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 if (bt_notification_get_type(notification
) == BT_NOTIFICATION_TYPE_EVENT
) {
134 ret
= pretty_print_event(pretty
, notification
);
141 void pretty_port_connected(
142 struct bt_private_component
*component
,
143 struct bt_private_port
*self_port
,
144 struct bt_port
*other_port
)
146 struct bt_private_connection
*connection
;
147 struct pretty_component
*pretty
;
149 pretty
= bt_private_component_get_user_data(component
);
151 assert(!pretty
->input_iterator
);
152 connection
= bt_private_port_get_private_connection(self_port
);
154 pretty
->input_iterator
=
155 bt_private_connection_create_notification_iterator(connection
);
157 if (!pretty
->input_iterator
) {
158 pretty
->error
= true;
165 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
167 enum bt_component_status ret
;
168 struct bt_notification
*notification
= NULL
;
169 struct bt_notification_iterator
*it
;
170 struct pretty_component
*pretty
=
171 bt_private_component_get_user_data(component
);
172 enum bt_notification_iterator_status it_ret
;
174 if (unlikely(pretty
->error
)) {
175 ret
= BT_COMPONENT_STATUS_ERROR
;
179 it
= pretty
->input_iterator
;
180 it_ret
= bt_notification_iterator_next(it
);
183 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
184 ret
= BT_COMPONENT_STATUS_ERROR
;
186 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
187 ret
= BT_COMPONENT_STATUS_END
;
188 BT_PUT(pretty
->input_iterator
);
190 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
191 ret
= BT_COMPONENT_STATUS_AGAIN
;
193 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
196 ret
= BT_COMPONENT_STATUS_ERROR
;
200 notification
= bt_notification_iterator_get_notification(it
);
201 assert(notification
);
202 ret
= handle_notification(pretty
, notification
);
205 bt_put(notification
);
210 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
212 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
215 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
216 const char *key
= plugin_options
[i
];
217 enum bt_value_status status
;
219 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
221 case BT_VALUE_STATUS_OK
:
224 ret
= BT_COMPONENT_STATUS_ERROR
;
233 bool check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
235 struct pretty_component
*pretty
= data
;
236 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
238 if (!bt_value_map_get(plugin_opt_map
, key
)) {
240 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
246 enum bt_component_status
apply_one_string(const char *key
,
247 struct bt_value
*params
,
250 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
251 struct bt_value
*value
= NULL
;
252 enum bt_value_status status
;
255 value
= bt_value_map_get(params
, key
);
259 if (bt_value_is_null(value
)) {
262 status
= bt_value_string_get(value
, &str
);
264 case BT_VALUE_STATUS_OK
:
267 ret
= BT_COMPONENT_STATUS_ERROR
;
270 *option
= g_strdup(str
);
277 enum bt_component_status
apply_one_bool(const char *key
,
278 struct bt_value
*params
,
282 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
283 struct bt_value
*value
= NULL
;
284 enum bt_value_status status
;
286 value
= bt_value_map_get(params
, key
);
290 status
= bt_value_bool_get(value
, option
);
292 case BT_VALUE_STATUS_OK
:
295 ret
= BT_COMPONENT_STATUS_ERROR
;
307 void warn_wrong_color_param(struct pretty_component
*pretty
)
310 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
314 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
316 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
318 if (!pretty
->options
.output_path
) {
322 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
330 ret
= BT_COMPONENT_STATUS_ERROR
;
336 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
337 struct bt_value
*params
)
339 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
340 enum bt_value_status status
;
344 pretty
->plugin_opt_map
= bt_value_map_create();
345 if (!pretty
->plugin_opt_map
) {
346 ret
= BT_COMPONENT_STATUS_ERROR
;
349 ret
= add_params_to_map(pretty
->plugin_opt_map
);
350 if (ret
!= BT_COMPONENT_STATUS_OK
) {
353 /* Report unknown parameters. */
354 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
356 case BT_VALUE_STATUS_OK
:
359 ret
= BT_COMPONENT_STATUS_ERROR
;
362 /* Known parameters. */
363 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
364 if (bt_value_map_has_key(params
, "color")) {
365 struct bt_value
*color_value
;
368 color_value
= bt_value_map_get(params
, "color");
373 status
= bt_value_string_get(color_value
, &color
);
375 warn_wrong_color_param(pretty
);
377 if (strcmp(color
, "never") == 0) {
378 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
379 } else if (strcmp(color
, "auto") == 0) {
380 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
381 } else if (strcmp(color
, "always") == 0) {
382 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
384 warn_wrong_color_param(pretty
);
391 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
392 if (ret
!= BT_COMPONENT_STATUS_OK
) {
395 ret
= open_output_file(pretty
);
396 if (ret
!= BT_COMPONENT_STATUS_OK
) {
400 value
= false; /* Default. */
401 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
402 if (ret
!= BT_COMPONENT_STATUS_OK
) {
405 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
407 value
= false; /* Default. */
408 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
409 if (ret
!= BT_COMPONENT_STATUS_OK
) {
412 pretty
->options
.print_timestamp_cycles
= value
;
414 value
= false; /* Default. */
415 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
416 if (ret
!= BT_COMPONENT_STATUS_OK
) {
419 pretty
->options
.clock_seconds
= value
;
421 value
= false; /* Default. */
422 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
423 if (ret
!= BT_COMPONENT_STATUS_OK
) {
426 pretty
->options
.clock_date
= value
;
428 value
= false; /* Default. */
429 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
430 if (ret
!= BT_COMPONENT_STATUS_OK
) {
433 pretty
->options
.clock_gmt
= value
;
435 value
= false; /* Default. */
436 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
437 if (ret
!= BT_COMPONENT_STATUS_OK
) {
440 pretty
->options
.verbose
= value
;
443 ret
= apply_one_string("name-default", params
, &str
);
444 if (ret
!= BT_COMPONENT_STATUS_OK
) {
448 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
449 } else if (!strcmp(str
, "show")) {
450 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
451 } else if (!strcmp(str
, "hide")) {
452 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
454 ret
= BT_COMPONENT_STATUS_ERROR
;
460 switch (pretty
->options
.name_default
) {
461 case PRETTY_DEFAULT_UNSET
:
462 pretty
->options
.print_payload_field_names
= true;
463 pretty
->options
.print_context_field_names
= true;
464 pretty
->options
.print_header_field_names
= false;
465 pretty
->options
.print_scope_field_names
= false;
467 case PRETTY_DEFAULT_SHOW
:
468 pretty
->options
.print_payload_field_names
= true;
469 pretty
->options
.print_context_field_names
= true;
470 pretty
->options
.print_header_field_names
= true;
471 pretty
->options
.print_scope_field_names
= true;
473 case PRETTY_DEFAULT_HIDE
:
474 pretty
->options
.print_payload_field_names
= false;
475 pretty
->options
.print_context_field_names
= false;
476 pretty
->options
.print_header_field_names
= false;
477 pretty
->options
.print_scope_field_names
= false;
480 ret
= BT_COMPONENT_STATUS_ERROR
;
486 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
487 if (ret
!= BT_COMPONENT_STATUS_OK
) {
491 pretty
->options
.print_payload_field_names
= value
;
496 ret
= apply_one_bool("name-context", params
, &value
, &found
);
497 if (ret
!= BT_COMPONENT_STATUS_OK
) {
501 pretty
->options
.print_context_field_names
= value
;
506 ret
= apply_one_bool("name-header", params
, &value
, &found
);
507 if (ret
!= BT_COMPONENT_STATUS_OK
) {
511 pretty
->options
.print_header_field_names
= value
;
516 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
517 if (ret
!= BT_COMPONENT_STATUS_OK
) {
521 pretty
->options
.print_scope_field_names
= value
;
525 ret
= apply_one_string("field-default", params
, &str
);
526 if (ret
!= BT_COMPONENT_STATUS_OK
) {
530 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
531 } else if (!strcmp(str
, "show")) {
532 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
533 } else if (!strcmp(str
, "hide")) {
534 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
536 ret
= BT_COMPONENT_STATUS_ERROR
;
542 switch (pretty
->options
.field_default
) {
543 case PRETTY_DEFAULT_UNSET
:
544 pretty
->options
.print_trace_field
= false;
545 pretty
->options
.print_trace_hostname_field
= true;
546 pretty
->options
.print_trace_domain_field
= false;
547 pretty
->options
.print_trace_procname_field
= true;
548 pretty
->options
.print_trace_vpid_field
= true;
549 pretty
->options
.print_loglevel_field
= false;
550 pretty
->options
.print_emf_field
= false;
551 pretty
->options
.print_callsite_field
= false;
553 case PRETTY_DEFAULT_SHOW
:
554 pretty
->options
.print_trace_field
= true;
555 pretty
->options
.print_trace_hostname_field
= true;
556 pretty
->options
.print_trace_domain_field
= true;
557 pretty
->options
.print_trace_procname_field
= true;
558 pretty
->options
.print_trace_vpid_field
= true;
559 pretty
->options
.print_loglevel_field
= true;
560 pretty
->options
.print_emf_field
= true;
561 pretty
->options
.print_callsite_field
= true;
563 case PRETTY_DEFAULT_HIDE
:
564 pretty
->options
.print_trace_field
= false;
565 pretty
->options
.print_trace_hostname_field
= false;
566 pretty
->options
.print_trace_domain_field
= false;
567 pretty
->options
.print_trace_procname_field
= false;
568 pretty
->options
.print_trace_vpid_field
= false;
569 pretty
->options
.print_loglevel_field
= false;
570 pretty
->options
.print_emf_field
= false;
571 pretty
->options
.print_callsite_field
= false;
574 ret
= BT_COMPONENT_STATUS_ERROR
;
580 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
581 if (ret
!= BT_COMPONENT_STATUS_OK
) {
585 pretty
->options
.print_trace_field
= value
;
590 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
591 if (ret
!= BT_COMPONENT_STATUS_OK
) {
595 pretty
->options
.print_trace_hostname_field
= value
;
600 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
601 if (ret
!= BT_COMPONENT_STATUS_OK
) {
605 pretty
->options
.print_trace_domain_field
= value
;
610 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
611 if (ret
!= BT_COMPONENT_STATUS_OK
) {
615 pretty
->options
.print_trace_procname_field
= value
;
620 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
621 if (ret
!= BT_COMPONENT_STATUS_OK
) {
625 pretty
->options
.print_trace_vpid_field
= value
;
630 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
631 if (ret
!= BT_COMPONENT_STATUS_OK
) {
635 pretty
->options
.print_loglevel_field
= value
;
640 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
641 if (ret
!= BT_COMPONENT_STATUS_OK
) {
645 pretty
->options
.print_emf_field
= value
;
650 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
651 if (ret
!= BT_COMPONENT_STATUS_OK
) {
655 pretty
->options
.print_callsite_field
= value
;
659 bt_put(pretty
->plugin_opt_map
);
660 pretty
->plugin_opt_map
= NULL
;
666 void set_use_colors(struct pretty_component
*pretty
)
668 switch (pretty
->options
.color
) {
669 case PRETTY_COLOR_OPT_ALWAYS
:
670 pretty
->use_colors
= true;
672 case PRETTY_COLOR_OPT_AUTO
:
673 pretty
->use_colors
= pretty
->out
== stdout
&&
674 bt_common_colors_supported();
676 case PRETTY_COLOR_OPT_NEVER
:
677 pretty
->use_colors
= false;
683 void init_stream_packet_context_quarks(void)
685 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
686 g_quark_from_string("timestamp_begin");
687 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
688 g_quark_from_string("timestamp_begin");
689 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
690 g_quark_from_string("timestamp_end");
691 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
692 g_quark_from_string("events_discarded");
693 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
694 g_quark_from_string("content_size");
695 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
696 g_quark_from_string("packet_size");
697 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
698 g_quark_from_string("packet_seq_num");
702 enum bt_component_status
pretty_init(
703 struct bt_private_component
*component
,
704 struct bt_value
*params
,
705 UNUSED_VAR
void *init_method_data
)
707 enum bt_component_status ret
;
708 struct pretty_component
*pretty
= create_pretty();
712 ret
= BT_COMPONENT_STATUS_NOMEM
;
716 priv_port
= bt_private_component_sink_add_input_private_port(component
,
719 ret
= BT_COMPONENT_STATUS_NOMEM
;
725 pretty
->out
= stdout
;
726 pretty
->err
= stderr
;
728 pretty
->delta_cycles
= -1ULL;
729 pretty
->last_cycles_timestamp
= -1ULL;
731 pretty
->delta_real_timestamp
= -1ULL;
732 pretty
->last_real_timestamp
= -1ULL;
734 ret
= apply_params(pretty
, params
);
735 if (ret
!= BT_COMPONENT_STATUS_OK
) {
739 set_use_colors(pretty
);
740 ret
= bt_private_component_set_user_data(component
, pretty
);
741 if (ret
!= BT_COMPONENT_STATUS_OK
) {
745 init_stream_packet_context_quarks();
750 destroy_pretty_data(pretty
);