X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fiterator.c;h=8d0f156dea4c2a282c9ca430101f0cd03f8ef481;hb=98b15851a941e7342b8bb19e265cdc3a40fabfb8;hp=81f7dd9d37a18451dfdcc0838048ec4b5e2ee5c6;hpb=867517794e3a3514589eb9b60fe252c65bd23269;p=babeltrace.git diff --git a/src/lib/graph/iterator.c b/src/lib/graph/iterator.c index 81f7dd9d..8d0f156d 100644 --- a/src/lib/graph/iterator.c +++ b/src/lib/graph/iterator.c @@ -95,7 +95,7 @@ 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) { - BT_ASSERT(iterator); + BT_ASSERT_DBG(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; @@ -137,7 +137,7 @@ void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj if (iterator->auto_seek.msgs) { while (!g_queue_is_empty(iterator->auto_seek.msgs)) { - bt_object_put_no_null_check( + bt_object_put_ref_no_null_check( g_queue_pop_tail(iterator->auto_seek.msgs)); } @@ -273,18 +273,23 @@ void bt_self_component_port_input_message_iterator_set_connection( } static -bt_bool can_seek_ns_from_origin_true( +enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true( struct bt_self_component_port_input_message_iterator *iterator, - int64_t ns_from_origin) + int64_t ns_from_origin, bt_bool *can_seek) { - return BT_TRUE; + *can_seek = BT_TRUE; + + return BT_FUNC_STATUS_OK; } static -bt_bool can_seek_beginning_true( - struct bt_self_component_port_input_message_iterator *iterator) +enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true( + struct bt_self_component_port_input_message_iterator *iterator, + bt_bool *can_seek) { - return BT_TRUE; + *can_seek = BT_TRUE; + + return BT_FUNC_STATUS_OK; } static @@ -293,8 +298,8 @@ int create_self_component_input_port_message_iterator( struct bt_self_component_port_input *self_port, struct bt_self_component_port_input_message_iterator **message_iterator) { - typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t)( - void *, void *, void *); + typedef enum bt_component_class_message_iterator_initialize_method_status (*init_method_t)( + void *, void *, void *, void *); init_method_t init_method = NULL; struct bt_self_component_port_input_message_iterator *iterator = @@ -446,7 +451,7 @@ int create_self_component_input_port_message_iterator( (void *) upstream_comp_cls; init_method = - (init_method_t) src_comp_cls->methods.msg_iter_init; + (init_method_t) src_comp_cls->methods.msg_iter_initialize; break; } case BT_COMPONENT_CLASS_TYPE_FILTER: @@ -455,7 +460,7 @@ int create_self_component_input_port_message_iterator( (void *) upstream_comp_cls; init_method = - (init_method_t) flt_comp_cls->methods.msg_iter_init; + (init_method_t) flt_comp_cls->methods.msg_iter_initialize; break; } default: @@ -464,10 +469,10 @@ int create_self_component_input_port_message_iterator( } if (init_method) { - enum bt_component_class_message_iterator_init_method_status iter_status; + enum bt_component_class_message_iterator_initialize_method_status iter_status; BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator); - iter_status = init_method(iterator, upstream_comp, + iter_status = init_method(iterator, &iterator->config, upstream_comp, upstream_port); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(iter_status)); @@ -480,6 +485,8 @@ int create_self_component_input_port_message_iterator( status = iter_status; goto error; } + + iterator->config.frozen = true; } if (downstream_msg_iter) { @@ -556,6 +563,16 @@ void bt_self_message_iterator_set_data( "%!+i, user-data-addr=%p", iterator, data); } +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", ""); + + config->can_seek_forward = can_seek_forward; +} + /* * Validate that the default clock snapshot in `msg` doesn't make us go back in * time. @@ -831,7 +848,7 @@ call_iterator_next_method( { enum bt_component_class_message_iterator_next_method_status status; - BT_ASSERT(iterator->methods.next); + BT_ASSERT_DBG(iterator->methods.next); BT_LOGD_STR("Calling user's \"next\" method."); status = iterator->methods.next(iterator, msgs, capacity, user_count); BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64, @@ -861,8 +878,8 @@ bt_self_component_port_input_message_iterator_next( 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_DBG(iterator->upstream_component); + BT_ASSERT_DBG(iterator->upstream_component->class); BT_ASSERT_PRE_DEV( bt_component_borrow_graph(iterator->upstream_component)->config_state != BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, @@ -899,7 +916,7 @@ bt_self_component_port_input_message_iterator_next( * 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_ASSERT_DBG(iterator->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); switch (status) { @@ -951,7 +968,7 @@ struct bt_self_component *bt_self_message_iterator_borrow_component( return (void *) iterator->upstream_component; } -struct bt_self_port_output *bt_self_message_iterator_borrow_port( +struct bt_self_component_port_output *bt_self_message_iterator_borrow_port( struct bt_self_message_iterator *self_iterator) { struct bt_self_component_port_input_message_iterator *iterator = @@ -961,13 +978,15 @@ struct bt_self_port_output *bt_self_message_iterator_borrow_port( return (void *) iterator->upstream_port; } -bt_bool bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( +enum bt_message_iterator_can_seek_ns_from_origin_status +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) + int64_t ns_from_origin, bt_bool *can_seek) { - bt_bool can = BT_FALSE; + enum bt_message_iterator_can_seek_ns_from_origin_status status; BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)"); BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); BT_ASSERT_PRE( bt_component_borrow_graph(iterator->upstream_component)->config_state != @@ -976,29 +995,66 @@ bt_bool bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( 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; + /* + * Initialize to an invalid value, so we can post-assert that + * the method returned a valid value. + */ + *can_seek = -1; + + BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i", + iterator); + + status = (int) iterator->methods.can_seek_ns_from_origin(iterator, + ns_from_origin, can_seek); + + if (status != BT_FUNC_STATUS_OK) { + BT_LIB_LOGW_APPEND_CAUSE( + "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: " + "%![iter-]+i, status=%s", + iterator, bt_common_func_status_string(status)); + goto end; + } + + BT_ASSERT_POST(*can_seek == BT_TRUE || *can_seek == BT_FALSE, + "Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i", + *can_seek, iterator); + + BT_LIB_LOGD( + "User's \"can seek nanoseconds from origin\" returned successfully: " + "%![iter-]+i, can-seek=%d", + iterator, *can_seek); + + if (*can_seek) { + goto end; + } } /* - * Automatic seeking fall back: if we can seek to the beginning, - * then we can automatically seek to any message. + * Automatic seeking fall back: if we can seek to the beginning and the + * iterator supports forward seeking then we can automatically seek to + * any timestamp. */ - if (iterator->methods.can_seek_beginning) { - can = iterator->methods.can_seek_beginning(iterator); + status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning( + iterator, can_seek); + if (status != BT_FUNC_STATUS_OK) { + goto end; } + *can_seek = *can_seek && iterator->config.can_seek_forward; + end: - return can; + return status; } -bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning( - struct bt_self_component_port_input_message_iterator *iterator) +enum bt_message_iterator_can_seek_beginning_status +bt_self_component_port_input_message_iterator_can_seek_beginning( + struct bt_self_component_port_input_message_iterator *iterator, + bt_bool *can_seek) { - bt_bool can = BT_FALSE; + enum bt_message_iterator_can_seek_beginning_status status; BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)"); BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); BT_ASSERT_PRE( bt_component_borrow_graph(iterator->upstream_component)->config_state != @@ -1007,10 +1063,26 @@ bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning( bt_component_borrow_graph(iterator->upstream_component)); if (iterator->methods.can_seek_beginning) { - can = iterator->methods.can_seek_beginning(iterator); + /* + * Initialize to an invalid value, so we can post-assert that + * the method returned a valid value. + */ + *can_seek = -1; + + status = (int) iterator->methods.can_seek_beginning(iterator, can_seek); + + BT_ASSERT_POST( + 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); + } else { + *can_seek = BT_FALSE; + status = BT_FUNC_STATUS_OK; } - return can; + return status; } static inline @@ -1050,6 +1122,22 @@ void reset_iterator_expectations( iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET; } +static +bool message_iterator_can_seek_beginning( + struct bt_self_component_port_input_message_iterator *iterator) +{ + enum bt_message_iterator_can_seek_beginning_status status; + bt_bool can_seek; + + status = bt_self_component_port_input_message_iterator_can_seek_beginning( + iterator, &can_seek); + if (status != BT_FUNC_STATUS_OK) { + can_seek = BT_FALSE; + } + + return can_seek; +} + enum bt_message_iterator_seek_beginning_status bt_self_component_port_input_message_iterator_seek_beginning( struct bt_self_component_port_input_message_iterator *iterator) @@ -1063,9 +1151,7 @@ bt_self_component_port_input_message_iterator_seek_beginning( 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), + BT_ASSERT_PRE(message_iterator_can_seek_beginning(iterator), "Message iterator cannot seek beginning: %!+i", iterator); /* @@ -1097,6 +1183,15 @@ bt_self_component_port_input_message_iterator_seek_beginning( return status; } +bt_bool +bt_self_component_port_input_message_iterator_can_seek_forward( + bt_self_component_port_input_message_iterator *iterator) +{ + BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + + return iterator->config.can_seek_forward; +} + /* * Structure used to record the state of a given stream during the fast-forward * phase of an auto-seek. @@ -1180,8 +1275,8 @@ int auto_seek_handle_message( const struct bt_clock_snapshot *clk_snapshot = NULL; int ret; - BT_ASSERT(msg); - BT_ASSERT(got_first); + BT_ASSERT_DBG(msg); + BT_ASSERT_DBG(got_first); switch (msg->type) { case BT_MESSAGE_TYPE_EVENT: @@ -1201,7 +1296,7 @@ int auto_seek_handle_message( (const void *) msg; clk_snapshot = inactivity_msg->default_cs; - BT_ASSERT(clk_snapshot); + BT_ASSERT_DBG(clk_snapshot); break; } case BT_MESSAGE_TYPE_PACKET_BEGINNING: @@ -1300,7 +1395,7 @@ int auto_seek_handle_message( abort(); } - BT_ASSERT(clk_snapshot); + BT_ASSERT_DBG(clk_snapshot); ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot, &msg_ns_from_origin); if (ret) { @@ -1334,7 +1429,7 @@ skip_msg: stream_state->seen_clock_snapshot = true; } - BT_ASSERT(!bt_g_hash_table_contains(stream_states, stream_msg->stream)); + BT_ASSERT_DBG(!bt_g_hash_table_contains(stream_states, stream_msg->stream)); g_hash_table_insert(stream_states, stream_msg->stream, stream_state); break; } @@ -1346,11 +1441,10 @@ skip_msg: /* Update stream's state: packet began. */ stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream); - BT_ASSERT(stream_state); - - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); + BT_ASSERT_DBG(stream_state); + BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); stream_state->state = AUTO_SEEK_STREAM_STATE_PACKET_BEGAN; - BT_ASSERT(!stream_state->packet); + BT_ASSERT_DBG(!stream_state->packet); stream_state->packet = packet_msg->packet; if (packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) { @@ -1366,7 +1460,7 @@ skip_msg: stream_state = g_hash_table_lookup(stream_states, event_msg->event->packet->stream); - BT_ASSERT(stream_state); + BT_ASSERT_DBG(stream_state); // HELPME: are we sure that event messages have clock snapshots at this point? stream_state->seen_clock_snapshot = true; @@ -1381,11 +1475,10 @@ skip_msg: /* Update stream's state: packet ended. */ stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream); - BT_ASSERT(stream_state); - - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_PACKET_BEGAN); + BT_ASSERT_DBG(stream_state); + BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_PACKET_BEGAN); stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN; - BT_ASSERT(stream_state->packet); + BT_ASSERT_DBG(stream_state->packet); stream_state->packet = NULL; if (packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) { @@ -1400,9 +1493,9 @@ skip_msg: struct auto_seek_stream_state *stream_state; stream_state = g_hash_table_lookup(stream_states, stream_msg->stream); - BT_ASSERT(stream_state); - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); - BT_ASSERT(!stream_state->packet); + BT_ASSERT_DBG(stream_state); + BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); + BT_ASSERT_DBG(!stream_state->packet); /* Update stream's state: this stream doesn't exist anymore. */ g_hash_table_remove(stream_states, stream_msg->stream); @@ -1416,7 +1509,7 @@ skip_msg: struct auto_seek_stream_state *stream_state; stream_state = g_hash_table_lookup(stream_states, discarded_msg->stream); - BT_ASSERT(stream_state); + BT_ASSERT_DBG(stream_state); if ((msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS && discarded_msg->stream->class->discarded_events_have_default_clock_snapshots) || (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS && discarded_msg->stream->class->discarded_packets_have_default_clock_snapshots)) { @@ -1429,7 +1522,7 @@ skip_msg: break; } - bt_object_put_no_null_check(msg); + bt_object_put_ref_no_null_check(msg); msg = NULL; goto end; @@ -1438,7 +1531,7 @@ push_msg: msg = NULL; end: - BT_ASSERT(!msg || status != BT_FUNC_STATUS_OK); + BT_ASSERT_DBG(!msg || status != BT_FUNC_STATUS_OK); return status; } @@ -1447,7 +1540,7 @@ int find_message_ge_ns_from_origin( struct bt_self_component_port_input_message_iterator *iterator, int64_t ns_from_origin, GHashTable *stream_states) { - int status; + int status = BT_FUNC_STATUS_OK; enum bt_self_component_port_input_message_iterator_state init_state = iterator->state; const struct bt_message *messages[MSG_BATCH_SIZE]; @@ -1455,7 +1548,7 @@ int find_message_ge_ns_from_origin( uint64_t i; bool got_first = false; - BT_ASSERT(iterator); + BT_ASSERT_DBG(iterator); memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE); /* @@ -1465,7 +1558,7 @@ int find_message_ge_ns_from_origin( set_self_comp_port_input_msg_iterator_state(iterator, BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); - BT_ASSERT(iterator->methods.next); + BT_ASSERT_DBG(iterator->methods.next); while (!got_first) { /* @@ -1487,7 +1580,7 @@ int find_message_ge_ns_from_origin( * The user's "next" method must not do any action which * would change the iterator's state. */ - BT_ASSERT(iterator->state == + BT_ASSERT_DBG(iterator->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); switch (status) { @@ -1529,7 +1622,7 @@ int find_message_ge_ns_from_origin( end: for (i = 0; i < user_count; i++) { if (messages[i]) { - bt_object_put_no_null_check(messages[i]); + bt_object_put_ref_no_null_check(messages[i]); } } @@ -1588,6 +1681,22 @@ int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class, cc_offset_cycles, cc_freq, ns_from_origin, raw_value); } +static +bool message_iterator_can_seek_ns_from_origin( + struct bt_self_component_port_input_message_iterator *iterator, + int64_t ns_from_origin) +{ + enum bt_message_iterator_can_seek_ns_from_origin_status status; + bt_bool can_seek; + + status = bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( + iterator, ns_from_origin, &can_seek); + if (status != BT_FUNC_STATUS_OK) { + can_seek = BT_FALSE; + } + + return can_seek; +} enum bt_message_iterator_seek_ns_from_origin_status bt_self_component_port_input_message_iterator_seek_ns_from_origin( @@ -1596,6 +1705,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( { int status; GHashTable *stream_states = NULL; + bt_bool can_seek_by_itself; BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); @@ -1604,9 +1714,9 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( 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_self_component_port_input_message_iterator_can_seek_ns_from_origin( - iterator, 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); set_self_comp_port_input_msg_iterator_state(iterator, @@ -1618,8 +1728,25 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( */ reset_iterator_expectations(iterator); - if (iterator->methods.seek_ns_from_origin) { + /* Check if the iterator can seek by itself. If not we'll use autoseek. */ + if (iterator->methods.can_seek_ns_from_origin) { + bt_component_class_message_iterator_can_seek_ns_from_origin_method_status + can_seek_status; + + can_seek_status = + iterator->methods.can_seek_ns_from_origin( + iterator, ns_from_origin, &can_seek_by_itself); + if (can_seek_status != BT_FUNC_STATUS_OK) { + status = can_seek_status; + goto end; + } + } else { + can_seek_by_itself = false; + } + + if (can_seek_by_itself) { /* The iterator knows how to seek to a particular time, let it handle this. */ + BT_ASSERT(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, @@ -1640,10 +1767,18 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( } } else { /* - * The iterator doesn't know how to seek to a particular time. We will - * seek to the beginning and fast forward to the right place. + * The iterator doesn't know how to seek by itself to a + * particular time. We will seek to the beginning and fast + * forward to the right place. */ - BT_ASSERT(iterator->methods.can_seek_beginning(iterator)); + enum bt_component_class_message_iterator_can_seek_beginning_method_status + can_seek_status; + bt_bool can_seek_beginning; + + can_seek_status = iterator->methods.can_seek_beginning(iterator, + &can_seek_beginning); + BT_ASSERT(can_seek_status == BT_FUNC_STATUS_OK); + BT_ASSERT(can_seek_beginning); BT_ASSERT(iterator->methods.seek_beginning); BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator); @@ -1682,7 +1817,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( * message queue. */ while (!g_queue_is_empty(iterator->auto_seek.msgs)) { - bt_object_put_no_null_check( + bt_object_put_ref_no_null_check( g_queue_pop_tail(iterator->auto_seek.msgs)); }