blob: c2c9ba032d4688c80cf7b3e1546da8a558068ec5 [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__
Andi Kleen57adc4d2009-05-06 16:02:53 -070064extern void warn_slowpath_fmt(const char *file, const int line,
Arjan van de Vena8f18b92008-07-25 01:45:53 -070065 const char *fmt, ...) __attribute__((format(printf, 3, 4)));
Ben Hutchingsb2be0522010-04-03 19:34:56 +010066extern void warn_slowpath_fmt_taint(const char *file, const int line,
67 unsigned taint, const char *fmt, ...)
68 __attribute__((format(printf, 4, 5)));
Andi Kleen57adc4d2009-05-06 16:02:53 -070069extern void warn_slowpath_null(const char *file, const int line);
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010070#define WANT_WARN_ON_SLOWPATH
71#endif
Andi Kleen57adc4d2009-05-06 16:02:53 -070072#define __WARN() warn_slowpath_null(__FILE__, __LINE__)
73#define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010074#define __WARN_printf_taint(taint, arg...) \
75 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
Arjan van de Vena8f18b92008-07-25 01:45:53 -070076#else
Ben Hutchingsb2be0522010-04-03 19:34:56 +010077#define __WARN() __WARN_TAINT(TAINT_WARN)
Ingo Molnarec5679e2008-11-28 17:56:14 +010078#define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0)
Ben Hutchingsb2be0522010-04-03 19:34:56 +010079#define __WARN_printf_taint(taint, arg...) \
80 do { printk(arg); __WARN_TAINT(taint); } while (0)
Olof Johansson3a6a62f2008-01-30 13:32:50 +010081#endif
82
83#ifndef WARN_ON
Herbert Xu684f9782006-09-29 01:59:06 -070084#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -070085 int __ret_warn_on = !!(condition); \
Olof Johansson3a6a62f2008-01-30 13:32:50 +010086 if (unlikely(__ret_warn_on)) \
87 __WARN(); \
Herbert Xu684f9782006-09-29 01:59:06 -070088 unlikely(__ret_warn_on); \
89})
Linus Torvalds1da177e2005-04-16 15:20:36 -070090#endif
91
Arjan van de Vena8f18b92008-07-25 01:45:53 -070092#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 Hutchingsb2be0522010-04-03 19:34:56 +0100101#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 Mackallc8538a72005-05-01 08:59:01 -0700108#else /* !CONFIG_BUG */
109#ifndef HAVE_ARCH_BUG
David Howellsda606822009-04-15 19:34:56 +0100110#define BUG() do {} while(0)
Matt Mackallc8538a72005-05-01 08:59:01 -0700111#endif
112
Matt Mackallc8538a72005-05-01 08:59:01 -0700113#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 Baechle8c7c7c92006-10-19 23:28:34 -0700118#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700119 int __ret_warn_on = !!(condition); \
Ralf Baechle8c7c7c92006-10-19 23:28:34 -0700120 unlikely(__ret_warn_on); \
121})
Matt Mackallc8538a72005-05-01 08:59:01 -0700122#endif
Arjan van de Vena8f18b92008-07-25 01:45:53 -0700123
124#ifndef WARN
125#define WARN(condition, format...) ({ \
126 int __ret_warn_on = !!(condition); \
127 unlikely(__ret_warn_on); \
128})
129#endif
130
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100131#define WARN_TAINT(condition, taint, format...) WARN_ON(condition)
132
Matt Mackallc8538a72005-05-01 08:59:01 -0700133#endif
134
Andrew Mortond69a8922006-10-06 00:43:49 -0700135#define WARN_ON_ONCE(condition) ({ \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800136 static bool __warned; \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700137 int __ret_warn_once = !!(condition); \
Andrew Mortond69a8922006-10-06 00:43:49 -0700138 \
139 if (unlikely(__ret_warn_once)) \
140 if (WARN_ON(!__warned)) \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800141 __warned = true; \
Andrew Mortond69a8922006-10-06 00:43:49 -0700142 unlikely(__ret_warn_once); \
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700143})
144
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700145#define WARN_ONCE(condition, format...) ({ \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800146 static bool __warned; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700147 int __ret_warn_once = !!(condition); \
148 \
149 if (unlikely(__ret_warn_once)) \
150 if (WARN(!__warned, format)) \
Cesar Eduardo Barros42f247c2009-12-14 18:00:13 -0800151 __warned = true; \
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700152 unlikely(__ret_warn_once); \
153})
154
Ben Hutchingsb2be0522010-04-03 19:34:56 +0100155#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
Dave Young717115e2008-07-25 01:45:58 -0700165#define WARN_ON_RATELIMIT(condition, state) \
166 WARN_ON((condition) && __ratelimit(state))
167
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700168#ifdef CONFIG_SMP
169# define WARN_ON_SMP(x) WARN_ON(x)
170#else
171# define WARN_ON_SMP(x) do { } while (0)
172#endif
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174#endif