Add bt_common_abort() and use it instead of abort() directly
[babeltrace.git] / src / lib / lib-logging.c
1 /*
2 * Copyright 2018 Philippe Proulx <pproulx@efficios.com>
3 *
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:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
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
20 * SOFTWARE.
21 */
22
23 #define BT_LOG_TAG "LIB/LIB-LOGGING"
24 #include "lib/logging.h"
25
26 #include <stdarg.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <inttypes.h>
31 #include <stdbool.h>
32 #include <stdint.h>
33 #include <wchar.h>
34 #include <glib.h>
35 #include "common/common.h"
36 #include "common/uuid.h"
37 #include <babeltrace2/babeltrace.h>
38
39 #include "logging.h"
40 #include "assert-pre.h"
41 #include "assert-post.h"
42 #include "value.h"
43 #include "integer-range-set.h"
44 #include "object-pool.h"
45 #include "graph/interrupter.h"
46 #include "graph/component-class.h"
47 #include "graph/component-filter.h"
48 #include "graph/component.h"
49 #include "graph/component-sink.h"
50 #include "graph/component-source.h"
51 #include "graph/connection.h"
52 #include "graph/graph.h"
53 #include "graph/message/discarded-items.h"
54 #include "graph/message/event.h"
55 #include "graph/message/iterator.h"
56 #include "graph/message/message.h"
57 #include "graph/message/message-iterator-inactivity.h"
58 #include "graph/message/packet.h"
59 #include "graph/message/stream.h"
60 #include "graph/port.h"
61 #include "plugin/plugin.h"
62 #include "plugin/plugin-so.h"
63 #include "trace-ir/clock-class.h"
64 #include "trace-ir/clock-snapshot.h"
65 #include "trace-ir/event-class.h"
66 #include "trace-ir/event.h"
67 #include "trace-ir/field-class.h"
68 #include "trace-ir/field.h"
69 #include "trace-ir/field-path.h"
70 #include "trace-ir/packet.h"
71 #include "trace-ir/stream-class.h"
72 #include "trace-ir/stream.h"
73 #include "trace-ir/trace-class.h"
74 #include "trace-ir/trace.h"
75 #include "trace-ir/utils.h"
76 #include "error.h"
77 #include "assert-pre.h"
78
79 #define LIB_LOGGING_BUF_SIZE (4096 * 4)
80
81 static __thread char lib_logging_buf[LIB_LOGGING_BUF_SIZE];
82
83 #define BUF_APPEND(_fmt, ...) \
84 do { \
85 int _count; \
86 size_t _size = LIB_LOGGING_BUF_SIZE - \
87 (size_t) (*buf_ch - lib_logging_buf); \
88 _count = snprintf(*buf_ch, _size, (_fmt), __VA_ARGS__); \
89 BT_ASSERT(_count >= 0); \
90 *buf_ch += MIN(_count, _size); \
91 if (*buf_ch >= lib_logging_buf + LIB_LOGGING_BUF_SIZE - 1) { \
92 return; \
93 } \
94 } while (0)
95
96 #define BUF_APPEND_UUID(_uuid) \
97 do { \
98 BUF_APPEND(", %suuid=", prefix); \
99 format_uuid(buf_ch, (_uuid)); \
100 } while (0)
101
102 #define PRFIELD(_expr) prefix, (_expr)
103
104 #define PRFIELD_GSTRING(_expr) PRFIELD((_expr) ? (_expr)->str : NULL)
105
106 #define TMP_PREFIX_LEN 128
107 #define SET_TMP_PREFIX(_prefix2) \
108 do { \
109 int snprintf_ret = \
110 snprintf(tmp_prefix, TMP_PREFIX_LEN - 1, "%s%s", \
111 prefix, (_prefix2)); \
112 \
113 if (snprintf_ret < 0 || snprintf_ret >= TMP_PREFIX_LEN - 1) { \
114 bt_common_abort(); \
115 } \
116 \
117 tmp_prefix[TMP_PREFIX_LEN - 1] = '\0'; \
118 } while (0)
119
120 static inline void format_component(char **buf_ch, bool extended,
121 const char *prefix, const struct bt_component *component);
122
123 static inline void format_port(char **buf_ch, bool extended,
124 const char *prefix, const struct bt_port *port);
125
126 static inline void format_connection(char **buf_ch, bool extended,
127 const char *prefix, const struct bt_connection *connection);
128
129 static inline void format_clock_snapshot(char **buf_ch, bool extended,
130 const char *prefix, const struct bt_clock_snapshot *clock_snapshot);
131
132 static inline void format_field_path(char **buf_ch, bool extended,
133 const char *prefix, const struct bt_field_path *field_path);
134
135 static inline void format_object(char **buf_ch, bool extended,
136 const char *prefix, const struct bt_object *obj)
137 {
138 BUF_APPEND(", %sref-count=%llu", prefix, obj->ref_count);
139 }
140
141 static inline void format_uuid(char **buf_ch, bt_uuid uuid)
142 {
143 BUF_APPEND("\"" BT_UUID_FMT "\"", BT_UUID_FMT_VALUES(uuid));
144 }
145
146 static inline void format_object_pool(char **buf_ch, bool extended,
147 const char *prefix, const struct bt_object_pool *pool)
148 {
149 BUF_APPEND(", %ssize=%zu", PRFIELD(pool->size));
150
151 if (pool->objects) {
152 BUF_APPEND(", %scap=%u", PRFIELD(pool->objects->len));
153 }
154 }
155
156 static inline void format_integer_field_class(char **buf_ch,
157 bool extended, const char *prefix,
158 const struct bt_field_class *field_class)
159 {
160 const struct bt_field_class_integer *int_fc =
161 (const void *) field_class;
162
163 BUF_APPEND(", %srange-size=%" PRIu64 ", %sbase=%s",
164 PRFIELD(int_fc->range),
165 PRFIELD(bt_common_field_class_integer_preferred_display_base_string(int_fc->base)));
166 }
167
168 static inline void format_array_field_class(char **buf_ch,
169 bool extended, const char *prefix,
170 const struct bt_field_class *field_class)
171 {
172 const struct bt_field_class_array *array_fc =
173 (const void *) field_class;
174
175 BUF_APPEND(", %selement-fc-addr=%p, %selement-fc-type=%s",
176 PRFIELD(array_fc->element_fc),
177 PRFIELD(bt_common_field_class_type_string(array_fc->element_fc->type)));
178 }
179
180 static inline void format_field_class(char **buf_ch, bool extended,
181 const char *prefix, const struct bt_field_class *field_class)
182 {
183 char tmp_prefix[TMP_PREFIX_LEN];
184
185 BUF_APPEND(", %stype=%s",
186 PRFIELD(bt_common_field_class_type_string(field_class->type)));
187
188 if (extended) {
189 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field_class->frozen));
190 BUF_APPEND(", %sis-part-of-trace-class=%d",
191 PRFIELD(field_class->part_of_trace_class));
192 } else {
193 return;
194 }
195
196 switch (field_class->type) {
197 case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
198 {
199 const struct bt_field_class_bit_array *ba_fc =
200 (const void *) field_class;
201
202 BUF_APPEND(", %slength=%" PRIu64, PRFIELD(ba_fc->length));
203 break;
204 }
205 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
206 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
207 {
208 format_integer_field_class(buf_ch, extended, prefix, field_class);
209 break;
210 }
211 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
212 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
213 {
214 const struct bt_field_class_enumeration *enum_fc =
215 (const void *) field_class;
216
217 format_integer_field_class(buf_ch, extended, prefix, field_class);
218 BUF_APPEND(", %smapping-count=%u",
219 PRFIELD(enum_fc->mappings->len));
220 break;
221 }
222 case BT_FIELD_CLASS_TYPE_STRUCTURE:
223 {
224 const struct bt_field_class_structure *struct_fc =
225 (const void *) field_class;
226
227 if (struct_fc->common.named_fcs) {
228 BUF_APPEND(", %smember-count=%u",
229 PRFIELD(struct_fc->common.named_fcs->len));
230 }
231
232 break;
233 }
234 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
235 {
236 const struct bt_field_class_array_static *array_fc =
237 (const void *) field_class;
238
239 format_array_field_class(buf_ch, extended, prefix, field_class);
240 BUF_APPEND(", %slength=%" PRIu64, PRFIELD(array_fc->length));
241 break;
242 }
243 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
244 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
245 {
246 const struct bt_field_class_array_dynamic *array_fc =
247 (const void *) field_class;
248
249 format_array_field_class(buf_ch, extended, prefix, field_class);
250
251 if (array_fc->length_fc) {
252 SET_TMP_PREFIX("length-fc-");
253 format_field_class(buf_ch, extended, tmp_prefix,
254 array_fc->length_fc);
255 }
256
257 if (array_fc->length_field_path) {
258 SET_TMP_PREFIX("length-field-path-");
259 format_field_path(buf_ch, extended, tmp_prefix,
260 array_fc->length_field_path);
261 }
262
263 break;
264 }
265 case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD:
266 case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD:
267 case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
268 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
269 {
270 const struct bt_field_class_option *opt_fc =
271 (const void *) field_class;
272
273 BUF_APPEND(", %scontent-fc-addr=%p, %scontent-fc-type=%s",
274 PRFIELD(opt_fc->content_fc),
275 PRFIELD(bt_common_field_class_type_string(opt_fc->content_fc->type)));
276
277 if (field_class->type !=
278 BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD) {
279 const struct bt_field_class_option_with_selector_field *opt_with_sel_fc =
280 (const void *) field_class;
281
282 if (opt_with_sel_fc->selector_fc) {
283 SET_TMP_PREFIX("selector-fc-");
284 format_field_class(buf_ch, extended, tmp_prefix,
285 opt_with_sel_fc->selector_fc);
286 }
287
288 if (opt_with_sel_fc->selector_field_path) {
289 SET_TMP_PREFIX("selector-field-path-");
290 format_field_path(buf_ch, extended, tmp_prefix,
291 opt_with_sel_fc->selector_field_path);
292 }
293 }
294
295 break;
296 }
297 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
298 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
299 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
300 {
301 const struct bt_field_class_variant *var_fc =
302 (const void *) field_class;
303
304 if (var_fc->common.named_fcs) {
305 BUF_APPEND(", %soption-count=%u",
306 PRFIELD(var_fc->common.named_fcs->len));
307 }
308
309 if (field_class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD ||
310 field_class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD) {
311 const struct bt_field_class_variant_with_selector_field *var_with_sel_fc =
312 (const void *) var_fc;
313
314 if (var_with_sel_fc->selector_fc) {
315 SET_TMP_PREFIX("selector-fc-");
316 format_field_class(buf_ch, extended, tmp_prefix,
317 var_with_sel_fc->selector_fc);
318 }
319
320 if (var_with_sel_fc->selector_field_path) {
321 SET_TMP_PREFIX("selector-field-path-");
322 format_field_path(buf_ch, extended, tmp_prefix,
323 var_with_sel_fc->selector_field_path);
324 }
325 }
326
327 break;
328 }
329 default:
330 break;
331 }
332 }
333
334 static inline void format_field_integer_extended(char **buf_ch,
335 const char *prefix, const struct bt_field *field)
336 {
337 const struct bt_field_integer *integer = (void *) field;
338 const struct bt_field_class_integer *field_class =
339 (void *) field->class;
340 const char *fmt = NULL;
341
342 BT_ASSERT(field_class);
343
344 if (field_class->base == BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL) {
345 fmt = ", %svalue=%" PRIo64;
346 } else if (field_class->base == BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL) {
347 fmt = ", %svalue=%" PRIx64;
348 }
349
350 if (field_class->common.type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
351 field_class->common.type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION) {
352 if (!fmt) {
353 fmt = ", %svalue=%" PRId64;
354 }
355
356 BUF_APPEND(fmt, PRFIELD(integer->value.i));
357 } else {
358 if (!fmt) {
359 fmt = ", %svalue=%" PRIu64;
360 }
361
362 BUF_APPEND(fmt, PRFIELD(integer->value.u));
363 }
364 }
365
366 static inline void format_field(char **buf_ch, bool extended,
367 const char *prefix, const struct bt_field *field)
368 {
369 BUF_APPEND(", %sis-set=%d", PRFIELD(field->is_set));
370
371 if (extended) {
372 BUF_APPEND(", %sis-frozen=%d", PRFIELD(field->frozen));
373 }
374
375 BUF_APPEND(", %sclass-addr=%p", PRFIELD(field->class));
376
377 if (!field->class) {
378 return;
379 }
380
381 BUF_APPEND(", %sclass-type=%s",
382 PRFIELD(bt_common_field_class_type_string(field->class->type)));
383
384 if (!extended || !field->is_set) {
385 return;
386 }
387
388 switch (field->class->type) {
389 case BT_FIELD_CLASS_TYPE_BOOL:
390 {
391 const struct bt_field_bool *bool_field = (const void *) field;
392
393 BUF_APPEND(", %svalue=%d", PRFIELD(bool_field->value));
394 break;
395 }
396 case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
397 {
398 const struct bt_field_bit_array *ba_field = (const void *) field;
399
400 BUF_APPEND(", %svalue-as-int=%" PRIx64,
401 PRFIELD(ba_field->value_as_int));
402 break;
403 }
404 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
405 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
406 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
407 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
408 {
409 format_field_integer_extended(buf_ch, prefix, field);
410 break;
411 }
412 case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
413 case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
414 {
415 const struct bt_field_real *real_field = (const void *) field;
416
417 BUF_APPEND(", %svalue=%f", PRFIELD(real_field->value));
418 break;
419 }
420 case BT_FIELD_CLASS_TYPE_STRING:
421 {
422 const struct bt_field_string *str = (const void *) field;
423
424 if (str->buf) {
425 BT_ASSERT(str->buf->data);
426 BUF_APPEND(", %spartial-value=\"%.32s\"",
427 PRFIELD(str->buf->data));
428 }
429
430 break;
431 }
432 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
433 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
434 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
435 {
436 const struct bt_field_array *array_field = (const void *) field;
437
438 BUF_APPEND(", %slength=%" PRIu64, PRFIELD(array_field->length));
439
440 if (array_field->fields) {
441 BUF_APPEND(", %sallocated-length=%u",
442 PRFIELD(array_field->fields->len));
443 }
444
445 break;
446 }
447 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
448 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
449 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
450 {
451 const struct bt_field_variant *var_field = (const void *) field;
452
453 BUF_APPEND(", %sselected-field-index=%" PRIu64,
454 PRFIELD(var_field->selected_index));
455 break;
456 }
457 default:
458 break;
459 }
460 }
461
462 static inline void format_field_path(char **buf_ch, bool extended,
463 const char *prefix, const struct bt_field_path *field_path)
464 {
465 uint64_t i;
466
467 if (field_path->items) {
468 BT_ASSERT(field_path->items);
469 BUF_APPEND(", %sitem-count=%u",
470 PRFIELD(field_path->items->len));
471 }
472
473 if (!extended || !field_path->items) {
474 return;
475 }
476
477 BUF_APPEND(", %spath=[%s",
478 PRFIELD(bt_common_scope_string(field_path->root)));
479
480 for (i = 0; i < bt_field_path_get_item_count(field_path); i++) {
481 const struct bt_field_path_item *fp_item =
482 bt_field_path_borrow_item_by_index_const(field_path, i);
483
484 switch (bt_field_path_item_get_type(fp_item)) {
485 case BT_FIELD_PATH_ITEM_TYPE_INDEX:
486 BUF_APPEND(", %" PRIu64,
487 bt_field_path_item_index_get_index(fp_item));
488 break;
489 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
490 BUF_APPEND("%s", ", <CUR>");
491 break;
492 default:
493 bt_common_abort();
494 }
495 }
496
497 BUF_APPEND("%s", "]");
498 }
499
500 static inline void format_trace_class(char **buf_ch, bool extended,
501 const char *prefix, const struct bt_trace_class *trace_class)
502 {
503 if (!extended) {
504 return;
505 }
506
507 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace_class->frozen));
508
509 if (trace_class->stream_classes) {
510 BUF_APPEND(", %sstream-class-count=%u",
511 PRFIELD(trace_class->stream_classes->len));
512 }
513
514 BUF_APPEND(", %sassigns-auto-sc-id=%d",
515 PRFIELD(trace_class->assigns_automatic_stream_class_id));
516 }
517
518 static inline void format_trace(char **buf_ch, bool extended,
519 const char *prefix, const struct bt_trace *trace)
520 {
521 char tmp_prefix[TMP_PREFIX_LEN];
522
523 if (trace->name.value) {
524 BUF_APPEND(", %sname=\"%s\"", PRFIELD(trace->name.value));
525 }
526
527 if (!extended) {
528 return;
529 }
530
531 if (trace->uuid.value) {
532 BUF_APPEND_UUID(trace->uuid.value);
533 }
534
535 BUF_APPEND(", %sis-frozen=%d", PRFIELD(trace->frozen));
536
537 if (trace->streams) {
538 BUF_APPEND(", %sstream-count=%u",
539 PRFIELD(trace->streams->len));
540 }
541
542 if (!trace->class) {
543 return;
544 }
545
546 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace->class));
547 SET_TMP_PREFIX("trace-class-");
548 format_trace_class(buf_ch, false, tmp_prefix, trace->class);
549 }
550
551 static inline void format_stream_class(char **buf_ch, bool extended,
552 const char *prefix,
553 const struct bt_stream_class *stream_class)
554 {
555 const struct bt_trace_class *trace_class;
556 char tmp_prefix[TMP_PREFIX_LEN];
557
558 BUF_APPEND(", %sid=%" PRIu64, PRFIELD(stream_class->id));
559
560 if (stream_class->name.value) {
561 BUF_APPEND(", %sname=\"%s\"",
562 PRFIELD(stream_class->name.value));
563 }
564
565 if (!extended) {
566 return;
567 }
568
569 BUF_APPEND(", %sis-frozen=%d", PRFIELD(stream_class->frozen));
570
571 if (stream_class->event_classes) {
572 BUF_APPEND(", %sevent-class-count=%u",
573 PRFIELD(stream_class->event_classes->len));
574 }
575
576 BUF_APPEND(", %spacket-context-fc-addr=%p, "
577 "%sevent-common-context-fc-addr=%p",
578 PRFIELD(stream_class->packet_context_fc),
579 PRFIELD(stream_class->event_common_context_fc));
580 trace_class = bt_stream_class_borrow_trace_class_inline(stream_class);
581 if (!trace_class) {
582 return;
583 }
584
585 BUF_APPEND(", %sassigns-auto-ec-id=%d, %sassigns-auto-stream-id=%d, "
586 "%ssupports-packets=%d, "
587 "%spackets-have-begin-default-cs=%d, "
588 "%spackets-have-end-default-cs=%d, "
589 "%ssupports-discarded-events=%d, "
590 "%sdiscarded-events-have-default-cs=%d, "
591 "%ssupports-discarded-packets=%d, "
592 "%sdiscarded-packets-have-default-cs=%d",
593 PRFIELD(stream_class->assigns_automatic_event_class_id),
594 PRFIELD(stream_class->assigns_automatic_stream_id),
595 PRFIELD(stream_class->supports_packets),
596 PRFIELD(stream_class->packets_have_beginning_default_clock_snapshot),
597 PRFIELD(stream_class->packets_have_end_default_clock_snapshot),
598 PRFIELD(stream_class->supports_discarded_events),
599 PRFIELD(stream_class->discarded_events_have_default_clock_snapshots),
600 PRFIELD(stream_class->supports_discarded_packets),
601 PRFIELD(stream_class->discarded_packets_have_default_clock_snapshots));
602 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
603 SET_TMP_PREFIX("trace-class-");
604 format_trace_class(buf_ch, false, tmp_prefix, trace_class);
605 SET_TMP_PREFIX("pcf-pool-");
606 format_object_pool(buf_ch, extended, tmp_prefix,
607 &stream_class->packet_context_field_pool);
608 }
609
610 static inline void format_event_class(char **buf_ch, bool extended,
611 const char *prefix, const struct bt_event_class *event_class)
612 {
613 const struct bt_stream_class *stream_class;
614 const struct bt_trace_class *trace_class;
615 char tmp_prefix[TMP_PREFIX_LEN];
616
617 BUF_APPEND(", %sid=%" PRIu64, PRFIELD(event_class->id));
618
619 if (event_class->name.value) {
620 BUF_APPEND(", %sname=\"%s\"",
621 PRFIELD(event_class->name.value));
622 }
623
624 if (!extended) {
625 return;
626 }
627
628 BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class->frozen));
629
630 if (event_class->log_level.base.avail) {
631 BUF_APPEND(", %slog-level=%s",
632 PRFIELD(bt_common_event_class_log_level_string(
633 (int) event_class->log_level.value)));
634 }
635
636 if (event_class->emf_uri.value) {
637 BUF_APPEND(", %semf-uri=\"%s\"",
638 PRFIELD(event_class->emf_uri.value));
639 }
640
641 BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
642 PRFIELD(event_class->specific_context_fc),
643 PRFIELD(event_class->payload_fc));
644
645 stream_class = bt_event_class_borrow_stream_class_const(event_class);
646 if (!stream_class) {
647 return;
648 }
649
650 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class));
651 SET_TMP_PREFIX("stream-class-");
652 format_stream_class(buf_ch, false, tmp_prefix, stream_class);
653 trace_class = bt_stream_class_borrow_trace_class_inline(stream_class);
654 if (!trace_class) {
655 return;
656 }
657
658 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
659 SET_TMP_PREFIX("trace-class-");
660 format_trace_class(buf_ch, false, tmp_prefix, trace_class);
661 SET_TMP_PREFIX("event-pool-");
662 format_object_pool(buf_ch, extended, tmp_prefix,
663 &event_class->event_pool);
664 }
665
666 static inline void format_stream(char **buf_ch, bool extended,
667 const char *prefix, const struct bt_stream *stream)
668 {
669 const struct bt_stream_class *stream_class;
670 const struct bt_trace_class *trace_class = NULL;
671 const struct bt_trace *trace = NULL;
672 char tmp_prefix[TMP_PREFIX_LEN];
673
674 BUF_APPEND(", %sid=%" PRIu64, PRFIELD(stream->id));
675
676 if (stream->name.value) {
677 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream->name.value));
678 }
679
680 if (!extended) {
681 return;
682 }
683
684 stream_class = bt_stream_borrow_class_const(stream);
685 if (stream_class) {
686 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class));
687 SET_TMP_PREFIX("stream-class-");
688 format_stream_class(buf_ch, false, tmp_prefix, stream_class);
689 trace_class = bt_stream_class_borrow_trace_class_inline(stream_class);
690 }
691
692 if (trace_class) {
693 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
694 SET_TMP_PREFIX("trace-class-");
695 format_trace_class(buf_ch, false, tmp_prefix, trace_class);
696 }
697
698 trace = bt_stream_borrow_trace_inline(stream);
699 if (trace) {
700 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace));
701 SET_TMP_PREFIX("trace-");
702 format_trace(buf_ch, false, tmp_prefix, trace);
703 }
704
705 SET_TMP_PREFIX("packet-pool-");
706 format_object_pool(buf_ch, extended, tmp_prefix, &stream->packet_pool);
707 }
708
709 static inline void format_packet(char **buf_ch, bool extended,
710 const char *prefix, const struct bt_packet *packet)
711 {
712 const struct bt_stream *stream;
713 const struct bt_trace_class *trace_class;
714 char tmp_prefix[TMP_PREFIX_LEN];
715
716 if (!extended) {
717 return;
718 }
719
720 BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
721 PRFIELD(packet->frozen),
722 PRFIELD(packet->context_field ? packet->context_field->field : NULL));
723 stream = bt_packet_borrow_stream_const(packet);
724 if (!stream) {
725 return;
726 }
727
728 BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream));
729 SET_TMP_PREFIX("stream-");
730 format_stream(buf_ch, false, tmp_prefix, stream);
731 trace_class = (const struct bt_trace_class *) bt_object_borrow_parent(&stream->base);
732 if (!trace_class) {
733 return;
734 }
735
736 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
737 SET_TMP_PREFIX("trace-class-");
738 format_trace_class(buf_ch, false, tmp_prefix, trace_class);
739 }
740
741 static inline void format_event(char **buf_ch, bool extended,
742 const char *prefix, const struct bt_event *event)
743 {
744 const struct bt_trace_class *trace_class;
745 const struct bt_stream_class *stream_class;
746 char tmp_prefix[TMP_PREFIX_LEN];
747
748 if (!extended) {
749 return;
750 }
751
752 BUF_APPEND(", %sis-frozen=%d, "
753 "%scommon-context-field-addr=%p, "
754 "%sspecific-context-field-addr=%p, "
755 "%spayload-field-addr=%p, ",
756 PRFIELD(event->frozen),
757 PRFIELD(event->common_context_field),
758 PRFIELD(event->specific_context_field),
759 PRFIELD(event->payload_field));
760 BUF_APPEND(", %sevent-class-addr=%p", PRFIELD(event->class));
761
762 if (!event->class) {
763 return;
764 }
765
766 SET_TMP_PREFIX("event-class-");
767 format_event_class(buf_ch, false, tmp_prefix, event->class);
768 stream_class = bt_event_class_borrow_stream_class(event->class);
769 if (stream_class) {
770 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class));
771 SET_TMP_PREFIX("stream-class-");
772 format_stream_class(buf_ch, false, tmp_prefix,
773 stream_class);
774
775 trace_class = bt_stream_class_borrow_trace_class_inline(
776 stream_class);
777 if (trace_class) {
778 BUF_APPEND(", %strace-class-addr=%p",
779 PRFIELD(trace_class));
780 SET_TMP_PREFIX("trace-class-");
781 format_trace_class(buf_ch, false, tmp_prefix,
782 trace_class);
783 }
784 }
785
786 if (event->stream) {
787 BUF_APPEND(", %sstream-addr=%p", PRFIELD(event->stream));
788 SET_TMP_PREFIX("stream-");
789 format_stream(buf_ch, false, tmp_prefix, event->stream);
790 }
791
792 if (event->packet) {
793 BUF_APPEND(", %spacket-addr=%p", PRFIELD(event->packet));
794 SET_TMP_PREFIX("packet-");
795 format_packet(buf_ch, false, tmp_prefix, event->packet);
796 }
797 }
798
799 static inline void format_clock_class(char **buf_ch, bool extended,
800 const char *prefix, const struct bt_clock_class *clock_class)
801 {
802 char tmp_prefix[TMP_PREFIX_LEN];
803
804 if (clock_class->name.value) {
805 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class->name.value));
806 }
807
808 BUF_APPEND(", %sfreq=%" PRIu64, PRFIELD(clock_class->frequency));
809
810 if (!extended) {
811 return;
812 }
813
814 if (clock_class->description.value) {
815 BUF_APPEND(", %spartial-descr=\"%.32s\"",
816 PRFIELD(clock_class->description.value));
817 }
818
819 if (clock_class->uuid.value) {
820 BUF_APPEND_UUID(clock_class->uuid.value);
821 }
822
823 BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64 ", "
824 "%soffset-s=%" PRId64 ", "
825 "%soffset-cycles=%" PRIu64 ", %sorigin-is-unix-epoch=%d, "
826 "%sbase-offset-ns=%" PRId64,
827 PRFIELD(clock_class->frozen), PRFIELD(clock_class->precision),
828 PRFIELD(clock_class->offset_seconds),
829 PRFIELD(clock_class->offset_cycles),
830 PRFIELD(clock_class->origin_is_unix_epoch),
831 PRFIELD(clock_class->base_offset.value_ns));
832
833 SET_TMP_PREFIX("cs-pool-");
834 format_object_pool(buf_ch, extended, tmp_prefix,
835 &clock_class->cs_pool);
836 }
837
838 static inline void format_clock_snapshot(char **buf_ch, bool extended,
839 const char *prefix, const struct bt_clock_snapshot *clock_snapshot)
840 {
841 char tmp_prefix[TMP_PREFIX_LEN];
842 BUF_APPEND(", %svalue=%" PRIu64 ", %sns-from-origin=%" PRId64,
843 PRFIELD(clock_snapshot->value_cycles),
844 PRFIELD(clock_snapshot->ns_from_origin));
845
846 if (!extended) {
847 return;
848 }
849
850 BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot->is_set));
851
852 if (clock_snapshot->clock_class) {
853 BUF_APPEND(", %sclock-class-addr=%p",
854 PRFIELD(clock_snapshot->clock_class));
855 SET_TMP_PREFIX("clock-class-");
856 format_clock_class(buf_ch, false, tmp_prefix,
857 clock_snapshot->clock_class);
858 }
859 }
860
861 static inline void format_interrupter(char **buf_ch, bool extended,
862 const char *prefix, const struct bt_interrupter *intr)
863 {
864 BUF_APPEND(", %sis-set=%d", PRFIELD(intr->is_set));
865 }
866
867 static inline void format_value(char **buf_ch, bool extended,
868 const char *prefix, const struct bt_value *value)
869 {
870 BUF_APPEND(", %stype=%s",
871 PRFIELD(bt_common_value_type_string(bt_value_get_type(value))));
872
873 if (!extended) {
874 return;
875 }
876
877 switch (bt_value_get_type(value)) {
878 case BT_VALUE_TYPE_BOOL:
879 {
880 bt_bool val = bt_value_bool_get(value);
881
882 BUF_APPEND(", %svalue=%d", PRFIELD(val));
883 break;
884 }
885 case BT_VALUE_TYPE_UNSIGNED_INTEGER:
886 {
887 BUF_APPEND(", %svalue=%" PRIu64,
888 PRFIELD(bt_value_integer_unsigned_get(value)));
889 break;
890 }
891 case BT_VALUE_TYPE_SIGNED_INTEGER:
892 {
893 BUF_APPEND(", %svalue=%" PRId64,
894 PRFIELD(bt_value_integer_signed_get(value)));
895 break;
896 }
897 case BT_VALUE_TYPE_REAL:
898 {
899 double val = bt_value_real_get(value);
900
901 BUF_APPEND(", %svalue=%f", PRFIELD(val));
902 break;
903 }
904 case BT_VALUE_TYPE_STRING:
905 {
906 const char *val = bt_value_string_get(value);
907
908 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val));
909 break;
910 }
911 case BT_VALUE_TYPE_ARRAY:
912 {
913 uint64_t count = bt_value_array_get_length(value);
914
915 BUF_APPEND(", %selement-count=%" PRId64, PRFIELD(count));
916 break;
917 }
918 case BT_VALUE_TYPE_MAP:
919 {
920 int64_t count = bt_value_map_get_size(value);
921
922 BT_ASSERT(count >= 0);
923 BUF_APPEND(", %selement-count=%" PRId64, PRFIELD(count));
924 break;
925 }
926 default:
927 break;
928 }
929 }
930
931 static inline void format_integer_range_set(char **buf_ch, bool extended,
932 const char *prefix,
933 const struct bt_integer_range_set *range_set)
934 {
935 BUF_APPEND(", %srange-count=%u", PRFIELD(range_set->ranges->len));
936
937 if (!extended) {
938 return;
939 }
940
941 BUF_APPEND(", %sis-frozen=%d", PRFIELD(range_set->frozen));
942 }
943
944 static inline void format_message(char **buf_ch, bool extended,
945 const char *prefix, const struct bt_message *msg)
946 {
947 char tmp_prefix[TMP_PREFIX_LEN];
948
949 BUF_APPEND(", %stype=%s",
950 PRFIELD(bt_message_type_string(msg->type)));
951
952 if (!extended) {
953 return;
954 }
955
956 BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
957 PRFIELD(msg->frozen), PRFIELD(msg->graph));
958
959 switch (msg->type) {
960 case BT_MESSAGE_TYPE_EVENT:
961 {
962 const struct bt_message_event *msg_event =
963 (const void *) msg;
964
965 if (msg_event->event) {
966 SET_TMP_PREFIX("event-");
967 format_event(buf_ch, true, tmp_prefix,
968 msg_event->event);
969 }
970
971 if (msg_event->default_cs) {
972 SET_TMP_PREFIX("default-cs-");
973 format_clock_snapshot(buf_ch, true, tmp_prefix,
974 msg_event->default_cs);
975 }
976
977 break;
978 }
979 case BT_MESSAGE_TYPE_STREAM_BEGINNING:
980 case BT_MESSAGE_TYPE_STREAM_END:
981 {
982 const struct bt_message_stream *msg_stream = (const void *) msg;
983
984 if (msg_stream->stream) {
985 SET_TMP_PREFIX("stream-");
986 format_stream(buf_ch, true, tmp_prefix,
987 msg_stream->stream);
988 }
989
990 BUF_APPEND(", %sdefault-cs-state=%s",
991 PRFIELD(bt_message_stream_clock_snapshot_state_string(
992 msg_stream->default_cs_state)));
993
994 if (msg_stream->default_cs_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
995 SET_TMP_PREFIX("default-cs-");
996 format_clock_snapshot(buf_ch, true, tmp_prefix,
997 msg_stream->default_cs);
998 }
999
1000 break;
1001 }
1002 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
1003 case BT_MESSAGE_TYPE_PACKET_END:
1004 {
1005 const struct bt_message_packet *msg_packet = (const void *) msg;
1006
1007 if (msg_packet->packet) {
1008 SET_TMP_PREFIX("packet-");
1009 format_packet(buf_ch, true, tmp_prefix,
1010 msg_packet->packet);
1011 }
1012
1013 if (msg_packet->default_cs) {
1014 SET_TMP_PREFIX("default-cs-");
1015 format_clock_snapshot(buf_ch, true, tmp_prefix,
1016 msg_packet->default_cs);
1017 }
1018
1019 break;
1020 }
1021 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1022 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1023 {
1024 const struct bt_message_discarded_items *msg_disc_items =
1025 (const void *) msg;
1026
1027 if (msg_disc_items->stream) {
1028 SET_TMP_PREFIX("stream-");
1029 format_stream(buf_ch, true, tmp_prefix,
1030 msg_disc_items->stream);
1031 }
1032
1033 if (msg_disc_items->default_begin_cs) {
1034 SET_TMP_PREFIX("begin-default-cs-");
1035 format_clock_snapshot(buf_ch, true, tmp_prefix,
1036 msg_disc_items->default_begin_cs);
1037 }
1038
1039 if (msg_disc_items->default_end_cs) {
1040 SET_TMP_PREFIX("end-default-cs-");
1041 format_clock_snapshot(buf_ch, true, tmp_prefix,
1042 msg_disc_items->default_end_cs);
1043 }
1044
1045 if (msg_disc_items->count.base.avail) {
1046 BUF_APPEND(", %scount=%" PRIu64,
1047 PRFIELD(msg_disc_items->count.value));
1048 }
1049
1050 break;
1051 }
1052 default:
1053 break;
1054 }
1055 }
1056
1057 static inline void format_plugin_so_shared_lib_handle(char **buf_ch,
1058 const char *prefix,
1059 const struct bt_plugin_so_shared_lib_handle *handle)
1060 {
1061 BUF_APPEND(", %saddr=%p", PRFIELD(handle));
1062
1063 if (handle->path) {
1064 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle->path));
1065 }
1066 }
1067
1068 static inline void format_component_class(char **buf_ch, bool extended,
1069 const char *prefix,
1070 const struct bt_component_class *comp_class)
1071 {
1072 char tmp_prefix[TMP_PREFIX_LEN];
1073
1074 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1075 PRFIELD(bt_component_class_type_string(comp_class->type)),
1076 PRFIELD_GSTRING(comp_class->name));
1077
1078 if (comp_class->description) {
1079 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1080 PRFIELD_GSTRING(comp_class->description));
1081 }
1082
1083 if (!extended) {
1084 return;
1085 }
1086
1087 BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class->frozen));
1088
1089 if (comp_class->so_handle) {
1090 SET_TMP_PREFIX("so-handle-");
1091 format_plugin_so_shared_lib_handle(buf_ch, tmp_prefix,
1092 comp_class->so_handle);
1093 }
1094 }
1095
1096 static inline void format_component(char **buf_ch, bool extended,
1097 const char *prefix, const struct bt_component *component)
1098 {
1099 char tmp_prefix[TMP_PREFIX_LEN];
1100
1101 BUF_APPEND(", %sname=\"%s\", %slog-level=%s",
1102 PRFIELD_GSTRING(component->name),
1103 PRFIELD(bt_common_logging_level_string(component->log_level)));
1104
1105 if (component->class) {
1106 SET_TMP_PREFIX("class-");
1107 format_component_class(buf_ch, extended, tmp_prefix,
1108 component->class);
1109 }
1110
1111 if (!extended) {
1112 return;
1113 }
1114
1115 if (component->input_ports) {
1116 BUF_APPEND(", %sinput-port-count=%u",
1117 PRFIELD(component->input_ports->len));
1118 }
1119
1120 if (component->output_ports) {
1121 BUF_APPEND(", %soutput-port-count=%u",
1122 PRFIELD(component->output_ports->len));
1123 }
1124 }
1125
1126 static inline void format_port(char **buf_ch, bool extended,
1127 const char *prefix, const struct bt_port *port)
1128 {
1129 char tmp_prefix[TMP_PREFIX_LEN];
1130
1131 BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1132 PRFIELD(bt_port_type_string(port->type)),
1133 PRFIELD_GSTRING(port->name));
1134
1135 if (!extended) {
1136 return;
1137 }
1138
1139 if (port->connection) {
1140 SET_TMP_PREFIX("conn-");
1141 format_connection(buf_ch, false, tmp_prefix, port->connection);
1142 }
1143 }
1144
1145 static inline void format_connection(char **buf_ch, bool extended,
1146 const char *prefix, const struct bt_connection *connection)
1147 {
1148 char tmp_prefix[TMP_PREFIX_LEN];
1149
1150 if (!extended) {
1151 return;
1152 }
1153
1154 if (connection->upstream_port) {
1155 SET_TMP_PREFIX("upstream-port-");
1156 format_port(buf_ch, false, tmp_prefix,
1157 connection->upstream_port);
1158 }
1159
1160 if (connection->downstream_port) {
1161 SET_TMP_PREFIX("downstream-port-");
1162 format_port(buf_ch, false, tmp_prefix,
1163 connection->downstream_port);
1164 }
1165 }
1166
1167 static inline void format_graph(char **buf_ch, bool extended,
1168 const char *prefix, const struct bt_graph *graph)
1169 {
1170 char tmp_prefix[TMP_PREFIX_LEN];
1171
1172 BUF_APPEND(", %scan-consume=%d, %sconfig-state=%s",
1173 PRFIELD(graph->can_consume),
1174 PRFIELD(bt_graph_configuration_state_string(graph->config_state)));
1175
1176 if (!extended) {
1177 return;
1178 }
1179
1180 if (graph->components) {
1181 BUF_APPEND(", %scomp-count=%u",
1182 PRFIELD(graph->components->len));
1183 }
1184
1185 if (graph->connections) {
1186 BUF_APPEND(", %sconn-count=%u",
1187 PRFIELD(graph->connections->len));
1188 }
1189
1190 SET_TMP_PREFIX("en-pool-");
1191 format_object_pool(buf_ch, extended, tmp_prefix,
1192 &graph->event_msg_pool);
1193 SET_TMP_PREFIX("pbn-pool-");
1194 format_object_pool(buf_ch, extended, tmp_prefix,
1195 &graph->packet_begin_msg_pool);
1196 SET_TMP_PREFIX("pen-pool-");
1197 format_object_pool(buf_ch, extended, tmp_prefix,
1198 &graph->packet_end_msg_pool);
1199 }
1200
1201 static inline void format_message_iterator(char **buf_ch,
1202 bool extended, const char *prefix,
1203 const struct bt_message_iterator *iterator)
1204 {
1205 char tmp_prefix[TMP_PREFIX_LEN];
1206 const struct bt_self_component_port_input_message_iterator *
1207 port_in_iter = (const void *) iterator;
1208
1209 if (port_in_iter->upstream_component) {
1210 SET_TMP_PREFIX("upstream-comp-");
1211 format_component(buf_ch, false, tmp_prefix,
1212 port_in_iter->upstream_component);
1213 }
1214
1215 if (!extended) {
1216 goto end;
1217 }
1218
1219 if (port_in_iter->upstream_port) {
1220 SET_TMP_PREFIX("upstream-port-");
1221 format_port(buf_ch, false, tmp_prefix,
1222 port_in_iter->upstream_port);
1223 }
1224
1225 if (port_in_iter->connection) {
1226 SET_TMP_PREFIX("upstream-conn-");
1227 format_connection(buf_ch, false, tmp_prefix,
1228 port_in_iter->connection);
1229 }
1230
1231 end:
1232 return;
1233 }
1234
1235 static inline void format_plugin(char **buf_ch, bool extended,
1236 const char *prefix, const struct bt_plugin *plugin)
1237 {
1238 char tmp_prefix[TMP_PREFIX_LEN];
1239
1240 BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin->type)));
1241
1242 if (plugin->info.path_set) {
1243 BUF_APPEND(", %spath=\"%s\"",
1244 PRFIELD_GSTRING(plugin->info.path));
1245 }
1246
1247 if (plugin->info.name_set) {
1248 BUF_APPEND(", %sname=\"%s\"",
1249 PRFIELD_GSTRING(plugin->info.name));
1250 }
1251
1252 if (!extended) {
1253 return;
1254 }
1255
1256 if (plugin->info.author_set) {
1257 BUF_APPEND(", %sauthor=\"%s\"",
1258 PRFIELD_GSTRING(plugin->info.author));
1259 }
1260
1261 if (plugin->info.license_set) {
1262 BUF_APPEND(", %slicense=\"%s\"",
1263 PRFIELD_GSTRING(plugin->info.license));
1264 }
1265
1266 if (plugin->info.version_set) {
1267 BUF_APPEND(", %sversion=%u.%u.%u%s",
1268 PRFIELD(plugin->info.version.major),
1269 plugin->info.version.minor,
1270 plugin->info.version.patch,
1271 plugin->info.version.extra ?
1272 plugin->info.version.extra->str : "");
1273 }
1274
1275 BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1276 "%ssink-comp-class-count=%u",
1277 PRFIELD(plugin->src_comp_classes->len),
1278 PRFIELD(plugin->flt_comp_classes->len),
1279 PRFIELD(plugin->sink_comp_classes->len));
1280
1281 if (plugin->spec_data) {
1282 const struct bt_plugin_so_spec_data *spec_data =
1283 (const void *) plugin->spec_data;
1284
1285 if (spec_data->shared_lib_handle) {
1286 SET_TMP_PREFIX("so-handle-");
1287 format_plugin_so_shared_lib_handle(buf_ch, tmp_prefix,
1288 spec_data->shared_lib_handle);
1289 }
1290 }
1291 }
1292
1293 static inline void format_error_cause(char **buf_ch, bool extended,
1294 const char *prefix, const struct bt_error_cause *cause)
1295 {
1296 const struct bt_error_cause_component_class_id *comp_class_id = NULL;
1297
1298 BUF_APPEND(", %sactor-type=%s, %smodule-name=\"%s\"",
1299 PRFIELD(bt_error_cause_actor_type_string(cause->actor_type)),
1300 PRFIELD_GSTRING(cause->module_name));
1301
1302 if (!extended) {
1303 return;
1304 }
1305
1306 BUF_APPEND(", %spartial-msg=\"%.32s\"",
1307 PRFIELD_GSTRING(cause->message));
1308
1309 switch (cause->actor_type) {
1310 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT:
1311 {
1312 const struct bt_error_cause_component_actor *spec_cause =
1313 (const void *) cause;
1314
1315 BUF_APPEND(", %scomp-name=\"%s\"",
1316 PRFIELD_GSTRING(spec_cause->comp_name));
1317 comp_class_id = &spec_cause->comp_class_id;
1318 break;
1319 }
1320 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS:
1321 {
1322 const struct bt_error_cause_component_class_actor *spec_cause =
1323 (const void *) cause;
1324
1325 comp_class_id = &spec_cause->comp_class_id;
1326 break;
1327 }
1328 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR:
1329 {
1330 const struct bt_error_cause_message_iterator_actor *spec_cause =
1331 (const void *) cause;
1332
1333 BUF_APPEND(", %scomp-name=\"%s\", %scomp-out-port-name=\"%s\"",
1334 PRFIELD_GSTRING(spec_cause->comp_name),
1335 PRFIELD_GSTRING(spec_cause->output_port_name));
1336 comp_class_id = &spec_cause->comp_class_id;
1337 break;
1338 }
1339 default:
1340 break;
1341 }
1342
1343 if (comp_class_id) {
1344 BUF_APPEND(", %scomp-cls-type=%s, %scomp-cls-name=\"%s\", "
1345 "%splugin-name=\"%s\"",
1346 PRFIELD(bt_component_class_type_string(
1347 comp_class_id->type)),
1348 PRFIELD_GSTRING(comp_class_id->name),
1349 PRFIELD_GSTRING(comp_class_id->plugin_name));
1350 }
1351 }
1352
1353 static inline void handle_conversion_specifier_bt(void *priv_data,
1354 char **buf_ch, size_t avail_size,
1355 const char **out_fmt_ch, va_list *args)
1356 {
1357 const char *fmt_ch = *out_fmt_ch;
1358 bool extended = false;
1359 char prefix[64];
1360 char *prefix_ch = prefix;
1361 const void *obj;
1362
1363 /* skip "%!" */
1364 fmt_ch += 2;
1365
1366 if (*fmt_ch == 'u') {
1367 /* UUID */
1368 obj = va_arg(*args, void *);
1369 format_uuid(buf_ch, obj);
1370 goto update_fmt;
1371 }
1372
1373 if (*fmt_ch == '[') {
1374 /* local prefix */
1375 fmt_ch++;
1376
1377 while (true) {
1378 if (*fmt_ch == ']') {
1379 *prefix_ch = '\0';
1380 fmt_ch++;
1381 break;
1382 }
1383
1384 *prefix_ch = *fmt_ch;
1385 prefix_ch++;
1386 fmt_ch++;
1387 }
1388 }
1389
1390 *prefix_ch = '\0';
1391
1392 if (*fmt_ch == '+') {
1393 extended = true;
1394 fmt_ch++;
1395 }
1396
1397 obj = va_arg(*args, void *);
1398 BUF_APPEND("%saddr=%p", prefix, obj);
1399
1400 if (!obj) {
1401 goto update_fmt;
1402 }
1403
1404 switch (*fmt_ch) {
1405 case 'F':
1406 format_field_class(buf_ch, extended, prefix, obj);
1407 break;
1408 case 'f':
1409 format_field(buf_ch, extended, prefix, obj);
1410 break;
1411 case 'P':
1412 format_field_path(buf_ch, extended, prefix, obj);
1413 break;
1414 case 'E':
1415 format_event_class(buf_ch, extended, prefix, obj);
1416 break;
1417 case 'e':
1418 format_event(buf_ch, extended, prefix, obj);
1419 break;
1420 case 'S':
1421 format_stream_class(buf_ch, extended, prefix, obj);
1422 break;
1423 case 's':
1424 format_stream(buf_ch, extended, prefix, obj);
1425 break;
1426 case 'a':
1427 format_packet(buf_ch, extended, prefix, obj);
1428 break;
1429 case 't':
1430 format_trace(buf_ch, extended, prefix, obj);
1431 break;
1432 case 'T':
1433 format_trace_class(buf_ch, extended, prefix, obj);
1434 break;
1435 case 'K':
1436 format_clock_class(buf_ch, extended, prefix, obj);
1437 break;
1438 case 'k':
1439 format_clock_snapshot(buf_ch, extended, prefix, obj);
1440 break;
1441 case 'v':
1442 format_value(buf_ch, extended, prefix, obj);
1443 break;
1444 case 'R':
1445 format_integer_range_set(buf_ch, extended, prefix, obj);
1446 break;
1447 case 'n':
1448 format_message(buf_ch, extended, prefix, obj);
1449 break;
1450 case 'i':
1451 format_message_iterator(buf_ch, extended, prefix, obj);
1452 break;
1453 case 'C':
1454 format_component_class(buf_ch, extended, prefix, obj);
1455 break;
1456 case 'c':
1457 format_component(buf_ch, extended, prefix, obj);
1458 break;
1459 case 'p':
1460 format_port(buf_ch, extended, prefix, obj);
1461 break;
1462 case 'x':
1463 format_connection(buf_ch, extended, prefix, obj);
1464 break;
1465 case 'l':
1466 format_plugin(buf_ch, extended, prefix, obj);
1467 break;
1468 case 'g':
1469 format_graph(buf_ch, extended, prefix, obj);
1470 break;
1471 case 'z':
1472 format_interrupter(buf_ch, extended, prefix, obj);
1473 break;
1474 case 'o':
1475 format_object_pool(buf_ch, extended, prefix, obj);
1476 break;
1477 case 'O':
1478 format_object(buf_ch, extended, prefix, obj);
1479 break;
1480 case 'r':
1481 format_error_cause(buf_ch, extended, prefix, obj);
1482 break;
1483 default:
1484 bt_common_abort();
1485 }
1486
1487 update_fmt:
1488 fmt_ch++;
1489 *out_fmt_ch = fmt_ch;
1490 }
1491
1492 void bt_lib_log(const char *func, const char *file, unsigned line,
1493 int lvl, const char *tag, const char *fmt, ...)
1494 {
1495 va_list args;
1496
1497 BT_ASSERT(fmt);
1498 va_start(args, fmt);
1499 bt_common_custom_vsnprintf(lib_logging_buf, LIB_LOGGING_BUF_SIZE, '!',
1500 handle_conversion_specifier_bt, NULL, fmt, &args);
1501 va_end(args);
1502 _bt_log_write_d(func, file, line, lvl, tag, "%s", lib_logging_buf);
1503 }
1504
1505 void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
1506 unsigned line, int lvl, const char *tag,
1507 const char *fmt, ...)
1508 {
1509 va_list args;
1510 bt_current_thread_error_append_cause_status status;
1511
1512 BT_ASSERT(fmt);
1513 va_start(args, fmt);
1514 bt_common_custom_vsnprintf(lib_logging_buf, LIB_LOGGING_BUF_SIZE, '!',
1515 handle_conversion_specifier_bt, NULL, fmt, &args);
1516 va_end(args);
1517
1518 /* Log conditionally, but always append the error cause */
1519 if (BT_LOG_ON(lvl)) {
1520 _bt_log_write_d(func, file, line, lvl, tag, "%s",
1521 lib_logging_buf);
1522 }
1523
1524 status = bt_current_thread_error_append_cause_from_unknown(
1525 BT_LIB_LOG_LIBBABELTRACE2_NAME, file, line, "%s",
1526 lib_logging_buf);
1527 if (status) {
1528 /*
1529 * Worst case: this error cause is not appended to the
1530 * current thread's error.
1531 *
1532 * We can accept this as it's an almost impossible
1533 * scenario and returning an error here would mean you
1534 * need to check the return value of each
1535 * BT_LIB_LOG*_APPEND_CAUSE() macro and that would be
1536 * cumbersome.
1537 */
1538 BT_LOGE("Cannot append error cause to current thread's "
1539 "error object: status=%s",
1540 bt_common_func_status_string(status));
1541 }
1542 }
This page took 0.063721 seconds and 4 git commands to generate.