All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mark Brown <broonie@kernel.org>
To: Catalin Marinas <catalin.marinas@arm.com>,
	Will Deacon <will@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	Andrew Morton <akpm@linux-foundation.org>,
	Marc Zyngier <maz@kernel.org>,
	Oliver Upton <oliver.upton@linux.dev>,
	James Morse <james.morse@arm.com>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	Arnd Bergmann <arnd@arndb.de>, Oleg Nesterov <oleg@redhat.com>,
	Eric Biederman <ebiederm@xmission.com>,
	Kees Cook <keescook@chromium.org>, Shuah Khan <shuah@kernel.org>,
	"Rick P. Edgecombe" <rick.p.edgecombe@intel.com>,
	Deepak Gupta <debug@rivosinc.com>,
	Ard Biesheuvel <ardb@kernel.org>,
	Szabolcs Nagy <Szabolcs.Nagy@arm.com>
Cc: "H.J. Lu" <hjl.tools@gmail.com>,
	Paul Walmsley <paul.walmsley@sifive.com>,
	Palmer Dabbelt <palmer@dabbelt.com>,
	Albert Ou <aou@eecs.berkeley.edu>,
	Florian Weimer <fweimer@redhat.com>,
	Christian Brauner <brauner@kernel.org>,
	Thiago Jung Bauermann <thiago.bauermann@linaro.org>,
	linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org,
	kvmarm@lists.linux.dev, linux-fsdevel@vger.kernel.org,
	linux-arch@vger.kernel.org, linux-mm@kvack.org,
	linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-riscv@lists.infradead.org, Mark Brown <broonie@kernel.org>
Subject: [PATCH v7 20/39] arm64/gcs: Context switch GCS state for EL0
Date: Wed, 22 Nov 2023 09:42:30 +0000	[thread overview]
Message-ID: <20231122-arm64-gcs-v7-20-201c483bd775@kernel.org> (raw)
In-Reply-To: <20231122-arm64-gcs-v7-0-201c483bd775@kernel.org>

There are two registers controlling the GCS state of EL0, GCSPR_EL0 which
is the current GCS pointer and GCSCRE0_EL1 which has enable bits for the
specific GCS functionality enabled for EL0. Manage these on context switch
and process lifetime events, GCS is reset on exec().  Also ensure that
any changes to the GCS memory are visible to other PEs and that changes
from other PEs are visible on this one by issuing a GCSB DSYNC when
moving to or from a thread with GCS.

Since the current GCS configuration of a thread will be visible to
userspace we store the configuration in the format used with userspace
and provide a helper which configures the system register as needed.

On systems that support GCS we always allow access to GCSPR_EL0, this
facilitates reporting of GCS faults if userspace implements disabling of
GCS on error - the GCS can still be discovered and examined even if GCS
has been disabled.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 arch/arm64/include/asm/gcs.h       | 24 ++++++++++++++++
 arch/arm64/include/asm/processor.h |  6 ++++
 arch/arm64/kernel/process.c        | 56 ++++++++++++++++++++++++++++++++++++++
 arch/arm64/mm/Makefile             |  1 +
 arch/arm64/mm/gcs.c                | 39 ++++++++++++++++++++++++++
 5 files changed, 126 insertions(+)

diff --git a/arch/arm64/include/asm/gcs.h b/arch/arm64/include/asm/gcs.h
index 7c5e95218db6..04594ef59dad 100644
--- a/arch/arm64/include/asm/gcs.h
+++ b/arch/arm64/include/asm/gcs.h
@@ -48,4 +48,28 @@ static inline u64 gcsss2(void)
 	return Xt;
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+static inline bool task_gcs_el0_enabled(struct task_struct *task)
+{
+	return current->thread.gcs_el0_mode & PR_SHADOW_STACK_ENABLE;
+}
+
+void gcs_set_el0_mode(struct task_struct *task);
+void gcs_free(struct task_struct *task);
+void gcs_preserve_current_state(void);
+
+#else
+
+static inline bool task_gcs_el0_enabled(struct task_struct *task)
+{
+	return false;
+}
+
+static inline void gcs_set_el0_mode(struct task_struct *task) { }
+static inline void gcs_free(struct task_struct *task) { }
+static inline void gcs_preserve_current_state(void) { }
+
+#endif
+
 #endif
