mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-12-27 11:29:36 +03:00
4b2220f0b9
Until now the notion of an internal debug logging infrastructure
was conflated with enabling ASSERT()s. This patch clarifies things
by cleanly breaking the two subsystem apart. The result of this
is the following behavior.
--enable-debug - Enable/disable code wrapped in ASSERT()s.
--disable-debug ASSERT()s are used to check invariants and
are never required for correct operation.
They are disabled by default because they
may impact performance.
--enable-debug-log - Enable/disable the debug log infrastructure.
--disable-debug-log This infrastructure allows the spl code and
its consumer to log messages to an in-kernel
log. The granularity of the logging can be
controlled by a debug mask. By default the
mask disables most debug messages resulting
in a negligible performance impact. Because
of this the debug log is enabled by default.
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
143 lines
5.0 KiB
C
143 lines
5.0 KiB
C
/*****************************************************************************\
|
|
* Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
|
|
* Copyright (C) 2007 The Regents of the University of California.
|
|
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
|
|
* Written by Brian Behlendorf <behlendorf1@llnl.gov>.
|
|
* UCRL-CODE-235197
|
|
*
|
|
* This file is part of the SPL, Solaris Porting Layer.
|
|
* For details, see <http://github.com/behlendorf/spl/>.
|
|
*
|
|
* The SPL is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
* option) any later version.
|
|
*
|
|
* The SPL is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with the SPL. If not, see <http://www.gnu.org/licenses/>.
|
|
\*****************************************************************************/
|
|
|
|
/*
|
|
* Available Solaris debug functions. All of the ASSERT() macros will be
|
|
* compiled out when NDEBUG is defined, this is the default behavior for
|
|
* the SPL. To enable assertions use the --enable-debug with configure.
|
|
* The VERIFY() functions are never compiled out and cannot be disabled.
|
|
*
|
|
* PANIC() - Panic the node and print message.
|
|
* ASSERT() - Assert X is true, if not panic.
|
|
* ASSERTF() - Assert X is true, if not panic and print message.
|
|
* ASSERTV() - Wraps a variable declaration which is only used by ASSERT().
|
|
* ASSERT3S() - Assert signed X OP Y is true, if not panic.
|
|
* ASSERT3U() - Assert unsigned X OP Y is true, if not panic.
|
|
* ASSERT3P() - Assert pointer X OP Y is true, if not panic.
|
|
* VERIFY() - Verify X is true, if not panic.
|
|
* VERIFY3S() - Verify signed X OP Y is true, if not panic.
|
|
* VERIFY3U() - Verify unsigned X OP Y is true, if not panic.
|
|
* VERIFY3P() - Verify pointer X OP Y is true, if not panic.
|
|
*/
|
|
|
|
#ifndef _SPL_DEBUG_H
|
|
#define _SPL_DEBUG_H
|
|
|
|
#include <spl-debug.h>
|
|
|
|
#ifdef NDEBUG /* Debugging Disabled */
|
|
|
|
/* Define SPL_DEBUG_STR to make clear which ASSERT definitions are used */
|
|
#define SPL_DEBUG_STR ""
|
|
|
|
#define PANIC(fmt, a...) \
|
|
do { \
|
|
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 ASSERTF(x, y, z...) ((void)0)
|
|
#define ASSERTV(x)
|
|
#define VERIFY(cond) \
|
|
do { \
|
|
if (unlikely(!(cond))) \
|
|
PANIC("VERIFY(" #cond ") failed\n"); \
|
|
} while (0)
|
|
|
|
#define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST) \
|
|
do { \
|
|
if (!((TYPE)(LEFT) OP (TYPE)(RIGHT))) \
|
|
PANIC("VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
|
|
"failed (" FMT " " #OP " " FMT ")\n", \
|
|
CAST (LEFT), CAST (RIGHT)); \
|
|
} while (0)
|
|
|
|
#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", \
|
|
(unsigned long long))
|
|
#define VERIFY3P(x,y,z) VERIFY3_IMPL(x, y, z, uintptr_t, "%p", (void *))
|
|
|
|
#define ASSERT3S(x,y,z) ((void)0)
|
|
#define ASSERT3U(x,y,z) ((void)0)
|
|
#define ASSERT3P(x,y,z) ((void)0)
|
|
|
|
#else /* Debugging Enabled */
|
|
|
|
/* Define SPL_DEBUG_STR to make clear which ASSERT definitions are used */
|
|
#define SPL_DEBUG_STR " (DEBUG mode)"
|
|
|
|
#define PANIC(fmt, a...) \
|
|
do { \
|
|
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 */
|
|
#define __ASSERT(cond) \
|
|
do { \
|
|
if (unlikely(!(cond))) { \
|
|
printk(KERN_EMERG "ASSERTION(" #cond ") failed\n"); \
|
|
BUG(); \
|
|
} \
|
|
} while (0)
|
|
|
|
/* ASSERTION that will debug log used outside the debug sysytem */
|
|
#define ASSERT(cond) \
|
|
do { \
|
|
if (unlikely(!(cond))) \
|
|
PANIC("ASSERTION(" #cond ") failed\n"); \
|
|
} while (0)
|
|
|
|
#define ASSERTF(cond, fmt, a...) \
|
|
do { \
|
|
if (unlikely(!(cond))) \
|
|
PANIC("ASSERTION(" #cond ") failed: " fmt, ## a); \
|
|
} while (0)
|
|
|
|
#define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST) \
|
|
do { \
|
|
if (!((TYPE)(LEFT) OP (TYPE)(RIGHT))) \
|
|
PANIC("VERIFY3(" #LEFT " " #OP " " #RIGHT ") " \
|
|
"failed (" FMT " " #OP " " FMT ")\n", \
|
|
CAST (LEFT), CAST (RIGHT)); \
|
|
} while (0)
|
|
|
|
#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", \
|
|
(unsigned long long))
|
|
#define VERIFY3P(x,y,z) VERIFY3_IMPL(x, y, z, uintptr_t, "%p", (void *))
|
|
|
|
#define ASSERT3S(x,y,z) VERIFY3S(x, y, z)
|
|
#define ASSERT3U(x,y,z) VERIFY3U(x, y, z)
|
|
#define ASSERT3P(x,y,z) VERIFY3P(x, y, z)
|
|
|
|
#define ASSERTV(x) x
|
|
#define VERIFY(x) ASSERT(x)
|
|
|
|
#endif /* NDEBUG */
|
|
#endif /* SPL_DEBUG_H */
|