2 * Copyright (c) 2020-2021 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_TRACE_IR_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_TRACE_IR_HPP
11 #include <type_traits>
13 #include <babeltrace2/babeltrace.h>
15 #include "cpp-common/bt2c/c-string-view.hpp"
16 #include "cpp-common/bt2s/optional.hpp"
18 #include "borrowed-object.hpp"
19 #include "clock-class.hpp"
20 #include "field-class.hpp"
22 #include "internal/utils.hpp"
23 #include "optional-borrowed-object.hpp"
24 #include "shared-object.hpp"
29 template <typename LibObjT>
32 template <typename LibObjT>
35 template <typename LibObjT>
38 template <typename LibObjT>
41 template <typename LibObjT>
42 class CommonEventClass;
44 template <typename LibObjT>
45 class CommonStreamClass;
47 template <typename LibObjT>
48 class CommonTraceClass;
52 template <typename LibObjT>
53 struct CommonEventSpec;
55 /* Functions specific to mutable events */
57 struct CommonEventSpec<bt_event> final
59 static bt_event_class *cls(bt_event * const libObjPtr) noexcept
61 return bt_event_borrow_class(libObjPtr);
64 static bt_stream *stream(bt_event * const libObjPtr) noexcept
66 return bt_event_borrow_stream(libObjPtr);
69 static bt_packet *packet(bt_event * const libObjPtr) noexcept
71 return bt_event_borrow_packet(libObjPtr);
74 static bt_field *payloadField(bt_event * const libObjPtr) noexcept
76 return bt_event_borrow_payload_field(libObjPtr);
79 static bt_field *specificContextField(bt_event * const libObjPtr) noexcept
81 return bt_event_borrow_specific_context_field(libObjPtr);
84 static bt_field *commonContextField(bt_event * const libObjPtr) noexcept
86 return bt_event_borrow_common_context_field(libObjPtr);
90 /* Functions specific to constant events */
92 struct CommonEventSpec<const bt_event> final
94 static const bt_event_class *cls(const bt_event * const libObjPtr) noexcept
96 return bt_event_borrow_class_const(libObjPtr);
99 static const bt_stream *stream(const bt_event * const libObjPtr) noexcept
101 return bt_event_borrow_stream_const(libObjPtr);
104 static const bt_packet *packet(const bt_event * const libObjPtr) noexcept
106 return bt_event_borrow_packet_const(libObjPtr);
109 static const bt_field *payloadField(const bt_event * const libObjPtr) noexcept
111 return bt_event_borrow_payload_field_const(libObjPtr);
114 static const bt_field *specificContextField(const bt_event * const libObjPtr) noexcept
116 return bt_event_borrow_specific_context_field_const(libObjPtr);
119 static const bt_field *commonContextField(const bt_event * const libObjPtr) noexcept
121 return bt_event_borrow_common_context_field_const(libObjPtr);
125 template <typename LibObjT>
126 using DepStructField = DepType<LibObjT, StructureField, ConstStructureField>;
128 } /* namespace internal */
130 template <typename LibObjT>
131 class CommonEvent final : public BorrowedObject<LibObjT>
134 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
135 using _Spec = internal::CommonEventSpec<LibObjT>;
136 using _Packet = internal::DepPacket<LibObjT>;
137 using _Stream = internal::DepStream<LibObjT>;
138 using _StructureField = internal::DepStructField<LibObjT>;
141 using typename BorrowedObject<LibObjT>::LibObjPtr;
143 using Class = internal::DepType<LibObjT, CommonEventClass<bt_event_class>,
144 CommonEventClass<const bt_event_class>>;
146 explicit CommonEvent(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
150 template <typename OtherLibObjT>
151 CommonEvent(const CommonEvent<OtherLibObjT> event) noexcept : _ThisBorrowedObject {event}
155 template <typename OtherLibObjT>
156 CommonEvent<LibObjT> operator=(const CommonEvent<OtherLibObjT> event) noexcept
158 _ThisBorrowedObject::operator=(event);
162 CommonEvent<const bt_event> asConst() const noexcept
164 return CommonEvent<const bt_event> {*this};
167 Class cls() const noexcept;
168 _Stream stream() const noexcept;
169 OptionalBorrowedObject<_Packet> packet() const noexcept;
171 OptionalBorrowedObject<_StructureField> payloadField() const noexcept
173 return _Spec::payloadField(this->libObjPtr());
176 OptionalBorrowedObject<_StructureField> specificContextField() const noexcept
178 return _Spec::specificContextField(this->libObjPtr());
181 OptionalBorrowedObject<_StructureField> commonContextField() const noexcept
183 return _Spec::commonContextField(this->libObjPtr());
187 using Event = CommonEvent<bt_event>;
188 using ConstEvent = CommonEvent<const bt_event>;
192 struct EventTypeDescr
194 using Const = ConstEvent;
195 using NonConst = Event;
199 struct TypeDescr<Event> : public EventTypeDescr
204 struct TypeDescr<ConstEvent> : public EventTypeDescr
208 struct PacketRefFuncs final
210 static void get(const bt_packet * const libObjPtr) noexcept
212 bt_packet_get_ref(libObjPtr);
215 static void put(const bt_packet * const libObjPtr) noexcept
217 bt_packet_put_ref(libObjPtr);
221 template <typename LibObjT>
222 struct CommonPacketSpec;
224 /* Functions specific to mutable packets */
226 struct CommonPacketSpec<bt_packet> final
228 static bt_stream *stream(bt_packet * const libObjPtr) noexcept
230 return bt_packet_borrow_stream(libObjPtr);
233 static bt_field *contextField(bt_packet * const libObjPtr) noexcept
235 return bt_packet_borrow_context_field(libObjPtr);
239 /* Functions specific to constant packets */
241 struct CommonPacketSpec<const bt_packet> final
243 static const bt_stream *stream(const bt_packet * const libObjPtr) noexcept
245 return bt_packet_borrow_stream_const(libObjPtr);
248 static const bt_field *contextField(const bt_packet * const libObjPtr) noexcept
250 return bt_packet_borrow_context_field_const(libObjPtr);
254 } /* namespace internal */
256 template <typename LibObjT>
257 class CommonPacket final : public BorrowedObject<LibObjT>
260 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
261 using _Spec = internal::CommonPacketSpec<LibObjT>;
262 using _Stream = internal::DepStream<LibObjT>;
263 using _StructureField = internal::DepStructField<LibObjT>;
266 using typename BorrowedObject<LibObjT>::LibObjPtr;
267 using Shared = SharedObject<CommonPacket, LibObjT, internal::PacketRefFuncs>;
269 explicit CommonPacket(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
273 template <typename OtherLibObjT>
274 CommonPacket(const CommonPacket<OtherLibObjT> packet) noexcept : _ThisBorrowedObject {packet}
278 template <typename OtherLibObjT>
279 CommonPacket operator=(const CommonPacket<OtherLibObjT> packet) noexcept
281 _ThisBorrowedObject::operator=(packet);
285 CommonPacket<const bt_packet> asConst() const noexcept
287 return CommonPacket<const bt_packet> {*this};
290 _Stream stream() const noexcept;
292 OptionalBorrowedObject<_StructureField> contextField() const noexcept
294 return _Spec::contextField(this->libObjPtr());
297 Shared shared() const noexcept
299 return Shared::createWithRef(*this);
303 using Packet = CommonPacket<bt_packet>;
304 using ConstPacket = CommonPacket<const bt_packet>;
308 struct PacketTypeDescr
310 using Const = ConstPacket;
311 using NonConst = Packet;
315 struct TypeDescr<Packet> : public PacketTypeDescr
320 struct TypeDescr<ConstPacket> : public PacketTypeDescr
324 } /* namespace internal */
326 template <typename LibObjT>
327 OptionalBorrowedObject<typename CommonEvent<LibObjT>::_Packet>
328 CommonEvent<LibObjT>::packet() const noexcept
330 return _Spec::packet(this->libObjPtr());
335 struct StreamRefFuncs final
337 static void get(const bt_stream * const libObjPtr) noexcept
339 bt_stream_get_ref(libObjPtr);
342 static void put(const bt_stream * const libObjPtr) noexcept
344 bt_stream_put_ref(libObjPtr);
348 template <typename LibObjT>
349 struct CommonStreamSpec;
351 /* Functions specific to mutable streams */
353 struct CommonStreamSpec<bt_stream> final
355 static bt_stream_class *cls(bt_stream * const libObjPtr) noexcept
357 return bt_stream_borrow_class(libObjPtr);
360 static bt_trace *trace(bt_stream * const libObjPtr) noexcept
362 return bt_stream_borrow_trace(libObjPtr);
365 static bt_value *userAttributes(bt_stream * const libObjPtr) noexcept
367 return bt_stream_borrow_user_attributes(libObjPtr);
371 /* Functions specific to constant streams */
373 struct CommonStreamSpec<const bt_stream> final
375 static const bt_stream_class *cls(const bt_stream * const libObjPtr) noexcept
377 return bt_stream_borrow_class_const(libObjPtr);
380 static const bt_trace *trace(const bt_stream * const libObjPtr) noexcept
382 return bt_stream_borrow_trace_const(libObjPtr);
385 static const bt_value *userAttributes(const bt_stream * const libObjPtr) noexcept
387 return bt_stream_borrow_user_attributes_const(libObjPtr);
391 } /* namespace internal */
393 template <typename LibObjT>
394 class CommonStream final : public BorrowedObject<LibObjT>
397 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
398 using _Spec = internal::CommonStreamSpec<LibObjT>;
399 using _Trace = internal::DepType<LibObjT, CommonTrace<bt_trace>, CommonTrace<const bt_trace>>;
402 using typename BorrowedObject<LibObjT>::LibObjPtr;
403 using Shared = SharedObject<CommonStream, LibObjT, internal::StreamRefFuncs>;
404 using UserAttributes = internal::DepUserAttrs<LibObjT>;
406 using Class = internal::DepType<LibObjT, CommonStreamClass<bt_stream_class>,
407 CommonStreamClass<const bt_stream_class>>;
409 explicit CommonStream(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
413 template <typename OtherLibObjT>
414 CommonStream(const CommonStream<OtherLibObjT> stream) noexcept : _ThisBorrowedObject {stream}
418 template <typename OtherLibObjT>
419 CommonStream operator=(const CommonStream<OtherLibObjT> stream) noexcept
421 _ThisBorrowedObject::operator=(stream);
425 CommonStream<const bt_stream> asConst() const noexcept
427 return CommonStream<const bt_stream> {*this};
430 Packet::Shared createPacket() const
432 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstStream`.");
434 const auto libObjPtr = bt_packet_create(this->libObjPtr());
436 internal::validateCreatedObjPtr(libObjPtr);
437 return Packet::Shared::createWithoutRef(libObjPtr);
440 Class cls() const noexcept;
441 _Trace trace() const noexcept;
443 std::uint64_t id() const noexcept
445 return bt_stream_get_id(this->libObjPtr());
448 void name(const char * const name) const
450 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstStream`.");
452 const auto status = bt_stream_set_name(this->libObjPtr(), name);
454 if (status == BT_STREAM_SET_NAME_STATUS_MEMORY_ERROR) {
455 throw MemoryError {};
459 void name(const std::string& name) const
461 this->name(name.data());
464 bt2c::CStringView name() const noexcept
466 return bt_stream_get_name(this->libObjPtr());
469 template <typename LibValT>
470 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
472 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstStream`.");
474 bt_stream_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
477 UserAttributes userAttributes() const noexcept
479 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
482 Shared shared() const noexcept
484 return Shared::createWithRef(*this);
488 using Stream = CommonStream<bt_stream>;
489 using ConstStream = CommonStream<const bt_stream>;
493 struct StreamTypeDescr
495 using Const = ConstStream;
496 using NonConst = Stream;
500 struct TypeDescr<Stream> : public StreamTypeDescr
505 struct TypeDescr<ConstStream> : public StreamTypeDescr
509 } /* namespace internal */
511 template <typename LibObjT>
512 typename CommonEvent<LibObjT>::_Stream CommonEvent<LibObjT>::stream() const noexcept
514 return _Stream {_Spec::stream(this->libObjPtr())};
517 template <typename LibObjT>
518 typename CommonPacket<LibObjT>::_Stream CommonPacket<LibObjT>::stream() const noexcept
520 return _Stream {_Spec::stream(this->libObjPtr())};
525 struct TraceRefFuncs final
527 static void get(const bt_trace * const libObjPtr) noexcept
529 bt_trace_get_ref(libObjPtr);
532 static void put(const bt_trace * const libObjPtr) noexcept
534 bt_trace_put_ref(libObjPtr);
538 template <typename LibObjT>
539 struct CommonTraceSpec;
541 /* Functions specific to mutable traces */
543 struct CommonTraceSpec<bt_trace> final
545 static bt_trace_class *cls(bt_trace * const libObjPtr) noexcept
547 return bt_trace_borrow_class(libObjPtr);
550 static bt_stream *streamByIndex(bt_trace * const libObjPtr, const std::uint64_t index) noexcept
552 return bt_trace_borrow_stream_by_index(libObjPtr, index);
555 static bt_stream *streamById(bt_trace * const libObjPtr, const std::uint64_t id) noexcept
557 return bt_trace_borrow_stream_by_id(libObjPtr, id);
560 static bt_value *userAttributes(bt_trace * const libObjPtr) noexcept
562 return bt_trace_borrow_user_attributes(libObjPtr);
566 /* Functions specific to constant traces */
568 struct CommonTraceSpec<const bt_trace> final
570 static const bt_trace_class *cls(const bt_trace * const libObjPtr) noexcept
572 return bt_trace_borrow_class_const(libObjPtr);
575 static const bt_stream *streamByIndex(const bt_trace * const libObjPtr,
576 const std::uint64_t index) noexcept
578 return bt_trace_borrow_stream_by_index_const(libObjPtr, index);
581 static const bt_stream *streamById(const bt_trace * const libObjPtr,
582 const std::uint64_t id) noexcept
584 return bt_trace_borrow_stream_by_id_const(libObjPtr, id);
587 static const bt_value *userAttributes(const bt_trace * const libObjPtr) noexcept
589 return bt_trace_borrow_user_attributes_const(libObjPtr);
593 } /* namespace internal */
595 template <typename LibObjT>
596 class CommonTrace final : public BorrowedObject<LibObjT>
599 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
600 using _Spec = internal::CommonTraceSpec<LibObjT>;
601 using _Stream = internal::DepStream<LibObjT>;
604 using typename BorrowedObject<LibObjT>::LibObjPtr;
605 using Shared = SharedObject<CommonTrace, LibObjT, internal::TraceRefFuncs>;
606 using UserAttributes = internal::DepUserAttrs<LibObjT>;
608 using Class = internal::DepType<LibObjT, CommonTraceClass<bt_trace_class>,
609 CommonTraceClass<const bt_trace_class>>;
611 struct ConstEnvironmentEntry
613 bt2c::CStringView name;
617 explicit CommonTrace(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
621 template <typename OtherLibObjT>
622 CommonTrace(const CommonTrace<OtherLibObjT> trace) noexcept : _ThisBorrowedObject {trace}
626 template <typename OtherLibObjT>
627 CommonTrace operator=(const CommonTrace<OtherLibObjT> trace) noexcept
629 _ThisBorrowedObject::operator=(trace);
633 CommonTrace<const bt_trace> asConst() const noexcept
635 return CommonTrace<const bt_trace> {*this};
638 Class cls() const noexcept;
640 void name(const char * const name) const
642 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
644 const auto status = bt_trace_set_name(this->libObjPtr(), name);
646 if (status == BT_TRACE_SET_NAME_STATUS_MEMORY_ERROR) {
647 throw MemoryError {};
651 void name(const std::string& name) const
653 this->name(name.data());
656 bt2c::CStringView name() const noexcept
658 return bt_trace_get_name(this->libObjPtr());
661 void uuid(const bt2c::UuidView& uuid) const noexcept
663 bt_trace_set_uuid(this->libObjPtr(), uuid.begin());
666 bt2s::optional<bt2c::UuidView> uuid() const noexcept
668 const auto uuid = bt_trace_get_uuid(this->libObjPtr());
671 return bt2c::UuidView {uuid};
674 return bt2s::nullopt;
677 std::uint64_t length() const noexcept
679 return bt_trace_get_stream_count(this->libObjPtr());
682 _Stream operator[](const std::uint64_t index) const noexcept
684 return _Stream {_Spec::streamByIndex(this->libObjPtr(), index)};
687 OptionalBorrowedObject<_Stream> streamById(const std::uint64_t id) const noexcept
689 return _Spec::streamById(this->libObjPtr(), id);
692 void environmentEntry(const char * const name, const std::int64_t val) const
694 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
696 const auto status = bt_trace_set_environment_entry_integer(this->libObjPtr(), name, val);
698 if (status == BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR) {
699 throw MemoryError {};
703 void environmentEntry(const std::string& name, const std::int64_t val) const
705 this->environmentEntry(name.data(), val);
708 void environmentEntry(const char * const name, const char * const val) const
710 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
712 const auto status = bt_trace_set_environment_entry_string(this->libObjPtr(), name, val);
714 if (status == BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR) {
715 throw MemoryError {};
719 void environmentEntry(const std::string& name, const char * const val) const
721 this->environmentEntry(name.data(), val);
724 void environmentEntry(const char * const name, const std::string& val) const
726 this->environmentEntry(name, val.data());
729 void environmentEntry(const std::string& name, const std::string& val) const
731 this->environmentEntry(name.data(), val.data());
734 std::uint64_t environmentSize() const noexcept
736 return bt_trace_get_environment_entry_count(this->libObjPtr());
739 ConstEnvironmentEntry environmentEntry(const std::uint64_t index) const noexcept
742 const bt_value *libObjPtr;
744 bt_trace_borrow_environment_entry_by_index_const(this->libObjPtr(), index, &name,
746 return ConstEnvironmentEntry {name, ConstValue {libObjPtr}};
749 OptionalBorrowedObject<ConstValue> environmentEntry(const char * const name) const noexcept
751 return bt_trace_borrow_environment_entry_value_by_name_const(this->libObjPtr(), name);
754 OptionalBorrowedObject<ConstValue> environmentEntry(const std::string& name) const noexcept
756 return this->environmentEntry(name.data());
759 template <typename LibValT>
760 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
762 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
764 bt_trace_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
767 UserAttributes userAttributes() const noexcept
769 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
772 Shared shared() const noexcept
774 return Shared::createWithRef(*this);
778 using Trace = CommonTrace<bt_trace>;
779 using ConstTrace = CommonTrace<const bt_trace>;
783 struct TraceTypeDescr
785 using Const = ConstTrace;
786 using NonConst = Trace;
790 struct TypeDescr<Trace> : public TraceTypeDescr
795 struct TypeDescr<ConstTrace> : public TraceTypeDescr
799 } /* namespace internal */
801 template <typename LibObjT>
802 typename CommonStream<LibObjT>::_Trace CommonStream<LibObjT>::trace() const noexcept
804 return _Trace {_Spec::trace(this->libObjPtr())};
809 struct EventClassRefFuncs final
811 static void get(const bt_event_class * const libObjPtr) noexcept
813 bt_event_class_get_ref(libObjPtr);
816 static void put(const bt_event_class * const libObjPtr) noexcept
818 bt_event_class_put_ref(libObjPtr);
822 template <typename LibObjT>
823 struct CommonEventClassSpec;
825 /* Functions specific to mutable event classes */
827 struct CommonEventClassSpec<bt_event_class> final
829 static bt_stream_class *streamClass(bt_event_class * const libObjPtr) noexcept
831 return bt_event_class_borrow_stream_class(libObjPtr);
834 static bt_field_class *payloadFieldClass(bt_event_class * const libObjPtr) noexcept
836 return bt_event_class_borrow_payload_field_class(libObjPtr);
839 static bt_field_class *specificContextFieldClass(bt_event_class * const libObjPtr) noexcept
841 return bt_event_class_borrow_specific_context_field_class(libObjPtr);
844 static bt_value *userAttributes(bt_event_class * const libObjPtr) noexcept
846 return bt_event_class_borrow_user_attributes(libObjPtr);
850 /* Functions specific to constant event classes */
852 struct CommonEventClassSpec<const bt_event_class> final
854 static const bt_stream_class *streamClass(const bt_event_class * const libObjPtr) noexcept
856 return bt_event_class_borrow_stream_class_const(libObjPtr);
859 static const bt_field_class *payloadFieldClass(const bt_event_class * const libObjPtr) noexcept
861 return bt_event_class_borrow_payload_field_class_const(libObjPtr);
864 static const bt_field_class *
865 specificContextFieldClass(const bt_event_class * const libObjPtr) noexcept
867 return bt_event_class_borrow_specific_context_field_class_const(libObjPtr);
870 static const bt_value *userAttributes(const bt_event_class * const libObjPtr) noexcept
872 return bt_event_class_borrow_user_attributes_const(libObjPtr);
876 template <typename LibObjT>
877 using DepStructFc = DepType<LibObjT, StructureFieldClass, ConstStructureFieldClass>;
879 } /* namespace internal */
881 template <typename LibObjT>
882 class CommonEventClass final : public BorrowedObject<LibObjT>
885 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
886 using _Spec = internal::CommonEventClassSpec<LibObjT>;
887 using _StructureFieldClass = internal::DepStructFc<LibObjT>;
889 using _StreamClass = internal::DepType<LibObjT, CommonStreamClass<bt_stream_class>,
890 CommonStreamClass<const bt_stream_class>>;
893 using typename BorrowedObject<LibObjT>::LibObjPtr;
894 using Shared = SharedObject<CommonEventClass, LibObjT, internal::EventClassRefFuncs>;
895 using UserAttributes = internal::DepUserAttrs<LibObjT>;
899 EMERGENCY = BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY,
900 ALERT = BT_EVENT_CLASS_LOG_LEVEL_ALERT,
901 CRITICAL = BT_EVENT_CLASS_LOG_LEVEL_CRITICAL,
902 ERR = BT_EVENT_CLASS_LOG_LEVEL_ERROR,
903 WARNING = BT_EVENT_CLASS_LOG_LEVEL_WARNING,
904 NOTICE = BT_EVENT_CLASS_LOG_LEVEL_NOTICE,
905 INFO = BT_EVENT_CLASS_LOG_LEVEL_INFO,
906 DEBUG_SYSTEM = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM,
907 DEBUG_PROGRAM = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM,
908 DEBUG_PROC = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS,
909 DEBUG_MODULE = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE,
910 DEBUG_UNIT = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT,
911 DEBUG_FUNCTION = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION,
912 DEBUG_LINE = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE,
913 DEBUG = BT_EVENT_CLASS_LOG_LEVEL_DEBUG,
916 explicit CommonEventClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
920 template <typename OtherLibObjT>
921 CommonEventClass(const CommonEventClass<OtherLibObjT> eventClass) noexcept :
922 _ThisBorrowedObject {eventClass}
926 template <typename OtherLibObjT>
927 CommonEventClass operator=(const CommonEventClass<OtherLibObjT> eventClass) noexcept
929 _ThisBorrowedObject::operator=(eventClass);
933 CommonEventClass<const bt_event_class> asConst() const noexcept
935 return CommonEventClass<const bt_event_class> {*this};
938 _StreamClass streamClass() const noexcept;
940 std::uint64_t id() const noexcept
942 return bt_event_class_get_id(this->libObjPtr());
945 void name(const char * const name) const
947 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
949 const auto status = bt_event_class_set_name(this->libObjPtr(), name);
951 if (status == BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
952 throw MemoryError {};
956 void name(const std::string& name) const
958 this->name(name.data());
961 bt2c::CStringView name() const noexcept
963 return bt_event_class_get_name(this->libObjPtr());
966 void logLevel(const LogLevel logLevel) const noexcept
968 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
970 bt_event_class_set_log_level(this->libObjPtr(),
971 static_cast<bt_event_class_log_level>(logLevel));
974 bt2s::optional<LogLevel> logLevel() const noexcept
976 bt_event_class_log_level libLogLevel;
978 if (bt_event_class_get_log_level(this->libObjPtr(), &libLogLevel)) {
979 return static_cast<LogLevel>(libLogLevel);
982 return bt2s::nullopt;
985 void emfUri(const char * const emfUri) const
987 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
989 const auto status = bt_event_class_set_emf_uri(this->libObjPtr(), emfUri);
991 if (status == BT_EVENT_CLASS_SET_EMF_URI_STATUS_MEMORY_ERROR) {
992 throw MemoryError {};
996 void emfUri(const std::string& emfUri) const
998 this->emfUri(emfUri.data());
1001 bt2c::CStringView emfUri() const noexcept
1003 return bt_event_class_get_emf_uri(this->libObjPtr());
1006 void payloadFieldClass(const StructureFieldClass fc) const
1008 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
1011 bt_event_class_set_payload_field_class(this->libObjPtr(), fc.libObjPtr());
1013 if (status == BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR) {
1014 throw MemoryError {};
1018 OptionalBorrowedObject<_StructureFieldClass> payloadFieldClass() const noexcept
1020 return _Spec::payloadFieldClass(this->libObjPtr());
1023 void specificContextFieldClass(const StructureFieldClass fc) const
1025 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
1028 bt_event_class_set_specific_context_field_class(this->libObjPtr(), fc.libObjPtr());
1030 if (status == BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR) {
1031 throw MemoryError {};
1035 OptionalBorrowedObject<_StructureFieldClass> specificContextFieldClass() const noexcept
1037 return _Spec::specificContextFieldClass(this->libObjPtr());
1040 template <typename LibValT>
1041 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1043 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
1045 bt_event_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1048 UserAttributes userAttributes() const noexcept
1050 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
1053 Shared shared() const noexcept
1055 return Shared::createWithRef(*this);
1059 using EventClass = CommonEventClass<bt_event_class>;
1060 using ConstEventClass = CommonEventClass<const bt_event_class>;
1062 namespace internal {
1064 struct EventClassTypeDescr
1066 using Const = ConstEventClass;
1067 using NonConst = EventClass;
1071 struct TypeDescr<EventClass> : public EventClassTypeDescr
1076 struct TypeDescr<ConstEventClass> : public EventClassTypeDescr
1080 } /* namespace internal */
1082 template <typename LibObjT>
1083 typename CommonEvent<LibObjT>::Class CommonEvent<LibObjT>::cls() const noexcept
1085 return Class {_Spec::cls(this->libObjPtr())};
1088 namespace internal {
1090 struct StreamClassRefFuncs final
1092 static void get(const bt_stream_class * const libObjPtr) noexcept
1094 bt_stream_class_get_ref(libObjPtr);
1097 static void put(const bt_stream_class * const libObjPtr) noexcept
1099 bt_stream_class_put_ref(libObjPtr);
1103 template <typename LibObjT>
1104 struct CommonStreamClassSpec;
1106 /* Functions specific to mutable stream classes */
1108 struct CommonStreamClassSpec<bt_stream_class> final
1110 static bt_trace_class *traceClass(bt_stream_class * const libObjPtr) noexcept
1112 return bt_stream_class_borrow_trace_class(libObjPtr);
1115 static bt_event_class *eventClassByIndex(bt_stream_class * const libObjPtr,
1116 const std::uint64_t index) noexcept
1118 return bt_stream_class_borrow_event_class_by_index(libObjPtr, index);
1121 static bt_event_class *eventClassById(bt_stream_class * const libObjPtr,
1122 const std::uint64_t id) noexcept
1124 return bt_stream_class_borrow_event_class_by_id(libObjPtr, id);
1127 static bt_clock_class *defaultClockClass(bt_stream_class * const libObjPtr) noexcept
1129 return bt_stream_class_borrow_default_clock_class(libObjPtr);
1132 static bt_field_class *packetContextFieldClass(bt_stream_class * const libObjPtr) noexcept
1134 return bt_stream_class_borrow_packet_context_field_class(libObjPtr);
1137 static bt_field_class *eventCommonContextFieldClass(bt_stream_class * const libObjPtr) noexcept
1139 return bt_stream_class_borrow_event_common_context_field_class(libObjPtr);
1142 static bt_value *userAttributes(bt_stream_class * const libObjPtr) noexcept
1144 return bt_stream_class_borrow_user_attributes(libObjPtr);
1148 /* Functions specific to constant stream classes */
1150 struct CommonStreamClassSpec<const bt_stream_class> final
1152 static const bt_trace_class *traceClass(const bt_stream_class * const libObjPtr) noexcept
1154 return bt_stream_class_borrow_trace_class_const(libObjPtr);
1157 static const bt_event_class *eventClassByIndex(const bt_stream_class * const libObjPtr,
1158 const std::uint64_t index) noexcept
1160 return bt_stream_class_borrow_event_class_by_index_const(libObjPtr, index);
1163 static const bt_event_class *eventClassById(const bt_stream_class * const libObjPtr,
1164 const std::uint64_t id) noexcept
1166 return bt_stream_class_borrow_event_class_by_id_const(libObjPtr, id);
1169 static const bt_clock_class *defaultClockClass(const bt_stream_class * const libObjPtr) noexcept
1171 return bt_stream_class_borrow_default_clock_class_const(libObjPtr);
1174 static const bt_field_class *
1175 packetContextFieldClass(const bt_stream_class * const libObjPtr) noexcept
1177 return bt_stream_class_borrow_packet_context_field_class_const(libObjPtr);
1180 static const bt_field_class *
1181 eventCommonContextFieldClass(const bt_stream_class * const libObjPtr) noexcept
1183 return bt_stream_class_borrow_event_common_context_field_class_const(libObjPtr);
1186 static const bt_value *userAttributes(const bt_stream_class * const libObjPtr) noexcept
1188 return bt_stream_class_borrow_user_attributes_const(libObjPtr);
1192 } /* namespace internal */
1194 template <typename LibObjT>
1195 class CommonStreamClass final : public BorrowedObject<LibObjT>
1198 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1199 using _Spec = internal::CommonStreamClassSpec<LibObjT>;
1200 using _StructureFieldClass = internal::DepStructFc<LibObjT>;
1202 using _TraceClass = internal::DepType<LibObjT, CommonTraceClass<bt_trace_class>,
1203 CommonTraceClass<const bt_trace_class>>;
1205 using _EventClass = internal::DepType<LibObjT, CommonEventClass<bt_event_class>,
1206 CommonEventClass<const bt_event_class>>;
1208 using _ClockClass = internal::DepType<LibObjT, ClockClass, ConstClockClass>;
1211 using typename BorrowedObject<LibObjT>::LibObjPtr;
1212 using Shared = SharedObject<CommonStreamClass, LibObjT, internal::StreamClassRefFuncs>;
1213 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1215 explicit CommonStreamClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
1219 template <typename OtherLibObjT>
1220 CommonStreamClass(const CommonStreamClass<OtherLibObjT> streamClass) noexcept :
1221 _ThisBorrowedObject {streamClass}
1225 template <typename OtherLibObjT>
1226 CommonStreamClass operator=(const CommonStreamClass<OtherLibObjT> streamClass) noexcept
1228 _ThisBorrowedObject::operator=(streamClass);
1232 CommonStreamClass<const bt_stream_class> asConst() const noexcept
1234 return CommonStreamClass<const bt_stream_class> {*this};
1237 Stream::Shared instantiate(const Trace trace) const
1239 static_assert(!std::is_const<LibObjT>::value,
1240 "Not available with `bt2::ConstStreamClass`.");
1242 const auto libObjPtr = bt_stream_create(this->libObjPtr(), trace.libObjPtr());
1244 internal::validateCreatedObjPtr(libObjPtr);
1245 return Stream::Shared::createWithoutRef(libObjPtr);
1248 Stream::Shared instantiate(const Trace trace, const std::uint64_t id) const
1250 static_assert(!std::is_const<LibObjT>::value,
1251 "Not available with `bt2::ConstStreamClass`.");
1253 const auto libObjPtr = bt_stream_create_with_id(this->libObjPtr(), trace.libObjPtr(), id);
1255 internal::validateCreatedObjPtr(libObjPtr);
1256 return Stream::Shared::createWithoutRef(libObjPtr);
1259 EventClass::Shared createEventClass() const
1261 static_assert(!std::is_const<LibObjT>::value,
1262 "Not available with `bt2::ConstStreamClass`.");
1264 const auto libObjPtr = bt_event_class_create(this->libObjPtr());
1266 internal::validateCreatedObjPtr(libObjPtr);
1267 return EventClass::Shared::createWithoutRef(libObjPtr);
1270 EventClass::Shared createEventClass(const std::uint64_t id) const
1272 static_assert(!std::is_const<LibObjT>::value,
1273 "Not available with `bt2::ConstStreamClass`.");
1275 const auto libObjPtr = bt_event_class_create_with_id(this->libObjPtr(), id);
1277 internal::validateCreatedObjPtr(libObjPtr);
1278 return EventClass::Shared::createWithoutRef(libObjPtr);
1281 _TraceClass traceClass() const noexcept;
1283 std::uint64_t id() const noexcept
1285 return bt_stream_class_get_id(this->libObjPtr());
1288 void name(const char * const name) const
1290 static_assert(!std::is_const<LibObjT>::value,
1291 "Not available with `bt2::ConstStreamClass`.");
1293 const auto status = bt_stream_class_set_name(this->libObjPtr(), name);
1295 if (status == BT_STREAM_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
1296 throw MemoryError {};
1300 void name(const std::string& name) const
1302 this->name(name.data());
1305 bt2c::CStringView name() const noexcept
1307 return bt_stream_class_get_name(this->libObjPtr());
1310 void assignsAutomaticEventClassId(const bool val) const noexcept
1312 static_assert(!std::is_const<LibObjT>::value,
1313 "Not available with `bt2::ConstStreamClass`.");
1315 bt_stream_class_set_assigns_automatic_event_class_id(this->libObjPtr(),
1316 static_cast<bt_bool>(val));
1319 bool assignsAutomaticEventClassId() const noexcept
1321 return static_cast<bool>(
1322 bt_stream_class_assigns_automatic_event_class_id(this->libObjPtr()));
1325 void assignsAutomaticStreamId(const bool val) const noexcept
1327 static_assert(!std::is_const<LibObjT>::value,
1328 "Not available with `bt2::ConstStreamClass`.");
1330 bt_stream_class_set_assigns_automatic_stream_id(this->libObjPtr(),
1331 static_cast<bt_bool>(val));
1334 bool assignsAutomaticStreamId() const noexcept
1336 return static_cast<bool>(bt_stream_class_assigns_automatic_stream_id(this->libObjPtr()));
1339 void supportsPackets(const bool supportsPackets, const bool withBeginningDefaultClkSnapshot,
1340 const bool withEndDefaultClkSnapshot) const noexcept
1342 static_assert(!std::is_const<LibObjT>::value,
1343 "Not available with `bt2::ConstStreamClass`.");
1345 bt_stream_class_set_supports_packets(this->libObjPtr(),
1346 static_cast<bt_bool>(supportsPackets),
1347 static_cast<bt_bool>(withBeginningDefaultClkSnapshot),
1348 static_cast<bt_bool>(withEndDefaultClkSnapshot));
1351 bool supportsPackets() const noexcept
1353 return static_cast<bool>(bt_stream_class_supports_packets(this->libObjPtr()));
1356 bool packetsHaveBeginningClockSnapshot() const noexcept
1358 return static_cast<bool>(
1359 bt_stream_class_packets_have_beginning_default_clock_snapshot(this->libObjPtr()));
1362 bool packetsHaveEndClockSnapshot() const noexcept
1364 return static_cast<bool>(
1365 bt_stream_class_packets_have_end_default_clock_snapshot(this->libObjPtr()));
1368 void supportsDiscardedEvents(const bool supportsDiscardedEvents,
1369 const bool withDefaultClkSnapshots) const noexcept
1371 static_assert(!std::is_const<LibObjT>::value,
1372 "Not available with `bt2::ConstStreamClass`.");
1374 bt_stream_class_set_supports_discarded_events(
1375 this->libObjPtr(), static_cast<bt_bool>(supportsDiscardedEvents),
1376 static_cast<bt_bool>(withDefaultClkSnapshots));
1379 bool supportsDiscardedEvents() const noexcept
1381 return static_cast<bool>(bt_stream_class_supports_discarded_events(this->libObjPtr()));
1384 bool discardedEventsHaveDefaultClockSnapshots() const noexcept
1386 return static_cast<bool>(
1387 bt_stream_class_discarded_events_have_default_clock_snapshots(this->libObjPtr()));
1390 void supportsDiscardedPackets(const bool supportsDiscardedPackets,
1391 const bool withDefaultClkSnapshots) const noexcept
1393 static_assert(!std::is_const<LibObjT>::value,
1394 "Not available with `bt2::ConstStreamClass`.");
1396 bt_stream_class_set_supports_discarded_packets(
1397 this->libObjPtr(), static_cast<bt_bool>(supportsDiscardedPackets),
1398 static_cast<bt_bool>(withDefaultClkSnapshots));
1401 bool supportsDiscardedPackets() const noexcept
1403 return static_cast<bool>(bt_stream_class_supports_discarded_packets(this->libObjPtr()));
1406 bool discardedPacketsHaveDefaultClockSnapshots() const noexcept
1408 return static_cast<bool>(
1409 bt_stream_class_discarded_packets_have_default_clock_snapshots(this->libObjPtr()));
1412 void defaultClockClass(const ClockClass clkCls) const
1414 static_assert(!std::is_const<LibObjT>::value,
1415 "Not available with `bt2::ConstStreamClass`.");
1418 bt_stream_class_set_default_clock_class(this->libObjPtr(), clkCls.libObjPtr());
1420 BT_ASSERT(status == BT_STREAM_CLASS_SET_DEFAULT_CLOCK_CLASS_STATUS_OK);
1423 OptionalBorrowedObject<_ClockClass> defaultClockClass() const noexcept
1425 return _Spec::defaultClockClass(this->libObjPtr());
1428 std::uint64_t length() const noexcept
1430 return bt_stream_class_get_event_class_count(this->libObjPtr());
1433 _EventClass operator[](const std::uint64_t index) const noexcept
1435 return _EventClass {_Spec::eventClassByIndex(this->libObjPtr(), index)};
1438 OptionalBorrowedObject<_EventClass> eventClassById(const std::uint64_t id) const noexcept
1440 return _Spec::eventClassById(this->libObjPtr(), id);
1443 void packetContextFieldClass(const StructureFieldClass fc) const
1445 static_assert(!std::is_const<LibObjT>::value,
1446 "Not available with `bt2::ConstStreamClass`.");
1449 bt_stream_class_set_packet_context_field_class(this->libObjPtr(), fc.libObjPtr());
1451 if (status == BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR) {
1452 throw MemoryError {};
1456 OptionalBorrowedObject<_StructureFieldClass> packetContextFieldClass() const noexcept
1458 return _Spec::packetContextFieldClass(this->libObjPtr());
1461 void eventCommonContextFieldClass(const StructureFieldClass fc) const
1463 static_assert(!std::is_const<LibObjT>::value,
1464 "Not available with `bt2::ConstStreamClass`.");
1467 bt_stream_class_set_event_common_context_field_class(this->libObjPtr(), fc.libObjPtr());
1469 if (status == BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR) {
1470 throw MemoryError {};
1474 OptionalBorrowedObject<_StructureFieldClass> eventCommonContextFieldClass() const noexcept
1476 return _Spec::eventCommonContextFieldClass(this->libObjPtr());
1479 template <typename LibValT>
1480 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1482 static_assert(!std::is_const<LibObjT>::value,
1483 "Not available with `bt2::ConstStreamClass`.");
1485 bt_stream_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1488 UserAttributes userAttributes() const noexcept
1490 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
1493 Shared shared() const noexcept
1495 return Shared::createWithRef(*this);
1499 using StreamClass = CommonStreamClass<bt_stream_class>;
1500 using ConstStreamClass = CommonStreamClass<const bt_stream_class>;
1502 namespace internal {
1504 struct StreamClassTypeDescr
1506 using Const = ConstStreamClass;
1507 using NonConst = StreamClass;
1511 struct TypeDescr<StreamClass> : public StreamClassTypeDescr
1516 struct TypeDescr<ConstStreamClass> : public StreamClassTypeDescr
1520 } /* namespace internal */
1522 template <typename LibObjT>
1523 typename CommonEventClass<LibObjT>::_StreamClass
1524 CommonEventClass<LibObjT>::streamClass() const noexcept
1526 return _StreamClass {_Spec::streamClass(this->libObjPtr())};
1529 template <typename LibObjT>
1530 typename CommonStream<LibObjT>::Class CommonStream<LibObjT>::cls() const noexcept
1532 return Class {_Spec::cls(this->libObjPtr())};
1535 namespace internal {
1537 struct TraceClassRefFuncs final
1539 static void get(const bt_trace_class * const libObjPtr) noexcept
1541 bt_trace_class_get_ref(libObjPtr);
1544 static void put(const bt_trace_class * const libObjPtr) noexcept
1546 bt_trace_class_put_ref(libObjPtr);
1550 template <typename LibObjT>
1551 struct CommonTraceClassSpec;
1553 /* Functions specific to mutable stream classes */
1555 struct CommonTraceClassSpec<bt_trace_class> final
1557 static bt_stream_class *streamClassByIndex(bt_trace_class * const libObjPtr,
1558 const std::uint64_t index) noexcept
1560 return bt_trace_class_borrow_stream_class_by_index(libObjPtr, index);
1563 static bt_stream_class *streamClassById(bt_trace_class * const libObjPtr,
1564 const std::uint64_t id) noexcept
1566 return bt_trace_class_borrow_stream_class_by_id(libObjPtr, id);
1569 static bt_value *userAttributes(bt_trace_class * const libObjPtr) noexcept
1571 return bt_trace_class_borrow_user_attributes(libObjPtr);
1575 /* Functions specific to constant stream classes */
1577 struct CommonTraceClassSpec<const bt_trace_class> final
1579 static const bt_stream_class *streamClassByIndex(const bt_trace_class * const libObjPtr,
1580 const std::uint64_t index) noexcept
1582 return bt_trace_class_borrow_stream_class_by_index_const(libObjPtr, index);
1585 static const bt_stream_class *streamClassById(const bt_trace_class * const libObjPtr,
1586 const std::uint64_t id) noexcept
1588 return bt_trace_class_borrow_stream_class_by_id_const(libObjPtr, id);
1591 static const bt_value *userAttributes(const bt_trace_class * const libObjPtr) noexcept
1593 return bt_trace_class_borrow_user_attributes_const(libObjPtr);
1597 } /* namespace internal */
1599 template <typename LibObjT>
1600 class CommonTraceClass final : public BorrowedObject<LibObjT>
1603 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1605 using _Spec = internal::CommonTraceClassSpec<LibObjT>;
1607 using _StreamClass = internal::DepType<LibObjT, CommonStreamClass<bt_stream_class>,
1608 CommonStreamClass<const bt_stream_class>>;
1611 using typename BorrowedObject<LibObjT>::LibObjPtr;
1612 using Shared = SharedObject<CommonTraceClass, LibObjT, internal::TraceClassRefFuncs>;
1613 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1615 explicit CommonTraceClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
1619 template <typename OtherLibObjT>
1620 CommonTraceClass(const CommonTraceClass<OtherLibObjT> traceClass) noexcept :
1621 _ThisBorrowedObject {traceClass}
1625 template <typename OtherLibObjT>
1626 CommonTraceClass operator=(const CommonTraceClass<OtherLibObjT> traceClass) noexcept
1628 _ThisBorrowedObject::operator=(traceClass);
1632 CommonTraceClass<const bt_trace_class> asConst() const noexcept
1634 return CommonTraceClass<const bt_trace_class> {*this};
1637 Trace::Shared instantiate() const
1639 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1641 const auto libObjPtr = bt_trace_create(this->libObjPtr());
1643 internal::validateCreatedObjPtr(libObjPtr);
1644 return Trace::Shared::createWithoutRef(libObjPtr);
1647 StreamClass::Shared createStreamClass() const
1649 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1651 const auto libObjPtr = bt_stream_class_create(this->libObjPtr());
1653 internal::validateCreatedObjPtr(libObjPtr);
1654 return StreamClass::Shared::createWithoutRef(libObjPtr);
1657 StreamClass::Shared createStreamClass(const std::uint64_t id) const
1659 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1661 const auto libObjPtr = bt_stream_class_create_with_id(this->libObjPtr(), id);
1663 internal::validateCreatedObjPtr(libObjPtr);
1664 return StreamClass::Shared::createWithoutRef(libObjPtr);
1667 FieldClass::Shared createBoolFieldClass() const
1669 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1671 const auto libObjPtr = bt_field_class_bool_create(this->libObjPtr());
1673 internal::validateCreatedObjPtr(libObjPtr);
1674 return FieldClass::Shared::createWithoutRef(libObjPtr);
1677 BitArrayFieldClass::Shared createBitArrayFieldClass(const std::uint64_t length) const
1679 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1681 const auto libObjPtr = bt_field_class_bit_array_create(this->libObjPtr(), length);
1683 internal::validateCreatedObjPtr(libObjPtr);
1684 return BitArrayFieldClass::Shared::createWithoutRef(libObjPtr);
1687 IntegerFieldClass::Shared createUnsignedIntegerFieldClass() const
1689 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1691 const auto libObjPtr = bt_field_class_integer_unsigned_create(this->libObjPtr());
1693 internal::validateCreatedObjPtr(libObjPtr);
1694 return IntegerFieldClass::Shared::createWithoutRef(libObjPtr);
1697 IntegerFieldClass::Shared createSignedIntegerFieldClass() const
1699 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1701 const auto libObjPtr = bt_field_class_integer_signed_create(this->libObjPtr());
1703 internal::validateCreatedObjPtr(libObjPtr);
1704 return IntegerFieldClass::Shared::createWithoutRef(libObjPtr);
1707 UnsignedEnumerationFieldClass::Shared createUnsignedEnumerationFieldClass() const
1709 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1711 const auto libObjPtr = bt_field_class_enumeration_unsigned_create(this->libObjPtr());
1713 internal::validateCreatedObjPtr(libObjPtr);
1714 return UnsignedEnumerationFieldClass::Shared::createWithoutRef(libObjPtr);
1717 SignedEnumerationFieldClass::Shared createSignedEnumerationFieldClass() const
1719 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1721 const auto libObjPtr = bt_field_class_enumeration_signed_create(this->libObjPtr());
1723 internal::validateCreatedObjPtr(libObjPtr);
1724 return SignedEnumerationFieldClass::Shared::createWithoutRef(libObjPtr);
1727 FieldClass::Shared createSinglePrecisionRealFieldClass() const
1729 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1731 const auto libObjPtr = bt_field_class_real_single_precision_create(this->libObjPtr());
1733 internal::validateCreatedObjPtr(libObjPtr);
1734 return FieldClass::Shared::createWithoutRef(libObjPtr);
1737 FieldClass::Shared createDoublePrecisionRealFieldClass() const
1739 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1741 const auto libObjPtr = bt_field_class_real_double_precision_create(this->libObjPtr());
1743 internal::validateCreatedObjPtr(libObjPtr);
1744 return FieldClass::Shared::createWithoutRef(libObjPtr);
1747 FieldClass::Shared createStringFieldClass() const
1749 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1751 const auto libObjPtr = bt_field_class_string_create(this->libObjPtr());
1753 internal::validateCreatedObjPtr(libObjPtr);
1754 return FieldClass::Shared::createWithoutRef(libObjPtr);
1757 StaticArrayFieldClass::Shared createStaticArrayFieldClass(const FieldClass elementFieldClass,
1758 const std::uint64_t length) const
1760 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1762 const auto libObjPtr = bt_field_class_array_static_create(
1763 this->libObjPtr(), elementFieldClass.libObjPtr(), length);
1765 internal::validateCreatedObjPtr(libObjPtr);
1766 return StaticArrayFieldClass::Shared::createWithoutRef(libObjPtr);
1769 ArrayFieldClass::Shared createDynamicArrayFieldClass(const FieldClass elementFieldClass) const
1771 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1773 const auto libObjPtr = bt_field_class_array_dynamic_create(
1774 this->libObjPtr(), elementFieldClass.libObjPtr(), nullptr);
1776 internal::validateCreatedObjPtr(libObjPtr);
1777 return ArrayFieldClass::Shared::createWithoutRef(libObjPtr);
1780 DynamicArrayWithLengthFieldClass::Shared
1781 createDynamicArrayFieldClass(const FieldClass elementFieldClass,
1782 const IntegerFieldClass lengthFieldClass) const
1784 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1786 const auto libObjPtr = bt_field_class_array_dynamic_create(
1787 this->libObjPtr(), elementFieldClass.libObjPtr(), lengthFieldClass.libObjPtr());
1789 internal::validateCreatedObjPtr(libObjPtr);
1790 return DynamicArrayWithLengthFieldClass::Shared::createWithoutRef(libObjPtr);
1793 StructureFieldClass::Shared createStructureFieldClass() const
1795 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1797 const auto libObjPtr = bt_field_class_structure_create(this->libObjPtr());
1799 internal::validateCreatedObjPtr(libObjPtr);
1800 return StructureFieldClass::Shared::createWithoutRef(libObjPtr);
1803 OptionFieldClass::Shared createOptionFieldClass(const FieldClass optionalFieldClass) const
1805 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1807 const auto libObjPtr = bt_field_class_option_without_selector_create(
1808 this->libObjPtr(), optionalFieldClass.libObjPtr());
1810 internal::validateCreatedObjPtr(libObjPtr);
1811 return OptionFieldClass::Shared::createWithoutRef(libObjPtr);
1814 OptionWithBoolSelectorFieldClass::Shared
1815 createOptionWithBoolSelectorFieldClass(const FieldClass optionalFieldClass,
1816 const FieldClass selectorFieldClass) const
1818 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1820 const auto libObjPtr = bt_field_class_option_with_selector_field_bool_create(
1821 this->libObjPtr(), optionalFieldClass.libObjPtr(), selectorFieldClass.libObjPtr());
1823 internal::validateCreatedObjPtr(libObjPtr);
1824 return OptionWithBoolSelectorFieldClass::Shared::createWithoutRef(libObjPtr);
1827 OptionWithUnsignedIntegerSelectorFieldClass::Shared
1828 createOptionWithUnsignedIntegerSelectorFieldClass(
1829 const FieldClass optionalFieldClass, const IntegerFieldClass selectorFieldClass,
1830 const ConstUnsignedIntegerRangeSet ranges) const
1832 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1834 const auto libObjPtr = bt_field_class_option_with_selector_field_integer_unsigned_create(
1835 this->libObjPtr(), optionalFieldClass.libObjPtr(), selectorFieldClass.libObjPtr(),
1836 ranges.libObjPtr());
1838 internal::validateCreatedObjPtr(libObjPtr);
1839 return OptionWithUnsignedIntegerSelectorFieldClass::Shared::createWithoutRef(libObjPtr);
1842 OptionWithSignedIntegerSelectorFieldClass::Shared
1843 createOptionWithSignedIntegerSelectorFieldClass(const FieldClass optionalFieldClass,
1844 const IntegerFieldClass selectorFieldClass,
1845 const ConstSignedIntegerRangeSet ranges) const
1847 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1849 const auto libObjPtr = bt_field_class_option_with_selector_field_integer_signed_create(
1850 this->libObjPtr(), optionalFieldClass.libObjPtr(), selectorFieldClass.libObjPtr(),
1851 ranges.libObjPtr());
1853 internal::validateCreatedObjPtr(libObjPtr);
1854 return OptionWithSignedIntegerSelectorFieldClass::Shared::createWithoutRef(libObjPtr);
1857 VariantWithoutSelectorFieldClass::Shared createVariantFieldClass() const
1859 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1861 const auto libObjPtr = bt_field_class_variant_create(this->libObjPtr(), nullptr);
1863 internal::validateCreatedObjPtr(libObjPtr);
1864 return VariantWithoutSelectorFieldClass::Shared::createWithoutRef(libObjPtr);
1867 VariantWithUnsignedIntegerSelectorFieldClass::Shared
1868 createVariantWithUnsignedIntegerSelectorFieldClass(
1869 const IntegerFieldClass selectorFieldClass) const
1871 return this->_createVariantWithIntegerSelectorFieldClass<
1872 VariantWithUnsignedIntegerSelectorFieldClass>(selectorFieldClass);
1875 VariantWithSignedIntegerSelectorFieldClass::Shared
1876 createVariantWithSignedIntegerSelectorFieldClass(
1877 const IntegerFieldClass selectorFieldClass) const
1879 return this->_createVariantWithIntegerSelectorFieldClass<
1880 VariantWithSignedIntegerSelectorFieldClass>(selectorFieldClass);
1883 void assignsAutomaticStreamClassId(const bool val) const noexcept
1885 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1887 bt_trace_class_set_assigns_automatic_stream_class_id(this->libObjPtr(),
1888 static_cast<bt_bool>(val));
1891 bool assignsAutomaticStreamClassId() const noexcept
1893 return static_cast<bool>(
1894 bt_trace_class_assigns_automatic_stream_class_id(this->libObjPtr()));
1897 std::uint64_t length() const noexcept
1899 return bt_trace_class_get_stream_class_count(this->libObjPtr());
1902 _StreamClass operator[](const std::uint64_t index) const noexcept
1904 return _StreamClass {_Spec::streamClassByIndex(this->libObjPtr(), index)};
1907 OptionalBorrowedObject<_StreamClass> streamClassById(const std::uint64_t id) const noexcept
1909 return _Spec::streamClassById(this->libObjPtr(), id);
1912 template <typename LibValT>
1913 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1915 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1917 bt_trace_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1920 UserAttributes userAttributes() const noexcept
1922 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
1925 Shared shared() const noexcept
1927 return Shared::createWithRef(*this);
1931 template <typename ObjT>
1932 typename ObjT::Shared
1933 _createVariantWithIntegerSelectorFieldClass(const IntegerFieldClass selectorFieldClass) const
1935 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTraceClass`.");
1937 const auto libObjPtr =
1938 bt_field_class_variant_create(this->libObjPtr(), selectorFieldClass.libObjPtr());
1940 internal::validateCreatedObjPtr(libObjPtr);
1941 return ObjT::Shared::createWithoutRef(libObjPtr);
1945 using TraceClass = CommonTraceClass<bt_trace_class>;
1946 using ConstTraceClass = CommonTraceClass<const bt_trace_class>;
1948 namespace internal {
1950 struct TraceClassTypeDescr
1952 using Const = ConstTraceClass;
1953 using NonConst = TraceClass;
1957 struct TypeDescr<TraceClass> : public TraceClassTypeDescr
1962 struct TypeDescr<ConstTraceClass> : public TraceClassTypeDescr
1966 } /* namespace internal */
1968 template <typename LibObjT>
1969 typename CommonStreamClass<LibObjT>::_TraceClass
1970 CommonStreamClass<LibObjT>::traceClass() const noexcept
1972 return _TraceClass {_Spec::traceClass(this->libObjPtr())};
1975 template <typename LibObjT>
1976 typename CommonTrace<LibObjT>::Class CommonTrace<LibObjT>::cls() const noexcept
1978 return Class {_Spec::cls(this->libObjPtr())};
1981 } /* namespace bt2 */
1983 #endif /* BABELTRACE_CPP_COMMON_BT2_TRACE_IR_HPP */