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 43SYSCTL_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 78int 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 */ 86extern 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 */ 97struct command; 98LIST_HEAD(command_table, command); 99extern struct command_table db_cmd_table; 100extern struct command_table db_show_table; 101extern struct command_table db_show_all_table; 102 103/* 104 * Type signature for a function implementing a ddb command. 105 */ 106typedef 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 */ 112struct 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) \ 131static struct command __CONCAT(_name,_suffix) = { \ 132 .name = __STRING(_name), \ 133 .fcn = _func, \ 134 .flag = _flag, \ 135 .more = _more \ 136}; \ 137static void __CONCAT(__CONCAT(_name,_suffix),_add)(void *arg __unused) \ 138 { db_command_register(&list, &__CONCAT(_name,_suffix)); } \ 139SYSINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY, \ 140 __CONCAT(__CONCAT(_name,_suffix),_add), NULL); \ 141static void __CONCAT(__CONCAT(_name,_suffix),_del)(void *arg __unused) \ 142 { db_command_unregister(&list, &__CONCAT(_name,_suffix)); } \ 143SYSUNINIT(__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) \ 158static db_cmdfcn_t _func; \ 159_DB_SET(_suffix, _name, _func, list, _flag, _more); \ 160static 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 180extern db_expr_t db_maxoff; 181extern int db_indent; 182extern int db_inst_count; 183extern int db_load_count; 184extern int db_store_count; 185extern volatile int db_pager_quit; 186extern db_expr_t db_radix; 187extern db_expr_t db_max_width; 188extern db_expr_t db_tab_stop_width; 189extern db_expr_t db_lines_per_page; 190 191struct thread; 192struct vm_map; 193 194void db_check_interrupt(void); 195void db_clear_watchpoints(void); 196db_addr_t db_disasm(db_addr_t loc, bool altfmt); 197 /* instruction disassembler */ 198void db_error(const char *s); 199int db_expression(db_expr_t *valuep); 200int db_get_variable(db_expr_t *valuep); 201void db_iprintf(const char *,...) __printflike(1, 2); 202struct proc *db_lookup_proc(db_expr_t addr); 203struct thread *db_lookup_thread(db_expr_t addr, bool check_pid); 204struct vm_map *db_map_addr(vm_offset_t); 205bool db_map_current(struct vm_map *); 206bool db_map_equal(struct vm_map *, struct vm_map *); 207void db_md_list_watchpoints(void); 208void db_print_loc_and_inst(db_addr_t loc); 209void db_print_thread(void); 210int db_printf(const char *fmt, ...) __printflike(1, 2); 211int db_read_bytes(vm_offset_t addr, size_t size, char *data); 212 /* machine-dependent */ 213int db_readline(char *lstart, int lsize); 214void db_restart_at_pc(bool watchpt); 215int db_set_variable(db_expr_t value); 216void db_set_watchpoints(void); 217void db_skip_to_eol(void); 218bool db_stop_at_pc(int type, int code, bool *is_breakpoint, 219 bool *is_watchpoint); 220#define db_strcpy strcpy 221void db_trace_self(void); 222int db_trace_thread(struct thread *, int); 223bool db_value_of_name(const char *name, db_expr_t *valuep); 224bool db_value_of_name_pcpu(const char *name, db_expr_t *valuep); 225bool db_value_of_name_vnet(const char *name, db_expr_t *valuep); 226int db_write_bytes(vm_offset_t addr, size_t size, char *data); 227void db_command_register(struct command_table *, struct command *); 228void db_command_unregister(struct command_table *, struct command *); 229int db_fetch_ksymtab(vm_offset_t ksym_start, vm_offset_t ksym_end, 230 vm_offset_t relbase); 231 232db_cmdfcn_t db_breakpoint_cmd; 233db_cmdfcn_t db_capture_cmd; 234db_cmdfcn_t db_continue_cmd; 235db_cmdfcn_t db_delete_cmd; 236db_cmdfcn_t db_deletehwatch_cmd; 237db_cmdfcn_t db_deletewatch_cmd; 238db_cmdfcn_t db_examine_cmd; 239db_cmdfcn_t db_findstack_cmd; 240db_cmdfcn_t db_hwatchpoint_cmd; 241db_cmdfcn_t db_listbreak_cmd; 242db_cmdfcn_t db_scripts_cmd; 243db_cmdfcn_t db_print_cmd; 244db_cmdfcn_t db_ps; 245db_cmdfcn_t db_run_cmd; 246db_cmdfcn_t db_script_cmd; 247db_cmdfcn_t db_search_cmd; 248db_cmdfcn_t db_set_cmd; 249db_cmdfcn_t db_set_thread; 250db_cmdfcn_t db_show_regs; 251db_cmdfcn_t db_show_threads; 252db_cmdfcn_t db_single_step_cmd; 253db_cmdfcn_t db_textdump_cmd; 254db_cmdfcn_t db_trace_until_call_cmd; 255db_cmdfcn_t db_trace_until_matching_cmd; 256db_cmdfcn_t db_unscript_cmd; 257db_cmdfcn_t db_watchpoint_cmd; 258db_cmdfcn_t db_write_cmd; 259 260/* 261 * Interface between DDB and the DDB output capture facility. 262 */ 263struct dumperinfo; 264void db_capture_dump(struct dumperinfo *di); 265void db_capture_enterpager(void); 266void db_capture_exitpager(void); 267void db_capture_write(char *buffer, u_int buflen); 268void db_capture_writech(char ch); 269 270/* 271 * Interface between DDB and the script facility. 272 */ 273void db_script_kdbenter(const char *eventname); /* KDB enter event. */ 274 275/* 276 * Interface between DDB and the textdump facility. 277 * 278 * Text dump blocks are of a fixed size; textdump_block_buffer is a 279 * statically allocated buffer that code interacting with textdumps can use 280 * to prepare and hold a pending block in when calling writenextblock(). 281 */ 282#define TEXTDUMP_BLOCKSIZE 512 283extern char textdump_block_buffer[TEXTDUMP_BLOCKSIZE]; 284 285void textdump_mkustar(char *block_buffer, const char *filename, 286 u_int size); 287void textdump_restoreoff(off_t offset); 288void textdump_saveoff(off_t *offsetp); 289int textdump_writenextblock(struct dumperinfo *di, char *buffer); 290 291/* 292 * Interface between the kernel and textdumps. 293 */ 294extern int textdump_pending; /* Call textdump_dumpsys() instead. */ 295void textdump_dumpsys(struct dumperinfo *di); 296 297#endif /* !_DDB_DDB_H_ */ 298