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
;
131 ret
= BT_COMPONENT_STATUS_ERROR
;
135 switch (bt_notification_get_type(notification
)) {
136 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
138 case BT_NOTIFICATION_TYPE_PACKET_END
:
140 case BT_NOTIFICATION_TYPE_EVENT
:
142 ret
= pretty_print_event(pretty
, notification
);
143 if (ret
!= BT_COMPONENT_STATUS_OK
) {
148 case BT_NOTIFICATION_TYPE_STREAM_END
:
151 puts("Unhandled notification type");
158 void pretty_port_connected(
159 struct bt_private_component
*component
,
160 struct bt_private_port
*self_port
,
161 struct bt_port
*other_port
)
163 struct bt_private_connection
*connection
;
164 struct pretty_component
*pretty
;
166 pretty
= bt_private_component_get_user_data(component
);
168 assert(!pretty
->input_iterator
);
169 connection
= bt_private_port_get_private_connection(self_port
);
171 pretty
->input_iterator
=
172 bt_private_connection_create_notification_iterator(connection
);
174 if (!pretty
->input_iterator
) {
175 pretty
->error
= true;
182 enum bt_component_status
pretty_consume(struct bt_private_component
*component
)
184 enum bt_component_status ret
;
185 struct bt_notification
*notification
= NULL
;
186 struct bt_notification_iterator
*it
;
187 struct pretty_component
*pretty
=
188 bt_private_component_get_user_data(component
);
189 enum bt_notification_iterator_status it_ret
;
191 if (unlikely(pretty
->error
)) {
192 ret
= BT_COMPONENT_STATUS_ERROR
;
196 it
= pretty
->input_iterator
;
197 it_ret
= bt_notification_iterator_next(it
);
200 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
201 ret
= BT_COMPONENT_STATUS_ERROR
;
203 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
204 ret
= BT_COMPONENT_STATUS_END
;
205 BT_PUT(pretty
->input_iterator
);
211 notification
= bt_notification_iterator_get_notification(it
);
212 assert(notification
);
213 ret
= handle_notification(pretty
, notification
);
215 bt_put(notification
);
220 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
222 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
225 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
226 const char *key
= plugin_options
[i
];
227 enum bt_value_status status
;
229 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
231 case BT_VALUE_STATUS_OK
:
234 ret
= BT_COMPONENT_STATUS_ERROR
;
243 bool check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
245 struct pretty_component
*pretty
= data
;
246 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
248 if (!bt_value_map_get(plugin_opt_map
, key
)) {
250 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
256 enum bt_component_status
apply_one_string(const char *key
,
257 struct bt_value
*params
,
260 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
261 struct bt_value
*value
= NULL
;
262 enum bt_value_status status
;
265 value
= bt_value_map_get(params
, key
);
269 if (bt_value_is_null(value
)) {
272 status
= bt_value_string_get(value
, &str
);
274 case BT_VALUE_STATUS_OK
:
277 ret
= BT_COMPONENT_STATUS_ERROR
;
280 *option
= g_strdup(str
);
287 enum bt_component_status
apply_one_bool(const char *key
,
288 struct bt_value
*params
,
292 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
293 struct bt_value
*value
= NULL
;
294 enum bt_value_status status
;
296 value
= bt_value_map_get(params
, key
);
300 status
= bt_value_bool_get(value
, option
);
302 case BT_VALUE_STATUS_OK
:
305 ret
= BT_COMPONENT_STATUS_ERROR
;
317 void warn_wrong_color_param(struct pretty_component
*pretty
)
320 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
324 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
326 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
328 if (!pretty
->options
.output_path
) {
332 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
340 ret
= BT_COMPONENT_STATUS_ERROR
;
346 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
347 struct bt_value
*params
)
349 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
350 enum bt_value_status status
;
354 pretty
->plugin_opt_map
= bt_value_map_create();
355 if (!pretty
->plugin_opt_map
) {
356 ret
= BT_COMPONENT_STATUS_ERROR
;
359 ret
= add_params_to_map(pretty
->plugin_opt_map
);
360 if (ret
!= BT_COMPONENT_STATUS_OK
) {
363 /* Report unknown parameters. */
364 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
366 case BT_VALUE_STATUS_OK
:
369 ret
= BT_COMPONENT_STATUS_ERROR
;
372 /* Known parameters. */
373 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
374 if (bt_value_map_has_key(params
, "color")) {
375 struct bt_value
*color_value
;
378 color_value
= bt_value_map_get(params
, "color");
383 status
= bt_value_string_get(color_value
, &color
);
385 warn_wrong_color_param(pretty
);
387 if (strcmp(color
, "never") == 0) {
388 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
389 } else if (strcmp(color
, "auto") == 0) {
390 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
391 } else if (strcmp(color
, "always") == 0) {
392 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
394 warn_wrong_color_param(pretty
);
401 ret
= apply_one_string("output-path",
403 &pretty
->options
.output_path
);
404 if (ret
!= BT_COMPONENT_STATUS_OK
) {
407 ret
= open_output_file(pretty
);
408 if (ret
!= BT_COMPONENT_STATUS_OK
) {
412 value
= false; /* Default. */
413 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
414 if (ret
!= BT_COMPONENT_STATUS_OK
) {
417 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
419 value
= false; /* Default. */
420 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
421 if (ret
!= BT_COMPONENT_STATUS_OK
) {
424 pretty
->options
.print_timestamp_cycles
= value
;
426 value
= false; /* Default. */
427 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
428 if (ret
!= BT_COMPONENT_STATUS_OK
) {
431 pretty
->options
.clock_seconds
= value
;
433 value
= false; /* Default. */
434 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
435 if (ret
!= BT_COMPONENT_STATUS_OK
) {
438 pretty
->options
.clock_date
= value
;
440 value
= false; /* Default. */
441 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
442 if (ret
!= BT_COMPONENT_STATUS_OK
) {
445 pretty
->options
.clock_gmt
= value
;
447 value
= false; /* Default. */
448 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
449 if (ret
!= BT_COMPONENT_STATUS_OK
) {
452 pretty
->options
.verbose
= value
;
455 ret
= apply_one_string("name-default", params
, &str
);
456 if (ret
!= BT_COMPONENT_STATUS_OK
) {
460 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
461 } else if (!strcmp(str
, "show")) {
462 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
463 } else if (!strcmp(str
, "hide")) {
464 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
466 ret
= BT_COMPONENT_STATUS_ERROR
;
472 switch (pretty
->options
.name_default
) {
473 case PRETTY_DEFAULT_UNSET
:
474 pretty
->options
.print_payload_field_names
= true;
475 pretty
->options
.print_context_field_names
= true;
476 pretty
->options
.print_header_field_names
= false;
477 pretty
->options
.print_scope_field_names
= false;
479 case PRETTY_DEFAULT_SHOW
:
480 pretty
->options
.print_payload_field_names
= true;
481 pretty
->options
.print_context_field_names
= true;
482 pretty
->options
.print_header_field_names
= true;
483 pretty
->options
.print_scope_field_names
= true;
485 case PRETTY_DEFAULT_HIDE
:
486 pretty
->options
.print_payload_field_names
= false;
487 pretty
->options
.print_context_field_names
= false;
488 pretty
->options
.print_header_field_names
= false;
489 pretty
->options
.print_scope_field_names
= false;
492 ret
= BT_COMPONENT_STATUS_ERROR
;
498 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
499 if (ret
!= BT_COMPONENT_STATUS_OK
) {
503 pretty
->options
.print_payload_field_names
= value
;
508 ret
= apply_one_bool("name-context", params
, &value
, &found
);
509 if (ret
!= BT_COMPONENT_STATUS_OK
) {
513 pretty
->options
.print_context_field_names
= value
;
518 ret
= apply_one_bool("name-header", params
, &value
, &found
);
519 if (ret
!= BT_COMPONENT_STATUS_OK
) {
523 pretty
->options
.print_header_field_names
= value
;
528 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
529 if (ret
!= BT_COMPONENT_STATUS_OK
) {
533 pretty
->options
.print_scope_field_names
= value
;
537 ret
= apply_one_string("field-default", params
, &str
);
538 if (ret
!= BT_COMPONENT_STATUS_OK
) {
542 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
543 } else if (!strcmp(str
, "show")) {
544 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
545 } else if (!strcmp(str
, "hide")) {
546 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
548 ret
= BT_COMPONENT_STATUS_ERROR
;
554 switch (pretty
->options
.field_default
) {
555 case PRETTY_DEFAULT_UNSET
:
556 pretty
->options
.print_trace_field
= false;
557 pretty
->options
.print_trace_hostname_field
= true;
558 pretty
->options
.print_trace_domain_field
= false;
559 pretty
->options
.print_trace_procname_field
= true;
560 pretty
->options
.print_trace_vpid_field
= true;
561 pretty
->options
.print_loglevel_field
= false;
562 pretty
->options
.print_emf_field
= false;
563 pretty
->options
.print_callsite_field
= false;
565 case PRETTY_DEFAULT_SHOW
:
566 pretty
->options
.print_trace_field
= true;
567 pretty
->options
.print_trace_hostname_field
= true;
568 pretty
->options
.print_trace_domain_field
= true;
569 pretty
->options
.print_trace_procname_field
= true;
570 pretty
->options
.print_trace_vpid_field
= true;
571 pretty
->options
.print_loglevel_field
= true;
572 pretty
->options
.print_emf_field
= true;
573 pretty
->options
.print_callsite_field
= true;
575 case PRETTY_DEFAULT_HIDE
:
576 pretty
->options
.print_trace_field
= false;
577 pretty
->options
.print_trace_hostname_field
= false;
578 pretty
->options
.print_trace_domain_field
= false;
579 pretty
->options
.print_trace_procname_field
= false;
580 pretty
->options
.print_trace_vpid_field
= false;
581 pretty
->options
.print_loglevel_field
= false;
582 pretty
->options
.print_emf_field
= false;
583 pretty
->options
.print_callsite_field
= false;
586 ret
= BT_COMPONENT_STATUS_ERROR
;
592 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
593 if (ret
!= BT_COMPONENT_STATUS_OK
) {
597 pretty
->options
.print_trace_field
= value
;
602 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
603 if (ret
!= BT_COMPONENT_STATUS_OK
) {
607 pretty
->options
.print_trace_hostname_field
= value
;
612 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
613 if (ret
!= BT_COMPONENT_STATUS_OK
) {
617 pretty
->options
.print_trace_domain_field
= value
;
622 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
623 if (ret
!= BT_COMPONENT_STATUS_OK
) {
627 pretty
->options
.print_trace_procname_field
= value
;
632 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
633 if (ret
!= BT_COMPONENT_STATUS_OK
) {
637 pretty
->options
.print_trace_vpid_field
= value
;
642 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
643 if (ret
!= BT_COMPONENT_STATUS_OK
) {
647 pretty
->options
.print_loglevel_field
= value
;
652 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
653 if (ret
!= BT_COMPONENT_STATUS_OK
) {
657 pretty
->options
.print_emf_field
= value
;
662 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
663 if (ret
!= BT_COMPONENT_STATUS_OK
) {
667 pretty
->options
.print_callsite_field
= value
;
671 bt_put(pretty
->plugin_opt_map
);
672 pretty
->plugin_opt_map
= NULL
;
678 void set_use_colors(struct pretty_component
*pretty
)
680 switch (pretty
->options
.color
) {
681 case PRETTY_COLOR_OPT_ALWAYS
:
682 pretty
->use_colors
= true;
684 case PRETTY_COLOR_OPT_AUTO
:
685 pretty
->use_colors
= pretty
->out
== stdout
&&
686 bt_common_colors_supported();
688 case PRETTY_COLOR_OPT_NEVER
:
689 pretty
->use_colors
= false;
695 void init_stream_packet_context_quarks(void)
697 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
698 g_quark_from_string("timestamp_begin");
699 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
700 g_quark_from_string("timestamp_begin");
701 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
702 g_quark_from_string("timestamp_end");
703 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
704 g_quark_from_string("events_discarded");
705 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
706 g_quark_from_string("content_size");
707 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
708 g_quark_from_string("packet_size");
709 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
710 g_quark_from_string("packet_seq_num");
714 enum bt_component_status
pretty_init(
715 struct bt_private_component
*component
,
716 struct bt_value
*params
,
717 UNUSED_VAR
void *init_method_data
)
719 enum bt_component_status ret
;
720 struct pretty_component
*pretty
= create_pretty();
723 ret
= BT_COMPONENT_STATUS_NOMEM
;
727 pretty
->out
= stdout
;
728 pretty
->err
= stderr
;
730 pretty
->delta_cycles
= -1ULL;
731 pretty
->last_cycles_timestamp
= -1ULL;
733 pretty
->delta_real_timestamp
= -1ULL;
734 pretty
->last_real_timestamp
= -1ULL;
736 ret
= apply_params(pretty
, params
);
737 if (ret
!= BT_COMPONENT_STATUS_OK
) {
741 set_use_colors(pretty
);
743 ret
= bt_private_component_set_user_data(component
, pretty
);
744 if (ret
!= BT_COMPONENT_STATUS_OK
) {
748 init_stream_packet_context_quarks();
753 destroy_pretty_data(pretty
);