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 */
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 */
102 * type_free called with type ref is decremented to 0.
104 void (*type_free
)(struct type
*type
);
106 (*declaration_new
)(struct type
*type
,
107 struct declaration_scope
*parent_scope
);
109 * declaration_free called with declaration ref is decremented to 0.
111 void (*declaration_free
)(struct declaration
*declaration
);
113 * Declaration copy function. Knows how to find the child declaration
114 * from the parent declaration.
116 void (*copy
)(struct stream_pos
*dest
, const struct format
*fdest
,
117 struct stream_pos
*src
, const struct format
*fsrc
,
118 struct declaration
*declaration
);
123 int ref
; /* number of references to the declaration */
127 * Because we address in bits, bitfields end up being exactly the same as
128 * integers, except that their read/write functions must be able to deal with
129 * read/write non aligned on CHAR_BIT.
131 struct type_integer
{
133 size_t len
; /* length, in bits. */
134 int byte_order
; /* byte order */
138 struct declaration_integer
{
139 struct declaration p
;
140 struct type_integer
*type
;
141 /* Last values read */
150 struct type_integer
*sign
;
151 struct type_integer
*mantissa
;
152 struct type_integer
*exp
;
154 /* TODO: we might want to express more info about NaN, +inf and -inf */
157 struct declaration_float
{
158 struct declaration p
;
159 struct type_float
*type
;
160 /* Last values read */
165 * enum_val_equal assumes that signed and unsigned memory layout overlap.
171 } start
; /* lowest range value */
175 } end
; /* highest range value */
178 struct enum_range_to_quark
{
179 struct cds_list_head node
;
180 struct enum_range range
;
185 * We optimize the common case (range of size 1: single value) by creating a
186 * hash table mapping values to quark sets. We then lookup the ranges to
187 * complete the quark set.
189 * TODO: The proper structure to hold the range to quark set mapping would be an
190 * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
191 * time. Using a simple O(n) list search for now for implementation speed and
192 * given that we can expect to have a _relatively_ small number of enumeration
193 * ranges. This might become untrue if we are fed with symbol tables often
194 * required to lookup function names from instruction pointer value.
197 GHashTable
*value_to_quark_set
; /* (value, GQuark GArray) */
198 struct cds_list_head range_to_quark
; /* (range, GQuark) */
199 GHashTable
*quark_to_range_set
; /* (GQuark, range GArray) */
204 struct type_integer
*integer_type
;
205 struct enum_table table
;
208 struct declaration_enum
{
209 struct declaration p
;
210 struct declaration_integer
*integer
;
211 struct type_enum
*type
;
212 /* Last GQuark values read. Keeping a reference on the GQuark array. */
220 struct declaration_string
{
221 struct declaration p
;
222 struct type_string
*type
;
223 char *value
; /* freed at declaration_string teardown */
232 struct declaration
*type
;
237 GHashTable
*fields_by_name
; /* Tuples (field name, field index) */
238 GArray
*fields
; /* Array of type_field */
241 struct declaration_struct
{
242 struct declaration p
;
243 struct type_struct
*type
;
244 struct declaration_scope
*scope
;
245 GArray
*fields
; /* Array of struct field */
248 struct type_variant
{
250 GHashTable
*fields_by_tag
; /* Tuples (field tag, field index) */
251 GArray
*fields
; /* Array of type_field */
254 struct declaration_variant
{
255 struct declaration p
;
256 struct type_variant
*type
;
257 struct declaration_scope
*scope
;
258 struct declaration
*tag
;
259 GArray
*fields
; /* Array of struct field */
260 struct field
*current_field
; /* Last field read */
269 struct declaration_array
{
270 struct declaration p
;
271 struct type_array
*type
;
272 struct declaration_scope
*scope
;
273 struct field current_element
; /* struct field */
276 struct type_sequence
{
278 struct type_integer
*len_type
;
282 struct declaration_sequence
{
283 struct declaration p
;
284 struct type_sequence
*type
;
285 struct declaration_scope
*scope
;
286 struct declaration_integer
*len
;
287 struct field current_element
; /* struct field */
290 struct type
*lookup_type(GQuark qname
, struct declaration_scope
*scope
);
291 int register_type(struct type
*type
, struct declaration_scope
*scope
);
293 void type_ref(struct type
*type
);
294 void type_unref(struct type
*type
);
296 struct declaration_scope
*
297 new_declaration_scope(struct declaration_scope
*parent_scope
);
298 void free_declaration_scope(struct declaration_scope
*scope
);
300 void declaration_ref(struct declaration
*declaration
);
301 void declaration_unref(struct declaration
*declaration
);
303 /* Nameless types can be created by passing a NULL name */
305 struct type_integer
*integer_type_new(const char *name
,
306 size_t len
, int byte_order
,
307 int signedness
, size_t alignment
);
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_float
*float_type_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_enum
*enum_type
, uint64_t v
);
330 * Returns a GArray of GQuark or NULL.
331 * Caller must release the GArray with g_array_unref().
333 GArray
*enum_int_to_quark_set(const struct type_enum
*enum_type
, uint64_t v
);
336 * Returns a GArray of struct enum_range or NULL.
337 * Callers do _not_ own the returned GArray (and therefore _don't_ need to
340 GArray
*enum_quark_to_range_set(const struct type_enum
*enum_type
, GQuark q
);
341 void enum_signed_insert(struct type_enum
*enum_type
,
342 int64_t start
, int64_t end
, GQuark q
);
343 void enum_unsigned_insert(struct type_enum
*enum_type
,
344 uint64_t start
, uint64_t end
, GQuark q
);
345 size_t enum_get_nr_enumerators(struct type_enum
*enum_type
);
347 struct type_enum
*enum_type_new(const char *name
,
348 struct type_integer
*integer_type
);
350 struct type_struct
*struct_type_new(const char *name
);
351 void struct_type_add_field(struct type_struct
*struct_type
,
352 const char *field_name
, struct type
*field_type
);
354 * Returns the index of a field within a structure.
356 unsigned long struct_type_lookup_field_index(struct type_struct
*struct_type
,
359 * field returned only valid as long as the field structure is not appended to.
362 struct_type_get_field_from_index(struct type_struct
*struct_type
,
363 unsigned long index
);
365 struct_get_field_from_index(struct declaration_struct
*struct_declaration
,
366 unsigned long index
);
369 * The tag enumeration is validated to ensure that it contains only mappings
370 * from numeric values to a single tag. Overlapping tag value ranges are
371 * therefore forbidden.
373 struct type_variant
*variant_type_new(const char *name
);
374 void variant_type_add_field(struct type_variant
*variant_type
,
375 const char *tag_name
, struct type
*tag_type
);
377 variant_type_get_field_from_tag(struct type_variant
*variant_type
, GQuark tag
);
379 * Returns 0 on success, -EPERM on error.
381 int variant_declaration_set_tag(struct declaration_variant
*variant
,
382 struct declaration
*enum_tag
);
384 * Returns the field selected by the current tag value.
385 * field returned only valid as long as the variant structure is not appended
389 variant_get_current_field(struct declaration_variant
*variant
);
392 * elem_type passed as parameter now belongs to the array. No need to free it
393 * explicitly. "len" is the number of elements in the array.
395 struct type_array
*array_type_new(const char *name
,
396 size_t len
, struct type
*elem_type
);
399 * int_type and elem_type passed as parameter now belong to the sequence. No
400 * need to free them explicitly.
402 struct type_sequence
*sequence_type_new(const char *name
,
403 struct type_integer
*len_type
,
404 struct type
*elem_type
);
406 #endif /* _BABELTRACE_TYPES_H */