diff --git a/arch/arm64/include/asm/processor.h b/arch/arm64/include/asm/processor.h
index e5bc54522e71..c28681cf9721 100644
--- a/arch/arm64/include/asm/processor.h
+++ b/arch/arm64/include/asm/processor.h
@@ -179,6 +179,12 @@ struct thread_struct {
 	u64			sctlr_user;
 	u64			svcr;
 	u64			tpidr2_el0;
+#ifdef CONFIG_ARM64_GCS
+	unsigned int		gcs_el0_mode;
+	u64			gcspr_el0;
+	u64			gcs_base;
+	u64			gcs_size;
+#endif
 };
 
 static inline unsigned int thread_get_vl(struct thread_struct *thread,
diff --git a/arch/arm64/kernel/process.c b/arch/arm64/kernel/process.c
index 7387b68c745b..fd80b43c2969 100644
--- a/arch/arm64/kernel/process.c
+++ b/arch/arm64/kernel/process.c
@@ -48,6 +48,7 @@
 #include <asm/cacheflush.h>
 #include <asm/exec.h>
 #include <asm/fpsimd.h>
+#include <asm/gcs.h>
 #include <asm/mmu_context.h>
 #include <asm/mte.h>
 #include <asm/processor.h>
@@ -271,12 +272,32 @@ static void flush_tagged_addr_state(void)
 		clear_thread_flag(TIF_TAGGED_ADDR);
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+static void flush_gcs(void)
+{
+	if (!system_supports_gcs())
+		return;
+
+	gcs_free(current);
+	current->thread.gcs_el0_mode = 0;
+	write_sysreg_s(0, SYS_GCSCRE0_EL1);
+	write_sysreg_s(0, SYS_GCSPR_EL0);
+}
+
+#else
+
+static void flush_gcs(void) { }
+
+#endif
+
 void flush_thread(void)
 {
 	fpsimd_flush_thread();
 	tls_thread_flush();
 	flush_ptrace_hw_breakpoint(current);
 	flush_tagged_addr_state();
+	flush_gcs();
 }
 
 void arch_release_task_struct(struct task_struct *tsk)
@@ -474,6 +495,40 @@ static void entry_task_switch(struct task_struct *next)
 	__this_cpu_write(__entry_task, next);
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+void gcs_preserve_current_state(void)
+{
+	if (task_gcs_el0_enabled(current))
+		current->thread.gcspr_el0 = read_sysreg_s(SYS_GCSPR_EL0);
+}
+
+static void gcs_thread_switch(struct task_struct *next)
+{
+	if (!system_supports_gcs())
+		return;
+
+	gcs_preserve_current_state();
+
+	gcs_set_el0_mode(next);
+	write_sysreg_s(next->thread.gcspr_el0, SYS_GCSPR_EL0);
+
+	/*
+	 * Ensure that GCS changes are observable by/from other PEs in
+	 * case of migration.
+	 */
+	if (task_gcs_el0_enabled(current) || task_gcs_el0_enabled(next))
+		gcsb_dsync();
+}
+
+#else
+
+static void gcs_thread_switch(struct task_struct *next)
+{
+}
+
+#endif
+
 /*
  * ARM erratum 1418040 handling, affecting the 32bit view of CNTVCT.
  * Ensure access is disabled when switching to a 32bit task, ensure
@@ -533,6 +588,7 @@ struct task_struct *__switch_to(struct task_struct *prev,
 	ssbs_thread_switch(next);
 	erratum_1418040_thread_switch(next);
 	ptrauth_thread_switch_user(next);
+	gcs_thread_switch(next);
 
 	/*
 	 * Complete any pending TLB or cache maintenance on this CPU in case
diff --git a/arch/arm64/mm/Makefile b/arch/arm64/mm/Makefile
index dbd1bc95967d..4e7cb2f02999 100644
--- a/arch/arm64/mm/Makefile
+++ b/arch/arm64/mm/Makefile
@@ -10,6 +10,7 @@ obj-$(CONFIG_TRANS_TABLE)	+= trans_pgd.o
 obj-$(CONFIG_TRANS_TABLE)	+= trans_pgd-asm.o
 obj-$(CONFIG_DEBUG_VIRTUAL)	+= physaddr.o
 obj-$(CONFIG_ARM64_MTE)		+= mteswap.o
+obj-$(CONFIG_ARM64_GCS)		+= gcs.o
 KASAN_SANITIZE_physaddr.o	+= n
 
 obj-$(CONFIG_KASAN)		+= kasan_init.o
diff --git a/arch/arm64/mm/gcs.c b/arch/arm64/mm/gcs.c
new file mode 100644
index 000000000000..b0a67efc522b
--- /dev/null
+++ b/arch/arm64/mm/gcs.c
@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+#include <linux/mm.h>
+#include <linux/mman.h>
+#include <linux/syscalls.h>
+#include <linux/types.h>
+
+#include <asm/cpufeature.h>
+#include <asm/page.h>
+
+/*
+ * Apply the GCS mode configured for the specified task to the
+ * hardware.
+ */
+void gcs_set_el0_mode(struct task_struct *task)
+{
+	u64 gcscre0_el1 = GCSCRE0_EL1_nTR;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_ENABLE)
+		gcscre0_el1 |= GCSCRE0_EL1_RVCHKEN | GCSCRE0_EL1_PCRSEL;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_WRITE)
+		gcscre0_el1 |= GCSCRE0_EL1_STREn;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_PUSH)
+		gcscre0_el1 |= GCSCRE0_EL1_PUSHMEn;
+
+	write_sysreg_s(gcscre0_el1, SYS_GCSCRE0_EL1);
+}
+
+void gcs_free(struct task_struct *task)
+{
+	if (task->thread.gcs_base)
+		vm_munmap(task->thread.gcs_base, task->thread.gcs_size);
+
+	task->thread.gcspr_el0 = 0;
+	task->thread.gcs_base = 0;
+	task->thread.gcs_size = 0;
+}

