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