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