From: Dave Hansen <dave@sr71.net>
To: linux-kernel@vger.kernel.org
Cc: Dave Hansen <dave@sr71.net>,
dave.hansen@intel.com, x86@kernel.org, corbet@lwn.net,
linux-doc@vger.kernel.org
Subject: [PATCH] x86/pkeys: Update documentation
Date: Tue, 04 Oct 2016 09:38:57 -0700 [thread overview]
Message-ID: <20161004163857.71E0D6F6@viggo.jf.intel.com> (raw)
From: Dave Hansen <dave.hansen@intel.com>
There are a few items that have gotten stale in the protection
keys documentation. The config option description only applied
to the execute-only support and is not accurate for the current
code. There was also a typo with the number of system calls. I
also wanted to call out that pkey_set() is not a kernel-provided
facility, and where to find an implementation.
Signed-off-by: Dave Hansen <dave.hansen@intel.com>
Cc: x86@kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
b/Documentation/x86/protection-keys.txt | 14 +++++---------
1 file changed, 5 insertions(+), 9 deletions(-)
diff -puN Documentation/x86/protection-keys.txt~pkeys-docfix Documentation/x86/protection-keys.txt
--- a/Documentation/x86/protection-keys.txt~pkeys-docfix 2016-10-04 09:31:01.361928429 -0700
+++ b/Documentation/x86/protection-keys.txt 2016-10-04 09:32:39.142383585 -0700
@@ -20,7 +20,7 @@ instruction fetches.
=========================== Syscalls ===========================
-There are 2 system calls which directly interact with pkeys:
+There are 3 system calls which directly interact with pkeys:
int pkey_alloc(unsigned long flags, unsigned long init_access_rights)
int pkey_free(int pkey);
@@ -52,6 +52,10 @@ is no longer in use:
munmap(ptr, PAGE_SIZE);
pkey_free(pkey);
+(Note: pkey_set() is a wrapper for the RDPKRU and WRPKRU instructions.
+ An example implementation can be found in
+ tools/testing/selftests/x86/protection_keys.c)
+
=========================== Behavior ===========================
The kernel attempts to make protection keys consistent with the
@@ -79,11 +83,3 @@ with a read():
The kernel will send a SIGSEGV in both cases, but si_code will be set
to SEGV_PKERR when violating protection keys versus SEGV_ACCERR when
the plain mprotect() permissions are violated.
-
-=========================== Config Option ===========================
-
-This config option adds approximately 1.5kb of text. and 50 bytes of
-data to the executable. A workload which does large O_DIRECT reads
-of holes in XFS files was run to exercise get_user_pages_fast(). No
-performance delta was observed with the config option
-enabled or disabled.
_
next reply other threads:[~2016-10-04 16:39 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-04 16:38 Dave Hansen [this message]
2016-10-05 8:39 ` [tip:mm/pkeys] " tip-bot for Dave Hansen
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=20161004163857.71E0D6F6@viggo.jf.intel.com \
--to=dave@sr71.net \
--cc=corbet@lwn.net \
--cc=dave.hansen@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=x86@kernel.org \
/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
Powered by JetHome