2 * This file contains core KASAN 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 <andreyknvl@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/sched/task_stack.h>
33 #include <linux/slab.h>
34 #include <linux/stacktrace.h>
35 #include <linux/string.h>
36 #include <linux/types.h>
37 #include <linux/vmalloc.h>
38 #include <linux/bug.h>
44 * All functions below always inlined so compiler could
45 * perform better optimizations in each of __asan_loadX/__assn_storeX
46 * depending on memory access size X.
49 static __always_inline
bool memory_is_poisoned_1(unsigned long addr
)
51 s8 shadow_value
= *(s8
*)kasan_mem_to_shadow((void *)addr
);
53 if (unlikely(shadow_value
)) {
54 s8 last_accessible_byte
= addr
& KASAN_SHADOW_MASK
;
55 return unlikely(last_accessible_byte
>= shadow_value
);
61 static __always_inline
bool memory_is_poisoned_2_4_8(unsigned long addr
,
64 u8
*shadow_addr
= (u8
*)kasan_mem_to_shadow((void *)addr
);
67 * Access crosses 8(shadow size)-byte boundary. Such access maps
68 * into 2 shadow bytes, so we need to check them both.
70 if (unlikely(((addr
+ size
- 1) & KASAN_SHADOW_MASK
) < size
- 1))
71 return *shadow_addr
|| memory_is_poisoned_1(addr
+ size
- 1);
73 return memory_is_poisoned_1(addr
+ size
- 1);
76 static __always_inline
bool memory_is_poisoned_16(unsigned long addr
)
78 u16
*shadow_addr
= (u16
*)kasan_mem_to_shadow((void *)addr
);
80 /* Unaligned 16-bytes access maps into 3 shadow bytes. */
81 if (unlikely(!IS_ALIGNED(addr
, KASAN_SHADOW_SCALE_SIZE
)))
82 return *shadow_addr
|| memory_is_poisoned_1(addr
+ 15);
87 static __always_inline
unsigned long bytes_is_nonzero(const u8
*start
,
92 return (unsigned long)start
;
100 static __always_inline
unsigned long memory_is_nonzero(const void *start
,
105 unsigned int prefix
= (unsigned long)start
% 8;
107 if (end
- start
<= 16)
108 return bytes_is_nonzero(start
, end
- start
);
112 ret
= bytes_is_nonzero(start
, prefix
);
118 words
= (end
- start
) / 8;
120 if (unlikely(*(u64
*)start
))
121 return bytes_is_nonzero(start
, 8);
126 return bytes_is_nonzero(start
, (end
- start
) % 8);
129 static __always_inline
bool memory_is_poisoned_n(unsigned long addr
,
134 ret
= memory_is_nonzero(kasan_mem_to_shadow((void *)addr
),
135 kasan_mem_to_shadow((void *)addr
+ size
- 1) + 1);
138 unsigned long last_byte
= addr
+ size
- 1;
139 s8
*last_shadow
= (s8
*)kasan_mem_to_shadow((void *)last_byte
);
141 if (unlikely(ret
!= (unsigned long)last_shadow
||
142 ((long)(last_byte
& KASAN_SHADOW_MASK
) >= *last_shadow
)))
148 static __always_inline
bool memory_is_poisoned(unsigned long addr
, size_t size
)
150 if (__builtin_constant_p(size
)) {
153 return memory_is_poisoned_1(addr
);
157 return memory_is_poisoned_2_4_8(addr
, size
);
159 return memory_is_poisoned_16(addr
);
165 return memory_is_poisoned_n(addr
, size
);
168 static __always_inline
void check_memory_region_inline(unsigned long addr
,
169 size_t size
, bool write
,
170 unsigned long ret_ip
)
172 if (unlikely(size
== 0))
175 if (unlikely((void *)addr
<
176 kasan_shadow_to_mem((void *)KASAN_SHADOW_START
))) {
177 kasan_report(addr
, size
, write
, ret_ip
);
181 if (likely(!memory_is_poisoned(addr
, size
)))
184 kasan_report(addr
, size
, write
, ret_ip
);
187 void check_memory_region(unsigned long addr
, size_t size
, bool write
,
188 unsigned long ret_ip
)
190 check_memory_region_inline(addr
, size
, write
, ret_ip
);
193 void kasan_cache_shrink(struct kmem_cache
*cache
)
195 quarantine_remove_cache(cache
);
198 void kasan_cache_shutdown(struct kmem_cache
*cache
)
200 if (!__kmem_cache_empty(cache
))
201 quarantine_remove_cache(cache
);
204 static void register_global(struct kasan_global
*global
)
206 size_t aligned_size
= round_up(global
->size
, KASAN_SHADOW_SCALE_SIZE
);
208 kasan_unpoison_shadow(global
->beg
, global
->size
);
210 kasan_poison_shadow(global
->beg
+ aligned_size
,
211 global
->size_with_redzone
- aligned_size
,
212 KASAN_GLOBAL_REDZONE
);
215 void __asan_register_globals(struct kasan_global
*globals
, size_t size
)
219 for (i
= 0; i
< size
; i
++)
220 register_global(&globals
[i
]);
222 EXPORT_SYMBOL(__asan_register_globals
);
224 void __asan_unregister_globals(struct kasan_global
*globals
, size_t size
)
227 EXPORT_SYMBOL(__asan_unregister_globals
);
229 #define DEFINE_ASAN_LOAD_STORE(size) \
230 void __asan_load##size(unsigned long addr) \
232 check_memory_region_inline(addr, size, false, _RET_IP_);\
234 EXPORT_SYMBOL(__asan_load##size); \
235 __alias(__asan_load##size) \
236 void __asan_load##size##_noabort(unsigned long); \
237 EXPORT_SYMBOL(__asan_load##size##_noabort); \
238 void __asan_store##size(unsigned long addr) \
240 check_memory_region_inline(addr, size, true, _RET_IP_); \
242 EXPORT_SYMBOL(__asan_store##size); \
243 __alias(__asan_store##size) \
244 void __asan_store##size##_noabort(unsigned long); \
245 EXPORT_SYMBOL(__asan_store##size##_noabort)
247 DEFINE_ASAN_LOAD_STORE(1);
248 DEFINE_ASAN_LOAD_STORE(2);
249 DEFINE_ASAN_LOAD_STORE(4);
250 DEFINE_ASAN_LOAD_STORE(8);
251 DEFINE_ASAN_LOAD_STORE(16);
253 void __asan_loadN(unsigned long addr
, size_t size
)
255 check_memory_region(addr
, size
, false, _RET_IP_
);
257 EXPORT_SYMBOL(__asan_loadN
);
259 __alias(__asan_loadN
)
260 void __asan_loadN_noabort(unsigned long, size_t);
261 EXPORT_SYMBOL(__asan_loadN_noabort
);
263 void __asan_storeN(unsigned long addr
, size_t size
)
265 check_memory_region(addr
, size
, true, _RET_IP_
);
267 EXPORT_SYMBOL(__asan_storeN
);
269 __alias(__asan_storeN
)
270 void __asan_storeN_noabort(unsigned long, size_t);
271 EXPORT_SYMBOL(__asan_storeN_noabort
);
273 /* to shut up compiler complaints */
274 void __asan_handle_no_return(void) {}
275 EXPORT_SYMBOL(__asan_handle_no_return
);
277 /* Emitted by compiler to poison large objects when they go out of scope. */
278 void __asan_poison_stack_memory(const void *addr
, size_t size
)
281 * Addr is KASAN_SHADOW_SCALE_SIZE-aligned and the object is surrounded
282 * by redzones, so we simply round up size to simplify logic.
284 kasan_poison_shadow(addr
, round_up(size
, KASAN_SHADOW_SCALE_SIZE
),
285 KASAN_USE_AFTER_SCOPE
);
287 EXPORT_SYMBOL(__asan_poison_stack_memory
);
289 /* Emitted by compiler to unpoison large objects when they go into scope. */
290 void __asan_unpoison_stack_memory(const void *addr
, size_t size
)
292 kasan_unpoison_shadow(addr
, size
);
294 EXPORT_SYMBOL(__asan_unpoison_stack_memory
);
296 /* Emitted by compiler to poison alloca()ed objects. */
297 void __asan_alloca_poison(unsigned long addr
, size_t size
)
299 size_t rounded_up_size
= round_up(size
, KASAN_SHADOW_SCALE_SIZE
);
300 size_t padding_size
= round_up(size
, KASAN_ALLOCA_REDZONE_SIZE
) -
302 size_t rounded_down_size
= round_down(size
, KASAN_SHADOW_SCALE_SIZE
);
304 const void *left_redzone
= (const void *)(addr
-
305 KASAN_ALLOCA_REDZONE_SIZE
);
306 const void *right_redzone
= (const void *)(addr
+ rounded_up_size
);
308 WARN_ON(!IS_ALIGNED(addr
, KASAN_ALLOCA_REDZONE_SIZE
));
310 kasan_unpoison_shadow((const void *)(addr
+ rounded_down_size
),
311 size
- rounded_down_size
);
312 kasan_poison_shadow(left_redzone
, KASAN_ALLOCA_REDZONE_SIZE
,
314 kasan_poison_shadow(right_redzone
,
315 padding_size
+ KASAN_ALLOCA_REDZONE_SIZE
,
318 EXPORT_SYMBOL(__asan_alloca_poison
);
320 /* Emitted by compiler to unpoison alloca()ed areas when the stack unwinds. */
321 void __asan_allocas_unpoison(const void *stack_top
, const void *stack_bottom
)
323 if (unlikely(!stack_top
|| stack_top
> stack_bottom
))
326 kasan_unpoison_shadow(stack_top
, stack_bottom
- stack_top
);
328 EXPORT_SYMBOL(__asan_allocas_unpoison
);
330 /* Emitted by the compiler to [un]poison local variables. */
331 #define DEFINE_ASAN_SET_SHADOW(byte) \
332 void __asan_set_shadow_##byte(const void *addr, size_t size) \
334 __memset((void *)addr, 0x##byte, size); \
336 EXPORT_SYMBOL(__asan_set_shadow_##byte)
338 DEFINE_ASAN_SET_SHADOW(00);
339 DEFINE_ASAN_SET_SHADOW(f1
);
340 DEFINE_ASAN_SET_SHADOW(f2
);
341 DEFINE_ASAN_SET_SHADOW(f3
);
342 DEFINE_ASAN_SET_SHADOW(f5
);
343 DEFINE_ASAN_SET_SHADOW(f8
);