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/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);
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);