X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Ftrace_class.py;h=94343552b01031238c32dab38e7c23e52fd371f8;hb=f0a42b33ac3951cd5cb2ee0f66ac04437a681621;hp=fb0eb543f10793b425b94dbb5d9d58350e06009d;hpb=1367bc7ce5e43057c3a2c00a8f4fa2130259ea76;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/trace_class.py b/src/bindings/python/bt2/bt2/trace_class.py index fb0eb543..94343552 100644 --- a/src/bindings/python/bt2/bt2/trace_class.py +++ b/src/bindings/python/bt2/bt2/trace_class.py @@ -22,64 +22,41 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. -__all__ = ['_TraceClass'] - -import bt2 from bt2 import native_bt, utils, object -import bt2.stream_class -import bt2.field_class +from bt2 import stream_class as bt2_stream_class +from bt2 import field_class as bt2_field_class +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 - - -class _StreamClassIterator(collections.abc.Iterator): - def __init__(self, trace_class): - self._trace_class = trace_class - self._at = 0 - - def __next__(self): - if self._at == len(self._trace_class): - raise StopIteration - - borrow_stream_class_fn = native_bt.trace_class_borrow_stream_class_by_index_const - sc_ptr = borrow_stream_class_fn(self._trace_class._ptr, self._at) - assert sc_ptr - id = native_bt.stream_class_get_id(sc_ptr) - assert id >= 0 - self._at += 1 - return id +import bt2 def _trace_class_destruction_listener_from_native(user_listener, trace_class_ptr): - trace_class = bt2.trace_class._TraceClass._create_from_ptr_and_get_ref(trace_class_ptr) + trace_class = _TraceClass._create_from_ptr_and_get_ref(trace_class_ptr) user_listener(trace_class) -class _TraceClass(object._SharedObject, collections.abc.Mapping): +class _TraceClassConst(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.trace_class_get_ref) _put_ref = staticmethod(native_bt.trace_class_put_ref) + _borrow_stream_class_ptr_by_index = staticmethod( + native_bt.trace_class_borrow_stream_class_by_index_const + ) + _borrow_stream_class_ptr_by_id = staticmethod( + native_bt.trace_class_borrow_stream_class_by_id_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 + ) - # Instantiate a trace of this class. - - def __call__(self, name=None, uuid=None, env=None): - trace_ptr = native_bt.trace_create(self._ptr) - - if trace_ptr is None: - raise bt2.CreationError('cannot create trace class object') - - trace = bt2.trace._Trace._create_from_ptr(trace_ptr) - - if name is not None: - trace._name = name - - if uuid is not None: - trace._uuid = uuid - - if env is not None: - for key, value in env.items(): - trace.env[key] = value - - return trace + @property + def user_attributes(self): + ptr = native_bt.trace_class_borrow_user_attributes(self._ptr) + assert ptr is not None + return self._create_value_from_ptr_and_get_ref(ptr) # Number of stream classes in this trace class. @@ -93,15 +70,15 @@ class _TraceClass(object._SharedObject, collections.abc.Mapping): def __getitem__(self, key): utils._check_uint64(key) - sc_ptr = native_bt.trace_class_borrow_stream_class_by_id_const(self._ptr, key) + sc_ptr = self._borrow_stream_class_ptr_by_id(self._ptr, key) if sc_ptr is None: raise KeyError(key) - return bt2.stream_class._StreamClass._create_from_ptr_and_get_ref(sc_ptr) + return self._stream_class_pycls._create_from_ptr_and_get_ref(sc_ptr) def __iter__(self): for idx in range(len(self)): - sc_ptr = native_bt.trace_class_borrow_stream_class_by_index_const(self._ptr, idx) + sc_ptr = self._borrow_stream_class_ptr_by_index(self._ptr, idx) assert sc_ptr is not None id = native_bt.stream_class_get_id(sc_ptr) @@ -109,38 +86,110 @@ class _TraceClass(object._SharedObject, collections.abc.Mapping): yield id - def create_stream_class(self, id=None, - name=None, - packet_context_field_class=None, - event_common_context_field_class=None, - default_clock_class=None, - assigns_automatic_event_class_id=True, - assigns_automatic_stream_id=True, - supports_packets=False, - packets_have_beginning_default_clock_snapshot=False, - packets_have_end_default_clock_snapshot=False, - supports_discarded_events=False, - discarded_events_have_default_clock_snapshots=False, - supports_discarded_packets=False, - discarded_packets_have_default_clock_snapshots=False): + @property + def assigns_automatic_stream_class_id(self): + return native_bt.trace_class_assigns_automatic_stream_class_id(self._ptr) + + # Add a listener to be called when the trace class is destroyed. + + def add_destruction_listener(self, listener): + + if not callable(listener): + raise TypeError("'listener' parameter is not callable") + + fn = native_bt.bt2_trace_class_add_destruction_listener + listener_from_native = functools.partial( + _trace_class_destruction_listener_from_native, listener + ) + + status, listener_id = fn(self._ptr, listener_from_native) + utils._handle_func_status( + status, 'cannot add destruction listener to trace class object' + ) + + return utils._ListenerHandle(listener_id, self) + + +class _TraceClass(_TraceClassConst): + _borrow_stream_class_ptr_by_index = staticmethod( + native_bt.trace_class_borrow_stream_class_by_index + ) + _borrow_stream_class_ptr_by_id = staticmethod( + native_bt.trace_class_borrow_stream_class_by_id + ) + _stream_class_pycls = bt2_stream_class._StreamClass + _create_value_from_ptr_and_get_ref = staticmethod( + bt2_value._create_from_ptr_and_get_ref + ) + + # Instantiate a trace of this class. + + def __call__(self, name=None, user_attributes=None, uuid=None, environment=None): + trace_ptr = native_bt.trace_create(self._ptr) + + if trace_ptr is None: + raise bt2._MemoryError('cannot create trace class object') + + trace = bt2_trace._Trace._create_from_ptr(trace_ptr) + + if name is not None: + trace._name = name + + if user_attributes is not None: + trace._user_attributes = user_attributes + + if uuid is not None: + trace._uuid = uuid + + if environment is not None: + for key, value in environment.items(): + trace.environment[key] = value + + return trace + + def create_stream_class( + self, + id=None, + name=None, + user_attributes=None, + packet_context_field_class=None, + event_common_context_field_class=None, + default_clock_class=None, + assigns_automatic_event_class_id=True, + assigns_automatic_stream_id=True, + supports_packets=False, + packets_have_beginning_default_clock_snapshot=False, + packets_have_end_default_clock_snapshot=False, + supports_discarded_events=False, + discarded_events_have_default_clock_snapshots=False, + supports_discarded_packets=False, + discarded_packets_have_default_clock_snapshots=False, + ): if self.assigns_automatic_stream_class_id: if id is not None: - raise ValueError('id provided, but trace class assigns automatic stream class ids') + raise ValueError( + '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') + raise ValueError( + 'id not provided, but trace class does not assign automatic stream class ids' + ) utils._check_uint64(id) sc_ptr = native_bt.stream_class_create_with_id(self._ptr, id) - sc = bt2.stream_class._StreamClass._create_from_ptr(sc_ptr) + sc = bt2_stream_class._StreamClass._create_from_ptr(sc_ptr) if name is not None: sc._name = name + if user_attributes is not None: + sc._user_attributes = user_attributes + if event_common_context_field_class is not None: sc._event_common_context_field_class = event_common_context_field_class @@ -151,9 +200,11 @@ class _TraceClass(object._SharedObject, collections.abc.Mapping): # `packets_have_beginning_default_clock_snapshot` or # `packets_have_end_default_clock_snapshot` is true, then this # stream class needs a default clock class already. - sc._set_supports_packets(supports_packets, - packets_have_beginning_default_clock_snapshot, - packets_have_end_default_clock_snapshot) + sc._set_supports_packets( + supports_packets, + packets_have_beginning_default_clock_snapshot, + packets_have_end_default_clock_snapshot, + ) # call after sc._set_supports_packets() because, if # `packet_context_field_class` is not `None`, then this stream @@ -163,32 +214,76 @@ class _TraceClass(object._SharedObject, collections.abc.Mapping): sc._assigns_automatic_event_class_id = assigns_automatic_event_class_id sc._assigns_automatic_stream_id = assigns_automatic_stream_id - sc._set_supports_discarded_events(supports_discarded_events, - discarded_events_have_default_clock_snapshots) - sc._set_supports_discarded_packets(supports_discarded_packets, - discarded_packets_have_default_clock_snapshots) + sc._set_supports_discarded_events( + supports_discarded_events, discarded_events_have_default_clock_snapshots + ) + sc._set_supports_discarded_packets( + supports_discarded_packets, discarded_packets_have_default_clock_snapshots + ) return sc - @property - def assigns_automatic_stream_class_id(self): - return native_bt.trace_class_assigns_automatic_stream_class_id(self._ptr) + def _user_attributes(self, user_attributes): + value = bt2_value.create_value(user_attributes) + utils._check_type(value, bt2_value.MapValue) + native_bt.trace_class_set_user_attributes(self._ptr, value._ptr) + + _user_attributes = property(fset=_user_attributes) def _assigns_automatic_stream_class_id(self, auto_id): utils._check_bool(auto_id) - return native_bt.trace_class_set_assigns_automatic_stream_class_id(self._ptr, auto_id) + return native_bt.trace_class_set_assigns_automatic_stream_class_id( + self._ptr, auto_id + ) - _assigns_automatic_stream_class_id = property(fset=_assigns_automatic_stream_class_id) + _assigns_automatic_stream_class_id = property( + fset=_assigns_automatic_stream_class_id + ) # Field class creation methods. - def _check_create_status(self, ptr, type_name): + def _check_field_class_create_status(self, ptr, type_name): if ptr is None: - raise bt2.CreationError( - 'cannot create {} field class'.format(type_name)) + raise bt2._MemoryError('cannot create {} field class'.format(type_name)) - def _create_integer_field_class(self, create_func, py_cls, type_name, field_value_range, preferred_display_base): + @staticmethod + def _set_field_class_user_attrs(fc, user_attributes): + if user_attributes is not None: + fc._user_attributes = user_attributes + + 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') + fc = bt2_field_class._BoolFieldClass._create_from_ptr(field_class_ptr) + self._set_field_class_user_attrs(fc, user_attributes) + return fc + + def create_bit_array_field_class(self, length, user_attributes=None): + utils._check_uint64(length) + + if length < 1 or length > 64: + raise ValueError( + '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') + fc = bt2_field_class._BitArrayFieldClass._create_from_ptr(field_class_ptr) + self._set_field_class_user_attrs(fc, user_attributes) + return fc + + def _create_integer_field_class( + self, + create_func, + py_cls, + type_name, + field_value_range, + preferred_display_base, + user_attributes, + ): field_class_ptr = create_func(self._ptr) - self._check_create_status(field_class_ptr, type_name) + self._check_field_class_create_status(field_class_ptr, type_name) field_class = py_cls._create_from_ptr(field_class_ptr) @@ -198,94 +293,137 @@ class _TraceClass(object._SharedObject, collections.abc.Mapping): if preferred_display_base is not None: field_class._preferred_display_base = preferred_display_base + self._set_field_class_user_attrs(field_class, user_attributes) return field_class - def create_signed_integer_field_class(self, field_value_range=None, preferred_display_base=None): - return self._create_integer_field_class(native_bt.field_class_signed_integer_create, - bt2.field_class._SignedIntegerFieldClass, - 'signed integer', field_value_range, preferred_display_base) - - def create_unsigned_integer_field_class(self, field_value_range=None, preferred_display_base=None): - return self._create_integer_field_class(native_bt.field_class_unsigned_integer_create, - bt2.field_class._UnsignedIntegerFieldClass, - 'unsigned integer', field_value_range, preferred_display_base) - - def create_signed_enumeration_field_class(self, field_value_range=None, preferred_display_base=None): - return self._create_integer_field_class(native_bt.field_class_signed_enumeration_create, - bt2.field_class._SignedEnumerationFieldClass, - 'signed enumeration', field_value_range, preferred_display_base) - - def create_unsigned_enumeration_field_class(self, field_value_range=None, preferred_display_base=None): - return self._create_integer_field_class(native_bt.field_class_unsigned_enumeration_create, - bt2.field_class._UnsignedEnumerationFieldClass, - 'unsigned enumeration', field_value_range, preferred_display_base) - - def create_real_field_class(self, is_single_precision=False): + def create_signed_integer_field_class( + self, field_value_range=None, preferred_display_base=None, user_attributes=None + ): + return self._create_integer_field_class( + native_bt.field_class_integer_signed_create, + bt2_field_class._SignedIntegerFieldClass, + 'signed integer', + field_value_range, + preferred_display_base, + user_attributes, + ) + + def create_unsigned_integer_field_class( + self, field_value_range=None, preferred_display_base=None, user_attributes=None + ): + return self._create_integer_field_class( + native_bt.field_class_integer_unsigned_create, + bt2_field_class._UnsignedIntegerFieldClass, + 'unsigned integer', + field_value_range, + preferred_display_base, + user_attributes, + ) + + def create_signed_enumeration_field_class( + self, field_value_range=None, preferred_display_base=None, user_attributes=None + ): + return self._create_integer_field_class( + native_bt.field_class_enumeration_signed_create, + bt2_field_class._SignedEnumerationFieldClass, + 'signed enumeration', + field_value_range, + preferred_display_base, + user_attributes, + ) + + def create_unsigned_enumeration_field_class( + self, field_value_range=None, preferred_display_base=None, user_attributes=None + ): + return self._create_integer_field_class( + native_bt.field_class_enumeration_unsigned_create, + bt2_field_class._UnsignedEnumerationFieldClass, + '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_create_status(field_class_ptr, 'real') + self._check_field_class_create_status(field_class_ptr, 'real') - field_class = bt2.field_class._RealFieldClass._create_from_ptr(field_class_ptr) + field_class = bt2_field_class._RealFieldClass._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): + def create_structure_field_class(self, user_attributes=None): field_class_ptr = native_bt.field_class_structure_create(self._ptr) - self._check_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 - return bt2.field_class._StructureFieldClass._create_from_ptr(field_class_ptr) - - def create_string_field_class(self): + def create_string_field_class(self, user_attributes=None): field_class_ptr = native_bt.field_class_string_create(self._ptr) - self._check_create_status(field_class_ptr, 'string') - - return bt2.field_class._StringFieldClass._create_from_ptr(field_class_ptr) + 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 - def create_static_array_field_class(self, elem_fc, length): - utils._check_type(elem_fc, bt2.field_class._FieldClass) + def create_static_array_field_class(self, elem_fc, length, user_attributes=None): + utils._check_type(elem_fc, bt2_field_class._FieldClass) utils._check_uint64(length) - ptr = native_bt.field_class_static_array_create(self._ptr, elem_fc._ptr, length) - self._check_create_status(ptr, 'static array') - - return bt2.field_class._StaticArrayFieldClass._create_from_ptr_and_get_ref(ptr) - - def create_dynamic_array_field_class(self, elem_fc, length_fc=None): - utils._check_type(elem_fc, bt2.field_class._FieldClass) + 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._set_field_class_user_attrs(fc, user_attributes) + return fc + + def create_dynamic_array_field_class( + self, elem_fc, length_fc=None, user_attributes=None + ): + utils._check_type(elem_fc, bt2_field_class._FieldClass) length_fc_ptr = None if length_fc is not None: - utils._check_type(length_fc, bt2.field_class._UnsignedIntegerFieldClass) + utils._check_type(length_fc, bt2_field_class._UnsignedIntegerFieldClass) length_fc_ptr = length_fc._ptr - ptr = native_bt.field_class_dynamic_array_create(self._ptr, elem_fc._ptr, length_fc_ptr) - self._check_create_status(ptr, 'dynamic array') - return bt2.field_class._DynamicArrayFieldClass._create_from_ptr(ptr) + 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._set_field_class_user_attrs(fc, user_attributes) + return fc + + def create_option_field_class( + self, content_fc, selector_fc=None, user_attributes=None + ): + utils._check_type(content_fc, bt2_field_class._FieldClass) - def create_variant_field_class(self, selector_fc=None): selector_fc_ptr = None if selector_fc is not None: - utils._check_type(selector_fc, bt2.field_class._IntegerFieldClass) + utils._check_type(selector_fc, bt2_field_class._BoolFieldClass) selector_fc_ptr = selector_fc._ptr - ptr = native_bt.field_class_variant_create(self._ptr, selector_fc_ptr) - self._check_create_status(ptr, 'variant') - return bt2.field_class._create_field_class_from_ptr_and_get_ref(ptr) - - # Add a listener to be called when the trace class is destroyed. + 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) + self._set_field_class_user_attrs(fc, user_attributes) + return fc - def add_destruction_listener(self, listener): - - if not callable(listener): - raise TypeError("'listener' parameter is not callable") - - fn = native_bt.bt2_trace_class_add_destruction_listener - listener_from_native = functools.partial(_trace_class_destruction_listener_from_native, - listener) + def create_variant_field_class(self, selector_fc=None, user_attributes=None): + selector_fc_ptr = None - listener_id = fn(self._ptr, listener_from_native) - if listener_id is None: - utils._raise_bt2_error('cannot add destruction listener to trace class object') + if selector_fc is not None: + utils._check_type(selector_fc, bt2_field_class._IntegerFieldClass) + selector_fc_ptr = selector_fc._ptr - return bt2._ListenerHandle(listener_id, self) + 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._set_field_class_user_attrs(fc, user_attributes) + return fc