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
):
1056 Structure (ordered map of field names to field declarations) field
1061 As of this version, this class is missing some properties.
1065 raise NotImplementedError("StructureFieldDeclaration cannot be instantiated")
1068 class StringFieldDeclaration(FieldDeclaration
):
1069 """Do not instantiate."""
1072 raise NotImplementedError("StringFieldDeclaration cannot be instantiated")
1075 class VariantFieldDeclaration(FieldDeclaration
):
1076 """Do not instantiate."""
1079 raise NotImplementedError("VariantFieldDeclaration cannot be instantiated")
1084 Return the last error code encountered while
1085 accessing a field and reset the error flag.
1086 Return 0 if no error, a negative value otherwise.
1089 return nbt
._bt
_ctf
_field
_get
_error
()
1092 def _create_field_declaration(declaration_ptr
, name
, scope
):
1094 Private field declaration factory.
1097 if declaration_ptr
is None:
1098 raise ValueError("declaration_ptr must be valid")
1099 if scope
not in _scopes
:
1100 raise ValueError("Invalid scope provided")
1102 type = nbt
._bt
_ctf
_field
_type
(declaration_ptr
)
1105 if type == CTFTypeId
.INTEGER
:
1106 declaration
= IntegerFieldDeclaration
.__new
__(IntegerFieldDeclaration
)
1107 elif type == CTFTypeId
.ENUM
:
1108 declaration
= EnumerationFieldDeclaration
.__new
__(EnumerationFieldDeclaration
)
1109 elif type == CTFTypeId
.ARRAY
:
1110 declaration
= ArrayFieldDeclaration
.__new
__(ArrayFieldDeclaration
)
1111 elif type == CTFTypeId
.SEQUENCE
:
1112 declaration
= SequenceFieldDeclaration
.__new
__(SequenceFieldDeclaration
)
1113 elif type == CTFTypeId
.FLOAT
:
1114 declaration
= FloatFieldDeclaration
.__new
__(FloatFieldDeclaration
)
1115 elif type == CTFTypeId
.STRUCT
:
1116 declaration
= StructureFieldDeclaration
.__new
__(StructureFieldDeclaration
)
1117 elif type == CTFTypeId
.STRING
:
1118 declaration
= StringFieldDeclaration
.__new
__(StringFieldDeclaration
)
1119 elif type == CTFTypeId
.VARIANT
:
1120 declaration
= VariantFieldDeclaration
.__new
__(VariantFieldDeclaration
)
1124 declaration
._fd
= declaration_ptr
1125 declaration
._s
= scope
1126 declaration
._name
= name
1132 def __init__(self
, definition_ptr
, scope
):
1133 self
._d
= definition_ptr
1136 if scope
not in _scopes
:
1137 ValueError("Invalid scope provided")
1141 """Return the name of a field or None on error."""
1143 return nbt
._bt
_ctf
_field
_name
(self
._d
)
1147 """Return the type of a field or -1 if unknown."""
1149 return nbt
._bt
_ctf
_field
_type
(nbt
._bt
_ctf
_get
_decl
_from
_def
(self
._d
))
1152 def declaration(self
):
1153 """Return the associated Definition object."""
1155 return _create_field_declaration(
1156 nbt
._bt
_ctf
_get
_decl
_from
_def
(self
._d
), self
.name
, self
.scope
)
1158 def _get_enum_str(self
):
1160 Return the string matching the current enumeration.
1161 Return None on error.
1164 return nbt
._bt
_ctf
_get
_enum
_str
(self
._d
)
1166 def _get_array_element_at(self
, index
):
1168 Return the array's element at position index.
1169 Return None on error
1172 array_ptr
= nbt
._bt
_python
_get
_array
_from
_def
(self
._d
)
1174 if array_ptr
is None:
1177 definition_ptr
= nbt
._bt
_array
_index
(array_ptr
, index
)
1179 if definition_ptr
is None:
1182 return _Definition(definition_ptr
, self
.scope
)
1184 def _get_sequence_len(self
):
1186 Return the len of a sequence or a negative
1190 seq
= nbt
._bt
_python
_get
_sequence
_from
_def
(self
._d
)
1192 return nbt
._bt
_sequence
_len
(seq
)
1194 def _get_sequence_element_at(self
, index
):
1196 Return the sequence's element at position index,
1197 otherwise return None
1200 seq
= nbt
._bt
_python
_get
_sequence
_from
_def
(self
._d
)
1203 definition_ptr
= nbt
._bt
_sequence
_index
(seq
, index
)
1205 if definition_ptr
is not None:
1206 return _Definition(definition_ptr
, self
.scope
)
1208 def _get_uint64(self
):
1210 Return the value associated with the field.
1211 If the field does not exist or is not of the type requested,
1212 the value returned is undefined. To check if an error occured,
1213 use the field_error() function after accessing a field.
1216 return nbt
._bt
_ctf
_get
_uint
64(self
._d
)
1218 def _get_int64(self
):
1220 Return the value associated with the field.
1221 If the field does not exist or is not of the type requested,
1222 the value returned is undefined. To check if an error occured,
1223 use the field_error() function after accessing a field.
1226 return nbt
._bt
_ctf
_get
_int
64(self
._d
)
1228 def _get_char_array(self
):
1230 Return the value associated with the field.
1231 If the field does not exist or is not of the type requested,
1232 the value returned is undefined. To check if an error occurred,
1233 use the field_error() function after accessing a field.
1236 return nbt
._bt
_ctf
_get
_char
_array
(self
._d
)
1240 Return the value associated with the field.
1241 If the field does not exist or is not of the type requested,
1242 the value returned is undefined. To check if an error occurred,
1243 use the field_error() function after accessing a field.
1246 return nbt
._bt
_ctf
_get
_string
(self
._d
)
1248 def _get_float(self
):
1250 Return the value associated with the field.
1251 If the field does not exist or is not of the type requested,
1252 the value returned is undefined. To check if an error occurred,
1253 use the field_error() function after accessing a field.
1256 return nbt
._bt
_ctf
_get
_float
(self
._d
)
1258 def _get_variant(self
):
1260 Return the variant's selected field.
1261 If the field does not exist or is not of the type requested,
1262 the value returned is undefined. To check if an error occurred,
1263 use the field_error() function after accessing a field.
1266 return nbt
._bt
_ctf
_get
_variant
(self
._d
)
1268 def _get_struct_field_count(self
):
1270 Return the number of fields contained in the structure.
1271 If the field does not exist or is not of the type requested,
1272 the value returned is undefined.
1275 return nbt
._bt
_ctf
_get
_struct
_field
_count
(self
._d
)
1277 def _get_struct_field_at(self
, i
):
1279 Return the structure's field at position i.
1280 If the field does not exist or is not of the type requested,
1281 the value returned is undefined. To check if an error occurred,
1282 use the field_error() function after accessing a field.
1285 return nbt
._bt
_ctf
_get
_struct
_field
_index
(self
._d
, i
)
1290 Return the value associated with the field according to its type.
1291 Return None on error.
1297 if id == CTFTypeId
.STRING
:
1298 value
= self
._get
_str
()
1299 elif id == CTFTypeId
.ARRAY
:
1300 element_decl
= self
.declaration
.element_declaration
1302 if ((element_decl
.type == CTFTypeId
.INTEGER
1303 and element_decl
.length
== 8)
1304 and (element_decl
.encoding
== CTFStringEncoding
.ASCII
or element_decl
.encoding
== CTFStringEncoding
.UTF8
)):
1305 value
= nbt
._bt
_python
_get
_array
_string
(self
._d
)
1309 for i
in range(self
.declaration
.length
):
1310 element
= self
._get
_array
_element
_at
(i
)
1311 value
.append(element
.value
)
1312 elif id == CTFTypeId
.INTEGER
:
1313 if self
.declaration
.signedness
== 0:
1314 value
= self
._get
_uint
64()
1316 value
= self
._get
_int
64()
1317 elif id == CTFTypeId
.ENUM
:
1318 value
= self
._get
_enum
_str
()
1319 elif id == CTFTypeId
.SEQUENCE
:
1320 element_decl
= self
.declaration
.element_declaration
1322 if ((element_decl
.type == CTFTypeId
.INTEGER
1323 and element_decl
.length
== 8)
1324 and (element_decl
.encoding
== CTFStringEncoding
.ASCII
or element_decl
.encoding
== CTFStringEncoding
.UTF8
)):
1325 value
= nbt
._bt
_python
_get
_sequence
_string
(self
._d
)
1327 seq_len
= self
._get
_sequence
_len
()
1330 for i
in range(seq_len
):
1331 evDef
= self
._get
_sequence
_element
_at
(i
)
1332 value
.append(evDef
.value
)
1333 elif id == CTFTypeId
.FLOAT
:
1334 value
= self
._get
_float
()
1335 elif id == CTFTypeId
.VARIANT
:
1336 variant
= _Definition
.__new
__(_Definition
)
1337 variant
._d
= self
._get
_variant
()
1338 value
= variant
.value
1339 elif id == CTFTypeId
.STRUCT
:
1342 for i
in range(self
._get
_struct
_field
_count
()):
1343 member
= _Definition(self
._get
_struct
_field
_at
(i
), self
.scope
)
1344 value
[member
.name
] = member
.value
1348 "Error occurred while accessing field {} of type {}".format(
1350 CTFTypeId
.type_name(id)))
1356 """Return the scope of a field or None on error."""
1362 # Used to compare to -1ULL in error checks
1363 _MAX_UINT64
= 0xFFFFFFFFFFFFFFFF
1365 class EnumerationMapping
:
1367 Enumeration mapping class. start and end values are inclusive.
1370 def __init__(self
, name
, start
, end
):
1376 def __init__(self
, name
):
1377 self
._c
= nbt
._bt
_ctf
_clock
_create
(name
)
1380 raise ValueError("Invalid clock name.")
1383 nbt
._bt
_ctf
_clock
_put
(self
._c
)
1388 Get the clock's name.
1391 name
= nbt
._bt
_ctf
_clock
_get
_name
(self
._c
)
1394 raise ValueError("Invalid clock instance.")
1399 def description(self
):
1401 Get the clock's description. None if unset.
1404 return nbt
._bt
_ctf
_clock
_get
_description
(self
._c
)
1407 def description(self
, desc
):
1409 Set the clock's description. The description appears in the clock's TSDL
1413 ret
= nbt
._bt
_ctf
_clock
_set
_description
(self
._c
, str(desc
))
1416 raise ValueError("Invalid clock description.")
1419 def frequency(self
):
1421 Get the clock's frequency (Hz).
1424 freq
= nbt
._bt
_ctf
_clock
_get
_frequency
(self
._c
)
1426 if freq
== CTFWriter
._MAX
_UINT
64:
1427 raise ValueError("Invalid clock instance")
1432 def frequency(self
, freq
):
1434 Set the clock's frequency (Hz).
1437 ret
= nbt
._bt
_ctf
_clock
_set
_frequency
(self
._c
, freq
)
1440 raise ValueError("Invalid frequency value.")
1443 def precision(self
):
1445 Get the clock's precision (in clock ticks).
1448 precision
= nbt
._bt
_ctf
_clock
_get
_precision
(self
._c
)
1450 if precision
== CTFWriter
._MAX
_UINT
64:
1451 raise ValueError("Invalid clock instance")
1456 def precision(self
, precision
):
1458 Set the clock's precision (in clock ticks).
1461 ret
= nbt
._bt
_ctf
_clock
_set
_precision
(self
._c
, precision
)
1464 def offset_seconds(self
):
1466 Get the clock's offset in seconds from POSIX.1 Epoch.
1469 offset_s
= nbt
._bt
_ctf
_clock
_get
_offset
_s
(self
._c
)
1471 if offset_s
== CTFWriter
._MAX
_UINT
64:
1472 raise ValueError("Invalid clock instance")
1476 @offset_seconds.setter
1477 def offset_seconds(self
, offset_s
):
1479 Set the clock's offset in seconds from POSIX.1 Epoch.
1482 ret
= nbt
._bt
_ctf
_clock
_set
_offset
_s
(self
._c
, offset_s
)
1485 raise ValueError("Invalid offset value.")
1490 Get the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1493 offset
= nbt
._bt
_ctf
_clock
_get
_offset
(self
._c
)
1495 if offset
== CTFWriter
._MAX
_UINT
64:
1496 raise ValueError("Invalid clock instance")
1501 def offset(self
, offset
):
1503 Set the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1506 ret
= nbt
._bt
_ctf
_clock
_set
_offset
(self
._c
, offset
)
1509 raise ValueError("Invalid offset value.")
1514 Get a clock's absolute attribute. A clock is absolute if the clock
1515 is a global reference across the trace's other clocks.
1518 is_absolute
= nbt
._bt
_ctf
_clock
_get
_is
_absolute
(self
._c
)
1520 if is_absolute
== -1:
1521 raise ValueError("Invalid clock instance")
1523 return False if is_absolute
== 0 else True
1526 def absolute(self
, is_absolute
):
1528 Set a clock's absolute attribute. A clock is absolute if the clock
1529 is a global reference across the trace's other clocks.
1532 ret
= nbt
._bt
_ctf
_clock
_set
_is
_absolute
(self
._c
, int(is_absolute
))
1535 raise ValueError("Could not set the clock's absolute attribute.")
1540 Get a clock's UUID (an object of type UUID).
1546 ret
, value
= nbt
._bt
_python
_ctf
_clock
_get
_uuid
_index
(self
._c
, i
)
1549 raise ValueError("Invalid clock instance")
1551 uuid_list
.append(value
)
1553 return UUID(bytes
=bytes(uuid_list
))
1556 def uuid(self
, uuid
):
1558 Set a clock's UUID (an object of type UUID).
1561 uuid_bytes
= uuid
.bytes
1563 if len(uuid_bytes
) != 16:
1564 raise ValueError("Invalid UUID provided. UUID length must be 16 bytes")
1566 for i
in range(len(uuid_bytes
)):
1567 ret
= nbt
._bt
_python
_ctf
_clock
_set
_uuid
_index
(self
._c
, i
,
1571 raise ValueError("Invalid clock instance")
1576 Get the current time in nanoseconds since the clock's origin (offset and
1577 offset_s attributes).
1580 time
= nbt
._bt
_ctf
_clock
_get
_time
(self
._c
)
1582 if time
== CTFWriter
._MAX
_UINT
64:
1583 raise ValueError("Invalid clock instance")
1588 def time(self
, time
):
1590 Set the current time in nanoseconds since the clock's origin (offset and
1591 offset_s attributes). The clock's value will be sampled as events are
1592 appended to a stream.
1595 ret
= nbt
._bt
_ctf
_clock
_set
_time
(self
._c
, time
)
1598 raise ValueError("Invalid time value.")
1600 class FieldDeclaration
:
1602 FieldDeclaration should not be instantiated directly. Instantiate
1603 one of the concrete FieldDeclaration classes.
1607 # These values are based on the bt_ctf_integer_base enum
1608 # declared in event-types.h.
1609 INTEGER_BASE_UNKNOWN
= -1
1610 INTEGER_BASE_BINARY
= 2
1611 INTEGER_BASE_OCTAL
= 8
1612 INTEGER_BASE_DECIMAL
= 10
1613 INTEGER_BASE_HEXADECIMAL
= 16
1616 if self
._ft
is None:
1617 raise ValueError("FieldDeclaration creation failed.")
1620 nbt
._bt
_ctf
_field
_type
_put
(self
._ft
)
1623 def _create_field_declaration_from_native_instance(
1624 native_field_declaration
):
1626 CTFTypeId
.INTEGER
: CTFWriter
.IntegerFieldDeclaration
,
1627 CTFTypeId
.FLOAT
: CTFWriter
.FloatFieldDeclaration
,
1628 CTFTypeId
.ENUM
: CTFWriter
.EnumerationFieldDeclaration
,
1629 CTFTypeId
.STRING
: CTFWriter
.StringFieldDeclaration
,
1630 CTFTypeId
.STRUCT
: CTFWriter
.StructureFieldDeclaration
,
1631 CTFTypeId
.VARIANT
: CTFWriter
.VariantFieldDeclaration
,
1632 CTFTypeId
.ARRAY
: CTFWriter
.ArrayFieldDeclaration
,
1633 CTFTypeId
.SEQUENCE
: CTFWriter
.SequenceFieldDeclaration
1636 field_type_id
= nbt
._bt
_ctf
_field
_type
_get
_type
_id
(native_field_declaration
)
1638 if field_type_id
== CTFTypeId
.UNKNOWN
:
1639 raise TypeError("Invalid field instance")
1641 declaration
= CTFWriter
.Field
.__new
__(CTFWriter
.Field
)
1642 declaration
._ft
= native_field_declaration
1643 declaration
.__class
__ = type_dict
[field_type_id
]
1648 def alignment(self
):
1650 Get the field declaration's alignment. Returns -1 on error.
1653 return nbt
._bt
_ctf
_field
_type
_get
_alignment
(self
._ft
)
1656 def alignment(self
, alignment
):
1658 Set the field declaration's alignment. Defaults to 1 (bit-aligned). However,
1659 some types, such as structures and string, may impose other alignment
1663 ret
= nbt
._bt
_ctf
_field
_type
_set
_alignment
(self
._ft
, alignment
)
1666 raise ValueError("Invalid alignment value.")
1669 def byte_order(self
):
1671 Get the field declaration's byte order. One of the ByteOrder's constant.
1674 return nbt
._bt
_ctf
_field
_type
_get
_byte
_order
(self
._ft
)
1677 def byte_order(self
, byte_order
):
1679 Set the field declaration's byte order. Use constants defined in the ByteOrder
1683 ret
= nbt
._bt
_ctf
_field
_type
_set
_byte
_order
(self
._ft
, byte_order
)
1686 raise ValueError("Could not set byte order value.")
1688 class IntegerFieldDeclaration(FieldDeclaration
):
1689 def __init__(self
, size
):
1691 Create a new integer field declaration of the given size.
1693 self
._ft
= nbt
._bt
_ctf
_field
_type
_integer
_create
(size
)
1699 Get an integer's size.
1702 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_size
(self
._ft
)
1705 raise ValueError("Could not get Integer's size attribute.")
1712 Get an integer's signedness attribute.
1715 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_signed
(self
._ft
)
1718 raise ValueError("Could not get Integer's signed attribute.")
1725 def signed(self
, signed
):
1727 Set an integer's signedness attribute.
1730 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_signed
(self
._ft
, signed
)
1733 raise ValueError("Could not set Integer's signed attribute.")
1738 Get the integer's base used to pretty-print the resulting trace.
1739 Returns a constant from the FieldDeclaration.IntegerBase class.
1742 return nbt
._bt
_ctf
_field
_type
_integer
_get
_base
(self
._ft
)
1745 def base(self
, base
):
1747 Set the integer's base used to pretty-print the resulting trace.
1748 The base must be a constant of the FieldDeclarationIntegerBase class.
1751 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_base
(self
._ft
, base
)
1754 raise ValueError("Could not set Integer's base.")
1759 Get the integer's encoding (one of the constants of the
1760 CTFStringEncoding class).
1761 Returns a constant from the CTFStringEncoding class.
1764 return nbt
._bt
_ctf
_field
_type
_integer
_get
_encoding
(self
._ft
)
1767 def encoding(self
, encoding
):
1769 An integer encoding may be set to signal that the integer must be printed
1770 as a text character. Must be a constant from the CTFStringEncoding class.
1773 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_encoding
(self
._ft
, encoding
)
1776 raise ValueError("Could not set Integer's encoding.")
1778 class EnumerationFieldDeclaration(FieldDeclaration
):
1779 def __init__(self
, integer_type
):
1781 Create a new enumeration field declaration with the given underlying container type.
1783 isinst
= isinstance(integer_type
, CTFWriter
.IntegerFieldDeclaration
)
1785 if integer_type
is None or not isinst
:
1786 raise TypeError("Invalid integer container.")
1788 self
._ft
= nbt
._bt
_ctf
_field
_type
_enumeration
_create
(integer_type
._ft
)
1792 def container(self
):
1794 Get the enumeration's underlying container type.
1797 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_container
_type
(self
._ft
)
1800 raise TypeError("Invalid enumeration declaration")
1802 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
1804 def add_mapping(self
, name
, range_start
, range_end
):
1806 Add a mapping to the enumeration. The range's values are inclusive.
1809 if range_start
< 0 or range_end
< 0:
1810 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
(self
._ft
,
1815 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
_unsigned
(self
._ft
,
1821 raise ValueError("Could not add mapping to enumeration declaration.")
1826 Generator returning instances of EnumerationMapping.
1829 signed
= self
.container
.signed
1831 count
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_count
(self
._ft
)
1833 for i
in range(count
):
1835 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, i
)
1837 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, i
)
1840 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1841 raise TypeError(msg
)
1843 name
, range_start
, range_end
= ret
1844 yield CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1846 def get_mapping_by_name(self
, name
):
1848 Get a mapping by name (EnumerationMapping).
1851 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_name
(self
._ft
, name
)
1856 if self
.container
.signed
:
1857 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
1859 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
1862 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1863 raise TypeError(msg
)
1865 name
, range_start
, range_end
= ret
1867 return CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1869 def get_mapping_by_value(self
, value
):
1871 Get a mapping by value (EnumerationMapping).
1875 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_value
(self
._ft
, value
)
1877 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_unsigned
_value
(self
._ft
, value
)
1882 if self
.container
.signed
:
1883 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
1885 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
1888 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1889 raise TypeError(msg
)
1891 name
, range_start
, range_end
= ret
1893 return CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1895 class FloatFieldDeclaration(FieldDeclaration
):
1903 Create a new floating point field declaration.
1906 self
._ft
= nbt
._bt
_ctf
_field
_type
_floating
_point
_create
()
1910 def exponent_digits(self
):
1912 Get the number of exponent digits used to store the floating point field.
1915 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_exponent
_digits
(self
._ft
)
1919 "Could not get Floating point exponent digit count")
1923 @exponent_digits.setter
1924 def exponent_digits(self
, exponent_digits
):
1926 Set the number of exponent digits to use to store the floating point field.
1927 The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which
1928 are defined as constants of this class.
1931 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_exponent
_digits
(self
._ft
,
1935 raise ValueError("Could not set exponent digit count.")
1938 def mantissa_digits(self
):
1940 Get the number of mantissa digits used to store the floating point field.
1943 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_mantissa
_digits
(self
._ft
)
1946 raise TypeError("Could not get Floating point mantissa digit count")
1950 @mantissa_digits.setter
1951 def mantissa_digits(self
, mantissa_digits
):
1953 Set the number of mantissa digits to use to store the floating point field.
1954 The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which
1955 are defined as constants of this class.
1958 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_mantissa
_digits
(self
._ft
,
1962 raise ValueError("Could not set mantissa digit count.")
1964 class FloatingPointFieldDeclaration(FloatFieldDeclaration
):
1967 class StructureFieldDeclaration(FieldDeclaration
):
1970 Create a new structure field declaration.
1973 self
._ft
= nbt
._bt
_ctf
_field
_type
_structure
_create
()
1976 def add_field(self
, field_type
, field_name
):
1978 Add a field of type "field_type" to the structure.
1981 ret
= nbt
._bt
_ctf
_field
_type
_structure
_add
_field
(self
._ft
,
1986 raise ValueError("Could not add field to structure.")
1991 Generator returning the structure's field as tuples of (field name, field declaration).
1994 count
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_count
(self
._ft
)
1997 raise TypeError("Could not get Structure field count")
1999 for i
in range(count
):
2000 field_name
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_name
(self
._ft
, i
)
2002 if field_name
is None:
2003 msg
= "Could not get Structure field name at index {}".format(i
)
2004 raise TypeError(msg
)
2006 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_type
(self
._ft
, i
)
2008 if field_type_native
is None:
2009 msg
= "Could not get Structure field type at index {}".format(i
)
2010 raise TypeError(msg
)
2012 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2013 yield (field_name
, field_type
)
2015 def get_field_by_name(self
, name
):
2017 Get a field declaration by name (FieldDeclaration).
2020 field_type_native
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_type
_by
_name
(self
._ft
, name
)
2022 if field_type_native
is None:
2023 msg
= "Could not find Structure field with name {}".format(name
)
2024 raise TypeError(msg
)
2026 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2028 class VariantFieldDeclaration(FieldDeclaration
):
2029 def __init__(self
, enum_tag
, tag_name
):
2031 Create a new variant field declaration.
2034 isinst
= isinstance(enum_tag
, CTFWriter
.EnumerationFieldDeclaration
)
2035 if enum_tag
is None or not isinst
:
2036 raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.")
2038 self
._ft
= nbt
._bt
_ctf
_field
_type
_variant
_create
(enum_tag
._ft
,
2045 Get the variant's tag name.
2048 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_name
(self
._ft
)
2051 raise TypeError("Could not get Variant tag name")
2058 Get the variant's tag type.
2061 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_type
(self
._ft
)
2064 raise TypeError("Could not get Variant tag type")
2066 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2068 def add_field(self
, field_type
, field_name
):
2070 Add a field of type "field_type" to the variant.
2073 ret
= nbt
._bt
_ctf
_field
_type
_variant
_add
_field
(self
._ft
,
2078 raise ValueError("Could not add field to variant.")
2083 Generator returning the variant's field as tuples of (field name, field declaration).
2086 count
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_count
(self
._ft
)
2089 raise TypeError("Could not get Variant field count")
2091 for i
in range(count
):
2092 field_name
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_name
(self
._ft
, i
)
2094 if field_name
is None:
2095 msg
= "Could not get Variant field name at index {}".format(i
)
2096 raise TypeError(msg
)
2098 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_type
(self
._ft
, i
)
2100 if field_type_native
is None:
2101 msg
= "Could not get Variant field type at index {}".format(i
)
2102 raise TypeError(msg
)
2104 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2105 yield (field_name
, field_type
)
2107 def get_field_by_name(self
, name
):
2109 Get a field declaration by name (FieldDeclaration).
2112 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_by
_name
(self
._ft
,
2115 if field_type_native
is None:
2116 msg
= "Could not find Variant field with name {}".format(name
)
2117 raise TypeError(msg
)
2119 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2121 def get_field_from_tag(self
, tag
):
2123 Get a field declaration from tag (EnumerationField).
2126 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_from
_tag
(self
._ft
, tag
._f
)
2128 if field_type_native
is None:
2129 msg
= "Could not find Variant field with tag value {}".format(tag
.value
)
2130 raise TypeError(msg
)
2132 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2134 class ArrayFieldDeclaration(FieldDeclaration
):
2135 def __init__(self
, element_type
, length
):
2137 Create a new array field declaration.
2140 self
._ft
= nbt
._bt
_ctf
_field
_type
_array
_create
(element_type
._ft
,
2145 def element_type(self
):
2147 Get the array's element type.
2150 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_element
_type
(self
._ft
)
2153 raise TypeError("Could not get Array element type")
2155 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2160 Get the array's length.
2163 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_length
(self
._ft
)
2166 raise TypeError("Could not get Array length")
2170 class SequenceFieldDeclaration(FieldDeclaration
):
2171 def __init__(self
, element_type
, length_field_name
):
2173 Create a new sequence field declaration.
2176 self
._ft
= nbt
._bt
_ctf
_field
_type
_sequence
_create
(element_type
._ft
,
2177 str(length_field_name
))
2181 def element_type(self
):
2183 Get the sequence's element type.
2186 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_element
_type
(self
._ft
)
2189 raise TypeError("Could not get Sequence element type")
2191 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2194 def length_field_name(self
):
2196 Get the sequence's length field name.
2199 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_length
_field
_name
(self
._ft
)
2202 raise TypeError("Could not get Sequence length field name")
2206 class StringFieldDeclaration(FieldDeclaration
):
2209 Create a new string field declaration.
2212 self
._ft
= nbt
._bt
_ctf
_field
_type
_string
_create
()
2218 Get a string declaration's encoding (a constant from the CTFStringEncoding class).
2221 return nbt
._bt
_ctf
_field
_type
_string
_get
_encoding
(self
._ft
)
2224 def encoding(self
, encoding
):
2226 Set a string declaration's encoding. Must be a constant from the CTFStringEncoding class.
2229 ret
= nbt
._bt
_ctf
_field
_type
_string
_set
_encoding
(self
._ft
, encoding
)
2231 raise ValueError("Could not set string encoding.")
2234 def create_field(field_type
):
2236 Create an instance of a field.
2238 isinst
= isinstance(field_type
, CTFWriter
.FieldDeclaration
)
2240 if field_type
is None or not isinst
:
2241 raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.")
2243 if isinstance(field_type
, CTFWriter
.IntegerFieldDeclaration
):
2244 return CTFWriter
.IntegerField(field_type
)
2245 elif isinstance(field_type
, CTFWriter
.EnumerationFieldDeclaration
):
2246 return CTFWriter
.EnumerationField(field_type
)
2247 elif isinstance(field_type
, CTFWriter
.FloatFieldDeclaration
):
2248 return CTFWriter
.FloatingPointField(field_type
)
2249 elif isinstance(field_type
, CTFWriter
.StructureFieldDeclaration
):
2250 return CTFWriter
.StructureField(field_type
)
2251 elif isinstance(field_type
, CTFWriter
.VariantFieldDeclaration
):
2252 return CTFWriter
.VariantField(field_type
)
2253 elif isinstance(field_type
, CTFWriter
.ArrayFieldDeclaration
):
2254 return CTFWriter
.ArrayField(field_type
)
2255 elif isinstance(field_type
, CTFWriter
.SequenceFieldDeclaration
):
2256 return CTFWriter
.SequenceField(field_type
)
2257 elif isinstance(field_type
, CTFWriter
.StringFieldDeclaration
):
2258 return CTFWriter
.StringField(field_type
)
2262 Base class, do not instantiate.
2265 def __init__(self
, field_type
):
2266 if not isinstance(field_type
, CTFWriter
.FieldDeclaration
):
2267 raise TypeError("Invalid field_type argument.")
2269 self
._f
= nbt
._bt
_ctf
_field
_create
(field_type
._ft
)
2272 raise ValueError("Field creation failed.")
2275 nbt
._bt
_ctf
_field
_put
(self
._f
)
2278 def _create_field_from_native_instance(native_field_instance
):
2280 CTFTypeId
.INTEGER
: CTFWriter
.IntegerField
,
2281 CTFTypeId
.FLOAT
: CTFWriter
.FloatingPointField
,
2282 CTFTypeId
.ENUM
: CTFWriter
.EnumerationField
,
2283 CTFTypeId
.STRING
: CTFWriter
.StringField
,
2284 CTFTypeId
.STRUCT
: CTFWriter
.StructureField
,
2285 CTFTypeId
.VARIANT
: CTFWriter
.VariantField
,
2286 CTFTypeId
.ARRAY
: CTFWriter
.ArrayField
,
2287 CTFTypeId
.SEQUENCE
: CTFWriter
.SequenceField
2290 field_type
= nbt
._bt
_python
_get
_field
_type
(native_field_instance
)
2292 if field_type
== CTFTypeId
.UNKNOWN
:
2293 raise TypeError("Invalid field instance")
2295 field
= CTFWriter
.Field
.__new
__(CTFWriter
.Field
)
2296 field
._f
= native_field_instance
2297 field
.__class
__ = type_dict
[field_type
]
2302 def declaration(self
):
2303 native_field_type
= nbt
._bt
_ctf
_field
_get
_type
(self
._f
)
2305 if native_field_type
is None:
2306 raise TypeError("Invalid field instance")
2307 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(
2310 class IntegerField(Field
):
2314 Get an integer field's value.
2317 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
2320 raise TypeError("Invalid integer instance.")
2323 ret
, value
= nbt
._bt
_ctf
_field
_unsigned
_integer
_get
_value
(self
._f
)
2325 ret
, value
= nbt
._bt
_ctf
_field
_signed
_integer
_get
_value
(self
._f
)
2328 raise ValueError("Could not get integer field value.")
2333 def value(self
, value
):
2335 Set an integer field's value.
2338 if not isinstance(value
, int):
2339 raise TypeError("IntegerField's value must be an int")
2341 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
2343 raise TypeError("Invalid integer instance.")
2346 ret
= nbt
._bt
_ctf
_field
_unsigned
_integer
_set
_value
(self
._f
, value
)
2348 ret
= nbt
._bt
_ctf
_field
_signed
_integer
_set
_value
(self
._f
, value
)
2351 raise ValueError("Could not set integer field value.")
2353 class EnumerationField(Field
):
2355 def container(self
):
2357 Return the enumeration's underlying container field (an integer field).
2360 container
= CTFWriter
.IntegerField
.__new
__(CTFWriter
.IntegerField
)
2361 container
._f
= nbt
._bt
_ctf
_field
_enumeration
_get
_container
(self
._f
)
2363 if container
._f
is None:
2364 raise TypeError("Invalid enumeration field type.")
2371 Get the enumeration field's mapping name.
2374 value
= nbt
._bt
_ctf
_field
_enumeration
_get
_mapping
_name
(self
._f
)
2377 raise ValueError("Could not get enumeration's mapping name.")
2382 def value(self
, value
):
2384 Set the enumeration field's value. Must be an integer as mapping names
2388 if not isinstance(value
, int):
2389 raise TypeError("EnumerationField value must be an int")
2391 self
.container
.value
= value
2393 class FloatingPointField(Field
):
2397 Get a floating point field's value.
2400 ret
, value
= nbt
._bt
_ctf
_field
_floating
_point
_get
_value
(self
._f
)
2403 raise ValueError("Could not get floating point field value.")
2408 def value(self
, value
):
2410 Set a floating point field's value.
2413 if not isinstance(value
, int) and not isinstance(value
, float):
2414 raise TypeError("Value must be either a float or an int")
2416 ret
= nbt
._bt
_ctf
_field
_floating
_point
_set
_value
(self
._f
, float(value
))
2419 raise ValueError("Could not set floating point field value.")
2421 # oops!! This class is provided to ensure backward-compatibility since
2422 # a stable release publicly exposed this abomination.
2423 class FloatFieldingPoint(FloatingPointField
):
2426 class StructureField(Field
):
2427 def field(self
, field_name
):
2429 Get the structure's field corresponding to the provided field name.
2432 native_instance
= nbt
._bt
_ctf
_field
_structure
_get
_field
(self
._f
,
2435 if native_instance
is None:
2436 raise ValueError("Invalid field_name provided.")
2438 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2440 class VariantField(Field
):
2441 def field(self
, tag
):
2443 Return the variant's selected field. The "tag" field is the selector enum field.
2446 native_instance
= nbt
._bt
_ctf
_field
_variant
_get
_field
(self
._f
, tag
._f
)
2448 if native_instance
is None:
2449 raise ValueError("Invalid tag provided.")
2451 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2453 class ArrayField(Field
):
2454 def field(self
, index
):
2456 Return the array's field at position "index".
2459 native_instance
= nbt
._bt
_ctf
_field
_array
_get
_field
(self
._f
, index
)
2461 if native_instance
is None:
2462 raise IndexError("Invalid index provided.")
2464 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2466 class SequenceField(Field
):
2470 Get the sequence's length field (IntegerField).
2473 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_length
(self
._f
)
2475 if native_instance
is None:
2478 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2481 def length(self
, length_field
):
2483 Set the sequence's length field (IntegerField).
2486 if not isinstance(length_field
, CTFWriter
.IntegerField
):
2487 raise TypeError("Invalid length field.")
2489 if length_field
.declaration
.signed
:
2490 raise TypeError("Sequence field length must be unsigned")
2492 ret
= nbt
._bt
_ctf
_field
_sequence
_set
_length
(self
._f
, length_field
._f
)
2495 raise ValueError("Could not set sequence length.")
2497 def field(self
, index
):
2499 Return the sequence's field at position "index".
2502 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_field
(self
._f
, index
)
2504 if native_instance
is None:
2505 raise ValueError("Could not get sequence element at index.")
2507 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2509 class StringField(Field
):
2513 Get a string field's value.
2516 return nbt
._bt
_ctf
_field
_string
_get
_value
(self
._f
)
2519 def value(self
, value
):
2521 Set a string field's value.
2524 ret
= nbt
._bt
_ctf
_field
_string
_set
_value
(self
._f
, str(value
))
2527 raise ValueError("Could not set string field value.")
2530 def __init__(self
, name
):
2532 Create a new event class of the given name.
2535 self
._ec
= nbt
._bt
_ctf
_event
_class
_create
(name
)
2537 if self
._ec
is None:
2538 raise ValueError("Event class creation failed.")
2541 nbt
._bt
_ctf
_event
_class
_put
(self
._ec
)
2543 def add_field(self
, field_type
, field_name
):
2545 Add a field of type "field_type" to the event class.
2548 ret
= nbt
._bt
_ctf
_event
_class
_add
_field
(self
._ec
, field_type
._ft
,
2552 raise ValueError("Could not add field to event class.")
2557 Get the event class' name.
2560 name
= nbt
._bt
_ctf
_event
_class
_get
_name
(self
._ec
)
2563 raise TypeError("Could not get EventClass name")
2570 Get the event class' id. Returns a negative value if unset.
2573 id = nbt
._bt
_ctf
_event
_class
_get
_id
(self
._ec
)
2576 raise TypeError("Could not get EventClass id")
2583 Set the event class' id. Throws a TypeError if the event class
2584 is already registered to a stream class.
2587 ret
= nbt
._bt
_ctf
_event
_class
_set
_id
(self
._ec
, id)
2590 raise TypeError("Can't change an Event Class's id after it has been assigned to a stream class")
2593 def stream_class(self
):
2595 Get the event class' stream class. Returns None if unset.
2597 stream_class_native
= nbt
._bt
_ctf
_event
_class
_get
_stream
_class
(self
._ec
)
2599 if stream_class_native
is None:
2602 stream_class
= CTFWriter
.StreamClass
.__new
__(CTFWriter
.StreamClass
)
2603 stream_class
._sc
= stream_class_native
2610 Generator returning the event class' fields as tuples of (field name, field declaration).
2613 count
= nbt
._bt
_ctf
_event
_class
_get
_field
_count
(self
._ec
)
2616 raise TypeError("Could not get EventClass' field count")
2618 for i
in range(count
):
2619 field_name
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_name
(self
._ec
, i
)
2621 if field_name
is None:
2622 msg
= "Could not get EventClass' field name at index {}".format(i
)
2623 raise TypeError(msg
)
2625 field_type_native
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_type
(self
._ec
, i
)
2627 if field_type_native
is None:
2628 msg
= "Could not get EventClass' field type at index {}".format(i
)
2629 raise TypeError(msg
)
2631 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2632 yield (field_name
, field_type
)
2634 def get_field_by_name(self
, name
):
2636 Get a field declaration by name (FieldDeclaration).
2639 field_type_native
= nbt
._bt
_ctf
_event
_class
_get
_field
_by
_name
(self
._ec
, name
)
2641 if field_type_native
is None:
2642 msg
= "Could not find EventClass field with name {}".format(name
)
2643 raise TypeError(msg
)
2645 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2648 def __init__(self
, event_class
):
2650 Create a new event of the given event class.
2653 if not isinstance(event_class
, CTFWriter
.EventClass
):
2654 raise TypeError("Invalid event_class argument.")
2656 self
._e
= nbt
._bt
_ctf
_event
_create
(event_class
._ec
)
2659 raise ValueError("Event creation failed.")
2662 nbt
._bt
_ctf
_event
_put
(self
._e
)
2665 def event_class(self
):
2667 Get the event's class.
2670 event_class_native
= nbt
._bt
_ctf
_event
_get
_class
(self
._e
)
2672 if event_class_native
is None:
2675 event_class
= CTFWriter
.EventClass
.__new
__(CTFWriter
.EventClass
)
2676 event_class
._ec
= event_class_native
2682 Get a clock from event. Returns None if the event's class
2683 is not registered to a stream class.
2686 clock_instance
= nbt
._bt
_ctf
_event
_get
_clock
(self
._e
)
2688 if clock_instance
is None:
2691 clock
= CTFWriter
.Clock
.__new
__(CTFWriter
.Clock
)
2692 clock
._c
= clock_instance
2696 def payload(self
, field_name
):
2698 Get a field from event.
2701 native_instance
= nbt
._bt
_ctf
_event
_get
_payload
(self
._e
,
2704 if native_instance
is None:
2705 raise ValueError("Could not get event payload.")
2707 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2709 def set_payload(self
, field_name
, value_field
):
2711 Set a manually created field as an event's payload.
2714 if not isinstance(value
, CTFWriter
.Field
):
2715 raise TypeError("Invalid value type.")
2717 ret
= nbt
._bt
_ctf
_event
_set
_payload
(self
._e
, str(field_name
),
2721 raise ValueError("Could not set event field payload.")
2724 def __init__(self
, name
):
2726 Create a new stream class of the given name.
2729 self
._sc
= nbt
._bt
_ctf
_stream
_class
_create
(name
)
2731 if self
._sc
is None:
2732 raise ValueError("Stream class creation failed.")
2735 nbt
._bt
_ctf
_stream
_class
_put
(self
._sc
)
2740 Get a stream class' name.
2743 name
= nbt
._bt
_ctf
_stream
_class
_get
_name
(self
._sc
)
2746 raise TypeError("Could not get StreamClass name")
2753 Get a stream class' clock.
2756 clock_instance
= nbt
._bt
_ctf
_stream
_class
_get
_clock
(self
._sc
)
2758 if clock_instance
is None:
2761 clock
= CTFWriter
.Clock
.__new
__(CTFWriter
.Clock
)
2762 clock
._c
= clock_instance
2767 def clock(self
, clock
):
2769 Assign a clock to a stream class.
2772 if not isinstance(clock
, CTFWriter
.Clock
):
2773 raise TypeError("Invalid clock type.")
2775 ret
= nbt
._bt
_ctf
_stream
_class
_set
_clock
(self
._sc
, clock
._c
)
2778 raise ValueError("Could not set stream class clock.")
2783 Get a stream class' id.
2786 ret
= nbt
._bt
_ctf
_stream
_class
_get
_id
(self
._sc
)
2789 raise TypeError("Could not get StreamClass id")
2796 Assign an id to a stream class.
2799 ret
= nbt
._bt
_ctf
_stream
_class
_set
_id
(self
._sc
, id)
2802 raise TypeError("Could not set stream class id.")
2805 def event_classes(self
):
2807 Generator returning the stream class' event classes.
2810 count
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
_count
(self
._sc
)
2813 raise TypeError("Could not get StreamClass' event class count")
2815 for i
in range(count
):
2816 event_class_native
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
(self
._sc
, i
)
2818 if event_class_native
is None:
2819 msg
= "Could not get StreamClass' event class at index {}".format(i
)
2820 raise TypeError(msg
)
2822 event_class
= CTFWriter
.EventClass
.__new
__(CTFWriter
.EventClass
)
2823 event_class
._ec
= event_class_native
2826 def add_event_class(self
, event_class
):
2828 Add an event class to a stream class. New events can be added even after a
2829 stream has been instantiated and events have been appended. However, a stream
2830 will not accept events of a class that has not been added to the stream
2834 if not isinstance(event_class
, CTFWriter
.EventClass
):
2835 raise TypeError("Invalid event_class type.")
2837 ret
= nbt
._bt
_ctf
_stream
_class
_add
_event
_class
(self
._sc
,
2841 raise ValueError("Could not add event class.")
2844 def packet_context_type(self
):
2846 Get the StreamClass' packet context type (StructureFieldDeclaration)
2849 field_type_native
= nbt
._bt
_ctf
_stream
_class
_get
_packet
_context
_type
(self
._sc
)
2851 if field_type_native
is None:
2852 raise ValueError("Invalid StreamClass")
2854 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2858 @packet_context_type.setter
2859 def packet_context_type(self
, field_type
):
2861 Set a StreamClass' packet context type. Must be of type
2862 StructureFieldDeclaration.
2865 if not isinstance(field_type
, CTFWriter
.StructureFieldDeclaration
):
2866 raise TypeError("field_type argument must be of type StructureFieldDeclaration.")
2868 ret
= nbt
._bt
_ctf
_stream
_class
_set
_packet
_context
_type
(self
._sc
,
2872 raise ValueError("Failed to set packet context type.")
2876 raise NotImplementedError("Stream cannot be instantiated; use Writer.create_stream()")
2879 nbt
._bt
_ctf
_stream
_put
(self
._s
)
2882 def discarded_events(self
):
2884 Get a stream's discarded event count.
2887 ret
, count
= nbt
._bt
_ctf
_stream
_get
_discarded
_events
_count
(self
._s
)
2890 raise ValueError("Could not get the stream's discarded events count")
2894 def append_discarded_events(self
, event_count
):
2896 Increase the current packet's discarded event count.
2899 nbt
._bt
_ctf
_stream
_append
_discarded
_events
(self
._s
, event_count
)
2901 def append_event(self
, event
):
2903 Append "event" to the stream's current packet. The stream's associated clock
2904 will be sampled during this call. The event shall not be modified after
2905 being appended to a stream.
2908 ret
= nbt
._bt
_ctf
_stream
_append
_event
(self
._s
, event
._e
)
2911 raise ValueError("Could not append event to stream.")
2914 def packet_context(self
):
2916 Get a Stream's packet context field (a StructureField).
2919 native_field
= nbt
._bt
_ctf
_stream
_get
_packet
_context
(self
._s
)
2921 if native_field
is None:
2922 raise ValueError("Invalid Stream.")
2924 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_field
)
2926 @packet_context.setter
2927 def packet_context(self
, field
):
2929 Set a Stream's packet context field (must be a StructureField).
2932 if not isinstance(field
, CTFWriter
.StructureField
):
2933 raise TypeError("Argument field must be of type StructureField")
2935 ret
= nbt
._bt
_ctf
_stream
_set
_packet
_context
(self
._s
, field
._f
)
2938 raise ValueError("Invalid packet context field.")
2942 The stream's current packet's events will be flushed to disk. Events
2943 subsequently appended to the stream will be added to a new packet.
2946 ret
= nbt
._bt
_ctf
_stream
_flush
(self
._s
)
2949 raise ValueError("Could not flush stream.")
2952 def __init__(self
, path
):
2954 Create a new writer that will produce a trace in the given path.
2957 self
._w
= nbt
._bt
_ctf
_writer
_create
(path
)
2960 raise ValueError("Writer creation failed.")
2963 nbt
._bt
_ctf
_writer
_put
(self
._w
)
2965 def create_stream(self
, stream_class
):
2967 Create a new stream instance and register it to the writer.
2970 if not isinstance(stream_class
, CTFWriter
.StreamClass
):
2971 raise TypeError("Invalid stream_class type.")
2973 stream
= CTFWriter
.Stream
.__new
__(CTFWriter
.Stream
)
2974 stream
._s
= nbt
._bt
_ctf
_writer
_create
_stream
(self
._w
, stream_class
._sc
)
2978 def add_environment_field(self
, name
, value
):
2980 Add an environment field to the trace.
2983 ret
= nbt
._bt
_ctf
_writer
_add
_environment
_field
(self
._w
, str(name
),
2987 raise ValueError("Could not add environment field to trace.")
2989 def add_clock(self
, clock
):
2991 Add a clock to the trace. Clocks assigned to stream classes must be
2992 registered to the writer.
2995 ret
= nbt
._bt
_ctf
_writer
_add
_clock
(self
._w
, clock
._c
)
2998 raise ValueError("Could not add clock to Writer.")
3003 Get the trace's TSDL meta-data.
3006 return nbt
._bt
_ctf
_writer
_get
_metadata
_string
(self
._w
)
3008 def flush_metadata(self
):
3010 Flush the trace's metadata to the metadata file.
3013 nbt
._bt
_ctf
_writer
_flush
_metadata
(self
._w
)
3016 def byte_order(self
):
3018 Get the trace's byte order. Must be a constant from the ByteOrder
3022 raise NotImplementedError("Getter not implemented.")
3025 def byte_order(self
, byte_order
):
3027 Set the trace's byte order. Must be a constant from the ByteOrder
3028 class. Defaults to the host machine's endianness
3031 ret
= nbt
._bt
_ctf
_writer
_set
_byte
_order
(self
._w
, byte_order
)
3034 raise ValueError("Could not set trace's byte order.")