include/babeltrace/ctf-ir/field-path.h

   1 #ifndef BABELTRACE_CTF_IR_FIELD_PATH_H
   2 #define BABELTRACE_CTF_IR_FIELD_PATH_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Field path
   6  *
   7  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * The Common Trace Format (CTF) Specification is available at
  28  * http://www.efficios.com/ctf
  29  */
  30
  31 #include <stdint.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bt_field_path;
  38
  39 enum bt_scope {
  40         BT_SCOPE_PACKET_HEADER,
  41         BT_SCOPE_PACKET_CONTEXT,
  42         BT_SCOPE_EVENT_HEADER,
  43         BT_SCOPE_EVENT_COMMON_CONTEXT,
  44         BT_SCOPE_EVENT_SPECIFIC_CONTEXT,
  45         BT_SCOPE_EVENT_PAYLOAD,
  46 };
  47
  48 extern enum bt_scope bt_field_path_get_root_scope(
  49                 struct bt_field_path *field_path);
  50
  51 extern uint64_t bt_field_path_get_index_count(
  52                 struct bt_field_path *field_path);
  53
  54 extern uint64_t bt_field_path_get_index_by_index(
  55                 struct bt_field_path *field_path, uint64_t index);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif /* BABELTRACE_CTF_IR_FIELD_PATH_H */