doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab
[babeltrace.git] / src / lib / trace-ir / trace-class.c
index 23a6a7e7b3450db0f9176d5a2ed63df46850d0c7..648a2af8095c3d1fcdbfe7162cc7597ff571551b 100644 (file)
@@ -1,58 +1,32 @@
 /*
+ * 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 "LIB/TRACE"
+#define BT_LOG_TAG "LIB/TRACE-CLASS"
 #include "lib/logging.h"
 
-#include "lib/assert-pre.h"
+#include "lib/assert-cond.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"
 #include "common/assert.h"
-#include "compat/glib.h"
 #include <inttypes.h>
 #include <stdint.h>
 #include <string.h>
+#include <stdbool.h>
 #include <stdlib.h>
 
-#include "clock-class.h"
-#include "event-class.h"
-#include "event.h"
-#include "field-class.h"
-#include "field-wrapper.h"
-#include "resolve-field-path.h"
+#include "trace-class.h"
 #include "stream-class.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 {
@@ -61,7 +35,10 @@ struct bt_trace_class_destruction_listener_elem {
 };
 
 #define BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(_tc)                         \
-       BT_ASSERT_PRE_DEV_HOT((_tc), "Trace class", ": %!+T", (_tc))
+       BT_ASSERT_PRE_DEV_HOT("trace-class", (_tc), "Trace class",      \
+               ": %!+T", (_tc))
+
+#define DESTRUCTION_LISTENER_FUNC_NAME "bt_trace_destruction_listener_func"
 
 static
 void destroy_trace_class(struct bt_object *obj)
@@ -69,12 +46,16 @@ 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;
+               const struct bt_error *saved_error;
+
                BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc);
 
                /*
@@ -89,24 +70,36 @@ 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 =
-                               g_array_index(tc->destruction_listeners,
+                               bt_g_array_index(tc->destruction_listeners,
                                                struct bt_trace_class_destruction_listener_elem, i);
 
                        if (elem.func) {
                                elem.func(tc, elem.data);
+                               BT_ASSERT_POST_NO_ERROR(
+                                       DESTRUCTION_LISTENER_FUNC_NAME);
                        }
 
                        /*
                         * 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(DESTRUCTION_LISTENER_FUNC_NAME,
+                               "trace-class-reference-count-not-changed",
+                               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 (saved_error) {
+                       BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
+               }
        }
 
        if (tc->stream_classes) {
@@ -118,11 +111,13 @@ void destroy_trace_class(struct bt_object *obj)
        g_free(tc);
 }
 
+BT_EXPORT
 struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp)
 {
        struct bt_trace_class *tc = NULL;
 
-       BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_COMP_NON_NULL(self_comp);
        BT_LOGD_STR("Creating default trace class object.");
        tc = g_new0(struct bt_trace_class, 1);
        if (!tc) {
@@ -131,6 +126,12 @@ struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp)
        }
 
        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);
@@ -157,10 +158,11 @@ end:
        return tc;
 }
 
+BT_EXPORT
 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;
@@ -169,13 +171,14 @@ enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener(
                .data = data,
        };
 
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE_NON_NULL(listener, "Listener");
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_TC_NON_NULL(tc);
+       BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(listener);
 
        /* Find the next available spot */
        for (i = 0; i < tc->destruction_listeners->len; i++) {
                struct bt_trace_class_destruction_listener_elem elem =
-                       g_array_index(tc->destruction_listeners,
+                       bt_g_array_index(tc->destruction_listeners,
                                struct bt_trace_class_destruction_listener_elem, i);
 
                if (!elem.func) {
@@ -198,27 +201,29 @@ enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener(
        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,
+       return (&bt_g_array_index(tc->destruction_listeners,
                        struct bt_trace_class_destruction_listener_elem,
-                       listener_id))->func != NULL;
+                       listener_id))->func;
 }
 
+BT_EXPORT
 enum bt_trace_class_remove_listener_status bt_trace_class_remove_destruction_listener(
-               const struct bt_trace_class *_tc, uint64_t listener_id)
+               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_NON_NULL(tc, "Trace class");
-       BT_ASSERT_PRE(has_listener_id(tc, listener_id),
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_TC_NON_NULL(tc);
+       BT_ASSERT_PRE("listener-id-exists",
+               has_listener_id(tc, listener_id),
                "Trace class has no such trace class destruction listener ID: "
                "%![tc-]+T, %" PRIu64, tc, listener_id);
-       elem = &g_array_index(tc->destruction_listeners,
+       elem = &bt_g_array_index(tc->destruction_listeners,
                        struct bt_trace_class_destruction_listener_elem,
                        listener_id);
        BT_ASSERT(elem->func);
@@ -231,20 +236,23 @@ enum bt_trace_class_remove_listener_status bt_trace_class_remove_destruction_lis
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_TC_NON_NULL(tc);
        return (uint64_t) tc->stream_classes->len;
 }
 
+BT_EXPORT
 struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
                struct bt_trace_class *tc, uint64_t index)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_TC_NON_NULL(tc);
        BT_ASSERT_PRE_DEV_VALID_INDEX(index, tc->stream_classes->len);
        return g_ptr_array_index(tc->stream_classes, index);
 }
 
