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/component-sink.h>
34 #include <babeltrace/graph/port.h>
35 #include <babeltrace/graph/private-port.h>
36 #include <babeltrace/graph/connection.h>
37 #include <babeltrace/graph/private-connection.h>
38 #include <babeltrace/graph/notification.h>
39 #include <babeltrace/graph/notification-iterator.h>
40 #include <babeltrace/graph/notification-event.h>
41 #include <babeltrace/values.h>
42 #include <babeltrace/compiler-internal.h>
43 #include <babeltrace/common-internal.h>
44 #include <plugins-common.h>
53 const char *plugin_options
[] = {
62 "name-default", /* show/hide */
67 "field-default", /* show/hide */
69 "field-trace:hostname",
71 "field-trace:procname",
79 void destroy_pretty_data(struct pretty_component
*pretty
)
81 bt_put(pretty
->input_iterator
);
82 (void) g_string_free(pretty
->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
) {
117 void pretty_finalize(struct bt_private_component
*component
)
119 void *data
= bt_private_component_get_user_data(component
);
121 destroy_pretty_data(data
);
125 enum bt_component_status
handle_notification(struct pretty_component
*pretty
,
126 struct bt_notification
*notification
)
128 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
132 if (bt_notification_get_type(notification
) == BT_NOTIFICATION_TYPE_EVENT
) {
133 ret
= pretty_print_event(pretty
, notification
);
140 void pretty_port_connected(
141 struct bt_private_component
*component
,
142 struct bt_private_port
*self_port
,
143 struct bt_port
*other_port
)
145 struct bt_private_connection
*connection
;
146 struct pretty_component
*pretty
;
148 pretty
= bt_private_component_get_user_data(component
);
150 assert(!pretty
->input_iterator
);
151 connection
= bt_private_port_get_private_connection(self_port
);
153 pretty
->input_iterator
=
154 bt_private_connection_create_notification_iterator(connection
);
156 if (!pretty
->input_iterator
) {
157 pretty
->error
= true;
164 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
166 enum bt_component_status ret
;
167 struct bt_notification
*notification
= NULL
;
168 struct bt_notification_iterator
*it
;
169 struct pretty_component
*pretty
=
170 bt_private_component_get_user_data(component
);
171 enum bt_notification_iterator_status it_ret
;
173 if (unlikely(pretty
->error
)) {
174 ret
= BT_COMPONENT_STATUS_ERROR
;
178 it
= pretty
->input_iterator
;
179 it_ret
= bt_notification_iterator_next(it
);
182 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
183 ret
= BT_COMPONENT_STATUS_ERROR
;
185 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
186 ret
= BT_COMPONENT_STATUS_END
;
187 BT_PUT(pretty
->input_iterator
);
189 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
190 ret
= BT_COMPONENT_STATUS_AGAIN
;
192 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
195 ret
= BT_COMPONENT_STATUS_ERROR
;
199 notification
= bt_notification_iterator_get_notification(it
);
200 assert(notification
);
201 ret
= handle_notification(pretty
, notification
);
204 bt_put(notification
);
209 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
211 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
214 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
215 const char *key
= plugin_options
[i
];
216 enum bt_value_status status
;
218 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
220 case BT_VALUE_STATUS_OK
:
223 ret
= BT_COMPONENT_STATUS_ERROR
;
232 bool check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
234 struct pretty_component
*pretty
= data
;
235 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
237 if (!bt_value_map_get(plugin_opt_map
, key
)) {
239 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
245 enum bt_component_status
apply_one_string(const char *key
,
246 struct bt_value
*params
,
249 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
250 struct bt_value
*value
= NULL
;
251 enum bt_value_status status
;
254 value
= bt_value_map_get(params
, key
);
258 if (bt_value_is_null(value
)) {
261 status
= bt_value_string_get(value
, &str
);
263 case BT_VALUE_STATUS_OK
:
266 ret
= BT_COMPONENT_STATUS_ERROR
;
269 *option
= g_strdup(str
);
276 enum bt_component_status
apply_one_bool(const char *key
,
277 struct bt_value
*params
,
281 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
282 struct bt_value
*value
= NULL
;
283 enum bt_value_status status
;
285 value
= bt_value_map_get(params
, key
);
289 status
= bt_value_bool_get(value
, option
);
291 case BT_VALUE_STATUS_OK
:
294 ret
= BT_COMPONENT_STATUS_ERROR
;
306 void warn_wrong_color_param(struct pretty_component
*pretty
)
309 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
313 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
315 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
317 if (!pretty
->options
.output_path
) {
321 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
329 ret
= BT_COMPONENT_STATUS_ERROR
;
335 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
336 struct bt_value
*params
)
338 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
339 enum bt_value_status status
;
343 pretty
->plugin_opt_map
= bt_value_map_create();
344 if (!pretty
->plugin_opt_map
) {
345 ret
= BT_COMPONENT_STATUS_ERROR
;
348 ret
= add_params_to_map(pretty
->plugin_opt_map
);
349 if (ret
!= BT_COMPONENT_STATUS_OK
) {
352 /* Report unknown parameters. */
353 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
355 case BT_VALUE_STATUS_OK
:
358 ret
= BT_COMPONENT_STATUS_ERROR
;
361 /* Known parameters. */
362 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
363 if (bt_value_map_has_key(params
, "color")) {
364 struct bt_value
*color_value
;
367 color_value
= bt_value_map_get(params
, "color");
372 status
= bt_value_string_get(color_value
, &color
);
374 warn_wrong_color_param(pretty
);
376 if (strcmp(color
, "never") == 0) {
377 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
378 } else if (strcmp(color
, "auto") == 0) {
379 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
380 } else if (strcmp(color
, "always") == 0) {
381 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
383 warn_wrong_color_param(pretty
);
390 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
391 if (ret
!= BT_COMPONENT_STATUS_OK
) {
394 ret
= open_output_file(pretty
);
395 if (ret
!= BT_COMPONENT_STATUS_OK
) {
399 value
= false; /* Default. */
400 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
401 if (ret
!= BT_COMPONENT_STATUS_OK
) {
404 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
406 value
= false; /* Default. */
407 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
408 if (ret
!= BT_COMPONENT_STATUS_OK
) {
411 pretty
->options
.print_timestamp_cycles
= value
;
413 value
= false; /* Default. */
414 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
415 if (ret
!= BT_COMPONENT_STATUS_OK
) {
418 pretty
->options
.clock_seconds
= value
;
420 value
= false; /* Default. */
421 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
422 if (ret
!= BT_COMPONENT_STATUS_OK
) {
425 pretty
->options
.clock_date
= value
;
427 value
= false; /* Default. */
428 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
429 if (ret
!= BT_COMPONENT_STATUS_OK
) {
432 pretty
->options
.clock_gmt
= value
;
434 value
= false; /* Default. */
435 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
436 if (ret
!= BT_COMPONENT_STATUS_OK
) {
439 pretty
->options
.verbose
= value
;
442 ret
= apply_one_string("name-default", params
, &str
);
443 if (ret
!= BT_COMPONENT_STATUS_OK
) {
447 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
448 } else if (!strcmp(str
, "show")) {
449 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
450 } else if (!strcmp(str
, "hide")) {
451 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
453 ret
= BT_COMPONENT_STATUS_ERROR
;
459 switch (pretty
->options
.name_default
) {
460 case PRETTY_DEFAULT_UNSET
:
461 pretty
->options
.print_payload_field_names
= true;
462 pretty
->options
.print_context_field_names
= true;
463 pretty
->options
.print_header_field_names
= false;
464 pretty
->options
.print_scope_field_names
= false;
466 case PRETTY_DEFAULT_SHOW
:
467 pretty
->options
.print_payload_field_names
= true;
468 pretty
->options
.print_context_field_names
= true;
469 pretty
->options
.print_header_field_names
= true;
470 pretty
->options
.print_scope_field_names
= true;
472 case PRETTY_DEFAULT_HIDE
:
473 pretty
->options
.print_payload_field_names
= false;
474 pretty
->options
.print_context_field_names
= false;
475 pretty
->options
.print_header_field_names
= false;
476 pretty
->options
.print_scope_field_names
= false;
479 ret
= BT_COMPONENT_STATUS_ERROR
;
485 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
486 if (ret
!= BT_COMPONENT_STATUS_OK
) {
490 pretty
->options
.print_payload_field_names
= value
;
495 ret
= apply_one_bool("name-context", params
, &value
, &found
);
496 if (ret
!= BT_COMPONENT_STATUS_OK
) {
500 pretty
->options
.print_context_field_names
= value
;
505 ret
= apply_one_bool("name-header", params
, &value
, &found
);
506 if (ret
!= BT_COMPONENT_STATUS_OK
) {
510 pretty
->options
.print_header_field_names
= value
;
515 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
516 if (ret
!= BT_COMPONENT_STATUS_OK
) {
520 pretty
->options
.print_scope_field_names
= value
;
524 ret
= apply_one_string("field-default", params
, &str
);
525 if (ret
!= BT_COMPONENT_STATUS_OK
) {
529 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
530 } else if (!strcmp(str
, "show")) {
531 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
532 } else if (!strcmp(str
, "hide")) {
533 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
535 ret
= BT_COMPONENT_STATUS_ERROR
;
541 switch (pretty
->options
.field_default
) {
542 case PRETTY_DEFAULT_UNSET
:
543 pretty
->options
.print_trace_field
= false;
544 pretty
->options
.print_trace_hostname_field
= true;
545 pretty
->options
.print_trace_domain_field
= false;
546 pretty
->options
.print_trace_procname_field
= true;
547 pretty
->options
.print_trace_vpid_field
= true;
548 pretty
->options
.print_loglevel_field
= false;
549 pretty
->options
.print_emf_field
= false;
550 pretty
->options
.print_callsite_field
= false;
552 case PRETTY_DEFAULT_SHOW
:
553 pretty
->options
.print_trace_field
= true;
554 pretty
->options
.print_trace_hostname_field
= true;
555 pretty
->options
.print_trace_domain_field
= true;
556 pretty
->options
.print_trace_procname_field
= true;
557 pretty
->options
.print_trace_vpid_field
= true;
558 pretty
->options
.print_loglevel_field
= true;
559 pretty
->options
.print_emf_field
= true;
560 pretty
->options
.print_callsite_field
= true;
562 case PRETTY_DEFAULT_HIDE
:
563 pretty
->options
.print_trace_field
= false;
564 pretty
->options
.print_trace_hostname_field
= false;
565 pretty
->options
.print_trace_domain_field
= false;
566 pretty
->options
.print_trace_procname_field
= false;
567 pretty
->options
.print_trace_vpid_field
= false;
568 pretty
->options
.print_loglevel_field
= false;
569 pretty
->options
.print_emf_field
= false;
570 pretty
->options
.print_callsite_field
= false;
573 ret
= BT_COMPONENT_STATUS_ERROR
;
579 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
580 if (ret
!= BT_COMPONENT_STATUS_OK
) {
584 pretty
->options
.print_trace_field
= value
;
589 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
590 if (ret
!= BT_COMPONENT_STATUS_OK
) {
594 pretty
->options
.print_trace_hostname_field
= value
;
599 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
600 if (ret
!= BT_COMPONENT_STATUS_OK
) {
604 pretty
->options
.print_trace_domain_field
= value
;
609 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
610 if (ret
!= BT_COMPONENT_STATUS_OK
) {
614 pretty
->options
.print_trace_procname_field
= value
;
619 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
620 if (ret
!= BT_COMPONENT_STATUS_OK
) {
624 pretty
->options
.print_trace_vpid_field
= value
;
629 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
630 if (ret
!= BT_COMPONENT_STATUS_OK
) {
634 pretty
->options
.print_loglevel_field
= value
;
639 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
640 if (ret
!= BT_COMPONENT_STATUS_OK
) {
644 pretty
->options
.print_emf_field
= value
;
649 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
650 if (ret
!= BT_COMPONENT_STATUS_OK
) {
654 pretty
->options
.print_callsite_field
= value
;
658 bt_put(pretty
->plugin_opt_map
);
659 pretty
->plugin_opt_map
= NULL
;
665 void set_use_colors(struct pretty_component
*pretty
)
667 switch (pretty
->options
.color
) {
668 case PRETTY_COLOR_OPT_ALWAYS
:
669 pretty
->use_colors
= true;
671 case PRETTY_COLOR_OPT_AUTO
:
672 pretty
->use_colors
= pretty
->out
== stdout
&&
673 bt_common_colors_supported();
675 case PRETTY_COLOR_OPT_NEVER
:
676 pretty
->use_colors
= false;
682 void init_stream_packet_context_quarks(void)
684 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
685 g_quark_from_string("timestamp_begin");
686 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
687 g_quark_from_string("timestamp_begin");
688 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
689 g_quark_from_string("timestamp_end");
690 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
691 g_quark_from_string("events_discarded");
692 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
693 g_quark_from_string("content_size");
694 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
695 g_quark_from_string("packet_size");
696 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
697 g_quark_from_string("packet_seq_num");
701 enum bt_component_status
pretty_init(
702 struct bt_private_component
*component
,
703 struct bt_value
*params
,
704 UNUSED_VAR
void *init_method_data
)
706 enum bt_component_status ret
;
707 struct pretty_component
*pretty
= create_pretty();
710 ret
= BT_COMPONENT_STATUS_NOMEM
;
714 pretty
->out
= stdout
;
715 pretty
->err
= stderr
;
717 pretty
->delta_cycles
= -1ULL;
718 pretty
->last_cycles_timestamp
= -1ULL;
720 pretty
->delta_real_timestamp
= -1ULL;
721 pretty
->last_real_timestamp
= -1ULL;
723 ret
= apply_params(pretty
, params
);
724 if (ret
!= BT_COMPONENT_STATUS_OK
) {
728 set_use_colors(pretty
);
729 ret
= bt_private_component_set_user_data(component
, pretty
);
730 if (ret
!= BT_COMPONENT_STATUS_OK
) {
734 init_stream_packet_context_quarks();
739 destroy_pretty_data(pretty
);