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/port-internal.h>
72 #include <babeltrace/plugin/plugin-internal.h>
73 #include <babeltrace/plugin/plugin-so-internal.h>
75 #define LIB_LOGGING_BUF_SIZE (4096 * 4)
77 static char __thread lib_logging_buf
[LIB_LOGGING_BUF_SIZE
];
79 #define BUF_APPEND(_fmt, ...) \
82 size_t _size = LIB_LOGGING_BUF_SIZE - \
83 (size_t) (*buf_ch - lib_logging_buf); \
84 _count = snprintf(*buf_ch, _size, (_fmt), __VA_ARGS__); \
85 BT_ASSERT(_count >= 0); \
86 *buf_ch += MIN(_count, _size); \
87 if (*buf_ch >= lib_logging_buf + LIB_LOGGING_BUF_SIZE - 1) { \
92 #define BUF_APPEND_UUID(_uuid) \
94 BUF_APPEND(", %suuid=", prefix); \
95 format_uuid(buf_ch, (_uuid)); \
98 #define PRFIELD(_expr) prefix, (_expr)
100 #define PRFIELD_GSTRING(_expr) PRFIELD((_expr) ? (_expr)->str : NULL)
102 #define SET_TMP_PREFIX(_prefix2) \
104 strcpy(tmp_prefix, prefix); \
105 strcat(tmp_prefix, (_prefix2)); \
108 static inline void format_component(char **buf_ch
, bool extended
,
109 const char *prefix
, const struct bt_component
*component
);
111 static inline void format_port(char **buf_ch
, bool extended
,
112 const char *prefix
, const struct bt_port
*port
);
114 static inline void format_connection(char **buf_ch
, bool extended
,
115 const char *prefix
, const struct bt_connection
*connection
);
117 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
118 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
);
120 static inline void format_field_path(char **buf_ch
, bool extended
,
121 const char *prefix
, const struct bt_field_path
*field_path
);
123 static inline void format_object(char **buf_ch
, bool extended
,
124 const char *prefix
, const struct bt_object
*obj
)
126 BUF_APPEND(", %sref-count=%llu", prefix
, obj
->ref_count
);
129 static inline void format_uuid(char **buf_ch
, bt_uuid uuid
)
131 BUF_APPEND("\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
132 (unsigned int) uuid
[0],
133 (unsigned int) uuid
[1],
134 (unsigned int) uuid
[2],
135 (unsigned int) uuid
[3],
136 (unsigned int) uuid
[4],
137 (unsigned int) uuid
[5],
138 (unsigned int) uuid
[6],
139 (unsigned int) uuid
[7],
140 (unsigned int) uuid
[8],
141 (unsigned int) uuid
[9],
142 (unsigned int) uuid
[10],
143 (unsigned int) uuid
[11],
144 (unsigned int) uuid
[12],
145 (unsigned int) uuid
[13],
146 (unsigned int) uuid
[14],
147 (unsigned int) uuid
[15]);
150 static inline void format_object_pool(char **buf_ch
, bool extended
,
151 const char *prefix
, const struct bt_object_pool
*pool
)
153 BUF_APPEND(", %ssize=%zu", PRFIELD(pool
->size
));
156 BUF_APPEND(", %scap=%u", PRFIELD(pool
->objects
->len
));
160 static inline void format_integer_field_class(char **buf_ch
,
161 bool extended
, const char *prefix
,
162 const struct bt_field_class
*field_class
)
164 const struct bt_field_class_integer
*int_fc
=
165 (const void *) field_class
;
167 BUF_APPEND(", %srange-size=%" PRIu64
", %sbase=%s",
168 PRFIELD(int_fc
->range
),
169 PRFIELD(bt_common_field_class_integer_preferred_display_base_string(int_fc
->base
)));
172 static inline void format_array_field_class(char **buf_ch
,
173 bool extended
, const char *prefix
,
174 const struct bt_field_class
*field_class
)
176 const struct bt_field_class_array
*array_fc
=
177 (const void *) field_class
;
179 BUF_APPEND(", %selement-fc-addr=%p, %selement-fc-type=%s",
180 PRFIELD(array_fc
->element_fc
),
181 PRFIELD(bt_common_field_class_type_string(array_fc
->element_fc
->type
)));
184 static inline void format_field_class(char **buf_ch
, bool extended
,
185 const char *prefix
, const struct bt_field_class
*field_class
)
189 BUF_APPEND(", %stype=%s",
190 PRFIELD(bt_common_field_class_type_string(field_class
->type
)));
193 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field_class
->frozen
));
194 BUF_APPEND(", %sis-part-of-trace-class=%d",
195 PRFIELD(field_class
->part_of_trace_class
));
200 switch (field_class
->type
) {
201 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
202 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
204 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
207 case BT_FIELD_CLASS_TYPE_REAL
:
209 const struct bt_field_class_real
*real_fc
= (void *) field_class
;
211 BUF_APPEND(", %sis-single-precision=%d",
212 PRFIELD(real_fc
->is_single_precision
));
215 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
216 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
218 const struct bt_field_class_enumeration
*enum_fc
=
219 (const void *) field_class
;
221 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
222 BUF_APPEND(", %smapping-count=%u",
223 PRFIELD(enum_fc
->mappings
->len
));
226 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
228 const struct bt_field_class_structure
*struct_fc
=
229 (const void *) field_class
;
231 if (struct_fc
->common
.named_fcs
) {
232 BUF_APPEND(", %smember-count=%u",
233 PRFIELD(struct_fc
->common
.named_fcs
->len
));
238 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
240 const struct bt_field_class_static_array
*array_fc
=
241 (const void *) field_class
;
243 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
244 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_fc
->length
));
247 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
249 const struct bt_field_class_dynamic_array
*array_fc
=
250 (const void *) field_class
;
252 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
254 if (array_fc
->length_fc
) {
255 SET_TMP_PREFIX("length-fc-");
256 format_field_class(buf_ch
, extended
, tmp_prefix
,
257 array_fc
->length_fc
);
260 if (array_fc
->length_field_path
) {
261 SET_TMP_PREFIX("length-field-path-");
262 format_field_path(buf_ch
, extended
, tmp_prefix
,
263 array_fc
->length_field_path
);
268 case BT_FIELD_CLASS_TYPE_VARIANT
:
270 const struct bt_field_class_variant
*var_fc
=
271 (const void *) field_class
;
273 if (var_fc
->common
.named_fcs
) {
274 BUF_APPEND(", %soption-count=%u",
275 PRFIELD(var_fc
->common
.named_fcs
->len
));
278 if (var_fc
->selector_fc
) {
279 SET_TMP_PREFIX("selector-fc-");
280 format_field_class(buf_ch
, extended
, tmp_prefix
,
281 var_fc
->selector_fc
);
284 if (var_fc
->selector_field_path
) {
285 SET_TMP_PREFIX("selector-field-path-");
286 format_field_path(buf_ch
, extended
, tmp_prefix
,
287 var_fc
->selector_field_path
);
297 static inline void format_field_integer_extended(char **buf_ch
,
298 const char *prefix
, const struct bt_field
*field
)
300 const struct bt_field_integer
*integer
= (void *) field
;
301 const struct bt_field_class_integer
*field_class
=
302 (void *) field
->class;
303 const char *fmt
= NULL
;
305 BT_ASSERT(field_class
);
307 if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
) {
308 fmt
= ", %svalue=%" PRIo64
;
309 } else if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
) {
310 fmt
= ", %svalue=%" PRIx64
;
313 if (field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
314 field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
316 fmt
= ", %svalue=%" PRId64
;
319 BUF_APPEND(fmt
, PRFIELD(integer
->value
.i
));
322 fmt
= ", %svalue=%" PRIu64
;
325 BUF_APPEND(fmt
, PRFIELD(integer
->value
.u
));
329 static inline void format_field(char **buf_ch
, bool extended
,
330 const char *prefix
, const struct bt_field
*field
)
332 BUF_APPEND(", %sis-set=%d", PRFIELD(field
->is_set
));
335 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field
->frozen
));
338 BUF_APPEND(", %sclass-addr=%p", PRFIELD(field
->class));
344 BUF_APPEND(", %sclass-type=%s",
345 PRFIELD(bt_common_field_class_type_string(field
->class->type
)));
347 if (!extended
|| !field
->is_set
) {
351 switch (field
->class->type
) {
352 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
353 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
354 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
355 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
357 format_field_integer_extended(buf_ch
, prefix
, field
);
360 case BT_FIELD_CLASS_TYPE_REAL
:
362 const struct bt_field_real
*real_field
= (const void *) field
;
364 BUF_APPEND(", %svalue=%f", PRFIELD(real_field
->value
));
367 case BT_FIELD_CLASS_TYPE_STRING
:
369 const struct bt_field_string
*str
= (const void *) field
;
372 BT_ASSERT(str
->buf
->data
);
373 BUF_APPEND(", %spartial-value=\"%.32s\"",
374 PRFIELD(str
->buf
->data
));
379 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
380 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
382 const struct bt_field_array
*array_field
= (const void *) field
;
384 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_field
->length
));
386 if (array_field
->fields
) {
387 BUF_APPEND(", %sallocated-length=%u",
388 PRFIELD(array_field
->fields
->len
));
393 case BT_FIELD_CLASS_TYPE_VARIANT
:
395 const struct bt_field_variant
*var_field
= (const void *) field
;
397 BUF_APPEND(", %sselected-field-index=%" PRIu64
,
398 PRFIELD(var_field
->selected_index
));
406 static inline void format_field_path(char **buf_ch
, bool extended
,
407 const char *prefix
, const struct bt_field_path
*field_path
)
411 if (field_path
->indexes
) {
412 BT_ASSERT(field_path
->indexes
);
413 BUF_APPEND(", %sindex-count=%u",
414 PRFIELD(field_path
->indexes
->len
));
417 if (!extended
|| !field_path
->indexes
) {
421 BUF_APPEND(", %spath=[%s",
422 PRFIELD(bt_common_scope_string(field_path
->root
)));
424 for (i
= 0; i
< field_path
->indexes
->len
; i
++) {
425 uint64_t index
= bt_field_path_get_index_by_index_inline(
428 BUF_APPEND(", %" PRIu64
, index
);
431 BUF_APPEND("%s", "]");
434 static inline void format_trace_class(char **buf_ch
, bool extended
,
435 const char *prefix
, const struct bt_trace_class
*trace_class
)
437 if (trace_class
->name
.value
) {
438 BUF_APPEND(", %sname=\"%s\"",
439 PRFIELD(trace_class
->name
.value
));
446 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace_class
->frozen
));
448 if (trace_class
->uuid
.value
) {
449 BUF_APPEND_UUID(trace_class
->uuid
.value
);
452 if (trace_class
->stream_classes
) {
453 BUF_APPEND(", %sstream-class-count=%u",
454 PRFIELD(trace_class
->stream_classes
->len
));
457 BUF_APPEND(", %sassigns-auto-sc-id=%d",
458 PRFIELD(trace_class
->assigns_automatic_stream_class_id
));
461 static inline void format_trace(char **buf_ch
, bool extended
,
462 const char *prefix
, const struct bt_trace
*trace
)
466 if (trace
->name
.value
) {
467 BUF_APPEND(", %sname=\"%s\"", PRFIELD(trace
->name
.value
));
474 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace
->frozen
));
476 if (trace
->streams
) {
477 BUF_APPEND(", %sstream-count=%u",
478 PRFIELD(trace
->streams
->len
));
481 BUF_APPEND(", %sis-static=%d", PRFIELD(trace
->is_static
));
487 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace
->class));
488 SET_TMP_PREFIX("trace-class-");
489 format_trace_class(buf_ch
, false, tmp_prefix
, trace
->class);
492 static inline void format_stream_class(char **buf_ch
, bool extended
,
494 const struct bt_stream_class
*stream_class
)
496 const struct bt_trace_class
*trace_class
;
499 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream_class
->id
));
501 if (stream_class
->name
.value
) {
502 BUF_APPEND(", %sname=\"%s\"",
503 PRFIELD(stream_class
->name
.value
));
510 BUF_APPEND(", %sis-frozen=%d", PRFIELD(stream_class
->frozen
));
512 if (stream_class
->event_classes
) {
513 BUF_APPEND(", %sevent-class-count=%u",
514 PRFIELD(stream_class
->event_classes
->len
));
517 BUF_APPEND(", %spacket-context-fc-addr=%p, "
518 "%sevent-common-context-fc-addr=%p",
519 PRFIELD(stream_class
->packet_context_fc
),
520 PRFIELD(stream_class
->event_common_context_fc
));
521 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
526 BUF_APPEND(", %sassigns-auto-ec-id=%d, %sassigns-auto-stream-id=%d, "
527 "%spackets-have-discarded-ev-counter-snapshot=%d, "
528 "%spackets-have-packet-counter-snapshot=%d, "
529 "%spackets-have-default-begin-cs=%d, "
530 "%spackets-have-default-end-cs=%d",
531 PRFIELD(stream_class
->assigns_automatic_event_class_id
),
532 PRFIELD(stream_class
->assigns_automatic_stream_id
),
533 PRFIELD(stream_class
->packets_have_discarded_event_counter_snapshot
),
534 PRFIELD(stream_class
->packets_have_packet_counter_snapshot
),
535 PRFIELD(stream_class
->packets_have_default_beginning_cs
),
536 PRFIELD(stream_class
->packets_have_default_end_cs
));
537 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
538 SET_TMP_PREFIX("trace-class-");
539 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
540 SET_TMP_PREFIX("pcf-pool-");
541 format_object_pool(buf_ch
, extended
, prefix
,
542 &stream_class
->packet_context_field_pool
);
545 static inline void format_event_class(char **buf_ch
, bool extended
,
546 const char *prefix
, const struct bt_event_class
*event_class
)
548 const struct bt_stream_class
*stream_class
;
549 const struct bt_trace_class
*trace_class
;
552 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(event_class
->id
));
554 if (event_class
->name
.value
) {
555 BUF_APPEND(", %sname=\"%s\"",
556 PRFIELD(event_class
->name
.value
));
563 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class
->frozen
));
565 if (event_class
->log_level
.base
.avail
) {
566 BUF_APPEND(", %slog-level=%s",
567 PRFIELD(bt_common_event_class_log_level_string(
568 (int) event_class
->log_level
.value
)));
571 if (event_class
->emf_uri
.value
) {
572 BUF_APPEND(", %semf-uri=\"%s\"",
573 PRFIELD(event_class
->emf_uri
.value
));
576 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
577 PRFIELD(event_class
->specific_context_fc
),
578 PRFIELD(event_class
->payload_fc
));
580 stream_class
= bt_event_class_borrow_stream_class_const(event_class
);
585 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
586 SET_TMP_PREFIX("stream-class-");
587 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
588 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
593 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
594 SET_TMP_PREFIX("trace-class-");
595 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
596 SET_TMP_PREFIX("event-pool-");
597 format_object_pool(buf_ch
, extended
, prefix
, &event_class
->event_pool
);
600 static inline void format_stream(char **buf_ch
, bool extended
,
601 const char *prefix
, const struct bt_stream
*stream
)
603 const struct bt_stream_class
*stream_class
;
604 const struct bt_trace_class
*trace_class
= NULL
;
605 const struct bt_trace
*trace
= NULL
;
608 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream
->id
));
610 if (stream
->name
.value
) {
611 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream
->name
.value
));
618 stream_class
= bt_stream_borrow_class_const(stream
);
620 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
621 SET_TMP_PREFIX("stream-class-");
622 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
623 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
627 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
628 SET_TMP_PREFIX("trace-class-");
629 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
632 trace
= bt_stream_borrow_trace_inline(stream
);
634 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace
));
635 SET_TMP_PREFIX("trace-");
636 format_trace(buf_ch
, false, tmp_prefix
, trace
);
639 SET_TMP_PREFIX("packet-pool-");
640 format_object_pool(buf_ch
, extended
, prefix
, &stream
->packet_pool
);
643 static inline void format_packet(char **buf_ch
, bool extended
,
644 const char *prefix
, const struct bt_packet
*packet
)
646 const struct bt_stream
*stream
;
647 const struct bt_trace_class
*trace_class
;
654 BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
655 PRFIELD(packet
->frozen
),
656 PRFIELD(packet
->context_field
? packet
->context_field
->field
: NULL
));
657 stream
= bt_packet_borrow_stream_const(packet
);
662 if (packet
->default_beginning_cs
) {
663 SET_TMP_PREFIX("default-begin-cs-");
664 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
665 packet
->default_beginning_cs
);
668 if (packet
->default_end_cs
) {
669 SET_TMP_PREFIX("default-end-cs-");
670 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
671 packet
->default_end_cs
);
674 if (packet
->discarded_event_counter_snapshot
.base
.avail
) {
675 BUF_APPEND(", %sdiscarded-ev-counter-snapshot=%" PRIu64
,
676 PRFIELD(packet
->discarded_event_counter_snapshot
.value
));
679 if (packet
->packet_counter_snapshot
.base
.avail
) {
680 BUF_APPEND(", %spacket-counter-snapshot=%" PRIu64
,
681 PRFIELD(packet
->packet_counter_snapshot
.value
));
684 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
685 SET_TMP_PREFIX("stream-");
686 format_stream(buf_ch
, false, tmp_prefix
, stream
);
687 trace_class
= (const struct bt_trace_class
*) bt_object_borrow_parent(&stream
->base
);
692 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
693 SET_TMP_PREFIX("trace-class-");
694 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
697 static inline void format_event(char **buf_ch
, bool extended
,
698 const char *prefix
, const struct bt_event
*event
)
700 const struct bt_packet
*packet
;
701 const struct bt_stream
*stream
;
702 const struct bt_trace_class
*trace_class
;
703 const struct bt_stream_class
*stream_class
;
710 BUF_APPEND(", %sis-frozen=%d, "
711 "%scommon-context-field-addr=%p, "
712 "%sspecific-context-field-addr=%p, "
713 "%spayload-field-addr=%p, ",
714 PRFIELD(event
->frozen
),
715 PRFIELD(event
->common_context_field
),
716 PRFIELD(event
->specific_context_field
),
717 PRFIELD(event
->payload_field
));
718 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event
->class));
724 SET_TMP_PREFIX("event-class-");
725 format_event_class(buf_ch
, false, tmp_prefix
, event
->class);
726 stream_class
= bt_event_class_borrow_stream_class(event
->class);
728 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
729 SET_TMP_PREFIX("stream-class-");
730 format_stream_class(buf_ch
, false, tmp_prefix
,
733 trace_class
= bt_stream_class_borrow_trace_class_inline(
736 BUF_APPEND(", %strace-class-addr=%p",
737 PRFIELD(trace_class
));
738 SET_TMP_PREFIX("trace-class-");
739 format_trace_class(buf_ch
, false, tmp_prefix
,
744 if (event
->default_cs
) {
745 SET_TMP_PREFIX("default-cs-");
746 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
750 packet
= bt_event_borrow_packet_const(event
);
755 BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet
));
756 SET_TMP_PREFIX("packet-");
757 format_packet(buf_ch
, false, tmp_prefix
, packet
);
758 stream
= bt_packet_borrow_stream_const(packet
);
763 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
764 SET_TMP_PREFIX("stream-");
765 format_stream(buf_ch
, false, tmp_prefix
, stream
);
768 static inline void format_clock_class(char **buf_ch
, bool extended
,
769 const char *prefix
, const struct bt_clock_class
*clock_class
)
773 if (clock_class
->name
.value
) {
774 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class
->name
.value
));
777 BUF_APPEND(", %sfreq=%" PRIu64
, PRFIELD(clock_class
->frequency
));
783 if (clock_class
->description
.value
) {
784 BUF_APPEND(", %spartial-descr=\"%.32s\"",
785 PRFIELD(clock_class
->description
.value
));
788 if (clock_class
->uuid
.value
) {
789 BUF_APPEND_UUID(clock_class
->uuid
.value
);
792 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64
", "
793 "%soffset-s=%" PRId64
", "
794 "%soffset-cycles=%" PRIu64
", %sis-absolute=%d, "
795 "%sbase-offset-ns=%" PRId64
,
796 PRFIELD(clock_class
->frozen
), PRFIELD(clock_class
->precision
),
797 PRFIELD(clock_class
->offset_seconds
),
798 PRFIELD(clock_class
->offset_cycles
),
799 PRFIELD(clock_class
->is_absolute
),
800 PRFIELD(clock_class
->base_offset
.value_ns
));
802 SET_TMP_PREFIX("cs-pool-");
803 format_object_pool(buf_ch
, extended
, prefix
, &clock_class
->cs_pool
);
806 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
807 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
)
810 BUF_APPEND(", %svalue=%" PRIu64
", %sns-from-origin=%" PRId64
,
811 PRFIELD(clock_snapshot
->value_cycles
),
812 PRFIELD(clock_snapshot
->ns_from_origin
));
818 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot
->is_set
));
820 if (clock_snapshot
->clock_class
) {
821 BUF_APPEND(", %sclock-class-addr=%p",
822 PRFIELD(clock_snapshot
->clock_class
));
823 SET_TMP_PREFIX("clock-class-");
824 format_clock_class(buf_ch
, false, tmp_prefix
,
825 clock_snapshot
->clock_class
);
829 static inline void format_value(char **buf_ch
, bool extended
,
830 const char *prefix
, const struct bt_value
*value
)
832 BUF_APPEND(", %stype=%s",
833 PRFIELD(bt_common_value_type_string(bt_value_get_type(value
))));
839 switch (bt_value_get_type(value
)) {
840 case BT_VALUE_TYPE_BOOL
:
842 bt_bool val
= bt_value_bool_get(value
);
844 BUF_APPEND(", %svalue=%d", PRFIELD(val
));
847 case BT_VALUE_TYPE_INTEGER
:
849 int64_t val
= bt_value_integer_get(value
);
851 BUF_APPEND(", %svalue=%" PRId64
, PRFIELD(val
));
854 case BT_VALUE_TYPE_REAL
:
856 double val
= bt_value_real_get(value
);
858 BUF_APPEND(", %svalue=%f", PRFIELD(val
));
861 case BT_VALUE_TYPE_STRING
:
863 const char *val
= bt_value_string_get(value
);
865 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val
));
868 case BT_VALUE_TYPE_ARRAY
:
870 int64_t count
= bt_value_array_get_size(value
);
872 BT_ASSERT(count
>= 0);
873 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
876 case BT_VALUE_TYPE_MAP
:
878 int64_t count
= bt_value_map_get_size(value
);
880 BT_ASSERT(count
>= 0);
881 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
889 static inline void format_message(char **buf_ch
, bool extended
,
890 const char *prefix
, const struct bt_message
*msg
)
894 BUF_APPEND(", %stype=%s",
895 PRFIELD(bt_message_type_string(msg
->type
)));
901 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
902 PRFIELD(msg
->frozen
), PRFIELD(msg
->graph
));
905 case BT_MESSAGE_TYPE_EVENT
:
907 const struct bt_message_event
*msg_event
=
910 if (msg_event
->event
) {
911 SET_TMP_PREFIX("event-");
912 format_event(buf_ch
, true, tmp_prefix
,
918 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
919 case BT_MESSAGE_TYPE_STREAM_END
:
921 const struct bt_message_stream
*msg_stream
= (const void *) msg
;
923 if (msg_stream
->stream
) {
924 SET_TMP_PREFIX("stream-");
925 format_stream(buf_ch
, true, tmp_prefix
,
931 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
932 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
934 const struct bt_message_stream_activity
*msg_stream_activity
=
937 if (msg_stream_activity
->stream
) {
938 SET_TMP_PREFIX("stream-");
939 format_stream(buf_ch
, true, tmp_prefix
,
940 msg_stream_activity
->stream
);
943 BUF_APPEND(", %sdefault-cs-state=%s",
944 PRFIELD(bt_message_stream_activity_clock_snapshot_state_string(
945 msg_stream_activity
->default_cs_state
)));
947 if (msg_stream_activity
->default_cs
) {
948 SET_TMP_PREFIX("default-cs-");
949 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
950 msg_stream_activity
->default_cs
);
955 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
956 case BT_MESSAGE_TYPE_PACKET_END
:
958 const struct bt_message_packet
*msg_packet
= (const void *) msg
;
960 if (msg_packet
->packet
) {
961 SET_TMP_PREFIX("packet-");
962 format_packet(buf_ch
, true, tmp_prefix
,
973 static inline void format_plugin_so_shared_lib_handle(char **buf_ch
,
975 const struct bt_plugin_so_shared_lib_handle
*handle
)
977 BUF_APPEND(", %saddr=%p", PRFIELD(handle
));
980 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle
->path
));
984 static inline void format_component_class(char **buf_ch
, bool extended
,
986 const struct bt_component_class
*comp_class
)
990 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
991 PRFIELD(bt_component_class_type_string(comp_class
->type
)),
992 PRFIELD_GSTRING(comp_class
->name
));
994 if (comp_class
->description
) {
995 BUF_APPEND(", %spartial-descr=\"%.32s\"",
996 PRFIELD_GSTRING(comp_class
->description
));
1003 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class
->frozen
));
1005 if (comp_class
->so_handle
) {
1006 SET_TMP_PREFIX("so-handle-");
1007 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1008 comp_class
->so_handle
);
1012 static inline void format_component(char **buf_ch
, bool extended
,
1013 const char *prefix
, const struct bt_component
*component
)
1015 char tmp_prefix
[64];
1017 BUF_APPEND(", %sname=\"%s\"",
1018 PRFIELD_GSTRING(component
->name
));
1020 if (component
->class) {
1021 SET_TMP_PREFIX("class-");
1022 format_component_class(buf_ch
, extended
, tmp_prefix
,
1030 if (component
->input_ports
) {
1031 BUF_APPEND(", %sinput-port-count=%u",
1032 PRFIELD(component
->input_ports
->len
));
1035 if (component
->output_ports
) {
1036 BUF_APPEND(", %soutput-port-count=%u",
1037 PRFIELD(component
->output_ports
->len
));
1041 static inline void format_port(char **buf_ch
, bool extended
,
1042 const char *prefix
, const struct bt_port
*port
)
1044 char tmp_prefix
[64];
1046 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1047 PRFIELD(bt_port_type_string(port
->type
)),
1048 PRFIELD_GSTRING(port
->name
));
1054 if (port
->connection
) {
1055 SET_TMP_PREFIX("conn-");
1056 format_connection(buf_ch
, false, tmp_prefix
, port
->connection
);
1060 static inline void format_connection(char **buf_ch
, bool extended
,
1061 const char *prefix
, const struct bt_connection
*connection
)
1063 char tmp_prefix
[64];
1069 if (connection
->upstream_port
) {
1070 SET_TMP_PREFIX("upstream-port-");
1071 format_port(buf_ch
, false, tmp_prefix
,
1072 connection
->upstream_port
);
1075 if (connection
->downstream_port
) {
1076 SET_TMP_PREFIX("downstream-port-");
1077 format_port(buf_ch
, false, tmp_prefix
,
1078 connection
->downstream_port
);
1082 static inline void format_graph(char **buf_ch
, bool extended
,
1083 const char *prefix
, const struct bt_graph
*graph
)
1085 char tmp_prefix
[64];
1087 BUF_APPEND(", %sis-canceled=%d", PRFIELD(graph
->canceled
));
1093 if (graph
->components
) {
1094 BUF_APPEND(", %scomp-count=%u",
1095 PRFIELD(graph
->components
->len
));
1098 if (graph
->connections
) {
1099 BUF_APPEND(", %sconn-count=%u",
1100 PRFIELD(graph
->connections
->len
));
1103 SET_TMP_PREFIX("en-pool-");
1104 format_object_pool(buf_ch
, extended
, prefix
,
1105 &graph
->event_msg_pool
);
1106 SET_TMP_PREFIX("pbn-pool-");
1107 format_object_pool(buf_ch
, extended
, prefix
,
1108 &graph
->packet_begin_msg_pool
);
1109 SET_TMP_PREFIX("pen-pool-");
1110 format_object_pool(buf_ch
, extended
, prefix
,
1111 &graph
->packet_end_msg_pool
);
1114 static inline void format_message_iterator(char **buf_ch
,
1115 bool extended
, const char *prefix
,
1116 const struct bt_message_iterator
*iterator
)
1119 char tmp_prefix
[64];
1121 if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
) {
1122 type
= "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1123 } else if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
) {
1124 type
= "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1129 BUF_APPEND(", %stype=%s", PRFIELD(type
));
1131 switch (iterator
->type
) {
1132 case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
:
1134 const struct bt_self_component_port_input_message_iterator
*
1135 port_in_iter
= (const void *) iterator
;
1137 if (port_in_iter
->upstream_component
) {
1138 SET_TMP_PREFIX("upstream-comp-");
1139 format_component(buf_ch
, false, tmp_prefix
,
1140 port_in_iter
->upstream_component
);
1143 if (port_in_iter
->upstream_port
) {
1144 SET_TMP_PREFIX("upstream-port-");
1145 format_port(buf_ch
, false, tmp_prefix
,
1146 port_in_iter
->upstream_port
);
1149 if (port_in_iter
->connection
) {
1150 SET_TMP_PREFIX("upstream-conn-");
1151 format_connection(buf_ch
, false, tmp_prefix
,
1152 port_in_iter
->connection
);
1156 case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
:
1158 const struct bt_port_output_message_iterator
*port_out_iter
=
1159 (const void *) iterator
;
1161 if (port_out_iter
->graph
) {
1162 SET_TMP_PREFIX("graph-");
1163 format_graph(buf_ch
, false, tmp_prefix
,
1164 port_out_iter
->graph
);
1167 if (port_out_iter
->colander
) {
1168 SET_TMP_PREFIX("colander-comp-");
1169 format_component(buf_ch
, false, tmp_prefix
,
1170 (void *) port_out_iter
->colander
);
1180 static inline void format_plugin(char **buf_ch
, bool extended
,
1181 const char *prefix
, const struct bt_plugin
*plugin
)
1183 char tmp_prefix
[64];
1185 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin
->type
)));
1187 if (plugin
->info
.path_set
) {
1188 BUF_APPEND(", %spath=\"%s\"",
1189 PRFIELD_GSTRING(plugin
->info
.path
));
1192 if (plugin
->info
.name_set
) {
1193 BUF_APPEND(", %sname=\"%s\"",
1194 PRFIELD_GSTRING(plugin
->info
.name
));
1201 if (plugin
->info
.author_set
) {
1202 BUF_APPEND(", %sauthor=\"%s\"",
1203 PRFIELD_GSTRING(plugin
->info
.author
));
1206 if (plugin
->info
.license_set
) {
1207 BUF_APPEND(", %slicense=\"%s\"",
1208 PRFIELD_GSTRING(plugin
->info
.license
));
1211 if (plugin
->info
.version_set
) {
1212 BUF_APPEND(", %sversion=%u.%u.%u%s",
1213 PRFIELD(plugin
->info
.version
.major
),
1214 plugin
->info
.version
.minor
,
1215 plugin
->info
.version
.patch
,
1216 plugin
->info
.version
.extra
?
1217 plugin
->info
.version
.extra
->str
: "");
1220 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1221 "%ssink-comp-class-count=%u",
1222 PRFIELD(plugin
->src_comp_classes
->len
),
1223 PRFIELD(plugin
->flt_comp_classes
->len
),
1224 PRFIELD(plugin
->sink_comp_classes
->len
));
1226 if (plugin
->spec_data
) {
1227 const struct bt_plugin_so_spec_data
*spec_data
=
1228 (const void *) plugin
->spec_data
;
1230 if (spec_data
->shared_lib_handle
) {
1231 SET_TMP_PREFIX("so-handle-");
1232 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1233 spec_data
->shared_lib_handle
);
1238 static inline void handle_conversion_specifier_bt(void *priv_data
,
1239 char **buf_ch
, size_t avail_size
,
1240 const char **out_fmt_ch
, va_list *args
)
1242 const char *fmt_ch
= *out_fmt_ch
;
1243 bool extended
= false;
1245 char *prefix_ch
= prefix
;
1251 if (*fmt_ch
== 'u') {
1253 obj
= va_arg(*args
, void *);
1254 format_uuid(buf_ch
, obj
);
1258 if (*fmt_ch
== '[') {
1263 if (*fmt_ch
== ']') {
1269 *prefix_ch
= *fmt_ch
;
1277 if (*fmt_ch
== '+') {
1282 obj
= va_arg(*args
, void *);
1283 BUF_APPEND("%saddr=%p", prefix
, obj
);
1291 format_field_class(buf_ch
, extended
, prefix
, obj
);
1294 format_field(buf_ch
, extended
, prefix
, obj
);
1297 format_field_path(buf_ch
, extended
, prefix
, obj
);
1300 format_event_class(buf_ch
, extended
, prefix
, obj
);
1303 format_event(buf_ch
, extended
, prefix
, obj
);
1306 format_stream_class(buf_ch
, extended
, prefix
, obj
);
1309 format_stream(buf_ch
, extended
, prefix
, obj
);
1312 format_packet(buf_ch
, extended
, prefix
, obj
);
1315 format_trace(buf_ch
, extended
, prefix
, obj
);
1318 format_trace_class(buf_ch
, extended
, prefix
, obj
);
1321 format_clock_class(buf_ch
, extended
, prefix
, obj
);
1324 format_clock_snapshot(buf_ch
, extended
, prefix
, obj
);
1327 format_value(buf_ch
, extended
, prefix
, obj
);
1330 format_message(buf_ch
, extended
, prefix
, obj
);
1333 format_message_iterator(buf_ch
, extended
, prefix
, obj
);
1336 format_component_class(buf_ch
, extended
, prefix
, obj
);
1339 format_component(buf_ch
, extended
, prefix
, obj
);
1342 format_port(buf_ch
, extended
, prefix
, obj
);
1345 format_connection(buf_ch
, extended
, prefix
, obj
);
1348 format_plugin(buf_ch
, extended
, prefix
, obj
);
1351 format_graph(buf_ch
, extended
, prefix
, obj
);
1354 format_object_pool(buf_ch
, extended
, prefix
, obj
);
1357 format_object(buf_ch
, extended
, prefix
, obj
);
1365 *out_fmt_ch
= fmt_ch
;
1369 void bt_lib_log(const char *func
, const char *file
, unsigned line
,
1370 int lvl
, const char *tag
, const char *fmt
, ...)
1375 va_start(args
, fmt
);
1376 bt_common_custom_vsnprintf(lib_logging_buf
, LIB_LOGGING_BUF_SIZE
, '!',
1377 handle_conversion_specifier_bt
, NULL
, fmt
, &args
);
1379 _bt_log_write_d(func
, file
, line
, lvl
, tag
, "%s", lib_logging_buf
);