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
);
85 (void) g_string_free(pretty
->string
, TRUE
);
88 if (pretty
->tmp_string
) {
89 (void) g_string_free(pretty
->tmp_string
, TRUE
);
92 if (pretty
->out
!= stdout
) {
95 ret
= fclose(pretty
->out
);
97 perror("close output file");
100 g_free(pretty
->options
.output_path
);
105 struct pretty_component
*create_pretty(void)
107 struct pretty_component
*pretty
;
109 pretty
= g_new0(struct pretty_component
, 1);
113 pretty
->string
= g_string_new("");
114 if (!pretty
->string
) {
117 pretty
->tmp_string
= g_string_new("");
118 if (!pretty
->tmp_string
) {
130 void pretty_finalize(struct bt_private_component
*component
)
132 void *data
= bt_private_component_get_user_data(component
);
134 destroy_pretty_data(data
);
138 enum bt_component_status
handle_notification(struct pretty_component
*pretty
,
139 struct bt_notification
*notification
)
141 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
145 switch (bt_notification_get_type(notification
)) {
146 case BT_NOTIFICATION_TYPE_EVENT
:
147 ret
= pretty_print_event(pretty
, notification
);
149 case BT_NOTIFICATION_TYPE_INACTIVITY
:
150 fprintf(stderr
, "Inactivity notification\n");
152 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
153 case BT_NOTIFICATION_TYPE_PACKET_END
:
154 case BT_NOTIFICATION_TYPE_STREAM_BEGIN
:
155 case BT_NOTIFICATION_TYPE_STREAM_END
:
158 fprintf(stderr
, "Unhandled notification type\n");
165 void pretty_port_connected(
166 struct bt_private_component
*component
,
167 struct bt_private_port
*self_port
,
168 struct bt_port
*other_port
)
170 enum bt_connection_status conn_status
;
171 struct bt_private_connection
*connection
;
172 struct pretty_component
*pretty
;
173 static const enum bt_notification_type notif_types
[] = {
174 BT_NOTIFICATION_TYPE_EVENT
,
175 BT_NOTIFICATION_TYPE_SENTINEL
,
178 pretty
= bt_private_component_get_user_data(component
);
180 assert(!pretty
->input_iterator
);
181 connection
= bt_private_port_get_private_connection(self_port
);
183 conn_status
= bt_private_connection_create_notification_iterator(
184 connection
, notif_types
, &pretty
->input_iterator
);
185 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
186 pretty
->error
= true;
193 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
195 enum bt_component_status ret
;
196 struct bt_notification
*notification
= NULL
;
197 struct bt_notification_iterator
*it
;
198 struct pretty_component
*pretty
=
199 bt_private_component_get_user_data(component
);
200 enum bt_notification_iterator_status it_ret
;
202 if (unlikely(pretty
->error
)) {
203 ret
= BT_COMPONENT_STATUS_ERROR
;
207 it
= pretty
->input_iterator
;
208 it_ret
= bt_notification_iterator_next(it
);
211 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
212 ret
= BT_COMPONENT_STATUS_END
;
213 BT_PUT(pretty
->input_iterator
);
215 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
216 ret
= BT_COMPONENT_STATUS_AGAIN
;
218 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
221 ret
= BT_COMPONENT_STATUS_ERROR
;
225 notification
= bt_notification_iterator_get_notification(it
);
226 assert(notification
);
227 ret
= handle_notification(pretty
, notification
);
230 bt_put(notification
);
235 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
237 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
240 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
241 const char *key
= plugin_options
[i
];
242 enum bt_value_status status
;
244 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
246 case BT_VALUE_STATUS_OK
:
249 ret
= BT_COMPONENT_STATUS_ERROR
;
258 bt_bool
check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
260 struct pretty_component
*pretty
= data
;
261 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
263 if (!bt_value_map_get(plugin_opt_map
, key
)) {
265 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
271 enum bt_component_status
apply_one_string(const char *key
,
272 struct bt_value
*params
,
275 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
276 struct bt_value
*value
= NULL
;
277 enum bt_value_status status
;
280 value
= bt_value_map_get(params
, key
);
284 if (bt_value_is_null(value
)) {
287 status
= bt_value_string_get(value
, &str
);
289 case BT_VALUE_STATUS_OK
:
292 ret
= BT_COMPONENT_STATUS_ERROR
;
295 *option
= g_strdup(str
);
302 enum bt_component_status
apply_one_bool(const char *key
,
303 struct bt_value
*params
,
307 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
308 struct bt_value
*value
= NULL
;
309 enum bt_value_status status
;
312 value
= bt_value_map_get(params
, key
);
316 status
= bt_value_bool_get(value
, &bool_val
);
318 case BT_VALUE_STATUS_OK
:
321 ret
= BT_COMPONENT_STATUS_ERROR
;
324 *option
= (bool) bool_val
;
334 void warn_wrong_color_param(struct pretty_component
*pretty
)
337 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
341 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
343 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
345 if (!pretty
->options
.output_path
) {
349 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
357 ret
= BT_COMPONENT_STATUS_ERROR
;
363 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
364 struct bt_value
*params
)
366 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
367 enum bt_value_status status
;
371 pretty
->plugin_opt_map
= bt_value_map_create();
372 if (!pretty
->plugin_opt_map
) {
373 ret
= BT_COMPONENT_STATUS_ERROR
;
376 ret
= add_params_to_map(pretty
->plugin_opt_map
);
377 if (ret
!= BT_COMPONENT_STATUS_OK
) {
380 /* Report unknown parameters. */
381 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
383 case BT_VALUE_STATUS_OK
:
386 ret
= BT_COMPONENT_STATUS_ERROR
;
389 /* Known parameters. */
390 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
391 if (bt_value_map_has_key(params
, "color")) {
392 struct bt_value
*color_value
;
395 color_value
= bt_value_map_get(params
, "color");
400 status
= bt_value_string_get(color_value
, &color
);
402 warn_wrong_color_param(pretty
);
404 if (strcmp(color
, "never") == 0) {
405 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
406 } else if (strcmp(color
, "auto") == 0) {
407 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
408 } else if (strcmp(color
, "always") == 0) {
409 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
411 warn_wrong_color_param(pretty
);
418 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
419 if (ret
!= BT_COMPONENT_STATUS_OK
) {
422 ret
= open_output_file(pretty
);
423 if (ret
!= BT_COMPONENT_STATUS_OK
) {
427 value
= false; /* Default. */
428 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
429 if (ret
!= BT_COMPONENT_STATUS_OK
) {
432 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
434 value
= false; /* Default. */
435 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
436 if (ret
!= BT_COMPONENT_STATUS_OK
) {
439 pretty
->options
.print_timestamp_cycles
= value
;
441 value
= false; /* Default. */
442 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
443 if (ret
!= BT_COMPONENT_STATUS_OK
) {
446 pretty
->options
.clock_seconds
= value
;
448 value
= false; /* Default. */
449 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
450 if (ret
!= BT_COMPONENT_STATUS_OK
) {
453 pretty
->options
.clock_date
= value
;
455 value
= false; /* Default. */
456 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
457 if (ret
!= BT_COMPONENT_STATUS_OK
) {
460 pretty
->options
.clock_gmt
= value
;
462 value
= false; /* Default. */
463 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
464 if (ret
!= BT_COMPONENT_STATUS_OK
) {
467 pretty
->options
.verbose
= value
;
470 ret
= apply_one_string("name-default", params
, &str
);
471 if (ret
!= BT_COMPONENT_STATUS_OK
) {
475 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
476 } else if (!strcmp(str
, "show")) {
477 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
478 } else if (!strcmp(str
, "hide")) {
479 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
481 ret
= BT_COMPONENT_STATUS_ERROR
;
487 switch (pretty
->options
.name_default
) {
488 case PRETTY_DEFAULT_UNSET
:
489 pretty
->options
.print_payload_field_names
= true;
490 pretty
->options
.print_context_field_names
= true;
491 pretty
->options
.print_header_field_names
= false;
492 pretty
->options
.print_scope_field_names
= false;
494 case PRETTY_DEFAULT_SHOW
:
495 pretty
->options
.print_payload_field_names
= true;
496 pretty
->options
.print_context_field_names
= true;
497 pretty
->options
.print_header_field_names
= true;
498 pretty
->options
.print_scope_field_names
= true;
500 case PRETTY_DEFAULT_HIDE
:
501 pretty
->options
.print_payload_field_names
= false;
502 pretty
->options
.print_context_field_names
= false;
503 pretty
->options
.print_header_field_names
= false;
504 pretty
->options
.print_scope_field_names
= false;
507 ret
= BT_COMPONENT_STATUS_ERROR
;
513 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
514 if (ret
!= BT_COMPONENT_STATUS_OK
) {
518 pretty
->options
.print_payload_field_names
= value
;
523 ret
= apply_one_bool("name-context", params
, &value
, &found
);
524 if (ret
!= BT_COMPONENT_STATUS_OK
) {
528 pretty
->options
.print_context_field_names
= value
;
533 ret
= apply_one_bool("name-header", params
, &value
, &found
);
534 if (ret
!= BT_COMPONENT_STATUS_OK
) {
538 pretty
->options
.print_header_field_names
= value
;
543 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
544 if (ret
!= BT_COMPONENT_STATUS_OK
) {
548 pretty
->options
.print_scope_field_names
= value
;
552 ret
= apply_one_string("field-default", params
, &str
);
553 if (ret
!= BT_COMPONENT_STATUS_OK
) {
557 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
558 } else if (!strcmp(str
, "show")) {
559 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
560 } else if (!strcmp(str
, "hide")) {
561 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
563 ret
= BT_COMPONENT_STATUS_ERROR
;
569 switch (pretty
->options
.field_default
) {
570 case PRETTY_DEFAULT_UNSET
:
571 pretty
->options
.print_trace_field
= false;
572 pretty
->options
.print_trace_hostname_field
= true;
573 pretty
->options
.print_trace_domain_field
= false;
574 pretty
->options
.print_trace_procname_field
= true;
575 pretty
->options
.print_trace_vpid_field
= true;
576 pretty
->options
.print_loglevel_field
= false;
577 pretty
->options
.print_emf_field
= false;
578 pretty
->options
.print_callsite_field
= false;
580 case PRETTY_DEFAULT_SHOW
:
581 pretty
->options
.print_trace_field
= true;
582 pretty
->options
.print_trace_hostname_field
= true;
583 pretty
->options
.print_trace_domain_field
= true;
584 pretty
->options
.print_trace_procname_field
= true;
585 pretty
->options
.print_trace_vpid_field
= true;
586 pretty
->options
.print_loglevel_field
= true;
587 pretty
->options
.print_emf_field
= true;
588 pretty
->options
.print_callsite_field
= true;
590 case PRETTY_DEFAULT_HIDE
:
591 pretty
->options
.print_trace_field
= false;
592 pretty
->options
.print_trace_hostname_field
= false;
593 pretty
->options
.print_trace_domain_field
= false;
594 pretty
->options
.print_trace_procname_field
= false;
595 pretty
->options
.print_trace_vpid_field
= false;
596 pretty
->options
.print_loglevel_field
= false;
597 pretty
->options
.print_emf_field
= false;
598 pretty
->options
.print_callsite_field
= false;
601 ret
= BT_COMPONENT_STATUS_ERROR
;
607 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
608 if (ret
!= BT_COMPONENT_STATUS_OK
) {
612 pretty
->options
.print_trace_field
= value
;
617 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
618 if (ret
!= BT_COMPONENT_STATUS_OK
) {
622 pretty
->options
.print_trace_hostname_field
= value
;
627 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
628 if (ret
!= BT_COMPONENT_STATUS_OK
) {
632 pretty
->options
.print_trace_domain_field
= value
;
637 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
638 if (ret
!= BT_COMPONENT_STATUS_OK
) {
642 pretty
->options
.print_trace_procname_field
= value
;
647 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
648 if (ret
!= BT_COMPONENT_STATUS_OK
) {
652 pretty
->options
.print_trace_vpid_field
= value
;
657 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
658 if (ret
!= BT_COMPONENT_STATUS_OK
) {
662 pretty
->options
.print_loglevel_field
= value
;
667 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
668 if (ret
!= BT_COMPONENT_STATUS_OK
) {
672 pretty
->options
.print_emf_field
= value
;
677 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
678 if (ret
!= BT_COMPONENT_STATUS_OK
) {
682 pretty
->options
.print_callsite_field
= value
;
686 bt_put(pretty
->plugin_opt_map
);
687 pretty
->plugin_opt_map
= NULL
;
693 void set_use_colors(struct pretty_component
*pretty
)
695 switch (pretty
->options
.color
) {
696 case PRETTY_COLOR_OPT_ALWAYS
:
697 pretty
->use_colors
= true;
699 case PRETTY_COLOR_OPT_AUTO
:
700 pretty
->use_colors
= pretty
->out
== stdout
&&
701 bt_common_colors_supported();
703 case PRETTY_COLOR_OPT_NEVER
:
704 pretty
->use_colors
= false;
710 void init_stream_packet_context_quarks(void)
712 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
713 g_quark_from_string("timestamp_begin");
714 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
715 g_quark_from_string("timestamp_begin");
716 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
717 g_quark_from_string("timestamp_end");
718 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
719 g_quark_from_string("events_discarded");
720 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
721 g_quark_from_string("content_size");
722 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
723 g_quark_from_string("packet_size");
724 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
725 g_quark_from_string("packet_seq_num");
729 enum bt_component_status
pretty_init(
730 struct bt_private_component
*component
,
731 struct bt_value
*params
,
732 UNUSED_VAR
void *init_method_data
)
734 enum bt_component_status ret
;
735 struct pretty_component
*pretty
= create_pretty();
738 ret
= BT_COMPONENT_STATUS_NOMEM
;
742 ret
= bt_private_component_sink_add_input_private_port(component
,
744 if (ret
!= BT_COMPONENT_STATUS_OK
) {
748 pretty
->out
= stdout
;
749 pretty
->err
= stderr
;
751 pretty
->delta_cycles
= -1ULL;
752 pretty
->last_cycles_timestamp
= -1ULL;
754 pretty
->delta_real_timestamp
= -1ULL;
755 pretty
->last_real_timestamp
= -1ULL;
757 ret
= apply_params(pretty
, params
);
758 if (ret
!= BT_COMPONENT_STATUS_OK
) {
762 set_use_colors(pretty
);
763 ret
= bt_private_component_set_user_data(component
, pretty
);
764 if (ret
!= BT_COMPONENT_STATUS_OK
) {
768 init_stream_packet_context_quarks();
773 destroy_pretty_data(pretty
);