-- 
2.39.2


WARNING: multiple messages have this Message-ID (diff)
From: Mark Brown <broonie@kernel.org>
To: Catalin Marinas <catalin.marinas@arm.com>,
	 Will Deacon <will@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	 Andrew Morton <akpm@linux-foundation.org>,
	Marc Zyngier <maz@kernel.org>,
	 Oliver Upton <oliver.upton@linux.dev>,
	James Morse <james.morse@arm.com>,
	 Suzuki K Poulose <suzuki.poulose@arm.com>,
	Arnd Bergmann <arnd@arndb.de>,  Oleg Nesterov <oleg@redhat.com>,
	Eric Biederman <ebiederm@xmission.com>,
	 Kees Cook <keescook@chromium.org>, Shuah Khan <shuah@kernel.org>,
	 "Rick P. Edgecombe" <rick.p.edgecombe@intel.com>,
	 Deepak Gupta <debug@rivosinc.com>,
	Ard Biesheuvel <ardb@kernel.org>,
	 Szabolcs Nagy <Szabolcs.Nagy@arm.com>
Cc: "H.J. Lu" <hjl.tools@gmail.com>,
	 Paul Walmsley <paul.walmsley@sifive.com>,
	 Palmer Dabbelt <palmer@dabbelt.com>,
	Albert Ou <aou@eecs.berkeley.edu>,
	 Florian Weimer <fweimer@redhat.com>,
	Christian Brauner <brauner@kernel.org>,
	 Thiago Jung Bauermann <thiago.bauermann@linaro.org>,
	 linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org,
	 kvmarm@lists.linux.dev, linux-fsdevel@vger.kernel.org,
	 linux-arch@vger.kernel.org, linux-mm@kvack.org,
	 linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
	 linux-riscv@lists.infradead.org, Mark Brown <broonie@kernel.org>
Subject: [PATCH v7 20/39] arm64/gcs: Context switch GCS state for EL0
Date: Wed, 22 Nov 2023 09:42:30 +0000	[thread overview]
Message-ID: <20231122-arm64-gcs-v7-20-201c483bd775@kernel.org> (raw)
In-Reply-To: <20231122-arm64-gcs-v7-0-201c483bd775@kernel.org>

There are two registers controlling the GCS state of EL0, GCSPR_EL0 which
is the current GCS pointer and GCSCRE0_EL1 which has enable bits for the
specific GCS functionality enabled for EL0. Manage these on context switch
and process lifetime events, GCS is reset on exec().  Also ensure that
any changes to the GCS memory are visible to other PEs and that changes
from other PEs are visible on this one by issuing a GCSB DSYNC when
moving to or from a thread with GCS.

Since the current GCS configuration of a thread will be visible to
userspace we store the configuration in the format used with userspace
and provide a helper which configures the system register as needed.

On systems that support GCS we always allow access to GCSPR_EL0, this
facilitates reporting of GCS faults if userspace implements disabling of
GCS on error - the GCS can still be discovered and examined even if GCS
has been disabled.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 arch/arm64/include/asm/gcs.h       | 24 ++++++++++++++++
 arch/arm64/include/asm/processor.h |  6 ++++
 arch/arm64/kernel/process.c        | 56 ++++++++++++++++++++++++++++++++++++++
 arch/arm64/mm/Makefile             |  1 +
 arch/arm64/mm/gcs.c                | 39 ++++++++++++++++++++++++++
 5 files changed, 126 insertions(+)

diff --git a/arch/arm64/include/asm/gcs.h b/arch/arm64/include/asm/gcs.h
index 7c5e95218db6..04594ef59dad 100644
--- a/arch/arm64/include/asm/gcs.h
+++ b/arch/arm64/include/asm/gcs.h
@@ -48,4 +48,28 @@ static inline u64 gcsss2(void)
 	return Xt;
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+static inline bool task_gcs_el0_enabled(struct task_struct *task)
+{
+	return current->thread.gcs_el0_mode & PR_SHADOW_STACK_ENABLE;
+}
+
+void gcs_set_el0_mode(struct task_struct *task);
+void gcs_free(struct task_struct *task);
+void gcs_preserve_current_state(void);
+
+#else
+
+static inline bool task_gcs_el0_enabled(struct task_struct *task)
+{
+	return false;
+}
+
+static inline void gcs_set_el0_mode(struct task_struct *task) { }
+static inline void gcs_free(struct task_struct *task) { }
+static inline void gcs_preserve_current_state(void) { }
+
+#endif
+
 #endif
