1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __MM_KASAN_KASAN_H
3 #define __MM_KASAN_KASAN_H
5 #include <linux/kasan.h>
6 #include <linux/stackdepot.h>
8 #define KASAN_SHADOW_SCALE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
9 #define KASAN_SHADOW_MASK (KASAN_SHADOW_SCALE_SIZE - 1)
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 */
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) */
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
27 #define KASAN_GLOBAL_REDZONE 0xFA /* redzone for global variable */
30 * Stack redzone shadow values
31 * (Those are compiler's ABI, don't change them)
33 #define KASAN_STACK_LEFT 0xF1
34 #define KASAN_STACK_MID 0xF2
35 #define KASAN_STACK_RIGHT 0xF3
36 #define KASAN_STACK_PARTIAL 0xF4
39 * alloca redzone shadow values
41 #define KASAN_ALLOCA_LEFT 0xCA
42 #define KASAN_ALLOCA_RIGHT 0xCB
44 #define KASAN_ALLOCA_REDZONE_SIZE 32
47 * Stack frame marker (compiler ABI).
49 #define KASAN_CURRENT_STACK_FRAME_MAGIC 0x41B58AB3
51 /* Don't break randconfig/all*config builds */
52 #ifndef KASAN_ABI_VERSION
53 #define KASAN_ABI_VERSION 1
56 struct kasan_access_info {
57 const void *access_addr;
58 const void *first_bad_addr;
64 /* The layout of struct dictated by compiler */
65 struct kasan_source_location {
71 /* The layout of struct dictated by compiler */
73 const void *beg; /* Address of the beginning of the global variable. */
74 size_t size; /* Size of the global variable. */
75 size_t size_with_redzone; /* Size of the variable + size of the red zone. 32 bytes aligned */
77 const void *module_name; /* Name of the module where the global variable is declared. */
78 unsigned long has_dynamic_init; /* This needed for C++ */
79 #if KASAN_ABI_VERSION >= 4
80 struct kasan_source_location *location;
82 #if KASAN_ABI_VERSION >= 5
88 * Structures to keep alloc and free tracks *
91 #define KASAN_STACK_DEPTH 64
95 depot_stack_handle_t stack;
98 struct kasan_alloc_meta {
99 struct kasan_track alloc_track;
100 struct kasan_track free_track;
104 struct qlist_node *next;
106 struct kasan_free_meta {
107 /* This field is used while the object is in the quarantine.
108 * Otherwise it might be used for the allocator freelist.
110 struct qlist_node quarantine_link;
113 struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
115 struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
118 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
120 return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
121 << KASAN_SHADOW_SCALE_SHIFT);
124 static inline bool addr_has_shadow(const void *addr)
126 return (addr >= kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
129 void kasan_poison_shadow(const void *address, size_t size, u8 value);
132 * check_memory_region - Check memory region, and report if invalid access.
133 * @addr: the accessed address
134 * @size: the accessed size
135 * @write: true if access is a write access
136 * @ret_ip: return address
137 * @return: true if access was valid, false if invalid
139 bool check_memory_region(unsigned long addr, size_t size, bool write,
140 unsigned long ret_ip);
142 void *find_first_bad_addr(void *addr, size_t size);
143 const char *get_bug_type(struct kasan_access_info *info);
145 void kasan_report(unsigned long addr, size_t size,
146 bool is_write, unsigned long ip);
147 void kasan_report_invalid_free(void *object, unsigned long ip);
149 #if defined(CONFIG_KASAN_GENERIC) && \
150 (defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
151 void quarantine_put(struct kasan_free_meta *info, struct kmem_cache *cache);
152 void quarantine_reduce(void);
153 void quarantine_remove_cache(struct kmem_cache *cache);
155 static inline void quarantine_put(struct kasan_free_meta *info,
156 struct kmem_cache *cache) { }
157 static inline void quarantine_reduce(void) { }
158 static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
161 #ifdef CONFIG_KASAN_SW_TAGS
163 void print_tags(u8 addr_tag, const void *addr);
169 static inline void print_tags(u8 addr_tag, const void *addr) { }
171 static inline u8 random_tag(void)
178 #ifndef arch_kasan_set_tag
179 static inline const void *arch_kasan_set_tag(const void *addr, u8 tag)
184 #ifndef arch_kasan_reset_tag
185 #define arch_kasan_reset_tag(addr) ((void *)(addr))
187 #ifndef arch_kasan_get_tag
188 #define arch_kasan_get_tag(addr) 0
191 #define set_tag(addr, tag) ((void *)arch_kasan_set_tag((addr), (tag)))
192 #define reset_tag(addr) ((void *)arch_kasan_reset_tag(addr))
193 #define get_tag(addr) arch_kasan_get_tag(addr)
196 * Exported functions for interfaces called from assembly or from generated
197 * code. Declarations here to avoid warning about missing declarations.
199 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
200 void __asan_register_globals(struct kasan_global *globals, size_t size);
201 void __asan_unregister_globals(struct kasan_global *globals, size_t size);
202 void __asan_loadN(unsigned long addr, size_t size);
203 void __asan_storeN(unsigned long addr, size_t size);
204 void __asan_handle_no_return(void);
205 void __asan_alloca_poison(unsigned long addr, size_t size);
206 void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);
208 void __asan_load1(unsigned long addr);
209 void __asan_store1(unsigned long addr);
210 void __asan_load2(unsigned long addr);
211 void __asan_store2(unsigned long addr);
212 void __asan_load4(unsigned long addr);
213 void __asan_store4(unsigned long addr);
214 void __asan_load8(unsigned long addr);
215 void __asan_store8(unsigned long addr);
216 void __asan_load16(unsigned long addr);
217 void __asan_store16(unsigned long addr);
219 void __asan_load1_noabort(unsigned long addr);
220 void __asan_store1_noabort(unsigned long addr);
221 void __asan_load2_noabort(unsigned long addr);
222 void __asan_store2_noabort(unsigned long addr);
223 void __asan_load4_noabort(unsigned long addr);
224 void __asan_store4_noabort(unsigned long addr);
225 void __asan_load8_noabort(unsigned long addr);
226 void __asan_store8_noabort(unsigned long addr);
227 void __asan_load16_noabort(unsigned long addr);
228 void __asan_store16_noabort(unsigned long addr);
230 void __asan_set_shadow_00(const void *addr, size_t size);
231 void __asan_set_shadow_f1(const void *addr, size_t size);
232 void __asan_set_shadow_f2(const void *addr, size_t size);
233 void __asan_set_shadow_f3(const void *addr, size_t size);
234 void __asan_set_shadow_f5(const void *addr, size_t size);
235 void __asan_set_shadow_f8(const void *addr, size_t size);