[mirror_ubuntu-bionic-kernel.git] / include / linux / kdb.h

#ifndef _KDB_H
#define _KDB_H

/*
 * Kernel Debugger Architecture Independent Global Headers
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file "COPYING" in the main directory of this archive
 * for more details.
 *
 * Copyright (c) 2000-2007 Silicon Graphics, Inc.  All Rights Reserved.
 * Copyright (C) 2000 Stephane Eranian <eranian@hpl.hp.com>
 * Copyright (C) 2009 Jason Wessel <jason.wessel@windriver.com>
 */

/* Shifted versions of the command enable bits are be used if the command
 * has no arguments (see kdb_check_flags). This allows commands, such as
 * go, to have different permissions depending upon whether it is called
 * with an argument.
 */
#define KDB_ENABLE_NO_ARGS_SHIFT 10

typedef enum {
	KDB_ENABLE_ALL = (1 << 0), /* Enable everything */
	KDB_ENABLE_MEM_READ = (1 << 1),
	KDB_ENABLE_MEM_WRITE = (1 << 2),
	KDB_ENABLE_REG_READ = (1 << 3),
	KDB_ENABLE_REG_WRITE = (1 << 4),
	KDB_ENABLE_INSPECT = (1 << 5),
	KDB_ENABLE_FLOW_CTRL = (1 << 6),
	KDB_ENABLE_SIGNAL = (1 << 7),
	KDB_ENABLE_REBOOT = (1 << 8),
	/* User exposed values stop here, all remaining flags are
	 * exclusively used to describe a commands behaviour.
	 */

	KDB_ENABLE_ALWAYS_SAFE = (1 << 9),
	KDB_ENABLE_MASK = (1 << KDB_ENABLE_NO_ARGS_SHIFT) - 1,

	KDB_ENABLE_ALL_NO_ARGS = KDB_ENABLE_ALL << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_MEM_READ_NO_ARGS = KDB_ENABLE_MEM_READ
				      << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_MEM_WRITE_NO_ARGS = KDB_ENABLE_MEM_WRITE
				       << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_REG_READ_NO_ARGS = KDB_ENABLE_REG_READ
				      << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_REG_WRITE_NO_ARGS = KDB_ENABLE_REG_WRITE
				       << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_INSPECT_NO_ARGS = KDB_ENABLE_INSPECT
				     << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_FLOW_CTRL_NO_ARGS = KDB_ENABLE_FLOW_CTRL
				       << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_SIGNAL_NO_ARGS = KDB_ENABLE_SIGNAL
				    << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_REBOOT_NO_ARGS = KDB_ENABLE_REBOOT
				    << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_ALWAYS_SAFE_NO_ARGS = KDB_ENABLE_ALWAYS_SAFE
					 << KDB_ENABLE_NO_ARGS_SHIFT,
	KDB_ENABLE_MASK_NO_ARGS = KDB_ENABLE_MASK << KDB_ENABLE_NO_ARGS_SHIFT,

	KDB_REPEAT_NO_ARGS = 0x40000000, /* Repeat the command w/o arguments */
	KDB_REPEAT_WITH_ARGS = 0x80000000, /* Repeat the command with args */
} kdb_cmdflags_t;

typedef int (*kdb_func_t)(int, const char **);

#ifdef	CONFIG_KGDB_KDB
#include <linux/init.h>
#include <linux/sched.h>
#include <linux/atomic.h>

#define KDB_POLL_FUNC_MAX	5
extern int kdb_poll_idx;

/*
 * kdb_initial_cpu is initialized to -1, and is set to the cpu
 * number whenever the kernel debugger is entered.
 */
extern int kdb_initial_cpu;

/* Types and messages used for dynamically added kdb shell commands */

#define KDB_MAXARGS    16 /* Maximum number of arguments to a function  */

/* KDB return codes from a command or internal kdb function */
#define KDB_NOTFOUND	(-1)
#define KDB_ARGCOUNT	(-2)
#define KDB_BADWIDTH	(-3)
#define KDB_BADRADIX	(-4)
#define KDB_NOTENV	(-5)
#define KDB_NOENVVALUE	(-6)
#define KDB_NOTIMP	(-7)
#define KDB_ENVFULL	(-8)
#define KDB_ENVBUFFULL	(-9)
#define KDB_TOOMANYBPT	(-10)
#define KDB_TOOMANYDBREGS (-11)
#define KDB_DUPBPT	(-12)
#define KDB_BPTNOTFOUND	(-13)
#define KDB_BADMODE	(-14)
#define KDB_BADINT	(-15)
#define KDB_INVADDRFMT  (-16)
#define KDB_BADREG      (-17)
#define KDB_BADCPUNUM   (-18)
#define KDB_BADLENGTH	(-19)
#define KDB_NOBP	(-20)
#define KDB_BADADDR	(-21)
#define KDB_NOPERM	(-22)

