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