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-message-iterator-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 __thread
char 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 TMP_PREFIX_LEN 64
104 #define SET_TMP_PREFIX(_prefix2) \
106 snprintf(tmp_prefix, TMP_PREFIX_LEN - 1, "%s%s", \
107 prefix, (_prefix2)); \
108 tmp_prefix[TMP_PREFIX_LEN - 1] = '\0'; \
111 static inline void format_component(char **buf_ch
, bool extended
,
112 const char *prefix
, const struct bt_component
*component
);
114 static inline void format_port(char **buf_ch
, bool extended
,
115 const char *prefix
, const struct bt_port
*port
);
117 static inline void format_connection(char **buf_ch
, bool extended
,
118 const char *prefix
, const struct bt_connection
*connection
);
120 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
121 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
);
123 static inline void format_field_path(char **buf_ch
, bool extended
,
124 const char *prefix
, const struct bt_field_path
*field_path
);
126 static inline void format_object(char **buf_ch
, bool extended
,
127 const char *prefix
, const struct bt_object
*obj
)
129 BUF_APPEND(", %sref-count=%llu", prefix
, obj
->ref_count
);
132 static inline void format_uuid(char **buf_ch
, bt_uuid uuid
)
134 BUF_APPEND("\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
135 (unsigned int) uuid
[0],
136 (unsigned int) uuid
[1],
137 (unsigned int) uuid
[2],
138 (unsigned int) uuid
[3],
139 (unsigned int) uuid
[4],
140 (unsigned int) uuid
[5],
141 (unsigned int) uuid
[6],
142 (unsigned int) uuid
[7],
143 (unsigned int) uuid
[8],
144 (unsigned int) uuid
[9],
145 (unsigned int) uuid
[10],
146 (unsigned int) uuid
[11],
147 (unsigned int) uuid
[12],
148 (unsigned int) uuid
[13],
149 (unsigned int) uuid
[14],
150 (unsigned int) uuid
[15]);
153 static inline void format_object_pool(char **buf_ch
, bool extended
,
154 const char *prefix
, const struct bt_object_pool
*pool
)
156 BUF_APPEND(", %ssize=%zu", PRFIELD(pool
->size
));
159 BUF_APPEND(", %scap=%u", PRFIELD(pool
->objects
->len
));
163 static inline void format_integer_field_class(char **buf_ch
,
164 bool extended
, const char *prefix
,
165 const struct bt_field_class
*field_class
)
167 const struct bt_field_class_integer
*int_fc
=
168 (const void *) field_class
;
170 BUF_APPEND(", %srange-size=%" PRIu64
", %sbase=%s",
171 PRFIELD(int_fc
->range
),
172 PRFIELD(bt_common_field_class_integer_preferred_display_base_string(int_fc
->base
)));
175 static inline void format_array_field_class(char **buf_ch
,
176 bool extended
, const char *prefix
,
177 const struct bt_field_class
*field_class
)
179 const struct bt_field_class_array
*array_fc
=
180 (const void *) field_class
;
182 BUF_APPEND(", %selement-fc-addr=%p, %selement-fc-type=%s",
183 PRFIELD(array_fc
->element_fc
),
184 PRFIELD(bt_common_field_class_type_string(array_fc
->element_fc
->type
)));
187 static inline void format_field_class(char **buf_ch
, bool extended
,
188 const char *prefix
, const struct bt_field_class
*field_class
)
190 char tmp_prefix
[TMP_PREFIX_LEN
];
192 BUF_APPEND(", %stype=%s",
193 PRFIELD(bt_common_field_class_type_string(field_class
->type
)));
196 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field_class
->frozen
));
197 BUF_APPEND(", %sis-part-of-trace-class=%d",
198 PRFIELD(field_class
->part_of_trace_class
));
203 switch (field_class
->type
) {
204 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
205 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
207 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
210 case BT_FIELD_CLASS_TYPE_REAL
:
212 const struct bt_field_class_real
*real_fc
= (void *) field_class
;
214 BUF_APPEND(", %sis-single-precision=%d",
215 PRFIELD(real_fc
->is_single_precision
));
218 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
219 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
221 const struct bt_field_class_enumeration
*enum_fc
=
222 (const void *) field_class
;
224 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
225 BUF_APPEND(", %smapping-count=%u",
226 PRFIELD(enum_fc
->mappings
->len
));
229 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
231 const struct bt_field_class_structure
*struct_fc
=
232 (const void *) field_class
;
234 if (struct_fc
->common
.named_fcs
) {
235 BUF_APPEND(", %smember-count=%u",
236 PRFIELD(struct_fc
->common
.named_fcs
->len
));
241 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
243 const struct bt_field_class_static_array
*array_fc
=
244 (const void *) field_class
;
246 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
247 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_fc
->length
));
250 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
252 const struct bt_field_class_dynamic_array
*array_fc
=
253 (const void *) field_class
;
255 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
257 if (array_fc
->length_fc
) {
258 SET_TMP_PREFIX("length-fc-");
259 format_field_class(buf_ch
, extended
, tmp_prefix
,
260 array_fc
->length_fc
);
263 if (array_fc
->length_field_path
) {
264 SET_TMP_PREFIX("length-field-path-");
265 format_field_path(buf_ch
, extended
, tmp_prefix
,
266 array_fc
->length_field_path
);
271 case BT_FIELD_CLASS_TYPE_VARIANT
:
273 const struct bt_field_class_variant
*var_fc
=
274 (const void *) field_class
;
276 if (var_fc
->common
.named_fcs
) {
277 BUF_APPEND(", %soption-count=%u",
278 PRFIELD(var_fc
->common
.named_fcs
->len
));
281 if (var_fc
->selector_fc
) {
282 SET_TMP_PREFIX("selector-fc-");
283 format_field_class(buf_ch
, extended
, tmp_prefix
,
284 var_fc
->selector_fc
);
287 if (var_fc
->selector_field_path
) {
288 SET_TMP_PREFIX("selector-field-path-");
289 format_field_path(buf_ch
, extended
, tmp_prefix
,
290 var_fc
->selector_field_path
);
300 static inline void format_field_integer_extended(char **buf_ch
,
301 const char *prefix
, const struct bt_field
*field
)
303 const struct bt_field_integer
*integer
= (void *) field
;
304 const struct bt_field_class_integer
*field_class
=
305 (void *) field
->class;
306 const char *fmt
= NULL
;
308 BT_ASSERT(field_class
);
310 if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
) {
311 fmt
= ", %svalue=%" PRIo64
;
312 } else if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
) {
313 fmt
= ", %svalue=%" PRIx64
;
316 if (field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
317 field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
319 fmt
= ", %svalue=%" PRId64
;
322 BUF_APPEND(fmt
, PRFIELD(integer
->value
.i
));
325 fmt
= ", %svalue=%" PRIu64
;
328 BUF_APPEND(fmt
, PRFIELD(integer
->value
.u
));
332 static inline void format_field(char **buf_ch
, bool extended
,
333 const char *prefix
, const struct bt_field
*field
)
335 BUF_APPEND(", %sis-set=%d", PRFIELD(field
->is_set
));
338 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field
->frozen
));
341 BUF_APPEND(", %sclass-addr=%p", PRFIELD(field
->class));
347 BUF_APPEND(", %sclass-type=%s",
348 PRFIELD(bt_common_field_class_type_string(field
->class->type
)));
350 if (!extended
|| !field
->is_set
) {
354 switch (field
->class->type
) {
355 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
356 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
357 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
358 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
360 format_field_integer_extended(buf_ch
, prefix
, field
);
363 case BT_FIELD_CLASS_TYPE_REAL
:
365 const struct bt_field_real
*real_field
= (const void *) field
;
367 BUF_APPEND(", %svalue=%f", PRFIELD(real_field
->value
));
370 case BT_FIELD_CLASS_TYPE_STRING
:
372 const struct bt_field_string
*str
= (const void *) field
;
375 BT_ASSERT(str
->buf
->data
);
376 BUF_APPEND(", %spartial-value=\"%.32s\"",
377 PRFIELD(str
->buf
->data
));
382 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
383 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
385 const struct bt_field_array
*array_field
= (const void *) field
;
387 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_field
->length
));
389 if (array_field
->fields
) {
390 BUF_APPEND(", %sallocated-length=%u",
391 PRFIELD(array_field
->fields
->len
));
396 case BT_FIELD_CLASS_TYPE_VARIANT
:
398 const struct bt_field_variant
*var_field
= (const void *) field
;
400 BUF_APPEND(", %sselected-field-index=%" PRIu64
,
401 PRFIELD(var_field
->selected_index
));
409 static inline void format_field_path(char **buf_ch
, bool extended
,
410 const char *prefix
, const struct bt_field_path
*field_path
)
414 if (field_path
->items
) {
415 BT_ASSERT(field_path
->items
);
416 BUF_APPEND(", %sitem-count=%u",
417 PRFIELD(field_path
->items
->len
));
420 if (!extended
|| !field_path
->items
) {
424 BUF_APPEND(", %spath=[%s",
425 PRFIELD(bt_common_scope_string(field_path
->root
)));
427 for (i
= 0; i
< bt_field_path_get_item_count(field_path
); i
++) {
428 const struct bt_field_path_item
*fp_item
=
429 bt_field_path_borrow_item_by_index_const(field_path
, i
);
431 switch (bt_field_path_item_get_type(fp_item
)) {
432 case BT_FIELD_PATH_ITEM_TYPE_INDEX
:
433 BUF_APPEND(", %" PRIu64
,
434 bt_field_path_item_index_get_index(fp_item
));
436 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT
:
437 BUF_APPEND("%s", ", <CUR>");
444 BUF_APPEND("%s", "]");
447 static inline void format_trace_class(char **buf_ch
, bool extended
,
448 const char *prefix
, const struct bt_trace_class
*trace_class
)
450 if (trace_class
->name
.value
) {
451 BUF_APPEND(", %sname=\"%s\"",
452 PRFIELD(trace_class
->name
.value
));
459 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace_class
->frozen
));
461 if (trace_class
->uuid
.value
) {
462 BUF_APPEND_UUID(trace_class
->uuid
.value
);
465 if (trace_class
->stream_classes
) {
466 BUF_APPEND(", %sstream-class-count=%u",
467 PRFIELD(trace_class
->stream_classes
->len
));
470 BUF_APPEND(", %sassigns-auto-sc-id=%d",
471 PRFIELD(trace_class
->assigns_automatic_stream_class_id
));
474 static inline void format_trace(char **buf_ch
, bool extended
,
475 const char *prefix
, const struct bt_trace
*trace
)
477 char tmp_prefix
[TMP_PREFIX_LEN
];
479 if (trace
->name
.value
) {
480 BUF_APPEND(", %sname=\"%s\"", PRFIELD(trace
->name
.value
));
487 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace
->frozen
));
489 if (trace
->streams
) {
490 BUF_APPEND(", %sstream-count=%u",
491 PRFIELD(trace
->streams
->len
));
498 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace
->class));
499 SET_TMP_PREFIX("trace-class-");
500 format_trace_class(buf_ch
, false, tmp_prefix
, trace
->class);
503 static inline void format_stream_class(char **buf_ch
, bool extended
,
505 const struct bt_stream_class
*stream_class
)
507 const struct bt_trace_class
*trace_class
;
508 char tmp_prefix
[TMP_PREFIX_LEN
];
510 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream_class
->id
));
512 if (stream_class
->name
.value
) {
513 BUF_APPEND(", %sname=\"%s\"",
514 PRFIELD(stream_class
->name
.value
));
521 BUF_APPEND(", %sis-frozen=%d", PRFIELD(stream_class
->frozen
));
523 if (stream_class
->event_classes
) {
524 BUF_APPEND(", %sevent-class-count=%u",
525 PRFIELD(stream_class
->event_classes
->len
));
528 BUF_APPEND(", %spacket-context-fc-addr=%p, "
529 "%sevent-common-context-fc-addr=%p",
530 PRFIELD(stream_class
->packet_context_fc
),
531 PRFIELD(stream_class
->event_common_context_fc
));
532 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
537 BUF_APPEND(", %sassigns-auto-ec-id=%d, %sassigns-auto-stream-id=%d, "
538 "%spackets-have-default-beginning-cs=%d, "
539 "%spackets-have-default-end-cs=%d, ",
540 PRFIELD(stream_class
->assigns_automatic_event_class_id
),
541 PRFIELD(stream_class
->assigns_automatic_stream_id
),
542 PRFIELD(stream_class
->packets_have_default_beginning_clock_snapshot
),
543 PRFIELD(stream_class
->packets_have_default_end_clock_snapshot
));
544 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
545 SET_TMP_PREFIX("trace-class-");
546 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
547 SET_TMP_PREFIX("pcf-pool-");
548 format_object_pool(buf_ch
, extended
, tmp_prefix
,
549 &stream_class
->packet_context_field_pool
);
552 static inline void format_event_class(char **buf_ch
, bool extended
,
553 const char *prefix
, const struct bt_event_class
*event_class
)
555 const struct bt_stream_class
*stream_class
;
556 const struct bt_trace_class
*trace_class
;
557 char tmp_prefix
[TMP_PREFIX_LEN
];
559 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(event_class
->id
));
561 if (event_class
->name
.value
) {
562 BUF_APPEND(", %sname=\"%s\"",
563 PRFIELD(event_class
->name
.value
));
570 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class
->frozen
));
572 if (event_class
->log_level
.base
.avail
) {
573 BUF_APPEND(", %slog-level=%s",
574 PRFIELD(bt_common_event_class_log_level_string(
575 (int) event_class
->log_level
.value
)));
578 if (event_class
->emf_uri
.value
) {
579 BUF_APPEND(", %semf-uri=\"%s\"",
580 PRFIELD(event_class
->emf_uri
.value
));
583 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
584 PRFIELD(event_class
->specific_context_fc
),
585 PRFIELD(event_class
->payload_fc
));
587 stream_class
= bt_event_class_borrow_stream_class_const(event_class
);
592 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
593 SET_TMP_PREFIX("stream-class-");
594 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
595 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
600 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
601 SET_TMP_PREFIX("trace-class-");
602 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
603 SET_TMP_PREFIX("event-pool-");
604 format_object_pool(buf_ch
, extended
, tmp_prefix
,
605 &event_class
->event_pool
);
608 static inline void format_stream(char **buf_ch
, bool extended
,
609 const char *prefix
, const struct bt_stream
*stream
)
611 const struct bt_stream_class
*stream_class
;
612 const struct bt_trace_class
*trace_class
= NULL
;
613 const struct bt_trace
*trace
= NULL
;
614 char tmp_prefix
[TMP_PREFIX_LEN
];
616 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream
->id
));
618 if (stream
->name
.value
) {
619 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream
->name
.value
));
626 stream_class
= bt_stream_borrow_class_const(stream
);
628 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
629 SET_TMP_PREFIX("stream-class-");
630 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
631 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
635 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
636 SET_TMP_PREFIX("trace-class-");
637 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
640 trace
= bt_stream_borrow_trace_inline(stream
);
642 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace
));
643 SET_TMP_PREFIX("trace-");
644 format_trace(buf_ch
, false, tmp_prefix
, trace
);
647 SET_TMP_PREFIX("packet-pool-");
648 format_object_pool(buf_ch
, extended
, tmp_prefix
, &stream
->packet_pool
);
651 static inline void format_packet(char **buf_ch
, bool extended
,
652 const char *prefix
, const struct bt_packet
*packet
)
654 const struct bt_stream
*stream
;
655 const struct bt_trace_class
*trace_class
;
656 char tmp_prefix
[TMP_PREFIX_LEN
];
662 BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
663 PRFIELD(packet
->frozen
),
664 PRFIELD(packet
->context_field
? packet
->context_field
->field
: NULL
));
665 stream
= bt_packet_borrow_stream_const(packet
);
670 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
671 SET_TMP_PREFIX("stream-");
672 format_stream(buf_ch
, false, tmp_prefix
, stream
);
673 trace_class
= (const struct bt_trace_class
*) bt_object_borrow_parent(&stream
->base
);
678 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
679 SET_TMP_PREFIX("trace-class-");
680 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
683 static inline void format_event(char **buf_ch
, bool extended
,
684 const char *prefix
, const struct bt_event
*event
)
686 const struct bt_packet
*packet
;
687 const struct bt_stream
*stream
;
688 const struct bt_trace_class
*trace_class
;
689 const struct bt_stream_class
*stream_class
;
690 char tmp_prefix
[TMP_PREFIX_LEN
];
696 BUF_APPEND(", %sis-frozen=%d, "
697 "%scommon-context-field-addr=%p, "
698 "%sspecific-context-field-addr=%p, "
699 "%spayload-field-addr=%p, ",
700 PRFIELD(event
->frozen
),
701 PRFIELD(event
->common_context_field
),
702 PRFIELD(event
->specific_context_field
),
703 PRFIELD(event
->payload_field
));
704 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event
->class));
710 SET_TMP_PREFIX("event-class-");
711 format_event_class(buf_ch
, false, tmp_prefix
, event
->class);
712 stream_class
= bt_event_class_borrow_stream_class(event
->class);
714 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
715 SET_TMP_PREFIX("stream-class-");
716 format_stream_class(buf_ch
, false, tmp_prefix
,
719 trace_class
= bt_stream_class_borrow_trace_class_inline(
722 BUF_APPEND(", %strace-class-addr=%p",
723 PRFIELD(trace_class
));
724 SET_TMP_PREFIX("trace-class-");
725 format_trace_class(buf_ch
, false, tmp_prefix
,
730 packet
= bt_event_borrow_packet_const(event
);
735 BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet
));
736 SET_TMP_PREFIX("packet-");
737 format_packet(buf_ch
, false, tmp_prefix
, packet
);
738 stream
= bt_packet_borrow_stream_const(packet
);
743 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
744 SET_TMP_PREFIX("stream-");
745 format_stream(buf_ch
, false, tmp_prefix
, stream
);
748 static inline void format_clock_class(char **buf_ch
, bool extended
,
749 const char *prefix
, const struct bt_clock_class
*clock_class
)
751 char tmp_prefix
[TMP_PREFIX_LEN
];
753 if (clock_class
->name
.value
) {
754 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class
->name
.value
));
757 BUF_APPEND(", %sfreq=%" PRIu64
, PRFIELD(clock_class
->frequency
));
763 if (clock_class
->description
.value
) {
764 BUF_APPEND(", %spartial-descr=\"%.32s\"",
765 PRFIELD(clock_class
->description
.value
));
768 if (clock_class
->uuid
.value
) {
769 BUF_APPEND_UUID(clock_class
->uuid
.value
);
772 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64
", "
773 "%soffset-s=%" PRId64
", "
774 "%soffset-cycles=%" PRIu64
", %sorigin-is-unix-epoch=%d, "
775 "%sbase-offset-ns=%" PRId64
,
776 PRFIELD(clock_class
->frozen
), PRFIELD(clock_class
->precision
),
777 PRFIELD(clock_class
->offset_seconds
),
778 PRFIELD(clock_class
->offset_cycles
),
779 PRFIELD(clock_class
->origin_is_unix_epoch
),
780 PRFIELD(clock_class
->base_offset
.value_ns
));
782 SET_TMP_PREFIX("cs-pool-");
783 format_object_pool(buf_ch
, extended
, tmp_prefix
,
784 &clock_class
->cs_pool
);
787 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
788 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
)
790 char tmp_prefix
[TMP_PREFIX_LEN
];
791 BUF_APPEND(", %svalue=%" PRIu64
", %sns-from-origin=%" PRId64
,
792 PRFIELD(clock_snapshot
->value_cycles
),
793 PRFIELD(clock_snapshot
->ns_from_origin
));
799 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot
->is_set
));
801 if (clock_snapshot
->clock_class
) {
802 BUF_APPEND(", %sclock-class-addr=%p",
803 PRFIELD(clock_snapshot
->clock_class
));
804 SET_TMP_PREFIX("clock-class-");
805 format_clock_class(buf_ch
, false, tmp_prefix
,
806 clock_snapshot
->clock_class
);
810 static inline void format_value(char **buf_ch
, bool extended
,
811 const char *prefix
, const struct bt_value
*value
)
813 BUF_APPEND(", %stype=%s",
814 PRFIELD(bt_common_value_type_string(bt_value_get_type(value
))));
820 switch (bt_value_get_type(value
)) {
821 case BT_VALUE_TYPE_BOOL
:
823 bt_bool val
= bt_value_bool_get(value
);
825 BUF_APPEND(", %svalue=%d", PRFIELD(val
));
828 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
830 BUF_APPEND(", %svalue=%" PRIu64
,
831 PRFIELD(bt_value_unsigned_integer_get(value
)));
834 case BT_VALUE_TYPE_SIGNED_INTEGER
:
836 BUF_APPEND(", %svalue=%" PRId64
,
837 PRFIELD(bt_value_signed_integer_get(value
)));
840 case BT_VALUE_TYPE_REAL
:
842 double val
= bt_value_real_get(value
);
844 BUF_APPEND(", %svalue=%f", PRFIELD(val
));
847 case BT_VALUE_TYPE_STRING
:
849 const char *val
= bt_value_string_get(value
);
851 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val
));
854 case BT_VALUE_TYPE_ARRAY
:
856 int64_t count
= bt_value_array_get_size(value
);
858 BT_ASSERT(count
>= 0);
859 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
862 case BT_VALUE_TYPE_MAP
:
864 int64_t count
= bt_value_map_get_size(value
);
866 BT_ASSERT(count
>= 0);
867 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
875 static inline void format_message(char **buf_ch
, bool extended
,
876 const char *prefix
, const struct bt_message
*msg
)
878 char tmp_prefix
[TMP_PREFIX_LEN
];
880 BUF_APPEND(", %stype=%s",
881 PRFIELD(bt_message_type_string(msg
->type
)));
887 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
888 PRFIELD(msg
->frozen
), PRFIELD(msg
->graph
));
891 case BT_MESSAGE_TYPE_EVENT
:
893 const struct bt_message_event
*msg_event
=
896 if (msg_event
->event
) {
897 SET_TMP_PREFIX("event-");
898 format_event(buf_ch
, true, tmp_prefix
,
902 if (msg_event
->default_cs
) {
903 SET_TMP_PREFIX("default-cs-");
904 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
905 msg_event
->default_cs
);
910 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
911 case BT_MESSAGE_TYPE_STREAM_END
:
913 const struct bt_message_stream
*msg_stream
= (const void *) msg
;
915 if (msg_stream
->stream
) {
916 SET_TMP_PREFIX("stream-");
917 format_stream(buf_ch
, true, tmp_prefix
,
923 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
924 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
926 const struct bt_message_stream_activity
*msg_stream_activity
=
929 if (msg_stream_activity
->stream
) {
930 SET_TMP_PREFIX("stream-");
931 format_stream(buf_ch
, true, tmp_prefix
,
932 msg_stream_activity
->stream
);
935 BUF_APPEND(", %sdefault-cs-state=%s",
936 PRFIELD(bt_message_stream_activity_clock_snapshot_state_string(
937 msg_stream_activity
->default_cs_state
)));
939 if (msg_stream_activity
->default_cs
) {
940 SET_TMP_PREFIX("default-cs-");
941 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
942 msg_stream_activity
->default_cs
);
947 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
948 case BT_MESSAGE_TYPE_PACKET_END
:
950 const struct bt_message_packet
*msg_packet
= (const void *) msg
;
952 if (msg_packet
->packet
) {
953 SET_TMP_PREFIX("packet-");
954 format_packet(buf_ch
, true, tmp_prefix
,
958 if (msg_packet
->default_cs
) {
959 SET_TMP_PREFIX("default-cs-");
960 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
961 msg_packet
->default_cs
);
966 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
967 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
969 const struct bt_message_discarded_items
*msg_disc_items
=
972 if (msg_disc_items
->stream
) {
973 SET_TMP_PREFIX("stream-");
974 format_stream(buf_ch
, true, tmp_prefix
,
975 msg_disc_items
->stream
);
978 if (msg_disc_items
->default_begin_cs
) {
979 SET_TMP_PREFIX("default-begin-cs-");
980 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
981 msg_disc_items
->default_begin_cs
);
984 if (msg_disc_items
->default_end_cs
) {
985 SET_TMP_PREFIX("default-end-cs-");
986 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
987 msg_disc_items
->default_end_cs
);
990 if (msg_disc_items
->count
.base
.avail
) {
991 BUF_APPEND(", %scount=%" PRIu64
,
992 PRFIELD(msg_disc_items
->count
.value
));
1002 static inline void format_plugin_so_shared_lib_handle(char **buf_ch
,
1004 const struct bt_plugin_so_shared_lib_handle
*handle
)
1006 BUF_APPEND(", %saddr=%p", PRFIELD(handle
));
1009 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle
->path
));
1013 static inline void format_component_class(char **buf_ch
, bool extended
,
1015 const struct bt_component_class
*comp_class
)
1017 char tmp_prefix
[TMP_PREFIX_LEN
];
1019 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1020 PRFIELD(bt_component_class_type_string(comp_class
->type
)),
1021 PRFIELD_GSTRING(comp_class
->name
));
1023 if (comp_class
->description
) {
1024 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1025 PRFIELD_GSTRING(comp_class
->description
));
1032 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class
->frozen
));
1034 if (comp_class
->so_handle
) {
1035 SET_TMP_PREFIX("so-handle-");
1036 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1037 comp_class
->so_handle
);
1041 static inline void format_component(char **buf_ch
, bool extended
,
1042 const char *prefix
, const struct bt_component
*component
)
1044 char tmp_prefix
[TMP_PREFIX_LEN
];
1046 BUF_APPEND(", %sname=\"%s\"",
1047 PRFIELD_GSTRING(component
->name
));
1049 if (component
->class) {
1050 SET_TMP_PREFIX("class-");
1051 format_component_class(buf_ch
, extended
, tmp_prefix
,
1059 if (component
->input_ports
) {
1060 BUF_APPEND(", %sinput-port-count=%u",
1061 PRFIELD(component
->input_ports
->len
));
1064 if (component
->output_ports
) {
1065 BUF_APPEND(", %soutput-port-count=%u",
1066 PRFIELD(component
->output_ports
->len
));
1070 static inline void format_port(char **buf_ch
, bool extended
,
1071 const char *prefix
, const struct bt_port
*port
)
1073 char tmp_prefix
[TMP_PREFIX_LEN
];
1075 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1076 PRFIELD(bt_port_type_string(port
->type
)),
1077 PRFIELD_GSTRING(port
->name
));
1083 if (port
->connection
) {
1084 SET_TMP_PREFIX("conn-");
1085 format_connection(buf_ch
, false, tmp_prefix
, port
->connection
);
1089 static inline void format_connection(char **buf_ch
, bool extended
,
1090 const char *prefix
, const struct bt_connection
*connection
)
1092 char tmp_prefix
[TMP_PREFIX_LEN
];
1098 if (connection
->upstream_port
) {
1099 SET_TMP_PREFIX("upstream-port-");
1100 format_port(buf_ch
, false, tmp_prefix
,
1101 connection
->upstream_port
);
1104 if (connection
->downstream_port
) {
1105 SET_TMP_PREFIX("downstream-port-");
1106 format_port(buf_ch
, false, tmp_prefix
,
1107 connection
->downstream_port
);
1111 static inline void format_graph(char **buf_ch
, bool extended
,
1112 const char *prefix
, const struct bt_graph
*graph
)
1114 char tmp_prefix
[TMP_PREFIX_LEN
];
1116 BUF_APPEND(", %sis-canceled=%d, %scan-consume=%d, "
1117 "%sconfig-state=%s",
1118 PRFIELD(graph
->canceled
),
1119 PRFIELD(graph
->can_consume
),
1120 PRFIELD(bt_graph_configuration_state_string(graph
->config_state
)));
1126 if (graph
->components
) {
1127 BUF_APPEND(", %scomp-count=%u",
1128 PRFIELD(graph
->components
->len
));
1131 if (graph
->connections
) {
1132 BUF_APPEND(", %sconn-count=%u",
1133 PRFIELD(graph
->connections
->len
));
1136 SET_TMP_PREFIX("en-pool-");
1137 format_object_pool(buf_ch
, extended
, tmp_prefix
,
1138 &graph
->event_msg_pool
);
1139 SET_TMP_PREFIX("pbn-pool-");
1140 format_object_pool(buf_ch
, extended
, tmp_prefix
,
1141 &graph
->packet_begin_msg_pool
);
1142 SET_TMP_PREFIX("pen-pool-");
1143 format_object_pool(buf_ch
, extended
, tmp_prefix
,
1144 &graph
->packet_end_msg_pool
);
1147 static inline void format_message_iterator(char **buf_ch
,
1148 bool extended
, const char *prefix
,
1149 const struct bt_message_iterator
*iterator
)
1152 char tmp_prefix
[TMP_PREFIX_LEN
];
1154 if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
) {
1155 type
= "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1156 } else if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
) {
1157 type
= "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1162 BUF_APPEND(", %stype=%s", PRFIELD(type
));
1164 switch (iterator
->type
) {
1165 case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
:
1167 const struct bt_self_component_port_input_message_iterator
*
1168 port_in_iter
= (const void *) iterator
;
1170 if (port_in_iter
->upstream_component
) {
1171 SET_TMP_PREFIX("upstream-comp-");
1172 format_component(buf_ch
, false, tmp_prefix
,
1173 port_in_iter
->upstream_component
);
1176 if (port_in_iter
->upstream_port
) {
1177 SET_TMP_PREFIX("upstream-port-");
1178 format_port(buf_ch
, false, tmp_prefix
,
1179 port_in_iter
->upstream_port
);
1182 if (port_in_iter
->connection
) {
1183 SET_TMP_PREFIX("upstream-conn-");
1184 format_connection(buf_ch
, false, tmp_prefix
,
1185 port_in_iter
->connection
);
1189 case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
:
1191 const struct bt_port_output_message_iterator
*port_out_iter
=
1192 (const void *) iterator
;
1194 if (port_out_iter
->graph
) {
1195 SET_TMP_PREFIX("graph-");
1196 format_graph(buf_ch
, false, tmp_prefix
,
1197 port_out_iter
->graph
);
1200 if (port_out_iter
->colander
) {
1201 SET_TMP_PREFIX("colander-comp-");
1202 format_component(buf_ch
, false, tmp_prefix
,
1203 (void *) port_out_iter
->colander
);
1213 static inline void format_plugin(char **buf_ch
, bool extended
,
1214 const char *prefix
, const struct bt_plugin
*plugin
)
1216 char tmp_prefix
[TMP_PREFIX_LEN
];
1218 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin
->type
)));
1220 if (plugin
->info
.path_set
) {
1221 BUF_APPEND(", %spath=\"%s\"",
1222 PRFIELD_GSTRING(plugin
->info
.path
));
1225 if (plugin
->info
.name_set
) {
1226 BUF_APPEND(", %sname=\"%s\"",
1227 PRFIELD_GSTRING(plugin
->info
.name
));
1234 if (plugin
->info
.author_set
) {
1235 BUF_APPEND(", %sauthor=\"%s\"",
1236 PRFIELD_GSTRING(plugin
->info
.author
));
1239 if (plugin
->info
.license_set
) {
1240 BUF_APPEND(", %slicense=\"%s\"",
1241 PRFIELD_GSTRING(plugin
->info
.license
));
1244 if (plugin
->info
.version_set
) {
1245 BUF_APPEND(", %sversion=%u.%u.%u%s",
1246 PRFIELD(plugin
->info
.version
.major
),
1247 plugin
->info
.version
.minor
,
1248 plugin
->info
.version
.patch
,
1249 plugin
->info
.version
.extra
?
1250 plugin
->info
.version
.extra
->str
: "");
1253 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1254 "%ssink-comp-class-count=%u",
1255 PRFIELD(plugin
->src_comp_classes
->len
),
1256 PRFIELD(plugin
->flt_comp_classes
->len
),
1257 PRFIELD(plugin
->sink_comp_classes
->len
));
1259 if (plugin
->spec_data
) {
1260 const struct bt_plugin_so_spec_data
*spec_data
=
1261 (const void *) plugin
->spec_data
;
1263 if (spec_data
->shared_lib_handle
) {
1264 SET_TMP_PREFIX("so-handle-");
1265 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1266 spec_data
->shared_lib_handle
);
1271 static inline void handle_conversion_specifier_bt(void *priv_data
,
1272 char **buf_ch
, size_t avail_size
,
1273 const char **out_fmt_ch
, va_list *args
)
1275 const char *fmt_ch
= *out_fmt_ch
;
1276 bool extended
= false;
1278 char *prefix_ch
= prefix
;
1284 if (*fmt_ch
== 'u') {
1286 obj
= va_arg(*args
, void *);
1287 format_uuid(buf_ch
, obj
);
1291 if (*fmt_ch
== '[') {
1296 if (*fmt_ch
== ']') {
1302 *prefix_ch
= *fmt_ch
;
1310 if (*fmt_ch
== '+') {
1315 obj
= va_arg(*args
, void *);
1316 BUF_APPEND("%saddr=%p", prefix
, obj
);
1324 format_field_class(buf_ch
, extended
, prefix
, obj
);
1327 format_field(buf_ch
, extended
, prefix
, obj
);
1330 format_field_path(buf_ch
, extended
, prefix
, obj
);
1333 format_event_class(buf_ch
, extended
, prefix
, obj
);
1336 format_event(buf_ch
, extended
, prefix
, obj
);
1339 format_stream_class(buf_ch
, extended
, prefix
, obj
);
1342 format_stream(buf_ch
, extended
, prefix
, obj
);
1345 format_packet(buf_ch
, extended
, prefix
, obj
);
1348 format_trace(buf_ch
, extended
, prefix
, obj
);
1351 format_trace_class(buf_ch
, extended
, prefix
, obj
);
1354 format_clock_class(buf_ch
, extended
, prefix
, obj
);
1357 format_clock_snapshot(buf_ch
, extended
, prefix
, obj
);
1360 format_value(buf_ch
, extended
, prefix
, obj
);
1363 format_message(buf_ch
, extended
, prefix
, obj
);
1366 format_message_iterator(buf_ch
, extended
, prefix
, obj
);
1369 format_component_class(buf_ch
, extended
, prefix
, obj
);
1372 format_component(buf_ch
, extended
, prefix
, obj
);
1375 format_port(buf_ch
, extended
, prefix
, obj
);
1378 format_connection(buf_ch
, extended
, prefix
, obj
);
1381 format_plugin(buf_ch
, extended
, prefix
, obj
);
1384 format_graph(buf_ch
, extended
, prefix
, obj
);
1387 format_object_pool(buf_ch
, extended
, prefix
, obj
);
1390 format_object(buf_ch
, extended
, prefix
, obj
);
1398 *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
);