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