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,
193 # Validate parameters before we create the object.
194 bt2_stream_class
._StreamClass
._validate
_create
_params
(
197 packet_context_field_class
,
198 event_common_context_field_class
,
200 assigns_automatic_event_class_id
,
201 assigns_automatic_stream_id
,
203 packets_have_beginning_default_clock_snapshot
,
204 packets_have_end_default_clock_snapshot
,
205 supports_discarded_events
,
206 discarded_events_have_default_clock_snapshots
,
207 supports_discarded_packets
,
208 discarded_packets_have_default_clock_snapshots
,
211 if self
.assigns_automatic_stream_class_id
:
214 'id provided, but trace class assigns automatic stream class ids'
217 sc_ptr
= native_bt
.stream_class_create(self
._ptr
)
221 'id not provided, but trace class does not assign automatic stream class ids'
224 utils
._check
_uint
64(id)
225 sc_ptr
= native_bt
.stream_class_create_with_id(self
._ptr
, id)
227 sc
= bt2_stream_class
._StreamClass
._create
_from
_ptr
(sc_ptr
)
232 if user_attributes
is not None:
233 sc
._user
_attributes
= user_attributes
235 if event_common_context_field_class
is not None:
236 sc
._event
_common
_context
_field
_class
= event_common_context_field_class
238 if default_clock_class
is not None:
239 sc
._default
_clock
_class
= default_clock_class
241 # call after `sc._default_clock_class` because, if
242 # `packets_have_beginning_default_clock_snapshot` or
243 # `packets_have_end_default_clock_snapshot` is true, then this
244 # stream class needs a default clock class already.
245 sc
._set
_supports
_packets
(
247 packets_have_beginning_default_clock_snapshot
,
248 packets_have_end_default_clock_snapshot
,
251 # call after sc._set_supports_packets() because, if
252 # `packet_context_field_class` is not `None`, then this stream
253 # class needs to support packets already.
254 if packet_context_field_class
is not None:
255 sc
._packet
_context
_field
_class
= packet_context_field_class
257 sc
._assigns
_automatic
_event
_class
_id
= assigns_automatic_event_class_id
258 sc
._assigns
_automatic
_stream
_id
= assigns_automatic_stream_id
259 sc
._set
_supports
_discarded
_events
(
260 supports_discarded_events
, discarded_events_have_default_clock_snapshots
262 sc
._set
_supports
_discarded
_packets
(
263 supports_discarded_packets
, discarded_packets_have_default_clock_snapshots
267 def _user_attributes(self
, user_attributes
):
268 value
= bt2_value
.create_value(user_attributes
)
269 utils
._check
_type
(value
, bt2_value
.MapValue
)
270 native_bt
.trace_class_set_user_attributes(self
._ptr
, value
._ptr
)
272 _user_attributes
= property(fset
=_user_attributes
)
274 def _assigns_automatic_stream_class_id(self
, auto_id
):
275 utils
._check
_bool
(auto_id
)
276 return native_bt
.trace_class_set_assigns_automatic_stream_class_id(
280 _assigns_automatic_stream_class_id
= property(
281 fset
=_assigns_automatic_stream_class_id
284 # Field class creation methods.
286 def _check_field_class_create_status(self
, ptr
, type_name
):
288 raise bt2
._MemoryError('cannot create {} field class'.format(type_name
))
291 def _set_field_class_user_attrs(fc
, user_attributes
):
292 if user_attributes
is not None:
293 fc
._user
_attributes
= user_attributes
295 def create_bool_field_class(self
, user_attributes
=None):
296 field_class_ptr
= native_bt
.field_class_bool_create(self
._ptr
)
297 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'boolean')
298 fc
= bt2_field_class
._BoolFieldClass
._create
_from
_ptr
(field_class_ptr
)
299 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
302 def create_bit_array_field_class(self
, length
, user_attributes
=None):
303 utils
._check
_uint
64(length
)
305 if length
< 1 or length
> 64:
307 'invalid length {}: expecting a value in the [1, 64] range'.format(
312 field_class_ptr
= native_bt
.field_class_bit_array_create(self
._ptr
, length
)
313 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'bit array')
314 fc
= bt2_field_class
._BitArrayFieldClass
._create
_from
_ptr
(field_class_ptr
)
315 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
318 def _create_integer_field_class(
324 preferred_display_base
,
327 field_class_ptr
= create_func(self
._ptr
)
328 self
._check
_field
_class
_create
_status
(field_class_ptr
, type_name
)
330 field_class
= py_cls
._create
_from
_ptr
(field_class_ptr
)
332 if field_value_range
is not None:
333 field_class
._field
_value
_range
= field_value_range
335 if preferred_display_base
is not None:
336 field_class
._preferred
_display
_base
= preferred_display_base
338 self
._set
_field
_class
_user
_attrs
(field_class
, user_attributes
)
341 def create_signed_integer_field_class(
342 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
344 return self
._create
_integer
_field
_class
(
345 native_bt
.field_class_integer_signed_create
,
346 bt2_field_class
._SignedIntegerFieldClass
,
349 preferred_display_base
,
353 def create_unsigned_integer_field_class(
354 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
356 return self
._create
_integer
_field
_class
(
357 native_bt
.field_class_integer_unsigned_create
,
358 bt2_field_class
._UnsignedIntegerFieldClass
,
361 preferred_display_base
,
365 def create_signed_enumeration_field_class(
366 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
368 return self
._create
_integer
_field
_class
(
369 native_bt
.field_class_enumeration_signed_create
,
370 bt2_field_class
._SignedEnumerationFieldClass
,
371 'signed enumeration',
373 preferred_display_base
,
377 def create_unsigned_enumeration_field_class(
378 self
, field_value_range
=None, preferred_display_base
=None, user_attributes
=None
380 return self
._create
_integer
_field
_class
(
381 native_bt
.field_class_enumeration_unsigned_create
,
382 bt2_field_class
._UnsignedEnumerationFieldClass
,
383 'unsigned enumeration',
385 preferred_display_base
,
389 def create_single_precision_real_field_class(self
, user_attributes
=None):
390 field_class_ptr
= native_bt
.field_class_real_single_precision_create(self
._ptr
)
391 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'single-precision real')
393 field_class
= bt2_field_class
._SinglePrecisionRealFieldClass
._create
_from
_ptr
(
397 self
._set
_field
_class
_user
_attrs
(field_class
, user_attributes
)
401 def create_double_precision_real_field_class(self
, user_attributes
=None):
402 field_class_ptr
= native_bt
.field_class_real_double_precision_create(self
._ptr
)
403 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'double-precision real')
405 field_class
= bt2_field_class
._DoublePrecisionRealFieldClass
._create
_from
_ptr
(
409 self
._set
_field
_class
_user
_attrs
(field_class
, user_attributes
)
413 def create_structure_field_class(self
, user_attributes
=None):
414 field_class_ptr
= native_bt
.field_class_structure_create(self
._ptr
)
415 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'structure')
416 fc
= bt2_field_class
._StructureFieldClass
._create
_from
_ptr
(field_class_ptr
)
417 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
420 def create_string_field_class(self
, user_attributes
=None):
421 field_class_ptr
= native_bt
.field_class_string_create(self
._ptr
)
422 self
._check
_field
_class
_create
_status
(field_class_ptr
, 'string')
423 fc
= bt2_field_class
._StringFieldClass
._create
_from
_ptr
(field_class_ptr
)
424 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
427 def create_static_array_field_class(self
, elem_fc
, length
, user_attributes
=None):
428 utils
._check
_type
(elem_fc
, bt2_field_class
._FieldClass
)
429 utils
._check
_uint
64(length
)
430 ptr
= native_bt
.field_class_array_static_create(self
._ptr
, elem_fc
._ptr
, length
)
431 self
._check
_field
_class
_create
_status
(ptr
, 'static array')
432 fc
= bt2_field_class
._StaticArrayFieldClass
._create
_from
_ptr
_and
_get
_ref
(ptr
)
433 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
436 def create_dynamic_array_field_class(
437 self
, elem_fc
, length_fc
=None, user_attributes
=None
439 utils
._check
_type
(elem_fc
, bt2_field_class
._FieldClass
)
442 if length_fc
is not None:
443 utils
._check
_type
(length_fc
, bt2_field_class
._UnsignedIntegerFieldClass
)
444 length_fc_ptr
= length_fc
._ptr
446 ptr
= native_bt
.field_class_array_dynamic_create(
447 self
._ptr
, elem_fc
._ptr
, length_fc_ptr
449 self
._check
_field
_class
_create
_status
(ptr
, 'dynamic array')
450 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
451 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
454 def create_option_without_selector_field_class(
455 self
, content_fc
, user_attributes
=None
457 utils
._check
_type
(content_fc
, bt2_field_class
._FieldClass
)
458 ptr
= native_bt
.field_class_option_without_selector_create(
459 self
._ptr
, content_fc
._ptr
461 self
._check
_field
_class
_create
_status
(ptr
, 'option')
462 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
463 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
466 def create_option_with_bool_selector_field_class(
467 self
, content_fc
, selector_fc
, selector_is_reversed
=False, user_attributes
=None
469 utils
._check
_type
(content_fc
, bt2_field_class
._FieldClass
)
470 utils
._check
_bool
(selector_is_reversed
)
471 utils
._check
_type
(selector_fc
, bt2_field_class
._BoolFieldClass
)
472 ptr
= native_bt
.field_class_option_with_selector_field_bool_create(
473 self
._ptr
, content_fc
._ptr
, selector_fc
._ptr
475 self
._check
_field
_class
_create
_status
(ptr
, 'option')
476 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
477 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
478 fc
._selector
_is
_reversed
= selector_is_reversed
481 def create_option_with_integer_selector_field_class(
482 self
, content_fc
, selector_fc
, ranges
, user_attributes
=None
484 utils
._check
_type
(content_fc
, bt2_field_class
._FieldClass
)
485 utils
._check
_type
(selector_fc
, bt2_field_class
._IntegerFieldClass
)
488 raise ValueError('integer range set is empty')
490 if isinstance(selector_fc
, bt2_field_class
._UnsignedIntegerFieldClass
):
491 utils
._check
_type
(ranges
, bt2_integer_range_set
.UnsignedIntegerRangeSet
)
492 ptr
= native_bt
.field_class_option_with_selector_field_integer_unsigned_create(
493 self
._ptr
, content_fc
._ptr
, selector_fc
._ptr
, ranges
._ptr
496 utils
._check
_type
(ranges
, bt2_integer_range_set
.SignedIntegerRangeSet
)
497 ptr
= native_bt
.field_class_option_with_selector_field_integer_signed_create(
498 self
._ptr
, content_fc
._ptr
, selector_fc
._ptr
, ranges
._ptr
501 self
._check
_field
_class
_create
_status
(ptr
, 'option')
502 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
503 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)
506 def create_variant_field_class(self
, selector_fc
=None, user_attributes
=None):
507 selector_fc_ptr
= None
509 if selector_fc
is not None:
510 utils
._check
_type
(selector_fc
, bt2_field_class
._IntegerFieldClass
)
511 selector_fc_ptr
= selector_fc
._ptr
513 ptr
= native_bt
.field_class_variant_create(self
._ptr
, selector_fc_ptr
)
514 self
._check
_field
_class
_create
_status
(ptr
, 'variant')
515 fc
= bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
516 self
._set
_field
_class
_user
_attrs
(fc
, user_attributes
)