1 #ifndef _BABELTRACE_TYPES_H
2 #define _BABELTRACE_TYPES_H
9 * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@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.
22 #include <babeltrace/align.h>
23 #include <babeltrace/list.h>
31 /* Preallocate this many fields for structures */
32 #define DEFAULT_NR_STRUCT_FIELDS 8
40 struct declaration_scope
{
41 /* Hash table mapping type name GQuark to "struct declaration" */
42 /* Used for both typedef and typealias. */
43 GHashTable
*typedef_declarations
;
44 /* Hash table mapping struct name GQuark to "struct declaration_struct" */
45 GHashTable
*struct_declarations
;
46 /* Hash table mapping variant name GQuark to "struct declaration_variant" */
47 GHashTable
*variant_declarations
;
48 /* Hash table mapping enum name GQuark to "struct type_enum" */
49 GHashTable
*enum_declarations
;
50 struct declaration_scope
*parent_scope
;
53 /* definition scope */
54 struct definition_scope
{
55 /* Hash table mapping field name GQuark to "struct definition" */
56 GHashTable
*definitions
;
57 struct definition_scope
*parent_scope
;
59 * Complete "path" leading to this definition scope.
60 * Includes dynamic scope name '.' field name '.' field name '.' ....
61 * Array of GQuark elements (which are each separated by dots).
62 * The dynamic scope name can contain dots, and is encoded into
63 * a single GQuark. Thus, scope_path[0] returns the GQuark
64 * identifying the dynamic scope.
66 GArray
*scope_path
; /* array of GQuark */
76 CTF_TYPE_UNTAGGED_VARIANT
,
85 size_t alignment
; /* type alignment, in bits */
86 int ref
; /* number of references to the type */
88 * declaration_free called with declaration ref is decremented to 0.
90 void (*declaration_free
)(struct declaration
*declaration
);
92 (*definition_new
)(struct declaration
*declaration
,
93 struct definition_scope
*parent_scope
,
94 GQuark field_name
, int index
);
96 * definition_free called with definition ref is decremented to 0.
98 void (*definition_free
)(struct definition
*definition
);
102 struct declaration
*declaration
;
103 int index
; /* Position of the definition in its container */
104 GQuark name
; /* Field name in its container (or 0 if unset) */
105 int ref
; /* number of references to the definition */
109 typedef int (*rw_dispatch
)(struct stream_pos
*pos
,
110 struct definition
*definition
);
112 /* Parent of per-plugin positions */
114 /* read/write dispatch table. Specific to plugin used for stream. */
115 rw_dispatch
*rw_table
; /* rw dispatch table */
116 int (*event_cb
)(struct stream_pos
*pos
,
117 struct ctf_stream
*stream
);
121 int generic_rw(struct stream_pos
*pos
, struct definition
*definition
)
123 enum ctf_type_id dispatch_id
= definition
->declaration
->id
;
126 assert(pos
->rw_table
[dispatch_id
] != NULL
);
127 call
= pos
->rw_table
[dispatch_id
];
128 return call(pos
, definition
);
132 * Because we address in bits, bitfields end up being exactly the same as
133 * integers, except that their read/write functions must be able to deal with
134 * read/write non aligned on CHAR_BIT.
136 struct declaration_integer
{
137 struct declaration p
;
138 size_t len
; /* length, in bits. */
139 int byte_order
; /* byte order */
141 int base
; /* Base for pretty-printing: 2, 8, 10, 16 */
144 struct definition_integer
{
146 struct declaration_integer
*declaration
;
147 /* Last values read */
154 struct declaration_float
{
155 struct declaration p
;
156 struct declaration_integer
*sign
;
157 struct declaration_integer
*mantissa
;
158 struct declaration_integer
*exp
;
160 /* TODO: we might want to express more info about NaN, +inf and -inf */
163 struct definition_float
{
165 struct declaration_float
*declaration
;
166 struct definition_integer
*sign
;
167 struct definition_integer
*mantissa
;
168 struct definition_integer
*exp
;
169 /* Last values read */
174 * enum_val_equal assumes that signed and unsigned memory layout overlap.
180 } start
; /* lowest range value */
184 } end
; /* highest range value */
187 struct enum_range_to_quark
{
188 struct cds_list_head node
;
189 struct enum_range range
;
194 * We optimize the common case (range of size 1: single value) by creating a
195 * hash table mapping values to quark sets. We then lookup the ranges to
196 * complete the quark set.
198 * TODO: The proper structure to hold the range to quark set mapping would be an
199 * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
200 * time. Using a simple O(n) list search for now for implementation speed and
201 * given that we can expect to have a _relatively_ small number of enumeration
202 * ranges. This might become untrue if we are fed with symbol tables often
203 * required to lookup function names from instruction pointer value.
206 GHashTable
*value_to_quark_set
; /* (value, GQuark GArray) */
207 struct cds_list_head range_to_quark
; /* (range, GQuark) */
208 GHashTable
*quark_to_range_set
; /* (GQuark, range GArray) */
211 struct declaration_enum
{
212 struct declaration p
;
213 struct declaration_integer
*integer_declaration
;
214 struct enum_table table
;
217 struct definition_enum
{
219 struct definition_integer
*integer
;
220 struct declaration_enum
*declaration
;
221 /* Last GQuark values read. Keeping a reference on the GQuark array. */
225 enum ctf_string_encoding
{
231 struct declaration_string
{
232 struct declaration p
;
233 enum ctf_string_encoding encoding
;
236 struct definition_string
{
238 struct declaration_string
*declaration
;
239 char *value
; /* freed at definition_string teardown */
240 size_t len
, alloc_len
;
243 struct declaration_field
{
245 struct declaration
*declaration
;
248 struct declaration_struct
{
249 struct declaration p
;
250 GHashTable
*fields_by_name
; /* Tuples (field name, field index) */
251 struct declaration_scope
*scope
;
252 GArray
*fields
; /* Array of declaration_field */
255 struct definition_struct
{
257 struct declaration_struct
*declaration
;
258 struct definition_scope
*scope
;
259 GPtrArray
*fields
; /* Array of pointers to struct definition */
262 struct declaration_untagged_variant
{
263 struct declaration p
;
264 GHashTable
*fields_by_tag
; /* Tuples (field tag, field index) */
265 struct declaration_scope
*scope
;
266 GArray
*fields
; /* Array of declaration_field */
269 struct declaration_variant
{
270 struct declaration p
;
271 struct declaration_untagged_variant
*untagged_variant
;
272 GArray
*tag_name
; /* Array of GQuark */
275 /* A variant needs to be tagged to be defined. */
276 struct definition_variant
{
278 struct declaration_variant
*declaration
;
279 struct definition_scope
*scope
;
280 struct definition
*enum_tag
;
281 GPtrArray
*fields
; /* Array of pointers to struct definition */
282 struct definition
*current_field
; /* Last field read */
285 struct declaration_array
{
286 struct declaration p
;
288 struct declaration
*elem
;
289 struct declaration_scope
*scope
;
292 struct definition_array
{
294 struct declaration_array
*declaration
;
295 struct definition_scope
*scope
;
296 GPtrArray
*elems
; /* Array of pointers to struct definition */
299 struct declaration_sequence
{
300 struct declaration p
;
301 struct declaration_integer
*len_declaration
;
302 struct declaration
*elem
;
303 struct declaration_scope
*scope
;
306 struct definition_sequence
{
308 struct declaration_sequence
*declaration
;
309 struct definition_scope
*scope
;
310 struct definition_integer
*len
;
311 GPtrArray
*elems
; /* Array of pointers to struct definition */
314 int register_declaration(GQuark declaration_name
,
315 struct declaration
*declaration
,
316 struct declaration_scope
*scope
);
317 struct declaration
*lookup_declaration(GQuark declaration_name
,
318 struct declaration_scope
*scope
);
321 * Type scopes also contain a separate registry for struct, variant and
322 * enum types. Those register types rather than type definitions, so
323 * that a named variant can be declared without specifying its target
324 * "choice" tag field immediately.
326 int register_struct_declaration(GQuark struct_name
,
327 struct declaration_struct
*struct_declaration
,
328 struct declaration_scope
*scope
);
329 struct declaration_struct
*
330 lookup_struct_declaration(GQuark struct_name
,
331 struct declaration_scope
*scope
);
332 int register_variant_declaration(GQuark variant_name
,
333 struct declaration_untagged_variant
*untagged_variant_declaration
,
334 struct declaration_scope
*scope
);
335 struct declaration_untagged_variant
*lookup_variant_declaration(GQuark variant_name
,
336 struct declaration_scope
*scope
);
337 int register_enum_declaration(GQuark enum_name
,
338 struct declaration_enum
*enum_declaration
,
339 struct declaration_scope
*scope
);
340 struct declaration_enum
*
341 lookup_enum_declaration(GQuark enum_name
,
342 struct declaration_scope
*scope
);
344 struct declaration_scope
*
345 new_declaration_scope(struct declaration_scope
*parent_scope
);
346 void free_declaration_scope(struct declaration_scope
*scope
);
349 * field_definition is for field definitions. They are registered into
353 lookup_definition(GArray
*cur_path
, /* array of GQuark */
354 GArray
*lookup_path
, /* array of GQuark */
355 struct definition_scope
*scope
);
356 int register_field_definition(GQuark field_name
,
357 struct definition
*definition
,
358 struct definition_scope
*scope
);
359 struct definition_scope
*
360 new_definition_scope(struct definition_scope
*parent_scope
,
362 void set_dynamic_definition_scope(struct definition
*definition
,
363 struct definition_scope
*scope
,
364 const char *root_name
);
365 void free_definition_scope(struct definition_scope
*scope
);
367 GQuark
new_definition_path(struct definition_scope
*parent_scope
, GQuark field_name
);
370 int compare_definition_path(struct definition
*definition
, GQuark path
)
372 return definition
->path
== path
;
375 void declaration_ref(struct declaration
*declaration
);
376 void declaration_unref(struct declaration
*declaration
);
378 void definition_ref(struct definition
*definition
);
379 void definition_unref(struct definition
*definition
);
381 struct declaration_integer
*integer_declaration_new(size_t len
, int byte_order
,
382 int signedness
, size_t alignment
,
386 * mantissa_len is the length of the number of bytes represented by the mantissa
387 * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
389 struct declaration_float
*float_declaration_new(size_t mantissa_len
,
390 size_t exp_len
, int byte_order
,
394 * A GQuark can be translated to/from strings with g_quark_from_string() and
395 * g_quark_to_string().
399 * Returns a GArray of GQuark or NULL.
400 * Caller must release the GArray with g_array_unref().
402 GArray
*enum_uint_to_quark_set(const struct declaration_enum
*enum_declaration
,
406 * Returns a GArray of GQuark or NULL.
407 * Caller must release the GArray with g_array_unref().
409 GArray
*enum_int_to_quark_set(const struct declaration_enum
*enum_declaration
,
413 * Returns a GArray of struct enum_range or NULL.
414 * Callers do _not_ own the returned GArray (and therefore _don't_ need to
417 GArray
*enum_quark_to_range_set(const struct declaration_enum
*enum_declaration
,
419 void enum_signed_insert(struct declaration_enum
*enum_declaration
,
420 int64_t start
, int64_t end
, GQuark q
);
421 void enum_unsigned_insert(struct declaration_enum
*enum_declaration
,
422 uint64_t start
, uint64_t end
, GQuark q
);
423 size_t enum_get_nr_enumerators(struct declaration_enum
*enum_declaration
);
425 struct declaration_enum
*
426 enum_declaration_new(struct declaration_integer
*integer_declaration
);
428 struct declaration_string
*
429 string_declaration_new(enum ctf_string_encoding encoding
);
431 struct declaration_struct
*
432 struct_declaration_new(struct declaration_scope
*parent_scope
,
434 void struct_declaration_add_field(struct declaration_struct
*struct_declaration
,
435 const char *field_name
,
436 struct declaration
*field_declaration
);
438 * Returns the index of a field within a structure.
440 int struct_declaration_lookup_field_index(struct declaration_struct
*struct_declaration
,
443 * field returned only valid as long as the field structure is not appended to.
445 struct declaration_field
*
446 struct_declaration_get_field_from_index(struct declaration_struct
*struct_declaration
,
449 struct_definition_get_field_from_index(struct definition_struct
*struct_definition
,
451 int struct_rw(struct stream_pos
*pos
, struct definition
*definition
);
452 uint64_t struct_declaration_len(struct declaration_struct
*struct_declaration
);
455 * The tag enumeration is validated to ensure that it contains only mappings
456 * from numeric values to a single tag. Overlapping tag value ranges are
457 * therefore forbidden.
459 struct declaration_untagged_variant
*untagged_variant_declaration_new(
460 struct declaration_scope
*parent_scope
);
461 struct declaration_variant
*variant_declaration_new(struct declaration_untagged_variant
*untagged_variant
,
464 void untagged_variant_declaration_add_field(struct declaration_untagged_variant
*untagged_variant_declaration
,
465 const char *field_name
,
466 struct declaration
*field_declaration
);
467 struct declaration_field
*
468 untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant
*untagged_variant_declaration
,
471 * Returns 0 on success, -EPERM on error.
473 int variant_definition_set_tag(struct definition_variant
*variant
,
474 struct definition
*enum_tag
);
476 * Returns the field selected by the current tag value.
477 * field returned only valid as long as the variant structure is not appended
480 struct definition
*variant_get_current_field(struct definition_variant
*variant
);
481 int variant_rw(struct stream_pos
*pos
, struct definition
*definition
);
484 * elem_declaration passed as parameter now belongs to the array. No
485 * need to free it explicitly. "len" is the number of elements in the
488 struct declaration_array
*
489 array_declaration_new(size_t len
, struct declaration
*elem_declaration
,
490 struct declaration_scope
*parent_scope
);
491 uint64_t array_len(struct definition_array
*array
);
492 struct definition
*array_index(struct definition_array
*array
, uint64_t i
);
493 int array_rw(struct stream_pos
*pos
, struct definition
*definition
);
496 * int_declaration and elem_declaration passed as parameter now belong
497 * to the sequence. No need to free them explicitly.
499 struct declaration_sequence
*
500 sequence_declaration_new(struct declaration_integer
*len_declaration
,
501 struct declaration
*elem_declaration
,
502 struct declaration_scope
*parent_scope
);
503 uint64_t sequence_len(struct definition_sequence
*sequence
);
504 struct definition
*sequence_index(struct definition_sequence
*sequence
, uint64_t i
);
505 int sequence_rw(struct stream_pos
*pos
, struct definition
*definition
);
508 * in: path (dot separated), out: q (GArray of GQuark)
510 void append_scope_path(const char *path
, GArray
*q
);
512 #endif /* _BABELTRACE_TYPES_H */