lib/ctf-ir/trace.c

   1 /*
   2  * trace.c
   3  *
   4  * Babeltrace CTF IR - Trace
   5  *
   6  * Copyright 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/trace-internal.h>
  30 #include <babeltrace/ctf-ir/clock-class-internal.h>
  31 #include <babeltrace/ctf-ir/stream-internal.h>
  32 #include <babeltrace/ctf-ir/stream-class-internal.h>
  33 #include <babeltrace/ctf-ir/event-internal.h>
  34 #include <babeltrace/ctf-ir/event-class.h>
  35 #include <babeltrace/ctf-ir/event-class-internal.h>
  36 #include <babeltrace/ctf-writer/functor-internal.h>
  37 #include <babeltrace/ctf-writer/clock-internal.h>
  38 #include <babeltrace/ctf-ir/field-types-internal.h>
  39 #include <babeltrace/ctf-ir/attributes-internal.h>
  40 #include <babeltrace/ctf-ir/validation-internal.h>
  41 #include <babeltrace/ctf-ir/visitor-internal.h>
  42 #include <babeltrace/ctf-ir/utils.h>
  43 #include <babeltrace/compiler-internal.h>
  44 #include <babeltrace/values.h>
  45 #include <babeltrace/ref.h>
  46 #include <babeltrace/endian-internal.h>
  47 #include <inttypes.h>
  48 #include <stdint.h>
  49
  50 #define DEFAULT_IDENTIFIER_SIZE 128
  51 #define DEFAULT_METADATA_STRING_SIZE 4096
  52
  53 struct listener_wrapper {
  54         bt_ctf_listener_cb listener;
  55         void *data;
  56 };
  57
  58 static
  59 void bt_ctf_trace_destroy(struct bt_object *obj);
  60 static
  61 int init_trace_packet_header(struct bt_ctf_trace *trace);
  62 static
  63 void bt_ctf_trace_freeze(struct bt_ctf_trace *trace);
  64
  65 static
  66 const unsigned int field_type_aliases_alignments[] = {
  67         [FIELD_TYPE_ALIAS_UINT5_T] = 1,
  68         [FIELD_TYPE_ALIAS_UINT8_T ... FIELD_TYPE_ALIAS_UINT16_T] = 8,
  69         [FIELD_TYPE_ALIAS_UINT27_T] = 1,
  70         [FIELD_TYPE_ALIAS_UINT32_T ... FIELD_TYPE_ALIAS_UINT64_T] = 8,
  71 };
  72
  73 static
  74 const unsigned int field_type_aliases_sizes[] = {
  75         [FIELD_TYPE_ALIAS_UINT5_T] = 5,
  76         [FIELD_TYPE_ALIAS_UINT8_T] = 8,
  77         [FIELD_TYPE_ALIAS_UINT16_T] = 16,
  78         [FIELD_TYPE_ALIAS_UINT27_T] = 27,
  79         [FIELD_TYPE_ALIAS_UINT32_T] = 32,
  80         [FIELD_TYPE_ALIAS_UINT64_T] = 64,
  81 };
  82
  83 struct bt_ctf_trace *bt_ctf_trace_create(void)
  84 {
  85         struct bt_ctf_trace *trace = NULL;
  86
  87         trace = g_new0(struct bt_ctf_trace, 1);
  88         if (!trace) {
  89                 goto error;
  90         }
  91
  92         trace->native_byte_order = BT_CTF_BYTE_ORDER_NATIVE;
  93         bt_object_init(trace, bt_ctf_trace_destroy);
  94         trace->clocks = g_ptr_array_new_with_free_func(
  95                 (GDestroyNotify) bt_put);
  96         trace->streams = g_ptr_array_new_with_free_func(
  97                 (GDestroyNotify) bt_object_release);
  98         trace->stream_classes = g_ptr_array_new_with_free_func(
  99                 (GDestroyNotify) bt_object_release);
 100         if (!trace->clocks || !trace->stream_classes || !trace->streams) {
 101                 goto error;
 102         }
 103
 104         /* Generate a trace UUID */
 105         uuid_generate(trace->uuid);
 106         if (init_trace_packet_header(trace)) {
 107                 goto error;
 108         }
 109
 110         /* Create the environment array object */
 111         trace->environment = bt_ctf_attributes_create();
 112         if (!trace->environment) {
 113                 goto error;
 114         }
 115
 116         trace->listeners = g_ptr_array_new_with_free_func(
 117                         (GDestroyNotify) g_free);
 118         if (!trace->listeners) {
 119                 goto error;
 120         }
 121
 122         return trace;
 123
 124 error:
 125         BT_PUT(trace);
 126         return trace;
 127 }
 128
 129 const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace)
 130 {
 131         const char *name = NULL;
 132
 133         if (!trace || !trace->name) {
 134                 goto end;
 135         }
 136
 137         name = trace->name->str;
 138 end:
 139         return name;
 140 }
 141
 142 int bt_ctf_trace_set_name(struct bt_ctf_trace *trace, const char *name)
 143 {
 144         int ret = 0;
 145
 146         if (!trace || !name || trace->frozen) {
 147                 ret = -1;
 148                 goto end;
 149         }
 150
 151         trace->name = trace->name ? g_string_assign(trace->name, name) :
 152                         g_string_new(name);
 153         if (!trace->name) {
 154                 ret = -1;
 155                 goto end;
 156         }
 157 end:
 158         return ret;
 159 }
 160
 161 void bt_ctf_trace_destroy(struct bt_object *obj)
 162 {
 163         struct bt_ctf_trace *trace;
 164
 165         trace = container_of(obj, struct bt_ctf_trace, base);
 166         if (trace->environment) {
 167                 bt_ctf_attributes_destroy(trace->environment);
 168         }
 169
 170         if (trace->name) {
 171                 g_string_free(trace->name, TRUE);
 172         }
 173
 174         if (trace->clocks) {
 175                 g_ptr_array_free(trace->clocks, TRUE);
 176         }
 177
 178         if (trace->streams) {
 179                 g_ptr_array_free(trace->streams, TRUE);
 180         }
 181
 182         if (trace->stream_classes) {
 183                 g_ptr_array_free(trace->stream_classes, TRUE);
 184         }
 185
 186         if (trace->listeners) {
 187                 g_ptr_array_free(trace->listeners, TRUE);
 188         }
 189
 190         bt_put(trace->packet_header_type);
 191         g_free(trace);
 192 }
 193
 194 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace *trace,
 195                 const char *name, struct bt_value *value)
 196 {
 197         int ret = 0;
 198
 199         if (!trace || !name || !value ||
 200                 bt_ctf_validate_identifier(name) ||
 201                 !(bt_value_is_integer(value) || bt_value_is_string(value))) {
 202                 ret = -1;
 203                 goto end;
 204         }
 205
 206         if (strchr(name, ' ')) {
 207                 ret = -1;
 208                 goto end;
 209         }
 210
 211         if (trace->frozen) {
 212                 /*
 213                  * New environment fields may be added to a frozen trace,
 214                  * but existing fields may not be changed.
 215                  *
 216                  * The object passed is frozen like all other attributes.
 217                  */
 218                 struct bt_value *attribute =
 219                         bt_ctf_attributes_get_field_value_by_name(
 220                                 trace->environment, name);
 221
 222                 if (attribute) {
 223                         BT_PUT(attribute);
 224                         ret = -1;
 225                         goto end;
 226                 }
 227
 228                 bt_value_freeze(value);
 229         }
 230
 231         ret = bt_ctf_attributes_set_field_value(trace->environment, name,
 232                 value);
 233
 234 end:
 235         return ret;
 236 }
 237
 238 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace *trace,
 239                 const char *name, const char *value)
 240 {
 241         int ret = 0;
 242         struct bt_value *env_value_string_obj = NULL;
 243
 244         if (!trace || !name || !value) {
 245                 ret = -1;
 246                 goto end;
 247         }
 248
 249         if (trace->frozen) {
 250                 /*
 251                  * New environment fields may be added to a frozen trace,
 252                  * but existing fields may not be changed.
 253                  */
 254                 struct bt_value *attribute =
 255                         bt_ctf_attributes_get_field_value_by_name(
 256                                 trace->environment, name);
 257
 258                 if (attribute) {
 259                         BT_PUT(attribute);
 260                         ret = -1;
 261                         goto end;
 262                 }
 263         }
 264
 265         env_value_string_obj = bt_value_string_create_init(value);
 266
 267         if (!env_value_string_obj) {
 268                 ret = -1;
 269                 goto end;
 270         }
 271
 272         if (trace->frozen) {
 273                 bt_value_freeze(env_value_string_obj);
 274         }
 275         ret = bt_ctf_trace_set_environment_field(trace, name,
 276                 env_value_string_obj);
 277
 278 end:
 279         BT_PUT(env_value_string_obj);
 280         return ret;
 281 }
 282
 283 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace *trace,
 284                 const char *name, int64_t value)
 285 {
 286         int ret = 0;
 287         struct bt_value *env_value_integer_obj = NULL;
 288
 289         if (!trace || !name) {
 290                 ret = -1;
 291                 goto end;
 292         }
 293
 294         if (trace->frozen) {
 295                 /*
 296                  * New environment fields may be added to a frozen trace,
 297                  * but existing fields may not be changed.
 298                  */
 299                 struct bt_value *attribute =
 300                         bt_ctf_attributes_get_field_value_by_name(
 301                                 trace->environment, name);
 302
 303                 if (attribute) {
 304                         BT_PUT(attribute);
 305                         ret = -1;
 306                         goto end;
 307                 }
 308         }
 309
 310         env_value_integer_obj = bt_value_integer_create_init(value);
 311         if (!env_value_integer_obj) {
 312                 ret = -1;
 313                 goto end;
 314         }
 315
 316         ret = bt_ctf_trace_set_environment_field(trace, name,
 317                 env_value_integer_obj);
 318         if (trace->frozen) {
 319                 bt_value_freeze(env_value_integer_obj);
 320         }
 321 end:
 322         BT_PUT(env_value_integer_obj);
 323         return ret;
 324 }
 325
 326 int64_t bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace *trace)
 327 {
 328         int64_t ret = 0;
 329
 330         if (!trace) {
 331                 ret = (int64_t) -1;
 332                 goto end;
 333         }
 334
 335         ret = bt_ctf_attributes_get_count(trace->environment);
 336
 337 end:
 338         return ret;
 339 }
 340
 341 const char *
 342 bt_ctf_trace_get_environment_field_name_by_index(struct bt_ctf_trace *trace,
 343                 uint64_t index)
 344 {
 345         const char *ret = NULL;
 346
 347         if (!trace) {
 348                 goto end;
 349         }
 350
 351         ret = bt_ctf_attributes_get_field_name(trace->environment, index);
 352
 353 end:
 354         return ret;
 355 }
 356
 357 struct bt_value *bt_ctf_trace_get_environment_field_value_by_index(
 358                 struct bt_ctf_trace *trace, uint64_t index)
 359 {
 360         struct bt_value *ret = NULL;
 361
 362         if (!trace) {
 363                 goto end;
 364         }
 365
 366         ret = bt_ctf_attributes_get_field_value(trace->environment, index);
 367
 368 end:
 369         return ret;
 370 }
 371
 372 struct bt_value *bt_ctf_trace_get_environment_field_value_by_name(
 373                 struct bt_ctf_trace *trace, const char *name)
 374 {
 375         struct bt_value *ret = NULL;
 376
 377         if (!trace || !name) {
 378                 goto end;
 379         }
 380
 381         ret = bt_ctf_attributes_get_field_value_by_name(trace->environment,
 382                 name);
 383
 384 end:
 385         return ret;
 386 }
 387
 388 int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace,
 389                 struct bt_ctf_clock_class *clock_class)
 390 {
 391         int ret = 0;
 392
 393         if (!trace || trace->is_static ||
 394                         !bt_ctf_clock_class_is_valid(clock_class)) {
 395                 ret = -1;
 396                 goto end;
 397         }
 398
 399         /* Check for duplicate clock classes */
 400         if (bt_ctf_trace_has_clock_class(trace, clock_class)) {
 401                 ret = -1;
 402                 goto end;
 403         }
 404
 405         bt_get(clock_class);
 406         g_ptr_array_add(trace->clocks, clock_class);
 407
 408         if (trace->frozen) {
 409                 bt_ctf_clock_class_freeze(clock_class);
 410         }
 411 end:
 412         return ret;
 413 }
 414
 415 int64_t bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *trace)
 416 {
 417         int64_t ret = (int64_t) -1;
 418
 419         if (!trace) {
 420                 goto end;
 421         }
 422
 423         ret = trace->clocks->len;
 424 end:
 425         return ret;
 426 }
 427
 428 struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_index(
 429                 struct bt_ctf_trace *trace, uint64_t index)
 430 {
 431         struct bt_ctf_clock_class *clock_class = NULL;
 432
 433         if (!trace || index >= trace->clocks->len) {
 434                 goto end;
 435         }
 436
 437         clock_class = g_ptr_array_index(trace->clocks, index);
 438         bt_get(clock_class);
 439 end:
 440         return clock_class;
 441 }
 442
 443 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace,
 444                 struct bt_ctf_stream_class *stream_class)
 445 {
 446         int ret;
 447         int64_t i;
 448         int64_t stream_id;
 449         struct bt_ctf_validation_output trace_sc_validation_output = { 0 };
 450         struct bt_ctf_validation_output *ec_validation_outputs = NULL;
 451         const enum bt_ctf_validation_flag trace_sc_validation_flags =
 452                 BT_CTF_VALIDATION_FLAG_TRACE |
 453                 BT_CTF_VALIDATION_FLAG_STREAM;
 454         const enum bt_ctf_validation_flag ec_validation_flags =
 455                 BT_CTF_VALIDATION_FLAG_EVENT;
 456         struct bt_ctf_field_type *packet_header_type = NULL;
 457         struct bt_ctf_field_type *packet_context_type = NULL;
 458         struct bt_ctf_field_type *event_header_type = NULL;
 459         struct bt_ctf_field_type *stream_event_ctx_type = NULL;
 460         int64_t event_class_count;
 461         struct bt_ctf_trace *current_parent_trace = NULL;
 462
 463         if (!trace || !stream_class || trace->is_static) {
 464                 ret = -1;
 465                 goto end;
 466         }
 467
 468         /*
 469          * At the end of this function we freeze the trace, so its
 470          * native byte order must NOT be BT_CTF_BYTE_ORDER_NATIVE.
 471          */
 472         if (trace->native_byte_order == BT_CTF_BYTE_ORDER_NATIVE) {
 473                 ret = -1;
 474                 goto end;
 475         }
 476
 477         current_parent_trace = bt_ctf_stream_class_get_trace(stream_class);
 478         if (current_parent_trace) {
 479                 /* Stream class is already associated to a trace, abort. */
 480                 ret = -1;
 481                 goto end;
 482         }
 483
 484         event_class_count =
 485                 bt_ctf_stream_class_get_event_class_count(stream_class);
 486         assert(event_class_count >= 0);
 487
 488         /* Check for duplicate stream classes */
 489         for (i = 0; i < trace->stream_classes->len; i++) {
 490                 if (trace->stream_classes->pdata[i] == stream_class) {
 491                         /* Stream class already registered to the trace */
 492                         ret = -1;
 493                         goto end;
 494                 }
 495         }
 496
 497         if (stream_class->clock) {
 498                 struct bt_ctf_clock_class *stream_clock_class =
 499                         stream_class->clock->clock_class;
 500
 501                 if (trace->is_created_by_writer) {
 502                         /*
 503                          * Make sure this clock was also added to the
 504                          * trace (potentially through its CTF writer
 505                          * owner).
 506                          */
 507                         size_t i;
 508
 509                         for (i = 0; i < trace->clocks->len; i++) {
 510                                 if (trace->clocks->pdata[i] ==
 511                                                 stream_clock_class) {
 512                                         /* Found! */
 513                                         break;
 514                                 }
 515                         }
 516
 517                         if (i == trace->clocks->len) {
 518                                 /* Not found */
 519                                 ret = -1;
 520                                 goto end;
 521                         }
 522                 } else {
 523                         /*
 524                          * This trace was NOT created by a CTF writer,
 525                          * thus do not allow the stream class to add to
 526                          * have a clock at all. Those are two
 527                          * independent APIs (non-writer and writer
 528                          * APIs), and isolating them simplifies things.
 529                          */
 530                         ret = -1;
 531                         goto end;
 532                 }
 533         }
 534
 535         /*
 536          * We're about to freeze both the trace and the stream class.
 537          * Also, each event class contained in this stream class are
 538          * already frozen.
 539          *
 540          * This trace, this stream class, and all its event classes
 541          * should be valid at this point.
 542          *
 543          * Validate trace and stream class first, then each event
 544          * class of this stream class can be validated individually.
 545          */
 546         packet_header_type =
 547                 bt_ctf_trace_get_packet_header_type(trace);
 548         packet_context_type =
 549                 bt_ctf_stream_class_get_packet_context_type(stream_class);
 550         event_header_type =
 551                 bt_ctf_stream_class_get_event_header_type(stream_class);
 552         stream_event_ctx_type =
 553                 bt_ctf_stream_class_get_event_context_type(stream_class);
 554         ret = bt_ctf_validate_class_types(trace->environment,
 555                 packet_header_type, packet_context_type, event_header_type,
 556                 stream_event_ctx_type, NULL, NULL, trace->valid,
 557                 stream_class->valid, 1, &trace_sc_validation_output,
 558                 trace_sc_validation_flags);
 559         BT_PUT(packet_header_type);
 560         BT_PUT(packet_context_type);
 561         BT_PUT(event_header_type);
 562         BT_PUT(stream_event_ctx_type);
 563
 564         if (ret) {
 565                 /*
 566                  * This means something went wrong during the validation
 567                  * process, not that the objects are invalid.
 568                  */
 569                 goto end;
 570         }
 571
 572         if ((trace_sc_validation_output.valid_flags &
 573                         trace_sc_validation_flags) !=
 574                         trace_sc_validation_flags) {
 575                 /* Invalid trace/stream class */
 576                 ret = -1;
 577                 goto end;
 578         }
 579
 580         if (event_class_count > 0) {
 581                 ec_validation_outputs = g_new0(struct bt_ctf_validation_output,
 582                         event_class_count);
 583                 if (!ec_validation_outputs) {
 584                         ret = -1;
 585                         goto end;
 586                 }
 587         }
 588
 589         /* Validate each event class individually */
 590         for (i = 0; i < event_class_count; i++) {
 591                 struct bt_ctf_event_class *event_class =
 592                         bt_ctf_stream_class_get_event_class_by_index(
 593                                 stream_class, i);
 594                 struct bt_ctf_field_type *event_context_type = NULL;
 595                 struct bt_ctf_field_type *event_payload_type = NULL;
 596
 597                 event_context_type =
 598                         bt_ctf_event_class_get_context_type(event_class);
 599                 event_payload_type =
 600                         bt_ctf_event_class_get_payload_type(event_class);
 601
 602                 /*
 603                  * It is important to use the field types returned by
 604                  * the previous trace and stream class validation here
 605                  * because copies could have been made.
 606                  */
 607                 ret = bt_ctf_validate_class_types(trace->environment,
 608                         trace_sc_validation_output.packet_header_type,
 609                         trace_sc_validation_output.packet_context_type,
 610                         trace_sc_validation_output.event_header_type,
 611                         trace_sc_validation_output.stream_event_ctx_type,
 612                         event_context_type, event_payload_type,
 613                         1, 1, event_class->valid, &ec_validation_outputs[i],
 614                         ec_validation_flags);
 615                 BT_PUT(event_context_type);
 616                 BT_PUT(event_payload_type);
 617                 BT_PUT(event_class);
 618
 619                 if (ret) {
 620                         goto end;
 621                 }
 622
 623                 if ((ec_validation_outputs[i].valid_flags &
 624                                 ec_validation_flags) != ec_validation_flags) {
 625                         /* Invalid event class */
 626                         ret = -1;
 627                         goto end;
 628                 }
 629         }
 630
 631         stream_id = bt_ctf_stream_class_get_id(stream_class);
 632         if (stream_id < 0) {
 633                 stream_id = trace->next_stream_id++;
 634                 if (stream_id < 0) {
 635                         ret = -1;
 636                         goto end;
 637                 }
 638
 639                 /* Try to assign a new stream id */
 640                 for (i = 0; i < trace->stream_classes->len; i++) {
 641                         if (stream_id == bt_ctf_stream_class_get_id(
 642                                 trace->stream_classes->pdata[i])) {
 643                                 /* Duplicate stream id found */
 644                                 ret = -1;
 645                                 goto end;
 646                         }
 647                 }
 648
 649                 if (bt_ctf_stream_class_set_id_no_check(stream_class,
 650                         stream_id)) {
 651                         /* TODO Should retry with a different stream id */
 652                         ret = -1;
 653                         goto end;
 654                 }
 655         }
 656
 657         bt_object_set_parent(stream_class, trace);
 658         g_ptr_array_add(trace->stream_classes, stream_class);
 659
 660         /*
 661          * At this point we know that the function will be successful.
 662          * Therefore we can replace the trace and stream class field
 663          * types with what's in their validation output structure and
 664          * mark them as valid. We can also replace the field types of
 665          * all the event classes of the stream class and mark them as
 666          * valid.
 667          */
 668         bt_ctf_validation_replace_types(trace, stream_class, NULL,
 669                 &trace_sc_validation_output, trace_sc_validation_flags);
 670         trace->valid = 1;
 671         stream_class->valid = 1;
 672
 673         /*
 674          * Put what was not moved in bt_ctf_validation_replace_types().
 675          */
 676         bt_ctf_validation_output_put_types(&trace_sc_validation_output);
 677
 678         for (i = 0; i < event_class_count; i++) {
 679                 struct bt_ctf_event_class *event_class =
 680                         bt_ctf_stream_class_get_event_class_by_index(
 681                                 stream_class, i);
 682
 683                 bt_ctf_validation_replace_types(NULL, NULL, event_class,
 684                         &ec_validation_outputs[i], ec_validation_flags);
 685                 event_class->valid = 1;
 686                 BT_PUT(event_class);
 687
 688                 /*
 689                  * Put what was not moved in
 690                  * bt_ctf_validation_replace_types().
 691                  */
 692                 bt_ctf_validation_output_put_types(&ec_validation_outputs[i]);
 693         }
 694
 695         /*
 696          * Freeze the trace and the stream class.
 697          */
 698         bt_ctf_stream_class_freeze(stream_class);
 699         bt_ctf_trace_freeze(trace);
 700
 701         /* Notifiy listeners of the trace's schema modification. */
 702         bt_ctf_stream_class_visit(stream_class,
 703                         bt_ctf_trace_object_modification, trace);
 704 end:
 705         if (ret) {
 706                 bt_object_set_parent(stream_class, NULL);
 707
 708                 if (ec_validation_outputs) {
 709                         for (i = 0; i < event_class_count; i++) {
 710                                 bt_ctf_validation_output_put_types(
 711                                         &ec_validation_outputs[i]);
 712                         }
 713                 }
 714         }
 715
 716         g_free(ec_validation_outputs);
 717         bt_ctf_validation_output_put_types(&trace_sc_validation_output);
 718         bt_put(current_parent_trace);
 719         assert(!packet_header_type);
 720         assert(!packet_context_type);
 721         assert(!event_header_type);
 722         assert(!stream_event_ctx_type);
 723
 724         return ret;
 725 }
 726
 727 int64_t bt_ctf_trace_get_stream_count(struct bt_ctf_trace *trace)
 728 {
 729         int64_t ret;
 730
 731         if (!trace) {
 732                 ret = (int64_t) -1;
 733                 goto end;
 734         }
 735
 736         ret = (int64_t) trace->streams->len;
 737
 738 end:
 739         return ret;
 740 }
 741
 742 struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index(
 743                 struct bt_ctf_trace *trace,
 744                 uint64_t index)
 745 {
 746         struct bt_ctf_stream *stream = NULL;
 747
 748         if (!trace || index >= trace->streams->len) {
 749                 goto end;
 750         }
 751
 752         stream = bt_get(g_ptr_array_index(trace->streams, index));
 753
 754 end:
 755         return stream;
 756 }
 757
 758 int64_t bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace *trace)
 759 {
 760         int64_t ret;
 761
 762         if (!trace) {
 763                 ret = (int64_t) -1;
 764                 goto end;
 765         }
 766
 767         ret = (int64_t) trace->stream_classes->len;
 768 end:
 769         return ret;
 770 }
 771
 772 struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_index(
 773                 struct bt_ctf_trace *trace, uint64_t index)
 774 {
 775         struct bt_ctf_stream_class *stream_class = NULL;
 776
 777         if (!trace || index >= trace->stream_classes->len) {
 778                 goto end;
 779         }
 780
 781         stream_class = g_ptr_array_index(trace->stream_classes, index);
 782         bt_get(stream_class);
 783 end:
 784         return stream_class;
 785 }
 786
 787 struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id(
 788                 struct bt_ctf_trace *trace, uint64_t id_param)
 789 {
 790         int i;
 791         struct bt_ctf_stream_class *stream_class = NULL;
 792         int64_t id = (int64_t) id_param;
 793
 794         if (!trace || id < 0) {
 795                 goto end;
 796         }
 797
 798         for (i = 0; i < trace->stream_classes->len; i++) {
 799                 struct bt_ctf_stream_class *stream_class_candidate;
 800
 801                 stream_class_candidate =
 802                         g_ptr_array_index(trace->stream_classes, i);
 803
 804                 if (bt_ctf_stream_class_get_id(stream_class_candidate) ==
 805                                 (int64_t) id) {
 806                         stream_class = stream_class_candidate;
 807                         bt_get(stream_class);
 808                         goto end;
 809                 }
 810         }
 811
 812 end:
 813         return stream_class;
 814 }
 815
 816 struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_name(
 817                 struct bt_ctf_trace *trace, const char *name)
 818 {
 819         size_t i;
 820         struct bt_ctf_clock_class *clock_class = NULL;
 821
 822         if (!trace || !name) {
 823                 goto end;
 824         }
 825
 826         for (i = 0; i < trace->clocks->len; i++) {
 827                 struct bt_ctf_clock_class *cur_clk =
 828                         g_ptr_array_index(trace->clocks, i);
 829                 const char *cur_clk_name = bt_ctf_clock_class_get_name(cur_clk);
 830
 831                 if (!cur_clk_name) {
 832                         goto end;
 833                 }
 834
 835                 if (!strcmp(cur_clk_name, name)) {
 836                         clock_class = cur_clk;
 837                         bt_get(clock_class);
 838                         goto end;
 839                 }
 840         }
 841
 842 end:
 843         return clock_class;
 844 }
 845
 846 BT_HIDDEN
 847 bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace *trace,
 848                 struct bt_ctf_clock_class *clock_class)
 849 {
 850         struct search_query query = { .value = clock_class, .found = 0 };
 851
 852         assert(trace);
 853         assert(clock_class);
 854
 855         g_ptr_array_foreach(trace->clocks, value_exists, &query);
 856         return query.found;
 857 }
 858
 859 BT_HIDDEN
 860 const char *get_byte_order_string(enum bt_ctf_byte_order byte_order)
 861 {
 862         const char *string;
 863
 864         switch (byte_order) {
 865         case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
 866                 string = "le";
 867                 break;
 868         case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
 869                 string = "be";
 870                 break;
 871         case BT_CTF_BYTE_ORDER_NATIVE:
 872                 string = "native";
 873                 break;
 874         default:
 875                 assert(false);
 876         }
 877
 878         return string;
 879 }
 880
 881 static
 882 int append_trace_metadata(struct bt_ctf_trace *trace,
 883                 struct metadata_context *context)
 884 {
 885         unsigned char *uuid = trace->uuid;
 886         int ret;
 887
 888         g_string_append(context->string, "trace {\n");
 889
 890         g_string_append(context->string, "\tmajor = 1;\n");
 891         g_string_append(context->string, "\tminor = 8;\n");
 892         assert(trace->native_byte_order == BT_CTF_BYTE_ORDER_LITTLE_ENDIAN ||
 893                 trace->native_byte_order == BT_CTF_BYTE_ORDER_BIG_ENDIAN ||
 894                 trace->native_byte_order == BT_CTF_BYTE_ORDER_NETWORK);
 895         g_string_append_printf(context->string,
 896                 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
 897                 uuid[0], uuid[1], uuid[2], uuid[3],
 898                 uuid[4], uuid[5], uuid[6], uuid[7],
 899                 uuid[8], uuid[9], uuid[10], uuid[11],
 900                 uuid[12], uuid[13], uuid[14], uuid[15]);
 901         g_string_append_printf(context->string, "\tbyte_order = %s;\n",
 902                 get_byte_order_string(trace->native_byte_order));
 903
 904         g_string_append(context->string, "\tpacket.header := ");
 905         context->current_indentation_level++;
 906         g_string_assign(context->field_name, "");
 907         ret = bt_ctf_field_type_serialize(trace->packet_header_type,
 908                 context);
 909         if (ret) {
 910                 goto end;
 911         }
 912         context->current_indentation_level--;
 913
 914         g_string_append(context->string, ";\n};\n\n");
 915 end:
 916         return ret;
 917 }
 918
 919 static
 920 void append_env_metadata(struct bt_ctf_trace *trace,
 921                 struct metadata_context *context)
 922 {
 923         int64_t i;
 924         int64_t env_size;
 925
 926         env_size = bt_ctf_attributes_get_count(trace->environment);
 927
 928         if (env_size <= 0) {
 929                 return;
 930         }
 931
 932         g_string_append(context->string, "env {\n");
 933
 934         for (i = 0; i < env_size; i++) {
 935                 struct bt_value *env_field_value_obj = NULL;
 936                 const char *entry_name;
 937
 938                 entry_name = bt_ctf_attributes_get_field_name(
 939                         trace->environment, i);
 940                 env_field_value_obj = bt_ctf_attributes_get_field_value(
 941                         trace->environment, i);
 942
 943                 if (!entry_name || !env_field_value_obj) {
 944                         goto loop_next;
 945                 }
 946
 947                 switch (bt_value_get_type(env_field_value_obj)) {
 948                 case BT_VALUE_TYPE_INTEGER:
 949                 {
 950                         int ret;
 951                         int64_t int_value;
 952
 953                         ret = bt_value_integer_get(env_field_value_obj,
 954                                 &int_value);
 955
 956                         if (ret) {
 957                                 goto loop_next;
 958                         }
 959
 960                         g_string_append_printf(context->string,
 961                                 "\t%s = %" PRId64 ";\n", entry_name,
 962                                 int_value);
 963                         break;
 964                 }
 965                 case BT_VALUE_TYPE_STRING:
 966                 {
 967                         int ret;
 968                         const char *str_value;
 969                         char *escaped_str = NULL;
 970
 971                         ret = bt_value_string_get(env_field_value_obj,
 972                                 &str_value);
 973
 974                         if (ret) {
 975                                 goto loop_next;
 976                         }
 977
 978                         escaped_str = g_strescape(str_value, NULL);
 979
 980                         if (!escaped_str) {
 981                                 goto loop_next;
 982                         }
 983
 984                         g_string_append_printf(context->string,
 985                                 "\t%s = \"%s\";\n", entry_name, escaped_str);
 986                         free(escaped_str);
 987                         break;
 988                 }
 989
 990                 default:
 991                         goto loop_next;
 992                 }
 993
 994 loop_next:
 995                 BT_PUT(env_field_value_obj);
 996         }
 997
 998         g_string_append(context->string, "};\n\n");
 999 }
