Move to kernel style SPDX license identifiers

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

diff --git a/src/lib/trace-ir/clock-class.c b/src/lib/trace-ir/clock-class.c
index fb0d108c502bad23b157c7b9f843cf29e33afeea..b9a66c02b0de4f109abe2fb0dbbfde8f29ee78d5 100644 (file)
--- a/src/lib/trace-ir/clock-class.c
+++ b/src/lib/trace-ir/clock-class.c
@@ -1,24 +1,8 @@
 /*
+ * 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"
@@ -26,7 +10,6 @@
 
 #include "lib/assert-pre.h"
 #include "common/uuid.h"
-#include <babeltrace2/trace-ir/clock-class-const.h>
 #include <babeltrace2/trace-ir/clock-class.h>
 #include "clock-class.h"
 #include "clock-snapshot.h"
@@ -35,9 +18,11 @@
 #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_DEV_CLOCK_CLASS_HOT(_cc) \
        BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc))
@@ -48,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);
@@ -85,6 +71,7 @@ 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");
 
@@ -95,6 +82,14 @@ struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp)
        }
 
        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_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
@@ -141,6 +136,7 @@ const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
 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_DEV_CLOCK_CLASS_HOT(clock_class);
@@ -160,6 +156,7 @@ const char *bt_clock_class_get_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_DEV_CLOCK_CLASS_HOT(clock_class);
@@ -276,6 +273,9 @@ 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;
 }
@@ -287,6 +287,7 @@ bt_clock_class_cycles_to_ns_from_origin(
 {
        int ret;
 
+       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);
@@ -296,12 +297,40 @@ bt_clock_class_cycles_to_ns_from_origin(
                        "value overflows the signed 64-bit integer range: "
                        "%![cc-]+K, cycles=%" PRIu64,
                        clock_class, cycles);
-               ret = BT_FUNC_STATUS_OVERFLOW;
+               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);