blob: e727fe0d145107f48ae5699364f390e3d3298bd5 [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
28#define BUGFLAG_WARNING (1<<0)
29#endif /* CONFIG_GENERIC_BUG */
30
David Brownellaf9379c2009-01-06 14:41:01 -080031/*
32 * Don't use BUG() or BUG_ON() unless there's really no way out; one
33 * example might be detecting data structure corruption in the middle
34 * of an operation that can't be backed out of. If the (sub)system
35 * can somehow continue operating, perhaps with reduced functionality,
36 * it's probably not BUG-worthy.
37 *
38 * If you're tempted to BUG(), think again: is completely giving up
39 * really the *only* solution? There are usually better options, where
40 * users don't need to reboot ASAP and can mostly shut down cleanly.
41 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#ifndef HAVE_ARCH_BUG
43#define BUG() do { \
Harvey Harrisond5c003b2008-10-15 22:01:24 -070044 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 panic("BUG!"); \
46} while (0)
47#endif
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#ifndef HAVE_ARCH_BUG_ON
Alexey Dobriyan2a41de42007-07-17 04:03:56 -070050#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#endif
52
David Brownellaf9379c2009-01-06 14:41:01 -080053/*
54 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
55 * significant issues that need prompt attention if they should ever
56 * appear at runtime. Use the versions with printk format strings
57 * to provide better diagnostics.
58 */
Olof Johansson3a6a62f2008-01-30 13:32:50 +010059#ifndef __WARN
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010060#ifndef __ASSEMBLY__
Arjan van de Vena8f18b92008-07-25 01:45:53 -070061extern void warn_slowpath(const char *file, const int line,
62 const char *fmt, ...) __attribute__((format(printf, 3, 4)));
Arjan van de Ven79b4cc52008-01-30 13:32:50 +010063#define WANT_WARN_ON_SLOWPATH
64#endif
Ingo Molnarec5679e2008-11-28 17:56:14 +010065#define __WARN() warn_slowpath(__FILE__, __LINE__, NULL)
66#define __WARN_printf(arg...) warn_slowpath(__FILE__, __LINE__, arg)
Arjan van de Vena8f18b92008-07-25 01:45:53 -070067#else
Ingo Molnarec5679e2008-11-28 17:56:14 +010068#define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0)
Olof Johansson3a6a62f2008-01-30 13:32:50 +010069#endif
70
71#ifndef WARN_ON
Herbert Xu684f9782006-09-29 01:59:06 -070072#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -070073 int __ret_warn_on = !!(condition); \
Olof Johansson3a6a62f2008-01-30 13:32:50 +010074 if (unlikely(__ret_warn_on)) \
75 __WARN(); \
Herbert Xu684f9782006-09-29 01:59:06 -070076 unlikely(__ret_warn_on); \
77})
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#endif
79
Arjan van de Vena8f18b92008-07-25 01:45:53 -070080#ifndef WARN
81#define WARN(condition, format...) ({ \
82 int __ret_warn_on = !!(condition); \
83 if (unlikely(__ret_warn_on)) \
84 __WARN_printf(format); \
85 unlikely(__ret_warn_on); \
86})
87#endif
88
Matt Mackallc8538a72005-05-01 08:59:01 -070089#else /* !CONFIG_BUG */
90#ifndef HAVE_ARCH_BUG
David Howellsda606822009-04-15 19:34:56 +010091#define BUG() do {} while(0)
Matt Mackallc8538a72005-05-01 08:59:01 -070092#endif
93
Matt Mackallc8538a72005-05-01 08:59:01 -070094#ifndef HAVE_ARCH_BUG_ON
95#define BUG_ON(condition) do { if (condition) ; } while(0)
96#endif
97
98#ifndef HAVE_ARCH_WARN_ON
Ralf Baechle8c7c7c92006-10-19 23:28:34 -070099#define WARN_ON(condition) ({ \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700100 int __ret_warn_on = !!(condition); \
Ralf Baechle8c7c7c92006-10-19 23:28:34 -0700101 unlikely(__ret_warn_on); \
102})
Matt Mackallc8538a72005-05-01 08:59:01 -0700103#endif
Arjan van de Vena8f18b92008-07-25 01:45:53 -0700104
105#ifndef WARN
106#define WARN(condition, format...) ({ \
107 int __ret_warn_on = !!(condition); \
108 unlikely(__ret_warn_on); \
109})
110#endif
111
Matt Mackallc8538a72005-05-01 08:59:01 -0700112#endif
113
Andrew Mortond69a8922006-10-06 00:43:49 -0700114#define WARN_ON_ONCE(condition) ({ \
115 static int __warned; \
Linus Torvalds8d4fbcf2007-07-31 21:12:07 -0700116 int __ret_warn_once = !!(condition); \
Andrew Mortond69a8922006-10-06 00:43:49 -0700117 \
118 if (unlikely(__ret_warn_once)) \
119 if (WARN_ON(!__warned)) \
120 __warned = 1; \
121 unlikely(__ret_warn_once); \
Ingo Molnar74bb6a02006-06-25 05:48:09 -0700122})
123
Arjan van de Ven45e9c0d2008-09-15 16:43:18 -0700124#define WARN_ONCE(condition, format...) ({ \
125 static int __warned; \
126 int __ret_warn_once = !!(condition); \
127 \
128 if (unlikely(__ret_warn_once)) \
129 if (WARN(!__warned, format)) \
130 __warned = 1; \
131 unlikely(__ret_warn_once); \
132})
133
Dave Young717115e2008-07-25 01:45:58 -0700134#define WARN_ON_RATELIMIT(condition, state) \
135 WARN_ON((condition) && __ratelimit(state))
136
Ingo Molnar8eb94f82006-06-27 02:54:50 -0700137#ifdef CONFIG_SMP
138# define WARN_ON_SMP(x) WARN_ON(x)
139#else
140# define WARN_ON_SMP(x) do { } while (0)
141#endif
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#endif