mm/kasan/kasan.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __MM_KASAN_KASAN_H
   3 #define __MM_KASAN_KASAN_H
   4
   5 #include <linux/kasan.h>
   6 #include <linux/stackdepot.h>
   7
   8 #define KASAN_SHADOW_SCALE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
   9 #define KASAN_SHADOW_MASK       (KASAN_SHADOW_SCALE_SIZE - 1)
  10
  11 #define KASAN_TAG_KERNEL        0xFF /* native kernel pointers tag */
  12 #define KASAN_TAG_INVALID       0xFE /* inaccessible memory tag */
  13 #define KASAN_TAG_MAX           0xFD /* maximum value for random tags */
  14
  15 #define KASAN_FREE_PAGE         0xFF  /* page was freed */
  16 #define KASAN_PAGE_REDZONE      0xFE  /* redzone for kmalloc_large allocations */
  17 #define KASAN_KMALLOC_REDZONE   0xFC  /* redzone inside slub object */
  18 #define KASAN_KMALLOC_FREE      0xFB  /* object was freed (kmem_cache_free/kfree) */
  19 #define KASAN_GLOBAL_REDZONE    0xFA  /* redzone for global variable */
  20
  21 /*
  22  * Stack redzone shadow values
  23  * (Those are compiler's ABI, don't change them)
  24  */
  25 #define KASAN_STACK_LEFT        0xF1
  26 #define KASAN_STACK_MID         0xF2
  27 #define KASAN_STACK_RIGHT       0xF3
  28 #define KASAN_STACK_PARTIAL     0xF4
  29 #define KASAN_USE_AFTER_SCOPE   0xF8
  30
  31 /*
  32  * alloca redzone shadow values
  33  */
  34 #define KASAN_ALLOCA_LEFT       0xCA
  35 #define KASAN_ALLOCA_RIGHT      0xCB
  36
  37 #define KASAN_ALLOCA_REDZONE_SIZE       32
  38
  39 /* Don't break randconfig/all*config builds */
  40 #ifndef KASAN_ABI_VERSION
  41 #define KASAN_ABI_VERSION 1
  42 #endif
  43
  44 struct kasan_access_info {
  45         const void *access_addr;
  46         const void *first_bad_addr;
  47         size_t access_size;
  48         bool is_write;
  49         unsigned long ip;
  50 };
  51
  52 /* The layout of struct dictated by compiler */
  53 struct kasan_source_location {
  54         const char *filename;
  55         int line_no;
  56         int column_no;
  57 };
  58
  59 /* The layout of struct dictated by compiler */
  60 struct kasan_global {
  61         const void *beg;                /* Address of the beginning of the global variable. */
  62         size_t size;                    /* Size of the global variable. */
  63         size_t size_with_redzone;       /* Size of the variable + size of the red zone. 32 bytes aligned */
  64         const void *name;
  65         const void *module_name;        /* Name of the module where the global variable is declared. */
  66         unsigned long has_dynamic_init; /* This needed for C++ */
  67 #if KASAN_ABI_VERSION >= 4
  68         struct kasan_source_location *location;
  69 #endif
  70 #if KASAN_ABI_VERSION >= 5
  71         char *odr_indicator;
  72 #endif
  73 };
  74
  75 /**
  76  * Structures to keep alloc and free tracks *
  77  */
  78
  79 #define KASAN_STACK_DEPTH 64
  80
  81 struct kasan_track {
  82         u32 pid;
  83         depot_stack_handle_t stack;
  84 };
  85
  86 struct kasan_alloc_meta {
  87         struct kasan_track alloc_track;
  88         struct kasan_track free_track;
  89 };
  90
  91 struct qlist_node {
  92         struct qlist_node *next;
  93 };
  94 struct kasan_free_meta {
  95         /* This field is used while the object is in the quarantine.
  96          * Otherwise it might be used for the allocator freelist.
  97          */
  98         struct qlist_node quarantine_link;
  99 };
 100
 101 struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
 102                                         const void *object);
 103 struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
 104                                         const void *object);
 105
 106 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
 107 {
 108         return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
 109                 << KASAN_SHADOW_SCALE_SHIFT);
 110 }
 111
 112 static inline bool addr_has_shadow(const void *addr)
 113 {
 114         return (addr >= kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
 115 }
 116
 117 void kasan_poison_shadow(const void *address, size_t size, u8 value);
 118
 119 void check_memory_region(unsigned long addr, size_t size, bool write,
 120                                 unsigned long ret_ip);
 121
 122 const char *get_bug_type(struct kasan_access_info *info);
 123
 124 void kasan_report(unsigned long addr, size_t size,
 125                 bool is_write, unsigned long ip);
 126 void kasan_report_invalid_free(void *object, unsigned long ip);
 127
 128 #if defined(CONFIG_KASAN_GENERIC) && \
 129         (defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
 130 void quarantine_put(struct kasan_free_meta *info, struct kmem_cache *cache);
 131 void quarantine_reduce(void);
 132 void quarantine_remove_cache(struct kmem_cache *cache);
 133 #else
 134 static inline void quarantine_put(struct kasan_free_meta *info,
 135                                 struct kmem_cache *cache) { }
 136 static inline void quarantine_reduce(void) { }
 137 static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
 138 #endif
 139
 140 #ifdef CONFIG_KASAN_SW_TAGS
 141
 142 u8 random_tag(void);
 143
 144 #else
 145
 146 static inline u8 random_tag(void)
 147 {
 148         return 0;
 149 }
 150
 151 #endif
 152
 153 #ifndef arch_kasan_set_tag
 154 #define arch_kasan_set_tag(addr, tag)   ((void *)(addr))
 155 #endif
 156 #ifndef arch_kasan_reset_tag
 157 #define arch_kasan_reset_tag(addr)      ((void *)(addr))
 158 #endif
 159 #ifndef arch_kasan_get_tag
 160 #define arch_kasan_get_tag(addr)        0
 161 #endif
 162
 163 #define set_tag(addr, tag)      ((void *)arch_kasan_set_tag((addr), (tag)))
 164 #define reset_tag(addr)         ((void *)arch_kasan_reset_tag(addr))
 165 #define get_tag(addr)           arch_kasan_get_tag(addr)
 166
 167 /*
 168  * Exported functions for interfaces called from assembly or from generated
 169  * code. Declarations here to avoid warning about missing declarations.
 170  */
 171 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
 172 void __asan_register_globals(struct kasan_global *globals, size_t size);
 173 void __asan_unregister_globals(struct kasan_global *globals, size_t size);
 174 void __asan_loadN(unsigned long addr, size_t size);
 175 void __asan_storeN(unsigned long addr, size_t size);
 176 void __asan_handle_no_return(void);
 177 void __asan_poison_stack_memory(const void *addr, size_t size);
 178 void __asan_unpoison_stack_memory(const void *addr, size_t size);
 179 void __asan_alloca_poison(unsigned long addr, size_t size);
 180 void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);
 181
 182 void __asan_load1(unsigned long addr);
 183 void __asan_store1(unsigned long addr);
 184 void __asan_load2(unsigned long addr);
 185 void __asan_store2(unsigned long addr);
 186 void __asan_load4(unsigned long addr);
 187 void __asan_store4(unsigned long addr);
 188 void __asan_load8(unsigned long addr);
 189 void __asan_store8(unsigned long addr);
 190 void __asan_load16(unsigned long addr);
 191 void __asan_store16(unsigned long addr);
 192
 193 void __asan_load1_noabort(unsigned long addr);
 194 void __asan_store1_noabort(unsigned long addr);
 195 void __asan_load2_noabort(unsigned long addr);
 196 void __asan_store2_noabort(unsigned long addr);
 197 void __asan_load4_noabort(unsigned long addr);
 198 void __asan_store4_noabort(unsigned long addr);
 199 void __asan_load8_noabort(unsigned long addr);
 200 void __asan_store8_noabort(unsigned long addr);
 201 void __asan_load16_noabort(unsigned long addr);
 202 void __asan_store16_noabort(unsigned long addr);
 203
 204 void __asan_set_shadow_00(const void *addr, size_t size);
 205 void __asan_set_shadow_f1(const void *addr, size_t size);
 206 void __asan_set_shadow_f2(const void *addr, size_t size);
 207 void __asan_set_shadow_f3(const void *addr, size_t size);
 208 void __asan_set_shadow_f5(const void *addr, size_t size);
 209 void __asan_set_shadow_f8(const void *addr, size_t size);
 210
 211 #endif