blob: 506ec19a3736b575c2d41519cc7c52ec64714bb0 [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
Matt Mackallc8538a72005-05-01 08:59:01 -07006#ifdef CONFIG_BUG
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -08007
8#ifdef CONFIG_GENERIC_BUG
9#ifndef __ASSEMBLY__
10struct bug_entry {
Jan Beulichb93a5312008-12-16 11:40:27 +000011#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080012 unsigned long bug_addr;
Jan Beulichb93a5312008-12-16 11:40:27 +000013#else
14 signed int bug_addr_disp;
15#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080016#ifdef CONFIG_DEBUG_BUGVERBOSE
Jan Beulichb93a5312008-12-16 11:40:27 +000017#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080018 const char *file;
Jan Beulichb93a5312008-12-16 11:40:27 +000019#else
20 signed int file_disp;
21#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080022 unsigned short line;
23#endif
24 unsigned short flags;
25};
26#endif /* __ASSEMBLY__ */
27
Ben Hutchingsb2be0522010-04-03 19:34:56 +010028#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 Fitzhardinge7664c5a2006-12-08 02:36:19 -080032#endif /* CONFIG_GENERIC_BUG */
33
Paul Mundt2603efa2012-06-18 13:54:17 +090034#ifndef __ASSEMBLY__
35#include <linux/kernel.h>
36
David Brownellaf9379c2009-01-06 14:41:01 -080037/*
38 * Don't use BUG() or BUG_ON() unless there's really no way out; one
39 * example might be detecting data structure corruption in the middle
40 * of an operation that can't be backed out of. If the (sub)system
41 * can somehow continue operating, perhaps with reduced functionality,
42 * it's probably not BUG-worthy.
43 *
44 * If you're tempted to BUG(), think again: is completely giving up
45 * really the *only* solution? There are usually better options, where
46 * users don't need to reboot ASAP and can mostly shut down cleanly.
47 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#ifndef HAVE_ARCH_BUG
49#define BUG() do { \
Harvey Harrisond5c003b2008-10-15 22:01:24 -070050 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 panic("BUG!"); \
52} while (0)
53#endif
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#ifndef HAVE_ARCH_BUG_ON
Alexey Dobriyan2a41de42007-07-17 04:03:56 -070056#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#endif
58
David Brownellaf9379c2009-01-06 14:41:01 -080059/*
60 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
61 * significant issues that need prompt attention if they should ever
62 * appear at runtime. Use the versions with printk format strings
63 * to provide better diagnostics.
64 */
Ben Hutchingsb2be0522010-04-03 19:34:56 +010065#ifndef __WARN_TAINT
Joe Perchesb9075fa2011-10-31 17:11:33 -070066extern __printf(3, 4)
67void warn_slowpath_fmt(const char *file, const int line,
68 const char *fmt, ...);
69extern __printf(4, 5)
70void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
71 const char *fmt, ...);
Andi Kleen57adc4d2009-05-06 16:02:53 -070072extern void warn_slowpath_null(const char *file, const int line);
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010073#define WANT_WARN_ON_SLOWPATH
Andi Kleen57adc4d2009-05-06 16:02:53 -070074#define __WARN() warn_slowpath_null(__FILE__, __LINE__)
75#define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010076#define __WARN_printf_taint(taint, arg...) \
77 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
Arjan van de Vena8f18b92008-07-25 01:45:53 -070078#else
Ben Hutchingsb2be0522010-04-03 19:34:56 +010079#define __WARN() __WARN_TAINT(TAINT_WARN)
Ingo Molnarec5679e2008-11-28 17:56:14 +010080#define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010081#define __WARN_printf_taint(taint, arg...) \
82 do { printk(arg); __WARN_TAINT(taint); } while (0)
Olof Johansson3a6a62f92008-01-30 13:32:50 +010083#endif
84
85#ifndef WARN_ON
Herbert Xu684f9782006-09-29 01:59:06 -070086#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -070087 int __ret_warn_on = !!(condition); \
Olof Johansson3a6a62f92008-01-30 13:32:50 +010088 if (unlikely(__ret_warn_on)) \
89 __WARN(); \
Herbert Xu684f9782006-09-29 01:59:06 -070090 unlikely(__ret_warn_on); \
91})
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#endif
93
Arjan van de Vena8f18b92008-07-25 01:45:53 -070094#ifndef WARN
95#define WARN(condition, format...) ({ \
96 int __ret_warn_on = !!(condition); \
97 if (unlikely(__ret_warn_on)) \
98 __WARN_printf(format); \
99 unlikely(__ret_warn_on); \
100})
101#endif
102
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100103#define WARN_TAINT(condition, taint, format...) ({ \
104 int __ret_warn_on = !!(condition); \
105 if (unlikely(__ret_warn_on)) \
106 __WARN_printf_taint(taint, format); \
107 unlikely(__ret_warn_on); \
108})
109
Matt Mackallc8538a72005-05-01 08:59:01 -0700110#else /* !CONFIG_BUG */
111#ifndef HAVE_ARCH_BUG
David Howellsda606822009-04-15 19:34:56 +0100112#define BUG() do {} while(0)
Matt Mackallc8538a72005-05-01 08:59:01 -0700113#endif
114
Matt Mackallc8538a72005-05-01 08:59:01 -0700115#ifndef HAVE_ARCH_BUG_ON
116#define BUG_ON(condition) do { if (condition) ; } while(0)
117#endif
118
119#ifndef HAVE_ARCH_WARN_ON
Ralf Baechle8c7c7c92006-10-19 23:28:34 -0700120#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700121 int __ret_warn_on = !!(condition); \
Ralf Baechle8c7c7c92006-10-19 23:28:34 -0700122 unlikely(__ret_warn_on); \
123})
Matt Mackallc8538a72005-05-01 08:59:01 -0700124#endif
Arjan van de Vena8f18b92008-07-25 01:45:53 -0700125
126#ifndef WARN
127#define WARN(condition, format...) ({ \
128 int __ret_warn_on = !!(condition); \
129 unlikely(__ret_warn_on); \
130})
131#endif
132
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100133#define WARN_TAINT(condition, taint, format...) WARN_ON(condition)
134
Matt Mackallc8538a72005-05-01 08:59:01 -0700135#endif
136
Andrew Mortond69a8922006-10-06 00:43:49 -0700137#define WARN_ON_ONCE(condition) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700138 static bool __section(.data.unlikely) __warned; \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700139 int __ret_warn_once = !!(condition); \
Andrew Mortond69a8922006-10-06 00:43:49 -0700140 \
141 if (unlikely(__ret_warn_once)) \
142 if (WARN_ON(!__warned)) \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800143 __warned = true; \
Andrew Mortond69a8922006-10-06 00:43:49 -0700144 unlikely(__ret_warn_once); \
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700145})
146
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700147#define WARN_ONCE(condition, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700148 static bool __section(.data.unlikely) __warned; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700149 int __ret_warn_once = !!(condition); \
150 \
151 if (unlikely(__ret_warn_once)) \
152 if (WARN(!__warned, format)) \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800153 __warned = true; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700154 unlikely(__ret_warn_once); \
155})
156
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100157#define WARN_TAINT_ONCE(condition, taint, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700158 static bool __section(.data.unlikely) __warned; \
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100159 int __ret_warn_once = !!(condition); \
160 \
161 if (unlikely(__ret_warn_once)) \
162 if (WARN_TAINT(!__warned, taint, format)) \
163 __warned = true; \
164 unlikely(__ret_warn_once); \
165})
166
Steven Rostedt2092e6b2011-03-17 15:21:06 -0400167/*
168 * WARN_ON_SMP() is for cases that the warning is either
169 * meaningless for !SMP or may even cause failures.
170 * This is usually used for cases that we have
171 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
172 * returns 0 for uniprocessor settings.
173 * It can also be used with values that are only defined
174 * on SMP:
175 *
176 * struct foo {
177 * [...]
178 * #ifdef CONFIG_SMP
179 * int bar;
180 * #endif
181 * };
182 *
183 * void func(struct foo *zoot)
184 * {
185 * WARN_ON_SMP(!zoot->bar);
186 *
187 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
188 * and should be a nop and return false for uniprocessor.
189 *
190 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
191 * and x is true.
192 */
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700193#ifdef CONFIG_SMP
194# define WARN_ON_SMP(x) WARN_ON(x)
195#else
Steven Rostedtccd0d442011-03-25 16:21:06 -0400196/*
197 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
198 * a stand alone line statement or as a condition in an if ()
199 * statement.
200 * A simple "0" would cause gcc to give a "statement has no effect"
201 * warning.
202 */
Steven Rostedt2092e6b2011-03-17 15:21:06 -0400203# define WARN_ON_SMP(x) ({0;})
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700204#endif
205
Paul Mundt2603efa2012-06-18 13:54:17 +0900206#endif /* __ASSEMBLY__ */
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208#endif