1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1984, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_PTRACE_H_
33#define _SYS_PTRACE_H_
34
35#include <sys/signal.h>
36#include <sys/param.h>
37#include <machine/reg.h>
38
39#define PT_TRACE_ME 0 /* child declares it's being traced */
40#define PT_READ_I 1 /* read word in child's I space */
41#define PT_READ_D 2 /* read word in child's D space */
42/* was PT_READ_U 3 * read word in child's user structure */
43#define PT_WRITE_I 4 /* write word in child's I space */
44#define PT_WRITE_D 5 /* write word in child's D space */
45/* was PT_WRITE_U 6 * write word in child's user structure */
46#define PT_CONTINUE 7 /* continue the child */
47#define PT_KILL 8 /* kill the child process */
48#define PT_STEP 9 /* single step the child */
49
50#define PT_ATTACH 10 /* trace some running process */
51#define PT_DETACH 11 /* stop tracing a process */
52#define PT_IO 12 /* do I/O to/from stopped process. */
53#define PT_LWPINFO 13 /* Info about the LWP that stopped. */
54#define PT_GETNUMLWPS 14 /* get total number of threads */
55#define PT_GETLWPLIST 15 /* get thread list */
56#define PT_CLEARSTEP 16 /* turn off single step */
57#define PT_SETSTEP 17 /* turn on single step */
58#define PT_SUSPEND 18 /* suspend a thread */
59#define PT_RESUME 19 /* resume a thread */
60
61#define PT_TO_SCE 20
62#define PT_TO_SCX 21
63#define PT_SYSCALL 22
64
65#define PT_FOLLOW_FORK 23
66#define PT_LWP_EVENTS 24 /* report LWP birth and exit */
67
68#define PT_GET_EVENT_MASK 25 /* get mask of optional events */
69#define PT_SET_EVENT_MASK 26 /* set mask of optional events */
70
71#define PT_GET_SC_ARGS 27 /* fetch syscall args */
72#define PT_GET_SC_RET 28 /* fetch syscall results */
73
74#define PT_COREDUMP 29 /* create a coredump */
75
76#define PT_GETREGS 33 /* get general-purpose registers */
77#define PT_SETREGS 34 /* set general-purpose registers */
78#define PT_GETFPREGS 35 /* get floating-point registers */
79#define PT_SETFPREGS 36 /* set floating-point registers */
80#define PT_GETDBREGS 37 /* get debugging registers */
81#define PT_SETDBREGS 38 /* set debugging registers */
82
83#define PT_VM_TIMESTAMP 40 /* Get VM version (timestamp) */
84#define PT_VM_ENTRY 41 /* Get VM map (entry) */
85#define PT_GETREGSET 42 /* Get a target register set */
86#define PT_SETREGSET 43 /* Set a target register set */
87#define PT_SC_REMOTE 44 /* Execute a syscall */
88
89#define PT_FIRSTMACH 64 /* for machine-specific requests */
90#define PT_LASTMACH 127
91#include <machine/ptrace.h> /* machine-specific requests, if any */
92
93#ifdef _KERNEL
94/* Space for ptrace commands not exposed directly to userspace. */
95#define PTINTERNAL_FIRST 128
96#define PTINTERNAL_LAST 191
97#define PTLINUX_GET_SC_ARGS (PTINTERNAL_FIRST + 0)
98#endif
99
100/* Events used with PT_GET_EVENT_MASK and PT_SET_EVENT_MASK */
101#define PTRACE_EXEC 0x0001
102#define PTRACE_SCE 0x0002
103#define PTRACE_SCX 0x0004
104#define PTRACE_SYSCALL (PTRACE_SCE | PTRACE_SCX)
105#define PTRACE_FORK 0x0008
106#define PTRACE_LWP 0x0010
107#define PTRACE_VFORK 0x0020
108
109#define PTRACE_DEFAULT (PTRACE_EXEC)
110
111struct ptrace_io_desc {
112 int piod_op; /* I/O operation */
113 void *piod_offs; /* child offset */
114 void *piod_addr; /* parent offset */
115 size_t piod_len; /* request length */
116};
117
118/*
119 * Operations in piod_op.
120 */
121#define PIOD_READ_D 1 /* Read from D space */
122#define PIOD_WRITE_D 2 /* Write to D space */
123#define PIOD_READ_I 3 /* Read from I space */
124#define PIOD_WRITE_I 4 /* Write to I space */
125
126/* Argument structure for PT_LWPINFO. */
127struct ptrace_lwpinfo {
128 lwpid_t pl_lwpid; /* LWP described. */
129 int pl_event; /* Event that stopped the LWP. */
130#define PL_EVENT_NONE 0
131#define PL_EVENT_SIGNAL 1
132 int pl_flags; /* LWP flags. */
133#define PL_FLAG_SA 0x01 /* M:N thread */
134#define PL_FLAG_BOUND 0x02 /* M:N bound thread */
135#define PL_FLAG_SCE 0x04 /* syscall enter point */
136#define PL_FLAG_SCX 0x08 /* syscall leave point */
137#define PL_FLAG_EXEC 0x10 /* exec(2) succeeded */
138#define PL_FLAG_SI 0x20 /* siginfo is valid */
139#define PL_FLAG_FORKED 0x40 /* new child */
140#define PL_FLAG_CHILD 0x80 /* I am from child */
141#define PL_FLAG_BORN 0x100 /* new LWP */
142#define PL_FLAG_EXITED 0x200 /* exiting LWP */
143#define PL_FLAG_VFORKED 0x400 /* new child via vfork */
144#define PL_FLAG_VFORK_DONE 0x800 /* vfork parent has resumed */
145 sigset_t pl_sigmask; /* LWP signal mask */
146 sigset_t pl_siglist; /* LWP pending signal */
147 struct __siginfo pl_siginfo; /* siginfo for signal */
148 char pl_tdname[MAXCOMLEN + 1]; /* LWP name */
149 pid_t pl_child_pid; /* New child pid */
150 u_int pl_syscall_code;
151 u_int pl_syscall_narg;
152};
153
154#if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__))
155struct ptrace_lwpinfo32 {
156 lwpid_t pl_lwpid; /* LWP described. */
157 int pl_event; /* Event that stopped the LWP. */
158 int pl_flags; /* LWP flags. */
159 sigset_t pl_sigmask; /* LWP signal mask */
160 sigset_t pl_siglist; /* LWP pending signal */
161 struct __siginfo32 pl_siginfo; /* siginfo for signal */
162 char pl_tdname[MAXCOMLEN + 1]; /* LWP name. */
163 pid_t pl_child_pid; /* New child pid */
164 u_int pl_syscall_code;
165 u_int pl_syscall_narg;
166};
167#endif
168
169/* Argument structure for PT_GET_SC_RET. */
170struct ptrace_sc_ret {
171 syscallarg_t sr_retval[2]; /* Only valid if sr_error == 0. */
172 int sr_error;
173};
174
175/* Argument structure for PT_VM_ENTRY. */
176struct ptrace_vm_entry {
177 int pve_entry; /* Entry number used for iteration. */
178 int pve_timestamp; /* Generation number of VM map. */
179 u_long pve_start; /* Start VA of range. */
180 u_long pve_end; /* End VA of range (incl). */
181 u_long pve_offset; /* Offset in backing object. */
182 u_int pve_prot; /* Protection of memory range. */
183 u_int pve_pathlen; /* Size of path. */
184 long pve_fileid; /* File ID. */
185 uint32_t pve_fsid; /* File system ID. */
186 char *pve_path; /* Path name of object. */
187};
188
189/* Argument structure for PT_COREDUMP */
190struct ptrace_coredump {
191 int pc_fd; /* File descriptor to write dump to. */
192 uint32_t pc_flags; /* Flags PC_* */
193 off_t pc_limit; /* Maximum size of the coredump,
194 0 for no limit. */
195};
196
197/* Flags for PT_COREDUMP pc_flags */
198#define PC_COMPRESS 0x00000001 /* Allow compression */
199#define PC_ALL 0x00000002 /* Include non-dumpable entries */
200
201struct ptrace_sc_remote {
202 struct ptrace_sc_ret pscr_ret;
203 u_int pscr_syscall;
204 u_int pscr_nargs;
205 syscallarg_t *pscr_args;
206};
207
208#ifdef _KERNEL
209
210#include <sys/proc.h>
211
212struct thr_coredump_req {
213 struct vnode *tc_vp; /* vnode to write coredump to. */
214 off_t tc_limit; /* max coredump file size. */
215 int tc_flags; /* user flags */
216 int tc_error; /* request result */
217};
218
219struct thr_syscall_req {
220 struct ptrace_sc_ret ts_ret;
221 u_int ts_nargs;
222 struct syscall_args ts_sa;
223};
224
225int ptrace_set_pc(struct thread *_td, unsigned long _addr);
226int ptrace_single_step(struct thread *_td);
227int ptrace_clear_single_step(struct thread *_td);
228
229#ifdef __HAVE_PTRACE_MACHDEP
230int cpu_ptrace(struct thread *_td, int _req, void *_addr, int _data);
231#endif
232
233/*
234 * These are prototypes for functions that implement some of the
235 * debugging functionality exported by procfs / linprocfs and by the
236 * ptrace(2) syscall. They used to be part of procfs, but they don't
237 * really belong there.
238 */
239struct reg;
240struct fpreg;
241struct dbreg;
242struct uio;
243int proc_read_regs(struct thread *_td, struct reg *_reg);
244int proc_write_regs(struct thread *_td, struct reg *_reg);
245int proc_read_fpregs(struct thread *_td, struct fpreg *_fpreg);
246int proc_write_fpregs(struct thread *_td, struct fpreg *_fpreg);
247int proc_read_dbregs(struct thread *_td, struct dbreg *_dbreg);
248int proc_write_dbregs(struct thread *_td, struct dbreg *_dbreg);
249int proc_sstep(struct thread *_td);
250int proc_rwmem(struct proc *_p, struct uio *_uio);
251ssize_t proc_readmem(struct thread *_td, struct proc *_p, vm_offset_t _va,
252 void *_buf, size_t _len);
253ssize_t proc_writemem(struct thread *_td, struct proc *_p, vm_offset_t _va,
254 void *_buf, size_t _len);
255#ifdef COMPAT_FREEBSD32
256struct reg32;
257struct fpreg32;
258struct dbreg32;
259int proc_read_regs32(struct thread *_td, struct reg32 *_reg32);
260int proc_write_regs32(struct thread *_td, struct reg32 *_reg32);
261int proc_read_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32);
262int proc_write_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32);
263int proc_read_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32);
264int proc_write_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32);
265#endif
266
267void ptrace_unsuspend(struct proc *p);
268
269extern bool allow_ptrace;
270
271#else /* !_KERNEL */
272
273#include <sys/cdefs.h>
274
275__BEGIN_DECLS
276int ptrace(int _request, pid_t _pid, caddr_t _addr, int _data);
277__END_DECLS
278
279#endif /* !_KERNEL */
280
281#endif /* !_SYS_PTRACE_H_ */