From: Binbin Wu <binbin.wu@linux.intel.com>
To: Sagi Shahar <sagis@google.com>
Cc: linux-kselftest@vger.kernel.org,
Ackerley Tng <ackerleytng@google.com>,
Ryan Afranji <afranji@google.com>,
Erdem Aktas <erdemaktas@google.com>,
Isaku Yamahata <isaku.yamahata@intel.com>,
Sean Christopherson <seanjc@google.com>,
Paolo Bonzini <pbonzini@redhat.com>,
Shuah Khan <shuah@kernel.org>, Peter Gonda <pgonda@google.com>,
Haibo Xu <haibo1.xu@intel.com>,
Chao Peng <chao.p.peng@linux.intel.com>,
Vishal Annapurve <vannapurve@google.com>,
Roger Wang <runanwang@google.com>,
Vipin Sharma <vipinsh@google.com>,
jmattson@google.com, dmatlack@google.com,
linux-kernel@vger.kernel.org, kvm@vger.kernel.org,
linux-mm@kvack.org
Subject: Re: [RFC PATCH v5 12/29] KVM: selftests: TDX: Add basic get_td_vmcall_info test
Date: Fri, 1 Mar 2024 14:03:43 +0800 [thread overview]
Message-ID: <be592452-be8f-4cb5-b751-b9328c19dee6@linux.intel.com> (raw)
In-Reply-To: <20231212204647.2170650-13-sagis@google.com>
On 12/13/2023 4:46 AM, Sagi Shahar wrote:
> The test calls get_td_vmcall_info from the guest and verifies the
> expected returned values.
>
> Signed-off-by: Sagi Shahar <sagis@google.com>
> Signed-off-by: Ackerley Tng <ackerleytng@google.com>
> Signed-off-by: Ryan Afranji <afranji@google.com>
> ---
> .../selftests/kvm/include/x86_64/tdx/tdx.h | 3 +
> .../kvm/include/x86_64/tdx/test_util.h | 27 +++++++
> .../selftests/kvm/lib/x86_64/tdx/tdx.c | 23 ++++++
> .../selftests/kvm/lib/x86_64/tdx/test_util.c | 46 +++++++++++
> .../selftests/kvm/x86_64/tdx_vm_tests.c | 80 +++++++++++++++++++
> 5 files changed, 179 insertions(+)
Reviewed-by: Binbin Wu <binbin.wu@linux.intel.com>
Also, does it need to add another case for the non-zero value of r12 to
test the VMCALL_INVALID_OPERAND path?
>
> diff --git a/tools/testing/selftests/kvm/include/x86_64/tdx/tdx.h b/tools/testing/selftests/kvm/include/x86_64/tdx/tdx.h
> index 1340c1070002..63788012bf94 100644
> --- a/tools/testing/selftests/kvm/include/x86_64/tdx/tdx.h
> +++ b/tools/testing/selftests/kvm/include/x86_64/tdx/tdx.h
> @@ -5,6 +5,7 @@
> #include <stdint.h>
> #include "kvm_util_base.h"
>
> +#define TDG_VP_VMCALL_GET_TD_VM_CALL_INFO 0x10000
> #define TDG_VP_VMCALL_REPORT_FATAL_ERROR 0x10003
>
> #define TDG_VP_VMCALL_INSTRUCTION_IO 30
> @@ -12,5 +13,7 @@ void handle_userspace_tdg_vp_vmcall_exit(struct kvm_vcpu *vcpu);
> uint64_t tdg_vp_vmcall_instruction_io(uint64_t port, uint64_t size,
> uint64_t write, uint64_t *data);
> void tdg_vp_vmcall_report_fatal_error(uint64_t error_code, uint64_t data_gpa);
> +uint64_t tdg_vp_vmcall_get_td_vmcall_info(uint64_t *r11, uint64_t *r12,
> + uint64_t *r13, uint64_t *r14);
>
> #endif // SELFTEST_TDX_TDX_H
> diff --git a/tools/testing/selftests/kvm/include/x86_64/tdx/test_util.h b/tools/testing/selftests/kvm/include/x86_64/tdx/test_util.h
> index af0ddbfe8d71..8a9b6a1bec3e 100644
> --- a/tools/testing/selftests/kvm/include/x86_64/tdx/test_util.h
> +++ b/tools/testing/selftests/kvm/include/x86_64/tdx/test_util.h
> @@ -4,6 +4,7 @@
>
> #include <stdbool.h>
>
> +#include "kvm_util_base.h"
> #include "tdcall.h"
>
> #define TDX_TEST_SUCCESS_PORT 0x30
> @@ -111,4 +112,30 @@ void tdx_test_fatal_with_data(uint64_t error_code, uint64_t data_gpa);
> */
> uint64_t tdx_test_report_to_user_space(uint32_t data);
>
> +/**
> + * Report a 64 bit value from the guest to user space using TDG.VP.VMCALL
> + * <Instruction.IO> call.
> + *
> + * Data is sent to host in 2 calls. LSB is sent (and needs to be read) first.
> + */
> +uint64_t tdx_test_send_64bit(uint64_t port, uint64_t data);
> +
> +/**
> + * Report a 64 bit value from the guest to user space using TDG.VP.VMCALL
> + * <Instruction.IO> call. Data is reported on port TDX_TEST_REPORT_PORT.
> + */
> +uint64_t tdx_test_report_64bit_to_user_space(uint64_t data);
> +
> +/**
> + * Read a 64 bit value from the guest in user space, sent using
> + * tdx_test_send_64bit().
> + */
> +uint64_t tdx_test_read_64bit(struct kvm_vcpu *vcpu, uint64_t port);
> +
> +/**
> + * Read a 64 bit value from the guest in user space, sent using
> + * tdx_test_report_64bit_to_user_space.
> + */
> +uint64_t tdx_test_read_64bit_report_from_guest(struct kvm_vcpu *vcpu);
> +
> #endif // SELFTEST_TDX_TEST_UTIL_H
> diff --git a/tools/testing/selftests/kvm/lib/x86_64/tdx/tdx.c b/tools/testing/selftests/kvm/lib/x86_64/tdx/tdx.c
> index b854c3aa34ff..e5a9e13c62e2 100644
> --- a/tools/testing/selftests/kvm/lib/x86_64/tdx/tdx.c
> +++ b/tools/testing/selftests/kvm/lib/x86_64/tdx/tdx.c
> @@ -64,3 +64,26 @@ void tdg_vp_vmcall_report_fatal_error(uint64_t error_code, uint64_t data_gpa)
>
> __tdx_hypercall(&args, 0);
> }
> +
> +uint64_t tdg_vp_vmcall_get_td_vmcall_info(uint64_t *r11, uint64_t *r12,
> + uint64_t *r13, uint64_t *r14)
> +{
> + uint64_t ret;
> + struct tdx_hypercall_args args = {
> + .r11 = TDG_VP_VMCALL_GET_TD_VM_CALL_INFO,
> + .r12 = 0,
> + };
> +
> + ret = __tdx_hypercall(&args, TDX_HCALL_HAS_OUTPUT);
> +
> + if (r11)
> + *r11 = args.r11;
> + if (r12)
> + *r12 = args.r12;
> + if (r13)
> + *r13 = args.r13;
> + if (r14)
> + *r14 = args.r14;
> +
> + return ret;
> +}
> diff --git a/tools/testing/selftests/kvm/lib/x86_64/tdx/test_util.c b/tools/testing/selftests/kvm/lib/x86_64/tdx/test_util.c
> index 55c5a1e634df..3ae651cd5fac 100644
> --- a/tools/testing/selftests/kvm/lib/x86_64/tdx/test_util.c
> +++ b/tools/testing/selftests/kvm/lib/x86_64/tdx/test_util.c
> @@ -7,6 +7,7 @@
> #include <unistd.h>
>
> #include "kvm_util_base.h"
> +#include "tdx/tdcall.h"
> #include "tdx/tdx.h"
> #include "tdx/test_util.h"
>
> @@ -53,3 +54,48 @@ uint64_t tdx_test_report_to_user_space(uint32_t data)
> TDG_VP_VMCALL_INSTRUCTION_IO_WRITE,
> &data_64);
> }
> +
> +uint64_t tdx_test_send_64bit(uint64_t port, uint64_t data)
> +{
> + uint64_t err;
> + uint64_t data_lo = data & 0xFFFFFFFF;
> + uint64_t data_hi = (data >> 32) & 0xFFFFFFFF;
> +
> + err = tdg_vp_vmcall_instruction_io(port, 4,
> + TDG_VP_VMCALL_INSTRUCTION_IO_WRITE,
> + &data_lo);
> + if (err)
> + return err;
> +
> + return tdg_vp_vmcall_instruction_io(port, 4,
> + TDG_VP_VMCALL_INSTRUCTION_IO_WRITE,
> + &data_hi);
> +}
> +
> +uint64_t tdx_test_report_64bit_to_user_space(uint64_t data)
> +{
> + return tdx_test_send_64bit(TDX_TEST_REPORT_PORT, data);
> +}
> +
> +uint64_t tdx_test_read_64bit(struct kvm_vcpu *vcpu, uint64_t port)
> +{
> + uint32_t lo, hi;
> + uint64_t res;
> +
> + TDX_TEST_ASSERT_IO(vcpu, port, 4, TDG_VP_VMCALL_INSTRUCTION_IO_WRITE);
> + lo = *(uint32_t *)((void *)vcpu->run + vcpu->run->io.data_offset);
> +
> + vcpu_run(vcpu);
> +
> + TDX_TEST_ASSERT_IO(vcpu, port, 4, TDG_VP_VMCALL_INSTRUCTION_IO_WRITE);
> + hi = *(uint32_t *)((void *)vcpu->run + vcpu->run->io.data_offset);
> +
> + res = hi;
> + res = (res << 32) | lo;
> + return res;
> +}
> +
> +uint64_t tdx_test_read_64bit_report_from_guest(struct kvm_vcpu *vcpu)
> +{
> + return tdx_test_read_64bit(vcpu, TDX_TEST_REPORT_PORT);
> +}
> diff --git a/tools/testing/selftests/kvm/x86_64/tdx_vm_tests.c b/tools/testing/selftests/kvm/x86_64/tdx_vm_tests.c
> index 1b30e6f5a569..569c8fb0a59f 100644
> --- a/tools/testing/selftests/kvm/x86_64/tdx_vm_tests.c
> +++ b/tools/testing/selftests/kvm/x86_64/tdx_vm_tests.c
> @@ -260,6 +260,85 @@ void verify_td_cpuid(void)
> printf("\t ... PASSED\n");
> }
>
> +/*
> + * Verifies get_td_vmcall_info functionality.
> + */
> +void guest_code_get_td_vmcall_info(void)
> +{
> + uint64_t err;
> + uint64_t r11, r12, r13, r14;
> +
> + err = tdg_vp_vmcall_get_td_vmcall_info(&r11, &r12, &r13, &r14);
> + if (err)
> + tdx_test_fatal(err);
> +
> + err = tdx_test_report_64bit_to_user_space(r11);
> + if (err)
> + tdx_test_fatal(err);
> +
> + err = tdx_test_report_64bit_to_user_space(r12);
> + if (err)
> + tdx_test_fatal(err);
> +
> + err = tdx_test_report_64bit_to_user_space(r13);
> + if (err)
> + tdx_test_fatal(err);
> +
> + err = tdx_test_report_64bit_to_user_space(r14);
> + if (err)
> + tdx_test_fatal(err);
> +
> + tdx_test_success();
> +}
> +
> +void verify_get_td_vmcall_info(void)
> +{
> + struct kvm_vm *vm;
> + struct kvm_vcpu *vcpu;
> +
> + uint64_t r11, r12, r13, r14;
> +
> + vm = td_create();
> + td_initialize(vm, VM_MEM_SRC_ANONYMOUS, 0);
> + vcpu = td_vcpu_add(vm, 0, guest_code_get_td_vmcall_info);
> + td_finalize(vm);
> +
> + printf("Verifying TD get vmcall info:\n");
> +
> + /* Wait for guest to report r11 value */
> + td_vcpu_run(vcpu);
> + TDX_TEST_CHECK_GUEST_FAILURE(vcpu);
> + r11 = tdx_test_read_64bit_report_from_guest(vcpu);
> +
> + /* Wait for guest to report r12 value */
> + td_vcpu_run(vcpu);
> + TDX_TEST_CHECK_GUEST_FAILURE(vcpu);
> + r12 = tdx_test_read_64bit_report_from_guest(vcpu);
> +
> + /* Wait for guest to report r13 value */
> + td_vcpu_run(vcpu);
> + TDX_TEST_CHECK_GUEST_FAILURE(vcpu);
> + r13 = tdx_test_read_64bit_report_from_guest(vcpu);
> +
> + /* Wait for guest to report r14 value */
> + td_vcpu_run(vcpu);
> + TDX_TEST_CHECK_GUEST_FAILURE(vcpu);
> + r14 = tdx_test_read_64bit_report_from_guest(vcpu);
> +
> + TEST_ASSERT_EQ(r11, 0);
> + TEST_ASSERT_EQ(r12, 0);
> + TEST_ASSERT_EQ(r13, 0);
> + TEST_ASSERT_EQ(r14, 0);
> +
> + /* Wait for guest to complete execution */
> + td_vcpu_run(vcpu);
> + TDX_TEST_CHECK_GUEST_FAILURE(vcpu);
> + TDX_TEST_ASSERT_SUCCESS(vcpu);
> +
> + kvm_vm_free(vm);
> + printf("\t ... PASSED\n");
> +}
> +
> int main(int argc, char **argv)
> {
> setbuf(stdout, NULL);
> @@ -273,6 +352,7 @@ int main(int argc, char **argv)
> run_in_new_process(&verify_report_fatal_error);
> run_in_new_process(&verify_td_ioexit);
> run_in_new_process(&verify_td_cpuid);
> + run_in_new_process(&verify_get_td_vmcall_info);
>
> return 0;
> }
next prev parent reply other threads:[~2024-03-01 6:03 UTC|newest]
Thread overview: 109+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-12 20:46 [RFC PATCH v5 00/29] TDX KVM selftests Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 01/29] KVM: selftests: Add function to allow one-to-one GVA to GPA mappings Sagi Shahar
2024-02-21 1:43 ` Binbin Wu
2024-07-23 19:55 ` Sagi Shahar
2024-03-21 22:29 ` Zhang, Dongsheng X
2024-07-23 19:56 ` Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 02/29] KVM: selftests: Expose function that sets up sregs based on VM's mode Sagi Shahar
2024-02-21 2:18 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 03/29] KVM: selftests: Store initial stack address in struct kvm_vcpu Sagi Shahar
2024-02-21 2:29 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 04/29] KVM: selftests: Refactor steps in vCPU descriptor table initialization Sagi Shahar
2024-02-21 5:43 ` Binbin Wu
2024-07-23 21:25 ` Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 05/29] KVM: selftests: Add helper functions to create TDX VMs Sagi Shahar
2024-02-22 9:24 ` Yan Zhao
2024-02-28 16:19 ` Binbin Wu
2024-03-21 22:54 ` Zhang, Dongsheng X
2024-04-12 5:34 ` Ackerley Tng
2023-12-12 20:46 ` [RFC PATCH v5 06/29] KVM: selftests: TDX: Use KVM_TDX_CAPABILITIES to validate TDs' attribute configuration Sagi Shahar
2024-02-29 8:31 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 07/29] KVM: selftests: TDX: Update load_td_memory_region for VM memory backed by guest memfd Sagi Shahar
2024-02-22 9:19 ` Yan Zhao
2024-07-24 16:42 ` Ackerley Tng
2024-07-25 18:19 ` Ackerley Tng
2023-12-12 20:46 ` [RFC PATCH v5 08/29] KVM: selftests: TDX: Add TDX lifecycle test Sagi Shahar
2024-02-23 1:55 ` Chen Yu
2024-03-01 4:58 ` Yan Zhao
2024-03-01 7:36 ` Yan Zhao
2024-03-21 23:20 ` Zhang, Dongsheng X
2024-04-12 4:42 ` Ackerley Tng
2024-03-22 21:33 ` Chen, Zide
2024-07-25 19:52 ` Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 09/29] KVM: selftests: TDX: Add report_fatal_error test Sagi Shahar
2024-02-29 12:31 ` Binbin Wu
2024-03-01 6:52 ` Binbin Wu
2024-07-25 20:37 ` Sagi Shahar
2024-03-01 12:09 ` Yan Zhao
2024-04-12 4:56 ` Ackerley Tng
2024-04-12 11:57 ` Yan Zhao
2024-04-15 8:05 ` Ackerley Tng
2024-04-15 10:09 ` Yan Zhao
2024-04-16 18:50 ` Sean Christopherson
2024-04-17 22:41 ` Yan Zhao
2024-04-22 21:23 ` Sean Christopherson
2024-07-28 11:16 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 10/29] KVM: selftests: TDX: Adding test case for TDX port IO Sagi Shahar
2024-02-29 13:20 ` Binbin Wu
2024-03-04 2:19 ` Yan Zhao
2024-03-04 9:16 ` Binbin Wu
2024-03-04 9:18 ` Yan Zhao
2024-07-25 22:35 ` Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 11/29] KVM: selftests: TDX: Add basic TDX CPUID test Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 12/29] KVM: selftests: TDX: Add basic get_td_vmcall_info test Sagi Shahar
2024-03-01 6:03 ` Binbin Wu [this message]
2023-12-12 20:46 ` [RFC PATCH v5 13/29] KVM: selftests: TDX: Add TDX IO writes test Sagi Shahar
2024-03-01 6:55 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 14/29] KVM: selftests: TDX: Add TDX IO reads test Sagi Shahar
2024-03-01 8:22 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 15/29] KVM: selftests: TDX: Add TDX MSR read/write tests Sagi Shahar
2024-03-01 12:00 ` Binbin Wu
2024-03-01 12:09 ` Binbin Wu
2024-03-05 0:22 ` Yan Zhao
2024-03-21 23:40 ` Zhang, Dongsheng X
2023-12-12 20:46 ` [RFC PATCH v5 16/29] KVM: selftests: TDX: Add TDX HLT exit test Sagi Shahar
2024-03-02 7:31 ` Binbin Wu
2024-03-05 5:40 ` Yan Zhao
2024-07-27 23:23 ` Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 17/29] KVM: selftests: TDX: Add TDX MMIO reads test Sagi Shahar
2024-03-05 7:09 ` Yan Zhao
2024-03-21 23:45 ` Zhang, Dongsheng X
2023-12-12 20:46 ` [RFC PATCH v5 18/29] KVM: selftests: TDX: Add TDX MMIO writes test Sagi Shahar
2024-03-02 7:58 ` Binbin Wu
2024-03-05 8:58 ` Yan Zhao
2024-07-30 19:03 ` Sagi Shahar
2024-03-21 23:46 ` Zhang, Dongsheng X
2023-12-12 20:46 ` [RFC PATCH v5 19/29] KVM: selftests: TDX: Add TDX CPUID TDVMCALL test Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 20/29] KVM: selftests: TDX: Verify the behavior when host consumes a TD private memory Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 21/29] KVM: selftests: TDX: Add TDG.VP.INFO test Sagi Shahar
2024-03-06 4:50 ` Yan Zhao
2023-12-12 20:46 ` [RFC PATCH v5 22/29] KVM: selftests: Add functions to allow mapping as shared Sagi Shahar
2024-03-05 11:09 ` Yan Zhao
[not found] ` <DS7PR11MB7886BD37E5E56DAB9A0087A3F6292@DS7PR11MB7886.namprd11.prod.outlook.com>
2024-03-16 6:24 ` Chen, Zide
2023-12-12 20:46 ` [RFC PATCH v5 23/29] KVM: selftests: TDX: Add shared memory test Sagi Shahar
2024-03-01 12:02 ` Yan Zhao
2024-03-06 1:36 ` Yan Zhao
2024-03-06 1:20 ` Yan Zhao
[not found] ` <DS7PR11MB7886AA5F8A19CDFCB5566B0EF6292@DS7PR11MB7886.namprd11.prod.outlook.com>
2024-03-16 6:24 ` Chen, Zide
2023-12-12 20:46 ` [RFC PATCH v5 24/29] KVM: selftests: Expose _vm_vaddr_alloc Sagi Shahar
2024-03-04 9:55 ` Binbin Wu
2024-03-06 1:49 ` Yan Zhao
2023-12-12 20:46 ` [RFC PATCH v5 25/29] KVM: selftests: TDX: Add support for TDG.MEM.PAGE.ACCEPT Sagi Shahar
2023-12-12 20:46 ` [RFC PATCH v5 26/29] KVM: selftests: TDX: Add support for TDG.VP.VEINFO.GET Sagi Shahar
2024-03-04 13:56 ` Binbin Wu
2023-12-12 20:46 ` [RFC PATCH v5 27/29] KVM: selftests: Propagate KVM_EXIT_MEMORY_FAULT to userspace Sagi Shahar
[not found] ` <DS7PR11MB78860170A5FD77253573BC09F6292@DS7PR11MB7886.namprd11.prod.outlook.com>
2024-03-14 21:46 ` Chen, Zide
2023-12-12 20:46 ` [RFC PATCH v5 28/29] KVM: selftests: TDX: Add TDX UPM selftest Sagi Shahar
2024-03-05 4:57 ` Binbin Wu
2024-03-06 8:54 ` Yan Zhao
2023-12-12 20:46 ` [RFC PATCH v5 29/29] KVM: selftests: TDX: Add TDX UPM selftests for implicit conversion Sagi Shahar
2024-06-05 18:38 ` [RFC PATCH v5 00/29] TDX KVM selftests Verma, Vishal L
2024-06-05 20:10 ` Sagi Shahar
2024-06-05 20:15 ` Verma, Vishal L
2024-06-05 20:18 ` Verma, Vishal L
2024-06-05 20:42 ` Sagi Shahar
2024-06-05 20:56 ` Edgecombe, Rick P
2024-06-05 21:34 ` Sagi Shahar
2024-06-05 21:44 ` Edgecombe, Rick P
2024-06-21 2:51 ` Edgecombe, Rick P
2024-06-21 20:52 ` Sagi Shahar
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=be592452-be8f-4cb5-b751-b9328c19dee6@linux.intel.com \
--to=binbin.wu@linux.intel.com \
--cc=ackerleytng@google.com \
--cc=afranji@google.com \
--cc=chao.p.peng@linux.intel.com \
--cc=dmatlack@google.com \
--cc=erdemaktas@google.com \
--cc=haibo1.xu@intel.com \
--cc=isaku.yamahata@intel.com \
--cc=jmattson@google.com \
--cc=kvm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=pbonzini@redhat.com \
--cc=pgonda@google.com \
--cc=runanwang@google.com \
--cc=sagis@google.com \
--cc=seanjc@google.com \
--cc=shuah@kernel.org \
--cc=vannapurve@google.com \
--cc=vipinsh@google.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 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.