Clock class API: use status
[babeltrace.git] / lib / trace-ir / clock-class.c
index 4cfd01c852128e46eb178375b28298a6557891d4..273d8f58a544d39b788fb5f7e9750066091bc910 100644 (file)
@@ -1,8 +1,7 @@
 /*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
 
 #include <babeltrace/assert-pre-internal.h>
 #include <babeltrace/compat/uuid-internal.h>
+#include <babeltrace/trace-ir/clock-class-const.h>
+#include <babeltrace/trace-ir/clock-class.h>
 #include <babeltrace/trace-ir/clock-class-internal.h>
-#include <babeltrace/trace-ir/clock-value-internal.h>
+#include <babeltrace/trace-ir/clock-snapshot-internal.h>
 #include <babeltrace/trace-ir/utils-internal.h>
-#include <babeltrace/object.h>
 #include <babeltrace/compiler-internal.h>
 #include <babeltrace/types.h>
 #include <babeltrace/compat/string-internal.h>
@@ -60,15 +60,15 @@ void destroy_clock_class(struct bt_object *obj)
                clock_class->description.value = NULL;
        }
 
-       bt_object_pool_finalize(&clock_class->cv_pool);
+       bt_object_pool_finalize(&clock_class->cs_pool);
        g_free(clock_class);
 }
 
 static
-void free_clock_value(struct bt_clock_value *clock_value,
+void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot,
                struct bt_clock_class *clock_class)
 {
-       bt_clock_value_destroy(clock_value);
+       bt_clock_snapshot_destroy(clock_snapshot);
 }
 
 static inline
@@ -106,7 +106,7 @@ end:
        return;
 }
 
-struct bt_private_clock_class *bt_private_clock_class_create(void)
+struct bt_clock_class *bt_clock_class_create(void)
 {
        int ret;
        struct bt_clock_class *clock_class = NULL;
@@ -135,13 +135,13 @@ struct bt_private_clock_class *bt_private_clock_class_create(void)
        clock_class->frequency = UINT64_C(1000000000);
        clock_class->is_absolute = BT_TRUE;
        set_base_offset(clock_class);
-       ret = bt_object_pool_initialize(&clock_class->cv_pool,
-               (bt_object_pool_new_object_func) bt_clock_value_new,
+       ret = bt_object_pool_initialize(&clock_class->cs_pool,
+               (bt_object_pool_new_object_func) bt_clock_snapshot_new,
                (bt_object_pool_destroy_object_func)
-                       free_clock_value,
+                       free_clock_snapshot,
                clock_class);
        if (ret) {
-               BT_LOGE("Failed to initialize clock value pool: ret=%d",
+               BT_LOGE("Failed to initialize clock snapshot pool: ret=%d",
                        ret);
                goto error;
        }
@@ -153,43 +153,37 @@ error:
        BT_OBJECT_PUT_REF_AND_RESET(clock_class);
 
 end:
-       return (void *) clock_class;
+       return clock_class;
 }
 
-const char *bt_clock_class_get_name(
-               struct bt_clock_class *clock_class)
+const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        return clock_class->name.value;
 }
 
-int bt_private_clock_class_set_name(
-               struct bt_private_clock_class *priv_clock_class,
-               const char *name)
+enum bt_clock_class_status bt_clock_class_set_name(
+               struct bt_clock_class *clock_class, const char *name)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
        g_string_assign(clock_class->name.str, name);
        clock_class->name.value = clock_class->name.str->str;
        BT_LIB_LOGV("Set clock class's name: %!+K", clock_class);
-       return 0;
+       return BT_CLOCK_CLASS_STATUS_OK;
 }
 
-const char *bt_clock_class_get_description(struct bt_clock_class *clock_class)
+const char *bt_clock_class_get_description(
+               const struct bt_clock_class *clock_class)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        return clock_class->description.value;
 }
 
-int bt_private_clock_class_set_description(
-               struct bt_private_clock_class *priv_clock_class,
-               const char *descr)
+enum bt_clock_class_status bt_clock_class_set_description(
+               struct bt_clock_class *clock_class, const char *descr)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_NON_NULL(descr, "Description");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
@@ -197,21 +191,18 @@ int bt_private_clock_class_set_description(
        clock_class->description.value = clock_class->description.str->str;
        BT_LIB_LOGV("Set clock class's description: %!+K",
                clock_class);
-       return 0;
+       return BT_CLOCK_CLASS_STATUS_OK;
 }
 
-uint64_t bt_clock_class_get_frequency(struct bt_clock_class *clock_class)
+uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        return clock_class->frequency;
 }
 
-void bt_private_clock_class_set_frequency(
-               struct bt_private_clock_class *priv_clock_class,
+void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
                uint64_t frequency)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
        BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
@@ -225,18 +216,15 @@ void bt_private_clock_class_set_frequency(
        BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class);
 }
 
-uint64_t bt_clock_class_get_precision(struct bt_clock_class *clock_class)
+uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        return clock_class->precision;
 }
 
-void bt_private_clock_class_set_precision(
-               struct bt_private_clock_class *priv_clock_class,
+void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
                uint64_t precision)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
        BT_ASSERT_PRE(precision != UINT64_C(-1),
@@ -246,7 +234,7 @@ void bt_private_clock_class_set_precision(
        BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class);
 }
 
-void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
+void bt_clock_class_get_offset(const struct bt_clock_class *clock_class,
                int64_t *seconds, uint64_t *cycles)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
@@ -256,12 +244,9 @@ void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
        *cycles = clock_class->offset_cycles;
 }
 
-void bt_private_clock_class_set_offset(
-               struct bt_private_clock_class *priv_clock_class,
+void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
                int64_t seconds, uint64_t cycles)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
        BT_ASSERT_PRE(cycles < clock_class->frequency,
@@ -273,18 +258,15 @@ void bt_private_clock_class_set_offset(
        BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class);
 }
 
-bt_bool bt_clock_class_is_absolute(struct bt_clock_class *clock_class)
+bt_bool bt_clock_class_is_absolute(const struct bt_clock_class *clock_class)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        return (bool) clock_class->is_absolute;
 }
 
-void bt_private_clock_class_set_is_absolute(
-               struct bt_private_clock_class *priv_clock_class,
+void bt_clock_class_set_is_absolute(struct bt_clock_class *clock_class,
                bt_bool is_absolute)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
        clock_class->is_absolute = (bool) is_absolute;
@@ -292,18 +274,15 @@ void bt_private_clock_class_set_is_absolute(
                clock_class);
 }
 
-bt_uuid bt_clock_class_get_uuid(struct bt_clock_class *clock_class)
+bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        return clock_class->uuid.value;
 }
 
-void bt_private_clock_class_set_uuid(
-               struct bt_private_clock_class *priv_clock_class,
+void bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
                bt_uuid uuid)
 {
-       struct bt_clock_class *clock_class = (void *) priv_clock_class;
-
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
        BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
@@ -313,7 +292,7 @@ void bt_private_clock_class_set_uuid(
 }
 
 BT_HIDDEN
-void _bt_clock_class_freeze(struct bt_clock_class *clock_class)
+void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
 {
        BT_ASSERT(clock_class);
 
@@ -322,10 +301,11 @@ void _bt_clock_class_freeze(struct bt_clock_class *clock_class)
        }
 
        BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
-       clock_class->frozen = 1;
+       ((struct bt_clock_class *) clock_class)->frozen = 1;
 }
 
-int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class *clock_class,
+enum bt_clock_class_status bt_clock_class_cycles_to_ns_from_origin(
+               const struct bt_clock_class *clock_class,
                uint64_t cycles, int64_t *ns)
 {
        int ret;
@@ -334,6 +314,7 @@ int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class *clock_class,
        BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
        ret = bt_util_ns_from_origin(clock_class, cycles, ns);
        if (ret) {
+               ret = BT_CLOCK_CLASS_STATUS_OVERFLOW;
                BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
                        "from origin for given clock class: "
                        "value overflows the signed 64-bit integer range: "
@@ -343,3 +324,13 @@ int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class *clock_class,
 
        return ret;
 }
+
+void bt_clock_class_get_ref(const struct bt_clock_class *clock_class)
+{
+       bt_object_get_ref(clock_class);
+}
+
+void bt_clock_class_put_ref(const struct bt_clock_class *clock_class)
+{
+       bt_object_put_ref(clock_class);
+}
This page took 0.026822 seconds and 4 git commands to generate.