2 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #include <babeltrace/babeltrace.h>
27 #include <babeltrace/compiler-internal.h>
28 #include <babeltrace/common-internal.h>
29 #include <plugins-common.h>
33 #include <babeltrace/assert-internal.h>
37 GQuark stream_packet_context_quarks
[STREAM_PACKET_CONTEXT_QUARKS_LEN
];
40 const char *plugin_options
[] = {
49 "name-default", /* show/hide */
54 "field-default", /* show/hide */
56 "field-trace:hostname",
58 "field-trace:procname",
66 const char * const in_port_name
= "in";
69 void destroy_pretty_data(struct pretty_component
*pretty
)
71 bt_self_component_port_input_message_iterator_put_ref(pretty
->iterator
);
74 (void) g_string_free(pretty
->string
, TRUE
);
77 if (pretty
->tmp_string
) {
78 (void) g_string_free(pretty
->tmp_string
, TRUE
);
81 if (pretty
->out
!= stdout
) {
84 ret
= fclose(pretty
->out
);
86 perror("close output file");
89 g_free(pretty
->options
.output_path
);
94 struct pretty_component
*create_pretty(void)
96 struct pretty_component
*pretty
;
98 pretty
= g_new0(struct pretty_component
, 1);
102 pretty
->string
= g_string_new("");
103 if (!pretty
->string
) {
106 pretty
->tmp_string
= g_string_new("");
107 if (!pretty
->tmp_string
) {
119 void pretty_finalize(bt_self_component_sink
*comp
)
122 bt_self_component_get_data(
123 bt_self_component_sink_as_self_component(comp
)));
127 bt_self_component_status
handle_message(
128 struct pretty_component
*pretty
,
129 const bt_message
*message
)
131 bt_self_component_status ret
= BT_SELF_COMPONENT_STATUS_OK
;
135 switch (bt_message_get_type(message
)) {
136 case BT_MESSAGE_TYPE_EVENT
:
137 if (pretty_print_event(pretty
, message
)) {
138 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
141 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
142 fprintf(stderr
, "Message iterator inactivity message\n");
144 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
145 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
146 if (pretty_print_discarded_items(pretty
, message
)) {
147 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
158 bt_self_component_status
pretty_graph_is_configured(
159 bt_self_component_sink
*comp
)
161 bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
162 struct pretty_component
*pretty
;
164 pretty
= bt_self_component_get_data(
165 bt_self_component_sink_as_self_component(comp
));
167 BT_ASSERT(!pretty
->iterator
);
168 pretty
->iterator
= bt_self_component_port_input_message_iterator_create(
169 bt_self_component_sink_borrow_input_port_by_name(comp
,
171 if (!pretty
->iterator
) {
172 status
= BT_SELF_COMPONENT_STATUS_NOMEM
;
179 bt_self_component_status
pretty_consume(
180 bt_self_component_sink
*comp
)
182 bt_self_component_status ret
;
183 bt_message_array_const msgs
;
184 bt_self_component_port_input_message_iterator
*it
;
185 struct pretty_component
*pretty
= bt_self_component_get_data(
186 bt_self_component_sink_as_self_component(comp
));
187 bt_message_iterator_status it_ret
;
191 it
= pretty
->iterator
;
192 it_ret
= bt_self_component_port_input_message_iterator_next(it
,
196 case BT_MESSAGE_ITERATOR_STATUS_OK
:
198 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
199 ret
= BT_SELF_COMPONENT_STATUS_NOMEM
;
201 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
202 ret
= BT_SELF_COMPONENT_STATUS_AGAIN
;
204 case BT_MESSAGE_ITERATOR_STATUS_END
:
205 ret
= BT_SELF_COMPONENT_STATUS_END
;
206 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(
210 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
214 BT_ASSERT(it_ret
== BT_MESSAGE_ITERATOR_STATUS_OK
);
216 for (i
= 0; i
< count
; i
++) {
217 ret
= handle_message(pretty
, msgs
[i
]);
222 bt_message_put_ref(msgs
[i
]);
226 for (; i
< count
; i
++) {
227 bt_message_put_ref(msgs
[i
]);
234 int add_params_to_map(bt_value
*plugin_opt_map
)
239 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
240 const char *key
= plugin_options
[i
];
241 bt_value_status status
;
243 status
= bt_value_map_insert_entry(plugin_opt_map
, key
,
246 case BT_VALUE_STATUS_OK
:
258 bt_bool
check_param_exists(const char *key
, const bt_value
*object
,
261 struct pretty_component
*pretty
= data
;
263 if (!bt_value_map_has_entry(pretty
->plugin_opt_map
,
266 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
272 void apply_one_string(const char *key
, const bt_value
*params
, char **option
)
274 const bt_value
*value
= NULL
;
277 value
= bt_value_map_borrow_entry_value_const(params
, key
);
281 if (bt_value_is_null(value
)) {
284 str
= bt_value_string_get(value
);
285 *option
= g_strdup(str
);
292 void apply_one_bool(const char *key
, const bt_value
*params
, bool *option
,
295 const bt_value
*value
= NULL
;
298 value
= bt_value_map_borrow_entry_value_const(params
, key
);
302 bool_val
= bt_value_bool_get(value
);
303 *option
= (bool) bool_val
;
313 void warn_wrong_color_param(struct pretty_component
*pretty
)
316 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
320 int open_output_file(struct pretty_component
*pretty
)
324 if (!pretty
->options
.output_path
) {
328 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
343 int apply_params(struct pretty_component
*pretty
, const bt_value
*params
)
346 bt_value_status status
;
350 pretty
->plugin_opt_map
= bt_value_map_create();
351 if (!pretty
->plugin_opt_map
) {
355 ret
= add_params_to_map(pretty
->plugin_opt_map
);
359 /* Report unknown parameters. */
360 status
= bt_value_map_foreach_entry_const(params
,
361 check_param_exists
, pretty
);
363 case BT_VALUE_STATUS_OK
:
369 /* Known parameters. */
370 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
371 if (bt_value_map_has_entry(params
, "color")) {
372 const bt_value
*color_value
;
375 color_value
= bt_value_map_borrow_entry_value_const(params
,
381 color
= bt_value_string_get(color_value
);
383 if (strcmp(color
, "never") == 0) {
384 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
385 } else if (strcmp(color
, "auto") == 0) {
386 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
387 } else if (strcmp(color
, "always") == 0) {
388 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
390 warn_wrong_color_param(pretty
);
394 apply_one_string("path", params
, &pretty
->options
.output_path
);
395 ret
= open_output_file(pretty
);
400 value
= false; /* Default. */
401 apply_one_bool("no-delta", params
, &value
, NULL
);
402 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
404 value
= false; /* Default. */
405 apply_one_bool("clock-cycles", params
, &value
, NULL
);
406 pretty
->options
.print_timestamp_cycles
= value
;
408 value
= false; /* Default. */
409 apply_one_bool("clock-seconds", params
, &value
, NULL
);
410 pretty
->options
.clock_seconds
= value
;
412 value
= false; /* Default. */
413 apply_one_bool("clock-date", params
, &value
, NULL
);
414 pretty
->options
.clock_date
= value
;
416 value
= false; /* Default. */
417 apply_one_bool("clock-gmt", params
, &value
, NULL
);
418 pretty
->options
.clock_gmt
= value
;
420 value
= false; /* Default. */
421 apply_one_bool("verbose", params
, &value
, NULL
);
422 pretty
->options
.verbose
= value
;
425 apply_one_string("name-default", params
, &str
);
427 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
428 } else if (!strcmp(str
, "show")) {
429 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
430 } else if (!strcmp(str
, "hide")) {
431 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
439 switch (pretty
->options
.name_default
) {
440 case PRETTY_DEFAULT_UNSET
:
441 pretty
->options
.print_payload_field_names
= true;
442 pretty
->options
.print_context_field_names
= true;
443 pretty
->options
.print_header_field_names
= false;
444 pretty
->options
.print_scope_field_names
= false;
446 case PRETTY_DEFAULT_SHOW
:
447 pretty
->options
.print_payload_field_names
= true;
448 pretty
->options
.print_context_field_names
= true;
449 pretty
->options
.print_header_field_names
= true;
450 pretty
->options
.print_scope_field_names
= true;
452 case PRETTY_DEFAULT_HIDE
:
453 pretty
->options
.print_payload_field_names
= false;
454 pretty
->options
.print_context_field_names
= false;
455 pretty
->options
.print_header_field_names
= false;
456 pretty
->options
.print_scope_field_names
= false;
465 apply_one_bool("name-payload", params
, &value
, &found
);
467 pretty
->options
.print_payload_field_names
= value
;
472 apply_one_bool("name-context", params
, &value
, &found
);
474 pretty
->options
.print_context_field_names
= value
;
479 apply_one_bool("name-header", params
, &value
, &found
);
481 pretty
->options
.print_header_field_names
= value
;
486 apply_one_bool("name-scope", params
, &value
, &found
);
488 pretty
->options
.print_scope_field_names
= value
;
492 apply_one_string("field-default", params
, &str
);
494 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
495 } else if (!strcmp(str
, "show")) {
496 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
497 } else if (!strcmp(str
, "hide")) {
498 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
506 switch (pretty
->options
.field_default
) {
507 case PRETTY_DEFAULT_UNSET
:
508 pretty
->options
.print_trace_field
= false;
509 pretty
->options
.print_trace_hostname_field
= true;
510 pretty
->options
.print_trace_domain_field
= false;
511 pretty
->options
.print_trace_procname_field
= true;
512 pretty
->options
.print_trace_vpid_field
= true;
513 pretty
->options
.print_loglevel_field
= false;
514 pretty
->options
.print_emf_field
= false;
515 pretty
->options
.print_callsite_field
= false;
517 case PRETTY_DEFAULT_SHOW
:
518 pretty
->options
.print_trace_field
= true;
519 pretty
->options
.print_trace_hostname_field
= true;
520 pretty
->options
.print_trace_domain_field
= true;
521 pretty
->options
.print_trace_procname_field
= true;
522 pretty
->options
.print_trace_vpid_field
= true;
523 pretty
->options
.print_loglevel_field
= true;
524 pretty
->options
.print_emf_field
= true;
525 pretty
->options
.print_callsite_field
= true;
527 case PRETTY_DEFAULT_HIDE
:
528 pretty
->options
.print_trace_field
= false;
529 pretty
->options
.print_trace_hostname_field
= false;
530 pretty
->options
.print_trace_domain_field
= false;
531 pretty
->options
.print_trace_procname_field
= false;
532 pretty
->options
.print_trace_vpid_field
= false;
533 pretty
->options
.print_loglevel_field
= false;
534 pretty
->options
.print_emf_field
= false;
535 pretty
->options
.print_callsite_field
= false;
544 apply_one_bool("field-trace", params
, &value
, &found
);
546 pretty
->options
.print_trace_field
= value
;
551 apply_one_bool("field-trace:hostname", params
, &value
, &found
);
553 pretty
->options
.print_trace_hostname_field
= value
;
558 apply_one_bool("field-trace:domain", params
, &value
, &found
);
560 pretty
->options
.print_trace_domain_field
= value
;
565 apply_one_bool("field-trace:procname", params
, &value
, &found
);
567 pretty
->options
.print_trace_procname_field
= value
;
572 apply_one_bool("field-trace:vpid", params
, &value
, &found
);
574 pretty
->options
.print_trace_vpid_field
= value
;
579 apply_one_bool("field-loglevel", params
, &value
, &found
);
581 pretty
->options
.print_loglevel_field
= value
;
586 apply_one_bool("field-emf", params
, &value
, &found
);
588 pretty
->options
.print_emf_field
= value
;
593 apply_one_bool("field-callsite", params
, &value
, &found
);
595 pretty
->options
.print_callsite_field
= value
;
599 bt_value_put_ref(pretty
->plugin_opt_map
);
600 pretty
->plugin_opt_map
= NULL
;
606 void set_use_colors(struct pretty_component
*pretty
)
608 switch (pretty
->options
.color
) {
609 case PRETTY_COLOR_OPT_ALWAYS
:
610 pretty
->use_colors
= true;
612 case PRETTY_COLOR_OPT_AUTO
:
613 pretty
->use_colors
= pretty
->out
== stdout
&&
614 bt_common_colors_supported();
616 case PRETTY_COLOR_OPT_NEVER
:
617 pretty
->use_colors
= false;
623 void init_stream_packet_context_quarks(void)
625 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
626 g_quark_from_string("timestamp_begin");
627 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
628 g_quark_from_string("timestamp_begin");
629 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
630 g_quark_from_string("timestamp_end");
631 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
632 g_quark_from_string("events_discarded");
633 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
634 g_quark_from_string("content_size");
635 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
636 g_quark_from_string("packet_size");
637 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
638 g_quark_from_string("packet_seq_num");
642 bt_self_component_status
pretty_init(
643 bt_self_component_sink
*comp
,
644 const bt_value
*params
,
645 UNUSED_VAR
void *init_method_data
)
647 bt_self_component_status ret
;
648 struct pretty_component
*pretty
= create_pretty();
651 ret
= BT_SELF_COMPONENT_STATUS_NOMEM
;
655 ret
= bt_self_component_sink_add_input_port(comp
, in_port_name
,
657 if (ret
!= BT_SELF_COMPONENT_STATUS_OK
) {
661 pretty
->out
= stdout
;
662 pretty
->err
= stderr
;
664 pretty
->delta_cycles
= -1ULL;
665 pretty
->last_cycles_timestamp
= -1ULL;
667 pretty
->delta_real_timestamp
= -1ULL;
668 pretty
->last_real_timestamp
= -1ULL;
670 if (apply_params(pretty
, params
)) {
671 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
675 set_use_colors(pretty
);
676 bt_self_component_set_data(
677 bt_self_component_sink_as_self_component(comp
), pretty
);
678 init_stream_packet_context_quarks();
684 destroy_pretty_data(pretty
);