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