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

   1 #ifndef BABELTRACE2_TRACE_IR_TRACE_CONST_H
   2 #define BABELTRACE2_TRACE_IR_TRACE_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_destruction_listener_func)(
  39                 const bt_trace *trace, void *data);
  40
  41 extern const bt_value *bt_trace_borrow_user_attributes_const(
  42                 const bt_trace *trace);
  43
  44 extern const bt_trace_class *bt_trace_borrow_class_const(
  45                 const bt_trace *trace);
  46
  47 extern const char *bt_trace_get_name(const bt_trace *trace);
  48
  49 extern bt_uuid bt_trace_get_uuid(const bt_trace *trace);
  50
  51 extern uint64_t bt_trace_get_environment_entry_count(const bt_trace *trace);
  52
  53 extern void bt_trace_borrow_environment_entry_by_index_const(
  54                 const bt_trace *trace, uint64_t index,
  55                 const char **name, const bt_value **value);
  56
  57 extern const bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
  58                 const bt_trace *trace, const char *name);
  59
  60 extern uint64_t bt_trace_get_stream_count(const bt_trace *trace);
  61
  62 extern const bt_stream *bt_trace_borrow_stream_by_index_const(
  63                 const bt_trace *trace, uint64_t index);
  64
  65 extern const bt_stream *bt_trace_borrow_stream_by_id_const(
  66                 const bt_trace *trace, uint64_t id);
  67
  68 typedef enum bt_trace_add_listener_status {
  69         BT_TRACE_ADD_LISTENER_STATUS_MEMORY_ERROR       = __BT_FUNC_STATUS_MEMORY_ERROR,
  70         BT_TRACE_ADD_LISTENER_STATUS_OK                 = __BT_FUNC_STATUS_OK,
  71 } bt_trace_add_listener_status;
  72
  73 extern bt_trace_add_listener_status bt_trace_add_destruction_listener(
  74                 const bt_trace *trace,
  75                 bt_trace_destruction_listener_func listener,
  76                 void *data, bt_listener_id *listener_id);
  77
  78 typedef enum bt_trace_remove_listener_status {
  79         BT_TRACE_REMOVE_LISTENER_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
  80         BT_TRACE_REMOVE_LISTENER_STATUS_OK              = __BT_FUNC_STATUS_OK,
  81 } bt_trace_remove_listener_status;
  82
  83 extern bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
  84                 const bt_trace *trace, bt_listener_id listener_id);
  85
  86 extern void bt_trace_get_ref(const bt_trace *trace);
  87
  88 extern void bt_trace_put_ref(const bt_trace *trace);
  89
  90 #define BT_TRACE_PUT_REF_AND_RESET(_var)                \
  91         do {                                            \
  92                 bt_trace_put_ref(_var);                 \
  93                 (_var) = NULL;                          \
  94         } while (0)
  95
  96 #define BT_TRACE_MOVE_REF(_var_dst, _var_src)           \
  97         do {                                            \
  98                 bt_trace_put_ref(_var_dst);             \
  99                 (_var_dst) = (_var_src);                \
 100                 (_var_src) = NULL;                      \
 101         } while (0)
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* BABELTRACE2_TRACE_IR_TRACE_CONST_H */