X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fassert-pre.h;h=0b85d861f695244c8450f8644dadf4dc00701531;hb=969c1d8a5c653480fe295344fece03988d101662;hp=2aae8f79a0e95a29331c81bfd4d920742e9d191d;hpb=c6f84660dba938fb188f14b063aa2e9684cd34d3;p=babeltrace.git

diff --git a/src/lib/assert-pre.h b/src/lib/assert-pre.h
index 2aae8f79..0b85d861 100644
--- a/src/lib/assert-pre.h
+++ b/src/lib/assert-pre.h
@@ -39,11 +39,11 @@
 # error Include "lib/logging.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
@@ -53,7 +53,6 @@
  *
  * Example:
  *
- *     BT_ASSERT_PRE_FUNC
  *     static inline bool check_complex_precond(...)
  *     {
  *         ...
@@ -71,7 +70,7 @@
  *     BT_ASSERT_PRE(check_complex_precond(...),
  *                   "Precondition is not satisfied: ...", ...);
  */
-# define BT_ASSERT_PRE_MSG(_fmt, ...)					\
+#define BT_ASSERT_PRE_MSG(_fmt, ...)					\
 	do {								\
 		bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,		\
 			__LINE__, BT_LOG_FATAL, BT_LOG_TAG,		\
@@ -79,8 +78,7 @@
 	} while (0)
 
 /*
- * Developer mode: asserts that the library precondition `_cond` is
- * satisfied.
+ * Asserts that the library precondition `_cond` is satisfied.
  *
  * If `_cond` is false, log a fatal statement using `_fmt` and the
  * optional arguments (same usage as BT_LIB_LOGF()), and abort.
@@ -89,51 +87,81 @@
  * 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, ...)				\
+#define BT_ASSERT_PRE(_cond, _fmt, ...)				\
 	do {								\
 		if (!(_cond)) {						\
 			BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \
-			BT_ASSERT_PRE_MSG((_fmt), ##__VA_ARGS__);	\
+			BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__);	\
 			BT_ASSERT_PRE_MSG("Aborting...");		\
 			abort();					\
 		}							\
 	} while (0)
 
 /*
- * Marks a function as being only used within a BT_ASSERT_PRE() context.
+ * Asserts that a given variable `_obj` named `_obj_name` (capitalized)
+ * is not `NULL`.
  */
-# define BT_ASSERT_PRE_FUNC
-#else
-# define BT_ASSERT_PRE(_cond, _fmt, ...)	((void) sizeof((void) (_cond), 0))
-# define BT_ASSERT_PRE_FUNC	__attribute__((unused))
-# define BT_ASSERT_PRE_MSG(_fmt, ...)
-#endif /* BT_DEV_MODE */
+#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)				\
+	BT_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name)
 
 /*
- * Developer mode: asserts that a given variable `_obj` named
- * `_obj_name` (capitalized) is not `NULL`.
+ * Asserts that a given index `_index` is less than a given length
+ * `_length`.
  */
-#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)				\
-	BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
+#define BT_ASSERT_PRE_VALID_INDEX(_index, _length)			\
+	BT_ASSERT_PRE((_index) < (_length),				\
+		"Index is out of bounds: index=%" PRIu64 ", "		\
+		"count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
+
+#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__)
+
+/* Developer mode version of BT_ASSERT_PRE(). */
+# define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)				\
+	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)			\
+	BT_ASSERT_PRE_NON_NULL((_obj), (_obj_name))
 
 /*
  * Developer mode: asserts that a given object `_obj` named `_obj_name`
  * (capitalized) is NOT frozen. This macro checks the `frozen` field of
  * `_obj`.
+ *
+ * This currently only exists in developer mode because some freezing
+ * functions can be called on the fast path, so they too are only
+ * enabled in developer mode.
  */
-#define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...)			\
+# define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...)		\
 	BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name,	\
 		##__VA_ARGS__)
 
+/* Developer mode version of BT_ASSERT_PRE_VALID_INDEX() */
+# define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)			\
+	BT_ASSERT_PRE_VALID_INDEX((_index), (_length))
+
 /*
- * Developer mode: asserts that a given index `_index` is less than a
- * given length `_length`.
+ * Marks a function as being only used within a BT_ASSERT_PRE_DEV()
+ * context.
  */
-#define BT_ASSERT_PRE_VALID_INDEX(_index, _length)			\
-	BT_ASSERT_PRE((_index) < (_length),				\
-		"Index is out of bounds: index=%" PRIu64 ", "		\
-		"count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
+# define BT_ASSERT_PRE_DEV_FUNC
+#else
+# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)
+# define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)	((void) sizeof((void) (_cond), 0))
+# define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name)			\
+	((void) sizeof((void) (_obj), (void) (_obj_name), 0))
+# define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...)		\
+	((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_FUNC		__attribute__((unused))
+#endif /* BT_DEV_MODE */
+
+#define BT_ASSERT_PRE_SUPPORTED
 
 #endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */