1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 # Permission is hereby granted, free of charge, to any person obtaining a copy
6 # of this software and associated documentation files (the "Software"), to deal
7 # in the Software without restriction, including without limitation the rights
8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 # copies of the Software, and to permit persons to whom the Software is
10 # furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 from bt2
import native_bt
, object, utils
24 from bt2
import message
as bt2_message
25 import collections
.abc
26 from bt2
import stream
as bt2_stream
27 from bt2
import event_class
as bt2_event_class
28 from bt2
import packet
as bt2_packet
29 from bt2
import port
as bt2_port
30 from bt2
import clock_class
as bt2_clock_class
34 class _MessageIterator(collections
.abc
.Iterator
):
36 raise NotImplementedError
39 class _UserComponentInputPortMessageIterator(object._SharedObject
, _MessageIterator
):
40 _get_ref
= staticmethod(
41 native_bt
.self_component_port_input_message_iterator_get_ref
43 _put_ref
= staticmethod(
44 native_bt
.self_component_port_input_message_iterator_put_ref
47 def __init__(self
, ptr
):
48 self
._current
_msgs
= []
53 if len(self
._current
_msgs
) == self
._at
:
54 status
, msgs
= native_bt
.bt2_self_component_port_input_get_msg_range(
57 utils
._handle
_func
_status
(
58 status
, 'unexpected error: cannot advance the message iterator'
60 self
._current
_msgs
= msgs
63 msg_ptr
= self
._current
_msgs
[self
._at
]
66 return bt2_message
._create
_from
_ptr
(msg_ptr
)
68 def can_seek_beginning(self
):
72 ) = native_bt
.self_component_port_input_message_iterator_can_seek_beginning(
75 utils
._handle
_func
_status
(
77 'cannot check whether or not message iterator can seek its beginning',
81 def seek_beginning(self
):
82 # Forget about buffered messages, they won't be valid after seeking.
83 self
._current
_msgs
.clear()
86 status
= native_bt
.self_component_port_input_message_iterator_seek_beginning(
89 utils
._handle
_func
_status
(status
, 'cannot seek message iterator beginning')
91 def can_seek_ns_from_origin(self
, ns_from_origin
):
92 utils
._check
_int
64(ns_from_origin
)
96 ) = native_bt
.self_component_port_input_message_iterator_can_seek_ns_from_origin(
97 self
._ptr
, ns_from_origin
99 utils
._handle
_func
_status
(
101 'cannot check whether or not message iterator can seek given ns from origin',
105 def seek_ns_from_origin(self
, ns_from_origin
):
106 utils
._check
_int
64(ns_from_origin
)
108 # Forget about buffered messages, they won't be valid after seeking.
109 self
._current
_msgs
.clear()
112 status
= native_bt
.self_component_port_input_message_iterator_seek_ns_from_origin(
113 self
._ptr
, ns_from_origin
115 utils
._handle
_func
_status
(
116 status
, 'message iterator cannot seek given ns from origin'
120 def can_seek_forward(self
):
121 return native_bt
.self_component_port_input_message_iterator_can_seek_forward(
126 class _MessageIteratorConfiguration
:
127 def __init__(self
, ptr
):
130 def can_seek_forward(self
, value
):
131 utils
._check
_bool
(value
)
132 native_bt
.self_message_iterator_configuration_set_can_seek_forward(
136 can_seek_forward
= property(fset
=can_seek_forward
)
139 # This is extended by the user to implement component classes in Python. It
140 # is created for a given output port when an input port message iterator is
141 # created on the input port on the other side of the connection. It is also
142 # created when an output port message iterator is created on this output port.
144 # Its purpose is to feed the messages that should go out through this output
146 class _UserMessageIterator(_MessageIterator
):
147 def __new__(cls
, ptr
):
148 # User iterator objects are always created by the native side,
149 # that is, never instantiated directly by Python code.
151 # The native code calls this, then manually calls
152 # self.__init__() without the `ptr` argument. The user has
153 # access to self.component during this call, thanks to this
154 # self._bt_ptr argument being set.
156 # self._bt_ptr is NOT owned by this object here, so there's nothing
157 # to do in __del__().
158 self
= super().__new
__(cls
)
162 def _bt_init_from_native(self
, config_ptr
, self_output_port_ptr
):
163 self_output_port
= bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
164 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
166 config
= _MessageIteratorConfiguration(config_ptr
)
167 self
.__init
__(config
, self_output_port
)
169 def __init__(self
, config
, self_output_port
):
173 def _component(self
):
174 return native_bt
.bt2_get_user_component_from_user_msg_iter(self
._bt
_ptr
)
178 port_ptr
= native_bt
.self_message_iterator_borrow_port(self
._bt
_ptr
)
179 assert port_ptr
is not None
180 return bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
181 port_ptr
, native_bt
.PORT_TYPE_OUTPUT
186 return int(self
._bt
_ptr
)
189 def _is_interrupted(self
):
190 return bool(native_bt
.self_message_iterator_is_interrupted(self
._bt
_ptr
))
192 def _user_finalize(self
):
198 def _bt_next_from_native(self
):
199 # this can raise anything: it's catched by the native part
202 except StopIteration:
207 utils
._check
_type
(msg
, bt2_message
._MessageConst
)
209 # The reference we return will be given to the message array.
210 # However, the `msg` Python object may stay alive, if the user has kept
211 # a reference to it. Acquire a new reference to account for that.
212 msg
._get
_ref
(msg
._ptr
)
215 def _bt_can_seek_beginning_from_native(self
):
216 # Here, we mimic the behavior of the C API:
218 # - If the iterator has a _user_can_seek_beginning method,
219 # read it and use that result.
220 # - Otherwise, the presence or absence of a `_user_seek_beginning`
221 # method indicates whether the iterator can seek beginning.
222 if hasattr(self
, '_user_can_seek_beginning'):
223 can_seek_beginning
= self
._user
_can
_seek
_beginning
()
224 utils
._check
_bool
(can_seek_beginning
)
225 return can_seek_beginning
227 return hasattr(self
, '_user_seek_beginning')
229 def _bt_seek_beginning_from_native(self
):
230 self
._user
_seek
_beginning
()
232 def _bt_can_seek_ns_from_origin_from_native(self
, ns_from_origin
):
233 # Return whether the iterator can seek ns from origin using the
234 # user-implemented seek_ns_from_origin method. We mimic the behavior
237 # - If the iterator has a _user_can_seek_ns_from_origin method,
238 # call it and use its return value.
239 # - Otherwise, if there is a `_user_seek_ns_from_origin` method,
240 # we presume it's possible.
242 if hasattr(self
, '_user_can_seek_ns_from_origin'):
243 can_seek_ns_from_origin
= self
._user
_can
_seek
_ns
_from
_origin
(ns_from_origin
)
244 utils
._check
_bool
(can_seek_ns_from_origin
)
245 return can_seek_ns_from_origin
247 return hasattr(self
, '_user_seek_ns_from_origin')
249 def _bt_seek_ns_from_origin_from_native(self
, ns_from_origin
):
250 self
._user
_seek
_ns
_from
_origin
(ns_from_origin
)
252 def _create_input_port_message_iterator(self
, input_port
):
253 utils
._check
_type
(input_port
, bt2_port
._UserComponentInputPort
)
258 ) = native_bt
.bt2_self_component_port_input_message_iterator_create_from_message_iterator(
259 self
._bt
_ptr
, input_port
._ptr
261 utils
._handle
_func
_status
(status
, 'cannot create message iterator object')
262 assert msg_iter_ptr
is not None
264 return _UserComponentInputPortMessageIterator(msg_iter_ptr
)
266 def _create_event_message(self
, event_class
, parent
, default_clock_snapshot
=None):
267 utils
._check
_type
(event_class
, bt2_event_class
._EventClass
)
269 if event_class
.stream_class
.supports_packets
:
270 utils
._check
_type
(parent
, bt2_packet
._Packet
)
272 utils
._check
_type
(parent
, bt2_stream
._Stream
)
274 if default_clock_snapshot
is not None:
275 if event_class
.stream_class
.default_clock_class
is None:
277 'event messages in this stream must not have a default clock snapshot'
280 utils
._check
_uint
64(default_clock_snapshot
)
282 if event_class
.stream_class
.supports_packets
:
283 ptr
= native_bt
.message_event_create_with_packet_and_default_clock_snapshot(
284 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
287 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
288 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
291 if event_class
.stream_class
.default_clock_class
is not None:
293 'event messages in this stream must have a default clock snapshot'
296 if event_class
.stream_class
.supports_packets
:
297 ptr
= native_bt
.message_event_create_with_packet(
298 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
301 ptr
= native_bt
.message_event_create(
302 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
306 raise bt2
._MemoryError('cannot create event message object')
308 return bt2_message
._EventMessage
(ptr
)
310 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
311 utils
._check
_type
(clock_class
, bt2_clock_class
._ClockClass
)
312 ptr
= native_bt
.message_message_iterator_inactivity_create(
313 self
._bt
_ptr
, clock_class
._ptr
, clock_snapshot
317 raise bt2
._MemoryError('cannot create inactivity message object')
319 return bt2_message
._MessageIteratorInactivityMessage
(ptr
)
321 def _create_stream_beginning_message(self
, stream
, default_clock_snapshot
=None):
322 utils
._check
_type
(stream
, bt2_stream
._Stream
)
324 ptr
= native_bt
.message_stream_beginning_create(self
._bt
_ptr
, stream
._ptr
)
326 raise bt2
._MemoryError('cannot create stream beginning message object')
328 msg
= bt2_message
._StreamBeginningMessage
(ptr
)
330 if default_clock_snapshot
is not None:
331 msg
._default
_clock
_snapshot
= default_clock_snapshot
335 def _create_stream_end_message(self
, stream
, default_clock_snapshot
=None):
336 utils
._check
_type
(stream
, bt2_stream
._Stream
)
338 ptr
= native_bt
.message_stream_end_create(self
._bt
_ptr
, stream
._ptr
)
340 raise bt2
._MemoryError('cannot create stream end message object')
342 msg
= bt2_message
._StreamEndMessage
(ptr
)
344 if default_clock_snapshot
is not None:
345 msg
._default
_clock
_snapshot
= default_clock_snapshot
349 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
350 utils
._check
_type
(packet
, bt2_packet
._Packet
)
352 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
353 if default_clock_snapshot
is None:
355 "packet beginning messages in this stream must have a default clock snapshot"
358 utils
._check
_uint
64(default_clock_snapshot
)
359 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
360 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
363 if default_clock_snapshot
is not None:
365 "packet beginning messages in this stream must not have a default clock snapshot"
368 ptr
= native_bt
.message_packet_beginning_create(self
._bt
_ptr
, packet
._ptr
)
371 raise bt2
._MemoryError('cannot create packet beginning message object')
373 return bt2_message
._PacketBeginningMessage
(ptr
)
375 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
376 utils
._check
_type
(packet
, bt2_packet
._Packet
)
378 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
379 if default_clock_snapshot
is None:
381 "packet end messages in this stream must have a default clock snapshot"
384 utils
._check
_uint
64(default_clock_snapshot
)
385 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
386 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
389 if default_clock_snapshot
is not None:
391 "packet end messages in this stream must not have a default clock snapshot"
394 ptr
= native_bt
.message_packet_end_create(self
._bt
_ptr
, packet
._ptr
)
397 raise bt2
._MemoryError('cannot create packet end message object')
399 return bt2_message
._PacketEndMessage
(ptr
)
401 def _create_discarded_events_message(
402 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
404 utils
._check
_type
(stream
, bt2_stream
._Stream
)
406 if not stream
.cls
.supports_discarded_events
:
407 raise ValueError('stream class does not support discarded events')
409 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
410 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
412 'discarded events have default clock snapshots for this stream class'
415 utils
._check
_uint
64(beg_clock_snapshot
)
416 utils
._check
_uint
64(end_clock_snapshot
)
417 ptr
= native_bt
.message_discarded_events_create_with_default_clock_snapshots(
418 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
421 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
423 'discarded events have no default clock snapshots for this stream class'
426 ptr
= native_bt
.message_discarded_events_create(self
._bt
_ptr
, stream
._ptr
)
429 raise bt2
._MemoryError('cannot discarded events message object')
431 msg
= bt2_message
._DiscardedEventsMessage
(ptr
)
433 if count
is not None:
438 def _create_discarded_packets_message(
439 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
441 utils
._check
_type
(stream
, bt2_stream
._Stream
)
443 if not stream
.cls
.supports_discarded_packets
:
444 raise ValueError('stream class does not support discarded packets')
446 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
447 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
449 'discarded packets have default clock snapshots for this stream class'
452 utils
._check
_uint
64(beg_clock_snapshot
)
453 utils
._check
_uint
64(end_clock_snapshot
)
454 ptr
= native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
455 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
458 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
460 'discarded packets have no default clock snapshots for this stream class'
463 ptr
= native_bt
.message_discarded_packets_create(self
._bt
_ptr
, stream
._ptr
)
466 raise bt2
._MemoryError('cannot discarded packets message object')
468 msg
= bt2_message
._DiscardedPacketsMessage
(ptr
)
470 if count
is not None: