Merge branch 'akpm' (patches from Andrew)
[muen/linux.git] / mm / kasan / kasan.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __MM_KASAN_KASAN_H
3 #define __MM_KASAN_KASAN_H
4
5 #include <linux/kasan.h>
6 #include <linux/stackdepot.h>
7
8 #define KASAN_SHADOW_SCALE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
9 #define KASAN_SHADOW_MASK       (KASAN_SHADOW_SCALE_SIZE - 1)
10
11 #define KASAN_TAG_KERNEL        0xFF /* native kernel pointers tag */
12 #define KASAN_TAG_INVALID       0xFE /* inaccessible memory tag */
13 #define KASAN_TAG_MAX           0xFD /* maximum value for random tags */
14
15 #ifdef CONFIG_KASAN_GENERIC
16 #define KASAN_FREE_PAGE         0xFF  /* page was freed */
17 #define KASAN_PAGE_REDZONE      0xFE  /* redzone for kmalloc_large allocations */
18 #define KASAN_KMALLOC_REDZONE   0xFC  /* redzone inside slub object */
19 #define KASAN_KMALLOC_FREE      0xFB  /* object was freed (kmem_cache_free/kfree) */
20 #else
21 #define KASAN_FREE_PAGE         KASAN_TAG_INVALID
22 #define KASAN_PAGE_REDZONE      KASAN_TAG_INVALID
23 #define KASAN_KMALLOC_REDZONE   KASAN_TAG_INVALID
24 #define KASAN_KMALLOC_FREE      KASAN_TAG_INVALID
25 #endif
26
27 #define KASAN_GLOBAL_REDZONE    0xFA  /* redzone for global variable */
28
29 /*
30  * Stack redzone shadow values
31  * (Those are compiler's ABI, don't change them)
32  */
33 #define KASAN_STACK_LEFT        0xF1
34 #define KASAN_STACK_MID         0xF2
35 #define KASAN_STACK_RIGHT       0xF3
36 #define KASAN_STACK_PARTIAL     0xF4
37
38 /*
39  * alloca redzone shadow values
40  */
41 #define KASAN_ALLOCA_LEFT       0xCA
42 #define KASAN_ALLOCA_RIGHT      0xCB
43
44 #define KASAN_ALLOCA_REDZONE_SIZE       32
45
46 /* Don't break randconfig/all*config builds */
47 #ifndef KASAN_ABI_VERSION
48 #define KASAN_ABI_VERSION 1
49 #endif
50
51 struct kasan_access_info {
52         const void *access_addr;
53         const void *first_bad_addr;
54         size_t access_size;
55         bool is_write;
56         unsigned long ip;
57 };
58
59 /* The layout of struct dictated by compiler */
60 struct kasan_source_location {
61         const char *filename;
62         int line_no;
63         int column_no;
64 };
65
66 /* The layout of struct dictated by compiler */
67 struct kasan_global {
68         const void *beg;                /* Address of the beginning of the global variable. */
69         size_t size;                    /* Size of the global variable. */
70         size_t size_with_redzone;       /* Size of the variable + size of the red zone. 32 bytes aligned */
71         const void *name;
72         const void *module_name;        /* Name of the module where the global variable is declared. */
73         unsigned long has_dynamic_init; /* This needed for C++ */
74 #if KASAN_ABI_VERSION >= 4
75         struct kasan_source_location *location;
76 #endif
77 #if KASAN_ABI_VERSION >= 5
78         char *odr_indicator;
79 #endif
80 };
81
82 /**
83  * Structures to keep alloc and free tracks *
84  */
85
86 #define KASAN_STACK_DEPTH 64
87
88 struct kasan_track {
89         u32 pid;
90         depot_stack_handle_t stack;
91 };
92
93 struct kasan_alloc_meta {
94         struct kasan_track alloc_track;
95         struct kasan_track free_track;
96 };
97
98 struct qlist_node {
99         struct qlist_node *next;
100 };
101 struct kasan_free_meta {
102         /* This field is used while the object is in the quarantine.
103          * Otherwise it might be used for the allocator freelist.
104          */
105         struct qlist_node quarantine_link;
106 };
107
108 struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
109                                         const void *object);
110 struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
111                                         const void *object);
112
113 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
114 {
115         return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
116                 << KASAN_SHADOW_SCALE_SHIFT);
117 }
118
119 static inline bool addr_has_shadow(const void *addr)
120 {
121         return (addr >= kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
122 }
123
124 void kasan_poison_shadow(const void *address, size_t size, u8 value);
125
126 void check_memory_region(unsigned long addr, size_t size, bool write,
127                                 unsigned long ret_ip);
128
129 void *find_first_bad_addr(void *addr, size_t size);
130 const char *get_bug_type(struct kasan_access_info *info);
131
132 void kasan_report(unsigned long addr, size_t size,
133                 bool is_write, unsigned long ip);
134 void kasan_report_invalid_free(void *object, unsigned long ip);
135
136 #if defined(CONFIG_KASAN_GENERIC) && \
137         (defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
138 void quarantine_put(struct kasan_free_meta *info, struct kmem_cache *cache);
139 void quarantine_reduce(void);
140 void quarantine_remove_cache(struct kmem_cache *cache);
141 #else
142 static inline void quarantine_put(struct kasan_free_meta *info,
143                                 struct kmem_cache *cache) { }
144 static inline void quarantine_reduce(void) { }
145 static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
146 #endif
147
148 #ifdef CONFIG_KASAN_SW_TAGS
149
150 void print_tags(u8 addr_tag, const void *addr);
151
152 u8 random_tag(void);
153
154 #else
155
156 static inline void print_tags(u8 addr_tag, const void *addr) { }
157
158 static inline u8 random_tag(void)
159 {
160         return 0;
161 }
162
163 #endif
164
165 #ifndef arch_kasan_set_tag
166 static inline const void *arch_kasan_set_tag(const void *addr, u8 tag)
167 {
168         return addr;
169 }
170 #endif
171 #ifndef arch_kasan_reset_tag
172 #define arch_kasan_reset_tag(addr)      ((void *)(addr))
173 #endif
174 #ifndef arch_kasan_get_tag
175 #define arch_kasan_get_tag(addr)        0
176 #endif
177
178 #define set_tag(addr, tag)      ((void *)arch_kasan_set_tag((addr), (tag)))
179 #define reset_tag(addr)         ((void *)arch_kasan_reset_tag(addr))
180 #define get_tag(addr)           arch_kasan_get_tag(addr)
181
182 /*
183  * Exported functions for interfaces called from assembly or from generated
184  * code. Declarations here to avoid warning about missing declarations.
185  */
186 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
187 void __asan_register_globals(struct kasan_global *globals, size_t size);
188 void __asan_unregister_globals(struct kasan_global *globals, size_t size);
189 void __asan_loadN(unsigned long addr, size_t size);
190 void __asan_storeN(unsigned long addr, size_t size);
191 void __asan_handle_no_return(void);
192 void __asan_alloca_poison(unsigned long addr, size_t size);
193 void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);
194
195 void __asan_load1(unsigned long addr);
196 void __asan_store1(unsigned long addr);
197 void __asan_load2(unsigned long addr);
198 void __asan_store2(unsigned long addr);
199 void __asan_load4(unsigned long addr);
200 void __asan_store4(unsigned long addr);
201 void __asan_load8(unsigned long addr);
202 void __asan_store8(unsigned long addr);
203 void __asan_load16(unsigned long addr);
204 void __asan_store16(unsigned long addr);
205
206 void __asan_load1_noabort(unsigned long addr);
207 void __asan_store1_noabort(unsigned long addr);
208 void __asan_load2_noabort(unsigned long addr);
209 void __asan_store2_noabort(unsigned long addr);
210 void __asan_load4_noabort(unsigned long addr);
211 void __asan_store4_noabort(unsigned long addr);
212 void __asan_load8_noabort(unsigned long addr);
213 void __asan_store8_noabort(unsigned long addr);
214 void __asan_load16_noabort(unsigned long addr);
215 void __asan_store16_noabort(unsigned long addr);
216
217 void __asan_set_shadow_00(const void *addr, size_t size);
218 void __asan_set_shadow_f1(const void *addr, size_t size);
219 void __asan_set_shadow_f2(const void *addr, size_t size);
220 void __asan_set_shadow_f3(const void *addr, size_t size);
221 void __asan_set_shadow_f5(const void *addr, size_t size);
222 void __asan_set_shadow_f8(const void *addr, size_t size);
223
224 #endif