3 # Babeltrace native interface Python module
5 # Copyright 2012-2015 EfficiOS Inc.
7 # Author: Danny Serres <danny.serres@efficios.com>
8 # Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 # Permission is hereby granted, free of charge, to any person obtaining a copy
11 # of this software and associated documentation files (the "Software"), to deal
12 # in the Software without restriction, including without limitation the rights
13 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 # copies of the Software, and to permit persons to whom the Software is
15 # furnished to do so, subject to the following conditions:
17 # The above copyright notice and this permission notice shall be included in
18 # all copies or substantial portions of the Software.
20 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 import babeltrace
.nativebt
as nbt
31 from datetime
import datetime
35 class TraceCollection
:
37 A :class:`TraceCollection` is a collection of opened traces.
39 In general, once a trace collection is created, you add one to many
40 independent traces to it using :meth:`add_trace` or
41 :meth:`add_traces_recursive`, and then iterate the ordered events
42 of all traces merged together using :attr:`events`.
44 You may use :meth:`remove_trace` to close and remove a specific
45 trace from a trace collection, although all the traces of a given
46 trace collection will be automatically removed when it is garbage
52 Creates an empty trace collection.
55 self
._tc
= nbt
._bt
_context
_create
()
58 nbt
._bt
_context
_put
(self
._tc
)
60 def add_trace(self
, path
, format_str
):
62 Adds a trace to the trace collection.
64 The trace is located at the file system path *path*. This
65 function **does not** recurse directories to find the trace:
66 *path* must point to the exact trace location (see
67 :meth:`add_traces_recursive` for a recursive version of this
70 *format_str* is a string indicating the Babeltrace type of the
71 trace to add. ``ctf`` is the only currently supported trace
74 Once added, the trace is opened.
76 Returns the corresponding :class:`TraceHandle` instance for
77 this opened trace on success, or ``None`` on error.
80 ret
= nbt
._bt
_context
_add
_trace
(self
._tc
, path
, format_str
,
86 th
= TraceHandle
.__new
__(TraceHandle
)
88 th
._trace
_collection
= self
92 def add_traces_recursive(self
, path
, format_str
):
94 Adds traces to this trace collection by recursively searching
95 in the *path* directory.
97 *format_str* is a string indicating the Babeltrace type of the
98 traces to find and add. ``ctf`` is the only currently supported
101 See also :meth:`add_trace`.
103 Returns a :class:`dict` object mapping full paths to trace
104 handles for each trace found, or ``None`` on error.
111 for fullpath
, dirs
, files
in os
.walk(path
):
112 if "metadata" in files
:
113 trace_handle
= self
.add_trace(fullpath
, format_str
)
115 if trace_handle
is None:
119 trace_handles
[fullpath
] = trace_handle
122 if noTrace
and error
:
127 def remove_trace(self
, trace_handle
):
129 Removes a trace from the trace collection using its trace
130 handle *trace_handle*.
132 :class:`TraceHandle` objects are returned by :meth:`add_trace`
133 and :meth:`add_traces_recursive`.
135 The trace is closed before being removed.
139 nbt
._bt
_context
_remove
_trace
(self
._tc
, trace_handle
._id
)
140 except AttributeError:
141 raise TypeError("in remove_trace, argument 2 must be a TraceHandle instance")
146 Generates the ordered :class:`Event` objects of all the opened
147 traces contained in this trace collection. Iterate this function
148 to iterate actual events.
150 Due to limitations of the native Babeltrace API, only one event
151 may be "alive" at a given time, i.e. a user **should never**
152 store a copy of the events returned by this function for
153 ulterior use. Users shall make sure to copy the information
154 they need *from* an event before accessing the next one.
156 Furthermore, :class:`Event` objects become invalid when the
157 generator goes out of scope as the underlying iterator will be
158 reclaimed. Using an event after the the generator has gone out
159 of scope may result in a crash or data corruption.
162 begin_pos_ptr
= nbt
._bt
_iter
_pos
()
163 end_pos_ptr
= nbt
._bt
_iter
_pos
()
164 begin_pos_ptr
.type = nbt
.SEEK_BEGIN
165 end_pos_ptr
.type = nbt
.SEEK_LAST
167 for event
in self
._events
(begin_pos_ptr
, end_pos_ptr
):
170 def events_timestamps(self
, timestamp_begin
, timestamp_end
):
172 Generates the ordered :class:`Event` objects of all the opened
173 traces contained in this trace collection from *timestamp_begin*
176 See :attr:`events` for notes and limitations.
179 begin_pos_ptr
= nbt
._bt
_iter
_pos
()
180 end_pos_ptr
= nbt
._bt
_iter
_pos
()
181 begin_pos_ptr
.type = end_pos_ptr
.type = nbt
.SEEK_TIME
182 begin_pos_ptr
.u
.seek_time
= timestamp_begin
183 end_pos_ptr
.u
.seek_time
= timestamp_end
185 for event
in self
._events
(begin_pos_ptr
, end_pos_ptr
):
189 def timestamp_begin(self
):
191 Trace collection's begin timestamp.
194 pos_ptr
= nbt
._bt
_iter
_pos
()
195 pos_ptr
.type = nbt
.SEEK_BEGIN
197 return self
._timestamp
_at
_pos
(pos_ptr
)
200 def timestamp_end(self
):
202 Trace collection's end timestamp.
205 pos_ptr
= nbt
._bt
_iter
_pos
()
206 pos_ptr
.type = nbt
.SEEK_LAST
208 return self
._timestamp
_at
_pos
(pos_ptr
)
210 def _timestamp_at_pos(self
, pos_ptr
):
211 ctf_it_ptr
= nbt
._bt
_ctf
_iter
_create
(self
._tc
, pos_ptr
, pos_ptr
)
213 if ctf_it_ptr
is None:
214 raise NotImplementedError("Creation of multiple iterators is unsupported.")
216 ev_ptr
= nbt
._bt
_ctf
_iter
_read
_event
(ctf_it_ptr
)
217 nbt
._bt
_ctf
_iter
_destroy
(ctf_it_ptr
)
219 def _events(self
, begin_pos_ptr
, end_pos_ptr
):
220 ctf_it_ptr
= nbt
._bt
_ctf
_iter
_create
(self
._tc
, begin_pos_ptr
, end_pos_ptr
)
222 if ctf_it_ptr
is None:
223 raise NotImplementedError("Creation of multiple iterators is unsupported.")
226 ev_ptr
= nbt
._bt
_ctf
_iter
_read
_event
(ctf_it_ptr
)
231 ev
= Event
.__new
__(Event
)
236 except GeneratorExit
:
239 ret
= nbt
._bt
_iter
_next
(nbt
._bt
_ctf
_get
_iter
(ctf_it_ptr
))
244 nbt
._bt
_ctf
_iter
_destroy
(ctf_it_ptr
)
247 # Based on enum bt_clock_type in clock-type.h
255 A :class:`TraceHandle` is a handle allowing the user to manipulate
256 a specific trace directly. It is a unique identifier representing a
257 trace, and is not meant to be instantiated by the user.
261 raise NotImplementedError("TraceHandle cannot be instantiated")
264 return "Babeltrace TraceHandle: trace_id('{0}')".format(self
._id
)
269 Trace handle's numeric ID.
277 Path of the underlying trace.
280 return nbt
._bt
_trace
_handle
_get
_path
(self
._trace
_collection
._tc
,
284 def timestamp_begin(self
):
286 Buffers creation timestamp (nanoseconds since Epoch) of the
290 return nbt
._bt
_trace
_handle
_get
_timestamp
_begin
(self
._trace
_collection
._tc
,
292 _ClockType
.CLOCK_REAL
)
295 def timestamp_end(self
):
297 Buffers destruction timestamp (nanoseconds since Epoch) of the
301 return nbt
._bt
_trace
_handle
_get
_timestamp
_end
(self
._trace
_collection
._tc
,
303 _ClockType
.CLOCK_REAL
)
308 Generates all the :class:`EventDeclaration` objects of the
311 Note that this doesn't generate actual trace *events*, but
312 rather their declarations, i.e. their layouts and metadata.
315 ret
= nbt
._bt
_python
_event
_decl
_listcaller
(self
.id,
316 self
._trace
_collection
._tc
)
318 if not isinstance(ret
, list):
321 ptr_list
, count
= ret
323 for i
in range(count
):
324 tmp
= EventDeclaration
.__new
__(EventDeclaration
)
325 tmp
._ed
= nbt
._bt
_python
_decl
_one
_from
_list
(ptr_list
, i
)
329 class CTFStringEncoding
:
331 CTF string encodings.
347 # Based on the enum in ctf-writer/writer.h
354 BYTE_ORDER_NATIVE
= 0
357 BYTE_ORDER_LITTLE_ENDIAN
= 1
360 BYTE_ORDER_BIG_ENDIAN
= 2
362 #: Network byte order (big-endian)
363 BYTE_ORDER_NETWORK
= 3
365 #: Unknown byte order
366 BYTE_ORDER_UNKNOWN
= 4 # Python-specific entry
369 # enum equivalent, accessible constants
370 # These are taken directly from ctf/events.h
371 # All changes to enums must also be made here
374 CTF numeric type identifiers.
383 #: Floating point number
411 Returns the name of the CTF numeric type identifier *id*.
414 name
= "UNKNOWN_TYPE"
416 attr
for attr
in dir(CTFTypeId
) if not callable(
419 attr
)) and not attr
.startswith("__")]
421 for attr
in constants
:
422 if getattr(CTFTypeId
, attr
) == id:
435 TRACE_PACKET_HEADER
= 0
438 STREAM_PACKET_CONTEXT
= 1
441 STREAM_EVENT_HEADER
= 2
443 #: Stream event context
444 STREAM_EVENT_CONTEXT
= 3
452 def scope_name(scope
):
454 Returns the name of the CTF scope *scope*.
457 name
= "UNKNOWN_SCOPE"
459 attr
for attr
in dir(CTFScope
) if not callable(
462 attr
)) and not attr
.startswith("__")]
464 for attr
in constants
:
465 if getattr(CTFScope
, attr
) == scope
:
472 # Priority of the scopes when searching for event fields
474 CTFScope
.EVENT_FIELDS
,
475 CTFScope
.EVENT_CONTEXT
,
476 CTFScope
.STREAM_EVENT_CONTEXT
,
477 CTFScope
.STREAM_EVENT_HEADER
,
478 CTFScope
.STREAM_PACKET_CONTEXT
,
479 CTFScope
.TRACE_PACKET_HEADER
483 class Event(collections
.Mapping
):
485 An :class:`Event` object represents a trace event. :class:`Event`
486 objects are returned by :attr:`TraceCollection.events` and are
487 not meant to be instantiated by the user.
489 :class:`Event` has a :class:`dict`-like interface for accessing
490 an event's field value by field name:
492 .. code-block:: python
496 If a field name exists in multiple scopes, the value of the first
497 field found is returned. The scopes are searched in the following
500 1. Event fields (:attr:`CTFScope.EVENT_FIELDS`)
501 2. Event context (:attr:`CTFScope.EVENT_CONTEXT`)
502 3. Stream event context (:attr:`CTFScope.STREAM_EVENT_CONTEXT`)
503 4. Event header (:attr:`CTFScope.STREAM_EVENT_HEADER`)
504 5. Packet context (:attr:`CTFScope.STREAM_PACKET_CONTEXT`)
505 6. Packet header (:attr:`CTFScope.TRACE_PACKET_HEADER`)
507 It is still possible to obtain a field's value from a specific
508 scope using :meth:`field_with_scope`.
510 Field values are returned as native Python types, that is:
512 +-----------------------+----------------------------------+
513 | Field type | Python type |
514 +=======================+==================================+
515 | Integer | :class:`int` |
516 +-----------------------+----------------------------------+
517 | Floating point number | :class:`float` |
518 +-----------------------+----------------------------------+
519 | Enumeration | :class:`str` (enumeration label) |
520 +-----------------------+----------------------------------+
521 | String | :class:`str` |
522 +-----------------------+----------------------------------+
523 | Array | :class:`list` of native Python |
525 +-----------------------+----------------------------------+
526 | Sequence | :class:`list` of native Python |
528 +-----------------------+----------------------------------+
529 | Structure | :class:`dict` mapping field |
530 | | names to native Python objects |
531 +-----------------------+----------------------------------+
533 For example, printing the third element of a sequence named ``seq``
534 in a structure named ``my_struct`` of the ``event``'s field named
535 ``my_field`` is done this way:
537 .. code-block:: python
539 print(event['my_field']['my_struct']['seq'][2])
543 raise NotImplementedError("Event cannot be instantiated")
548 Event's name or ``None`` on error.
551 return nbt
._bt
_ctf
_event
_name
(self
._e
)
556 Event's timestamp in cycles or -1 on error.
559 return nbt
._bt
_ctf
_get
_cycles
(self
._e
)
564 Event's timestamp (nanoseconds since Epoch) or -1 on error.
567 return nbt
._bt
_ctf
_get
_timestamp
(self
._e
)
572 Event's timestamp as a standard :class:`datetime.datetime`
575 Note that the :class:`datetime.datetime` class' precision
576 is limited to microseconds, whereas :attr:`timestamp` provides
577 the event's timestamp with a nanosecond resolution.
580 return datetime
.fromtimestamp(self
.timestamp
/ 1E9
)
582 def field_with_scope(self
, field_name
, scope
):
584 Returns the value of a field named *field_name* within the
585 scope *scope*, or ``None`` if the field cannot be found.
587 *scope* must be one of :class:`CTFScope` constants.
590 if scope
not in _scopes
:
591 raise ValueError("Invalid scope provided")
593 field
= self
._field
_with
_scope
(field_name
, scope
)
595 if field
is not None:
598 def field_list_with_scope(self
, scope
):
600 Returns a list of field names in the scope *scope*.
603 if scope
not in _scopes
:
604 raise ValueError("Invalid scope provided")
608 for field
in self
._field
_list
_with
_scope
(scope
):
609 field_names
.append(field
.name
)
616 :class:`TraceHandle` object containing this event, or ``None``
620 ret
= nbt
._bt
_ctf
_event
_get
_handle
_id
(self
._e
)
625 th
= TraceHandle
.__new
__(TraceHandle
)
627 th
._trace
_collection
= self
.get_trace_collection()
632 def trace_collection(self
):
634 :class:`TraceCollection` object containing this event, or
638 trace_collection
= TraceCollection()
639 trace_collection
._tc
= nbt
._bt
_ctf
_event
_get
_context
(self
._e
)
641 if trace_collection
._tc
is not None:
642 return trace_collection
644 def __getitem__(self
, field_name
):
645 field
= self
._field
(field_name
)
647 if field
is not None:
650 raise KeyError(field_name
)
653 for key
in self
.keys():
659 for scope
in _scopes
:
660 scope_ptr
= nbt
._bt
_ctf
_get
_top
_level
_scope
(self
._e
, scope
)
661 ret
= nbt
._bt
_python
_field
_listcaller
(self
._e
, scope_ptr
)
663 if isinstance(ret
, list):
668 def __contains__(self
, field_name
):
669 return self
._field
(field_name
) is not None
673 Returns the list of field names.
675 Note: field names are unique within the returned list, although
676 a field name could exist in multiple scopes. Use
677 :meth:`field_list_with_scope` to obtain the list of field names
683 for scope
in _scopes
:
684 for name
in self
.field_list_with_scope(scope
):
685 field_names
.add(name
)
687 return list(field_names
)
689 def get(self
, field_name
, default
=None):
691 Returns the value of the field named *field_name*, or *default*
694 See :class:`Event` note about how fields are retrieved by
695 name when multiple fields share the same name in different
699 field
= self
._field
(field_name
)
708 Generates pairs of (field name, field value).
710 This method iterates :meth:`keys` to find field names, which
711 means some fields could be unavailable if other fields share
712 their names in scopes with higher priorities.
715 for field
in self
.keys():
716 yield (field
, self
[field
])
718 def _field_with_scope(self
, field_name
, scope
):
719 scope_ptr
= nbt
._bt
_ctf
_get
_top
_level
_scope
(self
._e
, scope
)
721 if scope_ptr
is None:
724 definition_ptr
= nbt
._bt
_ctf
_get
_field
(self
._e
, scope_ptr
, field_name
)
726 if definition_ptr
is None:
729 field
= _Definition(definition_ptr
, scope
)
733 def _field(self
, field_name
):
736 for scope
in _scopes
:
737 field
= self
._field
_with
_scope
(field_name
, scope
)
739 if field
is not None:
744 def _field_list_with_scope(self
, scope
):
746 scope_ptr
= nbt
._bt
_ctf
_get
_top
_level
_scope
(self
._e
, scope
)
748 # Returns a list [list_ptr, count]. If list_ptr is NULL, SWIG will only
749 # provide the "count" return value
752 ret
= nbt
._bt
_python
_field
_listcaller
(self
._e
, scope_ptr
)
754 if isinstance(ret
, list):
755 list_ptr
, count
= ret
757 for i
in range(count
):
758 definition_ptr
= nbt
._bt
_python
_field
_one
_from
_list
(list_ptr
, i
)
760 if definition_ptr
is not None:
761 definition
= _Definition(definition_ptr
, scope
)
762 fields
.append(definition
)
767 class FieldError(Exception):
769 Field error, raised when a field's value cannot be accessed.
772 def __init__(self
, value
):
776 return repr(self
.value
)
779 class EventDeclaration
:
781 An event declaration contains the properties of a class of events,
782 that is, the common properties and fields layout of all the actual
783 recorded events associated with this declaration.
785 This class is not meant to be instantiated by the user. It is
786 returned by :attr:`TraceHandle.events`.
789 MAX_UINT64
= 0xFFFFFFFFFFFFFFFF
792 raise NotImplementedError("EventDeclaration cannot be instantiated")
797 Event's name, or ``None`` on error.
800 return nbt
._bt
_ctf
_get
_decl
_event
_name
(self
._ed
)
805 Event's numeric ID, or -1 on error.
808 id = nbt
._bt
_ctf
_get
_decl
_event
_id
(self
._ed
)
810 if id == self
.MAX_UINT64
:
818 Generates all the event's field declarations, going through
819 each scope in the following order:
821 1. Event fields (:attr:`CTFScope.EVENT_FIELDS`)
822 2. Event context (:attr:`CTFScope.EVENT_CONTEXT`)
823 3. Stream event context (:attr:`CTFScope.STREAM_EVENT_CONTEXT`)
824 4. Event header (:attr:`CTFScope.STREAM_EVENT_HEADER`)
825 5. Packet context (:attr:`CTFScope.STREAM_PACKET_CONTEXT`)
826 6. Packet header (:attr:`CTFScope.TRACE_PACKET_HEADER`)
828 All the generated field declarations inherit
829 :class:`FieldDeclaration`, and are among:
831 * :class:`IntegerFieldDeclaration`
832 * :class:`FloatFieldDeclaration`
833 * :class:`EnumerationFieldDeclaration`
834 * :class:`StringFieldDeclaration`
835 * :class:`ArrayFieldDeclaration`
836 * :class:`SequenceFieldDeclaration`
837 * :class:`StructureFieldDeclaration`
838 * :class:`VariantFieldDeclaration`
841 for scope
in _scopes
:
842 for declaration
in self
.fields_scope(scope
):
845 def fields_scope(self
, scope
):
847 Generates all the field declarations of the event's scope
850 *scope* must be one of :class:`CTFScope` constants.
852 All the generated field declarations inherit
853 :class:`FieldDeclaration`, and are among:
855 * :class:`IntegerFieldDeclaration`
856 * :class:`FloatFieldDeclaration`
857 * :class:`EnumerationFieldDeclaration`
858 * :class:`StringFieldDeclaration`
859 * :class:`ArrayFieldDeclaration`
860 * :class:`SequenceFieldDeclaration`
861 * :class:`StructureFieldDeclaration`
862 * :class:`VariantFieldDeclaration`
864 ret
= nbt
._by
_python
_field
_decl
_listcaller
(self
._ed
, scope
)
866 if not isinstance(ret
, list):
869 list_ptr
, count
= ret
871 for i
in range(count
):
872 field_decl_ptr
= nbt
._bt
_python
_field
_decl
_one
_from
_list
(list_ptr
, i
)
874 if field_decl_ptr
is not None:
875 decl_ptr
= nbt
._bt
_ctf
_get
_decl
_from
_field
_decl
(field_decl_ptr
)
876 name
= nbt
._bt
_ctf
_get
_decl
_field
_name
(field_decl_ptr
)
877 field_declaration
= _create_field_declaration(decl_ptr
, name
,
879 yield field_declaration
882 class FieldDeclaration
:
884 Base class for concrete field declarations.
886 This class is not meant to be instantiated by the user.
890 raise NotImplementedError("FieldDeclaration cannot be instantiated")
893 return "({0}) {1} {2}".format(CTFScope
.scope_name(self
.scope
),
894 CTFTypeId
.type_name(self
.type),
900 Field's name, or ``None`` on error.
908 Field's type (one of :class:`CTFTypeId` constants).
911 return nbt
._bt
_ctf
_field
_type
(self
._fd
)
916 Field's scope (one of :class:`CTFScope` constants).
922 class IntegerFieldDeclaration(FieldDeclaration
):
923 """Do not instantiate."""
926 raise NotImplementedError("IntegerFieldDeclaration cannot be instantiated")
929 def signedness(self
):
931 Return the signedness of an integer:
932 0 if unsigned; 1 if signed; -1 on error.
935 return nbt
._bt
_ctf
_get
_int
_signedness
(self
._fd
)
939 """Return the base of an int or a negative value on error."""
941 return nbt
._bt
_ctf
_get
_int
_base
(self
._fd
)
944 def byte_order(self
):
946 Return the byte order. One of class ByteOrder's entries.
949 ret
= nbt
._bt
_ctf
_get
_int
_byte
_order
(self
._fd
)
952 return ByteOrder
.BYTE_ORDER_LITTLE_ENDIAN
954 return ByteOrder
.BYTE_ORDER_BIG_ENDIAN
956 return ByteOrder
.BYTE_ORDER_UNKNOWN
961 Return the size, in bits, of an int or a negative
965 return nbt
._bt
_ctf
_get
_int
_len
(self
._fd
)
970 Return the encoding. One of class CTFStringEncoding's entries.
971 Return a negative value on error.
974 return nbt
._bt
_ctf
_get
_encoding
(self
._fd
)
977 class EnumerationFieldDeclaration(FieldDeclaration
):
979 Enumeration field declaration.
983 As of this version, this class is missing some properties.
987 raise NotImplementedError("EnumerationFieldDeclaration cannot be instantiated")
990 class ArrayFieldDeclaration(FieldDeclaration
):
992 Static array field declaration.
996 raise NotImplementedError("ArrayFieldDeclaration cannot be instantiated")
1001 Static array's fixed length (number of contained elements), or
1002 a negative value on error.
1005 return nbt
._bt
_ctf
_get
_array
_len
(self
._fd
)
1008 def element_declaration(self
):
1010 Underlying element's field declaration.
1013 field_decl_ptr
= nbt
._bt
_python
_get
_array
_element
_declaration
(self
._fd
)
1015 return _create_field_declaration(field_decl_ptr
, "", self
.scope
)
1018 class SequenceFieldDeclaration(FieldDeclaration
):
1020 Sequence (dynamic array) field declaration.
1024 As of this version, this class is missing some properties.
1028 raise NotImplementedError("SequenceFieldDeclaration cannot be instantiated")
1031 def element_declaration(self
):
1033 Underlying element's field declaration.
1036 field_decl_ptr
= nbt
._bt
_python
_get
_sequence
_element
_declaration
(self
._fd
)
1038 return _create_field_declaration(field_decl_ptr
, "", self
.scope
)
1041 class FloatFieldDeclaration(FieldDeclaration
):
1043 Floating point number field declaration.
1047 As of this version, this class is missing some properties.
1051 raise NotImplementedError("FloatFieldDeclaration cannot be instantiated")
1054 class StructureFieldDeclaration(FieldDeclaration
):
1055 """Do not instantiate."""
1058 raise NotImplementedError("StructureFieldDeclaration cannot be instantiated")
1061 class StringFieldDeclaration(FieldDeclaration
):
1062 """Do not instantiate."""
1065 raise NotImplementedError("StringFieldDeclaration cannot be instantiated")
1068 class VariantFieldDeclaration(FieldDeclaration
):
1069 """Do not instantiate."""
1072 raise NotImplementedError("VariantFieldDeclaration cannot be instantiated")
1077 Return the last error code encountered while
1078 accessing a field and reset the error flag.
1079 Return 0 if no error, a negative value otherwise.
1082 return nbt
._bt
_ctf
_field
_get
_error
()
1085 def _create_field_declaration(declaration_ptr
, name
, scope
):
1087 Private field declaration factory.
1090 if declaration_ptr
is None:
1091 raise ValueError("declaration_ptr must be valid")
1092 if scope
not in _scopes
:
1093 raise ValueError("Invalid scope provided")
1095 type = nbt
._bt
_ctf
_field
_type
(declaration_ptr
)
1098 if type == CTFTypeId
.INTEGER
:
1099 declaration
= IntegerFieldDeclaration
.__new
__(IntegerFieldDeclaration
)
1100 elif type == CTFTypeId
.ENUM
:
1101 declaration
= EnumerationFieldDeclaration
.__new
__(EnumerationFieldDeclaration
)
1102 elif type == CTFTypeId
.ARRAY
:
1103 declaration
= ArrayFieldDeclaration
.__new
__(ArrayFieldDeclaration
)
1104 elif type == CTFTypeId
.SEQUENCE
:
1105 declaration
= SequenceFieldDeclaration
.__new
__(SequenceFieldDeclaration
)
1106 elif type == CTFTypeId
.FLOAT
:
1107 declaration
= FloatFieldDeclaration
.__new
__(FloatFieldDeclaration
)
1108 elif type == CTFTypeId
.STRUCT
:
1109 declaration
= StructureFieldDeclaration
.__new
__(StructureFieldDeclaration
)
1110 elif type == CTFTypeId
.STRING
:
1111 declaration
= StringFieldDeclaration
.__new
__(StringFieldDeclaration
)
1112 elif type == CTFTypeId
.VARIANT
:
1113 declaration
= VariantFieldDeclaration
.__new
__(VariantFieldDeclaration
)
1117 declaration
._fd
= declaration_ptr
1118 declaration
._s
= scope
1119 declaration
._name
= name
1125 def __init__(self
, definition_ptr
, scope
):
1126 self
._d
= definition_ptr
1129 if scope
not in _scopes
:
1130 ValueError("Invalid scope provided")
1134 """Return the name of a field or None on error."""
1136 return nbt
._bt
_ctf
_field
_name
(self
._d
)
1140 """Return the type of a field or -1 if unknown."""
1142 return nbt
._bt
_ctf
_field
_type
(nbt
._bt
_ctf
_get
_decl
_from
_def
(self
._d
))
1145 def declaration(self
):
1146 """Return the associated Definition object."""
1148 return _create_field_declaration(
1149 nbt
._bt
_ctf
_get
_decl
_from
_def
(self
._d
), self
.name
, self
.scope
)
1151 def _get_enum_str(self
):
1153 Return the string matching the current enumeration.
1154 Return None on error.
1157 return nbt
._bt
_ctf
_get
_enum
_str
(self
._d
)
1159 def _get_array_element_at(self
, index
):
1161 Return the array's element at position index.
1162 Return None on error
1165 array_ptr
= nbt
._bt
_python
_get
_array
_from
_def
(self
._d
)
1167 if array_ptr
is None:
1170 definition_ptr
= nbt
._bt
_array
_index
(array_ptr
, index
)
1172 if definition_ptr
is None:
1175 return _Definition(definition_ptr
, self
.scope
)
1177 def _get_sequence_len(self
):
1179 Return the len of a sequence or a negative
1183 seq
= nbt
._bt
_python
_get
_sequence
_from
_def
(self
._d
)
1185 return nbt
._bt
_sequence
_len
(seq
)
1187 def _get_sequence_element_at(self
, index
):
1189 Return the sequence's element at position index,
1190 otherwise return None
1193 seq
= nbt
._bt
_python
_get
_sequence
_from
_def
(self
._d
)
1196 definition_ptr
= nbt
._bt
_sequence
_index
(seq
, index
)
1198 if definition_ptr
is not None:
1199 return _Definition(definition_ptr
, self
.scope
)
1201 def _get_uint64(self
):
1203 Return the value associated with the field.
1204 If the field does not exist or is not of the type requested,
1205 the value returned is undefined. To check if an error occured,
1206 use the field_error() function after accessing a field.
1209 return nbt
._bt
_ctf
_get
_uint
64(self
._d
)
1211 def _get_int64(self
):
1213 Return the value associated with the field.
1214 If the field does not exist or is not of the type requested,
1215 the value returned is undefined. To check if an error occured,
1216 use the field_error() function after accessing a field.
1219 return nbt
._bt
_ctf
_get
_int
64(self
._d
)
1221 def _get_char_array(self
):
1223 Return the value associated with the field.
1224 If the field does not exist or is not of the type requested,
1225 the value returned is undefined. To check if an error occurred,
1226 use the field_error() function after accessing a field.
1229 return nbt
._bt
_ctf
_get
_char
_array
(self
._d
)
1233 Return the value associated with the field.
1234 If the field does not exist or is not of the type requested,
1235 the value returned is undefined. To check if an error occurred,
1236 use the field_error() function after accessing a field.
1239 return nbt
._bt
_ctf
_get
_string
(self
._d
)
1241 def _get_float(self
):
1243 Return the value associated with the field.
1244 If the field does not exist or is not of the type requested,
1245 the value returned is undefined. To check if an error occurred,
1246 use the field_error() function after accessing a field.
1249 return nbt
._bt
_ctf
_get
_float
(self
._d
)
1251 def _get_variant(self
):
1253 Return the variant's selected field.
1254 If the field does not exist or is not of the type requested,
1255 the value returned is undefined. To check if an error occurred,
1256 use the field_error() function after accessing a field.
1259 return nbt
._bt
_ctf
_get
_variant
(self
._d
)
1261 def _get_struct_field_count(self
):
1263 Return the number of fields contained in the structure.
1264 If the field does not exist or is not of the type requested,
1265 the value returned is undefined.
1268 return nbt
._bt
_ctf
_get
_struct
_field
_count
(self
._d
)
1270 def _get_struct_field_at(self
, i
):
1272 Return the structure's field at position i.
1273 If the field does not exist or is not of the type requested,
1274 the value returned is undefined. To check if an error occurred,
1275 use the field_error() function after accessing a field.
1278 return nbt
._bt
_ctf
_get
_struct
_field
_index
(self
._d
, i
)
1283 Return the value associated with the field according to its type.
1284 Return None on error.
1290 if id == CTFTypeId
.STRING
:
1291 value
= self
._get
_str
()
1292 elif id == CTFTypeId
.ARRAY
:
1293 element_decl
= self
.declaration
.element_declaration
1295 if ((element_decl
.type == CTFTypeId
.INTEGER
1296 and element_decl
.length
== 8)
1297 and (element_decl
.encoding
== CTFStringEncoding
.ASCII
or element_decl
.encoding
== CTFStringEncoding
.UTF8
)):
1298 value
= nbt
._bt
_python
_get
_array
_string
(self
._d
)
1302 for i
in range(self
.declaration
.length
):
1303 element
= self
._get
_array
_element
_at
(i
)
1304 value
.append(element
.value
)
1305 elif id == CTFTypeId
.INTEGER
:
1306 if self
.declaration
.signedness
== 0:
1307 value
= self
._get
_uint
64()
1309 value
= self
._get
_int
64()
1310 elif id == CTFTypeId
.ENUM
:
1311 value
= self
._get
_enum
_str
()
1312 elif id == CTFTypeId
.SEQUENCE
:
1313 element_decl
= self
.declaration
.element_declaration
1315 if ((element_decl
.type == CTFTypeId
.INTEGER
1316 and element_decl
.length
== 8)
1317 and (element_decl
.encoding
== CTFStringEncoding
.ASCII
or element_decl
.encoding
== CTFStringEncoding
.UTF8
)):
1318 value
= nbt
._bt
_python
_get
_sequence
_string
(self
._d
)
1320 seq_len
= self
._get
_sequence
_len
()
1323 for i
in range(seq_len
):
1324 evDef
= self
._get
_sequence
_element
_at
(i
)
1325 value
.append(evDef
.value
)
1326 elif id == CTFTypeId
.FLOAT
:
1327 value
= self
._get
_float
()
1328 elif id == CTFTypeId
.VARIANT
:
1329 variant
= _Definition
.__new
__(_Definition
)
1330 variant
._d
= self
._get
_variant
()
1331 value
= variant
.value
1332 elif id == CTFTypeId
.STRUCT
:
1335 for i
in range(self
._get
_struct
_field
_count
()):
1336 member
= _Definition(self
._get
_struct
_field
_at
(i
), self
.scope
)
1337 value
[member
.name
] = member
.value
1341 "Error occurred while accessing field {} of type {}".format(
1343 CTFTypeId
.type_name(id)))
1349 """Return the scope of a field or None on error."""
1355 # Used to compare to -1ULL in error checks
1356 _MAX_UINT64
= 0xFFFFFFFFFFFFFFFF
1358 class EnumerationMapping
:
1360 Enumeration mapping class. start and end values are inclusive.
1363 def __init__(self
, name
, start
, end
):
1369 def __init__(self
, name
):
1370 self
._c
= nbt
._bt
_ctf
_clock
_create
(name
)
1373 raise ValueError("Invalid clock name.")
1376 nbt
._bt
_ctf
_clock
_put
(self
._c
)
1381 Get the clock's name.
1384 name
= nbt
._bt
_ctf
_clock
_get
_name
(self
._c
)
1387 raise ValueError("Invalid clock instance.")
1392 def description(self
):
1394 Get the clock's description. None if unset.
1397 return nbt
._bt
_ctf
_clock
_get
_description
(self
._c
)
1400 def description(self
, desc
):
1402 Set the clock's description. The description appears in the clock's TSDL
1406 ret
= nbt
._bt
_ctf
_clock
_set
_description
(self
._c
, str(desc
))
1409 raise ValueError("Invalid clock description.")
1412 def frequency(self
):
1414 Get the clock's frequency (Hz).
1417 freq
= nbt
._bt
_ctf
_clock
_get
_frequency
(self
._c
)
1419 if freq
== CTFWriter
._MAX
_UINT
64:
1420 raise ValueError("Invalid clock instance")
1425 def frequency(self
, freq
):
1427 Set the clock's frequency (Hz).
1430 ret
= nbt
._bt
_ctf
_clock
_set
_frequency
(self
._c
, freq
)
1433 raise ValueError("Invalid frequency value.")
1436 def precision(self
):
1438 Get the clock's precision (in clock ticks).
1441 precision
= nbt
._bt
_ctf
_clock
_get
_precision
(self
._c
)
1443 if precision
== CTFWriter
._MAX
_UINT
64:
1444 raise ValueError("Invalid clock instance")
1449 def precision(self
, precision
):
1451 Set the clock's precision (in clock ticks).
1454 ret
= nbt
._bt
_ctf
_clock
_set
_precision
(self
._c
, precision
)
1457 def offset_seconds(self
):
1459 Get the clock's offset in seconds from POSIX.1 Epoch.
1462 offset_s
= nbt
._bt
_ctf
_clock
_get
_offset
_s
(self
._c
)
1464 if offset_s
== CTFWriter
._MAX
_UINT
64:
1465 raise ValueError("Invalid clock instance")
1469 @offset_seconds.setter
1470 def offset_seconds(self
, offset_s
):
1472 Set the clock's offset in seconds from POSIX.1 Epoch.
1475 ret
= nbt
._bt
_ctf
_clock
_set
_offset
_s
(self
._c
, offset_s
)
1478 raise ValueError("Invalid offset value.")
1483 Get the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1486 offset
= nbt
._bt
_ctf
_clock
_get
_offset
(self
._c
)
1488 if offset
== CTFWriter
._MAX
_UINT
64:
1489 raise ValueError("Invalid clock instance")
1494 def offset(self
, offset
):
1496 Set the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1499 ret
= nbt
._bt
_ctf
_clock
_set
_offset
(self
._c
, offset
)
1502 raise ValueError("Invalid offset value.")
1507 Get a clock's absolute attribute. A clock is absolute if the clock
1508 is a global reference across the trace's other clocks.
1511 is_absolute
= nbt
._bt
_ctf
_clock
_get
_is
_absolute
(self
._c
)
1513 if is_absolute
== -1:
1514 raise ValueError("Invalid clock instance")
1516 return False if is_absolute
== 0 else True
1519 def absolute(self
, is_absolute
):
1521 Set a clock's absolute attribute. A clock is absolute if the clock
1522 is a global reference across the trace's other clocks.
1525 ret
= nbt
._bt
_ctf
_clock
_set
_is
_absolute
(self
._c
, int(is_absolute
))
1528 raise ValueError("Could not set the clock's absolute attribute.")
1533 Get a clock's UUID (an object of type UUID).
1539 ret
, value
= nbt
._bt
_python
_ctf
_clock
_get
_uuid
_index
(self
._c
, i
)
1542 raise ValueError("Invalid clock instance")
1544 uuid_list
.append(value
)
1546 return UUID(bytes
=bytes(uuid_list
))
1549 def uuid(self
, uuid
):
1551 Set a clock's UUID (an object of type UUID).
1554 uuid_bytes
= uuid
.bytes
1556 if len(uuid_bytes
) != 16:
1557 raise ValueError("Invalid UUID provided. UUID length must be 16 bytes")
1559 for i
in range(len(uuid_bytes
)):
1560 ret
= nbt
._bt
_python
_ctf
_clock
_set
_uuid
_index
(self
._c
, i
,
1564 raise ValueError("Invalid clock instance")
1569 Get the current time in nanoseconds since the clock's origin (offset and
1570 offset_s attributes).
1573 time
= nbt
._bt
_ctf
_clock
_get
_time
(self
._c
)
1575 if time
== CTFWriter
._MAX
_UINT
64:
1576 raise ValueError("Invalid clock instance")
1581 def time(self
, time
):
1583 Set the current time in nanoseconds since the clock's origin (offset and
1584 offset_s attributes). The clock's value will be sampled as events are
1585 appended to a stream.
1588 ret
= nbt
._bt
_ctf
_clock
_set
_time
(self
._c
, time
)
1591 raise ValueError("Invalid time value.")
1593 class FieldDeclaration
:
1595 FieldDeclaration should not be instantiated directly. Instantiate
1596 one of the concrete FieldDeclaration classes.
1600 # These values are based on the bt_ctf_integer_base enum
1601 # declared in event-types.h.
1602 INTEGER_BASE_UNKNOWN
= -1
1603 INTEGER_BASE_BINARY
= 2
1604 INTEGER_BASE_OCTAL
= 8
1605 INTEGER_BASE_DECIMAL
= 10
1606 INTEGER_BASE_HEXADECIMAL
= 16
1609 if self
._ft
is None:
1610 raise ValueError("FieldDeclaration creation failed.")
1613 nbt
._bt
_ctf
_field
_type
_put
(self
._ft
)
1616 def _create_field_declaration_from_native_instance(
1617 native_field_declaration
):
1619 CTFTypeId
.INTEGER
: CTFWriter
.IntegerFieldDeclaration
,
1620 CTFTypeId
.FLOAT
: CTFWriter
.FloatFieldDeclaration
,
1621 CTFTypeId
.ENUM
: CTFWriter
.EnumerationFieldDeclaration
,
1622 CTFTypeId
.STRING
: CTFWriter
.StringFieldDeclaration
,
1623 CTFTypeId
.STRUCT
: CTFWriter
.StructureFieldDeclaration
,
1624 CTFTypeId
.VARIANT
: CTFWriter
.VariantFieldDeclaration
,
1625 CTFTypeId
.ARRAY
: CTFWriter
.ArrayFieldDeclaration
,
1626 CTFTypeId
.SEQUENCE
: CTFWriter
.SequenceFieldDeclaration
1629 field_type_id
= nbt
._bt
_ctf
_field
_type
_get
_type
_id
(native_field_declaration
)
1631 if field_type_id
== CTFTypeId
.UNKNOWN
:
1632 raise TypeError("Invalid field instance")
1634 declaration
= CTFWriter
.Field
.__new
__(CTFWriter
.Field
)
1635 declaration
._ft
= native_field_declaration
1636 declaration
.__class
__ = type_dict
[field_type_id
]
1641 def alignment(self
):
1643 Get the field declaration's alignment. Returns -1 on error.
1646 return nbt
._bt
_ctf
_field
_type
_get
_alignment
(self
._ft
)
1649 def alignment(self
, alignment
):
1651 Set the field declaration's alignment. Defaults to 1 (bit-aligned). However,
1652 some types, such as structures and string, may impose other alignment
1656 ret
= nbt
._bt
_ctf
_field
_type
_set
_alignment
(self
._ft
, alignment
)
1659 raise ValueError("Invalid alignment value.")
1662 def byte_order(self
):
1664 Get the field declaration's byte order. One of the ByteOrder's constant.
1667 return nbt
._bt
_ctf
_field
_type
_get
_byte
_order
(self
._ft
)
1670 def byte_order(self
, byte_order
):
1672 Set the field declaration's byte order. Use constants defined in the ByteOrder
1676 ret
= nbt
._bt
_ctf
_field
_type
_set
_byte
_order
(self
._ft
, byte_order
)
1679 raise ValueError("Could not set byte order value.")
1681 class IntegerFieldDeclaration(FieldDeclaration
):
1682 def __init__(self
, size
):
1684 Create a new integer field declaration of the given size.
1686 self
._ft
= nbt
._bt
_ctf
_field
_type
_integer
_create
(size
)
1692 Get an integer's size.
1695 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_size
(self
._ft
)
1698 raise ValueError("Could not get Integer's size attribute.")
1705 Get an integer's signedness attribute.
1708 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_signed
(self
._ft
)
1711 raise ValueError("Could not get Integer's signed attribute.")
1718 def signed(self
, signed
):
1720 Set an integer's signedness attribute.
1723 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_signed
(self
._ft
, signed
)
1726 raise ValueError("Could not set Integer's signed attribute.")
1731 Get the integer's base used to pretty-print the resulting trace.
1732 Returns a constant from the FieldDeclaration.IntegerBase class.
1735 return nbt
._bt
_ctf
_field
_type
_integer
_get
_base
(self
._ft
)
1738 def base(self
, base
):
1740 Set the integer's base used to pretty-print the resulting trace.
1741 The base must be a constant of the FieldDeclarationIntegerBase class.
1744 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_base
(self
._ft
, base
)
1747 raise ValueError("Could not set Integer's base.")
1752 Get the integer's encoding (one of the constants of the
1753 CTFStringEncoding class).
1754 Returns a constant from the CTFStringEncoding class.
1757 return nbt
._bt
_ctf
_field
_type
_integer
_get
_encoding
(self
._ft
)
1760 def encoding(self
, encoding
):
1762 An integer encoding may be set to signal that the integer must be printed
1763 as a text character. Must be a constant from the CTFStringEncoding class.
1766 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_encoding
(self
._ft
, encoding
)
1769 raise ValueError("Could not set Integer's encoding.")
1771 class EnumerationFieldDeclaration(FieldDeclaration
):
1772 def __init__(self
, integer_type
):
1774 Create a new enumeration field declaration with the given underlying container type.
1776 isinst
= isinstance(integer_type
, CTFWriter
.IntegerFieldDeclaration
)
1778 if integer_type
is None or not isinst
:
1779 raise TypeError("Invalid integer container.")
1781 self
._ft
= nbt
._bt
_ctf
_field
_type
_enumeration
_create
(integer_type
._ft
)
1785 def container(self
):
1787 Get the enumeration's underlying container type.
1790 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_container
_type
(self
._ft
)
1793 raise TypeError("Invalid enumeration declaration")
1795 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
1797 def add_mapping(self
, name
, range_start
, range_end
):
1799 Add a mapping to the enumeration. The range's values are inclusive.
1802 if range_start
< 0 or range_end
< 0:
1803 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
(self
._ft
,
1808 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
_unsigned
(self
._ft
,
1814 raise ValueError("Could not add mapping to enumeration declaration.")
1819 Generator returning instances of EnumerationMapping.
1822 signed
= self
.container
.signed
1824 count
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_count
(self
._ft
)
1826 for i
in range(count
):
1828 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, i
)
1830 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, i
)
1833 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1834 raise TypeError(msg
)
1836 name
, range_start
, range_end
= ret
1837 yield CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1839 def get_mapping_by_name(self
, name
):
1841 Get a mapping by name (EnumerationMapping).
1844 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_name
(self
._ft
, name
)
1849 if self
.container
.signed
:
1850 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
1852 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
1855 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1856 raise TypeError(msg
)
1858 name
, range_start
, range_end
= ret
1860 return CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1862 def get_mapping_by_value(self
, value
):
1864 Get a mapping by value (EnumerationMapping).
1868 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_value
(self
._ft
, value
)
1870 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_unsigned
_value
(self
._ft
, value
)
1875 if self
.container
.signed
:
1876 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
1878 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
1881 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1882 raise TypeError(msg
)
1884 name
, range_start
, range_end
= ret
1886 return CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1888 class FloatFieldDeclaration(FieldDeclaration
):
1896 Create a new floating point field declaration.
1899 self
._ft
= nbt
._bt
_ctf
_field
_type
_floating
_point
_create
()
1903 def exponent_digits(self
):
1905 Get the number of exponent digits used to store the floating point field.
1908 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_exponent
_digits
(self
._ft
)
1912 "Could not get Floating point exponent digit count")
1916 @exponent_digits.setter
1917 def exponent_digits(self
, exponent_digits
):
1919 Set the number of exponent digits to use to store the floating point field.
1920 The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which
1921 are defined as constants of this class.
1924 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_exponent
_digits
(self
._ft
,
1928 raise ValueError("Could not set exponent digit count.")
1931 def mantissa_digits(self
):
1933 Get the number of mantissa digits used to store the floating point field.
1936 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_mantissa
_digits
(self
._ft
)
1939 raise TypeError("Could not get Floating point mantissa digit count")
1943 @mantissa_digits.setter
1944 def mantissa_digits(self
, mantissa_digits
):
1946 Set the number of mantissa digits to use to store the floating point field.
1947 The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which
1948 are defined as constants of this class.
1951 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_mantissa
_digits
(self
._ft
,
1955 raise ValueError("Could not set mantissa digit count.")
1957 class FloatingPointFieldDeclaration(FloatFieldDeclaration
):
1960 class StructureFieldDeclaration(FieldDeclaration
):
1963 Create a new structure field declaration.
1966 self
._ft
= nbt
._bt
_ctf
_field
_type
_structure
_create
()
1969 def add_field(self
, field_type
, field_name
):
1971 Add a field of type "field_type" to the structure.
1974 ret
= nbt
._bt
_ctf
_field
_type
_structure
_add
_field
(self
._ft
,
1979 raise ValueError("Could not add field to structure.")
1984 Generator returning the structure's field as tuples of (field name, field declaration).
1987 count
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_count
(self
._ft
)
1990 raise TypeError("Could not get Structure field count")
1992 for i
in range(count
):
1993 field_name
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_name
(self
._ft
, i
)
1995 if field_name
is None:
1996 msg
= "Could not get Structure field name at index {}".format(i
)
1997 raise TypeError(msg
)
1999 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_type
(self
._ft
, i
)
2001 if field_type_native
is None:
2002 msg
= "Could not get Structure field type at index {}".format(i
)
2003 raise TypeError(msg
)
2005 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2006 yield (field_name
, field_type
)
2008 def get_field_by_name(self
, name
):
2010 Get a field declaration by name (FieldDeclaration).
2013 field_type_native
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_type
_by
_name
(self
._ft
, name
)
2015 if field_type_native
is None:
2016 msg
= "Could not find Structure field with name {}".format(name
)
2017 raise TypeError(msg
)
2019 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2021 class VariantFieldDeclaration(FieldDeclaration
):
2022 def __init__(self
, enum_tag
, tag_name
):
2024 Create a new variant field declaration.
2027 isinst
= isinstance(enum_tag
, CTFWriter
.EnumerationFieldDeclaration
)
2028 if enum_tag
is None or not isinst
:
2029 raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.")
2031 self
._ft
= nbt
._bt
_ctf
_field
_type
_variant
_create
(enum_tag
._ft
,
2038 Get the variant's tag name.
2041 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_name
(self
._ft
)
2044 raise TypeError("Could not get Variant tag name")
2051 Get the variant's tag type.
2054 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_type
(self
._ft
)
2057 raise TypeError("Could not get Variant tag type")
2059 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2061 def add_field(self
, field_type
, field_name
):
2063 Add a field of type "field_type" to the variant.
2066 ret
= nbt
._bt
_ctf
_field
_type
_variant
_add
_field
(self
._ft
,
2071 raise ValueError("Could not add field to variant.")
2076 Generator returning the variant's field as tuples of (field name, field declaration).
2079 count
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_count
(self
._ft
)
2082 raise TypeError("Could not get Variant field count")
2084 for i
in range(count
):
2085 field_name
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_name
(self
._ft
, i
)
2087 if field_name
is None:
2088 msg
= "Could not get Variant field name at index {}".format(i
)
2089 raise TypeError(msg
)
2091 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_type
(self
._ft
, i
)
2093 if field_type_native
is None:
2094 msg
= "Could not get Variant field type at index {}".format(i
)
2095 raise TypeError(msg
)
2097 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2098 yield (field_name
, field_type
)
2100 def get_field_by_name(self
, name
):
2102 Get a field declaration by name (FieldDeclaration).
2105 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_by
_name
(self
._ft
,
2108 if field_type_native
is None:
2109 msg
= "Could not find Variant field with name {}".format(name
)
2110 raise TypeError(msg
)
2112 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2114 def get_field_from_tag(self
, tag
):
2116 Get a field declaration from tag (EnumerationField).
2119 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_from
_tag
(self
._ft
, tag
._f
)
2121 if field_type_native
is None:
2122 msg
= "Could not find Variant field with tag value {}".format(tag
.value
)
2123 raise TypeError(msg
)
2125 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2127 class ArrayFieldDeclaration(FieldDeclaration
):
2128 def __init__(self
, element_type
, length
):
2130 Create a new array field declaration.
2133 self
._ft
= nbt
._bt
_ctf
_field
_type
_array
_create
(element_type
._ft
,
2138 def element_type(self
):
2140 Get the array's element type.
2143 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_element
_type
(self
._ft
)
2146 raise TypeError("Could not get Array element type")
2148 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2153 Get the array's length.
2156 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_length
(self
._ft
)
2159 raise TypeError("Could not get Array length")
2163 class SequenceFieldDeclaration(FieldDeclaration
):
2164 def __init__(self
, element_type
, length_field_name
):
2166 Create a new sequence field declaration.
2169 self
._ft
= nbt
._bt
_ctf
_field
_type
_sequence
_create
(element_type
._ft
,
2170 str(length_field_name
))
2174 def element_type(self
):
2176 Get the sequence's element type.
2179 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_element
_type
(self
._ft
)
2182 raise TypeError("Could not get Sequence element type")
2184 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2187 def length_field_name(self
):
2189 Get the sequence's length field name.
2192 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_length
_field
_name
(self
._ft
)
2195 raise TypeError("Could not get Sequence length field name")
2199 class StringFieldDeclaration(FieldDeclaration
):
2202 Create a new string field declaration.
2205 self
._ft
= nbt
._bt
_ctf
_field
_type
_string
_create
()
2211 Get a string declaration's encoding (a constant from the CTFStringEncoding class).
2214 return nbt
._bt
_ctf
_field
_type
_string
_get
_encoding
(self
._ft
)
2217 def encoding(self
, encoding
):
2219 Set a string declaration's encoding. Must be a constant from the CTFStringEncoding class.
2222 ret
= nbt
._bt
_ctf
_field
_type
_string
_set
_encoding
(self
._ft
, encoding
)
2224 raise ValueError("Could not set string encoding.")
2227 def create_field(field_type
):
2229 Create an instance of a field.
2231 isinst
= isinstance(field_type
, CTFWriter
.FieldDeclaration
)
2233 if field_type
is None or not isinst
:
2234 raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.")
2236 if isinstance(field_type
, CTFWriter
.IntegerFieldDeclaration
):
2237 return CTFWriter
.IntegerField(field_type
)
2238 elif isinstance(field_type
, CTFWriter
.EnumerationFieldDeclaration
):
2239 return CTFWriter
.EnumerationField(field_type
)
2240 elif isinstance(field_type
, CTFWriter
.FloatFieldDeclaration
):
2241 return CTFWriter
.FloatingPointField(field_type
)
2242 elif isinstance(field_type
, CTFWriter
.StructureFieldDeclaration
):
2243 return CTFWriter
.StructureField(field_type
)
2244 elif isinstance(field_type
, CTFWriter
.VariantFieldDeclaration
):
2245 return CTFWriter
.VariantField(field_type
)
2246 elif isinstance(field_type
, CTFWriter
.ArrayFieldDeclaration
):
2247 return CTFWriter
.ArrayField(field_type
)
2248 elif isinstance(field_type
, CTFWriter
.SequenceFieldDeclaration
):
2249 return CTFWriter
.SequenceField(field_type
)
2250 elif isinstance(field_type
, CTFWriter
.StringFieldDeclaration
):
2251 return CTFWriter
.StringField(field_type
)
2255 Base class, do not instantiate.
2258 def __init__(self
, field_type
):
2259 if not isinstance(field_type
, CTFWriter
.FieldDeclaration
):
2260 raise TypeError("Invalid field_type argument.")
2262 self
._f
= nbt
._bt
_ctf
_field
_create
(field_type
._ft
)
2265 raise ValueError("Field creation failed.")
2268 nbt
._bt
_ctf
_field
_put
(self
._f
)
2271 def _create_field_from_native_instance(native_field_instance
):
2273 CTFTypeId
.INTEGER
: CTFWriter
.IntegerField
,
2274 CTFTypeId
.FLOAT
: CTFWriter
.FloatingPointField
,
2275 CTFTypeId
.ENUM
: CTFWriter
.EnumerationField
,
2276 CTFTypeId
.STRING
: CTFWriter
.StringField
,
2277 CTFTypeId
.STRUCT
: CTFWriter
.StructureField
,
2278 CTFTypeId
.VARIANT
: CTFWriter
.VariantField
,
2279 CTFTypeId
.ARRAY
: CTFWriter
.ArrayField
,
2280 CTFTypeId
.SEQUENCE
: CTFWriter
.SequenceField
2283 field_type
= nbt
._bt
_python
_get
_field
_type
(native_field_instance
)
2285 if field_type
== CTFTypeId
.UNKNOWN
:
2286 raise TypeError("Invalid field instance")
2288 field
= CTFWriter
.Field
.__new
__(CTFWriter
.Field
)
2289 field
._f
= native_field_instance
2290 field
.__class
__ = type_dict
[field_type
]
2295 def declaration(self
):
2296 native_field_type
= nbt
._bt
_ctf
_field
_get
_type
(self
._f
)
2298 if native_field_type
is None:
2299 raise TypeError("Invalid field instance")
2300 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(
2303 class IntegerField(Field
):
2307 Get an integer field's value.
2310 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
2313 raise TypeError("Invalid integer instance.")
2316 ret
, value
= nbt
._bt
_ctf
_field
_unsigned
_integer
_get
_value
(self
._f
)
2318 ret
, value
= nbt
._bt
_ctf
_field
_signed
_integer
_get
_value
(self
._f
)
2321 raise ValueError("Could not get integer field value.")
2326 def value(self
, value
):
2328 Set an integer field's value.
2331 if not isinstance(value
, int):
2332 raise TypeError("IntegerField's value must be an int")
2334 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
2336 raise TypeError("Invalid integer instance.")
2339 ret
= nbt
._bt
_ctf
_field
_unsigned
_integer
_set
_value
(self
._f
, value
)
2341 ret
= nbt
._bt
_ctf
_field
_signed
_integer
_set
_value
(self
._f
, value
)
2344 raise ValueError("Could not set integer field value.")
2346 class EnumerationField(Field
):
2348 def container(self
):
2350 Return the enumeration's underlying container field (an integer field).
2353 container
= CTFWriter
.IntegerField
.__new
__(CTFWriter
.IntegerField
)
2354 container
._f
= nbt
._bt
_ctf
_field
_enumeration
_get
_container
(self
._f
)
2356 if container
._f
is None:
2357 raise TypeError("Invalid enumeration field type.")
2364 Get the enumeration field's mapping name.
2367 value
= nbt
._bt
_ctf
_field
_enumeration
_get
_mapping
_name
(self
._f
)
2370 raise ValueError("Could not get enumeration's mapping name.")
2375 def value(self
, value
):
2377 Set the enumeration field's value. Must be an integer as mapping names
2381 if not isinstance(value
, int):
2382 raise TypeError("EnumerationField value must be an int")
2384 self
.container
.value
= value
2386 class FloatingPointField(Field
):
2390 Get a floating point field's value.
2393 ret
, value
= nbt
._bt
_ctf
_field
_floating
_point
_get
_value
(self
._f
)
2396 raise ValueError("Could not get floating point field value.")
2401 def value(self
, value
):
2403 Set a floating point field's value.
2406 if not isinstance(value
, int) and not isinstance(value
, float):
2407 raise TypeError("Value must be either a float or an int")
2409 ret
= nbt
._bt
_ctf
_field
_floating
_point
_set
_value
(self
._f
, float(value
))
2412 raise ValueError("Could not set floating point field value.")
2414 # oops!! This class is provided to ensure backward-compatibility since
2415 # a stable release publicly exposed this abomination.
2416 class FloatFieldingPoint(FloatingPointField
):
2419 class StructureField(Field
):
2420 def field(self
, field_name
):
2422 Get the structure's field corresponding to the provided field name.
2425 native_instance
= nbt
._bt
_ctf
_field
_structure
_get
_field
(self
._f
,
2428 if native_instance
is None:
2429 raise ValueError("Invalid field_name provided.")
2431 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2433 class VariantField(Field
):
2434 def field(self
, tag
):
2436 Return the variant's selected field. The "tag" field is the selector enum field.
2439 native_instance
= nbt
._bt
_ctf
_field
_variant
_get
_field
(self
._f
, tag
._f
)
2441 if native_instance
is None:
2442 raise ValueError("Invalid tag provided.")
2444 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2446 class ArrayField(Field
):
2447 def field(self
, index
):
2449 Return the array's field at position "index".
2452 native_instance
= nbt
._bt
_ctf
_field
_array
_get
_field
(self
._f
, index
)
2454 if native_instance
is None:
2455 raise IndexError("Invalid index provided.")
2457 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2459 class SequenceField(Field
):
2463 Get the sequence's length field (IntegerField).
2466 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_length
(self
._f
)
2468 if native_instance
is None:
2471 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2474 def length(self
, length_field
):
2476 Set the sequence's length field (IntegerField).
2479 if not isinstance(length_field
, CTFWriter
.IntegerField
):
2480 raise TypeError("Invalid length field.")
2482 if length_field
.declaration
.signed
:
2483 raise TypeError("Sequence field length must be unsigned")
2485 ret
= nbt
._bt
_ctf
_field
_sequence
_set
_length
(self
._f
, length_field
._f
)
2488 raise ValueError("Could not set sequence length.")
2490 def field(self
, index
):
2492 Return the sequence's field at position "index".
2495 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_field
(self
._f
, index
)
2497 if native_instance
is None:
2498 raise ValueError("Could not get sequence element at index.")
2500 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2502 class StringField(Field
):
2506 Get a string field's value.
2509 return nbt
._bt
_ctf
_field
_string
_get
_value
(self
._f
)
2512 def value(self
, value
):
2514 Set a string field's value.
2517 ret
= nbt
._bt
_ctf
_field
_string
_set
_value
(self
._f
, str(value
))
2520 raise ValueError("Could not set string field value.")
2523 def __init__(self
, name
):
2525 Create a new event class of the given name.
2528 self
._ec
= nbt
._bt
_ctf
_event
_class
_create
(name
)
2530 if self
._ec
is None:
2531 raise ValueError("Event class creation failed.")
2534 nbt
._bt
_ctf
_event
_class
_put
(self
._ec
)
2536 def add_field(self
, field_type
, field_name
):
2538 Add a field of type "field_type" to the event class.
2541 ret
= nbt
._bt
_ctf
_event
_class
_add
_field
(self
._ec
, field_type
._ft
,
2545 raise ValueError("Could not add field to event class.")
2550 Get the event class' name.
2553 name
= nbt
._bt
_ctf
_event
_class
_get
_name
(self
._ec
)
2556 raise TypeError("Could not get EventClass name")
2563 Get the event class' id. Returns a negative value if unset.
2566 id = nbt
._bt
_ctf
_event
_class
_get
_id
(self
._ec
)
2569 raise TypeError("Could not get EventClass id")
2576 Set the event class' id. Throws a TypeError if the event class
2577 is already registered to a stream class.
2580 ret
= nbt
._bt
_ctf
_event
_class
_set
_id
(self
._ec
, id)
2583 raise TypeError("Can't change an Event Class's id after it has been assigned to a stream class")
2586 def stream_class(self
):
2588 Get the event class' stream class. Returns None if unset.
2590 stream_class_native
= nbt
._bt
_ctf
_event
_class
_get
_stream
_class
(self
._ec
)
2592 if stream_class_native
is None:
2595 stream_class
= CTFWriter
.StreamClass
.__new
__(CTFWriter
.StreamClass
)
2596 stream_class
._sc
= stream_class_native
2603 Generator returning the event class' fields as tuples of (field name, field declaration).
2606 count
= nbt
._bt
_ctf
_event
_class
_get
_field
_count
(self
._ec
)
2609 raise TypeError("Could not get EventClass' field count")
2611 for i
in range(count
):
2612 field_name
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_name
(self
._ec
, i
)
2614 if field_name
is None:
2615 msg
= "Could not get EventClass' field name at index {}".format(i
)
2616 raise TypeError(msg
)
2618 field_type_native
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_type
(self
._ec
, i
)
2620 if field_type_native
is None:
2621 msg
= "Could not get EventClass' field type at index {}".format(i
)
2622 raise TypeError(msg
)
2624 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2625 yield (field_name
, field_type
)
2627 def get_field_by_name(self
, name
):
2629 Get a field declaration by name (FieldDeclaration).
2632 field_type_native
= nbt
._bt
_ctf
_event
_class
_get
_field
_by
_name
(self
._ec
, name
)
2634 if field_type_native
is None:
2635 msg
= "Could not find EventClass field with name {}".format(name
)
2636 raise TypeError(msg
)
2638 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2641 def __init__(self
, event_class
):
2643 Create a new event of the given event class.
2646 if not isinstance(event_class
, CTFWriter
.EventClass
):
2647 raise TypeError("Invalid event_class argument.")
2649 self
._e
= nbt
._bt
_ctf
_event
_create
(event_class
._ec
)
2652 raise ValueError("Event creation failed.")
2655 nbt
._bt
_ctf
_event
_put
(self
._e
)
2658 def event_class(self
):
2660 Get the event's class.
2663 event_class_native
= nbt
._bt
_ctf
_event
_get
_class
(self
._e
)
2665 if event_class_native
is None:
2668 event_class
= CTFWriter
.EventClass
.__new
__(CTFWriter
.EventClass
)
2669 event_class
._ec
= event_class_native
2675 Get a clock from event. Returns None if the event's class
2676 is not registered to a stream class.
2679 clock_instance
= nbt
._bt
_ctf
_event
_get
_clock
(self
._e
)
2681 if clock_instance
is None:
2684 clock
= CTFWriter
.Clock
.__new
__(CTFWriter
.Clock
)
2685 clock
._c
= clock_instance
2689 def payload(self
, field_name
):
2691 Get a field from event.
2694 native_instance
= nbt
._bt
_ctf
_event
_get
_payload
(self
._e
,
2697 if native_instance
is None:
2698 raise ValueError("Could not get event payload.")
2700 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2702 def set_payload(self
, field_name
, value_field
):
2704 Set a manually created field as an event's payload.
2707 if not isinstance(value
, CTFWriter
.Field
):
2708 raise TypeError("Invalid value type.")
2710 ret
= nbt
._bt
_ctf
_event
_set
_payload
(self
._e
, str(field_name
),
2714 raise ValueError("Could not set event field payload.")
2717 def __init__(self
, name
):
2719 Create a new stream class of the given name.
2722 self
._sc
= nbt
._bt
_ctf
_stream
_class
_create
(name
)
2724 if self
._sc
is None:
2725 raise ValueError("Stream class creation failed.")
2728 nbt
._bt
_ctf
_stream
_class
_put
(self
._sc
)
2733 Get a stream class' name.
2736 name
= nbt
._bt
_ctf
_stream
_class
_get
_name
(self
._sc
)
2739 raise TypeError("Could not get StreamClass name")
2746 Get a stream class' clock.
2749 clock_instance
= nbt
._bt
_ctf
_stream
_class
_get
_clock
(self
._sc
)
2751 if clock_instance
is None:
2754 clock
= CTFWriter
.Clock
.__new
__(CTFWriter
.Clock
)
2755 clock
._c
= clock_instance
2760 def clock(self
, clock
):
2762 Assign a clock to a stream class.
2765 if not isinstance(clock
, CTFWriter
.Clock
):
2766 raise TypeError("Invalid clock type.")
2768 ret
= nbt
._bt
_ctf
_stream
_class
_set
_clock
(self
._sc
, clock
._c
)
2771 raise ValueError("Could not set stream class clock.")
2776 Get a stream class' id.
2779 ret
= nbt
._bt
_ctf
_stream
_class
_get
_id
(self
._sc
)
2782 raise TypeError("Could not get StreamClass id")
2789 Assign an id to a stream class.
2792 ret
= nbt
._bt
_ctf
_stream
_class
_set
_id
(self
._sc
, id)
2795 raise TypeError("Could not set stream class id.")
2798 def event_classes(self
):
2800 Generator returning the stream class' event classes.
2803 count
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
_count
(self
._sc
)
2806 raise TypeError("Could not get StreamClass' event class count")
2808 for i
in range(count
):
2809 event_class_native
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
(self
._sc
, i
)
2811 if event_class_native
is None:
2812 msg
= "Could not get StreamClass' event class at index {}".format(i
)
2813 raise TypeError(msg
)
2815 event_class
= CTFWriter
.EventClass
.__new
__(CTFWriter
.EventClass
)
2816 event_class
._ec
= event_class_native
2819 def add_event_class(self
, event_class
):
2821 Add an event class to a stream class. New events can be added even after a
2822 stream has been instantiated and events have been appended. However, a stream
2823 will not accept events of a class that has not been added to the stream
2827 if not isinstance(event_class
, CTFWriter
.EventClass
):
2828 raise TypeError("Invalid event_class type.")
2830 ret
= nbt
._bt
_ctf
_stream
_class
_add
_event
_class
(self
._sc
,
2834 raise ValueError("Could not add event class.")
2837 def packet_context_type(self
):
2839 Get the StreamClass' packet context type (StructureFieldDeclaration)
2842 field_type_native
= nbt
._bt
_ctf
_stream
_class
_get
_packet
_context
_type
(self
._sc
)
2844 if field_type_native
is None:
2845 raise ValueError("Invalid StreamClass")
2847 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2851 @packet_context_type.setter
2852 def packet_context_type(self
, field_type
):
2854 Set a StreamClass' packet context type. Must be of type
2855 StructureFieldDeclaration.
2858 if not isinstance(field_type
, CTFWriter
.StructureFieldDeclaration
):
2859 raise TypeError("field_type argument must be of type StructureFieldDeclaration.")
2861 ret
= nbt
._bt
_ctf
_stream
_class
_set
_packet
_context
_type
(self
._sc
,
2865 raise ValueError("Failed to set packet context type.")
2869 raise NotImplementedError("Stream cannot be instantiated; use Writer.create_stream()")
2872 nbt
._bt
_ctf
_stream
_put
(self
._s
)
2875 def discarded_events(self
):
2877 Get a stream's discarded event count.
2880 ret
, count
= nbt
._bt
_ctf
_stream
_get
_discarded
_events
_count
(self
._s
)
2883 raise ValueError("Could not get the stream's discarded events count")
2887 def append_discarded_events(self
, event_count
):
2889 Increase the current packet's discarded event count.
2892 nbt
._bt
_ctf
_stream
_append
_discarded
_events
(self
._s
, event_count
)
2894 def append_event(self
, event
):
2896 Append "event" to the stream's current packet. The stream's associated clock
2897 will be sampled during this call. The event shall not be modified after
2898 being appended to a stream.
2901 ret
= nbt
._bt
_ctf
_stream
_append
_event
(self
._s
, event
._e
)
2904 raise ValueError("Could not append event to stream.")
2907 def packet_context(self
):
2909 Get a Stream's packet context field (a StructureField).
2912 native_field
= nbt
._bt
_ctf
_stream
_get
_packet
_context
(self
._s
)
2914 if native_field
is None:
2915 raise ValueError("Invalid Stream.")
2917 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_field
)
2919 @packet_context.setter
2920 def packet_context(self
, field
):
2922 Set a Stream's packet context field (must be a StructureField).
2925 if not isinstance(field
, CTFWriter
.StructureField
):
2926 raise TypeError("Argument field must be of type StructureField")
2928 ret
= nbt
._bt
_ctf
_stream
_set
_packet
_context
(self
._s
, field
._f
)
2931 raise ValueError("Invalid packet context field.")
2935 The stream's current packet's events will be flushed to disk. Events
2936 subsequently appended to the stream will be added to a new packet.
2939 ret
= nbt
._bt
_ctf
_stream
_flush
(self
._s
)
2942 raise ValueError("Could not flush stream.")
2945 def __init__(self
, path
):
2947 Create a new writer that will produce a trace in the given path.
2950 self
._w
= nbt
._bt
_ctf
_writer
_create
(path
)
2953 raise ValueError("Writer creation failed.")
2956 nbt
._bt
_ctf
_writer
_put
(self
._w
)
2958 def create_stream(self
, stream_class
):
2960 Create a new stream instance and register it to the writer.
2963 if not isinstance(stream_class
, CTFWriter
.StreamClass
):
2964 raise TypeError("Invalid stream_class type.")
2966 stream
= CTFWriter
.Stream
.__new
__(CTFWriter
.Stream
)
2967 stream
._s
= nbt
._bt
_ctf
_writer
_create
_stream
(self
._w
, stream_class
._sc
)
2971 def add_environment_field(self
, name
, value
):
2973 Add an environment field to the trace.
2976 ret
= nbt
._bt
_ctf
_writer
_add
_environment
_field
(self
._w
, str(name
),
2980 raise ValueError("Could not add environment field to trace.")
2982 def add_clock(self
, clock
):
2984 Add a clock to the trace. Clocks assigned to stream classes must be
2985 registered to the writer.
2988 ret
= nbt
._bt
_ctf
_writer
_add
_clock
(self
._w
, clock
._c
)
2991 raise ValueError("Could not add clock to Writer.")
2996 Get the trace's TSDL meta-data.
2999 return nbt
._bt
_ctf
_writer
_get
_metadata
_string
(self
._w
)
3001 def flush_metadata(self
):
3003 Flush the trace's metadata to the metadata file.
3006 nbt
._bt
_ctf
_writer
_flush
_metadata
(self
._w
)
3009 def byte_order(self
):
3011 Get the trace's byte order. Must be a constant from the ByteOrder
3015 raise NotImplementedError("Getter not implemented.")
3018 def byte_order(self
, byte_order
):
3020 Set the trace's byte order. Must be a constant from the ByteOrder
3021 class. Defaults to the host machine's endianness
3024 ret
= nbt
._bt
_ctf
_writer
_set
_byte
_order
(self
._w
, byte_order
)
3027 raise ValueError("Could not set trace's byte order.")