2 * Copyright 2018 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 #define BT_LOG_TAG "LIB-LOGGING"
33 #include <babeltrace/lib-logging-internal.h>
34 #include <babeltrace/assert-pre-internal.h>
35 #include <babeltrace/common-internal.h>
36 #include <babeltrace/lib-logging-internal.h>
37 #include <babeltrace/value-internal.h>
38 #include <babeltrace/value-internal.h>
39 #include <babeltrace/object-pool-internal.h>
40 #include <babeltrace/trace-ir/field-class-internal.h>
41 #include <babeltrace/trace-ir/field-internal.h>
42 #include <babeltrace/trace-ir/event-class-internal.h>
43 #include <babeltrace/trace-ir/event-const.h>
44 #include <babeltrace/trace-ir/event-internal.h>
45 #include <babeltrace/trace-ir/packet-const.h>
46 #include <babeltrace/trace-ir/packet-internal.h>
47 #include <babeltrace/trace-ir/stream-class-internal.h>
48 #include <babeltrace/trace-ir/stream-internal.h>
49 #include <babeltrace/trace-ir/stream-const.h>
50 #include <babeltrace/trace-ir/trace-internal.h>
51 #include <babeltrace/trace-ir/trace-class-internal.h>
52 #include <babeltrace/trace-ir/clock-class-internal.h>
53 #include <babeltrace/trace-ir/clock-snapshot-internal.h>
54 #include <babeltrace/trace-ir/field-path-internal.h>
55 #include <babeltrace/trace-ir/utils-internal.h>
56 #include <babeltrace/graph/component-class-internal.h>
57 #include <babeltrace/graph/component-class-sink-colander-internal.h>
58 #include <babeltrace/graph/component-filter-internal.h>
59 #include <babeltrace/graph/component-internal.h>
60 #include <babeltrace/graph/component-sink-internal.h>
61 #include <babeltrace/graph/component-source-internal.h>
62 #include <babeltrace/graph/connection-internal.h>
63 #include <babeltrace/graph/graph-internal.h>
64 #include <babeltrace/graph/message-event-internal.h>
65 #include <babeltrace/graph/message-inactivity-internal.h>
66 #include <babeltrace/graph/message-internal.h>
67 #include <babeltrace/graph/message-iterator-internal.h>
68 #include <babeltrace/graph/message-packet-internal.h>
69 #include <babeltrace/graph/message-stream-internal.h>
70 #include <babeltrace/graph/message-stream-activity-internal.h>
71 #include <babeltrace/graph/message-discarded-items-internal.h>
72 #include <babeltrace/graph/port-internal.h>
73 #include <babeltrace/plugin/plugin-internal.h>
74 #include <babeltrace/plugin/plugin-so-internal.h>
76 #define LIB_LOGGING_BUF_SIZE (4096 * 4)
78 static char __thread lib_logging_buf
[LIB_LOGGING_BUF_SIZE
];
80 #define BUF_APPEND(_fmt, ...) \
83 size_t _size = LIB_LOGGING_BUF_SIZE - \
84 (size_t) (*buf_ch - lib_logging_buf); \
85 _count = snprintf(*buf_ch, _size, (_fmt), __VA_ARGS__); \
86 BT_ASSERT(_count >= 0); \
87 *buf_ch += MIN(_count, _size); \
88 if (*buf_ch >= lib_logging_buf + LIB_LOGGING_BUF_SIZE - 1) { \
93 #define BUF_APPEND_UUID(_uuid) \
95 BUF_APPEND(", %suuid=", prefix); \
96 format_uuid(buf_ch, (_uuid)); \
99 #define PRFIELD(_expr) prefix, (_expr)
101 #define PRFIELD_GSTRING(_expr) PRFIELD((_expr) ? (_expr)->str : NULL)
103 #define SET_TMP_PREFIX(_prefix2) \
105 strcpy(tmp_prefix, prefix); \
106 strcat(tmp_prefix, (_prefix2)); \
109 static inline void format_component(char **buf_ch
, bool extended
,
110 const char *prefix
, const struct bt_component
*component
);
112 static inline void format_port(char **buf_ch
, bool extended
,
113 const char *prefix
, const struct bt_port
*port
);
115 static inline void format_connection(char **buf_ch
, bool extended
,
116 const char *prefix
, const struct bt_connection
*connection
);
118 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
119 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
);
121 static inline void format_field_path(char **buf_ch
, bool extended
,
122 const char *prefix
, const struct bt_field_path
*field_path
);
124 static inline void format_object(char **buf_ch
, bool extended
,
125 const char *prefix
, const struct bt_object
*obj
)
127 BUF_APPEND(", %sref-count=%llu", prefix
, obj
->ref_count
);
130 static inline void format_uuid(char **buf_ch
, bt_uuid uuid
)
132 BUF_APPEND("\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
133 (unsigned int) uuid
[0],
134 (unsigned int) uuid
[1],
135 (unsigned int) uuid
[2],
136 (unsigned int) uuid
[3],
137 (unsigned int) uuid
[4],
138 (unsigned int) uuid
[5],
139 (unsigned int) uuid
[6],
140 (unsigned int) uuid
[7],
141 (unsigned int) uuid
[8],
142 (unsigned int) uuid
[9],
143 (unsigned int) uuid
[10],
144 (unsigned int) uuid
[11],
145 (unsigned int) uuid
[12],
146 (unsigned int) uuid
[13],
147 (unsigned int) uuid
[14],
148 (unsigned int) uuid
[15]);
151 static inline void format_object_pool(char **buf_ch
, bool extended
,
152 const char *prefix
, const struct bt_object_pool
*pool
)
154 BUF_APPEND(", %ssize=%zu", PRFIELD(pool
->size
));
157 BUF_APPEND(", %scap=%u", PRFIELD(pool
->objects
->len
));
161 static inline void format_integer_field_class(char **buf_ch
,
162 bool extended
, const char *prefix
,
163 const struct bt_field_class
*field_class
)
165 const struct bt_field_class_integer
*int_fc
=
166 (const void *) field_class
;
168 BUF_APPEND(", %srange-size=%" PRIu64
", %sbase=%s",
169 PRFIELD(int_fc
->range
),
170 PRFIELD(bt_common_field_class_integer_preferred_display_base_string(int_fc
->base
)));
173 static inline void format_array_field_class(char **buf_ch
,
174 bool extended
, const char *prefix
,
175 const struct bt_field_class
*field_class
)
177 const struct bt_field_class_array
*array_fc
=
178 (const void *) field_class
;
180 BUF_APPEND(", %selement-fc-addr=%p, %selement-fc-type=%s",
181 PRFIELD(array_fc
->element_fc
),
182 PRFIELD(bt_common_field_class_type_string(array_fc
->element_fc
->type
)));
185 static inline void format_field_class(char **buf_ch
, bool extended
,
186 const char *prefix
, const struct bt_field_class
*field_class
)
190 BUF_APPEND(", %stype=%s",
191 PRFIELD(bt_common_field_class_type_string(field_class
->type
)));
194 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field_class
->frozen
));
195 BUF_APPEND(", %sis-part-of-trace-class=%d",
196 PRFIELD(field_class
->part_of_trace_class
));
201 switch (field_class
->type
) {
202 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
203 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
205 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
208 case BT_FIELD_CLASS_TYPE_REAL
:
210 const struct bt_field_class_real
*real_fc
= (void *) field_class
;
212 BUF_APPEND(", %sis-single-precision=%d",
213 PRFIELD(real_fc
->is_single_precision
));
216 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
217 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
219 const struct bt_field_class_enumeration
*enum_fc
=
220 (const void *) field_class
;
222 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
223 BUF_APPEND(", %smapping-count=%u",
224 PRFIELD(enum_fc
->mappings
->len
));
227 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
229 const struct bt_field_class_structure
*struct_fc
=
230 (const void *) field_class
;
232 if (struct_fc
->common
.named_fcs
) {
233 BUF_APPEND(", %smember-count=%u",
234 PRFIELD(struct_fc
->common
.named_fcs
->len
));
239 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
241 const struct bt_field_class_static_array
*array_fc
=
242 (const void *) field_class
;
244 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
245 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_fc
->length
));
248 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
250 const struct bt_field_class_dynamic_array
*array_fc
=
251 (const void *) field_class
;
253 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
255 if (array_fc
->length_fc
) {
256 SET_TMP_PREFIX("length-fc-");
257 format_field_class(buf_ch
, extended
, tmp_prefix
,
258 array_fc
->length_fc
);
261 if (array_fc
->length_field_path
) {
262 SET_TMP_PREFIX("length-field-path-");
263 format_field_path(buf_ch
, extended
, tmp_prefix
,
264 array_fc
->length_field_path
);
269 case BT_FIELD_CLASS_TYPE_VARIANT
:
271 const struct bt_field_class_variant
*var_fc
=
272 (const void *) field_class
;
274 if (var_fc
->common
.named_fcs
) {
275 BUF_APPEND(", %soption-count=%u",
276 PRFIELD(var_fc
->common
.named_fcs
->len
));
279 if (var_fc
->selector_fc
) {
280 SET_TMP_PREFIX("selector-fc-");
281 format_field_class(buf_ch
, extended
, tmp_prefix
,
282 var_fc
->selector_fc
);
285 if (var_fc
->selector_field_path
) {
286 SET_TMP_PREFIX("selector-field-path-");
287 format_field_path(buf_ch
, extended
, tmp_prefix
,
288 var_fc
->selector_field_path
);
298 static inline void format_field_integer_extended(char **buf_ch
,
299 const char *prefix
, const struct bt_field
*field
)
301 const struct bt_field_integer
*integer
= (void *) field
;
302 const struct bt_field_class_integer
*field_class
=
303 (void *) field
->class;
304 const char *fmt
= NULL
;
306 BT_ASSERT(field_class
);
308 if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
) {
309 fmt
= ", %svalue=%" PRIo64
;
310 } else if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
) {
311 fmt
= ", %svalue=%" PRIx64
;
314 if (field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
315 field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
317 fmt
= ", %svalue=%" PRId64
;
320 BUF_APPEND(fmt
, PRFIELD(integer
->value
.i
));
323 fmt
= ", %svalue=%" PRIu64
;
326 BUF_APPEND(fmt
, PRFIELD(integer
->value
.u
));
330 static inline void format_field(char **buf_ch
, bool extended
,
331 const char *prefix
, const struct bt_field
*field
)
333 BUF_APPEND(", %sis-set=%d", PRFIELD(field
->is_set
));
336 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field
->frozen
));
339 BUF_APPEND(", %sclass-addr=%p", PRFIELD(field
->class));
345 BUF_APPEND(", %sclass-type=%s",
346 PRFIELD(bt_common_field_class_type_string(field
->class->type
)));
348 if (!extended
|| !field
->is_set
) {
352 switch (field
->class->type
) {
353 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
354 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
355 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
356 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
358 format_field_integer_extended(buf_ch
, prefix
, field
);
361 case BT_FIELD_CLASS_TYPE_REAL
:
363 const struct bt_field_real
*real_field
= (const void *) field
;
365 BUF_APPEND(", %svalue=%f", PRFIELD(real_field
->value
));
368 case BT_FIELD_CLASS_TYPE_STRING
:
370 const struct bt_field_string
*str
= (const void *) field
;
373 BT_ASSERT(str
->buf
->data
);
374 BUF_APPEND(", %spartial-value=\"%.32s\"",
375 PRFIELD(str
->buf
->data
));
380 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
381 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
383 const struct bt_field_array
*array_field
= (const void *) field
;
385 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_field
->length
));
387 if (array_field
->fields
) {
388 BUF_APPEND(", %sallocated-length=%u",
389 PRFIELD(array_field
->fields
->len
));
394 case BT_FIELD_CLASS_TYPE_VARIANT
:
396 const struct bt_field_variant
*var_field
= (const void *) field
;
398 BUF_APPEND(", %sselected-field-index=%" PRIu64
,
399 PRFIELD(var_field
->selected_index
));
407 static inline void format_field_path(char **buf_ch
, bool extended
,
408 const char *prefix
, const struct bt_field_path
*field_path
)
412 if (field_path
->indexes
) {
413 BT_ASSERT(field_path
->indexes
);
414 BUF_APPEND(", %sindex-count=%u",
415 PRFIELD(field_path
->indexes
->len
));
418 if (!extended
|| !field_path
->indexes
) {
422 BUF_APPEND(", %spath=[%s",
423 PRFIELD(bt_common_scope_string(field_path
->root
)));
425 for (i
= 0; i
< field_path
->indexes
->len
; i
++) {
426 uint64_t index
= bt_field_path_get_index_by_index_inline(
429 BUF_APPEND(", %" PRIu64
, index
);
432 BUF_APPEND("%s", "]");
435 static inline void format_trace_class(char **buf_ch
, bool extended
,
436 const char *prefix
, const struct bt_trace_class
*trace_class
)
438 if (trace_class
->name
.value
) {
439 BUF_APPEND(", %sname=\"%s\"",
440 PRFIELD(trace_class
->name
.value
));
447 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace_class
->frozen
));
449 if (trace_class
->uuid
.value
) {
450 BUF_APPEND_UUID(trace_class
->uuid
.value
);
453 if (trace_class
->stream_classes
) {
454 BUF_APPEND(", %sstream-class-count=%u",
455 PRFIELD(trace_class
->stream_classes
->len
));
458 BUF_APPEND(", %sassigns-auto-sc-id=%d",
459 PRFIELD(trace_class
->assigns_automatic_stream_class_id
));
462 static inline void format_trace(char **buf_ch
, bool extended
,
463 const char *prefix
, const struct bt_trace
*trace
)
467 if (trace
->name
.value
) {
468 BUF_APPEND(", %sname=\"%s\"", PRFIELD(trace
->name
.value
));
475 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace
->frozen
));
477 if (trace
->streams
) {
478 BUF_APPEND(", %sstream-count=%u",
479 PRFIELD(trace
->streams
->len
));
482 BUF_APPEND(", %sis-static=%d", PRFIELD(trace
->is_static
));
488 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace
->class));
489 SET_TMP_PREFIX("trace-class-");
490 format_trace_class(buf_ch
, false, tmp_prefix
, trace
->class);
493 static inline void format_stream_class(char **buf_ch
, bool extended
,
495 const struct bt_stream_class
*stream_class
)
497 const struct bt_trace_class
*trace_class
;
500 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream_class
->id
));
502 if (stream_class
->name
.value
) {
503 BUF_APPEND(", %sname=\"%s\"",
504 PRFIELD(stream_class
->name
.value
));
511 BUF_APPEND(", %sis-frozen=%d", PRFIELD(stream_class
->frozen
));
513 if (stream_class
->event_classes
) {
514 BUF_APPEND(", %sevent-class-count=%u",
515 PRFIELD(stream_class
->event_classes
->len
));
518 BUF_APPEND(", %spacket-context-fc-addr=%p, "
519 "%sevent-common-context-fc-addr=%p",
520 PRFIELD(stream_class
->packet_context_fc
),
521 PRFIELD(stream_class
->event_common_context_fc
));
522 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
527 BUF_APPEND(", %sassigns-auto-ec-id=%d, %sassigns-auto-stream-id=%d, "
528 "%spackets-have-discarded-ev-counter-snapshot=%d, "
529 "%spackets-have-packet-counter-snapshot=%d, "
530 "%spackets-have-default-begin-cs=%d, "
531 "%spackets-have-default-end-cs=%d",
532 PRFIELD(stream_class
->assigns_automatic_event_class_id
),
533 PRFIELD(stream_class
->assigns_automatic_stream_id
),
534 PRFIELD(stream_class
->packets_have_discarded_event_counter_snapshot
),
535 PRFIELD(stream_class
->packets_have_packet_counter_snapshot
),
536 PRFIELD(stream_class
->packets_have_default_beginning_cs
),
537 PRFIELD(stream_class
->packets_have_default_end_cs
));
538 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
539 SET_TMP_PREFIX("trace-class-");
540 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
541 SET_TMP_PREFIX("pcf-pool-");
542 format_object_pool(buf_ch
, extended
, prefix
,
543 &stream_class
->packet_context_field_pool
);
546 static inline void format_event_class(char **buf_ch
, bool extended
,
547 const char *prefix
, const struct bt_event_class
*event_class
)
549 const struct bt_stream_class
*stream_class
;
550 const struct bt_trace_class
*trace_class
;
553 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(event_class
->id
));
555 if (event_class
->name
.value
) {
556 BUF_APPEND(", %sname=\"%s\"",
557 PRFIELD(event_class
->name
.value
));
564 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class
->frozen
));
566 if (event_class
->log_level
.base
.avail
) {
567 BUF_APPEND(", %slog-level=%s",
568 PRFIELD(bt_common_event_class_log_level_string(
569 (int) event_class
->log_level
.value
)));
572 if (event_class
->emf_uri
.value
) {
573 BUF_APPEND(", %semf-uri=\"%s\"",
574 PRFIELD(event_class
->emf_uri
.value
));
577 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
578 PRFIELD(event_class
->specific_context_fc
),
579 PRFIELD(event_class
->payload_fc
));
581 stream_class
= bt_event_class_borrow_stream_class_const(event_class
);
586 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
587 SET_TMP_PREFIX("stream-class-");
588 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
589 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
594 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
595 SET_TMP_PREFIX("trace-class-");
596 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
597 SET_TMP_PREFIX("event-pool-");
598 format_object_pool(buf_ch
, extended
, prefix
, &event_class
->event_pool
);
601 static inline void format_stream(char **buf_ch
, bool extended
,
602 const char *prefix
, const struct bt_stream
*stream
)
604 const struct bt_stream_class
*stream_class
;
605 const struct bt_trace_class
*trace_class
= NULL
;
606 const struct bt_trace
*trace
= NULL
;
609 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream
->id
));
611 if (stream
->name
.value
) {
612 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream
->name
.value
));
619 stream_class
= bt_stream_borrow_class_const(stream
);
621 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
622 SET_TMP_PREFIX("stream-class-");
623 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
624 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
628 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
629 SET_TMP_PREFIX("trace-class-");
630 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
633 trace
= bt_stream_borrow_trace_inline(stream
);
635 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace
));
636 SET_TMP_PREFIX("trace-");
637 format_trace(buf_ch
, false, tmp_prefix
, trace
);
640 SET_TMP_PREFIX("packet-pool-");
641 format_object_pool(buf_ch
, extended
, prefix
, &stream
->packet_pool
);
644 static inline void format_packet(char **buf_ch
, bool extended
,
645 const char *prefix
, const struct bt_packet
*packet
)
647 const struct bt_stream
*stream
;
648 const struct bt_trace_class
*trace_class
;
655 BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
656 PRFIELD(packet
->frozen
),
657 PRFIELD(packet
->context_field
? packet
->context_field
->field
: NULL
));
658 stream
= bt_packet_borrow_stream_const(packet
);
663 if (packet
->default_beginning_cs
) {
664 SET_TMP_PREFIX("default-begin-cs-");
665 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
666 packet
->default_beginning_cs
);
669 if (packet
->default_end_cs
) {
670 SET_TMP_PREFIX("default-end-cs-");
671 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
672 packet
->default_end_cs
);
675 if (packet
->discarded_event_counter_snapshot
.base
.avail
) {
676 BUF_APPEND(", %sdiscarded-ev-counter-snapshot=%" PRIu64
,
677 PRFIELD(packet
->discarded_event_counter_snapshot
.value
));
680 if (packet
->packet_counter_snapshot
.base
.avail
) {
681 BUF_APPEND(", %spacket-counter-snapshot=%" PRIu64
,
682 PRFIELD(packet
->packet_counter_snapshot
.value
));
685 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
686 SET_TMP_PREFIX("stream-");
687 format_stream(buf_ch
, false, tmp_prefix
, stream
);
688 trace_class
= (const struct bt_trace_class
*) bt_object_borrow_parent(&stream
->base
);
693 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
694 SET_TMP_PREFIX("trace-class-");
695 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
698 static inline void format_event(char **buf_ch
, bool extended
,
699 const char *prefix
, const struct bt_event
*event
)
701 const struct bt_packet
*packet
;
702 const struct bt_stream
*stream
;
703 const struct bt_trace_class
*trace_class
;
704 const struct bt_stream_class
*stream_class
;
711 BUF_APPEND(", %sis-frozen=%d, "
712 "%scommon-context-field-addr=%p, "
713 "%sspecific-context-field-addr=%p, "
714 "%spayload-field-addr=%p, ",
715 PRFIELD(event
->frozen
),
716 PRFIELD(event
->common_context_field
),
717 PRFIELD(event
->specific_context_field
),
718 PRFIELD(event
->payload_field
));
719 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event
->class));
725 SET_TMP_PREFIX("event-class-");
726 format_event_class(buf_ch
, false, tmp_prefix
, event
->class);
727 stream_class
= bt_event_class_borrow_stream_class(event
->class);
729 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
730 SET_TMP_PREFIX("stream-class-");
731 format_stream_class(buf_ch
, false, tmp_prefix
,
734 trace_class
= bt_stream_class_borrow_trace_class_inline(
737 BUF_APPEND(", %strace-class-addr=%p",
738 PRFIELD(trace_class
));
739 SET_TMP_PREFIX("trace-class-");
740 format_trace_class(buf_ch
, false, tmp_prefix
,
745 if (event
->default_cs
) {
746 SET_TMP_PREFIX("default-cs-");
747 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
751 packet
= bt_event_borrow_packet_const(event
);
756 BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet
));
757 SET_TMP_PREFIX("packet-");
758 format_packet(buf_ch
, false, tmp_prefix
, packet
);
759 stream
= bt_packet_borrow_stream_const(packet
);
764 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
765 SET_TMP_PREFIX("stream-");
766 format_stream(buf_ch
, false, tmp_prefix
, stream
);
769 static inline void format_clock_class(char **buf_ch
, bool extended
,
770 const char *prefix
, const struct bt_clock_class
*clock_class
)
774 if (clock_class
->name
.value
) {
775 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class
->name
.value
));
778 BUF_APPEND(", %sfreq=%" PRIu64
, PRFIELD(clock_class
->frequency
));
784 if (clock_class
->description
.value
) {
785 BUF_APPEND(", %spartial-descr=\"%.32s\"",
786 PRFIELD(clock_class
->description
.value
));
789 if (clock_class
->uuid
.value
) {
790 BUF_APPEND_UUID(clock_class
->uuid
.value
);
793 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64
", "
794 "%soffset-s=%" PRId64
", "
795 "%soffset-cycles=%" PRIu64
", %sis-absolute=%d, "
796 "%sbase-offset-ns=%" PRId64
,
797 PRFIELD(clock_class
->frozen
), PRFIELD(clock_class
->precision
),
798 PRFIELD(clock_class
->offset_seconds
),
799 PRFIELD(clock_class
->offset_cycles
),
800 PRFIELD(clock_class
->is_absolute
),
801 PRFIELD(clock_class
->base_offset
.value_ns
));
803 SET_TMP_PREFIX("cs-pool-");
804 format_object_pool(buf_ch
, extended
, prefix
, &clock_class
->cs_pool
);
807 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
808 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
)
811 BUF_APPEND(", %svalue=%" PRIu64
", %sns-from-origin=%" PRId64
,
812 PRFIELD(clock_snapshot
->value_cycles
),
813 PRFIELD(clock_snapshot
->ns_from_origin
));
819 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot
->is_set
));
821 if (clock_snapshot
->clock_class
) {
822 BUF_APPEND(", %sclock-class-addr=%p",
823 PRFIELD(clock_snapshot
->clock_class
));
824 SET_TMP_PREFIX("clock-class-");
825 format_clock_class(buf_ch
, false, tmp_prefix
,
826 clock_snapshot
->clock_class
);
830 static inline void format_value(char **buf_ch
, bool extended
,
831 const char *prefix
, const struct bt_value
*value
)
833 BUF_APPEND(", %stype=%s",
834 PRFIELD(bt_common_value_type_string(bt_value_get_type(value
))));
840 switch (bt_value_get_type(value
)) {
841 case BT_VALUE_TYPE_BOOL
:
843 bt_bool val
= bt_value_bool_get(value
);
845 BUF_APPEND(", %svalue=%d", PRFIELD(val
));
848 case BT_VALUE_TYPE_INTEGER
:
850 int64_t val
= bt_value_integer_get(value
);
852 BUF_APPEND(", %svalue=%" PRId64
, PRFIELD(val
));
855 case BT_VALUE_TYPE_REAL
:
857 double val
= bt_value_real_get(value
);
859 BUF_APPEND(", %svalue=%f", PRFIELD(val
));
862 case BT_VALUE_TYPE_STRING
:
864 const char *val
= bt_value_string_get(value
);
866 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val
));
869 case BT_VALUE_TYPE_ARRAY
:
871 int64_t count
= bt_value_array_get_size(value
);
873 BT_ASSERT(count
>= 0);
874 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
877 case BT_VALUE_TYPE_MAP
:
879 int64_t count
= bt_value_map_get_size(value
);
881 BT_ASSERT(count
>= 0);
882 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
890 static inline void format_message(char **buf_ch
, bool extended
,
891 const char *prefix
, const struct bt_message
*msg
)
895 BUF_APPEND(", %stype=%s",
896 PRFIELD(bt_message_type_string(msg
->type
)));
902 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
903 PRFIELD(msg
->frozen
), PRFIELD(msg
->graph
));
906 case BT_MESSAGE_TYPE_EVENT
:
908 const struct bt_message_event
*msg_event
=
911 if (msg_event
->event
) {
912 SET_TMP_PREFIX("event-");
913 format_event(buf_ch
, true, tmp_prefix
,
919 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
920 case BT_MESSAGE_TYPE_STREAM_END
:
922 const struct bt_message_stream
*msg_stream
= (const void *) msg
;
924 if (msg_stream
->stream
) {
925 SET_TMP_PREFIX("stream-");
926 format_stream(buf_ch
, true, tmp_prefix
,
932 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
933 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
935 const struct bt_message_stream_activity
*msg_stream_activity
=
938 if (msg_stream_activity
->stream
) {
939 SET_TMP_PREFIX("stream-");
940 format_stream(buf_ch
, true, tmp_prefix
,
941 msg_stream_activity
->stream
);
944 BUF_APPEND(", %sdefault-cs-state=%s",
945 PRFIELD(bt_message_stream_activity_clock_snapshot_state_string(
946 msg_stream_activity
->default_cs_state
)));
948 if (msg_stream_activity
->default_cs
) {
949 SET_TMP_PREFIX("default-cs-");
950 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
951 msg_stream_activity
->default_cs
);
956 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
957 case BT_MESSAGE_TYPE_PACKET_END
:
959 const struct bt_message_packet
*msg_packet
= (const void *) msg
;
961 if (msg_packet
->packet
) {
962 SET_TMP_PREFIX("packet-");
963 format_packet(buf_ch
, true, tmp_prefix
,
969 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
970 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
972 const struct bt_message_discarded_items
*msg_disc_items
=
975 if (msg_disc_items
->stream
) {
976 SET_TMP_PREFIX("stream-");
977 format_stream(buf_ch
, true, tmp_prefix
,
978 msg_disc_items
->stream
);
981 if (msg_disc_items
->default_begin_cs
) {
982 SET_TMP_PREFIX("default-begin-cs-");
983 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
984 msg_disc_items
->default_begin_cs
);
987 if (msg_disc_items
->default_end_cs
) {
988 SET_TMP_PREFIX("default-end-cs-");
989 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
990 msg_disc_items
->default_end_cs
);
993 if (msg_disc_items
->count
.base
.avail
) {
994 BUF_APPEND(", %scount=%" PRIu64
,
995 PRFIELD(msg_disc_items
->count
.value
));
1005 static inline void format_plugin_so_shared_lib_handle(char **buf_ch
,
1007 const struct bt_plugin_so_shared_lib_handle
*handle
)
1009 BUF_APPEND(", %saddr=%p", PRFIELD(handle
));
1012 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle
->path
));
1016 static inline void format_component_class(char **buf_ch
, bool extended
,
1018 const struct bt_component_class
*comp_class
)
1020 char tmp_prefix
[64];
1022 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1023 PRFIELD(bt_component_class_type_string(comp_class
->type
)),
1024 PRFIELD_GSTRING(comp_class
->name
));
1026 if (comp_class
->description
) {
1027 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1028 PRFIELD_GSTRING(comp_class
->description
));
1035 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class
->frozen
));
1037 if (comp_class
->so_handle
) {
1038 SET_TMP_PREFIX("so-handle-");
1039 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1040 comp_class
->so_handle
);
1044 static inline void format_component(char **buf_ch
, bool extended
,
1045 const char *prefix
, const struct bt_component
*component
)
1047 char tmp_prefix
[64];
1049 BUF_APPEND(", %sname=\"%s\"",
1050 PRFIELD_GSTRING(component
->name
));
1052 if (component
->class) {
1053 SET_TMP_PREFIX("class-");
1054 format_component_class(buf_ch
, extended
, tmp_prefix
,
1062 if (component
->input_ports
) {
1063 BUF_APPEND(", %sinput-port-count=%u",
1064 PRFIELD(component
->input_ports
->len
));
1067 if (component
->output_ports
) {
1068 BUF_APPEND(", %soutput-port-count=%u",
1069 PRFIELD(component
->output_ports
->len
));
1073 static inline void format_port(char **buf_ch
, bool extended
,
1074 const char *prefix
, const struct bt_port
*port
)
1076 char tmp_prefix
[64];
1078 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1079 PRFIELD(bt_port_type_string(port
->type
)),
1080 PRFIELD_GSTRING(port
->name
));
1086 if (port
->connection
) {
1087 SET_TMP_PREFIX("conn-");
1088 format_connection(buf_ch
, false, tmp_prefix
, port
->connection
);
1092 static inline void format_connection(char **buf_ch
, bool extended
,
1093 const char *prefix
, const struct bt_connection
*connection
)
1095 char tmp_prefix
[64];
1101 if (connection
->upstream_port
) {
1102 SET_TMP_PREFIX("upstream-port-");
1103 format_port(buf_ch
, false, tmp_prefix
,
1104 connection
->upstream_port
);
1107 if (connection
->downstream_port
) {
1108 SET_TMP_PREFIX("downstream-port-");
1109 format_port(buf_ch
, false, tmp_prefix
,
1110 connection
->downstream_port
);
1114 static inline void format_graph(char **buf_ch
, bool extended
,
1115 const char *prefix
, const struct bt_graph
*graph
)
1117 char tmp_prefix
[64];
1119 BUF_APPEND(", %sis-canceled=%d", PRFIELD(graph
->canceled
));
1125 if (graph
->components
) {
1126 BUF_APPEND(", %scomp-count=%u",
1127 PRFIELD(graph
->components
->len
));
1130 if (graph
->connections
) {
1131 BUF_APPEND(", %sconn-count=%u",
1132 PRFIELD(graph
->connections
->len
));
1135 SET_TMP_PREFIX("en-pool-");
1136 format_object_pool(buf_ch
, extended
, prefix
,
1137 &graph
->event_msg_pool
);
1138 SET_TMP_PREFIX("pbn-pool-");
1139 format_object_pool(buf_ch
, extended
, prefix
,
1140 &graph
->packet_begin_msg_pool
);
1141 SET_TMP_PREFIX("pen-pool-");
1142 format_object_pool(buf_ch
, extended
, prefix
,
1143 &graph
->packet_end_msg_pool
);
1146 static inline void format_message_iterator(char **buf_ch
,
1147 bool extended
, const char *prefix
,
1148 const struct bt_message_iterator
*iterator
)
1151 char tmp_prefix
[64];
1153 if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
) {
1154 type
= "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1155 } else if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
) {
1156 type
= "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1161 BUF_APPEND(", %stype=%s", PRFIELD(type
));
1163 switch (iterator
->type
) {
1164 case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
:
1166 const struct bt_self_component_port_input_message_iterator
*
1167 port_in_iter
= (const void *) iterator
;
1169 if (port_in_iter
->upstream_component
) {
1170 SET_TMP_PREFIX("upstream-comp-");
1171 format_component(buf_ch
, false, tmp_prefix
,
1172 port_in_iter
->upstream_component
);
1175 if (port_in_iter
->upstream_port
) {
1176 SET_TMP_PREFIX("upstream-port-");
1177 format_port(buf_ch
, false, tmp_prefix
,
1178 port_in_iter
->upstream_port
);
1181 if (port_in_iter
->connection
) {
1182 SET_TMP_PREFIX("upstream-conn-");
1183 format_connection(buf_ch
, false, tmp_prefix
,
1184 port_in_iter
->connection
);
1188 case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
:
1190 const struct bt_port_output_message_iterator
*port_out_iter
=
1191 (const void *) iterator
;
1193 if (port_out_iter
->graph
) {
1194 SET_TMP_PREFIX("graph-");
1195 format_graph(buf_ch
, false, tmp_prefix
,
1196 port_out_iter
->graph
);
1199 if (port_out_iter
->colander
) {
1200 SET_TMP_PREFIX("colander-comp-");
1201 format_component(buf_ch
, false, tmp_prefix
,
1202 (void *) port_out_iter
->colander
);
1212 static inline void format_plugin(char **buf_ch
, bool extended
,
1213 const char *prefix
, const struct bt_plugin
*plugin
)
1215 char tmp_prefix
[64];
1217 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin
->type
)));
1219 if (plugin
->info
.path_set
) {
1220 BUF_APPEND(", %spath=\"%s\"",
1221 PRFIELD_GSTRING(plugin
->info
.path
));
1224 if (plugin
->info
.name_set
) {
1225 BUF_APPEND(", %sname=\"%s\"",
1226 PRFIELD_GSTRING(plugin
->info
.name
));
1233 if (plugin
->info
.author_set
) {
1234 BUF_APPEND(", %sauthor=\"%s\"",
1235 PRFIELD_GSTRING(plugin
->info
.author
));
1238 if (plugin
->info
.license_set
) {
1239 BUF_APPEND(", %slicense=\"%s\"",
1240 PRFIELD_GSTRING(plugin
->info
.license
));
1243 if (plugin
->info
.version_set
) {
1244 BUF_APPEND(", %sversion=%u.%u.%u%s",
1245 PRFIELD(plugin
->info
.version
.major
),
1246 plugin
->info
.version
.minor
,
1247 plugin
->info
.version
.patch
,
1248 plugin
->info
.version
.extra
?
1249 plugin
->info
.version
.extra
->str
: "");
1252 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1253 "%ssink-comp-class-count=%u",
1254 PRFIELD(plugin
->src_comp_classes
->len
),
1255 PRFIELD(plugin
->flt_comp_classes
->len
),
1256 PRFIELD(plugin
->sink_comp_classes
->len
));
1258 if (plugin
->spec_data
) {
1259 const struct bt_plugin_so_spec_data
*spec_data
=
1260 (const void *) plugin
->spec_data
;
1262 if (spec_data
->shared_lib_handle
) {
1263 SET_TMP_PREFIX("so-handle-");
1264 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1265 spec_data
->shared_lib_handle
);
1270 static inline void handle_conversion_specifier_bt(void *priv_data
,
1271 char **buf_ch
, size_t avail_size
,
1272 const char **out_fmt_ch
, va_list *args
)
1274 const char *fmt_ch
= *out_fmt_ch
;
1275 bool extended
= false;
1277 char *prefix_ch
= prefix
;
1283 if (*fmt_ch
== 'u') {
1285 obj
= va_arg(*args
, void *);
1286 format_uuid(buf_ch
, obj
);
1290 if (*fmt_ch
== '[') {
1295 if (*fmt_ch
== ']') {
1301 *prefix_ch
= *fmt_ch
;
1309 if (*fmt_ch
== '+') {
1314 obj
= va_arg(*args
, void *);
1315 BUF_APPEND("%saddr=%p", prefix
, obj
);
1323 format_field_class(buf_ch
, extended
, prefix
, obj
);
1326 format_field(buf_ch
, extended
, prefix
, obj
);
1329 format_field_path(buf_ch
, extended
, prefix
, obj
);
1332 format_event_class(buf_ch
, extended
, prefix
, obj
);
1335 format_event(buf_ch
, extended
, prefix
, obj
);
1338 format_stream_class(buf_ch
, extended
, prefix
, obj
);
1341 format_stream(buf_ch
, extended
, prefix
, obj
);
1344 format_packet(buf_ch
, extended
, prefix
, obj
);
1347 format_trace(buf_ch
, extended
, prefix
, obj
);
1350 format_trace_class(buf_ch
, extended
, prefix
, obj
);
1353 format_clock_class(buf_ch
, extended
, prefix
, obj
);
1356 format_clock_snapshot(buf_ch
, extended
, prefix
, obj
);
1359 format_value(buf_ch
, extended
, prefix
, obj
);
1362 format_message(buf_ch
, extended
, prefix
, obj
);
1365 format_message_iterator(buf_ch
, extended
, prefix
, obj
);
1368 format_component_class(buf_ch
, extended
, prefix
, obj
);
1371 format_component(buf_ch
, extended
, prefix
, obj
);
1374 format_port(buf_ch
, extended
, prefix
, obj
);
1377 format_connection(buf_ch
, extended
, prefix
, obj
);
1380 format_plugin(buf_ch
, extended
, prefix
, obj
);
1383 format_graph(buf_ch
, extended
, prefix
, obj
);
1386 format_object_pool(buf_ch
, extended
, prefix
, obj
);
1389 format_object(buf_ch
, extended
, prefix
, obj
);
1397 *out_fmt_ch
= fmt_ch
;
1401 void bt_lib_log(const char *func
, const char *file
, unsigned line
,
1402 int lvl
, const char *tag
, const char *fmt
, ...)
1407 va_start(args
, fmt
);
1408 bt_common_custom_vsnprintf(lib_logging_buf
, LIB_LOGGING_BUF_SIZE
, '!',
1409 handle_conversion_specifier_bt
, NULL
, fmt
, &args
);
1411 _bt_log_write_d(func
, file
, line
, lvl
, tag
, "%s", lib_logging_buf
);