ir: allow the creation of an empty clock (nameless)
[babeltrace.git] / formats / ctf / ir / clock.c
index d1f435d50ae567ed6d879b32ce8647ca962bb2ac..002b72058fd4d6a14731d1581a7ff62720b8a5fa 100644 (file)
 
 #include <babeltrace/ctf-ir/clock-internal.h>
 #include <babeltrace/ctf-ir/utils.h>
+#include <babeltrace/ref.h>
 #include <babeltrace/ctf-writer/writer-internal.h>
+#include <babeltrace/object-internal.h>
 #include <babeltrace/compiler.h>
 #include <inttypes.h>
 
 static
-void bt_ctf_clock_destroy(struct bt_ctf_ref *ref);
+void bt_ctf_clock_destroy(struct bt_object *obj);
 
-BT_HIDDEN
-struct bt_ctf_clock *_bt_ctf_clock_create(void)
+struct bt_ctf_clock *bt_ctf_clock_create_empty(void)
 {
        struct bt_ctf_clock *clock = g_new0(
                struct bt_ctf_clock, 1);
@@ -47,17 +48,27 @@ struct bt_ctf_clock *_bt_ctf_clock_create(void)
 
        clock->precision = 1;
        clock->frequency = 1000000000;
-       bt_ctf_ref_init(&clock->ref_count);
+       bt_object_init(clock, bt_ctf_clock_destroy);
 end:
        return clock;
 }
 
 BT_HIDDEN
+bool bt_ctf_clock_is_valid(struct bt_ctf_clock *clock)
+{
+       return clock && clock->name;
+}
+
 int bt_ctf_clock_set_name(struct bt_ctf_clock *clock,
                const char *name)
 {
        int ret = 0;
 
+       if (!clock || clock->frozen) {
+               ret = -1;
+               goto end;
+       }
+
        if (bt_ctf_validate_identifier(name)) {
                ret = -1;
                goto end;
@@ -82,27 +93,33 @@ struct bt_ctf_clock *bt_ctf_clock_create(const char *name)
        int ret;
        struct bt_ctf_clock *clock = NULL;
 
-       clock = _bt_ctf_clock_create();
+       clock = bt_ctf_clock_create_empty();
        if (!clock) {
                goto error;
        }
 
        ret = bt_ctf_clock_set_name(clock, name);
        if (ret) {
-               goto error_destroy;
+               goto error;
        }
 
-       ret = babeltrace_uuid_generate(clock->uuid);
+       ret = bt_uuid_generate(clock->uuid);
        if (ret) {
-               goto error_destroy;
+               goto error;
        }
 
+       /*
+        * For backward compatibility reasons, a fresh clock can have
+        * a value because it could be added to a trace created by a
+        * CTF writer. As soon as this clock is added to a non-writer
+        * trace, then its value/time functions will be disabled.
+        */
+       clock->has_value = 1;
        clock->uuid_set = 1;
        return clock;
-error_destroy:
-       bt_ctf_clock_destroy(&clock->ref_count);
 error:
-       return NULL;
+       BT_PUT(clock);
+       return clock;
 }
 
 const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock)
@@ -205,20 +222,21 @@ end:
        return ret;
 }
 
-uint64_t bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock)
+int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock, int64_t *offset_s)
 {
-       uint64_t ret = -1ULL;
+       int ret = 0;
 
-       if (!clock) {
+       if (!clock || !offset_s) {
+               ret = -1;
                goto end;
        }
 
-       ret = clock->offset_s;
+       *offset_s = clock->offset_s;
 end:
        return ret;
 }
 
-int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s)
+int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, int64_t offset_s)
 {
        int ret = 0;
 
@@ -232,20 +250,21 @@ end:
        return ret;
 }
 
-uint64_t bt_ctf_clock_get_offset(struct bt_ctf_clock *clock)
+int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock, int64_t *offset)
 {
-       uint64_t ret = -1ULL;
+       int ret = 0;
 
-       if (!clock) {
+       if (!clock || !offset) {
+               ret = -1;
                goto end;
        }
 
-       ret = clock->offset;
+       *offset = clock->offset;
 end:
        return ret;
 }
 
-int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset)
+int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, int64_t offset)
 {
        int ret = 0;
 
@@ -315,50 +334,135 @@ end:
        return ret;
 }
 
