Document libbabeltrace2's C API

[babeltrace.git] / src / lib / trace-ir / packet.c

diff --git a/src/lib/trace-ir/packet.c b/src/lib/trace-ir/packet.c
index 585ed48b15ccafc3d1eb0281b4f1b44e95006044..388e196f268f6b0451433ceab8099277b33a1bf8 100644 (file)
--- a/src/lib/trace-ir/packet.c
+++ b/src/lib/trace-ir/packet.c
@@ -20,11 +20,10 @@
  * SOFTWARE.
  */
 
-#define BT_LOG_TAG "PACKET"
-#include "lib/lib-logging.h"
+#define BT_LOG_TAG "LIB/PACKET"
+#include "lib/logging.h"
 
 #include "lib/assert-pre.h"
-#include <babeltrace2/trace-ir/packet-const.h>
 #include <babeltrace2/trace-ir/packet.h>
 #include <babeltrace2/trace-ir/trace.h>
 #include <babeltrace2/trace-ir/stream-class.h>
@@ -32,6 +31,7 @@
 #include "lib/object.h"
 #include "common/assert.h"
 #include <inttypes.h>
+#include <stdbool.h>
 
 #include "field.h"
 #include "field-wrapper.h"
@@ -39,13 +39,11 @@
 #include "stream-class.h"
 #include "stream.h"
 #include "trace.h"
-
-#define BT_ASSERT_PRE_PACKET_HOT(_packet) \
-       BT_ASSERT_PRE_HOT((_packet), "Packet", ": %!+a", (_packet))
+#include "lib/func-status.h"
 
 struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
 {
-       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_DEV_NON_NULL(packet, "Packet");
        return packet->stream;
 }
 
@@ -57,7 +55,7 @@ const struct bt_stream *bt_packet_borrow_stream_const(
 
 struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet)
 {
-       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_DEV_NON_NULL(packet, "Packet");
        return packet->context_field ? packet->context_field->field : NULL;
 }
 
@@ -146,7 +144,7 @@ void bt_packet_recycle(struct bt_packet *packet)
        BT_ASSERT(stream);
        packet->stream = NULL;
        bt_object_pool_recycle_object(&stream->packet_pool, packet);
-       bt_object_put_no_null_check(&stream->base);
+       bt_object_put_ref_no_null_check(&stream->base);
 }
 
 BT_HIDDEN
@@ -181,14 +179,15 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
        BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream);
        packet = g_new0(struct bt_packet, 1);
        if (!packet) {
-               BT_LOGE_STR("Failed to allocate one packet object.");
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to allocate one packet object.");
                goto error;
        }
 
        bt_object_init_shared(&packet->base,
                (bt_object_release_func) bt_packet_recycle);
        packet->stream = stream;
-       bt_object_get_no_null_check(stream);
+       bt_object_get_ref_no_null_check(stream);
        trace_class = bt_stream_class_borrow_trace_class_inline(stream->class);
        BT_ASSERT(trace_class);
 
@@ -198,7 +197,8 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
                        &stream->class->packet_context_field_pool,
                        stream->class->packet_context_fc);
                if (!packet->context_field) {
-                       BT_LOGE_STR("Cannot create packet context field wrapper.");
+                       BT_LIB_LOGE_APPEND_CAUSE(
+                               "Cannot create packet context field wrapper.");
                        goto error;
                }
        }
@@ -218,17 +218,22 @@ struct bt_packet *bt_packet_create(const struct bt_stream *c_stream)
        struct bt_packet *packet = NULL;
        struct bt_stream *stream = (void *) c_stream;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(stream, "Stream");
+       BT_ASSERT_PRE(stream->class->supports_packets,
+               "Stream class does not support packets: %![sc-]+S",
+               stream->class);
        packet = bt_object_pool_create_object(&stream->packet_pool);
-       if (unlikely(!packet)) {
-               BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
+       if (G_UNLIKELY(!packet)) {
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Cannot allocate one packet from stream's packet pool: "
                        "%![stream-]+s", stream);
                goto end;
        }
 
-       if (likely(!packet->stream)) {
+       if (G_LIKELY(!packet->stream)) {
                packet->stream = stream;
-               bt_object_get_no_null_check_no_parent_check(
+               bt_object_get_ref_no_null_check_no_parent_check(
                        &packet->stream->base);
        }
 
@@ -236,34 +241,6 @@ end:
        return (void *) packet;
 }
 
-enum bt_packet_status bt_packet_move_context_field(struct bt_packet *packet,
-               struct bt_packet_context_field *context_field)
-{
-       struct bt_stream_class *stream_class;
-       struct bt_field_wrapper *field_wrapper = (void *) context_field;
-
-       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
-       BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
-       BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
-       stream_class = packet->stream->class;
-       BT_ASSERT_PRE(stream_class->packet_context_fc,
-               "Stream class has no packet context field class: %!+S",
-               stream_class);
-       BT_ASSERT_PRE(field_wrapper->field->class ==
-               stream_class->packet_context_fc,
-               "Unexpected packet context field's class: "
-               "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
-               stream_class->packet_context_fc);
-
-       /* Recycle current context field: always exists */
-       BT_ASSERT(packet->context_field);
-       recycle_context_field(packet->context_field, stream_class);
-
-       /* Move new field */
-       packet->context_field = field_wrapper;
-       return BT_PACKET_STATUS_OK;
-}
-
 void bt_packet_get_ref(const struct bt_packet *packet)
 {
        bt_object_get_ref(packet);