lib/ctf-ir/stream.c

   1 /*
   2  * stream.c
   3  *
   4  * Babeltrace CTF IR - Stream
   5  *
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #define BT_LOG_TAG "STREAM"
  30 #include <babeltrace/lib-logging-internal.h>
  31
  32 #include <babeltrace/ctf-ir/clock-class.h>
  33 #include <babeltrace/ctf-writer/clock.h>
  34 #include <babeltrace/ctf-writer/clock-internal.h>
  35 #include <babeltrace/ctf-writer/event.h>
  36 #include <babeltrace/ctf-ir/event-internal.h>
  37 #include <babeltrace/ctf-ir/field-types-internal.h>
  38 #include <babeltrace/ctf-ir/fields-internal.h>
  39 #include <babeltrace/ctf-ir/stream.h>
  40 #include <babeltrace/ctf-ir/stream-internal.h>
  41 #include <babeltrace/ctf-ir/stream-class-internal.h>
  42 #include <babeltrace/ctf-ir/trace.h>
  43 #include <babeltrace/ctf-ir/trace-internal.h>
  44 #include <babeltrace/ctf-writer/writer-internal.h>
  45 #include <babeltrace/graph/component-internal.h>
  46 #include <babeltrace/ref.h>
  47 #include <babeltrace/ctf-writer/functor-internal.h>
  48 #include <babeltrace/compiler-internal.h>
  49 #include <babeltrace/align-internal.h>
  50 #include <inttypes.h>
  51 #include <unistd.h>
  52
  53 static
  54 void bt_stream_destroy(struct bt_object *obj);
  55 static
  56 int try_set_structure_field_integer(struct bt_field *, char *, uint64_t);
  57
  58 static
  59 int set_integer_field_value(struct bt_field* field, uint64_t value)
  60 {
  61         int ret = 0;
  62         struct bt_field_type *field_type = NULL;
  63
  64         if (!field) {
  65                 BT_LOGW_STR("Invalid parameter: field is NULL.");
  66                 ret = -1;
  67                 goto end;
  68         }
  69
  70         field_type = bt_field_get_type(field);
  71         assert(field_type);
  72
  73         if (bt_field_type_get_type_id(field_type) !=
  74                         BT_FIELD_TYPE_ID_INTEGER) {
  75                 /* Not an integer and the value is unset, error. */
  76                 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
  77                         "field-addr=%p, ft-addr=%p, ft-id=%s",
  78                         field, field_type,
  79                         bt_field_type_id_string(field_type->id));
  80                 ret = -1;
  81                 goto end;
  82         }
  83
  84         if (bt_field_type_integer_is_signed(field_type)) {
  85                 ret = bt_field_signed_integer_set_value(field, (int64_t) value);
  86                 if (ret) {
  87                         /* Value is out of range, error. */
  88                         BT_LOGW("Cannot set signed integer field's value: "
  89                                 "addr=%p, value=%" PRId64,
  90                                 field, (int64_t) value);
  91                         goto end;
  92                 }
  93         } else {
  94                 ret = bt_field_unsigned_integer_set_value(field, value);
  95                 if (ret) {
  96                         /* Value is out of range, error. */
  97                         BT_LOGW("Cannot set unsigned integer field's value: "
  98                                 "addr=%p, value=%" PRIu64,
  99                                 field, value);
 100                         goto end;
 101                 }
 102         }
 103 end:
 104         bt_put(field_type);
 105         return ret;
 106 }
 107
 108 static
 109 int set_packet_header_magic(struct bt_stream *stream)
 110 {
 111         int ret = 0;
 112         struct bt_field *magic_field = bt_field_structure_get_field_by_name(
 113                 stream->packet_header, "magic");
 114         const uint32_t magic_value = 0xc1fc1fc1;
 115
 116         assert(stream);
 117
 118         if (!magic_field) {
 119                 /* No magic field found. Not an error, skip. */
 120                 BT_LOGV("No field named `magic` in packet header: skipping: "
 121                         "stream-addr=%p, stream-name=\"%s\"",
 122                         stream, bt_stream_get_name(stream));
 123                 goto end;
 124         }
 125
 126         ret = bt_field_unsigned_integer_set_value(magic_field,
 127                 (uint64_t) magic_value);
 128
 129         if (ret) {
 130                 BT_LOGW("Cannot set packet header field's `magic` integer field's value: "
 131                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 132                         stream, bt_stream_get_name(stream),
 133                         magic_field, (uint64_t) magic_value);
 134         } else {
 135                 BT_LOGV("Set packet header field's `magic` field's value: "
 136                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 137                         stream, bt_stream_get_name(stream),
 138                         magic_field, (uint64_t) magic_value);
 139         }
 140 end:
 141         bt_put(magic_field);
 142         return ret;
 143 }
 144
 145 static
 146 int set_packet_header_uuid(struct bt_stream *stream)
 147 {
 148         int ret = 0;
 149         int64_t i;
 150         struct bt_trace *trace = NULL;
 151         struct bt_field *uuid_field = bt_field_structure_get_field_by_name(
 152                 stream->packet_header, "uuid");
 153
 154         assert(stream);
 155
 156         if (!uuid_field) {
 157                 /* No uuid field found. Not an error, skip. */
 158                 BT_LOGV("No field named `uuid` in packet header: skipping: "
 159                         "stream-addr=%p, stream-name=\"%s\"",
 160                         stream, bt_stream_get_name(stream));
 161                 goto end;
 162         }
 163
 164         trace = (struct bt_trace *) bt_object_get_parent(stream);
 165         for (i = 0; i < 16; i++) {
 166                 struct bt_field *uuid_element =
 167                         bt_field_array_get_field(uuid_field, i);
 168
 169                 ret = bt_field_unsigned_integer_set_value(
 170                         uuid_element, (uint64_t) trace->uuid[i]);
 171                 bt_put(uuid_element);
 172                 if (ret) {
 173                         BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): "
 174                                 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
 175                                 "value=%" PRIu64 ", index=%" PRId64,
 176                                 stream, bt_stream_get_name(stream),
 177                                 uuid_element, (uint64_t) trace->uuid[i], i);
 178                         goto end;
 179                 }
 180         }
 181
 182         BT_LOGV("Set packet header field's `uuid` field's value: "
 183                 "stream-addr=%p, stream-name=\"%s\", field-addr=%p",
 184                 stream, bt_stream_get_name(stream), uuid_field);
 185
 186 end:
 187         bt_put(uuid_field);
 188         BT_PUT(trace);
 189         return ret;
 190 }
 191 static
 192 int set_packet_header_stream_id(struct bt_stream *stream)
 193 {
 194         int ret = 0;
 195         uint32_t stream_id;
 196         struct bt_field *stream_id_field = bt_field_structure_get_field_by_name(
 197                 stream->packet_header, "stream_id");
 198
 199         if (!stream_id_field) {
 200                 /* No stream_id field found. Not an error, skip. */
 201                 BT_LOGV("No field named `stream_id` in packet header: skipping: "
 202                         "stream-addr=%p, stream-name=\"%s\"",
 203                         stream, bt_stream_get_name(stream));
 204                 goto end;
 205         }
 206
 207         stream_id = stream->stream_class->id;
 208         ret = bt_field_unsigned_integer_set_value(stream_id_field,
 209                 (uint64_t) stream_id);
 210         if (ret) {
 211                 BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: "
 212                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 213                         stream, bt_stream_get_name(stream),
 214                         stream_id_field, (uint64_t) stream_id);
 215         } else {
 216                 BT_LOGV("Set packet header field's `stream_id` field's value: "
 217                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 218                         stream, bt_stream_get_name(stream),
 219                         stream_id_field, (uint64_t) stream_id);
 220         }
 221
 222 end:
 223         bt_put(stream_id_field);
 224         return ret;
 225 }
 226
 227 static
 228 int auto_populate_packet_header(struct bt_stream *stream)
 229 {
 230         int ret = 0;
 231
 232         if (!stream->packet_header) {
 233                 goto end;
 234         }
 235
 236         ret = set_packet_header_magic(stream);
 237         if (ret) {
 238                 BT_LOGW("Cannot set packet header's magic number field: "
 239                         "stream-addr=%p, stream-name=\"%s\"",
 240                         stream, bt_stream_get_name(stream));
 241                 goto end;
 242         }
 243
 244         ret = set_packet_header_uuid(stream);
 245         if (ret) {
 246                 BT_LOGW("Cannot set packet header's UUID field: "
 247                         "stream-addr=%p, stream-name=\"%s\"",
 248                         stream, bt_stream_get_name(stream));
 249                 goto end;
 250         }
 251
 252         ret = set_packet_header_stream_id(stream);
 253         if (ret) {
 254                 BT_LOGW("Cannot set packet header's stream class ID field: "
 255                         "stream-addr=%p, stream-name=\"%s\"",
 256                         stream, bt_stream_get_name(stream));
 257                 goto end;
 258         }
 259
 260         BT_LOGV("Automatically populated stream's packet header's known fields: "
 261                 "stream-addr=%p, stream-name=\"%s\"",
 262                 stream, bt_stream_get_name(stream));
 263
 264 end:
 265         return ret;
 266 }
 267
 268 static
 269 int set_packet_context_packet_size(struct bt_stream *stream)
 270 {
 271         int ret = 0;
 272         struct bt_field *field = bt_field_structure_get_field_by_name(
 273                 stream->packet_context, "packet_size");
 274
 275         assert(stream);
 276
 277         if (!field) {
 278                 /* No packet size field found. Not an error, skip. */
 279                 BT_LOGV("No field named `packet_size` in packet context: skipping: "
 280                         "stream-addr=%p, stream-name=\"%s\"",
 281                         stream, bt_stream_get_name(stream));
 282                 goto end;
 283         }
 284
 285         ret = bt_field_unsigned_integer_set_value(field,
 286                 stream->pos.packet_size);
 287         if (ret) {
 288                 BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: "
 289                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 290                         stream, bt_stream_get_name(stream),
 291                         field, stream->pos.packet_size);
 292         } else {
 293                 BT_LOGV("Set packet context field's `packet_size` field's value: "
 294                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 295                         stream, bt_stream_get_name(stream),
 296                         field, stream->pos.packet_size);
 297         }
 298
 299 end:
 300         bt_put(field);
 301         return ret;
 302 }
 303
 304 static
 305 int set_packet_context_content_size(struct bt_stream *stream)
 306 {
 307         int ret = 0;
 308         struct bt_field *field = bt_field_structure_get_field_by_name(
 309                 stream->packet_context, "content_size");
 310
 311         assert(stream);
 312
 313         if (!field) {
 314                 /* No content size field found. Not an error, skip. */
 315                 BT_LOGV("No field named `content_size` in packet context: skipping: "
 316                         "stream-addr=%p, stream-name=\"%s\"",
 317                         stream, bt_stream_get_name(stream));
 318                 goto end;
 319         }
 320
 321         ret = bt_field_unsigned_integer_set_value(field,
 322                 stream->pos.offset);
 323         if (ret) {
 324                 BT_LOGW("Cannot set packet context field's `content_size` integer field's value: "
 325                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64,
 326                         stream, bt_stream_get_name(stream),
 327                         field, stream->pos.offset);
 328         } else {
 329                 BT_LOGV("Set packet context field's `content_size` field's value: "
 330                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64,
 331                         stream, bt_stream_get_name(stream),
 332                         field, stream->pos.offset);
 333         }
 334
 335 end:
 336         bt_put(field);
 337         return ret;
 338 }
 339
 340 static
 341 int set_packet_context_events_discarded(struct bt_stream *stream)
 342 {
 343         int ret = 0;
 344         struct bt_field *field = bt_field_structure_get_field_by_name(
 345                 stream->packet_context, "events_discarded");
 346
 347         assert(stream);
 348
 349         if (!field) {
 350                 /* No discarded events count field found. Not an error, skip. */
 351                 BT_LOGV("No field named `events_discarded` in packet context: skipping: "
 352                         "stream-addr=%p, stream-name=\"%s\"",
 353                         stream, bt_stream_get_name(stream));
 354                 goto end;
 355         }
 356
 357         /*
 358          * If the field is set by the user, make sure that the value is
 359          * greater than or equal to the stream's current count of
 360          * discarded events. We do not allow wrapping here. If it's
 361          * valid, update the stream's current count.
 362          */
 363         if (bt_field_is_set(field)) {
 364                 uint64_t user_val;
 365
 366                 ret = bt_field_unsigned_integer_get_value(field,
 367                         &user_val);
 368                 if (ret) {
 369                         BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: "
 370                                 "stream-addr=%p, stream-name=\"%s\", field-addr=%p",
 371                                 stream, bt_stream_get_name(stream), field);
 372                         goto end;
 373                 }
 374
 375                 if (user_val < stream->discarded_events) {
 376                         BT_LOGW("Invalid packet context `events_discarded` field's unsigned value: "
 377                                 "value is lesser than the stream's current discarded events count: "
 378                                 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
 379                                 "value=%" PRIu64 ", "
 380                                 "stream-discarded-events-count=%" PRIu64,
 381                                 stream, bt_stream_get_name(stream), field,
 382                                 user_val, stream->discarded_events);
 383                         goto end;
 384                 }
 385
 386                 stream->discarded_events = user_val;
 387         } else {
 388                 ret = bt_field_unsigned_integer_set_value(field,
 389                         stream->discarded_events);
 390                 if (ret) {
 391                         BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: "
 392                                 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 393                                 stream, bt_stream_get_name(stream),
 394                                 field, stream->discarded_events);
 395                 } else {
 396                         BT_LOGV("Set packet context field's `events_discarded` field's value: "
 397                                 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 398                                 stream, bt_stream_get_name(stream),
 399                                 field, stream->discarded_events);
 400                 }
 401         }
 402
 403 end:
 404         bt_put(field);
 405         return ret;
 406 }
 407
 408 static
 409 int get_event_header_timestamp(struct bt_stream *stream,
 410                 struct bt_field *event_header, uint64_t *timestamp)
 411 {
 412         int ret = 0;
 413         struct bt_field *timestamp_field = NULL;
 414         struct bt_clock_class *ts_field_mapped_clock_class = NULL;
 415
 416         *timestamp = 0;
 417
 418         if (!event_header) {
 419                 BT_LOGV_STR("Event header does not exist.");
 420                 goto end;
 421         }
 422
 423         timestamp_field = bt_field_structure_get_field_by_name(event_header,
 424                 "timestamp");
 425         if (!timestamp_field) {
 426                 BT_LOGV("Cannot get event header's `timestamp` field: "
 427                         "event-header-field-addr=%p", event_header);
 428                 goto end;
 429         }
 430
 431         if (!bt_field_type_is_integer(timestamp_field->type)) {
 432                 BT_LOGV("Event header's `timestamp` field's type is not an integer field type: "
 433                         "event-header-field-addr=%p", event_header);
 434                 goto end;
 435         }
 436
 437         ts_field_mapped_clock_class =
 438                 bt_field_type_integer_get_mapped_clock_class(
 439                         timestamp_field->type);
 440         if (!ts_field_mapped_clock_class) {
 441                 BT_LOGV("Event header's `timestamp` field's type is not mapped to a clock class: "
 442                         "event-header-field-addr=%p", event_header);
 443                 goto end;
 444         }
 445
 446         if (ts_field_mapped_clock_class !=
 447                         stream->stream_class->clock->clock_class) {
 448                 BT_LOGV("Event header's `timestamp` field's type is not mapped to the stream's clock's class: "
 449                         "event-header-field-addr=%p", event_header);
 450                 goto end;
 451         }
 452
 453         ret = bt_field_unsigned_integer_get_value(timestamp_field,
 454                 timestamp);
 455         if (ret) {
 456                 BT_LOGW("Cannot get unsigned integer field's value: "
 457                         "event-header-field-addr=%p, "
 458                         "timestamp-field-addr=%p",
 459                         event_header, timestamp_field);
 460                 goto end;
 461         }
 462
 463 end:
 464         bt_put(timestamp_field);
 465         bt_put(ts_field_mapped_clock_class);
 466         return ret;
 467 }
 468
 469 static
 470 int set_packet_context_timestamp_field(struct bt_stream *stream,
 471                 const char *field_name, struct bt_event *event)
 472 {
 473         int ret = 0;
 474         struct bt_field *field = bt_field_structure_get_field_by_name(
 475                 stream->packet_context, field_name);
 476         struct bt_clock_class *field_mapped_clock_class = NULL;
 477         uint64_t ts;
 478
 479         assert(stream);
 480
 481         if (!field) {
 482                 /* No beginning timestamp field found. Not an error, skip. */
 483                 BT_LOGV("No field named `%s` in packet context: skipping: "
 484                         "stream-addr=%p, stream-name=\"%s\"", field_name,
 485                         stream, bt_stream_get_name(stream));
 486                 goto end;
 487         }
 488
 489         if (!stream->stream_class->clock) {
 490                 BT_LOGV("Stream has no clock: skipping: "
 491                         "stream-addr=%p, stream-name=\"%s\"",
 492                         stream, bt_stream_get_name(stream));
 493                 goto end;
 494         }
 495
 496         field_mapped_clock_class =
 497                 bt_field_type_integer_get_mapped_clock_class(field->type);
 498         if (!field_mapped_clock_class) {
 499                 BT_LOGV("Packet context's `%s` field's type is not mapped to a clock class: skipping: "
 500                         "stream-addr=%p, stream-name=\"%s\", "
 501                         "field-addr=%p, ft-addr=%p", field_name,
 502                         stream, bt_stream_get_name(stream),
 503                         field, field->type);
 504                 goto end;
 505         }
 506
 507         if (field_mapped_clock_class !=
 508                         stream->stream_class->clock->clock_class) {
 509                 BT_LOGV("Packet context's `%s` field's type is not mapped to the stream's clock's class: skipping: "
 510                         "stream-addr=%p, stream-name=\"%s\", "
 511                         "field-addr=%p, ft-addr=%p, "
 512                         "ft-mapped-clock-class-addr=%p, "
 513                         "ft-mapped-clock-class-name=\"%s\", "
 514                         "stream-clock-class-addr=%p, "
 515                         "stream-clock-class-name=\"%s\"",
 516                         field_name,
 517                         stream, bt_stream_get_name(stream),
 518                         field, field->type,
 519                         field_mapped_clock_class,
 520                         bt_clock_class_get_name(field_mapped_clock_class),
 521                         stream->stream_class->clock->clock_class,
 522                         bt_clock_class_get_name(
 523                                 stream->stream_class->clock->clock_class));
 524                 goto end;
 525         }
 526
 527         if (get_event_header_timestamp(stream, event->event_header, &ts)) {
 528                 BT_LOGW("Cannot get event's timestamp: "
 529                         "event-header-field-addr=%p",
 530                         event->event_header);
 531                 ret = -1;
 532                 goto end;
 533         }
 534
 535         ret = bt_field_unsigned_integer_set_value(field, ts);
 536         if (ret) {
 537                 BT_LOGW("Cannot set packet context field's `%s` integer field's value: "
 538                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 539                         field_name, stream, bt_stream_get_name(stream),
 540                         field, stream->discarded_events);
 541         } else {
 542                 BT_LOGV("Set packet context field's `%s` field's value: "
 543                         "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
 544                         field_name, stream, bt_stream_get_name(stream),
 545                         field, stream->discarded_events);
 546         }
 547
 548 end:
 549         bt_put(field);
 550         bt_put(field_mapped_clock_class);
 551         return ret;
 552 }
 553
 554 static
 555 int set_packet_context_timestamp_begin(struct bt_stream *stream)
 556 {
 557         int ret = 0;
 558
 559         if (stream->events->len == 0) {
 560                 BT_LOGV("Current packet contains no events: skipping: "
 561                         "stream-addr=%p, stream-name=\"%s\"",
 562                         stream, bt_stream_get_name(stream));
 563                 goto end;
 564         }
 565
 566         ret = set_packet_context_timestamp_field(stream, "timestamp_begin",
 567                 g_ptr_array_index(stream->events, 0));
 568
 569 end:
 570         return ret;
 571 }
 572
 573 static
 574 int set_packet_context_timestamp_end(struct bt_stream *stream)
 575 {
 576         int ret = 0;
 577
 578         if (stream->events->len == 0) {
 579                 BT_LOGV("Current packet contains no events: skipping: "
 580                         "stream-addr=%p, stream-name=\"%s\"",
 581                         stream, bt_stream_get_name(stream));
 582                 goto end;
 583         }
 584
 585         ret = set_packet_context_timestamp_field(stream, "timestamp_end",
 586                 g_ptr_array_index(stream->events, stream->events->len - 1));
 587
 588 end:
 589         return ret;
 590 }
 591
 592 static
 593 int auto_populate_packet_context(struct bt_stream *stream)
 594 {
 595         int ret = 0;
 596
 597         if (!stream->packet_context) {
 598                 goto end;
 599         }
 600
 601         ret = set_packet_context_packet_size(stream);
 602         if (ret) {
 603                 BT_LOGW("Cannot set packet context's packet size field: "
 604                         "stream-addr=%p, stream-name=\"%s\"",
 605                         stream, bt_stream_get_name(stream));
 606                 goto end;
 607         }
 608
 609         ret = set_packet_context_content_size(stream);
 610         if (ret) {
 611                 BT_LOGW("Cannot set packet context's content size field: "
 612                         "stream-addr=%p, stream-name=\"%s\"",
 613                         stream, bt_stream_get_name(stream));
 614                 goto end;
 615         }
 616
 617         ret = set_packet_context_timestamp_begin(stream);
 618         if (ret) {
 619                 BT_LOGW("Cannot set packet context's beginning timestamp field: "
 620                         "stream-addr=%p, stream-name=\"%s\"",
 621                         stream, bt_stream_get_name(stream));
 622                 goto end;
 623         }
 624
 625         ret = set_packet_context_timestamp_end(stream);
 626         if (ret) {
 627                 BT_LOGW("Cannot set packet context's end timestamp field: "
 628                         "stream-addr=%p, stream-name=\"%s\"",
 629                         stream, bt_stream_get_name(stream));
 630                 goto end;
 631         }
 632
 633         ret = set_packet_context_events_discarded(stream);
 634         if (ret) {
 635                 BT_LOGW("Cannot set packet context's discarded events count field: "
 636                         "stream-addr=%p, stream-name=\"%s\"",
 637                         stream, bt_stream_get_name(stream));
 638                 goto end;
 639         }
 640
 641         BT_LOGV("Automatically populated stream's packet context's known fields: "
 642                 "stream-addr=%p, stream-name=\"%s\"",
 643                 stream, bt_stream_get_name(stream));
 644
 645 end:
 646         return ret;
 647 }
 648
 649 static
 650 void release_event(struct bt_event *event)
 651 {
 652         if (bt_object_get_ref_count(event)) {
 653                 /*
 654                  * The event is being orphaned, but it must guarantee the
 655                  * existence of its event class for the duration of its
 656                  * lifetime.
 657                  */
 658                 bt_get(event->event_class);
 659                 BT_PUT(event->base.parent);
 660         } else {
 661                 bt_object_release(event);
 662         }
 663 }
 664
 665 static
 666 int create_stream_file(struct bt_ctf_writer *writer,
 667                 struct bt_stream *stream)
 668 {
 669         int fd;
 670         GString *filename = g_string_new(NULL);
 671         int64_t stream_class_id;
 672         char *file_path = NULL;
 673
 674         BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, "
 675                 "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"",
 676                 writer, stream, bt_stream_get_name(stream),
 677                 stream->stream_class, stream->stream_class->name->str);
 678
 679         if (stream->name && stream->name->len > 0) {
 680                 /* Use stream name's base name as prefix */
 681                 gchar *basename = g_path_get_basename(stream->name->str);
 682
 683                 assert(basename);
 684
 685                 if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) {
 686                         g_string_assign(filename, "stream");
 687                 } else {
 688                         g_string_assign(filename, basename);
 689                 }
 690
 691                 g_free(basename);
 692                 goto append_ids;
 693         }
 694
 695         if (stream->stream_class->name &&
 696                         stream->stream_class->name->len > 0) {
 697                 /* Use stream class name's base name as prefix */
 698                 gchar *basename =
 699                         g_path_get_basename(stream->stream_class->name->str);
 700
 701                 assert(basename);
 702
 703                 if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) {
 704                         g_string_assign(filename, "stream");
 705                 } else {
 706                         g_string_assign(filename, basename);
 707                 }
 708
 709                 g_free(basename);
 710                 goto append_ids;
 711         }
 712
 713         /* Default to using `stream-` as prefix */
 714         g_string_assign(filename, "stream");
 715
 716 append_ids:
 717         stream_class_id = bt_stream_class_get_id(stream->stream_class);
 718         assert(stream_class_id >= 0);
 719         assert(stream->id >= 0);
 720         g_string_append_printf(filename, "-%" PRId64 "-%" PRId64,
 721                 stream_class_id, stream->id);
 722
 723         file_path = g_build_filename(writer->path->str, filename->str, NULL);
 724         if (file_path == NULL) {
 725                 fd = -1;
 726                 goto end;
 727         }
 728
 729         fd = open(file_path,
 730                 O_RDWR | O_CREAT | O_TRUNC,
 731                 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
 732         g_free(file_path);
 733         if (fd < 0) {
 734                 BT_LOGW_ERRNO("Failed to open stream file for writing",
 735                         ": file_path=\"%s\", filename=\"%s\", ret=%d",
 736                         file_path, filename->str, fd);
 737                 goto end;
 738         }
 739
 740         BT_LOGD("Created stream file for writing: "
 741                 "stream-addr=%p, stream-name=\"%s\", "
 742                 "filename=\"%s\", fd=%d", stream, bt_stream_get_name(stream),
 743                 filename->str, fd);
 744
 745 end:
 746         g_string_free(filename, TRUE);
 747         return fd;
 748 }
 749
 750 static
 751 void set_stream_fd(struct bt_stream *stream, int fd)
 752 {
 753         (void) bt_stream_pos_init(&stream->pos, fd, O_RDWR);
 754         stream->pos.fd = fd;
 755 }
 756
 757 static
 758 void component_destroy_listener(struct bt_component *component, void *data)
 759 {
 760         struct bt_stream *stream = data;
 761
 762         BT_LOGD("Component is being destroyed, stream is notified: "
 763                 "comp-addr=%p, stream-addr=%p", component, stream);
 764         g_hash_table_remove(stream->comp_cur_port, component);
 765 }
 766
 767 static
 768 struct bt_stream *bt_stream_create_with_id_no_check(
 769                 struct bt_stream_class *stream_class,
 770                 const char *name, uint64_t id)
 771 {
 772         int ret;
 773         struct bt_stream *stream = NULL;
 774         struct bt_trace *trace = NULL;
 775         struct bt_ctf_writer *writer = NULL;
 776
 777         if (!stream_class) {
 778                 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
 779                 goto error;
 780         }
 781
 782         BT_LOGD("Creating stream object: stream-class-addr=%p, "
 783                 "stream-class-name=\"%s\", stream-name=\"%s\", "
 784                 "stream-id=%" PRIu64,
 785                 stream_class, bt_stream_class_get_name(stream_class),
 786                 name, id);
 787         trace = bt_stream_class_borrow_trace(stream_class);
 788         if (!trace) {
 789                 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
 790                         "stream-class-addr=%p, stream-class-name=\"%s\", "
 791                         "stream-name=\"%s\"",
 792                         stream_class, bt_stream_class_get_name(stream_class),
 793                         name);
 794                 goto error;
 795         }
 796
 797         if (bt_trace_is_static(trace)) {
 798                 /*
 799                  * A static trace has the property that all its stream
 800                  * classes, clock classes, and streams are definitive:
 801                  * no more can be added, and each object is also frozen.
 802                  */
 803                 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: "
 804                         "stream-class-addr=%p, stream-class-name=\"%s\", "
 805                         "stream-name=\"%s\", trace-addr=%p",
 806                         stream_class, bt_stream_class_get_name(stream_class),
 807                         name, trace);
 808                 goto error;
 809         }
 810
 811         if (id != -1ULL) {
 812                 /*
 813                  * Validate that the given ID is unique amongst all the
 814                  * existing trace's streams created from the same stream
 815                  * class.
 816                  */
 817                 size_t i;
 818
 819                 for (i = 0; i < trace->streams->len; i++) {
 820                         struct bt_stream *trace_stream =
 821                                 g_ptr_array_index(trace->streams, i);
 822
 823                         if (trace_stream->stream_class != stream_class) {
 824                                 continue;
 825                         }
 826
 827                         if (trace_stream->id == id) {
 828                                 BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID.");
 829                                 goto error;
 830                         }
 831                 }
 832         }
 833
 834         stream = g_new0(struct bt_stream, 1);
 835         if (!stream) {
 836                 BT_LOGE_STR("Failed to allocate one stream.");
 837                 goto error;
 838         }
 839
 840         bt_object_init(stream, bt_stream_destroy);
 841         /*
 842          * Acquire reference to parent since stream will become publicly
 843          * reachable; it needs its parent to remain valid.
 844          */
 845         bt_object_set_parent(stream, trace);
 846         stream->stream_class = stream_class;
 847         stream->pos.fd = -1;
 848         stream->id = (int64_t) id;
 849
 850         stream->destroy_listeners = g_array_new(FALSE, TRUE,
 851                 sizeof(struct bt_stream_destroy_listener));
 852         if (!stream->destroy_listeners) {
 853                 BT_LOGE_STR("Failed to allocate a GArray.");
 854                 goto error;
 855         }
 856
 857         if (name) {
 858                 stream->name = g_string_new(name);
 859                 if (!stream->name) {
 860                         BT_LOGE_STR("Failed to allocate a GString.");
 861                         goto error;
 862                 }
 863         }
 864
 865         BT_LOGD("Set stream's trace parent: trace-addr=%p", trace);
 866
 867         if (trace->is_created_by_writer) {
 868                 int fd;
 869                 writer = (struct bt_ctf_writer *) bt_object_get_parent(trace);
 870                 stream->id = (int64_t) stream_class->next_stream_id++;
 871
 872                 BT_LOGD("Stream object belongs to a writer's trace: "
 873                         "writer-addr=%p", writer);
 874                 assert(writer);
 875
 876                 if (stream_class->packet_context_type) {
 877                         BT_LOGD("Creating stream's packet context field: "
 878                                 "ft-addr=%p", stream_class->packet_context_type);
 879                         stream->packet_context = bt_field_create(
 880                                 stream_class->packet_context_type);
 881                         if (!stream->packet_context) {
 882                                 BT_LOGW_STR("Cannot create stream's packet context field.");
 883                                 goto error;
 884                         }
 885
 886                         /* Initialize events_discarded */
 887                         ret = try_set_structure_field_integer(
 888                                 stream->packet_context, "events_discarded", 0);
 889                         if (ret < 0) {
 890                                 BT_LOGW("Cannot set `events_discarded` field in packet context: "
 891                                         "ret=%d, packet-context-field-addr=%p",
 892                                         ret, stream->packet_context);
 893                                 goto error;
 894                         }
 895                 }
 896
 897                 stream->events = g_ptr_array_new_with_free_func(
 898                         (GDestroyNotify) release_event);
 899                 if (!stream->events) {
 900                         BT_LOGE_STR("Failed to allocate a GPtrArray.");
 901                         goto error;
 902                 }
 903
 904                 if (trace->packet_header_type) {
 905                         BT_LOGD("Creating stream's packet header field: "
 906                                 "ft-addr=%p", trace->packet_header_type);
 907                         stream->packet_header =
 908                                 bt_field_create(trace->packet_header_type);
 909                         if (!stream->packet_header) {
 910                                 BT_LOGW_STR("Cannot create stream's packet header field.");
 911                                 goto error;
 912                         }
 913                 }
 914
 915                 /*
 916                  * Attempt to populate the default trace packet header fields
 917                  * (magic, uuid and stream_id). This will _not_ fail shall the
 918                  * fields not be found or be of an incompatible type; they will
 919                  * simply not be populated automatically. The user will have to
 920                  * make sure to set the trace packet header fields himself
 921                  * before flushing.
 922                  */
 923                 ret = auto_populate_packet_header(stream);
 924                 if (ret) {
 925                         BT_LOGW_STR("Cannot automatically populate the stream's packet header.");
 926                         goto error;
 927                 }
 928
 929                 /* Create file associated with this stream */
 930                 fd = create_stream_file(writer, stream);
 931                 if (fd < 0) {
 932                         BT_LOGW_STR("Cannot create stream file.");
 933                         goto error;
 934                 }
 935
 936                 set_stream_fd(stream, fd);
 937
 938                 /* Freeze the writer */
 939                 BT_LOGD_STR("Freezing stream's CTF writer.");
 940                 bt_ctf_writer_freeze(writer);
 941         } else {
 942                 /* Non-writer stream indicated by a negative FD */
 943                 set_stream_fd(stream, -1);
 944                 stream->comp_cur_port = g_hash_table_new(g_direct_hash,
 945                         g_direct_equal);
 946                 if (!stream->comp_cur_port) {
 947                         BT_LOGE_STR("Failed to allocate a GHashTable.");
 948                         goto error;
 949                 }
 950         }
 951
 952         /* Add this stream to the trace's streams */
 953         g_ptr_array_add(trace->streams, stream);
 954         BT_LOGD("Created stream object: addr=%p", stream);
 955         goto end;
 956
 957 error:
 958         BT_PUT(stream);
 959
 960 end:
 961         bt_put(writer);
 962         return stream;
 963 }
 964
 965 struct bt_stream *bt_stream_create_with_id(
 966                 struct bt_stream_class *stream_class,
 967                 const char *name, uint64_t id_param)
 968 {
 969         struct bt_trace *trace;
 970         struct bt_stream *stream = NULL;
 971         int64_t id = (int64_t) id_param;
 972
 973         if (!stream_class) {
 974                 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
 975                 goto end;
 976         }
 977
 978         if (id < 0) {
 979                 BT_LOGW("Invalid parameter: invalid stream's ID: "
 980                         "name=\"%s\", id=%" PRIu64,
 981                         name, id_param);
 982                 goto end;
 983         }
 984
 985         trace = bt_stream_class_borrow_trace(stream_class);
 986         if (!trace) {
 987                 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
 988                         "stream-class-addr=%p, stream-class-name=\"%s\", "
 989                         "stream-name=\"%s\", stream-id=%" PRIu64,
 990                         stream_class, bt_stream_class_get_name(stream_class),
 991                         name, id_param);
 992                 goto end;
 993         }
 994
 995         if (trace->is_created_by_writer) {
 996                 BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_stream_create(): "
 997                         "stream-class-addr=%p, stream-class-name=\"%s\", "
 998                         "stream-name=\"%s\", stream-id=%" PRIu64,
 999                         stream_class, bt_stream_class_get_name(stream_class),
1000                         name, id_param);
1001                 goto end;
1002         }
1003
1004         stream = bt_stream_create_with_id_no_check(stream_class,
1005                 name, id_param);
1006
1007 end:
1008         return stream;
1009 }
1010
1011 struct bt_stream *bt_stream_create(
1012                 struct bt_stream_class *stream_class,
1013                 const char *name)
1014 {
1015         return bt_stream_create_with_id_no_check(stream_class,
1016                 name, -1ULL);
1017 }
1018
1019 struct bt_stream_class *bt_stream_get_class(
1020                 struct bt_stream *stream)
1021 {
1022         struct bt_stream_class *stream_class = NULL;
1023
1024         if (!stream) {
1025                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1026                 goto end;
1027         }
1028
1029         stream_class = stream->stream_class;
1030         bt_get(stream_class);
1031 end:
1032         return stream_class;
1033 }
1034
1035 int bt_stream_get_discarded_events_count(
1036                 struct bt_stream *stream, uint64_t *count)
1037 {
1038         int ret = 0;
1039
1040         if (!stream) {
1041                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1042                 ret = -1;
1043                 goto end;
1044         }
1045
1046         if (!count) {
1047                 BT_LOGW_STR("Invalid parameter: count is NULL.");
1048                 ret = -1;
1049                 goto end;
1050         }
1051
1052         if (stream->pos.fd < 0) {
1053                 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1054                         "stream-addr=%p, stream-name=\"%s\"",
1055                         stream, bt_stream_get_name(stream));
1056                 ret = -1;
1057                 goto end;
1058         }
1059
1060         *count = (uint64_t) stream->discarded_events;
1061
1062 end:
1063         return ret;
1064 }
1065
1066 static
1067 int set_packet_context_events_discarded_field(struct bt_stream *stream,
1068         uint64_t count)
1069 {
1070         int ret = 0;
1071         struct bt_field *events_discarded_field = NULL;
1072
1073         if (!stream->packet_context) {
1074                 goto end;
1075         }
1076
1077         events_discarded_field = bt_field_structure_get_field_by_name(
1078                 stream->packet_context, "events_discarded");
1079         if (!events_discarded_field) {
1080                 goto end;
1081         }
1082
1083         ret = bt_field_unsigned_integer_set_value(
1084                 events_discarded_field, count);
1085         if (ret) {
1086                 BT_LOGW("Cannot set packet context's `events_discarded` field: "
1087                         "field-addr=%p, value=%" PRIu64,
1088                         events_discarded_field, count);
1089                 goto end;
1090         }
1091
1092 end:
1093         bt_put(events_discarded_field);
1094         return ret;
1095 }
1096
1097 void bt_stream_append_discarded_events(struct bt_stream *stream,
1098                 uint64_t event_count)
1099 {
1100         int ret;
1101         uint64_t new_count;
1102         struct bt_field *events_discarded_field = NULL;
1103
1104         if (!stream) {
1105                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1106                 goto end;
1107         }
1108
1109         BT_LOGV("Appending discarded events to stream: "
1110                 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64,
1111                 stream, bt_stream_get_name(stream), event_count);
1112
1113         if (!stream->packet_context) {
1114                 BT_LOGW_STR("Invalid parameter: stream has no packet context field.");
1115                 goto end;
1116         }
1117
1118         if (stream->pos.fd < 0) {
1119                 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1120                 goto end;
1121         }
1122
1123         events_discarded_field = bt_field_structure_get_field_by_name(
1124                 stream->packet_context, "events_discarded");
1125         if (!events_discarded_field) {
1126                 BT_LOGW_STR("No field named `events_discarded` in stream's packet context.");
1127                 goto end;
1128         }
1129
1130         new_count = stream->discarded_events + event_count;
1131         if (new_count < stream->discarded_events) {
1132                 BT_LOGW("New discarded events count is less than the stream's current discarded events count: "
1133                         "cur-count=%" PRIu64 ", new-count=%" PRIu64,
1134                         stream->discarded_events, new_count);
1135                 goto end;
1136         }
1137
1138         ret = set_packet_context_events_discarded_field(stream, new_count);
1139         if (ret) {
1140                 /* set_packet_context_events_discarded_field() logs errors */
1141                 goto end;
1142         }
1143
1144         stream->discarded_events = new_count;
1145         BT_LOGV("Appended discarded events to stream: "
1146                 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64,
1147                 stream, bt_stream_get_name(stream), event_count);
1148
1149 end:
1150         bt_put(events_discarded_field);
1151 }
1152
1153 static int auto_populate_event_header(struct bt_stream *stream,
1154                 struct bt_event *event)
1155 {
1156         int ret = 0;
1157         struct bt_field *id_field = NULL, *timestamp_field = NULL;
1158         struct bt_clock_class *mapped_clock_class = NULL;
1159         int64_t event_class_id;
1160
1161         assert(event);
1162
1163         if (!event->event_header) {
1164                 goto end;
1165         }
1166
1167         if (event->frozen) {
1168                 BT_LOGW_STR("Cannot populate event header field: event is frozen.");
1169                 ret = -1;
1170                 goto end;
1171         }
1172
1173         BT_LOGV("Automatically populating event's header field: "
1174                 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1175                 stream, bt_stream_get_name(stream), event);
1176
1177         id_field = bt_field_structure_get_field_by_name(event->event_header, "id");
1178         event_class_id = bt_event_class_get_id(event->event_class);
1179         if (event_class_id < 0) {
1180                 BT_LOGE("Event class ID cannot be found");
1181                 ret = -1;
1182                 goto end;
1183         }
1184         if (id_field && bt_field_type_is_integer(id_field->type)) {
1185                 ret = set_integer_field_value(id_field, event_class_id);
1186                 if (ret) {
1187                         BT_LOGW("Cannot set event header's `id` field's value: "
1188                                 "addr=%p, value=%" PRIu64, id_field,
1189                                 event_class_id);
1190                         goto end;
1191                 }
1192         }
1193
1194         /*
1195          * The conditions to automatically set the timestamp are:
1196          *
1197          * 1. The event header field "timestamp" exists and is an
1198          *    integer field.
1199          * 2. This stream's class has a registered clock (set with
1200          *    bt_stream_class_set_clock()).
1201          * 3. The event header field "timestamp" has its type mapped to
1202          *    a clock class which is also the clock class of this
1203          *    stream's class's registered clock.
1204          */
1205         timestamp_field = bt_field_structure_get_field_by_name(event->event_header,
1206                         "timestamp");
1207         if (timestamp_field && stream->stream_class->clock &&
1208                         bt_field_type_is_integer(timestamp_field->type)) {
1209                 struct bt_clock_class *stream_class_clock_class =
1210                         stream->stream_class->clock->clock_class;
1211
1212                 mapped_clock_class =
1213                         bt_field_type_integer_get_mapped_clock_class(
1214                                 timestamp_field->type);
1215                 if (mapped_clock_class == stream_class_clock_class) {
1216                         uint64_t timestamp;
1217
1218                         ret = bt_ctf_clock_get_value(
1219                                 stream->stream_class->clock,
1220                                 &timestamp);
1221                         assert(ret == 0);
1222                         ret = set_integer_field_value(timestamp_field,
1223                                         timestamp);
1224                         if (ret) {
1225                                 BT_LOGW("Cannot set event header's `timestamp` field's value: "
1226                                         "addr=%p, value=%" PRIu64,
1227                                         timestamp_field, timestamp);
1228                                 goto end;
1229                         }
1230                 }
1231         }
1232
1233         BT_LOGV("Automatically populated event's header field: "
1234                 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1235                 stream, bt_stream_get_name(stream), event);
1236
1237 end:
1238         bt_put(id_field);
1239         bt_put(timestamp_field);
1240         bt_put(mapped_clock_class);
1241         return ret;
1242 }
1243
1244 int bt_stream_append_event(struct bt_stream *stream,
1245                 struct bt_event *event)
1246 {
1247         int ret = 0;
1248
1249         if (!stream) {
1250                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1251                 ret = -1;
1252                 goto end;
1253         }
1254
1255         if (!event) {
1256                 BT_LOGW_STR("Invalid parameter: event is NULL.");
1257                 ret = -1;
1258                 goto end;
1259         }
1260
1261         if (stream->pos.fd < 0) {
1262                 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1263                 ret = -1;
1264                 goto end;
1265         }
1266
1267         BT_LOGV("Appending event to stream: "
1268                 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1269                 "event-class-name=\"%s\", event-class-id=%" PRId64,
1270                 stream, bt_stream_get_name(stream), event,
1271                 bt_event_class_get_name(bt_event_borrow_event_class(event)),
1272                 bt_event_class_get_id(bt_event_borrow_event_class(event)));
1273
1274         /*
1275          * The event is not supposed to have a parent stream at this
1276          * point. The only other way an event can have a parent stream
1277          * is if it was assigned when setting a packet to the event,
1278          * in which case the packet's stream is not a writer stream,
1279          * and thus the user is trying to append an event which belongs
1280          * to another stream.
1281          */
1282         if (event->base.parent) {
1283                 ret = -1;
1284                 goto end;
1285         }
1286
1287         bt_object_set_parent(event, stream);
1288         BT_LOGV_STR("Automatically populating the header of the event to append.");
1289         ret = auto_populate_event_header(stream, event);
1290         if (ret) {
1291                 /* auto_populate_event_header() reports errors */
1292                 goto error;
1293         }
1294
1295         /* Make sure the various scopes of the event are set */
1296         BT_LOGV_STR("Validating event to append.");
1297         ret = bt_event_validate(event);
1298         if (ret) {
1299                 goto error;
1300         }
1301
1302         /* Save the new event and freeze it */
1303         BT_LOGV_STR("Freezing the event to append.");
1304         bt_event_freeze(event);
1305         g_ptr_array_add(stream->events, event);
1306
1307         /*
1308          * Event had to hold a reference to its event class as long as it wasn't
1309          * part of the same trace hierarchy. From now on, the event and its
1310          * class share the same lifetime guarantees and the reference is no
1311          * longer needed.
1312          */
1313         BT_LOGV_STR("Putting the event's class.");
1314         bt_put(event->event_class);
1315         BT_LOGV("Appended event to stream: "
1316                 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1317                 "event-class-name=\"%s\", event-class-id=%" PRId64,
1318                 stream, bt_stream_get_name(stream), event,
1319                 bt_event_class_get_name(bt_event_borrow_event_class(event)),
1320                 bt_event_class_get_id(bt_event_borrow_event_class(event)));
1321
1322 end:
1323         return ret;
1324
1325 error:
1326         /*
1327          * Orphan the event; we were not successful in associating it to
1328          * a stream.
1329          */
1330         bt_object_set_parent(event, NULL);
1331
1332         return ret;
1333 }
1334
1335 struct bt_field *bt_stream_get_packet_context(struct bt_stream *stream)
1336 {
1337         struct bt_field *packet_context = NULL;
1338
1339         if (!stream) {
1340                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1341                 goto end;
1342         }
1343
1344         if (stream->pos.fd < 0) {
1345                 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1346                         "stream-addr=%p, stream-name=\"%s\"", stream,
1347                         bt_stream_get_name(stream));
1348                 goto end;
1349         }
1350
1351         packet_context = stream->packet_context;
1352         if (packet_context) {
1353                 bt_get(packet_context);
1354         }
1355 end:
1356         return packet_context;
1357 }
1358
1359 int bt_stream_set_packet_context(struct bt_stream *stream,
1360                 struct bt_field *field)
1361 {
1362         int ret = 0;
1363         struct bt_field_type *field_type;
1364
1365         if (!stream) {
1366                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1367                 ret = -1;
1368                 goto end;
1369         }
1370
1371         if (stream->pos.fd < 0) {
1372                 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1373                 ret = -1;
1374                 goto end;
1375         }
1376
1377         field_type = bt_field_get_type(field);
1378         if (bt_field_type_compare(field_type,
1379                         stream->stream_class->packet_context_type)) {
1380                 BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: "
1381                         "stream-addr=%p, stream-name=\"%s\", "
1382                         "packet-context-field-addr=%p, "
1383                         "packet-context-ft-addr=%p",
1384                         stream, bt_stream_get_name(stream),
1385                         field, field_type);
1386                 ret = -1;
1387                 goto end;
1388         }
1389
1390         bt_put(field_type);
1391         bt_put(stream->packet_context);
1392         stream->packet_context = bt_get(field);
1393         BT_LOGV("Set stream's packet context field: "
1394                 "stream-addr=%p, stream-name=\"%s\", "
1395                 "packet-context-field-addr=%p",
1396                 stream, bt_stream_get_name(stream), field);
1397 end:
1398         return ret;
1399 }
1400
1401 struct bt_field *bt_stream_get_packet_header(struct bt_stream *stream)
1402 {
1403         struct bt_field *packet_header = NULL;
1404
1405         if (!stream) {
1406                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1407                 goto end;
1408         }
1409
1410         if (stream->pos.fd < 0) {
1411                 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1412                         "stream-addr=%p, stream-name=\"%s\"", stream,
1413                         bt_stream_get_name(stream));
1414                 goto end;
1415         }
1416
1417         packet_header = stream->packet_header;
1418         if (packet_header) {
1419                 bt_get(packet_header);
1420         }
1421 end:
1422         return packet_header;
1423 }
1424
1425 int bt_stream_set_packet_header(struct bt_stream *stream,
1426                 struct bt_field *field)
1427 {
1428         int ret = 0;
1429         struct bt_trace *trace = NULL;
1430         struct bt_field_type *field_type = NULL;
1431
1432         if (!stream) {
1433                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1434                 ret = -1;
1435                 goto end;
1436         }
1437
1438         if (stream->pos.fd < 0) {
1439                 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1440                 ret = -1;
1441                 goto end;
1442         }
1443
1444         trace = (struct bt_trace *) bt_object_get_parent(stream);
1445
1446         if (!field) {
1447                 if (trace->packet_header_type) {
1448                         BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
1449                                 "stream-addr=%p, stream-name=\"%s\", "
1450                                 "packet-header-field-addr=%p, "
1451                                 "expected-ft-addr=%p",
1452                                 stream, bt_stream_get_name(stream),
1453                                 field, trace->packet_header_type);
1454                         ret = -1;
1455                         goto end;
1456                 }
1457
1458                 goto skip_validation;
1459         }
1460
1461         field_type = bt_field_get_type(field);
1462         assert(field_type);
1463
1464         if (bt_field_type_compare(field_type, trace->packet_header_type)) {
1465                 BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: "
1466                         "stream-addr=%p, stream-name=\"%s\", "
1467                         "packet-header-field-addr=%p, "
1468                         "packet-header-ft-addr=%p",
1469                         stream, bt_stream_get_name(stream),
1470                         field, field_type);
1471                 ret = -1;
1472                 goto end;
1473         }
1474
1475 skip_validation:
1476         bt_put(stream->packet_header);
1477         stream->packet_header = bt_get(field);
1478         BT_LOGV("Set stream's packet header field: "
1479                 "stream-addr=%p, stream-name=\"%s\", "
1480                 "packet-header-field-addr=%p",
1481                 stream, bt_stream_get_name(stream), field);
1482 end:
1483         BT_PUT(trace);
1484         bt_put(field_type);
1485         return ret;
1486 }
1487
1488 static
1489 void reset_structure_field(struct bt_field *structure, const char *name)
1490 {
1491         struct bt_field *member;
1492
1493         member = bt_field_structure_get_field_by_name(structure, name);
1494         if (member) {
1495                 (void) bt_field_reset(member);
1496                 bt_put(member);
1497         }
1498 }
1499
1500 int bt_stream_flush(struct bt_stream *stream)
1501 {
1502         int ret = 0;
1503         size_t i;
1504         struct bt_stream_pos packet_context_pos;
1505         struct bt_trace *trace;
1506         enum bt_byte_order native_byte_order;
1507         bool has_packet_size = false;
1508
1509         if (!stream) {
1510                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1511                 ret = -1;
1512                 goto end_no_stream;
1513         }
1514
1515         if (stream->pos.fd < 0) {
1516                 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1517                 ret = -1;
1518                 goto end;
1519         }
1520
1521         if (stream->packet_context) {
1522                 struct bt_field *packet_size_field;
1523
1524                 packet_size_field = bt_field_structure_get_field_by_name(
1525                                 stream->packet_context, "packet_size");
1526                 has_packet_size = (packet_size_field != NULL);
1527                 bt_put(packet_size_field);
1528         }
1529
1530         if (stream->flushed_packet_count == 1) {
1531                 if (!stream->packet_context) {
1532                         BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
1533                         ret = -1;
1534                         goto end;
1535                 }
1536
1537                 if (!has_packet_size) {
1538                         BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once.");
1539                         ret = -1;
1540                         goto end;
1541                 }
1542         }
1543
1544         BT_LOGV("Flushing stream's current packet: stream-addr=%p, "
1545                 "stream-name=\"%s\", packet-index=%u", stream,
1546                 bt_stream_get_name(stream), stream->flushed_packet_count);
1547         trace = bt_stream_class_borrow_trace(stream->stream_class);
1548         assert(trace);
1549         native_byte_order = bt_trace_get_native_byte_order(trace);
1550
1551         ret = auto_populate_packet_header(stream);
1552         if (ret) {
1553                 BT_LOGW_STR("Cannot automatically populate the stream's packet header field.");
1554                 ret = -1;
1555                 goto end;
1556         }
1557
1558         ret = auto_populate_packet_context(stream);
1559         if (ret) {
1560                 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1561                 ret = -1;
1562                 goto end;
1563         }
1564
1565         /* mmap the next packet */
1566         BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64,
1567                 stream->pos.offset);
1568         bt_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR);
1569         assert(stream->pos.packet_size % 8 == 0);
1570
1571         if (stream->packet_header) {
1572                 BT_LOGV_STR("Serializing packet header field.");
1573                 ret = bt_field_serialize(stream->packet_header, &stream->pos,
1574                         native_byte_order);
1575                 if (ret) {
1576                         BT_LOGW("Cannot serialize stream's packet header field: "
1577                                 "field-addr=%p", stream->packet_header);
1578                         goto end;
1579                 }
1580         }
1581
1582         if (stream->packet_context) {
1583                 /* Write packet context */
1584                 memcpy(&packet_context_pos, &stream->pos,
1585                         sizeof(packet_context_pos));
1586                 BT_LOGV_STR("Serializing packet context field.");
1587                 ret = bt_field_serialize(stream->packet_context,
1588                         &stream->pos, native_byte_order);
1589                 if (ret) {
1590                         BT_LOGW("Cannot serialize stream's packet context field: "
1591                                 "field-addr=%p", stream->packet_context);
1592                         goto end;
1593                 }
1594         }
1595
1596         BT_LOGV("Serializing events: count=%u", stream->events->len);
1597
1598         for (i = 0; i < stream->events->len; i++) {
1599                 struct bt_event *event = g_ptr_array_index(
1600                         stream->events, i);
1601                 struct bt_event_class *event_class =
1602                         bt_event_borrow_event_class(event);
1603
1604                 BT_LOGV("Serializing event: index=%zu, event-addr=%p, "
1605                         "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
1606                         "pos-offset=%" PRId64 ", packet-size=%" PRIu64,
1607                         i, event, bt_event_class_get_name(event_class),
1608                         bt_event_class_get_id(event_class),
1609                         stream->pos.offset, stream->pos.packet_size);
1610
1611                 /* Write event header */
1612                 if (event->event_header) {
1613                         BT_LOGV_STR("Serializing event's header field.");
1614                         ret = bt_field_serialize(event->event_header,
1615                                         &stream->pos, native_byte_order);
1616                         if (ret) {
1617                                 BT_LOGW("Cannot serialize event's header field: "
1618                                                 "field-addr=%p", event->event_header);
1619                                 goto end;
1620                         }
1621                 }
1622
1623                 /* Write stream event context */
1624                 if (event->stream_event_context) {
1625                         BT_LOGV_STR("Serializing event's stream event context field.");
1626                         ret = bt_field_serialize(
1627                                 event->stream_event_context, &stream->pos,
1628                                 native_byte_order);
1629                         if (ret) {
1630                                 BT_LOGW("Cannot serialize event's stream event context field: "
1631                                         "field-addr=%p", event->stream_event_context);
1632                                 goto end;
1633                         }
1634                 }
1635
1636                 /* Write event content */
1637                 ret = bt_event_serialize(event, &stream->pos,
1638                         native_byte_order);
1639                 if (ret) {
1640                         /* bt_event_serialize() logs errors */
1641                         goto end;
1642                 }
1643         }
1644
1645         if (!has_packet_size && stream->pos.offset % 8 != 0) {
1646                 BT_LOGW("Stream's packet context field type has no `packet_size` field, "
1647                         "but current content size is not a multiple of 8 bits: "
1648                         "content-size=%" PRId64 ", "
1649                         "packet-size=%" PRIu64,
1650                         stream->pos.offset,
1651                         stream->pos.packet_size);
1652                 ret = -1;
1653                 goto end;
1654         }
1655
1656         assert(stream->pos.packet_size % 8 == 0);
1657
1658         /*
1659          * Remove extra padding bytes.
1660          */
1661         stream->pos.packet_size = (stream->pos.offset + 7) & ~7;
1662
1663         if (stream->packet_context) {
1664                 /*
1665                  * The whole packet is serialized at this point. Make sure that,
1666                  * if `packet_size` is missing, the current content size is
1667                  * equal to the current packet size.
1668                  */
1669                 struct bt_field *field = bt_field_structure_get_field_by_name(
1670                         stream->packet_context, "content_size");
1671
1672                 bt_put(field);
1673                 if (!field) {
1674                         if (stream->pos.offset != stream->pos.packet_size) {
1675                                 BT_LOGW("Stream's packet context's `content_size` field is missing, "
1676                                         "but current packet's content size is not equal to its packet size: "
1677                                         "content-size=%" PRId64 ", "
1678                                         "packet-size=%" PRIu64,
1679                                         stream->pos.offset,
1680                                         stream->pos.packet_size);
1681                                 ret = -1;
1682                                 goto end;
1683                         }
1684                 }
1685
1686                 /*
1687                  * Overwrite the packet context now that the stream
1688                  * position's packet and content sizes have the correct
1689                  * values.
1690                  *
1691                  * Copy base_mma as the packet may have been remapped
1692                  * (e.g. when a packet is resized).
1693                  */
1694                 packet_context_pos.base_mma = stream->pos.base_mma;
1695                 ret = auto_populate_packet_context(stream);
1696                 if (ret) {
1697                         BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1698                         ret = -1;
1699                         goto end;
1700                 }
1701
1702                 BT_LOGV("Rewriting (serializing) packet context field.");
1703                 ret = bt_field_serialize(stream->packet_context,
1704                         &packet_context_pos, native_byte_order);
1705                 if (ret) {
1706                         BT_LOGW("Cannot serialize stream's packet context field: "
1707                                 "field-addr=%p", stream->packet_context);
1708                         goto end;
1709                 }
1710         }
1711
1712         g_ptr_array_set_size(stream->events, 0);
1713         stream->flushed_packet_count++;
1714         stream->size += stream->pos.packet_size / CHAR_BIT;
1715
1716 end:
1717         /* Reset automatically-set fields. */
1718         if (stream->packet_context) {
1719                 reset_structure_field(stream->packet_context, "timestamp_begin");
1720                 reset_structure_field(stream->packet_context, "timestamp_end");
1721                 reset_structure_field(stream->packet_context, "packet_size");
1722                 reset_structure_field(stream->packet_context, "content_size");
1723                 reset_structure_field(stream->packet_context, "events_discarded");
1724         }
1725
1726         if (ret < 0) {
1727                 /*
1728                  * We failed to write the packet. Its size is therefore set to 0
1729                  * to ensure the next mapping is done in the same place rather
1730                  * than advancing by "stream->pos.packet_size", which would
1731                  * leave a corrupted packet in the trace.
1732                  */
1733                 stream->pos.packet_size = 0;
1734         } else {
1735                 BT_LOGV("Flushed stream's current packet: content-size=%" PRId64 ", "
1736                         "packet-size=%" PRIu64,
1737                         stream->pos.offset, stream->pos.packet_size);
1738         }
1739
1740 end_no_stream:
1741         return ret;
1742 }
1743
1744 /* Pre-2.0 CTF writer backward compatibility */
1745 void bt_ctf_stream_get(struct bt_stream *stream)
1746 {
1747         bt_get(stream);
1748 }
1749
1750 /* Pre-2.0 CTF writer backward compatibility */
1751 void bt_ctf_stream_put(struct bt_stream *stream)
1752 {
1753         bt_put(stream);
1754 }
1755
1756 static
1757 void bt_stream_destroy(struct bt_object *obj)
1758 {
1759         struct bt_stream *stream;
1760         int i;
1761
1762         stream = container_of(obj, struct bt_stream, base);
1763         BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"",
1764                 stream, bt_stream_get_name(stream));
1765
1766         /* Call destroy listeners in reverse registration order */
1767         for (i = stream->destroy_listeners->len - 1; i >= 0; i--) {
1768                 struct bt_stream_destroy_listener *listener =
1769                         &g_array_index(stream->destroy_listeners,
1770                                 struct bt_stream_destroy_listener, i);
1771
1772                 BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d",
1773                         listener->func, listener->data, i);
1774                 listener->func(stream, listener->data);
1775         }
1776
1777         (void) bt_stream_pos_fini(&stream->pos);
1778         if (stream->pos.fd >= 0) {
1779                 int ret;
1780
1781                 /*
1782                  * Truncate the file's size to the minimum required to fit the
1783                  * last packet as we might have grown it too much on the last
1784                  * mmap.
1785                  */
1786                 do {
1787                         ret = ftruncate(stream->pos.fd, stream->size);
1788                 } while (ret == -1 && errno == EINTR);
1789                 if (ret) {
1790                         BT_LOGE_ERRNO("Failed to truncate stream file",
1791                                 ": ret=%d, size=%" PRIu64,
1792                                 ret, (uint64_t) stream->size);
1793                 }
1794
1795                 if (close(stream->pos.fd)) {
1796                         BT_LOGE_ERRNO("Failed to close stream file",
1797                                 ": ret=%d", ret);
1798                 }
1799         }
1800
1801         if (stream->events) {
1802                 BT_LOGD_STR("Putting events.");
1803                 g_ptr_array_free(stream->events, TRUE);
1804         }
1805
1806         if (stream->name) {
1807                 g_string_free(stream->name, TRUE);
1808         }
1809
1810         if (stream->comp_cur_port) {
1811                 GHashTableIter ht_iter;
1812                 gpointer comp_gptr, port_gptr;
1813
1814                 /*
1815                  * Since we're destroying the stream, remove the destroy
1816                  * listeners that it registered for each component in
1817                  * its component-port mapping hash table. Otherwise they
1818                  * would be called and the stream would be accessed once
1819                  * it's freed or another stream would be accessed.
1820                  */
1821                 g_hash_table_iter_init(&ht_iter, stream->comp_cur_port);
1822
1823                 while (g_hash_table_iter_next(&ht_iter, &comp_gptr, &port_gptr)) {
1824                         assert(comp_gptr);
1825                         bt_component_remove_destroy_listener((void *) comp_gptr,
1826                                 component_destroy_listener, stream);
1827                 }
1828
1829                 g_hash_table_destroy(stream->comp_cur_port);
1830         }
1831
1832         if (stream->destroy_listeners) {
1833                 g_array_free(stream->destroy_listeners, TRUE);
1834         }
1835
1836         BT_LOGD_STR("Putting packet header field.");
1837         bt_put(stream->packet_header);
1838         BT_LOGD_STR("Putting packet context field.");
1839         bt_put(stream->packet_context);
1840         g_free(stream);
1841 }
1842
1843 static
1844 int _set_structure_field_integer(struct bt_field *structure, char *name,
1845                 uint64_t value, bt_bool force)
1846 {
1847         int ret = 0;
1848         struct bt_field_type *field_type = NULL;
1849         struct bt_field *integer;
1850
1851         assert(structure);
1852         assert(name);
1853
1854         integer = bt_field_structure_get_field_by_name(structure, name);
1855         if (!integer) {
1856                 /* Field not found, not an error. */
1857                 BT_LOGV("Field not found: struct-field-addr=%p, "
1858                         "name=\"%s\", force=%d", structure, name, force);
1859                 goto end;
1860         }
1861
1862         /* Make sure the payload has not already been set. */
1863         if (!force && bt_field_is_set(integer)) {
1864                 /* Payload already set, not an error */
1865                 BT_LOGV("Field's payload is already set: struct-field-addr=%p, "
1866                         "name=\"%s\", force=%d", structure, name, force);
1867                 goto end;
1868         }
1869
1870         field_type = bt_field_get_type(integer);
1871         assert(field_type);
1872         if (bt_field_type_get_type_id(field_type) != BT_FIELD_TYPE_ID_INTEGER) {
1873                 /*
1874                  * The user most likely meant for us to populate this field
1875                  * automatically. However, we can only do this if the field
1876                  * is an integer. Return an error.
1877                  */
1878                 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
1879                         "field-addr=%p, ft-addr=%p, ft-id=%s",
1880                         integer, field_type,
1881                         bt_field_type_id_string(field_type->id));
1882                 ret = -1;
1883                 goto end;
1884         }
1885
1886         if (bt_field_type_integer_is_signed(field_type)) {
1887                 ret = bt_field_signed_integer_set_value(integer,
1888                         (int64_t) value);
1889         } else {
1890                 ret = bt_field_unsigned_integer_set_value(integer, value);
1891         }
1892         ret = !ret ? 1 : ret;
1893 end:
1894         bt_put(integer);
1895         bt_put(field_type);
1896         return ret;
1897 }
1898
1899 /*
1900  * Returns the following codes:
1901  * 1 if the field was found and set,
1902  * 0 if nothing was done (field not found, or was already set),
1903  * <0 if an error was encoutered
1904  */
1905 static
1906 int try_set_structure_field_integer(struct bt_field *structure, char *name,
1907                 uint64_t value)
1908 {
1909         return _set_structure_field_integer(structure, name, value, BT_FALSE);
1910 }
1911
1912 const char *bt_stream_get_name(struct bt_stream *stream)
1913 {
1914         const char *name = NULL;
1915
1916         if (!stream) {
1917                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1918                 goto end;
1919         }
1920
1921         name = stream->name ? stream->name->str : NULL;
1922
1923 end:
1924         return name;
1925 }
1926
1927 int bt_stream_is_writer(struct bt_stream *stream)
1928 {
1929         int ret = -1;
1930
1931         if (!stream) {
1932                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1933                 goto end;
1934         }
1935
1936         ret = (stream->pos.fd >= 0);
1937
1938 end:
1939         return ret;
1940 }
1941
1942 BT_HIDDEN
1943 void bt_stream_map_component_to_port(struct bt_stream *stream,
1944                 struct bt_component *comp,
1945                 struct bt_port *port)
1946 {
1947         assert(stream);
1948         assert(comp);
1949         assert(port);
1950         assert(stream->comp_cur_port);
1951
1952         /*
1953          * Do not take a reference to the component here because we
1954          * don't want the component to exist as long as this stream
1955          * exists. Instead, keep a weak reference, but add a destroy
1956          * listener so that we remove this hash table entry when we know
1957          * the component is destroyed.
1958          */
1959         BT_LOGV("Adding component's destroy listener for stream: "
1960                 "stream-addr=%p, stream-name=\"%s\", comp-addr=%p, "
1961                 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1962                 stream, bt_stream_get_name(stream),
1963                 comp, bt_component_get_name(comp), port,
1964                 bt_port_get_name(port));
1965         bt_component_add_destroy_listener(comp, component_destroy_listener,
1966                 stream);
1967         g_hash_table_insert(stream->comp_cur_port, comp, port);
1968         BT_LOGV_STR("Mapped component to port for stream.");
1969 }
1970
1971 BT_HIDDEN
1972 struct bt_port *bt_stream_port_for_component(struct bt_stream *stream,
1973                 struct bt_component *comp)
1974 {
1975         assert(stream);
1976         assert(comp);
1977         assert(stream->comp_cur_port);
1978         return g_hash_table_lookup(stream->comp_cur_port, comp);
1979 }
1980
1981 BT_HIDDEN
1982 void bt_stream_add_destroy_listener(struct bt_stream *stream,
1983                 bt_stream_destroy_listener_func func, void *data)
1984 {
1985         struct bt_stream_destroy_listener listener;
1986
1987         assert(stream);
1988         assert(func);
1989         listener.func = func;
1990         listener.data = data;
1991         g_array_append_val(stream->destroy_listeners, listener);
1992         BT_LOGV("Added stream destroy listener: stream-addr=%p, "
1993                 "stream-name=\"%s\", func=%p, data=%p",
1994                 stream, bt_stream_get_name(stream), func, data);
1995 }
1996
1997 BT_HIDDEN
1998 void bt_stream_remove_destroy_listener(struct bt_stream *stream,
1999                 bt_stream_destroy_listener_func func, void *data)
2000 {
2001         size_t i;
2002
2003         assert(stream);
2004         assert(func);
2005
2006         for (i = 0; i < stream->destroy_listeners->len; i++) {
2007                 struct bt_stream_destroy_listener *listener =
2008                         &g_array_index(stream->destroy_listeners,
2009                                 struct bt_stream_destroy_listener, i);
2010
2011                 if (listener->func == func && listener->data == data) {
2012                         g_array_remove_index(stream->destroy_listeners, i);
2013                         i--;
2014                         BT_LOGV("Removed stream destroy listener: stream-addr=%p, "
2015                                 "stream-name=\"%s\", func=%p, data=%p",
2016                                 stream, bt_stream_get_name(stream),
2017                                 func, data);
2018                 }
2019         }
2020 }
2021
2022 int64_t bt_stream_get_id(struct bt_stream *stream)
2023 {
2024         int64_t ret;
2025
2026         if (!stream) {
2027                 BT_LOGW_STR("Invalid parameter: stream is NULL.");
2028                 ret = (int64_t) -1;
2029                 goto end;
2030         }
2031
2032         ret = stream->id;
2033         if (ret < 0) {
2034                 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
2035                         stream, bt_stream_get_name(stream));
2036         }
2037
2038 end:
2039         return ret;
2040 }