[apple/xnu.git] / osfmk / ddb / db_watch.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/*
 * HISTORY
 * 
 * Revision 1.1.1.1  1998/09/22 21:05:48  wsanchez
 * Import of Mac OS X kernel (~semeria)
 *
 * Revision 1.1.1.1  1998/03/07 02:26:09  wsanchez
 * Import of OSF Mach kernel (~mburg)
 *
 * Revision 1.1.6.1  1994/09/23  01:23:04  ezf
 * 	change marker to not FREE
 * 	[1994/09/22  21:11:39  ezf]
 *
 * Revision 1.1.2.4  1993/07/27  18:28:34  elliston
 * 	Add ANSI prototypes.  CR #9523.
 * 	[1993/07/27  18:13:34  elliston]
 * 
 * Revision 1.1.2.3  1993/06/07  22:07:00  jeffc
 * 	CR9176 - ANSI C violations: trailing tokens on CPP
 * 	directives, extra semicolons after decl_ ..., asm keywords
 * 	[1993/06/07  18:57:38  jeffc]
 * 
 * Revision 1.1.2.2  1993/06/02  23:13:21  jeffc
 * 	Added to OSF/1 R1.3 from NMK15.0.
 * 	[1993/06/02  20:57:59  jeffc]
 * 
 * Revision 1.1  1992/09/30  02:24:28  robert
 * 	Initial revision
 * 
 * $EndLog$
 */
/* CMU_HIST */
/*
 * Revision 2.5  91/10/09  16:04:47  af
 * 	 Revision 2.4.3.1  91/10/05  13:09:14  jeffreyh
 * 	 	Changed "map" field of db_watchpoint structure to "task",
 * 	 	and also changed paramters of function declarations.
 * 	 	[91/08/29            tak]
 * 
 * Revision 2.4.3.1  91/10/05  13:09:14  jeffreyh
 * 	Changed "map" field of db_watchpoint structure to "task",
 * 	and also changed paramters of function declarations.
 * 	[91/08/29            tak]
 * 
 * Revision 2.4  91/05/14  15:37:46  mrt
 * 	Correcting copyright
 * 
 * Revision 2.3  91/02/05  17:07:31  mrt
 * 	Changed to new Mach copyright
 * 	[91/01/31  16:20:09  mrt]
 * 
 * Revision 2.2  90/10/25  14:44:21  rwd
 * 	Generalized the watchpoint support.
 * 	[90/10/16            rwd]
 * 	Created.
 * 	[90/10/16            rpd]
 * 
 */
/* CMU_ENDHIST */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 * 	Author: David B. Golub, Carnegie Mellon University
 *	Date:	10/90
 */

#ifndef	_DDB_DB_WATCH_H_
#define	_DDB_DB_WATCH_H_

#include <mach/machine/vm_types.h>
#include <kern/task.h>
#include <machine/db_machdep.h>

/*
 * Watchpoint.
 */

typedef struct db_watchpoint {
	task_t    task;			/* in this map */
	db_addr_t loaddr;		/* from this address */
	db_addr_t hiaddr;		/* to this address */
	struct db_watchpoint *link;	/* link in in-use or free chain */
} *db_watchpoint_t;


/* Prototypes for functions exported by this module.
 */

void db_deletewatch_cmd(
	db_expr_t	addr,
	int		have_addr,
	db_expr_t	count,
	char *		modif);

void db_watchpoint_cmd(
	db_expr_t	addr,
	int		have_addr,
	db_expr_t	count,
	char *		modif);

void db_listwatch_cmd(void);

void db_clear_watchpoints(void);

void db_set_watchpoints(void);

boolean_t db_find_watchpoint(
	vm_map_t	map,
	db_addr_t	addr,
	db_regs_t	*regs);

