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$ 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 #include <machine/db_machdep.h> /* type definitions */ 41 42 #define DB_LINES_PER_PAGE 20 43 44 typedef void db_cmdfcn_t(db_expr_t addr, boolean_t have_addr, db_expr_t count, 45 char *modif); 46 47 typedef void db_page_calloutfcn_t(void *arg); 48 49 #define DB_COMMAND(cmd_name, func_name) \ 50 DB_SET(cmd_name, func_name, db_cmd_set, 0, NULL) 51 #define DB_SHOW_COMMAND(cmd_name, func_name) \ 52 DB_SET(cmd_name, func_name, db_show_cmd_set, 0, NULL) 53 54 #define DB_SET(cmd_name, func_name, set, flag, more) \ 55 static db_cmdfcn_t func_name; \ 56 \ 57 static const struct command __CONCAT(func_name,_cmd) = { \ 58 __STRING(cmd_name), \ 59 func_name, \ 60 flag, \ 61 more \ 62 }; \ 63 TEXT_SET(set, __CONCAT(func_name,_cmd)); \ 64 \ 65 static void \ 66 func_name(addr, have_addr, count, modif) \ 67 db_expr_t addr; \ 68 boolean_t have_addr; \ 69 db_expr_t count; \ 70 char *modif; 71 72 extern db_expr_t db_maxoff; 73 extern int db_indent; 74 extern int db_inst_count; 75 extern int db_load_count; 76 extern int debugger_on_panic; 77 extern int db_store_count; 78 extern db_expr_t db_radix; 79 extern db_expr_t db_max_width; 80 extern db_expr_t db_tab_stop_width; 81 82 struct thread; 83 struct vm_map; 84 85 void db_check_interrupt(void); 86 void db_clear_watchpoints(void); 87 db_addr_t db_disasm(db_addr_t loc, boolean_t altfmt); 88 /* instruction disassembler */ 89 void db_error(const char *s); 90 int db_expression(db_expr_t *valuep); 91 int db_get_variable(db_expr_t *valuep); 92 void db_iprintf(const char *,...) __printflike(1, 2); 93 struct vm_map *db_map_addr(vm_offset_t); 94 boolean_t db_map_current(struct vm_map *); 95 boolean_t db_map_equal(struct vm_map *, struct vm_map *); 96 void db_print_loc_and_inst(db_addr_t loc); 97 void db_print_thread(void); 98 void db_printf(const char *fmt, ...) __printflike(1, 2); 99 int db_read_bytes(vm_offset_t addr, size_t size, char *data); 100 /* machine-dependent */ 101 int db_readline(char *lstart, int lsize); 102 void db_restart_at_pc(boolean_t watchpt); 103 int db_set_variable(db_expr_t value); 104 void db_set_watchpoints(void); 105 void db_setup_paging(db_page_calloutfcn_t *callout, void *arg, 106 int maxlines); 107 void db_skip_to_eol(void); 108 boolean_t db_stop_at_pc(boolean_t *is_breakpoint); 109 #define db_strcpy strcpy 110 void db_trace_self(void); 111 int db_trace_thread(struct thread *, int); 112 int db_value_of_name(const char *name, db_expr_t *valuep); 113 int db_write_bytes(vm_offset_t addr, size_t size, char *data); 114 115 db_cmdfcn_t db_breakpoint_cmd; 116 db_cmdfcn_t db_continue_cmd; 117 db_cmdfcn_t db_delete_cmd; 118 db_cmdfcn_t db_deletehwatch_cmd; 119 db_cmdfcn_t db_deletewatch_cmd; 120 db_cmdfcn_t db_examine_cmd; 121 db_cmdfcn_t db_hwatchpoint_cmd; 122 db_cmdfcn_t db_listbreak_cmd; 123 db_cmdfcn_t db_print_cmd; 124 db_cmdfcn_t db_ps; 125 db_cmdfcn_t db_search_cmd; 126 db_cmdfcn_t db_set_cmd; 127 db_cmdfcn_t db_set_thread; 128 db_cmdfcn_t db_show_regs; 129 db_cmdfcn_t db_show_threads; 130 db_cmdfcn_t db_single_step_cmd; 131 db_cmdfcn_t db_stack_trace_cmd; 132 db_cmdfcn_t db_trace_until_call_cmd; 133 db_cmdfcn_t db_trace_until_matching_cmd; 134 db_cmdfcn_t db_watchpoint_cmd; 135 db_cmdfcn_t db_write_cmd; 136 137 db_page_calloutfcn_t db_simple_pager; 138 139 /* 140 * Command table. 141 */ 142 struct command { 143 char * name; /* command name */ 144 db_cmdfcn_t *fcn; /* function to call */ 145 int flag; /* extra info: */ 146 #define CS_OWN 0x1 /* non-standard syntax */ 147 #define CS_MORE 0x2 /* standard syntax, but may have other words 148 * at end */ 149 #define CS_SET_DOT 0x100 /* set dot after command */ 150 struct command *more; /* another level of command */ 151 }; 152 153 #endif /* !_DDB_DDB_H_ */ 154