2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1993, Garrett A. Wollman.
5 * Copyright (c) 1993, University of Vermont and State Agricultural College.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
36 * Necessary declarations for the `ddb' kernel debugger.
43 SYSCTL_DECL(_debug_ddb);
46 #include <machine/db_machdep.h> /* type definitions */
48 #include <sys/queue.h> /* LIST_* */
49 #include <sys/kernel.h> /* SYSINIT */
56 #define DB_MAXLINE 120
60 #define DB_MAXSCRIPTS 8
63 #ifndef DB_MAXSCRIPTNAME
64 #define DB_MAXSCRIPTNAME 32
67 #ifndef DB_MAXSCRIPTLEN
68 #define DB_MAXSCRIPTLEN 128
71 #ifndef DB_MAXSCRIPTRECURSION
72 #define DB_MAXSCRIPTRECURSION 3
76 #define DB_CALL db_fncall_generic
78 int DB_CALL(db_expr_t, db_expr_t *, int, db_expr_t[]);
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.
86 extern vm_offset_t ksymtab, kstrtab, ksymtab_size, ksymtab_relbase;
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.
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;
104 * Type signature for a function implementing a ddb command.
106 typedef void db_cmdfcn_t(db_expr_t addr, bool have_addr, db_expr_t count,
110 * Command table entry.
113 char * name; /* command name */
114 db_cmdfcn_t *fcn; /* function to call */
115 int flag; /* extra info: */
116 #define CS_OWN 0x1 /* non-standard syntax */
117 #define CS_MORE 0x2 /* standard syntax, but may have other words
119 #define CS_SET_DOT 0x100 /* set dot after command */
120 struct db_command_table *more; /* another level of command */
121 LIST_ENTRY(db_command) next; /* next entry in the command table */
125 * Arrange for the specified ddb command to be defined and
126 * bound to the specified function. Commands can be defined
127 * in modules in which case they will be available only when
128 * the module is loaded.
130 #define _DB_SET(_suffix, _name, _func, list, _flag, _more) \
131 static struct db_command __CONCAT(_name,_suffix) = { \
132 .name = __STRING(_name), \
137 static void __CONCAT(__CONCAT(_name,_suffix),_add)(void *arg __unused) \
138 { db_command_register(&list, &__CONCAT(_name,_suffix)); } \
139 SYSINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY, \
140 __CONCAT(__CONCAT(_name,_suffix),_add), NULL); \
141 static void __CONCAT(__CONCAT(_name,_suffix),_del)(void *arg __unused) \
142 { db_command_unregister(&list, &__CONCAT(_name,_suffix)); } \
143 SYSUNINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY, \
144 __CONCAT(__CONCAT(_name,_suffix),_del), NULL);
147 * Like _DB_SET but also create the function declaration which
148 * must be followed immediately by the body; e.g.
149 * _DB_FUNC(_cmd, panic, db_panic, db_cmd_table, 0, NULL)
151 * ...panic implementation...
154 * This macro is mostly used to define commands placed in one of
155 * the ddb command tables; see DB_COMMAND, etc. below.
157 #define _DB_FUNC(_suffix, _name, _func, list, _flag, _more) \
158 static db_cmdfcn_t _func; \
159 _DB_SET(_suffix, _name, _func, list, _flag, _more); \
161 _func(db_expr_t addr, bool have_addr, db_expr_t count, char *modif)
163 /* common idom provided for backwards compatibility */
164 #define DB_FUNC(_name, _func, list, _flag, _more) \
165 _DB_FUNC(_cmd, _name, _func, list, _flag, _more)
167 #define DB_COMMAND_FLAGS(cmd_name, func_name, flags) \
168 _DB_FUNC(_cmd, cmd_name, func_name, db_cmd_table, flags, NULL)
169 #define DB_COMMAND(cmd_name, func_name) \
170 DB_COMMAND_FLAGS(cmd_name, func_name, 0)
171 #define DB_ALIAS_FLAGS(alias_name, func_name, flags) \
172 _DB_SET(_cmd, alias_name, func_name, db_cmd_table, flags, NULL)
173 #define DB_ALIAS(alias_name, func_name) \
174 DB_ALIAS_FLAGS(alias_name, func_name, 0)
175 #define DB_SHOW_COMMAND_FLAGS(cmd_name, func_name, flags) \
176 _DB_FUNC(_show, cmd_name, func_name, db_show_table, flags, NULL)
177 #define DB_SHOW_COMMAND(cmd_name, func_name) \
178 DB_SHOW_COMMAND_FLAGS(cmd_name, func_name, 0)
179 #define DB_SHOW_ALIAS_FLAGS(alias_name, func_name, flags) \
180 _DB_SET(_show, alias_name, func_name, db_show_table, flags, NULL)
181 #define DB_SHOW_ALIAS(alias_name, func_name) \
182 DB_SHOW_ALIAS_FLAGS(alias_name, func_name, 0)
183 #define DB_SHOW_ALL_COMMAND(cmd_name, func_name) \
184 _DB_FUNC(_show_all, cmd_name, func_name, db_show_all_table, 0, NULL)
185 #define DB_SHOW_ALL_ALIAS(alias_name, func_name) \
186 _DB_SET(_show_all, alias_name, func_name, db_show_all_table, 0, NULL)
188 extern db_expr_t db_maxoff;
189 extern int db_indent;
190 extern int db_inst_count;
191 extern int db_load_count;
192 extern int db_store_count;
193 extern volatile int db_pager_quit;
194 extern db_expr_t db_radix;
195 extern db_expr_t db_max_width;
196 extern db_expr_t db_tab_stop_width;
197 extern db_expr_t db_lines_per_page;
202 void db_check_interrupt(void);
203 void db_clear_watchpoints(void);
204 db_addr_t db_disasm(db_addr_t loc, bool altfmt);
205 /* instruction disassembler */
206 void db_error(const char *s);
207 int db_expression(db_expr_t *valuep);
208 int db_get_variable(db_expr_t *valuep);
209 void db_iprintf(const char *,...) __printflike(1, 2);
210 struct proc *db_lookup_proc(db_expr_t addr);
211 struct thread *db_lookup_thread(db_expr_t addr, bool check_pid);
212 struct vm_map *db_map_addr(vm_offset_t);
213 bool db_map_current(struct vm_map *);
214 bool db_map_equal(struct vm_map *, struct vm_map *);
215 void db_md_list_watchpoints(void);
216 void db_print_loc_and_inst(db_addr_t loc);
217 void db_print_thread(void);
218 int db_printf(const char *fmt, ...) __printflike(1, 2);
219 int db_read_bytes(vm_offset_t addr, size_t size, char *data);
220 /* machine-dependent */
221 int db_readline(char *lstart, int lsize);
222 void db_restart_at_pc(bool watchpt);
223 int db_set_variable(db_expr_t value);
224 void db_set_watchpoints(void);
225 void db_skip_to_eol(void);
226 bool db_stop_at_pc(int type, int code, bool *is_breakpoint,
227 bool *is_watchpoint);
228 #define db_strcpy strcpy
229 void db_trace_self(void);
230 int db_trace_thread(struct thread *, int);
231 bool db_value_of_name(const char *name, db_expr_t *valuep);
232 bool db_value_of_name_pcpu(const char *name, db_expr_t *valuep);
233 bool db_value_of_name_vnet(const char *name, db_expr_t *valuep);
234 int db_write_bytes(vm_offset_t addr, size_t size, char *data);
235 void db_command_register(struct db_command_table *,
236 struct db_command *);
237 void db_command_unregister(struct db_command_table *,
238 struct db_command *);
239 int db_fetch_ksymtab(vm_offset_t ksym_start, vm_offset_t ksym_end,
240 vm_offset_t relbase);
242 db_cmdfcn_t db_breakpoint_cmd;
243 db_cmdfcn_t db_capture_cmd;
244 db_cmdfcn_t db_continue_cmd;
245 db_cmdfcn_t db_delete_cmd;
246 db_cmdfcn_t db_deletehwatch_cmd;
247 db_cmdfcn_t db_deletewatch_cmd;
248 db_cmdfcn_t db_examine_cmd;
249 db_cmdfcn_t db_findstack_cmd;
250 db_cmdfcn_t db_hwatchpoint_cmd;
251 db_cmdfcn_t db_listbreak_cmd;
252 db_cmdfcn_t db_scripts_cmd;
253 db_cmdfcn_t db_print_cmd;
255 db_cmdfcn_t db_run_cmd;
256 db_cmdfcn_t db_script_cmd;
257 db_cmdfcn_t db_search_cmd;
258 db_cmdfcn_t db_set_cmd;
259 db_cmdfcn_t db_set_thread;
260 db_cmdfcn_t db_show_regs;
261 db_cmdfcn_t db_show_threads;
262 db_cmdfcn_t db_single_step_cmd;
263 db_cmdfcn_t db_textdump_cmd;
264 db_cmdfcn_t db_trace_until_call_cmd;
265 db_cmdfcn_t db_trace_until_matching_cmd;
266 db_cmdfcn_t db_unscript_cmd;
267 db_cmdfcn_t db_watchpoint_cmd;
268 db_cmdfcn_t db_write_cmd;
271 * Interface between DDB and the DDB output capture facility.
274 void db_capture_dump(struct dumperinfo *di);
275 void db_capture_enterpager(void);
276 void db_capture_exitpager(void);
277 void db_capture_write(char *buffer, u_int buflen);
278 void db_capture_writech(char ch);
281 * Interface between DDB and the script facility.
283 void db_script_kdbenter(const char *eventname); /* KDB enter event. */
286 * Interface between DDB and the textdump facility.
288 * Text dump blocks are of a fixed size; textdump_block_buffer is a
289 * statically allocated buffer that code interacting with textdumps can use
290 * to prepare and hold a pending block in when calling writenextblock().
292 #define TEXTDUMP_BLOCKSIZE 512
293 extern char textdump_block_buffer[TEXTDUMP_BLOCKSIZE];
295 void textdump_mkustar(char *block_buffer, const char *filename,
297 void textdump_restoreoff(off_t offset);
298 void textdump_saveoff(off_t *offsetp);
299 int textdump_writenextblock(struct dumperinfo *di, char *buffer);
302 * Interface between the kernel and textdumps.
304 extern int textdump_pending; /* Call textdump_dumpsys() instead. */
305 void textdump_dumpsys(struct dumperinfo *di);
307 #endif /* !_DDB_DDB_H_ */