LoongArch: Add kprobes support
authorTiezhu Yang <yangtiezhu@loongson.cn>
Sat, 25 Feb 2023 07:52:57 +0000 (15:52 +0800)
committerHuacai Chen <chenhuacai@loongson.cn>
Sat, 25 Feb 2023 14:12:17 +0000 (22:12 +0800)
Kprobes allows you to trap at almost any kernel address and execute a
callback function, this commit adds kprobes support for LoongArch.

Tested-by: Jeff Xie <xiehuan09@gmail.com>
Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>
Signed-off-by: Huacai Chen <chenhuacai@loongson.cn>
arch/loongarch/Kconfig
arch/loongarch/include/asm/inst.h
arch/loongarch/include/asm/kprobes.h [new file with mode: 0644]
arch/loongarch/kernel/Makefile
arch/loongarch/kernel/kprobes.c [new file with mode: 0644]
arch/loongarch/kernel/traps.c
arch/loongarch/mm/fault.c

index 277ce9b9414e4a9d1707d1bc76c5a90ad3fb08c3..bb538b68116dc0afd2be361ed5ad621c9337fd86 100644 (file)
@@ -106,6 +106,7 @@ config LOONGARCH
        select HAVE_IOREMAP_PROT
        select HAVE_IRQ_EXIT_ON_IRQ_STACK
        select HAVE_IRQ_TIME_ACCOUNTING
+       select HAVE_KPROBES
        select HAVE_MOD_ARCH_SPECIFIC
        select HAVE_NMI
        select HAVE_PCI
index 3ade9ff2bb8ff3bfd4d7fd718c94846126fdcd5f..a04fe755d71932d298189b608f8d786fd3c6edef 100644 (file)
 
 #define ADDR_IMM(addr, INSN)   ((addr & ADDR_IMMMASK_##INSN) >> ADDR_IMMSHIFT_##INSN)
 
