- Port rtw(4) from NetBSD, which supports various RealTek 8180 chip based
[dragonfly.git] / 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: src/sys/ddb/ddb.h,v 1.24.2.2 2002/08/30 22:27:49 gibbs Exp $
31  * $DragonFly: src/sys/ddb/ddb.h,v 1.9 2006/05/20 02:42:01 dillon Exp $
32  */
33
34 /*
35  * Necessary declarations for the `ddb' kernel debugger.
36  */
37
38 #ifndef _DDB_DDB_H_
39 #define _DDB_DDB_H_
40
41 #ifndef _SYS_QUEUE_H_
42 #include <sys/queue.h>
43 #endif
44
45 #ifndef _MACHINE_DB_MACHDEP_H_
46 #include <machine/db_machdep.h>         /* type definitions */
47 #endif
48
49 typedef void db_cmdfcn_t (db_expr_t addr, boolean_t have_addr,
50                               db_expr_t count, char *modif);
51
52 #define DB_COMMAND(cmd_name, func_name) \
53         DB_SET(cmd_name, func_name, db_cmd_set, 0, NULL)
54 #define DB_SHOW_COMMAND(cmd_name, func_name) \
55         DB_SET(cmd_name, func_name, db_show_cmd_set, 0, NULL)
56
57 #define DB_SET(cmd_name, func_name, set, flag, more)            \
58 static db_cmdfcn_t      func_name;                              \
59                                                                 \
60 static const struct command __CONCAT(func_name,_cmd) = {        \
61         __STRING(cmd_name),                                     \
62         func_name,                                              \
63         flag,                                                   \
64         more                                                    \
65 };                                                              \
66 TEXT_SET(set, __CONCAT(func_name,_cmd));                        \
67                                                                 \
68 static void                                                     \
69 func_name(db_expr_t addr, boolean_t have_addr, db_expr_t count, \
70           char *modif)
71
72 extern char *esym;
73 extern db_expr_t db_maxoff;
74 extern int db_active;
75 extern int db_indent;
76 extern int db_inst_count;
77 extern int db_load_count;
78 extern int debugger_on_panic;
79 extern int db_store_count;
80 extern db_expr_t db_radix;
81 extern db_expr_t db_max_width;
82 extern db_expr_t db_tab_stop_width;
83
84 struct vm_map;
85
86 int             db_more(int *nl);
87 void            db_check_interrupt (void);
88 void            db_clear_watchpoints (void);
89 db_addr_t       db_disasm (db_addr_t loc, boolean_t altfmt, db_regs_t *regs);
90                                 /* instruction disassembler */
91 void            db_error (char *s);
92 int             db_expression (db_expr_t *valuep);
93 int             db_get_variable (db_expr_t *valuep);
94 void            db_iprintf (const char *,...) __printflike(1, 2);
95 struct vm_map   *db_map_addr (vm_offset_t);
96 boolean_t       db_map_current (struct vm_map *);
97 boolean_t       db_map_equal (struct vm_map *, struct vm_map *);
98 void            db_print_loc_and_inst (db_addr_t loc, db_regs_t *regs);
99 void            db_printf (const char *fmt, ...) __printflike(1, 2);
100 void            db_read_bytes (vm_offset_t addr, size_t size, char *data);
101                                 /* machine-dependent */
102 int             db_readline (char *lstart, int lsize);
103 void            db_restart_at_pc (boolean_t watchpt);
104 void            db_set_watchpoints (void);
105 void            db_skip_to_eol (void);
106 boolean_t       db_stop_at_pc (boolean_t *is_breakpoint);
107 #define         db_strcpy       strcpy
108 void            db_trap (int type, int code);
109 int             db_value_of_name (const char *name, db_expr_t *valuep);
110 void            db_write_bytes (vm_offset_t addr, size_t size, char *data);
111                                 /* machine-dependent */
112 void            kdb_init (void);
113
114 db_cmdfcn_t     db_breakpoint_cmd;
115 db_cmdfcn_t     db_continue_cmd;
116 db_cmdfcn_t     db_delete_cmd;
117 db_cmdfcn_t     db_deletehwatch_cmd;
118 db_cmdfcn_t     db_deletewatch_cmd;
119 db_cmdfcn_t     db_examine_cmd;
120 db_cmdfcn_t     db_hwatchpoint_cmd;
121 db_cmdfcn_t     db_listbreak_cmd;
122 db_cmdfcn_t     db_print_cmd;
123 db_cmdfcn_t     db_ps;
124 db_cmdfcn_t     db_search_cmd;
125 db_cmdfcn_t     db_set_cmd;
126 db_cmdfcn_t     db_show_regs;
127 db_cmdfcn_t     db_single_step_cmd;
128 db_cmdfcn_t     db_stack_trace_cmd;
129 db_cmdfcn_t     db_trace_until_call_cmd;
130 db_cmdfcn_t     db_trace_until_matching_cmd;
131 db_cmdfcn_t     db_watchpoint_cmd;
132 db_cmdfcn_t     db_write_cmd;
133
134 #if 0
135 db_cmdfcn_t     db_help_cmd;
136 db_cmdfcn_t     db_show_all_threads;
137 db_cmdfcn_t     db_show_one_thread;
138 db_cmdfcn_t     ipc_port_print;
139 db_cmdfcn_t     vm_page_print;
140 #endif
141
142 /*
143  * Print backtrace. (Machine-Dependant)
144  */
145 void            db_print_backtrace(void);
146
147 /*
148  * Command table.
149  */
150 struct command {
151         char *  name;           /* command name */
152         db_cmdfcn_t *fcn;       /* function to call */
153         int     flag;           /* extra info: */
154 #define CS_OWN          0x1     /* non-standard syntax */
155 #define CS_MORE         0x2     /* standard syntax, but may have other words
156                                  * at end */
157 #define CS_SET_DOT      0x100   /* set dot after command */
158         struct command *more;   /* another level of command */
159 };
160
161 /* XXX: UGLY hack */
162 #ifdef CN_DEAD
163 /*
164  * Routines to support GDB on an sio port.
165  */
166 extern dev_t       gdbdev;
167 extern cn_getc_t *gdb_getc;
168 extern cn_putc_t *gdb_putc;
169 #endif
170
171 #endif /* !_DDB_DDB_H_ */