Commit | Line | Data |
---|---|---|
273b65be | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
e2f7325d | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 5 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
6 | */ |
7 | ||
350ad6c1 | 8 | #define BT_LOG_TAG "LIB/STREAM" |
c2d9d9cf | 9 | #include "lib/logging.h" |
19abc2c6 | 10 | |
d98421f2 | 11 | #include "lib/assert-cond.h" |
3fadfbc0 | 12 | #include <babeltrace2/trace-ir/stream.h> |
3fadfbc0 | 13 | #include <babeltrace2/trace-ir/stream-class.h> |
3fadfbc0 | 14 | #include <babeltrace2/trace-ir/trace.h> |
578e048b | 15 | #include "compat/compiler.h" |
578e048b | 16 | #include "common/assert.h" |
3dca2276 | 17 | #include <inttypes.h> |
c4f23e30 | 18 | #include <stdbool.h> |
3dca2276 | 19 | #include <unistd.h> |
12c8a1a3 | 20 | |
578e048b MJ |
21 | #include "packet.h" |
22 | #include "stream-class.h" | |
23 | #include "stream.h" | |
24 | #include "trace.h" | |
c6962c96 | 25 | #include "lib/value.h" |
d24d5663 | 26 | #include "lib/func-status.h" |
578e048b | 27 | |
d5b13b9b | 28 | #define BT_ASSERT_PRE_DEV_STREAM_HOT(_stream) \ |
1778c2a4 PP |
29 | BT_ASSERT_PRE_DEV_HOT("stream", (_stream), "Stream", \ |
30 | ": %!+s", (_stream)) | |
263a7df5 | 31 | |
c9af50d1 | 32 | static |
44c440bc | 33 | void destroy_stream(struct bt_object *obj) |
c9af50d1 | 34 | { |
3dca2276 | 35 | struct bt_stream *stream = (void *) obj; |
c9af50d1 | 36 | |
44c440bc | 37 | BT_LIB_LOGD("Destroying stream object: %!+s", stream); |
c6962c96 | 38 | BT_OBJECT_PUT_REF_AND_RESET(stream->user_attributes); |
44c440bc | 39 | |
b91e0631 | 40 | g_free(stream->name); |
862ca4ed PP |
41 | BT_LOGD_STR("Putting stream's class."); |
42 | bt_object_put_ref(stream->class); | |
312c056a | 43 | bt_object_pool_finalize(&stream->packet_pool); |
3dca2276 | 44 | g_free(stream); |
c9af50d1 JG |
45 | } |
46 | ||
44c440bc | 47 | static |
ecd7492f MJ |
48 | void bt_stream_free_packet(struct bt_packet *packet, |
49 | struct bt_stream *stream __attribute__((unused))) | |
273b65be | 50 | { |
44c440bc PP |
51 | bt_packet_destroy(packet); |
52 | } | |
19abc2c6 | 53 | |
44c440bc PP |
54 | static inline |
55 | bool stream_id_is_unique(struct bt_trace *trace, | |
56 | struct bt_stream_class *stream_class, uint64_t id) | |
57 | { | |
58 | uint64_t i; | |
59 | bool is_unique = true; | |
273b65be | 60 | |
44c440bc PP |
61 | for (i = 0; i < trace->streams->len; i++) { |
62 | struct bt_stream *stream = trace->streams->pdata[i]; | |
273b65be | 63 | |
44c440bc PP |
64 | if (stream->class != stream_class) { |
65 | continue; | |
8bfa3f9c | 66 | } |
1c1d572f | 67 | |
44c440bc PP |
68 | if (stream->id == id) { |
69 | is_unique = false; | |
70 | goto end; | |
98edd02c | 71 | } |
273b65be JG |
72 | } |
73 | ||
3dca2276 | 74 | end: |
44c440bc | 75 | return is_unique; |
312c056a PP |
76 | } |
77 | ||
273b65be | 78 | static |
44c440bc | 79 | struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class, |
1778c2a4 | 80 | struct bt_trace *trace, uint64_t id, const char *api_func) |
273b65be | 81 | { |
3dca2276 | 82 | int ret; |
44c440bc | 83 | struct bt_stream *stream; |
44c440bc PP |
84 | |
85 | BT_ASSERT(stream_class); | |
862ca4ed | 86 | BT_ASSERT(trace); |
1778c2a4 PP |
87 | BT_ASSERT_PRE_FROM_FUNC(api_func, |
88 | "trace-class-is-stream-class-trace-class", | |
89 | trace->class == | |
90 | bt_stream_class_borrow_trace_class_inline(stream_class), | |
862ca4ed PP |
91 | "Trace's class is different from stream class's parent trace class: " |
92 | "%![sc-]+S, %![trace-]+t", stream_class, trace); | |
1778c2a4 PP |
93 | BT_ASSERT_PRE_FROM_FUNC(api_func, "stream-id-is-unique", |
94 | stream_id_is_unique(trace, stream_class, id), | |
44c440bc | 95 | "Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id); |
44c440bc PP |
96 | BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64, |
97 | trace, id); | |
3dca2276 PP |
98 | stream = g_new0(struct bt_stream, 1); |
99 | if (!stream) { | |
870631a2 | 100 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one stream."); |
3dca2276 | 101 | goto error; |
12c8a1a3 | 102 | } |
b71d7298 | 103 | |
44c440bc | 104 | bt_object_init_shared_with_parent(&stream->base, destroy_stream); |
c6962c96 PP |
105 | stream->user_attributes = bt_value_map_create(); |
106 | if (!stream->user_attributes) { | |
107 | BT_LIB_LOGE_APPEND_CAUSE( | |
108 | "Failed to create a map value object."); | |
109 | goto error; | |
110 | } | |
111 | ||
44c440bc | 112 | stream->id = id; |
312c056a PP |
113 | ret = bt_object_pool_initialize(&stream->packet_pool, |
114 | (bt_object_pool_new_object_func) bt_packet_new, | |
115 | (bt_object_pool_destroy_object_func) bt_stream_free_packet, | |
116 | stream); | |
117 | if (ret) { | |
870631a2 PP |
118 | BT_LIB_LOGE_APPEND_CAUSE( |
119 | "Failed to initialize packet pool: ret=%d", ret); | |
312c056a PP |
120 | goto error; |
121 | } | |
122 | ||
44c440bc | 123 | stream->class = stream_class; |
6871026b | 124 | bt_object_get_ref_no_null_check(stream_class); |
862ca4ed PP |
125 | |
126 | /* bt_trace_add_stream() sets the parent trace, and freezes the trace */ | |
44c440bc | 127 | bt_trace_add_stream(trace, stream); |
862ca4ed | 128 | |
44c440bc PP |
129 | bt_stream_class_freeze(stream_class); |
130 | BT_LIB_LOGD("Created stream object: %!+s", stream); | |
3dca2276 | 131 | goto end; |
3230ee6b | 132 | |
3dca2276 | 133 | error: |
65300d60 | 134 | BT_OBJECT_PUT_REF_AND_RESET(stream); |
3dca2276 PP |
135 | |
136 | end: | |
137 | return stream; | |
273b65be JG |
138 | } |
139 | ||
1353b066 | 140 | BT_EXPORT |
862ca4ed PP |
141 | struct bt_stream *bt_stream_create(struct bt_stream_class *stream_class, |
142 | struct bt_trace *trace) | |
273b65be | 143 | { |
44c440bc PP |
144 | uint64_t id; |
145 | ||
17f3083a | 146 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
147 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
148 | BT_ASSERT_PRE_TRACE_NON_NULL(trace); | |
1778c2a4 PP |
149 | BT_ASSERT_PRE("stream-class-automatically-assigns-stream-ids", |
150 | stream_class->assigns_automatic_stream_id, | |
44c440bc PP |
151 | "Stream class does not automatically assigns stream IDs: " |
152 | "%![sc-]+S", stream_class); | |
862ca4ed | 153 | id = bt_trace_get_automatic_stream_id(trace, stream_class); |
1778c2a4 | 154 | return create_stream_with_id(stream_class, trace, id, __func__); |
44c440bc | 155 | } |
d7b1ea66 | 156 | |
1353b066 | 157 | BT_EXPORT |
40f4ba76 | 158 | struct bt_stream *bt_stream_create_with_id(struct bt_stream_class *stream_class, |
862ca4ed | 159 | struct bt_trace *trace, uint64_t id) |
44c440bc | 160 | { |
17f3083a | 161 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
162 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
163 | BT_ASSERT_PRE_TRACE_NON_NULL(trace); | |
1778c2a4 PP |
164 | BT_ASSERT_PRE("stream-class-does-not-automatically-assigns-stream-ids", |
165 | !stream_class->assigns_automatic_stream_id, | |
44c440bc PP |
166 | "Stream class automatically assigns stream IDs: " |
167 | "%![sc-]+S", stream_class); | |
1778c2a4 | 168 | return create_stream_with_id(stream_class, trace, id, __func__); |
273b65be | 169 | } |
b71d7298 | 170 | |
1353b066 | 171 | BT_EXPORT |
094ff7c0 | 172 | struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream) |
af9296f3 | 173 | { |
d5b13b9b | 174 | BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream); |
44c440bc | 175 | return stream->class; |
af9296f3 JG |
176 | } |
177 | ||
1353b066 | 178 | BT_EXPORT |
40f4ba76 PP |
179 | const struct bt_stream_class *bt_stream_borrow_class_const( |
180 | const struct bt_stream *stream) | |
e5be10ef | 181 | { |
40f4ba76 | 182 | return bt_stream_borrow_class((void *) stream); |
e5be10ef PP |
183 | } |
184 | ||
1353b066 | 185 | BT_EXPORT |
862ca4ed PP |
186 | struct bt_trace *bt_stream_borrow_trace(struct bt_stream *stream) |
187 | { | |
d5b13b9b | 188 | BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream); |
862ca4ed PP |
189 | return bt_stream_borrow_trace_inline(stream); |
190 | } | |
191 | ||
1353b066 | 192 | BT_EXPORT |
862ca4ed PP |
193 | const struct bt_trace *bt_stream_borrow_trace_const( |
194 | const struct bt_stream *stream) | |
195 | { | |
196 | return bt_stream_borrow_trace((void *) stream); | |
197 | } | |
198 | ||
1353b066 | 199 | BT_EXPORT |
40f4ba76 | 200 | const char *bt_stream_get_name(const struct bt_stream *stream) |
b71d7298 | 201 | { |
d5b13b9b | 202 | BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream); |
b91e0631 | 203 | return stream->name; |
b71d7298 | 204 | } |
98a4cbef | 205 | |
1353b066 | 206 | BT_EXPORT |
d24d5663 | 207 | enum bt_stream_set_name_status bt_stream_set_name(struct bt_stream *stream, |
3dcff82b | 208 | const char *name) |
98a4cbef | 209 | { |
17f3083a | 210 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
211 | BT_ASSERT_PRE_STREAM_NON_NULL(stream); |
212 | BT_ASSERT_PRE_NAME_NON_NULL(name); | |
bdb288b3 | 213 | BT_ASSERT_PRE_DEV_STREAM_HOT(stream); |
b91e0631 SM |
214 | g_free(stream->name); |
215 | stream->name = g_strdup(name); | |
3f7d4d90 | 216 | BT_LIB_LOGD("Set stream's name: %!+s", stream); |
d24d5663 | 217 | return BT_FUNC_STATUS_OK; |
44c440bc | 218 | } |
cb6f1f7d | 219 | |
1353b066 | 220 | BT_EXPORT |
40f4ba76 | 221 | uint64_t bt_stream_get_id(const struct bt_stream *stream) |
44c440bc | 222 | { |
d5b13b9b | 223 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream); |
44c440bc PP |
224 | return stream->id; |
225 | } | |
cb6f1f7d | 226 | |
40f4ba76 | 227 | void _bt_stream_freeze(const struct bt_stream *stream) |
44c440bc | 228 | { |
44c440bc | 229 | BT_ASSERT(stream); |
c6962c96 PP |
230 | BT_LIB_LOGD("Freezing stream's user attributes: %!+v", |
231 | stream->user_attributes); | |
232 | bt_value_freeze(stream->user_attributes); | |
44c440bc | 233 | BT_LIB_LOGD("Freezing stream: %!+s", stream); |
40f4ba76 | 234 | ((struct bt_stream *) stream)->frozen = true; |
98a4cbef | 235 | } |
c5b9b441 | 236 | |
1353b066 | 237 | BT_EXPORT |
c6962c96 PP |
238 | const struct bt_value *bt_stream_borrow_user_attributes_const( |
239 | const struct bt_stream *stream) | |
240 | { | |
d5b13b9b | 241 | BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream); |
c6962c96 PP |
242 | return stream->user_attributes; |
243 | } | |
244 | ||
1353b066 | 245 | BT_EXPORT |
c6962c96 PP |
246 | struct bt_value *bt_stream_borrow_user_attributes(struct bt_stream *stream) |
247 | { | |
248 | return (void *) bt_stream_borrow_user_attributes_const((void *) stream); | |
249 | } | |
250 | ||
1353b066 | 251 | BT_EXPORT |
c6962c96 PP |
252 | void bt_stream_set_user_attributes(struct bt_stream *stream, |
253 | const struct bt_value *user_attributes) | |
254 | { | |
d5b13b9b PP |
255 | BT_ASSERT_PRE_STREAM_NON_NULL(stream); |
256 | BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes); | |
257 | BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes); | |
c6962c96 | 258 | BT_ASSERT_PRE_DEV_STREAM_HOT(stream); |
6871026b | 259 | bt_object_put_ref_no_null_check(stream->user_attributes); |
c6962c96 | 260 | stream->user_attributes = (void *) user_attributes; |
6871026b | 261 | bt_object_get_ref_no_null_check(stream->user_attributes); |
c6962c96 PP |
262 | } |
263 | ||
1353b066 | 264 | BT_EXPORT |
c5b9b441 PP |
265 | void bt_stream_get_ref(const struct bt_stream *stream) |
266 | { | |
267 | bt_object_get_ref(stream); | |
268 | } | |
269 | ||
1353b066 | 270 | BT_EXPORT |
c5b9b441 PP |
271 | void bt_stream_put_ref(const struct bt_stream *stream) |
272 | { | |
273 | bt_object_put_ref(stream); | |
274 | } |