lib: make precondition failure messages more clear on message creation

[babeltrace.git] / lib / graph / message / packet.c

diff --git a/lib/graph/message/packet.c b/lib/graph/message/packet.c
index 87c241e0e120c373ece2c4cd14be11906da84364..9ed9a0c47f2eb3054553feb4402dab82f0d6d504 100644 (file)
--- a/lib/graph/message/packet.c
+++ b/lib/graph/message/packet.c
@@ -22,24 +22,24 @@
  */
 
 #define BT_LOG_TAG "MSG-PACKET"
-#include <babeltrace/lib-logging-internal.h>
-
-#include <babeltrace/compiler-internal.h>
-#include <babeltrace/trace-ir/packet.h>
-#include <babeltrace/trace-ir/packet-internal.h>
-#include <babeltrace/trace-ir/stream-class.h>
-#include <babeltrace/trace-ir/stream.h>
-#include <babeltrace/trace-ir/stream-internal.h>
-#include <babeltrace/trace-ir/stream-class-internal.h>
-#include <babeltrace/graph/graph-internal.h>
-#include <babeltrace/graph/message-packet-beginning-const.h>
-#include <babeltrace/graph/message-packet-end-const.h>
-#include <babeltrace/graph/message-packet-beginning.h>
-#include <babeltrace/graph/message-packet-end.h>
-#include <babeltrace/graph/message-packet-internal.h>
-#include <babeltrace/assert-internal.h>
-#include <babeltrace/assert-pre-internal.h>
-#include <babeltrace/object-internal.h>
+#include <babeltrace2/lib-logging-internal.h>
+
+#include <babeltrace2/compiler-internal.h>
+#include <babeltrace2/trace-ir/packet.h>
+#include <babeltrace2/trace-ir/packet-internal.h>
+#include <babeltrace2/trace-ir/stream-class.h>
+#include <babeltrace2/trace-ir/stream.h>
+#include <babeltrace2/trace-ir/stream-internal.h>
+#include <babeltrace2/trace-ir/stream-class-internal.h>
+#include <babeltrace2/graph/graph-internal.h>
+#include <babeltrace2/graph/message-packet-beginning-const.h>
+#include <babeltrace2/graph/message-packet-end-const.h>
+#include <babeltrace2/graph/message-packet-beginning.h>
+#include <babeltrace2/graph/message-packet-end.h>
+#include <babeltrace2/graph/message-packet-internal.h>
+#include <babeltrace2/assert-internal.h>
+#include <babeltrace2/assert-pre-internal.h>
+#include <babeltrace2/object-internal.h>
 #include <inttypes.h>
 
 static inline
@@ -87,6 +87,7 @@ struct bt_message *create_packet_message(
        struct bt_message_packet *message = NULL;
        struct bt_stream *stream;
        struct bt_stream_class *stream_class;
+       bool need_cs;
 
        BT_ASSERT(msg_iter);
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
@@ -94,11 +95,28 @@ struct bt_message *create_packet_message(
        BT_ASSERT(stream);
        stream_class = bt_stream_borrow_class(stream);
        BT_ASSERT(stream_class);
-       BT_ASSERT_PRE((with_cs && stream_class->default_clock_class) ||
-               (!with_cs && !stream_class->default_clock_class),
-               "Creating a packet message with a default clock snapshot, but without "
-               "a default clock class, or without a default clock snapshot, "
-               "but with a default clock class: ",
+
+       if (pool == &msg_iter->graph->packet_begin_msg_pool) {
+               need_cs = stream_class->packets_have_beginning_default_clock_snapshot;
+       } else {
+               need_cs = stream_class->packets_have_end_default_clock_snapshot;
+       }
+
+       /*
+        * `packet_has_default_clock_snapshot` implies that the stream
+        * class has a default clock class (precondition).
+        */
+       BT_ASSERT_PRE(need_cs ? with_cs : true,
+               "Unexpected stream class configuration when creating "
+               "a packet beginning or end message: "
+               "a default clock snapshot is needed, but none was provided: "
+               "%![stream-]+s, %![sc-]+S, with-cs=%d, "
+               "cs-val=%" PRIu64,
+               stream, stream_class, with_cs, raw_value);
+       BT_ASSERT_PRE(!need_cs ? !with_cs : true,
+               "Unexpected stream class configuration when creating "
+               "a packet beginning or end message: "
+               "no default clock snapshot is needed, but one was provided: "
                "%![stream-]+s, %![sc-]+S, with-cs=%d, "
                "cs-val=%" PRIu64,
                stream, stream_class, with_cs, raw_value);
@@ -285,10 +303,9 @@ const struct bt_packet *bt_message_packet_end_borrow_packet_const(
 }
 
 static inline
-enum bt_clock_snapshot_state
+const struct bt_clock_snapshot *
 borrow_packet_message_default_clock_snapshot_const(
-               const struct bt_message *message,
-               const struct bt_clock_snapshot **snapshot)
+               const struct bt_message *message)
 {
        struct bt_message_packet *packet_msg = (void *) message;
 
@@ -297,31 +314,25 @@ borrow_packet_message_default_clock_snapshot_const(
                "Message's stream's class has no default clock class: "
                "%![msg-]+n, %![sc-]+S",
                message, packet_msg->packet->stream->class);
-       BT_ASSERT_PRE_NON_NULL(snapshot, "Clock snapshot (output)");
-       *snapshot = packet_msg->default_cs;
-       return BT_CLOCK_SNAPSHOT_STATE_KNOWN;
+       return packet_msg->default_cs;
 }
 
-enum bt_clock_snapshot_state
+const struct bt_clock_snapshot *
 bt_message_packet_beginning_borrow_default_clock_snapshot_const(
-               const struct bt_message *msg,
-               const struct bt_clock_snapshot **snapshot)
+               const struct bt_message *msg)
 {
        BT_ASSERT_PRE_NON_NULL(msg, "Message");
        BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING);
-       return borrow_packet_message_default_clock_snapshot_const(
-               msg, snapshot);
+       return borrow_packet_message_default_clock_snapshot_const(msg);
 }
 
-enum bt_clock_snapshot_state
+const struct bt_clock_snapshot *
 bt_message_packet_end_borrow_default_clock_snapshot_const(
-               const struct bt_message *msg,
-               const struct bt_clock_snapshot **snapshot)
+               const struct bt_message *msg)
 {
        BT_ASSERT_PRE_NON_NULL(msg, "Message");
        BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END);
-       return borrow_packet_message_default_clock_snapshot_const(
-               msg, snapshot);
+       return borrow_packet_message_default_clock_snapshot_const(msg);
 }
 
 static inline