lib/babeltrace/ctf-writer/writer-internal.h

   1 #ifndef BABELTRACE_CTF_WRITER_WRITER_INTERNAL_H
   2 #define BABELTRACE_CTF_WRITER_WRITER_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF Writer: Writer internal
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/ctf-writer/ref-internal.h>
  31 #include <babeltrace/ctf-writer/writer.h>
  32 #include <babeltrace/ctf-writer/event-types.h>
  33 #include <babeltrace/ctf-writer/event-fields.h>
  34 #include <babeltrace/babeltrace-internal.h>
  35 #include <glib.h>
  36 #include <dirent.h>
  37 #include <sys/types.h>
  38 #include <uuid/uuid.h>
  39
  40 enum field_type_alias {
  41         FIELD_TYPE_ALIAS_UINT5_T = 0,
  42         FIELD_TYPE_ALIAS_UINT8_T,
  43         FIELD_TYPE_ALIAS_UINT16_T,
  44         FIELD_TYPE_ALIAS_UINT27_T,
  45         FIELD_TYPE_ALIAS_UINT32_T,
  46         FIELD_TYPE_ALIAS_UINT64_T,
  47         NR_FIELD_TYPE_ALIAS,
  48 };
  49
  50 struct bt_ctf_writer {
  51         struct bt_ctf_ref ref_count;
  52         int frozen; /* Protects attributes that can't be changed mid-trace */
  53         GString *path;
  54         uuid_t uuid;
  55         int byte_order;
  56         int trace_dir_fd;
  57         int metadata_fd;
  58         GPtrArray *environment; /* Array of pointers to environment_variable */
  59         GPtrArray *clocks; /* Array of pointers to bt_ctf_clock */
  60         GPtrArray *stream_classes; /* Array of pointers to bt_ctf_stream_class */
  61         GPtrArray *streams; /* Array of pointers to bt_ctf_stream */
  62         struct bt_ctf_field_type *trace_packet_header_type;
  63         struct bt_ctf_field *trace_packet_header;
  64         uint64_t next_stream_id;
  65 };
  66
  67 struct environment_variable {
  68         GString *name, *value;
  69 };
  70
  71 struct metadata_context {
  72         GString *string;
  73         GString *field_name;
  74         unsigned int current_indentation_level;
  75 };
  76
  77 /* Checks that the string does not contain a reserved keyword */
  78 BT_HIDDEN
  79 int validate_identifier(const char *string);
  80
  81 BT_HIDDEN
  82 const char *get_byte_order_string(int byte_order);
  83
  84 BT_HIDDEN
  85 struct bt_ctf_field_type *get_field_type(enum field_type_alias alias);
  86
  87 #endif /* BABELTRACE_CTF_WRITER_WRITER_INTERNAL_H */