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