X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Ftrace.py;h=1c56b034c400789beade4d3aff1f1fa55bcb2678;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hp=db8268db1cf82cb4473f941ba518ac6891358b87;hpb=2a52034afe45faa6321ca6f0cdcb46b08292fb04;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/trace.py b/src/bindings/python/bt2/bt2/trace.py index db8268db..1c56b034 100644 --- a/src/bindings/python/bt2/bt2/trace.py +++ b/src/bindings/python/bt2/bt2/trace.py @@ -1,37 +1,28 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# 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, object, utils -import bt2.field_class import collections.abc -import bt2.value -import bt2.stream -import bt2.trace_class +from bt2 import value as bt2_value +from bt2 import stream as bt2_stream +from bt2 import stream_class as bt2_stream_class import bt2 import functools import uuid as uuidp -class _TraceEnv(collections.abc.MutableMapping): +def _bt2_trace_class(): + from bt2 import trace_class as bt2_trace_class + + return bt2_trace_class + + +class _TraceEnvironmentConst(collections.abc.Mapping): + _create_value_from_ptr_and_get_ref = staticmethod( + bt2_value._create_from_const_ptr_and_get_ref + ) + def __init__(self, trace): self._trace = trace @@ -44,21 +35,7 @@ class _TraceEnv(collections.abc.MutableMapping): if value_ptr is None: raise KeyError(key) - return bt2.value._create_from_ptr_and_get_ref(value_ptr) - - def __setitem__(self, key, value): - if isinstance(value, str): - set_env_entry_fn = native_bt.trace_set_environment_entry_string - elif isinstance(value, int): - set_env_entry_fn = native_bt.trace_set_environment_entry_integer - else: - raise TypeError('expected str or int, got {}'.format(type(value))) - - status = set_env_entry_fn(self._trace._ptr, key, value) - utils._handle_func_status(status, "cannot set trace object's environment entry") - - def __delitem__(self, key): - raise NotImplementedError + return self._create_value_from_ptr_and_get_ref(value_ptr) def __len__(self): count = native_bt.trace_get_environment_entry_count(self._trace._ptr) @@ -66,7 +43,7 @@ class _TraceEnv(collections.abc.MutableMapping): return count def __iter__(self): - trace_ptr = self._trace_env._trace._ptr + trace_ptr = self._trace._ptr for idx in range(len(self)): borrow_entry_fn = native_bt.trace_borrow_environment_entry_by_index_const @@ -75,14 +52,43 @@ class _TraceEnv(collections.abc.MutableMapping): yield entry_name -def _trace_destruction_listener_from_native(user_listener, trace_ptr): - trace = bt2.trace._Trace._create_from_ptr_and_get_ref(trace_ptr) - user_listener(trace) +class _TraceEnvironment(_TraceEnvironmentConst, collections.abc.MutableMapping): + _create_value_from_ptr_and_get_ref = staticmethod( + bt2_value._create_from_ptr_and_get_ref + ) + + def __setitem__(self, key, value): + if isinstance(value, str): + set_env_entry_fn = native_bt.trace_set_environment_entry_string + elif isinstance(value, int): + set_env_entry_fn = native_bt.trace_set_environment_entry_integer + else: + raise TypeError("expected str or int, got {}".format(type(value))) + + status = set_env_entry_fn(self._trace._ptr, key, value) + utils._handle_func_status(status, "cannot set trace object's environment entry") + + def __delitem__(self, key): + raise NotImplementedError -class _Trace(object._SharedObject, collections.abc.Mapping): +class _TraceConst(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.trace_get_ref) _put_ref = staticmethod(native_bt.trace_put_ref) + _borrow_stream_ptr_by_id = staticmethod(native_bt.trace_borrow_stream_by_id_const) + _borrow_stream_ptr_by_index = staticmethod( + native_bt.trace_borrow_stream_by_index_const + ) + _borrow_class_ptr = staticmethod(native_bt.trace_borrow_class_const) + _borrow_user_attributes_ptr = staticmethod( + native_bt.trace_borrow_user_attributes_const + ) + _create_value_from_ptr_and_get_ref = staticmethod( + bt2_value._create_from_const_ptr_and_get_ref + ) + _stream_pycls = property(lambda _: bt2_stream._StreamConst) + _trace_class_pycls = property(lambda _: _bt2_trace_class()._TraceClassConst) + _trace_env_pycls = property(lambda _: _TraceEnvironmentConst) def __len__(self): count = native_bt.trace_get_stream_count(self._ptr) @@ -92,16 +98,16 @@ class _Trace(object._SharedObject, collections.abc.Mapping): def __getitem__(self, id): utils._check_uint64(id) - stream_ptr = native_bt.trace_borrow_stream_by_id_const(self._ptr, id) + stream_ptr = self._borrow_stream_ptr_by_id(self._ptr, id) if stream_ptr is None: raise KeyError(id) - return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr) + return self._stream_pycls._create_from_ptr_and_get_ref(stream_ptr) def __iter__(self): for idx in range(len(self)): - stream_ptr = native_bt.trace_borrow_stream_by_index_const(self._ptr, idx) + stream_ptr = self._borrow_stream_ptr_by_index(self._ptr, idx) assert stream_ptr is not None id = native_bt.stream_get_id(stream_ptr) @@ -111,14 +117,83 @@ class _Trace(object._SharedObject, collections.abc.Mapping): @property def cls(self): - trace_class_ptr = native_bt.trace_borrow_class(self._ptr) + trace_class_ptr = self._borrow_class_ptr(self._ptr) assert trace_class_ptr is not None - return bt2.trace_class._TraceClass._create_from_ptr_and_get_ref(trace_class_ptr) + return self._trace_class_pycls._create_from_ptr_and_get_ref(trace_class_ptr) + + @property + def user_attributes(self): + ptr = self._borrow_user_attributes_ptr(self._ptr) + assert ptr is not None + return self._create_value_from_ptr_and_get_ref(ptr) @property def name(self): return native_bt.trace_get_name(self._ptr) + @property + def uuid(self): + uuid_bytes = native_bt.trace_get_uuid(self._ptr) + if uuid_bytes is None: + return + + return uuidp.UUID(bytes=uuid_bytes) + + @property + def environment(self): + return self._trace_env_pycls(self) + + def add_destruction_listener(self, listener): + """Add a listener to be called when the trace is destroyed.""" + if not callable(listener): + raise TypeError("'listener' parameter is not callable") + + handle = utils._ListenerHandle(self.addr) + + fn = native_bt.bt2_trace_add_destruction_listener + listener_from_native = functools.partial( + _trace_destruction_listener_from_native, listener, handle + ) + + status, listener_id = fn(self._ptr, listener_from_native) + utils._handle_func_status( + status, "cannot add destruction listener to trace object" + ) + + 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 destruction listener does not match the trace object." + ) + + if listener_handle._listener_id is None: + raise ValueError("This trace destruction listener was already removed.") + + status = native_bt.trace_remove_destruction_listener( + self._ptr, listener_handle._listener_id + ) + utils._handle_func_status(status) + listener_handle._invalidate() + + +class _Trace(_TraceConst): + _borrow_stream_ptr_by_id = staticmethod(native_bt.trace_borrow_stream_by_id) + _borrow_stream_ptr_by_index = staticmethod(native_bt.trace_borrow_stream_by_index) + _borrow_class_ptr = staticmethod(native_bt.trace_borrow_class) + _borrow_user_attributes_ptr = staticmethod(native_bt.trace_borrow_user_attributes) + _create_value_from_ptr_and_get_ref = staticmethod( + bt2_value._create_from_ptr_and_get_ref + ) + _stream_pycls = property(lambda _: bt2_stream._Stream) + _trace_class_pycls = property(lambda _: _bt2_trace_class()._TraceClass) + _trace_env_pycls = property(lambda _: _TraceEnvironment) + def _name(self, name): utils._check_str(name) status = native_bt.trace_set_name(self._ptr, name) @@ -126,13 +201,12 @@ class _Trace(object._SharedObject, collections.abc.Mapping): _name = property(fset=_name) - @property - def uuid(self): - uuid_bytes = native_bt.trace_get_uuid(self._ptr) - if uuid_bytes is None: - return + def _user_attributes(self, user_attributes): + value = bt2_value.create_value(user_attributes) + utils._check_type(value, bt2_value.MapValue) + native_bt.trace_set_user_attributes(self._ptr, value._ptr) - return uuidp.UUID(bytes=uuid_bytes) + _user_attributes = property(fset=_user_attributes) def _uuid(self, uuid): utils._check_type(uuid, uuidp.UUID) @@ -140,12 +214,8 @@ class _Trace(object._SharedObject, collections.abc.Mapping): _uuid = property(fset=_uuid) - @property - def env(self): - return _TraceEnv(self) - - def create_stream(self, stream_class, id=None, name=None): - utils._check_type(stream_class, bt2.stream_class._StreamClass) + def create_stream(self, stream_class, id=None, name=None, user_attributes=None): + utils._check_type(stream_class, bt2_stream_class._StreamClass) if stream_class.assigns_automatic_stream_id: if id is not None: @@ -166,28 +236,20 @@ class _Trace(object._SharedObject, collections.abc.Mapping): ) if stream_ptr is None: - raise bt2._MemoryError('cannot create stream object') + raise bt2._MemoryError("cannot create stream object") - stream = bt2.stream._Stream._create_from_ptr(stream_ptr) + stream = bt2_stream._Stream._create_from_ptr(stream_ptr) if name is not None: stream._name = name - return stream - - def add_destruction_listener(self, listener): - '''Add a listener to be called when the trace is destroyed.''' - if not callable(listener): - raise TypeError("'listener' parameter is not callable") + if user_attributes is not None: + stream._user_attributes = user_attributes - fn = native_bt.bt2_trace_add_destruction_listener - listener_from_native = functools.partial( - _trace_destruction_listener_from_native, listener - ) + return stream - status, listener_id = fn(self._ptr, listener_from_native) - utils._handle_func_status( - status, 'cannot add destruction listener to trace object' - ) - return bt2.utils._ListenerHandle(listener_id, self) +def _trace_destruction_listener_from_native(user_listener, handle, trace_ptr): + trace = _TraceConst._create_from_ptr_and_get_ref(trace_ptr) + user_listener(trace) + handle._invalidate()