2 * SPDX-License-Identifier: MIT
4 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 #define BT_COMP_LOG_SELF_COMP (pretty->self_comp)
9 #define BT_LOG_OUTPUT_LEVEL (pretty->log_level)
10 #define BT_LOG_TAG "PLUGIN/SINK.TEXT.PRETTY"
11 #include "logging/comp-logging.h"
13 #include <babeltrace2/babeltrace.h>
14 #include "compat/compiler.h"
15 #include "common/common.h"
20 #include "common/assert.h"
21 #include "plugins/common/param-validation/param-validation.h"
26 const char * const in_port_name
= "in";
29 void destroy_pretty_data(struct pretty_component
*pretty
)
35 bt_message_iterator_put_ref(pretty
->iterator
);
38 (void) g_string_free(pretty
->string
, TRUE
);
41 if (pretty
->tmp_string
) {
42 (void) g_string_free(pretty
->tmp_string
, TRUE
);
45 if (pretty
->out
!= stdout
) {
48 ret
= fclose(pretty
->out
);
50 perror("close output file");
53 g_free(pretty
->options
.output_path
);
61 struct pretty_component
*create_pretty(void)
63 struct pretty_component
*pretty
;
65 pretty
= g_new0(struct pretty_component
, 1);
69 pretty
->string
= g_string_new("");
70 if (!pretty
->string
) {
73 pretty
->tmp_string
= g_string_new("");
74 if (!pretty
->tmp_string
) {
86 void pretty_finalize(bt_self_component_sink
*comp
)
89 bt_self_component_get_data(
90 bt_self_component_sink_as_self_component(comp
)));
94 bt_message_iterator_class_next_method_status
handle_message(
95 struct pretty_component
*pretty
,
96 const bt_message
*message
)
98 bt_message_iterator_class_next_method_status ret
=
99 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
101 BT_ASSERT_DBG(pretty
);
103 switch (bt_message_get_type(message
)) {
104 case BT_MESSAGE_TYPE_EVENT
:
105 if (pretty_print_event(pretty
, message
)) {
106 BT_COMP_LOGE_APPEND_CAUSE(pretty
->self_comp
,
107 "Failed to print one event.");
108 ret
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
111 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
112 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
113 if (pretty_print_discarded_items(pretty
, message
)) {
114 BT_COMP_LOGE_APPEND_CAUSE(pretty
->self_comp
,
115 "Failed to print discarded items.");
116 ret
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
127 bt_component_class_sink_graph_is_configured_method_status
128 pretty_graph_is_configured(bt_self_component_sink
*self_comp_sink
)
130 bt_component_class_sink_graph_is_configured_method_status status
;
131 bt_message_iterator_create_from_sink_component_status
133 struct pretty_component
*pretty
;
134 bt_self_component
*self_comp
=
135 bt_self_component_sink_as_self_component(self_comp_sink
);
136 bt_self_component_port_input
*in_port
;
138 pretty
= bt_self_component_get_data(self_comp
);
140 BT_ASSERT(!pretty
->iterator
);
142 in_port
= bt_self_component_sink_borrow_input_port_by_name(self_comp_sink
,
144 if (!bt_port_is_connected(bt_port_input_as_port_const(
145 bt_self_component_port_input_as_port_input(in_port
)))) {
146 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Single input port is not connected: "
147 "port-name=\"%s\"", in_port_name
);
148 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR
;
152 msg_iter_status
= bt_message_iterator_create_from_sink_component(
153 self_comp_sink
, in_port
, &pretty
->iterator
);
154 if (msg_iter_status
!= BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK
) {
155 status
= (int) msg_iter_status
;
159 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK
;
166 bt_component_class_sink_consume_method_status
pretty_consume(
167 bt_self_component_sink
*comp
)
169 bt_component_class_sink_consume_method_status status
;
170 bt_message_array_const msgs
;
171 bt_message_iterator
*it
;
172 struct pretty_component
*pretty
= bt_self_component_get_data(
173 bt_self_component_sink_as_self_component(comp
));
174 bt_message_iterator_next_status next_status
;
178 it
= pretty
->iterator
;
179 next_status
= bt_message_iterator_next(it
,
181 if (next_status
!= BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
182 status
= (int) next_status
;
186 for (i
= 0; i
< count
; i
++) {
187 status
= (int) handle_message(pretty
, msgs
[i
]);
192 bt_message_put_ref(msgs
[i
]);
195 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
198 for (; i
< count
; i
++) {
199 bt_message_put_ref(msgs
[i
]);
206 void apply_one_string(const char *key
, const bt_value
*params
, char **option
)
208 const bt_value
*value
= NULL
;
211 value
= bt_value_map_borrow_entry_value_const(params
, key
);
216 str
= bt_value_string_get(value
);
217 *option
= g_strdup(str
);
224 * Apply parameter with key `key` to `option`. Use `def` as the value, if
225 * the parameter is not specified.
229 void apply_one_bool_with_default(const char *key
, const bt_value
*params
,
230 bool *option
, bool def
)
232 const bt_value
*value
;
234 value
= bt_value_map_borrow_entry_value_const(params
, key
);
236 bt_bool bool_val
= bt_value_bool_get(value
);
238 *option
= (bool) bool_val
;
245 void apply_one_bool_if_specified(const char *key
, const bt_value
*params
, bool *option
)
247 const bt_value
*value
;
249 value
= bt_value_map_borrow_entry_value_const(params
, key
);
251 bt_bool bool_val
= bt_value_bool_get(value
);
253 *option
= (bool) bool_val
;
258 int open_output_file(struct pretty_component
*pretty
)
262 if (!pretty
->options
.output_path
) {
266 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
280 static const char *color_choices
[] = { "never", "auto", "always", NULL
};
281 static const char *show_hide_choices
[] = { "show", "hide", NULL
};
284 struct bt_param_validation_map_value_entry_descr pretty_params
[] = {
285 { "color", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { BT_VALUE_TYPE_STRING
, .string
= {
286 .choices
= color_choices
,
288 { "path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
289 { "no-delta", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
290 { "clock-cycles", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
291 { "clock-seconds", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
292 { "clock-date", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
293 { "clock-gmt", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
294 { "verbose", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
296 { "name-default", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { BT_VALUE_TYPE_STRING
, .string
= {
297 .choices
= show_hide_choices
,
299 { "name-payload", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
300 { "name-context", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
301 { "name-scope", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
302 { "name-header", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
304 { "field-default", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { BT_VALUE_TYPE_STRING
, .string
= {
305 .choices
= show_hide_choices
,
307 { "field-trace", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
308 { "field-trace:hostname", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
309 { "field-trace:domain", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
310 { "field-trace:procname", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
311 { "field-trace:vpid", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
312 { "field-loglevel", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
313 { "field-emf", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
314 { "field-callsite", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
315 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
319 bt_component_class_initialize_method_status
apply_params(
320 struct pretty_component
*pretty
, const bt_value
*params
)
323 const bt_value
*value
;
324 bt_component_class_initialize_method_status status
;
325 enum bt_param_validation_status validation_status
;
326 gchar
*validate_error
= NULL
;
328 validation_status
= bt_param_validation_validate(params
,
329 pretty_params
, &validate_error
);
330 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
331 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
333 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
334 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
335 BT_COMP_LOGE_APPEND_CAUSE(pretty
->self_comp
, "%s", validate_error
);
339 /* Known parameters. */
340 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
341 value
= bt_value_map_borrow_entry_value_const(params
, "color");
343 const char *color
= bt_value_string_get(value
);
345 if (strcmp(color
, "never") == 0) {
346 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
347 } else if (strcmp(color
, "auto") == 0) {
348 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
350 BT_ASSERT(strcmp(color
, "always") == 0);
351 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
355 apply_one_string("path", params
, &pretty
->options
.output_path
);
356 ret
= open_output_file(pretty
);
358 BT_COMP_LOGE_APPEND_CAUSE(pretty
->self_comp
,
359 "Failed to open output file: %s", validate_error
);
360 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
364 apply_one_bool_with_default("no-delta", params
,
365 &pretty
->options
.print_delta_field
, false);
367 pretty
->options
.print_delta_field
= !pretty
->options
.print_delta_field
;
369 apply_one_bool_with_default("clock-cycles", params
,
370 &pretty
->options
.print_timestamp_cycles
, false);
372 apply_one_bool_with_default("clock-seconds", params
,
373 &pretty
->options
.clock_seconds
, false);
375 apply_one_bool_with_default("clock-date", params
,
376 &pretty
->options
.clock_date
, false);
378 apply_one_bool_with_default("clock-gmt", params
,
379 &pretty
->options
.clock_gmt
, false);
381 apply_one_bool_with_default("verbose", params
,
382 &pretty
->options
.verbose
, false);
385 value
= bt_value_map_borrow_entry_value_const(params
, "name-default");
387 const char *str
= bt_value_string_get(value
);
389 if (strcmp(str
, "show") == 0) {
390 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
392 BT_ASSERT(strcmp(str
, "hide") == 0);
393 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
396 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
399 switch (pretty
->options
.name_default
) {
400 case PRETTY_DEFAULT_UNSET
:
401 pretty
->options
.print_payload_field_names
= true;
402 pretty
->options
.print_context_field_names
= true;
403 pretty
->options
.print_header_field_names
= false;
404 pretty
->options
.print_scope_field_names
= false;
406 case PRETTY_DEFAULT_SHOW
:
407 pretty
->options
.print_payload_field_names
= true;
408 pretty
->options
.print_context_field_names
= true;
409 pretty
->options
.print_header_field_names
= true;
410 pretty
->options
.print_scope_field_names
= true;
412 case PRETTY_DEFAULT_HIDE
:
413 pretty
->options
.print_payload_field_names
= false;
414 pretty
->options
.print_context_field_names
= false;
415 pretty
->options
.print_header_field_names
= false;
416 pretty
->options
.print_scope_field_names
= false;
422 apply_one_bool_if_specified("name-payload", params
,
423 &pretty
->options
.print_payload_field_names
);
425 apply_one_bool_if_specified("name-context", params
,
426 &pretty
->options
.print_context_field_names
);
428 apply_one_bool_if_specified("name-header", params
,
429 &pretty
->options
.print_header_field_names
);
431 apply_one_bool_if_specified("name-scope", params
,
432 &pretty
->options
.print_scope_field_names
);
435 value
= bt_value_map_borrow_entry_value_const(params
, "field-default");
437 const char *str
= bt_value_string_get(value
);
439 if (strcmp(str
, "show") == 0) {
440 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
442 BT_ASSERT(strcmp(str
, "hide") == 0);
443 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
446 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
449 switch (pretty
->options
.field_default
) {
450 case PRETTY_DEFAULT_UNSET
:
451 pretty
->options
.print_trace_field
= false;
452 pretty
->options
.print_trace_hostname_field
= true;
453 pretty
->options
.print_trace_domain_field
= false;
454 pretty
->options
.print_trace_procname_field
= true;
455 pretty
->options
.print_trace_vpid_field
= true;
456 pretty
->options
.print_loglevel_field
= false;
457 pretty
->options
.print_emf_field
= false;
458 pretty
->options
.print_callsite_field
= false;
460 case PRETTY_DEFAULT_SHOW
:
461 pretty
->options
.print_trace_field
= true;
462 pretty
->options
.print_trace_hostname_field
= true;
463 pretty
->options
.print_trace_domain_field
= true;
464 pretty
->options
.print_trace_procname_field
= true;
465 pretty
->options
.print_trace_vpid_field
= true;
466 pretty
->options
.print_loglevel_field
= true;
467 pretty
->options
.print_emf_field
= true;
468 pretty
->options
.print_callsite_field
= true;
470 case PRETTY_DEFAULT_HIDE
:
471 pretty
->options
.print_trace_field
= false;
472 pretty
->options
.print_trace_hostname_field
= false;
473 pretty
->options
.print_trace_domain_field
= false;
474 pretty
->options
.print_trace_procname_field
= false;
475 pretty
->options
.print_trace_vpid_field
= false;
476 pretty
->options
.print_loglevel_field
= false;
477 pretty
->options
.print_emf_field
= false;
478 pretty
->options
.print_callsite_field
= false;
484 apply_one_bool_if_specified("field-trace", params
,
485 &pretty
->options
.print_trace_field
);
487 apply_one_bool_if_specified("field-trace:hostname", params
,
488 &pretty
->options
.print_trace_hostname_field
);
490 apply_one_bool_if_specified("field-trace:domain", params
,
491 &pretty
->options
.print_trace_domain_field
);
493 apply_one_bool_if_specified("field-trace:procname", params
,
494 &pretty
->options
.print_trace_procname_field
);
496 apply_one_bool_if_specified("field-trace:vpid", params
,
497 &pretty
->options
.print_trace_vpid_field
);
499 apply_one_bool_if_specified("field-loglevel", params
,
500 &pretty
->options
.print_loglevel_field
);
502 apply_one_bool_if_specified("field-emf", params
,
503 &pretty
->options
.print_emf_field
);
505 apply_one_bool_if_specified("field-callsite", params
,
506 &pretty
->options
.print_callsite_field
);
509 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
512 g_free(validate_error
);
518 void set_use_colors(struct pretty_component
*pretty
)
520 switch (pretty
->options
.color
) {
521 case PRETTY_COLOR_OPT_ALWAYS
:
522 pretty
->use_colors
= true;
524 case PRETTY_COLOR_OPT_AUTO
:
525 pretty
->use_colors
= pretty
->out
== stdout
&&
526 bt_common_colors_supported();
528 case PRETTY_COLOR_OPT_NEVER
:
529 pretty
->use_colors
= false;
535 bt_component_class_initialize_method_status
pretty_init(
536 bt_self_component_sink
*self_comp_sink
,
537 bt_self_component_sink_configuration
*config
,
538 const bt_value
*params
,
539 __attribute__((unused
)) void *init_method_data
)
541 bt_component_class_initialize_method_status status
;
542 bt_self_component_add_port_status add_port_status
;
543 struct pretty_component
*pretty
= create_pretty();
544 bt_self_component
*self_comp
=
545 bt_self_component_sink_as_self_component(self_comp_sink
);
546 const bt_component
*comp
= bt_self_component_as_component(self_comp
);
547 bt_logging_level log_level
= bt_component_get_logging_level(comp
);
551 * Don't use BT_COMP_LOGE_APPEND_CAUSE, as `pretty` is not
554 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
555 "Failed to allocate component.");
556 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
557 self_comp
, "Failed to allocate component.");
558 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
562 pretty
->self_comp
= self_comp
;
563 pretty
->log_level
= log_level
;
565 add_port_status
= bt_self_component_sink_add_input_port(self_comp_sink
,
566 in_port_name
, NULL
, NULL
);
567 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
568 status
= (int) add_port_status
;
572 pretty
->out
= stdout
;
573 pretty
->err
= stderr
;
575 pretty
->delta_cycles
= -1ULL;
576 pretty
->last_cycles_timestamp
= -1ULL;
578 pretty
->delta_real_timestamp
= -1ULL;
579 pretty
->last_real_timestamp
= -1ULL;
581 status
= apply_params(pretty
, params
);
582 if (status
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
586 set_use_colors(pretty
);
587 bt_self_component_set_data(self_comp
, pretty
);
589 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
593 destroy_pretty_data(pretty
);