/*
 * kdb_diemsg
 *
 *	Contains a pointer to the last string supplied to the
 *	kernel 'die' panic function.
 */
extern const char *kdb_diemsg;

#define KDB_FLAG_EARLYKDB	(1 << 0) /* set from boot parameter kdb=early */
#define KDB_FLAG_CATASTROPHIC	(1 << 1) /* A catastrophic event has occurred */
#define KDB_FLAG_CMD_INTERRUPT	(1 << 2) /* Previous command was interrupted */
#define KDB_FLAG_NOIPI		(1 << 3) /* Do not send IPIs */
#define KDB_FLAG_NO_CONSOLE	(1 << 5) /* No console is available,
					  * kdb is disabled */
#define KDB_FLAG_NO_VT_CONSOLE	(1 << 6) /* No VT console is available, do
					  * not use keyboard */
#define KDB_FLAG_NO_I8042	(1 << 7) /* No i8042 chip is available, do
					  * not use keyboard */

extern int kdb_flags;	/* Global flags, see kdb_state for per cpu state */

extern void kdb_save_flags(void);
extern void kdb_restore_flags(void);

#define KDB_FLAG(flag)		(kdb_flags & KDB_FLAG_##flag)
#define KDB_FLAG_SET(flag)	((void)(kdb_flags |= KDB_FLAG_##flag))
#define KDB_FLAG_CLEAR(flag)	((void)(kdb_flags &= ~KDB_FLAG_##flag))

/*
 * External entry point for the kernel debugger.  The pt_regs
 * at the time of entry are supplied along with the reason for
 * entry to the kernel debugger.
 */

typedef enum {
	KDB_REASON_ENTER = 1,	/* KDB_ENTER() trap/fault - regs valid */
	KDB_REASON_ENTER_SLAVE,	/* KDB_ENTER_SLAVE() trap/fault - regs valid */
	KDB_REASON_BREAK,	/* Breakpoint inst. - regs valid */
	KDB_REASON_DEBUG,	/* Debug Fault - regs valid */
	KDB_REASON_OOPS,	/* Kernel Oops - regs valid */
	KDB_REASON_SWITCH,	/* CPU switch - regs valid*/
	KDB_REASON_KEYBOARD,	/* Keyboard entry - regs valid */
	KDB_REASON_NMI,		/* Non-maskable interrupt; regs valid */
	KDB_REASON_RECURSE,	/* Recursive entry to kdb;
				 * regs probably valid */
	KDB_REASON_SSTEP,	/* Single Step trap. - regs valid */
	KDB_REASON_SYSTEM_NMI,	/* In NMI due to SYSTEM cmd; regs valid */
} kdb_reason_t;

enum kdb_msgsrc {
	KDB_MSGSRC_INTERNAL, /* direct call to kdb_printf() */
	KDB_MSGSRC_PRINTK, /* trapped from printk() */
};

extern int kdb_trap_printk;
extern int kdb_printf_cpu;
extern __printf(2, 0) int vkdb_printf(enum kdb_msgsrc src, const char *fmt,
				      va_list args);
extern __printf(1, 2) int kdb_printf(const char *, ...);
typedef __printf(1, 2) int (*kdb_printf_t)(const char *, ...);

extern void kdb_init(int level);

/* Access to kdb specific polling devices */
typedef int (*get_char_func)(void);
extern get_char_func kdb_poll_funcs[];
extern int kdb_get_kbd_char(void);

static inline
int kdb_process_cpu(const struct task_struct *p)
{
	unsigned int cpu = task_cpu(p);
	if (cpu > num_possible_cpus())
		cpu = 0;
	return cpu;
}

/* kdb access to register set for stack dumping */
extern struct pt_regs *kdb_current_regs;
#ifdef CONFIG_KALLSYMS
extern const char *kdb_walk_kallsyms(loff_t *pos);
#else /* ! CONFIG_KALLSYMS */
static inline const char *kdb_walk_kallsyms(loff_t *pos)
{
	return NULL;
}
#endif /* ! CONFIG_KALLSYMS */