#endif	/* !_DDB_DB_WATCH_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* @OSF_COPYRIGHT@
	27	*/
	28	/*
	29	* HISTORY
	30	*
	31	* Revision 1.1.1.1 1998/09/22 21:05:48 wsanchez
	32	* Import of Mac OS X kernel (~semeria)
	33	*
	34	* Revision 1.1.1.1 1998/03/07 02:26:09 wsanchez
	35	* Import of OSF Mach kernel (~mburg)
	36	*
	37	* Revision 1.1.6.1 1994/09/23 01:23:04 ezf
	38	* change marker to not FREE
	39	* [1994/09/22 21:11:39 ezf]
	40	*
	41	* Revision 1.1.2.4 1993/07/27 18:28:34 elliston
	42	* Add ANSI prototypes. CR #9523.
	43	* [1993/07/27 18:13:34 elliston]
	44	*
	45	* Revision 1.1.2.3 1993/06/07 22:07:00 jeffc
	46	* CR9176 - ANSI C violations: trailing tokens on CPP
	47	* directives, extra semicolons after decl_ ..., asm keywords
	48	* [1993/06/07 18:57:38 jeffc]
	49	*
	50	* Revision 1.1.2.2 1993/06/02 23:13:21 jeffc
	51	* Added to OSF/1 R1.3 from NMK15.0.
	52	* [1993/06/02 20:57:59 jeffc]
	53	*
	54	* Revision 1.1 1992/09/30 02:24:28 robert
	55	* Initial revision
	56	*
	57	* $EndLog$
	58	*/
	59	/* CMU_HIST */
	60	/*
	61	* Revision 2.5 91/10/09 16:04:47 af
	62	* Revision 2.4.3.1 91/10/05 13:09:14 jeffreyh
	63	* Changed "map" field of db_watchpoint structure to "task",
	64	* and also changed paramters of function declarations.
	65	* [91/08/29 tak]
	66	*
	67	* Revision 2.4.3.1 91/10/05 13:09:14 jeffreyh
	68	* Changed "map" field of db_watchpoint structure to "task",
	69	* and also changed paramters of function declarations.
	70	* [91/08/29 tak]
	71	*
	72	* Revision 2.4 91/05/14 15:37:46 mrt
	73	* Correcting copyright
	74	*
	75	* Revision 2.3 91/02/05 17:07:31 mrt
	76	* Changed to new Mach copyright
	77	* [91/01/31 16:20:09 mrt]
	78	*
	79	* Revision 2.2 90/10/25 14:44:21 rwd
	80	* Generalized the watchpoint support.
	81	* [90/10/16 rwd]
	82	* Created.
	83	* [90/10/16 rpd]
	84	*
	85	*/
86	/* CMU_ENDHIST */
87	/*
88	* Mach Operating System
89	* Copyright (c) 1991,1990 Carnegie Mellon University
90	* All Rights Reserved.
91	*
92	* Permission to use, copy, modify and distribute this software and its
93	* documentation is hereby granted, provided that both the copyright
94	* notice and this permission notice appear in all copies of the
95	* software, derivative works or modified versions, and any portions
96	* thereof, and that both notices appear in supporting documentation.
97	*
98	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
99	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
100	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
101	*
102	* Carnegie Mellon requests users of this software to return to
103	*
104	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
105	* School of Computer Science
106	* Carnegie Mellon University
107	* Pittsburgh PA 15213-3890
108	*
109	* any improvements or extensions that they make and grant Carnegie Mellon
110	* the rights to redistribute these changes.
111	*/
112	/*
113	*/
114	/*
115	* Author: David B. Golub, Carnegie Mellon University
116	* Date: 10/90
117	*/
118
119	#ifndef _DDB_DB_WATCH_H_
120	#define _DDB_DB_WATCH_H_
121
122	#include <mach/machine/vm_types.h>
123	#include <kern/task.h>
124	#include <machine/db_machdep.h>
125
126	/*
127	* Watchpoint.
128	*/
129
130	typedef struct db_watchpoint {
131	task_t task; /* in this map */
132	db_addr_t loaddr; /* from this address */
133	db_addr_t hiaddr; /* to this address */
134	struct db_watchpoint link; / link in in-use or free chain */
135	} *db_watchpoint_t;
136
137
138
139	/* Prototypes for functions exported by this module.
140	*/
141
142	void db_deletewatch_cmd(
143	db_expr_t addr,
144	int have_addr,
145	db_expr_t count,
146	char * modif);
147
148	void db_watchpoint_cmd(
149	db_expr_t addr,
150	int have_addr,
151	db_expr_t count,
152	char * modif);
153
154	void db_listwatch_cmd(void);
155
156	void db_clear_watchpoints(void);
157
158	void db_set_watchpoints(void);
159
160	boolean_t db_find_watchpoint(
161	vm_map_t map,
162	db_addr_t addr,
163	db_regs_t *regs);
164
165	#endif /* !_DDB_DB_WATCH_H_ */