xref: /minix/minix/commands/swifi/ddb.h (revision 433d6423)
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 
31 /*
32  * Necessary declarations for the `ddb' kernel debugger.
33  */
34 
35 #ifndef _DDB_DDB_H_
36 #define	_DDB_DDB_H_
37 
38 #define __P(protos) protos
39 typedef int boolean_t;
40 typedef unsigned long vm_offset_t;
41 
42 #include "db_machdep.h"		/* type definitions */
43 
44 typedef void db_cmdfcn_t __P((db_expr_t addr, boolean_t have_addr,
45 			      db_expr_t count, char *modif));
46 
47 #define DB_COMMAND(cmd_name, func_name) \
48 	DB_SET(cmd_name, func_name, db_cmd_set)
49 #define DB_SHOW_COMMAND(cmd_name, func_name) \
50 	DB_SET(cmd_name, func_name, db_show_cmd_set)
51 
52 #define DB_SET(cmd_name, func_name, set)			\
53 static db_cmdfcn_t	func_name;				\
54 								\
55 static const struct command __CONCAT(func_name,_cmd) = {	\
56 	__STRING(cmd_name),					\
57 	func_name,						\
58 	0,							\
59 	0,							\
60 };								\
61 TEXT_SET(set, __CONCAT(func_name,_cmd));			\
62 								\
63 static void							\
64 func_name(addr, have_addr, count, modif)			\
65 	db_expr_t addr;						\
66 	boolean_t have_addr;					\
67 	db_expr_t count;					\
68 	char *modif;
69 
70 extern char *esym;
71 extern unsigned int db_maxoff;
72 extern int db_indent;
73 extern int db_inst_count;
74 extern int db_load_count;
75 extern int db_store_count;
76 extern int db_radix;
77 extern int db_max_width;
78 extern int db_tab_stop_width;
79 
80 struct vm_map;
81 
82 void		cnpollc __P((int));
83 void		db_check_interrupt __P((void));
84 void		db_clear_watchpoints __P((void));
85 db_addr_t	db_disasm __P((db_addr_t loc, boolean_t altfmt));
86 				/* instruction disassembler */
87 #if 0
88 //void		db_error __P((char *s));
89 #endif
90 #define db_error printk
91 int		db_expression __P((db_expr_t *valuep));
92 int		db_get_variable __P((db_expr_t *valuep));
93 void		db_iprintf __P((const char *,...));
94 struct vm_map	*db_map_addr __P((vm_offset_t));
95 boolean_t	db_map_current __P((struct vm_map *));
96 boolean_t	db_map_equal __P((struct vm_map *, struct vm_map *));
97 void		db_print_loc_and_inst __P((db_addr_t loc));
98 void		db_printf __P((const char *fmt, ...));
99 void		db_read_bytes __P((vm_offset_t addr, int size, char *data));
100 				/* machine-dependent */
101 int		db_readline __P((char *lstart, int lsize));
102 void		db_restart_at_pc __P((boolean_t watchpt));
103 void		db_set_watchpoints __P((void));
104 void		db_skip_to_eol __P((void));
105 boolean_t	db_stop_at_pc __P((boolean_t *is_breakpoint));
106 #define		db_strcpy	strcpy
107 void		db_trap __P((int type, int code));
108 int		db_value_of_name __P((char *name, db_expr_t *valuep));
109 void		db_write_bytes __P((vm_offset_t addr, int size, char *data));
110 				/* machine-dependent */
111 void		kdb_init __P((void));
112 void		kdbprintf __P((const char *fmt, ...));
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_deletewatch_cmd;
118 db_cmdfcn_t	db_examine_cmd;
119 db_cmdfcn_t	db_listbreak_cmd;
120 db_cmdfcn_t	db_listwatch_cmd;
121 db_cmdfcn_t	db_print_cmd;
122 db_cmdfcn_t	db_ps;
123 db_cmdfcn_t	db_search_cmd;
124 db_cmdfcn_t	db_set_cmd;
125 db_cmdfcn_t	db_show_regs;
126 db_cmdfcn_t	db_single_step_cmd;
127 db_cmdfcn_t	db_stack_trace_cmd;
128 db_cmdfcn_t	db_trace_until_call_cmd;
129 db_cmdfcn_t	db_trace_until_matching_cmd;
130 db_cmdfcn_t	db_watchpoint_cmd;
131 db_cmdfcn_t	db_write_cmd;
132 
133 #if 0
134 db_cmdfcn_t	db_help_cmd;
135 db_cmdfcn_t	db_show_all_threads;
136 db_cmdfcn_t	db_show_one_thread;
137 db_cmdfcn_t	ipc_port_print;
138 db_cmdfcn_t	vm_page_print;
139 #endif
140 
141 /*
142  * Command table.
143  */
144 struct command {
145 	char *	name;		/* command name */
146 	db_cmdfcn_t *fcn;	/* function to call */
147 	int	flag;		/* extra info: */
148 #define	CS_OWN		0x1	/* non-standard syntax */
149 #define	CS_MORE		0x2	/* standard syntax, but may have other words
150 				 * at end */
151 #define	CS_SET_DOT	0x100	/* set dot after command */
152 	struct command *more;	/* another level of command */
153 };
154 
155 db_addr_t
156 my_disasm(db_addr_t	loc,
157 	  boolean_t	altfmt);
158 
159 #endif /* !_DDB_DDB_H_ */
160