2 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 #include <babeltrace2/babeltrace.h>
27 #include "common/assert.h"
28 #include "common/common.h"
29 #include "common/uuid.h"
32 #include "obj-lifetime-mgmt.h"
36 const char *plural(uint64_t value
)
38 return value
== 1 ? "" : "s";
42 void incr_indent_by(struct details_write_ctx
*ctx
, unsigned int value
)
45 ctx
->indent_level
+= value
;
49 void incr_indent(struct details_write_ctx
*ctx
)
51 incr_indent_by(ctx
, 2);
55 void decr_indent_by(struct details_write_ctx
*ctx
, unsigned int value
)
58 BT_ASSERT_DBG(ctx
->indent_level
>= value
);
59 ctx
->indent_level
-= value
;
63 void decr_indent(struct details_write_ctx
*ctx
)
65 decr_indent_by(ctx
, 2);
69 void format_uint(char *buf
, uint64_t value
, unsigned int base
)
71 const char *spec
= "%" PRIu64
;
72 char *buf_start
= buf
;
73 unsigned int digits_per_group
= 3;
75 bool sep_digits
= true;
80 /* TODO: Support binary format */
96 * Do not insert digit separators for numbers
97 * under 10,000 as it looks weird.
107 sprintf(buf_start
, spec
, value
);
110 bt_common_sep_digits(buf_start
, digits_per_group
, sep
);
115 void format_int(char *buf
, int64_t value
, unsigned int base
)
117 const char *spec
= "%" PRIu64
;
118 char *buf_start
= buf
;
119 unsigned int digits_per_group
= 3;
121 bool sep_digits
= true;
122 uint64_t abs_value
= value
< 0 ? (uint64_t) -value
: (uint64_t) value
;
132 /* TODO: Support binary format */
134 strcpy(buf_start
, "0x");
136 digits_per_group
= 4;
141 strcpy(buf_start
, "0");
146 if (value
>= -9999 && value
<= 9999) {
148 * Do not insert digit separators for numbers
149 * over -10,000 and under 10,000 as it looks
160 sprintf(buf_start
, spec
, abs_value
);
163 bt_common_sep_digits(buf_start
, digits_per_group
, sep
);
168 void write_nl(struct details_write_ctx
*ctx
)
171 g_string_append_c(ctx
->str
, '\n');
175 void write_sp(struct details_write_ctx
*ctx
)
178 g_string_append_c(ctx
->str
, ' ');
182 void write_indent(struct details_write_ctx
*ctx
)
188 for (i
= 0; i
< ctx
->indent_level
; i
++) {
194 void write_compound_member_name(struct details_write_ctx
*ctx
, const char *name
)
197 g_string_append_printf(ctx
->str
, "%s%s%s:",
198 color_fg_cyan(ctx
), name
, color_reset(ctx
));
202 void write_array_index(struct details_write_ctx
*ctx
, uint64_t index
,
208 format_uint(buf
, index
, 10);
209 g_string_append_printf(ctx
->str
, "%s[%s]%s:",
210 color
, buf
, color_reset(ctx
));
214 void write_obj_type_name(struct details_write_ctx
*ctx
, const char *name
)
216 g_string_append_printf(ctx
->str
, "%s%s%s%s",
217 color_fg_yellow(ctx
), color_bold(ctx
), name
, color_reset(ctx
));
221 void write_prop_name(struct details_write_ctx
*ctx
, const char *prop_name
)
223 g_string_append_printf(ctx
->str
, "%s%s%s",
224 color_fg_magenta(ctx
), prop_name
, color_reset(ctx
));
228 void write_prop_name_line(struct details_write_ctx
*ctx
, const char *prop_name
)
231 g_string_append_printf(ctx
->str
, "%s%s%s:",
232 color_fg_magenta(ctx
), prop_name
, color_reset(ctx
));
236 void write_str_prop_value(struct details_write_ctx
*ctx
, const char *value
)
238 g_string_append_printf(ctx
->str
, "%s%s%s",
239 color_bold(ctx
), value
, color_reset(ctx
));
243 void write_none_prop_value(struct details_write_ctx
*ctx
, const char *value
)
245 g_string_append_printf(ctx
->str
, "%s%s%s%s",
246 color_bold(ctx
), color_fg_magenta(ctx
),
247 value
, color_reset(ctx
));
251 void write_uint_str_prop_value(struct details_write_ctx
*ctx
, const char *value
)
253 write_str_prop_value(ctx
, value
);
257 void write_uint_prop_value(struct details_write_ctx
*ctx
, uint64_t value
)
261 format_uint(buf
, value
, 10);
262 write_uint_str_prop_value(ctx
, buf
);
266 void write_int_prop_value(struct details_write_ctx
*ctx
, int64_t value
)
270 format_int(buf
, value
, 10);
271 write_uint_str_prop_value(ctx
, buf
);
275 void write_float_prop_value(struct details_write_ctx
*ctx
, double value
)
277 g_string_append_printf(ctx
->str
, "%s%f%s",
278 color_bold(ctx
), value
, color_reset(ctx
));
282 void write_str_prop_line(struct details_write_ctx
*ctx
, const char *prop_name
,
283 const char *prop_value
)
285 BT_ASSERT_DBG(prop_value
);
287 write_prop_name(ctx
, prop_name
);
288 g_string_append(ctx
->str
, ": ");
289 write_str_prop_value(ctx
, prop_value
);
294 void write_uint_prop_line(struct details_write_ctx
*ctx
, const char *prop_name
,
298 write_prop_name(ctx
, prop_name
);
299 g_string_append(ctx
->str
, ": ");
300 write_uint_prop_value(ctx
, prop_value
);
305 void write_int_prop_line(struct details_write_ctx
*ctx
, const char *prop_name
,
309 write_prop_name(ctx
, prop_name
);
310 g_string_append(ctx
->str
, ": ");
311 write_int_prop_value(ctx
, prop_value
);
316 void write_int_str_prop_value(struct details_write_ctx
*ctx
, const char *value
)
318 write_str_prop_value(ctx
, value
);
322 void write_bool_prop_value(struct details_write_ctx
*ctx
, bt_bool prop_value
)
326 g_string_append(ctx
->str
, color_bold(ctx
));
329 g_string_append(ctx
->str
, color_fg_green(ctx
));
332 g_string_append(ctx
->str
, color_fg_red(ctx
));
336 g_string_append_printf(ctx
->str
, "%s%s", str
, color_reset(ctx
));
340 void write_bool_prop_line(struct details_write_ctx
*ctx
, const char *prop_name
,
344 write_prop_name(ctx
, prop_name
);
345 g_string_append(ctx
->str
, ": ");
346 write_bool_prop_value(ctx
, prop_value
);
351 void write_uuid_prop_line(struct details_write_ctx
*ctx
, const char *prop_name
,
356 write_prop_name(ctx
, prop_name
);
357 g_string_append_printf(ctx
->str
,
358 ": %s" BT_UUID_FMT
"%s\n",
360 BT_UUID_FMT_VALUES(uuid
),
365 gint
compare_strings(const char **a
, const char **b
)
367 return strcmp(*a
, *b
);
371 bt_bool
map_value_foreach_add_key_to_array(const char *key
,
372 const bt_value
*object
, void *data
)
374 GPtrArray
*keys
= data
;
377 g_ptr_array_add(keys
, (void *) key
);
382 void write_value(struct details_write_ctx
*ctx
, const bt_value
*value
,
386 bt_value_type value_type
= bt_value_get_type(value
);
387 GPtrArray
*keys
= g_ptr_array_new();
392 /* Write field's name */
394 write_prop_name_line(ctx
, name
);
397 /* Write field's value */
398 switch (value_type
) {
399 case BT_VALUE_TYPE_NULL
:
401 write_none_prop_value(ctx
, "Null");
403 case BT_VALUE_TYPE_BOOL
:
405 write_bool_prop_value(ctx
, bt_value_bool_get(value
));
407 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
408 format_uint(buf
, bt_value_integer_unsigned_get(value
), 10);
410 write_uint_str_prop_value(ctx
, buf
);
412 case BT_VALUE_TYPE_SIGNED_INTEGER
:
413 format_int(buf
, bt_value_integer_signed_get(value
), 10);
415 write_int_str_prop_value(ctx
, buf
);
417 case BT_VALUE_TYPE_REAL
:
419 write_float_prop_value(ctx
, bt_value_real_get(value
));
421 case BT_VALUE_TYPE_STRING
:
423 write_str_prop_value(ctx
, bt_value_string_get(value
));
425 case BT_VALUE_TYPE_ARRAY
:
427 uint64_t length
= bt_value_array_get_length(value
);
431 write_none_prop_value(ctx
, "Empty");
433 g_string_append(ctx
->str
, " Length ");
434 write_uint_prop_value(ctx
, length
);
435 g_string_append_c(ctx
->str
, ':');
440 for (i
= 0; i
< length
; i
++) {
441 const bt_value
*elem_value
=
442 bt_value_array_borrow_element_by_index_const(
446 write_array_index(ctx
, i
, color_fg_magenta(ctx
));
447 write_value(ctx
, elem_value
, NULL
);
453 case BT_VALUE_TYPE_MAP
:
455 bt_value_map_foreach_entry_const_status foreach_status
=
456 bt_value_map_foreach_entry_const(value
,
457 map_value_foreach_add_key_to_array
, keys
);
459 BT_ASSERT_DBG(foreach_status
==
460 BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
);
461 g_ptr_array_sort(keys
, (GCompareFunc
) compare_strings
);
466 for (i
= 0; i
< keys
->len
; i
++) {
467 const char *key
= keys
->pdata
[i
];
468 const bt_value
*entry_value
=
469 bt_value_map_borrow_entry_value_const(
473 write_value(ctx
, entry_value
, key
);
479 write_none_prop_value(ctx
, "Empty");
488 g_ptr_array_free(keys
, TRUE
);
492 void write_user_attributes(struct details_write_ctx
*ctx
,
493 const bt_value
*user_attrs
, bool write_newline
, bool *written
)
495 BT_ASSERT_DBG(user_attrs
);
497 if (!bt_value_map_is_empty(user_attrs
)) {
498 write_value(ctx
, user_attrs
, "User attributes");
511 void write_int_field_class_props(struct details_write_ctx
*ctx
,
512 const bt_field_class
*fc
, bool close
)
514 g_string_append_printf(ctx
->str
, "(%s%" PRIu64
"-bit%s, Base ",
516 bt_field_class_integer_get_field_value_range(fc
),
519 switch (bt_field_class_integer_get_preferred_display_base(fc
)) {
520 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
:
521 write_uint_prop_value(ctx
, 2);
523 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
:
524 write_uint_prop_value(ctx
, 8);
526 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
:
527 write_uint_prop_value(ctx
, 10);
529 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
:
530 write_uint_prop_value(ctx
, 16);
537 g_string_append(ctx
->str
, ")");
553 struct enum_field_class_mapping
{
557 /* Array of `struct int_range` */
562 gint
compare_enum_field_class_mappings(struct enum_field_class_mapping
**a
,
563 struct enum_field_class_mapping
**b
)
565 return strcmp((*a
)->label
, (*b
)->label
);
569 gint
compare_int_ranges_signed(struct int_range
*a
, struct int_range
*b
)
572 if (a
->lower
.i
< b
->lower
.i
) {
574 } else if (a
->lower
.i
> b
->lower
.i
) {
577 if (a
->upper
.i
< b
->upper
.i
) {
579 } else if (a
->upper
.i
> b
->upper
.i
) {
588 gint
compare_int_ranges_unsigned(struct int_range
*a
, struct int_range
*b
)
590 if (a
->lower
.u
< b
->lower
.u
) {
592 } else if (a
->lower
.u
> b
->lower
.u
) {
595 if (a
->upper
.u
< b
->upper
.u
) {
597 } else if (a
->upper
.u
> b
->upper
.u
) {
606 GArray
*range_set_to_int_ranges(const void *spec_range_set
, bool is_signed
)
609 const bt_integer_range_set
*range_set
;
610 GArray
*ranges
= g_array_new(FALSE
, TRUE
, sizeof(struct int_range
));
617 range_set
= bt_integer_range_set_signed_as_range_set_const(
620 range_set
= bt_integer_range_set_unsigned_as_range_set_const(
624 for (i
= 0; i
< bt_integer_range_set_get_range_count(range_set
); i
++) {
625 struct int_range range
;
628 const bt_integer_range_signed
*orig_range
=
629 bt_integer_range_set_signed_borrow_range_by_index_const(
632 range
.lower
.i
= bt_integer_range_signed_get_lower(orig_range
);
633 range
.upper
.i
= bt_integer_range_signed_get_upper(orig_range
);
635 const bt_integer_range_unsigned
*orig_range
=
636 bt_integer_range_set_unsigned_borrow_range_by_index_const(
639 range
.lower
.u
= bt_integer_range_unsigned_get_lower(orig_range
);
640 range
.upper
.u
= bt_integer_range_unsigned_get_upper(orig_range
);
643 g_array_append_val(ranges
, range
);
647 g_array_sort(ranges
, (GCompareFunc
) compare_int_ranges_signed
);
650 (GCompareFunc
) compare_int_ranges_unsigned
);
658 void destroy_enum_field_class_mapping(struct enum_field_class_mapping
*mapping
)
660 if (mapping
->ranges
) {
661 g_array_free(mapping
->ranges
, TRUE
);
662 mapping
->ranges
= NULL
;
669 struct int_range
*int_range_at(GArray
*ranges
, uint64_t index
)
671 return &g_array_index(ranges
, struct int_range
, index
);
675 void write_int_range(struct details_write_ctx
*ctx
,
676 struct int_range
*range
, bool is_signed
)
678 g_string_append(ctx
->str
, "[");
681 write_int_prop_value(ctx
, range
->lower
.i
);
683 write_int_prop_value(ctx
, range
->lower
.u
);
686 if (range
->lower
.u
!= range
->upper
.u
) {
687 g_string_append(ctx
->str
, ", ");
690 write_int_prop_value(ctx
, range
->upper
.i
);
692 write_int_prop_value(ctx
, range
->upper
.u
);
696 g_string_append(ctx
->str
, "]");
700 void write_enum_field_class_mappings(struct details_write_ctx
*ctx
,
701 const bt_field_class
*fc
)
706 bool is_signed
= bt_field_class_get_type(fc
) ==
707 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
;
709 mappings
= g_ptr_array_new_with_free_func(
710 (GDestroyNotify
) destroy_enum_field_class_mapping
);
711 BT_ASSERT_DBG(mappings
);
714 * Copy field class's mappings to our own arrays and structures
717 for (i
= 0; i
< bt_field_class_enumeration_get_mapping_count(fc
); i
++) {
718 const void *fc_mapping
;
719 const void *fc_range_set
;
720 struct enum_field_class_mapping
*mapping
= g_new0(
721 struct enum_field_class_mapping
, 1);
723 BT_ASSERT_DBG(mapping
);
726 fc_mapping
= bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
728 fc_range_set
= bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
731 fc_mapping
= bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
733 fc_range_set
= bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
737 mapping
->label
= bt_field_class_enumeration_mapping_get_label(
738 bt_field_class_enumeration_signed_mapping_as_mapping_const(
740 mapping
->ranges
= range_set_to_int_ranges(fc_range_set
,
742 BT_ASSERT_DBG(mapping
->ranges
);
743 g_ptr_array_add(mappings
, mapping
);
746 /* Sort mappings (ranges are already sorted within mappings) */
747 g_ptr_array_sort(mappings
,
748 (GCompareFunc
) compare_enum_field_class_mappings
);
751 for (i
= 0; i
< mappings
->len
; i
++) {
752 struct enum_field_class_mapping
*mapping
= mappings
->pdata
[i
];
755 write_prop_name_line(ctx
, mapping
->label
);
757 for (range_i
= 0; range_i
< mapping
->ranges
->len
; range_i
++) {
760 int_range_at(mapping
->ranges
, range_i
),
765 g_ptr_array_free(mappings
, TRUE
);
769 void write_field_path(struct details_write_ctx
*ctx
,
770 const bt_field_path
*field_path
)
774 g_string_append_c(ctx
->str
, '[');
776 switch (bt_field_path_get_root_scope(field_path
)) {
777 case BT_FIELD_PATH_SCOPE_PACKET_CONTEXT
:
778 write_str_prop_value(ctx
, "Packet context");
780 case BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT
:
781 write_str_prop_value(ctx
, "Event common context");
783 case BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT
:
784 write_str_prop_value(ctx
, "Event specific context");
786 case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD
:
787 write_str_prop_value(ctx
, "Event payload");
793 g_string_append(ctx
->str
, ": ");
795 for (i
= 0; i
< bt_field_path_get_item_count(field_path
); i
++) {
796 const bt_field_path_item
*fp_item
=
797 bt_field_path_borrow_item_by_index_const(field_path
, i
);
800 g_string_append(ctx
->str
, ", ");
803 switch (bt_field_path_item_get_type(fp_item
)) {
804 case BT_FIELD_PATH_ITEM_TYPE_INDEX
:
805 write_uint_prop_value(ctx
,
806 bt_field_path_item_index_get_index(fp_item
));
808 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT
:
809 write_str_prop_value(ctx
, "<current>");
816 g_string_append_c(ctx
->str
, ']');
820 void write_field_class(struct details_write_ctx
*ctx
, const bt_field_class
*fc
);
823 void write_variant_field_class_option(struct details_write_ctx
*ctx
,
824 const bt_field_class
*fc
, uint64_t index
)
826 bt_field_class_type fc_type
= bt_field_class_get_type(fc
);
827 const bt_field_class_variant_option
*option
=
828 bt_field_class_variant_borrow_option_by_index_const(
830 const void *orig_ranges
= NULL
;
831 GArray
*int_ranges
= NULL
;
833 const bt_value
*user_attrs
=
834 bt_field_class_variant_option_borrow_user_attributes_const(
836 const bt_field_class
*option_fc
=
837 bt_field_class_variant_option_borrow_field_class_const(option
);
840 write_compound_member_name(ctx
,
841 bt_field_class_variant_option_get_name(option
));
843 if (fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD
) {
844 const bt_field_class_variant_with_selector_field_integer_unsigned_option
*spec_opt
=
845 bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
849 bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
852 } else if (fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD
) {
853 const bt_field_class_variant_with_selector_field_integer_signed_option
*spec_opt
=
854 bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
858 bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
866 int_ranges
= range_set_to_int_ranges(orig_ranges
, is_signed
);
867 BT_ASSERT_DBG(int_ranges
);
869 for (i
= 0; i
< int_ranges
->len
; i
++) {
870 struct int_range
*range
= int_range_at(int_ranges
, i
);
873 write_int_range(ctx
, range
, is_signed
);
876 g_string_append(ctx
->str
, ": ");
881 if (bt_value_map_is_empty(user_attrs
)) {
882 write_field_class(ctx
, option_fc
);
888 write_prop_name_line(ctx
, "Field class");
890 write_field_class(ctx
, option_fc
);
893 /* User attributes */
894 write_user_attributes(ctx
, user_attrs
,
901 g_array_free(int_ranges
, TRUE
);
906 void write_field_class(struct details_write_ctx
*ctx
, const bt_field_class
*fc
)
910 bt_field_class_type fc_type
= bt_field_class_get_type(fc
);
911 const bt_value
*user_attrs
;
912 bool wrote_user_attrs
= false;
914 /* Write field class's type */
916 case BT_FIELD_CLASS_TYPE_BOOL
:
919 case BT_FIELD_CLASS_TYPE_BIT_ARRAY
:
922 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
923 type
= "Unsigned integer";
925 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
926 type
= "Signed integer";
928 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
929 type
= "Unsigned enumeration";
931 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
932 type
= "Signed enumeration";
934 case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
:
935 type
= "Single-precision real";
937 case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL
:
938 type
= "Double-precision real";
940 case BT_FIELD_CLASS_TYPE_STRING
:
943 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
946 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
947 type
= "Static array";
949 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
:
950 type
= "Dynamic array (no length field)";
952 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
:
953 type
= "Dynamic array (with length field)";
955 case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD
:
956 type
= "Option (no selector)";
958 case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD
:
959 type
= "Option (boolean selector)";
961 case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD
:
962 type
= "Option (unsigned integer selector)";
964 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD
:
965 type
= "Option (signed integer selector)";
967 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD
:
968 type
= "Variant (no selector)";
970 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD
:
971 type
= "Variant (unsigned integer selector)";
973 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD
:
974 type
= "Variant (signed integer selector)";
980 g_string_append_printf(ctx
->str
, "%s%s%s",
981 color_fg_blue(ctx
), type
, color_reset(ctx
));
983 /* Write field class's single-line properties */
984 if (bt_field_class_type_is(fc_type
, BT_FIELD_CLASS_TYPE_ENUMERATION
)) {
985 uint64_t mapping_count
=
986 bt_field_class_enumeration_get_mapping_count(fc
);
989 write_int_field_class_props(ctx
, fc
, false);
990 g_string_append(ctx
->str
, ", ");
991 write_uint_prop_value(ctx
, mapping_count
);
992 g_string_append_printf(ctx
->str
, " mapping%s)",
993 plural(mapping_count
));
994 } else if (bt_field_class_type_is(fc_type
,
995 BT_FIELD_CLASS_TYPE_INTEGER
)) {
997 write_int_field_class_props(ctx
, fc
, true);
998 } else if (fc_type
== BT_FIELD_CLASS_TYPE_STRUCTURE
) {
999 uint64_t member_count
=
1000 bt_field_class_structure_get_member_count(fc
);
1002 g_string_append(ctx
->str
, " (");
1003 write_uint_prop_value(ctx
, member_count
);
1004 g_string_append_printf(ctx
->str
, " member%s)",
1005 plural(member_count
));
1006 } else if (fc_type
== BT_FIELD_CLASS_TYPE_STATIC_ARRAY
) {
1007 g_string_append(ctx
->str
, " (Length ");
1008 write_uint_prop_value(ctx
,
1009 bt_field_class_array_static_get_length(fc
));
1010 g_string_append_c(ctx
->str
, ')');
1011 } else if (fc_type
== BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
) {
1012 const bt_field_path
*length_field_path
=
1013 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1016 g_string_append(ctx
->str
, " (Length field path ");
1017 write_field_path(ctx
, length_field_path
);
1018 g_string_append_c(ctx
->str
, ')');
1019 } else if (bt_field_class_type_is(fc_type
,
1020 BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD
)) {
1021 const bt_field_path
*selector_field_path
=
1022 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1025 g_string_append(ctx
->str
, " (Selector field path ");
1026 write_field_path(ctx
, selector_field_path
);
1027 g_string_append_c(ctx
->str
, ')');
1028 } else if (bt_field_class_type_is(fc_type
,
1029 BT_FIELD_CLASS_TYPE_VARIANT
)) {
1030 uint64_t option_count
=
1031 bt_field_class_variant_get_option_count(fc
);
1032 const bt_field_path
*sel_field_path
= NULL
;
1034 if (bt_field_class_type_is(fc_type
,
1035 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD
)) {
1037 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
1039 BT_ASSERT_DBG(sel_field_path
);
1042 g_string_append(ctx
->str
, " (");
1043 write_uint_prop_value(ctx
, option_count
);
1044 g_string_append_printf(ctx
->str
, " option%s",
1045 plural(option_count
));
1047 if (sel_field_path
) {
1048 g_string_append(ctx
->str
, ", Selector field path ");
1049 write_field_path(ctx
, sel_field_path
);
1052 g_string_append_c(ctx
->str
, ')');
1056 user_attrs
= bt_field_class_borrow_user_attributes_const(fc
);
1057 if (!bt_value_map_is_empty(user_attrs
)) {
1058 g_string_append(ctx
->str
, ":\n");
1059 write_user_attributes(ctx
, user_attrs
, false, NULL
);
1060 wrote_user_attrs
= true;
1063 /* Write field class's complex properties */
1064 if (bt_field_class_type_is(fc_type
, BT_FIELD_CLASS_TYPE_ENUMERATION
)) {
1065 uint64_t mapping_count
=
1066 bt_field_class_enumeration_get_mapping_count(fc
);
1068 if (mapping_count
> 0) {
1069 if (wrote_user_attrs
) {
1072 write_prop_name(ctx
, "Mappings");
1073 g_string_append_c(ctx
->str
, ':');
1076 /* Each mapping starts with its own newline */
1077 g_string_append_c(ctx
->str
, ':');
1080 write_enum_field_class_mappings(ctx
, fc
);
1082 if (wrote_user_attrs
) {
1086 } else if (fc_type
== BT_FIELD_CLASS_TYPE_STRUCTURE
) {
1087 uint64_t member_count
=
1088 bt_field_class_structure_get_member_count(fc
);
1090 if (member_count
> 0) {
1091 if (wrote_user_attrs
) {
1094 write_prop_name(ctx
, "Members");
1095 g_string_append_c(ctx
->str
, ':');
1098 /* Each member starts with its own newline */
1099 g_string_append_c(ctx
->str
, ':');
1102 for (i
= 0; i
< member_count
; i
++) {
1103 const bt_field_class_structure_member
*member
=
1104 bt_field_class_structure_borrow_member_by_index_const(
1106 const bt_value
*member_user_attrs
;
1107 const bt_field_class
*member_fc
=
1108 bt_field_class_structure_member_borrow_field_class_const(member
);
1111 write_compound_member_name(ctx
,
1112 bt_field_class_structure_member_get_name(member
));
1113 member_user_attrs
= bt_field_class_structure_member_borrow_user_attributes_const(
1116 if (bt_value_map_is_empty(member_user_attrs
)) {
1118 write_field_class(ctx
, member_fc
);
1124 write_prop_name_line(ctx
, "Field class");
1126 write_field_class(ctx
, member_fc
);
1129 /* User attributes */
1130 write_user_attributes(ctx
, member_user_attrs
,
1137 if (wrote_user_attrs
) {
1141 } else if (bt_field_class_type_is(fc_type
, BT_FIELD_CLASS_TYPE_ARRAY
)) {
1142 if (wrote_user_attrs
) {
1145 g_string_append(ctx
->str
, ":\n");
1148 write_prop_name_line(ctx
, "Element");
1150 write_field_class(ctx
,
1151 bt_field_class_array_borrow_element_field_class_const(fc
));
1152 } else if (bt_field_class_type_is(fc_type
,
1153 BT_FIELD_CLASS_TYPE_OPTION
)) {
1154 const void *ranges
= NULL
;
1155 bool selector_is_signed
= false;
1157 if (wrote_user_attrs
) {
1160 g_string_append(ctx
->str
, ":\n");
1163 if (fc_type
== BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD
) {
1164 write_bool_prop_line(ctx
, "Selector is reversed",
1165 bt_field_class_option_with_selector_field_bool_selector_is_reversed(fc
));
1166 } else if (fc_type
== BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD
) {
1167 ranges
= bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(fc
);
1168 } else if (fc_type
== BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD
) {
1169 ranges
= bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(fc
);
1170 selector_is_signed
= true;
1174 GArray
*sorted_ranges
= range_set_to_int_ranges(
1175 ranges
, selector_is_signed
);
1177 BT_ASSERT_DBG(sorted_ranges
);
1178 BT_ASSERT_DBG(sorted_ranges
->len
> 0);
1179 write_prop_name_line(ctx
, "Selector ranges");
1181 for (i
= 0; i
< sorted_ranges
->len
; i
++) {
1183 write_int_range(ctx
,
1184 int_range_at(sorted_ranges
, i
),
1185 selector_is_signed
);
1189 g_array_free(sorted_ranges
, TRUE
);
1192 write_prop_name_line(ctx
, "Content");
1194 write_field_class(ctx
,
1195 bt_field_class_option_borrow_field_class_const(fc
));
1196 } else if (bt_field_class_type_is(fc_type
,
1197 BT_FIELD_CLASS_TYPE_VARIANT
)) {
1198 uint64_t option_count
=
1199 bt_field_class_variant_get_option_count(fc
);
1201 if (option_count
> 0) {
1202 if (wrote_user_attrs
) {
1205 write_prop_name(ctx
, "Options");
1206 g_string_append_c(ctx
->str
, ':');
1209 /* Each option starts with its own newline */
1210 g_string_append_c(ctx
->str
, ':');
1213 for (i
= 0; i
< option_count
; i
++) {
1214 write_variant_field_class_option(ctx
, fc
, i
);
1217 if (wrote_user_attrs
) {
1227 void write_root_field_class(struct details_write_ctx
*ctx
, const char *name
,
1228 const bt_field_class
*fc
)
1230 BT_ASSERT_DBG(name
);
1233 write_prop_name(ctx
, name
);
1234 g_string_append(ctx
->str
, ": ");
1235 write_field_class(ctx
, fc
);
1240 void write_event_class(struct details_write_ctx
*ctx
, const bt_event_class
*ec
)
1242 const char *name
= bt_event_class_get_name(ec
);
1243 const char *emf_uri
;
1244 const bt_field_class
*fc
;
1245 bt_event_class_log_level log_level
;
1248 write_obj_type_name(ctx
, "Event class");
1250 /* Write name and ID */
1252 g_string_append_printf(ctx
->str
, " `%s%s%s`",
1253 color_fg_green(ctx
), name
, color_reset(ctx
));
1256 g_string_append(ctx
->str
, " (ID ");
1257 write_uint_prop_value(ctx
, bt_event_class_get_id(ec
));
1258 g_string_append(ctx
->str
, "):\n");
1260 /* Write properties */
1263 /* Write user attributes */
1264 write_user_attributes(ctx
,
1265 bt_event_class_borrow_user_attributes_const(ec
), true, NULL
);
1267 /* Write log level */
1268 if (bt_event_class_get_log_level(ec
, &log_level
) ==
1269 BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
1270 const char *ll_str
= NULL
;
1272 switch (log_level
) {
1273 case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY
:
1274 ll_str
= "Emergency";
1276 case BT_EVENT_CLASS_LOG_LEVEL_ALERT
:
1279 case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL
:
1280 ll_str
= "Critical";
1282 case BT_EVENT_CLASS_LOG_LEVEL_ERROR
:
1285 case BT_EVENT_CLASS_LOG_LEVEL_WARNING
:
1288 case BT_EVENT_CLASS_LOG_LEVEL_NOTICE
:
1291 case BT_EVENT_CLASS_LOG_LEVEL_INFO
:
1294 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
:
1295 ll_str
= "Debug (system)";
1297 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
:
1298 ll_str
= "Debug (program)";
1300 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
:
1301 ll_str
= "Debug (process)";
1303 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
:
1304 ll_str
= "Debug (module)";
1306 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
:
1307 ll_str
= "Debug (unit)";
1309 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
:
1310 ll_str
= "Debug (function)";
1312 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
:
1313 ll_str
= "Debug (line)";
1315 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG
:
1322 write_str_prop_line(ctx
, "Log level", ll_str
);
1326 emf_uri
= bt_event_class_get_emf_uri(ec
);
1328 write_str_prop_line(ctx
, "EMF URI", emf_uri
);
1331 /* Write specific context field class */
1332 fc
= bt_event_class_borrow_specific_context_field_class_const(ec
);
1334 write_root_field_class(ctx
, "Specific context field class", fc
);
1337 /* Write payload field class */
1338 fc
= bt_event_class_borrow_payload_field_class_const(ec
);
1340 write_root_field_class(ctx
, "Payload field class", fc
);
1347 void write_clock_class_prop_lines(struct details_write_ctx
*ctx
,
1348 const bt_clock_class
*cc
)
1350 int64_t offset_seconds
;
1351 uint64_t offset_cycles
;
1354 str
= bt_clock_class_get_name(cc
);
1356 write_str_prop_line(ctx
, "Name", str
);
1359 write_user_attributes(ctx
,
1360 bt_clock_class_borrow_user_attributes_const(cc
), true, NULL
);
1361 str
= bt_clock_class_get_description(cc
);
1363 write_str_prop_line(ctx
, "Description", str
);
1366 write_uint_prop_line(ctx
, "Frequency (Hz)",
1367 bt_clock_class_get_frequency(cc
));
1368 write_uint_prop_line(ctx
, "Precision (cycles)",
1369 bt_clock_class_get_precision(cc
));
1370 bt_clock_class_get_offset(cc
, &offset_seconds
, &offset_cycles
);
1371 write_int_prop_line(ctx
, "Offset (s)", offset_seconds
);
1372 write_uint_prop_line(ctx
, "Offset (cycles)", offset_cycles
);
1373 write_bool_prop_line(ctx
, "Origin is Unix epoch",
1374 bt_clock_class_origin_is_unix_epoch(cc
));
1376 if (ctx
->details_comp
->cfg
.with_uuid
) {
1377 bt_uuid uuid
= bt_clock_class_get_uuid(cc
);
1380 write_uuid_prop_line(ctx
, "UUID", uuid
);
1386 gint
compare_event_classes(const bt_event_class
**a
, const bt_event_class
**b
)
1388 uint64_t id_a
= bt_event_class_get_id(*a
);
1389 uint64_t id_b
= bt_event_class_get_id(*b
);
1393 } else if (id_a
> id_b
) {
1401 void write_stream_class(struct details_write_ctx
*ctx
,
1402 const bt_stream_class
*sc
)
1404 const bt_field_class
*fc
;
1405 GPtrArray
*event_classes
= g_ptr_array_new();
1409 write_obj_type_name(ctx
, "Stream class");
1411 /* Write name and ID */
1412 if (ctx
->details_comp
->cfg
.with_stream_class_name
) {
1413 const char *name
= bt_stream_class_get_name(sc
);
1416 g_string_append(ctx
->str
, " `");
1417 write_str_prop_value(ctx
, name
);
1418 g_string_append(ctx
->str
, "`");
1422 g_string_append(ctx
->str
, " (ID ");
1423 write_uint_prop_value(ctx
, bt_stream_class_get_id(sc
));
1424 g_string_append(ctx
->str
, "):\n");
1426 /* Write properties */
1429 /* Write user attributes */
1430 write_user_attributes(ctx
,
1431 bt_stream_class_borrow_user_attributes_const(sc
), true, NULL
);
1433 /* Write configuration */
1434 write_bool_prop_line(ctx
,
1435 "Supports packets", bt_stream_class_supports_packets(sc
));
1437 if (bt_stream_class_supports_packets(sc
)) {
1438 write_bool_prop_line(ctx
,
1439 "Packets have beginning default clock snapshot",
1440 bt_stream_class_packets_have_beginning_default_clock_snapshot(sc
));
1441 write_bool_prop_line(ctx
,
1442 "Packets have end default clock snapshot",
1443 bt_stream_class_packets_have_end_default_clock_snapshot(sc
));
1446 write_bool_prop_line(ctx
,
1447 "Supports discarded events",
1448 bt_stream_class_supports_discarded_events(sc
));
1450 if (bt_stream_class_supports_discarded_events(sc
)) {
1451 write_bool_prop_line(ctx
,
1452 "Discarded events have default clock snapshots",
1453 bt_stream_class_discarded_events_have_default_clock_snapshots(sc
));
1456 write_bool_prop_line(ctx
,
1457 "Supports discarded packets",
1458 bt_stream_class_supports_discarded_packets(sc
));
1460 if (bt_stream_class_supports_discarded_packets(sc
)) {
1461 write_bool_prop_line(ctx
,
1462 "Discarded packets have default clock snapshots",
1463 bt_stream_class_discarded_packets_have_default_clock_snapshots(sc
));
1466 /* Write default clock class */
1467 if (bt_stream_class_borrow_default_clock_class_const(sc
)) {
1469 write_prop_name(ctx
, "Default clock class");
1470 g_string_append_c(ctx
->str
, ':');
1473 write_clock_class_prop_lines(ctx
,
1474 bt_stream_class_borrow_default_clock_class_const(sc
));
1478 fc
= bt_stream_class_borrow_packet_context_field_class_const(sc
);
1480 write_root_field_class(ctx
, "Packet context field class", fc
);
1483 fc
= bt_stream_class_borrow_event_common_context_field_class_const(sc
);
1485 write_root_field_class(ctx
, "Event common context field class",
1489 for (i
= 0; i
< bt_stream_class_get_event_class_count(sc
); i
++) {
1490 g_ptr_array_add(event_classes
,
1491 (gpointer
) bt_stream_class_borrow_event_class_by_index_const(
1495 g_ptr_array_sort(event_classes
, (GCompareFunc
) compare_event_classes
);
1497 for (i
= 0; i
< event_classes
->len
; i
++) {
1498 write_event_class(ctx
, event_classes
->pdata
[i
]);
1502 g_ptr_array_free(event_classes
, TRUE
);
1506 gint
compare_stream_classes(const bt_stream_class
**a
, const bt_stream_class
**b
)
1508 uint64_t id_a
= bt_stream_class_get_id(*a
);
1509 uint64_t id_b
= bt_stream_class_get_id(*b
);
1513 } else if (id_a
> id_b
) {
1521 void write_trace_class(struct details_write_ctx
*ctx
, const bt_trace_class
*tc
)
1523 GPtrArray
*stream_classes
= g_ptr_array_new();
1525 bool printed_prop
= false;
1528 write_obj_type_name(ctx
, "Trace class");
1531 for (i
= 0; i
< bt_trace_class_get_stream_class_count(tc
); i
++) {
1532 g_ptr_array_add(stream_classes
,
1533 (gpointer
) bt_trace_class_borrow_stream_class_by_index_const(
1537 g_ptr_array_sort(stream_classes
, (GCompareFunc
) compare_stream_classes
);
1539 if (stream_classes
->len
> 0) {
1540 if (!printed_prop
) {
1541 g_string_append(ctx
->str
, ":\n");
1542 printed_prop
= true;
1548 /* Write user attributes */
1549 write_user_attributes(ctx
,
1550 bt_trace_class_borrow_user_attributes_const(tc
), true,
1553 /* Write stream classes */
1554 for (i
= 0; i
< stream_classes
->len
; i
++) {
1555 write_stream_class(ctx
, stream_classes
->pdata
[i
]);
1558 if (!printed_prop
) {
1563 g_ptr_array_free(stream_classes
, TRUE
);
1567 int try_write_meta(struct details_write_ctx
*ctx
, const bt_trace_class
*tc
,
1568 const bt_stream_class
*sc
, const bt_event_class
*ec
)
1574 if (details_need_to_write_trace_class(ctx
, tc
)) {
1577 if (ctx
->details_comp
->cfg
.compact
&&
1578 ctx
->details_comp
->printed_something
) {
1580 * There are no empty line between messages in
1581 * compact mode, so write one here to decouple
1582 * the trace class from the next message.
1588 * write_trace_class() also writes all its stream
1589 * classes their event classes, so we don't need to
1592 write_trace_class(ctx
, tc
);
1595 * Mark this trace class as written, as well as all
1596 * its stream classes and their event classes.
1598 ret
= details_did_write_trace_class(ctx
, tc
);
1603 for (sc_i
= 0; sc_i
< bt_trace_class_get_stream_class_count(tc
);
1606 const bt_stream_class
*tc_sc
=
1607 bt_trace_class_borrow_stream_class_by_index_const(
1610 details_did_write_meta_object(ctx
, tc
, tc_sc
);
1612 for (ec_i
= 0; ec_i
<
1613 bt_stream_class_get_event_class_count(tc_sc
);
1615 details_did_write_meta_object(ctx
, tc
,
1616 bt_stream_class_borrow_event_class_by_index_const(
1624 if (sc
&& details_need_to_write_meta_object(ctx
, tc
, sc
)) {
1629 if (ctx
->details_comp
->cfg
.compact
&&
1630 ctx
->details_comp
->printed_something
) {
1632 * There are no empty line between messages in
1633 * compact mode, so write one here to decouple
1634 * the stream class from the next message.
1640 * write_stream_class() also writes all its event
1641 * classes, so we don't need to rewrite `ec`.
1643 write_stream_class(ctx
, sc
);
1646 * Mark this stream class as written, as well as all its
1649 details_did_write_meta_object(ctx
, tc
, sc
);
1651 for (ec_i
= 0; ec_i
<
1652 bt_stream_class_get_event_class_count(sc
);
1654 details_did_write_meta_object(ctx
, tc
,
1655 bt_stream_class_borrow_event_class_by_index_const(
1662 if (ec
&& details_need_to_write_meta_object(ctx
, tc
, ec
)) {
1665 if (ctx
->details_comp
->cfg
.compact
&&
1666 ctx
->details_comp
->printed_something
) {
1668 * There are no empty line between messages in
1669 * compact mode, so write one here to decouple
1670 * the event class from the next message.
1675 write_event_class(ctx
, ec
);
1676 details_did_write_meta_object(ctx
, tc
, ec
);
1685 void write_time_str(struct details_write_ctx
*ctx
, const char *str
)
1687 if (!ctx
->details_comp
->cfg
.with_time
) {
1691 g_string_append_printf(ctx
->str
, "[%s%s%s%s]",
1692 color_bold(ctx
), color_fg_blue(ctx
), str
, color_reset(ctx
));
1694 if (ctx
->details_comp
->cfg
.compact
) {
1705 void write_time(struct details_write_ctx
*ctx
, const bt_clock_snapshot
*cs
)
1707 bt_clock_snapshot_get_ns_from_origin_status cs_status
;
1708 int64_t ns_from_origin
;
1711 if (!ctx
->details_comp
->cfg
.with_time
) {
1715 format_uint(buf
, bt_clock_snapshot_get_value(cs
), 10);
1716 g_string_append_printf(ctx
->str
, "[%s%s%s%s%s",
1717 color_bold(ctx
), color_fg_blue(ctx
), buf
,
1719 ctx
->details_comp
->cfg
.compact
? "" : " cycles");
1720 cs_status
= bt_clock_snapshot_get_ns_from_origin(cs
, &ns_from_origin
);
1721 if (cs_status
== BT_CLOCK_SNAPSHOT_GET_NS_FROM_ORIGIN_STATUS_OK
) {
1722 format_int(buf
, ns_from_origin
, 10);
1723 g_string_append_printf(ctx
->str
, "%s %s%s%s%s%s",
1724 ctx
->details_comp
->cfg
.compact
? "" : ",",
1725 color_bold(ctx
), color_fg_blue(ctx
), buf
,
1727 ctx
->details_comp
->cfg
.compact
? "" : " ns from origin");
1730 g_string_append(ctx
->str
, "]");
1732 if (ctx
->details_comp
->cfg
.compact
) {
1743 int write_message_follow_tag(struct details_write_ctx
*ctx
,
1744 const bt_stream
*stream
)
1747 uint64_t unique_trace_id
;
1748 const bt_stream_class
*sc
= bt_stream_borrow_class_const(stream
);
1749 const bt_trace
*trace
= bt_stream_borrow_trace_const(stream
);
1751 ret
= details_trace_unique_id(ctx
, trace
, &unique_trace_id
);
1756 if (ctx
->details_comp
->cfg
.compact
) {
1757 g_string_append_printf(ctx
->str
,
1758 "%s{%s%" PRIu64
" %" PRIu64
" %" PRIu64
"%s%s}%s ",
1759 color_fg_cyan(ctx
), color_bold(ctx
),
1760 unique_trace_id
, bt_stream_class_get_id(sc
),
1761 bt_stream_get_id(stream
),
1762 color_reset(ctx
), color_fg_cyan(ctx
), color_reset(ctx
));
1764 g_string_append_printf(ctx
->str
,
1765 "%s{Trace %s%" PRIu64
"%s%s, Stream class ID %s%" PRIu64
"%s%s, Stream ID %s%" PRIu64
"%s%s}%s\n",
1767 color_bold(ctx
), unique_trace_id
,
1768 color_reset(ctx
), color_fg_cyan(ctx
),
1769 color_bold(ctx
), bt_stream_class_get_id(sc
),
1770 color_reset(ctx
), color_fg_cyan(ctx
),
1771 color_bold(ctx
), bt_stream_get_id(stream
),
1772 color_reset(ctx
), color_fg_cyan(ctx
),
1781 void write_field(struct details_write_ctx
*ctx
, const bt_field
*field
,
1785 bt_field_class_type fc_type
= bt_field_get_class_type(field
);
1786 const bt_field_class
*fc
;
1789 /* Write field's name */
1791 write_compound_member_name(ctx
, name
);
1794 /* Write field's value */
1795 if (fc_type
== BT_FIELD_CLASS_TYPE_BOOL
) {
1797 write_bool_prop_value(ctx
, bt_field_bool_get_value(field
));
1798 } else if (fc_type
== BT_FIELD_CLASS_TYPE_BIT_ARRAY
) {
1799 format_uint(buf
, bt_field_bit_array_get_value_as_integer(field
),
1802 write_uint_str_prop_value(ctx
, buf
);
1803 } else if (bt_field_class_type_is(fc_type
,
1804 BT_FIELD_CLASS_TYPE_INTEGER
)) {
1805 unsigned int fmt_base
;
1806 bt_field_class_integer_preferred_display_base base
;
1808 fc
= bt_field_borrow_class_const(field
);
1809 base
= bt_field_class_integer_get_preferred_display_base(fc
);
1812 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
:
1815 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
:
1818 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
:
1821 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
:
1828 if (bt_field_class_type_is(fc_type
,
1829 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
)) {
1831 bt_field_integer_unsigned_get_value(field
),
1834 write_uint_str_prop_value(ctx
, buf
);
1837 bt_field_integer_signed_get_value(field
),
1840 write_int_str_prop_value(ctx
, buf
);
1842 } else if (fc_type
== BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
) {
1844 write_float_prop_value(ctx
, bt_field_real_single_precision_get_value(field
));
1845 } else if (fc_type
== BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL
) {
1847 write_float_prop_value(ctx
, bt_field_real_double_precision_get_value(field
));
1848 } else if (fc_type
== BT_FIELD_CLASS_TYPE_STRING
) {
1850 write_str_prop_value(ctx
, bt_field_string_get_value(field
));
1851 } else if (fc_type
== BT_FIELD_CLASS_TYPE_STRUCTURE
) {
1852 uint64_t member_count
;
1854 fc
= bt_field_borrow_class_const(field
);
1855 member_count
= bt_field_class_structure_get_member_count(fc
);
1857 if (member_count
> 0) {
1860 for (i
= 0; i
< member_count
; i
++) {
1861 const bt_field_class_structure_member
*member
=
1862 bt_field_class_structure_borrow_member_by_index_const(
1864 const bt_field
*member_field
=
1865 bt_field_structure_borrow_member_field_by_index_const(
1869 write_field(ctx
, member_field
,
1870 bt_field_class_structure_member_get_name(member
));
1876 write_none_prop_value(ctx
, "Empty");
1878 } else if (bt_field_class_type_is(fc_type
, BT_FIELD_CLASS_TYPE_ARRAY
)) {
1879 uint64_t length
= bt_field_array_get_length(field
);
1883 write_none_prop_value(ctx
, "Empty");
1885 g_string_append(ctx
->str
, " Length ");
1886 write_uint_prop_value(ctx
, length
);
1887 g_string_append_c(ctx
->str
, ':');
1892 for (i
= 0; i
< length
; i
++) {
1893 const bt_field
*elem_field
=
1894 bt_field_array_borrow_element_field_by_index_const(
1898 write_array_index(ctx
, i
, color_fg_cyan(ctx
));
1899 write_field(ctx
, elem_field
, NULL
);
1903 } else if (bt_field_class_type_is(fc_type
,
1904 BT_FIELD_CLASS_TYPE_OPTION
)) {
1905 const bt_field
*content_field
=
1906 bt_field_option_borrow_field_const(field
);
1908 if (!content_field
) {
1910 write_none_prop_value(ctx
, "None");
1912 write_field(ctx
, content_field
, NULL
);
1914 } else if (bt_field_class_type_is(fc_type
,
1915 BT_FIELD_CLASS_TYPE_VARIANT
)) {
1917 bt_field_variant_borrow_selected_option_field_const(
1925 void write_root_field(struct details_write_ctx
*ctx
, const char *name
,
1926 const bt_field
*field
)
1928 BT_ASSERT_DBG(name
);
1929 BT_ASSERT_DBG(field
);
1931 write_prop_name(ctx
, name
);
1932 g_string_append(ctx
->str
, ":");
1933 write_field(ctx
, field
, NULL
);
1938 int write_event_message(struct details_write_ctx
*ctx
,
1939 const bt_message
*msg
)
1942 const bt_event
*event
= bt_message_event_borrow_event_const(msg
);
1943 const bt_stream
*stream
= bt_event_borrow_stream_const(event
);
1944 const bt_event_class
*ec
= bt_event_borrow_class_const(event
);
1945 const bt_stream_class
*sc
= bt_event_class_borrow_stream_class_const(ec
);
1946 const bt_trace_class
*tc
= bt_stream_class_borrow_trace_class_const(sc
);
1947 const char *ec_name
;
1948 const bt_field
*field
;
1950 ret
= try_write_meta(ctx
, tc
, sc
, ec
);
1955 if (!ctx
->details_comp
->cfg
.with_data
) {
1959 if (ctx
->str
->len
> 0) {
1961 * Output buffer contains metadata: separate blocks with
1968 if (bt_stream_class_borrow_default_clock_class_const(sc
)) {
1970 bt_message_event_borrow_default_clock_snapshot_const(
1974 /* Write follow tag for message */
1975 ret
= write_message_follow_tag(ctx
, stream
);
1980 /* Write object's basic properties */
1981 write_obj_type_name(ctx
, "Event");
1982 ec_name
= bt_event_class_get_name(ec
);
1984 g_string_append_printf(ctx
->str
, " `%s%s%s`",
1985 color_fg_green(ctx
), ec_name
, color_reset(ctx
));
1988 g_string_append(ctx
->str
, " (");
1990 if (!ctx
->details_comp
->cfg
.compact
) {
1991 g_string_append(ctx
->str
, "Class ID ");
1994 write_uint_prop_value(ctx
, bt_event_class_get_id(ec
));
1995 g_string_append(ctx
->str
, ")");
1997 if (ctx
->details_comp
->cfg
.compact
) {
2003 g_string_append(ctx
->str
, ":\n");
2005 field
= bt_event_borrow_common_context_field_const(event
);
2007 write_root_field(ctx
, "Common context", field
);
2010 field
= bt_event_borrow_specific_context_field_const(event
);
2012 write_root_field(ctx
, "Specific context", field
);
2015 field
= bt_event_borrow_payload_field_const(event
);
2017 write_root_field(ctx
, "Payload", field
);
2027 gint
compare_streams(const bt_stream
**a
, const bt_stream
**b
)
2029 uint64_t id_a
= bt_stream_get_id(*a
);
2030 uint64_t id_b
= bt_stream_get_id(*b
);
2034 } else if (id_a
> id_b
) {
2037 const bt_stream_class
*a_sc
= bt_stream_borrow_class_const(*a
);
2038 const bt_stream_class
*b_sc
= bt_stream_borrow_class_const(*b
);
2039 uint64_t a_sc_id
= bt_stream_class_get_id(a_sc
);
2040 uint64_t b_sc_id
= bt_stream_class_get_id(b_sc
);
2042 if (a_sc_id
< b_sc_id
) {
2044 } else if (a_sc_id
> b_sc_id
) {
2053 void write_trace(struct details_write_ctx
*ctx
, const bt_trace
*trace
)
2055 GPtrArray
*streams
= g_ptr_array_new();
2057 bool printed_prop
= false;
2058 GPtrArray
*env_names
= g_ptr_array_new();
2062 write_obj_type_name(ctx
, "Trace");
2065 if (ctx
->details_comp
->cfg
.with_trace_name
) {
2066 const char *name
= bt_trace_get_name(trace
);
2068 g_string_append(ctx
->str
, " `");
2069 write_str_prop_value(ctx
, name
);
2070 g_string_append(ctx
->str
, "`");
2074 /* Write properties */
2078 if (ctx
->details_comp
->cfg
.with_uuid
) {
2079 bt_uuid uuid
= bt_trace_get_uuid(trace
);
2082 if (!printed_prop
) {
2083 g_string_append(ctx
->str
, ":\n");
2084 printed_prop
= true;
2087 write_uuid_prop_line(ctx
, "UUID", uuid
);
2091 /* Write environment */
2092 env_count
= bt_trace_get_environment_entry_count(trace
);
2093 if (env_count
> 0) {
2094 if (!printed_prop
) {
2095 g_string_append(ctx
->str
, ":\n");
2096 printed_prop
= true;
2100 write_prop_name(ctx
, "Environment");
2101 g_string_append(ctx
->str
, " (");
2102 write_uint_prop_value(ctx
, env_count
);
2103 g_string_append_printf(ctx
->str
, " entr%s):",
2104 env_count
== 1 ? "y" : "ies");
2108 for (i
= 0; i
< env_count
; i
++) {
2110 const bt_value
*value
;
2112 bt_trace_borrow_environment_entry_by_index_const(
2113 trace
, i
, &name
, &value
);
2114 g_ptr_array_add(env_names
, (gpointer
) name
);
2117 g_ptr_array_sort(env_names
, (GCompareFunc
) compare_strings
);
2119 for (i
= 0; i
< env_names
->len
; i
++) {
2120 const char *name
= env_names
->pdata
[i
];
2121 const bt_value
*value
=
2122 bt_trace_borrow_environment_entry_value_by_name_const(
2125 BT_ASSERT_DBG(value
);
2126 write_compound_member_name(ctx
, name
);
2129 if (bt_value_get_type(value
) ==
2130 BT_VALUE_TYPE_SIGNED_INTEGER
) {
2131 write_int_prop_value(ctx
,
2132 bt_value_integer_signed_get(value
));
2133 } else if (bt_value_get_type(value
) ==
2134 BT_VALUE_TYPE_STRING
) {
2135 write_str_prop_value(ctx
,
2136 bt_value_string_get(value
));
2147 for (i
= 0; i
< bt_trace_get_stream_count(trace
); i
++) {
2148 g_ptr_array_add(streams
,
2149 (gpointer
) bt_trace_borrow_stream_by_index_const(
2153 g_ptr_array_sort(streams
, (GCompareFunc
) compare_streams
);
2155 if (streams
->len
> 0 && !printed_prop
) {
2156 g_string_append(ctx
->str
, ":\n");
2157 printed_prop
= true;
2160 for (i
= 0; i
< streams
->len
; i
++) {
2161 const bt_stream
*stream
= streams
->pdata
[i
];
2164 write_obj_type_name(ctx
, "Stream");
2165 g_string_append(ctx
->str
, " (ID ");
2166 write_uint_prop_value(ctx
, bt_stream_get_id(stream
));
2167 g_string_append(ctx
->str
, ", Class ID ");
2168 write_uint_prop_value(ctx
, bt_stream_class_get_id(
2169 bt_stream_borrow_class_const(stream
)));
2170 g_string_append(ctx
->str
, ")");
2176 if (!printed_prop
) {
2180 g_ptr_array_free(streams
, TRUE
);
2181 g_ptr_array_free(env_names
, TRUE
);
2185 int write_stream_beginning_message(struct details_write_ctx
*ctx
,
2186 const bt_message
*msg
)
2189 const bt_stream
*stream
=
2190 bt_message_stream_beginning_borrow_stream_const(msg
);
2191 const bt_trace
*trace
= bt_stream_borrow_trace_const(stream
);
2192 const bt_stream_class
*sc
= bt_stream_borrow_class_const(stream
);
2193 const bt_clock_class
*cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
2194 const bt_trace_class
*tc
= bt_stream_class_borrow_trace_class_const(sc
);
2197 ret
= try_write_meta(ctx
, tc
, sc
, NULL
);
2202 if (!ctx
->details_comp
->cfg
.with_data
) {
2206 if (ctx
->str
->len
> 0) {
2208 * Output buffer contains metadata: separate blocks with
2216 const bt_clock_snapshot
*cs
;
2217 bt_message_stream_clock_snapshot_state cs_state
=
2218 bt_message_stream_beginning_borrow_default_clock_snapshot_const(msg
, &cs
);
2220 if (cs_state
== BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
2221 write_time(ctx
, cs
);
2223 write_time_str(ctx
, "Unknown");
2227 /* Write follow tag for message */
2228 ret
= write_message_follow_tag(ctx
, stream
);
2233 /* Write stream properties */
2234 write_obj_type_name(ctx
, "Stream beginning");
2236 if (ctx
->details_comp
->cfg
.compact
) {
2241 g_string_append(ctx
->str
, ":\n");
2244 if (ctx
->details_comp
->cfg
.with_stream_name
) {
2245 name
= bt_stream_get_name(stream
);
2247 write_str_prop_line(ctx
, "Name", name
);
2251 if (ctx
->details_comp
->cfg
.with_stream_class_name
) {
2252 name
= bt_stream_class_get_name(sc
);
2254 write_str_prop_line(ctx
, "Class name", name
);
2258 write_trace(ctx
, trace
);
2266 int write_stream_end_message(struct details_write_ctx
*ctx
,
2267 const bt_message
*msg
)
2270 const bt_stream
*stream
=
2271 bt_message_stream_end_borrow_stream_const(msg
);
2272 const bt_stream_class
*sc
=
2273 bt_stream_borrow_class_const(stream
);
2274 const bt_clock_class
*cc
=
2275 bt_stream_class_borrow_default_clock_class_const(sc
);
2277 if (!ctx
->details_comp
->cfg
.with_data
) {
2283 const bt_clock_snapshot
*cs
;
2284 bt_message_stream_clock_snapshot_state cs_state
=
2285 bt_message_stream_end_borrow_default_clock_snapshot_const(msg
, &cs
);
2287 if (cs_state
== BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
2288 write_time(ctx
, cs
);
2290 write_time_str(ctx
, "Unknown");
2294 /* Write follow tag for message */
2295 ret
= write_message_follow_tag(ctx
, stream
);
2300 /* Write stream properties */
2301 write_obj_type_name(ctx
, "Stream end\n");
2308 int write_packet_beginning_message(struct details_write_ctx
*ctx
,
2309 const bt_message
*msg
)
2312 const bt_packet
*packet
=
2313 bt_message_packet_beginning_borrow_packet_const(msg
);
2314 const bt_stream
*stream
= bt_packet_borrow_stream_const(packet
);
2315 const bt_stream_class
*sc
= bt_stream_borrow_class_const(stream
);
2316 const bt_field
*field
;
2318 if (!ctx
->details_comp
->cfg
.with_data
) {
2323 if (bt_stream_class_packets_have_beginning_default_clock_snapshot(sc
)) {
2325 bt_message_packet_beginning_borrow_default_clock_snapshot_const(
2329 /* Write follow tag for message */
2330 ret
= write_message_follow_tag(ctx
, stream
);
2335 write_obj_type_name(ctx
, "Packet beginning");
2337 if (ctx
->details_comp
->cfg
.compact
) {
2343 field
= bt_packet_borrow_context_field_const(packet
);
2345 g_string_append(ctx
->str
, ":\n");
2347 write_root_field(ctx
, "Context", field
);
2358 int write_discarded_items_message(struct details_write_ctx
*ctx
,
2359 const char *name
, const bt_stream
*stream
,
2360 const bt_clock_snapshot
*beginning_cs
,
2361 const bt_clock_snapshot
*end_cs
, uint64_t count
)
2367 write_time(ctx
, beginning_cs
);
2368 BT_ASSERT_DBG(end_cs
);
2369 write_time(ctx
, end_cs
);
2372 /* Write follow tag for message */
2373 ret
= write_message_follow_tag(ctx
, stream
);
2378 write_obj_type_name(ctx
, "Discarded ");
2379 write_obj_type_name(ctx
, name
);
2382 if (count
== UINT64_C(-1)) {
2387 g_string_append(ctx
->str
, " (");
2388 write_uint_prop_value(ctx
, count
);
2389 g_string_append_printf(ctx
->str
, " %s)\n", name
);
2396 int write_discarded_events_message(struct details_write_ctx
*ctx
,
2397 const bt_message
*msg
)
2400 const bt_stream
*stream
= bt_message_discarded_events_borrow_stream_const(
2402 const bt_stream_class
*sc
= bt_stream_borrow_class_const(stream
);
2403 const bt_clock_snapshot
*beginning_cs
= NULL
;
2404 const bt_clock_snapshot
*end_cs
= NULL
;
2407 if (!ctx
->details_comp
->cfg
.with_data
) {
2411 if (bt_stream_class_discarded_events_have_default_clock_snapshots(sc
)) {
2413 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
2416 bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
2420 if (bt_message_discarded_events_get_count(msg
, &count
) !=
2421 BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
2422 count
= UINT64_C(-1);
2425 ret
= write_discarded_items_message(ctx
, "events", stream
,
2426 beginning_cs
, end_cs
, count
);
2433 int write_discarded_packets_message(struct details_write_ctx
*ctx
,
2434 const bt_message
*msg
)
2437 const bt_stream
*stream
= bt_message_discarded_packets_borrow_stream_const(
2439 const bt_stream_class
*sc
= bt_stream_borrow_class_const(stream
);
2440 const bt_clock_snapshot
*beginning_cs
= NULL
;
2441 const bt_clock_snapshot
*end_cs
= NULL
;
2444 if (!ctx
->details_comp
->cfg
.with_data
) {
2448 if (bt_stream_class_discarded_packets_have_default_clock_snapshots(sc
)) {
2450 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
2453 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
2457 if (bt_message_discarded_packets_get_count(msg
, &count
) !=
2458 BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
2459 count
= UINT64_C(-1);
2462 ret
= write_discarded_items_message(ctx
, "packets", stream
,
2463 beginning_cs
, end_cs
, count
);
2470 int write_packet_end_message(struct details_write_ctx
*ctx
,
2471 const bt_message
*msg
)
2474 const bt_packet
*packet
=
2475 bt_message_packet_end_borrow_packet_const(msg
);
2476 const bt_stream
*stream
= bt_packet_borrow_stream_const(packet
);
2477 const bt_stream_class
*sc
= bt_stream_borrow_class_const(stream
);
2479 if (!ctx
->details_comp
->cfg
.with_data
) {
2484 if (bt_stream_class_packets_have_end_default_clock_snapshot(sc
)) {
2486 bt_message_packet_end_borrow_default_clock_snapshot_const(
2490 /* Write follow tag for message */
2491 ret
= write_message_follow_tag(ctx
, stream
);
2496 write_obj_type_name(ctx
, "Packet end");
2504 int write_message_iterator_inactivity_message(struct details_write_ctx
*ctx
,
2505 const bt_message
*msg
)
2508 const bt_clock_snapshot
*cs
=
2509 bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
2513 write_time(ctx
, cs
);
2514 write_obj_type_name(ctx
, "Message iterator inactivity");
2516 if (ctx
->details_comp
->cfg
.compact
) {
2521 /* Write clock class properties */
2522 g_string_append(ctx
->str
, ":\n");
2525 write_prop_name(ctx
, "Clock class");
2526 g_string_append_c(ctx
->str
, ':');
2529 write_clock_class_prop_lines(ctx
,
2530 bt_clock_snapshot_borrow_clock_class_const(cs
));
2538 int details_write_message(struct details_comp
*details_comp
,
2539 const bt_message
*msg
)
2542 struct details_write_ctx ctx
= {
2543 .details_comp
= details_comp
,
2544 .str
= details_comp
->str
,
2548 /* Reset output buffer */
2549 g_string_assign(details_comp
->str
, "");
2551 switch (bt_message_get_type(msg
)) {
2552 case BT_MESSAGE_TYPE_EVENT
:
2553 ret
= write_event_message(&ctx
, msg
);
2555 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
2556 ret
= write_message_iterator_inactivity_message(&ctx
, msg
);
2558 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
2559 ret
= write_stream_beginning_message(&ctx
, msg
);
2561 case BT_MESSAGE_TYPE_STREAM_END
:
2562 ret
= write_stream_end_message(&ctx
, msg
);
2564 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
2565 ret
= write_packet_beginning_message(&ctx
, msg
);
2567 case BT_MESSAGE_TYPE_PACKET_END
:
2568 ret
= write_packet_end_message(&ctx
, msg
);
2570 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
2571 ret
= write_discarded_events_message(&ctx
, msg
);
2573 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
2574 ret
= write_discarded_packets_message(&ctx
, msg
);
2581 * If this component printed at least one character so far, and
2582 * we're not in compact mode, and there's something in the
2583 * output buffer for this message, then prepend a newline to the
2584 * output buffer to visually separate message blocks.
2586 if (details_comp
->printed_something
&& !details_comp
->cfg
.compact
&&
2587 details_comp
->str
->len
> 0) {
2588 /* TODO: Optimize this */
2589 g_string_prepend_c(details_comp
->str
, '\n');