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 <babeltrace2/babeltrace.h>
27 #include "compat/bitfield.h"
28 #include "common/common.h"
29 #include "compat/time.h"
30 #include "common/assert.h"
36 #define NSEC_PER_SEC 1000000000LL
38 #define COLOR_NAME BT_COMMON_COLOR_BOLD
39 #define COLOR_FIELD_NAME BT_COMMON_COLOR_FG_CYAN
40 #define COLOR_RST BT_COMMON_COLOR_RESET
41 #define COLOR_STRING_VALUE BT_COMMON_COLOR_BOLD
42 #define COLOR_NUMBER_VALUE BT_COMMON_COLOR_BOLD
43 #define COLOR_ENUM_MAPPING_NAME BT_COMMON_COLOR_BOLD
44 #define COLOR_UNKNOWN BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_RED
45 #define COLOR_EVENT_NAME BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_MAGENTA
46 #define COLOR_TIMESTAMP BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_YELLOW
49 int64_t real_timestamp
; /* Relative to UNIX epoch. */
50 uint64_t clock_snapshot
; /* In cycles. */
54 int print_field(struct pretty_component
*pretty
,
55 const bt_field
*field
, bool print_names
,
56 GQuark
*filters_fields
, int filter_array_len
);
59 void print_name_equal(struct pretty_component
*pretty
, const char *name
)
61 if (pretty
->use_colors
) {
62 g_string_append_printf(pretty
->string
, "%s%s%s = ", COLOR_NAME
,
65 g_string_append_printf(pretty
->string
, "%s = ", name
);
70 void print_field_name_equal(struct pretty_component
*pretty
, const char *name
)
72 if (pretty
->use_colors
) {
73 g_string_append_printf(pretty
->string
, "%s%s%s = ",
74 COLOR_FIELD_NAME
, name
, COLOR_RST
);
76 g_string_append_printf(pretty
->string
, "%s = ", name
);
81 void print_timestamp_cycles(struct pretty_component
*pretty
,
82 const bt_clock_snapshot
*clock_snapshot
, bool update_last
)
86 cycles
= bt_clock_snapshot_get_value(clock_snapshot
);
87 g_string_append_printf(pretty
->string
, "%020" PRIu64
, cycles
);
90 if (pretty
->last_cycles_timestamp
!= -1ULL) {
91 pretty
->delta_cycles
= cycles
- pretty
->last_cycles_timestamp
;
94 pretty
->last_cycles_timestamp
= cycles
;
99 void print_timestamp_wall(struct pretty_component
*pretty
,
100 const bt_clock_snapshot
*clock_snapshot
, bool update_last
)
103 int64_t ts_nsec
= 0; /* add configurable offset */
104 int64_t ts_sec
= 0; /* add configurable offset */
105 uint64_t ts_sec_abs
, ts_nsec_abs
;
108 if (!clock_snapshot
) {
109 g_string_append(pretty
->string
, "??:??:??.?????????");
113 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, &ts_nsec
);
115 // TODO: log, this is unexpected
116 g_string_append(pretty
->string
, "Error");
121 if (pretty
->last_real_timestamp
!= -1ULL) {
122 pretty
->delta_real_timestamp
= ts_nsec
- pretty
->last_real_timestamp
;
125 pretty
->last_real_timestamp
= ts_nsec
;
128 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
129 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
131 if (ts_sec
>= 0 && ts_nsec
>= 0) {
134 ts_nsec_abs
= ts_nsec
;
135 } else if (ts_sec
> 0 && ts_nsec
< 0) {
137 ts_sec_abs
= ts_sec
- 1;
138 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
139 } else if (ts_sec
== 0 && ts_nsec
< 0) {
142 ts_nsec_abs
= -ts_nsec
;
143 } else if (ts_sec
< 0 && ts_nsec
> 0) {
145 ts_sec_abs
= -(ts_sec
+ 1);
146 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
147 } else if (ts_sec
< 0 && ts_nsec
== 0) {
149 ts_sec_abs
= -ts_sec
;
150 ts_nsec_abs
= ts_nsec
;
151 } else { /* (ts_sec < 0 && ts_nsec < 0) */
153 ts_sec_abs
= -ts_sec
;
154 ts_nsec_abs
= -ts_nsec
;
157 if (!pretty
->options
.clock_seconds
) {
159 time_t time_s
= (time_t) ts_sec_abs
;
161 if (is_negative
&& !pretty
->negative_timestamp_warning_done
) {
163 fprintf(stderr
, "[warning] Fallback to [sec.ns] to print negative time value. Use --clock-seconds.\n");
164 pretty
->negative_timestamp_warning_done
= true;
168 if (!pretty
->options
.clock_gmt
) {
171 res
= bt_localtime_r(&time_s
, &tm
);
174 fprintf(stderr
, "[warning] Unable to get localtime.\n");
180 res
= bt_gmtime_r(&time_s
, &tm
);
183 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
187 if (pretty
->options
.clock_date
) {
191 /* Print date and time */
192 res
= strftime(timestr
, sizeof(timestr
),
196 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
200 g_string_append(pretty
->string
, timestr
);
203 /* Print time in HH:MM:SS.ns */
204 g_string_append_printf(pretty
->string
,
205 "%02d:%02d:%02d.%09" PRIu64
, tm
.tm_hour
, tm
.tm_min
,
206 tm
.tm_sec
, ts_nsec_abs
);
210 g_string_append_printf(pretty
->string
, "%s%" PRId64
".%09" PRIu64
,
211 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
217 int print_event_timestamp(struct pretty_component
*pretty
,
218 const bt_message
*event_msg
, bool *start_line
)
220 bool print_names
= pretty
->options
.print_header_field_names
;
222 const bt_clock_snapshot
*clock_snapshot
= NULL
;
224 if (!bt_message_event_borrow_stream_class_default_clock_class_const(
226 /* No default clock class: skip the timestamp without an error */
230 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(event_msg
);
233 print_name_equal(pretty
, "timestamp");
235 g_string_append(pretty
->string
, "[");
237 if (pretty
->use_colors
) {
238 g_string_append(pretty
->string
, COLOR_TIMESTAMP
);
240 if (pretty
->options
.print_timestamp_cycles
) {
241 print_timestamp_cycles(pretty
, clock_snapshot
, true);
243 print_timestamp_wall(pretty
, clock_snapshot
, true);
245 if (pretty
->use_colors
) {
246 g_string_append(pretty
->string
, COLOR_RST
);
250 g_string_append(pretty
->string
, "] ");
252 if (pretty
->options
.print_delta_field
) {
254 g_string_append(pretty
->string
, ", ");
255 print_name_equal(pretty
, "delta");
257 g_string_append(pretty
->string
, "(");
259 if (pretty
->options
.print_timestamp_cycles
) {
260 if (pretty
->delta_cycles
== -1ULL) {
261 g_string_append(pretty
->string
,
262 "+??????????\?\?"); /* Not a trigraph. */
264 g_string_append_printf(pretty
->string
,
265 "+%012" PRIu64
, pretty
->delta_cycles
);
268 if (pretty
->delta_real_timestamp
!= -1ULL) {
269 uint64_t delta_sec
, delta_nsec
, delta
;
271 delta
= pretty
->delta_real_timestamp
;
272 delta_sec
= delta
/ NSEC_PER_SEC
;
273 delta_nsec
= delta
% NSEC_PER_SEC
;
274 g_string_append_printf(pretty
->string
,
275 "+%" PRIu64
".%09" PRIu64
,
276 delta_sec
, delta_nsec
);
278 g_string_append(pretty
->string
, "+?.?????????");
282 g_string_append(pretty
->string
, ") ");
285 *start_line
= !print_names
;
292 int print_event_header(struct pretty_component
*pretty
,
293 const bt_message
*event_msg
)
295 bool print_names
= pretty
->options
.print_header_field_names
;
297 const bt_event_class
*event_class
= NULL
;
298 const bt_packet
*packet
= NULL
;
299 const bt_stream
*stream
= NULL
;
300 const bt_trace
*trace
= NULL
;
301 const bt_event
*event
= bt_message_event_borrow_event_const(event_msg
);
304 bt_property_availability prop_avail
;
306 event_class
= bt_event_borrow_class_const(event
);
307 packet
= bt_event_borrow_packet_const(event
);
308 stream
= bt_packet_borrow_stream_const(packet
);
309 trace
= bt_stream_borrow_trace_const(stream
);
310 ret
= print_event_timestamp(pretty
, event_msg
, &pretty
->start_line
);
314 if (pretty
->options
.print_trace_field
) {
317 name
= bt_trace_get_name(trace
);
319 if (!pretty
->start_line
) {
320 g_string_append(pretty
->string
, ", ");
323 print_name_equal(pretty
, "trace");
326 g_string_append(pretty
->string
, name
);
329 g_string_append(pretty
->string
, ", ");
333 if (pretty
->options
.print_trace_hostname_field
) {
334 const bt_value
*hostname_str
;
336 hostname_str
= bt_trace_borrow_environment_entry_value_by_name_const(
341 if (!pretty
->start_line
) {
342 g_string_append(pretty
->string
, ", ");
345 print_name_equal(pretty
, "trace:hostname");
347 str
= bt_value_string_get(hostname_str
);
348 g_string_append(pretty
->string
, str
);
352 if (pretty
->options
.print_trace_domain_field
) {
353 const bt_value
*domain_str
;
355 domain_str
= bt_trace_borrow_environment_entry_value_by_name_const(
360 if (!pretty
->start_line
) {
361 g_string_append(pretty
->string
, ", ");
364 print_name_equal(pretty
, "trace:domain");
365 } else if (dom_print
) {
366 g_string_append(pretty
->string
, ":");
368 str
= bt_value_string_get(domain_str
);
369 g_string_append(pretty
->string
, str
);
373 if (pretty
->options
.print_trace_procname_field
) {
374 const bt_value
*procname_str
;
376 procname_str
= bt_trace_borrow_environment_entry_value_by_name_const(
381 if (!pretty
->start_line
) {
382 g_string_append(pretty
->string
, ", ");
385 print_name_equal(pretty
, "trace:procname");
386 } else if (dom_print
) {
387 g_string_append(pretty
->string
, ":");
389 str
= bt_value_string_get(procname_str
);
390 g_string_append(pretty
->string
, str
);
394 if (pretty
->options
.print_trace_vpid_field
) {
395 const bt_value
*vpid_value
;
397 vpid_value
= bt_trace_borrow_environment_entry_value_by_name_const(
402 if (!pretty
->start_line
) {
403 g_string_append(pretty
->string
, ", ");
406 print_name_equal(pretty
, "trace:vpid");
407 } else if (dom_print
) {
408 g_string_append(pretty
->string
, ":");
410 value
= bt_value_signed_integer_get(vpid_value
);
411 g_string_append_printf(pretty
->string
,
412 "(%" PRId64
")", value
);
416 if (pretty
->options
.print_loglevel_field
) {
417 static const char *log_level_names
[] = {
418 [ BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY
] = "TRACE_EMERG",
419 [ BT_EVENT_CLASS_LOG_LEVEL_ALERT
] = "TRACE_ALERT",
420 [ BT_EVENT_CLASS_LOG_LEVEL_CRITICAL
] = "TRACE_CRIT",
421 [ BT_EVENT_CLASS_LOG_LEVEL_ERROR
] = "TRACE_ERR",
422 [ BT_EVENT_CLASS_LOG_LEVEL_WARNING
] = "TRACE_WARNING",
423 [ BT_EVENT_CLASS_LOG_LEVEL_NOTICE
] = "TRACE_NOTICE",
424 [ BT_EVENT_CLASS_LOG_LEVEL_INFO
] = "TRACE_INFO",
425 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
] = "TRACE_DEBUG_SYSTEM",
426 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
] = "TRACE_DEBUG_PROGRAM",
427 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
] = "TRACE_DEBUG_PROCESS",
428 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
] = "TRACE_DEBUG_MODULE",
429 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
] = "TRACE_DEBUG_UNIT",
430 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
] = "TRACE_DEBUG_FUNCTION",
431 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
] = "TRACE_DEBUG_LINE",
432 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG
] = "TRACE_DEBUG",
434 bt_event_class_log_level log_level
;
435 const char *log_level_str
= NULL
;
437 prop_avail
= bt_event_class_get_log_level(event_class
,
439 if (prop_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
440 log_level_str
= log_level_names
[log_level
];
441 BT_ASSERT(log_level_str
);
443 if (!pretty
->start_line
) {
444 g_string_append(pretty
->string
, ", ");
447 print_name_equal(pretty
, "loglevel");
448 } else if (dom_print
) {
449 g_string_append(pretty
->string
, ":");
452 g_string_append(pretty
->string
, log_level_str
);
453 g_string_append_printf(
454 pretty
->string
, " (%d)", (int) log_level
);
458 if (pretty
->options
.print_emf_field
) {
461 uri_str
= bt_event_class_get_emf_uri(event_class
);
463 if (!pretty
->start_line
) {
464 g_string_append(pretty
->string
, ", ");
467 print_name_equal(pretty
, "model.emf.uri");
468 } else if (dom_print
) {
469 g_string_append(pretty
->string
, ":");
472 g_string_append(pretty
->string
, uri_str
);
476 if (dom_print
&& !print_names
) {
477 g_string_append(pretty
->string
, " ");
479 if (!pretty
->start_line
) {
480 g_string_append(pretty
->string
, ", ");
482 pretty
->start_line
= true;
484 print_name_equal(pretty
, "name");
486 ev_name
= bt_event_class_get_name(event_class
);
487 if (pretty
->use_colors
) {
489 g_string_append(pretty
->string
, COLOR_EVENT_NAME
);
491 g_string_append(pretty
->string
, COLOR_UNKNOWN
);
495 g_string_append(pretty
->string
, ev_name
);
497 g_string_append(pretty
->string
, "<unknown>");
499 if (pretty
->use_colors
) {
500 g_string_append(pretty
->string
, COLOR_RST
);
503 g_string_append(pretty
->string
, ": ");
505 g_string_append(pretty
->string
, ", ");
513 int print_integer(struct pretty_component
*pretty
,
514 const bt_field
*field
)
517 bt_field_class_integer_preferred_display_base base
;
518 const bt_field_class
*int_fc
;
523 bool rst_color
= false;
524 bt_field_class_type ft_type
;
526 int_fc
= bt_field_borrow_class_const(field
);
528 ft_type
= bt_field_get_class_type(field
);
529 if (ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
530 ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
) {
531 v
.u
= bt_field_unsigned_integer_get_value(field
);
533 v
.s
= bt_field_signed_integer_get_value(field
);
536 if (pretty
->use_colors
) {
537 g_string_append(pretty
->string
, COLOR_NUMBER_VALUE
);
541 base
= bt_field_class_integer_get_preferred_display_base(int_fc
);
543 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
:
547 len
= bt_field_class_integer_get_field_value_range(int_fc
);
548 g_string_append(pretty
->string
, "0b");
549 _bt_safe_lshift(v
.u
, 64 - len
);
550 for (bitnr
= 0; bitnr
< len
; bitnr
++) {
551 g_string_append_printf(pretty
->string
, "%u", (v
.u
& (1ULL << 63)) ? 1 : 0);
552 _bt_safe_lshift(v
.u
, 1);
556 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
:
558 if (ft_type
== BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
559 ft_type
== BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
562 len
= bt_field_class_integer_get_field_value_range(
568 /* Round length to the nearest 3-bit */
569 rounded_len
= (((len
- 1) / 3) + 1) * 3;
570 v
.u
&= ((uint64_t) 1 << rounded_len
) - 1;
574 g_string_append_printf(pretty
->string
, "0%" PRIo64
, v
.u
);
577 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
:
578 if (ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
579 ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
) {
580 g_string_append_printf(pretty
->string
, "%" PRIu64
, v
.u
);
582 g_string_append_printf(pretty
->string
, "%" PRId64
, v
.s
);
585 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
:
589 len
= bt_field_class_integer_get_field_value_range(int_fc
);
591 /* Round length to the nearest nibble */
592 uint8_t rounded_len
= ((len
+ 3) & ~0x3);
594 v
.u
&= ((uint64_t) 1 << rounded_len
) - 1;
597 g_string_append_printf(pretty
->string
, "0x%" PRIX64
, v
.u
);
606 g_string_append(pretty
->string
, COLOR_RST
);
612 void print_escape_string(struct pretty_component
*pretty
, const char *str
)
616 g_string_append_c(pretty
->string
, '"');
618 for (i
= 0; i
< strlen(str
); i
++) {
619 /* Escape sequences not recognized by iscntrl(). */
622 g_string_append(pretty
->string
, "\\\\");
625 g_string_append(pretty
->string
, "\\\'");
628 g_string_append(pretty
->string
, "\\\"");
631 g_string_append(pretty
->string
, "\\\?");
635 /* Standard characters. */
636 if (!iscntrl(str
[i
])) {
637 g_string_append_c(pretty
->string
, str
[i
]);
643 g_string_append(pretty
->string
, "\\0");
646 g_string_append(pretty
->string
, "\\a");
649 g_string_append(pretty
->string
, "\\b");
652 g_string_append(pretty
->string
, "\\e");
655 g_string_append(pretty
->string
, "\\f");
658 g_string_append(pretty
->string
, "\\n");
661 g_string_append(pretty
->string
, "\\r");
664 g_string_append(pretty
->string
, "\\t");
667 g_string_append(pretty
->string
, "\\v");
670 /* Unhandled control-sequence, print as hex. */
671 g_string_append_printf(pretty
->string
, "\\x%02x", str
[i
]);
676 g_string_append_c(pretty
->string
, '"');
680 int print_enum(struct pretty_component
*pretty
,
681 const bt_field
*field
)
684 const bt_field_class
*enumeration_field_class
= NULL
;
685 bt_field_class_enumeration_mapping_label_array label_array
;
686 uint64_t label_count
;
689 enumeration_field_class
= bt_field_borrow_class_const(field
);
690 if (!enumeration_field_class
) {
695 switch (bt_field_get_class_type(field
)) {
696 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
697 ret
= bt_field_unsigned_enumeration_get_mapping_labels(field
,
698 &label_array
, &label_count
);
700 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
701 ret
= bt_field_signed_enumeration_get_mapping_labels(field
,
702 &label_array
, &label_count
);
713 g_string_append(pretty
->string
, "( ");
714 if (label_count
== 0) {
715 if (pretty
->use_colors
) {
716 g_string_append(pretty
->string
, COLOR_UNKNOWN
);
718 g_string_append(pretty
->string
, "<unknown>");
719 if (pretty
->use_colors
) {
720 g_string_append(pretty
->string
, COLOR_RST
);
724 for (i
= 0; i
< label_count
; i
++) {
725 const char *mapping_name
= label_array
[i
];
728 g_string_append(pretty
->string
, ", ");
730 if (pretty
->use_colors
) {
731 g_string_append(pretty
->string
, COLOR_ENUM_MAPPING_NAME
);
733 print_escape_string(pretty
, mapping_name
);
734 if (pretty
->use_colors
) {
735 g_string_append(pretty
->string
, COLOR_RST
);
739 g_string_append(pretty
->string
, " : container = ");
740 ret
= print_integer(pretty
, field
);
744 g_string_append(pretty
->string
, " )");
750 int filter_field_name(struct pretty_component
*pretty
, const char *field_name
,
751 GQuark
*filter_fields
, int filter_array_len
)
754 GQuark field_quark
= g_quark_try_string(field_name
);
756 if (!field_quark
|| pretty
->options
.verbose
) {
760 for (i
= 0; i
< filter_array_len
; i
++) {
761 if (field_quark
== filter_fields
[i
]) {
769 int print_struct_field(struct pretty_component
*pretty
,
770 const bt_field
*_struct
,
771 const bt_field_class
*struct_class
,
772 uint64_t i
, bool print_names
, uint64_t *nr_printed_fields
,
773 GQuark
*filter_fields
, int filter_array_len
)
776 const char *field_name
;
777 const bt_field
*field
= NULL
;
778 const bt_field_class_structure_member
*member
;
780 field
= bt_field_structure_borrow_member_field_by_index_const(_struct
, i
);
786 member
= bt_field_class_structure_borrow_member_by_index_const(
788 field_name
= bt_field_class_structure_member_get_name(member
);
790 if (filter_fields
&& !filter_field_name(pretty
, field_name
,
791 filter_fields
, filter_array_len
)) {
796 if (*nr_printed_fields
> 0) {
797 g_string_append(pretty
->string
, ", ");
799 g_string_append(pretty
->string
, " ");
802 print_field_name_equal(pretty
, field_name
);
804 ret
= print_field(pretty
, field
, print_names
, NULL
, 0);
805 *nr_printed_fields
+= 1;
812 int print_struct(struct pretty_component
*pretty
,
813 const bt_field
*_struct
, bool print_names
,
814 GQuark
*filter_fields
, int filter_array_len
)
817 const bt_field_class
*struct_class
= NULL
;
818 uint64_t nr_fields
, i
, nr_printed_fields
;
820 struct_class
= bt_field_borrow_class_const(_struct
);
826 nr_fields
= bt_field_class_structure_get_member_count(struct_class
);
828 g_string_append(pretty
->string
, "{");
830 nr_printed_fields
= 0;
831 for (i
= 0; i
< nr_fields
; i
++) {
832 ret
= print_struct_field(pretty
, _struct
, struct_class
, i
,
833 print_names
, &nr_printed_fields
, filter_fields
,
840 g_string_append(pretty
->string
, " }");
847 int print_array_field(struct pretty_component
*pretty
,
848 const bt_field
*array
, uint64_t i
, bool print_names
)
850 const bt_field
*field
= NULL
;
853 g_string_append(pretty
->string
, ", ");
855 g_string_append(pretty
->string
, " ");
858 g_string_append_printf(pretty
->string
, "[%" PRIu64
"] = ", i
);
861 field
= bt_field_array_borrow_element_field_by_index_const(array
, i
);
863 return print_field(pretty
, field
, print_names
, NULL
, 0);
867 int print_array(struct pretty_component
*pretty
,
868 const bt_field
*array
, bool print_names
)
871 const bt_field_class
*array_class
= NULL
;
875 array_class
= bt_field_borrow_class_const(array
);
880 len
= bt_field_array_get_length(array
);
881 g_string_append(pretty
->string
, "[");
883 for (i
= 0; i
< len
; i
++) {
884 ret
= print_array_field(pretty
, array
, i
, print_names
);
890 g_string_append(pretty
->string
, " ]");
897 int print_sequence_field(struct pretty_component
*pretty
,
898 const bt_field
*seq
, uint64_t i
, bool print_names
)
900 const bt_field
*field
= NULL
;
903 g_string_append(pretty
->string
, ", ");
905 g_string_append(pretty
->string
, " ");
908 g_string_append_printf(pretty
->string
, "[%" PRIu64
"] = ", i
);
911 field
= bt_field_array_borrow_element_field_by_index_const(seq
, i
);
913 return print_field(pretty
, field
, print_names
, NULL
, 0);
917 int print_sequence(struct pretty_component
*pretty
,
918 const bt_field
*seq
, bool print_names
)
924 len
= bt_field_array_get_length(seq
);
925 g_string_append(pretty
->string
, "[");
928 for (i
= 0; i
< len
; i
++) {
929 ret
= print_sequence_field(pretty
, seq
, i
, print_names
);
935 g_string_append(pretty
->string
, " ]");
942 int print_variant(struct pretty_component
*pretty
,
943 const bt_field
*variant
, bool print_names
)
946 const bt_field
*field
= NULL
;
948 field
= bt_field_variant_borrow_selected_option_field_const(variant
);
950 g_string_append(pretty
->string
, "{ ");
953 // TODO: find tag's name using field path
954 // print_field_name_equal(pretty, tag_choice);
956 ret
= print_field(pretty
, field
, print_names
, NULL
, 0);
961 g_string_append(pretty
->string
, " }");
968 int print_field(struct pretty_component
*pretty
,
969 const bt_field
*field
, bool print_names
,
970 GQuark
*filter_fields
, int filter_array_len
)
972 bt_field_class_type class_id
;
974 class_id
= bt_field_get_class_type(field
);
976 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
977 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
978 return print_integer(pretty
, field
);
979 case BT_FIELD_CLASS_TYPE_REAL
:
983 v
= bt_field_real_get_value(field
);
984 if (pretty
->use_colors
) {
985 g_string_append(pretty
->string
, COLOR_NUMBER_VALUE
);
987 g_string_append_printf(pretty
->string
, "%g", v
);
988 if (pretty
->use_colors
) {
989 g_string_append(pretty
->string
, COLOR_RST
);
993 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
994 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
995 return print_enum(pretty
, field
);
996 case BT_FIELD_CLASS_TYPE_STRING
:
1000 str
= bt_field_string_get_value(field
);
1005 if (pretty
->use_colors
) {
1006 g_string_append(pretty
->string
, COLOR_STRING_VALUE
);
1008 print_escape_string(pretty
, str
);
1009 if (pretty
->use_colors
) {
1010 g_string_append(pretty
->string
, COLOR_RST
);
1014 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1015 return print_struct(pretty
, field
, print_names
, filter_fields
,
1017 case BT_FIELD_CLASS_TYPE_VARIANT
:
1018 return print_variant(pretty
, field
, print_names
);
1019 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1020 return print_array(pretty
, field
, print_names
);
1021 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1022 return print_sequence(pretty
, field
, print_names
);
1024 // TODO: log instead
1025 fprintf(pretty
->err
, "[error] Unknown type id: %d\n", (int) class_id
);
1031 int print_stream_packet_context(struct pretty_component
*pretty
,
1032 const bt_event
*event
)
1035 const bt_packet
*packet
= NULL
;
1036 const bt_field
*main_field
= NULL
;
1038 packet
= bt_event_borrow_packet_const(event
);
1043 main_field
= bt_packet_borrow_context_field_const(packet
);
1047 if (!pretty
->start_line
) {
1048 g_string_append(pretty
->string
, ", ");
1050 pretty
->start_line
= false;
1051 if (pretty
->options
.print_scope_field_names
) {
1052 print_name_equal(pretty
, "stream.packet.context");
1054 ret
= print_field(pretty
, main_field
,
1055 pretty
->options
.print_context_field_names
,
1056 stream_packet_context_quarks
,
1057 STREAM_PACKET_CONTEXT_QUARKS_LEN
);
1064 int print_stream_event_context(struct pretty_component
*pretty
,
1065 const bt_event
*event
)
1068 const bt_field
*main_field
= NULL
;
1070 main_field
= bt_event_borrow_common_context_field_const(event
);
1074 if (!pretty
->start_line
) {
1075 g_string_append(pretty
->string
, ", ");
1077 pretty
->start_line
= false;
1078 if (pretty
->options
.print_scope_field_names
) {
1079 print_name_equal(pretty
, "stream.event.context");
1081 ret
= print_field(pretty
, main_field
,
1082 pretty
->options
.print_context_field_names
, NULL
, 0);
1089 int print_event_context(struct pretty_component
*pretty
,
1090 const bt_event
*event
)
1093 const bt_field
*main_field
= NULL
;
1095 main_field
= bt_event_borrow_specific_context_field_const(event
);
1099 if (!pretty
->start_line
) {
1100 g_string_append(pretty
->string
, ", ");
1102 pretty
->start_line
= false;
1103 if (pretty
->options
.print_scope_field_names
) {
1104 print_name_equal(pretty
, "event.context");
1106 ret
= print_field(pretty
, main_field
,
1107 pretty
->options
.print_context_field_names
, NULL
, 0);
1114 int print_event_payload(struct pretty_component
*pretty
,
1115 const bt_event
*event
)
1118 const bt_field
*main_field
= NULL
;
1120 main_field
= bt_event_borrow_payload_field_const(event
);
1124 if (!pretty
->start_line
) {
1125 g_string_append(pretty
->string
, ", ");
1127 pretty
->start_line
= false;
1128 if (pretty
->options
.print_scope_field_names
) {
1129 print_name_equal(pretty
, "event.fields");
1131 ret
= print_field(pretty
, main_field
,
1132 pretty
->options
.print_payload_field_names
, NULL
, 0);
1139 int flush_buf(FILE *stream
, struct pretty_component
*pretty
)
1143 if (pretty
->string
->len
== 0) {
1147 if (fwrite(pretty
->string
->str
, pretty
->string
->len
, 1, stream
) != 1) {
1156 int pretty_print_event(struct pretty_component
*pretty
,
1157 const bt_message
*event_msg
)
1160 const bt_event
*event
=
1161 bt_message_event_borrow_event_const(event_msg
);
1164 pretty
->start_line
= true;
1165 g_string_assign(pretty
->string
, "");
1166 ret
= print_event_header(pretty
, event_msg
);
1171 ret
= print_stream_packet_context(pretty
, event
);
1176 ret
= print_stream_event_context(pretty
, event
);
1181 ret
= print_event_context(pretty
, event
);
1186 ret
= print_event_payload(pretty
, event
);
1191 g_string_append_c(pretty
->string
, '\n');
1192 if (flush_buf(pretty
->out
, pretty
)) {
1202 int print_discarded_elements_msg(struct pretty_component
*pretty
,
1203 const bt_stream
*stream
,
1204 const bt_clock_snapshot
*begin_clock_snapshot
,
1205 const bt_clock_snapshot
*end_clock_snapshot
,
1206 uint64_t count
, const char *elem_type
)
1209 const bt_stream_class
*stream_class
= NULL
;
1210 const bt_trace
*trace
= NULL
;
1211 const char *stream_name
;
1212 const char *trace_name
;
1214 int64_t stream_class_id
;
1216 const char *init_msg
;
1219 stream_name
= bt_stream_get_name(stream
);
1221 stream_name
= "(unknown)";
1224 /* Stream class ID */
1225 stream_class
= bt_stream_borrow_class_const(stream
);
1226 BT_ASSERT(stream_class
);
1227 stream_class_id
= bt_stream_class_get_id(stream_class
);
1230 stream_id
= bt_stream_get_id(stream
);
1233 trace
= bt_stream_borrow_trace_const(stream
);
1235 trace_name
= bt_trace_get_name(trace
);
1237 trace_name
= "(unknown)";
1241 trace_uuid
= bt_trace_get_uuid(trace
);
1243 /* Format message */
1244 g_string_assign(pretty
->string
, "");
1246 if (count
== UINT64_C(-1)) {
1247 init_msg
= "Tracer may have discarded";
1249 init_msg
= "Tracer discarded";
1252 g_string_append_printf(pretty
->string
,
1253 "%s%sWARNING%s%s: %s ",
1254 bt_common_color_fg_yellow(),
1255 bt_common_color_bold(),
1256 bt_common_color_reset(),
1257 bt_common_color_fg_yellow(), init_msg
);
1259 if (count
== UINT64_C(-1)) {
1260 g_string_append_printf(pretty
->string
, "%ss", elem_type
);
1262 g_string_append_printf(pretty
->string
,
1263 "%" PRIu64
" %s%s", count
, elem_type
,
1264 count
== 1 ? "" : "s");
1267 g_string_append_c(pretty
->string
, ' ');
1269 if (begin_clock_snapshot
&& end_clock_snapshot
) {
1270 g_string_append(pretty
->string
, "between [");
1271 print_timestamp_wall(pretty
, begin_clock_snapshot
, false);
1272 g_string_append(pretty
->string
, "] and [");
1273 print_timestamp_wall(pretty
, end_clock_snapshot
, false);
1274 g_string_append(pretty
->string
, "]");
1276 g_string_append(pretty
->string
, "(unknown time range)");
1279 g_string_append_printf(pretty
->string
, " in trace \"%s\" ", trace_name
);
1282 g_string_append_printf(pretty
->string
,
1283 "(UUID: %02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x) ",
1301 g_string_append(pretty
->string
, "(no UUID) ");
1304 g_string_append_printf(pretty
->string
,
1305 "within stream \"%s\" (stream class ID: %" PRIu64
", ",
1306 stream_name
, stream_class_id
);
1308 if (stream_id
>= 0) {
1309 g_string_append_printf(pretty
->string
,
1310 "stream ID: %" PRIu64
, stream_id
);
1312 g_string_append(pretty
->string
, "no stream ID");
1315 g_string_append_printf(pretty
->string
, ").%s\n",
1316 bt_common_color_reset());
1319 * Print to standard error stream to remain backward compatible
1320 * with Babeltrace 1.
1322 if (flush_buf(stderr
, pretty
)) {
1330 int pretty_print_discarded_items(struct pretty_component
*pretty
,
1331 const bt_message
*msg
)
1333 const bt_clock_snapshot
*begin
= NULL
;
1334 const bt_clock_snapshot
*end
= NULL
;
1335 const bt_stream
*stream
;
1336 const bt_stream_class
*stream_class
;
1337 uint64_t count
= UINT64_C(-1);
1338 const char *elem_type
;
1340 switch (bt_message_get_type(msg
)) {
1341 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1342 stream
= bt_message_discarded_events_borrow_stream_const(msg
);
1344 if (bt_message_discarded_events_get_count(msg
, &count
) ==
1345 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1346 count
= UINT64_C(-1);
1349 elem_type
= "event";
1351 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1352 stream
= bt_message_discarded_packets_borrow_stream_const(msg
);
1354 if (bt_message_discarded_packets_get_count(msg
, &count
) ==
1355 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1356 count
= UINT64_C(-1);
1359 elem_type
= "packet";
1366 stream_class
= bt_stream_borrow_class_const(stream
);
1368 switch (bt_message_get_type(msg
)) {
1369 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1370 if (bt_stream_class_discarded_events_have_default_clock_snapshots(
1372 begin
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1374 end
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1379 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1380 if (bt_stream_class_discarded_packets_have_default_clock_snapshots(
1382 begin
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1384 end
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1393 print_discarded_elements_msg(pretty
, stream
, begin
, end
,