[linux-block.git] / include / linux / mmdebug.h

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

#include <linux/bug.h>
#include <linux/stringify.h>

struct page;
struct vm_area_struct;
struct mm_struct;
struct vma_iterator;
struct vma_merge_struct;

void dump_page(const struct page *page, const char *reason);
void dump_vma(const struct vm_area_struct *vma);
void dump_mm(const struct mm_struct *mm);
void dump_vmg(const struct vma_merge_struct *vmg, const char *reason);
void vma_iter_dump_tree(const struct vma_iterator *vmi);

#ifdef CONFIG_DEBUG_VM
#define VM_BUG_ON(cond) BUG_ON(cond)
#define VM_BUG_ON_PAGE(cond, page)					\
	do {								\
		if (unlikely(cond)) {					\
			dump_page(page, "VM_BUG_ON_PAGE(" __stringify(cond)")");\
			BUG();						\
		}							\
	} while (0)
#define VM_BUG_ON_FOLIO(cond, folio)					\
	do {								\
		if (unlikely(cond)) {					\
			dump_page(&folio->page, "VM_BUG_ON_FOLIO(" __stringify(cond)")");\
			BUG();						\
		}							\
	} while (0)
#define VM_BUG_ON_VMA(cond, vma)					\
	do {								\
		if (unlikely(cond)) {					\
			dump_vma(vma);					\
			BUG();						\
		}							\
	} while (0)
#define VM_BUG_ON_MM(cond, mm)						\
	do {								\
		if (unlikely(cond)) {					\
			dump_mm(mm);					\
			BUG();						\
		}							\
	} while (0)
#define VM_WARN_ON_ONCE_PAGE(cond, page)	({			\
	static bool __section(".data..once") __warned;			\
	int __ret_warn_once = !!(cond);					\
									\
	if (unlikely(__ret_warn_once && !__warned)) {			\
		dump_page(page, "VM_WARN_ON_ONCE_PAGE(" __stringify(cond)")");\
		__warned = true;					\
		WARN_ON(1);						\
	}								\
	unlikely(__ret_warn_once);					\
})
#define VM_WARN_ON_FOLIO(cond, folio)		({			\
	int __ret_warn = !!(cond);					\
									\
	if (unlikely(__ret_warn)) {					\
		dump_page(&folio->page, "VM_WARN_ON_FOLIO(" __stringify(cond)")");\
		WARN_ON(1);						\
	}								\
	unlikely(__ret_warn);						\
})
#define VM_WARN_ON_ONCE_FOLIO(cond, folio)	({			\
	static bool __section(".data..once") __warned;			\
	int __ret_warn_once = !!(cond);					\
									\
	if (unlikely(__ret_warn_once && !__warned)) {			\
		dump_page(&folio->page, "VM_WARN_ON_ONCE_FOLIO(" __stringify(cond)")");\
		__warned = true;					\
		WARN_ON(1);						\
	}								\
	unlikely(__ret_warn_once);					\
})
#define VM_WARN_ON_ONCE_MM(cond, mm)		({			\
	static bool __section(".data..once") __warned;			\
	int __ret_warn_once = !!(cond);					\
									\
	if (unlikely(__ret_warn_once && !__warned)) {			\
		dump_mm(mm);						\
		__warned = true;					\
		WARN_ON(1);						\
	}								\
	unlikely(__ret_warn_once);					\
})
#define VM_WARN_ON_VMG(cond, vmg)		({			\
	int __ret_warn = !!(cond);					\
									\
	if (unlikely(__ret_warn)) {					\
		dump_vmg(vmg, "VM_WARN_ON_VMG(" __stringify(cond)")");	\
		WARN_ON(1);						\
	}								\
	unlikely(__ret_warn);						\
})

#define VM_WARN_ON(cond) (void)WARN_ON(cond)
#define VM_WARN_ON_ONCE(cond) (void)WARN_ON_ONCE(cond)
#define VM_WARN_ONCE(cond, format...) (void)WARN_ONCE(cond, format)
#define VM_WARN(cond, format...) (void)WARN(cond, format)
#else
#define VM_BUG_ON(cond) BUILD_BUG_ON_INVALID(cond)
#define VM_BUG_ON_PAGE(cond, page) VM_BUG_ON(cond)
#define VM_BUG_ON_FOLIO(cond, folio) VM_BUG_ON(cond)
#define VM_BUG_ON_VMA(cond, vma) VM_BUG_ON(cond)
#define VM_BUG_ON_MM(cond, mm) VM_BUG_ON(cond)
#define VM_WARN_ON(cond) BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ON_ONCE(cond) BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ON_ONCE_PAGE(cond, page)  BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ON_FOLIO(cond, folio)  BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ON_ONCE_FOLIO(cond, folio)  BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ON_ONCE_MM(cond, mm)  BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ON_VMG(cond, vmg)  BUILD_BUG_ON_INVALID(cond)
#define VM_WARN_ONCE(cond, format...) BUILD_BUG_ON_INVALID(cond)
#define VM_WARN(cond, format...) BUILD_BUG_ON_INVALID(cond)
#endif /* CONFIG_DEBUG_VM */

