Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef _ASM_GENERIC_BUG_H |
3 | #define _ASM_GENERIC_BUG_H | |
4 | ||
5 | #include <linux/compiler.h> | |
1da177e4 | 6 | |
2a8358d8 KC |
7 | #define CUT_HERE "------------[ cut here ]------------\n" |
8 | ||
09682c1d PM |
9 | #ifdef CONFIG_GENERIC_BUG |
10 | #define BUGFLAG_WARNING (1 << 0) | |
19d43626 PZ |
11 | #define BUGFLAG_ONCE (1 << 1) |
12 | #define BUGFLAG_DONE (1 << 2) | |
f26dee15 | 13 | #define BUGFLAG_TAINT(taint) ((taint) << 8) |
09682c1d PM |
14 | #define BUG_GET_TAINT(bug) ((bug)->flags >> 8) |
15 | #endif | |
16 | ||
17 | #ifndef __ASSEMBLY__ | |
18 | #include <linux/kernel.h> | |
19 | ||
ffb61c63 IM |
20 | #ifdef CONFIG_BUG |
21 | ||
f81f8ad5 | 22 | #ifdef CONFIG_GENERIC_BUG |
ffb61c63 | 23 | struct bug_entry { |
b93a531e | 24 | #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS |
7664c5a1 | 25 | unsigned long bug_addr; |
b93a531e JB |
26 | #else |
27 | signed int bug_addr_disp; | |
28 | #endif | |
7664c5a1 | 29 | #ifdef CONFIG_DEBUG_BUGVERBOSE |
b93a531e | 30 | #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS |
7664c5a1 | 31 | const char *file; |
b93a531e JB |
32 | #else |
33 | signed int file_disp; | |
34 | #endif | |
7664c5a1 JF |
35 | unsigned short line; |
36 | #endif | |
37 | unsigned short flags; | |
f81f8ad5 | 38 | }; |
ffb61c63 | 39 | #endif /* CONFIG_GENERIC_BUG */ |
7664c5a1 | 40 | |
af9379c7 DB |
41 | /* |
42 | * Don't use BUG() or BUG_ON() unless there's really no way out; one | |
43 | * example might be detecting data structure corruption in the middle | |
44 | * of an operation that can't be backed out of. If the (sub)system | |
45 | * can somehow continue operating, perhaps with reduced functionality, | |
46 | * it's probably not BUG-worthy. | |
47 | * | |
48 | * If you're tempted to BUG(), think again: is completely giving up | |
49 | * really the *only* solution? There are usually better options, where | |
50 | * users don't need to reboot ASAP and can mostly shut down cleanly. | |
51 | */ | |
1da177e4 LT |
52 | #ifndef HAVE_ARCH_BUG |
53 | #define BUG() do { \ | |
d5c003b4 | 54 | printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \ |
173a3efd | 55 | barrier_before_unreachable(); \ |
1da177e4 LT |
56 | panic("BUG!"); \ |
57 | } while (0) | |
58 | #endif | |
59 | ||
1da177e4 | 60 | #ifndef HAVE_ARCH_BUG_ON |
a3f7607d | 61 | #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) |
1da177e4 LT |
62 | #endif |
63 | ||
19d43626 PZ |
64 | #ifdef __WARN_FLAGS |
65 | #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint)) | |
66 | #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint)) | |
67 | ||
68 | #define WARN_ON_ONCE(condition) ({ \ | |
69 | int __ret_warn_on = !!(condition); \ | |
70 | if (unlikely(__ret_warn_on)) \ | |
71 | __WARN_ONCE_TAINT(TAINT_WARN); \ | |
72 | unlikely(__ret_warn_on); \ | |
73 | }) | |
74 | #endif | |
75 | ||
af9379c7 DB |
76 | /* |
77 | * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report | |
96c6a32c DV |
78 | * significant kernel issues that need prompt attention if they should ever |
79 | * appear at runtime. | |
80 | * | |
81 | * Do not use these macros when checking for invalid external inputs | |
82 | * (e.g. invalid system call arguments, or invalid data coming from | |
83 | * network/devices), and on transient conditions like ENOMEM or EAGAIN. | |
84 | * These macros should be used for recoverable kernel issues only. | |
85 | * For invalid external inputs, transient conditions, etc use | |
86 | * pr_err[_once/_ratelimited]() followed by dump_stack(), if necessary. | |
87 | * Do not include "BUG"/"WARNING" in format strings manually to make these | |
88 | * conditions distinguishable from kernel issues. | |
89 | * | |
90 | * Use the versions with printk format strings to provide better diagnostics. | |
af9379c7 | 91 | */ |
b2be0527 | 92 | #ifndef __WARN_TAINT |
b9075fa9 | 93 | extern __printf(4, 5) |
ee871133 KC |
94 | void warn_slowpath_fmt(const char *file, const int line, unsigned taint, |
95 | const char *fmt, ...); | |
79b4cc5e | 96 | #define WANT_WARN_ON_SLOWPATH |
f2f84b05 | 97 | #define __WARN() __WARN_printf(TAINT_WARN, NULL) |
89348fc3 | 98 | #define __WARN_printf(taint, arg...) \ |
ee871133 | 99 | warn_slowpath_fmt(__FILE__, __LINE__, taint, arg) |
a8f18b90 | 100 | #else |
a7bed27a | 101 | extern __printf(1, 2) void __warn_printk(const char *fmt, ...); |
6b15f678 DD |
102 | #define __WARN() do { \ |
103 | printk(KERN_WARNING CUT_HERE); __WARN_TAINT(TAINT_WARN); \ | |
104 | } while (0) | |
89348fc3 | 105 | #define __WARN_printf(taint, arg...) \ |
a7bed27a | 106 | do { __warn_printk(arg); __WARN_TAINT(taint); } while (0) |
3a6a62f9 OJ |
107 | #endif |
108 | ||
2553b67a JP |
109 | /* used internally by panic.c */ |
110 | struct warn_args; | |
0b396923 | 111 | struct pt_regs; |
2553b67a JP |
112 | |
113 | void __warn(const char *file, int line, void *caller, unsigned taint, | |
114 | struct pt_regs *regs, struct warn_args *args); | |
115 | ||
3a6a62f9 | 116 | #ifndef WARN_ON |
684f9783 | 117 | #define WARN_ON(condition) ({ \ |
8d4fbcfb | 118 | int __ret_warn_on = !!(condition); \ |
3a6a62f9 OJ |
119 | if (unlikely(__ret_warn_on)) \ |
120 | __WARN(); \ | |
684f9783 HX |
121 | unlikely(__ret_warn_on); \ |
122 | }) | |
1da177e4 LT |
123 | #endif |
124 | ||
a8f18b90 | 125 | #ifndef WARN |
19d43626 | 126 | #define WARN(condition, format...) ({ \ |
a8f18b90 AV |
127 | int __ret_warn_on = !!(condition); \ |
128 | if (unlikely(__ret_warn_on)) \ | |
89348fc3 | 129 | __WARN_printf(TAINT_WARN, format); \ |
a8f18b90 AV |
130 | unlikely(__ret_warn_on); \ |
131 | }) | |
132 | #endif | |
133 | ||
b2be0527 BH |
134 | #define WARN_TAINT(condition, taint, format...) ({ \ |
135 | int __ret_warn_on = !!(condition); \ | |
136 | if (unlikely(__ret_warn_on)) \ | |
89348fc3 | 137 | __WARN_printf(taint, format); \ |
b2be0527 BH |
138 | unlikely(__ret_warn_on); \ |
139 | }) | |
140 | ||
19d43626 | 141 | #ifndef WARN_ON_ONCE |
d69a8922 | 142 | #define WARN_ON_ONCE(condition) ({ \ |
b1fca27d | 143 | static bool __section(.data.once) __warned; \ |
8d4fbcfb | 144 | int __ret_warn_once = !!(condition); \ |
d69a8922 | 145 | \ |
dfbf2897 SR |
146 | if (unlikely(__ret_warn_once && !__warned)) { \ |
147 | __warned = true; \ | |
148 | WARN_ON(1); \ | |
149 | } \ | |
d69a8922 | 150 | unlikely(__ret_warn_once); \ |
74bb6a09 | 151 | }) |
19d43626 | 152 | #endif |
74bb6a09 | 153 | |
45e9c0de | 154 | #define WARN_ONCE(condition, format...) ({ \ |
b1fca27d | 155 | static bool __section(.data.once) __warned; \ |
45e9c0de AV |
156 | int __ret_warn_once = !!(condition); \ |
157 | \ | |
dfbf2897 SR |
158 | if (unlikely(__ret_warn_once && !__warned)) { \ |
159 | __warned = true; \ | |
160 | WARN(1, format); \ | |
161 | } \ | |
45e9c0de AV |
162 | unlikely(__ret_warn_once); \ |
163 | }) | |
164 | ||
b2be0527 | 165 | #define WARN_TAINT_ONCE(condition, taint, format...) ({ \ |
b1fca27d | 166 | static bool __section(.data.once) __warned; \ |
b2be0527 BH |
167 | int __ret_warn_once = !!(condition); \ |
168 | \ | |
dfbf2897 SR |
169 | if (unlikely(__ret_warn_once && !__warned)) { \ |
170 | __warned = true; \ | |
171 | WARN_TAINT(1, taint, format); \ | |
172 | } \ | |
b2be0527 BH |
173 | unlikely(__ret_warn_once); \ |
174 | }) | |
175 | ||
b607e70e JT |
176 | #else /* !CONFIG_BUG */ |
177 | #ifndef HAVE_ARCH_BUG | |
a4b5d580 | 178 | #define BUG() do {} while (1) |
b607e70e JT |
179 | #endif |
180 | ||
181 | #ifndef HAVE_ARCH_BUG_ON | |
9b87647c | 182 | #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) |
b607e70e JT |
183 | #endif |
184 | ||
185 | #ifndef HAVE_ARCH_WARN_ON | |
186 | #define WARN_ON(condition) ({ \ | |
187 | int __ret_warn_on = !!(condition); \ | |
188 | unlikely(__ret_warn_on); \ | |
189 | }) | |
190 | #endif | |
191 | ||
192 | #ifndef WARN | |
193 | #define WARN(condition, format...) ({ \ | |
194 | int __ret_warn_on = !!(condition); \ | |
4e50ebde | 195 | no_printk(format); \ |
b607e70e JT |
196 | unlikely(__ret_warn_on); \ |
197 | }) | |
198 | #endif | |
199 | ||
200 | #define WARN_ON_ONCE(condition) WARN_ON(condition) | |
201 | #define WARN_ONCE(condition, format...) WARN(condition, format) | |
202 | #define WARN_TAINT(condition, taint, format...) WARN(condition, format) | |
203 | #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format) | |
204 | ||
205 | #endif | |
206 | ||
2092e6be SR |
207 | /* |
208 | * WARN_ON_SMP() is for cases that the warning is either | |
209 | * meaningless for !SMP or may even cause failures. | |
2092e6be SR |
210 | * It can also be used with values that are only defined |
211 | * on SMP: | |
212 | * | |
213 | * struct foo { | |
214 | * [...] | |
215 | * #ifdef CONFIG_SMP | |
216 | * int bar; | |
217 | * #endif | |
218 | * }; | |
219 | * | |
220 | * void func(struct foo *zoot) | |
221 | * { | |
222 | * WARN_ON_SMP(!zoot->bar); | |
223 | * | |
224 | * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(), | |
225 | * and should be a nop and return false for uniprocessor. | |
226 | * | |
227 | * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set | |
228 | * and x is true. | |
229 | */ | |
8eb94f80 IM |
230 | #ifdef CONFIG_SMP |
231 | # define WARN_ON_SMP(x) WARN_ON(x) | |
232 | #else | |
ccd0d44f SR |
233 | /* |
234 | * Use of ({0;}) because WARN_ON_SMP(x) may be used either as | |
235 | * a stand alone line statement or as a condition in an if () | |
236 | * statement. | |
237 | * A simple "0" would cause gcc to give a "statement has no effect" | |
238 | * warning. | |
239 | */ | |
2092e6be | 240 | # define WARN_ON_SMP(x) ({0;}) |
8eb94f80 IM |
241 | #endif |
242 | ||
2603efa3 PM |
243 | #endif /* __ASSEMBLY__ */ |
244 | ||
1da177e4 | 245 | #endif |