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_EVENT
:
138 ret
= pretty_print_event(pretty
, notification
);
140 case BT_NOTIFICATION_TYPE_INACTIVITY
:
141 fprintf(stderr
, "Inactivity notification\n");
143 case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS
:
144 case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS
:
145 ret
= pretty_print_discarded_elements(pretty
, notification
);
155 enum bt_component_status
pretty_port_connected(
156 struct bt_private_component
*component
,
157 struct bt_private_port
*self_port
,
158 struct bt_port
*other_port
)
160 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
161 enum bt_connection_status conn_status
;
162 struct bt_private_connection
*connection
;
163 struct pretty_component
*pretty
;
165 pretty
= bt_private_component_get_user_data(component
);
167 BT_ASSERT(!pretty
->input_iterator
);
168 connection
= bt_private_port_get_private_connection(self_port
);
169 BT_ASSERT(connection
);
170 conn_status
= bt_private_connection_create_notification_iterator(
171 connection
, &pretty
->input_iterator
);
172 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
173 status
= BT_COMPONENT_STATUS_ERROR
;
181 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
183 enum bt_component_status ret
;
184 bt_notification_array notifs
;
185 struct bt_notification_iterator
*it
;
186 struct pretty_component
*pretty
=
187 bt_private_component_get_user_data(component
);
188 enum bt_notification_iterator_status it_ret
;
192 it
= pretty
->input_iterator
;
193 it_ret
= bt_private_connection_notification_iterator_next(it
, ¬ifs
,
197 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
198 ret
= BT_COMPONENT_STATUS_END
;
199 BT_PUT(pretty
->input_iterator
);
201 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
202 ret
= BT_COMPONENT_STATUS_AGAIN
;
204 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
207 ret
= BT_COMPONENT_STATUS_ERROR
;
211 BT_ASSERT(it_ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
);
213 for (i
= 0; i
< count
; i
++) {
214 ret
= handle_notification(pretty
, notifs
[i
]);
223 for (; i
< count
; i
++) {
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 bt_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_has_key(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_borrow(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
);
297 enum bt_component_status
apply_one_bool(const char *key
,
298 struct bt_value
*params
,
302 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
303 struct bt_value
*value
= NULL
;
304 enum bt_value_status status
;
307 value
= bt_value_map_borrow(params
, key
);
311 status
= bt_value_bool_get(value
, &bool_val
);
313 case BT_VALUE_STATUS_OK
:
316 ret
= BT_COMPONENT_STATUS_ERROR
;
319 *option
= (bool) bool_val
;
329 void warn_wrong_color_param(struct pretty_component
*pretty
)
332 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
336 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
338 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
340 if (!pretty
->options
.output_path
) {
344 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
352 ret
= BT_COMPONENT_STATUS_ERROR
;
358 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
359 struct bt_value
*params
)
361 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
362 enum bt_value_status status
;
366 pretty
->plugin_opt_map
= bt_value_map_create();
367 if (!pretty
->plugin_opt_map
) {
368 ret
= BT_COMPONENT_STATUS_ERROR
;
371 ret
= add_params_to_map(pretty
->plugin_opt_map
);
372 if (ret
!= BT_COMPONENT_STATUS_OK
) {
375 /* Report unknown parameters. */
376 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
378 case BT_VALUE_STATUS_OK
:
381 ret
= BT_COMPONENT_STATUS_ERROR
;
384 /* Known parameters. */
385 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
386 if (bt_value_map_has_key(params
, "color")) {
387 struct bt_value
*color_value
;
390 color_value
= bt_value_map_borrow(params
, "color");
395 status
= bt_value_string_get(color_value
, &color
);
397 warn_wrong_color_param(pretty
);
399 if (strcmp(color
, "never") == 0) {
400 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
401 } else if (strcmp(color
, "auto") == 0) {
402 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
403 } else if (strcmp(color
, "always") == 0) {
404 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
406 warn_wrong_color_param(pretty
);
411 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
412 if (ret
!= BT_COMPONENT_STATUS_OK
) {
415 ret
= open_output_file(pretty
);
416 if (ret
!= BT_COMPONENT_STATUS_OK
) {
420 value
= false; /* Default. */
421 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
422 if (ret
!= BT_COMPONENT_STATUS_OK
) {
425 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
427 value
= false; /* Default. */
428 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
429 if (ret
!= BT_COMPONENT_STATUS_OK
) {
432 pretty
->options
.print_timestamp_cycles
= value
;
434 value
= false; /* Default. */
435 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
436 if (ret
!= BT_COMPONENT_STATUS_OK
) {
439 pretty
->options
.clock_seconds
= value
;
441 value
= false; /* Default. */
442 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
443 if (ret
!= BT_COMPONENT_STATUS_OK
) {
446 pretty
->options
.clock_date
= value
;
448 value
= false; /* Default. */
449 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
450 if (ret
!= BT_COMPONENT_STATUS_OK
) {
453 pretty
->options
.clock_gmt
= value
;
455 value
= false; /* Default. */
456 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
457 if (ret
!= BT_COMPONENT_STATUS_OK
) {
460 pretty
->options
.verbose
= value
;
463 ret
= apply_one_string("name-default", params
, &str
);
464 if (ret
!= BT_COMPONENT_STATUS_OK
) {
468 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
469 } else if (!strcmp(str
, "show")) {
470 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
471 } else if (!strcmp(str
, "hide")) {
472 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
474 ret
= BT_COMPONENT_STATUS_ERROR
;
480 switch (pretty
->options
.name_default
) {
481 case PRETTY_DEFAULT_UNSET
:
482 pretty
->options
.print_payload_field_names
= true;
483 pretty
->options
.print_context_field_names
= true;
484 pretty
->options
.print_header_field_names
= false;
485 pretty
->options
.print_scope_field_names
= false;
487 case PRETTY_DEFAULT_SHOW
:
488 pretty
->options
.print_payload_field_names
= true;
489 pretty
->options
.print_context_field_names
= true;
490 pretty
->options
.print_header_field_names
= true;
491 pretty
->options
.print_scope_field_names
= true;
493 case PRETTY_DEFAULT_HIDE
:
494 pretty
->options
.print_payload_field_names
= false;
495 pretty
->options
.print_context_field_names
= false;
496 pretty
->options
.print_header_field_names
= false;
497 pretty
->options
.print_scope_field_names
= false;
500 ret
= BT_COMPONENT_STATUS_ERROR
;
506 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
507 if (ret
!= BT_COMPONENT_STATUS_OK
) {
511 pretty
->options
.print_payload_field_names
= value
;
516 ret
= apply_one_bool("name-context", params
, &value
, &found
);
517 if (ret
!= BT_COMPONENT_STATUS_OK
) {
521 pretty
->options
.print_context_field_names
= value
;
526 ret
= apply_one_bool("name-header", params
, &value
, &found
);
527 if (ret
!= BT_COMPONENT_STATUS_OK
) {
531 pretty
->options
.print_header_field_names
= value
;
536 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
537 if (ret
!= BT_COMPONENT_STATUS_OK
) {
541 pretty
->options
.print_scope_field_names
= value
;
545 ret
= apply_one_string("field-default", params
, &str
);
546 if (ret
!= BT_COMPONENT_STATUS_OK
) {
550 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
551 } else if (!strcmp(str
, "show")) {
552 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
553 } else if (!strcmp(str
, "hide")) {
554 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
556 ret
= BT_COMPONENT_STATUS_ERROR
;
562 switch (pretty
->options
.field_default
) {
563 case PRETTY_DEFAULT_UNSET
:
564 pretty
->options
.print_trace_field
= false;
565 pretty
->options
.print_trace_hostname_field
= true;
566 pretty
->options
.print_trace_domain_field
= false;
567 pretty
->options
.print_trace_procname_field
= true;
568 pretty
->options
.print_trace_vpid_field
= true;
569 pretty
->options
.print_loglevel_field
= false;
570 pretty
->options
.print_emf_field
= false;
571 pretty
->options
.print_callsite_field
= false;
573 case PRETTY_DEFAULT_SHOW
:
574 pretty
->options
.print_trace_field
= true;
575 pretty
->options
.print_trace_hostname_field
= true;
576 pretty
->options
.print_trace_domain_field
= true;
577 pretty
->options
.print_trace_procname_field
= true;
578 pretty
->options
.print_trace_vpid_field
= true;
579 pretty
->options
.print_loglevel_field
= true;
580 pretty
->options
.print_emf_field
= true;
581 pretty
->options
.print_callsite_field
= true;
583 case PRETTY_DEFAULT_HIDE
:
584 pretty
->options
.print_trace_field
= false;
585 pretty
->options
.print_trace_hostname_field
= false;
586 pretty
->options
.print_trace_domain_field
= false;
587 pretty
->options
.print_trace_procname_field
= false;
588 pretty
->options
.print_trace_vpid_field
= false;
589 pretty
->options
.print_loglevel_field
= false;
590 pretty
->options
.print_emf_field
= false;
591 pretty
->options
.print_callsite_field
= false;
594 ret
= BT_COMPONENT_STATUS_ERROR
;
600 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
601 if (ret
!= BT_COMPONENT_STATUS_OK
) {
605 pretty
->options
.print_trace_field
= value
;
610 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
611 if (ret
!= BT_COMPONENT_STATUS_OK
) {
615 pretty
->options
.print_trace_hostname_field
= value
;
620 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
621 if (ret
!= BT_COMPONENT_STATUS_OK
) {
625 pretty
->options
.print_trace_domain_field
= value
;
630 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
631 if (ret
!= BT_COMPONENT_STATUS_OK
) {
635 pretty
->options
.print_trace_procname_field
= value
;
640 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
641 if (ret
!= BT_COMPONENT_STATUS_OK
) {
645 pretty
->options
.print_trace_vpid_field
= value
;
650 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
651 if (ret
!= BT_COMPONENT_STATUS_OK
) {
655 pretty
->options
.print_loglevel_field
= value
;
660 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
661 if (ret
!= BT_COMPONENT_STATUS_OK
) {
665 pretty
->options
.print_emf_field
= value
;
670 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
671 if (ret
!= BT_COMPONENT_STATUS_OK
) {
675 pretty
->options
.print_callsite_field
= value
;
679 bt_put(pretty
->plugin_opt_map
);
680 pretty
->plugin_opt_map
= NULL
;
686 void set_use_colors(struct pretty_component
*pretty
)
688 switch (pretty
->options
.color
) {
689 case PRETTY_COLOR_OPT_ALWAYS
:
690 pretty
->use_colors
= true;
692 case PRETTY_COLOR_OPT_AUTO
:
693 pretty
->use_colors
= pretty
->out
== stdout
&&
694 bt_common_colors_supported();
696 case PRETTY_COLOR_OPT_NEVER
:
697 pretty
->use_colors
= false;
703 void init_stream_packet_context_quarks(void)
705 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
706 g_quark_from_string("timestamp_begin");
707 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
708 g_quark_from_string("timestamp_begin");
709 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
710 g_quark_from_string("timestamp_end");
711 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
712 g_quark_from_string("events_discarded");
713 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
714 g_quark_from_string("content_size");
715 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
716 g_quark_from_string("packet_size");
717 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
718 g_quark_from_string("packet_seq_num");
722 enum bt_component_status
pretty_init(
723 struct bt_private_component
*component
,
724 struct bt_value
*params
,
725 UNUSED_VAR
void *init_method_data
)
727 enum bt_component_status ret
;
728 struct pretty_component
*pretty
= create_pretty();
731 ret
= BT_COMPONENT_STATUS_NOMEM
;
735 ret
= bt_private_component_sink_add_input_private_port(component
,
737 if (ret
!= BT_COMPONENT_STATUS_OK
) {
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
);