-uint64_t bt_ctf_clock_get_time(struct bt_ctf_clock *clock)
+uint64_t ns_from_value(uint64_t frequency, uint64_t value)
 {
-       uint64_t ret = -1ULL;
+       uint64_t ns;
 
-       if (!clock) {
+       if (frequency == 1000000000) {
+               ns = value;
+       } else {
+               ns = (uint64_t) ((1e9 * (double) value) / (double) frequency);
+       }
+
+       return ns;
+}
+
+int bt_ctf_clock_get_time(struct bt_ctf_clock *clock, int64_t *time)
+{
+       int ret = 0;
+
+       if (!clock || !time) {
+               ret = -1;
+               goto end;
+       }
+
+
+       if (!clock->has_value) {
+               /*
+                * Clock belongs to a non-writer mode trace and thus
+                * this function is disabled.
+                */
                goto end;
        }
 
-       ret = clock->time;
+       *time = (int64_t) ns_from_value(clock->frequency, clock->value);
+
 end:
        return ret;
 }
 
-int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time)
+int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time)
 {
        int ret = 0;
+       int64_t value;
 
        /* Timestamps are strictly monotonic */
-       if (!clock || time < clock->time) {
+       if (!clock) {
+               ret = -1;
+               goto end;
+       }
+
+
+       if (!clock->has_value) {
+               /*
+                * Clock belongs to a non-writer mode trace and thus
+                * this function is disabled.
+                */
                ret = -1;
                goto end;
        }
 
-       clock->time = time;
+       /* Common case where cycles are actually nanoseconds */
+       if (clock->frequency == 1000000000) {
+               value = time;
+       } else {
+               value = (uint64_t) (((double) time *
+                       (double) clock->frequency) / 1e9);
+       }
+
+       ret = bt_ctf_clock_set_value(clock, value);
 end:
        return ret;
 }
 
-void bt_ctf_clock_get(struct bt_ctf_clock *clock)
+uint64_t bt_ctf_clock_get_value(struct bt_ctf_clock *clock)
 {
+       uint64_t ret = -1ULL;
+
        if (!clock) {
-               return;
+               goto end;
+       }
+
+       if (!clock->has_value) {
+               /*
+                * Clock belongs to a non-writer mode trace and thus
+                * this function is disabled.
+                */
+               goto end;
        }
 
-       bt_ctf_ref_get(&clock->ref_count);
+       ret = clock->value;
+end:
+       return ret;
 }
 
-void bt_ctf_clock_put(struct bt_ctf_clock *clock)
+int bt_ctf_clock_set_value(struct bt_ctf_clock *clock, uint64_t value)
 {
+       int ret = 0;
+
        if (!clock) {
-               return;
+               ret = -1;
+               goto end;
+       }
+
+       if (!clock->has_value) {
+               /*
+                * Clock belongs to a non-writer mode trace and thus
+                * this function is disabled.
+                */
+               ret = -1;
+               goto end;
+       }
+
+       /* Timestamps are strictly monotonic */
+       if (value < clock->value) {
+               ret = -1;
+               goto end;
        }
 
-       bt_ctf_ref_put(&clock->ref_count, bt_ctf_clock_destroy);
+       clock->value = value;
+end:
+       return ret;
+}
+
+void bt_ctf_clock_get(struct bt_ctf_clock *clock)
+{
+       bt_get(clock);
+}
+
+void bt_ctf_clock_put(struct bt_ctf_clock *clock)
+{
+       bt_put(clock);
 }
 
 BT_HIDDEN
@@ -410,15 +514,11 @@ void bt_ctf_clock_serialize(struct bt_ctf_clock *clock,
 }
 
 static
-void bt_ctf_clock_destroy(struct bt_ctf_ref *ref)
+void bt_ctf_clock_destroy(struct bt_object *obj)
 {
        struct bt_ctf_clock *clock;
 
-       if (!ref) {
-               return;
-       }
-
-       clock = container_of(ref, struct bt_ctf_clock, ref_count);
+       clock = container_of(obj, struct bt_ctf_clock, base);
        if (clock->name) {
                g_string_free(clock->name, TRUE);
        }
@@ -429,3 +529,24 @@ void bt_ctf_clock_destroy(struct bt_ctf_ref *ref)
 
        g_free(clock);
 }
+
+int64_t bt_ctf_clock_ns_from_value(struct bt_ctf_clock *clock, uint64_t value)
+{
+       int64_t ns = -1ULL;
+
+       if (!clock) {
+               goto end;
+       }
+
+       /* Initialize nanosecond timestamp to clock's offset in seconds */
+       ns = clock->offset_s * 1000000000;
+
+       /* Add offset in cycles, converted to nanoseconds */
+       ns += ns_from_value(clock->frequency, clock->offset);
+
+       /* Add given value, converter to nanoseconds */
+       ns += ns_from_value(clock->frequency, value);
+
+end:
+       return ns;
+}
This page took 0.031872 seconds and 4 git commands to generate.