src/bindings/python/bt2/bt2/trace.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt, object, utils
  24 import collections.abc
  25 from bt2 import value as bt2_value
  26 from bt2 import stream as bt2_stream
  27 from bt2 import stream_class as bt2_stream_class
  28 import bt2
  29 import functools
  30 import uuid as uuidp
  31
  32
  33 def _bt2_trace_class():
  34     from bt2 import trace_class as bt2_trace_class
  35
  36     return bt2_trace_class
  37
  38
  39 class _TraceEnvironmentConst(collections.abc.Mapping):
  40     _create_value_from_ptr_and_get_ref = staticmethod(
  41         bt2_value._create_from_const_ptr_and_get_ref
  42     )
  43
  44     def __init__(self, trace):
  45         self._trace = trace
  46
  47     def __getitem__(self, key):
  48         utils._check_str(key)
  49
  50         borrow_entry_fn = native_bt.trace_borrow_environment_entry_value_by_name_const
  51         value_ptr = borrow_entry_fn(self._trace._ptr, key)
  52
  53         if value_ptr is None:
  54             raise KeyError(key)
  55
  56         return self._create_value_from_ptr_and_get_ref(value_ptr)
  57
  58     def __len__(self):
  59         count = native_bt.trace_get_environment_entry_count(self._trace._ptr)
  60         assert count >= 0
  61         return count
  62
  63     def __iter__(self):
  64         trace_ptr = self._trace._ptr
  65
  66         for idx in range(len(self)):
  67             borrow_entry_fn = native_bt.trace_borrow_environment_entry_by_index_const
  68             entry_name, _ = borrow_entry_fn(trace_ptr, idx)
  69             assert entry_name is not None
  70             yield entry_name
  71
  72
  73 class _TraceEnvironment(_TraceEnvironmentConst, collections.abc.MutableMapping):
  74     _create_value_from_ptr_and_get_ref = staticmethod(
  75         bt2_value._create_from_ptr_and_get_ref
  76     )
  77
  78     def __setitem__(self, key, value):
  79         if isinstance(value, str):
  80             set_env_entry_fn = native_bt.trace_set_environment_entry_string
  81         elif isinstance(value, int):
  82             set_env_entry_fn = native_bt.trace_set_environment_entry_integer
  83         else:
  84             raise TypeError('expected str or int, got {}'.format(type(value)))
  85
  86         status = set_env_entry_fn(self._trace._ptr, key, value)
  87         utils._handle_func_status(status, "cannot set trace object's environment entry")
  88
  89     def __delitem__(self, key):
  90         raise NotImplementedError
  91
  92
  93 class _TraceConst(object._SharedObject, collections.abc.Mapping):
  94     _get_ref = staticmethod(native_bt.trace_get_ref)
  95     _put_ref = staticmethod(native_bt.trace_put_ref)
  96     _borrow_stream_ptr_by_id = staticmethod(native_bt.trace_borrow_stream_by_id_const)
  97     _borrow_stream_ptr_by_index = staticmethod(
  98         native_bt.trace_borrow_stream_by_index_const
  99     )
 100     _borrow_class_ptr = staticmethod(native_bt.trace_borrow_class_const)
 101     _borrow_user_attributes_ptr = staticmethod(
 102         native_bt.trace_borrow_user_attributes_const
 103     )
 104     _create_value_from_ptr_and_get_ref = staticmethod(
 105         bt2_value._create_from_const_ptr_and_get_ref
 106     )
 107     _stream_pycls = property(lambda _: bt2_stream._StreamConst)
 108     _trace_class_pycls = property(lambda _: _bt2_trace_class()._TraceClassConst)
 109     _trace_env_pycls = property(lambda _: _TraceEnvironmentConst)
 110
 111     def __len__(self):
 112         count = native_bt.trace_get_stream_count(self._ptr)
 113         assert count >= 0
 114         return count
 115
 116     def __getitem__(self, id):
 117         utils._check_uint64(id)
 118
 119         stream_ptr = self._borrow_stream_ptr_by_id(self._ptr, id)
 120
 121         if stream_ptr is None:
 122             raise KeyError(id)
 123
 124         return self._stream_pycls._create_from_ptr_and_get_ref(stream_ptr)
 125
 126     def __iter__(self):
 127         for idx in range(len(self)):
 128             stream_ptr = self._borrow_stream_ptr_by_index(self._ptr, idx)
 129             assert stream_ptr is not None
 130
 131             id = native_bt.stream_get_id(stream_ptr)
 132             assert id >= 0
 133
 134             yield id
 135
 136     @property
 137     def cls(self):
 138         trace_class_ptr = self._borrow_class_ptr(self._ptr)
 139         assert trace_class_ptr is not None
 140         return self._trace_class_pycls._create_from_ptr_and_get_ref(trace_class_ptr)
 141
 142     @property
 143     def user_attributes(self):
 144         ptr = self._borrow_user_attributes_ptr(self._ptr)
 145         assert ptr is not None
 146         return self._create_value_from_ptr_and_get_ref(ptr)
 147
 148     @property
 149     def name(self):
 150         return native_bt.trace_get_name(self._ptr)
 151
 152     @property
 153     def uuid(self):
 154         uuid_bytes = native_bt.trace_get_uuid(self._ptr)
 155         if uuid_bytes is None:
 156             return
 157
 158         return uuidp.UUID(bytes=uuid_bytes)
 159
 160     @property
 161     def environment(self):
 162         return self._trace_env_pycls(self)
 163
 164     def add_destruction_listener(self, listener):
 165         '''Add a listener to be called when the trace is destroyed.'''
 166         if not callable(listener):
 167             raise TypeError("'listener' parameter is not callable")
 168
 169         handle = utils._ListenerHandle(self.addr)
 170
 171         fn = native_bt.bt2_trace_add_destruction_listener
 172         listener_from_native = functools.partial(
 173             _trace_destruction_listener_from_native, listener, handle
 174         )
 175
 176         status, listener_id = fn(self._ptr, listener_from_native)
 177         utils._handle_func_status(
 178             status, 'cannot add destruction listener to trace object'
 179         )
 180
 181         handle._set_listener_id(listener_id)
 182
 183         return handle
 184
 185     def remove_destruction_listener(self, listener_handle):
 186         utils._check_type(listener_handle, utils._ListenerHandle)
 187
 188         if listener_handle._addr != self.addr:
 189             raise ValueError(
 190                 'This trace destruction listener does not match the trace object.'
 191             )
 192
 193         if listener_handle._listener_id is None:
 194             raise ValueError('This trace destruction listener was already removed.')
 195
 196         status = native_bt.trace_remove_destruction_listener(
 197             self._ptr, listener_handle._listener_id
 198         )
 199         utils._handle_func_status(status)
 200         listener_handle._invalidate()
 201
 202
 203 class _Trace(_TraceConst):
 204     _borrow_stream_ptr_by_id = staticmethod(native_bt.trace_borrow_stream_by_id)
 205     _borrow_stream_ptr_by_index = staticmethod(native_bt.trace_borrow_stream_by_index)
 206     _borrow_class_ptr = staticmethod(native_bt.trace_borrow_class)
 207     _borrow_user_attributes_ptr = staticmethod(native_bt.trace_borrow_user_attributes)
 208     _create_value_from_ptr_and_get_ref = staticmethod(
 209         bt2_value._create_from_ptr_and_get_ref
 210     )
 211     _stream_pycls = property(lambda _: bt2_stream._Stream)
 212     _trace_class_pycls = property(lambda _: _bt2_trace_class()._TraceClass)
 213     _trace_env_pycls = property(lambda _: _TraceEnvironment)
 214
 215     def _name(self, name):
 216         utils._check_str(name)
 217         status = native_bt.trace_set_name(self._ptr, name)
 218         utils._handle_func_status(status, "cannot set trace class object's name")
 219
 220     _name = property(fset=_name)
 221
 222     def _user_attributes(self, user_attributes):
 223         value = bt2_value.create_value(user_attributes)
 224         utils._check_type(value, bt2_value.MapValue)
 225         native_bt.trace_set_user_attributes(self._ptr, value._ptr)
 226
 227     _user_attributes = property(fset=_user_attributes)
 228
 229     def _uuid(self, uuid):
 230         utils._check_type(uuid, uuidp.UUID)
 231         native_bt.trace_set_uuid(self._ptr, uuid.bytes)
 232
 233     _uuid = property(fset=_uuid)
 234
 235     def create_stream(self, stream_class, id=None, name=None, user_attributes=None):
 236         utils._check_type(stream_class, bt2_stream_class._StreamClass)
 237
 238         if stream_class.assigns_automatic_stream_id:
 239             if id is not None:
 240                 raise ValueError(
 241                     "id provided, but stream class assigns automatic stream ids"
 242                 )
 243
 244             stream_ptr = native_bt.stream_create(stream_class._ptr, self._ptr)
 245         else:
 246             if id is None:
 247                 raise ValueError(
 248                     "id not provided, but stream class does not assign automatic stream ids"
 249                 )
 250
 251             utils._check_uint64(id)
 252             stream_ptr = native_bt.stream_create_with_id(
 253                 stream_class._ptr, self._ptr, id
 254             )
 255
 256         if stream_ptr is None:
 257             raise bt2._MemoryError('cannot create stream object')
 258
 259         stream = bt2_stream._Stream._create_from_ptr(stream_ptr)
 260
 261         if name is not None:
 262             stream._name = name
 263
 264         if user_attributes is not None:
 265             stream._user_attributes = user_attributes
 266
 267         return stream
 268
 269
 270 def _trace_destruction_listener_from_native(user_listener, handle, trace_ptr):
 271     trace = _TraceConst._create_from_ptr_and_get_ref(trace_ptr)
 272     user_listener(trace)
 273     handle._invalidate()