]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/linux/kdb.h
kgdb: core changes to support kdb
[mirror_ubuntu-focal-kernel.git] / include / linux / kdb.h
CommitLineData
5d5314d6
JW
1#ifndef _KDB_H
2#define _KDB_H
3
4/*
5 * Kernel Debugger Architecture Independent Global Headers
6 *
7 * This file is subject to the terms and conditions of the GNU General Public
8 * License. See the file "COPYING" in the main directory of this archive
9 * for more details.
10 *
11 * Copyright (c) 2000-2007 Silicon Graphics, Inc. All Rights Reserved.
12 * Copyright (C) 2000 Stephane Eranian <eranian@hpl.hp.com>
13 * Copyright (C) 2009 Jason Wessel <jason.wessel@windriver.com>
14 */
15
16#ifdef CONFIG_KGDB_KDB
17#include <linux/init.h>
18#include <linux/sched.h>
19#include <asm/atomic.h>
20
21#define KDB_POLL_FUNC_MAX 5
22
23/*
24 * kdb_initial_cpu is initialized to -1, and is set to the cpu
25 * number whenever the kernel debugger is entered.
26 */
27extern int kdb_initial_cpu;
28extern atomic_t kdb_event;
29
30/*
31 * kdb_diemsg
32 *
33 * Contains a pointer to the last string supplied to the
34 * kernel 'die' panic function.
35 */
36extern const char *kdb_diemsg;
37
38#define KDB_FLAG_EARLYKDB (1 << 0) /* set from boot parameter kdb=early */
39#define KDB_FLAG_CATASTROPHIC (1 << 1) /* A catastrophic event has occurred */
40#define KDB_FLAG_CMD_INTERRUPT (1 << 2) /* Previous command was interrupted */
41#define KDB_FLAG_NOIPI (1 << 3) /* Do not send IPIs */
42#define KDB_FLAG_ONLY_DO_DUMP (1 << 4) /* Only do a dump, used when
43 * kdb is off */
44#define KDB_FLAG_NO_CONSOLE (1 << 5) /* No console is available,
45 * kdb is disabled */
46#define KDB_FLAG_NO_VT_CONSOLE (1 << 6) /* No VT console is available, do
47 * not use keyboard */
48#define KDB_FLAG_NO_I8042 (1 << 7) /* No i8042 chip is available, do
49 * not use keyboard */
50
51extern int kdb_flags; /* Global flags, see kdb_state for per cpu state */
52
53extern void kdb_save_flags(void);
54extern void kdb_restore_flags(void);
55
56#define KDB_FLAG(flag) (kdb_flags & KDB_FLAG_##flag)
57#define KDB_FLAG_SET(flag) ((void)(kdb_flags |= KDB_FLAG_##flag))
58#define KDB_FLAG_CLEAR(flag) ((void)(kdb_flags &= ~KDB_FLAG_##flag))
59
60/*
61 * External entry point for the kernel debugger. The pt_regs
62 * at the time of entry are supplied along with the reason for
63 * entry to the kernel debugger.
64 */
65
66typedef enum {
67 KDB_REASON_ENTER = 1, /* KDB_ENTER() trap/fault - regs valid */
68 KDB_REASON_ENTER_SLAVE, /* KDB_ENTER_SLAVE() trap/fault - regs valid */
69 KDB_REASON_BREAK, /* Breakpoint inst. - regs valid */
70 KDB_REASON_DEBUG, /* Debug Fault - regs valid */
71 KDB_REASON_OOPS, /* Kernel Oops - regs valid */
72 KDB_REASON_SWITCH, /* CPU switch - regs valid*/
73 KDB_REASON_KEYBOARD, /* Keyboard entry - regs valid */
74 KDB_REASON_NMI, /* Non-maskable interrupt; regs valid */
75 KDB_REASON_RECURSE, /* Recursive entry to kdb;
76 * regs probably valid */
77 KDB_REASON_SSTEP, /* Single Step trap. - regs valid */
78} kdb_reason_t;
79
80extern int kdb_printf(const char *, ...)
81 __attribute__ ((format (printf, 1, 2)));
82typedef int (*kdb_printf_t)(const char *, ...)
83 __attribute__ ((format (printf, 1, 2)));
84
85extern void kdb_init(int level);
86
87/* Access to kdb specific polling devices */
88typedef int (*get_char_func)(void);
89extern get_char_func kdb_poll_funcs[];
90extern int kdb_get_kbd_char(void);
91
92static inline
93int kdb_process_cpu(const struct task_struct *p)
94{
95 unsigned int cpu = task_thread_info(p)->cpu;
96 if (cpu > num_possible_cpus())
97 cpu = 0;
98 return cpu;
99}
100
101/* kdb access to register set for stack dumping */
102extern struct pt_regs *kdb_current_regs;
103
104#else /* ! CONFIG_KGDB_KDB */
105#define kdb_printf(...)
106#define kdb_init(x)
107#endif /* CONFIG_KGDB_KDB */
108enum {
109 KDB_NOT_INITIALIZED,
110 KDB_INIT_EARLY,
111 KDB_INIT_FULL,
112};
113#endif /* !_KDB_H */