* [PATCH] riscv: probes: reject kprobes inside LR/SC sequences
@ 2026-08-19 10:29 ` Xiaofeng Yuan
0 siblings, 0 replies; 4+ messages in thread
From: Xiaofeng Yuan @ 2026-08-19 10:29 UTC (permalink / raw)
To: Paul Walmsley, Palmer Dabbelt, Albert Ou
Cc: linux-riscv, linux-kernel, yuanxiaofeng
A breakpoint trap taken in the middle of an LR/SC sequence clears the
load reservation, so an SC following the probed instruction would always
fail and the enclosing retry loop would re-enter the breakpoint,
livelocking the CPU.
Reject probing the LR/SC instructions themselves, and reject probing
any address that lies inside an LR/SC sequence by scanning back up to
the Zalrsc constrained-loop limit of 64 bytes.
Signed-off-by: Xiaofeng Yuan <yuanxiaofeng@eswincomputing.com>
---
arch/riscv/include/asm/insn.h | 18 +++++++++
arch/riscv/kernel/probes/decode-insn.c | 2 +
arch/riscv/kernel/probes/kprobes.c | 51 ++++++++++++++++++++++++++
3 files changed, 71 insertions(+)
diff --git a/arch/riscv/include/asm/insn.h b/arch/riscv/include/asm/insn.h
index c3005573e8..d7d85b1b84 100644
--- a/arch/riscv/include/asm/insn.h
+++ b/arch/riscv/include/asm/insn.h
@@ -13,9 +13,12 @@
#define RV_INSN_OPCODE_MASK GENMASK(6, 0)
#define RV_INSN_OPCODE_OPOFF 0
#define RV_INSN_FUNCT12_OPOFF 20
+#define RVG_FUNCT5_MASK GENMASK(31, 27)
+#define RVG_FUNCT5_OPOFF 27
#define RV_ENCODE_FUNCT3(f_) (RVG_FUNCT3_##f_ << RV_INSN_FUNCT3_OPOFF)
#define RV_ENCODE_FUNCT12(f_) (RVG_FUNCT12_##f_ << RV_INSN_FUNCT12_OPOFF)
+#define RV_ENCODE_FUNCT5(f_) (RVG_FUNCT5_##f_ << RVG_FUNCT5_OPOFF)
/* The bit field of immediate value in I-type instruction */
#define RV_I_IMM_SIGN_OPOFF 31
@@ -137,6 +140,7 @@
/* parts of opcode for RVG*/
#define RVG_OPCODE_FENCE 0x0f
#define RVG_OPCODE_AUIPC 0x17
+#define RVG_OPCODE_LRSC 0x2f
#define RVG_OPCODE_BRANCH 0x63
#define RVG_OPCODE_JALR 0x67
#define RVG_OPCODE_JAL 0x6f
@@ -176,6 +180,9 @@
#define RVG_FUNCT3_BLTU 0x6
#define RVG_FUNCT3_BGEU 0x7
+#define RVG_FUNCT5_LR 0x02
+#define RVG_FUNCT5_SC 0x03
+
/* parts of funct3 code for C extension*/
#define RVC_FUNCT3_C_BEQZ 0x6
#define RVC_FUNCT3_C_BNEZ 0x7
@@ -200,6 +207,8 @@
#define RVG_MATCH_BGEU (RV_ENCODE_FUNCT3(BGEU) | RVG_OPCODE_BRANCH)
#define RVG_MATCH_EBREAK (RV_ENCODE_FUNCT12(EBREAK) | RVG_OPCODE_SYSTEM)
#define RVG_MATCH_SRET (RV_ENCODE_FUNCT12(SRET) | RVG_OPCODE_SYSTEM)
+#define RVG_MATCH_LR (RV_ENCODE_FUNCT5(LR) | RVG_OPCODE_LRSC)
+#define RVG_MATCH_SC (RV_ENCODE_FUNCT5(SC) | RVG_OPCODE_LRSC)
#define RVC_MATCH_C_BEQZ (RVC_ENCODE_FUNCT3(C_BEQZ) | RVC_OPCODE_C1)
#define RVC_MATCH_C_BNEZ (RVC_ENCODE_FUNCT3(C_BNEZ) | RVC_OPCODE_C1)
#define RVC_MATCH_C_J (RVC_ENCODE_FUNCT3(C_J) | RVC_OPCODE_C1)
@@ -227,6 +236,8 @@
#define RVC_MASK_C_EBREAK 0xffff
#define RVG_MASK_EBREAK 0xffffffff
#define RVG_MASK_SRET 0xffffffff
+#define RVG_MASK_LR (RVG_FUNCT5_MASK | GENMASK(14, 14) | RV_INSN_OPCODE_MASK)
+#define RVG_MASK_SC (RVG_FUNCT5_MASK | GENMASK(14, 14) | RV_INSN_OPCODE_MASK)
#define __INSN_LENGTH_MASK _UL(0x3)
#define __INSN_LENGTH_GE_32 _UL(0x3)
@@ -262,6 +273,13 @@ __RISCV_INSN_FUNCS(c_ebreak, RVC_MASK_C_EBREAK, RVC_MATCH_C_EBREAK)
__RISCV_INSN_FUNCS(ebreak, RVG_MASK_EBREAK, RVG_MATCH_EBREAK)
__RISCV_INSN_FUNCS(sret, RVG_MASK_SRET, RVG_MATCH_SRET)
__RISCV_INSN_FUNCS(fence, RVG_MASK_FENCE, RVG_MATCH_FENCE);
+/*
+ * LR/SC (Zalrsc, opcode 0x2f). funct3 selects the operand size: 000 (W)
+ * and 011 (D) on RV64; bit 14 is clear for both, so it is used to match
+ * either size. The .aq/.rl bits (26:25) and rd are ignored.
+ */
+__RISCV_INSN_FUNCS(lr, RVG_MASK_LR, RVG_MATCH_LR)
+__RISCV_INSN_FUNCS(sc, RVG_MASK_SC, RVG_MATCH_SC)
/* special case to catch _any_ system instruction */
static __always_inline bool riscv_insn_is_system(u32 code)
diff --git a/arch/riscv/kernel/probes/decode-insn.c b/arch/riscv/kernel/probes/decode-insn.c
index 65d9590bfb..eae393ef58 100644
--- a/arch/riscv/kernel/probes/decode-insn.c
+++ b/arch/riscv/kernel/probes/decode-insn.c
@@ -23,6 +23,8 @@ riscv_probe_decode_insn(probe_opcode_t *addr, struct arch_probe_insn *api)
*/
RISCV_INSN_REJECTED(system, insn);
RISCV_INSN_REJECTED(fence, insn);
+ RISCV_INSN_REJECTED(lr, insn);
+ RISCV_INSN_REJECTED(sc, insn);
/*
* Simulate instructions list:
diff --git a/arch/riscv/kernel/probes/kprobes.c b/arch/riscv/kernel/probes/kprobes.c
index 9e2afabf94..e10c40b103 100644
--- a/arch/riscv/kernel/probes/kprobes.c
+++ b/arch/riscv/kernel/probes/kprobes.c
@@ -13,6 +13,7 @@
#include <asm/cacheflush.h>
#include <asm/bug.h>
#include <asm/text-patching.h>
+#include <asm/insn.h>
#include "decode-insn.h"
@@ -69,6 +70,53 @@ static bool __kprobes arch_check_kprobe(unsigned long addr)
return false;
}
+/*
+ * A trap taken in the middle of an LR/SC sequence clears the load
+ * reservation, so an SC following the probed instruction would always
+ * fail and the enclosing retry loop would re-enter the breakpoint.
+ * Reject probes inside such a sequence.
+ *
+ * A constrained LR/SC loop (Zalrsc) is limited to 16 instructions placed
+ * sequentially in memory (64 bytes in the base ISA), so scanning back
+ * that far covers every possible enclosing sequence.
+ */
+#define MAX_ATOMIC_CONTEXT_SIZE 64
+
+static bool __kprobes riscv_probe_insn_in_atomic(unsigned long addr)
+{
+ unsigned long tmp, offset, scan_start;
+ bool in_atomic = false;
+
+ if (!kallsyms_lookup_size_offset(addr, NULL, &offset))
+ return false;
+
+ tmp = addr - offset; /* function entry */
+
+ if (offset > MAX_ATOMIC_CONTEXT_SIZE)
+ scan_start = addr - MAX_ATOMIC_CONTEXT_SIZE;
+ else
+ scan_start = tmp;
+
+ /* advance to the scan window, keeping instruction alignment */
+ while (tmp < scan_start)
+ tmp += GET_INSN_LENGTH(*(u16 *)tmp);
+
+ /* scan the window, tracking whether an LR is still outstanding */
+ while (tmp < addr) {
+ if (GET_INSN_LENGTH(*(u16 *)tmp) == 4) {
+ u32 insn = *(u32 *)tmp;
+
+ if (riscv_insn_is_lr(insn))
+ in_atomic = true;
+ else if (riscv_insn_is_sc(insn))
+ in_atomic = false;
+ }
+ tmp += GET_INSN_LENGTH(*(u16 *)tmp);
+ }
+
+ return in_atomic;
+}
+
int __kprobes arch_prepare_kprobe(struct kprobe *p)
{
u16 *insn = (u16 *)p->addr;
@@ -79,6 +127,9 @@ int __kprobes arch_prepare_kprobe(struct kprobe *p)
if (!arch_check_kprobe((unsigned long)p->addr))
return -EILSEQ;
+ if (riscv_probe_insn_in_atomic((unsigned long)p->addr))
+ return -EINVAL;
+
/* copy instruction */
p->opcode = (kprobe_opcode_t)(*insn++);
if (GET_INSN_LENGTH(p->opcode) == 4)
--
2.43.0
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH] riscv: probes: reject kprobes inside LR/SC sequences
@ 2026-08-19 10:29 ` Xiaofeng Yuan
0 siblings, 0 replies; 4+ messages in thread
From: Xiaofeng Yuan @ 2026-08-19 10:29 UTC (permalink / raw)
To: Paul Walmsley, Palmer Dabbelt, Albert Ou
Cc: linux-riscv, linux-kernel, yuanxiaofeng
A breakpoint trap taken in the middle of an LR/SC sequence clears the
load reservation, so an SC following the probed instruction would always
fail and the enclosing retry loop would re-enter the breakpoint,
livelocking the CPU.
Reject probing the LR/SC instructions themselves, and reject probing
any address that lies inside an LR/SC sequence by scanning back up to
the Zalrsc constrained-loop limit of 64 bytes.
Signed-off-by: Xiaofeng Yuan <yuanxiaofeng@eswincomputing.com>
---
arch/riscv/include/asm/insn.h | 18 +++++++++
arch/riscv/kernel/probes/decode-insn.c | 2 +
arch/riscv/kernel/probes/kprobes.c | 51 ++++++++++++++++++++++++++
3 files changed, 71 insertions(+)
diff --git a/arch/riscv/include/asm/insn.h b/arch/riscv/include/asm/insn.h
index c3005573e8..d7d85b1b84 100644
--- a/arch/riscv/include/asm/insn.h
+++ b/arch/riscv/include/asm/insn.h
@@ -13,9 +13,12 @@
#define RV_INSN_OPCODE_MASK GENMASK(6, 0)
#define RV_INSN_OPCODE_OPOFF 0
#define RV_INSN_FUNCT12_OPOFF 20
+#define RVG_FUNCT5_MASK GENMASK(31, 27)
+#define RVG_FUNCT5_OPOFF 27
#define RV_ENCODE_FUNCT3(f_) (RVG_FUNCT3_##f_ << RV_INSN_FUNCT3_OPOFF)
#define RV_ENCODE_FUNCT12(f_) (RVG_FUNCT12_##f_ << RV_INSN_FUNCT12_OPOFF)
+#define RV_ENCODE_FUNCT5(f_) (RVG_FUNCT5_##f_ << RVG_FUNCT5_OPOFF)
/* The bit field of immediate value in I-type instruction */
#define RV_I_IMM_SIGN_OPOFF 31
@@ -137,6 +140,7 @@
/* parts of opcode for RVG*/
#define RVG_OPCODE_FENCE 0x0f
#define RVG_OPCODE_AUIPC 0x17
+#define RVG_OPCODE_LRSC 0x2f
#define RVG_OPCODE_BRANCH 0x63
#define RVG_OPCODE_JALR 0x67
#define RVG_OPCODE_JAL 0x6f
@@ -176,6 +180,9 @@
#define RVG_FUNCT3_BLTU 0x6
#define RVG_FUNCT3_BGEU 0x7
+#define RVG_FUNCT5_LR 0x02
+#define RVG_FUNCT5_SC 0x03
+
/* parts of funct3 code for C extension*/
#define RVC_FUNCT3_C_BEQZ 0x6
#define RVC_FUNCT3_C_BNEZ 0x7
@@ -200,6 +207,8 @@
#define RVG_MATCH_BGEU (RV_ENCODE_FUNCT3(BGEU) | RVG_OPCODE_BRANCH)
#define RVG_MATCH_EBREAK (RV_ENCODE_FUNCT12(EBREAK) | RVG_OPCODE_SYSTEM)
#define RVG_MATCH_SRET (RV_ENCODE_FUNCT12(SRET) | RVG_OPCODE_SYSTEM)
+#define RVG_MATCH_LR (RV_ENCODE_FUNCT5(LR) | RVG_OPCODE_LRSC)
+#define RVG_MATCH_SC (RV_ENCODE_FUNCT5(SC) | RVG_OPCODE_LRSC)
#define RVC_MATCH_C_BEQZ (RVC_ENCODE_FUNCT3(C_BEQZ) | RVC_OPCODE_C1)
#define RVC_MATCH_C_BNEZ (RVC_ENCODE_FUNCT3(C_BNEZ) | RVC_OPCODE_C1)
#define RVC_MATCH_C_J (RVC_ENCODE_FUNCT3(C_J) | RVC_OPCODE_C1)
@@ -227,6 +236,8 @@
#define RVC_MASK_C_EBREAK 0xffff
#define RVG_MASK_EBREAK 0xffffffff
#define RVG_MASK_SRET 0xffffffff
+#define RVG_MASK_LR (RVG_FUNCT5_MASK | GENMASK(14, 14) | RV_INSN_OPCODE_MASK)
+#define RVG_MASK_SC (RVG_FUNCT5_MASK | GENMASK(14, 14) | RV_INSN_OPCODE_MASK)
#define __INSN_LENGTH_MASK _UL(0x3)
#define __INSN_LENGTH_GE_32 _UL(0x3)
@@ -262,6 +273,13 @@ __RISCV_INSN_FUNCS(c_ebreak, RVC_MASK_C_EBREAK, RVC_MATCH_C_EBREAK)
__RISCV_INSN_FUNCS(ebreak, RVG_MASK_EBREAK, RVG_MATCH_EBREAK)
__RISCV_INSN_FUNCS(sret, RVG_MASK_SRET, RVG_MATCH_SRET)
__RISCV_INSN_FUNCS(fence, RVG_MASK_FENCE, RVG_MATCH_FENCE);
+/*
+ * LR/SC (Zalrsc, opcode 0x2f). funct3 selects the operand size: 000 (W)
+ * and 011 (D) on RV64; bit 14 is clear for both, so it is used to match
+ * either size. The .aq/.rl bits (26:25) and rd are ignored.
+ */
+__RISCV_INSN_FUNCS(lr, RVG_MASK_LR, RVG_MATCH_LR)
+__RISCV_INSN_FUNCS(sc, RVG_MASK_SC, RVG_MATCH_SC)
/* special case to catch _any_ system instruction */
static __always_inline bool riscv_insn_is_system(u32 code)
diff --git a/arch/riscv/kernel/probes/decode-insn.c b/arch/riscv/kernel/probes/decode-insn.c
index 65d9590bfb..eae393ef58 100644
--- a/arch/riscv/kernel/probes/decode-insn.c
+++ b/arch/riscv/kernel/probes/decode-insn.c
@@ -23,6 +23,8 @@ riscv_probe_decode_insn(probe_opcode_t *addr, struct arch_probe_insn *api)
*/
RISCV_INSN_REJECTED(system, insn);
RISCV_INSN_REJECTED(fence, insn);
+ RISCV_INSN_REJECTED(lr, insn);
+ RISCV_INSN_REJECTED(sc, insn);
/*
* Simulate instructions list:
diff --git a/arch/riscv/kernel/probes/kprobes.c b/arch/riscv/kernel/probes/kprobes.c
index 9e2afabf94..e10c40b103 100644
--- a/arch/riscv/kernel/probes/kprobes.c
+++ b/arch/riscv/kernel/probes/kprobes.c
@@ -13,6 +13,7 @@
#include <asm/cacheflush.h>
#include <asm/bug.h>
#include <asm/text-patching.h>
+#include <asm/insn.h>
#include "decode-insn.h"
@@ -69,6 +70,53 @@ static bool __kprobes arch_check_kprobe(unsigned long addr)
return false;
}
+/*
+ * A trap taken in the middle of an LR/SC sequence clears the load
+ * reservation, so an SC following the probed instruction would always
+ * fail and the enclosing retry loop would re-enter the breakpoint.
+ * Reject probes inside such a sequence.
+ *
+ * A constrained LR/SC loop (Zalrsc) is limited to 16 instructions placed
+ * sequentially in memory (64 bytes in the base ISA), so scanning back
+ * that far covers every possible enclosing sequence.
+ */
+#define MAX_ATOMIC_CONTEXT_SIZE 64
+
+static bool __kprobes riscv_probe_insn_in_atomic(unsigned long addr)
+{
+ unsigned long tmp, offset, scan_start;
+ bool in_atomic = false;
+
+ if (!kallsyms_lookup_size_offset(addr, NULL, &offset))
+ return false;
+
+ tmp = addr - offset; /* function entry */
+
+ if (offset > MAX_ATOMIC_CONTEXT_SIZE)
+ scan_start = addr - MAX_ATOMIC_CONTEXT_SIZE;
+ else
+ scan_start = tmp;
+
+ /* advance to the scan window, keeping instruction alignment */
+ while (tmp < scan_start)
+ tmp += GET_INSN_LENGTH(*(u16 *)tmp);
+
+ /* scan the window, tracking whether an LR is still outstanding */
+ while (tmp < addr) {
+ if (GET_INSN_LENGTH(*(u16 *)tmp) == 4) {
+ u32 insn = *(u32 *)tmp;
+
+ if (riscv_insn_is_lr(insn))
+ in_atomic = true;
+ else if (riscv_insn_is_sc(insn))
+ in_atomic = false;
+ }
+ tmp += GET_INSN_LENGTH(*(u16 *)tmp);
+ }
+
+ return in_atomic;
+}
+
int __kprobes arch_prepare_kprobe(struct kprobe *p)
{
u16 *insn = (u16 *)p->addr;
@@ -79,6 +127,9 @@ int __kprobes arch_prepare_kprobe(struct kprobe *p)
if (!arch_check_kprobe((unsigned long)p->addr))
return -EILSEQ;
+ if (riscv_probe_insn_in_atomic((unsigned long)p->addr))
+ return -EINVAL;
+
/* copy instruction */
p->opcode = (kprobe_opcode_t)(*insn++);
if (GET_INSN_LENGTH(p->opcode) == 4)
--
2.43.0
_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [PATCH] riscv: probes: reject kprobes inside LR/SC sequences
2026-08-19 10:29 ` Xiaofeng Yuan
@ 2026-08-19 12:33 ` Nam Cao
-1 siblings, 0 replies; 4+ messages in thread
From: Nam Cao @ 2026-08-19 12:33 UTC (permalink / raw)
To: Xiaofeng Yuan, Paul Walmsley, Palmer Dabbelt, Albert Ou
Cc: linux-riscv, linux-kernel, yuanxiaofeng
Xiaofeng Yuan <yuanxiaofeng@eswincomputing.com> writes:
> +/*
> + * A trap taken in the middle of an LR/SC sequence clears the load
> + * reservation, so an SC following the probed instruction would always
> + * fail and the enclosing retry loop would re-enter the breakpoint.
> + * Reject probes inside such a sequence.
> + *
> + * A constrained LR/SC loop (Zalrsc) is limited to 16 instructions placed
> + * sequentially in memory (64 bytes in the base ISA), so scanning back
> + * that far covers every possible enclosing sequence.
> + */
> +#define MAX_ATOMIC_CONTEXT_SIZE 64
What about C extension? Does this 64 still work?
> +
> +static bool __kprobes riscv_probe_insn_in_atomic(unsigned long addr)
> +{
> + unsigned long tmp, offset, scan_start;
> + bool in_atomic = false;
> +
> + if (!kallsyms_lookup_size_offset(addr, NULL, &offset))
> + return false;
> +
> + tmp = addr - offset; /* function entry */
> +
> + if (offset > MAX_ATOMIC_CONTEXT_SIZE)
> + scan_start = addr - MAX_ATOMIC_CONTEXT_SIZE;
What guarantees that 'scan_start' points to the beginning of an instruction?
> + else
> + scan_start = tmp;
> +
> + /* advance to the scan window, keeping instruction alignment */
> + while (tmp < scan_start)
> + tmp += GET_INSN_LENGTH(*(u16 *)tmp);
> +
> + /* scan the window, tracking whether an LR is still outstanding */
> + while (tmp < addr) {
> + if (GET_INSN_LENGTH(*(u16 *)tmp) == 4) {
Why is tmp casted to (u16 *)? An instruction can be 32 bits.
It still works, I think, but looks confusing.
> + u32 insn = *(u32 *)tmp;
Reuse this insn for the GET_INSN_LENGTH() above?
Nam
_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] riscv: probes: reject kprobes inside LR/SC sequences
@ 2026-08-19 12:33 ` Nam Cao
0 siblings, 0 replies; 4+ messages in thread
From: Nam Cao @ 2026-08-19 12:33 UTC (permalink / raw)
To: Xiaofeng Yuan, Paul Walmsley, Palmer Dabbelt, Albert Ou
Cc: linux-riscv, linux-kernel, yuanxiaofeng
Xiaofeng Yuan <yuanxiaofeng@eswincomputing.com> writes:
> +/*
> + * A trap taken in the middle of an LR/SC sequence clears the load
> + * reservation, so an SC following the probed instruction would always
> + * fail and the enclosing retry loop would re-enter the breakpoint.
> + * Reject probes inside such a sequence.
> + *
> + * A constrained LR/SC loop (Zalrsc) is limited to 16 instructions placed
> + * sequentially in memory (64 bytes in the base ISA), so scanning back
> + * that far covers every possible enclosing sequence.
> + */
> +#define MAX_ATOMIC_CONTEXT_SIZE 64
What about C extension? Does this 64 still work?
> +
> +static bool __kprobes riscv_probe_insn_in_atomic(unsigned long addr)
> +{
> + unsigned long tmp, offset, scan_start;
> + bool in_atomic = false;
> +
> + if (!kallsyms_lookup_size_offset(addr, NULL, &offset))
> + return false;
> +
> + tmp = addr - offset; /* function entry */
> +
> + if (offset > MAX_ATOMIC_CONTEXT_SIZE)
> + scan_start = addr - MAX_ATOMIC_CONTEXT_SIZE;
What guarantees that 'scan_start' points to the beginning of an instruction?
> + else
> + scan_start = tmp;
> +
> + /* advance to the scan window, keeping instruction alignment */
> + while (tmp < scan_start)
> + tmp += GET_INSN_LENGTH(*(u16 *)tmp);
> +
> + /* scan the window, tracking whether an LR is still outstanding */
> + while (tmp < addr) {
> + if (GET_INSN_LENGTH(*(u16 *)tmp) == 4) {
Why is tmp casted to (u16 *)? An instruction can be 32 bits.
It still works, I think, but looks confusing.
> + u32 insn = *(u32 *)tmp;
Reuse this insn for the GET_INSN_LENGTH() above?
Nam
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2026-08-19 12:34 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-08-19 10:29 [PATCH] riscv: probes: reject kprobes inside LR/SC sequences Xiaofeng Yuan
2026-08-19 10:29 ` Xiaofeng Yuan
2026-08-19 12:33 ` Nam Cao
2026-08-19 12:33 ` Nam Cao
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.