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 "LIB/STREAM-CLASS"
25 #include "lib/logging.h"
27 #include "lib/assert-pre.h"
28 #include <babeltrace2/trace-ir/trace-const.h>
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"
38 #include "clock-class.h"
39 #include "event-class.h"
40 #include "field-class.h"
42 #include "field-wrapper.h"
43 #include "resolve-field-path.h"
44 #include "stream-class.h"
47 #include "lib/func-status.h"
49 #define BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(_sc) \
50 BT_ASSERT_PRE_DEV_HOT((_sc), "Stream class", ": %!+S", (_sc))
53 void destroy_stream_class(struct bt_object
*obj
)
55 struct bt_stream_class
*stream_class
= (void *) obj
;
57 BT_LIB_LOGD("Destroying stream class: %!+S", stream_class
);
58 BT_LOGD_STR("Putting default clock class.");
59 BT_OBJECT_PUT_REF_AND_RESET(stream_class
->default_clock_class
);
61 if (stream_class
->event_classes
) {
62 BT_LOGD_STR("Destroying event classes.");
63 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
64 stream_class
->event_classes
= NULL
;
67 if (stream_class
->name
.str
) {
68 g_string_free(stream_class
->name
.str
, TRUE
);
69 stream_class
->name
.str
= NULL
;
70 stream_class
->name
.value
= NULL
;
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
->packet_context_field_pool
);
82 void free_field_wrapper(struct bt_field_wrapper
*field_wrapper
,
83 struct bt_stream_class
*stream_class
)
85 bt_field_wrapper_destroy((void *) field_wrapper
);
89 bool stream_class_id_is_unique(const struct bt_trace_class
*tc
, uint64_t id
)
92 bool is_unique
= true;
94 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
95 const struct bt_stream_class
*sc
=
96 tc
->stream_classes
->pdata
[i
];
109 struct bt_stream_class
*create_stream_class_with_id(
110 struct bt_trace_class
*tc
, uint64_t id
)
112 struct bt_stream_class
*stream_class
= NULL
;
116 BT_ASSERT_PRE(stream_class_id_is_unique(tc
, id
),
117 "Duplicate stream class ID: %![tc-]+T, id=%" PRIu64
, tc
, id
);
118 BT_LIB_LOGD("Creating stream class object: %![tc-]+T, id=%" PRIu64
,
120 stream_class
= g_new0(struct bt_stream_class
, 1);
122 BT_LIB_LOGE_APPEND_CAUSE(
123 "Failed to allocate one stream class.");
127 bt_object_init_shared_with_parent(&stream_class
->base
,
128 destroy_stream_class
);
130 stream_class
->name
.str
= g_string_new(NULL
);
131 if (!stream_class
->name
.str
) {
132 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
137 stream_class
->id
= id
;
138 stream_class
->assigns_automatic_event_class_id
= true;
139 stream_class
->assigns_automatic_stream_id
= true;
140 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
141 (GDestroyNotify
) bt_object_try_spec_release
);
142 if (!stream_class
->event_classes
) {
143 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
147 ret
= bt_object_pool_initialize(&stream_class
->packet_context_field_pool
,
148 (bt_object_pool_new_object_func
) bt_field_wrapper_new
,
149 (bt_object_pool_destroy_object_func
) free_field_wrapper
,
152 BT_LIB_LOGE_APPEND_CAUSE(
153 "Failed to initialize packet context field pool: ret=%d",
158 bt_object_set_parent(&stream_class
->base
, &tc
->base
);
159 g_ptr_array_add(tc
->stream_classes
, stream_class
);
160 bt_trace_class_freeze(tc
);
161 BT_LIB_LOGD("Created stream class object: %!+S", stream_class
);
165 BT_OBJECT_PUT_REF_AND_RESET(stream_class
);
171 struct bt_stream_class
*bt_stream_class_create(struct bt_trace_class
*tc
)
173 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
174 BT_ASSERT_PRE(tc
->assigns_automatic_stream_class_id
,
175 "Trace class does not automatically assigns stream class IDs: "
177 return create_stream_class_with_id(tc
,
178 (uint64_t) tc
->stream_classes
->len
);
181 struct bt_stream_class
*bt_stream_class_create_with_id(
182 struct bt_trace_class
*tc
, uint64_t id
)
184 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
185 BT_ASSERT_PRE(!tc
->assigns_automatic_stream_class_id
,
186 "Trace class automatically assigns stream class IDs: "
188 return create_stream_class_with_id(tc
, id
);
191 struct bt_trace_class
*bt_stream_class_borrow_trace_class(
192 struct bt_stream_class
*stream_class
)
194 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
195 return bt_stream_class_borrow_trace_class_inline(stream_class
);
198 const struct bt_trace_class
*bt_stream_class_borrow_trace_class_const(
199 const struct bt_stream_class
*stream_class
)
201 return bt_stream_class_borrow_trace_class((void *) stream_class
);
204 const char *bt_stream_class_get_name(const struct bt_stream_class
*stream_class
)
206 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
207 return stream_class
->name
.value
;
210 enum bt_stream_class_set_name_status
bt_stream_class_set_name(
211 struct bt_stream_class
*stream_class
,
214 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
215 BT_ASSERT_PRE_NON_NULL(name
, "Name");
216 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
217 g_string_assign(stream_class
->name
.str
, name
);
218 stream_class
->name
.value
= stream_class
->name
.str
->str
;
219 BT_LIB_LOGD("Set stream class's name: %!+S", stream_class
);
220 return BT_FUNC_STATUS_OK
;
223 uint64_t bt_stream_class_get_id(const struct bt_stream_class
*stream_class
)
225 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
226 return stream_class
->id
;
229 uint64_t bt_stream_class_get_event_class_count(
230 const struct bt_stream_class
*stream_class
)
232 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
233 return (uint64_t) stream_class
->event_classes
->len
;
236 struct bt_event_class
*bt_stream_class_borrow_event_class_by_index(
237 struct bt_stream_class
*stream_class
, uint64_t index
)
239 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
240 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, stream_class
->event_classes
->len
);
241 return g_ptr_array_index(stream_class
->event_classes
, index
);
244 const struct bt_event_class
*
245 bt_stream_class_borrow_event_class_by_index_const(
246 const struct bt_stream_class
*stream_class
, uint64_t index
)
248 return bt_stream_class_borrow_event_class_by_index(
249 (void *) stream_class
, index
);
252 struct bt_event_class
*bt_stream_class_borrow_event_class_by_id(
253 struct bt_stream_class
*stream_class
, uint64_t id
)
255 struct bt_event_class
*event_class
= NULL
;
258 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
260 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
261 struct bt_event_class
*event_class_candidate
=
262 g_ptr_array_index(stream_class
->event_classes
, i
);
264 if (event_class_candidate
->id
== id
) {
265 event_class
= event_class_candidate
;
274 const struct bt_event_class
*
275 bt_stream_class_borrow_event_class_by_id_const(
276 const struct bt_stream_class
*stream_class
, uint64_t id
)
278 return bt_stream_class_borrow_event_class_by_id(
279 (void *) stream_class
, id
);
282 const struct bt_field_class
*
283 bt_stream_class_borrow_packet_context_field_class_const(
284 const struct bt_stream_class
*stream_class
)
286 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
287 return stream_class
->packet_context_fc
;
290 struct bt_field_class
*
291 bt_stream_class_borrow_packet_context_field_class(
292 struct bt_stream_class
*stream_class
)
294 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
295 return stream_class
->packet_context_fc
;
298 enum bt_stream_class_set_field_class_status
299 bt_stream_class_set_packet_context_field_class(
300 struct bt_stream_class
*stream_class
,
301 struct bt_field_class
*field_class
)
304 struct bt_resolve_field_path_context resolve_ctx
= {
305 .packet_context
= field_class
,
306 .event_common_context
= NULL
,
307 .event_specific_context
= NULL
,
308 .event_payload
= NULL
,
311 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
312 BT_ASSERT_PRE(stream_class
->supports_packets
,
313 "Stream class does not support packets: %![sc-]+S",
315 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
316 BT_ASSERT_PRE_DEV_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 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
324 * This is the only reason for which
325 * bt_resolve_field_paths() can fail: anything else
326 * would be because a precondition is not satisfied.
328 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
332 bt_field_class_make_part_of_trace_class(field_class
);
333 bt_object_put_ref(stream_class
->packet_context_fc
);
334 stream_class
->packet_context_fc
= field_class
;
335 bt_object_get_no_null_check(stream_class
->packet_context_fc
);
336 bt_field_class_freeze(field_class
);
337 BT_LIB_LOGD("Set stream class's packet context field class: %!+S",
344 const struct bt_field_class
*
345 bt_stream_class_borrow_event_common_context_field_class_const(
346 const struct bt_stream_class
*stream_class
)
348 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
349 return stream_class
->event_common_context_fc
;
352 struct bt_field_class
*
353 bt_stream_class_borrow_event_common_context_field_class(
354 struct bt_stream_class
*stream_class
)
356 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
357 return stream_class
->event_common_context_fc
;
360 enum bt_stream_class_set_field_class_status
361 bt_stream_class_set_event_common_context_field_class(
362 struct bt_stream_class
*stream_class
,
363 struct bt_field_class
*field_class
)
366 struct bt_resolve_field_path_context resolve_ctx
= {
367 .packet_context
= NULL
,
368 .event_common_context
= field_class
,
369 .event_specific_context
= NULL
,
370 .event_payload
= NULL
,
373 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
374 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
375 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
376 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
377 BT_FIELD_CLASS_TYPE_STRUCTURE
,
378 "Event common context field class is not a structure field class: %!+F",
380 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
381 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
384 * This is the only reason for which
385 * bt_resolve_field_paths() can fail: anything else
386 * would be because a precondition is not satisfied.
388 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
392 bt_field_class_make_part_of_trace_class(field_class
);
393 bt_object_put_ref(stream_class
->event_common_context_fc
);
394 stream_class
->event_common_context_fc
= field_class
;
395 bt_object_get_no_null_check(stream_class
->event_common_context_fc
);
396 bt_field_class_freeze(field_class
);
397 BT_LIB_LOGD("Set stream class's event common context field class: %!+S",
405 void _bt_stream_class_freeze(const struct bt_stream_class
*stream_class
)
407 /* The field classes and default clock class are already frozen */
408 BT_ASSERT(stream_class
);
409 BT_LIB_LOGD("Freezing stream class: %!+S", stream_class
);
410 ((struct bt_stream_class
*) stream_class
)->frozen
= true;
413 enum bt_stream_class_set_default_clock_class_status
414 bt_stream_class_set_default_clock_class(
415 struct bt_stream_class
*stream_class
,
416 struct bt_clock_class
*clock_class
)
418 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
419 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
420 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
421 bt_object_put_ref(stream_class
->default_clock_class
);
422 stream_class
->default_clock_class
= clock_class
;
423 bt_object_get_no_null_check(stream_class
->default_clock_class
);
424 bt_clock_class_freeze(clock_class
);
425 BT_LIB_LOGD("Set stream class's default clock class: %!+S",
427 return BT_FUNC_STATUS_OK
;
430 struct bt_clock_class
*bt_stream_class_borrow_default_clock_class(
431 struct bt_stream_class
*stream_class
)
433 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
434 return stream_class
->default_clock_class
;
437 const struct bt_clock_class
*bt_stream_class_borrow_default_clock_class_const(
438 const struct bt_stream_class
*stream_class
)
440 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
441 return stream_class
->default_clock_class
;
444 bt_bool
bt_stream_class_assigns_automatic_event_class_id(
445 const struct bt_stream_class
*stream_class
)
447 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
448 return (bt_bool
) stream_class
->assigns_automatic_event_class_id
;
451 void bt_stream_class_set_assigns_automatic_event_class_id(
452 struct bt_stream_class
*stream_class
,
455 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
456 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
457 stream_class
->assigns_automatic_event_class_id
= (bool) value
;
458 BT_LIB_LOGD("Set stream class's automatic event class ID "
459 "assignment property: %!+S", stream_class
);
462 bt_bool
bt_stream_class_assigns_automatic_stream_id(
463 const struct bt_stream_class
*stream_class
)
465 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
466 return (bt_bool
) stream_class
->assigns_automatic_stream_id
;
469 void bt_stream_class_set_supports_discarded_events(
470 struct bt_stream_class
*stream_class
,
471 bt_bool supports_discarded_events
,
472 bt_bool with_default_clock_snapshots
)
474 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
475 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
476 BT_ASSERT_PRE(supports_discarded_events
||
477 !with_default_clock_snapshots
,
478 "Discarded events cannot have default clock snapshots when "
479 "not supported: %!+S", stream_class
);
480 BT_ASSERT_PRE(!with_default_clock_snapshots
||
481 stream_class
->default_clock_class
,
482 "Stream class has no default clock class: %!+S", stream_class
);
483 stream_class
->supports_discarded_events
=
484 (bool) supports_discarded_events
;
485 stream_class
->discarded_events_have_default_clock_snapshots
=
486 (bool) with_default_clock_snapshots
;
487 BT_LIB_LOGD("Set stream class's discarded events support property: "
488 "%!+S", stream_class
);
491 bt_bool
bt_stream_class_supports_discarded_events(
492 const struct bt_stream_class
*stream_class
)
494 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
495 return (bt_bool
) stream_class
->supports_discarded_events
;
498 bt_bool
bt_stream_class_discarded_events_have_default_clock_snapshots(
499 const struct bt_stream_class
*stream_class
)
501 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
502 return (bt_bool
) stream_class
->discarded_events_have_default_clock_snapshots
;
505 void bt_stream_class_set_supports_discarded_packets(
506 struct bt_stream_class
*stream_class
,
507 bt_bool supports_discarded_packets
,
508 bt_bool with_default_clock_snapshots
)
510 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
511 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
512 BT_ASSERT_PRE(!supports_discarded_packets
||
513 stream_class
->supports_packets
,
514 "Stream class does not support packets: %!+S",
516 BT_ASSERT_PRE(supports_discarded_packets
||
517 !with_default_clock_snapshots
,
518 "Discarded packets cannot have default clock snapshots when "
519 "not supported: %!+S", stream_class
);
520 BT_ASSERT_PRE(!with_default_clock_snapshots
||
521 stream_class
->default_clock_class
,
522 "Stream class has no default clock class: %!+S", stream_class
);
523 stream_class
->supports_discarded_packets
=
524 (bool) supports_discarded_packets
;
525 stream_class
->discarded_packets_have_default_clock_snapshots
=
526 (bool) with_default_clock_snapshots
;
527 BT_LIB_LOGD("Set stream class's discarded packets support property: "
528 "%!+S", stream_class
);
531 bt_bool
bt_stream_class_supports_discarded_packets(
532 const struct bt_stream_class
*stream_class
)
534 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
535 return (bt_bool
) stream_class
->supports_discarded_packets
;
538 bt_bool
bt_stream_class_discarded_packets_have_default_clock_snapshots(
539 const struct bt_stream_class
*stream_class
)
541 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
542 return (bt_bool
) stream_class
->discarded_packets_have_default_clock_snapshots
;
545 void bt_stream_class_set_supports_packets(
546 struct bt_stream_class
*stream_class
,
547 bt_bool supports_packets
,
548 bt_bool with_beginning_default_clock_snapshot
,
549 bt_bool with_end_default_clock_snapshot
)
551 bt_bool with_default_clock_snapshot
=
552 with_beginning_default_clock_snapshot
||
553 with_end_default_clock_snapshot
;
554 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
555 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
556 BT_ASSERT_PRE(supports_packets
||
557 !with_default_clock_snapshot
,
558 "Packets cannot have default clock snapshots when "
559 "not supported: %!+S", stream_class
);
560 BT_ASSERT_PRE(!with_default_clock_snapshot
||
561 stream_class
->default_clock_class
,
562 "Stream class has no default clock class: %!+S", stream_class
);
563 BT_ASSERT_PRE(supports_packets
|| !stream_class
->packet_context_fc
,
564 "Stream class already has a packet context field class: %!+S",
566 BT_ASSERT_PRE(supports_packets
||
567 !stream_class
->supports_discarded_packets
,
568 "Stream class already supports discarded packets: %!+S",
570 stream_class
->supports_packets
= (bool) supports_packets
;
571 stream_class
->packets_have_beginning_default_clock_snapshot
=
572 (bool) with_beginning_default_clock_snapshot
;
573 stream_class
->packets_have_end_default_clock_snapshot
=
574 (bool) with_end_default_clock_snapshot
;
575 BT_LIB_LOGD("Set stream class's packets support property: %!+S",
579 bt_bool
bt_stream_class_supports_packets(
580 const struct bt_stream_class
*stream_class
)
582 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
583 return (bt_bool
) stream_class
->supports_packets
;
586 bt_bool
bt_stream_class_packets_have_beginning_default_clock_snapshot(
587 const struct bt_stream_class
*stream_class
)
589 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
590 return (bt_bool
) stream_class
->packets_have_beginning_default_clock_snapshot
;
593 bt_bool
bt_stream_class_packets_have_end_default_clock_snapshot(
594 const struct bt_stream_class
*stream_class
)
596 BT_ASSERT_PRE_DEV_NON_NULL(stream_class
, "Stream class");
597 return (bt_bool
) stream_class
->packets_have_end_default_clock_snapshot
;
600 void bt_stream_class_set_assigns_automatic_stream_id(
601 struct bt_stream_class
*stream_class
,
604 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
605 BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class
);
606 stream_class
->assigns_automatic_stream_id
= (bool) value
;
607 BT_LIB_LOGD("Set stream class's automatic stream ID "
608 "assignment property: %!+S", stream_class
);
611 void bt_stream_class_get_ref(const struct bt_stream_class
*stream_class
)
613 bt_object_get_ref(stream_class
);
616 void bt_stream_class_put_ref(const struct bt_stream_class
*stream_class
)
618 bt_object_put_ref(stream_class
);