ddb.h revision 174921
1/*- 2 * Copyright (c) 1993, Garrett A. Wollman. 3 * Copyright (c) 1993, University of Vermont and State Agricultural College. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. Neither the name of the University nor the names of its contributors 15 * may be used to endorse or promote products derived from this software 16 * without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD: head/sys/ddb/ddb.h 174921 2007-12-26 11:32:33Z rwatson $ 31 */ 32 33/* 34 * Necessary declarations for the `ddb' kernel debugger. 35 */ 36 37#ifndef _DDB_DDB_H_ 38#define _DDB_DDB_H_ 39 40#ifdef SYSCTL_DECL 41SYSCTL_DECL(_debug_ddb); 42#endif 43 44#include <machine/db_machdep.h> /* type definitions */ 45 46#ifndef DB_MAXARGS 47#define DB_MAXARGS 10 48#endif 49 50#ifndef DB_MAXLINE 51#define DB_MAXLINE 120 52#endif 53 54#ifndef DB_MAXSCRIPTS 55#define DB_MAXSCRIPTS 8 56#endif 57 58#ifndef DB_MAXSCRIPTNAME 59#define DB_MAXSCRIPTNAME 32 60#endif 61 62#ifndef DB_MAXSCRIPTLEN 63#define DB_MAXSCRIPTLEN 128 64#endif 65 66#ifndef DB_MAXSCRIPTRECURSION 67#define DB_MAXSCRIPTRECURSION 3 68#endif 69 70#ifndef DB_CALL 71#define DB_CALL db_fncall_generic 72#else 73int DB_CALL(db_expr_t, db_expr_t *, int, db_expr_t[]); 74#endif 75 76typedef void db_cmdfcn_t(db_expr_t addr, boolean_t have_addr, db_expr_t count, 77 char *modif); 78 79#define DB_COMMAND(cmd_name, func_name) \ 80 DB_FUNC(cmd_name, func_name, db_cmd_set, 0, NULL) 81#define DB_SHOW_COMMAND(cmd_name, func_name) \ 82 DB_FUNC(cmd_name, func_name, db_show_cmd_set, 0, NULL) 83 84#define DB_SET(cmd_name, func_name, set, flag, more) \ 85static const struct command __CONCAT(cmd_name,_cmd) = { \ 86 __STRING(cmd_name), \ 87 func_name, \ 88 flag, \ 89 more \ 90}; \ 91TEXT_SET(set, __CONCAT(cmd_name,_cmd)) 92 93#define DB_FUNC(cmd_name, func_name, set, flag, more) \ 94static db_cmdfcn_t func_name; \ 95 \ 96DB_SET(cmd_name, func_name, set, flag, more); \ 97 \ 98static void \ 99func_name(addr, have_addr, count, modif) \ 100 db_expr_t addr; \ 101 boolean_t have_addr; \ 102 db_expr_t count; \ 103 char *modif; 104 105extern db_expr_t db_maxoff; 106extern int db_indent; 107extern int db_inst_count; 108extern int db_load_count; 109extern int db_store_count; 110extern volatile int db_pager_quit; 111extern db_expr_t db_radix; 112extern db_expr_t db_max_width; 113extern db_expr_t db_tab_stop_width; 114extern db_expr_t db_lines_per_page; 115 116struct thread; 117struct vm_map; 118 119void db_check_interrupt(void); 120void db_clear_watchpoints(void); 121db_addr_t db_disasm(db_addr_t loc, boolean_t altfmt); 122 /* instruction disassembler */ 123void db_error(const char *s); 124int db_expression(db_expr_t *valuep); 125int db_get_variable(db_expr_t *valuep); 126void db_iprintf(const char *,...) __printflike(1, 2); 127struct proc *db_lookup_proc(db_expr_t addr); 128struct thread *db_lookup_thread(db_expr_t addr, boolean_t check_pid); 129struct vm_map *db_map_addr(vm_offset_t); 130boolean_t db_map_current(struct vm_map *); 131boolean_t db_map_equal(struct vm_map *, struct vm_map *); 132int db_md_set_watchpoint(db_expr_t addr, db_expr_t size); 133int db_md_clr_watchpoint(db_expr_t addr, db_expr_t size); 134void db_md_list_watchpoints(void); 135void db_print_loc_and_inst(db_addr_t loc); 136void db_print_thread(void); 137void db_printf(const char *fmt, ...) __printflike(1, 2); 138int db_read_bytes(vm_offset_t addr, size_t size, char *data); 139 /* machine-dependent */ 140int db_readline(char *lstart, int lsize); 141void db_restart_at_pc(boolean_t watchpt); 142int db_set_variable(db_expr_t value); 143void db_set_watchpoints(void); 144void db_skip_to_eol(void); 145boolean_t db_stop_at_pc(boolean_t *is_breakpoint); 146#define db_strcpy strcpy 147void db_trace_self(void); 148int db_trace_thread(struct thread *, int); 149int db_value_of_name(const char *name, db_expr_t *valuep); 150int db_write_bytes(vm_offset_t addr, size_t size, char *data); 151 152db_cmdfcn_t db_breakpoint_cmd; 153db_cmdfcn_t db_capture_cmd; 154db_cmdfcn_t db_continue_cmd; 155db_cmdfcn_t db_delete_cmd; 156db_cmdfcn_t db_deletehwatch_cmd; 157db_cmdfcn_t db_deletewatch_cmd; 158db_cmdfcn_t db_examine_cmd; 159db_cmdfcn_t db_hwatchpoint_cmd; 160db_cmdfcn_t db_listbreak_cmd; 161db_cmdfcn_t db_scripts_cmd; 162db_cmdfcn_t db_print_cmd; 163db_cmdfcn_t db_ps; 164db_cmdfcn_t db_run_cmd; 165db_cmdfcn_t db_script_cmd; 166db_cmdfcn_t db_search_cmd; 167db_cmdfcn_t db_set_cmd; 168db_cmdfcn_t db_set_thread; 169db_cmdfcn_t db_show_regs; 170db_cmdfcn_t db_show_threads; 171db_cmdfcn_t db_single_step_cmd; 172db_cmdfcn_t db_textdump_cmd; 173db_cmdfcn_t db_trace_until_call_cmd; 174db_cmdfcn_t db_trace_until_matching_cmd; 175db_cmdfcn_t db_unscript_cmd; 176db_cmdfcn_t db_watchpoint_cmd; 177db_cmdfcn_t db_write_cmd; 178 179/* 180 * Command table. 181 */ 182struct command; 183 184struct command_table { 185 struct command *table; 186 struct command **aux_tablep; 187 struct command **aux_tablep_end; 188}; 189 190struct command { 191 char * name; /* command name */ 192 db_cmdfcn_t *fcn; /* function to call */ 193 int flag; /* extra info: */ 194#define CS_OWN 0x1 /* non-standard syntax */ 195#define CS_MORE 0x2 /* standard syntax, but may have other words 196 * at end */ 197#define CS_SET_DOT 0x100 /* set dot after command */ 198 struct command_table *more; /* another level of command */ 199}; 200 201/* 202 * Interface between DDB and the DDB output capture facility. 203 */ 204struct dumperinfo; 205void db_capture_dump(struct dumperinfo *di); 206void db_capture_enterpager(void); 207void db_capture_exitpager(void); 208void db_capture_write(char *buffer, u_int buflen); 209void db_capture_writech(char ch); 210 211/* 212 * Interface between DDB and the script facility. 213 */ 214void db_script_kdbenter(const char *eventname); /* KDB enter event. */ 215 216/* 217 * Interface between DDB and the textdump facility. 218 * 219 * Text dump blocks are of a fixed size; textdump_block_buffer is a 220 * statically allocated buffer that code interacting with textdumps can use 221 * to prepare and hold a pending block in when calling writenextblock(). 222 */ 223#define TEXTDUMP_BLOCKSIZE 512 224extern char textdump_block_buffer[TEXTDUMP_BLOCKSIZE]; 225 226void textdump_mkustar(char *block_buffer, const char *filename, 227 u_int size); 228void textdump_restoreoff(off_t offset); 229void textdump_saveoff(off_t *offsetp); 230int textdump_writenextblock(struct dumperinfo *di, char *buffer); 231 232/* 233 * Interface between the kernel and textdumps. 234 */ 235extern int textdump_pending; /* Call textdump_dumpsys() instead. */ 236void textdump_dumpsys(struct dumperinfo *di); 237 238#endif /* !_DDB_DDB_H_ */ 239