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