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> | |
37 | #include <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); | |
d11e9c49 MD |
122 | }; |
123 | ||
124 | static inline | |
0d69b916 | 125 | int generic_rw(struct bt_stream_pos *pos, struct bt_definition *definition) |
d11e9c49 MD |
126 | { |
127 | enum ctf_type_id dispatch_id = definition->declaration->id; | |
128 | rw_dispatch call; | |
129 | ||
130 | assert(pos->rw_table[dispatch_id] != NULL); | |
131 | call = pos->rw_table[dispatch_id]; | |
c5e74408 | 132 | return call(pos, definition); |
d11e9c49 MD |
133 | } |
134 | ||
bed864a7 MD |
135 | /* |
136 | * Because we address in bits, bitfields end up being exactly the same as | |
137 | * integers, except that their read/write functions must be able to deal with | |
138 | * read/write non aligned on CHAR_BIT. | |
139 | */ | |
f6625916 | 140 | struct declaration_integer { |
ecc54f11 | 141 | struct bt_declaration p; |
7fe00194 MD |
142 | size_t len; /* length, in bits. */ |
143 | int byte_order; /* byte order */ | |
144 | int signedness; | |
164078da | 145 | int base; /* Base for pretty-printing: 2, 8, 10, 16 */ |
81dee1bb | 146 | enum ctf_string_encoding encoding; |
56e60373 | 147 | struct ctf_clock *clock; |
fc93b2bd MD |
148 | }; |
149 | ||
e1151715 | 150 | struct definition_integer { |
0d69b916 | 151 | struct bt_definition p; |
f6625916 | 152 | struct declaration_integer *declaration; |
c054553d MD |
153 | /* Last values read */ |
154 | union { | |
155 | uint64_t _unsigned; | |
156 | int64_t _signed; | |
157 | } value; | |
158 | }; | |
159 | ||
f6625916 | 160 | struct declaration_float { |
ecc54f11 | 161 | struct bt_declaration p; |
f6625916 MD |
162 | struct declaration_integer *sign; |
163 | struct declaration_integer *mantissa; | |
164 | struct declaration_integer *exp; | |
fc93b2bd | 165 | int byte_order; |
0a46062b | 166 | /* TODO: we might want to express more info about NaN, +inf and -inf */ |
fc93b2bd MD |
167 | }; |
168 | ||
e1151715 | 169 | struct definition_float { |
0d69b916 | 170 | struct bt_definition p; |
f6625916 | 171 | struct declaration_float *declaration; |
d11e9c49 MD |
172 | struct definition_integer *sign; |
173 | struct definition_integer *mantissa; | |
174 | struct definition_integer *exp; | |
c054553d | 175 | /* Last values read */ |
f72803ca | 176 | double value; |
c054553d MD |
177 | }; |
178 | ||
d65d8abb MD |
179 | /* |
180 | * enum_val_equal assumes that signed and unsigned memory layout overlap. | |
181 | */ | |
182 | struct enum_range { | |
183 | union { | |
184 | int64_t _signed; | |
185 | uint64_t _unsigned; | |
186 | } start; /* lowest range value */ | |
187 | union { | |
188 | int64_t _signed; | |
189 | uint64_t _unsigned; | |
190 | } end; /* highest range value */ | |
191 | }; | |
192 | ||
193 | struct enum_range_to_quark { | |
3122e6f0 | 194 | struct bt_list_head node; |
d65d8abb MD |
195 | struct enum_range range; |
196 | GQuark quark; | |
197 | }; | |
198 | ||
199 | /* | |
200 | * We optimize the common case (range of size 1: single value) by creating a | |
201 | * hash table mapping values to quark sets. We then lookup the ranges to | |
202 | * complete the quark set. | |
203 | * | |
204 | * TODO: The proper structure to hold the range to quark set mapping would be an | |
205 | * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query | |
206 | * time. Using a simple O(n) list search for now for implementation speed and | |
207 | * given that we can expect to have a _relatively_ small number of enumeration | |
208 | * ranges. This might become untrue if we are fed with symbol tables often | |
209 | * required to lookup function names from instruction pointer value. | |
210 | */ | |
448d3cc7 | 211 | struct enum_table { |
d65d8abb | 212 | GHashTable *value_to_quark_set; /* (value, GQuark GArray) */ |
3122e6f0 | 213 | struct bt_list_head range_to_quark; /* (range, GQuark) */ |
d65d8abb | 214 | GHashTable *quark_to_range_set; /* (GQuark, range GArray) */ |
448d3cc7 MD |
215 | }; |
216 | ||
f6625916 | 217 | struct declaration_enum { |
ecc54f11 | 218 | struct bt_declaration p; |
f6625916 | 219 | struct declaration_integer *integer_declaration; |
448d3cc7 | 220 | struct enum_table table; |
fc93b2bd MD |
221 | }; |
222 | ||
e1151715 | 223 | struct definition_enum { |
0d69b916 | 224 | struct bt_definition p; |
e1151715 | 225 | struct definition_integer *integer; |
f6625916 | 226 | struct declaration_enum *declaration; |
c054553d MD |
227 | /* Last GQuark values read. Keeping a reference on the GQuark array. */ |
228 | GArray *value; | |
229 | }; | |
230 | ||
f6625916 | 231 | struct declaration_string { |
ecc54f11 | 232 | struct bt_declaration p; |
ab4cf058 | 233 | enum ctf_string_encoding encoding; |
c054553d MD |
234 | }; |
235 | ||
e1151715 | 236 | struct definition_string { |
0d69b916 | 237 | struct bt_definition p; |
f6625916 | 238 | struct declaration_string *declaration; |
e1151715 | 239 | char *value; /* freed at definition_string teardown */ |
d11e9c49 | 240 | size_t len, alloc_len; |
11796b96 MD |
241 | }; |
242 | ||
f6625916 | 243 | struct declaration_field { |
e19c3d69 | 244 | GQuark name; |
ecc54f11 | 245 | struct bt_declaration *declaration; |
c054553d MD |
246 | }; |
247 | ||
f6625916 | 248 | struct declaration_struct { |
ecc54f11 | 249 | struct bt_declaration p; |
e19c3d69 | 250 | GHashTable *fields_by_name; /* Tuples (field name, field index) */ |
f6625916 MD |
251 | struct declaration_scope *scope; |
252 | GArray *fields; /* Array of declaration_field */ | |
e19c3d69 MD |
253 | }; |
254 | ||
e1151715 | 255 | struct definition_struct { |
0d69b916 | 256 | struct bt_definition p; |
f6625916 | 257 | struct declaration_struct *declaration; |
0d69b916 | 258 | GPtrArray *fields; /* Array of pointers to struct bt_definition */ |
c054553d MD |
259 | }; |
260 | ||
d60cb676 | 261 | struct declaration_untagged_variant { |
ecc54f11 | 262 | struct bt_declaration p; |
c054553d | 263 | GHashTable *fields_by_tag; /* Tuples (field tag, field index) */ |
f6625916 MD |
264 | struct declaration_scope *scope; |
265 | GArray *fields; /* Array of declaration_field */ | |
c054553d MD |
266 | }; |
267 | ||
d60cb676 | 268 | struct declaration_variant { |
ecc54f11 | 269 | struct bt_declaration p; |
d60cb676 MD |
270 | struct declaration_untagged_variant *untagged_variant; |
271 | GArray *tag_name; /* Array of GQuark */ | |
272 | }; | |
273 | ||
274 | /* A variant needs to be tagged to be defined. */ | |
e1151715 | 275 | struct definition_variant { |
0d69b916 | 276 | struct bt_definition p; |
f6625916 | 277 | struct declaration_variant *declaration; |
0d69b916 JD |
278 | struct bt_definition *enum_tag; |
279 | GPtrArray *fields; /* Array of pointers to struct bt_definition */ | |
280 | struct bt_definition *current_field; /* Last field read */ | |
11796b96 MD |
281 | }; |
282 | ||
f6625916 | 283 | struct declaration_array { |
ecc54f11 | 284 | struct bt_declaration p; |
11796b96 | 285 | size_t len; |
ecc54f11 | 286 | struct bt_declaration *elem; |
f6625916 | 287 | struct declaration_scope *scope; |
11796b96 MD |
288 | }; |
289 | ||
e1151715 | 290 | struct definition_array { |
0d69b916 | 291 | struct bt_definition p; |
f6625916 | 292 | struct declaration_array *declaration; |
0d69b916 | 293 | GPtrArray *elems; /* Array of pointers to struct bt_definition */ |
81dee1bb | 294 | GString *string; /* String for encoded integer children */ |
c054553d MD |
295 | }; |
296 | ||
f6625916 | 297 | struct declaration_sequence { |
ecc54f11 | 298 | struct bt_declaration p; |
98df1c9f | 299 | GArray *length_name; /* Array of GQuark */ |
ecc54f11 | 300 | struct bt_declaration *elem; |
f6625916 | 301 | struct declaration_scope *scope; |
e19c3d69 MD |
302 | }; |
303 | ||
e1151715 | 304 | struct definition_sequence { |
0d69b916 | 305 | struct bt_definition p; |
f6625916 | 306 | struct declaration_sequence *declaration; |
98df1c9f | 307 | struct definition_integer *length; |
0d69b916 | 308 | GPtrArray *elems; /* Array of pointers to struct bt_definition */ |
81dee1bb | 309 | GString *string; /* String for encoded integer children */ |
c054553d MD |
310 | }; |
311 | ||
becd02a1 | 312 | int bt_register_declaration(GQuark declaration_name, |
ecc54f11 | 313 | struct bt_declaration *declaration, |
f6625916 | 314 | struct declaration_scope *scope); |
ecc54f11 | 315 | struct bt_declaration *bt_lookup_declaration(GQuark declaration_name, |
78af2bcd | 316 | struct declaration_scope *scope); |
c13cbf74 MD |
317 | |
318 | /* | |
319 | * Type scopes also contain a separate registry for struct, variant and | |
e1151715 | 320 | * enum types. Those register types rather than type definitions, so |
c13cbf74 MD |
321 | * that a named variant can be declared without specifying its target |
322 | * "choice" tag field immediately. | |
323 | */ | |
c8c98132 | 324 | int bt_register_struct_declaration(GQuark struct_name, |
f6625916 MD |
325 | struct declaration_struct *struct_declaration, |
326 | struct declaration_scope *scope); | |
327 | struct declaration_struct * | |
c8c98132 | 328 | bt_lookup_struct_declaration(GQuark struct_name, |
f6625916 | 329 | struct declaration_scope *scope); |
becd02a1 | 330 | int bt_register_variant_declaration(GQuark variant_name, |
a0720417 | 331 | struct declaration_untagged_variant *untagged_variant_declaration, |
f6625916 | 332 | struct declaration_scope *scope); |
becd02a1 | 333 | struct declaration_untagged_variant *bt_lookup_variant_declaration(GQuark variant_name, |
f6625916 | 334 | struct declaration_scope *scope); |
becd02a1 | 335 | int bt_register_enum_declaration(GQuark enum_name, |
f6625916 MD |
336 | struct declaration_enum *enum_declaration, |
337 | struct declaration_scope *scope); | |
338 | struct declaration_enum * | |
becd02a1 | 339 | bt_lookup_enum_declaration(GQuark enum_name, |
f6625916 MD |
340 | struct declaration_scope *scope); |
341 | ||
342 | struct declaration_scope * | |
becd02a1 JD |
343 | bt_new_declaration_scope(struct declaration_scope *parent_scope); |
344 | void bt_free_declaration_scope(struct declaration_scope *scope); | |
c054553d | 345 | |
c13cbf74 | 346 | /* |
e1151715 MD |
347 | * field_definition is for field definitions. They are registered into |
348 | * definition scopes. | |
c13cbf74 | 349 | */ |
0d69b916 | 350 | struct bt_definition * |
2b77e6a6 | 351 | bt_lookup_path_definition(GArray *cur_path, /* array of GQuark */ |
a35173fe MD |
352 | GArray *lookup_path, /* array of GQuark */ |
353 | struct definition_scope *scope); | |
2b77e6a6 | 354 | int bt_register_field_definition(GQuark field_name, |
0d69b916 | 355 | struct bt_definition *definition, |
e1151715 MD |
356 | struct definition_scope *scope); |
357 | struct definition_scope * | |
2b77e6a6 | 358 | bt_new_definition_scope(struct definition_scope *parent_scope, |
98df1c9f | 359 | GQuark field_name, const char *root_name); |
2b77e6a6 | 360 | void bt_free_definition_scope(struct definition_scope *scope); |
4c8bfb7e | 361 | |
2b77e6a6 | 362 | GQuark bt_new_definition_path(struct definition_scope *parent_scope, |
98df1c9f | 363 | GQuark field_name, const char *root_name); |
31262354 MD |
364 | |
365 | static inline | |
0d69b916 | 366 | int compare_definition_path(struct bt_definition *definition, GQuark path) |
31262354 MD |
367 | { |
368 | return definition->path == path; | |
369 | } | |
370 | ||
ecc54f11 JD |
371 | void bt_declaration_ref(struct bt_declaration *declaration); |
372 | void bt_declaration_unref(struct bt_declaration *declaration); | |
64893f33 | 373 | |
0d69b916 JD |
374 | void bt_definition_ref(struct bt_definition *definition); |
375 | void bt_definition_unref(struct bt_definition *definition); | |
698f0fe4 | 376 | |
becd02a1 | 377 | struct declaration_integer *bt_integer_declaration_new(size_t len, int byte_order, |
164078da | 378 | int signedness, size_t alignment, |
56e60373 MD |
379 | int base, enum ctf_string_encoding encoding, |
380 | struct ctf_clock *clock); | |
0d69b916 JD |
381 | uint64_t bt_get_unsigned_int(const struct bt_definition *field); |
382 | int64_t bt_get_signed_int(const struct bt_definition *field); | |
383 | int bt_get_int_signedness(const struct bt_definition *field); | |
384 | int bt_get_int_byte_order(const struct bt_definition *field); | |
385 | int bt_get_int_base(const struct bt_definition *field); | |
386 | size_t bt_get_int_len(const struct bt_definition *field); /* in bits */ | |
387 | enum ctf_string_encoding bt_get_int_encoding(const struct bt_definition *field); | |
0a46062b | 388 | |
11d43b90 MD |
389 | /* |
390 | * mantissa_len is the length of the number of bytes represented by the mantissa | |
391 | * (e.g. result of DBL_MANT_DIG). It includes the leading 1. | |
392 | */ | |
becd02a1 | 393 | struct declaration_float *bt_float_declaration_new(size_t mantissa_len, |
e19c3d69 MD |
394 | size_t exp_len, int byte_order, |
395 | size_t alignment); | |
0a46062b | 396 | |
448d3cc7 MD |
397 | /* |
398 | * A GQuark can be translated to/from strings with g_quark_from_string() and | |
399 | * g_quark_to_string(). | |
400 | */ | |
47e0f2e2 MD |
401 | |
402 | /* | |
403 | * Returns a GArray of GQuark or NULL. | |
404 | * Caller must release the GArray with g_array_unref(). | |
405 | */ | |
2399b6f4 | 406 | GArray *bt_enum_uint_to_quark_set(const struct declaration_enum *enum_declaration, |
f6625916 | 407 | uint64_t v); |
d65d8abb MD |
408 | |
409 | /* | |
47e0f2e2 | 410 | * Returns a GArray of GQuark or NULL. |
d65d8abb MD |
411 | * Caller must release the GArray with g_array_unref(). |
412 | */ | |
2399b6f4 | 413 | GArray *bt_enum_int_to_quark_set(const struct declaration_enum *enum_declaration, |
bcdf4cf2 | 414 | int64_t v); |
47e0f2e2 MD |
415 | |
416 | /* | |
417 | * Returns a GArray of struct enum_range or NULL. | |
fdacfb73 MD |
418 | * Callers do _not_ own the returned GArray (and therefore _don't_ need to |
419 | * release it). | |
47e0f2e2 | 420 | */ |
2399b6f4 | 421 | GArray *bt_enum_quark_to_range_set(const struct declaration_enum *enum_declaration, |
f6625916 | 422 | GQuark q); |
2399b6f4 | 423 | void bt_enum_signed_insert(struct declaration_enum *enum_declaration, |
d65d8abb | 424 | int64_t start, int64_t end, GQuark q); |
2399b6f4 | 425 | void bt_enum_unsigned_insert(struct declaration_enum *enum_declaration, |
d65d8abb | 426 | uint64_t start, uint64_t end, GQuark q); |
2399b6f4 | 427 | size_t bt_enum_get_nr_enumerators(struct declaration_enum *enum_declaration); |
f6625916 MD |
428 | |
429 | struct declaration_enum * | |
2399b6f4 | 430 | bt_enum_declaration_new(struct declaration_integer *integer_declaration); |
f6625916 | 431 | |
e397791f | 432 | struct declaration_string * |
ebdb2383 | 433 | bt_string_declaration_new(enum ctf_string_encoding encoding); |
0d69b916 JD |
434 | char *bt_get_string(const struct bt_definition *field); |
435 | enum ctf_string_encoding bt_get_string_encoding(const struct bt_definition *field); | |
e397791f | 436 | |
f6625916 | 437 | struct declaration_struct * |
c8c98132 | 438 | bt_struct_declaration_new(struct declaration_scope *parent_scope, |
b7e35bad | 439 | uint64_t min_align); |
c8c98132 | 440 | void bt_struct_declaration_add_field(struct declaration_struct *struct_declaration, |
f6625916 | 441 | const char *field_name, |
ecc54f11 | 442 | struct bt_declaration *field_declaration); |
11796b96 MD |
443 | /* |
444 | * Returns the index of a field within a structure. | |
445 | */ | |
c8c98132 | 446 | int bt_struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration, |
f6625916 | 447 | GQuark field_name); |
11796b96 MD |
448 | /* |
449 | * field returned only valid as long as the field structure is not appended to. | |
450 | */ | |
f6625916 | 451 | struct declaration_field * |
c8c98132 | 452 | bt_struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration, |
0f980a35 | 453 | int index); |
0d69b916 | 454 | struct bt_definition * |
c8c98132 | 455 | bt_struct_definition_get_field_from_index(struct definition_struct *struct_definition, |
0f980a35 | 456 | int index); |
0d69b916 | 457 | int bt_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
c8c98132 | 458 | uint64_t bt_struct_declaration_len(struct declaration_struct *struct_declaration); |
11796b96 | 459 | |
c054553d MD |
460 | /* |
461 | * The tag enumeration is validated to ensure that it contains only mappings | |
462 | * from numeric values to a single tag. Overlapping tag value ranges are | |
463 | * therefore forbidden. | |
464 | */ | |
becd02a1 | 465 | struct declaration_untagged_variant *bt_untagged_bt_variant_declaration_new( |
1934b94f | 466 | struct declaration_scope *parent_scope); |
becd02a1 | 467 | struct declaration_variant *bt_variant_declaration_new(struct declaration_untagged_variant *untagged_variant, |
d60cb676 MD |
468 | const char *tag); |
469 | ||
becd02a1 | 470 | void bt_untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration, |
d60cb676 | 471 | const char *field_name, |
ecc54f11 | 472 | struct bt_declaration *field_declaration); |
f6625916 | 473 | struct declaration_field * |
becd02a1 | 474 | bt_untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, |
1934b94f | 475 | GQuark tag); |
c054553d MD |
476 | /* |
477 | * Returns 0 on success, -EPERM on error. | |
478 | */ | |
e1151715 | 479 | int variant_definition_set_tag(struct definition_variant *variant, |
0d69b916 | 480 | struct bt_definition *enum_tag); |
c054553d MD |
481 | /* |
482 | * Returns the field selected by the current tag value. | |
483 | * field returned only valid as long as the variant structure is not appended | |
484 | * to. | |
485 | */ | |
0d69b916 JD |
486 | struct bt_definition *bt_variant_get_current_field(struct definition_variant *variant); |
487 | int bt_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition); | |
c054553d | 488 | |
d06d03db | 489 | /* |
f6625916 MD |
490 | * elem_declaration passed as parameter now belongs to the array. No |
491 | * need to free it explicitly. "len" is the number of elements in the | |
492 | * array. | |
d06d03db | 493 | */ |
f6625916 | 494 | struct declaration_array * |
ecc54f11 | 495 | bt_array_declaration_new(size_t len, struct bt_declaration *elem_declaration, |
1934b94f | 496 | struct declaration_scope *parent_scope); |
dcaa2e7d | 497 | uint64_t bt_array_len(struct definition_array *array); |
0d69b916 JD |
498 | struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i); |
499 | int bt_array_rw(struct bt_stream_pos *pos, struct bt_definition *definition); | |
500 | GString *bt_get_char_array(const struct bt_definition *field); | |
501 | int bt_get_array_len(const struct bt_definition *field); | |
11796b96 | 502 | |
d06d03db | 503 | /* |
f6625916 MD |
504 | * int_declaration and elem_declaration passed as parameter now belong |
505 | * to the sequence. No need to free them explicitly. | |
d06d03db | 506 | */ |
f6625916 | 507 | struct declaration_sequence * |
9ffd39fc | 508 | bt_sequence_declaration_new(const char *length_name, |
ecc54f11 | 509 | struct bt_declaration *elem_declaration, |
1934b94f | 510 | struct declaration_scope *parent_scope); |
9ffd39fc | 511 | uint64_t bt_sequence_len(struct definition_sequence *sequence); |
0d69b916 JD |
512 | struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i); |
513 | int bt_sequence_rw(struct bt_stream_pos *pos, struct bt_definition *definition); | |
11796b96 | 514 | |
d60cb676 MD |
515 | /* |
516 | * in: path (dot separated), out: q (GArray of GQuark) | |
517 | */ | |
dd0365d9 | 518 | void bt_append_scope_path(const char *path, GArray *q); |
d60cb676 | 519 | |
a35173fe MD |
520 | /* |
521 | * Lookup helpers. | |
522 | */ | |
0d69b916 | 523 | struct bt_definition *bt_lookup_definition(const struct bt_definition *definition, |
620961f6 | 524 | const char *field_name); |
0d69b916 | 525 | struct definition_integer *bt_lookup_integer(const struct bt_definition *definition, |
a35173fe MD |
526 | const char *field_name, |
527 | int signedness); | |
0d69b916 | 528 | struct definition_enum *bt_lookup_enum(const struct bt_definition *definition, |
a35173fe MD |
529 | const char *field_name, |
530 | int signedness); | |
0d69b916 | 531 | struct bt_definition *bt_lookup_variant(const struct bt_definition *definition, |
a35173fe MD |
532 | const char *field_name); |
533 | ||
300d317a JD |
534 | static inline |
535 | const char *rem_(const char *str) | |
536 | { | |
537 | if (str[0] == '_') | |
538 | return &str[1]; | |
539 | else | |
540 | return str; | |
541 | } | |
542 | ||
31262354 | 543 | #endif /* _BABELTRACE_TYPES_H */ |