diff --git a/arch/arm64/include/asm/processor.h b/arch/arm64/include/asm/processor.h
index e5bc54522e71..c28681cf9721 100644
--- a/arch/arm64/include/asm/processor.h
+++ b/arch/arm64/include/asm/processor.h
@@ -179,6 +179,12 @@ struct thread_struct {
 	u64			sctlr_user;
 	u64			svcr;
 	u64			tpidr2_el0;
+#ifdef CONFIG_ARM64_GCS
+	unsigned int		gcs_el0_mode;
+	u64			gcspr_el0;
+	u64			gcs_base;
+	u64			gcs_size;
+#endif
 };
 
 static inline unsigned int thread_get_vl(struct thread_struct *thread,
diff --git a/arch/arm64/kernel/process.c b/arch/arm64/kernel/process.c
index 7387b68c745b..fd80b43c2969 100644
--- a/arch/arm64/kernel/process.c
+++ b/arch/arm64/kernel/process.c
@@ -48,6 +48,7 @@
 #include <asm/cacheflush.h>
 #include <asm/exec.h>
 #include <asm/fpsimd.h>
+#include <asm/gcs.h>
 #include <asm/mmu_context.h>
 #include <asm/mte.h>
 #include <asm/processor.h>
@@ -271,12 +272,32 @@ static void flush_tagged_addr_state(void)
 		clear_thread_flag(TIF_TAGGED_ADDR);
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+static void flush_gcs(void)
+{
+	if (!system_supports_gcs())
+		return;
+
+	gcs_free(current);
+	current->thread.gcs_el0_mode = 0;
+	write_sysreg_s(0, SYS_GCSCRE0_EL1);
+	write_sysreg_s(0, SYS_GCSPR_EL0);
+}
+
+#else
+
+static void flush_gcs(void) { }
+
+#endif
+
 void flush_thread(void)
 {
 	fpsimd_flush_thread();
 	tls_thread_flush();
 	flush_ptrace_hw_breakpoint(current);
 	flush_tagged_addr_state();
+	flush_gcs();
 }
 
 void arch_release_task_struct(struct task_struct *tsk)
@@ -474,6 +495,40 @@ static void entry_task_switch(struct task_struct *next)
 	__this_cpu_write(__entry_task, next);
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+void gcs_preserve_current_state(void)
+{
+	if (task_gcs_el0_enabled(current))
+		current->thread.gcspr_el0 = read_sysreg_s(SYS_GCSPR_EL0);
+}
+
+static void gcs_thread_switch(struct task_struct *next)
+{
+	if (!system_supports_gcs())
+		return;
+
+	gcs_preserve_current_state();
+
+	gcs_set_el0_mode(next);
+	write_sysreg_s(next->thread.gcspr_el0, SYS_GCSPR_EL0);
+
+	/*
+	 * Ensure that GCS changes are observable by/from other PEs in
+	 * case of migration.
+	 */
+	if (task_gcs_el0_enabled(current) || task_gcs_el0_enabled(next))
+		gcsb_dsync();
+}
+
+#else
+
+static void gcs_thread_switch(struct task_struct *next)
+{
+}
+
+#endif
+
 /*
  * ARM erratum 1418040 handling, affecting the 32bit view of CNTVCT.
  * Ensure access is disabled when switching to a 32bit task, ensure
@@ -533,6 +588,7 @@ struct task_struct *__switch_to(struct task_struct *prev,
 	ssbs_thread_switch(next);
 	erratum_1418040_thread_switch(next);
 	ptrauth_thread_switch_user(next);
+	gcs_thread_switch(next);
 
 	/*
 	 * Complete any pending TLB or cache maintenance on this CPU in case
diff --git a/arch/arm64/mm/Makefile b/arch/arm64/mm/Makefile
index dbd1bc95967d..4e7cb2f02999 100644
--- a/arch/arm64/mm/Makefile
+++ b/arch/arm64/mm/Makefile
@@ -10,6 +10,7 @@ obj-$(CONFIG_TRANS_TABLE)	+= trans_pgd.o
 obj-$(CONFIG_TRANS_TABLE)	+= trans_pgd-asm.o
 obj-$(CONFIG_DEBUG_VIRTUAL)	+= physaddr.o
 obj-$(CONFIG_ARM64_MTE)		+= mteswap.o
+obj-$(CONFIG_ARM64_GCS)		+= gcs.o
 KASAN_SANITIZE_physaddr.o	+= n
 
 obj-$(CONFIG_KASAN)		+= kasan_init.o
diff --git a/arch/arm64/mm/gcs.c b/arch/arm64/mm/gcs.c
new file mode 100644
index 000000000000..b0a67efc522b
--- /dev/null
+++ b/arch/arm64/mm/gcs.c
@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+#include <linux/mm.h>
+#include <linux/mman.h>
+#include <linux/syscalls.h>
+#include <linux/types.h>
+
+#include <asm/cpufeature.h>
+#include <asm/page.h>
+
+/*
+ * Apply the GCS mode configured for the specified task to the
+ * hardware.
+ */
+void gcs_set_el0_mode(struct task_struct *task)
+{
+	u64 gcscre0_el1 = GCSCRE0_EL1_nTR;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_ENABLE)
+		gcscre0_el1 |= GCSCRE0_EL1_RVCHKEN | GCSCRE0_EL1_PCRSEL;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_WRITE)
+		gcscre0_el1 |= GCSCRE0_EL1_STREn;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_PUSH)
+		gcscre0_el1 |= GCSCRE0_EL1_PUSHMEn;
+
+	write_sysreg_s(gcscre0_el1, SYS_GCSCRE0_EL1);
+}
+
+void gcs_free(struct task_struct *task)
+{
+	if (task->thread.gcs_base)
+		vm_munmap(task->thread.gcs_base, task->thread.gcs_size);
+
+	task->thread.gcspr_el0 = 0;
+	task->thread.gcs_base = 0;
+	task->thread.gcs_size = 0;
+}

-- 
2.39.2


_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

WARNING: multiple messages have this Message-ID (diff)
From: Mark Brown <broonie@kernel.org>
To: Catalin Marinas <catalin.marinas@arm.com>,
	 Will Deacon <will@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	 Andrew Morton <akpm@linux-foundation.org>,
	Marc Zyngier <maz@kernel.org>,
	 Oliver Upton <oliver.upton@linux.dev>,
	James Morse <james.morse@arm.com>,
	 Suzuki K Poulose <suzuki.poulose@arm.com>,
	Arnd Bergmann <arnd@arndb.de>,  Oleg Nesterov <oleg@redhat.com>,
	Eric Biederman <ebiederm@xmission.com>,
	 Kees Cook <keescook@chromium.org>, Shuah Khan <shuah@kernel.org>,
	 "Rick P. Edgecombe" <rick.p.edgecombe@intel.com>,
	 Deepak Gupta <debug@rivosinc.com>,
	Ard Biesheuvel <ardb@kernel.org>,
	 Szabolcs Nagy <Szabolcs.Nagy@arm.com>
Cc: "H.J. Lu" <hjl.tools@gmail.com>,
	 Paul Walmsley <paul.walmsley@sifive.com>,
	 Palmer Dabbelt <palmer@dabbelt.com>,
	Albert Ou <aou@eecs.berkeley.edu>,
	 Florian Weimer <fweimer@redhat.com>,
	Christian Brauner <brauner@kernel.org>,
	 Thiago Jung Bauermann <thiago.bauermann@linaro.org>,
	 linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org,
	 kvmarm@lists.linux.dev, linux-fsdevel@vger.kernel.org,
	 linux-arch@vger.kernel.org, linux-mm@kvack.org,
	 linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
	 linux-riscv@lists.infradead.org, Mark Brown <broonie@kernel.org>
Subject: [PATCH v7 20/39] arm64/gcs: Context switch GCS state for EL0
Date: Wed, 22 Nov 2023 09:42:30 +0000	[thread overview]
Message-ID: <20231122-arm64-gcs-v7-20-201c483bd775@kernel.org> (raw)
In-Reply-To: <20231122-arm64-gcs-v7-0-201c483bd775@kernel.org>

There are two registers controlling the GCS state of EL0, GCSPR_EL0 which
is the current GCS pointer and GCSCRE0_EL1 which has enable bits for the
specific GCS functionality enabled for EL0. Manage these on context switch
and process lifetime events, GCS is reset on exec().  Also ensure that
any changes to the GCS memory are visible to other PEs and that changes
from other PEs are visible on this one by issuing a GCSB DSYNC when
moving to or from a thread with GCS.

Since the current GCS configuration of a thread will be visible to
userspace we store the configuration in the format used with userspace
and provide a helper which configures the system register as needed.

On systems that support GCS we always allow access to GCSPR_EL0, this
facilitates reporting of GCS faults if userspace implements disabling of
GCS on error - the GCS can still be discovered and examined even if GCS
has been disabled.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 arch/arm64/include/asm/gcs.h       | 24 ++++++++++++++++
 arch/arm64/include/asm/processor.h |  6 ++++
 arch/arm64/kernel/process.c        | 56 ++++++++++++++++++++++++++++++++++++++
 arch/arm64/mm/Makefile             |  1 +
 arch/arm64/mm/gcs.c                | 39 ++++++++++++++++++++++++++
 5 files changed, 126 insertions(+)

diff --git a/arch/arm64/include/asm/gcs.h b/arch/arm64/include/asm/gcs.h
index 7c5e95218db6..04594ef59dad 100644
--- a/arch/arm64/include/asm/gcs.h
+++ b/arch/arm64/include/asm/gcs.h
@@ -48,4 +48,28 @@ static inline u64 gcsss2(void)
 	return Xt;
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+static inline bool task_gcs_el0_enabled(struct task_struct *task)
+{
+	return current->thread.gcs_el0_mode & PR_SHADOW_STACK_ENABLE;
+}
+
+void gcs_set_el0_mode(struct task_struct *task);
+void gcs_free(struct task_struct *task);
+void gcs_preserve_current_state(void);
+
+#else
+
+static inline bool task_gcs_el0_enabled(struct task_struct *task)
+{
+	return false;
+}
+
+static inline void gcs_set_el0_mode(struct task_struct *task) { }
+static inline void gcs_free(struct task_struct *task) { }
+static inline void gcs_preserve_current_state(void) { }
+
+#endif
+
 #endif
diff --git a/arch/arm64/include/asm/processor.h b/arch/arm64/include/asm/processor.h
index e5bc54522e71..c28681cf9721 100644
--- a/arch/arm64/include/asm/processor.h
+++ b/arch/arm64/include/asm/processor.h
@@ -179,6 +179,12 @@ struct thread_struct {
 	u64			sctlr_user;
 	u64			svcr;
 	u64			tpidr2_el0;
+#ifdef CONFIG_ARM64_GCS
+	unsigned int		gcs_el0_mode;
+	u64			gcspr_el0;
+	u64			gcs_base;
+	u64			gcs_size;
+#endif
 };
 
 static inline unsigned int thread_get_vl(struct thread_struct *thread,
diff --git a/arch/arm64/kernel/process.c b/arch/arm64/kernel/process.c
index 7387b68c745b..fd80b43c2969 100644
--- a/arch/arm64/kernel/process.c
+++ b/arch/arm64/kernel/process.c
@@ -48,6 +48,7 @@
 #include <asm/cacheflush.h>
 #include <asm/exec.h>
 #include <asm/fpsimd.h>
+#include <asm/gcs.h>
 #include <asm/mmu_context.h>
 #include <asm/mte.h>
 #include <asm/processor.h>
@@ -271,12 +272,32 @@ static void flush_tagged_addr_state(void)
 		clear_thread_flag(TIF_TAGGED_ADDR);
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+static void flush_gcs(void)
+{
+	if (!system_supports_gcs())
+		return;
+
+	gcs_free(current);
+	current->thread.gcs_el0_mode = 0;
+	write_sysreg_s(0, SYS_GCSCRE0_EL1);
+	write_sysreg_s(0, SYS_GCSPR_EL0);
+}
+
+#else
+
+static void flush_gcs(void) { }
+
+#endif
+
 void flush_thread(void)
 {
 	fpsimd_flush_thread();
 	tls_thread_flush();
 	flush_ptrace_hw_breakpoint(current);
 	flush_tagged_addr_state();
+	flush_gcs();
 }
 
 void arch_release_task_struct(struct task_struct *tsk)
@@ -474,6 +495,40 @@ static void entry_task_switch(struct task_struct *next)
 	__this_cpu_write(__entry_task, next);
 }
 
+#ifdef CONFIG_ARM64_GCS
+
+void gcs_preserve_current_state(void)
+{
+	if (task_gcs_el0_enabled(current))
+		current->thread.gcspr_el0 = read_sysreg_s(SYS_GCSPR_EL0);
+}
+
+static void gcs_thread_switch(struct task_struct *next)
+{
+	if (!system_supports_gcs())
+		return;
+
+	gcs_preserve_current_state();
+
+	gcs_set_el0_mode(next);
+	write_sysreg_s(next->thread.gcspr_el0, SYS_GCSPR_EL0);
+
+	/*
+	 * Ensure that GCS changes are observable by/from other PEs in
+	 * case of migration.
+	 */
+	if (task_gcs_el0_enabled(current) || task_gcs_el0_enabled(next))
+		gcsb_dsync();
+}
+
+#else
+
+static void gcs_thread_switch(struct task_struct *next)
+{
+}
+
+#endif
+
 /*
  * ARM erratum 1418040 handling, affecting the 32bit view of CNTVCT.
  * Ensure access is disabled when switching to a 32bit task, ensure
@@ -533,6 +588,7 @@ struct task_struct *__switch_to(struct task_struct *prev,
 	ssbs_thread_switch(next);
 	erratum_1418040_thread_switch(next);
 	ptrauth_thread_switch_user(next);
+	gcs_thread_switch(next);
 
 	/*
 	 * Complete any pending TLB or cache maintenance on this CPU in case
diff --git a/arch/arm64/mm/Makefile b/arch/arm64/mm/Makefile
index dbd1bc95967d..4e7cb2f02999 100644
--- a/arch/arm64/mm/Makefile
+++ b/arch/arm64/mm/Makefile
@@ -10,6 +10,7 @@ obj-$(CONFIG_TRANS_TABLE)	+= trans_pgd.o
 obj-$(CONFIG_TRANS_TABLE)	+= trans_pgd-asm.o
 obj-$(CONFIG_DEBUG_VIRTUAL)	+= physaddr.o
 obj-$(CONFIG_ARM64_MTE)		+= mteswap.o
+obj-$(CONFIG_ARM64_GCS)		+= gcs.o
 KASAN_SANITIZE_physaddr.o	+= n
 
 obj-$(CONFIG_KASAN)		+= kasan_init.o
diff --git a/arch/arm64/mm/gcs.c b/arch/arm64/mm/gcs.c
new file mode 100644
index 000000000000..b0a67efc522b
--- /dev/null
+++ b/arch/arm64/mm/gcs.c
@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+#include <linux/mm.h>
+#include <linux/mman.h>
+#include <linux/syscalls.h>
+#include <linux/types.h>
+
+#include <asm/cpufeature.h>
+#include <asm/page.h>
+
+/*
+ * Apply the GCS mode configured for the specified task to the
+ * hardware.
+ */
+void gcs_set_el0_mode(struct task_struct *task)
+{
+	u64 gcscre0_el1 = GCSCRE0_EL1_nTR;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_ENABLE)
+		gcscre0_el1 |= GCSCRE0_EL1_RVCHKEN | GCSCRE0_EL1_PCRSEL;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_WRITE)
+		gcscre0_el1 |= GCSCRE0_EL1_STREn;
+
+	if (task->thread.gcs_el0_mode & PR_SHADOW_STACK_PUSH)
+		gcscre0_el1 |= GCSCRE0_EL1_PUSHMEn;
+
+	write_sysreg_s(gcscre0_el1, SYS_GCSCRE0_EL1);
+}
+
+void gcs_free(struct task_struct *task)
+{
+	if (task->thread.gcs_base)
+		vm_munmap(task->thread.gcs_base, task->thread.gcs_size);
+
+	task->thread.gcspr_el0 = 0;
+	task->thread.gcs_base = 0;
+	task->thread.gcs_size = 0;
+}

-- 
2.39.2


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2023-11-22  9:46 UTC|newest]

Thread overview: 207+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-22  9:42 [PATCH v7 00/39] arm64/gcs: Provide support for GCS in userspace Mark Brown
2023-11-22  9:42 ` Mark Brown
2023-11-22  9:42 ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 01/39] arm64/mm: Restructure arch_validate_flags() for extensibility Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 02/39] prctl: arch-agnostic prctl for shadow stack Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-12 19:17   ` Deepak Gupta
2023-12-12 19:17     ` Deepak Gupta
2023-12-12 19:17     ` Deepak Gupta
2023-12-12 19:22     ` Mark Brown
2023-12-12 19:22       ` Mark Brown
2023-12-12 19:22       ` Mark Brown
2023-12-13  0:50       ` Deepak Gupta
2023-12-13  0:50         ` Deepak Gupta
2023-12-13  0:50         ` Deepak Gupta
2023-12-13 13:37         ` Mark Brown
2023-12-13 13:37           ` Mark Brown
2023-12-13 13:37           ` Mark Brown
2023-12-13 19:43           ` Deepak Gupta
2023-12-13 19:43             ` Deepak Gupta
2023-12-13 19:43             ` Deepak Gupta
2023-12-13 19:48             ` Mark Brown
2023-12-13 19:48               ` Mark Brown
2023-12-13 19:48               ` Mark Brown
2023-12-12 20:17   ` Edgecombe, Rick P
2023-12-12 20:17     ` Edgecombe, Rick P
2023-12-12 20:17     ` Edgecombe, Rick P
2023-12-12 20:26     ` Mark Brown
2023-12-12 20:26       ` Mark Brown
2023-12-12 20:26       ` Mark Brown
2023-12-12 21:22       ` Edgecombe, Rick P
2023-12-12 21:22         ` Edgecombe, Rick P
2023-12-12 21:22         ` Edgecombe, Rick P
2023-12-13 13:49         ` Mark Brown
2023-12-13 13:49           ` Mark Brown
2023-12-13 13:49           ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 03/39] mman: Add map_shadow_stack() flags Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 04/39] arm64: Document boot requirements for Guarded Control Stacks Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 05/39] arm64/gcs: Document the ABI " Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 06/39] arm64/sysreg: Add new system registers for GCS Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 07/39] arm64/sysreg: Add definitions for architected GCS caps Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 08/39] arm64/gcs: Add manual encodings of GCS instructions Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 09/39] arm64/gcs: Provide put_user_gcs() Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 10/39] arm64/cpufeature: Runtime detection of Guarded Control Stack (GCS) Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 11/39] arm64/mm: Allocate PIE slots for EL0 guarded control stack Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 12/39] mm: Define VM_SHADOW_STACK for arm64 when we support GCS Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 13/39] arm64/mm: Map pages for guarded control stack Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-04  3:01   ` Thiago Jung Bauermann
2023-12-04  3:01     ` Thiago Jung Bauermann
2023-12-04  3:01     ` Thiago Jung Bauermann
2023-11-22  9:42 ` [PATCH v7 14/39] KVM: arm64: Manage GCS registers for guests Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 15/39] arm64/gcs: Allow GCS usage at EL0 and EL1 Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 16/39] arm64/idreg: Add overrride for GCS Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 17/39] arm64/hwcap: Add hwcap " Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 18/39] arm64/traps: Handle GCS exceptions Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 19/39] arm64/mm: Handle GCS data aborts Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` Mark Brown [this message]
2023-11-22  9:42   ` [PATCH v7 20/39] arm64/gcs: Context switch GCS state for EL0 Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-13 19:59   ` Deepak Gupta
2023-12-13 19:59     ` Deepak Gupta
2023-12-13 19:59     ` Deepak Gupta
2023-12-13 20:02     ` Mark Brown
2023-12-13 20:02       ` Mark Brown
2023-12-13 20:02       ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 21/39] arm64/gcs: Allocate a new GCS for threads with GCS enabled Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-06 20:22   ` Thiago Jung Bauermann
2023-12-06 20:22     ` Thiago Jung Bauermann
2023-12-06 20:22     ` Thiago Jung Bauermann
2023-11-22  9:42 ` [PATCH v7 22/39] arm64/gcs: Implement shadow stack prctl() interface Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-06 21:27   ` Thiago Jung Bauermann
2023-12-06 21:27     ` Thiago Jung Bauermann
2023-12-06 21:27     ` Thiago Jung Bauermann
2023-11-22  9:42 ` [PATCH v7 23/39] arm64/mm: Implement map_shadow_stack() Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-06 21:44   ` Thiago Jung Bauermann
2023-12-06 21:44     ` Thiago Jung Bauermann
2023-12-06 21:44     ` Thiago Jung Bauermann
2023-11-22  9:42 ` [PATCH v7 24/39] arm64/signal: Set up and restore the GCS context for signal handlers Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-09  3:15   ` Thiago Jung Bauermann
2023-12-09  3:15     ` Thiago Jung Bauermann
2023-12-09  3:15     ` Thiago Jung Bauermann
2023-12-09 13:09     ` Mark Brown
2023-12-09 13:09       ` Mark Brown
2023-12-09 13:09       ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 25/39] arm64/signal: Expose GCS state in signal frames Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-09 22:28   ` Thiago Jung Bauermann
2023-12-09 22:28     ` Thiago Jung Bauermann
2023-12-09 22:28     ` Thiago Jung Bauermann
2023-11-22  9:42 ` [PATCH v7 26/39] arm64/ptrace: Expose GCS via ptrace and core files Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-09 23:49   ` Thiago Jung Bauermann
2023-12-09 23:49     ` Thiago Jung Bauermann
2023-12-09 23:49     ` Thiago Jung Bauermann
2023-12-10 14:22     ` Mark Brown
2023-12-10 14:22       ` Mark Brown
2023-12-10 14:22       ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 27/39] arm64: Add Kconfig for Guarded Control Stack (GCS) Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 28/39] kselftest/arm64: Verify the GCS hwcap Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 29/39] kselftest/arm64: Add GCS as a detected feature in the signal tests Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 30/39] kselftest/arm64: Add framework support for GCS to signal handling tests Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 31/39] kselftest/arm64: Allow signals tests to specify an expected si_code Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 32/39] kselftest/arm64: Always run signals tests with GCS enabled Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 33/39] kselftest/arm64: Add very basic GCS test program Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 34/39] kselftest/arm64: Add a GCS test program built with the system libc Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-15  2:50   ` Thiago Jung Bauermann
2023-12-15  2:50     ` Thiago Jung Bauermann
2023-12-15  2:50     ` Thiago Jung Bauermann
2023-12-15 14:59     ` Mark Brown
2023-12-15 14:59       ` Mark Brown
2023-12-15 14:59       ` Mark Brown
2023-12-17  2:18       ` Thiago Jung Bauermann
2023-12-17  2:18         ` Thiago Jung Bauermann
2023-12-17  2:18         ` Thiago Jung Bauermann
2024-01-18 19:58     ` Mark Brown
2024-01-18 19:58       ` Mark Brown
2024-01-18 19:58       ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 35/39] kselftest/arm64: Add test coverage for GCS mode locking Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 36/39] selftests/arm64: Add GCS signal tests Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-17  2:12   ` Thiago Jung Bauermann
2023-12-17  2:12     ` Thiago Jung Bauermann
2023-12-17  2:12     ` Thiago Jung Bauermann
2024-01-18 21:10     ` Mark Brown
2024-01-18 21:10       ` Mark Brown
2024-01-18 21:10       ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 37/39] kselftest/arm64: Add a GCS stress test Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-13  2:45   ` Thiago Jung Bauermann
2023-12-13  2:45     ` Thiago Jung Bauermann
2023-12-13  2:45     ` Thiago Jung Bauermann
2023-11-22  9:42 ` [PATCH v7 38/39] kselftest/arm64: Enable GCS for the FP stress tests Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42 ` [PATCH v7 39/39] kselftest/clone3: Enable GCS in the clone3 selftests Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-11-22  9:42   ` Mark Brown
2023-12-20  4:13 ` [PATCH v7 00/39] arm64/gcs: Provide support for GCS in userspace Thiago Jung Bauermann
2023-12-20  4:13   ` Thiago Jung Bauermann
2023-12-20  4:13   ` Thiago Jung Bauermann

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=20231122-arm64-gcs-v7-20-201c483bd775@kernel.org \
    --to=broonie@kernel.org \
    --cc=Szabolcs.Nagy@arm.com \
    --cc=akpm@linux-foundation.org \
    --cc=aou@eecs.berkeley.edu \
    --cc=ardb@kernel.org \
    --cc=arnd@arndb.de \
    --cc=brauner@kernel.org \
    --cc=catalin.marinas@arm.com \
    --cc=corbet@lwn.net \
    --cc=debug@rivosinc.com \
    --cc=ebiederm@xmission.com \
    --cc=fweimer@redhat.com \
    --cc=hjl.tools@gmail.com \
    --cc=james.morse@arm.com \
    --cc=keescook@chromium.org \
    --cc=kvmarm@lists.linux.dev \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=maz@kernel.org \
    --cc=oleg@redhat.com \
    --cc=oliver.upton@linux.dev \
    --cc=palmer@dabbelt.com \
    --cc=paul.walmsley@sifive.com \
    --cc=rick.p.edgecombe@intel.com \
    --cc=shuah@kernel.org \
    --cc=suzuki.poulose@arm.com \
    --cc=thiago.bauermann@linaro.org \
    --cc=will@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.