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