All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alexander Graf <agraf@suse.de>
To: kvm-ppc@vger.kernel.org
Cc: KVM list <kvm@vger.kernel.org>,
	linuxppc-dev <linuxppc-dev@lists.ozlabs.org>
Subject: [PATCH 18/27] KVM: PPC: KVM PV guest stubs
Date: Thu,  1 Jul 2010 12:42:53 +0200	[thread overview]
Message-ID: <1277980982-12433-19-git-send-email-agraf@suse.de> (raw)
In-Reply-To: <1277980982-12433-1-git-send-email-agraf@suse.de>

We will soon start and replace instructions from the text section with
other, paravirtualized versions. To ease the readability of those patches
I split out the generic looping and magic page mapping code out.

This patch still only contains stubs. But at least it loops through the
text section :).

Signed-off-by: Alexander Graf <agraf@suse.de>

---

v1 -> v2:

  - kvm guest patch framework: introduce patch_ins
---
 arch/powerpc/kernel/kvm.c |   63 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 63 insertions(+), 0 deletions(-)

diff --git a/arch/powerpc/kernel/kvm.c b/arch/powerpc/kernel/kvm.c
index 2d8dd73..1f328d5 100644
--- a/arch/powerpc/kernel/kvm.c
+++ b/arch/powerpc/kernel/kvm.c
@@ -32,3 +32,66 @@
 #define KVM_MAGIC_PAGE		(-4096L)
 #define magic_var(x) KVM_MAGIC_PAGE + offsetof(struct kvm_vcpu_arch_shared, x)
 
+static bool kvm_patching_worked = true;
+
+static inline void kvm_patch_ins(u32 *inst, u32 new_inst)
+{
+	*inst = new_inst;
+	flush_icache_range((ulong)inst, (ulong)inst + 4);
+}
+
+static void kvm_map_magic_page(void *data)
+{
+	kvm_hypercall2(KVM_HC_PPC_MAP_MAGIC_PAGE,
+		       KVM_MAGIC_PAGE,  /* Physical Address */
+		       KVM_MAGIC_PAGE); /* Effective Address */
+}
+
+static void kvm_check_ins(u32 *inst)
+{
+	u32 _inst = *inst;
+	u32 inst_no_rt = _inst & ~KVM_MASK_RT;
+	u32 inst_rt = _inst & KVM_MASK_RT;
+
+	switch (inst_no_rt) {
+	}
+
+	switch (_inst) {
+	}
+}
+
+static void kvm_use_magic_page(void)
+{
+	u32 *p;
+	u32 *start, *end;
+
+	/* Tell the host to map the magic page to -4096 on all CPUs */
+
+	on_each_cpu(kvm_map_magic_page, NULL, 1);
+
+	/* Now loop through all code and find instructions */
+
+	start = (void*)_stext;
+	end = (void*)_etext;
+
+	for (p = start; p < end; p++)
+		kvm_check_ins(p);
+}
+
+static int __init kvm_guest_init(void)
+{
+	char *p;
+
+	if (!kvm_para_available())
+		return 0;
+
+	if (kvm_para_has_feature(KVM_FEATURE_MAGIC_PAGE))
+		kvm_use_magic_page();
+
+	printk(KERN_INFO "KVM: Live patching for a fast VM %s\n",
+			 kvm_patching_worked ? "worked" : "failed");
+
+	return 0;
+}
+
+postcore_initcall(kvm_guest_init);
-- 
1.6.0.2


WARNING: multiple messages have this Message-ID (diff)
From: Alexander Graf <agraf@suse.de>
To: kvm-ppc@vger.kernel.org
Cc: linuxppc-dev <linuxppc-dev@lists.ozlabs.org>,
	KVM list <kvm@vger.kernel.org>
Subject: [PATCH 18/27] KVM: PPC: KVM PV guest stubs
Date: Thu,  1 Jul 2010 12:42:53 +0200	[thread overview]
Message-ID: <1277980982-12433-19-git-send-email-agraf@suse.de> (raw)
In-Reply-To: <1277980982-12433-1-git-send-email-agraf@suse.de>

We will soon start and replace instructions from the text section with
other, paravirtualized versions. To ease the readability of those patches
I split out the generic looping and magic page mapping code out.

