Move to kernel style SPDX license identifiers
[babeltrace.git] / src / lib / trace-ir / clock-class.c
index e84a41b537d122d8fdad70a998995e13f9117852..b9a66c02b0de4f109abe2fb0dbbfde8f29ee78d5 100644 (file)
@@ -1,32 +1,15 @@
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2013, 2014 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
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
  */
 
 #define BT_LOG_TAG "LIB/CLOCK-CLASS"
 #include "lib/logging.h"
 
 #include "lib/assert-pre.h"
-#include "compat/uuid.h"
-#include <babeltrace2/trace-ir/clock-class-const.h>
+#include "common/uuid.h"
 #include <babeltrace2/trace-ir/clock-class.h>
 #include "clock-class.h"
 #include "clock-snapshot.h"
 #include <babeltrace2/types.h>
 #include "compat/string.h"
 #include <inttypes.h>
+#include <stdbool.h>
 #include "lib/object.h"
 #include "common/assert.h"
+#include "lib/func-status.h"
+#include "lib/value.h"
 
-#define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
-       BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
+#define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \
+       BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc))
 
 static
 void destroy_clock_class(struct bt_object *obj)
@@ -47,6 +33,7 @@ void destroy_clock_class(struct bt_object *obj)
        struct bt_clock_class *clock_class = (void *) obj;
 
        BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
+       BT_OBJECT_PUT_REF_AND_RESET(clock_class->user_attributes);
 
        if (clock_class->name.str) {
                g_string_free(clock_class->name.str, TRUE);
@@ -84,25 +71,34 @@ struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp)
        int ret;
        struct bt_clock_class *clock_class = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
        BT_LOGD_STR("Creating default clock class object");
 
        clock_class = g_new0(struct bt_clock_class, 1);
        if (!clock_class) {
-               BT_LOGE_STR("Failed to allocate one clock class.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class.");
                goto error;
        }
 
        bt_object_init_shared(&clock_class->base, destroy_clock_class);
+
+       clock_class->user_attributes = bt_value_map_create();
+       if (!clock_class->user_attributes) {
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to create a map value object.");
+               goto error;
+       }
+
        clock_class->name.str = g_string_new(NULL);
        if (!clock_class->name.str) {
-               BT_LOGE_STR("Failed to allocate a GString.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
                goto error;
        }
 
        clock_class->description.str = g_string_new(NULL);
        if (!clock_class->description.str) {
-               BT_LOGE_STR("Failed to allocate a GString.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
                goto error;
        }
 
@@ -115,7 +111,8 @@ struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp)
                        free_clock_snapshot,
                clock_class);
        if (ret) {
-               BT_LOGE("Failed to initialize clock snapshot pool: ret=%d",
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to initialize clock snapshot pool: ret=%d",
                        ret);
                goto error;
        }
@@ -132,45 +129,47 @@ end:
 
 const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
 {
-       BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
        return clock_class->name.value;
 }
 
-enum bt_clock_class_status bt_clock_class_set_name(
+enum bt_clock_class_set_name_status bt_clock_class_set_name(
                struct bt_clock_class *clock_class, const char *name)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
        g_string_assign(clock_class->name.str, name);
        clock_class->name.value = clock_class->name.str->str;
        BT_LIB_LOGD("Set clock class's name: %!+K", clock_class);
-       return BT_CLOCK_CLASS_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
 const char *bt_clock_class_get_description(
                const struct bt_clock_class *clock_class)
 {
-       BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
        return clock_class->description.value;
 }
 
-enum bt_clock_class_status bt_clock_class_set_description(
+enum bt_clock_class_set_description_status bt_clock_class_set_description(
                struct bt_clock_class *clock_class, const char *descr)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_NON_NULL(descr, "Description");
-       BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
        g_string_assign(clock_class->description.str, descr);
        clock_class->description.value = clock_class->description.str->str;
        BT_LIB_LOGD("Set clock class's description: %!+K",
                clock_class);
-       return BT_CLOCK_CLASS_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
 {
-       BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
        return clock_class->frequency;
 }
 
@@ -178,7 +177,7 @@ void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
                uint64_t frequency)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
-       BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
        BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
                "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
                clock_class, frequency);
@@ -192,7 +191,7 @@ void bt_clock_class_set_frequency(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");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
        return clock_class->precision;
 }
 
