0001
0002 #ifndef __MM_KASAN_KASAN_H
0003 #define __MM_KASAN_KASAN_H
0004
0005 #include <linux/kasan.h>
0006 #include <linux/kasan-tags.h>
0007 #include <linux/kfence.h>
0008 #include <linux/stackdepot.h>
0009
0010 #ifdef CONFIG_KASAN_HW_TAGS
0011
0012 #include <linux/static_key.h>
0013 #include "../slab.h"
0014
0015 DECLARE_STATIC_KEY_TRUE(kasan_flag_vmalloc);
0016 DECLARE_STATIC_KEY_TRUE(kasan_flag_stacktrace);
0017
0018 enum kasan_mode {
0019 KASAN_MODE_SYNC,
0020 KASAN_MODE_ASYNC,
0021 KASAN_MODE_ASYMM,
0022 };
0023
0024 extern enum kasan_mode kasan_mode __ro_after_init;
0025
0026 static inline bool kasan_vmalloc_enabled(void)
0027 {
0028 return static_branch_likely(&kasan_flag_vmalloc);
0029 }
0030
0031 static inline bool kasan_stack_collection_enabled(void)
0032 {
0033 return static_branch_unlikely(&kasan_flag_stacktrace);
0034 }
0035
0036 static inline bool kasan_async_fault_possible(void)
0037 {
0038 return kasan_mode == KASAN_MODE_ASYNC || kasan_mode == KASAN_MODE_ASYMM;
0039 }
0040
0041 static inline bool kasan_sync_fault_possible(void)
0042 {
0043 return kasan_mode == KASAN_MODE_SYNC || kasan_mode == KASAN_MODE_ASYMM;
0044 }
0045
0046 #else
0047
0048 static inline bool kasan_stack_collection_enabled(void)
0049 {
0050 return true;
0051 }
0052
0053 static inline bool kasan_async_fault_possible(void)
0054 {
0055 return false;
0056 }
0057
0058 static inline bool kasan_sync_fault_possible(void)
0059 {
0060 return true;
0061 }
0062
0063 #endif
0064
0065 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
0066 #define KASAN_GRANULE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
0067 #else
0068 #include <asm/mte-kasan.h>
0069 #define KASAN_GRANULE_SIZE MTE_GRANULE_SIZE
0070 #endif
0071
0072 #define KASAN_GRANULE_MASK (KASAN_GRANULE_SIZE - 1)
0073
0074 #define KASAN_MEMORY_PER_SHADOW_PAGE (KASAN_GRANULE_SIZE << PAGE_SHIFT)
0075
0076 #ifdef CONFIG_KASAN_GENERIC
0077 #define KASAN_PAGE_FREE 0xFF
0078 #define KASAN_PAGE_REDZONE 0xFE
0079 #define KASAN_SLAB_REDZONE 0xFC
0080 #define KASAN_SLAB_FREE 0xFB
0081 #define KASAN_VMALLOC_INVALID 0xF8
0082 #else
0083 #define KASAN_PAGE_FREE KASAN_TAG_INVALID
0084 #define KASAN_PAGE_REDZONE KASAN_TAG_INVALID
0085 #define KASAN_SLAB_REDZONE KASAN_TAG_INVALID
0086 #define KASAN_SLAB_FREE KASAN_TAG_INVALID
0087 #define KASAN_VMALLOC_INVALID KASAN_TAG_INVALID
0088 #endif
0089
0090 #ifdef CONFIG_KASAN_GENERIC
0091
0092 #define KASAN_SLAB_FREETRACK 0xFA
0093 #define KASAN_GLOBAL_REDZONE 0xF9
0094
0095
0096 #define KASAN_STACK_LEFT 0xF1
0097 #define KASAN_STACK_MID 0xF2
0098 #define KASAN_STACK_RIGHT 0xF3
0099 #define KASAN_STACK_PARTIAL 0xF4
0100
0101
0102 #define KASAN_ALLOCA_LEFT 0xCA
0103 #define KASAN_ALLOCA_RIGHT 0xCB
0104
0105
0106 #define KASAN_ALLOCA_REDZONE_SIZE 32
0107
0108
0109 #define KASAN_CURRENT_STACK_FRAME_MAGIC 0x41B58AB3
0110
0111
0112 #ifndef KASAN_ABI_VERSION
0113 #define KASAN_ABI_VERSION 1
0114 #endif
0115
0116 #endif
0117
0118
0119 #define META_BYTES_PER_BLOCK 1
0120 #define META_BLOCKS_PER_ROW 16
0121 #define META_BYTES_PER_ROW (META_BLOCKS_PER_ROW * META_BYTES_PER_BLOCK)
0122 #define META_MEM_BYTES_PER_ROW (META_BYTES_PER_ROW * KASAN_GRANULE_SIZE)
0123 #define META_ROWS_AROUND_ADDR 2
0124
0125 enum kasan_report_type {
0126 KASAN_REPORT_ACCESS,
0127 KASAN_REPORT_INVALID_FREE,
0128 KASAN_REPORT_DOUBLE_FREE,
0129 };
0130
0131 struct kasan_report_info {
0132 enum kasan_report_type type;
0133 void *access_addr;
0134 void *first_bad_addr;
0135 size_t access_size;
0136 bool is_write;
0137 unsigned long ip;
0138 };
0139
0140
0141 struct kasan_source_location {
0142 const char *filename;
0143 int line_no;
0144 int column_no;
0145 };
0146
0147
0148 struct kasan_global {
0149 const void *beg;
0150 size_t size;
0151 size_t size_with_redzone;
0152 const void *name;
0153 const void *module_name;
0154 unsigned long has_dynamic_init;
0155 #if KASAN_ABI_VERSION >= 4
0156 struct kasan_source_location *location;
0157 #endif
0158 #if KASAN_ABI_VERSION >= 5
0159 char *odr_indicator;
0160 #endif
0161 };
0162
0163
0164
0165 #define KASAN_STACK_DEPTH 64
0166
0167 struct kasan_track {
0168 u32 pid;
0169 depot_stack_handle_t stack;
0170 };
0171
0172 #if defined(CONFIG_KASAN_TAGS_IDENTIFY) && defined(CONFIG_KASAN_SW_TAGS)
0173 #define KASAN_NR_FREE_STACKS 5
0174 #else
0175 #define KASAN_NR_FREE_STACKS 1
0176 #endif
0177
0178 struct kasan_alloc_meta {
0179 struct kasan_track alloc_track;
0180
0181 #ifdef CONFIG_KASAN_GENERIC
0182 depot_stack_handle_t aux_stack[2];
0183 #else
0184 struct kasan_track free_track[KASAN_NR_FREE_STACKS];
0185 #endif
0186 #ifdef CONFIG_KASAN_TAGS_IDENTIFY
0187 u8 free_pointer_tag[KASAN_NR_FREE_STACKS];
0188 u8 free_track_idx;
0189 #endif
0190 };
0191
0192 struct qlist_node {
0193 struct qlist_node *next;
0194 };
0195
0196
0197
0198
0199
0200
0201 #define KASAN_NO_FREE_META INT_MAX
0202
0203
0204
0205
0206
0207 struct kasan_free_meta {
0208 #ifdef CONFIG_KASAN_GENERIC
0209 struct qlist_node quarantine_link;
0210 struct kasan_track free_track;
0211 #endif
0212 };
0213
0214 #if IS_ENABLED(CONFIG_KASAN_KUNIT_TEST)
0215
0216 struct kunit_kasan_status {
0217 bool report_found;
0218 bool sync_fault;
0219 };
0220 #endif
0221
0222 struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
0223 const void *object);
0224 #ifdef CONFIG_KASAN_GENERIC
0225 struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
0226 const void *object);
0227 #endif
0228
0229 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
0230
0231 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
0232 {
0233 return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
0234 << KASAN_SHADOW_SCALE_SHIFT);
0235 }
0236
0237 static inline bool addr_has_metadata(const void *addr)
0238 {
0239 return (kasan_reset_tag(addr) >=
0240 kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
0241 }
0242
0243
0244
0245
0246
0247
0248
0249
0250
0251 bool kasan_check_range(unsigned long addr, size_t size, bool write,
0252 unsigned long ret_ip);
0253
0254 #else
0255
0256 static inline bool addr_has_metadata(const void *addr)
0257 {
0258 return (is_vmalloc_addr(addr) || virt_addr_valid(addr));
0259 }
0260
0261 #endif
0262
0263 #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS)
0264 void kasan_print_tags(u8 addr_tag, const void *addr);
0265 #else
0266 static inline void kasan_print_tags(u8 addr_tag, const void *addr) { }
0267 #endif
0268
0269 void *kasan_find_first_bad_addr(void *addr, size_t size);
0270 const char *kasan_get_bug_type(struct kasan_report_info *info);
0271 void kasan_metadata_fetch_row(char *buffer, void *row);
0272
0273 #if defined(CONFIG_KASAN_STACK)
0274 void kasan_print_address_stack_frame(const void *addr);
0275 #else
0276 static inline void kasan_print_address_stack_frame(const void *addr) { }
0277 #endif
0278
0279 bool kasan_report(unsigned long addr, size_t size,
0280 bool is_write, unsigned long ip);
0281 void kasan_report_invalid_free(void *object, unsigned long ip, enum kasan_report_type type);
0282
0283 struct page *kasan_addr_to_page(const void *addr);
0284 struct slab *kasan_addr_to_slab(const void *addr);
0285
0286 depot_stack_handle_t kasan_save_stack(gfp_t flags, bool can_alloc);
0287 void kasan_set_track(struct kasan_track *track, gfp_t flags);
0288 void kasan_set_free_info(struct kmem_cache *cache, void *object, u8 tag);
0289 struct kasan_track *kasan_get_free_track(struct kmem_cache *cache,
0290 void *object, u8 tag);
0291
0292 #if defined(CONFIG_KASAN_GENERIC) && \
0293 (defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
0294 bool kasan_quarantine_put(struct kmem_cache *cache, void *object);
0295 void kasan_quarantine_reduce(void);
0296 void kasan_quarantine_remove_cache(struct kmem_cache *cache);
0297 #else
0298 static inline bool kasan_quarantine_put(struct kmem_cache *cache, void *object) { return false; }
0299 static inline void kasan_quarantine_reduce(void) { }
0300 static inline void kasan_quarantine_remove_cache(struct kmem_cache *cache) { }
0301 #endif
0302
0303 #ifndef arch_kasan_set_tag
0304 static inline const void *arch_kasan_set_tag(const void *addr, u8 tag)
0305 {
0306 return addr;
0307 }
0308 #endif
0309 #ifndef arch_kasan_get_tag
0310 #define arch_kasan_get_tag(addr) 0
0311 #endif
0312
0313 #define set_tag(addr, tag) ((void *)arch_kasan_set_tag((addr), (tag)))
0314 #define get_tag(addr) arch_kasan_get_tag(addr)
0315
0316 #ifdef CONFIG_KASAN_HW_TAGS
0317
0318 #ifndef arch_enable_tagging_sync
0319 #define arch_enable_tagging_sync()
0320 #endif
0321 #ifndef arch_enable_tagging_async
0322 #define arch_enable_tagging_async()
0323 #endif
0324 #ifndef arch_enable_tagging_asymm
0325 #define arch_enable_tagging_asymm()
0326 #endif
0327 #ifndef arch_force_async_tag_fault
0328 #define arch_force_async_tag_fault()
0329 #endif
0330 #ifndef arch_get_random_tag
0331 #define arch_get_random_tag() (0xFF)
0332 #endif
0333 #ifndef arch_get_mem_tag
0334 #define arch_get_mem_tag(addr) (0xFF)
0335 #endif
0336 #ifndef arch_set_mem_tag_range
0337 #define arch_set_mem_tag_range(addr, size, tag, init) ((void *)(addr))
0338 #endif
0339
0340 #define hw_enable_tagging_sync() arch_enable_tagging_sync()
0341 #define hw_enable_tagging_async() arch_enable_tagging_async()
0342 #define hw_enable_tagging_asymm() arch_enable_tagging_asymm()
0343 #define hw_force_async_tag_fault() arch_force_async_tag_fault()
0344 #define hw_get_random_tag() arch_get_random_tag()
0345 #define hw_get_mem_tag(addr) arch_get_mem_tag(addr)
0346 #define hw_set_mem_tag_range(addr, size, tag, init) \
0347 arch_set_mem_tag_range((addr), (size), (tag), (init))
0348
0349 void kasan_enable_tagging(void);
0350
0351 #else
0352
0353 #define hw_enable_tagging_sync()
0354 #define hw_enable_tagging_async()
0355 #define hw_enable_tagging_asymm()
0356
0357 static inline void kasan_enable_tagging(void) { }
0358
0359 #endif
0360
0361 #if defined(CONFIG_KASAN_HW_TAGS) && IS_ENABLED(CONFIG_KASAN_KUNIT_TEST)
0362
0363 void kasan_force_async_fault(void);
0364
0365 #else
0366
0367 static inline void kasan_force_async_fault(void) { }
0368
0369 #endif
0370
0371 #ifdef CONFIG_KASAN_SW_TAGS
0372 u8 kasan_random_tag(void);
0373 #elif defined(CONFIG_KASAN_HW_TAGS)
0374 static inline u8 kasan_random_tag(void) { return hw_get_random_tag(); }
0375 #else
0376 static inline u8 kasan_random_tag(void) { return 0; }
0377 #endif
0378
0379 #ifdef CONFIG_KASAN_HW_TAGS
0380
0381 static inline void kasan_poison(const void *addr, size_t size, u8 value, bool init)
0382 {
0383 addr = kasan_reset_tag(addr);
0384
0385
0386 if (is_kfence_address(addr))
0387 return;
0388
0389 if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK))
0390 return;
0391 if (WARN_ON(size & KASAN_GRANULE_MASK))
0392 return;
0393
0394 hw_set_mem_tag_range((void *)addr, size, value, init);
0395 }
0396
0397 static inline void kasan_unpoison(const void *addr, size_t size, bool init)
0398 {
0399 u8 tag = get_tag(addr);
0400
0401 addr = kasan_reset_tag(addr);
0402
0403
0404 if (is_kfence_address(addr))
0405 return;
0406
0407 if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK))
0408 return;
0409
0410
0411
0412
0413
0414
0415
0416 if (__slub_debug_enabled() &&
0417 init && ((unsigned long)size & KASAN_GRANULE_MASK)) {
0418 init = false;
0419 memzero_explicit((void *)addr, size);
0420 }
0421 size = round_up(size, KASAN_GRANULE_SIZE);
0422
0423 hw_set_mem_tag_range((void *)addr, size, tag, init);
0424 }
0425
0426 static inline bool kasan_byte_accessible(const void *addr)
0427 {
0428 u8 ptr_tag = get_tag(addr);
0429 u8 mem_tag = hw_get_mem_tag((void *)addr);
0430
0431 return ptr_tag == KASAN_TAG_KERNEL || ptr_tag == mem_tag;
0432 }
0433
0434 #else
0435
0436
0437
0438
0439
0440
0441
0442
0443
0444
0445 void kasan_poison(const void *addr, size_t size, u8 value, bool init);
0446
0447
0448
0449
0450
0451
0452
0453
0454
0455
0456
0457
0458 void kasan_unpoison(const void *addr, size_t size, bool init);
0459
0460 bool kasan_byte_accessible(const void *addr);
0461
0462 #endif
0463
0464 #ifdef CONFIG_KASAN_GENERIC
0465
0466
0467
0468
0469
0470
0471
0472
0473
0474
0475 void kasan_poison_last_granule(const void *address, size_t size);
0476
0477 #else
0478
0479 static inline void kasan_poison_last_granule(const void *address, size_t size) { }
0480
0481 #endif
0482
0483 #ifndef kasan_arch_is_ready
0484 static inline bool kasan_arch_is_ready(void) { return true; }
0485 #elif !defined(CONFIG_KASAN_GENERIC) || !defined(CONFIG_KASAN_OUTLINE)
0486 #error kasan_arch_is_ready only works in KASAN generic outline mode!
0487 #endif
0488
0489 #if IS_ENABLED(CONFIG_KASAN_KUNIT_TEST) || IS_ENABLED(CONFIG_KASAN_MODULE_TEST)
0490
0491 bool kasan_save_enable_multi_shot(void);
0492 void kasan_restore_multi_shot(bool enabled);
0493
0494 #endif
0495
0496
0497
0498
0499
0500
0501 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
0502 void __asan_register_globals(struct kasan_global *globals, size_t size);
0503 void __asan_unregister_globals(struct kasan_global *globals, size_t size);
0504 void __asan_handle_no_return(void);
0505 void __asan_alloca_poison(unsigned long addr, size_t size);
0506 void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);
0507
0508 void __asan_load1(unsigned long addr);
0509 void __asan_store1(unsigned long addr);
0510 void __asan_load2(unsigned long addr);
0511 void __asan_store2(unsigned long addr);
0512 void __asan_load4(unsigned long addr);
0513 void __asan_store4(unsigned long addr);
0514 void __asan_load8(unsigned long addr);
0515 void __asan_store8(unsigned long addr);
0516 void __asan_load16(unsigned long addr);
0517 void __asan_store16(unsigned long addr);
0518 void __asan_loadN(unsigned long addr, size_t size);
0519 void __asan_storeN(unsigned long addr, size_t size);
0520
0521 void __asan_load1_noabort(unsigned long addr);
0522 void __asan_store1_noabort(unsigned long addr);
0523 void __asan_load2_noabort(unsigned long addr);
0524 void __asan_store2_noabort(unsigned long addr);
0525 void __asan_load4_noabort(unsigned long addr);
0526 void __asan_store4_noabort(unsigned long addr);
0527 void __asan_load8_noabort(unsigned long addr);
0528 void __asan_store8_noabort(unsigned long addr);
0529 void __asan_load16_noabort(unsigned long addr);
0530 void __asan_store16_noabort(unsigned long addr);
0531 void __asan_loadN_noabort(unsigned long addr, size_t size);
0532 void __asan_storeN_noabort(unsigned long addr, size_t size);
0533
0534 void __asan_report_load1_noabort(unsigned long addr);
0535 void __asan_report_store1_noabort(unsigned long addr);
0536 void __asan_report_load2_noabort(unsigned long addr);
0537 void __asan_report_store2_noabort(unsigned long addr);
0538 void __asan_report_load4_noabort(unsigned long addr);
0539 void __asan_report_store4_noabort(unsigned long addr);
0540 void __asan_report_load8_noabort(unsigned long addr);
0541 void __asan_report_store8_noabort(unsigned long addr);
0542 void __asan_report_load16_noabort(unsigned long addr);
0543 void __asan_report_store16_noabort(unsigned long addr);
0544 void __asan_report_load_n_noabort(unsigned long addr, size_t size);
0545 void __asan_report_store_n_noabort(unsigned long addr, size_t size);
0546
0547 void __asan_set_shadow_00(const void *addr, size_t size);
0548 void __asan_set_shadow_f1(const void *addr, size_t size);
0549 void __asan_set_shadow_f2(const void *addr, size_t size);
0550 void __asan_set_shadow_f3(const void *addr, size_t size);
0551 void __asan_set_shadow_f5(const void *addr, size_t size);
0552 void __asan_set_shadow_f8(const void *addr, size_t size);
0553
0554 void __hwasan_load1_noabort(unsigned long addr);
0555 void __hwasan_store1_noabort(unsigned long addr);
0556 void __hwasan_load2_noabort(unsigned long addr);
0557 void __hwasan_store2_noabort(unsigned long addr);
0558 void __hwasan_load4_noabort(unsigned long addr);
0559 void __hwasan_store4_noabort(unsigned long addr);
0560 void __hwasan_load8_noabort(unsigned long addr);
0561 void __hwasan_store8_noabort(unsigned long addr);
0562 void __hwasan_load16_noabort(unsigned long addr);
0563 void __hwasan_store16_noabort(unsigned long addr);
0564 void __hwasan_loadN_noabort(unsigned long addr, size_t size);
0565 void __hwasan_storeN_noabort(unsigned long addr, size_t size);
0566
0567 void __hwasan_tag_memory(unsigned long addr, u8 tag, unsigned long size);
0568
0569 #endif