lib: assign a unique ID to each pre/postcond. and report it on failure
[babeltrace.git] / src / lib / trace-ir / trace.c
index d155cae2e0ea205c0a04ffc5ab0d3019d6d637ed..bd20f9fbda343e48689edf140573574d02eaa8da 100644 (file)
@@ -1,39 +1,20 @@
 /*
+ * 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"
 #include "lib/logging.h"
 
-#include "lib/assert-pre.h"
-#include "lib/assert-post.h"
+#include "lib/assert-cond.h"
 #include <babeltrace2/trace-ir/trace.h>
-#include <babeltrace2/trace-ir/trace-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"
@@ -65,8 +46,11 @@ struct bt_trace_destruction_listener_elem {
        void *data;
 };
 
-#define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace) \
-       BT_ASSERT_PRE_DEV_HOT((_trace), "Trace", ": %!+t", (_trace))
+#define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace)                            \
+       BT_ASSERT_PRE_DEV_HOT("trace", (_trace), "Trace", ": %!+t", (_trace))
+
+#define DESTRUCTION_LISTENER_FUNC_NAME                                 \
+       "bt_trace_class_destruction_listener_func"
 
 static
 void destroy_trace(struct bt_object *obj)
@@ -82,6 +66,8 @@ void destroy_trace(struct bt_object *obj)
         */
        if (trace->destruction_listeners) {
                uint64_t i;
+               const struct bt_error *saved_error;
+
                BT_LIB_LOGD("Calling trace destruction listener(s): %!+t", trace);
 
                /*
@@ -96,25 +82,36 @@ void destroy_trace(struct bt_object *obj)
                */
                trace->base.ref_count++;
 
+               saved_error = bt_current_thread_take_error();
+
                /* Call all the trace destruction listeners */
                for (i = 0; i < trace->destruction_listeners->len; i++) {
                        struct bt_trace_destruction_listener_elem elem =
                                g_array_index(trace->destruction_listeners,
-                                               struct bt_trace_destruction_listener_elem, i);
+                                       struct bt_trace_destruction_listener_elem, i);
 
                        if (elem.func) {
                                elem.func(trace, elem.data);
-                               BT_ASSERT_POST_NO_ERROR();
+                               BT_ASSERT_POST_NO_ERROR(
+                                       DESTRUCTION_LISTENER_FUNC_NAME);
                        }
 
                        /*
                         * The destruction listener should not have kept a
                         * reference to the trace.
                         */
-                       BT_ASSERT_POST(trace->base.ref_count == 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace);
+                       BT_ASSERT_POST(DESTRUCTION_LISTENER_FUNC_NAME,
+                               "trace-reference-count-not-changed",
+                               trace->base.ref_count == 1,
+                               "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t",
+                               trace);
                }
                g_array_free(trace->destruction_listeners, TRUE);
                trace->destruction_listeners = NULL;
