flt.utils.muxer: deterministically order messages of same timestamps
authorFrancis Deslauriers <francis.deslauriers@efficios.com>
Wed, 17 Jul 2019 22:23:35 +0000 (18:23 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 8 Aug 2019 18:39:52 +0000 (14:39 -0400)
Issue
=====
The ordering of messages with the exact same timestamp is runtime
dependent. It is causing flakiness in tests using a `sink.text.details`
sink component where such differences in ordering is checked.

Note: It's common to have messages with the same timestamps because that
messages with no clock snapshot are assumed to happen at the same time
that of the previous message.

Solution
========
We need to order messages deterministically even when timestamps are the
same. This commit adds functions to order, in a predictable manner,
messages that have the same timestamp (or no timestamp at all) so that
they are sorted in the same way every time a trace is read.

With this commit:
* We first try to sort the messages by their trace name, stream class
  id, or stream id,
* If not possible, we check if the messages have different types and if
  they do, we sort them using the following scheme:
    SB < PB < EV < DE < MI < PE < DP < SE
* If they are of the same type, we sort them comparing their properties.

Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: Id6fc1fe8b19d02ec1804e54255a73c64820d1e13
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1719
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
src/plugins/utils/muxer/muxer.c

index dd18d98a7023d9ba306067180c7ffefaa07193be..f92f8326b14c8bfc9c5254940358371ef665bb6c 100644 (file)
@@ -849,6 +849,895 @@ end:
        return ret;
 }
 
