Commit | Line | Data |
---|---|---|
3228cc1d PP |
1 | #ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H |
2 | #define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H | |
af9a82eb JG |
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> | |
b2e0c907 | 32 | #include <babeltrace/graph/component.h> |
3228cc1d PP |
33 | #include <babeltrace/graph/private-component.h> |
34 | #include <babeltrace/graph/private-port.h> | |
35 | #include <babeltrace/ctf-ir/event.h> | |
36 | ||
37 | enum pretty_default { | |
38 | PRETTY_DEFAULT_UNSET, | |
39 | PRETTY_DEFAULT_SHOW, | |
40 | PRETTY_DEFAULT_HIDE, | |
6e1bc0df MD |
41 | }; |
42 | ||
3228cc1d PP |
43 | enum pretty_color_option { |
44 | PRETTY_COLOR_OPT_NEVER, | |
45 | PRETTY_COLOR_OPT_AUTO, | |
46 | PRETTY_COLOR_OPT_ALWAYS, | |
ad96d936 PP |
47 | }; |
48 | ||
3228cc1d | 49 | struct pretty_options { |
6e1bc0df | 50 | char *output_path; |
6e1bc0df | 51 | |
3228cc1d PP |
52 | enum pretty_default name_default; |
53 | enum pretty_default field_default; | |
6e1bc0df MD |
54 | |
55 | bool print_scope_field_names; | |
56 | bool print_header_field_names; | |
57 | bool print_context_field_names; | |
58 | bool print_payload_field_names; | |
59 | ||
60 | bool print_delta_field; | |
61 | bool print_loglevel_field; | |
62 | bool print_emf_field; | |
60535549 | 63 | bool print_callsite_field; |
6e1bc0df MD |
64 | bool print_trace_field; |
65 | bool print_trace_domain_field; | |
66 | bool print_trace_procname_field; | |
67 | bool print_trace_vpid_field; | |
68 | bool print_trace_hostname_field; | |
69 | ||
70 | bool print_timestamp_cycles; | |
71 | bool clock_seconds; | |
72 | bool clock_date; | |
73 | bool clock_gmt; | |
3228cc1d | 74 | enum pretty_color_option color; |
a263021c | 75 | bool verbose; |
af9a82eb JG |
76 | }; |
77 | ||
3228cc1d PP |
78 | struct pretty_component { |
79 | struct pretty_options options; | |
75e1829b | 80 | struct bt_notification_iterator *input_iterator; |
af9a82eb | 81 | FILE *out, *err; |
6a18b281 | 82 | int depth; /* nesting, used for tabulation alignment. */ |
6e1bc0df | 83 | bool start_line; |
6a18b281 | 84 | GString *string; |
5280f742 | 85 | GString *tmp_string; |
6e1bc0df | 86 | struct bt_value *plugin_opt_map; /* Temporary parameter map. */ |
ad96d936 | 87 | bool use_colors; |
0d8b4d8e | 88 | bool error; |
3af83b5a MD |
89 | |
90 | uint64_t last_cycles_timestamp; | |
91 | uint64_t delta_cycles; | |
92 | ||
93 | uint64_t last_real_timestamp; | |
94 | uint64_t delta_real_timestamp; | |
f1c99b12 MD |
95 | |
96 | bool negative_timestamp_warning_done; | |
af9a82eb JG |
97 | }; |
98 | ||
2b4c4a7c JD |
99 | enum stream_packet_context_quarks_enum { |
100 | Q_TIMESTAMP_BEGIN, | |
101 | Q_TIMESTAMP_END, | |
102 | Q_EVENTS_DISCARDED, | |
103 | Q_CONTENT_SIZE, | |
104 | Q_PACKET_SIZE, | |
105 | Q_PACKET_SEQ_NUM, | |
106 | STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */ | |
107 | }; | |
108 | ||
b7c70610 | 109 | extern |
2b4c4a7c JD |
110 | GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN]; |
111 | ||
af9a82eb | 112 | BT_HIDDEN |
3228cc1d PP |
113 | enum bt_component_status pretty_init( |
114 | struct bt_private_component *component, | |
115 | struct bt_value *params, | |
116 | void *init_method_data); | |
117 | ||
118 | BT_HIDDEN | |
119 | enum bt_component_status pretty_consume(struct bt_private_component *component); | |
120 | ||
121 | BT_HIDDEN | |
0d8b4d8e | 122 | void pretty_port_connected( |
3228cc1d PP |
123 | struct bt_private_component *component, |
124 | struct bt_private_port *self_port, | |
125 | struct bt_port *other_port); | |
126 | ||
127 | BT_HIDDEN | |
128 | void pretty_finalize(struct bt_private_component *component); | |
129 | ||
130 | BT_HIDDEN | |
131 | enum bt_component_status pretty_print_event(struct pretty_component *pretty, | |
d9f65f09 | 132 | struct bt_notification *event_notif); |
af9a82eb | 133 | |
da6febac PP |
134 | BT_HIDDEN |
135 | enum bt_component_status pretty_print_discarded_elements( | |
136 | struct pretty_component *pretty, | |
137 | struct bt_notification *notif); | |
138 | ||
3228cc1d | 139 | #endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */ |