Blame view

include/asm-generic/bug.h 5.4 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
  #ifndef _ASM_GENERIC_BUG_H
  #define _ASM_GENERIC_BUG_H
  
  #include <linux/compiler.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
5

c8538a7aa   Matt Mackall   [PATCH] remove al...
6
  #ifdef CONFIG_BUG
7664c5a1d   Jeremy Fitzhardinge   [PATCH] Generic B...
7
8
9
10
  
  #ifdef CONFIG_GENERIC_BUG
  #ifndef __ASSEMBLY__
  struct bug_entry {
b93a531e3   Jan Beulich   allow bug table e...
11
  #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
7664c5a1d   Jeremy Fitzhardinge   [PATCH] Generic B...
12
  	unsigned long	bug_addr;
b93a531e3   Jan Beulich   allow bug table e...
13
14
15
  #else
  	signed int	bug_addr_disp;
  #endif
7664c5a1d   Jeremy Fitzhardinge   [PATCH] Generic B...
16
  #ifdef CONFIG_DEBUG_BUGVERBOSE
b93a531e3   Jan Beulich   allow bug table e...
17
  #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
7664c5a1d   Jeremy Fitzhardinge   [PATCH] Generic B...
18
  	const char	*file;
b93a531e3   Jan Beulich   allow bug table e...
19
20
21
  #else
  	signed int	file_disp;
  #endif
7664c5a1d   Jeremy Fitzhardinge   [PATCH] Generic B...
22
23
24
25
26
  	unsigned short	line;
  #endif
  	unsigned short	flags;
  };
  #endif		/* __ASSEMBLY__ */
b2be05273   Ben Hutchings   panic: Allow warn...
27
28
29
  #define BUGFLAG_WARNING		(1 << 0)
  #define BUGFLAG_TAINT(taint)	(BUGFLAG_WARNING | ((taint) << 8))
  #define BUG_GET_TAINT(bug)	((bug)->flags >> 8)
7664c5a1d   Jeremy Fitzhardinge   [PATCH] Generic B...
30
  #endif	/* CONFIG_GENERIC_BUG */
af9379c71   David Brownell   documentation: wh...
31
32
33
34
35
36
37
38
39
40
41
  /*
   * Don't use BUG() or BUG_ON() unless there's really no way out; one
   * example might be detecting data structure corruption in the middle
   * of an operation that can't be backed out of.  If the (sub)system
   * can somehow continue operating, perhaps with reduced functionality,
   * it's probably not BUG-worthy.
   *
   * If you're tempted to BUG(), think again:  is completely giving up
   * really the *only* solution?  There are usually better options, where
   * users don't need to reboot ASAP and can mostly shut down cleanly.
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
42
43
  #ifndef HAVE_ARCH_BUG
  #define BUG() do { \
d5c003b4d   Harvey Harrison   include: replace ...
44
45
  	printk("BUG: failure at %s:%d/%s()!
  ", __FILE__, __LINE__, __func__); \
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
46
47
48
  	panic("BUG!"); \
  } while (0)
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
49
  #ifndef HAVE_ARCH_BUG_ON
2a41de48b   Alexey Dobriyan   Fix sparse false ...
50
  #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while(0)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
51
  #endif
af9379c71   David Brownell   documentation: wh...
52
53
54
55
56
57
  /*
   * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
   * significant issues that need prompt attention if they should ever
   * appear at runtime.  Use the versions with printk format strings
   * to provide better diagnostics.
   */
b2be05273   Ben Hutchings   panic: Allow warn...
58
  #ifndef __WARN_TAINT
79b4cc5ee   Arjan van de Ven   debug: move WARN_...
59
  #ifndef __ASSEMBLY__
b9075fa96   Joe Perches   treewide: use __p...
60
61
62
63
64
65
  extern __printf(3, 4)
  void warn_slowpath_fmt(const char *file, const int line,
  		       const char *fmt, ...);
  extern __printf(4, 5)
  void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
  			     const char *fmt, ...);
