4 * Babeltrace CTF Text Output Plugin
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 #include <babeltrace/babeltrace.h>
31 #include <babeltrace/values.h>
32 #include <babeltrace/compiler-internal.h>
33 #include <babeltrace/common-internal.h>
34 #include <plugins-common.h>
38 #include <babeltrace/assert-internal.h>
42 GQuark stream_packet_context_quarks
[STREAM_PACKET_CONTEXT_QUARKS_LEN
];
45 const char *plugin_options
[] = {
54 "name-default", /* show/hide */
59 "field-default", /* show/hide */
61 "field-trace:hostname",
63 "field-trace:procname",
71 void destroy_pretty_data(struct pretty_component
*pretty
)
73 bt_put(pretty
->input_iterator
);
76 (void) g_string_free(pretty
->string
, TRUE
);
79 if (pretty
->tmp_string
) {
80 (void) g_string_free(pretty
->tmp_string
, TRUE
);
83 if (pretty
->out
!= stdout
) {
86 ret
= fclose(pretty
->out
);
88 perror("close output file");
91 g_free(pretty
->options
.output_path
);
96 struct pretty_component
*create_pretty(void)
98 struct pretty_component
*pretty
;
100 pretty
= g_new0(struct pretty_component
, 1);
104 pretty
->string
= g_string_new("");
105 if (!pretty
->string
) {
108 pretty
->tmp_string
= g_string_new("");
109 if (!pretty
->tmp_string
) {
121 void pretty_finalize(struct bt_private_component
*component
)
123 void *data
= bt_private_component_get_user_data(component
);
125 destroy_pretty_data(data
);
129 enum bt_component_status
handle_notification(struct pretty_component
*pretty
,
130 struct bt_notification
*notification
)
132 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
136 switch (bt_notification_get_type(notification
)) {
137 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
138 ret
= pretty_print_packet(pretty
, notification
);
140 case BT_NOTIFICATION_TYPE_EVENT
:
141 ret
= pretty_print_event(pretty
, notification
);
143 case BT_NOTIFICATION_TYPE_INACTIVITY
:
144 fprintf(stderr
, "Inactivity notification\n");
154 enum bt_component_status
pretty_port_connected(
155 struct bt_private_component
*component
,
156 struct bt_private_port
*self_port
,
157 struct bt_port
*other_port
)
159 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
160 enum bt_connection_status conn_status
;
161 struct bt_private_connection
*connection
;
162 struct pretty_component
*pretty
;
164 pretty
= bt_private_component_get_user_data(component
);
166 BT_ASSERT(!pretty
->input_iterator
);
167 connection
= bt_private_port_get_private_connection(self_port
);
168 BT_ASSERT(connection
);
169 conn_status
= bt_private_connection_create_notification_iterator(
170 connection
, &pretty
->input_iterator
);
171 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
172 status
= BT_COMPONENT_STATUS_ERROR
;
180 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
182 enum bt_component_status ret
;
183 bt_notification_array notifs
;
184 struct bt_notification_iterator
*it
;
185 struct pretty_component
*pretty
=
186 bt_private_component_get_user_data(component
);
187 enum bt_notification_iterator_status it_ret
;
191 it
= pretty
->input_iterator
;
192 it_ret
= bt_private_connection_notification_iterator_next(it
, ¬ifs
,
196 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
197 ret
= BT_COMPONENT_STATUS_END
;
198 BT_PUT(pretty
->input_iterator
);
200 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
201 ret
= BT_COMPONENT_STATUS_AGAIN
;
203 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
206 ret
= BT_COMPONENT_STATUS_ERROR
;
210 BT_ASSERT(it_ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
);
212 for (i
= 0; i
< count
; i
++) {
213 ret
= handle_notification(pretty
, notifs
[i
]);
222 for (; i
< count
; i
++) {
230 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
232 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
235 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
236 const char *key
= plugin_options
[i
];
237 enum bt_value_status status
;
239 status
= bt_value_map_insert_entry(plugin_opt_map
, key
, bt_value_null
);
241 case BT_VALUE_STATUS_OK
:
244 ret
= BT_COMPONENT_STATUS_ERROR
;
253 bt_bool
check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
255 struct pretty_component
*pretty
= data
;
256 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
258 if (!bt_value_map_has_entry(plugin_opt_map
, key
)) {
260 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
266 enum bt_component_status
apply_one_string(const char *key
,
267 struct bt_value
*params
,
270 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
271 struct bt_value
*value
= NULL
;
272 enum bt_value_status status
;
275 value
= bt_value_map_borrow_entry_value(params
, key
);
279 if (bt_value_is_null(value
)) {
282 status
= bt_value_string_get(value
, &str
);
284 case BT_VALUE_STATUS_OK
:
287 ret
= BT_COMPONENT_STATUS_ERROR
;
290 *option
= g_strdup(str
);
296 enum bt_component_status
apply_one_bool(const char *key
,
297 struct bt_value
*params
,
301 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
302 struct bt_value
*value
= NULL
;
303 enum bt_value_status status
;
306 value
= bt_value_map_borrow_entry_value(params
, key
);
310 status
= bt_value_bool_get(value
, &bool_val
);
312 case BT_VALUE_STATUS_OK
:
315 ret
= BT_COMPONENT_STATUS_ERROR
;
318 *option
= (bool) bool_val
;
328 void warn_wrong_color_param(struct pretty_component
*pretty
)
331 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
335 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
337 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
339 if (!pretty
->options
.output_path
) {
343 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
351 ret
= BT_COMPONENT_STATUS_ERROR
;
357 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
358 struct bt_value
*params
)
360 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
361 enum bt_value_status status
;
365 pretty
->plugin_opt_map
= bt_value_map_create();
366 if (!pretty
->plugin_opt_map
) {
367 ret
= BT_COMPONENT_STATUS_ERROR
;
370 ret
= add_params_to_map(pretty
->plugin_opt_map
);
371 if (ret
!= BT_COMPONENT_STATUS_OK
) {
374 /* Report unknown parameters. */
375 status
= bt_value_map_foreach_entry(params
, check_param_exists
, pretty
);
377 case BT_VALUE_STATUS_OK
:
380 ret
= BT_COMPONENT_STATUS_ERROR
;
383 /* Known parameters. */
384 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
385 if (bt_value_map_has_entry(params
, "color")) {
386 struct bt_value
*color_value
;
389 color_value
= bt_value_map_borrow_entry_value(params
, "color");
394 status
= bt_value_string_get(color_value
, &color
);
396 warn_wrong_color_param(pretty
);
398 if (strcmp(color
, "never") == 0) {
399 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
400 } else if (strcmp(color
, "auto") == 0) {
401 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
402 } else if (strcmp(color
, "always") == 0) {
403 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
405 warn_wrong_color_param(pretty
);
410 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
411 if (ret
!= BT_COMPONENT_STATUS_OK
) {
414 ret
= open_output_file(pretty
);
415 if (ret
!= BT_COMPONENT_STATUS_OK
) {
419 value
= false; /* Default. */
420 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
421 if (ret
!= BT_COMPONENT_STATUS_OK
) {
424 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
426 value
= false; /* Default. */
427 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
428 if (ret
!= BT_COMPONENT_STATUS_OK
) {
431 pretty
->options
.print_timestamp_cycles
= value
;
433 value
= false; /* Default. */
434 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
435 if (ret
!= BT_COMPONENT_STATUS_OK
) {
438 pretty
->options
.clock_seconds
= value
;
440 value
= false; /* Default. */
441 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
442 if (ret
!= BT_COMPONENT_STATUS_OK
) {
445 pretty
->options
.clock_date
= value
;
447 value
= false; /* Default. */
448 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
449 if (ret
!= BT_COMPONENT_STATUS_OK
) {
452 pretty
->options
.clock_gmt
= value
;
454 value
= false; /* Default. */
455 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
456 if (ret
!= BT_COMPONENT_STATUS_OK
) {
459 pretty
->options
.verbose
= value
;
462 ret
= apply_one_string("name-default", params
, &str
);
463 if (ret
!= BT_COMPONENT_STATUS_OK
) {
467 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
468 } else if (!strcmp(str
, "show")) {
469 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
470 } else if (!strcmp(str
, "hide")) {
471 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
473 ret
= BT_COMPONENT_STATUS_ERROR
;
479 switch (pretty
->options
.name_default
) {
480 case PRETTY_DEFAULT_UNSET
:
481 pretty
->options
.print_payload_field_names
= true;
482 pretty
->options
.print_context_field_names
= true;
483 pretty
->options
.print_header_field_names
= false;
484 pretty
->options
.print_scope_field_names
= false;
486 case PRETTY_DEFAULT_SHOW
:
487 pretty
->options
.print_payload_field_names
= true;
488 pretty
->options
.print_context_field_names
= true;
489 pretty
->options
.print_header_field_names
= true;
490 pretty
->options
.print_scope_field_names
= true;
492 case PRETTY_DEFAULT_HIDE
:
493 pretty
->options
.print_payload_field_names
= false;
494 pretty
->options
.print_context_field_names
= false;
495 pretty
->options
.print_header_field_names
= false;
496 pretty
->options
.print_scope_field_names
= false;
499 ret
= BT_COMPONENT_STATUS_ERROR
;
505 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
506 if (ret
!= BT_COMPONENT_STATUS_OK
) {
510 pretty
->options
.print_payload_field_names
= value
;
515 ret
= apply_one_bool("name-context", params
, &value
, &found
);
516 if (ret
!= BT_COMPONENT_STATUS_OK
) {
520 pretty
->options
.print_context_field_names
= value
;
525 ret
= apply_one_bool("name-header", params
, &value
, &found
);
526 if (ret
!= BT_COMPONENT_STATUS_OK
) {
530 pretty
->options
.print_header_field_names
= value
;
535 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
536 if (ret
!= BT_COMPONENT_STATUS_OK
) {
540 pretty
->options
.print_scope_field_names
= value
;
544 ret
= apply_one_string("field-default", params
, &str
);
545 if (ret
!= BT_COMPONENT_STATUS_OK
) {
549 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
550 } else if (!strcmp(str
, "show")) {
551 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
552 } else if (!strcmp(str
, "hide")) {
553 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
555 ret
= BT_COMPONENT_STATUS_ERROR
;
561 switch (pretty
->options
.field_default
) {
562 case PRETTY_DEFAULT_UNSET
:
563 pretty
->options
.print_trace_field
= false;
564 pretty
->options
.print_trace_hostname_field
= true;
565 pretty
->options
.print_trace_domain_field
= false;
566 pretty
->options
.print_trace_procname_field
= true;
567 pretty
->options
.print_trace_vpid_field
= true;
568 pretty
->options
.print_loglevel_field
= false;
569 pretty
->options
.print_emf_field
= false;
570 pretty
->options
.print_callsite_field
= false;
572 case PRETTY_DEFAULT_SHOW
:
573 pretty
->options
.print_trace_field
= true;
574 pretty
->options
.print_trace_hostname_field
= true;
575 pretty
->options
.print_trace_domain_field
= true;
576 pretty
->options
.print_trace_procname_field
= true;
577 pretty
->options
.print_trace_vpid_field
= true;
578 pretty
->options
.print_loglevel_field
= true;
579 pretty
->options
.print_emf_field
= true;
580 pretty
->options
.print_callsite_field
= true;
582 case PRETTY_DEFAULT_HIDE
:
583 pretty
->options
.print_trace_field
= false;
584 pretty
->options
.print_trace_hostname_field
= false;
585 pretty
->options
.print_trace_domain_field
= false;
586 pretty
->options
.print_trace_procname_field
= false;
587 pretty
->options
.print_trace_vpid_field
= false;
588 pretty
->options
.print_loglevel_field
= false;
589 pretty
->options
.print_emf_field
= false;
590 pretty
->options
.print_callsite_field
= false;
593 ret
= BT_COMPONENT_STATUS_ERROR
;
599 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
600 if (ret
!= BT_COMPONENT_STATUS_OK
) {
604 pretty
->options
.print_trace_field
= value
;
609 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
610 if (ret
!= BT_COMPONENT_STATUS_OK
) {
614 pretty
->options
.print_trace_hostname_field
= value
;
619 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
620 if (ret
!= BT_COMPONENT_STATUS_OK
) {
624 pretty
->options
.print_trace_domain_field
= value
;
629 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
630 if (ret
!= BT_COMPONENT_STATUS_OK
) {
634 pretty
->options
.print_trace_procname_field
= value
;
639 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
640 if (ret
!= BT_COMPONENT_STATUS_OK
) {
644 pretty
->options
.print_trace_vpid_field
= value
;
649 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
650 if (ret
!= BT_COMPONENT_STATUS_OK
) {
654 pretty
->options
.print_loglevel_field
= value
;
659 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
660 if (ret
!= BT_COMPONENT_STATUS_OK
) {
664 pretty
->options
.print_emf_field
= value
;
669 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
670 if (ret
!= BT_COMPONENT_STATUS_OK
) {
674 pretty
->options
.print_callsite_field
= value
;
678 bt_put(pretty
->plugin_opt_map
);
679 pretty
->plugin_opt_map
= NULL
;
685 void set_use_colors(struct pretty_component
*pretty
)
687 switch (pretty
->options
.color
) {
688 case PRETTY_COLOR_OPT_ALWAYS
:
689 pretty
->use_colors
= true;
691 case PRETTY_COLOR_OPT_AUTO
:
692 pretty
->use_colors
= pretty
->out
== stdout
&&
693 bt_common_colors_supported();
695 case PRETTY_COLOR_OPT_NEVER
:
696 pretty
->use_colors
= false;
702 void init_stream_packet_context_quarks(void)
704 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
705 g_quark_from_string("timestamp_begin");
706 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
707 g_quark_from_string("timestamp_begin");
708 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
709 g_quark_from_string("timestamp_end");
710 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
711 g_quark_from_string("events_discarded");
712 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
713 g_quark_from_string("content_size");
714 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
715 g_quark_from_string("packet_size");
716 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
717 g_quark_from_string("packet_seq_num");
721 enum bt_component_status
pretty_init(
722 struct bt_private_component
*component
,
723 struct bt_value
*params
,
724 UNUSED_VAR
void *init_method_data
)
726 enum bt_component_status ret
;
727 struct pretty_component
*pretty
= create_pretty();
730 ret
= BT_COMPONENT_STATUS_NOMEM
;
734 ret
= bt_private_component_sink_add_input_private_port(component
,
736 if (ret
!= BT_COMPONENT_STATUS_OK
) {
740 pretty
->out
= stdout
;
741 pretty
->err
= stderr
;
743 pretty
->delta_cycles
= -1ULL;
744 pretty
->last_cycles_timestamp
= -1ULL;
746 pretty
->delta_real_timestamp
= -1ULL;
747 pretty
->last_real_timestamp
= -1ULL;
749 ret
= apply_params(pretty
, params
);
750 if (ret
!= BT_COMPONENT_STATUS_OK
) {
754 set_use_colors(pretty
);
755 ret
= bt_private_component_set_user_data(component
, pretty
);
756 if (ret
!= BT_COMPONENT_STATUS_OK
) {
760 init_stream_packet_context_quarks();
765 destroy_pretty_data(pretty
);