2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "STREAM-CLASS"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/trace-ir/clock-class-internal.h>
29 #include <babeltrace/trace-ir/event-class-internal.h>
30 #include <babeltrace/trace-ir/field-class-internal.h>
31 #include <babeltrace/trace-ir/field-internal.h>
32 #include <babeltrace/trace-ir/stream-class-internal.h>
33 #include <babeltrace/trace-ir/trace-const.h>
34 #include <babeltrace/trace-ir/trace-internal.h>
35 #include <babeltrace/trace-ir/utils-internal.h>
36 #include <babeltrace/trace-ir/field-wrapper-internal.h>
37 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
38 #include <babeltrace/compiler-internal.h>
39 #include <babeltrace/align-internal.h>
40 #include <babeltrace/endian-internal.h>
41 #include <babeltrace/assert-internal.h>
42 #include <babeltrace/property-internal.h>
47 #define BT_ASSERT_PRE_STREAM_CLASS_HOT(_sc) \
48 BT_ASSERT_PRE_HOT((_sc), "Stream class", ": %!+S", (_sc))
51 void destroy_stream_class(struct bt_object
*obj
)
53 struct bt_stream_class
*stream_class
= (void *) obj
;
55 BT_LIB_LOGD("Destroying stream class: %!+S", stream_class
);
56 BT_LOGD_STR("Putting default clock class.");
57 BT_OBJECT_PUT_REF_AND_RESET(stream_class
->default_clock_class
);
59 if (stream_class
->event_classes
) {
60 BT_LOGD_STR("Destroying event classes.");
61 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
62 stream_class
->event_classes
= NULL
;
65 if (stream_class
->name
.str
) {
66 g_string_free(stream_class
->name
.str
, TRUE
);
67 stream_class
->name
.str
= NULL
;
68 stream_class
->name
.value
= NULL
;
71 BT_LOGD_STR("Putting event header field class.");
72 BT_OBJECT_PUT_REF_AND_RESET(stream_class
->event_header_fc
);
73 BT_LOGD_STR("Putting packet context field class.");
74 BT_OBJECT_PUT_REF_AND_RESET(stream_class
->packet_context_fc
);
75 BT_LOGD_STR("Putting event common context field class.");
76 BT_OBJECT_PUT_REF_AND_RESET(stream_class
->event_common_context_fc
);
77 bt_object_pool_finalize(&stream_class
->event_header_field_pool
);
78 bt_object_pool_finalize(&stream_class
->packet_context_field_pool
);
83 void free_field_wrapper(struct bt_field_wrapper
*field_wrapper
,
84 struct bt_stream_class
*stream_class
)
86 bt_field_wrapper_destroy((void *) field_wrapper
);
91 bool stream_class_id_is_unique(const struct bt_trace_class
*tc
, uint64_t id
)
94 bool is_unique
= true;
96 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
97 const struct bt_stream_class
*sc
=
98 tc
->stream_classes
->pdata
[i
];
111 struct bt_stream_class
*create_stream_class_with_id(
112 struct bt_trace_class
*tc
, uint64_t id
)
114 struct bt_stream_class
*stream_class
= NULL
;
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
,
122 stream_class
= g_new0(struct bt_stream_class
, 1);
124 BT_LOGE_STR("Failed to allocate one stream class.");
128 bt_object_init_shared_with_parent(&stream_class
->base
,
129 destroy_stream_class
);
131 stream_class
->name
.str
= g_string_new(NULL
);
132 if (!stream_class
->name
.str
) {
133 BT_LOGE_STR("Failed to allocate a GString.");
138 stream_class
->id
= id
;
139 stream_class
->assigns_automatic_event_class_id
= true;
140 stream_class
->assigns_automatic_stream_id
= true;
141 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
142 (GDestroyNotify
) bt_object_try_spec_release
);
143 if (!stream_class
->event_classes
) {
144 BT_LOGE_STR("Failed to allocate a GPtrArray.");
148 ret
= bt_object_pool_initialize(&stream_class
->event_header_field_pool
,
149 (bt_object_pool_new_object_func
) bt_field_wrapper_new
,
150 (bt_object_pool_destroy_object_func
) free_field_wrapper
,
153 BT_LOGE("Failed to initialize event header field pool: ret=%d",
158 ret
= bt_object_pool_initialize(&stream_class
->packet_context_field_pool
,
159 (bt_object_pool_new_object_func
) bt_field_wrapper_new
,
160 (bt_object_pool_destroy_object_func
) free_field_wrapper
,
163 BT_LOGE("Failed to initialize packet context field pool: ret=%d",
168 bt_object_set_parent(&stream_class
->base
, &tc
->base
);
169 g_ptr_array_add(tc
->stream_classes
, stream_class
);
170 bt_trace_class_freeze(tc
);
171 BT_LIB_LOGD("Created stream class object: %!+S", stream_class
);
175 BT_OBJECT_PUT_REF_AND_RESET(stream_class
);
181 struct bt_stream_class
*bt_stream_class_create(struct bt_trace_class
*tc
)
183 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
184 BT_ASSERT_PRE(tc
->assigns_automatic_stream_class_id
,
185 "Trace class does not automatically assigns stream class IDs: "
187 return create_stream_class_with_id(tc
,
188 (uint64_t) tc
->stream_classes
->len
);
191 struct bt_stream_class
*bt_stream_class_create_with_id(
192 struct bt_trace_class
*tc
, uint64_t id
)
194 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
195 BT_ASSERT_PRE(!tc
->assigns_automatic_stream_class_id
,
196 "Trace class automatically assigns stream class IDs: "
198 return create_stream_class_with_id(tc
, id
);
201 struct bt_trace_class
*bt_stream_class_borrow_trace_class(
202 struct bt_stream_class
*stream_class
)
204 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
205 return bt_stream_class_borrow_trace_class_inline(stream_class
);
208 const struct bt_trace_class
*bt_stream_class_borrow_trace_class_const(
209 const struct bt_stream_class
*stream_class
)
211 return bt_stream_class_borrow_trace_class((void *) stream_class
);
214 const char *bt_stream_class_get_name(const struct bt_stream_class
*stream_class
)
216 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
217 return stream_class
->name
.value
;
220 enum bt_stream_class_status
bt_stream_class_set_name(
221 struct bt_stream_class
*stream_class
,
224 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
225 BT_ASSERT_PRE_NON_NULL(name
, "Name");
226 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
227 g_string_assign(stream_class
->name
.str
, name
);
228 stream_class
->name
.value
= stream_class
->name
.str
->str
;
229 BT_LIB_LOGV("Set stream class's name: %!+S", stream_class
);
230 return BT_STREAM_CLASS_STATUS_OK
;
233 uint64_t bt_stream_class_get_id(const struct bt_stream_class
*stream_class
)
235 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
236 return stream_class
->id
;
239 uint64_t bt_stream_class_get_event_class_count(
240 const struct bt_stream_class
*stream_class
)
242 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
243 return (uint64_t) stream_class
->event_classes
->len
;
246 struct bt_event_class
*bt_stream_class_borrow_event_class_by_index(
247 struct bt_stream_class
*stream_class
, uint64_t index
)
249 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
250 BT_ASSERT_PRE_VALID_INDEX(index
, stream_class
->event_classes
->len
);
251 return g_ptr_array_index(stream_class
->event_classes
, index
);
254 const struct bt_event_class
*
255 bt_stream_class_borrow_event_class_by_index_const(
256 const struct bt_stream_class
*stream_class
, uint64_t index
)
258 return bt_stream_class_borrow_event_class_by_index(
259 (void *) stream_class
, index
);
262 struct bt_event_class
*bt_stream_class_borrow_event_class_by_id(
263 struct bt_stream_class
*stream_class
, uint64_t id
)
265 struct bt_event_class
*event_class
= NULL
;
268 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
270 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
271 struct bt_event_class
*event_class_candidate
=
272 g_ptr_array_index(stream_class
->event_classes
, i
);
274 if (event_class_candidate
->id
== id
) {
275 event_class
= event_class_candidate
;
284 const struct bt_event_class
*
285 bt_stream_class_borrow_event_class_by_id_const(
286 const struct bt_stream_class
*stream_class
, uint64_t id
)
288 return bt_stream_class_borrow_event_class_by_id(
289 (void *) stream_class
, id
);
292 const struct bt_field_class
*
293 bt_stream_class_borrow_packet_context_field_class_const(
294 const struct bt_stream_class
*stream_class
)
296 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
297 return stream_class
->packet_context_fc
;
300 enum bt_stream_class_status
bt_stream_class_set_packet_context_field_class(
301 struct bt_stream_class
*stream_class
,
302 struct bt_field_class
*field_class
)
305 struct bt_resolve_field_path_context resolve_ctx
= {
306 .packet_header
= NULL
,
307 .packet_context
= field_class
,
308 .event_header
= NULL
,
309 .event_common_context
= NULL
,
310 .event_specific_context
= NULL
,
311 .event_payload
= NULL
,
314 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
315 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
316 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
317 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
318 BT_FIELD_CLASS_TYPE_STRUCTURE
,
319 "Packet context field class is not a structure field class: %!+F",
321 resolve_ctx
.packet_header
=
322 bt_stream_class_borrow_trace_class_inline(stream_class
)->packet_header_fc
;
323 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
326 * This is the only reason for which
327 * bt_resolve_field_paths() can fail: anything else
328 * would be because a precondition is not satisfied.
330 ret
= BT_STREAM_CLASS_STATUS_NOMEM
;
334 bt_field_class_make_part_of_trace_class(field_class
);
335 bt_object_put_ref(stream_class
->packet_context_fc
);
336 stream_class
->packet_context_fc
= field_class
;
337 bt_object_get_no_null_check(stream_class
->packet_context_fc
);
338 bt_field_class_freeze(field_class
);
339 BT_LIB_LOGV("Set stream class's packet context field class: %!+S",
346 const struct bt_field_class
*bt_stream_class_borrow_event_header_field_class_const(
347 const struct bt_stream_class
*stream_class
)
349 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
350 return stream_class
->event_header_fc
;
353 enum bt_stream_class_status
bt_stream_class_set_event_header_field_class(
354 struct bt_stream_class
*stream_class
,
355 struct bt_field_class
*field_class
)
358 struct bt_resolve_field_path_context resolve_ctx
= {
359 .packet_header
= NULL
,
360 .packet_context
= NULL
,
361 .event_header
= field_class
,
362 .event_common_context
= NULL
,
363 .event_specific_context
= NULL
,
364 .event_payload
= NULL
,
367 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
368 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
369 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
370 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
371 BT_FIELD_CLASS_TYPE_STRUCTURE
,
372 "Event header field class is not a structure field class: %!+F",
374 resolve_ctx
.packet_header
=
375 bt_stream_class_borrow_trace_class_inline(stream_class
)->packet_header_fc
;
376 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
377 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
380 * This is the only reason for which
381 * bt_resolve_field_paths() can fail: anything else
382 * would be because a precondition is not satisfied.
384 ret
= BT_STREAM_CLASS_STATUS_NOMEM
;
388 bt_field_class_make_part_of_trace_class(field_class
);
389 bt_object_put_ref(stream_class
->event_header_fc
);
390 stream_class
->event_header_fc
= field_class
;
391 bt_object_get_no_null_check(stream_class
->event_header_fc
);
392 bt_field_class_freeze(field_class
);
393 BT_LIB_LOGV("Set stream class's event header field class: %!+S",
400 const struct bt_field_class
*
401 bt_stream_class_borrow_event_common_context_field_class_const(
402 const struct bt_stream_class
*stream_class
)
404 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
405 return stream_class
->event_common_context_fc
;
408 enum bt_stream_class_status
409 bt_stream_class_set_event_common_context_field_class(
410 struct bt_stream_class
*stream_class
,
411 struct bt_field_class
*field_class
)
414 struct bt_resolve_field_path_context resolve_ctx
= {
415 .packet_header
= NULL
,
416 .packet_context
= NULL
,
417 .event_header
= NULL
,
418 .event_common_context
= field_class
,
419 .event_specific_context
= NULL
,
420 .event_payload
= NULL
,
423 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
424 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
425 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
426 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
427 BT_FIELD_CLASS_TYPE_STRUCTURE
,
428 "Event common context field class is not a structure field class: %!+F",
430 resolve_ctx
.packet_header
=
431 bt_stream_class_borrow_trace_class_inline(stream_class
)->packet_header_fc
;
432 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
433 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
434 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
437 * This is the only reason for which
438 * bt_resolve_field_paths() can fail: anything else
439 * would be because a precondition is not satisfied.
441 ret
= BT_STREAM_CLASS_STATUS_NOMEM
;
445 bt_field_class_make_part_of_trace_class(field_class
);
446 bt_object_put_ref(stream_class
->event_common_context_fc
);
447 stream_class
->event_common_context_fc
= field_class
;
448 bt_object_get_no_null_check(stream_class
->event_common_context_fc
);
449 bt_field_class_freeze(field_class
);
450 BT_LIB_LOGV("Set stream class's event common context field class: %!+S",
458 void _bt_stream_class_freeze(const struct bt_stream_class
*stream_class
)
460 /* The field classes and default clock class are already frozen */
461 BT_ASSERT(stream_class
);
462 BT_LIB_LOGD("Freezing stream class: %!+S", stream_class
);
463 ((struct bt_stream_class
*) stream_class
)->frozen
= true;
466 enum bt_stream_class_status
bt_stream_class_set_default_clock_class(
467 struct bt_stream_class
*stream_class
,
468 struct bt_clock_class
*clock_class
)
470 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
471 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
472 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
473 bt_object_put_ref(stream_class
->default_clock_class
);
474 stream_class
->default_clock_class
= clock_class
;
475 bt_object_get_no_null_check(stream_class
->default_clock_class
);
476 bt_clock_class_freeze(clock_class
);
477 BT_LIB_LOGV("Set stream class's default clock class: %!+S",
479 return BT_STREAM_CLASS_STATUS_OK
;
482 struct bt_clock_class
*bt_stream_class_borrow_default_clock_class(
483 struct bt_stream_class
*stream_class
)
485 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
486 return stream_class
->default_clock_class
;
489 const struct bt_clock_class
*bt_stream_class_borrow_default_clock_class_const(
490 const struct bt_stream_class
*stream_class
)
492 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
493 return stream_class
->default_clock_class
;
496 bt_bool
bt_stream_class_assigns_automatic_event_class_id(
497 const struct bt_stream_class
*stream_class
)
499 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
500 return (bt_bool
) stream_class
->assigns_automatic_event_class_id
;
503 void bt_stream_class_set_assigns_automatic_event_class_id(
504 struct bt_stream_class
*stream_class
,
507 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
508 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
509 stream_class
->assigns_automatic_event_class_id
= (bool) value
;
510 BT_LIB_LOGV("Set stream class's automatic event class ID "
511 "assignment property: %!+S", stream_class
);
514 bt_bool
bt_stream_class_assigns_automatic_stream_id(
515 const struct bt_stream_class
*stream_class
)
517 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
518 return (bt_bool
) stream_class
->assigns_automatic_stream_id
;
521 void bt_stream_class_set_assigns_automatic_stream_id(
522 struct bt_stream_class
*stream_class
,
525 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
526 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
527 stream_class
->assigns_automatic_stream_id
= (bool) value
;
528 BT_LIB_LOGV("Set stream class's automatic stream ID "
529 "assignment property: %!+S", stream_class
);
532 bt_bool
bt_stream_class_packets_have_discarded_event_counter_snapshot(
533 const struct bt_stream_class
*stream_class
)
535 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
536 return (bt_bool
) stream_class
->packets_have_discarded_event_counter_snapshot
;
539 void bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
540 struct bt_stream_class
*stream_class
,
543 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
544 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
545 stream_class
->packets_have_discarded_event_counter_snapshot
=
547 BT_LIB_LOGV("Set stream class's "
548 "\"packets have discarded event counter snapshot\" property: "
549 "%!+S", stream_class
);
552 bt_bool
bt_stream_class_packets_have_packet_counter_snapshot(
553 const struct bt_stream_class
*stream_class
)
555 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
556 return (bt_bool
) stream_class
->packets_have_packet_counter_snapshot
;
559 void bt_stream_class_set_packets_have_packet_counter_snapshot(
560 struct bt_stream_class
*stream_class
,
563 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
564 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
565 stream_class
->packets_have_packet_counter_snapshot
=
567 BT_LIB_LOGV("Set stream class's "
568 "\"packets have packet counter snapshot\" property: "
569 "%!+S", stream_class
);
572 bt_bool
bt_stream_class_packets_have_default_beginning_clock_snapshot(
573 const struct bt_stream_class
*stream_class
)
575 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
576 return (bt_bool
) stream_class
->packets_have_default_beginning_cs
;
579 void bt_stream_class_set_packets_have_default_beginning_clock_snapshot(
580 struct bt_stream_class
*stream_class
,
583 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
584 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
585 BT_ASSERT_PRE(!value
|| stream_class
->default_clock_class
,
586 "Stream class does not have a default clock class: %!+S",
588 stream_class
->packets_have_default_beginning_cs
= (bool) value
;
589 BT_LIB_LOGV("Set stream class's "
590 "\"packets have default beginning clock snapshot\" property: "
591 "%!+S", stream_class
);
594 bt_bool
bt_stream_class_packets_have_default_end_clock_snapshot(
595 const struct bt_stream_class
*stream_class
)
597 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
598 return (bt_bool
) stream_class
->packets_have_default_end_cs
;
601 void bt_stream_class_set_packets_have_default_end_clock_snapshot(
602 struct bt_stream_class
*stream_class
,
605 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
606 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
607 BT_ASSERT_PRE(!value
|| stream_class
->default_clock_class
,
608 "Stream class does not have a default clock class: %!+S",
610 stream_class
->packets_have_default_end_cs
= (bool) value
;
611 BT_LIB_LOGV("Set stream class's "
612 "\"packets have default end clock snapshot\" property: "
613 "%!+S", stream_class
);
616 bt_bool
bt_stream_class_default_clock_is_always_known(
617 const struct bt_stream_class
*stream_class
)
619 /* BT_CLOCK_SNAPSHOT_STATE_UNKNOWN is not supported as of 2.0 */
623 void bt_stream_class_get_ref(const struct bt_stream_class
*stream_class
)
625 bt_object_get_ref(stream_class
);
628 void bt_stream_class_put_ref(const struct bt_stream_class
*stream_class
)
630 bt_object_put_ref(stream_class
);