From: ira.weiny@intel.com
To: Dave Hansen <dave.hansen@linux.intel.com>,
"H. Peter Anvin" <hpa@zytor.com>,
Dan Williams <dan.j.williams@intel.com>
Cc: Ira Weiny <ira.weiny@intel.com>,
Fenghua Yu <fenghua.yu@intel.com>,
Rick Edgecombe <rick.p.edgecombe@intel.com>,
linux-kernel@vger.kernel.org
Subject: [PATCH V8 11/44] mm/pkeys: Define static PKS key array and default values
Date: Thu, 27 Jan 2022 09:54:32 -0800 [thread overview]
Message-ID: <20220127175505.851391-12-ira.weiny@intel.com> (raw)
In-Reply-To: <20220127175505.851391-1-ira.weiny@intel.com>
From: Ira Weiny <ira.weiny@intel.com>
Kernel users will need a way to allocate a PKS Pkey for their use.
Introduce pks-keys.h as a place to define enum pks_pkey_consumers and
the macro PKS_INIT_VALUE. PKS_INIT_VALUE holds the default value for
each key. Kernel users reserve a key value by adding an entry to the
enum pks_pkey_consumers with a unique value [1-15] and replacing that
value in the PKS_INIT_VALUE macro using the desired default macro;
PKR_RW_KEY(), PKR_WD_KEY(), or PKR_AD_KEY().
Use this value to initialize all CPUs at boot.
pks-keys.h is added as a new header with minimal header dependencies.
This allows the use of PKS_INIT_VALUE within other headers where the
additional includes from pkeys.h caused major conflicts. The main
conflict was using PKS_INIT_VALUE for INIT_TRHEAD in asm/processor.h
Add documentation.
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
---
Changes for V8
Create pks-keys.h to solve header conflicts in subsequent
patches.
Remove create_initial_pkrs_value() which did not work
Replace it with PKS_INIT_VALUE
Fix up documentation to match
s/PKR_RW_BIT/PKR_RW_KEY()/
s/PKRS_INIT_VALUE/PKS_INIT_VALUE
Split this off of the previous patch
Update documentation and embed it in the code to help ensure it
is kept up to date.
Changes for V7
Create a dynamic pkrs_initial_value in early init code.
Clean up comments
Add comment to macro guard
---
Documentation/core-api/protection-keys.rst | 4 ++
arch/x86/include/asm/pkeys_common.h | 1 +
arch/x86/mm/pkeys.c | 2 +-
include/linux/pkeys.h | 2 +
include/linux/pks-keys.h | 59 ++++++++++++++++++++++
5 files changed, 67 insertions(+), 1 deletion(-)
create mode 100644 include/linux/pks-keys.h
diff --git a/Documentation/core-api/protection-keys.rst b/Documentation/core-api/protection-keys.rst
index 58670e3ee39e..af283a1a9aa0 100644
--- a/Documentation/core-api/protection-keys.rst
+++ b/Documentation/core-api/protection-keys.rst
@@ -129,6 +129,10 @@ Kernel users intending to use PKS support should depend on
ARCH_HAS_SUPERVISOR_PKEYS, and select ARCH_ENABLE_SUPERVISOR_PKEYS to turn on
this support within the core.
+PKS Key Allocation
+------------------
+.. kernel-doc:: include/linux/pks-keys.h
+ :doc: PKS_KEY_ALLOCATION
MSR details
-----------
diff --git a/arch/x86/include/asm/pkeys_common.h b/arch/x86/include/asm/pkeys_common.h
index d02ab5bc3fff..efb101dee3aa 100644
--- a/arch/x86/include/asm/pkeys_common.h
+++ b/arch/x86/include/asm/pkeys_common.h
@@ -8,6 +8,7 @@
#define PKR_PKEY_SHIFT(pkey) (pkey * PKR_BITS_PER_PKEY)
+#define PKR_RW_KEY(pkey) (0 << PKR_PKEY_SHIFT(pkey))
#define PKR_AD_KEY(pkey) (PKR_AD_BIT << PKR_PKEY_SHIFT(pkey))
#define PKR_WD_KEY(pkey) (PKR_WD_BIT << PKR_PKEY_SHIFT(pkey))
diff --git a/arch/x86/mm/pkeys.c b/arch/x86/mm/pkeys.c
index 02629219e683..a5b5b86e97ce 100644
--- a/arch/x86/mm/pkeys.c
+++ b/arch/x86/mm/pkeys.c
@@ -217,7 +217,7 @@ void pks_setup(void)
if (!cpu_feature_enabled(X86_FEATURE_PKS))
return;
- wrmsrl(MSR_IA32_PKRS, 0);
+ wrmsrl(MSR_IA32_PKRS, PKS_INIT_VALUE);
cr4_set_bits(X86_CR4_PKS);
}
diff --git a/include/linux/pkeys.h b/include/linux/pkeys.h
index 86be8bf27b41..e9ea8f152915 100644
--- a/include/linux/pkeys.h
+++ b/include/linux/pkeys.h
@@ -48,4 +48,6 @@ static inline bool arch_pkeys_enabled(void)
#endif /* ! CONFIG_ARCH_HAS_PKEYS */
+#include <linux/pks-keys.h>
+
#endif /* _LINUX_PKEYS_H */
diff --git a/include/linux/pks-keys.h b/include/linux/pks-keys.h
new file mode 100644
index 000000000000..05fe4a1cf888
--- /dev/null
+++ b/include/linux/pks-keys.h
@@ -0,0 +1,59 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef _LINUX_PKS_KEYS_H
+#define _LINUX_PKS_KEYS_H
+
+#ifdef CONFIG_ARCH_ENABLE_SUPERVISOR_PKEYS
+
+#include <asm/pkeys_common.h>
+
+/**
+ * DOC: PKS_KEY_ALLOCATION
+ *
+ * Users reserve a key value by adding an entry to enum pks_pkey_consumers with
+ * a unique value from 1 to 15. Then replacing that value in the
+ * PKS_INIT_VALUE macro using the desired default protection; PKR_RW_KEY(),
+ * PKR_WD_KEY(), or PKR_AD_KEY().
+ *
+ * PKS_KEY_DEFAULT must remain 0 key with a default of read/write to support
+ * non-pks protected pages. Unused keys should be set (Access Disabled
+ * PKR_AD_KEY()).
+ *
+ * For example to configure a key for 'MY_FEATURE' with a default of Write
+ * Disabled.
+ *
+ * .. code-block:: c
+ *
+ * enum pks_pkey_consumers
+ * {
+ * PKS_KEY_DEFAULT = 0,
+ * PKS_KEY_MY_FEATURE = 1,
+ * }
+ *
+ * #define PKS_INIT_VALUE (PKR_RW_KEY(PKS_KEY_DEFAULT) |
+ * PKR_WD_KEY(PKS_KEY_MY_FEATURE) |
+ * PKR_AD_KEY(2) | PKR_AD_KEY(3) |
+ * PKR_AD_KEY(4) | PKR_AD_KEY(5) |
+ * PKR_AD_KEY(6) | PKR_AD_KEY(7) |
+ * PKR_AD_KEY(8) | PKR_AD_KEY(9) |
+ * PKR_AD_KEY(10) | PKR_AD_KEY(11) |
+ * PKR_AD_KEY(12) | PKR_AD_KEY(13) |
+ * PKR_AD_KEY(14) | PKR_AD_KEY(15))
+ *
+ */
+enum pks_pkey_consumers {
+ PKS_KEY_DEFAULT = 0, /* Must be 0 for default PTE values */
+};
+
+#define PKS_INIT_VALUE (PKR_RW_KEY(PKS_KEY_DEFAULT) | \
+ PKR_AD_KEY(1) | \
+ PKR_AD_KEY(2) | PKR_AD_KEY(3) | \
+ PKR_AD_KEY(4) | PKR_AD_KEY(5) | \
+ PKR_AD_KEY(6) | PKR_AD_KEY(7) | \
+ PKR_AD_KEY(8) | PKR_AD_KEY(9) | \
+ PKR_AD_KEY(10) | PKR_AD_KEY(11) | \
+ PKR_AD_KEY(12) | PKR_AD_KEY(13) | \
+ PKR_AD_KEY(14) | PKR_AD_KEY(15))
+
+#endif /* CONFIG_ARCH_ENABLE_SUPERVISOR_PKEYS */
+
+#endif /* _LINUX_PKS_KEYS_H */
--
2.31.1
next prev parent reply other threads:[~2022-01-27 17:55 UTC|newest]
Thread overview: 145+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-27 17:54 [PATCH V8 00/44] PKS/PMEM: Add Stray Write Protection ira.weiny
2022-01-27 17:54 ` [PATCH V8 01/44] entry: Create an internal irqentry_exit_cond_resched() call ira.weiny
2022-01-27 17:54 ` [PATCH V8 02/44] Documentation/protection-keys: Clean up documentation for User Space pkeys ira.weiny
2022-01-28 22:39 ` Dave Hansen
2022-02-01 23:49 ` Ira Weiny
2022-02-01 23:54 ` Dave Hansen
2022-01-27 17:54 ` [PATCH V8 03/44] x86/pkeys: Create pkeys_common.h ira.weiny
2022-01-28 22:43 ` Dave Hansen
2022-02-02 1:00 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 04/44] x86/pkeys: Add additional PKEY helper macros ira.weiny
2022-01-28 22:47 ` Dave Hansen
2022-02-02 20:21 ` Ira Weiny
2022-02-02 20:26 ` Dave Hansen
2022-02-02 20:28 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 05/44] x86/fpu: Refactor arch_set_user_pkey_access() ira.weiny
2022-01-28 22:50 ` Dave Hansen
2022-02-02 20:22 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 06/44] mm/pkeys: Add Kconfig options for PKS ira.weiny
2022-01-28 22:54 ` Dave Hansen
2022-01-28 23:10 ` Ira Weiny
2022-01-28 23:51 ` Dave Hansen
2022-02-04 19:08 ` Ira Weiny
2022-02-09 5:34 ` Ira Weiny
2022-02-14 19:20 ` Dave Hansen
2022-02-14 23:03 ` Ira Weiny
2022-01-29 0:06 ` Dave Hansen
2022-02-04 19:14 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 07/44] x86/pkeys: Add PKS CPU feature bit ira.weiny
2022-01-28 23:05 ` Dave Hansen
2022-02-04 19:21 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 08/44] x86/fault: Adjust WARN_ON for PKey fault ira.weiny
2022-01-28 23:10 ` Dave Hansen
2022-02-04 20:06 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 09/44] x86/pkeys: Enable PKS on cpus which support it ira.weiny
2022-01-28 23:18 ` Dave Hansen
2022-01-28 23:41 ` Ira Weiny
2022-01-28 23:53 ` Dave Hansen
2022-01-27 17:54 ` [PATCH V8 10/44] Documentation/pkeys: Add initial PKS documentation ira.weiny
2022-01-28 23:57 ` Dave Hansen
2022-01-27 17:54 ` ira.weiny [this message]
2022-01-29 0:02 ` [PATCH V8 11/44] mm/pkeys: Define static PKS key array and default values Dave Hansen
2022-02-04 23:54 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 12/44] mm/pkeys: Define PKS page table macros ira.weiny
2022-01-27 17:54 ` [PATCH V8 13/44] mm/pkeys: Add initial PKS Test code ira.weiny
2022-01-31 19:30 ` Edgecombe, Rick P
2022-02-09 23:44 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 14/44] x86/pkeys: Introduce pks_write_pkrs() ira.weiny
2022-01-29 0:12 ` Dave Hansen
2022-01-29 0:16 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 15/44] x86/pkeys: Preserve the PKS MSR on context switch ira.weiny
2022-01-29 0:22 ` Dave Hansen
2022-02-11 6:10 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 16/44] mm/pkeys: Introduce pks_mk_readwrite() ira.weiny
2022-01-31 23:10 ` Edgecombe, Rick P
2022-02-18 2:22 ` Ira Weiny
2022-02-01 17:40 ` Dave Hansen
2022-02-18 4:39 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 17/44] mm/pkeys: Introduce pks_mk_noaccess() ira.weiny
2022-01-27 17:54 ` [PATCH V8 18/44] x86/fault: Add a PKS test fault hook ira.weiny
2022-01-31 19:56 ` Edgecombe, Rick P
2022-02-11 20:40 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 19/44] mm/pkeys: PKS Testing, add pks_mk_*() tests ira.weiny
2022-02-01 17:45 ` Dave Hansen
2022-02-18 5:34 ` Ira Weiny
2022-02-18 15:28 ` Dave Hansen
2022-02-18 17:25 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 20/44] mm/pkeys: Add PKS test for context switching ira.weiny
2022-02-01 17:43 ` Edgecombe, Rick P
2022-02-22 21:42 ` Ira Weiny
2022-02-01 17:47 ` Edgecombe, Rick P
2022-02-01 19:52 ` Edgecombe, Rick P
2022-02-18 6:03 ` Ira Weiny
2022-02-18 6:02 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 21/44] x86/entry: Add auxiliary pt_regs space ira.weiny
2022-01-27 17:54 ` [PATCH V8 22/44] entry: Pass pt_regs to irqentry_exit_cond_resched() ira.weiny
2022-01-27 17:54 ` [PATCH V8 23/44] entry: Add architecture auxiliary pt_regs save/restore calls ira.weiny
2022-01-27 17:54 ` [PATCH V8 24/44] x86/entry: Define arch_{save|restore}_auxiliary_pt_regs() ira.weiny
2022-01-27 17:54 ` [PATCH V8 25/44] x86/pkeys: Preserve PKRS MSR across exceptions ira.weiny
2022-01-27 17:54 ` [PATCH V8 26/44] x86/fault: Print PKS MSR on fault ira.weiny
2022-02-01 18:13 ` Edgecombe, Rick P
2022-02-18 6:01 ` Ira Weiny
2022-02-18 17:28 ` Edgecombe, Rick P
2022-02-18 20:20 ` Dave Hansen
2022-02-18 20:54 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 27/44] mm/pkeys: Add PKS exception test ira.weiny
2022-01-27 17:54 ` [PATCH V8 28/44] mm/pkeys: Introduce pks_update_exception() ira.weiny
2022-01-27 17:54 ` [PATCH V8 29/44] mm/pkeys: Introduce PKS fault callbacks ira.weiny
2022-01-27 17:54 ` [PATCH V8 30/44] mm/pkeys: Test setting a PKS key in a custom fault callback ira.weiny
2022-02-01 0:55 ` Edgecombe, Rick P
2022-03-01 15:39 ` Ira Weiny
2022-02-01 17:42 ` Edgecombe, Rick P
2022-02-11 20:44 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 31/44] mm/pkeys: Add pks_available() ira.weiny
2022-01-27 17:54 ` [PATCH V8 32/44] memremap_pages: Add Kconfig for DEVMAP_ACCESS_PROTECTION ira.weiny
2022-02-04 15:49 ` Dan Williams
2022-01-27 17:54 ` [PATCH V8 33/44] memremap_pages: Introduce pgmap_protection_available() ira.weiny
2022-02-04 16:19 ` Dan Williams
2022-02-28 16:59 ` Ira Weiny
2022-03-01 15:56 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 34/44] memremap_pages: Introduce a PGMAP_PROTECTION flag ira.weiny
2022-01-27 17:54 ` [PATCH V8 35/44] memremap_pages: Introduce devmap_protected() ira.weiny
2022-01-27 17:54 ` [PATCH V8 36/44] memremap_pages: Reserve a PKS PKey for eventual use by PMEM ira.weiny
2022-02-01 18:35 ` Edgecombe, Rick P
2022-02-04 17:12 ` Dan Williams
2022-02-05 5:40 ` Ira Weiny
2022-02-05 8:19 ` Dan Williams
2022-02-06 18:14 ` Dan Williams
2022-02-08 22:48 ` Ira Weiny
2022-02-08 23:22 ` Dan Williams
2022-02-08 23:42 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 37/44] memremap_pages: Set PKS PKey in PTEs if PGMAP_PROTECTIONS is requested ira.weiny
2022-02-04 17:41 ` Dan Williams
2022-03-01 18:15 ` Ira Weiny
2022-01-27 17:54 ` [PATCH V8 38/44] memremap_pages: Define pgmap_mk_{readwrite|noaccess}() calls ira.weiny
2022-02-04 18:35 ` Dan Williams
2022-02-05 0:09 ` Ira Weiny
2022-02-05 0:19 ` Dan Williams
2022-02-05 0:25 ` Dan Williams
2022-02-05 0:27 ` Dan Williams
2022-02-05 5:55 ` Ira Weiny
2022-02-05 6:28 ` Dan Williams
2022-02-22 22:05 ` Ira Weiny
2022-01-27 17:55 ` [PATCH V8 39/44] memremap_pages: Add memremap.pks_fault_mode ira.weiny
2022-02-01 1:16 ` Edgecombe, Rick P
2022-03-02 0:20 ` Ira Weiny
2022-02-04 19:01 ` Dan Williams
2022-03-02 2:00 ` Ira Weiny
2022-01-27 17:55 ` [PATCH V8 40/44] memremap_pages: Add pgmap_protection_flag_invalid() ira.weiny
2022-02-01 1:37 ` Edgecombe, Rick P
2022-03-02 2:01 ` Ira Weiny
2022-02-04 19:18 ` Dan Williams
2022-01-27 17:55 ` [PATCH V8 41/44] kmap: Ensure kmap works for devmap pages ira.weiny
2022-02-04 21:07 ` Dan Williams
2022-03-01 19:45 ` Ira Weiny
2022-03-01 19:50 ` Ira Weiny
2022-03-01 20:05 ` Dan Williams
2022-03-01 23:03 ` Ira Weiny
2022-01-27 17:55 ` [PATCH V8 42/44] dax: Stray access protection for dax_direct_access() ira.weiny
2022-02-04 5:19 ` Dan Williams
2022-03-01 18:13 ` Ira Weiny
2022-01-27 17:55 ` [PATCH V8 43/44] nvdimm/pmem: Enable stray access protection ira.weiny
2022-02-04 21:10 ` Dan Williams
2022-03-01 18:18 ` Ira Weiny
2022-01-27 17:55 ` [PATCH V8 44/44] devdax: " ira.weiny
2022-02-04 21:12 ` Dan Williams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220127175505.851391-12-ira.weiny@intel.com \
--to=ira.weiny@intel.com \
--cc=dan.j.williams@intel.com \
--cc=dave.hansen@linux.intel.com \
--cc=fenghua.yu@intel.com \
--cc=hpa@zytor.com \
--cc=linux-kernel@vger.kernel.org \
--cc=rick.p.edgecombe@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).