4 * Maintainer: Jason Wessel <jason.wessel@windriver.com>
6 * Copyright (C) 2000-2001 VERITAS Software Corporation.
7 * Copyright (C) 2002-2004 Timesys Corporation
8 * Copyright (C) 2003-2004 Amit S. Kale <amitkale@linsyssoft.com>
9 * Copyright (C) 2004 Pavel Machek <pavel@ucw.cz>
10 * Copyright (C) 2004-2006 Tom Rini <trini@kernel.crashing.org>
11 * Copyright (C) 2004-2006 LinSysSoft Technologies Pvt. Ltd.
12 * Copyright (C) 2005-2009 Wind River Systems, Inc.
13 * Copyright (C) 2007 MontaVista Software, Inc.
14 * Copyright (C) 2008 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
16 * Contributors at various stages not listed above:
17 * Jason Wessel ( jason.wessel@windriver.com )
18 * George Anzinger <george@mvista.com>
19 * Anurekh Saxena (anurekh.saxena@timesys.com)
20 * Lake Stevens Instrument Division (Glenn Engel)
21 * Jim Kingdon, Cygnus Support.
23 * Original KGDB stub: David Grothe <dave@gcom.com>,
24 * Tigran Aivazian <tigran@sco.com>
26 * This file is licensed under the terms of the GNU General Public License
27 * version 2. This program is licensed "as is" without any warranty of any
28 * kind, whether express or implied.
31 #define pr_fmt(fmt) "KGDB: " fmt
33 #include <linux/pid_namespace.h>
34 #include <linux/clocksource.h>
35 #include <linux/serial_core.h>
36 #include <linux/interrupt.h>
37 #include <linux/spinlock.h>
38 #include <linux/console.h>
39 #include <linux/threads.h>
40 #include <linux/uaccess.h>
41 #include <linux/kernel.h>
42 #include <linux/module.h>
43 #include <linux/ptrace.h>
44 #include <linux/string.h>
45 #include <linux/delay.h>
46 #include <linux/sched.h>
47 #include <linux/sysrq.h>
48 #include <linux/reboot.h>
49 #include <linux/init.h>
50 #include <linux/kgdb.h>
51 #include <linux/kdb.h>
52 #include <linux/nmi.h>
53 #include <linux/pid.h>
54 #include <linux/smp.h>
56 #include <linux/vmacache.h>
57 #include <linux/rcupdate.h>
58 #include <linux/irq.h>
60 #include <asm/cacheflush.h>
61 #include <asm/byteorder.h>
62 #include <linux/atomic.h>
64 #include "debug_core.h"
66 static int kgdb_break_asap;
68 struct debuggerinfo_struct kgdb_info[NR_CPUS];
70 /* kgdb_connected - Is a host GDB connected to us? */
72 EXPORT_SYMBOL_GPL(kgdb_connected);
74 /* All the KGDB handlers are installed */
75 int kgdb_io_module_registered;
77 /* Guard for recursive entry */
78 static int exception_level;
80 struct kgdb_io *dbg_io_ops;
81 static DEFINE_SPINLOCK(kgdb_registration_lock);
83 /* Action for the reboot notifier, a global allow kdb to change it */
84 static int kgdbreboot;
85 /* kgdb console driver is loaded */
86 static int kgdb_con_registered;
87 /* determine if kgdb console output should be used */
88 static int kgdb_use_con;
89 /* Flag for alternate operations for early debugging */
90 bool dbg_is_early = true;
91 /* Next cpu to become the master debug core */
94 /* Use kdb or gdbserver mode */
97 module_param(kgdb_use_con, int, 0644);
98 module_param(kgdbreboot, int, 0644);
101 * Holds information about breakpoints in a kernel. These breakpoints are
102 * added and removed by gdb.
104 static struct kgdb_bkpt kgdb_break[KGDB_MAX_BREAKPOINTS] = {
105 [0 ... KGDB_MAX_BREAKPOINTS-1] = { .state = BP_UNDEFINED }
109 * The CPU# of the active CPU, or -1 if none:
111 atomic_t kgdb_active = ATOMIC_INIT(-1);
112 EXPORT_SYMBOL_GPL(kgdb_active);
113 static DEFINE_RAW_SPINLOCK(dbg_master_lock);
114 static DEFINE_RAW_SPINLOCK(dbg_slave_lock);
117 * We use NR_CPUs not PERCPU, in case kgdb is used to debug early
118 * bootup code (which might not have percpu set up yet):
120 static atomic_t masters_in_kgdb;
121 static atomic_t slaves_in_kgdb;
122 static atomic_t kgdb_break_tasklet_var;
123 atomic_t kgdb_setting_breakpoint;
125 struct task_struct *kgdb_usethread;
126 struct task_struct *kgdb_contthread;
128 int kgdb_single_step;
129 static pid_t kgdb_sstep_pid;
131 /* to keep track of the CPU which is doing the single stepping*/
132 atomic_t kgdb_cpu_doing_single_step = ATOMIC_INIT(-1);
135 * If you are debugging a problem where roundup (the collection of
136 * all other CPUs) is a problem [this should be extremely rare],
137 * then use the nokgdbroundup option to avoid roundup. In that case
138 * the other CPUs might interfere with your debugging context, so
139 * use this with care:
141 static int kgdb_do_roundup = 1;
143 static int __init opt_nokgdbroundup(char *str)
150 early_param("nokgdbroundup", opt_nokgdbroundup);
153 * Finally, some KGDB code :-)
157 * Weak aliases for breakpoint management,
158 * can be overridden by architectures when needed:
160 int __weak kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt)
164 err = copy_from_kernel_nofault(bpt->saved_instr, (char *)bpt->bpt_addr,
168 err = copy_to_kernel_nofault((char *)bpt->bpt_addr,
169 arch_kgdb_ops.gdb_bpt_instr, BREAK_INSTR_SIZE);
172 NOKPROBE_SYMBOL(kgdb_arch_set_breakpoint);
174 int __weak kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt)
176 return copy_to_kernel_nofault((char *)bpt->bpt_addr,
177 (char *)bpt->saved_instr, BREAK_INSTR_SIZE);
179 NOKPROBE_SYMBOL(kgdb_arch_remove_breakpoint);
181 int __weak kgdb_validate_break_address(unsigned long addr)
183 struct kgdb_bkpt tmp;
186 if (kgdb_within_blocklist(addr))
189 /* Validate setting the breakpoint and then removing it. If the
190 * remove fails, the kernel needs to emit a bad message because we
191 * are deep trouble not being able to put things back the way we
195 err = kgdb_arch_set_breakpoint(&tmp);
198 err = kgdb_arch_remove_breakpoint(&tmp);
200 pr_err("Critical breakpoint error, kernel memory destroyed at: %lx\n",
205 unsigned long __weak kgdb_arch_pc(int exception, struct pt_regs *regs)
207 return instruction_pointer(regs);
209 NOKPROBE_SYMBOL(kgdb_arch_pc);
211 int __weak kgdb_arch_init(void)
216 int __weak kgdb_skipexception(int exception, struct pt_regs *regs)
220 NOKPROBE_SYMBOL(kgdb_skipexception);
225 * Default (weak) implementation for kgdb_roundup_cpus
228 void __weak kgdb_call_nmi_hook(void *ignored)
231 * NOTE: get_irq_regs() is supposed to get the registers from
232 * before the IPI interrupt happened and so is supposed to
233 * show where the processor was. In some situations it's
234 * possible we might be called without an IPI, so it might be
235 * safer to figure out how to make kgdb_breakpoint() work
238 kgdb_nmicallback(raw_smp_processor_id(), get_irq_regs());
240 NOKPROBE_SYMBOL(kgdb_call_nmi_hook);
242 static DEFINE_PER_CPU(call_single_data_t, kgdb_roundup_csd) =
243 CSD_INIT(kgdb_call_nmi_hook, NULL);
245 void __weak kgdb_roundup_cpus(void)
247 call_single_data_t *csd;
248 int this_cpu = raw_smp_processor_id();
252 for_each_online_cpu(cpu) {
253 /* No need to roundup ourselves */
257 csd = &per_cpu(kgdb_roundup_csd, cpu);
260 * If it didn't round up last time, don't try again
261 * since smp_call_function_single_async() will block.
263 * If rounding_up is false then we know that the
264 * previous call must have at least started and that
265 * means smp_call_function_single_async() won't block.
267 if (kgdb_info[cpu].rounding_up)
269 kgdb_info[cpu].rounding_up = true;
271 ret = smp_call_function_single_async(cpu, csd);
273 kgdb_info[cpu].rounding_up = false;
276 NOKPROBE_SYMBOL(kgdb_roundup_cpus);
281 * Some architectures need cache flushes when we set/clear a
284 static void kgdb_flush_swbreak_addr(unsigned long addr)
286 if (!CACHE_FLUSH_IS_SAFE)
292 for (i = 0; i < VMACACHE_SIZE; i++) {
293 if (!current->vmacache.vmas[i])
295 flush_cache_range(current->vmacache.vmas[i],
296 addr, addr + BREAK_INSTR_SIZE);
300 /* Force flush instruction cache if it was outside the mm */
301 flush_icache_range(addr, addr + BREAK_INSTR_SIZE);
303 NOKPROBE_SYMBOL(kgdb_flush_swbreak_addr);
306 * SW breakpoint management:
308 int dbg_activate_sw_breakpoints(void)
314 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
315 if (kgdb_break[i].state != BP_SET)
318 error = kgdb_arch_set_breakpoint(&kgdb_break[i]);
321 pr_info("BP install failed: %lx\n",
322 kgdb_break[i].bpt_addr);
326 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
327 kgdb_break[i].state = BP_ACTIVE;
331 NOKPROBE_SYMBOL(dbg_activate_sw_breakpoints);
333 int dbg_set_sw_break(unsigned long addr)
335 int err = kgdb_validate_break_address(addr);
342 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
343 if ((kgdb_break[i].state == BP_SET) &&
344 (kgdb_break[i].bpt_addr == addr))
347 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
348 if (kgdb_break[i].state == BP_REMOVED &&
349 kgdb_break[i].bpt_addr == addr) {
356 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
357 if (kgdb_break[i].state == BP_UNDEFINED) {
367 kgdb_break[breakno].state = BP_SET;
368 kgdb_break[breakno].type = BP_BREAKPOINT;
369 kgdb_break[breakno].bpt_addr = addr;
374 int dbg_deactivate_sw_breakpoints(void)
380 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
381 if (kgdb_break[i].state != BP_ACTIVE)
383 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
385 pr_info("BP remove failed: %lx\n",
386 kgdb_break[i].bpt_addr);
390 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
391 kgdb_break[i].state = BP_SET;
395 NOKPROBE_SYMBOL(dbg_deactivate_sw_breakpoints);
397 int dbg_remove_sw_break(unsigned long addr)
401 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
402 if ((kgdb_break[i].state == BP_SET) &&
403 (kgdb_break[i].bpt_addr == addr)) {
404 kgdb_break[i].state = BP_REMOVED;
411 int kgdb_isremovedbreak(unsigned long addr)
415 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
416 if ((kgdb_break[i].state == BP_REMOVED) &&
417 (kgdb_break[i].bpt_addr == addr))
423 int kgdb_has_hit_break(unsigned long addr)
427 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
428 if (kgdb_break[i].state == BP_ACTIVE &&
429 kgdb_break[i].bpt_addr == addr)
435 int dbg_remove_all_break(void)
440 /* Clear memory breakpoints. */
441 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
442 if (kgdb_break[i].state != BP_ACTIVE)
444 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
446 pr_err("breakpoint remove failed: %lx\n",
447 kgdb_break[i].bpt_addr);
449 kgdb_break[i].state = BP_UNDEFINED;
452 /* Clear hardware breakpoints. */
453 if (arch_kgdb_ops.remove_all_hw_break)
454 arch_kgdb_ops.remove_all_hw_break();
459 #ifdef CONFIG_KGDB_KDB
460 void kdb_dump_stack_on_cpu(int cpu)
462 if (cpu == raw_smp_processor_id() || !IS_ENABLED(CONFIG_SMP)) {
467 if (!(kgdb_info[cpu].exception_state & DCPU_IS_SLAVE)) {
468 kdb_printf("ERROR: Task on cpu %d didn't stop in the debugger\n",
474 * In general, architectures don't support dumping the stack of a
475 * "running" process that's not the current one. From the point of
476 * view of the Linux, kernel processes that are looping in the kgdb
477 * slave loop are still "running". There's also no API (that actually
478 * works across all architectures) that can do a stack crawl based
479 * on registers passed as a parameter.
481 * Solve this conundrum by asking slave CPUs to do the backtrace
484 kgdb_info[cpu].exception_state |= DCPU_WANT_BT;
485 while (kgdb_info[cpu].exception_state & DCPU_WANT_BT)
491 * Return true if there is a valid kgdb I/O module. Also if no
492 * debugger is attached a message can be printed to the console about
493 * waiting for the debugger to attach.
495 * The print_wait argument is only to be true when called from inside
496 * the core kgdb_handle_exception, because it will wait for the
497 * debugger to attach.
499 static int kgdb_io_ready(int print_wait)
505 if (atomic_read(&kgdb_setting_breakpoint))
508 #ifdef CONFIG_KGDB_KDB
510 pr_crit("waiting... or $3#33 for KDB\n");
512 pr_crit("Waiting for remote debugger\n");
517 NOKPROBE_SYMBOL(kgdb_io_ready);
519 static int kgdb_reenter_check(struct kgdb_state *ks)
523 if (atomic_read(&kgdb_active) != raw_smp_processor_id())
526 /* Panic on recursive debugger calls: */
528 addr = kgdb_arch_pc(ks->ex_vector, ks->linux_regs);
529 dbg_deactivate_sw_breakpoints();
532 * If the break point removed ok at the place exception
533 * occurred, try to recover and print a warning to the end
534 * user because the user planted a breakpoint in a place that
535 * KGDB needs in order to function.
537 if (dbg_remove_sw_break(addr) == 0) {
539 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
540 dbg_activate_sw_breakpoints();
541 pr_crit("re-enter error: breakpoint removed %lx\n", addr);
546 dbg_remove_all_break();
547 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
549 if (exception_level > 1) {
551 kgdb_io_module_registered = false;
552 panic("Recursive entry to debugger");
555 pr_crit("re-enter exception: ALL breakpoints killed\n");
556 #ifdef CONFIG_KGDB_KDB
557 /* Allow kdb to debug itself one level */
561 panic("Recursive entry to debugger");
565 NOKPROBE_SYMBOL(kgdb_reenter_check);
567 static void dbg_touch_watchdogs(void)
569 touch_softlockup_watchdog_sync();
570 clocksource_touch_watchdog();
571 rcu_cpu_stall_reset();
573 NOKPROBE_SYMBOL(dbg_touch_watchdogs);
575 static int kgdb_cpu_enter(struct kgdb_state *ks, struct pt_regs *regs,
579 int sstep_tries = 100;
583 int online_cpus = num_online_cpus();
586 kgdb_info[ks->cpu].enter_kgdb++;
587 kgdb_info[ks->cpu].exception_state |= exception_state;
589 if (exception_state == DCPU_WANT_MASTER)
590 atomic_inc(&masters_in_kgdb);
592 atomic_inc(&slaves_in_kgdb);
594 if (arch_kgdb_ops.disable_hw_break)
595 arch_kgdb_ops.disable_hw_break(regs);
600 * Interrupts will be restored by the 'trap return' code, except when
603 local_irq_save(flags);
606 kgdb_info[cpu].debuggerinfo = regs;
607 kgdb_info[cpu].task = current;
608 kgdb_info[cpu].ret_state = 0;
609 kgdb_info[cpu].irq_depth = hardirq_count() >> HARDIRQ_SHIFT;
611 /* Make sure the above info reaches the primary CPU */
614 if (exception_level == 1) {
615 if (raw_spin_trylock(&dbg_master_lock))
616 atomic_xchg(&kgdb_active, cpu);
617 goto cpu_master_loop;
621 * CPU will loop if it is a slave or request to become a kgdb
622 * master cpu and acquire the kgdb_active lock:
626 if (kgdb_info[cpu].exception_state & DCPU_NEXT_MASTER) {
627 kgdb_info[cpu].exception_state &= ~DCPU_NEXT_MASTER;
628 goto cpu_master_loop;
629 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_MASTER) {
630 if (raw_spin_trylock(&dbg_master_lock)) {
631 atomic_xchg(&kgdb_active, cpu);
634 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_BT) {
636 kgdb_info[cpu].exception_state &= ~DCPU_WANT_BT;
637 } else if (kgdb_info[cpu].exception_state & DCPU_IS_SLAVE) {
638 if (!raw_spin_is_locked(&dbg_slave_lock))
642 /* Return to normal operation by executing any
643 * hw breakpoint fixup.
645 if (arch_kgdb_ops.correct_hw_break)
646 arch_kgdb_ops.correct_hw_break();
649 kgdb_info[cpu].debuggerinfo = NULL;
650 kgdb_info[cpu].task = NULL;
651 kgdb_info[cpu].exception_state &=
652 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
653 kgdb_info[cpu].enter_kgdb--;
654 smp_mb__before_atomic();
655 atomic_dec(&slaves_in_kgdb);
656 dbg_touch_watchdogs();
657 local_irq_restore(flags);
665 * For single stepping, try to only enter on the processor
666 * that was single stepping. To guard against a deadlock, the
667 * kernel will only try for the value of sstep_tries before
668 * giving up and continuing on.
670 if (atomic_read(&kgdb_cpu_doing_single_step) != -1 &&
671 (kgdb_info[cpu].task &&
672 kgdb_info[cpu].task->pid != kgdb_sstep_pid) && --sstep_tries) {
673 atomic_set(&kgdb_active, -1);
674 raw_spin_unlock(&dbg_master_lock);
675 dbg_touch_watchdogs();
676 local_irq_restore(flags);
682 if (!kgdb_io_ready(1)) {
683 kgdb_info[cpu].ret_state = 1;
684 goto kgdb_restore; /* No I/O connection, resume the system */
688 * Don't enter if we have hit a removed breakpoint.
690 if (kgdb_skipexception(ks->ex_vector, ks->linux_regs))
693 atomic_inc(&ignore_console_lock_warning);
695 /* Call the I/O driver's pre_exception routine */
696 if (dbg_io_ops->pre_exception)
697 dbg_io_ops->pre_exception();
700 * Get the passive CPU lock which will hold all the non-primary
701 * CPU in a spin state while the debugger is active
703 if (!kgdb_single_step)
704 raw_spin_lock(&dbg_slave_lock);
707 /* If send_ready set, slaves are already waiting */
709 atomic_set(ks->send_ready, 1);
711 /* Signal the other CPUs to enter kgdb_wait() */
712 else if ((!kgdb_single_step) && kgdb_do_roundup)
717 * Wait for the other CPUs to be notified and be waiting for us:
719 time_left = MSEC_PER_SEC;
720 while (kgdb_do_roundup && --time_left &&
721 (atomic_read(&masters_in_kgdb) + atomic_read(&slaves_in_kgdb)) !=
725 pr_crit("Timed out waiting for secondary CPUs.\n");
728 * At this point the primary processor is completely
729 * in the debugger and all secondary CPUs are quiescent
731 dbg_deactivate_sw_breakpoints();
732 kgdb_single_step = 0;
733 kgdb_contthread = current;
735 trace_on = tracing_is_on();
743 error = kdb_stub(ks);
748 error = gdb_serial_stub(ks);
751 if (error == DBG_PASS_EVENT) {
752 dbg_kdb_mode = !dbg_kdb_mode;
753 } else if (error == DBG_SWITCH_CPU_EVENT) {
754 kgdb_info[dbg_switch_cpu].exception_state |=
758 kgdb_info[cpu].ret_state = error;
763 dbg_activate_sw_breakpoints();
765 /* Call the I/O driver's post_exception routine */
766 if (dbg_io_ops->post_exception)
767 dbg_io_ops->post_exception();
769 atomic_dec(&ignore_console_lock_warning);
771 if (!kgdb_single_step) {
772 raw_spin_unlock(&dbg_slave_lock);
773 /* Wait till all the CPUs have quit from the debugger. */
774 while (kgdb_do_roundup && atomic_read(&slaves_in_kgdb))
779 if (atomic_read(&kgdb_cpu_doing_single_step) != -1) {
780 int sstep_cpu = atomic_read(&kgdb_cpu_doing_single_step);
781 if (kgdb_info[sstep_cpu].task)
782 kgdb_sstep_pid = kgdb_info[sstep_cpu].task->pid;
786 if (arch_kgdb_ops.correct_hw_break)
787 arch_kgdb_ops.correct_hw_break();
791 kgdb_info[cpu].debuggerinfo = NULL;
792 kgdb_info[cpu].task = NULL;
793 kgdb_info[cpu].exception_state &=
794 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
795 kgdb_info[cpu].enter_kgdb--;
796 smp_mb__before_atomic();
797 atomic_dec(&masters_in_kgdb);
798 /* Free kgdb_active */
799 atomic_set(&kgdb_active, -1);
800 raw_spin_unlock(&dbg_master_lock);
801 dbg_touch_watchdogs();
802 local_irq_restore(flags);
805 return kgdb_info[cpu].ret_state;
807 NOKPROBE_SYMBOL(kgdb_cpu_enter);
810 * kgdb_handle_exception() - main entry point from a kernel exception
813 * interface locks, if any (begin_session)
814 * kgdb lock (kgdb_active)
817 kgdb_handle_exception(int evector, int signo, int ecode, struct pt_regs *regs)
819 struct kgdb_state kgdb_var;
820 struct kgdb_state *ks = &kgdb_var;
823 if (arch_kgdb_ops.enable_nmi)
824 arch_kgdb_ops.enable_nmi(0);
826 * Avoid entering the debugger if we were triggered due to an oops
827 * but panic_timeout indicates the system should automatically
828 * reboot on panic. We don't want to get stuck waiting for input
829 * on such systems, especially if its "just" an oops.
831 if (signo != SIGTRAP && panic_timeout)
834 memset(ks, 0, sizeof(struct kgdb_state));
835 ks->cpu = raw_smp_processor_id();
836 ks->ex_vector = evector;
838 ks->err_code = ecode;
839 ks->linux_regs = regs;
841 if (kgdb_reenter_check(ks))
842 goto out; /* Ouch, double exception ! */
843 if (kgdb_info[ks->cpu].enter_kgdb != 0)
846 ret = kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
848 if (arch_kgdb_ops.enable_nmi)
849 arch_kgdb_ops.enable_nmi(1);
852 NOKPROBE_SYMBOL(kgdb_handle_exception);
855 * GDB places a breakpoint at this function to know dynamically loaded objects.
857 static int module_event(struct notifier_block *self, unsigned long val,
863 static struct notifier_block dbg_module_load_nb = {
864 .notifier_call = module_event,
867 int kgdb_nmicallback(int cpu, void *regs)
870 struct kgdb_state kgdb_var;
871 struct kgdb_state *ks = &kgdb_var;
873 kgdb_info[cpu].rounding_up = false;
875 memset(ks, 0, sizeof(struct kgdb_state));
877 ks->linux_regs = regs;
879 if (kgdb_info[ks->cpu].enter_kgdb == 0 &&
880 raw_spin_is_locked(&dbg_master_lock)) {
881 kgdb_cpu_enter(ks, regs, DCPU_IS_SLAVE);
887 NOKPROBE_SYMBOL(kgdb_nmicallback);
889 int kgdb_nmicallin(int cpu, int trapnr, void *regs, int err_code,
890 atomic_t *send_ready)
893 if (!kgdb_io_ready(0) || !send_ready)
896 if (kgdb_info[cpu].enter_kgdb == 0) {
897 struct kgdb_state kgdb_var;
898 struct kgdb_state *ks = &kgdb_var;
900 memset(ks, 0, sizeof(struct kgdb_state));
902 ks->ex_vector = trapnr;
904 ks->err_code = err_code;
905 ks->linux_regs = regs;
906 ks->send_ready = send_ready;
907 kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
913 NOKPROBE_SYMBOL(kgdb_nmicallin);
915 static void kgdb_console_write(struct console *co, const char *s,
920 /* If we're debugging, or KGDB has not connected, don't try
922 if (!kgdb_connected || atomic_read(&kgdb_active) != -1 || dbg_kdb_mode)
925 local_irq_save(flags);
926 gdbstub_msg_write(s, count);
927 local_irq_restore(flags);
930 static struct console kgdbcons = {
932 .write = kgdb_console_write,
933 .flags = CON_PRINTBUFFER | CON_ENABLED,
937 static int __init opt_kgdb_con(char *str)
941 if (kgdb_io_module_registered && !kgdb_con_registered) {
942 register_console(&kgdbcons);
943 kgdb_con_registered = 1;
949 early_param("kgdbcon", opt_kgdb_con);
951 #ifdef CONFIG_MAGIC_SYSRQ
952 static void sysrq_handle_dbg(int key)
955 pr_crit("ERROR: No KGDB I/O module available\n");
958 if (!kgdb_connected) {
959 #ifdef CONFIG_KGDB_KDB
961 pr_crit("KGDB or $3#33 for KDB\n");
963 pr_crit("Entering KGDB\n");
970 static const struct sysrq_key_op sysrq_dbg_op = {
971 .handler = sysrq_handle_dbg,
972 .help_msg = "debug(g)",
973 .action_msg = "DEBUG",
977 void kgdb_panic(const char *msg)
979 if (!kgdb_io_module_registered)
983 * We don't want to get stuck waiting for input from user if
984 * "panic_timeout" indicates the system should automatically
991 kdb_printf("PANIC: %s\n", msg);
996 static void kgdb_initial_breakpoint(void)
1000 pr_crit("Waiting for connection from remote gdb...\n");
1004 void __weak kgdb_arch_late(void)
1008 void __init dbg_late_init(void)
1010 dbg_is_early = false;
1011 if (kgdb_io_module_registered)
1013 kdb_init(KDB_INIT_FULL);
1015 if (kgdb_io_module_registered && kgdb_break_asap)
1016 kgdb_initial_breakpoint();
1020 dbg_notify_reboot(struct notifier_block *this, unsigned long code, void *x)
1023 * Take the following action on reboot notify depending on value:
1024 * 1 == Enter debugger
1025 * 0 == [the default] detatch debug client
1026 * -1 == Do nothing... and use this until the board resets
1028 switch (kgdbreboot) {
1040 static struct notifier_block dbg_reboot_notifier = {
1041 .notifier_call = dbg_notify_reboot,
1043 .priority = INT_MAX,
1046 static void kgdb_register_callbacks(void)
1048 if (!kgdb_io_module_registered) {
1049 kgdb_io_module_registered = 1;
1053 register_module_notifier(&dbg_module_load_nb);
1054 register_reboot_notifier(&dbg_reboot_notifier);
1055 #ifdef CONFIG_MAGIC_SYSRQ
1056 register_sysrq_key('g', &sysrq_dbg_op);
1058 if (kgdb_use_con && !kgdb_con_registered) {
1059 register_console(&kgdbcons);
1060 kgdb_con_registered = 1;
1065 static void kgdb_unregister_callbacks(void)
1068 * When this routine is called KGDB should unregister from
1069 * handlers and clean up, making sure it is not handling any
1070 * break exceptions at the time.
1072 if (kgdb_io_module_registered) {
1073 kgdb_io_module_registered = 0;
1074 unregister_reboot_notifier(&dbg_reboot_notifier);
1075 unregister_module_notifier(&dbg_module_load_nb);
1077 #ifdef CONFIG_MAGIC_SYSRQ
1078 unregister_sysrq_key('g', &sysrq_dbg_op);
1080 if (kgdb_con_registered) {
1081 unregister_console(&kgdbcons);
1082 kgdb_con_registered = 0;
1088 * There are times a tasklet needs to be used vs a compiled in
1089 * break point so as to cause an exception outside a kgdb I/O module,
1090 * such as is the case with kgdboe, where calling a breakpoint in the
1091 * I/O driver itself would be fatal.
1093 static void kgdb_tasklet_bpt(unsigned long ing)
1096 atomic_set(&kgdb_break_tasklet_var, 0);
1099 static DECLARE_TASKLET_OLD(kgdb_tasklet_breakpoint, kgdb_tasklet_bpt);
1101 void kgdb_schedule_breakpoint(void)
1103 if (atomic_read(&kgdb_break_tasklet_var) ||
1104 atomic_read(&kgdb_active) != -1 ||
1105 atomic_read(&kgdb_setting_breakpoint))
1107 atomic_inc(&kgdb_break_tasklet_var);
1108 tasklet_schedule(&kgdb_tasklet_breakpoint);
1110 EXPORT_SYMBOL_GPL(kgdb_schedule_breakpoint);
1113 * kgdb_register_io_module - register KGDB IO module
1114 * @new_dbg_io_ops: the io ops vector
1116 * Register it with the KGDB core.
1118 int kgdb_register_io_module(struct kgdb_io *new_dbg_io_ops)
1120 struct kgdb_io *old_dbg_io_ops;
1123 spin_lock(&kgdb_registration_lock);
1125 old_dbg_io_ops = dbg_io_ops;
1126 if (old_dbg_io_ops) {
1127 if (!old_dbg_io_ops->deinit) {
1128 spin_unlock(&kgdb_registration_lock);
1130 pr_err("KGDB I/O driver %s can't replace %s.\n",
1131 new_dbg_io_ops->name, old_dbg_io_ops->name);
1134 pr_info("Replacing I/O driver %s with %s\n",
1135 old_dbg_io_ops->name, new_dbg_io_ops->name);
1138 if (new_dbg_io_ops->init) {
1139 err = new_dbg_io_ops->init();
1141 spin_unlock(&kgdb_registration_lock);
1146 dbg_io_ops = new_dbg_io_ops;
1148 spin_unlock(&kgdb_registration_lock);
1150 if (old_dbg_io_ops) {
1151 old_dbg_io_ops->deinit();
1155 pr_info("Registered I/O driver %s\n", new_dbg_io_ops->name);
1158 kgdb_register_callbacks();
1160 if (kgdb_break_asap &&
1161 (!dbg_is_early || IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG)))
1162 kgdb_initial_breakpoint();
1166 EXPORT_SYMBOL_GPL(kgdb_register_io_module);
1169 * kkgdb_unregister_io_module - unregister KGDB IO module
1170 * @old_dbg_io_ops: the io ops vector
1172 * Unregister it with the KGDB core.
1174 void kgdb_unregister_io_module(struct kgdb_io *old_dbg_io_ops)
1176 BUG_ON(kgdb_connected);
1179 * KGDB is no longer able to communicate out, so
1180 * unregister our callbacks and reset state.
1182 kgdb_unregister_callbacks();
1184 spin_lock(&kgdb_registration_lock);
1186 WARN_ON_ONCE(dbg_io_ops != old_dbg_io_ops);
1189 spin_unlock(&kgdb_registration_lock);
1191 if (old_dbg_io_ops->deinit)
1192 old_dbg_io_ops->deinit();
1194 pr_info("Unregistered I/O driver %s, debugger disabled\n",
1195 old_dbg_io_ops->name);
1197 EXPORT_SYMBOL_GPL(kgdb_unregister_io_module);
1199 int dbg_io_get_char(void)
1201 int ret = dbg_io_ops->read_char();
1202 if (ret == NO_POLL_CHAR)
1212 * kgdb_breakpoint - generate breakpoint exception
1214 * This function will generate a breakpoint exception. It is used at the
1215 * beginning of a program to sync up with a debugger and can be used
1216 * otherwise as a quick means to stop program execution and "break" into
1219 noinline void kgdb_breakpoint(void)
1221 atomic_inc(&kgdb_setting_breakpoint);
1222 wmb(); /* Sync point before breakpoint */
1223 arch_kgdb_breakpoint();
1224 wmb(); /* Sync point after breakpoint */
1225 atomic_dec(&kgdb_setting_breakpoint);
1227 EXPORT_SYMBOL_GPL(kgdb_breakpoint);
1229 static int __init opt_kgdb_wait(char *str)
1231 kgdb_break_asap = 1;
1233 kdb_init(KDB_INIT_EARLY);
1234 if (kgdb_io_module_registered &&
1235 IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG))
1236 kgdb_initial_breakpoint();
1241 early_param("kgdbwait", opt_kgdb_wait);