/* Dynamic kdb shell command registration */
extern int kdb_register(char *, kdb_func_t, char *, char *, short);
extern int kdb_register_flags(char *, kdb_func_t, char *, char *,
			      short, kdb_cmdflags_t);
extern int kdb_unregister(char *);
#else /* ! CONFIG_KGDB_KDB */
static inline __printf(1, 2) int kdb_printf(const char *fmt, ...) { return 0; }
static inline void kdb_init(int level) {}
static inline int kdb_register(char *cmd, kdb_func_t func, char *usage,
			       char *help, short minlen) { return 0; }
static inline int kdb_register_flags(char *cmd, kdb_func_t func, char *usage,
				     char *help, short minlen,
				     kdb_cmdflags_t flags) { return 0; }
static inline int kdb_unregister(char *cmd) { return 0; }
#endif	/* CONFIG_KGDB_KDB */
enum {
	KDB_NOT_INITIALIZED,
	KDB_INIT_EARLY,
	KDB_INIT_FULL,
};

extern int kdbgetintenv(const char *, int *);
extern int kdb_set(int, const char **);

#endif	/* !_KDB_H */
Commit	Line	Data
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
9452e977 DT	16	/* Shifted versions of the command enable bits are be used if the command
	17	* has no arguments (see kdb_check_flags). This allows commands, such as
	18	* go, to have different permissions depending upon whether it is called
	19	* with an argument.
	20	*/
	21	#define KDB_ENABLE_NO_ARGS_SHIFT 10
	22
729043e8	23	typedef enum {
9452e977 DT	24	KDB_ENABLE_ALL = (1 << 0), /* Enable everything */
	25	KDB_ENABLE_MEM_READ = (1 << 1),
	26	KDB_ENABLE_MEM_WRITE = (1 << 2),
	27	KDB_ENABLE_REG_READ = (1 << 3),
	28	KDB_ENABLE_REG_WRITE = (1 << 4),
	29	KDB_ENABLE_INSPECT = (1 << 5),
	30	KDB_ENABLE_FLOW_CTRL = (1 << 6),
	31	KDB_ENABLE_SIGNAL = (1 << 7),
	32	KDB_ENABLE_REBOOT = (1 << 8),
	33	/* User exposed values stop here, all remaining flags are
	34	* exclusively used to describe a commands behaviour.
	35	*/
	36
	37	KDB_ENABLE_ALWAYS_SAFE = (1 << 9),
	38	KDB_ENABLE_MASK = (1 << KDB_ENABLE_NO_ARGS_SHIFT) - 1,
	39
	40	KDB_ENABLE_ALL_NO_ARGS = KDB_ENABLE_ALL << KDB_ENABLE_NO_ARGS_SHIFT,
	41	KDB_ENABLE_MEM_READ_NO_ARGS = KDB_ENABLE_MEM_READ
	42	<< KDB_ENABLE_NO_ARGS_SHIFT,
	43	KDB_ENABLE_MEM_WRITE_NO_ARGS = KDB_ENABLE_MEM_WRITE
	44	<< KDB_ENABLE_NO_ARGS_SHIFT,
	45	KDB_ENABLE_REG_READ_NO_ARGS = KDB_ENABLE_REG_READ
	46	<< KDB_ENABLE_NO_ARGS_SHIFT,
	47	KDB_ENABLE_REG_WRITE_NO_ARGS = KDB_ENABLE_REG_WRITE
	48	<< KDB_ENABLE_NO_ARGS_SHIFT,
	49	KDB_ENABLE_INSPECT_NO_ARGS = KDB_ENABLE_INSPECT
	50	<< KDB_ENABLE_NO_ARGS_SHIFT,
	51	KDB_ENABLE_FLOW_CTRL_NO_ARGS = KDB_ENABLE_FLOW_CTRL
	52	<< KDB_ENABLE_NO_ARGS_SHIFT,
	53	KDB_ENABLE_SIGNAL_NO_ARGS = KDB_ENABLE_SIGNAL
	54	<< KDB_ENABLE_NO_ARGS_SHIFT,
	55	KDB_ENABLE_REBOOT_NO_ARGS = KDB_ENABLE_REBOOT
	56	<< KDB_ENABLE_NO_ARGS_SHIFT,
	57	KDB_ENABLE_ALWAYS_SAFE_NO_ARGS = KDB_ENABLE_ALWAYS_SAFE
	58	<< KDB_ENABLE_NO_ARGS_SHIFT,
	59	KDB_ENABLE_MASK_NO_ARGS = KDB_ENABLE_MASK << KDB_ENABLE_NO_ARGS_SHIFT,
	60
	61	KDB_REPEAT_NO_ARGS = 0x40000000, /* Repeat the command w/o arguments */
	62	KDB_REPEAT_WITH_ARGS = 0x80000000, /* Repeat the command with args */
15a42a9b	63	} kdb_cmdflags_t;
729043e8 AV	64
	65	typedef int (kdb_func_t)(int, const char *);
	66
