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 PRFIELD(stream_class
->assigns_automatic_event_class_id
),
529 PRFIELD(stream_class
->assigns_automatic_stream_id
));
530 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
531 SET_TMP_PREFIX("trace-class-");
532 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
533 SET_TMP_PREFIX("pcf-pool-");
534 format_object_pool(buf_ch
, extended
, prefix
,
535 &stream_class
->packet_context_field_pool
);
538 static inline void format_event_class(char **buf_ch
, bool extended
,
539 const char *prefix
, const struct bt_event_class
*event_class
)
541 const struct bt_stream_class
*stream_class
;
542 const struct bt_trace_class
*trace_class
;
545 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(event_class
->id
));
547 if (event_class
->name
.value
) {
548 BUF_APPEND(", %sname=\"%s\"",
549 PRFIELD(event_class
->name
.value
));
556 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class
->frozen
));
558 if (event_class
->log_level
.base
.avail
) {
559 BUF_APPEND(", %slog-level=%s",
560 PRFIELD(bt_common_event_class_log_level_string(
561 (int) event_class
->log_level
.value
)));
564 if (event_class
->emf_uri
.value
) {
565 BUF_APPEND(", %semf-uri=\"%s\"",
566 PRFIELD(event_class
->emf_uri
.value
));
569 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
570 PRFIELD(event_class
->specific_context_fc
),
571 PRFIELD(event_class
->payload_fc
));
573 stream_class
= bt_event_class_borrow_stream_class_const(event_class
);
578 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
579 SET_TMP_PREFIX("stream-class-");
580 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
581 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
586 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
587 SET_TMP_PREFIX("trace-class-");
588 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
589 SET_TMP_PREFIX("event-pool-");
590 format_object_pool(buf_ch
, extended
, prefix
, &event_class
->event_pool
);
593 static inline void format_stream(char **buf_ch
, bool extended
,
594 const char *prefix
, const struct bt_stream
*stream
)
596 const struct bt_stream_class
*stream_class
;
597 const struct bt_trace_class
*trace_class
= NULL
;
598 const struct bt_trace
*trace
= NULL
;
601 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream
->id
));
603 if (stream
->name
.value
) {
604 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream
->name
.value
));
611 stream_class
= bt_stream_borrow_class_const(stream
);
613 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
614 SET_TMP_PREFIX("stream-class-");
615 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
616 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
620 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
621 SET_TMP_PREFIX("trace-class-");
622 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
625 trace
= bt_stream_borrow_trace_inline(stream
);
627 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace
));
628 SET_TMP_PREFIX("trace-");
629 format_trace(buf_ch
, false, tmp_prefix
, trace
);
632 SET_TMP_PREFIX("packet-pool-");
633 format_object_pool(buf_ch
, extended
, prefix
, &stream
->packet_pool
);
636 static inline void format_packet(char **buf_ch
, bool extended
,
637 const char *prefix
, const struct bt_packet
*packet
)
639 const struct bt_stream
*stream
;
640 const struct bt_trace_class
*trace_class
;
647 BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
648 PRFIELD(packet
->frozen
),
649 PRFIELD(packet
->context_field
? packet
->context_field
->field
: NULL
));
650 stream
= bt_packet_borrow_stream_const(packet
);
655 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
656 SET_TMP_PREFIX("stream-");
657 format_stream(buf_ch
, false, tmp_prefix
, stream
);
658 trace_class
= (const struct bt_trace_class
*) bt_object_borrow_parent(&stream
->base
);
663 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
664 SET_TMP_PREFIX("trace-class-");
665 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
668 static inline void format_event(char **buf_ch
, bool extended
,
669 const char *prefix
, const struct bt_event
*event
)
671 const struct bt_packet
*packet
;
672 const struct bt_stream
*stream
;
673 const struct bt_trace_class
*trace_class
;
674 const struct bt_stream_class
*stream_class
;
681 BUF_APPEND(", %sis-frozen=%d, "
682 "%scommon-context-field-addr=%p, "
683 "%sspecific-context-field-addr=%p, "
684 "%spayload-field-addr=%p, ",
685 PRFIELD(event
->frozen
),
686 PRFIELD(event
->common_context_field
),
687 PRFIELD(event
->specific_context_field
),
688 PRFIELD(event
->payload_field
));
689 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event
->class));
695 SET_TMP_PREFIX("event-class-");
696 format_event_class(buf_ch
, false, tmp_prefix
, event
->class);
697 stream_class
= bt_event_class_borrow_stream_class(event
->class);
699 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
700 SET_TMP_PREFIX("stream-class-");
701 format_stream_class(buf_ch
, false, tmp_prefix
,
704 trace_class
= bt_stream_class_borrow_trace_class_inline(
707 BUF_APPEND(", %strace-class-addr=%p",
708 PRFIELD(trace_class
));
709 SET_TMP_PREFIX("trace-class-");
710 format_trace_class(buf_ch
, false, tmp_prefix
,
715 packet
= bt_event_borrow_packet_const(event
);
720 BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet
));
721 SET_TMP_PREFIX("packet-");
722 format_packet(buf_ch
, false, tmp_prefix
, packet
);
723 stream
= bt_packet_borrow_stream_const(packet
);
728 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
729 SET_TMP_PREFIX("stream-");
730 format_stream(buf_ch
, false, tmp_prefix
, stream
);
733 static inline void format_clock_class(char **buf_ch
, bool extended
,
734 const char *prefix
, const struct bt_clock_class
*clock_class
)
738 if (clock_class
->name
.value
) {
739 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class
->name
.value
));
742 BUF_APPEND(", %sfreq=%" PRIu64
, PRFIELD(clock_class
->frequency
));
748 if (clock_class
->description
.value
) {
749 BUF_APPEND(", %spartial-descr=\"%.32s\"",
750 PRFIELD(clock_class
->description
.value
));
753 if (clock_class
->uuid
.value
) {
754 BUF_APPEND_UUID(clock_class
->uuid
.value
);
757 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64
", "
758 "%soffset-s=%" PRId64
", "
759 "%soffset-cycles=%" PRIu64
", %sorigin-is-unix-epoch=%d, "
760 "%sbase-offset-ns=%" PRId64
,
761 PRFIELD(clock_class
->frozen
), PRFIELD(clock_class
->precision
),
762 PRFIELD(clock_class
->offset_seconds
),
763 PRFIELD(clock_class
->offset_cycles
),
764 PRFIELD(clock_class
->origin_is_unix_epoch
),
765 PRFIELD(clock_class
->base_offset
.value_ns
));
767 SET_TMP_PREFIX("cs-pool-");
768 format_object_pool(buf_ch
, extended
, prefix
, &clock_class
->cs_pool
);
771 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
772 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
)
775 BUF_APPEND(", %svalue=%" PRIu64
", %sns-from-origin=%" PRId64
,
776 PRFIELD(clock_snapshot
->value_cycles
),
777 PRFIELD(clock_snapshot
->ns_from_origin
));
783 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot
->is_set
));
785 if (clock_snapshot
->clock_class
) {
786 BUF_APPEND(", %sclock-class-addr=%p",
787 PRFIELD(clock_snapshot
->clock_class
));
788 SET_TMP_PREFIX("clock-class-");
789 format_clock_class(buf_ch
, false, tmp_prefix
,
790 clock_snapshot
->clock_class
);
794 static inline void format_value(char **buf_ch
, bool extended
,
795 const char *prefix
, const struct bt_value
*value
)
797 BUF_APPEND(", %stype=%s",
798 PRFIELD(bt_common_value_type_string(bt_value_get_type(value
))));
804 switch (bt_value_get_type(value
)) {
805 case BT_VALUE_TYPE_BOOL
:
807 bt_bool val
= bt_value_bool_get(value
);
809 BUF_APPEND(", %svalue=%d", PRFIELD(val
));
812 case BT_VALUE_TYPE_INTEGER
:
814 int64_t val
= bt_value_integer_get(value
);
816 BUF_APPEND(", %svalue=%" PRId64
, PRFIELD(val
));
819 case BT_VALUE_TYPE_REAL
:
821 double val
= bt_value_real_get(value
);
823 BUF_APPEND(", %svalue=%f", PRFIELD(val
));
826 case BT_VALUE_TYPE_STRING
:
828 const char *val
= bt_value_string_get(value
);
830 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val
));
833 case BT_VALUE_TYPE_ARRAY
:
835 int64_t count
= bt_value_array_get_size(value
);
837 BT_ASSERT(count
>= 0);
838 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
841 case BT_VALUE_TYPE_MAP
:
843 int64_t count
= bt_value_map_get_size(value
);
845 BT_ASSERT(count
>= 0);
846 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
854 static inline void format_message(char **buf_ch
, bool extended
,
855 const char *prefix
, const struct bt_message
*msg
)
859 BUF_APPEND(", %stype=%s",
860 PRFIELD(bt_message_type_string(msg
->type
)));
866 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
867 PRFIELD(msg
->frozen
), PRFIELD(msg
->graph
));
870 case BT_MESSAGE_TYPE_EVENT
:
872 const struct bt_message_event
*msg_event
=
875 if (msg_event
->event
) {
876 SET_TMP_PREFIX("event-");
877 format_event(buf_ch
, true, tmp_prefix
,
881 if (msg_event
->default_cs
) {
882 SET_TMP_PREFIX("default-cs-");
883 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
884 msg_event
->default_cs
);
889 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
890 case BT_MESSAGE_TYPE_STREAM_END
:
892 const struct bt_message_stream
*msg_stream
= (const void *) msg
;
894 if (msg_stream
->stream
) {
895 SET_TMP_PREFIX("stream-");
896 format_stream(buf_ch
, true, tmp_prefix
,
902 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
903 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
905 const struct bt_message_stream_activity
*msg_stream_activity
=
908 if (msg_stream_activity
->stream
) {
909 SET_TMP_PREFIX("stream-");
910 format_stream(buf_ch
, true, tmp_prefix
,
911 msg_stream_activity
->stream
);
914 BUF_APPEND(", %sdefault-cs-state=%s",
915 PRFIELD(bt_message_stream_activity_clock_snapshot_state_string(
916 msg_stream_activity
->default_cs_state
)));
918 if (msg_stream_activity
->default_cs
) {
919 SET_TMP_PREFIX("default-cs-");
920 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
921 msg_stream_activity
->default_cs
);
926 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
927 case BT_MESSAGE_TYPE_PACKET_END
:
929 const struct bt_message_packet
*msg_packet
= (const void *) msg
;
931 if (msg_packet
->packet
) {
932 SET_TMP_PREFIX("packet-");
933 format_packet(buf_ch
, true, tmp_prefix
,
937 if (msg_packet
->default_cs
) {
938 SET_TMP_PREFIX("default-cs-");
939 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
940 msg_packet
->default_cs
);
945 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
946 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
948 const struct bt_message_discarded_items
*msg_disc_items
=
951 if (msg_disc_items
->stream
) {
952 SET_TMP_PREFIX("stream-");
953 format_stream(buf_ch
, true, tmp_prefix
,
954 msg_disc_items
->stream
);
957 if (msg_disc_items
->default_begin_cs
) {
958 SET_TMP_PREFIX("default-begin-cs-");
959 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
960 msg_disc_items
->default_begin_cs
);
963 if (msg_disc_items
->default_end_cs
) {
964 SET_TMP_PREFIX("default-end-cs-");
965 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
966 msg_disc_items
->default_end_cs
);
969 if (msg_disc_items
->count
.base
.avail
) {
970 BUF_APPEND(", %scount=%" PRIu64
,
971 PRFIELD(msg_disc_items
->count
.value
));
981 static inline void format_plugin_so_shared_lib_handle(char **buf_ch
,
983 const struct bt_plugin_so_shared_lib_handle
*handle
)
985 BUF_APPEND(", %saddr=%p", PRFIELD(handle
));
988 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle
->path
));
992 static inline void format_component_class(char **buf_ch
, bool extended
,
994 const struct bt_component_class
*comp_class
)
998 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
999 PRFIELD(bt_component_class_type_string(comp_class
->type
)),
1000 PRFIELD_GSTRING(comp_class
->name
));
1002 if (comp_class
->description
) {
1003 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1004 PRFIELD_GSTRING(comp_class
->description
));
1011 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class
->frozen
));
1013 if (comp_class
->so_handle
) {
1014 SET_TMP_PREFIX("so-handle-");
1015 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1016 comp_class
->so_handle
);
1020 static inline void format_component(char **buf_ch
, bool extended
,
1021 const char *prefix
, const struct bt_component
*component
)
1023 char tmp_prefix
[64];
1025 BUF_APPEND(", %sname=\"%s\"",
1026 PRFIELD_GSTRING(component
->name
));
1028 if (component
->class) {
1029 SET_TMP_PREFIX("class-");
1030 format_component_class(buf_ch
, extended
, tmp_prefix
,
1038 if (component
->input_ports
) {
1039 BUF_APPEND(", %sinput-port-count=%u",
1040 PRFIELD(component
->input_ports
->len
));
1043 if (component
->output_ports
) {
1044 BUF_APPEND(", %soutput-port-count=%u",
1045 PRFIELD(component
->output_ports
->len
));
1049 static inline void format_port(char **buf_ch
, bool extended
,
1050 const char *prefix
, const struct bt_port
*port
)
1052 char tmp_prefix
[64];
1054 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1055 PRFIELD(bt_port_type_string(port
->type
)),
1056 PRFIELD_GSTRING(port
->name
));
1062 if (port
->connection
) {
1063 SET_TMP_PREFIX("conn-");
1064 format_connection(buf_ch
, false, tmp_prefix
, port
->connection
);
1068 static inline void format_connection(char **buf_ch
, bool extended
,
1069 const char *prefix
, const struct bt_connection
*connection
)
1071 char tmp_prefix
[64];
1077 if (connection
->upstream_port
) {
1078 SET_TMP_PREFIX("upstream-port-");
1079 format_port(buf_ch
, false, tmp_prefix
,
1080 connection
->upstream_port
);
1083 if (connection
->downstream_port
) {
1084 SET_TMP_PREFIX("downstream-port-");
1085 format_port(buf_ch
, false, tmp_prefix
,
1086 connection
->downstream_port
);
1090 static inline void format_graph(char **buf_ch
, bool extended
,
1091 const char *prefix
, const struct bt_graph
*graph
)
1093 char tmp_prefix
[64];
1095 BUF_APPEND(", %sis-canceled=%d", PRFIELD(graph
->canceled
));
1101 if (graph
->components
) {
1102 BUF_APPEND(", %scomp-count=%u",
1103 PRFIELD(graph
->components
->len
));
1106 if (graph
->connections
) {
1107 BUF_APPEND(", %sconn-count=%u",
1108 PRFIELD(graph
->connections
->len
));
1111 SET_TMP_PREFIX("en-pool-");
1112 format_object_pool(buf_ch
, extended
, prefix
,
1113 &graph
->event_msg_pool
);
1114 SET_TMP_PREFIX("pbn-pool-");
1115 format_object_pool(buf_ch
, extended
, prefix
,
1116 &graph
->packet_begin_msg_pool
);
1117 SET_TMP_PREFIX("pen-pool-");
1118 format_object_pool(buf_ch
, extended
, prefix
,
1119 &graph
->packet_end_msg_pool
);
1122 static inline void format_message_iterator(char **buf_ch
,
1123 bool extended
, const char *prefix
,
1124 const struct bt_message_iterator
*iterator
)
1127 char tmp_prefix
[64];
1129 if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
) {
1130 type
= "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1131 } else if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
) {
1132 type
= "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1137 BUF_APPEND(", %stype=%s", PRFIELD(type
));
1139 switch (iterator
->type
) {
1140 case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
:
1142 const struct bt_self_component_port_input_message_iterator
*
1143 port_in_iter
= (const void *) iterator
;
1145 if (port_in_iter
->upstream_component
) {
1146 SET_TMP_PREFIX("upstream-comp-");
1147 format_component(buf_ch
, false, tmp_prefix
,
1148 port_in_iter
->upstream_component
);
1151 if (port_in_iter
->upstream_port
) {
1152 SET_TMP_PREFIX("upstream-port-");
1153 format_port(buf_ch
, false, tmp_prefix
,
1154 port_in_iter
->upstream_port
);
1157 if (port_in_iter
->connection
) {
1158 SET_TMP_PREFIX("upstream-conn-");
1159 format_connection(buf_ch
, false, tmp_prefix
,
1160 port_in_iter
->connection
);
1164 case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
:
1166 const struct bt_port_output_message_iterator
*port_out_iter
=
1167 (const void *) iterator
;
1169 if (port_out_iter
->graph
) {
1170 SET_TMP_PREFIX("graph-");
1171 format_graph(buf_ch
, false, tmp_prefix
,
1172 port_out_iter
->graph
);
1175 if (port_out_iter
->colander
) {
1176 SET_TMP_PREFIX("colander-comp-");
1177 format_component(buf_ch
, false, tmp_prefix
,
1178 (void *) port_out_iter
->colander
);
1188 static inline void format_plugin(char **buf_ch
, bool extended
,
1189 const char *prefix
, const struct bt_plugin
*plugin
)
1191 char tmp_prefix
[64];
1193 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin
->type
)));
1195 if (plugin
->info
.path_set
) {
1196 BUF_APPEND(", %spath=\"%s\"",
1197 PRFIELD_GSTRING(plugin
->info
.path
));
1200 if (plugin
->info
.name_set
) {
1201 BUF_APPEND(", %sname=\"%s\"",
1202 PRFIELD_GSTRING(plugin
->info
.name
));
1209 if (plugin
->info
.author_set
) {
1210 BUF_APPEND(", %sauthor=\"%s\"",
1211 PRFIELD_GSTRING(plugin
->info
.author
));
1214 if (plugin
->info
.license_set
) {
1215 BUF_APPEND(", %slicense=\"%s\"",
1216 PRFIELD_GSTRING(plugin
->info
.license
));
1219 if (plugin
->info
.version_set
) {
1220 BUF_APPEND(", %sversion=%u.%u.%u%s",
1221 PRFIELD(plugin
->info
.version
.major
),
1222 plugin
->info
.version
.minor
,
1223 plugin
->info
.version
.patch
,
1224 plugin
->info
.version
.extra
?
1225 plugin
->info
.version
.extra
->str
: "");
1228 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1229 "%ssink-comp-class-count=%u",
1230 PRFIELD(plugin
->src_comp_classes
->len
),
1231 PRFIELD(plugin
->flt_comp_classes
->len
),
1232 PRFIELD(plugin
->sink_comp_classes
->len
));
1234 if (plugin
->spec_data
) {
1235 const struct bt_plugin_so_spec_data
*spec_data
=
1236 (const void *) plugin
->spec_data
;
1238 if (spec_data
->shared_lib_handle
) {
1239 SET_TMP_PREFIX("so-handle-");
1240 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1241 spec_data
->shared_lib_handle
);
1246 static inline void handle_conversion_specifier_bt(void *priv_data
,
1247 char **buf_ch
, size_t avail_size
,
1248 const char **out_fmt_ch
, va_list *args
)
1250 const char *fmt_ch
= *out_fmt_ch
;
1251 bool extended
= false;
1253 char *prefix_ch
= prefix
;
1259 if (*fmt_ch
== 'u') {
1261 obj
= va_arg(*args
, void *);
1262 format_uuid(buf_ch
, obj
);
1266 if (*fmt_ch
== '[') {
1271 if (*fmt_ch
== ']') {
1277 *prefix_ch
= *fmt_ch
;
1285 if (*fmt_ch
== '+') {
1290 obj
= va_arg(*args
, void *);
1291 BUF_APPEND("%saddr=%p", prefix
, obj
);
1299 format_field_class(buf_ch
, extended
, prefix
, obj
);
1302 format_field(buf_ch
, extended
, prefix
, obj
);
1305 format_field_path(buf_ch
, extended
, prefix
, obj
);
1308 format_event_class(buf_ch
, extended
, prefix
, obj
);
1311 format_event(buf_ch
, extended
, prefix
, obj
);
1314 format_stream_class(buf_ch
, extended
, prefix
, obj
);
1317 format_stream(buf_ch
, extended
, prefix
, obj
);
1320 format_packet(buf_ch
, extended
, prefix
, obj
);
1323 format_trace(buf_ch
, extended
, prefix
, obj
);
1326 format_trace_class(buf_ch
, extended
, prefix
, obj
);
1329 format_clock_class(buf_ch
, extended
, prefix
, obj
);
1332 format_clock_snapshot(buf_ch
, extended
, prefix
, obj
);
1335 format_value(buf_ch
, extended
, prefix
, obj
);
1338 format_message(buf_ch
, extended
, prefix
, obj
);
1341 format_message_iterator(buf_ch
, extended
, prefix
, obj
);
1344 format_component_class(buf_ch
, extended
, prefix
, obj
);
1347 format_component(buf_ch
, extended
, prefix
, obj
);
1350 format_port(buf_ch
, extended
, prefix
, obj
);
1353 format_connection(buf_ch
, extended
, prefix
, obj
);
1356 format_plugin(buf_ch
, extended
, prefix
, obj
);
1359 format_graph(buf_ch
, extended
, prefix
, obj
);
1362 format_object_pool(buf_ch
, extended
, prefix
, obj
);
1365 format_object(buf_ch
, extended
, prefix
, obj
);
1373 *out_fmt_ch
= fmt_ch
;
1377 void bt_lib_log(const char *func
, const char *file
, unsigned line
,
1378 int lvl
, const char *tag
, const char *fmt
, ...)
1383 va_start(args
, fmt
);
1384 bt_common_custom_vsnprintf(lib_logging_buf
, LIB_LOGGING_BUF_SIZE
, '!',
1385 handle_conversion_specifier_bt
, NULL
, fmt
, &args
);
1387 _bt_log_write_d(func
, file
, line
, lvl
, tag
, "%s", lib_logging_buf
);