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 #define BT_LOG_TAG "CTF-WRITER"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/ctf-writer/clock-internal.h>
33 #include <babeltrace/ctf-writer/writer-internal.h>
34 #include <babeltrace/ctf-ir/field-types-internal.h>
35 #include <babeltrace/ctf-ir/fields-internal.h>
36 #include <babeltrace/ctf-writer/functor-internal.h>
37 #include <babeltrace/ctf-ir/stream-class-internal.h>
38 #include <babeltrace/ctf-ir/stream-internal.h>
39 #include <babeltrace/ctf-ir/trace-internal.h>
40 #include <babeltrace/ref.h>
41 #include <babeltrace/endian-internal.h>
42 #include <babeltrace/compiler-internal.h>
43 #include <babeltrace/compat/uuid-internal.h>
53 void bt_ctf_writer_destroy(struct bt_object
*obj
);
56 int init_trace_packet_header(struct bt_trace
*trace
)
59 struct bt_field
*magic
= NULL
, *uuid_array
= NULL
;
60 struct bt_field_type
*_uint32_t
=
61 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
62 struct bt_field_type
*_uint8_t
=
63 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
64 struct bt_field_type
*trace_packet_header_type
=
65 bt_field_type_structure_create();
66 struct bt_field_type
*uuid_array_type
=
67 bt_field_type_array_create(_uint8_t
, 16);
69 if (!trace_packet_header_type
|| !uuid_array_type
) {
74 ret
= bt_field_type_structure_add_field(trace_packet_header_type
,
80 ret
= bt_field_type_structure_add_field(trace_packet_header_type
,
81 uuid_array_type
, "uuid");
86 ret
= bt_field_type_structure_add_field(trace_packet_header_type
,
87 _uint32_t
, "stream_id");
92 ret
= bt_trace_set_packet_header_type(trace
,
93 trace_packet_header_type
);
98 bt_put(uuid_array_type
);
103 bt_put(trace_packet_header_type
);
107 struct bt_ctf_writer
*bt_ctf_writer_create(const char *path
)
110 struct bt_ctf_writer
*writer
= NULL
;
111 unsigned char uuid
[16];
112 char *metadata_path
= NULL
;
118 writer
= g_new0(struct bt_ctf_writer
, 1);
123 metadata_path
= g_build_filename(path
, "metadata", NULL
);
125 bt_object_init(writer
, bt_ctf_writer_destroy
);
126 writer
->path
= g_string_new(path
);
131 writer
->trace
= bt_trace_create();
132 if (!writer
->trace
) {
136 ret
= init_trace_packet_header(writer
->trace
);
141 /* Generate a UUID for this writer's trace */
142 ret
= bt_uuid_generate(uuid
);
144 BT_LOGE_STR("Cannot generate UUID for CTF writer's trace.");
148 ret
= bt_trace_set_uuid(writer
->trace
, uuid
);
153 writer
->trace
->is_created_by_writer
= 1;
154 bt_object_set_parent(writer
->trace
, writer
);
155 bt_put(writer
->trace
);
157 /* Default to little-endian */
158 ret
= bt_ctf_writer_set_byte_order(writer
, BT_BYTE_ORDER_NATIVE
);
161 /* Create trace directory if necessary and open a metadata file */
162 if (g_mkdir_with_parents(path
, S_IRWXU
| S_IRWXG
)) {
163 perror("g_mkdir_with_parents");
167 writer
->metadata_fd
= open(metadata_path
,
168 O_WRONLY
| O_CREAT
| O_TRUNC
,
169 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
170 if (writer
->metadata_fd
< 0) {
175 g_free(metadata_path
);
181 g_free(metadata_path
);
185 void bt_ctf_writer_destroy(struct bt_object
*obj
)
187 struct bt_ctf_writer
*writer
;
189 writer
= container_of(obj
, struct bt_ctf_writer
, base
);
190 bt_ctf_writer_flush_metadata(writer
);
192 g_string_free(writer
->path
, TRUE
);
195 if (writer
->metadata_fd
> 0) {
196 if (close(writer
->metadata_fd
)) {
201 bt_object_release(writer
->trace
);
205 struct bt_trace
*bt_ctf_writer_get_trace(struct bt_ctf_writer
*writer
)
207 struct bt_trace
*trace
= NULL
;
213 trace
= writer
->trace
;
219 struct bt_stream
*bt_ctf_writer_create_stream(struct bt_ctf_writer
*writer
,
220 struct bt_stream_class
*stream_class
)
222 struct bt_stream
*stream
= NULL
;
223 int stream_class_count
;
224 bt_bool stream_class_found
= BT_FALSE
;
227 if (!writer
|| !stream_class
) {
231 /* Make sure the stream class is part of the writer's trace */
232 stream_class_count
= bt_trace_get_stream_class_count(writer
->trace
);
233 if (stream_class_count
< 0) {
237 for (i
= 0; i
< stream_class_count
; i
++) {
238 struct bt_stream_class
*existing_stream_class
=
239 bt_trace_get_stream_class_by_index(
242 if (existing_stream_class
== stream_class
) {
243 stream_class_found
= BT_TRUE
;
246 BT_PUT(existing_stream_class
);
248 if (stream_class_found
) {
253 if (!stream_class_found
) {
254 int ret
= bt_trace_add_stream_class(writer
->trace
,
262 stream
= bt_stream_create(stream_class
, NULL
);
274 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer
*writer
,
280 if (!writer
|| !name
|| !value
) {
284 ret
= bt_trace_set_environment_field_string(writer
->trace
,
290 int bt_ctf_writer_add_environment_field_int64(struct bt_ctf_writer
*writer
,
291 const char *name
, int64_t value
)
295 if (!writer
|| !name
) {
299 ret
= bt_trace_set_environment_field_integer(writer
->trace
, name
,
305 int bt_ctf_writer_add_clock(struct bt_ctf_writer
*writer
,
306 struct bt_ctf_clock
*clock
)
310 if (!writer
|| !clock
) {
314 ret
= bt_trace_add_clock_class(writer
->trace
, clock
->clock_class
);
319 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer
*writer
)
321 char *metadata_string
= NULL
;
327 metadata_string
= bt_trace_get_metadata_string(
330 return metadata_string
;
333 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer
*writer
)
336 char *metadata_string
= NULL
;
342 metadata_string
= bt_trace_get_metadata_string(
344 if (!metadata_string
) {
348 if (lseek(writer
->metadata_fd
, 0, SEEK_SET
) == (off_t
)-1) {
353 if (ftruncate(writer
->metadata_fd
, 0)) {
358 ret
= write(writer
->metadata_fd
, metadata_string
,
359 strlen(metadata_string
));
365 g_free(metadata_string
);
368 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer
*writer
,
369 enum bt_byte_order byte_order
)
373 if (!writer
|| writer
->frozen
) {
378 if (byte_order
== BT_BYTE_ORDER_NATIVE
) {
379 byte_order
= BT_MY_BYTE_ORDER
;
382 ret
= bt_trace_set_native_byte_order(writer
->trace
,
388 void bt_ctf_writer_get(struct bt_ctf_writer
*writer
)
393 void bt_ctf_writer_put(struct bt_ctf_writer
*writer
)
399 void bt_ctf_writer_freeze(struct bt_ctf_writer
*writer
)