plugins/text/text.h

   1 #ifndef BABELTRACE_PLUGIN_TEXT_H
   2 #define BABELTRACE_PLUGIN_TEXT_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/graph/component.h>
  33
  34 enum text_default {
  35         TEXT_DEFAULT_UNSET,
  36         TEXT_DEFAULT_SHOW,
  37         TEXT_DEFAULT_HIDE,
  38 };
  39
  40 enum text_color_option {
  41         TEXT_COLOR_OPT_NEVER,
  42         TEXT_COLOR_OPT_AUTO,
  43         TEXT_COLOR_OPT_ALWAYS,
  44 };
  45
  46 struct text_options {
  47         char *output_path;
  48         char *debug_info_dir;
  49         char *debug_info_target_prefix;
  50
  51         enum text_default name_default;
  52         enum text_default field_default;
  53
  54         bool print_scope_field_names;
  55         bool print_header_field_names;
  56         bool print_context_field_names;
  57         bool print_payload_field_names;
  58
  59         bool print_delta_field;
  60         bool print_loglevel_field;
  61         bool print_emf_field;
  62         bool print_trace_field;
  63         bool print_trace_domain_field;
  64         bool print_trace_procname_field;
  65         bool print_trace_vpid_field;
  66         bool print_trace_hostname_field;
  67
  68         bool print_timestamp_cycles;
  69         bool clock_seconds;
  70         bool clock_date;
  71         bool clock_gmt;
  72         bool debug_info_full_path;
  73         enum text_color_option color;
  74         bool verbose;
  75 };
  76
  77 struct text_component {
  78         struct text_options options;
  79         struct bt_notification_iterator *input_iterator;
  80         FILE *out, *err;
  81         bool processed_first_event; /* Should be per-iterator. */
  82         int depth;      /* nesting, used for tabulation alignment. */
  83         bool start_line;
  84         GString *string;
  85         struct bt_value *plugin_opt_map;        /* Temporary parameter map. */
  86         bool use_colors;
  87
  88         uint64_t last_cycles_timestamp;
  89         uint64_t delta_cycles;
  90
  91         uint64_t last_real_timestamp;
  92         uint64_t delta_real_timestamp;
  93 };
  94
  95 enum stream_packet_context_quarks_enum {
  96         Q_TIMESTAMP_BEGIN,
  97         Q_TIMESTAMP_END,
  98         Q_EVENTS_DISCARDED,
  99         Q_CONTENT_SIZE,
 100         Q_PACKET_SIZE,
 101         Q_PACKET_SEQ_NUM,
 102         STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
 103 };
 104
 105 GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
 106
 107 BT_HIDDEN
 108 enum bt_component_status text_print_event(struct text_component *text,
 109                 struct bt_ctf_event *event);
 110
 111 #endif /* BABELTRACE_PLUGIN_TEXT_H */