plugins/ctf/text/text.c

   1 /*
   2  * text.c
   3  *
   4  * Babeltrace CTF Text Output Plugin
   5  *
   6  * Copyright 2015 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-lib.h>
  30 #include <babeltrace/plugin/plugin-system.h>
  31 #include <babeltrace/plugin/plugin.h>
  32 #include <babeltrace/plugin/sink.h>
  33 #include <glib.h>
  34 #include <stdio.h>
  35
  36 const char *plugin_name = "ctf-text";
  37
  38 enum loglevel {
  39         LOGLEVEL_EMERG                  = 0,
  40         LOGLEVEL_ALERT                  = 1,
  41         LOGLEVEL_CRIT                   = 2,
  42         LOGLEVEL_ERR                    = 3,
  43         LOGLEVEL_WARNING                = 4,
  44         LOGLEVEL_NOTICE                 = 5,
  45         LOGLEVEL_INFO                   = 6,
  46         LOGLEVEL_DEBUG_SYSTEM           = 7,
  47         LOGLEVEL_DEBUG_PROGRAM          = 8,
  48         LOGLEVEL_DEBUG_PROCESS          = 9,
  49         LOGLEVEL_DEBUG_MODULE           = 10,
  50         LOGLEVEL_DEBUG_UNIT             = 11,
  51         LOGLEVEL_DEBUG_FUNCTION         = 12,
  52         LOGLEVEL_DEBUG_LINE             = 13,
  53         LOGLEVEL_DEBUG                  = 14,
  54 };
  55
  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 ctf_text {
  75         int opt_print_all_field_names;
  76         int opt_print_scope_field_names;
  77         int opt_print_header_field_names;
  78         int opt_print_context_field_names;
  79         int opt_print_payload_field_names;
  80         int opt_print_all_fields;
  81         int opt_print_trace_field;
  82         int opt_print_trace_domain_field;
  83         int opt_print_trace_procname_field;
  84         int opt_print_trace_vpid_field;
  85         int opt_print_trace_hostname_field;
  86         int opt_print_trace_default_fields;
  87         int opt_print_loglevel_field;
  88         int opt_print_emf_field;
  89         int opt_print_callsite_field;
  90         int opt_print_delta_field;
  91 };
  92
  93 static
  94 void ctf_text_destroy(struct bt_plugin *plugin)
  95 {
  96         struct ctf_text *text;
  97
  98         if (!plugin) {
  99                 return;
 100         }
 101
 102         text = bt_plugin_get_private_data(plugin);
 103         if (!text) {
 104                 return;
 105         }
 106
 107         g_free(text);
 108 }
 109
 110 static
 111 int ctf_text_handle_notification(struct bt_plugin *plugin,
 112                 struct bt_notification *notification)
 113 {
 114         return BT_PLUGIN_STATUS_OK;
 115 }
 116
 117 enum bt_plugin_type bt_plugin_lib_get_type(void)
 118 {
 119         return BT_PLUGIN_TYPE_SINK;
 120 }
 121
 122 const char *bt_plugin_lib_get_format_name(void)
 123 {
 124         return plugin_name;
 125 }
 126
 127 static
 128 int text_init(struct ctf_text *text, struct bt_object *params)
 129 {
 130         int ret = 0;
 131
 132         if (!text || !params) {
 133                 ret = -1;
 134                 goto end;
 135         }
 136
 137         text->opt_print_trace_default_fields = 1;
 138         text->opt_print_delta_field = 1;
 139 end:
 140         return ret;
 141 }
 142
 143 struct bt_plugin *bt_plugin_lib_create(struct bt_object *params)
 144 {
 145         int ret;
 146         struct bt_plugin *plugin = NULL;
 147         struct ctf_text *text = g_new0(struct ctf_text, 1);
 148
 149         /* Set default text output options */
 150         ret = text_init(text, params);
 151         if (ret) {
 152                 goto error;
 153         }
 154
 155         plugin = bt_plugin_sink_create(plugin_name, text,
 156                 ctf_text_destroy, ctf_text_handle_notification);
 157         if (!plugin) {
 158                 goto error;
 159         }
 160
 161 end:
 162         return plugin;
 163 error:
 164         if (text) {
 165                 g_free(text);
 166         }
 167         goto end;
 168 }