lib: assign a unique ID to each pre/postcond. and report it on failure
[babeltrace.git] / src / lib / trace-ir / event-class.c
index 20b8850d0c2a77c7b746a4ab97e75e6e8e2fad32..871f40cbb13eeaa15fdc00183954142870c52d14 100644 (file)
@@ -1,30 +1,14 @@
 /*
+ * 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/EVENT-CLASS"
 #include "lib/logging.h"
 
-#include "lib/assert-pre.h"
+#include "lib/assert-cond.h"
 #include <babeltrace2/trace-ir/field-class.h>
 #include <babeltrace2/trace-ir/event-class.h>
 #include <babeltrace2/trace-ir/stream-class.h>
@@ -49,8 +33,9 @@
 #include "utils.h"
 #include "lib/func-status.h"
 
-#define BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(_ec) \
-       BT_ASSERT_PRE_DEV_HOT(((const struct bt_event_class *) (_ec)),  \
+#define BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(_ec)                         \
+       BT_ASSERT_PRE_DEV_HOT("event-class",                            \
+               ((const struct bt_event_class *) (_ec)),                \
                "Event class", ": %!+E", (_ec))
 
 static
@@ -115,7 +100,8 @@ struct bt_event_class *create_event_class_with_id(
        struct bt_event_class *event_class;
 
        BT_ASSERT(stream_class);
-       BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id),
+       BT_ASSERT_PRE("event-class-id-is-unique",
+               event_class_id_is_unique(stream_class, id),
                "Duplicate event class ID: %![sc-]+S, id=%" PRIu64,
                stream_class, id);
        BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64,
@@ -178,8 +164,10 @@ struct bt_event_class *bt_event_class_create(
                struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE(stream_class->assigns_automatic_event_class_id,
+       BT_ASSERT_PRE_SC_NON_NULL(stream_class);
+       BT_ASSERT_PRE(
+               "stream-class-automatically-assigns-event-class-ids",
+               stream_class->assigns_automatic_event_class_id,
                "Stream class does not automatically assigns event class IDs: "
                "%![sc-]+S", stream_class);
        return create_event_class_with_id(stream_class,
@@ -190,7 +178,9 @@ struct bt_event_class *bt_event_class_create_with_id(
                struct bt_stream_class *stream_class, uint64_t id)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id,
+       BT_ASSERT_PRE(
+               "stream-class-does-not-automatically-assigns-event-class-ids",
+               !stream_class->assigns_automatic_event_class_id,
                "Stream class automatically assigns event class IDs: "
                "%![sc-]+S", stream_class);
        return create_event_class_with_id(stream_class, id);
@@ -198,7 +188,7 @@ struct bt_event_class *bt_event_class_create_with_id(
 
 const char *bt_event_class_get_name(const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->name.value;
 }
 
@@ -206,8 +196,8 @@ enum bt_event_class_set_name_status bt_event_class_set_name(
                struct bt_event_class *event_class, const char *name)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_EC_NON_NULL(event_class);
+       BT_ASSERT_PRE_NAME_NON_NULL(name);
        BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
        g_string_assign(event_class->name.str, name);
        event_class->name.value = event_class->name.str->str;
@@ -217,7 +207,7 @@ enum bt_event_class_set_name_status bt_event_class_set_name(
 
 uint64_t bt_event_class_get_id(const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->id;
 }
 
@@ -225,8 +215,9 @@ enum bt_property_availability bt_event_class_get_log_level(
                const struct bt_event_class *event_class,
                enum bt_event_class_log_level *log_level)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
-       BT_ASSERT_PRE_DEV_NON_NULL(log_level, "Log level (output)");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
+       BT_ASSERT_PRE_DEV_NON_NULL("log-level-output", log_level,
+               "Log level (output)");
        *log_level = (enum bt_event_class_log_level)
                event_class->log_level.value;
        return event_class->log_level.base.avail;
@@ -236,7 +227,7 @@ void bt_event_class_set_log_level(
                struct bt_event_class *event_class,
                enum bt_event_class_log_level log_level)
 {
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_EC_NON_NULL(event_class);
        BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
        bt_property_uint_set(&event_class->log_level,
                (uint64_t) log_level);
@@ -245,7 +236,7 @@ void bt_event_class_set_log_level(
 
 const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->emf_uri.value;
 }
 
@@ -254,8 +245,8 @@ enum bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
                const char *emf_uri)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
-       BT_ASSERT_PRE_NON_NULL(emf_uri, "EMF URI");
+       BT_ASSERT_PRE_EC_NON_NULL(event_class);
+       BT_ASSERT_PRE_NON_NULL("emf-uri", emf_uri, "EMF URI");
        BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
        g_string_assign(event_class->emf_uri.str, emf_uri);
        event_class->emf_uri.value = event_class->emf_uri.str->str;
@@ -266,7 +257,7 @@ enum bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
 struct bt_stream_class *bt_event_class_borrow_stream_class(
                struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return bt_event_class_borrow_stream_class_inline(event_class);
 }
 
@@ -281,7 +272,7 @@ const struct bt_field_class *
 bt_event_class_borrow_specific_context_field_class_const(
                const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->specific_context_fc;
 }
 
@@ -289,7 +280,7 @@ struct bt_field_class *
 bt_event_class_borrow_specific_context_field_class(
                struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->specific_context_fc;
 }
 
@@ -308,20 +299,18 @@ bt_event_class_set_specific_context_field_class(
        };
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
-       BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
+       BT_ASSERT_PRE_EC_NON_NULL(event_class);
+       BT_ASSERT_PRE_FC_NON_NULL(field_class);
        BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
-       BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
-               BT_FIELD_CLASS_TYPE_STRUCTURE,
-               "Specific context field class is not a structure field class: "
-               "%!+F", field_class);
+       BT_ASSERT_PRE_FC_IS_STRUCT("specific-context", field_class,
+               "Specific context field class");
        stream_class = bt_event_class_borrow_stream_class_inline(
                event_class);
        resolve_ctx.packet_context = stream_class->packet_context_fc;
        resolve_ctx.event_common_context =
                stream_class->event_common_context_fc;
 
-       ret = bt_resolve_field_paths(field_class, &resolve_ctx);
+       ret = bt_resolve_field_paths(field_class, &resolve_ctx, __func__);
        if (ret) {
                /*
                 * This is the only reason for which
@@ -347,14 +336,14 @@ end:
 const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
                const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->payload_fc;
 }
 
 struct bt_field_class *bt_event_class_borrow_payload_field_class(
                struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->payload_fc;
 }
 
@@ -373,13 +362,10 @@ bt_event_class_set_payload_field_class(
        };
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
-       BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
+       BT_ASSERT_PRE_EC_NON_NULL(event_class);
+       BT_ASSERT_PRE_FC_NON_NULL(field_class);
        BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
-       BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
-               BT_FIELD_CLASS_TYPE_STRUCTURE,
-               "Payload field class is not a structure field class: %!+F",
-               field_class);
+       BT_ASSERT_PRE_FC_IS_STRUCT("payload", field_class, "Payload field class");
        stream_class = bt_event_class_borrow_stream_class_inline(
                event_class);
        resolve_ctx.packet_context = stream_class->packet_context_fc;
@@ -387,7 +373,7 @@ bt_event_class_set_payload_field_class(
                stream_class->event_common_context_fc;
        resolve_ctx.event_specific_context = event_class->specific_context_fc;
 
-       ret = bt_resolve_field_paths(field_class, &resolve_ctx);
+       ret = bt_resolve_field_paths(field_class, &resolve_ctx, __func__);
        if (ret) {
                /*
                 * This is the only reason for which
@@ -424,7 +410,7 @@ void _bt_event_class_freeze(const struct bt_event_class *event_class)
 const struct bt_value *bt_event_class_borrow_user_attributes_const(
                const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_EC_NON_NULL(event_class);
        return event_class->user_attributes;
 }
 
@@ -439,11 +425,10 @@ void bt_event_class_set_user_attributes(
                struct bt_event_class *event_class,
                const struct bt_value *user_attributes)
 {
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event 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_EC_NON_NULL(event_class);
        BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
+       BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes);
+       BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes);
        bt_object_put_ref_no_null_check(event_class->user_attributes);
        event_class->user_attributes = (void *) user_attributes;
        bt_object_get_ref_no_null_check(event_class->user_attributes);
This page took 0.027118 seconds and 4 git commands to generate.