Document libbabeltrace2's C API

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

diff --git a/src/lib/trace-ir/clock-snapshot.c b/src/lib/trace-ir/clock-snapshot.c
index 944532a2359e8acce1d40593a2ca05f7760ecc7c..9d20c9c1a0ff69e7b4e378702155224bc8d509e7 100644 (file)
--- a/src/lib/trace-ir/clock-snapshot.c
+++ b/src/lib/trace-ir/clock-snapshot.c
@@ -24,20 +24,22 @@
 #include "lib/logging.h"
 
 #include "lib/assert-pre.h"
-#include "compat/uuid.h"
+#include "common/uuid.h"
 #include "clock-class.h"
 #include "clock-snapshot.h"
-#include <babeltrace2/trace-ir/clock-snapshot-const.h>
+#include <babeltrace2/trace-ir/clock-snapshot.h>
 #include "compat/compiler.h"
 #include <babeltrace2/types.h>
 #include "compat/string.h"
 #include <inttypes.h>
 #include "lib/object.h"
 #include "common/assert.h"
+#include "lib/func-status.h"
 
 BT_HIDDEN
 void bt_clock_snapshot_destroy(struct bt_clock_snapshot *clock_snapshot)
 {
+       BT_ASSERT(clock_snapshot);
        BT_LIB_LOGD("Destroying clock snapshot: %!+k", clock_snapshot);
        BT_OBJECT_PUT_REF_AND_RESET(clock_snapshot->clock_class);
        g_free(clock_snapshot);
@@ -54,13 +56,14 @@ struct bt_clock_snapshot *bt_clock_snapshot_new(
                clock_class);
        ret = g_new0(struct bt_clock_snapshot, 1);
        if (!ret) {
-               BT_LOGE_STR("Failed to allocate one clock snapshot.");
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to allocate one clock snapshot.");
                goto end;
        }
 
        bt_object_init_unique(&ret->base);
        ret->clock_class = clock_class;
-       bt_object_get_no_null_check(clock_class);
+       bt_object_get_ref_no_null_check(clock_class);
        bt_clock_class_freeze(clock_class);
        BT_LIB_LOGD("Created clock snapshot object: %!+k", ret);
 
@@ -74,25 +77,18 @@ struct bt_clock_snapshot *bt_clock_snapshot_create(
 {
        struct bt_clock_snapshot *clock_snapshot = NULL;
 
-       BT_ASSERT(clock_class);
+       BT_ASSERT_DBG(clock_class);
        clock_snapshot = bt_object_pool_create_object(&clock_class->cs_pool);
        if (!clock_snapshot) {
-               BT_LIB_LOGE("Cannot allocate one clock snapshot from clock class's clock snapshot pool: "
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Cannot allocate one clock snapshot from clock class's clock snapshot pool: "
                        "%![cc-]+K", clock_class);
-               goto error;
+               goto end;
        }
 
        if (G_LIKELY(!clock_snapshot->clock_class)) {
                clock_snapshot->clock_class = clock_class;
-               bt_object_get_no_null_check(clock_class);
-       }
-
-       goto end;
-
-error:
-       if (clock_snapshot) {
-               bt_clock_snapshot_recycle(clock_snapshot);
-               clock_snapshot = NULL;
+               bt_object_get_ref_no_null_check(clock_class);
        }
 
 end:
@@ -104,7 +100,7 @@ void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot)
 {
        struct bt_clock_class *clock_class;
 
-       BT_ASSERT(clock_snapshot);
+       BT_ASSERT_DBG(clock_snapshot);
        BT_LIB_LOGD("Recycling clock snapshot: %!+k", clock_snapshot);
 
        /*
@@ -131,7 +127,7 @@ void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot)
         */
        bt_clock_snapshot_reset(clock_snapshot);
        clock_class = clock_snapshot->clock_class;
-       BT_ASSERT(clock_class);
+       BT_ASSERT_DBG(clock_class);
        clock_snapshot->clock_class = NULL;
        bt_object_pool_recycle_object(&clock_class->cs_pool, clock_snapshot);
        bt_object_put_ref(clock_class);
@@ -140,28 +136,31 @@ void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot)
 uint64_t bt_clock_snapshot_get_value(
                const struct bt_clock_snapshot *clock_snapshot)
 {
-       BT_ASSERT_PRE_NON_NULL(clock_snapshot, "Clock snapshot");
-       BT_ASSERT_PRE(clock_snapshot->is_set,
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_snapshot, "Clock snapshot");
+       BT_ASSERT_PRE_DEV(clock_snapshot->is_set,
                "Clock snapshot is not set: %!+k", clock_snapshot);
        return clock_snapshot->value_cycles;
 }
 
-enum bt_clock_snapshot_status bt_clock_snapshot_get_ns_from_origin(
+enum bt_clock_snapshot_get_ns_from_origin_status
+bt_clock_snapshot_get_ns_from_origin(
                const struct bt_clock_snapshot *clock_snapshot,
                int64_t *ret_value_ns)
 {
-       int ret = BT_CLOCK_SNAPSHOT_STATUS_OK;
+       int ret = BT_FUNC_STATUS_OK;
 
-       BT_ASSERT_PRE_NON_NULL(clock_snapshot, "Clock snapshot");
-       BT_ASSERT_PRE_NON_NULL(ret_value_ns, "Value (ns) (output)");
-       BT_ASSERT_PRE(clock_snapshot->is_set,
+       BT_ASSERT_PRE_DEV_NO_ERROR();
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_snapshot, "Clock snapshot");
+       BT_ASSERT_PRE_DEV_NON_NULL(ret_value_ns, "Value (ns) (output)");
+       BT_ASSERT_PRE_DEV(clock_snapshot->is_set,
                "Clock snapshot is not set: %!+k", clock_snapshot);
 
        if (clock_snapshot->ns_from_origin_overflows) {
-               BT_LIB_LOGD("Clock snapshot, once converted to nanoseconds from origin, "
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Clock snapshot, once converted to nanoseconds from origin, "
                        "overflows the signed 64-bit integer range: "
                        "%![cs-]+k", clock_snapshot);
-               ret = BT_CLOCK_SNAPSHOT_STATUS_OVERFLOW;
+               ret = BT_FUNC_STATUS_OVERFLOW_ERROR;
                goto end;
        }
 
@@ -174,6 +173,6 @@ end:
 const struct bt_clock_class *bt_clock_snapshot_borrow_clock_class_const(
                const struct bt_clock_snapshot *clock_snapshot)
 {
-       BT_ASSERT_PRE_NON_NULL(clock_snapshot, "Clock snapshot");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_snapshot, "Clock snapshot");
        return clock_snapshot->clock_class;
 }