Relock PROC_LOCK before one failure case in ptrace_single_step().
[freebsd.git] / sys / mips / mips / pm_machdep.c
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1992 Terrence R. Lambert.
5  * Copyright (c) 1982, 1987, 1990 The Regents of the University of California.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * William Jolitz.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *      from: @(#)machdep.c     7.4 (Berkeley) 6/3/91
36  *      from: src/sys/i386/i386/machdep.c,v 1.385.2.3 2000/05/10 02:04:46 obrien
37  *      JNPR: pm_machdep.c,v 1.9.2.1 2007/08/16 15:59:10 girish
38  */
39
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
42
43 #include <sys/types.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/sysent.h>
47 #include <sys/proc.h>
48 #include <sys/signalvar.h>
49 #include <sys/exec.h>
50 #include <sys/imgact.h>
51 #include <sys/ucontext.h>
52 #include <sys/lock.h>
53 #include <sys/syscallsubr.h>
54 #include <sys/sysproto.h>
55 #include <sys/ptrace.h>
56 #include <sys/syslog.h>
57 #include <vm/vm.h>
58 #include <vm/pmap.h>
59 #include <vm/vm_map.h>
60 #include <vm/vm_extern.h>
61 #include <sys/user.h>
62 #include <sys/uio.h>
63 #include <machine/abi.h>
64 #include <machine/cpuinfo.h>
65 #include <machine/reg.h>
66 #include <machine/md_var.h>
67 #include <machine/sigframe.h>
68 #include <machine/tls.h>
69 #include <machine/vmparam.h>
70 #include <sys/vnode.h>
71 #include <fs/pseudofs/pseudofs.h>
72 #include <fs/procfs/procfs.h>
73
74 #define UCONTEXT_MAGIC  0xACEDBADE
75
76 /*
77  * Send an interrupt to process.
78  *
79  * Stack is set up to allow sigcode stored
80  * at top to call routine, followed by kcall
81  * to sigreturn routine below.  After sigreturn
82  * resets the signal mask, the stack, and the
83  * frame pointer, it returns to the user
84  * specified pc, psl.
85  */
86 void
87 sendsig(sig_t catcher, ksiginfo_t *ksi, sigset_t *mask)
88 {
89         struct proc *p;
90         struct thread *td;
91         struct trapframe *regs;
92         struct sigacts *psp;
93         struct sigframe sf, *sfp;
94         int sig;
95         int oonstack;
96
97         td = curthread;
98         p = td->td_proc;
99         PROC_LOCK_ASSERT(p, MA_OWNED);
100         sig = ksi->ksi_signo;
101         psp = p->p_sigacts;
102         mtx_assert(&psp->ps_mtx, MA_OWNED);
103
104         regs = td->td_frame;
105         oonstack = sigonstack(regs->sp);
106
107         /* save user context */
108         bzero(&sf, sizeof(struct sigframe));
109         sf.sf_uc.uc_sigmask = *mask;
110         sf.sf_uc.uc_stack = td->td_sigstk;
111         sf.sf_uc.uc_mcontext.mc_onstack = (oonstack) ? 1 : 0;
112         sf.sf_uc.uc_mcontext.mc_pc = regs->pc;
113         sf.sf_uc.uc_mcontext.mullo = regs->mullo;
114         sf.sf_uc.uc_mcontext.mulhi = regs->mulhi;
115         sf.sf_uc.uc_mcontext.mc_tls = td->td_md.md_tls;
116         sf.sf_uc.uc_mcontext.mc_regs[0] = UCONTEXT_MAGIC;  /* magic number */
117         bcopy((void *)&regs->ast, (void *)&sf.sf_uc.uc_mcontext.mc_regs[1],
118             sizeof(sf.sf_uc.uc_mcontext.mc_regs) - sizeof(register_t));
119         sf.sf_uc.uc_mcontext.mc_fpused = td->td_md.md_flags & MDTD_FPUSED;
120         if (sf.sf_uc.uc_mcontext.mc_fpused) {
121                 /* if FPU has current state, save it first */
122                 if (td == PCPU_GET(fpcurthread))
123                         MipsSaveCurFPState(td);
124                 bcopy((void *)&td->td_frame->f0,
125                     (void *)sf.sf_uc.uc_mcontext.mc_fpregs,
126                     sizeof(sf.sf_uc.uc_mcontext.mc_fpregs));
127         }
128
129         /* Allocate and validate space for the signal handler context. */
130         if ((td->td_pflags & TDP_ALTSTACK) != 0 && !oonstack &&
131             SIGISMEMBER(psp->ps_sigonstack, sig)) {
132                 sfp = (struct sigframe *)(((uintptr_t)td->td_sigstk.ss_sp +
133                     td->td_sigstk.ss_size - sizeof(struct sigframe))
134                     & ~(STACK_ALIGN - 1));
135         } else
136                 sfp = (struct sigframe *)((vm_offset_t)(regs->sp - 
137                     sizeof(struct sigframe)) & ~(STACK_ALIGN - 1));
138
139         /* Build the argument list for the signal handler. */
140         regs->a0 = sig;
141         regs->a2 = (register_t)(intptr_t)&sfp->sf_uc;
142         if (SIGISMEMBER(psp->ps_siginfo, sig)) {
143                 /* Signal handler installed with SA_SIGINFO. */
144                 regs->a1 = (register_t)(intptr_t)&sfp->sf_si;
145                 /* sf.sf_ahu.sf_action = (__siginfohandler_t *)catcher; */
146
147                 /* fill siginfo structure */
148                 sf.sf_si = ksi->ksi_info;
149                 sf.sf_si.si_signo = sig;
150                 sf.sf_si.si_code = ksi->ksi_code;
151                 sf.sf_si.si_addr = (void*)(intptr_t)regs->badvaddr;
152         } else {
153                 /* Old FreeBSD-style arguments. */
154                 regs->a1 = ksi->ksi_code;
155                 regs->a3 = regs->badvaddr;
156                 /* sf.sf_ahu.sf_handler = catcher; */
157         }
158
159         mtx_unlock(&psp->ps_mtx);
160         PROC_UNLOCK(p);
161
162         /*
163          * Copy the sigframe out to the user's stack.
164          */
165         if (copyout(&sf, sfp, sizeof(struct sigframe)) != 0) {
166                 /*
167                  * Something is wrong with the stack pointer.
168                  * ...Kill the process.
169                  */
170                 PROC_LOCK(p);
171                 sigexit(td, SIGILL);
172         }
173
174         regs->pc = (register_t)(intptr_t)catcher;
175         regs->t9 = (register_t)(intptr_t)catcher;
176         regs->sp = (register_t)(intptr_t)sfp;
177         /*
178          * Signal trampoline code is at base of user stack.
179          */
180         regs->ra = (register_t)(intptr_t)PS_STRINGS - *(p->p_sysent->sv_szsigcode);
181         PROC_LOCK(p);
182         mtx_lock(&psp->ps_mtx);
183 }
184
185 /*
186  * System call to cleanup state after a signal
187  * has been taken.  Reset signal mask and
188  * stack state from context left by sendsig (above).
189  * Return to previous pc as specified by
190  * context left by sendsig.
191  */
192 int
193 sys_sigreturn(struct thread *td, struct sigreturn_args *uap)
194 {
195         ucontext_t uc;
196         int error;
197
198         error = copyin(uap->sigcntxp, &uc, sizeof(uc));
199         if (error != 0)
200             return (error);
201
202         error = set_mcontext(td, &uc.uc_mcontext);
203         if (error != 0)
204                 return (error);
205
206         kern_sigprocmask(td, SIG_SETMASK, &uc.uc_sigmask, NULL, 0);
207
208         return (EJUSTRETURN);
209 }
210
211 int
212 ptrace_set_pc(struct thread *td, unsigned long addr)
213 {
214         td->td_frame->pc = (register_t) addr;
215         return 0;
216 }
217
218 static int
219 ptrace_read_int(struct thread *td, off_t addr, int *v)
220 {
221
222         if (proc_readmem(td, td->td_proc, addr, v, sizeof(*v)) != sizeof(*v))
223                 return (ENOMEM);
224         return (0);
225 }
226
227 static int
228 ptrace_write_int(struct thread *td, off_t addr, int v)
229 {
230
231         if (proc_writemem(td, td->td_proc, addr, &v, sizeof(v)) != sizeof(v))
232                 return (ENOMEM);
233         return (0);
234 }
235
236 int
237 ptrace_single_step(struct thread *td)
238 {
239         unsigned va;
240         struct trapframe *locr0 = td->td_frame;
241         int i;
242         int bpinstr = MIPS_BREAK_SSTEP;
243         int curinstr;
244         struct proc *p;
245
246         p = td->td_proc;
247         PROC_UNLOCK(p);
248         /*
249          * Fetch what's at the current location.
250          */
251         ptrace_read_int(td,  (off_t)locr0->pc, &curinstr);
252
253         /* compute next address after current location */
254         if(curinstr != 0) {
255                 va = MipsEmulateBranch(locr0, locr0->pc, locr0->fsr,
256                     (uintptr_t)&curinstr);
257         } else {
258                 va = locr0->pc + 4;
259         }
260         if (td->td_md.md_ss_addr) {
261                 printf("SS %s (%d): breakpoint already set at %x (va %x)\n",
262                     p->p_comm, p->p_pid, td->td_md.md_ss_addr, va); /* XXX */
263                 PROC_LOCK(p);
264                 return (EFAULT);
265         }
266         td->td_md.md_ss_addr = va;
267         /*
268          * Fetch what's at the current location.
269          */
270         ptrace_read_int(td, (off_t)va, &td->td_md.md_ss_instr);
271
272         /*
273          * Store breakpoint instruction at the "next" location now.
274          */
275         i = ptrace_write_int (td, va, bpinstr);
276
277         /*
278          * The sync'ing of I & D caches is done by procfs_domem()
279          * through procfs_rwmem().
280          */
281
282         PROC_LOCK(p);
283         if (i < 0)
284                 return (EFAULT);
285 #if 0
286         printf("SS %s (%d): breakpoint set at %x: %x (pc %x) br %x\n",
287             p->p_comm, p->p_pid, p->p_md.md_ss_addr,
288             p->p_md.md_ss_instr, locr0->pc, curinstr); /* XXX */
289 #endif
290         return (0);
291 }
292
293
294 void
295 makectx(struct trapframe *tf, struct pcb *pcb)
296 {
297
298         pcb->pcb_context[PCB_REG_RA] = tf->ra;
299         pcb->pcb_context[PCB_REG_PC] = tf->pc;
300         pcb->pcb_context[PCB_REG_SP] = tf->sp;
301 }
302
303 int
304 fill_regs(struct thread *td, struct reg *regs)
305 {
306         memcpy(regs, td->td_frame, sizeof(struct reg));
307         return (0);
308 }
309
310 int
311 set_regs(struct thread *td, struct reg *regs)
312 {
313         struct trapframe *f;
314         register_t sr;
315
316         f = (struct trapframe *) td->td_frame;
317         /*
318          * Don't allow the user to change SR
319          */
320         sr = f->sr;
321         memcpy(td->td_frame, regs, sizeof(struct reg));
322         f->sr = sr;
323         return (0);
324 }
325
326 int
327 get_mcontext(struct thread *td, mcontext_t *mcp, int flags)
328 {
329         struct trapframe *tp;
330
331         tp = td->td_frame;
332         PROC_LOCK(curthread->td_proc);
333         mcp->mc_onstack = sigonstack(tp->sp);
334         PROC_UNLOCK(curthread->td_proc);
335         bcopy((void *)&td->td_frame->zero, (void *)&mcp->mc_regs,
336             sizeof(mcp->mc_regs));
337
338         mcp->mc_fpused = td->td_md.md_flags & MDTD_FPUSED;
339         if (mcp->mc_fpused) {
340                 bcopy((void *)&td->td_frame->f0, (void *)&mcp->mc_fpregs,
341                     sizeof(mcp->mc_fpregs));
342         }
343         if (flags & GET_MC_CLEAR_RET) {
344                 mcp->mc_regs[V0] = 0;
345                 mcp->mc_regs[V1] = 0;
346                 mcp->mc_regs[A3] = 0;
347         }
348
349         mcp->mc_pc = td->td_frame->pc;
350         mcp->mullo = td->td_frame->mullo;
351         mcp->mulhi = td->td_frame->mulhi;
352         mcp->mc_tls = td->td_md.md_tls;
353         return (0);
354 }
355
356 int
357 set_mcontext(struct thread *td, mcontext_t *mcp)
358 {
359         struct trapframe *tp;
360
361         tp = td->td_frame;
362         bcopy((void *)&mcp->mc_regs, (void *)&td->td_frame->zero,
363             sizeof(mcp->mc_regs));
364
365         td->td_md.md_flags = mcp->mc_fpused & MDTD_FPUSED;
366         if (mcp->mc_fpused) {
367                 bcopy((void *)&mcp->mc_fpregs, (void *)&td->td_frame->f0,
368                     sizeof(mcp->mc_fpregs));
369         }
370         td->td_frame->pc = mcp->mc_pc;
371         td->td_frame->mullo = mcp->mullo;
372         td->td_frame->mulhi = mcp->mulhi;
373         td->td_md.md_tls = mcp->mc_tls;
374         /* Dont let user to set any bits in status and cause registers. */
375
376         return (0);
377 }
378
379 int
380 fill_fpregs(struct thread *td, struct fpreg *fpregs)
381 {
382         if (td == PCPU_GET(fpcurthread))
383                 MipsSaveCurFPState(td);
384         memcpy(fpregs, &td->td_frame->f0, sizeof(struct fpreg));
385         fpregs->r_regs[FIR_NUM] = cpuinfo.fpu_id;
386         return 0;
387 }
388
389 int
390 set_fpregs(struct thread *td, struct fpreg *fpregs)
391 {
392         if (PCPU_GET(fpcurthread) == td)
393                 PCPU_SET(fpcurthread, (struct thread *)0);
394         memcpy(&td->td_frame->f0, fpregs, sizeof(struct fpreg));
395         return 0;
396 }
397
398
399 /*
400  * Clear registers on exec
401  * $sp is set to the stack pointer passed in.  $pc is set to the entry
402  * point given by the exec_package passed in, as is $t9 (used for PIC
403  * code by the MIPS elf abi).
404  */
405 void
406 exec_setregs(struct thread *td, struct image_params *imgp, u_long stack)
407 {
408
409         bzero((caddr_t)td->td_frame, sizeof(struct trapframe));
410
411         td->td_frame->sp = ((register_t)stack) & ~(STACK_ALIGN - 1);
412
413         /*
414          * If we're running o32 or n32 programs but have 64-bit registers,
415          * GCC may use stack-relative addressing near the top of user
416          * address space that, due to sign extension, will yield an
417          * invalid address.  For instance, if sp is 0x7fffff00 then GCC
418          * might do something like this to load a word from 0x7ffffff0:
419          *
420          *      addu    sp, sp, 32768
421          *      lw      t0, -32528(sp)
422          *
423          * On systems with 64-bit registers, sp is sign-extended to
424          * 0xffffffff80007f00 and the load is instead done from
425          * 0xffffffff7ffffff0.
426          *
427          * To prevent this, we subtract 64K from the stack pointer here
428          * for processes with 32-bit pointers.
429          */
430 #if defined(__mips_n32) || defined(__mips_n64)
431         if (!SV_PROC_FLAG(td->td_proc, SV_LP64))
432                 td->td_frame->sp -= 65536;
433 #endif
434
435         td->td_frame->pc = imgp->entry_addr & ~3;
436         td->td_frame->t9 = imgp->entry_addr & ~3; /* abicall req */
437         td->td_frame->sr = MIPS_SR_KSU_USER | MIPS_SR_EXL | MIPS_SR_INT_IE |
438             (mips_rd_status() & MIPS_SR_INT_MASK);
439 #if defined(__mips_n32) 
440         td->td_frame->sr |= MIPS_SR_PX;
441 #elif  defined(__mips_n64)
442         td->td_frame->sr |= MIPS_SR_PX | MIPS_SR_UX | MIPS_SR_KX;
443 #endif
444         /*
445          * FREEBSD_DEVELOPERS_FIXME:
446          * Setup any other CPU-Specific registers (Not MIPS Standard)
447          * and/or bits in other standard MIPS registers (if CPU-Specific)
448          *  that are needed.
449          */
450
451         /*
452          * Set up arguments for the rtld-capable crt0:
453          *      a0      stack pointer
454          *      a1      rtld cleanup (filled in by dynamic loader)
455          *      a2      rtld object (filled in by dynamic loader)
456          *      a3      ps_strings
457          */
458         td->td_frame->a0 = (register_t) stack;
459         td->td_frame->a1 = 0;
460         td->td_frame->a2 = 0;
461         td->td_frame->a3 = (register_t)imgp->ps_strings;
462
463         td->td_md.md_flags &= ~MDTD_FPUSED;
464         if (PCPU_GET(fpcurthread) == td)
465             PCPU_SET(fpcurthread, (struct thread *)0);
466         td->td_md.md_ss_addr = 0;
467
468         td->td_md.md_tls_tcb_offset = TLS_TP_OFFSET + TLS_TCB_SIZE;
469 }
470
471 int
472 ptrace_clear_single_step(struct thread *td)
473 {
474         int i;
475         struct proc *p;
476
477         p = td->td_proc;
478         PROC_LOCK_ASSERT(p, MA_OWNED);
479         if (!td->td_md.md_ss_addr)
480                 return EINVAL;
481
482         /*
483          * Restore original instruction and clear BP
484          */
485         i = ptrace_write_int (td, td->td_md.md_ss_addr, td->td_md.md_ss_instr);
486
487         /* The sync'ing of I & D caches is done by procfs_domem(). */
488
489         if (i < 0) {
490                 log(LOG_ERR, "SS %s %d: can't restore instruction at %x: %x\n",
491                     p->p_comm, p->p_pid, td->td_md.md_ss_addr,
492                     td->td_md.md_ss_instr);
493         }
494         td->td_md.md_ss_addr = 0;
495         return 0;
496 }