1 #ifndef _BABELTRACE_TYPES_H
2 #define _BABELTRACE_TYPES_H
9 * Copyright 2010 - 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>
30 /* Preallocate this many fields for structures */
31 #define DEFAULT_NR_STRUCT_FIELDS 8
34 * Always update stream_pos with move_pos and init_pos.
37 unsigned char *base
; /* Base address */
38 size_t offset
; /* Offset from base, in bits */
39 int dummy
; /* Dummy position, for length calculation */
43 void init_pos(struct stream_pos
*pos
, unsigned char *base
)
45 pos
->base
= base
; /* initial base, page-aligned */
51 * move_pos - move position of a relative bit offset
53 * TODO: allow larger files by updating base too.
56 void move_pos(struct stream_pos
*pos
, size_t offset
)
58 pos
->offset
= pos
->offset
+ offset
;
62 * align_pos - align position on a bit offset (> 0)
64 * TODO: allow larger files by updating base too.
67 void align_pos(struct stream_pos
*pos
, size_t offset
)
69 pos
->offset
+= offset_align(pos
->offset
, offset
);
73 void copy_pos(struct stream_pos
*dest
, struct stream_pos
*src
)
75 memcpy(dest
, src
, sizeof(struct stream_pos
));
79 unsigned char *get_pos_addr(struct stream_pos
*pos
)
81 /* Only makes sense to get the address after aligning on CHAR_BIT */
82 assert(!(pos
->offset
% CHAR_BIT
));
83 return pos
->base
+ (pos
->offset
/ CHAR_BIT
);
89 GQuark name
; /* type name */
90 size_t alignment
; /* type alignment, in bits */
91 int ref
; /* number of references to the type */
93 * Type copy function. Knows how to find the child type_class from the
96 void (*copy
)(struct stream_pos
*dest
, const struct format
*fdest
,
97 struct stream_pos
*src
, const struct format
*fsrc
,
98 const struct type_class
*type_class
);
99 void (*free
)(struct type_class
*type_class
);
103 * Because we address in bits, bitfields end up being exactly the same as
104 * integers, except that their read/write functions must be able to deal with
105 * read/write non aligned on CHAR_BIT.
107 struct type_class_integer
{
109 size_t len
; /* length, in bits. */
110 int byte_order
; /* byte order */
114 struct type_class_float
{
116 struct type_class_integer
*sign
;
117 struct type_class_integer
*mantissa
;
118 struct type_class_integer
*exp
;
120 /* TODO: we might want to express more info about NaN, +inf and -inf */
124 GHashTable
*value_to_quark
; /* Tuples (value, GQuark) */
125 GHashTable
*quark_to_value
; /* Tuples (GQuark, value) */
128 struct type_class_enum
{
129 struct type_class_integer p
; /* inherit from integer */
130 struct enum_table table
;
133 struct type_class_string
{
139 struct type_class
*type_class
;
142 struct type_class_struct
{
144 GHashTable
*fields_by_name
; /* Tuples (field name, field index) */
145 GArray
*fields
; /* Array of fields */
148 struct type_class_array
{
151 struct type_class
*elem
;
154 struct type_class_sequence
{
156 struct type_class_integer
*len_class
;
157 struct type_class
*elem
;
160 struct type_class
*lookup_type(GQuark qname
);
161 int register_type(struct type_class
*type_class
);
163 void type_ref(struct type_class
*type_class
);
164 void type_unref(struct type_class
*type_class
);
166 /* Nameless types can be created by passing a NULL name */
168 struct type_class_integer
*integer_type_new(const char *name
,
169 size_t len
, int byte_order
,
172 void integer_type_free(struct type_class_integer
*int_class
);
175 * mantissa_len is the length of the number of bytes represented by the mantissa
176 * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
178 struct type_class_float
*float_type_new(const char *name
,
180 size_t exp_len
, int byte_order
,
182 void float_type_free(struct type_class_float
*float_class
);
185 * A GQuark can be translated to/from strings with g_quark_from_string() and
186 * g_quark_to_string().
188 GQuark
enum_uint_to_quark(const struct type_class_enum
*enum_class
, uint64_t v
);
189 GQuark
enum_int_to_quark(const struct type_class_enum
*enum_class
, uint64_t v
);
190 uint64_t enum_quark_to_uint(const struct type_class_enum
*enum_class
,
192 int64_t enum_quark_to_int(const struct type_class_enum
*enum_class
,
194 void enum_signed_insert(struct type_class_enum
*enum_class
,
195 int64_t v
, GQuark q
);
196 void enum_unsigned_insert(struct type_class_enum
*enum_class
,
197 uint64_t v
, GQuark q
);
199 struct type_class_enum
*enum_type_new(const char *name
,
200 size_t len
, int byte_order
,
203 void enum_type_free(struct type_class_enum
*enum_class
);
205 struct type_class_struct
*struct_type_new(const char *name
);
206 void struct_type_free(struct type_class_struct
*struct_class
);
207 void struct_type_add_field(struct type_class_struct
*struct_class
,
208 const char *field_name
,
209 struct type_class
*type_class
);
211 * Returns the index of a field within a structure.
214 struct_type_lookup_field_index(struct type_class_struct
*struct_class
,
217 * field returned only valid as long as the field structure is not appended to.
220 struct_type_get_field_from_index(struct type_class_struct
*struct_class
,
221 unsigned long index
);
224 * elem_class passed as parameter now belongs to the array. No need to free it
227 struct type_class_array
*array_type_new(const char *name
,
229 struct type_class
*elem_class
);
230 void array_type_free(struct type_class_array
*array_class
);
233 * int_class and elem_class passed as parameter now belongs to the sequence. No
234 * need to free them explicitely.
236 struct type_class_sequence
*sequence_type_new(const char *name
,
237 struct type_class_integer
*len_class
,
238 struct type_class
*elem_class
);
239 void sequence_type_free(struct type_class_sequence
*sequence_class
);
241 #endif /* _BABELTRACE_TYPES_H */
This page took 0.044246 seconds and 6 git commands to generate.