Allow NULL clock name

[babeltrace.git] / formats / ctf / ir / clock.c

diff --git a/formats/ctf/ir/clock.c b/formats/ctf/ir/clock.c
index bf2fbda5b2627b8cffb9584650ff1a81921b2afa..738f2d80977a6a0eb0ee5b7195594493354b08a4 100644 (file)
--- a/formats/ctf/ir/clock.c
+++ b/formats/ctf/ir/clock.c
@@ -38,28 +38,21 @@ static
 void bt_ctf_clock_destroy(struct bt_object *obj);
 
 BT_HIDDEN
-struct bt_ctf_clock *_bt_ctf_clock_create(void)
+bool bt_ctf_clock_is_valid(struct bt_ctf_clock *clock)
 {
-       struct bt_ctf_clock *clock = g_new0(
-               struct bt_ctf_clock, 1);
-
-       if (!clock) {
-               goto end;
-       }
-
-       clock->precision = 1;
-       clock->frequency = 1000000000;
-       bt_object_init(clock, bt_ctf_clock_destroy);
-end:
-       return clock;
+       return clock && clock->name;
 }
 
-BT_HIDDEN
 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,16 +75,21 @@ end:
 struct bt_ctf_clock *bt_ctf_clock_create(const char *name)
 {
        int ret;
-       struct bt_ctf_clock *clock = NULL;
+       struct bt_ctf_clock *clock = g_new0(struct bt_ctf_clock, 1);
 
-       clock = _bt_ctf_clock_create();
        if (!clock) {
                goto error;
        }
 
-       ret = bt_ctf_clock_set_name(clock, name);
-       if (ret) {
-               goto error;
+       clock->precision = 1;
+       clock->frequency = 1000000000;
+       bt_object_init(clock, bt_ctf_clock_destroy);
+
+       if (name) {
+               ret = bt_ctf_clock_set_name(clock, name);
+               if (ret) {
+                       goto error;
+               }
        }
 
        ret = bt_uuid_generate(clock->uuid);
@@ -99,6 +97,13 @@ struct bt_ctf_clock *bt_ctf_clock_create(const char *name)
                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:
@@ -318,6 +323,19 @@ end:
        return ret;
 }
 
+uint64_t ns_from_value(uint64_t frequency, uint64_t value)
+{
+       uint64_t ns;
+
+       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;
@@ -327,7 +345,17 @@ int bt_ctf_clock_get_time(struct bt_ctf_clock *clock, int64_t *time)
                goto end;
        }
 
-       *time = clock->time;
+
+       if (!clock->has_value) {
+               /*
+                * Clock belongs to a non-writer mode trace and thus
+                * this function is disabled.
+                */
+               goto end;
+       }
+
+       *time = (int64_t) ns_from_value(clock->frequency, clock->value);
+
 end:
        return ret;
 }
@@ -335,14 +363,83 @@ end:
 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;
+}
+
+uint64_t bt_ctf_clock_get_value(struct bt_ctf_clock *clock)
+{
+       uint64_t ret = -1ULL;
+
+       if (!clock) {
+               goto end;
+       }
+
+       if (!clock->has_value) {
+               /*
+                * Clock belongs to a non-writer mode trace and thus
+                * this function is disabled.
+                */
+               goto end;
+       }
+
+       ret = clock->value;
+end:
+       return ret;
+}
+
+int bt_ctf_clock_set_value(struct bt_ctf_clock *clock, uint64_t value)
+{
+       int ret = 0;
+
+       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;
+       }
+
+       /* Timestamps are strictly monotonic */
+       if (value < clock->value) {
+               ret = -1;
+               goto end;
+       }
+
+       clock->value = value;
 end:
        return ret;
 }
@@ -421,3 +518,24 @@ void bt_ctf_clock_destroy(struct bt_object *obj)
 
        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;
+}