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>
49 void bt_ctf_writer_destroy(struct bt_object
*obj
);
51 struct bt_ctf_writer
*bt_ctf_writer_create(const char *path
)
54 struct bt_ctf_writer
*writer
= NULL
;
60 writer
= g_new0(struct bt_ctf_writer
, 1);
65 bt_object_init(writer
, bt_ctf_writer_destroy
);
66 writer
->path
= g_string_new(path
);
71 writer
->trace
= bt_ctf_trace_create();
76 writer
->trace
->is_created_by_writer
= 1;
77 bt_object_set_parent(writer
->trace
, writer
);
78 bt_put(writer
->trace
);
80 /* Default to little-endian */
81 ret
= bt_ctf_writer_set_byte_order(writer
, BT_CTF_BYTE_ORDER_NATIVE
);
84 /* Create trace directory if necessary and open a metadata file */
85 if (g_mkdir_with_parents(path
, S_IRWXU
| S_IRWXG
)) {
86 perror("g_mkdir_with_parents");
90 writer
->trace_dir_fd
= open(path
, O_RDONLY
, S_IRWXU
| S_IRWXG
);
91 if (writer
->trace_dir_fd
< 0) {
96 writer
->metadata_fd
= openat(writer
->trace_dir_fd
, "metadata",
97 O_WRONLY
| O_CREAT
| O_TRUNC
,
98 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
103 unlinkat(writer
->trace_dir_fd
, "metadata", 0);
109 void bt_ctf_writer_destroy(struct bt_object
*obj
)
111 struct bt_ctf_writer
*writer
;
113 writer
= container_of(obj
, struct bt_ctf_writer
, base
);
114 bt_ctf_writer_flush_metadata(writer
);
116 g_string_free(writer
->path
, TRUE
);
119 if (writer
->trace_dir_fd
> 0) {
120 if (close(writer
->trace_dir_fd
)) {
125 if (writer
->metadata_fd
> 0) {
126 if (close(writer
->metadata_fd
)) {
131 bt_object_release(writer
->trace
);
135 struct bt_ctf_trace
*bt_ctf_writer_get_trace(struct bt_ctf_writer
*writer
)
137 struct bt_ctf_trace
*trace
= NULL
;
143 trace
= writer
->trace
;
149 struct bt_ctf_stream
*bt_ctf_writer_create_stream(struct bt_ctf_writer
*writer
,
150 struct bt_ctf_stream_class
*stream_class
)
152 struct bt_ctf_stream
*stream
= NULL
;
153 int stream_class_count
;
154 bool stream_class_found
= false;
157 if (!writer
|| !stream_class
) {
161 /* Make sure the stream class is part of the writer's trace */
162 stream_class_count
= bt_ctf_trace_get_stream_class_count(writer
->trace
);
163 if (stream_class_count
< 0) {
167 for (i
= 0; i
< stream_class_count
; i
++) {
168 struct bt_ctf_stream_class
*existing_stream_class
=
169 bt_ctf_trace_get_stream_class(writer
->trace
, i
);
171 if (existing_stream_class
== stream_class
) {
172 stream_class_found
= true;
175 BT_PUT(existing_stream_class
);
177 if (stream_class_found
) {
182 if (!stream_class_found
) {
183 int ret
= bt_ctf_trace_add_stream_class(writer
->trace
,
191 stream
= bt_ctf_stream_create(stream_class
, NULL
);
203 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer
*writer
,
209 if (!writer
|| !name
|| !value
) {
213 ret
= bt_ctf_trace_set_environment_field_string(writer
->trace
,
219 int bt_ctf_writer_add_environment_field_int64(struct bt_ctf_writer
*writer
,
225 if (!writer
|| !name
) {
229 ret
= bt_ctf_trace_set_environment_field_integer(writer
->trace
, name
,
235 int bt_ctf_writer_add_clock(struct bt_ctf_writer
*writer
,
236 struct bt_ctf_clock
*clock
)
240 if (!writer
|| !clock
) {
244 ret
= bt_ctf_trace_add_clock_class(writer
->trace
, clock
->clock_class
);
249 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer
*writer
)
251 char *metadata_string
= NULL
;
257 metadata_string
= bt_ctf_trace_get_metadata_string(
260 return metadata_string
;
263 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer
*writer
)
266 char *metadata_string
= NULL
;
272 metadata_string
= bt_ctf_trace_get_metadata_string(
274 if (!metadata_string
) {
278 if (lseek(writer
->metadata_fd
, 0, SEEK_SET
) == (off_t
)-1) {
283 if (ftruncate(writer
->metadata_fd
, 0)) {
288 ret
= write(writer
->metadata_fd
, metadata_string
,
289 strlen(metadata_string
));
295 g_free(metadata_string
);
298 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer
*writer
,
299 enum bt_ctf_byte_order byte_order
)
303 if (!writer
|| writer
->frozen
) {
308 if (byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
309 byte_order
= BT_CTF_MY_BYTE_ORDER
;
312 ret
= bt_ctf_trace_set_native_byte_order(writer
->trace
,
318 void bt_ctf_writer_get(struct bt_ctf_writer
*writer
)
323 void bt_ctf_writer_put(struct bt_ctf_writer
*writer
)
329 void bt_ctf_writer_freeze(struct bt_ctf_writer
*writer
)