This patch still only contains stubs. But at least it loops through the
text section :).

Signed-off-by: Alexander Graf <agraf@suse.de>

---

v1 -> v2:

  - kvm guest patch framework: introduce patch_ins
---
 arch/powerpc/kernel/kvm.c |   63 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 63 insertions(+), 0 deletions(-)

diff --git a/arch/powerpc/kernel/kvm.c b/arch/powerpc/kernel/kvm.c
index 2d8dd73..1f328d5 100644
--- a/arch/powerpc/kernel/kvm.c
+++ b/arch/powerpc/kernel/kvm.c
@@ -32,3 +32,66 @@
 #define KVM_MAGIC_PAGE		(-4096L)
 #define magic_var(x) KVM_MAGIC_PAGE + offsetof(struct kvm_vcpu_arch_shared, x)
 
+static bool kvm_patching_worked = true;
+
+static inline void kvm_patch_ins(u32 *inst, u32 new_inst)
+{
+	*inst = new_inst;
+	flush_icache_range((ulong)inst, (ulong)inst + 4);
+}
+
+static void kvm_map_magic_page(void *data)
+{
+	kvm_hypercall2(KVM_HC_PPC_MAP_MAGIC_PAGE,
+		       KVM_MAGIC_PAGE,  /* Physical Address */
+		       KVM_MAGIC_PAGE); /* Effective Address */
+}
+
+static void kvm_check_ins(u32 *inst)
+{
+	u32 _inst = *inst;
+	u32 inst_no_rt = _inst & ~KVM_MASK_RT;
+	u32 inst_rt = _inst & KVM_MASK_RT;
+
+	switch (inst_no_rt) {
+	}
+
+	switch (_inst) {
+	}
+}
+
+static void kvm_use_magic_page(void)
+{
+	u32 *p;
+	u32 *start, *end;
+
+	/* Tell the host to map the magic page to -4096 on all CPUs */
+
+	on_each_cpu(kvm_map_magic_page, NULL, 1);
+
+	/* Now loop through all code and find instructions */
+
+	start = (void*)_stext;
+	end = (void*)_etext;
+
+	for (p = start; p < end; p++)
+		kvm_check_ins(p);
+}
+
+static int __init kvm_guest_init(void)
+{
+	char *p;
+
+	if (!kvm_para_available())
+		return 0;
+
+	if (kvm_para_has_feature(KVM_FEATURE_MAGIC_PAGE))
+		kvm_use_magic_page();
+
+	printk(KERN_INFO "KVM: Live patching for a fast VM %s\n",
+			 kvm_patching_worked ? "worked" : "failed");
+
+	return 0;
+}
+
+postcore_initcall(kvm_guest_init);
-- 
1.6.0.2

WARNING: multiple messages have this Message-ID (diff)
From: Alexander Graf <agraf@suse.de>
To: kvm-ppc@vger.kernel.org
Cc: KVM list <kvm@vger.kernel.org>,
	linuxppc-dev <linuxppc-dev@lists.ozlabs.org>
Subject: [PATCH 18/27] KVM: PPC: KVM PV guest stubs
Date: Thu, 01 Jul 2010 10:42:53 +0000	[thread overview]
Message-ID: <1277980982-12433-19-git-send-email-agraf@suse.de> (raw)
In-Reply-To: <1277980982-12433-1-git-send-email-agraf@suse.de>

We will soon start and replace instructions from the text section with
other, paravirtualized versions. To ease the readability of those patches
I split out the generic looping and magic page mapping code out.

This patch still only contains stubs. But at least it loops through the
text section :).

Signed-off-by: Alexander Graf <agraf@suse.de>

---

v1 -> v2:

  - kvm guest patch framework: introduce patch_ins
---
 arch/powerpc/kernel/kvm.c |   63 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 63 insertions(+), 0 deletions(-)

diff --git a/arch/powerpc/kernel/kvm.c b/arch/powerpc/kernel/kvm.c
index 2d8dd73..1f328d5 100644
--- a/arch/powerpc/kernel/kvm.c
+++ b/arch/powerpc/kernel/kvm.c
@@ -32,3 +32,66 @@
 #define KVM_MAGIC_PAGE		(-4096L)
 #define magic_var(x) KVM_MAGIC_PAGE + offsetof(struct kvm_vcpu_arch_shared, x)
 
