X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fmessage_iterator.py;h=e2efa732baba9729f2635456341d11121717b009;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hp=bde3afa054a11a1ca4265fae050fd7f9df0ba8e6;hpb=44ced4ff8e8b5e46ef03f3aec737fca5ca2c7003;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/message_iterator.py b/src/bindings/python/bt2/bt2/message_iterator.py index bde3afa0..e2efa732 100644 --- a/src/bindings/python/bt2/bt2/message_iterator.py +++ b/src/bindings/python/bt2/bt2/message_iterator.py @@ -1,84 +1,110 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, object, utils -import bt2.message +from bt2 import message as bt2_message import collections.abc -import bt2.component +from bt2 import stream as bt2_stream +from bt2 import event_class as bt2_event_class +from bt2 import packet as bt2_packet +from bt2 import port as bt2_port +from bt2 import clock_class as bt2_clock_class import bt2 class _MessageIterator(collections.abc.Iterator): - def _handle_status(self, status, gen_error_msg): - if status == native_bt.MESSAGE_ITERATOR_STATUS_AGAIN: - raise bt2.TryAgain - elif status == native_bt.MESSAGE_ITERATOR_STATUS_END: - raise bt2.Stop - elif status < 0: - raise bt2.Error(gen_error_msg) - def __next__(self): raise NotImplementedError -class _GenericMessageIterator(object._SharedObject, _MessageIterator): +class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageIterator): + _get_ref = staticmethod(native_bt.message_iterator_get_ref) + _put_ref = staticmethod(native_bt.message_iterator_put_ref) + def __init__(self, ptr): - self._current_msgs = [] - self._at = 0 - super().__init__(ptr) + self._current_msgs = [] + self._at = 0 + super().__init__(ptr) def __next__(self): if len(self._current_msgs) == self._at: - status, msgs = self._get_msg_range(self._ptr) - self._handle_status(status, - 'unexpected error: cannot advance the message iterator') + status, msgs = native_bt.bt2_self_component_port_input_get_msg_range( + self._ptr + ) + utils._handle_func_status( + status, "unexpected error: cannot advance the message iterator" + ) self._current_msgs = msgs self._at = 0 msg_ptr = self._current_msgs[self._at] self._at += 1 - return bt2.message._create_from_ptr(msg_ptr) + return bt2_message._create_from_ptr(msg_ptr) + + def can_seek_beginning(self): + (status, res) = native_bt.message_iterator_can_seek_beginning(self._ptr) + utils._handle_func_status( + status, + "cannot check whether or not message iterator can seek its beginning", + ) + return res != 0 + + def seek_beginning(self): + # Forget about buffered messages, they won't be valid after seeking. + self._current_msgs.clear() + self._at = 0 + + status = native_bt.message_iterator_seek_beginning(self._ptr) + utils._handle_func_status(status, "cannot seek message iterator beginning") + + def can_seek_ns_from_origin(self, ns_from_origin): + utils._check_int64(ns_from_origin) + (status, res) = native_bt.message_iterator_can_seek_ns_from_origin( + self._ptr, ns_from_origin + ) + utils._handle_func_status( + status, + "cannot check whether or not message iterator can seek given ns from origin", + ) + return res != 0 + + def seek_ns_from_origin(self, ns_from_origin): + utils._check_int64(ns_from_origin) + + # Forget about buffered messages, they won't be valid after seeking. + self._current_msgs.clear() + self._at = 0 + + status = native_bt.message_iterator_seek_ns_from_origin( + self._ptr, ns_from_origin + ) + utils._handle_func_status( + status, "message iterator cannot seek given ns from origin" + ) + + @property + def can_seek_forward(self): + return native_bt.message_iterator_can_seek_forward(self._ptr) -# This is created when a component wants to iterate on one of its input ports. -class _UserComponentInputPortMessageIterator(_GenericMessageIterator): - _get_msg_range = staticmethod(native_bt.py3_self_component_port_input_get_msg_range) - _get_ref = staticmethod(native_bt.self_component_port_input_message_iterator_get_ref) - _put_ref = staticmethod(native_bt.self_component_port_input_message_iterator_put_ref) +class _MessageIteratorConfiguration: + def __init__(self, ptr): + self._ptr = ptr + def can_seek_forward(self, value): + utils._check_bool(value) + native_bt.self_message_iterator_configuration_set_can_seek_forward( + self._ptr, value + ) -# This is created when the user wants to iterate on a component's output port, -# from outside the graph. -class _OutputPortMessageIterator(_GenericMessageIterator): - _get_msg_range = staticmethod(native_bt.py3_port_output_get_msg_range) - _get_ref = staticmethod(native_bt.port_output_message_iterator_get_ref) - _put_ref = staticmethod(native_bt.port_output_message_iterator_put_ref) + can_seek_forward = property(fset=can_seek_forward) # This is extended by the user to implement component classes in Python. It # is created for a given output port when an input port message iterator is -# created on the input port on the other side of the connection. It is also -# created when an output port message iterator is created on this output port. +# created on the input port on the other side of the connection. # # Its purpose is to feed the messages that should go out through this output # port. @@ -90,253 +116,346 @@ class _UserMessageIterator(_MessageIterator): # The native code calls this, then manually calls # self.__init__() without the `ptr` argument. The user has # access to self.component during this call, thanks to this - # self._ptr argument being set. + # self._bt_ptr argument being set. # - # self._ptr is NOT owned by this object here, so there's nothing + # self._bt_ptr is NOT owned by this object here, so there's nothing # to do in __del__(). self = super().__new__(cls) - self._ptr = ptr + self._bt_ptr = ptr return self - def _init_from_native(self, self_output_port_ptr): - self_output_port = bt2.port._create_self_from_ptr_and_get_ref( - self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT) - self.__init__(self_output_port) + def _bt_init_from_native(self, config_ptr, self_output_port_ptr): + self_output_port = bt2_port._create_self_from_ptr_and_get_ref( + self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT + ) + config = _MessageIteratorConfiguration(config_ptr) + self.__init__(config, self_output_port) - def __init__(self, output_port): + def __init__(self, config, self_output_port): pass @property def _component(self): - return native_bt.py3_get_user_component_from_user_msg_iter(self._ptr) + return native_bt.bt2_get_user_component_from_user_msg_iter(self._bt_ptr) + + @property + def _port(self): + port_ptr = native_bt.self_message_iterator_borrow_port(self._bt_ptr) + assert port_ptr is not None + return bt2_port._create_self_from_ptr_and_get_ref( + port_ptr, native_bt.PORT_TYPE_OUTPUT + ) @property def addr(self): - return int(self._ptr) + return int(self._bt_ptr) + + @property + def _is_interrupted(self): + return bool(native_bt.self_message_iterator_is_interrupted(self._bt_ptr)) - def _finalize(self): + def _user_finalize(self): pass def __next__(self): raise bt2.Stop - def _next_from_native(self): + def _bt_next_from_native(self): # this can raise anything: it's catched by the native part try: msg = next(self) except StopIteration: raise bt2.Stop - except: + except Exception: raise - utils._check_type(msg, bt2.message._Message) - - # Release the reference to the native part. - ptr = msg._release() - return int(ptr) - - def _create_event_message(self, event_class, packet, default_clock_snapshot=None): - utils._check_type(event_class, bt2.event_class._EventClass) - utils._check_type(packet, bt2.packet._Packet) + utils._check_type(msg, bt2_message._MessageConst) - if default_clock_snapshot is not None: - if event_class.stream_class.default_clock_class is None: - raise ValueError('event messages in this stream must not have a default clock snapshot') + # The reference we return will be given to the message array. + # However, the `msg` Python object may stay alive, if the user has kept + # a reference to it. Acquire a new reference to account for that. + msg._get_ref(msg._ptr) + return int(msg._ptr) - utils._check_uint64(default_clock_snapshot) - ptr = native_bt.message_event_create_with_default_clock_snapshot( - self._ptr, event_class._ptr, packet._ptr, default_clock_snapshot) + def _bt_can_seek_beginning_from_native(self): + # Here, we mimic the behavior of the C API: + # + # - If the iterator has a _user_can_seek_beginning method, + # read it and use that result. + # - Otherwise, the presence or absence of a `_user_seek_beginning` + # method indicates whether the iterator can seek beginning. + if hasattr(self, "_user_can_seek_beginning"): + can_seek_beginning = self._user_can_seek_beginning() + utils._check_bool(can_seek_beginning) + return can_seek_beginning else: - if event_class.stream_class.default_clock_class is not None: - raise ValueError('event messages in this stream must have a default clock snapshot') + return hasattr(self, "_user_seek_beginning") - ptr = native_bt.message_event_create( - self._ptr, event_class._ptr, packet._ptr) + def _bt_seek_beginning_from_native(self): + self._user_seek_beginning() - if ptr is None: - raise bt2.CreationError('cannot create event message object') + def _bt_can_seek_ns_from_origin_from_native(self, ns_from_origin): + # Return whether the iterator can seek ns from origin using the + # user-implemented seek_ns_from_origin method. We mimic the behavior + # of the C API: + # + # - If the iterator has a _user_can_seek_ns_from_origin method, + # call it and use its return value. + # - Otherwise, if there is a `_user_seek_ns_from_origin` method, + # we presume it's possible. + + if hasattr(self, "_user_can_seek_ns_from_origin"): + can_seek_ns_from_origin = self._user_can_seek_ns_from_origin(ns_from_origin) + utils._check_bool(can_seek_ns_from_origin) + return can_seek_ns_from_origin + else: + return hasattr(self, "_user_seek_ns_from_origin") - return bt2.message._EventMessage(ptr) + def _bt_seek_ns_from_origin_from_native(self, ns_from_origin): + self._user_seek_ns_from_origin(ns_from_origin) - def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot): - utils._check_type(clock_class, bt2.clock_class._ClockClass) - ptr = native_bt.message_message_iterator_inactivity_create( - self._ptr, clock_class._ptr, clock_snapshot) + def _create_message_iterator(self, input_port): + utils._check_type(input_port, bt2_port._UserComponentInputPort) - if ptr is None: - raise bt2.CreationError('cannot create inactivity message object') + if not input_port.is_connected: + raise ValueError("input port is not connected") - return bt2.message._MessageIteratorInactivityMessage(ptr) + ( + status, + msg_iter_ptr, + ) = native_bt.bt2_message_iterator_create_from_message_iterator( + self._bt_ptr, input_port._ptr + ) + utils._handle_func_status(status, "cannot create message iterator object") + assert msg_iter_ptr is not None - _unknown_clock_snapshot = bt2.message._StreamActivityMessageUnknownClockSnapshot() - _infinite_clock_snapshot = bt2.message._StreamActivityMessageInfiniteClockSnapshot() + return _UserComponentInputPortMessageIterator(msg_iter_ptr) - @staticmethod - def _validate_stream_activity_message_default_clock_snapshot(stream, default_cs): - isinst_infinite = isinstance(default_cs, bt2.message._StreamActivityMessageInfiniteClockSnapshot) - isinst_unknown = isinstance(default_cs, bt2.message._StreamActivityMessageUnknownClockSnapshot) + def _create_event_message(self, event_class, parent, default_clock_snapshot=None): + utils._check_type(event_class, bt2_event_class._EventClass) - if utils._is_uint64(default_cs): - pass - elif isinst_infinite or isinst_unknown: - if default_cs is not _UserMessageIterator._unknown_clock_snapshot and default_cs is not _UserMessageIterator._infinite_clock_snapshot: - raise ValueError('unexpected value for default clock snapshot') + if event_class.stream_class.supports_packets: + utils._check_type(parent, bt2_packet._Packet) else: - raise TypeError("unexpected type '{}' for default clock snapshot".format(default_cs.__class__.__name__)) + utils._check_type(parent, bt2_stream._Stream) + + if default_clock_snapshot is not None: + if event_class.stream_class.default_clock_class is None: + raise ValueError( + "event messages in this stream must not have a default clock snapshot" + ) - if stream.cls.default_clock_class is None: - if utils._is_uint64(default_cs): - raise ValueError('stream activity messages in this stream cannot have a known default clock snapshot') + utils._check_uint64(default_clock_snapshot) - def _create_stream_beginning_message(self, stream): - utils._check_type(stream, bt2.stream._Stream) + if event_class.stream_class.supports_packets: + ptr = native_bt.message_event_create_with_packet_and_default_clock_snapshot( + self._bt_ptr, event_class._ptr, parent._ptr, default_clock_snapshot + ) + else: + ptr = native_bt.message_event_create_with_default_clock_snapshot( + self._bt_ptr, event_class._ptr, parent._ptr, default_clock_snapshot + ) + else: + if event_class.stream_class.default_clock_class is not None: + raise ValueError( + "event messages in this stream must have a default clock snapshot" + ) + + if event_class.stream_class.supports_packets: + ptr = native_bt.message_event_create_with_packet( + self._bt_ptr, event_class._ptr, parent._ptr + ) + else: + ptr = native_bt.message_event_create( + self._bt_ptr, event_class._ptr, parent._ptr + ) - ptr = native_bt.message_stream_beginning_create(self._ptr, stream._ptr) if ptr is None: - raise bt2.CreationError('cannot create stream beginning message object') + raise bt2._MemoryError("cannot create event message object") - return bt2.message._StreamBeginningMessage(ptr) + return bt2_message._EventMessage(ptr) - def _create_stream_activity_beginning_message(self, stream, - default_clock_snapshot=_unknown_clock_snapshot): - utils._check_type(stream, bt2.stream._Stream) - self._validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot) - ptr = native_bt.message_stream_activity_beginning_create(self._ptr, stream._ptr) + def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot): + utils._check_type(clock_class, bt2_clock_class._ClockClass) + ptr = native_bt.message_message_iterator_inactivity_create( + self._bt_ptr, clock_class._ptr, clock_snapshot + ) if ptr is None: - raise bt2.CreationError( - 'cannot create stream activity beginning message object') + raise bt2._MemoryError("cannot create inactivity message object") - msg = bt2.message._StreamActivityBeginningMessage(ptr) - msg._default_clock_snapshot = default_clock_snapshot - return msg + return bt2_message._MessageIteratorInactivityMessage(ptr) - def _create_stream_activity_end_message(self, stream, - default_clock_snapshot=_unknown_clock_snapshot): - utils._check_type(stream, bt2.stream._Stream) - self._validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot) - ptr = native_bt.message_stream_activity_end_create(self._ptr, stream._ptr) + def _create_stream_beginning_message(self, stream, default_clock_snapshot=None): + utils._check_type(stream, bt2_stream._Stream) + ptr = native_bt.message_stream_beginning_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2.CreationError( - 'cannot create stream activity end message object') + raise bt2._MemoryError("cannot create stream beginning message object") + + msg = bt2_message._StreamBeginningMessage(ptr) + + if default_clock_snapshot is not None: + msg._default_clock_snapshot = default_clock_snapshot - msg = bt2.message._StreamActivityEndMessage(ptr) - msg._default_clock_snapshot = default_clock_snapshot return msg - def _create_stream_end_message(self, stream): - utils._check_type(stream, bt2.stream._Stream) + def _create_stream_end_message(self, stream, default_clock_snapshot=None): + utils._check_type(stream, bt2_stream._Stream) - ptr = native_bt.message_stream_end_create(self._ptr, stream._ptr) + ptr = native_bt.message_stream_end_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2.CreationError('cannot create stream end message object') + raise bt2._MemoryError("cannot create stream end message object") + + msg = bt2_message._StreamEndMessage(ptr) - return bt2.message._StreamEndMessage(ptr) + if default_clock_snapshot is not None: + msg._default_clock_snapshot = default_clock_snapshot + + return msg def _create_packet_beginning_message(self, packet, default_clock_snapshot=None): - utils._check_type(packet, bt2.packet._Packet) + utils._check_type(packet, bt2_packet._Packet) if packet.stream.cls.packets_have_beginning_default_clock_snapshot: if default_clock_snapshot is None: - raise ValueError("packet beginning messages in this stream must have a default clock snapshot") + raise ValueError( + "packet beginning messages in this stream must have a default clock snapshot" + ) utils._check_uint64(default_clock_snapshot) ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot( - self._ptr, packet._ptr, default_clock_snapshot) + self._bt_ptr, packet._ptr, default_clock_snapshot + ) else: if default_clock_snapshot is not None: - raise ValueError("packet beginning messages in this stream must not have a default clock snapshot") + raise ValueError( + "packet beginning messages in this stream must not have a default clock snapshot" + ) - ptr = native_bt.message_packet_beginning_create(self._ptr, packet._ptr) + ptr = native_bt.message_packet_beginning_create(self._bt_ptr, packet._ptr) if ptr is None: - raise bt2.CreationError('cannot create packet beginning message object') + raise bt2._MemoryError("cannot create packet beginning message object") - return bt2.message._PacketBeginningMessage(ptr) + return bt2_message._PacketBeginningMessage(ptr) def _create_packet_end_message(self, packet, default_clock_snapshot=None): - utils._check_type(packet, bt2.packet._Packet) + utils._check_type(packet, bt2_packet._Packet) if packet.stream.cls.packets_have_end_default_clock_snapshot: if default_clock_snapshot is None: - raise ValueError("packet end messages in this stream must have a default clock snapshot") + raise ValueError( + "packet end messages in this stream must have a default clock snapshot" + ) utils._check_uint64(default_clock_snapshot) ptr = native_bt.message_packet_end_create_with_default_clock_snapshot( - self._ptr, packet._ptr, default_clock_snapshot) + self._bt_ptr, packet._ptr, default_clock_snapshot + ) else: if default_clock_snapshot is not None: - raise ValueError("packet end messages in this stream must not have a default clock snapshot") + raise ValueError( + "packet end messages in this stream must not have a default clock snapshot" + ) - ptr = native_bt.message_packet_end_create(self._ptr, packet._ptr) + ptr = native_bt.message_packet_end_create(self._bt_ptr, packet._ptr) if ptr is None: - raise bt2.CreationError('cannot create packet end message object') + raise bt2._MemoryError("cannot create packet end message object") - return bt2.message._PacketEndMessage(ptr) + return bt2_message._PacketEndMessage(ptr) - def _create_discarded_events_message(self, stream, count=None, - beg_clock_snapshot=None, - end_clock_snapshot=None): - utils._check_type(stream, bt2.stream._Stream) + def _create_discarded_events_message( + self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None + ): + utils._check_type(stream, bt2_stream._Stream) if not stream.cls.supports_discarded_events: - raise ValueError('stream class does not support discarded events') + raise ValueError("stream class does not support discarded events") if stream.cls.discarded_events_have_default_clock_snapshots: if beg_clock_snapshot is None or end_clock_snapshot is None: - raise ValueError('discarded events have default clock snapshots for this stream class') + raise ValueError( + "discarded events have default clock snapshots for this stream class" + ) utils._check_uint64(beg_clock_snapshot) utils._check_uint64(end_clock_snapshot) - ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots( - self._ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot) + + if beg_clock_snapshot > end_clock_snapshot: + raise ValueError( + "beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})".format( + beg_clock_snapshot, end_clock_snapshot + ) + ) + + ptr = ( + native_bt.message_discarded_events_create_with_default_clock_snapshots( + self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot + ) + ) else: if beg_clock_snapshot is not None or end_clock_snapshot is not None: - raise ValueError('discarded events have no default clock snapshots for this stream class') + raise ValueError( + "discarded events have no default clock snapshots for this stream class" + ) - ptr = native_bt.message_discarded_events_create( - self._ptr, stream._ptr) + ptr = native_bt.message_discarded_events_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2.CreationError('cannot discarded events message object') + raise bt2._MemoryError("cannot discarded events message object") - msg = bt2.message._DiscardedEventsMessage(ptr) + msg = bt2_message._DiscardedEventsMessage(ptr) if count is not None: msg._count = count return msg - def _create_discarded_packets_message(self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None): - utils._check_type(stream, bt2.stream._Stream) + def _create_discarded_packets_message( + self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None + ): + utils._check_type(stream, bt2_stream._Stream) if not stream.cls.supports_discarded_packets: - raise ValueError('stream class does not support discarded packets') + raise ValueError("stream class does not support discarded packets") if stream.cls.discarded_packets_have_default_clock_snapshots: if beg_clock_snapshot is None or end_clock_snapshot is None: - raise ValueError('discarded packets have default clock snapshots for this stream class') + raise ValueError( + "discarded packets have default clock snapshots for this stream class" + ) utils._check_uint64(beg_clock_snapshot) utils._check_uint64(end_clock_snapshot) - ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots( - self._ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot) + + if beg_clock_snapshot > end_clock_snapshot: + raise ValueError( + "beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})".format( + beg_clock_snapshot, end_clock_snapshot + ) + ) + + ptr = ( + native_bt.message_discarded_packets_create_with_default_clock_snapshots( + self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot + ) + ) else: if beg_clock_snapshot is not None or end_clock_snapshot is not None: - raise ValueError('discarded packets have no default clock snapshots for this stream class') + raise ValueError( + "discarded packets have no default clock snapshots for this stream class" + ) - ptr = native_bt.message_discarded_packets_create( - self._ptr, stream._ptr) + ptr = native_bt.message_discarded_packets_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2.CreationError('cannot discarded packets message object') + raise bt2._MemoryError("cannot discarded packets message object") - msg = bt2.message._DiscardedPacketsMessage(ptr) + msg = bt2_message._DiscardedPacketsMessage(ptr) if count is not None: msg._count = count return msg -