blob: 6f96247226a4d2b9c1e9aa56be423ffa0c4d49df [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)
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 Mackallc8538a72005-05-01 08:59:01 -070015#ifdef CONFIG_BUG
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080016
17#ifdef CONFIG_GENERIC_BUG
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080018struct bug_entry {
Jan Beulichb93a5312008-12-16 11:40:27 +000019#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080020 unsigned long bug_addr;
Jan Beulichb93a5312008-12-16 11:40:27 +000021#else
22 signed int bug_addr_disp;
23#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080024#ifdef CONFIG_DEBUG_BUGVERBOSE
Jan Beulichb93a5312008-12-16 11:40:27 +000025#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080026 const char *file;
Jan Beulichb93a5312008-12-16 11:40:27 +000027#else
28 signed int file_disp;
29#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080030 unsigned short line;
31#endif
32 unsigned short flags;
33};
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080034#endif /* CONFIG_GENERIC_BUG */
35
David Brownellaf9379c72009-01-06 14:41:01 -080036/*
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 Torvalds1da177e2005-04-16 15:20:36 -070047#ifndef HAVE_ARCH_BUG
48#define BUG() do { \
Harvey Harrisond5c003b2008-10-15 22:01:24 -070049 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 panic("BUG!"); \
51} while (0)
52#endif
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#ifndef HAVE_ARCH_BUG_ON
Josh Tripletta3f76072014-04-07 15:39:11 -070055#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#endif
57
David Brownellaf9379c72009-01-06 14:41:01 -080058/*
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 Hutchingsb2be0522010-04-03 19:34:56 +010064#ifndef __WARN_TAINT
Joe Perchesb9075fa2011-10-31 17:11:33 -070065extern __printf(3, 4)
66void warn_slowpath_fmt(const char *file, const int line,
67 const char *fmt, ...);
68extern __printf(4, 5)
69void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
70 const char *fmt, ...);
Andi Kleen57adc4d2009-05-06 16:02:53 -070071extern void warn_slowpath_null(const char *file, const int line);
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010072#define WANT_WARN_ON_SLOWPATH
Andi Kleen57adc4d2009-05-06 16:02:53 -070073#define __WARN() warn_slowpath_null(__FILE__, __LINE__)
74#define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010075#define __WARN_printf_taint(taint, arg...) \
76 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
Arjan van de Vena8f18b92008-07-25 01:45:53 -070077#else
Ben Hutchingsb2be0522010-04-03 19:34:56 +010078#define __WARN() __WARN_TAINT(TAINT_WARN)
Ingo Molnarec5679e2008-11-28 17:56:14 +010079#define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010080#define __WARN_printf_taint(taint, arg...) \
81 do { printk(arg); __WARN_TAINT(taint); } while (0)
Olof Johansson3a6a62f92008-01-30 13:32:50 +010082#endif
83
Josh Poimboeuf2553b672016-03-17 14:23:04 -070084/* used internally by panic.c */
85struct warn_args;
86
87void __warn(const char *file, int line, void *caller, unsigned taint,
88 struct pt_regs *regs, struct warn_args *args);
89
Olof Johansson3a6a62f92008-01-30 13:32:50 +010090#ifndef WARN_ON
Herbert Xu684f9782006-09-29 01:59:06 -070091#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -070092 int __ret_warn_on = !!(condition); \
Olof Johansson3a6a62f92008-01-30 13:32:50 +010093 if (unlikely(__ret_warn_on)) \
94 __WARN(); \
Herbert Xu684f9782006-09-29 01:59:06 -070095 unlikely(__ret_warn_on); \
96})
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#endif
98
Arjan van de Vena8f18b92008-07-25 01:45:53 -070099#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 Hutchingsb2be0522010-04-03 19:34:56 +0100108#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 Mortond69a8922006-10-06 00:43:49 -0700115#define WARN_ON_ONCE(condition) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700116 static bool __section(.data.unlikely) __warned; \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700117 int __ret_warn_once = !!(condition); \
Andrew Mortond69a8922006-10-06 00:43:49 -0700118 \
Steven Rostedtdfbf2892016-03-17 14:21:12 -0700119 if (unlikely(__ret_warn_once && !__warned)) { \
120 __warned = true; \
121 WARN_ON(1); \
122 } \
Andrew Mortond69a8922006-10-06 00:43:49 -0700123 unlikely(__ret_warn_once); \
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700124})
125
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700126#define WARN_ONCE(condition, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700127 static bool __section(.data.unlikely) __warned; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700128 int __ret_warn_once = !!(condition); \
129 \
Steven Rostedtdfbf2892016-03-17 14:21:12 -0700130 if (unlikely(__ret_warn_once && !__warned)) { \
131 __warned = true; \
132 WARN(1, format); \
133 } \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700134 unlikely(__ret_warn_once); \
135})
136
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100137#define WARN_TAINT_ONCE(condition, taint, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700138 static bool __section(.data.unlikely) __warned; \
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100139 int __ret_warn_once = !!(condition); \
140 \
Steven Rostedtdfbf2892016-03-17 14:21:12 -0700141 if (unlikely(__ret_warn_once && !__warned)) { \
142 __warned = true; \
143 WARN_TAINT(1, taint, format); \
144 } \
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100145 unlikely(__ret_warn_once); \
146})
147
Josh Triplettb607e702014-04-07 15:39:10 -0700148#else /* !CONFIG_BUG */
149#ifndef HAVE_ARCH_BUG
Josh Tripletta4b5d582014-04-07 15:39:13 -0700150#define BUG() do {} while (1)
Josh Triplettb607e702014-04-07 15:39:10 -0700151#endif
152
153#ifndef HAVE_ARCH_BUG_ON
Arnd Bergmann3c047052015-11-21 00:27:26 +0100154#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
Josh Triplettb607e702014-04-07 15:39:10 -0700155#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 Triplett4e50ebde2014-04-07 15:39:12 -0700167 no_printk(format); \
Josh Triplettb607e702014-04-07 15:39:10 -0700168 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 Rostedt2092e6b2011-03-17 15:21:06 -0400179/*
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 Molnar8eb94f82006-06-27 02:54:50 -0700205#ifdef CONFIG_SMP
206# define WARN_ON_SMP(x) WARN_ON(x)
207#else
Steven Rostedtccd0d442011-03-25 16:21:06 -0400208/*
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 Rostedt2092e6b2011-03-17 15:21:06 -0400215# define WARN_ON_SMP(x) ({0;})
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700216#endif
217
Paul Mundt2603efa2012-06-18 13:54:17 +0900218#endif /* __ASSEMBLY__ */
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220#endif