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/init.h>
21 #include <linux/kernel.h>
22 #include <linux/kmemleak.h>
23 #include <linux/memblock.h>
24 #include <linux/memory.h>
26 #include <linux/module.h>
27 #include <linux/printk.h>
28 #include <linux/sched.h>
29 #include <linux/slab.h>
30 #include <linux/stacktrace.h>
31 #include <linux/string.h>
32 #include <linux/types.h>
33 #include <linux/vmalloc.h>
34 #include <linux/kasan.h>
40 * Poisons the shadow memory for 'size' bytes starting from 'addr'.
41 * Memory addresses should be aligned to KASAN_SHADOW_SCALE_SIZE.
43 static void kasan_poison_shadow(const void *address
, size_t size
, u8 value
)
45 void *shadow_start
, *shadow_end
;
47 shadow_start
= kasan_mem_to_shadow(address
);
48 shadow_end
= kasan_mem_to_shadow(address
+ size
);
50 memset(shadow_start
, value
, shadow_end
- shadow_start
);
53 void kasan_unpoison_shadow(const void *address
, size_t size
)
55 kasan_poison_shadow(address
, size
, 0);
57 if (size
& KASAN_SHADOW_MASK
) {
58 u8
*shadow
= (u8
*)kasan_mem_to_shadow(address
+ size
);
59 *shadow
= size
& KASAN_SHADOW_MASK
;
65 * All functions below always inlined so compiler could
66 * perform better optimizations in each of __asan_loadX/__assn_storeX
67 * depending on memory access size X.
70 static __always_inline
bool memory_is_poisoned_1(unsigned long addr
)
72 s8 shadow_value
= *(s8
*)kasan_mem_to_shadow((void *)addr
);
74 if (unlikely(shadow_value
)) {
75 s8 last_accessible_byte
= addr
& KASAN_SHADOW_MASK
;
76 return unlikely(last_accessible_byte
>= shadow_value
);
82 static __always_inline
bool memory_is_poisoned_2(unsigned long addr
)
84 u16
*shadow_addr
= (u16
*)kasan_mem_to_shadow((void *)addr
);
86 if (unlikely(*shadow_addr
)) {
87 if (memory_is_poisoned_1(addr
+ 1))
91 * If single shadow byte covers 2-byte access, we don't
92 * need to do anything more. Otherwise, test the first
95 if (likely(((addr
+ 1) & KASAN_SHADOW_MASK
) != 0))
98 return unlikely(*(u8
*)shadow_addr
);
104 static __always_inline
bool memory_is_poisoned_4(unsigned long addr
)
106 u16
*shadow_addr
= (u16
*)kasan_mem_to_shadow((void *)addr
);
108 if (unlikely(*shadow_addr
)) {
109 if (memory_is_poisoned_1(addr
+ 3))
113 * If single shadow byte covers 4-byte access, we don't
114 * need to do anything more. Otherwise, test the first
117 if (likely(((addr
+ 3) & KASAN_SHADOW_MASK
) >= 3))
120 return unlikely(*(u8
*)shadow_addr
);
126 static __always_inline
bool memory_is_poisoned_8(unsigned long addr
)
128 u16
*shadow_addr
= (u16
*)kasan_mem_to_shadow((void *)addr
);
130 if (unlikely(*shadow_addr
)) {
131 if (memory_is_poisoned_1(addr
+ 7))
135 * If single shadow byte covers 8-byte access, we don't
136 * need to do anything more. Otherwise, test the first
139 if (likely(IS_ALIGNED(addr
, KASAN_SHADOW_SCALE_SIZE
)))
142 return unlikely(*(u8
*)shadow_addr
);
148 static __always_inline
bool memory_is_poisoned_16(unsigned long addr
)
150 u32
*shadow_addr
= (u32
*)kasan_mem_to_shadow((void *)addr
);
152 if (unlikely(*shadow_addr
)) {
153 u16 shadow_first_bytes
= *(u16
*)shadow_addr
;
155 if (unlikely(shadow_first_bytes
))
159 * If two shadow bytes covers 16-byte access, we don't
160 * need to do anything more. Otherwise, test the last
163 if (likely(IS_ALIGNED(addr
, KASAN_SHADOW_SCALE_SIZE
)))
166 return memory_is_poisoned_1(addr
+ 15);
172 static __always_inline
unsigned long bytes_is_zero(const u8
*start
,
176 if (unlikely(*start
))
177 return (unsigned long)start
;
185 static __always_inline
unsigned long memory_is_zero(const void *start
,
190 unsigned int prefix
= (unsigned long)start
% 8;
192 if (end
- start
<= 16)
193 return bytes_is_zero(start
, end
- start
);
197 ret
= bytes_is_zero(start
, prefix
);
203 words
= (end
- start
) / 8;
205 if (unlikely(*(u64
*)start
))
206 return bytes_is_zero(start
, 8);
211 return bytes_is_zero(start
, (end
- start
) % 8);
214 static __always_inline
bool memory_is_poisoned_n(unsigned long addr
,
219 ret
= memory_is_zero(kasan_mem_to_shadow((void *)addr
),
220 kasan_mem_to_shadow((void *)addr
+ size
- 1) + 1);
223 unsigned long last_byte
= addr
+ size
- 1;
224 s8
*last_shadow
= (s8
*)kasan_mem_to_shadow((void *)last_byte
);
226 if (unlikely(ret
!= (unsigned long)last_shadow
||
227 ((long)(last_byte
& KASAN_SHADOW_MASK
) >= *last_shadow
)))
233 static __always_inline
bool memory_is_poisoned(unsigned long addr
, size_t size
)
235 if (__builtin_constant_p(size
)) {
238 return memory_is_poisoned_1(addr
);
240 return memory_is_poisoned_2(addr
);
242 return memory_is_poisoned_4(addr
);
244 return memory_is_poisoned_8(addr
);
246 return memory_is_poisoned_16(addr
);
252 return memory_is_poisoned_n(addr
, size
);
255 static __always_inline
void check_memory_region_inline(unsigned long addr
,
256 size_t size
, bool write
,
257 unsigned long ret_ip
)
259 if (unlikely(size
== 0))
262 if (unlikely((void *)addr
<
263 kasan_shadow_to_mem((void *)KASAN_SHADOW_START
))) {
264 kasan_report(addr
, size
, write
, ret_ip
);
268 if (likely(!memory_is_poisoned(addr
, size
)))
271 kasan_report(addr
, size
, write
, ret_ip
);
274 static void check_memory_region(unsigned long addr
,
275 size_t size
, bool write
,
276 unsigned long ret_ip
)
278 check_memory_region_inline(addr
, size
, write
, ret_ip
);
281 void kasan_check_read(const void *p
, unsigned int size
)
283 check_memory_region((unsigned long)p
, size
, false, _RET_IP_
);
285 EXPORT_SYMBOL(kasan_check_read
);
287 void kasan_check_write(const void *p
, unsigned int size
)
289 check_memory_region((unsigned long)p
, size
, true, _RET_IP_
);
291 EXPORT_SYMBOL(kasan_check_write
);
294 void *memset(void *addr
, int c
, size_t len
)
296 check_memory_region((unsigned long)addr
, len
, true, _RET_IP_
);
298 return __memset(addr
, c
, len
);
302 void *memmove(void *dest
, const void *src
, size_t len
)
304 check_memory_region((unsigned long)src
, len
, false, _RET_IP_
);
305 check_memory_region((unsigned long)dest
, len
, true, _RET_IP_
);
307 return __memmove(dest
, src
, len
);
311 void *memcpy(void *dest
, const void *src
, size_t len
)
313 check_memory_region((unsigned long)src
, len
, false, _RET_IP_
);
314 check_memory_region((unsigned long)dest
, len
, true, _RET_IP_
);
316 return __memcpy(dest
, src
, len
);
319 void kasan_alloc_pages(struct page
*page
, unsigned int order
)
321 if (likely(!PageHighMem(page
)))
322 kasan_unpoison_shadow(page_address(page
), PAGE_SIZE
<< order
);
325 void kasan_free_pages(struct page
*page
, unsigned int order
)
327 if (likely(!PageHighMem(page
)))
328 kasan_poison_shadow(page_address(page
),
333 void kasan_poison_slab(struct page
*page
)
335 kasan_poison_shadow(page_address(page
),
336 PAGE_SIZE
<< compound_order(page
),
337 KASAN_KMALLOC_REDZONE
);
340 void kasan_unpoison_object_data(struct kmem_cache
*cache
, void *object
)
342 kasan_unpoison_shadow(object
, cache
->object_size
);
345 void kasan_poison_object_data(struct kmem_cache
*cache
, void *object
)
347 kasan_poison_shadow(object
,
348 round_up(cache
->object_size
, KASAN_SHADOW_SCALE_SIZE
),
349 KASAN_KMALLOC_REDZONE
);
352 void kasan_slab_alloc(struct kmem_cache
*cache
, void *object
)
354 kasan_kmalloc(cache
, object
, cache
->object_size
);
357 void kasan_slab_free(struct kmem_cache
*cache
, void *object
)
359 unsigned long size
= cache
->object_size
;
360 unsigned long rounded_up_size
= round_up(size
, KASAN_SHADOW_SCALE_SIZE
);
362 /* RCU slabs could be legally used after free within the RCU period */
363 if (unlikely(cache
->flags
& SLAB_DESTROY_BY_RCU
))
366 kasan_poison_shadow(object
, rounded_up_size
, KASAN_KMALLOC_FREE
);
369 void kasan_kmalloc(struct kmem_cache
*cache
, const void *object
, size_t size
)
371 unsigned long redzone_start
;
372 unsigned long redzone_end
;
374 if (unlikely(object
== NULL
))
377 redzone_start
= round_up((unsigned long)(object
+ size
),
378 KASAN_SHADOW_SCALE_SIZE
);
379 redzone_end
= round_up((unsigned long)object
+ cache
->object_size
,
380 KASAN_SHADOW_SCALE_SIZE
);
382 kasan_unpoison_shadow(object
, size
);
383 kasan_poison_shadow((void *)redzone_start
, redzone_end
- redzone_start
,
384 KASAN_KMALLOC_REDZONE
);
386 EXPORT_SYMBOL(kasan_kmalloc
);
388 void kasan_kmalloc_large(const void *ptr
, size_t size
)
391 unsigned long redzone_start
;
392 unsigned long redzone_end
;
394 if (unlikely(ptr
== NULL
))
397 page
= virt_to_page(ptr
);
398 redzone_start
= round_up((unsigned long)(ptr
+ size
),
399 KASAN_SHADOW_SCALE_SIZE
);
400 redzone_end
= (unsigned long)ptr
+ (PAGE_SIZE
<< compound_order(page
));
402 kasan_unpoison_shadow(ptr
, size
);
403 kasan_poison_shadow((void *)redzone_start
, redzone_end
- redzone_start
,
407 void kasan_krealloc(const void *object
, size_t size
)
411 if (unlikely(object
== ZERO_SIZE_PTR
))
414 page
= virt_to_head_page(object
);
416 if (unlikely(!PageSlab(page
)))
417 kasan_kmalloc_large(object
, size
);
419 kasan_kmalloc(page
->slab_cache
, object
, size
);
422 void kasan_kfree(void *ptr
)
426 page
= virt_to_head_page(ptr
);
428 if (unlikely(!PageSlab(page
)))
429 kasan_poison_shadow(ptr
, PAGE_SIZE
<< compound_order(page
),
432 kasan_slab_free(page
->slab_cache
, ptr
);
435 void kasan_kfree_large(const void *ptr
)
437 struct page
*page
= virt_to_page(ptr
);
439 kasan_poison_shadow(ptr
, PAGE_SIZE
<< compound_order(page
),
443 int kasan_module_alloc(void *addr
, size_t size
)
448 unsigned long shadow_start
;
450 shadow_start
= (unsigned long)kasan_mem_to_shadow(addr
);
451 scaled_size
= (size
+ KASAN_SHADOW_MASK
) >> KASAN_SHADOW_SCALE_SHIFT
;
452 shadow_size
= round_up(scaled_size
, PAGE_SIZE
);
454 if (WARN_ON(!PAGE_ALIGNED(shadow_start
)))
457 ret
= __vmalloc_node_range(shadow_size
, 1, shadow_start
,
458 shadow_start
+ shadow_size
,
459 GFP_KERNEL
| __GFP_HIGHMEM
| __GFP_ZERO
,
460 PAGE_KERNEL
, VM_NO_GUARD
, NUMA_NO_NODE
,
461 __builtin_return_address(0));
464 find_vm_area(addr
)->flags
|= VM_KASAN
;
465 kmemleak_ignore(ret
);
472 void kasan_free_shadow(const struct vm_struct
*vm
)
474 if (vm
->flags
& VM_KASAN
)
475 vfree(kasan_mem_to_shadow(vm
->addr
));
478 static void register_global(struct kasan_global
*global
)
480 size_t aligned_size
= round_up(global
->size
, KASAN_SHADOW_SCALE_SIZE
);
482 kasan_unpoison_shadow(global
->beg
, global
->size
);
484 kasan_poison_shadow(global
->beg
+ aligned_size
,
485 global
->size_with_redzone
- aligned_size
,
486 KASAN_GLOBAL_REDZONE
);
489 void __asan_register_globals(struct kasan_global
*globals
, size_t size
)
493 for (i
= 0; i
< size
; i
++)
494 register_global(&globals
[i
]);
496 EXPORT_SYMBOL(__asan_register_globals
);
498 void __asan_unregister_globals(struct kasan_global
*globals
, size_t size
)
501 EXPORT_SYMBOL(__asan_unregister_globals
);
503 #define DEFINE_ASAN_LOAD_STORE(size) \
504 void __asan_load##size(unsigned long addr) \
506 check_memory_region_inline(addr, size, false, _RET_IP_);\
508 EXPORT_SYMBOL(__asan_load##size); \
509 __alias(__asan_load##size) \
510 void __asan_load##size##_noabort(unsigned long); \
511 EXPORT_SYMBOL(__asan_load##size##_noabort); \
512 void __asan_store##size(unsigned long addr) \
514 check_memory_region_inline(addr, size, true, _RET_IP_); \
516 EXPORT_SYMBOL(__asan_store##size); \
517 __alias(__asan_store##size) \
518 void __asan_store##size##_noabort(unsigned long); \
519 EXPORT_SYMBOL(__asan_store##size##_noabort)
521 DEFINE_ASAN_LOAD_STORE(1);
522 DEFINE_ASAN_LOAD_STORE(2);
523 DEFINE_ASAN_LOAD_STORE(4);
524 DEFINE_ASAN_LOAD_STORE(8);
525 DEFINE_ASAN_LOAD_STORE(16);
527 void __asan_loadN(unsigned long addr
, size_t size
)
529 check_memory_region(addr
, size
, false, _RET_IP_
);
531 EXPORT_SYMBOL(__asan_loadN
);
533 __alias(__asan_loadN
)
534 void __asan_loadN_noabort(unsigned long, size_t);
535 EXPORT_SYMBOL(__asan_loadN_noabort
);
537 void __asan_storeN(unsigned long addr
, size_t size
)
539 check_memory_region(addr
, size
, true, _RET_IP_
);
541 EXPORT_SYMBOL(__asan_storeN
);
543 __alias(__asan_storeN
)
544 void __asan_storeN_noabort(unsigned long, size_t);
545 EXPORT_SYMBOL(__asan_storeN_noabort
);
547 /* to shut up compiler complaints */
548 void __asan_handle_no_return(void) {}
549 EXPORT_SYMBOL(__asan_handle_no_return
);
551 #ifdef CONFIG_MEMORY_HOTPLUG
552 static int kasan_mem_notifier(struct notifier_block
*nb
,
553 unsigned long action
, void *data
)
555 return (action
== MEM_GOING_ONLINE
) ? NOTIFY_BAD
: NOTIFY_OK
;
558 static int __init
kasan_memhotplug_init(void)
560 pr_err("WARNING: KASAN doesn't support memory hot-add\n");
561 pr_err("Memory hot-add will be disabled\n");
563 hotplug_memory_notifier(kasan_mem_notifier
, 0);
568 core_initcall(kasan_memhotplug_init
);