X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fmessage_iterator.py;h=eb22dfb4edec32c4afd14612d744cb618248319d;hb=26fc5aedf;hp=7f996b007e1ec8353fb3537fd45d0fdd80823c66;hpb=578e048b5debf169e286e5b5cc747b5d6c16886d;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/message_iterator.py b/src/bindings/python/bt2/bt2/message_iterator.py index 7f996b00..eb22dfb4 100644 --- a/src/bindings/python/bt2/bt2/message_iterator.py +++ b/src/bindings/python/bt2/bt2/message_iterator.py @@ -28,14 +28,6 @@ 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 @@ -49,8 +41,8 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator): 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') + utils._handle_func_status(status, + 'unexpected error: cannot advance the message iterator') self._current_msgs = msgs self._at = 0 @@ -59,20 +51,38 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator): return bt2.message._create_from_ptr(msg_ptr) + @property + def can_seek_beginning(self): + res = self._can_seek_beginning(self._ptr) + 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 = self._seek_beginning(self._ptr) + utils._handle_func_status(status, + 'cannot seek message iterator beginning') + # 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_msg_range = staticmethod(native_bt.bt2_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) + _can_seek_beginning = staticmethod(native_bt.self_component_port_input_message_iterator_can_seek_beginning) + _seek_beginning = staticmethod(native_bt.self_component_port_input_message_iterator_seek_beginning) # 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_msg_range = staticmethod(native_bt.bt2_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_beginning = staticmethod(native_bt.port_output_message_iterator_can_seek_beginning) + _seek_beginning = staticmethod(native_bt.port_output_message_iterator_seek_beginning) # This is extended by the user to implement component classes in Python. It @@ -90,15 +100,15 @@ 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): + def _bt_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) @@ -108,11 +118,11 @@ class _UserMessageIterator(_MessageIterator): @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 addr(self): - return int(self._ptr) + return int(self._bt_ptr) def _finalize(self): pass @@ -120,7 +130,7 @@ class _UserMessageIterator(_MessageIterator): 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) @@ -131,36 +141,61 @@ class _UserMessageIterator(_MessageIterator): utils._check_type(msg, bt2.message._Message) - # Release the reference to the native part. - ptr = msg._release() - return int(ptr) + # 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) - # Validate that the presence or lack of presence of a - # `default_clock_snapshot` value is valid in the context of `stream_class`. - @staticmethod - def _validate_default_clock_snapshot(stream_class, default_clock_snapshot): - stream_class_has_default_clock_class = stream_class.default_clock_class is not None - - if stream_class_has_default_clock_class and default_clock_snapshot is None: - raise bt2.Error( - 'stream class has a default clock class, default_clock_snapshot should not be None') + @property + def _bt_can_seek_beginning_from_native(self): + # Here, we mimic the behavior of the C API: + # + # - If the iterator has a _can_seek_beginning attribute, read it and use + # that result. + # - Otherwise, the presence or absence of a `_seek_beginning` + # method indicates whether the iterator can seek beginning. + if hasattr(self, '_can_seek_beginning'): + can_seek_beginning = self._can_seek_beginning + utils._check_bool(can_seek_beginning) + return can_seek_beginning + else: + return hasattr(self, '_seek_beginning') - if not stream_class_has_default_clock_class and default_clock_snapshot is not None: - raise bt2.Error( - 'stream class has no default clock class, default_clock_snapshot should be None') + def _bt_seek_beginning_from_native(self): + self._seek_beginning() - def _create_event_message(self, event_class, packet, default_clock_snapshot=None): + def _create_event_message(self, event_class, parent=None, + default_clock_snapshot=None): utils._check_type(event_class, bt2.event_class._EventClass) - utils._check_type(packet, bt2.packet._Packet) - self._validate_default_clock_snapshot(packet.stream.cls, default_clock_snapshot) + + if event_class.stream_class.supports_packets: + utils._check_type(parent, bt2.packet._Packet) + else: + 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') + 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) + + 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: - ptr = native_bt.message_event_create( - self._ptr, event_class._ptr, packet._ptr) + 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) if ptr is None: raise bt2.CreationError('cannot create event message object') @@ -170,80 +205,56 @@ class _UserMessageIterator(_MessageIterator): 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) + self._bt_ptr, clock_class._ptr, clock_snapshot) if ptr is None: raise bt2.CreationError('cannot create inactivity message object') return bt2.message._MessageIteratorInactivityMessage(ptr) - def _create_stream_beginning_message(self, stream): + 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._ptr, stream._ptr) + ptr = native_bt.message_stream_beginning_create(self._bt_ptr, stream._ptr) if ptr is None: raise bt2.CreationError('cannot create stream beginning message object') - return bt2.message._StreamBeginningMessage(ptr) - - def _create_stream_activity_beginning_message(self, stream, default_clock_snapshot=None): - utils._check_type(stream, bt2.stream._Stream) - self._validate_default_clock_snapshot(stream.cls, default_clock_snapshot) - - ptr = native_bt.message_stream_activity_beginning_create(self._ptr, stream._ptr) - - if ptr is None: - raise bt2.CreationError( - 'cannot create stream activity beginning message object') - - msg = bt2.message._StreamActivityBeginningMessage(ptr) + msg = bt2.message._StreamBeginningMessage(ptr) if default_clock_snapshot is not None: msg._default_clock_snapshot = default_clock_snapshot return msg - def _create_stream_activity_end_message(self, stream, default_clock_snapshot=None): + def _create_stream_end_message(self, stream, default_clock_snapshot=None): utils._check_type(stream, bt2.stream._Stream) - self._validate_default_clock_snapshot(stream.cls, default_clock_snapshot) - - ptr = native_bt.message_stream_activity_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 activity end message object') + raise bt2.CreationError('cannot create stream end message object') - msg = bt2.message._StreamActivityEndMessage(ptr) + msg = bt2.message._StreamEndMessage(ptr) if default_clock_snapshot is not None: msg._default_clock_snapshot = default_clock_snapshot return msg - def _create_stream_end_message(self, stream): - utils._check_type(stream, bt2.stream._Stream) - - ptr = native_bt.message_stream_end_create(self._ptr, stream._ptr) - if ptr is None: - raise bt2.CreationError('cannot create stream end message object') - - return bt2.message._StreamEndMessage(ptr) - def _create_packet_beginning_message(self, packet, default_clock_snapshot=None): 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 snapshots") + 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 snapshots") + 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') @@ -255,16 +266,16 @@ class _UserMessageIterator(_MessageIterator): 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 snapshots") + 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 snapshots") + 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') @@ -286,13 +297,13 @@ class _UserMessageIterator(_MessageIterator): 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) + 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') ptr = native_bt.message_discarded_events_create( - self._ptr, stream._ptr) + self._bt_ptr, stream._ptr) if ptr is None: raise bt2.CreationError('cannot discarded events message object') @@ -317,13 +328,13 @@ class _UserMessageIterator(_MessageIterator): 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) + 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') ptr = native_bt.message_discarded_packets_create( - self._ptr, stream._ptr) + self._bt_ptr, stream._ptr) if ptr is None: raise bt2.CreationError('cannot discarded packets message object')