xref: /freebsd/sys/ddb/ddb.h (revision 2449b9e5fe565be757a4b29093fd1c9c6ffcf3c9)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1993, Garrett A. Wollman.
5  * Copyright (c) 1993, University of Vermont and State Agricultural College.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 
35 /*
36  * Necessary declarations for the `ddb' kernel debugger.
37  */
38 
39 #ifndef _DDB_DDB_H_
40 #define	_DDB_DDB_H_
41 
42 #ifdef SYSCTL_DECL
43 SYSCTL_DECL(_debug_ddb);
44 #endif
45 
46 #include <machine/db_machdep.h>		/* type definitions */
47 
48 #include <sys/queue.h>			/* LIST_* */
49 #include <sys/kernel.h>			/* SYSINIT */
50 
51 #ifndef DB_MAXARGS
52 #define	DB_MAXARGS	10
53 #endif
54 
55 #ifndef DB_MAXLINE
56 #define	DB_MAXLINE	120
57 #endif
58 
59 #ifndef DB_MAXSCRIPTS
60 #define	DB_MAXSCRIPTS	8
61 #endif
62 
63 #ifndef DB_MAXSCRIPTNAME
64 #define	DB_MAXSCRIPTNAME	32
65 #endif
66 
67 #ifndef DB_MAXSCRIPTLEN
68 #define	DB_MAXSCRIPTLEN	128
69 #endif
70 
71 #ifndef DB_MAXSCRIPTRECURSION
72 #define	DB_MAXSCRIPTRECURSION	3
73 #endif
74 
75 #ifndef DB_CALL
76 #define	DB_CALL	db_fncall_generic
77 #else
78 int	DB_CALL(db_expr_t, db_expr_t *, int, db_expr_t[]);
79 #endif
80 
81 /*
82  * Extern variables to set the address and size of the symtab and strtab.
83  * Most users should use db_fetch_symtab in order to set them from the
84  * boot loader provided values.
85  */
86 extern vm_offset_t ksymtab, kstrtab, ksymtab_size, ksymtab_relbase;
87 
88 /*
89  * There are three "command tables":
90  * - One for simple commands; a list of these is displayed
91  *   by typing 'help' at the debugger prompt.
92  * - One for sub-commands of 'show'; to see this type 'show'
93  *   without any arguments.
94  * - The last one for sub-commands of 'show all'; type 'show all'
95  *   without any argument to get a list.
96  */
97 struct db_command;
98 LIST_HEAD(db_command_table, db_command);
99 extern struct db_command_table db_cmd_table;
100 extern struct db_command_table db_show_table;
101 extern struct db_command_table db_show_all_table;
102 
103 /*
104  * Type signature for a function implementing a ddb command.
105  */
106 typedef void db_cmdfcn_t(db_expr_t addr, bool have_addr, db_expr_t count,
107 	    char *modif);
108 
109 /*
110  * Command table entry.
111  */
112 struct db_command {
113 	char *name;		/* command name */
114 	db_cmdfcn_t *fcn;	/* function to call */
115 	int flag;
116 #define	CS_OWN		0x1	/* non-standard syntax */
117 #define	CS_MORE		0x2	/* standard syntax, but may have other words
118 				 * at end */
119 #define	CS_SET_DOT	0x100	/* set dot after command */
120 #define	DB_CMD_MEMSAFE	0x1000	/* Command does not allow reads or writes to
121 				 * arbitrary memory. */
122 #define	DB_MAC1		0x10000	/* For MAC policy use */
123 #define	DB_MAC2		0x20000
124 	struct db_command_table *more; /* another level of command */
125 	LIST_ENTRY(db_command) next; /* next entry in the command table */
126 	void *mac_priv;		/* For MAC policy use */
127 };
128 
129 /*
130  * Arrange for the specified ddb command to be defined and
131  * bound to the specified function.  Commands can be defined
132  * in modules in which case they will be available only when
133  * the module is loaded.
134  */
135 #define	_DB_SET(_suffix, _name, _func, list, _flag, _more)	\
136 static struct db_command __CONCAT(_name,_suffix) = {		\
137 	.name	= __STRING(_name),				\
138 	.fcn	= _func,					\
139 	.flag	= _flag,					\
140 	.more	= _more						\
141 };								\
142 static void __CONCAT(__CONCAT(_name,_suffix),_add)(void *arg __unused) \
143     { db_command_register(&list, &__CONCAT(_name,_suffix)); }	\
144 SYSINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY,	\
145     __CONCAT(__CONCAT(_name,_suffix),_add), NULL);		\
146 static void __CONCAT(__CONCAT(_name,_suffix),_del)(void *arg __unused) \
147     { db_command_unregister(&list, &__CONCAT(_name,_suffix)); }	\
148 SYSUNINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY,	\
149     __CONCAT(__CONCAT(_name,_suffix),_del), NULL);
150 
151 /*
152  * Like _DB_SET but also create the function declaration which
153  * must be followed immediately by the body; e.g.
154  *   _DB_FUNC(_cmd, panic, db_panic, db_cmd_table, 0, NULL)
155  *   {
156  *	...panic implementation...
157  *   }
158  *
159  * This macro is mostly used to define commands placed in one of
160  * the ddb command tables; see DB_COMMAND, etc. below.
161  */
162 #define	_DB_FUNC(_suffix, _name, _func, list, _flag, _more)	\
163 static db_cmdfcn_t _func;					\
164 _DB_SET(_suffix, _name, _func, list, _flag, _more);		\
165 static void							\
166 _func(db_expr_t addr, bool have_addr, db_expr_t count, char *modif)
167 
168 /* common idom provided for backwards compatibility */
169 #define	DB_FUNC(_name, _func, list, _flag, _more)		\
170 	_DB_FUNC(_cmd, _name, _func, list, _flag, _more)
171 
172 #define	DB_COMMAND_FLAGS(cmd_name, func_name, flags) \
173 	_DB_FUNC(_cmd, cmd_name, func_name, db_cmd_table, flags, NULL)
174 #define	DB_COMMAND(cmd_name, func_name) \
175 	DB_COMMAND_FLAGS(cmd_name, func_name, 0)
176 #define	DB_ALIAS_FLAGS(alias_name, func_name, flags) \
177 	_DB_SET(_cmd, alias_name, func_name, db_cmd_table, flags, NULL)
178 #define	DB_ALIAS(alias_name, func_name) \
179 	DB_ALIAS_FLAGS(alias_name, func_name, 0)
180 #define	DB_SHOW_COMMAND_FLAGS(cmd_name, func_name, flags) \
181 	_DB_FUNC(_show, cmd_name, func_name, db_show_table, flags, NULL)
182 #define	DB_SHOW_COMMAND(cmd_name, func_name) \
183 	DB_SHOW_COMMAND_FLAGS(cmd_name, func_name, 0)
184 #define	DB_SHOW_ALIAS_FLAGS(alias_name, func_name, flags) \
185 	_DB_SET(_show, alias_name, func_name, db_show_table, flags, NULL)
186 #define	DB_SHOW_ALIAS(alias_name, func_name) \
187 	DB_SHOW_ALIAS_FLAGS(alias_name, func_name, 0)
188 #define	DB_SHOW_ALL_COMMAND(cmd_name, func_name)			\
189 	_DB_FUNC(_show_all, cmd_name, func_name, db_show_all_table,	\
190 	    DB_CMD_MEMSAFE, NULL)
191 #define	DB_SHOW_ALL_ALIAS(alias_name, func_name)			\
192 	_DB_SET(_show_all, alias_name, func_name, db_show_all_table,	\
193 	    DB_CMD_MEMSAFE, NULL)
194 
195 extern db_expr_t db_maxoff;
196 extern int db_indent;
197 extern int db_inst_count;
198 extern int db_load_count;
199 extern int db_store_count;
200 extern volatile int db_pager_quit;
201 extern db_expr_t db_radix;
202 extern db_expr_t db_max_width;
203 extern db_expr_t db_tab_stop_width;
204 extern db_expr_t db_lines_per_page;
205 
206 struct thread;
207 struct vm_map;
208 
209 void		db_check_interrupt(void);
210 void		db_clear_watchpoints(void);
211 db_addr_t	db_disasm(db_addr_t loc, bool altfmt);
212 				/* instruction disassembler */
213 void		db_error(const char *s);
214 int		db_expression(db_expr_t *valuep);
215 int		db_getc(void);
216 int		db_get_variable(db_expr_t *valuep);
217 void		db_iprintf(const char *,...) __printflike(1, 2);
218 struct proc	*db_lookup_proc(db_expr_t addr);
219 struct thread	*db_lookup_thread(db_expr_t addr, bool check_pid);
220 struct vm_map	*db_map_addr(vm_offset_t);
221 bool		db_map_current(struct vm_map *);
222 bool		db_map_equal(struct vm_map *, struct vm_map *);
223 void		db_md_list_watchpoints(void);
224 void		db_print_loc_and_inst(db_addr_t loc);
225 void		db_print_thread(void);
226 int		db_printf(const char *fmt, ...) __printflike(1, 2);
227 int		db_read_bytes(vm_offset_t addr, size_t size, char *data);
228 				/* machine-dependent */
229 int		db_readline(char *lstart, int lsize);
230 void		db_restart_at_pc(bool watchpt);
231 int		db_set_variable(db_expr_t value);
232 void		db_set_watchpoints(void);
233 void		db_skip_to_eol(void);
234 bool		db_stop_at_pc(int type, int code, bool *is_breakpoint,
235 		    bool *is_watchpoint);
236 #define		db_strcpy	strcpy
237 void		db_trace_self(void);
238 int		db_trace_thread(struct thread *, int);
239 bool		db_value_of_name(const char *name, db_expr_t *valuep);
240 bool		db_value_of_name_pcpu(const char *name, db_expr_t *valuep);
241 bool		db_value_of_name_vnet(const char *name, db_expr_t *valuep);
242 int		db_write_bytes(vm_offset_t addr, size_t size, char *data);
243 void		db_command_register(struct db_command_table *,
244 		    struct db_command *);
245 void		db_command_unregister(struct db_command_table *,
246 		    struct db_command *);
247 int		db_fetch_ksymtab(vm_offset_t ksym_start, vm_offset_t ksym_end,
248 		    vm_offset_t relbase);
249 
250 db_cmdfcn_t	db_breakpoint_cmd;
251 db_cmdfcn_t	db_capture_cmd;
252 db_cmdfcn_t	db_continue_cmd;
253 db_cmdfcn_t	db_delete_cmd;
254 db_cmdfcn_t	db_deletehwatch_cmd;
255 db_cmdfcn_t	db_deletewatch_cmd;
256 db_cmdfcn_t	db_examine_cmd;
257 db_cmdfcn_t	db_findstack_cmd;
258 db_cmdfcn_t	db_hwatchpoint_cmd;
259 db_cmdfcn_t	db_listbreak_cmd;
260 db_cmdfcn_t	db_scripts_cmd;
261 db_cmdfcn_t	db_print_cmd;
262 db_cmdfcn_t	db_ps;
263 db_cmdfcn_t	db_run_cmd;
264 db_cmdfcn_t	db_script_cmd;
265 db_cmdfcn_t	db_search_cmd;
266 db_cmdfcn_t	db_set_cmd;
267 db_cmdfcn_t	db_set_thread;
268 db_cmdfcn_t	db_show_regs;
269 db_cmdfcn_t	db_show_threads;
270 db_cmdfcn_t	db_single_step_cmd;
271 db_cmdfcn_t	db_textdump_cmd;
272 db_cmdfcn_t	db_trace_until_call_cmd;
273 db_cmdfcn_t	db_trace_until_matching_cmd;
274 db_cmdfcn_t	db_unscript_cmd;
275 db_cmdfcn_t	db_watchpoint_cmd;
276 db_cmdfcn_t	db_write_cmd;
277 
278 /*
279  * Interface between DDB and the DDB output capture facility.
280  */
281 struct dumperinfo;
282 void	db_capture_dump(struct dumperinfo *di);
283 void	db_capture_enterpager(void);
284 void	db_capture_exitpager(void);
285 void	db_capture_write(char *buffer, u_int buflen);
286 void	db_capture_writech(char ch);
287 
288 /*
289  * Interface between DDB  and the script facility.
290  */
291 void	db_script_kdbenter(const char *eventname);	/* KDB enter event. */
292 
293 /*
294  * Interface between DDB and the textdump facility.
295  *
296  * Text dump blocks are of a fixed size; textdump_block_buffer is a
297  * statically allocated buffer that code interacting with textdumps can use
298  * to prepare and hold a pending block in when calling writenextblock().
299  */
300 #define	TEXTDUMP_BLOCKSIZE	512
301 extern char	textdump_block_buffer[TEXTDUMP_BLOCKSIZE];
302 
303 void	textdump_mkustar(char *block_buffer, const char *filename,
304 	    u_int size);
305 void	textdump_restoreoff(off_t offset);
306 void	textdump_saveoff(off_t *offsetp);
307 int	textdump_writenextblock(struct dumperinfo *di, char *buffer);
308 
309 /*
310  * Interface between the kernel and textdumps.
311  */
312 extern int	textdump_pending;	/* Call textdump_dumpsys() instead. */
313 void	textdump_dumpsys(struct dumperinfo *di);
314 
315 #endif /* !_DDB_DDB_H_ */
316