lib: add pre condition asserts to check current thread has no error

[babeltrace.git] / src / lib / assert-pre.h

diff --git a/src/lib/assert-pre.h b/src/lib/assert-pre.h
index 17ee8a89ad74ac27c96d64155412a9c5e6972ad6..138977558f95daf67d542e679ba5a005d0dddc3e 100644 (file)
--- a/src/lib/assert-pre.h
+++ b/src/lib/assert-pre.h
@@ -39,8 +39,10 @@
 # error Include "lib/logging.h" before this header.
 #endif
 
+#include <stdbool.h>
 #include <stdlib.h>
 #include <inttypes.h>
+#include "common/common.h"
 #include "common/macros.h"
 
 /*
@@ -52,7 +54,6 @@
  *
  * Example:
  *
- *     BT_ASSERT_PRE_FUNC
  *     static inline bool check_complex_precond(...)
  *     {
  *         ...
@@ -87,7 +88,7 @@
  * code), use BT_ASSERT_POST().
  *
  * To assert that an internal postcondition is satisfied, use
- * BT_ASSERT().
+ * BT_ASSERT() or BT_ASSERT_DBG().
  */
 #define BT_ASSERT_PRE(_cond, _fmt, ...)                                \
        do {                                                            \
@@ -95,7 +96,7 @@
                        BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \
                        BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__); \
                        BT_ASSERT_PRE_MSG("Aborting...");               \
-                       abort();                                        \
+                       bt_common_abort();                                      \
                }                                                       \
        } while (0)
 
@@ -104,7 +105,7 @@
  * is not `NULL`.
  */
 #define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)                                \
-       BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
+       BT_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name)
 
 /*
  * Asserts that a given index `_index` is less than a given length
@@ -116,18 +117,27 @@
                "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
 
 /*
- * Marks a function as being only used within a BT_ASSERT_PRE() context.
+ * Asserts that the current thread has no error set.
  */
-#define BT_ASSERT_PRE_FUNC
+#define BT_ASSERT_PRE_NO_ERROR() \
+       do {                                                                    \
+               const struct bt_error *err = bt_current_thread_take_error();    \
+               if (err) {                                                      \
+                       bt_current_thread_move_error(err);                      \
+               }                                                               \
+               BT_ASSERT_PRE(!err,                                             \
+                       "API function called while current thread has an "      \
+                       "error: function=%s", __func__);                        \
+       } while (0)
 
 #ifdef BT_DEV_MODE
 /* Developer mode version of BT_ASSERT_PRE_MSG(). */
-# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)                                      \
-       BT_ASSERT_PRE_MSG(_fmt, #__VA_ARGS__)
+# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)                              \
+       BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__)
 
 /* Developer mode version of BT_ASSERT_PRE(). */
 # define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)                           \
-       BT_ASSERT_PRE((_cond), _fmt, #__VA_ARGS__)
+       BT_ASSERT_PRE((_cond), _fmt, ##__VA_ARGS__)
 
 /* Developer mode version of BT_ASSERT_PRE_NON_NULL() */
 # define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name)                   \
@@ -150,7 +160,14 @@
 # define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)                        \
        BT_ASSERT_PRE_VALID_INDEX((_index), (_length))
 
-/* Developer mode version of `BT_ASSERT_PRE_FUNC`. */
+/* Developer mode version of BT_ASSERT_PRE_NO_ERROR(). */
+# define BT_ASSERT_PRE_DEV_NO_ERROR() \
+       BT_ASSERT_PRE_NO_ERROR()
+
+/*
+ * Marks a function as being only used within a BT_ASSERT_PRE_DEV()
+ * context.
+ */
 # define BT_ASSERT_PRE_DEV_FUNC
 #else
 # define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)
@@ -161,6 +178,7 @@
        ((void) sizeof((void) (_obj), (void) (_obj_name), 0))
 # define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)                        \
        ((void) sizeof((void) (_index), (void) (_length), 0))
+# define BT_ASSERT_PRE_DEV_NO_ERROR()
 # define BT_ASSERT_PRE_DEV_FUNC                __attribute__((unused))
 #endif /* BT_DEV_MODE */