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