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