Document libbabeltrace2's C API

[babeltrace.git] / src / lib / graph / message / discarded-items.c

diff --git a/src/lib/graph/message/discarded-items.c b/src/lib/graph/message/discarded-items.c
index b38f8facc0e23e495a4e91033713ac5b48b023f2..e7646377648220e6f57b9ba7d66b163e7c72b2c6 100644 (file)
--- a/src/lib/graph/message/discarded-items.c
+++ b/src/lib/graph/message/discarded-items.c
@@ -23,6 +23,8 @@
 #define BT_LOG_TAG "LIB/MSG-DISCARDED-ITEMS"
 #include "lib/logging.h"
 
+#include <stdbool.h>
+
 #include "lib/assert-pre.h"
 #include "lib/object.h"
 #include "compat/compiler.h"
@@ -32,10 +34,6 @@
 #include "lib/trace-ir/stream.h"
 #include "lib/property.h"
 #include "lib/graph/message/message.h"
-#include <babeltrace2/graph/message-discarded-events.h>
-#include <babeltrace2/graph/message-discarded-events-const.h>
-#include <babeltrace2/graph/message-discarded-packets.h>
-#include <babeltrace2/graph/message-discarded-packets-const.h>
 
 #include "discarded-items.h"
 
@@ -113,14 +111,15 @@ struct bt_message *create_discarded_items_message(
                with_cs, beginning_raw_value, end_raw_value);
        message = g_new0(struct bt_message_discarded_items, 1);
        if (!message) {
-               BT_LOGE_STR("Failed to allocate one discarded items message.");
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to allocate one discarded items message.");
                goto error;
        }
 
        bt_message_init(&message->parent, type,
                destroy_discarded_items_message, NULL);
        message->stream = stream;
