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