formats/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 #include <babeltrace/ctf-ir/clock.h>
  30 #include <babeltrace/ctf-ir/clock-internal.h>
  31 #include <babeltrace/ctf-writer/event.h>
  32 #include <babeltrace/ctf-ir/event-internal.h>
  33 #include <babeltrace/ctf-ir/event-types-internal.h>
  34 #include <babeltrace/ctf-ir/event-fields-internal.h>
  35 #include <babeltrace/ctf-ir/stream.h>
  36 #include <babeltrace/ctf-ir/stream-internal.h>
  37 #include <babeltrace/ctf-ir/stream-class-internal.h>
  38 #include <babeltrace/ref.h>
  39 #include <babeltrace/ctf-writer/functor-internal.h>
  40 #include <babeltrace/compiler.h>
  41 #include <babeltrace/align.h>
  42 #include <babeltrace/ctf/ctf-index.h>
  43
  44 static
  45 void bt_ctf_stream_destroy(struct bt_object *obj);
  46 static
  47 int set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);
  48
  49 static
  50 int set_packet_header_magic(struct bt_ctf_stream *stream)
  51 {
  52         int ret = 0;
  53         struct bt_ctf_field_type *magic_field_type = NULL;
  54         struct bt_ctf_field *magic_field = bt_ctf_field_structure_get_field(
  55                 stream->packet_header, "magic");
  56
  57         if (!magic_field) {
  58                 /* No magic field found. Not an error, skip. */
  59                 goto end;
  60         }
  61
  62         if (!bt_ctf_field_validate(magic_field)) {
  63                 /* Value already set. Not an error, skip. */
  64                 goto end;
  65         }
  66
  67         magic_field_type = bt_ctf_field_get_type(magic_field);
  68         assert(magic_field_type);
  69
  70         if (bt_ctf_field_type_get_type_id(magic_field_type) !=
  71                 CTF_TYPE_INTEGER) {
  72                 /* Magic field is not an integer. Not an error, skip. */
  73                 goto end;
  74         }
  75
  76         if (bt_ctf_field_type_integer_get_size(magic_field_type) != 32) {
  77                 /*
  78                  * Magic field is not of the expected size.
  79                  * Not an error, skip.
  80                  */
  81                 goto end;
  82         }
  83
  84         ret = bt_ctf_field_type_integer_get_signed(magic_field_type);
  85         assert(ret >= 0);
  86         if (ret) {
  87                 ret = bt_ctf_field_signed_integer_set_value(magic_field,
  88                         (int64_t) 0xC1FC1FC1);
  89         } else {
  90                 ret = bt_ctf_field_unsigned_integer_set_value(magic_field,
  91                         (uint64_t) 0xC1FC1FC1);
  92         }
  93 end:
  94         bt_put(magic_field);
  95         bt_put(magic_field_type);
  96         return ret;
  97 }
  98
  99 static
 100 int set_packet_header_uuid(struct bt_ctf_stream *stream)
 101 {
 102         int i, ret = 0;
 103         struct bt_ctf_trace *trace = NULL;
 104         struct bt_ctf_field_type *uuid_field_type = NULL;
 105         struct bt_ctf_field_type *element_field_type = NULL;
 106         struct bt_ctf_field *uuid_field = bt_ctf_field_structure_get_field(
 107                 stream->packet_header, "uuid");
 108
 109         if (!uuid_field) {
 110                 /* No uuid field found. Not an error, skip. */
 111                 goto end;
 112         }
 113
 114         if (!bt_ctf_field_validate(uuid_field)) {
 115                 /* Value already set. Not an error, skip. */
 116                 goto end;
 117         }
 118
 119         uuid_field_type = bt_ctf_field_get_type(uuid_field);
 120         assert(uuid_field_type);
 121         if (bt_ctf_field_type_get_type_id(uuid_field_type) !=
 122                 CTF_TYPE_ARRAY) {
 123                 /* UUID field is not an array. Not an error, skip. */
 124                 goto end;
 125         }
 126
 127         if (bt_ctf_field_type_array_get_length(uuid_field_type) != 16) {
 128                 /*
 129                  * UUID field is not of the expected size.
 130                  * Not an error, skip.
 131                  */
 132                 goto end;
 133         }
 134
 135         element_field_type = bt_ctf_field_type_array_get_element_type(
 136                 uuid_field_type);
 137         assert(element_field_type);
 138         if (bt_ctf_field_type_get_type_id(element_field_type) !=
 139                 CTF_TYPE_INTEGER) {
 140                 /* UUID array elements are not integers. Not an error, skip */
 141                 goto end;
 142         }
 143
 144         trace = (struct bt_ctf_trace *) bt_object_get_parent(stream);
 145         for (i = 0; i < 16; i++) {
 146                 struct bt_ctf_field *uuid_element =
 147                         bt_ctf_field_array_get_field(uuid_field, i);
 148
 149                 ret = bt_ctf_field_type_integer_get_signed(element_field_type);
 150                 assert(ret >= 0);
 151
 152                 if (ret) {
 153                         ret = bt_ctf_field_signed_integer_set_value(
 154                                 uuid_element, (int64_t) trace->uuid[i]);
 155                 } else {
 156                         ret = bt_ctf_field_unsigned_integer_set_value(
 157                                 uuid_element,
 158                                 (uint64_t) trace->uuid[i]);
 159                 }
 160                 bt_put(uuid_element);
 161                 if (ret) {
 162                         goto end;
 163                 }
 164         }
 165
 166 end:
 167         bt_put(uuid_field);
 168         bt_put(uuid_field_type);
 169         bt_put(element_field_type);
 170         BT_PUT(trace);
 171         return ret;
 172 }
 173 static
 174 int set_packet_header_stream_id(struct bt_ctf_stream *stream)
 175 {
 176         int ret = 0;
 177         uint32_t stream_id;
 178         struct bt_ctf_field_type *stream_id_field_type = NULL;
 179         struct bt_ctf_field *stream_id_field = bt_ctf_field_structure_get_field(
 180                 stream->packet_header, "stream_id");
 181
 182         if (!stream_id_field) {
 183                 /* No stream_id field found. Not an error, skip. */
 184                 goto end;
 185         }
 186
 187         if (!bt_ctf_field_validate(stream_id_field)) {
 188                 /* Value already set. Not an error, skip. */
 189                 goto end;
 190         }
 191
 192         stream_id_field_type = bt_ctf_field_get_type(stream_id_field);
 193         assert(stream_id_field_type);
 194         if (bt_ctf_field_type_get_type_id(stream_id_field_type) !=
 195                 CTF_TYPE_INTEGER) {
 196                 /* stream_id field is not an integer. Not an error, skip. */
 197                 goto end;
 198         }
 199
 200         stream_id = stream->stream_class->id;
 201         ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type);
 202         assert(ret >= 0);
 203         if (ret) {
 204                 ret = bt_ctf_field_signed_integer_set_value(stream_id_field,
 205                         (int64_t) stream_id);
 206         } else {
 207                 ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field,
 208                         (uint64_t) stream_id);
 209         }
 210 end:
 211         bt_put(stream_id_field);
 212         bt_put(stream_id_field_type);
 213         return ret;
 214 }
 215
 216 static
 217 int set_packet_header(struct bt_ctf_stream *stream)
 218 {
 219         int ret;
 220
 221         ret = set_packet_header_magic(stream);
 222         if (ret) {
 223                 goto end;
 224         }
 225
 226         ret = set_packet_header_uuid(stream);
 227         if (ret) {
 228                 goto end;
 229         }
 230
 231         ret = set_packet_header_stream_id(stream);
 232         if (ret) {
 233                 goto end;
 234         }
 235 end:
 236         return ret;
 237 }
 238
 239 static
 240 void release_event(struct bt_ctf_event *event)
 241 {
 242         if (bt_object_get_ref_count(event)) {
 243                 /*
 244                  * The event is being orphaned, but it must guarantee the
 245                  * existence of its event class for the duration of its
 246                  * lifetime.
 247                  */
 248                 bt_get(event->event_class);
 249                 BT_PUT(event->base.parent);
 250         } else {
 251                 bt_object_release(event);
 252         }
 253 }
 254
 255 BT_HIDDEN
 256 struct bt_ctf_stream *bt_ctf_stream_create(
 257         struct bt_ctf_stream_class *stream_class,
 258         struct bt_ctf_trace *trace)
 259 {
 260         int ret;
 261         struct bt_ctf_stream *stream = NULL;
 262
 263         if (!stream_class || !trace) {
 264                 goto end;
 265         }
 266
 267         stream = g_new0(struct bt_ctf_stream, 1);
 268         if (!stream) {
 269                 goto end;
 270         }
 271
 272         bt_object_init(stream, bt_ctf_stream_destroy);
 273         /*
 274          * Acquire reference to parent since stream will become publicly
 275          * reachable; it needs its parent to remain valid.
 276          */
 277         bt_object_set_parent(stream, trace);
 278         stream->packet_context = bt_ctf_field_create(
 279                 stream_class->packet_context_type);
 280         if (!stream->packet_context) {
 281                 goto error;
 282         }
 283
 284         /*
 285          * A stream class may not have a stream event context defined
 286          * in which case this stream will never have a stream_event_context
 287          * member since, after a stream's creation, the parent stream class
 288          * is "frozen" (immutable).
 289          */
 290         if (stream_class->event_context_type) {
 291                 stream->event_context = bt_ctf_field_create(
 292                         stream_class->event_context_type);
 293                 if (!stream->packet_context) {
 294                         goto error;
 295                 }
 296         }
 297
 298         /* Initialize events_discarded */
 299         ret = set_structure_field_integer(stream->packet_context,
 300                 "events_discarded", 0);
 301         if (ret) {
 302                 goto error;
 303         }
 304
 305         stream->pos.fd = -1;
 306         stream->id = stream_class->next_stream_id++;
 307         stream->stream_class = stream_class;
 308         stream->events = g_ptr_array_new_with_free_func(
 309                 (GDestroyNotify) release_event);
 310         if (!stream->events) {
 311                 goto error;
 312         }
 313         if (stream_class->event_context_type) {
 314                 stream->event_contexts = g_ptr_array_new_with_free_func(
 315                         (GDestroyNotify) bt_put);
 316                 if (!stream->event_contexts) {
 317                         goto error;
 318                 }
 319         }
 320
 321         /* A trace is not allowed to have a NULL packet header */
 322         assert(trace->packet_header_type);
 323         stream->packet_header = bt_ctf_field_create(trace->packet_header_type);
 324         if (!stream->packet_header) {
 325                 goto error;
 326         }
 327         /*
 328          * Attempt to populate the default trace packet header fields
 329          * (magic, uuid and stream_id). This will _not_ fail shall the
 330          * fields not be found or be of an incompatible type; they will
 331          * simply not be populated automatically. The user will have to
 332          * make sure to set the trace packet header fields himself before
 333          * flushing.
 334          */
 335         ret = set_packet_header(stream);
 336         if (ret) {
 337                 goto error;
 338         }
 339 end:
 340         return stream;
 341 error:
 342         BT_PUT(stream);
 343         bt_put(trace);
 344         return stream;
 345 }
 346
 347 BT_HIDDEN
 348 int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd)
 349 {
 350         int ret = 0;
 351
 352         if (stream->pos.fd != -1) {
 353                 ret = -1;
 354                 goto end;
 355         }
 356
 357         ctf_init_pos(&stream->pos, NULL, fd, O_RDWR);
 358         stream->pos.fd = fd;
 359 end:
 360         return ret;
 361 }
 362
 363 struct bt_ctf_stream_class *bt_ctf_stream_get_class(
 364                 struct bt_ctf_stream *stream)
 365 {
 366         struct bt_ctf_stream_class *stream_class = NULL;
 367
 368         if (!stream) {
 369                 goto end;
 370         }
 371
 372         stream_class = stream->stream_class;
 373         bt_get(stream_class);
 374 end:
 375         return stream_class;
 376 }
 377
 378 int bt_ctf_stream_get_discarded_events_count(
 379                 struct bt_ctf_stream *stream, uint64_t *count)
 380 {
 381         int64_t ret = 0;
 382         int field_signed;
 383         struct bt_ctf_field *events_discarded_field = NULL;
 384         struct bt_ctf_field_type *events_discarded_field_type = NULL;
 385
 386         if (!stream || !count || !stream->packet_context) {
 387                 ret = -1;
 388                 goto end;
 389         }
 390
 391         events_discarded_field = bt_ctf_field_structure_get_field(
 392                 stream->packet_context, "events_discarded");
 393         if (!events_discarded_field) {
 394                 ret = -1;
 395                 goto end;
 396         }
 397
 398         events_discarded_field_type = bt_ctf_field_get_type(
 399                 events_discarded_field);
 400         if (!events_discarded_field_type) {
 401                 ret = -1;
 402                 goto end;
 403         }
 404
 405         field_signed = bt_ctf_field_type_integer_get_signed(
 406                 events_discarded_field_type);
 407         if (field_signed < 0) {
 408                 ret = field_signed;
 409                 goto end;
 410         }
 411
 412         if (field_signed) {
 413                 int64_t signed_count;
 414
 415                 ret = bt_ctf_field_signed_integer_get_value(
 416                         events_discarded_field, &signed_count);
 417                 if (ret) {
 418                         goto end;
 419                 }
 420                 if (signed_count < 0) {
 421                         /* Invalid value */
 422                         ret = -1;
 423                         goto end;
 424                 }
 425                 *count = (uint64_t) signed_count;
 426         } else {
 427                 ret = bt_ctf_field_unsigned_integer_get_value(
 428                         events_discarded_field, count);
 429                 if (ret) {
 430                         goto end;
 431                 }
 432         }
 433 end:
 434         bt_put(events_discarded_field);
 435         bt_put(events_discarded_field_type);
 436         return ret;
 437 }
 438
 439 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
 440                 uint64_t event_count)
 441 {
 442         int ret;
 443         int field_signed;
 444         uint64_t previous_count;
 445         uint64_t new_count;
 446         struct bt_ctf_field *events_discarded_field = NULL;
 447         struct bt_ctf_field_type *events_discarded_field_type = NULL;
 448
 449         if (!stream || !stream->packet_context) {
 450                 goto end;
 451         }
 452
 453         ret = bt_ctf_stream_get_discarded_events_count(stream,
 454                 &previous_count);
 455         if (ret) {
 456                 goto end;
 457         }
 458
 459         events_discarded_field = bt_ctf_field_structure_get_field(
 460                 stream->packet_context, "events_discarded");
 461         if (!events_discarded_field) {
 462                 goto end;
 463         }
 464
 465         events_discarded_field_type = bt_ctf_field_get_type(
 466                 events_discarded_field);
 467         if (!events_discarded_field_type) {
 468                 goto end;
 469         }
 470
 471         field_signed = bt_ctf_field_type_integer_get_signed(
 472                 events_discarded_field_type);
 473         if (field_signed < 0) {
 474                 goto end;
 475         }
 476
 477         new_count = previous_count + event_count;
 478         if (field_signed) {
 479                 ret = bt_ctf_field_signed_integer_set_value(
 480                         events_discarded_field, (int64_t) new_count);
 481                 if (ret) {
 482                         goto end;
 483                 }
 484         } else {
 485                 ret = bt_ctf_field_unsigned_integer_set_value(
 486                         events_discarded_field, new_count);
 487                 if (ret) {
 488                         goto end;
 489                 }
 490         }
 491
 492 end:
 493         bt_put(events_discarded_field);
 494         bt_put(events_discarded_field_type);
 495 }
 496
 497 int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
 498                 struct bt_ctf_event *event)
 499 {
 500         int ret = 0;
 501         struct bt_ctf_field *event_context_copy = NULL;
 502
 503         if (!stream || !event) {
 504                 ret = -1;
 505                 goto end;
 506         }
 507
 508         bt_object_set_parent(event, stream);
 509         ret = bt_ctf_event_populate_event_header(event);
 510         if (ret) {
 511                 goto end;
 512         }
 513
 514         /* Make sure the event's payload is set */
 515         ret = bt_ctf_event_validate(event);
 516         if (ret) {
 517                 goto end;
 518         }
 519
 520         /* Sample the current stream event context by copying it */
 521         if (stream->event_context) {
 522                 /* Make sure the event context's payload is set */
 523                 ret = bt_ctf_field_validate(stream->event_context);
 524                 if (ret) {
 525                         goto end;
 526                 }
 527
 528                 event_context_copy = bt_ctf_field_copy(stream->event_context);
 529                 if (!event_context_copy) {
 530                         ret = -1;
 531                         goto end;
 532                 }
 533         }
 534
 535         /* Save the new event along with its associated stream event context */
 536         g_ptr_array_add(stream->events, event);
 537         if (event_context_copy) {
 538                 g_ptr_array_add(stream->event_contexts, event_context_copy);
 539         }
 540         /*
 541          * Event had to hold a reference to its event class as long as it wasn't
 542          * part of the same trace hierarchy. From now on, the event and its
 543          * class share the same lifetime guarantees and the reference is no
 544          * longer needed.
 545          */
 546         bt_put(event->event_class);
 547 end:
 548         if (ret) {
 549                 /*
 550                  * Orphan the event; we were not succesful in associating it to
 551                  * a stream.
 552                  */
 553                 bt_object_set_parent(event, NULL);
 554         }
 555         return ret;
 556 }
 557
 558 struct bt_ctf_field *bt_ctf_stream_get_packet_context(
 559                 struct bt_ctf_stream *stream)
 560 {
 561         struct bt_ctf_field *packet_context = NULL;
 562
 563         if (!stream) {
 564                 goto end;
 565         }
 566
 567         packet_context = stream->packet_context;
 568         if (packet_context) {
 569                 bt_get(packet_context);
 570         }
 571 end:
 572         return packet_context;
 573 }
 574
 575 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
 576                 struct bt_ctf_field *field)
 577 {
 578         int ret = 0;
 579         struct bt_ctf_field_type *field_type;
 580
 581         if (!stream || !field) {
 582                 ret = -1;
 583                 goto end;
 584         }
 585
 586         field_type = bt_ctf_field_get_type(field);
 587         if (field_type != stream->stream_class->packet_context_type) {
 588                 ret = -1;
 589                 goto end;
 590         }
 591
 592         bt_put(field_type);
 593         bt_get(field);
 594         bt_put(stream->packet_context);
 595         stream->packet_context = field;
 596 end:
 597         return ret;
 598 }
 599
 600 struct bt_ctf_field *bt_ctf_stream_get_event_context(
 601                 struct bt_ctf_stream *stream)
 602 {
 603         struct bt_ctf_field *event_context = NULL;
 604
 605         if (!stream) {
 606                 goto end;
 607         }
 608
 609         event_context = stream->event_context;
 610         if (event_context) {
 611                 bt_get(event_context);
 612         }
 613 end:
 614         return event_context;
 615 }
 616
 617 int bt_ctf_stream_set_event_context(struct bt_ctf_stream *stream,
 618                 struct bt_ctf_field *field)
 619 {
 620         int ret = 0;
 621         struct bt_ctf_field_type *field_type = NULL;
 622
 623         if (!stream || !field) {
 624                 ret = -1;
 625                 goto end;
 626         }
 627
 628         field_type = bt_ctf_field_get_type(field);
 629         if (field_type != stream->stream_class->event_context_type) {
 630                 ret = -1;
 631                 goto end;
 632         }
 633
 634         bt_get(field);
 635         bt_put(stream->event_context);
 636         stream->event_context = field;
 637 end:
 638         bt_put(field_type);
 639         return ret;
 640 }
 641
 642 struct bt_ctf_field *bt_ctf_stream_get_packet_header(
 643                 struct bt_ctf_stream *stream)
 644 {
 645         struct bt_ctf_field *packet_header = NULL;
 646
 647         if (!stream) {
 648                 goto end;
 649         }
 650
 651         packet_header = stream->packet_header;
 652         if (packet_header) {
 653                 bt_get(packet_header);
 654         }
 655 end:
 656         return packet_header;
 657 }
 658
 659 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
 660                 struct bt_ctf_field *field)
 661 {
 662         int ret = 0;
 663         struct bt_ctf_trace *trace = NULL;
 664         struct bt_ctf_field_type *field_type = NULL;
 665
 666         if (!stream || !field) {
 667                 ret = -1;
 668                 goto end;
 669         }
 670
 671         trace = (struct bt_ctf_trace *) bt_object_get_parent(stream);
 672         field_type = bt_ctf_field_get_type(field);
 673         if (field_type != trace->packet_header_type) {
 674                 ret = -1;
 675                 goto end;
 676         }
 677
 678         bt_get(field);
 679         bt_put(stream->packet_header);
 680         stream->packet_header = field;
 681 end:
 682         BT_PUT(trace);
 683         bt_put(field_type);
 684         return ret;
 685 }
 686
 687 static
 688 int get_event_header_timestamp(struct bt_ctf_field *event_header, uint64_t *timestamp)
 689 {
 690         int ret = 0;
 691         struct bt_ctf_field *timestamp_field = NULL;
 692         struct bt_ctf_field_type *timestamp_field_type = NULL;
 693
 694         timestamp_field = bt_ctf_field_structure_get_field(event_header,
 695                 "timestamp");
 696         if (!timestamp_field) {
 697                 ret = -1;
 698                 goto end;
 699         }
 700
 701         timestamp_field_type = bt_ctf_field_get_type(timestamp_field);
 702         assert(timestamp_field_type);
 703         if (bt_ctf_field_type_get_type_id(timestamp_field_type) !=
 704                 CTF_TYPE_INTEGER) {
 705                 ret = -1;
 706                 goto end;
 707         }
 708
 709         if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) {
 710                 int64_t val;
 711
 712                 ret = bt_ctf_field_signed_integer_get_value(timestamp_field,
 713                         &val);
 714                 if (ret) {
 715                         goto end;
 716                 }
 717                 *timestamp = (uint64_t) val;
 718         } else {
 719                 ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field,
 720                         timestamp);
 721                 if (ret) {
 722                         goto end;
 723                 }
 724         }
 725 end:
 726         bt_put(timestamp_field);
 727         bt_put(timestamp_field_type);
 728         return ret;
 729 }
 730
 731 int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
 732 {
 733         int ret = 0;
 734         size_t i;
 735         uint64_t timestamp_begin, timestamp_end, events_discarded;
 736         struct bt_ctf_field *integer = NULL;
 737         struct ctf_stream_pos packet_context_pos;
 738
 739         if (!stream || stream->pos.fd < 0) {
 740                 /*
 741                  * Stream does not have an associated fd. It is,
 742                  * therefore, not a stream being used to write events.
 743                  */
 744                 ret = -1;
 745                 goto end;
 746         }
 747
 748         if (!stream->events->len) {
 749                 goto end;
 750         }
 751
 752         ret = bt_ctf_field_validate(stream->packet_header);
 753         if (ret) {
 754                 goto end;
 755         }
 756
 757         /* mmap the next packet */
 758         ctf_packet_seek(&stream->pos.parent, 0, SEEK_CUR);
 759
 760         ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos);
 761         if (ret) {
 762                 goto end;
 763         }
 764
 765         /* Set the default context attributes if present and unset. */
 766         if (!get_event_header_timestamp(
 767                 ((struct bt_ctf_event *) g_ptr_array_index(
 768                 stream->events, 0))->event_header, &timestamp_begin)) {
 769                 ret = set_structure_field_integer(stream->packet_context,
 770                         "timestamp_begin", timestamp_begin);
 771                 if (ret) {
 772                         goto end;
 773                 }
 774         }
 775
 776         if (!get_event_header_timestamp(
 777                 ((struct bt_ctf_event *) g_ptr_array_index(
 778                 stream->events, stream->events->len - 1))->event_header,
 779                 &timestamp_end)) {
 780
 781                 ret = set_structure_field_integer(stream->packet_context,
 782                         "timestamp_end", timestamp_end);
 783                 if (ret) {
 784                         goto end;
 785                 }
 786         }
 787         ret = set_structure_field_integer(stream->packet_context,
 788                 "content_size", UINT64_MAX);
 789         if (ret) {
 790                 goto end;
 791         }
 792
 793         ret = set_structure_field_integer(stream->packet_context,
 794                 "packet_size", UINT64_MAX);
 795         if (ret) {
 796                 goto end;
 797         }
 798
 799         /* Write packet context */
 800         memcpy(&packet_context_pos, &stream->pos,
 801                sizeof(struct ctf_stream_pos));
 802         ret = bt_ctf_field_serialize(stream->packet_context,
 803                 &stream->pos);
 804         if (ret) {
 805                 goto end;
 806         }
 807
 808         ret = bt_ctf_stream_get_discarded_events_count(stream,
 809                 &events_discarded);
 810         if (ret) {
 811                 goto end;
 812         }
 813
 814         /* Unset the packet context's fields. */
 815         ret = bt_ctf_field_reset(stream->packet_context);
 816         if (ret) {
 817                 goto end;
 818         }
 819
 820         /* Set the previous number of discarded events. */
 821         ret = set_structure_field_integer(stream->packet_context,
 822                 "events_discarded", events_discarded);
 823         if (ret) {
 824                 goto end;
 825         }
 826
 827         for (i = 0; i < stream->events->len; i++) {
 828                 struct bt_ctf_event *event = g_ptr_array_index(
 829                         stream->events, i);
 830
 831                 ret = bt_ctf_field_reset(event->event_header);
 832                 if (ret) {
 833                         goto end;
 834                 }
 835
 836                 /* Write event header */
 837                 ret = bt_ctf_field_serialize(event->event_header,
 838                         &stream->pos);
 839                 if (ret) {
 840                         goto end;
 841                 }
 842
 843                 /* Write stream event context */
 844                 if (stream->event_contexts) {
 845                         ret = bt_ctf_field_serialize(
 846                                 g_ptr_array_index(stream->event_contexts, i),
 847                                 &stream->pos);
 848                         if (ret) {
 849                                 goto end;
 850                         }
 851                 }
 852
 853                 /* Write event content */
 854                 ret = bt_ctf_event_serialize(event, &stream->pos);
 855                 if (ret) {
 856                         goto end;
 857                 }
 858         }
 859
 860         /*
 861          * Update the packet total size and content size and overwrite the
 862          * packet context.
 863          * Copy base_mma as the packet may have been remapped (e.g. when a
 864          * packet is resized).
 865          */
 866         packet_context_pos.base_mma = stream->pos.base_mma;
 867         ret = set_structure_field_integer(stream->packet_context,
 868                 "content_size", stream->pos.offset);
 869         if (ret) {
 870                 goto end;
 871         }
 872
 873         ret = set_structure_field_integer(stream->packet_context,
 874                 "packet_size", stream->pos.packet_size);
 875         if (ret) {
 876                 goto end;
 877         }
 878
 879         ret = bt_ctf_field_serialize(stream->packet_context,
 880                 &packet_context_pos);
 881         if (ret) {
 882                 goto end;
 883         }
 884
 885         g_ptr_array_set_size(stream->events, 0);
 886         if (stream->event_contexts) {
 887                 g_ptr_array_set_size(stream->event_contexts, 0);
 888         }
 889         stream->flushed_packet_count++;
 890 end:
 891         bt_put(integer);
 892         return ret;
 893 }
 894
 895 void bt_ctf_stream_get(struct bt_ctf_stream *stream)
 896 {
 897         bt_get(stream);
 898 }
 899
 900 void bt_ctf_stream_put(struct bt_ctf_stream *stream)
 901 {
 902         bt_put(stream);
 903 }
 904
 905 static
 906 void bt_ctf_stream_destroy(struct bt_object *obj)
 907 {
 908         struct bt_ctf_stream *stream;
 909
 910         stream = container_of(obj, struct bt_ctf_stream, base);
 911         ctf_fini_pos(&stream->pos);
 912         if (stream->pos.fd >= 0 && close(stream->pos.fd)) {
 913                 perror("close");
 914         }
 915
 916         if (stream->events) {
 917                 g_ptr_array_free(stream->events, TRUE);
 918         }
 919         if (stream->event_contexts) {
 920                 g_ptr_array_free(stream->event_contexts, TRUE);
 921         }
 922         bt_put(stream->packet_header);
 923         bt_put(stream->packet_context);
 924         bt_put(stream->event_context);
 925         g_free(stream);
 926 }
 927
 928 static
 929 int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
 930                 uint64_t value)
 931 {
 932         int ret = 0;
 933         struct bt_ctf_field_type *field_type = NULL;
 934         struct bt_ctf_field *integer =
 935                 bt_ctf_field_structure_get_field(structure, name);
 936
 937         if (!structure || !name) {
 938                 ret = -1;
 939                 goto end;
 940         }
 941
 942         if (!integer) {
 943                 /* Field not found, not an error. */
 944                 goto end;
 945         }
 946
 947         /* Make sure the payload has not already been set. */
 948         if (!bt_ctf_field_validate(integer)) {
 949                 /* Payload already set, not an error */
 950                 goto end;
 951         }
 952
 953         field_type = bt_ctf_field_get_type(integer);
 954         /* Something is serioulsly wrong */
 955         assert(field_type);
 956         if (bt_ctf_field_type_get_type_id(field_type) != CTF_TYPE_INTEGER) {
 957                 /*
 958                  * The user most likely meant for us to populate this field
 959                  * automatically. However, we can only do this if the field
 960                  * is an integer. Return an error.
 961                  */
 962                 ret = -1;
 963                 goto end;
 964         }
 965
 966         if (bt_ctf_field_type_integer_get_signed(field_type)) {
 967                 ret = bt_ctf_field_signed_integer_set_value(integer,
 968                         (int64_t) value);
 969         } else {
 970                 ret = bt_ctf_field_unsigned_integer_set_value(integer, value);
 971         }
 972 end:
 973         bt_put(integer);
 974         bt_put(field_type);
 975         return ret;
 976 }