]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/asm-generic/bug.h
dmaengine: Fix access to uninitialized dma_slave_caps
[mirror_ubuntu-bionic-kernel.git] / include / asm-generic / bug.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _ASM_GENERIC_BUG_H
3#define _ASM_GENERIC_BUG_H
4
5#include <linux/compiler.h>
1da177e4 6
2a8358d8
KC
7#define CUT_HERE "------------[ cut here ]------------\n"
8
09682c1d
PM
9#ifdef CONFIG_GENERIC_BUG
10#define BUGFLAG_WARNING (1 << 0)
19d43626
PZ
11#define BUGFLAG_ONCE (1 << 1)
12#define BUGFLAG_DONE (1 << 2)
f26dee15 13#define BUGFLAG_TAINT(taint) ((taint) << 8)
09682c1d
PM
14#define BUG_GET_TAINT(bug) ((bug)->flags >> 8)
15#endif
16
17#ifndef __ASSEMBLY__
18#include <linux/kernel.h>
19
c8538a7a 20#ifdef CONFIG_BUG
7664c5a1
JF
21
22#ifdef CONFIG_GENERIC_BUG
7664c5a1 23struct bug_entry {
b93a531e 24#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
7664c5a1 25 unsigned long bug_addr;
b93a531e
JB
26#else
27 signed int bug_addr_disp;
28#endif
7664c5a1 29#ifdef CONFIG_DEBUG_BUGVERBOSE
b93a531e 30#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
7664c5a1 31 const char *file;
b93a531e
JB
32#else
33 signed int file_disp;
34#endif
7664c5a1
JF
35 unsigned short line;
36#endif
37 unsigned short flags;
38};
7664c5a1
JF
39#endif /* CONFIG_GENERIC_BUG */
40
af9379c7
DB
41/*
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.
47 *
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.
51 */
1da177e4
LT
52#ifndef HAVE_ARCH_BUG
53#define BUG() do { \
d5c003b4 54 printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
a1fa7ffe 55 barrier_before_unreachable(); \
1da177e4
LT
56 panic("BUG!"); \
57} while (0)
58#endif
59
1da177e4 60#ifndef HAVE_ARCH_BUG_ON
a3f7607d 61#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
1da177e4
LT
62#endif
63
19d43626
PZ
64#ifdef __WARN_FLAGS
65#define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint))
66#define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint))
67
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); \
73})
74#endif
75
af9379c7
DB
76/*
77 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
78 * significant issues that need prompt attention if they should ever
79 * appear at runtime. Use the versions with printk format strings
80 * to provide better diagnostics.
81 */
b2be0527 82#ifndef __WARN_TAINT
b9075fa9
JP
83extern __printf(3, 4)
84void warn_slowpath_fmt(const char *file, const int line,
85 const char *fmt, ...);
86extern __printf(4, 5)
87void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
88 const char *fmt, ...);
57adc4d2 89extern void warn_slowpath_null(const char *file, const int line);
79b4cc5e 90#define WANT_WARN_ON_SLOWPATH
57adc4d2
AK
91#define __WARN() warn_slowpath_null(__FILE__, __LINE__)
92#define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg)
b2be0527
BH
93#define __WARN_printf_taint(taint, arg...) \
94 warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
a8f18b90 95#else
a7bed27a 96extern __printf(1, 2) void __warn_printk(const char *fmt, ...);
7a9c0667
DD
97#define __WARN() do { \
98 printk(KERN_WARNING CUT_HERE); __WARN_TAINT(TAINT_WARN); \
99} while (0)
100#define __WARN_printf(arg...) __WARN_printf_taint(TAINT_WARN, arg)
b2be0527 101#define __WARN_printf_taint(taint, arg...) \
a7bed27a 102 do { __warn_printk(arg); __WARN_TAINT(taint); } while (0)
3a6a62f9
OJ
103#endif
104
2553b67a
JP
105/* used internally by panic.c */
106struct warn_args;
0b396923 107struct pt_regs;
2553b67a
JP
108
109void __warn(const char *file, int line, void *caller, unsigned taint,
110 struct pt_regs *regs, struct warn_args *args);
111
3a6a62f9 112#ifndef WARN_ON
684f9783 113#define WARN_ON(condition) ({ \
8d4fbcfb 114 int __ret_warn_on = !!(condition); \
3a6a62f9
OJ
115 if (unlikely(__ret_warn_on)) \
116 __WARN(); \
684f9783
HX
117 unlikely(__ret_warn_on); \
118})
1da177e4
LT
119#endif
120
a8f18b90 121#ifndef WARN
19d43626 122#define WARN(condition, format...) ({ \
a8f18b90
AV
123 int __ret_warn_on = !!(condition); \
124 if (unlikely(__ret_warn_on)) \
125 __WARN_printf(format); \
126 unlikely(__ret_warn_on); \
127})
128#endif
129
b2be0527
BH
130#define WARN_TAINT(condition, taint, format...) ({ \
131 int __ret_warn_on = !!(condition); \
132 if (unlikely(__ret_warn_on)) \
133 __WARN_printf_taint(taint, format); \
134 unlikely(__ret_warn_on); \
135})
136
19d43626 137#ifndef WARN_ON_ONCE
d69a8922 138#define WARN_ON_ONCE(condition) ({ \
b1fca27d 139 static bool __section(.data.once) __warned; \
8d4fbcfb 140 int __ret_warn_once = !!(condition); \
d69a8922 141 \
dfbf2897
SR
142 if (unlikely(__ret_warn_once && !__warned)) { \
143 __warned = true; \
144 WARN_ON(1); \
145 } \
d69a8922 146 unlikely(__ret_warn_once); \
74bb6a09 147})
19d43626 148#endif
74bb6a09 149
45e9c0de 150#define WARN_ONCE(condition, format...) ({ \
b1fca27d 151 static bool __section(.data.once) __warned; \
45e9c0de
AV
152 int __ret_warn_once = !!(condition); \
153 \
dfbf2897
SR
154 if (unlikely(__ret_warn_once && !__warned)) { \
155 __warned = true; \
156 WARN(1, format); \
157 } \
45e9c0de
AV
158 unlikely(__ret_warn_once); \
159})
160
b2be0527 161#define WARN_TAINT_ONCE(condition, taint, format...) ({ \
b1fca27d 162 static bool __section(.data.once) __warned; \
b2be0527
BH
163 int __ret_warn_once = !!(condition); \
164 \
dfbf2897
SR
165 if (unlikely(__ret_warn_once && !__warned)) { \
166 __warned = true; \
167 WARN_TAINT(1, taint, format); \
168 } \
b2be0527
BH
169 unlikely(__ret_warn_once); \
170})
171
b607e70e
JT
172#else /* !CONFIG_BUG */
173#ifndef HAVE_ARCH_BUG
a4b5d580 174#define BUG() do {} while (1)
b607e70e
JT
175#endif
176
177#ifndef HAVE_ARCH_BUG_ON
3c047057 178#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
b607e70e
JT
179#endif
180
181#ifndef HAVE_ARCH_WARN_ON
182#define WARN_ON(condition) ({ \
183 int __ret_warn_on = !!(condition); \
184 unlikely(__ret_warn_on); \
185})
186#endif
187
188#ifndef WARN
189#define WARN(condition, format...) ({ \
190 int __ret_warn_on = !!(condition); \
4e50ebde 191 no_printk(format); \
b607e70e
JT
192 unlikely(__ret_warn_on); \
193})
194#endif
195
196#define WARN_ON_ONCE(condition) WARN_ON(condition)
197#define WARN_ONCE(condition, format...) WARN(condition, format)
198#define WARN_TAINT(condition, taint, format...) WARN(condition, format)
199#define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format)
200
201#endif
202
2092e6be
SR
203/*
204 * WARN_ON_SMP() is for cases that the warning is either
205 * meaningless for !SMP or may even cause failures.
206 * This is usually used for cases that we have
207 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
208 * returns 0 for uniprocessor settings.
209 * It can also be used with values that are only defined
210 * on SMP:
211 *
212 * struct foo {
213 * [...]
214 * #ifdef CONFIG_SMP
215 * int bar;
216 * #endif
217 * };
218 *
219 * void func(struct foo *zoot)
220 * {
221 * WARN_ON_SMP(!zoot->bar);
222 *
223 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
224 * and should be a nop and return false for uniprocessor.
225 *
226 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
227 * and x is true.
228 */
8eb94f80
IM
229#ifdef CONFIG_SMP
230# define WARN_ON_SMP(x) WARN_ON(x)
231#else
ccd0d44f
SR
232/*
233 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
234 * a stand alone line statement or as a condition in an if ()
235 * statement.
236 * A simple "0" would cause gcc to give a "statement has no effect"
237 * warning.
238 */
2092e6be 239# define WARN_ON_SMP(x) ({0;})
8eb94f80
IM
240#endif
241
2603efa3
PM
242#endif /* __ASSEMBLY__ */
243
1da177e4 244#endif