Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef _ASM_GENERIC_BUG_H |
| 2 | #define _ASM_GENERIC_BUG_H |
| 3 | |
| 4 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 5 | |
Paul Mundt | 09682c1 | 2012-06-25 17:15:31 +0900 | [diff] [blame] | 6 | #ifdef CONFIG_GENERIC_BUG |
| 7 | #define BUGFLAG_WARNING (1 << 0) |
Peter Zijlstra | 19d4362 | 2017-02-25 08:56:53 +0100 | [diff] [blame] | 8 | #define BUGFLAG_ONCE (1 << 1) |
| 9 | #define BUGFLAG_DONE (1 << 2) |
Peter Zijlstra | f26dee1 | 2017-04-10 10:49:39 +0200 | [diff] [blame] | 10 | #define BUGFLAG_TAINT(taint) ((taint) << 8) |
Paul Mundt | 09682c1 | 2012-06-25 17:15:31 +0900 | [diff] [blame] | 11 | #define BUG_GET_TAINT(bug) ((bug)->flags >> 8) |
| 12 | #endif |
| 13 | |
| 14 | #ifndef __ASSEMBLY__ |
| 15 | #include <linux/kernel.h> |
| 16 | |
Matt Mackall | c8538a7 | 2005-05-01 08:59:01 -0700 | [diff] [blame] | 17 | #ifdef CONFIG_BUG |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 18 | |
| 19 | #ifdef CONFIG_GENERIC_BUG |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 20 | struct bug_entry { |
Jan Beulich | b93a531 | 2008-12-16 11:40:27 +0000 | [diff] [blame] | 21 | #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 22 | unsigned long bug_addr; |
Jan Beulich | b93a531 | 2008-12-16 11:40:27 +0000 | [diff] [blame] | 23 | #else |
| 24 | signed int bug_addr_disp; |
| 25 | #endif |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 26 | #ifdef CONFIG_DEBUG_BUGVERBOSE |
Jan Beulich | b93a531 | 2008-12-16 11:40:27 +0000 | [diff] [blame] | 27 | #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 28 | const char *file; |
Jan Beulich | b93a531 | 2008-12-16 11:40:27 +0000 | [diff] [blame] | 29 | #else |
| 30 | signed int file_disp; |
| 31 | #endif |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 32 | unsigned short line; |
| 33 | #endif |
| 34 | unsigned short flags; |
| 35 | }; |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 36 | #endif /* CONFIG_GENERIC_BUG */ |
| 37 | |
David Brownell | af9379c7 | 2009-01-06 14:41:01 -0800 | [diff] [blame] | 38 | /* |
| 39 | * Don't use BUG() or BUG_ON() unless there's really no way out; one |
| 40 | * example might be detecting data structure corruption in the middle |
| 41 | * of an operation that can't be backed out of. If the (sub)system |
| 42 | * can somehow continue operating, perhaps with reduced functionality, |
| 43 | * it's probably not BUG-worthy. |
| 44 | * |
| 45 | * If you're tempted to BUG(), think again: is completely giving up |
| 46 | * really the *only* solution? There are usually better options, where |
| 47 | * users don't need to reboot ASAP and can mostly shut down cleanly. |
| 48 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | #ifndef HAVE_ARCH_BUG |
| 50 | #define BUG() do { \ |
Harvey Harrison | d5c003b | 2008-10-15 22:01:24 -0700 | [diff] [blame] | 51 | printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | panic("BUG!"); \ |
| 53 | } while (0) |
| 54 | #endif |
| 55 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | #ifndef HAVE_ARCH_BUG_ON |
Josh Triplett | a3f7607 | 2014-04-07 15:39:11 -0700 | [diff] [blame] | 57 | #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | #endif |
| 59 | |
Peter Zijlstra | 19d4362 | 2017-02-25 08:56:53 +0100 | [diff] [blame] | 60 | #ifdef __WARN_FLAGS |
| 61 | #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint)) |
| 62 | #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint)) |
| 63 | |
| 64 | #define WARN_ON_ONCE(condition) ({ \ |
| 65 | int __ret_warn_on = !!(condition); \ |
| 66 | if (unlikely(__ret_warn_on)) \ |
| 67 | __WARN_ONCE_TAINT(TAINT_WARN); \ |
| 68 | unlikely(__ret_warn_on); \ |
| 69 | }) |
| 70 | #endif |
| 71 | |
David Brownell | af9379c7 | 2009-01-06 14:41:01 -0800 | [diff] [blame] | 72 | /* |
| 73 | * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report |
| 74 | * significant issues that need prompt attention if they should ever |
| 75 | * appear at runtime. Use the versions with printk format strings |
| 76 | * to provide better diagnostics. |
| 77 | */ |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 78 | #ifndef __WARN_TAINT |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 79 | extern __printf(3, 4) |
| 80 | void warn_slowpath_fmt(const char *file, const int line, |
| 81 | const char *fmt, ...); |
| 82 | extern __printf(4, 5) |
| 83 | void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint, |
| 84 | const char *fmt, ...); |
Andi Kleen | 57adc4d | 2009-05-06 16:02:53 -0700 | [diff] [blame] | 85 | extern void warn_slowpath_null(const char *file, const int line); |
Arjan van de Ven | 79b4cc5 | 2008-01-30 13:32:50 +0100 | [diff] [blame] | 86 | #define WANT_WARN_ON_SLOWPATH |
Andi Kleen | 57adc4d | 2009-05-06 16:02:53 -0700 | [diff] [blame] | 87 | #define __WARN() warn_slowpath_null(__FILE__, __LINE__) |
| 88 | #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg) |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 89 | #define __WARN_printf_taint(taint, arg...) \ |
| 90 | warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg) |
Arjan van de Ven | a8f18b9 | 2008-07-25 01:45:53 -0700 | [diff] [blame] | 91 | #else |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 92 | #define __WARN() __WARN_TAINT(TAINT_WARN) |
Ingo Molnar | ec5679e | 2008-11-28 17:56:14 +0100 | [diff] [blame] | 93 | #define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0) |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 94 | #define __WARN_printf_taint(taint, arg...) \ |
| 95 | do { printk(arg); __WARN_TAINT(taint); } while (0) |
Olof Johansson | 3a6a62f9 | 2008-01-30 13:32:50 +0100 | [diff] [blame] | 96 | #endif |
| 97 | |
Josh Poimboeuf | 2553b67 | 2016-03-17 14:23:04 -0700 | [diff] [blame] | 98 | /* used internally by panic.c */ |
| 99 | struct warn_args; |
| 100 | |
| 101 | void __warn(const char *file, int line, void *caller, unsigned taint, |
| 102 | struct pt_regs *regs, struct warn_args *args); |
| 103 | |
Olof Johansson | 3a6a62f9 | 2008-01-30 13:32:50 +0100 | [diff] [blame] | 104 | #ifndef WARN_ON |
Herbert Xu | 684f978 | 2006-09-29 01:59:06 -0700 | [diff] [blame] | 105 | #define WARN_ON(condition) ({ \ |
Linus Torvalds | 8d4fbcf | 2007-07-31 21:12:07 -0700 | [diff] [blame] | 106 | int __ret_warn_on = !!(condition); \ |
Olof Johansson | 3a6a62f9 | 2008-01-30 13:32:50 +0100 | [diff] [blame] | 107 | if (unlikely(__ret_warn_on)) \ |
| 108 | __WARN(); \ |
Herbert Xu | 684f978 | 2006-09-29 01:59:06 -0700 | [diff] [blame] | 109 | unlikely(__ret_warn_on); \ |
| 110 | }) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 111 | #endif |
| 112 | |
Arjan van de Ven | a8f18b9 | 2008-07-25 01:45:53 -0700 | [diff] [blame] | 113 | #ifndef WARN |
Peter Zijlstra | 19d4362 | 2017-02-25 08:56:53 +0100 | [diff] [blame] | 114 | #define WARN(condition, format...) ({ \ |
Arjan van de Ven | a8f18b9 | 2008-07-25 01:45:53 -0700 | [diff] [blame] | 115 | int __ret_warn_on = !!(condition); \ |
| 116 | if (unlikely(__ret_warn_on)) \ |
| 117 | __WARN_printf(format); \ |
| 118 | unlikely(__ret_warn_on); \ |
| 119 | }) |
| 120 | #endif |
| 121 | |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 122 | #define WARN_TAINT(condition, taint, format...) ({ \ |
| 123 | int __ret_warn_on = !!(condition); \ |
| 124 | if (unlikely(__ret_warn_on)) \ |
| 125 | __WARN_printf_taint(taint, format); \ |
| 126 | unlikely(__ret_warn_on); \ |
| 127 | }) |
| 128 | |
Peter Zijlstra | 19d4362 | 2017-02-25 08:56:53 +0100 | [diff] [blame] | 129 | #ifndef WARN_ON_ONCE |
Andrew Morton | d69a892 | 2006-10-06 00:43:49 -0700 | [diff] [blame] | 130 | #define WARN_ON_ONCE(condition) ({ \ |
Jan Beulich | 7ccaba5 | 2012-03-23 15:01:52 -0700 | [diff] [blame] | 131 | static bool __section(.data.unlikely) __warned; \ |
Linus Torvalds | 8d4fbcf | 2007-07-31 21:12:07 -0700 | [diff] [blame] | 132 | int __ret_warn_once = !!(condition); \ |
Andrew Morton | d69a892 | 2006-10-06 00:43:49 -0700 | [diff] [blame] | 133 | \ |
Steven Rostedt | dfbf289 | 2016-03-17 14:21:12 -0700 | [diff] [blame] | 134 | if (unlikely(__ret_warn_once && !__warned)) { \ |
| 135 | __warned = true; \ |
| 136 | WARN_ON(1); \ |
| 137 | } \ |
Andrew Morton | d69a892 | 2006-10-06 00:43:49 -0700 | [diff] [blame] | 138 | unlikely(__ret_warn_once); \ |
Ingo Molnar | 74bb6a0 | 2006-06-25 05:48:09 -0700 | [diff] [blame] | 139 | }) |
Peter Zijlstra | 19d4362 | 2017-02-25 08:56:53 +0100 | [diff] [blame] | 140 | #endif |
Ingo Molnar | 74bb6a0 | 2006-06-25 05:48:09 -0700 | [diff] [blame] | 141 | |
Arjan van de Ven | 45e9c0d | 2008-09-15 16:43:18 -0700 | [diff] [blame] | 142 | #define WARN_ONCE(condition, format...) ({ \ |
Jan Beulich | 7ccaba5 | 2012-03-23 15:01:52 -0700 | [diff] [blame] | 143 | static bool __section(.data.unlikely) __warned; \ |
Arjan van de Ven | 45e9c0d | 2008-09-15 16:43:18 -0700 | [diff] [blame] | 144 | int __ret_warn_once = !!(condition); \ |
| 145 | \ |
Steven Rostedt | dfbf289 | 2016-03-17 14:21:12 -0700 | [diff] [blame] | 146 | if (unlikely(__ret_warn_once && !__warned)) { \ |
| 147 | __warned = true; \ |
| 148 | WARN(1, format); \ |
| 149 | } \ |
Arjan van de Ven | 45e9c0d | 2008-09-15 16:43:18 -0700 | [diff] [blame] | 150 | unlikely(__ret_warn_once); \ |
| 151 | }) |
| 152 | |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 153 | #define WARN_TAINT_ONCE(condition, taint, format...) ({ \ |
Jan Beulich | 7ccaba5 | 2012-03-23 15:01:52 -0700 | [diff] [blame] | 154 | static bool __section(.data.unlikely) __warned; \ |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 155 | int __ret_warn_once = !!(condition); \ |
| 156 | \ |
Steven Rostedt | dfbf289 | 2016-03-17 14:21:12 -0700 | [diff] [blame] | 157 | if (unlikely(__ret_warn_once && !__warned)) { \ |
| 158 | __warned = true; \ |
| 159 | WARN_TAINT(1, taint, format); \ |
| 160 | } \ |
Ben Hutchings | b2be052 | 2010-04-03 19:34:56 +0100 | [diff] [blame] | 161 | unlikely(__ret_warn_once); \ |
| 162 | }) |
| 163 | |
Josh Triplett | b607e70 | 2014-04-07 15:39:10 -0700 | [diff] [blame] | 164 | #else /* !CONFIG_BUG */ |
| 165 | #ifndef HAVE_ARCH_BUG |
Josh Triplett | a4b5d58 | 2014-04-07 15:39:13 -0700 | [diff] [blame] | 166 | #define BUG() do {} while (1) |
Josh Triplett | b607e70 | 2014-04-07 15:39:10 -0700 | [diff] [blame] | 167 | #endif |
| 168 | |
| 169 | #ifndef HAVE_ARCH_BUG_ON |
Arnd Bergmann | 3c04705 | 2015-11-21 00:27:26 +0100 | [diff] [blame] | 170 | #define BUG_ON(condition) do { if (condition) BUG(); } while (0) |
Josh Triplett | b607e70 | 2014-04-07 15:39:10 -0700 | [diff] [blame] | 171 | #endif |
| 172 | |
| 173 | #ifndef HAVE_ARCH_WARN_ON |
| 174 | #define WARN_ON(condition) ({ \ |
| 175 | int __ret_warn_on = !!(condition); \ |
| 176 | unlikely(__ret_warn_on); \ |
| 177 | }) |
| 178 | #endif |
| 179 | |
| 180 | #ifndef WARN |
| 181 | #define WARN(condition, format...) ({ \ |
| 182 | int __ret_warn_on = !!(condition); \ |
Josh Triplett | 4e50ebde | 2014-04-07 15:39:12 -0700 | [diff] [blame] | 183 | no_printk(format); \ |
Josh Triplett | b607e70 | 2014-04-07 15:39:10 -0700 | [diff] [blame] | 184 | unlikely(__ret_warn_on); \ |
| 185 | }) |
| 186 | #endif |
| 187 | |
| 188 | #define WARN_ON_ONCE(condition) WARN_ON(condition) |
| 189 | #define WARN_ONCE(condition, format...) WARN(condition, format) |
| 190 | #define WARN_TAINT(condition, taint, format...) WARN(condition, format) |
| 191 | #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format) |
| 192 | |
| 193 | #endif |
| 194 | |
Steven Rostedt | 2092e6b | 2011-03-17 15:21:06 -0400 | [diff] [blame] | 195 | /* |
| 196 | * WARN_ON_SMP() is for cases that the warning is either |
| 197 | * meaningless for !SMP or may even cause failures. |
| 198 | * This is usually used for cases that we have |
| 199 | * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked() |
| 200 | * returns 0 for uniprocessor settings. |
| 201 | * It can also be used with values that are only defined |
| 202 | * on SMP: |
| 203 | * |
| 204 | * struct foo { |
| 205 | * [...] |
| 206 | * #ifdef CONFIG_SMP |
| 207 | * int bar; |
| 208 | * #endif |
| 209 | * }; |
| 210 | * |
| 211 | * void func(struct foo *zoot) |
| 212 | * { |
| 213 | * WARN_ON_SMP(!zoot->bar); |
| 214 | * |
| 215 | * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(), |
| 216 | * and should be a nop and return false for uniprocessor. |
| 217 | * |
| 218 | * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set |
| 219 | * and x is true. |
| 220 | */ |
Ingo Molnar | 8eb94f8 | 2006-06-27 02:54:50 -0700 | [diff] [blame] | 221 | #ifdef CONFIG_SMP |
| 222 | # define WARN_ON_SMP(x) WARN_ON(x) |
| 223 | #else |
Steven Rostedt | ccd0d44 | 2011-03-25 16:21:06 -0400 | [diff] [blame] | 224 | /* |
| 225 | * Use of ({0;}) because WARN_ON_SMP(x) may be used either as |
| 226 | * a stand alone line statement or as a condition in an if () |
| 227 | * statement. |
| 228 | * A simple "0" would cause gcc to give a "statement has no effect" |
| 229 | * warning. |
| 230 | */ |
Steven Rostedt | 2092e6b | 2011-03-17 15:21:06 -0400 | [diff] [blame] | 231 | # define WARN_ON_SMP(x) ({0;}) |
Ingo Molnar | 8eb94f8 | 2006-06-27 02:54:50 -0700 | [diff] [blame] | 232 | #endif |
| 233 | |
Paul Mundt | 2603efa | 2012-06-18 13:54:17 +0900 | [diff] [blame] | 234 | #endif /* __ASSEMBLY__ */ |
| 235 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | #endif |