ptrace.h revision 1.17 1 /* $NetBSD: ptrace.h,v 1.17 2017/01/16 21:35:59 kamil Exp $ */
2
3 /*
4 * Copyright (c) 2001 Wasabi Systems, Inc.
5 * All rights reserved.
6 *
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed for the NetBSD Project by
20 * Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 * or promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 /*
39 * Copyright (c) 1993 Christopher G. Demetriou
40 * All rights reserved.
41 *
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgement:
52 * This product includes software developed by Christopher G. Demetriou.
53 * 4. The name of the author may not be used to endorse or promote products
54 * derived from this software without specific prior written permission
55 *
56 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
57 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
58 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
59 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
60 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
61 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
62 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
63 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
64 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
65 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 */
67
68 #ifndef _I386_PTRACE_H_
69 #define _I386_PTRACE_H_
70
71 /*
72 * i386-dependent ptrace definitions
73 */
74 #define PT_STEP (PT_FIRSTMACH + 0)
75 #define PT_GETREGS (PT_FIRSTMACH + 1)
76 #define PT_SETREGS (PT_FIRSTMACH + 2)
77 #define PT_GETFPREGS (PT_FIRSTMACH + 3)
78 #define PT_SETFPREGS (PT_FIRSTMACH + 4)
79
80 /* We have machine-dependent process tracing needs. */
81 #define __HAVE_PTRACE_MACHDEP
82
83 /* We have machine-dependent procfs nodes. */
84 #define __HAVE_PROCFS_MACHDEP
85
86 /* The machine-dependent ptrace(2) requests. */
87 #define PT_GETXMMREGS (PT_FIRSTMACH + 5)
88 #define PT_SETXMMREGS (PT_FIRSTMACH + 6)
89 #define PT_READ_WATCHPOINT (PT_FIRSTMACH + 7)
90 #define PT_WRITE_WATCHPOINT (PT_FIRSTMACH + 8)
91 #define PT_COUNT_WATCHPOINTS (PT_FIRSTMACH + 9)
92
93 #define PT_MACHDEP_STRINGS \
94 "PT_STEP", \
95 "PT_GETREGS", \
96 "PT_SETREGS", \
97 "PT_GETFPREGS", \
98 "PT_SETFPREGS", \
99 "PT_GETXMMREGS", \
100 "PT_SETXMMREGS", \
101 "PT_READ_WATCHPOINT", \
102 "PT_WRITE_WATCHPOINT", \
103 "PT_COUNT_WATCHPOINTS"
104
105 #include <machine/reg.h>
106 #define PTRACE_REG_PC(r) (r)->r_eip
107 #define PTRACE_REG_SET_PC(r, v) (r)->r_eip = (v)
108 #define PTRACE_REG_SP(r) (r)->r_esp
109 #define PTRACE_REG_INTRV(r) (r)->r_eax
110
111 #define PTRACE_BREAKPOINT ((const uint8_t[]) { 0xcc })
112 #define PTRACE_BREAKPOINT_SIZE 1
113 #define PTRACE_BREAKPOINT_ADJ sizeof(PTRACE_BREAKPOINT)
114
115 #define __HAVE_PTRACE_WATCHPOINTS
116
117 /*
118 * The current list of supported hardware watchpoints
119 */
120 #define PTRACE_PW_TYPE_DBREGS 1
121
122 struct mdpw {
123 union {
124 /* Debug Registers DR0-3, DR6, DR7 */
125 struct {
126 void *_md_address;
127 int _md_condition;
128 int _md_length;
129 } _dbregs;
130 } _type;
131 };
132
133 /*
134 * This MD structure translates into x86_hw_watchpoint
135 *
136 * pw_address - 0 represents disabled hardware watchpoint
137 *
138 * conditions:
139 * 0b00 - execution
140 * 0b01 - data write
141 * 0b10 - io read/write (not implemented)
142 * 0b11 - data read/write
143 *
144 * length:
145 * 0b00 - 1 byte
146 * 0b01 - 2 bytes
147 * 0b10 - undefined
148 * 0b11 - 4 bytes
149 *
150 * Helper symbols for conditions and length are available in <x86/dbregs.h>
151 *
152 */
153
154 #define md_address _type._dbregs._md_address
155 #define md_condition _type._dbregs._md_condition
156 #define md_length _type._dbregs._md_length
157
158
159 #ifdef _KERNEL
160
161 /*
162 * These are used in sys_ptrace() to find good ptrace(2) requests.
163 */
164 #define PTRACE_MACHDEP_REQUEST_CASES \
165 case PT_GETXMMREGS: \
166 case PT_SETXMMREGS:
167
168 /*
169 * These are used to define machine-dependent procfs node types.
170 */
171 #define PROCFS_MACHDEP_NODE_TYPES \
172 Pmachdep_xmmregs, /* extended FP register set */
173
174 /*
175 * These are used in switch statements to catch machine-dependent
176 * procfs node types.
177 */
178 #define PROCFS_MACHDEP_NODETYPE_CASES \
179 case Pmachdep_xmmregs:
180
181 /*
182 * These are used to protect a privileged process's state.
183 */
184 #define PROCFS_MACHDEP_PROTECT_CASES \
185 case Pmachdep_xmmregs:
186
187 /*
188 * These are used to define the machine-dependent procfs nodes.
189 */
190 #define PROCFS_MACHDEP_NODETYPE_DEFNS \
191 { DT_REG, N("xmmregs"), Pmachdep_xmmregs, \
192 procfs_machdep_validxmmregs },
193
194 struct xmmregs;
195
196 /* Functions used by both ptrace(2) and procfs. */
197 int process_machdep_doxmmregs(struct lwp *, struct lwp *, struct uio *);
198 int process_machdep_validxmmregs(struct proc *);
199
200 /* Functions used by procfs. */
201 struct mount;
202 struct pfsnode;
203 int procfs_machdep_doxmmregs(struct lwp *, struct lwp *,
204 struct pfsnode *, struct uio *);
205 int procfs_machdep_validxmmregs(struct lwp *, struct mount *);
206
207 #endif /* _KERNEL */
208
209 #endif /* _I386_PTRACE_H_ */
210