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
):
1042 """Do not instantiate."""
1045 raise NotImplementedError("FloatFieldDeclaration cannot be instantiated")
1048 class StructureFieldDeclaration(FieldDeclaration
):
1049 """Do not instantiate."""
1052 raise NotImplementedError("StructureFieldDeclaration cannot be instantiated")
1055 class StringFieldDeclaration(FieldDeclaration
):
1056 """Do not instantiate."""
1059 raise NotImplementedError("StringFieldDeclaration cannot be instantiated")
1062 class VariantFieldDeclaration(FieldDeclaration
):
1063 """Do not instantiate."""
1066 raise NotImplementedError("VariantFieldDeclaration cannot be instantiated")
1071 Return the last error code encountered while
1072 accessing a field and reset the error flag.
1073 Return 0 if no error, a negative value otherwise.
1076 return nbt
._bt
_ctf
_field
_get
_error
()
1079 def _create_field_declaration(declaration_ptr
, name
, scope
):
1081 Private field declaration factory.
1084 if declaration_ptr
is None:
1085 raise ValueError("declaration_ptr must be valid")
1086 if scope
not in _scopes
:
1087 raise ValueError("Invalid scope provided")
1089 type = nbt
._bt
_ctf
_field
_type
(declaration_ptr
)
1092 if type == CTFTypeId
.INTEGER
:
1093 declaration
= IntegerFieldDeclaration
.__new
__(IntegerFieldDeclaration
)
1094 elif type == CTFTypeId
.ENUM
:
1095 declaration
= EnumerationFieldDeclaration
.__new
__(EnumerationFieldDeclaration
)
1096 elif type == CTFTypeId
.ARRAY
:
1097 declaration
= ArrayFieldDeclaration
.__new
__(ArrayFieldDeclaration
)
1098 elif type == CTFTypeId
.SEQUENCE
:
1099 declaration
= SequenceFieldDeclaration
.__new
__(SequenceFieldDeclaration
)
1100 elif type == CTFTypeId
.FLOAT
:
1101 declaration
= FloatFieldDeclaration
.__new
__(FloatFieldDeclaration
)
1102 elif type == CTFTypeId
.STRUCT
:
1103 declaration
= StructureFieldDeclaration
.__new
__(StructureFieldDeclaration
)
1104 elif type == CTFTypeId
.STRING
:
1105 declaration
= StringFieldDeclaration
.__new
__(StringFieldDeclaration
)
1106 elif type == CTFTypeId
.VARIANT
:
1107 declaration
= VariantFieldDeclaration
.__new
__(VariantFieldDeclaration
)
1111 declaration
._fd
= declaration_ptr
1112 declaration
._s
= scope
1113 declaration
._name
= name
1119 def __init__(self
, definition_ptr
, scope
):
1120 self
._d
= definition_ptr
1123 if scope
not in _scopes
:
1124 ValueError("Invalid scope provided")
1128 """Return the name of a field or None on error."""
1130 return nbt
._bt
_ctf
_field
_name
(self
._d
)
1134 """Return the type of a field or -1 if unknown."""
1136 return nbt
._bt
_ctf
_field
_type
(nbt
._bt
_ctf
_get
_decl
_from
_def
(self
._d
))
1139 def declaration(self
):
1140 """Return the associated Definition object."""
1142 return _create_field_declaration(
1143 nbt
._bt
_ctf
_get
_decl
_from
_def
(self
._d
), self
.name
, self
.scope
)
1145 def _get_enum_str(self
):
1147 Return the string matching the current enumeration.
1148 Return None on error.
1151 return nbt
._bt
_ctf
_get
_enum
_str
(self
._d
)
1153 def _get_array_element_at(self
, index
):
1155 Return the array's element at position index.
1156 Return None on error
1159 array_ptr
= nbt
._bt
_python
_get
_array
_from
_def
(self
._d
)
1161 if array_ptr
is None:
1164 definition_ptr
= nbt
._bt
_array
_index
(array_ptr
, index
)
1166 if definition_ptr
is None:
1169 return _Definition(definition_ptr
, self
.scope
)
1171 def _get_sequence_len(self
):
1173 Return the len of a sequence or a negative
1177 seq
= nbt
._bt
_python
_get
_sequence
_from
_def
(self
._d
)
1179 return nbt
._bt
_sequence
_len
(seq
)
1181 def _get_sequence_element_at(self
, index
):
1183 Return the sequence's element at position index,
1184 otherwise return None
1187 seq
= nbt
._bt
_python
_get
_sequence
_from
_def
(self
._d
)
1190 definition_ptr
= nbt
._bt
_sequence
_index
(seq
, index
)
1192 if definition_ptr
is not None:
1193 return _Definition(definition_ptr
, self
.scope
)
1195 def _get_uint64(self
):
1197 Return the value associated with the field.
1198 If the field does not exist or is not of the type requested,
1199 the value returned is undefined. To check if an error occured,
1200 use the field_error() function after accessing a field.
1203 return nbt
._bt
_ctf
_get
_uint
64(self
._d
)
1205 def _get_int64(self
):
1207 Return the value associated with the field.
1208 If the field does not exist or is not of the type requested,
1209 the value returned is undefined. To check if an error occured,
1210 use the field_error() function after accessing a field.
1213 return nbt
._bt
_ctf
_get
_int
64(self
._d
)
1215 def _get_char_array(self
):
1217 Return the value associated with the field.
1218 If the field does not exist or is not of the type requested,
1219 the value returned is undefined. To check if an error occurred,
1220 use the field_error() function after accessing a field.
1223 return nbt
._bt
_ctf
_get
_char
_array
(self
._d
)
1227 Return the value associated with the field.
1228 If the field does not exist or is not of the type requested,
1229 the value returned is undefined. To check if an error occurred,
1230 use the field_error() function after accessing a field.
1233 return nbt
._bt
_ctf
_get
_string
(self
._d
)
1235 def _get_float(self
):
1237 Return the value associated with the field.
1238 If the field does not exist or is not of the type requested,
1239 the value returned is undefined. To check if an error occurred,
1240 use the field_error() function after accessing a field.
1243 return nbt
._bt
_ctf
_get
_float
(self
._d
)
1245 def _get_variant(self
):
1247 Return the variant's selected field.
1248 If the field does not exist or is not of the type requested,
1249 the value returned is undefined. To check if an error occurred,
1250 use the field_error() function after accessing a field.
1253 return nbt
._bt
_ctf
_get
_variant
(self
._d
)
1255 def _get_struct_field_count(self
):
1257 Return the number of fields contained in the structure.
1258 If the field does not exist or is not of the type requested,
1259 the value returned is undefined.
1262 return nbt
._bt
_ctf
_get
_struct
_field
_count
(self
._d
)
1264 def _get_struct_field_at(self
, i
):
1266 Return the structure's field at position i.
1267 If the field does not exist or is not of the type requested,
1268 the value returned is undefined. To check if an error occurred,
1269 use the field_error() function after accessing a field.
1272 return nbt
._bt
_ctf
_get
_struct
_field
_index
(self
._d
, i
)
1277 Return the value associated with the field according to its type.
1278 Return None on error.
1284 if id == CTFTypeId
.STRING
:
1285 value
= self
._get
_str
()
1286 elif id == CTFTypeId
.ARRAY
:
1287 element_decl
= self
.declaration
.element_declaration
1289 if ((element_decl
.type == CTFTypeId
.INTEGER
1290 and element_decl
.length
== 8)
1291 and (element_decl
.encoding
== CTFStringEncoding
.ASCII
or element_decl
.encoding
== CTFStringEncoding
.UTF8
)):
1292 value
= nbt
._bt
_python
_get
_array
_string
(self
._d
)
1296 for i
in range(self
.declaration
.length
):
1297 element
= self
._get
_array
_element
_at
(i
)
1298 value
.append(element
.value
)
1299 elif id == CTFTypeId
.INTEGER
:
1300 if self
.declaration
.signedness
== 0:
1301 value
= self
._get
_uint
64()
1303 value
= self
._get
_int
64()
1304 elif id == CTFTypeId
.ENUM
:
1305 value
= self
._get
_enum
_str
()
1306 elif id == CTFTypeId
.SEQUENCE
:
1307 element_decl
= self
.declaration
.element_declaration
1309 if ((element_decl
.type == CTFTypeId
.INTEGER
1310 and element_decl
.length
== 8)
1311 and (element_decl
.encoding
== CTFStringEncoding
.ASCII
or element_decl
.encoding
== CTFStringEncoding
.UTF8
)):
1312 value
= nbt
._bt
_python
_get
_sequence
_string
(self
._d
)
1314 seq_len
= self
._get
_sequence
_len
()
1317 for i
in range(seq_len
):
1318 evDef
= self
._get
_sequence
_element
_at
(i
)
1319 value
.append(evDef
.value
)
1320 elif id == CTFTypeId
.FLOAT
:
1321 value
= self
._get
_float
()
1322 elif id == CTFTypeId
.VARIANT
:
1323 variant
= _Definition
.__new
__(_Definition
)
1324 variant
._d
= self
._get
_variant
()
1325 value
= variant
.value
1326 elif id == CTFTypeId
.STRUCT
:
1329 for i
in range(self
._get
_struct
_field
_count
()):
1330 member
= _Definition(self
._get
_struct
_field
_at
(i
), self
.scope
)
1331 value
[member
.name
] = member
.value
1335 "Error occurred while accessing field {} of type {}".format(
1337 CTFTypeId
.type_name(id)))
1343 """Return the scope of a field or None on error."""
1349 # Used to compare to -1ULL in error checks
1350 _MAX_UINT64
= 0xFFFFFFFFFFFFFFFF
1352 class EnumerationMapping
:
1354 Enumeration mapping class. start and end values are inclusive.
1357 def __init__(self
, name
, start
, end
):
1363 def __init__(self
, name
):
1364 self
._c
= nbt
._bt
_ctf
_clock
_create
(name
)
1367 raise ValueError("Invalid clock name.")
1370 nbt
._bt
_ctf
_clock
_put
(self
._c
)
1375 Get the clock's name.
1378 name
= nbt
._bt
_ctf
_clock
_get
_name
(self
._c
)
1381 raise ValueError("Invalid clock instance.")
1386 def description(self
):
1388 Get the clock's description. None if unset.
1391 return nbt
._bt
_ctf
_clock
_get
_description
(self
._c
)
1394 def description(self
, desc
):
1396 Set the clock's description. The description appears in the clock's TSDL
1400 ret
= nbt
._bt
_ctf
_clock
_set
_description
(self
._c
, str(desc
))
1403 raise ValueError("Invalid clock description.")
1406 def frequency(self
):
1408 Get the clock's frequency (Hz).
1411 freq
= nbt
._bt
_ctf
_clock
_get
_frequency
(self
._c
)
1413 if freq
== CTFWriter
._MAX
_UINT
64:
1414 raise ValueError("Invalid clock instance")
1419 def frequency(self
, freq
):
1421 Set the clock's frequency (Hz).
1424 ret
= nbt
._bt
_ctf
_clock
_set
_frequency
(self
._c
, freq
)
1427 raise ValueError("Invalid frequency value.")
1430 def precision(self
):
1432 Get the clock's precision (in clock ticks).
1435 precision
= nbt
._bt
_ctf
_clock
_get
_precision
(self
._c
)
1437 if precision
== CTFWriter
._MAX
_UINT
64:
1438 raise ValueError("Invalid clock instance")
1443 def precision(self
, precision
):
1445 Set the clock's precision (in clock ticks).
1448 ret
= nbt
._bt
_ctf
_clock
_set
_precision
(self
._c
, precision
)
1451 def offset_seconds(self
):
1453 Get the clock's offset in seconds from POSIX.1 Epoch.
1456 offset_s
= nbt
._bt
_ctf
_clock
_get
_offset
_s
(self
._c
)
1458 if offset_s
== CTFWriter
._MAX
_UINT
64:
1459 raise ValueError("Invalid clock instance")
1463 @offset_seconds.setter
1464 def offset_seconds(self
, offset_s
):
1466 Set the clock's offset in seconds from POSIX.1 Epoch.
1469 ret
= nbt
._bt
_ctf
_clock
_set
_offset
_s
(self
._c
, offset_s
)
1472 raise ValueError("Invalid offset value.")
1477 Get the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1480 offset
= nbt
._bt
_ctf
_clock
_get
_offset
(self
._c
)
1482 if offset
== CTFWriter
._MAX
_UINT
64:
1483 raise ValueError("Invalid clock instance")
1488 def offset(self
, offset
):
1490 Set the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1493 ret
= nbt
._bt
_ctf
_clock
_set
_offset
(self
._c
, offset
)
1496 raise ValueError("Invalid offset value.")
1501 Get a clock's absolute attribute. A clock is absolute if the clock
1502 is a global reference across the trace's other clocks.
1505 is_absolute
= nbt
._bt
_ctf
_clock
_get
_is
_absolute
(self
._c
)
1507 if is_absolute
== -1:
1508 raise ValueError("Invalid clock instance")
1510 return False if is_absolute
== 0 else True
1513 def absolute(self
, is_absolute
):
1515 Set a clock's absolute attribute. A clock is absolute if the clock
1516 is a global reference across the trace's other clocks.
1519 ret
= nbt
._bt
_ctf
_clock
_set
_is
_absolute
(self
._c
, int(is_absolute
))
1522 raise ValueError("Could not set the clock's absolute attribute.")
1527 Get a clock's UUID (an object of type UUID).
1533 ret
, value
= nbt
._bt
_python
_ctf
_clock
_get
_uuid
_index
(self
._c
, i
)
1536 raise ValueError("Invalid clock instance")
1538 uuid_list
.append(value
)
1540 return UUID(bytes
=bytes(uuid_list
))
1543 def uuid(self
, uuid
):
1545 Set a clock's UUID (an object of type UUID).
1548 uuid_bytes
= uuid
.bytes
1550 if len(uuid_bytes
) != 16:
1551 raise ValueError("Invalid UUID provided. UUID length must be 16 bytes")
1553 for i
in range(len(uuid_bytes
)):
1554 ret
= nbt
._bt
_python
_ctf
_clock
_set
_uuid
_index
(self
._c
, i
,
1558 raise ValueError("Invalid clock instance")
1563 Get the current time in nanoseconds since the clock's origin (offset and
1564 offset_s attributes).
1567 time
= nbt
._bt
_ctf
_clock
_get
_time
(self
._c
)
1569 if time
== CTFWriter
._MAX
_UINT
64:
1570 raise ValueError("Invalid clock instance")
1575 def time(self
, time
):
1577 Set the current time in nanoseconds since the clock's origin (offset and
1578 offset_s attributes). The clock's value will be sampled as events are
1579 appended to a stream.
1582 ret
= nbt
._bt
_ctf
_clock
_set
_time
(self
._c
, time
)
1585 raise ValueError("Invalid time value.")
1587 class FieldDeclaration
:
1589 FieldDeclaration should not be instantiated directly. Instantiate
1590 one of the concrete FieldDeclaration classes.
1594 # These values are based on the bt_ctf_integer_base enum
1595 # declared in event-types.h.
1596 INTEGER_BASE_UNKNOWN
= -1
1597 INTEGER_BASE_BINARY
= 2
1598 INTEGER_BASE_OCTAL
= 8
1599 INTEGER_BASE_DECIMAL
= 10
1600 INTEGER_BASE_HEXADECIMAL
= 16
1603 if self
._ft
is None:
1604 raise ValueError("FieldDeclaration creation failed.")
1607 nbt
._bt
_ctf
_field
_type
_put
(self
._ft
)
1610 def _create_field_declaration_from_native_instance(
1611 native_field_declaration
):
1613 CTFTypeId
.INTEGER
: CTFWriter
.IntegerFieldDeclaration
,
1614 CTFTypeId
.FLOAT
: CTFWriter
.FloatFieldDeclaration
,
1615 CTFTypeId
.ENUM
: CTFWriter
.EnumerationFieldDeclaration
,
1616 CTFTypeId
.STRING
: CTFWriter
.StringFieldDeclaration
,
1617 CTFTypeId
.STRUCT
: CTFWriter
.StructureFieldDeclaration
,
1618 CTFTypeId
.VARIANT
: CTFWriter
.VariantFieldDeclaration
,
1619 CTFTypeId
.ARRAY
: CTFWriter
.ArrayFieldDeclaration
,
1620 CTFTypeId
.SEQUENCE
: CTFWriter
.SequenceFieldDeclaration
1623 field_type_id
= nbt
._bt
_ctf
_field
_type
_get
_type
_id
(native_field_declaration
)
1625 if field_type_id
== CTFTypeId
.UNKNOWN
:
1626 raise TypeError("Invalid field instance")
1628 declaration
= CTFWriter
.Field
.__new
__(CTFWriter
.Field
)
1629 declaration
._ft
= native_field_declaration
1630 declaration
.__class
__ = type_dict
[field_type_id
]
1635 def alignment(self
):
1637 Get the field declaration's alignment. Returns -1 on error.
1640 return nbt
._bt
_ctf
_field
_type
_get
_alignment
(self
._ft
)
1643 def alignment(self
, alignment
):
1645 Set the field declaration's alignment. Defaults to 1 (bit-aligned). However,
1646 some types, such as structures and string, may impose other alignment
1650 ret
= nbt
._bt
_ctf
_field
_type
_set
_alignment
(self
._ft
, alignment
)
1653 raise ValueError("Invalid alignment value.")
1656 def byte_order(self
):
1658 Get the field declaration's byte order. One of the ByteOrder's constant.
1661 return nbt
._bt
_ctf
_field
_type
_get
_byte
_order
(self
._ft
)
1664 def byte_order(self
, byte_order
):
1666 Set the field declaration's byte order. Use constants defined in the ByteOrder
1670 ret
= nbt
._bt
_ctf
_field
_type
_set
_byte
_order
(self
._ft
, byte_order
)
1673 raise ValueError("Could not set byte order value.")
1675 class IntegerFieldDeclaration(FieldDeclaration
):
1676 def __init__(self
, size
):
1678 Create a new integer field declaration of the given size.
1680 self
._ft
= nbt
._bt
_ctf
_field
_type
_integer
_create
(size
)
1686 Get an integer's size.
1689 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_size
(self
._ft
)
1692 raise ValueError("Could not get Integer's size attribute.")
1699 Get an integer's signedness attribute.
1702 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_signed
(self
._ft
)
1705 raise ValueError("Could not get Integer's signed attribute.")
1712 def signed(self
, signed
):
1714 Set an integer's signedness attribute.
1717 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_signed
(self
._ft
, signed
)
1720 raise ValueError("Could not set Integer's signed attribute.")
1725 Get the integer's base used to pretty-print the resulting trace.
1726 Returns a constant from the FieldDeclaration.IntegerBase class.
1729 return nbt
._bt
_ctf
_field
_type
_integer
_get
_base
(self
._ft
)
1732 def base(self
, base
):
1734 Set the integer's base used to pretty-print the resulting trace.
1735 The base must be a constant of the FieldDeclarationIntegerBase class.
1738 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_base
(self
._ft
, base
)
1741 raise ValueError("Could not set Integer's base.")
1746 Get the integer's encoding (one of the constants of the
1747 CTFStringEncoding class).
1748 Returns a constant from the CTFStringEncoding class.
1751 return nbt
._bt
_ctf
_field
_type
_integer
_get
_encoding
(self
._ft
)
1754 def encoding(self
, encoding
):
1756 An integer encoding may be set to signal that the integer must be printed
1757 as a text character. Must be a constant from the CTFStringEncoding class.
1760 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_encoding
(self
._ft
, encoding
)
1763 raise ValueError("Could not set Integer's encoding.")
1765 class EnumerationFieldDeclaration(FieldDeclaration
):
1766 def __init__(self
, integer_type
):
1768 Create a new enumeration field declaration with the given underlying container type.
1770 isinst
= isinstance(integer_type
, CTFWriter
.IntegerFieldDeclaration
)
1772 if integer_type
is None or not isinst
:
1773 raise TypeError("Invalid integer container.")
1775 self
._ft
= nbt
._bt
_ctf
_field
_type
_enumeration
_create
(integer_type
._ft
)
1779 def container(self
):
1781 Get the enumeration's underlying container type.
1784 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_container
_type
(self
._ft
)
1787 raise TypeError("Invalid enumeration declaration")
1789 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
1791 def add_mapping(self
, name
, range_start
, range_end
):
1793 Add a mapping to the enumeration. The range's values are inclusive.
1796 if range_start
< 0 or range_end
< 0:
1797 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
(self
._ft
,
1802 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
_unsigned
(self
._ft
,
1808 raise ValueError("Could not add mapping to enumeration declaration.")
1813 Generator returning instances of EnumerationMapping.
1816 signed
= self
.container
.signed
1818 count
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_count
(self
._ft
)
1820 for i
in range(count
):
1822 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, i
)
1824 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, i
)
1827 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1828 raise TypeError(msg
)
1830 name
, range_start
, range_end
= ret
1831 yield CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1833 def get_mapping_by_name(self
, name
):
1835 Get a mapping by name (EnumerationMapping).
1838 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_name
(self
._ft
, name
)
1843 if self
.container
.signed
:
1844 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
1846 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
1849 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1850 raise TypeError(msg
)
1852 name
, range_start
, range_end
= ret
1854 return CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1856 def get_mapping_by_value(self
, value
):
1858 Get a mapping by value (EnumerationMapping).
1862 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_value
(self
._ft
, value
)
1864 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_unsigned
_value
(self
._ft
, value
)
1869 if self
.container
.signed
:
1870 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
1872 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
1875 msg
= "Could not get Enumeration mapping at index {}".format(i
)
1876 raise TypeError(msg
)
1878 name
, range_start
, range_end
= ret
1880 return CTFWriter
.EnumerationMapping(name
, range_start
, range_end
)
1882 class FloatFieldDeclaration(FieldDeclaration
):
1890 Create a new floating point field declaration.
1893 self
._ft
= nbt
._bt
_ctf
_field
_type
_floating
_point
_create
()
1897 def exponent_digits(self
):
1899 Get the number of exponent digits used to store the floating point field.
1902 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_exponent
_digits
(self
._ft
)
1906 "Could not get Floating point exponent digit count")
1910 @exponent_digits.setter
1911 def exponent_digits(self
, exponent_digits
):
1913 Set the number of exponent digits to use to store the floating point field.
1914 The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which
1915 are defined as constants of this class.
1918 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_exponent
_digits
(self
._ft
,
1922 raise ValueError("Could not set exponent digit count.")
1925 def mantissa_digits(self
):
1927 Get the number of mantissa digits used to store the floating point field.
1930 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_mantissa
_digits
(self
._ft
)
1933 raise TypeError("Could not get Floating point mantissa digit count")
1937 @mantissa_digits.setter
1938 def mantissa_digits(self
, mantissa_digits
):
1940 Set the number of mantissa digits to use to store the floating point field.
1941 The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which
1942 are defined as constants of this class.
1945 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_mantissa
_digits
(self
._ft
,
1949 raise ValueError("Could not set mantissa digit count.")
1951 class FloatingPointFieldDeclaration(FloatFieldDeclaration
):
1954 class StructureFieldDeclaration(FieldDeclaration
):
1957 Create a new structure field declaration.
1960 self
._ft
= nbt
._bt
_ctf
_field
_type
_structure
_create
()
1963 def add_field(self
, field_type
, field_name
):
1965 Add a field of type "field_type" to the structure.
1968 ret
= nbt
._bt
_ctf
_field
_type
_structure
_add
_field
(self
._ft
,
1973 raise ValueError("Could not add field to structure.")
1978 Generator returning the structure's field as tuples of (field name, field declaration).
1981 count
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_count
(self
._ft
)
1984 raise TypeError("Could not get Structure field count")
1986 for i
in range(count
):
1987 field_name
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_name
(self
._ft
, i
)
1989 if field_name
is None:
1990 msg
= "Could not get Structure field name at index {}".format(i
)
1991 raise TypeError(msg
)
1993 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_type
(self
._ft
, i
)
1995 if field_type_native
is None:
1996 msg
= "Could not get Structure field type at index {}".format(i
)
1997 raise TypeError(msg
)
1999 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2000 yield (field_name
, field_type
)
2002 def get_field_by_name(self
, name
):
2004 Get a field declaration by name (FieldDeclaration).
2007 field_type_native
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_type
_by
_name
(self
._ft
, name
)
2009 if field_type_native
is None:
2010 msg
= "Could not find Structure field with name {}".format(name
)
2011 raise TypeError(msg
)
2013 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2015 class VariantFieldDeclaration(FieldDeclaration
):
2016 def __init__(self
, enum_tag
, tag_name
):
2018 Create a new variant field declaration.
2021 isinst
= isinstance(enum_tag
, CTFWriter
.EnumerationFieldDeclaration
)
2022 if enum_tag
is None or not isinst
:
2023 raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.")
2025 self
._ft
= nbt
._bt
_ctf
_field
_type
_variant
_create
(enum_tag
._ft
,
2032 Get the variant's tag name.
2035 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_name
(self
._ft
)
2038 raise TypeError("Could not get Variant tag name")
2045 Get the variant's tag type.
2048 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_type
(self
._ft
)
2051 raise TypeError("Could not get Variant tag type")
2053 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2055 def add_field(self
, field_type
, field_name
):
2057 Add a field of type "field_type" to the variant.
2060 ret
= nbt
._bt
_ctf
_field
_type
_variant
_add
_field
(self
._ft
,
2065 raise ValueError("Could not add field to variant.")
2070 Generator returning the variant's field as tuples of (field name, field declaration).
2073 count
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_count
(self
._ft
)
2076 raise TypeError("Could not get Variant field count")
2078 for i
in range(count
):
2079 field_name
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_name
(self
._ft
, i
)
2081 if field_name
is None:
2082 msg
= "Could not get Variant field name at index {}".format(i
)
2083 raise TypeError(msg
)
2085 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_type
(self
._ft
, i
)
2087 if field_type_native
is None:
2088 msg
= "Could not get Variant field type at index {}".format(i
)
2089 raise TypeError(msg
)
2091 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2092 yield (field_name
, field_type
)
2094 def get_field_by_name(self
, name
):
2096 Get a field declaration by name (FieldDeclaration).
2099 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_by
_name
(self
._ft
,
2102 if field_type_native
is None:
2103 msg
= "Could not find Variant field with name {}".format(name
)
2104 raise TypeError(msg
)
2106 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2108 def get_field_from_tag(self
, tag
):
2110 Get a field declaration from tag (EnumerationField).
2113 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_from
_tag
(self
._ft
, tag
._f
)
2115 if field_type_native
is None:
2116 msg
= "Could not find Variant field with tag value {}".format(tag
.value
)
2117 raise TypeError(msg
)
2119 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2121 class ArrayFieldDeclaration(FieldDeclaration
):
2122 def __init__(self
, element_type
, length
):
2124 Create a new array field declaration.
2127 self
._ft
= nbt
._bt
_ctf
_field
_type
_array
_create
(element_type
._ft
,
2132 def element_type(self
):
2134 Get the array's element type.
2137 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_element
_type
(self
._ft
)
2140 raise TypeError("Could not get Array element type")
2142 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2147 Get the array's length.
2150 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_length
(self
._ft
)
2153 raise TypeError("Could not get Array length")
2157 class SequenceFieldDeclaration(FieldDeclaration
):
2158 def __init__(self
, element_type
, length_field_name
):
2160 Create a new sequence field declaration.
2163 self
._ft
= nbt
._bt
_ctf
_field
_type
_sequence
_create
(element_type
._ft
,
2164 str(length_field_name
))
2168 def element_type(self
):
2170 Get the sequence's element type.
2173 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_element
_type
(self
._ft
)
2176 raise TypeError("Could not get Sequence element type")
2178 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
2181 def length_field_name(self
):
2183 Get the sequence's length field name.
2186 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_length
_field
_name
(self
._ft
)
2189 raise TypeError("Could not get Sequence length field name")
2193 class StringFieldDeclaration(FieldDeclaration
):
2196 Create a new string field declaration.
2199 self
._ft
= nbt
._bt
_ctf
_field
_type
_string
_create
()
2205 Get a string declaration's encoding (a constant from the CTFStringEncoding class).
2208 return nbt
._bt
_ctf
_field
_type
_string
_get
_encoding
(self
._ft
)
2211 def encoding(self
, encoding
):
2213 Set a string declaration's encoding. Must be a constant from the CTFStringEncoding class.
2216 ret
= nbt
._bt
_ctf
_field
_type
_string
_set
_encoding
(self
._ft
, encoding
)
2218 raise ValueError("Could not set string encoding.")
2221 def create_field(field_type
):
2223 Create an instance of a field.
2225 isinst
= isinstance(field_type
, CTFWriter
.FieldDeclaration
)
2227 if field_type
is None or not isinst
:
2228 raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.")
2230 if isinstance(field_type
, CTFWriter
.IntegerFieldDeclaration
):
2231 return CTFWriter
.IntegerField(field_type
)
2232 elif isinstance(field_type
, CTFWriter
.EnumerationFieldDeclaration
):
2233 return CTFWriter
.EnumerationField(field_type
)
2234 elif isinstance(field_type
, CTFWriter
.FloatFieldDeclaration
):
2235 return CTFWriter
.FloatingPointField(field_type
)
2236 elif isinstance(field_type
, CTFWriter
.StructureFieldDeclaration
):
2237 return CTFWriter
.StructureField(field_type
)
2238 elif isinstance(field_type
, CTFWriter
.VariantFieldDeclaration
):
2239 return CTFWriter
.VariantField(field_type
)
2240 elif isinstance(field_type
, CTFWriter
.ArrayFieldDeclaration
):
2241 return CTFWriter
.ArrayField(field_type
)
2242 elif isinstance(field_type
, CTFWriter
.SequenceFieldDeclaration
):
2243 return CTFWriter
.SequenceField(field_type
)
2244 elif isinstance(field_type
, CTFWriter
.StringFieldDeclaration
):
2245 return CTFWriter
.StringField(field_type
)
2249 Base class, do not instantiate.
2252 def __init__(self
, field_type
):
2253 if not isinstance(field_type
, CTFWriter
.FieldDeclaration
):
2254 raise TypeError("Invalid field_type argument.")
2256 self
._f
= nbt
._bt
_ctf
_field
_create
(field_type
._ft
)
2259 raise ValueError("Field creation failed.")
2262 nbt
._bt
_ctf
_field
_put
(self
._f
)
2265 def _create_field_from_native_instance(native_field_instance
):
2267 CTFTypeId
.INTEGER
: CTFWriter
.IntegerField
,
2268 CTFTypeId
.FLOAT
: CTFWriter
.FloatingPointField
,
2269 CTFTypeId
.ENUM
: CTFWriter
.EnumerationField
,
2270 CTFTypeId
.STRING
: CTFWriter
.StringField
,
2271 CTFTypeId
.STRUCT
: CTFWriter
.StructureField
,
2272 CTFTypeId
.VARIANT
: CTFWriter
.VariantField
,
2273 CTFTypeId
.ARRAY
: CTFWriter
.ArrayField
,
2274 CTFTypeId
.SEQUENCE
: CTFWriter
.SequenceField
2277 field_type
= nbt
._bt
_python
_get
_field
_type
(native_field_instance
)
2279 if field_type
== CTFTypeId
.UNKNOWN
:
2280 raise TypeError("Invalid field instance")
2282 field
= CTFWriter
.Field
.__new
__(CTFWriter
.Field
)
2283 field
._f
= native_field_instance
2284 field
.__class
__ = type_dict
[field_type
]
2289 def declaration(self
):
2290 native_field_type
= nbt
._bt
_ctf
_field
_get
_type
(self
._f
)
2292 if native_field_type
is None:
2293 raise TypeError("Invalid field instance")
2294 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(
2297 class IntegerField(Field
):
2301 Get an integer field's value.
2304 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
2307 raise TypeError("Invalid integer instance.")
2310 ret
, value
= nbt
._bt
_ctf
_field
_unsigned
_integer
_get
_value
(self
._f
)
2312 ret
, value
= nbt
._bt
_ctf
_field
_signed
_integer
_get
_value
(self
._f
)
2315 raise ValueError("Could not get integer field value.")
2320 def value(self
, value
):
2322 Set an integer field's value.
2325 if not isinstance(value
, int):
2326 raise TypeError("IntegerField's value must be an int")
2328 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
2330 raise TypeError("Invalid integer instance.")
2333 ret
= nbt
._bt
_ctf
_field
_unsigned
_integer
_set
_value
(self
._f
, value
)
2335 ret
= nbt
._bt
_ctf
_field
_signed
_integer
_set
_value
(self
._f
, value
)
2338 raise ValueError("Could not set integer field value.")
2340 class EnumerationField(Field
):
2342 def container(self
):
2344 Return the enumeration's underlying container field (an integer field).
2347 container
= CTFWriter
.IntegerField
.__new
__(CTFWriter
.IntegerField
)
2348 container
._f
= nbt
._bt
_ctf
_field
_enumeration
_get
_container
(self
._f
)
2350 if container
._f
is None:
2351 raise TypeError("Invalid enumeration field type.")
2358 Get the enumeration field's mapping name.
2361 value
= nbt
._bt
_ctf
_field
_enumeration
_get
_mapping
_name
(self
._f
)
2364 raise ValueError("Could not get enumeration's mapping name.")
2369 def value(self
, value
):
2371 Set the enumeration field's value. Must be an integer as mapping names
2375 if not isinstance(value
, int):
2376 raise TypeError("EnumerationField value must be an int")
2378 self
.container
.value
= value
2380 class FloatingPointField(Field
):
2384 Get a floating point field's value.
2387 ret
, value
= nbt
._bt
_ctf
_field
_floating
_point
_get
_value
(self
._f
)
2390 raise ValueError("Could not get floating point field value.")
2395 def value(self
, value
):
2397 Set a floating point field's value.
2400 if not isinstance(value
, int) and not isinstance(value
, float):
2401 raise TypeError("Value must be either a float or an int")
2403 ret
= nbt
._bt
_ctf
_field
_floating
_point
_set
_value
(self
._f
, float(value
))
2406 raise ValueError("Could not set floating point field value.")
2408 # oops!! This class is provided to ensure backward-compatibility since
2409 # a stable release publicly exposed this abomination.
2410 class FloatFieldingPoint(FloatingPointField
):
2413 class StructureField(Field
):
2414 def field(self
, field_name
):
2416 Get the structure's field corresponding to the provided field name.
2419 native_instance
= nbt
._bt
_ctf
_field
_structure
_get
_field
(self
._f
,
2422 if native_instance
is None:
2423 raise ValueError("Invalid field_name provided.")
2425 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2427 class VariantField(Field
):
2428 def field(self
, tag
):
2430 Return the variant's selected field. The "tag" field is the selector enum field.
2433 native_instance
= nbt
._bt
_ctf
_field
_variant
_get
_field
(self
._f
, tag
._f
)
2435 if native_instance
is None:
2436 raise ValueError("Invalid tag provided.")
2438 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2440 class ArrayField(Field
):
2441 def field(self
, index
):
2443 Return the array's field at position "index".
2446 native_instance
= nbt
._bt
_ctf
_field
_array
_get
_field
(self
._f
, index
)
2448 if native_instance
is None:
2449 raise IndexError("Invalid index provided.")
2451 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2453 class SequenceField(Field
):
2457 Get the sequence's length field (IntegerField).
2460 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_length
(self
._f
)
2462 if native_instance
is None:
2465 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2468 def length(self
, length_field
):
2470 Set the sequence's length field (IntegerField).
2473 if not isinstance(length_field
, CTFWriter
.IntegerField
):
2474 raise TypeError("Invalid length field.")
2476 if length_field
.declaration
.signed
:
2477 raise TypeError("Sequence field length must be unsigned")
2479 ret
= nbt
._bt
_ctf
_field
_sequence
_set
_length
(self
._f
, length_field
._f
)
2482 raise ValueError("Could not set sequence length.")
2484 def field(self
, index
):
2486 Return the sequence's field at position "index".
2489 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_field
(self
._f
, index
)
2491 if native_instance
is None:
2492 raise ValueError("Could not get sequence element at index.")
2494 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2496 class StringField(Field
):
2500 Get a string field's value.
2503 return nbt
._bt
_ctf
_field
_string
_get
_value
(self
._f
)
2506 def value(self
, value
):
2508 Set a string field's value.
2511 ret
= nbt
._bt
_ctf
_field
_string
_set
_value
(self
._f
, str(value
))
2514 raise ValueError("Could not set string field value.")
2517 def __init__(self
, name
):
2519 Create a new event class of the given name.
2522 self
._ec
= nbt
._bt
_ctf
_event
_class
_create
(name
)
2524 if self
._ec
is None:
2525 raise ValueError("Event class creation failed.")
2528 nbt
._bt
_ctf
_event
_class
_put
(self
._ec
)
2530 def add_field(self
, field_type
, field_name
):
2532 Add a field of type "field_type" to the event class.
2535 ret
= nbt
._bt
_ctf
_event
_class
_add
_field
(self
._ec
, field_type
._ft
,
2539 raise ValueError("Could not add field to event class.")
2544 Get the event class' name.
2547 name
= nbt
._bt
_ctf
_event
_class
_get
_name
(self
._ec
)
2550 raise TypeError("Could not get EventClass name")
2557 Get the event class' id. Returns a negative value if unset.
2560 id = nbt
._bt
_ctf
_event
_class
_get
_id
(self
._ec
)
2563 raise TypeError("Could not get EventClass id")
2570 Set the event class' id. Throws a TypeError if the event class
2571 is already registered to a stream class.
2574 ret
= nbt
._bt
_ctf
_event
_class
_set
_id
(self
._ec
, id)
2577 raise TypeError("Can't change an Event Class's id after it has been assigned to a stream class")
2580 def stream_class(self
):
2582 Get the event class' stream class. Returns None if unset.
2584 stream_class_native
= nbt
._bt
_ctf
_event
_class
_get
_stream
_class
(self
._ec
)
2586 if stream_class_native
is None:
2589 stream_class
= CTFWriter
.StreamClass
.__new
__(CTFWriter
.StreamClass
)
2590 stream_class
._sc
= stream_class_native
2597 Generator returning the event class' fields as tuples of (field name, field declaration).
2600 count
= nbt
._bt
_ctf
_event
_class
_get
_field
_count
(self
._ec
)
2603 raise TypeError("Could not get EventClass' field count")
2605 for i
in range(count
):
2606 field_name
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_name
(self
._ec
, i
)
2608 if field_name
is None:
2609 msg
= "Could not get EventClass' field name at index {}".format(i
)
2610 raise TypeError(msg
)
2612 field_type_native
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_type
(self
._ec
, i
)
2614 if field_type_native
is None:
2615 msg
= "Could not get EventClass' field type at index {}".format(i
)
2616 raise TypeError(msg
)
2618 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2619 yield (field_name
, field_type
)
2621 def get_field_by_name(self
, name
):
2623 Get a field declaration by name (FieldDeclaration).
2626 field_type_native
= nbt
._bt
_ctf
_event
_class
_get
_field
_by
_name
(self
._ec
, name
)
2628 if field_type_native
is None:
2629 msg
= "Could not find EventClass field with name {}".format(name
)
2630 raise TypeError(msg
)
2632 return CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2635 def __init__(self
, event_class
):
2637 Create a new event of the given event class.
2640 if not isinstance(event_class
, CTFWriter
.EventClass
):
2641 raise TypeError("Invalid event_class argument.")
2643 self
._e
= nbt
._bt
_ctf
_event
_create
(event_class
._ec
)
2646 raise ValueError("Event creation failed.")
2649 nbt
._bt
_ctf
_event
_put
(self
._e
)
2652 def event_class(self
):
2654 Get the event's class.
2657 event_class_native
= nbt
._bt
_ctf
_event
_get
_class
(self
._e
)
2659 if event_class_native
is None:
2662 event_class
= CTFWriter
.EventClass
.__new
__(CTFWriter
.EventClass
)
2663 event_class
._ec
= event_class_native
2669 Get a clock from event. Returns None if the event's class
2670 is not registered to a stream class.
2673 clock_instance
= nbt
._bt
_ctf
_event
_get
_clock
(self
._e
)
2675 if clock_instance
is None:
2678 clock
= CTFWriter
.Clock
.__new
__(CTFWriter
.Clock
)
2679 clock
._c
= clock_instance
2683 def payload(self
, field_name
):
2685 Get a field from event.
2688 native_instance
= nbt
._bt
_ctf
_event
_get
_payload
(self
._e
,
2691 if native_instance
is None:
2692 raise ValueError("Could not get event payload.")
2694 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_instance
)
2696 def set_payload(self
, field_name
, value_field
):
2698 Set a manually created field as an event's payload.
2701 if not isinstance(value
, CTFWriter
.Field
):
2702 raise TypeError("Invalid value type.")
2704 ret
= nbt
._bt
_ctf
_event
_set
_payload
(self
._e
, str(field_name
),
2708 raise ValueError("Could not set event field payload.")
2711 def __init__(self
, name
):
2713 Create a new stream class of the given name.
2716 self
._sc
= nbt
._bt
_ctf
_stream
_class
_create
(name
)
2718 if self
._sc
is None:
2719 raise ValueError("Stream class creation failed.")
2722 nbt
._bt
_ctf
_stream
_class
_put
(self
._sc
)
2727 Get a stream class' name.
2730 name
= nbt
._bt
_ctf
_stream
_class
_get
_name
(self
._sc
)
2733 raise TypeError("Could not get StreamClass name")
2740 Get a stream class' clock.
2743 clock_instance
= nbt
._bt
_ctf
_stream
_class
_get
_clock
(self
._sc
)
2745 if clock_instance
is None:
2748 clock
= CTFWriter
.Clock
.__new
__(CTFWriter
.Clock
)
2749 clock
._c
= clock_instance
2754 def clock(self
, clock
):
2756 Assign a clock to a stream class.
2759 if not isinstance(clock
, CTFWriter
.Clock
):
2760 raise TypeError("Invalid clock type.")
2762 ret
= nbt
._bt
_ctf
_stream
_class
_set
_clock
(self
._sc
, clock
._c
)
2765 raise ValueError("Could not set stream class clock.")
2770 Get a stream class' id.
2773 ret
= nbt
._bt
_ctf
_stream
_class
_get
_id
(self
._sc
)
2776 raise TypeError("Could not get StreamClass id")
2783 Assign an id to a stream class.
2786 ret
= nbt
._bt
_ctf
_stream
_class
_set
_id
(self
._sc
, id)
2789 raise TypeError("Could not set stream class id.")
2792 def event_classes(self
):
2794 Generator returning the stream class' event classes.
2797 count
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
_count
(self
._sc
)
2800 raise TypeError("Could not get StreamClass' event class count")
2802 for i
in range(count
):
2803 event_class_native
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
(self
._sc
, i
)
2805 if event_class_native
is None:
2806 msg
= "Could not get StreamClass' event class at index {}".format(i
)
2807 raise TypeError(msg
)
2809 event_class
= CTFWriter
.EventClass
.__new
__(CTFWriter
.EventClass
)
2810 event_class
._ec
= event_class_native
2813 def add_event_class(self
, event_class
):
2815 Add an event class to a stream class. New events can be added even after a
2816 stream has been instantiated and events have been appended. However, a stream
2817 will not accept events of a class that has not been added to the stream
2821 if not isinstance(event_class
, CTFWriter
.EventClass
):
2822 raise TypeError("Invalid event_class type.")
2824 ret
= nbt
._bt
_ctf
_stream
_class
_add
_event
_class
(self
._sc
,
2828 raise ValueError("Could not add event class.")
2831 def packet_context_type(self
):
2833 Get the StreamClass' packet context type (StructureFieldDeclaration)
2836 field_type_native
= nbt
._bt
_ctf
_stream
_class
_get
_packet
_context
_type
(self
._sc
)
2838 if field_type_native
is None:
2839 raise ValueError("Invalid StreamClass")
2841 field_type
= CTFWriter
.FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
2845 @packet_context_type.setter
2846 def packet_context_type(self
, field_type
):
2848 Set a StreamClass' packet context type. Must be of type
2849 StructureFieldDeclaration.
2852 if not isinstance(field_type
, CTFWriter
.StructureFieldDeclaration
):
2853 raise TypeError("field_type argument must be of type StructureFieldDeclaration.")
2855 ret
= nbt
._bt
_ctf
_stream
_class
_set
_packet
_context
_type
(self
._sc
,
2859 raise ValueError("Failed to set packet context type.")
2863 raise NotImplementedError("Stream cannot be instantiated; use Writer.create_stream()")
2866 nbt
._bt
_ctf
_stream
_put
(self
._s
)
2869 def discarded_events(self
):
2871 Get a stream's discarded event count.
2874 ret
, count
= nbt
._bt
_ctf
_stream
_get
_discarded
_events
_count
(self
._s
)
2877 raise ValueError("Could not get the stream's discarded events count")
2881 def append_discarded_events(self
, event_count
):
2883 Increase the current packet's discarded event count.
2886 nbt
._bt
_ctf
_stream
_append
_discarded
_events
(self
._s
, event_count
)
2888 def append_event(self
, event
):
2890 Append "event" to the stream's current packet. The stream's associated clock
2891 will be sampled during this call. The event shall not be modified after
2892 being appended to a stream.
2895 ret
= nbt
._bt
_ctf
_stream
_append
_event
(self
._s
, event
._e
)
2898 raise ValueError("Could not append event to stream.")
2901 def packet_context(self
):
2903 Get a Stream's packet context field (a StructureField).
2906 native_field
= nbt
._bt
_ctf
_stream
_get
_packet
_context
(self
._s
)
2908 if native_field
is None:
2909 raise ValueError("Invalid Stream.")
2911 return CTFWriter
.Field
._create
_field
_from
_native
_instance
(native_field
)
2913 @packet_context.setter
2914 def packet_context(self
, field
):
2916 Set a Stream's packet context field (must be a StructureField).
2919 if not isinstance(field
, CTFWriter
.StructureField
):
2920 raise TypeError("Argument field must be of type StructureField")
2922 ret
= nbt
._bt
_ctf
_stream
_set
_packet
_context
(self
._s
, field
._f
)
2925 raise ValueError("Invalid packet context field.")
2929 The stream's current packet's events will be flushed to disk. Events
2930 subsequently appended to the stream will be added to a new packet.
2933 ret
= nbt
._bt
_ctf
_stream
_flush
(self
._s
)
2936 raise ValueError("Could not flush stream.")
2939 def __init__(self
, path
):
2941 Create a new writer that will produce a trace in the given path.
2944 self
._w
= nbt
._bt
_ctf
_writer
_create
(path
)
2947 raise ValueError("Writer creation failed.")
2950 nbt
._bt
_ctf
_writer
_put
(self
._w
)
2952 def create_stream(self
, stream_class
):
2954 Create a new stream instance and register it to the writer.
2957 if not isinstance(stream_class
, CTFWriter
.StreamClass
):
2958 raise TypeError("Invalid stream_class type.")
2960 stream
= CTFWriter
.Stream
.__new
__(CTFWriter
.Stream
)
2961 stream
._s
= nbt
._bt
_ctf
_writer
_create
_stream
(self
._w
, stream_class
._sc
)
2965 def add_environment_field(self
, name
, value
):
2967 Add an environment field to the trace.
2970 ret
= nbt
._bt
_ctf
_writer
_add
_environment
_field
(self
._w
, str(name
),
2974 raise ValueError("Could not add environment field to trace.")
2976 def add_clock(self
, clock
):
2978 Add a clock to the trace. Clocks assigned to stream classes must be
2979 registered to the writer.
2982 ret
= nbt
._bt
_ctf
_writer
_add
_clock
(self
._w
, clock
._c
)
2985 raise ValueError("Could not add clock to Writer.")
2990 Get the trace's TSDL meta-data.
2993 return nbt
._bt
_ctf
_writer
_get
_metadata
_string
(self
._w
)
2995 def flush_metadata(self
):
2997 Flush the trace's metadata to the metadata file.
3000 nbt
._bt
_ctf
_writer
_flush
_metadata
(self
._w
)
3003 def byte_order(self
):
3005 Get the trace's byte order. Must be a constant from the ByteOrder
3009 raise NotImplementedError("Getter not implemented.")
3012 def byte_order(self
, byte_order
):
3014 Set the trace's byte order. Must be a constant from the ByteOrder
3015 class. Defaults to the host machine's endianness
3018 ret
= nbt
._bt
_ctf
_writer
_set
_byte
_order
(self
._w
, byte_order
)
3021 raise ValueError("Could not set trace's byte order.")