1000
1001 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace *trace)
1002 {
1003         char *metadata = NULL;
1004         struct metadata_context *context = NULL;
1005         int err = 0;
1006         size_t i;
1007
1008         if (!trace) {
1009                 goto end;
1010         }
1011
1012         context = g_new0(struct metadata_context, 1);
1013         if (!context) {
1014                 goto end;
1015         }
1016
1017         context->field_name = g_string_sized_new(DEFAULT_IDENTIFIER_SIZE);
1018         context->string = g_string_sized_new(DEFAULT_METADATA_STRING_SIZE);
1019         g_string_append(context->string, "/* CTF 1.8 */\n\n");
1020         if (append_trace_metadata(trace, context)) {
1021                 goto error;
1022         }
1023         append_env_metadata(trace, context);
1024         g_ptr_array_foreach(trace->clocks,
1025                 (GFunc)bt_ctf_clock_class_serialize, context);
1026
1027         for (i = 0; i < trace->stream_classes->len; i++) {
1028                 err = bt_ctf_stream_class_serialize(
1029                         trace->stream_classes->pdata[i], context);
1030                 if (err) {
1031                         goto error;
1032                 }
1033         }
1034
1035         metadata = context->string->str;
1036 error:
1037         g_string_free(context->string, err ? TRUE : FALSE);
1038         g_string_free(context->field_name, TRUE);
1039         g_free(context);
1040 end:
1041         return metadata;
1042 }
1043
1044 enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(struct bt_ctf_trace *trace)
1045 {
1046         enum bt_ctf_byte_order ret = BT_CTF_BYTE_ORDER_UNKNOWN;
1047
1048         if (!trace) {
1049                 goto end;
1050         }
1051
1052         ret = trace->native_byte_order;
1053
1054 end:
1055         return ret;
1056 }
1057
1058 int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace,
1059                 enum bt_ctf_byte_order byte_order)
1060 {
1061         int ret = 0;
1062
1063         if (!trace || trace->frozen) {
1064                 ret = -1;
1065                 goto end;
1066         }
1067
1068         if (byte_order != BT_CTF_BYTE_ORDER_LITTLE_ENDIAN &&
1069                         byte_order != BT_CTF_BYTE_ORDER_BIG_ENDIAN &&
1070                         byte_order != BT_CTF_BYTE_ORDER_NETWORK) {
1071                 ret = -1;
1072                 goto end;
1073         }
1074
1075         trace->native_byte_order = byte_order;
1076
1077 end:
1078         return ret;
1079 }
1080
1081 struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_type(
1082                 struct bt_ctf_trace *trace)
1083 {
1084         struct bt_ctf_field_type *field_type = NULL;
1085
1086         if (!trace) {
1087                 goto end;
1088         }
1089
1090         bt_get(trace->packet_header_type);
1091         field_type = trace->packet_header_type;
1092 end:
1093         return field_type;
1094 }
1095
1096 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace,
1097                 struct bt_ctf_field_type *packet_header_type)
1098 {
1099         int ret = 0;
1100
1101         if (!trace || trace->frozen) {
1102                 ret = -1;
1103                 goto end;
1104         }
1105
1106         /* packet_header_type must be a structure. */
1107         if (packet_header_type &&
1108                         bt_ctf_field_type_get_type_id(packet_header_type) !=
1109                                 BT_CTF_FIELD_TYPE_ID_STRUCT) {
1110                 ret = -1;
1111                 goto end;
1112         }
1113
1114         bt_put(trace->packet_header_type);
1115         trace->packet_header_type = bt_get(packet_header_type);
1116 end:
1117         return ret;
1118 }
1119
1120 static
1121 int64_t get_stream_class_count(void *element)
1122 {
1123         return bt_ctf_trace_get_stream_class_count(
1124                         (struct bt_ctf_trace *) element);
1125 }
1126
1127 static
1128 void *get_stream_class(void *element, int i)
1129 {
1130         return bt_ctf_trace_get_stream_class_by_index(
1131                         (struct bt_ctf_trace *) element, i);
1132 }
1133
1134 static
1135 int visit_stream_class(void *object, bt_ctf_visitor visitor,void *data)
1136 {
1137         return bt_ctf_stream_class_visit(object, visitor, data);
1138 }
1139
1140 int bt_ctf_trace_visit(struct bt_ctf_trace *trace,
1141                 bt_ctf_visitor visitor, void *data)
1142 {
1143         int ret;
1144         struct bt_ctf_object obj =
1145                         { .object = trace, .type = BT_CTF_OBJECT_TYPE_TRACE };
1146
1147         if (!trace || !visitor) {
1148                 ret = -1;
1149                 goto end;
1150         }
1151
1152         ret = visitor_helper(&obj, get_stream_class_count,
1153                         get_stream_class, visit_stream_class, visitor, data);
1154 end:
1155         return ret;
1156 }
1157
1158 static
1159 int invoke_listener(struct bt_ctf_object *object, void *data)
1160 {
1161         struct listener_wrapper *listener_wrapper = data;
1162
1163         listener_wrapper->listener(object, listener_wrapper->data);
1164         return 0;
1165 }
1166
1167 int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace,
1168                 bt_ctf_listener_cb listener, void *listener_data)
1169 {
1170         int ret = 0;
1171         struct listener_wrapper *listener_wrapper =
1172                         g_new0(struct listener_wrapper, 1);
1173
1174         if (!trace || !listener || !listener_wrapper) {
1175                 ret = -1;
1176                 goto error;
1177         }
1178
1179         listener_wrapper->listener = listener;
1180         listener_wrapper->data = listener_data;
1181
1182         /* Visit the current schema. */
1183         ret = bt_ctf_trace_visit(trace, invoke_listener, listener_wrapper);
1184         if (ret) {
1185                 goto error;
1186         }
1187
1188         /*
1189          * Add listener to the array of callbacks which will be invoked on
1190          * schema changes.
1191          */
1192         g_ptr_array_add(trace->listeners, listener_wrapper);
1193         return ret;
1194 error:
1195         g_free(listener_wrapper);
1196         return ret;
1197 }
1198
1199 BT_HIDDEN
1200 int bt_ctf_trace_object_modification(struct bt_ctf_object *object,
1201                 void *trace_ptr)
1202 {
1203         size_t i;
1204         struct bt_ctf_trace *trace = trace_ptr;
1205
1206         assert(trace);
1207         assert(object);
1208
1209         if (trace->listeners->len == 0) {
1210                 goto end;
1211         }
1212
1213         for (i = 0; i < trace->listeners->len; i++) {
1214                 struct listener_wrapper *listener =
1215                                 g_ptr_array_index(trace->listeners, i);
1216
1217                 listener->listener(object, listener->data);
1218         }
1219 end:
1220         return 0;
1221 }
1222
1223 BT_HIDDEN
1224 struct bt_ctf_field_type *get_field_type(enum field_type_alias alias)
1225 {
1226         int ret;
1227         unsigned int alignment, size;
1228         struct bt_ctf_field_type *field_type = NULL;
1229
1230         if (alias >= NR_FIELD_TYPE_ALIAS) {
1231                 goto end;
1232         }
1233
1234         alignment = field_type_aliases_alignments[alias];
1235         size = field_type_aliases_sizes[alias];
1236         field_type = bt_ctf_field_type_integer_create(size);
1237         ret = bt_ctf_field_type_set_alignment(field_type, alignment);
1238         if (ret) {
1239                 BT_PUT(field_type);
1240         }
1241 end:
1242         return field_type;
1243 }
1244
1245 static
1246 void bt_ctf_trace_freeze(struct bt_ctf_trace *trace)
1247 {
1248         int i;
1249
1250         bt_ctf_field_type_freeze(trace->packet_header_type);
1251         bt_ctf_attributes_freeze(trace->environment);
1252
1253         for (i = 0; i < trace->clocks->len; i++) {
1254                 struct bt_ctf_clock_class *clock_class =
1255                         g_ptr_array_index(trace->clocks, i);
1256
1257                 bt_ctf_clock_class_freeze(clock_class);
1258         }
1259
1260         trace->frozen = 1;
1261 }
1262
1263 static
1264 int init_trace_packet_header(struct bt_ctf_trace *trace)
1265 {
1266         int ret = 0;
1267         struct bt_ctf_field *magic = NULL, *uuid_array = NULL;
1268         struct bt_ctf_field_type *_uint32_t =
1269                 get_field_type(FIELD_TYPE_ALIAS_UINT32_T);
1270         struct bt_ctf_field_type *_uint8_t =
1271                 get_field_type(FIELD_TYPE_ALIAS_UINT8_T);
1272         struct bt_ctf_field_type *trace_packet_header_type =
1273                 bt_ctf_field_type_structure_create();
1274         struct bt_ctf_field_type *uuid_array_type =
1275                 bt_ctf_field_type_array_create(_uint8_t, 16);
1276
1277         if (!trace_packet_header_type || !uuid_array_type) {
1278                 ret = -1;
1279                 goto end;
1280         }
1281
1282         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
1283                 _uint32_t, "magic");
1284         if (ret) {
1285                 goto end;
1286         }
1287
1288         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
1289                 uuid_array_type, "uuid");
1290         if (ret) {
1291                 goto end;
1292         }
1293
1294         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
1295                 _uint32_t, "stream_id");
1296         if (ret) {
1297                 goto end;
1298         }
1299
1300         ret = bt_ctf_trace_set_packet_header_type(trace,
1301                 trace_packet_header_type);
1302         if (ret) {
1303                 goto end;
1304         }
1305 end:
1306         bt_put(uuid_array_type);
1307         bt_put(_uint32_t);
1308         bt_put(_uint8_t);
1309         bt_put(magic);
1310         bt_put(uuid_array);
1311         bt_put(trace_packet_header_type);
1312         return ret;
1313 }
1314
1315 bool bt_ctf_trace_is_static(struct bt_ctf_trace *trace)
1316 {
1317         bool is_static = false;
1318
1319         if (!trace) {
1320                 goto end;
1321         }
1322
1323         is_static = trace->is_static;
1324
1325 end:
1326         return is_static;
1327 }
1328
1329 int bt_ctf_trace_set_is_static(struct bt_ctf_trace *trace)
1330 {
1331         int ret = 0;
1332
1333         if (!trace) {
1334                 ret = -1;
1335                 goto end;
1336         }
1337
1338         trace->is_static = true;
1339         bt_ctf_trace_freeze(trace);
1340
1341 end:
1342         return ret;
1343 }