/*
+ * SPDX-License-Identifier: MIT
+ *
* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@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.
*/
#define BT_LOG_TAG "LIB/MSG-ITER"
#include <babeltrace2/graph/message-iterator.h>
#include <babeltrace2/types.h>
#include "common/assert.h"
-#include "lib/assert-pre.h"
-#include "lib/assert-post.h"
+#include "lib/assert-cond.h"
#include <stdint.h>
#include <inttypes.h>
#include <stdbool.h>
#define MSG_BATCH_SIZE 15
#define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
- BT_ASSERT_PRE((_iter)->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE || \
- (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ENDED || \
+ BT_ASSERT_PRE("has-state-to-seek", \
+ (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE || \
+ (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ENDED || \
(_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
(_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
- "Message iterator is in the wrong state: %!+i", _iter)
+ "Message iterator is in the wrong state: %!+i", (_iter))
+
+#ifdef BT_DEV_MODE
+struct per_stream_state
+{
+ bt_packet *cur_packet;
+
+ /* Bit mask of expected message types. */
+ guint expected_msg_types;
+};
+#endif
+
+static void
+clear_per_stream_state (struct bt_message_iterator *iterator)
+{
+#ifdef BT_DEV_MODE
+ g_hash_table_remove_all(iterator->per_stream_state);
+#else
+ BT_USE_EXPR(iterator);
+#endif
+}
static inline
void set_msg_iterator_state(struct bt_message_iterator *iterator,
iterator->msgs = NULL;
}
+#ifdef BT_DEV_MODE
+ g_hash_table_destroy(iterator->per_stream_state);
+#endif
+
g_free(iterator);
}
-BT_HIDDEN
void bt_message_iterator_try_finalize(
struct bt_message_iterator *iterator)
{
BT_LIB_LOGD("Calling user's finalization method: %!+i",
iterator);
method(iterator);
+ BT_ASSERT_POST_NO_ERROR("bt_message_iterator_class_finalize_method");
if (saved_error) {
BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
return;
}
-BT_HIDDEN
void bt_message_iterator_set_connection(
struct bt_message_iterator *iterator,
struct bt_connection *connection)
static
enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true(
- struct bt_message_iterator *iterator,
- int64_t ns_from_origin, bt_bool *can_seek)
+ struct bt_message_iterator *iterator __attribute__((unused)),
+ int64_t ns_from_origin __attribute__((unused)),
+ bt_bool *can_seek)
{
*can_seek = BT_TRUE;
static
enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true(
- struct bt_message_iterator *iterator,
+ struct bt_message_iterator *iterator __attribute__((unused)),
bt_bool *can_seek)
{
*can_seek = BT_TRUE;
int create_self_component_input_port_message_iterator(
struct bt_self_message_iterator *self_downstream_msg_iter,
struct bt_self_component_port_input *self_port,
- struct bt_message_iterator **message_iterator)
+ struct bt_message_iterator **message_iterator,
+ const char *api_func)
{
bt_message_iterator_class_initialize_method init_method = NULL;
struct bt_message_iterator *iterator =
struct bt_component_class_with_iterator_class *upstream_comp_cls_with_iter_cls;
int status;
- BT_ASSERT_PRE_NON_NULL(message_iterator, "Created message iterator");
- BT_ASSERT_PRE_NON_NULL(port, "Input port");
+ BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "message-iterator-output",
+ message_iterator, "Created message iterator (output)");
+ BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "input-port", port,
+ "Input port");
comp = bt_port_borrow_component_inline(port);
- BT_ASSERT_PRE(bt_port_is_connected(port),
+ BT_ASSERT_PRE_FROM_FUNC(api_func, "input-port-is-connected",
+ bt_port_is_connected(port),
"Input port is not connected: %![port-]+p", port);
- BT_ASSERT_PRE(comp, "Input port is not part of a component: %![port-]+p",
+ BT_ASSERT_PRE_FROM_FUNC(api_func, "input-port-has-component",
+ comp, "Input port is not part of a component: %![port-]+p",
port);
BT_ASSERT(port->connection);
upstream_port = port->connection->upstream_port;
BT_ASSERT(upstream_port);
upstream_comp = bt_port_borrow_component_inline(upstream_port);
BT_ASSERT(upstream_comp);
- BT_ASSERT_PRE(
+ BT_ASSERT_PRE_FROM_FUNC(api_func, "graph-is-configured",
bt_component_borrow_graph(upstream_comp)->config_state ==
BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED ||
bt_component_borrow_graph(upstream_comp)->config_state ==
g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE);
iterator->last_ns_from_origin = INT64_MIN;
+
+#ifdef BT_DEV_MODE
+ /* The per-stream state is only used for dev assertions right now. */
+ iterator->per_stream_state = g_hash_table_new_full(
+ g_direct_hash,
+ g_direct_equal,
+ NULL,
+ g_free);
+#endif
+
iterator->auto_seek.msgs = g_queue_new();
if (!iterator->auto_seek.msgs) {
BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue.");
(struct bt_self_component_port_output *) upstream_port);
BT_LOGD("User method returned: status=%s",
bt_common_func_status_string(iter_status));
- BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(iter_status);
+ BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
+ "bt_message_iterator_class_initialize_method",
+ iter_status);
if (iter_status != BT_FUNC_STATUS_OK) {
BT_LIB_LOGW_APPEND_CAUSE(
"Component input port message iterator initialization method failed: "
return status;
}
+BT_EXPORT
bt_message_iterator_create_from_message_iterator_status
bt_message_iterator_create_from_message_iterator(
struct bt_self_message_iterator *self_msg_iter,
struct bt_message_iterator **message_iterator)
{
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(self_msg_iter);
return create_self_component_input_port_message_iterator(self_msg_iter,
- input_port, message_iterator);
+ input_port, message_iterator, __func__);
}
+BT_EXPORT
bt_message_iterator_create_from_sink_component_status
bt_message_iterator_create_from_sink_component(
struct bt_self_component_sink *self_comp,
struct bt_message_iterator **message_iterator)
{
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(self_comp, "Sink component");
+ BT_ASSERT_PRE_NON_NULL("sink-component", self_comp, "Sink component");
return create_self_component_input_port_message_iterator(NULL,
- input_port, message_iterator);
+ input_port, message_iterator, __func__);
}
+BT_EXPORT
void *bt_self_message_iterator_get_data(
const struct bt_self_message_iterator *self_iterator)
{
struct bt_message_iterator *iterator =
(void *) self_iterator;
- BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
return iterator->user_data;
}
+BT_EXPORT
void bt_self_message_iterator_set_data(
struct bt_self_message_iterator *self_iterator, void *data)
{
struct bt_message_iterator *iterator =
(void *) self_iterator;
- BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
iterator->user_data = data;
BT_LIB_LOGD("Set message iterator's user data: "
"%!+i, user-data-addr=%p", iterator, data);
}
+BT_EXPORT
void bt_self_message_iterator_configuration_set_can_seek_forward(
bt_self_message_iterator_configuration *config,
bt_bool can_seek_forward)
{
- BT_ASSERT_PRE_NON_NULL(config, "Message iterator configuration");
- BT_ASSERT_PRE_DEV_HOT(config, "Message iterator configuration", "");
+ BT_ASSERT_PRE_NON_NULL("message-iterator-configuration", config,
+ "Message iterator configuration");
+ BT_ASSERT_PRE_DEV_HOT("message-iterator-configuration", config,
+ "Message iterator configuration", "");
config->can_seek_forward = can_seek_forward;
}
* time.
*/
-BT_ASSERT_POST_DEV_FUNC
+BT_ASSERT_COND_DEV_FUNC
static
bool clock_snapshots_are_monotonic_one(
struct bt_message_iterator *iterator,
return result;
}
-BT_ASSERT_POST_DEV_FUNC
+BT_ASSERT_COND_DEV_FUNC
static
bool clock_snapshots_are_monotonic(
struct bt_message_iterator *iterator,
* stream is compatible with what we've seen before.
*/
-BT_ASSERT_POST_DEV_FUNC
+BT_ASSERT_COND_DEV_FUNC
static
bool clock_classes_are_compatible_one(struct bt_message_iterator *iterator,
const struct bt_message *msg)
case CLOCK_EXPECTATION_NONE:
if (clock_class) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting no clock class, got one: %![cc-]+K",
clock_class);
result = false;
case CLOCK_EXPECTATION_ORIGIN_UNIX:
if (!clock_class) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class, got none.");
result = false;
goto end;
}
if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class with Unix epoch origin: %![cc-]+K",
clock_class);
result = false;
case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID:
if (!clock_class) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class, got none.");
result = false;
goto end;
}
if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class without Unix epoch origin: %![cc-]+K",
clock_class);
result = false;
}
if (!clock_class_uuid) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class with UUID: %![cc-]+K",
clock_class);
result = false;
}
if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class with UUID, got one "
"with a different UUID: %![cc-]+K, expected-uuid=%!u",
clock_class, iterator->clock_expectation.uuid);
case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID:
if (!clock_class) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class, got none.");
result = false;
goto end;
}
if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class without Unix epoch origin: %![cc-]+K",
clock_class);
result = false;
}
if (clock_class_uuid) {
- BT_ASSERT_POST_DEV_MSG(
+ BT_ASSERT_COND_DEV_MSG(
"Expecting a clock class without UUID: %![cc-]+K",
clock_class);
result = false;
return result;
}
-BT_ASSERT_POST_DEV_FUNC
+BT_ASSERT_COND_DEV_FUNC
static
bool clock_classes_are_compatible(
struct bt_message_iterator *iterator,
return result;
}
+#ifdef BT_DEV_MODE
+static
+const bt_stream *get_stream_from_msg(const struct bt_message *msg)
+{
+ struct bt_stream *stream;
+
+ switch (msg->type) {
+ case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+ case BT_MESSAGE_TYPE_STREAM_END:
+ {
+ struct bt_message_stream *msg_stream =
+ (struct bt_message_stream *) msg;
+ stream = msg_stream->stream;
+ break;
+ }
+ case BT_MESSAGE_TYPE_EVENT:
+ {
+ struct bt_message_event *msg_event =
+ (struct bt_message_event *) msg;
+ stream = msg_event->event->stream;
+ break;
+ }
+ case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+ case BT_MESSAGE_TYPE_PACKET_END:
+ {
+ struct bt_message_packet *msg_packet =
+ (struct bt_message_packet *) msg;
+ stream = msg_packet->packet->stream;
+ break;
+ }
+ case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+ case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+ {
+ struct bt_message_discarded_items *msg_discarded =
+ (struct bt_message_discarded_items *) msg;
+ stream = msg_discarded->stream;
+ break;
+ }
+ case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+ stream = NULL;
+ break;
+ default:
+ bt_common_abort();
+ }
+
+ return stream;
+}
+
+static
+GString *message_types_to_string(guint msg_types)
+{
+ GString *str = g_string_new("");
+
+ for (int msg_type = 1; msg_type <= BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY;
+ msg_type <<= 1) {
+ if (msg_type & msg_types) {
+ if (str->len > 0) {
+ g_string_append_c(str, '|');
+ }
+
+ g_string_append(str,
+ bt_common_message_type_string(msg_type));
+ }
+ }
+
+ return str;
+}
+
+static
+void update_expected_msg_type(const struct bt_stream *stream,
+ struct per_stream_state *state,
+ const struct bt_message *msg)
+{
+ switch (msg->type) {
+ case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+ state->expected_msg_types = BT_MESSAGE_TYPE_STREAM_END;
+
+ if (stream->class->supports_packets) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_PACKET_BEGINNING;
+
+ if (stream->class->supports_discarded_packets) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_PACKETS;
+ }
+ } else {
+ state->expected_msg_types |= BT_MESSAGE_TYPE_EVENT;
+ }
+
+ if (stream->class->supports_discarded_events) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_EVENTS;
+ }
+
+ break;
+ case BT_MESSAGE_TYPE_STREAM_END:
+ state->expected_msg_types = 0;
+ break;
+ case BT_MESSAGE_TYPE_EVENT:
+ {
+ state->expected_msg_types = BT_MESSAGE_TYPE_EVENT;
+
+ if (stream->class->supports_packets) {
+ state->expected_msg_types |= BT_MESSAGE_TYPE_PACKET_END;
+ } else {
+ state->expected_msg_types |= BT_MESSAGE_TYPE_STREAM_END;
+ }
+
+ if (stream->class->supports_discarded_events) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_EVENTS;
+ }
+
+ break;
+ }
+ case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+ {
+ state->expected_msg_types = BT_MESSAGE_TYPE_EVENT |
+ BT_MESSAGE_TYPE_PACKET_END;
+
+ if (stream->class->supports_discarded_events) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_EVENTS;
+ }
+
+ break;
+ }
+ case BT_MESSAGE_TYPE_PACKET_END:
+ {
+ state->expected_msg_types = BT_MESSAGE_TYPE_PACKET_BEGINNING |
+ BT_MESSAGE_TYPE_STREAM_END;
+
+ if (stream->class->supports_discarded_events) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_EVENTS;
+ }
+
+ if (stream->class->supports_discarded_packets) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_PACKETS;
+ }
+
+ break;
+ }
+ case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+ state->expected_msg_types = BT_MESSAGE_TYPE_DISCARDED_EVENTS;
+
+ if (state->cur_packet) {
+ state->expected_msg_types |= BT_MESSAGE_TYPE_EVENT |
+ BT_MESSAGE_TYPE_PACKET_END;
+ } else {
+ state->expected_msg_types |= BT_MESSAGE_TYPE_STREAM_END;
+
+ if (stream->class->supports_packets) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_PACKET_BEGINNING;
+
+ if (stream->class->supports_discarded_packets) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_PACKETS;
+ }
+ } else {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_EVENT;
+ }
+ }
+
+ break;
+ case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+ state->expected_msg_types = BT_MESSAGE_TYPE_DISCARDED_PACKETS |
+ BT_MESSAGE_TYPE_PACKET_BEGINNING |
+ BT_MESSAGE_TYPE_STREAM_END;
+
+ if (stream->class->supports_discarded_events) {
+ state->expected_msg_types |=
+ BT_MESSAGE_TYPE_DISCARDED_EVENTS;
+ }
+ break;
+ default:
+ /*
+ * Other message types are not associated to a stream, so we
+ * should not get them here.
+ */
+ bt_common_abort();
+ }
+}
+
+static
+struct per_stream_state *get_per_stream_state(
+ struct bt_message_iterator *iterator,
+ const struct bt_stream *stream)
+{
+ struct per_stream_state *state = g_hash_table_lookup(
+ iterator->per_stream_state, stream);
+
+ if (!state) {
+ state = g_new0(struct per_stream_state, 1);
+ state->expected_msg_types = BT_MESSAGE_TYPE_STREAM_BEGINNING;
+ g_hash_table_insert(iterator->per_stream_state,
+ (gpointer) stream, state);
+ }
+
+ return state;
+}
+#endif
+
+#define NEXT_METHOD_NAME "bt_message_iterator_class_next_method"
+
+#ifdef BT_DEV_MODE
+static
+void assert_post_dev_expected_sequence(struct bt_message_iterator *iterator,
+ const struct bt_message *msg)
+{
+ const bt_stream *stream = get_stream_from_msg(msg);
+ struct per_stream_state *state;
+
+ if (!stream) {
+ goto end;
+ }
+
+ state = get_per_stream_state(iterator, stream);
+
+ /*
+ * We don't free the return value of message_types_to_string(), but
+ * that's because we know the program is going to abort anyway, and
+ * we don't want to call it if the assertion holds.
+ */
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "message-type-is-expected",
+ msg->type & state->expected_msg_types,
+ "Unexpected message type: %![stream-]s, %![iterator-]i, "
+ "%![message-]n, expected-msg-types=%s",
+ stream, iterator, msg,
+ message_types_to_string(state->expected_msg_types)->str);
+
+ update_expected_msg_type(stream, state, msg);
+
+end:
+ return;
+}
+
+static
+void assert_post_dev_expected_packet(struct bt_message_iterator *iterator,
+ const struct bt_message *msg)
+{
+ const bt_stream *stream = get_stream_from_msg(msg);
+ struct per_stream_state *state;
+ const bt_packet *actual_packet = NULL;
+ const bt_packet *expected_packet = NULL;
+
+ if (!stream) {
+ goto end;
+ }
+
+ state = get_per_stream_state(iterator, stream);
+
+ switch (msg->type) {
+ case BT_MESSAGE_TYPE_EVENT:
+ {
+ const struct bt_message_event *msg_event =
+ (const struct bt_message_event *) msg;
+
+ actual_packet = msg_event->event->packet;
+ expected_packet = state->cur_packet;
+ break;
+ }
+ case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+ {
+ const struct bt_message_packet *msg_packet =
+ (const struct bt_message_packet *) msg;
+
+ BT_ASSERT(!state->cur_packet);
+ state->cur_packet = msg_packet->packet;
+ break;
+ }
+ case BT_MESSAGE_TYPE_PACKET_END:
+ {
+ const struct bt_message_packet *msg_packet =
+ (const struct bt_message_packet *) msg;
+
+ actual_packet = msg_packet->packet;
+ expected_packet = state->cur_packet;
+ BT_ASSERT(state->cur_packet);
+ state->cur_packet = NULL;
+ break;
+ }
+ default:
+ break;
+ }
+
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "message-packet-is-expected",
+ actual_packet == expected_packet,
+ "Message's packet is not expected: %![stream-]s, %![iterator-]i, "
+ "%![message-]n, %![received-packet-]a, %![expected-packet-]a",
+ stream, iterator, msg, actual_packet, expected_packet);
+
+end:
+ return;
+}
+
+static
+void assert_post_dev_next(
+ struct bt_message_iterator *iterator,
+ bt_message_iterator_class_next_method_status status,
+ bt_message_array_const msgs, uint64_t msg_count)
+{
+ if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK) {
+ uint64_t i;
+
+ for (i = 0; i < msg_count; i++) {
+ assert_post_dev_expected_sequence(iterator, msgs[i]);
+ assert_post_dev_expected_packet(iterator, msgs[i]);
+ }
+ } else if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END) {
+ GHashTableIter iter;
+
+ gpointer stream_v, stream_state_v;
+
+ g_hash_table_iter_init(&iter, iterator->per_stream_state);
+ while (g_hash_table_iter_next(&iter, &stream_v,
+ &stream_state_v)) {
+ struct bt_stream *stream = stream_v;
+ struct per_stream_state *stream_state = stream_state_v;
+
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "stream-is-ended",
+ stream_state->expected_msg_types == 0,
+ "Stream is not ended: %![stream-]s, "
+ "%![iterator-]i, expected-msg-types=%s",
+ stream, iterator,
+ message_types_to_string(
+ stream_state->expected_msg_types)->str);
+ }
+
+ }
+}
+#endif
+
/*
* Call the `next` method of the iterator. Do some validation on the returned
* messages.
bt_common_func_status_string(status), *user_count);
if (status == BT_FUNC_STATUS_OK) {
- BT_ASSERT_POST_DEV(clock_classes_are_compatible(iterator, msgs, *user_count),
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "message-clock-classes-are-compatible",
+ clock_classes_are_compatible(iterator, msgs,
+ *user_count),
"Clocks are not compatible");
- BT_ASSERT_POST_DEV(clock_snapshots_are_monotonic(iterator, msgs, *user_count),
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "message-clock-snapshots-are-monotonic",
+ clock_snapshots_are_monotonic(iterator, msgs,
+ *user_count),
"Clock snapshots are not monotonic");
}
- BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(status);
+#ifdef BT_DEV_MODE
+ assert_post_dev_next(iterator, status, msgs, *user_count);
+#endif
+
+ BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(NEXT_METHOD_NAME,
+ status);
return status;
}
+BT_EXPORT
enum bt_message_iterator_next_status
bt_message_iterator_next(
struct bt_message_iterator *iterator,
enum bt_message_iterator_next_status status = BT_FUNC_STATUS_OK;
BT_ASSERT_PRE_DEV_NO_ERROR();
- BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
- BT_ASSERT_PRE_DEV_NON_NULL(msgs, "Message array (output)");
- BT_ASSERT_PRE_DEV_NON_NULL(user_count, "Message count (output)");
- BT_ASSERT_PRE_DEV(iterator->state ==
- BT_MESSAGE_ITERATOR_STATE_ACTIVE,
+ BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
+ BT_ASSERT_PRE_DEV_NON_NULL("message-array-output", msgs,
+ "Message array (output)");
+ BT_ASSERT_PRE_DEV_NON_NULL("user-count-output", user_count,
+ "Message count (output)");
+ BT_ASSERT_PRE_DEV("message-iterator-is-active",
+ iterator->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE,
"Message iterator's \"next\" called, but "
"message iterator is in the wrong state: %!+i", iterator);
BT_ASSERT_DBG(iterator->upstream_component);
BT_ASSERT_DBG(iterator->upstream_component->class);
- BT_ASSERT_PRE_DEV(
+ BT_ASSERT_PRE_DEV("graph-is-configured",
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
"Graph is not configured: %!+g",
* by its downstream owner.
*
* For the same reason, there is no way that this iterator could
- * have seeked (cannot seek a self message iterator).
+ * have sought (cannot seek a self message iterator).
*/
BT_ASSERT_DBG(iterator->state ==
BT_MESSAGE_ITERATOR_STATE_ACTIVE);
switch (status) {
case BT_FUNC_STATUS_OK:
- BT_ASSERT_POST_DEV(*user_count <= MSG_BATCH_SIZE,
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, "count-lteq-capacity",
+ *user_count <= MSG_BATCH_SIZE,
"Invalid returned message count: greater than "
"batch size: count=%" PRIu64 ", batch-size=%u",
*user_count, MSG_BATCH_SIZE);
return status;
}
+BT_EXPORT
struct bt_component *
bt_message_iterator_borrow_component(
struct bt_message_iterator *iterator)
{
- BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
return iterator->upstream_component;
}
+BT_EXPORT
struct bt_self_component *bt_self_message_iterator_borrow_component(
struct bt_self_message_iterator *self_iterator)
{
struct bt_message_iterator *iterator =
(void *) self_iterator;
- BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
return (void *) iterator->upstream_component;
}
+BT_EXPORT
struct bt_self_component_port_output *bt_self_message_iterator_borrow_port(
struct bt_self_message_iterator *self_iterator)
{
struct bt_message_iterator *iterator =
(void *) self_iterator;
- BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
return (void *) iterator->upstream_port;
}
+#define CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME \
+ "bt_message_iterator_class_can_seek_ns_from_origin_method"
+
+BT_EXPORT
enum bt_message_iterator_can_seek_ns_from_origin_status
bt_message_iterator_can_seek_ns_from_origin(
struct bt_message_iterator *iterator,
enum bt_message_iterator_can_seek_ns_from_origin_status status;
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
- BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
+ BT_ASSERT_PRE_RES_OUT_NON_NULL(can_seek);
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
- BT_ASSERT_PRE(
+ BT_ASSERT_PRE("graph-is-configured",
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
"Graph is not configured: %!+g",
status = (int) iterator->methods.can_seek_ns_from_origin(iterator,
ns_from_origin, can_seek);
- BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
+ BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
+ CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME, status);
if (status != BT_FUNC_STATUS_OK) {
BT_LIB_LOGW_APPEND_CAUSE(
goto end;
}
- BT_ASSERT_POST(*can_seek == BT_TRUE || *can_seek == BT_FALSE,
+ BT_ASSERT_POST(CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME,
+ "valid-return-value",
+ *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);
return status;
}
+#define CAN_SEEK_BEGINNING_METHOD_NAME \
+ "bt_message_iterator_class_can_seek_beginning"
+
+BT_EXPORT
enum bt_message_iterator_can_seek_beginning_status
bt_message_iterator_can_seek_beginning(
struct bt_message_iterator *iterator,
enum bt_message_iterator_can_seek_beginning_status status;
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
- BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
+ BT_ASSERT_PRE_RES_OUT_NON_NULL(can_seek);
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
- BT_ASSERT_PRE(
+ BT_ASSERT_PRE("graph-is-configured",
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
"Graph is not configured: %!+g",
status = (int) iterator->methods.can_seek_beginning(iterator, can_seek);
- BT_ASSERT_POST(
+ BT_ASSERT_POST(CAN_SEEK_BEGINNING_METHOD_NAME,
+ "valid-return-value",
status != BT_FUNC_STATUS_OK ||
*can_seek == BT_TRUE ||
*can_seek == BT_FALSE,
"Unexpected boolean value returned from user's \"can seek beginning\" method: val=%d, %![iter-]+i",
*can_seek, iterator);
- BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
+ BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
+ CAN_SEEK_BEGINNING_METHOD_NAME, status);
} else {
*can_seek = BT_FALSE;
status = BT_FUNC_STATUS_OK;
return can_seek;
}
+#define SEEK_BEGINNING_METHOD_NAME \
+ "bt_message_iterator_class_seek_beginning_method"
+
+BT_EXPORT
enum bt_message_iterator_seek_beginning_status
-bt_message_iterator_seek_beginning(
- struct bt_message_iterator *iterator)
+bt_message_iterator_seek_beginning(struct bt_message_iterator *iterator)
{
int status;
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
- BT_ASSERT_PRE(
+ BT_ASSERT_PRE("graph-is-configured",
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
"Graph is not configured: %!+g",
bt_component_borrow_graph(iterator->upstream_component));
- BT_ASSERT_PRE(message_iterator_can_seek_beginning(iterator),
+ BT_ASSERT_PRE("can-seek-beginning",
+ message_iterator_can_seek_beginning(iterator),
"Message iterator cannot seek beginning: %!+i", iterator);
/*
status = iterator->methods.seek_beginning(iterator);
BT_LOGD("User method returned: status=%s",
bt_common_func_status_string(status));
- BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
+ BT_ASSERT_POST(SEEK_BEGINNING_METHOD_NAME, "valid-status",
+ status == BT_FUNC_STATUS_OK ||
status == BT_FUNC_STATUS_ERROR ||
status == BT_FUNC_STATUS_MEMORY_ERROR ||
status == BT_FUNC_STATUS_AGAIN,
"Unexpected status: %![iter-]+i, status=%s",
iterator, bt_common_func_status_string(status));
- BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
+ BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(SEEK_BEGINNING_METHOD_NAME,
+ status);
if (status < 0) {
BT_LIB_LOGW_APPEND_CAUSE(
"Component input port message iterator's \"seek beginning\" method failed: "
iterator, bt_common_func_status_string(status));
}
+ clear_per_stream_state(iterator);
+
set_iterator_state_after_seeking(iterator, status);
return status;
}
+BT_EXPORT
bt_bool
bt_message_iterator_can_seek_forward(
bt_message_iterator *iterator)
{
- BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
return iterator->config.can_seek_forward;
}
(const void *) msg;
clk_snapshot = event_msg->default_cs;
- BT_ASSERT_POST_DEV(clk_snapshot,
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "event-message-has-default-clock-snapshot",
+ clk_snapshot,
"Event message has no default clock snapshot: %!+n",
event_msg);
break;
const struct bt_message_packet *packet_msg =
(const void *) msg;
+ if (msg->type == BT_MESSAGE_TYPE_PACKET_BEGINNING
+ && !packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) {
+ goto skip_msg;
+ }
+
+ if (msg->type == BT_MESSAGE_TYPE_PACKET_END
+ && !packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) {
+ goto skip_msg;
+ }
+
clk_snapshot = packet_msg->default_cs;
- BT_ASSERT_POST_DEV(clk_snapshot,
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "packet-message-has-default-clock-snapshot",
+ clk_snapshot,
"Packet message has no default clock snapshot: %!+n",
packet_msg);
break;
struct bt_message_discarded_items *msg_disc_items =
(void *) msg;
- BT_ASSERT_POST_DEV(msg_disc_items->default_begin_cs &&
- msg_disc_items->default_end_cs,
+ if (msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS &&
+ !msg_disc_items->stream->class->discarded_events_have_default_clock_snapshots) {
+ goto skip_msg;
+ }
+
+ if (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS &&
+ !msg_disc_items->stream->class->discarded_packets_have_default_clock_snapshots) {
+ goto skip_msg;
+ }
+
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "discarded-events-packets-message-has-default-clock-snapshot",
+ msg_disc_items->default_begin_cs &&
+ msg_disc_items->default_end_cs,
"Discarded events/packets message has no default clock snapshots: %!+n",
msg_disc_items);
ret = bt_clock_snapshot_get_ns_from_origin(
switch (status) {
case BT_FUNC_STATUS_OK:
- BT_ASSERT_POST_DEV(user_count <= MSG_BATCH_SIZE,
+ BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+ "count-lteq-capacity",
+ user_count <= MSG_BATCH_SIZE,
"Invalid returned message count: greater than "
"batch size: count=%" PRIu64 ", batch-size=%u",
user_count, MSG_BATCH_SIZE);
/*
* This function is installed as the iterator's next callback after we have
- * auto-seeked (seeked to the beginning and fast-forwarded) to send the
+ * auto-sought (sought to the beginning and fast-forwarded) to send the
* messages saved in iterator->auto_seek.msgs. Once this is done, the original
* next callback is put back.
*/
return can_seek;
}
+#define SEEK_NS_FROM_ORIGIN_METHOD_NAME \
+ "bt_message_iterator_class_seek_ns_from_origin_method"
+
+
+BT_EXPORT
enum bt_message_iterator_seek_ns_from_origin_status
bt_message_iterator_seek_ns_from_origin(
struct bt_message_iterator *iterator,
bt_bool can_seek_by_itself;
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
- BT_ASSERT_PRE(
+ BT_ASSERT_PRE("graph-is-configured",
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
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(
+ BT_ASSERT_PRE("can-seek-ns-from-origin",
message_iterator_can_seek_ns_from_origin(iterator, ns_from_origin),
"Message iterator cannot seek nanoseconds from origin: %!+i, "
"ns-from-origin=%" PRId64, iterator, ns_from_origin);
ns_from_origin);
BT_LOGD("User method returned: status=%s",
bt_common_func_status_string(status));
- BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
+ BT_ASSERT_POST(SEEK_NS_FROM_ORIGIN_METHOD_NAME, "valid-status",
+ status == BT_FUNC_STATUS_OK ||
status == BT_FUNC_STATUS_ERROR ||
status == BT_FUNC_STATUS_MEMORY_ERROR ||
status == BT_FUNC_STATUS_AGAIN,
"Unexpected status: %![iter-]+i, status=%s",
iterator, bt_common_func_status_string(status));
- BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
+ BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
+ SEEK_NS_FROM_ORIGIN_METHOD_NAME, status);
if (status < 0) {
BT_LIB_LOGW_APPEND_CAUSE(
"Component input port message iterator's \"seek nanoseconds from origin\" method failed: "
status = iterator->methods.seek_beginning(iterator);
BT_LOGD("User method returned: status=%s",
bt_common_func_status_string(status));
- BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
+ BT_ASSERT_POST(SEEK_BEGINNING_METHOD_NAME, "valid-status",
+ status == BT_FUNC_STATUS_OK ||
status == BT_FUNC_STATUS_ERROR ||
status == BT_FUNC_STATUS_MEMORY_ERROR ||
status == BT_FUNC_STATUS_AGAIN,
iterator, bt_common_func_status_string(status));
}
+ clear_per_stream_state(iterator);
+
switch (status) {
case BT_FUNC_STATUS_OK:
break;
}
}
+ clear_per_stream_state(iterator);
+
/*
* The following messages returned by the next method (including
* post_auto_seek_next) must be after (or at) `ns_from_origin`.
return status;
}
+BT_EXPORT
bt_bool bt_self_message_iterator_is_interrupted(
const struct bt_self_message_iterator *self_msg_iter)
{
const struct bt_message_iterator *iterator =
(const void *) self_msg_iter;
- BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
+ BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
return (bt_bool) bt_graph_is_interrupted(iterator->graph);
}
+BT_EXPORT
void bt_message_iterator_get_ref(
const struct bt_message_iterator *iterator)
{
bt_object_get_ref(iterator);
}
+BT_EXPORT
void bt_message_iterator_put_ref(
const struct bt_message_iterator *iterator)
{
projects / babeltrace.git / blobdiff