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
):
31 def _handle_status(self
, status
, gen_error_msg
):
32 if status
== native_bt
.MESSAGE_ITERATOR_STATUS_AGAIN
:
34 elif status
== native_bt
.MESSAGE_ITERATOR_STATUS_END
:
37 raise bt2
.Error(gen_error_msg
)
40 raise NotImplementedError
43 class _GenericMessageIterator(object._SharedObject
, _MessageIterator
):
44 def __init__(self
, ptr
):
45 self
._current
_msgs
= []
50 if len(self
._current
_msgs
) == self
._at
:
51 status
, msgs
= self
._get
_msg
_range
(self
._ptr
)
52 self
._handle
_status
(status
,
53 'unexpected error: cannot advance the message iterator')
54 self
._current
_msgs
= msgs
57 msg_ptr
= self
._current
_msgs
[self
._at
]
60 return bt2
.message
._create
_from
_ptr
(msg_ptr
)
63 # This is created when a component wants to iterate on one of its input ports.
64 class _UserComponentInputPortMessageIterator(_GenericMessageIterator
):
65 _get_msg_range
= staticmethod(native_bt
.py3_self_component_port_input_get_msg_range
)
66 _get_ref
= staticmethod(native_bt
.self_component_port_input_message_iterator_get_ref
)
67 _put_ref
= staticmethod(native_bt
.self_component_port_input_message_iterator_put_ref
)
70 # This is created when the user wants to iterate on a component's output port,
71 # from outside the graph.
72 class _OutputPortMessageIterator(_GenericMessageIterator
):
73 _get_msg_range
= staticmethod(native_bt
.py3_port_output_get_msg_range
)
74 _get_ref
= staticmethod(native_bt
.port_output_message_iterator_get_ref
)
75 _put_ref
= staticmethod(native_bt
.port_output_message_iterator_put_ref
)
78 # This is extended by the user to implement component classes in Python. It
79 # is created for a given output port when an input port message iterator is
80 # created on the input port on the other side of the connection. It is also
81 # created when an output port message iterator is created on this output port.
83 # Its purpose is to feed the messages that should go out through this output
85 class _UserMessageIterator(_MessageIterator
):
86 def __new__(cls
, ptr
):
87 # User iterator objects are always created by the native side,
88 # that is, never instantiated directly by Python code.
90 # The native code calls this, then manually calls
91 # self.__init__() without the `ptr` argument. The user has
92 # access to self.component during this call, thanks to this
93 # self._ptr argument being set.
95 # self._ptr is NOT owned by this object here, so there's nothing
97 self
= super().__new
__(cls
)
101 def _init_from_native(self
, self_output_port_ptr
):
102 self_output_port
= bt2
.port
._create
_self
_from
_ptr
_and
_get
_ref
(
103 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
)
104 self
.__init
__(self_output_port
)
106 def __init__(self
, output_port
):
110 def _component(self
):
111 return native_bt
.py3_get_user_component_from_user_msg_iter(self
._ptr
)
115 return int(self
._ptr
)
123 def _next_from_native(self
):
124 # this can raise anything: it's catched by the native part
127 except StopIteration:
132 utils
._check
_type
(msg
, bt2
.message
._Message
)
134 # Release the reference to the native part.
138 def _create_event_message(self
, event_class
, packet
, default_clock_snapshot
=None):
139 utils
._check
_type
(event_class
, bt2
.event_class
._EventClass
)
140 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
142 if default_clock_snapshot
is not None:
143 if event_class
.stream_class
.default_clock_class
is None:
144 raise ValueError('event messages in this stream must not have a default clock snapshot')
146 utils
._check
_uint
64(default_clock_snapshot
)
147 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
148 self
._ptr
, event_class
._ptr
, packet
._ptr
, default_clock_snapshot
)
150 if event_class
.stream_class
.default_clock_class
is not None:
151 raise ValueError('event messages in this stream must have a default clock snapshot')
153 ptr
= native_bt
.message_event_create(
154 self
._ptr
, event_class
._ptr
, packet
._ptr
)
157 raise bt2
.CreationError('cannot create event message object')
159 return bt2
.message
._EventMessage
(ptr
)
161 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
162 utils
._check
_type
(clock_class
, bt2
.clock_class
._ClockClass
)
163 ptr
= native_bt
.message_message_iterator_inactivity_create(
164 self
._ptr
, clock_class
._ptr
, clock_snapshot
)
167 raise bt2
.CreationError('cannot create inactivity message object')
169 return bt2
.message
._MessageIteratorInactivityMessage
(ptr
)
171 _unknown_clock_snapshot
= bt2
.message
._StreamActivityMessageUnknownClockSnapshot
()
172 _infinite_clock_snapshot
= bt2
.message
._StreamActivityMessageInfiniteClockSnapshot
()
175 def _validate_stream_activity_message_default_clock_snapshot(stream
, default_cs
):
176 isinst_infinite
= isinstance(default_cs
, bt2
.message
._StreamActivityMessageInfiniteClockSnapshot
)
177 isinst_unknown
= isinstance(default_cs
, bt2
.message
._StreamActivityMessageUnknownClockSnapshot
)
179 if utils
._is
_uint
64(default_cs
):
181 elif isinst_infinite
or isinst_unknown
:
182 if default_cs
is not _UserMessageIterator
._unknown
_clock
_snapshot
and default_cs
is not _UserMessageIterator
._infinite
_clock
_snapshot
:
183 raise ValueError('unexpected value for default clock snapshot')
185 raise TypeError("unexpected type '{}' for default clock snapshot".format(default_cs
.__class
__.__name
__))
187 if stream
.cls
.default_clock_class
is None:
188 if utils
._is
_uint
64(default_cs
):
189 raise ValueError('stream activity messages in this stream cannot have a known default clock snapshot')
191 def _create_stream_beginning_message(self
, stream
):
192 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
194 ptr
= native_bt
.message_stream_beginning_create(self
._ptr
, stream
._ptr
)
196 raise bt2
.CreationError('cannot create stream beginning message object')
198 return bt2
.message
._StreamBeginningMessage
(ptr
)
200 def _create_stream_activity_beginning_message(self
, stream
,
201 default_clock_snapshot
=_unknown_clock_snapshot
):
202 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
203 self
._validate
_stream
_activity
_message
_default
_clock
_snapshot
(stream
, default_clock_snapshot
)
204 ptr
= native_bt
.message_stream_activity_beginning_create(self
._ptr
, stream
._ptr
)
207 raise bt2
.CreationError(
208 'cannot create stream activity beginning message object')
210 msg
= bt2
.message
._StreamActivityBeginningMessage
(ptr
)
211 msg
._default
_clock
_snapshot
= default_clock_snapshot
214 def _create_stream_activity_end_message(self
, stream
,
215 default_clock_snapshot
=_unknown_clock_snapshot
):
216 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
217 self
._validate
_stream
_activity
_message
_default
_clock
_snapshot
(stream
, default_clock_snapshot
)
218 ptr
= native_bt
.message_stream_activity_end_create(self
._ptr
, stream
._ptr
)
221 raise bt2
.CreationError(
222 'cannot create stream activity end message object')
224 msg
= bt2
.message
._StreamActivityEndMessage
(ptr
)
225 msg
._default
_clock
_snapshot
= default_clock_snapshot
228 def _create_stream_end_message(self
, stream
):
229 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
231 ptr
= native_bt
.message_stream_end_create(self
._ptr
, stream
._ptr
)
233 raise bt2
.CreationError('cannot create stream end message object')
235 return bt2
.message
._StreamEndMessage
(ptr
)
237 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
238 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
240 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
241 if default_clock_snapshot
is None:
242 raise ValueError("packet beginning messages in this stream must have a default clock snapshot")
244 utils
._check
_uint
64(default_clock_snapshot
)
245 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
246 self
._ptr
, packet
._ptr
, default_clock_snapshot
)
248 if default_clock_snapshot
is not None:
249 raise ValueError("packet beginning messages in this stream must not have a default clock snapshot")
251 ptr
= native_bt
.message_packet_beginning_create(self
._ptr
, packet
._ptr
)
254 raise bt2
.CreationError('cannot create packet beginning message object')
256 return bt2
.message
._PacketBeginningMessage
(ptr
)
258 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
259 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
261 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
262 if default_clock_snapshot
is None:
263 raise ValueError("packet end messages in this stream must have a default clock snapshot")
265 utils
._check
_uint
64(default_clock_snapshot
)
266 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
267 self
._ptr
, packet
._ptr
, default_clock_snapshot
)
269 if default_clock_snapshot
is not None:
270 raise ValueError("packet end messages in this stream must not have a default clock snapshot")
272 ptr
= native_bt
.message_packet_end_create(self
._ptr
, packet
._ptr
)
275 raise bt2
.CreationError('cannot create packet end message object')
277 return bt2
.message
._PacketEndMessage
(ptr
)
279 def _create_discarded_events_message(self
, stream
, count
=None,
280 beg_clock_snapshot
=None,
281 end_clock_snapshot
=None):
282 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
284 if not stream
.cls
.supports_discarded_events
:
285 raise ValueError('stream class does not support discarded events')
287 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
288 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
289 raise ValueError('discarded events have default clock snapshots for this stream class')
291 utils
._check
_uint
64(beg_clock_snapshot
)
292 utils
._check
_uint
64(end_clock_snapshot
)
293 ptr
= native_bt
.message_discarded_events_create_with_default_clock_snapshots(
294 self
._ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
)
296 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
297 raise ValueError('discarded events have no default clock snapshots for this stream class')
299 ptr
= native_bt
.message_discarded_events_create(
300 self
._ptr
, stream
._ptr
)
303 raise bt2
.CreationError('cannot discarded events message object')
305 msg
= bt2
.message
._DiscardedEventsMessage
(ptr
)
307 if count
is not None:
312 def _create_discarded_packets_message(self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None):
313 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
315 if not stream
.cls
.supports_discarded_packets
:
316 raise ValueError('stream class does not support discarded packets')
318 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
319 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
320 raise ValueError('discarded packets have default clock snapshots for this stream class')
322 utils
._check
_uint
64(beg_clock_snapshot
)
323 utils
._check
_uint
64(end_clock_snapshot
)
324 ptr
= native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
325 self
._ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
)
327 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
328 raise ValueError('discarded packets have no default clock snapshots for this stream class')
330 ptr
= native_bt
.message_discarded_packets_create(
331 self
._ptr
, stream
._ptr
)
334 raise bt2
.CreationError('cannot discarded packets message object')
336 msg
= bt2
.message
._DiscardedPacketsMessage
(ptr
)
338 if count
is not None: