2 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #include <babeltrace/babeltrace.h>
27 #include <babeltrace/compiler-internal.h>
28 #include <babeltrace/common-internal.h>
29 #include <plugins-common.h>
33 #include <babeltrace/assert-internal.h>
37 GQuark stream_packet_context_quarks
[STREAM_PACKET_CONTEXT_QUARKS_LEN
];
40 const char *plugin_options
[] = {
49 "name-default", /* show/hide */
54 "field-default", /* show/hide */
56 "field-trace:hostname",
58 "field-trace:procname",
66 void destroy_pretty_data(struct pretty_component
*pretty
)
68 bt_self_component_port_input_notification_iterator_put_ref(pretty
->iterator
);
71 (void) g_string_free(pretty
->string
, TRUE
);
74 if (pretty
->tmp_string
) {
75 (void) g_string_free(pretty
->tmp_string
, TRUE
);
78 if (pretty
->out
!= stdout
) {
81 ret
= fclose(pretty
->out
);
83 perror("close output file");
86 g_free(pretty
->options
.output_path
);
91 struct pretty_component
*create_pretty(void)
93 struct pretty_component
*pretty
;
95 pretty
= g_new0(struct pretty_component
, 1);
99 pretty
->string
= g_string_new("");
100 if (!pretty
->string
) {
103 pretty
->tmp_string
= g_string_new("");
104 if (!pretty
->tmp_string
) {
116 void pretty_finalize(struct bt_self_component_sink
*comp
)
119 bt_self_component_get_data(
120 bt_self_component_sink_as_self_component(comp
)));
124 enum bt_self_component_status
handle_notification(
125 struct pretty_component
*pretty
,
126 const struct bt_notification
*notification
)
128 enum bt_self_component_status ret
= BT_SELF_COMPONENT_STATUS_OK
;
132 switch (bt_notification_get_type(notification
)) {
133 case BT_NOTIFICATION_TYPE_PACKET_BEGINNING
:
134 if (pretty_print_packet(pretty
, notification
)) {
135 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
138 case BT_NOTIFICATION_TYPE_EVENT
:
139 if (pretty_print_event(pretty
, notification
)) {
140 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
143 case BT_NOTIFICATION_TYPE_INACTIVITY
:
144 fprintf(stderr
, "Inactivity notification\n");
154 enum bt_self_component_status
pretty_port_connected(
155 struct bt_self_component_sink
*comp
,
156 struct bt_self_component_port_input
*self_port
,
157 const struct bt_port_output
*other_port
)
159 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
160 struct pretty_component
*pretty
;
162 pretty
= bt_self_component_get_data(
163 bt_self_component_sink_as_self_component(comp
));
165 BT_ASSERT(!pretty
->iterator
);
166 pretty
->iterator
= bt_self_component_port_input_notification_iterator_create(
168 if (!pretty
->iterator
) {
169 status
= BT_SELF_COMPONENT_STATUS_NOMEM
;
176 enum bt_self_component_status
pretty_consume(
177 struct bt_self_component_sink
*comp
)
179 enum bt_self_component_status ret
;
180 bt_notification_array_const notifs
;
181 struct bt_self_component_port_input_notification_iterator
*it
;
182 struct pretty_component
*pretty
= bt_self_component_get_data(
183 bt_self_component_sink_as_self_component(comp
));
184 enum bt_notification_iterator_status it_ret
;
188 it
= pretty
->iterator
;
189 it_ret
= bt_self_component_port_input_notification_iterator_next(it
,
193 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
195 case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
:
196 ret
= BT_SELF_COMPONENT_STATUS_NOMEM
;
198 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
199 ret
= BT_SELF_COMPONENT_STATUS_AGAIN
;
201 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
202 ret
= BT_SELF_COMPONENT_STATUS_END
;
203 BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_PUT_REF_AND_RESET(
207 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
211 BT_ASSERT(it_ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
);
213 for (i
= 0; i
< count
; i
++) {
214 ret
= handle_notification(pretty
, notifs
[i
]);
219 bt_notification_put_ref(notifs
[i
]);
223 for (; i
< count
; i
++) {
224 bt_notification_put_ref(notifs
[i
]);
231 int add_params_to_map(struct bt_value
*plugin_opt_map
)
236 for (i
= 0; i
< BT_ARRAY_SIZE(plugin_options
); i
++) {
237 const char *key
= plugin_options
[i
];
238 enum bt_value_status status
;
240 status
= bt_value_map_insert_entry(plugin_opt_map
, key
,
243 case BT_VALUE_STATUS_OK
:
255 bt_bool
check_param_exists(const char *key
, const struct bt_value
*object
,
258 struct pretty_component
*pretty
= data
;
260 if (!bt_value_map_has_entry(pretty
->plugin_opt_map
,
263 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key
);
269 void apply_one_string(const char *key
, const struct bt_value
*params
, char **option
)
271 const struct bt_value
*value
= NULL
;
274 value
= bt_value_map_borrow_entry_value_const(params
, key
);
278 if (bt_value_is_null(value
)) {
281 str
= bt_value_string_get(value
);
282 *option
= g_strdup(str
);
289 void apply_one_bool(const char *key
, const struct bt_value
*params
, bool *option
,
292 const struct bt_value
*value
= NULL
;
295 value
= bt_value_map_borrow_entry_value_const(params
, key
);
299 bool_val
= bt_value_bool_get(value
);
300 *option
= (bool) bool_val
;
310 void warn_wrong_color_param(struct pretty_component
*pretty
)
313 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
317 int open_output_file(struct pretty_component
*pretty
)
321 if (!pretty
->options
.output_path
) {
325 pretty
->out
= fopen(pretty
->options
.output_path
, "w");
340 int apply_params(struct pretty_component
*pretty
, const struct bt_value
*params
)
343 enum bt_value_status status
;
347 pretty
->plugin_opt_map
= bt_value_map_create();
348 if (!pretty
->plugin_opt_map
) {
352 ret
= add_params_to_map(pretty
->plugin_opt_map
);
356 /* Report unknown parameters. */
357 status
= bt_value_map_foreach_entry_const(params
,
358 check_param_exists
, pretty
);
360 case BT_VALUE_STATUS_OK
:
366 /* Known parameters. */
367 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
368 if (bt_value_map_has_entry(params
, "color")) {
369 const struct bt_value
*color_value
;
372 color_value
= bt_value_map_borrow_entry_value_const(params
,
378 color
= bt_value_string_get(color_value
);
380 if (strcmp(color
, "never") == 0) {
381 pretty
->options
.color
= PRETTY_COLOR_OPT_NEVER
;
382 } else if (strcmp(color
, "auto") == 0) {
383 pretty
->options
.color
= PRETTY_COLOR_OPT_AUTO
;
384 } else if (strcmp(color
, "always") == 0) {
385 pretty
->options
.color
= PRETTY_COLOR_OPT_ALWAYS
;
387 warn_wrong_color_param(pretty
);
391 apply_one_string("path", params
, &pretty
->options
.output_path
);
392 ret
= open_output_file(pretty
);
397 value
= false; /* Default. */
398 apply_one_bool("no-delta", params
, &value
, NULL
);
399 pretty
->options
.print_delta_field
= !value
; /* Reverse logic. */
401 value
= false; /* Default. */
402 apply_one_bool("clock-cycles", params
, &value
, NULL
);
403 pretty
->options
.print_timestamp_cycles
= value
;
405 value
= false; /* Default. */
406 apply_one_bool("clock-seconds", params
, &value
, NULL
);
407 pretty
->options
.clock_seconds
= value
;
409 value
= false; /* Default. */
410 apply_one_bool("clock-date", params
, &value
, NULL
);
411 pretty
->options
.clock_date
= value
;
413 value
= false; /* Default. */
414 apply_one_bool("clock-gmt", params
, &value
, NULL
);
415 pretty
->options
.clock_gmt
= value
;
417 value
= false; /* Default. */
418 apply_one_bool("verbose", params
, &value
, NULL
);
419 pretty
->options
.verbose
= value
;
422 apply_one_string("name-default", params
, &str
);
424 pretty
->options
.name_default
= PRETTY_DEFAULT_UNSET
;
425 } else if (!strcmp(str
, "show")) {
426 pretty
->options
.name_default
= PRETTY_DEFAULT_SHOW
;
427 } else if (!strcmp(str
, "hide")) {
428 pretty
->options
.name_default
= PRETTY_DEFAULT_HIDE
;
436 switch (pretty
->options
.name_default
) {
437 case PRETTY_DEFAULT_UNSET
:
438 pretty
->options
.print_payload_field_names
= true;
439 pretty
->options
.print_context_field_names
= true;
440 pretty
->options
.print_header_field_names
= false;
441 pretty
->options
.print_scope_field_names
= false;
443 case PRETTY_DEFAULT_SHOW
:
444 pretty
->options
.print_payload_field_names
= true;
445 pretty
->options
.print_context_field_names
= true;
446 pretty
->options
.print_header_field_names
= true;
447 pretty
->options
.print_scope_field_names
= true;
449 case PRETTY_DEFAULT_HIDE
:
450 pretty
->options
.print_payload_field_names
= false;
451 pretty
->options
.print_context_field_names
= false;
452 pretty
->options
.print_header_field_names
= false;
453 pretty
->options
.print_scope_field_names
= false;
462 apply_one_bool("name-payload", params
, &value
, &found
);
464 pretty
->options
.print_payload_field_names
= value
;
469 apply_one_bool("name-context", params
, &value
, &found
);
471 pretty
->options
.print_context_field_names
= value
;
476 apply_one_bool("name-header", params
, &value
, &found
);
478 pretty
->options
.print_header_field_names
= value
;
483 apply_one_bool("name-scope", params
, &value
, &found
);
485 pretty
->options
.print_scope_field_names
= value
;
489 apply_one_string("field-default", params
, &str
);
491 pretty
->options
.field_default
= PRETTY_DEFAULT_UNSET
;
492 } else if (!strcmp(str
, "show")) {
493 pretty
->options
.field_default
= PRETTY_DEFAULT_SHOW
;
494 } else if (!strcmp(str
, "hide")) {
495 pretty
->options
.field_default
= PRETTY_DEFAULT_HIDE
;
503 switch (pretty
->options
.field_default
) {
504 case PRETTY_DEFAULT_UNSET
:
505 pretty
->options
.print_trace_field
= false;
506 pretty
->options
.print_trace_hostname_field
= true;
507 pretty
->options
.print_trace_domain_field
= false;
508 pretty
->options
.print_trace_procname_field
= true;
509 pretty
->options
.print_trace_vpid_field
= true;
510 pretty
->options
.print_loglevel_field
= false;
511 pretty
->options
.print_emf_field
= false;
512 pretty
->options
.print_callsite_field
= false;
514 case PRETTY_DEFAULT_SHOW
:
515 pretty
->options
.print_trace_field
= true;
516 pretty
->options
.print_trace_hostname_field
= true;
517 pretty
->options
.print_trace_domain_field
= true;
518 pretty
->options
.print_trace_procname_field
= true;
519 pretty
->options
.print_trace_vpid_field
= true;
520 pretty
->options
.print_loglevel_field
= true;
521 pretty
->options
.print_emf_field
= true;
522 pretty
->options
.print_callsite_field
= true;
524 case PRETTY_DEFAULT_HIDE
:
525 pretty
->options
.print_trace_field
= false;
526 pretty
->options
.print_trace_hostname_field
= false;
527 pretty
->options
.print_trace_domain_field
= false;
528 pretty
->options
.print_trace_procname_field
= false;
529 pretty
->options
.print_trace_vpid_field
= false;
530 pretty
->options
.print_loglevel_field
= false;
531 pretty
->options
.print_emf_field
= false;
532 pretty
->options
.print_callsite_field
= false;
541 apply_one_bool("field-trace", params
, &value
, &found
);
543 pretty
->options
.print_trace_field
= value
;
548 apply_one_bool("field-trace:hostname", params
, &value
, &found
);
550 pretty
->options
.print_trace_hostname_field
= value
;
555 apply_one_bool("field-trace:domain", params
, &value
, &found
);
557 pretty
->options
.print_trace_domain_field
= value
;
562 apply_one_bool("field-trace:procname", params
, &value
, &found
);
564 pretty
->options
.print_trace_procname_field
= value
;
569 apply_one_bool("field-trace:vpid", params
, &value
, &found
);
571 pretty
->options
.print_trace_vpid_field
= value
;
576 apply_one_bool("field-loglevel", params
, &value
, &found
);
578 pretty
->options
.print_loglevel_field
= value
;
583 apply_one_bool("field-emf", params
, &value
, &found
);
585 pretty
->options
.print_emf_field
= value
;
590 apply_one_bool("field-callsite", params
, &value
, &found
);
592 pretty
->options
.print_callsite_field
= value
;
596 bt_value_put_ref(pretty
->plugin_opt_map
);
597 pretty
->plugin_opt_map
= NULL
;
603 void set_use_colors(struct pretty_component
*pretty
)
605 switch (pretty
->options
.color
) {
606 case PRETTY_COLOR_OPT_ALWAYS
:
607 pretty
->use_colors
= true;
609 case PRETTY_COLOR_OPT_AUTO
:
610 pretty
->use_colors
= pretty
->out
== stdout
&&
611 bt_common_colors_supported();
613 case PRETTY_COLOR_OPT_NEVER
:
614 pretty
->use_colors
= false;
620 void init_stream_packet_context_quarks(void)
622 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
623 g_quark_from_string("timestamp_begin");
624 stream_packet_context_quarks
[Q_TIMESTAMP_BEGIN
] =
625 g_quark_from_string("timestamp_begin");
626 stream_packet_context_quarks
[Q_TIMESTAMP_END
] =
627 g_quark_from_string("timestamp_end");
628 stream_packet_context_quarks
[Q_EVENTS_DISCARDED
] =
629 g_quark_from_string("events_discarded");
630 stream_packet_context_quarks
[Q_CONTENT_SIZE
] =
631 g_quark_from_string("content_size");
632 stream_packet_context_quarks
[Q_PACKET_SIZE
] =
633 g_quark_from_string("packet_size");
634 stream_packet_context_quarks
[Q_PACKET_SEQ_NUM
] =
635 g_quark_from_string("packet_seq_num");
639 enum bt_self_component_status
pretty_init(
640 struct bt_self_component_sink
*comp
,
641 const struct bt_value
*params
,
642 UNUSED_VAR
void *init_method_data
)
644 enum bt_self_component_status ret
;
645 struct pretty_component
*pretty
= create_pretty();
648 ret
= BT_SELF_COMPONENT_STATUS_NOMEM
;
652 ret
= bt_self_component_sink_add_input_port(comp
, "in", NULL
, NULL
);
653 if (ret
!= BT_SELF_COMPONENT_STATUS_OK
) {
657 pretty
->out
= stdout
;
658 pretty
->err
= stderr
;
660 pretty
->delta_cycles
= -1ULL;
661 pretty
->last_cycles_timestamp
= -1ULL;
663 pretty
->delta_real_timestamp
= -1ULL;
664 pretty
->last_real_timestamp
= -1ULL;
666 if (apply_params(pretty
, params
)) {
667 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
671 set_use_colors(pretty
);
672 bt_self_component_set_data(
673 bt_self_component_sink_as_self_component(comp
), pretty
);
674 init_stream_packet_context_quarks();
680 destroy_pretty_data(pretty
);