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
25 import collections
.abc
30 class _MessageIterator(collections
.abc
.Iterator
):
32 raise NotImplementedError
35 class _GenericMessageIterator(object._SharedObject
, _MessageIterator
):
36 def __init__(self
, ptr
):
37 self
._current
_msgs
= []
42 if len(self
._current
_msgs
) == self
._at
:
43 status
, msgs
= self
._get
_msg
_range
(self
._ptr
)
44 utils
._handle
_func
_status
(status
,
45 'unexpected error: cannot advance the message iterator')
46 self
._current
_msgs
= msgs
49 msg_ptr
= self
._current
_msgs
[self
._at
]
52 return bt2
.message
._create
_from
_ptr
(msg_ptr
)
55 def can_seek_beginning(self
):
56 res
= self
._can
_seek
_beginning
(self
._ptr
)
59 def seek_beginning(self
):
60 # Forget about buffered messages, they won't be valid after seeking..
61 self
._current
_msgs
.clear()
64 status
= self
._seek
_beginning
(self
._ptr
)
65 utils
._handle
_func
_status
(status
,
66 'cannot seek message iterator beginning')
69 # This is created when a component wants to iterate on one of its input ports.
70 class _UserComponentInputPortMessageIterator(_GenericMessageIterator
):
71 _get_msg_range
= staticmethod(native_bt
.bt2_self_component_port_input_get_msg_range
)
72 _get_ref
= staticmethod(native_bt
.self_component_port_input_message_iterator_get_ref
)
73 _put_ref
= staticmethod(native_bt
.self_component_port_input_message_iterator_put_ref
)
74 _can_seek_beginning
= staticmethod(native_bt
.self_component_port_input_message_iterator_can_seek_beginning
)
75 _seek_beginning
= staticmethod(native_bt
.self_component_port_input_message_iterator_seek_beginning
)
78 # This is created when the user wants to iterate on a component's output port,
79 # from outside the graph.
80 class _OutputPortMessageIterator(_GenericMessageIterator
):
81 _get_msg_range
= staticmethod(native_bt
.bt2_port_output_get_msg_range
)
82 _get_ref
= staticmethod(native_bt
.port_output_message_iterator_get_ref
)
83 _put_ref
= staticmethod(native_bt
.port_output_message_iterator_put_ref
)
84 _can_seek_beginning
= staticmethod(native_bt
.port_output_message_iterator_can_seek_beginning
)
85 _seek_beginning
= staticmethod(native_bt
.port_output_message_iterator_seek_beginning
)
88 # This is extended by the user to implement component classes in Python. It
89 # is created for a given output port when an input port message iterator is
90 # created on the input port on the other side of the connection. It is also
91 # created when an output port message iterator is created on this output port.
93 # Its purpose is to feed the messages that should go out through this output
95 class _UserMessageIterator(_MessageIterator
):
96 def __new__(cls
, ptr
):
97 # User iterator objects are always created by the native side,
98 # that is, never instantiated directly by Python code.
100 # The native code calls this, then manually calls
101 # self.__init__() without the `ptr` argument. The user has
102 # access to self.component during this call, thanks to this
103 # self._ptr argument being set.
105 # self._ptr is NOT owned by this object here, so there's nothing
106 # to do in __del__().
107 self
= super().__new
__(cls
)
111 def _init_from_native(self
, self_output_port_ptr
):
112 self_output_port
= bt2
.port
._create
_self
_from
_ptr
_and
_get
_ref
(
113 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
)
114 self
.__init
__(self_output_port
)
116 def __init__(self
, output_port
):
120 def _component(self
):
121 return native_bt
.bt2_get_user_component_from_user_msg_iter(self
._ptr
)
125 return int(self
._ptr
)
133 def _next_from_native(self
):
134 # this can raise anything: it's catched by the native part
137 except StopIteration:
142 utils
._check
_type
(msg
, bt2
.message
._Message
)
144 # The reference we return will be given to the message array.
145 # However, the `msg` Python object may stay alive, if the user has kept
146 # a reference to it. Acquire a new reference to account for that.
147 msg
._get
_ref
(msg
._ptr
)
151 def _can_seek_beginning_from_native(self
):
152 # Here, we mimic the behavior of the C API:
154 # - If the iterator has a _can_seek_beginning attribute, read it and use
156 # - Otherwise, the presence or absence of a `_seek_beginning`
157 # method indicates whether the iterator can seek beginning.
158 if hasattr(self
, '_can_seek_beginning'):
159 can_seek_beginning
= self
._can
_seek
_beginning
160 utils
._check
_bool
(can_seek_beginning
)
161 return can_seek_beginning
163 return hasattr(self
, '_seek_beginning')
165 def _seek_beginning_from_native(self
):
166 self
._seek
_beginning
()
168 def _create_event_message(self
, event_class
, packet
, default_clock_snapshot
=None):
169 utils
._check
_type
(event_class
, bt2
.event_class
._EventClass
)
170 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
172 if default_clock_snapshot
is not None:
173 if event_class
.stream_class
.default_clock_class
is None:
174 raise ValueError('event messages in this stream must not have a default clock snapshot')
176 utils
._check
_uint
64(default_clock_snapshot
)
177 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
178 self
._ptr
, event_class
._ptr
, packet
._ptr
, default_clock_snapshot
)
180 if event_class
.stream_class
.default_clock_class
is not None:
181 raise ValueError('event messages in this stream must have a default clock snapshot')
183 ptr
= native_bt
.message_event_create(
184 self
._ptr
, event_class
._ptr
, packet
._ptr
)
187 raise bt2
.CreationError('cannot create event message object')
189 return bt2
.message
._EventMessage
(ptr
)
191 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
192 utils
._check
_type
(clock_class
, bt2
.clock_class
._ClockClass
)
193 ptr
= native_bt
.message_message_iterator_inactivity_create(
194 self
._ptr
, clock_class
._ptr
, clock_snapshot
)
197 raise bt2
.CreationError('cannot create inactivity message object')
199 return bt2
.message
._MessageIteratorInactivityMessage
(ptr
)
201 _unknown_clock_snapshot
= bt2
.message
._StreamActivityMessageUnknownClockSnapshot
()
202 _infinite_clock_snapshot
= bt2
.message
._StreamActivityMessageInfiniteClockSnapshot
()
205 def _validate_stream_activity_message_default_clock_snapshot(stream
, default_cs
):
206 isinst_infinite
= isinstance(default_cs
, bt2
.message
._StreamActivityMessageInfiniteClockSnapshot
)
207 isinst_unknown
= isinstance(default_cs
, bt2
.message
._StreamActivityMessageUnknownClockSnapshot
)
209 if utils
._is
_uint
64(default_cs
):
211 elif isinst_infinite
or isinst_unknown
:
212 if default_cs
is not _UserMessageIterator
._unknown
_clock
_snapshot
and default_cs
is not _UserMessageIterator
._infinite
_clock
_snapshot
:
213 raise ValueError('unexpected value for default clock snapshot')
215 raise TypeError("unexpected type '{}' for default clock snapshot".format(default_cs
.__class
__.__name
__))
217 if stream
.cls
.default_clock_class
is None:
218 if utils
._is
_uint
64(default_cs
):
219 raise ValueError('stream activity messages in this stream cannot have a known default clock snapshot')
221 def _create_stream_beginning_message(self
, stream
):
222 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
224 ptr
= native_bt
.message_stream_beginning_create(self
._ptr
, stream
._ptr
)
226 raise bt2
.CreationError('cannot create stream beginning message object')
228 return bt2
.message
._StreamBeginningMessage
(ptr
)
230 def _create_stream_activity_beginning_message(self
, stream
,
231 default_clock_snapshot
=_unknown_clock_snapshot
):
232 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
233 self
._validate
_stream
_activity
_message
_default
_clock
_snapshot
(stream
, default_clock_snapshot
)
234 ptr
= native_bt
.message_stream_activity_beginning_create(self
._ptr
, stream
._ptr
)
237 raise bt2
.CreationError(
238 'cannot create stream activity beginning message object')
240 msg
= bt2
.message
._StreamActivityBeginningMessage
(ptr
)
241 msg
._default
_clock
_snapshot
= default_clock_snapshot
244 def _create_stream_activity_end_message(self
, stream
,
245 default_clock_snapshot
=_unknown_clock_snapshot
):
246 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
247 self
._validate
_stream
_activity
_message
_default
_clock
_snapshot
(stream
, default_clock_snapshot
)
248 ptr
= native_bt
.message_stream_activity_end_create(self
._ptr
, stream
._ptr
)
251 raise bt2
.CreationError(
252 'cannot create stream activity end message object')
254 msg
= bt2
.message
._StreamActivityEndMessage
(ptr
)
255 msg
._default
_clock
_snapshot
= default_clock_snapshot
258 def _create_stream_end_message(self
, stream
):
259 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
261 ptr
= native_bt
.message_stream_end_create(self
._ptr
, stream
._ptr
)
263 raise bt2
.CreationError('cannot create stream end message object')
265 return bt2
.message
._StreamEndMessage
(ptr
)
267 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
268 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
270 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
271 if default_clock_snapshot
is None:
272 raise ValueError("packet beginning messages in this stream must have a default clock snapshot")
274 utils
._check
_uint
64(default_clock_snapshot
)
275 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
276 self
._ptr
, packet
._ptr
, default_clock_snapshot
)
278 if default_clock_snapshot
is not None:
279 raise ValueError("packet beginning messages in this stream must not have a default clock snapshot")
281 ptr
= native_bt
.message_packet_beginning_create(self
._ptr
, packet
._ptr
)
284 raise bt2
.CreationError('cannot create packet beginning message object')
286 return bt2
.message
._PacketBeginningMessage
(ptr
)
288 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
289 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
291 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
292 if default_clock_snapshot
is None:
293 raise ValueError("packet end messages in this stream must have a default clock snapshot")
295 utils
._check
_uint
64(default_clock_snapshot
)
296 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
297 self
._ptr
, packet
._ptr
, default_clock_snapshot
)
299 if default_clock_snapshot
is not None:
300 raise ValueError("packet end messages in this stream must not have a default clock snapshot")
302 ptr
= native_bt
.message_packet_end_create(self
._ptr
, packet
._ptr
)
305 raise bt2
.CreationError('cannot create packet end message object')
307 return bt2
.message
._PacketEndMessage
(ptr
)
309 def _create_discarded_events_message(self
, stream
, count
=None,
310 beg_clock_snapshot
=None,
311 end_clock_snapshot
=None):
312 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
314 if not stream
.cls
.supports_discarded_events
:
315 raise ValueError('stream class does not support discarded events')
317 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
318 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
319 raise ValueError('discarded events have default clock snapshots for this stream class')
321 utils
._check
_uint
64(beg_clock_snapshot
)
322 utils
._check
_uint
64(end_clock_snapshot
)
323 ptr
= native_bt
.message_discarded_events_create_with_default_clock_snapshots(
324 self
._ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
)
326 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
327 raise ValueError('discarded events have no default clock snapshots for this stream class')
329 ptr
= native_bt
.message_discarded_events_create(
330 self
._ptr
, stream
._ptr
)
333 raise bt2
.CreationError('cannot discarded events message object')
335 msg
= bt2
.message
._DiscardedEventsMessage
(ptr
)
337 if count
is not None:
342 def _create_discarded_packets_message(self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None):
343 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
345 if not stream
.cls
.supports_discarded_packets
:
346 raise ValueError('stream class does not support discarded packets')
348 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
349 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
350 raise ValueError('discarded packets have default clock snapshots for this stream class')
352 utils
._check
_uint
64(beg_clock_snapshot
)
353 utils
._check
_uint
64(end_clock_snapshot
)
354 ptr
= native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
355 self
._ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
)
357 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
358 raise ValueError('discarded packets have no default clock snapshots for this stream class')
360 ptr
= native_bt
.message_discarded_packets_create(
361 self
._ptr
, stream
._ptr
)
364 raise bt2
.CreationError('cannot discarded packets message object')
366 msg
= bt2
.message
._DiscardedPacketsMessage
(ptr
)
368 if count
is not None: