1 #ifndef BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
2 #define BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
5 * BabelTrace - CTF IR: Event types internal
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 #include <babeltrace/ctf-writer/event-types.h>
31 #include <babeltrace/ctf-writer/event-fields.h>
32 #include <babeltrace/ctf-writer/writer.h>
33 #include <babeltrace/ctf-ir/trace-internal.h>
34 #include <babeltrace/babeltrace-internal.h>
35 #include <babeltrace/object-internal.h>
36 #include <babeltrace/types.h>
37 #include <babeltrace/ctf/events.h>
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
*);
45 CTF_NODE_UNKNOWN
= -1,
47 CTF_NODE_TRACE_PACKET_HEADER
= 1,
48 CTF_NODE_STREAM_PACKET_CONTEXT
= 2,
49 CTF_NODE_STREAM_EVENT_HEADER
= 3,
50 CTF_NODE_STREAM_EVENT_CONTEXT
= 4,
51 CTF_NODE_EVENT_CONTEXT
= 5,
52 CTF_NODE_EVENT_FIELDS
= 6,
55 struct bt_ctf_field_path
{
56 enum bt_ctf_node root
;
58 * Array of integers (int) indicating the index in either
59 * structures or variants that make-up the path to a field.
64 struct bt_ctf_field_type
{
65 struct bt_object base
;
66 struct bt_declaration
*declaration
;
67 type_freeze_func freeze
;
68 type_serialize_func serialize
;
70 * A type can't be modified once it is added to an event or after a
71 * a field has been instanciated from it.
76 * This flag indicates if the field type is valid. A valid
77 * field type is _always_ frozen. All the nested field types of
78 * a valid field type are also valid (and thus frozen).
83 struct bt_ctf_field_type_integer
{
84 struct bt_ctf_field_type parent
;
85 struct declaration_integer declaration
;
86 struct bt_ctf_clock
*mapped_clock
;
89 * This is what the user sets and is never modified by internal
92 * This field must contain a `BT_CTF_BYTE_ORDER_*` value.
94 enum bt_ctf_byte_order user_byte_order
;
97 struct enumeration_mapping
{
110 struct bt_ctf_field_type_enumeration
{
111 struct bt_ctf_field_type parent
;
112 struct bt_ctf_field_type
*container
;
113 GPtrArray
*entries
; /* Array of ptrs to struct enumeration_mapping */
114 struct declaration_enum declaration
;
117 struct bt_ctf_field_type_floating_point
{
118 struct bt_ctf_field_type parent
;
119 struct declaration_float declaration
;
122 * The `declaration` field above contains 3 pointers pointing
123 * to the fields below. This avoids unnecessary dynamic
126 struct declaration_integer sign
;
127 struct declaration_integer mantissa
;
128 struct declaration_integer exp
;
131 * This is what the user sets and is never modified by internal
134 * This field must contain a `BT_CTF_BYTE_ORDER_*` value.
136 enum bt_ctf_byte_order user_byte_order
;
139 struct structure_field
{
141 struct bt_ctf_field_type
*type
;
144 struct bt_ctf_field_type_structure
{
145 struct bt_ctf_field_type parent
;
146 GHashTable
*field_name_to_index
;
147 GPtrArray
*fields
; /* Array of pointers to struct structure_field */
148 struct declaration_struct declaration
;
151 struct bt_ctf_field_type_variant
{
152 struct bt_ctf_field_type parent
;
154 struct bt_ctf_field_type_enumeration
*tag
;
155 struct bt_ctf_field_path
*tag_path
;
156 GHashTable
*field_name_to_index
;
157 GPtrArray
*fields
; /* Array of pointers to struct structure_field */
158 struct declaration_variant declaration
;
161 struct bt_ctf_field_type_array
{
162 struct bt_ctf_field_type parent
;
163 struct bt_ctf_field_type
*element_type
;
164 unsigned int length
; /* Number of elements */
165 struct declaration_array declaration
;
168 struct bt_ctf_field_type_sequence
{
169 struct bt_ctf_field_type parent
;
170 struct bt_ctf_field_type
*element_type
;
171 GString
*length_field_name
;
172 struct bt_ctf_field_path
*length_field_path
;
173 struct declaration_sequence declaration
;
176 struct bt_ctf_field_type_string
{
177 struct bt_ctf_field_type parent
;
178 struct declaration_string declaration
;
182 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
);
185 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
186 struct bt_ctf_field_type_variant
*variant
, int64_t tag_value
);
189 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
190 struct bt_ctf_field_type_variant
*variant
, uint64_t tag_value
);
193 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
194 struct metadata_context
*context
);
197 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
);
200 const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
201 struct bt_ctf_field_type_enumeration
*enumeration_type
,
205 const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
206 struct bt_ctf_field_type_enumeration
*enumeration_type
,
209 /* Override field type's byte order only if it is set to "native" */
211 void bt_ctf_field_type_set_native_byte_order(
212 struct bt_ctf_field_type
*type
, int byte_order
);
214 /* Deep copy a field type */
216 struct bt_ctf_field_type
*bt_ctf_field_type_copy(
217 struct bt_ctf_field_type
*type
);
220 struct bt_ctf_field_path
*bt_ctf_field_path_create(void);
223 struct bt_ctf_field_path
*bt_ctf_field_path_copy(
224 struct bt_ctf_field_path
*path
);
227 void bt_ctf_field_path_destroy(struct bt_ctf_field_path
*path
);
230 int bt_ctf_field_type_structure_get_field_name_index(
231 struct bt_ctf_field_type
*structure
, const char *name
);
233 /* Replace an existing field's type in a structure */
235 int bt_ctf_field_type_structure_set_field_index(
236 struct bt_ctf_field_type
*structure
,
237 struct bt_ctf_field_type
*field
, int index
);
240 int bt_ctf_field_type_variant_get_field_name_index(
241 struct bt_ctf_field_type
*variant
, const char *name
);
244 int bt_ctf_field_type_sequence_set_length_field_path(
245 struct bt_ctf_field_type
*type
,
246 struct bt_ctf_field_path
*path
);
249 struct bt_ctf_field_path
*bt_ctf_field_type_sequence_get_length_field_path(
250 struct bt_ctf_field_type
*type
);
253 int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type
*type
,
254 struct bt_ctf_field_path
*path
);
257 struct bt_ctf_field_path
*bt_ctf_field_type_variant_get_tag_field_path(
258 struct bt_ctf_field_type
*type
);
261 int bt_ctf_field_type_variant_set_tag(struct bt_ctf_field_type
*type
,
262 struct bt_ctf_field_type
*tag
);
264 /* Replace an existing field's type in a variant */
266 int bt_ctf_field_type_variant_set_field_index(
267 struct bt_ctf_field_type
*variant
,
268 struct bt_ctf_field_type
*field
, int index
);
271 int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type
*array
,
272 struct bt_ctf_field_type
*element_type
);
275 int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type
*array
,
276 struct bt_ctf_field_type
*element_type
);
278 #endif /* BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H */