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

   1 #ifndef BABELTRACE_TRACE_IR_STREAM_CONST_H
   2 #define BABELTRACE_TRACE_IR_STREAM_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 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 /* For bt_trace, bt_stream, bt_stream_class */
  31 #include <babeltrace2/types.h>
  32
  33 #include <stdint.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 typedef enum bt_stream_status {
  40         BT_STREAM_STATUS_OK = 0,
  41         BT_STREAM_STATUS_NOMEM = -12,
  42 } bt_stream_status;
  43
  44 extern const bt_stream_class *bt_stream_borrow_class_const(
  45                 const bt_stream *stream);
  46
  47 extern const bt_trace *bt_stream_borrow_trace_const(
  48                 const bt_stream *stream);
  49
  50 extern const char *bt_stream_get_name(const bt_stream *stream);
  51
  52 extern uint64_t bt_stream_get_id(const bt_stream *stream);
  53
  54 extern void bt_stream_get_ref(const bt_stream *stream);
  55
  56 extern void bt_stream_put_ref(const bt_stream *stream);
  57
  58 #define BT_STREAM_PUT_REF_AND_RESET(_var)               \
  59         do {                                            \
  60                 bt_stream_put_ref(_var);                \
  61                 (_var) = NULL;                          \
  62         } while (0)
  63
  64 #define BT_STREAM_MOVE_REF(_var_dst, _var_src)          \
  65         do {                                            \
  66                 bt_stream_put_ref(_var_dst);            \
  67                 (_var_dst) = (_var_src);                \
  68                 (_var_src) = NULL;                      \
  69         } while (0)
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif /* BABELTRACE_TRACE_IR_STREAM_CONST_H */