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