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-ir/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/compiler.h>
48 void bt_ctf_writer_destroy(struct bt_object
*obj
);
50 struct bt_ctf_writer
*bt_ctf_writer_create(const char *path
)
52 struct bt_ctf_writer
*writer
= NULL
;
58 writer
= g_new0(struct bt_ctf_writer
, 1);
63 bt_object_init(writer
, bt_ctf_writer_destroy
);
64 writer
->path
= g_string_new(path
);
69 writer
->trace
= bt_ctf_trace_create();
74 writer
->trace
->is_created_by_writer
= 1;
75 bt_object_set_parent(writer
->trace
, writer
);
76 bt_put(writer
->trace
);
77 /* Create trace directory if necessary and open a metadata file */
78 if (g_mkdir_with_parents(path
, S_IRWXU
| S_IRWXG
)) {
79 perror("g_mkdir_with_parents");
83 writer
->trace_dir_fd
= open(path
, O_RDONLY
, S_IRWXU
| S_IRWXG
);
84 if (writer
->trace_dir_fd
< 0) {
89 writer
->metadata_fd
= openat(writer
->trace_dir_fd
, "metadata",
90 O_WRONLY
| O_CREAT
| O_TRUNC
,
91 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
96 unlinkat(writer
->trace_dir_fd
, "metadata", 0);
102 void bt_ctf_writer_destroy(struct bt_object
*obj
)
104 struct bt_ctf_writer
*writer
;
106 writer
= container_of(obj
, struct bt_ctf_writer
, base
);
107 bt_ctf_writer_flush_metadata(writer
);
109 g_string_free(writer
->path
, TRUE
);
112 if (writer
->trace_dir_fd
> 0) {
113 if (close(writer
->trace_dir_fd
)) {
118 if (writer
->metadata_fd
> 0) {
119 if (close(writer
->metadata_fd
)) {
124 bt_object_release(writer
->trace
);
128 struct bt_ctf_trace
*bt_ctf_writer_get_trace(struct bt_ctf_writer
*writer
)
130 struct bt_ctf_trace
*trace
= NULL
;
136 trace
= writer
->trace
;
142 struct bt_ctf_stream
*bt_ctf_writer_create_stream(struct bt_ctf_writer
*writer
,
143 struct bt_ctf_stream_class
*stream_class
)
145 struct bt_ctf_stream
*stream
= NULL
;
146 int stream_class_count
;
147 bool stream_class_found
= false;
150 if (!writer
|| !stream_class
) {
154 /* Make sure the stream class is part of the writer's trace */
155 stream_class_count
= bt_ctf_trace_get_stream_class_count(writer
->trace
);
156 if (stream_class_count
< 0) {
160 for (i
= 0; i
< stream_class_count
; i
++) {
161 struct bt_ctf_stream_class
*existing_stream_class
=
162 bt_ctf_trace_get_stream_class(writer
->trace
, i
);
164 if (existing_stream_class
== stream_class
) {
165 stream_class_found
= true;
168 BT_PUT(existing_stream_class
);
170 if (stream_class_found
) {
175 if (!stream_class_found
) {
176 int ret
= bt_ctf_trace_add_stream_class(writer
->trace
,
184 stream
= bt_ctf_stream_create(stream_class
);
196 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer
*writer
,
202 if (!writer
|| !name
|| !value
) {
206 ret
= bt_ctf_trace_set_environment_field_string(writer
->trace
,
212 int bt_ctf_writer_add_clock(struct bt_ctf_writer
*writer
,
213 struct bt_ctf_clock
*clock
)
217 if (!writer
|| !clock
) {
221 ret
= bt_ctf_trace_add_clock(writer
->trace
, clock
);
226 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer
*writer
)
228 char *metadata_string
= NULL
;
234 metadata_string
= bt_ctf_trace_get_metadata_string(
237 return metadata_string
;
240 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer
*writer
)
243 char *metadata_string
= NULL
;
249 metadata_string
= bt_ctf_trace_get_metadata_string(
251 if (!metadata_string
) {
255 if (lseek(writer
->metadata_fd
, 0, SEEK_SET
) == (off_t
)-1) {
260 if (ftruncate(writer
->metadata_fd
, 0)) {
265 ret
= write(writer
->metadata_fd
, metadata_string
,
266 strlen(metadata_string
));
272 g_free(metadata_string
);
275 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer
*writer
,
276 enum bt_ctf_byte_order byte_order
)
280 if (!writer
|| writer
->frozen
) {
285 ret
= bt_ctf_trace_set_byte_order(writer
->trace
,
291 void bt_ctf_writer_get(struct bt_ctf_writer
*writer
)
296 void bt_ctf_writer_put(struct bt_ctf_writer
*writer
)
302 void bt_ctf_writer_freeze(struct bt_ctf_writer
*writer
)