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/bitfield-internal.h>
28 #include <babeltrace/common-internal.h>
29 #include <babeltrace/compat/time-internal.h>
30 #include <babeltrace/assert-internal.h>
35 #define NSEC_PER_SEC 1000000000LL
37 #define COLOR_NAME BT_COMMON_COLOR_BOLD
38 #define COLOR_FIELD_NAME BT_COMMON_COLOR_FG_CYAN
39 #define COLOR_RST BT_COMMON_COLOR_RESET
40 #define COLOR_STRING_VALUE BT_COMMON_COLOR_BOLD
41 #define COLOR_NUMBER_VALUE BT_COMMON_COLOR_BOLD
42 #define COLOR_ENUM_MAPPING_NAME BT_COMMON_COLOR_BOLD
43 #define COLOR_UNKNOWN BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_RED
44 #define COLOR_EVENT_NAME BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_MAGENTA
45 #define COLOR_TIMESTAMP BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_YELLOW
48 int64_t real_timestamp
; /* Relative to UNIX epoch. */
49 uint64_t clock_value
; /* In cycles. */
53 int print_field(struct pretty_component
*pretty
,
54 struct bt_field
*field
, bool print_names
,
55 GQuark
*filters_fields
, int filter_array_len
);
58 void print_name_equal(struct pretty_component
*pretty
, const char *name
)
60 if (pretty
->use_colors
) {
61 g_string_append_printf(pretty
->string
, "%s%s%s = ", COLOR_NAME
,
64 g_string_append_printf(pretty
->string
, "%s = ", name
);
69 void print_field_name_equal(struct pretty_component
*pretty
, const char *name
)
71 if (pretty
->use_colors
) {
72 g_string_append_printf(pretty
->string
, "%s%s%s = ",
73 COLOR_FIELD_NAME
, name
, COLOR_RST
);
75 g_string_append_printf(pretty
->string
, "%s = ", name
);
80 void print_timestamp_cycles(struct pretty_component
*pretty
,
81 struct bt_event
*event
)
83 struct bt_clock_value
*clock_value
;
85 enum bt_clock_value_status cv_status
;
87 cv_status
= bt_event_borrow_default_clock_value(event
, &clock_value
);
88 if (cv_status
!= BT_CLOCK_VALUE_STATUS_KNOWN
|| !clock_value
) {
89 g_string_append(pretty
->string
, "????????????????????");
93 cycles
= bt_clock_value_get_value(clock_value
);
94 g_string_append_printf(pretty
->string
, "%020" PRIu64
, cycles
);
96 if (pretty
->last_cycles_timestamp
!= -1ULL) {
97 pretty
->delta_cycles
= cycles
- pretty
->last_cycles_timestamp
;
99 pretty
->last_cycles_timestamp
= cycles
;
103 void print_timestamp_wall(struct pretty_component
*pretty
,
104 struct bt_clock_value
*clock_value
)
107 int64_t ts_nsec
= 0; /* add configurable offset */
108 int64_t ts_sec
= 0; /* add configurable offset */
109 uint64_t ts_sec_abs
, ts_nsec_abs
;
113 g_string_append(pretty
->string
, "??:??:??.?????????");
117 ret
= bt_clock_value_get_ns_from_origin(clock_value
, &ts_nsec
);
119 // TODO: log, this is unexpected
120 g_string_append(pretty
->string
, "Error");
124 if (pretty
->last_real_timestamp
!= -1ULL) {
125 pretty
->delta_real_timestamp
= ts_nsec
- pretty
->last_real_timestamp
;
128 pretty
->last_real_timestamp
= ts_nsec
;
129 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
130 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
132 if (ts_sec
>= 0 && ts_nsec
>= 0) {
135 ts_nsec_abs
= ts_nsec
;
136 } else if (ts_sec
> 0 && ts_nsec
< 0) {
138 ts_sec_abs
= ts_sec
- 1;
139 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
140 } else if (ts_sec
== 0 && ts_nsec
< 0) {
143 ts_nsec_abs
= -ts_nsec
;
144 } else if (ts_sec
< 0 && ts_nsec
> 0) {
146 ts_sec_abs
= -(ts_sec
+ 1);
147 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
148 } else if (ts_sec
< 0 && ts_nsec
== 0) {
150 ts_sec_abs
= -ts_sec
;
151 ts_nsec_abs
= ts_nsec
;
152 } else { /* (ts_sec < 0 && ts_nsec < 0) */
154 ts_sec_abs
= -ts_sec
;
155 ts_nsec_abs
= -ts_nsec
;
158 if (!pretty
->options
.clock_seconds
) {
160 time_t time_s
= (time_t) ts_sec_abs
;
162 if (is_negative
&& !pretty
->negative_timestamp_warning_done
) {
164 fprintf(stderr
, "[warning] Fallback to [sec.ns] to print negative time value. Use --clock-seconds.\n");
165 pretty
->negative_timestamp_warning_done
= true;
169 if (!pretty
->options
.clock_gmt
) {
172 res
= bt_localtime_r(&time_s
, &tm
);
175 fprintf(stderr
, "[warning] Unable to get localtime.\n");
181 res
= bt_gmtime_r(&time_s
, &tm
);
184 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
188 if (pretty
->options
.clock_date
) {
192 /* Print date and time */
193 res
= strftime(timestr
, sizeof(timestr
),
197 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
201 g_string_append(pretty
->string
, timestr
);
204 /* Print time in HH:MM:SS.ns */
205 g_string_append_printf(pretty
->string
,
206 "%02d:%02d:%02d.%09" PRIu64
, tm
.tm_hour
, tm
.tm_min
,
207 tm
.tm_sec
, ts_nsec_abs
);
211 g_string_append_printf(pretty
->string
, "%s%" PRId64
".%09" PRIu64
,
212 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
218 int print_event_timestamp(struct pretty_component
*pretty
,
219 struct bt_event
*event
, bool *start_line
)
221 bool print_names
= pretty
->options
.print_header_field_names
;
223 struct bt_stream
*stream
= NULL
;
224 struct bt_stream_class
*stream_class
= NULL
;
225 struct bt_trace
*trace
= NULL
;
226 struct bt_clock_value
*clock_value
= NULL
;
227 enum bt_clock_value_status cv_status
;
229 stream
= bt_event_borrow_stream(event
);
235 stream_class
= bt_stream_borrow_class(stream
);
240 trace
= bt_stream_class_borrow_trace(stream_class
);
246 cv_status
= bt_event_borrow_default_clock_value(event
, &clock_value
);
247 if (cv_status
!= BT_CLOCK_VALUE_STATUS_KNOWN
|| !clock_value
) {
248 /* No default clock value: skip the timestamp without an error */
253 print_name_equal(pretty
, "timestamp");
255 g_string_append(pretty
->string
, "[");
257 if (pretty
->use_colors
) {
258 g_string_append(pretty
->string
, COLOR_TIMESTAMP
);
260 if (pretty
->options
.print_timestamp_cycles
) {
261 print_timestamp_cycles(pretty
, event
);
264 cv_status
= bt_event_borrow_default_clock_value(event
,
266 print_timestamp_wall(pretty
, clock_value
);
268 if (pretty
->use_colors
) {
269 g_string_append(pretty
->string
, COLOR_RST
);
273 g_string_append(pretty
->string
, "] ");
275 if (pretty
->options
.print_delta_field
) {
277 g_string_append(pretty
->string
, ", ");
278 print_name_equal(pretty
, "delta");
280 g_string_append(pretty
->string
, "(");
282 if (pretty
->options
.print_timestamp_cycles
) {
283 if (pretty
->delta_cycles
== -1ULL) {
284 g_string_append(pretty
->string
,
285 "+??????????\?\?) "); /* Not a trigraph. */
287 g_string_append_printf(pretty
->string
,
288 "+%012" PRIu64
, pretty
->delta_cycles
);
291 if (pretty
->delta_real_timestamp
!= -1ULL) {
292 uint64_t delta_sec
, delta_nsec
, delta
;
294 delta
= pretty
->delta_real_timestamp
;
295 delta_sec
= delta
/ NSEC_PER_SEC
;
296 delta_nsec
= delta
% NSEC_PER_SEC
;
297 g_string_append_printf(pretty
->string
,
298 "+%" PRIu64
".%09" PRIu64
,
299 delta_sec
, delta_nsec
);
301 g_string_append(pretty
->string
, "+?.?????????");
305 g_string_append(pretty
->string
, ") ");
308 *start_line
= !print_names
;
315 int print_event_header(struct pretty_component
*pretty
,
316 struct bt_event
*event
)
318 bool print_names
= pretty
->options
.print_header_field_names
;
320 struct bt_event_class
*event_class
= NULL
;
321 struct bt_stream_class
*stream_class
= NULL
;
322 struct bt_trace
*trace_class
= NULL
;
324 enum bt_property_availability prop_avail
;
326 event_class
= bt_event_borrow_class(event
);
331 stream_class
= bt_event_class_borrow_stream_class(event_class
);
336 trace_class
= bt_stream_class_borrow_trace(stream_class
);
341 ret
= print_event_timestamp(pretty
, event
, &pretty
->start_line
);
345 if (pretty
->options
.print_trace_field
) {
348 name
= bt_trace_get_name(trace_class
);
350 if (!pretty
->start_line
) {
351 g_string_append(pretty
->string
, ", ");
354 print_name_equal(pretty
, "trace");
357 g_string_append(pretty
->string
, name
);
360 g_string_append(pretty
->string
, " ");
364 if (pretty
->options
.print_trace_hostname_field
) {
365 const struct bt_value
*hostname_str
;
367 hostname_str
= bt_trace_borrow_environment_entry_value_by_name(
368 trace_class
, "hostname");
372 if (!pretty
->start_line
) {
373 g_string_append(pretty
->string
, ", ");
376 print_name_equal(pretty
, "trace:hostname");
378 str
= bt_value_string_get(hostname_str
);
379 g_string_append(pretty
->string
, str
);
383 if (pretty
->options
.print_trace_domain_field
) {
384 const struct bt_value
*domain_str
;
386 domain_str
= bt_trace_borrow_environment_entry_value_by_name(
387 trace_class
, "domain");
391 if (!pretty
->start_line
) {
392 g_string_append(pretty
->string
, ", ");
395 print_name_equal(pretty
, "trace:domain");
396 } else if (dom_print
) {
397 g_string_append(pretty
->string
, ":");
399 str
= bt_value_string_get(domain_str
);
400 g_string_append(pretty
->string
, str
);
404 if (pretty
->options
.print_trace_procname_field
) {
405 const struct bt_value
*procname_str
;
407 procname_str
= bt_trace_borrow_environment_entry_value_by_name(
408 trace_class
, "procname");
412 if (!pretty
->start_line
) {
413 g_string_append(pretty
->string
, ", ");
416 print_name_equal(pretty
, "trace:procname");
417 } else if (dom_print
) {
418 g_string_append(pretty
->string
, ":");
420 str
= bt_value_string_get(procname_str
);
421 g_string_append(pretty
->string
, str
);
425 if (pretty
->options
.print_trace_vpid_field
) {
426 const struct bt_value
*vpid_value
;
428 vpid_value
= bt_trace_borrow_environment_entry_value_by_name(
429 trace_class
, "vpid");
433 if (!pretty
->start_line
) {
434 g_string_append(pretty
->string
, ", ");
437 print_name_equal(pretty
, "trace:vpid");
438 } else if (dom_print
) {
439 g_string_append(pretty
->string
, ":");
441 value
= bt_value_integer_get(vpid_value
);
442 g_string_append_printf(pretty
->string
,
443 "(%" PRId64
")", value
);
447 if (pretty
->options
.print_loglevel_field
) {
448 static const char *log_level_names
[] = {
449 [ BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY
] = "TRACE_EMERG",
450 [ BT_EVENT_CLASS_LOG_LEVEL_ALERT
] = "TRACE_ALERT",
451 [ BT_EVENT_CLASS_LOG_LEVEL_CRITICAL
] = "TRACE_CRIT",
452 [ BT_EVENT_CLASS_LOG_LEVEL_ERROR
] = "TRACE_ERR",
453 [ BT_EVENT_CLASS_LOG_LEVEL_WARNING
] = "TRACE_WARNING",
454 [ BT_EVENT_CLASS_LOG_LEVEL_NOTICE
] = "TRACE_NOTICE",
455 [ BT_EVENT_CLASS_LOG_LEVEL_INFO
] = "TRACE_INFO",
456 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
] = "TRACE_DEBUG_SYSTEM",
457 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
] = "TRACE_DEBUG_PROGRAM",
458 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
] = "TRACE_DEBUG_PROCESS",
459 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
] = "TRACE_DEBUG_MODULE",
460 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
] = "TRACE_DEBUG_UNIT",
461 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
] = "TRACE_DEBUG_FUNCTION",
462 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
] = "TRACE_DEBUG_LINE",
463 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG
] = "TRACE_DEBUG",
465 enum bt_event_class_log_level log_level
;
466 const char *log_level_str
= NULL
;
468 prop_avail
= bt_event_class_get_log_level(event_class
,
470 if (prop_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
471 log_level_str
= log_level_names
[log_level
];
472 BT_ASSERT(log_level_str
);
474 if (!pretty
->start_line
) {
475 g_string_append(pretty
->string
, ", ");
478 print_name_equal(pretty
, "loglevel");
479 } else if (dom_print
) {
480 g_string_append(pretty
->string
, ":");
483 g_string_append(pretty
->string
, log_level_str
);
484 g_string_append_printf(
485 pretty
->string
, " (%d)", (int) log_level
);
489 if (pretty
->options
.print_emf_field
) {
492 uri_str
= bt_event_class_get_emf_uri(event_class
);
494 if (!pretty
->start_line
) {
495 g_string_append(pretty
->string
, ", ");
498 print_name_equal(pretty
, "model.emf.uri");
499 } else if (dom_print
) {
500 g_string_append(pretty
->string
, ":");
503 g_string_append(pretty
->string
, uri_str
);
507 if (dom_print
&& !print_names
) {
508 g_string_append(pretty
->string
, " ");
510 if (!pretty
->start_line
) {
511 g_string_append(pretty
->string
, ", ");
513 pretty
->start_line
= true;
515 print_name_equal(pretty
, "name");
517 if (pretty
->use_colors
) {
518 g_string_append(pretty
->string
, COLOR_EVENT_NAME
);
520 g_string_append(pretty
->string
, bt_event_class_get_name(event_class
));
521 if (pretty
->use_colors
) {
522 g_string_append(pretty
->string
, COLOR_RST
);
525 g_string_append(pretty
->string
, ": ");
527 g_string_append(pretty
->string
, ", ");
535 int print_integer(struct pretty_component
*pretty
,
536 struct bt_field
*field
)
539 enum bt_field_class_integer_preferred_display_base base
;
540 struct bt_field_class
*int_fc
;
545 bool rst_color
= false;
546 enum bt_field_class_type ft_type
;
548 int_fc
= bt_field_borrow_class(field
);
550 ft_type
= bt_field_get_class_type(field
);
551 if (ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
552 ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
) {
553 v
.u
= bt_field_unsigned_integer_get_value(field
);
555 v
.s
= bt_field_signed_integer_get_value(field
);
558 if (pretty
->use_colors
) {
559 g_string_append(pretty
->string
, COLOR_NUMBER_VALUE
);
563 base
= bt_field_class_integer_get_preferred_display_base(int_fc
);
565 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
:
569 len
= bt_field_class_integer_get_field_value_range(int_fc
);
570 g_string_append(pretty
->string
, "0b");
571 v
.u
= _bt_piecewise_lshift(v
.u
, 64 - len
);
572 for (bitnr
= 0; bitnr
< len
; bitnr
++) {
573 g_string_append_printf(pretty
->string
, "%u", (v
.u
& (1ULL << 63)) ? 1 : 0);
574 v
.u
= _bt_piecewise_lshift(v
.u
, 1);
578 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
:
580 if (ft_type
== BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
581 ft_type
== BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
584 len
= bt_field_class_integer_get_field_value_range(
590 /* Round length to the nearest 3-bit */
591 rounded_len
= (((len
- 1) / 3) + 1) * 3;
592 v
.u
&= ((uint64_t) 1 << rounded_len
) - 1;
596 g_string_append_printf(pretty
->string
, "0%" PRIo64
, v
.u
);
599 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
:
600 if (ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
601 ft_type
== BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
) {
602 g_string_append_printf(pretty
->string
, "%" PRIu64
, v
.u
);
604 g_string_append_printf(pretty
->string
, "%" PRId64
, v
.s
);
607 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
:
611 len
= bt_field_class_integer_get_field_value_range(int_fc
);
613 /* Round length to the nearest nibble */
614 uint8_t rounded_len
= ((len
+ 3) & ~0x3);
616 v
.u
&= ((uint64_t) 1 << rounded_len
) - 1;
619 g_string_append_printf(pretty
->string
, "0x%" PRIX64
, v
.u
);
628 g_string_append(pretty
->string
, COLOR_RST
);
634 void print_escape_string(struct pretty_component
*pretty
, const char *str
)
638 g_string_append_c(pretty
->string
, '"');
640 for (i
= 0; i
< strlen(str
); i
++) {
641 /* Escape sequences not recognized by iscntrl(). */
644 g_string_append(pretty
->string
, "\\\\");
647 g_string_append(pretty
->string
, "\\\'");
650 g_string_append(pretty
->string
, "\\\"");
653 g_string_append(pretty
->string
, "\\\?");
657 /* Standard characters. */
658 if (!iscntrl(str
[i
])) {
659 g_string_append_c(pretty
->string
, str
[i
]);
665 g_string_append(pretty
->string
, "\\0");
668 g_string_append(pretty
->string
, "\\a");
671 g_string_append(pretty
->string
, "\\b");
674 g_string_append(pretty
->string
, "\\e");
677 g_string_append(pretty
->string
, "\\f");
680 g_string_append(pretty
->string
, "\\n");
683 g_string_append(pretty
->string
, "\\r");
686 g_string_append(pretty
->string
, "\\t");
689 g_string_append(pretty
->string
, "\\v");
692 /* Unhandled control-sequence, print as hex. */
693 g_string_append_printf(pretty
->string
, "\\x%02x", str
[i
]);
698 g_string_append_c(pretty
->string
, '"');
702 int print_enum(struct pretty_component
*pretty
,
703 struct bt_field
*field
)
706 struct bt_field_class
*enumeration_field_class
= NULL
;
707 bt_field_class_enumeration_mapping_label_array label_array
;
708 uint64_t label_count
;
711 enumeration_field_class
= bt_field_borrow_class(field
);
712 if (!enumeration_field_class
) {
717 switch (bt_field_get_class_type(field
)) {
718 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
719 ret
= bt_field_unsigned_enumeration_get_mapping_labels(field
,
720 &label_array
, &label_count
);
722 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
723 ret
= bt_field_signed_enumeration_get_mapping_labels(field
,
724 &label_array
, &label_count
);
735 g_string_append(pretty
->string
, "( ");
736 if (label_count
== 0) {
737 if (pretty
->use_colors
) {
738 g_string_append(pretty
->string
, COLOR_UNKNOWN
);
740 g_string_append(pretty
->string
, "<unknown>");
741 if (pretty
->use_colors
) {
742 g_string_append(pretty
->string
, COLOR_RST
);
746 for (i
= 0; i
< label_count
; i
++) {
747 const char *mapping_name
= label_array
[i
];
750 g_string_append(pretty
->string
, ", ");
752 if (pretty
->use_colors
) {
753 g_string_append(pretty
->string
, COLOR_ENUM_MAPPING_NAME
);
755 print_escape_string(pretty
, mapping_name
);
756 if (pretty
->use_colors
) {
757 g_string_append(pretty
->string
, COLOR_RST
);
761 g_string_append(pretty
->string
, " : container = ");
762 ret
= print_integer(pretty
, field
);
766 g_string_append(pretty
->string
, " )");
772 int filter_field_name(struct pretty_component
*pretty
, const char *field_name
,
773 GQuark
*filter_fields
, int filter_array_len
)
776 GQuark field_quark
= g_quark_try_string(field_name
);
778 if (!field_quark
|| pretty
->options
.verbose
) {
782 for (i
= 0; i
< filter_array_len
; i
++) {
783 if (field_quark
== filter_fields
[i
]) {
791 int print_struct_field(struct pretty_component
*pretty
,
792 struct bt_field
*_struct
,
793 struct bt_field_class
*struct_class
,
794 uint64_t i
, bool print_names
, uint64_t *nr_printed_fields
,
795 GQuark
*filter_fields
, int filter_array_len
)
798 const char *field_name
;
799 struct bt_field
*field
= NULL
;
800 struct bt_field_class
*field_class
= NULL
;;
802 field
= bt_field_structure_borrow_member_field_by_index(_struct
, i
);
808 bt_field_class_structure_borrow_member_by_index(struct_class
, i
,
809 &field_name
, &field_class
);
811 if (filter_fields
&& !filter_field_name(pretty
, field_name
,
812 filter_fields
, filter_array_len
)) {
817 if (*nr_printed_fields
> 0) {
818 g_string_append(pretty
->string
, ", ");
820 g_string_append(pretty
->string
, " ");
823 print_field_name_equal(pretty
, field_name
);
825 ret
= print_field(pretty
, field
, print_names
, NULL
, 0);
826 *nr_printed_fields
+= 1;
833 int print_struct(struct pretty_component
*pretty
,
834 struct bt_field
*_struct
, bool print_names
,
835 GQuark
*filter_fields
, int filter_array_len
)
838 struct bt_field_class
*struct_class
= NULL
;
839 uint64_t nr_fields
, i
, nr_printed_fields
;
841 struct_class
= bt_field_borrow_class(_struct
);
846 nr_fields
= bt_field_class_structure_get_member_count(struct_class
);
851 g_string_append(pretty
->string
, "{");
853 nr_printed_fields
= 0;
854 for (i
= 0; i
< nr_fields
; i
++) {
855 ret
= print_struct_field(pretty
, _struct
, struct_class
, i
,
856 print_names
, &nr_printed_fields
, filter_fields
,
863 g_string_append(pretty
->string
, " }");
870 int print_array_field(struct pretty_component
*pretty
,
871 struct bt_field
*array
, uint64_t i
, bool print_names
)
873 struct bt_field
*field
= NULL
;
876 g_string_append(pretty
->string
, ", ");
878 g_string_append(pretty
->string
, " ");
881 g_string_append_printf(pretty
->string
, "[%" PRIu64
"] = ", i
);
884 field
= bt_field_array_borrow_element_field_by_index(array
, i
);
886 return print_field(pretty
, field
, print_names
, NULL
, 0);
890 int print_array(struct pretty_component
*pretty
,
891 struct bt_field
*array
, bool print_names
)
894 struct bt_field_class
*array_class
= NULL
;
898 array_class
= bt_field_borrow_class(array
);
903 len
= bt_field_array_get_length(array
);
904 g_string_append(pretty
->string
, "[");
906 for (i
= 0; i
< len
; i
++) {
907 ret
= print_array_field(pretty
, array
, i
, print_names
);
913 g_string_append(pretty
->string
, " ]");
920 int print_sequence_field(struct pretty_component
*pretty
,
921 struct bt_field
*seq
, uint64_t i
, bool print_names
)
923 struct bt_field
*field
= NULL
;
926 g_string_append(pretty
->string
, ", ");
928 g_string_append(pretty
->string
, " ");
931 g_string_append_printf(pretty
->string
, "[%" PRIu64
"] = ", i
);
934 field
= bt_field_array_borrow_element_field_by_index(seq
, i
);
936 return print_field(pretty
, field
, print_names
, NULL
, 0);
940 int print_sequence(struct pretty_component
*pretty
,
941 struct bt_field
*seq
, bool print_names
)
947 len
= bt_field_array_get_length(seq
);
953 g_string_append(pretty
->string
, "[");
956 for (i
= 0; i
< len
; i
++) {
957 ret
= print_sequence_field(pretty
, seq
, i
, print_names
);
963 g_string_append(pretty
->string
, " ]");
970 int print_variant(struct pretty_component
*pretty
,
971 struct bt_field
*variant
, bool print_names
)
974 struct bt_field
*field
= NULL
;
976 field
= bt_field_variant_borrow_selected_option_field(variant
);
978 g_string_append(pretty
->string
, "{ ");
981 // TODO: find tag's name using field path
982 // print_field_name_equal(pretty, tag_choice);
984 ret
= print_field(pretty
, field
, print_names
, NULL
, 0);
989 g_string_append(pretty
->string
, " }");
996 int print_field(struct pretty_component
*pretty
,
997 struct bt_field
*field
, bool print_names
,
998 GQuark
*filter_fields
, int filter_array_len
)
1000 enum bt_field_class_type class_id
;
1002 class_id
= bt_field_get_class_type(field
);
1004 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
1005 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
1006 return print_integer(pretty
, field
);
1007 case BT_FIELD_CLASS_TYPE_REAL
:
1011 v
= bt_field_real_get_value(field
);
1012 if (pretty
->use_colors
) {
1013 g_string_append(pretty
->string
, COLOR_NUMBER_VALUE
);
1015 g_string_append_printf(pretty
->string
, "%g", v
);
1016 if (pretty
->use_colors
) {
1017 g_string_append(pretty
->string
, COLOR_RST
);
1021 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
1022 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
1023 return print_enum(pretty
, field
);
1024 case BT_FIELD_CLASS_TYPE_STRING
:
1028 str
= bt_field_string_get_value(field
);
1033 if (pretty
->use_colors
) {
1034 g_string_append(pretty
->string
, COLOR_STRING_VALUE
);
1036 print_escape_string(pretty
, str
);
1037 if (pretty
->use_colors
) {
1038 g_string_append(pretty
->string
, COLOR_RST
);
1042 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1043 return print_struct(pretty
, field
, print_names
, filter_fields
,
1045 case BT_FIELD_CLASS_TYPE_VARIANT
:
1046 return print_variant(pretty
, field
, print_names
);
1047 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1048 return print_array(pretty
, field
, print_names
);
1049 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1050 return print_sequence(pretty
, field
, print_names
);
1052 // TODO: log instead
1053 fprintf(pretty
->err
, "[error] Unknown type id: %d\n", (int) class_id
);
1059 int print_stream_packet_context(struct pretty_component
*pretty
,
1060 struct bt_event
*event
)
1063 struct bt_packet
*packet
= NULL
;
1064 struct bt_field
*main_field
= NULL
;
1066 packet
= bt_event_borrow_packet(event
);
1071 main_field
= bt_packet_borrow_context_field(packet
);
1075 if (!pretty
->start_line
) {
1076 g_string_append(pretty
->string
, ", ");
1078 pretty
->start_line
= false;
1079 if (pretty
->options
.print_scope_field_names
) {
1080 print_name_equal(pretty
, "stream.packet.context");
1082 ret
= print_field(pretty
, main_field
,
1083 pretty
->options
.print_context_field_names
,
1084 stream_packet_context_quarks
,
1085 STREAM_PACKET_CONTEXT_QUARKS_LEN
);
1092 int print_event_header_raw(struct pretty_component
*pretty
,
1093 struct bt_event
*event
)
1096 struct bt_field
*main_field
= NULL
;
1098 main_field
= bt_event_borrow_header_field(event
);
1102 if (!pretty
->start_line
) {
1103 g_string_append(pretty
->string
, ", ");
1105 pretty
->start_line
= false;
1106 if (pretty
->options
.print_scope_field_names
) {
1107 print_name_equal(pretty
, "stream.event.header");
1109 ret
= print_field(pretty
, main_field
,
1110 pretty
->options
.print_header_field_names
, NULL
, 0);
1117 int print_stream_event_context(struct pretty_component
*pretty
,
1118 struct bt_event
*event
)
1121 struct bt_field
*main_field
= NULL
;
1123 main_field
= bt_event_borrow_common_context_field(event
);
1127 if (!pretty
->start_line
) {
1128 g_string_append(pretty
->string
, ", ");
1130 pretty
->start_line
= false;
1131 if (pretty
->options
.print_scope_field_names
) {
1132 print_name_equal(pretty
, "stream.event.context");
1134 ret
= print_field(pretty
, main_field
,
1135 pretty
->options
.print_context_field_names
, NULL
, 0);
1142 int print_event_context(struct pretty_component
*pretty
,
1143 struct bt_event
*event
)
1146 struct bt_field
*main_field
= NULL
;
1148 main_field
= bt_event_borrow_specific_context_field(event
);
1152 if (!pretty
->start_line
) {
1153 g_string_append(pretty
->string
, ", ");
1155 pretty
->start_line
= false;
1156 if (pretty
->options
.print_scope_field_names
) {
1157 print_name_equal(pretty
, "event.context");
1159 ret
= print_field(pretty
, main_field
,
1160 pretty
->options
.print_context_field_names
, NULL
, 0);
1167 int print_event_payload(struct pretty_component
*pretty
,
1168 struct bt_event
*event
)
1171 struct bt_field
*main_field
= NULL
;
1173 main_field
= bt_event_borrow_payload_field(event
);
1177 if (!pretty
->start_line
) {
1178 g_string_append(pretty
->string
, ", ");
1180 pretty
->start_line
= false;
1181 if (pretty
->options
.print_scope_field_names
) {
1182 print_name_equal(pretty
, "event.fields");
1184 ret
= print_field(pretty
, main_field
,
1185 pretty
->options
.print_payload_field_names
, NULL
, 0);
1192 int flush_buf(FILE *stream
, struct pretty_component
*pretty
)
1196 if (pretty
->string
->len
== 0) {
1200 if (fwrite(pretty
->string
->str
, pretty
->string
->len
, 1, stream
) != 1) {
1209 int pretty_print_event(struct pretty_component
*pretty
,
1210 struct bt_notification
*event_notif
)
1213 struct bt_event
*event
=
1214 bt_notification_event_borrow_event(event_notif
);
1217 pretty
->start_line
= true;
1218 g_string_assign(pretty
->string
, "");
1219 ret
= print_event_header(pretty
, event
);
1224 ret
= print_stream_packet_context(pretty
, event
);
1229 if (pretty
->options
.verbose
) {
1230 ret
= print_event_header_raw(pretty
, event
);
1236 ret
= print_stream_event_context(pretty
, event
);
1241 ret
= print_event_context(pretty
, event
);
1246 ret
= print_event_payload(pretty
, event
);
1251 g_string_append_c(pretty
->string
, '\n');
1252 if (flush_buf(pretty
->out
, pretty
)) {
1262 int print_discarded_elements_msg(
1263 struct pretty_component
*pretty
, struct bt_packet
*packet
,
1264 uint64_t count
, const char *elem_type
)
1268 struct bt_stream
*stream
= NULL
;
1269 struct bt_stream_class
*stream_class
= NULL
;
1270 struct bt_trace
*trace
= NULL
;
1271 const char *stream_name
;
1272 const char *trace_name
;
1273 const unsigned char *trace_uuid
;
1274 int64_t stream_class_id
;
1276 struct bt_clock_value
*begin_clock_value
= NULL
;
1277 struct bt_clock_value
*end_clock_value
= NULL
;
1281 stream
= bt_packet_borrow_stream(packet
);
1283 stream_name
= bt_stream_get_name(stream
);
1285 /* Stream class ID */
1286 stream_class
= bt_stream_borrow_class(stream
);
1287 BT_ASSERT(stream_class
);
1288 stream_class_id
= bt_stream_class_get_id(stream_class
);
1291 stream_id
= bt_stream_get_id(stream
);
1294 trace
= bt_stream_class_borrow_trace(stream_class
);
1296 trace_name
= bt_trace_get_name(trace
);
1298 trace_name
= "(unknown)";
1302 trace_uuid
= bt_trace_get_uuid(trace
);
1304 /* Beginning and end times */
1305 (void) bt_packet_borrow_previous_packet_default_end_clock_value(
1306 packet
, &begin_clock_value
);
1307 (void) bt_packet_borrow_default_end_clock_value(packet
,
1310 /* Format message */
1311 g_string_assign(pretty
->string
, "");
1312 g_string_append_printf(pretty
->string
,
1313 "%s%sWARNING%s%s: Tracer discarded %" PRId64
" %s%s ",
1314 bt_common_color_fg_yellow(),
1315 bt_common_color_bold(),
1316 bt_common_color_reset(),
1317 bt_common_color_fg_yellow(),
1318 count
, elem_type
, count
== 1 ? "" : "s");
1320 if (begin_clock_value
&& end_clock_value
) {
1321 g_string_append(pretty
->string
, "between [");
1322 print_timestamp_wall(pretty
, begin_clock_value
);
1323 g_string_append(pretty
->string
, "] and [");
1324 print_timestamp_wall(pretty
, end_clock_value
);
1325 g_string_append(pretty
->string
, "]");
1327 g_string_append(pretty
->string
, "(unknown time range)");
1330 g_string_append_printf(pretty
->string
, " in trace \"%s\" ", trace_name
);
1333 g_string_append_printf(pretty
->string
,
1334 "(UUID: %02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x) ",
1352 g_string_append(pretty
->string
, "(no UUID) ");
1355 g_string_append_printf(pretty
->string
,
1356 "within stream \"%s\" (stream class ID: %" PRId64
", ",
1357 stream_name
, stream_class_id
);
1359 if (stream_id
>= 0) {
1360 g_string_append_printf(pretty
->string
,
1361 "stream ID: %" PRId64
, stream_id
);
1363 g_string_append(pretty
->string
, "no stream ID");
1366 g_string_append_printf(pretty
->string
, ").%s\n",
1367 bt_common_color_reset());
1370 * Print to standard error stream to remain backward compatible
1371 * with Babeltrace 1.
1373 if (flush_buf(stderr
, pretty
)) {
1383 int pretty_print_packet(struct pretty_component
*pretty
,
1384 struct bt_notification
*packet_beginning_notif
)
1387 struct bt_packet
*packet
= bt_notification_packet_begin_borrow_packet(
1388 packet_beginning_notif
);
1392 if (bt_packet_get_discarded_event_count(packet
, &count
) ==
1393 BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE
&&
1395 status
= print_discarded_elements_msg(pretty
, packet
,
1402 if (bt_packet_get_discarded_packet_count(packet
, &count
) ==
1403 BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE
&&
1405 status
= print_discarded_elements_msg(pretty
, packet
,