4 * Babeltrace CTF Writer
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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/clock-internal.h>
30 #include <babeltrace/ctf-writer/writer-internal.h>
31 #include <babeltrace/ctf-ir/field-types-internal.h>
32 #include <babeltrace/ctf-ir/fields-internal.h>
33 #include <babeltrace/ctf-writer/functor-internal.h>
34 #include <babeltrace/ctf-ir/stream-class-internal.h>
35 #include <babeltrace/ctf-ir/stream-internal.h>
36 #include <babeltrace/ctf-ir/trace-internal.h>
37 #include <babeltrace/ref.h>
38 #include <babeltrace/endian-internal.h>
39 #include <babeltrace/compiler-internal.h>
40 #include <babeltrace/compat/uuid-internal.h>
50 void bt_ctf_writer_destroy(struct bt_object
*obj
);
53 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
56 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
57 struct bt_ctf_field_type
*_uint32_t
=
58 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
59 struct bt_ctf_field_type
*_uint8_t
=
60 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
61 struct bt_ctf_field_type
*trace_packet_header_type
=
62 bt_ctf_field_type_structure_create();
63 struct bt_ctf_field_type
*uuid_array_type
=
64 bt_ctf_field_type_array_create(_uint8_t
, 16);
66 if (!trace_packet_header_type
|| !uuid_array_type
) {
71 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
77 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
78 uuid_array_type
, "uuid");
83 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
84 _uint32_t
, "stream_id");
89 ret
= bt_ctf_trace_set_packet_header_type(trace
,
90 trace_packet_header_type
);
95 bt_put(uuid_array_type
);
100 bt_put(trace_packet_header_type
);
104 struct bt_ctf_writer
*bt_ctf_writer_create(const char *path
)
107 struct bt_ctf_writer
*writer
= NULL
;
108 unsigned char uuid
[16];
114 writer
= g_new0(struct bt_ctf_writer
, 1);
119 bt_object_init(writer
, bt_ctf_writer_destroy
);
120 writer
->path
= g_string_new(path
);
125 writer
->trace
= bt_ctf_trace_create();
126 if (!writer
->trace
) {
130 ret
= init_trace_packet_header(writer
->trace
);
135 /* Generate a UUID for this writer's trace */
137 ret
= bt_ctf_trace_set_uuid(writer
->trace
, uuid
);
142 writer
->trace
->is_created_by_writer
= 1;
143 bt_object_set_parent(writer
->trace
, writer
);
144 bt_put(writer
->trace
);
146 /* Default to little-endian */
147 ret
= bt_ctf_writer_set_byte_order(writer
, BT_CTF_BYTE_ORDER_NATIVE
);
150 /* Create trace directory if necessary and open a metadata file */
151 if (g_mkdir_with_parents(path
, S_IRWXU
| S_IRWXG
)) {
152 perror("g_mkdir_with_parents");
156 writer
->trace_dir_fd
= open(path
, O_RDONLY
, S_IRWXU
| S_IRWXG
);
157 if (writer
->trace_dir_fd
< 0) {
162 writer
->metadata_fd
= openat(writer
->trace_dir_fd
, "metadata",
163 O_WRONLY
| O_CREAT
| O_TRUNC
,
164 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
169 unlinkat(writer
->trace_dir_fd
, "metadata", 0);
175 void bt_ctf_writer_destroy(struct bt_object
*obj
)
177 struct bt_ctf_writer
*writer
;
179 writer
= container_of(obj
, struct bt_ctf_writer
, base
);
180 bt_ctf_writer_flush_metadata(writer
);
182 g_string_free(writer
->path
, TRUE
);
185 if (writer
->trace_dir_fd
> 0) {
186 if (close(writer
->trace_dir_fd
)) {
191 if (writer
->metadata_fd
> 0) {
192 if (close(writer
->metadata_fd
)) {
197 bt_object_release(writer
->trace
);
201 struct bt_ctf_trace
*bt_ctf_writer_get_trace(struct bt_ctf_writer
*writer
)
203 struct bt_ctf_trace
*trace
= NULL
;
209 trace
= writer
->trace
;
215 struct bt_ctf_stream
*bt_ctf_writer_create_stream(struct bt_ctf_writer
*writer
,
216 struct bt_ctf_stream_class
*stream_class
)
218 struct bt_ctf_stream
*stream
= NULL
;
219 int stream_class_count
;
220 bool stream_class_found
= false;
223 if (!writer
|| !stream_class
) {
227 /* Make sure the stream class is part of the writer's trace */
228 stream_class_count
= bt_ctf_trace_get_stream_class_count(writer
->trace
);
229 if (stream_class_count
< 0) {
233 for (i
= 0; i
< stream_class_count
; i
++) {
234 struct bt_ctf_stream_class
*existing_stream_class
=
235 bt_ctf_trace_get_stream_class_by_index(
238 if (existing_stream_class
== stream_class
) {
239 stream_class_found
= true;
242 BT_PUT(existing_stream_class
);
244 if (stream_class_found
) {
249 if (!stream_class_found
) {
250 int ret
= bt_ctf_trace_add_stream_class(writer
->trace
,
258 stream
= bt_ctf_stream_create(stream_class
, NULL
);
270 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer
*writer
,
276 if (!writer
|| !name
|| !value
) {
280 ret
= bt_ctf_trace_set_environment_field_string(writer
->trace
,
286 int bt_ctf_writer_add_environment_field_int64(struct bt_ctf_writer
*writer
,
287 const char *name
, int64_t value
)
291 if (!writer
|| !name
) {
295 ret
= bt_ctf_trace_set_environment_field_integer(writer
->trace
, name
,
301 int bt_ctf_writer_add_clock(struct bt_ctf_writer
*writer
,
302 struct bt_ctf_clock
*clock
)
306 if (!writer
|| !clock
) {
310 ret
= bt_ctf_trace_add_clock_class(writer
->trace
, clock
->clock_class
);
315 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer
*writer
)
317 char *metadata_string
= NULL
;
323 metadata_string
= bt_ctf_trace_get_metadata_string(
326 return metadata_string
;
329 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer
*writer
)
332 char *metadata_string
= NULL
;
338 metadata_string
= bt_ctf_trace_get_metadata_string(
340 if (!metadata_string
) {
344 if (lseek(writer
->metadata_fd
, 0, SEEK_SET
) == (off_t
)-1) {
349 if (ftruncate(writer
->metadata_fd
, 0)) {
354 ret
= write(writer
->metadata_fd
, metadata_string
,
355 strlen(metadata_string
));
361 g_free(metadata_string
);
364 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer
*writer
,
365 enum bt_ctf_byte_order byte_order
)
369 if (!writer
|| writer
->frozen
) {
374 if (byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
375 byte_order
= BT_CTF_MY_BYTE_ORDER
;
378 ret
= bt_ctf_trace_set_native_byte_order(writer
->trace
,
384 void bt_ctf_writer_get(struct bt_ctf_writer
*writer
)
389 void bt_ctf_writer_put(struct bt_ctf_writer
*writer
)
395 void bt_ctf_writer_freeze(struct bt_ctf_writer
*writer
)