+struct message_to_compare {
+       const bt_message *msg;
+       const bt_trace *trace;
+       const bt_stream *stream;
+};
+
+struct messages_to_compare {
+       struct message_to_compare left;
+       struct message_to_compare right;
+};
+
+static
+int message_type_weight(const bt_message_type msg_type)
+{
+       int weight;
+
+       switch (msg_type) {
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+               weight = 7;
+               break;
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+               weight = 6;
+               break;
+       case BT_MESSAGE_TYPE_EVENT:
+               weight = 5;
+               break;
+       case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+               weight = 4;
+               break;
+       case BT_MESSAGE_TYPE_PACKET_END:
+               weight = 3;
+               break;
+       case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+               weight = 2;
+               break;
+       case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+               weight = 1;
+               break;
+       case BT_MESSAGE_TYPE_STREAM_END:
+               weight = 0;
+               break;
+       default:
+               abort();
+       }
+
+       return weight;
+}
+
+/*
+ * Compare 2 messages to order them in a determinitic way based on their
+ * types.
+ * Returns -1 is left mesage must go first
+ * Returns 1 is right mesage must go first
+ */
+static
+int compare_messages_by_type(struct messages_to_compare *msgs)
+{
+       bt_message_type left_msg_type = bt_message_get_type(msgs->left.msg);
+       bt_message_type right_msg_type = bt_message_get_type(msgs->right.msg);
+
+       return message_type_weight(right_msg_type) -
+               message_type_weight(left_msg_type);
+}
+
+static
+int compare_events(const bt_event *left_event, const bt_event *right_event)
+{
+       int ret;
+       const bt_event_class *left_event_class, *right_event_class;
+       uint64_t left_event_class_id, right_event_class_id;
+       const char *left_event_class_name, *right_event_class_name,
+                       *left_event_class_emf_uri, *right_event_class_emf_uri;
+       bt_event_class_log_level left_event_class_log_level, right_event_class_log_level;
+       bt_property_availability left_log_level_avail, right_log_level_avail;
+
+       left_event_class = bt_event_borrow_class_const(left_event);
+       right_event_class = bt_event_borrow_class_const(right_event);
+
+       left_event_class_id = bt_event_class_get_id(left_event_class);
+       right_event_class_id = bt_event_class_get_id(right_event_class);
+
+       if (left_event_class_id > right_event_class_id) {
+               ret = 1;
+               goto end;
+       } else if (left_event_class_id < right_event_class_id) {
+               ret = -1;
+               goto end;
+       }
+
+       left_event_class_name = bt_event_class_get_name(left_event_class);
+       right_event_class_name = bt_event_class_get_name(right_event_class);
+       if (left_event_class_name && right_event_class_name) {
+               ret = strcmp(left_event_class_name, right_event_class_name);
+               if (ret != 0) {
+                       goto end;
+               }
+       } else if (!left_event_class_name && right_event_class_name) {
+               ret = -1;
+               goto end;
+       } else if (left_event_class_name && !right_event_class_name) {
+               ret = 1;
+               goto end;
+       }
+
+       left_log_level_avail = bt_event_class_get_log_level(left_event_class,
+               &left_event_class_log_level);
+       right_log_level_avail = bt_event_class_get_log_level(right_event_class,
+               &right_event_class_log_level);
+
+       if (left_log_level_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       right_log_level_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
+               ret = left_event_class_log_level - right_event_class_log_level;
+               if (ret) {
+                       goto end;
+               }
+       } else if (left_log_level_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       right_log_level_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
+               ret = -1;
+               goto end;
+       } else if (left_log_level_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE &&
+                       right_log_level_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
+               ret = 1;
+               goto end;
+       }
+
+       left_event_class_emf_uri = bt_event_class_get_emf_uri(left_event_class);
+       right_event_class_emf_uri = bt_event_class_get_emf_uri(right_event_class);
+       if (left_event_class_emf_uri && right_event_class_emf_uri) {
+               ret = strcmp(left_event_class_emf_uri, right_event_class_emf_uri);
+               if (ret != 0) {
+                       goto end;
+               }
+       } else if (!left_event_class_emf_uri && right_event_class_emf_uri) {
+               ret = -1;
+               goto end;
+       } else if (left_event_class_emf_uri && !right_event_class_emf_uri) {
+               ret = 1;
+               goto end;
+       }
+
+end:
+       return ret;
+}
+
+static
+int compare_streams(const bt_stream *left_stream, const bt_stream *right_stream)
+{
+       int ret = 0;
+       const char *left_stream_name, *right_stream_name,
+             *left_stream_class_name, *right_stream_class_name;
+       const bt_stream_class *left_stream_class, *right_stream_class;
+
+       /*
+        * No need to compare stream id as it was checked earlier and if we are
+        * here it means they are identical or both absent.
+        */
+       BT_ASSERT(bt_stream_get_id(left_stream) ==
+               bt_stream_get_id(right_stream));
+
+       /* Compare stream name. */
+       left_stream_name = bt_stream_get_name(left_stream);
+       right_stream_name = bt_stream_get_name(right_stream);
+
+       if (left_stream_name && right_stream_name) {
+               ret = strcmp(left_stream_name, right_stream_name);
+               if (ret != 0) {
+                       goto end;
+               }
+       } else if (!left_stream_name && right_stream_name) {
+               ret = -1;
+               goto end;
+       } else if (left_stream_name && !right_stream_name) {
+               ret = 1;
+               goto end;
+       }
+
+       left_stream_class = bt_stream_borrow_class_const(left_stream);
+       right_stream_class = bt_stream_borrow_class_const(right_stream);
+
+       /*
+        * No need to compare stream class id as it was checked earlier and if
+        * we are here it means they are identical.
+        */
+       BT_ASSERT(bt_stream_class_get_id(left_stream_class) ==
+               bt_stream_class_get_id(right_stream_class));
+
+       /* Compare stream class name. */
+       left_stream_class_name = bt_stream_class_get_name(left_stream_class);
+       right_stream_class_name = bt_stream_class_get_name(right_stream_class);
+
+       if (left_stream_class_name && right_stream_class_name) {
+               ret = strcmp(left_stream_class_name, right_stream_class_name);
+               if (ret != 0) {
+                       goto end;
+               }
+       } else if (!left_stream_class_name && right_stream_class_name) {
+               ret = -1;
+               goto end;
+       } else if (left_stream_class_name && !right_stream_class_name) {
+               ret = 1;
+               goto end;
+       }
+
+       /* Compare stream class automatic event class id assignment. */
+       if (bt_stream_class_assigns_automatic_event_class_id(left_stream_class) &&
+                       !bt_stream_class_assigns_automatic_event_class_id(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_assigns_automatic_event_class_id(left_stream_class) &&
+                       bt_stream_class_assigns_automatic_event_class_id(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /* Compare stream class automatic stream id assignment. */
+       if (bt_stream_class_assigns_automatic_stream_id(left_stream_class) &&
+                       !bt_stream_class_assigns_automatic_stream_id(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_assigns_automatic_stream_id(left_stream_class) &&
+                       bt_stream_class_assigns_automatic_stream_id(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /* Compare stream class support of discarded events. */
+       if (bt_stream_class_supports_discarded_events(left_stream_class) &&
+                       !bt_stream_class_supports_discarded_events(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_supports_discarded_events(left_stream_class) &&
+                       bt_stream_class_supports_discarded_events(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /* Compare stream class discarded events default clock snapshot. */
+       if (bt_stream_class_discarded_events_have_default_clock_snapshots(left_stream_class) &&
+                       !bt_stream_class_discarded_events_have_default_clock_snapshots(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_discarded_events_have_default_clock_snapshots(left_stream_class) &&
+                       bt_stream_class_discarded_events_have_default_clock_snapshots(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /* Compare stream class support of packets. */
+       if (bt_stream_class_supports_packets(left_stream_class) &&
+                       !bt_stream_class_supports_packets(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_supports_packets(left_stream_class) &&
+                       bt_stream_class_supports_packets(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!bt_stream_class_supports_packets(left_stream_class)) {
+               /* Skip all packet related checks. */
+               goto end;
+       }
+
+       /*
+        * Compare stream class presence of discarded packets beginning default
+        * clock snapshot.
+        */
+       if (bt_stream_class_packets_have_beginning_default_clock_snapshot(left_stream_class) &&
+                       !bt_stream_class_packets_have_beginning_default_clock_snapshot(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_packets_have_beginning_default_clock_snapshot(left_stream_class) &&
+                       bt_stream_class_packets_have_beginning_default_clock_snapshot(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /*
+        * Compare stream class presence of discarded packets end default clock
+        * snapshot.
+        */
+       if (bt_stream_class_packets_have_end_default_clock_snapshot(left_stream_class) &&
+                       !bt_stream_class_packets_have_end_default_clock_snapshot(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_packets_have_end_default_clock_snapshot(left_stream_class) &&
+                       bt_stream_class_packets_have_end_default_clock_snapshot(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /* Compare stream class support of discarded packets. */
+       if (bt_stream_class_supports_discarded_packets(left_stream_class) &&
+                       !bt_stream_class_supports_discarded_packets(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_supports_discarded_packets(left_stream_class) &&
+                       bt_stream_class_supports_discarded_packets(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+       /* Compare stream class discarded packets default clock snapshot. */
+       if (bt_stream_class_discarded_packets_have_default_clock_snapshots(left_stream_class) &&
+                       !bt_stream_class_discarded_packets_have_default_clock_snapshots(right_stream_class)) {
+               ret = 1;
+               goto end;
+       } else if (!bt_stream_class_discarded_packets_have_default_clock_snapshots(left_stream_class) &&
+                       bt_stream_class_discarded_packets_have_default_clock_snapshots(right_stream_class)) {
+               ret = -1;
+               goto end;
+       }
+
+end:
+       return ret;
+}
+
+static
+int compare_clock_snapshots_and_clock_classes(const bt_clock_snapshot *left_cs,
+               const bt_clock_snapshot *right_cs)
+{
+       int ret;
+       uint64_t left_freq, right_freq, left_prec, right_prec;
+       uint64_t left_cs_value, right_cs_value;
+       const bt_clock_class *left_clock_class, *right_clock_class;
+       const char *left_clock_class_name, *right_clock_class_name;
+       left_cs_value = bt_clock_snapshot_get_value(left_cs);
+       right_cs_value = bt_clock_snapshot_get_value(right_cs);
+       bt_uuid left_clock_class_uuid, right_clock_class_uuid;
+
+       ret = left_cs_value - right_cs_value;
+       if (ret != 0) {
+               goto end;
+       }
+
+       left_clock_class = bt_clock_snapshot_borrow_clock_class_const(left_cs);
+       right_clock_class = bt_clock_snapshot_borrow_clock_class_const(right_cs);
+
+       left_clock_class_uuid = bt_clock_class_get_uuid(left_clock_class);
+       right_clock_class_uuid = bt_clock_class_get_uuid(right_clock_class);
+
+       if (left_clock_class_uuid && !right_clock_class_uuid) {
+               ret = -1;
+               goto end;
+       } else if (!left_clock_class_uuid && right_clock_class_uuid) {
+               ret = 1;
+               goto end;
+       } else if (left_clock_class_uuid && right_clock_class_uuid) {
+               ret = bt_uuid_compare(left_clock_class_uuid,
+                       right_clock_class_uuid);
+               if (ret != 0) {
+                       goto end;
+               }
+       }
+
+
+       left_clock_class_name = bt_clock_class_get_name(left_clock_class);
+       right_clock_class_name = bt_clock_class_get_name(right_clock_class);
+
+       if (left_clock_class_name && !right_clock_class_name) {
+               ret = -1;
+               goto end;
+       } else if (!left_clock_class_name && right_clock_class_name) {
+               ret = 1;
+               goto end;
+       } else if (left_clock_class_name && right_clock_class_name) {
+               ret = strcmp(left_clock_class_name, right_clock_class_name);
+               if (ret != 0) {
+                       goto end;
+               }
+       }
+
+       left_freq = bt_clock_class_get_frequency(left_clock_class);
+       right_freq = bt_clock_class_get_frequency(right_clock_class);
+
+       ret = right_freq - left_freq;
+       if (ret != 0) {
+               goto end;
+       }
+
+       left_prec = bt_clock_class_get_precision(left_clock_class);
+       right_prec = bt_clock_class_get_precision(right_clock_class);
+
+       ret = right_prec - left_prec;
+       if (ret != 0) {
+               goto end;
+       }
+
+end:
+       return ret;
+}
+
+static
+const bt_stream *borrow_stream(const bt_message *msg)
+{
+       bt_message_type msg_type = bt_message_get_type(msg);
+       const bt_stream *stream = NULL;
+       const bt_packet *packet = NULL;
+       const bt_event *event = NULL;
+
+       switch (msg_type) {
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+               stream = bt_message_stream_beginning_borrow_stream_const(msg);
+               break;
+       case BT_MESSAGE_TYPE_STREAM_END:
+               stream = bt_message_stream_end_borrow_stream_const(msg);
+               break;
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+               packet = bt_message_packet_beginning_borrow_packet_const(msg);
+               stream = bt_packet_borrow_stream_const(packet);
+               break;
+       case BT_MESSAGE_TYPE_PACKET_END:
+               packet = bt_message_packet_end_borrow_packet_const(msg);
+               stream = bt_packet_borrow_stream_const(packet);
+               break;
+       case BT_MESSAGE_TYPE_EVENT:
+               event = bt_message_event_borrow_event_const(msg);
+               stream = bt_event_borrow_stream_const(event);
+               break;
+       case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+               stream = bt_message_discarded_events_borrow_stream_const(msg);
+               break;
+       case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+               stream = bt_message_discarded_packets_borrow_stream_const(msg);
+               break;
+       case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+               goto end;
+       default:
+               abort();
+       }
+
+end:
+       return stream;
+}
+
+static
+const bt_trace *borrow_trace(const bt_message *msg)
+{
+       const bt_trace *trace = NULL;
+       const bt_stream *stream = NULL;
+
+       stream = borrow_stream(msg);
+       if (stream) {
+               trace = bt_stream_borrow_trace_const(stream);
+       }
+
+       return trace;
+}
+
+static
+int compare_messages_by_trace_name(struct messages_to_compare *msgs)
+{
+       int ret = 0;
+       const char *left_trace_name = NULL, *right_trace_name = NULL;
+
+       if (msgs->left.trace && !msgs->right.trace) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!msgs->left.trace && msgs->right.trace) {
+               ret = 1;
+               goto end;
+       }
+
+       if (!msgs->left.trace && !msgs->right.trace) {
+               ret = 0;
+               goto end;
+       }
+
+       left_trace_name = bt_trace_get_name(msgs->left.trace);
+       right_trace_name = bt_trace_get_name(msgs->right.trace);
+
+       if (left_trace_name && !right_trace_name) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!left_trace_name && right_trace_name) {
+               ret = 1;
+               goto end;
+       }
+
+       if (!left_trace_name && !right_trace_name) {
+               ret = 0;
+               goto end;
+       }
+
+       ret = strcmp(left_trace_name, right_trace_name);
+end:
+       return ret;
+}
+
+static
+int compare_messages_by_trace_uuid(struct messages_to_compare *msgs)
+{
+       int ret = 0;
+       bt_uuid left_trace_uuid = NULL, right_trace_uuid = NULL;
+
+       if (msgs->left.trace && !msgs->right.trace) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!msgs->left.trace && msgs->right.trace) {
+               ret = 1;
+               goto end;
+       }
+
+       if (!msgs->left.trace && !msgs->right.trace) {
+               ret = 0;
+               goto end;
+       }
+
+       left_trace_uuid = bt_trace_get_uuid(msgs->left.trace);
+       right_trace_uuid = bt_trace_get_uuid(msgs->right.trace);
+
+       if (left_trace_uuid && !right_trace_uuid) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!left_trace_uuid && right_trace_uuid) {
+               ret = 1;
+               goto end;
+       }
+
+       if (!left_trace_uuid && !right_trace_uuid) {
+               ret = 0;
+               goto end;
+       }
+
+       ret = bt_uuid_compare(left_trace_uuid, right_trace_uuid);
+end:
+       return ret;
+}
+
+static
+int compare_messages_by_stream_class_id(struct messages_to_compare *msgs)
+{
+       int ret = 0;
+       uint64_t left_stream_class_id = 0, right_stream_class_id = 0;
+
+       if (msgs->left.stream && !msgs->right.stream) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!msgs->left.stream && msgs->right.stream) {
+               ret = 1;
+               goto end;
+       }
+
+       if (!msgs->left.stream && !msgs->right.stream) {
+               ret = 0;
+               goto end;
+       }
+
+       left_stream_class_id = bt_stream_class_get_id(
+               bt_stream_borrow_class_const(msgs->left.stream));
+
+       right_stream_class_id = bt_stream_class_get_id(
+               bt_stream_borrow_class_const(msgs->right.stream));
+
+       if (left_stream_class_id == right_stream_class_id) {
+               ret = 0;
+               goto end;
+       }
+
+       ret = (left_stream_class_id < right_stream_class_id) ? -1 : 1;
+
+end:
+       return ret;
+}
+
+static
+int compare_messages_by_stream_id(struct messages_to_compare *msgs)
+{
+       int ret = 0;
+       uint64_t left_stream_id = 0, right_stream_id = 0;
+
+       if (msgs->left.stream && !msgs->right.stream) {
+               ret = -1;
+               goto end;
+       }
+
+       if (!msgs->left.stream && msgs->right.stream) {
+               ret = 1;
+               goto end;
+       }
+
+       if (!msgs->left.stream && !msgs->right.stream) {
+               ret = 0;
+               goto end;
+       }
+
+       left_stream_id = bt_stream_get_id(msgs->left.stream);
+       right_stream_id = bt_stream_get_id(msgs->right.stream);
+
+       if (left_stream_id == right_stream_id) {
+               ret = 0;
+               goto end;
+       }
+
+       ret = (left_stream_id < right_stream_id) ? -1 : 1;
+
+end:
+       return ret;
+}
+
+static
+int compare_messages_same_type(struct messages_to_compare *msgs)
+{
+       int ret = 0;
+
+       /*
+        * Both messages are of the same type, we must compare characterics of
+        * the messages such as the attributes of the event in a event message.
+        */
+       BT_ASSERT(bt_message_get_type(msgs->left.msg) ==
+               bt_message_get_type(msgs->right.msg));
+
+       switch (bt_message_get_type(msgs->left.msg)) {
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+       case BT_MESSAGE_TYPE_STREAM_END:
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+
+               break;
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+
+               break;
+       case BT_MESSAGE_TYPE_PACKET_END:
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+
+               break;
+       case BT_MESSAGE_TYPE_EVENT:
+       {
+               const bt_event *left_event, *right_event;
+               left_event = bt_message_event_borrow_event_const(msgs->left.msg);
+               right_event = bt_message_event_borrow_event_const(msgs->right.msg);
+
+               ret = compare_events(left_event, right_event);
+               if (ret) {
+                       goto end;
+               }
+
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+               break;
+       }
+       case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+       {
+               const bt_stream_class *left_stream_class;
+               bt_property_availability left_event_count_avail,
+                                        right_event_count_avail;
+               uint64_t left_event_count, right_event_count;
+
+               /*
+                * Compare streams first to check if there is a
+                * mismatch about discarded event related configuration
+                * in the stream class.
+                */
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+
+               left_stream_class = bt_stream_borrow_class_const(msgs->left.stream);
+               if (bt_stream_class_discarded_events_have_default_clock_snapshots(
+                               left_stream_class)) {
+                       const bt_clock_snapshot *left_beg_cs =
+                               bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msgs->left.msg);
+                       const bt_clock_snapshot *right_beg_cs =
+                               bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msgs->right.msg);
+                       const bt_clock_snapshot *left_end_cs =
+                               bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msgs->left.msg);
+                       const bt_clock_snapshot *right_end_cs =
+                               bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msgs->right.msg);
+
+                       ret = compare_clock_snapshots_and_clock_classes(
+                               left_beg_cs, right_beg_cs);
+                       if (ret) {
+                               goto end;
+                       }
+
+                       ret = compare_clock_snapshots_and_clock_classes(
+                               left_end_cs, right_end_cs);
+                       if (ret) {
+                               goto end;
+                       }
+               }
+
+               left_event_count_avail =
+                       bt_message_discarded_events_get_count(
+                               msgs->left.msg, &left_event_count);
+               right_event_count_avail =
+                       bt_message_discarded_events_get_count(
+                               msgs->right.msg, &right_event_count);
+               if (left_event_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       right_event_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
+                       ret = left_event_count - right_event_count;
+                       if (ret != 0) {
+                               goto end;
+                       }
+               } else if (left_event_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       right_event_count_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
+                       ret = -1;
+                       goto end;
+               } else if (left_event_count_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE &&
+                       right_event_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
+                       ret = 1;
+                       goto end;
+               }
+
+               break;
+       }
+       case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+       {
+               const bt_stream_class *left_stream_class;
+               bt_property_availability left_packet_count_avail,
+                                        right_packet_count_avail;
+               uint64_t left_packet_count, right_packet_count;
+
+               /*
+                * Compare streams first to check if there is a
+                * mismatch about discarded packets related
+                * configuration in the stream class.
+                */
+               ret = compare_streams(msgs->left.stream, msgs->right.stream);
+               if (ret) {
+                       goto end;
+               }
+
+               left_stream_class = bt_stream_borrow_class_const(msgs->left.stream);
+
+               if (bt_stream_class_discarded_packets_have_default_clock_snapshots(
+                               left_stream_class)) {
+                       const bt_clock_snapshot *left_beg_cs =
+                               bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msgs->left.msg);
+                       const bt_clock_snapshot *right_beg_cs =
+                               bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msgs->right.msg);
+                       const bt_clock_snapshot *left_end_cs =
+                               bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msgs->left.msg);
+                       const bt_clock_snapshot *right_end_cs =
+                               bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msgs->right.msg);
+
+                       ret = compare_clock_snapshots_and_clock_classes(
+                               left_beg_cs, right_beg_cs);
+                       if (ret) {
+                               goto end;
+                       }
+
+                       ret = compare_clock_snapshots_and_clock_classes(
+                               left_end_cs, right_end_cs);
+                       if (ret) {
+                               goto end;
+                       }
+               }
+
+               left_packet_count_avail = bt_message_discarded_packets_get_count(
+                       msgs->left.msg, &left_packet_count);
+               right_packet_count_avail = bt_message_discarded_packets_get_count(
+                       msgs->right.msg, &right_packet_count);
+               if (left_packet_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       right_packet_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
+                       ret = left_packet_count - right_packet_count;
+                       if (ret != 0) {
+                               goto end;
+                       }
+               } else if (left_packet_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       right_packet_count_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
+                       ret = -1;
+                       goto end;
+               } else if (left_packet_count_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE &&
+                       right_packet_count_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
+                       ret = 1;
+                       goto end;
+               }
+
+               break;
+       }
+       case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+       {
+               const bt_clock_snapshot *left_cs =
+                       bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(msgs->left.msg);
+               const bt_clock_snapshot *right_cs =
+                       bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(msgs->right.msg);
+
+               ret = compare_clock_snapshots_and_clock_classes(
+                       left_cs, right_cs);
+               if (ret != 0) {
+                       goto end;
+               }
+
+               break;
+       }
+       default:
+               abort();
+       }
+
+end:
+       return ret;
+}
+
+static
+int compare_messages(const bt_message *left_msg, const bt_message *right_msg)
+{
+       int ret = 0;
+       struct messages_to_compare msgs;
+
+       BT_ASSERT(left_msg != right_msg);
+
+       msgs.left.msg = left_msg;
+       msgs.left.trace = borrow_trace(left_msg);
+       msgs.left.stream = borrow_stream(left_msg);
+
+       msgs.right.msg = right_msg;
+       msgs.right.trace = borrow_trace(right_msg);
+       msgs.right.stream = borrow_stream(right_msg);
+
+       /* Same timestamp: compare trace names. */
+       ret = compare_messages_by_trace_name(&msgs);
+       if (ret) {
+               goto end;
+       }
+
+       /* Same timestamp and trace name: compare trace UUIDs. */
+       ret = compare_messages_by_trace_uuid(&msgs);
+       if (ret) {
+               goto end;
+       }
+
+       /*
+        * Same timestamp, trace name, and trace UUID: compare stream class
+        * IDs.
+        */
+       ret = compare_messages_by_stream_class_id(&msgs);
+       if (ret) {
+               goto end;
+       }
+
+       /*
+        * Same timestamp, trace name, trace UUID, and stream class ID: compare
+        * stream IDs.
+        */
+       ret = compare_messages_by_stream_id(&msgs);
+       if (ret) {
+               goto end;
+       }
+
+       if (bt_message_get_type(msgs.left.msg) !=
+                       bt_message_get_type(msgs.right.msg)) {
+               /*
+                * The messages are of different type, we order (arbitrarily)
+                * in the following way:
+                * SB < PB < EV < DE < MI < PE < DP < SE
+                */
+               ret = compare_messages_by_type(&msgs);
+               if (ret) {
+                       goto end;
+               }
+       } else {
+               /* The messages are of the same type. */
+               ret = compare_messages_same_type(&msgs);
+               if (ret) {
+                       goto end;
+               }
+       }
+
+end:
+       return ret;
+}
+
 /*
  * This function finds the youngest available message amongst the
  * non-ended upstream message iterators and returns the upstream
@@ -943,11 +1832,44 @@ muxer_msg_iter_youngest_upstream_msg_iter(
                        goto end;
                }
 
-               if (msg_ts_ns <= youngest_ts_ns) {
+               if (msg_ts_ns < youngest_ts_ns) {
                        *muxer_upstream_msg_iter =
                                cur_muxer_upstream_msg_iter;
                        youngest_ts_ns = msg_ts_ns;
                        *ts_ns = youngest_ts_ns;
+               } else if (msg_ts_ns == youngest_ts_ns) {
+                       /*
+                        * The currently selected message to be sent downstream
+                        * next has the exact same timestamp that of the
+                        * current candidate message. We must break the tie
+                        * in a predictable manner.
+                        */
+                       const bt_message *selected_msg = g_queue_peek_head(
+                               (*muxer_upstream_msg_iter)->msgs);
+                       BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
+
+                       /*
+                        * Order the messages in an arbitrary but determinitic
+                        * way.
+                        */
+                       ret = compare_messages(msg, selected_msg);
+                       if (ret < 0) {
+                               /*
+                                * The `msg` should go first. Update the next
+                                * iterator and the current timestamp.
+                                */
+                               *muxer_upstream_msg_iter =
+                                       cur_muxer_upstream_msg_iter;
+                               youngest_ts_ns = msg_ts_ns;
+                               *ts_ns = youngest_ts_ns;
+                       } else if (ret == 0) {
+                               /* Unable to pick which one should go first. */
+                               BT_COMP_LOGW("Cannot deterministically pick next upstream message iterator because they have identical next messages: "
+                                       "muxer-upstream-msg-iter-wrap-addr=%p"
+                                       "cur-muxer-upstream-msg-iter-wrap-addr=%p",
+                                       *muxer_upstream_msg_iter,
+                                       cur_muxer_upstream_msg_iter);
+                       }
                }
        }
 
This page took 0.034003 seconds and 4 git commands to generate.