plugins/text/pretty/pretty.h

   1 #ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
   2 #define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
   3
   4 /*
   5  * BabelTrace - CTF Text Output Plug-in
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <stdbool.h>
  31 #include <babeltrace/babeltrace-internal.h>
  32 #include <babeltrace/babeltrace.h>
  33
  34 enum pretty_default {
  35         PRETTY_DEFAULT_UNSET,
  36         PRETTY_DEFAULT_SHOW,
  37         PRETTY_DEFAULT_HIDE,
  38 };
  39
  40 enum pretty_color_option {
  41         PRETTY_COLOR_OPT_NEVER,
  42         PRETTY_COLOR_OPT_AUTO,
  43         PRETTY_COLOR_OPT_ALWAYS,
  44 };
  45
  46 struct pretty_options {
  47         char *output_path;
  48
  49         enum pretty_default name_default;
  50         enum pretty_default field_default;
  51
  52         bool print_scope_field_names;
  53         bool print_header_field_names;
  54         bool print_context_field_names;
  55         bool print_payload_field_names;
  56
  57         bool print_delta_field;
  58         bool print_loglevel_field;
  59         bool print_emf_field;
  60         bool print_callsite_field;
  61         bool print_trace_field;
  62         bool print_trace_domain_field;
  63         bool print_trace_procname_field;
  64         bool print_trace_vpid_field;
  65         bool print_trace_hostname_field;
  66
  67         bool print_timestamp_cycles;
  68         bool clock_seconds;
  69         bool clock_date;
  70         bool clock_gmt;
  71         enum pretty_color_option color;
  72         bool verbose;
  73 };
  74
  75 struct pretty_component {
  76         struct pretty_options options;
  77         struct bt_notification_iterator *input_iterator;
  78         FILE *out, *err;
  79         int depth;      /* nesting, used for tabulation alignment. */
  80         bool start_line;
  81         GString *string;
  82         GString *tmp_string;
  83         struct bt_value *plugin_opt_map;        /* Temporary parameter map. */
  84         bool use_colors;
  85         bool error;
  86
  87         uint64_t last_cycles_timestamp;
  88         uint64_t delta_cycles;
  89
  90         uint64_t last_real_timestamp;
  91         uint64_t delta_real_timestamp;
  92
  93         bool negative_timestamp_warning_done;
  94 };
  95
  96 enum stream_packet_context_quarks_enum {
  97         Q_TIMESTAMP_BEGIN,
  98         Q_TIMESTAMP_END,
  99         Q_EVENTS_DISCARDED,
 100         Q_CONTENT_SIZE,
 101         Q_PACKET_SIZE,
 102         Q_PACKET_SEQ_NUM,
 103         STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
 104 };
 105
 106 extern
 107 GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
 108
 109 BT_HIDDEN
 110 enum bt_component_status pretty_init(
 111                 struct bt_private_component *component,
 112                 struct bt_value *params,
 113                 void *init_method_data);
 114
 115 BT_HIDDEN
 116 enum bt_component_status pretty_consume(struct bt_private_component *component);
 117
 118 BT_HIDDEN
 119 void pretty_port_connected(
 120                 struct bt_private_component *component,
 121                 struct bt_private_port *self_port,
 122                 struct bt_port *other_port);
 123
 124 BT_HIDDEN
 125 void pretty_finalize(struct bt_private_component *component);
 126
 127 BT_HIDDEN
 128 enum bt_component_status pretty_print_event(struct pretty_component *pretty,
 129                 struct bt_notification *event_notif);
 130
 131 BT_HIDDEN
 132 enum bt_component_status pretty_print_discarded_elements(
 133                 struct pretty_component *pretty,
 134                 struct bt_notification *notif);
 135
 136 #endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */