blob: 2520a6e241dc0967ef7f8e096436a19a6042e36a [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
David Brownellaf9379c2009-01-06 14:41:01 -080034/*
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 Torvalds1da177e2005-04-16 15:20:36 -070045#ifndef HAVE_ARCH_BUG
46#define BUG() do { \
Harvey Harrisond5c003b2008-10-15 22:01:24 -070047 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 panic("BUG!"); \
49} while (0)
50#endif
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#ifndef HAVE_ARCH_BUG_ON
Alexey Dobriyan2a41de42007-07-17 04:03:56 -070053#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#endif
55
David Brownellaf9379c2009-01-06 14:41:01 -080056/*
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 Hutchingsb2be0522010-04-03 19:34:56 +010062#ifndef __WARN_TAINT
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010063#ifndef __ASSEMBLY__
Joe Perchesb9075fa2011-10-31 17:11:33 -070064extern __printf(3, 4)
65void warn_slowpath_fmt(const char *file, const int line,
66 const char *fmt, ...);
67extern __printf(4, 5)
68void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
69 const char *fmt, ...);
Andi Kleen57adc4d2009-05-06 16:02:53 -070070extern void warn_slowpath_null(const char *file, const int line);
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010071#define WANT_WARN_ON_SLOWPATH
72#endif
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 Johansson3a6a62f2008-01-30 13:32:50 +010082#endif
83
84#ifndef WARN_ON
Herbert Xu684f9782006-09-29 01:59:06 -070085#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -070086 int __ret_warn_on = !!(condition); \
Olof Johansson3a6a62f2008-01-30 13:32:50 +010087 if (unlikely(__ret_warn_on)) \
88 __WARN(); \
Herbert Xu684f9782006-09-29 01:59:06 -070089 unlikely(__ret_warn_on); \
90})
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#endif
92
Arjan van de Vena8f18b92008-07-25 01:45:53 -070093#ifndef WARN
94#define WARN(condition, format...) ({ \
95 int __ret_warn_on = !!(condition); \
96 if (unlikely(__ret_warn_on)) \
97 __WARN_printf(format); \
98 unlikely(__ret_warn_on); \
99})
100#endif
101
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100102#define WARN_TAINT(condition, taint, format...) ({ \
103 int __ret_warn_on = !!(condition); \
104 if (unlikely(__ret_warn_on)) \
105 __WARN_printf_taint(taint, format); \
106 unlikely(__ret_warn_on); \
107})
108
Matt Mackallc8538a72005-05-01 08:59:01 -0700109#else /* !CONFIG_BUG */
110#ifndef HAVE_ARCH_BUG
David Howellsda606822009-04-15 19:34:56 +0100111#define BUG() do {} while(0)
Matt Mackallc8538a72005-05-01 08:59:01 -0700112#endif
113
Matt Mackallc8538a72005-05-01 08:59:01 -0700114#ifndef HAVE_ARCH_BUG_ON
115#define BUG_ON(condition) do { if (condition) ; } while(0)
116#endif
117
118#ifndef HAVE_ARCH_WARN_ON
Ralf Baechle8c7c7c92006-10-19 23:28:34 -0700119#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700120 int __ret_warn_on = !!(condition); \
Ralf Baechle8c7c7c92006-10-19 23:28:34 -0700121 unlikely(__ret_warn_on); \
122})
Matt Mackallc8538a72005-05-01 08:59:01 -0700123#endif
Arjan van de Vena8f18b92008-07-25 01:45:53 -0700124
125#ifndef WARN
126#define WARN(condition, format...) ({ \
127 int __ret_warn_on = !!(condition); \
128 unlikely(__ret_warn_on); \
129})
130#endif
131
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100132#define WARN_TAINT(condition, taint, format...) WARN_ON(condition)
133
Matt Mackallc8538a72005-05-01 08:59:01 -0700134#endif
135
Andrew Mortond69a8922006-10-06 00:43:49 -0700136#define WARN_ON_ONCE(condition) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700137 static bool __section(.data.unlikely) __warned; \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700138 int __ret_warn_once = !!(condition); \
Andrew Mortond69a8922006-10-06 00:43:49 -0700139 \
140 if (unlikely(__ret_warn_once)) \
141 if (WARN_ON(!__warned)) \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800142 __warned = true; \
Andrew Mortond69a8922006-10-06 00:43:49 -0700143 unlikely(__ret_warn_once); \
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700144})
145
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700146#define WARN_ONCE(condition, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700147 static bool __section(.data.unlikely) __warned; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700148 int __ret_warn_once = !!(condition); \
149 \
150 if (unlikely(__ret_warn_once)) \
151 if (WARN(!__warned, format)) \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800152 __warned = true; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700153 unlikely(__ret_warn_once); \
154})
155
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100156#define WARN_TAINT_ONCE(condition, taint, format...) ({ \
Jan Beulich7ccaba52012-03-23 15:01:52 -0700157 static bool __section(.data.unlikely) __warned; \
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100158 int __ret_warn_once = !!(condition); \
159 \
160 if (unlikely(__ret_warn_once)) \
161 if (WARN_TAINT(!__warned, taint, format)) \
162 __warned = true; \
163 unlikely(__ret_warn_once); \
164})
165
Steven Rostedt2092e6b2011-03-17 15:21:06 -0400166/*
167 * WARN_ON_SMP() is for cases that the warning is either
168 * meaningless for !SMP or may even cause failures.
169 * This is usually used for cases that we have
170 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
171 * returns 0 for uniprocessor settings.
172 * It can also be used with values that are only defined
173 * on SMP:
174 *
175 * struct foo {
176 * [...]
177 * #ifdef CONFIG_SMP
178 * int bar;
179 * #endif
180 * };
181 *
182 * void func(struct foo *zoot)
183 * {
184 * WARN_ON_SMP(!zoot->bar);
185 *
186 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
187 * and should be a nop and return false for uniprocessor.
188 *
189 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
190 * and x is true.
191 */
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700192#ifdef CONFIG_SMP
193# define WARN_ON_SMP(x) WARN_ON(x)
194#else
Steven Rostedtccd0d442011-03-25 16:21:06 -0400195/*
196 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
197 * a stand alone line statement or as a condition in an if ()
198 * statement.
199 * A simple "0" would cause gcc to give a "statement has no effect"
200 * warning.
201 */
Steven Rostedt2092e6b2011-03-17 15:21:06 -0400202# define WARN_ON_SMP(x) ({0;})
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700203#endif
204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205#endif