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