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