3 # Babeltrace writer interface Python module
5 # Copyright 2012-2015 EfficiOS Inc.
7 # Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 # Permission is hereby granted, free of charge, to any person obtaining a copy
10 # of this software and associated documentation files (the "Software"), to deal
11 # in the Software without restriction, including without limitation the rights
12 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 # copies of the Software, and to permit persons to whom the Software is
14 # furnished to do so, subject to the following conditions:
16 # The above copyright notice and this permission notice shall be included in
17 # all copies or substantial portions of the Software.
19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 import babeltrace
.nativebt
as nbt
28 import babeltrace
.common
as common
32 # Used to compare to -1ULL in error checks
33 _MAX_UINT64
= 0xFFFFFFFFFFFFFFFF
36 class EnumerationMapping
:
38 Mapping from an enumeration label to a range of integers.
41 def __init__(self
, name
, start
, end
):
43 Creates an enumeration mapping, where label *name* is mapped to
44 the [*start*, *end*] range of integers (*end* is included).
46 Set *start* and *end* to the same value to create an enumeration
47 mapping to a single value.
57 A CTF clock allows the description of the system's clock topology, as
58 well as the definition of each clock's parameters.
60 :class:`Clock` objects must be registered to a :class:`Writer`
61 object (see :meth:`Writer.add_clock`), as well as be registered to
62 a :class:`StreamClass` object (see :attr:`StreamClass.clock`).
65 def __init__(self
, name
):
67 Creates a default CTF clock named *name*.
69 :exc:`ValueError` is raised on error.
72 self
._c
= nbt
._bt
_ctf
_clock
_create
(name
)
75 raise ValueError("Invalid clock name.")
78 nbt
._bt
_ctf
_clock
_put
(self
._c
)
85 Set this attribute to change the clock's name.
87 :exc:`ValueError` is raised on error.
90 name
= nbt
._bt
_ctf
_clock
_get
_name
(self
._c
)
93 raise ValueError("Invalid clock instance.")
98 def description(self
):
100 Clock description (string).
102 Set this attribute to change the clock's description.
104 :exc:`ValueError` is raised on error.
107 return nbt
._bt
_ctf
_clock
_get
_description
(self
._c
)
110 def description(self
, desc
):
111 ret
= nbt
._bt
_ctf
_clock
_set
_description
(self
._c
, str(desc
))
114 raise ValueError("Invalid clock description.")
119 Clock frequency in Hz (integer).
121 Set this attribute to change the clock's frequency.
123 :exc:`ValueError` is raised on error.
126 freq
= nbt
._bt
_ctf
_clock
_get
_frequency
(self
._c
)
128 if freq
== _MAX_UINT64
:
129 raise ValueError("Invalid clock instance")
134 def frequency(self
, freq
):
135 ret
= nbt
._bt
_ctf
_clock
_set
_frequency
(self
._c
, freq
)
138 raise ValueError("Invalid frequency value.")
143 Clock precision in clock ticks (integer).
145 Set this attribute to change the clock's precision.
147 :exc:`ValueError` is raised on error.
150 precision
= nbt
._bt
_ctf
_clock
_get
_precision
(self
._c
)
152 if precision
== _MAX_UINT64
:
153 raise ValueError("Invalid clock instance")
158 def precision(self
, precision
):
159 ret
= nbt
._bt
_ctf
_clock
_set
_precision
(self
._c
, precision
)
162 def offset_seconds(self
):
164 Clock offset in seconds since POSIX.1 Epoch (integer).
166 Set this attribute to change the clock's offset in seconds.
168 :exc:`ValueError` is raised on error.
171 offset_s
= nbt
._bt
_ctf
_clock
_get
_offset
_s
(self
._c
)
173 if offset_s
== _MAX_UINT64
:
174 raise ValueError("Invalid clock instance")
178 @offset_seconds.setter
179 def offset_seconds(self
, offset_s
):
180 ret
= nbt
._bt
_ctf
_clock
_set
_offset
_s
(self
._c
, offset_s
)
183 raise ValueError("Invalid offset value.")
188 Clock offset in ticks since (POSIX.1 Epoch +
189 :attr:`offset_seconds`).
191 Set this attribute to change the clock's offset.
193 :exc:`ValueError` is raised on error.
196 offset
= nbt
._bt
_ctf
_clock
_get
_offset
(self
._c
)
198 if offset
== _MAX_UINT64
:
199 raise ValueError("Invalid clock instance")
204 def offset(self
, offset
):
205 ret
= nbt
._bt
_ctf
_clock
_set
_offset
(self
._c
, offset
)
208 raise ValueError("Invalid offset value.")
213 ``True`` if this clock is absolute, i.e. if the clock is a
214 global reference across the other clocks of the trace.
216 Set this attribute to change the clock's absolute state
219 :exc:`ValueError` is raised on error.
222 is_absolute
= nbt
._bt
_ctf
_clock
_get
_is
_absolute
(self
._c
)
224 if is_absolute
== -1:
225 raise ValueError("Invalid clock instance")
227 return False if is_absolute
== 0 else True
230 def absolute(self
, is_absolute
):
231 ret
= nbt
._bt
_ctf
_clock
_set
_is
_absolute
(self
._c
, int(is_absolute
))
234 raise ValueError("Could not set the clock absolute attribute.")
239 Clock UUID (an :class:`uuid.UUID` object).
241 Set this attribute to change the clock's UUID.
243 :exc:`ValueError` is raised on error.
249 ret
, value
= nbt
._bt
_python
_ctf
_clock
_get
_uuid
_index
(self
._c
, i
)
252 raise ValueError("Invalid clock instance")
254 uuid_list
.append(value
)
256 return UUID(bytes
=bytes(uuid_list
))
259 def uuid(self
, uuid
):
260 uuid_bytes
= uuid
.bytes
262 if len(uuid_bytes
) != 16:
263 raise ValueError("Invalid UUID provided. UUID length must be 16 bytes")
265 for i
in range(len(uuid_bytes
)):
266 ret
= nbt
._bt
_python
_ctf
_clock
_set
_uuid
_index
(self
._c
, i
,
270 raise ValueError("Invalid clock instance")
275 Clock current time; nanoseconds (integer) since clock origin
276 (POSIX.1 Epoch + :attr:`offset_seconds` + :attr:`offset`).
278 Set this attribute to change the clock's current time.
280 :exc:`ValueError` is raised on error.
283 time
= nbt
._bt
_ctf
_clock
_get
_time
(self
._c
)
285 if time
== _MAX_UINT64
:
286 raise ValueError("Invalid clock instance")
291 def time(self
, time
):
292 ret
= nbt
._bt
_ctf
_clock
_set
_time
(self
._c
, time
)
295 raise ValueError("Invalid time value.")
300 Display base of an integer.
304 INTEGER_BASE_UNKNOWN
= -1
307 INTEGER_BASE_BINARY
= 2
310 INTEGER_BASE_OCTAL
= 8
313 INTEGER_BASE_DECIMAL
= 10
316 INTEGER_BASE_HEXADECIMAL
= 16
319 class FieldDeclaration
:
321 Base class of all field declarations. This class is not meant to
322 be instantiated by the user; use one of the concrete field
323 declaration subclasses instead.
326 class IntegerBase(IntegerBase
):
331 raise ValueError("FieldDeclaration creation failed.")
334 nbt
._bt
_ctf
_field
_type
_put
(self
._ft
)
337 def _create_field_declaration_from_native_instance(
338 native_field_declaration
):
340 common
.CTFTypeId
.INTEGER
: IntegerFieldDeclaration
,
341 common
.CTFTypeId
.FLOAT
: FloatFieldDeclaration
,
342 common
.CTFTypeId
.ENUM
: EnumerationFieldDeclaration
,
343 common
.CTFTypeId
.STRING
: StringFieldDeclaration
,
344 common
.CTFTypeId
.STRUCT
: StructureFieldDeclaration
,
345 common
.CTFTypeId
.VARIANT
: VariantFieldDeclaration
,
346 common
.CTFTypeId
.ARRAY
: ArrayFieldDeclaration
,
347 common
.CTFTypeId
.SEQUENCE
: SequenceFieldDeclaration
350 field_type_id
= nbt
._bt
_ctf
_field
_type
_get
_type
_id
(native_field_declaration
)
352 if field_type_id
== common
.CTFTypeId
.UNKNOWN
:
353 raise TypeError("Invalid field instance")
355 declaration
= Field
.__new
__(Field
)
356 declaration
._ft
= native_field_declaration
357 declaration
.__class
__ = type_dict
[field_type_id
]
364 Field alignment in bits (integer).
366 Set this attribute to change this field's alignment.
368 :exc:`ValueError` is raised on error.
371 return nbt
._bt
_ctf
_field
_type
_get
_alignment
(self
._ft
)
374 def alignment(self
, alignment
):
375 ret
= nbt
._bt
_ctf
_field
_type
_set
_alignment
(self
._ft
, alignment
)
378 raise ValueError("Invalid alignment value.")
381 def byte_order(self
):
383 Field byte order (one of :class:`babeltrace.common.ByteOrder`
386 Set this attribute to change this field's byte order.
388 :exc:`ValueError` is raised on error.
391 return nbt
._bt
_ctf
_field
_type
_get
_byte
_order
(self
._ft
)
394 def byte_order(self
, byte_order
):
395 ret
= nbt
._bt
_ctf
_field
_type
_set
_byte
_order
(self
._ft
, byte_order
)
398 raise ValueError("Could not set byte order value.")
401 class IntegerFieldDeclaration(FieldDeclaration
):
403 Integer field declaration.
406 def __init__(self
, size
):
408 Creates an integer field declaration of size *size* bits.
410 :exc:`ValueError` is raised on error.
413 self
._ft
= nbt
._bt
_ctf
_field
_type
_integer
_create
(size
)
419 Integer size in bits (integer).
421 Set this attribute to change this integer's size.
423 :exc:`ValueError` is raised on error.
426 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_size
(self
._ft
)
429 raise ValueError("Could not get Integer size attribute.")
436 ``True`` if this integer is signed.
438 Set this attribute to change this integer's signedness
441 :exc:`ValueError` is raised on error.
444 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_signed
(self
._ft
)
447 raise ValueError("Could not get Integer signed attribute.")
454 def signed(self
, signed
):
455 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_signed
(self
._ft
, signed
)
458 raise ValueError("Could not set Integer signed attribute.")
463 Integer display base (one of :class:`IntegerBase` constants).
465 Set this attribute to change this integer's display base.
467 :exc:`ValueError` is raised on error.
470 return nbt
._bt
_ctf
_field
_type
_integer
_get
_base
(self
._ft
)
473 def base(self
, base
):
474 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_base
(self
._ft
, base
)
477 raise ValueError("Could not set Integer base.")
482 Integer encoding (one of
483 :class:`babeltrace.common.CTFStringEncoding` constants).
485 Set this attribute to change this integer's encoding.
487 :exc:`ValueError` is raised on error.
490 return nbt
._bt
_ctf
_field
_type
_integer
_get
_encoding
(self
._ft
)
493 def encoding(self
, encoding
):
494 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_encoding
(self
._ft
, encoding
)
497 raise ValueError("Could not set Integer encoding.")
500 class EnumerationFieldDeclaration(FieldDeclaration
):
502 Enumeration field declaration. A CTF enumeration maps labels to
506 def __init__(self
, integer_type
):
508 Creates an enumeration field declaration, with *integer_type*
509 being the underlying :class:`IntegerFieldDeclaration` for storing
512 :exc:`ValueError` is raised on error.
515 isinst
= isinstance(integer_type
, IntegerFieldDeclaration
)
517 if integer_type
is None or not isinst
:
518 raise TypeError("Invalid integer container.")
520 self
._ft
= nbt
._bt
_ctf
_field
_type
_enumeration
_create
(integer_type
._ft
)
526 Underlying container (:class:`IntegerFieldDeclaration`).
528 :exc:`TypeError` is raised on error.
531 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_container
_type
(self
._ft
)
534 raise TypeError("Invalid enumeration declaration")
536 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
538 def add_mapping(self
, name
, range_start
, range_end
):
540 Adds a mapping to the enumeration field declaration, from the
541 label named *name* to range [*range_start*, *range_end*], where
542 *range_start* and *range_end* are integers included in the
545 :exc:`ValueError` is raised on error.
548 if range_start
< 0 or range_end
< 0:
549 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
(self
._ft
,
554 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
_unsigned
(self
._ft
,
560 raise ValueError("Could not add mapping to enumeration declaration.")
565 Generates the mappings of this enumeration field declaration
566 (:class:`EnumerationMapping` objects).
568 :exc:`TypeError` is raised on error.
571 signed
= self
.container
.signed
573 count
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_count
(self
._ft
)
575 for i
in range(count
):
577 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, i
)
579 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, i
)
582 msg
= "Could not get Enumeration mapping at index {}".format(i
)
585 name
, range_start
, range_end
= ret
586 yield EnumerationMapping(name
, range_start
, range_end
)
588 def get_mapping_by_name(self
, name
):
590 Returns the :class:`EnumerationMapping` object for the label
593 :exc:`TypeError` is raised on error.
596 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_name
(self
._ft
, name
)
601 if self
.container
.signed
:
602 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
604 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
607 msg
= "Could not get Enumeration mapping at index {}".format(i
)
610 name
, range_start
, range_end
= ret
612 return EnumerationMapping(name
, range_start
, range_end
)
614 def get_mapping_by_value(self
, value
):
616 Returns the :class:`EnumerationMapping` object for the value
619 :exc:`TypeError` is raised on error.
623 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_value
(self
._ft
, value
)
625 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_unsigned
_value
(self
._ft
, value
)
630 if self
.container
.signed
:
631 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
633 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
636 msg
= "Could not get Enumeration mapping at index {}".format(i
)
639 name
, range_start
, range_end
= ret
641 return EnumerationMapping(name
, range_start
, range_end
)
644 class FloatingPointFieldDeclaration(FieldDeclaration
):
646 Floating point number field declaration.
648 A CTF floating point number is a made of three sections: the sign
649 bit, the exponent bits, and the mantissa bits. The most significant
650 bit of the resulting binary word is the sign bit, and is included
651 in the number of mantissa bits.
654 `IEEE 754 <http://en.wikipedia.org/wiki/IEEE_floating_point>`_
655 single precision floating point number is represented on a 32-bit
656 word using an 8-bit exponent (``e``) and a 24-bit mantissa (``m``),
657 the latter count including the sign bit (``s``)::
659 s eeeeeeee mmmmmmmmmmmmmmmmmmmmmmm
661 The IEEE 754 double precision floating point number uses an
662 11-bit exponent and a 53-bit mantissa.
665 #: IEEE 754 single precision floating point number exponent size
668 #: IEEE 754 double precision floating point number exponent size
671 #: IEEE 754 single precision floating point number mantissa size
674 #: IEEE 754 double precision floating point number mantissa size
679 Creates a floating point number field declaration.
681 :exc:`ValueError` is raised on error.
684 self
._ft
= nbt
._bt
_ctf
_field
_type
_floating
_point
_create
()
688 def exponent_digits(self
):
690 Floating point number exponent section size in bits (integer).
692 Set this attribute to change the floating point number's
693 exponent section's size. You may use :attr:`FLT_EXP_DIG` or
694 :attr:`DBL_EXP_DIG` for IEEE 754 floating point numbers.
696 :exc:`ValueError` is raised on error.
699 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_exponent
_digits
(self
._ft
)
703 "Could not get Floating point exponent digit count")
707 @exponent_digits.setter
708 def exponent_digits(self
, exponent_digits
):
709 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_exponent
_digits
(self
._ft
,
713 raise ValueError("Could not set exponent digit count.")
716 def mantissa_digits(self
):
718 Floating point number mantissa section size in bits (integer).
720 Set this attribute to change the floating point number's
721 mantissa section's size. You may use :attr:`FLT_MANT_DIG` or
722 :attr:`DBL_MANT_DIG` for IEEE 754 floating point numbers.
724 :exc:`ValueError` is raised on error.
727 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_mantissa
_digits
(self
._ft
)
730 raise TypeError("Could not get Floating point mantissa digit count")
734 @mantissa_digits.setter
735 def mantissa_digits(self
, mantissa_digits
):
736 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_mantissa
_digits
(self
._ft
,
740 raise ValueError("Could not set mantissa digit count.")
743 class FloatFieldDeclaration(FloatingPointFieldDeclaration
):
747 class StructureFieldDeclaration(FieldDeclaration
):
749 Structure field declaration, i.e. an ordered mapping from field
750 names to field declarations.
755 Creates an empty structure field declaration.
757 :exc:`ValueError` is raised on error.
760 self
._ft
= nbt
._bt
_ctf
_field
_type
_structure
_create
()
763 def add_field(self
, field_type
, field_name
):
765 Appends one :class:`FieldDeclaration` *field_type* named
766 *field_name* to the structure's ordered map.
768 :exc:`ValueError` is raised on error.
771 ret
= nbt
._bt
_ctf
_field
_type
_structure
_add
_field
(self
._ft
,
776 raise ValueError("Could not add field to structure.")
781 Generates the (field name, :class:`FieldDeclaration`) pairs
784 :exc:`TypeError` is raised on error.
787 count
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_count
(self
._ft
)
790 raise TypeError("Could not get Structure field count")
792 for i
in range(count
):
793 field_name
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_name
(self
._ft
, i
)
795 if field_name
is None:
796 msg
= "Could not get Structure field name at index {}".format(i
)
799 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_type
(self
._ft
, i
)
801 if field_type_native
is None:
802 msg
= "Could not get Structure field type at index {}".format(i
)
805 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
806 yield (field_name
, field_type
)
808 def get_field_by_name(self
, name
):
810 Returns the :class:`FieldDeclaration` mapped to the field name
811 *name* in this structure.
813 :exc:`TypeError` is raised on error.
816 field_type_native
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_type
_by
_name
(self
._ft
, name
)
818 if field_type_native
is None:
819 msg
= "Could not find Structure field with name {}".format(name
)
822 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
825 class VariantFieldDeclaration(FieldDeclaration
):
826 def __init__(self
, enum_tag
, tag_name
):
828 Create a new variant field declaration.
831 isinst
= isinstance(enum_tag
, EnumerationFieldDeclaration
)
832 if enum_tag
is None or not isinst
:
833 raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.")
835 self
._ft
= nbt
._bt
_ctf
_field
_type
_variant
_create
(enum_tag
._ft
,
842 Get the variant's tag name.
845 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_name
(self
._ft
)
848 raise TypeError("Could not get Variant tag name")
855 Get the variant's tag type.
858 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_type
(self
._ft
)
861 raise TypeError("Could not get Variant tag type")
863 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
865 def add_field(self
, field_type
, field_name
):
867 Add a field of type "field_type" to the variant.
870 ret
= nbt
._bt
_ctf
_field
_type
_variant
_add
_field
(self
._ft
,
875 raise ValueError("Could not add field to variant.")
880 Generator returning the variant's field as tuples of (field name, field declaration).
883 count
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_count
(self
._ft
)
886 raise TypeError("Could not get Variant field count")
888 for i
in range(count
):
889 field_name
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_name
(self
._ft
, i
)
891 if field_name
is None:
892 msg
= "Could not get Variant field name at index {}".format(i
)
895 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_type
(self
._ft
, i
)
897 if field_type_native
is None:
898 msg
= "Could not get Variant field type at index {}".format(i
)
901 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
902 yield (field_name
, field_type
)
904 def get_field_by_name(self
, name
):
906 Get a field declaration by name (FieldDeclaration).
909 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_by
_name
(self
._ft
,
912 if field_type_native
is None:
913 msg
= "Could not find Variant field with name {}".format(name
)
916 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
918 def get_field_from_tag(self
, tag
):
920 Get a field declaration from tag (EnumerationField).
923 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_from
_tag
(self
._ft
, tag
._f
)
925 if field_type_native
is None:
926 msg
= "Could not find Variant field with tag value {}".format(tag
.value
)
929 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
932 class ArrayFieldDeclaration(FieldDeclaration
):
933 def __init__(self
, element_type
, length
):
935 Create a new array field declaration.
938 self
._ft
= nbt
._bt
_ctf
_field
_type
_array
_create
(element_type
._ft
,
943 def element_type(self
):
945 Get the array's element type.
948 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_element
_type
(self
._ft
)
951 raise TypeError("Could not get Array element type")
953 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
958 Get the array's length.
961 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_length
(self
._ft
)
964 raise TypeError("Could not get Array length")
969 class SequenceFieldDeclaration(FieldDeclaration
):
970 def __init__(self
, element_type
, length_field_name
):
972 Create a new sequence field declaration.
975 self
._ft
= nbt
._bt
_ctf
_field
_type
_sequence
_create
(element_type
._ft
,
976 str(length_field_name
))
980 def element_type(self
):
982 Get the sequence's element type.
985 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_element
_type
(self
._ft
)
988 raise TypeError("Could not get Sequence element type")
990 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
993 def length_field_name(self
):
995 Get the sequence's length field name.
998 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_length
_field
_name
(self
._ft
)
1001 raise TypeError("Could not get Sequence length field name")
1006 class StringFieldDeclaration(FieldDeclaration
):
1009 Create a new string field declaration.
1012 self
._ft
= nbt
._bt
_ctf
_field
_type
_string
_create
()
1018 Get a string declaration's encoding (a constant from the CTFStringEncoding class).
1021 return nbt
._bt
_ctf
_field
_type
_string
_get
_encoding
(self
._ft
)
1024 def encoding(self
, encoding
):
1026 Set a string declaration's encoding. Must be a constant from the CTFStringEncoding class.
1029 ret
= nbt
._bt
_ctf
_field
_type
_string
_set
_encoding
(self
._ft
, encoding
)
1031 raise ValueError("Could not set string encoding.")
1035 def create_field(field_type
):
1037 Create an instance of a field.
1039 isinst
= isinstance(field_type
, FieldDeclaration
)
1041 if field_type
is None or not isinst
:
1042 raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.")
1044 if isinstance(field_type
, IntegerFieldDeclaration
):
1045 return IntegerField(field_type
)
1046 elif isinstance(field_type
, EnumerationFieldDeclaration
):
1047 return EnumerationField(field_type
)
1048 elif isinstance(field_type
, FloatFieldDeclaration
):
1049 return FloatingPointField(field_type
)
1050 elif isinstance(field_type
, StructureFieldDeclaration
):
1051 return StructureField(field_type
)
1052 elif isinstance(field_type
, VariantFieldDeclaration
):
1053 return VariantField(field_type
)
1054 elif isinstance(field_type
, ArrayFieldDeclaration
):
1055 return ArrayField(field_type
)
1056 elif isinstance(field_type
, SequenceFieldDeclaration
):
1057 return SequenceField(field_type
)
1058 elif isinstance(field_type
, StringFieldDeclaration
):
1059 return StringField(field_type
)
1064 Base class, do not instantiate.
1067 def __init__(self
, field_type
):
1068 if not isinstance(field_type
, FieldDeclaration
):
1069 raise TypeError("Invalid field_type argument.")
1071 self
._f
= nbt
._bt
_ctf
_field
_create
(field_type
._ft
)
1074 raise ValueError("Field creation failed.")
1077 nbt
._bt
_ctf
_field
_put
(self
._f
)
1080 def _create_field_from_native_instance(native_field_instance
):
1082 common
.CTFTypeId
.INTEGER
: IntegerField
,
1083 common
.CTFTypeId
.FLOAT
: FloatingPointField
,
1084 common
.CTFTypeId
.ENUM
: EnumerationField
,
1085 common
.CTFTypeId
.STRING
: StringField
,
1086 common
.CTFTypeId
.STRUCT
: StructureField
,
1087 common
.CTFTypeId
.VARIANT
: VariantField
,
1088 common
.CTFTypeId
.ARRAY
: ArrayField
,
1089 common
.CTFTypeId
.SEQUENCE
: SequenceField
1092 field_type
= nbt
._bt
_python
_get
_field
_type
(native_field_instance
)
1094 if field_type
== common
.CTFTypeId
.UNKNOWN
:
1095 raise TypeError("Invalid field instance")
1097 field
= Field
.__new
__(Field
)
1098 field
._f
= native_field_instance
1099 field
.__class
__ = type_dict
[field_type
]
1104 def declaration(self
):
1105 native_field_type
= nbt
._bt
_ctf
_field
_get
_type
(self
._f
)
1107 if native_field_type
is None:
1108 raise TypeError("Invalid field instance")
1109 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(
1113 class IntegerField(Field
):
1117 Get an integer field's value.
1120 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
1123 raise TypeError("Invalid integer instance.")
1126 ret
, value
= nbt
._bt
_ctf
_field
_unsigned
_integer
_get
_value
(self
._f
)
1128 ret
, value
= nbt
._bt
_ctf
_field
_signed
_integer
_get
_value
(self
._f
)
1131 raise ValueError("Could not get integer field value.")
1136 def value(self
, value
):
1138 Set an integer field's value.
1141 if not isinstance(value
, int):
1142 raise TypeError("IntegerField's value must be an int")
1144 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
1146 raise TypeError("Invalid integer instance.")
1149 ret
= nbt
._bt
_ctf
_field
_unsigned
_integer
_set
_value
(self
._f
, value
)
1151 ret
= nbt
._bt
_ctf
_field
_signed
_integer
_set
_value
(self
._f
, value
)
1154 raise ValueError("Could not set integer field value.")
1157 class EnumerationField(Field
):
1159 def container(self
):
1161 Return the enumeration's underlying container field (an integer field).
1164 container
= IntegerField
.__new
__(IntegerField
)
1165 container
._f
= nbt
._bt
_ctf
_field
_enumeration
_get
_container
(self
._f
)
1167 if container
._f
is None:
1168 raise TypeError("Invalid enumeration field type.")
1175 Get the enumeration field's mapping name.
1178 value
= nbt
._bt
_ctf
_field
_enumeration
_get
_mapping
_name
(self
._f
)
1181 raise ValueError("Could not get enumeration's mapping name.")
1186 def value(self
, value
):
1188 Set the enumeration field's value. Must be an integer as mapping names
1192 if not isinstance(value
, int):
1193 raise TypeError("EnumerationField value must be an int")
1195 self
.container
.value
= value
1198 class FloatingPointField(Field
):
1202 Get a floating point field's value.
1205 ret
, value
= nbt
._bt
_ctf
_field
_floating
_point
_get
_value
(self
._f
)
1208 raise ValueError("Could not get floating point field value.")
1213 def value(self
, value
):
1215 Set a floating point field's value.
1218 if not isinstance(value
, int) and not isinstance(value
, float):
1219 raise TypeError("Value must be either a float or an int")
1221 ret
= nbt
._bt
_ctf
_field
_floating
_point
_set
_value
(self
._f
, float(value
))
1224 raise ValueError("Could not set floating point field value.")
1227 # oops!! This class is provided to ensure backward-compatibility since
1228 # a stable release publicly exposed this abomination.
1229 class FloatFieldingPoint(FloatingPointField
):
1233 class StructureField(Field
):
1234 def field(self
, field_name
):
1236 Get the structure's field corresponding to the provided field name.
1239 native_instance
= nbt
._bt
_ctf
_field
_structure
_get
_field
(self
._f
,
1242 if native_instance
is None:
1243 raise ValueError("Invalid field_name provided.")
1245 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1248 class VariantField(Field
):
1249 def field(self
, tag
):
1251 Return the variant's selected field. The "tag" field is the selector enum field.
1254 native_instance
= nbt
._bt
_ctf
_field
_variant
_get
_field
(self
._f
, tag
._f
)
1256 if native_instance
is None:
1257 raise ValueError("Invalid tag provided.")
1259 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1262 class ArrayField(Field
):
1263 def field(self
, index
):
1265 Return the array's field at position "index".
1268 native_instance
= nbt
._bt
_ctf
_field
_array
_get
_field
(self
._f
, index
)
1270 if native_instance
is None:
1271 raise IndexError("Invalid index provided.")
1273 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1276 class SequenceField(Field
):
1280 Get the sequence's length field (IntegerField).
1283 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_length
(self
._f
)
1285 if native_instance
is None:
1288 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1291 def length(self
, length_field
):
1293 Set the sequence's length field (IntegerField).
1296 if not isinstance(length_field
, IntegerField
):
1297 raise TypeError("Invalid length field.")
1299 if length_field
.declaration
.signed
:
1300 raise TypeError("Sequence field length must be unsigned")
1302 ret
= nbt
._bt
_ctf
_field
_sequence
_set
_length
(self
._f
, length_field
._f
)
1305 raise ValueError("Could not set sequence length.")
1307 def field(self
, index
):
1309 Return the sequence's field at position "index".
1312 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_field
(self
._f
, index
)
1314 if native_instance
is None:
1315 raise ValueError("Could not get sequence element at index.")
1317 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1320 class StringField(Field
):
1324 Get a string field's value.
1327 return nbt
._bt
_ctf
_field
_string
_get
_value
(self
._f
)
1330 def value(self
, value
):
1332 Set a string field's value.
1335 ret
= nbt
._bt
_ctf
_field
_string
_set
_value
(self
._f
, str(value
))
1338 raise ValueError("Could not set string field value.")
1342 def __init__(self
, name
):
1344 Create a new event class of the given name.
1347 self
._ec
= nbt
._bt
_ctf
_event
_class
_create
(name
)
1349 if self
._ec
is None:
1350 raise ValueError("Event class creation failed.")
1353 nbt
._bt
_ctf
_event
_class
_put
(self
._ec
)
1355 def add_field(self
, field_type
, field_name
):
1357 Add a field of type "field_type" to the event class.
1360 ret
= nbt
._bt
_ctf
_event
_class
_add
_field
(self
._ec
, field_type
._ft
,
1364 raise ValueError("Could not add field to event class.")
1369 Get the event class' name.
1372 name
= nbt
._bt
_ctf
_event
_class
_get
_name
(self
._ec
)
1375 raise TypeError("Could not get EventClass name")
1382 Get the event class' id. Returns a negative value if unset.
1385 id = nbt
._bt
_ctf
_event
_class
_get
_id
(self
._ec
)
1388 raise TypeError("Could not get EventClass id")
1395 Set the event class' id. Throws a TypeError if the event class
1396 is already registered to a stream class.
1399 ret
= nbt
._bt
_ctf
_event
_class
_set
_id
(self
._ec
, id)
1402 raise TypeError("Can't change an Event Class's id after it has been assigned to a stream class")
1405 def stream_class(self
):
1407 Get the event class' stream class. Returns None if unset.
1409 stream_class_native
= nbt
._bt
_ctf
_event
_class
_get
_stream
_class
(self
._ec
)
1411 if stream_class_native
is None:
1414 stream_class
= StreamClass
.__new
__(StreamClass
)
1415 stream_class
._sc
= stream_class_native
1422 Generator returning the event class' fields as tuples of (field name, field declaration).
1425 count
= nbt
._bt
_ctf
_event
_class
_get
_field
_count
(self
._ec
)
1428 raise TypeError("Could not get EventClass' field count")
1430 for i
in range(count
):
1431 field_name
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_name
(self
._ec
, i
)
1433 if field_name
is None:
1434 msg
= "Could not get EventClass' field name at index {}".format(i
)
1435 raise TypeError(msg
)
1437 field_type_native
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_type
(self
._ec
, i
)
1439 if field_type_native
is None:
1440 msg
= "Could not get EventClass' field type at index {}".format(i
)
1441 raise TypeError(msg
)
1443 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
1444 yield (field_name
, field_type
)
1446 def get_field_by_name(self
, name
):
1448 Get a field declaration by name (FieldDeclaration).
1451 field_type_native
= nbt
._bt
_ctf
_event
_class
_get
_field
_by
_name
(self
._ec
, name
)
1453 if field_type_native
is None:
1454 msg
= "Could not find EventClass field with name {}".format(name
)
1455 raise TypeError(msg
)
1457 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
1461 def __init__(self
, event_class
):
1463 Create a new event of the given event class.
1466 if not isinstance(event_class
, EventClass
):
1467 raise TypeError("Invalid event_class argument.")
1469 self
._e
= nbt
._bt
_ctf
_event
_create
(event_class
._ec
)
1472 raise ValueError("Event creation failed.")
1475 nbt
._bt
_ctf
_event
_put
(self
._e
)
1478 def event_class(self
):
1480 Get the event's class.
1483 event_class_native
= nbt
._bt
_ctf
_event
_get
_class
(self
._e
)
1485 if event_class_native
is None:
1488 event_class
= EventClass
.__new
__(EventClass
)
1489 event_class
._ec
= event_class_native
1495 Get a clock from event. Returns None if the event's class
1496 is not registered to a stream class.
1499 clock_instance
= nbt
._bt
_ctf
_event
_get
_clock
(self
._e
)
1501 if clock_instance
is None:
1504 clock
= Clock
.__new
__(Clock
)
1505 clock
._c
= clock_instance
1509 def payload(self
, field_name
):
1511 Get a field from event.
1514 native_instance
= nbt
._bt
_ctf
_event
_get
_payload
(self
._e
,
1517 if native_instance
is None:
1518 raise ValueError("Could not get event payload.")
1520 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1522 def set_payload(self
, field_name
, value_field
):
1524 Set a manually created field as an event's payload.
1527 if not isinstance(value
, Field
):
1528 raise TypeError("Invalid value type.")
1530 ret
= nbt
._bt
_ctf
_event
_set
_payload
(self
._e
, str(field_name
),
1534 raise ValueError("Could not set event field payload.")
1538 def __init__(self
, name
):
1540 Create a new stream class of the given name.
1543 self
._sc
= nbt
._bt
_ctf
_stream
_class
_create
(name
)
1545 if self
._sc
is None:
1546 raise ValueError("Stream class creation failed.")
1549 nbt
._bt
_ctf
_stream
_class
_put
(self
._sc
)
1554 Get a stream class' name.
1557 name
= nbt
._bt
_ctf
_stream
_class
_get
_name
(self
._sc
)
1560 raise TypeError("Could not get StreamClass name")
1567 Get a stream class' clock.
1570 clock_instance
= nbt
._bt
_ctf
_stream
_class
_get
_clock
(self
._sc
)
1572 if clock_instance
is None:
1575 clock
= Clock
.__new
__(Clock
)
1576 clock
._c
= clock_instance
1581 def clock(self
, clock
):
1583 Assign a clock to a stream class.
1586 if not isinstance(clock
, Clock
):
1587 raise TypeError("Invalid clock type.")
1589 ret
= nbt
._bt
_ctf
_stream
_class
_set
_clock
(self
._sc
, clock
._c
)
1592 raise ValueError("Could not set stream class clock.")
1597 Get a stream class' id.
1600 ret
= nbt
._bt
_ctf
_stream
_class
_get
_id
(self
._sc
)
1603 raise TypeError("Could not get StreamClass id")
1610 Assign an id to a stream class.
1613 ret
= nbt
._bt
_ctf
_stream
_class
_set
_id
(self
._sc
, id)
1616 raise TypeError("Could not set stream class id.")
1619 def event_classes(self
):
1621 Generator returning the stream class' event classes.
1624 count
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
_count
(self
._sc
)
1627 raise TypeError("Could not get StreamClass' event class count")
1629 for i
in range(count
):
1630 event_class_native
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
(self
._sc
, i
)
1632 if event_class_native
is None:
1633 msg
= "Could not get StreamClass' event class at index {}".format(i
)
1634 raise TypeError(msg
)
1636 event_class
= EventClass
.__new
__(EventClass
)
1637 event_class
._ec
= event_class_native
1640 def add_event_class(self
, event_class
):
1642 Add an event class to a stream class. New events can be added even after a
1643 stream has been instantiated and events have been appended. However, a stream
1644 will not accept events of a class that has not been added to the stream
1648 if not isinstance(event_class
, EventClass
):
1649 raise TypeError("Invalid event_class type.")
1651 ret
= nbt
._bt
_ctf
_stream
_class
_add
_event
_class
(self
._sc
,
1655 raise ValueError("Could not add event class.")
1658 def packet_context_type(self
):
1660 Get the StreamClass' packet context type (StructureFieldDeclaration)
1663 field_type_native
= nbt
._bt
_ctf
_stream
_class
_get
_packet
_context
_type
(self
._sc
)
1665 if field_type_native
is None:
1666 raise ValueError("Invalid StreamClass")
1668 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
1672 @packet_context_type.setter
1673 def packet_context_type(self
, field_type
):
1675 Set a StreamClass' packet context type. Must be of type
1676 StructureFieldDeclaration.
1679 if not isinstance(field_type
, StructureFieldDeclaration
):
1680 raise TypeError("field_type argument must be of type StructureFieldDeclaration.")
1682 ret
= nbt
._bt
_ctf
_stream
_class
_set
_packet
_context
_type
(self
._sc
,
1686 raise ValueError("Failed to set packet context type.")
1691 raise NotImplementedError("Stream cannot be instantiated; use Writer.create_stream()")
1694 nbt
._bt
_ctf
_stream
_put
(self
._s
)
1697 def discarded_events(self
):
1699 Get a stream's discarded event count.
1702 ret
, count
= nbt
._bt
_ctf
_stream
_get
_discarded
_events
_count
(self
._s
)
1705 raise ValueError("Could not get the stream's discarded events count")
1709 def append_discarded_events(self
, event_count
):
1711 Increase the current packet's discarded event count.
1714 nbt
._bt
_ctf
_stream
_append
_discarded
_events
(self
._s
, event_count
)
1716 def append_event(self
, event
):
1718 Append "event" to the stream's current packet. The stream's associated clock
1719 will be sampled during this call. The event shall not be modified after
1720 being appended to a stream.
1723 ret
= nbt
._bt
_ctf
_stream
_append
_event
(self
._s
, event
._e
)
1726 raise ValueError("Could not append event to stream.")
1729 def packet_context(self
):
1731 Get a Stream's packet context field (a StructureField).
1734 native_field
= nbt
._bt
_ctf
_stream
_get
_packet
_context
(self
._s
)
1736 if native_field
is None:
1737 raise ValueError("Invalid Stream.")
1739 return Field
._create
_field
_from
_native
_instance
(native_field
)
1741 @packet_context.setter
1742 def packet_context(self
, field
):
1744 Set a Stream's packet context field (must be a StructureField).
1747 if not isinstance(field
, StructureField
):
1748 raise TypeError("Argument field must be of type StructureField")
1750 ret
= nbt
._bt
_ctf
_stream
_set
_packet
_context
(self
._s
, field
._f
)
1753 raise ValueError("Invalid packet context field.")
1757 The stream's current packet's events will be flushed to disk. Events
1758 subsequently appended to the stream will be added to a new packet.
1761 ret
= nbt
._bt
_ctf
_stream
_flush
(self
._s
)
1764 raise ValueError("Could not flush stream.")
1768 def __init__(self
, path
):
1770 Create a new writer that will produce a trace in the given path.
1773 self
._w
= nbt
._bt
_ctf
_writer
_create
(path
)
1776 raise ValueError("Writer creation failed.")
1779 nbt
._bt
_ctf
_writer
_put
(self
._w
)
1781 def create_stream(self
, stream_class
):
1783 Create a new stream instance and register it to the writer.
1786 if not isinstance(stream_class
, StreamClass
):
1787 raise TypeError("Invalid stream_class type.")
1789 stream
= Stream
.__new
__(Stream
)
1790 stream
._s
= nbt
._bt
_ctf
_writer
_create
_stream
(self
._w
, stream_class
._sc
)
1794 def add_environment_field(self
, name
, value
):
1796 Add an environment field to the trace.
1799 ret
= nbt
._bt
_ctf
_writer
_add
_environment
_field
(self
._w
, str(name
),
1803 raise ValueError("Could not add environment field to trace.")
1805 def add_clock(self
, clock
):
1807 Add a clock to the trace. Clocks assigned to stream classes must be
1808 registered to the writer.
1811 ret
= nbt
._bt
_ctf
_writer
_add
_clock
(self
._w
, clock
._c
)
1814 raise ValueError("Could not add clock to Writer.")
1819 Get the trace's TSDL meta-data.
1822 return nbt
._bt
_ctf
_writer
_get
_metadata
_string
(self
._w
)
1824 def flush_metadata(self
):
1826 Flush the trace's metadata to the metadata file.
1829 nbt
._bt
_ctf
_writer
_flush
_metadata
(self
._w
)
1832 def byte_order(self
):
1834 Get the trace's byte order. Must be a constant from the ByteOrder
1838 raise NotImplementedError("Getter not implemented.")
1841 def byte_order(self
, byte_order
):
1843 Set the trace's byte order. Must be a constant from the ByteOrder
1844 class. Defaults to the host machine's endianness
1847 ret
= nbt
._bt
_ctf
_writer
_set
_byte
_order
(self
._w
, byte_order
)
1850 raise ValueError("Could not set trace's byte order.")