*/
*can_seek = -1;
+ BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i",
+ iterator);
+
status = (int) iterator->methods.can_seek_ns_from_origin(iterator,
ns_from_origin, can_seek);
- BT_ASSERT_POST(
- status != BT_FUNC_STATUS_OK ||
- *can_seek == BT_TRUE ||
- *can_seek == BT_FALSE,
+ if (status != BT_FUNC_STATUS_OK) {
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: "
+ "%![iter-]+i, status=%s",
+ iterator, bt_common_func_status_string(status));
+ goto end;
+ }
+
+ BT_ASSERT_POST(*can_seek == BT_TRUE || *can_seek == BT_FALSE,
"Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i",
*can_seek, iterator);
- goto end;
+ BT_LIB_LOGD(
+ "User's \"can seek nanoseconds from origin\" returned successfully: "
+ "%![iter-]+i, can-seek=%d",
+ iterator, *can_seek);
+
+ if (*can_seek) {
+ goto end;
+ }
}
/*
- * Automatic seeking fall back: if we can seek to the beginning,
- * then we can automatically seek to any message.
+ * Automatic seeking fall back: if we can seek to the beginning and the
+ * iterator supports forward seeking then we can automatically seek to
+ * any timestamp.
*/
status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
iterator, can_seek);
+ if (status != BT_FUNC_STATUS_OK) {
+ goto end;
+ }
+
+ *can_seek = *can_seek && iterator->config.can_seek_forward;
end:
return status;
{
int status;
GHashTable *stream_states = NULL;
+ bt_bool can_seek_by_itself;
BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
"Graph is not configured: %!+g",
bt_component_borrow_graph(iterator->upstream_component));
+ /* The iterator must be able to seek ns from origin one way or another. */
BT_ASSERT_PRE(
message_iterator_can_seek_ns_from_origin(iterator, ns_from_origin),
"Message iterator cannot seek nanoseconds from origin: %!+i, "
*/
reset_iterator_expectations(iterator);
- if (iterator->methods.seek_ns_from_origin) {
+ /* Check if the iterator can seek by itself. If not we'll use autoseek. */
+ if (iterator->methods.can_seek_ns_from_origin) {
+ bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
+ can_seek_status;
+
+ can_seek_status =
+ iterator->methods.can_seek_ns_from_origin(
+ iterator, ns_from_origin, &can_seek_by_itself);
+ if (can_seek_status != BT_FUNC_STATUS_OK) {
+ status = can_seek_status;
+ goto end;
+ }
+ } else {
+ can_seek_by_itself = false;
+ }
+
+ if (can_seek_by_itself) {
/* The iterator knows how to seek to a particular time, let it handle this. */
+ BT_ASSERT_PRE_DEV(iterator->methods.seek_ns_from_origin,
+ "Message iterator does not implement `seek_ns_from_origin` method: %!+i",
+ iterator);
BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
"%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin);
status = iterator->methods.seek_ns_from_origin(iterator,
}
} else {
/*
- * The iterator doesn't know how to seek to a particular time. We will
- * seek to the beginning and fast forward to the right place.
+ * The iterator doesn't know how to seek by itself to a
+ * particular time. We will seek to the beginning and fast
+ * forward to the right place.
*/
enum bt_component_class_message_iterator_can_seek_beginning_method_status
can_seek_status;
user_can_seek_beginning=None,
user_seek_ns_from_origin=None,
user_can_seek_ns_from_origin=None,
+ can_seek_forward=False,
):
class MySourceIter(bt2._UserMessageIterator):
def __init__(self, config, port):
self._create_stream_end_message(stream),
]
self._at = 0
+ config.can_seek_forward = can_seek_forward
def __next__(self):
if self._at < len(self._msgs):
self._upstream_iter = self._create_input_port_message_iterator(
self._component._input_ports['in']
)
+ config.can_seek_forward = self._upstream_iter.can_seek_forward
def __next__(self):
return next(self._upstream_iter)
class UserMessageIteratorSeekNsFromOriginTestCase(unittest.TestCase):
- def test_can_seek_ns_from_origin(self):
- class MySink(bt2._UserSinkComponent):
- def __init__(self, config, params, obj):
- self._add_input_port('in')
+ def test_can_seek_ns_from_origin_returns_true(self):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: returns True
+ # - seek_ns_from_origin provided: Don't care
+ # - can the iterator seek beginning: Don't care
+ # - can the iterator seek forward: Don't care
+ #
+ # We expect iter.can_seek_ns_from_origin to return True.
+ for user_seek_ns_from_origin_provided in (False, True):
+ for iter_can_seek_beginning in (False, True):
+ for iter_can_seek_forward in (False, True):
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=True,
+ user_can_seek_ns_from_origin_ret_val=True,
+ user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided,
+ iter_can_seek_beginning=iter_can_seek_beginning,
+ iter_can_seek_forward=iter_can_seek_forward,
+ )
+
+ def test_can_seek_ns_from_origin_returns_false_can_seek_beginning_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: returns False
+ # - seek_ns_from_origin provided: Don't care
+ # - can the iterator seek beginning: Yes
+ # - can the iterator seek forward: Yes
+ #
+ # We expect iter.can_seek_ns_from_origin to return True.
+ for user_seek_ns_from_origin_provided in (False, True):
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=True,
+ user_can_seek_ns_from_origin_ret_val=False,
+ user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided,
+ iter_can_seek_beginning=True,
+ iter_can_seek_forward=True,
+ )
- def _user_graph_is_configured(self):
- self._msg_iter = self._create_input_port_message_iterator(
- self._input_ports['in']
- )
+ def test_can_seek_ns_from_origin_returns_false_can_seek_beginning_not_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: returns False
+ # - seek_ns_from_origin provided: Don't care
+ # - can the iterator seek beginning: Yes
+ # - can the iterator seek forward: No
+ #
+ # We expect iter.can_seek_ns_from_origin to return False.
+ for user_seek_ns_from_origin_provided in (False, True):
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=False,
+ user_can_seek_ns_from_origin_ret_val=False,
+ user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided,
+ iter_can_seek_beginning=True,
+ iter_can_seek_forward=False,
+ )
- def _user_consume(self):
- nonlocal can_seek_ns_from_origin
- nonlocal test_ns_from_origin
- can_seek_ns_from_origin = self._msg_iter.can_seek_ns_from_origin(
- test_ns_from_origin
+ def test_can_seek_ns_from_origin_returns_false_cant_seek_beginning_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: returns False
+ # - seek_ns_from_origin provided: Don't care
+ # - can the iterator seek beginning: No
+ # - can the iterator seek forward: Yes
+ #
+ # We expect iter.can_seek_ns_from_origin to return False.
+ # for user_seek_ns_from_origin_provided in (False, True):
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=False,
+ user_can_seek_ns_from_origin_ret_val=False,
+ user_seek_ns_from_origin_provided=False,
+ iter_can_seek_beginning=False,
+ iter_can_seek_forward=True,
+ )
+
+ def test_can_seek_ns_from_origin_returns_false_cant_seek_beginning_not_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: returns False
+ # - seek_ns_from_origin provided: Don't care
+ # - can the iterator seek beginning: No
+ # - can the iterator seek forward: No
+ #
+ # We expect iter.can_seek_ns_from_origin to return False.
+ for user_seek_ns_from_origin_provided in (False, True):
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=False,
+ user_can_seek_ns_from_origin_ret_val=False,
+ user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided,
+ iter_can_seek_beginning=False,
+ iter_can_seek_forward=False,
+ )
+
+ def test_no_can_seek_ns_from_origin_seek_ns_from_origin(self):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: Not provided
+ # - seek_ns_from_origin provided: Yes
+ # - can the iterator seek beginning: Don't care
+ # - can the iterator seek forward: Don't care
+ #
+ # We expect iter.can_seek_ns_from_origin to return True.
+ for iter_can_seek_beginning in (False, True):
+ for iter_can_seek_forward in (False, True):
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=True,
+ user_can_seek_ns_from_origin_ret_val=None,
+ user_seek_ns_from_origin_provided=True,
+ iter_can_seek_beginning=iter_can_seek_beginning,
+ iter_can_seek_forward=iter_can_seek_forward,
)
- def _user_can_seek_ns_from_origin(iter_self, ns_from_origin):
- nonlocal input_port_iter_can_seek_ns_from_origin
- nonlocal test_ns_from_origin
- self.assertEqual(ns_from_origin, test_ns_from_origin)
- return input_port_iter_can_seek_ns_from_origin
+ def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_can_seek_beginning_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: Not provided
+ # - seek_ns_from_origin provided: Not provided
+ # - can the iterator seek beginning: Yes
+ # - can the iterator seek forward: Yes
+ #
+ # We expect iter.can_seek_ns_from_origin to return True.
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=True,
+ user_can_seek_ns_from_origin_ret_val=None,
+ user_seek_ns_from_origin_provided=False,
+ iter_can_seek_beginning=True,
+ iter_can_seek_forward=True,
+ )
- graph = _setup_seek_test(
- MySink, user_can_seek_ns_from_origin=_user_can_seek_ns_from_origin
+ def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_can_seek_beginning_not_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: Not provided
+ # - seek_ns_from_origin provided: Not provided
+ # - can the iterator seek beginning: Yes
+ # - can the iterator seek forward: No
+ #
+ # We expect iter.can_seek_ns_from_origin to return False.
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=False,
+ user_can_seek_ns_from_origin_ret_val=None,
+ user_seek_ns_from_origin_provided=False,
+ iter_can_seek_beginning=True,
+ iter_can_seek_forward=False,
)
- input_port_iter_can_seek_ns_from_origin = True
- can_seek_ns_from_origin = None
- test_ns_from_origin = 1
- graph.run_once()
- self.assertIs(can_seek_ns_from_origin, True)
+ def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_cant_seek_beginning_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: Not provided
+ # - seek_ns_from_origin provided: Not provided
+ # - can the iterator seek beginning: No
+ # - can the iterator seek forward: Yes
+ #
+ # We expect iter.can_seek_ns_from_origin to return False.
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=False,
+ user_can_seek_ns_from_origin_ret_val=None,
+ user_seek_ns_from_origin_provided=False,
+ iter_can_seek_beginning=False,
+ iter_can_seek_forward=True,
+ )
- input_port_iter_can_seek_ns_from_origin = False
- can_seek_ns_from_origin = None
- test_ns_from_origin = 2
- graph.run_once()
- self.assertIs(can_seek_ns_from_origin, False)
+ def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_cant_seek_beginning_not_forward_seekable(
+ self
+ ):
+ # Test the case where:
+ #
+ # - can_seek_ns_from_origin: Not provided
+ # - seek_ns_from_origin provided: Not provided
+ # - can the iterator seek beginning: No
+ # - can the iterator seek forward: No
+ #
+ # We expect iter.can_seek_ns_from_origin to return False.
+ self._can_seek_ns_from_origin_test(
+ expected_outcome=False,
+ user_can_seek_ns_from_origin_ret_val=None,
+ user_seek_ns_from_origin_provided=False,
+ iter_can_seek_beginning=False,
+ iter_can_seek_forward=False,
+ )
- def test_no_can_seek_ns_from_origin_with_seek_ns_from_origin(self):
- # Test an iterator without a _user_can_seek_ns_from_origin method, but
- # with a _user_seek_ns_from_origin method.
+ def _can_seek_ns_from_origin_test(
+ self,
+ expected_outcome,
+ user_can_seek_ns_from_origin_ret_val,
+ user_seek_ns_from_origin_provided,
+ iter_can_seek_beginning,
+ iter_can_seek_forward,
+ ):
class MySink(bt2._UserSinkComponent):
def __init__(self, config, params, obj):
self._add_input_port('in')
def _user_consume(self):
nonlocal can_seek_ns_from_origin
- nonlocal test_ns_from_origin
can_seek_ns_from_origin = self._msg_iter.can_seek_ns_from_origin(
- test_ns_from_origin
+ passed_ns_from_origin
)
- def _user_seek_ns_from_origin(self):
- pass
+ if user_can_seek_ns_from_origin_ret_val is not None:
- graph = _setup_seek_test(
- MySink, user_seek_ns_from_origin=_user_seek_ns_from_origin
- )
- can_seek_ns_from_origin = None
- test_ns_from_origin = 2
- graph.run_once()
- self.assertIs(can_seek_ns_from_origin, True)
+ def user_can_seek_ns_from_origin(self, ns_from_origin):
+ nonlocal received_ns_from_origin
+ received_ns_from_origin = ns_from_origin
+ return user_can_seek_ns_from_origin_ret_val
- def test_no_can_seek_ns_from_origin_with_seek_beginning(self):
- # Test an iterator without a _user_can_seek_ns_from_origin method, but
- # with a _user_seek_beginning method.
- class MySink(bt2._UserSinkComponent):
- def __init__(self, config, params, obj):
- self._add_input_port('in')
+ else:
+ user_can_seek_ns_from_origin = None
- def _user_graph_is_configured(self):
- self._msg_iter = self._create_input_port_message_iterator(
- self._input_ports['in']
- )
+ if user_seek_ns_from_origin_provided:
- def _user_consume(self):
- nonlocal can_seek_ns_from_origin
- nonlocal test_ns_from_origin
- can_seek_ns_from_origin = self._msg_iter.can_seek_ns_from_origin(
- test_ns_from_origin
- )
+ def user_seek_ns_from_origin(self, ns_from_origin):
+ pass
- def _user_seek_beginning(self):
- pass
+ else:
+ user_seek_ns_from_origin = None
- graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning)
- can_seek_ns_from_origin = None
- test_ns_from_origin = 2
- graph.run_once()
- self.assertIs(can_seek_ns_from_origin, True)
+ if iter_can_seek_beginning:
- def test_no_can_seek_ns_from_origin(self):
- # Test an iterator without a _user_can_seek_ns_from_origin method
- # and no other related method.
- class MySink(bt2._UserSinkComponent):
- def __init__(self, config, params, obj):
- self._add_input_port('in')
+ def user_seek_beginning(self):
+ pass
- def _user_graph_is_configured(self):
- self._msg_iter = self._create_input_port_message_iterator(
- self._input_ports['in']
- )
+ else:
+ user_seek_beginning = None
- def _user_consume(self):
- nonlocal can_seek_ns_from_origin
- nonlocal test_ns_from_origin
- can_seek_ns_from_origin = self._msg_iter.can_seek_ns_from_origin(
- test_ns_from_origin
- )
+ graph = _setup_seek_test(
+ MySink,
+ user_can_seek_ns_from_origin=user_can_seek_ns_from_origin,
+ user_seek_ns_from_origin=user_seek_ns_from_origin,
+ user_seek_beginning=user_seek_beginning,
+ can_seek_forward=iter_can_seek_forward,
+ )
- graph = _setup_seek_test(MySink)
+ passed_ns_from_origin = 77
+ received_ns_from_origin = None
can_seek_ns_from_origin = None
- test_ns_from_origin = 2
graph.run_once()
- self.assertIs(can_seek_ns_from_origin, False)
+ self.assertIs(can_seek_ns_from_origin, expected_outcome)
+
+ if user_can_seek_ns_from_origin_ret_val is not None:
+ self.assertEqual(received_ns_from_origin, passed_ns_from_origin)
def test_can_seek_ns_from_origin_user_error(self):
class MySink(bt2._UserSinkComponent):
projects / babeltrace.git / commitdiff
