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
35 * Always update stream_pos with move_pos and init_pos.
38 char *base
; /* Base address */
39 size_t offset
; /* Offset from base, in bits */
40 int dummy
; /* Dummy position, for length calculation */
44 void init_pos(struct stream_pos
*pos
, char *base
)
46 pos
->base
= base
; /* initial base, page-aligned */
52 * move_pos - move position of a relative bit offset
54 * TODO: allow larger files by updating base too.
57 void move_pos(struct stream_pos
*pos
, size_t offset
)
59 pos
->offset
= pos
->offset
+ offset
;
63 * align_pos - align position on a bit offset (> 0)
65 * TODO: allow larger files by updating base too.
68 void align_pos(struct stream_pos
*pos
, size_t offset
)
70 pos
->offset
+= offset_align(pos
->offset
, offset
);
74 void copy_pos(struct stream_pos
*dest
, struct stream_pos
*src
)
76 memcpy(dest
, src
, sizeof(struct stream_pos
));
80 char *get_pos_addr(struct stream_pos
*pos
)
82 /* Only makes sense to get the address after aligning on CHAR_BIT */
83 assert(!(pos
->offset
% CHAR_BIT
));
84 return pos
->base
+ (pos
->offset
/ CHAR_BIT
);
92 /* Hash table mapping type name GQuark to "struct declaration" */
93 GHashTable
*type_declarations
;
94 /* Hash table mapping struct name GQuark to "struct type_struct" */
95 GHashTable
*struct_types
;
96 /* Hash table mapping variant name GQuark to "struct type_variant" */
97 GHashTable
*variant_types
;
98 /* Hash table mapping enum name GQuark to "struct type_enum" */
99 GHashTable
*enum_types
;
100 struct type_scope
*parent_scope
;
103 /* declaration scope */
104 struct declaration_scope
{
105 /* Hash table mapping field name GQuark to "struct declaration" */
106 GHashTable
*declarations
;
107 struct declaration_scope
*parent_scope
;
111 CTF_TYPE_UNKNOWN
= 0,
125 GQuark name
; /* type name */
126 size_t alignment
; /* type alignment, in bits */
127 int ref
; /* number of references to the type */
129 * type_free called with type ref is decremented to 0.
131 void (*type_free
)(struct type
*type
);
133 (*declaration_new
)(struct type
*type
,
134 struct declaration_scope
*parent_scope
);
136 * declaration_free called with declaration ref is decremented to 0.
138 void (*declaration_free
)(struct declaration
*declaration
);
140 * Declaration copy function. Knows how to find the child declaration
141 * from the parent declaration.
143 void (*copy
)(struct stream_pos
*dest
, const struct format
*fdest
,
144 struct stream_pos
*src
, const struct format
*fsrc
,
145 struct declaration
*declaration
);
150 int ref
; /* number of references to the declaration */
154 * Because we address in bits, bitfields end up being exactly the same as
155 * integers, except that their read/write functions must be able to deal with
156 * read/write non aligned on CHAR_BIT.
158 struct type_integer
{
160 size_t len
; /* length, in bits. */
161 int byte_order
; /* byte order */
165 struct declaration_integer
{
166 struct declaration p
;
167 struct type_integer
*type
;
168 /* Last values read */
177 struct type_integer
*sign
;
178 struct type_integer
*mantissa
;
179 struct type_integer
*exp
;
181 /* TODO: we might want to express more info about NaN, +inf and -inf */
184 struct declaration_float
{
185 struct declaration p
;
186 struct type_float
*type
;
187 /* Last values read */
192 * enum_val_equal assumes that signed and unsigned memory layout overlap.
198 } start
; /* lowest range value */
202 } end
; /* highest range value */
205 struct enum_range_to_quark
{
206 struct cds_list_head node
;
207 struct enum_range range
;
212 * We optimize the common case (range of size 1: single value) by creating a
213 * hash table mapping values to quark sets. We then lookup the ranges to
214 * complete the quark set.
216 * TODO: The proper structure to hold the range to quark set mapping would be an
217 * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
218 * time. Using a simple O(n) list search for now for implementation speed and
219 * given that we can expect to have a _relatively_ small number of enumeration
220 * ranges. This might become untrue if we are fed with symbol tables often
221 * required to lookup function names from instruction pointer value.
224 GHashTable
*value_to_quark_set
; /* (value, GQuark GArray) */
225 struct cds_list_head range_to_quark
; /* (range, GQuark) */
226 GHashTable
*quark_to_range_set
; /* (GQuark, range GArray) */
231 struct type_integer
*integer_type
;
232 struct enum_table table
;
235 struct declaration_enum
{
236 struct declaration p
;
237 struct declaration_integer
*integer
;
238 struct type_enum
*type
;
239 /* Last GQuark values read. Keeping a reference on the GQuark array. */
247 struct declaration_string
{
248 struct declaration p
;
249 struct type_string
*type
;
250 char *value
; /* freed at declaration_string teardown */
260 struct declaration
*declaration
;
265 GHashTable
*fields_by_name
; /* Tuples (field name, field index) */
266 struct type_scope
*scope
;
267 GArray
*fields
; /* Array of type_field */
270 struct declaration_struct
{
271 struct declaration p
;
272 struct type_struct
*type
;
273 struct declaration_scope
*scope
;
274 GArray
*fields
; /* Array of struct field */
277 struct type_variant
{
279 GHashTable
*fields_by_tag
; /* Tuples (field tag, field index) */
280 struct type_scope
*scope
;
281 GArray
*fields
; /* Array of type_field */
282 GQuark tag_name
; /* TODO */
283 /* Tag name must be nonzero and must exist when defining the variant */
286 struct declaration_variant
{
287 struct declaration p
;
288 struct type_variant
*type
;
289 struct declaration_scope
*scope
;
290 struct declaration
*enum_tag
;
291 GArray
*fields
; /* Array of struct field */
292 struct field
*current_field
; /* Last field read */
299 struct type_scope
*scope
;
302 struct declaration_array
{
303 struct declaration p
;
304 struct type_array
*type
;
305 struct declaration_scope
*scope
;
306 struct field current_element
; /* struct field */
309 struct type_sequence
{
311 struct type_integer
*len_type
;
313 struct type_scope
*scope
;
316 struct declaration_sequence
{
317 struct declaration p
;
318 struct type_sequence
*type
;
319 struct declaration_scope
*scope
;
320 struct declaration_integer
*len
;
321 struct field current_element
; /* struct field */
325 * type_declaration is for typedef and typealias. They are registered
328 int register_type_declaration(GQuark type_name
, struct declaration
*declaration
,
329 struct type_scope
*scope
);
330 struct declaration
*lookup_type_declaration(GQuark type_name
,
331 struct type_scope
*scope
);
334 * Type scopes also contain a separate registry for struct, variant and
335 * enum types. Those register types rather than type declarations, so
336 * that a named variant can be declared without specifying its target
337 * "choice" tag field immediately.
339 int register_struct_type(GQuark struct_name
, struct type_struct
*struct_type
,
340 struct type_scope
*scope
);
341 struct type_struct
*lookup_struct_type(GQuark struct_name
,
342 struct type_scope
*scope
);
343 int register_variant_type(GQuark variant_name
,
344 struct type_variant
*variant_type
,
345 struct type_scope
*scope
);
346 struct type_variant
*lookup_variant_type(GQuark variant_name
,
347 struct type_scope
*scope
);
348 int register_enum_type(GQuark enum_name
, struct type_enum
*enum_type
,
349 struct type_scope
*scope
);
350 struct type_enum
*lookup_enum_type(GQuark enum_name
,
351 struct type_scope
*scope
);
353 struct type_scope
*new_type_scope(struct type_scope
*parent_scope
);
354 void free_type_scope(struct type_scope
*scope
);
357 * field_declaration is for field declarations. They are registered into
358 * declaration scopes.
361 lookup_field_declaration(GQuark field_name
,
362 struct declaration_scope
*scope
);
363 int register_field_declaration(GQuark field_name
,
364 struct declaration
*declaration
,
365 struct declaration_scope
*scope
);
366 struct declaration_scope
*
367 new_declaration_scope(struct declaration_scope
*parent_scope
);
368 void free_declaration_scope(struct declaration_scope
*scope
);
370 void type_ref(struct type
*type
);
371 void type_unref(struct type
*type
);
373 void declaration_ref(struct declaration
*declaration
);
374 void declaration_unref(struct declaration
*declaration
);
376 /* Nameless types can be created by passing a NULL name */
378 struct type_integer
*integer_type_new(const char *name
,
379 size_t len
, int byte_order
,
380 int signedness
, size_t alignment
);
383 * mantissa_len is the length of the number of bytes represented by the mantissa
384 * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
386 struct type_float
*float_type_new(const char *name
,
388 size_t exp_len
, int byte_order
,
392 * A GQuark can be translated to/from strings with g_quark_from_string() and
393 * g_quark_to_string().
397 * Returns a GArray of GQuark or NULL.
398 * Caller must release the GArray with g_array_unref().
400 GArray
*enum_uint_to_quark_set(const struct type_enum
*enum_type
, uint64_t v
);
403 * Returns a GArray of GQuark or NULL.
404 * Caller must release the GArray with g_array_unref().
406 GArray
*enum_int_to_quark_set(const struct type_enum
*enum_type
, uint64_t v
);
409 * Returns a GArray of struct enum_range or NULL.
410 * Callers do _not_ own the returned GArray (and therefore _don't_ need to
413 GArray
*enum_quark_to_range_set(const struct type_enum
*enum_type
, GQuark q
);
414 void enum_signed_insert(struct type_enum
*enum_type
,
415 int64_t start
, int64_t end
, GQuark q
);
416 void enum_unsigned_insert(struct type_enum
*enum_type
,
417 uint64_t start
, uint64_t end
, GQuark q
);
418 size_t enum_get_nr_enumerators(struct type_enum
*enum_type
);
420 struct type_enum
*enum_type_new(const char *name
,
421 struct type_integer
*integer_type
);
423 struct type_struct
*struct_type_new(const char *name
,
424 struct type_scope
*parent_scope
);
425 void struct_type_add_field(struct type_struct
*struct_type
,
426 const char *field_name
, struct type
*field_type
);
428 * Returns the index of a field within a structure.
430 unsigned long struct_type_lookup_field_index(struct type_struct
*struct_type
,
433 * field returned only valid as long as the field structure is not appended to.
436 struct_type_get_field_from_index(struct type_struct
*struct_type
,
437 unsigned long index
);
439 struct_get_field_from_index(struct declaration_struct
*struct_declaration
,
440 unsigned long index
);
443 * The tag enumeration is validated to ensure that it contains only mappings
444 * from numeric values to a single tag. Overlapping tag value ranges are
445 * therefore forbidden.
447 struct type_variant
*variant_type_new(const char *name
,
448 struct type_scope
*parent_scope
);
449 void variant_type_add_field(struct type_variant
*variant_type
,
450 const char *tag_name
, struct type
*tag_type
);
452 variant_type_get_field_from_tag(struct type_variant
*variant_type
, GQuark tag
);
454 * Returns 0 on success, -EPERM on error.
456 int variant_declaration_set_tag(struct declaration_variant
*variant
,
457 struct declaration
*enum_tag
);
459 * Returns the field selected by the current tag value.
460 * field returned only valid as long as the variant structure is not appended
464 variant_get_current_field(struct declaration_variant
*variant
);
467 * elem_type passed as parameter now belongs to the array. No need to free it
468 * explicitly. "len" is the number of elements in the array.
470 struct type_array
*array_type_new(const char *name
,
471 size_t len
, struct type
*elem_type
,
472 struct type_scope
*parent_scope
);
475 * int_type and elem_type passed as parameter now belong to the sequence. No
476 * need to free them explicitly.
478 struct type_sequence
*sequence_type_new(const char *name
,
479 struct type_integer
*len_type
,
480 struct type
*elem_type
,
481 struct type_scope
*parent_scope
);
483 #endif /* _BABELTRACE_TYPES_H */