+
+               if (saved_error) {
+                       BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
+               }
        }
 
        if (trace->name.str) {
@@ -214,7 +211,7 @@ end:
 
 const char *bt_trace_get_name(const struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        return trace->name.value;
 }
 
@@ -222,8 +219,8 @@ enum bt_trace_set_name_status bt_trace_set_name(struct bt_trace *trace,
                const char *name)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_NAME_NON_NULL(name);
        BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
        g_string_assign(trace->name.str, name);
        trace->name.value = trace->name.str->str;
@@ -233,14 +230,14 @@ enum bt_trace_set_name_status bt_trace_set_name(struct bt_trace *trace,
 
 bt_uuid bt_trace_get_uuid(const struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        return trace->uuid.value;
 }
 
 void bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
 {
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
+       BT_ASSERT_PRE_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_UUID_NON_NULL(uuid);
        BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
        bt_uuid_copy(trace->uuid.uuid, uuid);
        trace->uuid.value = trace->uuid.uuid;
@@ -266,8 +263,9 @@ enum bt_trace_set_environment_entry_status set_environment_entry(
        BT_ASSERT(trace);
        BT_ASSERT(name);
        BT_ASSERT(value);
-       BT_ASSERT_PRE(!trace->frozen ||
-               !trace_has_environment_entry(trace, name),
+       BT_ASSERT_PRE("not-frozen:trace",
+               !trace->frozen ||
+                       !trace_has_environment_entry(trace, name),
                "Trace is frozen: cannot replace environment entry: "
                "%![trace-]+t, entry-name=\"%s\"", trace, name);
        ret = bt_attributes_set_field_value(trace->environment, name,
@@ -294,9 +292,9 @@ bt_trace_set_environment_entry_string(
        struct bt_value *value_obj;
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_NON_NULL(value, "Value");
+       BT_ASSERT_PRE_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_NAME_NON_NULL(name);
+       BT_ASSERT_PRE_NON_NULL("value", value, "Value");
 
        value_obj = bt_value_string_create_init(value);
        if (!value_obj) {
@@ -322,8 +320,8 @@ bt_trace_set_environment_entry_integer(
        struct bt_value *value_obj;
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_NAME_NON_NULL(name);
 
        value_obj = bt_value_integer_signed_create_init(value);
        if (!value_obj) {
@@ -343,7 +341,7 @@ end:
 
 uint64_t bt_trace_get_environment_entry_count(const struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        return bt_attributes_get_count(trace->environment);
 }
 
@@ -351,9 +349,10 @@ void bt_trace_borrow_environment_entry_by_index_const(
                const struct bt_trace *trace, uint64_t index,
                const char **name, const struct bt_value **value)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_DEV_NAME_NON_NULL(name);
+       BT_ASSERT_PRE_DEV_NON_NULL("value-object-output", value,
+               "Value object (output)");
        BT_ASSERT_PRE_DEV_VALID_INDEX(index,
                bt_attributes_get_count(trace->environment));
        *value = bt_attributes_borrow_field_value(trace->environment, index);
@@ -365,22 +364,22 @@ void bt_trace_borrow_environment_entry_by_index_const(
 const struct bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
                const struct bt_trace *trace, const char *name)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_DEV_NAME_NON_NULL(name);
        return bt_attributes_borrow_field_value_by_name(trace->environment,
                name);
 }
 
 uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        return (uint64_t) trace->streams->len;
 }
 
 struct bt_stream *bt_trace_borrow_stream_by_index(
                struct bt_trace *trace, uint64_t index)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        BT_ASSERT_PRE_DEV_VALID_INDEX(index, trace->streams->len);
        return g_ptr_array_index(trace->streams, index);
 }
@@ -397,7 +396,7 @@ struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
        struct bt_stream *stream = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
 
        for (i = 0; i < trace->streams->len; i++) {
                struct bt_stream *stream_candidate =
@@ -432,8 +431,8 @@ enum bt_trace_add_listener_status bt_trace_add_destruction_listener(
        };
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_NON_NULL(listener, "Listener");
+       BT_ASSERT_PRE_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(listener);
 
        /* Find the next available spot */
        for (i = 0; i < trace->destruction_listeners->len; i++) {
@@ -477,8 +476,9 @@ enum bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
        struct bt_trace_destruction_listener_elem *elem;
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE(has_listener_id(trace, listener_id),
+       BT_ASSERT_PRE_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE("listener-id-exists",
+               has_listener_id(trace, listener_id),
                "Trace has no such trace destruction listener ID: "
                "%![trace-]+t, %" PRIu64, trace, listener_id);
        elem = &g_array_index(trace->destruction_listeners,
@@ -546,7 +546,7 @@ uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
 
 struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        return trace->class;
 }
 
@@ -559,7 +559,7 @@ const struct bt_trace_class *bt_trace_borrow_class_const(
 const struct bt_value *bt_trace_borrow_user_attributes_const(
                const struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_TRACE_NON_NULL(trace);
        return trace->user_attributes;
 }
 
@@ -572,10 +572,9 @@ void bt_trace_set_user_attributes(
                struct bt_trace *trace,
                const struct bt_value *user_attributes)
 {
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       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_TRACE_NON_NULL(trace);
+       BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes);
+       BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes);
        BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
        bt_object_put_ref_no_null_check(trace->user_attributes);
        trace->user_attributes = (void *) user_attributes;
This page took 0.028463 seconds and 4 git commands to generate.