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__); \
55 barrier_before_unreachable(); \
60 #ifndef HAVE_ARCH_BUG_ON
61 #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
65 #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint))
66 #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint))
68 #define WARN_ON_ONCE(condition) ({ \
69 int __ret_warn_on = !!(condition); \
70 if (unlikely(__ret_warn_on)) \
71 __WARN_ONCE_TAINT(TAINT_WARN); \
72 unlikely(__ret_warn_on); \
77 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
78 * significant kernel issues that need prompt attention if they should ever
81 * Do not use these macros when checking for invalid external inputs
82 * (e.g. invalid system call arguments, or invalid data coming from
83 * network/devices), and on transient conditions like ENOMEM or EAGAIN.
84 * These macros should be used for recoverable kernel issues only.
85 * For invalid external inputs, transient conditions, etc use
86 * pr_err[_once/_ratelimited]() followed by dump_stack(), if necessary.
87 * Do not include "BUG"/"WARNING" in format strings manually to make these
88 * conditions distinguishable from kernel issues.
90 * Use the versions with printk format strings to provide better diagnostics.
94 void warn_slowpath_fmt(const char *file, const int line,
95 const char *fmt, ...);
97 void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
98 const char *fmt, ...);
99 extern void warn_slowpath_null(const char *file, const int line);
100 #define WANT_WARN_ON_SLOWPATH
101 #define __WARN() warn_slowpath_null(__FILE__, __LINE__)
102 #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
103 #define __WARN_printf_taint(taint, arg...) \
104 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
106 extern __printf(1, 2) void __warn_printk(const char *fmt, ...);
107 #define __WARN() do { \
108 printk(KERN_WARNING CUT_HERE); __WARN_TAINT(TAINT_WARN); \
110 #define __WARN_printf(arg...) __WARN_printf_taint(TAINT_WARN, arg)
111 #define __WARN_printf_taint(taint, arg...) \
112 do { __warn_printk(arg); __WARN_TAINT(taint); } while (0)
115 /* used internally by panic.c */
119 void __warn(const char *file, int line, void *caller, unsigned taint,
120 struct pt_regs *regs, struct warn_args *args);
123 #define WARN_ON(condition) ({ \
124 int __ret_warn_on = !!(condition); \
125 if (unlikely(__ret_warn_on)) \
127 unlikely(__ret_warn_on); \
132 #define WARN(condition, format...) ({ \
133 int __ret_warn_on = !!(condition); \
134 if (unlikely(__ret_warn_on)) \
135 __WARN_printf(format); \
136 unlikely(__ret_warn_on); \
140 #define WARN_TAINT(condition, taint, format...) ({ \
141 int __ret_warn_on = !!(condition); \
142 if (unlikely(__ret_warn_on)) \
143 __WARN_printf_taint(taint, format); \
144 unlikely(__ret_warn_on); \
148 #define WARN_ON_ONCE(condition) ({ \
149 static bool __section(.data.once) __warned; \
150 int __ret_warn_once = !!(condition); \
152 if (unlikely(__ret_warn_once && !__warned)) { \
156 unlikely(__ret_warn_once); \
160 #define WARN_ONCE(condition, format...) ({ \
161 static bool __section(.data.once) __warned; \
162 int __ret_warn_once = !!(condition); \
164 if (unlikely(__ret_warn_once && !__warned)) { \
168 unlikely(__ret_warn_once); \
171 #define WARN_TAINT_ONCE(condition, taint, format...) ({ \
172 static bool __section(.data.once) __warned; \
173 int __ret_warn_once = !!(condition); \
175 if (unlikely(__ret_warn_once && !__warned)) { \
177 WARN_TAINT(1, taint, format); \
179 unlikely(__ret_warn_once); \
182 #else /* !CONFIG_BUG */
183 #ifndef HAVE_ARCH_BUG
184 #define BUG() do {} while (1)
187 #ifndef HAVE_ARCH_BUG_ON
188 #define BUG_ON(condition) do { if (condition) BUG(); } while (0)
191 #ifndef HAVE_ARCH_WARN_ON
192 #define WARN_ON(condition) ({ \
193 int __ret_warn_on = !!(condition); \
194 unlikely(__ret_warn_on); \
199 #define WARN(condition, format...) ({ \
200 int __ret_warn_on = !!(condition); \
202 unlikely(__ret_warn_on); \
206 #define WARN_ON_ONCE(condition) WARN_ON(condition)
207 #define WARN_ONCE(condition, format...) WARN(condition, format)
208 #define WARN_TAINT(condition, taint, format...) WARN(condition, format)
209 #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format)
214 * WARN_ON_SMP() is for cases that the warning is either
215 * meaningless for !SMP or may even cause failures.
216 * This is usually used for cases that we have
217 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
218 * returns 0 for uniprocessor settings.
219 * It can also be used with values that are only defined
229 * void func(struct foo *zoot)
231 * WARN_ON_SMP(!zoot->bar);
233 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
234 * and should be a nop and return false for uniprocessor.
236 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
240 # define WARN_ON_SMP(x) WARN_ON(x)
243 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
244 * a stand alone line statement or as a condition in an if ()
246 * A simple "0" would cause gcc to give a "statement has no effect"
249 # define WARN_ON_SMP(x) ({0;})
252 #endif /* __ASSEMBLY__ */