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/private-component-sink.h>
34 #include <babeltrace/graph/component-sink.h>
35 #include <babeltrace/graph/port.h>
36 #include <babeltrace/graph/private-port.h>
37 #include <babeltrace/graph/connection.h>
38 #include <babeltrace/graph/private-connection.h>
39 #include <babeltrace/graph/notification.h>
40 #include <babeltrace/graph/notification-iterator.h>
41 #include <babeltrace/graph/notification-event.h>
42 #include <babeltrace/values.h>
43 #include <babeltrace/compiler-internal.h>
44 #include <babeltrace/common-internal.h>
45 #include <plugins-common.h>
54 const char *plugin_options
[] = {
63 "name-default", /* show/hide */
68 "field-default", /* show/hide */
70 "field-trace:hostname",
72 "field-trace:procname",
80 void destroy_pretty_data(struct pretty_component
*pretty
)
82 bt_put(pretty
->input_iterator
);
83 (void) g_string_free(pretty
->string
, TRUE
);
84 if (pretty
->out
!= stdout
) {
87 ret
= fclose(pretty
->out
);
89 perror("close output file");
92 g_free(pretty
->options
.output_path
);
97 struct pretty_component
*create_pretty(void)
99 struct pretty_component
*pretty
;
101 pretty
= g_new0(struct pretty_component
, 1);
105 pretty
->string
= g_string_new("");
106 if (!pretty
->string
) {
118 void pretty_finalize(struct bt_private_component
*component
)
120 void *data
= bt_private_component_get_user_data(component
);
122 destroy_pretty_data(data
);
126 enum bt_component_status
handle_notification(struct pretty_component
*pretty
,
127 struct bt_notification
*notification
)
129 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
133 switch (bt_notification_get_type(notification
)) {
134 case BT_NOTIFICATION_TYPE_EVENT
:
135 ret
= pretty_print_event(pretty
, notification
);
137 case BT_NOTIFICATION_TYPE_INACTIVITY
:
138 fprintf(stderr
, "Inactivity notification\n");
140 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
141 case BT_NOTIFICATION_TYPE_PACKET_END
:
142 case BT_NOTIFICATION_TYPE_STREAM_BEGIN
:
143 case BT_NOTIFICATION_TYPE_STREAM_END
:
146 fprintf(stderr
, "Unhandled notification type\n");
153 void pretty_port_connected(
154 struct bt_private_component
*component
,
155 struct bt_private_port
*self_port
,
156 struct bt_port
*other_port
)
158 struct bt_private_connection
*connection
;
159 struct pretty_component
*pretty
;
160 static const enum bt_notification_type notif_types
[] = {
161 BT_NOTIFICATION_TYPE_EVENT
,
162 BT_NOTIFICATION_TYPE_SENTINEL
,
165 pretty
= bt_private_component_get_user_data(component
);
167 assert(!pretty
->input_iterator
);
168 connection
= bt_private_port_get_private_connection(self_port
);
170 pretty
->input_iterator
=
171 bt_private_connection_create_notification_iterator(connection
,
174 if (!pretty
->input_iterator
) {
175 pretty
->error
= true;
182 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
184 enum bt_component_status ret
;
185 struct bt_notification
*notification
= NULL
;
186 struct bt_notification_iterator
*it
;
187 struct pretty_component
*pretty
=
188 bt_private_component_get_user_data(component
);
189 enum bt_notification_iterator_status it_ret
;
191 if (unlikely(pretty
->error
)) {
192 ret
= BT_COMPONENT_STATUS_ERROR
;
196 it
= pretty
->input_iterator
;
197 it_ret
= bt_notification_iterator_next(it
);
200 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
201 ret
= BT_COMPONENT_STATUS_END
;
202 BT_PUT(pretty
->input_iterator
);
204 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
205 ret
= BT_COMPONENT_STATUS_AGAIN
;
207 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
210 ret
= BT_COMPONENT_STATUS_ERROR
;
214 notification
= bt_notification_iterator_get_notification(it
);
215 assert(notification
);
216 ret
= handle_notification(pretty
, notification
);
219 bt_put(notification
);
224 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
226 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
229 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
230 const char *key
= plugin_options
[i
];
231 enum bt_value_status status
;
233 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
235 case BT_VALUE_STATUS_OK
:
238 ret
= BT_COMPONENT_STATUS_ERROR
;
247 bt_bool
check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
249 struct pretty_component
*pretty
= data
;
250 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
252 if (!bt_value_map_get(plugin_opt_map
, key
)) {
254 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
260 enum bt_component_status
apply_one_string(const char *key
,
261 struct bt_value
*params
,
264 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
265 struct bt_value
*value
= NULL
;
266 enum bt_value_status status
;
269 value
= bt_value_map_get(params
, key
);
273 if (bt_value_is_null(value
)) {
276 status
= bt_value_string_get(value
, &str
);
278 case BT_VALUE_STATUS_OK
:
281 ret
= BT_COMPONENT_STATUS_ERROR
;
284 *option
= g_strdup(str
);
291 enum bt_component_status
apply_one_bool(const char *key
,
292 struct bt_value
*params
,
296 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
297 struct bt_value
*value
= NULL
;
298 enum bt_value_status status
;
301 value
= bt_value_map_get(params
, key
);
305 status
= bt_value_bool_get(value
, &bool_val
);
307 case BT_VALUE_STATUS_OK
:
310 ret
= BT_COMPONENT_STATUS_ERROR
;
313 *option
= (bool) bool_val
;
323 void warn_wrong_color_param(struct pretty_component
*pretty
)
326 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
330 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
332 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
334 if (!pretty
->options
.output_path
) {
338 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
346 ret
= BT_COMPONENT_STATUS_ERROR
;
352 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
353 struct bt_value
*params
)
355 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
356 enum bt_value_status status
;
360 pretty
->plugin_opt_map
= bt_value_map_create();
361 if (!pretty
->plugin_opt_map
) {
362 ret
= BT_COMPONENT_STATUS_ERROR
;
365 ret
= add_params_to_map(pretty
->plugin_opt_map
);
366 if (ret
!= BT_COMPONENT_STATUS_OK
) {
369 /* Report unknown parameters. */
370 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
372 case BT_VALUE_STATUS_OK
:
375 ret
= BT_COMPONENT_STATUS_ERROR
;
378 /* Known parameters. */
379 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
380 if (bt_value_map_has_key(params
, "color")) {
381 struct bt_value
*color_value
;
384 color_value
= bt_value_map_get(params
, "color");
389 status
= bt_value_string_get(color_value
, &color
);
391 warn_wrong_color_param(pretty
);
393 if (strcmp(color
, "never") == 0) {
394 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
395 } else if (strcmp(color
, "auto") == 0) {
396 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
397 } else if (strcmp(color
, "always") == 0) {
398 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
400 warn_wrong_color_param(pretty
);
407 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
408 if (ret
!= BT_COMPONENT_STATUS_OK
) {
411 ret
= open_output_file(pretty
);
412 if (ret
!= BT_COMPONENT_STATUS_OK
) {
416 value
= false; /* Default. */
417 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
418 if (ret
!= BT_COMPONENT_STATUS_OK
) {
421 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
423 value
= false; /* Default. */
424 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
425 if (ret
!= BT_COMPONENT_STATUS_OK
) {
428 pretty
->options
.print_timestamp_cycles
= value
;
430 value
= false; /* Default. */
431 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
432 if (ret
!= BT_COMPONENT_STATUS_OK
) {
435 pretty
->options
.clock_seconds
= value
;
437 value
= false; /* Default. */
438 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
439 if (ret
!= BT_COMPONENT_STATUS_OK
) {
442 pretty
->options
.clock_date
= value
;
444 value
= false; /* Default. */
445 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
446 if (ret
!= BT_COMPONENT_STATUS_OK
) {
449 pretty
->options
.clock_gmt
= value
;
451 value
= false; /* Default. */
452 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
453 if (ret
!= BT_COMPONENT_STATUS_OK
) {
456 pretty
->options
.verbose
= value
;
459 ret
= apply_one_string("name-default", params
, &str
);
460 if (ret
!= BT_COMPONENT_STATUS_OK
) {
464 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
465 } else if (!strcmp(str
, "show")) {
466 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
467 } else if (!strcmp(str
, "hide")) {
468 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
470 ret
= BT_COMPONENT_STATUS_ERROR
;
476 switch (pretty
->options
.name_default
) {
477 case PRETTY_DEFAULT_UNSET
:
478 pretty
->options
.print_payload_field_names
= true;
479 pretty
->options
.print_context_field_names
= true;
480 pretty
->options
.print_header_field_names
= false;
481 pretty
->options
.print_scope_field_names
= false;
483 case PRETTY_DEFAULT_SHOW
:
484 pretty
->options
.print_payload_field_names
= true;
485 pretty
->options
.print_context_field_names
= true;
486 pretty
->options
.print_header_field_names
= true;
487 pretty
->options
.print_scope_field_names
= true;
489 case PRETTY_DEFAULT_HIDE
:
490 pretty
->options
.print_payload_field_names
= false;
491 pretty
->options
.print_context_field_names
= false;
492 pretty
->options
.print_header_field_names
= false;
493 pretty
->options
.print_scope_field_names
= false;
496 ret
= BT_COMPONENT_STATUS_ERROR
;
502 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
503 if (ret
!= BT_COMPONENT_STATUS_OK
) {
507 pretty
->options
.print_payload_field_names
= value
;
512 ret
= apply_one_bool("name-context", params
, &value
, &found
);
513 if (ret
!= BT_COMPONENT_STATUS_OK
) {
517 pretty
->options
.print_context_field_names
= value
;
522 ret
= apply_one_bool("name-header", params
, &value
, &found
);
523 if (ret
!= BT_COMPONENT_STATUS_OK
) {
527 pretty
->options
.print_header_field_names
= value
;
532 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
533 if (ret
!= BT_COMPONENT_STATUS_OK
) {
537 pretty
->options
.print_scope_field_names
= value
;
541 ret
= apply_one_string("field-default", params
, &str
);
542 if (ret
!= BT_COMPONENT_STATUS_OK
) {
546 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
547 } else if (!strcmp(str
, "show")) {
548 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
549 } else if (!strcmp(str
, "hide")) {
550 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
552 ret
= BT_COMPONENT_STATUS_ERROR
;
558 switch (pretty
->options
.field_default
) {
559 case PRETTY_DEFAULT_UNSET
:
560 pretty
->options
.print_trace_field
= false;
561 pretty
->options
.print_trace_hostname_field
= true;
562 pretty
->options
.print_trace_domain_field
= false;
563 pretty
->options
.print_trace_procname_field
= true;
564 pretty
->options
.print_trace_vpid_field
= true;
565 pretty
->options
.print_loglevel_field
= false;
566 pretty
->options
.print_emf_field
= false;
567 pretty
->options
.print_callsite_field
= false;
569 case PRETTY_DEFAULT_SHOW
:
570 pretty
->options
.print_trace_field
= true;
571 pretty
->options
.print_trace_hostname_field
= true;
572 pretty
->options
.print_trace_domain_field
= true;
573 pretty
->options
.print_trace_procname_field
= true;
574 pretty
->options
.print_trace_vpid_field
= true;
575 pretty
->options
.print_loglevel_field
= true;
576 pretty
->options
.print_emf_field
= true;
577 pretty
->options
.print_callsite_field
= true;
579 case PRETTY_DEFAULT_HIDE
:
580 pretty
->options
.print_trace_field
= false;
581 pretty
->options
.print_trace_hostname_field
= false;
582 pretty
->options
.print_trace_domain_field
= false;
583 pretty
->options
.print_trace_procname_field
= false;
584 pretty
->options
.print_trace_vpid_field
= false;
585 pretty
->options
.print_loglevel_field
= false;
586 pretty
->options
.print_emf_field
= false;
587 pretty
->options
.print_callsite_field
= false;
590 ret
= BT_COMPONENT_STATUS_ERROR
;
596 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
597 if (ret
!= BT_COMPONENT_STATUS_OK
) {
601 pretty
->options
.print_trace_field
= value
;
606 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
607 if (ret
!= BT_COMPONENT_STATUS_OK
) {
611 pretty
->options
.print_trace_hostname_field
= value
;
616 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
617 if (ret
!= BT_COMPONENT_STATUS_OK
) {
621 pretty
->options
.print_trace_domain_field
= value
;
626 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
627 if (ret
!= BT_COMPONENT_STATUS_OK
) {
631 pretty
->options
.print_trace_procname_field
= value
;
636 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
637 if (ret
!= BT_COMPONENT_STATUS_OK
) {
641 pretty
->options
.print_trace_vpid_field
= value
;
646 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
647 if (ret
!= BT_COMPONENT_STATUS_OK
) {
651 pretty
->options
.print_loglevel_field
= value
;
656 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
657 if (ret
!= BT_COMPONENT_STATUS_OK
) {
661 pretty
->options
.print_emf_field
= value
;
666 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
667 if (ret
!= BT_COMPONENT_STATUS_OK
) {
671 pretty
->options
.print_callsite_field
= value
;
675 bt_put(pretty
->plugin_opt_map
);
676 pretty
->plugin_opt_map
= NULL
;
682 void set_use_colors(struct pretty_component
*pretty
)
684 switch (pretty
->options
.color
) {
685 case PRETTY_COLOR_OPT_ALWAYS
:
686 pretty
->use_colors
= true;
688 case PRETTY_COLOR_OPT_AUTO
:
689 pretty
->use_colors
= pretty
->out
== stdout
&&
690 bt_common_colors_supported();
692 case PRETTY_COLOR_OPT_NEVER
:
693 pretty
->use_colors
= false;
699 void init_stream_packet_context_quarks(void)
701 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
702 g_quark_from_string("timestamp_begin");
703 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
704 g_quark_from_string("timestamp_begin");
705 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
706 g_quark_from_string("timestamp_end");
707 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
708 g_quark_from_string("events_discarded");
709 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
710 g_quark_from_string("content_size");
711 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
712 g_quark_from_string("packet_size");
713 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
714 g_quark_from_string("packet_seq_num");
718 enum bt_component_status
pretty_init(
719 struct bt_private_component
*component
,
720 struct bt_value
*params
,
721 UNUSED_VAR
void *init_method_data
)
723 enum bt_component_status ret
;
724 struct pretty_component
*pretty
= create_pretty();
728 ret
= BT_COMPONENT_STATUS_NOMEM
;
732 priv_port
= bt_private_component_sink_add_input_private_port(component
,
735 ret
= BT_COMPONENT_STATUS_NOMEM
;
741 pretty
->out
= stdout
;
742 pretty
->err
= stderr
;
744 pretty
->delta_cycles
= -1ULL;
745 pretty
->last_cycles_timestamp
= -1ULL;
747 pretty
->delta_real_timestamp
= -1ULL;
748 pretty
->last_real_timestamp
= -1ULL;
750 ret
= apply_params(pretty
, params
);
751 if (ret
!= BT_COMPONENT_STATUS_OK
) {
755 set_use_colors(pretty
);
756 ret
= bt_private_component_set_user_data(component
, pretty
);
757 if (ret
!= BT_COMPONENT_STATUS_OK
) {
761 init_stream_packet_context_quarks();
766 destroy_pretty_data(pretty
);