1 # SPDX-License-Identifier: MIT
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 from bt2
import native_bt
6 from bt2
import object as bt2_object
7 from bt2
import utils
as bt2_utils
8 from bt2
import message
as bt2_message
10 from bt2
import stream
as bt2_stream
11 from bt2
import event_class
as bt2_event_class
12 from bt2
import packet
as bt2_packet
13 from bt2
import port
as bt2_port
14 from bt2
import clock_class
as bt2_clock_class
15 from bt2
import error
as bt2_error
18 class _MessageIterator(collections
.abc
.Iterator
):
20 raise NotImplementedError
23 class _UserComponentInputPortMessageIterator(
24 bt2_object
._SharedObject
, _MessageIterator
28 native_bt
.message_iterator_get_ref(ptr
)
32 native_bt
.message_iterator_put_ref(ptr
)
34 def __init__(self
, ptr
):
35 self
._current
_msgs
= []
40 if len(self
._current
_msgs
) == self
._at
:
41 status
, msgs
= native_bt
.bt2_self_component_port_input_get_msg_range(
44 bt2_utils
._handle
_func
_status
(
45 status
, "unexpected error: cannot advance the message iterator"
47 self
._current
_msgs
= msgs
50 msg_ptr
= self
._current
_msgs
[self
._at
]
53 return bt2_message
._create
_from
_ptr
(msg_ptr
)
55 def can_seek_beginning(self
):
56 (status
, res
) = native_bt
.message_iterator_can_seek_beginning(self
._ptr
)
57 bt2_utils
._handle
_func
_status
(
59 "cannot check whether or not message iterator can seek its beginning",
63 def seek_beginning(self
):
64 # Forget about buffered messages, they won't be valid after seeking.
65 self
._current
_msgs
.clear()
68 status
= native_bt
.message_iterator_seek_beginning(self
._ptr
)
69 bt2_utils
._handle
_func
_status
(status
, "cannot seek message iterator beginning")
71 def can_seek_ns_from_origin(self
, ns_from_origin
):
72 bt2_utils
._check
_int
64(ns_from_origin
)
73 (status
, res
) = native_bt
.message_iterator_can_seek_ns_from_origin(
74 self
._ptr
, ns_from_origin
76 bt2_utils
._handle
_func
_status
(
78 "cannot check whether or not message iterator can seek given ns from origin",
82 def seek_ns_from_origin(self
, ns_from_origin
):
83 bt2_utils
._check
_int
64(ns_from_origin
)
85 # Forget about buffered messages, they won't be valid after seeking.
86 self
._current
_msgs
.clear()
89 status
= native_bt
.message_iterator_seek_ns_from_origin(
90 self
._ptr
, ns_from_origin
92 bt2_utils
._handle
_func
_status
(
93 status
, "message iterator cannot seek given ns from origin"
97 def can_seek_forward(self
):
98 return native_bt
.message_iterator_can_seek_forward(self
._ptr
)
101 class _MessageIteratorConfiguration
:
102 def __init__(self
, ptr
):
105 def can_seek_forward(self
, value
):
106 bt2_utils
._check
_bool
(value
)
107 native_bt
.self_message_iterator_configuration_set_can_seek_forward(
111 can_seek_forward
= property(fset
=can_seek_forward
)
114 # This is extended by the user to implement component classes in Python. It
115 # is created for a given output port when an input port message iterator is
116 # created on the input port on the other side of the connection.
118 # Its purpose is to feed the messages that should go out through this output
120 class _UserMessageIterator(_MessageIterator
):
121 def __new__(cls
, ptr
):
122 # User iterator objects are always created by the native side,
123 # that is, never instantiated directly by Python code.
125 # The native code calls this, then manually calls
126 # self.__init__() without the `ptr` argument. The user has
127 # access to self.component during this call, thanks to this
128 # self._bt_ptr argument being set.
130 # self._bt_ptr is NOT owned by this object here, so there's nothing
131 # to do in __del__().
132 self
= super().__new
__(cls
)
136 def _bt_init_from_native(self
, config_ptr
, self_output_port_ptr
):
137 self_output_port
= bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
138 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
140 config
= _MessageIteratorConfiguration(config_ptr
)
141 self
.__init
__(config
, self_output_port
)
143 def __init__(self
, config
, self_output_port
):
147 def _component(self
):
148 return native_bt
.bt2_get_user_component_from_user_msg_iter(self
._bt
_ptr
)
152 port_ptr
= native_bt
.self_message_iterator_borrow_port(self
._bt
_ptr
)
153 assert port_ptr
is not None
154 return bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
155 port_ptr
, native_bt
.PORT_TYPE_OUTPUT
160 return int(self
._bt
_ptr
)
163 def _is_interrupted(self
):
164 return bool(native_bt
.self_message_iterator_is_interrupted(self
._bt
_ptr
))
166 def _user_finalize(self
):
172 def _bt_next_from_native(self
):
173 # this can raise anything: it's catched by the native part
176 except StopIteration:
181 bt2_utils
._check
_type
(msg
, bt2_message
._MessageConst
)
183 # The reference we return will be given to the message array.
184 # However, the `msg` Python object may stay alive, if the user has kept
185 # a reference to it. Acquire a new reference to account for that.
186 msg
._get
_ref
(msg
._ptr
)
189 def _bt_can_seek_beginning_from_native(self
):
190 # Here, we mimic the behavior of the C API:
192 # - If the iterator has a _user_can_seek_beginning method,
193 # read it and use that result.
194 # - Otherwise, the presence or absence of a `_user_seek_beginning`
195 # method indicates whether the iterator can seek beginning.
196 if hasattr(self
, "_user_can_seek_beginning"):
197 can_seek_beginning
= self
._user
_can
_seek
_beginning
()
198 bt2_utils
._check
_bool
(can_seek_beginning
)
199 return can_seek_beginning
201 return hasattr(self
, "_user_seek_beginning")
203 def _bt_seek_beginning_from_native(self
):
204 self
._user
_seek
_beginning
()
206 def _bt_can_seek_ns_from_origin_from_native(self
, ns_from_origin
):
207 # Return whether the iterator can seek ns from origin using the
208 # user-implemented seek_ns_from_origin method. We mimic the behavior
211 # - If the iterator has a _user_can_seek_ns_from_origin method,
212 # call it and use its return value.
213 # - Otherwise, if there is a `_user_seek_ns_from_origin` method,
214 # we presume it's possible.
216 if hasattr(self
, "_user_can_seek_ns_from_origin"):
217 can_seek_ns_from_origin
= self
._user
_can
_seek
_ns
_from
_origin
(ns_from_origin
)
218 bt2_utils
._check
_bool
(can_seek_ns_from_origin
)
219 return can_seek_ns_from_origin
221 return hasattr(self
, "_user_seek_ns_from_origin")
223 def _bt_seek_ns_from_origin_from_native(self
, ns_from_origin
):
224 self
._user
_seek
_ns
_from
_origin
(ns_from_origin
)
226 def _create_message_iterator(self
, input_port
):
227 bt2_utils
._check
_type
(input_port
, bt2_port
._UserComponentInputPort
)
229 if not input_port
.is_connected
:
230 raise ValueError("input port is not connected")
235 ) = native_bt
.bt2_message_iterator_create_from_message_iterator(
236 self
._bt
_ptr
, input_port
._ptr
238 bt2_utils
._handle
_func
_status
(status
, "cannot create message iterator object")
239 assert msg_iter_ptr
is not None
241 return _UserComponentInputPortMessageIterator(msg_iter_ptr
)
243 def _create_event_message(self
, event_class
, parent
, default_clock_snapshot
=None):
244 bt2_utils
._check
_type
(event_class
, bt2_event_class
._EventClass
)
246 if event_class
.stream_class
.supports_packets
:
247 bt2_utils
._check
_type
(parent
, bt2_packet
._Packet
)
249 bt2_utils
._check
_type
(parent
, bt2_stream
._Stream
)
251 if default_clock_snapshot
is not None:
252 if event_class
.stream_class
.default_clock_class
is None:
254 "event messages in this stream must not have a default clock snapshot"
257 bt2_utils
._check
_uint
64(default_clock_snapshot
)
259 if event_class
.stream_class
.supports_packets
:
260 ptr
= native_bt
.message_event_create_with_packet_and_default_clock_snapshot(
261 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
264 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
265 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
268 if event_class
.stream_class
.default_clock_class
is not None:
270 "event messages in this stream must have a default clock snapshot"
273 if event_class
.stream_class
.supports_packets
:
274 ptr
= native_bt
.message_event_create_with_packet(
275 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
278 ptr
= native_bt
.message_event_create(
279 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
283 raise bt2_error
._MemoryError
("cannot create event message object")
285 return bt2_message
._EventMessage
(ptr
)
287 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
288 bt2_utils
._check
_type
(clock_class
, bt2_clock_class
._ClockClass
)
289 ptr
= native_bt
.message_message_iterator_inactivity_create(
290 self
._bt
_ptr
, clock_class
._ptr
, clock_snapshot
294 raise bt2_error
._MemoryError
("cannot create inactivity message object")
296 return bt2_message
._MessageIteratorInactivityMessage
(ptr
)
298 def _create_stream_beginning_message(self
, stream
, default_clock_snapshot
=None):
299 bt2_utils
._check
_type
(stream
, bt2_stream
._Stream
)
301 ptr
= native_bt
.message_stream_beginning_create(self
._bt
_ptr
, stream
._ptr
)
303 raise bt2_error
._MemoryError
(
304 "cannot create stream beginning message object"
307 msg
= bt2_message
._StreamBeginningMessage
(ptr
)
309 if default_clock_snapshot
is not None:
310 msg
._default
_clock
_snapshot
= default_clock_snapshot
314 def _create_stream_end_message(self
, stream
, default_clock_snapshot
=None):
315 bt2_utils
._check
_type
(stream
, bt2_stream
._Stream
)
317 ptr
= native_bt
.message_stream_end_create(self
._bt
_ptr
, stream
._ptr
)
319 raise bt2_error
._MemoryError
("cannot create stream end message object")
321 msg
= bt2_message
._StreamEndMessage
(ptr
)
323 if default_clock_snapshot
is not None:
324 msg
._default
_clock
_snapshot
= default_clock_snapshot
328 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
329 bt2_utils
._check
_type
(packet
, bt2_packet
._Packet
)
331 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
332 if default_clock_snapshot
is None:
334 "packet beginning messages in this stream must have a default clock snapshot"
337 bt2_utils
._check
_uint
64(default_clock_snapshot
)
338 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
339 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
342 if default_clock_snapshot
is not None:
344 "packet beginning messages in this stream must not have a default clock snapshot"
347 ptr
= native_bt
.message_packet_beginning_create(self
._bt
_ptr
, packet
._ptr
)
350 raise bt2_error
._MemoryError
(
351 "cannot create packet beginning message object"
354 return bt2_message
._PacketBeginningMessage
(ptr
)
356 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
357 bt2_utils
._check
_type
(packet
, bt2_packet
._Packet
)
359 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
360 if default_clock_snapshot
is None:
362 "packet end messages in this stream must have a default clock snapshot"
365 bt2_utils
._check
_uint
64(default_clock_snapshot
)
366 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
367 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
370 if default_clock_snapshot
is not None:
372 "packet end messages in this stream must not have a default clock snapshot"
375 ptr
= native_bt
.message_packet_end_create(self
._bt
_ptr
, packet
._ptr
)
378 raise bt2_error
._MemoryError
("cannot create packet end message object")
380 return bt2_message
._PacketEndMessage
(ptr
)
382 def _create_discarded_events_message(
383 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
385 bt2_utils
._check
_type
(stream
, bt2_stream
._Stream
)
387 if not stream
.cls
.supports_discarded_events
:
388 raise ValueError("stream class does not support discarded events")
390 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
391 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
393 "discarded events have default clock snapshots for this stream class"
396 bt2_utils
._check
_uint
64(beg_clock_snapshot
)
397 bt2_utils
._check
_uint
64(end_clock_snapshot
)
399 if beg_clock_snapshot
> end_clock_snapshot
:
401 "beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})".format(
402 beg_clock_snapshot
, end_clock_snapshot
407 native_bt
.message_discarded_events_create_with_default_clock_snapshots(
408 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
412 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
414 "discarded events have no default clock snapshots for this stream class"
417 ptr
= native_bt
.message_discarded_events_create(self
._bt
_ptr
, stream
._ptr
)
420 raise bt2_error
._MemoryError
("cannot discarded events message object")
422 msg
= bt2_message
._DiscardedEventsMessage
(ptr
)
424 if count
is not None:
429 def _create_discarded_packets_message(
430 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
432 bt2_utils
._check
_type
(stream
, bt2_stream
._Stream
)
434 if not stream
.cls
.supports_discarded_packets
:
435 raise ValueError("stream class does not support discarded packets")
437 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
438 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
440 "discarded packets have default clock snapshots for this stream class"
443 bt2_utils
._check
_uint
64(beg_clock_snapshot
)
444 bt2_utils
._check
_uint
64(end_clock_snapshot
)
446 if beg_clock_snapshot
> end_clock_snapshot
:
448 "beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})".format(
449 beg_clock_snapshot
, end_clock_snapshot
454 native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
455 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
459 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
461 "discarded packets have no default clock snapshots for this stream class"
464 ptr
= native_bt
.message_discarded_packets_create(self
._bt
_ptr
, stream
._ptr
)
467 raise bt2_error
._MemoryError
("cannot discarded packets message object")
469 msg
= bt2_message
._DiscardedPacketsMessage
(ptr
)
471 if count
is not None: