2 * Copyright(c) 2017 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * This code is based in part on work published here:
15 * https://github.com/IAIK/KAISER
17 * The original work was written by and and signed off by for the Linux
29 #include <linux/kernel.h>
30 #include <linux/errno.h>
31 #include <linux/string.h>
32 #include <linux/types.h>
33 #include <linux/bug.h>
34 #include <linux/init.h>
35 #include <linux/spinlock.h>
37 #include <linux/uaccess.h>
39 #include <asm/cpufeature.h>
40 #include <asm/hypervisor.h>
41 #include <asm/vsyscall.h>
42 #include <asm/cmdline.h>
44 #include <asm/pgtable.h>
45 #include <asm/pgalloc.h>
46 #include <asm/tlbflush.h>
48 #include <asm/sections.h>
51 #define pr_fmt(fmt) "Kernel/User page tables isolation: " fmt
53 /* Backporting helper */
55 #define __GFP_NOTRACK 0
59 * Define the page-table levels we clone for user-space on 32
63 #define PTI_LEVEL_KERNEL_IMAGE PTI_CLONE_PMD
65 #define PTI_LEVEL_KERNEL_IMAGE PTI_CLONE_PTE
68 static void __init pti_print_if_insecure(const char *reason)
70 if (boot_cpu_has_bug(X86_BUG_CPU_MELTDOWN))
71 pr_info("%s\n", reason);
74 static void __init pti_print_if_secure(const char *reason)
76 if (!boot_cpu_has_bug(X86_BUG_CPU_MELTDOWN))
77 pr_info("%s\n", reason);
86 void __init pti_check_boottime_disable(void)
91 /* Assume mode is auto unless overridden. */
94 if (hypervisor_is_type(X86_HYPER_XEN_PV)) {
95 pti_mode = PTI_FORCE_OFF;
96 pti_print_if_insecure("disabled on XEN PV.");
100 ret = cmdline_find_option(boot_command_line, "pti", arg, sizeof(arg));
102 if (ret == 3 && !strncmp(arg, "off", 3)) {
103 pti_mode = PTI_FORCE_OFF;
104 pti_print_if_insecure("disabled on command line.");
107 if (ret == 2 && !strncmp(arg, "on", 2)) {
108 pti_mode = PTI_FORCE_ON;
109 pti_print_if_secure("force enabled on command line.");
112 if (ret == 4 && !strncmp(arg, "auto", 4)) {
118 if (cmdline_find_option_bool(boot_command_line, "nopti")) {
119 pti_mode = PTI_FORCE_OFF;
120 pti_print_if_insecure("disabled on command line.");
125 if (!boot_cpu_has_bug(X86_BUG_CPU_MELTDOWN))
128 setup_force_cpu_cap(X86_FEATURE_PTI);
131 pgd_t __pti_set_user_pgtbl(pgd_t *pgdp, pgd_t pgd)
134 * Changes to the high (kernel) portion of the kernelmode page
135 * tables are not automatically propagated to the usermode tables.
137 * Users should keep in mind that, unlike the kernelmode tables,
138 * there is no vmalloc_fault equivalent for the usermode tables.
139 * Top-level entries added to init_mm's usermode pgd after boot
140 * will not be automatically propagated to other mms.
142 if (!pgdp_maps_userspace(pgdp))
146 * The user page tables get the full PGD, accessible from
149 kernel_to_user_pgdp(pgdp)->pgd = pgd.pgd;
152 * If this is normal user memory, make it NX in the kernel
153 * pagetables so that, if we somehow screw up and return to
154 * usermode with the kernel CR3 loaded, we'll get a page fault
155 * instead of allowing user code to execute with the wrong CR3.
157 * As exceptions, we don't set NX if:
158 * - _PAGE_USER is not set. This could be an executable
159 * EFI runtime mapping or something similar, and the kernel
160 * may execute from it
161 * - we don't have NX support
162 * - we're clearing the PGD (i.e. the new pgd is not present).
164 if ((pgd.pgd & (_PAGE_USER|_PAGE_PRESENT)) == (_PAGE_USER|_PAGE_PRESENT) &&
165 (__supported_pte_mask & _PAGE_NX))
168 /* return the copy of the PGD we want the kernel to use: */
173 * Walk the user copy of the page tables (optionally) trying to allocate
174 * page table pages on the way down.
176 * Returns a pointer to a P4D on success, or NULL on failure.
178 static p4d_t *pti_user_pagetable_walk_p4d(unsigned long address)
180 pgd_t *pgd = kernel_to_user_pgdp(pgd_offset_k(address));
181 gfp_t gfp = (GFP_KERNEL | __GFP_NOTRACK | __GFP_ZERO);
183 if (address < PAGE_OFFSET) {
184 WARN_ONCE(1, "attempt to walk user address\n");
188 if (pgd_none(*pgd)) {
189 unsigned long new_p4d_page = __get_free_page(gfp);
190 if (WARN_ON_ONCE(!new_p4d_page))
193 set_pgd(pgd, __pgd(_KERNPG_TABLE | __pa(new_p4d_page)));
195 BUILD_BUG_ON(pgd_large(*pgd) != 0);
197 return p4d_offset(pgd, address);
201 * Walk the user copy of the page tables (optionally) trying to allocate
202 * page table pages on the way down.
204 * Returns a pointer to a PMD on success, or NULL on failure.
206 static pmd_t *pti_user_pagetable_walk_pmd(unsigned long address)
208 gfp_t gfp = (GFP_KERNEL | __GFP_NOTRACK | __GFP_ZERO);
212 p4d = pti_user_pagetable_walk_p4d(address);
216 BUILD_BUG_ON(p4d_large(*p4d) != 0);
217 if (p4d_none(*p4d)) {
218 unsigned long new_pud_page = __get_free_page(gfp);
219 if (WARN_ON_ONCE(!new_pud_page))
222 set_p4d(p4d, __p4d(_KERNPG_TABLE | __pa(new_pud_page)));
225 pud = pud_offset(p4d, address);
226 /* The user page tables do not use large mappings: */
227 if (pud_large(*pud)) {
231 if (pud_none(*pud)) {
232 unsigned long new_pmd_page = __get_free_page(gfp);
233 if (WARN_ON_ONCE(!new_pmd_page))
236 set_pud(pud, __pud(_KERNPG_TABLE | __pa(new_pmd_page)));
239 return pmd_offset(pud, address);
243 * Walk the shadow copy of the page tables (optionally) trying to allocate
244 * page table pages on the way down. Does not support large pages.
246 * Note: this is only used when mapping *new* kernel data into the
247 * user/shadow page tables. It is never used for userspace data.
249 * Returns a pointer to a PTE on success, or NULL on failure.
251 static pte_t *pti_user_pagetable_walk_pte(unsigned long address)
253 gfp_t gfp = (GFP_KERNEL | __GFP_NOTRACK | __GFP_ZERO);
257 pmd = pti_user_pagetable_walk_pmd(address);
261 /* We can't do anything sensible if we hit a large mapping. */
262 if (pmd_large(*pmd)) {
267 if (pmd_none(*pmd)) {
268 unsigned long new_pte_page = __get_free_page(gfp);
272 set_pmd(pmd, __pmd(_KERNPG_TABLE | __pa(new_pte_page)));
275 pte = pte_offset_kernel(pmd, address);
276 if (pte_flags(*pte) & _PAGE_USER) {
277 WARN_ONCE(1, "attempt to walk to user pte\n");
283 #ifdef CONFIG_X86_VSYSCALL_EMULATION
284 static void __init pti_setup_vsyscall(void)
286 pte_t *pte, *target_pte;
289 pte = lookup_address(VSYSCALL_ADDR, &level);
290 if (!pte || WARN_ON(level != PG_LEVEL_4K) || pte_none(*pte))
293 target_pte = pti_user_pagetable_walk_pte(VSYSCALL_ADDR);
294 if (WARN_ON(!target_pte))
298 set_vsyscall_pgtable_user_bits(kernel_to_user_pgdp(swapper_pg_dir));
301 static void __init pti_setup_vsyscall(void) { }
304 enum pti_clone_level {
310 pti_clone_pgtable(unsigned long start, unsigned long end,
311 enum pti_clone_level level)
316 * Clone the populated PMDs which cover start to end. These PMD areas
319 for (addr = start; addr < end;) {
320 pte_t *pte, *target_pte;
321 pmd_t *pmd, *target_pmd;
330 pgd = pgd_offset_k(addr);
331 if (WARN_ON(pgd_none(*pgd)))
333 p4d = p4d_offset(pgd, addr);
334 if (WARN_ON(p4d_none(*p4d)))
337 pud = pud_offset(p4d, addr);
338 if (pud_none(*pud)) {
343 pmd = pmd_offset(pud, addr);
344 if (pmd_none(*pmd)) {
349 if (pmd_large(*pmd) || level == PTI_CLONE_PMD) {
350 target_pmd = pti_user_pagetable_walk_pmd(addr);
351 if (WARN_ON(!target_pmd))
355 * Only clone present PMDs. This ensures only setting
356 * _PAGE_GLOBAL on present PMDs. This should only be
357 * called on well-known addresses anyway, so a non-
358 * present PMD would be a surprise.
360 if (WARN_ON(!(pmd_flags(*pmd) & _PAGE_PRESENT)))
364 * Setting 'target_pmd' below creates a mapping in both
365 * the user and kernel page tables. It is effectively
366 * global, so set it as global in both copies. Note:
367 * the X86_FEATURE_PGE check is not _required_ because
368 * the CPU ignores _PAGE_GLOBAL when PGE is not
369 * supported. The check keeps consistentency with
370 * code that only set this bit when supported.
372 if (boot_cpu_has(X86_FEATURE_PGE))
373 *pmd = pmd_set_flags(*pmd, _PAGE_GLOBAL);
376 * Copy the PMD. That is, the kernelmode and usermode
377 * tables will share the last-level page tables of this
384 } else if (level == PTI_CLONE_PTE) {
386 /* Walk the page-table down to the pte level */
387 pte = pte_offset_kernel(pmd, addr);
388 if (pte_none(*pte)) {
393 /* Only clone present PTEs */
394 if (WARN_ON(!(pte_flags(*pte) & _PAGE_PRESENT)))
397 /* Allocate PTE in the user page-table */
398 target_pte = pti_user_pagetable_walk_pte(addr);
399 if (WARN_ON(!target_pte))
402 /* Set GLOBAL bit in both PTEs */
403 if (boot_cpu_has(X86_FEATURE_PGE))
404 *pte = pte_set_flags(*pte, _PAGE_GLOBAL);
419 * Clone a single p4d (i.e. a top-level entry on 4-level systems and a
420 * next-level entry on 5-level systems.
422 static void __init pti_clone_p4d(unsigned long addr)
424 p4d_t *kernel_p4d, *user_p4d;
427 user_p4d = pti_user_pagetable_walk_p4d(addr);
431 kernel_pgd = pgd_offset_k(addr);
432 kernel_p4d = p4d_offset(kernel_pgd, addr);
433 *user_p4d = *kernel_p4d;
437 * Clone the CPU_ENTRY_AREA into the user space visible page table.
439 static void __init pti_clone_user_shared(void)
441 pti_clone_p4d(CPU_ENTRY_AREA_BASE);
444 #else /* CONFIG_X86_64 */
447 * On 32 bit PAE systems with 1GB of Kernel address space there is only
448 * one pgd/p4d for the whole kernel. Cloning that would map the whole
449 * address space into the user page-tables, making PTI useless. So clone
450 * the page-table on the PMD level to prevent that.
452 static void __init pti_clone_user_shared(void)
454 unsigned long start, end;
456 start = CPU_ENTRY_AREA_BASE;
457 end = start + (PAGE_SIZE * CPU_ENTRY_AREA_PAGES);
459 pti_clone_pgtable(start, end, PTI_CLONE_PMD);
461 #endif /* CONFIG_X86_64 */
464 * Clone the ESPFIX P4D into the user space visible page table
466 static void __init pti_setup_espfix64(void)
468 #ifdef CONFIG_X86_ESPFIX64
469 pti_clone_p4d(ESPFIX_BASE_ADDR);
474 * Clone the populated PMDs of the entry and irqentry text and force it RO.
476 static void pti_clone_entry_text(void)
478 pti_clone_pgtable((unsigned long) __entry_text_start,
479 (unsigned long) __irqentry_text_end,
484 * Global pages and PCIDs are both ways to make kernel TLB entries
485 * live longer, reduce TLB misses and improve kernel performance.
486 * But, leaving all kernel text Global makes it potentially accessible
487 * to Meltdown-style attacks which make it trivial to find gadgets or
490 * Only use global pages when it is really worth it.
492 static inline bool pti_kernel_image_global_ok(void)
495 * Systems with PCIDs get litlle benefit from global
496 * kernel text and are not worth the downsides.
498 if (cpu_feature_enabled(X86_FEATURE_PCID))
502 * Only do global kernel image for pti=auto. Do the most
503 * secure thing (not global) if pti=on specified.
505 if (pti_mode != PTI_AUTO)
509 * K8 may not tolerate the cleared _PAGE_RW on the userspace
510 * global kernel image pages. Do the safe thing (disable
511 * global kernel image). This is unlikely to ever be
512 * noticed because PTI is disabled by default on AMD CPUs.
514 if (boot_cpu_has(X86_FEATURE_K8))
518 * RANDSTRUCT derives its hardening benefits from the
519 * attacker's lack of knowledge about the layout of kernel
520 * data structures. Keep the kernel image non-global in
521 * cases where RANDSTRUCT is in use to help keep the layout a
524 if (IS_ENABLED(CONFIG_GCC_PLUGIN_RANDSTRUCT))
531 * This is the only user for these and it is not arch-generic
532 * like the other set_memory.h functions. Just extern them.
534 extern int set_memory_nonglobal(unsigned long addr, int numpages);
535 extern int set_memory_global(unsigned long addr, int numpages);
538 * For some configurations, map all of kernel text into the user page
539 * tables. This reduces TLB misses, especially on non-PCID systems.
541 static void pti_clone_kernel_text(void)
544 * rodata is part of the kernel image and is normally
545 * readable on the filesystem or on the web. But, do not
546 * clone the areas past rodata, they might contain secrets.
548 unsigned long start = PFN_ALIGN(_text);
549 unsigned long end_clone = (unsigned long)__end_rodata_aligned;
550 unsigned long end_global = PFN_ALIGN((unsigned long)__stop___ex_table);
552 if (!pti_kernel_image_global_ok())
555 pr_debug("mapping partial kernel image into user address space\n");
558 * Note that this will undo _some_ of the work that
559 * pti_set_kernel_image_nonglobal() did to clear the
562 pti_clone_pgtable(start, end_clone, PTI_LEVEL_KERNEL_IMAGE);
565 * pti_clone_pgtable() will set the global bit in any PMDs
566 * that it clones, but we also need to get any PTEs in
567 * the last level for areas that are not huge-page-aligned.
570 /* Set the global bit for normal non-__init kernel text: */
571 set_memory_global(start, (end_global - start) >> PAGE_SHIFT);
574 void pti_set_kernel_image_nonglobal(void)
577 * The identity map is created with PMDs, regardless of the
578 * actual length of the kernel. We need to clear
579 * _PAGE_GLOBAL up to a PMD boundary, not just to the end
582 unsigned long start = PFN_ALIGN(_text);
583 unsigned long end = ALIGN((unsigned long)_end, PMD_PAGE_SIZE);
586 * This clears _PAGE_GLOBAL from the entire kernel image.
587 * pti_clone_kernel_text() map put _PAGE_GLOBAL back for
588 * areas that are mapped to userspace.
590 set_memory_nonglobal(start, (end - start) >> PAGE_SHIFT);
594 * Initialize kernel page table isolation
596 void __init pti_init(void)
598 if (!static_cpu_has(X86_FEATURE_PTI))
601 pr_info("enabled\n");
605 * We check for X86_FEATURE_PCID here. But the init-code will
606 * clear the feature flag on 32 bit because the feature is not
607 * supported on 32 bit anyway. To print the warning we need to
608 * check with cpuid directly again.
610 if (cpuid_ecx(0x1) & BIT(17)) {
611 /* Use printk to work around pr_fmt() */
612 printk(KERN_WARNING "\n");
613 printk(KERN_WARNING "************************************************************\n");
614 printk(KERN_WARNING "** WARNING! WARNING! WARNING! WARNING! WARNING! WARNING! **\n");
615 printk(KERN_WARNING "** **\n");
616 printk(KERN_WARNING "** You are using 32-bit PTI on a 64-bit PCID-capable CPU. **\n");
617 printk(KERN_WARNING "** Your performance will increase dramatically if you **\n");
618 printk(KERN_WARNING "** switch to a 64-bit kernel! **\n");
619 printk(KERN_WARNING "** **\n");
620 printk(KERN_WARNING "** WARNING! WARNING! WARNING! WARNING! WARNING! WARNING! **\n");
621 printk(KERN_WARNING "************************************************************\n");
625 pti_clone_user_shared();
627 /* Undo all global bits from the init pagetables in head_64.S: */
628 pti_set_kernel_image_nonglobal();
629 /* Replace some of the global bits just for shared entry text: */
630 pti_clone_entry_text();
631 pti_setup_espfix64();
632 pti_setup_vsyscall();
636 * Finalize the kernel mappings in the userspace page-table. Some of the
637 * mappings for the kernel image might have changed since pti_init()
638 * cloned them. This is because parts of the kernel image have been
639 * mapped RO and/or NX. These changes need to be cloned again to the
640 * userspace page-table.
642 void pti_finalize(void)
645 * We need to clone everything (again) that maps parts of the
648 pti_clone_entry_text();
649 pti_clone_kernel_text();
651 debug_checkwx_user();