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 command; 98 LIST_HEAD(command_table, command); 99 extern struct command_table db_cmd_table; 100 extern struct command_table db_show_table; 101 extern struct 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 command { 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 118 * at end */ 119 #define CS_SET_DOT 0x100 /* set dot after command */ 120 struct command_table *more; /* another level of command */ 121 LIST_ENTRY(command) next; /* next entry in the command table */ 122 }; 123 124 /* 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. 129 */ 130 #define _DB_SET(_suffix, _name, _func, list, _flag, _more) \ 131 static struct command __CONCAT(_name,_suffix) = { \ 132 .name = __STRING(_name), \ 133 .fcn = _func, \ 134 .flag = _flag, \ 135 .more = _more \ 136 }; \ 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); 145 146 /* 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) 150 * { 151 * ...panic implementation... 152 * } 153 * 154 * This macro is mostly used to define commands placed in one of 155 * the ddb command tables; see DB_COMMAND, etc. below. 156 */ 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); \ 160 static void \ 161 _func(db_expr_t addr, bool have_addr, db_expr_t count, char *modif) 162 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) 166 167 #define DB_COMMAND(cmd_name, func_name) \ 168 _DB_FUNC(_cmd, cmd_name, func_name, db_cmd_table, 0, NULL) 169 #define DB_ALIAS(alias_name, func_name) \ 170 _DB_SET(_cmd, alias_name, func_name, db_cmd_table, 0, NULL) 171 #define DB_SHOW_COMMAND(cmd_name, func_name) \ 172 _DB_FUNC(_show, cmd_name, func_name, db_show_table, 0, NULL) 173 #define DB_SHOW_ALIAS(alias_name, func_name) \ 174 _DB_SET(_show, alias_name, func_name, db_show_table, 0, NULL) 175 #define DB_SHOW_ALL_COMMAND(cmd_name, func_name) \ 176 _DB_FUNC(_show_all, cmd_name, func_name, db_show_all_table, 0, NULL) 177 #define DB_SHOW_ALL_ALIAS(alias_name, func_name) \ 178 _DB_SET(_show_all, alias_name, func_name, db_show_all_table, 0, NULL) 179 180 extern db_expr_t db_maxoff; 181 extern int db_indent; 182 extern int db_inst_count; 183 extern int db_load_count; 184 extern int db_store_count; 185 extern volatile int db_pager_quit; 186 extern db_expr_t db_radix; 187 extern db_expr_t db_max_width; 188 extern db_expr_t db_tab_stop_width; 189 extern db_expr_t db_lines_per_page; 190 191 struct thread; 192 struct vm_map; 193 194 void db_check_interrupt(void); 195 void db_clear_watchpoints(void); 196 db_addr_t db_disasm(db_addr_t loc, bool altfmt); 197 /* instruction disassembler */ 198 void db_error(const char *s); 199 int db_expression(db_expr_t *valuep); 200 int db_get_variable(db_expr_t *valuep); 201 void db_iprintf(const char *,...) __printflike(1, 2); 202 struct proc *db_lookup_proc(db_expr_t addr); 203 struct thread *db_lookup_thread(db_expr_t addr, bool check_pid); 204 struct vm_map *db_map_addr(vm_offset_t); 205 bool db_map_current(struct vm_map *); 206 bool db_map_equal(struct vm_map *, struct vm_map *); 207 int db_md_set_watchpoint(db_expr_t addr, db_expr_t size); 208 int db_md_clr_watchpoint(db_expr_t addr, db_expr_t size); 209 void db_md_list_watchpoints(void); 210 void db_print_loc_and_inst(db_addr_t loc); 211 void db_print_thread(void); 212 int db_printf(const char *fmt, ...) __printflike(1, 2); 213 int db_read_bytes(vm_offset_t addr, size_t size, char *data); 214 /* machine-dependent */ 215 int db_readline(char *lstart, int lsize); 216 void db_restart_at_pc(bool watchpt); 217 int db_set_variable(db_expr_t value); 218 void db_set_watchpoints(void); 219 void db_skip_to_eol(void); 220 bool db_stop_at_pc(int type, int code, bool *is_breakpoint, 221 bool *is_watchpoint); 222 #define db_strcpy strcpy 223 void db_trace_self(void); 224 int db_trace_thread(struct thread *, int); 225 bool db_value_of_name(const char *name, db_expr_t *valuep); 226 bool db_value_of_name_pcpu(const char *name, db_expr_t *valuep); 227 bool db_value_of_name_vnet(const char *name, db_expr_t *valuep); 228 int db_write_bytes(vm_offset_t addr, size_t size, char *data); 229 void db_command_register(struct command_table *, struct command *); 230 void db_command_unregister(struct command_table *, struct command *); 231 int db_fetch_ksymtab(vm_offset_t ksym_start, vm_offset_t ksym_end, 232 vm_offset_t relbase); 233 234 db_cmdfcn_t db_breakpoint_cmd; 235 db_cmdfcn_t db_capture_cmd; 236 db_cmdfcn_t db_continue_cmd; 237 db_cmdfcn_t db_delete_cmd; 238 db_cmdfcn_t db_deletehwatch_cmd; 239 db_cmdfcn_t db_deletewatch_cmd; 240 db_cmdfcn_t db_examine_cmd; 241 db_cmdfcn_t db_findstack_cmd; 242 db_cmdfcn_t db_hwatchpoint_cmd; 243 db_cmdfcn_t db_listbreak_cmd; 244 db_cmdfcn_t db_scripts_cmd; 245 db_cmdfcn_t db_print_cmd; 246 db_cmdfcn_t db_ps; 247 db_cmdfcn_t db_run_cmd; 248 db_cmdfcn_t db_script_cmd; 249 db_cmdfcn_t db_search_cmd; 250 db_cmdfcn_t db_set_cmd; 251 db_cmdfcn_t db_set_thread; 252 db_cmdfcn_t db_show_regs; 253 db_cmdfcn_t db_show_threads; 254 db_cmdfcn_t db_single_step_cmd; 255 db_cmdfcn_t db_textdump_cmd; 256 db_cmdfcn_t db_trace_until_call_cmd; 257 db_cmdfcn_t db_trace_until_matching_cmd; 258 db_cmdfcn_t db_unscript_cmd; 259 db_cmdfcn_t db_watchpoint_cmd; 260 db_cmdfcn_t db_write_cmd; 261 262 /* 263 * Interface between DDB and the DDB output capture facility. 264 */ 265 struct dumperinfo; 266 void db_capture_dump(struct dumperinfo *di); 267 void db_capture_enterpager(void); 268 void db_capture_exitpager(void); 269 void db_capture_write(char *buffer, u_int buflen); 270 void db_capture_writech(char ch); 271 272 /* 273 * Interface between DDB and the script facility. 274 */ 275 void db_script_kdbenter(const char *eventname); /* KDB enter event. */ 276 277 /* 278 * Interface between DDB and the textdump facility. 279 * 280 * Text dump blocks are of a fixed size; textdump_block_buffer is a 281 * statically allocated buffer that code interacting with textdumps can use 282 * to prepare and hold a pending block in when calling writenextblock(). 283 */ 284 #define TEXTDUMP_BLOCKSIZE 512 285 extern char textdump_block_buffer[TEXTDUMP_BLOCKSIZE]; 286 287 void textdump_mkustar(char *block_buffer, const char *filename, 288 u_int size); 289 void textdump_restoreoff(off_t offset); 290 void textdump_saveoff(off_t *offsetp); 291 int textdump_writenextblock(struct dumperinfo *di, char *buffer); 292 293 /* 294 * Interface between the kernel and textdumps. 295 */ 296 extern int textdump_pending; /* Call textdump_dumpsys() instead. */ 297 void textdump_dumpsys(struct dumperinfo *di); 298 299 #endif /* !_DDB_DDB_H_ */ 300