include/babeltrace/ctf-ir/event-types-internal.h

   1 #ifndef BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Event types 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/event-types.h>
  31 #include <babeltrace/ctf-writer/ref-internal.h>
  32 #include <babeltrace/ctf-writer/event-fields.h>
  33 #include <babeltrace/ctf-writer/writer.h>
  34 #include <babeltrace/ctf-ir/trace-internal.h>
  35 #include <babeltrace/babeltrace-internal.h>
  36 #include <babeltrace/types.h>
  37 #include <babeltrace/ctf/events.h>
  38 #include <glib.h>
  39
  40 typedef void(*type_freeze_func)(struct bt_ctf_field_type *);
  41 typedef int(*type_serialize_func)(struct bt_ctf_field_type *,
  42                 struct metadata_context *);
  43
  44 struct bt_ctf_field_type {
  45         struct bt_ctf_ref ref_count;
  46         struct bt_declaration *declaration;
  47         GString *alias_name;
  48         type_freeze_func freeze;
  49         type_serialize_func serialize;
  50         /*
  51          * A type can't be modified once it is added to an event or after a
  52          * a field has been instanciated from it.
  53          */
  54         int frozen;
  55 };
  56
  57 struct bt_ctf_field_type_integer {
  58         struct bt_ctf_field_type parent;
  59         struct declaration_integer declaration;
  60         struct bt_ctf_clock *mapped_clock;
  61 };
  62
  63 struct enumeration_mapping {
  64         union {
  65                 uint64_t _unsigned;
  66                 int64_t _signed;
  67         } range_start;
  68
  69         union {
  70                 uint64_t _unsigned;
  71                 int64_t _signed;
  72         } range_end;
  73         GQuark string;
  74 };
  75
  76 struct bt_ctf_field_type_enumeration {
  77         struct bt_ctf_field_type parent;
  78         struct bt_ctf_field_type *container;
  79         GPtrArray *entries; /* Array of pointers to struct enum_mapping */
  80         struct declaration_enum declaration;
  81 };
  82
  83 struct bt_ctf_field_type_floating_point {
  84         struct bt_ctf_field_type parent;
  85         struct declaration_float declaration;
  86         struct declaration_integer sign;
  87         struct declaration_integer mantissa;
  88         struct declaration_integer exp;
  89 };
  90
  91 struct structure_field {
  92         GQuark name;
  93         struct bt_ctf_field_type *type;
  94 };
  95
  96 struct bt_ctf_field_type_structure {
  97         struct bt_ctf_field_type parent;
  98         GHashTable *field_name_to_index;
  99         GPtrArray *fields; /* Array of pointers to struct structure_field */
 100         struct declaration_enum declaration;
 101 };
 102
 103 struct bt_ctf_field_type_variant {
 104         struct bt_ctf_field_type parent;
 105         GString *tag_name;
 106         struct bt_ctf_field_type_enumeration *tag;
 107         GHashTable *field_name_to_index;
 108         GPtrArray *fields; /* Array of pointers to struct structure_field */
 109         struct declaration_variant declaration;
 110 };
 111
 112 struct bt_ctf_field_type_array {
 113         struct bt_ctf_field_type parent;
 114         struct bt_ctf_field_type *element_type;
 115         unsigned int length; /* Number of elements */
 116         struct declaration_array declaration;
 117 };
 118
 119 struct bt_ctf_field_type_sequence {
 120         struct bt_ctf_field_type parent;
 121         struct bt_ctf_field_type *element_type;
 122         GString *length_field_name;
 123         struct declaration_sequence declaration;
 124 };
 125
 126 struct bt_ctf_field_type_string {
 127         struct bt_ctf_field_type parent;
 128         struct declaration_string declaration;
 129 };
 130
 131 BT_HIDDEN
 132 void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);
 133
 134 BT_HIDDEN
 135 struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_signed(
 136                 struct bt_ctf_field_type_variant *variant, int64_t tag_value);
 137
 138 BT_HIDDEN
 139 struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_unsigned(
 140                 struct bt_ctf_field_type_variant *variant, uint64_t tag_value);
 141
 142 BT_HIDDEN
 143 int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
 144                 struct metadata_context *context);
 145
 146 BT_HIDDEN
 147 int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);
 148
 149 BT_HIDDEN
 150 const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
 151                 struct bt_ctf_field_type_enumeration *enumeration_type,
 152                 uint64_t value);
 153
 154 BT_HIDDEN
 155 const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
 156                 struct bt_ctf_field_type_enumeration *enumeration_type,
 157                 int64_t value);
 158
 159 /* Override field type's byte order only if it is set to "native" */
 160 BT_HIDDEN
 161 void bt_ctf_field_type_set_native_byte_order(
 162                 struct bt_ctf_field_type *type, int byte_order);
 163 #endif /* BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H */