+enum reg0i15_op {
+       break_op        = 0x54,
+};
+
 enum reg0i26_op {
        b_op            = 0x14,
        bl_op           = 0x15,
@@ -180,6 +184,11 @@ enum reg3sa2_op {
        alsld_op        = 0x16,
 };
 
+struct reg0i15_format {
+       unsigned int immediate : 15;
+       unsigned int opcode : 17;
+};
+
 struct reg0i26_format {
        unsigned int immediate_h : 10;
        unsigned int immediate_l : 16;
@@ -265,6 +274,7 @@ struct reg3sa2_format {
 
 union loongarch_instruction {
        unsigned int word;
+       struct reg0i15_format   reg0i15_format;
        struct reg0i26_format   reg0i26_format;
        struct reg1i20_format   reg1i20_format;
        struct reg1i21_format   reg1i21_format;
@@ -323,6 +333,11 @@ static inline bool is_imm_negative(unsigned long val, unsigned int bit)
        return val & (1UL << (bit - 1));
 }
 
+static inline bool is_break_ins(union loongarch_instruction *ip)
+{
+       return ip->reg0i15_format.opcode == break_op;
+}
+
 static inline bool is_pc_ins(union loongarch_instruction *ip)
 {
        return ip->reg1i20_format.opcode >= pcaddi_op &&
diff --git a/arch/loongarch/include/asm/kprobes.h b/arch/loongarch/include/asm/kprobes.h
new file mode 100644 (file)
index 0000000..7b9fc3e
--- /dev/null
@@ -0,0 +1,58 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+#ifndef __ASM_LOONGARCH_KPROBES_H
+#define __ASM_LOONGARCH_KPROBES_H
+
+#include <asm-generic/kprobes.h>
+
+#ifdef CONFIG_KPROBES
+
+#include <asm/inst.h>
+#include <asm/cacheflush.h>
+
+#define __ARCH_WANT_KPROBES_INSN_SLOT
+#define MAX_INSN_SIZE                  2
+
+#define flush_insn_slot(p)                                             \
+do {                                                                   \
+       if (p->addr)                                                    \
+               flush_icache_range((unsigned long)p->addr,              \
+                          (unsigned long)p->addr +                     \
+                          (MAX_INSN_SIZE * sizeof(kprobe_opcode_t)));  \
+} while (0)
+
+#define kretprobe_blacklist_size       0
+
+typedef union loongarch_instruction kprobe_opcode_t;
+
+/* Architecture specific copy of original instruction */
+struct arch_specific_insn {
+       /* copy of the original instruction */
+       kprobe_opcode_t *insn;
+       /* restore address after simulation */
+       unsigned long restore;
+};
+
+struct prev_kprobe {
+       struct kprobe *kp;
+       unsigned int status;
+};
+
+/* per-cpu kprobe control block */
+struct kprobe_ctlblk {
+       unsigned int kprobe_status;
+       unsigned long saved_status;
+       struct prev_kprobe prev_kprobe;
+};
+
+void arch_remove_kprobe(struct kprobe *p);
+bool kprobe_fault_handler(struct pt_regs *regs, int trapnr);
+bool kprobe_breakpoint_handler(struct pt_regs *regs);
+bool kprobe_singlestep_handler(struct pt_regs *regs);
+
+#else /* !CONFIG_KPROBES */
+
+static inline bool kprobe_breakpoint_handler(struct pt_regs *regs) { return false; }
+static inline bool kprobe_singlestep_handler(struct pt_regs *regs) { return false; }
+
+#endif /* CONFIG_KPROBES */
+#endif /* __ASM_LOONGARCH_KPROBES_H */
index bbb6b047f5db73de21e1fdca4f5312bc9bac8991..0a2f546216c0f747a855b8614c78160ade12c924 100644 (file)
@@ -52,4 +52,6 @@ obj-$(CONFIG_UNWINDER_PROLOGUE) += unwind_prologue.o
 obj-$(CONFIG_PERF_EVENTS)      += perf_event.o perf_regs.o
 obj-$(CONFIG_HAVE_HW_BREAKPOINT)       += hw_breakpoint.o
 
+obj-$(CONFIG_KPROBES)          += kprobes.o
+
 CPPFLAGS_vmlinux.lds           := $(KBUILD_CFLAGS)
diff --git a/arch/loongarch/kernel/kprobes.c b/arch/loongarch/kernel/kprobes.c
new file mode 100644 (file)
index 0000000..73eddd7
--- /dev/null
@@ -0,0 +1,379 @@
+// SPDX-License-Identifier: GPL-2.0-only
+#include <linux/kdebug.h>
+#include <linux/kprobes.h>
+#include <linux/preempt.h>
+#include <asm/break.h>
+
+static const union loongarch_instruction breakpoint_insn = {
+       .reg0i15_format = {
+               .opcode = break_op,
+               .immediate = BRK_KPROBE_BP,
+       }
+};
+
+static const union loongarch_instruction singlestep_insn = {
+       .reg0i15_format = {
+               .opcode = break_op,
+               .immediate = BRK_KPROBE_SSTEPBP,
+       }
+};
+
+DEFINE_PER_CPU(struct kprobe *, current_kprobe);
+DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
+
+static bool insns_not_supported(union loongarch_instruction insn)
+{
+       switch (insn.reg2i14_format.opcode) {
+       case llw_op:
+       case lld_op:
+       case scw_op:
+       case scd_op:
+               pr_notice("kprobe: ll and sc instructions are not supported\n");
+               return true;
+       }
+
+       switch (insn.reg1i21_format.opcode) {
+       case bceqz_op:
+               pr_notice("kprobe: bceqz and bcnez instructions are not supported\n");
+               return true;
+       }
+
+       return false;
+}
+NOKPROBE_SYMBOL(insns_not_supported);
+
+static bool insns_need_simulation(struct kprobe *p)
+{
+       if (is_pc_ins(&p->opcode))
+               return true;
+
+       if (is_branch_ins(&p->opcode))
+               return true;
+
+       return false;
+}
+NOKPROBE_SYMBOL(insns_need_simulation);
+
+static void arch_simulate_insn(struct kprobe *p, struct pt_regs *regs)
+{
+       if (is_pc_ins(&p->opcode))
+               simu_pc(regs, p->opcode);
+       else if (is_branch_ins(&p->opcode))
+               simu_branch(regs, p->opcode);
+}
+NOKPROBE_SYMBOL(arch_simulate_insn);
+
+static void arch_prepare_ss_slot(struct kprobe *p)
+{
+       p->ainsn.insn[0] = *p->addr;
+       p->ainsn.insn[1] = singlestep_insn;
+       p->ainsn.restore = (unsigned long)p->addr + LOONGARCH_INSN_SIZE;
+}
+NOKPROBE_SYMBOL(arch_prepare_ss_slot);
+
+static void arch_prepare_simulate(struct kprobe *p)
+{
+       p->ainsn.restore = 0;
+}
+NOKPROBE_SYMBOL(arch_prepare_simulate);
+
+int arch_prepare_kprobe(struct kprobe *p)
+{
+       if ((unsigned long)p->addr & 0x3)
+               return -EILSEQ;
+
+       /* copy instruction */
+       p->opcode = *p->addr;
+
+       /* decode instruction */
+       if (insns_not_supported(p->opcode))
+               return -EINVAL;
+
+       if (insns_need_simulation(p)) {
+               p->ainsn.insn = NULL;
+       } else {
+               p->ainsn.insn = get_insn_slot();
+               if (!p->ainsn.insn)
+                       return -ENOMEM;
+       }
+
+       /* prepare the instruction */
+       if (p->ainsn.insn)
+               arch_prepare_ss_slot(p);
+       else
+               arch_prepare_simulate(p);
+
+       return 0;
+}
+NOKPROBE_SYMBOL(arch_prepare_kprobe);
+
+/* Install breakpoint in text */
+void arch_arm_kprobe(struct kprobe *p)
+{
+       *p->addr = breakpoint_insn;
+       flush_insn_slot(p);
+}
+NOKPROBE_SYMBOL(arch_arm_kprobe);
+
+/* Remove breakpoint from text */
+void arch_disarm_kprobe(struct kprobe *p)
+{
+       *p->addr = p->opcode;
+       flush_insn_slot(p);
+}
+NOKPROBE_SYMBOL(arch_disarm_kprobe);
+
+void arch_remove_kprobe(struct kprobe *p)
+{
+       if (p->ainsn.insn) {
+               free_insn_slot(p->ainsn.insn, 0);
+               p->ainsn.insn = NULL;
+       }
+}
+NOKPROBE_SYMBOL(arch_remove_kprobe);
+
+static void save_previous_kprobe(struct kprobe_ctlblk *kcb)
+{
+       kcb->prev_kprobe.kp = kprobe_running();
+       kcb->prev_kprobe.status = kcb->kprobe_status;
+}
+NOKPROBE_SYMBOL(save_previous_kprobe);
+
+static void restore_previous_kprobe(struct kprobe_ctlblk *kcb)
+{
+       __this_cpu_write(current_kprobe, kcb->prev_kprobe.kp);
+       kcb->kprobe_status = kcb->prev_kprobe.status;
+}
+NOKPROBE_SYMBOL(restore_previous_kprobe);
+
+static void set_current_kprobe(struct kprobe *p)
+{
+       __this_cpu_write(current_kprobe, p);
+}
+NOKPROBE_SYMBOL(set_current_kprobe);
+
+/*
+ * Interrupts need to be disabled before single-step mode is set,
+ * and not reenabled until after single-step mode ends.
+ * Without disabling interrupt on local CPU, there is a chance of
+ * interrupt occurrence in the period of exception return and start
+ * of out-of-line single-step, that result in wrongly single stepping
+ * into the interrupt handler.
+ */
+static void save_local_irqflag(struct kprobe_ctlblk *kcb,
+                              struct pt_regs *regs)
+{
+       kcb->saved_status = regs->csr_prmd;
+       regs->csr_prmd &= ~CSR_PRMD_PIE;
+}
+NOKPROBE_SYMBOL(save_local_irqflag);
+
+static void restore_local_irqflag(struct kprobe_ctlblk *kcb,
+                                 struct pt_regs *regs)
+{
+       regs->csr_prmd = kcb->saved_status;
+}
+NOKPROBE_SYMBOL(restore_local_irqflag);
+
+static void post_kprobe_handler(struct kprobe *cur, struct kprobe_ctlblk *kcb,
+                               struct pt_regs *regs)
+{
+       /* return addr restore if non-branching insn */
+       if (cur->ainsn.restore != 0)
+               instruction_pointer_set(regs, cur->ainsn.restore);
+
+       /* restore back original saved kprobe variables and continue */
+       if (kcb->kprobe_status == KPROBE_REENTER) {
+               restore_previous_kprobe(kcb);
+               preempt_enable_no_resched();
+               return;
+       }
+
+       /*
+        * update the kcb status even if the cur->post_handler is
+        * not set because reset_curent_kprobe() doesn't update kcb.
+        */
+       kcb->kprobe_status = KPROBE_HIT_SSDONE;
+       if (cur->post_handler)
+               cur->post_handler(cur, regs, 0);
+
+       reset_current_kprobe();
+       preempt_enable_no_resched();
+}
+NOKPROBE_SYMBOL(post_kprobe_handler);
+
+static void setup_singlestep(struct kprobe *p, struct pt_regs *regs,
+                            struct kprobe_ctlblk *kcb, int reenter)
+{
+       if (reenter) {
+               save_previous_kprobe(kcb);
+               set_current_kprobe(p);
+               kcb->kprobe_status = KPROBE_REENTER;
+       } else {
+               kcb->kprobe_status = KPROBE_HIT_SS;
+       }
+
+       if (p->ainsn.insn) {
+               /* IRQs and single stepping do not mix well */
+               save_local_irqflag(kcb, regs);
+               /* set ip register to prepare for single stepping */
+               regs->csr_era = (unsigned long)p->ainsn.insn;
+       } else {
+               /* simulate single steping */
+               arch_simulate_insn(p, regs);
+               /* now go for post processing */
+               post_kprobe_handler(p, kcb, regs);
+       }
+}
+NOKPROBE_SYMBOL(setup_singlestep);
+
+static bool reenter_kprobe(struct kprobe *p, struct pt_regs *regs,
+                          struct kprobe_ctlblk *kcb)
+{
+       switch (kcb->kprobe_status) {
+       case KPROBE_HIT_SS:
+       case KPROBE_HIT_SSDONE:
+       case KPROBE_HIT_ACTIVE:
+               kprobes_inc_nmissed_count(p);
+               setup_singlestep(p, regs, kcb, 1);
+               break;
+       case KPROBE_REENTER:
+               pr_warn("Failed to recover from reentered kprobes.\n");
+               dump_kprobe(p);
+               WARN_ON_ONCE(1);
+               break;
+       default:
+               WARN_ON(1);
+               return false;
+       }
+
+       return true;
+}
+NOKPROBE_SYMBOL(reenter_kprobe);
+
+bool kprobe_breakpoint_handler(struct pt_regs *regs)
+{
+       struct kprobe_ctlblk *kcb;
+       struct kprobe *p, *cur_kprobe;
+       kprobe_opcode_t *addr = (kprobe_opcode_t *)regs->csr_era;
+
+       /*
+        * We don't want to be preempted for the entire
+        * duration of kprobe processing.
+        */
+       preempt_disable();
+       kcb = get_kprobe_ctlblk();
+       cur_kprobe = kprobe_running();
+
+       p = get_kprobe(addr);
+       if (p) {
+               if (cur_kprobe) {
+                       if (reenter_kprobe(p, regs, kcb))
+                               return true;
+               } else {
+                       /* Probe hit */
+                       set_current_kprobe(p);
+                       kcb->kprobe_status = KPROBE_HIT_ACTIVE;
+
+                       /*
+                        * If we have no pre-handler or it returned 0, we
+                        * continue with normal processing.  If we have a
+                        * pre-handler and it returned non-zero, it will
+                        * modify the execution path and no need to single
+                        * stepping. Let's just reset current kprobe and exit.
+                        *
+                        * pre_handler can hit a breakpoint and can step thru
+                        * before return.
+                        */
+                       if (!p->pre_handler || !p->pre_handler(p, regs)) {
+                               setup_singlestep(p, regs, kcb, 0);
+                       } else {
+                               reset_current_kprobe();
+                               preempt_enable_no_resched();
+                       }
+                       return true;
+               }
+       }
+
+       if (addr->word != breakpoint_insn.word) {
+               /*
+                * The breakpoint instruction was removed right
+                * after we hit it.  Another cpu has removed
+                * either a probepoint or a debugger breakpoint
+                * at this address.  In either case, no further
+                * handling of this interrupt is appropriate.
+                * Return back to original instruction, and continue.
+                */
+               regs->csr_era = (unsigned long)addr;
+               preempt_enable_no_resched();
+               return true;
+       }
+
+       preempt_enable_no_resched();
+       return false;
+}
+NOKPROBE_SYMBOL(kprobe_breakpoint_handler);
+
+bool kprobe_singlestep_handler(struct pt_regs *regs)
+{
+       struct kprobe *cur = kprobe_running();
+       struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
+       unsigned long addr = instruction_pointer(regs);
+
+       if (cur && (kcb->kprobe_status & (KPROBE_HIT_SS | KPROBE_REENTER)) &&
+           ((unsigned long)&cur->ainsn.insn[1] == addr)) {
+               restore_local_irqflag(kcb, regs);
+               post_kprobe_handler(cur, kcb, regs);
+               return true;
+       }
+
+       preempt_enable_no_resched();
+       return false;
+}
+NOKPROBE_SYMBOL(kprobe_singlestep_handler);
+
+bool kprobe_fault_handler(struct pt_regs *regs, int trapnr)
+{
+       struct kprobe *cur = kprobe_running();
+       struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
+
+       switch (kcb->kprobe_status) {
+       case KPROBE_HIT_SS:
+       case KPROBE_REENTER:
+               /*
+                * We are here because the instruction being single
+                * stepped caused a page fault. We reset the current
+                * kprobe and the ip points back to the probe address
+                * and allow the page fault handler to continue as a
+                * normal page fault.
+                */
+               regs->csr_era = (unsigned long)cur->addr;
+               WARN_ON_ONCE(!instruction_pointer(regs));
+
+               if (kcb->kprobe_status == KPROBE_REENTER) {
+                       restore_previous_kprobe(kcb);
+               } else {
+                       restore_local_irqflag(kcb, regs);
+                       reset_current_kprobe();
+               }
+               preempt_enable_no_resched();
+               break;
+       }
+       return false;
+}
+NOKPROBE_SYMBOL(kprobe_fault_handler);
+
+/*
+ * Provide a blacklist of symbols identifying ranges which cannot be kprobed.
+ * This blacklist is exposed to userspace via debugfs (kprobes/blacklist).
+ */
+int __init arch_populate_kprobe_blacklist(void)
+{
+       return kprobe_add_area_blacklist((unsigned long)__irqentry_text_start,
+                                        (unsigned long)__irqentry_text_end);
+}
+
+int __init arch_init_kprobes(void)
+{
+       return 0;
+}
index 1d47747e2154a5af8075c51559dbb3de32a13762..de8ebe20b666cf5934751801e615f6f16ea21f4a 100644 (file)
@@ -437,7 +437,9 @@ asmlinkage void noinstr do_bp(struct pt_regs *regs)
        unsigned long era = exception_era(regs);
        irqentry_state_t state = irqentry_enter(regs);
 
-       local_irq_enable();
+       if (regs->csr_prmd & CSR_PRMD_PIE)
+               local_irq_enable();
+
        current->thread.trap_nr = read_csr_excode();
        if (__get_inst(&opcode, (u32 *)era, user))
                goto out_sigsegv;
@@ -450,14 +452,12 @@ asmlinkage void noinstr do_bp(struct pt_regs *regs)
         */
        switch (bcode) {
        case BRK_KPROBE_BP:
-               if (notify_die(DIE_BREAK, "Kprobe", regs, bcode,
-                              current->thread.trap_nr, SIGTRAP) == NOTIFY_STOP)
+               if (kprobe_breakpoint_handler(regs))
                        goto out;
                else
                        break;
        case BRK_KPROBE_SSTEPBP:
-               if (notify_die(DIE_SSTEPBP, "Kprobe_SingleStep", regs, bcode,
-                              current->thread.trap_nr, SIGTRAP) == NOTIFY_STOP)
+               if (kprobe_singlestep_handler(regs))
                        goto out;
                else
                        break;
@@ -500,7 +500,9 @@ asmlinkage void noinstr do_bp(struct pt_regs *regs)
        }
 
 out:
-       local_irq_disable();
+       if (regs->csr_prmd & CSR_PRMD_PIE)
+               local_irq_disable();
+
        irqentry_exit(regs, state);
        return;
 
index 1ccd53655cab097f02ed09a5c1bd566de38d01ec..449087bd589d339dba1b27f66cc07f170085cff7 100644 (file)
@@ -135,6 +135,9 @@ static void __kprobes __do_page_fault(struct pt_regs *regs,
        struct vm_area_struct *vma = NULL;
        vm_fault_t fault;
 
+       if (kprobe_page_fault(regs, current->thread.trap_nr))
+               return;
+
        /*
         * We fault-in kernel-space virtual memory on-demand. The
         * 'reference' page table is init_mm.pgd.