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

   1 #ifndef BABELTRACE2_TRACE_IR_TRACE_CLASS_CONST_H
   2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 #include <stdint.h>
  35
  36 /*
  37  * For bt_bool, bt_uuid, bt_trace_class, bt_stream_class,
  38  * bt_field_class, bt_value
  39  */
  40 #include <babeltrace2/types.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 typedef void (* bt_trace_class_destruction_listener_func)(
  47                 const bt_trace_class *trace_class, void *data);
  48
  49 extern bt_bool bt_trace_class_assigns_automatic_stream_class_id(
  50                 const bt_trace_class *trace_class);
  51
  52 extern uint64_t bt_trace_class_get_stream_class_count(
  53                 const bt_trace_class *trace_class);
  54
  55 extern const bt_stream_class *
  56 bt_trace_class_borrow_stream_class_by_index_const(
  57                 const bt_trace_class *trace_class, uint64_t index);
  58
  59 extern const bt_stream_class *bt_trace_class_borrow_stream_class_by_id_const(
  60                 const bt_trace_class *trace_class, uint64_t id);
  61
  62 typedef enum bt_trace_class_add_listener_status {
  63         BT_TRACE_CLASS_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
  64         BT_TRACE_CLASS_ADD_LISTENER_STATUS_OK           = __BT_FUNC_STATUS_OK,
  65 } bt_trace_class_add_listener_status;
  66
  67 extern bt_trace_class_add_listener_status
  68 bt_trace_class_add_destruction_listener(
  69         const bt_trace_class *trace_class,
  70         bt_trace_class_destruction_listener_func listener,
  71         void *data, uint64_t *listener_id);
  72
  73 typedef enum bt_trace_class_remove_listener_status {
  74         BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  75         BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_OK                = __BT_FUNC_STATUS_OK,
  76 } bt_trace_class_remove_listener_status;
  77
  78 extern bt_trace_class_remove_listener_status
  79 bt_trace_class_remove_destruction_listener(
  80         const bt_trace_class *trace_class, uint64_t listener_id);
  81
  82 extern void bt_trace_class_get_ref(const bt_trace_class *trace_class);
  83
  84 extern void bt_trace_class_put_ref(const bt_trace_class *trace_class);
  85
  86 #define BT_TRACE_CLASS_PUT_REF_AND_RESET(_var)          \
  87         do {                                            \
  88                 bt_trace_class_put_ref(_var);           \
  89                 (_var) = NULL;                          \
  90         } while (0)
  91
  92 #define BT_TRACE_CLASS_MOVE_REF(_var_dst, _var_src)     \
  93         do {                                            \
  94                 bt_trace_class_put_ref(_var_dst);       \
  95                 (_var_dst) = (_var_src);                \
  96                 (_var_src) = NULL;                      \
  97         } while (0)
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103 #endif /* BABELTRACE2_TRACE_IR_TRACE_CLASS_CONST_H */