Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity

Safer debugging and assertion macros. 

Spl's debugging and assertion macros macro used the typical do/while(0)
form for if/else friendliness, however, this limits their use in contexts
where a do loop is not valid; such as within another multi-statement
style macro.

The following macros have been converted to not use do/while(0):
	PANIC, ASSERT, ASSERTF, VERIFY, VERIFY3_IMPL

PANIC has been converted to a wrapper around the new spl_PANIC() function.

The other macros have been converted to use the "&&" operator for the
branch-predicition conditional and also to use spl_PANIC().

The __ASSERT() macro was not touched.  It is only used by the debugging
infrastructure and that code, including this macro, will be retired when
the tracepoint patches are merged.

Signed-off-by: Tim Chase <tim@chase2k.com>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Closes #367
This commit is contained in:
Tim Chase 2014-06-18 15:22:50 -05:00 committed by Brian Behlendorf
parent 31cb5383bf
commit f6a869614e
2 changed files with 46 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
include/sys/debug.h
View File

@ -54,28 +54,23 @@
#define SPL_DEBUG_STR "" #define SPL_DEBUG_STR ""
#define PANIC(fmt, a...) \ #define PANIC(fmt, a...) \
do { \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, fmt, ## a)
printk(KERN_EMERG fmt, ## a); \
spl_debug_bug(__FILE__, __FUNCTION__, __LINE__, 0); \
} while (0)
#define __ASSERT(x) ((void)0) #define __ASSERT(x) ((void)0)
#define ASSERT(x) ((void)0) #define ASSERT(x) ((void)0)
#define ASSERTF(x, y, z...) ((void)0) #define ASSERTF(x, y, z...) ((void)0)
#define ASSERTV(x) #define ASSERTV(x)
#define VERIFY(cond) \ #define VERIFY(cond) \
do { \ (void)(unlikely(!(cond)) && \
if (unlikely(!(cond))) \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, \
PANIC("VERIFY(" #cond ") failed\n"); \ "%s", "VERIFY(" #cond ") failed\n"))
} while (0)
#define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST) \ #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST) \
do { \ (void)((!((TYPE)(LEFT) OP (TYPE)(RIGHT))) && \
if (!((TYPE)(LEFT) OP (TYPE)(RIGHT))) \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, \
PANIC("VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \ "VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (" FMT " " #OP " " FMT ")\n", \ "failed (" FMT " " #OP " " FMT ")\n", \
CAST (LEFT), CAST (RIGHT)); \ CAST (LEFT), CAST (RIGHT)))
} while (0)
#define VERIFY3S(x,y,z) VERIFY3_IMPL(x, y, z, int64_t, "%lld", (long long)) #define VERIFY3S(x,y,z) VERIFY3_IMPL(x, y, z, int64_t, "%lld", (long long))
#define VERIFY3U(x,y,z) VERIFY3_IMPL(x, y, z, uint64_t, "%llu", \ #define VERIFY3U(x,y,z) VERIFY3_IMPL(x, y, z, uint64_t, "%llu", \
@ -94,11 +89,7 @@ do { \
#define SPL_DEBUG_STR " (DEBUG mode)" #define SPL_DEBUG_STR " (DEBUG mode)"
#define PANIC(fmt, a...) \ #define PANIC(fmt, a...) \
do { \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, fmt, ## a)
spl_debug_msg(NULL, 0, 0, \
__FILE__, __FUNCTION__, __LINE__, fmt, ## a); \
spl_debug_bug(__FILE__, __FUNCTION__, __LINE__, 0); \
} while (0)
/* ASSERTION that is safe to use within the debug system */ /* ASSERTION that is safe to use within the debug system */
#define __ASSERT(cond) \ #define __ASSERT(cond) \
@ -111,24 +102,21 @@ do { \
/* ASSERTION that will debug log used outside the debug sysytem */ /* ASSERTION that will debug log used outside the debug sysytem */
#define ASSERT(cond) \ #define ASSERT(cond) \
do { \ (void)(unlikely(!(cond)) && \
if (unlikely(!(cond))) \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, \
PANIC("ASSERTION(" #cond ") failed\n"); \ "%s", "ASSERTION(" #cond ") failed\n"))
} while (0)
#define ASSERTF(cond, fmt, a...) \ #define ASSERTF(cond, fmt, a...) \
do { \ (void)(unlikely(!(cond)) && \
if (unlikely(!(cond))) \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, \
PANIC("ASSERTION(" #cond ") failed: " fmt, ## a); \ "ASSERTION(" #cond ") failed: " fmt, ## a))
} while (0)
#define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST) \ #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST) \
do { \ (void)((!((TYPE)(LEFT) OP (TYPE)(RIGHT))) && \
if (!((TYPE)(LEFT) OP (TYPE)(RIGHT))) \ spl_PANIC(__FILE__, __FUNCTION__, __LINE__, \
PANIC("VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \ "VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
"failed (" FMT " " #OP " " FMT ")\n", \ "failed (" FMT " " #OP " " FMT ")\n", \
CAST (LEFT), CAST (RIGHT)); \ CAST (LEFT), CAST (RIGHT)))
} while (0)
#define VERIFY3S(x,y,z) VERIFY3_IMPL(x, y, z, int64_t, "%lld", (long long)) #define VERIFY3S(x,y,z) VERIFY3_IMPL(x, y, z, int64_t, "%lld", (long long))
#define VERIFY3U(x,y,z) VERIFY3_IMPL(x, y, z, uint64_t, "%llu", \ #define VERIFY3U(x,y,z) VERIFY3_IMPL(x, y, z, uint64_t, "%llu", \
@ -146,6 +134,12 @@ do { \
#endif /* NDEBUG */ #endif /* NDEBUG */
/*
* Helpers for the Solaris debug macros above
*/
extern int spl_PANIC(char *filename, const char *functionname,
int lineno, const char *fmt, ...);
/* /*
* Compile-time assertion. The condition 'x' must be constant. * Compile-time assertion. The condition 'x' must be constant.
*/ */

21
module/spl/spl-err.c
View File

@ -39,6 +39,27 @@ static char ce_prefix[CE_IGNORE][10] = { "", "NOTICE: ", "WARNING: ", "" };
static char ce_suffix[CE_IGNORE][2] = { "", "\n", "\n", "" }; static char ce_suffix[CE_IGNORE][2] = { "", "\n", "\n", "" };
#endif #endif
int
spl_PANIC(char *filename, const char *functionname,
int lineno, const char *fmt, ...) {
char msg[MAXMSGLEN];
va_list ap;
va_start(ap, fmt);
if (vsnprintf(msg, sizeof (msg), fmt, ap) == sizeof (msg))
msg[sizeof (msg) - 1] = '\0';
va_end(ap);
#ifdef NDEBUG
printk(KERN_EMERG "%s", msg);
#else
spl_debug_msg(NULL, 0, 0,
filename, functionname, lineno, "%s", msg);
#endif
spl_debug_bug(filename, functionname, lineno, 0);
return 1;
}
EXPORT_SYMBOL(spl_PANIC);
void void
vpanic(const char *fmt, va_list ap) vpanic(const char *fmt, va_list ap)
{ {