src/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 #define BT_LOG_TAG "CTF-WRITER"
  30 #include "logging.h"
  31
  32 #include <errno.h>
  33 #include <fcntl.h>
  34 #include <inttypes.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <sys/stat.h>
  38 #include <unistd.h>
  39
  40 #include <babeltrace2/ctf-writer/object.h>
  41
  42 #include "common/assert.h"
  43 #include "compat/compiler.h"
  44 #include "compat/endian.h"
  45 #include "compat/uuid.h"
  46
  47 #include "clock.h"
  48 #include "fields.h"
  49 #include "field-types.h"
  50 #include "functor.h"
  51 #include "stream-class.h"
  52 #include "stream.h"
  53 #include "trace.h"
  54 #include "writer.h"
  55
  56 static
  57 void bt_ctf_writer_destroy(struct bt_ctf_object *obj);
  58
  59 static
  60 int init_trace_packet_header(struct bt_ctf_trace *trace)
  61 {
  62         int ret = 0;
  63         struct bt_ctf_field_type *_uint32_t =
  64                 get_field_type(FIELD_TYPE_ALIAS_UINT32_T);
  65         struct bt_ctf_field_type *_uint8_t =
  66                 get_field_type(FIELD_TYPE_ALIAS_UINT8_T);
  67         struct bt_ctf_field_type *trace_packet_header_type =
  68                 bt_ctf_field_type_structure_create();
  69         struct bt_ctf_field_type *uuid_array_type =
  70                 bt_ctf_field_type_array_create(_uint8_t, 16);
  71
  72         if (!trace_packet_header_type || !uuid_array_type) {
  73                 ret = -1;
  74                 goto end;
  75         }
  76
  77         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
  78                 _uint32_t, "magic");
  79         if (ret) {
  80                 goto end;
  81         }
  82
  83         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
  84                 uuid_array_type, "uuid");
  85         if (ret) {
  86                 goto end;
  87         }
  88
  89         ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
  90                 _uint32_t, "stream_id");
  91         if (ret) {
  92                 goto end;
  93         }
  94
  95         ret = bt_ctf_trace_set_packet_header_field_type(trace,
  96                 trace_packet_header_type);
  97         if (ret) {
  98                 goto end;
  99         }
 100 end:
 101         bt_ctf_object_put_ref(uuid_array_type);
 102         bt_ctf_object_put_ref(_uint32_t);
 103         bt_ctf_object_put_ref(_uint8_t);
 104         bt_ctf_object_put_ref(trace_packet_header_type);
 105         return ret;
 106 }
 107
 108 struct bt_ctf_writer *bt_ctf_writer_create(const char *path)
 109 {
 110         int ret;
 111         struct bt_ctf_writer *writer = NULL;
 112         unsigned char uuid[16];
 113         char *metadata_path = NULL;
 114
 115         if (!path) {
 116                 goto error;
 117         }
 118
 119         writer = g_new0(struct bt_ctf_writer, 1);
 120         if (!writer) {
 121                 goto error;
 122         }
 123
 124         metadata_path = g_build_filename(path, "metadata", NULL);
 125
 126         bt_ctf_object_init_shared(&writer->base, bt_ctf_writer_destroy);
 127         writer->path = g_string_new(path);
 128         if (!writer->path) {
 129                 goto error_destroy;
 130         }
 131
 132         writer->trace = bt_ctf_trace_create();
 133         if (!writer->trace) {
 134                 goto error_destroy;
 135         }
 136
 137         ret = init_trace_packet_header(writer->trace);
 138         if (ret) {
 139                 goto error_destroy;
 140         }
 141
 142         /* Generate a UUID for this writer's trace */
 143         ret = bt_uuid_generate(uuid);
 144         if (ret) {
 145                 BT_LOGE_STR("Cannot generate UUID for CTF writer's trace.");
 146                 goto error_destroy;
 147         }
 148
 149         ret = bt_ctf_trace_set_uuid(writer->trace, uuid);
 150         if (ret) {
 151                 goto error_destroy;
 152         }
 153
 154         bt_ctf_object_set_parent(&writer->trace->common.base, &writer->base);
 155         bt_ctf_object_put_ref(writer->trace);
 156
 157         /* Default to little-endian */
 158         ret = bt_ctf_writer_set_byte_order(writer, BT_CTF_BYTE_ORDER_NATIVE);
 159         BT_ASSERT(ret == 0);
 160
 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");
 164                 goto error_destroy;
 165         }
 166
 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) {
 171                 perror("open");
 172                 goto error_destroy;
 173         }
 174
 175         g_free(metadata_path);
 176         return writer;
 177
 178 error_destroy:
 179         BT_CTF_OBJECT_PUT_REF_AND_RESET(writer);
 180 error:
 181         g_free(metadata_path);
 182         return writer;
 183 }
 184
 185 void bt_ctf_writer_destroy(struct bt_ctf_object *obj)
 186 {
 187         struct bt_ctf_writer *writer;
 188
 189         writer = container_of(obj, struct bt_ctf_writer, base);
 190         bt_ctf_writer_flush_metadata(writer);
 191         if (writer->path) {
 192                 g_string_free(writer->path, TRUE);
 193         }
 194
 195         if (writer->metadata_fd > 0) {
 196                 if (close(writer->metadata_fd)) {
 197                         perror("close");
 198                 }
 199         }
 200
 201         bt_ctf_object_try_spec_release(&writer->trace->common.base);
 202         g_free(writer);
 203 }
 204
 205 struct bt_ctf_trace *bt_ctf_writer_get_trace(struct bt_ctf_writer *writer)
 206 {
 207         struct bt_ctf_trace *trace = NULL;
 208
 209         if (!writer) {
 210                 goto end;
 211         }
 212
 213         trace = writer->trace;
 214         bt_ctf_object_get_ref(trace);
 215 end:
 216         return trace;
 217 }
 218
 219 struct bt_ctf_stream *bt_ctf_writer_create_stream(struct bt_ctf_writer *writer,
 220                 struct bt_ctf_stream_class *stream_class)
 221 {
 222         struct bt_ctf_stream *stream = NULL;
 223         int stream_class_count;
 224         bt_bool stream_class_found = BT_FALSE;
 225         int i;
 226
 227         if (!writer || !stream_class) {
 228                 goto error;
 229         }
 230
 231         /* Make sure the stream class is part of the writer's trace */
 232         stream_class_count = bt_ctf_trace_get_stream_class_count(writer->trace);
 233         if (stream_class_count < 0) {
 234                 goto error;
 235         }
 236
 237         for (i = 0; i < stream_class_count; i++) {
 238                 struct bt_ctf_stream_class *existing_stream_class =
 239                         bt_ctf_trace_get_stream_class_by_index(
 240                                 writer->trace, i);
 241
 242                 if (existing_stream_class == stream_class) {
 243                         stream_class_found = BT_TRUE;
 244                 }
 245
 246                 BT_CTF_OBJECT_PUT_REF_AND_RESET(existing_stream_class);
 247
 248                 if (stream_class_found) {
 249                         break;
 250                 }
 251         }
 252
 253         if (!stream_class_found) {
 254                 int ret = bt_ctf_trace_add_stream_class(writer->trace,
 255                         stream_class);
 256
 257                 if (ret) {
 258                         goto error;
 259                 }
 260         }
 261
 262         stream = bt_ctf_stream_create_with_id(stream_class, NULL, -1ULL);
 263         if (!stream) {
 264                 goto error;
 265         }
 266
 267         return stream;
 268
 269 error:
 270         BT_CTF_OBJECT_PUT_REF_AND_RESET(stream);
 271         return stream;
 272 }
 273
 274 int bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer,
 275                 const char *name,
 276                 const char *value)
 277 {
 278         int ret = -1;
 279
 280         if (!writer || !name || !value) {
 281                 goto end;
 282         }
 283
 284         ret = bt_ctf_trace_set_environment_field_string(writer->trace,
 285                 name, value);
 286 end:
 287         return ret;
 288 }
 289
 290 int bt_ctf_writer_add_environment_field_int64(struct bt_ctf_writer *writer,
 291                 const char *name, int64_t value)
 292 {
 293         int ret = -1;
 294
 295         if (!writer || !name) {
 296                 goto end;
 297         }
 298
 299         ret = bt_ctf_trace_set_environment_field_integer(writer->trace, name,
 300                 value);
 301 end:
 302         return ret;
 303 }
 304
 305 int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer,
 306                 struct bt_ctf_clock *clock)
 307 {
 308         int ret = -1;
 309
 310         if (!writer || !clock) {
 311                 goto end;
 312         }
 313
 314         ret = bt_ctf_trace_add_clock_class(writer->trace, clock->clock_class);
 315 end:
 316         return ret;
 317 }
 318
 319 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer)
 320 {
 321         char *metadata_string = NULL;
 322
 323         if (!writer) {
 324                 goto end;
 325         }
 326
 327         metadata_string = bt_ctf_trace_get_metadata_string(
 328                 writer->trace);
 329 end:
 330         return metadata_string;
 331 }
 332
 333 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer)
 334 {
 335         int ret;
 336         char *metadata_string = NULL;
 337
 338         if (!writer) {
 339                 goto end;
 340         }
 341
 342         metadata_string = bt_ctf_trace_get_metadata_string(
 343                 writer->trace);
 344         if (!metadata_string) {
 345                 goto end;
 346         }
 347
 348         if (lseek(writer->metadata_fd, 0, SEEK_SET) == (off_t)-1) {
 349                 perror("lseek");
 350                 goto end;
 351         }
 352
 353         if (ftruncate(writer->metadata_fd, 0)) {
 354                 perror("ftruncate");
 355                 goto end;
 356         }
 357
 358         ret = write(writer->metadata_fd, metadata_string,
 359                 strlen(metadata_string));
 360         if (ret < 0) {
 361                 perror("write");
 362                 goto end;
 363         }
 364 end:
 365         g_free(metadata_string);
 366 }
 367
 368 int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer,
 369                 enum bt_ctf_byte_order byte_order)
 370 {
 371         int ret = 0;
 372
 373         if (!writer || writer->frozen) {
 374                 ret = -1;
 375                 goto end;
 376         }
 377
 378         if (byte_order == BT_CTF_BYTE_ORDER_NATIVE) {
 379                 if (BYTE_ORDER == LITTLE_ENDIAN) {
 380                         byte_order = BT_CTF_BYTE_ORDER_LITTLE_ENDIAN;
 381                 } else {
 382                         byte_order = BT_CTF_BYTE_ORDER_BIG_ENDIAN;
 383                 }
 384         }
 385
 386         ret = bt_ctf_trace_set_native_byte_order(writer->trace,
 387                 byte_order);
 388 end:
 389         return ret;
 390 }
 391
 392 BT_HIDDEN
 393 void bt_ctf_writer_freeze(struct bt_ctf_writer *writer)
 394 {
 395         writer->frozen = 1;
 396 }
 397
 398 static
 399 const unsigned int field_type_aliases_alignments[] = {
 400         [FIELD_TYPE_ALIAS_UINT5_T] = 1,
 401         [FIELD_TYPE_ALIAS_UINT8_T ... FIELD_TYPE_ALIAS_UINT16_T] = 8,
 402         [FIELD_TYPE_ALIAS_UINT27_T] = 1,
 403         [FIELD_TYPE_ALIAS_UINT32_T ... FIELD_TYPE_ALIAS_UINT64_T] = 8,
 404 };
 405
 406 static
 407 const unsigned int field_type_aliases_sizes[] = {
 408         [FIELD_TYPE_ALIAS_UINT5_T] = 5,
 409         [FIELD_TYPE_ALIAS_UINT8_T] = 8,
 410         [FIELD_TYPE_ALIAS_UINT16_T] = 16,
 411         [FIELD_TYPE_ALIAS_UINT27_T] = 27,
 412         [FIELD_TYPE_ALIAS_UINT32_T] = 32,
 413         [FIELD_TYPE_ALIAS_UINT64_T] = 64,
 414 };
 415
 416 BT_HIDDEN
 417 struct bt_ctf_field_type *get_field_type(enum field_type_alias alias)
 418 {
 419         int ret;
 420         unsigned int alignment, size;
 421         struct bt_ctf_field_type *field_type = NULL;
 422
 423         if (alias >= NR_FIELD_TYPE_ALIAS) {
 424                 goto end;
 425         }
 426
 427         alignment = field_type_aliases_alignments[alias];
 428         size = field_type_aliases_sizes[alias];
 429         field_type = bt_ctf_field_type_integer_create(size);
 430         ret = bt_ctf_field_type_set_alignment(field_type, alignment);
 431         if (ret) {
 432                 BT_CTF_OBJECT_PUT_REF_AND_RESET(field_type);
 433         }
 434 end:
 435         return field_type;
 436 }
 437
 438 BT_HIDDEN
 439 const char *bt_ctf_get_byte_order_string(enum bt_ctf_byte_order byte_order)
 440 {
 441         const char *string;
 442
 443         switch (byte_order) {
 444         case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
 445                 string = "le";
 446                 break;
 447         case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
 448                 string = "be";
 449                 break;
 450         case BT_CTF_BYTE_ORDER_NATIVE:
 451                 string = "native";
 452                 break;
 453         default:
 454                 abort();
 455         }
 456
 457         return string;
 458 }