Fix: msg-iter.c: create packet message with correct function

Issue
=====
With CTF metadata having a stream class with:

* A packet context not having `timestamp_begin` or `timestamp_end`
  fields.

* An event header having a field mapped to a clock class.

The result is a Babeltrace trace IR stream class with a default clock
class.

However the decoding process fails because, without `timestamp_begin`
and `timestamp_end` packet context fields, the current packet's
beginning and end times are never set, thus we call
bt_message_packet_beginning_create() and bt_message_packet_end_create()
to create the messages. This is a precondition break because when a
stream class has a default clock class, all the packet beginning, packet
end, and event messages must have default clock snapshots.

Solution
========
In create_msg_packet_beginning(), if the current packet's beginning time
property is not set, use the last packet's end time or 0 if this is
not set either.

In create_msg_packet_end(), if the current packet's end time property is
not set, use the current clock value, and set it as the current packet's
end time property so that it becomes the last packet's end time property
in bt_msg_iter_switch_packet().

Known drawbacks
===============
With this fix, the first packet beginning message's clock snapshot's raw
value is 0. This is probably not ideal, as we cannot know if there was
any stream activity between 0 and the first event's time. The real fix
should probably be to use the first event's time, but this would require
more work as we would need to decode the first event's header before
calling create_msg_packet_beginning().

It's not a problem to compute the stream intersection, as no messages
are created during the execution of the `trace-info` query, so both
properties, as returned by bt_msg_iter_get_packet_properties(), are not
set. However there's a bug in the `trace-info` query as of this patch:
it does not check if the properties are set or not.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/plugins/ctf/common/msg-iter/msg-iter.c b/plugins/ctf/common/msg-iter/msg-iter.c
index 5cd91179539c7cf0ac7a8578959fa1a2274e7db2..7077d2e7360cb4739a3129508bd06aae49dd0ac6 100644 (file)
--- a/plugins/ctf/common/msg-iter/msg-iter.c
+++ b/plugins/ctf/common/msg-iter/msg-iter.c
@@ -2507,13 +2507,23 @@ void create_msg_packet_beginning(struct bt_msg_iter *notit,
 
        BT_ASSERT(notit->msg_iter);
 
-       if (notit->snapshots.beginning_clock == UINT64_C(-1)) {
+       if (bt_stream_class_borrow_default_clock_class(notit->meta.sc->ir_sc)) {
+               uint64_t value = 0;
+
+               if (notit->snapshots.beginning_clock == UINT64_C(-1)) {
+                       if (notit->prev_packet_snapshots.end_clock != UINT64_C(-1)) {
+                               value = notit->prev_packet_snapshots.end_clock;
+                       }
+               } else {
+                       value = notit->snapshots.beginning_clock;
+               }
+
+
+               msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
+                       notit->msg_iter, notit->packet, value);
+       } else {
                msg = bt_message_packet_beginning_create(notit->msg_iter,
                        notit->packet);
-       } else {
-               msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
-                       notit->msg_iter, notit->packet,
-                       notit->snapshots.beginning_clock);
        }
 
        if (!msg) {
@@ -2545,13 +2555,19 @@ void create_msg_packet_end(struct bt_msg_iter *notit, bt_message **message)
 
        BT_ASSERT(notit->msg_iter);
 
-       if (notit->snapshots.end_clock == UINT64_C(-1)) {
-               msg = bt_message_packet_end_create(notit->msg_iter,
-                       notit->packet);
-       } else {
+       if (bt_stream_class_borrow_default_clock_class(notit->meta.sc->ir_sc)) {
+               if (notit->snapshots.end_clock == UINT64_C(-1)) {
+                       notit->snapshots.end_clock =
+                               notit->default_clock_snapshot;
+               }
+
+               BT_ASSERT(notit->snapshots.end_clock != UINT64_C(-1));
                msg = bt_message_packet_end_create_with_default_clock_snapshot(
                        notit->msg_iter, notit->packet,
                        notit->snapshots.end_clock);
+       } else {
+               msg = bt_message_packet_end_create(notit->msg_iter,
+                       notit->packet);
        }
 
        if (!msg) {