Commit | Line | Data |
---|---|---|
273b65be | 1 | /* |
f2b0325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 3 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be | 4 | * |
273b65be JG |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
b03487ab | 24 | #define BT_LOG_TAG "LIB/STREAM" |
1633ef46 | 25 | #include "lib/logging.h" |
19abc2c6 | 26 | |
57952005 | 27 | #include "lib/assert-pre.h" |
71c5da58 MJ |
28 | #include <babeltrace2/trace-ir/stream-const.h> |
29 | #include <babeltrace2/trace-ir/stream.h> | |
71c5da58 | 30 | #include <babeltrace2/trace-ir/stream-class.h> |
71c5da58 | 31 | #include <babeltrace2/trace-ir/trace.h> |
57952005 MJ |
32 | #include "compat/compiler.h" |
33 | #include "common/align.h" | |
34 | #include "common/assert.h" | |
35 | #include "lib/property.h" | |
8deee039 | 36 | #include <inttypes.h> |
969c1d8a | 37 | #include <stdbool.h> |
8deee039 | 38 | #include <unistd.h> |
12c8a1a3 | 39 | |
57952005 MJ |
40 | #include "packet.h" |
41 | #include "stream-class.h" | |
42 | #include "stream.h" | |
43 | #include "trace.h" | |
af90138b | 44 | #include "lib/value.h" |
fb25b9e3 | 45 | #include "lib/func-status.h" |
57952005 | 46 | |
fa6cfec3 PP |
47 | #define BT_ASSERT_PRE_DEV_STREAM_HOT(_stream) \ |
48 | BT_ASSERT_PRE_DEV_HOT((_stream), "Stream", ": %!+s", (_stream)) | |
263a7df5 | 49 | |
c9af50d1 | 50 | static |
7b33a0e0 | 51 | void destroy_stream(struct bt_object *obj) |
c9af50d1 | 52 | { |
8deee039 | 53 | struct bt_stream *stream = (void *) obj; |
c9af50d1 | 54 | |
7b33a0e0 | 55 | BT_LIB_LOGD("Destroying stream object: %!+s", stream); |
af90138b | 56 | BT_OBJECT_PUT_REF_AND_RESET(stream->user_attributes); |
7b33a0e0 PP |
57 | |
58 | if (stream->name.str) { | |
59 | g_string_free(stream->name.str, TRUE); | |
1248f5ea PP |
60 | stream->name.str = NULL; |
61 | stream->name.value = NULL; | |
7b33a0e0 PP |
62 | } |
63 | ||
10b7a2e4 PP |
64 | BT_LOGD_STR("Putting stream's class."); |
65 | bt_object_put_ref(stream->class); | |
a6918753 | 66 | bt_object_pool_finalize(&stream->packet_pool); |
8deee039 | 67 | g_free(stream); |
c9af50d1 JG |
68 | } |
69 | ||
7b33a0e0 PP |
70 | static |
71 | void bt_stream_free_packet(struct bt_packet *packet, struct bt_stream *stream) | |
273b65be | 72 | { |
7b33a0e0 PP |
73 | bt_packet_destroy(packet); |
74 | } | |
19abc2c6 | 75 | |
7b33a0e0 PP |
76 | static inline |
77 | bool stream_id_is_unique(struct bt_trace *trace, | |
78 | struct bt_stream_class *stream_class, uint64_t id) | |
79 | { | |
80 | uint64_t i; | |
81 | bool is_unique = true; | |
273b65be | 82 | |
7b33a0e0 PP |
83 | for (i = 0; i < trace->streams->len; i++) { |
84 | struct bt_stream *stream = trace->streams->pdata[i]; | |
273b65be | 85 | |
7b33a0e0 PP |
86 | if (stream->class != stream_class) { |
87 | continue; | |
8bfa3f9c | 88 | } |
daaa1851 | 89 | |
7b33a0e0 PP |
90 | if (stream->id == id) { |
91 | is_unique = false; | |
92 | goto end; | |
98edd02c | 93 | } |
273b65be JG |
94 | } |
95 | ||
8deee039 | 96 | end: |
7b33a0e0 | 97 | return is_unique; |
a6918753 PP |
98 | } |
99 | ||
273b65be | 100 | static |
7b33a0e0 | 101 | struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class, |
10b7a2e4 | 102 | struct bt_trace *trace, uint64_t id) |
273b65be | 103 | { |
8deee039 | 104 | int ret; |
7b33a0e0 | 105 | struct bt_stream *stream; |
7b33a0e0 PP |
106 | |
107 | BT_ASSERT(stream_class); | |
10b7a2e4 PP |
108 | BT_ASSERT(trace); |
109 | BT_ASSERT_PRE(trace->class == | |
110 | bt_stream_class_borrow_trace_class_inline(stream_class), | |
111 | "Trace's class is different from stream class's parent trace class: " | |
112 | "%![sc-]+S, %![trace-]+t", stream_class, trace); | |
7b33a0e0 PP |
113 | BT_ASSERT_PRE(stream_id_is_unique(trace, stream_class, id), |
114 | "Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id); | |
7b33a0e0 PP |
115 | BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64, |
116 | trace, id); | |
8deee039 PP |
117 | stream = g_new0(struct bt_stream, 1); |
118 | if (!stream) { | |
a8f90e5d | 119 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one stream."); |
8deee039 | 120 | goto error; |
12c8a1a3 | 121 | } |
b71d7298 | 122 | |
7b33a0e0 | 123 | bt_object_init_shared_with_parent(&stream->base, destroy_stream); |
af90138b PP |
124 | stream->user_attributes = bt_value_map_create(); |
125 | if (!stream->user_attributes) { | |
126 | BT_LIB_LOGE_APPEND_CAUSE( | |
127 | "Failed to create a map value object."); | |
128 | goto error; | |
129 | } | |
130 | ||
7b33a0e0 PP |
131 | stream->name.str = g_string_new(NULL); |
132 | if (!stream->name.str) { | |
a8f90e5d | 133 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
8deee039 | 134 | goto error; |
b71d7298 | 135 | } |
41ac640a | 136 | |
7b33a0e0 | 137 | stream->id = id; |
a6918753 PP |
138 | ret = bt_object_pool_initialize(&stream->packet_pool, |
139 | (bt_object_pool_new_object_func) bt_packet_new, | |
140 | (bt_object_pool_destroy_object_func) bt_stream_free_packet, | |
141 | stream); | |
142 | if (ret) { | |
a8f90e5d PP |
143 | BT_LIB_LOGE_APPEND_CAUSE( |
144 | "Failed to initialize packet pool: ret=%d", ret); | |
a6918753 PP |
145 | goto error; |
146 | } | |
147 | ||
7b33a0e0 | 148 | stream->class = stream_class; |
864aa43f | 149 | bt_object_get_ref_no_null_check(stream_class); |
10b7a2e4 PP |
150 | |
151 | /* bt_trace_add_stream() sets the parent trace, and freezes the trace */ | |
7b33a0e0 | 152 | bt_trace_add_stream(trace, stream); |
10b7a2e4 | 153 | |
7b33a0e0 PP |
154 | bt_stream_class_freeze(stream_class); |
155 | BT_LIB_LOGD("Created stream object: %!+s", stream); | |
8deee039 | 156 | goto end; |
3230ee6b | 157 | |
8deee039 | 158 | error: |
8138bfe1 | 159 | BT_OBJECT_PUT_REF_AND_RESET(stream); |
8deee039 PP |
160 | |
161 | end: | |
162 | return stream; | |
273b65be JG |
163 | } |
164 | ||
10b7a2e4 PP |
165 | struct bt_stream *bt_stream_create(struct bt_stream_class *stream_class, |
166 | struct bt_trace *trace) | |
273b65be | 167 | { |
7b33a0e0 PP |
168 | uint64_t id; |
169 | ||
7c7324d3 | 170 | BT_ASSERT_PRE_NO_ERROR(); |
7b33a0e0 | 171 | BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class"); |
10b7a2e4 | 172 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
7b33a0e0 PP |
173 | BT_ASSERT_PRE(stream_class->assigns_automatic_stream_id, |
174 | "Stream class does not automatically assigns stream IDs: " | |
175 | "%![sc-]+S", stream_class); | |
10b7a2e4 PP |
176 | id = bt_trace_get_automatic_stream_id(trace, stream_class); |
177 | return create_stream_with_id(stream_class, trace, id); | |
7b33a0e0 | 178 | } |
d7b1ea66 | 179 | |
78cf9df6 | 180 | struct bt_stream *bt_stream_create_with_id(struct bt_stream_class *stream_class, |
10b7a2e4 | 181 | struct bt_trace *trace, uint64_t id) |
7b33a0e0 | 182 | { |
7c7324d3 | 183 | BT_ASSERT_PRE_NO_ERROR(); |
10b7a2e4 PP |
184 | BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class"); |
185 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); | |
7b33a0e0 PP |
186 | BT_ASSERT_PRE(!stream_class->assigns_automatic_stream_id, |
187 | "Stream class automatically assigns stream IDs: " | |
188 | "%![sc-]+S", stream_class); | |
10b7a2e4 | 189 | return create_stream_with_id(stream_class, trace, id); |
273b65be | 190 | } |
b71d7298 | 191 | |
5fe68922 | 192 | struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream) |
af9296f3 | 193 | { |
fa6cfec3 | 194 | BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream"); |
7b33a0e0 | 195 | return stream->class; |
af9296f3 JG |
196 | } |
197 | ||
78cf9df6 PP |
198 | const struct bt_stream_class *bt_stream_borrow_class_const( |
199 | const struct bt_stream *stream) | |
9e550e5f | 200 | { |
78cf9df6 | 201 | return bt_stream_borrow_class((void *) stream); |
9e550e5f PP |
202 | } |
203 | ||
10b7a2e4 PP |
204 | struct bt_trace *bt_stream_borrow_trace(struct bt_stream *stream) |
205 | { | |
fa6cfec3 | 206 | BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream"); |
10b7a2e4 PP |
207 | return bt_stream_borrow_trace_inline(stream); |
208 | } | |
209 | ||
210 | const struct bt_trace *bt_stream_borrow_trace_const( | |
211 | const struct bt_stream *stream) | |
212 | { | |
213 | return bt_stream_borrow_trace((void *) stream); | |
214 | } | |
215 | ||
78cf9df6 | 216 | const char *bt_stream_get_name(const struct bt_stream *stream) |
b71d7298 | 217 | { |
fa6cfec3 | 218 | BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream"); |
7b33a0e0 | 219 | return stream->name.value; |
b71d7298 | 220 | } |
98a4cbef | 221 | |
fb25b9e3 | 222 | enum bt_stream_set_name_status bt_stream_set_name(struct bt_stream *stream, |
45490f7f | 223 | const char *name) |
98a4cbef | 224 | { |
7c7324d3 | 225 | BT_ASSERT_PRE_NO_ERROR(); |
c471045c | 226 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); |
7b33a0e0 | 227 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
fa6cfec3 | 228 | BT_ASSERT_PRE_DEV_STREAM_HOT(stream); |
7b33a0e0 PP |
229 | g_string_assign(stream->name.str, name); |
230 | stream->name.value = stream->name.str->str; | |
a684a357 | 231 | BT_LIB_LOGD("Set stream's name: %!+s", stream); |
fb25b9e3 | 232 | return BT_FUNC_STATUS_OK; |
7b33a0e0 | 233 | } |
18acc6f8 | 234 | |
78cf9df6 | 235 | uint64_t bt_stream_get_id(const struct bt_stream *stream) |
7b33a0e0 | 236 | { |
fa6cfec3 | 237 | BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream class"); |
7b33a0e0 PP |
238 | return stream->id; |
239 | } | |
18acc6f8 | 240 | |
7b33a0e0 | 241 | BT_HIDDEN |
78cf9df6 | 242 | void _bt_stream_freeze(const struct bt_stream *stream) |
7b33a0e0 | 243 | { |
7b33a0e0 | 244 | BT_ASSERT(stream); |
af90138b PP |
245 | BT_LIB_LOGD("Freezing stream's user attributes: %!+v", |
246 | stream->user_attributes); | |
247 | bt_value_freeze(stream->user_attributes); | |
7b33a0e0 | 248 | BT_LIB_LOGD("Freezing stream: %!+s", stream); |
78cf9df6 | 249 | ((struct bt_stream *) stream)->frozen = true; |
98a4cbef | 250 | } |
8c6884d9 | 251 | |
af90138b PP |
252 | const struct bt_value *bt_stream_borrow_user_attributes_const( |
253 | const struct bt_stream *stream) | |
254 | { | |
255 | BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream"); | |
256 | return stream->user_attributes; | |
257 | } | |
258 | ||
259 | struct bt_value *bt_stream_borrow_user_attributes(struct bt_stream *stream) | |
260 | { | |
261 | return (void *) bt_stream_borrow_user_attributes_const((void *) stream); | |
262 | } | |
263 | ||
264 | void bt_stream_set_user_attributes(struct bt_stream *stream, | |
265 | const struct bt_value *user_attributes) | |
266 | { | |
267 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); | |
268 | BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes"); | |
269 | BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP, | |
270 | "User attributes object is not a map value object."); | |
271 | BT_ASSERT_PRE_DEV_STREAM_HOT(stream); | |
864aa43f | 272 | bt_object_put_ref_no_null_check(stream->user_attributes); |
af90138b | 273 | stream->user_attributes = (void *) user_attributes; |
864aa43f | 274 | bt_object_get_ref_no_null_check(stream->user_attributes); |
af90138b PP |
275 | } |
276 | ||
8c6884d9 PP |
277 | void bt_stream_get_ref(const struct bt_stream *stream) |
278 | { | |
279 | bt_object_get_ref(stream); | |
280 | } | |
281 | ||
282 | void bt_stream_put_ref(const struct bt_stream *stream) | |
283 | { | |
284 | bt_object_put_ref(stream); | |
285 | } |