1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef _LINUX_BUG_H
3*4882a593Smuzhiyun #define _LINUX_BUG_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun #include <asm/bug.h>
6*4882a593Smuzhiyun #include <linux/compiler.h>
7*4882a593Smuzhiyun #include <linux/build_bug.h>
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun enum bug_trap_type {
10*4882a593Smuzhiyun BUG_TRAP_TYPE_NONE = 0,
11*4882a593Smuzhiyun BUG_TRAP_TYPE_WARN = 1,
12*4882a593Smuzhiyun BUG_TRAP_TYPE_BUG = 2,
13*4882a593Smuzhiyun };
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun struct pt_regs;
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun #ifdef __CHECKER__
18*4882a593Smuzhiyun #define MAYBE_BUILD_BUG_ON(cond) (0)
19*4882a593Smuzhiyun #else /* __CHECKER__ */
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #define MAYBE_BUILD_BUG_ON(cond) \
22*4882a593Smuzhiyun do { \
23*4882a593Smuzhiyun if (__builtin_constant_p((cond))) \
24*4882a593Smuzhiyun BUILD_BUG_ON(cond); \
25*4882a593Smuzhiyun else \
26*4882a593Smuzhiyun BUG_ON(cond); \
27*4882a593Smuzhiyun } while (0)
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun #endif /* __CHECKER__ */
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun #ifdef CONFIG_GENERIC_BUG
32*4882a593Smuzhiyun #include <asm-generic/bug.h>
33*4882a593Smuzhiyun
is_warning_bug(const struct bug_entry * bug)34*4882a593Smuzhiyun static inline int is_warning_bug(const struct bug_entry *bug)
35*4882a593Smuzhiyun {
36*4882a593Smuzhiyun return bug->flags & BUGFLAG_WARNING;
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun struct bug_entry *find_bug(unsigned long bugaddr);
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun enum bug_trap_type report_bug(unsigned long bug_addr, struct pt_regs *regs);
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun /* These are defined by the architecture */
44*4882a593Smuzhiyun int is_valid_bugaddr(unsigned long addr);
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun void generic_bug_clear_once(void);
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun #else /* !CONFIG_GENERIC_BUG */
49*4882a593Smuzhiyun
find_bug(unsigned long bugaddr)50*4882a593Smuzhiyun static inline void *find_bug(unsigned long bugaddr)
51*4882a593Smuzhiyun {
52*4882a593Smuzhiyun return NULL;
53*4882a593Smuzhiyun }
54*4882a593Smuzhiyun
report_bug(unsigned long bug_addr,struct pt_regs * regs)55*4882a593Smuzhiyun static inline enum bug_trap_type report_bug(unsigned long bug_addr,
56*4882a593Smuzhiyun struct pt_regs *regs)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun return BUG_TRAP_TYPE_BUG;
59*4882a593Smuzhiyun }
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun
generic_bug_clear_once(void)62*4882a593Smuzhiyun static inline void generic_bug_clear_once(void) {}
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun #endif /* CONFIG_GENERIC_BUG */
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun /*
67*4882a593Smuzhiyun * Since detected data corruption should stop operation on the affected
68*4882a593Smuzhiyun * structures. Return value must be checked and sanely acted on by caller.
69*4882a593Smuzhiyun */
check_data_corruption(bool v)70*4882a593Smuzhiyun static inline __must_check bool check_data_corruption(bool v) { return v; }
71*4882a593Smuzhiyun #define CHECK_DATA_CORRUPTION(condition, fmt, ...) \
72*4882a593Smuzhiyun check_data_corruption(({ \
73*4882a593Smuzhiyun bool corruption = unlikely(condition); \
74*4882a593Smuzhiyun if (corruption) { \
75*4882a593Smuzhiyun if (IS_ENABLED(CONFIG_BUG_ON_DATA_CORRUPTION)) { \
76*4882a593Smuzhiyun pr_err(fmt, ##__VA_ARGS__); \
77*4882a593Smuzhiyun BUG(); \
78*4882a593Smuzhiyun } else \
79*4882a593Smuzhiyun WARN(1, fmt, ##__VA_ARGS__); \
80*4882a593Smuzhiyun } \
81*4882a593Smuzhiyun corruption; \
82*4882a593Smuzhiyun }))
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun #endif /* _LINUX_BUG_H */
85