Skip to content

PKS: Add Protection Keys Supervisor (PKS) support

[email protected] linux-doc linux-kselftest linux-mm linux-nvdimm lkml nvdimm 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest10 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10x86/pkeys: Create pkeys_common.harch/x86/include/asm/pgtable.h arch/x86/include/asm/pkeys.h arch/x86/include/asm/pkeys_common.h +2 more+33 -190 replies
2/10x86/fpu: Refactor arch_set_user_pkey_access() for PKS supportarch/x86/include/asm/pkeys.h arch/x86/kernel/fpu/xstate.c arch/x86/mm/pkeys.c+29 -180 replies
3/10x86/pks: Enable Protection Keys Supervisor (PKS)arch/x86/Kconfig arch/x86/include/asm/cpufeatures.h arch/x86/include/asm/disabled-features.h +3 more+26 -10 replies
4/10x86/pks: Preserve the PKRS MSR on context switcharch/x86/include/asm/msr-index.h arch/x86/include/asm/pkeys_common.h arch/x86/include/asm/processor.h +3 more+94 -00 replies
5/10x86/pks: Add PKS kernel APIDocumentation/core-api/protection-keys.rst arch/x86/include/asm/pgtable_types.h arch/x86/include/asm/pkeys.h +4 more+259 -180 replies
6/10x86/entry: Move nmi entry/exit into common codearch/x86/entry/common.c arch/x86/include/asm/idtentry.h arch/x86/kernel/cpu/mce/core.c +4 more+72 -503 replies
7/10x86/entry: Pass irqentry_state_t by referencearch/x86/entry/common.c arch/x86/include/asm/idtentry.h arch/x86/kernel/cpu/mce/core.c +6 more+65 -592 replies
8/10x86/entry: Preserve PKRS MSR across exceptionsarch/x86/entry/common.c arch/x86/include/asm/pkeys_common.h arch/x86/mm/pkeys.c +2 more+67 -50 replies
9/10x86/fault: Report the PKRS state on faultarch/x86/mm/fault.c+33 -250 replies
10/10x86/pks: Add PKS test codeDocumentation/core-api/protection-keys.rst arch/x86/mm/fault.c lib/Kconfig.debug +5 more+801 -10 replies

Reviews trailers per patch

2 of 10 patches have a Reviewed-by or Acked-by.

PatchDave Hansen
1/10R-b
2/10
3/10
4/10
5/10
6/10
7/10
8/10
9/10
10/10R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 00/10] PKS: Add Protection Keys Supervisor (PKS) support

From: Ira Weiny <[email protected]>

Changes from RFC V3[3]
Rebase to TIP master
Update test error output
Standardize on 'irq_state' for state variables
From Dave Hansen
Update commit messages
Add/clean up comments
Add X86_FEATURE_PKS to disabled-features.h and remove some
explicit CONFIG checks
Move saved_pkrs member of thread_struct
Remove superfluous preempt_disable() s/irq_save_pks/irq_save_set_pks/
Ensure PKRS is not seen in faults if not configured or not
supported
s/pks_mknoaccess/pks_mk_noaccess/ s/pks_mkread/pks_mk_readonly/ s/pks_mkrdwr/pks_mk_readwrite/
Change pks_key_alloc return to -EOPNOTSUPP when not supported
From Peter Zijlstra
Clean up Attribution
Remove superfluous preempt_disable()
Add union to differentiate exit_rcu/lockdep use in
irqentry_state_t
From Thomas Gleixner
Add preliminary clean up patch and adjust series as needed

Introduce a new page protection mechanism for supervisor pages, Protection Key Supervisor (PKS).

2 use cases for PKS are being developed, trusted keys and PMEM. Trusted keys is a newer use case which is still being explored. PMEM was submitted as part of the RFC (v2) series[1]. However, since then it was found that some callers of kmap() require a global implementation of PKS. Specifically some users of kmap() expect mappings to be available to all kernel threads. While global use of PKS is rare it needs to be included for correctness. Unfortunately the kmap() updates required a large patch series to make the needed changes at the various kmap() call sites so that patch set has been split out. Because the global PKS feature is only required for that use case it will be deferred to that set as well.[2] This patch set is being submitted as a precursor to both of the use cases.

For an overview of the entire PKS ecosystem, a git tree including this series and 2 proposed use cases can be found here:

	https://lore.kernel.org/lkml/[email protected]/
	https://lore.kernel.org/lkml/[email protected]/

PKS enables protections on 'domains' of supervisor pages to limit supervisor mode access to those pages beyond the normal paging protections. PKS works in a similar fashion to user space pkeys, PKU. As with PKU, supervisor pkeys are checked in addition to normal paging protections and Access or Writes can be disabled via a MSR update without TLB flushes when permissions change. Also like PKU, a page mapping is assigned to a domain by setting pkey bits in the page table entry for that mapping.

Access is controlled through a PKRS register which is updated via WRMSR/RDMSR.

XSAVE is not supported for the PKRS MSR. Therefore the implementation saves/restores the MSR across context switches and during exceptions. Nested exceptions are supported by each exception getting a new PKS state.

For consistent behavior with current paging protections, pkey 0 is reserved and configured to allow full access via the pkey mechanism, thus preserving the default paging protections on mappings with the default pkey value of 0.

Other keys, (1-15) are allocated by an allocator which prepares us for key contention from day one. Kernel users should be prepared for the allocator to fail either because of key exhaustion or due to PKS not being supported on the arch and/or CPU instance.

The following are key attributes of PKS.

1) Fast switching of permissions
1a) Prevents access without page table manipulations 1b) No TLB flushes required
2) Works on a per thread basis

PKS is available with 4 and 5 level paging. Like PKRU it consumes 4 bits from the PTE to store the pkey within the entry.

[1] https://lore.kernel.org/lkml/[email protected]/
[2] https://lore.kernel.org/lkml/[email protected]/
[3] https://lore.kernel.org/lkml/[email protected]/

Fenghua Yu (2):
x86/pks: Enable Protection Keys Supervisor (PKS) x86/pks: Add PKS kernel API

Ira Weiny (7):
x86/pkeys: Create pkeys_common.h
x86/fpu: Refactor arch_set_user_pkey_access() for PKS support x86/pks: Preserve the PKRS MSR on context switch x86/entry: Pass irqentry_state_t by reference x86/entry: Preserve PKRS MSR across exceptions x86/fault: Report the PKRS state on fault
x86/pks: Add PKS test code

Thomas Gleixner (1):
x86/entry: Move nmi entry/exit into common code

 Documentation/core-api/protection-keys.rst  | 102 ++-
 arch/x86/Kconfig                            |   1 +
 arch/x86/entry/common.c                     |  65 +-
 arch/x86/include/asm/cpufeatures.h          |   1 +
 arch/x86/include/asm/disabled-features.h    |   8 +-
 arch/x86/include/asm/idtentry.h             |  28 +-
 arch/x86/include/asm/msr-index.h            |   1 +
 arch/x86/include/asm/pgtable.h              |  13 +-
 arch/x86/include/asm/pgtable_types.h        |  12 +
 arch/x86/include/asm/pkeys.h                |  15 +
 arch/x86/include/asm/pkeys_common.h         |  40 ++
 arch/x86/include/asm/processor.h            |  14 +
 arch/x86/include/uapi/asm/processor-flags.h |   2 +
 arch/x86/kernel/cpu/common.c                |  15 +
 arch/x86/kernel/cpu/mce/core.c              |   6 +-
 arch/x86/kernel/fpu/xstate.c                |  22 +-
 arch/x86/kernel/kvm.c                       |   6 +-
 arch/x86/kernel/nmi.c                       |   6 +-
 arch/x86/kernel/process.c                   |  26 +
 arch/x86/kernel/traps.c                     |  24 +-
 arch/x86/mm/fault.c                         |  87 ++-
 arch/x86/mm/pkeys.c                         | 191 +++++-
 include/linux/entry-common.h                |  46 +-
 include/linux/pgtable.h                     |   4 +
 include/linux/pkeys.h                       |  22 +
 kernel/entry/common.c                       |  62 +-
 lib/Kconfig.debug                           |  12 +
 lib/Makefile                                |   3 +
 lib/pks/Makefile                            |   3 +
 lib/pks/pks_test.c                          | 691 ++++++++++++++++++++
 mm/Kconfig                                  |   2 +
 tools/testing/selftests/x86/Makefile        |   3 +-
 tools/testing/selftests/x86/test_pks.c      |  66 ++
 33 files changed, 1441 insertions(+), 158 deletions(-)
 create mode 100644 arch/x86/include/asm/pkeys_common.h
 create mode 100644 lib/pks/Makefile
 create mode 100644 lib/pks/pks_test.c
 create mode 100644 tools/testing/selftests/x86/test_pks.c
Signature · 1 line
2.28.0.rc0.12.gb6a658bd00c9