4 * Babeltrace CTF Writer
6 * Copyright 2013 EfficiOS Inc.
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #include <babeltrace/ctf-writer/writer.h>
30 #include <babeltrace/ctf-writer/clock.h>
31 #include <babeltrace/ctf-writer/clock-internal.h>
32 #include <babeltrace/ctf-writer/writer-internal.h>
33 #include <babeltrace/ctf-writer/event-types-internal.h>
34 #include <babeltrace/ctf-writer/event-fields-internal.h>
35 #include <babeltrace/ctf-writer/functor-internal.h>
36 #include <babeltrace/ctf-writer/stream-internal.h>
37 #include <babeltrace/ctf-writer/stream.h>
38 #include <babeltrace/compiler.h>
39 #include <babeltrace/endian.h>
48 #define DEFAULT_IDENTIFIER_SIZE 128
49 #define DEFAULT_METADATA_STRING_SIZE 4096
52 void environment_variable_destroy(struct environment_variable
*var
);
54 void bt_ctf_writer_destroy(struct bt_ctf_ref
*ref
);
56 int init_trace_packet_header(struct bt_ctf_writer
*writer
);
58 int create_stream_file(struct bt_ctf_writer
*writer
,
59 struct bt_ctf_stream
*stream
);
61 void stream_flush_cb(struct bt_ctf_stream
*stream
,
62 struct bt_ctf_writer
*writer
);
65 const char * const reserved_keywords_str
[] = {"align", "callsite",
66 "const", "char", "clock", "double", "enum", "env", "event",
67 "floating_point", "float", "integer", "int", "long", "short", "signed",
68 "stream", "string", "struct", "trace", "typealias", "typedef",
69 "unsigned", "variant", "void" "_Bool", "_Complex", "_Imaginary"};
72 const unsigned int field_type_aliases_alignments
[] = {
73 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
74 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
75 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
76 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
80 const unsigned int field_type_aliases_sizes
[] = {
81 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
82 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
83 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
84 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
85 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
86 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
89 static GHashTable
*reserved_keywords_set
;
91 static int global_data_refcount
;
93 struct bt_ctf_writer
*bt_ctf_writer_create(const char *path
)
95 struct bt_ctf_writer
*writer
= NULL
;
101 writer
= g_new0(struct bt_ctf_writer
, 1);
106 bt_ctf_writer_set_byte_order(writer
, BT_CTF_BYTE_ORDER_NATIVE
);
107 bt_ctf_ref_init(&writer
->ref_count
);
108 writer
->path
= g_string_new(path
);
113 /* Create trace directory if necessary and open a metadata file */
114 if (g_mkdir_with_parents(path
, S_IRWXU
| S_IRWXG
)) {
115 perror("g_mkdir_with_parents");
119 writer
->trace_dir_fd
= open(path
, O_RDONLY
, S_IRWXU
| S_IRWXG
);
120 if (writer
->trace_dir_fd
< 0) {
125 writer
->metadata_fd
= openat(writer
->trace_dir_fd
, "metadata",
126 O_WRONLY
| O_CREAT
| O_TRUNC
,
127 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
128 writer
->environment
= g_ptr_array_new_with_free_func(
129 (GDestroyNotify
)environment_variable_destroy
);
130 writer
->clocks
= g_ptr_array_new_with_free_func(
131 (GDestroyNotify
)bt_ctf_clock_put
);
132 writer
->streams
= g_ptr_array_new_with_free_func(
133 (GDestroyNotify
)bt_ctf_stream_put
);
134 writer
->stream_classes
= g_ptr_array_new_with_free_func(
135 (GDestroyNotify
)bt_ctf_stream_class_put
);
136 if (!writer
->environment
|| !writer
->clocks
||
137 !writer
->stream_classes
|| !writer
->streams
) {
141 /* Generate a trace UUID */
142 uuid_generate(writer
->uuid
);
143 if (init_trace_packet_header(writer
)) {
149 unlinkat(writer
->trace_dir_fd
, "metadata", 0);
150 bt_ctf_writer_destroy(&writer
->ref_count
);
156 void bt_ctf_writer_destroy(struct bt_ctf_ref
*ref
)
158 struct bt_ctf_writer
*writer
;
164 writer
= container_of(ref
, struct bt_ctf_writer
, ref_count
);
165 bt_ctf_writer_flush_metadata(writer
);
167 g_string_free(writer
->path
, TRUE
);
170 if (writer
->trace_dir_fd
> 0) {
171 if (close(writer
->trace_dir_fd
)) {
177 if (writer
->metadata_fd
> 0) {
178 if (close(writer
->metadata_fd
)) {
184 if (writer
->environment
) {
185 g_ptr_array_free(writer
->environment
, TRUE
);
188 if (writer
->clocks
) {
189 g_ptr_array_free(writer
->clocks
, TRUE
);
192 if (writer
->streams
) {
193 g_ptr_array_free(writer
->streams
, TRUE
);
196 if (writer
->stream_classes
) {
197 g_ptr_array_free(writer
->stream_classes
, TRUE
);
200 bt_ctf_field_type_put(writer
->trace_packet_header_type
);
201 bt_ctf_field_put(writer
->trace_packet_header
);
205 struct bt_ctf_stream
*bt_ctf_writer_create_stream(struct bt_ctf_writer
*writer
,
206 struct bt_ctf_stream_class
*stream_class
)
209 int stream_class_found
= 0;
212 struct bt_ctf_stream
*stream
= NULL
;
214 if (!writer
|| !stream_class
) {
218 stream
= bt_ctf_stream_create(stream_class
);
223 stream_fd
= create_stream_file(writer
, stream
);
224 if (stream_fd
< 0 || bt_ctf_stream_set_fd(stream
, stream_fd
)) {
228 bt_ctf_stream_set_flush_callback(stream
, (flush_func
)stream_flush_cb
,
230 ret
= bt_ctf_stream_class_set_byte_order(stream
->stream_class
,
231 writer
->byte_order
== LITTLE_ENDIAN
?
232 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
: BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
237 for (i
= 0; i
< writer
->stream_classes
->len
; i
++) {
238 if (writer
->stream_classes
->pdata
[i
] == stream
->stream_class
) {
239 stream_class_found
= 1;
243 if (!stream_class_found
) {
244 if (bt_ctf_stream_class_set_id(stream
->stream_class
,
245 writer
->next_stream_id
++)) {
249 bt_ctf_stream_class_get(stream
->stream_class
);
250 g_ptr_array_add(writer
->stream_classes
, stream
->stream_class
);
253 bt_ctf_stream_get(stream
);
254 g_ptr_array_add(writer
->streams
, stream
);
258 bt_ctf_stream_put(stream
);
262 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer
*writer
,
266 struct environment_variable
*var
= NULL
;
267 char *escaped_value
= NULL
;
270 if (!writer
|| !name
|| !value
|| validate_identifier(name
)) {
275 if (strchr(name
, ' ')) {
280 var
= g_new0(struct environment_variable
, 1);
286 escaped_value
= g_strescape(value
, NULL
);
287 if (!escaped_value
) {
292 var
->name
= g_string_new(name
);
293 var
->value
= g_string_new(escaped_value
);
294 g_free(escaped_value
);
295 if (!var
->name
|| !var
->value
) {
300 g_ptr_array_add(writer
->environment
, var
);
304 if (var
&& var
->name
) {
305 g_string_free(var
->name
, TRUE
);
308 if (var
&& var
->value
) {
309 g_string_free(var
->value
, TRUE
);
316 int bt_ctf_writer_add_clock(struct bt_ctf_writer
*writer
,
317 struct bt_ctf_clock
*clock
)
320 struct search_query query
= { .value
= clock
, .found
= 0 };
322 if (!writer
|| !clock
) {
327 /* Check for duplicate clocks */
328 g_ptr_array_foreach(writer
->clocks
, value_exists
, &query
);
334 bt_ctf_clock_get(clock
);
335 g_ptr_array_add(writer
->clocks
, clock
);
341 const char *get_byte_order_string(int byte_order
)
345 switch (byte_order
) {
361 int append_trace_metadata(struct bt_ctf_writer
*writer
,
362 struct metadata_context
*context
)
364 unsigned char *uuid
= writer
->uuid
;
367 g_string_append(context
->string
, "trace {\n");
369 g_string_append(context
->string
, "\tmajor = 1;\n");
370 g_string_append(context
->string
, "\tminor = 8;\n");
372 g_string_append_printf(context
->string
,
373 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
374 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
375 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
376 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
377 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
378 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
379 get_byte_order_string(writer
->byte_order
));
381 g_string_append(context
->string
, "\tpacket.header := ");
382 context
->current_indentation_level
++;
383 g_string_assign(context
->field_name
, "");
384 ret
= bt_ctf_field_type_serialize(writer
->trace_packet_header_type
,
389 context
->current_indentation_level
--;
391 g_string_append(context
->string
, ";\n};\n\n");
397 void append_env_field_metadata(struct environment_variable
*var
,
398 struct metadata_context
*context
)
400 g_string_append_printf(context
->string
, "\t%s = \"%s\";\n",
401 var
->name
->str
, var
->value
->str
);
405 void append_env_metadata(struct bt_ctf_writer
*writer
,
406 struct metadata_context
*context
)
408 if (writer
->environment
->len
== 0) {
412 g_string_append(context
->string
, "env {\n");
413 g_ptr_array_foreach(writer
->environment
,
414 (GFunc
)append_env_field_metadata
, context
);
415 g_string_append(context
->string
, "};\n\n");
418 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer
*writer
)
420 char *metadata
= NULL
;
421 struct metadata_context
*context
= NULL
;
429 context
= g_new0(struct metadata_context
, 1);
434 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
435 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
436 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
437 if (append_trace_metadata(writer
, context
)) {
440 append_env_metadata(writer
, context
);
441 g_ptr_array_foreach(writer
->clocks
,
442 (GFunc
)bt_ctf_clock_serialize
, context
);
444 for (i
= 0; i
< writer
->stream_classes
->len
; i
++) {
445 err
= bt_ctf_stream_class_serialize(
446 writer
->stream_classes
->pdata
[i
], context
);
452 metadata
= context
->string
->str
;
454 g_string_free(context
->string
, err
? TRUE
: FALSE
);
455 g_string_free(context
->field_name
, TRUE
);
461 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer
*writer
)
464 char *metadata_string
= NULL
;
470 metadata_string
= bt_ctf_writer_get_metadata_string(writer
);
471 if (!metadata_string
) {
475 if (lseek(writer
->metadata_fd
, 0, SEEK_SET
) == (off_t
)-1) {
480 if (ftruncate(writer
->metadata_fd
, 0)) {
485 ret
= write(writer
->metadata_fd
, metadata_string
,
486 strlen(metadata_string
));
492 g_free(metadata_string
);
495 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer
*writer
,
496 enum bt_ctf_byte_order byte_order
)
499 int internal_byte_order
;
501 if (!writer
|| writer
->frozen
) {
506 switch (byte_order
) {
507 case BT_CTF_BYTE_ORDER_NATIVE
:
508 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
509 LITTLE_ENDIAN
: BIG_ENDIAN
;
511 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
512 internal_byte_order
= LITTLE_ENDIAN
;
514 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
515 case BT_CTF_BYTE_ORDER_NETWORK
:
516 internal_byte_order
= BIG_ENDIAN
;
523 writer
->byte_order
= internal_byte_order
;
524 if (writer
->trace_packet_header_type
||
525 writer
->trace_packet_header
) {
526 init_trace_packet_header(writer
);
532 void bt_ctf_writer_get(struct bt_ctf_writer
*writer
)
538 bt_ctf_ref_get(&writer
->ref_count
);
541 void bt_ctf_writer_put(struct bt_ctf_writer
*writer
)
547 bt_ctf_ref_put(&writer
->ref_count
, bt_ctf_writer_destroy
);
551 int validate_identifier(const char *input_string
)
555 char *save_ptr
, *token
;
557 if (!input_string
|| input_string
[0] == '\0') {
562 string
= strdup(input_string
);
568 token
= strtok_r(string
, " ", &save_ptr
);
570 if (g_hash_table_lookup_extended(reserved_keywords_set
,
571 GINT_TO_POINTER(g_quark_from_string(token
)),
577 token
= strtok_r(NULL
, " ", &save_ptr
);
585 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
587 unsigned int alignment
, size
;
588 struct bt_ctf_field_type
*field_type
;
590 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
594 alignment
= field_type_aliases_alignments
[alias
];
595 size
= field_type_aliases_sizes
[alias
];
596 field_type
= bt_ctf_field_type_integer_create(size
);
597 bt_ctf_field_type_set_alignment(field_type
, alignment
);
602 int init_trace_packet_header(struct bt_ctf_writer
*writer
)
606 struct bt_ctf_field
*trace_packet_header
= NULL
,
607 *magic
= NULL
, *uuid_array
= NULL
;
608 struct bt_ctf_field_type
*_uint32_t
=
609 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
610 struct bt_ctf_field_type
*_uint8_t
=
611 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
612 struct bt_ctf_field_type
*trace_packet_header_type
=
613 bt_ctf_field_type_structure_create();
614 struct bt_ctf_field_type
*uuid_array_type
=
615 bt_ctf_field_type_array_create(_uint8_t
, 16);
617 if (!trace_packet_header_type
|| !uuid_array_type
) {
622 ret
= bt_ctf_field_type_set_byte_order(_uint32_t
,
623 (writer
->byte_order
== LITTLE_ENDIAN
?
624 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
625 BT_CTF_BYTE_ORDER_BIG_ENDIAN
));
630 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
636 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
637 uuid_array_type
, "uuid");
642 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
643 _uint32_t
, "stream_id");
648 trace_packet_header
= bt_ctf_field_create(trace_packet_header_type
);
649 if (!trace_packet_header
) {
654 magic
= bt_ctf_field_structure_get_field(trace_packet_header
, "magic");
655 ret
= bt_ctf_field_unsigned_integer_set_value(magic
, 0xC1FC1FC1);
660 uuid_array
= bt_ctf_field_structure_get_field(trace_packet_header
,
662 for (i
= 0; i
< 16; i
++) {
663 struct bt_ctf_field
*uuid_element
=
664 bt_ctf_field_array_get_field(uuid_array
, i
);
665 ret
= bt_ctf_field_unsigned_integer_set_value(uuid_element
,
667 bt_ctf_field_put(uuid_element
);
673 bt_ctf_field_type_put(writer
->trace_packet_header_type
);
674 bt_ctf_field_put(writer
->trace_packet_header
);
675 writer
->trace_packet_header_type
= trace_packet_header_type
;
676 writer
->trace_packet_header
= trace_packet_header
;
678 bt_ctf_field_type_put(uuid_array_type
);
679 bt_ctf_field_type_put(_uint32_t
);
680 bt_ctf_field_type_put(_uint8_t
);
681 bt_ctf_field_put(magic
);
682 bt_ctf_field_put(uuid_array
);
684 bt_ctf_field_type_put(trace_packet_header_type
);
685 bt_ctf_field_put(trace_packet_header
);
692 void environment_variable_destroy(struct environment_variable
*var
)
694 g_string_free(var
->name
, TRUE
);
695 g_string_free(var
->value
, TRUE
);
700 int create_stream_file(struct bt_ctf_writer
*writer
,
701 struct bt_ctf_stream
*stream
)
704 GString
*filename
= g_string_new(stream
->stream_class
->name
->str
);
706 g_string_append_printf(filename
, "_%" PRIu32
, stream
->id
);
707 fd
= openat(writer
->trace_dir_fd
, filename
->str
,
708 O_RDWR
| O_CREAT
| O_TRUNC
,
709 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
710 g_string_free(filename
, TRUE
);
715 void stream_flush_cb(struct bt_ctf_stream
*stream
, struct bt_ctf_writer
*writer
)
717 struct bt_ctf_field
*stream_id
;
719 /* Start a new packet in the stream */
720 if (stream
->flushed_packet_count
) {
721 /* ctf_init_pos has already initialized the first packet */
722 ctf_packet_seek(&stream
->pos
.parent
, 0, SEEK_CUR
);
725 stream_id
= bt_ctf_field_structure_get_field(
726 writer
->trace_packet_header
, "stream_id");
727 bt_ctf_field_unsigned_integer_set_value(stream_id
,
728 stream
->stream_class
->id
);
729 bt_ctf_field_put(stream_id
);
731 /* Write the trace_packet_header */
732 bt_ctf_field_serialize(writer
->trace_packet_header
, &stream
->pos
);
735 static __attribute__((constructor
))
736 void writer_init(void)
739 const size_t reserved_keywords_count
=
740 sizeof(reserved_keywords_str
) / sizeof(char *);
742 global_data_refcount
++;
747 reserved_keywords_set
= g_hash_table_new(g_direct_hash
, g_direct_equal
);
748 for (i
= 0; i
< reserved_keywords_count
; i
++) {
749 gpointer quark
= GINT_TO_POINTER(g_quark_from_string(
750 reserved_keywords_str
[i
]));
752 g_hash_table_insert(reserved_keywords_set
, quark
, quark
);
758 static __attribute__((destructor
))
759 void writer_finalize(void)
761 if (--global_data_refcount
== 0) {
762 g_hash_table_destroy(reserved_keywords_set
);