bug.h 6.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5
#ifndef _ASM_GENERIC_BUG_H
#define _ASM_GENERIC_BUG_H

#include <linux/compiler.h>

6 7
#ifdef CONFIG_GENERIC_BUG
#define BUGFLAG_WARNING		(1 << 0)
8 9
#define BUGFLAG_ONCE		(1 << 1)
#define BUGFLAG_DONE		(1 << 2)
10 11 12 13 14 15 16
#define BUGFLAG_TAINT(taint)	(BUGFLAG_WARNING | ((taint) << 8))
#define BUG_GET_TAINT(bug)	((bug)->flags >> 8)
#endif

#ifndef __ASSEMBLY__
#include <linux/kernel.h>

M
Matt Mackall 已提交
17
#ifdef CONFIG_BUG
18 19 20

#ifdef CONFIG_GENERIC_BUG
struct bug_entry {
21
#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
22
	unsigned long	bug_addr;
23 24 25
#else
	signed int	bug_addr_disp;
#endif
26
#ifdef CONFIG_DEBUG_BUGVERBOSE
27
#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
28
	const char	*file;
29 30 31
#else
	signed int	file_disp;
#endif
32 33 34 35 36 37
	unsigned short	line;
#endif
	unsigned short	flags;
};
#endif	/* CONFIG_GENERIC_BUG */

38 39 40 41 42 43 44 45 46 47 48
/*
 * Don't use BUG() or BUG_ON() unless there's really no way out; one
 * example might be detecting data structure corruption in the middle
 * of an operation that can't be backed out of.  If the (sub)system
 * can somehow continue operating, perhaps with reduced functionality,
 * it's probably not BUG-worthy.
 *
 * If you're tempted to BUG(), think again:  is completely giving up
 * really the *only* solution?  There are usually better options, where
 * users don't need to reboot ASAP and can mostly shut down cleanly.
 */
L
Linus Torvalds 已提交
49 50
#ifndef HAVE_ARCH_BUG
#define BUG() do { \
51
	printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
L
Linus Torvalds 已提交
52 53 54 55 56
	panic("BUG!"); \
} while (0)
#endif

#ifndef HAVE_ARCH_BUG_ON
57
#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
L
Linus Torvalds 已提交
58 59
#endif

60 61 62 63 64 65 66 67 68 69 70 71
#ifdef __WARN_FLAGS
#define __WARN_TAINT(taint)		__WARN_FLAGS(BUGFLAG_TAINT(taint))
#define __WARN_ONCE_TAINT(taint)	__WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint))

#define WARN_ON_ONCE(condition) ({				\
	int __ret_warn_on = !!(condition);			\
	if (unlikely(__ret_warn_on))				\
		__WARN_ONCE_TAINT(TAINT_WARN);			\
	unlikely(__ret_warn_on);				\
})
#endif

72 73 74 75 76 77
/*
 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
 * significant issues that need prompt attention if they should ever
 * appear at runtime.  Use the versions with printk format strings
 * to provide better diagnostics.
 */
78
#ifndef __WARN_TAINT
79 80 81 82 83 84
extern __printf(3, 4)
void warn_slowpath_fmt(const char *file, const int line,
		       const char *fmt, ...);
extern __printf(4, 5)
void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
			     const char *fmt, ...);
85
extern void warn_slowpath_null(const char *file, const int line);
86
#define WANT_WARN_ON_SLOWPATH
87 88
#define __WARN()		warn_slowpath_null(__FILE__, __LINE__)
#define __WARN_printf(arg...)	warn_slowpath_fmt(__FILE__, __LINE__, arg)
89 90
#define __WARN_printf_taint(taint, arg...)				\
	warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
91
#else
92
#define __WARN()		__WARN_TAINT(TAINT_WARN)
93
#define __WARN_printf(arg...)	do { printk(arg); __WARN(); } while (0)
94 95
#define __WARN_printf_taint(taint, arg...)				\
	do { printk(arg); __WARN_TAINT(taint); } while (0)
O
Olof Johansson 已提交
96 97
#endif

98 99 100 101 102 103
/* used internally by panic.c */
struct warn_args;

