lib/graph/iterator: use clock correlation validator util
[babeltrace.git] / src / lib / graph / iterator.c
index 73893ddb36e6d713fd0fb38e1df7aae89483f9a5..c3cd9fecaf1ad4865131603300531f50f4e9a656 100644 (file)
@@ -18,6 +18,7 @@
 #include <babeltrace2/trace-ir/packet.h>
 #include "lib/trace-ir/packet.h"
 #include "lib/trace-ir/stream.h"
+#include "lib/trace-ir/stream-class.h"
 #include <babeltrace2/trace-ir/clock-class.h>
 #include <babeltrace2/trace-ir/stream-class.h>
 #include <babeltrace2/trace-ir/stream.h>
 #include "component.h"
 #include "connection.h"
 #include "graph.h"
+#include "iterator.h"
 #include "message-iterator-class.h"
 #include "message/discarded-items.h"
 #include "message/event.h"
-#include "message/iterator.h"
 #include "message/message.h"
 #include "message/message-iterator-inactivity.h"
 #include "message/stream.h"
 #include "message/packet.h"
 #include "lib/func-status.h"
+#include "clock-correlation-validator/clock-correlation-validator.h"
 
 /*
  * TODO: Use graph's state (number of active iterators, etc.) and
@@ -64,7 +66,7 @@
                (_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
                "Message iterator is in the wrong state: %!+i", (_iter))
 
-#ifdef BT_DEV_MODE
+BT_IF_DEV_MODE(
 struct per_stream_state
 {
        bt_packet *cur_packet;
@@ -72,7 +74,7 @@ struct per_stream_state
        /* Bit mask of expected message types. */
        guint expected_msg_types;
 };
-#endif
+)
 
 static void
 clear_per_stream_state (struct bt_message_iterator *iterator)
@@ -153,9 +155,9 @@ void bt_message_iterator_destroy(struct bt_object *obj)
                iterator->msgs = NULL;
        }
 
-#ifdef BT_DEV_MODE
-       g_hash_table_destroy(iterator->per_stream_state);
-#endif
+       BT_IF_DEV_MODE(bt_clock_correlation_validator_destroy(
+               iterator->correlation_validator));
+       BT_IF_DEV_MODE(g_hash_table_destroy(iterator->per_stream_state));
 
        g_free(iterator);
 }
@@ -361,17 +363,26 @@ int create_self_component_input_port_message_iterator(
                goto error;
        }
 
+       BT_IF_DEV_MODE(
+               iterator->correlation_validator =
+                       bt_clock_correlation_validator_create();
+               if (!iterator->correlation_validator) {
+                       BT_LIB_LOGE_APPEND_CAUSE(
+                               "Failed to allocate a clock correlation validator.");
+                       status = BT_FUNC_STATUS_MEMORY_ERROR;
+                       goto error;
+               }
+       );
+
        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(
+       BT_IF_DEV_MODE(iterator->per_stream_state = g_hash_table_new_full(
                g_direct_hash,
                g_direct_equal,
                NULL,
-               g_free);
-#endif
+               g_free));
 
        iterator->auto_seek.msgs = g_queue_new();
        if (!iterator->auto_seek.msgs) {
@@ -660,167 +671,90 @@ end:
        return result;
 }
 
+#define NEXT_METHOD_NAME       "bt_message_iterator_class_next_method"
+
+#ifdef BT_DEV_MODE
+
 /*
  * When a new stream begins, verify that the clock class tied to this
  * stream is compatible with what we've seen before.
  */
 
-BT_ASSERT_COND_DEV_FUNC
 static
-bool clock_classes_are_compatible_one(struct bt_message_iterator *iterator,
+void assert_post_dev_clock_classes_are_compatible_one(
+               struct bt_message_iterator *iterator,
                const struct bt_message *msg)
 {
-       enum bt_message_type message_type = bt_message_get_type(msg);
-       bool result;
-
-       if (message_type == BT_MESSAGE_TYPE_STREAM_BEGINNING) {
-               const struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg;
-               const struct bt_clock_class *clock_class = stream_msg->stream->class->default_clock_class;
-               bt_uuid clock_class_uuid = NULL;
+       enum bt_clock_correlation_validator_error_type type;
+       bt_uuid expected_uuid;
+       const bt_clock_class *actual_clock_cls;
+       const bt_clock_class *expected_clock_cls;
+
+       if (!bt_clock_correlation_validator_validate_message(
+                       iterator->correlation_validator, msg, &type,
+                       &expected_uuid, &actual_clock_cls,
+                       &expected_clock_cls)) {
+               switch (type) {
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_NO_CLOCK_CLASS_GOT_ONE:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "stream-class-has-no-clock-class", false,
+                               "Expecting no clock class, got one.");
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_UNIX_GOT_NONE:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "stream-class-has-clock-class-with-unix-epoch-origin", false,
+                               "Expecting a clock class, got none.");
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_UNIX_GOT_OTHER:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "clock-class-has-unix-epoch-origin", false,
+                               "Expecting a clock class with Unix epoch origin: %![cc-]+K",
+                               actual_clock_cls);
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_UUID_GOT_NONE:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "stream-class-has-clock-class-with-uuid", false,
+                               "Expecting a clock class, got none.");
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_UUID_GOT_UNIX:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "clock-class-has-non-unix-epoch-origin", false,
+                               "Expecting a clock class without Unix epoch origin: %![cc-]+K",
+                               actual_clock_cls);
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_UUID_GOT_NO_UUID:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "clock-class-has-uuid", false,
+                               "Expecting a clock class with UUID:  %![cc-]+K",
+                               actual_clock_cls);
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_UUID_GOT_OTHER_UUID:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "clock-class-has-expected-uuid", false,
+                               "Expecting a clock class with UUID, got one with a different UUID: %![cc-]+K, expected-uuid=%!u",
+                               actual_clock_cls, expected_uuid);
 
