1 // SPDX-License-Identifier: GPL-2.0-only
3 * LoongArch KGDB support
5 * Copyright (C) 2023 Loongson Technology Corporation Limited
8 #include <linux/hw_breakpoint.h>
9 #include <linux/kdebug.h>
10 #include <linux/kgdb.h>
11 #include <linux/processor.h>
12 #include <linux/ptrace.h>
13 #include <linux/sched.h>
14 #include <linux/smp.h>
16 #include <asm/cacheflush.h>
18 #include <asm/hw_breakpoint.h>
20 #include <asm/irq_regs.h>
21 #include <asm/ptrace.h>
22 #include <asm/sigcontext.h>
24 int kgdb_watch_activated;
25 static unsigned int stepped_opcode;
26 static unsigned long stepped_address;
28 struct dbg_reg_def_t dbg_reg_def[DBG_MAX_REG_NUM] = {
29 { "r0", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[0]) },
30 { "r1", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[1]) },
31 { "r2", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[2]) },
32 { "r3", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[3]) },
33 { "r4", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[4]) },
34 { "r5", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[5]) },
35 { "r6", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[6]) },
36 { "r7", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[7]) },
37 { "r8", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[8]) },
38 { "r9", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[9]) },
39 { "r10", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[10]) },
40 { "r11", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[11]) },
41 { "r12", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[12]) },
42 { "r13", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[13]) },
43 { "r14", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[14]) },
44 { "r15", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[15]) },
45 { "r16", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[16]) },
46 { "r17", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[17]) },
47 { "r18", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[18]) },
48 { "r19", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[19]) },
49 { "r20", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[20]) },
50 { "r21", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[21]) },
51 { "r22", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[22]) },
52 { "r23", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[23]) },
53 { "r24", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[24]) },
54 { "r25", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[25]) },
55 { "r26", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[26]) },
56 { "r27", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[27]) },
57 { "r28", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[28]) },
58 { "r29", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[29]) },
59 { "r30", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[30]) },
60 { "r31", GDB_SIZEOF_REG, offsetof(struct pt_regs, regs[31]) },
61 { "orig_a0", GDB_SIZEOF_REG, offsetof(struct pt_regs, orig_a0) },
62 { "pc", GDB_SIZEOF_REG, offsetof(struct pt_regs, csr_era) },
63 { "badv", GDB_SIZEOF_REG, offsetof(struct pt_regs, csr_badvaddr) },
64 { "f0", GDB_SIZEOF_REG, 0 },
65 { "f1", GDB_SIZEOF_REG, 1 },
66 { "f2", GDB_SIZEOF_REG, 2 },
67 { "f3", GDB_SIZEOF_REG, 3 },
68 { "f4", GDB_SIZEOF_REG, 4 },
69 { "f5", GDB_SIZEOF_REG, 5 },
70 { "f6", GDB_SIZEOF_REG, 6 },
71 { "f7", GDB_SIZEOF_REG, 7 },
72 { "f8", GDB_SIZEOF_REG, 8 },
73 { "f9", GDB_SIZEOF_REG, 9 },
74 { "f10", GDB_SIZEOF_REG, 10 },
75 { "f11", GDB_SIZEOF_REG, 11 },
76 { "f12", GDB_SIZEOF_REG, 12 },
77 { "f13", GDB_SIZEOF_REG, 13 },
78 { "f14", GDB_SIZEOF_REG, 14 },
79 { "f15", GDB_SIZEOF_REG, 15 },
80 { "f16", GDB_SIZEOF_REG, 16 },
81 { "f17", GDB_SIZEOF_REG, 17 },
82 { "f18", GDB_SIZEOF_REG, 18 },
83 { "f19", GDB_SIZEOF_REG, 19 },
84 { "f20", GDB_SIZEOF_REG, 20 },
85 { "f21", GDB_SIZEOF_REG, 21 },
86 { "f22", GDB_SIZEOF_REG, 22 },
87 { "f23", GDB_SIZEOF_REG, 23 },
88 { "f24", GDB_SIZEOF_REG, 24 },
89 { "f25", GDB_SIZEOF_REG, 25 },
90 { "f26", GDB_SIZEOF_REG, 26 },
91 { "f27", GDB_SIZEOF_REG, 27 },
92 { "f28", GDB_SIZEOF_REG, 28 },
93 { "f29", GDB_SIZEOF_REG, 29 },
94 { "f30", GDB_SIZEOF_REG, 30 },
95 { "f31", GDB_SIZEOF_REG, 31 },
107 char *dbg_get_reg(int regno, void *mem, struct pt_regs *regs)
109 int reg_offset, reg_size;
111 if (regno < 0 || regno >= DBG_MAX_REG_NUM)
114 reg_offset = dbg_reg_def[regno].offset;
115 reg_size = dbg_reg_def[regno].size;
117 if (reg_offset == -1)
120 /* Handle general-purpose/orig_a0/pc/badv registers */
121 if (regno <= DBG_PT_REGS_END) {
122 memcpy(mem, (void *)regs + reg_offset, reg_size);
126 if (!(regs->csr_euen & CSR_EUEN_FPEN))
131 /* Handle FP registers */
133 case DBG_FCSR: /* Process the fcsr */
134 memcpy(mem, (void *)¤t->thread.fpu.fcsr, reg_size);
136 case DBG_FCC_BASE ... DBG_FCC_END: /* Process the fcc */
137 memcpy(mem, (void *)¤t->thread.fpu.fcc + reg_offset, reg_size);
139 case DBG_FPR_BASE ... DBG_FPR_END: /* Process the fpr */
140 memcpy(mem, (void *)¤t->thread.fpu.fpr[reg_offset], reg_size);
147 return dbg_reg_def[regno].name;
150 int dbg_set_reg(int regno, void *mem, struct pt_regs *regs)
152 int reg_offset, reg_size;
154 if (regno < 0 || regno >= DBG_MAX_REG_NUM)
157 reg_offset = dbg_reg_def[regno].offset;
158 reg_size = dbg_reg_def[regno].size;
160 if (reg_offset == -1)
163 /* Handle general-purpose/orig_a0/pc/badv registers */
164 if (regno <= DBG_PT_REGS_END) {
165 memcpy((void *)regs + reg_offset, mem, reg_size);
169 if (!(regs->csr_euen & CSR_EUEN_FPEN))
172 /* Handle FP registers */
174 case DBG_FCSR: /* Process the fcsr */
175 memcpy((void *)¤t->thread.fpu.fcsr, mem, reg_size);
177 case DBG_FCC_BASE ... DBG_FCC_END: /* Process the fcc */
178 memcpy((void *)¤t->thread.fpu.fcc + reg_offset, mem, reg_size);
180 case DBG_FPR_BASE ... DBG_FPR_END: /* Process the fpr */
181 memcpy((void *)¤t->thread.fpu.fpr[reg_offset], mem, reg_size);
193 * Similar to regs_to_gdb_regs() except that process is sleeping and so
194 * we may not be able to get all the info.
196 void sleeping_thread_to_gdb_regs(unsigned long *gdb_regs, struct task_struct *p)
198 /* Initialize to zero */
199 memset((char *)gdb_regs, 0, NUMREGBYTES);
201 gdb_regs[DBG_LOONGARCH_RA] = p->thread.reg01;
202 gdb_regs[DBG_LOONGARCH_TP] = (long)p;
203 gdb_regs[DBG_LOONGARCH_SP] = p->thread.reg03;
206 gdb_regs[DBG_LOONGARCH_S0] = p->thread.reg23;
207 gdb_regs[DBG_LOONGARCH_S1] = p->thread.reg24;
208 gdb_regs[DBG_LOONGARCH_S2] = p->thread.reg25;
209 gdb_regs[DBG_LOONGARCH_S3] = p->thread.reg26;
210 gdb_regs[DBG_LOONGARCH_S4] = p->thread.reg27;
211 gdb_regs[DBG_LOONGARCH_S5] = p->thread.reg28;
212 gdb_regs[DBG_LOONGARCH_S6] = p->thread.reg29;
213 gdb_regs[DBG_LOONGARCH_S7] = p->thread.reg30;
214 gdb_regs[DBG_LOONGARCH_S8] = p->thread.reg31;
217 * PC use return address (RA), i.e. the moment after return from __switch_to()
219 gdb_regs[DBG_LOONGARCH_PC] = p->thread.reg01;
222 void kgdb_arch_set_pc(struct pt_regs *regs, unsigned long pc)
227 void arch_kgdb_breakpoint(void)
229 __asm__ __volatile__ ( \
230 ".globl kgdb_breakinst\n\t" \
232 "kgdb_breakinst:\tbreak 2\n\t"); /* BRK_KDB = 2 */
236 * Calls linux_debug_hook before the kernel dies. If KGDB is enabled,
237 * then try to fall into the debugger
239 static int kgdb_loongarch_notify(struct notifier_block *self, unsigned long cmd, void *ptr)
241 struct die_args *args = (struct die_args *)ptr;
242 struct pt_regs *regs = args->regs;
244 /* Userspace events, ignore. */
248 if (!kgdb_io_module_registered)
251 if (atomic_read(&kgdb_active) != -1)
252 kgdb_nmicallback(smp_processor_id(), regs);
254 if (kgdb_handle_exception(args->trapnr, args->signr, cmd, regs))
257 if (atomic_read(&kgdb_setting_breakpoint))
258 if (regs->csr_era == (unsigned long)&kgdb_breakinst)
259 regs->csr_era += LOONGARCH_INSN_SIZE;
264 bool kgdb_breakpoint_handler(struct pt_regs *regs)
266 struct die_args args = {
270 .trapnr = read_csr_excode(),
275 return (kgdb_loongarch_notify(NULL, DIE_TRAP, &args) == NOTIFY_STOP) ? true : false;
278 static struct notifier_block kgdb_notifier = {
279 .notifier_call = kgdb_loongarch_notify,
282 static inline void kgdb_arch_update_addr(struct pt_regs *regs,
283 char *remcom_in_buffer)
288 ptr = &remcom_in_buffer[1];
289 if (kgdb_hex2long(&ptr, &addr))
290 regs->csr_era = addr;
293 /* Calculate the new address for after a step */
294 static int get_step_address(struct pt_regs *regs, unsigned long *next_addr)
297 unsigned int si, si_l, si_h, rd, rj, cj;
298 unsigned long pc = instruction_pointer(regs);
299 union loongarch_instruction *ip = (union loongarch_instruction *)pc;
302 pr_warn("%s: invalid pc 0x%lx\n", __func__, pc);
306 *next_addr = pc + LOONGARCH_INSN_SIZE;
308 si_h = ip->reg0i26_format.immediate_h;
309 si_l = ip->reg0i26_format.immediate_l;
310 switch (ip->reg0i26_format.opcode) {
312 *next_addr = pc + sign_extend64((si_h << 16 | si_l) << 2, 27);
315 *next_addr = pc + sign_extend64((si_h << 16 | si_l) << 2, 27);
316 regs->regs[1] = pc + LOONGARCH_INSN_SIZE;
320 rj = ip->reg1i21_format.rj;
321 cj = (rj & 0x07) + DBG_FCC_BASE;
322 si_l = ip->reg1i21_format.immediate_l;
323 si_h = ip->reg1i21_format.immediate_h;
324 dbg_get_reg(cj, &cj_val, regs);
325 switch (ip->reg1i21_format.opcode) {
327 if (regs->regs[rj] == 0)
328 *next_addr = pc + sign_extend64((si_h << 16 | si_l) << 2, 22);
331 if (regs->regs[rj] != 0)
332 *next_addr = pc + sign_extend64((si_h << 16 | si_l) << 2, 22);
334 case bceqz_op: /* bceqz_op = bcnez_op */
335 if (((rj & 0x18) == 0x00) && !cj_val) /* bceqz */
336 *next_addr = pc + sign_extend64((si_h << 16 | si_l) << 2, 22);
337 if (((rj & 0x18) == 0x08) && cj_val) /* bcnez */
338 *next_addr = pc + sign_extend64((si_h << 16 | si_l) << 2, 22);
342 rj = ip->reg2i16_format.rj;
343 rd = ip->reg2i16_format.rd;
344 si = ip->reg2i16_format.immediate;
345 switch (ip->reg2i16_format.opcode) {
347 if (regs->regs[rj] == regs->regs[rd])
348 *next_addr = pc + sign_extend64(si << 2, 17);
351 if (regs->regs[rj] != regs->regs[rd])
352 *next_addr = pc + sign_extend64(si << 2, 17);
355 if ((long)regs->regs[rj] < (long)regs->regs[rd])
356 *next_addr = pc + sign_extend64(si << 2, 17);
359 if ((long)regs->regs[rj] >= (long)regs->regs[rd])
360 *next_addr = pc + sign_extend64(si << 2, 17);
363 if (regs->regs[rj] < regs->regs[rd])
364 *next_addr = pc + sign_extend64(si << 2, 17);
367 if (regs->regs[rj] >= regs->regs[rd])
368 *next_addr = pc + sign_extend64(si << 2, 17);
371 regs->regs[rd] = pc + LOONGARCH_INSN_SIZE;
372 *next_addr = regs->regs[rj] + sign_extend64(si << 2, 17);
379 static int do_single_step(struct pt_regs *regs)
382 unsigned long addr = 0; /* Determine where the target instruction will send us to */
384 error = get_step_address(regs, &addr);
388 /* Store the opcode in the stepped address */
389 error = get_kernel_nofault(stepped_opcode, (void *)addr);
393 stepped_address = addr;
395 /* Replace the opcode with the break instruction */
396 error = copy_to_kernel_nofault((void *)stepped_address,
397 arch_kgdb_ops.gdb_bpt_instr, BREAK_INSTR_SIZE);
398 flush_icache_range(addr, addr + BREAK_INSTR_SIZE);
404 kgdb_single_step = 1;
405 atomic_set(&kgdb_cpu_doing_single_step, raw_smp_processor_id());
411 /* Undo a single step */
412 static void undo_single_step(struct pt_regs *regs)
414 if (stepped_opcode) {
415 copy_to_kernel_nofault((void *)stepped_address,
416 (void *)&stepped_opcode, BREAK_INSTR_SIZE);
417 flush_icache_range(stepped_address, stepped_address + BREAK_INSTR_SIZE);
422 kgdb_single_step = 0;
423 atomic_set(&kgdb_cpu_doing_single_step, -1);
426 int kgdb_arch_handle_exception(int vector, int signo, int err_code,
427 char *remcom_in_buffer, char *remcom_out_buffer,
428 struct pt_regs *regs)
432 undo_single_step(regs);
433 regs->csr_prmd |= CSR_PRMD_PWE;
435 switch (remcom_in_buffer[0]) {
438 regs->csr_prmd &= ~CSR_PRMD_PWE;
441 kgdb_arch_update_addr(regs, remcom_in_buffer);
444 kgdb_arch_update_addr(regs, remcom_in_buffer);
445 ret = do_single_step(regs);
454 static struct hw_breakpoint {
455 unsigned int enabled;
459 struct perf_event * __percpu *pev;
460 } breakinfo[LOONGARCH_MAX_BRP];
462 static int hw_break_reserve_slot(int breakno)
465 struct perf_event **pevent;
467 for_each_online_cpu(cpu) {
469 pevent = per_cpu_ptr(breakinfo[breakno].pev, cpu);
470 if (dbg_reserve_bp_slot(*pevent))
477 for_each_online_cpu(cpu) {
481 pevent = per_cpu_ptr(breakinfo[breakno].pev, cpu);
482 dbg_release_bp_slot(*pevent);
488 static int hw_break_release_slot(int breakno)
491 struct perf_event **pevent;
496 for_each_online_cpu(cpu) {
497 pevent = per_cpu_ptr(breakinfo[breakno].pev, cpu);
498 if (dbg_release_bp_slot(*pevent))
500 * The debugger is responsible for handing the retry on
509 static int kgdb_set_hw_break(unsigned long addr, int len, enum kgdb_bptype bptype)
513 for (i = 0; i < LOONGARCH_MAX_BRP; i++)
514 if (!breakinfo[i].enabled)
517 if (i == LOONGARCH_MAX_BRP)
521 case BP_HARDWARE_BREAKPOINT:
522 breakinfo[i].type = HW_BREAKPOINT_X;
524 case BP_READ_WATCHPOINT:
525 breakinfo[i].type = HW_BREAKPOINT_R;
527 case BP_WRITE_WATCHPOINT:
528 breakinfo[i].type = HW_BREAKPOINT_W;
530 case BP_ACCESS_WATCHPOINT:
531 breakinfo[i].type = HW_BREAKPOINT_RW;
539 breakinfo[i].len = HW_BREAKPOINT_LEN_1;
542 breakinfo[i].len = HW_BREAKPOINT_LEN_2;
545 breakinfo[i].len = HW_BREAKPOINT_LEN_4;
548 breakinfo[i].len = HW_BREAKPOINT_LEN_8;
554 breakinfo[i].addr = addr;
555 if (hw_break_reserve_slot(i)) {
556 breakinfo[i].addr = 0;
559 breakinfo[i].enabled = 1;
564 static int kgdb_remove_hw_break(unsigned long addr, int len, enum kgdb_bptype bptype)
568 for (i = 0; i < LOONGARCH_MAX_BRP; i++)
569 if (breakinfo[i].addr == addr && breakinfo[i].enabled)
572 if (i == LOONGARCH_MAX_BRP)
575 if (hw_break_release_slot(i)) {
576 pr_err("Cannot remove hw breakpoint at %lx\n", addr);
579 breakinfo[i].enabled = 0;
584 static void kgdb_disable_hw_break(struct pt_regs *regs)
587 int cpu = raw_smp_processor_id();
588 struct perf_event *bp;
590 for (i = 0; i < LOONGARCH_MAX_BRP; i++) {
591 if (!breakinfo[i].enabled)
594 bp = *per_cpu_ptr(breakinfo[i].pev, cpu);
595 if (bp->attr.disabled == 1)
598 arch_uninstall_hw_breakpoint(bp);
599 bp->attr.disabled = 1;
602 /* Disable hardware debugging while we are in kgdb */
603 csr_xchg32(0, CSR_CRMD_WE, LOONGARCH_CSR_CRMD);
606 static void kgdb_remove_all_hw_break(void)
609 int cpu = raw_smp_processor_id();
610 struct perf_event *bp;
612 for (i = 0; i < LOONGARCH_MAX_BRP; i++) {
613 if (!breakinfo[i].enabled)
616 bp = *per_cpu_ptr(breakinfo[i].pev, cpu);
617 if (!bp->attr.disabled) {
618 arch_uninstall_hw_breakpoint(bp);
619 bp->attr.disabled = 1;
623 if (hw_break_release_slot(i))
624 pr_err("KGDB: hw bpt remove failed %lx\n", breakinfo[i].addr);
625 breakinfo[i].enabled = 0;
628 csr_xchg32(0, CSR_CRMD_WE, LOONGARCH_CSR_CRMD);
629 kgdb_watch_activated = 0;
632 static void kgdb_correct_hw_break(void)
634 int i, activated = 0;
636 for (i = 0; i < LOONGARCH_MAX_BRP; i++) {
637 struct perf_event *bp;
639 int cpu = raw_smp_processor_id();
641 if (!breakinfo[i].enabled)
644 bp = *per_cpu_ptr(breakinfo[i].pev, cpu);
645 if (bp->attr.disabled != 1)
648 bp->attr.bp_addr = breakinfo[i].addr;
649 bp->attr.bp_len = breakinfo[i].len;
650 bp->attr.bp_type = breakinfo[i].type;
652 val = hw_breakpoint_arch_parse(bp, &bp->attr, counter_arch_bp(bp));
656 val = arch_install_hw_breakpoint(bp);
658 bp->attr.disabled = 0;
662 csr_xchg32(activated ? CSR_CRMD_WE : 0, CSR_CRMD_WE, LOONGARCH_CSR_CRMD);
663 kgdb_watch_activated = activated;
666 const struct kgdb_arch arch_kgdb_ops = {
667 .gdb_bpt_instr = {0x02, 0x00, break_op >> 1, 0x00}, /* BRK_KDB = 2 */
668 .flags = KGDB_HW_BREAKPOINT,
669 .set_hw_breakpoint = kgdb_set_hw_break,
670 .remove_hw_breakpoint = kgdb_remove_hw_break,
671 .disable_hw_break = kgdb_disable_hw_break,
672 .remove_all_hw_break = kgdb_remove_all_hw_break,
673 .correct_hw_break = kgdb_correct_hw_break,
676 int kgdb_arch_init(void)
678 return register_die_notifier(&kgdb_notifier);
681 void kgdb_arch_late(void)
684 struct perf_event_attr attr;
685 struct perf_event **pevent;
687 hw_breakpoint_init(&attr);
689 attr.bp_addr = (unsigned long)kgdb_arch_init;
690 attr.bp_len = HW_BREAKPOINT_LEN_4;
691 attr.bp_type = HW_BREAKPOINT_W;
694 for (i = 0; i < LOONGARCH_MAX_BRP; i++) {
695 if (breakinfo[i].pev)
698 breakinfo[i].pev = register_wide_hw_breakpoint(&attr, NULL, NULL);
699 if (IS_ERR((void * __force)breakinfo[i].pev)) {
700 pr_err("kgdb: Could not allocate hw breakpoints.\n");
701 breakinfo[i].pev = NULL;
705 for_each_online_cpu(cpu) {
706 pevent = per_cpu_ptr(breakinfo[i].pev, cpu);
707 if (pevent[0]->destroy) {
708 pevent[0]->destroy = NULL;
709 release_bp_slot(*pevent);
715 void kgdb_arch_exit(void)
719 for (i = 0; i < LOONGARCH_MAX_BRP; i++) {
720 if (breakinfo[i].pev) {
721 unregister_wide_hw_breakpoint(breakinfo[i].pev);
722 breakinfo[i].pev = NULL;
726 unregister_die_notifier(&kgdb_notifier);