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                 "%spackets-have-default-beginning-cs=%d, "
 522                 "%spackets-have-default-end-cs=%d, "
 523                 "%ssupports-discarded-events=%d, "
 524                 "%sdiscarded-events-have-default-cs=%d, "
 525                 "%ssupports-discarded-packets=%d, "
 526                 "%sdiscarded-packets-have-default-cs=%d",
 527                 PRFIELD(stream_class->assigns_automatic_event_class_id),
 528                 PRFIELD(stream_class->assigns_automatic_stream_id),
 529                 PRFIELD(stream_class->packets_have_beginning_default_clock_snapshot),
 530                 PRFIELD(stream_class->packets_have_end_default_clock_snapshot),
 531                 PRFIELD(stream_class->supports_discarded_events),
 532                 PRFIELD(stream_class->discarded_events_have_default_clock_snapshots),
 533                 PRFIELD(stream_class->supports_discarded_packets),
 534                 PRFIELD(stream_class->discarded_packets_have_default_clock_snapshots));
 535         BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
 536         SET_TMP_PREFIX("trace-class-");
 537         format_trace_class(buf_ch, false, tmp_prefix, trace_class);
 538         SET_TMP_PREFIX("pcf-pool-");
 539         format_object_pool(buf_ch, extended, tmp_prefix,
 540                 &stream_class->packet_context_field_pool);
 541 }
 542
 543 static inline void format_event_class(char **buf_ch, bool extended,
 544                 const char *prefix, const struct bt_event_class *event_class)
 545 {
 546         const struct bt_stream_class *stream_class;
 547         const struct bt_trace_class *trace_class;
 548         char tmp_prefix[TMP_PREFIX_LEN];
 549
 550         BUF_APPEND(", %sid=%" PRIu64, PRFIELD(event_class->id));
 551
 552         if (event_class->name.value) {
 553                 BUF_APPEND(", %sname=\"%s\"",
 554                         PRFIELD(event_class->name.value));
 555         }
 556
 557         if (!extended) {
 558                 return;
 559         }
 560
 561         BUF_APPEND(", %sis-frozen=%d", PRFIELD(event_class->frozen));
 562
 563         if (event_class->log_level.base.avail) {
 564                 BUF_APPEND(", %slog-level=%s",
 565                         PRFIELD(bt_common_event_class_log_level_string(
 566                                 (int) event_class->log_level.value)));
 567         }
 568
 569         if (event_class->emf_uri.value) {
 570                 BUF_APPEND(", %semf-uri=\"%s\"",
 571                         PRFIELD(event_class->emf_uri.value));
 572         }
 573
 574         BUF_APPEND(", %sspecific-context-fc-addr=%p, %spayload-fc-addr=%p",
 575                 PRFIELD(event_class->specific_context_fc),
 576                 PRFIELD(event_class->payload_fc));
 577
 578         stream_class = bt_event_class_borrow_stream_class_const(event_class);
 579         if (!stream_class) {
 580                 return;
 581         }
 582
 583         BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class));
 584         SET_TMP_PREFIX("stream-class-");
 585         format_stream_class(buf_ch, false, tmp_prefix, stream_class);
 586         trace_class = bt_stream_class_borrow_trace_class_inline(stream_class);
 587         if (!trace_class) {
 588                 return;
 589         }
 590
 591         BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
 592         SET_TMP_PREFIX("trace-class-");
 593         format_trace_class(buf_ch, false, tmp_prefix, trace_class);
 594         SET_TMP_PREFIX("event-pool-");
 595         format_object_pool(buf_ch, extended, tmp_prefix,
 596                 &event_class->event_pool);
 597 }
 598
 599 static inline void format_stream(char **buf_ch, bool extended,
 600                 const char *prefix, const struct bt_stream *stream)
 601 {
 602         const struct bt_stream_class *stream_class;
 603         const struct bt_trace_class *trace_class = NULL;
 604         const struct bt_trace *trace = NULL;
 605         char tmp_prefix[TMP_PREFIX_LEN];
 606
 607         BUF_APPEND(", %sid=%" PRIu64, PRFIELD(stream->id));
 608
 609         if (stream->name.value) {
 610                 BUF_APPEND(", %sname=\"%s\"", PRFIELD(stream->name.value));
 611         }
 612
 613         if (!extended) {
 614                 return;
 615         }
 616
 617         stream_class = bt_stream_borrow_class_const(stream);
 618         if (stream_class) {
 619                 BUF_APPEND(", %sstream-class-addr=%p", PRFIELD(stream_class));
 620                 SET_TMP_PREFIX("stream-class-");
 621                 format_stream_class(buf_ch, false, tmp_prefix, stream_class);
 622                 trace_class = bt_stream_class_borrow_trace_class_inline(stream_class);
 623         }
 624
 625         if (trace_class) {
 626                 BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
 627                 SET_TMP_PREFIX("trace-class-");
 628                 format_trace_class(buf_ch, false, tmp_prefix, trace_class);
 629         }
 630
 631         trace = bt_stream_borrow_trace_inline(stream);
 632         if (trace) {
 633                 BUF_APPEND(", %strace-addr=%p", PRFIELD(trace));
 634                 SET_TMP_PREFIX("trace-");
 635                 format_trace(buf_ch, false, tmp_prefix, trace);
 636         }
 637
 638         SET_TMP_PREFIX("packet-pool-");
 639         format_object_pool(buf_ch, extended, tmp_prefix, &stream->packet_pool);
 640 }
 641
 642 static inline void format_packet(char **buf_ch, bool extended,
 643                 const char *prefix, const struct bt_packet *packet)
 644 {
 645         const struct bt_stream *stream;
 646         const struct bt_trace_class *trace_class;
 647         char tmp_prefix[TMP_PREFIX_LEN];
 648
 649         if (!extended) {
 650                 return;
 651         }
 652
 653         BUF_APPEND(", %sis-frozen=%d, %scontext-field-addr=%p",
 654                 PRFIELD(packet->frozen),
 655                 PRFIELD(packet->context_field ? packet->context_field->field : NULL));
 656         stream = bt_packet_borrow_stream_const(packet);
 657         if (!stream) {
 658                 return;
 659         }
 660
 661         BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream));
 662         SET_TMP_PREFIX("stream-");
 663         format_stream(buf_ch, false, tmp_prefix, stream);
 664         trace_class = (const struct bt_trace_class *) bt_object_borrow_parent(&stream->base);
 665         if (!trace_class) {
 666                 return;
 667         }
 668
 669         BUF_APPEND(", %strace-class-addr=%p", PRFIELD(trace_class));
 670         SET_TMP_PREFIX("trace-class-");
 671         format_trace_class(buf_ch, false, tmp_prefix, trace_class);
 672 }
 673
 674 static inline void format_event(char **buf_ch, bool extended,
 675                 const char *prefix, const struct bt_event *event)
 676 {
 677         const struct bt_packet *packet;
 678         const struct bt_stream *stream;
 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         packet = bt_event_borrow_packet_const(event);
 722         if (!packet) {
 723                 return;
 724         }
 725
 726         BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet));
 727         SET_TMP_PREFIX("packet-");
 728         format_packet(buf_ch, false, tmp_prefix, packet);
 729         stream = bt_packet_borrow_stream_const(packet);
 730         if (!stream) {
 731                 return;
 732         }
 733
 734         BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream));
 735         SET_TMP_PREFIX("stream-");
 736         format_stream(buf_ch, false, tmp_prefix, stream);
 737 }
 738
 739 static inline void format_clock_class(char **buf_ch, bool extended,
 740                 const char *prefix, const struct bt_clock_class *clock_class)
 741 {
 742         char tmp_prefix[TMP_PREFIX_LEN];
 743
 744         if (clock_class->name.value) {
 745                 BUF_APPEND(", %sname=\"%s\"", PRFIELD(clock_class->name.value));
 746         }
 747
 748         BUF_APPEND(", %sfreq=%" PRIu64, PRFIELD(clock_class->frequency));
 749
 750         if (!extended) {
 751                 return;
 752         }
 753
 754         if (clock_class->description.value) {
 755                 BUF_APPEND(", %spartial-descr=\"%.32s\"",
 756                         PRFIELD(clock_class->description.value));
 757         }
 758
 759         if (clock_class->uuid.value) {
 760                 BUF_APPEND_UUID(clock_class->uuid.value);
 761         }
 762
 763         BUF_APPEND(", %sis-frozen=%d, %sprecision=%" PRIu64 ", "
 764                 "%soffset-s=%" PRId64 ", "
 765                 "%soffset-cycles=%" PRIu64 ", %sorigin-is-unix-epoch=%d, "
 766                 "%sbase-offset-ns=%" PRId64,
 767                 PRFIELD(clock_class->frozen), PRFIELD(clock_class->precision),
 768                 PRFIELD(clock_class->offset_seconds),
 769                 PRFIELD(clock_class->offset_cycles),
 770                 PRFIELD(clock_class->origin_is_unix_epoch),
 771                 PRFIELD(clock_class->base_offset.value_ns));
 772
 773         SET_TMP_PREFIX("cs-pool-");
 774         format_object_pool(buf_ch, extended, tmp_prefix,
 775                 &clock_class->cs_pool);
 776 }
 777
 778 static inline void format_clock_snapshot(char **buf_ch, bool extended,
 779                 const char *prefix, const struct bt_clock_snapshot *clock_snapshot)
 780 {
 781         char tmp_prefix[TMP_PREFIX_LEN];
 782         BUF_APPEND(", %svalue=%" PRIu64 ", %sns-from-origin=%" PRId64,
 783                 PRFIELD(clock_snapshot->value_cycles),
 784                 PRFIELD(clock_snapshot->ns_from_origin));
 785
 786         if (!extended) {
 787                 return;
 788         }
 789
 790         BUF_APPEND(", %sis-set=%d", PRFIELD(clock_snapshot->is_set));
 791
 792         if (clock_snapshot->clock_class) {
 793                 BUF_APPEND(", %sclock-class-addr=%p",
 794                         PRFIELD(clock_snapshot->clock_class));
 795                 SET_TMP_PREFIX("clock-class-");
 796                 format_clock_class(buf_ch, false, tmp_prefix,
 797                         clock_snapshot->clock_class);
 798         }
 799 }
 800
 801 static inline void format_value(char **buf_ch, bool extended,
 802                 const char *prefix, const struct bt_value *value)
 803 {
 804         BUF_APPEND(", %stype=%s",
 805                 PRFIELD(bt_common_value_type_string(bt_value_get_type(value))));
 806
 807         if (!extended) {
 808                 return;
 809         }
 810
 811         switch (bt_value_get_type(value)) {
 812         case BT_VALUE_TYPE_BOOL:
 813         {
 814                 bt_bool val = bt_value_bool_get(value);
 815
 816                 BUF_APPEND(", %svalue=%d", PRFIELD(val));
 817                 break;
 818         }
 819         case BT_VALUE_TYPE_UNSIGNED_INTEGER:
 820         {
 821                 BUF_APPEND(", %svalue=%" PRIu64,
 822                         PRFIELD(bt_value_unsigned_integer_get(value)));
 823                 break;
 824         }
 825         case BT_VALUE_TYPE_SIGNED_INTEGER:
 826         {
 827                 BUF_APPEND(", %svalue=%" PRId64,
 828                         PRFIELD(bt_value_signed_integer_get(value)));
 829                 break;
 830         }
 831         case BT_VALUE_TYPE_REAL:
 832         {
 833                 double val = bt_value_real_get(value);
 834
 835                 BUF_APPEND(", %svalue=%f", PRFIELD(val));
 836                 break;
 837         }
 838         case BT_VALUE_TYPE_STRING:
 839         {
 840                 const char *val = bt_value_string_get(value);
 841
 842                 BUF_APPEND(", %spartial-value=\"%.32s\"", PRFIELD(val));
 843                 break;
 844         }
 845         case BT_VALUE_TYPE_ARRAY:
 846         {
 847                 int64_t count = bt_value_array_get_size(value);
 848
 849                 BT_ASSERT(count >= 0);
 850                 BUF_APPEND(", %selement-count=%" PRId64, PRFIELD(count));
 851                 break;
 852         }
 853         case BT_VALUE_TYPE_MAP:
 854         {
 855                 int64_t count = bt_value_map_get_size(value);
 856
 857                 BT_ASSERT(count >= 0);
 858                 BUF_APPEND(", %selement-count=%" PRId64, PRFIELD(count));
 859                 break;
 860         }
 861         default:
 862                 break;
 863         }
 864 }
 865
 866 static inline void format_message(char **buf_ch, bool extended,
 867                 const char *prefix, const struct bt_message *msg)
 868 {
 869         char tmp_prefix[TMP_PREFIX_LEN];
 870
 871         BUF_APPEND(", %stype=%s",
 872                 PRFIELD(bt_message_type_string(msg->type)));
 873
 874         if (!extended) {
 875                 return;
 876         }
 877
 878         BUF_APPEND(", %sis-frozen=%d, %sgraph-addr=%p",
 879                 PRFIELD(msg->frozen), PRFIELD(msg->graph));
 880
 881         switch (msg->type) {
 882         case BT_MESSAGE_TYPE_EVENT:
 883         {
 884                 const struct bt_message_event *msg_event =
 885                         (const void *) msg;
 886
 887                 if (msg_event->event) {
 888                         SET_TMP_PREFIX("event-");
 889                         format_event(buf_ch, true, tmp_prefix,
 890                                 msg_event->event);
 891                 }
 892
 893                 if (msg_event->default_cs) {
 894                         SET_TMP_PREFIX("default-cs-");
 895                         format_clock_snapshot(buf_ch, true, tmp_prefix,
 896                                 msg_event->default_cs);
 897                 }
 898
 899                 break;
 900         }
 901         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
 902         case BT_MESSAGE_TYPE_STREAM_END:
 903         {
 904                 const struct bt_message_stream *msg_stream = (const void *) msg;
 905
 906                 if (msg_stream->stream) {
 907                         SET_TMP_PREFIX("stream-");
 908                         format_stream(buf_ch, true, tmp_prefix,
 909                                 msg_stream->stream);
 910                 }
 911
 912                 BUF_APPEND(", %sdefault-cs-state=%s",
 913                         PRFIELD(bt_message_stream_clock_snapshot_state_string(
 914                                 msg_stream->default_cs_state)));
 915
 916                 if (msg_stream->default_cs_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
 917                         SET_TMP_PREFIX("default-cs-");
 918                         format_clock_snapshot(buf_ch, true, tmp_prefix,
 919                                 msg_stream->default_cs);
 920                 }
 921
 922                 break;
 923         }
 924         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
 925         case BT_MESSAGE_TYPE_PACKET_END:
 926         {
 927                 const struct bt_message_packet *msg_packet = (const void *) msg;
 928
 929                 if (msg_packet->packet) {
 930                         SET_TMP_PREFIX("packet-");
 931                         format_packet(buf_ch, true, tmp_prefix,
 932                                 msg_packet->packet);
 933                 }
 934
 935                 if (msg_packet->default_cs) {
 936                         SET_TMP_PREFIX("default-cs-");
 937                         format_clock_snapshot(buf_ch, true, tmp_prefix,
 938                                 msg_packet->default_cs);
 939                 }
 940
 941                 break;
 942         }
 943         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
 944         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
 945         {
 946                 const struct bt_message_discarded_items *msg_disc_items =
 947                         (const void *) msg;
 948
 949                 if (msg_disc_items->stream) {
 950                         SET_TMP_PREFIX("stream-");
 951                         format_stream(buf_ch, true, tmp_prefix,
 952                                 msg_disc_items->stream);
 953                 }
 954
 955                 if (msg_disc_items->default_begin_cs) {
 956                         SET_TMP_PREFIX("default-begin-cs-");
 957                         format_clock_snapshot(buf_ch, true, tmp_prefix,
 958                                 msg_disc_items->default_begin_cs);
 959                 }
 960
 961                 if (msg_disc_items->default_end_cs) {
 962                         SET_TMP_PREFIX("default-end-cs-");
 963                         format_clock_snapshot(buf_ch, true, tmp_prefix,
 964                                 msg_disc_items->default_end_cs);
 965                 }
 966
 967                 if (msg_disc_items->count.base.avail) {
 968                         BUF_APPEND(", %scount=%" PRIu64,
 969                                 PRFIELD(msg_disc_items->count.value));
 970                 }
 971
 972                 break;
 973         }
 974         default:
 975                 break;
 976         }
 977 }
 978
 979 static inline void format_plugin_so_shared_lib_handle(char **buf_ch,
 980                 const char *prefix,
 981                 const struct bt_plugin_so_shared_lib_handle *handle)
 982 {
 983         BUF_APPEND(", %saddr=%p", PRFIELD(handle));
 984
 985         if (handle->path) {
 986                 BUF_APPEND(", %spath=\"%s\"", PRFIELD_GSTRING(handle->path));
 987         }
 988 }
 989
 990 static inline void format_component_class(char **buf_ch, bool extended,
 991                 const char *prefix,
 992                 const struct bt_component_class *comp_class)
 993 {
 994         char tmp_prefix[TMP_PREFIX_LEN];
 995
 996         BUF_APPEND(", %stype=%s, %sname=\"%s\"",
 997                 PRFIELD(bt_component_class_type_string(comp_class->type)),
 998                 PRFIELD_GSTRING(comp_class->name));
 999
1000         if (comp_class->description) {
1001                 BUF_APPEND(", %spartial-descr=\"%.32s\"",
1002                         PRFIELD_GSTRING(comp_class->description));
1003         }
1004
1005         if (!extended) {
1006                 return;
1007         }
1008
1009         BUF_APPEND(", %sis-frozen=%d", PRFIELD(comp_class->frozen));
1010
1011         if (comp_class->so_handle) {
1012                 SET_TMP_PREFIX("so-handle-");
1013                 format_plugin_so_shared_lib_handle(buf_ch, tmp_prefix,
1014                         comp_class->so_handle);
1015         }
1016 }
1017
1018 static inline void format_component(char **buf_ch, bool extended,
1019                 const char *prefix, const struct bt_component *component)
1020 {
1021         char tmp_prefix[TMP_PREFIX_LEN];
1022
1023         BUF_APPEND(", %sname=\"%s\", %slog-level=%s",
1024                 PRFIELD_GSTRING(component->name),
1025                 PRFIELD(bt_common_logging_level_string(component->log_level)));
1026
1027         if (component->class) {
1028                 SET_TMP_PREFIX("class-");
1029                 format_component_class(buf_ch, extended, tmp_prefix,
1030                         component->class);
1031         }
1032
1033         if (!extended) {
1034                 return;
1035         }
1036
1037         if (component->input_ports) {
1038                 BUF_APPEND(", %sinput-port-count=%u",
1039                         PRFIELD(component->input_ports->len));
1040         }
1041
1042         if (component->output_ports) {
1043                 BUF_APPEND(", %soutput-port-count=%u",
1044                         PRFIELD(component->output_ports->len));
1045         }
1046 }
1047
1048 static inline void format_port(char **buf_ch, bool extended,
1049                 const char *prefix, const struct bt_port *port)
1050 {
1051         char tmp_prefix[TMP_PREFIX_LEN];
1052
1053         BUF_APPEND(", %stype=%s, %sname=\"%s\"",
1054                 PRFIELD(bt_port_type_string(port->type)),
1055                 PRFIELD_GSTRING(port->name));
1056
1057         if (!extended) {
1058                 return;
1059         }
1060
1061         if (port->connection) {
1062                 SET_TMP_PREFIX("conn-");
1063                 format_connection(buf_ch, false, tmp_prefix, port->connection);
1064         }
1065 }
1066
1067 static inline void format_connection(char **buf_ch, bool extended,
1068                 const char *prefix, const struct bt_connection *connection)
1069 {
1070         char tmp_prefix[TMP_PREFIX_LEN];
1071
1072         if (!extended) {
1073                 return;
1074         }
1075
1076         if (connection->upstream_port) {
1077                 SET_TMP_PREFIX("upstream-port-");
1078                 format_port(buf_ch, false, tmp_prefix,
1079                         connection->upstream_port);
1080         }
1081
1082         if (connection->downstream_port) {
1083                 SET_TMP_PREFIX("downstream-port-");
1084                 format_port(buf_ch, false, tmp_prefix,
1085                         connection->downstream_port);
1086         }
1087 }
1088
1089 static inline void format_graph(char **buf_ch, bool extended,
1090                 const char *prefix, const struct bt_graph *graph)
1091 {
1092         char tmp_prefix[TMP_PREFIX_LEN];
1093
1094         BUF_APPEND(", %sis-canceled=%d, %scan-consume=%d, "
1095                 "%sconfig-state=%s",
1096                 PRFIELD(graph->canceled),
1097                 PRFIELD(graph->can_consume),
1098                 PRFIELD(bt_graph_configuration_state_string(graph->config_state)));
1099
1100         if (!extended) {
1101                 return;
1102         }
1103
1104         if (graph->components) {
1105                 BUF_APPEND(", %scomp-count=%u",
1106                         PRFIELD(graph->components->len));
1107         }
1108
1109         if (graph->connections) {
1110                 BUF_APPEND(", %sconn-count=%u",
1111                         PRFIELD(graph->connections->len));
1112         }
1113
1114         SET_TMP_PREFIX("en-pool-");
1115         format_object_pool(buf_ch, extended, tmp_prefix,
1116                 &graph->event_msg_pool);
1117         SET_TMP_PREFIX("pbn-pool-");
1118         format_object_pool(buf_ch, extended, tmp_prefix,
1119                 &graph->packet_begin_msg_pool);
1120         SET_TMP_PREFIX("pen-pool-");
1121         format_object_pool(buf_ch, extended, tmp_prefix,
1122                 &graph->packet_end_msg_pool);
1123 }
1124
1125 static inline void format_message_iterator(char **buf_ch,
1126                 bool extended, const char *prefix,
1127                 const struct bt_message_iterator *iterator)
1128 {
1129         const char *type;
1130         char tmp_prefix[TMP_PREFIX_LEN];
1131
1132         if (iterator->type == BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT) {
1133                 type = "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
1134         } else if (iterator->type == BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT) {
1135                 type = "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
1136         } else {
1137                 type = "(unknown)";
1138         }
1139
1140         BUF_APPEND(", %stype=%s", PRFIELD(type));
1141
1142         switch (iterator->type) {
1143         case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT:
1144         {
1145                 const struct bt_self_component_port_input_message_iterator *
1146                         port_in_iter = (const void *) iterator;
1147
1148                 if (port_in_iter->upstream_component) {
1149                         SET_TMP_PREFIX("upstream-comp-");
1150                         format_component(buf_ch, false, tmp_prefix,
1151                                 port_in_iter->upstream_component);
1152                 }
1153
1154                 if (port_in_iter->upstream_port) {
1155                         SET_TMP_PREFIX("upstream-port-");
1156                         format_port(buf_ch, false, tmp_prefix,
1157                                 port_in_iter->upstream_port);
1158                 }
1159
1160                 if (port_in_iter->connection) {
1161                         SET_TMP_PREFIX("upstream-conn-");
1162                         format_connection(buf_ch, false, tmp_prefix,
1163                                 port_in_iter->connection);
1164                 }
1165                 break;
1166         }
1167         case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT:
1168         {
1169                 const struct bt_port_output_message_iterator *port_out_iter =
1170                         (const void *) iterator;
1171
1172                 if (port_out_iter->graph) {
1173                         SET_TMP_PREFIX("graph-");
1174                         format_graph(buf_ch, false, tmp_prefix,
1175                                 port_out_iter->graph);
1176                 }
1177
1178                 if (port_out_iter->colander) {
1179                         SET_TMP_PREFIX("colander-comp-");
1180                         format_component(buf_ch, false, tmp_prefix,
1181                                 (void *) port_out_iter->colander);
1182                 }
1183
1184                 break;
1185         }
1186         default:
1187                 break;
1188         }
1189 }
1190
1191 static inline void format_plugin(char **buf_ch, bool extended,
1192                 const char *prefix, const struct bt_plugin *plugin)
1193 {
1194         char tmp_prefix[TMP_PREFIX_LEN];
1195
1196         BUF_APPEND(", %stype=%s", PRFIELD(bt_plugin_type_string(plugin->type)));
1197
1198         if (plugin->info.path_set) {
1199                 BUF_APPEND(", %spath=\"%s\"",
1200                         PRFIELD_GSTRING(plugin->info.path));
1201         }
1202
1203         if (plugin->info.name_set) {
1204                 BUF_APPEND(", %sname=\"%s\"",
1205                         PRFIELD_GSTRING(plugin->info.name));
1206         }
1207
1208         if (!extended) {
1209                 return;
1210         }
1211
1212         if (plugin->info.author_set) {
1213                 BUF_APPEND(", %sauthor=\"%s\"",
1214                         PRFIELD_GSTRING(plugin->info.author));
1215         }
1216
1217         if (plugin->info.license_set) {
1218                 BUF_APPEND(", %slicense=\"%s\"",
1219                         PRFIELD_GSTRING(plugin->info.license));
1220         }
1221
1222         if (plugin->info.version_set) {
1223                 BUF_APPEND(", %sversion=%u.%u.%u%s",
1224                         PRFIELD(plugin->info.version.major),
1225                         plugin->info.version.minor,
1226                         plugin->info.version.patch,
1227                         plugin->info.version.extra ?
1228                                 plugin->info.version.extra->str : "");
1229         }
1230
1231         BUF_APPEND(", %ssrc-comp-class-count=%u, %sflt-comp-class-count=%u, "
1232                 "%ssink-comp-class-count=%u",
1233                 PRFIELD(plugin->src_comp_classes->len),
1234                 PRFIELD(plugin->flt_comp_classes->len),
1235                 PRFIELD(plugin->sink_comp_classes->len));
1236
1237         if (plugin->spec_data) {
1238                 const struct bt_plugin_so_spec_data *spec_data =
1239                         (const void *) plugin->spec_data;
1240
1241                 if (spec_data->shared_lib_handle) {
1242                         SET_TMP_PREFIX("so-handle-");
1243                         format_plugin_so_shared_lib_handle(buf_ch, tmp_prefix,
1244                                 spec_data->shared_lib_handle);
1245                 }
1246         }
1247 }
1248
1249 static inline void format_error_cause(char **buf_ch, bool extended,
1250                 const char *prefix, const struct bt_error_cause *cause)
1251 {
1252         const struct bt_error_cause_component_class_id *comp_class_id = NULL;
1253
1254         BUF_APPEND(", %sactor-type=%s, %smodule-name=\"%s\"",
1255                 PRFIELD(bt_error_cause_actor_type_string(cause->actor_type)),
1256                 PRFIELD_GSTRING(cause->module_name));
1257
1258         if (!extended) {
1259                 return;
1260         }
1261
1262         BUF_APPEND(", %spartial-msg=\"%.32s\"",
1263                 PRFIELD_GSTRING(cause->message));
1264
1265         switch (cause->actor_type) {
1266         case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT:
1267         {
1268                 const struct bt_error_cause_component_actor *spec_cause =
1269                         (const void *) cause;
1270
1271                 BUF_APPEND(", %scomp-name=\"%s\"",
1272                         PRFIELD_GSTRING(spec_cause->comp_name));
1273                 comp_class_id = &spec_cause->comp_class_id;
1274                 break;
1275         }
1276         case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS:
1277         {
1278                 const struct bt_error_cause_component_class_actor *spec_cause =
1279                         (const void *) cause;
1280
1281                 comp_class_id = &spec_cause->comp_class_id;
1282                 break;
1283         }
1284         case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR:
1285         {
1286                 const struct bt_error_cause_message_iterator_actor *spec_cause =
1287                         (const void *) cause;
1288
1289                 BUF_APPEND(", %scomp-name=\"%s\", %scomp-out-port-name=\"%s\"",
1290                         PRFIELD_GSTRING(spec_cause->comp_name),
1291                         PRFIELD_GSTRING(spec_cause->output_port_name));
1292                 comp_class_id = &spec_cause->comp_class_id;
1293                 break;
1294         }
1295         default:
1296                 break;
1297         }
1298
1299         if (comp_class_id) {
1300                 BUF_APPEND(", %scomp-cls-type=%s, %scomp-cls-name=\"%s\", "
1301                         "%splugin-name=\"%s\"",
1302                         PRFIELD(bt_component_class_type_string(
1303                                 comp_class_id->type)),
1304                         PRFIELD_GSTRING(comp_class_id->name),
1305                         PRFIELD_GSTRING(comp_class_id->plugin_name));
1306         }
1307 }
1308
1309 static inline void handle_conversion_specifier_bt(void *priv_data,
1310                 char **buf_ch, size_t avail_size,
1311                 const char **out_fmt_ch, va_list *args)
1312 {
1313         const char *fmt_ch = *out_fmt_ch;
1314         bool extended = false;
1315         char prefix[64];
1316         char *prefix_ch = prefix;
1317         const void *obj;
1318
1319         /* skip "%!" */
1320         fmt_ch += 2;
1321
1322         if (*fmt_ch == 'u') {
1323                 /* UUID */
1324                 obj = va_arg(*args, void *);
1325                 format_uuid(buf_ch, obj);
1326                 goto update_fmt;
1327         }
1328
1329         if (*fmt_ch == '[') {
1330                 /* local prefix */
1331                 fmt_ch++;
1332
1333                 while (true) {
1334                         if (*fmt_ch == ']') {
1335                                 *prefix_ch = '\0';
1336                                 fmt_ch++;
1337                                 break;
1338                         }
1339
1340                         *prefix_ch = *fmt_ch;
1341                         prefix_ch++;
1342                         fmt_ch++;
1343                 }
1344         }
1345
1346         *prefix_ch = '\0';
1347
1348         if (*fmt_ch == '+') {
1349                 extended = true;
1350                 fmt_ch++;
1351         }
1352
1353         obj = va_arg(*args, void *);
1354         BUF_APPEND("%saddr=%p", prefix, obj);
1355
1356         if (!obj) {
1357                 goto update_fmt;
1358         }
1359
1360         switch (*fmt_ch) {
1361         case 'F':
1362                 format_field_class(buf_ch, extended, prefix, obj);
1363                 break;
1364         case 'f':
1365                 format_field(buf_ch, extended, prefix, obj);
1366                 break;
1367         case 'P':
1368                 format_field_path(buf_ch, extended, prefix, obj);
1369                 break;
1370         case 'E':
1371                 format_event_class(buf_ch, extended, prefix, obj);
1372                 break;
1373         case 'e':
1374                 format_event(buf_ch, extended, prefix, obj);
1375                 break;
1376         case 'S':
1377                 format_stream_class(buf_ch, extended, prefix, obj);
1378                 break;
1379         case 's':
1380                 format_stream(buf_ch, extended, prefix, obj);
1381                 break;
1382         case 'a':
1383                 format_packet(buf_ch, extended, prefix, obj);
1384                 break;
1385         case 't':
1386                 format_trace(buf_ch, extended, prefix, obj);
1387                 break;
1388         case 'T':
1389                 format_trace_class(buf_ch, extended, prefix, obj);
1390                 break;
1391         case 'K':
1392                 format_clock_class(buf_ch, extended, prefix, obj);
1393                 break;
1394         case 'k':
1395                 format_clock_snapshot(buf_ch, extended, prefix, obj);
1396                 break;
1397         case 'v':
1398                 format_value(buf_ch, extended, prefix, obj);
1399                 break;
1400         case 'n':
1401                 format_message(buf_ch, extended, prefix, obj);
1402                 break;
1403         case 'i':
1404                 format_message_iterator(buf_ch, extended, prefix, obj);
1405                 break;
1406         case 'C':
1407                 format_component_class(buf_ch, extended, prefix, obj);
1408                 break;
1409         case 'c':
1410                 format_component(buf_ch, extended, prefix, obj);
1411                 break;
1412         case 'p':
1413                 format_port(buf_ch, extended, prefix, obj);
1414                 break;
1415         case 'x':
1416                 format_connection(buf_ch, extended, prefix, obj);
1417                 break;
1418         case 'l':
1419                 format_plugin(buf_ch, extended, prefix, obj);
1420                 break;
1421         case 'g':
1422                 format_graph(buf_ch, extended, prefix, obj);
1423                 break;
1424         case 'o':
1425                 format_object_pool(buf_ch, extended, prefix, obj);
1426                 break;
1427         case 'O':
1428                 format_object(buf_ch, extended, prefix, obj);
1429                 break;
1430         case 'r':
1431                 format_error_cause(buf_ch, extended, prefix, obj);
1432                 break;
1433         default:
1434                 abort();
1435         }
1436
1437 update_fmt:
1438         fmt_ch++;
1439         *out_fmt_ch = fmt_ch;
1440 }
1441
1442 void bt_lib_log(const char *func, const char *file, unsigned line,
1443                 int lvl, const char *tag, const char *fmt, ...)
1444 {
1445         va_list args;
1446
1447         BT_ASSERT(fmt);
1448         va_start(args, fmt);
1449         bt_common_custom_vsnprintf(lib_logging_buf, LIB_LOGGING_BUF_SIZE, '!',
1450                 handle_conversion_specifier_bt, NULL, fmt, &args);
1451         va_end(args);
1452         _bt_log_write_d(func, file, line, lvl, tag, "%s", lib_logging_buf);
1453 }
1454
1455 void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
1456                 unsigned line, int lvl, const char *tag,
1457                 const char *fmt, ...)
1458 {
1459         va_list args;
1460         bt_current_thread_error_append_cause_status status;
1461
1462         BT_ASSERT(fmt);
1463         va_start(args, fmt);
1464         bt_common_custom_vsnprintf(lib_logging_buf, LIB_LOGGING_BUF_SIZE, '!',
1465                 handle_conversion_specifier_bt, NULL, fmt, &args);
1466         va_end(args);
1467
1468         /* Log conditionally, but always append the error cause */
1469         if (BT_LOG_ON(lvl)) {
1470                 _bt_log_write_d(func, file, line, lvl, tag, "%s",
1471                         lib_logging_buf);
1472         }
1473
1474         status = bt_current_thread_error_append_cause_from_unknown(
1475                 "Babeltrace library", file, line, "%s", lib_logging_buf);
1476         if (status) {
1477                 /*
1478                  * Worst case: this error cause is not appended to the
1479                  * current thread's error.
1480                  *
1481                  * We can accept this as it's an almost impossible
1482                  * scenario and returning an error here would mean you
1483                  * need to check the return value of each
1484                  * BT_LIB_LOG*_APPEND_CAUSE() macro and that would be
1485                  * cumbersome.
1486                  */
1487                 BT_LOGE("Cannot append error cause to current thread's "
1488                         "error object: status=%s",
1489                         bt_common_func_status_string(status));
1490         }
1491 }