6 * Copyright (C) 2000-2001 VERITAS Software Corporation.
7 * Copyright (C) 2002-2004 Timesys Corporation
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.
16 * Contributors at various stages not listed above:
20 * Lake Stevens Instrument Division (Glenn Engel)
21 * Jim Kingdon, Cygnus Support.
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 atomic_t kgdb_setting_breakpoint;
124 struct task_struct *kgdb_usethread;
125 struct task_struct *kgdb_contthread;
127 int kgdb_single_step;
128 static pid_t kgdb_sstep_pid;
130 /* to keep track of the CPU which is doing the single stepping*/
131 atomic_t kgdb_cpu_doing_single_step = ATOMIC_INIT(-1);
134 * If you are debugging a problem where roundup (the collection of
135 * all other CPUs) is a problem [this should be extremely rare],
136 * then use the nokgdbroundup option to avoid roundup. In that case
137 * the other CPUs might interfere with your debugging context, so
138 * use this with care:
140 static int kgdb_do_roundup = 1;
142 static int __init opt_nokgdbroundup(char *str)
149 early_param("nokgdbroundup", opt_nokgdbroundup);
152 * Finally, some KGDB code :-)
156 * Weak aliases for breakpoint management,
157 * can be overridden by architectures when needed:
159 int __weak kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt)
163 err = copy_from_kernel_nofault(bpt->saved_instr, (char *)bpt->bpt_addr,
167 err = copy_to_kernel_nofault((char *)bpt->bpt_addr,
168 arch_kgdb_ops.gdb_bpt_instr, BREAK_INSTR_SIZE);
171 NOKPROBE_SYMBOL(kgdb_arch_set_breakpoint);
173 int __weak kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt)
175 return copy_to_kernel_nofault((char *)bpt->bpt_addr,
176 (char *)bpt->saved_instr, BREAK_INSTR_SIZE);
178 NOKPROBE_SYMBOL(kgdb_arch_remove_breakpoint);
180 int __weak kgdb_validate_break_address(unsigned long addr)
182 struct kgdb_bkpt tmp;
185 if (kgdb_within_blocklist(addr))
188 /* Validate setting the breakpoint and then removing it. If the
189 * remove fails, the kernel needs to emit a bad message because we
190 * are deep trouble not being able to put things back the way we
194 err = kgdb_arch_set_breakpoint(&tmp);
197 err = kgdb_arch_remove_breakpoint(&tmp);
199 pr_err("Critical breakpoint error, kernel memory destroyed at: %lx\n",
204 unsigned long __weak kgdb_arch_pc(int exception, struct pt_regs *regs)
206 return instruction_pointer(regs);
208 NOKPROBE_SYMBOL(kgdb_arch_pc);
210 int __weak kgdb_arch_init(void)
215 int __weak kgdb_skipexception(int exception, struct pt_regs *regs)
219 NOKPROBE_SYMBOL(kgdb_skipexception);
224 * Default (weak) implementation for kgdb_roundup_cpus
227 void __weak kgdb_call_nmi_hook(void *ignored)
230 * NOTE: get_irq_regs() is supposed to get the registers from
231 * before the IPI interrupt happened and so is supposed to
232 * show where the processor was. In some situations it's
233 * possible we might be called without an IPI, so it might be
234 * safer to figure out how to make kgdb_breakpoint() work
237 kgdb_nmicallback(raw_smp_processor_id(), get_irq_regs());
239 NOKPROBE_SYMBOL(kgdb_call_nmi_hook);
241 static DEFINE_PER_CPU(call_single_data_t, kgdb_roundup_csd) =
242 CSD_INIT(kgdb_call_nmi_hook, NULL);
244 void __weak kgdb_roundup_cpus(void)
246 call_single_data_t *csd;
247 int this_cpu = raw_smp_processor_id();
251 for_each_online_cpu(cpu) {
252 /* No need to roundup ourselves */
256 csd = &per_cpu(kgdb_roundup_csd, cpu);
259 * If it didn't round up last time, don't try again
260 * since smp_call_function_single_async() will block.
262 * If rounding_up is false then we know that the
263 * previous call must have at least started and that
264 * means smp_call_function_single_async() won't block.
266 if (kgdb_info[cpu].rounding_up)
268 kgdb_info[cpu].rounding_up = true;
270 ret = smp_call_function_single_async(cpu, csd);
272 kgdb_info[cpu].rounding_up = false;
275 NOKPROBE_SYMBOL(kgdb_roundup_cpus);
280 * Some architectures need cache flushes when we set/clear a
283 static void kgdb_flush_swbreak_addr(unsigned long addr)
285 if (!CACHE_FLUSH_IS_SAFE)
291 for (i = 0; i < VMACACHE_SIZE; i++) {
292 if (!current->vmacache.vmas[i])
294 flush_cache_range(current->vmacache.vmas[i],
295 addr, addr + BREAK_INSTR_SIZE);
299 /* Force flush instruction cache if it was outside the mm */
300 flush_icache_range(addr, addr + BREAK_INSTR_SIZE);
302 NOKPROBE_SYMBOL(kgdb_flush_swbreak_addr);
305 * SW breakpoint management:
307 int dbg_activate_sw_breakpoints(void)
313 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
314 if (kgdb_break[i].state != BP_SET)
317 error = kgdb_arch_set_breakpoint(&kgdb_break[i]);
320 pr_info("BP install failed: %lx\n",
321 kgdb_break[i].bpt_addr);
325 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
326 kgdb_break[i].state = BP_ACTIVE;
330 NOKPROBE_SYMBOL(dbg_activate_sw_breakpoints);
332 int dbg_set_sw_break(unsigned long addr)
334 int err = kgdb_validate_break_address(addr);
341 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
342 if ((kgdb_break[i].state == BP_SET) &&
343 (kgdb_break[i].bpt_addr == addr))
346 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
347 if (kgdb_break[i].state == BP_REMOVED &&
348 kgdb_break[i].bpt_addr == addr) {
355 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
356 if (kgdb_break[i].state == BP_UNDEFINED) {
366 kgdb_break[breakno].state = BP_SET;
367 kgdb_break[breakno].type = BP_BREAKPOINT;
368 kgdb_break[breakno].bpt_addr = addr;
373 int dbg_deactivate_sw_breakpoints(void)
379 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
380 if (kgdb_break[i].state != BP_ACTIVE)
382 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
384 pr_info("BP remove failed: %lx\n",
385 kgdb_break[i].bpt_addr);
389 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
390 kgdb_break[i].state = BP_SET;
394 NOKPROBE_SYMBOL(dbg_deactivate_sw_breakpoints);
396 int dbg_remove_sw_break(unsigned long addr)
400 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
401 if ((kgdb_break[i].state == BP_SET) &&
402 (kgdb_break[i].bpt_addr == addr)) {
403 kgdb_break[i].state = BP_REMOVED;
410 int kgdb_isremovedbreak(unsigned long addr)
414 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
415 if ((kgdb_break[i].state == BP_REMOVED) &&
416 (kgdb_break[i].bpt_addr == addr))
422 int kgdb_has_hit_break(unsigned long addr)
426 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
427 if (kgdb_break[i].state == BP_ACTIVE &&
428 kgdb_break[i].bpt_addr == addr)
434 int dbg_remove_all_break(void)
439 /* Clear memory breakpoints. */
440 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
441 if (kgdb_break[i].state != BP_ACTIVE)
443 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
445 pr_err("breakpoint remove failed: %lx\n",
446 kgdb_break[i].bpt_addr);
448 kgdb_break[i].state = BP_UNDEFINED;
451 /* Clear hardware breakpoints. */
452 if (arch_kgdb_ops.remove_all_hw_break)
453 arch_kgdb_ops.remove_all_hw_break();
458 void kgdb_free_init_mem(void)
462 /* Clear init memory breakpoints. */
463 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
464 if (init_section_contains((void *)kgdb_break[i].bpt_addr, 0))
465 kgdb_break[i].state = BP_UNDEFINED;
469 #ifdef CONFIG_KGDB_KDB
470 void kdb_dump_stack_on_cpu(int cpu)
472 if (cpu == raw_smp_processor_id() || !IS_ENABLED(CONFIG_SMP)) {
477 if (!(kgdb_info[cpu].exception_state & DCPU_IS_SLAVE)) {
478 kdb_printf("ERROR: Task on cpu %d didn't stop in the debugger\n",
484 * In general, architectures don't support dumping the stack of a
485 * "running" process that's not the current one. From the point of
486 * view of the Linux, kernel processes that are looping in the kgdb
487 * slave loop are still "running". There's also no API (that actually
488 * works across all architectures) that can do a stack crawl based
489 * on registers passed as a parameter.
491 * Solve this conundrum by asking slave CPUs to do the backtrace
494 kgdb_info[cpu].exception_state |= DCPU_WANT_BT;
495 while (kgdb_info[cpu].exception_state & DCPU_WANT_BT)
501 * Return true if there is a valid kgdb I/O module. Also if no
502 * debugger is attached a message can be printed to the console about
503 * waiting for the debugger to attach.
505 * The print_wait argument is only to be true when called from inside
506 * the core kgdb_handle_exception, because it will wait for the
507 * debugger to attach.
509 static int kgdb_io_ready(int print_wait)
515 if (atomic_read(&kgdb_setting_breakpoint))
518 #ifdef CONFIG_KGDB_KDB
520 pr_crit("waiting... or $3#33 for KDB\n");
522 pr_crit("Waiting for remote debugger\n");
527 NOKPROBE_SYMBOL(kgdb_io_ready);
529 static int kgdb_reenter_check(struct kgdb_state *ks)
533 if (atomic_read(&kgdb_active) != raw_smp_processor_id())
536 /* Panic on recursive debugger calls: */
538 addr = kgdb_arch_pc(ks->ex_vector, ks->linux_regs);
539 dbg_deactivate_sw_breakpoints();
542 * If the break point removed ok at the place exception
543 * occurred, try to recover and print a warning to the end
544 * user because the user planted a breakpoint in a place that
545 * KGDB needs in order to function.
547 if (dbg_remove_sw_break(addr) == 0) {
549 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
550 dbg_activate_sw_breakpoints();
551 pr_crit("re-enter error: breakpoint removed %lx\n", addr);
556 dbg_remove_all_break();
557 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
559 if (exception_level > 1) {
561 kgdb_io_module_registered = false;
562 panic("Recursive entry to debugger");
565 pr_crit("re-enter exception: ALL breakpoints killed\n");
566 #ifdef CONFIG_KGDB_KDB
567 /* Allow kdb to debug itself one level */
571 panic("Recursive entry to debugger");
575 NOKPROBE_SYMBOL(kgdb_reenter_check);
577 static void dbg_touch_watchdogs(void)
579 touch_softlockup_watchdog_sync();
580 clocksource_touch_watchdog();
581 rcu_cpu_stall_reset();
583 NOKPROBE_SYMBOL(dbg_touch_watchdogs);
585 static int kgdb_cpu_enter(struct kgdb_state *ks, struct pt_regs *regs,
589 int sstep_tries = 100;
593 int online_cpus = num_online_cpus();
596 kgdb_info[ks->cpu].enter_kgdb++;
597 kgdb_info[ks->cpu].exception_state |= exception_state;
599 if (exception_state == DCPU_WANT_MASTER)
600 atomic_inc(&masters_in_kgdb);
602 atomic_inc(&slaves_in_kgdb);
604 if (arch_kgdb_ops.disable_hw_break)
605 arch_kgdb_ops.disable_hw_break(regs);
610 * Interrupts will be restored by the 'trap return' code, except when
613 local_irq_save(flags);
616 kgdb_info[cpu].debuggerinfo = regs;
617 kgdb_info[cpu].task = current;
618 kgdb_info[cpu].ret_state = 0;
619 kgdb_info[cpu].irq_depth = hardirq_count() >> HARDIRQ_SHIFT;
621 /* Make sure the above info reaches the primary CPU */
624 if (exception_level == 1) {
625 if (raw_spin_trylock(&dbg_master_lock))
626 atomic_xchg(&kgdb_active, cpu);
627 goto cpu_master_loop;
631 * CPU will loop if it is a slave or request to become a kgdb
632 * master cpu and acquire the kgdb_active lock:
636 if (kgdb_info[cpu].exception_state & DCPU_NEXT_MASTER) {
637 kgdb_info[cpu].exception_state &= ~DCPU_NEXT_MASTER;
638 goto cpu_master_loop;
639 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_MASTER) {
640 if (raw_spin_trylock(&dbg_master_lock)) {
641 atomic_xchg(&kgdb_active, cpu);
644 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_BT) {
646 kgdb_info[cpu].exception_state &= ~DCPU_WANT_BT;
647 } else if (kgdb_info[cpu].exception_state & DCPU_IS_SLAVE) {
648 if (!raw_spin_is_locked(&dbg_slave_lock))
652 /* Return to normal operation by executing any
653 * hw breakpoint fixup.
655 if (arch_kgdb_ops.correct_hw_break)
656 arch_kgdb_ops.correct_hw_break();
659 kgdb_info[cpu].debuggerinfo = NULL;
660 kgdb_info[cpu].task = NULL;
661 kgdb_info[cpu].exception_state &=
662 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
663 kgdb_info[cpu].enter_kgdb--;
664 smp_mb__before_atomic();
665 atomic_dec(&slaves_in_kgdb);
666 dbg_touch_watchdogs();
667 local_irq_restore(flags);
675 * For single stepping, try to only enter on the processor
676 * that was single stepping. To guard against a deadlock, the
677 * kernel will only try for the value of sstep_tries before
678 * giving up and continuing on.
680 if (atomic_read(&kgdb_cpu_doing_single_step) != -1 &&
681 (kgdb_info[cpu].task &&
682 kgdb_info[cpu].task->pid != kgdb_sstep_pid) && --sstep_tries) {
683 atomic_set(&kgdb_active, -1);
684 raw_spin_unlock(&dbg_master_lock);
685 dbg_touch_watchdogs();
686 local_irq_restore(flags);
692 if (!kgdb_io_ready(1)) {
693 kgdb_info[cpu].ret_state = 1;
694 goto kgdb_restore; /* No I/O connection, resume the system */
698 * Don't enter if we have hit a removed breakpoint.
700 if (kgdb_skipexception(ks->ex_vector, ks->linux_regs))
703 atomic_inc(&ignore_console_lock_warning);
705 /* Call the I/O driver's pre_exception routine */
706 if (dbg_io_ops->pre_exception)
707 dbg_io_ops->pre_exception();
710 * Get the passive CPU lock which will hold all the non-primary
711 * CPU in a spin state while the debugger is active
713 if (!kgdb_single_step)
714 raw_spin_lock(&dbg_slave_lock);
717 /* If send_ready set, slaves are already waiting */
719 atomic_set(ks->send_ready, 1);
721 /* Signal the other CPUs to enter kgdb_wait() */
722 else if ((!kgdb_single_step) && kgdb_do_roundup)
727 * Wait for the other CPUs to be notified and be waiting for us:
729 time_left = MSEC_PER_SEC;
730 while (kgdb_do_roundup && --time_left &&
731 (atomic_read(&masters_in_kgdb) + atomic_read(&slaves_in_kgdb)) !=
735 pr_crit("Timed out waiting for secondary CPUs.\n");
738 * At this point the primary processor is completely
739 * in the debugger and all secondary CPUs are quiescent
741 dbg_deactivate_sw_breakpoints();
742 kgdb_single_step = 0;
743 kgdb_contthread = current;
745 trace_on = tracing_is_on();
753 error = kdb_stub(ks);
758 error = gdb_serial_stub(ks);
761 if (error == DBG_PASS_EVENT) {
762 dbg_kdb_mode = !dbg_kdb_mode;
763 } else if (error == DBG_SWITCH_CPU_EVENT) {
764 kgdb_info[dbg_switch_cpu].exception_state |=
768 kgdb_info[cpu].ret_state = error;
773 dbg_activate_sw_breakpoints();
775 /* Call the I/O driver's post_exception routine */
776 if (dbg_io_ops->post_exception)
777 dbg_io_ops->post_exception();
779 atomic_dec(&ignore_console_lock_warning);
781 if (!kgdb_single_step) {
782 raw_spin_unlock(&dbg_slave_lock);
783 /* Wait till all the CPUs have quit from the debugger. */
784 while (kgdb_do_roundup && atomic_read(&slaves_in_kgdb))
789 if (atomic_read(&kgdb_cpu_doing_single_step) != -1) {
790 int sstep_cpu = atomic_read(&kgdb_cpu_doing_single_step);
791 if (kgdb_info[sstep_cpu].task)
792 kgdb_sstep_pid = kgdb_info[sstep_cpu].task->pid;
796 if (arch_kgdb_ops.correct_hw_break)
797 arch_kgdb_ops.correct_hw_break();
801 kgdb_info[cpu].debuggerinfo = NULL;
802 kgdb_info[cpu].task = NULL;
803 kgdb_info[cpu].exception_state &=
804 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
805 kgdb_info[cpu].enter_kgdb--;
806 smp_mb__before_atomic();
807 atomic_dec(&masters_in_kgdb);
808 /* Free kgdb_active */
809 atomic_set(&kgdb_active, -1);
810 raw_spin_unlock(&dbg_master_lock);
811 dbg_touch_watchdogs();
812 local_irq_restore(flags);
815 return kgdb_info[cpu].ret_state;
817 NOKPROBE_SYMBOL(kgdb_cpu_enter);
820 * kgdb_handle_exception() - main entry point from a kernel exception
823 * interface locks, if any (begin_session)
824 * kgdb lock (kgdb_active)
827 kgdb_handle_exception(int evector, int signo, int ecode, struct pt_regs *regs)
829 struct kgdb_state kgdb_var;
830 struct kgdb_state *ks = &kgdb_var;
833 if (arch_kgdb_ops.enable_nmi)
834 arch_kgdb_ops.enable_nmi(0);
836 * Avoid entering the debugger if we were triggered due to an oops
837 * but panic_timeout indicates the system should automatically
838 * reboot on panic. We don't want to get stuck waiting for input
839 * on such systems, especially if its "just" an oops.
841 if (signo != SIGTRAP && panic_timeout)
844 memset(ks, 0, sizeof(struct kgdb_state));
845 ks->cpu = raw_smp_processor_id();
846 ks->ex_vector = evector;
848 ks->err_code = ecode;
849 ks->linux_regs = regs;
851 if (kgdb_reenter_check(ks))
852 goto out; /* Ouch, double exception ! */
853 if (kgdb_info[ks->cpu].enter_kgdb != 0)
856 ret = kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
858 if (arch_kgdb_ops.enable_nmi)
859 arch_kgdb_ops.enable_nmi(1);
862 NOKPROBE_SYMBOL(kgdb_handle_exception);
865 * GDB places a breakpoint at this function to know dynamically loaded objects.
867 static int module_event(struct notifier_block *self, unsigned long val,
873 static struct notifier_block dbg_module_load_nb = {
874 .notifier_call = module_event,
877 int kgdb_nmicallback(int cpu, void *regs)
880 struct kgdb_state kgdb_var;
881 struct kgdb_state *ks = &kgdb_var;
883 kgdb_info[cpu].rounding_up = false;
885 memset(ks, 0, sizeof(struct kgdb_state));
887 ks->linux_regs = regs;
889 if (kgdb_info[ks->cpu].enter_kgdb == 0 &&
890 raw_spin_is_locked(&dbg_master_lock)) {
891 kgdb_cpu_enter(ks, regs, DCPU_IS_SLAVE);
897 NOKPROBE_SYMBOL(kgdb_nmicallback);
899 int kgdb_nmicallin(int cpu, int trapnr, void *regs, int err_code,
900 atomic_t *send_ready)
903 if (!kgdb_io_ready(0) || !send_ready)
906 if (kgdb_info[cpu].enter_kgdb == 0) {
907 struct kgdb_state kgdb_var;
908 struct kgdb_state *ks = &kgdb_var;
910 memset(ks, 0, sizeof(struct kgdb_state));
912 ks->ex_vector = trapnr;
914 ks->err_code = err_code;
915 ks->linux_regs = regs;
916 ks->send_ready = send_ready;
917 kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
923 NOKPROBE_SYMBOL(kgdb_nmicallin);
925 static void kgdb_console_write(struct console *co, const char *s,
930 /* If we're debugging, or KGDB has not connected, don't try
932 if (!kgdb_connected || atomic_read(&kgdb_active) != -1 || dbg_kdb_mode)
935 local_irq_save(flags);
936 gdbstub_msg_write(s, count);
937 local_irq_restore(flags);
940 static struct console kgdbcons = {
942 .write = kgdb_console_write,
943 .flags = CON_PRINTBUFFER | CON_ENABLED,
947 static int __init opt_kgdb_con(char *str)
951 if (kgdb_io_module_registered && !kgdb_con_registered) {
952 register_console(&kgdbcons);
953 kgdb_con_registered = 1;
959 early_param("kgdbcon", opt_kgdb_con);
961 #ifdef CONFIG_MAGIC_SYSRQ
962 static void sysrq_handle_dbg(int key)
965 pr_crit("ERROR: No KGDB I/O module available\n");
968 if (!kgdb_connected) {
969 #ifdef CONFIG_KGDB_KDB
971 pr_crit("KGDB or $3#33 for KDB\n");
973 pr_crit("Entering KGDB\n");
980 static const struct sysrq_key_op sysrq_dbg_op = {
981 .handler = sysrq_handle_dbg,
982 .help_msg = "debug(g)",
983 .action_msg = "DEBUG",
987 void kgdb_panic(const char *msg)
989 if (!kgdb_io_module_registered)
993 * We don't want to get stuck waiting for input from user if
994 * "panic_timeout" indicates the system should automatically
1001 kdb_printf("PANIC: %s\n", msg);
1006 static void kgdb_initial_breakpoint(void)
1008 kgdb_break_asap = 0;
1010 pr_crit("Waiting for connection from remote gdb...\n");
1014 void __weak kgdb_arch_late(void)
1018 void __init dbg_late_init(void)
1020 dbg_is_early = false;
1021 if (kgdb_io_module_registered)
1023 kdb_init(KDB_INIT_FULL);
1025 if (kgdb_io_module_registered && kgdb_break_asap)
1026 kgdb_initial_breakpoint();
1030 dbg_notify_reboot(struct notifier_block *this, unsigned long code, void *x)
1033 * Take the following action on reboot notify depending on value:
1034 * 1 == Enter debugger
1035 * 0 == [the default] detatch debug client
1036 * -1 == Do nothing... and use this until the board resets
1038 switch (kgdbreboot) {
1050 static struct notifier_block dbg_reboot_notifier = {
1051 .notifier_call = dbg_notify_reboot,
1053 .priority = INT_MAX,
1056 static void kgdb_register_callbacks(void)
1058 if (!kgdb_io_module_registered) {
1059 kgdb_io_module_registered = 1;
1063 register_module_notifier(&dbg_module_load_nb);
1064 register_reboot_notifier(&dbg_reboot_notifier);
1065 #ifdef CONFIG_MAGIC_SYSRQ
1066 register_sysrq_key('g', &sysrq_dbg_op);
1068 if (kgdb_use_con && !kgdb_con_registered) {
1069 register_console(&kgdbcons);
1070 kgdb_con_registered = 1;
1075 static void kgdb_unregister_callbacks(void)
1078 * When this routine is called KGDB should unregister from
1079 * handlers and clean up, making sure it is not handling any
1080 * break exceptions at the time.
1082 if (kgdb_io_module_registered) {
1083 kgdb_io_module_registered = 0;
1084 unregister_reboot_notifier(&dbg_reboot_notifier);
1085 unregister_module_notifier(&dbg_module_load_nb);
1087 #ifdef CONFIG_MAGIC_SYSRQ
1088 unregister_sysrq_key('g', &sysrq_dbg_op);
1090 if (kgdb_con_registered) {
1091 unregister_console(&kgdbcons);
1092 kgdb_con_registered = 0;
1098 * kgdb_register_io_module - register KGDB IO module
1099 * @new_dbg_io_ops: the io ops vector
1101 * Register it with the KGDB core.
1103 int kgdb_register_io_module(struct kgdb_io *new_dbg_io_ops)
1105 struct kgdb_io *old_dbg_io_ops;
1108 spin_lock(&kgdb_registration_lock);
1110 old_dbg_io_ops = dbg_io_ops;
1111 if (old_dbg_io_ops) {
1112 if (!old_dbg_io_ops->deinit) {
1113 spin_unlock(&kgdb_registration_lock);
1115 pr_err("KGDB I/O driver %s can't replace %s.\n",
1116 new_dbg_io_ops->name, old_dbg_io_ops->name);
1119 pr_info("Replacing I/O driver %s with %s\n",
1120 old_dbg_io_ops->name, new_dbg_io_ops->name);
1123 if (new_dbg_io_ops->init) {
1124 err = new_dbg_io_ops->init();
1126 spin_unlock(&kgdb_registration_lock);
1131 dbg_io_ops = new_dbg_io_ops;
1133 spin_unlock(&kgdb_registration_lock);
1135 if (old_dbg_io_ops) {
1136 old_dbg_io_ops->deinit();
1140 pr_info("Registered I/O driver %s\n", new_dbg_io_ops->name);
1143 kgdb_register_callbacks();
1145 if (kgdb_break_asap &&
1146 (!dbg_is_early || IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG)))
1147 kgdb_initial_breakpoint();
1151 EXPORT_SYMBOL_GPL(kgdb_register_io_module);
1154 * kgdb_unregister_io_module - unregister KGDB IO module
1155 * @old_dbg_io_ops: the io ops vector
1157 * Unregister it with the KGDB core.
1159 void kgdb_unregister_io_module(struct kgdb_io *old_dbg_io_ops)
1161 BUG_ON(kgdb_connected);
1164 * KGDB is no longer able to communicate out, so
1165 * unregister our callbacks and reset state.
1167 kgdb_unregister_callbacks();
1169 spin_lock(&kgdb_registration_lock);
1171 WARN_ON_ONCE(dbg_io_ops != old_dbg_io_ops);
1174 spin_unlock(&kgdb_registration_lock);
1176 if (old_dbg_io_ops->deinit)
1177 old_dbg_io_ops->deinit();
1179 pr_info("Unregistered I/O driver %s, debugger disabled\n",
1180 old_dbg_io_ops->name);
1182 EXPORT_SYMBOL_GPL(kgdb_unregister_io_module);
1184 int dbg_io_get_char(void)
1186 int ret = dbg_io_ops->read_char();
1187 if (ret == NO_POLL_CHAR)
1197 * kgdb_breakpoint - generate breakpoint exception
1199 * This function will generate a breakpoint exception. It is used at the
1200 * beginning of a program to sync up with a debugger and can be used
1201 * otherwise as a quick means to stop program execution and "break" into
1204 noinline void kgdb_breakpoint(void)
1206 atomic_inc(&kgdb_setting_breakpoint);
1207 wmb(); /* Sync point before breakpoint */
1208 arch_kgdb_breakpoint();
1209 wmb(); /* Sync point after breakpoint */
1210 atomic_dec(&kgdb_setting_breakpoint);
1212 EXPORT_SYMBOL_GPL(kgdb_breakpoint);
1214 static int __init opt_kgdb_wait(char *str)
1216 kgdb_break_asap = 1;
1218 kdb_init(KDB_INIT_EARLY);
1219 if (kgdb_io_module_registered &&
1220 IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG))
1221 kgdb_initial_breakpoint();
1226 early_param("kgdbwait", opt_kgdb_wait);