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/kasan-tags.h>
   7 #include <linux/kfence.h>
   8 #include <linux/stackdepot.h>
   9
  10 #ifdef CONFIG_KASAN_HW_TAGS
  11
  12 #include <linux/static_key.h>
  13 #include "../slab.h"
  14
  15 DECLARE_STATIC_KEY_FALSE(kasan_flag_stacktrace);
  16 extern bool kasan_flag_async __ro_after_init;
  17
  18 static inline bool kasan_stack_collection_enabled(void)
  19 {
  20         return static_branch_unlikely(&kasan_flag_stacktrace);
  21 }
  22
  23 static inline bool kasan_async_mode_enabled(void)
  24 {
  25         return kasan_flag_async;
  26 }
  27 #else
  28
  29 static inline bool kasan_stack_collection_enabled(void)
  30 {
  31         return true;
  32 }
  33
  34 static inline bool kasan_async_mode_enabled(void)
  35 {
  36         return false;
  37 }
  38
  39 #endif
  40
  41 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
  42 #define KASAN_GRANULE_SIZE      (1UL << KASAN_SHADOW_SCALE_SHIFT)
  43 #else
  44 #include <asm/mte-kasan.h>
  45 #define KASAN_GRANULE_SIZE      MTE_GRANULE_SIZE
  46 #endif
  47
  48 #define KASAN_GRANULE_MASK      (KASAN_GRANULE_SIZE - 1)
  49
  50 #define KASAN_MEMORY_PER_SHADOW_PAGE    (KASAN_GRANULE_SIZE << PAGE_SHIFT)
  51
  52 #ifdef CONFIG_KASAN_GENERIC
  53 #define KASAN_FREE_PAGE         0xFF  /* page was freed */
  54 #define KASAN_PAGE_REDZONE      0xFE  /* redzone for kmalloc_large allocations */
  55 #define KASAN_KMALLOC_REDZONE   0xFC  /* redzone inside slub object */
  56 #define KASAN_KMALLOC_FREE      0xFB  /* object was freed (kmem_cache_free/kfree) */
  57 #define KASAN_KMALLOC_FREETRACK 0xFA  /* object was freed and has free track set */
  58 #else
  59 #define KASAN_FREE_PAGE         KASAN_TAG_INVALID
  60 #define KASAN_PAGE_REDZONE      KASAN_TAG_INVALID
  61 #define KASAN_KMALLOC_REDZONE   KASAN_TAG_INVALID
  62 #define KASAN_KMALLOC_FREE      KASAN_TAG_INVALID
  63 #define KASAN_KMALLOC_FREETRACK KASAN_TAG_INVALID
  64 #endif
  65
  66 #define KASAN_GLOBAL_REDZONE    0xF9  /* redzone for global variable */
  67 #define KASAN_VMALLOC_INVALID   0xF8  /* unallocated space in vmapped page */
  68
  69 /*
  70  * Stack redzone shadow values
  71  * (Those are compiler's ABI, don't change them)
  72  */
  73 #define KASAN_STACK_LEFT        0xF1
  74 #define KASAN_STACK_MID         0xF2
  75 #define KASAN_STACK_RIGHT       0xF3
  76 #define KASAN_STACK_PARTIAL     0xF4
  77
  78 /*
  79  * alloca redzone shadow values
  80  */
  81 #define KASAN_ALLOCA_LEFT       0xCA
  82 #define KASAN_ALLOCA_RIGHT      0xCB
  83
  84 #define KASAN_ALLOCA_REDZONE_SIZE       32
  85
  86 /*
  87  * Stack frame marker (compiler ABI).
  88  */
  89 #define KASAN_CURRENT_STACK_FRAME_MAGIC 0x41B58AB3
  90
  91 /* Don't break randconfig/all*config builds */
  92 #ifndef KASAN_ABI_VERSION
  93 #define KASAN_ABI_VERSION 1
  94 #endif
  95
  96 /* Metadata layout customization. */
  97 #define META_BYTES_PER_BLOCK 1
  98 #define META_BLOCKS_PER_ROW 16
  99 #define META_BYTES_PER_ROW (META_BLOCKS_PER_ROW * META_BYTES_PER_BLOCK)
 100 #define META_MEM_BYTES_PER_ROW (META_BYTES_PER_ROW * KASAN_GRANULE_SIZE)
 101 #define META_ROWS_AROUND_ADDR 2
 102
 103 struct kasan_access_info {
 104         const void *access_addr;
 105         const void *first_bad_addr;
 106         size_t access_size;
 107         bool is_write;
 108         unsigned long ip;
 109 };
 110
 111 /* The layout of struct dictated by compiler */
 112 struct kasan_source_location {
 113         const char *filename;
 114         int line_no;
 115         int column_no;
 116 };
 117
 118 /* The layout of struct dictated by compiler */
 119 struct kasan_global {
 120         const void *beg;                /* Address of the beginning of the global variable. */
 121         size_t size;                    /* Size of the global variable. */
 122         size_t size_with_redzone;       /* Size of the variable + size of the red zone. 32 bytes aligned */
 123         const void *name;
 124         const void *module_name;        /* Name of the module where the global variable is declared. */
 125         unsigned long has_dynamic_init; /* This needed for C++ */
 126 #if KASAN_ABI_VERSION >= 4
 127         struct kasan_source_location *location;
 128 #endif
 129 #if KASAN_ABI_VERSION >= 5
 130         char *odr_indicator;
 131 #endif
 132 };
 133
 134 /**
 135  * Structures to keep alloc and free tracks *
 136  */
 137
 138 #define KASAN_STACK_DEPTH 64
 139
 140 struct kasan_track {
 141         u32 pid;
 142         depot_stack_handle_t stack;
 143 };
 144
 145 #if defined(CONFIG_KASAN_TAGS_IDENTIFY) && defined(CONFIG_KASAN_SW_TAGS)
 146 #define KASAN_NR_FREE_STACKS 5
 147 #else
 148 #define KASAN_NR_FREE_STACKS 1
 149 #endif
 150
 151 struct kasan_alloc_meta {
 152         struct kasan_track alloc_track;
 153 #ifdef CONFIG_KASAN_GENERIC
 154         /*
 155          * The auxiliary stack is stored into struct kasan_alloc_meta.
 156          * The free stack is stored into struct kasan_free_meta.
 157          */
 158         depot_stack_handle_t aux_stack[2];
 159 #else
 160         struct kasan_track free_track[KASAN_NR_FREE_STACKS];
 161 #endif
 162 #ifdef CONFIG_KASAN_TAGS_IDENTIFY
 163         u8 free_pointer_tag[KASAN_NR_FREE_STACKS];
 164         u8 free_track_idx;
 165 #endif
 166 };
 167
 168 struct qlist_node {
 169         struct qlist_node *next;
 170 };
 171
 172 /*
 173  * Generic mode either stores free meta in the object itself or in the redzone
 174  * after the object. In the former case free meta offset is 0, in the latter
 175  * case it has some sane value smaller than INT_MAX. Use INT_MAX as free meta
 176  * offset when free meta isn't present.
 177  */
 178 #define KASAN_NO_FREE_META INT_MAX
 179
 180 struct kasan_free_meta {
 181 #ifdef CONFIG_KASAN_GENERIC
 182         /* This field is used while the object is in the quarantine.
 183          * Otherwise it might be used for the allocator freelist.
 184          */
 185         struct qlist_node quarantine_link;
 186         struct kasan_track free_track;
 187 #endif
 188 };
 189
 190 struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
 191                                                 const void *object);
 192 #ifdef CONFIG_KASAN_GENERIC
 193 struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
 194                                                 const void *object);
 195 #endif
 196
 197 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
 198
 199 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
 200 {
 201         return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
 202                 << KASAN_SHADOW_SCALE_SHIFT);
 203 }
 204
 205 static inline bool addr_has_metadata(const void *addr)
 206 {
 207         return (addr >= kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
 208 }
 209
 210 /**
 211  * kasan_check_range - Check memory region, and report if invalid access.
 212  * @addr: the accessed address
 213  * @size: the accessed size
 214  * @write: true if access is a write access
 215  * @ret_ip: return address
 216  * @return: true if access was valid, false if invalid
 217  */
 218 bool kasan_check_range(unsigned long addr, size_t size, bool write,
 219                                 unsigned long ret_ip);
 220
 221 #else /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */
 222
 223 static inline bool addr_has_metadata(const void *addr)
 224 {
 225         return (is_vmalloc_addr(addr) || virt_addr_valid(addr));
 226 }
 227
 228 #endif /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */
 229
 230 #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS)
 231 void kasan_print_tags(u8 addr_tag, const void *addr);
 232 #else
 233 static inline void kasan_print_tags(u8 addr_tag, const void *addr) { }
 234 #endif
 235
 236 void *kasan_find_first_bad_addr(void *addr, size_t size);
 237 const char *kasan_get_bug_type(struct kasan_access_info *info);
 238 void kasan_metadata_fetch_row(char *buffer, void *row);
 239
 240 #if defined(CONFIG_KASAN_GENERIC) && defined(CONFIG_KASAN_STACK)
 241 void kasan_print_address_stack_frame(const void *addr);
 242 #else
 243 static inline void kasan_print_address_stack_frame(const void *addr) { }
 244 #endif
 245
 246 bool kasan_report(unsigned long addr, size_t size,
 247                 bool is_write, unsigned long ip);
 248 void kasan_report_invalid_free(void *object, unsigned long ip);
 249
 250 struct page *kasan_addr_to_page(const void *addr);
 251
 252 depot_stack_handle_t kasan_save_stack(gfp_t flags);
 253 void kasan_set_track(struct kasan_track *track, gfp_t flags);
 254 void kasan_set_free_info(struct kmem_cache *cache, void *object, u8 tag);
 255 struct kasan_track *kasan_get_free_track(struct kmem_cache *cache,
 256                                 void *object, u8 tag);
 257
 258 #if defined(CONFIG_KASAN_GENERIC) && \
 259         (defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
 260 bool kasan_quarantine_put(struct kmem_cache *cache, void *object);
 261 void kasan_quarantine_reduce(void);
 262 void kasan_quarantine_remove_cache(struct kmem_cache *cache);
 263 #else
 264 static inline bool kasan_quarantine_put(struct kmem_cache *cache, void *object) { return false; }
 265 static inline void kasan_quarantine_reduce(void) { }
 266 static inline void kasan_quarantine_remove_cache(struct kmem_cache *cache) { }
 267 #endif
 268
 269 #ifndef arch_kasan_set_tag
 270 static inline const void *arch_kasan_set_tag(const void *addr, u8 tag)
 271 {
 272         return addr;
 273 }
 274 #endif
 275 #ifndef arch_kasan_get_tag
 276 #define arch_kasan_get_tag(addr)        0
 277 #endif
 278
 279 #define set_tag(addr, tag)      ((void *)arch_kasan_set_tag((addr), (tag)))
 280 #define get_tag(addr)           arch_kasan_get_tag(addr)
 281
 282 #ifdef CONFIG_KASAN_HW_TAGS
 283
 284 #ifndef arch_enable_tagging_sync
 285 #define arch_enable_tagging_sync()
 286 #endif
 287 #ifndef arch_enable_tagging_async
 288 #define arch_enable_tagging_async()
 289 #endif
 290 #ifndef arch_force_async_tag_fault
 291 #define arch_force_async_tag_fault()
 292 #endif
 293 #ifndef arch_get_random_tag
 294 #define arch_get_random_tag()   (0xFF)
 295 #endif
 296 #ifndef arch_get_mem_tag
 297 #define arch_get_mem_tag(addr)  (0xFF)
 298 #endif
 299 #ifndef arch_set_mem_tag_range
 300 #define arch_set_mem_tag_range(addr, size, tag, init) ((void *)(addr))
 301 #endif
 302
 303 #define hw_enable_tagging_sync()                arch_enable_tagging_sync()
 304 #define hw_enable_tagging_async()               arch_enable_tagging_async()
 305 #define hw_force_async_tag_fault()              arch_force_async_tag_fault()
 306 #define hw_get_random_tag()                     arch_get_random_tag()
 307 #define hw_get_mem_tag(addr)                    arch_get_mem_tag(addr)
 308 #define hw_set_mem_tag_range(addr, size, tag, init) \
 309                         arch_set_mem_tag_range((addr), (size), (tag), (init))
 310
 311 #else /* CONFIG_KASAN_HW_TAGS */
 312
 313 #define hw_enable_tagging_sync()
 314 #define hw_enable_tagging_async()
 315
 316 #endif /* CONFIG_KASAN_HW_TAGS */
 317
 318 #if defined(CONFIG_KASAN_HW_TAGS) && IS_ENABLED(CONFIG_KASAN_KUNIT_TEST)
 319
 320 void kasan_enable_tagging_sync(void);
 321 void kasan_force_async_fault(void);
 322
 323 #else /* CONFIG_KASAN_HW_TAGS || CONFIG_KASAN_KUNIT_TEST */
 324
 325 static inline void kasan_enable_tagging_sync(void) { }
 326 static inline void kasan_force_async_fault(void) { }
 327
 328 #endif /* CONFIG_KASAN_HW_TAGS || CONFIG_KASAN_KUNIT_TEST */
 329
 330 #ifdef CONFIG_KASAN_SW_TAGS
 331 u8 kasan_random_tag(void);
 332 #elif defined(CONFIG_KASAN_HW_TAGS)
 333 static inline u8 kasan_random_tag(void) { return hw_get_random_tag(); }
 334 #else
 335 static inline u8 kasan_random_tag(void) { return 0; }
 336 #endif
 337
 338 #ifdef CONFIG_KASAN_HW_TAGS
 339
 340 static inline void kasan_poison(const void *addr, size_t size, u8 value, bool init)
 341 {
 342         addr = kasan_reset_tag(addr);
 343
 344         /* Skip KFENCE memory if called explicitly outside of sl*b. */
 345         if (is_kfence_address(addr))
 346                 return;
 347
 348         if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK))
 349                 return;
 350         if (WARN_ON(size & KASAN_GRANULE_MASK))
 351                 return;
 352
 353         hw_set_mem_tag_range((void *)addr, size, value, init);
 354 }
 355
 356 static inline void kasan_unpoison(const void *addr, size_t size, bool init)
 357 {
 358         u8 tag = get_tag(addr);
 359
 360         addr = kasan_reset_tag(addr);
 361
 362         /* Skip KFENCE memory if called explicitly outside of sl*b. */
 363         if (is_kfence_address(addr))
 364                 return;
 365
 366         if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK))
 367                 return;
 368         /*
 369          * Explicitly initialize the memory with the precise object size to
 370          * avoid overwriting the SLAB redzone. This disables initialization in
 371          * the arch code and may thus lead to performance penalty. The penalty
 372          * is accepted since SLAB redzones aren't enabled in production builds.
 373          */
 374         if (__slub_debug_enabled() &&
 375             init && ((unsigned long)size & KASAN_GRANULE_MASK)) {
 376                 init = false;
 377                 memzero_explicit((void *)addr, size);
 378         }
 379         size = round_up(size, KASAN_GRANULE_SIZE);
 380
 381         hw_set_mem_tag_range((void *)addr, size, tag, init);
 382 }
 383
 384 static inline bool kasan_byte_accessible(const void *addr)
 385 {
 386         u8 ptr_tag = get_tag(addr);
 387         u8 mem_tag = hw_get_mem_tag((void *)addr);
 388
 389         return ptr_tag == KASAN_TAG_KERNEL || ptr_tag == mem_tag;
 390 }
 391
 392 #else /* CONFIG_KASAN_HW_TAGS */
 393
 394 /**
 395  * kasan_poison - mark the memory range as inaccessible
 396  * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE
 397  * @size - range size, must be aligned to KASAN_GRANULE_SIZE
 398  * @value - value that's written to metadata for the range
 399  * @init - whether to initialize the memory range (only for hardware tag-based)
 400  *
 401  * The size gets aligned to KASAN_GRANULE_SIZE before marking the range.
 402  */
 403 void kasan_poison(const void *addr, size_t size, u8 value, bool init);
 404
 405 /**
 406  * kasan_unpoison - mark the memory range as accessible
 407  * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE
 408  * @size - range size, can be unaligned
 409  * @init - whether to initialize the memory range (only for hardware tag-based)
 410  *
 411  * For the tag-based modes, the @size gets aligned to KASAN_GRANULE_SIZE before
 412  * marking the range.
 413  * For the generic mode, the last granule of the memory range gets partially
 414  * unpoisoned based on the @size.
 415  */
 416 void kasan_unpoison(const void *addr, size_t size, bool init);
 417
 418 bool kasan_byte_accessible(const void *addr);
 419
 420 #endif /* CONFIG_KASAN_HW_TAGS */
 421
 422 #ifdef CONFIG_KASAN_GENERIC
 423
 424 /**
 425  * kasan_poison_last_granule - mark the last granule of the memory range as
 426  * inaccessible
 427  * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE
 428  * @size - range size
 429  *
 430  * This function is only available for the generic mode, as it's the only mode
 431  * that has partially poisoned memory granules.
 432  */
 433 void kasan_poison_last_granule(const void *address, size_t size);
 434
 435 #else /* CONFIG_KASAN_GENERIC */
 436
 437 static inline void kasan_poison_last_granule(const void *address, size_t size) { }
 438
 439 #endif /* CONFIG_KASAN_GENERIC */
 440
 441 #ifndef kasan_arch_is_ready
 442 static inline bool kasan_arch_is_ready(void)    { return true; }
 443 #elif !defined(CONFIG_KASAN_GENERIC) || !defined(CONFIG_KASAN_OUTLINE)
 444 #error kasan_arch_is_ready only works in KASAN generic outline mode!
 445 #endif
 446
 447 /*
 448  * Exported functions for interfaces called from assembly or from generated
 449  * code. Declarations here to avoid warning about missing declarations.
 450  */
 451 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
 452 void __asan_register_globals(struct kasan_global *globals, size_t size);
 453 void __asan_unregister_globals(struct kasan_global *globals, size_t size);
 454 void __asan_handle_no_return(void);
 455 void __asan_alloca_poison(unsigned long addr, size_t size);
 456 void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);
 457
 458 void __asan_load1(unsigned long addr);
 459 void __asan_store1(unsigned long addr);
 460 void __asan_load2(unsigned long addr);
 461 void __asan_store2(unsigned long addr);
 462 void __asan_load4(unsigned long addr);
 463 void __asan_store4(unsigned long addr);
 464 void __asan_load8(unsigned long addr);
 465 void __asan_store8(unsigned long addr);
 466 void __asan_load16(unsigned long addr);
 467 void __asan_store16(unsigned long addr);
 468 void __asan_loadN(unsigned long addr, size_t size);
 469 void __asan_storeN(unsigned long addr, size_t size);
 470
 471 void __asan_load1_noabort(unsigned long addr);
 472 void __asan_store1_noabort(unsigned long addr);
 473 void __asan_load2_noabort(unsigned long addr);
 474 void __asan_store2_noabort(unsigned long addr);
 475 void __asan_load4_noabort(unsigned long addr);
 476 void __asan_store4_noabort(unsigned long addr);
 477 void __asan_load8_noabort(unsigned long addr);
 478 void __asan_store8_noabort(unsigned long addr);
 479 void __asan_load16_noabort(unsigned long addr);
 480 void __asan_store16_noabort(unsigned long addr);
 481 void __asan_loadN_noabort(unsigned long addr, size_t size);
 482 void __asan_storeN_noabort(unsigned long addr, size_t size);
 483
 484 void __asan_report_load1_noabort(unsigned long addr);
 485 void __asan_report_store1_noabort(unsigned long addr);
 486 void __asan_report_load2_noabort(unsigned long addr);
 487 void __asan_report_store2_noabort(unsigned long addr);
 488 void __asan_report_load4_noabort(unsigned long addr);
 489 void __asan_report_store4_noabort(unsigned long addr);
 490 void __asan_report_load8_noabort(unsigned long addr);
 491 void __asan_report_store8_noabort(unsigned long addr);
 492 void __asan_report_load16_noabort(unsigned long addr);
 493 void __asan_report_store16_noabort(unsigned long addr);
 494 void __asan_report_load_n_noabort(unsigned long addr, size_t size);
 495 void __asan_report_store_n_noabort(unsigned long addr, size_t size);
 496
 497 void __asan_set_shadow_00(const void *addr, size_t size);
 498 void __asan_set_shadow_f1(const void *addr, size_t size);
 499 void __asan_set_shadow_f2(const void *addr, size_t size);
 500 void __asan_set_shadow_f3(const void *addr, size_t size);
 501 void __asan_set_shadow_f5(const void *addr, size_t size);
 502 void __asan_set_shadow_f8(const void *addr, size_t size);
 503
 504 void __hwasan_load1_noabort(unsigned long addr);
 505 void __hwasan_store1_noabort(unsigned long addr);
 506 void __hwasan_load2_noabort(unsigned long addr);
 507 void __hwasan_store2_noabort(unsigned long addr);
 508 void __hwasan_load4_noabort(unsigned long addr);
 509 void __hwasan_store4_noabort(unsigned long addr);
 510 void __hwasan_load8_noabort(unsigned long addr);
 511 void __hwasan_store8_noabort(unsigned long addr);
 512 void __hwasan_load16_noabort(unsigned long addr);
 513 void __hwasan_store16_noabort(unsigned long addr);
 514 void __hwasan_loadN_noabort(unsigned long addr, size_t size);
 515 void __hwasan_storeN_noabort(unsigned long addr, size_t size);
 516
 517 void __hwasan_tag_memory(unsigned long addr, u8 tag, unsigned long size);
 518
 519 #endif