Move to kernel style SPDX license identifiers
[babeltrace.git] / src / lib / trace-ir / trace-class.c
index f05c7711eb8f10f1b088fcbefb88055991d5d958..90ae4de74f7ca6dd2416785b131dc56165ac0058 100644 (file)
@@ -1,38 +1,21 @@
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 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 "TRACE"
-#include "lib/lib-logging.h"
+#define BT_LOG_TAG "LIB/TRACE-CLASS"
+#include "lib/logging.h"
 
 #include "lib/assert-pre.h"
+#include "lib/assert-post.h"
 #include <babeltrace2/trace-ir/trace-class.h>
-#include <babeltrace2/trace-ir/trace-class-const.h>
 #include <babeltrace2/trace-ir/event-class.h>
 #include "ctf-writer/functor.h"
 #include "ctf-writer/clock.h"
 #include "compat/compiler.h"
 #include <babeltrace2/value.h>
-#include <babeltrace2/value-const.h>
 #include "lib/value.h"
 #include <babeltrace2/types.h>
 #include "compat/endian.h"
@@ -41,9 +24,9 @@
 #include <inttypes.h>
 #include <stdint.h>
 #include <string.h>
+#include <stdbool.h>
 #include <stdlib.h>
 
-#include "attributes.h"
 #include "clock-class.h"
 #include "event-class.h"
 #include "event.h"
 #include "stream.h"
 #include "trace.h"
 #include "utils.h"
+#include "lib/value.h"
+#include "lib/func-status.h"
 
 struct bt_trace_class_destruction_listener_elem {
        bt_trace_class_destruction_listener_func func;
        void *data;
 };
 
-#define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc)                             \
-       BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc))
+#define BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(_tc)                         \
+       BT_ASSERT_PRE_DEV_HOT((_tc), "Trace class", ": %!+T", (_tc))
 
 static
 void destroy_trace_class(struct bt_object *obj)
@@ -69,13 +54,17 @@ void destroy_trace_class(struct bt_object *obj)
        struct bt_trace_class *tc = (void *) obj;
 
        BT_LIB_LOGD("Destroying trace class object: %!+T", tc);
+       BT_OBJECT_PUT_REF_AND_RESET(tc->user_attributes);
+
        /*
         * Call destruction listener functions so that everything else
         * still exists in the trace class.
         */
        if (tc->destruction_listeners) {
                uint64_t i;
-               BT_LIB_LOGV("Calling trace class destruction listener(s): %!+T", tc);
+               const struct bt_error *saved_error;
+
+               BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc);
 
                /*
                * The trace class' reference count is 0 if we're here. Increment
@@ -89,6 +78,8 @@ void destroy_trace_class(struct bt_object *obj)
                */
                tc->base.ref_count++;
 
+               saved_error = bt_current_thread_take_error();
+
                /* Call all the trace class destruction listeners */
                for (i = 0; i < tc->destruction_listeners->len; i++) {
                        struct bt_trace_class_destruction_listener_elem elem =
@@ -97,28 +88,21 @@ void destroy_trace_class(struct bt_object *obj)
 
                        if (elem.func) {
                                elem.func(tc, elem.data);
+                               BT_ASSERT_POST_NO_ERROR();
                        }
 
                        /*
                         * The destruction listener should not have kept a
                         * reference to the trace class.
                         */
-                       BT_ASSERT_PRE(tc->base.ref_count == 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc);
+                       BT_ASSERT_POST(tc->base.ref_count == 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc);
                }
                g_array_free(tc->destruction_listeners, TRUE);
                tc->destruction_listeners = NULL;
-       }
 