-               if (clock_class) {
-                       clock_class_uuid = bt_clock_class_get_uuid(clock_class);
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_NO_UUID_GOT_NONE:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "stream-class-has-clock-class", false,
+                               "Expecting a clock class, got none.");
+               case BT_CLOCK_CORRELATION_VALIDATOR_ERROR_TYPE_EXPECTING_ORIGIN_NO_UUID_GOT_OTHER:
+                       BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
+                               "clock-class-is-expected", false,
+                               "Unexpected clock class: %![expected-cc-]+K, %![actual-cc-]+K",
+                               expected_clock_cls, actual_clock_cls);
                }
 
-               switch (iterator->clock_expectation.type) {
-               case CLOCK_EXPECTATION_UNSET:
-                       /*
-                        * This is the first time we see a message with a clock
-                        * snapshot: record the properties of that clock, against
-                        * which we'll compare the clock properties of the following
-                        * messages.
-                        */
-
-                       if (!clock_class) {
-                               iterator->clock_expectation.type = CLOCK_EXPECTATION_NONE;
-                       } else if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
-                               iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_UNIX;
-                       } else if (clock_class_uuid) {
-                               iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_UUID;
-                               bt_uuid_copy(iterator->clock_expectation.uuid, clock_class_uuid);
-                       } else {
-                               iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID;
-                       }
-                       break;
-
-               case CLOCK_EXPECTATION_NONE:
-                       if (clock_class) {
-                               BT_ASSERT_COND_DEV_MSG(
-                                       "Expecting no clock class, got one: %![cc-]+K",
-                                       clock_class);
-                               result = false;
-                               goto end;
-                       }
-
-                       break;
-
-               case CLOCK_EXPECTATION_ORIGIN_UNIX:
-                       if (!clock_class) {
-                               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_COND_DEV_MSG(
-                                       "Expecting a clock class with Unix epoch origin: %![cc-]+K",
-                                       clock_class);
-                               result = false;
-                               goto end;
-                       }
-                       break;
-
-               case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID:
-                       if (!clock_class) {
-                               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_COND_DEV_MSG(
-                                       "Expecting a clock class without Unix epoch origin: %![cc-]+K",
-                                       clock_class);
-                               result = false;
-                               goto end;
-                       }
-
-                       if (!clock_class_uuid) {
-                               BT_ASSERT_COND_DEV_MSG(
-                                       "Expecting a clock class with UUID: %![cc-]+K",
-                                       clock_class);
-                               result = false;
-                               goto end;
-                       }
-
-                       if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) {
-                               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);
-                               result = false;
-                               goto end;
-                       }
-                       break;
-
-               case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID:
-                       if (!clock_class) {
-                               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_COND_DEV_MSG(
-                                       "Expecting a clock class without Unix epoch origin: %![cc-]+K",
-                                       clock_class);
-                               result = false;
-                               goto end;
-                       }
-
-                       if (clock_class_uuid) {
-                               BT_ASSERT_COND_DEV_MSG(
-                                       "Expecting a clock class without UUID: %![cc-]+K",
-                                       clock_class);
-                               result = false;
-                               goto end;
-                       }
-                       break;
-               }
+               bt_common_abort();
        }
-
-       result = true;
-
-end:
-       return result;
 }
 
-BT_ASSERT_COND_DEV_FUNC
 static
-bool clock_classes_are_compatible(
+void assert_post_dev_clock_classes_are_compatible(
                struct bt_message_iterator *iterator,
                bt_message_array_const msgs, uint64_t msg_count)
 {
        uint64_t i;
-       bool result;
 
        for (i = 0; i < msg_count; i++) {
-               if (!clock_classes_are_compatible_one(iterator, msgs[i])) {
-                       result = false;
-                       goto end;
-               }
+               assert_post_dev_clock_classes_are_compatible_one(iterator, msgs[i]);
        }
-
-       result = true;
-
-end:
-       return result;
 }
 
-#ifdef BT_DEV_MODE
 static
 const bt_stream *get_stream_from_msg(const struct bt_message *msg)
 {
@@ -1024,11 +958,7 @@ struct per_stream_state *get_per_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)
@@ -1179,11 +1109,9 @@ call_iterator_next_method(
                bt_common_func_status_string(status), *user_count);
 
        if (status == BT_FUNC_STATUS_OK) {
-               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_IF_DEV_MODE(assert_post_dev_clock_classes_are_compatible(
+                       iterator, msgs, *user_count));
+
                BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
                        "message-clock-snapshots-are-monotonic",
                        clock_snapshots_are_monotonic(iterator, msgs,
@@ -1191,9 +1119,8 @@ call_iterator_next_method(
                        "Clock snapshots are not monotonic");
        }
 
-#ifdef BT_DEV_MODE
-       assert_post_dev_next(iterator, status, msgs, *user_count);
-#endif
+       BT_IF_DEV_MODE(assert_post_dev_next(iterator, status, msgs,
+               *user_count));
 
        BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(NEXT_METHOD_NAME,
                status);
@@ -1474,7 +1401,6 @@ void reset_iterator_expectations(
                struct bt_message_iterator *iterator)
 {
        iterator->last_ns_from_origin = INT64_MIN;
-       iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET;
 }
 
 static
This page took 0.028701 seconds and 4 git commands to generate.