Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
2e339de1 | 4 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
f504043c | 5 | * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
7a278c8e JG |
6 | */ |
7 | ||
88488ff5 SM |
8 | #define BT_COMP_LOG_SELF_COMP self_comp |
9 | #define BT_LOG_OUTPUT_LEVEL log_level | |
10 | #define BT_LOG_TAG "PLUGIN/SINK.TEXT.PRETTY" | |
11 | #include "logging/comp-logging.h" | |
12 | ||
3fadfbc0 | 13 | #include <babeltrace2/babeltrace.h> |
578e048b MJ |
14 | #include "compat/compiler.h" |
15 | #include "common/common.h" | |
bfd20a42 | 16 | #include <stdio.h> |
39cfa40f | 17 | #include <stdbool.h> |
bac67f0f | 18 | #include <glib.h> |
9957b01a | 19 | #include <string.h> |
578e048b | 20 | #include "common/assert.h" |
88488ff5 | 21 | #include "plugins/common/param-validation/param-validation.h" |
6405967d | 22 | |
3228cc1d PP |
23 | #include "pretty.h" |
24 | ||
5badd463 PP |
25 | static |
26 | const char * const in_port_name = "in"; | |
27 | ||
bfd20a42 | 28 | static |
3228cc1d | 29 | void destroy_pretty_data(struct pretty_component *pretty) |
bac67f0f | 30 | { |
27a1afa7 SM |
31 | if (!pretty) { |
32 | goto end; | |
33 | } | |
34 | ||
9a2c8b8e | 35 | bt_message_iterator_put_ref(pretty->iterator); |
96eccbbc | 36 | |
5280f742 PP |
37 | if (pretty->string) { |
38 | (void) g_string_free(pretty->string, TRUE); | |
39 | } | |
40 | ||
41 | if (pretty->tmp_string) { | |
42 | (void) g_string_free(pretty->tmp_string, TRUE); | |
43 | } | |
44 | ||
3228cc1d | 45 | if (pretty->out != stdout) { |
77986bad JD |
46 | int ret; |
47 | ||
3228cc1d | 48 | ret = fclose(pretty->out); |
77986bad JD |
49 | if (ret) { |
50 | perror("close output file"); | |
51 | } | |
52 | } | |
3228cc1d | 53 | g_free(pretty->options.output_path); |
3228cc1d | 54 | g_free(pretty); |
27a1afa7 SM |
55 | |
56 | end: | |
57 | return; | |
bac67f0f JG |
58 | } |
59 | ||
b25bd455 | 60 | static |
3228cc1d | 61 | struct pretty_component *create_pretty(void) |
bac67f0f | 62 | { |
3228cc1d | 63 | struct pretty_component *pretty; |
541b0a11 | 64 | |
3228cc1d PP |
65 | pretty = g_new0(struct pretty_component, 1); |
66 | if (!pretty) { | |
541b0a11 JG |
67 | goto end; |
68 | } | |
3228cc1d PP |
69 | pretty->string = g_string_new(""); |
70 | if (!pretty->string) { | |
6a18b281 MD |
71 | goto error; |
72 | } | |
5280f742 PP |
73 | pretty->tmp_string = g_string_new(""); |
74 | if (!pretty->tmp_string) { | |
75 | goto error; | |
76 | } | |
541b0a11 | 77 | end: |
3228cc1d | 78 | return pretty; |
6a18b281 MD |
79 | |
80 | error: | |
3228cc1d | 81 | g_free(pretty); |
6a18b281 | 82 | return NULL; |
bac67f0f JG |
83 | } |
84 | ||
3228cc1d | 85 | BT_HIDDEN |
b19ff26f | 86 | void pretty_finalize(bt_self_component_sink *comp) |
b25bd455 | 87 | { |
d94d92ac PP |
88 | destroy_pretty_data( |
89 | bt_self_component_get_data( | |
707b7d35 | 90 | bt_self_component_sink_as_self_component(comp))); |
b25bd455 JG |
91 | } |
92 | ||
bac67f0f | 93 | static |
a3f0c7db | 94 | bt_message_iterator_class_next_method_status handle_message( |
d94d92ac | 95 | struct pretty_component *pretty, |
d6e69534 | 96 | const bt_message *message) |
4c1456f0 | 97 | { |
a3f0c7db SM |
98 | bt_message_iterator_class_next_method_status ret = |
99 | BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; | |
541b0a11 | 100 | |
98b15851 | 101 | BT_ASSERT_DBG(pretty); |
541b0a11 | 102 | |
d6e69534 | 103 | switch (bt_message_get_type(message)) { |
d6e69534 PP |
104 | case BT_MESSAGE_TYPE_EVENT: |
105 | if (pretty_print_event(pretty, message)) { | |
a3f0c7db | 106 | ret = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; |
d94d92ac | 107 | } |
7cdc2bab | 108 | break; |
8e53bed4 PP |
109 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: |
110 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
111 | if (pretty_print_discarded_items(pretty, message)) { | |
a3f0c7db | 112 | ret = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; |
8e53bed4 PP |
113 | } |
114 | break; | |
7cdc2bab | 115 | default: |
f42867e2 | 116 | break; |
78586d8a | 117 | } |
b5e978f4 | 118 | |
541b0a11 | 119 | return ret; |
4c1456f0 | 120 | } |
bac67f0f | 121 | |
3228cc1d | 122 | BT_HIDDEN |
d24d5663 PP |
123 | bt_component_class_sink_graph_is_configured_method_status |
124 | pretty_graph_is_configured(bt_self_component_sink *comp) | |
75e1829b | 125 | { |
e803df70 | 126 | bt_component_class_sink_graph_is_configured_method_status status; |
9a2c8b8e | 127 | bt_message_iterator_create_from_sink_component_status |
e803df70 | 128 | msg_iter_status; |
3228cc1d | 129 | struct pretty_component *pretty; |
75e1829b | 130 | |
d94d92ac | 131 | pretty = bt_self_component_get_data( |
707b7d35 | 132 | bt_self_component_sink_as_self_component(comp)); |
f6ccaed9 | 133 | BT_ASSERT(pretty); |
d94d92ac | 134 | BT_ASSERT(!pretty->iterator); |
9a2c8b8e | 135 | msg_iter_status = bt_message_iterator_create_from_sink_component( |
ca02df0a | 136 | comp, bt_self_component_sink_borrow_input_port_by_name(comp, |
e803df70 | 137 | in_port_name), &pretty->iterator); |
9a2c8b8e | 138 | if (msg_iter_status != BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK) { |
e803df70 SM |
139 | status = (int) msg_iter_status; |
140 | goto end; | |
75e1829b | 141 | } |
72b913fb | 142 | |
e803df70 SM |
143 | status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK; |
144 | ||
145 | end: | |
bf55043c | 146 | return status; |
75e1829b JG |
147 | } |
148 | ||
3228cc1d | 149 | BT_HIDDEN |
d24d5663 | 150 | bt_component_class_sink_consume_method_status pretty_consume( |
b19ff26f | 151 | bt_self_component_sink *comp) |
fec2a9f2 | 152 | { |
b51acf23 JR |
153 | bt_component_class_sink_consume_method_status ret = |
154 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK; | |
d6e69534 | 155 | bt_message_array_const msgs; |
9a2c8b8e | 156 | bt_message_iterator *it; |
d94d92ac | 157 | struct pretty_component *pretty = bt_self_component_get_data( |
707b7d35 | 158 | bt_self_component_sink_as_self_component(comp)); |
d24d5663 | 159 | bt_message_iterator_next_status next_status; |
d4393e08 PP |
160 | uint64_t count = 0; |
161 | uint64_t i = 0; | |
fec2a9f2 | 162 | |
d94d92ac | 163 | it = pretty->iterator; |
9a2c8b8e | 164 | next_status = bt_message_iterator_next(it, |
d6e69534 | 165 | &msgs, &count); |
0d8b4d8e | 166 | |
d24d5663 PP |
167 | switch (next_status) { |
168 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK: | |
d94d92ac | 169 | break; |
d24d5663 PP |
170 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR: |
171 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN: | |
172 | ret = (int) next_status; | |
d94d92ac | 173 | goto end; |
d24d5663 PP |
174 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_END: |
175 | ret = (int) next_status; | |
9a2c8b8e | 176 | BT_MESSAGE_ITERATOR_PUT_REF_AND_RESET( |
c5b9b441 | 177 | pretty->iterator); |
dfa6653c | 178 | goto end; |
dfa6653c | 179 | default: |
d24d5663 | 180 | ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR; |
dfa6653c | 181 | goto end; |
fec2a9f2 JG |
182 | } |
183 | ||
98b15851 | 184 | BT_ASSERT_DBG(next_status == BT_MESSAGE_ITERATOR_NEXT_STATUS_OK); |
d4393e08 PP |
185 | |
186 | for (i = 0; i < count; i++) { | |
9275bef4 | 187 | ret = (int) handle_message(pretty, msgs[i]); |
d4393e08 PP |
188 | if (ret) { |
189 | goto end; | |
190 | } | |
191 | ||
d6e69534 | 192 | bt_message_put_ref(msgs[i]); |
d4393e08 | 193 | } |
dfa6653c | 194 | |
fec2a9f2 | 195 | end: |
d4393e08 | 196 | for (; i < count; i++) { |
d6e69534 | 197 | bt_message_put_ref(msgs[i]); |
d4393e08 PP |
198 | } |
199 | ||
fec2a9f2 JG |
200 | return ret; |
201 | } | |
202 | ||
6e1bc0df | 203 | static |
b19ff26f | 204 | void apply_one_string(const char *key, const bt_value *params, char **option) |
6e1bc0df | 205 | { |
b19ff26f | 206 | const bt_value *value = NULL; |
6e1bc0df MD |
207 | const char *str; |
208 | ||
05e21286 | 209 | value = bt_value_map_borrow_entry_value_const(params, key); |
6e1bc0df MD |
210 | if (!value) { |
211 | goto end; | |
212 | } | |
88488ff5 | 213 | |
601b0d3c | 214 | str = bt_value_string_get(value); |
6e1bc0df | 215 | *option = g_strdup(str); |
601b0d3c | 216 | |
6e1bc0df | 217 | end: |
d94d92ac | 218 | return; |
6e1bc0df MD |
219 | } |
220 | ||
88488ff5 SM |
221 | /* |
222 | * Apply parameter with key `key` to `option`. Use `def` as the value, if | |
223 | * the parameter is not specified. | |
224 | */ | |
225 | ||
6e1bc0df | 226 | static |
88488ff5 SM |
227 | void apply_one_bool_with_default(const char *key, const bt_value *params, |
228 | bool *option, bool def) | |
6e1bc0df | 229 | { |
88488ff5 | 230 | const bt_value *value; |
6e1bc0df | 231 | |
05e21286 | 232 | value = bt_value_map_borrow_entry_value_const(params, key); |
88488ff5 SM |
233 | if (value) { |
234 | bt_bool bool_val = bt_value_bool_get(value); | |
a82e90e8 | 235 | |
88488ff5 SM |
236 | *option = (bool) bool_val; |
237 | } else { | |
238 | *option = def; | |
239 | } | |
6e1bc0df MD |
240 | } |
241 | ||
ad96d936 | 242 | static |
88488ff5 | 243 | void apply_one_bool_if_specified(const char *key, const bt_value *params, bool *option) |
ad96d936 | 244 | { |
88488ff5 SM |
245 | const bt_value *value; |
246 | ||
247 | value = bt_value_map_borrow_entry_value_const(params, key); | |
248 | if (value) { | |
249 | bt_bool bool_val = bt_value_bool_get(value); | |
250 | ||
251 | *option = (bool) bool_val; | |
252 | } | |
ad96d936 PP |
253 | } |
254 | ||
77986bad | 255 | static |
d94d92ac | 256 | int open_output_file(struct pretty_component *pretty) |
77986bad | 257 | { |
d94d92ac | 258 | int ret = 0; |
77986bad | 259 | |
3228cc1d | 260 | if (!pretty->options.output_path) { |
77986bad JD |
261 | goto end; |
262 | } | |
263 | ||
3228cc1d PP |
264 | pretty->out = fopen(pretty->options.output_path, "w"); |
265 | if (!pretty->out) { | |
77986bad JD |
266 | goto error; |
267 | } | |
268 | ||
269 | goto end; | |
270 | ||
271 | error: | |
d94d92ac PP |
272 | ret = -1; |
273 | ||
77986bad JD |
274 | end: |
275 | return ret; | |
276 | } | |
277 | ||
88488ff5 SM |
278 | static const char *color_choices[] = { "never", "auto", "always", NULL }; |
279 | static const char *show_hide_choices[] = { "show", "hide", NULL }; | |
280 | ||
d9120ccb | 281 | static |
88488ff5 SM |
282 | struct bt_param_validation_map_value_entry_descr pretty_params[] = { |
283 | { "color", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = { | |
284 | .choices = color_choices, | |
285 | } } }, | |
286 | { "path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, | |
287 | { "no-delta", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
288 | { "clock-cycles", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
289 | { "clock-seconds", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
290 | { "clock-date", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
291 | { "clock-gmt", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
292 | { "verbose", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
293 | ||
294 | { "name-default", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = { | |
295 | .choices = show_hide_choices, | |
296 | } } }, | |
297 | { "name-payload", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
298 | { "name-context", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
299 | { "name-scope", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
300 | { "name-header", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
301 | ||
302 | { "field-default", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = { | |
303 | .choices = show_hide_choices, | |
304 | } } }, | |
305 | { "field-trace", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
306 | { "field-trace:hostname", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
307 | { "field-trace:domain", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
308 | { "field-trace:procname", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
309 | { "field-trace:vpid", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
310 | { "field-loglevel", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
311 | { "field-emf", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
312 | { "field-callsite", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
313 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
314 | }; | |
315 | ||
6e1bc0df | 316 | static |
88488ff5 SM |
317 | bt_component_class_initialize_method_status apply_params( |
318 | struct pretty_component *pretty, const bt_value *params, | |
319 | bt_self_component *self_comp, bt_logging_level log_level) | |
6e1bc0df | 320 | { |
88488ff5 SM |
321 | int ret; |
322 | const bt_value *value; | |
323 | bt_component_class_initialize_method_status status; | |
324 | enum bt_param_validation_status validation_status; | |
325 | gchar *validate_error = NULL; | |
326 | ||
327 | validation_status = bt_param_validation_validate(params, | |
328 | pretty_params, &validate_error); | |
329 | if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { | |
330 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
6e1bc0df | 331 | goto end; |
88488ff5 SM |
332 | } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { |
333 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
334 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validate_error); | |
6e1bc0df MD |
335 | goto end; |
336 | } | |
d24d5663 | 337 | |
6e1bc0df | 338 | /* Known parameters. */ |
3228cc1d | 339 | pretty->options.color = PRETTY_COLOR_OPT_AUTO; |
88488ff5 SM |
340 | value = bt_value_map_borrow_entry_value_const(params, "color"); |
341 | if (value) { | |
342 | const char *color = bt_value_string_get(value); | |
601b0d3c PP |
343 | |
344 | if (strcmp(color, "never") == 0) { | |
345 | pretty->options.color = PRETTY_COLOR_OPT_NEVER; | |
346 | } else if (strcmp(color, "auto") == 0) { | |
347 | pretty->options.color = PRETTY_COLOR_OPT_AUTO; | |
ad96d936 | 348 | } else { |
88488ff5 SM |
349 | BT_ASSERT(strcmp(color, "always") == 0); |
350 | pretty->options.color = PRETTY_COLOR_OPT_ALWAYS; | |
ad96d936 | 351 | } |
ad96d936 PP |
352 | } |
353 | ||
d94d92ac | 354 | apply_one_string("path", params, &pretty->options.output_path); |
3228cc1d | 355 | ret = open_output_file(pretty); |
d94d92ac | 356 | if (ret) { |
88488ff5 | 357 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; |
77986bad JD |
358 | goto end; |
359 | } | |
6e1bc0df | 360 | |
88488ff5 SM |
361 | apply_one_bool_with_default("no-delta", params, |
362 | &pretty->options.print_delta_field, false); | |
363 | /* Reverse logic. */ | |
364 | pretty->options.print_delta_field = !pretty->options.print_delta_field; | |
6e1bc0df | 365 | |
88488ff5 SM |
366 | apply_one_bool_with_default("clock-cycles", params, |
367 | &pretty->options.print_timestamp_cycles, false); | |
6e1bc0df | 368 | |
88488ff5 SM |
369 | apply_one_bool_with_default("clock-seconds", params, |
370 | &pretty->options.clock_seconds , false); | |
6e1bc0df | 371 | |
88488ff5 SM |
372 | apply_one_bool_with_default("clock-date", params, |
373 | &pretty->options.clock_date, false); | |
6e1bc0df | 374 | |
88488ff5 SM |
375 | apply_one_bool_with_default("clock-gmt", params, |
376 | &pretty->options.clock_gmt, false); | |
6e1bc0df | 377 | |
88488ff5 SM |
378 | apply_one_bool_with_default("verbose", params, |
379 | &pretty->options.verbose, false); | |
a263021c | 380 | |
6e1bc0df | 381 | /* Names. */ |
88488ff5 SM |
382 | value = bt_value_map_borrow_entry_value_const(params, "name-default"); |
383 | if (value) { | |
384 | const char *str = bt_value_string_get(value); | |
385 | ||
386 | if (strcmp(str, "show") == 0) { | |
387 | pretty->options.name_default = PRETTY_DEFAULT_SHOW; | |
388 | } else { | |
389 | BT_ASSERT(strcmp(str, "hide") == 0); | |
390 | pretty->options.name_default = PRETTY_DEFAULT_HIDE; | |
391 | } | |
6e1bc0df | 392 | } else { |
88488ff5 | 393 | pretty->options.name_default = PRETTY_DEFAULT_UNSET; |
6e1bc0df | 394 | } |
6e1bc0df | 395 | |
3228cc1d PP |
396 | switch (pretty->options.name_default) { |
397 | case PRETTY_DEFAULT_UNSET: | |
398 | pretty->options.print_payload_field_names = true; | |
399 | pretty->options.print_context_field_names = true; | |
400 | pretty->options.print_header_field_names = false; | |
401 | pretty->options.print_scope_field_names = false; | |
6e1bc0df | 402 | break; |
3228cc1d PP |
403 | case PRETTY_DEFAULT_SHOW: |
404 | pretty->options.print_payload_field_names = true; | |
405 | pretty->options.print_context_field_names = true; | |
406 | pretty->options.print_header_field_names = true; | |
407 | pretty->options.print_scope_field_names = true; | |
6e1bc0df | 408 | break; |
3228cc1d PP |
409 | case PRETTY_DEFAULT_HIDE: |
410 | pretty->options.print_payload_field_names = false; | |
411 | pretty->options.print_context_field_names = false; | |
412 | pretty->options.print_header_field_names = false; | |
413 | pretty->options.print_scope_field_names = false; | |
6e1bc0df MD |
414 | break; |
415 | default: | |
498e7994 | 416 | bt_common_abort(); |
6e1bc0df MD |
417 | } |
418 | ||
88488ff5 SM |
419 | apply_one_bool_if_specified("name-payload", params, |
420 | &pretty->options.print_payload_field_names); | |
6e1bc0df | 421 | |
88488ff5 SM |
422 | apply_one_bool_if_specified("name-context", params, |
423 | &pretty->options.print_context_field_names); | |
6e1bc0df | 424 | |
88488ff5 SM |
425 | apply_one_bool_if_specified("name-header", params, |
426 | &pretty->options.print_header_field_names); | |
6e1bc0df | 427 | |
88488ff5 SM |
428 | apply_one_bool_if_specified("name-scope", params, |
429 | &pretty->options.print_scope_field_names); | |
6e1bc0df MD |
430 | |
431 | /* Fields. */ | |
88488ff5 SM |
432 | value = bt_value_map_borrow_entry_value_const(params, "field-default"); |
433 | if (value) { | |
434 | const char *str = bt_value_string_get(value); | |
435 | ||
436 | if (strcmp(str, "show") == 0) { | |
437 | pretty->options.field_default = PRETTY_DEFAULT_SHOW; | |
438 | } else { | |
439 | BT_ASSERT(strcmp(str, "hide") == 0); | |
440 | pretty->options.field_default = PRETTY_DEFAULT_HIDE; | |
441 | } | |
6e1bc0df | 442 | } else { |
88488ff5 | 443 | pretty->options.field_default = PRETTY_DEFAULT_UNSET; |
6e1bc0df | 444 | } |
6e1bc0df | 445 | |
3228cc1d PP |
446 | switch (pretty->options.field_default) { |
447 | case PRETTY_DEFAULT_UNSET: | |
448 | pretty->options.print_trace_field = false; | |
449 | pretty->options.print_trace_hostname_field = true; | |
450 | pretty->options.print_trace_domain_field = false; | |
451 | pretty->options.print_trace_procname_field = true; | |
452 | pretty->options.print_trace_vpid_field = true; | |
453 | pretty->options.print_loglevel_field = false; | |
454 | pretty->options.print_emf_field = false; | |
455 | pretty->options.print_callsite_field = false; | |
6e1bc0df | 456 | break; |
3228cc1d PP |
457 | case PRETTY_DEFAULT_SHOW: |
458 | pretty->options.print_trace_field = true; | |
459 | pretty->options.print_trace_hostname_field = true; | |
460 | pretty->options.print_trace_domain_field = true; | |
461 | pretty->options.print_trace_procname_field = true; | |
462 | pretty->options.print_trace_vpid_field = true; | |
463 | pretty->options.print_loglevel_field = true; | |
464 | pretty->options.print_emf_field = true; | |
465 | pretty->options.print_callsite_field = true; | |
6e1bc0df | 466 | break; |
3228cc1d PP |
467 | case PRETTY_DEFAULT_HIDE: |
468 | pretty->options.print_trace_field = false; | |
469 | pretty->options.print_trace_hostname_field = false; | |
470 | pretty->options.print_trace_domain_field = false; | |
471 | pretty->options.print_trace_procname_field = false; | |
472 | pretty->options.print_trace_vpid_field = false; | |
473 | pretty->options.print_loglevel_field = false; | |
474 | pretty->options.print_emf_field = false; | |
475 | pretty->options.print_callsite_field = false; | |
6e1bc0df MD |
476 | break; |
477 | default: | |
498e7994 | 478 | bt_common_abort(); |
6e1bc0df MD |
479 | } |
480 | ||
88488ff5 SM |
481 | apply_one_bool_if_specified("field-trace", params, |
482 | &pretty->options.print_trace_field); | |
6e1bc0df | 483 | |
88488ff5 SM |
484 | apply_one_bool_if_specified("field-trace:hostname", params, |
485 | &pretty->options.print_trace_hostname_field); | |
6e1bc0df | 486 | |
88488ff5 SM |
487 | apply_one_bool_if_specified("field-trace:domain", params, |
488 | &pretty->options.print_trace_domain_field); | |
6e1bc0df | 489 | |
88488ff5 SM |
490 | apply_one_bool_if_specified("field-trace:procname", params, |
491 | &pretty->options.print_trace_procname_field); | |
6e1bc0df | 492 | |
88488ff5 SM |
493 | apply_one_bool_if_specified("field-trace:vpid", params, |
494 | &pretty->options.print_trace_vpid_field); | |
6e1bc0df | 495 | |
88488ff5 SM |
496 | apply_one_bool_if_specified("field-loglevel", params, |
497 | &pretty->options.print_loglevel_field); | |
6e1bc0df | 498 | |
88488ff5 SM |
499 | apply_one_bool_if_specified("field-emf", params, |
500 | &pretty->options.print_emf_field); | |
6e1bc0df | 501 | |
88488ff5 SM |
502 | apply_one_bool_if_specified("field-callsite", params, |
503 | &pretty->options.print_callsite_field); | |
504 | ||
04609487 | 505 | pretty_print_init(); |
88488ff5 | 506 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; |
6e1bc0df | 507 | |
6e1bc0df | 508 | end: |
88488ff5 SM |
509 | g_free(validate_error); |
510 | ||
511 | return status; | |
6e1bc0df MD |
512 | } |
513 | ||
ad96d936 | 514 | static |
3228cc1d | 515 | void set_use_colors(struct pretty_component *pretty) |
ad96d936 | 516 | { |
3228cc1d PP |
517 | switch (pretty->options.color) { |
518 | case PRETTY_COLOR_OPT_ALWAYS: | |
519 | pretty->use_colors = true; | |
ad96d936 | 520 | break; |
3228cc1d PP |
521 | case PRETTY_COLOR_OPT_AUTO: |
522 | pretty->use_colors = pretty->out == stdout && | |
ad96d936 PP |
523 | bt_common_colors_supported(); |
524 | break; | |
3228cc1d PP |
525 | case PRETTY_COLOR_OPT_NEVER: |
526 | pretty->use_colors = false; | |
ad96d936 PP |
527 | break; |
528 | } | |
529 | } | |
530 | ||
3228cc1d | 531 | BT_HIDDEN |
21a9f056 | 532 | bt_component_class_initialize_method_status pretty_init( |
88488ff5 | 533 | bt_self_component_sink *self_comp_sink, |
59225a3e SM |
534 | bt_self_component_sink_configuration *config, |
535 | const bt_value *params, | |
c88dd1cb | 536 | __attribute__((unused)) void *init_method_data) |
bac67f0f | 537 | { |
88488ff5 SM |
538 | bt_component_class_initialize_method_status status; |
539 | bt_self_component_add_port_status add_port_status; | |
3228cc1d | 540 | struct pretty_component *pretty = create_pretty(); |
88488ff5 SM |
541 | bt_self_component *self_comp = |
542 | bt_self_component_sink_as_self_component(self_comp_sink); | |
543 | const bt_component *comp = bt_self_component_as_component(self_comp); | |
544 | bt_logging_level log_level = bt_component_get_logging_level(comp); | |
bac67f0f | 545 | |
3228cc1d | 546 | if (!pretty) { |
88488ff5 SM |
547 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
548 | goto error; | |
bac67f0f JG |
549 | } |
550 | ||
88488ff5 SM |
551 | add_port_status = bt_self_component_sink_add_input_port(self_comp_sink, |
552 | in_port_name, NULL, NULL); | |
553 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { | |
554 | status = (int) add_port_status; | |
d24d5663 | 555 | goto error; |
b9d103be PP |
556 | } |
557 | ||
3228cc1d PP |
558 | pretty->out = stdout; |
559 | pretty->err = stderr; | |
6e1bc0df | 560 | |
3228cc1d PP |
561 | pretty->delta_cycles = -1ULL; |
562 | pretty->last_cycles_timestamp = -1ULL; | |
3af83b5a | 563 | |
3228cc1d PP |
564 | pretty->delta_real_timestamp = -1ULL; |
565 | pretty->last_real_timestamp = -1ULL; | |
3af83b5a | 566 | |
88488ff5 SM |
567 | status = apply_params(pretty, params, self_comp, log_level); |
568 | if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { | |
6e1bc0df MD |
569 | goto error; |
570 | } | |
571 | ||
3228cc1d | 572 | set_use_colors(pretty); |
88488ff5 | 573 | bt_self_component_set_data(self_comp, pretty); |
2b4c4a7c | 574 | |
88488ff5 SM |
575 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; |
576 | goto end; | |
d94d92ac | 577 | |
bac67f0f | 578 | error: |
3228cc1d | 579 | destroy_pretty_data(pretty); |
88488ff5 SM |
580 | |
581 | end: | |
582 | return status; | |
bac67f0f | 583 | } |