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
);
90 /* Type declaration scope */
91 struct declaration_scope
{
92 /* Hash table mapping type name GQuark to struct type_class */
93 GHashTable
*type_classes
;
94 struct declaration_scope
*parent_scope
;
98 GQuark name
; /* type name */
99 size_t alignment
; /* type alignment, in bits */
100 int ref
; /* number of references to the type class */
102 * class_free called with type class ref is decremented to 0.
104 void (*class_free
)(struct type_class
*type_class
);
105 struct type
*(*type_new
)(struct type_class
*_class
,
106 struct declaration_scope
*parent_scope
);
108 * type_free called with type ref is decremented to 0.
110 void (*type_free
)(struct type
*type
);
112 * Type copy function. Knows how to find the child type from the parent
115 void (*copy
)(struct stream_pos
*dest
, const struct format
*fdest
,
116 struct stream_pos
*src
, const struct format
*fsrc
,
121 struct type_class
*_class
;
122 int ref
; /* number of references to the type instance */
126 * Because we address in bits, bitfields end up being exactly the same as
127 * integers, except that their read/write functions must be able to deal with
128 * read/write non aligned on CHAR_BIT.
130 struct type_class_integer
{
132 size_t len
; /* length, in bits. */
133 int byte_order
; /* byte order */
137 struct type_integer
{
139 struct type_class_integer
*_class
;
140 /* Last values read */
147 struct type_class_float
{
149 struct type_class_integer
*sign
;
150 struct type_class_integer
*mantissa
;
151 struct type_class_integer
*exp
;
153 /* TODO: we might want to express more info about NaN, +inf and -inf */
158 struct type_class_float
*_class
;
159 /* Last values read */
164 * enum_val_equal assumes that signed and unsigned memory layout overlap.
170 } start
; /* lowest range value */
174 } end
; /* highest range value */
177 struct enum_range_to_quark
{
178 struct cds_list_head node
;
179 struct enum_range range
;
184 * We optimize the common case (range of size 1: single value) by creating a
185 * hash table mapping values to quark sets. We then lookup the ranges to
186 * complete the quark set.
188 * TODO: The proper structure to hold the range to quark set mapping would be an
189 * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
190 * time. Using a simple O(n) list search for now for implementation speed and
191 * given that we can expect to have a _relatively_ small number of enumeration
192 * ranges. This might become untrue if we are fed with symbol tables often
193 * required to lookup function names from instruction pointer value.
196 GHashTable
*value_to_quark_set
; /* (value, GQuark GArray) */
197 struct cds_list_head range_to_quark
; /* (range, GQuark) */
198 GHashTable
*quark_to_range_set
; /* (GQuark, range GArray) */
201 struct type_class_enum
{
202 struct type_class_integer p
; /* inherit from integer */
203 struct enum_table table
;
208 struct type_class_enum
*_class
;
209 /* Last GQuark values read. Keeping a reference on the GQuark array. */
213 struct type_class_string
{
219 struct type_class_string
*_class
;
220 char *value
; /* freed at type_string teardown */
223 struct type_class_field
{
225 struct type_class
*type_class
;
232 struct type_class_struct
{
234 GHashTable
*fields_by_name
; /* Tuples (field name, field index) */
235 GArray
*fields
; /* Array of type_class_field */
240 struct type_class_struct
*_class
;
241 struct declaration_scope
*scope
;
242 GArray
*fields
; /* Array of struct field */
245 struct type_class_variant
{
247 GHashTable
*fields_by_tag
; /* Tuples (field tag, field index) */
248 GArray
*fields
; /* Array of type_class_field */
251 struct type_variant
{
253 struct type_class_variant
*_class
;
254 struct declaration_scope
*scope
;
256 GArray
*fields
; /* Array of struct field */
257 struct field
*current_field
; /* Last field read */
260 struct type_class_array
{
263 struct type_class
*elem
;
268 struct type_class_array
*_class
;
269 struct declaration_scope
*scope
;
270 struct field current_element
; /* struct field */
273 struct type_class_sequence
{
275 struct type_class_integer
*len_class
;
276 struct type_class
*elem
;
279 struct type_sequence
{
281 struct type_class_sequence
*_class
;
282 struct declaration_scope
*scope
;
283 struct type_integer
*len
;
284 struct field current_element
; /* struct field */
287 struct type_class
*lookup_type_class(GQuark qname
,
288 struct declaration_scope
*scope
);
289 int register_type_class(struct type_class
*type_class
,
290 struct declaration_scope
*scope
);
292 void type_class_ref(struct type_class
*type_class
);
293 void type_class_unref(struct type_class
*type_class
);
295 struct declaration_scope
*
296 new_declaration_scope(struct declaration_scope
*parent_scope
);
297 void free_declaration_scope(struct declaration_scope
*scope
);
299 void type_ref(struct type
*type
);
300 void type_unref(struct type
*type
);
302 /* Nameless types can be created by passing a NULL name */
304 struct type_class_integer
*integer_type_class_new(const char *name
,
305 size_t len
, int byte_order
,
310 * mantissa_len is the length of the number of bytes represented by the mantissa
311 * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
313 struct type_class_float
*float_type_class_new(const char *name
,
315 size_t exp_len
, int byte_order
,
319 * A GQuark can be translated to/from strings with g_quark_from_string() and
320 * g_quark_to_string().
324 * Returns a GArray of GQuark or NULL.
325 * Caller must release the GArray with g_array_unref().
327 GArray
*enum_uint_to_quark_set(const struct type_class_enum
*enum_class
,
331 * Returns a GArray of GQuark or NULL.
332 * Caller must release the GArray with g_array_unref().
334 GArray
*enum_int_to_quark_set(const struct type_class_enum
*enum_class
,
338 * Returns a GArray of struct enum_range or NULL.
339 * Callers do _not_ own the returned GArray (and therefore _don't_ need to
342 GArray
*enum_quark_to_range_set(const struct type_class_enum
*enum_class
,
344 void enum_signed_insert(struct type_class_enum
*enum_class
,
345 int64_t start
, int64_t end
, GQuark q
);
346 void enum_unsigned_insert(struct type_class_enum
*enum_class
,
347 uint64_t start
, uint64_t end
, GQuark q
);
348 size_t enum_get_nr_enumerators(struct type_class_enum
*enum_class
);
350 struct type_class_enum
*enum_type_class_new(const char *name
,
351 size_t len
, int byte_order
,
355 struct type_class_struct
*struct_type_class_new(const char *name
);
356 void struct_type_class_add_field(struct type_class_struct
*struct_class
,
357 const char *field_name
,
358 struct type_class
*type_class
);
360 * Returns the index of a field within a structure.
363 struct_type_class_lookup_field_index(struct type_class_struct
*struct_class
,
366 * field returned only valid as long as the field structure is not appended to.
368 struct type_class_field
*
369 struct_type_class_get_field_from_index(struct type_class_struct
*struct_class
,
370 unsigned long index
);
372 struct_type_get_field_from_index(struct type_struct
*_struct
,
373 unsigned long index
);
376 * The tag enumeration is validated to ensure that it contains only mappings
377 * from numeric values to a single tag. Overlapping tag value ranges are
378 * therefore forbidden.
380 struct type_class_variant
*variant_type_class_new(const char *name
);
381 void variant_type_class_add_field(struct type_class_variant
*variant_class
,
382 const char *tag_name
,
383 struct type_class
*type_class
);
384 struct type_class_field
*
385 variant_type_class_get_field_from_tag(struct type_class_variant
*variant_class
,
388 * Returns 0 on success, -EPERM on error.
390 int variant_type_set_tag(struct type_variant
*variant
,
391 struct type
*enum_tag_instance
);
393 * Returns the field selected by the current tag value.
394 * field returned only valid as long as the variant structure is not appended
398 variant_type_get_current_field(struct type_variant
*variant
);
401 * elem_class passed as parameter now belongs to the array. No need to free it
402 * explicitly. "len" is the number of elements in the array.
404 struct type_class_array
*array_type_class_new(const char *name
,
406 struct type_class
*elem_class
);
409 * int_class and elem_class passed as parameter now belongs to the sequence. No
410 * need to free them explicitly.
412 struct type_class_sequence
*sequence_type_class_new(const char *name
,
413 struct type_class_integer
*len_class
,
414 struct type_class
*elem_class
);
416 #endif /* _BABELTRACE_TYPES_H */