57adc4d2d   Andi Kleen   Eliminate thousan...
66
  extern void warn_slowpath_null(const char *file, const int line);
79b4cc5ee   Arjan van de Ven   debug: move WARN_...
67
68
  #define WANT_WARN_ON_SLOWPATH
  #endif
57adc4d2d   Andi Kleen   Eliminate thousan...
69
70
  #define __WARN()		warn_slowpath_null(__FILE__, __LINE__)
  #define __WARN_printf(arg...)	warn_slowpath_fmt(__FILE__, __LINE__, arg)
b2be05273   Ben Hutchings   panic: Allow warn...
71
72
  #define __WARN_printf_taint(taint, arg...)				\
  	warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
a8f18b909   Arjan van de Ven   Add a WARN() macr...
73
  #else
b2be05273   Ben Hutchings   panic: Allow warn...
74
  #define __WARN()		__WARN_TAINT(TAINT_WARN)
ec5679e51   Ingo Molnar   debug warnings: e...
75
  #define __WARN_printf(arg...)	do { printk(arg); __WARN(); } while (0)
b2be05273   Ben Hutchings   panic: Allow warn...
76
77
  #define __WARN_printf_taint(taint, arg...)				\
  	do { printk(arg); __WARN_TAINT(taint); } while (0)
3a6a62f96   Olof Johansson   debug: introduce ...
78
79
80
  #endif
  
  #ifndef WARN_ON
684f97834   Herbert Xu   [PATCH] Let WARN_...
81
  #define WARN_ON(condition) ({						\
8d4fbcfbe   Linus Torvalds   Fix WARN_ON() on ...
82
  	int __ret_warn_on = !!(condition);				\
3a6a62f96   Olof Johansson   debug: introduce ...
83
84
  	if (unlikely(__ret_warn_on))					\
  		__WARN();						\
684f97834   Herbert Xu   [PATCH] Let WARN_...
85
86
  	unlikely(__ret_warn_on);					\
  })
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
87
  #endif
a8f18b909   Arjan van de Ven   Add a WARN() macr...
88
89
90
91
92
93
94
95
  #ifndef WARN
  #define WARN(condition, format...) ({						\
  	int __ret_warn_on = !!(condition);				\
  	if (unlikely(__ret_warn_on))					\
  		__WARN_printf(format);					\
  	unlikely(__ret_warn_on);					\
  })
  #endif
b2be05273   Ben Hutchings   panic: Allow warn...
96
97
98
99
100
101
  #define WARN_TAINT(condition, taint, format...) ({			\
  	int __ret_warn_on = !!(condition);				\
  	if (unlikely(__ret_warn_on))					\
  		__WARN_printf_taint(taint, format);			\
  	unlikely(__ret_warn_on);					\
  })
c8538a7aa   Matt Mackall   [PATCH] remove al...
102
103
  #else /* !CONFIG_BUG */
  #ifndef HAVE_ARCH_BUG
da60682c1   David Howells   The default CONFI...
104
  #define BUG() do {} while(0)
c8538a7aa   Matt Mackall   [PATCH] remove al...
105
  #endif
c8538a7aa   Matt Mackall   [PATCH] remove al...
106
107
108
109
110
  #ifndef HAVE_ARCH_BUG_ON
  #define BUG_ON(condition) do { if (condition) ; } while(0)
  #endif
  
  #ifndef HAVE_ARCH_WARN_ON
8c7c7c9bf   Ralf Baechle   [PATCH] Fix warni...
111
  #define WARN_ON(condition) ({						\
8d4fbcfbe   Linus Torvalds   Fix WARN_ON() on ...
112
  	int __ret_warn_on = !!(condition);				\
8c7c7c9bf   Ralf Baechle   [PATCH] Fix warni...
113
114
  	unlikely(__ret_warn_on);					\
  })
c8538a7aa   Matt Mackall   [PATCH] remove al...
115
  #endif
a8f18b909   Arjan van de Ven   Add a WARN() macr...
116
117
118
119
120
121
122
  
  #ifndef WARN
  #define WARN(condition, format...) ({					\
  	int __ret_warn_on = !!(condition);				\
  	unlikely(__ret_warn_on);					\
  })
  #endif
