kasan.h 7.07 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2
3
4
5
6
7
8
#ifndef _LINUX_KASAN_H
#define _LINUX_KASAN_H

#include <linux/types.h>

struct kmem_cache;
struct page;
9
struct vm_struct;
10
struct task_struct;
11
12
13
14

#ifdef CONFIG_KASAN

#include <asm/kasan.h>
15
#include <linux/pgtable.h>
16

17
18
19
20
21
extern unsigned char kasan_early_shadow_page[PAGE_SIZE];
extern pte_t kasan_early_shadow_pte[PTRS_PER_PTE];
extern pmd_t kasan_early_shadow_pmd[PTRS_PER_PMD];
extern pud_t kasan_early_shadow_pud[PTRS_PER_PUD];
extern p4d_t kasan_early_shadow_p4d[MAX_PTRS_PER_P4D];
22

23
int kasan_populate_early_shadow(const void *shadow_start,
24
25
				const void *shadow_end);

26
27
28
29
30
31
32
static inline void *kasan_mem_to_shadow(const void *addr)
{
	return (void *)((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT)
		+ KASAN_SHADOW_OFFSET;
}

/* Enable reporting bugs after kasan_disable_current() */
33
extern void kasan_enable_current(void);
34
35

/* Disable reporting bugs for current task */
36
extern void kasan_disable_current(void);
37
38
39

void kasan_unpoison_shadow(const void *address, size_t size);

40
void kasan_unpoison_task_stack(struct task_struct *task);
41
void kasan_unpoison_stack_above_sp_to(const void *watermark);
42

43
44
45
void kasan_alloc_pages(struct page *page, unsigned int order);
void kasan_free_pages(struct page *page, unsigned int order);

46
void kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
47
			slab_flags_t *flags);
Alexander Potapenko's avatar
Alexander Potapenko committed
48

49
50
51
void kasan_poison_slab(struct page *page);
void kasan_unpoison_object_data(struct kmem_cache *cache, void *object);
void kasan_poison_object_data(struct kmem_cache *cache, void *object);
52
53
void * __must_check kasan_init_slab_obj(struct kmem_cache *cache,
					const void *object);
54

55
56
void * __must_check kasan_kmalloc_large(const void *ptr, size_t size,
						gfp_t flags);
57
void kasan_kfree_large(void *ptr, unsigned long ip);
58
void kasan_poison_kfree(void *ptr, unsigned long ip);
59
60
61
62
void * __must_check kasan_kmalloc(struct kmem_cache *s, const void *object,
					size_t size, gfp_t flags);
void * __must_check kasan_krealloc(const void *object, size_t new_size,
					gfp_t flags);
63

64
65
void * __must_check kasan_slab_alloc(struct kmem_cache *s, void *object,
					gfp_t flags);
66
bool kasan_slab_free(struct kmem_cache *s, void *object, unsigned long ip);
67

Alexander Potapenko's avatar
Alexander Potapenko committed
68
69
70
71
72
struct kasan_cache {
	int alloc_meta_offset;
	int free_meta_offset;
};

73
74
75
76
77
78
/*
 * These functions provide a special case to support backing module
 * allocations with real shadow memory. With KASAN vmalloc, the special
 * case is unnecessary, as the work is handled in the generic case.
 */
#ifndef CONFIG_KASAN_VMALLOC
79
int kasan_module_alloc(void *addr, size_t size);
80
void kasan_free_shadow(const struct vm_struct *vm);
81
82
83
84
#else
static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
static inline void kasan_free_shadow(const struct vm_struct *vm) {}
#endif
85

86
87
88
int kasan_add_zero_shadow(void *start, unsigned long size);
void kasan_remove_zero_shadow(void *start, unsigned long size);

89
90
91
92
93
size_t __ksize(const void *);
static inline void kasan_unpoison_slab(const void *ptr)
{
	kasan_unpoison_shadow(ptr, __ksize(ptr));
}
94
size_t kasan_metadata_size(struct kmem_cache *cache);
95

96
97
98
bool kasan_save_enable_multi_shot(void);
void kasan_restore_multi_shot(bool enabled);

99
100
101
102
#else /* CONFIG_KASAN */

static inline void kasan_unpoison_shadow(const void *address, size_t size) {}

103
static inline void kasan_unpoison_task_stack(struct task_struct *task) {}
104
static inline void kasan_unpoison_stack_above_sp_to(const void *watermark) {}
105

106
107
108
static inline void kasan_enable_current(void) {}
static inline void kasan_disable_current(void) {}

109
110
111
static inline void kasan_alloc_pages(struct page *page, unsigned int order) {}
static inline void kasan_free_pages(struct page *page, unsigned int order) {}

Alexander Potapenko's avatar
Alexander Potapenko committed
112
static inline void kasan_cache_create(struct kmem_cache *cache,
113
				      unsigned int *size,
114
				      slab_flags_t *flags) {}
Alexander Potapenko's avatar
Alexander Potapenko committed
115

116
117
118
119
120
static inline void kasan_poison_slab(struct page *page) {}
static inline void kasan_unpoison_object_data(struct kmem_cache *cache,
					void *object) {}
static inline void kasan_poison_object_data(struct kmem_cache *cache,
					void *object) {}
121
122
123
124
125
static inline void *kasan_init_slab_obj(struct kmem_cache *cache,
				const void *object)
{
	return (void *)object;
}
126

127
128
129
130
static inline void *kasan_kmalloc_large(void *ptr, size_t size, gfp_t flags)
{
	return ptr;
}
131
static inline void kasan_kfree_large(void *ptr, unsigned long ip) {}
132
static inline void kasan_poison_kfree(void *ptr, unsigned long ip) {}
133
134
135
136
137
138
139
140
141
142
static inline void *kasan_kmalloc(struct kmem_cache *s, const void *object,
				size_t size, gfp_t flags)
{
	return (void *)object;
}
static inline void *kasan_krealloc(const void *object, size_t new_size,
				 gfp_t flags)
{
	return (void *)object;
}
143

144
145
146
147
148
static inline void *kasan_slab_alloc(struct kmem_cache *s, void *object,
				   gfp_t flags)
{
	return object;
}
149
150
static inline bool kasan_slab_free(struct kmem_cache *s, void *object,
				   unsigned long ip)
151
152
153
{
	return false;
}
154

155
static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
156
static inline void kasan_free_shadow(const struct vm_struct *vm) {}
157

158
159
160
161
162
163
164
165
static inline int kasan_add_zero_shadow(void *start, unsigned long size)
{
	return 0;
}
static inline void kasan_remove_zero_shadow(void *start,
					unsigned long size)
{}

166
static inline void kasan_unpoison_slab(const void *ptr) { }
167
static inline size_t kasan_metadata_size(struct kmem_cache *cache) { return 0; }
168

169
170
#endif /* CONFIG_KASAN */

171
172
#ifdef CONFIG_KASAN_GENERIC

173
174
#define KASAN_SHADOW_INIT 0

175
176
177
178
179
180
181
182
183
184
void kasan_cache_shrink(struct kmem_cache *cache);
void kasan_cache_shutdown(struct kmem_cache *cache);

#else /* CONFIG_KASAN_GENERIC */

static inline void kasan_cache_shrink(struct kmem_cache *cache) {}
static inline void kasan_cache_shutdown(struct kmem_cache *cache) {}

#endif /* CONFIG_KASAN_GENERIC */

185
186
187
188
#ifdef CONFIG_KASAN_SW_TAGS

#define KASAN_SHADOW_INIT 0xFF

189
190
191
192
void kasan_init_tags(void);

void *kasan_reset_tag(const void *addr);

193
bool kasan_report(unsigned long addr, size_t size,
194
195
		bool is_write, unsigned long ip);

196
197
198
199
200
201
202
203
204
#else /* CONFIG_KASAN_SW_TAGS */

static inline void kasan_init_tags(void) { }

static inline void *kasan_reset_tag(const void *addr)
{
	return (void *)addr;
}

205
206
#endif /* CONFIG_KASAN_SW_TAGS */

207
#ifdef CONFIG_KASAN_VMALLOC
208
209
210
int kasan_populate_vmalloc(unsigned long addr, unsigned long size);
void kasan_poison_vmalloc(const void *start, unsigned long size);
void kasan_unpoison_vmalloc(const void *start, unsigned long size);
211
212
213
214
void kasan_release_vmalloc(unsigned long start, unsigned long end,
			   unsigned long free_region_start,
			   unsigned long free_region_end);
#else
215
216
static inline int kasan_populate_vmalloc(unsigned long start,
					unsigned long size)
217
218
219
220
{
	return 0;
}

221
222
223
224
static inline void kasan_poison_vmalloc(const void *start, unsigned long size)
{ }
static inline void kasan_unpoison_vmalloc(const void *start, unsigned long size)
{ }
225
226
227
228
229
230
static inline void kasan_release_vmalloc(unsigned long start,
					 unsigned long end,
					 unsigned long free_region_start,
					 unsigned long free_region_end) {}
#endif

231
232
233
234
235
236
#ifdef CONFIG_KASAN_INLINE
void kasan_non_canonical_hook(unsigned long addr);
#else /* CONFIG_KASAN_INLINE */
static inline void kasan_non_canonical_hook(unsigned long addr) { }
#endif /* CONFIG_KASAN_INLINE */

237
#endif /* LINUX_KASAN_H */