1 // SPDX-License-Identifier: GPL-2.0-only
5 * Maintainer: Jason Wessel <jason.wessel@windriver.com>
7 * Copyright (C) 2000-2001 VERITAS Software Corporation.
8 * Copyright (C) 2002-2004 Timesys Corporation
9 * Copyright (C) 2003-2004 Amit S. Kale <amitkale@linsyssoft.com>
10 * Copyright (C) 2004 Pavel Machek <pavel@ucw.cz>
11 * Copyright (C) 2004-2006 Tom Rini <trini@kernel.crashing.org>
12 * Copyright (C) 2004-2006 LinSysSoft Technologies Pvt. Ltd.
13 * Copyright (C) 2005-2009 Wind River Systems, Inc.
14 * Copyright (C) 2007 MontaVista Software, Inc.
15 * Copyright (C) 2008 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
17 * Contributors at various stages not listed above:
18 * Jason Wessel ( jason.wessel@windriver.com )
19 * George Anzinger <george@mvista.com>
20 * Anurekh Saxena (anurekh.saxena@timesys.com)
21 * Lake Stevens Instrument Division (Glenn Engel)
22 * Jim Kingdon, Cygnus Support.
24 * Original KGDB stub: David Grothe <dave@gcom.com>,
25 * Tigran Aivazian <tigran@sco.com>
28 #define pr_fmt(fmt) "KGDB: " fmt
30 #include <linux/pid_namespace.h>
31 #include <linux/clocksource.h>
32 #include <linux/serial_core.h>
33 #include <linux/interrupt.h>
34 #include <linux/spinlock.h>
35 #include <linux/console.h>
36 #include <linux/threads.h>
37 #include <linux/uaccess.h>
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/ptrace.h>
41 #include <linux/string.h>
42 #include <linux/delay.h>
43 #include <linux/sched.h>
44 #include <linux/sysrq.h>
45 #include <linux/reboot.h>
46 #include <linux/init.h>
47 #include <linux/kgdb.h>
48 #include <linux/kdb.h>
49 #include <linux/nmi.h>
50 #include <linux/pid.h>
51 #include <linux/smp.h>
53 #include <linux/rcupdate.h>
54 #include <linux/irq.h>
55 #include <linux/security.h>
57 #include <asm/cacheflush.h>
58 #include <asm/byteorder.h>
59 #include <linux/atomic.h>
61 #include "debug_core.h"
63 static int kgdb_break_asap
;
65 struct debuggerinfo_struct kgdb_info
[NR_CPUS
];
67 /* kgdb_connected - Is a host GDB connected to us? */
69 EXPORT_SYMBOL_GPL(kgdb_connected
);
71 /* All the KGDB handlers are installed */
72 int kgdb_io_module_registered
;
74 /* Guard for recursive entry */
75 static int exception_level
;
77 struct kgdb_io
*dbg_io_ops
;
78 static DEFINE_SPINLOCK(kgdb_registration_lock
);
80 /* Action for the reboot notifier, a global allow kdb to change it */
81 static int kgdbreboot
;
82 /* kgdb console driver is loaded */
83 static int kgdb_con_registered
;
84 /* determine if kgdb console output should be used */
85 static int kgdb_use_con
;
86 /* Flag for alternate operations for early debugging */
87 bool dbg_is_early
= true;
88 /* Next cpu to become the master debug core */
91 /* Use kdb or gdbserver mode */
94 module_param(kgdb_use_con
, int, 0644);
95 module_param(kgdbreboot
, int, 0644);
98 * Holds information about breakpoints in a kernel. These breakpoints are
99 * added and removed by gdb.
101 static struct kgdb_bkpt kgdb_break
[KGDB_MAX_BREAKPOINTS
] = {
102 [0 ... KGDB_MAX_BREAKPOINTS
-1] = { .state
= BP_UNDEFINED
}
106 * The CPU# of the active CPU, or -1 if none:
108 atomic_t kgdb_active
= ATOMIC_INIT(-1);
109 EXPORT_SYMBOL_GPL(kgdb_active
);
110 static DEFINE_RAW_SPINLOCK(dbg_master_lock
);
111 static DEFINE_RAW_SPINLOCK(dbg_slave_lock
);
114 * We use NR_CPUs not PERCPU, in case kgdb is used to debug early
115 * bootup code (which might not have percpu set up yet):
117 static atomic_t masters_in_kgdb
;
118 static atomic_t slaves_in_kgdb
;
119 atomic_t kgdb_setting_breakpoint
;
121 struct task_struct
*kgdb_usethread
;
122 struct task_struct
*kgdb_contthread
;
124 int kgdb_single_step
;
125 static pid_t kgdb_sstep_pid
;
127 /* to keep track of the CPU which is doing the single stepping*/
128 atomic_t kgdb_cpu_doing_single_step
= ATOMIC_INIT(-1);
131 * If you are debugging a problem where roundup (the collection of
132 * all other CPUs) is a problem [this should be extremely rare],
133 * then use the nokgdbroundup option to avoid roundup. In that case
134 * the other CPUs might interfere with your debugging context, so
135 * use this with care:
137 static int kgdb_do_roundup
= 1;
139 static int __init
opt_nokgdbroundup(char *str
)
146 early_param("nokgdbroundup", opt_nokgdbroundup
);
149 * Finally, some KGDB code :-)
153 * Weak aliases for breakpoint management,
154 * can be overridden by architectures when needed:
156 int __weak
kgdb_arch_set_breakpoint(struct kgdb_bkpt
*bpt
)
160 err
= copy_from_kernel_nofault(bpt
->saved_instr
, (char *)bpt
->bpt_addr
,
164 err
= copy_to_kernel_nofault((char *)bpt
->bpt_addr
,
165 arch_kgdb_ops
.gdb_bpt_instr
, BREAK_INSTR_SIZE
);
168 NOKPROBE_SYMBOL(kgdb_arch_set_breakpoint
);
170 int __weak
kgdb_arch_remove_breakpoint(struct kgdb_bkpt
*bpt
)
172 return copy_to_kernel_nofault((char *)bpt
->bpt_addr
,
173 (char *)bpt
->saved_instr
, BREAK_INSTR_SIZE
);
175 NOKPROBE_SYMBOL(kgdb_arch_remove_breakpoint
);
177 int __weak
kgdb_validate_break_address(unsigned long addr
)
179 struct kgdb_bkpt tmp
;
182 if (kgdb_within_blocklist(addr
))
185 /* Validate setting the breakpoint and then removing it. If the
186 * remove fails, the kernel needs to emit a bad message because we
187 * are deep trouble not being able to put things back the way we
191 err
= kgdb_arch_set_breakpoint(&tmp
);
194 err
= kgdb_arch_remove_breakpoint(&tmp
);
196 pr_err("Critical breakpoint error, kernel memory destroyed at: %lx\n",
201 unsigned long __weak
kgdb_arch_pc(int exception
, struct pt_regs
*regs
)
203 return instruction_pointer(regs
);
205 NOKPROBE_SYMBOL(kgdb_arch_pc
);
207 int __weak
kgdb_arch_init(void)
212 int __weak
kgdb_skipexception(int exception
, struct pt_regs
*regs
)
216 NOKPROBE_SYMBOL(kgdb_skipexception
);
221 * Default (weak) implementation for kgdb_roundup_cpus
224 void __weak
kgdb_call_nmi_hook(void *ignored
)
227 * NOTE: get_irq_regs() is supposed to get the registers from
228 * before the IPI interrupt happened and so is supposed to
229 * show where the processor was. In some situations it's
230 * possible we might be called without an IPI, so it might be
231 * safer to figure out how to make kgdb_breakpoint() work
234 kgdb_nmicallback(raw_smp_processor_id(), get_irq_regs());
236 NOKPROBE_SYMBOL(kgdb_call_nmi_hook
);
238 static DEFINE_PER_CPU(call_single_data_t
, kgdb_roundup_csd
) =
239 CSD_INIT(kgdb_call_nmi_hook
, NULL
);
241 void __weak
kgdb_roundup_cpus(void)
243 call_single_data_t
*csd
;
244 int this_cpu
= raw_smp_processor_id();
248 for_each_online_cpu(cpu
) {
249 /* No need to roundup ourselves */
253 csd
= &per_cpu(kgdb_roundup_csd
, cpu
);
256 * If it didn't round up last time, don't try again
257 * since smp_call_function_single_async() will block.
259 * If rounding_up is false then we know that the
260 * previous call must have at least started and that
261 * means smp_call_function_single_async() won't block.
263 if (kgdb_info
[cpu
].rounding_up
)
265 kgdb_info
[cpu
].rounding_up
= true;
267 ret
= smp_call_function_single_async(cpu
, csd
);
269 kgdb_info
[cpu
].rounding_up
= false;
272 NOKPROBE_SYMBOL(kgdb_roundup_cpus
);
277 * Some architectures need cache flushes when we set/clear a
280 static void kgdb_flush_swbreak_addr(unsigned long addr
)
282 if (!CACHE_FLUSH_IS_SAFE
)
285 /* Force flush instruction cache if it was outside the mm */
286 flush_icache_range(addr
, addr
+ BREAK_INSTR_SIZE
);
288 NOKPROBE_SYMBOL(kgdb_flush_swbreak_addr
);
291 * SW breakpoint management:
293 int dbg_activate_sw_breakpoints(void)
299 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
300 if (kgdb_break
[i
].state
!= BP_SET
)
303 error
= kgdb_arch_set_breakpoint(&kgdb_break
[i
]);
306 pr_info("BP install failed: %lx\n",
307 kgdb_break
[i
].bpt_addr
);
311 kgdb_flush_swbreak_addr(kgdb_break
[i
].bpt_addr
);
312 kgdb_break
[i
].state
= BP_ACTIVE
;
316 NOKPROBE_SYMBOL(dbg_activate_sw_breakpoints
);
318 int dbg_set_sw_break(unsigned long addr
)
320 int err
= kgdb_validate_break_address(addr
);
327 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
328 if ((kgdb_break
[i
].state
== BP_SET
) &&
329 (kgdb_break
[i
].bpt_addr
== addr
))
332 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
333 if (kgdb_break
[i
].state
== BP_REMOVED
&&
334 kgdb_break
[i
].bpt_addr
== addr
) {
341 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
342 if (kgdb_break
[i
].state
== BP_UNDEFINED
) {
352 kgdb_break
[breakno
].state
= BP_SET
;
353 kgdb_break
[breakno
].type
= BP_BREAKPOINT
;
354 kgdb_break
[breakno
].bpt_addr
= addr
;
359 int dbg_deactivate_sw_breakpoints(void)
365 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
366 if (kgdb_break
[i
].state
!= BP_ACTIVE
)
368 error
= kgdb_arch_remove_breakpoint(&kgdb_break
[i
]);
370 pr_info("BP remove failed: %lx\n",
371 kgdb_break
[i
].bpt_addr
);
375 kgdb_flush_swbreak_addr(kgdb_break
[i
].bpt_addr
);
376 kgdb_break
[i
].state
= BP_SET
;
380 NOKPROBE_SYMBOL(dbg_deactivate_sw_breakpoints
);
382 int dbg_remove_sw_break(unsigned long addr
)
386 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
387 if ((kgdb_break
[i
].state
== BP_SET
) &&
388 (kgdb_break
[i
].bpt_addr
== addr
)) {
389 kgdb_break
[i
].state
= BP_REMOVED
;
396 int kgdb_isremovedbreak(unsigned long addr
)
400 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
401 if ((kgdb_break
[i
].state
== BP_REMOVED
) &&
402 (kgdb_break
[i
].bpt_addr
== addr
))
408 int kgdb_has_hit_break(unsigned long addr
)
412 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
413 if (kgdb_break
[i
].state
== BP_ACTIVE
&&
414 kgdb_break
[i
].bpt_addr
== addr
)
420 int dbg_remove_all_break(void)
425 /* Clear memory breakpoints. */
426 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
427 if (kgdb_break
[i
].state
!= BP_ACTIVE
)
429 error
= kgdb_arch_remove_breakpoint(&kgdb_break
[i
]);
431 pr_err("breakpoint remove failed: %lx\n",
432 kgdb_break
[i
].bpt_addr
);
434 kgdb_break
[i
].state
= BP_UNDEFINED
;
437 /* Clear hardware breakpoints. */
438 if (arch_kgdb_ops
.remove_all_hw_break
)
439 arch_kgdb_ops
.remove_all_hw_break();
444 void kgdb_free_init_mem(void)
448 /* Clear init memory breakpoints. */
449 for (i
= 0; i
< KGDB_MAX_BREAKPOINTS
; i
++) {
450 if (init_section_contains((void *)kgdb_break
[i
].bpt_addr
, 0))
451 kgdb_break
[i
].state
= BP_UNDEFINED
;
455 #ifdef CONFIG_KGDB_KDB
456 void kdb_dump_stack_on_cpu(int cpu
)
458 if (cpu
== raw_smp_processor_id() || !IS_ENABLED(CONFIG_SMP
)) {
463 if (!(kgdb_info
[cpu
].exception_state
& DCPU_IS_SLAVE
)) {
464 kdb_printf("ERROR: Task on cpu %d didn't stop in the debugger\n",
470 * In general, architectures don't support dumping the stack of a
471 * "running" process that's not the current one. From the point of
472 * view of the Linux, kernel processes that are looping in the kgdb
473 * slave loop are still "running". There's also no API (that actually
474 * works across all architectures) that can do a stack crawl based
475 * on registers passed as a parameter.
477 * Solve this conundrum by asking slave CPUs to do the backtrace
480 kgdb_info
[cpu
].exception_state
|= DCPU_WANT_BT
;
481 while (kgdb_info
[cpu
].exception_state
& DCPU_WANT_BT
)
487 * Return true if there is a valid kgdb I/O module. Also if no
488 * debugger is attached a message can be printed to the console about
489 * waiting for the debugger to attach.
491 * The print_wait argument is only to be true when called from inside
492 * the core kgdb_handle_exception, because it will wait for the
493 * debugger to attach.
495 static int kgdb_io_ready(int print_wait
)
501 if (atomic_read(&kgdb_setting_breakpoint
))
504 #ifdef CONFIG_KGDB_KDB
506 pr_crit("waiting... or $3#33 for KDB\n");
508 pr_crit("Waiting for remote debugger\n");
513 NOKPROBE_SYMBOL(kgdb_io_ready
);
515 static int kgdb_reenter_check(struct kgdb_state
*ks
)
519 if (atomic_read(&kgdb_active
) != raw_smp_processor_id())
522 /* Panic on recursive debugger calls: */
524 addr
= kgdb_arch_pc(ks
->ex_vector
, ks
->linux_regs
);
525 dbg_deactivate_sw_breakpoints();
528 * If the break point removed ok at the place exception
529 * occurred, try to recover and print a warning to the end
530 * user because the user planted a breakpoint in a place that
531 * KGDB needs in order to function.
533 if (dbg_remove_sw_break(addr
) == 0) {
535 kgdb_skipexception(ks
->ex_vector
, ks
->linux_regs
);
536 dbg_activate_sw_breakpoints();
537 pr_crit("re-enter error: breakpoint removed %lx\n", addr
);
542 dbg_remove_all_break();
543 kgdb_skipexception(ks
->ex_vector
, ks
->linux_regs
);
545 if (exception_level
> 1) {
547 kgdb_io_module_registered
= false;
548 panic("Recursive entry to debugger");
551 pr_crit("re-enter exception: ALL breakpoints killed\n");
552 #ifdef CONFIG_KGDB_KDB
553 /* Allow kdb to debug itself one level */
557 panic("Recursive entry to debugger");
561 NOKPROBE_SYMBOL(kgdb_reenter_check
);
563 static void dbg_touch_watchdogs(void)
565 touch_softlockup_watchdog_sync();
566 clocksource_touch_watchdog();
567 rcu_cpu_stall_reset();
569 NOKPROBE_SYMBOL(dbg_touch_watchdogs
);
571 static int kgdb_cpu_enter(struct kgdb_state
*ks
, struct pt_regs
*regs
,
575 int sstep_tries
= 100;
579 int online_cpus
= num_online_cpus();
582 kgdb_info
[ks
->cpu
].enter_kgdb
++;
583 kgdb_info
[ks
->cpu
].exception_state
|= exception_state
;
585 if (exception_state
== DCPU_WANT_MASTER
)
586 atomic_inc(&masters_in_kgdb
);
588 atomic_inc(&slaves_in_kgdb
);
590 if (arch_kgdb_ops
.disable_hw_break
)
591 arch_kgdb_ops
.disable_hw_break(regs
);
596 * Interrupts will be restored by the 'trap return' code, except when
599 local_irq_save(flags
);
602 kgdb_info
[cpu
].debuggerinfo
= regs
;
603 kgdb_info
[cpu
].task
= current
;
604 kgdb_info
[cpu
].ret_state
= 0;
605 kgdb_info
[cpu
].irq_depth
= hardirq_count() >> HARDIRQ_SHIFT
;
607 /* Make sure the above info reaches the primary CPU */
610 if (exception_level
== 1) {
611 if (raw_spin_trylock(&dbg_master_lock
))
612 atomic_xchg(&kgdb_active
, cpu
);
613 goto cpu_master_loop
;
617 * CPU will loop if it is a slave or request to become a kgdb
618 * master cpu and acquire the kgdb_active lock:
622 if (kgdb_info
[cpu
].exception_state
& DCPU_NEXT_MASTER
) {
623 kgdb_info
[cpu
].exception_state
&= ~DCPU_NEXT_MASTER
;
624 goto cpu_master_loop
;
625 } else if (kgdb_info
[cpu
].exception_state
& DCPU_WANT_MASTER
) {
626 if (raw_spin_trylock(&dbg_master_lock
)) {
627 atomic_xchg(&kgdb_active
, cpu
);
630 } else if (kgdb_info
[cpu
].exception_state
& DCPU_WANT_BT
) {
632 kgdb_info
[cpu
].exception_state
&= ~DCPU_WANT_BT
;
633 } else if (kgdb_info
[cpu
].exception_state
& DCPU_IS_SLAVE
) {
634 if (!raw_spin_is_locked(&dbg_slave_lock
))
638 /* Return to normal operation by executing any
639 * hw breakpoint fixup.
641 if (arch_kgdb_ops
.correct_hw_break
)
642 arch_kgdb_ops
.correct_hw_break();
645 kgdb_info
[cpu
].debuggerinfo
= NULL
;
646 kgdb_info
[cpu
].task
= NULL
;
647 kgdb_info
[cpu
].exception_state
&=
648 ~(DCPU_WANT_MASTER
| DCPU_IS_SLAVE
);
649 kgdb_info
[cpu
].enter_kgdb
--;
650 smp_mb__before_atomic();
651 atomic_dec(&slaves_in_kgdb
);
652 dbg_touch_watchdogs();
653 local_irq_restore(flags
);
661 * For single stepping, try to only enter on the processor
662 * that was single stepping. To guard against a deadlock, the
663 * kernel will only try for the value of sstep_tries before
664 * giving up and continuing on.
666 if (atomic_read(&kgdb_cpu_doing_single_step
) != -1 &&
667 (kgdb_info
[cpu
].task
&&
668 kgdb_info
[cpu
].task
->pid
!= kgdb_sstep_pid
) && --sstep_tries
) {
669 atomic_set(&kgdb_active
, -1);
670 raw_spin_unlock(&dbg_master_lock
);
671 dbg_touch_watchdogs();
672 local_irq_restore(flags
);
678 if (!kgdb_io_ready(1)) {
679 kgdb_info
[cpu
].ret_state
= 1;
680 goto kgdb_restore
; /* No I/O connection, resume the system */
684 * Don't enter if we have hit a removed breakpoint.
686 if (kgdb_skipexception(ks
->ex_vector
, ks
->linux_regs
))
689 atomic_inc(&ignore_console_lock_warning
);
691 /* Call the I/O driver's pre_exception routine */
692 if (dbg_io_ops
->pre_exception
)
693 dbg_io_ops
->pre_exception();
696 * Get the passive CPU lock which will hold all the non-primary
697 * CPU in a spin state while the debugger is active
699 if (!kgdb_single_step
)
700 raw_spin_lock(&dbg_slave_lock
);
703 /* If send_ready set, slaves are already waiting */
705 atomic_set(ks
->send_ready
, 1);
707 /* Signal the other CPUs to enter kgdb_wait() */
708 else if ((!kgdb_single_step
) && kgdb_do_roundup
)
713 * Wait for the other CPUs to be notified and be waiting for us:
715 time_left
= MSEC_PER_SEC
;
716 while (kgdb_do_roundup
&& --time_left
&&
717 (atomic_read(&masters_in_kgdb
) + atomic_read(&slaves_in_kgdb
)) !=
721 pr_crit("Timed out waiting for secondary CPUs.\n");
724 * At this point the primary processor is completely
725 * in the debugger and all secondary CPUs are quiescent
727 dbg_deactivate_sw_breakpoints();
728 kgdb_single_step
= 0;
729 kgdb_contthread
= current
;
731 trace_on
= tracing_is_on();
739 error
= kdb_stub(ks
);
745 * This is a brutal way to interfere with the debugger
746 * and prevent gdb being used to poke at kernel memory.
747 * This could cause trouble if lockdown is applied when
748 * there is already an active gdb session. For now the
749 * answer is simply "don't do that". Typically lockdown
750 * *will* be applied before the debug core gets started
751 * so only developers using kgdb for fairly advanced
752 * early kernel debug can be biten by this. Hopefully
753 * they are sophisticated enough to take care of
754 * themselves, especially with help from the lockdown
755 * message printed on the console!
757 if (security_locked_down(LOCKDOWN_DBG_WRITE_KERNEL
)) {
758 if (IS_ENABLED(CONFIG_KGDB_KDB
)) {
759 /* Switch back to kdb if possible... */
763 /* ... otherwise just bail */
767 error
= gdb_serial_stub(ks
);
770 if (error
== DBG_PASS_EVENT
) {
771 dbg_kdb_mode
= !dbg_kdb_mode
;
772 } else if (error
== DBG_SWITCH_CPU_EVENT
) {
773 kgdb_info
[dbg_switch_cpu
].exception_state
|=
777 kgdb_info
[cpu
].ret_state
= error
;
782 dbg_activate_sw_breakpoints();
784 /* Call the I/O driver's post_exception routine */
785 if (dbg_io_ops
->post_exception
)
786 dbg_io_ops
->post_exception();
788 atomic_dec(&ignore_console_lock_warning
);
790 if (!kgdb_single_step
) {
791 raw_spin_unlock(&dbg_slave_lock
);
792 /* Wait till all the CPUs have quit from the debugger. */
793 while (kgdb_do_roundup
&& atomic_read(&slaves_in_kgdb
))
798 if (atomic_read(&kgdb_cpu_doing_single_step
) != -1) {
799 int sstep_cpu
= atomic_read(&kgdb_cpu_doing_single_step
);
800 if (kgdb_info
[sstep_cpu
].task
)
801 kgdb_sstep_pid
= kgdb_info
[sstep_cpu
].task
->pid
;
805 if (arch_kgdb_ops
.correct_hw_break
)
806 arch_kgdb_ops
.correct_hw_break();
810 kgdb_info
[cpu
].debuggerinfo
= NULL
;
811 kgdb_info
[cpu
].task
= NULL
;
812 kgdb_info
[cpu
].exception_state
&=
813 ~(DCPU_WANT_MASTER
| DCPU_IS_SLAVE
);
814 kgdb_info
[cpu
].enter_kgdb
--;
815 smp_mb__before_atomic();
816 atomic_dec(&masters_in_kgdb
);
817 /* Free kgdb_active */
818 atomic_set(&kgdb_active
, -1);
819 raw_spin_unlock(&dbg_master_lock
);
820 dbg_touch_watchdogs();
821 local_irq_restore(flags
);
824 return kgdb_info
[cpu
].ret_state
;
826 NOKPROBE_SYMBOL(kgdb_cpu_enter
);
829 * kgdb_handle_exception() - main entry point from a kernel exception
832 * interface locks, if any (begin_session)
833 * kgdb lock (kgdb_active)
836 kgdb_handle_exception(int evector
, int signo
, int ecode
, struct pt_regs
*regs
)
838 struct kgdb_state kgdb_var
;
839 struct kgdb_state
*ks
= &kgdb_var
;
842 if (arch_kgdb_ops
.enable_nmi
)
843 arch_kgdb_ops
.enable_nmi(0);
845 * Avoid entering the debugger if we were triggered due to an oops
846 * but panic_timeout indicates the system should automatically
847 * reboot on panic. We don't want to get stuck waiting for input
848 * on such systems, especially if its "just" an oops.
850 if (signo
!= SIGTRAP
&& panic_timeout
)
853 memset(ks
, 0, sizeof(struct kgdb_state
));
854 ks
->cpu
= raw_smp_processor_id();
855 ks
->ex_vector
= evector
;
857 ks
->err_code
= ecode
;
858 ks
->linux_regs
= regs
;
860 if (kgdb_reenter_check(ks
))
861 goto out
; /* Ouch, double exception ! */
862 if (kgdb_info
[ks
->cpu
].enter_kgdb
!= 0)
865 ret
= kgdb_cpu_enter(ks
, regs
, DCPU_WANT_MASTER
);
867 if (arch_kgdb_ops
.enable_nmi
)
868 arch_kgdb_ops
.enable_nmi(1);
871 NOKPROBE_SYMBOL(kgdb_handle_exception
);
874 * GDB places a breakpoint at this function to know dynamically loaded objects.
876 static int module_event(struct notifier_block
*self
, unsigned long val
,
882 static struct notifier_block dbg_module_load_nb
= {
883 .notifier_call
= module_event
,
886 int kgdb_nmicallback(int cpu
, void *regs
)
889 struct kgdb_state kgdb_var
;
890 struct kgdb_state
*ks
= &kgdb_var
;
892 kgdb_info
[cpu
].rounding_up
= false;
894 memset(ks
, 0, sizeof(struct kgdb_state
));
896 ks
->linux_regs
= regs
;
898 if (kgdb_info
[ks
->cpu
].enter_kgdb
== 0 &&
899 raw_spin_is_locked(&dbg_master_lock
)) {
900 kgdb_cpu_enter(ks
, regs
, DCPU_IS_SLAVE
);
906 NOKPROBE_SYMBOL(kgdb_nmicallback
);
908 int kgdb_nmicallin(int cpu
, int trapnr
, void *regs
, int err_code
,
909 atomic_t
*send_ready
)
912 if (!kgdb_io_ready(0) || !send_ready
)
915 if (kgdb_info
[cpu
].enter_kgdb
== 0) {
916 struct kgdb_state kgdb_var
;
917 struct kgdb_state
*ks
= &kgdb_var
;
919 memset(ks
, 0, sizeof(struct kgdb_state
));
921 ks
->ex_vector
= trapnr
;
923 ks
->err_code
= err_code
;
924 ks
->linux_regs
= regs
;
925 ks
->send_ready
= send_ready
;
926 kgdb_cpu_enter(ks
, regs
, DCPU_WANT_MASTER
);
932 NOKPROBE_SYMBOL(kgdb_nmicallin
);
934 static void kgdb_console_write(struct console
*co
, const char *s
,
939 /* If we're debugging, or KGDB has not connected, don't try
941 if (!kgdb_connected
|| atomic_read(&kgdb_active
) != -1 || dbg_kdb_mode
)
944 local_irq_save(flags
);
945 gdbstub_msg_write(s
, count
);
946 local_irq_restore(flags
);
949 static struct console kgdbcons
= {
951 .write
= kgdb_console_write
,
952 .flags
= CON_PRINTBUFFER
| CON_ENABLED
,
956 static int __init
opt_kgdb_con(char *str
)
960 if (kgdb_io_module_registered
&& !kgdb_con_registered
) {
961 register_console(&kgdbcons
);
962 kgdb_con_registered
= 1;
968 early_param("kgdbcon", opt_kgdb_con
);
970 #ifdef CONFIG_MAGIC_SYSRQ
971 static void sysrq_handle_dbg(u8 key
)
974 pr_crit("ERROR: No KGDB I/O module available\n");
977 if (!kgdb_connected
) {
978 #ifdef CONFIG_KGDB_KDB
980 pr_crit("KGDB or $3#33 for KDB\n");
982 pr_crit("Entering KGDB\n");
989 static const struct sysrq_key_op sysrq_dbg_op
= {
990 .handler
= sysrq_handle_dbg
,
991 .help_msg
= "debug(g)",
992 .action_msg
= "DEBUG",
996 void kgdb_panic(const char *msg
)
998 if (!kgdb_io_module_registered
)
1002 * We don't want to get stuck waiting for input from user if
1003 * "panic_timeout" indicates the system should automatically
1010 console_flush_on_panic(CONSOLE_FLUSH_PENDING
);
1013 kdb_printf("PANIC: %s\n", msg
);
1018 static void kgdb_initial_breakpoint(void)
1020 kgdb_break_asap
= 0;
1022 pr_crit("Waiting for connection from remote gdb...\n");
1026 void __weak
kgdb_arch_late(void)
1030 void __init
dbg_late_init(void)
1032 dbg_is_early
= false;
1033 if (kgdb_io_module_registered
)
1035 kdb_init(KDB_INIT_FULL
);
1037 if (kgdb_io_module_registered
&& kgdb_break_asap
)
1038 kgdb_initial_breakpoint();
1042 dbg_notify_reboot(struct notifier_block
*this, unsigned long code
, void *x
)
1045 * Take the following action on reboot notify depending on value:
1046 * 1 == Enter debugger
1047 * 0 == [the default] detach debug client
1048 * -1 == Do nothing... and use this until the board resets
1050 switch (kgdbreboot
) {
1063 static struct notifier_block dbg_reboot_notifier
= {
1064 .notifier_call
= dbg_notify_reboot
,
1066 .priority
= INT_MAX
,
1069 static void kgdb_register_callbacks(void)
1071 if (!kgdb_io_module_registered
) {
1072 kgdb_io_module_registered
= 1;
1076 register_module_notifier(&dbg_module_load_nb
);
1077 register_reboot_notifier(&dbg_reboot_notifier
);
1078 #ifdef CONFIG_MAGIC_SYSRQ
1079 register_sysrq_key('g', &sysrq_dbg_op
);
1081 if (kgdb_use_con
&& !kgdb_con_registered
) {
1082 register_console(&kgdbcons
);
1083 kgdb_con_registered
= 1;
1088 static void kgdb_unregister_callbacks(void)
1091 * When this routine is called KGDB should unregister from
1092 * handlers and clean up, making sure it is not handling any
1093 * break exceptions at the time.
1095 if (kgdb_io_module_registered
) {
1096 kgdb_io_module_registered
= 0;
1097 unregister_reboot_notifier(&dbg_reboot_notifier
);
1098 unregister_module_notifier(&dbg_module_load_nb
);
1100 #ifdef CONFIG_MAGIC_SYSRQ
1101 unregister_sysrq_key('g', &sysrq_dbg_op
);
1103 if (kgdb_con_registered
) {
1104 unregister_console(&kgdbcons
);
1105 kgdb_con_registered
= 0;
1111 * kgdb_register_io_module - register KGDB IO module
1112 * @new_dbg_io_ops: the io ops vector
1114 * Register it with the KGDB core.
1116 int kgdb_register_io_module(struct kgdb_io
*new_dbg_io_ops
)
1118 struct kgdb_io
*old_dbg_io_ops
;
1121 spin_lock(&kgdb_registration_lock
);
1123 old_dbg_io_ops
= dbg_io_ops
;
1124 if (old_dbg_io_ops
) {
1125 if (!old_dbg_io_ops
->deinit
) {
1126 spin_unlock(&kgdb_registration_lock
);
1128 pr_err("KGDB I/O driver %s can't replace %s.\n",
1129 new_dbg_io_ops
->name
, old_dbg_io_ops
->name
);
1132 pr_info("Replacing I/O driver %s with %s\n",
1133 old_dbg_io_ops
->name
, new_dbg_io_ops
->name
);
1136 if (new_dbg_io_ops
->init
) {
1137 err
= new_dbg_io_ops
->init();
1139 spin_unlock(&kgdb_registration_lock
);
1144 dbg_io_ops
= new_dbg_io_ops
;
1146 spin_unlock(&kgdb_registration_lock
);
1148 if (old_dbg_io_ops
) {
1149 old_dbg_io_ops
->deinit();
1153 pr_info("Registered I/O driver %s\n", new_dbg_io_ops
->name
);
1156 kgdb_register_callbacks();
1158 if (kgdb_break_asap
&&
1159 (!dbg_is_early
|| IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG
)))
1160 kgdb_initial_breakpoint();
1164 EXPORT_SYMBOL_GPL(kgdb_register_io_module
);
1167 * kgdb_unregister_io_module - unregister KGDB IO module
1168 * @old_dbg_io_ops: the io ops vector
1170 * Unregister it with the KGDB core.
1172 void kgdb_unregister_io_module(struct kgdb_io
*old_dbg_io_ops
)
1174 BUG_ON(kgdb_connected
);
1177 * KGDB is no longer able to communicate out, so
1178 * unregister our callbacks and reset state.
1180 kgdb_unregister_callbacks();
1182 spin_lock(&kgdb_registration_lock
);
1184 WARN_ON_ONCE(dbg_io_ops
!= old_dbg_io_ops
);
1187 spin_unlock(&kgdb_registration_lock
);
1189 if (old_dbg_io_ops
->deinit
)
1190 old_dbg_io_ops
->deinit();
1192 pr_info("Unregistered I/O driver %s, debugger disabled\n",
1193 old_dbg_io_ops
->name
);
1195 EXPORT_SYMBOL_GPL(kgdb_unregister_io_module
);
1197 int dbg_io_get_char(void)
1199 int ret
= dbg_io_ops
->read_char();
1200 if (ret
== NO_POLL_CHAR
)
1210 * kgdb_breakpoint - generate breakpoint exception
1212 * This function will generate a breakpoint exception. It is used at the
1213 * beginning of a program to sync up with a debugger and can be used
1214 * otherwise as a quick means to stop program execution and "break" into
1217 noinline
void kgdb_breakpoint(void)
1219 atomic_inc(&kgdb_setting_breakpoint
);
1220 wmb(); /* Sync point before breakpoint */
1221 arch_kgdb_breakpoint();
1222 wmb(); /* Sync point after breakpoint */
1223 atomic_dec(&kgdb_setting_breakpoint
);
1225 EXPORT_SYMBOL_GPL(kgdb_breakpoint
);
1227 static int __init
opt_kgdb_wait(char *str
)
1229 kgdb_break_asap
= 1;
1231 kdb_init(KDB_INIT_EARLY
);
1232 if (kgdb_io_module_registered
&&
1233 IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG
))
1234 kgdb_initial_breakpoint();
1239 early_param("kgdbwait", opt_kgdb_wait
);