bug.h 5.93 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5
#ifndef _ASM_GENERIC_BUG_H
#define _ASM_GENERIC_BUG_H

#include <linux/compiler.h>

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

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

15
#ifdef CONFIG_BUG
16 17 18

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

36 37 38 39 40 41 42 43 44 45 46
/*
 * 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.
 */
Linus Torvalds's avatar
Linus Torvalds committed
47 48
#ifndef HAVE_ARCH_BUG
#define BUG() do { \
49
	printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
Linus Torvalds's avatar
Linus Torvalds committed
50 51 52 53 54
	panic("BUG!"); \
} while (0)
#endif

#ifndef HAVE_ARCH_BUG_ON
55
#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
Linus Torvalds's avatar
Linus Torvalds committed
56 57
#endif

58 59 60 61 62 63
/*
 * 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.
 */
64
#ifndef __WARN_TAINT
65 66 67 68 69 70
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, ...);
71
extern void warn_slowpath_null(const char *file, const int line);
72
#define WANT_WARN_ON_SLOWPATH
73 74
#define __WARN()		warn_slowpath_null(__FILE__, __LINE__)
#define __WARN_printf(arg...)	warn_slowpath_fmt(__FILE__, __LINE__, arg)
75 76
#define __WARN_printf_taint(taint, arg...)				\
	warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
77
#else
78
#define __WARN()		__WARN_TAINT(TAINT_WARN)
79
#define __WARN_printf(arg...)	do { printk(arg); __WARN(); } while (0)
80 81
#define __WARN_printf_taint(taint, arg...)				\
	do { printk(arg); __WARN_TAINT(taint); } while (0)
82 83
#endif

84 85 86 87 88 89
/* 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);

90
#ifndef WARN_ON
91
#define WARN_ON(condition) ({						\
92
	int __ret_warn_on = !!(condition);				\
93 94
	if (unlikely(__ret_warn_on))					\
		__WARN();						\
95 96
	unlikely(__ret_warn_on);					\
})
Linus Torvalds's avatar
Linus Torvalds committed
97 98
#endif

99 100 101 102 103 104 105 106 107
#ifndef WARN
#define WARN(condition, format...) ({						\
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN_printf(format);					\
	unlikely(__ret_warn_on);					\
})
#endif

108 109 110 111 112 113 114
#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);					\
})

115
#define WARN_ON_ONCE(condition)	({				\
116
	static bool __section(.data.unlikely) __warned;		\
117
	int __ret_warn_once = !!(condition);			\
118
								\
119 120 121 122
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_ON(1);					\
	}							\
123
	unlikely(__ret_warn_once);				\
124 125
})

126
#define WARN_ONCE(condition, format...)	({			\
127
	static bool __section(.data.unlikely) __warned;		\
128 129
	int __ret_warn_once = !!(condition);			\
								\
130 131 132 133
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN(1, format);				\
	}							\
134 135 136
	unlikely(__ret_warn_once);				\
})

137
#define WARN_TAINT_ONCE(condition, taint, format...)	({	\
138
	static bool __section(.data.unlikely) __warned;		\
139 140
	int __ret_warn_once = !!(condition);			\
								\
141 142 143 144
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_TAINT(1, taint, format);			\
	}							\
145 146 147
	unlikely(__ret_warn_once);				\
})

148 149
#else /* !CONFIG_BUG */
#ifndef HAVE_ARCH_BUG
150
#define BUG() do {} while (1)
151 152 153
#endif

#ifndef HAVE_ARCH_BUG_ON
154
#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
155 156 157 158 159 160 161 162 163 164 165 166
#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);				\
167
	no_printk(format);						\
168 169 170 171 172 173 174 175 176 177 178
	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

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
/*
 * 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.
 */
205 206 207
#ifdef CONFIG_SMP
# define WARN_ON_SMP(x)			WARN_ON(x)
#else
208 209 210 211 212 213 214
/*
 * 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.
 */
215
# define WARN_ON_SMP(x)			({0;})
216 217
#endif

218 219
#endif /* __ASSEMBLY__ */

Linus Torvalds's avatar
Linus Torvalds committed
220
#endif