1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/static_key.h>
6 #include <linux/types.h>
15 #include <linux/linkage.h>
16 #include <asm/kasan.h>
18 /* kasan_data struct is used in KUnit tests for KASAN expected failures */
19 struct kunit_kasan_expectation {
26 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
28 #include <linux/pgtable.h>
30 /* Software KASAN implementations use shadow memory. */
32 #ifdef CONFIG_KASAN_SW_TAGS
33 #define KASAN_SHADOW_INIT 0xFF
35 #define KASAN_SHADOW_INIT 0
38 #ifndef PTE_HWTABLE_PTRS
39 #define PTE_HWTABLE_PTRS 0
42 extern unsigned char kasan_early_shadow_page[PAGE_SIZE];
43 extern pte_t kasan_early_shadow_pte[PTRS_PER_PTE + PTE_HWTABLE_PTRS];
44 extern pmd_t kasan_early_shadow_pmd[PTRS_PER_PMD];
45 extern pud_t kasan_early_shadow_pud[PTRS_PER_PUD];
46 extern p4d_t kasan_early_shadow_p4d[MAX_PTRS_PER_P4D];
48 int kasan_populate_early_shadow(const void *shadow_start,
49 const void *shadow_end);
51 static inline void *kasan_mem_to_shadow(const void *addr)
53 return (void *)((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT)
54 + KASAN_SHADOW_OFFSET;
57 int kasan_add_zero_shadow(void *start, unsigned long size);
58 void kasan_remove_zero_shadow(void *start, unsigned long size);
60 /* Enable reporting bugs after kasan_disable_current() */
61 extern void kasan_enable_current(void);
63 /* Disable reporting bugs for current task */
64 extern void kasan_disable_current(void);
66 #else /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */
68 static inline int kasan_add_zero_shadow(void *start, unsigned long size)
72 static inline void kasan_remove_zero_shadow(void *start,
76 static inline void kasan_enable_current(void) {}
77 static inline void kasan_disable_current(void) {}
79 #endif /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */
84 int alloc_meta_offset;
88 #ifdef CONFIG_KASAN_HW_TAGS
90 DECLARE_STATIC_KEY_FALSE(kasan_flag_enabled);
92 static __always_inline bool kasan_enabled(void)
94 return static_branch_likely(&kasan_flag_enabled);
97 #else /* CONFIG_KASAN_HW_TAGS */
99 static inline bool kasan_enabled(void)
104 #endif /* CONFIG_KASAN_HW_TAGS */
106 slab_flags_t __kasan_never_merge(void);
107 static __always_inline slab_flags_t kasan_never_merge(void)
110 return __kasan_never_merge();
114 void __kasan_unpoison_range(const void *addr, size_t size);
115 static __always_inline void kasan_unpoison_range(const void *addr, size_t size)
118 __kasan_unpoison_range(addr, size);
121 void __kasan_alloc_pages(struct page *page, unsigned int order);
122 static __always_inline void kasan_alloc_pages(struct page *page,
126 __kasan_alloc_pages(page, order);
129 void __kasan_free_pages(struct page *page, unsigned int order);
130 static __always_inline void kasan_free_pages(struct page *page,
134 __kasan_free_pages(page, order);
137 void __kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
138 slab_flags_t *flags);
139 static __always_inline void kasan_cache_create(struct kmem_cache *cache,
140 unsigned int *size, slab_flags_t *flags)
143 __kasan_cache_create(cache, size, flags);
146 size_t __kasan_metadata_size(struct kmem_cache *cache);
147 static __always_inline size_t kasan_metadata_size(struct kmem_cache *cache)
150 return __kasan_metadata_size(cache);
154 void __kasan_poison_slab(struct page *page);
155 static __always_inline void kasan_poison_slab(struct page *page)
158 __kasan_poison_slab(page);
161 void __kasan_unpoison_object_data(struct kmem_cache *cache, void *object);
162 static __always_inline void kasan_unpoison_object_data(struct kmem_cache *cache,
166 __kasan_unpoison_object_data(cache, object);
169 void __kasan_poison_object_data(struct kmem_cache *cache, void *object);
170 static __always_inline void kasan_poison_object_data(struct kmem_cache *cache,
174 __kasan_poison_object_data(cache, object);
177 void * __must_check __kasan_init_slab_obj(struct kmem_cache *cache,
179 static __always_inline void * __must_check kasan_init_slab_obj(
180 struct kmem_cache *cache, const void *object)
183 return __kasan_init_slab_obj(cache, object);
184 return (void *)object;
187 bool __kasan_slab_free(struct kmem_cache *s, void *object, unsigned long ip);
188 static __always_inline bool kasan_slab_free(struct kmem_cache *s, void *object)
191 return __kasan_slab_free(s, object, _RET_IP_);
195 void __kasan_slab_free_mempool(void *ptr, unsigned long ip);
196 static __always_inline void kasan_slab_free_mempool(void *ptr)
199 __kasan_slab_free_mempool(ptr, _RET_IP_);
202 void * __must_check __kasan_slab_alloc(struct kmem_cache *s,
203 void *object, gfp_t flags);
204 static __always_inline void * __must_check kasan_slab_alloc(
205 struct kmem_cache *s, void *object, gfp_t flags)
208 return __kasan_slab_alloc(s, object, flags);
212 void * __must_check __kasan_kmalloc(struct kmem_cache *s, const void *object,
213 size_t size, gfp_t flags);
214 static __always_inline void * __must_check kasan_kmalloc(struct kmem_cache *s,
215 const void *object, size_t size, gfp_t flags)
218 return __kasan_kmalloc(s, object, size, flags);
219 return (void *)object;
222 void * __must_check __kasan_kmalloc_large(const void *ptr,
223 size_t size, gfp_t flags);
224 static __always_inline void * __must_check kasan_kmalloc_large(const void *ptr,
225 size_t size, gfp_t flags)
228 return __kasan_kmalloc_large(ptr, size, flags);
232 void * __must_check __kasan_krealloc(const void *object,
233 size_t new_size, gfp_t flags);
234 static __always_inline void * __must_check kasan_krealloc(const void *object,
235 size_t new_size, gfp_t flags)
238 return __kasan_krealloc(object, new_size, flags);
239 return (void *)object;
242 void __kasan_kfree_large(void *ptr, unsigned long ip);
243 static __always_inline void kasan_kfree_large(void *ptr)
246 __kasan_kfree_large(ptr, _RET_IP_);
250 * Unlike kasan_check_read/write(), kasan_check_byte() is performed even for
251 * the hardware tag-based mode that doesn't rely on compiler instrumentation.
253 bool __kasan_check_byte(const void *addr, unsigned long ip);
254 static __always_inline bool kasan_check_byte(const void *addr)
257 return __kasan_check_byte(addr, _RET_IP_);
262 bool kasan_save_enable_multi_shot(void);
263 void kasan_restore_multi_shot(bool enabled);
265 #else /* CONFIG_KASAN */
267 static inline bool kasan_enabled(void)
271 static inline slab_flags_t kasan_never_merge(void)
275 static inline void kasan_unpoison_range(const void *address, size_t size) {}
276 static inline void kasan_alloc_pages(struct page *page, unsigned int order) {}
277 static inline void kasan_free_pages(struct page *page, unsigned int order) {}
278 static inline void kasan_cache_create(struct kmem_cache *cache,
280 slab_flags_t *flags) {}
281 static inline size_t kasan_metadata_size(struct kmem_cache *cache) { return 0; }
282 static inline void kasan_poison_slab(struct page *page) {}
283 static inline void kasan_unpoison_object_data(struct kmem_cache *cache,
285 static inline void kasan_poison_object_data(struct kmem_cache *cache,
287 static inline void *kasan_init_slab_obj(struct kmem_cache *cache,
290 return (void *)object;
292 static inline bool kasan_slab_free(struct kmem_cache *s, void *object)
296 static inline void kasan_slab_free_mempool(void *ptr) {}
297 static inline void *kasan_slab_alloc(struct kmem_cache *s, void *object,
302 static inline void *kasan_kmalloc(struct kmem_cache *s, const void *object,
303 size_t size, gfp_t flags)
305 return (void *)object;
307 static inline void *kasan_kmalloc_large(const void *ptr, size_t size, gfp_t flags)
311 static inline void *kasan_krealloc(const void *object, size_t new_size,
314 return (void *)object;
316 static inline void kasan_kfree_large(void *ptr) {}
317 static inline bool kasan_check_byte(const void *address)
322 #endif /* CONFIG_KASAN */
324 #if defined(CONFIG_KASAN) && CONFIG_KASAN_STACK
325 void kasan_unpoison_task_stack(struct task_struct *task);
327 static inline void kasan_unpoison_task_stack(struct task_struct *task) {}
330 #ifdef CONFIG_KASAN_GENERIC
332 void kasan_cache_shrink(struct kmem_cache *cache);
333 void kasan_cache_shutdown(struct kmem_cache *cache);
334 void kasan_record_aux_stack(void *ptr);
336 #else /* CONFIG_KASAN_GENERIC */
338 static inline void kasan_cache_shrink(struct kmem_cache *cache) {}
339 static inline void kasan_cache_shutdown(struct kmem_cache *cache) {}
340 static inline void kasan_record_aux_stack(void *ptr) {}
342 #endif /* CONFIG_KASAN_GENERIC */
344 #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS)
346 static inline void *kasan_reset_tag(const void *addr)
348 return (void *)arch_kasan_reset_tag(addr);
352 * kasan_report - print a report about a bad memory access detected by KASAN
353 * @addr: address of the bad access
354 * @size: size of the bad access
355 * @is_write: whether the bad access is a write or a read
356 * @ip: instruction pointer for the accessibility check or the bad access itself
358 bool kasan_report(unsigned long addr, size_t size,
359 bool is_write, unsigned long ip);
361 #else /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */
363 static inline void *kasan_reset_tag(const void *addr)
368 #endif /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS*/
370 #ifdef CONFIG_KASAN_SW_TAGS
371 void __init kasan_init_sw_tags(void);
373 static inline void kasan_init_sw_tags(void) { }
376 #ifdef CONFIG_KASAN_HW_TAGS
377 void kasan_init_hw_tags_cpu(void);
378 void __init kasan_init_hw_tags(void);
380 static inline void kasan_init_hw_tags_cpu(void) { }
381 static inline void kasan_init_hw_tags(void) { }
384 #ifdef CONFIG_KASAN_VMALLOC
386 int kasan_populate_vmalloc(unsigned long addr, unsigned long size);
387 void kasan_poison_vmalloc(const void *start, unsigned long size);
388 void kasan_unpoison_vmalloc(const void *start, unsigned long size);
389 void kasan_release_vmalloc(unsigned long start, unsigned long end,
390 unsigned long free_region_start,
391 unsigned long free_region_end);
393 #else /* CONFIG_KASAN_VMALLOC */
395 static inline int kasan_populate_vmalloc(unsigned long start,
401 static inline void kasan_poison_vmalloc(const void *start, unsigned long size)
403 static inline void kasan_unpoison_vmalloc(const void *start, unsigned long size)
405 static inline void kasan_release_vmalloc(unsigned long start,
407 unsigned long free_region_start,
408 unsigned long free_region_end) {}
410 #endif /* CONFIG_KASAN_VMALLOC */
412 #if (defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)) && \
413 !defined(CONFIG_KASAN_VMALLOC)
416 * These functions provide a special case to support backing module
417 * allocations with real shadow memory. With KASAN vmalloc, the special
418 * case is unnecessary, as the work is handled in the generic case.
420 int kasan_module_alloc(void *addr, size_t size);
421 void kasan_free_shadow(const struct vm_struct *vm);
423 #else /* (CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS) && !CONFIG_KASAN_VMALLOC */
425 static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
426 static inline void kasan_free_shadow(const struct vm_struct *vm) {}
428 #endif /* (CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS) && !CONFIG_KASAN_VMALLOC */
430 #ifdef CONFIG_KASAN_INLINE
431 void kasan_non_canonical_hook(unsigned long addr);
432 #else /* CONFIG_KASAN_INLINE */
433 static inline void kasan_non_canonical_hook(unsigned long addr) { }
434 #endif /* CONFIG_KASAN_INLINE */
436 #endif /* LINUX_KASAN_H */