1 # SPDX-License-Identifier: MIT
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 from bt2
import native_bt
, object, utils
6 from bt2
import field_class
as bt2_field_class
7 from bt2
import event_class
as bt2_event_class
8 from bt2
import clock_class
as bt2_clock_class
9 from bt2
import value
as bt2_value
10 import collections
.abc
13 def _bt2_trace_class():
14 from bt2
import trace_class
as bt2_trace_class
16 return bt2_trace_class
19 class _StreamClassConst(object._SharedObject
, collections
.abc
.Mapping
):
20 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
21 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
22 _borrow_event_class_ptr_by_id
= staticmethod(
23 native_bt
.stream_class_borrow_event_class_by_id_const
25 _borrow_event_class_ptr_by_index
= staticmethod(
26 native_bt
.stream_class_borrow_event_class_by_index_const
28 _borrow_trace_class_ptr
= staticmethod(
29 native_bt
.stream_class_borrow_trace_class_const
31 _borrow_packet_context_field_class_ptr
= staticmethod(
32 native_bt
.stream_class_borrow_packet_context_field_class_const
34 _borrow_event_common_context_field_class_ptr
= staticmethod(
35 native_bt
.stream_class_borrow_event_common_context_field_class_const
37 _borrow_default_clock_class_ptr
= staticmethod(
38 native_bt
.stream_class_borrow_default_clock_class_const
40 _borrow_user_attributes_ptr
= staticmethod(
41 native_bt
.stream_class_borrow_user_attributes_const
44 _event_class_cls
= property(lambda _
: bt2_event_class
._EventClassConst
)
45 _trace_class_cls
= property(lambda _
: _bt2_trace_class()._TraceClassConst
)
46 _clock_class_cls
= property(lambda _
: bt2_clock_class
._ClockClassConst
)
48 def __getitem__(self
, key
):
49 utils
._check
_int
64(key
)
50 ec_ptr
= self
._borrow
_event
_class
_ptr
_by
_id
(self
._ptr
, key
)
55 return self
._event
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(ec_ptr
)
58 count
= native_bt
.stream_class_get_event_class_count(self
._ptr
)
63 for idx
in range(len(self
)):
64 ec_ptr
= self
._borrow
_event
_class
_ptr
_by
_index
(self
._ptr
, idx
)
65 assert ec_ptr
is not None
67 id = native_bt
.event_class_get_id(ec_ptr
)
73 def trace_class(self
):
74 tc_ptr
= self
._borrow
_trace
_class
_ptr
(self
._ptr
)
76 if tc_ptr
is not None:
77 return self
._trace
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(tc_ptr
)
80 def user_attributes(self
):
81 ptr
= self
._borrow
_user
_attributes
_ptr
(self
._ptr
)
82 assert ptr
is not None
83 return bt2_value
._create
_from
_ptr
_and
_get
_ref
(ptr
)
87 return native_bt
.stream_class_get_name(self
._ptr
)
90 def assigns_automatic_event_class_id(self
):
91 return native_bt
.stream_class_assigns_automatic_event_class_id(self
._ptr
)
94 def assigns_automatic_stream_id(self
):
95 return native_bt
.stream_class_assigns_automatic_stream_id(self
._ptr
)
98 def supports_packets(self
):
99 return native_bt
.stream_class_supports_packets(self
._ptr
)
102 def packets_have_beginning_default_clock_snapshot(self
):
103 return native_bt
.stream_class_packets_have_beginning_default_clock_snapshot(
108 def packets_have_end_default_clock_snapshot(self
):
109 return native_bt
.stream_class_packets_have_end_default_clock_snapshot(self
._ptr
)
112 def supports_discarded_events(self
):
113 return native_bt
.stream_class_supports_discarded_events(self
._ptr
)
116 def discarded_events_have_default_clock_snapshots(self
):
117 return native_bt
.stream_class_discarded_events_have_default_clock_snapshots(
122 def supports_discarded_packets(self
):
123 return native_bt
.stream_class_supports_discarded_packets(self
._ptr
)
126 def discarded_packets_have_default_clock_snapshots(self
):
127 return native_bt
.stream_class_discarded_packets_have_default_clock_snapshots(
133 id = native_bt
.stream_class_get_id(self
._ptr
)
141 def packet_context_field_class(self
):
142 fc_ptr
= self
._borrow
_packet
_context
_field
_class
_ptr
(self
._ptr
)
147 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
150 def event_common_context_field_class(self
):
151 fc_ptr
= self
._borrow
_event
_common
_context
_field
_class
_ptr
(self
._ptr
)
156 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
159 def default_clock_class(self
):
160 cc_ptr
= self
._borrow
_default
_clock
_class
_ptr
(self
._ptr
)
164 return self
._clock
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(cc_ptr
)
167 class _StreamClass(_StreamClassConst
):
168 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
169 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
170 _borrow_event_class_ptr_by_id
= staticmethod(
171 native_bt
.stream_class_borrow_event_class_by_id
173 _borrow_event_class_ptr_by_index
= staticmethod(
174 native_bt
.stream_class_borrow_event_class_by_index
176 _borrow_trace_class_ptr
= staticmethod(native_bt
.stream_class_borrow_trace_class
)
177 _borrow_packet_context_field_class_ptr
= staticmethod(
178 native_bt
.stream_class_borrow_packet_context_field_class
180 _borrow_event_common_context_field_class_ptr
= staticmethod(
181 native_bt
.stream_class_borrow_event_common_context_field_class
183 _borrow_default_clock_class_ptr
= staticmethod(
184 native_bt
.stream_class_borrow_default_clock_class
186 _borrow_user_attributes_ptr
= staticmethod(
187 native_bt
.stream_class_borrow_user_attributes
190 _event_class_cls
= property(lambda s
: bt2_event_class
._EventClass
)
191 _trace_class_cls
= property(lambda s
: _bt2_trace_class()._TraceClass
)
192 _clock_class_cls
= property(lambda s
: bt2_clock_class
._ClockClass
)
194 def create_event_class(
198 user_attributes
=None,
201 specific_context_field_class
=None,
202 payload_field_class
=None,
204 # Validate parameters before we create the object.
205 bt2_event_class
._EventClass
._validate
_create
_params
(
210 specific_context_field_class
,
214 if self
.assigns_automatic_event_class_id
:
217 'id provided, but stream class assigns automatic event class ids'
220 ec_ptr
= native_bt
.event_class_create(self
._ptr
)
224 'id not provided, but stream class does not assign automatic event class ids'
227 utils
._check
_uint
64(id)
228 ec_ptr
= native_bt
.event_class_create_with_id(self
._ptr
, id)
230 event_class
= bt2_event_class
._EventClass
._create
_from
_ptr
(ec_ptr
)
233 event_class
._name
= name
235 if user_attributes
is not None:
236 event_class
._user
_attributes
= user_attributes
238 if log_level
is not None:
239 event_class
._log
_level
= log_level
241 if emf_uri
is not None:
242 event_class
._emf
_uri
= emf_uri
244 if specific_context_field_class
is not None:
245 event_class
._specific
_context
_field
_class
= specific_context_field_class
247 if payload_field_class
is not None:
248 event_class
._payload
_field
_class
= payload_field_class
252 def _user_attributes(self
, user_attributes
):
253 value
= bt2_value
.create_value(user_attributes
)
254 native_bt
.stream_class_set_user_attributes(self
._ptr
, value
._ptr
)
256 _user_attributes
= property(fset
=_user_attributes
)
258 def _name(self
, name
):
259 status
= native_bt
.stream_class_set_name(self
._ptr
, name
)
260 utils
._handle
_func
_status
(status
, "cannot set stream class object's name")
262 _name
= property(fset
=_name
)
264 def _assigns_automatic_event_class_id(self
, auto_id
):
265 native_bt
.stream_class_set_assigns_automatic_event_class_id(self
._ptr
, auto_id
)
267 _assigns_automatic_event_class_id
= property(fset
=_assigns_automatic_event_class_id
)
269 def _assigns_automatic_stream_id(self
, auto_id
):
270 native_bt
.stream_class_set_assigns_automatic_stream_id(self
._ptr
, auto_id
)
272 _assigns_automatic_stream_id
= property(fset
=_assigns_automatic_stream_id
)
274 def _set_supports_packets(self
, supports
, with_begin_cs
=False, with_end_cs
=False):
275 native_bt
.stream_class_set_supports_packets(
276 self
._ptr
, supports
, with_begin_cs
, with_end_cs
279 def _set_supports_discarded_events(self
, supports
, with_cs
=False):
280 native_bt
.stream_class_set_supports_discarded_events(
281 self
._ptr
, supports
, with_cs
284 _supports_discarded_events
= property(fset
=_set_supports_discarded_events
)
286 def _set_supports_discarded_packets(self
, supports
, with_cs
):
287 native_bt
.stream_class_set_supports_discarded_packets(
288 self
._ptr
, supports
, with_cs
291 _supports_discarded_packets
= property(fset
=_set_supports_discarded_packets
)
293 def _packet_context_field_class(self
, packet_context_field_class
):
294 status
= native_bt
.stream_class_set_packet_context_field_class(
295 self
._ptr
, packet_context_field_class
._ptr
297 utils
._handle
_func
_status
(
298 status
, "cannot set stream class' packet context field class"
301 _packet_context_field_class
= property(fset
=_packet_context_field_class
)
303 def _event_common_context_field_class(self
, event_common_context_field_class
):
304 set_context_fn
= native_bt
.stream_class_set_event_common_context_field_class
305 status
= set_context_fn(self
._ptr
, event_common_context_field_class
._ptr
)
306 utils
._handle
_func
_status
(
307 status
, "cannot set stream class' event context field type"
310 _event_common_context_field_class
= property(fset
=_event_common_context_field_class
)
312 def _default_clock_class(self
, clock_class
):
313 native_bt
.stream_class_set_default_clock_class(self
._ptr
, clock_class
._ptr
)
315 _default_clock_class
= property(fset
=_default_clock_class
)
318 def _validate_create_params(
322 packet_context_field_class
,
323 event_common_context_field_class
,
325 assigns_automatic_event_class_id
,
326 assigns_automatic_stream_id
,
328 packets_have_beginning_default_clock_snapshot
,
329 packets_have_end_default_clock_snapshot
,
330 supports_discarded_events
,
331 discarded_events_have_default_clock_snapshots
,
332 supports_discarded_packets
,
333 discarded_packets_have_default_clock_snapshots
,
337 utils
._check
_str
(name
)
340 if user_attributes
is not None:
341 value
= bt2_value
.create_value(user_attributes
)
342 utils
._check
_type
(value
, bt2_value
.MapValue
)
344 # Packet context field class
345 if packet_context_field_class
is not None:
346 if not supports_packets
:
348 'cannot have a packet context field class without supporting packets'
352 packet_context_field_class
, bt2_field_class
._StructureFieldClass
355 # Event common context field class
356 if event_common_context_field_class
is not None:
358 event_common_context_field_class
, bt2_field_class
._StructureFieldClass
361 # Default clock class
362 if default_clock_class
is not None:
363 utils
._check
_type
(default_clock_class
, bt2_clock_class
._ClockClass
)
365 # Assigns automatic event class id
366 utils
._check
_bool
(assigns_automatic_event_class_id
)
368 # Assigns automatic stream id
369 utils
._check
_bool
(assigns_automatic_stream_id
)
372 utils
._check
_bool
(supports_packets
)
373 utils
._check
_bool
(packets_have_beginning_default_clock_snapshot
)
374 utils
._check
_bool
(packets_have_end_default_clock_snapshot
)
376 if not supports_packets
:
377 if packets_have_beginning_default_clock_snapshot
:
379 'cannot not support packets, but have packet beginning default clock snapshot'
381 if packets_have_end_default_clock_snapshot
:
383 'cannot not support packets, but have packet end default clock snapshots'
387 utils
._check
_bool
(supports_discarded_events
)
388 utils
._check
_bool
(discarded_events_have_default_clock_snapshots
)
391 not supports_discarded_events
392 and discarded_events_have_default_clock_snapshots
395 'cannot not support discarded events, but have default clock snapshots for discarded event messages'
399 utils
._check
_bool
(supports_discarded_packets
)
400 utils
._check
_bool
(discarded_packets_have_default_clock_snapshots
)
402 if supports_discarded_packets
and not supports_packets
:
404 'cannot support discarded packets, but not support packets'
408 not supports_discarded_packets
409 and discarded_packets_have_default_clock_snapshots
412 'cannot not support discarded packets, but have default clock snapshots for discarded packet messages'