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 void 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_connection_status conn_status
;
161 struct bt_private_connection
*connection
;
162 struct pretty_component
*pretty
;
164 pretty
= bt_private_component_get_user_data(component
);
166 BT_ASSERT(!pretty
->input_iterator
);
167 connection
= bt_private_port_get_private_connection(self_port
);
168 BT_ASSERT(connection
);
169 conn_status
= bt_private_connection_create_notification_iterator(
170 connection
, &pretty
->input_iterator
);
171 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
172 pretty
->error
= true;
179 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
181 enum bt_component_status ret
;
182 bt_notification_array notifs
;
183 struct bt_notification_iterator
*it
;
184 struct pretty_component
*pretty
=
185 bt_private_component_get_user_data(component
);
186 enum bt_notification_iterator_status it_ret
;
190 if (unlikely(pretty
->error
)) {
191 ret
= BT_COMPONENT_STATUS_ERROR
;
195 it
= pretty
->input_iterator
;
196 it_ret
= bt_private_connection_notification_iterator_next(it
, ¬ifs
,
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 BT_ASSERT(it_ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
);
216 for (i
= 0; i
< count
; i
++) {
217 ret
= handle_notification(pretty
, notifs
[i
]);
226 for (; i
< count
; i
++) {
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 bt_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_has_key(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_borrow(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
);
300 enum bt_component_status
apply_one_bool(const char *key
,
301 struct bt_value
*params
,
305 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
306 struct bt_value
*value
= NULL
;
307 enum bt_value_status status
;
310 value
= bt_value_map_borrow(params
, key
);
314 status
= bt_value_bool_get(value
, &bool_val
);
316 case BT_VALUE_STATUS_OK
:
319 ret
= BT_COMPONENT_STATUS_ERROR
;
322 *option
= (bool) bool_val
;
332 void warn_wrong_color_param(struct pretty_component
*pretty
)
335 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
339 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
341 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
343 if (!pretty
->options
.output_path
) {
347 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
355 ret
= BT_COMPONENT_STATUS_ERROR
;
361 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
362 struct bt_value
*params
)
364 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
365 enum bt_value_status status
;
369 pretty
->plugin_opt_map
= bt_value_map_create();
370 if (!pretty
->plugin_opt_map
) {
371 ret
= BT_COMPONENT_STATUS_ERROR
;
374 ret
= add_params_to_map(pretty
->plugin_opt_map
);
375 if (ret
!= BT_COMPONENT_STATUS_OK
) {
378 /* Report unknown parameters. */
379 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
381 case BT_VALUE_STATUS_OK
:
384 ret
= BT_COMPONENT_STATUS_ERROR
;
387 /* Known parameters. */
388 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
389 if (bt_value_map_has_key(params
, "color")) {
390 struct bt_value
*color_value
;
393 color_value
= bt_value_map_borrow(params
, "color");
398 status
= bt_value_string_get(color_value
, &color
);
400 warn_wrong_color_param(pretty
);
402 if (strcmp(color
, "never") == 0) {
403 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
404 } else if (strcmp(color
, "auto") == 0) {
405 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
406 } else if (strcmp(color
, "always") == 0) {
407 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
409 warn_wrong_color_param(pretty
);
414 ret
= apply_one_string("path", params
, &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 value
= false; /* Default. */
424 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
425 if (ret
!= BT_COMPONENT_STATUS_OK
) {
428 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
430 value
= false; /* Default. */
431 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
432 if (ret
!= BT_COMPONENT_STATUS_OK
) {
435 pretty
->options
.print_timestamp_cycles
= value
;
437 value
= false; /* Default. */
438 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
439 if (ret
!= BT_COMPONENT_STATUS_OK
) {
442 pretty
->options
.clock_seconds
= value
;
444 value
= false; /* Default. */
445 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
446 if (ret
!= BT_COMPONENT_STATUS_OK
) {
449 pretty
->options
.clock_date
= value
;
451 value
= false; /* Default. */
452 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
453 if (ret
!= BT_COMPONENT_STATUS_OK
) {
456 pretty
->options
.clock_gmt
= value
;
458 value
= false; /* Default. */
459 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
460 if (ret
!= BT_COMPONENT_STATUS_OK
) {
463 pretty
->options
.verbose
= value
;
466 ret
= apply_one_string("name-default", params
, &str
);
467 if (ret
!= BT_COMPONENT_STATUS_OK
) {
471 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
472 } else if (!strcmp(str
, "show")) {
473 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
474 } else if (!strcmp(str
, "hide")) {
475 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
477 ret
= BT_COMPONENT_STATUS_ERROR
;
483 switch (pretty
->options
.name_default
) {
484 case PRETTY_DEFAULT_UNSET
:
485 pretty
->options
.print_payload_field_names
= true;
486 pretty
->options
.print_context_field_names
= true;
487 pretty
->options
.print_header_field_names
= false;
488 pretty
->options
.print_scope_field_names
= false;
490 case PRETTY_DEFAULT_SHOW
:
491 pretty
->options
.print_payload_field_names
= true;
492 pretty
->options
.print_context_field_names
= true;
493 pretty
->options
.print_header_field_names
= true;
494 pretty
->options
.print_scope_field_names
= true;
496 case PRETTY_DEFAULT_HIDE
:
497 pretty
->options
.print_payload_field_names
= false;
498 pretty
->options
.print_context_field_names
= false;
499 pretty
->options
.print_header_field_names
= false;
500 pretty
->options
.print_scope_field_names
= false;
503 ret
= BT_COMPONENT_STATUS_ERROR
;
509 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
510 if (ret
!= BT_COMPONENT_STATUS_OK
) {
514 pretty
->options
.print_payload_field_names
= value
;
519 ret
= apply_one_bool("name-context", params
, &value
, &found
);
520 if (ret
!= BT_COMPONENT_STATUS_OK
) {
524 pretty
->options
.print_context_field_names
= value
;
529 ret
= apply_one_bool("name-header", params
, &value
, &found
);
530 if (ret
!= BT_COMPONENT_STATUS_OK
) {
534 pretty
->options
.print_header_field_names
= value
;
539 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
540 if (ret
!= BT_COMPONENT_STATUS_OK
) {
544 pretty
->options
.print_scope_field_names
= value
;
548 ret
= apply_one_string("field-default", params
, &str
);
549 if (ret
!= BT_COMPONENT_STATUS_OK
) {
553 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
554 } else if (!strcmp(str
, "show")) {
555 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
556 } else if (!strcmp(str
, "hide")) {
557 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
559 ret
= BT_COMPONENT_STATUS_ERROR
;
565 switch (pretty
->options
.field_default
) {
566 case PRETTY_DEFAULT_UNSET
:
567 pretty
->options
.print_trace_field
= false;
568 pretty
->options
.print_trace_hostname_field
= true;
569 pretty
->options
.print_trace_domain_field
= false;
570 pretty
->options
.print_trace_procname_field
= true;
571 pretty
->options
.print_trace_vpid_field
= true;
572 pretty
->options
.print_loglevel_field
= false;
573 pretty
->options
.print_emf_field
= false;
574 pretty
->options
.print_callsite_field
= false;
576 case PRETTY_DEFAULT_SHOW
:
577 pretty
->options
.print_trace_field
= true;
578 pretty
->options
.print_trace_hostname_field
= true;
579 pretty
->options
.print_trace_domain_field
= true;
580 pretty
->options
.print_trace_procname_field
= true;
581 pretty
->options
.print_trace_vpid_field
= true;
582 pretty
->options
.print_loglevel_field
= true;
583 pretty
->options
.print_emf_field
= true;
584 pretty
->options
.print_callsite_field
= true;
586 case PRETTY_DEFAULT_HIDE
:
587 pretty
->options
.print_trace_field
= false;
588 pretty
->options
.print_trace_hostname_field
= false;
589 pretty
->options
.print_trace_domain_field
= false;
590 pretty
->options
.print_trace_procname_field
= false;
591 pretty
->options
.print_trace_vpid_field
= false;
592 pretty
->options
.print_loglevel_field
= false;
593 pretty
->options
.print_emf_field
= false;
594 pretty
->options
.print_callsite_field
= false;
597 ret
= BT_COMPONENT_STATUS_ERROR
;
603 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
604 if (ret
!= BT_COMPONENT_STATUS_OK
) {
608 pretty
->options
.print_trace_field
= value
;
613 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
614 if (ret
!= BT_COMPONENT_STATUS_OK
) {
618 pretty
->options
.print_trace_hostname_field
= value
;
623 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
624 if (ret
!= BT_COMPONENT_STATUS_OK
) {
628 pretty
->options
.print_trace_domain_field
= value
;
633 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
634 if (ret
!= BT_COMPONENT_STATUS_OK
) {
638 pretty
->options
.print_trace_procname_field
= value
;
643 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
644 if (ret
!= BT_COMPONENT_STATUS_OK
) {
648 pretty
->options
.print_trace_vpid_field
= value
;
653 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
654 if (ret
!= BT_COMPONENT_STATUS_OK
) {
658 pretty
->options
.print_loglevel_field
= value
;
663 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
664 if (ret
!= BT_COMPONENT_STATUS_OK
) {
668 pretty
->options
.print_emf_field
= value
;
673 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
674 if (ret
!= BT_COMPONENT_STATUS_OK
) {
678 pretty
->options
.print_callsite_field
= value
;
682 bt_put(pretty
->plugin_opt_map
);
683 pretty
->plugin_opt_map
= NULL
;
689 void set_use_colors(struct pretty_component
*pretty
)
691 switch (pretty
->options
.color
) {
692 case PRETTY_COLOR_OPT_ALWAYS
:
693 pretty
->use_colors
= true;
695 case PRETTY_COLOR_OPT_AUTO
:
696 pretty
->use_colors
= pretty
->out
== stdout
&&
697 bt_common_colors_supported();
699 case PRETTY_COLOR_OPT_NEVER
:
700 pretty
->use_colors
= false;
706 void init_stream_packet_context_quarks(void)
708 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
709 g_quark_from_string("timestamp_begin");
710 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
711 g_quark_from_string("timestamp_begin");
712 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
713 g_quark_from_string("timestamp_end");
714 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
715 g_quark_from_string("events_discarded");
716 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
717 g_quark_from_string("content_size");
718 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
719 g_quark_from_string("packet_size");
720 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
721 g_quark_from_string("packet_seq_num");
725 enum bt_component_status
pretty_init(
726 struct bt_private_component
*component
,
727 struct bt_value
*params
,
728 UNUSED_VAR
void *init_method_data
)
730 enum bt_component_status ret
;
731 struct pretty_component
*pretty
= create_pretty();
734 ret
= BT_COMPONENT_STATUS_NOMEM
;
738 ret
= bt_private_component_sink_add_input_private_port(component
,
740 if (ret
!= BT_COMPONENT_STATUS_OK
) {
744 pretty
->out
= stdout
;
745 pretty
->err
= stderr
;
747 pretty
->delta_cycles
= -1ULL;
748 pretty
->last_cycles_timestamp
= -1ULL;
750 pretty
->delta_real_timestamp
= -1ULL;
751 pretty
->last_real_timestamp
= -1ULL;
753 ret
= apply_params(pretty
, params
);
754 if (ret
!= BT_COMPONENT_STATUS_OK
) {
758 set_use_colors(pretty
);
759 ret
= bt_private_component_set_user_data(component
, pretty
);
760 if (ret
!= BT_COMPONENT_STATUS_OK
) {
764 init_stream_packet_context_quarks();
769 destroy_pretty_data(pretty
);