bug.h 7.1 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
L
Linus Torvalds 已提交
2 3 4 5 6
#ifndef _ASM_GENERIC_BUG_H
#define _ASM_GENERIC_BUG_H

#include <linux/compiler.h>

7 8
#define CUT_HERE		"------------[ cut here ]------------\n"

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

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

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

#ifdef CONFIG_BUG
40

41 42 43 44 45 46 47 48 49 50 51
/*
 * 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 已提交
52 53
#ifndef HAVE_ARCH_BUG
#define BUG() do { \
54
	printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
55
	barrier_before_unreachable(); \
L
Linus Torvalds 已提交
56 57 58 59 60
	panic("BUG!"); \
} while (0)
#endif

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

64 65 66 67 68 69 70 71 72 73 74 75
#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

76 77
/*
 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
78 79 80 81 82 83 84 85 86 87 88 89 90
 * significant kernel issues that need prompt attention if they should ever
 * appear at runtime.
 *
 * Do not use these macros when checking for invalid external inputs
 * (e.g. invalid system call arguments, or invalid data coming from
 * network/devices), and on transient conditions like ENOMEM or EAGAIN.
 * These macros should be used for recoverable kernel issues only.
 * For invalid external inputs, transient conditions, etc use
 * pr_err[_once/_ratelimited]() followed by dump_stack(), if necessary.
 * Do not include "BUG"/"WARNING" in format strings manually to make these
 * conditions distinguishable from kernel issues.
 *
 * Use the versions with printk format strings to provide better diagnostics.
91
 */
92
#ifndef __WARN_TAINT
93 94 95 96 97 98
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, ...);
99
extern void warn_slowpath_null(const char *file, const int line);
100
#define WANT_WARN_ON_SLOWPATH
101 102
#define __WARN()		warn_slowpath_null(__FILE__, __LINE__)
#define __WARN_printf(arg...)	warn_slowpath_fmt(__FILE__, __LINE__, arg)
103 104
#define __WARN_printf_taint(taint, arg...)				\
	warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
105
#else
106
extern __printf(1, 2) void __warn_printk(const char *fmt, ...);
107
#define __WARN()		__WARN_TAINT(TAINT_WARN)
108
#define __WARN_printf(arg...)	do { __warn_printk(arg); __WARN(); } while (0)
109
#define __WARN_printf_taint(taint, arg...)				\
110
	do { __warn_printk(arg); __WARN_TAINT(taint); } while (0)
O
Olof Johansson 已提交
111 112
#endif

113 114
/* used internally by panic.c */
struct warn_args;
115
struct pt_regs;
116 117 118 119

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

O
Olof Johansson 已提交
120
#ifndef WARN_ON
121
#define WARN_ON(condition) ({						\
L
Linus Torvalds 已提交
122
	int __ret_warn_on = !!(condition);				\
O
Olof Johansson 已提交
123 124
	if (unlikely(__ret_warn_on))					\
		__WARN();						\
125 126
	unlikely(__ret_warn_on);					\
})
L
Linus Torvalds 已提交
127 128
#endif

129
#ifndef WARN
130
#define WARN(condition, format...) ({					\
131 132 133 134 135 136 137
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN_printf(format);					\
	unlikely(__ret_warn_on);					\
})
#endif

138 139 140 141 142 143 144
#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);					\
})

145
#ifndef WARN_ON_ONCE
146
#define WARN_ON_ONCE(condition)	({				\
147
	static bool __section(.data.once) __warned;		\
L
Linus Torvalds 已提交
148
	int __ret_warn_once = !!(condition);			\
149
								\
150 151 152 153
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_ON(1);					\
	}							\
154
	unlikely(__ret_warn_once);				\
155
})
156
#endif
157

158
#define WARN_ONCE(condition, format...)	({			\
159
	static bool __section(.data.once) __warned;		\
160 161
	int __ret_warn_once = !!(condition);			\
								\
162 163 164 165
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN(1, format);				\
	}							\
166 167 168
	unlikely(__ret_warn_once);				\
})

169
#define WARN_TAINT_ONCE(condition, taint, format...)	({	\
170
	static bool __section(.data.once) __warned;		\
171 172
	int __ret_warn_once = !!(condition);			\
								\
173 174 175 176
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_TAINT(1, taint, format);			\
	}							\
177 178 179
	unlikely(__ret_warn_once);				\
})

180 181
#else /* !CONFIG_BUG */
#ifndef HAVE_ARCH_BUG
182
#define BUG() do {} while (1)
183 184 185
#endif

#ifndef HAVE_ARCH_BUG_ON
186
#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
187 188 189 190 191 192 193 194 195 196 197 198
#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);				\
199
	no_printk(format);						\
200 201 202 203 204 205 206 207 208 209 210
	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

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
/*
 * 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.
 */
237 238 239
#ifdef CONFIG_SMP
# define WARN_ON_SMP(x)			WARN_ON(x)
#else
240 241 242 243 244 245 246
/*
 * 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.
 */
247
# define WARN_ON_SMP(x)			({0;})
248 249
#endif

250 251
#endif /* __ASSEMBLY__ */

L
Linus Torvalds 已提交
252
#endif