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