1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_GENERIC_BUG_H
3 #define _ASM_GENERIC_BUG_H
5 #include <linux/compiler.h>
7 #define CUT_HERE "------------[ cut here ]------------\n"
9 #ifdef CONFIG_GENERIC_BUG
10 #define BUGFLAG_WARNING (1 << 0)
11 #define BUGFLAG_ONCE (1 << 1)
12 #define BUGFLAG_DONE (1 << 2)
13 #define BUGFLAG_TAINT(taint) ((taint) << 8)
14 #define BUG_GET_TAINT(bug) ((bug)->flags >> 8)
18 #include <linux/kernel.h>
22 #ifdef CONFIG_GENERIC_BUG
24 #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
25 unsigned long bug_addr
;
27 signed int bug_addr_disp
;
29 #ifdef CONFIG_DEBUG_BUGVERBOSE
30 #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
39 #endif /* CONFIG_GENERIC_BUG */
42 * Don't use BUG() or BUG_ON() unless there's really no way out; one
43 * example might be detecting data structure corruption in the middle
44 * of an operation that can't be backed out of. If the (sub)system
45 * can somehow continue operating, perhaps with reduced functionality,
46 * it's probably not BUG-worthy.
48 * If you're tempted to BUG(), think again: is completely giving up
49 * really the *only* solution? There are usually better options, where
50 * users don't need to reboot ASAP and can mostly shut down cleanly.
54 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
59 #ifndef HAVE_ARCH_BUG_ON
60 #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
64 #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint))
65 #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint))
67 #define WARN_ON_ONCE(condition) ({ \
68 int __ret_warn_on = !!(condition); \
69 if (unlikely(__ret_warn_on)) \
70 __WARN_ONCE_TAINT(TAINT_WARN); \
71 unlikely(__ret_warn_on); \
76 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
77 * significant issues that need prompt attention if they should ever
78 * appear at runtime. Use the versions with printk format strings
79 * to provide better diagnostics.
83 void warn_slowpath_fmt(const char *file
, const int line
,
84 const char *fmt
, ...);
86 void warn_slowpath_fmt_taint(const char *file
, const int line
, unsigned taint
,
87 const char *fmt
, ...);
88 extern void warn_slowpath_null(const char *file
, const int line
);
89 #define WANT_WARN_ON_SLOWPATH
90 #define __WARN() warn_slowpath_null(__FILE__, __LINE__)
91 #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
92 #define __WARN_printf_taint(taint, arg...) \
93 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
95 extern __printf(1, 2) void __warn_printk(const char *fmt
, ...);
96 #define __WARN() __WARN_TAINT(TAINT_WARN)
97 #define __WARN_printf(arg...) do { __warn_printk(arg); __WARN(); } while (0)
98 #define __WARN_printf_taint(taint, arg...) \
99 do { __warn_printk(arg); __WARN_TAINT(taint); } while (0)
102 /* used internally by panic.c */
106 void __warn(const char *file
, int line
, void *caller
, unsigned taint
,
107 struct pt_regs
*regs
, struct warn_args
*args
);
110 #define WARN_ON(condition) ({ \
111 int __ret_warn_on = !!(condition); \
112 if (unlikely(__ret_warn_on)) \
114 unlikely(__ret_warn_on); \
119 #define WARN(condition, format...) ({ \
120 int __ret_warn_on = !!(condition); \
121 if (unlikely(__ret_warn_on)) \
122 __WARN_printf(format); \
123 unlikely(__ret_warn_on); \
127 #define WARN_TAINT(condition, taint, format...) ({ \
128 int __ret_warn_on = !!(condition); \
129 if (unlikely(__ret_warn_on)) \
130 __WARN_printf_taint(taint, format); \
131 unlikely(__ret_warn_on); \
135 #define WARN_ON_ONCE(condition) ({ \
136 static bool __section(.data.once) __warned; \
137 int __ret_warn_once = !!(condition); \
139 if (unlikely(__ret_warn_once && !__warned)) { \
143 unlikely(__ret_warn_once); \
147 #define WARN_ONCE(condition, format...) ({ \
148 static bool __section(.data.once) __warned; \
149 int __ret_warn_once = !!(condition); \
151 if (unlikely(__ret_warn_once && !__warned)) { \
155 unlikely(__ret_warn_once); \
158 #define WARN_TAINT_ONCE(condition, taint, format...) ({ \
159 static bool __section(.data.once) __warned; \
160 int __ret_warn_once = !!(condition); \
162 if (unlikely(__ret_warn_once && !__warned)) { \
164 WARN_TAINT(1, taint, format); \
166 unlikely(__ret_warn_once); \
169 #else /* !CONFIG_BUG */
170 #ifndef HAVE_ARCH_BUG
171 #define BUG() do {} while (1)
174 #ifndef HAVE_ARCH_BUG_ON
175 #define BUG_ON(condition) do { if (condition) BUG(); } while (0)
178 #ifndef HAVE_ARCH_WARN_ON
179 #define WARN_ON(condition) ({ \
180 int __ret_warn_on = !!(condition); \
181 unlikely(__ret_warn_on); \
186 #define WARN(condition, format...) ({ \
187 int __ret_warn_on = !!(condition); \
189 unlikely(__ret_warn_on); \
193 #define WARN_ON_ONCE(condition) WARN_ON(condition)
194 #define WARN_ONCE(condition, format...) WARN(condition, format)
195 #define WARN_TAINT(condition, taint, format...) WARN(condition, format)
196 #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format)
201 * WARN_ON_SMP() is for cases that the warning is either
202 * meaningless for !SMP or may even cause failures.
203 * This is usually used for cases that we have
204 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
205 * returns 0 for uniprocessor settings.
206 * It can also be used with values that are only defined
216 * void func(struct foo *zoot)
218 * WARN_ON_SMP(!zoot->bar);
220 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
221 * and should be a nop and return false for uniprocessor.
223 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
227 # define WARN_ON_SMP(x) WARN_ON(x)
230 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
231 * a stand alone line statement or as a condition in an if ()
233 * A simple "0" would cause gcc to give a "statement has no effect"
236 # define WARN_ON_SMP(x) ({0;})
239 #endif /* __ASSEMBLY__ */