X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fmessage_iterator.py;h=8703e90be10f095c8a5f0cb96d9deade24ebe488;hb=HEAD;hp=253fbcc73c4c9cdd63488fd381dc2fc671274e3f;hpb=c0e46a7c2b7bdd588eb716191940bf5b34f9fc5b;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/message_iterator.py b/src/bindings/python/bt2/bt2/message_iterator.py index 253fbcc7..8703e90b 100644 --- a/src/bindings/python/bt2/bt2/message_iterator.py +++ b/src/bindings/python/bt2/bt2/message_iterator.py @@ -1,34 +1,19 @@ -# 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 -from bt2 import message as bt2_message + import collections.abc -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 error as bt2_error +from bt2 import utils as bt2_utils +from bt2 import object as bt2_object +from bt2 import packet as bt2_packet +from bt2 import stream as bt2_stream +from bt2 import message as bt2_message +from bt2 import native_bt from bt2 import clock_class as bt2_clock_class -import bt2 +from bt2 import event_class as bt2_event_class class _MessageIterator(collections.abc.Iterator): @@ -36,13 +21,16 @@ class _MessageIterator(collections.abc.Iterator): raise NotImplementedError -class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageIterator): - _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 _UserComponentInputPortMessageIterator( + bt2_object._SharedObject, _MessageIterator +): + @staticmethod + def _get_ref(ptr): + native_bt.message_iterator_get_ref(ptr) + + @staticmethod + def _put_ref(ptr): + native_bt.message_iterator_put_ref(ptr) def __init__(self, ptr): self._current_msgs = [] @@ -54,8 +42,8 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera 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' + bt2_utils._handle_func_status( + status, "unexpected error: cannot advance the message iterator" ) self._current_msgs = msgs self._at = 0 @@ -66,12 +54,10 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera return bt2_message._create_from_ptr(msg_ptr) def can_seek_beginning(self): - status, res = native_bt.self_component_port_input_message_iterator_can_seek_beginning( - self._ptr - ) - utils._handle_func_status( + (status, res) = native_bt.message_iterator_can_seek_beginning(self._ptr) + bt2_utils._handle_func_status( status, - 'cannot check whether or not message iterator can seek its beginning', + "cannot check whether or not message iterator can seek its beginning", ) return res != 0 @@ -80,41 +66,37 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera self._current_msgs.clear() self._at = 0 - status = native_bt.self_component_port_input_message_iterator_seek_beginning( - self._ptr - ) - utils._handle_func_status(status, 'cannot seek message iterator beginning') + status = native_bt.message_iterator_seek_beginning(self._ptr) + bt2_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.self_component_port_input_message_iterator_can_seek_ns_from_origin( + bt2_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( + bt2_utils._handle_func_status( status, - 'cannot check whether or not message iterator can seek given ns from origin', + "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) + bt2_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.self_component_port_input_message_iterator_seek_ns_from_origin( + 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' + bt2_utils._handle_func_status( + status, "message iterator cannot seek given ns from origin" ) @property def can_seek_forward(self): - return native_bt.self_component_port_input_message_iterator_can_seek_forward( - self._ptr - ) + return native_bt.message_iterator_can_seek_forward(self._ptr) class _MessageIteratorConfiguration: @@ -122,7 +104,7 @@ class _MessageIteratorConfiguration: self._ptr = ptr def can_seek_forward(self, value): - utils._check_bool(value) + bt2_utils._check_bool(value) native_bt.self_message_iterator_configuration_set_can_seek_forward( self._ptr, value ) @@ -132,8 +114,7 @@ class _MessageIteratorConfiguration: # 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. @@ -187,18 +168,18 @@ class _UserMessageIterator(_MessageIterator): pass def __next__(self): - raise bt2.Stop + raise bt2_utils.Stop def _bt_next_from_native(self): - # this can raise anything: it's catched by the native part + # this can raise anything: it's caught by the native part try: msg = next(self) except StopIteration: - raise bt2.Stop + raise bt2_utils.Stop except Exception: raise - utils._check_type(msg, bt2_message._MessageConst) + bt2_utils._check_type(msg, bt2_message._MessageConst) # The reference we return will be given to the message array. # However, the `msg` Python object may stay alive, if the user has kept @@ -213,12 +194,12 @@ class _UserMessageIterator(_MessageIterator): # 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'): + if hasattr(self, "_user_can_seek_beginning"): can_seek_beginning = self._user_can_seek_beginning() - utils._check_bool(can_seek_beginning) + bt2_utils._check_bool(can_seek_beginning) return can_seek_beginning else: - return hasattr(self, '_user_seek_beginning') + return hasattr(self, "_user_seek_beginning") def _bt_seek_beginning_from_native(self): self._user_seek_beginning() @@ -233,42 +214,48 @@ class _UserMessageIterator(_MessageIterator): # - 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'): + 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) + bt2_utils._check_bool(can_seek_ns_from_origin) return can_seek_ns_from_origin else: - return hasattr(self, '_user_seek_ns_from_origin') + return hasattr(self, "_user_seek_ns_from_origin") def _bt_seek_ns_from_origin_from_native(self, ns_from_origin): self._user_seek_ns_from_origin(ns_from_origin) - def _create_input_port_message_iterator(self, input_port): - utils._check_type(input_port, bt2_port._UserComponentInputPort) + def _create_message_iterator(self, input_port): + bt2_utils._check_type(input_port, bt2_port._UserComponentInputPort) + + if not input_port.is_connected: + raise ValueError("input port is not connected") - status, msg_iter_ptr = native_bt.bt2_self_component_port_input_message_iterator_create_from_message_iterator( + ( + 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') + bt2_utils._handle_func_status(status, "cannot create message iterator object") assert msg_iter_ptr is not None return _UserComponentInputPortMessageIterator(msg_iter_ptr) def _create_event_message(self, event_class, parent, default_clock_snapshot=None): - utils._check_type(event_class, bt2_event_class._EventClass) + bt2_utils._check_type(event_class, bt2_event_class._EventClass) if event_class.stream_class.supports_packets: - utils._check_type(parent, bt2_packet._Packet) + bt2_utils._check_type(parent, bt2_packet._Packet) else: - utils._check_type(parent, bt2_stream._Stream) + bt2_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' + "event messages in this stream must not have a default clock snapshot" ) - utils._check_uint64(default_clock_snapshot) + bt2_utils._check_uint64(default_clock_snapshot) if event_class.stream_class.supports_packets: ptr = native_bt.message_event_create_with_packet_and_default_clock_snapshot( @@ -281,7 +268,7 @@ class _UserMessageIterator(_MessageIterator): 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' + "event messages in this stream must have a default clock snapshot" ) if event_class.stream_class.supports_packets: @@ -294,27 +281,29 @@ class _UserMessageIterator(_MessageIterator): ) if ptr is None: - raise bt2._MemoryError('cannot create event message object') + raise bt2_error._MemoryError("cannot create event message object") return bt2_message._EventMessage(ptr) def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot): - utils._check_type(clock_class, bt2_clock_class._ClockClass) + bt2_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._MemoryError('cannot create inactivity message object') + raise bt2_error._MemoryError("cannot create inactivity message object") return bt2_message._MessageIteratorInactivityMessage(ptr) def _create_stream_beginning_message(self, stream, default_clock_snapshot=None): - utils._check_type(stream, bt2_stream._Stream) + bt2_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._MemoryError('cannot create stream beginning message object') + raise bt2_error._MemoryError( + "cannot create stream beginning message object" + ) msg = bt2_message._StreamBeginningMessage(ptr) @@ -324,11 +313,11 @@ class _UserMessageIterator(_MessageIterator): return msg def _create_stream_end_message(self, stream, default_clock_snapshot=None): - utils._check_type(stream, bt2_stream._Stream) + bt2_utils._check_type(stream, bt2_stream._Stream) ptr = native_bt.message_stream_end_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2._MemoryError('cannot create stream end message object') + raise bt2_error._MemoryError("cannot create stream end message object") msg = bt2_message._StreamEndMessage(ptr) @@ -338,7 +327,7 @@ class _UserMessageIterator(_MessageIterator): return msg def _create_packet_beginning_message(self, packet, default_clock_snapshot=None): - utils._check_type(packet, bt2_packet._Packet) + bt2_utils._check_type(packet, bt2_packet._Packet) if packet.stream.cls.packets_have_beginning_default_clock_snapshot: if default_clock_snapshot is None: @@ -346,7 +335,7 @@ class _UserMessageIterator(_MessageIterator): "packet beginning messages in this stream must have a default clock snapshot" ) - utils._check_uint64(default_clock_snapshot) + bt2_utils._check_uint64(default_clock_snapshot) ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot( self._bt_ptr, packet._ptr, default_clock_snapshot ) @@ -359,12 +348,14 @@ class _UserMessageIterator(_MessageIterator): ptr = native_bt.message_packet_beginning_create(self._bt_ptr, packet._ptr) if ptr is None: - raise bt2._MemoryError('cannot create packet beginning message object') + raise bt2_error._MemoryError( + "cannot create packet beginning message object" + ) return bt2_message._PacketBeginningMessage(ptr) def _create_packet_end_message(self, packet, default_clock_snapshot=None): - utils._check_type(packet, bt2_packet._Packet) + bt2_utils._check_type(packet, bt2_packet._Packet) if packet.stream.cls.packets_have_end_default_clock_snapshot: if default_clock_snapshot is None: @@ -372,7 +363,7 @@ class _UserMessageIterator(_MessageIterator): "packet end messages in this stream must have a default clock snapshot" ) - utils._check_uint64(default_clock_snapshot) + bt2_utils._check_uint64(default_clock_snapshot) ptr = native_bt.message_packet_end_create_with_default_clock_snapshot( self._bt_ptr, packet._ptr, default_clock_snapshot ) @@ -385,39 +376,49 @@ class _UserMessageIterator(_MessageIterator): ptr = native_bt.message_packet_end_create(self._bt_ptr, packet._ptr) if ptr is None: - raise bt2._MemoryError('cannot create packet end message object') + raise bt2_error._MemoryError("cannot create packet end message object") 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) + bt2_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' + "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._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot + bt2_utils._check_uint64(beg_clock_snapshot) + bt2_utils._check_uint64(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' + "discarded events have no default clock snapshots for this stream class" ) ptr = native_bt.message_discarded_events_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2._MemoryError('cannot discarded events message object') + raise bt2_error._MemoryError("cannot discarded events message object") msg = bt2_message._DiscardedEventsMessage(ptr) @@ -429,32 +430,42 @@ class _UserMessageIterator(_MessageIterator): def _create_discarded_packets_message( self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None ): - utils._check_type(stream, bt2_stream._Stream) + bt2_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' + "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._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot + bt2_utils._check_uint64(beg_clock_snapshot) + bt2_utils._check_uint64(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' + "discarded packets have no default clock snapshots for this stream class" ) ptr = native_bt.message_discarded_packets_create(self._bt_ptr, stream._ptr) if ptr is None: - raise bt2._MemoryError('cannot discarded packets message object') + raise bt2_error._MemoryError("cannot discarded packets message object") msg = bt2_message._DiscardedPacketsMessage(ptr)