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
29 from bt2
import stream_class
as bt2_stream_class
30 from bt2
import field_class
as bt2_field_class
31 from bt2
import trace
as bt2_trace
32 from bt2
import trace_class
as bt2_trace_class
33 import collections
.abc
37 class _StreamClassIterator(collections
.abc
.Iterator
):
38 def __init__(self
, trace_class
):
39 self
._trace
_class
= trace_class
43 if self
._at
== len(self
._trace
_class
):
46 borrow_stream_class_fn
= (
47 native_bt
.trace_class_borrow_stream_class_by_index_const
49 sc_ptr
= borrow_stream_class_fn(self
._trace
_class
._ptr
, self
._at
)
51 id = native_bt
.stream_class_get_id(sc_ptr
)
57 def _trace_class_destruction_listener_from_native(user_listener
, trace_class_ptr
):
58 trace_class
= bt2_trace_class
._TraceClass
._create
_from
_ptr
_and
_get
_ref
(
61 user_listener(trace_class
)
64 class _TraceClass(object._SharedObject
, collections
.abc
.Mapping
):
65 _get_ref
= staticmethod(native_bt
.trace_class_get_ref
)
66 _put_ref
= staticmethod(native_bt
.trace_class_put_ref
)
68 # Instantiate a trace of this class.
70 def __call__(self
, name
=None, uuid
=None, env
=None):
71 trace_ptr
= native_bt
.trace_create(self
._ptr
)
74 raise bt2
._MemoryError('cannot create trace class object')
76 trace
= bt2_trace
._Trace
._create
_from
_ptr
(trace_ptr
)
85 for key
, value
in env
.items():
86 trace
.env
[key
] = value
90 # Number of stream classes in this trace class.
93 count
= native_bt
.trace_class_get_stream_class_count(self
._ptr
)
97 # Get a stream class by stream id.
99 def __getitem__(self
, key
):
100 utils
._check
_uint
64(key
)
102 sc_ptr
= native_bt
.trace_class_borrow_stream_class_by_id_const(self
._ptr
, key
)
106 return bt2_stream_class
._StreamClass
._create
_from
_ptr
_and
_get
_ref
(sc_ptr
)
109 for idx
in range(len(self
)):
110 sc_ptr
= native_bt
.trace_class_borrow_stream_class_by_index_const(
113 assert sc_ptr
is not None
115 id = native_bt
.stream_class_get_id(sc_ptr
)
120 def create_stream_class(
124 packet_context_field_class
=None,
125 event_common_context_field_class
=None,
126 default_clock_class
=None,
127 assigns_automatic_event_class_id
=True,
128 assigns_automatic_stream_id
=True,
129 supports_packets
=False,
130 packets_have_beginning_default_clock_snapshot
=False,
131 packets_have_end_default_clock_snapshot
=False,
132 supports_discarded_events
=False,
133 discarded_events_have_default_clock_snapshots
=False,
134 supports_discarded_packets
=False,
135 discarded_packets_have_default_clock_snapshots
=False,
138 if self
.assigns_automatic_stream_class_id
:
141 'id provided, but trace class assigns automatic stream class ids'
144 sc_ptr
= native_bt
.stream_class_create(self
._ptr
)
148 'id not provided, but trace class does not assign automatic stream class ids'
151 utils
._check
_uint
64(id)
152 sc_ptr
= native_bt
.stream_class_create_with_id(self
._ptr
, id)
154 sc
= bt2_stream_class
._StreamClass
._create
_from
_ptr
(sc_ptr
)
159 if event_common_context_field_class
is not None:
160 sc
._event
_common
_context
_field
_class
= event_common_context_field_class
162 if default_clock_class
is not None:
163 sc
._default
_clock
_class
= default_clock_class
165 # call after `sc._default_clock_class` because, if
166 # `packets_have_beginning_default_clock_snapshot` or
167 # `packets_have_end_default_clock_snapshot` is true, then this
168 # stream class needs a default clock class already.
169 sc
._set
_supports
_packets
(
171 packets_have_beginning_default_clock_snapshot
,
172 packets_have_end_default_clock_snapshot
,
175 # call after sc._set_supports_packets() because, if
176 # `packet_context_field_class` is not `None`, then this stream
177 # class needs to support packets already.
178 if packet_context_field_class
is not None:
179 sc
._packet
_context
_field
_class
= packet_context_field_class
181 sc
._assigns
_automatic
_event
_class
_id
= assigns_automatic_event_class_id
182 sc
._assigns
_automatic
_stream
_id
= assigns_automatic_stream_id
183 sc
._set
_supports
_discarded
_events
(
184 supports_discarded_events
, discarded_events_have_default_clock_snapshots
186 sc
._set
_supports
_discarded
_packets
(
187 supports_discarded_packets
, discarded_packets_have_default_clock_snapshots
192 def assigns_automatic_stream_class_id(self
):
193 return native_bt
.trace_class_assigns_automatic_stream_class_id(self
._ptr
)
195 def _assigns_automatic_stream_class_id(self
, auto_id
):
196 utils
._check
_bool
(auto_id
)
197 return native_bt
.trace_class_set_assigns_automatic_stream_class_id(
201 _assigns_automatic_stream_class_id
= property(
202 fset
=_assigns_automatic_stream_class_id
205 # Field class creation methods.
207 def _check_create_status(self
, ptr
, type_name
):
209 raise bt2
._MemoryError('cannot create {} field class'.format(type_name
))
211 def _create_integer_field_class(
212 self
, create_func
, py_cls
, type_name
, field_value_range
, preferred_display_base
214 field_class_ptr
= create_func(self
._ptr
)
215 self
._check
_create
_status
(field_class_ptr
, type_name
)
217 field_class
= py_cls
._create
_from
_ptr
(field_class_ptr
)
219 if field_value_range
is not None:
220 field_class
._field
_value
_range
= field_value_range
222 if preferred_display_base
is not None:
223 field_class
._preferred
_display
_base
= preferred_display_base
227 def create_signed_integer_field_class(
228 self
, field_value_range
=None, preferred_display_base
=None
230 return self
._create
_integer
_field
_class
(
231 native_bt
.field_class_integer_signed_create
,
232 bt2_field_class
._SignedIntegerFieldClass
,
235 preferred_display_base
,
238 def create_unsigned_integer_field_class(
239 self
, field_value_range
=None, preferred_display_base
=None
241 return self
._create
_integer
_field
_class
(
242 native_bt
.field_class_integer_unsigned_create
,
243 bt2_field_class
._UnsignedIntegerFieldClass
,
246 preferred_display_base
,
249 def create_signed_enumeration_field_class(
250 self
, field_value_range
=None, preferred_display_base
=None
252 return self
._create
_integer
_field
_class
(
253 native_bt
.field_class_enumeration_signed_create
,
254 bt2_field_class
._SignedEnumerationFieldClass
,
255 'signed enumeration',
257 preferred_display_base
,
260 def create_unsigned_enumeration_field_class(
261 self
, field_value_range
=None, preferred_display_base
=None
263 return self
._create
_integer
_field
_class
(
264 native_bt
.field_class_enumeration_unsigned_create
,
265 bt2_field_class
._UnsignedEnumerationFieldClass
,
266 'unsigned enumeration',
268 preferred_display_base
,
271 def create_real_field_class(self
, is_single_precision
=False):
272 field_class_ptr
= native_bt
.field_class_real_create(self
._ptr
)
273 self
._check
_create
_status
(field_class_ptr
, 'real')
275 field_class
= bt2_field_class
._RealFieldClass
._create
_from
_ptr
(field_class_ptr
)
277 field_class
._is
_single
_precision
= is_single_precision
281 def create_structure_field_class(self
):
282 field_class_ptr
= native_bt
.field_class_structure_create(self
._ptr
)
283 self
._check
_create
_status
(field_class_ptr
, 'structure')
285 return bt2_field_class
._StructureFieldClass
._create
_from
_ptr
(field_class_ptr
)
287 def create_string_field_class(self
):
288 field_class_ptr
= native_bt
.field_class_string_create(self
._ptr
)
289 self
._check
_create
_status
(field_class_ptr
, 'string')
291 return bt2_field_class
._StringFieldClass
._create
_from
_ptr
(field_class_ptr
)
293 def create_static_array_field_class(self
, elem_fc
, length
):
294 utils
._check
_type
(elem_fc
, bt2_field_class
._FieldClass
)
295 utils
._check
_uint
64(length
)
296 ptr
= native_bt
.field_class_array_static_create(self
._ptr
, elem_fc
._ptr
, length
)
297 self
._check
_create
_status
(ptr
, 'static array')
299 return bt2_field_class
._StaticArrayFieldClass
._create
_from
_ptr
_and
_get
_ref
(ptr
)
301 def create_dynamic_array_field_class(self
, elem_fc
, length_fc
=None):
302 utils
._check
_type
(elem_fc
, bt2_field_class
._FieldClass
)
305 if length_fc
is not None:
306 utils
._check
_type
(length_fc
, bt2_field_class
._UnsignedIntegerFieldClass
)
307 length_fc_ptr
= length_fc
._ptr
309 ptr
= native_bt
.field_class_array_dynamic_create(
310 self
._ptr
, elem_fc
._ptr
, length_fc_ptr
312 self
._check
_create
_status
(ptr
, 'dynamic array')
313 return bt2_field_class
._DynamicArrayFieldClass
._create
_from
_ptr
(ptr
)
315 def create_variant_field_class(self
, selector_fc
=None):
316 selector_fc_ptr
= None
318 if selector_fc
is not None:
319 utils
._check
_type
(selector_fc
, bt2_field_class
._IntegerFieldClass
)
320 selector_fc_ptr
= selector_fc
._ptr
322 ptr
= native_bt
.field_class_variant_create(self
._ptr
, selector_fc_ptr
)
323 self
._check
_create
_status
(ptr
, 'variant')
324 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(ptr
)
326 # Add a listener to be called when the trace class is destroyed.
328 def add_destruction_listener(self
, listener
):
330 if not callable(listener
):
331 raise TypeError("'listener' parameter is not callable")
333 fn
= native_bt
.bt2_trace_class_add_destruction_listener
334 listener_from_native
= functools
.partial(
335 _trace_class_destruction_listener_from_native
, listener
338 status
, listener_id
= fn(self
._ptr
, listener_from_native
)
339 utils
._handle
_func
_status
(
340 status
, 'cannot add destruction listener to trace class object'
343 return utils
._ListenerHandle
(listener_id
, self
)