Commit | Line | Data |
---|---|---|
2e33ac5a PP |
1 | #ifndef BABELTRACE_CTF_IR_FIELD_TYPES_H |
2 | #define BABELTRACE_CTF_IR_FIELD_TYPES_H | |
adc315b8 JG |
3 | |
4 | /* | |
2e33ac5a | 5 | * BabelTrace - CTF IR: Event field types |
adc315b8 | 6 | * |
de9dd397 | 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
adc315b8 JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | * | |
29 | * The Common Trace Format (CTF) Specification is available at | |
30 | * http://www.efficios.com/ctf | |
31 | */ | |
32 | ||
adc315b8 | 33 | #include <stdint.h> |
c3c35de4 | 34 | #include <stddef.h> |
adc315b8 JG |
35 | |
36 | #ifdef __cplusplus | |
37 | extern "C" { | |
38 | #endif | |
39 | ||
78c8ab4f PP |
40 | /** |
41 | @defgroup ctfirfieldtypes CTF IR field types | |
42 | @ingroup ctfir | |
43 | @brief CTF IR field types. | |
44 | ||
45 | @code | |
46 | #include <babeltrace/ctf-ir/field-types.h> | |
47 | @endcode | |
48 | ||
49 | A CTF IR <strong><em>field type</em></strong> is a field type that you | |
4089d5a6 | 50 | can use to create concrete @fields. |
78c8ab4f | 51 | |
4089d5a6 | 52 | You can create a @field object from a CTF IR field type object |
78c8ab4f PP |
53 | with bt_ctf_field_create(). |
54 | ||
55 | In the CTF IR hierarchy, you can set the root field types of three | |
56 | objects: | |
57 | ||
58 | - \ref ctfirtraceclass | |
59 | - Trace packet header field type: bt_ctf_trace_set_packet_header_type(). | |
60 | - \ref ctfirstreamclass | |
61 | - Stream packet context field type: | |
62 | bt_ctf_stream_class_set_packet_context_type(). | |
63 | - Stream event header field type: | |
64 | bt_ctf_stream_class_set_event_header_type(). | |
65 | - Stream event context field type: | |
66 | bt_ctf_stream_class_set_event_context_type(). | |
67 | - \ref ctfireventclass | |
68 | - Event context field type: bt_ctf_event_class_set_context_type(). | |
69 | - Event payload field type: bt_ctf_event_class_set_payload_type(). | |
70 | ||
71 | As of Babeltrace \btversion, those six previous "root" field types | |
4089d5a6 | 72 | \em must be @structft objects. |
78c8ab4f | 73 | |
4089d5a6 PP |
74 | If, at any level within a given root field type, you add a @seqft or a |
75 | @varft, you do not need to specify its associated length | |
78c8ab4f | 76 | or tag field type: the length or tag string is enough for the Babeltrace |
4089d5a6 | 77 | system to resolve the needed field type depending on where this |
78c8ab4f PP |
78 | dynamic field type is located within the whole hierarchy. It is |
79 | guaranteed that this automatic resolving is performed for all the field | |
80 | types contained in a given | |
81 | \link ctfirstreamclass CTF IR stream class\endlink (and in its | |
82 | children \link ctfireventclass CTF IR event classes\endlink) once you | |
83 | add it to a \link ctfirtraceclass CTF IR trace class\endlink with | |
84 | bt_ctf_trace_add_stream_class(). Once a stream class is the child of | |
85 | a trace class, this automatic resolving is performed for the field | |
86 | types of an event class when you add it with | |
87 | bt_ctf_stream_class_add_event_class(). If the system cannot find a path | |
88 | to a field in the hierarchy for a dynamic field type, the adding | |
89 | function fails. | |
90 | ||
91 | The standard CTF field types are: | |
92 | ||
93 | <table> | |
94 | <tr> | |
95 | <th>Type ID | |
96 | <th>CTF IR field type | |
97 | <th>CTF IR field which you can create from this field type | |
98 | </tr> | |
99 | <tr> | |
100 | <td>#BT_CTF_TYPE_ID_INTEGER | |
101 | <td>\ref ctfirintfieldtype | |
102 | <td>\ref ctfirintfield | |
103 | </tr> | |
104 | <tr> | |
105 | <td>#BT_CTF_TYPE_ID_FLOAT | |
106 | <td>\ref ctfirfloatfieldtype | |
107 | <td>\ref ctfirfloatfield | |
108 | </tr> | |
109 | <tr> | |
110 | <td>#BT_CTF_TYPE_ID_ENUM | |
111 | <td>\ref ctfirenumfieldtype | |
112 | <td>\ref ctfirenumfield | |
113 | </tr> | |
114 | <tr> | |
115 | <td>#BT_CTF_TYPE_ID_STRING | |
116 | <td>\ref ctfirstringfieldtype | |
117 | <td>\ref ctfirstringfield | |
118 | </tr> | |
119 | <tr> | |
120 | <td>#BT_CTF_TYPE_ID_STRUCT | |
121 | <td>\ref ctfirstructfieldtype | |
122 | <td>\ref ctfirstructfield | |
123 | </tr> | |
124 | <tr> | |
125 | <td>#BT_CTF_TYPE_ID_ARRAY | |
126 | <td>\ref ctfirarrayfieldtype | |
127 | <td>\ref ctfirarrayfield | |
128 | </tr> | |
129 | <tr> | |
130 | <td>#BT_CTF_TYPE_ID_SEQUENCE | |
131 | <td>\ref ctfirseqfieldtype | |
132 | <td>\ref ctfirseqfield | |
133 | </tr> | |
134 | <tr> | |
135 | <td>#BT_CTF_TYPE_ID_VARIANT | |
136 | <td>\ref ctfirvarfieldtype | |
137 | <td>\ref ctfirvarfield | |
138 | </tr> | |
139 | </table> | |
140 | ||
141 | Each field type has its own <strong>type ID</strong> (see | |
142 | #bt_ctf_type_id). You get the type ID of a field type object | |
143 | with bt_ctf_field_type_get_type_id(). | |
144 | ||
145 | You can get a deep copy of a field type with bt_ctf_field_type_copy(). | |
146 | This function resets, in the field type copy, the resolved field type | |
147 | of the dynamic field types. The automatic resolving can be done again | |
148 | when you eventually call bt_ctf_event_create(), | |
149 | bt_ctf_stream_class_add_event_class(), or | |
150 | bt_ctf_trace_add_stream_class(). | |
151 | ||
152 | You \em must always use bt_ctf_field_type_compare() to compare two | |
153 | field types. Since some parts of the Babeltrace system can copy field | |
154 | types behind the scenes, you \em cannot rely on a simple field type | |
155 | pointer comparison. | |
156 | ||
157 | As with any Babeltrace object, CTF IR field type objects have | |
158 | <a href="https://en.wikipedia.org/wiki/Reference_counting">reference | |
159 | counts</a>. See \ref refs to learn more about the reference counting | |
160 | management of Babeltrace objects. | |
161 | ||
162 | The following functions can \em freeze field type objects: | |
163 | ||
164 | - bt_ctf_field_create() freezes its field type parameter. | |
165 | - bt_ctf_stream_class_add_event_class(), if its | |
166 | \link ctfirstreamclass CTF IR stream class\endlink parameter has a | |
167 | \link ctfirtraceclass CTF IR trace class\endlink parent, freezes | |
168 | the root field types of its | |
169 | \link ctfireventclass CTF IR event class\endlink parameter. | |
170 | - bt_ctf_trace_add_stream_class() freezes the root field types of the | |
171 | whole trace class hierarchy (trace class, children stream classes, | |
172 | and their children event classes). | |
173 | - bt_ctf_writer_create_stream() freezes the root field types of the | |
174 | whole CTF writer's trace class hierarchy. | |
175 | - bt_ctf_event_create() freezes the root field types of its event class | |
176 | parameter and of ther parent stream class of this event class. | |
177 | ||
18fcd1c9 PP |
178 | You cannot modify a frozen field type object: it is considered |
179 | immutable, except for \link refs reference counting\endlink. | |
180 | ||
78c8ab4f | 181 | @sa ctfirfields |
bb8c17e0 | 182 | @sa \ref ctfirfieldtypesexamples "Examples" |
78c8ab4f PP |
183 | |
184 | @file | |
10a876cd | 185 | @brief CTF IR field types type and functions. |
78c8ab4f PP |
186 | @sa ctfirfieldtypes |
187 | ||
188 | @addtogroup ctfirfieldtypes | |
189 | @{ | |
190 | */ | |
191 | ||
192 | /** | |
193 | @struct bt_ctf_field_type | |
194 | @brief A CTF IR field type. | |
195 | @sa ctfirfieldtypes | |
196 | */ | |
197 | struct bt_ctf_field_type; | |
adc315b8 JG |
198 | struct bt_ctf_event_class; |
199 | struct bt_ctf_event; | |
b92ddaaa | 200 | struct bt_ctf_field; |
b011f6b0 | 201 | struct bt_ctf_field_path; |
23320c3b | 202 | struct bt_ctf_field_type_enumeration_mapping_iterator; |
adc315b8 | 203 | |
78c8ab4f PP |
204 | /** @cond DOCUMENT */ |
205 | ||
9a19a512 PP |
206 | /* |
207 | * Babeltrace 1.x enumerations that were also used in CTF writer's API. | |
208 | * They are left here for backward compatibility reasons, but | |
209 | * enum bt_ctf_type_id and enum bt_ctf_string_encoding should be used | |
210 | * in new code. Both new enumerations are compatible with their legacy | |
211 | * counterpart. | |
212 | */ | |
213 | enum ctf_type_id { | |
214 | CTF_TYPE_UNKNOWN = 0, | |
215 | CTF_TYPE_INTEGER, | |
216 | CTF_TYPE_FLOAT, | |
217 | CTF_TYPE_ENUM, | |
218 | CTF_TYPE_STRING, | |
219 | CTF_TYPE_STRUCT, | |
220 | CTF_TYPE_UNTAGGED_VARIANT, | |
221 | CTF_TYPE_VARIANT, | |
222 | CTF_TYPE_ARRAY, | |
223 | CTF_TYPE_SEQUENCE, | |
224 | NR_CTF_TYPES, | |
225 | }; | |
226 | ||
227 | /* | |
228 | * Old enum. | |
229 | */ | |
230 | enum ctf_string_encoding { | |
231 | CTF_STRING_NONE = 0, | |
232 | CTF_STRING_UTF8, | |
233 | CTF_STRING_ASCII, | |
234 | CTF_STRING_UNKNOWN, | |
235 | }; | |
236 | ||
78c8ab4f PP |
237 | /** @endcond */ |
238 | ||
239 | /** | |
240 | @brief CTF scope. | |
241 | */ | |
242 | enum bt_ctf_scope { | |
243 | /// Unknown, used for errors. | |
244 | BT_CTF_SCOPE_UNKNOWN = -1, | |
245 | ||
246 | /// Trace packet header. | |
247 | BT_CTF_SCOPE_TRACE_PACKET_HEADER = 1, | |
248 | ||
249 | /// Stream packet context. | |
250 | BT_CTF_SCOPE_STREAM_PACKET_CONTEXT = 2, | |
251 | ||
252 | /// Stream event header. | |
253 | BT_CTF_SCOPE_STREAM_EVENT_HEADER = 3, | |
254 | ||
255 | /// Stream event context. | |
256 | BT_CTF_SCOPE_STREAM_EVENT_CONTEXT = 4, | |
257 | ||
258 | /// Event context. | |
259 | BT_CTF_SCOPE_EVENT_CONTEXT = 5, | |
260 | ||
261 | /// Event payload. | |
262 | BT_CTF_SCOPE_EVENT_PAYLOAD = 6, | |
263 | ||
264 | /// @cond DOCUMENT | |
265 | BT_CTF_SCOPE_ENV = 0, | |
266 | BT_CTF_SCOPE_EVENT_FIELDS = 6, | |
267 | /// @endcond | |
268 | }; | |
269 | ||
270 | /** | |
271 | @name Type information | |
272 | @{ | |
273 | */ | |
274 | ||
275 | /** | |
4089d5a6 | 276 | @brief Type ID of a @ft. |
78c8ab4f | 277 | */ |
9a19a512 | 278 | enum bt_ctf_type_id { |
78c8ab4f | 279 | /// Unknown, used for errors. |
9a19a512 | 280 | BT_CTF_TYPE_ID_UNKNOWN = CTF_TYPE_UNKNOWN, |
78c8ab4f PP |
281 | |
282 | /// \ref ctfirintfieldtype | |
9a19a512 | 283 | BT_CTF_TYPE_ID_INTEGER = CTF_TYPE_INTEGER, |
78c8ab4f PP |
284 | |
285 | /// \ref ctfirfloatfieldtype | |
9a19a512 | 286 | BT_CTF_TYPE_ID_FLOAT = CTF_TYPE_FLOAT, |
78c8ab4f PP |
287 | |
288 | /// \ref ctfirenumfieldtype | |
9a19a512 | 289 | BT_CTF_TYPE_ID_ENUM = CTF_TYPE_ENUM, |
78c8ab4f PP |
290 | |
291 | /// \ref ctfirstringfieldtype | |
9a19a512 | 292 | BT_CTF_TYPE_ID_STRING = CTF_TYPE_STRING, |
78c8ab4f PP |
293 | |
294 | /// \ref ctfirstructfieldtype | |
9a19a512 | 295 | BT_CTF_TYPE_ID_STRUCT = CTF_TYPE_STRUCT, |
78c8ab4f PP |
296 | |
297 | /// @cond DOCUMENT | |
9a19a512 | 298 | BT_CTF_TYPE_ID_UNTAGGED_VARIANT = CTF_TYPE_UNTAGGED_VARIANT, |
78c8ab4f PP |
299 | /// @endcond |
300 | ||
301 | /// \ref ctfirarrayfieldtype | |
9a19a512 | 302 | BT_CTF_TYPE_ID_ARRAY = CTF_TYPE_ARRAY, |
78c8ab4f PP |
303 | |
304 | /// \ref ctfirseqfieldtype | |
9a19a512 | 305 | BT_CTF_TYPE_ID_SEQUENCE = CTF_TYPE_SEQUENCE, |
9a19a512 | 306 | |
78c8ab4f PP |
307 | /// \ref ctfirvarfieldtype |
308 | BT_CTF_TYPE_ID_VARIANT = CTF_TYPE_VARIANT, | |
309 | ||
310 | /// Number of enumeration entries. | |
311 | BT_CTF_NR_TYPE_IDS = NR_CTF_TYPES, | |
adc315b8 JG |
312 | }; |
313 | ||
78c8ab4f | 314 | /** |
4089d5a6 | 315 | @brief Returns the type ID of the @ft \p field_type. |
78c8ab4f PP |
316 | |
317 | @param[in] field_type Field type of which to get the type ID. | |
318 | @returns Type ID of \p field_type, | |
319 | or #BT_CTF_TYPE_ID_UNKNOWN on error. | |
320 | ||
321 | @prenotnull{field_type} | |
322 | @postrefcountsame{field_type} | |
323 | ||
324 | @sa #bt_ctf_type_id: CTF IR field type ID. | |
325 | @sa bt_ctf_field_type_is_integer(): Returns whether or not a given | |
4089d5a6 | 326 | field type is a @intft. |
78c8ab4f | 327 | @sa bt_ctf_field_type_is_floating_point(): Returns whether or not a |
4089d5a6 | 328 | given field type is a @floatft. |
78c8ab4f | 329 | @sa bt_ctf_field_type_is_enumeration(): Returns whether or not a given |
4089d5a6 | 330 | field type is a @enumft. |
78c8ab4f | 331 | @sa bt_ctf_field_type_is_string(): Returns whether or not a given |
4089d5a6 | 332 | field type is a @stringft. |
78c8ab4f | 333 | @sa bt_ctf_field_type_is_structure(): Returns whether or not a given |
4089d5a6 | 334 | field type is a @structft. |
78c8ab4f | 335 | @sa bt_ctf_field_type_is_array(): Returns whether or not a given |
4089d5a6 | 336 | field type is a @arrayft. |
78c8ab4f | 337 | @sa bt_ctf_field_type_is_sequence(): Returns whether or not a given |
4089d5a6 | 338 | field type is a @seqft. |
78c8ab4f | 339 | @sa bt_ctf_field_type_is_variant(): Returns whether or not a given |
4089d5a6 | 340 | field type is a @varft. |
78c8ab4f PP |
341 | */ |
342 | extern enum bt_ctf_type_id bt_ctf_field_type_get_type_id( | |
343 | struct bt_ctf_field_type *field_type); | |
344 | ||
345 | /** | |
4089d5a6 | 346 | @brief Returns whether or not the @ft \p field_type is a @intft. |
78c8ab4f PP |
347 | |
348 | @param[in] field_type Field type to check (can be \c NULL). | |
349 | @returns 1 if \p field_type is an integer field type, | |
350 | or 0 otherwise (including if \p field_type is | |
351 | \c NULL). | |
352 | ||
353 | @prenotnull{field_type} | |
354 | @postrefcountsame{field_type} | |
355 | ||
356 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
357 | field type. | |
358 | */ | |
359 | extern int bt_ctf_field_type_is_integer(struct bt_ctf_field_type *field_type); | |
360 | ||
361 | /** | |
4089d5a6 | 362 | @brief Returns whether or not the @ft \p field_type is a @floatft. |
78c8ab4f PP |
363 | |
364 | @param[in] field_type Field type to check (can be \c NULL). | |
365 | @returns 1 if \p field_type is a floating point | |
366 | number field type, | |
367 | or 0 otherwise (including if \p field_type is | |
368 | \c NULL). | |
369 | ||
370 | @postrefcountsame{field_type} | |
371 | ||
372 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
373 | field type. | |
374 | */ | |
375 | extern int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type *field_type); | |
376 | ||
377 | /** | |
4089d5a6 | 378 | @brief Returns whether or not the @ft \p field_type is a @enumft. |
78c8ab4f PP |
379 | |
380 | @param[in] field_type Field type to check (can be \c NULL). | |
381 | @returns 1 if \p field_type is an enumeration field type, | |
382 | or 0 otherwise (including if \p field_type is | |
383 | \c NULL). | |
384 | ||
385 | @postrefcountsame{field_type} | |
386 | ||
387 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
388 | field type. | |
389 | */ | |
390 | extern int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type *field_type); | |
391 | ||
392 | /** | |
4089d5a6 | 393 | @brief Returns whether or not the @ft \p field_type is a @stringft. |
78c8ab4f PP |
394 | |
395 | @param[in] field_type Field type to check (can be \c NULL). | |
396 | @returns 1 if \p field_type is a string field type, | |
397 | or 0 otherwise (including if \p field_type is | |
398 | \c NULL). | |
399 | ||
400 | @postrefcountsame{field_type} | |
401 | ||
402 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
403 | field type. | |
404 | */ | |
405 | extern int bt_ctf_field_type_is_string(struct bt_ctf_field_type *field_type); | |
406 | ||
407 | /** | |
4089d5a6 | 408 | @brief Returns whether or not the @ft \p field_type is a @structft. |
78c8ab4f PP |
409 | |
410 | @param[in] field_type Field type to check (can be \c NULL). | |
411 | @returns 1 if \p field_type is a structure field type, | |
412 | or 0 otherwise (including if \p field_type is | |
413 | \c NULL). | |
414 | ||
415 | @postrefcountsame{field_type} | |
416 | ||
417 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
418 | field type. | |
419 | */ | |
420 | extern int bt_ctf_field_type_is_structure(struct bt_ctf_field_type *field_type); | |
421 | ||
422 | /** | |
4089d5a6 | 423 | @brief Returns whether or not the @ft \p field_type is a @arrayft. |
78c8ab4f PP |
424 | |
425 | @param[in] field_type Field type to check (can be \c NULL). | |
426 | @returns 1 if \p field_type is an array field type, | |
427 | or 0 otherwise (including if \p field_type is | |
428 | \c NULL). | |
429 | ||
430 | @postrefcountsame{field_type} | |
431 | ||
432 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
433 | field type. | |
434 | */ | |
435 | extern int bt_ctf_field_type_is_array(struct bt_ctf_field_type *field_type); | |
436 | ||
437 | /** | |
4089d5a6 | 438 | @brief Returns whether or not the @ft \p field_type is a @seqft. |
78c8ab4f PP |
439 | |
440 | @param[in] field_type Field type to check (can be \c NULL). | |
441 | @returns 1 if \p field_type is a sequence field type, | |
442 | or 0 otherwise (including if \p field_type is | |
443 | \c NULL). | |
444 | ||
445 | @postrefcountsame{field_type} | |
446 | ||
447 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
448 | field type. | |
449 | */ | |
450 | extern int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type *field_type); | |
451 | ||
452 | /** | |
4089d5a6 | 453 | @brief Returns whether or not the @ft \p field_type is a @varft. |
78c8ab4f PP |
454 | |
455 | @param[in] field_type Field type to check (can be \c NULL). | |
456 | @returns 1 if \p field_type is a variant field type, | |
457 | or 0 otherwise (including if \p field_type is | |
458 | \c NULL). | |
459 | ||
460 | @postrefcountsame{field_type} | |
461 | ||
462 | @sa bt_ctf_field_type_get_type_id(): Returns the type ID of a given | |
463 | field type. | |
464 | */ | |
465 | extern int bt_ctf_field_type_is_variant(struct bt_ctf_field_type *field_type); | |
466 | ||
467 | /** @} */ | |
468 | ||
469 | /** | |
470 | @name Common properties types and functions | |
471 | @{ | |
472 | */ | |
473 | ||
474 | /** | |
475 | @brief <a href="https://en.wikipedia.org/wiki/Endianness">Byte order</a> | |
4089d5a6 | 476 | of a @ft. |
78c8ab4f | 477 | */ |
adc315b8 | 478 | enum bt_ctf_byte_order { |
78c8ab4f | 479 | /// Unknown, used for errors. |
b92ddaaa | 480 | BT_CTF_BYTE_ORDER_UNKNOWN = -1, |
78c8ab4f | 481 | |
c35a1669 | 482 | /* |
46df6b28 PP |
483 | * Note that native, in the context of the CTF specification, is defined |
484 | * as "the byte order described in the trace" and does not mean that the | |
485 | * host's endianness will be used. | |
c35a1669 | 486 | */ |
78c8ab4f | 487 | /// Native (default) byte order. |
adc315b8 | 488 | BT_CTF_BYTE_ORDER_NATIVE = 0, |
78c8ab4f PP |
489 | |
490 | /// Little-endian. | |
adc315b8 | 491 | BT_CTF_BYTE_ORDER_LITTLE_ENDIAN, |
78c8ab4f PP |
492 | |
493 | /// Big-endian. | |
adc315b8 | 494 | BT_CTF_BYTE_ORDER_BIG_ENDIAN, |
78c8ab4f PP |
495 | |
496 | /// Network byte order (big-endian). | |
adc315b8 JG |
497 | BT_CTF_BYTE_ORDER_NETWORK, |
498 | }; | |
499 | ||
78c8ab4f | 500 | /** |
4089d5a6 | 501 | @brief String encoding of a @ft. |
78c8ab4f | 502 | */ |
87b41f95 | 503 | enum bt_ctf_string_encoding { |
78c8ab4f PP |
504 | /// Unknown, used for errors. |
505 | BT_CTF_STRING_ENCODING_UNKNOWN = CTF_STRING_UNKNOWN, | |
506 | ||
507 | /// No encoding. | |
87b41f95 | 508 | BT_CTF_STRING_ENCODING_NONE = CTF_STRING_NONE, |
78c8ab4f PP |
509 | |
510 | /// <a href="https://en.wikipedia.org/wiki/UTF-8">UTF-8</a>. | |
87b41f95 | 511 | BT_CTF_STRING_ENCODING_UTF8 = CTF_STRING_UTF8, |
78c8ab4f PP |
512 | |
513 | /// <a href="https://en.wikipedia.org/wiki/ASCII">ASCII</a>. | |
87b41f95 | 514 | BT_CTF_STRING_ENCODING_ASCII = CTF_STRING_ASCII, |
87b41f95 PP |
515 | }; |
516 | ||
78c8ab4f | 517 | /** |
4089d5a6 PP |
518 | @brief Returns the alignment of the @fields described by |
519 | the @ft \p field_type. | |
78c8ab4f PP |
520 | |
521 | @param[in] field_type Field type which describes the | |
522 | fields of which to get the alignment. | |
523 | @returns Alignment of the fields described by | |
524 | \p field_type, or a negative value on error. | |
525 | ||
526 | @prenotnull{field_type} | |
527 | @postrefcountsame{field_type} | |
528 | ||
529 | @sa bt_ctf_field_type_set_alignment(): Sets the alignment | |
530 | of the fields described by a given field type. | |
531 | */ | |
532 | extern int bt_ctf_field_type_get_alignment( | |
533 | struct bt_ctf_field_type *field_type); | |
534 | ||
535 | /** | |
4089d5a6 PP |
536 | @brief Sets the alignment of the @fields described by the |
537 | @ft \p field_type to \p alignment. | |
78c8ab4f PP |
538 | |
539 | \p alignment \em must be greater than 0 and a power of two. | |
540 | ||
541 | @param[in] field_type Field type which describes the fields of | |
542 | which to set the alignment. | |
543 | @param[in] alignment Alignment of the fields described by | |
544 | \p field_type. | |
545 | @returns 0 on success, or a negative value on error. | |
546 | ||
547 | @prenotnull{field_type} | |
548 | @prehot{field_type} | |
549 | @pre \p alignment is greater than 0 and a power of two. | |
550 | @postrefcountsame{field_type} | |
551 | ||
552 | @sa bt_ctf_field_type_get_alignment(): Returns the alignment of the | |
553 | fields described by a given field type. | |
554 | */ | |
555 | extern int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *field_type, | |
556 | unsigned int alignment); | |
557 | ||
558 | /** | |
4089d5a6 PP |
559 | @brief Returns the byte order of the @fields described by |
560 | the @ft \p field_type. | |
78c8ab4f | 561 | |
4089d5a6 PP |
562 | You can only call this function if \p field_type is a @intft, a |
563 | @floatft, or a @enumft. | |
78c8ab4f PP |
564 | |
565 | @param[in] field_type Field type which describes the | |
566 | fields of which to get the byte order. | |
567 | @returns Byte order of the fields described by | |
568 | \p field_type, or #BT_CTF_BYTE_ORDER_UNKNOWN on | |
569 | error. | |
570 | ||
571 | @prenotnull{field_type} | |
4089d5a6 | 572 | @pre \p field_type is a @intft, a @floatft, or a @enumft. |
78c8ab4f PP |
573 | @postrefcountsame{field_type} |
574 | ||
575 | @sa bt_ctf_field_type_set_byte_order(): Sets the byte order | |
576 | of the fields described by a given field type. | |
577 | */ | |
578 | extern enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order( | |
579 | struct bt_ctf_field_type *field_type); | |
580 | ||
581 | /** | |
4089d5a6 PP |
582 | @brief Sets the byte order of the @fields described by the |
583 | @ft \p field_type to \p byte_order. | |
78c8ab4f PP |
584 | |
585 | If \p field_type is a compound field type, this function also | |
586 | recursively sets the byte order of its children to \p byte_order. | |
587 | ||
588 | @param[in] field_type Field type which describes the fields of | |
589 | which to set the byte order. | |
590 | @param[in] byte_order Alignment of the fields described by | |
591 | \p field_type. | |
592 | @returns 0 on success, or a negative value on error. | |
593 | ||
594 | @prenotnull{field_type} | |
595 | @prehot{field_type} | |
596 | @pre \p byte_order is #BT_CTF_BYTE_ORDER_NATIVE, | |
597 | #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN, #BT_CTF_BYTE_ORDER_BIG_ENDIAN, | |
598 | or #BT_CTF_BYTE_ORDER_NETWORK. | |
4089d5a6 | 599 | @postrefcountsame{field_type} |
78c8ab4f PP |
600 | |
601 | @sa bt_ctf_field_type_get_byte_order(): Returns the byte order of the | |
602 | fields described by a given field type. | |
603 | */ | |
604 | extern int bt_ctf_field_type_set_byte_order( | |
605 | struct bt_ctf_field_type *field_type, | |
606 | enum bt_ctf_byte_order byte_order); | |
607 | ||
608 | /** @} */ | |
609 | ||
610 | /** | |
611 | @name Utility functions | |
612 | @{ | |
613 | */ | |
614 | ||
615 | /** | |
4089d5a6 | 616 | @brief Returns whether or not the @ft \p field_type_a |
78c8ab4f PP |
617 | is equivalent to the field type \p field_type_b. |
618 | ||
619 | You \em must use this function to compare two field types: it is not | |
620 | safe to compare two pointer values directly, because, for internal | |
621 | reasons, some parts of the Babeltrace system can copy user field types | |
622 | and discard the original ones. | |
623 | ||
624 | @param[in] field_type_a Field type to compare to \p field_type_b. | |
625 | @param[in] field_type_b Field type to compare to \p field_type_a. | |
626 | @returns 0 if \p field_type_a is equivalent to | |
627 | \p field_type_b, 1 if they are not equivalent, | |
628 | or a negative value on error. | |
629 | ||
630 | @prenotnull{field_type_a} | |
631 | @prenotnull{field_type_b} | |
632 | @postrefcountsame{field_type_a} | |
633 | @postrefcountsame{field_type_b} | |
634 | */ | |
635 | extern int bt_ctf_field_type_compare(struct bt_ctf_field_type *field_type_a, | |
636 | struct bt_ctf_field_type *field_type_b); | |
637 | ||
638 | /** | |
4089d5a6 | 639 | @brief Creates a \em deep copy of the @ft \p field_type. |
78c8ab4f PP |
640 | |
641 | You can copy a frozen field type: the resulting copy is | |
642 | <em>not frozen</em>. | |
643 | ||
4089d5a6 | 644 | This function resets the tag field type of a copied @varft. The |
78c8ab4f PP |
645 | automatic field resolving which some functions of the API perform |
646 | can set it again when the returned field type is used (learn more | |
647 | in the detailed description of this module). | |
648 | ||
649 | @param[in] field_type Field type to copy. | |
650 | @returns Deep copy of \p field_type on success, | |
651 | or \c NULL on error. | |
652 | ||
653 | @prenotnull{field_type} | |
654 | @postrefcountsame{field_type} | |
655 | @postsuccessrefcountret1 | |
63168860 | 656 | @post <strong>On success</strong>, the returned field type is not frozen. |
78c8ab4f PP |
657 | */ |
658 | extern struct bt_ctf_field_type *bt_ctf_field_type_copy( | |
659 | struct bt_ctf_field_type *field_type); | |
660 | ||
661 | /** @} */ | |
662 | ||
663 | /** @} */ | |
664 | ||
665 | /** | |
666 | @defgroup ctfirintfieldtype CTF IR integer field type | |
667 | @ingroup ctfirfieldtypes | |
668 | @brief CTF IR integer field type. | |
669 | ||
670 | @code | |
671 | #include <babeltrace/ctf-ir/field-types.h> | |
672 | @endcode | |
673 | ||
674 | A CTF IR <strong><em>integer field type</em></strong> is a field type that | |
4089d5a6 | 675 | you can use to create concrete @intfield objects. |
78c8ab4f PP |
676 | |
677 | You can create an integer field type | |
678 | with bt_ctf_field_type_integer_create(). | |
679 | ||
680 | An integer field type has the following properties: | |
681 | ||
682 | <table> | |
683 | <tr> | |
684 | <th>Property | |
685 | <th>Value at creation | |
686 | <th>Getter | |
687 | <th>Setter | |
688 | </tr> | |
689 | <tr> | |
690 | <td>\b Alignment (bits) of the described integer fields | |
691 | <td>1 | |
692 | <td>bt_ctf_field_type_get_alignment() | |
693 | <td>bt_ctf_field_type_set_alignment() | |
694 | </tr> | |
695 | <tr> | |
696 | <td><strong>Byte order</strong> of the described integer fields | |
697 | <td>#BT_CTF_BYTE_ORDER_NATIVE | |
698 | <td>bt_ctf_field_type_get_byte_order() | |
699 | <td>bt_ctf_field_type_set_byte_order() | |
700 | </tr> | |
701 | <tr> | |
702 | <td><strong>Storage size</strong> (bits) of the described | |
703 | integer fields | |
704 | <td>Specified at creation | |
705 | <td>bt_ctf_field_type_integer_get_size() | |
c3c35de4 | 706 | <td>bt_ctf_field_type_integer_set_size() |
78c8ab4f PP |
707 | </tr> |
708 | <tr> | |
709 | <td><strong>Signedness</strong> of the described integer fields | |
710 | <td>Unsigned | |
711 | <td>bt_ctf_field_type_integer_get_signed() | |
712 | <td>bt_ctf_field_type_integer_set_signed() | |
713 | </tr> | |
714 | <tr> | |
715 | <td><strong>Preferred display base</strong> of the described | |
716 | integer fields | |
717 | <td>#BT_CTF_INTEGER_BASE_DECIMAL | |
718 | <td>bt_ctf_field_type_integer_get_base() | |
719 | <td>bt_ctf_field_type_integer_set_base() | |
720 | </tr> | |
721 | <tr> | |
722 | <td>\b Encoding of the described integer fields | |
723 | <td>#BT_CTF_STRING_ENCODING_NONE | |
724 | <td>bt_ctf_field_type_integer_get_encoding() | |
725 | <td>bt_ctf_field_type_integer_set_encoding() | |
726 | </tr> | |
727 | <tr> | |
728 | <td><strong>Mapped | |
729 | \link ctfirclockclass CTF IR clock class\endlink</strong> | |
730 | <td>None | |
ac0c6bdd PP |
731 | <td>bt_ctf_field_type_integer_get_mapped_clock_class() |
732 | <td>bt_ctf_field_type_integer_set_mapped_clock_class() | |
78c8ab4f PP |
733 | </tr> |
734 | </table> | |
735 | ||
736 | @sa ctfirintfield | |
737 | @sa ctfirfieldtypes | |
bb8c17e0 | 738 | @sa \ref ctfirfieldtypesexamples_intfieldtype "Examples" |
78c8ab4f PP |
739 | |
740 | @addtogroup ctfirintfieldtype | |
741 | @{ | |
742 | */ | |
743 | ||
744 | /** | |
4089d5a6 | 745 | @brief Preferred display base (radix) of a @intft. |
78c8ab4f PP |
746 | */ |
747 | enum bt_ctf_integer_base { | |
748 | /// Unknown, used for errors. | |
749 | BT_CTF_INTEGER_BASE_UNKNOWN = -1, | |
750 | ||
751 | /// Binary. | |
752 | BT_CTF_INTEGER_BASE_BINARY = 2, | |
753 | ||
754 | /// Octal. | |
755 | BT_CTF_INTEGER_BASE_OCTAL = 8, | |
756 | ||
757 | /// Decimal. | |
758 | BT_CTF_INTEGER_BASE_DECIMAL = 10, | |
759 | ||
760 | /// Hexadecimal. | |
761 | BT_CTF_INTEGER_BASE_HEXADECIMAL = 16, | |
b011f6b0 PP |
762 | }; |
763 | ||
78c8ab4f | 764 | /** |
4089d5a6 PP |
765 | @brief Creates a default @intft with \p size bits as the storage size |
766 | of the @intfields it describes. | |
78c8ab4f | 767 | |
c3c35de4 JD |
768 | You can change the storage size of the integer fields described by |
769 | the created integer field type later with | |
770 | bt_ctf_field_type_integer_set_size(). | |
771 | ||
78c8ab4f PP |
772 | @param[in] size Storage size (bits) of the described integer fields. |
773 | @returns Created integer field type, or \c NULL on error. | |
774 | ||
775 | @pre \p size is greater than 0 and lesser than or equal to 64. | |
776 | @postsuccessrefcountret1 | |
777 | */ | |
adc315b8 JG |
778 | extern struct bt_ctf_field_type *bt_ctf_field_type_integer_create( |
779 | unsigned int size); | |
780 | ||
78c8ab4f | 781 | /** |
4089d5a6 PP |
782 | @brief Returns the storage size, in bits, of the @intfields |
783 | described by the @intft \p int_field_type. | |
78c8ab4f PP |
784 | |
785 | @param[in] int_field_type Integer field type which describes the | |
786 | integer fields of which to get the | |
787 | storage size. | |
788 | @returns Storage size (bits) of the integer | |
789 | fields described by \p int_field_type, | |
790 | or a negative value on error. | |
791 | ||
792 | @prenotnull{int_field_type} | |
793 | @preisintft{int_field_type} | |
794 | @postrefcountsame{int_field_type} | |
c3c35de4 JD |
795 | |
796 | @sa bt_ctf_field_type_integer_set_size(): Sets the storage size of the | |
797 | integer fields described by a given integer field type. | |
78c8ab4f | 798 | */ |
b92ddaaa | 799 | extern int bt_ctf_field_type_integer_get_size( |
78c8ab4f | 800 | struct bt_ctf_field_type *int_field_type); |
b92ddaaa | 801 | |
c3c35de4 JD |
802 | /** |
803 | @brief Sets the storage size, in bits, of the @intfields described by | |
804 | the @intft \p int_field_type. | |
805 | ||
806 | @param[in] int_field_type Integer field type which describes the | |
807 | integer fields of which to set the | |
808 | storage size. | |
809 | @param[in] size Storage size (bits) of the integer fields | |
810 | described by \p int_field_type. | |
811 | @returns 0 on success, or a negative value on error. | |
812 | ||
813 | @prenotnull{int_field_type} | |
814 | @preisintft{int_field_type} | |
815 | @prehot{int_field_type} | |
816 | @pre \p size is greater than 0 and lesser than or equal to 64. | |
817 | @postrefcountsame{int_field_type} | |
818 | ||
819 | @sa bt_ctf_field_type_integer_get_size(): Returns the storage size of | |
820 | the integer fields described by a given integer field type. | |
821 | */ | |
822 | extern int bt_ctf_field_type_integer_set_size( | |
823 | struct bt_ctf_field_type *int_field_type, size_t size); | |
824 | ||
78c8ab4f | 825 | /** |
4089d5a6 PP |
826 | @brief Returns whether or not the @intfields described by the @intft |
827 | \p int_field_type are signed. | |
78c8ab4f PP |
828 | |
829 | @param[in] int_field_type Integer field type which describes the | |
830 | integer fields of which to get the | |
831 | signedness. | |
832 | @returns 1 if the integer fields described by | |
833 | \p int_field_type are signed, 0 if they | |
834 | are unsigned, or a negative value on | |
835 | error. | |
836 | ||
837 | @prenotnull{int_field_type} | |
838 | @preisintft{int_field_type} | |
839 | @postrefcountsame{int_field_type} | |
840 | ||
841 | @sa bt_ctf_field_type_integer_set_signed(): Sets the signedness of the | |
842 | integer fields described by a given integer field type. | |
843 | */ | |
b92ddaaa | 844 | extern int bt_ctf_field_type_integer_get_signed( |
78c8ab4f | 845 | struct bt_ctf_field_type *int_field_type); |
b92ddaaa | 846 | |
78c8ab4f | 847 | /** |
4089d5a6 PP |
848 | @brief Sets whether or not the @intfields described by |
849 | the @intft \p int_field_type are signed. | |
78c8ab4f PP |
850 | |
851 | @param[in] int_field_type Integer field type which describes the | |
852 | integer fields of which to set the | |
853 | signedness. | |
854 | @param[in] is_signed Signedness of the integer fields | |
855 | described by \p int_field_type; 0 means | |
856 | \em unsigned, 1 means \em signed. | |
857 | @returns 0 on success, or a negative value on error. | |
858 | ||
859 | @prenotnull{int_field_type} | |
860 | @preisintft{int_field_type} | |
861 | @prehot{int_field_type} | |
862 | @pre \p is_signed is 0 or 1. | |
c3c35de4 | 863 | @postrefcountsame{int_field_type} |
78c8ab4f PP |
864 | |
865 | @sa bt_ctf_field_type_integer_get_signed(): Returns the signedness of | |
866 | the integer fields described by a given integer field type. | |
867 | */ | |
adc315b8 | 868 | extern int bt_ctf_field_type_integer_set_signed( |
78c8ab4f | 869 | struct bt_ctf_field_type *int_field_type, int is_signed); |
adc315b8 | 870 | |
78c8ab4f | 871 | /** |
4089d5a6 PP |
872 | @brief Returns the preferred display base (radix) of the @intfields |
873 | described by the @intft \p int_field_type. | |
78c8ab4f PP |
874 | |
875 | @param[in] int_field_type Integer field type which describes the | |
876 | integer fields of which to get the | |
877 | preferred display base. | |
878 | @returns Preferred display base of the integer | |
879 | fields described by \p int_field_type, | |
880 | or #BT_CTF_INTEGER_BASE_UNKNOWN on | |
881 | error. | |
882 | ||
883 | @prenotnull{int_field_type} | |
884 | @preisintft{int_field_type} | |
885 | @postrefcountsame{int_field_type} | |
886 | ||
887 | @sa bt_ctf_field_type_integer_set_base(): Sets the preferred display | |
888 | base of the integer fields described by a given integer field | |
889 | type. | |
890 | */ | |
b92ddaaa | 891 | extern enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base( |
78c8ab4f | 892 | struct bt_ctf_field_type *int_field_type); |
b92ddaaa | 893 | |
78c8ab4f | 894 | /** |
4089d5a6 PP |
895 | @brief Sets the preferred display base (radix) of the @intfields |
896 | described by the @intft \p int_field_type to \p base. | |
78c8ab4f PP |
897 | |
898 | @param[in] int_field_type Integer field type which describes the | |
899 | integer fields of which to set the | |
900 | preferred display base. | |
901 | @param[in] base Preferred display base of the integer | |
902 | fields described by \p int_field_type. | |
903 | @returns 0 on success, or a negative value on error. | |
904 | ||
905 | @prenotnull{int_field_type} | |
906 | @preisintft{int_field_type} | |
907 | @prehot{int_field_type} | |
908 | @pre \p base is #BT_CTF_INTEGER_BASE_BINARY, #BT_CTF_INTEGER_BASE_OCTAL, | |
909 | #BT_CTF_INTEGER_BASE_DECIMAL, or | |
910 | #BT_CTF_INTEGER_BASE_HEXADECIMAL. | |
911 | @postrefcountsame{int_field_type} | |
912 | ||
913 | @sa bt_ctf_field_type_integer_get_base(): Returns the preferred display | |
914 | base of the integer fields described by a given | |
915 | integer field type. | |
916 | */ | |
917 | extern int bt_ctf_field_type_integer_set_base( | |
918 | struct bt_ctf_field_type *int_field_type, | |
adc315b8 JG |
919 | enum bt_ctf_integer_base base); |
920 | ||
78c8ab4f | 921 | /** |
4089d5a6 PP |
922 | @brief Returns the encoding of the @intfields described by |
923 | the @intft \p int_field_type. | |
78c8ab4f PP |
924 | |
925 | @param[in] int_field_type Integer field type which describes the | |
926 | integer fields of which to get the | |
927 | encoding. | |
928 | @returns Encoding of the integer | |
929 | fields described by \p int_field_type, | |
930 | or #BT_CTF_STRING_ENCODING_UNKNOWN on | |
931 | error. | |
932 | ||
933 | @prenotnull{int_field_type} | |
934 | @preisintft{int_field_type} | |
935 | @postrefcountsame{int_field_type} | |
936 | ||
937 | @sa bt_ctf_field_type_integer_set_encoding(): Sets the encoding | |
938 | of the integer fields described by a given integer field type. | |
939 | */ | |
87b41f95 | 940 | extern enum bt_ctf_string_encoding bt_ctf_field_type_integer_get_encoding( |
78c8ab4f | 941 | struct bt_ctf_field_type *int_field_type); |
b92ddaaa | 942 | |
78c8ab4f | 943 | /** |
4089d5a6 PP |
944 | @brief Sets the encoding of the @intfields described by the @intft |
945 | \p int_field_type to \p encoding. | |
78c8ab4f | 946 | |
4089d5a6 PP |
947 | You can use this property, in CTF IR, to create "text" @arrayfts or |
948 | @seqfts. A text array field type is array field type with an unsigned, | |
78c8ab4f PP |
949 | 8-bit integer field type having an encoding as its element field type. |
950 | ||
951 | @param[in] int_field_type Integer field type which describes the | |
952 | integer fields of which to set the | |
953 | encoding. | |
954 | @param[in] encoding Encoding of the integer | |
955 | fields described by \p int_field_type. | |
956 | @returns 0 on success, or a negative value on error. | |
957 | ||
958 | @prenotnull{int_field_type} | |
959 | @preisintft{int_field_type} | |
960 | @prehot{int_field_type} | |
961 | @pre \p encoding is #BT_CTF_STRING_ENCODING_NONE, | |
962 | #BT_CTF_STRING_ENCODING_ASCII, or | |
963 | #BT_CTF_STRING_ENCODING_UTF8. | |
964 | @postrefcountsame{int_field_type} | |
965 | ||
966 | @sa bt_ctf_field_type_integer_get_encoding(): Returns the encoding of | |
967 | the integer fields described by a given integer field type. | |
968 | */ | |
adc315b8 | 969 | extern int bt_ctf_field_type_integer_set_encoding( |
78c8ab4f | 970 | struct bt_ctf_field_type *int_field_type, |
87b41f95 | 971 | enum bt_ctf_string_encoding encoding); |
adc315b8 | 972 | |
6cfb906f | 973 | /** |
4089d5a6 PP |
974 | @brief Returns the \link ctfirclockclass CTF IR clock class\endlink |
975 | mapped to the @intft \p int_field_type. | |
78c8ab4f PP |
976 | |
977 | The mapped clock class, if any, indicates the class of the clock which | |
4089d5a6 | 978 | an @intfield described by \p int_field_type should sample or update. |
78c8ab4f PP |
979 | This mapped clock class is only indicative. |
980 | ||
981 | @param[in] int_field_type Integer field type of which to get the | |
982 | mapped clock class. | |
983 | @returns Mapped clock class of \p int_field_type, | |
984 | or \c NULL if there's no mapped clock | |
985 | class or on error. | |
986 | ||
987 | @prenotnull{int_field_type} | |
988 | @preisintft{int_field_type} | |
989 | @postrefcountsame{int_field_type} | |
990 | @postsuccessrefcountretinc | |
991 | ||
ac0c6bdd | 992 | @sa bt_ctf_field_type_integer_set_mapped_clock_class(): Sets the mapped |
78c8ab4f PP |
993 | clock class of a given integer field type. |
994 | */ | |
ac0c6bdd | 995 | extern struct bt_ctf_clock_class *bt_ctf_field_type_integer_get_mapped_clock_class( |
78c8ab4f | 996 | struct bt_ctf_field_type *int_field_type); |
6cfb906f JG |
997 | |
998 | /** | |
4089d5a6 | 999 | @brief Sets the \link ctfirclockclass CTF IR clock class\endlink mapped |
ac0c6bdd | 1000 | to the @intft \p int_field_type to \p clock_class. |
78c8ab4f PP |
1001 | |
1002 | The mapped clock class, if any, indicates the class of the clock which | |
1003 | an integer field described by \p int_field_type should sample or update. | |
1004 | This mapped clock class is only indicative. | |
1005 | ||
1006 | @param[in] int_field_type Integer field type of which to set the | |
1007 | mapped clock class. | |
1008 | @param[in] clock_class Mapped clock class of \p int_field_type. | |
1009 | @returns 0 on success, or a negative value on error. | |
1010 | ||
1011 | @prenotnull{int_field_type} | |
1012 | @prenotnull{clock_class} | |
1013 | @preisintft{int_field_type} | |
1014 | @prehot{int_field_type} | |
1015 | @postrefcountsame{int_field_type} | |
1016 | @postsuccessrefcountinc{clock_class} | |
1017 | ||
ac0c6bdd | 1018 | @sa bt_ctf_field_type_integer_get_mapped_clock_class(): Returns the mapped |
78c8ab4f PP |
1019 | clock class of a given integer field type. |
1020 | */ | |
ac0c6bdd | 1021 | extern int bt_ctf_field_type_integer_set_mapped_clock_class( |
78c8ab4f | 1022 | struct bt_ctf_field_type *int_field_type, |
ac0c6bdd | 1023 | struct bt_ctf_clock_class *clock_class); |
6cfb906f | 1024 | |
78c8ab4f | 1025 | /** @} */ |
adc315b8 | 1026 | |
78c8ab4f PP |
1027 | /** |
1028 | @defgroup ctfirfloatfieldtype CTF IR floating point number field type | |
1029 | @ingroup ctfirfieldtypes | |
1030 | @brief CTF IR floating point number field type. | |
1031 | ||
1032 | @code | |
1033 | #include <babeltrace/ctf-ir/field-types.h> | |
1034 | @endcode | |
1035 | ||
1036 | A CTF IR <strong><em>floating point number field type</em></strong> is | |
4089d5a6 | 1037 | a field type that you can use to create concrete @floatfields. |
78c8ab4f PP |
1038 | |
1039 | You can create a floating point number field type | |
1040 | with bt_ctf_field_type_floating_point_create(). | |
1041 | ||
1042 | A floating point number field type has the following properties: | |
1043 | ||
1044 | <table> | |
1045 | <tr> | |
1046 | <th>Property | |
1047 | <th>Value at creation | |
1048 | <th>Getter | |
1049 | <th>Setter | |
1050 | </tr> | |
1051 | <tr> | |
1052 | <td>\b Alignment (bits) of the described floating point | |
1053 | number fields | |
1054 | <td>1 | |
1055 | <td>bt_ctf_field_type_get_alignment() | |
1056 | <td>bt_ctf_field_type_set_alignment() | |
1057 | </tr> | |
1058 | <tr> | |
1059 | <td><strong>Byte order</strong> of the described floating point | |
1060 | number fields | |
1061 | <td>#BT_CTF_BYTE_ORDER_NATIVE | |
1062 | <td>bt_ctf_field_type_get_byte_order() | |
1063 | <td>bt_ctf_field_type_set_byte_order() | |
1064 | </tr> | |
1065 | <tr> | |
1066 | <td><strong>Exponent storage size</strong> (bits) of the described | |
1067 | floating point number fields | |
1068 | <td>8 | |
1069 | <td>bt_ctf_field_type_floating_point_get_exponent_digits() | |
1070 | <td>bt_ctf_field_type_floating_point_set_exponent_digits() | |
1071 | </tr> | |
1072 | <tr> | |
1073 | <td><strong>Mantissa and sign storage size</strong> (bits) of the | |
1074 | described floating point number fields | |
1075 | <td>24 (23-bit mantissa, 1-bit sign) | |
1076 | <td>bt_ctf_field_type_floating_point_get_mantissa_digits() | |
1077 | <td>bt_ctf_field_type_floating_point_set_mantissa_digits() | |
1078 | </tr> | |
1079 | </table> | |
1080 | ||
1081 | @sa ctfirfloatfield | |
1082 | @sa ctfirfieldtypes | |
bb8c17e0 | 1083 | @sa \ref ctfirfieldtypesexamples_floatfieldtype "Examples" |
78c8ab4f PP |
1084 | |
1085 | @addtogroup ctfirfloatfieldtype | |
1086 | @{ | |
1087 | */ | |
b92ddaaa | 1088 | |
78c8ab4f | 1089 | /** |
4089d5a6 | 1090 | @brief Creates a default @floatft. |
adc315b8 | 1091 | |
78c8ab4f PP |
1092 | @returns Created floating point number field type, |
1093 | or \c NULL on error. | |
b92ddaaa | 1094 | |
78c8ab4f PP |
1095 | @postsuccessrefcountret1 |
1096 | */ | |
1097 | extern struct bt_ctf_field_type *bt_ctf_field_type_floating_point_create(void); | |
b92ddaaa | 1098 | |
78c8ab4f | 1099 | /** |
4089d5a6 PP |
1100 | @brief Returns the exponent storage size of the @floatfields |
1101 | described by the @floatft \p float_field_type. | |
78c8ab4f PP |
1102 | |
1103 | @param[in] float_field_type Floating point number field type which | |
1104 | describes the floating point number | |
1105 | fields of which to get the exponent | |
1106 | storage size. | |
1107 | @returns Exponent storage size of the | |
1108 | floating point number fields | |
1109 | described by \p float_field_type, | |
1110 | or a negative value on error. | |
1111 | ||
1112 | @prenotnull{float_field_type} | |
1113 | @preisfloatft{float_field_type} | |
1114 | @postrefcountsame{float_field_type} | |
1115 | ||
1116 | @sa bt_ctf_field_type_floating_point_set_exponent_digits(): Sets the | |
1117 | exponent storage size of the floating point number fields | |
1118 | described by a given floating point number field type. | |
1119 | */ | |
1120 | extern int bt_ctf_field_type_floating_point_get_exponent_digits( | |
1121 | struct bt_ctf_field_type *float_field_type); | |
b92ddaaa | 1122 | |
78c8ab4f | 1123 | /** |
4089d5a6 PP |
1124 | @brief Sets the exponent storage size of the @floatfields described by |
1125 | the @floatft \p float_field_type to \p exponent_size. | |
78c8ab4f PP |
1126 | |
1127 | As of Babeltrace \btversion, \p exponent_size can only be 8 or 11. | |
1128 | ||
1129 | @param[in] float_field_type Floating point number field type which | |
1130 | describes the floating point number | |
1131 | fields of which to set the exponent | |
1132 | storage size. | |
1133 | @param[in] exponent_size Exponent storage size of the floating | |
1134 | point number fields described by \p | |
1135 | float_field_type. | |
1136 | @returns 0 on success, or a negative value on error. | |
1137 | ||
1138 | @prenotnull{float_field_type} | |
1139 | @preisfloatft{float_field_type} | |
1140 | @prehot{float_field_type} | |
1141 | @pre \p exponent_size is 8 or 11. | |
1142 | @postrefcountsame{float_field_type} | |
1143 | ||
1144 | @sa bt_ctf_field_type_floating_point_get_exponent_digits(): Returns the | |
1145 | exponent storage size of the floating point number fields | |
1146 | described by a given floating point number field type. | |
1147 | */ | |
1148 | extern int bt_ctf_field_type_floating_point_set_exponent_digits( | |
1149 | struct bt_ctf_field_type *float_field_type, | |
1150 | unsigned int exponent_size); | |
1151 | ||
1152 | /** | |
4089d5a6 PP |
1153 | @brief Returns the mantissa and sign storage size of the @floatfields |
1154 | described by the @floatft \p float_field_type. | |
78c8ab4f PP |
1155 | |
1156 | On success, the returned value is the sum of the mantissa \em and | |
1157 | sign storage sizes. | |
1158 | ||
1159 | @param[in] float_field_type Floating point number field type which | |
1160 | describes the floating point number | |
1161 | fields of which to get the mantissa and | |
1162 | sign storage size. | |
1163 | @returns Mantissa and sign storage size of the | |
1164 | floating point number fields | |
1165 | described by \p float_field_type, | |
1166 | or a negative value on error. | |
1167 | ||
1168 | @prenotnull{float_field_type} | |
1169 | @preisfloatft{float_field_type} | |
1170 | @postrefcountsame{float_field_type} | |
1171 | ||
1172 | @sa bt_ctf_field_type_floating_point_set_mantissa_digits(): Sets the | |
1173 | mantissa and size storage size of the floating point number | |
1174 | fields described by a given floating point number field type. | |
1175 | */ | |
1176 | extern int bt_ctf_field_type_floating_point_get_mantissa_digits( | |
1177 | struct bt_ctf_field_type *float_field_type); | |
1178 | ||
1179 | /** | |
4089d5a6 PP |
1180 | @brief Sets the mantissa and sign storage size of the @floatfields |
1181 | described by the @floatft \p float_field_type to \p | |
1182 | mantissa_sign_size. | |
78c8ab4f PP |
1183 | |
1184 | As of Babeltrace \btversion, \p mantissa_sign_size can only be 24 or 53. | |
1185 | ||
1186 | @param[in] float_field_type Floating point number field type which | |
1187 | describes the floating point number | |
1188 | fields of which to set the mantissa and | |
1189 | sign storage size. | |
1190 | @param[in] mantissa_sign_size Mantissa and sign storage size of the | |
1191 | floating point number fields described | |
1192 | by \p float_field_type. | |
1193 | @returns 0 on success, or a negative value on error. | |
1194 | ||
1195 | @prenotnull{float_field_type} | |
1196 | @preisfloatft{float_field_type} | |
1197 | @prehot{float_field_type} | |
1198 | @pre \p mantissa_sign_size is 24 or 53. | |
1199 | @postrefcountsame{float_field_type} | |
1200 | ||
1201 | @sa bt_ctf_field_type_floating_point_get_mantissa_digits(): Returns the | |
1202 | mantissa and sign storage size of the floating point number | |
1203 | fields described by a given floating point number field type. | |
1204 | */ | |
1205 | extern int bt_ctf_field_type_floating_point_set_mantissa_digits( | |
1206 | struct bt_ctf_field_type *float_field_type, | |
1207 | unsigned int mantissa_sign_size); | |
1208 | ||
1209 | /** @} */ | |
b92ddaaa | 1210 | |
78c8ab4f PP |
1211 | /** |
1212 | @defgroup ctfirenumfieldtype CTF IR enumeration field type | |
1213 | @ingroup ctfirfieldtypes | |
1214 | @brief CTF IR enumeration field type. | |
1215 | ||
1216 | @code | |
1217 | #include <babeltrace/ctf-ir/field-types.h> | |
1218 | @endcode | |
1219 | ||
1220 | A CTF IR <strong><em>enumeration field type</em></strong> is | |
4089d5a6 | 1221 | a field type that you can use to create concrete @enumfields. |
78c8ab4f | 1222 | |
4089d5a6 PP |
1223 | You can create an enumeration field type with |
1224 | bt_ctf_field_type_enumeration_create(). This function needs a @intft | |
1225 | which represents the storage field type of the created enumeration field | |
1226 | type. In other words, an enumeration field type wraps an integer field | |
1227 | type and adds label-value mappings to it. | |
78c8ab4f PP |
1228 | |
1229 | An enumeration mapping has: | |
1230 | ||
1231 | - A <strong>name</strong>. | |
1232 | - A <strong>range of values</strong> given by a beginning and an ending | |
1233 | value, both included in the range. | |
1234 | ||
1235 | You can add a mapping to an enumeration field type with | |
1236 | bt_ctf_field_type_enumeration_add_mapping() or | |
1237 | bt_ctf_field_type_enumeration_add_mapping_unsigned(), depending on the | |
4089d5a6 | 1238 | signedness of the wrapped @intft. |
78c8ab4f | 1239 | |
5c3f3b7e PP |
1240 | You can find mappings by name or by value with the following find |
1241 | operations: | |
1242 | ||
1243 | - bt_ctf_field_type_enumeration_find_mappings_by_name(): Finds the | |
1244 | mappings with a given name. | |
1245 | - bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(): | |
1246 | Finds the mappings which contain a given unsigned value in their | |
1247 | range. | |
1248 | - bt_ctf_field_type_enumeration_find_mappings_by_signed_value(): | |
1249 | Finds the mappings which contain a given signed value in their range. | |
1250 | ||
1251 | Those functions return a @enumftiter on the result set of the find | |
1252 | operation. | |
1253 | ||
96e8f959 MD |
1254 | Many mappings can share the same name, and the ranges of a given |
1255 | enumeration field type are allowed to overlap. For example, | |
78c8ab4f PP |
1256 | this is a valid set of mappings: |
1257 | ||
1258 | @verbatim | |
1259 | APPLE -> [ 3, 19] | |
1260 | BANANA -> [-15, 1] | |
1261 | CHERRY -> [ 25, 34] | |
1262 | APPLE -> [ 55, 55] | |
1263 | @endverbatim | |
1264 | ||
96e8f959 | 1265 | The following set of mappings is also valid: |
78c8ab4f PP |
1266 | |
1267 | @verbatim | |
1268 | APPLE -> [ 3, 19] | |
1269 | BANANA -> [-15, 1] | |
1270 | CHERRY -> [ 25, 34] | |
1271 | APPLE -> [ 30, 55] | |
1272 | @endverbatim | |
1273 | ||
1274 | Here, the range of the second \c APPLE mapping overlaps the range of | |
1275 | the \c CHERRY mapping. | |
1276 | ||
5c3f3b7e | 1277 | @sa ctfirenumftmappingiter |
78c8ab4f PP |
1278 | @sa ctfirenumfield |
1279 | @sa ctfirfieldtypes | |
1280 | ||
1281 | @addtogroup ctfirenumfieldtype | |
1282 | @{ | |
1283 | */ | |
1284 | ||
1285 | /** | |
4089d5a6 | 1286 | @brief Creates a default @enumft wrapping the @intft \p int_field_type. |
78c8ab4f PP |
1287 | |
1288 | @param[in] int_field_type Integer field type wrapped by the | |
1289 | created enumeration field type. | |
1290 | @returns Created enumeration field type, | |
1291 | or \c NULL on error. | |
1292 | ||
1293 | @prenotnull{int_field_type} | |
1294 | @preisintft{int_field_type} | |
1295 | @postsuccessrefcountinc{int_field_type} | |
1296 | @postsuccessrefcountret1 | |
1297 | */ | |
1298 | extern struct bt_ctf_field_type *bt_ctf_field_type_enumeration_create( | |
1299 | struct bt_ctf_field_type *int_field_type); | |
1300 | ||
1301 | /** | |
4089d5a6 | 1302 | @brief Returns the @intft wrapped by the @enumft \p enum_field_type. |
78c8ab4f PP |
1303 | |
1304 | @param[in] enum_field_type Enumeration field type of which to get | |
1305 | the wrapped integer field type. | |
1306 | @returns Integer field type wrapped by | |
1307 | \p enum_field_type, or \c NULL on | |
1308 | error. | |
1309 | ||
1310 | @prenotnull{enum_field_type} | |
1311 | @preisenumft{enum_field_type} | |
1312 | @postrefcountsame{enum_field_type} | |
1313 | @postsuccessrefcountretinc | |
1314 | */ | |
1315 | extern | |
1316 | struct bt_ctf_field_type *bt_ctf_field_type_enumeration_get_container_type( | |
1317 | struct bt_ctf_field_type *enum_field_type); | |
1318 | ||
1319 | /** | |
4089d5a6 PP |
1320 | @brief Returns the number of mappings contained in the |
1321 | @enumft \p enum_field_type. | |
78c8ab4f PP |
1322 | |
1323 | @param[in] enum_field_type Enumeration field type of which to get | |
1324 | the number of contained mappings. | |
1325 | @returns Number of mappings contained in | |
1326 | \p enum_field_type, or a negative | |
1327 | value on error. | |
1328 | ||
1329 | @prenotnull{enum_field_type} | |
1330 | @preisenumft{enum_field_type} | |
1331 | @postrefcountsame{enum_field_type} | |
1332 | */ | |
1333 | extern int bt_ctf_field_type_enumeration_get_mapping_count( | |
1334 | struct bt_ctf_field_type *enum_field_type); | |
1335 | ||
1336 | /** | |
4089d5a6 | 1337 | @brief Returns the signed mapping of the @enumft |
78c8ab4f PP |
1338 | \p enum_field_type at index \p index. |
1339 | ||
4089d5a6 PP |
1340 | The @intft wrapped by \p enum_field_type, as returned by |
1341 | bt_ctf_field_type_enumeration_get_container_type(), must be \b signed | |
1342 | to use this function. | |
78c8ab4f PP |
1343 | |
1344 | On success, \p enum_field_type remains the sole owner of \p *name. | |
1345 | ||
1346 | @param[in] enum_field_type Enumeration field type of which to get | |
1347 | the mapping at index \p index. | |
8dc7eb94 | 1348 | @param[in] index Index of the mapping to get from |
78c8ab4f PP |
1349 | \p enum_field_type. |
1350 | @param[out] name Returned name of the mapping at index | |
1351 | \p index. | |
1352 | @param[out] range_begin Returned beginning of the range | |
1353 | (included) of the mapping at index \p | |
1354 | index. | |
1355 | @param[out] range_end Returned end of the range (included) of | |
1356 | the mapping at index \p index. | |
1357 | @returns 0 on success, or a negative value on error. | |
1358 | ||
1359 | @prenotnull{enum_field_type} | |
1360 | @prenotnull{name} | |
1361 | @prenotnull{range_begin} | |
1362 | @prenotnull{range_end} | |
1363 | @preisenumft{enum_field_type} | |
4089d5a6 | 1364 | @pre The wrapped @intft of \p enum_field_type is signed. |
78c8ab4f PP |
1365 | @pre \p index is lesser than the number of mappings contained in the |
1366 | enumeration field type \p enum_field_type (see | |
1367 | bt_ctf_field_type_enumeration_get_mapping_count()). | |
1368 | @postrefcountsame{enum_field_type} | |
1369 | ||
cfb61c11 JG |
1370 | @sa bt_ctf_field_type_enumeration_get_mapping_unsigned(): Returns the |
1371 | unsigned mapping contained by a given enumeration field type | |
78c8ab4f PP |
1372 | at a given index. |
1373 | */ | |
96e8f959 | 1374 | extern int bt_ctf_field_type_enumeration_get_mapping_signed( |
78c8ab4f PP |
1375 | struct bt_ctf_field_type *enum_field_type, int index, |
1376 | const char **name, int64_t *range_begin, int64_t *range_end); | |
1377 | ||
1378 | /** | |
4089d5a6 PP |
1379 | @brief Returns the unsigned mapping of the @enumft |
1380 | \p enum_field_type at index \p index. | |
78c8ab4f | 1381 | |
4089d5a6 | 1382 | The @intft wrapped by \p enum_field_type, as returned by |
78c8ab4f PP |
1383 | bt_ctf_field_type_enumeration_get_container_type(), must be |
1384 | \b unsigned to use this function. | |
1385 | ||
1386 | On success, \p enum_field_type remains the sole owner of \p *name. | |
1387 | ||
1388 | @param[in] enum_field_type Enumeration field type of which to get | |
1389 | the mapping at index \p index. | |
8dc7eb94 | 1390 | @param[in] index Index of the mapping to get from |
78c8ab4f PP |
1391 | \p enum_field_type. |
1392 | @param[out] name Returned name of the mapping at index | |
1393 | \p index. | |
1394 | @param[out] range_begin Returned beginning of the range | |
1395 | (included) of the mapping at index \p | |
1396 | index. | |
1397 | @param[out] range_end Returned end of the range (included) of | |
1398 | the mapping at index \p index. | |
1399 | @returns 0 on success, or a negative value on error. | |
1400 | ||
1401 | @prenotnull{enum_field_type} | |
1402 | @prenotnull{name} | |
1403 | @prenotnull{range_begin} | |
1404 | @prenotnull{range_end} | |
1405 | @preisenumft{enum_field_type} | |
4089d5a6 | 1406 | @pre The wrapped @intft of \p enum_field_type is unsigned. |
78c8ab4f PP |
1407 | @pre \p index is lesser than the number of mappings contained in the |
1408 | enumeration field type \p enum_field_type (see | |
1409 | bt_ctf_field_type_enumeration_get_mapping_count()). | |
1410 | @postrefcountsame{enum_field_type} | |
1411 | ||
cfb61c11 JG |
1412 | @sa bt_ctf_field_type_enumeration_get_mapping_signed(): Returns the |
1413 | signed mapping contained by a given enumeration field type | |
78c8ab4f PP |
1414 | at a given index. |
1415 | */ | |
1416 | extern int bt_ctf_field_type_enumeration_get_mapping_unsigned( | |
1417 | struct bt_ctf_field_type *enum_field_type, int index, | |
1418 | const char **name, uint64_t *range_begin, | |
1419 | uint64_t *range_end); | |
1420 | ||
8dc7eb94 | 1421 | /** |
5c3f3b7e PP |
1422 | @brief Finds the mappings of the @enumft \p enum_field_type which |
1423 | are named \p name. | |
8dc7eb94 | 1424 | |
5c3f3b7e PP |
1425 | This function returns an iterator on the result set of this find |
1426 | operation. See \ref ctfirenumftmappingiter for more details. | |
1427 | ||
1428 | @param[in] enum_field_type Enumeration field type of which to find | |
1429 | the mappings named \p name. | |
1430 | @param[in] name Name of the mappings to find in | |
1431 | \p enum_field_type. | |
1432 | @returns @enumftiter on the set of mappings named | |
1433 | \p name in \p enum_field_type, or | |
1434 | \c NULL if no mappings were found or | |
1435 | on error. | |
8dc7eb94 JG |
1436 | |
1437 | @prenotnull{enum_field_type} | |
1438 | @prenotnull{name} | |
1439 | @preisenumft{enum_field_type} | |
1440 | @postrefcountsame{enum_field_type} | |
1441 | @postsuccessrefcountret1 | |
5c3f3b7e PP |
1442 | @post <strong>On success</strong>, the returned @enumftiter can iterate |
1443 | on at least one mapping. | |
1444 | ||
1445 | @sa bt_ctf_field_type_enumeration_find_mappings_by_signed_value(): Finds | |
1446 | the mappings of a given enumeration field type which contain | |
1447 | a given signed value in their range. | |
1448 | @sa bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(): Finds | |
1449 | the mappings of a given enumeration field type which contain | |
1450 | a given unsigned value in their range. | |
8dc7eb94 JG |
1451 | */ |
1452 | extern struct bt_ctf_field_type_enumeration_mapping_iterator * | |
1453 | bt_ctf_field_type_enumeration_find_mappings_by_name( | |
1454 | struct bt_ctf_field_type *enum_field_type, | |
1455 | const char *name); | |
1456 | ||
1457 | /** | |
5c3f3b7e PP |
1458 | @brief Finds the mappings of the @enumft \p enum_field_type which |
1459 | contain the signed value \p value in their range. | |
8dc7eb94 | 1460 | |
5c3f3b7e PP |
1461 | This function returns an iterator on the result set of this find |
1462 | operation. See \ref ctfirenumftmappingiter for more details. | |
1463 | ||
1464 | @param[in] enum_field_type Enumeration field type of which to find | |
1465 | the mappings which contain \p value. | |
1466 | @param[in] value Value to find in the ranges of the | |
1467 | mappings of \p enum_field_type. | |
1468 | @returns @enumftiter on the set of mappings of | |
1469 | \p enum_field_type which contain | |
1470 | \p value in their range, or \c NULL if | |
1471 | no mappings were found or on error. | |
8dc7eb94 JG |
1472 | |
1473 | @prenotnull{enum_field_type} | |
8dc7eb94 JG |
1474 | @preisenumft{enum_field_type} |
1475 | @postrefcountsame{enum_field_type} | |
1476 | @postsuccessrefcountret1 | |
5c3f3b7e PP |
1477 | @post <strong>On success</strong>, the returned @enumftiter can iterate |
1478 | on at least one mapping. | |
1479 | ||
1480 | @sa bt_ctf_field_type_enumeration_find_mappings_by_name(): Finds the | |
1481 | mappings of a given enumeration field type which have a given | |
1482 | name. | |
1483 | @sa bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(): Finds | |
1484 | the mappings of a given enumeration field type which contain | |
1485 | a given unsigned value in their range. | |
8dc7eb94 JG |
1486 | */ |
1487 | extern struct bt_ctf_field_type_enumeration_mapping_iterator * | |
1488 | bt_ctf_field_type_enumeration_find_mappings_by_signed_value( | |
1489 | struct bt_ctf_field_type *enum_field_type, | |
1490 | int64_t value); | |
1491 | ||
1492 | /** | |
5c3f3b7e PP |
1493 | @brief Finds the mappings of the @enumft \p enum_field_type which |
1494 | contain the unsigned value \p value in their range. | |
1495 | ||
1496 | This function returns an iterator on the result set of this find | |
1497 | operation. See \ref ctfirenumftmappingiter for more details. | |
1498 | ||
1499 | @param[in] enum_field_type Enumeration field type of which to find | |
1500 | the mappings which contain \p value. | |
1501 | @param[in] value Value to find in the ranges of the | |
1502 | mappings of \p enum_field_type. | |
1503 | @returns @enumftiter on the set of mappings of | |
1504 | \p enum_field_type which contain | |
1505 | \p value in their range, or \c NULL | |
1506 | if no mappings were found or | |
1507 | on error. | |
8dc7eb94 JG |
1508 | |
1509 | @prenotnull{enum_field_type} | |
8dc7eb94 JG |
1510 | @preisenumft{enum_field_type} |
1511 | @postrefcountsame{enum_field_type} | |
1512 | @postsuccessrefcountret1 | |
5c3f3b7e PP |
1513 | @post <strong>On success</strong>, the returned @enumftiter can iterate |
1514 | on at least one mapping. | |
1515 | ||
1516 | @sa bt_ctf_field_type_enumeration_find_mappings_by_name(): Finds the | |
1517 | mappings of a given enumeration field type which have a given | |
1518 | name. | |
1519 | @sa bt_ctf_field_type_enumeration_find_mappings_by_signed_value(): Finds | |
1520 | the mappings of a given enumeration field type which contain | |
1521 | a given unsigned value in their range. | |
8dc7eb94 JG |
1522 | */ |
1523 | extern struct bt_ctf_field_type_enumeration_mapping_iterator * | |
1524 | bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value( | |
1525 | struct bt_ctf_field_type *enum_field_type, | |
1526 | uint64_t value); | |
1527 | ||
78c8ab4f | 1528 | /** |
4089d5a6 PP |
1529 | @brief Adds a mapping to the @enumft \p enum_field_type which maps the |
1530 | name \p name to the signed range \p range_begin (included) to | |
1531 | \p range_end (included). | |
78c8ab4f PP |
1532 | |
1533 | Make \p range_begin and \p range_end the same value to add a mapping | |
1534 | to a single value. | |
1535 | ||
4089d5a6 | 1536 | The @intft wrapped by \p enum_field_type, as returned by |
78c8ab4f PP |
1537 | bt_ctf_field_type_enumeration_get_container_type(), must be |
1538 | \b signed to use this function. | |
1539 | ||
96e8f959 | 1540 | A mapping in \p enum_field_type can exist with the name \p name. |
78c8ab4f PP |
1541 | |
1542 | @param[in] enum_field_type Enumeration field type to which to add | |
1543 | a mapping. | |
1544 | @param[in] name Name of the mapping to add (copied | |
1545 | on success). | |
1546 | @param[in] range_begin Beginning of the range of the mapping | |
1547 | (included). | |
1548 | @param[in] range_end End of the range of the mapping | |
1549 | (included). | |
1550 | @returns 0 on success, or a negative value on error. | |
1551 | ||
1552 | @prenotnull{enum_field_type} | |
1553 | @prenotnull{name} | |
1554 | @preisenumft{enum_field_type} | |
4089d5a6 | 1555 | @pre The wrapped @intft of \p enum_field_type is signed. |
78c8ab4f PP |
1556 | @pre \p range_end is greater than or equal to \p range_begin. |
1557 | @postrefcountsame{enum_field_type} | |
1558 | ||
1559 | @sa bt_ctf_field_type_enumeration_add_mapping_unsigned(): Adds an | |
1560 | unsigned mapping to a given enumeration field type. | |
1561 | */ | |
1562 | extern int bt_ctf_field_type_enumeration_add_mapping( | |
1563 | struct bt_ctf_field_type *enum_field_type, const char *name, | |
1564 | int64_t range_begin, int64_t range_end); | |
adc315b8 | 1565 | |
78c8ab4f | 1566 | /** |
4089d5a6 PP |
1567 | @brief Adds a mapping to the @enumft \p enum_field_type which maps |
1568 | the name \p name to the unsigned | |
78c8ab4f PP |
1569 | range \p range_begin (included) to \p range_end (included). |
1570 | ||
1571 | Make \p range_begin and \p range_end the same value to add a mapping | |
1572 | to a single value. | |
1573 | ||
4089d5a6 | 1574 | The @intft wrapped by \p enum_field_type, as returned by |
78c8ab4f PP |
1575 | bt_ctf_field_type_enumeration_get_container_type(), must be |
1576 | \b unsigned to use this function. | |
1577 | ||
96e8f959 | 1578 | A mapping in \p enum_field_type can exist with the name \p name. |
78c8ab4f PP |
1579 | |
1580 | @param[in] enum_field_type Enumeration field type to which to add | |
1581 | a mapping. | |
1582 | @param[in] name Name of the mapping to add (copied | |
1583 | on success). | |
1584 | @param[in] range_begin Beginning of the range of the mapping | |
1585 | (included). | |
1586 | @param[in] range_end End of the range of the mapping | |
1587 | (included). | |
1588 | @returns 0 on success, or a negative value on error. | |
1589 | ||
1590 | @prenotnull{enum_field_type} | |
1591 | @prenotnull{name} | |
1592 | @preisenumft{enum_field_type} | |
4089d5a6 | 1593 | @pre The wrapped @intft of \p enum_field_type is unsigned. |
78c8ab4f PP |
1594 | @pre \p range_end is greater than or equal to \p range_begin. |
1595 | @postrefcountsame{enum_field_type} | |
1596 | ||
1597 | @sa bt_ctf_field_type_enumeration_add_mapping(): Adds a signed | |
1598 | mapping to a given enumeration field type. | |
1599 | */ | |
1600 | extern int bt_ctf_field_type_enumeration_add_mapping_unsigned( | |
1601 | struct bt_ctf_field_type *enum_field_type, const char *name, | |
1602 | uint64_t range_begin, uint64_t range_end); | |
b92ddaaa | 1603 | |
78c8ab4f | 1604 | /** @} */ |
adc315b8 | 1605 | |
cfb61c11 | 1606 | /** |
5c3f3b7e PP |
1607 | @defgroup ctfirenumftmappingiter CTF IR enumeration field type mapping iterator |
1608 | @ingroup ctfirenumfieldtype | |
1609 | @brief CTF IR enumeration field type mapping iterator. | |
cfb61c11 JG |
1610 | |
1611 | @code | |
1612 | #include <babeltrace/ctf-ir/field-types.h> | |
1613 | @endcode | |
1614 | ||
5c3f3b7e PP |
1615 | A CTF IR <strong><em>enumeration field type mapping |
1616 | iterator</em></strong> is an iterator on @enumft mappings. | |
1617 | ||
1618 | You can get an enumeration mapping iterator from one of the following | |
1619 | functions: | |
1620 | ||
1621 | - Find operations of an @enumft object: | |
1622 | - bt_ctf_field_type_enumeration_find_mappings_by_name(): Finds the | |
1623 | mappings with a given name. | |
1624 | - bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(): | |
1625 | Finds the mappings which contain a given unsigned value in their | |
1626 | range. | |
1627 | - bt_ctf_field_type_enumeration_find_mappings_by_signed_value(): | |
1628 | Finds the mappings which contain a given signed value in their range. | |
1629 | - bt_ctf_field_enumeration_get_mappings(): Finds the mappings in the | |
1630 | @enumft of an @enumfield containing its current integral value in | |
1631 | their range. | |
1632 | ||
1633 | Those functions guarantee that the returned iterator can iterate on | |
1634 | at least one mapping. Otherwise, they return \c NULL. | |
1635 | ||
1636 | You can get the name and the range of a mapping iterator's current | |
1637 | mapping with | |
1638 | bt_ctf_field_type_enumeration_mapping_iterator_get_signed() | |
1639 | or | |
1640 | bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned(), | |
1641 | depending on the signedness of the @intft wrapped by the | |
1642 | @enumft. If you only need the name of the current mapping, you can | |
1643 | use any of the two functions and set the \p range_begin and \p range_end | |
1644 | parameters to \c NULL. | |
1645 | ||
1646 | You can advance an enumeration field type mapping iterator to the next | |
1647 | mapping with | |
1648 | bt_ctf_field_type_enumeration_mapping_iterator_next(). This | |
1649 | function returns a negative value when you reach the end of the | |
1650 | result set. | |
1651 | ||
1652 | As with any Babeltrace object, CTF IR enumeration field type mapping | |
1653 | iterator objects have <a | |
1654 | href="https://en.wikipedia.org/wiki/Reference_counting">reference | |
1655 | counts</a>. See \ref refs to learn more about the reference counting | |
1656 | management of Babeltrace objects. | |
cfb61c11 JG |
1657 | |
1658 | @sa ctfirenumfieldtype | |
cfb61c11 | 1659 | |
5c3f3b7e | 1660 | @addtogroup ctfirenumftmappingiter |
cfb61c11 JG |
1661 | @{ |
1662 | */ | |
1663 | ||
1664 | /** | |
5c3f3b7e PP |
1665 | @struct bt_ctf_field_type_enumeration_mapping_iterator |
1666 | @brief A CTF IR enumeration field type mapping iterator. | |
1667 | @sa ctfirenumftmappingiter | |
cfb61c11 | 1668 | */ |
cfb61c11 JG |
1669 | |
1670 | /** | |
5c3f3b7e PP |
1671 | @brief Returns the name and the range of the current (signed) mapping |
1672 | of the @enumftiter \p iter. | |
cfb61c11 | 1673 | |
5c3f3b7e PP |
1674 | If one of \p range_begin or \p range_end is not \c NULL, the @intft |
1675 | wrapped by the @enumft from which \p iter was obtained, as returned by | |
cfb61c11 | 1676 | bt_ctf_field_type_enumeration_get_container_type(), must be |
5c3f3b7e PP |
1677 | \b signed to use this function. Otherwise, if you only need to get the |
1678 | name of the current mapping, set \p range_begin and \p range_end to | |
1679 | \c NULL. | |
1680 | ||
1681 | On success, if \p name is not \c NULL, \p *name remains valid as long | |
1682 | as \p iter exists and | |
1683 | bt_ctf_field_type_enumeration_mapping_iterator_next() is | |
1684 | \em not called on \p iter. | |
1685 | ||
1686 | @param[in] iter Enumeration field type mapping iterator | |
1687 | of which to get the range of the current | |
1688 | mapping. | |
1689 | @param[out] name Returned name of the current mapping of | |
1690 | \p iter (can be \c NULL to ignore). | |
cfb61c11 | 1691 | @param[out] range_begin Returned beginning of the range |
5c3f3b7e PP |
1692 | (included) of the current mapping of |
1693 | \p iter (can be \c NULL to ignore). | |
1694 | @param[out] range_end Returned end of the range | |
1695 | (included) of the current mapping of | |
1696 | \p iter (can be \c NULL to ignore). | |
cfb61c11 JG |
1697 | @returns 0 on success, or a negative value on error. |
1698 | ||
1699 | @prenotnull{iter} | |
cfb61c11 JG |
1700 | @postrefcountsame{iter} |
1701 | ||
5c3f3b7e PP |
1702 | @sa bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned(): |
1703 | Returns the name and the unsigned range of the current mapping | |
1704 | of a given enumeration field type mapping iterator. | |
cfb61c11 JG |
1705 | */ |
1706 | extern int bt_ctf_field_type_enumeration_mapping_iterator_get_signed( | |
1707 | struct bt_ctf_field_type_enumeration_mapping_iterator *iter, | |
5c3f3b7e | 1708 | const char **name, int64_t *range_begin, int64_t *range_end); |
cfb61c11 JG |
1709 | |
1710 | /** | |
5c3f3b7e PP |
1711 | @brief Returns the name and the range of the current (unsigned) mapping |
1712 | of the @enumftiter \p iter. | |
cfb61c11 | 1713 | |
5c3f3b7e PP |
1714 | If one of \p range_begin or \p range_end is not \c NULL, the @intft |
1715 | wrapped by the @enumft from which \p iter was obtained, as returned by | |
cfb61c11 | 1716 | bt_ctf_field_type_enumeration_get_container_type(), must be |
5c3f3b7e PP |
1717 | \b unsigned to use this function. Otherwise, if you only need to get the |
1718 | name of the current mapping, set \p range_begin and \p range_end to | |
1719 | \c NULL. | |
1720 | ||
1721 | On success, if \p name is not \c NULL, \p *name remains valid as long | |
1722 | as \p iter exists and | |
1723 | bt_ctf_field_type_enumeration_mapping_iterator_next() is | |
1724 | \em not called on \p iter. | |
1725 | ||
1726 | @param[in] iter Enumeration field type mapping iterator | |
1727 | of which to get the range of the current | |
1728 | mapping. | |
1729 | @param[out] name Returned name of the current mapping of | |
1730 | \p iter (can be \c NULL to ignore). | |
cfb61c11 | 1731 | @param[out] range_begin Returned beginning of the range |
5c3f3b7e PP |
1732 | (included) of the current mapping of |
1733 | \p iter (can be \c NULL to ignore). | |
1734 | @param[out] range_end Returned end of the range | |
1735 | (included) of the current mapping of | |
1736 | \p iter (can be \c NULL to ignore). | |
cfb61c11 JG |
1737 | @returns 0 on success, or a negative value on error. |
1738 | ||
1739 | @prenotnull{iter} | |
cfb61c11 JG |
1740 | @postrefcountsame{iter} |
1741 | ||
5c3f3b7e PP |
1742 | @sa |
1743 | bt_ctf_field_type_enumeration_mapping_iterator_get_signed(): | |
1744 | Returns the name and the signed range of the current mapping of | |
1745 | a given enumeration field type mapping iterator. | |
cfb61c11 JG |
1746 | */ |
1747 | extern int bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned( | |
1748 | struct bt_ctf_field_type_enumeration_mapping_iterator *iter, | |
5c3f3b7e | 1749 | const char **name, uint64_t *range_begin, uint64_t *range_end); |
cfb61c11 JG |
1750 | |
1751 | /** | |
5c3f3b7e | 1752 | @brief Advances the @enumftiter \p iter to the next mapping. |
cfb61c11 | 1753 | |
5c3f3b7e PP |
1754 | @param[in] iter Enumeration field type mapping iterator to |
1755 | advance. | |
1756 | @returns 0 on success, or a negative value on error or | |
1757 | when you reach the end of the set. | |
cfb61c11 JG |
1758 | |
1759 | @prenotnull{iter} | |
1760 | @postrefcountsame{iter} | |
1761 | */ | |
1762 | extern int bt_ctf_field_type_enumeration_mapping_iterator_next( | |
1763 | struct bt_ctf_field_type_enumeration_mapping_iterator *iter); | |
1764 | ||
1765 | /** @} */ | |
1766 | ||
78c8ab4f PP |
1767 | /** |
1768 | @defgroup ctfirstringfieldtype CTF IR string field type | |
1769 | @ingroup ctfirfieldtypes | |
1770 | @brief CTF IR string field type. | |
b92ddaaa | 1771 | |
78c8ab4f PP |
1772 | @code |
1773 | #include <babeltrace/ctf-ir/field-types.h> | |
1774 | @endcode | |
adc315b8 | 1775 | |
78c8ab4f | 1776 | A CTF IR <strong><em>string field type</em></strong> is a field type that |
4089d5a6 | 1777 | you can use to create concrete @stringfields. |
adc315b8 | 1778 | |
78c8ab4f PP |
1779 | You can create a string field type |
1780 | with bt_ctf_field_type_string_create(). | |
adc315b8 | 1781 | |
78c8ab4f | 1782 | A string field type has only one property: the \b encoding of its |
4089d5a6 | 1783 | described @stringfields. By default, the encoding of the string fields |
78c8ab4f PP |
1784 | described by a string field type is #BT_CTF_STRING_ENCODING_UTF8. You |
1785 | can set the encoding of the string fields described by a string field | |
1786 | type with bt_ctf_field_type_string_set_encoding(). | |
1787 | ||
1788 | @sa ctfirstringfield | |
1789 | @sa ctfirfieldtypes | |
1790 | ||
1791 | @addtogroup ctfirstringfieldtype | |
1792 | @{ | |
1793 | */ | |
1794 | ||
1795 | /** | |
4089d5a6 | 1796 | @brief Creates a default @stringft. |
78c8ab4f PP |
1797 | |
1798 | @returns Created string field type, or \c NULL on error. | |
1799 | ||
1800 | @postsuccessrefcountret1 | |
1801 | */ | |
1802 | extern struct bt_ctf_field_type *bt_ctf_field_type_string_create(void); | |
1803 | ||
1804 | /** | |
4089d5a6 PP |
1805 | @brief Returns the encoding of the @stringfields described by |
1806 | the @stringft \p string_field_type. | |
78c8ab4f PP |
1807 | |
1808 | @param[in] string_field_type String field type which describes the | |
1809 | string fields of which to get the | |
1810 | encoding. | |
1811 | @returns Encoding of the string | |
1812 | fields described by \p string_field_type, | |
1813 | or #BT_CTF_STRING_ENCODING_UNKNOWN on | |
1814 | error. | |
1815 | ||
1816 | @prenotnull{string_field_type} | |
1817 | @preisstringft{string_field_type} | |
1818 | @postrefcountsame{string_field_type} | |
1819 | ||
1820 | @sa bt_ctf_field_type_string_set_encoding(): Sets the encoding | |
1821 | of the string fields described by a given string field type. | |
1822 | */ | |
1823 | extern enum bt_ctf_string_encoding bt_ctf_field_type_string_get_encoding( | |
1824 | struct bt_ctf_field_type *string_field_type); | |
1825 | ||
1826 | /** | |
4089d5a6 PP |
1827 | @brief Sets the encoding of the @stringfields described by the |
1828 | @stringft \p string_field_type to \p encoding. | |
78c8ab4f PP |
1829 | |
1830 | @param[in] string_field_type String field type which describes the | |
1831 | string fields of which to set the | |
1832 | encoding. | |
1833 | @param[in] encoding Encoding of the string fields described | |
1834 | by \p string_field_type. | |
1835 | @returns 0 on success, or a negative value on error. | |
1836 | ||
1837 | @prenotnull{string_field_type} | |
1838 | @preisstringft{string_field_type} | |
1839 | @prehot{string_field_type} | |
1840 | @pre \p encoding is #BT_CTF_STRING_ENCODING_ASCII or | |
1841 | #BT_CTF_STRING_ENCODING_UTF8. | |
1842 | @postrefcountsame{string_field_type} | |
1843 | ||
1844 | @sa bt_ctf_field_type_string_get_encoding(): Returns the encoding of | |
1845 | the string fields described by a given string field type. | |
1846 | */ | |
1847 | extern int bt_ctf_field_type_string_set_encoding( | |
1848 | struct bt_ctf_field_type *string_field_type, | |
1849 | enum bt_ctf_string_encoding encoding); | |
1850 | ||
1851 | /** @} */ | |
1852 | ||
1853 | /** | |
1854 | @defgroup ctfirstructfieldtype CTF IR structure field type | |
1855 | @ingroup ctfirfieldtypes | |
1856 | @brief CTF IR structure field type. | |
1857 | ||
1858 | @code | |
1859 | #include <babeltrace/ctf-ir/field-types.h> | |
1860 | @endcode | |
1861 | ||
1862 | A CTF IR <strong><em>structure field type</em></strong> is | |
4089d5a6 | 1863 | a field type that you can use to create concrete @structfields. |
78c8ab4f PP |
1864 | |
1865 | You can create a structure field type | |
1866 | with bt_ctf_field_type_structure_create(). This function creates | |
1867 | an empty structure field type, with no fields. | |
1868 | ||
1869 | You can add a field to a structure field type with | |
1870 | bt_ctf_field_type_structure_add_field(). Two fields in a structure | |
1871 | field type cannot have the same name. | |
1872 | ||
1873 | You can set the \em minimum alignment of the structure fields described | |
1874 | by a structure field type with the common | |
1875 | bt_ctf_field_type_set_alignment() function. The \em effective alignment | |
1876 | of the structure fields described by a structure field type, as per | |
1877 | <a href="http://diamon.org/ctf/">CTF</a>, is the \em maximum value amongst | |
1878 | the effective alignments of all its fields. Note that the effective | |
4089d5a6 | 1879 | alignment of @varfields is always 1. |
78c8ab4f PP |
1880 | |
1881 | You can set the byte order of <em>all the contained fields</em>, | |
1882 | recursively, of a structure field type with the common | |
1883 | bt_ctf_field_type_set_byte_order() function. | |
1884 | ||
1885 | @sa ctfirstructfield | |
1886 | @sa ctfirfieldtypes | |
1887 | ||
1888 | @addtogroup ctfirstructfieldtype | |
1889 | @{ | |
1890 | */ | |
1891 | ||
1892 | /** | |
4089d5a6 | 1893 | @brief Creates a default, empty @structft. |
78c8ab4f PP |
1894 | |
1895 | @returns Created structure field type, | |
1896 | or \c NULL on error. | |
1897 | ||
1898 | @postsuccessrefcountret1 | |
1899 | */ | |
1900 | extern struct bt_ctf_field_type *bt_ctf_field_type_structure_create(void); | |
1901 | ||
1902 | /** | |
4089d5a6 PP |
1903 | @brief Returns the number of fields contained in the |
1904 | @structft \p struct_field_type. | |
78c8ab4f PP |
1905 | |
1906 | @param[in] struct_field_type Structure field type of which to get | |
1907 | the number of contained fields. | |
1908 | @returns Number of fields contained in | |
1909 | \p struct_field_type, or a negative | |
1910 | value on error. | |
1911 | ||
1912 | @prenotnull{struct_field_type} | |
1913 | @preisstructft{struct_field_type} | |
1914 | @postrefcountsame{struct_field_type} | |
1915 | */ | |
074ee56d | 1916 | extern int bt_ctf_field_type_structure_get_field_count( |
78c8ab4f | 1917 | struct bt_ctf_field_type *struct_field_type); |
b92ddaaa | 1918 | |
78c8ab4f | 1919 | /** |
4089d5a6 PP |
1920 | @brief Returns the field of the @structft \p struct_field_type |
1921 | at index \p index. | |
78c8ab4f PP |
1922 | |
1923 | On success, the field's type is placed in \p *field_type if | |
1924 | \p field_type is not \c NULL. The field's name is placed in | |
1925 | \p *field_name if \p field_name is not \c NULL. | |
1926 | \p struct_field_type remains the sole owner of \p *field_name. | |
1927 | ||
1928 | @param[in] struct_field_type Structure field type of which to get | |
1929 | the field at index \p index. | |
1930 | @param[out] field_name Returned name of the field at index | |
1931 | \p index (can be \c NULL). | |
1932 | @param[out] field_type Returned field type of the field | |
1933 | at index \p index (can be \c NULL). | |
1934 | @param[in] index Index of the field to get from | |
1935 | \p struct_field_type. | |
1936 | @returns 0 on success, or a negative value on error. | |
1937 | ||
1938 | @prenotnull{struct_field_type} | |
1939 | @preisstructft{struct_field_type} | |
1940 | @pre \p index is lesser than the number of fields contained in the | |
1941 | structure field type \p struct_field_type (see | |
1942 | bt_ctf_field_type_structure_get_field_count()). | |
1943 | @postrefcountsame{struct_field_type} | |
1944 | @post <strong>On success</strong>, the returned field's type is placed | |
1945 | in \p *field_type and its reference count is incremented. | |
1946 | ||
1947 | @sa bt_ctf_field_type_structure_get_field_type_by_name(): Finds a | |
1948 | structure field type's field by name. | |
1949 | */ | |
b92ddaaa | 1950 | extern int bt_ctf_field_type_structure_get_field( |
78c8ab4f | 1951 | struct bt_ctf_field_type *struct_field_type, |
b92ddaaa | 1952 | const char **field_name, struct bt_ctf_field_type **field_type, |
074ee56d | 1953 | int index); |
b92ddaaa | 1954 | |
78c8ab4f PP |
1955 | /** |
1956 | @brief Returns the type of the field named \p field_name found in | |
4089d5a6 | 1957 | the @structft \p struct_field_type. |
78c8ab4f PP |
1958 | |
1959 | @param[in] struct_field_type Structure field type of which to get | |
1960 | a field's type. | |
1961 | @param[in] field_name Name of the field to find. | |
1962 | @returns Type of the field named \p field_name in | |
1963 | \p struct_field_type, or | |
1964 | \c NULL on error. | |
1965 | ||
1966 | @prenotnull{struct_field_type} | |
1967 | @prenotnull{field_name} | |
1968 | @preisstructft{struct_field_type} | |
1969 | @postrefcountsame{struct_field_type} | |
1970 | @postsuccessrefcountretinc | |
1971 | ||
1972 | @sa bt_ctf_field_type_structure_get_field(): Finds a | |
1973 | structure field type's field by index. | |
1974 | */ | |
b92ddaaa JG |
1975 | extern |
1976 | struct bt_ctf_field_type *bt_ctf_field_type_structure_get_field_type_by_name( | |
78c8ab4f PP |
1977 | struct bt_ctf_field_type *struct_field_type, |
1978 | const char *field_name); | |
b92ddaaa | 1979 | |
78c8ab4f | 1980 | /** |
4089d5a6 PP |
1981 | @brief Adds a field named \p field_name with the @ft |
1982 | \p field_type to the @structft \p struct_field_type. | |
78c8ab4f PP |
1983 | |
1984 | On success, \p field_type becomes the child of \p struct_field_type. | |
1985 | ||
1986 | This function adds the new field after the current last field of | |
1987 | \p struct_field_type (append mode). | |
1988 | ||
1989 | You \em cannot add a field named \p field_name if there's already a | |
1990 | field named \p field_name in \p struct_field_type. | |
1991 | ||
1992 | @param[in] struct_field_type Structure field type to which to add | |
1993 | a new field. | |
1994 | @param[in] field_type Field type of the field to add to | |
1995 | \p struct_field_type. | |
1996 | @param[in] field_name Name of the field to add to | |
1997 | \p struct_field_type | |
1998 | (copied on success). | |
1999 | @returns 0 on success, or a negative value on error. | |
2000 | ||
2001 | @prenotnull{struct_field_type} | |
2002 | @prenotnull{field_type} | |
2003 | @prenotnull{field_name} | |
2004 | @preisstructft{struct_field_type} | |
2005 | @pre \p field_type is not and does not contain \p struct_field_type, | |
2006 | recursively, as a field's type. | |
2007 | @prehot{struct_field_type} | |
2008 | @postrefcountsame{struct_field_type} | |
2009 | @postsuccessrefcountinc{field_type} | |
2010 | */ | |
2011 | extern int bt_ctf_field_type_structure_add_field( | |
2012 | struct bt_ctf_field_type *struct_field_type, | |
2013 | struct bt_ctf_field_type *field_type, | |
2014 | const char *field_name); | |
b92ddaaa | 2015 | |
78c8ab4f | 2016 | /** @} */ |
b92ddaaa | 2017 | |
78c8ab4f PP |
2018 | /** |
2019 | @defgroup ctfirarrayfieldtype CTF IR array field type | |
2020 | @ingroup ctfirfieldtypes | |
2021 | @brief CTF IR array field type. | |
adc315b8 | 2022 | |
78c8ab4f PP |
2023 | @code |
2024 | #include <babeltrace/ctf-ir/field-types.h> | |
2025 | @endcode | |
d9b1ab6d | 2026 | |
78c8ab4f | 2027 | A CTF IR <strong><em>array field type</em></strong> is a field type that |
4089d5a6 | 2028 | you can use to create concrete @arrayfields. |
adc315b8 | 2029 | |
78c8ab4f PP |
2030 | You can create an array field type |
2031 | with bt_ctf_field_type_array_create(). This function needs | |
4089d5a6 PP |
2032 | the @ft of the fields contained by the array fields described by the |
2033 | array field type to create. | |
b92ddaaa | 2034 | |
78c8ab4f PP |
2035 | @sa ctfirarrayfield |
2036 | @sa ctfirfieldtypes | |
b92ddaaa | 2037 | |
78c8ab4f PP |
2038 | @addtogroup ctfirarrayfieldtype |
2039 | @{ | |
2040 | */ | |
b92ddaaa | 2041 | |
78c8ab4f | 2042 | /** |
4089d5a6 | 2043 | @brief Creates a default @arrayft with |
78c8ab4f | 2044 | \p element_field_type as the field type of the fields contained |
4089d5a6 | 2045 | in its described @arrayfields of length \p length. |
78c8ab4f PP |
2046 | |
2047 | @param[in] element_field_type Field type of the fields contained in | |
2048 | the array fields described by the | |
2049 | created array field type. | |
2050 | @param[in] length Length of the array fields described by | |
2051 | the created array field type. | |
2052 | @returns Created array field type, or | |
2053 | \c NULL on error. | |
2054 | ||
2055 | @prenotnull{element_field_type} | |
2056 | @postsuccessrefcountinc{element_field_type} | |
2057 | @postsuccessrefcountret1 | |
2058 | */ | |
adc315b8 | 2059 | extern struct bt_ctf_field_type *bt_ctf_field_type_array_create( |
78c8ab4f PP |
2060 | struct bt_ctf_field_type *element_field_type, |
2061 | unsigned int length); | |
b92ddaaa | 2062 | |
78c8ab4f | 2063 | /** |
4089d5a6 PP |
2064 | @brief Returns the @ft of the @fields contained in |
2065 | the @arrayfields described by the @arrayft \p array_field_type. | |
78c8ab4f PP |
2066 | |
2067 | @param[in] array_field_type Array field type of which to get | |
2068 | the type of the fields contained in its | |
2069 | described array fields. | |
2070 | @returns Type of the fields contained in the | |
2071 | array fields described by | |
2072 | \p array_field_type, or \c NULL | |
2073 | on error. | |
2074 | ||
2075 | @prenotnull{array_field_type} | |
2076 | @preisarrayft{array_field_type} | |
2077 | @postrefcountsame{array_field_type} | |
2078 | @postsuccessrefcountretinc | |
2079 | */ | |
b92ddaaa | 2080 | extern struct bt_ctf_field_type *bt_ctf_field_type_array_get_element_type( |
78c8ab4f | 2081 | struct bt_ctf_field_type *array_field_type); |
b92ddaaa | 2082 | |
78c8ab4f | 2083 | /** |
4089d5a6 PP |
2084 | @brief Returns the number of @fields contained in the |
2085 | @arrayfields described by the @arrayft \p array_field_type. | |
78c8ab4f PP |
2086 | |
2087 | @param[in] array_field_type Array field type of which to get | |
2088 | the number of fields contained in its | |
2089 | described array fields. | |
2090 | @returns Number of fields contained in the | |
2091 | array fields described by | |
2092 | \p array_field_type, or a negative value | |
2093 | on error. | |
2094 | ||
2095 | @prenotnull{array_field_type} | |
2096 | @preisarrayft{array_field_type} | |
2097 | @postrefcountsame{array_field_type} | |
2098 | */ | |
b92ddaaa | 2099 | extern int64_t bt_ctf_field_type_array_get_length( |
78c8ab4f | 2100 | struct bt_ctf_field_type *array_field_type); |
adc315b8 | 2101 | |
78c8ab4f | 2102 | /** @} */ |
adc315b8 | 2103 | |
78c8ab4f PP |
2104 | /** |
2105 | @defgroup ctfirseqfieldtype CTF IR sequence field type | |
2106 | @ingroup ctfirfieldtypes | |
2107 | @brief CTF IR sequence field type. | |
b92ddaaa | 2108 | |
78c8ab4f PP |
2109 | @code |
2110 | #include <babeltrace/ctf-ir/field-types.h> | |
2111 | @endcode | |
b92ddaaa | 2112 | |
78c8ab4f | 2113 | A CTF IR <strong><em>sequence field type</em></strong> is |
4089d5a6 | 2114 | a field type that you can use to create concrete @seqfields. |
adc315b8 | 2115 | |
78c8ab4f | 2116 | You can create a sequence field type with |
4089d5a6 | 2117 | bt_ctf_field_type_sequence_create(). This function needs the @ft |
78c8ab4f PP |
2118 | of the fields contained by the sequence fields described by the created |
2119 | sequence field type. This function also needs the length name of the | |
2120 | sequence field type to create. The length name is used to automatically | |
2121 | resolve the length's field type. See \ref ctfirfieldtypes to learn more | |
2122 | about the automatic resolving. | |
b92ddaaa | 2123 | |
78c8ab4f PP |
2124 | @sa ctfirseqfield |
2125 | @sa ctfirfieldtypes | |
adc315b8 | 2126 | |
78c8ab4f PP |
2127 | @addtogroup ctfirseqfieldtype |
2128 | @{ | |
2129 | */ | |
b92ddaaa | 2130 | |
78c8ab4f | 2131 | /** |
4089d5a6 PP |
2132 | @brief Creates a default @seqft with \p element_field_type as the |
2133 | @ft of the @fields contained in its described @seqfields | |
2134 | with the length name \p length_name. | |
78c8ab4f PP |
2135 | |
2136 | \p length_name can be an absolute or relative reference. See | |
2137 | <a href="http://diamon.org/ctf/">CTF</a> for more details. | |
2138 | ||
2139 | @param[in] element_field_type Field type of the fields contained in | |
2140 | the sequence fields described by the | |
2141 | created sequence field type. | |
2142 | @param[in] length_name Length name (copied on success). | |
2143 | @returns Created array field type, or | |
2144 | \c NULL on error. | |
2145 | ||
2146 | @prenotnull{element_field_type} | |
2147 | @prenotnull{length_name} | |
2148 | @postsuccessrefcountinc{element_field_type} | |
2149 | @postsuccessrefcountret1 | |
2150 | */ | |
2151 | extern struct bt_ctf_field_type *bt_ctf_field_type_sequence_create( | |
2152 | struct bt_ctf_field_type *element_field_type, | |
2153 | const char *length_name); | |
adc315b8 | 2154 | |
78c8ab4f | 2155 | /** |
4089d5a6 PP |
2156 | @brief Returns the @ft of the @fields contained in the @seqft |
2157 | described by the @seqft \p sequence_field_type. | |
78c8ab4f PP |
2158 | |
2159 | @param[in] sequence_field_type Sequence field type of which to get | |
2160 | the type of the fields contained in its | |
2161 | described sequence fields. | |
2162 | @returns Type of the fields contained in the | |
2163 | sequence fields described by | |
2164 | \p sequence_field_type, or \c NULL | |
2165 | on error. | |
2166 | ||
2167 | @prenotnull{sequence_field_type} | |
2168 | @preisseqft{sequence_field_type} | |
2169 | @postrefcountsame{sequence_field_type} | |
2170 | @postsuccessrefcountretinc | |
2171 | */ | |
2172 | extern struct bt_ctf_field_type *bt_ctf_field_type_sequence_get_element_type( | |
2173 | struct bt_ctf_field_type *sequence_field_type); | |
b92ddaaa | 2174 | |
78c8ab4f | 2175 | /** |
4089d5a6 | 2176 | @brief Returns the length name of the @seqft \p sequence_field_type. |
adc315b8 | 2177 | |
78c8ab4f PP |
2178 | On success, \p sequence_field_type remains the sole owner of |
2179 | the returned string. | |
b011f6b0 | 2180 | |
78c8ab4f PP |
2181 | @param[in] sequence_field_type Sequence field type of which to get the |
2182 | length name. | |
2183 | @returns Length name of \p sequence_field_type, | |
2184 | or \c NULL on error. | |
2185 | ||
2186 | @prenotnull{sequence_field_type} | |
2187 | @preisseqft{sequence_field_type} | |
2188 | ||
2189 | @sa bt_ctf_field_type_sequence_get_length_field_path(): Returns the | |
2190 | length's CTF IR field path of a given sequence field type. | |
2191 | */ | |
2192 | extern const char *bt_ctf_field_type_sequence_get_length_field_name( | |
2193 | struct bt_ctf_field_type *sequence_field_type); | |
2194 | ||
2195 | /** | |
4089d5a6 PP |
2196 | @brief Returns the length's CTF IR field path of the @seqft |
2197 | \p sequence_field_type. | |
78c8ab4f PP |
2198 | |
2199 | The length's field path of a sequence field type is set when automatic | |
2200 | resolving is performed (see \ref ctfirfieldtypes). | |
2201 | ||
2202 | @param[in] sequence_field_type Sequence field type of which to get the | |
2203 | length's field path. | |
2204 | @returns Length's field path of | |
2205 | \p sequence_field_type, or | |
2206 | \c NULL if the length's field path is | |
2207 | not set yet is not set or on error. | |
2208 | ||
2209 | @prenotnull{sequence_field_type} | |
2210 | @preisseqft{sequence_field_type} | |
2211 | @postsuccessrefcountretinc | |
2212 | ||
2213 | @sa bt_ctf_field_type_sequence_get_length_field_name(): Returns the | |
2214 | length's name of a given sequence field type. | |
2215 | */ | |
b011f6b0 | 2216 | extern struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path( |
78c8ab4f | 2217 | struct bt_ctf_field_type *sequence_field_type); |
b011f6b0 | 2218 | |
78c8ab4f | 2219 | /** @} */ |
265e809c | 2220 | |
78c8ab4f PP |
2221 | /** |
2222 | @defgroup ctfirvarfieldtype CTF IR variant field type | |
2223 | @ingroup ctfirfieldtypes | |
2224 | @brief CTF IR variant field type. | |
2225 | ||
2226 | @code | |
2227 | #include <babeltrace/ctf-ir/field-types.h> | |
2228 | @endcode | |
2229 | ||
2230 | A CTF IR <strong><em>variant field type</em></strong> is | |
4089d5a6 PP |
2231 | a field type that you can use to create concrete @varfields. |
2232 | ||
2233 | You can create a variant field type with | |
2234 | bt_ctf_field_type_variant_create(). This function expects you to pass | |
2235 | both the tag's @enumft and the tag name of the variant field type to | |
2236 | create. The tag's field type is optional, as the Babeltrace system can | |
2237 | automatically resolve it using the tag name. You can leave the tag name | |
2238 | to \c NULL initially, and set it later with | |
2239 | bt_ctf_field_type_variant_set_tag_name(). The tag name must be set when | |
2240 | the variant field type is frozen. See \ref ctfirfieldtypes to learn more | |
2241 | about the automatic resolving and the conditions under which a field | |
2242 | type can be frozen. | |
78c8ab4f PP |
2243 | |
2244 | You can add a field to a variant field type with | |
2245 | bt_ctf_field_type_variant_add_field(). All the field names of a | |
4089d5a6 | 2246 | variant field type \em must exist as mapping names in its tag's @enumft. |
78c8ab4f | 2247 | |
4089d5a6 | 2248 | The effective alignment of the @varfields described by a |
78c8ab4f | 2249 | variant field type is always 1, but the individual fields of a |
4089d5a6 | 2250 | @varfield can have custom alignments. |
78c8ab4f PP |
2251 | |
2252 | You can set the byte order of <em>all the contained fields</em>, | |
2253 | recursively, of a variant field type with the common | |
2254 | bt_ctf_field_type_set_byte_order() function. | |
2255 | ||
2256 | @sa ctfirvarfield | |
2257 | @sa ctfirfieldtypes | |
2258 | ||
2259 | @addtogroup ctfirvarfieldtype | |
2260 | @{ | |
2261 | */ | |
06629ab3 | 2262 | |
78c8ab4f | 2263 | /** |
4089d5a6 | 2264 | @brief Creates a default, empty @varft with the tag's @enumft |
78c8ab4f PP |
2265 | \p tag_field_type and the tag name \p tag_name. |
2266 | ||
2267 | \p tag_field_type can be \c NULL; the tag's field type can be | |
2268 | automatically resolved from the variant field type's tag name (see | |
2269 | \ref ctfirfieldtypes). If \p tag_name is \c NULL, it \em must be set | |
2270 | with bt_ctf_field_type_variant_set_tag_name() \em before the variant | |
2271 | field type is frozen. | |
2272 | ||
2273 | \p tag_name can be an absolute or relative reference. See | |
2274 | <a href="http://diamon.org/ctf/">CTF</a> for more details. | |
2275 | ||
2276 | @param[in] tag_field_type Tag's enumeration field type | |
2277 | (can be \c NULL). | |
2278 | @param[in] tag_name Tag name (copied on success, | |
2279 | can be \c NULL). | |
2280 | @returns Created variant field type, or | |
2281 | \c NULL on error. | |
2282 | ||
2283 | @pre \p tag_field_type is an enumeration field type or \c NULL. | |
2284 | @post <strong>On success, if \p tag_field_type is not \c NULL</strong>, | |
2285 | its reference count is incremented. | |
2286 | @postsuccessrefcountret1 | |
2287 | */ | |
2288 | extern struct bt_ctf_field_type *bt_ctf_field_type_variant_create( | |
2289 | struct bt_ctf_field_type *tag_field_type, | |
2290 | const char *tag_name); | |
b92ddaaa | 2291 | |
78c8ab4f | 2292 | /** |
4089d5a6 | 2293 | @brief Returns the tag's @enumft of the @varft \p variant_field_type. |
78c8ab4f PP |
2294 | |
2295 | @param[in] variant_field_type Variant field type of which to get | |
2296 | the tag's enumeration field type. | |
2297 | @returns Tag's enumeration field type of | |
2298 | \p variant_field_type, or \c NULL if the | |
2299 | tag's field type is not set or on | |
2300 | error. | |
2301 | ||
2302 | @prenotnull{variant_field_type} | |
2303 | @preisvarft{variant_field_type} | |
2304 | @postrefcountsame{variant_field_type} | |
2305 | @postsuccessrefcountretinc | |
2306 | */ | |
2307 | extern struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type( | |
2308 | struct bt_ctf_field_type *variant_field_type); | |
56db8d7a | 2309 | |
78c8ab4f | 2310 | /** |
4089d5a6 | 2311 | @brief Returns the tag name of the @varft \p variant_field_type. |
78c8ab4f PP |
2312 | |
2313 | On success, \p variant_field_type remains the sole owner of | |
2314 | the returned string. | |
2315 | ||
2316 | @param[in] variant_field_type Variant field type of which to get the | |
2317 | tag name. | |
2318 | @returns Tag name of \p variant_field_type, or | |
2319 | \c NULL if the tag name is not set or | |
2320 | on error. | |
2321 | ||
2322 | @prenotnull{variant_field_type} | |
2323 | @preisvarft{variant_field_type} | |
2324 | ||
2325 | @sa bt_ctf_field_type_variant_set_tag_name(): Sets the tag name of | |
2326 | a given variant field type. | |
2327 | @sa bt_ctf_field_type_variant_get_tag_field_path(): Returns the tag's | |
2328 | CTF IR field path of a given variant field type. | |
2329 | */ | |
2330 | extern const char *bt_ctf_field_type_variant_get_tag_name( | |
2331 | struct bt_ctf_field_type *variant_field_type); | |
56db8d7a | 2332 | |
78c8ab4f | 2333 | /** |
4089d5a6 | 2334 | @brief Sets the tag name of the @varft \p variant_field_type. |
78c8ab4f PP |
2335 | |
2336 | \p tag_name can be an absolute or relative reference. See | |
2337 | <a href="http://diamon.org/ctf/">CTF</a> for more details. | |
2338 | ||
2339 | @param[in] variant_field_type Variant field type of which to set | |
2340 | the tag name. | |
2341 | @param[in] tag_name Tag name of \p variant_field_type | |
2342 | (copied on success). | |
2343 | @returns 0 on success, or a negative value on error. | |
2344 | ||
2345 | @prenotnull{variant_field_type} | |
2346 | @prenotnull{name} | |
2347 | @prehot{variant_field_type} | |
2348 | @postrefcountsame{variant_field_type} | |
2349 | ||
2350 | @sa bt_ctf_field_type_variant_get_tag_name(): Returns the tag name of | |
2351 | a given variant field type. | |
2352 | */ | |
2353 | extern int bt_ctf_field_type_variant_set_tag_name( | |
2354 | struct bt_ctf_field_type *variant_field_type, | |
2355 | const char *tag_name); | |
56db8d7a | 2356 | |
78c8ab4f | 2357 | /** |
4089d5a6 PP |
2358 | @brief Returns the tag's CTF IR field path of the @varft |
2359 | \p variant_field_type. | |
78c8ab4f PP |
2360 | |
2361 | The tag's field path of a variant field type is set when automatic | |
2362 | resolving is performed (see \ref ctfirfieldtypes). | |
2363 | ||
2364 | @param[in] variant_field_type Variant field type of which to get the | |
2365 | tag's field path. | |
2366 | @returns Tag's field path of | |
2367 | \p variant_field_type, or | |
2368 | \c NULL if the tag's field path is not | |
2369 | set yet is not set or on error. | |
2370 | ||
2371 | @prenotnull{variant_field_type} | |
2372 | @preisvarft{variant_field_type} | |
2373 | @postsuccessrefcountretinc | |
2374 | ||
2375 | @sa bt_ctf_field_type_variant_get_tag_name(): Returns the tag's | |
2376 | name of a given variant field type. | |
2377 | */ | |
2378 | extern struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path( | |
2379 | struct bt_ctf_field_type *variant_field_type); | |
56db8d7a | 2380 | |
78c8ab4f | 2381 | /** |
4089d5a6 PP |
2382 | @brief Returns the number of fields (choices) contained in the @varft |
2383 | \p variant_field_type. | |
78c8ab4f PP |
2384 | |
2385 | @param[in] variant_field_type Variant field type of which to get | |
2386 | the number of contained fields. | |
2387 | @returns Number of fields contained in | |
2388 | \p variant_field_type, or a negative | |
2389 | value on error. | |
2390 | ||
2391 | @prenotnull{variant_field_type} | |
2392 | @preisvarft{variant_field_type} | |
2393 | @postrefcountsame{variant_field_type} | |
2394 | */ | |
2395 | extern int bt_ctf_field_type_variant_get_field_count( | |
2396 | struct bt_ctf_field_type *variant_field_type); | |
56db8d7a | 2397 | |
78c8ab4f | 2398 | /** |
4089d5a6 PP |
2399 | @brief Returns the field (choice) of the @varft \p variant_field_type |
2400 | at index \p index. | |
78c8ab4f PP |
2401 | |
2402 | On success, the field's type is placed in \p *field_type if | |
2403 | \p field_type is not \c NULL. The field's name is placed in | |
2404 | \p *field_name if \p field_name is not \c NULL. | |
2405 | \p variant_field_type remains the sole owner of \p *field_name. | |
2406 | ||
2407 | @param[in] variant_field_type Variant field type of which to get | |
2408 | the field at index \p index. | |
2409 | @param[out] field_name Returned name of the field at index | |
2410 | \p index (can be \c NULL). | |
2411 | @param[out] field_type Returned field type of the field | |
2412 | at index \p index (can be \c NULL). | |
2413 | @param[in] index Index of the field to get from | |
2414 | \p variant_field_type. | |
2415 | @returns 0 on success, or a negative value on error. | |
2416 | ||
2417 | @prenotnull{variant_field_type} | |
2418 | @preisvarft{variant_field_type} | |
2419 | @pre \p index is lesser than the number of fields contained in the | |
2420 | variant field type \p variant_field_type (see | |
2421 | bt_ctf_field_type_variant_get_field_count()). | |
2422 | @postrefcountsame{variant_field_type} | |
2423 | @post <strong>On success</strong>, the returned field's type is placed | |
2424 | in \p *field_type and its reference count is incremented. | |
2425 | ||
2426 | @sa bt_ctf_field_type_variant_get_field_type_by_name(): Finds a variant | |
2427 | field type's field by name. | |
2428 | @sa bt_ctf_field_type_variant_get_field_type_from_tag(): Finds a variant | |
2429 | field type's field by current tag value. | |
2430 | */ | |
2431 | extern int bt_ctf_field_type_variant_get_field( | |
2432 | struct bt_ctf_field_type *variant_field_type, | |
2433 | const char **field_name, | |
2434 | struct bt_ctf_field_type **field_type, int index); | |
56db8d7a | 2435 | |
78c8ab4f PP |
2436 | /** |
2437 | @brief Returns the type of the field (choice) named \p field_name | |
4089d5a6 | 2438 | found in the @varft \p variant_field_type. |
78c8ab4f PP |
2439 | |
2440 | @param[in] variant_field_type Variant field type of which to get | |
2441 | a field's type. | |
2442 | @param[in] field_name Name of the field to find. | |
2443 | @returns Type of the field named \p field_name in | |
2444 | \p variant_field_type, or | |
2445 | \c NULL on error. | |
2446 | ||
2447 | @prenotnull{variant_field_type} | |
2448 | @prenotnull{field_name} | |
2449 | @preisvarft{variant_field_type} | |
2450 | @postrefcountsame{variant_field_type} | |
2451 | @postsuccessrefcountretinc | |
2452 | ||
2453 | @sa bt_ctf_field_type_variant_get_field(): Finds a variant field type's | |
2454 | field by index. | |
2455 | @sa bt_ctf_field_type_variant_get_field_type_from_tag(): Finds a variant | |
2456 | field type's field by current tag value. | |
2457 | */ | |
2458 | extern | |
2459 | struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_by_name( | |
2460 | struct bt_ctf_field_type *variant_field_type, | |
2461 | const char *field_name); | |
56db8d7a | 2462 | |
78c8ab4f PP |
2463 | /** |
2464 | @brief Returns the type of the field (choice) selected by the value of | |
4089d5a6 | 2465 | the @enumfield \p tag_field in the @varft \p variant_field_type. |
78c8ab4f PP |
2466 | |
2467 | \p tag_field is the current tag value. | |
2468 | ||
2469 | The field type of \p tag_field, as returned by bt_ctf_field_get_type(), | |
2470 | \em must be equivalent to the field type returned by | |
2471 | bt_ctf_field_type_variant_get_tag_type() for \p variant_field_type. | |
2472 | ||
2473 | @param[in] variant_field_type Variant field type of which to get | |
2474 | a field's type. | |
2475 | @param[in] tag_field Current tag value (variant field type's | |
2476 | selector). | |
2477 | @returns Type of the field selected by | |
2478 | \p tag_field in \p variant_field_type, | |
2479 | or \c NULL on error. | |
2480 | ||
2481 | @prenotnull{variant_field_type} | |
2482 | @prenotnull{tag_field} | |
2483 | @preisvarft{variant_field_type} | |
2484 | @preisenumfield{tag_field} | |
2485 | @postrefcountsame{variant_field_type} | |
2486 | @postrefcountsame{tag_field} | |
2487 | @postsuccessrefcountretinc | |
2488 | ||
2489 | @sa bt_ctf_field_type_variant_get_field(): Finds a variant field type's | |
2490 | field by index. | |
2491 | @sa bt_ctf_field_type_variant_get_field_type_by_name(): Finds a variant | |
2492 | field type's field by name. | |
2493 | */ | |
2494 | extern | |
2495 | struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_from_tag( | |
2496 | struct bt_ctf_field_type *variant_field_type, | |
2497 | struct bt_ctf_field *tag_field); | |
2498 | ||
2499 | /** | |
4089d5a6 PP |
2500 | @brief Adds a field (a choice) named \p field_name with the @ft |
2501 | \p field_type to the @varft \p variant_field_type. | |
78c8ab4f PP |
2502 | |
2503 | On success, \p field_type becomes the child of \p variant_field_type. | |
2504 | ||
2505 | You \em cannot add a field named \p field_name if there's already a | |
2506 | field named \p field_name in \p variant_field_type. | |
2507 | ||
2508 | \p field_name \em must name an existing mapping in the tag's | |
2509 | enumeration field type of \p variant_field_type. | |
2510 | ||
2511 | @param[in] variant_field_type Variant field type to which to add | |
2512 | a new field. | |
2513 | @param[in] field_type Field type of the field to add to | |
2514 | \p variant_field_type. | |
2515 | @param[in] field_name Name of the field to add to | |
2516 | \p variant_field_type | |
2517 | (copied on success). | |
2518 | @returns 0 on success, or a negative value on error. | |
2519 | ||
2520 | @prenotnull{variant_field_type} | |
2521 | @prenotnull{field_type} | |
2522 | @prenotnull{field_name} | |
2523 | @preisvarft{variant_field_type} | |
2524 | @pre \p field_type is not and does not contain \p variant_field_type, | |
2525 | recursively, as a field's type. | |
2526 | @prehot{variant_field_type} | |
2527 | @postrefcountsame{variant_field_type} | |
2528 | @postsuccessrefcountinc{field_type} | |
2529 | */ | |
2530 | extern int bt_ctf_field_type_variant_add_field( | |
2531 | struct bt_ctf_field_type *variant_field_type, | |
2532 | struct bt_ctf_field_type *field_type, | |
2533 | const char *field_name); | |
2534 | ||
2535 | /** @} */ | |
56db8d7a | 2536 | |
adc315b8 JG |
2537 | #ifdef __cplusplus |
2538 | } | |
2539 | #endif | |
2540 | ||
2e33ac5a | 2541 | #endif /* BABELTRACE_CTF_IR_FIELD_TYPES_H */ |