Babeltrace 2 C API  2.0.3
Open-source trace manipulation framework
 All Functions Variables Typedefs Enumerations Enumerator Modules Pages
field-path.h
1 #ifndef BABELTRACE2_TRACE_IR_FIELD_PATH_H
2 #define BABELTRACE2_TRACE_IR_FIELD_PATH_H
3 
4 /*
5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
9  * in the Software without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11  * copies of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  */
25 
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
28 #endif
29 
30 #include <stdint.h>
31 
32 #include <babeltrace2/types.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
206 typedef enum bt_field_path_scope {
212 
218 
224 
231 
247  const bt_field_path *field_path);
248 
264 extern uint64_t bt_field_path_get_item_count(
265  const bt_field_path *field_path);
266 
297  const bt_field_path *field_path, uint64_t index);
298 
314 extern void bt_field_path_get_ref(const bt_field_path *field_path);
315 
331 extern void bt_field_path_put_ref(const bt_field_path *field_path);
332 
347 #define BT_FIELD_PATH_PUT_REF_AND_RESET(_field_path) \
348  do { \
349  bt_field_path_put_ref(_field_path); \
350  (_field_path) = NULL; \
351  } while (0)
352 
378 #define BT_FIELD_PATH_MOVE_REF(_dst, _src) \
379  do { \
380  bt_field_path_put_ref(_dst); \
381  (_dst) = (_src); \
382  (_src) = NULL; \
383  } while (0)
384 
409 
415 
422 
439  const bt_field_path_item *item);
440 
460 extern uint64_t bt_field_path_item_index_get_index(
461  const bt_field_path_item *item);
462 
467 #ifdef __cplusplus
468 }
469 #endif
470 
471 #endif /* BABELTRACE2_TRACE_IR_FIELD_PATH_H */
bt_field_path_scope
Field path scopes.
Definition: field-path.h:206
struct bt_field_path_item bt_field_path_item
Field path item.
Definition: types.h:63
struct bt_field_path bt_field_path
Field path.
Definition: types.h:62
bt_field_path_item_type bt_field_path_item_get_type(const bt_field_path_item *item)
Returns the type enumerator of the field path item item.
Event common context.
Definition: field-path.h:217
void bt_field_path_get_ref(const bt_field_path *field_path)
Increments the reference count of the field path field_path.
Current field of an option field.
Definition: field-path.h:420
bt_field_path_item_type
Field path item type enumerators.
Definition: field-path.h:402
Event specific context.
Definition: field-path.h:223
Packet context.
Definition: field-path.h:211
Common field of an array field.
Definition: field-path.h:414
Index of a structure field member or selected variant field option's field.
Definition: field-path.h:408
const bt_field_path_item * bt_field_path_borrow_item_by_index_const(const bt_field_path *field_path, uint64_t index)
Borrows the item at index index from the field path field_path.
uint64_t bt_field_path_item_index_get_index(const bt_field_path_item *item)
Returns the index value of the index field path item item.
bt_field_path_scope bt_field_path_get_root_scope(const bt_field_path *field_path)
Returns the root scope of the field path field_path.
Event payload.
Definition: field-path.h:229
uint64_t bt_field_path_get_item_count(const bt_field_path *field_path)
Returns the number of items contained in the field path field_path.
void bt_field_path_put_ref(const bt_field_path *field_path)
Decrements the reference count of the field path field_path.