void __warn(const char *file, int line, void *caller, unsigned taint,
	    struct pt_regs *regs, struct warn_args *args);

O
Olof Johansson 已提交
104
#ifndef WARN_ON
105
#define WARN_ON(condition) ({						\
L
Linus Torvalds 已提交
106
	int __ret_warn_on = !!(condition);				\
O
Olof Johansson 已提交
107 108
	if (unlikely(__ret_warn_on))					\
		__WARN();						\
109 110
	unlikely(__ret_warn_on);					\
})
L
Linus Torvalds 已提交
111 112
#endif

113
#ifndef WARN
114
#define WARN(condition, format...) ({					\
115 116 117 118 119 120 121
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN_printf(format);					\
	unlikely(__ret_warn_on);					\
})
#endif

122 123 124 125 126 127 128
#define WARN_TAINT(condition, taint, format...) ({			\
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN_printf_taint(taint, format);			\
	unlikely(__ret_warn_on);					\
})

129
#ifndef WARN_ON_ONCE
130
#define WARN_ON_ONCE(condition)	({				\
131
	static bool __section(.data.unlikely) __warned;		\
L
Linus Torvalds 已提交
132
	int __ret_warn_once = !!(condition);			\
133
								\
134 135 136 137
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_ON(1);					\
	}							\
138
	unlikely(__ret_warn_once);				\
139
})
140
#endif
141

142
#define WARN_ONCE(condition, format...)	({			\
143
	static bool __section(.data.unlikely) __warned;		\
144 145
	int __ret_warn_once = !!(condition);			\
								\
146 147 148 149
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN(1, format);				\
	}							\
150 151 152
	unlikely(__ret_warn_once);				\
})

153
#define WARN_TAINT_ONCE(condition, taint, format...)	({	\
154
	static bool __section(.data.unlikely) __warned;		\
155 156
	int __ret_warn_once = !!(condition);			\
								\
157 158 159 160
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_TAINT(1, taint, format);			\
	}							\
161 162 163
	unlikely(__ret_warn_once);				\
})

164 165
#else /* !CONFIG_BUG */
#ifndef HAVE_ARCH_BUG
166
#define BUG() do {} while (1)
167 168 169
#endif

#ifndef HAVE_ARCH_BUG_ON
170
#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
171 172 173 174 175 176 177 178 179 180 181 182
#endif

#ifndef HAVE_ARCH_WARN_ON
#define WARN_ON(condition) ({						\
	int __ret_warn_on = !!(condition);				\
	unlikely(__ret_warn_on);					\
})
#endif

#ifndef WARN
#define WARN(condition, format...) ({					\
	int __ret_warn_on = !!(condition);				\
183
	no_printk(format);						\
184 185 186 187 188 189 190 191 192 193 194
	unlikely(__ret_warn_on);					\
})
#endif

#define WARN_ON_ONCE(condition) WARN_ON(condition)
#define WARN_ONCE(condition, format...) WARN(condition, format)
#define WARN_TAINT(condition, taint, format...) WARN(condition, format)
#define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format)

#endif

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
/*
 * WARN_ON_SMP() is for cases that the warning is either
 * meaningless for !SMP or may even cause failures.
 * This is usually used for cases that we have
 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
 * returns 0 for uniprocessor settings.
 * It can also be used with values that are only defined
 * on SMP:
 *
 * struct foo {
 *  [...]
 * #ifdef CONFIG_SMP
 *	int bar;
 * #endif
 * };
 *
 * void func(struct foo *zoot)
 * {
 *	WARN_ON_SMP(!zoot->bar);
 *
 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
 * and should be a nop and return false for uniprocessor.
 *
 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
 * and x is true.
 */
221 222 223
#ifdef CONFIG_SMP
# define WARN_ON_SMP(x)			WARN_ON(x)
#else
224 225 226 227 228 229 230
/*
 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
 * a stand alone line statement or as a condition in an if ()
 * statement.
 * A simple "0" would cause gcc to give a "statement has no effect"
 * warning.
 */
231
# define WARN_ON_SMP(x)			({0;})
232 233
#endif

234 235
#endif /* __ASSEMBLY__ */

L
Linus Torvalds 已提交
236
#endif