Commit | Line | Data |
---|---|---|
9843982d JD |
1 | #ifndef _BABELTRACE_CTF_EVENTS_H |
2 | #define _BABELTRACE_CTF_EVENTS_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * CTF events API | |
8 | * | |
9 | * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation | |
10 | * | |
11 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
12 | * Julien Desfossez <julien.desfossez@efficios.com> | |
13 | * | |
14 | * Permission is hereby granted, free of charge, to any person obtaining | |
15 | * a copy of this software and associated documentation files (the | |
16 | * "Software"), to deal in the Software without restriction, including | |
17 | * without limitation the rights to use, copy, modify, merge, publish, | |
18 | * distribute, sublicense, and/or sell copies of the Software, and to | |
19 | * permit persons to whom the Software is furnished to do so, subject to | |
20 | * the following conditions: | |
21 | * | |
22 | * The above copyright notice and this permission notice shall be | |
23 | * included in all copies or substantial portions of the Software. | |
c462e188 MD |
24 | * |
25 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
26 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
27 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
28 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
29 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
30 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
31 | * SOFTWARE. | |
9843982d JD |
32 | */ |
33 | ||
34 | #include <stdint.h> | |
e003ab50 | 35 | #include <babeltrace/context.h> |
03798a93 | 36 | #include <babeltrace/clock-types.h> |
9843982d | 37 | |
6946751f JD |
38 | #ifdef __cplusplus |
39 | extern "C" { | |
40 | #endif | |
41 | ||
0d69b916 | 42 | struct bt_definition; |
ecc54f11 | 43 | struct bt_declaration; |
c50d2a7a | 44 | struct bt_ctf_event; |
e003ab50 | 45 | struct bt_ctf_event_decl; |
64c2c249 | 46 | struct bt_ctf_field_decl; |
9843982d JD |
47 | |
48 | /* | |
49 | * the top-level scopes in CTF | |
50 | */ | |
51 | enum bt_ctf_scope { | |
52 | BT_TRACE_PACKET_HEADER = 0, | |
53 | BT_STREAM_PACKET_CONTEXT = 1, | |
54 | BT_STREAM_EVENT_HEADER = 2, | |
55 | BT_STREAM_EVENT_CONTEXT = 3, | |
56 | BT_EVENT_CONTEXT = 4, | |
57 | BT_EVENT_FIELDS = 5, | |
58 | }; | |
59 | ||
60 | /* | |
61 | * the supported CTF types | |
62 | */ | |
63 | enum ctf_type_id { | |
64 | CTF_TYPE_UNKNOWN = 0, | |
65 | CTF_TYPE_INTEGER, | |
66 | CTF_TYPE_FLOAT, | |
67 | CTF_TYPE_ENUM, | |
68 | CTF_TYPE_STRING, | |
69 | CTF_TYPE_STRUCT, | |
70 | CTF_TYPE_UNTAGGED_VARIANT, | |
71 | CTF_TYPE_VARIANT, | |
72 | CTF_TYPE_ARRAY, | |
73 | CTF_TYPE_SEQUENCE, | |
74 | NR_CTF_TYPES, | |
75 | }; | |
76 | ||
8673030f JD |
77 | /* |
78 | * the supported CTF string encodings | |
79 | */ | |
80 | enum ctf_string_encoding { | |
81 | CTF_STRING_NONE = 0, | |
82 | CTF_STRING_UTF8, | |
83 | CTF_STRING_ASCII, | |
84 | CTF_STRING_UNKNOWN, | |
85 | }; | |
86 | ||
9843982d JD |
87 | /* |
88 | * bt_ctf_get_top_level_scope: return a definition of the top-level scope | |
89 | * | |
90 | * Top-level scopes are defined in the bt_ctf_scope enum. | |
91 | * In order to get a field or a field list, the user needs to pass a | |
92 | * scope as argument, this scope can be a top-level scope or a scope | |
93 | * relative to an arbitrary field. This function provides the mapping | |
94 | * between the enum and the actual definition of top-level scopes. | |
95 | * On error return NULL. | |
96 | */ | |
0d69b916 | 97 | const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *event, |
9843982d JD |
98 | enum bt_ctf_scope scope); |
99 | ||
100 | /* | |
101 | * bt_ctf_event_get_name: returns the name of the event or NULL on error | |
102 | */ | |
c50d2a7a | 103 | const char *bt_ctf_event_name(const struct bt_ctf_event *event); |
9843982d JD |
104 | |
105 | /* | |
d40ee8ec | 106 | * bt_ctf_get_cycles: returns the timestamp of the event as written |
03798a93 | 107 | * in the packet (in cycles) or -1ULL on error. |
57f3005e | 108 | */ |
d40ee8ec | 109 | uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *event); |
57f3005e SJD |
110 | |
111 | /* | |
d40ee8ec | 112 | * bt_ctf_get_timestamp: returns the timestamp of the event offsetted |
03798a93 | 113 | * with the system clock source (in ns) or -1ULL on error |
9843982d | 114 | */ |
d40ee8ec | 115 | uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event); |
9843982d JD |
116 | |
117 | /* | |
bb337d59 MD |
118 | * bt_ctf_get_field_list: obtain the list of fields for compound type |
119 | * | |
f5464725 JD |
120 | * This function can be used to obtain the list of fields contained |
121 | * within a top-level scope of an event or a compound type: array, | |
122 | * sequence, structure, or variant. | |
bb337d59 MD |
123 | |
124 | * This function sets the "list" pointer to an array of definition | |
aacd0c69 JD |
125 | * pointers and set count to the number of elements in the array. |
126 | * Return 0 on success and a negative value on error. | |
bb337d59 MD |
127 | * |
128 | * The content pointed to by "list" should *not* be freed. It stays | |
129 | * valid as long as the event is unchanged (as long as the iterator | |
130 | * from which the event is extracted is unchanged). | |
9843982d | 131 | */ |
c50d2a7a | 132 | int bt_ctf_get_field_list(const struct bt_ctf_event *event, |
0d69b916 JD |
133 | const struct bt_definition *scope, |
134 | struct bt_definition const * const **list, | |
9843982d JD |
135 | unsigned int *count); |
136 | ||
137 | /* | |
138 | * bt_ctf_get_field: returns the definition of a specific field | |
139 | */ | |
0d69b916 JD |
140 | const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *event, |
141 | const struct bt_definition *scope, | |
9843982d JD |
142 | const char *field); |
143 | ||
144 | /* | |
145 | * bt_ctf_get_index: if the field is an array or a sequence, return the element | |
146 | * at position index, otherwise return NULL; | |
147 | */ | |
0d69b916 JD |
148 | const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *event, |
149 | const struct bt_definition *field, | |
9843982d JD |
150 | unsigned int index); |
151 | ||
152 | /* | |
153 | * bt_ctf_field_name: returns the name of a field or NULL on error | |
154 | */ | |
0d69b916 | 155 | const char *bt_ctf_field_name(const struct bt_definition *def); |
9843982d | 156 | |
2bdfa4cf | 157 | /* |
b14d90be JD |
158 | * bt_ctf_get_decl_from_def: return the declaration of a field from |
159 | * its definition or NULL on error | |
2bdfa4cf | 160 | */ |
ecc54f11 | 161 | const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *def); |
b14d90be JD |
162 | |
163 | /* | |
164 | * bt_ctf_get_decl_from_field_decl: return the declaration of a field from | |
165 | * a field_decl or NULL on error | |
166 | */ | |
ecc54f11 | 167 | const struct bt_declaration *bt_ctf_get_decl_from_field_decl( |
b14d90be | 168 | const struct bt_ctf_field_decl *field); |
2bdfa4cf | 169 | |
9843982d JD |
170 | /* |
171 | * bt_ctf_field_type: returns the type of a field or -1 if unknown | |
172 | */ | |
ecc54f11 | 173 | enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *decl); |
9843982d | 174 | |
8673030f JD |
175 | /* |
176 | * bt_ctf_get_int_signedness: return the signedness of an integer | |
177 | * | |
178 | * return 0 if unsigned | |
179 | * return 1 if signed | |
180 | * return -1 on error | |
181 | */ | |
ecc54f11 | 182 | int bt_ctf_get_int_signedness(const struct bt_declaration *decl); |
8673030f JD |
183 | |
184 | /* | |
185 | * bt_ctf_get_int_base: return the base of an int or a negative value on error | |
186 | */ | |
ecc54f11 | 187 | int bt_ctf_get_int_base(const struct bt_declaration *decl); |
8673030f JD |
188 | |
189 | /* | |
190 | * bt_ctf_get_int_byte_order: return the byte order of an int or a negative | |
191 | * value on error | |
192 | */ | |
ecc54f11 | 193 | int bt_ctf_get_int_byte_order(const struct bt_declaration *decl); |
8673030f | 194 | |
fef0e521 MD |
195 | /* |
196 | * bt_ctf_get_int_len: return the size, in bits, of an int or a negative | |
197 | * value on error | |
198 | */ | |
ecc54f11 | 199 | ssize_t bt_ctf_get_int_len(const struct bt_declaration *decl); |
fef0e521 | 200 | |
8673030f | 201 | /* |
c22b9327 JD |
202 | * bt_ctf_get_encoding: return the encoding of an int, a string, or of |
203 | * the integer contained in a char array or a sequence. | |
8673030f JD |
204 | * return a negative value on error |
205 | */ | |
ecc54f11 | 206 | enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *decl); |
8673030f JD |
207 | |
208 | /* | |
209 | * bt_ctf_get_array_len: return the len of an array or a negative | |
210 | * value on error | |
211 | */ | |
ecc54f11 | 212 | int bt_ctf_get_array_len(const struct bt_declaration *decl); |
8673030f | 213 | |
3a068915 JG |
214 | /* |
215 | * bt_ctf_get_struct_field_count: return the number of fields in a structure. | |
216 | * Returns a negative value on error. | |
217 | */ | |
218 | uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *field); | |
219 | ||
9843982d JD |
220 | /* |
221 | * Field access functions | |
222 | * | |
223 | * These functions return the value associated with the field passed in | |
224 | * parameter. | |
225 | * | |
226 | * If the field does not exist or is not of the type requested, the value | |
227 | * returned is undefined. To check if an error occured, use the | |
b330165c | 228 | * bt_ctf_field_get_error() function after accessing a field. |
4d25c350 MD |
229 | * |
230 | * bt_ctf_get_enum_int gets the integer field of an enumeration. | |
231 | * bt_ctf_get_enum_str gets the string matching the current enumeration | |
232 | * value, or NULL if the current value does not match any string. | |
9843982d | 233 | */ |
0d69b916 JD |
234 | uint64_t bt_ctf_get_uint64(const struct bt_definition *field); |
235 | int64_t bt_ctf_get_int64(const struct bt_definition *field); | |
236 | const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field); | |
237 | const char *bt_ctf_get_enum_str(const struct bt_definition *field); | |
238 | char *bt_ctf_get_char_array(const struct bt_definition *field); | |
239 | char *bt_ctf_get_string(const struct bt_definition *field); | |
e5a73b90 | 240 | double bt_ctf_get_float(const struct bt_definition *field); |
812e6682 | 241 | const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field); |
3a068915 JG |
242 | const struct bt_definition *bt_ctf_get_struct_field_index( |
243 | const struct bt_definition *field, uint64_t i); | |
9843982d JD |
244 | |
245 | /* | |
b330165c | 246 | * bt_ctf_field_get_error: returns the last error code encountered while |
9843982d JD |
247 | * accessing a field and reset the error flag. |
248 | * Return 0 if no error, a negative value otherwise. | |
249 | */ | |
250 | int bt_ctf_field_get_error(void); | |
251 | ||
e003ab50 | 252 | /* |
f5464725 JD |
253 | * bt_ctf_get_event_decl_list: get a list of all the event declarations in |
254 | * a trace. | |
255 | * | |
256 | * The list array is pointed to the array of event declarations. | |
257 | * The number of events in the array is written in count. | |
e003ab50 JD |
258 | * |
259 | * Return 0 on success and a negative value on error. | |
f5464725 JD |
260 | * |
261 | * The content pointed to by "list" should *not* be freed. It stays | |
262 | * valid as long as the trace is opened. | |
e003ab50 JD |
263 | */ |
264 | int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx, | |
64c2c249 | 265 | struct bt_ctf_event_decl * const **list, |
e003ab50 JD |
266 | unsigned int *count); |
267 | ||
268 | /* | |
269 | * bt_ctf_get_decl_event_name: return the name of the event or NULL on error | |
270 | */ | |
271 | const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event); | |
272 | ||
78564612 AM |
273 | /* |
274 | * bt_ctf_get_decl_event_id: return the event-ID of the event or -1ULL on error | |
275 | */ | |
276 | uint64_t bt_ctf_get_decl_event_id(const struct bt_ctf_event_decl *event); | |
277 | ||
64c2c249 | 278 | /* |
f5464725 JD |
279 | * bt_ctf_get_decl_fields: get all field declarations in a scope of an event |
280 | * | |
281 | * The list array is pointed to the array of field declaration. | |
282 | * The number of field declaration in the array is written in count. | |
64c2c249 JD |
283 | * |
284 | * Returns 0 on success and a negative value on error | |
f5464725 JD |
285 | * |
286 | * The content pointed to by "list" should *not* be freed. It stays | |
287 | * valid as long as the trace is opened. | |
64c2c249 JD |
288 | */ |
289 | int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl, | |
290 | enum bt_ctf_scope scope, | |
291 | struct bt_ctf_field_decl const * const **list, | |
292 | unsigned int *count); | |
293 | ||
294 | /* | |
295 | * bt_ctf_get_decl_field_name: return the name of a field decl or NULL on error | |
296 | */ | |
297 | const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field); | |
298 | ||
6946751f JD |
299 | #ifdef __cplusplus |
300 | } | |
301 | #endif | |
302 | ||
9843982d | 303 | #endif /* _BABELTRACE_CTF_EVENTS_H */ |