-# The MIT License (MIT)
+# SPDX-License-Identifier: MIT
#
# Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
-#
-# 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 component as 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
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
def __next__(self):
if len(self._current_msgs) == self._at:
- status, msgs = self._get_msg_range(self._ptr)
+ 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'
+ status, "unexpected error: cannot advance the message iterator"
)
self._current_msgs = msgs
self._at = 0
return bt2_message._create_from_ptr(msg_ptr)
- @property
def can_seek_beginning(self):
- res = self._can_seek_beginning(self._ptr)
+ (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..
+ # 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 = 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.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.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
- )
+ 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)
+
+
+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
+ )
+
+ 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.
self._bt_ptr = ptr
return self
- def _bt_init_from_native(self, self_output_port_ptr):
+ 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
)
- self.__init__(self_output_port)
+ 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.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._bt_ptr)
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):
msg = next(self)
except StopIteration:
raise bt2.Stop
- except:
+ except Exception:
raise
- utils._check_type(msg, bt2_message._Message)
+ 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
msg._get_ref(msg._ptr)
return int(msg._ptr)
- @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`
+ # - 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, '_can_seek_beginning'):
- can_seek_beginning = self._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:
- return hasattr(self, '_seek_beginning')
+ return hasattr(self, "_user_seek_beginning")
def _bt_seek_beginning_from_native(self):
- self._seek_beginning()
+ self._user_seek_beginning()
- def _create_input_port_message_iterator(self, input_port):
+ 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")
+
+ 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(self, input_port):
utils._check_type(input_port, bt2_port._UserComponentInputPort)
- msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create_from_message_iterator(
+ if not input_port.is_connected:
+ raise ValueError("input port is not connected")
+
+ (
+ status,
+ msg_iter_ptr,
+ ) = native_bt.bt2_message_iterator_create_from_message_iterator(
self._bt_ptr, input_port._ptr
)
-
- if msg_iter_ptr is None:
- raise bt2.CreationError('cannot create message iterator object')
+ 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=None, default_clock_snapshot=None
- ):
+ def _create_event_message(self, event_class, parent, default_clock_snapshot=None):
utils._check_type(event_class, bt2_event_class._EventClass)
if event_class.stream_class.supports_packets:
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)
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:
)
if ptr is None:
- raise bt2._MemoryError('cannot create event message object')
+ raise bt2._MemoryError("cannot create event message object")
return bt2_message._EventMessage(ptr)
)
if ptr is None:
- raise bt2._MemoryError('cannot create inactivity message object')
+ raise bt2._MemoryError("cannot create inactivity message object")
return bt2_message._MessageIteratorInactivityMessage(ptr)
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._MemoryError("cannot create stream beginning message object")
msg = bt2_message._StreamBeginningMessage(ptr)
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._MemoryError("cannot create stream end message object")
msg = bt2_message._StreamEndMessage(ptr)
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._MemoryError("cannot create packet beginning message object")
return bt2_message._PacketBeginningMessage(ptr)
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._MemoryError("cannot create packet end message object")
return bt2_message._PacketEndMessage(ptr)
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
+
+ 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._MemoryError("cannot discarded events message object")
msg = bt2_message._DiscardedEventsMessage(ptr)
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
+
+ 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._MemoryError("cannot discarded packets message object")
msg = bt2_message._DiscardedPacketsMessage(ptr)
projects / babeltrace.git / blobdiff