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_STREAM_CLASS_HOT(_sc) \
50 BT_ASSERT_PRE_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
);
90 bool stream_class_id_is_unique(const struct bt_trace_class
*tc
, uint64_t id
)
93 bool is_unique
= true;
95 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
96 const struct bt_stream_class
*sc
=
97 tc
->stream_classes
->pdata
[i
];
110 struct bt_stream_class
*create_stream_class_with_id(
111 struct bt_trace_class
*tc
, uint64_t id
)
113 struct bt_stream_class
*stream_class
= NULL
;
117 BT_ASSERT_PRE(stream_class_id_is_unique(tc
, id
),
118 "Duplicate stream class ID: %![tc-]+T, id=%" PRIu64
, tc
, id
);
119 BT_LIB_LOGD("Creating stream class object: %![tc-]+T, id=%" PRIu64
,
121 stream_class
= g_new0(struct bt_stream_class
, 1);
123 BT_LIB_LOGE_APPEND_CAUSE(
124 "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_LIB_LOGE_APPEND_CAUSE("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_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
148 ret
= bt_object_pool_initialize(&stream_class
->packet_context_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_LIB_LOGE_APPEND_CAUSE(
154 "Failed to initialize packet context field pool: ret=%d",
159 bt_object_set_parent(&stream_class
->base
, &tc
->base
);
160 g_ptr_array_add(tc
->stream_classes
, stream_class
);
161 bt_trace_class_freeze(tc
);
162 BT_LIB_LOGD("Created stream class object: %!+S", stream_class
);
166 BT_OBJECT_PUT_REF_AND_RESET(stream_class
);
172 struct bt_stream_class
*bt_stream_class_create(struct bt_trace_class
*tc
)
174 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
175 BT_ASSERT_PRE(tc
->assigns_automatic_stream_class_id
,
176 "Trace class does not automatically assigns stream class IDs: "
178 return create_stream_class_with_id(tc
,
179 (uint64_t) tc
->stream_classes
->len
);
182 struct bt_stream_class
*bt_stream_class_create_with_id(
183 struct bt_trace_class
*tc
, uint64_t id
)
185 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
186 BT_ASSERT_PRE(!tc
->assigns_automatic_stream_class_id
,
187 "Trace class automatically assigns stream class IDs: "
189 return create_stream_class_with_id(tc
, id
);
192 struct bt_trace_class
*bt_stream_class_borrow_trace_class(
193 struct bt_stream_class
*stream_class
)
195 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
196 return bt_stream_class_borrow_trace_class_inline(stream_class
);
199 const struct bt_trace_class
*bt_stream_class_borrow_trace_class_const(
200 const struct bt_stream_class
*stream_class
)
202 return bt_stream_class_borrow_trace_class((void *) stream_class
);
205 const char *bt_stream_class_get_name(const struct bt_stream_class
*stream_class
)
207 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
208 return stream_class
->name
.value
;
211 enum bt_stream_class_set_name_status
bt_stream_class_set_name(
212 struct bt_stream_class
*stream_class
,
215 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
216 BT_ASSERT_PRE_NON_NULL(name
, "Name");
217 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
218 g_string_assign(stream_class
->name
.str
, name
);
219 stream_class
->name
.value
= stream_class
->name
.str
->str
;
220 BT_LIB_LOGD("Set stream class's name: %!+S", stream_class
);
221 return BT_FUNC_STATUS_OK
;
224 uint64_t bt_stream_class_get_id(const struct bt_stream_class
*stream_class
)
226 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
227 return stream_class
->id
;
230 uint64_t bt_stream_class_get_event_class_count(
231 const struct bt_stream_class
*stream_class
)
233 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
234 return (uint64_t) stream_class
->event_classes
->len
;
237 struct bt_event_class
*bt_stream_class_borrow_event_class_by_index(
238 struct bt_stream_class
*stream_class
, uint64_t index
)
240 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
241 BT_ASSERT_PRE_VALID_INDEX(index
, stream_class
->event_classes
->len
);
242 return g_ptr_array_index(stream_class
->event_classes
, index
);
245 const struct bt_event_class
*
246 bt_stream_class_borrow_event_class_by_index_const(
247 const struct bt_stream_class
*stream_class
, uint64_t index
)
249 return bt_stream_class_borrow_event_class_by_index(
250 (void *) stream_class
, index
);
253 struct bt_event_class
*bt_stream_class_borrow_event_class_by_id(
254 struct bt_stream_class
*stream_class
, uint64_t id
)
256 struct bt_event_class
*event_class
= NULL
;
259 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
261 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
262 struct bt_event_class
*event_class_candidate
=
263 g_ptr_array_index(stream_class
->event_classes
, i
);
265 if (event_class_candidate
->id
== id
) {
266 event_class
= event_class_candidate
;
275 const struct bt_event_class
*
276 bt_stream_class_borrow_event_class_by_id_const(
277 const struct bt_stream_class
*stream_class
, uint64_t id
)
279 return bt_stream_class_borrow_event_class_by_id(
280 (void *) stream_class
, id
);
283 const struct bt_field_class
*
284 bt_stream_class_borrow_packet_context_field_class_const(
285 const struct bt_stream_class
*stream_class
)
287 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
288 return stream_class
->packet_context_fc
;
291 struct bt_field_class
*
292 bt_stream_class_borrow_packet_context_field_class(
293 struct bt_stream_class
*stream_class
)
295 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
296 return stream_class
->packet_context_fc
;
299 enum bt_stream_class_set_field_class_status
300 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_context
= field_class
,
307 .event_common_context
= NULL
,
308 .event_specific_context
= NULL
,
309 .event_payload
= NULL
,
312 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
313 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
314 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
315 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
316 BT_FIELD_CLASS_TYPE_STRUCTURE
,
317 "Packet context field class is not a structure field class: %!+F",
319 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
322 * This is the only reason for which
323 * bt_resolve_field_paths() can fail: anything else
324 * would be because a precondition is not satisfied.
326 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
330 bt_field_class_make_part_of_trace_class(field_class
);
331 bt_object_put_ref(stream_class
->packet_context_fc
);
332 stream_class
->packet_context_fc
= field_class
;
333 bt_object_get_no_null_check(stream_class
->packet_context_fc
);
334 bt_field_class_freeze(field_class
);
335 BT_LIB_LOGD("Set stream class's packet context field class: %!+S",
342 const struct bt_field_class
*
343 bt_stream_class_borrow_event_common_context_field_class_const(
344 const struct bt_stream_class
*stream_class
)
346 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
347 return stream_class
->event_common_context_fc
;
350 struct bt_field_class
*
351 bt_stream_class_borrow_event_common_context_field_class(
352 struct bt_stream_class
*stream_class
)
354 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
355 return stream_class
->event_common_context_fc
;
358 enum bt_stream_class_set_field_class_status
359 bt_stream_class_set_event_common_context_field_class(
360 struct bt_stream_class
*stream_class
,
361 struct bt_field_class
*field_class
)
364 struct bt_resolve_field_path_context resolve_ctx
= {
365 .packet_context
= NULL
,
366 .event_common_context
= field_class
,
367 .event_specific_context
= NULL
,
368 .event_payload
= NULL
,
371 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
372 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
373 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
374 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
375 BT_FIELD_CLASS_TYPE_STRUCTURE
,
376 "Event common context field class is not a structure field class: %!+F",
378 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
379 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
382 * This is the only reason for which
383 * bt_resolve_field_paths() can fail: anything else
384 * would be because a precondition is not satisfied.
386 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
390 bt_field_class_make_part_of_trace_class(field_class
);
391 bt_object_put_ref(stream_class
->event_common_context_fc
);
392 stream_class
->event_common_context_fc
= field_class
;
393 bt_object_get_no_null_check(stream_class
->event_common_context_fc
);
394 bt_field_class_freeze(field_class
);
395 BT_LIB_LOGD("Set stream class's event common context field class: %!+S",
403 void _bt_stream_class_freeze(const struct bt_stream_class
*stream_class
)
405 /* The field classes and default clock class are already frozen */
406 BT_ASSERT(stream_class
);
407 BT_LIB_LOGD("Freezing stream class: %!+S", stream_class
);
408 ((struct bt_stream_class
*) stream_class
)->frozen
= true;
411 enum bt_stream_class_set_default_clock_class_status
412 bt_stream_class_set_default_clock_class(
413 struct bt_stream_class
*stream_class
,
414 struct bt_clock_class
*clock_class
)
416 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
417 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
418 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
419 bt_object_put_ref(stream_class
->default_clock_class
);
420 stream_class
->default_clock_class
= clock_class
;
421 bt_object_get_no_null_check(stream_class
->default_clock_class
);
422 bt_clock_class_freeze(clock_class
);
423 BT_LIB_LOGD("Set stream class's default clock class: %!+S",
425 return BT_FUNC_STATUS_OK
;
428 struct bt_clock_class
*bt_stream_class_borrow_default_clock_class(
429 struct bt_stream_class
*stream_class
)
431 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
432 return stream_class
->default_clock_class
;
435 const struct bt_clock_class
*bt_stream_class_borrow_default_clock_class_const(
436 const struct bt_stream_class
*stream_class
)
438 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
439 return stream_class
->default_clock_class
;
442 bt_bool
bt_stream_class_assigns_automatic_event_class_id(
443 const struct bt_stream_class
*stream_class
)
445 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
446 return (bt_bool
) stream_class
->assigns_automatic_event_class_id
;
449 void bt_stream_class_set_assigns_automatic_event_class_id(
450 struct bt_stream_class
*stream_class
,
453 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
454 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
455 stream_class
->assigns_automatic_event_class_id
= (bool) value
;
456 BT_LIB_LOGD("Set stream class's automatic event class ID "
457 "assignment property: %!+S", stream_class
);
460 bt_bool
bt_stream_class_packets_have_beginning_default_clock_snapshot(
461 const struct bt_stream_class
*stream_class
)
463 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
464 return (bt_bool
) stream_class
->packets_have_beginning_default_clock_snapshot
;
467 void bt_stream_class_set_packets_have_beginning_default_clock_snapshot(
468 struct bt_stream_class
*stream_class
, bt_bool value
)
470 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
471 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
472 BT_ASSERT_PRE(!value
|| stream_class
->default_clock_class
,
473 "Stream class has no default clock class: %!+S", stream_class
);
474 stream_class
->packets_have_beginning_default_clock_snapshot
=
476 BT_LIB_LOGD("Set stream class's \"packets have default beginning "
477 "clock snapshot\" property: %!+S", stream_class
);
480 bt_bool
bt_stream_class_packets_have_end_default_clock_snapshot(
481 const struct bt_stream_class
*stream_class
)
483 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
484 return (bt_bool
) stream_class
->packets_have_end_default_clock_snapshot
;
487 void bt_stream_class_set_packets_have_end_default_clock_snapshot(
488 struct bt_stream_class
*stream_class
, bt_bool value
)
490 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
491 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
492 BT_ASSERT_PRE(!value
|| stream_class
->default_clock_class
,
493 "Stream class has no default clock class: %!+S", stream_class
);
494 stream_class
->packets_have_end_default_clock_snapshot
=
496 BT_LIB_LOGD("Set stream class's \"packets have default end "
497 "clock snapshot\" property: %!+S", stream_class
);
500 bt_bool
bt_stream_class_assigns_automatic_stream_id(
501 const struct bt_stream_class
*stream_class
)
503 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
504 return (bt_bool
) stream_class
->assigns_automatic_stream_id
;
507 void bt_stream_class_set_supports_discarded_events(
508 struct bt_stream_class
*stream_class
,
509 bt_bool supports_discarded_events
,
510 bt_bool with_default_clock_snapshots
)
512 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
513 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
514 BT_ASSERT_PRE(supports_discarded_events
||
515 !with_default_clock_snapshots
,
516 "Discarded events cannot have default clock snapshots when "
517 "not supported: %!+S", stream_class
);
518 BT_ASSERT_PRE(!with_default_clock_snapshots
||
519 stream_class
->default_clock_class
,
520 "Stream class has no default clock class: %!+S", stream_class
);
521 stream_class
->supports_discarded_events
=
522 (bool) supports_discarded_events
;
523 stream_class
->discarded_events_have_default_clock_snapshots
=
524 (bool) with_default_clock_snapshots
;
525 BT_LIB_LOGD("Set stream class's discarded events support property: "
526 "%!+S", stream_class
);
529 bt_bool
bt_stream_class_supports_discarded_events(
530 const struct bt_stream_class
*stream_class
)
532 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
533 return (bt_bool
) stream_class
->supports_discarded_events
;
536 bt_bool
bt_stream_class_discarded_events_have_default_clock_snapshots(
537 const struct bt_stream_class
*stream_class
)
539 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
540 return (bt_bool
) stream_class
->discarded_events_have_default_clock_snapshots
;
543 void bt_stream_class_set_supports_discarded_packets(
544 struct bt_stream_class
*stream_class
,
545 bt_bool supports_discarded_packets
,
546 bt_bool with_default_clock_snapshots
)
548 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
549 BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class
);
550 BT_ASSERT_PRE(supports_discarded_packets
||
551 !with_default_clock_snapshots
,
552 "Discarded packets cannot have default clock snapshots when "
553 "not supported: %!+S", stream_class
);
554 BT_ASSERT_PRE(!with_default_clock_snapshots
||
555 stream_class
->default_clock_class
,
556 "Stream class has no default clock class: %!+S", stream_class
);
557 stream_class
->supports_discarded_packets
=
558 (bool) supports_discarded_packets
;
559 stream_class
->discarded_packets_have_default_clock_snapshots
=
560 (bool) with_default_clock_snapshots
;
561 BT_LIB_LOGD("Set stream class's discarded packets support property: "
562 "%!+S", stream_class
);
565 bt_bool
bt_stream_class_supports_discarded_packets(
566 const struct bt_stream_class
*stream_class
)
568 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
569 return (bt_bool
) stream_class
->supports_discarded_packets
;
572 bt_bool
bt_stream_class_discarded_packets_have_default_clock_snapshots(
573 const struct bt_stream_class
*stream_class
)
575 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
576 return (bt_bool
) stream_class
->discarded_packets_have_default_clock_snapshots
;
579 void bt_stream_class_set_assigns_automatic_stream_id(
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 stream_class
->assigns_automatic_stream_id
= (bool) value
;
586 BT_LIB_LOGD("Set stream class's automatic stream ID "
587 "assignment property: %!+S", stream_class
);
590 void bt_stream_class_get_ref(const struct bt_stream_class
*stream_class
)
592 bt_object_get_ref(stream_class
);
595 void bt_stream_class_put_ref(const struct bt_stream_class
*stream_class
)
597 bt_object_put_ref(stream_class
);