Babeltrace 2 C API  2.1.1
Open-source trace manipulation framework
field-path.h
1 /*
2  * SPDX-License-Identifier: MIT
3  *
4  * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
5  */
6 
7 #ifndef BABELTRACE2_TRACE_IR_FIELD_PATH_H
8 #define BABELTRACE2_TRACE_IR_FIELD_PATH_H
9 
10 /* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
11 
12 #ifndef __BT_IN_BABELTRACE_H
13 # error "Please include <babeltrace2/babeltrace.h> instead."
14 #endif
15 
16 #include <stdint.h>
17 
18 #include <babeltrace2/types.h>
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
199 typedef enum bt_field_path_scope {
205 
211 
217 
224 
240  const bt_field_path *field_path) __BT_NOEXCEPT;
241 
257 extern uint64_t bt_field_path_get_item_count(
258  const bt_field_path *field_path) __BT_NOEXCEPT;
259 
290  const bt_field_path *field_path, uint64_t index) __BT_NOEXCEPT;
291 
307 extern void bt_field_path_get_ref(const bt_field_path *field_path)
308  __BT_NOEXCEPT;
309 
325 extern void bt_field_path_put_ref(const bt_field_path *field_path)
326  __BT_NOEXCEPT;
327 
342 #define BT_FIELD_PATH_PUT_REF_AND_RESET(_field_path) \
343  do { \
344  bt_field_path_put_ref(_field_path); \
345  (_field_path) = NULL; \
346  } while (0)
347 
373 #define BT_FIELD_PATH_MOVE_REF(_dst, _src) \
374  do { \
375  bt_field_path_put_ref(_dst); \
376  (_dst) = (_src); \
377  (_src) = NULL; \
378  } while (0)
379 
404 
410 
417 
434  const bt_field_path_item *item) __BT_NOEXCEPT;
435 
455 extern uint64_t bt_field_path_item_index_get_index(
456  const bt_field_path_item *item) __BT_NOEXCEPT;
457 
462 #ifdef __cplusplus
463 }
464 #endif
465 
466 #endif /* BABELTRACE2_TRACE_IR_FIELD_PATH_H */
bt_field_path_scope
Field path scopes.
Definition: field-path.h:199
struct bt_field_path_item bt_field_path_item
Field path item.
Definition: types.h:50
struct bt_field_path bt_field_path
Field path.
Definition: types.h:49
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:210
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:415
bt_field_path_item_type
Field path item type enumerators.
Definition: field-path.h:397
Event specific context.
Definition: field-path.h:216
Packet context.
Definition: field-path.h:204
Common field of an array field.
Definition: field-path.h:409
Index of a structure field member or the field of a selected variant field option.
Definition: field-path.h:403
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:222
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.