[linux.git] / include / linux / bug.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_BUG_H
#define _LINUX_BUG_H

#include <asm/bug.h>
#include <linux/compiler.h>
#include <linux/build_bug.h>

enum bug_trap_type {
	BUG_TRAP_TYPE_NONE = 0,
	BUG_TRAP_TYPE_WARN = 1,
	BUG_TRAP_TYPE_BUG = 2,
};

struct pt_regs;

#ifdef __CHECKER__
#define MAYBE_BUILD_BUG_ON(cond) (0)
#else /* __CHECKER__ */

#define MAYBE_BUILD_BUG_ON(cond)			\
	do {						\
		if (__builtin_constant_p((cond)))       \
			BUILD_BUG_ON(cond);             \
		else                                    \
			BUG_ON(cond);                   \
	} while (0)

#endif	/* __CHECKER__ */

#ifdef CONFIG_GENERIC_BUG
#include <asm-generic/bug.h>

static inline int is_warning_bug(const struct bug_entry *bug)
{
	return bug->flags & BUGFLAG_WARNING;
}

void bug_get_file_line(struct bug_entry *bug, const char **file,
		       unsigned int *line);

struct bug_entry *find_bug(unsigned long bugaddr);

enum bug_trap_type report_bug(unsigned long bug_addr, struct pt_regs *regs);

/* These are defined by the architecture */
int is_valid_bugaddr(unsigned long addr);

void generic_bug_clear_once(void);

#else	/* !CONFIG_GENERIC_BUG */

static inline void *find_bug(unsigned long bugaddr)
{
	return NULL;
}

static inline enum bug_trap_type report_bug(unsigned long bug_addr,
					    struct pt_regs *regs)
{
	return BUG_TRAP_TYPE_BUG;
}

struct bug_entry;
static inline void bug_get_file_line(struct bug_entry *bug, const char **file,
				     unsigned int *line)
{
	*file = NULL;
	*line = 0;
}

static inline void generic_bug_clear_once(void) {}

#endif	/* CONFIG_GENERIC_BUG */

#ifdef CONFIG_PRINTK
void mem_dump_obj(void *object);
#else
static inline void mem_dump_obj(void *object) {}
#endif

/*
 * Since detected data corruption should stop operation on the affected
 * structures. Return value must be checked and sanely acted on by caller.
 */
static inline __must_check bool check_data_corruption(bool v) { return v; }
#define CHECK_DATA_CORRUPTION(condition, addr, fmt, ...)		 \
	check_data_corruption(({					 \
		bool corruption = unlikely(condition);			 \
		if (corruption) {					 \
			if (addr)					 \
				mem_dump_obj(addr);			 \
			if (IS_ENABLED(CONFIG_BUG_ON_DATA_CORRUPTION)) { \
				pr_err(fmt, ##__VA_ARGS__);		 \
				BUG();					 \
			} else						 \
				WARN(1, fmt, ##__VA_ARGS__);		 \
		}							 \
		corruption;						 \
	}))

#endif	/* _LINUX_BUG_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
7664c5a1 JF	2	#ifndef _LINUX_BUG_H
	3	#define _LINUX_BUG_H
	4
7664c5a1	5	#include <asm/bug.h>
a3ccc497	6	#include <linux/compiler.h>
bc6245e5	7	#include <linux/build_bug.h>
7664c5a1 JF	8
	9	enum bug_trap_type {
	10	BUG_TRAP_TYPE_NONE = 0,
	11	BUG_TRAP_TYPE_WARN = 1,
	12	BUG_TRAP_TYPE_BUG = 2,
	13	};
	14
608e2619 HC	15	struct pt_regs;
608e2619 HC	16
35edd910	17	#ifdef __CHECKER__
ff20c2e0	18	#define MAYBE_BUILD_BUG_ON(cond) (0)
35edd910 PG	19	#else /* __CHECKER__ */
35edd910 PG	20
ff20c2e0 KS	21	#define MAYBE_BUILD_BUG_ON(cond) \
	22	do { \
	23	if (__builtin_constant_p((cond))) \
	24	BUILD_BUG_ON(cond); \
	25	else \
	26	BUG_ON(cond); \
	27	} while (0)
	28
35edd910 PG	29	#endif /* __CHECKER__ */
35edd910 PG	30
7664c5a1 JF	31	#ifdef CONFIG_GENERIC_BUG
	32	#include <asm-generic/bug.h>
	33
	34	static inline int is_warning_bug(const struct bug_entry *bug)
	35	{
	36	return bug->flags & BUGFLAG_WARNING;
	37	}
	38
26dbc7e2 AS	39	void bug_get_file_line(struct bug_entry bug, const char *file,
	40	unsigned int *line);
	41
19d43626	42	struct bug_entry *find_bug(unsigned long bugaddr);
7664c5a1	43
608e2619	44	enum bug_trap_type report_bug(unsigned long bug_addr, struct pt_regs *regs);
7664c5a1	45
7664c5a1 JF	46	/* These are defined by the architecture */
	47	int is_valid_bugaddr(unsigned long addr);
	48
aaf5dcfb AK	49	void generic_bug_clear_once(void);
aaf5dcfb AK	50
7664c5a1 JF	51	#else /* !CONFIG_GENERIC_BUG */
7664c5a1 JF	52
e336b402 MH	53	static inline void *find_bug(unsigned long bugaddr)
	54	{
	55	return NULL;
	56	}
	57
608e2619 HC	58	static inline enum bug_trap_type report_bug(unsigned long bug_addr,
608e2619 HC	59	struct pt_regs *regs)
7664c5a1 JF	60	{
	61	return BUG_TRAP_TYPE_BUG;
	62	}
7664c5a1	63
d3debfcc MZ	64	struct bug_entry;
	65	static inline void bug_get_file_line(struct bug_entry bug, const char *file,
	66	unsigned int *line)
	67	{
	68	*file = NULL;
	69	*line = 0;
	70	}
aaf5dcfb AK	71
	72	static inline void generic_bug_clear_once(void) {}
	73
7664c5a1	74	#endif /* CONFIG_GENERIC_BUG */
de54ebbe	75
30cee1e4 MS	76	#ifdef CONFIG_PRINTK
	77	void mem_dump_obj(void *object);
	78	#else
	79	static inline void mem_dump_obj(void *object) {}
	80	#endif
	81
de54ebbe KC	82	/*
de54ebbe KC	83	* Since detected data corruption should stop operation on the affected
85caa95b	84	* structures. Return value must be checked and sanely acted on by caller.
de54ebbe	85	*/
85caa95b	86	static inline __must_check bool check_data_corruption(bool v) { return v; }
30cee1e4	87	#define CHECK_DATA_CORRUPTION(condition, addr, fmt, ...) \
85caa95b KC	88	check_data_corruption(({ \
	89	bool corruption = unlikely(condition); \
	90	if (corruption) { \
30cee1e4 MS	91	if (addr) \
30cee1e4 MS	92	mem_dump_obj(addr); \
de54ebbe KC	93	if (IS_ENABLED(CONFIG_BUG_ON_DATA_CORRUPTION)) { \
	94	pr_err(fmt, ##__VA_ARGS__); \
	95	BUG(); \
	96	} else \
	97	WARN(1, fmt, ##__VA_ARGS__); \
de54ebbe	98	} \
85caa95b KC	99	corruption; \
85caa95b KC	100	}))
de54ebbe	101
7664c5a1	102	#endif /* _LINUX_BUG_H */