2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2001 Alexander Kabaev
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
36 #include <sys/mutex.h>
38 #include <sys/ptrace.h>
39 #include <sys/syscallsubr.h>
40 #include <sys/systm.h>
42 #include <machine/md_var.h>
43 #include <machine/pcb.h>
44 #include <machine/reg.h>
46 #include <i386/linux/linux.h>
47 #include <i386/linux/linux_proto.h>
48 #include <compat/linux/linux_signal.h>
51 * Linux ptrace requests numbers. Mostly identical to FreeBSD,
52 * except for MD ones and PT_ATTACH/PT_DETACH.
54 #define PTRACE_TRACEME 0
55 #define PTRACE_PEEKTEXT 1
56 #define PTRACE_PEEKDATA 2
57 #define PTRACE_PEEKUSR 3
58 #define PTRACE_POKETEXT 4
59 #define PTRACE_POKEDATA 5
60 #define PTRACE_POKEUSR 6
63 #define PTRACE_SINGLESTEP 9
65 #define PTRACE_ATTACH 16
66 #define PTRACE_DETACH 17
68 #define LINUX_PTRACE_SYSCALL 24
70 #define PTRACE_GETREGS 12
71 #define PTRACE_SETREGS 13
72 #define PTRACE_GETFPREGS 14
73 #define PTRACE_SETFPREGS 15
74 #define PTRACE_GETFPXREGS 18
75 #define PTRACE_SETFPXREGS 19
77 #define PTRACE_SETOPTIONS 21
80 * Linux keeps debug registers at the following
81 * offset in the user struct
83 #define LINUX_DBREG_OFFSET 252
84 #define LINUX_DBREG_SIZE (8*sizeof(l_int))
87 map_signum(int signum)
90 signum = linux_to_bsd_signal(signum);
91 return ((signum == SIGSTOP)? 0 : signum);
115 * Translate i386 ptrace registers between Linux and FreeBSD formats.
116 * The translation is pretty straighforward, for all registers, but
117 * orig_eax on Linux side and r_trapno and r_err in FreeBSD
120 map_regs_to_linux(struct reg *bsd_r, struct linux_pt_reg *linux_r)
122 linux_r->ebx = bsd_r->r_ebx;
123 linux_r->ecx = bsd_r->r_ecx;
124 linux_r->edx = bsd_r->r_edx;
125 linux_r->esi = bsd_r->r_esi;
126 linux_r->edi = bsd_r->r_edi;
127 linux_r->ebp = bsd_r->r_ebp;
128 linux_r->eax = bsd_r->r_eax;
129 linux_r->xds = bsd_r->r_ds;
130 linux_r->xes = bsd_r->r_es;
131 linux_r->xfs = bsd_r->r_fs;
132 linux_r->xgs = bsd_r->r_gs;
133 linux_r->orig_eax = bsd_r->r_eax;
134 linux_r->eip = bsd_r->r_eip;
135 linux_r->xcs = bsd_r->r_cs;
136 linux_r->eflags = bsd_r->r_eflags;
137 linux_r->esp = bsd_r->r_esp;
138 linux_r->xss = bsd_r->r_ss;
142 map_regs_from_linux(struct reg *bsd_r, struct linux_pt_reg *linux_r)
144 bsd_r->r_ebx = linux_r->ebx;
145 bsd_r->r_ecx = linux_r->ecx;
146 bsd_r->r_edx = linux_r->edx;
147 bsd_r->r_esi = linux_r->esi;
148 bsd_r->r_edi = linux_r->edi;
149 bsd_r->r_ebp = linux_r->ebp;
150 bsd_r->r_eax = linux_r->eax;
151 bsd_r->r_ds = linux_r->xds;
152 bsd_r->r_es = linux_r->xes;
153 bsd_r->r_fs = linux_r->xfs;
154 bsd_r->r_gs = linux_r->xgs;
155 bsd_r->r_eip = linux_r->eip;
156 bsd_r->r_cs = linux_r->xcs;
157 bsd_r->r_eflags = linux_r->eflags;
158 bsd_r->r_esp = linux_r->esp;
159 bsd_r->r_ss = linux_r->xss;
162 struct linux_pt_fpreg {
170 l_long st_space[2*10];
174 map_fpregs_to_linux(struct fpreg *bsd_r, struct linux_pt_fpreg *linux_r)
176 linux_r->cwd = bsd_r->fpr_env[0];
177 linux_r->swd = bsd_r->fpr_env[1];
178 linux_r->twd = bsd_r->fpr_env[2];
179 linux_r->fip = bsd_r->fpr_env[3];
180 linux_r->fcs = bsd_r->fpr_env[4];
181 linux_r->foo = bsd_r->fpr_env[5];
182 linux_r->fos = bsd_r->fpr_env[6];
183 bcopy(bsd_r->fpr_acc, linux_r->st_space, sizeof(linux_r->st_space));
187 map_fpregs_from_linux(struct fpreg *bsd_r, struct linux_pt_fpreg *linux_r)
189 bsd_r->fpr_env[0] = linux_r->cwd;
190 bsd_r->fpr_env[1] = linux_r->swd;
191 bsd_r->fpr_env[2] = linux_r->twd;
192 bsd_r->fpr_env[3] = linux_r->fip;
193 bsd_r->fpr_env[4] = linux_r->fcs;
194 bsd_r->fpr_env[5] = linux_r->foo;
195 bsd_r->fpr_env[6] = linux_r->fos;
196 bcopy(bsd_r->fpr_acc, linux_r->st_space, sizeof(bsd_r->fpr_acc));
199 struct linux_pt_fpxreg {
211 l_long xmm_space[32];
216 linux_proc_read_fpxregs(struct thread *td, struct linux_pt_fpxreg *fpxregs)
219 PROC_LOCK_ASSERT(td->td_proc, MA_OWNED);
220 if (cpu_fxsr == 0 || (td->td_proc->p_flag & P_INMEM) == 0)
222 bcopy(&get_pcb_user_save_td(td)->sv_xmm, fpxregs, sizeof(*fpxregs));
227 linux_proc_write_fpxregs(struct thread *td, struct linux_pt_fpxreg *fpxregs)
230 PROC_LOCK_ASSERT(td->td_proc, MA_OWNED);
231 if (cpu_fxsr == 0 || (td->td_proc->p_flag & P_INMEM) == 0)
233 bcopy(fpxregs, &get_pcb_user_save_td(td)->sv_xmm, sizeof(*fpxregs));
238 linux_ptrace(struct thread *td, struct linux_ptrace_args *uap)
241 struct linux_pt_reg reg;
242 struct linux_pt_fpreg fpreg;
243 struct linux_pt_fpxreg fpxreg;
247 struct fpreg bsd_fpreg;
248 struct dbreg bsd_dbreg;
256 /* by default, just copy data intact */
258 pid = (pid_t)uap->pid;
259 addr = (void *)uap->addr;
263 case PTRACE_POKETEXT:
264 case PTRACE_POKEDATA:
266 error = kern_ptrace(td, req, pid, addr, uap->data);
268 case PTRACE_PEEKTEXT:
269 case PTRACE_PEEKDATA: {
270 /* need to preserve return value */
271 int rval = td->td_retval[0];
272 error = kern_ptrace(td, req, pid, addr, 0);
274 error = copyout(td->td_retval, (void *)uap->data,
276 td->td_retval[0] = rval;
280 error = kern_ptrace(td, PT_DETACH, pid, (void *)1,
281 map_signum(uap->data));
283 case PTRACE_SINGLESTEP:
285 error = kern_ptrace(td, req, pid, (void *)1,
286 map_signum(uap->data));
289 error = kern_ptrace(td, PT_ATTACH, pid, addr, uap->data);
292 /* Linux is using data where FreeBSD is using addr */
293 error = kern_ptrace(td, PT_GETREGS, pid, &u.bsd_reg, 0);
295 map_regs_to_linux(&u.bsd_reg, &r.reg);
296 error = copyout(&r.reg, (void *)uap->data,
301 /* Linux is using data where FreeBSD is using addr */
302 error = copyin((void *)uap->data, &r.reg, sizeof(r.reg));
304 map_regs_from_linux(&u.bsd_reg, &r.reg);
305 error = kern_ptrace(td, PT_SETREGS, pid, &u.bsd_reg, 0);
308 case PTRACE_GETFPREGS:
309 /* Linux is using data where FreeBSD is using addr */
310 error = kern_ptrace(td, PT_GETFPREGS, pid, &u.bsd_fpreg, 0);
312 map_fpregs_to_linux(&u.bsd_fpreg, &r.fpreg);
313 error = copyout(&r.fpreg, (void *)uap->data,
317 case PTRACE_SETFPREGS:
318 /* Linux is using data where FreeBSD is using addr */
319 error = copyin((void *)uap->data, &r.fpreg, sizeof(r.fpreg));
321 map_fpregs_from_linux(&u.bsd_fpreg, &r.fpreg);
322 error = kern_ptrace(td, PT_SETFPREGS, pid,
326 case PTRACE_SETFPXREGS:
327 error = copyin((void *)uap->data, &r.fpxreg, sizeof(r.fpxreg));
331 case PTRACE_GETFPXREGS: {
335 if (sizeof(struct linux_pt_fpxreg) != sizeof(struct savexmm)) {
338 printf("linux: savexmm != linux_pt_fpxreg\n");
345 if ((p = pfind(uap->pid)) == NULL) {
350 /* Exiting processes can't be debugged. */
351 if ((p->p_flag & P_WEXIT) != 0) {
356 if ((error = p_candebug(td, p)) != 0)
359 /* System processes can't be debugged. */
360 if ((p->p_flag & P_SYSTEM) != 0) {
365 /* not being traced... */
366 if ((p->p_flag & P_TRACED) == 0) {
371 /* not being traced by YOU */
372 if (p->p_pptr != td->td_proc) {
377 /* not currently stopped */
378 if (!P_SHOULDSTOP(p) || (p->p_flag & P_WAITED) == 0) {
383 if (req == PTRACE_GETFPXREGS) {
384 _PHOLD(p); /* may block */
385 td2 = FIRST_THREAD_IN_PROC(p);
386 error = linux_proc_read_fpxregs(td2, &r.fpxreg);
390 error = copyout(&r.fpxreg, (void *)uap->data,
393 /* clear dangerous bits exactly as Linux does*/
394 r.fpxreg.mxcsr &= 0xffbf;
395 _PHOLD(p); /* may block */
396 td2 = FIRST_THREAD_IN_PROC(p);
397 error = linux_proc_write_fpxregs(td2, &r.fpxreg);
408 case PTRACE_POKEUSR: {
411 /* check addr for alignment */
412 if (uap->addr < 0 || uap->addr & (sizeof(l_int) - 1))
415 * Allow Linux programs to access register values in
416 * user struct. We simulate this through PT_GET/SETREGS
419 if (uap->addr < sizeof(struct linux_pt_reg)) {
420 error = kern_ptrace(td, PT_GETREGS, pid, &u.bsd_reg, 0);
424 map_regs_to_linux(&u.bsd_reg, &r.reg);
425 if (req == PTRACE_PEEKUSR) {
426 error = copyout((char *)&r.reg + uap->addr,
427 (void *)uap->data, sizeof(l_int));
431 *(l_int *)((char *)&r.reg + uap->addr) =
434 map_regs_from_linux(&u.bsd_reg, &r.reg);
435 error = kern_ptrace(td, PT_SETREGS, pid, &u.bsd_reg, 0);
439 * Simulate debug registers access
441 if (uap->addr >= LINUX_DBREG_OFFSET &&
442 uap->addr <= LINUX_DBREG_OFFSET + LINUX_DBREG_SIZE) {
443 error = kern_ptrace(td, PT_GETDBREGS, pid, &u.bsd_dbreg,
448 uap->addr -= LINUX_DBREG_OFFSET;
449 if (req == PTRACE_PEEKUSR) {
450 error = copyout((char *)&u.bsd_dbreg +
451 uap->addr, (void *)uap->data,
456 *(l_int *)((char *)&u.bsd_dbreg + uap->addr) =
458 error = kern_ptrace(td, PT_SETDBREGS, pid,
464 case LINUX_PTRACE_SYSCALL:
467 printf("linux: ptrace(%u, ...) not implemented\n",
468 (unsigned int)uap->req);