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 | ||
32 | /* For bt_bool */ | |
33 | #include <babeltrace/types.h> | |
34 | ||
35 | #ifdef __cplusplus | |
36 | extern "C" { | |
37 | #endif | |
38 | ||
862ca4ed | 39 | struct bt_trace_class; |
40f4ba76 PP |
40 | struct bt_stream_class; |
41 | struct bt_event_class; | |
c5b9b441 | 42 | struct bt_stream_class; |
40f4ba76 PP |
43 | struct bt_event_header_field; |
44 | struct bt_packet_context_field; | |
45 | ||
862ca4ed | 46 | extern const struct bt_trace_class *bt_stream_class_borrow_trace_class_const( |
40f4ba76 PP |
47 | const struct bt_stream_class *stream_class); |
48 | ||
49 | extern const char *bt_stream_class_get_name( | |
50 | const struct bt_stream_class *stream_class); | |
51 | ||
52 | extern bt_bool bt_stream_class_assigns_automatic_event_class_id( | |
53 | const struct bt_stream_class *stream_class); | |
54 | ||
55 | extern bt_bool bt_stream_class_assigns_automatic_stream_id( | |
56 | const struct bt_stream_class *stream_class); | |
57 | ||
58 | extern uint64_t bt_stream_class_get_id( | |
59 | const struct bt_stream_class *stream_class); | |
60 | ||
61 | extern const struct bt_field_class * | |
62 | bt_stream_class_borrow_packet_context_field_class_const( | |
63 | const struct bt_stream_class *stream_class); | |
64 | ||
65 | extern const struct bt_field_class * | |
66 | bt_stream_class_borrow_event_header_field_class_const( | |
67 | const struct bt_stream_class *stream_class); | |
68 | ||
69 | extern const struct bt_field_class * | |
70 | bt_stream_class_borrow_event_common_context_field_class_const( | |
71 | const struct bt_stream_class *stream_class); | |
72 | ||
73 | extern uint64_t bt_stream_class_get_event_class_count( | |
74 | const struct bt_stream_class *stream_class); | |
75 | ||
76 | extern const struct bt_event_class * | |
77 | bt_stream_class_borrow_event_class_by_index_const( | |
78 | const struct bt_stream_class *stream_class, uint64_t index); | |
79 | ||
80 | extern const struct bt_event_class * | |
81 | bt_stream_class_borrow_event_class_by_id_const( | |
82 | const struct bt_stream_class *stream_class, uint64_t id); | |
83 | ||
84 | extern const struct bt_clock_class * | |
85 | bt_stream_class_borrow_default_clock_class_const( | |
86 | const struct bt_stream_class *stream_class); | |
87 | ||
88 | extern bt_bool bt_stream_class_default_clock_is_always_known( | |
89 | const struct bt_stream_class *stream_class); | |
90 | ||
91 | extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot( | |
92 | const struct bt_stream_class *stream_class); | |
93 | ||
94 | extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot( | |
95 | const struct bt_stream_class *stream_class); | |
96 | ||
97 | extern bt_bool bt_stream_class_packets_have_default_beginning_clock_value( | |
98 | const struct bt_stream_class *stream_class); | |
99 | ||
100 | extern bt_bool bt_stream_class_packets_have_default_end_clock_value( | |
101 | const struct bt_stream_class *stream_class); | |
102 | ||
c5b9b441 PP |
103 | extern void bt_stream_class_get_ref(const struct bt_stream_class *stream_class); |
104 | ||
105 | extern void bt_stream_class_put_ref(const struct 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 | ||
40f4ba76 PP |
120 | #ifdef __cplusplus |
121 | } | |
122 | #endif | |
123 | ||
124 | #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H */ |