+static bool kvm_patching_worked = true;
+
+static inline void kvm_patch_ins(u32 *inst, u32 new_inst)
+{
+	*inst = new_inst;
+	flush_icache_range((ulong)inst, (ulong)inst + 4);
+}
+
+static void kvm_map_magic_page(void *data)
+{
+	kvm_hypercall2(KVM_HC_PPC_MAP_MAGIC_PAGE,
+		       KVM_MAGIC_PAGE,  /* Physical Address */
+		       KVM_MAGIC_PAGE); /* Effective Address */
+}
+
+static void kvm_check_ins(u32 *inst)
+{
+	u32 _inst = *inst;
+	u32 inst_no_rt = _inst & ~KVM_MASK_RT;
+	u32 inst_rt = _inst & KVM_MASK_RT;
+
+	switch (inst_no_rt) {
+	}
+
+	switch (_inst) {
+	}
+}
+
+static void kvm_use_magic_page(void)
+{
+	u32 *p;
+	u32 *start, *end;
+
+	/* Tell the host to map the magic page to -4096 on all CPUs */
+
+	on_each_cpu(kvm_map_magic_page, NULL, 1);
+
+	/* Now loop through all code and find instructions */
+
+	start = (void*)_stext;
+	end = (void*)_etext;
+
+	for (p = start; p < end; p++)
+		kvm_check_ins(p);
+}
+
+static int __init kvm_guest_init(void)
+{
+	char *p;
+
+	if (!kvm_para_available())
+		return 0;
+
+	if (kvm_para_has_feature(KVM_FEATURE_MAGIC_PAGE))
+		kvm_use_magic_page();
+
+	printk(KERN_INFO "KVM: Live patching for a fast VM %s\n",
+			 kvm_patching_worked ? "worked" : "failed");
+
+	return 0;
+}
+
+postcore_initcall(kvm_guest_init);
-- 
1.6.0.2


  parent reply	other threads:[~2010-07-01 10:43 UTC|newest]

Thread overview: 171+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-01 10:42 [PATCH 00/27] KVM PPC PV framework Alexander Graf
2010-07-01 10:42 ` Alexander Graf
2010-07-01 10:42 ` Alexander Graf
2010-07-01 10:42 ` [PATCH 02/27] KVM: PPC: Convert MSR to shared page Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 03/27] KVM: PPC: Convert DSISR " Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 04/27] KVM: PPC: Convert DAR " Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 05/27] KVM: PPC: Convert SRR0 and SRR1 " Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 08/27] KVM: PPC: Add PV guest critical sections Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 09/27] KVM: PPC: Add PV guest scratch registers Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 11/27] KVM: PPC: Make RMO a define Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
     [not found]   ` <1277980982-12433-12-git-send-email-agraf-l3A5Bk7waGM@public.gmane.org>
2010-07-02 16:23     ` Segher Boessenkool
2010-07-02 16:23       ` Segher Boessenkool
2010-07-02 16:23       ` Segher Boessenkool
2010-07-01 10:42 ` [PATCH 14/27] KVM: PPC: Magic Page BookE support Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
     [not found]   ` <1277980982-12433-15-git-send-email-agraf-l3A5Bk7waGM@public.gmane.org>
2010-07-01 11:18     ` Josh Boyer
2010-07-01 11:18       ` Josh Boyer
2010-07-01 11:18       ` Josh Boyer
     [not found]       ` <20100701111823.GE7756-jnIq6iUNB1CO8iYQgJmm/0EOCMrvLtNR@public.gmane.org>
2010-07-01 12:25         ` Alexander Graf
2010-07-01 12:25           ` Alexander Graf
2010-07-01 12:25           ` Alexander Graf
2010-07-12 11:24     ` Liu Yu-B13201
2010-07-12 11:24       ` Liu Yu-B13201
2010-07-12 11:24       ` Liu Yu-B13201
2010-07-01 10:42 ` [PATCH 15/27] KVM: PPC: Expose magic page support to guest Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 17/27] KVM: PPC: Generic KVM PV guest support Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` Alexander Graf [this message]
2010-07-01 10:42   ` [PATCH 18/27] KVM: PPC: KVM PV guest stubs Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 19/27] KVM: PPC: PV instructions to loads and stores Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 21/27] KVM: PPC: Introduce kvm_tmp framework Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
     [not found] ` <1277980982-12433-1-git-send-email-agraf-l3A5Bk7waGM@public.gmane.org>
2010-07-01 10:42   ` [PATCH 01/27] KVM: PPC: Introduce shared page Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42   ` [PATCH 06/27] KVM: PPC: Convert SPRG[0-4] to " Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42   ` [PATCH 07/27] KVM: PPC: Implement hypervisor interface Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42   ` [PATCH 10/27] KVM: PPC: Tell guest about pending interrupts Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42   ` [PATCH 12/27] KVM: PPC: First magic page steps Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42   ` [PATCH 13/27] KVM: PPC: Magic Page Book3s support Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
     [not found]     ` <1277980982-12433-14-git-send-email-agraf-l3A5Bk7waGM@public.gmane.org>
