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>
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_PACKET_BEGIN
:
144 case BT_NOTIFICATION_TYPE_PACKET_END
:
145 case BT_NOTIFICATION_TYPE_STREAM_BEGIN
:
146 case BT_NOTIFICATION_TYPE_STREAM_END
:
148 case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS
:
149 case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS
:
150 ret
= pretty_print_discarded_elements(pretty
, notification
);
153 fprintf(stderr
, "Unhandled notification type\n");
160 void pretty_port_connected(
161 struct bt_private_component
*component
,
162 struct bt_private_port
*self_port
,
163 struct bt_port
*other_port
)
165 enum bt_connection_status conn_status
;
166 struct bt_private_connection
*connection
;
167 struct pretty_component
*pretty
;
168 static const enum bt_notification_type notif_types
[] = {
169 BT_NOTIFICATION_TYPE_EVENT
,
170 BT_NOTIFICATION_TYPE_DISCARDED_PACKETS
,
171 BT_NOTIFICATION_TYPE_DISCARDED_EVENTS
,
172 BT_NOTIFICATION_TYPE_SENTINEL
,
175 pretty
= bt_private_component_get_user_data(component
);
177 assert(!pretty
->input_iterator
);
178 connection
= bt_private_port_get_private_connection(self_port
);
180 conn_status
= bt_private_connection_create_notification_iterator(
181 connection
, notif_types
, &pretty
->input_iterator
);
182 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
183 pretty
->error
= true;
190 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
192 enum bt_component_status ret
;
193 struct bt_notification
*notification
= NULL
;
194 struct bt_notification_iterator
*it
;
195 struct pretty_component
*pretty
=
196 bt_private_component_get_user_data(component
);
197 enum bt_notification_iterator_status it_ret
;
199 if (unlikely(pretty
->error
)) {
200 ret
= BT_COMPONENT_STATUS_ERROR
;
204 it
= pretty
->input_iterator
;
205 it_ret
= bt_notification_iterator_next(it
);
208 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
209 ret
= BT_COMPONENT_STATUS_END
;
210 BT_PUT(pretty
->input_iterator
);
212 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
213 ret
= BT_COMPONENT_STATUS_AGAIN
;
215 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
218 ret
= BT_COMPONENT_STATUS_ERROR
;
222 notification
= bt_notification_iterator_get_notification(it
);
223 assert(notification
);
224 ret
= handle_notification(pretty
, notification
);
227 bt_put(notification
);
232 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
234 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
237 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
238 const char *key
= plugin_options
[i
];
239 enum bt_value_status status
;
241 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
243 case BT_VALUE_STATUS_OK
:
246 ret
= BT_COMPONENT_STATUS_ERROR
;
255 bt_bool
check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
257 struct pretty_component
*pretty
= data
;
258 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
260 if (!bt_value_map_get(plugin_opt_map
, key
)) {
262 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
268 enum bt_component_status
apply_one_string(const char *key
,
269 struct bt_value
*params
,
272 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
273 struct bt_value
*value
= NULL
;
274 enum bt_value_status status
;
277 value
= bt_value_map_get(params
, key
);
281 if (bt_value_is_null(value
)) {
284 status
= bt_value_string_get(value
, &str
);
286 case BT_VALUE_STATUS_OK
:
289 ret
= BT_COMPONENT_STATUS_ERROR
;
292 *option
= g_strdup(str
);
299 enum bt_component_status
apply_one_bool(const char *key
,
300 struct bt_value
*params
,
304 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
305 struct bt_value
*value
= NULL
;
306 enum bt_value_status status
;
309 value
= bt_value_map_get(params
, key
);
313 status
= bt_value_bool_get(value
, &bool_val
);
315 case BT_VALUE_STATUS_OK
:
318 ret
= BT_COMPONENT_STATUS_ERROR
;
321 *option
= (bool) bool_val
;
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("path", params
, &pretty
->options
.output_path
);
416 if (ret
!= BT_COMPONENT_STATUS_OK
) {
419 ret
= open_output_file(pretty
);
420 if (ret
!= BT_COMPONENT_STATUS_OK
) {
424 value
= false; /* Default. */
425 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
426 if (ret
!= BT_COMPONENT_STATUS_OK
) {
429 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
431 value
= false; /* Default. */
432 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
433 if (ret
!= BT_COMPONENT_STATUS_OK
) {
436 pretty
->options
.print_timestamp_cycles
= value
;
438 value
= false; /* Default. */
439 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
440 if (ret
!= BT_COMPONENT_STATUS_OK
) {
443 pretty
->options
.clock_seconds
= value
;
445 value
= false; /* Default. */
446 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
447 if (ret
!= BT_COMPONENT_STATUS_OK
) {
450 pretty
->options
.clock_date
= value
;
452 value
= false; /* Default. */
453 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
454 if (ret
!= BT_COMPONENT_STATUS_OK
) {
457 pretty
->options
.clock_gmt
= value
;
459 value
= false; /* Default. */
460 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
461 if (ret
!= BT_COMPONENT_STATUS_OK
) {
464 pretty
->options
.verbose
= value
;
467 ret
= apply_one_string("name-default", params
, &str
);
468 if (ret
!= BT_COMPONENT_STATUS_OK
) {
472 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
473 } else if (!strcmp(str
, "show")) {
474 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
475 } else if (!strcmp(str
, "hide")) {
476 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
478 ret
= BT_COMPONENT_STATUS_ERROR
;
484 switch (pretty
->options
.name_default
) {
485 case PRETTY_DEFAULT_UNSET
:
486 pretty
->options
.print_payload_field_names
= true;
487 pretty
->options
.print_context_field_names
= true;
488 pretty
->options
.print_header_field_names
= false;
489 pretty
->options
.print_scope_field_names
= false;
491 case PRETTY_DEFAULT_SHOW
:
492 pretty
->options
.print_payload_field_names
= true;
493 pretty
->options
.print_context_field_names
= true;
494 pretty
->options
.print_header_field_names
= true;
495 pretty
->options
.print_scope_field_names
= true;
497 case PRETTY_DEFAULT_HIDE
:
498 pretty
->options
.print_payload_field_names
= false;
499 pretty
->options
.print_context_field_names
= false;
500 pretty
->options
.print_header_field_names
= false;
501 pretty
->options
.print_scope_field_names
= false;
504 ret
= BT_COMPONENT_STATUS_ERROR
;
510 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
511 if (ret
!= BT_COMPONENT_STATUS_OK
) {
515 pretty
->options
.print_payload_field_names
= value
;
520 ret
= apply_one_bool("name-context", params
, &value
, &found
);
521 if (ret
!= BT_COMPONENT_STATUS_OK
) {
525 pretty
->options
.print_context_field_names
= value
;
530 ret
= apply_one_bool("name-header", params
, &value
, &found
);
531 if (ret
!= BT_COMPONENT_STATUS_OK
) {
535 pretty
->options
.print_header_field_names
= value
;
540 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
541 if (ret
!= BT_COMPONENT_STATUS_OK
) {
545 pretty
->options
.print_scope_field_names
= value
;
549 ret
= apply_one_string("field-default", params
, &str
);
550 if (ret
!= BT_COMPONENT_STATUS_OK
) {
554 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
555 } else if (!strcmp(str
, "show")) {
556 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
557 } else if (!strcmp(str
, "hide")) {
558 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
560 ret
= BT_COMPONENT_STATUS_ERROR
;
566 switch (pretty
->options
.field_default
) {
567 case PRETTY_DEFAULT_UNSET
:
568 pretty
->options
.print_trace_field
= false;
569 pretty
->options
.print_trace_hostname_field
= true;
570 pretty
->options
.print_trace_domain_field
= false;
571 pretty
->options
.print_trace_procname_field
= true;
572 pretty
->options
.print_trace_vpid_field
= true;
573 pretty
->options
.print_loglevel_field
= false;
574 pretty
->options
.print_emf_field
= false;
575 pretty
->options
.print_callsite_field
= false;
577 case PRETTY_DEFAULT_SHOW
:
578 pretty
->options
.print_trace_field
= true;
579 pretty
->options
.print_trace_hostname_field
= true;
580 pretty
->options
.print_trace_domain_field
= true;
581 pretty
->options
.print_trace_procname_field
= true;
582 pretty
->options
.print_trace_vpid_field
= true;
583 pretty
->options
.print_loglevel_field
= true;
584 pretty
->options
.print_emf_field
= true;
585 pretty
->options
.print_callsite_field
= true;
587 case PRETTY_DEFAULT_HIDE
:
588 pretty
->options
.print_trace_field
= false;
589 pretty
->options
.print_trace_hostname_field
= false;
590 pretty
->options
.print_trace_domain_field
= false;
591 pretty
->options
.print_trace_procname_field
= false;
592 pretty
->options
.print_trace_vpid_field
= false;
593 pretty
->options
.print_loglevel_field
= false;
594 pretty
->options
.print_emf_field
= false;
595 pretty
->options
.print_callsite_field
= false;
598 ret
= BT_COMPONENT_STATUS_ERROR
;
604 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
605 if (ret
!= BT_COMPONENT_STATUS_OK
) {
609 pretty
->options
.print_trace_field
= value
;
614 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
615 if (ret
!= BT_COMPONENT_STATUS_OK
) {
619 pretty
->options
.print_trace_hostname_field
= value
;
624 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
625 if (ret
!= BT_COMPONENT_STATUS_OK
) {
629 pretty
->options
.print_trace_domain_field
= value
;
634 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
635 if (ret
!= BT_COMPONENT_STATUS_OK
) {
639 pretty
->options
.print_trace_procname_field
= value
;
644 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
645 if (ret
!= BT_COMPONENT_STATUS_OK
) {
649 pretty
->options
.print_trace_vpid_field
= value
;
654 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
655 if (ret
!= BT_COMPONENT_STATUS_OK
) {
659 pretty
->options
.print_loglevel_field
= value
;
664 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
665 if (ret
!= BT_COMPONENT_STATUS_OK
) {
669 pretty
->options
.print_emf_field
= value
;
674 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
675 if (ret
!= BT_COMPONENT_STATUS_OK
) {
679 pretty
->options
.print_callsite_field
= value
;
683 bt_put(pretty
->plugin_opt_map
);
684 pretty
->plugin_opt_map
= NULL
;
690 void set_use_colors(struct pretty_component
*pretty
)
692 switch (pretty
->options
.color
) {
693 case PRETTY_COLOR_OPT_ALWAYS
:
694 pretty
->use_colors
= true;
696 case PRETTY_COLOR_OPT_AUTO
:
697 pretty
->use_colors
= pretty
->out
== stdout
&&
698 bt_common_colors_supported();
700 case PRETTY_COLOR_OPT_NEVER
:
701 pretty
->use_colors
= false;
707 void init_stream_packet_context_quarks(void)
709 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
710 g_quark_from_string("timestamp_begin");
711 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
712 g_quark_from_string("timestamp_begin");
713 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
714 g_quark_from_string("timestamp_end");
715 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
716 g_quark_from_string("events_discarded");
717 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
718 g_quark_from_string("content_size");
719 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
720 g_quark_from_string("packet_size");
721 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
722 g_quark_from_string("packet_seq_num");
726 enum bt_component_status
pretty_init(
727 struct bt_private_component
*component
,
728 struct bt_value
*params
,
729 UNUSED_VAR
void *init_method_data
)
731 enum bt_component_status ret
;
732 struct pretty_component
*pretty
= create_pretty();
735 ret
= BT_COMPONENT_STATUS_NOMEM
;
739 ret
= bt_private_component_sink_add_input_private_port(component
,
741 if (ret
!= BT_COMPONENT_STATUS_OK
) {
745 pretty
->out
= stdout
;
746 pretty
->err
= stderr
;
748 pretty
->delta_cycles
= -1ULL;
749 pretty
->last_cycles_timestamp
= -1ULL;
751 pretty
->delta_real_timestamp
= -1ULL;
752 pretty
->last_real_timestamp
= -1ULL;
754 ret
= apply_params(pretty
, params
);
755 if (ret
!= BT_COMPONENT_STATUS_OK
) {
759 set_use_colors(pretty
);
760 ret
= bt_private_component_set_user_data(component
, pretty
);
761 if (ret
!= BT_COMPONENT_STATUS_OK
) {
765 init_stream_packet_context_quarks();
770 destroy_pretty_data(pretty
);