[mirror_ubuntu-jammy-kernel.git] / include / asm-generic / bug.h

#ifndef _ASM_GENERIC_BUG_H
#define _ASM_GENERIC_BUG_H

#include <linux/compiler.h>

#ifdef CONFIG_GENERIC_BUG
#define BUGFLAG_WARNING		(1 << 0)
#define BUGFLAG_ONCE		(1 << 1)
#define BUGFLAG_DONE		(1 << 2)
#define BUGFLAG_TAINT(taint)	((taint) << 8)
#define BUG_GET_TAINT(bug)	((bug)->flags >> 8)
#endif

#ifndef __ASSEMBLY__
#include <linux/kernel.h>

#ifdef CONFIG_BUG

#ifdef CONFIG_GENERIC_BUG
struct bug_entry {
#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
	unsigned long	bug_addr;
#else
	signed int	bug_addr_disp;
#endif
#ifdef CONFIG_DEBUG_BUGVERBOSE
#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
	const char	*file;
#else
	signed int	file_disp;
#endif
	unsigned short	line;
#endif
	unsigned short	flags;
};
#endif	/* CONFIG_GENERIC_BUG */

/*
 * Don't use BUG() or BUG_ON() unless there's really no way out; one
 * example might be detecting data structure corruption in the middle
 * of an operation that can't be backed out of.  If the (sub)system
 * can somehow continue operating, perhaps with reduced functionality,
 * it's probably not BUG-worthy.
 *
 * If you're tempted to BUG(), think again:  is completely giving up
 * really the *only* solution?  There are usually better options, where
 * users don't need to reboot ASAP and can mostly shut down cleanly.
 */
#ifndef HAVE_ARCH_BUG
#define BUG() do { \
	printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
	panic("BUG!"); \
} while (0)
#endif

#ifndef HAVE_ARCH_BUG_ON
#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)
#endif

#ifdef __WARN_FLAGS
#define __WARN_TAINT(taint)		__WARN_FLAGS(BUGFLAG_TAINT(taint))
#define __WARN_ONCE_TAINT(taint)	__WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint))

#define WARN_ON_ONCE(condition) ({				\
	int __ret_warn_on = !!(condition);			\
	if (unlikely(__ret_warn_on))				\
		__WARN_ONCE_TAINT(TAINT_WARN);			\
	unlikely(__ret_warn_on);				\
})
#endif

/*
 * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
 * significant issues that need prompt attention if they should ever
 * appear at runtime.  Use the versions with printk format strings
 * to provide better diagnostics.
 */
#ifndef __WARN_TAINT
extern __printf(3, 4)
void warn_slowpath_fmt(const char *file, const int line,
		       const char *fmt, ...);
extern __printf(4, 5)
void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint,
			     const char *fmt, ...);
extern void warn_slowpath_null(const char *file, const int line);
#define WANT_WARN_ON_SLOWPATH
#define __WARN()		warn_slowpath_null(__FILE__, __LINE__)
#define __WARN_printf(arg...)	warn_slowpath_fmt(__FILE__, __LINE__, arg)
#define __WARN_printf_taint(taint, arg...)				\
	warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg)
#else
#define __WARN()		__WARN_TAINT(TAINT_WARN)
#define __WARN_printf(arg...)	do { printk(arg); __WARN(); } while (0)
#define __WARN_printf_taint(taint, arg...)				\
	do { printk(arg); __WARN_TAINT(taint); } while (0)
#endif

/* used internally by panic.c */
struct warn_args;

void __warn(const char *file, int line, void *caller, unsigned taint,
	    struct pt_regs *regs, struct warn_args *args);

#ifndef WARN_ON
#define WARN_ON(condition) ({						\
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN();						\
	unlikely(__ret_warn_on);					\
})
#endif

#ifndef WARN
#define WARN(condition, format...) ({					\
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN_printf(format);					\
	unlikely(__ret_warn_on);					\
})
#endif

#define WARN_TAINT(condition, taint, format...) ({			\
	int __ret_warn_on = !!(condition);				\
	if (unlikely(__ret_warn_on))					\
		__WARN_printf_taint(taint, format);			\
	unlikely(__ret_warn_on);					\
})

#ifndef WARN_ON_ONCE
#define WARN_ON_ONCE(condition)	({				\
	static bool __section(.data.unlikely) __warned;		\
	int __ret_warn_once = !!(condition);			\
								\
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_ON(1);					\
	}							\
	unlikely(__ret_warn_once);				\
})
#endif

#define WARN_ONCE(condition, format...)	({			\
	static bool __section(.data.unlikely) __warned;		\
	int __ret_warn_once = !!(condition);			\
								\
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN(1, format);				\
	}							\
	unlikely(__ret_warn_once);				\
})

#define WARN_TAINT_ONCE(condition, taint, format...)	({	\
	static bool __section(.data.unlikely) __warned;		\
	int __ret_warn_once = !!(condition);			\
								\
	if (unlikely(__ret_warn_once && !__warned)) {		\
		__warned = true;				\
		WARN_TAINT(1, taint, format);			\
	}							\
	unlikely(__ret_warn_once);				\
})

#else /* !CONFIG_BUG */
#ifndef HAVE_ARCH_BUG
#define BUG() do {} while (1)
#endif

#ifndef HAVE_ARCH_BUG_ON
#define BUG_ON(condition) do { if (condition) BUG(); } while (0)
#endif

#ifndef HAVE_ARCH_WARN_ON
#define WARN_ON(condition) ({						\
	int __ret_warn_on = !!(condition);				\
	unlikely(__ret_warn_on);					\
})
#endif

#ifndef WARN
#define WARN(condition, format...) ({					\
	int __ret_warn_on = !!(condition);				\
	no_printk(format);						\
	unlikely(__ret_warn_on);					\
})
#endif

#define WARN_ON_ONCE(condition) WARN_ON(condition)
#define WARN_ONCE(condition, format...) WARN(condition, format)
#define WARN_TAINT(condition, taint, format...) WARN(condition, format)
#define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format)

#endif

/*
 * WARN_ON_SMP() is for cases that the warning is either
 * meaningless for !SMP or may even cause failures.
 * This is usually used for cases that we have
 * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked()
 * returns 0 for uniprocessor settings.
 * It can also be used with values that are only defined
 * on SMP:
 *
 * struct foo {
 *  [...]
 * #ifdef CONFIG_SMP
 *	int bar;
 * #endif
 * };
 *
 * void func(struct foo *zoot)
 * {
 *	WARN_ON_SMP(!zoot->bar);
 *
 * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(),
 * and should be a nop and return false for uniprocessor.
 *
 * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set
 * and x is true.
 */
#ifdef CONFIG_SMP
# define WARN_ON_SMP(x)			WARN_ON(x)
#else
/*
 * Use of ({0;}) because WARN_ON_SMP(x) may be used either as
 * a stand alone line statement or as a condition in an if ()
 * statement.
 * A simple "0" would cause gcc to give a "statement has no effect"
 * warning.
 */
# define WARN_ON_SMP(x)			({0;})
#endif

#endif /* __ASSEMBLY__ */

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