xref: /illumos-gate/usr/src/uts/common/sys/watchpoint.h (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _SYS_WATCHPOINT_H
28 #define	_SYS_WATCHPOINT_H
29 
30 #include <sys/types.h>
31 #include <vm/seg_enum.h>
32 #include <sys/copyops.h>
33 #include <sys/avl.h>
34 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 /*
40  * Definitions for the VM implementation of watchpoints.
41  * See proc(5) and <sys/procfs.h> for definitions of the user interface.
42  */
43 
44 /*
45  * Each process with watchpoints has a linked list of watched areas.
46  * The list is kept sorted by user-level virtual address.
47  */
48 typedef struct watched_area {
49 	avl_node_t wa_link;	/* link in AVL tree */
50 	caddr_t	wa_vaddr;	/* virtual address of watched area */
51 	caddr_t	wa_eaddr;	/* virtual address plus size */
52 	ulong_t	wa_flags;	/* watch type flags (see <sys/procfs.h>) */
53 } watched_area_t;
54 
55 /*
56  * The list of watched areas maps into a list of pages with modified
57  * protections.  The list is kept sorted by user-level virtual address.
58  */
59 typedef struct watched_page {
60 	avl_node_t wp_link;	/* Link in AVL tree */
61 	struct watched_page *wp_list;	/* link in p_wprot */
62 	caddr_t	wp_vaddr;	/* virtual address of this page */
63 	uchar_t	wp_prot;	/* modified protection bits */
64 	uchar_t	wp_oprot;	/* original protection bits */
65 	uchar_t	wp_umap[3];	/* reference counts of user pr_mappage()s */
66 	uchar_t	wp_kmap[3];	/* reference counts of kernel pr_mappage()s */
67 	ushort_t wp_flags;	/* see below */
68 	short	wp_read;	/* number of WA_READ areas in this page */
69 	short	wp_write;	/* number of WA_WRITE areas in this page */
70 	short	wp_exec;	/* number of WA_EXEC areas in this page */
71 } watched_page_t;
72 
73 /* wp_flags */
74 #define	WP_NOWATCH	0x01	/* protections temporarily restored */
75 #define	WP_SETPROT	0x02	/* SEGOP_SETPROT() needed on this page */
76 
77 #ifdef	_KERNEL
78 
79 /*
80  * These functions handle the necessary logic to perform the copy operation
81  * while ignoring watchpoints.
82  */
83 extern int copyin_nowatch(const void *, void *, size_t);
84 extern int copyout_nowatch(const void *, void *, size_t);
85 extern int fuword32_nowatch(const void *, uint32_t *);
86 extern int suword32_nowatch(void *, uint32_t);
87 #ifdef _LP64
88 extern int suword64_nowatch(void *, uint64_t);
89 extern int fuword64_nowatch(const void *, uint64_t *);
90 #endif
91 
92 /*
93  * Disable watchpoints for a given region of memory.  When bracketed by these
94  * calls, functions can use copyops and ignore watchpoints.
95  */
96 extern int watch_disable_addr(const void *, size_t, enum seg_rw);
97 extern void watch_enable_addr(const void *, size_t, enum seg_rw);
98 
99 /*
100  * Enable/Disable watchpoints for an entire thread.
101  */
102 extern	void	watch_enable(kthread_id_t);
103 extern	void	watch_disable(kthread_id_t);
104 
105 struct as;
106 struct proc;
107 struct k_siginfo;
108 extern	void	setallwatch(void);
109 extern	int	pr_is_watchpage(caddr_t, enum seg_rw);
110 extern	int	pr_is_watchpage_as(caddr_t, enum seg_rw, struct as *);
111 extern	int	pr_is_watchpoint(caddr_t *, int *, size_t, size_t *,
112 			enum seg_rw);
113 extern	void	do_watch_step(caddr_t, size_t, enum seg_rw, int, greg_t);
114 extern	int	undo_watch_step(struct k_siginfo *);
115 extern	int	wp_compare(const void *, const void *);
116 extern	int	wa_compare(const void *, const void *);
117 
118 extern	struct copyops watch_copyops;
119 
120 extern watched_area_t *pr_find_watched_area(struct proc *, watched_area_t *,
121     avl_index_t *);
122 
123 #endif
124 
125 #ifdef	__cplusplus
126 }
127 #endif
128 
129 #endif	/* _SYS_WATCHPOINT_H */
130