formats/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-internal.h>
  31 #include <babeltrace/ctf-ir/stream-internal.h>
  32 #include <babeltrace/ctf-ir/stream-class-internal.h>
  33 #include <babeltrace/ctf-writer/functor-internal.h>
  34 #include <babeltrace/ctf-ir/event-types-internal.h>
  35 #include <babeltrace/ctf-ir/utils.h>
  36 #include <babeltrace/compiler.h>
  37 #include <babeltrace/objects.h>
  38
  39 #define DEFAULT_IDENTIFIER_SIZE 128
  40 #define DEFAULT_METADATA_STRING_SIZE 4096
  41
  42 static
  43 void bt_ctf_trace_destroy(struct bt_ctf_ref *ref);
  44 static
  45 int init_trace_packet_header(struct bt_ctf_trace *trace);
  46
  47 static
  48 const unsigned int field_type_aliases_alignments[] = {
  49         [FIELD_TYPE_ALIAS_UINT5_T] = 1,
  50         [FIELD_TYPE_ALIAS_UINT8_T ... FIELD_TYPE_ALIAS_UINT16_T] = 8,
  51         [FIELD_TYPE_ALIAS_UINT27_T] = 1,
  52         [FIELD_TYPE_ALIAS_UINT32_T ... FIELD_TYPE_ALIAS_UINT64_T] = 8,
  53 };
  54
  55 static
  56 const unsigned int field_type_aliases_sizes[] = {
  57         [FIELD_TYPE_ALIAS_UINT5_T] = 5,
  58         [FIELD_TYPE_ALIAS_UINT8_T] = 8,
  59         [FIELD_TYPE_ALIAS_UINT16_T] = 16,
  60         [FIELD_TYPE_ALIAS_UINT27_T] = 27,
  61         [FIELD_TYPE_ALIAS_UINT32_T] = 32,
  62         [FIELD_TYPE_ALIAS_UINT64_T] = 64,
  63 };
  64
  65 struct bt_ctf_trace *bt_ctf_trace_create(void)
  66 {
  67         struct bt_ctf_trace *trace = NULL;
  68
  69         trace = g_new0(struct bt_ctf_trace, 1);
  70         if (!trace) {
  71                 goto error;
  72         }
  73
  74         bt_ctf_trace_set_byte_order(trace, BT_CTF_BYTE_ORDER_NATIVE);
  75         bt_ctf_ref_init(&trace->ref_count);
  76         trace->clocks = g_ptr_array_new_with_free_func(
  77                 (GDestroyNotify)bt_ctf_clock_put);
  78         trace->streams = g_ptr_array_new_with_free_func(
  79                 (GDestroyNotify)bt_ctf_stream_put);
  80         trace->stream_classes = g_ptr_array_new_with_free_func(
  81                 (GDestroyNotify)bt_ctf_stream_class_put);
  82         if (!trace->clocks || !trace->stream_classes || !trace->streams) {
  83                 goto error_destroy;
  84         }
  85
  86         /* Generate a trace UUID */
  87         uuid_generate(trace->uuid);
  88         if (init_trace_packet_header(trace)) {
  89                 goto error_destroy;
  90         }
  91
  92         /* Create the environment array object */
  93         trace->environment = bt_ctf_attributes_create();
  94         if (!trace->environment) {
  95                 goto error_destroy;
  96         }
  97
  98         return trace;
  99
 100 error_destroy:
 101         bt_ctf_trace_destroy(&trace->ref_count);
 102         trace = NULL;
 103 error:
 104         return trace;
 105 }
 106
 107 void bt_ctf_trace_destroy(struct bt_ctf_ref *ref)
 108 {
 109         struct bt_ctf_trace *trace;
 110
 111         if (!ref) {
 112                 return;
 113         }
 114
 115         trace = container_of(ref, struct bt_ctf_trace, ref_count);
 116         if (trace->environment) {
 117                 bt_ctf_attributes_destroy(trace->environment);
 118         }
 119
 120         if (trace->clocks) {
 121                 g_ptr_array_free(trace->clocks, TRUE);
 122         }
 123
 124         if (trace->streams) {
 125                 g_ptr_array_free(trace->streams, TRUE);
 126         }
 127
 128         if (trace->stream_classes) {
 129                 g_ptr_array_free(trace->stream_classes, TRUE);
 130         }
 131
 132         bt_ctf_field_type_put(trace->packet_header_type);
 133         g_free(trace);
 134 }
 135
 136 struct bt_ctf_stream *bt_ctf_trace_create_stream(struct bt_ctf_trace *trace,
 137                 struct bt_ctf_stream_class *stream_class)
 138 {
 139         int ret;
 140         int stream_class_found = 0;
 141         size_t i;
 142         struct bt_ctf_stream *stream = NULL;
 143
 144         if (!trace || !stream_class) {
 145                 goto error;
 146         }
 147
 148         stream = bt_ctf_stream_create(stream_class, trace);
 149         if (!stream) {
 150                 goto error;
 151         }
 152
 153         for (i = 0; i < trace->stream_classes->len; i++) {
 154                 if (trace->stream_classes->pdata[i] == stream_class) {
 155                         stream_class_found = 1;
 156                 }
 157         }
 158
 159         if (!stream_class_found) {
 160                 ret = bt_ctf_trace_add_stream_class(trace, stream_class);
 161                 if (ret) {
 162                         goto error;
 163                 }
 164         }
 165
 166         bt_ctf_stream_get(stream);
 167         g_ptr_array_add(trace->streams, stream);
 168
 169         return stream;
 170 error:
 171         bt_ctf_stream_put(stream);
 172         return NULL;
 173 }
 174
 175 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace *trace,
 176                 const char *name, struct bt_object *value)
 177 {
 178         int ret = 0;
 179
 180         if (!trace || trace->frozen || !name || !value ||
 181                 bt_ctf_validate_identifier(name) ||
 182                 !(bt_object_is_integer(value) || bt_object_is_string(value))) {
 183                 ret = -1;
 184                 goto end;
 185         }
 186
 187         if (strchr(name, ' ')) {
 188                 ret = -1;
 189                 goto end;
 190         }
 191
 192         ret = bt_ctf_attributes_set_field_value(trace->environment, name,
 193                 value);
 194
 195 end:
 196         return ret;
 197 }
 198
 199 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace *trace,
 200                 const char *name, const char *value)
 201 {
 202         int ret = 0;
 203         struct bt_object *env_value_string_obj = NULL;
 204
 205         if (!trace || !name || !value) {
 206                 ret = -1;
 207                 goto end;
 208         }
 209
 210         env_value_string_obj = bt_object_string_create_init(value);
 211
 212         if (!env_value_string_obj) {
 213                 ret = -1;
 214                 goto end;
 215         }
 216
 217         ret = bt_ctf_trace_set_environment_field(trace, name,
 218                 env_value_string_obj);
 219
 220 end:
 221         BT_OBJECT_PUT(env_value_string_obj);
 222
 223         return ret;
 224 }
 225
 226 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace *trace,
 227                 const char *name, int64_t value)
 228 {
 229         int ret = 0;
 230         struct bt_object *env_value_integer_obj = NULL;
 231
 232         if (!trace || !name) {
 233                 ret = -1;
 234                 goto end;
 235         }
 236
 237         env_value_integer_obj = bt_object_integer_create_init(value);
 238         if (!env_value_integer_obj) {
 239                 ret = -1;
 240                 goto end;
 241         }
 242
 243         ret = bt_ctf_trace_set_environment_field(trace, name,
 244                 env_value_integer_obj);
 245
 246 end:
 247         BT_OBJECT_PUT(env_value_integer_obj);
 248
 249         return ret;
 250 }
 251
 252 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace *trace)
 253 {
 254         int ret = 0;
 255
 256         if (!trace) {
 257                 ret = -1;
 258                 goto end;
 259         }
 260
 261         ret = bt_ctf_attributes_get_count(trace->environment);
 262
 263 end:
 264         return ret;
 265 }
 266
 267 const char *
 268 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace *trace,
 269                 int index)
 270 {
 271         const char *ret = NULL;
 272
 273         if (!trace) {
 274                 goto end;
 275         }
 276
 277         ret = bt_ctf_attributes_get_field_name(trace->environment, index);
 278
 279 end:
 280         return ret;
 281 }
 282
 283 struct bt_object *bt_ctf_trace_get_environment_field_value(
 284                 struct bt_ctf_trace *trace, int index)
 285 {
 286         struct bt_object *ret = NULL;
 287
 288         if (!trace) {
 289                 goto end;
 290         }
 291
 292         ret = bt_ctf_attributes_get_field_value(trace->environment, index);
 293
 294 end:
 295         return ret;
 296 }
 297
 298 struct bt_object *bt_ctf_trace_get_environment_field_value_by_name(
 299                 struct bt_ctf_trace *trace, const char *name)
 300 {
 301         struct bt_object *ret = NULL;
 302
 303         if (!trace || !name) {
 304                 goto end;
 305         }
 306
 307         ret = bt_ctf_attributes_get_field_value_by_name(trace->environment,
 308                 name);
 309
 310 end:
 311         return ret;
 312 }
 313
 314 int bt_ctf_trace_add_clock(struct bt_ctf_trace *trace,
 315                 struct bt_ctf_clock *clock)
 316 {
 317         int ret = 0;
 318         struct search_query query = { .value = clock, .found = 0 };
 319
 320         if (!trace || !clock) {
 321                 ret = -1;
 322                 goto end;
 323         }
 324
 325         /* Check for duplicate clocks */
 326         g_ptr_array_foreach(trace->clocks, value_exists, &query);
 327         if (query.found) {
 328                 ret = -1;
 329                 goto end;
 330         }
 331
 332         bt_ctf_clock_get(clock);
 333         g_ptr_array_add(trace->clocks, clock);
 334 end:
 335         return ret;
 336 }
 337
 338 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace *trace)
 339 {
 340         int ret = -1;
 341
 342         if (!trace) {
 343                 goto end;
 344         }
 345
 346         ret = trace->clocks->len;
 347 end:
 348         return ret;
 349 }
 350
 351 struct bt_ctf_clock *bt_ctf_trace_get_clock(struct bt_ctf_trace *trace,
 352                 int index)
 353 {
 354         struct bt_ctf_clock *clock = NULL;
 355
 356         if (!trace || index < 0 || index >= trace->clocks->len) {
 357                 goto end;
 358         }
 359
 360         clock = g_ptr_array_index(trace->clocks, index);
 361         bt_ctf_clock_get(clock);
 362 end:
 363         return clock;
 364 }
 365
 366 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace,
 367                 struct bt_ctf_stream_class *stream_class)
 368 {
 369         int ret, i;
 370         int64_t stream_id;
 371
 372         if (!trace || !stream_class) {
 373                 ret = -1;
 374                 goto end;
 375         }
 376
 377         for (i = 0; i < trace->stream_classes->len; i++) {
 378                 if (trace->stream_classes->pdata[i] == stream_class) {
 379                         ret = -1;
 380                         goto end;
 381                 }
 382         }
 383
 384         stream_id = bt_ctf_stream_class_get_id(stream_class);
 385         if (stream_id < 0) {
 386                 stream_id = trace->next_stream_id++;
 387
 388                 /* Try to assign a new stream id */
 389                 for (i = 0; i < trace->stream_classes->len; i++) {
 390                         if (stream_id == bt_ctf_stream_class_get_id(
 391                                 trace->stream_classes->pdata[i])) {
 392                                 /* Duplicate stream id found */
 393                                 ret = -1;
 394                                 goto end;
 395                         }
 396                 }
 397
 398                 if (_bt_ctf_stream_class_set_id(stream_class,
 399                         stream_id)) {
 400                         /* TODO Should retry with a different stream id */
 401                         ret = -1;
 402                         goto end;
 403                 }
 404         }
 405
 406         bt_ctf_stream_class_get(stream_class);
 407         g_ptr_array_add(trace->stream_classes, stream_class);
 408
 409         /*
 410          * Freeze the trace and its packet header.
 411          *
 412          * All field type byte orders set as "native" byte ordering can now be
 413          * safely set to trace's own endianness, including the stream class'.
 414          */
 415         bt_ctf_field_type_set_native_byte_order(trace->packet_header_type,
 416                 trace->byte_order);
 417         ret = bt_ctf_stream_class_set_byte_order(stream_class,
 418                 trace->byte_order == LITTLE_ENDIAN ?
 419                 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN : BT_CTF_BYTE_ORDER_BIG_ENDIAN);
 420         if (ret) {
 421                 goto end;
 422         }
 423         bt_ctf_stream_class_freeze(stream_class);
 424         trace->frozen = 1;
 425         bt_ctf_attributes_freeze(trace->environment);
 426
 427 end:
 428         return ret;
 429 }
 430
 431 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace *trace)
 432 {
 433         int ret;
 434
 435         if (!trace) {
 436                 ret = -1;
 437                 goto end;
 438         }
 439
 440         ret = trace->stream_classes->len;
 441 end:
 442         return ret;
 443 }
 444
 445 struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class(
 446                 struct bt_ctf_trace *trace, int index)
 447 {
 448         struct bt_ctf_stream_class *stream_class = NULL;
 449
 450         if (!trace || index < 0 || index >= trace->stream_classes->len) {
 451                 goto end;
 452         }
 453
 454         stream_class = g_ptr_array_index(trace->stream_classes, index);
 455         bt_ctf_stream_class_get(stream_class);
 456 end:
 457         return stream_class;
 458 }
 459
 460 struct bt_ctf_clock *bt_ctf_trace_get_clock_by_name(
 461                 struct bt_ctf_trace *trace, const char *name)
 462 {
 463         size_t i;
 464         struct bt_ctf_clock *clock = NULL;
 465
 466         if (!trace || !name) {
 467                 goto end;
 468         }
 469
 470         for (i = 0; i < trace->clocks->len; ++i) {
 471                 struct bt_ctf_clock *cur_clk =
 472                         g_ptr_array_index(trace->clocks, i);
 473                 const char *cur_clk_name = bt_ctf_clock_get_name(cur_clk);
 474
 475                 if (!cur_clk_name) {
 476                         goto end;
 477                 }
 478
 479                 if (!strcmp(cur_clk_name, name)) {
 480                         clock = cur_clk;
 481                         bt_ctf_clock_get(clock);
 482                         goto end;
 483                 }
 484         }
 485
 486 end:
 487         return clock;
 488 }
 489
 490 BT_HIDDEN
 491 const char *get_byte_order_string(int byte_order)
 492 {
 493         const char *string;
 494
 495         switch (byte_order) {
 496         case LITTLE_ENDIAN:
 497                 string = "le";
 498                 break;
 499         case BIG_ENDIAN:
 500                 string = "be";
 501                 break;
 502         default:
 503                 string = "unknown";
 504                 break;
 505         }
 506
 507         return string;
 508 }
 509
 510 static
 511 int append_trace_metadata(struct bt_ctf_trace *trace,
 512                 struct metadata_context *context)
 513 {
 514         unsigned char *uuid = trace->uuid;
 515         int ret;
 516
 517         g_string_append(context->string, "trace {\n");
 518
 519         g_string_append(context->string, "\tmajor = 1;\n");
 520         g_string_append(context->string, "\tminor = 8;\n");
 521
 522         g_string_append_printf(context->string,
 523                 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
 524                 uuid[0], uuid[1], uuid[2], uuid[3],
 525                 uuid[4], uuid[5], uuid[6], uuid[7],
 526                 uuid[8], uuid[9], uuid[10], uuid[11],
 527                 uuid[12], uuid[13], uuid[14], uuid[15]);
 528         g_string_append_printf(context->string, "\tbyte_order = %s;\n",
 529                 get_byte_order_string(trace->byte_order));
 530
 531         g_string_append(context->string, "\tpacket.header := ");
 532         context->current_indentation_level++;
 533         g_string_assign(context->field_name, "");
 534         ret = bt_ctf_field_type_serialize(trace->packet_header_type,
 535                 context);
 536         if (ret) {
 537                 goto end;
 538         }
 539         context->current_indentation_level--;
 540
 541         g_string_append(context->string, ";\n};\n\n");
 542 end:
 543         return ret;
 544 }
 545
 546 static
 547 void append_env_metadata(struct bt_ctf_trace *trace,
 548                 struct metadata_context *context)
 549 {
 550         int i;
 551         int env_size;
 552
 553         env_size = bt_ctf_attributes_get_count(trace->environment);
 554
 555         if (env_size <= 0) {
 556                 return;
 557         }
 558
 559         g_string_append(context->string, "env {\n");
 560
 561         for (i = 0; i < env_size; ++i) {
 562                 struct bt_object *env_field_value_obj = NULL;
 563                 const char *entry_name;
 564                 int64_t int_value;
 565                 int ret;
 566
 567                 entry_name = bt_ctf_attributes_get_field_name(
 568                         trace->environment, i);
 569                 env_field_value_obj = bt_ctf_attributes_get_field_value(
 570                         trace->environment, i);
 571
 572                 if (!entry_name || !env_field_value_obj) {
 573                         goto loop_next;
 574                 }
 575
 576                 switch (bt_object_get_type(env_field_value_obj)) {
 577                 case BT_OBJECT_TYPE_INTEGER:
 578                         ret = bt_object_integer_get(env_field_value_obj,
 579                                 &int_value);
 580
 581                         if (ret) {
 582                                 goto loop_next;
 583                         }
 584
 585                         g_string_append_printf(context->string,
 586                                 "\t%s = %" PRId64 ";\n", entry_name,
 587                                 int_value);
 588                         break;
 589
 590                 case BT_OBJECT_TYPE_STRING:
 591                 {
 592                         int ret;
 593                         const char *str_value;
 594                         char *escaped_str = NULL;
 595
 596                         ret = bt_object_string_get(env_field_value_obj,
 597                                 &str_value);
 598
 599                         if (ret) {
 600                                 goto loop_next;
 601                         }
 602
 603                         escaped_str = g_strescape(str_value, NULL);
 604
 605                         if (!escaped_str) {
 606                                 goto loop_next;
 607                         }
 608
 609                         g_string_append_printf(context->string,
 610                                 "\t%s = \"%s\";\n", entry_name, escaped_str);
 611                         free(escaped_str);
 612                         break;
 613                 }
 614
 615                 default:
 616                         goto loop_next;
 617                 }
 618
 619 loop_next:
 620                 BT_OBJECT_PUT(env_field_value_obj);
 621         }
 622
 623         g_string_append(context->string, "};\n\n");
 624 }
 625
 626 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace *trace)
 627 {
 628         char *metadata = NULL;
 629         struct metadata_context *context = NULL;
 630         int err = 0;
 631         size_t i;
 632
 633         if (!trace) {
 634                 goto end;
 635         }
 636
 637         context = g_new0(struct metadata_context, 1);
 638         if (!context) {
 639                 goto end;
 640         }
 641
 642         context->field_name = g_string_sized_new(DEFAULT_IDENTIFIER_SIZE);
 643         context->string = g_string_sized_new(DEFAULT_METADATA_STRING_SIZE);
 644         g_string_append(context->string, "/* CTF 1.8 */\n\n");
 645         if (append_trace_metadata(trace, context)) {
 646                 goto error;
 647         }
 648         append_env_metadata(trace, context);
 649         g_ptr_array_foreach(trace->clocks,
 650                 (GFunc)bt_ctf_clock_serialize, context);
 651
 652         for (i = 0; i < trace->stream_classes->len; i++) {
 653                 err = bt_ctf_stream_class_serialize(
 654                         trace->stream_classes->pdata[i], context);
 655                 if (err) {
 656                         goto error;
 657                 }
 658         }
 659
 660         metadata = context->string->str;
 661 error:
 662         g_string_free(context->string, err ? TRUE : FALSE);
 663         g_string_free(context->field_name, TRUE);
 664         g_free(context);
 665 end:
 666         return metadata;
 667 }
 668
 669 enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(struct bt_ctf_trace *trace)
 670 {
 671         enum bt_ctf_byte_order ret = BT_CTF_BYTE_ORDER_UNKNOWN;
 672
 673         if (!trace) {
 674                 goto end;
 675         }
 676
 677         switch (trace->byte_order) {
 678         case BIG_ENDIAN:
 679                 ret = BT_CTF_BYTE_ORDER_BIG_ENDIAN;
 680                 break;
 681         case LITTLE_ENDIAN:
 682                 ret = BT_CTF_BYTE_ORDER_LITTLE_ENDIAN;
 683                 break;
 684         default:
 685                 break;
 686         }
 687 end:
 688         return ret;
 689 }
 690
 691 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace,
 692                 enum bt_ctf_byte_order byte_order)
 693 {
 694         int ret = 0;
 695         int internal_byte_order;
 696
 697         if (!trace || trace->frozen) {
 698                 ret = -1;
 699                 goto end;
 700         }
 701
 702         switch (byte_order) {
 703         case BT_CTF_BYTE_ORDER_NATIVE:
 704                 /*
 705                  * This doesn't make sense since the CTF specification defines
 706                  * the "native" byte order as "the byte order described in the
 707                  * trace description". However, this behavior had been
 708                  * implemented as part of v1.2 and is kept to maintain
 709                  * compatibility.
 710                  *
 711                  * This may be changed on a major version bump only.
 712                  */
 713                 internal_byte_order = (G_BYTE_ORDER == G_LITTLE_ENDIAN) ?
 714                         LITTLE_ENDIAN : BIG_ENDIAN;
 715                 break;
 716         case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
 717                 internal_byte_order = LITTLE_ENDIAN;
 718                 break;
 719         case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
 720         case BT_CTF_BYTE_ORDER_NETWORK:
 721                 internal_byte_order = BIG_ENDIAN;
 722                 break;
 723         default:
 724                 ret = -1;
 725                 goto end;
 726         }
 727
 728         trace->byte_order = internal_byte_order;
 729 end:
 730         return ret;
 731 }
 732
 733 struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_type(
 734                 struct bt_ctf_trace *trace)
 735 {
 736         struct bt_ctf_field_type *field_type = NULL;
 737
 738         if (!trace) {
 739                 goto end;
 740         }
 741
 742         bt_ctf_field_type_get(trace->packet_header_type);
 743         field_type = trace->packet_header_type;
 744 end:
 745         return field_type;
 746 }
 747
 748 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace,
 749                 struct bt_ctf_field_type *packet_header_type)
 750 {
 751         int ret = 0;
 752
 753         if (!trace || !packet_header_type || trace->frozen) {
 754                 ret = -1;
 755                 goto end;
 756         }
 757
 758         /* packet_header_type must be a structure */
 759         if (bt_ctf_field_type_get_type_id(packet_header_type) !=
 760                 CTF_TYPE_STRUCT) {
 761                 ret = -1;
 762                 goto end;
 763         }
 764
 765         bt_ctf_field_type_get(packet_header_type);
 766         bt_ctf_field_type_put(trace->packet_header_type);
 767         trace->packet_header_type = packet_header_type;
 768 end:
 769         return ret;
 770 }
 771
 772 void bt_ctf_trace_get(struct bt_ctf_trace *trace)
 773 {
 774         if (!trace) {
 775                 return;
 776         }
 777
 778         bt_ctf_ref_get(&trace->ref_count);
 779 }
 780
 781 void bt_ctf_trace_put(struct bt_ctf_trace *trace)
 782 {
 783         if (!trace) {
 784                 return;
 785         }
 786
 787         bt_ctf_ref_put(&trace->ref_count, bt_ctf_trace_destroy);
 788 }
 789
 790 BT_HIDDEN
 791 struct bt_ctf_field_type *get_field_type(enum field_type_alias alias)
 792 {
 793         unsigned int alignment, size;
 794         struct bt_ctf_field_type *field_type;
 795
 796         if (alias >= NR_FIELD_TYPE_ALIAS) {
 797                 return NULL;
 798         }
 799
 800         alignment = field_type_aliases_alignments[alias];
 801         size = field_type_aliases_sizes[alias];
 802         field_type = bt_ctf_field_type_integer_create(size);
 803         bt_ctf_field_type_set_alignment(field_type, alignment);
 804         return field_type;
 805 }
 806
 807 static
 808 int init_trace_packet_header(struct bt_ctf_trace *trace)
 809 {
 810         int ret = 0;
 811         struct bt_ctf_field *magic = NULL, *uuid_array = NULL;
 812         struct bt_ctf_field_type *_uint32_t =
 813                 get_field_type(FIELD_TYPE_ALIAS_UINT32_T);
 814         struct bt_ctf_field_type *_uint8_t =
 815                 get_field_type(FIELD_TYPE_ALIAS_UINT8_T);
 816         struct bt_ctf_field_type *trace_packet_header_type =
 817                 bt_ctf_field_type_structure_create();
 818         struct bt_ctf_field_type *uuid_array_type =
 819                 bt_ctf_field_type_array_create(_uint8_t, 16);
 820
 821         if (!trace_packet_header_type || !uuid_array_type) {
 822                 ret = -1;
 823                 goto end;
 824         }
 825
 826         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
 827                 _uint32_t, "magic");
 828         if (ret) {
 829                 goto end;
 830         }
 831
 832         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
 833                 uuid_array_type, "uuid");
 834         if (ret) {
 835                 goto end;
 836         }
 837
 838         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
 839                 _uint32_t, "stream_id");
 840         if (ret) {
 841                 goto end;
 842         }
 843
 844         ret = bt_ctf_trace_set_packet_header_type(trace,
 845                 trace_packet_header_type);
 846         if (ret) {
 847                 goto end;
 848         }
 849 end:
 850         bt_ctf_field_type_put(uuid_array_type);
 851         bt_ctf_field_type_put(_uint32_t);
 852         bt_ctf_field_type_put(_uint8_t);
 853         bt_ctf_field_put(magic);
 854         bt_ctf_field_put(uuid_array);
 855         bt_ctf_field_type_put(trace_packet_header_type);
 856
 857         return ret;
 858 }