X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fassert-pre.h;h=39472a44cba9478967b9afdb0c03901b7b8ea426;hb=5084732e40a7925d22f741e4ed08f19d36078fbe;hp=7636b56a8dce4b739de9601f4ab7fa5ea16373df;hpb=f2371a94ac704928244e9feb22888abf8df54a1c;p=babeltrace.git diff --git a/src/lib/assert-pre.h b/src/lib/assert-pre.h index 7636b56a..39472a44 100644 --- a/src/lib/assert-pre.h +++ b/src/lib/assert-pre.h @@ -25,49 +25,24 @@ */ /* - * The macros in this header use macros defined in "lib/lib-logging.h". + * The macros in this header use macros defined in "lib/logging.h". * We don't want this header to automatically include - * "lib/lib-logging.h" because you need to manually define BT_LOG_TAG - * before including "lib/lib-logging.h" and it is unexpected that you + * "lib/logging.h" because you need to manually define BT_LOG_TAG + * before including "lib/logging.h" and it is unexpected that you * also need to define it before including this header. * * This is a reminder that in order to use "lib/assert-pre.h", you also * need to use logging explicitly. */ -#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H -# error Include "lib/lib-logging.h" before this header. +#ifndef BT_LIB_LOG_SUPPORTED +# error Include "lib/logging.h" before this header. #endif #include #include #include "common/macros.h" -#ifdef BT_DEV_MODE -/* - * Asserts that the library precondition _cond is satisfied. - * - * If _cond is false, log a fatal statement using _fmt and the optional - * arguments using BT_LIB_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(). - */ -# define BT_ASSERT_PRE(_cond, _fmt, ...) \ - do { \ - if (!(_cond)) { \ - BT_LOGF_STR("Library precondition not satisfied; error is:"); \ - BT_LIB_LOGF((_fmt), ##__VA_ARGS__); \ - BT_LOGF_STR("Aborting..."); \ - abort(); \ - } \ - } while (0) - -/* - * Marks a function as being only used within a BT_ASSERT_PRE() context. - */ -# define BT_ASSERT_PRE_FUNC - /* * Prints the details of an unsatisfied precondition without immediately * aborting. You should use this within a function which checks @@ -77,7 +52,6 @@ * * Example: * - * BT_ASSERT_PRE_FUNC * static inline bool check_complex_precond(...) * { * ... @@ -95,33 +69,98 @@ * BT_ASSERT_PRE(check_complex_precond(...), * "Precondition is not satisfied: ...", ...); */ -# define BT_ASSERT_PRE_MSG BT_LIB_LOGF -#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_MSG(_fmt, ...) \ + do { \ + bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \ + __LINE__, BT_LOG_FATAL, BT_LOG_TAG, \ + (_fmt), ##__VA_ARGS__); \ + } while (0) /* - * Developer mode: asserts that a given variable is not NULL. + * 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. + * + * To assert that a library postcondition is satisfied (return from user + * code), use BT_ASSERT_POST(). + * + * To assert that an internal postcondition is satisfied, use + * BT_ASSERT(). */ -#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \ - BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name) +#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("Aborting..."); \ + abort(); \ + } \ + } while (0) /* - * Developer mode: asserts that a given object is NOT frozen. This macro - * checks the `frozen` field of _obj. + * Asserts that a given variable `_obj` named `_obj_name` (capitalized) + * is not `NULL`. */ -#define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...) \ - BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \ - ##__VA_ARGS__) +#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \ + BT_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name) /* - * Developer mode: asserts that a given index is less than a given size. + * Asserts that a given index `_index` is less than a given length + * `_length`. */ #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_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)) + +/* + * 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, ...) +# 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 */