plugins/text/text.c

   1 /*
   2  * text.c
   3  *
   4  * Babeltrace CTF Text Output Plugin
   5  *
   6  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/plugin/plugin-macros.h>
  30 #include <babeltrace/plugin/component.h>
  31 #include <babeltrace/plugin/sink.h>
  32 #include <babeltrace/plugin/notification/notification.h>
  33 #include <babeltrace/plugin/notification/iterator.h>
  34 #include <babeltrace/plugin/notification/event.h>
  35 #include <stdio.h>
  36 #include <stdbool.h>
  37 #include <glib.h>
  38 #include "text.h"
  39
  40 static
  41 const char *loglevel_str [] = {
  42         [LOGLEVEL_EMERG] =              "TRACE_EMERG",
  43         [LOGLEVEL_ALERT] =              "TRACE_ALERT",
  44         [LOGLEVEL_CRIT] =               "TRACE_CRIT",
  45         [LOGLEVEL_ERR] =                "TRACE_ERR",
  46         [LOGLEVEL_WARNING] =            "TRACE_WARNING",
  47         [LOGLEVEL_NOTICE] =             "TRACE_NOTICE",
  48         [LOGLEVEL_INFO] =               "TRACE_INFO",
  49         [LOGLEVEL_DEBUG_SYSTEM] =       "TRACE_DEBUG_SYSTEM",
  50         [LOGLEVEL_DEBUG_PROGRAM] =      "TRACE_DEBUG_PROGRAM",
  51         [LOGLEVEL_DEBUG_PROCESS] =      "TRACE_DEBUG_PROCESS",
  52         [LOGLEVEL_DEBUG_MODULE] =       "TRACE_DEBUG_MODULE",
  53         [LOGLEVEL_DEBUG_UNIT] =         "TRACE_DEBUG_UNIT",
  54         [LOGLEVEL_DEBUG_FUNCTION] =     "TRACE_DEBUG_FUNCTION",
  55         [LOGLEVEL_DEBUG_LINE] =         "TRACE_DEBUG_LINE",
  56         [LOGLEVEL_DEBUG] =              "TRACE_DEBUG",
  57 };
  58
  59 static
  60 void destroy_text_data(struct text_component *text)
  61 {
  62         g_free(text);
  63 }
  64
  65 static
  66 struct text_component *create_text(void)
  67 {
  68         struct text_component *text;
  69
  70         text = g_new0(struct text_component, 1);
  71         if (!text) {
  72                 goto end;
  73         }
  74 end:
  75         return text;
  76 }
  77
  78 static
  79 void destroy_text(struct bt_component *component)
  80 {
  81         void *data = bt_component_get_private_data(component);
  82
  83         destroy_text_data(data);
  84 }
  85
  86 static
  87 enum bt_component_status handle_notification(struct text_component *text,
  88         struct bt_notification *notification)
  89 {
  90         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  91
  92         if (!text) {
  93                 ret = BT_COMPONENT_STATUS_ERROR;
  94                 goto end;
  95         }
  96
  97         switch (bt_notification_get_type(notification)) {
  98         case BT_NOTIFICATION_TYPE_PACKET_START:
  99                 puts("<packet>");
 100                 break;
 101         case BT_NOTIFICATION_TYPE_PACKET_END:
 102                 puts("</packet>");
 103                 break;
 104         case BT_NOTIFICATION_TYPE_EVENT:
 105         {
 106                 struct bt_ctf_event *event = bt_notification_event_get_event(
 107                                 notification);
 108
 109                 if (!event) {
 110                         ret = BT_COMPONENT_STATUS_ERROR;
 111                         goto end;
 112                 }
 113                 ret = text_print_event(text, event);
 114                 bt_put(event);
 115                 if (ret != BT_COMPONENT_STATUS_OK) {
 116                         goto end;
 117                 }
 118                 break;
 119         }
 120         case BT_NOTIFICATION_TYPE_STREAM_END:
 121                 puts("</stream>");
 122                 break;
 123         default:
 124                 puts("Unhandled notification type");
 125         }
 126 end:
 127         return ret;
 128 }
 129
 130 static
 131 enum bt_component_status run(struct bt_component *component)
 132 {
 133         enum bt_component_status ret;
 134         struct bt_notification *notification = NULL;
 135         struct bt_notification_iterator *it;
 136         struct text_component *text = bt_component_get_private_data(component);
 137
 138         ret = bt_component_sink_get_input_iterator(component, 0, &it);
 139         if (ret != BT_COMPONENT_STATUS_OK) {
 140                 goto end;
 141         }
 142
 143         if (!text->processed_first_event) {
 144                 ret = bt_notification_iterator_next(it);
 145                 if (ret != BT_COMPONENT_STATUS_OK) {
 146                         goto end;
 147                 }
 148         } else {
 149                 text->processed_first_event = true;
 150         }
 151
 152         notification = bt_notification_iterator_get_notification(it);
 153         if (!notification) {
 154                 ret = BT_COMPONENT_STATUS_ERROR;
 155                 goto end;
 156         }
 157
 158         ret = handle_notification(text, notification);
 159 end:
 160         bt_put(it);
 161         bt_put(notification);
 162         return ret;
 163 }
 164
 165 static
 166 enum bt_component_status text_component_init(
 167         struct bt_component *component, struct bt_value *params)
 168 {
 169         enum bt_component_status ret;
 170         struct text_component *text = create_text();
 171
 172         if (!text) {
 173                 ret = BT_COMPONENT_STATUS_NOMEM;
 174                 goto end;
 175         }
 176
 177         ret = bt_component_set_destroy_cb(component,
 178                         destroy_text);
 179         if (ret != BT_COMPONENT_STATUS_OK) {
 180                 goto error;
 181         }
 182
 183         ret = bt_component_set_private_data(component, text);
 184         if (ret != BT_COMPONENT_STATUS_OK) {
 185                 goto error;
 186         }
 187
 188         ret = bt_component_sink_set_consume_cb(component,
 189                         run);
 190         if (ret != BT_COMPONENT_STATUS_OK) {
 191                 goto error;
 192         }
 193
 194         text->out = stdout;
 195         text->err = stderr;
 196 end:
 197         return ret;
 198 error:
 199         destroy_text_data(text);
 200         return ret;
 201 }
 202
 203 /* Initialize plug-in entry points. */
 204 BT_PLUGIN_NAME("text");
 205 BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
 206 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
 207 BT_PLUGIN_LICENSE("MIT");
 208
 209 BT_PLUGIN_COMPONENT_CLASSES_BEGIN
 210 BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text",
 211                 "Formats CTF-IR to text. Formerly known as ctf-text.",
 212                 text_component_init)
 213 BT_PLUGIN_COMPONENT_CLASSES_END