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