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 "common/common.h"
34 #include "lib/value.h"
35 #include "lib/value.h"
36 #include "lib/object-pool.h"
37 #include <babeltrace2/trace-ir/event-const.h>
38 #include <babeltrace2/trace-ir/packet-const.h>
39 #include <babeltrace2/trace-ir/stream-const.h>
41 #include "graph/component-class.h"
42 #include "graph/component-class-sink-colander.h"
43 #include "graph/component-filter.h"
44 #include "graph/component.h"
45 #include "graph/component-sink.h"
46 #include "graph/component-source.h"
47 #include "graph/connection.h"
48 #include "graph/graph.h"
49 #include "graph/message/discarded-items.h"
50 #include "graph/message/event.h"
51 #include "graph/message/iterator.h"
52 #include "graph/message/message.h"
53 #include "graph/message/message-iterator-inactivity.h"
54 #include "graph/message/packet.h"
55 #include "graph/message/stream-activity.h"
56 #include "graph/message/stream.h"
57 #include "graph/port.h"
58 #include "lib-logging.h"
59 #include "plugin/plugin.h"
60 #include "plugin/plugin-so.h"
61 #include "trace-ir/clock-class.h"
62 #include "trace-ir/clock-snapshot.h"
63 #include "trace-ir/event-class.h"
64 #include "trace-ir/event.h"
65 #include "trace-ir/field-class.h"
66 #include "trace-ir/field.h"
67 #include "trace-ir/field-path.h"
68 #include "trace-ir/packet.h"
69 #include "trace-ir/stream-class.h"
70 #include "trace-ir/stream.h"
71 #include "trace-ir/trace-class.h"
72 #include "trace-ir/trace.h"
73 #include "trace-ir/utils.h"
74 #include "assert-pre.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 "%ssupports-discarded-events=%d, "
541 "%sdiscarded-events-have-default-cs=%d, "
542 "%ssupports-discarded-packets=%d, "
543 "%sdiscarded-packets-have-default-cs=%d",
544 PRFIELD(stream_class
->assigns_automatic_event_class_id
),
545 PRFIELD(stream_class
->assigns_automatic_stream_id
),
546 PRFIELD(stream_class
->packets_have_beginning_default_clock_snapshot
),
547 PRFIELD(stream_class
->packets_have_end_default_clock_snapshot
),
548 PRFIELD(stream_class
->supports_discarded_events
),
549 PRFIELD(stream_class
->discarded_events_have_default_clock_snapshots
),
550 PRFIELD(stream_class
->supports_discarded_packets
),
551 PRFIELD(stream_class
->discarded_packets_have_default_clock_snapshots
));
552 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
553 SET_TMP_PREFIX("trace-class-");
554 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
555 SET_TMP_PREFIX("pcf-pool-");
556 format_object_pool(buf_ch
, extended
, tmp_prefix
,
557 &stream_class
->packet_context_field_pool
);
560 static inline void format_event_class(char **buf_ch
, bool extended
,
561 const char *prefix
, const struct bt_event_class
*event_class
)
563 const struct bt_stream_class
*stream_class
;
564 const struct bt_trace_class
*trace_class
;
565 char tmp_prefix
[TMP_PREFIX_LEN
];
567 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(event_class
->id
));
569 if (event_class
->name
.value
) {
570 BUF_APPEND(", %sname=\"%s\"",
571 PRFIELD(event_class
->name
.value
));
578 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class
->frozen
));
580 if (event_class
->log_level
.base
.avail
) {
581 BUF_APPEND(", %slog-level=%s",
582 PRFIELD(bt_common_event_class_log_level_string(
583 (int) event_class
->log_level
.value
)));
586 if (event_class
->emf_uri
.value
) {
587 BUF_APPEND(", %semf-uri=\"%s\"",
588 PRFIELD(event_class
->emf_uri
.value
));
591 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
592 PRFIELD(event_class
->specific_context_fc
),
593 PRFIELD(event_class
->payload_fc
));
595 stream_class
= bt_event_class_borrow_stream_class_const(event_class
);
600 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
601 SET_TMP_PREFIX("stream-class-");
602 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
603 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
608 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
609 SET_TMP_PREFIX("trace-class-");
610 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
611 SET_TMP_PREFIX("event-pool-");
612 format_object_pool(buf_ch
, extended
, tmp_prefix
,
613 &event_class
->event_pool
);
616 static inline void format_stream(char **buf_ch
, bool extended
,
617 const char *prefix
, const struct bt_stream
*stream
)
619 const struct bt_stream_class
*stream_class
;
620 const struct bt_trace_class
*trace_class
= NULL
;
621 const struct bt_trace
*trace
= NULL
;
622 char tmp_prefix
[TMP_PREFIX_LEN
];
624 BUF_APPEND(", %sid=%" PRIu64
, PRFIELD(stream
->id
));
626 if (stream
->name
.value
) {
627 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream
->name
.value
));
634 stream_class
= bt_stream_borrow_class_const(stream
);
636 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
637 SET_TMP_PREFIX("stream-class-");
638 format_stream_class(buf_ch
, false, tmp_prefix
, stream_class
);
639 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
643 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
644 SET_TMP_PREFIX("trace-class-");
645 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
648 trace
= bt_stream_borrow_trace_inline(stream
);
650 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace
));
651 SET_TMP_PREFIX("trace-");
652 format_trace(buf_ch
, false, tmp_prefix
, trace
);
655 SET_TMP_PREFIX("packet-pool-");
656 format_object_pool(buf_ch
, extended
, tmp_prefix
, &stream
->packet_pool
);
659 static inline void format_packet(char **buf_ch
, bool extended
,
660 const char *prefix
, const struct bt_packet
*packet
)
662 const struct bt_stream
*stream
;
663 const struct bt_trace_class
*trace_class
;
664 char tmp_prefix
[TMP_PREFIX_LEN
];
670 BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
671 PRFIELD(packet
->frozen
),
672 PRFIELD(packet
->context_field
? packet
->context_field
->field
: NULL
));
673 stream
= bt_packet_borrow_stream_const(packet
);
678 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
679 SET_TMP_PREFIX("stream-");
680 format_stream(buf_ch
, false, tmp_prefix
, stream
);
681 trace_class
= (const struct bt_trace_class
*) bt_object_borrow_parent(&stream
->base
);
686 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class
));
687 SET_TMP_PREFIX("trace-class-");
688 format_trace_class(buf_ch
, false, tmp_prefix
, trace_class
);
691 static inline void format_event(char **buf_ch
, bool extended
,
692 const char *prefix
, const struct bt_event
*event
)
694 const struct bt_packet
*packet
;
695 const struct bt_stream
*stream
;
696 const struct bt_trace_class
*trace_class
;
697 const struct bt_stream_class
*stream_class
;
698 char tmp_prefix
[TMP_PREFIX_LEN
];
704 BUF_APPEND(", %sis-frozen=%d, "
705 "%scommon-context-field-addr=%p, "
706 "%sspecific-context-field-addr=%p, "
707 "%spayload-field-addr=%p, ",
708 PRFIELD(event
->frozen
),
709 PRFIELD(event
->common_context_field
),
710 PRFIELD(event
->specific_context_field
),
711 PRFIELD(event
->payload_field
));
712 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event
->class));
718 SET_TMP_PREFIX("event-class-");
719 format_event_class(buf_ch
, false, tmp_prefix
, event
->class);
720 stream_class
= bt_event_class_borrow_stream_class(event
->class);
722 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class
));
723 SET_TMP_PREFIX("stream-class-");
724 format_stream_class(buf_ch
, false, tmp_prefix
,
727 trace_class
= bt_stream_class_borrow_trace_class_inline(
730 BUF_APPEND(", %strace-class-addr=%p",
731 PRFIELD(trace_class
));
732 SET_TMP_PREFIX("trace-class-");
733 format_trace_class(buf_ch
, false, tmp_prefix
,
738 packet
= bt_event_borrow_packet_const(event
);
743 BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet
));
744 SET_TMP_PREFIX("packet-");
745 format_packet(buf_ch
, false, tmp_prefix
, packet
);
746 stream
= bt_packet_borrow_stream_const(packet
);
751 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream
));
752 SET_TMP_PREFIX("stream-");
753 format_stream(buf_ch
, false, tmp_prefix
, stream
);
756 static inline void format_clock_class(char **buf_ch
, bool extended
,
757 const char *prefix
, const struct bt_clock_class
*clock_class
)
759 char tmp_prefix
[TMP_PREFIX_LEN
];
761 if (clock_class
->name
.value
) {
762 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class
->name
.value
));
765 BUF_APPEND(", %sfreq=%" PRIu64
, PRFIELD(clock_class
->frequency
));
771 if (clock_class
->description
.value
) {
772 BUF_APPEND(", %spartial-descr=\"%.32s\"",
773 PRFIELD(clock_class
->description
.value
));
776 if (clock_class
->uuid
.value
) {
777 BUF_APPEND_UUID(clock_class
->uuid
.value
);
780 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64
", "
781 "%soffset-s=%" PRId64
", "
782 "%soffset-cycles=%" PRIu64
", %sorigin-is-unix-epoch=%d, "
783 "%sbase-offset-ns=%" PRId64
,
784 PRFIELD(clock_class
->frozen
), PRFIELD(clock_class
->precision
),
785 PRFIELD(clock_class
->offset_seconds
),
786 PRFIELD(clock_class
->offset_cycles
),
787 PRFIELD(clock_class
->origin_is_unix_epoch
),
788 PRFIELD(clock_class
->base_offset
.value_ns
));
790 SET_TMP_PREFIX("cs-pool-");
791 format_object_pool(buf_ch
, extended
, tmp_prefix
,
792 &clock_class
->cs_pool
);
795 static inline void format_clock_snapshot(char **buf_ch
, bool extended
,
796 const char *prefix
, const struct bt_clock_snapshot
*clock_snapshot
)
798 char tmp_prefix
[TMP_PREFIX_LEN
];
799 BUF_APPEND(", %svalue=%" PRIu64
", %sns-from-origin=%" PRId64
,
800 PRFIELD(clock_snapshot
->value_cycles
),
801 PRFIELD(clock_snapshot
->ns_from_origin
));
807 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot
->is_set
));
809 if (clock_snapshot
->clock_class
) {
810 BUF_APPEND(", %sclock-class-addr=%p",
811 PRFIELD(clock_snapshot
->clock_class
));
812 SET_TMP_PREFIX("clock-class-");
813 format_clock_class(buf_ch
, false, tmp_prefix
,
814 clock_snapshot
->clock_class
);
818 static inline void format_value(char **buf_ch
, bool extended
,
819 const char *prefix
, const struct bt_value
*value
)
821 BUF_APPEND(", %stype=%s",
822 PRFIELD(bt_common_value_type_string(bt_value_get_type(value
))));
828 switch (bt_value_get_type(value
)) {
829 case BT_VALUE_TYPE_BOOL
:
831 bt_bool val
= bt_value_bool_get(value
);
833 BUF_APPEND(", %svalue=%d", PRFIELD(val
));
836 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
838 BUF_APPEND(", %svalue=%" PRIu64
,
839 PRFIELD(bt_value_unsigned_integer_get(value
)));
842 case BT_VALUE_TYPE_SIGNED_INTEGER
:
844 BUF_APPEND(", %svalue=%" PRId64
,
845 PRFIELD(bt_value_signed_integer_get(value
)));
848 case BT_VALUE_TYPE_REAL
:
850 double val
= bt_value_real_get(value
);
852 BUF_APPEND(", %svalue=%f", PRFIELD(val
));
855 case BT_VALUE_TYPE_STRING
:
857 const char *val
= bt_value_string_get(value
);
859 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val
));
862 case BT_VALUE_TYPE_ARRAY
:
864 int64_t count
= bt_value_array_get_size(value
);
866 BT_ASSERT(count
>= 0);
867 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
870 case BT_VALUE_TYPE_MAP
:
872 int64_t count
= bt_value_map_get_size(value
);
874 BT_ASSERT(count
>= 0);
875 BUF_APPEND(", %selement-count=%" PRId64
, PRFIELD(count
));
883 static inline void format_message(char **buf_ch
, bool extended
,
884 const char *prefix
, const struct bt_message
*msg
)
886 char tmp_prefix
[TMP_PREFIX_LEN
];
888 BUF_APPEND(", %stype=%s",
889 PRFIELD(bt_message_type_string(msg
->type
)));
895 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
896 PRFIELD(msg
->frozen
), PRFIELD(msg
->graph
));
899 case BT_MESSAGE_TYPE_EVENT
:
901 const struct bt_message_event
*msg_event
=
904 if (msg_event
->event
) {
905 SET_TMP_PREFIX("event-");
906 format_event(buf_ch
, true, tmp_prefix
,
910 if (msg_event
->default_cs
) {
911 SET_TMP_PREFIX("default-cs-");
912 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
913 msg_event
->default_cs
);
918 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
919 case BT_MESSAGE_TYPE_STREAM_END
:
921 const struct bt_message_stream
*msg_stream
= (const void *) msg
;
923 if (msg_stream
->stream
) {
924 SET_TMP_PREFIX("stream-");
925 format_stream(buf_ch
, true, tmp_prefix
,
931 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
932 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
934 const struct bt_message_stream_activity
*msg_stream_activity
=
937 if (msg_stream_activity
->stream
) {
938 SET_TMP_PREFIX("stream-");
939 format_stream(buf_ch
, true, tmp_prefix
,
940 msg_stream_activity
->stream
);
943 BUF_APPEND(", %sdefault-cs-state=%s",
944 PRFIELD(bt_message_stream_activity_clock_snapshot_state_string(
945 msg_stream_activity
->default_cs_state
)));
947 if (msg_stream_activity
->default_cs
) {
948 SET_TMP_PREFIX("default-cs-");
949 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
950 msg_stream_activity
->default_cs
);
955 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
956 case BT_MESSAGE_TYPE_PACKET_END
:
958 const struct bt_message_packet
*msg_packet
= (const void *) msg
;
960 if (msg_packet
->packet
) {
961 SET_TMP_PREFIX("packet-");
962 format_packet(buf_ch
, true, tmp_prefix
,
966 if (msg_packet
->default_cs
) {
967 SET_TMP_PREFIX("default-cs-");
968 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
969 msg_packet
->default_cs
);
974 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
975 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
977 const struct bt_message_discarded_items
*msg_disc_items
=
980 if (msg_disc_items
->stream
) {
981 SET_TMP_PREFIX("stream-");
982 format_stream(buf_ch
, true, tmp_prefix
,
983 msg_disc_items
->stream
);
986 if (msg_disc_items
->default_begin_cs
) {
987 SET_TMP_PREFIX("default-begin-cs-");
988 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
989 msg_disc_items
->default_begin_cs
);
992 if (msg_disc_items
->default_end_cs
) {
993 SET_TMP_PREFIX("default-end-cs-");
994 format_clock_snapshot(buf_ch
, true, tmp_prefix
,
995 msg_disc_items
->default_end_cs
);
998 if (msg_disc_items
->count
.base
.avail
) {
999 BUF_APPEND(", %scount=%" PRIu64
,
1000 PRFIELD(msg_disc_items
->count
.value
));
1010 static inline void format_plugin_so_shared_lib_handle(char **buf_ch
,
1012 const struct bt_plugin_so_shared_lib_handle
*handle
)
1014 BUF_APPEND(", %saddr=%p", PRFIELD(handle
));
1017 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle
->path
));
1021 static inline void format_component_class(char **buf_ch
, bool extended
,
1023 const struct bt_component_class
*comp_class
)
1025 char tmp_prefix
[TMP_PREFIX_LEN
];
1027 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1028 PRFIELD(bt_component_class_type_string(comp_class
->type
)),
1029 PRFIELD_GSTRING(comp_class
->name
));
1031 if (comp_class
->description
) {
1032 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1033 PRFIELD_GSTRING(comp_class
->description
));
1040 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class
->frozen
));
1042 if (comp_class
->so_handle
) {
1043 SET_TMP_PREFIX("so-handle-");
1044 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1045 comp_class
->so_handle
);
1049 static inline void format_component(char **buf_ch
, bool extended
,
1050 const char *prefix
, const struct bt_component
*component
)
1052 char tmp_prefix
[TMP_PREFIX_LEN
];
1054 BUF_APPEND(", %sname=\"%s\"",
1055 PRFIELD_GSTRING(component
->name
));
1057 if (component
->class) {
1058 SET_TMP_PREFIX("class-");
1059 format_component_class(buf_ch
, extended
, tmp_prefix
,
1067 if (component
->input_ports
) {
1068 BUF_APPEND(", %sinput-port-count=%u",
1069 PRFIELD(component
->input_ports
->len
));
1072 if (component
->output_ports
) {
1073 BUF_APPEND(", %soutput-port-count=%u",
1074 PRFIELD(component
->output_ports
->len
));
1078 static inline void format_port(char **buf_ch
, bool extended
,
1079 const char *prefix
, const struct bt_port
*port
)
1081 char tmp_prefix
[TMP_PREFIX_LEN
];
1083 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1084 PRFIELD(bt_port_type_string(port
->type
)),
1085 PRFIELD_GSTRING(port
->name
));
1091 if (port
->connection
) {
1092 SET_TMP_PREFIX("conn-");
1093 format_connection(buf_ch
, false, tmp_prefix
, port
->connection
);
1097 static inline void format_connection(char **buf_ch
, bool extended
,
1098 const char *prefix
, const struct bt_connection
*connection
)
1100 char tmp_prefix
[TMP_PREFIX_LEN
];
1106 if (connection
->upstream_port
) {
1107 SET_TMP_PREFIX("upstream-port-");
1108 format_port(buf_ch
, false, tmp_prefix
,
1109 connection
->upstream_port
);
1112 if (connection
->downstream_port
) {
1113 SET_TMP_PREFIX("downstream-port-");
1114 format_port(buf_ch
, false, tmp_prefix
,
1115 connection
->downstream_port
);
1119 static inline void format_graph(char **buf_ch
, bool extended
,
1120 const char *prefix
, const struct bt_graph
*graph
)
1122 char tmp_prefix
[TMP_PREFIX_LEN
];
1124 BUF_APPEND(", %sis-canceled=%d, %scan-consume=%d, "
1125 "%sconfig-state=%s",
1126 PRFIELD(graph
->canceled
),
1127 PRFIELD(graph
->can_consume
),
1128 PRFIELD(bt_graph_configuration_state_string(graph
->config_state
)));
1134 if (graph
->components
) {
1135 BUF_APPEND(", %scomp-count=%u",
1136 PRFIELD(graph
->components
->len
));
1139 if (graph
->connections
) {
1140 BUF_APPEND(", %sconn-count=%u",
1141 PRFIELD(graph
->connections
->len
));
1144 SET_TMP_PREFIX("en-pool-");
1145 format_object_pool(buf_ch
, extended
, tmp_prefix
,
1146 &graph
->event_msg_pool
);
1147 SET_TMP_PREFIX("pbn-pool-");
1148 format_object_pool(buf_ch
, extended
, tmp_prefix
,
1149 &graph
->packet_begin_msg_pool
);
1150 SET_TMP_PREFIX("pen-pool-");
1151 format_object_pool(buf_ch
, extended
, tmp_prefix
,
1152 &graph
->packet_end_msg_pool
);
1155 static inline void format_message_iterator(char **buf_ch
,
1156 bool extended
, const char *prefix
,
1157 const struct bt_message_iterator
*iterator
)
1160 char tmp_prefix
[TMP_PREFIX_LEN
];
1162 if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
) {
1163 type
= "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1164 } else if (iterator
->type
== BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
) {
1165 type
= "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1170 BUF_APPEND(", %stype=%s", PRFIELD(type
));
1172 switch (iterator
->type
) {
1173 case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
:
1175 const struct bt_self_component_port_input_message_iterator
*
1176 port_in_iter
= (const void *) iterator
;
1178 if (port_in_iter
->upstream_component
) {
1179 SET_TMP_PREFIX("upstream-comp-");
1180 format_component(buf_ch
, false, tmp_prefix
,
1181 port_in_iter
->upstream_component
);
1184 if (port_in_iter
->upstream_port
) {
1185 SET_TMP_PREFIX("upstream-port-");
1186 format_port(buf_ch
, false, tmp_prefix
,
1187 port_in_iter
->upstream_port
);
1190 if (port_in_iter
->connection
) {
1191 SET_TMP_PREFIX("upstream-conn-");
1192 format_connection(buf_ch
, false, tmp_prefix
,
1193 port_in_iter
->connection
);
1197 case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
:
1199 const struct bt_port_output_message_iterator
*port_out_iter
=
1200 (const void *) iterator
;
1202 if (port_out_iter
->graph
) {
1203 SET_TMP_PREFIX("graph-");
1204 format_graph(buf_ch
, false, tmp_prefix
,
1205 port_out_iter
->graph
);
1208 if (port_out_iter
->colander
) {
1209 SET_TMP_PREFIX("colander-comp-");
1210 format_component(buf_ch
, false, tmp_prefix
,
1211 (void *) port_out_iter
->colander
);
1221 static inline void format_plugin(char **buf_ch
, bool extended
,
1222 const char *prefix
, const struct bt_plugin
*plugin
)
1224 char tmp_prefix
[TMP_PREFIX_LEN
];
1226 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin
->type
)));
1228 if (plugin
->info
.path_set
) {
1229 BUF_APPEND(", %spath=\"%s\"",
1230 PRFIELD_GSTRING(plugin
->info
.path
));
1233 if (plugin
->info
.name_set
) {
1234 BUF_APPEND(", %sname=\"%s\"",
1235 PRFIELD_GSTRING(plugin
->info
.name
));
1242 if (plugin
->info
.author_set
) {
1243 BUF_APPEND(", %sauthor=\"%s\"",
1244 PRFIELD_GSTRING(plugin
->info
.author
));
1247 if (plugin
->info
.license_set
) {
1248 BUF_APPEND(", %slicense=\"%s\"",
1249 PRFIELD_GSTRING(plugin
->info
.license
));
1252 if (plugin
->info
.version_set
) {
1253 BUF_APPEND(", %sversion=%u.%u.%u%s",
1254 PRFIELD(plugin
->info
.version
.major
),
1255 plugin
->info
.version
.minor
,
1256 plugin
->info
.version
.patch
,
1257 plugin
->info
.version
.extra
?
1258 plugin
->info
.version
.extra
->str
: "");
1261 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1262 "%ssink-comp-class-count=%u",
1263 PRFIELD(plugin
->src_comp_classes
->len
),
1264 PRFIELD(plugin
->flt_comp_classes
->len
),
1265 PRFIELD(plugin
->sink_comp_classes
->len
));
1267 if (plugin
->spec_data
) {
1268 const struct bt_plugin_so_spec_data
*spec_data
=
1269 (const void *) plugin
->spec_data
;
1271 if (spec_data
->shared_lib_handle
) {
1272 SET_TMP_PREFIX("so-handle-");
1273 format_plugin_so_shared_lib_handle(buf_ch
, tmp_prefix
,
1274 spec_data
->shared_lib_handle
);
1279 static inline void handle_conversion_specifier_bt(void *priv_data
,
1280 char **buf_ch
, size_t avail_size
,
1281 const char **out_fmt_ch
, va_list *args
)
1283 const char *fmt_ch
= *out_fmt_ch
;
1284 bool extended
= false;
1286 char *prefix_ch
= prefix
;
1292 if (*fmt_ch
== 'u') {
1294 obj
= va_arg(*args
, void *);
1295 format_uuid(buf_ch
, obj
);
1299 if (*fmt_ch
== '[') {
1304 if (*fmt_ch
== ']') {
1310 *prefix_ch
= *fmt_ch
;
1318 if (*fmt_ch
== '+') {
1323 obj
= va_arg(*args
, void *);
1324 BUF_APPEND("%saddr=%p", prefix
, obj
);
1332 format_field_class(buf_ch
, extended
, prefix
, obj
);
1335 format_field(buf_ch
, extended
, prefix
, obj
);
1338 format_field_path(buf_ch
, extended
, prefix
, obj
);
1341 format_event_class(buf_ch
, extended
, prefix
, obj
);
1344 format_event(buf_ch
, extended
, prefix
, obj
);
1347 format_stream_class(buf_ch
, extended
, prefix
, obj
);
1350 format_stream(buf_ch
, extended
, prefix
, obj
);
1353 format_packet(buf_ch
, extended
, prefix
, obj
);
1356 format_trace(buf_ch
, extended
, prefix
, obj
);
1359 format_trace_class(buf_ch
, extended
, prefix
, obj
);
1362 format_clock_class(buf_ch
, extended
, prefix
, obj
);
1365 format_clock_snapshot(buf_ch
, extended
, prefix
, obj
);
1368 format_value(buf_ch
, extended
, prefix
, obj
);
1371 format_message(buf_ch
, extended
, prefix
, obj
);
1374 format_message_iterator(buf_ch
, extended
, prefix
, obj
);
1377 format_component_class(buf_ch
, extended
, prefix
, obj
);
1380 format_component(buf_ch
, extended
, prefix
, obj
);
1383 format_port(buf_ch
, extended
, prefix
, obj
);
1386 format_connection(buf_ch
, extended
, prefix
, obj
);
1389 format_plugin(buf_ch
, extended
, prefix
, obj
);
1392 format_graph(buf_ch
, extended
, prefix
, obj
);
1395 format_object_pool(buf_ch
, extended
, prefix
, obj
);
1398 format_object(buf_ch
, extended
, prefix
, obj
);
1406 *out_fmt_ch
= fmt_ch
;
1409 void bt_lib_log(const char *func
, const char *file
, unsigned line
,
1410 int lvl
, const char *tag
, const char *fmt
, ...)
1415 va_start(args
, fmt
);
1416 bt_common_custom_vsnprintf(lib_logging_buf
, LIB_LOGGING_BUF_SIZE
, '!',
1417 handle_conversion_specifier_bt
, NULL
, fmt
, &args
);
1419 _bt_log_write_d(func
, file
, line
, lvl
, tag
, "%s", lib_logging_buf
);