Do not require logging support for BT_[CTF_]ASSERT_PRE()

[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..c0a24614c10d90905b6fef7c85b6d77513e401e7 100644 (file)
--- a/src/ctf-writer/assert-pre.h
+++ b/src/ctf-writer/assert-pre.h
@@ -44,6 +44,40 @@
 #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.
  *
@@ -56,9 +90,9 @@
 # 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...");                     \
+                       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...");           \
                        abort();                                        \
                }                                                       \
        } while (0)
@@ -95,7 +129,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))