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 /* Hash table mapping field name GQuark to struct declaration */
95 GHashTable
*declarations
;
96 struct declaration_scope
*parent_scope
;
100 GQuark name
; /* type name */
101 size_t alignment
; /* type alignment, in bits */
102 int ref
; /* number of references to the type */
104 * type_free called with type ref is decremented to 0.
106 void (*type_free
)(struct type
*type
);
108 (*declaration_new
)(struct type
*type
,
109 struct declaration_scope
*parent_scope
);
111 * declaration_free called with declaration ref is decremented to 0.
113 void (*declaration_free
)(struct declaration
*declaration
);
115 * Declaration copy function. Knows how to find the child declaration
116 * from the parent declaration.
118 void (*copy
)(struct stream_pos
*dest
, const struct format
*fdest
,
119 struct stream_pos
*src
, const struct format
*fsrc
,
120 struct declaration
*declaration
);
125 int ref
; /* number of references to the declaration */
129 * Because we address in bits, bitfields end up being exactly the same as
130 * integers, except that their read/write functions must be able to deal with
131 * read/write non aligned on CHAR_BIT.
133 struct type_integer
{
135 size_t len
; /* length, in bits. */
136 int byte_order
; /* byte order */
140 struct declaration_integer
{
141 struct declaration p
;
142 struct type_integer
*type
;
143 /* Last values read */
152 struct type_integer
*sign
;
153 struct type_integer
*mantissa
;
154 struct type_integer
*exp
;
156 /* TODO: we might want to express more info about NaN, +inf and -inf */
159 struct declaration_float
{
160 struct declaration p
;
161 struct type_float
*type
;
162 /* Last values read */
167 * enum_val_equal assumes that signed and unsigned memory layout overlap.
173 } start
; /* lowest range value */
177 } end
; /* highest range value */
180 struct enum_range_to_quark
{
181 struct cds_list_head node
;
182 struct enum_range range
;
187 * We optimize the common case (range of size 1: single value) by creating a
188 * hash table mapping values to quark sets. We then lookup the ranges to
189 * complete the quark set.
191 * TODO: The proper structure to hold the range to quark set mapping would be an
192 * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
193 * time. Using a simple O(n) list search for now for implementation speed and
194 * given that we can expect to have a _relatively_ small number of enumeration
195 * ranges. This might become untrue if we are fed with symbol tables often
196 * required to lookup function names from instruction pointer value.
199 GHashTable
*value_to_quark_set
; /* (value, GQuark GArray) */
200 struct cds_list_head range_to_quark
; /* (range, GQuark) */
201 GHashTable
*quark_to_range_set
; /* (GQuark, range GArray) */
206 struct type_integer
*integer_type
;
207 struct enum_table table
;
210 struct declaration_enum
{
211 struct declaration p
;
212 struct declaration_integer
*integer
;
213 struct type_enum
*type
;
214 /* Last GQuark values read. Keeping a reference on the GQuark array. */
222 struct declaration_string
{
223 struct declaration p
;
224 struct type_string
*type
;
225 char *value
; /* freed at declaration_string teardown */
235 struct declaration
*declaration
;
240 GHashTable
*fields_by_name
; /* Tuples (field name, field index) */
241 GArray
*fields
; /* Array of type_field */
244 struct declaration_struct
{
245 struct declaration p
;
246 struct type_struct
*type
;
247 struct declaration_scope
*scope
;
248 GArray
*fields
; /* Array of struct field */
251 struct type_variant
{
253 GHashTable
*fields_by_tag
; /* Tuples (field tag, field index) */
254 GArray
*fields
; /* Array of type_field */
257 struct declaration_variant
{
258 struct declaration p
;
259 struct type_variant
*type
;
260 struct declaration_scope
*scope
;
261 struct declaration
*enum_tag
;
262 GArray
*fields
; /* Array of struct field */
263 struct field
*current_field
; /* Last field read */
272 struct declaration_array
{
273 struct declaration p
;
274 struct type_array
*type
;
275 struct declaration_scope
*scope
;
276 struct field current_element
; /* struct field */
279 struct type_sequence
{
281 struct type_integer
*len_type
;
285 struct declaration_sequence
{
286 struct declaration p
;
287 struct type_sequence
*type
;
288 struct declaration_scope
*scope
;
289 struct declaration_integer
*len
;
290 struct field current_element
; /* struct field */
293 struct type
*lookup_type(GQuark type_name
, struct declaration_scope
*scope
);
294 int register_type(struct type
*type
, struct declaration_scope
*scope
);
297 lookup_declaration(GQuark field_name
, struct declaration_scope
*scope
);
298 int register_declaration(GQuark field_name
, struct declaration
*declaration
,
299 struct declaration_scope
*scope
);
301 void type_ref(struct type
*type
);
302 void type_unref(struct type
*type
);
304 struct declaration_scope
*
305 new_declaration_scope(struct declaration_scope
*parent_scope
);
306 void free_declaration_scope(struct declaration_scope
*scope
);
308 void declaration_ref(struct declaration
*declaration
);
309 void declaration_unref(struct declaration
*declaration
);
311 /* Nameless types can be created by passing a NULL name */
313 struct type_integer
*integer_type_new(const char *name
,
314 size_t len
, int byte_order
,
315 int signedness
, size_t alignment
);
318 * mantissa_len is the length of the number of bytes represented by the mantissa
319 * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
321 struct type_float
*float_type_new(const char *name
,
323 size_t exp_len
, int byte_order
,
327 * A GQuark can be translated to/from strings with g_quark_from_string() and
328 * g_quark_to_string().
332 * Returns a GArray of GQuark or NULL.
333 * Caller must release the GArray with g_array_unref().
335 GArray
*enum_uint_to_quark_set(const struct type_enum
*enum_type
, uint64_t v
);
338 * Returns a GArray of GQuark or NULL.
339 * Caller must release the GArray with g_array_unref().
341 GArray
*enum_int_to_quark_set(const struct type_enum
*enum_type
, uint64_t v
);
344 * Returns a GArray of struct enum_range or NULL.
345 * Callers do _not_ own the returned GArray (and therefore _don't_ need to
348 GArray
*enum_quark_to_range_set(const struct type_enum
*enum_type
, GQuark q
);
349 void enum_signed_insert(struct type_enum
*enum_type
,
350 int64_t start
, int64_t end
, GQuark q
);
351 void enum_unsigned_insert(struct type_enum
*enum_type
,
352 uint64_t start
, uint64_t end
, GQuark q
);
353 size_t enum_get_nr_enumerators(struct type_enum
*enum_type
);
355 struct type_enum
*enum_type_new(const char *name
,
356 struct type_integer
*integer_type
);
358 struct type_struct
*struct_type_new(const char *name
);
359 void struct_type_add_field(struct type_struct
*struct_type
,
360 const char *field_name
, struct type
*field_type
);
362 * Returns the index of a field within a structure.
364 unsigned long struct_type_lookup_field_index(struct type_struct
*struct_type
,
367 * field returned only valid as long as the field structure is not appended to.
370 struct_type_get_field_from_index(struct type_struct
*struct_type
,
371 unsigned long index
);
373 struct_get_field_from_index(struct declaration_struct
*struct_declaration
,
374 unsigned long index
);
377 * The tag enumeration is validated to ensure that it contains only mappings
378 * from numeric values to a single tag. Overlapping tag value ranges are
379 * therefore forbidden.
381 struct type_variant
*variant_type_new(const char *name
);
382 void variant_type_add_field(struct type_variant
*variant_type
,
383 const char *tag_name
, struct type
*tag_type
);
385 variant_type_get_field_from_tag(struct type_variant
*variant_type
, GQuark tag
);
387 * Returns 0 on success, -EPERM on error.
389 int variant_declaration_set_tag(struct declaration_variant
*variant
,
390 struct declaration
*enum_tag
);
392 * Returns the field selected by the current tag value.
393 * field returned only valid as long as the variant structure is not appended
397 variant_get_current_field(struct declaration_variant
*variant
);
400 * elem_type passed as parameter now belongs to the array. No need to free it
401 * explicitly. "len" is the number of elements in the array.
403 struct type_array
*array_type_new(const char *name
,
404 size_t len
, struct type
*elem_type
);
407 * int_type and elem_type passed as parameter now belong to the sequence. No
408 * need to free them explicitly.
410 struct type_sequence
*sequence_type_new(const char *name
,
411 struct type_integer
*len_type
,
412 struct type
*elem_type
);
414 #endif /* _BABELTRACE_TYPES_H */