2010-07-02 15:37       ` Alexander Graf
2010-07-02 15:37         ` Alexander Graf
2010-07-02 15:37         ` Alexander Graf
     [not found]         ` <4C2E07AC.4010801-l3A5Bk7waGM@public.gmane.org>
2010-07-04  9:42           ` Avi Kivity
2010-07-04  9:42             ` Avi Kivity
2010-07-04  9:42             ` Avi Kivity
2010-07-01 10:42   ` [PATCH 16/27] KVM: Move kvm_guest_init out of generic code Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
     [not found]     ` <1277980982-12433-17-git-send-email-agraf-l3A5Bk7waGM@public.gmane.org>
2010-07-02  7:41       ` Geert Uytterhoeven
2010-07-02  7:41         ` Geert Uytterhoeven
2010-07-02  7:41         ` Geert Uytterhoeven
2010-07-02  7:44         ` Alexander Graf
2010-07-02  7:44           ` Alexander Graf
2010-07-02  7:44           ` Alexander Graf
2010-07-01 10:42   ` [PATCH 20/27] KVM: PPC: PV tlbsync to nop Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42   ` [PATCH 22/27] KVM: PPC: Introduce branch patching helper Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:42     ` Alexander Graf
2010-07-01 10:43   ` [PATCH 25/27] KVM: PPC: PV mtmsrd L=0 and mtmsr Alexander Graf
2010-07-01 10:43     ` Alexander Graf
2010-07-01 10:43     ` Alexander Graf
2010-07-01 10:43   ` [PATCH 26/27] KVM: PPC: PV wrteei Alexander Graf
2010-07-01 10:43     ` Alexander Graf
2010-07-01 10:43     ` Alexander Graf
2010-07-09  4:57   ` [PATCH 00/27] KVM PPC PV framework MJ embd
2010-07-09  4:57     ` MJ embd
2010-07-09  4:57     ` MJ embd
2010-07-09  6:33     ` Alexander Graf
2010-07-09  6:33       ` Alexander Graf
2010-07-09  6:33       ` Alexander Graf
2010-07-01 10:42 ` [PATCH 23/27] KVM: PPC: PV assembler helpers Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42 ` [PATCH 24/27] KVM: PPC: PV mtmsrd L=1 Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:42   ` Alexander Graf
2010-07-01 10:43 ` [PATCH 27/27] KVM: PPC: Add Documentation about PV interface Alexander Graf
2010-07-01 10:43   ` Alexander Graf
2010-07-01 10:43   ` Alexander Graf
     [not found]   ` <1277980982-12433-28-git-send-email-agraf-l3A5Bk7waGM@public.gmane.org>
2010-07-02 16:27     ` Segher Boessenkool
2010-07-02 16:27       ` Segher Boessenkool
2010-07-02 16:27       ` Segher Boessenkool
2010-07-02 18:41       ` Alexander Graf
2010-07-02 18:41         ` Alexander Graf
2010-07-02 18:41         ` Alexander Graf
     [not found]         ` <A98DA9FC-DC42-452E-BD44-5F86D1707BF0-l3A5Bk7waGM@public.gmane.org>