b2be05273   Ben Hutchings   panic: Allow warn...
123
  #define WARN_TAINT(condition, taint, format...) WARN_ON(condition)
c8538a7aa   Matt Mackall   [PATCH] remove al...
124
  #endif
d69a89226   Andrew Morton   [PATCH] Fix WARN_...
125
  #define WARN_ON_ONCE(condition)	({				\
42f247c83   Cesar Eduardo Barros   WARN_ONCE(): use ...
126
  	static bool __warned;					\
8d4fbcfbe   Linus Torvalds   Fix WARN_ON() on ...
127
  	int __ret_warn_once = !!(condition);			\
d69a89226   Andrew Morton   [PATCH] Fix WARN_...
128
129
130
  								\
  	if (unlikely(__ret_warn_once))				\
  		if (WARN_ON(!__warned)) 			\
42f247c83   Cesar Eduardo Barros   WARN_ONCE(): use ...
131
  			__warned = true;			\
d69a89226   Andrew Morton   [PATCH] Fix WARN_...
132
  	unlikely(__ret_warn_once);				\
74bb6a09b   Ingo Molnar   [PATCH] introduce...
133
  })
45e9c0de2   Arjan van de Ven   warn: Turn the ne...
134
  #define WARN_ONCE(condition, format...)	({			\
42f247c83   Cesar Eduardo Barros   WARN_ONCE(): use ...
135
  	static bool __warned;					\
45e9c0de2   Arjan van de Ven   warn: Turn the ne...
136
137
138
139
  	int __ret_warn_once = !!(condition);			\
  								\
  	if (unlikely(__ret_warn_once))				\
  		if (WARN(!__warned, format)) 			\
42f247c83   Cesar Eduardo Barros   WARN_ONCE(): use ...
140
  			__warned = true;			\
45e9c0de2   Arjan van de Ven   warn: Turn the ne...
141
142
  	unlikely(__ret_warn_once);				\
  })
b2be05273   Ben Hutchings   panic: Allow warn...
143
144
145
146
147
148
149
150
151
  #define WARN_TAINT_ONCE(condition, taint, format...)	({	\
  	static bool __warned;					\
  	int __ret_warn_once = !!(condition);			\
  								\
  	if (unlikely(__ret_warn_once))				\
  		if (WARN_TAINT(!__warned, taint, format))	\
  			__warned = true;			\
  	unlikely(__ret_warn_once);				\
  })
2092e6be8   Steven Rostedt   WARN_ON_SMP(): Al...
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
  /*
   * WARN_ON_SMP() is for cases that the warning is either
   * meaningless for !SMP or may even cause failures.
   * This is usually used for cases that we have
   * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
   * returns 0 for uniprocessor settings.
   * It can also be used with values that are only defined
   * on SMP:
   *
   * struct foo {
   *  [...]
   * #ifdef CONFIG_SMP
   *	int bar;
   * #endif
   * };
   *
   * void func(struct foo *zoot)
   * {
   *	WARN_ON_SMP(!zoot->bar);
   *
   * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
   * and should be a nop and return false for uniprocessor.
   *
   * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
   * and x is true.
   */
8eb94f80d   Ingo Molnar   [PATCH] pi-futex:...
178
179
180
  #ifdef CONFIG_SMP
  # define WARN_ON_SMP(x)			WARN_ON(x)
  #else
ccd0d44fa   Steven Rostedt   WARN_ON_SMP(): Ad...
181
182
183
184
185
186
187
  /*
   * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
   * a stand alone line statement or as a condition in an if ()
   * statement.
   * A simple "0" would cause gcc to give a "statement has no effect"
   * warning.
   */
2092e6be8   Steven Rostedt   WARN_ON_SMP(): Al...
188
  # define WARN_ON_SMP(x)			({0;})
8eb94f80d   Ingo Molnar   [PATCH] pi-futex:...
189
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
190
  #endif