xref: /openbmc/linux/include/linux/kasan.h (revision 3c9e3aa1)
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 #include <asm/kasan.h>
1569786cdbSAndrey Ryabinin #include <asm/pgtable.h>
160b24beccSAndrey Ryabinin 
179577dd74SAndrey Konovalov extern unsigned char kasan_early_shadow_page[PAGE_SIZE];
189577dd74SAndrey Konovalov extern pte_t kasan_early_shadow_pte[PTRS_PER_PTE];
199577dd74SAndrey Konovalov extern pmd_t kasan_early_shadow_pmd[PTRS_PER_PMD];
209577dd74SAndrey Konovalov extern pud_t kasan_early_shadow_pud[PTRS_PER_PUD];
219577dd74SAndrey Konovalov extern p4d_t kasan_early_shadow_p4d[MAX_PTRS_PER_P4D];
2269786cdbSAndrey Ryabinin 
239577dd74SAndrey Konovalov int kasan_populate_early_shadow(const void *shadow_start,
2469786cdbSAndrey Ryabinin 				const void *shadow_end);
2569786cdbSAndrey Ryabinin 
260b24beccSAndrey Ryabinin static inline void *kasan_mem_to_shadow(const void *addr)
270b24beccSAndrey Ryabinin {
280b24beccSAndrey Ryabinin 	return (void *)((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT)
290b24beccSAndrey Ryabinin 		+ KASAN_SHADOW_OFFSET;
300b24beccSAndrey Ryabinin }
310b24beccSAndrey Ryabinin 
320b24beccSAndrey Ryabinin /* Enable reporting bugs after kasan_disable_current() */
33af8601adSIngo Molnar extern void kasan_enable_current(void);
340b24beccSAndrey Ryabinin 
350b24beccSAndrey Ryabinin /* Disable reporting bugs for current task */
36af8601adSIngo Molnar extern void kasan_disable_current(void);
370b24beccSAndrey Ryabinin 
380b24beccSAndrey Ryabinin void kasan_unpoison_shadow(const void *address, size_t size);
390b24beccSAndrey Ryabinin 
40e3ae1163SMark Rutland void kasan_unpoison_task_stack(struct task_struct *task);
419f7d416cSDmitry Vyukov void kasan_unpoison_stack_above_sp_to(const void *watermark);
42e3ae1163SMark Rutland 
43b8c73fc2SAndrey Ryabinin void kasan_alloc_pages(struct page *page, unsigned int order);
44b8c73fc2SAndrey Ryabinin void kasan_free_pages(struct page *page, unsigned int order);
45b8c73fc2SAndrey Ryabinin 
46be4a7988SAlexey Dobriyan void kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
47d50112edSAlexey Dobriyan 			slab_flags_t *flags);
487ed2f9e6SAlexander Potapenko 
490316bec2SAndrey Ryabinin void kasan_poison_slab(struct page *page);
500316bec2SAndrey Ryabinin void kasan_unpoison_object_data(struct kmem_cache *cache, void *object);
510316bec2SAndrey Ryabinin void kasan_poison_object_data(struct kmem_cache *cache, void *object);
520116523cSAndrey Konovalov void *kasan_init_slab_obj(struct kmem_cache *cache, const void *object);
530316bec2SAndrey Ryabinin 
540116523cSAndrey Konovalov void *kasan_kmalloc_large(const void *ptr, size_t size, gfp_t flags);
55ee3ce779SDmitry Vyukov void kasan_kfree_large(void *ptr, unsigned long ip);
566860f634SDmitry Vyukov void kasan_poison_kfree(void *ptr, unsigned long ip);
570116523cSAndrey Konovalov void *kasan_kmalloc(struct kmem_cache *s, const void *object, size_t size,
58505f5dcbSAlexander Potapenko 		  gfp_t flags);
590116523cSAndrey Konovalov void *kasan_krealloc(const void *object, size_t new_size, gfp_t flags);
600316bec2SAndrey Ryabinin 
610116523cSAndrey Konovalov void *kasan_slab_alloc(struct kmem_cache *s, void *object, gfp_t flags);
62ee3ce779SDmitry Vyukov bool kasan_slab_free(struct kmem_cache *s, void *object, unsigned long ip);
630316bec2SAndrey Ryabinin 
647ed2f9e6SAlexander Potapenko struct kasan_cache {
657ed2f9e6SAlexander Potapenko 	int alloc_meta_offset;
667ed2f9e6SAlexander Potapenko 	int free_meta_offset;
677ed2f9e6SAlexander Potapenko };
687ed2f9e6SAlexander Potapenko 
69bebf56a1SAndrey Ryabinin int kasan_module_alloc(void *addr, size_t size);
70a5af5aa8SAndrey Ryabinin void kasan_free_shadow(const struct vm_struct *vm);
71bebf56a1SAndrey Ryabinin 
720207df4fSAndrey Ryabinin int kasan_add_zero_shadow(void *start, unsigned long size);
730207df4fSAndrey Ryabinin void kasan_remove_zero_shadow(void *start, unsigned long size);
740207df4fSAndrey Ryabinin 
759b75a867SAndrey Ryabinin size_t ksize(const void *);
769b75a867SAndrey Ryabinin static inline void kasan_unpoison_slab(const void *ptr) { ksize(ptr); }
7780a9201aSAlexander Potapenko size_t kasan_metadata_size(struct kmem_cache *cache);
789b75a867SAndrey Ryabinin 
79b0845ce5SMark Rutland bool kasan_save_enable_multi_shot(void);
80b0845ce5SMark Rutland void kasan_restore_multi_shot(bool enabled);
81b0845ce5SMark Rutland 
820b24beccSAndrey Ryabinin #else /* CONFIG_KASAN */
830b24beccSAndrey Ryabinin 
840b24beccSAndrey Ryabinin static inline void kasan_unpoison_shadow(const void *address, size_t size) {}
850b24beccSAndrey Ryabinin 
86e3ae1163SMark Rutland static inline void kasan_unpoison_task_stack(struct task_struct *task) {}
879f7d416cSDmitry Vyukov static inline void kasan_unpoison_stack_above_sp_to(const void *watermark) {}
88e3ae1163SMark Rutland 
890b24beccSAndrey Ryabinin static inline void kasan_enable_current(void) {}
900b24beccSAndrey Ryabinin static inline void kasan_disable_current(void) {}
910b24beccSAndrey Ryabinin 
92b8c73fc2SAndrey Ryabinin static inline void kasan_alloc_pages(struct page *page, unsigned int order) {}
93b8c73fc2SAndrey Ryabinin static inline void kasan_free_pages(struct page *page, unsigned int order) {}
94b8c73fc2SAndrey Ryabinin 
957ed2f9e6SAlexander Potapenko static inline void kasan_cache_create(struct kmem_cache *cache,
96be4a7988SAlexey Dobriyan 				      unsigned int *size,
97d50112edSAlexey Dobriyan 				      slab_flags_t *flags) {}
987ed2f9e6SAlexander Potapenko 
990316bec2SAndrey Ryabinin static inline void kasan_poison_slab(struct page *page) {}
1000316bec2SAndrey Ryabinin static inline void kasan_unpoison_object_data(struct kmem_cache *cache,
1010316bec2SAndrey Ryabinin 					void *object) {}
1020316bec2SAndrey Ryabinin static inline void kasan_poison_object_data(struct kmem_cache *cache,
1030316bec2SAndrey Ryabinin 					void *object) {}
1040116523cSAndrey Konovalov static inline void *kasan_init_slab_obj(struct kmem_cache *cache,
1050116523cSAndrey Konovalov 				const void *object)
1060116523cSAndrey Konovalov {
1070116523cSAndrey Konovalov 	return (void *)object;
1080116523cSAndrey Konovalov }
1090316bec2SAndrey Ryabinin 
1100116523cSAndrey Konovalov static inline void *kasan_kmalloc_large(void *ptr, size_t size, gfp_t flags)
1110116523cSAndrey Konovalov {
1120116523cSAndrey Konovalov 	return ptr;
1130116523cSAndrey Konovalov }
114ee3ce779SDmitry Vyukov static inline void kasan_kfree_large(void *ptr, unsigned long ip) {}
1156860f634SDmitry Vyukov static inline void kasan_poison_kfree(void *ptr, unsigned long ip) {}
1160116523cSAndrey Konovalov static inline void *kasan_kmalloc(struct kmem_cache *s, const void *object,
1170116523cSAndrey Konovalov 				size_t size, gfp_t flags)
1180116523cSAndrey Konovalov {
1190116523cSAndrey Konovalov 	return (void *)object;
1200116523cSAndrey Konovalov }
1210116523cSAndrey Konovalov static inline void *kasan_krealloc(const void *object, size_t new_size,
1220116523cSAndrey Konovalov 				 gfp_t flags)
1230116523cSAndrey Konovalov {
1240116523cSAndrey Konovalov 	return (void *)object;
1250116523cSAndrey Konovalov }
1260316bec2SAndrey Ryabinin 
1270116523cSAndrey Konovalov static inline void *kasan_slab_alloc(struct kmem_cache *s, void *object,
1280116523cSAndrey Konovalov 				   gfp_t flags)
1290116523cSAndrey Konovalov {
1300116523cSAndrey Konovalov 	return object;
1310116523cSAndrey Konovalov }
132ee3ce779SDmitry Vyukov static inline bool kasan_slab_free(struct kmem_cache *s, void *object,
133ee3ce779SDmitry Vyukov 				   unsigned long ip)
13455834c59SAlexander Potapenko {
13555834c59SAlexander Potapenko 	return false;
13655834c59SAlexander Potapenko }
1370316bec2SAndrey Ryabinin 
138bebf56a1SAndrey Ryabinin static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
139a5af5aa8SAndrey Ryabinin static inline void kasan_free_shadow(const struct vm_struct *vm) {}
140bebf56a1SAndrey Ryabinin 
1410207df4fSAndrey Ryabinin static inline int kasan_add_zero_shadow(void *start, unsigned long size)
1420207df4fSAndrey Ryabinin {
1430207df4fSAndrey Ryabinin 	return 0;
1440207df4fSAndrey Ryabinin }
1450207df4fSAndrey Ryabinin static inline void kasan_remove_zero_shadow(void *start,
1460207df4fSAndrey Ryabinin 					unsigned long size)
1470207df4fSAndrey Ryabinin {}
1480207df4fSAndrey Ryabinin 
1499b75a867SAndrey Ryabinin static inline void kasan_unpoison_slab(const void *ptr) { }
15080a9201aSAlexander Potapenko static inline size_t kasan_metadata_size(struct kmem_cache *cache) { return 0; }
1519b75a867SAndrey Ryabinin 
1520b24beccSAndrey Ryabinin #endif /* CONFIG_KASAN */
1530b24beccSAndrey Ryabinin 
1542bd926b4SAndrey Konovalov #ifdef CONFIG_KASAN_GENERIC
1552bd926b4SAndrey Konovalov 
156080eb83fSAndrey Konovalov #define KASAN_SHADOW_INIT 0
157080eb83fSAndrey Konovalov 
1582bd926b4SAndrey Konovalov void kasan_cache_shrink(struct kmem_cache *cache);
1592bd926b4SAndrey Konovalov void kasan_cache_shutdown(struct kmem_cache *cache);
1602bd926b4SAndrey Konovalov 
1612bd926b4SAndrey Konovalov #else /* CONFIG_KASAN_GENERIC */
1622bd926b4SAndrey Konovalov 
1632bd926b4SAndrey Konovalov static inline void kasan_cache_shrink(struct kmem_cache *cache) {}
1642bd926b4SAndrey Konovalov static inline void kasan_cache_shutdown(struct kmem_cache *cache) {}
1652bd926b4SAndrey Konovalov 
1662bd926b4SAndrey Konovalov #endif /* CONFIG_KASAN_GENERIC */
1672bd926b4SAndrey Konovalov 
168080eb83fSAndrey Konovalov #ifdef CONFIG_KASAN_SW_TAGS
169080eb83fSAndrey Konovalov 
170080eb83fSAndrey Konovalov #define KASAN_SHADOW_INIT 0xFF
171080eb83fSAndrey Konovalov 
1723c9e3aa1SAndrey Konovalov void kasan_init_tags(void);
1733c9e3aa1SAndrey Konovalov 
1743c9e3aa1SAndrey Konovalov void *kasan_reset_tag(const void *addr);
1753c9e3aa1SAndrey Konovalov 
1763c9e3aa1SAndrey Konovalov #else /* CONFIG_KASAN_SW_TAGS */
1773c9e3aa1SAndrey Konovalov 
1783c9e3aa1SAndrey Konovalov static inline void kasan_init_tags(void) { }
1793c9e3aa1SAndrey Konovalov 
1803c9e3aa1SAndrey Konovalov static inline void *kasan_reset_tag(const void *addr)
1813c9e3aa1SAndrey Konovalov {
1823c9e3aa1SAndrey Konovalov 	return (void *)addr;
1833c9e3aa1SAndrey Konovalov }
1843c9e3aa1SAndrey Konovalov 
185080eb83fSAndrey Konovalov #endif /* CONFIG_KASAN_SW_TAGS */
186080eb83fSAndrey Konovalov 
1870b24beccSAndrey Ryabinin #endif /* LINUX_KASAN_H */
188