Loading...
1/*
2 * Kernel Debug Core
3 *
4 * Maintainer: Jason Wessel <jason.wessel@windriver.com>
5 *
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>
15 *
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.
22 *
23 * Original KGDB stub: David Grothe <dave@gcom.com>,
24 * Tigran Aivazian <tigran@sco.com>
25 *
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.
29 */
30#include <linux/pid_namespace.h>
31#include <linux/clocksource.h>
32#include <linux/interrupt.h>
33#include <linux/spinlock.h>
34#include <linux/console.h>
35#include <linux/threads.h>
36#include <linux/uaccess.h>
37#include <linux/kernel.h>
38#include <linux/module.h>
39#include <linux/ptrace.h>
40#include <linux/string.h>
41#include <linux/delay.h>
42#include <linux/sched.h>
43#include <linux/sysrq.h>
44#include <linux/reboot.h>
45#include <linux/init.h>
46#include <linux/kgdb.h>
47#include <linux/kdb.h>
48#include <linux/pid.h>
49#include <linux/smp.h>
50#include <linux/mm.h>
51#include <linux/rcupdate.h>
52
53#include <asm/cacheflush.h>
54#include <asm/byteorder.h>
55#include <linux/atomic.h>
56
57#include "debug_core.h"
58
59static int kgdb_break_asap;
60
61struct debuggerinfo_struct kgdb_info[NR_CPUS];
62
63/**
64 * kgdb_connected - Is a host GDB connected to us?
65 */
66int kgdb_connected;
67EXPORT_SYMBOL_GPL(kgdb_connected);
68
69/* All the KGDB handlers are installed */
70int kgdb_io_module_registered;
71
72/* Guard for recursive entry */
73static int exception_level;
74
75struct kgdb_io *dbg_io_ops;
76static DEFINE_SPINLOCK(kgdb_registration_lock);
77
78/* Action for the reboot notifiter, a global allow kdb to change it */
79static int kgdbreboot;
80/* kgdb console driver is loaded */
81static int kgdb_con_registered;
82/* determine if kgdb console output should be used */
83static int kgdb_use_con;
84/* Flag for alternate operations for early debugging */
85bool dbg_is_early = true;
86/* Next cpu to become the master debug core */
87int dbg_switch_cpu;
88
89/* Use kdb or gdbserver mode */
90int dbg_kdb_mode = 1;
91
92static int __init opt_kgdb_con(char *str)
93{
94 kgdb_use_con = 1;
95 return 0;
96}
97
98early_param("kgdbcon", opt_kgdb_con);
99
100module_param(kgdb_use_con, int, 0644);
101module_param(kgdbreboot, int, 0644);
102
103/*
104 * Holds information about breakpoints in a kernel. These breakpoints are
105 * added and removed by gdb.
106 */
107static struct kgdb_bkpt kgdb_break[KGDB_MAX_BREAKPOINTS] = {
108 [0 ... KGDB_MAX_BREAKPOINTS-1] = { .state = BP_UNDEFINED }
109};
110
111/*
112 * The CPU# of the active CPU, or -1 if none:
113 */
114atomic_t kgdb_active = ATOMIC_INIT(-1);
115EXPORT_SYMBOL_GPL(kgdb_active);
116static DEFINE_RAW_SPINLOCK(dbg_master_lock);
117static DEFINE_RAW_SPINLOCK(dbg_slave_lock);
118
119/*
120 * We use NR_CPUs not PERCPU, in case kgdb is used to debug early
121 * bootup code (which might not have percpu set up yet):
122 */
123static atomic_t masters_in_kgdb;
124static atomic_t slaves_in_kgdb;
125static atomic_t kgdb_break_tasklet_var;
126atomic_t kgdb_setting_breakpoint;
127
128struct task_struct *kgdb_usethread;
129struct task_struct *kgdb_contthread;
130
131int kgdb_single_step;
132static pid_t kgdb_sstep_pid;
133
134/* to keep track of the CPU which is doing the single stepping*/
135atomic_t kgdb_cpu_doing_single_step = ATOMIC_INIT(-1);
136
137/*
138 * If you are debugging a problem where roundup (the collection of
139 * all other CPUs) is a problem [this should be extremely rare],
140 * then use the nokgdbroundup option to avoid roundup. In that case
141 * the other CPUs might interfere with your debugging context, so
142 * use this with care:
143 */
144static int kgdb_do_roundup = 1;
145
146static int __init opt_nokgdbroundup(char *str)
147{
148 kgdb_do_roundup = 0;
149
150 return 0;
151}
152
153early_param("nokgdbroundup", opt_nokgdbroundup);
154
155/*
156 * Finally, some KGDB code :-)
157 */
158
159/*
160 * Weak aliases for breakpoint management,
161 * can be overriden by architectures when needed:
162 */
163int __weak kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt)
164{
165 int err;
166
167 err = probe_kernel_read(bpt->saved_instr, (char *)bpt->bpt_addr,
168 BREAK_INSTR_SIZE);
169 if (err)
170 return err;
171 err = probe_kernel_write((char *)bpt->bpt_addr,
172 arch_kgdb_ops.gdb_bpt_instr, BREAK_INSTR_SIZE);
173 return err;
174}
175
176int __weak kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt)
177{
178 return probe_kernel_write((char *)bpt->bpt_addr,
179 (char *)bpt->saved_instr, BREAK_INSTR_SIZE);
180}
181
182int __weak kgdb_validate_break_address(unsigned long addr)
183{
184 struct kgdb_bkpt tmp;
185 int err;
186 /* Validate setting the breakpoint and then removing it. If the
187 * remove fails, the kernel needs to emit a bad message because we
188 * are deep trouble not being able to put things back the way we
189 * found them.
190 */
191 tmp.bpt_addr = addr;
192 err = kgdb_arch_set_breakpoint(&tmp);
193 if (err)
194 return err;
195 err = kgdb_arch_remove_breakpoint(&tmp);
196 if (err)
197 printk(KERN_ERR "KGDB: Critical breakpoint error, kernel "
198 "memory destroyed at: %lx", addr);
199 return err;
200}
201
202unsigned long __weak kgdb_arch_pc(int exception, struct pt_regs *regs)
203{
204 return instruction_pointer(regs);
205}
206
207int __weak kgdb_arch_init(void)
208{
209 return 0;
210}
211
212int __weak kgdb_skipexception(int exception, struct pt_regs *regs)
213{
214 return 0;
215}
216
217/*
218 * Some architectures need cache flushes when we set/clear a
219 * breakpoint:
220 */
221static void kgdb_flush_swbreak_addr(unsigned long addr)
222{
223 if (!CACHE_FLUSH_IS_SAFE)
224 return;
225
226 if (current->mm && current->mm->mmap_cache) {
227 flush_cache_range(current->mm->mmap_cache,
228 addr, addr + BREAK_INSTR_SIZE);
229 }
230 /* Force flush instruction cache if it was outside the mm */
231 flush_icache_range(addr, addr + BREAK_INSTR_SIZE);
232}
233
234/*
235 * SW breakpoint management:
236 */
237int dbg_activate_sw_breakpoints(void)
238{
239 int error;
240 int ret = 0;
241 int i;
242
243 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
244 if (kgdb_break[i].state != BP_SET)
245 continue;
246
247 error = kgdb_arch_set_breakpoint(&kgdb_break[i]);
248 if (error) {
249 ret = error;
250 printk(KERN_INFO "KGDB: BP install failed: %lx",
251 kgdb_break[i].bpt_addr);
252 continue;
253 }
254
255 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
256 kgdb_break[i].state = BP_ACTIVE;
257 }
258 return ret;
259}
260
261int dbg_set_sw_break(unsigned long addr)
262{
263 int err = kgdb_validate_break_address(addr);
264 int breakno = -1;
265 int i;
266
267 if (err)
268 return err;
269
270 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
271 if ((kgdb_break[i].state == BP_SET) &&
272 (kgdb_break[i].bpt_addr == addr))
273 return -EEXIST;
274 }
275 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
276 if (kgdb_break[i].state == BP_REMOVED &&
277 kgdb_break[i].bpt_addr == addr) {
278 breakno = i;
279 break;
280 }
281 }
282
283 if (breakno == -1) {
284 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
285 if (kgdb_break[i].state == BP_UNDEFINED) {
286 breakno = i;
287 break;
288 }
289 }
290 }
291
292 if (breakno == -1)
293 return -E2BIG;
294
295 kgdb_break[breakno].state = BP_SET;
296 kgdb_break[breakno].type = BP_BREAKPOINT;
297 kgdb_break[breakno].bpt_addr = addr;
298
299 return 0;
300}
301
302int dbg_deactivate_sw_breakpoints(void)
303{
304 int error;
305 int ret = 0;
306 int i;
307
308 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
309 if (kgdb_break[i].state != BP_ACTIVE)
310 continue;
311 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
312 if (error) {
313 printk(KERN_INFO "KGDB: BP remove failed: %lx\n",
314 kgdb_break[i].bpt_addr);
315 ret = error;
316 }
317
318 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
319 kgdb_break[i].state = BP_SET;
320 }
321 return ret;
322}
323
324int dbg_remove_sw_break(unsigned long addr)
325{
326 int i;
327
328 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
329 if ((kgdb_break[i].state == BP_SET) &&
330 (kgdb_break[i].bpt_addr == addr)) {
331 kgdb_break[i].state = BP_REMOVED;
332 return 0;
333 }
334 }
335 return -ENOENT;
336}
337
338int kgdb_isremovedbreak(unsigned long addr)
339{
340 int i;
341
342 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
343 if ((kgdb_break[i].state == BP_REMOVED) &&
344 (kgdb_break[i].bpt_addr == addr))
345 return 1;
346 }
347 return 0;
348}
349
350int dbg_remove_all_break(void)
351{
352 int error;
353 int i;
354
355 /* Clear memory breakpoints. */
356 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
357 if (kgdb_break[i].state != BP_ACTIVE)
358 goto setundefined;
359 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
360 if (error)
361 printk(KERN_ERR "KGDB: breakpoint remove failed: %lx\n",
362 kgdb_break[i].bpt_addr);
363setundefined:
364 kgdb_break[i].state = BP_UNDEFINED;
365 }
366
367 /* Clear hardware breakpoints. */
368 if (arch_kgdb_ops.remove_all_hw_break)
369 arch_kgdb_ops.remove_all_hw_break();
370
371 return 0;
372}
373
374/*
375 * Return true if there is a valid kgdb I/O module. Also if no
376 * debugger is attached a message can be printed to the console about
377 * waiting for the debugger to attach.
378 *
379 * The print_wait argument is only to be true when called from inside
380 * the core kgdb_handle_exception, because it will wait for the
381 * debugger to attach.
382 */
383static int kgdb_io_ready(int print_wait)
384{
385 if (!dbg_io_ops)
386 return 0;
387 if (kgdb_connected)
388 return 1;
389 if (atomic_read(&kgdb_setting_breakpoint))
390 return 1;
391 if (print_wait) {
392#ifdef CONFIG_KGDB_KDB
393 if (!dbg_kdb_mode)
394 printk(KERN_CRIT "KGDB: waiting... or $3#33 for KDB\n");
395#else
396 printk(KERN_CRIT "KGDB: Waiting for remote debugger\n");
397#endif
398 }
399 return 1;
400}
401
402static int kgdb_reenter_check(struct kgdb_state *ks)
403{
404 unsigned long addr;
405
406 if (atomic_read(&kgdb_active) != raw_smp_processor_id())
407 return 0;
408
409 /* Panic on recursive debugger calls: */
410 exception_level++;
411 addr = kgdb_arch_pc(ks->ex_vector, ks->linux_regs);
412 dbg_deactivate_sw_breakpoints();
413
414 /*
415 * If the break point removed ok at the place exception
416 * occurred, try to recover and print a warning to the end
417 * user because the user planted a breakpoint in a place that
418 * KGDB needs in order to function.
419 */
420 if (dbg_remove_sw_break(addr) == 0) {
421 exception_level = 0;
422 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
423 dbg_activate_sw_breakpoints();
424 printk(KERN_CRIT "KGDB: re-enter error: breakpoint removed %lx\n",
425 addr);
426 WARN_ON_ONCE(1);
427
428 return 1;
429 }
430 dbg_remove_all_break();
431 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
432
433 if (exception_level > 1) {
434 dump_stack();
435 panic("Recursive entry to debugger");
436 }
437
438 printk(KERN_CRIT "KGDB: re-enter exception: ALL breakpoints killed\n");
439#ifdef CONFIG_KGDB_KDB
440 /* Allow kdb to debug itself one level */
441 return 0;
442#endif
443 dump_stack();
444 panic("Recursive entry to debugger");
445
446 return 1;
447}
448
449static void dbg_touch_watchdogs(void)
450{
451 touch_softlockup_watchdog_sync();
452 clocksource_touch_watchdog();
453 rcu_cpu_stall_reset();
454}
455
456static int kgdb_cpu_enter(struct kgdb_state *ks, struct pt_regs *regs,
457 int exception_state)
458{
459 unsigned long flags;
460 int sstep_tries = 100;
461 int error;
462 int cpu;
463 int trace_on = 0;
464 int online_cpus = num_online_cpus();
465
466 kgdb_info[ks->cpu].enter_kgdb++;
467 kgdb_info[ks->cpu].exception_state |= exception_state;
468
469 if (exception_state == DCPU_WANT_MASTER)
470 atomic_inc(&masters_in_kgdb);
471 else
472 atomic_inc(&slaves_in_kgdb);
473
474 if (arch_kgdb_ops.disable_hw_break)
475 arch_kgdb_ops.disable_hw_break(regs);
476
477acquirelock:
478 /*
479 * Interrupts will be restored by the 'trap return' code, except when
480 * single stepping.
481 */
482 local_irq_save(flags);
483
484 cpu = ks->cpu;
485 kgdb_info[cpu].debuggerinfo = regs;
486 kgdb_info[cpu].task = current;
487 kgdb_info[cpu].ret_state = 0;
488 kgdb_info[cpu].irq_depth = hardirq_count() >> HARDIRQ_SHIFT;
489
490 /* Make sure the above info reaches the primary CPU */
491 smp_mb();
492
493 if (exception_level == 1) {
494 if (raw_spin_trylock(&dbg_master_lock))
495 atomic_xchg(&kgdb_active, cpu);
496 goto cpu_master_loop;
497 }
498
499 /*
500 * CPU will loop if it is a slave or request to become a kgdb
501 * master cpu and acquire the kgdb_active lock:
502 */
503 while (1) {
504cpu_loop:
505 if (kgdb_info[cpu].exception_state & DCPU_NEXT_MASTER) {
506 kgdb_info[cpu].exception_state &= ~DCPU_NEXT_MASTER;
507 goto cpu_master_loop;
508 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_MASTER) {
509 if (raw_spin_trylock(&dbg_master_lock)) {
510 atomic_xchg(&kgdb_active, cpu);
511 break;
512 }
513 } else if (kgdb_info[cpu].exception_state & DCPU_IS_SLAVE) {
514 if (!raw_spin_is_locked(&dbg_slave_lock))
515 goto return_normal;
516 } else {
517return_normal:
518 /* Return to normal operation by executing any
519 * hw breakpoint fixup.
520 */
521 if (arch_kgdb_ops.correct_hw_break)
522 arch_kgdb_ops.correct_hw_break();
523 if (trace_on)
524 tracing_on();
525 kgdb_info[cpu].exception_state &=
526 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
527 kgdb_info[cpu].enter_kgdb--;
528 smp_mb__before_atomic_dec();
529 atomic_dec(&slaves_in_kgdb);
530 dbg_touch_watchdogs();
531 local_irq_restore(flags);
532 return 0;
533 }
534 cpu_relax();
535 }
536
537 /*
538 * For single stepping, try to only enter on the processor
539 * that was single stepping. To guard against a deadlock, the
540 * kernel will only try for the value of sstep_tries before
541 * giving up and continuing on.
542 */
543 if (atomic_read(&kgdb_cpu_doing_single_step) != -1 &&
544 (kgdb_info[cpu].task &&
545 kgdb_info[cpu].task->pid != kgdb_sstep_pid) && --sstep_tries) {
546 atomic_set(&kgdb_active, -1);
547 raw_spin_unlock(&dbg_master_lock);
548 dbg_touch_watchdogs();
549 local_irq_restore(flags);
550
551 goto acquirelock;
552 }
553
554 if (!kgdb_io_ready(1)) {
555 kgdb_info[cpu].ret_state = 1;
556 goto kgdb_restore; /* No I/O connection, resume the system */
557 }
558
559 /*
560 * Don't enter if we have hit a removed breakpoint.
561 */
562 if (kgdb_skipexception(ks->ex_vector, ks->linux_regs))
563 goto kgdb_restore;
564
565 /* Call the I/O driver's pre_exception routine */
566 if (dbg_io_ops->pre_exception)
567 dbg_io_ops->pre_exception();
568
569 /*
570 * Get the passive CPU lock which will hold all the non-primary
571 * CPU in a spin state while the debugger is active
572 */
573 if (!kgdb_single_step)
574 raw_spin_lock(&dbg_slave_lock);
575
576#ifdef CONFIG_SMP
577 /* Signal the other CPUs to enter kgdb_wait() */
578 if ((!kgdb_single_step) && kgdb_do_roundup)
579 kgdb_roundup_cpus(flags);
580#endif
581
582 /*
583 * Wait for the other CPUs to be notified and be waiting for us:
584 */
585 while (kgdb_do_roundup && (atomic_read(&masters_in_kgdb) +
586 atomic_read(&slaves_in_kgdb)) != online_cpus)
587 cpu_relax();
588
589 /*
590 * At this point the primary processor is completely
591 * in the debugger and all secondary CPUs are quiescent
592 */
593 dbg_deactivate_sw_breakpoints();
594 kgdb_single_step = 0;
595 kgdb_contthread = current;
596 exception_level = 0;
597 trace_on = tracing_is_on();
598 if (trace_on)
599 tracing_off();
600
601 while (1) {
602cpu_master_loop:
603 if (dbg_kdb_mode) {
604 kgdb_connected = 1;
605 error = kdb_stub(ks);
606 if (error == -1)
607 continue;
608 kgdb_connected = 0;
609 } else {
610 error = gdb_serial_stub(ks);
611 }
612
613 if (error == DBG_PASS_EVENT) {
614 dbg_kdb_mode = !dbg_kdb_mode;
615 } else if (error == DBG_SWITCH_CPU_EVENT) {
616 kgdb_info[dbg_switch_cpu].exception_state |=
617 DCPU_NEXT_MASTER;
618 goto cpu_loop;
619 } else {
620 kgdb_info[cpu].ret_state = error;
621 break;
622 }
623 }
624
625 /* Call the I/O driver's post_exception routine */
626 if (dbg_io_ops->post_exception)
627 dbg_io_ops->post_exception();
628
629 if (!kgdb_single_step) {
630 raw_spin_unlock(&dbg_slave_lock);
631 /* Wait till all the CPUs have quit from the debugger. */
632 while (kgdb_do_roundup && atomic_read(&slaves_in_kgdb))
633 cpu_relax();
634 }
635
636kgdb_restore:
637 if (atomic_read(&kgdb_cpu_doing_single_step) != -1) {
638 int sstep_cpu = atomic_read(&kgdb_cpu_doing_single_step);
639 if (kgdb_info[sstep_cpu].task)
640 kgdb_sstep_pid = kgdb_info[sstep_cpu].task->pid;
641 else
642 kgdb_sstep_pid = 0;
643 }
644 if (arch_kgdb_ops.correct_hw_break)
645 arch_kgdb_ops.correct_hw_break();
646 if (trace_on)
647 tracing_on();
648
649 kgdb_info[cpu].exception_state &=
650 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
651 kgdb_info[cpu].enter_kgdb--;
652 smp_mb__before_atomic_dec();
653 atomic_dec(&masters_in_kgdb);
654 /* Free kgdb_active */
655 atomic_set(&kgdb_active, -1);
656 raw_spin_unlock(&dbg_master_lock);
657 dbg_touch_watchdogs();
658 local_irq_restore(flags);
659
660 return kgdb_info[cpu].ret_state;
661}
662
663/*
664 * kgdb_handle_exception() - main entry point from a kernel exception
665 *
666 * Locking hierarchy:
667 * interface locks, if any (begin_session)
668 * kgdb lock (kgdb_active)
669 */
670int
671kgdb_handle_exception(int evector, int signo, int ecode, struct pt_regs *regs)
672{
673 struct kgdb_state kgdb_var;
674 struct kgdb_state *ks = &kgdb_var;
675
676 ks->cpu = raw_smp_processor_id();
677 ks->ex_vector = evector;
678 ks->signo = signo;
679 ks->err_code = ecode;
680 ks->kgdb_usethreadid = 0;
681 ks->linux_regs = regs;
682
683 if (kgdb_reenter_check(ks))
684 return 0; /* Ouch, double exception ! */
685 if (kgdb_info[ks->cpu].enter_kgdb != 0)
686 return 0;
687
688 return kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
689}
690
691int kgdb_nmicallback(int cpu, void *regs)
692{
693#ifdef CONFIG_SMP
694 struct kgdb_state kgdb_var;
695 struct kgdb_state *ks = &kgdb_var;
696
697 memset(ks, 0, sizeof(struct kgdb_state));
698 ks->cpu = cpu;
699 ks->linux_regs = regs;
700
701 if (kgdb_info[ks->cpu].enter_kgdb == 0 &&
702 raw_spin_is_locked(&dbg_master_lock)) {
703 kgdb_cpu_enter(ks, regs, DCPU_IS_SLAVE);
704 return 0;
705 }
706#endif
707 return 1;
708}
709
710static void kgdb_console_write(struct console *co, const char *s,
711 unsigned count)
712{
713 unsigned long flags;
714
715 /* If we're debugging, or KGDB has not connected, don't try
716 * and print. */
717 if (!kgdb_connected || atomic_read(&kgdb_active) != -1 || dbg_kdb_mode)
718 return;
719
720 local_irq_save(flags);
721 gdbstub_msg_write(s, count);
722 local_irq_restore(flags);
723}
724
725static struct console kgdbcons = {
726 .name = "kgdb",
727 .write = kgdb_console_write,
728 .flags = CON_PRINTBUFFER | CON_ENABLED,
729 .index = -1,
730};
731
732#ifdef CONFIG_MAGIC_SYSRQ
733static void sysrq_handle_dbg(int key)
734{
735 if (!dbg_io_ops) {
736 printk(KERN_CRIT "ERROR: No KGDB I/O module available\n");
737 return;
738 }
739 if (!kgdb_connected) {
740#ifdef CONFIG_KGDB_KDB
741 if (!dbg_kdb_mode)
742 printk(KERN_CRIT "KGDB or $3#33 for KDB\n");
743#else
744 printk(KERN_CRIT "Entering KGDB\n");
745#endif
746 }
747
748 kgdb_breakpoint();
749}
750
751static struct sysrq_key_op sysrq_dbg_op = {
752 .handler = sysrq_handle_dbg,
753 .help_msg = "debug(G)",
754 .action_msg = "DEBUG",
755};
756#endif
757
758static int kgdb_panic_event(struct notifier_block *self,
759 unsigned long val,
760 void *data)
761{
762 if (dbg_kdb_mode)
763 kdb_printf("PANIC: %s\n", (char *)data);
764 kgdb_breakpoint();
765 return NOTIFY_DONE;
766}
767
768static struct notifier_block kgdb_panic_event_nb = {
769 .notifier_call = kgdb_panic_event,
770 .priority = INT_MAX,
771};
772
773void __weak kgdb_arch_late(void)
774{
775}
776
777void __init dbg_late_init(void)
778{
779 dbg_is_early = false;
780 if (kgdb_io_module_registered)
781 kgdb_arch_late();
782 kdb_init(KDB_INIT_FULL);
783}
784
785static int
786dbg_notify_reboot(struct notifier_block *this, unsigned long code, void *x)
787{
788 /*
789 * Take the following action on reboot notify depending on value:
790 * 1 == Enter debugger
791 * 0 == [the default] detatch debug client
792 * -1 == Do nothing... and use this until the board resets
793 */
794 switch (kgdbreboot) {
795 case 1:
796 kgdb_breakpoint();
797 case -1:
798 goto done;
799 }
800 if (!dbg_kdb_mode)
801 gdbstub_exit(code);
802done:
803 return NOTIFY_DONE;
804}
805
806static struct notifier_block dbg_reboot_notifier = {
807 .notifier_call = dbg_notify_reboot,
808 .next = NULL,
809 .priority = INT_MAX,
810};
811
812static void kgdb_register_callbacks(void)
813{
814 if (!kgdb_io_module_registered) {
815 kgdb_io_module_registered = 1;
816 kgdb_arch_init();
817 if (!dbg_is_early)
818 kgdb_arch_late();
819 register_reboot_notifier(&dbg_reboot_notifier);
820 atomic_notifier_chain_register(&panic_notifier_list,
821 &kgdb_panic_event_nb);
822#ifdef CONFIG_MAGIC_SYSRQ
823 register_sysrq_key('g', &sysrq_dbg_op);
824#endif
825 if (kgdb_use_con && !kgdb_con_registered) {
826 register_console(&kgdbcons);
827 kgdb_con_registered = 1;
828 }
829 }
830}
831
832static void kgdb_unregister_callbacks(void)
833{
834 /*
835 * When this routine is called KGDB should unregister from the
836 * panic handler and clean up, making sure it is not handling any
837 * break exceptions at the time.
838 */
839 if (kgdb_io_module_registered) {
840 kgdb_io_module_registered = 0;
841 unregister_reboot_notifier(&dbg_reboot_notifier);
842 atomic_notifier_chain_unregister(&panic_notifier_list,
843 &kgdb_panic_event_nb);
844 kgdb_arch_exit();
845#ifdef CONFIG_MAGIC_SYSRQ
846 unregister_sysrq_key('g', &sysrq_dbg_op);
847#endif
848 if (kgdb_con_registered) {
849 unregister_console(&kgdbcons);
850 kgdb_con_registered = 0;
851 }
852 }
853}
854
855/*
856 * There are times a tasklet needs to be used vs a compiled in
857 * break point so as to cause an exception outside a kgdb I/O module,
858 * such as is the case with kgdboe, where calling a breakpoint in the
859 * I/O driver itself would be fatal.
860 */
861static void kgdb_tasklet_bpt(unsigned long ing)
862{
863 kgdb_breakpoint();
864 atomic_set(&kgdb_break_tasklet_var, 0);
865}
866
867static DECLARE_TASKLET(kgdb_tasklet_breakpoint, kgdb_tasklet_bpt, 0);
868
869void kgdb_schedule_breakpoint(void)
870{
871 if (atomic_read(&kgdb_break_tasklet_var) ||
872 atomic_read(&kgdb_active) != -1 ||
873 atomic_read(&kgdb_setting_breakpoint))
874 return;
875 atomic_inc(&kgdb_break_tasklet_var);
876 tasklet_schedule(&kgdb_tasklet_breakpoint);
877}
878EXPORT_SYMBOL_GPL(kgdb_schedule_breakpoint);
879
880static void kgdb_initial_breakpoint(void)
881{
882 kgdb_break_asap = 0;
883
884 printk(KERN_CRIT "kgdb: Waiting for connection from remote gdb...\n");
885 kgdb_breakpoint();
886}
887
888/**
889 * kgdb_register_io_module - register KGDB IO module
890 * @new_dbg_io_ops: the io ops vector
891 *
892 * Register it with the KGDB core.
893 */
894int kgdb_register_io_module(struct kgdb_io *new_dbg_io_ops)
895{
896 int err;
897
898 spin_lock(&kgdb_registration_lock);
899
900 if (dbg_io_ops) {
901 spin_unlock(&kgdb_registration_lock);
902
903 printk(KERN_ERR "kgdb: Another I/O driver is already "
904 "registered with KGDB.\n");
905 return -EBUSY;
906 }
907
908 if (new_dbg_io_ops->init) {
909 err = new_dbg_io_ops->init();
910 if (err) {
911 spin_unlock(&kgdb_registration_lock);
912 return err;
913 }
914 }
915
916 dbg_io_ops = new_dbg_io_ops;
917
918 spin_unlock(&kgdb_registration_lock);
919
920 printk(KERN_INFO "kgdb: Registered I/O driver %s.\n",
921 new_dbg_io_ops->name);
922
923 /* Arm KGDB now. */
924 kgdb_register_callbacks();
925
926 if (kgdb_break_asap)
927 kgdb_initial_breakpoint();
928
929 return 0;
930}
931EXPORT_SYMBOL_GPL(kgdb_register_io_module);
932
933/**
934 * kkgdb_unregister_io_module - unregister KGDB IO module
935 * @old_dbg_io_ops: the io ops vector
936 *
937 * Unregister it with the KGDB core.
938 */
939void kgdb_unregister_io_module(struct kgdb_io *old_dbg_io_ops)
940{
941 BUG_ON(kgdb_connected);
942
943 /*
944 * KGDB is no longer able to communicate out, so
945 * unregister our callbacks and reset state.
946 */
947 kgdb_unregister_callbacks();
948
949 spin_lock(&kgdb_registration_lock);
950
951 WARN_ON_ONCE(dbg_io_ops != old_dbg_io_ops);
952 dbg_io_ops = NULL;
953
954 spin_unlock(&kgdb_registration_lock);
955
956 printk(KERN_INFO
957 "kgdb: Unregistered I/O driver %s, debugger disabled.\n",
958 old_dbg_io_ops->name);
959}
960EXPORT_SYMBOL_GPL(kgdb_unregister_io_module);
961
962int dbg_io_get_char(void)
963{
964 int ret = dbg_io_ops->read_char();
965 if (ret == NO_POLL_CHAR)
966 return -1;
967 if (!dbg_kdb_mode)
968 return ret;
969 if (ret == 127)
970 return 8;
971 return ret;
972}
973
974/**
975 * kgdb_breakpoint - generate breakpoint exception
976 *
977 * This function will generate a breakpoint exception. It is used at the
978 * beginning of a program to sync up with a debugger and can be used
979 * otherwise as a quick means to stop program execution and "break" into
980 * the debugger.
981 */
982void kgdb_breakpoint(void)
983{
984 atomic_inc(&kgdb_setting_breakpoint);
985 wmb(); /* Sync point before breakpoint */
986 arch_kgdb_breakpoint();
987 wmb(); /* Sync point after breakpoint */
988 atomic_dec(&kgdb_setting_breakpoint);
989}
990EXPORT_SYMBOL_GPL(kgdb_breakpoint);
991
992static int __init opt_kgdb_wait(char *str)
993{
994 kgdb_break_asap = 1;
995
996 kdb_init(KDB_INIT_EARLY);
997 if (kgdb_io_module_registered)
998 kgdb_initial_breakpoint();
999
1000 return 0;
1001}
1002
1003early_param("kgdbwait", opt_kgdb_wait);
1/*
2 * Kernel Debug Core
3 *
4 * Maintainer: Jason Wessel <jason.wessel@windriver.com>
5 *
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>
15 *
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.
22 *
23 * Original KGDB stub: David Grothe <dave@gcom.com>,
24 * Tigran Aivazian <tigran@sco.com>
25 *
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.
29 */
30
31#define pr_fmt(fmt) "KGDB: " fmt
32
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>
55#include <linux/mm.h>
56#include <linux/vmacache.h>
57#include <linux/rcupdate.h>
58#include <linux/irq.h>
59
60#include <asm/cacheflush.h>
61#include <asm/byteorder.h>
62#include <linux/atomic.h>
63
64#include "debug_core.h"
65
66static int kgdb_break_asap;
67
68struct debuggerinfo_struct kgdb_info[NR_CPUS];
69
70/* kgdb_connected - Is a host GDB connected to us? */
71int kgdb_connected;
72EXPORT_SYMBOL_GPL(kgdb_connected);
73
74/* All the KGDB handlers are installed */
75int kgdb_io_module_registered;
76
77/* Guard for recursive entry */
78static int exception_level;
79
80struct kgdb_io *dbg_io_ops;
81static DEFINE_SPINLOCK(kgdb_registration_lock);
82
83/* Action for the reboot notifiter, a global allow kdb to change it */
84static int kgdbreboot;
85/* kgdb console driver is loaded */
86static int kgdb_con_registered;
87/* determine if kgdb console output should be used */
88static int kgdb_use_con;
89/* Flag for alternate operations for early debugging */
90bool dbg_is_early = true;
91/* Next cpu to become the master debug core */
92int dbg_switch_cpu;
93
94/* Use kdb or gdbserver mode */
95int dbg_kdb_mode = 1;
96
97static int __init opt_kgdb_con(char *str)
98{
99 kgdb_use_con = 1;
100 return 0;
101}
102
103early_param("kgdbcon", opt_kgdb_con);
104
105module_param(kgdb_use_con, int, 0644);
106module_param(kgdbreboot, int, 0644);
107
108/*
109 * Holds information about breakpoints in a kernel. These breakpoints are
110 * added and removed by gdb.
111 */
112static struct kgdb_bkpt kgdb_break[KGDB_MAX_BREAKPOINTS] = {
113 [0 ... KGDB_MAX_BREAKPOINTS-1] = { .state = BP_UNDEFINED }
114};
115
116/*
117 * The CPU# of the active CPU, or -1 if none:
118 */
119atomic_t kgdb_active = ATOMIC_INIT(-1);
120EXPORT_SYMBOL_GPL(kgdb_active);
121static DEFINE_RAW_SPINLOCK(dbg_master_lock);
122static DEFINE_RAW_SPINLOCK(dbg_slave_lock);
123
124/*
125 * We use NR_CPUs not PERCPU, in case kgdb is used to debug early
126 * bootup code (which might not have percpu set up yet):
127 */
128static atomic_t masters_in_kgdb;
129static atomic_t slaves_in_kgdb;
130static atomic_t kgdb_break_tasklet_var;
131atomic_t kgdb_setting_breakpoint;
132
133struct task_struct *kgdb_usethread;
134struct task_struct *kgdb_contthread;
135
136int kgdb_single_step;
137static pid_t kgdb_sstep_pid;
138
139/* to keep track of the CPU which is doing the single stepping*/
140atomic_t kgdb_cpu_doing_single_step = ATOMIC_INIT(-1);
141
142/*
143 * If you are debugging a problem where roundup (the collection of
144 * all other CPUs) is a problem [this should be extremely rare],
145 * then use the nokgdbroundup option to avoid roundup. In that case
146 * the other CPUs might interfere with your debugging context, so
147 * use this with care:
148 */
149static int kgdb_do_roundup = 1;
150
151static int __init opt_nokgdbroundup(char *str)
152{
153 kgdb_do_roundup = 0;
154
155 return 0;
156}
157
158early_param("nokgdbroundup", opt_nokgdbroundup);
159
160/*
161 * Finally, some KGDB code :-)
162 */
163
164/*
165 * Weak aliases for breakpoint management,
166 * can be overriden by architectures when needed:
167 */
168int __weak kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt)
169{
170 int err;
171
172 err = copy_from_kernel_nofault(bpt->saved_instr, (char *)bpt->bpt_addr,
173 BREAK_INSTR_SIZE);
174 if (err)
175 return err;
176 err = copy_to_kernel_nofault((char *)bpt->bpt_addr,
177 arch_kgdb_ops.gdb_bpt_instr, BREAK_INSTR_SIZE);
178 return err;
179}
180
181int __weak kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt)
182{
183 return copy_to_kernel_nofault((char *)bpt->bpt_addr,
184 (char *)bpt->saved_instr, BREAK_INSTR_SIZE);
185}
186
187int __weak kgdb_validate_break_address(unsigned long addr)
188{
189 struct kgdb_bkpt tmp;
190 int err;
191 /* Validate setting the breakpoint and then removing it. If the
192 * remove fails, the kernel needs to emit a bad message because we
193 * are deep trouble not being able to put things back the way we
194 * found them.
195 */
196 tmp.bpt_addr = addr;
197 err = kgdb_arch_set_breakpoint(&tmp);
198 if (err)
199 return err;
200 err = kgdb_arch_remove_breakpoint(&tmp);
201 if (err)
202 pr_err("Critical breakpoint error, kernel memory destroyed at: %lx\n",
203 addr);
204 return err;
205}
206
207unsigned long __weak kgdb_arch_pc(int exception, struct pt_regs *regs)
208{
209 return instruction_pointer(regs);
210}
211
212int __weak kgdb_arch_init(void)
213{
214 return 0;
215}
216
217int __weak kgdb_skipexception(int exception, struct pt_regs *regs)
218{
219 return 0;
220}
221
222#ifdef CONFIG_SMP
223
224/*
225 * Default (weak) implementation for kgdb_roundup_cpus
226 */
227
228static DEFINE_PER_CPU(call_single_data_t, kgdb_roundup_csd);
229
230void __weak kgdb_call_nmi_hook(void *ignored)
231{
232 /*
233 * NOTE: get_irq_regs() is supposed to get the registers from
234 * before the IPI interrupt happened and so is supposed to
235 * show where the processor was. In some situations it's
236 * possible we might be called without an IPI, so it might be
237 * safer to figure out how to make kgdb_breakpoint() work
238 * properly here.
239 */
240 kgdb_nmicallback(raw_smp_processor_id(), get_irq_regs());
241}
242
243void __weak kgdb_roundup_cpus(void)
244{
245 call_single_data_t *csd;
246 int this_cpu = raw_smp_processor_id();
247 int cpu;
248 int ret;
249
250 for_each_online_cpu(cpu) {
251 /* No need to roundup ourselves */
252 if (cpu == this_cpu)
253 continue;
254
255 csd = &per_cpu(kgdb_roundup_csd, cpu);
256
257 /*
258 * If it didn't round up last time, don't try again
259 * since smp_call_function_single_async() will block.
260 *
261 * If rounding_up is false then we know that the
262 * previous call must have at least started and that
263 * means smp_call_function_single_async() won't block.
264 */
265 if (kgdb_info[cpu].rounding_up)
266 continue;
267 kgdb_info[cpu].rounding_up = true;
268
269 csd->func = kgdb_call_nmi_hook;
270 ret = smp_call_function_single_async(cpu, csd);
271 if (ret)
272 kgdb_info[cpu].rounding_up = false;
273 }
274}
275
276#endif
277
278/*
279 * Some architectures need cache flushes when we set/clear a
280 * breakpoint:
281 */
282static void kgdb_flush_swbreak_addr(unsigned long addr)
283{
284 if (!CACHE_FLUSH_IS_SAFE)
285 return;
286
287 if (current->mm) {
288 int i;
289
290 for (i = 0; i < VMACACHE_SIZE; i++) {
291 if (!current->vmacache.vmas[i])
292 continue;
293 flush_cache_range(current->vmacache.vmas[i],
294 addr, addr + BREAK_INSTR_SIZE);
295 }
296 }
297
298 /* Force flush instruction cache if it was outside the mm */
299 flush_icache_range(addr, addr + BREAK_INSTR_SIZE);
300}
301
302/*
303 * SW breakpoint management:
304 */
305int dbg_activate_sw_breakpoints(void)
306{
307 int error;
308 int ret = 0;
309 int i;
310
311 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
312 if (kgdb_break[i].state != BP_SET)
313 continue;
314
315 error = kgdb_arch_set_breakpoint(&kgdb_break[i]);
316 if (error) {
317 ret = error;
318 pr_info("BP install failed: %lx\n",
319 kgdb_break[i].bpt_addr);
320 continue;
321 }
322
323 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
324 kgdb_break[i].state = BP_ACTIVE;
325 }
326 return ret;
327}
328
329int dbg_set_sw_break(unsigned long addr)
330{
331 int err = kgdb_validate_break_address(addr);
332 int breakno = -1;
333 int i;
334
335 if (err)
336 return err;
337
338 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
339 if ((kgdb_break[i].state == BP_SET) &&
340 (kgdb_break[i].bpt_addr == addr))
341 return -EEXIST;
342 }
343 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
344 if (kgdb_break[i].state == BP_REMOVED &&
345 kgdb_break[i].bpt_addr == addr) {
346 breakno = i;
347 break;
348 }
349 }
350
351 if (breakno == -1) {
352 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
353 if (kgdb_break[i].state == BP_UNDEFINED) {
354 breakno = i;
355 break;
356 }
357 }
358 }
359
360 if (breakno == -1)
361 return -E2BIG;
362
363 kgdb_break[breakno].state = BP_SET;
364 kgdb_break[breakno].type = BP_BREAKPOINT;
365 kgdb_break[breakno].bpt_addr = addr;
366
367 return 0;
368}
369
370int dbg_deactivate_sw_breakpoints(void)
371{
372 int error;
373 int ret = 0;
374 int i;
375
376 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
377 if (kgdb_break[i].state != BP_ACTIVE)
378 continue;
379 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
380 if (error) {
381 pr_info("BP remove failed: %lx\n",
382 kgdb_break[i].bpt_addr);
383 ret = error;
384 }
385
386 kgdb_flush_swbreak_addr(kgdb_break[i].bpt_addr);
387 kgdb_break[i].state = BP_SET;
388 }
389 return ret;
390}
391
392int dbg_remove_sw_break(unsigned long addr)
393{
394 int i;
395
396 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
397 if ((kgdb_break[i].state == BP_SET) &&
398 (kgdb_break[i].bpt_addr == addr)) {
399 kgdb_break[i].state = BP_REMOVED;
400 return 0;
401 }
402 }
403 return -ENOENT;
404}
405
406int kgdb_isremovedbreak(unsigned long addr)
407{
408 int i;
409
410 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
411 if ((kgdb_break[i].state == BP_REMOVED) &&
412 (kgdb_break[i].bpt_addr == addr))
413 return 1;
414 }
415 return 0;
416}
417
418int kgdb_has_hit_break(unsigned long addr)
419{
420 int i;
421
422 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
423 if (kgdb_break[i].state == BP_ACTIVE &&
424 kgdb_break[i].bpt_addr == addr)
425 return 1;
426 }
427 return 0;
428}
429
430int dbg_remove_all_break(void)
431{
432 int error;
433 int i;
434
435 /* Clear memory breakpoints. */
436 for (i = 0; i < KGDB_MAX_BREAKPOINTS; i++) {
437 if (kgdb_break[i].state != BP_ACTIVE)
438 goto setundefined;
439 error = kgdb_arch_remove_breakpoint(&kgdb_break[i]);
440 if (error)
441 pr_err("breakpoint remove failed: %lx\n",
442 kgdb_break[i].bpt_addr);
443setundefined:
444 kgdb_break[i].state = BP_UNDEFINED;
445 }
446
447 /* Clear hardware breakpoints. */
448 if (arch_kgdb_ops.remove_all_hw_break)
449 arch_kgdb_ops.remove_all_hw_break();
450
451 return 0;
452}
453
454#ifdef CONFIG_KGDB_KDB
455void kdb_dump_stack_on_cpu(int cpu)
456{
457 if (cpu == raw_smp_processor_id() || !IS_ENABLED(CONFIG_SMP)) {
458 dump_stack();
459 return;
460 }
461
462 if (!(kgdb_info[cpu].exception_state & DCPU_IS_SLAVE)) {
463 kdb_printf("ERROR: Task on cpu %d didn't stop in the debugger\n",
464 cpu);
465 return;
466 }
467
468 /*
469 * In general, architectures don't support dumping the stack of a
470 * "running" process that's not the current one. From the point of
471 * view of the Linux, kernel processes that are looping in the kgdb
472 * slave loop are still "running". There's also no API (that actually
473 * works across all architectures) that can do a stack crawl based
474 * on registers passed as a parameter.
475 *
476 * Solve this conundrum by asking slave CPUs to do the backtrace
477 * themselves.
478 */
479 kgdb_info[cpu].exception_state |= DCPU_WANT_BT;
480 while (kgdb_info[cpu].exception_state & DCPU_WANT_BT)
481 cpu_relax();
482}
483#endif
484
485/*
486 * Return true if there is a valid kgdb I/O module. Also if no
487 * debugger is attached a message can be printed to the console about
488 * waiting for the debugger to attach.
489 *
490 * The print_wait argument is only to be true when called from inside
491 * the core kgdb_handle_exception, because it will wait for the
492 * debugger to attach.
493 */
494static int kgdb_io_ready(int print_wait)
495{
496 if (!dbg_io_ops)
497 return 0;
498 if (kgdb_connected)
499 return 1;
500 if (atomic_read(&kgdb_setting_breakpoint))
501 return 1;
502 if (print_wait) {
503#ifdef CONFIG_KGDB_KDB
504 if (!dbg_kdb_mode)
505 pr_crit("waiting... or $3#33 for KDB\n");
506#else
507 pr_crit("Waiting for remote debugger\n");
508#endif
509 }
510 return 1;
511}
512
513static int kgdb_reenter_check(struct kgdb_state *ks)
514{
515 unsigned long addr;
516
517 if (atomic_read(&kgdb_active) != raw_smp_processor_id())
518 return 0;
519
520 /* Panic on recursive debugger calls: */
521 exception_level++;
522 addr = kgdb_arch_pc(ks->ex_vector, ks->linux_regs);
523 dbg_deactivate_sw_breakpoints();
524
525 /*
526 * If the break point removed ok at the place exception
527 * occurred, try to recover and print a warning to the end
528 * user because the user planted a breakpoint in a place that
529 * KGDB needs in order to function.
530 */
531 if (dbg_remove_sw_break(addr) == 0) {
532 exception_level = 0;
533 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
534 dbg_activate_sw_breakpoints();
535 pr_crit("re-enter error: breakpoint removed %lx\n", addr);
536 WARN_ON_ONCE(1);
537
538 return 1;
539 }
540 dbg_remove_all_break();
541 kgdb_skipexception(ks->ex_vector, ks->linux_regs);
542
543 if (exception_level > 1) {
544 dump_stack();
545 kgdb_io_module_registered = false;
546 panic("Recursive entry to debugger");
547 }
548
549 pr_crit("re-enter exception: ALL breakpoints killed\n");
550#ifdef CONFIG_KGDB_KDB
551 /* Allow kdb to debug itself one level */
552 return 0;
553#endif
554 dump_stack();
555 panic("Recursive entry to debugger");
556
557 return 1;
558}
559
560static void dbg_touch_watchdogs(void)
561{
562 touch_softlockup_watchdog_sync();
563 clocksource_touch_watchdog();
564 rcu_cpu_stall_reset();
565}
566
567static int kgdb_cpu_enter(struct kgdb_state *ks, struct pt_regs *regs,
568 int exception_state)
569{
570 unsigned long flags;
571 int sstep_tries = 100;
572 int error;
573 int cpu;
574 int trace_on = 0;
575 int online_cpus = num_online_cpus();
576 u64 time_left;
577
578 kgdb_info[ks->cpu].enter_kgdb++;
579 kgdb_info[ks->cpu].exception_state |= exception_state;
580
581 if (exception_state == DCPU_WANT_MASTER)
582 atomic_inc(&masters_in_kgdb);
583 else
584 atomic_inc(&slaves_in_kgdb);
585
586 if (arch_kgdb_ops.disable_hw_break)
587 arch_kgdb_ops.disable_hw_break(regs);
588
589acquirelock:
590 rcu_read_lock();
591 /*
592 * Interrupts will be restored by the 'trap return' code, except when
593 * single stepping.
594 */
595 local_irq_save(flags);
596
597 cpu = ks->cpu;
598 kgdb_info[cpu].debuggerinfo = regs;
599 kgdb_info[cpu].task = current;
600 kgdb_info[cpu].ret_state = 0;
601 kgdb_info[cpu].irq_depth = hardirq_count() >> HARDIRQ_SHIFT;
602
603 /* Make sure the above info reaches the primary CPU */
604 smp_mb();
605
606 if (exception_level == 1) {
607 if (raw_spin_trylock(&dbg_master_lock))
608 atomic_xchg(&kgdb_active, cpu);
609 goto cpu_master_loop;
610 }
611
612 /*
613 * CPU will loop if it is a slave or request to become a kgdb
614 * master cpu and acquire the kgdb_active lock:
615 */
616 while (1) {
617cpu_loop:
618 if (kgdb_info[cpu].exception_state & DCPU_NEXT_MASTER) {
619 kgdb_info[cpu].exception_state &= ~DCPU_NEXT_MASTER;
620 goto cpu_master_loop;
621 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_MASTER) {
622 if (raw_spin_trylock(&dbg_master_lock)) {
623 atomic_xchg(&kgdb_active, cpu);
624 break;
625 }
626 } else if (kgdb_info[cpu].exception_state & DCPU_WANT_BT) {
627 dump_stack();
628 kgdb_info[cpu].exception_state &= ~DCPU_WANT_BT;
629 } else if (kgdb_info[cpu].exception_state & DCPU_IS_SLAVE) {
630 if (!raw_spin_is_locked(&dbg_slave_lock))
631 goto return_normal;
632 } else {
633return_normal:
634 /* Return to normal operation by executing any
635 * hw breakpoint fixup.
636 */
637 if (arch_kgdb_ops.correct_hw_break)
638 arch_kgdb_ops.correct_hw_break();
639 if (trace_on)
640 tracing_on();
641 kgdb_info[cpu].debuggerinfo = NULL;
642 kgdb_info[cpu].task = NULL;
643 kgdb_info[cpu].exception_state &=
644 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
645 kgdb_info[cpu].enter_kgdb--;
646 smp_mb__before_atomic();
647 atomic_dec(&slaves_in_kgdb);
648 dbg_touch_watchdogs();
649 local_irq_restore(flags);
650 rcu_read_unlock();
651 return 0;
652 }
653 cpu_relax();
654 }
655
656 /*
657 * For single stepping, try to only enter on the processor
658 * that was single stepping. To guard against a deadlock, the
659 * kernel will only try for the value of sstep_tries before
660 * giving up and continuing on.
661 */
662 if (atomic_read(&kgdb_cpu_doing_single_step) != -1 &&
663 (kgdb_info[cpu].task &&
664 kgdb_info[cpu].task->pid != kgdb_sstep_pid) && --sstep_tries) {
665 atomic_set(&kgdb_active, -1);
666 raw_spin_unlock(&dbg_master_lock);
667 dbg_touch_watchdogs();
668 local_irq_restore(flags);
669 rcu_read_unlock();
670
671 goto acquirelock;
672 }
673
674 if (!kgdb_io_ready(1)) {
675 kgdb_info[cpu].ret_state = 1;
676 goto kgdb_restore; /* No I/O connection, resume the system */
677 }
678
679 /*
680 * Don't enter if we have hit a removed breakpoint.
681 */
682 if (kgdb_skipexception(ks->ex_vector, ks->linux_regs))
683 goto kgdb_restore;
684
685 atomic_inc(&ignore_console_lock_warning);
686
687 /* Call the I/O driver's pre_exception routine */
688 if (dbg_io_ops->pre_exception)
689 dbg_io_ops->pre_exception();
690
691 /*
692 * Get the passive CPU lock which will hold all the non-primary
693 * CPU in a spin state while the debugger is active
694 */
695 if (!kgdb_single_step)
696 raw_spin_lock(&dbg_slave_lock);
697
698#ifdef CONFIG_SMP
699 /* If send_ready set, slaves are already waiting */
700 if (ks->send_ready)
701 atomic_set(ks->send_ready, 1);
702
703 /* Signal the other CPUs to enter kgdb_wait() */
704 else if ((!kgdb_single_step) && kgdb_do_roundup)
705 kgdb_roundup_cpus();
706#endif
707
708 /*
709 * Wait for the other CPUs to be notified and be waiting for us:
710 */
711 time_left = MSEC_PER_SEC;
712 while (kgdb_do_roundup && --time_left &&
713 (atomic_read(&masters_in_kgdb) + atomic_read(&slaves_in_kgdb)) !=
714 online_cpus)
715 udelay(1000);
716 if (!time_left)
717 pr_crit("Timed out waiting for secondary CPUs.\n");
718
719 /*
720 * At this point the primary processor is completely
721 * in the debugger and all secondary CPUs are quiescent
722 */
723 dbg_deactivate_sw_breakpoints();
724 kgdb_single_step = 0;
725 kgdb_contthread = current;
726 exception_level = 0;
727 trace_on = tracing_is_on();
728 if (trace_on)
729 tracing_off();
730
731 while (1) {
732cpu_master_loop:
733 if (dbg_kdb_mode) {
734 kgdb_connected = 1;
735 error = kdb_stub(ks);
736 if (error == -1)
737 continue;
738 kgdb_connected = 0;
739 } else {
740 error = gdb_serial_stub(ks);
741 }
742
743 if (error == DBG_PASS_EVENT) {
744 dbg_kdb_mode = !dbg_kdb_mode;
745 } else if (error == DBG_SWITCH_CPU_EVENT) {
746 kgdb_info[dbg_switch_cpu].exception_state |=
747 DCPU_NEXT_MASTER;
748 goto cpu_loop;
749 } else {
750 kgdb_info[cpu].ret_state = error;
751 break;
752 }
753 }
754
755 /* Call the I/O driver's post_exception routine */
756 if (dbg_io_ops->post_exception)
757 dbg_io_ops->post_exception();
758
759 atomic_dec(&ignore_console_lock_warning);
760
761 if (!kgdb_single_step) {
762 raw_spin_unlock(&dbg_slave_lock);
763 /* Wait till all the CPUs have quit from the debugger. */
764 while (kgdb_do_roundup && atomic_read(&slaves_in_kgdb))
765 cpu_relax();
766 }
767
768kgdb_restore:
769 if (atomic_read(&kgdb_cpu_doing_single_step) != -1) {
770 int sstep_cpu = atomic_read(&kgdb_cpu_doing_single_step);
771 if (kgdb_info[sstep_cpu].task)
772 kgdb_sstep_pid = kgdb_info[sstep_cpu].task->pid;
773 else
774 kgdb_sstep_pid = 0;
775 }
776 if (arch_kgdb_ops.correct_hw_break)
777 arch_kgdb_ops.correct_hw_break();
778 if (trace_on)
779 tracing_on();
780
781 kgdb_info[cpu].debuggerinfo = NULL;
782 kgdb_info[cpu].task = NULL;
783 kgdb_info[cpu].exception_state &=
784 ~(DCPU_WANT_MASTER | DCPU_IS_SLAVE);
785 kgdb_info[cpu].enter_kgdb--;
786 smp_mb__before_atomic();
787 atomic_dec(&masters_in_kgdb);
788 /* Free kgdb_active */
789 atomic_set(&kgdb_active, -1);
790 raw_spin_unlock(&dbg_master_lock);
791 dbg_touch_watchdogs();
792 local_irq_restore(flags);
793 rcu_read_unlock();
794
795 return kgdb_info[cpu].ret_state;
796}
797
798/*
799 * kgdb_handle_exception() - main entry point from a kernel exception
800 *
801 * Locking hierarchy:
802 * interface locks, if any (begin_session)
803 * kgdb lock (kgdb_active)
804 */
805int
806kgdb_handle_exception(int evector, int signo, int ecode, struct pt_regs *regs)
807{
808 struct kgdb_state kgdb_var;
809 struct kgdb_state *ks = &kgdb_var;
810 int ret = 0;
811
812 if (arch_kgdb_ops.enable_nmi)
813 arch_kgdb_ops.enable_nmi(0);
814 /*
815 * Avoid entering the debugger if we were triggered due to an oops
816 * but panic_timeout indicates the system should automatically
817 * reboot on panic. We don't want to get stuck waiting for input
818 * on such systems, especially if its "just" an oops.
819 */
820 if (signo != SIGTRAP && panic_timeout)
821 return 1;
822
823 memset(ks, 0, sizeof(struct kgdb_state));
824 ks->cpu = raw_smp_processor_id();
825 ks->ex_vector = evector;
826 ks->signo = signo;
827 ks->err_code = ecode;
828 ks->linux_regs = regs;
829
830 if (kgdb_reenter_check(ks))
831 goto out; /* Ouch, double exception ! */
832 if (kgdb_info[ks->cpu].enter_kgdb != 0)
833 goto out;
834
835 ret = kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
836out:
837 if (arch_kgdb_ops.enable_nmi)
838 arch_kgdb_ops.enable_nmi(1);
839 return ret;
840}
841
842/*
843 * GDB places a breakpoint at this function to know dynamically loaded objects.
844 */
845static int module_event(struct notifier_block *self, unsigned long val,
846 void *data)
847{
848 return 0;
849}
850
851static struct notifier_block dbg_module_load_nb = {
852 .notifier_call = module_event,
853};
854
855int kgdb_nmicallback(int cpu, void *regs)
856{
857#ifdef CONFIG_SMP
858 struct kgdb_state kgdb_var;
859 struct kgdb_state *ks = &kgdb_var;
860
861 kgdb_info[cpu].rounding_up = false;
862
863 memset(ks, 0, sizeof(struct kgdb_state));
864 ks->cpu = cpu;
865 ks->linux_regs = regs;
866
867 if (kgdb_info[ks->cpu].enter_kgdb == 0 &&
868 raw_spin_is_locked(&dbg_master_lock)) {
869 kgdb_cpu_enter(ks, regs, DCPU_IS_SLAVE);
870 return 0;
871 }
872#endif
873 return 1;
874}
875
876int kgdb_nmicallin(int cpu, int trapnr, void *regs, int err_code,
877 atomic_t *send_ready)
878{
879#ifdef CONFIG_SMP
880 if (!kgdb_io_ready(0) || !send_ready)
881 return 1;
882
883 if (kgdb_info[cpu].enter_kgdb == 0) {
884 struct kgdb_state kgdb_var;
885 struct kgdb_state *ks = &kgdb_var;
886
887 memset(ks, 0, sizeof(struct kgdb_state));
888 ks->cpu = cpu;
889 ks->ex_vector = trapnr;
890 ks->signo = SIGTRAP;
891 ks->err_code = err_code;
892 ks->linux_regs = regs;
893 ks->send_ready = send_ready;
894 kgdb_cpu_enter(ks, regs, DCPU_WANT_MASTER);
895 return 0;
896 }
897#endif
898 return 1;
899}
900
901static void kgdb_console_write(struct console *co, const char *s,
902 unsigned count)
903{
904 unsigned long flags;
905
906 /* If we're debugging, or KGDB has not connected, don't try
907 * and print. */
908 if (!kgdb_connected || atomic_read(&kgdb_active) != -1 || dbg_kdb_mode)
909 return;
910
911 local_irq_save(flags);
912 gdbstub_msg_write(s, count);
913 local_irq_restore(flags);
914}
915
916static struct console kgdbcons = {
917 .name = "kgdb",
918 .write = kgdb_console_write,
919 .flags = CON_PRINTBUFFER | CON_ENABLED,
920 .index = -1,
921};
922
923#ifdef CONFIG_MAGIC_SYSRQ
924static void sysrq_handle_dbg(int key)
925{
926 if (!dbg_io_ops) {
927 pr_crit("ERROR: No KGDB I/O module available\n");
928 return;
929 }
930 if (!kgdb_connected) {
931#ifdef CONFIG_KGDB_KDB
932 if (!dbg_kdb_mode)
933 pr_crit("KGDB or $3#33 for KDB\n");
934#else
935 pr_crit("Entering KGDB\n");
936#endif
937 }
938
939 kgdb_breakpoint();
940}
941
942static const struct sysrq_key_op sysrq_dbg_op = {
943 .handler = sysrq_handle_dbg,
944 .help_msg = "debug(g)",
945 .action_msg = "DEBUG",
946};
947#endif
948
949void kgdb_panic(const char *msg)
950{
951 if (!kgdb_io_module_registered)
952 return;
953
954 /*
955 * We don't want to get stuck waiting for input from user if
956 * "panic_timeout" indicates the system should automatically
957 * reboot on panic.
958 */
959 if (panic_timeout)
960 return;
961
962 if (dbg_kdb_mode)
963 kdb_printf("PANIC: %s\n", msg);
964
965 kgdb_breakpoint();
966}
967
968static void kgdb_initial_breakpoint(void)
969{
970 kgdb_break_asap = 0;
971
972 pr_crit("Waiting for connection from remote gdb...\n");
973 kgdb_breakpoint();
974}
975
976void __weak kgdb_arch_late(void)
977{
978}
979
980void __init dbg_late_init(void)
981{
982 dbg_is_early = false;
983 if (kgdb_io_module_registered)
984 kgdb_arch_late();
985 kdb_init(KDB_INIT_FULL);
986
987 if (kgdb_io_module_registered && kgdb_break_asap)
988 kgdb_initial_breakpoint();
989}
990
991static int
992dbg_notify_reboot(struct notifier_block *this, unsigned long code, void *x)
993{
994 /*
995 * Take the following action on reboot notify depending on value:
996 * 1 == Enter debugger
997 * 0 == [the default] detatch debug client
998 * -1 == Do nothing... and use this until the board resets
999 */
1000 switch (kgdbreboot) {
1001 case 1:
1002 kgdb_breakpoint();
1003 case -1:
1004 goto done;
1005 }
1006 if (!dbg_kdb_mode)
1007 gdbstub_exit(code);
1008done:
1009 return NOTIFY_DONE;
1010}
1011
1012static struct notifier_block dbg_reboot_notifier = {
1013 .notifier_call = dbg_notify_reboot,
1014 .next = NULL,
1015 .priority = INT_MAX,
1016};
1017
1018static void kgdb_register_callbacks(void)
1019{
1020 if (!kgdb_io_module_registered) {
1021 kgdb_io_module_registered = 1;
1022 kgdb_arch_init();
1023 if (!dbg_is_early)
1024 kgdb_arch_late();
1025 register_module_notifier(&dbg_module_load_nb);
1026 register_reboot_notifier(&dbg_reboot_notifier);
1027#ifdef CONFIG_MAGIC_SYSRQ
1028 register_sysrq_key('g', &sysrq_dbg_op);
1029#endif
1030 if (kgdb_use_con && !kgdb_con_registered) {
1031 register_console(&kgdbcons);
1032 kgdb_con_registered = 1;
1033 }
1034 }
1035}
1036
1037static void kgdb_unregister_callbacks(void)
1038{
1039 /*
1040 * When this routine is called KGDB should unregister from
1041 * handlers and clean up, making sure it is not handling any
1042 * break exceptions at the time.
1043 */
1044 if (kgdb_io_module_registered) {
1045 kgdb_io_module_registered = 0;
1046 unregister_reboot_notifier(&dbg_reboot_notifier);
1047 unregister_module_notifier(&dbg_module_load_nb);
1048 kgdb_arch_exit();
1049#ifdef CONFIG_MAGIC_SYSRQ
1050 unregister_sysrq_key('g', &sysrq_dbg_op);
1051#endif
1052 if (kgdb_con_registered) {
1053 unregister_console(&kgdbcons);
1054 kgdb_con_registered = 0;
1055 }
1056 }
1057}
1058
1059/*
1060 * There are times a tasklet needs to be used vs a compiled in
1061 * break point so as to cause an exception outside a kgdb I/O module,
1062 * such as is the case with kgdboe, where calling a breakpoint in the
1063 * I/O driver itself would be fatal.
1064 */
1065static void kgdb_tasklet_bpt(unsigned long ing)
1066{
1067 kgdb_breakpoint();
1068 atomic_set(&kgdb_break_tasklet_var, 0);
1069}
1070
1071static DECLARE_TASKLET_OLD(kgdb_tasklet_breakpoint, kgdb_tasklet_bpt);
1072
1073void kgdb_schedule_breakpoint(void)
1074{
1075 if (atomic_read(&kgdb_break_tasklet_var) ||
1076 atomic_read(&kgdb_active) != -1 ||
1077 atomic_read(&kgdb_setting_breakpoint))
1078 return;
1079 atomic_inc(&kgdb_break_tasklet_var);
1080 tasklet_schedule(&kgdb_tasklet_breakpoint);
1081}
1082EXPORT_SYMBOL_GPL(kgdb_schedule_breakpoint);
1083
1084/**
1085 * kgdb_register_io_module - register KGDB IO module
1086 * @new_dbg_io_ops: the io ops vector
1087 *
1088 * Register it with the KGDB core.
1089 */
1090int kgdb_register_io_module(struct kgdb_io *new_dbg_io_ops)
1091{
1092 struct kgdb_io *old_dbg_io_ops;
1093 int err;
1094
1095 spin_lock(&kgdb_registration_lock);
1096
1097 old_dbg_io_ops = dbg_io_ops;
1098 if (old_dbg_io_ops) {
1099 if (!old_dbg_io_ops->deinit) {
1100 spin_unlock(&kgdb_registration_lock);
1101
1102 pr_err("KGDB I/O driver %s can't replace %s.\n",
1103 new_dbg_io_ops->name, old_dbg_io_ops->name);
1104 return -EBUSY;
1105 }
1106 pr_info("Replacing I/O driver %s with %s\n",
1107 old_dbg_io_ops->name, new_dbg_io_ops->name);
1108 }
1109
1110 if (new_dbg_io_ops->init) {
1111 err = new_dbg_io_ops->init();
1112 if (err) {
1113 spin_unlock(&kgdb_registration_lock);
1114 return err;
1115 }
1116 }
1117
1118 dbg_io_ops = new_dbg_io_ops;
1119
1120 spin_unlock(&kgdb_registration_lock);
1121
1122 if (old_dbg_io_ops) {
1123 old_dbg_io_ops->deinit();
1124 return 0;
1125 }
1126
1127 pr_info("Registered I/O driver %s\n", new_dbg_io_ops->name);
1128
1129 /* Arm KGDB now. */
1130 kgdb_register_callbacks();
1131
1132 if (kgdb_break_asap &&
1133 (!dbg_is_early || IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG)))
1134 kgdb_initial_breakpoint();
1135
1136 return 0;
1137}
1138EXPORT_SYMBOL_GPL(kgdb_register_io_module);
1139
1140/**
1141 * kkgdb_unregister_io_module - unregister KGDB IO module
1142 * @old_dbg_io_ops: the io ops vector
1143 *
1144 * Unregister it with the KGDB core.
1145 */
1146void kgdb_unregister_io_module(struct kgdb_io *old_dbg_io_ops)
1147{
1148 BUG_ON(kgdb_connected);
1149
1150 /*
1151 * KGDB is no longer able to communicate out, so
1152 * unregister our callbacks and reset state.
1153 */
1154 kgdb_unregister_callbacks();
1155
1156 spin_lock(&kgdb_registration_lock);
1157
1158 WARN_ON_ONCE(dbg_io_ops != old_dbg_io_ops);
1159 dbg_io_ops = NULL;
1160
1161 spin_unlock(&kgdb_registration_lock);
1162
1163 if (old_dbg_io_ops->deinit)
1164 old_dbg_io_ops->deinit();
1165
1166 pr_info("Unregistered I/O driver %s, debugger disabled\n",
1167 old_dbg_io_ops->name);
1168}
1169EXPORT_SYMBOL_GPL(kgdb_unregister_io_module);
1170
1171int dbg_io_get_char(void)
1172{
1173 int ret = dbg_io_ops->read_char();
1174 if (ret == NO_POLL_CHAR)
1175 return -1;
1176 if (!dbg_kdb_mode)
1177 return ret;
1178 if (ret == 127)
1179 return 8;
1180 return ret;
1181}
1182
1183/**
1184 * kgdb_breakpoint - generate breakpoint exception
1185 *
1186 * This function will generate a breakpoint exception. It is used at the
1187 * beginning of a program to sync up with a debugger and can be used
1188 * otherwise as a quick means to stop program execution and "break" into
1189 * the debugger.
1190 */
1191noinline void kgdb_breakpoint(void)
1192{
1193 atomic_inc(&kgdb_setting_breakpoint);
1194 wmb(); /* Sync point before breakpoint */
1195 arch_kgdb_breakpoint();
1196 wmb(); /* Sync point after breakpoint */
1197 atomic_dec(&kgdb_setting_breakpoint);
1198}
1199EXPORT_SYMBOL_GPL(kgdb_breakpoint);
1200
1201static int __init opt_kgdb_wait(char *str)
1202{
1203 kgdb_break_asap = 1;
1204
1205 kdb_init(KDB_INIT_EARLY);
1206 if (kgdb_io_module_registered &&
1207 IS_ENABLED(CONFIG_ARCH_HAS_EARLY_DEBUG))
1208 kgdb_initial_breakpoint();
1209
1210 return 0;
1211}
1212
1213early_param("kgdbwait", opt_kgdb_wait);