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/port-internal.h>
71 #include <babeltrace/plugin/plugin-internal.h>
72 #include <babeltrace/plugin/plugin-so-internal.h>
74 #define LIB_LOGGING_BUF_SIZE (4096 * 4)
76 static char __thread lib_logging_buf
[LIB_LOGGING_BUF_SIZE
];
78 #define BUF_APPEND(_fmt, ...) \
81 size_t _size = LIB_LOGGING_BUF_SIZE - \
82 (size_t) (*buf_ch - lib_logging_buf); \
83 _count = snprintf(*buf_ch, _size, (_fmt), __VA_ARGS__); \
84 BT_ASSERT(_count >= 0); \
85 *buf_ch += MIN(_count, _size); \
86 if (*buf_ch >= lib_logging_buf + LIB_LOGGING_BUF_SIZE - 1) { \
91 #define BUF_APPEND_UUID(_uuid) \
93 BUF_APPEND(", %suuid=", prefix); \
94 format_uuid(buf_ch, (_uuid)); \
97 #define PRFIELD(_expr) prefix, (_expr)
99 #define PRFIELD_GSTRING(_expr) PRFIELD((_expr) ? (_expr)->str : NULL)
101 #define SET_TMP_PREFIX(_prefix2) \
103 strcpy(tmp_prefix, prefix); \
104 strcat(tmp_prefix, (_prefix2)); \
107 static inline void format_component(char **buf_ch
, bool extended
,
108 const char *prefix
, const struct bt_component
*component
);
110 static inline void format_port(char **buf_ch
, bool extended
,
111 const char *prefix
, const struct bt_port
*port
);
113 static inline void format_connection(char **buf_ch
, bool extended
,
114 const char *prefix
, const struct bt_connection
*connection
);
116 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
117 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
);
119 static inline void format_field_path(char **buf_ch
, bool extended
,
120 const char *prefix
, const struct bt_field_path
*field_path
);
122 static inline void format_object(char **buf_ch
, bool extended
,
123 const char *prefix
, const struct bt_object
*obj
)
125 BUF_APPEND(", %sref-count=%llu", prefix
, obj
->ref_count
);
128 static inline void format_uuid(char **buf_ch
, bt_uuid uuid
)
130 BUF_APPEND("\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
131 (unsigned int) uuid
[0],
132 (unsigned int) uuid
[1],
133 (unsigned int) uuid
[2],
134 (unsigned int) uuid
[3],
135 (unsigned int) uuid
[4],
136 (unsigned int) uuid
[5],
137 (unsigned int) uuid
[6],
138 (unsigned int) uuid
[7],
139 (unsigned int) uuid
[8],
140 (unsigned int) uuid
[9],
141 (unsigned int) uuid
[10],
142 (unsigned int) uuid
[11],
143 (unsigned int) uuid
[12],
144 (unsigned int) uuid
[13],
145 (unsigned int) uuid
[14],
146 (unsigned int) uuid
[15]);
149 static inline void format_object_pool(char **buf_ch
, bool extended
,
150 const char *prefix
, const struct bt_object_pool
*pool
)
152 BUF_APPEND(", %ssize=%zu", PRFIELD(pool
->size
));
155 BUF_APPEND(", %scap=%u", PRFIELD(pool
->objects
->len
));
159 static inline void format_integer_field_class(char **buf_ch
,
160 bool extended
, const char *prefix
,
161 const struct bt_field_class
*field_class
)
163 const struct bt_field_class_integer
*int_fc
=
164 (const void *) field_class
;
166 BUF_APPEND(", %srange-size=%" PRIu64
", %sbase=%s",
167 PRFIELD(int_fc
->range
),
168 PRFIELD(bt_common_field_class_integer_preferred_display_base_string(int_fc
->base
)));
171 static inline void format_array_field_class(char **buf_ch
,
172 bool extended
, const char *prefix
,
173 const struct bt_field_class
*field_class
)
175 const struct bt_field_class_array
*array_fc
=
176 (const void *) field_class
;
178 BUF_APPEND(", %selement-fc-addr=%p, %selement-fc-type=%s",
179 PRFIELD(array_fc
->element_fc
),
180 PRFIELD(bt_common_field_class_type_string(array_fc
->element_fc
->type
)));
183 static inline void format_field_class(char **buf_ch
, bool extended
,
184 const char *prefix
, const struct bt_field_class
*field_class
)
188 BUF_APPEND(", %stype=%s",
189 PRFIELD(bt_common_field_class_type_string(field_class
->type
)));
192 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field_class
->frozen
));
193 BUF_APPEND(", %sis-part-of-trace-class=%d",
194 PRFIELD(field_class
->part_of_trace_class
));
199 switch (field_class
->type
) {
200 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
201 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
203 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
206 case BT_FIELD_CLASS_TYPE_REAL
:
208 const struct bt_field_class_real
*real_fc
= (void *) field_class
;
210 BUF_APPEND(", %sis-single-precision=%d",
211 PRFIELD(real_fc
->is_single_precision
));
214 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
215 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
217 const struct bt_field_class_enumeration
*enum_fc
=
218 (const void *) field_class
;
220 format_integer_field_class(buf_ch
, extended
, prefix
, field_class
);
221 BUF_APPEND(", %smapping-count=%u",
222 PRFIELD(enum_fc
->mappings
->len
));
225 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
227 const struct bt_field_class_structure
*struct_fc
=
228 (const void *) field_class
;
230 if (struct_fc
->common
.named_fcs
) {
231 BUF_APPEND(", %smember-count=%u",
232 PRFIELD(struct_fc
->common
.named_fcs
->len
));
237 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
239 const struct bt_field_class_static_array
*array_fc
=
240 (const void *) field_class
;
242 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
243 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_fc
->length
));
246 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
248 const struct bt_field_class_dynamic_array
*array_fc
=
249 (const void *) field_class
;
251 format_array_field_class(buf_ch
, extended
, prefix
, field_class
);
253 if (array_fc
->length_fc
) {
254 SET_TMP_PREFIX("length-fc-");
255 format_field_class(buf_ch
, extended
, tmp_prefix
,
256 array_fc
->length_fc
);
259 if (array_fc
->length_field_path
) {
260 SET_TMP_PREFIX("length-field-path-");
261 format_field_path(buf_ch
, extended
, tmp_prefix
,
262 array_fc
->length_field_path
);
267 case BT_FIELD_CLASS_TYPE_VARIANT
:
269 const struct bt_field_class_variant
*var_fc
=
270 (const void *) field_class
;
272 if (var_fc
->common
.named_fcs
) {
273 BUF_APPEND(", %soption-count=%u",
274 PRFIELD(var_fc
->common
.named_fcs
->len
));
277 if (var_fc
->selector_fc
) {
278 SET_TMP_PREFIX("selector-fc-");
279 format_field_class(buf_ch
, extended
, tmp_prefix
,
280 var_fc
->selector_fc
);
283 if (var_fc
->selector_field_path
) {
284 SET_TMP_PREFIX("selector-field-path-");
285 format_field_path(buf_ch
, extended
, tmp_prefix
,
286 var_fc
->selector_field_path
);
296 static inline void format_field_integer_extended(char **buf_ch
,
297 const char *prefix
, const struct bt_field
*field
)
299 const struct bt_field_integer
*integer
= (void *) field
;
300 const struct bt_field_class_integer
*field_class
=
301 (void *) field
->class;
302 const char *fmt
= NULL
;
304 BT_ASSERT(field_class
);
306 if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
) {
307 fmt
= ", %svalue=%" PRIo64
;
308 } else if (field_class
->base
== BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
) {
309 fmt
= ", %svalue=%" PRIx64
;
312 if (field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
313 field_class
->common
.type
== BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
315 fmt
= ", %svalue=%" PRId64
;
318 BUF_APPEND(fmt
, PRFIELD(integer
->value
.i
));
321 fmt
= ", %svalue=%" PRIu64
;
324 BUF_APPEND(fmt
, PRFIELD(integer
->value
.u
));
328 static inline void format_field(char **buf_ch
, bool extended
,
329 const char *prefix
, const struct bt_field
*field
)
331 BUF_APPEND(", %sis-set=%d", PRFIELD(field
->is_set
));
334 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field
->frozen
));
337 BUF_APPEND(", %sclass-addr=%p", PRFIELD(field
->class));
343 BUF_APPEND(", %sclass-type=%s",
344 PRFIELD(bt_common_field_class_type_string(field
->class->type
)));
346 if (!extended
|| !field
->is_set
) {
350 switch (field
->class->type
) {
351 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
352 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
353 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
354 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
356 format_field_integer_extended(buf_ch
, prefix
, field
);
359 case BT_FIELD_CLASS_TYPE_REAL
:
361 const struct bt_field_real
*real_field
= (const void *) field
;
363 BUF_APPEND(", %svalue=%f", PRFIELD(real_field
->value
));
366 case BT_FIELD_CLASS_TYPE_STRING
:
368 const struct bt_field_string
*str
= (const void *) field
;
371 BT_ASSERT(str
->buf
->data
);
372 BUF_APPEND(", %spartial-value=\"%.32s\"",
373 PRFIELD(str
->buf
->data
));
378 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
379 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
381 const struct bt_field_array
*array_field
= (const void *) field
;
383 BUF_APPEND(", %slength=%" PRIu64
, PRFIELD(array_field
->length
));
385 if (array_field
->fields
) {
386 BUF_APPEND(", %sallocated-length=%u",
387 PRFIELD(array_field
->fields
->len
));
392 case BT_FIELD_CLASS_TYPE_VARIANT
:
394 const struct bt_field_variant
*var_field
= (const void *) field
;
396 BUF_APPEND(", %sselected-field-index=%" PRIu64
,
397 PRFIELD(var_field
->selected_index
));
405 static inline void format_field_path(char **buf_ch
, bool extended
,
406 const char *prefix
, const struct bt_field_path
*field_path
)
410 if (field_path
->indexes
) {
411 BT_ASSERT(field_path
->indexes
);
412 BUF_APPEND(", %sindex-count=%u",
413 PRFIELD(field_path
->indexes
->len
));
416 if (!extended
|| !field_path
->indexes
) {
420 BUF_APPEND(", %spath=[%s",
421 PRFIELD(bt_common_scope_string(field_path
->root
)));
423 for (i
= 0; i
< field_path
->indexes
->len
; i
++) {
424 uint64_t index
= bt_field_path_get_index_by_index_inline(
427 BUF_APPEND(", %" PRIu64
, index
);
430 BUF_APPEND("%s", "]");
433 static inline void format_trace_class(char **buf_ch
, bool extended
,
434 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(", %spacket-header-fc-addr=%p, "
459 "%sassigns-auto-sc-id=%d",
460 PRFIELD(trace_class
->packet_header_fc
),
461 PRFIELD(trace_class
->assigns_automatic_stream_class_id
));
462 SET_TMP_PREFIX("phf-pool-");
463 format_object_pool(buf_ch
, extended
, prefix
,
464 &trace_class
->packet_header_field_pool
);
467 static inline void format_trace(char **buf_ch
, bool extended
,
468 const char *prefix
, const struct bt_trace
*trace
)
472 if (trace
->name
.value
) {
473 BUF_APPEND(", %sname=\"%s\"", PRFIELD(trace
->name
.value
));
480 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace
->frozen
));
482 if (trace
->streams
) {
483 BUF_APPEND(", %sstream-count=%u",
484 PRFIELD(trace
->streams
->len
));
487 BUF_APPEND(", %sis-static=%d", PRFIELD(trace
->is_static
));
493 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace
->class));
494 SET_TMP_PREFIX("trace-class-");
495 format_trace_class(buf_ch
, false, tmp_prefix
, trace
->class);
498 static inline void format_stream_class(char **buf_ch
, bool extended
,
500 const struct bt_stream_class
*stream_class
)
502 const struct bt_trace_class
*trace_class
;
505 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream_class
->id
));
507 if (stream_class
->name
.value
) {
508 BUF_APPEND(", %sname=\"%s\"",
509 PRFIELD(stream_class
->name
.value
));
516 BUF_APPEND(", %sis-frozen=%d", PRFIELD(stream_class
->frozen
));
518 if (stream_class
->event_classes
) {
519 BUF_APPEND(", %sevent-class-count=%u",
520 PRFIELD(stream_class
->event_classes
->len
));
523 BUF_APPEND(", %spacket-context-fc-addr=%p, "
524 "%sevent-header-fc-addr=%p, %sevent-common-context-fc-addr=%p",
525 PRFIELD(stream_class
->packet_context_fc
),
526 PRFIELD(stream_class
->event_header_fc
),
527 PRFIELD(stream_class
->event_common_context_fc
));
528 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
533 BUF_APPEND(", %sassigns-auto-ec-id=%d, %sassigns-auto-stream-id=%d, "
534 "%spackets-have-discarded-ev-counter-snapshot=%d, "
535 "%spackets-have-packet-counter-snapshot=%d, "
536 "%spackets-have-default-begin-cs=%d, "
537 "%spackets-have-default-end-cs=%d",
538 PRFIELD(stream_class
->assigns_automatic_event_class_id
),
539 PRFIELD(stream_class
->assigns_automatic_stream_id
),
540 PRFIELD(stream_class
->packets_have_discarded_event_counter_snapshot
),
541 PRFIELD(stream_class
->packets_have_packet_counter_snapshot
),
542 PRFIELD(stream_class
->packets_have_default_beginning_cs
),
543 PRFIELD(stream_class
->packets_have_default_end_cs
));
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("ehf-pool-");
548 format_object_pool(buf_ch
, extended
, prefix
,
549 &stream_class
->event_header_field_pool
);
550 SET_TMP_PREFIX("pcf-pool-");
551 format_object_pool(buf_ch
, extended
, prefix
,
552 &stream_class
->packet_context_field_pool
);
555 static inline void format_event_class(char **buf_ch
, bool extended
,
556 const char *prefix
, const struct bt_event_class
*event_class
)
558 const struct bt_stream_class
*stream_class
;
559 const struct bt_trace_class
*trace_class
;
562 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(event_class
->id
));
564 if (event_class
->name
.value
) {
565 BUF_APPEND(", %sname=\"%s\"",
566 PRFIELD(event_class
->name
.value
));
573 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class
->frozen
));
575 if (event_class
->log_level
.base
.avail
) {
576 BUF_APPEND(", %slog-level=%s",
577 PRFIELD(bt_common_event_class_log_level_string(
578 (int) event_class
->log_level
.value
)));
581 if (event_class
->emf_uri
.value
) {
582 BUF_APPEND(", %semf-uri=\"%s\"",
583 PRFIELD(event_class
->emf_uri
.value
));
586 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
587 PRFIELD(event_class
->specific_context_fc
),
588 PRFIELD(event_class
->payload_fc
));
590 stream_class
= bt_event_class_borrow_stream_class_const(event_class
);
595 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
596 SET_TMP_PREFIX("stream-class-");
597 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
598 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
603 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
604 SET_TMP_PREFIX("trace-class-");
605 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
606 SET_TMP_PREFIX("event-pool-");
607 format_object_pool(buf_ch
, extended
, prefix
, &event_class
->event_pool
);
610 static inline void format_stream(char **buf_ch
, bool extended
,
611 const char *prefix
, const struct bt_stream
*stream
)
613 const struct bt_stream_class
*stream_class
;
614 const struct bt_trace_class
*trace_class
= NULL
;
615 const struct bt_trace
*trace
= NULL
;
618 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream
->id
));
620 if (stream
->name
.value
) {
621 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream
->name
.value
));
628 stream_class
= bt_stream_borrow_class_const(stream
);
630 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
631 SET_TMP_PREFIX("stream-class-");
632 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
633 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
637 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
638 SET_TMP_PREFIX("trace-class-");
639 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
642 trace
= bt_stream_borrow_trace_inline(stream
);
644 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace
));
645 SET_TMP_PREFIX("trace-");
646 format_trace(buf_ch
, false, tmp_prefix
, trace
);
649 SET_TMP_PREFIX("packet-pool-");
650 format_object_pool(buf_ch
, extended
, prefix
, &stream
->packet_pool
);
653 static inline void format_packet(char **buf_ch
, bool extended
,
654 const char *prefix
, const struct bt_packet
*packet
)
656 const struct bt_stream
*stream
;
657 const struct bt_trace_class
*trace_class
;
664 BUF_APPEND(", %sis-frozen=%d, %sheader-field-addr=%p, "
665 "%scontext-field-addr=%p",
666 PRFIELD(packet
->frozen
),
667 PRFIELD(packet
->header_field
? packet
->header_field
->field
: NULL
),
668 PRFIELD(packet
->context_field
? packet
->context_field
->field
: NULL
));
669 stream
= bt_packet_borrow_stream_const(packet
);
674 if (packet
->default_beginning_cs
) {
675 SET_TMP_PREFIX("default-begin-cs-");
676 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
677 packet
->default_beginning_cs
);
680 if (packet
->default_end_cs
) {
681 SET_TMP_PREFIX("default-end-cs-");
682 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
683 packet
->default_end_cs
);
686 if (packet
->discarded_event_counter_snapshot
.base
.avail
) {
687 BUF_APPEND(", %sdiscarded-ev-counter-snapshot=%" PRIu64
,
688 PRFIELD(packet
->discarded_event_counter_snapshot
.value
));
691 if (packet
->packet_counter_snapshot
.base
.avail
) {
692 BUF_APPEND(", %spacket-counter-snapshot=%" PRIu64
,
693 PRFIELD(packet
->packet_counter_snapshot
.value
));
696 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
697 SET_TMP_PREFIX("stream-");
698 format_stream(buf_ch
, false, tmp_prefix
, stream
);
699 trace_class
= (const struct bt_trace_class
*) bt_object_borrow_parent(&stream
->base
);
704 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
705 SET_TMP_PREFIX("trace-class-");
706 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
709 static inline void format_event(char **buf_ch
, bool extended
,
710 const char *prefix
, const struct bt_event
*event
)
712 const struct bt_packet
*packet
;
713 const struct bt_stream
*stream
;
714 const struct bt_trace_class
*trace_class
;
715 const struct bt_stream_class
*stream_class
;
722 BUF_APPEND(", %sis-frozen=%d, %sheader-field-addr=%p, "
723 "%scommon-context-field-addr=%p, "
724 "%sspecific-context-field-addr=%p, "
725 "%spayload-field-addr=%p, ",
726 PRFIELD(event
->frozen
),
727 PRFIELD(event
->header_field
?
728 event
->header_field
->field
: NULL
),
729 PRFIELD(event
->common_context_field
),
730 PRFIELD(event
->specific_context_field
),
731 PRFIELD(event
->payload_field
));
732 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event
->class));
738 SET_TMP_PREFIX("event-class-");
739 format_event_class(buf_ch
, false, tmp_prefix
, event
->class);
740 stream_class
= bt_event_class_borrow_stream_class(event
->class);
742 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
743 SET_TMP_PREFIX("stream-class-");
744 format_stream_class(buf_ch
, false, tmp_prefix
,
747 trace_class
= bt_stream_class_borrow_trace_class_inline(
750 BUF_APPEND(", %strace-class-addr=%p",
751 PRFIELD(trace_class
));
752 SET_TMP_PREFIX("trace-class-");
753 format_trace_class(buf_ch
, false, tmp_prefix
,
758 if (event
->default_cs
) {
759 SET_TMP_PREFIX("default-cs-");
760 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
764 packet
= bt_event_borrow_packet_const(event
);
769 BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet
));
770 SET_TMP_PREFIX("packet-");
771 format_packet(buf_ch
, false, tmp_prefix
, packet
);
772 stream
= bt_packet_borrow_stream_const(packet
);
777 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
778 SET_TMP_PREFIX("stream-");
779 format_stream(buf_ch
, false, tmp_prefix
, stream
);
782 static inline void format_clock_class(char **buf_ch
, bool extended
,
783 const char *prefix
, const struct bt_clock_class
*clock_class
)
787 if (clock_class
->name
.value
) {
788 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class
->name
.value
));
791 BUF_APPEND(", %sfreq=%" PRIu64
, PRFIELD(clock_class
->frequency
));
797 if (clock_class
->description
.value
) {
798 BUF_APPEND(", %spartial-descr=\"%.32s\"",
799 PRFIELD(clock_class
->description
.value
));
802 if (clock_class
->uuid
.value
) {
803 BUF_APPEND_UUID(clock_class
->uuid
.value
);
806 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64
", "
807 "%soffset-s=%" PRId64
", "
808 "%soffset-cycles=%" PRIu64
", %sis-absolute=%d, "
809 "%sbase-offset-ns=%" PRId64
,
810 PRFIELD(clock_class
->frozen
), PRFIELD(clock_class
->precision
),
811 PRFIELD(clock_class
->offset_seconds
),
812 PRFIELD(clock_class
->offset_cycles
),
813 PRFIELD(clock_class
->is_absolute
),
814 PRFIELD(clock_class
->base_offset
.value_ns
));
816 SET_TMP_PREFIX("cs-pool-");
817 format_object_pool(buf_ch
, extended
, prefix
, &clock_class
->cs_pool
);
820 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
821 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
)
824 BUF_APPEND(", %svalue=%" PRIu64
", %sns-from-origin=%" PRId64
,
825 PRFIELD(clock_snapshot
->value_cycles
),
826 PRFIELD(clock_snapshot
->ns_from_origin
));
832 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot
->is_set
));
834 if (clock_snapshot
->clock_class
) {
835 BUF_APPEND(", %sclock-class-addr=%p",
836 PRFIELD(clock_snapshot
->clock_class
));
837 SET_TMP_PREFIX("clock-class-");
838 format_clock_class(buf_ch
, false, tmp_prefix
,
839 clock_snapshot
->clock_class
);
843 static inline void format_value(char **buf_ch
, bool extended
,
844 const char *prefix
, const struct bt_value
*value
)
846 BUF_APPEND(", %stype=%s",
847 PRFIELD(bt_common_value_type_string(bt_value_get_type(value
))));
853 switch (bt_value_get_type(value
)) {
854 case BT_VALUE_TYPE_BOOL
:
856 bt_bool val
= bt_value_bool_get(value
);
858 BUF_APPEND(", %svalue=%d", PRFIELD(val
));
861 case BT_VALUE_TYPE_INTEGER
:
863 int64_t val
= bt_value_integer_get(value
);
865 BUF_APPEND(", %svalue=%" PRId64
, PRFIELD(val
));
868 case BT_VALUE_TYPE_REAL
:
870 double val
= bt_value_real_get(value
);
872 BUF_APPEND(", %svalue=%f", PRFIELD(val
));
875 case BT_VALUE_TYPE_STRING
:
877 const char *val
= bt_value_string_get(value
);
879 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val
));
882 case BT_VALUE_TYPE_ARRAY
:
884 int64_t count
= bt_value_array_get_size(value
);
886 BT_ASSERT(count
>= 0);
887 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
890 case BT_VALUE_TYPE_MAP
:
892 int64_t count
= bt_value_map_get_size(value
);
894 BT_ASSERT(count
>= 0);
895 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
903 static inline void format_message(char **buf_ch
, bool extended
,
904 const char *prefix
, const struct bt_message
*msg
)
908 BUF_APPEND(", %stype=%s",
909 PRFIELD(bt_message_type_string(msg
->type
)));
915 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
916 PRFIELD(msg
->frozen
), PRFIELD(msg
->graph
));
919 case BT_MESSAGE_TYPE_EVENT
:
921 const struct bt_message_event
*msg_event
=
924 if (msg_event
->event
) {
925 SET_TMP_PREFIX("event-");
926 format_event(buf_ch
, true, tmp_prefix
, msg_event
->event
);
931 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
933 const struct bt_message_stream_beginning
*msg_stream
=
936 if (msg_stream
->stream
) {
937 SET_TMP_PREFIX("stream-");
938 format_stream(buf_ch
, true, tmp_prefix
, msg_stream
->stream
);
943 case BT_MESSAGE_TYPE_STREAM_END
:
945 const struct bt_message_stream_end
*msg_stream
=
948 if (msg_stream
->stream
) {
949 SET_TMP_PREFIX("stream-");
950 format_stream(buf_ch
, true, tmp_prefix
, msg_stream
->stream
);
955 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
957 const struct bt_message_packet_beginning
*msg_packet
=
960 if (msg_packet
->packet
) {
961 SET_TMP_PREFIX("packet-");
962 format_packet(buf_ch
, true, tmp_prefix
, msg_packet
->packet
);
967 case BT_MESSAGE_TYPE_PACKET_END
:
969 const struct bt_message_packet_end
*msg_packet
=
972 if (msg_packet
->packet
) {
973 SET_TMP_PREFIX("packet-");
974 format_packet(buf_ch
, true, tmp_prefix
, msg_packet
->packet
);
984 static inline void format_plugin_so_shared_lib_handle(char **buf_ch
,
986 const struct bt_plugin_so_shared_lib_handle
*handle
)
988 BUF_APPEND(", %saddr=%p", PRFIELD(handle
));
991 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle
->path
));
995 static inline void format_component_class(char **buf_ch
, bool extended
,
997 const struct bt_component_class
*comp_class
)
1001 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1002 PRFIELD(bt_component_class_type_string(comp_class
->type
)),
1003 PRFIELD_GSTRING(comp_class
->name
));
1005 if (comp_class
->description
) {
1006 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1007 PRFIELD_GSTRING(comp_class
->description
));
1014 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class
->frozen
));
1016 if (comp_class
->so_handle
) {
1017 SET_TMP_PREFIX("so-handle-");
1018 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1019 comp_class
->so_handle
);
1023 static inline void format_component(char **buf_ch
, bool extended
,
1024 const char *prefix
, const struct bt_component
*component
)
1026 char tmp_prefix
[64];
1028 BUF_APPEND(", %sname=\"%s\"",
1029 PRFIELD_GSTRING(component
->name
));
1031 if (component
->class) {
1032 SET_TMP_PREFIX("class-");
1033 format_component_class(buf_ch
, extended
, tmp_prefix
,
1041 if (component
->input_ports
) {
1042 BUF_APPEND(", %sinput-port-count=%u",
1043 PRFIELD(component
->input_ports
->len
));
1046 if (component
->output_ports
) {
1047 BUF_APPEND(", %soutput-port-count=%u",
1048 PRFIELD(component
->output_ports
->len
));
1052 static inline void format_port(char **buf_ch
, bool extended
,
1053 const char *prefix
, const struct bt_port
*port
)
1055 char tmp_prefix
[64];
1057 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1058 PRFIELD(bt_port_type_string(port
->type
)),
1059 PRFIELD_GSTRING(port
->name
));
1065 if (port
->connection
) {
1066 SET_TMP_PREFIX("conn-");
1067 format_connection(buf_ch
, false, tmp_prefix
, port
->connection
);
1071 static inline void format_connection(char **buf_ch
, bool extended
,
1072 const char *prefix
, const struct bt_connection
*connection
)
1074 char tmp_prefix
[64];
1080 if (connection
->upstream_port
) {
1081 SET_TMP_PREFIX("upstream-port-");
1082 format_port(buf_ch
, false, tmp_prefix
,
1083 connection
->upstream_port
);
1086 if (connection
->downstream_port
) {
1087 SET_TMP_PREFIX("downstream-port-");
1088 format_port(buf_ch
, false, tmp_prefix
,
1089 connection
->downstream_port
);
1093 static inline void format_graph(char **buf_ch
, bool extended
,
1094 const char *prefix
, const struct bt_graph
*graph
)
1096 char tmp_prefix
[64];
1098 BUF_APPEND(", %sis-canceled=%d", PRFIELD(graph
->canceled
));
1104 if (graph
->components
) {
1105 BUF_APPEND(", %scomp-count=%u",
1106 PRFIELD(graph
->components
->len
));
1109 if (graph
->connections
) {
1110 BUF_APPEND(", %sconn-count=%u",
1111 PRFIELD(graph
->connections
->len
));
1114 SET_TMP_PREFIX("en-pool-");
1115 format_object_pool(buf_ch
, extended
, prefix
,
1116 &graph
->event_msg_pool
);
1117 SET_TMP_PREFIX("pbn-pool-");
1118 format_object_pool(buf_ch
, extended
, prefix
,
1119 &graph
->packet_begin_msg_pool
);
1120 SET_TMP_PREFIX("pen-pool-");
1121 format_object_pool(buf_ch
, extended
, prefix
,
1122 &graph
->packet_end_msg_pool
);
1125 static inline void format_message_iterator(char **buf_ch
,
1126 bool extended
, const char *prefix
,
1127 const struct bt_message_iterator
*iterator
)
1130 char tmp_prefix
[64];
1132 if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
) {
1133 type
= "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1134 } else if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
) {
1135 type
= "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1140 BUF_APPEND(", %stype=%s", PRFIELD(type
));
1142 switch (iterator
->type
) {
1143 case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
:
1145 const struct bt_self_component_port_input_message_iterator
*
1146 port_in_iter
= (const void *) iterator
;
1148 if (port_in_iter
->upstream_component
) {
1149 SET_TMP_PREFIX("upstream-comp-");
1150 format_component(buf_ch
, false, tmp_prefix
,
1151 port_in_iter
->upstream_component
);
1154 if (port_in_iter
->upstream_port
) {
1155 SET_TMP_PREFIX("upstream-port-");
1156 format_port(buf_ch
, false, tmp_prefix
,
1157 port_in_iter
->upstream_port
);
1160 if (port_in_iter
->connection
) {
1161 SET_TMP_PREFIX("upstream-conn-");
1162 format_connection(buf_ch
, false, tmp_prefix
,
1163 port_in_iter
->connection
);
1167 case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
:
1169 const struct bt_port_output_message_iterator
*port_out_iter
=
1170 (const void *) iterator
;
1172 if (port_out_iter
->graph
) {
1173 SET_TMP_PREFIX("graph-");
1174 format_graph(buf_ch
, false, tmp_prefix
,
1175 port_out_iter
->graph
);
1178 if (port_out_iter
->colander
) {
1179 SET_TMP_PREFIX("colander-comp-");
1180 format_component(buf_ch
, false, tmp_prefix
,
1181 (void *) port_out_iter
->colander
);
1191 static inline void format_plugin(char **buf_ch
, bool extended
,
1192 const char *prefix
, const struct bt_plugin
*plugin
)
1194 char tmp_prefix
[64];
1196 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin
->type
)));
1198 if (plugin
->info
.path_set
) {
1199 BUF_APPEND(", %spath=\"%s\"",
1200 PRFIELD_GSTRING(plugin
->info
.path
));
1203 if (plugin
->info
.name_set
) {
1204 BUF_APPEND(", %sname=\"%s\"",
1205 PRFIELD_GSTRING(plugin
->info
.name
));
1212 if (plugin
->info
.author_set
) {
1213 BUF_APPEND(", %sauthor=\"%s\"",
1214 PRFIELD_GSTRING(plugin
->info
.author
));
1217 if (plugin
->info
.license_set
) {
1218 BUF_APPEND(", %slicense=\"%s\"",
1219 PRFIELD_GSTRING(plugin
->info
.license
));
1222 if (plugin
->info
.version_set
) {
1223 BUF_APPEND(", %sversion=%u.%u.%u%s",
1224 PRFIELD(plugin
->info
.version
.major
),
1225 plugin
->info
.version
.minor
,
1226 plugin
->info
.version
.patch
,
1227 plugin
->info
.version
.extra
?
1228 plugin
->info
.version
.extra
->str
: "");
1231 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1232 "%ssink-comp-class-count=%u",
1233 PRFIELD(plugin
->src_comp_classes
->len
),
1234 PRFIELD(plugin
->flt_comp_classes
->len
),
1235 PRFIELD(plugin
->sink_comp_classes
->len
));
1237 if (plugin
->spec_data
) {
1238 const struct bt_plugin_so_spec_data
*spec_data
=
1239 (const void *) plugin
->spec_data
;
1241 if (spec_data
->shared_lib_handle
) {
1242 SET_TMP_PREFIX("so-handle-");
1243 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1244 spec_data
->shared_lib_handle
);
1249 static inline void handle_conversion_specifier_bt(void *priv_data
,
1250 char **buf_ch
, size_t avail_size
,
1251 const char **out_fmt_ch
, va_list *args
)
1253 const char *fmt_ch
= *out_fmt_ch
;
1254 bool extended
= false;
1256 char *prefix_ch
= prefix
;
1262 if (*fmt_ch
== 'u') {
1264 obj
= va_arg(*args
, void *);
1265 format_uuid(buf_ch
, obj
);
1269 if (*fmt_ch
== '[') {
1274 if (*fmt_ch
== ']') {
1280 *prefix_ch
= *fmt_ch
;
1288 if (*fmt_ch
== '+') {
1293 obj
= va_arg(*args
, void *);
1294 BUF_APPEND("%saddr=%p", prefix
, obj
);
1302 format_field_class(buf_ch
, extended
, prefix
, obj
);
1305 format_field(buf_ch
, extended
, prefix
, obj
);
1308 format_field_path(buf_ch
, extended
, prefix
, obj
);
1311 format_event_class(buf_ch
, extended
, prefix
, obj
);
1314 format_event(buf_ch
, extended
, prefix
, obj
);
1317 format_stream_class(buf_ch
, extended
, prefix
, obj
);
1320 format_stream(buf_ch
, extended
, prefix
, obj
);
1323 format_packet(buf_ch
, extended
, prefix
, obj
);
1326 format_trace(buf_ch
, extended
, prefix
, obj
);
1329 format_trace_class(buf_ch
, extended
, prefix
, obj
);
1332 format_clock_class(buf_ch
, extended
, prefix
, obj
);
1335 format_clock_snapshot(buf_ch
, extended
, prefix
, obj
);
1338 format_value(buf_ch
, extended
, prefix
, obj
);
1341 format_message(buf_ch
, extended
, prefix
, obj
);
1344 format_message_iterator(buf_ch
, extended
, prefix
, obj
);
1347 format_component_class(buf_ch
, extended
, prefix
, obj
);
1350 format_component(buf_ch
, extended
, prefix
, obj
);
1353 format_port(buf_ch
, extended
, prefix
, obj
);
1356 format_connection(buf_ch
, extended
, prefix
, obj
);
1359 format_plugin(buf_ch
, extended
, prefix
, obj
);
1362 format_graph(buf_ch
, extended
, prefix
, obj
);
1365 format_object_pool(buf_ch
, extended
, prefix
, obj
);
1368 format_object(buf_ch
, extended
, prefix
, obj
);
1376 *out_fmt_ch
= fmt_ch
;
1380 void bt_lib_log(const char *func
, const char *file
, unsigned line
,
1381 int lvl
, const char *tag
, const char *fmt
, ...)
1386 va_start(args
, fmt
);
1387 bt_common_custom_vsnprintf(lib_logging_buf
, LIB_LOGGING_BUF_SIZE
, '!',
1388 handle_conversion_specifier_bt
, NULL
, fmt
, &args
);
1390 _bt_log_write_d(func
, file
, line
, lvl
, tag
, "%s", lib_logging_buf
);