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 * @(#)ptrace.h 8.2 (Berkeley) 1/4/94 32 * $FreeBSD$ 33 */ 34 35 #ifndef _SYS_PTRACE_H_ 36 #define _SYS_PTRACE_H_ 37 38 #include <sys/signal.h> 39 #include <sys/param.h> 40 #include <machine/reg.h> 41 42 #define PT_TRACE_ME 0 /* child declares it's being traced */ 43 #define PT_READ_I 1 /* read word in child's I space */ 44 #define PT_READ_D 2 /* read word in child's D space */ 45 /* was PT_READ_U 3 * read word in child's user structure */ 46 #define PT_WRITE_I 4 /* write word in child's I space */ 47 #define PT_WRITE_D 5 /* write word in child's D space */ 48 /* was PT_WRITE_U 6 * write word in child's user structure */ 49 #define PT_CONTINUE 7 /* continue the child */ 50 #define PT_KILL 8 /* kill the child process */ 51 #define PT_STEP 9 /* single step the child */ 52 53 #define PT_ATTACH 10 /* trace some running process */ 54 #define PT_DETACH 11 /* stop tracing a process */ 55 #define PT_IO 12 /* do I/O to/from stopped process. */ 56 #define PT_LWPINFO 13 /* Info about the LWP that stopped. */ 57 #define PT_GETNUMLWPS 14 /* get total number of threads */ 58 #define PT_GETLWPLIST 15 /* get thread list */ 59 #define PT_CLEARSTEP 16 /* turn off single step */ 60 #define PT_SETSTEP 17 /* turn on single step */ 61 #define PT_SUSPEND 18 /* suspend a thread */ 62 #define PT_RESUME 19 /* resume a thread */ 63 64 #define PT_TO_SCE 20 65 #define PT_TO_SCX 21 66 #define PT_SYSCALL 22 67 68 #define PT_FOLLOW_FORK 23 69 #define PT_LWP_EVENTS 24 /* report LWP birth and exit */ 70 71 #define PT_GET_EVENT_MASK 25 /* get mask of optional events */ 72 #define PT_SET_EVENT_MASK 26 /* set mask of optional events */ 73 74 #define PT_GET_SC_ARGS 27 /* fetch syscall args */ 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 86 #define PT_FIRSTMACH 64 /* for machine-specific requests */ 87 #include <machine/ptrace.h> /* machine-specific requests, if any */ 88 89 /* Events used with PT_GET_EVENT_MASK and PT_SET_EVENT_MASK */ 90 #define PTRACE_EXEC 0x0001 91 #define PTRACE_SCE 0x0002 92 #define PTRACE_SCX 0x0004 93 #define PTRACE_SYSCALL (PTRACE_SCE | PTRACE_SCX) 94 #define PTRACE_FORK 0x0008 95 #define PTRACE_LWP 0x0010 96 #define PTRACE_VFORK 0x0020 97 98 #define PTRACE_DEFAULT (PTRACE_EXEC) 99 100 struct ptrace_io_desc { 101 int piod_op; /* I/O operation */ 102 void *piod_offs; /* child offset */ 103 void *piod_addr; /* parent offset */ 104 size_t piod_len; /* request length */ 105 }; 106 107 /* 108 * Operations in piod_op. 109 */ 110 #define PIOD_READ_D 1 /* Read from D space */ 111 #define PIOD_WRITE_D 2 /* Write to D space */ 112 #define PIOD_READ_I 3 /* Read from I space */ 113 #define PIOD_WRITE_I 4 /* Write to I space */ 114 115 /* Argument structure for PT_LWPINFO. */ 116 struct ptrace_lwpinfo { 117 lwpid_t pl_lwpid; /* LWP described. */ 118 int pl_event; /* Event that stopped the LWP. */ 119 #define PL_EVENT_NONE 0 120 #define PL_EVENT_SIGNAL 1 121 int pl_flags; /* LWP flags. */ 122 #define PL_FLAG_SA 0x01 /* M:N thread */ 123 #define PL_FLAG_BOUND 0x02 /* M:N bound thread */ 124 #define PL_FLAG_SCE 0x04 /* syscall enter point */ 125 #define PL_FLAG_SCX 0x08 /* syscall leave point */ 126 #define PL_FLAG_EXEC 0x10 /* exec(2) succeeded */ 127 #define PL_FLAG_SI 0x20 /* siginfo is valid */ 128 #define PL_FLAG_FORKED 0x40 /* new child */ 129 #define PL_FLAG_CHILD 0x80 /* I am from child */ 130 #define PL_FLAG_BORN 0x100 /* new LWP */ 131 #define PL_FLAG_EXITED 0x200 /* exiting LWP */ 132 #define PL_FLAG_VFORKED 0x400 /* new child via vfork */ 133 #define PL_FLAG_VFORK_DONE 0x800 /* vfork parent has resumed */ 134 sigset_t pl_sigmask; /* LWP signal mask */ 135 sigset_t pl_siglist; /* LWP pending signal */ 136 struct __siginfo pl_siginfo; /* siginfo for signal */ 137 char pl_tdname[MAXCOMLEN + 1]; /* LWP name */ 138 pid_t pl_child_pid; /* New child pid */ 139 u_int pl_syscall_code; 140 u_int pl_syscall_narg; 141 }; 142 143 #if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__)) 144 struct ptrace_lwpinfo32 { 145 lwpid_t pl_lwpid; /* LWP described. */ 146 int pl_event; /* Event that stopped the LWP. */ 147 int pl_flags; /* LWP flags. */ 148 sigset_t pl_sigmask; /* LWP signal mask */ 149 sigset_t pl_siglist; /* LWP pending signal */ 150 struct siginfo32 pl_siginfo; /* siginfo for signal */ 151 char pl_tdname[MAXCOMLEN + 1]; /* LWP name. */ 152 pid_t pl_child_pid; /* New child pid */ 153 u_int pl_syscall_code; 154 u_int pl_syscall_narg; 155 }; 156 #endif 157 158 /* Argument structure for PT_VM_ENTRY. */ 159 struct ptrace_vm_entry { 160 int pve_entry; /* Entry number used for iteration. */ 161 int pve_timestamp; /* Generation number of VM map. */ 162 u_long pve_start; /* Start VA of range. */ 163 u_long pve_end; /* End VA of range (incl). */ 164 u_long pve_offset; /* Offset in backing object. */ 165 u_int pve_prot; /* Protection of memory range. */ 166 u_int pve_pathlen; /* Size of path. */ 167 long pve_fileid; /* File ID. */ 168 uint32_t pve_fsid; /* File system ID. */ 169 char *pve_path; /* Path name of object. */ 170 }; 171 172 #ifdef _KERNEL 173 174 int ptrace_set_pc(struct thread *_td, unsigned long _addr); 175 int ptrace_single_step(struct thread *_td); 176 int ptrace_clear_single_step(struct thread *_td); 177 178 #ifdef __HAVE_PTRACE_MACHDEP 179 int cpu_ptrace(struct thread *_td, int _req, void *_addr, int _data); 180 #endif 181 182 /* 183 * These are prototypes for functions that implement some of the 184 * debugging functionality exported by procfs / linprocfs and by the 185 * ptrace(2) syscall. They used to be part of procfs, but they don't 186 * really belong there. 187 */ 188 struct reg; 189 struct fpreg; 190 struct dbreg; 191 struct uio; 192 int proc_read_regs(struct thread *_td, struct reg *_reg); 193 int proc_write_regs(struct thread *_td, struct reg *_reg); 194 int proc_read_fpregs(struct thread *_td, struct fpreg *_fpreg); 195 int proc_write_fpregs(struct thread *_td, struct fpreg *_fpreg); 196 int proc_read_dbregs(struct thread *_td, struct dbreg *_dbreg); 197 int proc_write_dbregs(struct thread *_td, struct dbreg *_dbreg); 198 int proc_sstep(struct thread *_td); 199 int proc_rwmem(struct proc *_p, struct uio *_uio); 200 ssize_t proc_readmem(struct thread *_td, struct proc *_p, vm_offset_t _va, 201 void *_buf, size_t _len); 202 ssize_t proc_writemem(struct thread *_td, struct proc *_p, vm_offset_t _va, 203 void *_buf, size_t _len); 204 #ifdef COMPAT_FREEBSD32 205 struct reg32; 206 struct fpreg32; 207 struct dbreg32; 208 int proc_read_regs32(struct thread *_td, struct reg32 *_reg32); 209 int proc_write_regs32(struct thread *_td, struct reg32 *_reg32); 210 int proc_read_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32); 211 int proc_write_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32); 212 int proc_read_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32); 213 int proc_write_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32); 214 #endif 215 #else /* !_KERNEL */ 216 217 #include <sys/cdefs.h> 218 219 __BEGIN_DECLS 220 int ptrace(int _request, pid_t _pid, caddr_t _addr, int _data); 221 __END_DECLS 222 223 #endif /* !_KERNEL */ 224 225 #endif /* !_SYS_PTRACE_H_ */ 226