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#include <machine/ptrace.h> /* machine-specific requests, if any */ 91 92/* Events used with PT_GET_EVENT_MASK and PT_SET_EVENT_MASK */ 93#define PTRACE_EXEC 0x0001 94#define PTRACE_SCE 0x0002 95#define PTRACE_SCX 0x0004 96#define PTRACE_SYSCALL (PTRACE_SCE | PTRACE_SCX) 97#define PTRACE_FORK 0x0008 98#define PTRACE_LWP 0x0010 99#define PTRACE_VFORK 0x0020 100 101#define PTRACE_DEFAULT (PTRACE_EXEC) 102 103struct ptrace_io_desc { 104 int piod_op; /* I/O operation */ 105 void *piod_offs; /* child offset */ 106 void *piod_addr; /* parent offset */ 107 size_t piod_len; /* request length */ 108}; 109 110/* 111 * Operations in piod_op. 112 */ 113#define PIOD_READ_D 1 /* Read from D space */ 114#define PIOD_WRITE_D 2 /* Write to D space */ 115#define PIOD_READ_I 3 /* Read from I space */ 116#define PIOD_WRITE_I 4 /* Write to I space */ 117 118/* Argument structure for PT_LWPINFO. */ 119struct ptrace_lwpinfo { 120 lwpid_t pl_lwpid; /* LWP described. */ 121 int pl_event; /* Event that stopped the LWP. */ 122#define PL_EVENT_NONE 0 123#define PL_EVENT_SIGNAL 1 124 int pl_flags; /* LWP flags. */ 125#define PL_FLAG_SA 0x01 /* M:N thread */ 126#define PL_FLAG_BOUND 0x02 /* M:N bound thread */ 127#define PL_FLAG_SCE 0x04 /* syscall enter point */ 128#define PL_FLAG_SCX 0x08 /* syscall leave point */ 129#define PL_FLAG_EXEC 0x10 /* exec(2) succeeded */ 130#define PL_FLAG_SI 0x20 /* siginfo is valid */ 131#define PL_FLAG_FORKED 0x40 /* new child */ 132#define PL_FLAG_CHILD 0x80 /* I am from child */ 133#define PL_FLAG_BORN 0x100 /* new LWP */ 134#define PL_FLAG_EXITED 0x200 /* exiting LWP */ 135#define PL_FLAG_VFORKED 0x400 /* new child via vfork */ 136#define PL_FLAG_VFORK_DONE 0x800 /* vfork parent has resumed */ 137 sigset_t pl_sigmask; /* LWP signal mask */ 138 sigset_t pl_siglist; /* LWP pending signal */ 139 struct __siginfo pl_siginfo; /* siginfo for signal */ 140 char pl_tdname[MAXCOMLEN + 1]; /* LWP name */ 141 pid_t pl_child_pid; /* New child pid */ 142 u_int pl_syscall_code; 143 u_int pl_syscall_narg; 144}; 145 146#if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__)) 147struct ptrace_lwpinfo32 { 148 lwpid_t pl_lwpid; /* LWP described. */ 149 int pl_event; /* Event that stopped the LWP. */ 150 int pl_flags; /* LWP flags. */ 151 sigset_t pl_sigmask; /* LWP signal mask */ 152 sigset_t pl_siglist; /* LWP pending signal */ 153 struct __siginfo32 pl_siginfo; /* siginfo for signal */ 154 char pl_tdname[MAXCOMLEN + 1]; /* LWP name. */ 155 pid_t pl_child_pid; /* New child pid */ 156 u_int pl_syscall_code; 157 u_int pl_syscall_narg; 158}; 159#endif 160 161/* Argument structure for PT_GET_SC_RET. */ 162struct ptrace_sc_ret { 163 syscallarg_t sr_retval[2]; /* Only valid if sr_error == 0. */ 164 int sr_error; 165}; 166 167/* Argument structure for PT_VM_ENTRY. */ 168struct ptrace_vm_entry { 169 int pve_entry; /* Entry number used for iteration. */ 170 int pve_timestamp; /* Generation number of VM map. */ 171 u_long pve_start; /* Start VA of range. */ 172 u_long pve_end; /* End VA of range (incl). */ 173 u_long pve_offset; /* Offset in backing object. */ 174 u_int pve_prot; /* Protection of memory range. */ 175 u_int pve_pathlen; /* Size of path. */ 176 long pve_fileid; /* File ID. */ 177 uint32_t pve_fsid; /* File system ID. */ 178 char *pve_path; /* Path name of object. */ 179}; 180 181/* Argument structure for PT_COREDUMP */ 182struct ptrace_coredump { 183 int pc_fd; /* File descriptor to write dump to. */ 184 uint32_t pc_flags; /* Flags PC_* */ 185 off_t pc_limit; /* Maximum size of the coredump, 186 0 for no limit. */ 187}; 188 189/* Flags for PT_COREDUMP pc_flags */ 190#define PC_COMPRESS 0x00000001 /* Allow compression */ 191#define PC_ALL 0x00000002 /* Include non-dumpable entries */ 192 193struct ptrace_sc_remote { 194 struct ptrace_sc_ret pscr_ret; 195 u_int pscr_syscall; 196 u_int pscr_nargs; 197 syscallarg_t *pscr_args; 198}; 199 200#ifdef _KERNEL 201 202#include <sys/proc.h> 203 204struct thr_coredump_req { 205 struct vnode *tc_vp; /* vnode to write coredump to. */ 206 off_t tc_limit; /* max coredump file size. */ 207 int tc_flags; /* user flags */ 208 int tc_error; /* request result */ 209}; 210 211struct thr_syscall_req { 212 struct ptrace_sc_ret ts_ret; 213 u_int ts_nargs; 214 struct syscall_args ts_sa; 215}; 216 217int ptrace_set_pc(struct thread *_td, unsigned long _addr); 218int ptrace_single_step(struct thread *_td); 219int ptrace_clear_single_step(struct thread *_td); 220 221#ifdef __HAVE_PTRACE_MACHDEP 222int cpu_ptrace(struct thread *_td, int _req, void *_addr, int _data); 223#endif 224 225/* 226 * These are prototypes for functions that implement some of the 227 * debugging functionality exported by procfs / linprocfs and by the 228 * ptrace(2) syscall. They used to be part of procfs, but they don't 229 * really belong there. 230 */ 231struct reg; 232struct fpreg; 233struct dbreg; 234struct uio; 235int proc_read_regs(struct thread *_td, struct reg *_reg); 236int proc_write_regs(struct thread *_td, struct reg *_reg); 237int proc_read_fpregs(struct thread *_td, struct fpreg *_fpreg); 238int proc_write_fpregs(struct thread *_td, struct fpreg *_fpreg); 239int proc_read_dbregs(struct thread *_td, struct dbreg *_dbreg); 240int proc_write_dbregs(struct thread *_td, struct dbreg *_dbreg); 241int proc_sstep(struct thread *_td); 242int proc_rwmem(struct proc *_p, struct uio *_uio); 243ssize_t proc_readmem(struct thread *_td, struct proc *_p, vm_offset_t _va, 244 void *_buf, size_t _len); 245ssize_t proc_writemem(struct thread *_td, struct proc *_p, vm_offset_t _va, 246 void *_buf, size_t _len); 247#ifdef COMPAT_FREEBSD32 248struct reg32; 249struct fpreg32; 250struct dbreg32; 251int proc_read_regs32(struct thread *_td, struct reg32 *_reg32); 252int proc_write_regs32(struct thread *_td, struct reg32 *_reg32); 253int proc_read_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32); 254int proc_write_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32); 255int proc_read_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32); 256int proc_write_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32); 257#endif 258 259void ptrace_unsuspend(struct proc *p); 260 261extern bool allow_ptrace; 262 263#else /* !_KERNEL */ 264 265#include <sys/cdefs.h> 266 267__BEGIN_DECLS 268int ptrace(int _request, pid_t _pid, caddr_t _addr, int _data); 269__END_DECLS 270 271#endif /* !_KERNEL */ 272 273#endif /* !_SYS_PTRACE_H_ */ 274