159fd51b2SAndrey Konovalov // SPDX-License-Identifier: GPL-2.0
259fd51b2SAndrey Konovalov /*
32e903b91SAndrey Konovalov * This file contains core software tag-based KASAN code.
459fd51b2SAndrey Konovalov *
559fd51b2SAndrey Konovalov * Copyright (c) 2018 Google, Inc.
659fd51b2SAndrey Konovalov * Author: Andrey Konovalov <andreyknvl@google.com>
759fd51b2SAndrey Konovalov */
859fd51b2SAndrey Konovalov
928ab3584SAndrey Konovalov #define pr_fmt(fmt) "kasan: " fmt
1059fd51b2SAndrey Konovalov
1159fd51b2SAndrey Konovalov #include <linux/export.h>
1259fd51b2SAndrey Konovalov #include <linux/interrupt.h>
1359fd51b2SAndrey Konovalov #include <linux/init.h>
1459fd51b2SAndrey Konovalov #include <linux/kasan.h>
1559fd51b2SAndrey Konovalov #include <linux/kernel.h>
1659fd51b2SAndrey Konovalov #include <linux/kmemleak.h>
1759fd51b2SAndrey Konovalov #include <linux/linkage.h>
1859fd51b2SAndrey Konovalov #include <linux/memblock.h>
1959fd51b2SAndrey Konovalov #include <linux/memory.h>
2059fd51b2SAndrey Konovalov #include <linux/mm.h>
2159fd51b2SAndrey Konovalov #include <linux/module.h>
2259fd51b2SAndrey Konovalov #include <linux/printk.h>
2359fd51b2SAndrey Konovalov #include <linux/random.h>
2459fd51b2SAndrey Konovalov #include <linux/sched.h>
2559fd51b2SAndrey Konovalov #include <linux/sched/task_stack.h>
2659fd51b2SAndrey Konovalov #include <linux/slab.h>
2759fd51b2SAndrey Konovalov #include <linux/stacktrace.h>
2859fd51b2SAndrey Konovalov #include <linux/string.h>
2959fd51b2SAndrey Konovalov #include <linux/types.h>
3059fd51b2SAndrey Konovalov #include <linux/vmalloc.h>
3159fd51b2SAndrey Konovalov #include <linux/bug.h>
3259fd51b2SAndrey Konovalov
3359fd51b2SAndrey Konovalov #include "kasan.h"
3459fd51b2SAndrey Konovalov #include "../slab.h"
3559fd51b2SAndrey Konovalov
3659fd51b2SAndrey Konovalov static DEFINE_PER_CPU(u32, prng_state);
3759fd51b2SAndrey Konovalov
kasan_init_sw_tags(void)3860a3a5feSAndrey Konovalov void __init kasan_init_sw_tags(void)
3959fd51b2SAndrey Konovalov {
4059fd51b2SAndrey Konovalov int cpu;
4159fd51b2SAndrey Konovalov
4259fd51b2SAndrey Konovalov for_each_possible_cpu(cpu)
4359fd51b2SAndrey Konovalov per_cpu(prng_state, cpu) = (u32)get_cycles();
4428ab3584SAndrey Konovalov
457ebfce33SAndrey Konovalov kasan_init_tags();
467ebfce33SAndrey Konovalov
477ebfce33SAndrey Konovalov pr_info("KernelAddressSanitizer initialized (sw-tags, stacktrace=%s)\n",
487ebfce33SAndrey Konovalov kasan_stack_collection_enabled() ? "on" : "off");
4959fd51b2SAndrey Konovalov }
5059fd51b2SAndrey Konovalov
5159fd51b2SAndrey Konovalov /*
5259fd51b2SAndrey Konovalov * If a preemption happens between this_cpu_read and this_cpu_write, the only
5359fd51b2SAndrey Konovalov * side effect is that we'll give a few allocated in different contexts objects
5459fd51b2SAndrey Konovalov * the same tag. Since tag-based KASAN is meant to be used a probabilistic
5559fd51b2SAndrey Konovalov * bug-detection debug feature, this doesn't have significant negative impact.
5659fd51b2SAndrey Konovalov *
5759fd51b2SAndrey Konovalov * Ideally the tags use strong randomness to prevent any attempts to predict
5859fd51b2SAndrey Konovalov * them during explicit exploit attempts. But strong randomness is expensive,
5959fd51b2SAndrey Konovalov * and we did an intentional trade-off to use a PRNG. This non-atomic RMW
6059fd51b2SAndrey Konovalov * sequence has in fact positive effect, since interrupts that randomly skew
6159fd51b2SAndrey Konovalov * PRNG at unpredictable points do only good.
6259fd51b2SAndrey Konovalov */
kasan_random_tag(void)63f00748bfSAndrey Konovalov u8 kasan_random_tag(void)
6459fd51b2SAndrey Konovalov {
6559fd51b2SAndrey Konovalov u32 state = this_cpu_read(prng_state);
6659fd51b2SAndrey Konovalov
6759fd51b2SAndrey Konovalov state = 1664525 * state + 1013904223;
6859fd51b2SAndrey Konovalov this_cpu_write(prng_state, state);
6959fd51b2SAndrey Konovalov
7059fd51b2SAndrey Konovalov return (u8)(state % (KASAN_TAG_MAX + 1));
7159fd51b2SAndrey Konovalov }
7259fd51b2SAndrey Konovalov
kasan_check_range(const void * addr,size_t size,bool write,unsigned long ret_ip)73*bb6e04a1SArnd Bergmann bool kasan_check_range(const void *addr, size_t size, bool write,
7459fd51b2SAndrey Konovalov unsigned long ret_ip)
7559fd51b2SAndrey Konovalov {
7659fd51b2SAndrey Konovalov u8 tag;
7759fd51b2SAndrey Konovalov u8 *shadow_first, *shadow_last, *shadow;
7859fd51b2SAndrey Konovalov void *untagged_addr;
7959fd51b2SAndrey Konovalov
8059fd51b2SAndrey Konovalov if (unlikely(size == 0))
8159fd51b2SAndrey Konovalov return true;
8259fd51b2SAndrey Konovalov
8359fd51b2SAndrey Konovalov if (unlikely(addr + size < addr))
8459fd51b2SAndrey Konovalov return !kasan_report(addr, size, write, ret_ip);
8559fd51b2SAndrey Konovalov
8659fd51b2SAndrey Konovalov tag = get_tag((const void *)addr);
8759fd51b2SAndrey Konovalov
8859fd51b2SAndrey Konovalov /*
8959fd51b2SAndrey Konovalov * Ignore accesses for pointers tagged with 0xff (native kernel
9059fd51b2SAndrey Konovalov * pointer tag) to suppress false positives caused by kmap.
9159fd51b2SAndrey Konovalov *
9259fd51b2SAndrey Konovalov * Some kernel code was written to account for archs that don't keep
9359fd51b2SAndrey Konovalov * high memory mapped all the time, but rather map and unmap particular
9459fd51b2SAndrey Konovalov * pages when needed. Instead of storing a pointer to the kernel memory,
9559fd51b2SAndrey Konovalov * this code saves the address of the page structure and offset within
9659fd51b2SAndrey Konovalov * that page for later use. Those pages are then mapped and unmapped
9759fd51b2SAndrey Konovalov * with kmap/kunmap when necessary and virt_to_page is used to get the
9859fd51b2SAndrey Konovalov * virtual address of the page. For arm64 (that keeps the high memory
9959fd51b2SAndrey Konovalov * mapped all the time), kmap is turned into a page_address call.
10059fd51b2SAndrey Konovalov
10159fd51b2SAndrey Konovalov * The issue is that with use of the page_address + virt_to_page
10259fd51b2SAndrey Konovalov * sequence the top byte value of the original pointer gets lost (gets
10359fd51b2SAndrey Konovalov * set to KASAN_TAG_KERNEL (0xFF)).
10459fd51b2SAndrey Konovalov */
10559fd51b2SAndrey Konovalov if (tag == KASAN_TAG_KERNEL)
10659fd51b2SAndrey Konovalov return true;
10759fd51b2SAndrey Konovalov
108c0054c56SAndrey Konovalov untagged_addr = kasan_reset_tag((const void *)addr);
1098f17febbSKuan-Ying Lee if (unlikely(!addr_has_metadata(untagged_addr)))
11059fd51b2SAndrey Konovalov return !kasan_report(addr, size, write, ret_ip);
11159fd51b2SAndrey Konovalov shadow_first = kasan_mem_to_shadow(untagged_addr);
11259fd51b2SAndrey Konovalov shadow_last = kasan_mem_to_shadow(untagged_addr + size - 1);
11359fd51b2SAndrey Konovalov for (shadow = shadow_first; shadow <= shadow_last; shadow++) {
11459fd51b2SAndrey Konovalov if (*shadow != tag) {
11559fd51b2SAndrey Konovalov return !kasan_report(addr, size, write, ret_ip);
11659fd51b2SAndrey Konovalov }
11759fd51b2SAndrey Konovalov }
11859fd51b2SAndrey Konovalov
11959fd51b2SAndrey Konovalov return true;
12059fd51b2SAndrey Konovalov }
12159fd51b2SAndrey Konovalov
kasan_byte_accessible(const void * addr)122611806b4SAndrey Konovalov bool kasan_byte_accessible(const void *addr)
1232cdbed63SAndrey Konovalov {
1242cdbed63SAndrey Konovalov u8 tag = get_tag(addr);
125bfcfe371SPeter Collingbourne void *untagged_addr = kasan_reset_tag(addr);
126bfcfe371SPeter Collingbourne u8 shadow_byte;
1272cdbed63SAndrey Konovalov
1288f17febbSKuan-Ying Lee if (!addr_has_metadata(untagged_addr))
129bfcfe371SPeter Collingbourne return false;
130bfcfe371SPeter Collingbourne
131bfcfe371SPeter Collingbourne shadow_byte = READ_ONCE(*(u8 *)kasan_mem_to_shadow(untagged_addr));
132bfcfe371SPeter Collingbourne return tag == KASAN_TAG_KERNEL || tag == shadow_byte;
1332cdbed63SAndrey Konovalov }
1342cdbed63SAndrey Konovalov
13559fd51b2SAndrey Konovalov #define DEFINE_HWASAN_LOAD_STORE(size) \
136*bb6e04a1SArnd Bergmann void __hwasan_load##size##_noabort(void *addr) \
13759fd51b2SAndrey Konovalov { \
138f00748bfSAndrey Konovalov kasan_check_range(addr, size, false, _RET_IP_); \
13959fd51b2SAndrey Konovalov } \
14059fd51b2SAndrey Konovalov EXPORT_SYMBOL(__hwasan_load##size##_noabort); \
141*bb6e04a1SArnd Bergmann void __hwasan_store##size##_noabort(void *addr) \
14259fd51b2SAndrey Konovalov { \
143f00748bfSAndrey Konovalov kasan_check_range(addr, size, true, _RET_IP_); \
14459fd51b2SAndrey Konovalov } \
14559fd51b2SAndrey Konovalov EXPORT_SYMBOL(__hwasan_store##size##_noabort)
14659fd51b2SAndrey Konovalov
14759fd51b2SAndrey Konovalov DEFINE_HWASAN_LOAD_STORE(1);
14859fd51b2SAndrey Konovalov DEFINE_HWASAN_LOAD_STORE(2);
14959fd51b2SAndrey Konovalov DEFINE_HWASAN_LOAD_STORE(4);
15059fd51b2SAndrey Konovalov DEFINE_HWASAN_LOAD_STORE(8);
15159fd51b2SAndrey Konovalov DEFINE_HWASAN_LOAD_STORE(16);
15259fd51b2SAndrey Konovalov
__hwasan_loadN_noabort(void * addr,ssize_t size)153*bb6e04a1SArnd Bergmann void __hwasan_loadN_noabort(void *addr, ssize_t size)
15459fd51b2SAndrey Konovalov {
155f00748bfSAndrey Konovalov kasan_check_range(addr, size, false, _RET_IP_);
15659fd51b2SAndrey Konovalov }
15759fd51b2SAndrey Konovalov EXPORT_SYMBOL(__hwasan_loadN_noabort);
15859fd51b2SAndrey Konovalov
__hwasan_storeN_noabort(void * addr,ssize_t size)159*bb6e04a1SArnd Bergmann void __hwasan_storeN_noabort(void *addr, ssize_t size)
16059fd51b2SAndrey Konovalov {
161f00748bfSAndrey Konovalov kasan_check_range(addr, size, true, _RET_IP_);
16259fd51b2SAndrey Konovalov }
16359fd51b2SAndrey Konovalov EXPORT_SYMBOL(__hwasan_storeN_noabort);
16459fd51b2SAndrey Konovalov
__hwasan_tag_memory(void * addr,u8 tag,ssize_t size)165*bb6e04a1SArnd Bergmann void __hwasan_tag_memory(void *addr, u8 tag, ssize_t size)
16659fd51b2SAndrey Konovalov {
167*bb6e04a1SArnd Bergmann kasan_poison(addr, size, tag, false);
16859fd51b2SAndrey Konovalov }
16959fd51b2SAndrey Konovalov EXPORT_SYMBOL(__hwasan_tag_memory);
17059fd51b2SAndrey Konovalov
kasan_tag_mismatch(void * addr,unsigned long access_info,unsigned long ret_ip)171*bb6e04a1SArnd Bergmann void kasan_tag_mismatch(void *addr, unsigned long access_info,
1721cbdf60bSPeter Collingbourne unsigned long ret_ip)
1731cbdf60bSPeter Collingbourne {
1741cbdf60bSPeter Collingbourne kasan_report(addr, 1 << (access_info & 0xf), access_info & 0x10,
1751cbdf60bSPeter Collingbourne ret_ip);
1761cbdf60bSPeter Collingbourne }
177