X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fgraph%2Fiterator.c;h=1e02eb33c5eff3613ae6809a4d2c7322749cf205;hb=2d8aeedf7e6b830747a71bceaa0f8a35e97293b9;hp=56b688046c5a746c4a33d663dc4b7b5af0f7de16;hpb=7b53201cfb06ec02f4203e28458dfbcf53d87988;p=babeltrace.git diff --git a/lib/graph/iterator.c b/lib/graph/iterator.c index 56b68804..1e02eb33 100644 --- a/lib/graph/iterator.c +++ b/lib/graph/iterator.c @@ -1,6 +1,6 @@ /* + * Copyright 2017-2018 Philippe Proulx * Copyright 2015 Jérémie Galarneau - * Copyright 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 @@ -21,12 +21,13 @@ * SOFTWARE. */ -#define BT_LOG_TAG "NOTIF-ITER" +#define BT_LOG_TAG "MSG-ITER" #include #include -#include -#include +#include +#include +#include #include #include #include @@ -40,18 +41,24 @@ #include #include #include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include @@ -67,82 +74,59 @@ * TODO: Use graph's state (number of active iterators, etc.) and * possibly system specifications to make a better guess than this. */ -#define NOTIF_BATCH_SIZE 15 +#define MSG_BATCH_SIZE 15 -struct stream_state { - const struct bt_stream *stream; /* owned by this */ - const struct bt_packet *cur_packet; /* owned by this */ - uint64_t expected_notif_seq_num; - bt_bool is_ended; -}; +#define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \ + BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \ + (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \ + (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \ + (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \ + "Message iterator is in the wrong state: %!+i", _iter) -BT_ASSERT_PRE_FUNC -static -void destroy_stream_state(struct stream_state *stream_state) +static inline +void _set_self_comp_port_input_msg_iterator_state( + struct bt_self_component_port_input_message_iterator *iterator, + enum bt_self_component_port_input_message_iterator_state state) { - if (!stream_state) { - return; - } - - BT_LOGV("Destroying stream state: stream-state-addr=%p", stream_state); - BT_LOGV_STR("Putting stream state's current packet."); - BT_OBJECT_PUT_REF_AND_RESET(stream_state->cur_packet); - BT_LOGV_STR("Putting stream state's stream."); - BT_OBJECT_PUT_REF_AND_RESET(stream_state->stream); - g_free(stream_state); + BT_ASSERT(iterator); + BT_LIB_LOGD("Updating message iterator's state: new-state=%s", + bt_self_component_port_input_message_iterator_state_string(state)); + iterator->state = state; } -BT_ASSERT_PRE_FUNC -static -struct stream_state *create_stream_state(const struct bt_stream *stream) -{ - struct stream_state *stream_state = g_new0(struct stream_state, 1); - - if (!stream_state) { - BT_LOGE_STR("Failed to allocate one stream state."); - goto end; - } - - /* - * We keep a reference to the stream until we know it's ended. - */ - stream_state->stream = stream; - bt_object_get_no_null_check(stream_state->stream); - BT_LIB_LOGV("Created stream state: %![stream-]+s, " - "stream-state-addr=%p", - stream, stream_state); - -end: - return stream_state; -} +#ifdef BT_DEV_MODE +# define set_self_comp_port_input_msg_iterator_state _set_self_comp_port_input_msg_iterator_state +#else +# define set_self_comp_port_input_msg_iterator_state(_a, _b) ((void) _a); ((void) _b); +#endif static -void destroy_base_notification_iterator(struct bt_object *obj) +void destroy_base_message_iterator(struct bt_object *obj) { - struct bt_notification_iterator *iterator = (void *) obj; + struct bt_message_iterator *iterator = (void *) obj; BT_ASSERT(iterator); - if (iterator->notifs) { - g_ptr_array_free(iterator->notifs, TRUE); - iterator->notifs = NULL; + if (iterator->msgs) { + g_ptr_array_free(iterator->msgs, TRUE); + iterator->msgs = NULL; } g_free(iterator); } static -void bt_self_component_port_input_notification_iterator_destroy(struct bt_object *obj) +void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj) { - struct bt_self_component_port_input_notification_iterator *iterator; + struct bt_self_component_port_input_message_iterator *iterator; BT_ASSERT(obj); /* - * The notification iterator's reference count is 0 if we're + * The message iterator's reference count is 0 if we're * here. Increment it to avoid a double-destroy (possibly * infinitely recursive). This could happen for example if the - * notification iterator's finalization function does + * message iterator's finalization function does * bt_object_get_ref() (or anything that causes * bt_object_get_ref() to be called) on itself (ref. count goes * from 0 to 1), and then bt_object_put_ref(): the reference @@ -151,20 +135,9 @@ void bt_self_component_port_input_notification_iterator_destroy(struct bt_object */ obj->ref_count++; iterator = (void *) obj; - BT_LIB_LOGD("Destroying self component input port notification iterator object: " + BT_LIB_LOGD("Destroying self component input port message iterator object: " "%!+i", iterator); - bt_self_component_port_input_notification_iterator_finalize(iterator); - - if (iterator->stream_states) { - /* - * Remove our destroy listener from each stream which - * has a state in this iterator. Otherwise the destroy - * listener would be called with an invalid/other - * notification iterator object. - */ - g_hash_table_destroy(iterator->stream_states); - iterator->stream_states = NULL; - } + bt_self_component_port_input_message_iterator_try_finalize(iterator); if (iterator->connection) { /* @@ -176,12 +149,22 @@ void bt_self_component_port_input_notification_iterator_destroy(struct bt_object iterator->connection = NULL; } - destroy_base_notification_iterator(obj); + if (iterator->auto_seek_msgs) { + while (!g_queue_is_empty(iterator->auto_seek_msgs)) { + bt_object_put_no_null_check( + g_queue_pop_tail(iterator->auto_seek_msgs)); + } + + g_queue_free(iterator->auto_seek_msgs); + iterator->auto_seek_msgs = NULL; + } + + destroy_base_message_iterator(obj); } BT_HIDDEN -void bt_self_component_port_input_notification_iterator_finalize( - struct bt_self_component_port_input_notification_iterator *iterator) +void bt_self_component_port_input_message_iterator_try_finalize( + struct bt_self_component_port_input_message_iterator *iterator) { typedef void (*method_t)(void *); @@ -191,33 +174,28 @@ void bt_self_component_port_input_notification_iterator_finalize( BT_ASSERT(iterator); switch (iterator->state) { - case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED: + case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED: /* Skip user finalization if user initialization failed */ - BT_LIB_LOGD("Not finalizing non-initialized notification iterator: " + BT_LIB_LOGD("Not finalizing non-initialized message iterator: " "%!+i", iterator); - return; - case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED: - case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED: + goto end; + case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED: /* Already finalized */ - BT_LIB_LOGD("Not finalizing notification iterator: already finalized: " + BT_LIB_LOGD("Not finalizing message iterator: already finalized: " "%!+i", iterator); - return; + goto end; + case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING: + /* Already finalized */ + BT_LIB_LOGF("Message iterator is already being finalized: " + "%!+i", iterator); + abort(); default: break; } - BT_LIB_LOGD("Finalizing notification iterator: %!+i", iterator); - - if (iterator->state == BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ENDED) { - BT_LIB_LOGD("Updating notification iterator's state: " - "new-state=BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED"); - iterator->state = BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED; - } else { - BT_LIB_LOGD("Updating notification iterator's state: " - "new-state=BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED"); - iterator->state = BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED; - } - + BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator); + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING); BT_ASSERT(iterator->upstream_component); comp_class = iterator->upstream_component->class; @@ -228,7 +206,7 @@ void bt_self_component_port_input_notification_iterator_finalize( struct bt_component_class_source *src_comp_cls = (void *) comp_class; - method = (method_t) src_comp_cls->methods.notif_iter_finalize; + method = (method_t) src_comp_cls->methods.msg_iter_finalize; break; } case BT_COMPONENT_CLASS_TYPE_FILTER: @@ -236,7 +214,7 @@ void bt_self_component_port_input_notification_iterator_finalize( struct bt_component_class_filter *flt_comp_cls = (void *) comp_class; - method = (method_t) flt_comp_cls->methods.notif_iter_finalize; + method = (method_t) flt_comp_cls->methods.msg_iter_finalize; break; } default: @@ -252,82 +230,101 @@ void bt_self_component_port_input_notification_iterator_finalize( iterator->upstream_component = NULL; iterator->upstream_port = NULL; - BT_LIB_LOGD("Finalized notification iterator: %!+i", iterator); + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED); + BT_LIB_LOGD("Finalized message iterator: %!+i", iterator); + +end: + return; } BT_HIDDEN -void bt_self_component_port_input_notification_iterator_set_connection( - struct bt_self_component_port_input_notification_iterator *iterator, +void bt_self_component_port_input_message_iterator_set_connection( + struct bt_self_component_port_input_message_iterator *iterator, struct bt_connection *connection) { BT_ASSERT(iterator); iterator->connection = connection; - BT_LIB_LOGV("Set notification iterator's connection: " + BT_LIB_LOGV("Set message iterator's connection: " "%![iter-]+i, %![conn-]+x", iterator, connection); } static -int init_notification_iterator(struct bt_notification_iterator *iterator, - enum bt_notification_iterator_type type, +int init_message_iterator(struct bt_message_iterator *iterator, + enum bt_message_iterator_type type, bt_object_release_func destroy) { int ret = 0; bt_object_init_shared(&iterator->base, destroy); iterator->type = type; - iterator->notifs = g_ptr_array_new(); - if (!iterator->notifs) { + iterator->msgs = g_ptr_array_new(); + if (!iterator->msgs) { BT_LOGE_STR("Failed to allocate a GPtrArray."); ret = -1; goto end; } - g_ptr_array_set_size(iterator->notifs, NOTIF_BATCH_SIZE); + g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE); end: return ret; } static -struct bt_self_component_port_input_notification_iterator * -bt_self_component_port_input_notification_iterator_create_initial( +bt_bool can_seek_ns_from_origin_true( + struct bt_self_component_port_input_message_iterator *iterator, + int64_t ns_from_origin) +{ + return BT_TRUE; +} + +static +bt_bool can_seek_beginning_true( + struct bt_self_component_port_input_message_iterator *iterator) +{ + return BT_TRUE; +} + +static +struct bt_self_component_port_input_message_iterator * +bt_self_component_port_input_message_iterator_create_initial( struct bt_component *upstream_comp, struct bt_port *upstream_port) { int ret; - struct bt_self_component_port_input_notification_iterator *iterator = NULL; + struct bt_self_component_port_input_message_iterator *iterator = NULL; BT_ASSERT(upstream_comp); BT_ASSERT(upstream_port); BT_ASSERT(bt_port_is_connected(upstream_port)); - BT_LIB_LOGD("Creating initial notification iterator on self component input port: " + BT_LIB_LOGD("Creating initial message iterator on self component input port: " "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port); BT_ASSERT(bt_component_get_class_type(upstream_comp) == BT_COMPONENT_CLASS_TYPE_SOURCE || bt_component_get_class_type(upstream_comp) == BT_COMPONENT_CLASS_TYPE_FILTER); iterator = g_new0( - struct bt_self_component_port_input_notification_iterator, 1); + struct bt_self_component_port_input_message_iterator, 1); if (!iterator) { BT_LOGE_STR("Failed to allocate one self component input port " - "notification iterator."); + "message iterator."); goto end; } - ret = init_notification_iterator((void *) iterator, - BT_NOTIFICATION_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT, - bt_self_component_port_input_notification_iterator_destroy); + ret = init_message_iterator((void *) iterator, + BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT, + bt_self_component_port_input_message_iterator_destroy); if (ret) { - /* init_notification_iterator() logs errors */ + /* init_message_iterator() logs errors */ BT_OBJECT_PUT_REF_AND_RESET(iterator); goto end; } - iterator->stream_states = g_hash_table_new_full(g_direct_hash, - g_direct_equal, NULL, (GDestroyNotify) destroy_stream_state); - if (!iterator->stream_states) { - BT_LOGE_STR("Failed to allocate a GHashTable."); - BT_OBJECT_PUT_REF_AND_RESET(iterator); + iterator->auto_seek_msgs = g_queue_new(); + if (!iterator->auto_seek_msgs) { + BT_LOGE_STR("Failed to allocate a GQueue."); + ret = -1; goto end; } @@ -335,8 +332,73 @@ bt_self_component_port_input_notification_iterator_create_initial( iterator->upstream_port = upstream_port; iterator->connection = iterator->upstream_port->connection; iterator->graph = bt_component_borrow_graph(upstream_comp); - iterator->state = BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED; - BT_LIB_LOGD("Created initial notification iterator on self component input port: " + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED); + + switch (iterator->upstream_component->class->type) { + case BT_COMPONENT_CLASS_TYPE_SOURCE: + { + struct bt_component_class_source *src_comp_cls = + (void *) iterator->upstream_component->class; + + iterator->methods.next = + (bt_self_component_port_input_message_iterator_next_method) + src_comp_cls->methods.msg_iter_next; + iterator->methods.seek_ns_from_origin = + (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method) + src_comp_cls->methods.msg_iter_seek_ns_from_origin; + iterator->methods.seek_beginning = + (bt_self_component_port_input_message_iterator_seek_beginning_method) + src_comp_cls->methods.msg_iter_seek_beginning; + iterator->methods.can_seek_ns_from_origin = + (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method) + src_comp_cls->methods.msg_iter_can_seek_ns_from_origin; + iterator->methods.can_seek_beginning = + (bt_self_component_port_input_message_iterator_can_seek_beginning_method) + src_comp_cls->methods.msg_iter_can_seek_beginning; + break; + } + case BT_COMPONENT_CLASS_TYPE_FILTER: + { + struct bt_component_class_filter *flt_comp_cls = + (void *) iterator->upstream_component->class; + + iterator->methods.next = + (bt_self_component_port_input_message_iterator_next_method) + flt_comp_cls->methods.msg_iter_next; + iterator->methods.seek_ns_from_origin = + (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method) + flt_comp_cls->methods.msg_iter_seek_ns_from_origin; + iterator->methods.seek_beginning = + (bt_self_component_port_input_message_iterator_seek_beginning_method) + flt_comp_cls->methods.msg_iter_seek_beginning; + iterator->methods.can_seek_ns_from_origin = + (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method) + flt_comp_cls->methods.msg_iter_can_seek_ns_from_origin; + iterator->methods.can_seek_beginning = + (bt_self_component_port_input_message_iterator_can_seek_beginning_method) + flt_comp_cls->methods.msg_iter_can_seek_beginning; + break; + } + default: + abort(); + } + + if (iterator->methods.seek_ns_from_origin && + !iterator->methods.can_seek_ns_from_origin) { + iterator->methods.can_seek_ns_from_origin = + (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method) + can_seek_ns_from_origin_true; + } + + if (iterator->methods.seek_beginning && + !iterator->methods.can_seek_beginning) { + iterator->methods.can_seek_beginning = + (bt_self_component_port_input_message_iterator_seek_beginning_method) + can_seek_beginning_true; + } + + BT_LIB_LOGD("Created initial message iterator on self component input port: " "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i", upstream_port, upstream_comp, iterator); @@ -344,15 +406,15 @@ end: return iterator; } -struct bt_self_component_port_input_notification_iterator * -bt_self_component_port_input_notification_iterator_create( +struct bt_self_component_port_input_message_iterator * +bt_self_component_port_input_message_iterator_create( struct bt_self_component_port_input *self_port) { - typedef enum bt_self_notification_iterator_status (*init_method_t)( + typedef enum bt_self_message_iterator_status (*init_method_t)( void *, void *, void *); init_method_t init_method = NULL; - struct bt_self_component_port_input_notification_iterator *iterator = + struct bt_self_component_port_input_message_iterator *iterator = NULL; struct bt_port *port = (void *) self_port; struct bt_port *upstream_port; @@ -374,16 +436,21 @@ bt_self_component_port_input_notification_iterator_create( BT_ASSERT(upstream_port); upstream_comp = bt_port_borrow_component_inline(upstream_port); BT_ASSERT(upstream_comp); + BT_ASSERT_PRE( + bt_component_borrow_graph(upstream_comp)->config_state != + BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, + "Graph is not configured: %!+g", + bt_component_borrow_graph(upstream_comp)); upstream_comp_cls = upstream_comp->class; BT_ASSERT(upstream_comp->class->type == BT_COMPONENT_CLASS_TYPE_SOURCE || upstream_comp->class->type == BT_COMPONENT_CLASS_TYPE_FILTER); - iterator = bt_self_component_port_input_notification_iterator_create_initial( + iterator = bt_self_component_port_input_message_iterator_create_initial( upstream_comp, upstream_port); if (!iterator) { BT_LOGW_STR("Cannot create self component input port " - "notification iterator."); + "message iterator."); goto end; } @@ -394,7 +461,7 @@ bt_self_component_port_input_notification_iterator_create( (void *) upstream_comp_cls; init_method = - (init_method_t) src_comp_cls->methods.notif_iter_init; + (init_method_t) src_comp_cls->methods.msg_iter_init; break; } case BT_COMPONENT_CLASS_TYPE_FILTER: @@ -403,7 +470,7 @@ bt_self_component_port_input_notification_iterator_create( (void *) upstream_comp_cls; init_method = - (init_method_t) flt_comp_cls->methods.notif_iter_init; + (init_method_t) flt_comp_cls->methods.msg_iter_init; break; } default: @@ -418,16 +485,18 @@ bt_self_component_port_input_notification_iterator_create( iter_status = init_method(iterator, upstream_comp, upstream_port); BT_LOGD("User method returned: status=%s", - bt_notification_iterator_status_string(iter_status)); - if (iter_status != BT_NOTIFICATION_ITERATOR_STATUS_OK) { + bt_message_iterator_status_string(iter_status)); + if (iter_status != BT_MESSAGE_ITERATOR_STATUS_OK) { BT_LOGW_STR("Initialization method failed."); + BT_OBJECT_PUT_REF_AND_RESET(iterator); goto end; } } - iterator->state = BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ACTIVE; + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); g_ptr_array_add(port->connection->iterators, iterator); - BT_LIB_LOGD("Created notification iterator on self component input port: " + BT_LIB_LOGD("Created message iterator on self component input port: " "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i", upstream_port, upstream_comp, iterator); @@ -435,391 +504,95 @@ end: return iterator; } -void *bt_self_notification_iterator_get_data( - const struct bt_self_notification_iterator *self_iterator) +void *bt_self_message_iterator_get_data( + const struct bt_self_message_iterator *self_iterator) { - struct bt_self_component_port_input_notification_iterator *iterator = + struct bt_self_component_port_input_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); return iterator->user_data; } -void bt_self_notification_iterator_set_data( - struct bt_self_notification_iterator *self_iterator, void *data) +void bt_self_message_iterator_set_data( + struct bt_self_message_iterator *self_iterator, void *data) { - struct bt_self_component_port_input_notification_iterator *iterator = + struct bt_self_component_port_input_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); iterator->user_data = data; - BT_LIB_LOGV("Set notification iterator's user data: " + BT_LIB_LOGV("Set message iterator's user data: " "%!+i, user-data-addr=%p", iterator, data); } -BT_ASSERT_PRE_FUNC -static inline -void bt_notification_borrow_packet_stream(const struct bt_notification *notif, - const struct bt_stream **stream, - const struct bt_packet **packet) -{ - BT_ASSERT(notif); - - switch (notif->type) { - case BT_NOTIFICATION_TYPE_EVENT: - *packet = bt_event_borrow_packet_const( - bt_notification_event_borrow_event_const(notif)); - *stream = bt_packet_borrow_stream_const(*packet); - break; - case BT_NOTIFICATION_TYPE_STREAM_BEGIN: - *stream = bt_notification_stream_begin_borrow_stream_const(notif); - break; - case BT_NOTIFICATION_TYPE_STREAM_END: - *stream = bt_notification_stream_end_borrow_stream_const(notif); - break; - case BT_NOTIFICATION_TYPE_PACKET_BEGIN: - *packet = bt_notification_packet_begin_borrow_packet_const(notif); - *stream = bt_packet_borrow_stream_const(*packet); - break; - case BT_NOTIFICATION_TYPE_PACKET_END: - *packet = bt_notification_packet_end_borrow_packet_const(notif); - *stream = bt_packet_borrow_stream_const(*packet); - break; - default: - break; - } -} - -BT_ASSERT_PRE_FUNC -static inline -bool validate_notification( - struct bt_self_component_port_input_notification_iterator *iterator, - const struct bt_notification *c_notif) -{ - bool is_valid = true; - struct stream_state *stream_state; - const struct bt_stream *stream = NULL; - const struct bt_packet *packet = NULL; - struct bt_notification *notif = (void *) c_notif; - - BT_ASSERT(notif); - bt_notification_borrow_packet_stream(c_notif, &stream, &packet); - - if (!stream) { - /* we don't care about notifications not attached to streams */ - goto end; - } - - stream_state = g_hash_table_lookup(iterator->stream_states, stream); - if (!stream_state) { - /* - * No stream state for this stream: this notification - * MUST be a BT_NOTIFICATION_TYPE_STREAM_BEGIN notification - * and its sequence number must be 0. - */ - if (c_notif->type != BT_NOTIFICATION_TYPE_STREAM_BEGIN) { - BT_ASSERT_PRE_MSG("Unexpected notification: missing a " - "BT_NOTIFICATION_TYPE_STREAM_BEGIN " - "notification prior to this notification: " - "%![stream-]+s", stream); - is_valid = false; - goto end; - } - - if (c_notif->seq_num == -1ULL) { - notif->seq_num = 0; - } - - if (c_notif->seq_num != 0) { - BT_ASSERT_PRE_MSG("Unexpected notification sequence " - "number for this notification iterator: " - "this is the first notification for this " - "stream, expecting sequence number 0: " - "seq-num=%" PRIu64 ", %![stream-]+s", - c_notif->seq_num, stream); - is_valid = false; - goto end; - } - - stream_state = create_stream_state(stream); - if (!stream_state) { - abort(); - } - - g_hash_table_insert(iterator->stream_states, - (void *) stream, stream_state); - stream_state->expected_notif_seq_num++; - goto end; - } - - if (stream_state->is_ended) { - /* - * There's a new notification which has a reference to a - * stream which, from this iterator's point of view, is - * ended ("end of stream" notification was returned). - * This is bad: the API guarantees that it can never - * happen. - */ - BT_ASSERT_PRE_MSG("Stream is already ended: %![stream-]+s", - stream); - is_valid = false; - goto end; - } - - if (c_notif->seq_num == -1ULL) { - notif->seq_num = stream_state->expected_notif_seq_num; - } - - if (c_notif->seq_num != -1ULL && - c_notif->seq_num != stream_state->expected_notif_seq_num) { - BT_ASSERT_PRE_MSG("Unexpected notification sequence number: " - "seq-num=%" PRIu64 ", " - "expected-seq-num=%" PRIu64 ", %![stream-]+s", - c_notif->seq_num, stream_state->expected_notif_seq_num, - stream); - is_valid = false; - goto end; - } - - switch (c_notif->type) { - case BT_NOTIFICATION_TYPE_STREAM_BEGIN: - BT_ASSERT_PRE_MSG("Unexpected BT_NOTIFICATION_TYPE_STREAM_BEGIN " - "notification at this point: notif-seq-num=%" PRIu64 ", " - "%![stream-]+s", c_notif->seq_num, stream); - is_valid = false; - goto end; - case BT_NOTIFICATION_TYPE_STREAM_END: - if (stream_state->cur_packet) { - BT_ASSERT_PRE_MSG("Unexpected BT_NOTIFICATION_TYPE_STREAM_END " - "notification: missing a " - "BT_NOTIFICATION_TYPE_PACKET_END notification " - "prior to this notification: " - "notif-seq-num=%" PRIu64 ", " - "%![stream-]+s", c_notif->seq_num, stream); - is_valid = false; - goto end; - } - stream_state->expected_notif_seq_num++; - stream_state->is_ended = true; - goto end; - case BT_NOTIFICATION_TYPE_PACKET_BEGIN: - if (stream_state->cur_packet) { - BT_ASSERT_PRE_MSG("Unexpected BT_NOTIFICATION_TYPE_PACKET_BEGIN " - "notification at this point: missing a " - "BT_NOTIFICATION_TYPE_PACKET_END notification " - "prior to this notification: " - "notif-seq-num=%" PRIu64 ", %![stream-]+s, " - "%![packet-]+a", c_notif->seq_num, stream, - packet); - is_valid = false; - goto end; - } - stream_state->expected_notif_seq_num++; - stream_state->cur_packet = packet; - bt_object_get_no_null_check(stream_state->cur_packet); - goto end; - case BT_NOTIFICATION_TYPE_PACKET_END: - if (!stream_state->cur_packet) { - BT_ASSERT_PRE_MSG("Unexpected BT_NOTIFICATION_TYPE_PACKET_END " - "notification at this point: missing a " - "BT_NOTIFICATION_TYPE_PACKET_BEGIN notification " - "prior to this notification: " - "notif-seq-num=%" PRIu64 ", %![stream-]+s, " - "%![packet-]+a", c_notif->seq_num, stream, - packet); - is_valid = false; - goto end; - } - stream_state->expected_notif_seq_num++; - BT_OBJECT_PUT_REF_AND_RESET(stream_state->cur_packet); - goto end; - case BT_NOTIFICATION_TYPE_EVENT: - if (packet != stream_state->cur_packet) { - BT_ASSERT_PRE_MSG("Unexpected packet for " - "BT_NOTIFICATION_TYPE_EVENT notification: " - "notif-seq-num=%" PRIu64 ", %![stream-]+s, " - "%![notif-packet-]+a, %![expected-packet-]+a", - c_notif->seq_num, stream, - stream_state->cur_packet, packet); - is_valid = false; - goto end; - } - stream_state->expected_notif_seq_num++; - goto end; - default: - break; - } - -end: - return is_valid; -} - -BT_ASSERT_PRE_FUNC -static inline -bool validate_notifications( - struct bt_self_component_port_input_notification_iterator *iterator, - uint64_t count) +enum bt_message_iterator_status +bt_self_component_port_input_message_iterator_next( + struct bt_self_component_port_input_message_iterator *iterator, + bt_message_array_const *msgs, uint64_t *user_count) { - bool ret = true; - bt_notification_array_const notifs = - (void *) iterator->base.notifs->pdata; - uint64_t i; + int status = BT_MESSAGE_ITERATOR_STATUS_OK; - for (i = 0; i < count; i++) { - ret = validate_notification(iterator, notifs[i]); - if (!ret) { - break; - } - } - - return ret; -} - -BT_ASSERT_PRE_FUNC -static inline bool self_comp_port_input_notif_iter_can_end( - struct bt_self_component_port_input_notification_iterator *iterator) -{ - GHashTableIter iter; - gpointer stream_key, state_value; - bool ret = true; - - /* - * Verify that this iterator received a - * BT_NOTIFICATION_TYPE_STREAM_END notification for each stream - * which has a state. - */ - - g_hash_table_iter_init(&iter, iterator->stream_states); - - while (g_hash_table_iter_next(&iter, &stream_key, &state_value)) { - struct stream_state *stream_state = (void *) state_value; - - BT_ASSERT(stream_state); - BT_ASSERT(stream_key); - - if (!stream_state->is_ended) { - BT_ASSERT_PRE_MSG("Ending notification iterator, " - "but stream is not ended: " - "%![stream-]s", stream_key); - ret = false; - goto end; - } - } - -end: - return ret; -} - -enum bt_notification_iterator_status -bt_self_component_port_input_notification_iterator_next( - struct bt_self_component_port_input_notification_iterator *iterator, - bt_notification_array_const *notifs, uint64_t *user_count) -{ - typedef enum bt_self_notification_iterator_status (*method_t)( - void *, bt_notification_array_const, uint64_t, uint64_t *); - - method_t method = NULL; - struct bt_component_class *comp_cls; - int status = BT_NOTIFICATION_ITERATOR_STATUS_OK; - - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); - BT_ASSERT_PRE_NON_NULL(notifs, "Notification array (output)"); - BT_ASSERT_PRE_NON_NULL(user_count, "Notification count (output)"); + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NON_NULL(msgs, "Message array (output)"); + BT_ASSERT_PRE_NON_NULL(user_count, "Message count (output)"); BT_ASSERT_PRE(iterator->state == - BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ACTIVE, - "Notification iterator's \"next\" called, but " - "iterator is in the wrong state: %!+i", iterator); + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE, + "Message iterator's \"next\" called, but " + "message iterator is in the wrong state: %!+i", iterator); BT_ASSERT(iterator->upstream_component); BT_ASSERT(iterator->upstream_component->class); + BT_ASSERT_PRE( + 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_LIB_LOGD("Getting next self component input port " - "notification iterator's notifications: %!+i", iterator); - comp_cls = iterator->upstream_component->class; - - /* Pick the appropriate "next" method */ - switch (comp_cls->type) { - case BT_COMPONENT_CLASS_TYPE_SOURCE: - { - struct bt_component_class_source *src_comp_cls = - (void *) comp_cls; - - method = (method_t) src_comp_cls->methods.notif_iter_next; - break; - } - case BT_COMPONENT_CLASS_TYPE_FILTER: - { - struct bt_component_class_filter *flt_comp_cls = - (void *) comp_cls; - - method = (method_t) flt_comp_cls->methods.notif_iter_next; - break; - } - default: - abort(); - } + "message iterator's messages: %!+i", iterator); /* - * Call the user's "next" method to get the next notifications + * Call the user's "next" method to get the next messages * and status. */ - BT_ASSERT(method); + BT_ASSERT(iterator->methods.next); BT_LOGD_STR("Calling user's \"next\" method."); - status = method(iterator, - (void *) iterator->base.notifs->pdata, - NOTIF_BATCH_SIZE, user_count); + status = iterator->methods.next(iterator, + (void *) iterator->base.msgs->pdata, MSG_BATCH_SIZE, + user_count); BT_LOGD("User method returned: status=%s", - bt_notification_iterator_status_string(status)); + bt_message_iterator_status_string(status)); if (status < 0) { BT_LOGW_STR("User method failed."); goto end; } - if (iterator->state == BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED || - iterator->state == BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED) { - /* - * The user's "next" method, somehow, cancelled its own - * notification iterator. This can happen, for example, - * when the user's method removes the port on which - * there's the connection from which the iterator was - * created. In this case, said connection is ended, and - * all its notification iterators are finalized. - * - * Only bt_object_put_ref() the returned notification if - * the status is BT_NOTIFICATION_ITERATOR_STATUS_OK - * because otherwise this field could be garbage. - */ - if (status == BT_NOTIFICATION_ITERATOR_STATUS_OK) { - uint64_t i; - bt_notification_array_const notifs = - (void *) iterator->base.notifs->pdata; - - for (i = 0; i < *user_count; i++) { - bt_object_put_ref(notifs[i]); - } - } - - status = BT_NOTIFICATION_ITERATOR_STATUS_CANCELED; - goto end; - } +#ifdef BT_DEV_MODE + /* + * There is no way that this iterator could have been finalized + * during its "next" method, as the only way to do this is to + * put the last iterator's reference, and this can only be done + * by its downstream owner. + * + * For the same reason, there is no way that this iterator could + * have seeked (cannot seek a self message iterator). + */ + BT_ASSERT(iterator->state == + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); +#endif switch (status) { - case BT_NOTIFICATION_ITERATOR_STATUS_OK: - BT_ASSERT_PRE(validate_notifications(iterator, *user_count), - "Notifications are invalid at this point: " - "%![notif-iter-]+i, count=%" PRIu64, - iterator, *user_count); - *notifs = (void *) iterator->base.notifs->pdata; + case BT_MESSAGE_ITERATOR_STATUS_OK: + BT_ASSERT_PRE(*user_count <= MSG_BATCH_SIZE, + "Invalid returned message count: greater than " + "batch size: count=%" PRIu64 ", batch-size=%u", + *user_count, MSG_BATCH_SIZE); + *msgs = (void *) iterator->base.msgs->pdata; break; - case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN: + case BT_MESSAGE_ITERATOR_STATUS_AGAIN: goto end; - case BT_NOTIFICATION_ITERATOR_STATUS_END: - BT_ASSERT_PRE(self_comp_port_input_notif_iter_can_end(iterator), - "Notification iterator cannot end at this point: " - "%!+i", iterator); - BT_ASSERT(iterator->state == - BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ACTIVE); - iterator->state = BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ENDED; - BT_LOGD("Set new status: status=%s", - bt_notification_iterator_status_string(status)); + case BT_MESSAGE_ITERATOR_STATUS_END: + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED); goto end; default: /* Unknown non-error status */ @@ -830,21 +603,19 @@ end: return status; } -enum bt_notification_iterator_status -bt_port_output_notification_iterator_next( - struct bt_port_output_notification_iterator *iterator, - bt_notification_array_const *notifs_to_user, +enum bt_message_iterator_status bt_port_output_message_iterator_next( + struct bt_port_output_message_iterator *iterator, + bt_message_array_const *msgs_to_user, uint64_t *count_to_user) { - enum bt_notification_iterator_status status; + enum bt_message_iterator_status status; enum bt_graph_status graph_status; - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); - BT_ASSERT_PRE_NON_NULL(notifs_to_user, "Notification array (output)"); - BT_ASSERT_PRE_NON_NULL(count_to_user, "Notification count (output)"); - BT_LIB_LOGD("Getting next output port notification iterator's notifications: " + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NON_NULL(msgs_to_user, "Message array (output)"); + BT_ASSERT_PRE_NON_NULL(count_to_user, "Message count (output)"); + BT_LIB_LOGD("Getting next output port message iterator's messages: " "%!+i", iterator); - graph_status = bt_graph_consume_sink_no_check(iterator->graph, iterator->colander); switch (graph_status) { @@ -855,71 +626,79 @@ bt_port_output_notification_iterator_next( status = (int) graph_status; break; case BT_GRAPH_STATUS_OK: - status = BT_NOTIFICATION_ITERATOR_STATUS_OK; + status = BT_MESSAGE_ITERATOR_STATUS_OK; /* - * On success, the colander sink moves the notifications + * On success, the colander sink moves the messages * to this iterator's array and sets this iterator's - * notification count: move them to the user. + * message count: move them to the user. */ - *notifs_to_user = (void *) iterator->base.notifs->pdata; + *msgs_to_user = (void *) iterator->base.msgs->pdata; *count_to_user = iterator->count; break; default: /* Other errors */ - status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR; + status = BT_MESSAGE_ITERATOR_STATUS_ERROR; } return status; } -struct bt_component *bt_self_component_port_input_notification_iterator_borrow_component( - struct bt_self_component_port_input_notification_iterator *iterator) +struct bt_component * +bt_self_component_port_input_message_iterator_borrow_component( + struct bt_self_component_port_input_message_iterator *iterator) { - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); return iterator->upstream_component; } -struct bt_self_component *bt_self_notification_iterator_borrow_component( - struct bt_self_notification_iterator *self_iterator) +const struct bt_component * +bt_self_component_port_input_message_iterator_borrow_component_const( + const struct bt_self_component_port_input_message_iterator *iterator) { - struct bt_self_component_port_input_notification_iterator *iterator = + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + return iterator->upstream_component; +} + +struct bt_self_component *bt_self_message_iterator_borrow_component( + struct bt_self_message_iterator *self_iterator) +{ + struct bt_self_component_port_input_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); return (void *) iterator->upstream_component; } -struct bt_self_port_output *bt_self_notification_iterator_borrow_port( - struct bt_self_notification_iterator *self_iterator) +struct bt_self_port_output *bt_self_message_iterator_borrow_port( + struct bt_self_message_iterator *self_iterator) { - struct bt_self_component_port_input_notification_iterator *iterator = + struct bt_self_component_port_input_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Notification iterator"); + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); return (void *) iterator->upstream_port; } static -void bt_port_output_notification_iterator_destroy(struct bt_object *obj) +void bt_port_output_message_iterator_destroy(struct bt_object *obj) { - struct bt_port_output_notification_iterator *iterator = (void *) obj; + struct bt_port_output_message_iterator *iterator = (void *) obj; - BT_LIB_LOGD("Destroying output port notification iterator object: %!+i", + BT_LIB_LOGD("Destroying output port message iterator object: %!+i", iterator); BT_LOGD_STR("Putting graph."); BT_OBJECT_PUT_REF_AND_RESET(iterator->graph); BT_LOGD_STR("Putting colander sink component."); BT_OBJECT_PUT_REF_AND_RESET(iterator->colander); - destroy_base_notification_iterator(obj); + destroy_base_message_iterator(obj); } -struct bt_port_output_notification_iterator * -bt_port_output_notification_iterator_create( - struct bt_graph *graph, +struct bt_port_output_message_iterator * +bt_port_output_message_iterator_create(struct bt_graph *graph, const struct bt_port_output *output_port) { - struct bt_port_output_notification_iterator *iterator = NULL; + struct bt_port_output_message_iterator *iterator = NULL; struct bt_component_class_sink *colander_comp_cls = NULL; struct bt_component *output_port_comp = NULL; struct bt_component_sink *colander_comp; @@ -938,21 +717,23 @@ bt_port_output_notification_iterator_create( (void *) graph, "Output port is not part of graph: %![graph-]+g, %![port-]+p", graph, output_port); + BT_ASSERT_PRE(!graph->has_sink, + "Graph already has a sink component: %![graph-]+g"); - /* Create notification iterator */ - BT_LIB_LOGD("Creating notification iterator on output port: " + /* Create message iterator */ + BT_LIB_LOGD("Creating message iterator on output port: " "%![port-]+p, %![comp-]+c", output_port, output_port_comp); - iterator = g_new0(struct bt_port_output_notification_iterator, 1); + iterator = g_new0(struct bt_port_output_message_iterator, 1); if (!iterator) { - BT_LOGE_STR("Failed to allocate one output port notification iterator."); + BT_LOGE_STR("Failed to allocate one output port message iterator."); goto error; } - ret = init_notification_iterator((void *) iterator, - BT_NOTIFICATION_ITERATOR_TYPE_PORT_OUTPUT, - bt_port_output_notification_iterator_destroy); + ret = init_message_iterator((void *) iterator, + BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT, + bt_port_output_message_iterator_destroy); if (ret) { - /* init_notification_iterator() logs errors */ + /* init_message_iterator() logs errors */ BT_OBJECT_PUT_REF_AND_RESET(iterator); goto end; } @@ -966,7 +747,7 @@ bt_port_output_notification_iterator_create( iterator->graph = graph; bt_object_get_no_null_check(iterator->graph); - colander_data.notifs = (void *) iterator->base.notifs->pdata; + colander_data.msgs = (void *) iterator->base.msgs->pdata; colander_data.count_addr = &iterator->count; /* Hope that nobody uses this very unique name */ @@ -1002,13 +783,19 @@ bt_port_output_notification_iterator_create( /* * At this point everything went fine. Make the graph - * nonconsumable forever so that only this notification iterator + * nonconsumable forever so that only this message iterator * can consume (thanks to bt_graph_consume_sink_no_check()). - * This avoids leaking the notification created by the colander - * sink and moved to the notification iterator's notification + * This avoids leaking the message created by the colander + * sink and moved to the message iterator's message * member. */ bt_graph_set_can_consume(iterator->graph, false); + + /* + * Also set the graph as being configured: it has no active sink + * anyway, so we don't need to call bt_graph_configure(). + */ + graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED; goto end; error: @@ -1041,3 +828,658 @@ end: bt_object_put_ref(colander_comp_cls); return (void *) iterator; } + +bt_bool bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( + struct bt_self_component_port_input_message_iterator *iterator, + int64_t ns_from_origin) +{ + bt_bool can = BT_FALSE; + + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); + BT_ASSERT_PRE( + 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)); + + if (iterator->methods.can_seek_ns_from_origin) { + can = iterator->methods.can_seek_ns_from_origin(iterator, + ns_from_origin); + goto end; + } + + /* + * Automatic seeking fall back: if we can seek to the beginning, + * then we can automatically seek to any message. + */ + if (iterator->methods.can_seek_beginning) { + can = iterator->methods.can_seek_beginning(iterator); + } + +end: + return can; +} + +bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning( + struct bt_self_component_port_input_message_iterator *iterator) +{ + bt_bool can = BT_FALSE; + + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); + BT_ASSERT_PRE( + 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)); + + if (iterator->methods.can_seek_beginning) { + can = iterator->methods.can_seek_beginning(iterator); + } + + return can; +} + +static inline +void _set_iterator_state_after_seeking( + struct bt_self_component_port_input_message_iterator *iterator, + enum bt_message_iterator_status status) +{ + enum bt_self_component_port_input_message_iterator_state new_state = 0; + + /* Set iterator's state depending on seeking status */ + switch (status) { + case BT_MESSAGE_ITERATOR_STATUS_OK: + new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE; + break; + case BT_MESSAGE_ITERATOR_STATUS_AGAIN: + new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN; + break; + case BT_MESSAGE_ITERATOR_STATUS_ERROR: + case BT_MESSAGE_ITERATOR_STATUS_NOMEM: + new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR; + break; + case BT_MESSAGE_ITERATOR_STATUS_END: + new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED; + break; + default: + abort(); + } + + set_self_comp_port_input_msg_iterator_state(iterator, new_state); +} + +#ifdef BT_DEV_MODE +# define set_iterator_state_after_seeking _set_iterator_state_after_seeking +#else +# define set_iterator_state_after_seeking(_iter, _status) ((void) _iter); ((void) _status); +#endif + +enum bt_message_iterator_status +bt_self_component_port_input_message_iterator_seek_beginning( + struct bt_self_component_port_input_message_iterator *iterator) +{ + int status; + + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); + BT_ASSERT_PRE( + 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( + bt_self_component_port_input_message_iterator_can_seek_beginning( + iterator), + "Message iterator cannot seek beginning: %!+i", iterator); + BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator); + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING); + status = iterator->methods.seek_beginning(iterator); + BT_LOGD("User method returned: status=%s", + bt_message_iterator_status_string(status)); + BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK || + status == BT_MESSAGE_ITERATOR_STATUS_ERROR || + status == BT_MESSAGE_ITERATOR_STATUS_NOMEM || + status == BT_MESSAGE_ITERATOR_STATUS_AGAIN, + "Unexpected status: %![iter-]+i, status=%s", + iterator, bt_common_self_message_iterator_status_string(status)); + set_iterator_state_after_seeking(iterator, status); + return status; +} + +static inline +enum bt_message_iterator_status auto_seek_handle_message( + struct bt_self_component_port_input_message_iterator *iterator, + int64_t ns_from_origin, const struct bt_message *msg, + bool *got_first) +{ + enum bt_message_iterator_status status = BT_MESSAGE_ITERATOR_STATUS_OK; + int64_t msg_ns_from_origin; + const struct bt_clock_snapshot *clk_snapshot = NULL; + int ret; + + BT_ASSERT(msg); + BT_ASSERT(got_first); + + switch (msg->type) { + case BT_MESSAGE_TYPE_EVENT: + { + const struct bt_message_event *event_msg = + (const void *) msg; + + clk_snapshot = event_msg->default_cs; + BT_ASSERT_PRE(clk_snapshot, + "Event message has no default clock snapshot: %!+n", + event_msg); + break; + } + case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: + { + const struct bt_message_message_iterator_inactivity *inactivity_msg = + (const void *) msg; + + clk_snapshot = inactivity_msg->default_cs; + BT_ASSERT(clk_snapshot); + break; + } + case BT_MESSAGE_TYPE_PACKET_BEGINNING: + case BT_MESSAGE_TYPE_PACKET_END: + { + const struct bt_message_packet *packet_msg = + (const void *) msg; + + clk_snapshot = packet_msg->default_cs; + BT_ASSERT_PRE(clk_snapshot, + "Packet message has no default clock snapshot: %!+n", + packet_msg); + break; + } + case BT_MESSAGE_TYPE_DISCARDED_EVENTS: + case BT_MESSAGE_TYPE_DISCARDED_PACKETS: + { + struct bt_message_discarded_items *msg_disc_items = + (void *) msg; + + BT_ASSERT_PRE(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( + msg_disc_items->default_begin_cs, + &msg_ns_from_origin); + if (ret) { + status = BT_MESSAGE_ITERATOR_STATUS_ERROR; + goto end; + } + + if (msg_ns_from_origin >= ns_from_origin) { + *got_first = true; + goto push_msg; + } + + ret = bt_clock_snapshot_get_ns_from_origin( + msg_disc_items->default_end_cs, + &msg_ns_from_origin); + if (ret) { + status = BT_MESSAGE_ITERATOR_STATUS_ERROR; + goto end; + } + + if (msg_ns_from_origin >= ns_from_origin) { + /* + * The discarded items message's beginning time + * is before the requested seeking time, but its + * end time is after. Modify the message so as + * to set its beginning time to the requested + * seeking time, and make its item count unknown + * as we don't know if items were really + * discarded within the new time range. + */ + uint64_t new_begin_raw_value; + + ret = bt_clock_class_clock_value_from_ns_from_origin( + msg_disc_items->default_end_cs->clock_class, + ns_from_origin, &new_begin_raw_value); + if (ret) { + status = BT_MESSAGE_ITERATOR_STATUS_ERROR; + goto end; + } + + bt_clock_snapshot_set_raw_value( + msg_disc_items->default_begin_cs, + new_begin_raw_value); + msg_disc_items->count.base.avail = + BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE; + + /* + * It is safe to push it because its beginning + * time is exactly the requested seeking time. + */ + goto push_msg; + } else { + goto skip_msg; + } + } + case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: + { + const struct bt_message_stream_activity *stream_act_msg = + (const void *) msg; + + switch (stream_act_msg->default_cs_state) { + case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN: + case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE: + /* + * -inf is always less than any requested time, + * and we can't assume any specific time for an + * unknown clock snapshot, so skip this. + */ + goto skip_msg; + case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN: + clk_snapshot = stream_act_msg->default_cs; + BT_ASSERT(clk_snapshot); + break; + default: + abort(); + } + + break; + } + case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: + { + const struct bt_message_stream_activity *stream_act_msg = + (const void *) msg; + + switch (stream_act_msg->default_cs_state) { + case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN: + /* + * We can't assume any specific time for an + * unknown clock snapshot, so skip this. + */ + goto skip_msg; + case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE: + /* + * +inf is always greater than any requested + * time. + */ + *got_first = true; + goto push_msg; + case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN: + clk_snapshot = stream_act_msg->default_cs; + BT_ASSERT(clk_snapshot); + break; + default: + abort(); + } + + break; + } + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + case BT_MESSAGE_TYPE_STREAM_END: + /* Ignore */ + goto skip_msg; + default: + abort(); + } + + BT_ASSERT(clk_snapshot); + ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot, + &msg_ns_from_origin); + if (ret) { + status = BT_MESSAGE_ITERATOR_STATUS_ERROR; + goto end; + } + + if (msg_ns_from_origin >= ns_from_origin) { + *got_first = true; + goto push_msg; + } + +skip_msg: + bt_object_put_no_null_check(msg); + msg = NULL; + goto end; + +push_msg: + g_queue_push_head(iterator->auto_seek_msgs, (void *) msg); + msg = NULL; + +end: + BT_ASSERT(!msg || status != BT_MESSAGE_ITERATOR_STATUS_OK); + return status; +} + +static +enum bt_message_iterator_status find_message_ge_ns_from_origin( + struct bt_self_component_port_input_message_iterator *iterator, + int64_t ns_from_origin) +{ + int status; + enum bt_self_component_port_input_message_iterator_state init_state = + iterator->state; + const struct bt_message *messages[MSG_BATCH_SIZE]; + uint64_t user_count = 0; + uint64_t i; + bool got_first = false; + + BT_ASSERT(iterator); + memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE); + + /* + * Make this iterator temporarily active (not seeking) to call + * the "next" method. + */ + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); + + BT_ASSERT(iterator->methods.next); + + while (!got_first) { + /* + * Call the user's "next" method to get the next + * messages and status. + */ + BT_LOGD_STR("Calling user's \"next\" method."); + status = iterator->methods.next(iterator, + &messages[0], MSG_BATCH_SIZE, &user_count); + BT_LOGD("User method returned: status=%s", + bt_message_iterator_status_string(status)); + +#ifdef BT_DEV_MODE + /* + * The user's "next" method must not do any action which + * would change the iterator's state. + */ + BT_ASSERT(iterator->state == + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); +#endif + + switch (status) { + case BT_MESSAGE_ITERATOR_STATUS_OK: + BT_ASSERT_PRE(user_count <= MSG_BATCH_SIZE, + "Invalid returned message count: greater than " + "batch size: count=%" PRIu64 ", batch-size=%u", + user_count, MSG_BATCH_SIZE); + break; + case BT_MESSAGE_ITERATOR_STATUS_AGAIN: + case BT_MESSAGE_ITERATOR_STATUS_ERROR: + case BT_MESSAGE_ITERATOR_STATUS_NOMEM: + case BT_MESSAGE_ITERATOR_STATUS_END: + goto end; + default: + abort(); + } + + for (i = 0; i < user_count; i++) { + if (got_first) { + g_queue_push_head(iterator->auto_seek_msgs, + (void *) messages[i]); + messages[i] = NULL; + continue; + } + + status = auto_seek_handle_message(iterator, + ns_from_origin, messages[i], &got_first); + if (status == BT_MESSAGE_ITERATOR_STATUS_OK) { + /* Message was either pushed or moved */ + messages[i] = NULL; + } else { + goto end; + } + } + } + +end: + for (i = 0; i < user_count; i++) { + if (messages[i]) { + bt_object_put_no_null_check(messages[i]); + } + } + + set_self_comp_port_input_msg_iterator_state(iterator, init_state); + return status; +} + +static +enum bt_self_message_iterator_status post_auto_seek_next( + struct bt_self_component_port_input_message_iterator *iterator, + bt_message_array_const msgs, uint64_t capacity, + uint64_t *count) +{ + BT_ASSERT(!g_queue_is_empty(iterator->auto_seek_msgs)); + *count = 0; + + /* + * Move auto-seek messages to the output array (which is this + * iterator's base message array). + */ + while (capacity > 0 && !g_queue_is_empty(iterator->auto_seek_msgs)) { + msgs[*count] = g_queue_pop_tail(iterator->auto_seek_msgs); + capacity--; + (*count)++; + } + + BT_ASSERT(*count > 0); + + if (g_queue_is_empty(iterator->auto_seek_msgs)) { + /* No more auto-seek messages */ + switch (iterator->upstream_component->class->type) { + case BT_COMPONENT_CLASS_TYPE_SOURCE: + { + struct bt_component_class_source *src_comp_cls = + (void *) iterator->upstream_component->class; + + iterator->methods.next = + (bt_self_component_port_input_message_iterator_next_method) + src_comp_cls->methods.msg_iter_next; + break; + } + case BT_COMPONENT_CLASS_TYPE_FILTER: + { + struct bt_component_class_filter *flt_comp_cls = + (void *) iterator->upstream_component->class; + + iterator->methods.next = + (bt_self_component_port_input_message_iterator_next_method) + flt_comp_cls->methods.msg_iter_next; + break; + } + default: + abort(); + } + } + + return BT_SELF_MESSAGE_ITERATOR_STATUS_OK; +} + +enum bt_message_iterator_status +bt_self_component_port_input_message_iterator_seek_ns_from_origin( + struct bt_self_component_port_input_message_iterator *iterator, + int64_t ns_from_origin) +{ + int status; + + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); + BT_ASSERT_PRE( + 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( + bt_self_component_port_input_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); + set_self_comp_port_input_msg_iterator_state(iterator, + BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING); + + if (iterator->methods.seek_ns_from_origin) { + 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, + ns_from_origin); + BT_LOGD("User method returned: status=%s", + bt_message_iterator_status_string(status)); + BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK || + status == BT_MESSAGE_ITERATOR_STATUS_ERROR || + status == BT_MESSAGE_ITERATOR_STATUS_NOMEM || + status == BT_MESSAGE_ITERATOR_STATUS_AGAIN, + "Unexpected status: %![iter-]+i, status=%s", + iterator, + bt_common_self_message_iterator_status_string(status)); + } else { + /* Start automatic seeking: seek beginning first */ + BT_ASSERT(iterator->methods.can_seek_beginning(iterator)); + BT_ASSERT(iterator->methods.seek_beginning); + BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", + iterator); + status = iterator->methods.seek_beginning(iterator); + BT_LOGD("User method returned: status=%s", + bt_message_iterator_status_string(status)); + BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK || + status == BT_MESSAGE_ITERATOR_STATUS_ERROR || + status == BT_MESSAGE_ITERATOR_STATUS_NOMEM || + status == BT_MESSAGE_ITERATOR_STATUS_AGAIN, + "Unexpected status: %![iter-]+i, status=%s", + iterator, + bt_common_self_message_iterator_status_string(status)); + switch (status) { + case BT_MESSAGE_ITERATOR_STATUS_OK: + break; + case BT_MESSAGE_ITERATOR_STATUS_ERROR: + case BT_MESSAGE_ITERATOR_STATUS_NOMEM: + case BT_MESSAGE_ITERATOR_STATUS_AGAIN: + goto end; + default: + abort(); + } + + /* + * Find the first message which has a default clock + * snapshot greater than or equal to the requested + * seeking time, and move the received messages from + * this point in the batch to this iterator's auto-seek + * message queue. + */ + while (!g_queue_is_empty(iterator->auto_seek_msgs)) { + bt_object_put_no_null_check( + g_queue_pop_tail(iterator->auto_seek_msgs)); + } + + status = find_message_ge_ns_from_origin(iterator, + ns_from_origin); + switch (status) { + case BT_MESSAGE_ITERATOR_STATUS_OK: + case BT_MESSAGE_ITERATOR_STATUS_END: + /* + * If there are messages in the auto-seek + * message queue, replace the user's "next" + * method with a custom, temporary "next" method + * which returns them. + */ + if (!g_queue_is_empty(iterator->auto_seek_msgs)) { + iterator->methods.next = + (bt_self_component_port_input_message_iterator_next_method) + post_auto_seek_next; + } + + /* + * `BT_MESSAGE_ITERATOR_STATUS_END` becomes + * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next + * time this iterator's "next" method is called, + * it will return + * `BT_MESSAGE_ITERATOR_STATUS_END`. + */ + status = BT_MESSAGE_ITERATOR_STATUS_OK; + break; + case BT_MESSAGE_ITERATOR_STATUS_ERROR: + case BT_MESSAGE_ITERATOR_STATUS_NOMEM: + case BT_MESSAGE_ITERATOR_STATUS_AGAIN: + goto end; + default: + abort(); + } + } + +end: + set_iterator_state_after_seeking(iterator, status); + return status; +} + +static inline +bt_self_component_port_input_message_iterator * +borrow_output_port_message_iterator_upstream_iterator( + struct bt_port_output_message_iterator *iterator) +{ + struct bt_component_class_sink_colander_priv_data *colander_data; + + BT_ASSERT(iterator); + colander_data = (void *) iterator->colander->parent.user_data; + BT_ASSERT(colander_data); + BT_ASSERT(colander_data->msg_iter); + return colander_data->msg_iter; +} + +bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin( + struct bt_port_output_message_iterator *iterator, + int64_t ns_from_origin) +{ + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( + borrow_output_port_message_iterator_upstream_iterator( + iterator), ns_from_origin); +} + +bt_bool bt_port_output_message_iterator_can_seek_beginning( + struct bt_port_output_message_iterator *iterator) +{ + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + return bt_self_component_port_input_message_iterator_can_seek_beginning( + borrow_output_port_message_iterator_upstream_iterator( + iterator)); +} + +enum bt_message_iterator_status bt_port_output_message_iterator_seek_ns_from_origin( + struct bt_port_output_message_iterator *iterator, + int64_t ns_from_origin) +{ + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + return bt_self_component_port_input_message_iterator_seek_ns_from_origin( + borrow_output_port_message_iterator_upstream_iterator(iterator), + ns_from_origin); +} + +enum bt_message_iterator_status bt_port_output_message_iterator_seek_beginning( + struct bt_port_output_message_iterator *iterator) +{ + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + return bt_self_component_port_input_message_iterator_seek_beginning( + borrow_output_port_message_iterator_upstream_iterator( + iterator)); +} + +void bt_port_output_message_iterator_get_ref( + const struct bt_port_output_message_iterator *iterator) +{ + bt_object_get_ref(iterator); +} + +void bt_port_output_message_iterator_put_ref( + const struct bt_port_output_message_iterator *iterator) +{ + bt_object_put_ref(iterator); +} + +void bt_self_component_port_input_message_iterator_get_ref( + const struct bt_self_component_port_input_message_iterator *iterator) +{ + bt_object_get_ref(iterator); +} + +void bt_self_component_port_input_message_iterator_put_ref( + const struct bt_self_component_port_input_message_iterator *iterator) +{ + bt_object_put_ref(iterator); +}