2 * SPDX-License-Identifier: MIT
4 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Babeltrace CTF Writer
9 #define BT_LOG_TAG "CTF-WRITER"
20 #include <babeltrace2-ctf-writer/object.h>
22 #include "common/assert.h"
23 #include "compat/compiler.h"
24 #include "compat/endian.h"
25 #include "common/uuid.h"
29 #include "field-types.h"
31 #include "stream-class.h"
37 void bt_ctf_writer_destroy(struct bt_ctf_object
*obj
);
40 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
43 struct bt_ctf_field_type
*_uint32_t
=
44 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
45 struct bt_ctf_field_type
*_uint8_t
=
46 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
47 struct bt_ctf_field_type
*trace_packet_header_type
=
48 bt_ctf_field_type_structure_create();
49 struct bt_ctf_field_type
*uuid_array_type
=
50 bt_ctf_field_type_array_create(_uint8_t
, 16);
52 if (!trace_packet_header_type
|| !uuid_array_type
) {
57 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
63 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
64 uuid_array_type
, "uuid");
69 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
70 _uint32_t
, "stream_id");
75 ret
= bt_ctf_trace_set_packet_header_field_type(trace
,
76 trace_packet_header_type
);
81 bt_ctf_object_put_ref(uuid_array_type
);
82 bt_ctf_object_put_ref(_uint32_t
);
83 bt_ctf_object_put_ref(_uint8_t
);
84 bt_ctf_object_put_ref(trace_packet_header_type
);
88 struct bt_ctf_writer
*bt_ctf_writer_create(const char *path
)
91 struct bt_ctf_writer
*writer
= NULL
;
93 char *metadata_path
= NULL
;
99 writer
= g_new0(struct bt_ctf_writer
, 1);
104 metadata_path
= g_build_filename(path
, "metadata", NULL
);
106 bt_ctf_object_init_shared(&writer
->base
, bt_ctf_writer_destroy
);
107 writer
->path
= g_string_new(path
);
112 writer
->trace
= bt_ctf_trace_create();
113 if (!writer
->trace
) {
117 ret
= init_trace_packet_header(writer
->trace
);
122 /* Generate a UUID for this writer's trace */
123 bt_uuid_generate(uuid
);
125 ret
= bt_ctf_trace_set_uuid(writer
->trace
, uuid
);
130 bt_ctf_object_set_parent(&writer
->trace
->common
.base
, &writer
->base
);
131 bt_ctf_object_put_ref(writer
->trace
);
133 /* Default to little-endian */
134 ret
= bt_ctf_writer_set_byte_order(writer
, BT_CTF_BYTE_ORDER_NATIVE
);
135 BT_ASSERT_DBG(ret
== 0);
137 /* Create trace directory if necessary and open a metadata file */
138 if (g_mkdir_with_parents(path
, S_IRWXU
| S_IRWXG
)) {
139 perror("g_mkdir_with_parents");
143 writer
->metadata_fd
= open(metadata_path
,
144 O_WRONLY
| O_CREAT
| O_TRUNC
,
145 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
146 if (writer
->metadata_fd
< 0) {
151 g_free(metadata_path
);
155 BT_CTF_OBJECT_PUT_REF_AND_RESET(writer
);
157 g_free(metadata_path
);
161 void bt_ctf_writer_destroy(struct bt_ctf_object
*obj
)
163 struct bt_ctf_writer
*writer
;
165 writer
= container_of(obj
, struct bt_ctf_writer
, base
);
166 bt_ctf_writer_flush_metadata(writer
);
168 g_string_free(writer
->path
, TRUE
);
171 if (writer
->metadata_fd
> 0) {
172 if (close(writer
->metadata_fd
)) {
177 bt_ctf_object_try_spec_release(&writer
->trace
->common
.base
);
181 struct bt_ctf_trace
*bt_ctf_writer_get_trace(struct bt_ctf_writer
*writer
)
183 struct bt_ctf_trace
*trace
= NULL
;
189 trace
= writer
->trace
;
190 bt_ctf_object_get_ref(trace
);
195 struct bt_ctf_stream
*bt_ctf_writer_create_stream(struct bt_ctf_writer
*writer
,
196 struct bt_ctf_stream_class
*stream_class
)
198 struct bt_ctf_stream
*stream
= NULL
;
199 int stream_class_count
;
200 bt_ctf_bool stream_class_found
= BT_CTF_FALSE
;
203 if (!writer
|| !stream_class
) {
207 /* Make sure the stream class is part of the writer's trace */
208 stream_class_count
= bt_ctf_trace_get_stream_class_count(writer
->trace
);
209 if (stream_class_count
< 0) {
213 for (i
= 0; i
< stream_class_count
; i
++) {
214 struct bt_ctf_stream_class
*existing_stream_class
=
215 bt_ctf_trace_get_stream_class_by_index(
218 if (existing_stream_class
== stream_class
) {
219 stream_class_found
= BT_CTF_TRUE
;
222 BT_CTF_OBJECT_PUT_REF_AND_RESET(existing_stream_class
);
224 if (stream_class_found
) {
229 if (!stream_class_found
) {
230 int ret
= bt_ctf_trace_add_stream_class(writer
->trace
,
238 stream
= bt_ctf_stream_create_with_id(stream_class
, NULL
, -1ULL);
246 BT_CTF_OBJECT_PUT_REF_AND_RESET(stream
);
250 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer
*writer
,
256 if (!writer
|| !name
|| !value
) {
260 ret
= bt_ctf_trace_set_environment_field_string(writer
->trace
,
266 int bt_ctf_writer_add_environment_field_int64(struct bt_ctf_writer
*writer
,
267 const char *name
, int64_t value
)
271 if (!writer
|| !name
) {
275 ret
= bt_ctf_trace_set_environment_field_integer(writer
->trace
, name
,
281 int bt_ctf_writer_add_clock(struct bt_ctf_writer
*writer
,
282 struct bt_ctf_clock
*clock
)
286 if (!writer
|| !clock
) {
290 ret
= bt_ctf_trace_add_clock_class(writer
->trace
, clock
->clock_class
);
295 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer
*writer
)
297 char *metadata_string
= NULL
;
303 metadata_string
= bt_ctf_trace_get_metadata_string(
306 return metadata_string
;
309 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer
*writer
)
312 char *metadata_string
= NULL
;
318 metadata_string
= bt_ctf_trace_get_metadata_string(
320 if (!metadata_string
) {
324 if (lseek(writer
->metadata_fd
, 0, SEEK_SET
) == (off_t
)-1) {
329 if (ftruncate(writer
->metadata_fd
, 0)) {
334 ret
= write(writer
->metadata_fd
, metadata_string
,
335 strlen(metadata_string
));
341 g_free(metadata_string
);
344 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer
*writer
,
345 enum bt_ctf_byte_order byte_order
)
349 if (!writer
|| writer
->frozen
) {
354 if (byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
355 if (BYTE_ORDER
== LITTLE_ENDIAN
) {
356 byte_order
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
358 byte_order
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
362 ret
= bt_ctf_trace_set_native_byte_order(writer
->trace
,
369 void bt_ctf_writer_freeze(struct bt_ctf_writer
*writer
)
375 const unsigned int field_type_aliases_alignments
[] = {
376 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
377 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
378 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
379 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
383 const unsigned int field_type_aliases_sizes
[] = {
384 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
385 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
386 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
387 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
388 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
389 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
393 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
396 unsigned int alignment
, size
;
397 struct bt_ctf_field_type
*field_type
= NULL
;
399 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
403 alignment
= field_type_aliases_alignments
[alias
];
404 size
= field_type_aliases_sizes
[alias
];
405 field_type
= bt_ctf_field_type_integer_create(size
);
406 ret
= bt_ctf_field_type_set_alignment(field_type
, alignment
);
408 BT_CTF_OBJECT_PUT_REF_AND_RESET(field_type
);
415 const char *bt_ctf_get_byte_order_string(enum bt_ctf_byte_order byte_order
)
419 switch (byte_order
) {
420 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
423 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
426 case BT_CTF_BYTE_ORDER_NATIVE
: