Commit | Line | Data |
---|---|---|
d79865b9 MD |
1 | #ifndef _BABELTRACE_TYPES_H |
2 | #define _BABELTRACE_TYPES_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
fc93b2bd | 7 | * Type Header |
d79865b9 | 8 | * |
64fa3fec MD |
9 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation |
10 | * | |
11 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
d79865b9 | 12 | * |
ccd7e1c8 MD |
13 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
14 | * of this software and associated documentation files (the "Software"), to deal | |
15 | * in the Software without restriction, including without limitation the rights | |
16 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
17 | * copies of the Software, and to permit persons to whom the Software is | |
18 | * furnished to do so, subject to the following conditions: | |
d79865b9 | 19 | * |
ccd7e1c8 MD |
20 | * The above copyright notice and this permission notice shall be included in |
21 | * all copies or substantial portions of the Software. | |
c462e188 MD |
22 | * |
23 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
24 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
25 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
26 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
27 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
28 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
29 | * SOFTWARE. | |
d79865b9 MD |
30 | */ |
31 | ||
bed864a7 | 32 | #include <babeltrace/align.h> |
d65d8abb | 33 | #include <babeltrace/list.h> |
9843982d | 34 | #include <babeltrace/ctf/events.h> |
4c8bfb7e MD |
35 | #include <stdbool.h> |
36 | #include <stdint.h> | |
8099326b | 37 | #include <babeltrace/compat/limits.h> |
bed864a7 | 38 | #include <string.h> |
4c8bfb7e | 39 | #include <glib.h> |
8eab883c | 40 | #include <assert.h> |
bed864a7 | 41 | |
11796b96 MD |
42 | /* Preallocate this many fields for structures */ |
43 | #define DEFAULT_NR_STRUCT_FIELDS 8 | |
44 | ||
9e88d150 | 45 | struct ctf_stream_definition; |
1cf393f6 | 46 | struct bt_stream_pos; |
37b99bdb | 47 | struct bt_format; |
0d69b916 | 48 | struct bt_definition; |
56e60373 | 49 | struct ctf_clock; |
4c8bfb7e | 50 | |
64893f33 | 51 | /* type scope */ |
f6625916 | 52 | struct declaration_scope { |
c13cbf74 | 53 | /* Hash table mapping type name GQuark to "struct declaration" */ |
1ee8e81d | 54 | /* Used for both typedef and typealias. */ |
f6625916 MD |
55 | GHashTable *typedef_declarations; |
56 | /* Hash table mapping struct name GQuark to "struct declaration_struct" */ | |
57 | GHashTable *struct_declarations; | |
58 | /* Hash table mapping variant name GQuark to "struct declaration_variant" */ | |
59 | GHashTable *variant_declarations; | |
c13cbf74 | 60 | /* Hash table mapping enum name GQuark to "struct type_enum" */ |
f6625916 MD |
61 | GHashTable *enum_declarations; |
62 | struct declaration_scope *parent_scope; | |
64893f33 MD |
63 | }; |
64 | ||
e1151715 MD |
65 | /* definition scope */ |
66 | struct definition_scope { | |
67 | /* Hash table mapping field name GQuark to "struct definition" */ | |
68 | GHashTable *definitions; | |
69 | struct definition_scope *parent_scope; | |
05c749e5 MD |
70 | /* |
71 | * Complete "path" leading to this definition scope. | |
9e29e16e | 72 | * Includes dynamic scope name '.' field name '.' field name '.' .... |
05c749e5 | 73 | * Array of GQuark elements (which are each separated by dots). |
9e29e16e MD |
74 | * The dynamic scope name can contain dots, and is encoded into |
75 | * a single GQuark. Thus, scope_path[0] returns the GQuark | |
76 | * identifying the dynamic scope. | |
05c749e5 MD |
77 | */ |
78 | GArray *scope_path; /* array of GQuark */ | |
6b71274a MD |
79 | }; |
80 | ||
ecc54f11 | 81 | struct bt_declaration { |
05628561 | 82 | enum ctf_type_id id; |
fc93b2bd | 83 | size_t alignment; /* type alignment, in bits */ |
e19c3d69 | 84 | int ref; /* number of references to the type */ |
c054553d | 85 | /* |
f6625916 | 86 | * declaration_free called with declaration ref is decremented to 0. |
c054553d | 87 | */ |
ecc54f11 | 88 | void (*declaration_free)(struct bt_declaration *declaration); |
0d69b916 | 89 | struct bt_definition * |
ecc54f11 | 90 | (*definition_new)(struct bt_declaration *declaration, |
05c749e5 | 91 | struct definition_scope *parent_scope, |
98df1c9f MD |
92 | GQuark field_name, int index, |
93 | const char *root_name); | |
c054553d | 94 | /* |
e1151715 | 95 | * definition_free called with definition ref is decremented to 0. |
e19c3d69 | 96 | */ |
0d69b916 | 97 | void (*definition_free)(struct bt_definition *definition); |
c054553d MD |
98 | }; |
99 | ||
0d69b916 | 100 | struct bt_definition { |
ecc54f11 | 101 | struct bt_declaration *declaration; |
05c749e5 | 102 | int index; /* Position of the definition in its container */ |
b1a2f580 | 103 | GQuark name; /* Field name in its container (or 0 if unset) */ |
e1151715 | 104 | int ref; /* number of references to the definition */ |
31262354 | 105 | GQuark path; |
a35173fe | 106 | struct definition_scope *scope; |
fc93b2bd MD |
107 | }; |
108 | ||
1cf393f6 | 109 | typedef int (*rw_dispatch)(struct bt_stream_pos *pos, |
0d69b916 | 110 | struct bt_definition *definition); |
d11e9c49 MD |
111 | |
112 | /* Parent of per-plugin positions */ | |
1cf393f6 | 113 | struct bt_stream_pos { |
d11e9c49 MD |
114 | /* read/write dispatch table. Specific to plugin used for stream. */ |
115 | rw_dispatch *rw_table; /* rw dispatch table */ | |
1cf393f6 | 116 | int (*event_cb)(struct bt_stream_pos *pos, |
9e88d150 | 117 | struct ctf_stream_definition *stream); |
7237592a MD |
118 | int (*pre_trace_cb)(struct bt_stream_pos *pos, |
119 | struct bt_trace_descriptor *trace); | |
120 | int (*post_trace_cb)(struct bt_stream_pos *pos, | |
121 | struct bt_trace_descriptor *trace); | |
ca334c72 | 122 | struct bt_trace_descriptor *trace; |
d11e9c49 MD |
123 | }; |
124 | ||
125 | static inline | |
0d69b916 | 126 | int generic_rw(struct bt_stream_pos *pos, struct bt_definition *definition) |
d11e9c49 MD |
127 | { |
128 | enum ctf_type_id dispatch_id = definition->declaration->id; | |
129 | rw_dispatch call; | |
130 | ||
131 | assert(pos->rw_table[dispatch_id] != NULL); | |
132 | call = pos->rw_table[dispatch_id]; | |
c5e74408 | 133 | return call(pos, definition); |
d11e9c49 MD |
134 | } |
135 | ||
bed864a7 MD |
136 | /* |
137 | * Because we address in bits, bitfields end up being exactly the same as | |
138 | * integers, except that their read/write functions must be able to deal with | |
139 | * read/write non aligned on CHAR_BIT. | |
140 | */ | |
f6625916 | 141 | struct declaration_integer { |
ecc54f11 | 142 | struct bt_declaration p; |
7fe00194 | 143 | size_t len; /* length, in bits. */ |
c35a1669 | 144 | int byte_order; /* LITTLE_ENDIAN/BIG_ENDIAN, 0 == "Native" */ |
7fe00194 | 145 | int signedness; |
164078da | 146 | int base; /* Base for pretty-printing: 2, 8, 10, 16 */ |
81dee1bb | 147 | enum ctf_string_encoding encoding; |
56e60373 | 148 | struct ctf_clock *clock; |
fc93b2bd MD |
149 | }; |
150 | ||
e1151715 | 151 | struct definition_integer { |
0d69b916 | 152 | struct bt_definition p; |
f6625916 | 153 | struct declaration_integer *declaration; |
c054553d MD |
154 | /* Last values read */ |
155 | union { | |
156 | uint64_t _unsigned; | |
157 | int64_t _signed; | |
158 | } value; | |
159 | }; | |
160 | ||
f6625916 | 161 | struct declaration_float { |
ecc54f11 | 162 | struct bt_declaration p; |
f6625916 MD |
163 | struct declaration_integer *sign; |
164 | struct declaration_integer *mantissa; | |
165 | struct declaration_integer *exp; | |
c35a1669 | 166 | int byte_order; /* LITTLE_ENDIAN/BIG_ENDIAN, 0 == "Native" */ |
0a46062b | 167 | /* TODO: we might want to express more info about NaN, +inf and -inf */ |
fc93b2bd MD |
168 | }; |
169 | ||
e1151715 | 170 | struct definition_float { |
0d69b916 | 171 | struct bt_definition p; |
f6625916 | 172 | struct declaration_float *declaration; |
d11e9c49 MD |
173 | struct definition_integer *sign; |
174 | struct definition_integer *mantissa; | |
175 | struct definition_integer *exp; | |
c054553d | 176 | /* Last values read */ |
f72803ca | 177 | double value; |
c054553d MD |
178 | }; |
179 | ||
d65d8abb MD |
180 | /* |
181 | * enum_val_equal assumes that signed and unsigned memory layout overlap. | |
182 | */ | |
183 | struct enum_range { | |
184 | union { | |
185 | int64_t _signed; | |
186 | uint64_t _unsigned; | |
187 | } start; /* lowest range value */ | |
188 | union { | |
189 | int64_t _signed; | |
190 | uint64_t _unsigned; | |
191 | } end; /* highest range value */ | |
192 | }; | |
193 | ||
194 | struct enum_range_to_quark { | |
3122e6f0 | 195 | struct bt_list_head node; |
d65d8abb MD |
196 | struct enum_range range; |
197 | GQuark quark; | |
198 | }; | |
199 | ||
200 | /* | |
201 | * We optimize the common case (range of size 1: single value) by creating a | |
202 | * hash table mapping values to quark sets. We then lookup the ranges to | |
203 | * complete the quark set. | |
204 | * | |
205 | * TODO: The proper structure to hold the range to quark set mapping would be an | |
206 | * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query | |
207 | * time. Using a simple O(n) list search for now for implementation speed and | |
208 | * given that we can expect to have a _relatively_ small number of enumeration | |
209 | * ranges. This might become untrue if we are fed with symbol tables often | |
210 | * required to lookup function names from instruction pointer value. | |
211 | */ | |
448d3cc7 | 212 | struct enum_table { |
d65d8abb | 213 | GHashTable *value_to_quark_set; /* (value, GQuark GArray) */ |
3122e6f0 | 214 | struct bt_list_head range_to_quark; /* (range, GQuark) */ |
d65d8abb | 215 | GHashTable *quark_to_range_set; /* (GQuark, range GArray) */ |
448d3cc7 MD |
216 | }; |
217 | ||
f6625916 | 218 | struct declaration_enum { |
ecc54f11 | 219 | struct bt_declaration p; |
f6625916 | 220 | struct declaration_integer *integer_declaration; |
448d3cc7 | 221 | struct enum_table table; |
fc93b2bd MD |
222 | }; |
223 | ||
e1151715 | 224 | struct definition_enum { |
0d69b916 | 225 | struct bt_definition p; |
e1151715 | 226 | struct definition_integer *integer; |
f6625916 | 227 | struct declaration_enum *declaration; |
c054553d MD |
228 | /* Last GQuark values read. Keeping a reference on the GQuark array. */ |
229 | GArray *value; | |
230 | }; | |
231 | ||
f6625916 | 232 | struct declaration_string { |
ecc54f11 | 233 | struct bt_declaration p; |
ab4cf058 | 234 | enum ctf_string_encoding encoding; |
c054553d MD |
235 | }; |
236 | ||
e1151715 | 237 | struct definition_string { |
0d69b916 | 238 | struct bt_definition p; |
f6625916 | 239 | struct declaration_string *declaration; |
e1151715 | 240 | char *value; /* freed at definition_string teardown */ |
d11e9c49 | 241 | size_t len, alloc_len; |
11796b96 MD |
242 | }; |
243 | ||
f6625916 | 244 | struct declaration_field { |
e19c3d69 | 245 | GQuark name; |
ecc54f11 | 246 | struct bt_declaration *declaration; |
c054553d MD |
247 | }; |
248 | ||
f6625916 | 249 | struct declaration_struct { |
ecc54f11 | 250 | struct bt_declaration p; |
e19c3d69 | 251 | GHashTable *fields_by_name; /* Tuples (field name, field index) */ |
f6625916 MD |
252 | struct declaration_scope *scope; |
253 | GArray *fields; /* Array of declaration_field */ | |
e19c3d69 MD |
254 | }; |
255 | ||
e1151715 | 256 | struct definition_struct { |
0d69b916 | 257 | struct bt_definition p; |
f6625916 | 258 | struct declaration_struct *declaration; |
0d69b916 | 259 | GPtrArray *fields; /* Array of pointers to struct bt_definition */ |
c054553d MD |
260 | }; |
261 | ||
d60cb676 | 262 | struct declaration_untagged_variant { |
ecc54f11 | 263 | struct bt_declaration p; |
c054553d | 264 | GHashTable *fields_by_tag; /* Tuples (field tag, field index) */ |
f6625916 MD |
265 | struct declaration_scope *scope; |
266 | GArray *fields; /* Array of declaration_field */ | |
c054553d MD |
267 | }; |
268 | ||
d60cb676 | 269 | struct declaration_variant { |
ecc54f11 | 270 | struct bt_declaration p; |
d60cb676 MD |
271 | struct declaration_untagged_variant *untagged_variant; |
272 | GArray *tag_name; /* Array of GQuark */ | |
273 | }; | |
274 | ||
275 | /* A variant needs to be tagged to be defined. */ | |
e1151715 | 276 | struct definition_variant { |
0d69b916 | 277 | struct bt_definition p; |
f6625916 | 278 | struct declaration_variant *declaration; |
0d69b916 JD |
279 | struct bt_definition *enum_tag; |
280 | GPtrArray *fields; /* Array of pointers to struct bt_definition */ | |
281 | struct bt_definition *current_field; /* Last field read */ | |
11796b96 MD |
282 | }; |
283 | ||
f6625916 | 284 | struct declaration_array { |
ecc54f11 | 285 | struct bt_declaration p; |
11796b96 | 286 | size_t len; |
ecc54f11 | 287 | struct bt_declaration *elem; |
f6625916 | 288 | struct declaration_scope *scope; |
11796b96 MD |
289 | }; |
290 | ||
e1151715 | 291 | struct definition_array { |
0d69b916 | 292 | struct bt_definition p; |
f6625916 | 293 | struct declaration_array *declaration; |
0d69b916 | 294 | GPtrArray *elems; /* Array of pointers to struct bt_definition */ |
81dee1bb | 295 | GString *string; /* String for encoded integer children */ |
c054553d MD |
296 | }; |
297 | ||
f6625916 | 298 | struct declaration_sequence { |
ecc54f11 | 299 | struct bt_declaration p; |
98df1c9f | 300 | GArray *length_name; /* Array of GQuark */ |
ecc54f11 | 301 | struct bt_declaration *elem; |
f6625916 | 302 | struct declaration_scope *scope; |
e19c3d69 MD |
303 | }; |
304 | ||
e1151715 | 305 | struct definition_sequence { |
0d69b916 | 306 | struct bt_definition p; |
f6625916 | 307 | struct declaration_sequence *declaration; |
98df1c9f | 308 | struct definition_integer *length; |
0d69b916 | 309 | GPtrArray *elems; /* Array of pointers to struct bt_definition */ |
81dee1bb | 310 | GString *string; /* String for encoded integer children */ |
c054553d MD |
311 | }; |
312 | ||
becd02a1 | 313 | int bt_register_declaration(GQuark declaration_name, |
ecc54f11 | 314 | struct bt_declaration *declaration, |
f6625916 | 315 | struct declaration_scope *scope); |
ecc54f11 | 316 | struct bt_declaration *bt_lookup_declaration(GQuark declaration_name, |
78af2bcd | 317 | struct declaration_scope *scope); |
c13cbf74 MD |
318 | |
319 | /* | |
320 | * Type scopes also contain a separate registry for struct, variant and | |
e1151715 | 321 | * enum types. Those register types rather than type definitions, so |
c13cbf74 MD |
322 | * that a named variant can be declared without specifying its target |
323 | * "choice" tag field immediately. | |
324 | */ | |
c8c98132 | 325 | int bt_register_struct_declaration(GQuark struct_name, |
f6625916 MD |
326 | struct declaration_struct *struct_declaration, |
327 | struct declaration_scope *scope); | |
328 | struct declaration_struct * | |
c8c98132 | 329 | bt_lookup_struct_declaration(GQuark struct_name, |
f6625916 | 330 | struct declaration_scope *scope); |
becd02a1 | 331 | int bt_register_variant_declaration(GQuark variant_name, |
a0720417 | 332 | struct declaration_untagged_variant *untagged_variant_declaration, |
f6625916 | 333 | struct declaration_scope *scope); |
becd02a1 | 334 | struct declaration_untagged_variant *bt_lookup_variant_declaration(GQuark variant_name, |
f6625916 | 335 | struct declaration_scope *scope); |
becd02a1 | 336 | int bt_register_enum_declaration(GQuark enum_name, |
f6625916 MD |
337 | struct declaration_enum *enum_declaration, |
338 | struct declaration_scope *scope); | |
339 | struct declaration_enum * | |
becd02a1 | 340 | bt_lookup_enum_declaration(GQuark enum_name, |
f6625916 MD |
341 | struct declaration_scope *scope); |
342 | ||
343 | struct declaration_scope * | |
becd02a1 JD |
344 | bt_new_declaration_scope(struct declaration_scope *parent_scope); |
345 | void bt_free_declaration_scope(struct declaration_scope *scope); | |
c054553d | 346 | |
c13cbf74 | 347 | /* |
e1151715 MD |
348 | * field_definition is for field definitions. They are registered into |
349 | * definition scopes. | |
c13cbf74 | 350 | */ |
0d69b916 | 351 | struct bt_definition * |
2b77e6a6 | 352 | bt_lookup_path_definition(GArray *cur_path, /* array of GQuark */ |
a35173fe MD |
353 | GArray *lookup_path, /* array of GQuark */ |
354 | struct definition_scope *scope); | |
2b77e6a6 | 355 | int bt_register_field_definition(GQuark field_name, |
0d69b916 | 356 | struct bt_definition *definition, |
e1151715 MD |
357 | struct definition_scope *scope); |
358 | struct definition_scope * | |
2b77e6a6 | 359 | bt_new_definition_scope(struct definition_scope *parent_scope, |
98df1c9f | 360 | GQuark field_name, const char *root_name); |
2b77e6a6 | 361 | void bt_free_definition_scope(struct definition_scope *scope); |
4c8bfb7e | 362 | |
2b77e6a6 | 363 | GQuark bt_new_definition_path(struct definition_scope *parent_scope, |
98df1c9f | 364 | GQuark field_name, const char *root_name); |
31262354 MD |
365 | |
366 | static inline | |
0d69b916 | 367 | int compare_definition_path(struct bt_definition *definition, GQuark path) |
31262354 MD |
368 | { |
369 | return definition->path == path; | |
370 | } | |
371 | ||
ecc54f11 JD |
372 | void bt_declaration_ref(struct bt_declaration *declaration); |
373 | void bt_declaration_unref(struct bt_declaration *declaration); | |
64893f33 | 374 | |
0d69b916 JD |
375 | void bt_definition_ref(struct bt_definition *definition); |
376 | void bt_definition_unref(struct bt_definition *definition); | |
698f0fe4 | 377 | |
becd02a1 | 378 | struct declaration_integer *bt_integer_declaration_new(size_t len, int byte_order, |
164078da | 379 | int signedness, size_t alignment, |
56e60373 MD |
380 | int base, enum ctf_string_encoding encoding, |
381 | struct ctf_clock *clock); | |
0d69b916 JD |
382 | uint64_t bt_get_unsigned_int(const struct bt_definition *field); |
383 | int64_t bt_get_signed_int(const struct bt_definition *field); | |
384 | int bt_get_int_signedness(const struct bt_definition *field); | |
385 | int bt_get_int_byte_order(const struct bt_definition *field); | |
386 | int bt_get_int_base(const struct bt_definition *field); | |
387 | size_t bt_get_int_len(const struct bt_definition *field); /* in bits */ | |
388 | enum ctf_string_encoding bt_get_int_encoding(const struct bt_definition *field); | |
0a46062b | 389 | |
11d43b90 MD |
390 | /* |
391 | * mantissa_len is the length of the number of bytes represented by the mantissa | |
392 | * (e.g. result of DBL_MANT_DIG). It includes the leading 1. | |
393 | */ | |
becd02a1 | 394 | struct declaration_float *bt_float_declaration_new(size_t mantissa_len, |
e19c3d69 MD |
395 | size_t exp_len, int byte_order, |
396 | size_t alignment); | |
0a46062b | 397 | |
448d3cc7 MD |
398 | /* |
399 | * A GQuark can be translated to/from strings with g_quark_from_string() and | |
400 | * g_quark_to_string(). | |
401 | */ | |
47e0f2e2 MD |
402 | |
403 | /* | |
404 | * Returns a GArray of GQuark or NULL. | |
405 | * Caller must release the GArray with g_array_unref(). | |
406 | */ | |
2399b6f4 | 407 | GArray *bt_enum_uint_to_quark_set(const struct declaration_enum *enum_declaration, |
f6625916 | 408 | uint64_t v); |
d65d8abb MD |
409 | |
410 | /* | |
47e0f2e2 | 411 | * Returns a GArray of GQuark or NULL. |
d65d8abb MD |
412 | * Caller must release the GArray with g_array_unref(). |
413 | */ | |
2399b6f4 | 414 | GArray *bt_enum_int_to_quark_set(const struct declaration_enum *enum_declaration, |
bcdf4cf2 | 415 | int64_t v); |
47e0f2e2 MD |
416 | |
417 | /* | |
418 | * Returns a GArray of struct enum_range or NULL. | |
fdacfb73 MD |
419 | * Callers do _not_ own the returned GArray (and therefore _don't_ need to |
420 | * release it). | |
47e0f2e2 | 421 | */ |
2399b6f4 | 422 | GArray *bt_enum_quark_to_range_set(const struct declaration_enum *enum_declaration, |
f6625916 | 423 | GQuark q); |
2399b6f4 | 424 | void bt_enum_signed_insert(struct declaration_enum *enum_declaration, |
d65d8abb | 425 | int64_t start, int64_t end, GQuark q); |
2399b6f4 | 426 | void bt_enum_unsigned_insert(struct declaration_enum *enum_declaration, |
d65d8abb | 427 | uint64_t start, uint64_t end, GQuark q); |
2399b6f4 | 428 | size_t bt_enum_get_nr_enumerators(struct declaration_enum *enum_declaration); |
f6625916 MD |
429 | |
430 | struct declaration_enum * | |
2399b6f4 | 431 | bt_enum_declaration_new(struct declaration_integer *integer_declaration); |
f6625916 | 432 | |
e397791f | 433 | struct declaration_string * |
ebdb2383 | 434 | bt_string_declaration_new(enum ctf_string_encoding encoding); |
0d69b916 JD |
435 | char *bt_get_string(const struct bt_definition *field); |
436 | enum ctf_string_encoding bt_get_string_encoding(const struct bt_definition *field); | |
e397791f | 437 | |
e5a73b90 JG |
438 | double bt_get_float(const struct bt_definition *field); |
439 | ||
812e6682 JG |
440 | const struct bt_definition *bt_get_variant_field(struct bt_definition *definition); |
441 | ||
f6625916 | 442 | struct declaration_struct * |
c8c98132 | 443 | bt_struct_declaration_new(struct declaration_scope *parent_scope, |
b7e35bad | 444 | uint64_t min_align); |
c8c98132 | 445 | void bt_struct_declaration_add_field(struct declaration_struct *struct_declaration, |
f6625916 | 446 | const char *field_name, |
ecc54f11 | 447 | struct bt_declaration *field_declaration); |
11796b96 MD |
448 | /* |
449 | * Returns the index of a field within a structure. | |
450 | */ | |
c8c98132 | 451 | int bt_struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration, |
f6625916 | 452 | GQuark field_name); |
11796b96 MD |
453 | /* |
454 | * field returned only valid as long as the field structure is not appended to. | |
455 | */ | |
f6625916 | 456 | struct declaration_field * |
c8c98132 | 457 | bt_struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration, |
0f980a35 | 458 | int index); |
0d69b916 | 459 | struct bt_definition * |
3a068915 | 460 | bt_struct_definition_get_field_from_index(const struct definition_struct *struct_definition, |
0f980a35 | 461 | int index); |
0d69b916 | 462 | int bt_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
3a068915 | 463 | uint64_t bt_struct_declaration_len(const struct declaration_struct *struct_declaration); |
11796b96 | 464 | |
c054553d MD |
465 | /* |
466 | * The tag enumeration is validated to ensure that it contains only mappings | |
467 | * from numeric values to a single tag. Overlapping tag value ranges are | |
468 | * therefore forbidden. | |
469 | */ | |
becd02a1 | 470 | struct declaration_untagged_variant *bt_untagged_bt_variant_declaration_new( |
1934b94f | 471 | struct declaration_scope *parent_scope); |
becd02a1 | 472 | struct declaration_variant *bt_variant_declaration_new(struct declaration_untagged_variant *untagged_variant, |
d60cb676 MD |
473 | const char *tag); |
474 | ||
becd02a1 | 475 | void bt_untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration, |
d60cb676 | 476 | const char *field_name, |
ecc54f11 | 477 | struct bt_declaration *field_declaration); |
f6625916 | 478 | struct declaration_field * |
becd02a1 | 479 | bt_untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, |
1934b94f | 480 | GQuark tag); |
c054553d MD |
481 | /* |
482 | * Returns 0 on success, -EPERM on error. | |
483 | */ | |
e1151715 | 484 | int variant_definition_set_tag(struct definition_variant *variant, |
0d69b916 | 485 | struct bt_definition *enum_tag); |
c054553d MD |
486 | /* |
487 | * Returns the field selected by the current tag value. | |
488 | * field returned only valid as long as the variant structure is not appended | |
489 | * to. | |
490 | */ | |
0d69b916 JD |
491 | struct bt_definition *bt_variant_get_current_field(struct definition_variant *variant); |
492 | int bt_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition); | |
c054553d | 493 | |
d06d03db | 494 | /* |
f6625916 MD |
495 | * elem_declaration passed as parameter now belongs to the array. No |
496 | * need to free it explicitly. "len" is the number of elements in the | |
497 | * array. | |
d06d03db | 498 | */ |
f6625916 | 499 | struct declaration_array * |
ecc54f11 | 500 | bt_array_declaration_new(size_t len, struct bt_declaration *elem_declaration, |
1934b94f | 501 | struct declaration_scope *parent_scope); |
dcaa2e7d | 502 | uint64_t bt_array_len(struct definition_array *array); |
0d69b916 JD |
503 | struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i); |
504 | int bt_array_rw(struct bt_stream_pos *pos, struct bt_definition *definition); | |
505 | GString *bt_get_char_array(const struct bt_definition *field); | |
506 | int bt_get_array_len(const struct bt_definition *field); | |
11796b96 | 507 | |
d06d03db | 508 | /* |
f6625916 MD |
509 | * int_declaration and elem_declaration passed as parameter now belong |
510 | * to the sequence. No need to free them explicitly. | |
d06d03db | 511 | */ |
f6625916 | 512 | struct declaration_sequence * |
9ffd39fc | 513 | bt_sequence_declaration_new(const char *length_name, |
ecc54f11 | 514 | struct bt_declaration *elem_declaration, |
1934b94f | 515 | struct declaration_scope *parent_scope); |
9ffd39fc | 516 | uint64_t bt_sequence_len(struct definition_sequence *sequence); |
0d69b916 JD |
517 | struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i); |
518 | int bt_sequence_rw(struct bt_stream_pos *pos, struct bt_definition *definition); | |
11796b96 | 519 | |
d60cb676 MD |
520 | /* |
521 | * in: path (dot separated), out: q (GArray of GQuark) | |
522 | */ | |
dd0365d9 | 523 | void bt_append_scope_path(const char *path, GArray *q); |
d60cb676 | 524 | |
a35173fe MD |
525 | /* |
526 | * Lookup helpers. | |
527 | */ | |
0d69b916 | 528 | struct bt_definition *bt_lookup_definition(const struct bt_definition *definition, |
620961f6 | 529 | const char *field_name); |
0d69b916 | 530 | struct definition_integer *bt_lookup_integer(const struct bt_definition *definition, |
a35173fe MD |
531 | const char *field_name, |
532 | int signedness); | |
0d69b916 | 533 | struct definition_enum *bt_lookup_enum(const struct bt_definition *definition, |
a35173fe MD |
534 | const char *field_name, |
535 | int signedness); | |
0d69b916 | 536 | struct bt_definition *bt_lookup_variant(const struct bt_definition *definition, |
a35173fe MD |
537 | const char *field_name); |
538 | ||
300d317a JD |
539 | static inline |
540 | const char *rem_(const char *str) | |
541 | { | |
542 | if (str[0] == '_') | |
543 | return &str[1]; | |
544 | else | |
545 | return str; | |
546 | } | |
547 | ||
31262354 | 548 | #endif /* _BABELTRACE_TYPES_H */ |