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 from bt2
import native_bt
, utils
, object
26 from bt2
import stream_class
as bt2_stream_class
27 from bt2
import field_class
as bt2_field_class
28 from bt2
import integer_range_set
as bt2_integer_range_set
29 from bt2
import trace
as bt2_trace
30 from bt2
import value
as bt2_value
31 import collections
.abc
36 def _trace_class_destruction_listener_from_native(user_listener
, trace_class_ptr
):
37 trace_class
= _TraceClass
._create
_from
_ptr
_and
_get
_ref
(trace_class_ptr
)
38 user_listener(trace_class
)
41 class _TraceClassConst(object._SharedObject
, collections
.abc
.Mapping
):
42 _get_ref
= staticmethod(native_bt
.trace_class_get_ref
)
43 _put_ref
= staticmethod(native_bt
.trace_class_put_ref
)
44 _borrow_stream_class_ptr_by_index
= staticmethod(
45 native_bt
.trace_class_borrow_stream_class_by_index_const
47 _borrow_stream_class_ptr_by_id
= staticmethod(
48 native_bt
.trace_class_borrow_stream_class_by_id_const
50 _borrow_user_attributes_ptr
= staticmethod(
51 native_bt
.trace_class_borrow_user_attributes_const
53 _stream_class_pycls
= bt2_stream_class
._StreamClassConst
54 _create_value_from_ptr_and_get_ref
= staticmethod(
55 bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
59 def user_attributes(self
):
60 ptr
= self
._borrow
_user
_attributes
_ptr
(self
._ptr
)
61 assert ptr
is not None
62 return self
._create
_value
_from
_ptr
_and
_get
_ref
(ptr
)
64 # Number of stream classes in this trace class.
67 count
= native_bt
.trace_class_get_stream_class_count(self
._ptr
)
71 # Get a stream class by stream id.
73 def __getitem__(self
, key
):
74 utils
._check
_uint
64(key
)
76 sc_ptr
= self
._borrow
_stream
_class
_ptr
_by
_id
(self
._ptr
, key
)
80 return self
._stream
_class
_pycls
._create
_from
_ptr
_and
_get
_ref
(sc_ptr
)
83 for idx
in range(len(self
)):
84 sc_ptr
= self
._borrow
_stream
_class
_ptr
_by
_index
(self
._ptr
, idx
)
85 assert sc_ptr
is not None
87 id = native_bt
.stream_class_get_id(sc_ptr
)
93 def assigns_automatic_stream_class_id(self
):
94 return native_bt
.trace_class_assigns_automatic_stream_class_id(self
._ptr
)
96 # Add a listener to be called when the trace class is destroyed.
98 def add_destruction_listener(self
, listener
):
100 if not callable(listener
):
101 raise TypeError("'listener' parameter is not callable")
103 fn
= native_bt
.bt2_trace_class_add_destruction_listener
104 listener_from_native
= functools
.partial(
105 _trace_class_destruction_listener_from_native
, listener
108 status
, listener_id
= fn(self
._ptr
, listener_from_native
)
109 utils
._handle
_func
_status
(
110 status
, 'cannot add destruction listener to trace class object'
113 return utils
._ListenerHandle
(listener_id
, self
)
115 def remove_destruction_listener(self
, listener_handle
):
116 utils
._check
_type
(listener_handle
, utils
._ListenerHandle
)
118 if listener_handle
._obj
.addr
!= self
.addr
:
120 'This trace class destruction listener does not match the trace object.'
123 if listener_handle
._listener
_id
is None:
125 'This trace class destruction listener was already removed.'
128 status
= native_bt
.trace_class_remove_destruction_listener(
129 self
._ptr
, listener_handle
._listener
_id
131 utils
._handle
_func
_status
(status
)
132 listener_handle
._listener
_id
= None
135 class _TraceClass(_TraceClassConst
):
136 _borrow_stream_class_ptr_by_index
= staticmethod(
137 native_bt
.trace_class_borrow_stream_class_by_index
139 _borrow_stream_class_ptr_by_id
= staticmethod(
140 native_bt
.trace_class_borrow_stream_class_by_id
142 _borrow_user_attributes_ptr
= staticmethod(
143 native_bt
.trace_class_borrow_user_attributes
145 _stream_class_pycls
= bt2_stream_class
._StreamClass
146 _create_value_from_ptr_and_get_ref
= staticmethod(
147 bt2_value
._create
_from
_ptr
_and
_get
_ref
150 # Instantiate a trace of this class.
152 def __call__(self
, name
=None, user_attributes
=None, uuid
=None, environment
=None):
153 trace_ptr
= native_bt
.trace_create(self
._ptr
)
155 if trace_ptr
is None:
156 raise bt2
._MemoryError('cannot create trace class object')
158 trace
= bt2_trace
._Trace
._create
_from
_ptr
(trace_ptr
)
163 if user_attributes
is not None:
164 trace
._user
_attributes
= user_attributes
169 if environment
is not None:
170 for key
, value
in environment
.items():
171 trace
.environment
[key
] = value
175 def create_stream_class(
179 user_attributes
=None,
180 packet_context_field_class
=None,
181 event_common_context_field_class
=None,
182 default_clock_class
=None,
183 assigns_automatic_event_class_id
=True,
184 assigns_automatic_stream_id
=True,
185 supports_packets
=False,
186 packets_have_beginning_default_clock_snapshot
=False,
187 packets_have_end_default_clock_snapshot
=False,
188 supports_discarded_events
=False,
189 discarded_events_have_default_clock_snapshots
=False,
190 supports_discarded_packets
=False,
191 discarded_packets_have_default_clock_snapshots
=False,
194 if self
.assigns_automatic_stream_class_id
:
197 'id provided, but trace class assigns automatic stream class ids'
200 sc_ptr
= native_bt
.stream_class_create(self
._ptr
)
204 'id not provided, but trace class does not assign automatic stream class ids'
207 utils
._check
_uint
64(id)
208 sc_ptr
= native_bt
.stream_class_create_with_id(self
._ptr
, id)
210 sc
= bt2_stream_class
._StreamClass
._create
_from
_ptr
(sc_ptr
)
215 if user_attributes
is not None:
216 sc
._user
_attributes
= user_attributes
218 if event_common_context_field_class
is not None:
219 sc
._event
_common
_context
_field
_class
= event_common_context_field_class
221 if default_clock_class
is not None:
222 sc
._default
_clock
_class
= default_clock_class
224 # call after `sc._default_clock_class` because, if
225 # `packets_have_beginning_default_clock_snapshot` or
226 # `packets_have_end_default_clock_snapshot` is true, then this
227 # stream class needs a default clock class already.
228 sc
._set
_supports
_packets
(
230 packets_have_beginning_default_clock_snapshot
,
231 packets_have_end_default_clock_snapshot
,
234 # call after sc._set_supports_packets() because, if
235 # `packet_context_field_class` is not `None`, then this stream
236 # class needs to support packets already.
237 if packet_context_field_class
is not None:
238 sc
._packet
_context
_field
_class
= packet_context_field_class
240 sc
._assigns
_automatic
_event
_class
_id
= assigns_automatic_event_class_id
241 sc
._assigns
_automatic
_stream
_id
= assigns_automatic_stream_id
242 sc
._set
_supports
_discarded
_events
(
243 supports_discarded_events
, discarded_events_have_default_clock_snapshots
245 sc
._set
_supports
_discarded
_packets
(
246 supports_discarded_packets
, discarded_packets_have_default_clock_snapshots
250 def _user_attributes(self
, user_attributes
):
251 value
= bt2_value
.create_value(user_attributes
)
252 utils
._check
_type
(value
, bt2_value
.MapValue
)
253 native_bt
.trace_class_set_user_attributes(self
._ptr
, value
._ptr
)
255 _user_attributes
= property(fset
=_user_attributes
)
257 def _assigns_automatic_stream_class_id(self
, auto_id
):
258 utils
._check
_bool
(auto_id
)
259 return native_bt
.trace_class_set_assigns_automatic_stream_class_id(
263 _assigns_automatic_stream_class_id
= property(
264 fset
=_assigns_automatic_stream_class_id
267 # Field class creation methods.
269 def _check_field_class_create_status(self
, ptr
, type_name
):
271 raise bt2
._MemoryError('cannot create {} field class'.format(type_name
))
274 def _set_field_class_user_attrs(fc
, user_attributes
):
275 if user_attributes
is not None:
276 fc
._user
_attributes
= user_attributes
278 def create_bool_field_class(self
, user_attributes
=None):
279 field_class_ptr
= native_bt
.field_class_bool_create(self
._ptr
)
280 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'boolean')
281 fc
= bt2_field_class
._BoolFieldClass
._create
_from
_ptr
(field_class_ptr
)
282 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
285 def create_bit_array_field_class(self
, length
, user_attributes
=None):
286 utils
._check
_uint
64(length
)
288 if length
< 1 or length
> 64:
290 'invalid length {}: expecting a value in the [1, 64] range'.format(
295 field_class_ptr
= native_bt
.field_class_bit_array_create(self
._ptr
, length
)
296 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'bit array')
297 fc
= bt2_field_class
._BitArrayFieldClass
._create
_from
_ptr
(field_class_ptr
)
298 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
301 def _create_integer_field_class(
307 preferred_display_base
,
310 field_class_ptr
= create_func(self
._ptr
)
311 self
._check
_field
_class
_create
_status
(field_class_ptr
, type_name
)
313 field_class
= py_cls
._create
_from
_ptr
(field_class_ptr
)
315 if field_value_range
is not None:
316 field_class
._field
_value
_range
= field_value_range
318 if preferred_display_base
is not None:
319 field_class
._preferred
_display
_base
= preferred_display_base
321 self
._set
_field
_class
_user
_attrs
(field_class
, user_attributes
)
324 def create_signed_integer_field_class(
325 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
327 return self
._create
_integer
_field
_class
(
328 native_bt
.field_class_integer_signed_create
,
329 bt2_field_class
._SignedIntegerFieldClass
,
332 preferred_display_base
,
336 def create_unsigned_integer_field_class(
337 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
339 return self
._create
_integer
_field
_class
(
340 native_bt
.field_class_integer_unsigned_create
,
341 bt2_field_class
._UnsignedIntegerFieldClass
,
344 preferred_display_base
,
348 def create_signed_enumeration_field_class(
349 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
351 return self
._create
_integer
_field
_class
(
352 native_bt
.field_class_enumeration_signed_create
,
353 bt2_field_class
._SignedEnumerationFieldClass
,
354 'signed enumeration',
356 preferred_display_base
,
360 def create_unsigned_enumeration_field_class(
361 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
363 return self
._create
_integer
_field
_class
(
364 native_bt
.field_class_enumeration_unsigned_create
,
365 bt2_field_class
._UnsignedEnumerationFieldClass
,
366 'unsigned enumeration',
368 preferred_display_base
,
372 def create_single_precision_real_field_class(self
, user_attributes
=None):
373 field_class_ptr
= native_bt
.field_class_real_single_precision_create(self
._ptr
)
374 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'single-precision real')
376 field_class
= bt2_field_class
._SinglePrecisionRealFieldClass
._create
_from
_ptr
(
380 self
._set
_field
_class
_user
_attrs
(field_class
, user_attributes
)
384 def create_double_precision_real_field_class(self
, user_attributes
=None):
385 field_class_ptr
= native_bt
.field_class_real_double_precision_create(self
._ptr
)
386 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'double-precision real')
388 field_class
= bt2_field_class
._DoublePrecisionRealFieldClass
._create
_from
_ptr
(
392 self
._set
_field
_class
_user
_attrs
(field_class
, user_attributes
)
396 def create_structure_field_class(self
, user_attributes
=None):
397 field_class_ptr
= native_bt
.field_class_structure_create(self
._ptr
)
398 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'structure')
399 fc
= bt2_field_class
._StructureFieldClass
._create
_from
_ptr
(field_class_ptr
)
400 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
403 def create_string_field_class(self
, user_attributes
=None):
404 field_class_ptr
= native_bt
.field_class_string_create(self
._ptr
)
405 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'string')
406 fc
= bt2_field_class
._StringFieldClass
._create
_from
_ptr
(field_class_ptr
)
407 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
410 def create_static_array_field_class(self
, elem_fc
, length
, user_attributes
=None):
411 utils
._check
_type
(elem_fc
, bt2_field_class
._FieldClass
)
412 utils
._check
_uint
64(length
)
413 ptr
= native_bt
.field_class_array_static_create(self
._ptr
, elem_fc
._ptr
, length
)
414 self
._check
_field
_class
_create
_status
(ptr
, 'static array')
415 fc
= bt2_field_class
._StaticArrayFieldClass
._create
_from
_ptr
_and
_get
_ref
(ptr
)
416 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
419 def create_dynamic_array_field_class(
420 self
, elem_fc
, length_fc
=None, user_attributes
=None
422 utils
._check
_type
(elem_fc
, bt2_field_class
._FieldClass
)
425 if length_fc
is not None:
426 utils
._check
_type
(length_fc
, bt2_field_class
._UnsignedIntegerFieldClass
)
427 length_fc_ptr
= length_fc
._ptr
429 ptr
= native_bt
.field_class_array_dynamic_create(
430 self
._ptr
, elem_fc
._ptr
, length_fc_ptr
432 self
._check
_field
_class
_create
_status
(ptr
, 'dynamic array')
433 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
434 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
437 def create_option_without_selector_field_class(
438 self
, content_fc
, user_attributes
=None
440 utils
._check
_type
(content_fc
, bt2_field_class
._FieldClass
)
441 ptr
= native_bt
.field_class_option_without_selector_create(
442 self
._ptr
, content_fc
._ptr
444 self
._check
_field
_class
_create
_status
(ptr
, 'option')
445 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
446 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
449 def create_option_with_bool_selector_field_class(
450 self
, content_fc
, selector_fc
, selector_is_reversed
=False, user_attributes
=None
452 utils
._check
_type
(content_fc
, bt2_field_class
._FieldClass
)
453 utils
._check
_bool
(selector_is_reversed
)
454 utils
._check
_type
(selector_fc
, bt2_field_class
._BoolFieldClass
)
455 ptr
= native_bt
.field_class_option_with_selector_bool_create(
456 self
._ptr
, content_fc
._ptr
, selector_fc
._ptr
458 self
._check
_field
_class
_create
_status
(ptr
, 'option')
459 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
460 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
461 fc
._selector
_is
_reversed
= selector_is_reversed
464 def create_option_with_integer_selector_field_class(
465 self
, content_fc
, selector_fc
, ranges
, user_attributes
=None
467 utils
._check
_type
(content_fc
, bt2_field_class
._FieldClass
)
468 utils
._check
_type
(selector_fc
, bt2_field_class
._IntegerFieldClass
)
471 raise ValueError('integer range set is empty')
473 if isinstance(selector_fc
, bt2_field_class
._UnsignedIntegerFieldClass
):
474 utils
._check
_type
(ranges
, bt2_integer_range_set
.UnsignedIntegerRangeSet
)
475 ptr
= native_bt
.field_class_option_with_selector_integer_unsigned_create(
476 self
._ptr
, content_fc
._ptr
, selector_fc
._ptr
, ranges
._ptr
479 utils
._check
_type
(ranges
, bt2_integer_range_set
.SignedIntegerRangeSet
)
480 ptr
= native_bt
.field_class_option_with_selector_integer_signed_create(
481 self
._ptr
, content_fc
._ptr
, selector_fc
._ptr
, ranges
._ptr
484 self
._check
_field
_class
_create
_status
(ptr
, 'option')
485 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
486 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
489 def create_variant_field_class(self
, selector_fc
=None, user_attributes
=None):
490 selector_fc_ptr
= None
492 if selector_fc
is not None:
493 utils
._check
_type
(selector_fc
, bt2_field_class
._IntegerFieldClass
)
494 selector_fc_ptr
= selector_fc
._ptr
496 ptr
= native_bt
.field_class_variant_create(self
._ptr
, selector_fc_ptr
)
497 self
._check
_field
_class
_create
_status
(ptr
, 'variant')
498 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
499 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)