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