Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_KASAN_H
3#define _LINUX_KASAN_H
4
5#include <linux/types.h>
6
7struct kmem_cache;
8struct page;
9struct vm_struct;
10struct task_struct;
11
12#ifdef CONFIG_KASAN
13
14#include <linux/pgtable.h>
15#include <asm/kasan.h>
16
17extern unsigned char kasan_early_shadow_page[PAGE_SIZE];
18extern pte_t kasan_early_shadow_pte[PTRS_PER_PTE];
19extern pmd_t kasan_early_shadow_pmd[PTRS_PER_PMD];
20extern pud_t kasan_early_shadow_pud[PTRS_PER_PUD];
21extern p4d_t kasan_early_shadow_p4d[MAX_PTRS_PER_P4D];
22
23int kasan_populate_early_shadow(const void *shadow_start,
24 const void *shadow_end);
25
26static inline void *kasan_mem_to_shadow(const void *addr)
27{
28 return (void *)((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT)
29 + KASAN_SHADOW_OFFSET;
30}
31
32/* Enable reporting bugs after kasan_disable_current() */
33extern void kasan_enable_current(void);
34
35/* Disable reporting bugs for current task */
36extern void kasan_disable_current(void);
37
38void kasan_unpoison_shadow(const void *address, size_t size);
39
40void kasan_unpoison_task_stack(struct task_struct *task);
41
42void kasan_alloc_pages(struct page *page, unsigned int order);
43void kasan_free_pages(struct page *page, unsigned int order);
44
45void kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
46 slab_flags_t *flags);
47
48void kasan_poison_slab(struct page *page);
49void kasan_unpoison_object_data(struct kmem_cache *cache, void *object);
50void kasan_poison_object_data(struct kmem_cache *cache, void *object);
51void * __must_check kasan_init_slab_obj(struct kmem_cache *cache,
52 const void *object);
53
54void * __must_check kasan_kmalloc_large(const void *ptr, size_t size,
55 gfp_t flags);
56void kasan_kfree_large(void *ptr, unsigned long ip);
57void kasan_poison_kfree(void *ptr, unsigned long ip);
58void * __must_check kasan_kmalloc(struct kmem_cache *s, const void *object,
59 size_t size, gfp_t flags);
60void * __must_check kasan_krealloc(const void *object, size_t new_size,
61 gfp_t flags);
62
63void * __must_check kasan_slab_alloc(struct kmem_cache *s, void *object,
64 gfp_t flags);
65bool kasan_slab_free(struct kmem_cache *s, void *object, unsigned long ip);
66
67struct kasan_cache {
68 int alloc_meta_offset;
69 int free_meta_offset;
70};
71
72/*
73 * These functions provide a special case to support backing module
74 * allocations with real shadow memory. With KASAN vmalloc, the special
75 * case is unnecessary, as the work is handled in the generic case.
76 */
77#ifndef CONFIG_KASAN_VMALLOC
78int kasan_module_alloc(void *addr, size_t size);
79void kasan_free_shadow(const struct vm_struct *vm);
80#else
81static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
82static inline void kasan_free_shadow(const struct vm_struct *vm) {}
83#endif
84
85int kasan_add_zero_shadow(void *start, unsigned long size);
86void kasan_remove_zero_shadow(void *start, unsigned long size);
87
88size_t __ksize(const void *);
89static inline void kasan_unpoison_slab(const void *ptr)
90{
91 kasan_unpoison_shadow(ptr, __ksize(ptr));
92}
93size_t kasan_metadata_size(struct kmem_cache *cache);
94
95bool kasan_save_enable_multi_shot(void);
96void kasan_restore_multi_shot(bool enabled);
97
98#else /* CONFIG_KASAN */
99
100static inline void kasan_unpoison_shadow(const void *address, size_t size) {}
101
102static inline void kasan_unpoison_task_stack(struct task_struct *task) {}
103
104static inline void kasan_enable_current(void) {}
105static inline void kasan_disable_current(void) {}
106
107static inline void kasan_alloc_pages(struct page *page, unsigned int order) {}
108static inline void kasan_free_pages(struct page *page, unsigned int order) {}
109
110static inline void kasan_cache_create(struct kmem_cache *cache,
111 unsigned int *size,
112 slab_flags_t *flags) {}
113
114static inline void kasan_poison_slab(struct page *page) {}
115static inline void kasan_unpoison_object_data(struct kmem_cache *cache,
116 void *object) {}
117static inline void kasan_poison_object_data(struct kmem_cache *cache,
118 void *object) {}
119static inline void *kasan_init_slab_obj(struct kmem_cache *cache,
120 const void *object)
121{
122 return (void *)object;
123}
124
125static inline void *kasan_kmalloc_large(void *ptr, size_t size, gfp_t flags)
126{
127 return ptr;
128}
129static inline void kasan_kfree_large(void *ptr, unsigned long ip) {}
130static inline void kasan_poison_kfree(void *ptr, unsigned long ip) {}
131static inline void *kasan_kmalloc(struct kmem_cache *s, const void *object,
132 size_t size, gfp_t flags)
133{
134 return (void *)object;
135}
136static inline void *kasan_krealloc(const void *object, size_t new_size,
137 gfp_t flags)
138{
139 return (void *)object;
140}
141
142static inline void *kasan_slab_alloc(struct kmem_cache *s, void *object,
143 gfp_t flags)
144{
145 return object;
146}
147static inline bool kasan_slab_free(struct kmem_cache *s, void *object,
148 unsigned long ip)
149{
150 return false;
151}
152
153static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
154static inline void kasan_free_shadow(const struct vm_struct *vm) {}
155
156static inline int kasan_add_zero_shadow(void *start, unsigned long size)
157{
158 return 0;
159}
160static inline void kasan_remove_zero_shadow(void *start,
161 unsigned long size)
162{}
163
164static inline void kasan_unpoison_slab(const void *ptr) { }
165static inline size_t kasan_metadata_size(struct kmem_cache *cache) { return 0; }
166
167#endif /* CONFIG_KASAN */
168
169#ifdef CONFIG_KASAN_GENERIC
170
171#define KASAN_SHADOW_INIT 0
172
173void kasan_cache_shrink(struct kmem_cache *cache);
174void kasan_cache_shutdown(struct kmem_cache *cache);
175void kasan_record_aux_stack(void *ptr);
176
177#else /* CONFIG_KASAN_GENERIC */
178
179static inline void kasan_cache_shrink(struct kmem_cache *cache) {}
180static inline void kasan_cache_shutdown(struct kmem_cache *cache) {}
181static inline void kasan_record_aux_stack(void *ptr) {}
182
183#endif /* CONFIG_KASAN_GENERIC */
184
185#ifdef CONFIG_KASAN_SW_TAGS
186
187#define KASAN_SHADOW_INIT 0xFF
188
189void kasan_init_tags(void);
190
191void *kasan_reset_tag(const void *addr);
192
193bool kasan_report(unsigned long addr, size_t size,
194 bool is_write, unsigned long ip);
195
196#else /* CONFIG_KASAN_SW_TAGS */
197
198static inline void kasan_init_tags(void) { }
199
200static inline void *kasan_reset_tag(const void *addr)
201{
202 return (void *)addr;
203}
204
205#endif /* CONFIG_KASAN_SW_TAGS */
206
207#ifdef CONFIG_KASAN_VMALLOC
208int kasan_populate_vmalloc(unsigned long addr, unsigned long size);
209void kasan_poison_vmalloc(const void *start, unsigned long size);
210void kasan_unpoison_vmalloc(const void *start, unsigned long size);
211void kasan_release_vmalloc(unsigned long start, unsigned long end,
212 unsigned long free_region_start,
213 unsigned long free_region_end);
214#else
215static inline int kasan_populate_vmalloc(unsigned long start,
216 unsigned long size)
217{
218 return 0;
219}
220
221static inline void kasan_poison_vmalloc(const void *start, unsigned long size)
222{ }
223static inline void kasan_unpoison_vmalloc(const void *start, unsigned long size)
224{ }
225static inline void kasan_release_vmalloc(unsigned long start,
226 unsigned long end,
227 unsigned long free_region_start,
228 unsigned long free_region_end) {}
229#endif
230
231#ifdef CONFIG_KASAN_INLINE
232void kasan_non_canonical_hook(unsigned long addr);
233#else /* CONFIG_KASAN_INLINE */
234static inline void kasan_non_canonical_hook(unsigned long addr) { }
235#endif /* CONFIG_KASAN_INLINE */
236
237#endif /* LINUX_KASAN_H */