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

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