xref: /freebsd/sys/sys/kdb.h (revision 56e53cb8ef000c3ef72337a4095987a932cdedef)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2004 Marcel Moolenaar
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _SYS_KDB_H_
32 #define	_SYS_KDB_H_
33 
34 #include <machine/setjmp.h>
35 
36 struct pcb;
37 struct thread;
38 struct trapframe;
39 
40 typedef int dbbe_init_f(void);
41 typedef void dbbe_trace_f(void);
42 typedef void dbbe_trace_thread_f(struct thread *);
43 typedef int dbbe_trap_f(int, int);
44 
45 struct kdb_dbbe {
46 	const char	*dbbe_name;
47 	dbbe_init_f	*dbbe_init;
48 	dbbe_trace_f	*dbbe_trace;
49 	dbbe_trace_thread_f *dbbe_trace_thread;
50 	dbbe_trap_f	*dbbe_trap;
51 	int		dbbe_active;
52 };
53 
54 #define	KDB_BACKEND(name, init, trace, trace_thread, trap) \
55 	static struct kdb_dbbe name##_dbbe = {		\
56 		.dbbe_name = #name,			\
57 		.dbbe_init = init,			\
58 		.dbbe_trace = trace,			\
59 		.dbbe_trace_thread = trace_thread,	\
60 		.dbbe_trap = trap			\
61 	};						\
62 	DATA_SET(kdb_dbbe_set, name##_dbbe)
63 
64 extern u_char kdb_active;		/* Non-zero while in debugger. */
65 extern int debugger_on_panic;		/* enter the debugger on panic. */
66 extern struct kdb_dbbe *kdb_dbbe;	/* Default debugger backend or NULL. */
67 extern struct trapframe *kdb_frame;	/* Frame to kdb_trap(). */
68 extern struct pcb *kdb_thrctx;		/* Current context. */
69 extern struct thread *kdb_thread;	/* Current thread. */
70 
71 int	kdb_alt_break(int, int *);
72 int	kdb_alt_break_gdb(int, int *);
73 int	kdb_break(void);
74 void	kdb_backtrace(void);
75 void	kdb_backtrace_thread(struct thread *);
76 int	kdb_dbbe_select(const char *);
77 void	kdb_enter(const char *, const char *);
78 void	kdb_init(void);
79 void *	kdb_jmpbuf(jmp_buf);
80 void	kdb_panic(const char *);
81 void	kdb_reboot(void);
82 void	kdb_reenter(void);
83 void	kdb_reenter_silent(void);
84 struct pcb *kdb_thr_ctx(struct thread *);
85 struct thread *kdb_thr_first(void);
86 struct thread *kdb_thr_from_pid(pid_t);
87 struct thread *kdb_thr_lookup(lwpid_t);
88 struct thread *kdb_thr_next(struct thread *);
89 int	kdb_thr_select(struct thread *);
90 int	kdb_trap(int, int, struct trapframe *);
91 
92 /*
93  * KDB enters the debugger via breakpoint(), which leaves the debugger without
94  * a lot of information about why it was entered.  This simple enumerated set
95  * captures some basic information.
96  *
97  * It is recommended that values here be short (<16 character) alpha-numeric
98  * strings, as they will be used to construct DDB(4) script names.
99  */
100 extern const char * volatile kdb_why;
101 #define	KDB_WHY_UNSET		NULL		/* No reason set. */
102 #define	KDB_WHY_PANIC		"panic"		/* panic() was called. */
103 #define	KDB_WHY_KASSERT		"kassert"	/* kassert failed. */
104 #define	KDB_WHY_SYSCTL		"sysctl"	/* Sysctl entered debugger. */
105 #define	KDB_WHY_BOOTFLAGS	"bootflags"	/* Boot flags were set. */
106 #define	KDB_WHY_WITNESS		"witness"	/* Witness entered debugger. */
107 #define	KDB_WHY_VFSLOCK		"vfslock"	/* VFS detected lock problem. */
108 #define	KDB_WHY_NETGRAPH	"netgraph"	/* Netgraph entered debugger. */
109 #define	KDB_WHY_BREAK		"break"		/* Console or serial break. */
110 #define	KDB_WHY_WATCHDOG	"watchdog"	/* Watchdog entered debugger. */
111 #define	KDB_WHY_CAM		"cam"		/* CAM has entered debugger. */
112 #define	KDB_WHY_NDIS		"ndis"		/* NDIS entered debugger. */
113 #define	KDB_WHY_ACPI		"acpi"		/* ACPI entered debugger. */
114 #define	KDB_WHY_TRAPSIG		"trapsig"	/* Sparc fault. */
115 #define	KDB_WHY_POWERFAIL	"powerfail"	/* Powerfail NMI. */
116 #define	KDB_WHY_MAC		"mac"		/* MAC Framework. */
117 #define	KDB_WHY_POWERPC		"powerpc"	/* Unhandled powerpc intr. */
118 #define	KDB_WHY_UNIONFS		"unionfs"	/* Unionfs bug. */
119 #define	KDB_WHY_DTRACE		"dtrace"	/* DTrace action entered debugger. */
120 
121 /* Return values for kdb_alt_break */
122 #define	KDB_REQ_DEBUGGER	1	/* User requested Debugger */
123 #define	KDB_REQ_PANIC		2	/* User requested a panic */
124 #define	KDB_REQ_REBOOT		3	/* User requested a clean reboot */
125 
126 #endif /* !_SYS_KDB_H_ */
127