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 void pretty_port_connected(
172 struct bt_private_component
*component
,
173 struct bt_private_port
*self_port
,
174 struct bt_port
*other_port
)
176 struct bt_private_connection
*connection
;
177 struct pretty_component
*pretty
;
179 pretty
= bt_private_component_get_user_data(component
);
181 assert(!pretty
->input_iterator
);
182 connection
= bt_private_port_get_private_connection(self_port
);
184 pretty
->input_iterator
=
185 bt_private_connection_create_notification_iterator(connection
);
187 if (!pretty
->input_iterator
) {
188 pretty
->error
= true;
195 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
197 enum bt_component_status ret
;
198 struct bt_notification
*notification
= NULL
;
199 struct bt_notification_iterator
*it
;
200 struct pretty_component
*pretty
=
201 bt_private_component_get_user_data(component
);
202 enum bt_notification_iterator_status it_ret
;
204 if (unlikely(pretty
->error
)) {
205 ret
= BT_COMPONENT_STATUS_ERROR
;
209 it
= pretty
->input_iterator
;
210 it_ret
= bt_notification_iterator_next(it
);
213 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
214 ret
= BT_COMPONENT_STATUS_ERROR
;
216 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
217 ret
= BT_COMPONENT_STATUS_END
;
218 BT_PUT(pretty
->input_iterator
);
224 notification
= bt_notification_iterator_get_notification(it
);
225 assert(notification
);
226 ret
= handle_notification(pretty
, notification
);
227 pretty
->processed_first_event
= true;
229 bt_put(notification
);
234 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
236 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
239 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
240 const char *key
= plugin_options
[i
];
241 enum bt_value_status status
;
243 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
245 case BT_VALUE_STATUS_OK
:
248 ret
= BT_COMPONENT_STATUS_ERROR
;
257 bool check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
259 struct pretty_component
*pretty
= data
;
260 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
262 if (!bt_value_map_get(plugin_opt_map
, key
)) {
264 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
270 enum bt_component_status
apply_one_string(const char *key
,
271 struct bt_value
*params
,
274 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
275 struct bt_value
*value
= NULL
;
276 enum bt_value_status status
;
279 value
= bt_value_map_get(params
, key
);
283 if (bt_value_is_null(value
)) {
286 status
= bt_value_string_get(value
, &str
);
288 case BT_VALUE_STATUS_OK
:
291 ret
= BT_COMPONENT_STATUS_ERROR
;
294 *option
= g_strdup(str
);
301 enum bt_component_status
apply_one_bool(const char *key
,
302 struct bt_value
*params
,
306 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
307 struct bt_value
*value
= NULL
;
308 enum bt_value_status status
;
310 value
= bt_value_map_get(params
, key
);
314 status
= bt_value_bool_get(value
, option
);
316 case BT_VALUE_STATUS_OK
:
319 ret
= BT_COMPONENT_STATUS_ERROR
;
331 void warn_wrong_color_param(struct pretty_component
*pretty
)
334 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
338 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
340 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
342 if (!pretty
->options
.output_path
) {
346 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
354 ret
= BT_COMPONENT_STATUS_ERROR
;
360 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
361 struct bt_value
*params
)
363 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
364 enum bt_value_status status
;
368 pretty
->plugin_opt_map
= bt_value_map_create();
369 if (!pretty
->plugin_opt_map
) {
370 ret
= BT_COMPONENT_STATUS_ERROR
;
373 ret
= add_params_to_map(pretty
->plugin_opt_map
);
374 if (ret
!= BT_COMPONENT_STATUS_OK
) {
377 /* Report unknown parameters. */
378 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
380 case BT_VALUE_STATUS_OK
:
383 ret
= BT_COMPONENT_STATUS_ERROR
;
386 /* Known parameters. */
387 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
388 if (bt_value_map_has_key(params
, "color")) {
389 struct bt_value
*color_value
;
392 color_value
= bt_value_map_get(params
, "color");
397 status
= bt_value_string_get(color_value
, &color
);
399 warn_wrong_color_param(pretty
);
401 if (strcmp(color
, "never") == 0) {
402 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
403 } else if (strcmp(color
, "auto") == 0) {
404 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
405 } else if (strcmp(color
, "always") == 0) {
406 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
408 warn_wrong_color_param(pretty
);
415 ret
= apply_one_string("output-path",
417 &pretty
->options
.output_path
);
418 if (ret
!= BT_COMPONENT_STATUS_OK
) {
421 ret
= open_output_file(pretty
);
422 if (ret
!= BT_COMPONENT_STATUS_OK
) {
426 ret
= apply_one_string("debug-info-dir",
428 &pretty
->options
.debug_info_dir
);
429 if (ret
!= BT_COMPONENT_STATUS_OK
) {
433 ret
= apply_one_string("debug-info-target-prefix",
435 &pretty
->options
.debug_info_target_prefix
);
436 if (ret
!= BT_COMPONENT_STATUS_OK
) {
440 value
= false; /* Default. */
441 ret
= apply_one_bool("debug-info-full-path", params
, &value
, NULL
);
442 if (ret
!= BT_COMPONENT_STATUS_OK
) {
445 pretty
->options
.debug_info_full_path
= value
;
447 value
= false; /* Default. */
448 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
449 if (ret
!= BT_COMPONENT_STATUS_OK
) {
452 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
454 value
= false; /* Default. */
455 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
456 if (ret
!= BT_COMPONENT_STATUS_OK
) {
459 pretty
->options
.print_timestamp_cycles
= value
;
461 value
= false; /* Default. */
462 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
463 if (ret
!= BT_COMPONENT_STATUS_OK
) {
466 pretty
->options
.clock_seconds
= value
;
468 value
= false; /* Default. */
469 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
470 if (ret
!= BT_COMPONENT_STATUS_OK
) {
473 pretty
->options
.clock_date
= value
;
475 value
= false; /* Default. */
476 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
477 if (ret
!= BT_COMPONENT_STATUS_OK
) {
480 pretty
->options
.clock_gmt
= value
;
482 value
= false; /* Default. */
483 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
484 if (ret
!= BT_COMPONENT_STATUS_OK
) {
487 pretty
->options
.verbose
= value
;
490 ret
= apply_one_string("name-default", params
, &str
);
491 if (ret
!= BT_COMPONENT_STATUS_OK
) {
495 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
496 } else if (!strcmp(str
, "show")) {
497 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
498 } else if (!strcmp(str
, "hide")) {
499 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
501 ret
= BT_COMPONENT_STATUS_ERROR
;
507 switch (pretty
->options
.name_default
) {
508 case PRETTY_DEFAULT_UNSET
:
509 pretty
->options
.print_payload_field_names
= true;
510 pretty
->options
.print_context_field_names
= true;
511 pretty
->options
.print_header_field_names
= false;
512 pretty
->options
.print_scope_field_names
= false;
514 case PRETTY_DEFAULT_SHOW
:
515 pretty
->options
.print_payload_field_names
= true;
516 pretty
->options
.print_context_field_names
= true;
517 pretty
->options
.print_header_field_names
= true;
518 pretty
->options
.print_scope_field_names
= true;
520 case PRETTY_DEFAULT_HIDE
:
521 pretty
->options
.print_payload_field_names
= false;
522 pretty
->options
.print_context_field_names
= false;
523 pretty
->options
.print_header_field_names
= false;
524 pretty
->options
.print_scope_field_names
= false;
527 ret
= BT_COMPONENT_STATUS_ERROR
;
533 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
534 if (ret
!= BT_COMPONENT_STATUS_OK
) {
538 pretty
->options
.print_payload_field_names
= value
;
543 ret
= apply_one_bool("name-context", params
, &value
, &found
);
544 if (ret
!= BT_COMPONENT_STATUS_OK
) {
548 pretty
->options
.print_context_field_names
= value
;
553 ret
= apply_one_bool("name-header", params
, &value
, &found
);
554 if (ret
!= BT_COMPONENT_STATUS_OK
) {
558 pretty
->options
.print_header_field_names
= value
;
563 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
564 if (ret
!= BT_COMPONENT_STATUS_OK
) {
568 pretty
->options
.print_scope_field_names
= value
;
572 ret
= apply_one_string("field-default", params
, &str
);
573 if (ret
!= BT_COMPONENT_STATUS_OK
) {
577 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
578 } else if (!strcmp(str
, "show")) {
579 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
580 } else if (!strcmp(str
, "hide")) {
581 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
583 ret
= BT_COMPONENT_STATUS_ERROR
;
589 switch (pretty
->options
.field_default
) {
590 case PRETTY_DEFAULT_UNSET
:
591 pretty
->options
.print_trace_field
= false;
592 pretty
->options
.print_trace_hostname_field
= true;
593 pretty
->options
.print_trace_domain_field
= false;
594 pretty
->options
.print_trace_procname_field
= true;
595 pretty
->options
.print_trace_vpid_field
= true;
596 pretty
->options
.print_loglevel_field
= false;
597 pretty
->options
.print_emf_field
= false;
598 pretty
->options
.print_callsite_field
= false;
600 case PRETTY_DEFAULT_SHOW
:
601 pretty
->options
.print_trace_field
= true;
602 pretty
->options
.print_trace_hostname_field
= true;
603 pretty
->options
.print_trace_domain_field
= true;
604 pretty
->options
.print_trace_procname_field
= true;
605 pretty
->options
.print_trace_vpid_field
= true;
606 pretty
->options
.print_loglevel_field
= true;
607 pretty
->options
.print_emf_field
= true;
608 pretty
->options
.print_callsite_field
= true;
610 case PRETTY_DEFAULT_HIDE
:
611 pretty
->options
.print_trace_field
= false;
612 pretty
->options
.print_trace_hostname_field
= false;
613 pretty
->options
.print_trace_domain_field
= false;
614 pretty
->options
.print_trace_procname_field
= false;
615 pretty
->options
.print_trace_vpid_field
= false;
616 pretty
->options
.print_loglevel_field
= false;
617 pretty
->options
.print_emf_field
= false;
618 pretty
->options
.print_callsite_field
= false;
621 ret
= BT_COMPONENT_STATUS_ERROR
;
627 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
628 if (ret
!= BT_COMPONENT_STATUS_OK
) {
632 pretty
->options
.print_trace_field
= value
;
637 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
638 if (ret
!= BT_COMPONENT_STATUS_OK
) {
642 pretty
->options
.print_trace_hostname_field
= value
;
647 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
648 if (ret
!= BT_COMPONENT_STATUS_OK
) {
652 pretty
->options
.print_trace_domain_field
= value
;
657 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
658 if (ret
!= BT_COMPONENT_STATUS_OK
) {
662 pretty
->options
.print_trace_procname_field
= value
;
667 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
668 if (ret
!= BT_COMPONENT_STATUS_OK
) {
672 pretty
->options
.print_trace_vpid_field
= value
;
677 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
678 if (ret
!= BT_COMPONENT_STATUS_OK
) {
682 pretty
->options
.print_loglevel_field
= value
;
687 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
688 if (ret
!= BT_COMPONENT_STATUS_OK
) {
692 pretty
->options
.print_emf_field
= value
;
697 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
698 if (ret
!= BT_COMPONENT_STATUS_OK
) {
702 pretty
->options
.print_callsite_field
= value
;
706 bt_put(pretty
->plugin_opt_map
);
707 pretty
->plugin_opt_map
= NULL
;
713 void set_use_colors(struct pretty_component
*pretty
)
715 switch (pretty
->options
.color
) {
716 case PRETTY_COLOR_OPT_ALWAYS
:
717 pretty
->use_colors
= true;
719 case PRETTY_COLOR_OPT_AUTO
:
720 pretty
->use_colors
= pretty
->out
== stdout
&&
721 bt_common_colors_supported();
723 case PRETTY_COLOR_OPT_NEVER
:
724 pretty
->use_colors
= false;
730 void init_stream_packet_context_quarks(void)
732 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
733 g_quark_from_string("timestamp_begin");
734 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
735 g_quark_from_string("timestamp_begin");
736 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
737 g_quark_from_string("timestamp_end");
738 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
739 g_quark_from_string("events_discarded");
740 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
741 g_quark_from_string("content_size");
742 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
743 g_quark_from_string("packet_size");
744 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
745 g_quark_from_string("packet_seq_num");
749 enum bt_component_status
pretty_init(
750 struct bt_private_component
*component
,
751 struct bt_value
*params
,
752 UNUSED_VAR
void *init_method_data
)
754 enum bt_component_status ret
;
755 struct pretty_component
*pretty
= create_pretty();
758 ret
= BT_COMPONENT_STATUS_NOMEM
;
762 pretty
->out
= stdout
;
763 pretty
->err
= stderr
;
765 pretty
->delta_cycles
= -1ULL;
766 pretty
->last_cycles_timestamp
= -1ULL;
768 pretty
->delta_real_timestamp
= -1ULL;
769 pretty
->last_real_timestamp
= -1ULL;
771 ret
= apply_params(pretty
, params
);
772 if (ret
!= BT_COMPONENT_STATUS_OK
) {
776 set_use_colors(pretty
);
778 ret
= bt_private_component_set_user_data(component
, pretty
);
779 if (ret
!= BT_COMPONENT_STATUS_OK
) {
783 init_stream_packet_context_quarks();
788 destroy_pretty_data(pretty
);