include/babeltrace/trace-ir/trace-class-const.h

   1 #ifndef BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H
   2 #define BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  * The Common Trace Format (CTF) Specification is available at
  27  * http://www.efficios.com/ctf
  28  */
  29
  30 /*
  31  * For bt_bool, bt_uuid, bt_trace_class, bt_stream_class,
  32  * bt_field_class, bt_value
  33  */
  34 #include <babeltrace/types.h>
  35
  36 #include <stdint.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 extern bt_bool bt_trace_class_assigns_automatic_stream_class_id(
  43                 const bt_trace_class *trace_class);
  44
  45 extern const char *bt_trace_class_get_name(
  46                 const bt_trace_class *trace_class);
  47
  48 extern bt_uuid bt_trace_class_get_uuid(
  49                 const bt_trace_class *trace_class);
  50
  51 extern uint64_t bt_trace_class_get_environment_entry_count(
  52                 const bt_trace_class *trace_class);
  53
  54 extern void bt_trace_class_borrow_environment_entry_by_index_const(
  55                 const bt_trace_class *trace_class, uint64_t index,
  56                 const char **name, const bt_value **value);
  57
  58 extern const bt_value *
  59 bt_trace_class_borrow_environment_entry_value_by_name_const(
  60                 const bt_trace_class *trace_class, const char *name);
  61
  62 extern const bt_field_class *
  63 bt_trace_class_borrow_packet_header_field_class_const(
  64                 const bt_trace_class *trace_class);
  65
  66 extern uint64_t bt_trace_class_get_stream_class_count(
  67                 const bt_trace_class *trace_class);
  68
  69 extern const bt_stream_class *
  70 bt_trace_class_borrow_stream_class_by_index_const(
  71                 const bt_trace_class *trace_class, uint64_t index);
  72
  73 extern const bt_stream_class *bt_trace_class_borrow_stream_class_by_id_const(
  74                 const bt_trace_class *trace_class, uint64_t id);
  75
  76 extern void bt_trace_class_get_ref(const bt_trace_class *trace_class);
  77
  78 extern void bt_trace_class_put_ref(const bt_trace_class *trace_class);
  79
  80 #define BT_TRACE_CLASS_PUT_REF_AND_RESET(_var)          \
  81         do {                                            \
  82                 bt_trace_class_put_ref(_var);           \
  83                 (_var) = NULL;                          \
  84         } while (0)
  85
  86 #define BT_TRACE_CLASS_MOVE_REF(_var_dst, _var_src)     \
  87         do {                                            \
  88                 bt_trace_class_put_ref(_var_dst);       \
  89                 (_var_dst) = (_var_src);                \
  90                 (_var_src) = NULL;                      \
  91         } while (0)
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97 #endif /* BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H */