#ifdef CONFIG_DEBUG_VM_IRQSOFF
#define VM_WARN_ON_IRQS_ENABLED() WARN_ON_ONCE(!irqs_disabled())
#else
#define VM_WARN_ON_IRQS_ENABLED() do { } while (0)
#endif

#ifdef CONFIG_DEBUG_VIRTUAL
#define VIRTUAL_BUG_ON(cond) BUG_ON(cond)
#else
#define VIRTUAL_BUG_ON(cond) do { } while (0)
#endif

#ifdef CONFIG_DEBUG_VM_PGFLAGS
#define VM_BUG_ON_PGFLAGS(cond, page) VM_BUG_ON_PAGE(cond, page)
#else
#define VM_BUG_ON_PGFLAGS(cond, page) BUILD_BUG_ON_INVALID(cond)
#endif

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
59ea7463 JS	2	#ifndef LINUX_MM_DEBUG_H
	3	#define LINUX_MM_DEBUG_H 1
	4
1d5cda40	5	#include <linux/bug.h>
e4f67422 DH	6	#include <linux/stringify.h>
e4f67422 DH	7
309381fe	8	struct page;
0bf55139	9	struct vm_area_struct;
31c9afa6	10	struct mm_struct;
b50e195f	11	struct vma_iterator;
b0d66d82	12	struct vma_merge_struct;
309381fe	13
b3a32033	14	void dump_page(const struct page page, const char reason);
0bf55139	15	void dump_vma(const struct vm_area_struct *vma);
31c9afa6	16	void dump_mm(const struct mm_struct *mm);
b0d66d82	17	void dump_vmg(const struct vma_merge_struct vmg, const char reason);
b50e195f	18	void vma_iter_dump_tree(const struct vma_iterator *vmi);
309381fe	19
59ea7463 JS	20	#ifdef CONFIG_DEBUG_VM
59ea7463 JS	21	#define VM_BUG_ON(cond) BUG_ON(cond)
e4f67422 DH	22	#define VM_BUG_ON_PAGE(cond, page) \
	23	do { \
	24	if (unlikely(cond)) { \
	25	dump_page(page, "VM_BUG_ON_PAGE(" __stringify(cond)")");\
	26	BUG(); \
	27	} \
	28	} while (0)
9e9edb20 MWO	29	#define VM_BUG_ON_FOLIO(cond, folio) \
	30	do { \
	31	if (unlikely(cond)) { \
	32	dump_page(&folio->page, "VM_BUG_ON_FOLIO(" __stringify(cond)")");\
	33	BUG(); \
	34	} \
	35	} while (0)
fa3759cc SL	36	#define VM_BUG_ON_VMA(cond, vma) \
	37	do { \
	38	if (unlikely(cond)) { \
	39	dump_vma(vma); \
	40	BUG(); \
	41	} \
	42	} while (0)
31c9afa6 SL	43	#define VM_BUG_ON_MM(cond, mm) \
	44	do { \
	45	if (unlikely(cond)) { \
	46	dump_mm(mm); \
	47	BUG(); \
	48	} \
	49	} while (0)
a4055888	50	#define VM_WARN_ON_ONCE_PAGE(cond, page) ({ \
dbefa1f3	51	static bool __section(".data..once") __warned; \
a4055888 AS	52	int __ret_warn_once = !!(cond); \
	53	\
	54	if (unlikely(__ret_warn_once && !__warned)) { \
	55	dump_page(page, "VM_WARN_ON_ONCE_PAGE(" __stringify(cond)")");\
	56	__warned = true; \
	57	WARN_ON(1); \
	58	} \
	59	unlikely(__ret_warn_once); \
	60	})
020bc44a JL	61	#define VM_WARN_ON_FOLIO(cond, folio) ({ \
	62	int __ret_warn = !!(cond); \
	63	\
	64	if (unlikely(__ret_warn)) { \
	65	dump_page(&folio->page, "VM_WARN_ON_FOLIO(" __stringify(cond)")");\
	66	WARN_ON(1); \
	67	} \
	68	unlikely(__ret_warn); \
	69	})
