include/linux/kasan.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_KASAN_H
   3 #define _LINUX_KASAN_H
   4
   5 #include <linux/types.h>
   6
   7 struct kmem_cache;
   8 struct page;
   9 struct vm_struct;
  10 struct task_struct;
  11
  12 #ifdef CONFIG_KASAN
  13
  14 #include <asm/kasan.h>
  15 #include <asm/pgtable.h>
  16
  17 extern unsigned char kasan_early_shadow_page[PAGE_SIZE];
  18 extern pte_t kasan_early_shadow_pte[PTRS_PER_PTE];
  19 extern pmd_t kasan_early_shadow_pmd[PTRS_PER_PMD];
  20 extern pud_t kasan_early_shadow_pud[PTRS_PER_PUD];
  21 extern p4d_t kasan_early_shadow_p4d[MAX_PTRS_PER_P4D];
  22
  23 int kasan_populate_early_shadow(const void *shadow_start,
  24                                 const void *shadow_end);
  25
  26 static 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() */
  33 extern void kasan_enable_current(void);
  34
  35 /* Disable reporting bugs for current task */
  36 extern void kasan_disable_current(void);
  37
  38 void kasan_unpoison_shadow(const void *address, size_t size);
  39
  40 void kasan_unpoison_task_stack(struct task_struct *task);
  41 void kasan_unpoison_stack_above_sp_to(const void *watermark);
  42
  43 void kasan_alloc_pages(struct page *page, unsigned int order);
  44 void kasan_free_pages(struct page *page, unsigned int order);
  45
  46 void kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
  47                         slab_flags_t *flags);
  48
  49 void kasan_poison_slab(struct page *page);
  50 void kasan_unpoison_object_data(struct kmem_cache *cache, void *object);
  51 void kasan_poison_object_data(struct kmem_cache *cache, void *object);
  52 void * __must_check kasan_init_slab_obj(struct kmem_cache *cache,
  53                                         const void *object);
  54
  55 void * __must_check kasan_kmalloc_large(const void *ptr, size_t size,
  56                                                 gfp_t flags);
  57 void kasan_kfree_large(void *ptr, unsigned long ip);
  58 void kasan_poison_kfree(void *ptr, unsigned long ip);
  59 void * __must_check kasan_kmalloc(struct kmem_cache *s, const void *object,
  60                                         size_t size, gfp_t flags);
  61 void * __must_check kasan_krealloc(const void *object, size_t new_size,
  62                                         gfp_t flags);
  63
  64 void * __must_check kasan_slab_alloc(struct kmem_cache *s, void *object,
  65                                         gfp_t flags);
  66 bool kasan_slab_free(struct kmem_cache *s, void *object, unsigned long ip);
  67
  68 struct kasan_cache {
  69         int alloc_meta_offset;
  70         int free_meta_offset;
  71 };
  72
  73 int kasan_module_alloc(void *addr, size_t size);
  74 void kasan_free_shadow(const struct vm_struct *vm);
  75
  76 int kasan_add_zero_shadow(void *start, unsigned long size);
  77 void kasan_remove_zero_shadow(void *start, unsigned long size);
  78
  79 size_t ksize(const void *);
  80 static inline void kasan_unpoison_slab(const void *ptr) { ksize(ptr); }
  81 size_t kasan_metadata_size(struct kmem_cache *cache);
  82
  83 bool kasan_save_enable_multi_shot(void);
  84 void kasan_restore_multi_shot(bool enabled);
  85
  86 #else /* CONFIG_KASAN */
  87
  88 static inline void kasan_unpoison_shadow(const void *address, size_t size) {}
  89
  90 static inline void kasan_unpoison_task_stack(struct task_struct *task) {}
  91 static inline void kasan_unpoison_stack_above_sp_to(const void *watermark) {}
  92
  93 static inline void kasan_enable_current(void) {}
  94 static inline void kasan_disable_current(void) {}
  95
  96 static inline void kasan_alloc_pages(struct page *page, unsigned int order) {}
  97 static inline void kasan_free_pages(struct page *page, unsigned int order) {}
  98
  99 static inline void kasan_cache_create(struct kmem_cache *cache,
 100                                       unsigned int *size,
 101                                       slab_flags_t *flags) {}
 102
 103 static inline void kasan_poison_slab(struct page *page) {}
 104 static inline void kasan_unpoison_object_data(struct kmem_cache *cache,
 105                                         void *object) {}
 106 static inline void kasan_poison_object_data(struct kmem_cache *cache,
 107                                         void *object) {}
 108 static inline void *kasan_init_slab_obj(struct kmem_cache *cache,
 109                                 const void *object)
 110 {
 111         return (void *)object;
 112 }
 113
 114 static inline void *kasan_kmalloc_large(void *ptr, size_t size, gfp_t flags)
 115 {
 116         return ptr;
 117 }
 118 static inline void kasan_kfree_large(void *ptr, unsigned long ip) {}
 119 static inline void kasan_poison_kfree(void *ptr, unsigned long ip) {}
 120 static inline void *kasan_kmalloc(struct kmem_cache *s, const void *object,
 121                                 size_t size, gfp_t flags)
 122 {
 123         return (void *)object;
 124 }
 125 static inline void *kasan_krealloc(const void *object, size_t new_size,
 126                                  gfp_t flags)
 127 {
 128         return (void *)object;
 129 }
 130
 131 static inline void *kasan_slab_alloc(struct kmem_cache *s, void *object,
 132                                    gfp_t flags)
 133 {
 134         return object;
 135 }
 136 static inline bool kasan_slab_free(struct kmem_cache *s, void *object,
 137                                    unsigned long ip)
 138 {
 139         return false;
 140 }
 141
 142 static inline int kasan_module_alloc(void *addr, size_t size) { return 0; }
 143 static inline void kasan_free_shadow(const struct vm_struct *vm) {}
 144
 145 static inline int kasan_add_zero_shadow(void *start, unsigned long size)
 146 {
 147         return 0;
 148 }
 149 static inline void kasan_remove_zero_shadow(void *start,
 150                                         unsigned long size)
 151 {}
 152
 153 static inline void kasan_unpoison_slab(const void *ptr) { }
 154 static inline size_t kasan_metadata_size(struct kmem_cache *cache) { return 0; }
 155
 156 #endif /* CONFIG_KASAN */
 157
 158 #ifdef CONFIG_KASAN_GENERIC
 159
 160 #define KASAN_SHADOW_INIT 0
 161
 162 void kasan_cache_shrink(struct kmem_cache *cache);
 163 void kasan_cache_shutdown(struct kmem_cache *cache);
 164
 165 #else /* CONFIG_KASAN_GENERIC */
 166
 167 static inline void kasan_cache_shrink(struct kmem_cache *cache) {}
 168 static inline void kasan_cache_shutdown(struct kmem_cache *cache) {}
 169
 170 #endif /* CONFIG_KASAN_GENERIC */
 171
 172 #ifdef CONFIG_KASAN_SW_TAGS
 173
 174 #define KASAN_SHADOW_INIT 0xFF
 175
 176 void kasan_init_tags(void);
 177
 178 void *kasan_reset_tag(const void *addr);
 179
 180 void kasan_report(unsigned long addr, size_t size,
 181                 bool is_write, unsigned long ip);
 182
 183 #else /* CONFIG_KASAN_SW_TAGS */
 184
 185 static inline void kasan_init_tags(void) { }
 186
 187 static inline void *kasan_reset_tag(const void *addr)
 188 {
 189         return (void *)addr;
 190 }
 191
 192 #endif /* CONFIG_KASAN_SW_TAGS */
 193
 194 #endif /* LINUX_KASAN_H */