162306a36Sopenharmony_ci// SPDX-License-Identifier: GPL-2.0
262306a36Sopenharmony_ci/*
362306a36Sopenharmony_ci * This file implements KASLR memory randomization for x86_64. It randomizes
462306a36Sopenharmony_ci * the virtual address space of kernel memory regions (physical memory
562306a36Sopenharmony_ci * mapping, vmalloc & vmemmap) for x86_64. This security feature mitigates
662306a36Sopenharmony_ci * exploits relying on predictable kernel addresses.
762306a36Sopenharmony_ci *
862306a36Sopenharmony_ci * Entropy is generated using the KASLR early boot functions now shared in
962306a36Sopenharmony_ci * the lib directory (originally written by Kees Cook). Randomization is
1062306a36Sopenharmony_ci * done on PGD & P4D/PUD page table levels to increase possible addresses.
1162306a36Sopenharmony_ci * The physical memory mapping code was adapted to support P4D/PUD level
1262306a36Sopenharmony_ci * virtual addresses. This implementation on the best configuration provides
1362306a36Sopenharmony_ci * 30,000 possible virtual addresses in average for each memory region.
1462306a36Sopenharmony_ci * An additional low memory page is used to ensure each CPU can start with
1562306a36Sopenharmony_ci * a PGD aligned virtual address (for realmode).
1662306a36Sopenharmony_ci *
1762306a36Sopenharmony_ci * The order of each memory region is not changed. The feature looks at
1862306a36Sopenharmony_ci * the available space for the regions based on different configuration
1962306a36Sopenharmony_ci * options and randomizes the base and space between each. The size of the
2062306a36Sopenharmony_ci * physical memory mapping is the available physical memory.
2162306a36Sopenharmony_ci */
2262306a36Sopenharmony_ci
2362306a36Sopenharmony_ci#include <linux/kernel.h>
2462306a36Sopenharmony_ci#include <linux/init.h>
2562306a36Sopenharmony_ci#include <linux/random.h>
2662306a36Sopenharmony_ci#include <linux/memblock.h>
2762306a36Sopenharmony_ci#include <linux/pgtable.h>
2862306a36Sopenharmony_ci
2962306a36Sopenharmony_ci#include <asm/setup.h>
3062306a36Sopenharmony_ci#include <asm/kaslr.h>
3162306a36Sopenharmony_ci
3262306a36Sopenharmony_ci#include "mm_internal.h"
3362306a36Sopenharmony_ci
3462306a36Sopenharmony_ci#define TB_SHIFT 40
3562306a36Sopenharmony_ci
3662306a36Sopenharmony_ci/*
3762306a36Sopenharmony_ci * The end address could depend on more configuration options to make the
3862306a36Sopenharmony_ci * highest amount of space for randomization available, but that's too hard
3962306a36Sopenharmony_ci * to keep straight and caused issues already.
4062306a36Sopenharmony_ci */
4162306a36Sopenharmony_cistatic const unsigned long vaddr_end = CPU_ENTRY_AREA_BASE;
4262306a36Sopenharmony_ci
4362306a36Sopenharmony_ci/*
4462306a36Sopenharmony_ci * Memory regions randomized by KASLR (except modules that use a separate logic
4562306a36Sopenharmony_ci * earlier during boot). The list is ordered based on virtual addresses. This
4662306a36Sopenharmony_ci * order is kept after randomization.
4762306a36Sopenharmony_ci */
4862306a36Sopenharmony_cistatic __initdata struct kaslr_memory_region {
4962306a36Sopenharmony_ci	unsigned long *base;
5062306a36Sopenharmony_ci	unsigned long size_tb;
5162306a36Sopenharmony_ci} kaslr_regions[] = {
5262306a36Sopenharmony_ci	{ &page_offset_base, 0 },
5362306a36Sopenharmony_ci	{ &vmalloc_base, 0 },
5462306a36Sopenharmony_ci	{ &vmemmap_base, 0 },
5562306a36Sopenharmony_ci};
5662306a36Sopenharmony_ci
5762306a36Sopenharmony_ci/* Get size in bytes used by the memory region */
5862306a36Sopenharmony_cistatic inline unsigned long get_padding(struct kaslr_memory_region *region)
5962306a36Sopenharmony_ci{
6062306a36Sopenharmony_ci	return (region->size_tb << TB_SHIFT);
6162306a36Sopenharmony_ci}
6262306a36Sopenharmony_ci
6362306a36Sopenharmony_ci/* Initialize base and padding for each memory region randomized with KASLR */
6462306a36Sopenharmony_civoid __init kernel_randomize_memory(void)
6562306a36Sopenharmony_ci{
6662306a36Sopenharmony_ci	size_t i;
6762306a36Sopenharmony_ci	unsigned long vaddr_start, vaddr;
6862306a36Sopenharmony_ci	unsigned long rand, memory_tb;
6962306a36Sopenharmony_ci	struct rnd_state rand_state;
7062306a36Sopenharmony_ci	unsigned long remain_entropy;
7162306a36Sopenharmony_ci	unsigned long vmemmap_size;
7262306a36Sopenharmony_ci
7362306a36Sopenharmony_ci	vaddr_start = pgtable_l5_enabled() ? __PAGE_OFFSET_BASE_L5 : __PAGE_OFFSET_BASE_L4;
7462306a36Sopenharmony_ci	vaddr = vaddr_start;
7562306a36Sopenharmony_ci
7662306a36Sopenharmony_ci	/*
7762306a36Sopenharmony_ci	 * These BUILD_BUG_ON checks ensure the memory layout is consistent
7862306a36Sopenharmony_ci	 * with the vaddr_start/vaddr_end variables. These checks are very
7962306a36Sopenharmony_ci	 * limited....
8062306a36Sopenharmony_ci	 */
8162306a36Sopenharmony_ci	BUILD_BUG_ON(vaddr_start >= vaddr_end);
8262306a36Sopenharmony_ci	BUILD_BUG_ON(vaddr_end != CPU_ENTRY_AREA_BASE);
8362306a36Sopenharmony_ci	BUILD_BUG_ON(vaddr_end > __START_KERNEL_map);
8462306a36Sopenharmony_ci
8562306a36Sopenharmony_ci	if (!kaslr_memory_enabled())
8662306a36Sopenharmony_ci		return;
8762306a36Sopenharmony_ci
8862306a36Sopenharmony_ci	kaslr_regions[0].size_tb = 1 << (MAX_PHYSMEM_BITS - TB_SHIFT);
8962306a36Sopenharmony_ci	kaslr_regions[1].size_tb = VMALLOC_SIZE_TB;
9062306a36Sopenharmony_ci
9162306a36Sopenharmony_ci	/*
9262306a36Sopenharmony_ci	 * Update Physical memory mapping to available and
9362306a36Sopenharmony_ci	 * add padding if needed (especially for memory hotplug support).
9462306a36Sopenharmony_ci	 */
9562306a36Sopenharmony_ci	BUG_ON(kaslr_regions[0].base != &page_offset_base);
9662306a36Sopenharmony_ci	memory_tb = DIV_ROUND_UP(max_pfn << PAGE_SHIFT, 1UL << TB_SHIFT) +
9762306a36Sopenharmony_ci		CONFIG_RANDOMIZE_MEMORY_PHYSICAL_PADDING;
9862306a36Sopenharmony_ci
9962306a36Sopenharmony_ci	/* Adapt physical memory region size based on available memory */
10062306a36Sopenharmony_ci	if (memory_tb < kaslr_regions[0].size_tb)
10162306a36Sopenharmony_ci		kaslr_regions[0].size_tb = memory_tb;
10262306a36Sopenharmony_ci
10362306a36Sopenharmony_ci	/*
10462306a36Sopenharmony_ci	 * Calculate the vmemmap region size in TBs, aligned to a TB
10562306a36Sopenharmony_ci	 * boundary.
10662306a36Sopenharmony_ci	 */
10762306a36Sopenharmony_ci	vmemmap_size = (kaslr_regions[0].size_tb << (TB_SHIFT - PAGE_SHIFT)) *
10862306a36Sopenharmony_ci			sizeof(struct page);
10962306a36Sopenharmony_ci	kaslr_regions[2].size_tb = DIV_ROUND_UP(vmemmap_size, 1UL << TB_SHIFT);
11062306a36Sopenharmony_ci
11162306a36Sopenharmony_ci	/* Calculate entropy available between regions */
11262306a36Sopenharmony_ci	remain_entropy = vaddr_end - vaddr_start;
11362306a36Sopenharmony_ci	for (i = 0; i < ARRAY_SIZE(kaslr_regions); i++)
11462306a36Sopenharmony_ci		remain_entropy -= get_padding(&kaslr_regions[i]);
11562306a36Sopenharmony_ci
11662306a36Sopenharmony_ci	prandom_seed_state(&rand_state, kaslr_get_random_long("Memory"));
11762306a36Sopenharmony_ci
11862306a36Sopenharmony_ci	for (i = 0; i < ARRAY_SIZE(kaslr_regions); i++) {
11962306a36Sopenharmony_ci		unsigned long entropy;
12062306a36Sopenharmony_ci
12162306a36Sopenharmony_ci		/*
12262306a36Sopenharmony_ci		 * Select a random virtual address using the extra entropy
12362306a36Sopenharmony_ci		 * available.
12462306a36Sopenharmony_ci		 */
12562306a36Sopenharmony_ci		entropy = remain_entropy / (ARRAY_SIZE(kaslr_regions) - i);
12662306a36Sopenharmony_ci		prandom_bytes_state(&rand_state, &rand, sizeof(rand));
12762306a36Sopenharmony_ci		entropy = (rand % (entropy + 1)) & PUD_MASK;
12862306a36Sopenharmony_ci		vaddr += entropy;
12962306a36Sopenharmony_ci		*kaslr_regions[i].base = vaddr;
13062306a36Sopenharmony_ci
13162306a36Sopenharmony_ci		/*
13262306a36Sopenharmony_ci		 * Jump the region and add a minimum padding based on
13362306a36Sopenharmony_ci		 * randomization alignment.
13462306a36Sopenharmony_ci		 */
13562306a36Sopenharmony_ci		vaddr += get_padding(&kaslr_regions[i]);
13662306a36Sopenharmony_ci		vaddr = round_up(vaddr + 1, PUD_SIZE);
13762306a36Sopenharmony_ci		remain_entropy -= entropy;
13862306a36Sopenharmony_ci	}
13962306a36Sopenharmony_ci}
14062306a36Sopenharmony_ci
14162306a36Sopenharmony_civoid __meminit init_trampoline_kaslr(void)
14262306a36Sopenharmony_ci{
14362306a36Sopenharmony_ci	pud_t *pud_page_tramp, *pud, *pud_tramp;
14462306a36Sopenharmony_ci	p4d_t *p4d_page_tramp, *p4d, *p4d_tramp;
14562306a36Sopenharmony_ci	unsigned long paddr, vaddr;
14662306a36Sopenharmony_ci	pgd_t *pgd;
14762306a36Sopenharmony_ci
14862306a36Sopenharmony_ci	pud_page_tramp = alloc_low_page();
14962306a36Sopenharmony_ci
15062306a36Sopenharmony_ci	/*
15162306a36Sopenharmony_ci	 * There are two mappings for the low 1MB area, the direct mapping
15262306a36Sopenharmony_ci	 * and the 1:1 mapping for the real mode trampoline:
15362306a36Sopenharmony_ci	 *
15462306a36Sopenharmony_ci	 * Direct mapping: virt_addr = phys_addr + PAGE_OFFSET
15562306a36Sopenharmony_ci	 * 1:1 mapping:    virt_addr = phys_addr
15662306a36Sopenharmony_ci	 */
15762306a36Sopenharmony_ci	paddr = 0;
15862306a36Sopenharmony_ci	vaddr = (unsigned long)__va(paddr);
15962306a36Sopenharmony_ci	pgd = pgd_offset_k(vaddr);
16062306a36Sopenharmony_ci
16162306a36Sopenharmony_ci	p4d = p4d_offset(pgd, vaddr);
16262306a36Sopenharmony_ci	pud = pud_offset(p4d, vaddr);
16362306a36Sopenharmony_ci
16462306a36Sopenharmony_ci	pud_tramp = pud_page_tramp + pud_index(paddr);
16562306a36Sopenharmony_ci	*pud_tramp = *pud;
16662306a36Sopenharmony_ci
16762306a36Sopenharmony_ci	if (pgtable_l5_enabled()) {
16862306a36Sopenharmony_ci		p4d_page_tramp = alloc_low_page();
16962306a36Sopenharmony_ci
17062306a36Sopenharmony_ci		p4d_tramp = p4d_page_tramp + p4d_index(paddr);
17162306a36Sopenharmony_ci
17262306a36Sopenharmony_ci		set_p4d(p4d_tramp,
17362306a36Sopenharmony_ci			__p4d(_KERNPG_TABLE | __pa(pud_page_tramp)));
17462306a36Sopenharmony_ci
17562306a36Sopenharmony_ci		trampoline_pgd_entry =
17662306a36Sopenharmony_ci			__pgd(_KERNPG_TABLE | __pa(p4d_page_tramp));
17762306a36Sopenharmony_ci	} else {
17862306a36Sopenharmony_ci		trampoline_pgd_entry =
17962306a36Sopenharmony_ci			__pgd(_KERNPG_TABLE | __pa(pud_page_tramp));
18062306a36Sopenharmony_ci	}
18162306a36Sopenharmony_ci}
182