1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef LINUX_MM_DEBUG_H
3 #define LINUX_MM_DEBUG_H 1
4 
5 #include <linux/bug.h>
6 #include <linux/stringify.h>
7 
8 struct page;
9 struct vm_area_struct;
10 struct mm_struct;
11 
12 void dump_page(struct page *page, const char *reason);
13 void dump_vma(const struct vm_area_struct *vma);
14 void dump_mm(const struct mm_struct *mm);
15 
16 #ifdef CONFIG_DEBUG_VM
17 #define VM_BUG_ON(cond) BUG_ON(cond)
18 #define VM_BUG_ON_PAGE(cond, page)					\
19 	do {								\
20 		if (unlikely(cond)) {					\
21 			dump_page(page, "VM_BUG_ON_PAGE(" __stringify(cond)")");\
22 			BUG();						\
23 		}							\
24 	} while (0)
25 #define VM_BUG_ON_FOLIO(cond, folio)					\
26 	do {								\
27 		if (unlikely(cond)) {					\
28 			dump_page(&folio->page, "VM_BUG_ON_FOLIO(" __stringify(cond)")");\
29 			BUG();						\
30 		}							\
31 	} while (0)
32 #define VM_BUG_ON_VMA(cond, vma)					\
33 	do {								\
34 		if (unlikely(cond)) {					\
35 			dump_vma(vma);					\
36 			BUG();						\
37 		}							\
38 	} while (0)
39 #define VM_BUG_ON_MM(cond, mm)						\
40 	do {								\
41 		if (unlikely(cond)) {					\
42 			dump_mm(mm);					\
43 			BUG();						\
44 		}							\
45 	} while (0)
46 #define VM_WARN_ON_ONCE_PAGE(cond, page)	({			\
47 	static bool __section(".data.once") __warned;			\
48 	int __ret_warn_once = !!(cond);					\
49 									\
50 	if (unlikely(__ret_warn_once && !__warned)) {			\
51 		dump_page(page, "VM_WARN_ON_ONCE_PAGE(" __stringify(cond)")");\
52 		__warned = true;					\
53 		WARN_ON(1);						\
54 	}								\
55 	unlikely(__ret_warn_once);					\
56 })
57 #define VM_WARN_ON_FOLIO(cond, folio)		({			\
58 	int __ret_warn = !!(cond);					\
59 									\
60 	if (unlikely(__ret_warn)) {					\
61 		dump_page(&folio->page, "VM_WARN_ON_FOLIO(" __stringify(cond)")");\
62 		WARN_ON(1);						\
63 	}								\
64 	unlikely(__ret_warn);						\
65 })
66 #define VM_WARN_ON_ONCE_FOLIO(cond, folio)	({			\
67 	static bool __section(".data.once") __warned;			\
68 	int __ret_warn_once = !!(cond);					\
69 									\
70 	if (unlikely(__ret_warn_once && !__warned)) {			\
71 		dump_page(&folio->page, "VM_WARN_ON_ONCE_FOLIO(" __stringify(cond)")");\
72 		__warned = true;					\
73 		WARN_ON(1);						\
74 	}								\
75 	unlikely(__ret_warn_once);					\
76 })
77 
78 #define VM_WARN_ON(cond) (void)WARN_ON(cond)
79 #define VM_WARN_ON_ONCE(cond) (void)WARN_ON_ONCE(cond)
80 #define VM_WARN_ONCE(cond, format...) (void)WARN_ONCE(cond, format)
81 #define VM_WARN(cond, format...) (void)WARN(cond, format)
82 #else
83 #define VM_BUG_ON(cond) BUILD_BUG_ON_INVALID(cond)
84 #define VM_BUG_ON_PAGE(cond, page) VM_BUG_ON(cond)
85 #define VM_BUG_ON_FOLIO(cond, folio) VM_BUG_ON(cond)
86 #define VM_BUG_ON_VMA(cond, vma) VM_BUG_ON(cond)
87 #define VM_BUG_ON_MM(cond, mm) VM_BUG_ON(cond)
88 #define VM_WARN_ON(cond) BUILD_BUG_ON_INVALID(cond)
89 #define VM_WARN_ON_ONCE(cond) BUILD_BUG_ON_INVALID(cond)
90 #define VM_WARN_ON_ONCE_PAGE(cond, page)  BUILD_BUG_ON_INVALID(cond)
91 #define VM_WARN_ON_FOLIO(cond, folio)  BUILD_BUG_ON_INVALID(cond)
92 #define VM_WARN_ON_ONCE_FOLIO(cond, folio)  BUILD_BUG_ON_INVALID(cond)
93 #define VM_WARN_ONCE(cond, format...) BUILD_BUG_ON_INVALID(cond)
94 #define VM_WARN(cond, format...) BUILD_BUG_ON_INVALID(cond)
95 #endif
96 
97 #ifdef CONFIG_DEBUG_VM_IRQSOFF
98 #define VM_WARN_ON_IRQS_ENABLED() WARN_ON_ONCE(!irqs_disabled())
99 #else
100 #define VM_WARN_ON_IRQS_ENABLED() do { } while (0)
101 #endif
102 
103 #ifdef CONFIG_DEBUG_VIRTUAL
104 #define VIRTUAL_BUG_ON(cond) BUG_ON(cond)
105 #else
106 #define VIRTUAL_BUG_ON(cond) do { } while (0)
107 #endif
108 
109 #ifdef CONFIG_DEBUG_VM_PGFLAGS
110 #define VM_BUG_ON_PGFLAGS(cond, page) VM_BUG_ON_PAGE(cond, page)
111 #else
112 #define VM_BUG_ON_PGFLAGS(cond, page) BUILD_BUG_ON_INVALID(cond)
113 #endif
114 
115 #endif
116