1 /*-
2  * Copyright (c) 1984, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)ptrace.h	8.2 (Berkeley) 1/4/94
30  * $FreeBSD: stable/9/sys/sys/ptrace.h 290464 2015-11-06 20:10:54Z jhb $
31  */
32 
33 #ifndef	_SYS_PTRACE_H_
34 #define	_SYS_PTRACE_H_
35 
36 #include <sys/signal.h>
37 #include <sys/param.h>
38 #include <machine/reg.h>
39 
40 #define	PT_TRACE_ME	0	/* child declares it's being traced */
41 #define	PT_READ_I	1	/* read word in child's I space */
42 #define	PT_READ_D	2	/* read word in child's D space */
43 /* was	PT_READ_U	3	 * read word in child's user structure */
44 #define	PT_WRITE_I	4	/* write word in child's I space */
45 #define	PT_WRITE_D	5	/* write word in child's D space */
46 /* was	PT_WRITE_U	6	 * write word in child's user structure */
47 #define	PT_CONTINUE	7	/* continue the child */
48 #define	PT_KILL		8	/* kill the child process */
49 #define	PT_STEP		9	/* single step the child */
50 
51 #define	PT_ATTACH	10	/* trace some running process */
52 #define	PT_DETACH	11	/* stop tracing a process */
53 #define PT_IO		12	/* do I/O to/from stopped process. */
54 #define	PT_LWPINFO	13	/* Info about the LWP that stopped. */
55 #define PT_GETNUMLWPS	14	/* get total number of threads */
56 #define PT_GETLWPLIST	15	/* get thread list */
57 #define PT_CLEARSTEP	16	/* turn off single step */
58 #define PT_SETSTEP	17	/* turn on single step */
59 #define PT_SUSPEND	18	/* suspend a thread */
60 #define PT_RESUME	19	/* resume a thread */
61 
62 #define	PT_TO_SCE	20
63 #define	PT_TO_SCX	21
64 #define	PT_SYSCALL	22
65 
66 #define	PT_FOLLOW_FORK	23
67 
68 #define PT_GETREGS      33	/* get general-purpose registers */
69 #define PT_SETREGS      34	/* set general-purpose registers */
70 #define PT_GETFPREGS    35	/* get floating-point registers */
71 #define PT_SETFPREGS    36	/* set floating-point registers */
72 #define PT_GETDBREGS    37	/* get debugging registers */
73 #define PT_SETDBREGS    38	/* set debugging registers */
74 
75 #define	PT_VM_TIMESTAMP	40	/* Get VM version (timestamp) */
76 #define	PT_VM_ENTRY	41	/* Get VM map (entry) */
77 
78 #define PT_FIRSTMACH    64	/* for machine-specific requests */
79 #include <machine/ptrace.h>	/* machine-specific requests, if any */
80 
81 struct ptrace_io_desc {
82 	int	piod_op;	/* I/O operation */
83 	void	*piod_offs;	/* child offset */
84 	void	*piod_addr;	/* parent offset */
85 	size_t	piod_len;	/* request length */
86 };
87 
88 /*
89  * Operations in piod_op.
90  */
91 #define PIOD_READ_D	1	/* Read from D space */
92 #define PIOD_WRITE_D	2	/* Write to D space */
93 #define PIOD_READ_I	3	/* Read from I space */
94 #define PIOD_WRITE_I	4	/* Write to I space */
95 
96 /* Argument structure for PT_LWPINFO. */
97 struct ptrace_lwpinfo {
98 	lwpid_t	pl_lwpid;	/* LWP described. */
99 	int	pl_event;	/* Event that stopped the LWP. */
100 #define	PL_EVENT_NONE	0
101 #define	PL_EVENT_SIGNAL	1
102 	int	pl_flags;	/* LWP flags. */
103 #define	PL_FLAG_SA	0x01	/* M:N thread */
104 #define	PL_FLAG_BOUND	0x02	/* M:N bound thread */
105 #define	PL_FLAG_SCE	0x04	/* syscall enter point */
106 #define	PL_FLAG_SCX	0x08	/* syscall leave point */
107 #define	PL_FLAG_EXEC	0x10	/* exec(2) succeeded */
108 #define	PL_FLAG_SI	0x20	/* siginfo is valid */
109 #define	PL_FLAG_FORKED	0x40	/* new child */
110 #define	PL_FLAG_CHILD	0x80	/* I am from child */
111 	sigset_t	pl_sigmask;	/* LWP signal mask */
112 	sigset_t	pl_siglist;	/* LWP pending signal */
113 	struct __siginfo pl_siginfo;	/* siginfo for signal */
114 	char		pl_tdname[MAXCOMLEN + 1]; /* LWP name */
115 	pid_t		pl_child_pid;	/* New child pid */
116 	u_int		pl_syscall_code;
117 	u_int		pl_syscall_narg;
118 };
119 
120 /* Argument structure for PT_VM_ENTRY. */
121 struct ptrace_vm_entry {
122 	int		pve_entry;	/* Entry number used for iteration. */
123 	int		pve_timestamp;	/* Generation number of VM map. */
124 	u_long		pve_start;	/* Start VA of range. */
125 	u_long		pve_end;	/* End VA of range (incl). */
126 	u_long		pve_offset;	/* Offset in backing object. */
127 	u_int		pve_prot;	/* Protection of memory range. */
128 	u_int		pve_pathlen;	/* Size of path. */
129 	long		pve_fileid;	/* File ID. */
130 	uint32_t	pve_fsid;	/* File system ID. */
131 	char		*pve_path;	/* Path name of object. */
132 };
133 
134 #ifdef _KERNEL
135 
136 /*
137  * The flags below are used for ptrace(2) tracing and have no relation
138  * to procfs.  They are stored in struct proc's p_stops member.
139  */
140 #define	S_PT_SCE	0x000010000
141 #define	S_PT_SCX	0x000020000
142 
143 int	ptrace_set_pc(struct thread *_td, unsigned long _addr);
144 int	ptrace_single_step(struct thread *_td);
145 int	ptrace_clear_single_step(struct thread *_td);
146 
147 #ifdef __HAVE_PTRACE_MACHDEP
148 int	cpu_ptrace(struct thread *_td, int _req, void *_addr, int _data);
149 #endif
150 
151 /*
152  * These are prototypes for functions that implement some of the
153  * debugging functionality exported by procfs / linprocfs and by the
154  * ptrace(2) syscall.  They used to be part of procfs, but they don't
155  * really belong there.
156  */
157 struct reg;
158 struct fpreg;
159 struct dbreg;
160 struct uio;
161 int	proc_read_regs(struct thread *_td, struct reg *_reg);
162 int	proc_write_regs(struct thread *_td, struct reg *_reg);
163 int	proc_read_fpregs(struct thread *_td, struct fpreg *_fpreg);
164 int	proc_write_fpregs(struct thread *_td, struct fpreg *_fpreg);
165 int	proc_read_dbregs(struct thread *_td, struct dbreg *_dbreg);
166 int	proc_write_dbregs(struct thread *_td, struct dbreg *_dbreg);
167 int	proc_sstep(struct thread *_td);
168 int	proc_rwmem(struct proc *_p, struct uio *_uio);
169 #ifdef COMPAT_FREEBSD32
170 struct reg32;
171 struct fpreg32;
172 struct dbreg32;
173 int	proc_read_regs32(struct thread *_td, struct reg32 *_reg32);
174 int	proc_write_regs32(struct thread *_td, struct reg32 *_reg32);
175 int	proc_read_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32);
176 int	proc_write_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32);
177 int	proc_read_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32);
178 int	proc_write_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32);
179 #endif
180 #else /* !_KERNEL */
181 
182 #include <sys/cdefs.h>
183 
184 __BEGIN_DECLS
185 int	ptrace(int _request, pid_t _pid, caddr_t _addr, int _data);
186 __END_DECLS
187 
188 #endif /* !_KERNEL */
189 
190 #endif	/* !_SYS_PTRACE_H_ */
191