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