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/plugin/plugin-dev.h>
31 #include <babeltrace/graph/component.h>
32 #include <babeltrace/graph/private-component.h>
33 #include <babeltrace/graph/component-sink.h>
34 #include <babeltrace/graph/port.h>
35 #include <babeltrace/graph/private-port.h>
36 #include <babeltrace/graph/connection.h>
37 #include <babeltrace/graph/private-connection.h>
38 #include <babeltrace/graph/notification.h>
39 #include <babeltrace/graph/notification-iterator.h>
40 #include <babeltrace/graph/notification-event.h>
41 #include <babeltrace/values.h>
42 #include <babeltrace/compiler-internal.h>
43 #include <babeltrace/common-internal.h>
44 #include <plugins-common.h>
53 const char *plugin_options
[] = {
57 "debug-info-target-prefix",
58 "debug-info-full-path",
65 "name-default", /* show/hide */
70 "field-default", /* show/hide */
72 "field-trace:hostname",
74 "field-trace:procname",
82 void destroy_pretty_data(struct pretty_component
*pretty
)
84 bt_put(pretty
->input_iterator
);
85 (void) g_string_free(pretty
->string
, TRUE
);
86 if (pretty
->out
!= stdout
) {
89 ret
= fclose(pretty
->out
);
91 perror("close output file");
94 g_free(pretty
->options
.output_path
);
95 g_free(pretty
->options
.debug_info_dir
);
96 g_free(pretty
->options
.debug_info_target_prefix
);
101 struct pretty_component
*create_pretty(void)
103 struct pretty_component
*pretty
;
105 pretty
= g_new0(struct pretty_component
, 1);
109 pretty
->string
= g_string_new("");
110 if (!pretty
->string
) {
122 void pretty_finalize(struct bt_private_component
*component
)
124 void *data
= bt_private_component_get_user_data(component
);
126 destroy_pretty_data(data
);
130 enum bt_component_status
handle_notification(struct pretty_component
*pretty
,
131 struct bt_notification
*notification
)
133 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
136 ret
= BT_COMPONENT_STATUS_ERROR
;
140 switch (bt_notification_get_type(notification
)) {
141 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
143 case BT_NOTIFICATION_TYPE_PACKET_END
:
145 case BT_NOTIFICATION_TYPE_EVENT
:
147 struct bt_ctf_event
*event
= bt_notification_event_get_event(
151 ret
= BT_COMPONENT_STATUS_ERROR
;
154 ret
= pretty_print_event(pretty
, event
);
156 if (ret
!= BT_COMPONENT_STATUS_OK
) {
161 case BT_NOTIFICATION_TYPE_STREAM_END
:
164 puts("Unhandled notification type");
171 enum bt_component_status
pretty_accept_port_connection(
172 struct bt_private_component
*component
,
173 struct bt_private_port
*self_port
,
174 struct bt_port
*other_port
)
176 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
177 struct bt_private_connection
*connection
;
178 struct pretty_component
*pretty
;
180 pretty
= bt_private_component_get_user_data(component
);
182 assert(!pretty
->input_iterator
);
183 connection
= bt_private_port_get_private_connection(self_port
);
185 pretty
->input_iterator
=
186 bt_private_connection_create_notification_iterator(connection
);
188 if (!pretty
->input_iterator
) {
189 ret
= BT_COMPONENT_STATUS_ERROR
;
197 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
199 enum bt_component_status ret
;
200 struct bt_notification
*notification
= NULL
;
201 struct bt_notification_iterator
*it
;
202 struct pretty_component
*pretty
=
203 bt_private_component_get_user_data(component
);
204 enum bt_notification_iterator_status it_ret
;
206 it
= pretty
->input_iterator
;
208 it_ret
= bt_notification_iterator_next(it
);
210 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
211 ret
= BT_COMPONENT_STATUS_ERROR
;
213 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
214 ret
= BT_COMPONENT_STATUS_END
;
215 BT_PUT(pretty
->input_iterator
);
221 notification
= bt_notification_iterator_get_notification(it
);
222 assert(notification
);
223 ret
= handle_notification(pretty
, notification
);
224 pretty
->processed_first_event
= true;
226 bt_put(notification
);
231 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
233 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
236 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
237 const char *key
= plugin_options
[i
];
238 enum bt_value_status status
;
240 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
242 case BT_VALUE_STATUS_OK
:
245 ret
= BT_COMPONENT_STATUS_ERROR
;
254 bool check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
256 struct pretty_component
*pretty
= data
;
257 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
259 if (!bt_value_map_get(plugin_opt_map
, key
)) {
261 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
267 enum bt_component_status
apply_one_string(const char *key
,
268 struct bt_value
*params
,
271 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
272 struct bt_value
*value
= NULL
;
273 enum bt_value_status status
;
276 value
= bt_value_map_get(params
, key
);
280 if (bt_value_is_null(value
)) {
283 status
= bt_value_string_get(value
, &str
);
285 case BT_VALUE_STATUS_OK
:
288 ret
= BT_COMPONENT_STATUS_ERROR
;
291 *option
= g_strdup(str
);
298 enum bt_component_status
apply_one_bool(const char *key
,
299 struct bt_value
*params
,
303 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
304 struct bt_value
*value
= NULL
;
305 enum bt_value_status status
;
307 value
= bt_value_map_get(params
, key
);
311 status
= bt_value_bool_get(value
, option
);
313 case BT_VALUE_STATUS_OK
:
316 ret
= BT_COMPONENT_STATUS_ERROR
;
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(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_key(params
, "color")) {
386 struct bt_value
*color_value
;
389 color_value
= bt_value_map_get(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
);
412 ret
= apply_one_string("output-path",
414 &pretty
->options
.output_path
);
415 if (ret
!= BT_COMPONENT_STATUS_OK
) {
418 ret
= open_output_file(pretty
);
419 if (ret
!= BT_COMPONENT_STATUS_OK
) {
423 ret
= apply_one_string("debug-info-dir",
425 &pretty
->options
.debug_info_dir
);
426 if (ret
!= BT_COMPONENT_STATUS_OK
) {
430 ret
= apply_one_string("debug-info-target-prefix",
432 &pretty
->options
.debug_info_target_prefix
);
433 if (ret
!= BT_COMPONENT_STATUS_OK
) {
437 value
= false; /* Default. */
438 ret
= apply_one_bool("debug-info-full-path", params
, &value
, NULL
);
439 if (ret
!= BT_COMPONENT_STATUS_OK
) {
442 pretty
->options
.debug_info_full_path
= value
;
444 value
= false; /* Default. */
445 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
446 if (ret
!= BT_COMPONENT_STATUS_OK
) {
449 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
451 value
= false; /* Default. */
452 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
453 if (ret
!= BT_COMPONENT_STATUS_OK
) {
456 pretty
->options
.print_timestamp_cycles
= value
;
458 value
= false; /* Default. */
459 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
460 if (ret
!= BT_COMPONENT_STATUS_OK
) {
463 pretty
->options
.clock_seconds
= value
;
465 value
= false; /* Default. */
466 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
467 if (ret
!= BT_COMPONENT_STATUS_OK
) {
470 pretty
->options
.clock_date
= value
;
472 value
= false; /* Default. */
473 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
474 if (ret
!= BT_COMPONENT_STATUS_OK
) {
477 pretty
->options
.clock_gmt
= value
;
479 value
= false; /* Default. */
480 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
481 if (ret
!= BT_COMPONENT_STATUS_OK
) {
484 pretty
->options
.verbose
= value
;
487 ret
= apply_one_string("name-default", params
, &str
);
488 if (ret
!= BT_COMPONENT_STATUS_OK
) {
492 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
493 } else if (!strcmp(str
, "show")) {
494 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
495 } else if (!strcmp(str
, "hide")) {
496 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
498 ret
= BT_COMPONENT_STATUS_ERROR
;
504 switch (pretty
->options
.name_default
) {
505 case PRETTY_DEFAULT_UNSET
:
506 pretty
->options
.print_payload_field_names
= true;
507 pretty
->options
.print_context_field_names
= true;
508 pretty
->options
.print_header_field_names
= false;
509 pretty
->options
.print_scope_field_names
= false;
511 case PRETTY_DEFAULT_SHOW
:
512 pretty
->options
.print_payload_field_names
= true;
513 pretty
->options
.print_context_field_names
= true;
514 pretty
->options
.print_header_field_names
= true;
515 pretty
->options
.print_scope_field_names
= true;
517 case PRETTY_DEFAULT_HIDE
:
518 pretty
->options
.print_payload_field_names
= false;
519 pretty
->options
.print_context_field_names
= false;
520 pretty
->options
.print_header_field_names
= false;
521 pretty
->options
.print_scope_field_names
= false;
524 ret
= BT_COMPONENT_STATUS_ERROR
;
530 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
531 if (ret
!= BT_COMPONENT_STATUS_OK
) {
535 pretty
->options
.print_payload_field_names
= value
;
540 ret
= apply_one_bool("name-context", params
, &value
, &found
);
541 if (ret
!= BT_COMPONENT_STATUS_OK
) {
545 pretty
->options
.print_context_field_names
= value
;
550 ret
= apply_one_bool("name-header", params
, &value
, &found
);
551 if (ret
!= BT_COMPONENT_STATUS_OK
) {
555 pretty
->options
.print_header_field_names
= value
;
560 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
561 if (ret
!= BT_COMPONENT_STATUS_OK
) {
565 pretty
->options
.print_scope_field_names
= value
;
569 ret
= apply_one_string("field-default", params
, &str
);
570 if (ret
!= BT_COMPONENT_STATUS_OK
) {
574 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
575 } else if (!strcmp(str
, "show")) {
576 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
577 } else if (!strcmp(str
, "hide")) {
578 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
580 ret
= BT_COMPONENT_STATUS_ERROR
;
586 switch (pretty
->options
.field_default
) {
587 case PRETTY_DEFAULT_UNSET
:
588 pretty
->options
.print_trace_field
= false;
589 pretty
->options
.print_trace_hostname_field
= true;
590 pretty
->options
.print_trace_domain_field
= false;
591 pretty
->options
.print_trace_procname_field
= true;
592 pretty
->options
.print_trace_vpid_field
= true;
593 pretty
->options
.print_loglevel_field
= false;
594 pretty
->options
.print_emf_field
= false;
595 pretty
->options
.print_callsite_field
= false;
597 case PRETTY_DEFAULT_SHOW
:
598 pretty
->options
.print_trace_field
= true;
599 pretty
->options
.print_trace_hostname_field
= true;
600 pretty
->options
.print_trace_domain_field
= true;
601 pretty
->options
.print_trace_procname_field
= true;
602 pretty
->options
.print_trace_vpid_field
= true;
603 pretty
->options
.print_loglevel_field
= true;
604 pretty
->options
.print_emf_field
= true;
605 pretty
->options
.print_callsite_field
= true;
607 case PRETTY_DEFAULT_HIDE
:
608 pretty
->options
.print_trace_field
= false;
609 pretty
->options
.print_trace_hostname_field
= false;
610 pretty
->options
.print_trace_domain_field
= false;
611 pretty
->options
.print_trace_procname_field
= false;
612 pretty
->options
.print_trace_vpid_field
= false;
613 pretty
->options
.print_loglevel_field
= false;
614 pretty
->options
.print_emf_field
= false;
615 pretty
->options
.print_callsite_field
= false;
618 ret
= BT_COMPONENT_STATUS_ERROR
;
624 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
625 if (ret
!= BT_COMPONENT_STATUS_OK
) {
629 pretty
->options
.print_trace_field
= value
;
634 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
635 if (ret
!= BT_COMPONENT_STATUS_OK
) {
639 pretty
->options
.print_trace_hostname_field
= value
;
644 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
645 if (ret
!= BT_COMPONENT_STATUS_OK
) {
649 pretty
->options
.print_trace_domain_field
= value
;
654 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
655 if (ret
!= BT_COMPONENT_STATUS_OK
) {
659 pretty
->options
.print_trace_procname_field
= value
;
664 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
665 if (ret
!= BT_COMPONENT_STATUS_OK
) {
669 pretty
->options
.print_trace_vpid_field
= value
;
674 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
675 if (ret
!= BT_COMPONENT_STATUS_OK
) {
679 pretty
->options
.print_loglevel_field
= value
;
684 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
685 if (ret
!= BT_COMPONENT_STATUS_OK
) {
689 pretty
->options
.print_emf_field
= value
;
694 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
695 if (ret
!= BT_COMPONENT_STATUS_OK
) {
699 pretty
->options
.print_callsite_field
= value
;
703 bt_put(pretty
->plugin_opt_map
);
704 pretty
->plugin_opt_map
= NULL
;
710 void set_use_colors(struct pretty_component
*pretty
)
712 switch (pretty
->options
.color
) {
713 case PRETTY_COLOR_OPT_ALWAYS
:
714 pretty
->use_colors
= true;
716 case PRETTY_COLOR_OPT_AUTO
:
717 pretty
->use_colors
= pretty
->out
== stdout
&&
718 bt_common_colors_supported();
720 case PRETTY_COLOR_OPT_NEVER
:
721 pretty
->use_colors
= false;
727 void init_stream_packet_context_quarks(void)
729 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
730 g_quark_from_string("timestamp_begin");
731 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
732 g_quark_from_string("timestamp_begin");
733 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
734 g_quark_from_string("timestamp_end");
735 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
736 g_quark_from_string("events_discarded");
737 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
738 g_quark_from_string("content_size");
739 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
740 g_quark_from_string("packet_size");
741 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
742 g_quark_from_string("packet_seq_num");
746 enum bt_component_status
pretty_init(
747 struct bt_private_component
*component
,
748 struct bt_value
*params
,
749 UNUSED_VAR
void *init_method_data
)
751 enum bt_component_status ret
;
752 struct pretty_component
*pretty
= create_pretty();
755 ret
= BT_COMPONENT_STATUS_NOMEM
;
759 pretty
->out
= stdout
;
760 pretty
->err
= stderr
;
762 pretty
->delta_cycles
= -1ULL;
763 pretty
->last_cycles_timestamp
= -1ULL;
765 pretty
->delta_real_timestamp
= -1ULL;
766 pretty
->last_real_timestamp
= -1ULL;
768 ret
= apply_params(pretty
, params
);
769 if (ret
!= BT_COMPONENT_STATUS_OK
) {
773 set_use_colors(pretty
);
775 ret
= bt_private_component_set_user_data(component
, pretty
);
776 if (ret
!= BT_COMPONENT_STATUS_OK
) {
780 init_stream_packet_context_quarks();
785 destroy_pretty_data(pretty
);