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