5d5314d6 JW	67	#ifdef CONFIG_KGDB_KDB
	68	#include <linux/init.h>
	69	#include <linux/sched.h>
60063497	70	#include <linux/atomic.h>
5d5314d6 JW	71
5d5314d6 JW	72	#define KDB_POLL_FUNC_MAX 5
f5316b4a	73	extern int kdb_poll_idx;
5d5314d6 JW	74
	75	/*
	76	* kdb_initial_cpu is initialized to -1, and is set to the cpu
	77	* number whenever the kernel debugger is entered.
	78	*/
	79	extern int kdb_initial_cpu;
5d5314d6	80
f7030bbc JW	81	/* Types and messages used for dynamically added kdb shell commands */
	82
	83	#define KDB_MAXARGS 16 /* Maximum number of arguments to a function */
	84
f7030bbc JW	85	/* KDB return codes from a command or internal kdb function */
	86	#define KDB_NOTFOUND (-1)
	87	#define KDB_ARGCOUNT (-2)
	88	#define KDB_BADWIDTH (-3)
	89	#define KDB_BADRADIX (-4)
	90	#define KDB_NOTENV (-5)
	91	#define KDB_NOENVVALUE (-6)
	92	#define KDB_NOTIMP (-7)
	93	#define KDB_ENVFULL (-8)
	94	#define KDB_ENVBUFFULL (-9)
	95	#define KDB_TOOMANYBPT (-10)
	96	#define KDB_TOOMANYDBREGS (-11)
	97	#define KDB_DUPBPT (-12)
	98	#define KDB_BPTNOTFOUND (-13)
	99	#define KDB_BADMODE (-14)
	100	#define KDB_BADINT (-15)
	101	#define KDB_INVADDRFMT (-16)
	102	#define KDB_BADREG (-17)
	103	#define KDB_BADCPUNUM (-18)
	104	#define KDB_BADLENGTH (-19)
	105	#define KDB_NOBP (-20)
	106	#define KDB_BADADDR (-21)
420c2b1b	107	#define KDB_NOPERM (-22)
f7030bbc	108
5d5314d6 JW	109	/*
	110	* kdb_diemsg
	111	*
	112	* Contains a pointer to the last string supplied to the
	113	* kernel 'die' panic function.
	114	*/
	115	extern const char *kdb_diemsg;
	116
	117	#define KDB_FLAG_EARLYKDB (1 << 0) /* set from boot parameter kdb=early */
	118	#define KDB_FLAG_CATASTROPHIC (1 << 1) /* A catastrophic event has occurred */
	119	#define KDB_FLAG_CMD_INTERRUPT (1 << 2) /* Previous command was interrupted */
	120	#define KDB_FLAG_NOIPI (1 << 3) /* Do not send IPIs */
