Move to kernel style SPDX license identifiers

[babeltrace.git] / src / ctf-writer / assert-pre.h

diff --git a/src/ctf-writer/assert-pre.h b/src/ctf-writer/assert-pre.h
index 5444760d77d7bf994c09e0d2c1b234368a126977..3d41037c6a6640a41a3b229c1516658726d9d318 100644 (file)
--- a/src/ctf-writer/assert-pre.h
+++ b/src/ctf-writer/assert-pre.h
@@ -1,29 +1,13 @@
-#ifndef BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H
-#define BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H
-
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
  * Copyright (c) 2018 Philippe Proulx <pproulx@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.
  */
 
+#ifndef BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H
+#define BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H
+
 /*
  * The macros in this header use macros defined in "logging/log.h". We
  * don't want this header to automatically include "logging/log.h"
@@ -39,11 +23,46 @@
 # error Include "logging/log.h" before this header.
 #endif
 
+#include <stdbool.h>
 #include <stdlib.h>
 #include <inttypes.h>
 #include "common/macros.h"
 
 #ifdef BT_DEV_MODE
+/*
+ * Prints the details of an unsatisfied precondition without immediately
+ * aborting. You should use this within a function which checks
+ * preconditions, but which is called from a BT_CTF_ASSERT_PRE()
+ * context, so that the function can still return its result for
+ * BT_CTF_ASSERT_PRE() to evaluate it.
+ *
+ * Example:
+ *
+ *     BT_CTF_ASSERT_PRE_FUNC
+ *     static inline bool check_complex_precond(...)
+ *     {
+ *         ...
+ *
+ *         if (...) {
+ *             BT_CTF_ASSERT_PRE_MSG("Invalid object: ...", ...);
+ *             return false;
+ *         }
+ *
+ *         ...
+ *     }
+ *
+ *     ...
+ *
+ *     BT_CTF_ASSERT_PRE(check_complex_precond(...),
+ *                   "Precondition is not satisfied: ...", ...);
+ */
+# define BT_CTF_ASSERT_PRE_MSG(_fmt, ...)                              \
+       do {                                                            \
+               _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION, __FILE__,      \
+                       __LINE__, BT_LOG_FATAL, BT_LOG_TAG, (_fmt),     \
+                       ##__VA_ARGS__);                                 \
+       } while (0)
+
 /*
  * Asserts that the library precondition _cond is satisfied.
  *
@@ -51,15 +70,15 @@
  * arguments using BT_LOGF(), and abort.
  *
  * To assert that a postcondition is satisfied or that some internal
- * object/context/value is in the expected state, use BT_ASSERT().
+ * object/context/value is in the expected state, use BT_ASSERT_DBG().
  */
 # define BT_CTF_ASSERT_PRE(_cond, _fmt, ...)                           \
        do {                                                            \
                if (!(_cond)) {                                         \
-                       BT_LOGF_STR("Library precondition not satisfied; error is:"); \
-                       BT_LOGF((_fmt), ##__VA_ARGS__);         \
-                       BT_LOGF_STR("Aborting...");                     \
-                       abort();                                        \
+                       BT_CTF_ASSERT_PRE_MSG("CTF writer precondition not satisfied; error is:"); \
+                       BT_CTF_ASSERT_PRE_MSG((_fmt), ##__VA_ARGS__);   \
+                       BT_CTF_ASSERT_PRE_MSG("Aborting...");           \
+                       bt_common_abort();                                      \
                }                                                       \
        } while (0)
 
@@ -95,7 +114,6 @@
  *     BT_CTF_ASSERT_PRE(check_complex_precond(...),
  *                   "Precondition is not satisfied: ...", ...);
  */
-# define BT_CTF_ASSERT_PRE_MSG BT_LOGF
 #else
 # define BT_CTF_ASSERT_PRE(_cond, _fmt, ...)   ((void) sizeof((void) (_cond), 0))
 # define BT_CTF_ASSERT_PRE_FUNC        __attribute__((unused))
@@ -106,7 +124,7 @@
  * Developer mode: asserts that a given variable is not NULL.
  */
 #define BT_CTF_ASSERT_PRE_NON_NULL(_obj, _obj_name)                            \
-       BT_CTF_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
+       BT_CTF_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name)
 
 /*
  * Developer mode: asserts that a given object is NOT frozen. This macro