ptrace.h revision 331722
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/11/sys/sys/ptrace.h 331722 2018-03-29 02:50:57Z eadler $ 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#define PT_LWP_EVENTS 24 /* report LWP birth and exit */ 68 69#define PT_GET_EVENT_MASK 25 /* get mask of optional events */ 70#define PT_SET_EVENT_MASK 26 /* set mask of optional events */ 71 72#define PT_GET_SC_ARGS 27 /* fetch syscall args */ 73 74#define PT_GETREGS 33 /* get general-purpose registers */ 75#define PT_SETREGS 34 /* set general-purpose registers */ 76#define PT_GETFPREGS 35 /* get floating-point registers */ 77#define PT_SETFPREGS 36 /* set floating-point registers */ 78#define PT_GETDBREGS 37 /* get debugging registers */ 79#define PT_SETDBREGS 38 /* set debugging registers */ 80 81#define PT_VM_TIMESTAMP 40 /* Get VM version (timestamp) */ 82#define PT_VM_ENTRY 41 /* Get VM map (entry) */ 83 84#define PT_FIRSTMACH 64 /* for machine-specific requests */ 85#include <machine/ptrace.h> /* machine-specific requests, if any */ 86 87/* Events used with PT_GET_EVENT_MASK and PT_SET_EVENT_MASK */ 88#define PTRACE_EXEC 0x0001 89#define PTRACE_SCE 0x0002 90#define PTRACE_SCX 0x0004 91#define PTRACE_SYSCALL (PTRACE_SCE | PTRACE_SCX) 92#define PTRACE_FORK 0x0008 93#define PTRACE_LWP 0x0010 94#define PTRACE_VFORK 0x0020 95 96#define PTRACE_DEFAULT (PTRACE_EXEC) 97 98struct ptrace_io_desc { 99 int piod_op; /* I/O operation */ 100 void *piod_offs; /* child offset */ 101 void *piod_addr; /* parent offset */ 102 size_t piod_len; /* request length */ 103}; 104 105/* 106 * Operations in piod_op. 107 */ 108#define PIOD_READ_D 1 /* Read from D space */ 109#define PIOD_WRITE_D 2 /* Write to D space */ 110#define PIOD_READ_I 3 /* Read from I space */ 111#define PIOD_WRITE_I 4 /* Write to I space */ 112 113/* Argument structure for PT_LWPINFO. */ 114struct ptrace_lwpinfo { 115 lwpid_t pl_lwpid; /* LWP described. */ 116 int pl_event; /* Event that stopped the LWP. */ 117#define PL_EVENT_NONE 0 118#define PL_EVENT_SIGNAL 1 119 int pl_flags; /* LWP flags. */ 120#define PL_FLAG_SA 0x01 /* M:N thread */ 121#define PL_FLAG_BOUND 0x02 /* M:N bound thread */ 122#define PL_FLAG_SCE 0x04 /* syscall enter point */ 123#define PL_FLAG_SCX 0x08 /* syscall leave point */ 124#define PL_FLAG_EXEC 0x10 /* exec(2) succeeded */ 125#define PL_FLAG_SI 0x20 /* siginfo is valid */ 126#define PL_FLAG_FORKED 0x40 /* new child */ 127#define PL_FLAG_CHILD 0x80 /* I am from child */ 128#define PL_FLAG_BORN 0x100 /* new LWP */ 129#define PL_FLAG_EXITED 0x200 /* exiting LWP */ 130#define PL_FLAG_VFORKED 0x400 /* new child via vfork */ 131#define PL_FLAG_VFORK_DONE 0x800 /* vfork parent has resumed */ 132 sigset_t pl_sigmask; /* LWP signal mask */ 133 sigset_t pl_siglist; /* LWP pending signal */ 134 struct __siginfo pl_siginfo; /* siginfo for signal */ 135 char pl_tdname[MAXCOMLEN + 1]; /* LWP name */ 136 pid_t pl_child_pid; /* New child pid */ 137 u_int pl_syscall_code; 138 u_int pl_syscall_narg; 139}; 140 141#if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__)) 142struct ptrace_lwpinfo32 { 143 lwpid_t pl_lwpid; /* LWP described. */ 144 int pl_event; /* Event that stopped the LWP. */ 145 int pl_flags; /* LWP flags. */ 146 sigset_t pl_sigmask; /* LWP signal mask */ 147 sigset_t pl_siglist; /* LWP pending signal */ 148 struct siginfo32 pl_siginfo; /* siginfo for signal */ 149 char pl_tdname[MAXCOMLEN + 1]; /* LWP name. */ 150 pid_t pl_child_pid; /* New child pid */ 151 u_int pl_syscall_code; 152 u_int pl_syscall_narg; 153}; 154#endif 155 156/* Argument structure for PT_VM_ENTRY. */ 157struct ptrace_vm_entry { 158 int pve_entry; /* Entry number used for iteration. */ 159 int pve_timestamp; /* Generation number of VM map. */ 160 u_long pve_start; /* Start VA of range. */ 161 u_long pve_end; /* End VA of range (incl). */ 162 u_long pve_offset; /* Offset in backing object. */ 163 u_int pve_prot; /* Protection of memory range. */ 164 u_int pve_pathlen; /* Size of path. */ 165 long pve_fileid; /* File ID. */ 166 uint32_t pve_fsid; /* File system ID. */ 167 char *pve_path; /* Path name of object. */ 168}; 169 170#ifdef _KERNEL 171 172int ptrace_set_pc(struct thread *_td, unsigned long _addr); 173int ptrace_single_step(struct thread *_td); 174int ptrace_clear_single_step(struct thread *_td); 175 176#ifdef __HAVE_PTRACE_MACHDEP 177int cpu_ptrace(struct thread *_td, int _req, void *_addr, int _data); 178#endif 179 180/* 181 * These are prototypes for functions that implement some of the 182 * debugging functionality exported by procfs / linprocfs and by the 183 * ptrace(2) syscall. They used to be part of procfs, but they don't 184 * really belong there. 185 */ 186struct reg; 187struct fpreg; 188struct dbreg; 189struct uio; 190int proc_read_regs(struct thread *_td, struct reg *_reg); 191int proc_write_regs(struct thread *_td, struct reg *_reg); 192int proc_read_fpregs(struct thread *_td, struct fpreg *_fpreg); 193int proc_write_fpregs(struct thread *_td, struct fpreg *_fpreg); 194int proc_read_dbregs(struct thread *_td, struct dbreg *_dbreg); 195int proc_write_dbregs(struct thread *_td, struct dbreg *_dbreg); 196int proc_sstep(struct thread *_td); 197int proc_rwmem(struct proc *_p, struct uio *_uio); 198ssize_t proc_readmem(struct thread *_td, struct proc *_p, vm_offset_t _va, 199 void *_buf, size_t _len); 200ssize_t proc_writemem(struct thread *_td, struct proc *_p, vm_offset_t _va, 201 void *_buf, size_t _len); 202#ifdef COMPAT_FREEBSD32 203struct reg32; 204struct fpreg32; 205struct dbreg32; 206int proc_read_regs32(struct thread *_td, struct reg32 *_reg32); 207int proc_write_regs32(struct thread *_td, struct reg32 *_reg32); 208int proc_read_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32); 209int proc_write_fpregs32(struct thread *_td, struct fpreg32 *_fpreg32); 210int proc_read_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32); 211int proc_write_dbregs32(struct thread *_td, struct dbreg32 *_dbreg32); 212#endif 213#else /* !_KERNEL */ 214 215#include <sys/cdefs.h> 216 217__BEGIN_DECLS 218int ptrace(int _request, pid_t _pid, caddr_t _addr, int _data); 219__END_DECLS 220 221#endif /* !_KERNEL */ 222 223#endif /* !_SYS_PTRACE_H_ */ 224