5d5314d6 JW	121	#define KDB_FLAG_NO_CONSOLE (1 << 5) /* No console is available,
	122	* kdb is disabled */
	123	#define KDB_FLAG_NO_VT_CONSOLE (1 << 6) /* No VT console is available, do
	124	* not use keyboard */
	125	#define KDB_FLAG_NO_I8042 (1 << 7) /* No i8042 chip is available, do
	126	* not use keyboard */
	127
	128	extern int kdb_flags; /* Global flags, see kdb_state for per cpu state */
	129
	130	extern void kdb_save_flags(void);
	131	extern void kdb_restore_flags(void);
	132
	133	#define KDB_FLAG(flag) (kdb_flags & KDB_FLAG_##flag)
	134	#define KDB_FLAG_SET(flag) ((void)(kdb_flags \|= KDB_FLAG_##flag))
	135	#define KDB_FLAG_CLEAR(flag) ((void)(kdb_flags &= ~KDB_FLAG_##flag))
	136
	137	/*
	138	* External entry point for the kernel debugger. The pt_regs
	139	* at the time of entry are supplied along with the reason for
	140	* entry to the kernel debugger.
	141	*/
	142
	143	typedef enum {
	144	KDB_REASON_ENTER = 1, /* KDB_ENTER() trap/fault - regs valid */
	145	KDB_REASON_ENTER_SLAVE, /* KDB_ENTER_SLAVE() trap/fault - regs valid */
	146	KDB_REASON_BREAK, /* Breakpoint inst. - regs valid */
	147	KDB_REASON_DEBUG, /* Debug Fault - regs valid */
	148	KDB_REASON_OOPS, /* Kernel Oops - regs valid */
	149	KDB_REASON_SWITCH, /* CPU switch - regs valid*/
	150	KDB_REASON_KEYBOARD, /* Keyboard entry - regs valid */
	151	KDB_REASON_NMI, /* Non-maskable interrupt; regs valid */
	152	KDB_REASON_RECURSE, /* Recursive entry to kdb;
	153	* regs probably valid */
	154	KDB_REASON_SSTEP, /* Single Step trap. - regs valid */
8daaa5f8	155	KDB_REASON_SYSTEM_NMI, /* In NMI due to SYSTEM cmd; regs valid */
5d5314d6 JW	156	} kdb_reason_t;
5d5314d6 JW	157
f7d4ca8b DT	158	enum kdb_msgsrc {
	159	KDB_MSGSRC_INTERNAL, /* direct call to kdb_printf() */
	160	KDB_MSGSRC_PRINTK, /* trapped from printk() */
	161	};
	162
d37d39ae	163	extern int kdb_trap_printk;
34aaff40	164	extern int kdb_printf_cpu;
f7d4ca8b DT	165	extern __printf(2, 0) int vkdb_printf(enum kdb_msgsrc src, const char *fmt,
f7d4ca8b DT	166	va_list args);
b9075fa9 JP	167	extern __printf(1, 2) int kdb_printf(const char *, ...);
b9075fa9 JP	168	typedef __printf(1, 2) int (kdb_printf_t)(const char , ...);
5d5314d6 JW	169
	170	extern void kdb_init(int level);
	171
	172	/* Access to kdb specific polling devices */
	173	typedef int (*get_char_func)(void);
	174	extern get_char_func kdb_poll_funcs[];
	175	extern int kdb_get_kbd_char(void);
	176
	177	static inline
	178	int kdb_process_cpu(const struct task_struct *p)
	179	{
e558af65	180	unsigned int cpu = task_cpu(p);
5d5314d6 JW	181	if (cpu > num_possible_cpus())
	182	cpu = 0;
	183	return cpu;
	184	}
	185
	186	/* kdb access to register set for stack dumping */
	187	extern struct pt_regs *kdb_current_regs;
91b152aa JW	188	#ifdef CONFIG_KALLSYMS
	189	extern const char kdb_walk_kallsyms(loff_t pos);
	190	#else /* ! CONFIG_KALLSYMS */
	191	static inline const char kdb_walk_kallsyms(loff_t pos)
	192	{
	193	return NULL;
	194	}
	195	#endif /* ! CONFIG_KALLSYMS */
5d5314d6	196
f7030bbc JW	197	/* Dynamic kdb shell command registration */
f7030bbc JW	198	extern int kdb_register(char , kdb_func_t, char , char *, short);
42c884c1 AV	199	extern int kdb_register_flags(char , kdb_func_t, char , char *,
42c884c1 AV	200	short, kdb_cmdflags_t);
f7030bbc	201	extern int kdb_unregister(char *);
5d5314d6	202	#else /* ! CONFIG_KGDB_KDB */
729043e8 AV	203	static inline __printf(1, 2) int kdb_printf(const char *fmt, ...) { return 0; }
	204	static inline void kdb_init(int level) {}
	205	static inline int kdb_register(char cmd, kdb_func_t func, char usage,
	206	char *help, short minlen) { return 0; }
42c884c1 AV	207	static inline int kdb_register_flags(char cmd, kdb_func_t func, char usage,
	208	char *help, short minlen,
	209	kdb_cmdflags_t flags) { return 0; }
729043e8	210	static inline int kdb_unregister(char *cmd) { return 0; }
5d5314d6 JW	211	#endif /* CONFIG_KGDB_KDB */
	212	enum {
	213	KDB_NOT_INITIALIZED,
	214	KDB_INIT_EARLY,
	215	KDB_INIT_FULL,
	216	};
81d44507 JW	217
	218	extern int kdbgetintenv(const char , int );
	219	extern int kdb_set(int, const char **);
	220
5d5314d6	221	#endif /* !_KDB_H */