Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_STREAM_CLASS_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_STREAM_CLASS_CONST_H | |
40f4ba76 PP |
3 | |
4 | /* | |
e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
40f4ba76 PP |
6 | * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
40f4ba76 PP |
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 | ||
4fa90f32 PP |
30 | #ifndef __BT_IN_BABELTRACE_H |
31 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
32 | #endif | |
33 | ||
40f4ba76 PP |
34 | #include <stdint.h> |
35 | ||
b19ff26f PP |
36 | /* |
37 | * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class, | |
83ebb7f1 | 38 | * bt_stream_class |
b19ff26f | 39 | */ |
3fadfbc0 | 40 | #include <babeltrace2/types.h> |
40f4ba76 PP |
41 | |
42 | #ifdef __cplusplus | |
43 | extern "C" { | |
44 | #endif | |
45 | ||
b19ff26f PP |
46 | extern const bt_trace_class *bt_stream_class_borrow_trace_class_const( |
47 | const bt_stream_class *stream_class); | |
40f4ba76 PP |
48 | |
49 | extern const char *bt_stream_class_get_name( | |
b19ff26f | 50 | const bt_stream_class *stream_class); |
40f4ba76 PP |
51 | |
52 | extern bt_bool bt_stream_class_assigns_automatic_event_class_id( | |
b19ff26f | 53 | const bt_stream_class *stream_class); |
40f4ba76 PP |
54 | |
55 | extern bt_bool bt_stream_class_assigns_automatic_stream_id( | |
b19ff26f | 56 | const bt_stream_class *stream_class); |
26fc5aed PP |
57 | |
58 | extern bt_bool bt_stream_class_supports_packets( | |
59 | const bt_stream_class *stream_class); | |
40f4ba76 | 60 | |
9b24b6aa | 61 | extern bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot( |
649934d2 PP |
62 | const bt_stream_class *stream_class); |
63 | ||
9b24b6aa | 64 | extern bt_bool bt_stream_class_packets_have_end_default_clock_snapshot( |
649934d2 PP |
65 | const bt_stream_class *stream_class); |
66 | ||
2e90378a PP |
67 | extern bt_bool bt_stream_class_supports_discarded_events( |
68 | const bt_stream_class *stream_class); | |
69 | ||
70 | extern bt_bool bt_stream_class_supports_discarded_packets( | |
71 | const bt_stream_class *stream_class); | |
72 | ||
73 | extern bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots( | |
74 | const bt_stream_class *stream_class); | |
75 | ||
76 | extern bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots( | |
77 | const bt_stream_class *stream_class); | |
78 | ||
40f4ba76 | 79 | extern uint64_t bt_stream_class_get_id( |
b19ff26f | 80 | const bt_stream_class *stream_class); |
40f4ba76 | 81 | |
b19ff26f | 82 | extern const bt_field_class * |
40f4ba76 | 83 | bt_stream_class_borrow_packet_context_field_class_const( |
b19ff26f | 84 | const bt_stream_class *stream_class); |
40f4ba76 | 85 | |
b19ff26f | 86 | extern const bt_field_class * |
40f4ba76 | 87 | bt_stream_class_borrow_event_common_context_field_class_const( |
b19ff26f | 88 | const bt_stream_class *stream_class); |
40f4ba76 PP |
89 | |
90 | extern uint64_t bt_stream_class_get_event_class_count( | |
b19ff26f | 91 | const bt_stream_class *stream_class); |
40f4ba76 | 92 | |
b19ff26f | 93 | extern const bt_event_class * |
40f4ba76 | 94 | bt_stream_class_borrow_event_class_by_index_const( |
b19ff26f | 95 | const bt_stream_class *stream_class, uint64_t index); |
40f4ba76 | 96 | |
b19ff26f | 97 | extern const bt_event_class * |
40f4ba76 | 98 | bt_stream_class_borrow_event_class_by_id_const( |
b19ff26f | 99 | const bt_stream_class *stream_class, uint64_t id); |
40f4ba76 | 100 | |
b19ff26f | 101 | extern const bt_clock_class * |
40f4ba76 | 102 | bt_stream_class_borrow_default_clock_class_const( |
b19ff26f | 103 | const bt_stream_class *stream_class); |
40f4ba76 | 104 | |
b19ff26f | 105 | extern void bt_stream_class_get_ref(const bt_stream_class *stream_class); |
c5b9b441 | 106 | |
b19ff26f | 107 | extern void bt_stream_class_put_ref(const bt_stream_class *stream_class); |
c5b9b441 PP |
108 | |
109 | #define BT_STREAM_CLASS_PUT_REF_AND_RESET(_var) \ | |
110 | do { \ | |
111 | bt_stream_class_put_ref(_var); \ | |
112 | (_var) = NULL; \ | |
113 | } while (0) | |
114 | ||
115 | #define BT_STREAM_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
116 | do { \ | |
117 | bt_stream_class_put_ref(_var_dst); \ | |
118 | (_var_dst) = (_var_src); \ | |
119 | (_var_src) = NULL; \ | |
120 | } while (0) | |
121 | ||
40f4ba76 PP |
122 | #ifdef __cplusplus |
123 | } | |
124 | #endif | |
125 | ||
924dc299 | 126 | #endif /* BABELTRACE2_TRACE_IR_STREAM_CLASS_CONST_H */ |