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 struct bt_notification
*notification
= NULL
;
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
;
188 if (unlikely(pretty
->error
)) {
189 ret
= BT_COMPONENT_STATUS_ERROR
;
193 it
= pretty
->input_iterator
;
194 it_ret
= bt_notification_iterator_next(it
);
197 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
198 ret
= BT_COMPONENT_STATUS_END
;
199 BT_PUT(pretty
->input_iterator
);
201 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
202 ret
= BT_COMPONENT_STATUS_AGAIN
;
204 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
207 ret
= BT_COMPONENT_STATUS_ERROR
;
211 notification
= bt_notification_iterator_get_notification(it
);
212 BT_ASSERT(notification
);
213 ret
= handle_notification(pretty
, notification
);
216 bt_put(notification
);
221 enum bt_component_status
add_params_to_map(struct bt_value
*plugin_opt_map
)
223 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
226 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
227 const char *key
= plugin_options
[i
];
228 enum bt_value_status status
;
230 status
= bt_value_map_insert(plugin_opt_map
, key
, bt_value_null
);
232 case BT_VALUE_STATUS_OK
:
235 ret
= BT_COMPONENT_STATUS_ERROR
;
244 bt_bool
check_param_exists(const char *key
, struct bt_value
*object
, void *data
)
246 struct pretty_component
*pretty
= data
;
247 struct bt_value
*plugin_opt_map
= pretty
->plugin_opt_map
;
249 if (!bt_value_map_get(plugin_opt_map
, key
)) {
251 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
257 enum bt_component_status
apply_one_string(const char *key
,
258 struct bt_value
*params
,
261 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
262 struct bt_value
*value
= NULL
;
263 enum bt_value_status status
;
266 value
= bt_value_map_get(params
, key
);
270 if (bt_value_is_null(value
)) {
273 status
= bt_value_string_get(value
, &str
);
275 case BT_VALUE_STATUS_OK
:
278 ret
= BT_COMPONENT_STATUS_ERROR
;
281 *option
= g_strdup(str
);
288 enum bt_component_status
apply_one_bool(const char *key
,
289 struct bt_value
*params
,
293 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
294 struct bt_value
*value
= NULL
;
295 enum bt_value_status status
;
298 value
= bt_value_map_get(params
, key
);
302 status
= bt_value_bool_get(value
, &bool_val
);
304 case BT_VALUE_STATUS_OK
:
307 ret
= BT_COMPONENT_STATUS_ERROR
;
310 *option
= (bool) bool_val
;
320 void warn_wrong_color_param(struct pretty_component
*pretty
)
323 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
327 enum bt_component_status
open_output_file(struct pretty_component
*pretty
)
329 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
331 if (!pretty
->options
.output_path
) {
335 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
343 ret
= BT_COMPONENT_STATUS_ERROR
;
349 enum bt_component_status
apply_params(struct pretty_component
*pretty
,
350 struct bt_value
*params
)
352 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
353 enum bt_value_status status
;
357 pretty
->plugin_opt_map
= bt_value_map_create();
358 if (!pretty
->plugin_opt_map
) {
359 ret
= BT_COMPONENT_STATUS_ERROR
;
362 ret
= add_params_to_map(pretty
->plugin_opt_map
);
363 if (ret
!= BT_COMPONENT_STATUS_OK
) {
366 /* Report unknown parameters. */
367 status
= bt_value_map_foreach(params
, check_param_exists
, pretty
);
369 case BT_VALUE_STATUS_OK
:
372 ret
= BT_COMPONENT_STATUS_ERROR
;
375 /* Known parameters. */
376 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
377 if (bt_value_map_has_key(params
, "color")) {
378 struct bt_value
*color_value
;
381 color_value
= bt_value_map_get(params
, "color");
386 status
= bt_value_string_get(color_value
, &color
);
388 warn_wrong_color_param(pretty
);
390 if (strcmp(color
, "never") == 0) {
391 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
392 } else if (strcmp(color
, "auto") == 0) {
393 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
394 } else if (strcmp(color
, "always") == 0) {
395 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
397 warn_wrong_color_param(pretty
);
404 ret
= apply_one_string("path", params
, &pretty
->options
.output_path
);
405 if (ret
!= BT_COMPONENT_STATUS_OK
) {
408 ret
= open_output_file(pretty
);
409 if (ret
!= BT_COMPONENT_STATUS_OK
) {
413 value
= false; /* Default. */
414 ret
= apply_one_bool("no-delta", params
, &value
, NULL
);
415 if (ret
!= BT_COMPONENT_STATUS_OK
) {
418 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
420 value
= false; /* Default. */
421 ret
= apply_one_bool("clock-cycles", params
, &value
, NULL
);
422 if (ret
!= BT_COMPONENT_STATUS_OK
) {
425 pretty
->options
.print_timestamp_cycles
= value
;
427 value
= false; /* Default. */
428 ret
= apply_one_bool("clock-seconds", params
, &value
, NULL
);
429 if (ret
!= BT_COMPONENT_STATUS_OK
) {
432 pretty
->options
.clock_seconds
= value
;
434 value
= false; /* Default. */
435 ret
= apply_one_bool("clock-date", params
, &value
, NULL
);
436 if (ret
!= BT_COMPONENT_STATUS_OK
) {
439 pretty
->options
.clock_date
= value
;
441 value
= false; /* Default. */
442 ret
= apply_one_bool("clock-gmt", params
, &value
, NULL
);
443 if (ret
!= BT_COMPONENT_STATUS_OK
) {
446 pretty
->options
.clock_gmt
= value
;
448 value
= false; /* Default. */
449 ret
= apply_one_bool("verbose", params
, &value
, NULL
);
450 if (ret
!= BT_COMPONENT_STATUS_OK
) {
453 pretty
->options
.verbose
= value
;
456 ret
= apply_one_string("name-default", params
, &str
);
457 if (ret
!= BT_COMPONENT_STATUS_OK
) {
461 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
462 } else if (!strcmp(str
, "show")) {
463 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
464 } else if (!strcmp(str
, "hide")) {
465 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
467 ret
= BT_COMPONENT_STATUS_ERROR
;
473 switch (pretty
->options
.name_default
) {
474 case PRETTY_DEFAULT_UNSET
:
475 pretty
->options
.print_payload_field_names
= true;
476 pretty
->options
.print_context_field_names
= true;
477 pretty
->options
.print_header_field_names
= false;
478 pretty
->options
.print_scope_field_names
= false;
480 case PRETTY_DEFAULT_SHOW
:
481 pretty
->options
.print_payload_field_names
= true;
482 pretty
->options
.print_context_field_names
= true;
483 pretty
->options
.print_header_field_names
= true;
484 pretty
->options
.print_scope_field_names
= true;
486 case PRETTY_DEFAULT_HIDE
:
487 pretty
->options
.print_payload_field_names
= false;
488 pretty
->options
.print_context_field_names
= false;
489 pretty
->options
.print_header_field_names
= false;
490 pretty
->options
.print_scope_field_names
= false;
493 ret
= BT_COMPONENT_STATUS_ERROR
;
499 ret
= apply_one_bool("name-payload", params
, &value
, &found
);
500 if (ret
!= BT_COMPONENT_STATUS_OK
) {
504 pretty
->options
.print_payload_field_names
= value
;
509 ret
= apply_one_bool("name-context", params
, &value
, &found
);
510 if (ret
!= BT_COMPONENT_STATUS_OK
) {
514 pretty
->options
.print_context_field_names
= value
;
519 ret
= apply_one_bool("name-header", params
, &value
, &found
);
520 if (ret
!= BT_COMPONENT_STATUS_OK
) {
524 pretty
->options
.print_header_field_names
= value
;
529 ret
= apply_one_bool("name-scope", params
, &value
, &found
);
530 if (ret
!= BT_COMPONENT_STATUS_OK
) {
534 pretty
->options
.print_scope_field_names
= value
;
538 ret
= apply_one_string("field-default", params
, &str
);
539 if (ret
!= BT_COMPONENT_STATUS_OK
) {
543 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
544 } else if (!strcmp(str
, "show")) {
545 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
546 } else if (!strcmp(str
, "hide")) {
547 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
549 ret
= BT_COMPONENT_STATUS_ERROR
;
555 switch (pretty
->options
.field_default
) {
556 case PRETTY_DEFAULT_UNSET
:
557 pretty
->options
.print_trace_field
= false;
558 pretty
->options
.print_trace_hostname_field
= true;
559 pretty
->options
.print_trace_domain_field
= false;
560 pretty
->options
.print_trace_procname_field
= true;
561 pretty
->options
.print_trace_vpid_field
= true;
562 pretty
->options
.print_loglevel_field
= false;
563 pretty
->options
.print_emf_field
= false;
564 pretty
->options
.print_callsite_field
= false;
566 case PRETTY_DEFAULT_SHOW
:
567 pretty
->options
.print_trace_field
= true;
568 pretty
->options
.print_trace_hostname_field
= true;
569 pretty
->options
.print_trace_domain_field
= true;
570 pretty
->options
.print_trace_procname_field
= true;
571 pretty
->options
.print_trace_vpid_field
= true;
572 pretty
->options
.print_loglevel_field
= true;
573 pretty
->options
.print_emf_field
= true;
574 pretty
->options
.print_callsite_field
= true;
576 case PRETTY_DEFAULT_HIDE
:
577 pretty
->options
.print_trace_field
= false;
578 pretty
->options
.print_trace_hostname_field
= false;
579 pretty
->options
.print_trace_domain_field
= false;
580 pretty
->options
.print_trace_procname_field
= false;
581 pretty
->options
.print_trace_vpid_field
= false;
582 pretty
->options
.print_loglevel_field
= false;
583 pretty
->options
.print_emf_field
= false;
584 pretty
->options
.print_callsite_field
= false;
587 ret
= BT_COMPONENT_STATUS_ERROR
;
593 ret
= apply_one_bool("field-trace", params
, &value
, &found
);
594 if (ret
!= BT_COMPONENT_STATUS_OK
) {
598 pretty
->options
.print_trace_field
= value
;
603 ret
= apply_one_bool("field-trace:hostname", params
, &value
, &found
);
604 if (ret
!= BT_COMPONENT_STATUS_OK
) {
608 pretty
->options
.print_trace_hostname_field
= value
;
613 ret
= apply_one_bool("field-trace:domain", params
, &value
, &found
);
614 if (ret
!= BT_COMPONENT_STATUS_OK
) {
618 pretty
->options
.print_trace_domain_field
= value
;
623 ret
= apply_one_bool("field-trace:procname", params
, &value
, &found
);
624 if (ret
!= BT_COMPONENT_STATUS_OK
) {
628 pretty
->options
.print_trace_procname_field
= value
;
633 ret
= apply_one_bool("field-trace:vpid", params
, &value
, &found
);
634 if (ret
!= BT_COMPONENT_STATUS_OK
) {
638 pretty
->options
.print_trace_vpid_field
= value
;
643 ret
= apply_one_bool("field-loglevel", params
, &value
, &found
);
644 if (ret
!= BT_COMPONENT_STATUS_OK
) {
648 pretty
->options
.print_loglevel_field
= value
;
653 ret
= apply_one_bool("field-emf", params
, &value
, &found
);
654 if (ret
!= BT_COMPONENT_STATUS_OK
) {
658 pretty
->options
.print_emf_field
= value
;
663 ret
= apply_one_bool("field-callsite", params
, &value
, &found
);
664 if (ret
!= BT_COMPONENT_STATUS_OK
) {
668 pretty
->options
.print_callsite_field
= value
;
672 bt_put(pretty
->plugin_opt_map
);
673 pretty
->plugin_opt_map
= NULL
;
679 void set_use_colors(struct pretty_component
*pretty
)
681 switch (pretty
->options
.color
) {
682 case PRETTY_COLOR_OPT_ALWAYS
:
683 pretty
->use_colors
= true;
685 case PRETTY_COLOR_OPT_AUTO
:
686 pretty
->use_colors
= pretty
->out
== stdout
&&
687 bt_common_colors_supported();
689 case PRETTY_COLOR_OPT_NEVER
:
690 pretty
->use_colors
= false;
696 void init_stream_packet_context_quarks(void)
698 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
699 g_quark_from_string("timestamp_begin");
700 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
701 g_quark_from_string("timestamp_begin");
702 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
703 g_quark_from_string("timestamp_end");
704 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
705 g_quark_from_string("events_discarded");
706 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
707 g_quark_from_string("content_size");
708 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
709 g_quark_from_string("packet_size");
710 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
711 g_quark_from_string("packet_seq_num");
715 enum bt_component_status
pretty_init(
716 struct bt_private_component
*component
,
717 struct bt_value
*params
,
718 UNUSED_VAR
void *init_method_data
)
720 enum bt_component_status ret
;
721 struct pretty_component
*pretty
= create_pretty();
724 ret
= BT_COMPONENT_STATUS_NOMEM
;
728 ret
= bt_private_component_sink_add_input_private_port(component
,
730 if (ret
!= BT_COMPONENT_STATUS_OK
) {
734 pretty
->out
= stdout
;
735 pretty
->err
= stderr
;
737 pretty
->delta_cycles
= -1ULL;
738 pretty
->last_cycles_timestamp
= -1ULL;
740 pretty
->delta_real_timestamp
= -1ULL;
741 pretty
->last_real_timestamp
= -1ULL;
743 ret
= apply_params(pretty
, params
);
744 if (ret
!= BT_COMPONENT_STATUS_OK
) {
748 set_use_colors(pretty
);
749 ret
= bt_private_component_set_user_data(component
, pretty
);
750 if (ret
!= BT_COMPONENT_STATUS_OK
) {
754 init_stream_packet_context_quarks();
759 destroy_pretty_data(pretty
);