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_text_data(struct text_component *text)
  60 {
  61         g_free(text);
  62 }
  63
  64 static
  65 struct text_component *create_text(void)
  66 {
  67         struct text_component *text;
  68
  69         text = g_new0(struct text_component, 1);
  70         if (!text) {
  71                 goto end;
  72         }
  73 end:
  74         return text;
  75 }
  76
  77 static void destroy_text(struct bt_component *component)
  78 {
  79         void *data = bt_component_get_private_data(component);
  80
  81         destroy_text_data(data);
  82 }
  83
  84 static
  85 enum bt_component_status handle_notification(struct bt_component *component,
  86         struct bt_notification *notification)
  87 {
  88         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  89         struct text_component *text = bt_component_get_private_data(component);
  90
  91         if (!text) {
  92                 ret = BT_COMPONENT_STATUS_ERROR;
  93                 goto end;
  94         }
  95
  96         switch (bt_notification_get_type(notification)) {
  97         case BT_NOTIFICATION_TYPE_PACKET_START:
  98                 puts("<packet>");
  99                 break;
 100         case BT_NOTIFICATION_TYPE_PACKET_END:
 101                 puts("</packet>");
 102                 break;
 103         case BT_NOTIFICATION_TYPE_EVENT:
 104         {
 105                 struct bt_ctf_event *event = bt_notification_event_get_event(
 106                                 notification);
 107
 108                 if (!event) {
 109                         ret = BT_COMPONENT_STATUS_ERROR;
 110                         goto end;
 111                 }
 112                 ret = text_print_event(text, event);
 113                 if (ret != BT_COMPONENT_STATUS_OK) {
 114                         goto end;
 115                 }
 116                 break;
 117         }
 118         case BT_NOTIFICATION_TYPE_STREAM_END:
 119                 puts("</stream>");
 120                 break;
 121         default:
 122                 puts("Unhandled notification type");
 123         }
 124 end:
 125         return ret;
 126 }
 127
 128 static
 129 enum bt_component_status text_component_init(
 130         struct bt_component *component, struct bt_value *params)
 131 {
 132         enum bt_component_status ret;
 133         struct text_component *text = create_text();
 134
 135         if (!text) {
 136                 ret = BT_COMPONENT_STATUS_NOMEM;
 137                 goto end;
 138         }
 139
 140         ret = bt_component_set_destroy_cb(component,
 141                         destroy_text);
 142         if (ret != BT_COMPONENT_STATUS_OK) {
 143                 goto error;
 144         }
 145
 146         ret = bt_component_set_private_data(component, text);
 147         if (ret != BT_COMPONENT_STATUS_OK) {
 148                 goto error;
 149         }
 150
 151         ret = bt_component_sink_set_handle_notification_cb(component,
 152                         handle_notification);
 153         if (ret != BT_COMPONENT_STATUS_OK) {
 154                 goto error;
 155         }
 156
 157         text->out = stdout;
 158         text->err = stderr;
 159 end:
 160         return ret;
 161 error:
 162         destroy_text_data(text);
 163         return ret;
 164 }
 165
 166 /* Initialize plug-in entry points. */
 167 BT_PLUGIN_NAME("text");
 168 BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
 169 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
 170 BT_PLUGIN_LICENSE("MIT");
 171
 172 BT_PLUGIN_COMPONENT_CLASSES_BEGIN
 173 BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text",
 174                 "Formats CTF-IR to text. Formerly known as ctf-text.",
 175                 text_component_init)
 176 BT_PLUGIN_COMPONENT_CLASSES_END