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_GRANULE_SIZE      (1UL << KASAN_SHADOW_SCALE_SHIFT)
   9 #define KASAN_GRANULE_MASK      (KASAN_GRANULE_SIZE - 1)
  10
  11 #define KASAN_MEMORY_PER_SHADOW_PAGE    (KASAN_GRANULE_SIZE << PAGE_SHIFT)
  12
  13 #define KASAN_TAG_KERNEL        0xFF /* native kernel pointers tag */
  14 #define KASAN_TAG_INVALID       0xFE /* inaccessible memory tag */
  15 #define KASAN_TAG_MAX           0xFD /* maximum value for random tags */
  16
  17 #ifdef CONFIG_KASAN_GENERIC
  18 #define KASAN_FREE_PAGE         0xFF  /* page was freed */
  19 #define KASAN_PAGE_REDZONE      0xFE  /* redzone for kmalloc_large allocations */
  20 #define KASAN_KMALLOC_REDZONE   0xFC  /* redzone inside slub object */
  21 #define KASAN_KMALLOC_FREE      0xFB  /* object was freed (kmem_cache_free/kfree) */
  22 #define KASAN_KMALLOC_FREETRACK 0xFA  /* object was freed and has free track set */
  23 #else
  24 #define KASAN_FREE_PAGE         KASAN_TAG_INVALID
  25 #define KASAN_PAGE_REDZONE      KASAN_TAG_INVALID
  26 #define KASAN_KMALLOC_REDZONE   KASAN_TAG_INVALID
  27 #define KASAN_KMALLOC_FREE      KASAN_TAG_INVALID
  28 #define KASAN_KMALLOC_FREETRACK KASAN_TAG_INVALID
  29 #endif
  30
  31 #define KASAN_GLOBAL_REDZONE    0xF9  /* redzone for global variable */
  32 #define KASAN_VMALLOC_INVALID   0xF8  /* unallocated space in vmapped page */
  33
  34 /*
  35  * Stack redzone shadow values
  36  * (Those are compiler's ABI, don't change them)
  37  */
  38 #define KASAN_STACK_LEFT        0xF1
  39 #define KASAN_STACK_MID         0xF2
  40 #define KASAN_STACK_RIGHT       0xF3
  41 #define KASAN_STACK_PARTIAL     0xF4
  42
  43 /*
  44  * alloca redzone shadow values
  45  */
  46 #define KASAN_ALLOCA_LEFT       0xCA
  47 #define KASAN_ALLOCA_RIGHT      0xCB
  48
  49 #define KASAN_ALLOCA_REDZONE_SIZE       32
  50
  51 /*
  52  * Stack frame marker (compiler ABI).
  53  */
  54 #define KASAN_CURRENT_STACK_FRAME_MAGIC 0x41B58AB3
  55
  56 /* Don't break randconfig/all*config builds */
  57 #ifndef KASAN_ABI_VERSION
  58 #define KASAN_ABI_VERSION 1
  59 #endif
  60
  61 struct kasan_access_info {
  62         const void *access_addr;
  63         const void *first_bad_addr;
  64         size_t access_size;
  65         bool is_write;
  66         unsigned long ip;
  67 };
  68
  69 /* The layout of struct dictated by compiler */
  70 struct kasan_source_location {
  71         const char *filename;
  72         int line_no;
  73         int column_no;
  74 };
  75
  76 /* The layout of struct dictated by compiler */
  77 struct kasan_global {
  78         const void *beg;                /* Address of the beginning of the global variable. */
  79         size_t size;                    /* Size of the global variable. */
  80         size_t size_with_redzone;       /* Size of the variable + size of the red zone. 32 bytes aligned */
  81         const void *name;
  82         const void *module_name;        /* Name of the module where the global variable is declared. */
  83         unsigned long has_dynamic_init; /* This needed for C++ */
  84 #if KASAN_ABI_VERSION >= 4
  85         struct kasan_source_location *location;
  86 #endif
  87 #if KASAN_ABI_VERSION >= 5
  88         char *odr_indicator;
  89 #endif
  90 };
  91
  92 /**
  93  * Structures to keep alloc and free tracks *
  94  */
  95
  96 #define KASAN_STACK_DEPTH 64
  97
  98 struct kasan_track {
  99         u32 pid;
 100         depot_stack_handle_t stack;
 101 };
 102
 103 #ifdef CONFIG_KASAN_SW_TAGS_IDENTIFY
 104 #define KASAN_NR_FREE_STACKS 5
 105 #else
 106 #define KASAN_NR_FREE_STACKS 1
 107 #endif
 108
 109 struct kasan_alloc_meta {
 110         struct kasan_track alloc_track;
 111 #ifdef CONFIG_KASAN_GENERIC
 112         /*
 113          * call_rcu() call stack is stored into struct kasan_alloc_meta.
 114          * The free stack is stored into struct kasan_free_meta.
 115          */
 116         depot_stack_handle_t aux_stack[2];
 117 #else
 118         struct kasan_track free_track[KASAN_NR_FREE_STACKS];
 119 #endif
 120 #ifdef CONFIG_KASAN_SW_TAGS_IDENTIFY
 121         u8 free_pointer_tag[KASAN_NR_FREE_STACKS];
 122         u8 free_track_idx;
 123 #endif
 124 };
 125
 126 struct qlist_node {
 127         struct qlist_node *next;
 128 };
 129 struct kasan_free_meta {
 130         /* This field is used while the object is in the quarantine.
 131          * Otherwise it might be used for the allocator freelist.
 132          */
 133         struct qlist_node quarantine_link;
 134 #ifdef CONFIG_KASAN_GENERIC
 135         struct kasan_track free_track;
 136 #endif
 137 };
 138
 139 struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
 140                                         const void *object);
 141 struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
 142                                         const void *object);
 143
 144 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
 145 {
 146         return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
 147                 << KASAN_SHADOW_SCALE_SHIFT);
 148 }
 149
 150 static inline bool addr_has_shadow(const void *addr)
 151 {
 152         return (addr >= kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
 153 }
 154
 155 void poison_range(const void *address, size_t size, u8 value);
 156 void unpoison_range(const void *address, size_t size);
 157
 158 /**
 159  * check_memory_region - Check memory region, and report if invalid access.
 160  * @addr: the accessed address
 161  * @size: the accessed size
 162  * @write: true if access is a write access
 163  * @ret_ip: return address
 164  * @return: true if access was valid, false if invalid
 165  */
 166 bool check_memory_region(unsigned long addr, size_t size, bool write,
 167                                 unsigned long ret_ip);
 168
 169 void *find_first_bad_addr(void *addr, size_t size);
 170 const char *get_bug_type(struct kasan_access_info *info);
 171
 172 bool kasan_report(unsigned long addr, size_t size,
 173                 bool is_write, unsigned long ip);
 174 void kasan_report_invalid_free(void *object, unsigned long ip);
 175
 176 struct page *kasan_addr_to_page(const void *addr);
 177
 178 depot_stack_handle_t kasan_save_stack(gfp_t flags);
 179 void kasan_set_track(struct kasan_track *track, gfp_t flags);
 180 void kasan_set_free_info(struct kmem_cache *cache, void *object, u8 tag);
 181 struct kasan_track *kasan_get_free_track(struct kmem_cache *cache,
 182                                 void *object, u8 tag);
 183
 184 #if defined(CONFIG_KASAN_GENERIC) && \
 185         (defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
 186 void quarantine_put(struct kasan_free_meta *info, struct kmem_cache *cache);
 187 void quarantine_reduce(void);
 188 void quarantine_remove_cache(struct kmem_cache *cache);
 189 #else
 190 static inline void quarantine_put(struct kasan_free_meta *info,
 191                                 struct kmem_cache *cache) { }
 192 static inline void quarantine_reduce(void) { }
 193 static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
 194 #endif
 195
 196 #ifdef CONFIG_KASAN_SW_TAGS
 197
 198 void print_tags(u8 addr_tag, const void *addr);
 199
 200 u8 random_tag(void);
 201
 202 #else
 203
 204 static inline void print_tags(u8 addr_tag, const void *addr) { }
 205
 206 static inline u8 random_tag(void)
 207 {
 208         return 0;
 209 }
 210
 211 #endif
 212
 213 #ifndef arch_kasan_set_tag
 214 static inline const void *arch_kasan_set_tag(const void *addr, u8 tag)
 215 {
 216         return addr;
 217 }
 218 #endif
 219 #ifndef arch_kasan_reset_tag
 220 #define arch_kasan_reset_tag(addr)      ((void *)(addr))
 221 #endif
 222 #ifndef arch_kasan_get_tag
 223 #define arch_kasan_get_tag(addr)        0
 224 #endif
 225
 226 #define set_tag(addr, tag)      ((void *)arch_kasan_set_tag((addr), (tag)))
 227 #define reset_tag(addr)         ((void *)arch_kasan_reset_tag(addr))
 228 #define get_tag(addr)           arch_kasan_get_tag(addr)
 229
 230 /*
 231  * Exported functions for interfaces called from assembly or from generated
 232  * code. Declarations here to avoid warning about missing declarations.
 233  */
 234 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
 235 void __asan_register_globals(struct kasan_global *globals, size_t size);
 236 void __asan_unregister_globals(struct kasan_global *globals, size_t size);
 237 void __asan_handle_no_return(void);
 238 void __asan_alloca_poison(unsigned long addr, size_t size);
 239 void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);
 240
 241 void __asan_load1(unsigned long addr);
 242 void __asan_store1(unsigned long addr);
 243 void __asan_load2(unsigned long addr);
 244 void __asan_store2(unsigned long addr);
 245 void __asan_load4(unsigned long addr);
 246 void __asan_store4(unsigned long addr);
 247 void __asan_load8(unsigned long addr);
 248 void __asan_store8(unsigned long addr);
 249 void __asan_load16(unsigned long addr);
 250 void __asan_store16(unsigned long addr);
 251 void __asan_loadN(unsigned long addr, size_t size);
 252 void __asan_storeN(unsigned long addr, size_t size);
 253
 254 void __asan_load1_noabort(unsigned long addr);
 255 void __asan_store1_noabort(unsigned long addr);
 256 void __asan_load2_noabort(unsigned long addr);
 257 void __asan_store2_noabort(unsigned long addr);
 258 void __asan_load4_noabort(unsigned long addr);
 259 void __asan_store4_noabort(unsigned long addr);
 260 void __asan_load8_noabort(unsigned long addr);
 261 void __asan_store8_noabort(unsigned long addr);
 262 void __asan_load16_noabort(unsigned long addr);
 263 void __asan_store16_noabort(unsigned long addr);
 264 void __asan_loadN_noabort(unsigned long addr, size_t size);
 265 void __asan_storeN_noabort(unsigned long addr, size_t size);
 266
 267 void __asan_report_load1_noabort(unsigned long addr);
 268 void __asan_report_store1_noabort(unsigned long addr);
 269 void __asan_report_load2_noabort(unsigned long addr);
 270 void __asan_report_store2_noabort(unsigned long addr);
 271 void __asan_report_load4_noabort(unsigned long addr);
 272 void __asan_report_store4_noabort(unsigned long addr);
 273 void __asan_report_load8_noabort(unsigned long addr);
 274 void __asan_report_store8_noabort(unsigned long addr);
 275 void __asan_report_load16_noabort(unsigned long addr);
 276 void __asan_report_store16_noabort(unsigned long addr);
 277 void __asan_report_load_n_noabort(unsigned long addr, size_t size);
 278 void __asan_report_store_n_noabort(unsigned long addr, size_t size);
 279
 280 void __asan_set_shadow_00(const void *addr, size_t size);
 281 void __asan_set_shadow_f1(const void *addr, size_t size);
 282 void __asan_set_shadow_f2(const void *addr, size_t size);
 283 void __asan_set_shadow_f3(const void *addr, size_t size);
 284 void __asan_set_shadow_f5(const void *addr, size_t size);
 285 void __asan_set_shadow_f8(const void *addr, size_t size);
 286
 287 void __hwasan_load1_noabort(unsigned long addr);
 288 void __hwasan_store1_noabort(unsigned long addr);
 289 void __hwasan_load2_noabort(unsigned long addr);
 290 void __hwasan_store2_noabort(unsigned long addr);
 291 void __hwasan_load4_noabort(unsigned long addr);
 292 void __hwasan_store4_noabort(unsigned long addr);
 293 void __hwasan_load8_noabort(unsigned long addr);
 294 void __hwasan_store8_noabort(unsigned long addr);
 295 void __hwasan_load16_noabort(unsigned long addr);
 296 void __hwasan_store16_noabort(unsigned long addr);
 297 void __hwasan_loadN_noabort(unsigned long addr, size_t size);
 298 void __hwasan_storeN_noabort(unsigned long addr, size_t size);
 299
 300 void __hwasan_tag_memory(unsigned long addr, u8 tag, unsigned long size);
 301
 302 #endif