blob: d6f4aed479a12b0da4ed81c3c905183a08e55e39 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _ASM_GENERIC_BUG_H
2#define _ASM_GENERIC_BUG_H
3
4#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
Paul Mundt09682c12012-06-25 17:15:31 +09006#ifdef CONFIG_GENERIC_BUG
7#define BUGFLAG_WARNING (1 << 0)
Peter Zijlstra19d43622017-02-25 08:56:53 +01008#define BUGFLAG_ONCE (1 << 1)
9#define BUGFLAG_DONE (1 << 2)
Peter Zijlstraf26dee12017-04-10 10:49:39 +020010#define BUGFLAG_TAINT(taint) ((taint) << 8)
Paul Mundt09682c12012-06-25 17:15:31 +090011#define BUG_GET_TAINT(bug) ((bug)->flags >> 8)
12#endif
13
14#ifndef __ASSEMBLY__
15#include <linux/kernel.h>
16
Matt Mackallc8538a72005-05-01 08:59:01 -070017#ifdef CONFIG_BUG
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080018
19#ifdef CONFIG_GENERIC_BUG
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080020struct bug_entry {
Jan Beulichb93a5312008-12-16 11:40:27 +000021#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080022 unsigned long bug_addr;
Jan Beulichb93a5312008-12-16 11:40:27 +000023#else
24 signed int bug_addr_disp;
25#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080026#ifdef CONFIG_DEBUG_BUGVERBOSE
Jan Beulichb93a5312008-12-16 11:40:27 +000027#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080028 const char *file;
Jan Beulichb93a5312008-12-16 11:40:27 +000029#else
30 signed int file_disp;
31#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080032 unsigned short line;
33#endif
34 unsigned short flags;
35};
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080036#endif /* CONFIG_GENERIC_BUG */
37
David Brownellaf9379c72009-01-06 14:41:01 -080038/*
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 Torvalds1da177e2005-04-16 15:20:36 -070049#ifndef HAVE_ARCH_BUG
50#define BUG() do { \
Harvey Harrisond5c003b2008-10-15 22:01:24 -070051 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 panic("BUG!"); \
53} while (0)
54#endif
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#ifndef HAVE_ARCH_BUG_ON
Josh Tripletta3f76072014-04-07 15:39:11 -070057#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#endif
59
Peter Zijlstra19d43622017-02-25 08:56:53 +010060#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 Brownellaf9379c72009-01-06 14:41:01 -080072/*
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 Hutchingsb2be0522010-04-03 19:34:56 +010078#ifndef __WARN_TAINT
Joe Perchesb9075fa2011-10-31 17:11:33 -070079extern __printf(3, 4)
80void warn_slowpath_fmt(const char *file, const int line,
81 const char *fmt, ...);
82extern __printf(4, 5)
83void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
84 const char *fmt, ...);
Andi Kleen57adc4d2009-05-06 16:02:53 -070085extern void warn_slowpath_null(const char *file, const int line);
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010086#define WANT_WARN_ON_SLOWPATH
Andi Kleen57adc4d2009-05-06 16:02:53 -070087#define __WARN() warn_slowpath_null(__FILE__, __LINE__)
88#define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010089#define __WARN_printf_taint(taint, arg...) \
90 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
Arjan van de Vena8f18b92008-07-25 01:45:53 -070091#else
Ben Hutchingsb2be0522010-04-03 19:34:56 +010092#define __WARN() __WARN_TAINT(TAINT_WARN)
Ingo Molnarec5679e2008-11-28 17:56:14 +010093#define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010094#define __WARN_printf_taint(taint, arg...) \
95 do { printk(arg); __WARN_TAINT(taint); } while (0)
Olof Johansson3a6a62f92008-01-30 13:32:50 +010096#endif
97
Josh Poimboeuf2553b672016-03-17 14:23:04 -070098/* used internally by panic.c */
99struct warn_args;
100
101void __warn(const char *file, int line, void *caller, unsigned taint,
102 struct pt_regs *regs, struct warn_args *args);
103
Olof Johansson3a6a62f92008-01-30 13:32:50 +0100104#ifndef WARN_ON
Herbert Xu684f9782006-09-29 01:59:06 -0700105#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700106 int __ret_warn_on = !!(condition); \
Olof Johansson3a6a62f92008-01-30 13:32:50 +0100107 if (unlikely(__ret_warn_on)) \
108 __WARN(); \
Herbert Xu684f9782006-09-29 01:59:06 -0700109 unlikely(__ret_warn_on); \
110})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#endif
112
Arjan van de Vena8f18b92008-07-25 01:45:53 -0700113#ifndef WARN
Peter Zijlstra19d43622017-02-25 08:56:53 +0100114#define WARN(condition, format...) ({ \
Arjan van de Vena8f18b92008-07-25 01:45:53 -0700115 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 Hutchingsb2be0522010-04-03 19:34:56 +0100122#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 Zijlstra19d43622017-02-25 08:56:53 +0100129#ifndef WARN_ON_ONCE
Andrew Mortond69a8922006-10-06 00:43:49 -0700130#define WARN_ON_ONCE(condition) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700131 static bool __section(.data.unlikely) __warned; \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700132 int __ret_warn_once = !!(condition); \
Andrew Mortond69a8922006-10-06 00:43:49 -0700133 \
Steven Rostedtdfbf2892016-03-17 14:21:12 -0700134 if (unlikely(__ret_warn_once && !__warned)) { \
135 __warned = true; \
136 WARN_ON(1); \
137 } \
Andrew Mortond69a8922006-10-06 00:43:49 -0700138 unlikely(__ret_warn_once); \
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700139})
Peter Zijlstra19d43622017-02-25 08:56:53 +0100140#endif
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700141
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700142#define WARN_ONCE(condition, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700143 static bool __section(.data.unlikely) __warned; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700144 int __ret_warn_once = !!(condition); \
145 \
Steven Rostedtdfbf2892016-03-17 14:21:12 -0700146 if (unlikely(__ret_warn_once && !__warned)) { \
147 __warned = true; \
148 WARN(1, format); \
149 } \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700150 unlikely(__ret_warn_once); \
151})
152
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100153#define WARN_TAINT_ONCE(condition, taint, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700154 static bool __section(.data.unlikely) __warned; \
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100155 int __ret_warn_once = !!(condition); \
156 \
Steven Rostedtdfbf2892016-03-17 14:21:12 -0700157 if (unlikely(__ret_warn_once && !__warned)) { \
158 __warned = true; \
159 WARN_TAINT(1, taint, format); \
160 } \
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100161 unlikely(__ret_warn_once); \
162})
163
Josh Triplettb607e702014-04-07 15:39:10 -0700164#else /* !CONFIG_BUG */
165#ifndef HAVE_ARCH_BUG
Josh Tripletta4b5d582014-04-07 15:39:13 -0700166#define BUG() do {} while (1)
Josh Triplettb607e702014-04-07 15:39:10 -0700167#endif
168
169#ifndef HAVE_ARCH_BUG_ON
Arnd Bergmann3c047052015-11-21 00:27:26 +0100170#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
Josh Triplettb607e702014-04-07 15:39:10 -0700171#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 Triplett4e50ebde2014-04-07 15:39:12 -0700183 no_printk(format); \
Josh Triplettb607e702014-04-07 15:39:10 -0700184 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 Rostedt2092e6b2011-03-17 15:21:06 -0400195/*
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 Molnar8eb94f82006-06-27 02:54:50 -0700221#ifdef CONFIG_SMP
222# define WARN_ON_SMP(x) WARN_ON(x)
223#else
Steven Rostedtccd0d442011-03-25 16:21:06 -0400224/*
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 Rostedt2092e6b2011-03-17 15:21:06 -0400231# define WARN_ON_SMP(x) ({0;})
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700232#endif
233
Paul Mundt2603efa2012-06-18 13:54:17 +0900234#endif /* __ASSEMBLY__ */
235
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236#endif