9e9edb20	70	#define VM_WARN_ON_ONCE_FOLIO(cond, folio) ({ \
dbefa1f3	71	static bool __section(".data..once") __warned; \
9e9edb20 MWO	72	int __ret_warn_once = !!(cond); \
	73	\
	74	if (unlikely(__ret_warn_once && !__warned)) { \
	75	dump_page(&folio->page, "VM_WARN_ON_ONCE_FOLIO(" __stringify(cond)")");\
	76	__warned = true; \
	77	WARN_ON(1); \
	78	} \
	79	unlikely(__ret_warn_once); \
	80	})
b50e195f	81	#define VM_WARN_ON_ONCE_MM(cond, mm) ({ \
dbefa1f3	82	static bool __section(".data..once") __warned; \
b50e195f LH	83	int __ret_warn_once = !!(cond); \
	84	\
	85	if (unlikely(__ret_warn_once && !__warned)) { \
	86	dump_mm(mm); \
	87	__warned = true; \
	88	WARN_ON(1); \
	89	} \
	90	unlikely(__ret_warn_once); \
	91	})
b0d66d82 LS	92	#define VM_WARN_ON_VMG(cond, vmg) ({ \
	93	int __ret_warn = !!(cond); \
	94	\
	95	if (unlikely(__ret_warn)) { \
	96	dump_vmg(vmg, "VM_WARN_ON_VMG(" __stringify(cond)")"); \
	97	WARN_ON(1); \
	98	} \
	99	unlikely(__ret_warn); \
	100	})
a4055888	101
91241681 MH	102	#define VM_WARN_ON(cond) (void)WARN_ON(cond)
	103	#define VM_WARN_ON_ONCE(cond) (void)WARN_ON_ONCE(cond)
	104	#define VM_WARN_ONCE(cond, format...) (void)WARN_ONCE(cond, format)
	105	#define VM_WARN(cond, format...) (void)WARN(cond, format)
59ea7463	106	#else
02602a18	107	#define VM_BUG_ON(cond) BUILD_BUG_ON_INVALID(cond)
309381fe	108	#define VM_BUG_ON_PAGE(cond, page) VM_BUG_ON(cond)
9e9edb20	109	#define VM_BUG_ON_FOLIO(cond, folio) VM_BUG_ON(cond)
fa3759cc	110	#define VM_BUG_ON_VMA(cond, vma) VM_BUG_ON(cond)
31c9afa6	111	#define VM_BUG_ON_MM(cond, mm) VM_BUG_ON(cond)
02a8efed AM	112	#define VM_WARN_ON(cond) BUILD_BUG_ON_INVALID(cond)
02a8efed AM	113	#define VM_WARN_ON_ONCE(cond) BUILD_BUG_ON_INVALID(cond)
a4055888	114	#define VM_WARN_ON_ONCE_PAGE(cond, page) BUILD_BUG_ON_INVALID(cond)
020bc44a	115	#define VM_WARN_ON_FOLIO(cond, folio) BUILD_BUG_ON_INVALID(cond)
9e9edb20	116	#define VM_WARN_ON_ONCE_FOLIO(cond, folio) BUILD_BUG_ON_INVALID(cond)
b50e195f	117	#define VM_WARN_ON_ONCE_MM(cond, mm) BUILD_BUG_ON_INVALID(cond)
b0d66d82	118	#define VM_WARN_ON_VMG(cond, vmg) BUILD_BUG_ON_INVALID(cond)
ef6b571f	119	#define VM_WARN_ONCE(cond, format...) BUILD_BUG_ON_INVALID(cond)
a54f9aeb	120	#define VM_WARN(cond, format...) BUILD_BUG_ON_INVALID(cond)
b0d66d82	121	#endif /* CONFIG_DEBUG_VM */
59ea7463	122
a738e9ba TG	123	#ifdef CONFIG_DEBUG_VM_IRQSOFF
	124	#define VM_WARN_ON_IRQS_ENABLED() WARN_ON_ONCE(!irqs_disabled())
	125	#else
	126	#define VM_WARN_ON_IRQS_ENABLED() do { } while (0)
	127	#endif
	128
59ea7463 JS	129	#ifdef CONFIG_DEBUG_VIRTUAL
	130	#define VIRTUAL_BUG_ON(cond) BUG_ON(cond)
	131	#else
7aa413de	132	#define VIRTUAL_BUG_ON(cond) do { } while (0)
59ea7463 JS	133	#endif
59ea7463 JS	134
95ad9755 KS	135	#ifdef CONFIG_DEBUG_VM_PGFLAGS
	136	#define VM_BUG_ON_PGFLAGS(cond, page) VM_BUG_ON_PAGE(cond, page)
	137	#else
	138	#define VM_BUG_ON_PGFLAGS(cond, page) BUILD_BUG_ON_INVALID(cond)
	139	#endif
	140
59ea7463	141	#endif