2 * This file contains shadow memory manipulation code.
4 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
5 * Author: Andrey Ryabinin <ryabinin.a.a@gmail.com>
7 * Some code borrowed from https://github.com/xairy/kasan-prototype by
8 * Andrey Konovalov <adech.fo@gmail.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #define DISABLE_BRANCH_PROFILING
19 #include <linux/export.h>
20 #include <linux/interrupt.h>
21 #include <linux/init.h>
22 #include <linux/kasan.h>
23 #include <linux/kernel.h>
24 #include <linux/kmemleak.h>
25 #include <linux/linkage.h>
26 #include <linux/memblock.h>
27 #include <linux/memory.h>
29 #include <linux/module.h>
30 #include <linux/printk.h>
31 #include <linux/sched.h>
32 #include <linux/slab.h>
33 #include <linux/stacktrace.h>
34 #include <linux/string.h>
35 #include <linux/types.h>
36 #include <linux/vmalloc.h>
37 #include <linux/bug.h>
42 void kasan_enable_current(void)
44 current->kasan_depth++;
47 void kasan_disable_current(void)
49 current->kasan_depth--;
53 * Poisons the shadow memory for 'size' bytes starting from 'addr'.
54 * Memory addresses should be aligned to KASAN_SHADOW_SCALE_SIZE.
56 static void kasan_poison_shadow(const void *address, size_t size, u8 value)
58 void *shadow_start, *shadow_end;
60 shadow_start = kasan_mem_to_shadow(address);
61 shadow_end = kasan_mem_to_shadow(address + size);
63 memset(shadow_start, value, shadow_end - shadow_start);
66 void kasan_unpoison_shadow(const void *address, size_t size)
68 kasan_poison_shadow(address, size, 0);
70 if (size & KASAN_SHADOW_MASK) {
71 u8 *shadow = (u8 *)kasan_mem_to_shadow(address + size);
72 *shadow = size & KASAN_SHADOW_MASK;
76 static void __kasan_unpoison_stack(struct task_struct *task, const void *sp)
78 void *base = task_stack_page(task);
79 size_t size = sp - base;
81 kasan_unpoison_shadow(base, size);
84 /* Unpoison the entire stack for a task. */
85 void kasan_unpoison_task_stack(struct task_struct *task)
87 __kasan_unpoison_stack(task, task_stack_page(task) + THREAD_SIZE);
90 /* Unpoison the stack for the current task beyond a watermark sp value. */
91 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark)
94 * Calculate the task stack base address. Avoid using 'current'
95 * because this function is called by early resume code which hasn't
96 * yet set up the percpu register (%gs).
98 void *base = (void *)((unsigned long)watermark & ~(THREAD_SIZE - 1));
100 kasan_unpoison_shadow(base, watermark - base);
104 * Clear all poison for the region between the current SP and a provided
105 * watermark value, as is sometimes required prior to hand-crafted asm function
106 * returns in the middle of functions.
108 void kasan_unpoison_stack_above_sp_to(const void *watermark)
110 const void *sp = __builtin_frame_address(0);
111 size_t size = watermark - sp;
113 if (WARN_ON(sp > watermark))
115 kasan_unpoison_shadow(sp, size);
119 * All functions below always inlined so compiler could
120 * perform better optimizations in each of __asan_loadX/__assn_storeX
121 * depending on memory access size X.
124 static __always_inline bool memory_is_poisoned_1(unsigned long addr)
126 s8 shadow_value = *(s8 *)kasan_mem_to_shadow((void *)addr);
128 if (unlikely(shadow_value)) {
129 s8 last_accessible_byte = addr & KASAN_SHADOW_MASK;
130 return unlikely(last_accessible_byte >= shadow_value);
136 static __always_inline bool memory_is_poisoned_2(unsigned long addr)
138 u16 *shadow_addr = (u16 *)kasan_mem_to_shadow((void *)addr);
140 if (unlikely(*shadow_addr)) {
141 if (memory_is_poisoned_1(addr + 1))
145 * If single shadow byte covers 2-byte access, we don't
146 * need to do anything more. Otherwise, test the first
149 if (likely(((addr + 1) & KASAN_SHADOW_MASK) != 0))
152 return unlikely(*(u8 *)shadow_addr);
158 static __always_inline bool memory_is_poisoned_4(unsigned long addr)
160 u16 *shadow_addr = (u16 *)kasan_mem_to_shadow((void *)addr);
162 if (unlikely(*shadow_addr)) {
163 if (memory_is_poisoned_1(addr + 3))
167 * If single shadow byte covers 4-byte access, we don't
168 * need to do anything more. Otherwise, test the first
171 if (likely(((addr + 3) & KASAN_SHADOW_MASK) >= 3))
174 return unlikely(*(u8 *)shadow_addr);
180 static __always_inline bool memory_is_poisoned_8(unsigned long addr)
182 u16 *shadow_addr = (u16 *)kasan_mem_to_shadow((void *)addr);
184 if (unlikely(*shadow_addr)) {
185 if (memory_is_poisoned_1(addr + 7))
189 * If single shadow byte covers 8-byte access, we don't
190 * need to do anything more. Otherwise, test the first
193 if (likely(IS_ALIGNED(addr, KASAN_SHADOW_SCALE_SIZE)))
196 return unlikely(*(u8 *)shadow_addr);
202 static __always_inline bool memory_is_poisoned_16(unsigned long addr)
204 u32 *shadow_addr = (u32 *)kasan_mem_to_shadow((void *)addr);
206 if (unlikely(*shadow_addr)) {
207 u16 shadow_first_bytes = *(u16 *)shadow_addr;
209 if (unlikely(shadow_first_bytes))
213 * If two shadow bytes covers 16-byte access, we don't
214 * need to do anything more. Otherwise, test the last
217 if (likely(IS_ALIGNED(addr, KASAN_SHADOW_SCALE_SIZE)))
220 return memory_is_poisoned_1(addr + 15);
226 static __always_inline unsigned long bytes_is_zero(const u8 *start,
230 if (unlikely(*start))
231 return (unsigned long)start;
239 static __always_inline unsigned long memory_is_zero(const void *start,
244 unsigned int prefix = (unsigned long)start % 8;
246 if (end - start <= 16)
247 return bytes_is_zero(start, end - start);
251 ret = bytes_is_zero(start, prefix);
257 words = (end - start) / 8;
259 if (unlikely(*(u64 *)start))
260 return bytes_is_zero(start, 8);
265 return bytes_is_zero(start, (end - start) % 8);
268 static __always_inline bool memory_is_poisoned_n(unsigned long addr,
273 ret = memory_is_zero(kasan_mem_to_shadow((void *)addr),
274 kasan_mem_to_shadow((void *)addr + size - 1) + 1);
277 unsigned long last_byte = addr + size - 1;
278 s8 *last_shadow = (s8 *)kasan_mem_to_shadow((void *)last_byte);
280 if (unlikely(ret != (unsigned long)last_shadow ||
281 ((long)(last_byte & KASAN_SHADOW_MASK) >= *last_shadow)))
287 static __always_inline bool memory_is_poisoned(unsigned long addr, size_t size)
289 if (__builtin_constant_p(size)) {
292 return memory_is_poisoned_1(addr);
294 return memory_is_poisoned_2(addr);
296 return memory_is_poisoned_4(addr);
298 return memory_is_poisoned_8(addr);
300 return memory_is_poisoned_16(addr);
306 return memory_is_poisoned_n(addr, size);
309 static __always_inline void check_memory_region_inline(unsigned long addr,
310 size_t size, bool write,
311 unsigned long ret_ip)
313 if (unlikely(size == 0))
316 if (unlikely((void *)addr <
317 kasan_shadow_to_mem((void *)KASAN_SHADOW_START))) {
318 kasan_report(addr, size, write, ret_ip);
322 if (likely(!memory_is_poisoned(addr, size)))
325 kasan_report(addr, size, write, ret_ip);
328 static void check_memory_region(unsigned long addr,
329 size_t size, bool write,
330 unsigned long ret_ip)
332 check_memory_region_inline(addr, size, write, ret_ip);
335 void kasan_check_read(const void *p, unsigned int size)
337 check_memory_region((unsigned long)p, size, false, _RET_IP_);
339 EXPORT_SYMBOL(kasan_check_read);
341 void kasan_check_write(const void *p, unsigned int size)
343 check_memory_region((unsigned long)p, size, true, _RET_IP_);
345 EXPORT_SYMBOL(kasan_check_write);
348 void *memset(void *addr, int c, size_t len)
350 check_memory_region((unsigned long)addr, len, true, _RET_IP_);
352 return __memset(addr, c, len);
356 void *memmove(void *dest, const void *src, size_t len)
358 check_memory_region((unsigned long)src, len, false, _RET_IP_);
359 check_memory_region((unsigned long)dest, len, true, _RET_IP_);
361 return __memmove(dest, src, len);
365 void *memcpy(void *dest, const void *src, size_t len)
367 check_memory_region((unsigned long)src, len, false, _RET_IP_);
368 check_memory_region((unsigned long)dest, len, true, _RET_IP_);
370 return __memcpy(dest, src, len);
373 void kasan_alloc_pages(struct page *page, unsigned int order)
375 if (likely(!PageHighMem(page)))
376 kasan_unpoison_shadow(page_address(page), PAGE_SIZE << order);
379 void kasan_free_pages(struct page *page, unsigned int order)
381 if (likely(!PageHighMem(page)))
382 kasan_poison_shadow(page_address(page),
388 * Adaptive redzone policy taken from the userspace AddressSanitizer runtime.
389 * For larger allocations larger redzones are used.
391 static size_t optimal_redzone(size_t object_size)
394 object_size <= 64 - 16 ? 16 :
395 object_size <= 128 - 32 ? 32 :
396 object_size <= 512 - 64 ? 64 :
397 object_size <= 4096 - 128 ? 128 :
398 object_size <= (1 << 14) - 256 ? 256 :
399 object_size <= (1 << 15) - 512 ? 512 :
400 object_size <= (1 << 16) - 1024 ? 1024 : 2048;
404 void kasan_cache_create(struct kmem_cache *cache, size_t *size,
405 unsigned long *flags)
408 int orig_size = *size;
410 /* Add alloc meta. */
411 cache->kasan_info.alloc_meta_offset = *size;
412 *size += sizeof(struct kasan_alloc_meta);
415 if (cache->flags & SLAB_DESTROY_BY_RCU || cache->ctor ||
416 cache->object_size < sizeof(struct kasan_free_meta)) {
417 cache->kasan_info.free_meta_offset = *size;
418 *size += sizeof(struct kasan_free_meta);
420 redzone_adjust = optimal_redzone(cache->object_size) -
421 (*size - cache->object_size);
423 if (redzone_adjust > 0)
424 *size += redzone_adjust;
426 *size = min(KMALLOC_MAX_SIZE, max(*size, cache->object_size +
427 optimal_redzone(cache->object_size)));
430 * If the metadata doesn't fit, don't enable KASAN at all.
432 if (*size <= cache->kasan_info.alloc_meta_offset ||
433 *size <= cache->kasan_info.free_meta_offset) {
434 cache->kasan_info.alloc_meta_offset = 0;
435 cache->kasan_info.free_meta_offset = 0;
440 *flags |= SLAB_KASAN;
443 void kasan_cache_shrink(struct kmem_cache *cache)
445 quarantine_remove_cache(cache);
448 void kasan_cache_shutdown(struct kmem_cache *cache)
450 quarantine_remove_cache(cache);
453 size_t kasan_metadata_size(struct kmem_cache *cache)
455 return (cache->kasan_info.alloc_meta_offset ?
456 sizeof(struct kasan_alloc_meta) : 0) +
457 (cache->kasan_info.free_meta_offset ?
458 sizeof(struct kasan_free_meta) : 0);
461 void kasan_poison_slab(struct page *page)
463 kasan_poison_shadow(page_address(page),
464 PAGE_SIZE << compound_order(page),
465 KASAN_KMALLOC_REDZONE);
468 void kasan_unpoison_object_data(struct kmem_cache *cache, void *object)
470 kasan_unpoison_shadow(object, cache->object_size);
473 void kasan_poison_object_data(struct kmem_cache *cache, void *object)
475 kasan_poison_shadow(object,
476 round_up(cache->object_size, KASAN_SHADOW_SCALE_SIZE),
477 KASAN_KMALLOC_REDZONE);
480 static inline int in_irqentry_text(unsigned long ptr)
482 return (ptr >= (unsigned long)&__irqentry_text_start &&
483 ptr < (unsigned long)&__irqentry_text_end) ||
484 (ptr >= (unsigned long)&__softirqentry_text_start &&
485 ptr < (unsigned long)&__softirqentry_text_end);
488 static inline void filter_irq_stacks(struct stack_trace *trace)
492 if (!trace->nr_entries)
494 for (i = 0; i < trace->nr_entries; i++)
495 if (in_irqentry_text(trace->entries[i])) {
496 /* Include the irqentry function into the stack. */
497 trace->nr_entries = i + 1;
502 static inline depot_stack_handle_t save_stack(gfp_t flags)
504 unsigned long entries[KASAN_STACK_DEPTH];
505 struct stack_trace trace = {
508 .max_entries = KASAN_STACK_DEPTH,
512 save_stack_trace(&trace);
513 filter_irq_stacks(&trace);
514 if (trace.nr_entries != 0 &&
515 trace.entries[trace.nr_entries-1] == ULONG_MAX)
518 return depot_save_stack(&trace, flags);
521 static inline void set_track(struct kasan_track *track, gfp_t flags)
523 track->pid = current->pid;
524 track->stack = save_stack(flags);
527 struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
530 BUILD_BUG_ON(sizeof(struct kasan_alloc_meta) > 32);
531 return (void *)object + cache->kasan_info.alloc_meta_offset;
534 struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
537 BUILD_BUG_ON(sizeof(struct kasan_free_meta) > 32);
538 return (void *)object + cache->kasan_info.free_meta_offset;
541 void kasan_init_slab_obj(struct kmem_cache *cache, const void *object)
543 struct kasan_alloc_meta *alloc_info;
545 if (!(cache->flags & SLAB_KASAN))
548 alloc_info = get_alloc_info(cache, object);
549 __memset(alloc_info, 0, sizeof(*alloc_info));
552 void kasan_slab_alloc(struct kmem_cache *cache, void *object, gfp_t flags)
554 kasan_kmalloc(cache, object, cache->object_size, flags);
557 static void kasan_poison_slab_free(struct kmem_cache *cache, void *object)
559 unsigned long size = cache->object_size;
560 unsigned long rounded_up_size = round_up(size, KASAN_SHADOW_SCALE_SIZE);
562 /* RCU slabs could be legally used after free within the RCU period */
563 if (unlikely(cache->flags & SLAB_DESTROY_BY_RCU))
566 kasan_poison_shadow(object, rounded_up_size, KASAN_KMALLOC_FREE);
569 bool kasan_slab_free(struct kmem_cache *cache, void *object)
573 /* RCU slabs could be legally used after free within the RCU period */
574 if (unlikely(cache->flags & SLAB_DESTROY_BY_RCU))
577 shadow_byte = READ_ONCE(*(s8 *)kasan_mem_to_shadow(object));
578 if (shadow_byte < 0 || shadow_byte >= KASAN_SHADOW_SCALE_SIZE) {
579 kasan_report_double_free(cache, object,
580 __builtin_return_address(1));
584 kasan_poison_slab_free(cache, object);
586 if (unlikely(!(cache->flags & SLAB_KASAN)))
589 set_track(&get_alloc_info(cache, object)->free_track, GFP_NOWAIT);
590 quarantine_put(get_free_info(cache, object), cache);
594 void kasan_kmalloc(struct kmem_cache *cache, const void *object, size_t size,
597 unsigned long redzone_start;
598 unsigned long redzone_end;
600 if (gfpflags_allow_blocking(flags))
603 if (unlikely(object == NULL))
606 redzone_start = round_up((unsigned long)(object + size),
607 KASAN_SHADOW_SCALE_SIZE);
608 redzone_end = round_up((unsigned long)object + cache->object_size,
609 KASAN_SHADOW_SCALE_SIZE);
611 kasan_unpoison_shadow(object, size);
612 kasan_poison_shadow((void *)redzone_start, redzone_end - redzone_start,
613 KASAN_KMALLOC_REDZONE);
615 if (cache->flags & SLAB_KASAN)
616 set_track(&get_alloc_info(cache, object)->alloc_track, flags);
618 EXPORT_SYMBOL(kasan_kmalloc);
620 void kasan_kmalloc_large(const void *ptr, size_t size, gfp_t flags)
623 unsigned long redzone_start;
624 unsigned long redzone_end;
626 if (gfpflags_allow_blocking(flags))
629 if (unlikely(ptr == NULL))
632 page = virt_to_page(ptr);
633 redzone_start = round_up((unsigned long)(ptr + size),
634 KASAN_SHADOW_SCALE_SIZE);
635 redzone_end = (unsigned long)ptr + (PAGE_SIZE << compound_order(page));
637 kasan_unpoison_shadow(ptr, size);
638 kasan_poison_shadow((void *)redzone_start, redzone_end - redzone_start,
642 void kasan_krealloc(const void *object, size_t size, gfp_t flags)
646 if (unlikely(object == ZERO_SIZE_PTR))
649 page = virt_to_head_page(object);
651 if (unlikely(!PageSlab(page)))
652 kasan_kmalloc_large(object, size, flags);
654 kasan_kmalloc(page->slab_cache, object, size, flags);
657 void kasan_poison_kfree(void *ptr)
661 page = virt_to_head_page(ptr);
663 if (unlikely(!PageSlab(page)))
664 kasan_poison_shadow(ptr, PAGE_SIZE << compound_order(page),
667 kasan_poison_slab_free(page->slab_cache, ptr);
670 void kasan_kfree_large(const void *ptr)
672 struct page *page = virt_to_page(ptr);
674 kasan_poison_shadow(ptr, PAGE_SIZE << compound_order(page),
678 int kasan_module_alloc(void *addr, size_t size)
683 unsigned long shadow_start;
685 shadow_start = (unsigned long)kasan_mem_to_shadow(addr);
686 scaled_size = (size + KASAN_SHADOW_MASK) >> KASAN_SHADOW_SCALE_SHIFT;
687 shadow_size = round_up(scaled_size, PAGE_SIZE);
689 if (WARN_ON(!PAGE_ALIGNED(shadow_start)))
692 ret = __vmalloc_node_range(shadow_size, 1, shadow_start,
693 shadow_start + shadow_size,
694 GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO,
695 PAGE_KERNEL, VM_NO_GUARD, NUMA_NO_NODE,
696 __builtin_return_address(0));
699 find_vm_area(addr)->flags |= VM_KASAN;
700 kmemleak_ignore(ret);
707 void kasan_free_shadow(const struct vm_struct *vm)
709 if (vm->flags & VM_KASAN)
710 vfree(kasan_mem_to_shadow(vm->addr));
713 static void register_global(struct kasan_global *global)
715 size_t aligned_size = round_up(global->size, KASAN_SHADOW_SCALE_SIZE);
717 kasan_unpoison_shadow(global->beg, global->size);
719 kasan_poison_shadow(global->beg + aligned_size,
720 global->size_with_redzone - aligned_size,
721 KASAN_GLOBAL_REDZONE);
724 void __asan_register_globals(struct kasan_global *globals, size_t size)
728 for (i = 0; i < size; i++)
729 register_global(&globals[i]);
731 EXPORT_SYMBOL(__asan_register_globals);
733 void __asan_unregister_globals(struct kasan_global *globals, size_t size)
736 EXPORT_SYMBOL(__asan_unregister_globals);
738 #define DEFINE_ASAN_LOAD_STORE(size) \
739 void __asan_load##size(unsigned long addr) \
741 check_memory_region_inline(addr, size, false, _RET_IP_);\
743 EXPORT_SYMBOL(__asan_load##size); \
744 __alias(__asan_load##size) \
745 void __asan_load##size##_noabort(unsigned long); \
746 EXPORT_SYMBOL(__asan_load##size##_noabort); \
747 void __asan_store##size(unsigned long addr) \
749 check_memory_region_inline(addr, size, true, _RET_IP_); \
751 EXPORT_SYMBOL(__asan_store##size); \
752 __alias(__asan_store##size) \
753 void __asan_store##size##_noabort(unsigned long); \
754 EXPORT_SYMBOL(__asan_store##size##_noabort)
756 DEFINE_ASAN_LOAD_STORE(1);
757 DEFINE_ASAN_LOAD_STORE(2);
758 DEFINE_ASAN_LOAD_STORE(4);
759 DEFINE_ASAN_LOAD_STORE(8);
760 DEFINE_ASAN_LOAD_STORE(16);
762 void __asan_loadN(unsigned long addr, size_t size)
764 check_memory_region(addr, size, false, _RET_IP_);
766 EXPORT_SYMBOL(__asan_loadN);
768 __alias(__asan_loadN)
769 void __asan_loadN_noabort(unsigned long, size_t);
770 EXPORT_SYMBOL(__asan_loadN_noabort);
772 void __asan_storeN(unsigned long addr, size_t size)
774 check_memory_region(addr, size, true, _RET_IP_);
776 EXPORT_SYMBOL(__asan_storeN);
778 __alias(__asan_storeN)
779 void __asan_storeN_noabort(unsigned long, size_t);
780 EXPORT_SYMBOL(__asan_storeN_noabort);
782 /* to shut up compiler complaints */
783 void __asan_handle_no_return(void) {}
784 EXPORT_SYMBOL(__asan_handle_no_return);
786 /* Emitted by compiler to poison large objects when they go out of scope. */
787 void __asan_poison_stack_memory(const void *addr, size_t size)
790 * Addr is KASAN_SHADOW_SCALE_SIZE-aligned and the object is surrounded
791 * by redzones, so we simply round up size to simplify logic.
793 kasan_poison_shadow(addr, round_up(size, KASAN_SHADOW_SCALE_SIZE),
794 KASAN_USE_AFTER_SCOPE);
796 EXPORT_SYMBOL(__asan_poison_stack_memory);
798 /* Emitted by compiler to unpoison large objects when they go into scope. */
799 void __asan_unpoison_stack_memory(const void *addr, size_t size)
801 kasan_unpoison_shadow(addr, size);
803 EXPORT_SYMBOL(__asan_unpoison_stack_memory);
805 #ifdef CONFIG_MEMORY_HOTPLUG
806 static int kasan_mem_notifier(struct notifier_block *nb,
807 unsigned long action, void *data)
809 return (action == MEM_GOING_ONLINE) ? NOTIFY_BAD : NOTIFY_OK;
812 static int __init kasan_memhotplug_init(void)
814 pr_info("WARNING: KASAN doesn't support memory hot-add\n");
815 pr_info("Memory hot-add will be disabled\n");
817 hotplug_memory_notifier(kasan_mem_notifier, 0);
822 core_initcall(kasan_memhotplug_init);