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