include/babeltrace/trace-ir/stream-class-const.h

   1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
   2 #define BABELTRACE_TRACE_IR_STREAM_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 #include <stdint.h>
  31
  32 /*
  33  * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
  34  * bt_stream_class
  35  */
  36 #include <babeltrace/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 typedef enum bt_stream_class_status {
  43         BT_STREAM_CLASS_STATUS_OK = 0,
  44         BT_STREAM_CLASS_STATUS_NOMEM = -12,
  45 } bt_stream_class_status;
  46
  47 extern const bt_trace_class *bt_stream_class_borrow_trace_class_const(
  48                 const bt_stream_class *stream_class);
  49
  50 extern const char *bt_stream_class_get_name(
  51                 const bt_stream_class *stream_class);
  52
  53 extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
  54                 const bt_stream_class *stream_class);
  55
  56 extern bt_bool bt_stream_class_assigns_automatic_stream_id(
  57                 const bt_stream_class *stream_class);
  58
  59 extern bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot(
  60                 const bt_stream_class *stream_class);
  61
  62 extern bt_bool bt_stream_class_packets_have_end_default_clock_snapshot(
  63                 const bt_stream_class *stream_class);
  64
  65 extern bt_bool bt_stream_class_supports_discarded_events(
  66                 const bt_stream_class *stream_class);
  67
  68 extern bt_bool bt_stream_class_supports_discarded_packets(
  69                 const bt_stream_class *stream_class);
  70
  71 extern bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots(
  72                 const bt_stream_class *stream_class);
  73
  74 extern bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots(
  75                 const bt_stream_class *stream_class);
  76
  77 extern uint64_t bt_stream_class_get_id(
  78                 const bt_stream_class *stream_class);
  79
  80 extern const bt_field_class *
  81 bt_stream_class_borrow_packet_context_field_class_const(
  82                 const bt_stream_class *stream_class);
  83
  84 extern const bt_field_class *
  85 bt_stream_class_borrow_event_common_context_field_class_const(
  86                 const bt_stream_class *stream_class);
  87
  88 extern uint64_t bt_stream_class_get_event_class_count(
  89                 const bt_stream_class *stream_class);
  90
  91 extern const bt_event_class *
  92 bt_stream_class_borrow_event_class_by_index_const(
  93                 const bt_stream_class *stream_class, uint64_t index);
  94
  95 extern const bt_event_class *
  96 bt_stream_class_borrow_event_class_by_id_const(
  97                 const bt_stream_class *stream_class, uint64_t id);
  98
  99 extern const bt_clock_class *
 100 bt_stream_class_borrow_default_clock_class_const(
 101                 const bt_stream_class *stream_class);
 102
 103 extern void bt_stream_class_get_ref(const bt_stream_class *stream_class);
 104
 105 extern void bt_stream_class_put_ref(const bt_stream_class *stream_class);
 106
 107 #define BT_STREAM_CLASS_PUT_REF_AND_RESET(_var)         \
 108         do {                                            \
 109                 bt_stream_class_put_ref(_var);          \
 110                 (_var) = NULL;                          \
 111         } while (0)
 112
 113 #define BT_STREAM_CLASS_MOVE_REF(_var_dst, _var_src)    \
 114         do {                                            \
 115                 bt_stream_class_put_ref(_var_dst);      \
 116                 (_var_dst) = (_var_src);                \
 117                 (_var_src) = NULL;                      \
 118         } while (0)
 119
 120 #ifdef __cplusplus
 121 }
 122 #endif
 123
 124 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H */