X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Ftrace_class.py;h=f66f385527934d5348e8e83ed9aa3730396db293;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hp=94343552b01031238c32dab38e7c23e52fd371f8;hpb=f0a42b33ac3951cd5cb2ee0f66ac04437a681621;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/trace_class.py b/src/bindings/python/bt2/bt2/trace_class.py index 94343552..f66f3855 100644 --- a/src/bindings/python/bt2/bt2/trace_class.py +++ b/src/bindings/python/bt2/bt2/trace_class.py @@ -1,41 +1,26 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx # Copyright (c) 2018 Francis Deslauriers # Copyright (c) 2019 Simon Marchi -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, utils, object from bt2 import stream_class as bt2_stream_class from bt2 import field_class as bt2_field_class +from bt2 import integer_range_set as bt2_integer_range_set from bt2 import trace as bt2_trace -from bt2 import trace_class as bt2_trace_class from bt2 import value as bt2_value import collections.abc import functools import bt2 -def _trace_class_destruction_listener_from_native(user_listener, trace_class_ptr): +def _trace_class_destruction_listener_from_native( + user_listener, handle, trace_class_ptr +): trace_class = _TraceClass._create_from_ptr_and_get_ref(trace_class_ptr) user_listener(trace_class) + handle._invalidate() class _TraceClassConst(object._SharedObject, collections.abc.Mapping): @@ -47,6 +32,9 @@ class _TraceClassConst(object._SharedObject, collections.abc.Mapping): _borrow_stream_class_ptr_by_id = staticmethod( native_bt.trace_class_borrow_stream_class_by_id_const ) + _borrow_user_attributes_ptr = staticmethod( + native_bt.trace_class_borrow_user_attributes_const + ) _stream_class_pycls = bt2_stream_class._StreamClassConst _create_value_from_ptr_and_get_ref = staticmethod( bt2_value._create_from_const_ptr_and_get_ref @@ -54,7 +42,7 @@ class _TraceClassConst(object._SharedObject, collections.abc.Mapping): @property def user_attributes(self): - ptr = native_bt.trace_class_borrow_user_attributes(self._ptr) + ptr = self._borrow_user_attributes_ptr(self._ptr) assert ptr is not None return self._create_value_from_ptr_and_get_ref(ptr) @@ -97,17 +85,40 @@ class _TraceClassConst(object._SharedObject, collections.abc.Mapping): if not callable(listener): raise TypeError("'listener' parameter is not callable") - fn = native_bt.bt2_trace_class_add_destruction_listener + handle = utils._ListenerHandle(self.addr) + listener_from_native = functools.partial( - _trace_class_destruction_listener_from_native, listener + _trace_class_destruction_listener_from_native, listener, handle ) + fn = native_bt.bt2_trace_class_add_destruction_listener status, listener_id = fn(self._ptr, listener_from_native) utils._handle_func_status( - status, 'cannot add destruction listener to trace class object' + status, "cannot add destruction listener to trace class object" ) - return utils._ListenerHandle(listener_id, self) + handle._set_listener_id(listener_id) + + return handle + + def remove_destruction_listener(self, listener_handle): + utils._check_type(listener_handle, utils._ListenerHandle) + + if listener_handle._addr != self.addr: + raise ValueError( + "This trace class destruction listener does not match the trace class object." + ) + + if listener_handle._listener_id is None: + raise ValueError( + "This trace class destruction listener was already removed." + ) + + status = native_bt.trace_class_remove_destruction_listener( + self._ptr, listener_handle._listener_id + ) + utils._handle_func_status(status) + listener_handle._invalidate() class _TraceClass(_TraceClassConst): @@ -117,6 +128,9 @@ class _TraceClass(_TraceClassConst): _borrow_stream_class_ptr_by_id = staticmethod( native_bt.trace_class_borrow_stream_class_by_id ) + _borrow_user_attributes_ptr = staticmethod( + native_bt.trace_class_borrow_user_attributes + ) _stream_class_pycls = bt2_stream_class._StreamClass _create_value_from_ptr_and_get_ref = staticmethod( bt2_value._create_from_ptr_and_get_ref @@ -128,7 +142,7 @@ class _TraceClass(_TraceClassConst): trace_ptr = native_bt.trace_create(self._ptr) if trace_ptr is None: - raise bt2._MemoryError('cannot create trace class object') + raise bt2._MemoryError("cannot create trace class object") trace = bt2_trace._Trace._create_from_ptr(trace_ptr) @@ -165,18 +179,35 @@ class _TraceClass(_TraceClassConst): supports_discarded_packets=False, discarded_packets_have_default_clock_snapshots=False, ): + # Validate parameters before we create the object. + bt2_stream_class._StreamClass._validate_create_params( + name, + user_attributes, + packet_context_field_class, + event_common_context_field_class, + default_clock_class, + assigns_automatic_event_class_id, + assigns_automatic_stream_id, + supports_packets, + packets_have_beginning_default_clock_snapshot, + packets_have_end_default_clock_snapshot, + supports_discarded_events, + discarded_events_have_default_clock_snapshots, + supports_discarded_packets, + discarded_packets_have_default_clock_snapshots, + ) if self.assigns_automatic_stream_class_id: if id is not None: raise ValueError( - 'id provided, but trace class assigns automatic stream class ids' + "id provided, but trace class assigns automatic stream class ids" ) sc_ptr = native_bt.stream_class_create(self._ptr) else: if id is None: raise ValueError( - 'id not provided, but trace class does not assign automatic stream class ids' + "id not provided, but trace class does not assign automatic stream class ids" ) utils._check_uint64(id) @@ -243,7 +274,7 @@ class _TraceClass(_TraceClassConst): def _check_field_class_create_status(self, ptr, type_name): if ptr is None: - raise bt2._MemoryError('cannot create {} field class'.format(type_name)) + raise bt2._MemoryError("cannot create {} field class".format(type_name)) @staticmethod def _set_field_class_user_attrs(fc, user_attributes): @@ -252,7 +283,7 @@ class _TraceClass(_TraceClassConst): def create_bool_field_class(self, user_attributes=None): field_class_ptr = native_bt.field_class_bool_create(self._ptr) - self._check_field_class_create_status(field_class_ptr, 'boolean') + self._check_field_class_create_status(field_class_ptr, "boolean") fc = bt2_field_class._BoolFieldClass._create_from_ptr(field_class_ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc @@ -262,13 +293,13 @@ class _TraceClass(_TraceClassConst): if length < 1 or length > 64: raise ValueError( - 'invalid length {}: expecting a value in the [1, 64] range'.format( + "invalid length {}: expecting a value in the [1, 64] range".format( length ) ) field_class_ptr = native_bt.field_class_bit_array_create(self._ptr, length) - self._check_field_class_create_status(field_class_ptr, 'bit array') + self._check_field_class_create_status(field_class_ptr, "bit array") fc = bt2_field_class._BitArrayFieldClass._create_from_ptr(field_class_ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc @@ -302,7 +333,7 @@ class _TraceClass(_TraceClassConst): return self._create_integer_field_class( native_bt.field_class_integer_signed_create, bt2_field_class._SignedIntegerFieldClass, - 'signed integer', + "signed integer", field_value_range, preferred_display_base, user_attributes, @@ -314,7 +345,7 @@ class _TraceClass(_TraceClassConst): return self._create_integer_field_class( native_bt.field_class_integer_unsigned_create, bt2_field_class._UnsignedIntegerFieldClass, - 'unsigned integer', + "unsigned integer", field_value_range, preferred_display_base, user_attributes, @@ -326,7 +357,7 @@ class _TraceClass(_TraceClassConst): return self._create_integer_field_class( native_bt.field_class_enumeration_signed_create, bt2_field_class._SignedEnumerationFieldClass, - 'signed enumeration', + "signed enumeration", field_value_range, preferred_display_base, user_attributes, @@ -338,33 +369,46 @@ class _TraceClass(_TraceClassConst): return self._create_integer_field_class( native_bt.field_class_enumeration_unsigned_create, bt2_field_class._UnsignedEnumerationFieldClass, - 'unsigned enumeration', + "unsigned enumeration", field_value_range, preferred_display_base, user_attributes, ) - def create_real_field_class(self, is_single_precision=False, user_attributes=None): - field_class_ptr = native_bt.field_class_real_create(self._ptr) - self._check_field_class_create_status(field_class_ptr, 'real') + def create_single_precision_real_field_class(self, user_attributes=None): + field_class_ptr = native_bt.field_class_real_single_precision_create(self._ptr) + self._check_field_class_create_status(field_class_ptr, "single-precision real") - field_class = bt2_field_class._RealFieldClass._create_from_ptr(field_class_ptr) + field_class = bt2_field_class._SinglePrecisionRealFieldClass._create_from_ptr( + field_class_ptr + ) + + self._set_field_class_user_attrs(field_class, user_attributes) + + return field_class + + def create_double_precision_real_field_class(self, user_attributes=None): + field_class_ptr = native_bt.field_class_real_double_precision_create(self._ptr) + self._check_field_class_create_status(field_class_ptr, "double-precision real") + + field_class = bt2_field_class._DoublePrecisionRealFieldClass._create_from_ptr( + field_class_ptr + ) - field_class._is_single_precision = is_single_precision self._set_field_class_user_attrs(field_class, user_attributes) return field_class def create_structure_field_class(self, user_attributes=None): field_class_ptr = native_bt.field_class_structure_create(self._ptr) - self._check_field_class_create_status(field_class_ptr, 'structure') + self._check_field_class_create_status(field_class_ptr, "structure") fc = bt2_field_class._StructureFieldClass._create_from_ptr(field_class_ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc def create_string_field_class(self, user_attributes=None): field_class_ptr = native_bt.field_class_string_create(self._ptr) - self._check_field_class_create_status(field_class_ptr, 'string') + self._check_field_class_create_status(field_class_ptr, "string") fc = bt2_field_class._StringFieldClass._create_from_ptr(field_class_ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc @@ -373,8 +417,8 @@ class _TraceClass(_TraceClassConst): utils._check_type(elem_fc, bt2_field_class._FieldClass) utils._check_uint64(length) ptr = native_bt.field_class_array_static_create(self._ptr, elem_fc._ptr, length) - self._check_field_class_create_status(ptr, 'static array') - fc = bt2_field_class._StaticArrayFieldClass._create_from_ptr_and_get_ref(ptr) + self._check_field_class_create_status(ptr, "static array") + fc = bt2_field_class._StaticArrayFieldClass._create_from_ptr(ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc @@ -391,27 +435,62 @@ class _TraceClass(_TraceClassConst): ptr = native_bt.field_class_array_dynamic_create( self._ptr, elem_fc._ptr, length_fc_ptr ) - self._check_field_class_create_status(ptr, 'dynamic array') - fc = bt2_field_class._DynamicArrayFieldClass._create_from_ptr(ptr) + self._check_field_class_create_status(ptr, "dynamic array") + fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc - def create_option_field_class( - self, content_fc, selector_fc=None, user_attributes=None + def create_option_without_selector_field_class( + self, content_fc, user_attributes=None ): utils._check_type(content_fc, bt2_field_class._FieldClass) + ptr = native_bt.field_class_option_without_selector_create( + self._ptr, content_fc._ptr + ) + self._check_field_class_create_status(ptr, "option") + fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr) + self._set_field_class_user_attrs(fc, user_attributes) + return fc - selector_fc_ptr = None + def create_option_with_bool_selector_field_class( + self, content_fc, selector_fc, selector_is_reversed=False, user_attributes=None + ): + utils._check_type(content_fc, bt2_field_class._FieldClass) + utils._check_bool(selector_is_reversed) + utils._check_type(selector_fc, bt2_field_class._BoolFieldClass) + ptr = native_bt.field_class_option_with_selector_field_bool_create( + self._ptr, content_fc._ptr, selector_fc._ptr + ) + self._check_field_class_create_status(ptr, "option") + fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr) + self._set_field_class_user_attrs(fc, user_attributes) + fc._selector_is_reversed = selector_is_reversed + return fc - if selector_fc is not None: - utils._check_type(selector_fc, bt2_field_class._BoolFieldClass) - selector_fc_ptr = selector_fc._ptr + def create_option_with_integer_selector_field_class( + self, content_fc, selector_fc, ranges, user_attributes=None + ): + utils._check_type(content_fc, bt2_field_class._FieldClass) + utils._check_type(selector_fc, bt2_field_class._IntegerFieldClass) - ptr = native_bt.field_class_option_create( - self._ptr, content_fc._ptr, selector_fc_ptr - ) - self._check_field_class_create_status(ptr, 'option') - fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr) + if len(ranges) == 0: + raise ValueError("integer range set is empty") + + if isinstance(selector_fc, bt2_field_class._UnsignedIntegerFieldClass): + utils._check_type(ranges, bt2_integer_range_set.UnsignedIntegerRangeSet) + ptr = native_bt.field_class_option_with_selector_field_integer_unsigned_create( + self._ptr, content_fc._ptr, selector_fc._ptr, ranges._ptr + ) + else: + utils._check_type(ranges, bt2_integer_range_set.SignedIntegerRangeSet) + ptr = ( + native_bt.field_class_option_with_selector_field_integer_signed_create( + self._ptr, content_fc._ptr, selector_fc._ptr, ranges._ptr + ) + ) + + self._check_field_class_create_status(ptr, "option") + fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc @@ -423,7 +502,7 @@ class _TraceClass(_TraceClassConst): selector_fc_ptr = selector_fc._ptr ptr = native_bt.field_class_variant_create(self._ptr, selector_fc_ptr) - self._check_field_class_create_status(ptr, 'variant') - fc = bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr) + self._check_field_class_create_status(ptr, "variant") + fc = bt2_field_class._obj_type_from_field_class_ptr(ptr)._create_from_ptr(ptr) self._set_field_class_user_attrs(fc, user_attributes) return fc