-       if (tc->environment) {
-               BT_LOGD_STR("Destroying environment attributes.");
-               bt_attributes_destroy(tc->environment);
-               tc->environment = NULL;
-       }
-
-       if (tc->name.str) {
-               g_string_free(tc->name.str, TRUE);
-               tc->name.str = NULL;
-               tc->name.value = NULL;
+               if (saved_error) {
+                       BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
+               }
        }
 
        if (tc->stream_classes) {
@@ -134,39 +118,34 @@ struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp)
 {
        struct bt_trace_class *tc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
        BT_LOGD_STR("Creating default trace class object.");
        tc = g_new0(struct bt_trace_class, 1);
        if (!tc) {
-               BT_LOGE_STR("Failed to allocate one trace class.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace class.");
                goto error;
        }
 
        bt_object_init_shared_with_parent(&tc->base, destroy_trace_class);
+       tc->user_attributes = bt_value_map_create();
+       if (!tc->user_attributes) {
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to create a map value object.");
+               goto error;
+       }
 
        tc->stream_classes = g_ptr_array_new_with_free_func(
                (GDestroyNotify) bt_object_try_spec_release);
        if (!tc->stream_classes) {
-               BT_LOGE_STR("Failed to allocate one GPtrArray.");
-               goto error;
-       }
-
-       tc->name.str = g_string_new(NULL);
-       if (!tc->name.str) {
-               BT_LOGE_STR("Failed to allocate one GString.");
-               goto error;
-       }
-
-       tc->environment = bt_attributes_create();
-       if (!tc->environment) {
-               BT_LOGE_STR("Cannot create empty attributes object.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
                goto error;
        }
 
        tc->destruction_listeners = g_array_new(FALSE, TRUE,
                sizeof(struct bt_trace_class_destruction_listener_elem));
        if (!tc->destruction_listeners) {
-               BT_LOGE_STR("Failed to allocate one GArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
                goto error;
        }
 
@@ -181,44 +160,10 @@ end:
        return tc;
 }
 
-const char *bt_trace_class_get_name(const struct bt_trace_class *tc)
-{
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       return tc->name.value;
-}
-
-enum bt_trace_class_status bt_trace_class_set_name(
-               struct bt_trace_class *tc, const char *name)
-{
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
-       g_string_assign(tc->name.str, name);
-       tc->name.value = tc->name.str->str;
-       BT_LIB_LOGV("Set trace class's name: %!+T", tc);
-       return BT_TRACE_CLASS_STATUS_OK;
-}
-
-bt_uuid bt_trace_class_get_uuid(const struct bt_trace_class *tc)
-{
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       return tc->uuid.value;
-}
-
-void bt_trace_class_set_uuid(struct bt_trace_class *tc, bt_uuid uuid)
-{
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
-       BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
-       memcpy(tc->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
-       tc->uuid.value = tc->uuid.uuid;
-       BT_LIB_LOGV("Set trace class's UUID: %!+T", tc);
-}
-
-enum bt_trace_class_status bt_trace_class_add_destruction_listener(
+enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener(
                const struct bt_trace_class *_tc,
                bt_trace_class_destruction_listener_func listener,
-               void *data, uint64_t *listener_id)
+               void *data, bt_listener_id *listener_id)
 {
        struct bt_trace_class *tc = (void *) _tc;
        uint64_t i;
@@ -227,6 +172,7 @@ enum bt_trace_class_status bt_trace_class_add_destruction_listener(
                .data = data,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
        BT_ASSERT_PRE_NON_NULL(listener, "Listener");
 
@@ -251,27 +197,27 @@ enum bt_trace_class_status bt_trace_class_add_destruction_listener(
                *listener_id = i;
        }
 
-       BT_LIB_LOGV("Added trace class destruction listener: %![tc-]+T, "
+       BT_LIB_LOGD("Added trace class destruction listener: %![tc-]+T, "
                        "listener-id=%" PRIu64, tc, i);
-       return BT_TRACE_CLASS_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
-BT_ASSERT_PRE_FUNC
 static
 bool has_listener_id(const struct bt_trace_class *tc, uint64_t listener_id)
 {
        BT_ASSERT(listener_id < tc->destruction_listeners->len);
        return (&g_array_index(tc->destruction_listeners,
                        struct bt_trace_class_destruction_listener_elem,
-                       listener_id))->func != NULL;
+                       listener_id))->func;
 }
 
-enum bt_trace_class_status bt_trace_class_remove_destruction_listener(
-               const struct bt_trace_class *_tc, uint64_t listener_id)
+enum bt_trace_class_remove_listener_status bt_trace_class_remove_destruction_listener(
+               const struct bt_trace_class *_tc, bt_listener_id listener_id)
 {
        struct bt_trace_class *tc = (void *) _tc;
        struct bt_trace_class_destruction_listener_elem *elem;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
        BT_ASSERT_PRE(has_listener_id(tc, listener_id),
                "Trace class has no such trace class destruction listener ID: "
@@ -283,140 +229,23 @@ enum bt_trace_class_status bt_trace_class_remove_destruction_listener(
 
        elem->func = NULL;
        elem->data = NULL;
-       BT_LIB_LOGV("Removed trace class destruction listener: "
+       BT_LIB_LOGD("Removed trace class destruction listener: "
                "%![tc-]+T, listener-id=%" PRIu64,
                tc, listener_id);
-       return BT_TRACE_CLASS_STATUS_OK;
-}
-
-BT_ASSERT_FUNC
-static
-bool trace_has_environment_entry(const struct bt_trace_class *tc, const char *name)
-{
-       BT_ASSERT(tc);
-
-       return bt_attributes_borrow_field_value_by_name(
-               tc->environment, name) != NULL;
-}
-
-static
-enum bt_trace_class_status set_environment_entry(struct bt_trace_class *tc,
-               const char *name, struct bt_value *value)
-{
-       int ret;
-
-       BT_ASSERT(tc);
-       BT_ASSERT(name);
-       BT_ASSERT(value);
-       BT_ASSERT_PRE(!tc->frozen ||
-               !trace_has_environment_entry(tc, name),
-               "Trace class is frozen: cannot replace environment entry: "
-               "%![tc-]+T, entry-name=\"%s\"", tc, name);
-       ret = bt_attributes_set_field_value(tc->environment, name,
-               value);
-       if (ret) {
-               ret = BT_TRACE_CLASS_STATUS_NOMEM;
-               BT_LIB_LOGE("Cannot set trace class's environment entry: "
-                       "%![tc-]+T, entry-name=\"%s\"", tc, name);
-       } else {
-               bt_value_freeze(value);
-               BT_LIB_LOGV("Set trace class's environment entry: "
-                       "%![tc-]+T, entry-name=\"%s\"", tc, name);
-       }
-
-       return ret;
-}
-
-enum bt_trace_class_status bt_trace_class_set_environment_entry_string(
-               struct bt_trace_class *tc, const char *name, const char *value)
-{
-       int ret;
-       struct bt_value *value_obj;
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_NON_NULL(value, "Value");
-       value_obj = bt_value_string_create_init(value);
-       if (!value_obj) {
-               BT_LOGE_STR("Cannot create a string value object.");
-               ret = -1;
-               goto end;
-       }
-
-       /* set_environment_entry() logs errors */
-       ret = set_environment_entry(tc, name, value_obj);
-
-end:
-       bt_object_put_ref(value_obj);
-       return ret;
-}
-
-enum bt_trace_class_status bt_trace_class_set_environment_entry_integer(
-               struct bt_trace_class *tc, const char *name, int64_t value)
-{
-       int ret;
-       struct bt_value *value_obj;
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
-       value_obj = bt_value_signed_integer_create_init(value);
-       if (!value_obj) {
-               BT_LOGE_STR("Cannot create an integer value object.");
-               ret = BT_TRACE_CLASS_STATUS_NOMEM;
-               goto end;
-       }
-
-       /* set_environment_entry() logs errors */
-       ret = set_environment_entry(tc, name, value_obj);
-
-end:
-       bt_object_put_ref(value_obj);
-       return ret;
-}
-
-uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class *tc)
-{
-       int64_t ret;
-
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       ret = bt_attributes_get_count(tc->environment);
-       BT_ASSERT(ret >= 0);
-       return (uint64_t) ret;
-}
-
-void bt_trace_class_borrow_environment_entry_by_index_const(
-               const struct bt_trace_class *tc, uint64_t index,
-               const char **name, const struct bt_value **value)
-{
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_NON_NULL(value, "Value");
-       BT_ASSERT_PRE_VALID_INDEX(index,
-               bt_attributes_get_count(tc->environment));
-       *value = bt_attributes_borrow_field_value(tc->environment, index);
-       BT_ASSERT(*value);
-       *name = bt_attributes_get_field_name(tc->environment, index);
-       BT_ASSERT(*name);
-}
-
-const struct bt_value *bt_trace_class_borrow_environment_entry_value_by_name_const(
-               const struct bt_trace_class *tc, const char *name)
-{
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
-       return bt_attributes_borrow_field_value_by_name(tc->environment,
-               name);
+       return BT_FUNC_STATUS_OK;
 }
 
 uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc)
 {
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
        return (uint64_t) tc->stream_classes->len;
 }
 
 struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
                struct bt_trace_class *tc, uint64_t index)
 {
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_VALID_INDEX(index, tc->stream_classes->len);
+       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_VALID_INDEX(index, tc->stream_classes->len);
        return g_ptr_array_index(tc->stream_classes, index);
 }
 
@@ -434,7 +263,7 @@ struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
        struct bt_stream_class *stream_class = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
 
        for (i = 0; i < tc->stream_classes->len; i++) {
                struct bt_stream_class *stream_class_candidate =
@@ -467,7 +296,7 @@ void _bt_trace_class_freeze(const struct bt_trace_class *tc)
 
 bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc)
 {
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
        return (bt_bool) tc->assigns_automatic_stream_class_id;
 }
 
@@ -475,12 +304,39 @@ void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class
                bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
+       BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(tc);
        tc->assigns_automatic_stream_class_id = (bool) value;
-       BT_LIB_LOGV("Set trace class's automatic stream class ID "
+       BT_LIB_LOGD("Set trace class's automatic stream class ID "
                "assignment property: %!+T", tc);
 }
 
+const struct bt_value *bt_trace_class_borrow_user_attributes_const(
+               const struct bt_trace_class *trace_class)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(trace_class, "Trace class");
+       return trace_class->user_attributes;
+}
+
+struct bt_value *bt_trace_class_borrow_user_attributes(
+               struct bt_trace_class *trace_class)
+{
+       return (void *) bt_trace_class_borrow_user_attributes_const(
+               (void *) trace_class);
+}
+
+void bt_trace_class_set_user_attributes(struct bt_trace_class *trace_class,
+               const struct bt_value *user_attributes)
+{
+       BT_ASSERT_PRE_NON_NULL(trace_class, "Trace 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_TRACE_CLASS_HOT(trace_class);
+       bt_object_put_ref_no_null_check(trace_class->user_attributes);
+       trace_class->user_attributes = (void *) user_attributes;
+       bt_object_get_ref_no_null_check(trace_class->user_attributes);
+}
+
 void bt_trace_class_get_ref(const struct bt_trace_class *trace_class)
 {
        bt_object_get_ref(trace_class);
This page took 0.028569 seconds and 4 git commands to generate.