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/event.h>
  34 #include <stdio.h>
  35 #include <stdbool.h>
  36 #include <glib.h>
  37 #include "text.h"
  38
  39 static
  40 const char *loglevel_str [] = {
  41         [LOGLEVEL_EMERG] =              "TRACE_EMERG",
  42         [LOGLEVEL_ALERT] =              "TRACE_ALERT",
  43         [LOGLEVEL_CRIT] =               "TRACE_CRIT",
  44         [LOGLEVEL_ERR] =                "TRACE_ERR",
  45         [LOGLEVEL_WARNING] =            "TRACE_WARNING",
  46         [LOGLEVEL_NOTICE] =             "TRACE_NOTICE",
  47         [LOGLEVEL_INFO] =               "TRACE_INFO",
  48         [LOGLEVEL_DEBUG_SYSTEM] =       "TRACE_DEBUG_SYSTEM",
  49         [LOGLEVEL_DEBUG_PROGRAM] =      "TRACE_DEBUG_PROGRAM",
  50         [LOGLEVEL_DEBUG_PROCESS] =      "TRACE_DEBUG_PROCESS",
  51         [LOGLEVEL_DEBUG_MODULE] =       "TRACE_DEBUG_MODULE",
  52         [LOGLEVEL_DEBUG_UNIT] =         "TRACE_DEBUG_UNIT",
  53         [LOGLEVEL_DEBUG_FUNCTION] =     "TRACE_DEBUG_FUNCTION",
  54         [LOGLEVEL_DEBUG_LINE] =         "TRACE_DEBUG_LINE",
  55         [LOGLEVEL_DEBUG] =              "TRACE_DEBUG",
  56 };
  57
  58 static
  59 void destroy_stream_timestamp(void *stream_timestamp)
  60 {
  61         g_free(stream_timestamp);
  62 }
  63
  64 static
  65 void destroy_text_data(struct text_component *text)
  66 {
  67         if (text->stream_timestamps) {
  68                 g_hash_table_destroy(text->stream_timestamps);
  69         }
  70         g_free(text);
  71 }
  72
  73 static
  74 struct text_component *create_text(void)
  75 {
  76         struct text_component *text;
  77
  78         text = g_new0(struct text_component, 1);
  79         if (!text) {
  80                 goto end;
  81         }
  82
  83         text->stream_timestamps = g_hash_table_new_full(
  84                         NULL, NULL, NULL, destroy_stream_timestamp);
  85         if (!text->stream_timestamps) {
  86                 goto error;
  87         }
  88 end:
  89         return text;
  90 error:
  91         destroy_text_data(text);
  92         return NULL;
  93 }
  94
  95 static void destroy_text(struct bt_component *component)
  96 {
  97         void *data = bt_component_get_private_data(component);
  98
  99         destroy_text_data(data);
 100 }
 101
 102 static
 103 enum bt_component_status handle_notification(struct bt_component *component,
 104         struct bt_notification *notification)
 105 {
 106         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 107         struct text_component *text = bt_component_get_private_data(component);
 108
 109         if (!text) {
 110                 ret = BT_COMPONENT_STATUS_ERROR;
 111                 goto end;
 112         }
 113
 114         switch (bt_notification_get_type(notification)) {
 115         case BT_NOTIFICATION_TYPE_PACKET_START:
 116                 puts("<packet>");
 117                 break;
 118         case BT_NOTIFICATION_TYPE_PACKET_END:
 119                 puts("</packet>");
 120                 break;
 121         case BT_NOTIFICATION_TYPE_EVENT:
 122         {
 123                 struct bt_ctf_event *event = bt_notification_event_get_event(
 124                                 notification);
 125
 126                 puts("\t<event>");
 127                 if (!event) {
 128                         ret = BT_COMPONENT_STATUS_ERROR;
 129                         goto end;
 130                 }
 131                 ret = text_print_event(text, event);
 132                 if (ret != BT_COMPONENT_STATUS_OK) {
 133                         goto end;
 134                 }
 135                 break;
 136         }
 137         case BT_NOTIFICATION_TYPE_STREAM_END:
 138                 puts("</stream>");
 139                 break;
 140         default:
 141                 puts("Unhandled notification type");
 142         }
 143 end:
 144         return ret;
 145 }
 146
 147 static
 148 enum bt_component_status text_component_init(
 149         struct bt_component *component, struct bt_value *params)
 150 {
 151         enum bt_component_status ret;
 152         struct text_component *text = create_text();
 153
 154         if (!text) {
 155                 ret = BT_COMPONENT_STATUS_NOMEM;
 156                 goto end;
 157         }
 158
 159         ret = bt_component_set_destroy_cb(component,
 160                         destroy_text);
 161         if (ret != BT_COMPONENT_STATUS_OK) {
 162                 goto error;
 163         }
 164
 165         ret = bt_component_set_private_data(component, text);
 166         if (ret != BT_COMPONENT_STATUS_OK) {
 167                 goto error;
 168         }
 169
 170         ret = bt_component_sink_set_handle_notification_cb(component,
 171                         handle_notification);
 172         if (ret != BT_COMPONENT_STATUS_OK) {
 173                 goto error;
 174         }
 175
 176         text->out = stdout;
 177         text->err = stderr;
 178 end:
 179         return ret;
 180 error:
 181         destroy_text_data(text);
 182         return ret;
 183 }
 184
 185 /* Initialize plug-in entry points. */
 186 BT_PLUGIN_NAME("text");
 187 BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
 188 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
 189 BT_PLUGIN_LICENSE("MIT");
 190
 191 BT_PLUGIN_COMPONENT_CLASSES_BEGIN
 192 BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text",
 193                 "Formats CTF-IR to text. Formerly known as ctf-text.",
 194                 text_component_init)
 195 BT_PLUGIN_COMPONENT_CLASSES_END