xref: /openbmc/linux/include/linux/kasan.h (revision d50112ed)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
20b24beccSAndrey Ryabinin #ifndef _LINUX_KASAN_H
30b24beccSAndrey Ryabinin #define _LINUX_KASAN_H
40b24beccSAndrey Ryabinin 
50b24beccSAndrey Ryabinin #include <linux/types.h>
60b24beccSAndrey Ryabinin 
70b24beccSAndrey Ryabinin struct kmem_cache;
80b24beccSAndrey Ryabinin struct page;
9a5af5aa8SAndrey Ryabinin struct vm_struct;
105be9b730SMasami Hiramatsu struct task_struct;
110b24beccSAndrey Ryabinin 
120b24beccSAndrey Ryabinin #ifdef CONFIG_KASAN
130b24beccSAndrey Ryabinin 
140b24beccSAndrey Ryabinin #define KASAN_SHADOW_SCALE_SHIFT 3
150b24beccSAndrey Ryabinin 
160b24beccSAndrey Ryabinin #include <asm/kasan.h>
1769786cdbSAndrey Ryabinin #include <asm/pgtable.h>
180b24beccSAndrey Ryabinin 
1969786cdbSAndrey Ryabinin extern unsigned char kasan_zero_page[PAGE_SIZE];
2069786cdbSAndrey Ryabinin extern pte_t kasan_zero_pte[PTRS_PER_PTE];
2169786cdbSAndrey Ryabinin extern pmd_t kasan_zero_pmd[PTRS_PER_PMD];
2269786cdbSAndrey Ryabinin extern pud_t kasan_zero_pud[PTRS_PER_PUD];
23c2febafcSKirill A. Shutemov extern p4d_t kasan_zero_p4d[PTRS_PER_P4D];
2469786cdbSAndrey Ryabinin 
2569786cdbSAndrey Ryabinin void kasan_populate_zero_shadow(const void *shadow_start,
2669786cdbSAndrey Ryabinin 				const void *shadow_end);
2769786cdbSAndrey Ryabinin 
280b24beccSAndrey Ryabinin static inline void *kasan_mem_to_shadow(const void *addr)
290b24beccSAndrey Ryabinin {
300b24beccSAndrey Ryabinin 	return (void *)((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT)
310b24beccSAndrey Ryabinin 		+ KASAN_SHADOW_OFFSET;
320b24beccSAndrey Ryabinin }
330b24beccSAndrey Ryabinin 
340b24beccSAndrey Ryabinin /* Enable reporting bugs after kasan_disable_current() */
35af8601adSIngo Molnar extern void kasan_enable_current(void);
360b24beccSAndrey Ryabinin 
370b24beccSAndrey Ryabinin /* Disable reporting bugs for current task */
38af8601adSIngo Molnar extern void kasan_disable_current(void);
390b24beccSAndrey Ryabinin 
400b24beccSAndrey Ryabinin void kasan_unpoison_shadow(const void *address, size_t size);
410b24beccSAndrey Ryabinin 
42e3ae1163SMark Rutland void kasan_unpoison_task_stack(struct task_struct *task);
439f7d416cSDmitry Vyukov void kasan_unpoison_stack_above_sp_to(const void *watermark);
44e3ae1163SMark Rutland 
45b8c73fc2SAndrey Ryabinin void kasan_alloc_pages(struct page *page, unsigned int order);
46b8c73fc2SAndrey Ryabinin void kasan_free_pages(struct page *page, unsigned int order);
47b8c73fc2SAndrey Ryabinin 
487ed2f9e6SAlexander Potapenko void kasan_cache_create(struct kmem_cache *cache, size_t *size,
49d50112edSAlexey Dobriyan 			slab_flags_t *flags);
5055834c59SAlexander Potapenko void kasan_cache_shrink(struct kmem_cache *cache);
51f9fa1d91SGreg Thelen void kasan_cache_shutdown(struct kmem_cache *cache);
527ed2f9e6SAlexander Potapenko 
530316bec2SAndrey Ryabinin void kasan_poison_slab(struct page *page);
540316bec2SAndrey Ryabinin void kasan_unpoison_object_data(struct kmem_cache *cache, void *object);
550316bec2SAndrey Ryabinin void kasan_poison_object_data(struct kmem_cache *cache, void *object);
56b3cbd9bfSAndrey Ryabinin void kasan_init_slab_obj(struct kmem_cache *cache, const void *object);
570316bec2SAndrey Ryabinin 
58505f5dcbSAlexander Potapenko void kasan_kmalloc_large(const void *ptr, size_t size, gfp_t flags);
590316bec2SAndrey Ryabinin void kasan_kfree_large(const void *ptr);
609b75a867SAndrey Ryabinin void kasan_poison_kfree(void *ptr);
61505f5dcbSAlexander Potapenko void kasan_kmalloc(struct kmem_cache *s, const void *object, size_t size,
62505f5dcbSAlexander Potapenko 		  gfp_t flags);
63505f5dcbSAlexander Potapenko void kasan_krealloc(const void *object, size_t new_size, gfp_t flags);
640316bec2SAndrey Ryabinin 
65505f5dcbSAlexander Potapenko void kasan_slab_alloc(struct kmem_cache *s, void *object, gfp_t flags);
6655834c59SAlexander Potapenko bool kasan_slab_free(struct kmem_cache *s, void *object);
670316bec2SAndrey Ryabinin 
687ed2f9e6SAlexander Potapenko struct kasan_cache {
697ed2f9e6SAlexander Potapenko 	int alloc_meta_offset;
707ed2f9e6SAlexander Potapenko 	int free_meta_offset;
717ed2f9e6SAlexander Potapenko };
727ed2f9e6SAlexander Potapenko 
73bebf56a1SAndrey Ryabinin int kasan_module_alloc(void *addr, size_t size);
74a5af5aa8SAndrey Ryabinin void kasan_free_shadow(const struct vm_struct *vm);
75bebf56a1SAndrey Ryabinin 
769b75a867SAndrey Ryabinin size_t ksize(const void *);
779b75a867SAndrey Ryabinin static inline void kasan_unpoison_slab(const void *ptr) { ksize(ptr); }
7880a9201aSAlexander Potapenko size_t kasan_metadata_size(struct kmem_cache *cache);
799b75a867SAndrey Ryabinin 
80b0845ce5SMark Rutland bool kasan_save_enable_multi_shot(void);
81b0845ce5SMark Rutland void kasan_restore_multi_shot(bool enabled);
82b0845ce5SMark Rutland 
830b24beccSAndrey Ryabinin #else /* CONFIG_KASAN */
840b24beccSAndrey Ryabinin 
850b24beccSAndrey Ryabinin static inline void kasan_unpoison_shadow(const void *address, size_t size) {}
860b24beccSAndrey Ryabinin 
87e3ae1163SMark Rutland static inline void kasan_unpoison_task_stack(struct task_struct *task) {}
889f7d416cSDmitry Vyukov static inline void kasan_unpoison_stack_above_sp_to(const void *watermark) {}
89e3ae1163SMark Rutland 
900b24beccSAndrey Ryabinin static inline void kasan_enable_current(void) {}
910b24beccSAndrey Ryabinin static inline void kasan_disable_current(void) {}
920b24beccSAndrey Ryabinin 
93b8c73fc2SAndrey Ryabinin static inline void kasan_alloc_pages(struct page *page, unsigned int order) {}
94b8c73fc2SAndrey Ryabinin static inline void kasan_free_pages(struct page *page, unsigned int order) {}
95b8c73fc2SAndrey Ryabinin 
967ed2f9e6SAlexander Potapenko static inline void kasan_cache_create(struct kmem_cache *cache,
977ed2f9e6SAlexander Potapenko 				      size_t *size,
98d50112edSAlexey Dobriyan 				      slab_flags_t *flags) {}
9955834c59SAlexander Potapenko static inline void kasan_cache_shrink(struct kmem_cache *cache) {}
100f9fa1d91SGreg Thelen static inline void kasan_cache_shutdown(struct kmem_cache *cache) {}
1017ed2f9e6SAlexander Potapenko 
1020316bec2SAndrey Ryabinin static inline void kasan_poison_slab(struct page *page) {}
1030316bec2SAndrey Ryabinin static inline void kasan_unpoison_object_data(struct kmem_cache *cache,
1040316bec2SAndrey Ryabinin 					void *object) {}
1050316bec2SAndrey Ryabinin static inline void kasan_poison_object_data(struct kmem_cache *cache,
1060316bec2SAndrey Ryabinin 					void *object) {}
107b3cbd9bfSAndrey Ryabinin static inline void kasan_init_slab_obj(struct kmem_cache *cache,
108b3cbd9bfSAndrey Ryabinin 				const void *object) {}
1090316bec2SAndrey Ryabinin 
110505f5dcbSAlexander Potapenko static inline void kasan_kmalloc_large(void *ptr, size_t size, gfp_t flags) {}
1110316bec2SAndrey Ryabinin static inline void kasan_kfree_large(const void *ptr) {}
1129b75a867SAndrey Ryabinin static inline void kasan_poison_kfree(void *ptr) {}
1130316bec2SAndrey Ryabinin static inline void kasan_kmalloc(struct kmem_cache *s, const void *object,
114505f5dcbSAlexander Potapenko 				size_t size, gfp_t flags) {}
115505f5dcbSAlexander Potapenko static inline void kasan_krealloc(const void *object, size_t new_size,
116505f5dcbSAlexander Potapenko 				 gfp_t flags) {}
1170316bec2SAndrey Ryabinin 
118505f5dcbSAlexander Potapenko static inline void kasan_slab_alloc(struct kmem_cache *s, void *object,
119505f5dcbSAlexander Potapenko 				   gfp_t flags) {}
12055834c59SAlexander Potapenko static inline bool kasan_slab_free(struct kmem_cache *s, void *object)
12155834c59SAlexander Potapenko {
12255834c59SAlexander Potapenko 	return false;
12355834c59SAlexander Potapenko }
1240316bec2SAndrey Ryabinin 
125bebf56a1SAndrey Ryabinin static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
126a5af5aa8SAndrey Ryabinin static inline void kasan_free_shadow(const struct vm_struct *vm) {}
127bebf56a1SAndrey Ryabinin 
1289b75a867SAndrey Ryabinin static inline void kasan_unpoison_slab(const void *ptr) { }
12980a9201aSAlexander Potapenko static inline size_t kasan_metadata_size(struct kmem_cache *cache) { return 0; }
1309b75a867SAndrey Ryabinin 
1310b24beccSAndrey Ryabinin #endif /* CONFIG_KASAN */
1320b24beccSAndrey Ryabinin 
1330b24beccSAndrey Ryabinin #endif /* LINUX_KASAN_H */
134