+BT_EXPORT
 const struct bt_stream_class *
 bt_trace_class_borrow_stream_class_by_index_const(
                const struct bt_trace_class *tc, uint64_t index)
@@ -253,13 +261,14 @@ bt_trace_class_borrow_stream_class_by_index_const(
                (void *) tc, index);
 }
 
+BT_EXPORT
 struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
                struct bt_trace_class *tc, uint64_t id)
 {
        struct bt_stream_class *stream_class = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_TC_NON_NULL(tc);
 
        for (i = 0; i < tc->stream_classes->len; i++) {
                struct bt_stream_class *stream_class_candidate =
@@ -275,6 +284,7 @@ end:
        return stream_class;
 }
 
+BT_EXPORT
 const struct bt_stream_class *
 bt_trace_class_borrow_stream_class_by_id_const(
                const struct bt_trace_class *tc, uint64_t id)
@@ -282,7 +292,6 @@ bt_trace_class_borrow_stream_class_by_id_const(
        return bt_trace_class_borrow_stream_class_by_id((void *) tc, id);
 }
 
-BT_HIDDEN
 void _bt_trace_class_freeze(const struct bt_trace_class *tc)
 {
        BT_ASSERT(tc);
@@ -290,27 +299,60 @@ void _bt_trace_class_freeze(const struct bt_trace_class *tc)
        ((struct bt_trace_class *) tc)->frozen = true;
 }
 
+BT_EXPORT
 bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_DEV_TC_NON_NULL(tc);
        return (bt_bool) tc->assigns_automatic_stream_class_id;
 }
 
+BT_EXPORT
 void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class *tc,
                bt_bool value)
 {
-       BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
+       BT_ASSERT_PRE_TC_NON_NULL(tc);
        BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(tc);
        tc->assigns_automatic_stream_class_id = (bool) value;
        BT_LIB_LOGD("Set trace class's automatic stream class ID "
                "assignment property: %!+T", tc);
 }
 
+BT_EXPORT
+const struct bt_value *bt_trace_class_borrow_user_attributes_const(
+               const struct bt_trace_class *trace_class)
+{
+       BT_ASSERT_PRE_DEV_TC_NON_NULL(trace_class);
+       return trace_class->user_attributes;
+}
+
+BT_EXPORT
+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);
+}
+
+BT_EXPORT
+void bt_trace_class_set_user_attributes(struct bt_trace_class *trace_class,
+               const struct bt_value *user_attributes)
+{
+       BT_ASSERT_PRE_TC_NON_NULL(trace_class);
+       BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes);
+       BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes);
+       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);
+}
+
+BT_EXPORT
 void bt_trace_class_get_ref(const struct bt_trace_class *trace_class)
 {
        bt_object_get_ref(trace_class);
 }
 
+BT_EXPORT
 void bt_trace_class_put_ref(const struct bt_trace_class *trace_class)
 {
        bt_object_put_ref(trace_class);
This page took 0.029316 seconds and 4 git commands to generate.