Skip to content

Commit

Permalink
Clean up existing VERIFY*() macros.
Browse files Browse the repository at this point in the history
Chiefly:

- Remove unnecessary parentheses around variable names.
- Remove spaces between the type and variable in casts.
- Make the panic message for VERIFY0() reflect how the macro is used.
- Use %p to format pointers, except in Linux kernel code.

Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by: Kay Pedersen <[email protected]>
Reviewed-by: Alexander Motin <[email protected]>
Signed-off-by: Dag-Erling Smørgrav <[email protected]>
Closes openzfs#15225
  • Loading branch information
dag-erling authored and lundman committed Dec 11, 2023
1 parent 53ad03b commit b363d08
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 29 deletions.
27 changes: 13 additions & 14 deletions include/os/freebsd/spl/sys/debug.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%d " #OP " %d)\n", \
(boolean_t)(_verify3_left), \
(boolean_t)(_verify3_right)); \
(boolean_t)_verify3_left, \
(boolean_t)_verify3_right); \
} while (0)

#define VERIFY3S(LEFT, OP, RIGHT) do { \
Expand All @@ -100,8 +100,8 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%lld " #OP " %lld)\n", \
(long long) (_verify3_left), \
(long long) (_verify3_right)); \
(long long)_verify3_left, \
(long long)_verify3_right); \
} while (0)

#define VERIFY3U(LEFT, OP, RIGHT) do { \
Expand All @@ -111,8 +111,8 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%llu " #OP " %llu)\n", \
(unsigned long long) (_verify3_left), \
(unsigned long long) (_verify3_right)); \
(unsigned long long)_verify3_left, \
(unsigned long long)_verify3_right); \
} while (0)

#define VERIFY3P(LEFT, OP, RIGHT) do { \
Expand All @@ -121,19 +121,18 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
if (unlikely(!(_verify3_left OP _verify3_right))) \
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%px " #OP " %px)\n", \
(void *) (_verify3_left), \
(void *) (_verify3_right)); \
"failed (%p " #OP " %p)\n", \
(void *)_verify3_left, \
(void *)_verify3_right); \
} while (0)

#define VERIFY0(RIGHT) do { \
const int64_t _verify3_left = (int64_t)(0); \
const int64_t _verify3_right = (int64_t)(RIGHT); \
if (unlikely(!(_verify3_left == _verify3_right))) \
const int64_t _verify0_right = (int64_t)(RIGHT); \
if (unlikely(!(0 == _verify0_right))) \
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY0(0 == " #RIGHT ") " \
"VERIFY0(" #RIGHT ") " \
"failed (0 == %lld)\n", \
(long long) (_verify3_right)); \
(long long)_verify0_right); \
} while (0)

/*
Expand Down
25 changes: 12 additions & 13 deletions include/os/linux/spl/sys/debug.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%d " #OP " %d)\n", \
(boolean_t)(_verify3_left), \
(boolean_t)(_verify3_right)); \
(boolean_t)_verify3_left, \
(boolean_t)_verify3_right); \
} while (0)

#define VERIFY3S(LEFT, OP, RIGHT) do { \
Expand All @@ -104,8 +104,8 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%lld " #OP " %lld)\n", \
(long long)(_verify3_left), \
(long long)(_verify3_right)); \
(long long)_verify3_left, \
(long long)_verify3_right); \
} while (0)

#define VERIFY3U(LEFT, OP, RIGHT) do { \
Expand All @@ -115,8 +115,8 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%llu " #OP " %llu)\n", \
(unsigned long long)(_verify3_left), \
(unsigned long long)(_verify3_right)); \
(unsigned long long)_verify3_left, \
(unsigned long long)_verify3_right); \
} while (0)

#define VERIFY3P(LEFT, OP, RIGHT) do { \
Expand All @@ -126,18 +126,17 @@ spl_assert(const char *buf, const char *file, const char *func, int line)
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (%px " #OP " %px)\n", \
(void *) (_verify3_left), \
(void *) (_verify3_right)); \
(void *)_verify3_left, \
(void *)_verify3_right); \
} while (0)

#define VERIFY0(RIGHT) do { \
const int64_t _verify3_left = (int64_t)(0); \
const int64_t _verify3_right = (int64_t)(RIGHT); \
if (unlikely(!(_verify3_left == _verify3_right))) \
const int64_t _verify0_right = (int64_t)(RIGHT); \
if (unlikely(!(0 == _verify0_right))) \
spl_panic(__FILE__, __FUNCTION__, __LINE__, \
"VERIFY0(0 == " #RIGHT ") " \
"VERIFY0(" #RIGHT ") " \
"failed (0 == %lld)\n", \
(long long) (_verify3_right)); \
(long long)_verify0_right); \
} while (0)

#define VERIFY_IMPLY(A, B) \
Expand Down
4 changes: 2 additions & 2 deletions lib/libspl/include/assert.h
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ do { \
const uintptr_t __right = (uintptr_t)(RIGHT); \
if (!(__left OP __right)) \
libspl_assertf(__FILE__, __FUNCTION__, __LINE__, \
"%s %s %s (0x%llx %s 0x%llx)", #LEFT, #OP, #RIGHT, \
(u_longlong_t)__left, #OP, (u_longlong_t)__right); \
"%s %s %s (%p %s %p)", #LEFT, #OP, #RIGHT, \
(void *)__left, #OP, (void *)__right); \
} while (0)

#define VERIFY0(LEFT) \
Expand Down

0 comments on commit b363d08

Please sign in to comment.