1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
4 # Copyright (c) 2018 Francis Deslauriers <francis.deslauriers@efficios.com>
5 # Copyright (c) 2019 Simon Marchi <simon.marchi@efficios.com>
7 # Permission is hereby granted, free of charge, to any person obtaining a copy
8 # of this software and associated documentation files (the "Software"), to deal
9 # in the Software without restriction, including without limitation the rights
10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the Software is
12 # furnished to do so, subject to the following conditions:
14 # The above copyright notice and this permission notice shall be included in
15 # all copies or substantial portions of the Software.
17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 __all__
= ['TraceClass']
28 from bt2
import native_bt
, utils
, object
30 import collections
.abc
34 class _TraceClassEnv(collections
.abc
.MutableMapping
):
35 def __init__(self
, trace_class
):
36 self
._trace
_class
= trace_class
38 def __getitem__(self
, key
):
41 borrow_entry_fn
= native_bt
.trace_class_borrow_environment_entry_value_by_name_const
42 value_ptr
= borrow_entry_fn(self
._trace
_class
._ptr
, key
)
47 return bt2
.value
._create
_from
_ptr
_and
_get
_ref
(value_ptr
)
49 def __setitem__(self
, key
, value
):
50 if isinstance(value
, str):
51 set_env_entry_fn
= native_bt
.trace_class_set_environment_entry_string
52 elif isinstance(value
, int):
53 set_env_entry_fn
= native_bt
.trace_class_set_environment_entry_integer
55 raise TypeError('expected str or int, got {}'.format(type(value
)))
57 ret
= set_env_entry_fn(self
._trace
_class
._ptr
, key
, value
)
59 utils
._handle
_ret
(ret
, "cannot set trace class object's environment entry")
61 def __delitem__(self
, key
):
62 raise NotImplementedError
65 count
= native_bt
.trace_class_get_environment_entry_count(self
._trace
_class
._ptr
)
70 trace_class_ptr
= self
._trace
_class
_env
._trace
_class
._ptr
72 for idx
in range(len(self
)):
73 borrow_entry_fn
= native_bt
.trace_class_borrow_environment_entry_by_index_const
74 entry_name
, _
= borrow_entry_fn(trace_class_ptr
, idx
)
75 assert entry_name
is not None
79 class _StreamClassIterator(collections
.abc
.Iterator
):
80 def __init__(self
, trace_class
):
81 self
._trace
_class
= trace_class
85 if self
._at
== len(self
._trace
_class
):
88 borrow_stream_class_fn
= native_bt
.trace_class_borrow_stream_class_by_index_const
89 sc_ptr
= borrow_stream_class_fn(self
._trace
_class
._ptr
, self
._at
)
91 id = native_bt
.stream_class_get_id(sc_ptr
)
97 def _trace_class_destruction_listener_from_native(user_listener
, trace_class_ptr
):
98 trace_class
= bt2
.trace_class
.TraceClass
._create
_from
_ptr
_and
_get
_ref
(trace_class_ptr
)
99 user_listener(trace_class
)
102 class TraceClass(object._SharedObject
, collections
.abc
.Mapping
):
103 _get_ref
= staticmethod(native_bt
.trace_class_get_ref
)
104 _put_ref
= staticmethod(native_bt
.trace_class_put_ref
)
108 uuid_bytes
= native_bt
.trace_class_get_uuid(self
._ptr
)
109 if uuid_bytes
is None:
112 return uuidp
.UUID(bytes
=uuid_bytes
)
114 def _uuid(self
, uuid
):
115 utils
._check
_type
(uuid
, uuidp
.UUID
)
116 native_bt
.trace_class_set_uuid(self
._ptr
, uuid
.bytes
)
118 _uuid
= property(fset
=_uuid
)
120 # Instantiate a trace of this class.
122 def __call__(self
, name
=None):
123 trace_ptr
= native_bt
.trace_create(self
._ptr
)
125 if trace_ptr
is None:
126 raise bt2
.CreationError('cannot create trace class object')
128 trace
= bt2
.trace
.Trace
._create
_from
_ptr
(trace_ptr
)
135 # Number of stream classes in this trace class.
138 count
= native_bt
.trace_class_get_stream_class_count(self
._ptr
)
142 # Get a stream class by stream id.
144 def __getitem__(self
, key
):
145 utils
._check
_uint
64(key
)
147 sc_ptr
= native_bt
.trace_class_borrow_stream_class_by_id_const(self
._ptr
, key
)
151 return bt2
.StreamClass
._create
_from
_ptr
_and
_get
_ref
(sc_ptr
)
154 for idx
in range(len(self
)):
155 sc_ptr
= native_bt
.trace_class_borrow_stream_class_by_index_const(self
._ptr
, idx
)
156 assert sc_ptr
is not None
158 id = native_bt
.stream_class_get_id(sc_ptr
)
165 return _TraceClassEnv(self
)
167 def create_stream_class(self
, id=None,
169 packet_context_field_class
=None,
170 event_common_context_field_class
=None,
171 default_clock_class
=None,
172 assigns_automatic_event_class_id
=True,
173 assigns_automatic_stream_id
=True,
174 packets_have_default_beginning_clock_snapshot
=False,
175 packets_have_default_end_clock_snapshot
=False):
177 if self
.assigns_automatic_stream_class_id
:
179 raise ValueError('id provided, but trace class assigns automatic stream class ids')
181 sc_ptr
= native_bt
.stream_class_create(self
._ptr
)
184 raise ValueError('id not provided, but trace class does not assign automatic stream class ids')
186 utils
._check
_uint
64(id)
187 sc_ptr
= native_bt
.stream_class_create_with_id(self
._ptr
, id)
189 sc
= bt2
.stream_class
.StreamClass
._create
_from
_ptr
(sc_ptr
)
194 if packet_context_field_class
is not None:
195 sc
._packet
_context
_field
_class
= packet_context_field_class
197 if event_common_context_field_class
is not None:
198 sc
._event
_common
_context
_field
_class
= event_common_context_field_class
200 if default_clock_class
is not None:
201 sc
._default
_clock
_class
= default_clock_class
203 sc
._assigns
_automatic
_event
_class
_id
= assigns_automatic_event_class_id
204 sc
._assigns
_automatic
_stream
_id
= assigns_automatic_stream_id
205 sc
._packets
_have
_default
_beginning
_clock
_snapshot
= packets_have_default_beginning_clock_snapshot
206 sc
._packets
_have
_default
_end
_clock
_snapshot
= packets_have_default_end_clock_snapshot
211 def assigns_automatic_stream_class_id(self
):
212 return native_bt
.trace_class_assigns_automatic_stream_class_id(self
._ptr
)
214 def _assigns_automatic_stream_class_id(self
, auto_id
):
215 utils
._check
_bool
(auto_id
)
216 return native_bt
.trace_class_set_assigns_automatic_stream_class_id(self
._ptr
, auto_id
)
218 _assigns_automatic_stream_class_id
= property(fset
=_assigns_automatic_stream_class_id
)
220 # Field class creation methods.
222 def _check_create_status(self
, ptr
, type_name
):
224 raise bt2
.CreationError(
225 'cannot create {} field class'.format(type_name
))
227 def _create_integer_field_class(self
, create_func
, py_cls
, type_name
, field_value_range
, preferred_display_base
):
228 field_class_ptr
= create_func(self
._ptr
)
229 self
._check
_create
_status
(field_class_ptr
, type_name
)
231 field_class
= py_cls
._create
_from
_ptr
(field_class_ptr
)
233 if field_value_range
is not None:
234 field_class
._field
_value
_range
= field_value_range
236 if preferred_display_base
is not None:
237 field_class
._preferred
_display
_base
= preferred_display_base
241 def create_signed_integer_field_class(self
, field_value_range
=None, preferred_display_base
=None):
242 return self
._create
_integer
_field
_class
(native_bt
.field_class_signed_integer_create
,
243 bt2
.field_class
._SignedIntegerFieldClass
,
244 'signed integer', field_value_range
, preferred_display_base
)
246 def create_unsigned_integer_field_class(self
, field_value_range
=None, preferred_display_base
=None):
247 return self
._create
_integer
_field
_class
(native_bt
.field_class_unsigned_integer_create
,
248 bt2
.field_class
._UnsignedIntegerFieldClass
,
249 'unsigned integer', field_value_range
, preferred_display_base
)
251 def create_signed_enumeration_field_class(self
, field_value_range
=None, preferred_display_base
=None):
252 return self
._create
_integer
_field
_class
(native_bt
.field_class_signed_enumeration_create
,
253 bt2
.field_class
._SignedEnumerationFieldClass
,
254 'signed enumeration', field_value_range
, preferred_display_base
)
256 def create_unsigned_enumeration_field_class(self
, field_value_range
=None, preferred_display_base
=None):
257 return self
._create
_integer
_field
_class
(native_bt
.field_class_unsigned_enumeration_create
,
258 bt2
.field_class
._UnsignedEnumerationFieldClass
,
259 'unsigned enumeration', field_value_range
, preferred_display_base
)
261 def create_real_field_class(self
, is_single_precision
=False):
262 field_class_ptr
= native_bt
.field_class_real_create(self
._ptr
)
263 self
._check
_create
_status
(field_class_ptr
, 'real')
265 field_class
= bt2
.field_class
._RealFieldClass
._create
_from
_ptr
(field_class_ptr
)
267 field_class
._is
_single
_precision
= is_single_precision
271 def create_structure_field_class(self
):
272 field_class_ptr
= native_bt
.field_class_structure_create(self
._ptr
)
273 self
._check
_create
_status
(field_class_ptr
, 'structure')
275 return bt2
.field_class
._StructureFieldClass
._create
_from
_ptr
(field_class_ptr
)
277 def create_string_field_class(self
):
278 field_class_ptr
= native_bt
.field_class_string_create(self
._ptr
)
279 self
._check
_create
_status
(field_class_ptr
, 'string')
281 return bt2
.field_class
._StringFieldClass
._create
_from
_ptr
(field_class_ptr
)
283 def create_static_array_field_class(self
, elem_fc
, length
):
284 utils
._check
_type
(elem_fc
, bt2
.field_class
._FieldClass
)
285 utils
._check
_uint
64(length
)
286 ptr
= native_bt
.field_class_static_array_create(self
._ptr
, elem_fc
._ptr
, length
)
287 self
._check
_create
_status
(ptr
, 'static array')
289 return bt2
.field_class
._StaticArrayFieldClass
._create
_from
_ptr
_and
_get
_ref
(ptr
)
291 def create_dynamic_array_field_class(self
, elem_fc
, length_fc
=None):
292 utils
._check
_type
(elem_fc
, bt2
.field_class
._FieldClass
)
293 ptr
= native_bt
.field_class_dynamic_array_create(self
._ptr
, elem_fc
._ptr
)
294 self
._check
_create
_status
(ptr
, 'dynamic array')
295 obj
= bt2
.field_class
._DynamicArrayFieldClass
._create
_from
_ptr
(ptr
)
297 if length_fc
is not None:
298 obj
._length
_field
_class
= length_fc
302 def create_variant_field_class(self
, selector_fc
=None):
303 ptr
= native_bt
.field_class_variant_create(self
._ptr
)
304 self
._check
_create
_status
(ptr
, 'variant')
305 obj
= bt2
.field_class
._VariantFieldClass
._create
_from
_ptr
(ptr
)
307 if selector_fc
is not None:
308 obj
._selector
_field
_class
= selector_fc
312 # Add a listener to be called when the trace class is destroyed.
314 def add_destruction_listener(self
, listener
):
316 if not callable(listener
):
317 raise TypeError("'listener' parameter is not callable")
319 fn
= native_bt
.py3_trace_class_add_destruction_listener
320 listener_from_native
= functools
.partial(_trace_class_destruction_listener_from_native
,
323 listener_id
= fn(self
._ptr
, listener_from_native
)
324 if listener_id
is None:
325 utils
._raise
_bt
2_error
('cannot add destruction listener to trace class object')
327 return bt2
._ListenerHandle(listener_id
, self
)