@@ -200,7 +199,7 @@ void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
                uint64_t precision)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
-       BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
        BT_ASSERT_PRE(precision != UINT64_C(-1),
                "Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
                clock_class, precision);
@@ -211,9 +210,9 @@ void bt_clock_class_set_precision(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");
-       BT_ASSERT_PRE_NON_NULL(seconds, "Seconds (output)");
-       BT_ASSERT_PRE_NON_NULL(cycles, "Cycles (output)");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_DEV_NON_NULL(seconds, "Seconds (output)");
+       BT_ASSERT_PRE_DEV_NON_NULL(cycles, "Cycles (output)");
        *seconds = clock_class->offset_seconds;
        *cycles = clock_class->offset_cycles;
 }
@@ -222,7 +221,7 @@ void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
                int64_t seconds, uint64_t cycles)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
-       BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
        BT_ASSERT_PRE(cycles < clock_class->frequency,
                "Offset (cycles) is greater than clock class's frequency: "
                "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
@@ -234,7 +233,7 @@ void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
 
 bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class)
 {
-       BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
        return (bool) clock_class->origin_is_unix_epoch;
 }
 
@@ -242,7 +241,7 @@ void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class,
                bt_bool origin_is_unix_epoch)
 {
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
-       BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
        clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch;
        BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K",
                clock_class);
@@ -250,7 +249,7 @@ void bt_clock_class_set_origin_is_unix_epoch(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");
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
        return clock_class->uuid.value;
 }
 
@@ -259,8 +258,8 @@ void bt_clock_class_set_uuid(struct bt_clock_class *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);
-       memcpy(clock_class->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
+       bt_uuid_copy(clock_class->uuid.uuid, uuid);
        clock_class->uuid.value = clock_class->uuid.uuid;
        BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class);
 }
@@ -274,31 +273,64 @@ void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
                return;
        }
 
+       BT_LIB_LOGD("Freezing clock class's user attributes: %!+v",
+               clock_class->user_attributes);
+       bt_value_freeze(clock_class->user_attributes);
        BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
        ((struct bt_clock_class *) clock_class)->frozen = 1;
 }
 
-enum bt_clock_class_status bt_clock_class_cycles_to_ns_from_origin(
+enum bt_clock_class_cycles_to_ns_from_origin_status
+bt_clock_class_cycles_to_ns_from_origin(
                const struct bt_clock_class *clock_class,
                uint64_t cycles, int64_t *ns)
 {
        int ret;
 
-       BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
-       BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
+       BT_ASSERT_PRE_DEV_NO_ERROR();
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_DEV_NON_NULL(ns, "Nanoseconds (output)");
        ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns);
        if (ret) {
-               ret = BT_CLOCK_CLASS_STATUS_OVERFLOW;
-               BT_LIB_LOGD("Cannot convert cycles to nanoseconds "
+               BT_LIB_LOGE_APPEND_CAUSE("Cannot convert cycles to nanoseconds "
                        "from origin for given clock class: "
                        "value overflows the signed 64-bit integer range: "
                        "%![cc-]+K, cycles=%" PRIu64,
                        clock_class, cycles);
+               ret = BT_FUNC_STATUS_OVERFLOW_ERROR;
        }
 
        return ret;
 }
 
+const struct bt_value *bt_clock_class_borrow_user_attributes_const(
+               const struct bt_clock_class *clock_class)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+       return clock_class->user_attributes;
+}
+
+struct bt_value *bt_clock_class_borrow_user_attributes(
+               struct bt_clock_class *clock_class)
+{
+       return (void *) bt_clock_class_borrow_user_attributes_const(
+               (void *) clock_class);
+}
+
+void bt_clock_class_set_user_attributes(
+               struct bt_clock_class *clock_class,
+               const struct bt_value *user_attributes)
+{
+       BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+       BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
+       BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
+               "User attributes object is not a map value object.");
+       BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
+       bt_object_put_ref_no_null_check(clock_class->user_attributes);
+       clock_class->user_attributes = (void *) user_attributes;
+       bt_object_get_ref_no_null_check(clock_class->user_attributes);
+}
+
 void bt_clock_class_get_ref(const struct bt_clock_class *clock_class)
 {
        bt_object_get_ref(clock_class);
This page took 0.027974 seconds and 4 git commands to generate.