-       bt_object_get_no_null_check(message->stream);
+       bt_object_get_ref_no_null_check(message->stream);
 
        if (with_cs) {
                BT_ASSERT(stream_class->default_clock_class);
@@ -161,7 +160,7 @@ struct bt_stream *borrow_discarded_items_message_stream(
 {
        struct bt_message_discarded_items *disc_items_msg = (void *) message;
 
-       BT_ASSERT(message);
+       BT_ASSERT_DBG(message);
        return disc_items_msg->stream;
 }
 
@@ -172,7 +171,7 @@ void set_discarded_items_message_count(struct bt_message *message,
        struct bt_message_discarded_items *disc_items_msg = (void *) message;
 
        BT_ASSERT(message);
-       BT_ASSERT_PRE_HOT(message, "Message", ": %!+n", message);
+       BT_ASSERT_PRE_DEV_HOT(message, "Message", ": %!+n", message);
        bt_property_uint_set(&disc_items_msg->count, count);
 }
 
@@ -182,8 +181,8 @@ enum bt_property_availability get_discarded_items_message_count(
 {
        struct bt_message_discarded_items *disc_items_msg = (void *) message;
 
-       BT_ASSERT_PRE_NON_NULL(count, "Count (output)");
-       BT_ASSERT(message);
+       BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
+       BT_ASSERT_DBG(message);
        *count = disc_items_msg->count.value;
        return disc_items_msg->count.base.avail;
 }
@@ -195,8 +194,8 @@ borrow_discarded_items_message_beginning_default_clock_snapshot_const(
 {
        struct bt_message_discarded_items *disc_items_msg = (void *) message;
 
-       BT_ASSERT(message);
-       BT_ASSERT_PRE(disc_items_msg->stream->class->default_clock_class,
+       BT_ASSERT_DBG(message);
+       BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class,
                "Message's stream's class has no default clock class: "
                "%![msg-]+n, %![sc-]+S",
                message, disc_items_msg->stream->class);
@@ -210,8 +209,8 @@ borrow_discarded_items_message_end_default_clock_snapshot_const(
 {
        struct bt_message_discarded_items *disc_items_msg = (void *) message;
 
-       BT_ASSERT(message);
-       BT_ASSERT_PRE(disc_items_msg->stream->class->default_clock_class,
+       BT_ASSERT_DBG(message);
+       BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class,
                "Message's stream's class has no default clock class: "
                "%![msg-]+n, %![sc-]+S",
                message, disc_items_msg->stream->class);
@@ -222,6 +221,8 @@ struct bt_message *bt_message_discarded_events_create(
                struct bt_self_message_iterator *message_iterator,
                const struct bt_stream *stream)
 {
+       BT_ASSERT_PRE_DEV_NO_ERROR();
+
        return create_discarded_items_message(message_iterator,
                BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
                false, 0, 0);
@@ -232,6 +233,8 @@ struct bt_message *bt_message_discarded_events_create_with_default_clock_snapsho
                const struct bt_stream *stream, uint64_t beginning_raw_value,
                uint64_t end_raw_value)
 {
+       BT_ASSERT_PRE_DEV_NO_ERROR();
+
        return create_discarded_items_message(message_iterator,
                BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
                true, beginning_raw_value, end_raw_value);
@@ -240,8 +243,8 @@ struct bt_message *bt_message_discarded_events_create_with_default_clock_snapsho
 struct bt_stream *bt_message_discarded_events_borrow_stream(
                struct bt_message *message)
 {
-       BT_ASSERT_PRE_NON_NULL(message, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
+       BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
        return borrow_discarded_items_message_stream(message);
 }
 
@@ -257,8 +260,8 @@ const struct bt_clock_snapshot *
 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
                const struct bt_message *msg)
 {
-       BT_ASSERT_PRE_NON_NULL(msg, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
+       BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
        return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
                msg);
 }
@@ -267,8 +270,8 @@ const struct bt_clock_snapshot *
 bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
                const struct bt_message *msg)
 {
-       BT_ASSERT_PRE_NON_NULL(msg, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
+       BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
        return borrow_discarded_items_message_end_default_clock_snapshot_const(
                msg);
 }
@@ -283,8 +286,9 @@ bt_message_discarded_events_borrow_stream_const(const struct bt_message *message
 enum bt_property_availability bt_message_discarded_events_get_count(
                const struct bt_message *message, uint64_t *count)
 {
-       BT_ASSERT_PRE_NON_NULL(message, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
+       BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
+               BT_MESSAGE_TYPE_DISCARDED_EVENTS);
        return get_discarded_items_message_count(message, count);
 }
 
@@ -292,6 +296,8 @@ struct bt_message *bt_message_discarded_packets_create(
                struct bt_self_message_iterator *message_iterator,
                const struct bt_stream *stream)
 {
+       BT_ASSERT_PRE_DEV_NO_ERROR();
+
        return create_discarded_items_message(message_iterator,
                BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
                false, 0, 0);
@@ -302,6 +308,8 @@ struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapsh
                const struct bt_stream *stream, uint64_t beginning_raw_value,
                uint64_t end_raw_value)
 {
+       BT_ASSERT_PRE_DEV_NO_ERROR();
+
        return create_discarded_items_message(message_iterator,
                BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
                true, beginning_raw_value, end_raw_value);
@@ -310,8 +318,9 @@ struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapsh
 struct bt_stream *bt_message_discarded_packets_borrow_stream(
                struct bt_message *message)
 {
-       BT_ASSERT_PRE_NON_NULL(message, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
+       BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
+               BT_MESSAGE_TYPE_DISCARDED_PACKETS);
        return borrow_discarded_items_message_stream(message);
 }
 
@@ -327,8 +336,8 @@ const struct bt_clock_snapshot *
 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
                const struct bt_message *msg)
 {
-       BT_ASSERT_PRE_NON_NULL(msg, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
+       BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
        return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
                msg);
 }
@@ -337,8 +346,8 @@ const struct bt_clock_snapshot *
 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
                const struct bt_message *msg)
 {
-       BT_ASSERT_PRE_NON_NULL(msg, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
+       BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
        return borrow_discarded_items_message_end_default_clock_snapshot_const(
                msg);
 }
@@ -353,8 +362,9 @@ bt_message_discarded_packets_borrow_stream_const(const struct bt_message *messag
 enum bt_property_availability bt_message_discarded_packets_get_count(
                const struct bt_message *message, uint64_t *count)
 {
-       BT_ASSERT_PRE_NON_NULL(message, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
+       BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
+               BT_MESSAGE_TYPE_DISCARDED_PACKETS);
        return get_discarded_items_message_count(message, count);
 }
 
@@ -365,7 +375,7 @@ borrow_discarded_items_message_stream_class_default_clock_class(
 {
        struct bt_message_discarded_items *disc_items_msg = (void *) msg;
 
-       BT_ASSERT(msg);
+       BT_ASSERT_DBG(msg);
        return disc_items_msg->stream->class->default_clock_class;
 }
 
@@ -373,8 +383,8 @@ const struct bt_clock_class *
 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
                const struct bt_message *msg)
 {
-       BT_ASSERT_PRE_NON_NULL(msg, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
+       BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
        return borrow_discarded_items_message_stream_class_default_clock_class(
                msg);
 }
@@ -383,8 +393,8 @@ const struct bt_clock_class *
 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
                const struct bt_message *msg)
 {
-       BT_ASSERT_PRE_NON_NULL(msg, "Message");
-       BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
+       BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
+       BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
        return borrow_discarded_items_message_stream_class_default_clock_class(
                msg);
 }