formats/ctf/writer/writer.c

   1 /*
   2  * writer.c
   3  *
   4  * Babeltrace CTF Writer
   5  *
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  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:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  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
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/ctf-ir/clock-internal.h>
  30 #include <babeltrace/ctf-writer/writer-internal.h>
  31 #include <babeltrace/ctf-ir/event-types-internal.h>
  32 #include <babeltrace/ctf-ir/event-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/ref.h>
  37 #include <babeltrace/compiler.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <sys/stat.h>
  41 #include <errno.h>
  42 #include <unistd.h>
  43 #include <fcntl.h>
  44 #include <inttypes.h>
  45
  46 static
  47 void bt_ctf_writer_destroy(struct bt_object *obj);
  48
  49 static
  50 int create_stream_file(struct bt_ctf_writer *writer,
  51                 struct bt_ctf_stream *stream);
  52
  53 struct bt_ctf_writer *bt_ctf_writer_create(const char *path)
  54 {
  55         struct bt_ctf_writer *writer = NULL;
  56
  57         if (!path) {
  58                 goto error;
  59         }
  60
  61         writer = g_new0(struct bt_ctf_writer, 1);
  62         if (!writer) {
  63                 goto error;
  64         }
  65
  66         bt_object_init(writer, bt_ctf_writer_destroy);
  67         writer->path = g_string_new(path);
  68         if (!writer->path) {
  69                 goto error_destroy;
  70         }
  71
  72         writer->trace = bt_ctf_trace_create();
  73         if (!writer->trace) {
  74                 goto error_destroy;
  75         }
  76
  77         bt_object_set_parent(writer->trace, writer);
  78         bt_put(writer->trace);
  79         /* Create trace directory if necessary and open a metadata file */
  80         if (g_mkdir_with_parents(path, S_IRWXU | S_IRWXG)) {
  81                 perror("g_mkdir_with_parents");
  82                 goto error_destroy;
  83         }
  84
  85         writer->trace_dir_fd = open(path, O_RDONLY, S_IRWXU | S_IRWXG);
  86         if (writer->trace_dir_fd < 0) {
  87                 perror("open");
  88                 goto error_destroy;
  89         }
  90
  91         writer->metadata_fd = openat(writer->trace_dir_fd, "metadata",
  92                 O_WRONLY | O_CREAT | O_TRUNC,
  93                 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
  94
  95         return writer;
  96
  97 error_destroy:
  98         unlinkat(writer->trace_dir_fd, "metadata", 0);
  99         BT_PUT(writer);
 100 error:
 101         return writer;
 102 }
 103
 104 void bt_ctf_writer_destroy(struct bt_object *obj)
 105 {
 106         struct bt_ctf_writer *writer;
 107
 108         writer = container_of(obj, struct bt_ctf_writer, base);
 109         bt_ctf_writer_flush_metadata(writer);
 110         if (writer->path) {
 111                 g_string_free(writer->path, TRUE);
 112         }
 113
 114         if (writer->trace_dir_fd > 0) {
 115                 if (close(writer->trace_dir_fd)) {
 116                         perror("close");
 117                 }
 118         }
 119
 120         if (writer->metadata_fd > 0) {
 121                 if (close(writer->metadata_fd)) {
 122                         perror("close");
 123                 }
 124         }
 125
 126         bt_object_release(writer->trace);
 127         g_free(writer);
 128 }
 129
 130 struct bt_ctf_trace *bt_ctf_writer_get_trace(struct bt_ctf_writer *writer)
 131 {
 132         struct bt_ctf_trace *trace = NULL;
 133
 134         if (!writer) {
 135                 goto end;
 136         }
 137
 138         trace = writer->trace;
 139         bt_get(trace);
 140 end:
 141         return trace;
 142 }
 143
 144 struct bt_ctf_stream *bt_ctf_writer_create_stream(struct bt_ctf_writer *writer,
 145                 struct bt_ctf_stream_class *stream_class)
 146 {
 147         int stream_fd;
 148         struct bt_ctf_stream *stream = NULL;
 149
 150         if (!writer || !stream_class) {
 151                 goto error;
 152         }
 153
 154         stream = bt_ctf_trace_create_stream(writer->trace, stream_class);
 155         if (!stream) {
 156                 goto error;
 157         }
 158
 159         stream_fd = create_stream_file(writer, stream);
 160         if (stream_fd < 0 || bt_ctf_stream_set_fd(stream, stream_fd)) {
 161                 goto error;
 162         }
 163
 164         writer->frozen = 1;
 165         return stream;
 166
 167 error:
 168         BT_PUT(stream);
 169         return stream;
 170 }
 171
 172 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer,
 173                 const char *name,
 174                 const char *value)
 175 {
 176         int ret = -1;
 177
 178         if (!writer || !name || !value) {
 179                 goto end;
 180         }
 181
 182         ret = bt_ctf_trace_set_environment_field_string(writer->trace,
 183                 name, value);
 184 end:
 185         return ret;
 186 }
 187
 188 int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer,
 189                 struct bt_ctf_clock *clock)
 190 {
 191         int ret = -1;
 192
 193         if (!writer || !clock) {
 194                 goto end;
 195         }
 196
 197         ret = bt_ctf_trace_add_clock(writer->trace, clock);
 198 end:
 199         return ret;
 200 }
 201
 202 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer)
 203 {
 204         char *metadata_string = NULL;
 205
 206         if (!writer) {
 207                 goto end;
 208         }
 209
 210         metadata_string = bt_ctf_trace_get_metadata_string(
 211                 writer->trace);
 212 end:
 213         return metadata_string;
 214 }
 215
 216 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer)
 217 {
 218         int ret;
 219         char *metadata_string = NULL;
 220
 221         if (!writer) {
 222                 goto end;
 223         }
 224
 225         metadata_string = bt_ctf_trace_get_metadata_string(
 226                 writer->trace);
 227         if (!metadata_string) {
 228                 goto end;
 229         }
 230
 231         if (lseek(writer->metadata_fd, 0, SEEK_SET) == (off_t)-1) {
 232                 perror("lseek");
 233                 goto end;
 234         }
 235
 236         if (ftruncate(writer->metadata_fd, 0)) {
 237                 perror("ftruncate");
 238                 goto end;
 239         }
 240
 241         ret = write(writer->metadata_fd, metadata_string,
 242                 strlen(metadata_string));
 243         if (ret < 0) {
 244                 perror("write");
 245                 goto end;
 246         }
 247 end:
 248         g_free(metadata_string);
 249 }
 250
 251 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer,
 252                 enum bt_ctf_byte_order byte_order)
 253 {
 254         int ret = 0;
 255
 256         if (!writer || writer->frozen) {
 257                 ret = -1;
 258                 goto end;
 259         }
 260
 261         ret = bt_ctf_trace_set_byte_order(writer->trace,
 262                 byte_order);
 263 end:
 264         return ret;
 265 }
 266
 267 void bt_ctf_writer_get(struct bt_ctf_writer *writer)
 268 {
 269         bt_get(writer);
 270 }
 271
 272 void bt_ctf_writer_put(struct bt_ctf_writer *writer)
 273 {
 274         bt_put(writer);
 275 }
 276
 277 static
 278 int create_stream_file(struct bt_ctf_writer *writer,
 279                 struct bt_ctf_stream *stream)
 280 {
 281         int fd;
 282         GString *filename = g_string_new(stream->stream_class->name->str);
 283
 284         if (stream->stream_class->name->len == 0) {
 285                 int64_t ret;
 286
 287                 ret = bt_ctf_stream_class_get_id(stream->stream_class);
 288                 if (ret < 0) {
 289                         fd = -1;
 290                         goto error;
 291                 }
 292
 293                 g_string_printf(filename, "stream_%" PRId64, ret);
 294         }
 295
 296         g_string_append_printf(filename, "_%" PRIu32, stream->id);
 297         fd = openat(writer->trace_dir_fd, filename->str,
 298                 O_RDWR | O_CREAT | O_TRUNC,
 299                 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
 300 error:
 301         g_string_free(filename, TRUE);
 302         return fd;
 303 }