All of lore.kernel.org
 help / color / mirror / Atom feed
From: Peter Zijlstra <peterz@infradead.org>
To: Waiman Long <Waiman.Long@hp.com>
Cc: linux-arch@vger.kernel.org, Rik van Riel <riel@redhat.com>,
	Raghavendra K T <raghavendra.kt@linux.vnet.ibm.com>,
	Gleb Natapov <gleb@redhat.com>,
	kvm@vger.kernel.org,
	Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>,
	Scott J Norton <scott.norton@hp.com>,
	x86@kernel.org, Paolo Bonzini <paolo.bonzini@gmail.com>,
	linux-kernel@vger.kernel.org,
	virtualization@lists.linux-foundation.org,
	Ingo Molnar <mingo@redhat.com>, Chegu Vinod <chegu_vinod@hp.com>,
	David Vrabel <david.vrabel@citrix.com>,
	"H. Peter Anvin" <hpa@zytor.com>,
	xen-devel@lists.xenproject.org,
	Thomas Gleixner <tglx@linutronix.de>,
	"Paul E. McKenney" <paulmck@linux.vnet.ibm.com>,
	Linus Torvalds <torvalds@linux-foundation.org>,
	Oleg Nesterov <oleg@redhat.com>
Subject: Re: [PATCH v9 07/19] qspinlock: Use a simple write to grab the lock, if applicable
Date: Thu, 17 Apr 2014 18:54:08 +0200	[thread overview]
Message-ID: <20140417165408.GU11096@twins.programming.kicks-ass.net> (raw)
In-Reply-To: <1397747051-15401-8-git-send-email-Waiman.Long@hp.com>

On Thu, Apr 17, 2014 at 11:03:59AM -0400, Waiman Long wrote:
>  kernel/locking/qspinlock.c |   61 +++++++++++++++++++++++++++++++------------
>  1 files changed, 44 insertions(+), 17 deletions(-)
> 
> diff --git a/kernel/locking/qspinlock.c b/kernel/locking/qspinlock.c
> index 497da24..80fe9ee 100644
> --- a/kernel/locking/qspinlock.c
> +++ b/kernel/locking/qspinlock.c
> @@ -98,23 +98,29 @@ static inline struct mcs_spinlock *decode_tail(u32 tail)
>   * can allow better optimization of the lock acquisition for the pending
>   * bit holder.
>   */
> -#if _Q_PENDING_BITS == 8
> -
>  struct __qspinlock {
>  	union {
>  		atomic_t val;
> -		struct {
>  #ifdef __LITTLE_ENDIAN
> +		u8	 locked;
> +		struct {
>  			u16	locked_pending;
>  			u16	tail;
> +		};
>  #else
> +		struct {
>  			u16	tail;
>  			u16	locked_pending;
> -#endif
>  		};
> +		struct {
> +			u8	reserved[3];
> +			u8	locked;
> +		};
> +#endif

Ah, yes, that's probably nicer than what I made of it..

>  	};
>  };
>  
> +#if _Q_PENDING_BITS == 8
>  /**
>   * clear_pending_set_locked - take ownership and clear the pending bit.
>   * @lock: Pointer to queue spinlock structure
> @@ -204,6 +210,22 @@ xchg_tail(struct qspinlock *lock, u32 tail, u32 *pval)
>  #endif /* _Q_PENDING_BITS == 8 */
>  
>  /**
> + * get_qlock - Set the lock bit and own the lock
> + * @lock: Pointer to queue spinlock structure
> + *
> + * This routine should only be called when the caller is the only one
> + * entitled to acquire the lock.
> + */
> +static __always_inline void get_qlock(struct qspinlock *lock)

Don't like that function name though; what was wrong with set_locked(),
which is more or less what I called it.

> +{
> +	struct __qspinlock *l = (void *)lock;
> +
> +	barrier();
> +	ACCESS_ONCE(l->locked) = _Q_LOCKED_VAL;
> +	barrier();
> +}

> @@ -378,15 +403,19 @@ void queue_spin_lock_slowpath(struct qspinlock *lock, u32 val)
>  	 *
>  	 * n,0,0 -> 0,0,1 : lock, uncontended
>  	 * *,0,0 -> *,0,1 : lock, contended
> +	 *
> +	 * If the queue head is the only one in the queue (lock value == tail),
> +	 * clear the tail code and grab the lock. Otherwise, we only need
> +	 * to grab the lock.
>  	 */
>  	for (;;) {
> -		new = _Q_LOCKED_VAL;
> -		if (val != tail)
> -			new |= val;
> -
> -		old = atomic_cmpxchg(&lock->val, val, new);
> -		if (old == val)
> +		if (val != tail) {
> +			get_qlock(lock);
>  			break;
> +		}

Ah, good one. I hadn't done that.

> +		old = atomic_cmpxchg(&lock->val, val, _Q_LOCKED_VAL);
> +		if (old == val)
> +			goto release;	/* No contention */
>  
>  		val = old;
>  	}

I did have a patch that played tricks with ->next, but I seem to have
forgotten the details, and I tossed the patch because it didn't show any
difference on the benchmark.

WARNING: multiple messages have this Message-ID (diff)
From: Peter Zijlstra <peterz@infradead.org>
To: Waiman Long <Waiman.Long@hp.com>
Cc: Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>, "H. Peter Anvin" <hpa@zytor.com>,
	linux-arch@vger.kernel.org, x86@kernel.org,
	linux-kernel@vger.kernel.org,
	virtualization@lists.linux-foundation.org,
	xen-devel@lists.xenproject.org, kvm@vger.kernel.org,
	Paolo Bonzini <paolo.bonzini@gmail.com>,
	Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>,
	"Paul E. McKenney" <paulmck@linux.vnet.ibm.com>,
	Rik van Riel <riel@redhat.com>,
	Linus Torvalds <torvalds@linux-foundation.org>,
	Raghavendra K T <raghavendra.kt@linux.vnet.ibm.com>,
	David Vrabel <david.vrabel@citrix.com>,
	Oleg Nesterov <oleg@redhat.com>, Gleb Natapov <gleb@redhat.com>,
	Scott J Norton <scott.norton@hp.com>,
	Chegu Vinod <chegu_vinod@hp.com>
Subject: Re: [PATCH v9 07/19] qspinlock: Use a simple write to grab the lock, if applicable
Date: Thu, 17 Apr 2014 18:54:08 +0200	[thread overview]
Message-ID: <20140417165408.GU11096@twins.programming.kicks-ass.net> (raw)
Message-ID: <20140417165408.Re_7LFlvPAIUazeeDBTnn2mX2YGFNc2i9zwwnu9NMWU@z> (raw)
In-Reply-To: <1397747051-15401-8-git-send-email-Waiman.Long@hp.com>

On Thu, Apr 17, 2014 at 11:03:59AM -0400, Waiman Long wrote:
>  kernel/locking/qspinlock.c |   61 +++++++++++++++++++++++++++++++------------
>  1 files changed, 44 insertions(+), 17 deletions(-)
> 
> diff --git a/kernel/locking/qspinlock.c b/kernel/locking/qspinlock.c
> index 497da24..80fe9ee 100644
> --- a/kernel/locking/qspinlock.c
> +++ b/kernel/locking/qspinlock.c
> @@ -98,23 +98,29 @@ static inline struct mcs_spinlock *decode_tail(u32 tail)
>   * can allow better optimization of the lock acquisition for the pending
>   * bit holder.
>   */
> -#if _Q_PENDING_BITS == 8
> -
>  struct __qspinlock {
>  	union {
>  		atomic_t val;
> -		struct {
>  #ifdef __LITTLE_ENDIAN
> +		u8	 locked;
> +		struct {
>  			u16	locked_pending;
>  			u16	tail;
> +		};
>  #else
> +		struct {
>  			u16	tail;
>  			u16	locked_pending;
> -#endif
>  		};
> +		struct {
> +			u8	reserved[3];
> +			u8	locked;
> +		};
> +#endif

Ah, yes, that's probably nicer than what I made of it..

>  	};
>  };
>  
> +#if _Q_PENDING_BITS == 8
>  /**
>   * clear_pending_set_locked - take ownership and clear the pending bit.
>   * @lock: Pointer to queue spinlock structure
> @@ -204,6 +210,22 @@ xchg_tail(struct qspinlock *lock, u32 tail, u32 *pval)
>  #endif /* _Q_PENDING_BITS == 8 */
>  
>  /**
> + * get_qlock - Set the lock bit and own the lock
> + * @lock: Pointer to queue spinlock structure
> + *
> + * This routine should only be called when the caller is the only one
> + * entitled to acquire the lock.
> + */
> +static __always_inline void get_qlock(struct qspinlock *lock)

Don't like that function name though; what was wrong with set_locked(),
which is more or less what I called it.

> +{
> +	struct __qspinlock *l = (void *)lock;
> +
> +	barrier();
> +	ACCESS_ONCE(l->locked) = _Q_LOCKED_VAL;
> +	barrier();
> +}

> @@ -378,15 +403,19 @@ void queue_spin_lock_slowpath(struct qspinlock *lock, u32 val)
>  	 *
>  	 * n,0,0 -> 0,0,1 : lock, uncontended
>  	 * *,0,0 -> *,0,1 : lock, contended
> +	 *
> +	 * If the queue head is the only one in the queue (lock value == tail),
> +	 * clear the tail code and grab the lock. Otherwise, we only need
> +	 * to grab the lock.
>  	 */
>  	for (;;) {
> -		new = _Q_LOCKED_VAL;
> -		if (val != tail)
> -			new |= val;
> -
> -		old = atomic_cmpxchg(&lock->val, val, new);
> -		if (old == val)
> +		if (val != tail) {
> +			get_qlock(lock);
>  			break;
> +		}

Ah, good one. I hadn't done that.

> +		old = atomic_cmpxchg(&lock->val, val, _Q_LOCKED_VAL);
> +		if (old == val)
> +			goto release;	/* No contention */
>  
>  		val = old;
>  	}

I did have a patch that played tricks with ->next, but I seem to have
forgotten the details, and I tossed the patch because it didn't show any
difference on the benchmark.

  reply	other threads:[~2014-04-17 16:54 UTC|newest]

Thread overview: 211+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-17 15:03 [PATCH v9 00/19] qspinlock: a 4-byte queue spinlock with PV support Waiman Long
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03 ` [PATCH v9 01/19] qspinlock: A simple generic 4-byte queue spinlock Waiman Long
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03 ` [PATCH v9 02/19] qspinlock, x86: Enable x86-64 to use " Waiman Long
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03 ` [PATCH v9 03/19] qspinlock: Add pending bit Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:42   ` Peter Zijlstra
2014-04-17 15:42     ` Peter Zijlstra
2014-04-17 21:20     ` Waiman Long
2014-04-17 21:20     ` Waiman Long
2014-04-18  8:13       ` Peter Zijlstra
2014-04-18  8:13         ` Peter Zijlstra
2014-04-18 17:07         ` Waiman Long
2014-04-18 17:07         ` Waiman Long
2014-04-18 17:07           ` Waiman Long
2014-04-18  8:13       ` Peter Zijlstra
2014-04-17 21:20     ` Waiman Long
2014-04-17 15:42   ` Peter Zijlstra
2014-04-18  7:42   ` Ingo Molnar
2014-04-18  7:42     ` Ingo Molnar
2014-04-18 16:23     ` Waiman Long
2014-04-18 16:23     ` Waiman Long
2014-04-18 16:23       ` Waiman Long
2014-04-18 16:35       ` Konrad Rzeszutek Wilk
2014-04-18 16:35         ` Konrad Rzeszutek Wilk
2014-04-18 18:12         ` Waiman Long
2014-04-18 18:12           ` Waiman Long
2014-04-18 18:12         ` Waiman Long
2014-04-18 16:35       ` Konrad Rzeszutek Wilk
2014-04-18  7:42   ` Ingo Molnar
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03 ` [PATCH v9 04/19] qspinlock: Extract out the exchange of tail code word Waiman Long
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:49   ` Peter Zijlstra
2014-04-17 15:49     ` Peter Zijlstra
2014-04-17 21:28     ` Waiman Long
2014-04-17 21:28     ` Waiman Long
2014-04-17 21:28       ` Waiman Long
2014-04-18  8:15       ` Peter Zijlstra
2014-04-18  8:15       ` Peter Zijlstra
2014-04-18  8:15         ` Peter Zijlstra
2014-04-18 17:32         ` Waiman Long
2014-04-18 17:32           ` Waiman Long
2014-04-18 17:53           ` Peter Zijlstra
2014-04-18 17:53             ` Peter Zijlstra
2014-04-18 18:13             ` Waiman Long
2014-04-18 18:13               ` Waiman Long
2014-04-18 18:13             ` Waiman Long
2014-04-18 17:53           ` Peter Zijlstra
2014-04-18 17:32         ` Waiman Long
2014-04-17 15:49   ` Peter Zijlstra
2014-04-17 15:03 ` [PATCH v9 05/19] qspinlock: Optimize for smaller NR_CPUS Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 15:50   ` Peter Zijlstra
2014-04-17 15:50   ` Peter Zijlstra
2014-04-17 15:50     ` Peter Zijlstra
2014-04-17 21:29     ` Waiman Long
2014-04-17 21:29     ` Waiman Long
2014-04-17 21:29       ` Waiman Long
2014-04-17 15:51   ` Peter Zijlstra
2014-04-17 15:51     ` Peter Zijlstra
2014-04-17 21:33     ` Waiman Long
2014-04-17 21:33     ` Waiman Long
2014-04-17 21:33       ` Waiman Long
2014-04-17 15:51   ` Peter Zijlstra
2014-04-17 15:56   ` Peter Zijlstra
2014-04-17 15:56     ` Peter Zijlstra
2014-04-17 21:46     ` Waiman Long
2014-04-17 21:46     ` Waiman Long
2014-04-17 21:46       ` Waiman Long
2014-04-18  8:27       ` Peter Zijlstra
2014-04-18  8:27         ` Peter Zijlstra
2014-04-18 17:52         ` Waiman Long
2014-04-18 17:52           ` Waiman Long
2014-04-18 19:05           ` Peter Zijlstra
2014-04-18 19:05             ` Peter Zijlstra
2014-04-18 21:40             ` Waiman Long
2014-04-18 21:40             ` Waiman Long
2014-04-18 21:40               ` Waiman Long
2014-04-23 14:23               ` Waiman Long
2014-04-23 14:23               ` Waiman Long
2014-04-23 14:23                 ` Waiman Long
2014-04-23 14:56                 ` Konrad Rzeszutek Wilk
2014-04-23 14:56                 ` Konrad Rzeszutek Wilk
2014-04-23 14:56                   ` Konrad Rzeszutek Wilk
2014-04-23 17:43                   ` Waiman Long
2014-04-23 17:43                   ` Waiman Long
2014-04-23 17:43                     ` Waiman Long
2014-04-23 17:55                     ` Konrad Rzeszutek Wilk
2014-04-23 17:55                     ` Konrad Rzeszutek Wilk
2014-04-23 17:55                       ` Konrad Rzeszutek Wilk
2014-04-23 22:24                       ` Waiman Long
2014-04-23 22:24                       ` Waiman Long
2014-04-23 22:24                         ` Waiman Long
2014-04-23 23:48                         ` Waiman Long
2014-04-23 23:48                           ` Waiman Long
2014-04-23 23:48                         ` Waiman Long
2014-04-18 19:05           ` Peter Zijlstra
2014-04-18 17:52         ` Waiman Long
2014-04-18  8:27       ` Peter Zijlstra
2014-04-17 15:56   ` Peter Zijlstra
2014-04-17 15:58   ` Peter Zijlstra
2014-04-17 15:58   ` Peter Zijlstra
2014-04-17 15:58     ` Peter Zijlstra
2014-04-17 21:49     ` Waiman Long
2014-04-17 21:49     ` Waiman Long
2014-04-17 21:49       ` Waiman Long
2014-04-18  7:46       ` Ingo Molnar
2014-04-18  7:46       ` Ingo Molnar
2014-04-18  7:46         ` Ingo Molnar
2014-04-18 16:26         ` Waiman Long
2014-04-18 16:26           ` Waiman Long
2014-04-19  9:24           ` Ingo Molnar
2014-04-19  9:24             ` Ingo Molnar
2014-04-19  9:24           ` Ingo Molnar
2014-04-18 16:26         ` Waiman Long
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03 ` [PATCH v9 06/19] qspinlock: prolong the stay in the pending bit path Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 16:36   ` Peter Zijlstra
2014-04-17 16:36     ` Peter Zijlstra
2014-04-18  1:46     ` Waiman Long
2014-04-18  1:46     ` Waiman Long
2014-04-18  1:46       ` Waiman Long
2014-04-18  8:33       ` Peter Zijlstra
2014-04-18  8:33       ` Peter Zijlstra
2014-04-18  8:33         ` Peter Zijlstra
2014-04-18 18:07         ` Waiman Long
2014-04-18 18:07         ` Waiman Long
2014-04-18 18:07         ` Waiman Long
2014-04-17 16:36   ` Peter Zijlstra
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:03 ` [PATCH v9 07/19] qspinlock: Use a simple write to grab the lock, if applicable Waiman Long
2014-04-17 15:03   ` Waiman Long
2014-04-17 16:54   ` Peter Zijlstra [this message]
2014-04-17 16:54     ` Peter Zijlstra
2014-04-17 16:54   ` Peter Zijlstra
2014-04-17 15:03 ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 08/19] qspinlock: Make a new qnode structure to support virtualization Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 09/19] qspinlock: Prepare for unfair lock support Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 10/19] qspinlock, x86: Allow unfair spinlock in a virtual guest Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 11/19] qspinlock: Split the MCS queuing code into a separate slowerpath Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 12/19] unfair qspinlock: Variable frequency lock stealing mechanism Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 13/19] unfair qspinlock: Enable lock stealing in lock waiters Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 14/19] pvqspinlock, x86: Rename paravirt_ticketlocks_enabled Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 15/19] pvqspinlock, x86: Add PV data structure & methods Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 16/19] pvqspinlock: Enable coexistence with the unfair lock Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 17/19] pvqspinlock: Add qspinlock para-virtualization support Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 18/19] pvqspinlock, x86: Enable PV qspinlock PV for KVM Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04 ` [PATCH v9 19/19] pvqspinlock, x86: Enable PV qspinlock for XEN Waiman Long
2014-04-17 15:04 ` Waiman Long
2014-04-17 15:04   ` Waiman Long
2014-04-17 17:23 ` [PATCH v9 00/19] qspinlock: a 4-byte queue spinlock with PV support Konrad Rzeszutek Wilk
2014-04-17 17:23   ` Konrad Rzeszutek Wilk
2014-04-17 17:40   ` Raghavendra K T
2014-04-17 17:40     ` Raghavendra K T
2014-04-18  1:50     ` Waiman Long
2014-04-18  1:50     ` Waiman Long
2014-04-18  1:50     ` Waiman Long
2014-04-17 17:40   ` Raghavendra K T
2014-04-18  1:48   ` Waiman Long
2014-04-18  1:48     ` Waiman Long
2014-04-18 13:18     ` Konrad Rzeszutek Wilk
2014-04-18 13:18       ` Konrad Rzeszutek Wilk
2014-04-18 17:05       ` Waiman Long
2014-04-18 17:05         ` Waiman Long
2014-04-18 17:05       ` Waiman Long
2014-04-18 13:18     ` Konrad Rzeszutek Wilk
2014-04-18  1:48   ` Waiman Long
2014-04-17 17:23 ` Konrad Rzeszutek Wilk
2014-04-27 18:09 ` Raghavendra K T
2014-05-07 15:00   ` Waiman Long
2014-05-07 15:00   ` Waiman Long
2014-05-07 15:00   ` Waiman Long
2014-04-27 18:09 ` Raghavendra K T
2014-04-27 18:09 ` Raghavendra K T

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=20140417165408.GU11096@twins.programming.kicks-ass.net \
    --to=peterz@infradead.org \
    --cc=Waiman.Long@hp.com \
    --cc=chegu_vinod@hp.com \
    --cc=david.vrabel@citrix.com \
    --cc=gleb@redhat.com \
    --cc=hpa@zytor.com \
    --cc=konrad.wilk@oracle.com \
    --cc=kvm@vger.kernel.org \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=oleg@redhat.com \
    --cc=paolo.bonzini@gmail.com \
    --cc=paulmck@linux.vnet.ibm.com \
    --cc=raghavendra.kt@linux.vnet.ibm.com \
    --cc=riel@redhat.com \
    --cc=scott.norton@hp.com \
    --cc=tglx@linutronix.de \
    --cc=torvalds@linux-foundation.org \
    --cc=virtualization@lists.linux-foundation.org \
    --cc=x86@kernel.org \
    --cc=xen-devel@lists.xenproject.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.