From: Changbin Du <changbin.du@gmail.com>
To: corbet@lwn.net, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de
Cc: x86@kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, Changbin Du <changbin.du@gmail.com>,
Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Subject: [PATCH v3 06/27] Documentation: x86: convert entry_64.txt to reST
Date: Tue, 7 May 2019 01:09:02 +0800 [thread overview]
Message-ID: <20190506170923.7117-7-changbin.du@gmail.com> (raw)
In-Reply-To: <20190506170923.7117-1-changbin.du@gmail.com>
This converts the plain text documentation to reStructuredText format and
add it to Sphinx TOC tree. No essential content change.
Signed-off-by: Changbin Du <changbin.du@gmail.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/x86/{entry_64.txt => entry_64.rst} | 12 +++++++++---
Documentation/x86/index.rst | 1 +
2 files changed, 10 insertions(+), 3 deletions(-)
rename Documentation/x86/{entry_64.txt => entry_64.rst} (95%)
diff --git a/Documentation/x86/entry_64.txt b/Documentation/x86/entry_64.rst
similarity index 95%
rename from Documentation/x86/entry_64.txt
rename to Documentation/x86/entry_64.rst
index c1df8eba9dfd..a48b3f6ebbe8 100644
--- a/Documentation/x86/entry_64.txt
+++ b/Documentation/x86/entry_64.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============
+Kernel Entries
+==============
+
This file documents some of the kernel entries in
arch/x86/entry/entry_64.S. A lot of this explanation is adapted from
an email from Ingo Molnar:
@@ -59,7 +65,7 @@ Now, there's a secondary complication: there's a cheap way to test
which mode the CPU is in and an expensive way.
The cheap way is to pick this info off the entry frame on the kernel
-stack, from the CS of the ptregs area of the kernel stack:
+stack, from the CS of the ptregs area of the kernel stack::
xorl %ebx,%ebx
testl $3,CS+8(%rsp)
@@ -67,7 +73,7 @@ stack, from the CS of the ptregs area of the kernel stack:
SWAPGS
The expensive (paranoid) way is to read back the MSR_GS_BASE value
-(which is what SWAPGS modifies):
+(which is what SWAPGS modifies)::
movl $1,%ebx
movl $MSR_GS_BASE,%ecx
@@ -76,7 +82,7 @@ The expensive (paranoid) way is to read back the MSR_GS_BASE value
js 1f /* negative -> in kernel */
SWAPGS
xorl %ebx,%ebx
-1: ret
+ 1: ret
If we are at an interrupt or user-trap/gate-alike boundary then we can
use the faster check: the stack will be a reliable indicator of
diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst
index f6f4e0fc79f2..0e3e73458738 100644
--- a/Documentation/x86/index.rst
+++ b/Documentation/x86/index.rst
@@ -12,3 +12,4 @@ x86-specific Documentation
topology
exception-tables
kernel-stacks
+ entry_64
--
2.20.1
next prev parent reply other threads:[~2019-05-06 17:10 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-06 17:08 [PATCH v3 00/27] Include linux x86 docs into Sphinx TOC tree Changbin Du
2019-05-06 17:08 ` [PATCH v3 01/27] Documentation: add Linux x86 docs to " Changbin Du
2019-05-06 17:08 ` [PATCH v3 02/27] Documentation: x86: convert boot.txt to reST Changbin Du
2019-05-06 17:52 ` Mauro Carvalho Chehab
2019-05-08 14:54 ` Changbin Du
2019-05-06 17:08 ` [PATCH v3 03/27] Documentation: x86: convert topology.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 04/27] Documentation: x86: convert exception-tables.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 05/27] Documentation: x86: convert kernel-stacks " Changbin Du
2019-05-06 17:09 ` Changbin Du [this message]
2019-05-06 17:09 ` [PATCH v3 07/27] Documentation: x86: convert earlyprintk.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 08/27] Documentation: x86: convert zero-page.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 09/27] Documentation: x86: convert tlb.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 10/27] Documentation: x86: convert mtrr.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 11/27] Documentation: x86: convert pat.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 12/27] Documentation: x86: convert protection-keys.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 13/27] Documentation: x86: convert intel_mpx.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 14/27] Documentation: x86: convert amd-memory-encryption.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 15/27] Documentation: x86: convert pti.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 16/27] Documentation: x86: convert microcode.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 17/27] Documentation: x86: convert resctrl_ui.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 18/27] Documentation: x86: convert orc-unwinder.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 19/27] Documentation: x86: convert usb-legacy-support.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 20/27] Documentation: x86: convert i386/IO-APIC.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 21/27] Documentation: x86: convert x86_64/boot-options.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 22/27] Documentation: x86: convert x86_64/uefi.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 23/27] Documentation: x86: convert x86_64/mm.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 24/27] Documentation: x86: convert x86_64/5level-paging.txt " Changbin Du
2019-05-06 17:09 ` [PATCH v3 25/27] Documentation: x86: convert x86_64/fake-numa-for-cpusets " Changbin Du
2019-05-06 17:09 ` [PATCH v3 26/27] Documentation: x86: convert x86_64/cpu-hotplug-spec " Changbin Du
2019-05-06 17:09 ` [PATCH v3 27/27] Documentation: x86: convert x86_64/machinecheck " Changbin Du
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=20190506170923.7117-7-changbin.du@gmail.com \
--to=changbin.du@gmail.com \
--cc=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mingo@redhat.com \
--cc=tglx@linutronix.de \
--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;
as well as URLs for NNTP newsgroup(s).