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

   1 #ifndef BABELTRACE_TRACE_IR_FIELD_PATH_CONST_H
   2 #define BABELTRACE_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 #include <stdint.h>
  30
  31 /* For bt_field_path */
  32 #include <babeltrace/types.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 typedef enum bt_scope {
  39         BT_SCOPE_PACKET_HEADER,
  40         BT_SCOPE_PACKET_CONTEXT,
  41         BT_SCOPE_EVENT_HEADER,
  42         BT_SCOPE_EVENT_COMMON_CONTEXT,
  43         BT_SCOPE_EVENT_SPECIFIC_CONTEXT,
  44         BT_SCOPE_EVENT_PAYLOAD,
  45 } bt_scope;
  46
  47 extern bt_scope bt_field_path_get_root_scope(
  48                 const bt_field_path *field_path);
  49
  50 extern uint64_t bt_field_path_get_index_count(
  51                 const bt_field_path *field_path);
  52
  53 extern uint64_t bt_field_path_get_index_by_index(
  54                 const bt_field_path *field_path, uint64_t index);
  55
  56 extern void bt_field_path_get_ref(const bt_field_path *field_path);
  57
  58 extern void bt_field_path_put_ref(const bt_field_path *field_path);
  59
  60 #define BT_FIELD_PATH_PUT_REF_AND_RESET(_var)           \
  61         do {                                            \
  62                 bt_field_path_put_ref(_var);            \
  63                 (_var) = NULL;                          \
  64         } while (0)
  65
  66 #define BT_FIELD_PATH_MOVE_REF(_var_dst, _var_src)      \
  67         do {                                            \
  68                 bt_field_path_put_ref(_var_dst);        \
  69                 (_var_dst) = (_var_src);                \
  70                 (_var_src) = NULL;                      \
  71         } while (0)
  72
  73 #ifdef __cplusplus
  74 }
  75 #endif
  76
  77 #endif /* BABELTRACE_TRACE_IR_FIELD_PATH_CONST_H */