Commit | Line | Data |
---|---|---|
11b0cdc8 | 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> |
11b0cdc8 JG |
6 | */ |
7 | ||
350ad6c1 | 8 | #define BT_LOG_TAG "LIB/STREAM-CLASS" |
c2d9d9cf | 9 | #include "lib/logging.h" |
d2f71f12 | 10 | |
d98421f2 | 11 | #include "lib/assert-cond.h" |
43c59509 | 12 | #include <babeltrace2/trace-ir/trace.h> |
578e048b MJ |
13 | #include "compat/compiler.h" |
14 | #include "common/align.h" | |
15 | #include "compat/endian.h" | |
16 | #include "common/assert.h" | |
17 | #include "lib/property.h" | |
dc3fffef | 18 | #include <inttypes.h> |
544d0515 | 19 | #include <stdint.h> |
e011d2c1 | 20 | #include <stdbool.h> |
11b0cdc8 | 21 | |
578e048b MJ |
22 | #include "clock-class.h" |
23 | #include "event-class.h" | |
24 | #include "field-class.h" | |
25 | #include "field.h" | |
26 | #include "field-wrapper.h" | |
27 | #include "resolve-field-path.h" | |
28 | #include "stream-class.h" | |
29 | #include "trace.h" | |
30 | #include "utils.h" | |
c6962c96 | 31 | #include "lib/value.h" |
d24d5663 | 32 | #include "lib/func-status.h" |
578e048b | 33 | |
d5b13b9b | 34 | #define BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(_sc) \ |
1778c2a4 PP |
35 | BT_ASSERT_PRE_DEV_HOT("stream-class", (_sc), "Stream class", \ |
36 | ": %!+S", (_sc)) | |
142c5610 | 37 | |
cb6f1f7d | 38 | static |
44c440bc | 39 | void destroy_stream_class(struct bt_object *obj) |
3ea33115 | 40 | { |
cb6f1f7d PP |
41 | struct bt_stream_class *stream_class = (void *) obj; |
42 | ||
44c440bc PP |
43 | BT_LIB_LOGD("Destroying stream class: %!+S", stream_class); |
44 | BT_LOGD_STR("Putting default clock class."); | |
c6962c96 | 45 | BT_OBJECT_PUT_REF_AND_RESET(stream_class->user_attributes); |
238b7404 | 46 | BT_OBJECT_PUT_REF_AND_RESET(stream_class->default_clock_class); |
3ea33115 | 47 | |
3dca2276 PP |
48 | if (stream_class->event_classes) { |
49 | BT_LOGD_STR("Destroying event classes."); | |
50 | g_ptr_array_free(stream_class->event_classes, TRUE); | |
238b7404 | 51 | stream_class->event_classes = NULL; |
d2f71f12 PP |
52 | } |
53 | ||
44c440bc PP |
54 | if (stream_class->name.str) { |
55 | g_string_free(stream_class->name.str, TRUE); | |
238b7404 PP |
56 | stream_class->name.str = NULL; |
57 | stream_class->name.value = NULL; | |
3ea33115 JG |
58 | } |
59 | ||
e6276565 | 60 | BT_LOGD_STR("Putting packet context field class."); |
238b7404 | 61 | BT_OBJECT_PUT_REF_AND_RESET(stream_class->packet_context_fc); |
e6276565 | 62 | BT_LOGD_STR("Putting event common context field class."); |
238b7404 | 63 | BT_OBJECT_PUT_REF_AND_RESET(stream_class->event_common_context_fc); |
312c056a | 64 | bt_object_pool_finalize(&stream_class->packet_context_field_pool); |
3dca2276 | 65 | g_free(stream_class); |
3ea33115 JG |
66 | } |
67 | ||
312c056a PP |
68 | static |
69 | void free_field_wrapper(struct bt_field_wrapper *field_wrapper, | |
70 | struct bt_stream_class *stream_class) | |
71 | { | |
72 | bt_field_wrapper_destroy((void *) field_wrapper); | |
73 | } | |
74 | ||
44c440bc | 75 | static |
862ca4ed | 76 | bool stream_class_id_is_unique(const struct bt_trace_class *tc, uint64_t id) |
44c440bc PP |
77 | { |
78 | uint64_t i; | |
79 | bool is_unique = true; | |
80 | ||
862ca4ed | 81 | for (i = 0; i < tc->stream_classes->len; i++) { |
40f4ba76 | 82 | const struct bt_stream_class *sc = |
862ca4ed | 83 | tc->stream_classes->pdata[i]; |
44c440bc PP |
84 | |
85 | if (sc->id == id) { | |
86 | is_unique = false; | |
87 | goto end; | |
88 | } | |
89 | } | |
90 | ||
91 | end: | |
92 | return is_unique; | |
93 | } | |
94 | ||
95 | static | |
862ca4ed PP |
96 | struct bt_stream_class *create_stream_class_with_id( |
97 | struct bt_trace_class *tc, uint64_t id) | |
2f100782 | 98 | { |
3dca2276 PP |
99 | struct bt_stream_class *stream_class = NULL; |
100 | int ret; | |
2f100782 | 101 | |
862ca4ed | 102 | BT_ASSERT(tc); |
1778c2a4 PP |
103 | BT_ASSERT_PRE("stream-class-id-is-unique", |
104 | stream_class_id_is_unique(tc, id), | |
862ca4ed PP |
105 | "Duplicate stream class ID: %![tc-]+T, id=%" PRIu64, tc, id); |
106 | BT_LIB_LOGD("Creating stream class object: %![tc-]+T, id=%" PRIu64, | |
107 | tc, id); | |
3dca2276 | 108 | stream_class = g_new0(struct bt_stream_class, 1); |
d2f71f12 | 109 | if (!stream_class) { |
870631a2 PP |
110 | BT_LIB_LOGE_APPEND_CAUSE( |
111 | "Failed to allocate one stream class."); | |
3dca2276 | 112 | goto error; |
d2f71f12 PP |
113 | } |
114 | ||
44c440bc PP |
115 | bt_object_init_shared_with_parent(&stream_class->base, |
116 | destroy_stream_class); | |
c6962c96 PP |
117 | stream_class->user_attributes = bt_value_map_create(); |
118 | if (!stream_class->user_attributes) { | |
119 | BT_LIB_LOGE_APPEND_CAUSE( | |
120 | "Failed to create a map value object."); | |
121 | goto error; | |
122 | } | |
44c440bc PP |
123 | |
124 | stream_class->name.str = g_string_new(NULL); | |
125 | if (!stream_class->name.str) { | |
870631a2 | 126 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
c6962c96 | 127 | goto error; |
44c440bc PP |
128 | } |
129 | ||
130 | stream_class->id = id; | |
131 | stream_class->assigns_automatic_event_class_id = true; | |
132 | stream_class->assigns_automatic_stream_id = true; | |
133 | stream_class->event_classes = g_ptr_array_new_with_free_func( | |
134 | (GDestroyNotify) bt_object_try_spec_release); | |
135 | if (!stream_class->event_classes) { | |
870631a2 | 136 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); |
3dca2276 | 137 | goto error; |
2f100782 JG |
138 | } |
139 | ||
312c056a PP |
140 | ret = bt_object_pool_initialize(&stream_class->packet_context_field_pool, |
141 | (bt_object_pool_new_object_func) bt_field_wrapper_new, | |
142 | (bt_object_pool_destroy_object_func) free_field_wrapper, | |
143 | stream_class); | |
144 | if (ret) { | |
870631a2 PP |
145 | BT_LIB_LOGE_APPEND_CAUSE( |
146 | "Failed to initialize packet context field pool: ret=%d", | |
312c056a PP |
147 | ret); |
148 | goto error; | |
149 | } | |
150 | ||
862ca4ed PP |
151 | bt_object_set_parent(&stream_class->base, &tc->base); |
152 | g_ptr_array_add(tc->stream_classes, stream_class); | |
153 | bt_trace_class_freeze(tc); | |
44c440bc | 154 | BT_LIB_LOGD("Created stream class object: %!+S", stream_class); |
312c056a PP |
155 | goto end; |
156 | ||
157 | error: | |
65300d60 | 158 | BT_OBJECT_PUT_REF_AND_RESET(stream_class); |
312c056a PP |
159 | |
160 | end: | |
44c440bc | 161 | return stream_class; |
312c056a PP |
162 | } |
163 | ||
1353b066 | 164 | BT_EXPORT |
862ca4ed | 165 | struct bt_stream_class *bt_stream_class_create(struct bt_trace_class *tc) |
312c056a | 166 | { |
17f3083a | 167 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b | 168 | BT_ASSERT_PRE_TC_NON_NULL(tc); |
1778c2a4 PP |
169 | BT_ASSERT_PRE("trace-class-automatically-assigns-stream-class-ids", |
170 | tc->assigns_automatic_stream_class_id, | |
862ca4ed PP |
171 | "Trace class does not automatically assigns stream class IDs: " |
172 | "%![sc-]+T", tc); | |
173 | return create_stream_class_with_id(tc, | |
174 | (uint64_t) tc->stream_classes->len); | |
44c440bc | 175 | } |
312c056a | 176 | |
1353b066 | 177 | BT_EXPORT |
40f4ba76 | 178 | struct bt_stream_class *bt_stream_class_create_with_id( |
862ca4ed | 179 | struct bt_trace_class *tc, uint64_t id) |
44c440bc | 180 | { |
17f3083a | 181 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b | 182 | BT_ASSERT_PRE_TC_NON_NULL(tc); |
1778c2a4 PP |
183 | BT_ASSERT_PRE( |
184 | "trace-class-does-not-automatically-assigns-stream-class-ids", | |
185 | !tc->assigns_automatic_stream_class_id, | |
862ca4ed PP |
186 | "Trace class automatically assigns stream class IDs: " |
187 | "%![sc-]+T", tc); | |
188 | return create_stream_class_with_id(tc, id); | |
312c056a PP |
189 | } |
190 | ||
1353b066 | 191 | BT_EXPORT |
862ca4ed | 192 | struct bt_trace_class *bt_stream_class_borrow_trace_class( |
40f4ba76 | 193 | struct bt_stream_class *stream_class) |
11b0cdc8 | 194 | { |
d5b13b9b | 195 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
862ca4ed | 196 | return bt_stream_class_borrow_trace_class_inline(stream_class); |
11b0cdc8 JG |
197 | } |
198 | ||
1353b066 | 199 | BT_EXPORT |
862ca4ed | 200 | const struct bt_trace_class *bt_stream_class_borrow_trace_class_const( |
40f4ba76 | 201 | const struct bt_stream_class *stream_class) |
e5be10ef | 202 | { |
862ca4ed | 203 | return bt_stream_class_borrow_trace_class((void *) stream_class); |
e5be10ef PP |
204 | } |
205 | ||
1353b066 | 206 | BT_EXPORT |
40f4ba76 | 207 | const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class) |
2f100782 | 208 | { |
d5b13b9b | 209 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
44c440bc | 210 | return stream_class->name.value; |
2f100782 JG |
211 | } |
212 | ||
1353b066 | 213 | BT_EXPORT |
d24d5663 | 214 | enum bt_stream_class_set_name_status bt_stream_class_set_name( |
40f4ba76 | 215 | struct bt_stream_class *stream_class, |
3dca2276 | 216 | const char *name) |
5ca83563 | 217 | { |
17f3083a | 218 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
219 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
220 | BT_ASSERT_PRE_NAME_NON_NULL(name); | |
bdb288b3 | 221 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
44c440bc PP |
222 | g_string_assign(stream_class->name.str, name); |
223 | stream_class->name.value = stream_class->name.str->str; | |
3f7d4d90 | 224 | BT_LIB_LOGD("Set stream class's name: %!+S", stream_class); |
d24d5663 | 225 | return BT_FUNC_STATUS_OK; |
5ca83563 JG |
226 | } |
227 | ||
1353b066 | 228 | BT_EXPORT |
40f4ba76 | 229 | uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class) |
2f100782 | 230 | { |
d5b13b9b | 231 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
44c440bc | 232 | return stream_class->id; |
2f100782 JG |
233 | } |
234 | ||
1353b066 | 235 | BT_EXPORT |
44c440bc | 236 | uint64_t bt_stream_class_get_event_class_count( |
40f4ba76 | 237 | const struct bt_stream_class *stream_class) |
29664b2a | 238 | { |
d5b13b9b | 239 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
44c440bc | 240 | return (uint64_t) stream_class->event_classes->len; |
29664b2a PP |
241 | } |
242 | ||
1353b066 | 243 | BT_EXPORT |
44c440bc PP |
244 | struct bt_event_class *bt_stream_class_borrow_event_class_by_index( |
245 | struct bt_stream_class *stream_class, uint64_t index) | |
0d23acbe | 246 | { |
d5b13b9b | 247 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
bdb288b3 | 248 | BT_ASSERT_PRE_DEV_VALID_INDEX(index, stream_class->event_classes->len); |
44c440bc | 249 | return g_ptr_array_index(stream_class->event_classes, index); |
0d23acbe PP |
250 | } |
251 | ||
1353b066 | 252 | BT_EXPORT |
40f4ba76 PP |
253 | const struct bt_event_class * |
254 | bt_stream_class_borrow_event_class_by_index_const( | |
255 | const struct bt_stream_class *stream_class, uint64_t index) | |
e5be10ef | 256 | { |
40f4ba76 | 257 | return bt_stream_class_borrow_event_class_by_index( |
e5be10ef PP |
258 | (void *) stream_class, index); |
259 | } | |
260 | ||
1353b066 | 261 | BT_EXPORT |
44c440bc | 262 | struct bt_event_class *bt_stream_class_borrow_event_class_by_id( |
e5be10ef | 263 | struct bt_stream_class *stream_class, uint64_t id) |
11b0cdc8 | 264 | { |
44c440bc PP |
265 | struct bt_event_class *event_class = NULL; |
266 | uint64_t i; | |
0b9ce69f | 267 | |
d5b13b9b | 268 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
11b0cdc8 | 269 | |
e5be10ef | 270 | for (i = 0; i < stream_class->event_classes->len; i++) { |
44c440bc | 271 | struct bt_event_class *event_class_candidate = |
e5be10ef | 272 | g_ptr_array_index(stream_class->event_classes, i); |
e6a8e8e4 | 273 | |
44c440bc PP |
274 | if (event_class_candidate->id == id) { |
275 | event_class = event_class_candidate; | |
09840de5 PP |
276 | goto end; |
277 | } | |
69dc4535 JG |
278 | } |
279 | ||
69dc4535 | 280 | end: |
44c440bc | 281 | return event_class; |
0863f950 PP |
282 | } |
283 | ||
1353b066 | 284 | BT_EXPORT |
40f4ba76 PP |
285 | const struct bt_event_class * |
286 | bt_stream_class_borrow_event_class_by_id_const( | |
287 | const struct bt_stream_class *stream_class, uint64_t id) | |
e5be10ef | 288 | { |
40f4ba76 | 289 | return bt_stream_class_borrow_event_class_by_id( |
e5be10ef PP |
290 | (void *) stream_class, id); |
291 | } | |
292 | ||
1353b066 | 293 | BT_EXPORT |
40f4ba76 PP |
294 | const struct bt_field_class * |
295 | bt_stream_class_borrow_packet_context_field_class_const( | |
296 | const struct bt_stream_class *stream_class) | |
12c8a1a3 | 297 | { |
d5b13b9b | 298 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
5cd6d0e5 | 299 | return stream_class->packet_context_fc; |
12c8a1a3 JG |
300 | } |
301 | ||
1353b066 | 302 | BT_EXPORT |
740faaf4 PP |
303 | struct bt_field_class * |
304 | bt_stream_class_borrow_packet_context_field_class( | |
305 | struct bt_stream_class *stream_class) | |
306 | { | |
d5b13b9b | 307 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
740faaf4 PP |
308 | return stream_class->packet_context_fc; |
309 | } | |
310 | ||
1353b066 | 311 | BT_EXPORT |
d24d5663 PP |
312 | enum bt_stream_class_set_field_class_status |
313 | bt_stream_class_set_packet_context_field_class( | |
40f4ba76 PP |
314 | struct bt_stream_class *stream_class, |
315 | struct bt_field_class *field_class) | |
12c8a1a3 | 316 | { |
44c440bc PP |
317 | int ret; |
318 | struct bt_resolve_field_path_context resolve_ctx = { | |
5cd6d0e5 | 319 | .packet_context = field_class, |
44c440bc PP |
320 | .event_common_context = NULL, |
321 | .event_specific_context = NULL, | |
322 | .event_payload = NULL, | |
323 | }; | |
cb6f1f7d | 324 | |
17f3083a | 325 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b | 326 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
1778c2a4 PP |
327 | BT_ASSERT_PRE("supports-packets", |
328 | stream_class->supports_packets, | |
26fc5aed PP |
329 | "Stream class does not support packets: %![sc-]+S", |
330 | stream_class); | |
d5b13b9b | 331 | BT_ASSERT_PRE_FC_NON_NULL(field_class); |
bdb288b3 | 332 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
1778c2a4 PP |
333 | BT_ASSERT_PRE_FC_IS_STRUCT("field-class", field_class, |
334 | "Packet context field class"); | |
335 | ret = bt_resolve_field_paths(field_class, &resolve_ctx, __func__); | |
44c440bc | 336 | if (ret) { |
a6ae8edc PP |
337 | /* |
338 | * This is the only reason for which | |
339 | * bt_resolve_field_paths() can fail: anything else | |
340 | * would be because a precondition is not satisfied. | |
341 | */ | |
d24d5663 | 342 | ret = BT_FUNC_STATUS_MEMORY_ERROR; |
cb6f1f7d PP |
343 | goto end; |
344 | } | |
345 | ||
862ca4ed | 346 | bt_field_class_make_part_of_trace_class(field_class); |
65300d60 | 347 | bt_object_put_ref(stream_class->packet_context_fc); |
398454ed | 348 | stream_class->packet_context_fc = field_class; |
6871026b | 349 | bt_object_get_ref_no_null_check(stream_class->packet_context_fc); |
5cd6d0e5 | 350 | bt_field_class_freeze(field_class); |
3f7d4d90 | 351 | BT_LIB_LOGD("Set stream class's packet context field class: %!+S", |
44c440bc | 352 | stream_class); |
cb6f1f7d PP |
353 | |
354 | end: | |
355 | return ret; | |
12c8a1a3 JG |
356 | } |
357 | ||
1353b066 | 358 | BT_EXPORT |
40f4ba76 PP |
359 | const struct bt_field_class * |
360 | bt_stream_class_borrow_event_common_context_field_class_const( | |
361 | const struct bt_stream_class *stream_class) | |
af181248 | 362 | { |
d5b13b9b | 363 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
5cd6d0e5 | 364 | return stream_class->event_common_context_fc; |
af181248 JG |
365 | } |
366 | ||
1353b066 | 367 | BT_EXPORT |
740faaf4 PP |
368 | struct bt_field_class * |
369 | bt_stream_class_borrow_event_common_context_field_class( | |
370 | struct bt_stream_class *stream_class) | |
371 | { | |
d5b13b9b | 372 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
740faaf4 PP |
373 | return stream_class->event_common_context_fc; |
374 | } | |
375 | ||
1353b066 | 376 | BT_EXPORT |
d24d5663 | 377 | enum bt_stream_class_set_field_class_status |
a6ae8edc | 378 | bt_stream_class_set_event_common_context_field_class( |
40f4ba76 PP |
379 | struct bt_stream_class *stream_class, |
380 | struct bt_field_class *field_class) | |
af181248 | 381 | { |
44c440bc PP |
382 | int ret; |
383 | struct bt_resolve_field_path_context resolve_ctx = { | |
44c440bc | 384 | .packet_context = NULL, |
5cd6d0e5 | 385 | .event_common_context = field_class, |
44c440bc PP |
386 | .event_specific_context = NULL, |
387 | .event_payload = NULL, | |
388 | }; | |
cb6f1f7d | 389 | |
17f3083a | 390 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
391 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
392 | BT_ASSERT_PRE_FC_NON_NULL(field_class); | |
bdb288b3 | 393 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
1778c2a4 | 394 | BT_ASSERT_PRE_FC_IS_STRUCT("field-class", field_class, |
d5b13b9b | 395 | "Event common context field class"); |
5cd6d0e5 | 396 | resolve_ctx.packet_context = stream_class->packet_context_fc; |
1778c2a4 | 397 | ret = bt_resolve_field_paths(field_class, &resolve_ctx, __func__); |
44c440bc | 398 | if (ret) { |
a6ae8edc PP |
399 | /* |
400 | * This is the only reason for which | |
401 | * bt_resolve_field_paths() can fail: anything else | |
402 | * would be because a precondition is not satisfied. | |
403 | */ | |
d24d5663 | 404 | ret = BT_FUNC_STATUS_MEMORY_ERROR; |
cb6f1f7d PP |
405 | goto end; |
406 | } | |
407 | ||
862ca4ed | 408 | bt_field_class_make_part_of_trace_class(field_class); |
65300d60 | 409 | bt_object_put_ref(stream_class->event_common_context_fc); |
398454ed | 410 | stream_class->event_common_context_fc = field_class; |
6871026b | 411 | bt_object_get_ref_no_null_check(stream_class->event_common_context_fc); |
5cd6d0e5 | 412 | bt_field_class_freeze(field_class); |
3f7d4d90 | 413 | BT_LIB_LOGD("Set stream class's event common context field class: %!+S", |
44c440bc | 414 | stream_class); |
cb6f1f7d | 415 | |
cb6f1f7d PP |
416 | end: |
417 | return ret; | |
11b0cdc8 JG |
418 | } |
419 | ||
40f4ba76 | 420 | void _bt_stream_class_freeze(const struct bt_stream_class *stream_class) |
8bf65fbd | 421 | { |
5cd6d0e5 | 422 | /* The field classes and default clock class are already frozen */ |
44c440bc | 423 | BT_ASSERT(stream_class); |
c6962c96 PP |
424 | BT_LIB_LOGD("Freezing stream class's user attributes: %!+v", |
425 | stream_class->user_attributes); | |
426 | bt_value_freeze(stream_class->user_attributes); | |
44c440bc | 427 | BT_LIB_LOGD("Freezing stream class: %!+S", stream_class); |
40f4ba76 | 428 | ((struct bt_stream_class *) stream_class)->frozen = true; |
8bf65fbd JG |
429 | } |
430 | ||
1353b066 | 431 | BT_EXPORT |
d24d5663 PP |
432 | enum bt_stream_class_set_default_clock_class_status |
433 | bt_stream_class_set_default_clock_class( | |
40f4ba76 | 434 | struct bt_stream_class *stream_class, |
44c440bc | 435 | struct bt_clock_class *clock_class) |
8bf65fbd | 436 | { |
17f3083a | 437 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
438 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
439 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); | |
bdb288b3 | 440 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
65300d60 | 441 | bt_object_put_ref(stream_class->default_clock_class); |
398454ed | 442 | stream_class->default_clock_class = clock_class; |
6871026b | 443 | bt_object_get_ref_no_null_check(stream_class->default_clock_class); |
44c440bc | 444 | bt_clock_class_freeze(clock_class); |
3f7d4d90 | 445 | BT_LIB_LOGD("Set stream class's default clock class: %!+S", |
44c440bc | 446 | stream_class); |
d24d5663 | 447 | return BT_FUNC_STATUS_OK; |
8bf65fbd JG |
448 | } |
449 | ||
1353b066 | 450 | BT_EXPORT |
44c440bc PP |
451 | struct bt_clock_class *bt_stream_class_borrow_default_clock_class( |
452 | struct bt_stream_class *stream_class) | |
8bf65fbd | 453 | { |
d5b13b9b | 454 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
44c440bc PP |
455 | return stream_class->default_clock_class; |
456 | } | |
8bf65fbd | 457 | |
1353b066 | 458 | BT_EXPORT |
40f4ba76 PP |
459 | const struct bt_clock_class *bt_stream_class_borrow_default_clock_class_const( |
460 | const struct bt_stream_class *stream_class) | |
461 | { | |
d5b13b9b | 462 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
40f4ba76 PP |
463 | return stream_class->default_clock_class; |
464 | } | |
465 | ||
1353b066 | 466 | BT_EXPORT |
44c440bc | 467 | bt_bool bt_stream_class_assigns_automatic_event_class_id( |
40f4ba76 | 468 | const struct bt_stream_class *stream_class) |
44c440bc | 469 | { |
d5b13b9b | 470 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
44c440bc | 471 | return (bt_bool) stream_class->assigns_automatic_event_class_id; |
8bf65fbd JG |
472 | } |
473 | ||
1353b066 | 474 | BT_EXPORT |
40f4ba76 PP |
475 | void bt_stream_class_set_assigns_automatic_event_class_id( |
476 | struct bt_stream_class *stream_class, | |
e5be10ef | 477 | bt_bool value) |
8bf65fbd | 478 | { |
d5b13b9b | 479 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
bdb288b3 | 480 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
44c440bc | 481 | stream_class->assigns_automatic_event_class_id = (bool) value; |
3f7d4d90 | 482 | BT_LIB_LOGD("Set stream class's automatic event class ID " |
44c440bc | 483 | "assignment property: %!+S", stream_class); |
44c440bc | 484 | } |
8bf65fbd | 485 | |
1353b066 | 486 | BT_EXPORT |
44c440bc | 487 | bt_bool bt_stream_class_assigns_automatic_stream_id( |
40f4ba76 | 488 | const struct bt_stream_class *stream_class) |
44c440bc | 489 | { |
d5b13b9b | 490 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
44c440bc PP |
491 | return (bt_bool) stream_class->assigns_automatic_stream_id; |
492 | } | |
8bf65fbd | 493 | |
1353b066 | 494 | BT_EXPORT |
2e90378a PP |
495 | void bt_stream_class_set_supports_discarded_events( |
496 | struct bt_stream_class *stream_class, | |
497 | bt_bool supports_discarded_events, | |
498 | bt_bool with_default_clock_snapshots) | |
499 | { | |
d5b13b9b | 500 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
bdb288b3 | 501 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
1778c2a4 PP |
502 | BT_ASSERT_PRE("supports-discarded-events-for-default-clock-snapshots", |
503 | supports_discarded_events || | |
504 | !with_default_clock_snapshots, | |
2e90378a PP |
505 | "Discarded events cannot have default clock snapshots when " |
506 | "not supported: %!+S", stream_class); | |
1778c2a4 PP |
507 | BT_ASSERT_PRE("has-default-clock-class-for-default-clock-snapshots", |
508 | !with_default_clock_snapshots || | |
509 | stream_class->default_clock_class, | |
2e90378a PP |
510 | "Stream class has no default clock class: %!+S", stream_class); |
511 | stream_class->supports_discarded_events = | |
512 | (bool) supports_discarded_events; | |
513 | stream_class->discarded_events_have_default_clock_snapshots = | |
514 | (bool) with_default_clock_snapshots; | |
3f7d4d90 | 515 | BT_LIB_LOGD("Set stream class's discarded events support property: " |
2e90378a PP |
516 | "%!+S", stream_class); |
517 | } | |
518 | ||
1353b066 | 519 | BT_EXPORT |
2e90378a PP |
520 | bt_bool bt_stream_class_supports_discarded_events( |
521 | const struct bt_stream_class *stream_class) | |
522 | { | |
d5b13b9b | 523 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
2e90378a PP |
524 | return (bt_bool) stream_class->supports_discarded_events; |
525 | } | |
526 | ||
1353b066 | 527 | BT_EXPORT |
2e90378a PP |
528 | bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots( |
529 | const struct bt_stream_class *stream_class) | |
530 | { | |
d5b13b9b | 531 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
2e90378a PP |
532 | return (bt_bool) stream_class->discarded_events_have_default_clock_snapshots; |
533 | } | |
534 | ||
1353b066 | 535 | BT_EXPORT |
2e90378a PP |
536 | void bt_stream_class_set_supports_discarded_packets( |
537 | struct bt_stream_class *stream_class, | |
538 | bt_bool supports_discarded_packets, | |
539 | bt_bool with_default_clock_snapshots) | |
540 | { | |
d5b13b9b | 541 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
bdb288b3 | 542 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
1778c2a4 PP |
543 | BT_ASSERT_PRE("supports-packets-for-discarded-packets-support", |
544 | !supports_discarded_packets || | |
545 | stream_class->supports_packets, | |
26fc5aed PP |
546 | "Stream class does not support packets: %!+S", |
547 | stream_class); | |
1778c2a4 PP |
548 | BT_ASSERT_PRE("supports-discarded-packets-for-default-clock-snapshots", |
549 | supports_discarded_packets || | |
550 | !with_default_clock_snapshots, | |
2e90378a PP |
551 | "Discarded packets cannot have default clock snapshots when " |
552 | "not supported: %!+S", stream_class); | |
1778c2a4 PP |
553 | BT_ASSERT_PRE("has-default-clock-class-for-default-clock-snapshots", |
554 | !with_default_clock_snapshots || | |
555 | stream_class->default_clock_class, | |
2e90378a PP |
556 | "Stream class has no default clock class: %!+S", stream_class); |
557 | stream_class->supports_discarded_packets = | |
558 | (bool) supports_discarded_packets; | |
559 | stream_class->discarded_packets_have_default_clock_snapshots = | |
560 | (bool) with_default_clock_snapshots; | |
3f7d4d90 | 561 | BT_LIB_LOGD("Set stream class's discarded packets support property: " |
2e90378a PP |
562 | "%!+S", stream_class); |
563 | } | |
564 | ||
1353b066 | 565 | BT_EXPORT |
2e90378a PP |
566 | bt_bool bt_stream_class_supports_discarded_packets( |
567 | const struct bt_stream_class *stream_class) | |
568 | { | |
d5b13b9b | 569 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
2e90378a PP |
570 | return (bt_bool) stream_class->supports_discarded_packets; |
571 | } | |
572 | ||
1353b066 | 573 | BT_EXPORT |
2e90378a PP |
574 | bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots( |
575 | const struct bt_stream_class *stream_class) | |
576 | { | |
d5b13b9b | 577 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
2e90378a PP |
578 | return (bt_bool) stream_class->discarded_packets_have_default_clock_snapshots; |
579 | } | |
580 | ||
1353b066 | 581 | BT_EXPORT |
26fc5aed PP |
582 | void bt_stream_class_set_supports_packets( |
583 | struct bt_stream_class *stream_class, | |
584 | bt_bool supports_packets, | |
585 | bt_bool with_beginning_default_clock_snapshot, | |
586 | bt_bool with_end_default_clock_snapshot) | |
587 | { | |
588 | bt_bool with_default_clock_snapshot = | |
589 | with_beginning_default_clock_snapshot || | |
590 | with_end_default_clock_snapshot; | |
d5b13b9b | 591 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
bdb288b3 | 592 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
1778c2a4 PP |
593 | BT_ASSERT_PRE("supports-packets-for-default-clock-snapshot", |
594 | supports_packets || | |
595 | !with_default_clock_snapshot, | |
26fc5aed PP |
596 | "Packets cannot have default clock snapshots when " |
597 | "not supported: %!+S", stream_class); | |
1778c2a4 PP |
598 | BT_ASSERT_PRE("has-default-clock-class-for-default-clock-snapshot", |
599 | !with_default_clock_snapshot || | |
600 | stream_class->default_clock_class, | |
26fc5aed | 601 | "Stream class has no default clock class: %!+S", stream_class); |
1778c2a4 PP |
602 | BT_ASSERT_PRE("supports-packets-for-packet-context-field-class", |
603 | supports_packets || !stream_class->packet_context_fc, | |
26fc5aed PP |
604 | "Stream class already has a packet context field class: %!+S", |
605 | stream_class); | |
1778c2a4 PP |
606 | BT_ASSERT_PRE("supports-packets-for-discarded-packets-support", |
607 | supports_packets || !stream_class->supports_discarded_packets, | |
26fc5aed PP |
608 | "Stream class already supports discarded packets: %!+S", |
609 | stream_class); | |
610 | stream_class->supports_packets = (bool) supports_packets; | |
611 | stream_class->packets_have_beginning_default_clock_snapshot = | |
612 | (bool) with_beginning_default_clock_snapshot; | |
613 | stream_class->packets_have_end_default_clock_snapshot = | |
614 | (bool) with_end_default_clock_snapshot; | |
615 | BT_LIB_LOGD("Set stream class's packets support property: %!+S", | |
616 | stream_class); | |
617 | } | |
618 | ||
1353b066 | 619 | BT_EXPORT |
26fc5aed PP |
620 | bt_bool bt_stream_class_supports_packets( |
621 | const struct bt_stream_class *stream_class) | |
622 | { | |
d5b13b9b | 623 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
26fc5aed PP |
624 | return (bt_bool) stream_class->supports_packets; |
625 | } | |
626 | ||
1353b066 | 627 | BT_EXPORT |
26fc5aed PP |
628 | bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot( |
629 | const struct bt_stream_class *stream_class) | |
630 | { | |
d5b13b9b | 631 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
26fc5aed PP |
632 | return (bt_bool) stream_class->packets_have_beginning_default_clock_snapshot; |
633 | } | |
634 | ||
1353b066 | 635 | BT_EXPORT |
26fc5aed PP |
636 | bt_bool bt_stream_class_packets_have_end_default_clock_snapshot( |
637 | const struct bt_stream_class *stream_class) | |
638 | { | |
d5b13b9b | 639 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
26fc5aed PP |
640 | return (bt_bool) stream_class->packets_have_end_default_clock_snapshot; |
641 | } | |
642 | ||
1353b066 | 643 | BT_EXPORT |
40f4ba76 PP |
644 | void bt_stream_class_set_assigns_automatic_stream_id( |
645 | struct bt_stream_class *stream_class, | |
e5be10ef | 646 | bt_bool value) |
44c440bc | 647 | { |
d5b13b9b | 648 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
bdb288b3 | 649 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
44c440bc | 650 | stream_class->assigns_automatic_stream_id = (bool) value; |
3f7d4d90 | 651 | BT_LIB_LOGD("Set stream class's automatic stream ID " |
44c440bc | 652 | "assignment property: %!+S", stream_class); |
44c440bc | 653 | } |
3dca2276 | 654 | |
1353b066 | 655 | BT_EXPORT |
c6962c96 PP |
656 | const struct bt_value *bt_stream_class_borrow_user_attributes_const( |
657 | const struct bt_stream_class *stream_class) | |
658 | { | |
d5b13b9b | 659 | BT_ASSERT_PRE_DEV_SC_NON_NULL(stream_class); |
c6962c96 PP |
660 | return stream_class->user_attributes; |
661 | } | |
662 | ||
1353b066 | 663 | BT_EXPORT |
c6962c96 PP |
664 | struct bt_value *bt_stream_class_borrow_user_attributes( |
665 | struct bt_stream_class *stream_class) | |
666 | { | |
667 | return (void *) bt_stream_class_borrow_user_attributes_const( | |
668 | (void *) stream_class); | |
669 | } | |
670 | ||
1353b066 | 671 | BT_EXPORT |
c6962c96 PP |
672 | void bt_stream_class_set_user_attributes( |
673 | struct bt_stream_class *stream_class, | |
674 | const struct bt_value *user_attributes) | |
675 | { | |
d5b13b9b PP |
676 | BT_ASSERT_PRE_SC_NON_NULL(stream_class); |
677 | BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes); | |
678 | BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes); | |
c6962c96 | 679 | BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class); |
6871026b | 680 | bt_object_put_ref_no_null_check(stream_class->user_attributes); |
c6962c96 | 681 | stream_class->user_attributes = (void *) user_attributes; |
6871026b | 682 | bt_object_get_ref_no_null_check(stream_class->user_attributes); |
c6962c96 PP |
683 | } |
684 | ||
1353b066 | 685 | BT_EXPORT |
c5b9b441 PP |
686 | void bt_stream_class_get_ref(const struct bt_stream_class *stream_class) |
687 | { | |
688 | bt_object_get_ref(stream_class); | |
689 | } | |
690 | ||
1353b066 | 691 | BT_EXPORT |
c5b9b441 PP |
692 | void bt_stream_class_put_ref(const struct bt_stream_class *stream_class) |
693 | { | |
694 | bt_object_put_ref(stream_class); | |
695 | } |