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/bt2s/optional.hpp"
17 #include "borrowed-object.hpp"
18 #include "clock-class.hpp"
19 #include "field-class.hpp"
21 #include "internal/utils.hpp"
22 #include "optional-borrowed-object.hpp"
23 #include "shared-object.hpp"
28 template <typename LibObjT>
31 template <typename LibObjT>
34 template <typename LibObjT>
37 template <typename LibObjT>
40 template <typename LibObjT>
41 class CommonEventClass;
43 template <typename LibObjT>
44 class CommonStreamClass;
46 template <typename LibObjT>
47 class CommonTraceClass;
51 template <typename LibObjT>
52 struct CommonEventSpec;
54 /* Functions specific to mutable events */
56 struct CommonEventSpec<bt_event> final
58 static bt_event_class *cls(bt_event * const libObjPtr) noexcept
60 return bt_event_borrow_class(libObjPtr);
63 static bt_stream *stream(bt_event * const libObjPtr) noexcept
65 return bt_event_borrow_stream(libObjPtr);
68 static bt_packet *packet(bt_event * const libObjPtr) noexcept
70 return bt_event_borrow_packet(libObjPtr);
73 static bt_field *payloadField(bt_event * const libObjPtr) noexcept
75 return bt_event_borrow_payload_field(libObjPtr);
78 static bt_field *specificContextField(bt_event * const libObjPtr) noexcept
80 return bt_event_borrow_specific_context_field(libObjPtr);
83 static bt_field *commonContextField(bt_event * const libObjPtr) noexcept
85 return bt_event_borrow_common_context_field(libObjPtr);
89 /* Functions specific to constant events */
91 struct CommonEventSpec<const bt_event> final
93 static const bt_event_class *cls(const bt_event * const libObjPtr) noexcept
95 return bt_event_borrow_class_const(libObjPtr);
98 static const bt_stream *stream(const bt_event * const libObjPtr) noexcept
100 return bt_event_borrow_stream_const(libObjPtr);
103 static const bt_packet *packet(const bt_event * const libObjPtr) noexcept
105 return bt_event_borrow_packet_const(libObjPtr);
108 static const bt_field *payloadField(const bt_event * const libObjPtr) noexcept
110 return bt_event_borrow_payload_field_const(libObjPtr);
113 static const bt_field *specificContextField(const bt_event * const libObjPtr) noexcept
115 return bt_event_borrow_specific_context_field_const(libObjPtr);
118 static const bt_field *commonContextField(const bt_event * const libObjPtr) noexcept
120 return bt_event_borrow_common_context_field_const(libObjPtr);
124 template <typename LibObjT>
125 using DepStructField = DepType<LibObjT, StructureField, ConstStructureField>;
127 } /* namespace internal */
129 template <typename LibObjT>
130 class CommonEvent final : public BorrowedObject<LibObjT>
133 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
134 using _Spec = internal::CommonEventSpec<LibObjT>;
135 using _Packet = internal::DepPacket<LibObjT>;
136 using _Stream = internal::DepStream<LibObjT>;
137 using _StructureField = internal::DepStructField<LibObjT>;
140 using typename BorrowedObject<LibObjT>::LibObjPtr;
142 using Class = internal::DepType<LibObjT, CommonEventClass<bt_event_class>,
143 CommonEventClass<const bt_event_class>>;
145 explicit CommonEvent(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
149 template <typename OtherLibObjT>
150 CommonEvent(const CommonEvent<OtherLibObjT> event) noexcept : _ThisBorrowedObject {event}
154 template <typename OtherLibObjT>
155 CommonEvent<LibObjT> operator=(const CommonEvent<OtherLibObjT> event) noexcept
157 _ThisBorrowedObject::operator=(event);
161 CommonEvent<const bt_event> asConst() const noexcept
163 return CommonEvent<const bt_event> {*this};
166 Class cls() const noexcept;
167 _Stream stream() const noexcept;
168 OptionalBorrowedObject<_Packet> packet() const noexcept;
170 OptionalBorrowedObject<_StructureField> payloadField() const noexcept
172 return _Spec::payloadField(this->libObjPtr());
175 OptionalBorrowedObject<_StructureField> specificContextField() const noexcept
177 return _Spec::specificContextField(this->libObjPtr());
180 OptionalBorrowedObject<_StructureField> commonContextField() const noexcept
182 return _Spec::commonContextField(this->libObjPtr());
186 using Event = CommonEvent<bt_event>;
187 using ConstEvent = CommonEvent<const bt_event>;
191 struct EventTypeDescr
193 using Const = ConstEvent;
194 using NonConst = Event;
198 struct TypeDescr<Event> : public EventTypeDescr
203 struct TypeDescr<ConstEvent> : public EventTypeDescr
207 struct PacketRefFuncs final
209 static void get(const bt_packet * const libObjPtr) noexcept
211 bt_packet_get_ref(libObjPtr);
214 static void put(const bt_packet * const libObjPtr) noexcept
216 bt_packet_put_ref(libObjPtr);
220 template <typename LibObjT>
221 struct CommonPacketSpec;
223 /* Functions specific to mutable packets */
225 struct CommonPacketSpec<bt_packet> final
227 static bt_stream *stream(bt_packet * const libObjPtr) noexcept
229 return bt_packet_borrow_stream(libObjPtr);
232 static bt_field *contextField(bt_packet * const libObjPtr) noexcept
234 return bt_packet_borrow_context_field(libObjPtr);
238 /* Functions specific to constant packets */
240 struct CommonPacketSpec<const bt_packet> final
242 static const bt_stream *stream(const bt_packet * const libObjPtr) noexcept
244 return bt_packet_borrow_stream_const(libObjPtr);
247 static const bt_field *contextField(const bt_packet * const libObjPtr) noexcept
249 return bt_packet_borrow_context_field_const(libObjPtr);
253 } /* namespace internal */
255 template <typename LibObjT>
256 class CommonPacket final : public BorrowedObject<LibObjT>
259 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
260 using _Spec = internal::CommonPacketSpec<LibObjT>;
261 using _Stream = internal::DepStream<LibObjT>;
262 using _StructureField = internal::DepStructField<LibObjT>;
265 using typename BorrowedObject<LibObjT>::LibObjPtr;
266 using Shared = SharedObject<CommonPacket, LibObjT, internal::PacketRefFuncs>;
268 explicit CommonPacket(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
272 template <typename OtherLibObjT>
273 CommonPacket(const CommonPacket<OtherLibObjT> packet) noexcept : _ThisBorrowedObject {packet}
277 template <typename OtherLibObjT>
278 CommonPacket operator=(const CommonPacket<OtherLibObjT> packet) noexcept
280 _ThisBorrowedObject::operator=(packet);
284 CommonPacket<const bt_packet> asConst() const noexcept
286 return CommonPacket<const bt_packet> {*this};
289 _Stream stream() const noexcept;
291 OptionalBorrowedObject<_StructureField> contextField() const noexcept
293 return _Spec::contextField(this->libObjPtr());
296 Shared shared() const noexcept
298 return Shared::createWithRef(*this);
302 using Packet = CommonPacket<bt_packet>;
303 using ConstPacket = CommonPacket<const bt_packet>;
307 struct PacketTypeDescr
309 using Const = ConstPacket;
310 using NonConst = Packet;
314 struct TypeDescr<Packet> : public PacketTypeDescr
319 struct TypeDescr<ConstPacket> : public PacketTypeDescr
323 } /* namespace internal */
325 template <typename LibObjT>
326 OptionalBorrowedObject<typename CommonEvent<LibObjT>::_Packet>
327 CommonEvent<LibObjT>::packet() const noexcept
329 return _Spec::packet(this->libObjPtr());
334 struct StreamRefFuncs final
336 static void get(const bt_stream * const libObjPtr) noexcept
338 bt_stream_get_ref(libObjPtr);
341 static void put(const bt_stream * const libObjPtr) noexcept
343 bt_stream_put_ref(libObjPtr);
347 template <typename LibObjT>
348 struct CommonStreamSpec;
350 /* Functions specific to mutable streams */
352 struct CommonStreamSpec<bt_stream> final
354 static bt_stream_class *cls(bt_stream * const libObjPtr) noexcept
356 return bt_stream_borrow_class(libObjPtr);
359 static bt_trace *trace(bt_stream * const libObjPtr) noexcept
361 return bt_stream_borrow_trace(libObjPtr);
364 static bt_value *userAttributes(bt_stream * const libObjPtr) noexcept
366 return bt_stream_borrow_user_attributes(libObjPtr);
370 /* Functions specific to constant streams */
372 struct CommonStreamSpec<const bt_stream> final
374 static const bt_stream_class *cls(const bt_stream * const libObjPtr) noexcept
376 return bt_stream_borrow_class_const(libObjPtr);
379 static const bt_trace *trace(const bt_stream * const libObjPtr) noexcept
381 return bt_stream_borrow_trace_const(libObjPtr);
384 static const bt_value *userAttributes(const bt_stream * const libObjPtr) noexcept
386 return bt_stream_borrow_user_attributes_const(libObjPtr);
390 } /* namespace internal */
392 template <typename LibObjT>
393 class CommonStream final : public BorrowedObject<LibObjT>
396 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
397 using _Spec = internal::CommonStreamSpec<LibObjT>;
398 using _Trace = internal::DepType<LibObjT, CommonTrace<bt_trace>, CommonTrace<const bt_trace>>;
401 using typename BorrowedObject<LibObjT>::LibObjPtr;
402 using Shared = SharedObject<CommonStream, LibObjT, internal::StreamRefFuncs>;
403 using UserAttributes = internal::DepUserAttrs<LibObjT>;
405 using Class = internal::DepType<LibObjT, CommonStreamClass<bt_stream_class>,
406 CommonStreamClass<const bt_stream_class>>;
408 explicit CommonStream(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
412 template <typename OtherLibObjT>
413 CommonStream(const CommonStream<OtherLibObjT> stream) noexcept : _ThisBorrowedObject {stream}
417 template <typename OtherLibObjT>
418 CommonStream operator=(const CommonStream<OtherLibObjT> stream) noexcept
420 _ThisBorrowedObject::operator=(stream);
424 CommonStream<const bt_stream> asConst() const noexcept
426 return CommonStream<const bt_stream> {*this};
429 Packet::Shared createPacket() const
431 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstStream`.");
433 const auto libObjPtr = bt_packet_create(this->libObjPtr());
435 internal::validateCreatedObjPtr(libObjPtr);
436 return Packet::Shared::createWithoutRef(libObjPtr);
439 Class cls() const noexcept;
440 _Trace trace() const noexcept;
442 std::uint64_t id() const noexcept
444 return bt_stream_get_id(this->libObjPtr());
447 void name(const char * const name) const
449 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstStream`.");
451 const auto status = bt_stream_set_name(this->libObjPtr(), name);
453 if (status == BT_STREAM_SET_NAME_STATUS_MEMORY_ERROR) {
454 throw MemoryError {};
458 void name(const std::string& name) const
460 this->name(name.data());
463 const char *name() const noexcept
465 return bt_stream_get_name(this->libObjPtr());
468 template <typename LibValT>
469 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
471 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstStream`.");
473 bt_stream_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
476 UserAttributes userAttributes() const noexcept
478 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
481 Shared shared() const noexcept
483 return Shared::createWithRef(*this);
487 using Stream = CommonStream<bt_stream>;
488 using ConstStream = CommonStream<const bt_stream>;
492 struct StreamTypeDescr
494 using Const = ConstStream;
495 using NonConst = Stream;
499 struct TypeDescr<Stream> : public StreamTypeDescr
504 struct TypeDescr<ConstStream> : public StreamTypeDescr
508 } /* namespace internal */
510 template <typename LibObjT>
511 typename CommonEvent<LibObjT>::_Stream CommonEvent<LibObjT>::stream() const noexcept
513 return _Stream {_Spec::stream(this->libObjPtr())};
516 template <typename LibObjT>
517 typename CommonPacket<LibObjT>::_Stream CommonPacket<LibObjT>::stream() const noexcept
519 return _Stream {_Spec::stream(this->libObjPtr())};
524 struct TraceRefFuncs final
526 static void get(const bt_trace * const libObjPtr) noexcept
528 bt_trace_get_ref(libObjPtr);
531 static void put(const bt_trace * const libObjPtr) noexcept
533 bt_trace_put_ref(libObjPtr);
537 template <typename LibObjT>
538 struct CommonTraceSpec;
540 /* Functions specific to mutable traces */
542 struct CommonTraceSpec<bt_trace> final
544 static bt_trace_class *cls(bt_trace * const libObjPtr) noexcept
546 return bt_trace_borrow_class(libObjPtr);
549 static bt_stream *streamByIndex(bt_trace * const libObjPtr, const std::uint64_t index) noexcept
551 return bt_trace_borrow_stream_by_index(libObjPtr, index);
554 static bt_stream *streamById(bt_trace * const libObjPtr, const std::uint64_t id) noexcept
556 return bt_trace_borrow_stream_by_id(libObjPtr, id);
559 static bt_value *userAttributes(bt_trace * const libObjPtr) noexcept
561 return bt_trace_borrow_user_attributes(libObjPtr);
565 /* Functions specific to constant traces */
567 struct CommonTraceSpec<const bt_trace> final
569 static const bt_trace_class *cls(const bt_trace * const libObjPtr) noexcept
571 return bt_trace_borrow_class_const(libObjPtr);
574 static const bt_stream *streamByIndex(const bt_trace * const libObjPtr,
575 const std::uint64_t index) noexcept
577 return bt_trace_borrow_stream_by_index_const(libObjPtr, index);
580 static const bt_stream *streamById(const bt_trace * const libObjPtr,
581 const std::uint64_t id) noexcept
583 return bt_trace_borrow_stream_by_id_const(libObjPtr, id);
586 static const bt_value *userAttributes(const bt_trace * const libObjPtr) noexcept
588 return bt_trace_borrow_user_attributes_const(libObjPtr);
592 } /* namespace internal */
594 template <typename LibObjT>
595 class CommonTrace final : public BorrowedObject<LibObjT>
598 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
599 using _Spec = internal::CommonTraceSpec<LibObjT>;
600 using _Stream = internal::DepStream<LibObjT>;
603 using typename BorrowedObject<LibObjT>::LibObjPtr;
604 using Shared = SharedObject<CommonTrace, LibObjT, internal::TraceRefFuncs>;
605 using UserAttributes = internal::DepUserAttrs<LibObjT>;
607 using Class = internal::DepType<LibObjT, CommonTraceClass<bt_trace_class>,
608 CommonTraceClass<const bt_trace_class>>;
610 struct ConstEnvironmentEntry
616 explicit CommonTrace(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
620 template <typename OtherLibObjT>
621 CommonTrace(const CommonTrace<OtherLibObjT> trace) noexcept : _ThisBorrowedObject {trace}
625 template <typename OtherLibObjT>
626 CommonTrace operator=(const CommonTrace<OtherLibObjT> trace) noexcept
628 _ThisBorrowedObject::operator=(trace);
632 CommonTrace<const bt_trace> asConst() const noexcept
634 return CommonTrace<const bt_trace> {*this};
637 Class cls() const noexcept;
639 void name(const char * const name) const
641 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
643 const auto status = bt_trace_set_name(this->libObjPtr(), name);
645 if (status == BT_TRACE_SET_NAME_STATUS_MEMORY_ERROR) {
646 throw MemoryError {};
650 void name(const std::string& name) const
652 this->name(name.data());
655 const char *name() const noexcept
657 return bt_trace_get_name(this->libObjPtr());
660 void uuid(const bt2c::UuidView& uuid) const noexcept
662 bt_trace_set_uuid(this->libObjPtr(), uuid.begin());
665 bt2s::optional<bt2c::UuidView> uuid() const noexcept
667 const auto uuid = bt_trace_get_uuid(this->libObjPtr());
670 return bt2c::UuidView {uuid};
673 return bt2s::nullopt;
676 std::uint64_t length() const noexcept
678 return bt_trace_get_stream_count(this->libObjPtr());
681 _Stream operator[](const std::uint64_t index) const noexcept
683 return _Stream {_Spec::streamByIndex(this->libObjPtr(), index)};
686 OptionalBorrowedObject<_Stream> streamById(const std::uint64_t id) const noexcept
688 return _Spec::streamById(this->libObjPtr(), id);
691 void environmentEntry(const char * const name, const std::int64_t val) const
693 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
695 const auto status = bt_trace_set_environment_entry_integer(this->libObjPtr(), name, val);
697 if (status == BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR) {
698 throw MemoryError {};
702 void environmentEntry(const std::string& name, const std::int64_t val) const
704 this->environmentEntry(name.data(), val);
707 void environmentEntry(const char * const name, const char * const val) const
709 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
711 const auto status = bt_trace_set_environment_entry_string(this->libObjPtr(), name, val);
713 if (status == BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR) {
714 throw MemoryError {};
718 void environmentEntry(const std::string& name, const char * const val) const
720 this->environmentEntry(name.data(), val);
723 void environmentEntry(const char * const name, const std::string& val) const
725 this->environmentEntry(name, val.data());
728 void environmentEntry(const std::string& name, const std::string& val) const
730 this->environmentEntry(name.data(), val.data());
733 std::uint64_t environmentSize() const noexcept
735 return bt_trace_get_environment_entry_count(this->libObjPtr());
738 ConstEnvironmentEntry environmentEntry(const std::uint64_t index) const noexcept
741 const bt_value *libObjPtr;
743 bt_trace_borrow_environment_entry_by_index_const(this->libObjPtr(), index, &name,
745 return ConstEnvironmentEntry {name, ConstValue {libObjPtr}};
748 OptionalBorrowedObject<ConstValue> environmentEntry(const char * const name) const noexcept
750 return bt_trace_borrow_environment_entry_value_by_name_const(this->libObjPtr(), name);
753 OptionalBorrowedObject<ConstValue> environmentEntry(const std::string& name) const noexcept
755 return this->environmentEntry(name.data());
758 template <typename LibValT>
759 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
761 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstTrace`.");
763 bt_trace_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
766 UserAttributes userAttributes() const noexcept
768 return UserAttributes {_Spec::userAttributes(this->libObjPtr())};
771 Shared shared() const noexcept
773 return Shared::createWithRef(*this);
777 using Trace = CommonTrace<bt_trace>;
778 using ConstTrace = CommonTrace<const bt_trace>;
782 struct TraceTypeDescr
784 using Const = ConstTrace;
785 using NonConst = Trace;
789 struct TypeDescr<Trace> : public TraceTypeDescr
794 struct TypeDescr<ConstTrace> : public TraceTypeDescr
798 } /* namespace internal */
800 template <typename LibObjT>
801 typename CommonStream<LibObjT>::_Trace CommonStream<LibObjT>::trace() const noexcept
803 return _Trace {_Spec::trace(this->libObjPtr())};
808 struct EventClassRefFuncs final
810 static void get(const bt_event_class * const libObjPtr) noexcept
812 bt_event_class_get_ref(libObjPtr);
815 static void put(const bt_event_class * const libObjPtr) noexcept
817 bt_event_class_put_ref(libObjPtr);
821 template <typename LibObjT>
822 struct CommonEventClassSpec;
824 /* Functions specific to mutable event classes */
826 struct CommonEventClassSpec<bt_event_class> final
828 static bt_stream_class *streamClass(bt_event_class * const libObjPtr) noexcept
830 return bt_event_class_borrow_stream_class(libObjPtr);
833 static bt_field_class *payloadFieldClass(bt_event_class * const libObjPtr) noexcept
835 return bt_event_class_borrow_payload_field_class(libObjPtr);
838 static bt_field_class *specificContextFieldClass(bt_event_class * const libObjPtr) noexcept
840 return bt_event_class_borrow_specific_context_field_class(libObjPtr);
843 static bt_value *userAttributes(bt_event_class * const libObjPtr) noexcept
845 return bt_event_class_borrow_user_attributes(libObjPtr);
849 /* Functions specific to constant event classes */
851 struct CommonEventClassSpec<const bt_event_class> final
853 static const bt_stream_class *streamClass(const bt_event_class * const libObjPtr) noexcept
855 return bt_event_class_borrow_stream_class_const(libObjPtr);
858 static const bt_field_class *payloadFieldClass(const bt_event_class * const libObjPtr) noexcept
860 return bt_event_class_borrow_payload_field_class_const(libObjPtr);
863 static const bt_field_class *
864 specificContextFieldClass(const bt_event_class * const libObjPtr) noexcept
866 return bt_event_class_borrow_specific_context_field_class_const(libObjPtr);
869 static const bt_value *userAttributes(const bt_event_class * const libObjPtr) noexcept
871 return bt_event_class_borrow_user_attributes_const(libObjPtr);
875 template <typename LibObjT>
876 using DepStructFc = DepType<LibObjT, StructureFieldClass, ConstStructureFieldClass>;
878 } /* namespace internal */
880 template <typename LibObjT>
881 class CommonEventClass final : public BorrowedObject<LibObjT>
884 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
885 using _Spec = internal::CommonEventClassSpec<LibObjT>;
886 using _StructureFieldClass = internal::DepStructFc<LibObjT>;
888 using _StreamClass = internal::DepType<LibObjT, CommonStreamClass<bt_stream_class>,
889 CommonStreamClass<const bt_stream_class>>;
892 using typename BorrowedObject<LibObjT>::LibObjPtr;
893 using Shared = SharedObject<CommonEventClass, LibObjT, internal::EventClassRefFuncs>;
894 using UserAttributes = internal::DepUserAttrs<LibObjT>;
898 EMERGENCY = BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY,
899 ALERT = BT_EVENT_CLASS_LOG_LEVEL_ALERT,
900 CRITICAL = BT_EVENT_CLASS_LOG_LEVEL_CRITICAL,
901 ERR = BT_EVENT_CLASS_LOG_LEVEL_ERROR,
902 WARNING = BT_EVENT_CLASS_LOG_LEVEL_WARNING,
903 NOTICE = BT_EVENT_CLASS_LOG_LEVEL_NOTICE,
904 INFO = BT_EVENT_CLASS_LOG_LEVEL_INFO,
905 DEBUG_SYSTEM = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM,
906 DEBUG_PROGRAM = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM,
907 DEBUG_PROC = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS,
908 DEBUG_MODULE = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE,
909 DEBUG_UNIT = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT,
910 DEBUG_FUNCTION = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION,
911 DEBUG_LINE = BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE,
912 DEBUG = BT_EVENT_CLASS_LOG_LEVEL_DEBUG,
915 explicit CommonEventClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
919 template <typename OtherLibObjT>
920 CommonEventClass(const CommonEventClass<OtherLibObjT> eventClass) noexcept :
921 _ThisBorrowedObject {eventClass}
925 template <typename OtherLibObjT>
926 CommonEventClass operator=(const CommonEventClass<OtherLibObjT> eventClass) noexcept
928 _ThisBorrowedObject::operator=(eventClass);
932 CommonEventClass<const bt_event_class> asConst() const noexcept
934 return CommonEventClass<const bt_event_class> {*this};
937 _StreamClass streamClass() const noexcept;
939 std::uint64_t id() const noexcept
941 return bt_event_class_get_id(this->libObjPtr());
944 void name(const char * const name) const
946 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
948 const auto status = bt_event_class_set_name(this->libObjPtr(), name);
950 if (status == BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
951 throw MemoryError {};
955 void name(const std::string& name) const
957 this->name(name.data());
960 const char *name() const noexcept
962 return bt_event_class_get_name(this->libObjPtr());
965 void logLevel(const LogLevel logLevel) const noexcept
967 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstEventClass`.");
969 bt_event_class_set_log_level(this->libObjPtr(),
970 static_cast<bt_event_class_log_level>(logLevel));
973 bt2s::optional<LogLevel> logLevel() const noexcept
975 bt_event_class_log_level libLogLevel;
976 const auto avail = bt_event_class_get_log_level(this->libObjPtr(), &libLogLevel);
978 if (avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
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 const char *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 const char *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 */