2010-07-03 22:42           ` Benjamin Herrenschmidt
2010-07-03 22:42             ` Benjamin Herrenschmidt
2010-07-03 22:42             ` Benjamin Herrenschmidt
2010-07-04  9:04             ` Alexander Graf
2010-07-04  9:04               ` Alexander Graf
2010-07-04  9:04               ` Alexander Graf
     [not found]       ` <EB2E1C5B-118B-481B-83D6-44CFAA2E55D3-XVmvHMARGAS8U2dJNN8I7kB+6BGkLq7r@public.gmane.org>
2010-07-03 22:41         ` Benjamin Herrenschmidt
2010-07-03 22:41           ` Benjamin Herrenschmidt
2010-07-03 22:41           ` Benjamin Herrenschmidt
2010-07-04  9:04           ` Alexander Graf
2010-07-04  9:04             ` Alexander Graf
2010-07-04  9:04             ` Alexander Graf
2010-07-04  9:10             ` Avi Kivity
2010-07-04  9:10               ` Avi Kivity
2010-07-04  9:10               ` Avi Kivity
     [not found]               ` <4C305001.7060301-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2010-07-04  9:17                 ` Alexander Graf
2010-07-04  9:17                   ` Alexander Graf
2010-07-04  9:17                   ` Alexander Graf
     [not found]                   ` <40488555-C73E-4C04-BFAD-31ED99CDBBDA-l3A5Bk7waGM@public.gmane.org>
2010-07-04  9:30                     ` Alexander Graf
2010-07-04  9:30                       ` Alexander Graf
2010-07-04  9:30                       ` Alexander Graf
     [not found]                       ` <486564E7-7942-4021-8EB2-67DC4E56580D-l3A5Bk7waGM@public.gmane.org>
2010-07-04  9:41                         ` Avi Kivity
2010-07-04  9:41                           ` Avi Kivity
2010-07-04  9:41                           ` Avi Kivity
2010-07-04  9:37                     ` Avi Kivity
2010-07-04  9:37                       ` Avi Kivity
2010-07-04  9:37                       ` Avi Kivity
2010-07-02 17:59     ` Hollis Blanchard
2010-07-02 17:59       ` Hollis Blanchard
2010-07-02 17:59       ` Hollis Blanchard
2010-07-02 18:47       ` Alexander Graf
2010-07-02 18:47         ` Alexander Graf
2010-07-02 18:47         ` Alexander Graf
     [not found]         ` <3085B58A-01A1-4B5C-A0E7-024DCFDFD4B2-l3A5Bk7waGM@public.gmane.org>
2010-07-02 19:10           ` Scott Wood
2010-07-02 19:10             ` Scott Wood
2010-07-02 19:10             ` Scott Wood
     [not found]             ` <20100702141003.75302a9a-1MYqz8GpK7RekFaExTCHk1jVikpgYyvb5NbjCUgZEJk@public.gmane.org>
2010-07-04  9:02               ` Alexander Graf
2010-07-04  9:02                 ` Alexander Graf
2010-07-04  9:02                 ` Alexander Graf
2010-07-09  9:11     ` MJ embd
2010-07-09  9:23       ` MJ embd
2010-07-09  9:11       ` MJ embd
     [not found]       ` <AANLkTil6RekYBNnpM2MjSH7rcrHQZdHRwK5cBrvKQKhM-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2010-07-09  9:15         ` Alexander Graf
2010-07-09  9:15           ` Alexander Graf
2010-07-09  9:15           ` Alexander Graf
2010-07-02 16:22 ` [PATCH 00/27] KVM PPC PV framework Segher Boessenkool
2010-07-02 16:22   ` Segher Boessenkool
2010-07-02 16:22   ` Segher Boessenkool
     [not found]   ` <82C19122-91B6-4F91-9EF0-BEA2759A349D-XVmvHMARGAS8U2dJNN8I7kB+6BGkLq7r@public.gmane.org>
2010-07-02 16:59     ` Alexander Graf
2010-07-02 16:59       ` Alexander Graf
2010-07-02 16:59       ` Alexander Graf

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=1277980982-12433-19-git-send-email-agraf@suse.de \
    --to=agraf@suse.de \
    --cc=kvm-ppc@vger.kernel.org \
    --cc=kvm@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.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.