include/babeltrace2/trace-ir/field-path-const.h

   1 #ifndef BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H
   2 #define BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H
   3
   4 /*
   5  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   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  * The Common Trace Format (CTF) Specification is available at
  26  * http://www.efficios.com/ctf
  27  */
  28
  29 #ifndef __BT_IN_BABELTRACE_H
  30 # error "Please include <babeltrace2/babeltrace.h> instead."
  31 #endif
  32
  33 #include <stdint.h>
  34
  35 /* For bt_field_path, bt_field_path_item */
  36 #include <babeltrace2/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 typedef enum bt_field_path_item_type {
  43         BT_FIELD_PATH_ITEM_TYPE_INDEX,
  44         BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT,
  45 } bt_field_path_item_type;
  46
  47 typedef enum bt_scope {
  48         BT_SCOPE_PACKET_CONTEXT,
  49         BT_SCOPE_EVENT_COMMON_CONTEXT,
  50         BT_SCOPE_EVENT_SPECIFIC_CONTEXT,
  51         BT_SCOPE_EVENT_PAYLOAD,
  52 } bt_scope;
  53
  54 extern bt_scope bt_field_path_get_root_scope(
  55                 const bt_field_path *field_path);
  56
  57 extern uint64_t bt_field_path_get_item_count(
  58                 const bt_field_path *field_path);
  59
  60 extern const bt_field_path_item *bt_field_path_borrow_item_by_index_const(
  61                 const bt_field_path *field_path, uint64_t index);
  62
  63 extern bt_field_path_item_type bt_field_path_item_get_type(
  64                 const bt_field_path_item *field_path_item);
  65
  66 extern uint64_t bt_field_path_item_index_get_index(
  67                 const bt_field_path_item *field_path_item);
  68
  69 extern void bt_field_path_get_ref(const bt_field_path *field_path);
  70
  71 extern void bt_field_path_put_ref(const bt_field_path *field_path);
  72
  73 #define BT_FIELD_PATH_PUT_REF_AND_RESET(_var)           \
  74         do {                                            \
  75                 bt_field_path_put_ref(_var);            \
  76                 (_var) = NULL;                          \
  77         } while (0)
  78
  79 #define BT_FIELD_PATH_MOVE_REF(_var_dst, _var_src)      \
  80         do {                                            \
  81                 bt_field_path_put_ref(_var_dst);        \
  82                 (_var_dst) = (_var_src);                \
  83                 (_var_src) = NULL;                      \
  84         } while (0)
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 #endif /* BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H */