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
):
402 def __init__(self
, size
):
404 Create a new integer field declaration of the given size.
406 self
._ft
= nbt
._bt
_ctf
_field
_type
_integer
_create
(size
)
412 Get an integer's size.
415 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_size
(self
._ft
)
418 raise ValueError("Could not get Integer's size attribute.")
425 Get an integer's signedness attribute.
428 ret
= nbt
._bt
_ctf
_field
_type
_integer
_get
_signed
(self
._ft
)
431 raise ValueError("Could not get Integer's signed attribute.")
438 def signed(self
, signed
):
440 Set an integer's signedness attribute.
443 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_signed
(self
._ft
, signed
)
446 raise ValueError("Could not set Integer's signed attribute.")
451 Get the integer's base used to pretty-print the resulting trace.
452 Returns a constant from the FieldDeclaration.IntegerBase class.
455 return nbt
._bt
_ctf
_field
_type
_integer
_get
_base
(self
._ft
)
458 def base(self
, base
):
460 Set the integer's base used to pretty-print the resulting trace.
461 The base must be a constant of the FieldDeclarationIntegerBase class.
464 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_base
(self
._ft
, base
)
467 raise ValueError("Could not set Integer's base.")
472 Get the integer's encoding (one of the constants of the
473 CTFStringEncoding class).
474 Returns a constant from the CTFStringEncoding class.
477 return nbt
._bt
_ctf
_field
_type
_integer
_get
_encoding
(self
._ft
)
480 def encoding(self
, encoding
):
482 An integer encoding may be set to signal that the integer must be printed
483 as a text character. Must be a constant from the CTFStringEncoding class.
486 ret
= nbt
._bt
_ctf
_field
_type
_integer
_set
_encoding
(self
._ft
, encoding
)
489 raise ValueError("Could not set Integer's encoding.")
492 class EnumerationFieldDeclaration(FieldDeclaration
):
493 def __init__(self
, integer_type
):
495 Create a new enumeration field declaration with the given underlying container type.
497 isinst
= isinstance(integer_type
, IntegerFieldDeclaration
)
499 if integer_type
is None or not isinst
:
500 raise TypeError("Invalid integer container.")
502 self
._ft
= nbt
._bt
_ctf
_field
_type
_enumeration
_create
(integer_type
._ft
)
508 Get the enumeration's underlying container type.
511 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_container
_type
(self
._ft
)
514 raise TypeError("Invalid enumeration declaration")
516 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
518 def add_mapping(self
, name
, range_start
, range_end
):
520 Add a mapping to the enumeration. The range's values are inclusive.
523 if range_start
< 0 or range_end
< 0:
524 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
(self
._ft
,
529 ret
= nbt
._bt
_ctf
_field
_type
_enumeration
_add
_mapping
_unsigned
(self
._ft
,
535 raise ValueError("Could not add mapping to enumeration declaration.")
540 Generator returning instances of EnumerationMapping.
543 signed
= self
.container
.signed
545 count
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_count
(self
._ft
)
547 for i
in range(count
):
549 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, i
)
551 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, i
)
554 msg
= "Could not get Enumeration mapping at index {}".format(i
)
557 name
, range_start
, range_end
= ret
558 yield EnumerationMapping(name
, range_start
, range_end
)
560 def get_mapping_by_name(self
, name
):
562 Get a mapping by name (EnumerationMapping).
565 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_name
(self
._ft
, name
)
570 if self
.container
.signed
:
571 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
573 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
576 msg
= "Could not get Enumeration mapping at index {}".format(i
)
579 name
, range_start
, range_end
= ret
581 return EnumerationMapping(name
, range_start
, range_end
)
583 def get_mapping_by_value(self
, value
):
585 Get a mapping by value (EnumerationMapping).
589 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_value
(self
._ft
, value
)
591 index
= nbt
._bt
_ctf
_field
_type
_enumeration
_get
_mapping
_index
_by
_unsigned
_value
(self
._ft
, value
)
596 if self
.container
.signed
:
597 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
(self
._ft
, index
)
599 ret
= nbt
._bt
_python
_ctf
_field
_type
_enumeration
_get
_mapping
_unsigned
(self
._ft
, index
)
602 msg
= "Could not get Enumeration mapping at index {}".format(i
)
605 name
, range_start
, range_end
= ret
607 return EnumerationMapping(name
, range_start
, range_end
)
610 class FloatFieldDeclaration(FieldDeclaration
):
618 Create a new floating point field declaration.
621 self
._ft
= nbt
._bt
_ctf
_field
_type
_floating
_point
_create
()
625 def exponent_digits(self
):
627 Get the number of exponent digits used to store the floating point field.
630 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_exponent
_digits
(self
._ft
)
634 "Could not get Floating point exponent digit count")
638 @exponent_digits.setter
639 def exponent_digits(self
, exponent_digits
):
641 Set the number of exponent digits to use to store the floating point field.
642 The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which
643 are defined as constants of this class.
646 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_exponent
_digits
(self
._ft
,
650 raise ValueError("Could not set exponent digit count.")
653 def mantissa_digits(self
):
655 Get the number of mantissa digits used to store the floating point field.
658 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_get
_mantissa
_digits
(self
._ft
)
661 raise TypeError("Could not get Floating point mantissa digit count")
665 @mantissa_digits.setter
666 def mantissa_digits(self
, mantissa_digits
):
668 Set the number of mantissa digits to use to store the floating point field.
669 The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which
670 are defined as constants of this class.
673 ret
= nbt
._bt
_ctf
_field
_type
_floating
_point
_set
_mantissa
_digits
(self
._ft
,
677 raise ValueError("Could not set mantissa digit count.")
680 class FloatingPointFieldDeclaration(FloatFieldDeclaration
):
684 class StructureFieldDeclaration(FieldDeclaration
):
687 Create a new structure field declaration.
690 self
._ft
= nbt
._bt
_ctf
_field
_type
_structure
_create
()
693 def add_field(self
, field_type
, field_name
):
695 Add a field of type "field_type" to the structure.
698 ret
= nbt
._bt
_ctf
_field
_type
_structure
_add
_field
(self
._ft
,
703 raise ValueError("Could not add field to structure.")
708 Generator returning the structure's field as tuples of (field name, field declaration).
711 count
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_count
(self
._ft
)
714 raise TypeError("Could not get Structure field count")
716 for i
in range(count
):
717 field_name
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_name
(self
._ft
, i
)
719 if field_name
is None:
720 msg
= "Could not get Structure field name at index {}".format(i
)
723 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_structure
_get
_field
_type
(self
._ft
, i
)
725 if field_type_native
is None:
726 msg
= "Could not get Structure field type at index {}".format(i
)
729 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
730 yield (field_name
, field_type
)
732 def get_field_by_name(self
, name
):
734 Get a field declaration by name (FieldDeclaration).
737 field_type_native
= nbt
._bt
_ctf
_field
_type
_structure
_get
_field
_type
_by
_name
(self
._ft
, name
)
739 if field_type_native
is None:
740 msg
= "Could not find Structure field with name {}".format(name
)
743 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
746 class VariantFieldDeclaration(FieldDeclaration
):
747 def __init__(self
, enum_tag
, tag_name
):
749 Create a new variant field declaration.
752 isinst
= isinstance(enum_tag
, EnumerationFieldDeclaration
)
753 if enum_tag
is None or not isinst
:
754 raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.")
756 self
._ft
= nbt
._bt
_ctf
_field
_type
_variant
_create
(enum_tag
._ft
,
763 Get the variant's tag name.
766 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_name
(self
._ft
)
769 raise TypeError("Could not get Variant tag name")
776 Get the variant's tag type.
779 ret
= nbt
._bt
_ctf
_field
_type
_variant
_get
_tag
_type
(self
._ft
)
782 raise TypeError("Could not get Variant tag type")
784 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
786 def add_field(self
, field_type
, field_name
):
788 Add a field of type "field_type" to the variant.
791 ret
= nbt
._bt
_ctf
_field
_type
_variant
_add
_field
(self
._ft
,
796 raise ValueError("Could not add field to variant.")
801 Generator returning the variant's field as tuples of (field name, field declaration).
804 count
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_count
(self
._ft
)
807 raise TypeError("Could not get Variant field count")
809 for i
in range(count
):
810 field_name
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_name
(self
._ft
, i
)
812 if field_name
is None:
813 msg
= "Could not get Variant field name at index {}".format(i
)
816 field_type_native
= nbt
._bt
_python
_ctf
_field
_type
_variant
_get
_field
_type
(self
._ft
, i
)
818 if field_type_native
is None:
819 msg
= "Could not get Variant field type at index {}".format(i
)
822 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
823 yield (field_name
, field_type
)
825 def get_field_by_name(self
, name
):
827 Get a field declaration by name (FieldDeclaration).
830 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_by
_name
(self
._ft
,
833 if field_type_native
is None:
834 msg
= "Could not find Variant field with name {}".format(name
)
837 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
839 def get_field_from_tag(self
, tag
):
841 Get a field declaration from tag (EnumerationField).
844 field_type_native
= nbt
._bt
_ctf
_field
_type
_variant
_get
_field
_type
_from
_tag
(self
._ft
, tag
._f
)
846 if field_type_native
is None:
847 msg
= "Could not find Variant field with tag value {}".format(tag
.value
)
850 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
853 class ArrayFieldDeclaration(FieldDeclaration
):
854 def __init__(self
, element_type
, length
):
856 Create a new array field declaration.
859 self
._ft
= nbt
._bt
_ctf
_field
_type
_array
_create
(element_type
._ft
,
864 def element_type(self
):
866 Get the array's element type.
869 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_element
_type
(self
._ft
)
872 raise TypeError("Could not get Array element type")
874 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
879 Get the array's length.
882 ret
= nbt
._bt
_ctf
_field
_type
_array
_get
_length
(self
._ft
)
885 raise TypeError("Could not get Array length")
890 class SequenceFieldDeclaration(FieldDeclaration
):
891 def __init__(self
, element_type
, length_field_name
):
893 Create a new sequence field declaration.
896 self
._ft
= nbt
._bt
_ctf
_field
_type
_sequence
_create
(element_type
._ft
,
897 str(length_field_name
))
901 def element_type(self
):
903 Get the sequence's element type.
906 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_element
_type
(self
._ft
)
909 raise TypeError("Could not get Sequence element type")
911 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(ret
)
914 def length_field_name(self
):
916 Get the sequence's length field name.
919 ret
= nbt
._bt
_ctf
_field
_type
_sequence
_get
_length
_field
_name
(self
._ft
)
922 raise TypeError("Could not get Sequence length field name")
927 class StringFieldDeclaration(FieldDeclaration
):
930 Create a new string field declaration.
933 self
._ft
= nbt
._bt
_ctf
_field
_type
_string
_create
()
939 Get a string declaration's encoding (a constant from the CTFStringEncoding class).
942 return nbt
._bt
_ctf
_field
_type
_string
_get
_encoding
(self
._ft
)
945 def encoding(self
, encoding
):
947 Set a string declaration's encoding. Must be a constant from the CTFStringEncoding class.
950 ret
= nbt
._bt
_ctf
_field
_type
_string
_set
_encoding
(self
._ft
, encoding
)
952 raise ValueError("Could not set string encoding.")
956 def create_field(field_type
):
958 Create an instance of a field.
960 isinst
= isinstance(field_type
, FieldDeclaration
)
962 if field_type
is None or not isinst
:
963 raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.")
965 if isinstance(field_type
, IntegerFieldDeclaration
):
966 return IntegerField(field_type
)
967 elif isinstance(field_type
, EnumerationFieldDeclaration
):
968 return EnumerationField(field_type
)
969 elif isinstance(field_type
, FloatFieldDeclaration
):
970 return FloatingPointField(field_type
)
971 elif isinstance(field_type
, StructureFieldDeclaration
):
972 return StructureField(field_type
)
973 elif isinstance(field_type
, VariantFieldDeclaration
):
974 return VariantField(field_type
)
975 elif isinstance(field_type
, ArrayFieldDeclaration
):
976 return ArrayField(field_type
)
977 elif isinstance(field_type
, SequenceFieldDeclaration
):
978 return SequenceField(field_type
)
979 elif isinstance(field_type
, StringFieldDeclaration
):
980 return StringField(field_type
)
985 Base class, do not instantiate.
988 def __init__(self
, field_type
):
989 if not isinstance(field_type
, FieldDeclaration
):
990 raise TypeError("Invalid field_type argument.")
992 self
._f
= nbt
._bt
_ctf
_field
_create
(field_type
._ft
)
995 raise ValueError("Field creation failed.")
998 nbt
._bt
_ctf
_field
_put
(self
._f
)
1001 def _create_field_from_native_instance(native_field_instance
):
1003 common
.CTFTypeId
.INTEGER
: IntegerField
,
1004 common
.CTFTypeId
.FLOAT
: FloatingPointField
,
1005 common
.CTFTypeId
.ENUM
: EnumerationField
,
1006 common
.CTFTypeId
.STRING
: StringField
,
1007 common
.CTFTypeId
.STRUCT
: StructureField
,
1008 common
.CTFTypeId
.VARIANT
: VariantField
,
1009 common
.CTFTypeId
.ARRAY
: ArrayField
,
1010 common
.CTFTypeId
.SEQUENCE
: SequenceField
1013 field_type
= nbt
._bt
_python
_get
_field
_type
(native_field_instance
)
1015 if field_type
== common
.CTFTypeId
.UNKNOWN
:
1016 raise TypeError("Invalid field instance")
1018 field
= Field
.__new
__(Field
)
1019 field
._f
= native_field_instance
1020 field
.__class
__ = type_dict
[field_type
]
1025 def declaration(self
):
1026 native_field_type
= nbt
._bt
_ctf
_field
_get
_type
(self
._f
)
1028 if native_field_type
is None:
1029 raise TypeError("Invalid field instance")
1030 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(
1034 class IntegerField(Field
):
1038 Get an integer field's value.
1041 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
1044 raise TypeError("Invalid integer instance.")
1047 ret
, value
= nbt
._bt
_ctf
_field
_unsigned
_integer
_get
_value
(self
._f
)
1049 ret
, value
= nbt
._bt
_ctf
_field
_signed
_integer
_get
_value
(self
._f
)
1052 raise ValueError("Could not get integer field value.")
1057 def value(self
, value
):
1059 Set an integer field's value.
1062 if not isinstance(value
, int):
1063 raise TypeError("IntegerField's value must be an int")
1065 signedness
= nbt
._bt
_python
_field
_integer
_get
_signedness
(self
._f
)
1067 raise TypeError("Invalid integer instance.")
1070 ret
= nbt
._bt
_ctf
_field
_unsigned
_integer
_set
_value
(self
._f
, value
)
1072 ret
= nbt
._bt
_ctf
_field
_signed
_integer
_set
_value
(self
._f
, value
)
1075 raise ValueError("Could not set integer field value.")
1078 class EnumerationField(Field
):
1080 def container(self
):
1082 Return the enumeration's underlying container field (an integer field).
1085 container
= IntegerField
.__new
__(IntegerField
)
1086 container
._f
= nbt
._bt
_ctf
_field
_enumeration
_get
_container
(self
._f
)
1088 if container
._f
is None:
1089 raise TypeError("Invalid enumeration field type.")
1096 Get the enumeration field's mapping name.
1099 value
= nbt
._bt
_ctf
_field
_enumeration
_get
_mapping
_name
(self
._f
)
1102 raise ValueError("Could not get enumeration's mapping name.")
1107 def value(self
, value
):
1109 Set the enumeration field's value. Must be an integer as mapping names
1113 if not isinstance(value
, int):
1114 raise TypeError("EnumerationField value must be an int")
1116 self
.container
.value
= value
1119 class FloatingPointField(Field
):
1123 Get a floating point field's value.
1126 ret
, value
= nbt
._bt
_ctf
_field
_floating
_point
_get
_value
(self
._f
)
1129 raise ValueError("Could not get floating point field value.")
1134 def value(self
, value
):
1136 Set a floating point field's value.
1139 if not isinstance(value
, int) and not isinstance(value
, float):
1140 raise TypeError("Value must be either a float or an int")
1142 ret
= nbt
._bt
_ctf
_field
_floating
_point
_set
_value
(self
._f
, float(value
))
1145 raise ValueError("Could not set floating point field value.")
1148 # oops!! This class is provided to ensure backward-compatibility since
1149 # a stable release publicly exposed this abomination.
1150 class FloatFieldingPoint(FloatingPointField
):
1154 class StructureField(Field
):
1155 def field(self
, field_name
):
1157 Get the structure's field corresponding to the provided field name.
1160 native_instance
= nbt
._bt
_ctf
_field
_structure
_get
_field
(self
._f
,
1163 if native_instance
is None:
1164 raise ValueError("Invalid field_name provided.")
1166 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1169 class VariantField(Field
):
1170 def field(self
, tag
):
1172 Return the variant's selected field. The "tag" field is the selector enum field.
1175 native_instance
= nbt
._bt
_ctf
_field
_variant
_get
_field
(self
._f
, tag
._f
)
1177 if native_instance
is None:
1178 raise ValueError("Invalid tag provided.")
1180 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1183 class ArrayField(Field
):
1184 def field(self
, index
):
1186 Return the array's field at position "index".
1189 native_instance
= nbt
._bt
_ctf
_field
_array
_get
_field
(self
._f
, index
)
1191 if native_instance
is None:
1192 raise IndexError("Invalid index provided.")
1194 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1197 class SequenceField(Field
):
1201 Get the sequence's length field (IntegerField).
1204 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_length
(self
._f
)
1206 if native_instance
is None:
1209 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1212 def length(self
, length_field
):
1214 Set the sequence's length field (IntegerField).
1217 if not isinstance(length_field
, IntegerField
):
1218 raise TypeError("Invalid length field.")
1220 if length_field
.declaration
.signed
:
1221 raise TypeError("Sequence field length must be unsigned")
1223 ret
= nbt
._bt
_ctf
_field
_sequence
_set
_length
(self
._f
, length_field
._f
)
1226 raise ValueError("Could not set sequence length.")
1228 def field(self
, index
):
1230 Return the sequence's field at position "index".
1233 native_instance
= nbt
._bt
_ctf
_field
_sequence
_get
_field
(self
._f
, index
)
1235 if native_instance
is None:
1236 raise ValueError("Could not get sequence element at index.")
1238 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1241 class StringField(Field
):
1245 Get a string field's value.
1248 return nbt
._bt
_ctf
_field
_string
_get
_value
(self
._f
)
1251 def value(self
, value
):
1253 Set a string field's value.
1256 ret
= nbt
._bt
_ctf
_field
_string
_set
_value
(self
._f
, str(value
))
1259 raise ValueError("Could not set string field value.")
1263 def __init__(self
, name
):
1265 Create a new event class of the given name.
1268 self
._ec
= nbt
._bt
_ctf
_event
_class
_create
(name
)
1270 if self
._ec
is None:
1271 raise ValueError("Event class creation failed.")
1274 nbt
._bt
_ctf
_event
_class
_put
(self
._ec
)
1276 def add_field(self
, field_type
, field_name
):
1278 Add a field of type "field_type" to the event class.
1281 ret
= nbt
._bt
_ctf
_event
_class
_add
_field
(self
._ec
, field_type
._ft
,
1285 raise ValueError("Could not add field to event class.")
1290 Get the event class' name.
1293 name
= nbt
._bt
_ctf
_event
_class
_get
_name
(self
._ec
)
1296 raise TypeError("Could not get EventClass name")
1303 Get the event class' id. Returns a negative value if unset.
1306 id = nbt
._bt
_ctf
_event
_class
_get
_id
(self
._ec
)
1309 raise TypeError("Could not get EventClass id")
1316 Set the event class' id. Throws a TypeError if the event class
1317 is already registered to a stream class.
1320 ret
= nbt
._bt
_ctf
_event
_class
_set
_id
(self
._ec
, id)
1323 raise TypeError("Can't change an Event Class's id after it has been assigned to a stream class")
1326 def stream_class(self
):
1328 Get the event class' stream class. Returns None if unset.
1330 stream_class_native
= nbt
._bt
_ctf
_event
_class
_get
_stream
_class
(self
._ec
)
1332 if stream_class_native
is None:
1335 stream_class
= StreamClass
.__new
__(StreamClass
)
1336 stream_class
._sc
= stream_class_native
1343 Generator returning the event class' fields as tuples of (field name, field declaration).
1346 count
= nbt
._bt
_ctf
_event
_class
_get
_field
_count
(self
._ec
)
1349 raise TypeError("Could not get EventClass' field count")
1351 for i
in range(count
):
1352 field_name
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_name
(self
._ec
, i
)
1354 if field_name
is None:
1355 msg
= "Could not get EventClass' field name at index {}".format(i
)
1356 raise TypeError(msg
)
1358 field_type_native
= nbt
._bt
_python
_ctf
_event
_class
_get
_field
_type
(self
._ec
, i
)
1360 if field_type_native
is None:
1361 msg
= "Could not get EventClass' field type at index {}".format(i
)
1362 raise TypeError(msg
)
1364 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
1365 yield (field_name
, field_type
)
1367 def get_field_by_name(self
, name
):
1369 Get a field declaration by name (FieldDeclaration).
1372 field_type_native
= nbt
._bt
_ctf
_event
_class
_get
_field
_by
_name
(self
._ec
, name
)
1374 if field_type_native
is None:
1375 msg
= "Could not find EventClass field with name {}".format(name
)
1376 raise TypeError(msg
)
1378 return FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
1382 def __init__(self
, event_class
):
1384 Create a new event of the given event class.
1387 if not isinstance(event_class
, EventClass
):
1388 raise TypeError("Invalid event_class argument.")
1390 self
._e
= nbt
._bt
_ctf
_event
_create
(event_class
._ec
)
1393 raise ValueError("Event creation failed.")
1396 nbt
._bt
_ctf
_event
_put
(self
._e
)
1399 def event_class(self
):
1401 Get the event's class.
1404 event_class_native
= nbt
._bt
_ctf
_event
_get
_class
(self
._e
)
1406 if event_class_native
is None:
1409 event_class
= EventClass
.__new
__(EventClass
)
1410 event_class
._ec
= event_class_native
1416 Get a clock from event. Returns None if the event's class
1417 is not registered to a stream class.
1420 clock_instance
= nbt
._bt
_ctf
_event
_get
_clock
(self
._e
)
1422 if clock_instance
is None:
1425 clock
= Clock
.__new
__(Clock
)
1426 clock
._c
= clock_instance
1430 def payload(self
, field_name
):
1432 Get a field from event.
1435 native_instance
= nbt
._bt
_ctf
_event
_get
_payload
(self
._e
,
1438 if native_instance
is None:
1439 raise ValueError("Could not get event payload.")
1441 return Field
._create
_field
_from
_native
_instance
(native_instance
)
1443 def set_payload(self
, field_name
, value_field
):
1445 Set a manually created field as an event's payload.
1448 if not isinstance(value
, Field
):
1449 raise TypeError("Invalid value type.")
1451 ret
= nbt
._bt
_ctf
_event
_set
_payload
(self
._e
, str(field_name
),
1455 raise ValueError("Could not set event field payload.")
1459 def __init__(self
, name
):
1461 Create a new stream class of the given name.
1464 self
._sc
= nbt
._bt
_ctf
_stream
_class
_create
(name
)
1466 if self
._sc
is None:
1467 raise ValueError("Stream class creation failed.")
1470 nbt
._bt
_ctf
_stream
_class
_put
(self
._sc
)
1475 Get a stream class' name.
1478 name
= nbt
._bt
_ctf
_stream
_class
_get
_name
(self
._sc
)
1481 raise TypeError("Could not get StreamClass name")
1488 Get a stream class' clock.
1491 clock_instance
= nbt
._bt
_ctf
_stream
_class
_get
_clock
(self
._sc
)
1493 if clock_instance
is None:
1496 clock
= Clock
.__new
__(Clock
)
1497 clock
._c
= clock_instance
1502 def clock(self
, clock
):
1504 Assign a clock to a stream class.
1507 if not isinstance(clock
, Clock
):
1508 raise TypeError("Invalid clock type.")
1510 ret
= nbt
._bt
_ctf
_stream
_class
_set
_clock
(self
._sc
, clock
._c
)
1513 raise ValueError("Could not set stream class clock.")
1518 Get a stream class' id.
1521 ret
= nbt
._bt
_ctf
_stream
_class
_get
_id
(self
._sc
)
1524 raise TypeError("Could not get StreamClass id")
1531 Assign an id to a stream class.
1534 ret
= nbt
._bt
_ctf
_stream
_class
_set
_id
(self
._sc
, id)
1537 raise TypeError("Could not set stream class id.")
1540 def event_classes(self
):
1542 Generator returning the stream class' event classes.
1545 count
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
_count
(self
._sc
)
1548 raise TypeError("Could not get StreamClass' event class count")
1550 for i
in range(count
):
1551 event_class_native
= nbt
._bt
_ctf
_stream
_class
_get
_event
_class
(self
._sc
, i
)
1553 if event_class_native
is None:
1554 msg
= "Could not get StreamClass' event class at index {}".format(i
)
1555 raise TypeError(msg
)
1557 event_class
= EventClass
.__new
__(EventClass
)
1558 event_class
._ec
= event_class_native
1561 def add_event_class(self
, event_class
):
1563 Add an event class to a stream class. New events can be added even after a
1564 stream has been instantiated and events have been appended. However, a stream
1565 will not accept events of a class that has not been added to the stream
1569 if not isinstance(event_class
, EventClass
):
1570 raise TypeError("Invalid event_class type.")
1572 ret
= nbt
._bt
_ctf
_stream
_class
_add
_event
_class
(self
._sc
,
1576 raise ValueError("Could not add event class.")
1579 def packet_context_type(self
):
1581 Get the StreamClass' packet context type (StructureFieldDeclaration)
1584 field_type_native
= nbt
._bt
_ctf
_stream
_class
_get
_packet
_context
_type
(self
._sc
)
1586 if field_type_native
is None:
1587 raise ValueError("Invalid StreamClass")
1589 field_type
= FieldDeclaration
._create
_field
_declaration
_from
_native
_instance
(field_type_native
)
1593 @packet_context_type.setter
1594 def packet_context_type(self
, field_type
):
1596 Set a StreamClass' packet context type. Must be of type
1597 StructureFieldDeclaration.
1600 if not isinstance(field_type
, StructureFieldDeclaration
):
1601 raise TypeError("field_type argument must be of type StructureFieldDeclaration.")
1603 ret
= nbt
._bt
_ctf
_stream
_class
_set
_packet
_context
_type
(self
._sc
,
1607 raise ValueError("Failed to set packet context type.")
1612 raise NotImplementedError("Stream cannot be instantiated; use Writer.create_stream()")
1615 nbt
._bt
_ctf
_stream
_put
(self
._s
)
1618 def discarded_events(self
):
1620 Get a stream's discarded event count.
1623 ret
, count
= nbt
._bt
_ctf
_stream
_get
_discarded
_events
_count
(self
._s
)
1626 raise ValueError("Could not get the stream's discarded events count")
1630 def append_discarded_events(self
, event_count
):
1632 Increase the current packet's discarded event count.
1635 nbt
._bt
_ctf
_stream
_append
_discarded
_events
(self
._s
, event_count
)
1637 def append_event(self
, event
):
1639 Append "event" to the stream's current packet. The stream's associated clock
1640 will be sampled during this call. The event shall not be modified after
1641 being appended to a stream.
1644 ret
= nbt
._bt
_ctf
_stream
_append
_event
(self
._s
, event
._e
)
1647 raise ValueError("Could not append event to stream.")
1650 def packet_context(self
):
1652 Get a Stream's packet context field (a StructureField).
1655 native_field
= nbt
._bt
_ctf
_stream
_get
_packet
_context
(self
._s
)
1657 if native_field
is None:
1658 raise ValueError("Invalid Stream.")
1660 return Field
._create
_field
_from
_native
_instance
(native_field
)
1662 @packet_context.setter
1663 def packet_context(self
, field
):
1665 Set a Stream's packet context field (must be a StructureField).
1668 if not isinstance(field
, StructureField
):
1669 raise TypeError("Argument field must be of type StructureField")
1671 ret
= nbt
._bt
_ctf
_stream
_set
_packet
_context
(self
._s
, field
._f
)
1674 raise ValueError("Invalid packet context field.")
1678 The stream's current packet's events will be flushed to disk. Events
1679 subsequently appended to the stream will be added to a new packet.
1682 ret
= nbt
._bt
_ctf
_stream
_flush
(self
._s
)
1685 raise ValueError("Could not flush stream.")
1689 def __init__(self
, path
):
1691 Create a new writer that will produce a trace in the given path.
1694 self
._w
= nbt
._bt
_ctf
_writer
_create
(path
)
1697 raise ValueError("Writer creation failed.")
1700 nbt
._bt
_ctf
_writer
_put
(self
._w
)
1702 def create_stream(self
, stream_class
):
1704 Create a new stream instance and register it to the writer.
1707 if not isinstance(stream_class
, StreamClass
):
1708 raise TypeError("Invalid stream_class type.")
1710 stream
= Stream
.__new
__(Stream
)
1711 stream
._s
= nbt
._bt
_ctf
_writer
_create
_stream
(self
._w
, stream_class
._sc
)
1715 def add_environment_field(self
, name
, value
):
1717 Add an environment field to the trace.
1720 ret
= nbt
._bt
_ctf
_writer
_add
_environment
_field
(self
._w
, str(name
),
1724 raise ValueError("Could not add environment field to trace.")
1726 def add_clock(self
, clock
):
1728 Add a clock to the trace. Clocks assigned to stream classes must be
1729 registered to the writer.
1732 ret
= nbt
._bt
_ctf
_writer
_add
_clock
(self
._w
, clock
._c
)
1735 raise ValueError("Could not add clock to Writer.")
1740 Get the trace's TSDL meta-data.
1743 return nbt
._bt
_ctf
_writer
_get
_metadata
_string
(self
._w
)
1745 def flush_metadata(self
):
1747 Flush the trace's metadata to the metadata file.
1750 nbt
._bt
_ctf
_writer
_flush
_metadata
(self
._w
)
1753 def byte_order(self
):
1755 Get the trace's byte order. Must be a constant from the ByteOrder
1759 raise NotImplementedError("Getter not implemented.")
1762 def byte_order(self
, byte_order
):
1764 Set the trace's byte order. Must be a constant from the ByteOrder
1765 class. Defaults to the host machine's endianness
1768 ret
= nbt
._bt
_ctf
_writer
_set
_byte
_order
(self
._w
, byte_order
)
1771 raise ValueError("Could not set trace's byte order.")