1fcf9fc10SMark Johnston /*-
24d846d26SWarner Losh * SPDX-License-Identifier: BSD-2-Clause
35e53a4f9SPedro F. Giffuni *
48eb20f36SRui Paulo * Copyright (c) 2010 The FreeBSD Foundation
58eb20f36SRui Paulo * All rights reserved.
68eb20f36SRui Paulo *
78eb20f36SRui Paulo * This software was developed by Rui Paulo under sponsorship from the
88eb20f36SRui Paulo * FreeBSD Foundation.
98eb20f36SRui Paulo *
108eb20f36SRui Paulo * Redistribution and use in source and binary forms, with or without
118eb20f36SRui Paulo * modification, are permitted provided that the following conditions
128eb20f36SRui Paulo * are met:
138eb20f36SRui Paulo * 1. Redistributions of source code must retain the above copyright
148eb20f36SRui Paulo * notice, this list of conditions and the following disclaimer.
158eb20f36SRui Paulo * 2. Redistributions in binary form must reproduce the above copyright
168eb20f36SRui Paulo * notice, this list of conditions and the following disclaimer in the
178eb20f36SRui Paulo * documentation and/or other materials provided with the distribution.
188eb20f36SRui Paulo *
198eb20f36SRui Paulo * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
208eb20f36SRui Paulo * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
218eb20f36SRui Paulo * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
228eb20f36SRui Paulo * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
238eb20f36SRui Paulo * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
248eb20f36SRui Paulo * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
258eb20f36SRui Paulo * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
268eb20f36SRui Paulo * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
278eb20f36SRui Paulo * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
288eb20f36SRui Paulo * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
298eb20f36SRui Paulo * SUCH DAMAGE.
308eb20f36SRui Paulo */
318eb20f36SRui Paulo
328eb20f36SRui Paulo #include <sys/types.h>
338eb20f36SRui Paulo #include <sys/ptrace.h>
348eb20f36SRui Paulo #include <sys/wait.h>
358eb20f36SRui Paulo
368eb20f36SRui Paulo #include <assert.h>
378eb20f36SRui Paulo #include <err.h>
388eb20f36SRui Paulo #include <errno.h>
39813b2694SMark Johnston #include <signal.h>
40813b2694SMark Johnston #include <stdio.h>
41fcf9fc10SMark Johnston
428eb20f36SRui Paulo #include "_libproc.h"
438eb20f36SRui Paulo
4427e54fb5SRuslan Bukin #if defined(__aarch64__)
4527e54fb5SRuslan Bukin #define AARCH64_BRK 0xd4200000
4627e54fb5SRuslan Bukin #define AARCH64_BRK_IMM16_SHIFT 5
4727e54fb5SRuslan Bukin #define AARCH64_BRK_IMM16_VAL (0xd << AARCH64_BRK_IMM16_SHIFT)
4827e54fb5SRuslan Bukin #define BREAKPOINT_INSTR (AARCH64_BRK | AARCH64_BRK_IMM16_VAL)
4927e54fb5SRuslan Bukin #define BREAKPOINT_INSTR_SZ 4
5027e54fb5SRuslan Bukin #elif defined(__amd64__) || defined(__i386__)
518eb20f36SRui Paulo #define BREAKPOINT_INSTR 0xcc /* int 0x3 */
528eb20f36SRui Paulo #define BREAKPOINT_INSTR_SZ 1
53e3c074a0SAndrew Turner #define BREAKPOINT_ADJUST_SZ BREAKPOINT_INSTR_SZ
5427e54fb5SRuslan Bukin #elif defined(__arm__)
5527e54fb5SRuslan Bukin #define BREAKPOINT_INSTR 0xe7ffffff /* bkpt */
5627e54fb5SRuslan Bukin #define BREAKPOINT_INSTR_SZ 4
57c7570492SJustin Hibbits #elif defined(__powerpc__)
58c7570492SJustin Hibbits #define BREAKPOINT_INSTR 0x7fe00008 /* trap */
59c7570492SJustin Hibbits #define BREAKPOINT_INSTR_SZ 4
60ca20f8ecSRuslan Bukin #elif defined(__riscv)
617dd3aed9SRuslan Bukin #define BREAKPOINT_INSTR 0x00100073 /* sbreak */
627dd3aed9SRuslan Bukin #define BREAKPOINT_INSTR_SZ 4
638eb20f36SRui Paulo #else
648eb20f36SRui Paulo #error "Add support for your architecture"
658eb20f36SRui Paulo #endif
668eb20f36SRui Paulo
671d290950SRuslan Bukin /*
681d290950SRuslan Bukin * Use 4-bytes holder for breakpoint instruction on all the platforms.
691d290950SRuslan Bukin * Works for x86 as well until it is endian-little platform.
701d290950SRuslan Bukin * (We are coping one byte only on x86 from this 4-bytes piece of
711d290950SRuslan Bukin * memory).
721d290950SRuslan Bukin */
731d290950SRuslan Bukin typedef uint32_t instr_t;
741d290950SRuslan Bukin
75813b2694SMark Johnston static int
proc_stop(struct proc_handle * phdl)76813b2694SMark Johnston proc_stop(struct proc_handle *phdl)
77813b2694SMark Johnston {
78813b2694SMark Johnston int status;
79813b2694SMark Johnston
80813b2694SMark Johnston if (kill(proc_getpid(phdl), SIGSTOP) == -1) {
81813b2694SMark Johnston DPRINTF("kill %d", proc_getpid(phdl));
82813b2694SMark Johnston return (-1);
83813b2694SMark Johnston } else if (waitpid(proc_getpid(phdl), &status, WSTOPPED) == -1) {
84813b2694SMark Johnston DPRINTF("waitpid %d", proc_getpid(phdl));
85813b2694SMark Johnston return (-1);
86813b2694SMark Johnston } else if (!WIFSTOPPED(status)) {
87813b2694SMark Johnston DPRINTFX("waitpid: unexpected status 0x%x", status);
88813b2694SMark Johnston return (-1);
89813b2694SMark Johnston }
90813b2694SMark Johnston
91813b2694SMark Johnston return (0);
92813b2694SMark Johnston }
93813b2694SMark Johnston
948eb20f36SRui Paulo int
proc_bkptset(struct proc_handle * phdl,uintptr_t address,unsigned long * saved)958eb20f36SRui Paulo proc_bkptset(struct proc_handle *phdl, uintptr_t address,
968eb20f36SRui Paulo unsigned long *saved)
978eb20f36SRui Paulo {
988eb20f36SRui Paulo struct ptrace_io_desc piod;
9992f92525SMark Johnston int ret = 0, stopped;
1001d290950SRuslan Bukin instr_t instr;
1018eb20f36SRui Paulo
1028eb20f36SRui Paulo *saved = 0;
1038eb20f36SRui Paulo if (phdl->status == PS_DEAD || phdl->status == PS_UNDEAD ||
1048eb20f36SRui Paulo phdl->status == PS_IDLE) {
1058eb20f36SRui Paulo errno = ENOENT;
1068eb20f36SRui Paulo return (-1);
1078eb20f36SRui Paulo }
1088eb20f36SRui Paulo
1099e5787d2SMatt Macy DPRINTFX("adding breakpoint at 0x%lx", (unsigned long)address);
110813b2694SMark Johnston
11192f92525SMark Johnston stopped = 0;
11292f92525SMark Johnston if (phdl->status != PS_STOP) {
113813b2694SMark Johnston if (proc_stop(phdl) != 0)
114813b2694SMark Johnston return (-1);
11592f92525SMark Johnston stopped = 1;
11692f92525SMark Johnston }
117813b2694SMark Johnston
1188eb20f36SRui Paulo /*
1198eb20f36SRui Paulo * Read the original instruction.
1208eb20f36SRui Paulo */
1211d290950SRuslan Bukin instr = 0;
1228eb20f36SRui Paulo piod.piod_op = PIOD_READ_I;
1230ccd9d15SBrooks Davis piod.piod_offs = (void *)address;
1241d290950SRuslan Bukin piod.piod_addr = &instr;
1258eb20f36SRui Paulo piod.piod_len = BREAKPOINT_INSTR_SZ;
1268eb20f36SRui Paulo if (ptrace(PT_IO, proc_getpid(phdl), (caddr_t)&piod, 0) < 0) {
127fcf9fc10SMark Johnston DPRINTF("ERROR: couldn't read instruction at address 0x%jx",
128fcf9fc10SMark Johnston (uintmax_t)address);
129813b2694SMark Johnston ret = -1;
130813b2694SMark Johnston goto done;
1318eb20f36SRui Paulo }
1321d290950SRuslan Bukin *saved = instr;
1338eb20f36SRui Paulo /*
1348eb20f36SRui Paulo * Write a breakpoint instruction to that address.
1358eb20f36SRui Paulo */
1361d290950SRuslan Bukin instr = BREAKPOINT_INSTR;
1378eb20f36SRui Paulo piod.piod_op = PIOD_WRITE_I;
1380ccd9d15SBrooks Davis piod.piod_offs = (void *)address;
1391d290950SRuslan Bukin piod.piod_addr = &instr;
1408eb20f36SRui Paulo piod.piod_len = BREAKPOINT_INSTR_SZ;
1418eb20f36SRui Paulo if (ptrace(PT_IO, proc_getpid(phdl), (caddr_t)&piod, 0) < 0) {
142fcf9fc10SMark Johnston DPRINTF("ERROR: couldn't write instruction at address 0x%jx",
143fcf9fc10SMark Johnston (uintmax_t)address);
144813b2694SMark Johnston ret = -1;
145813b2694SMark Johnston goto done;
1468eb20f36SRui Paulo }
1478eb20f36SRui Paulo
148813b2694SMark Johnston done:
14992f92525SMark Johnston if (stopped)
150813b2694SMark Johnston /* Restart the process if we had to stop it. */
15192f92525SMark Johnston proc_continue(phdl);
152813b2694SMark Johnston
153813b2694SMark Johnston return (ret);
1548eb20f36SRui Paulo }
1558eb20f36SRui Paulo
1568eb20f36SRui Paulo int
proc_bkptdel(struct proc_handle * phdl,uintptr_t address,unsigned long saved)1578eb20f36SRui Paulo proc_bkptdel(struct proc_handle *phdl, uintptr_t address,
1588eb20f36SRui Paulo unsigned long saved)
1598eb20f36SRui Paulo {
1608eb20f36SRui Paulo struct ptrace_io_desc piod;
16192f92525SMark Johnston int ret = 0, stopped;
1621d290950SRuslan Bukin instr_t instr;
1638eb20f36SRui Paulo
1648eb20f36SRui Paulo if (phdl->status == PS_DEAD || phdl->status == PS_UNDEAD ||
1658eb20f36SRui Paulo phdl->status == PS_IDLE) {
1668eb20f36SRui Paulo errno = ENOENT;
1678eb20f36SRui Paulo return (-1);
1688eb20f36SRui Paulo }
169813b2694SMark Johnston
1709e5787d2SMatt Macy DPRINTFX("removing breakpoint at 0x%lx", (unsigned long)address);
171813b2694SMark Johnston
17292f92525SMark Johnston stopped = 0;
17392f92525SMark Johnston if (phdl->status != PS_STOP) {
174813b2694SMark Johnston if (proc_stop(phdl) != 0)
175813b2694SMark Johnston return (-1);
17692f92525SMark Johnston stopped = 1;
17792f92525SMark Johnston }
178813b2694SMark Johnston
1798eb20f36SRui Paulo /*
1808eb20f36SRui Paulo * Overwrite the breakpoint instruction that we setup previously.
1818eb20f36SRui Paulo */
1821d290950SRuslan Bukin instr = saved;
1838eb20f36SRui Paulo piod.piod_op = PIOD_WRITE_I;
1840ccd9d15SBrooks Davis piod.piod_offs = (void *)address;
1851d290950SRuslan Bukin piod.piod_addr = &instr;
1868eb20f36SRui Paulo piod.piod_len = BREAKPOINT_INSTR_SZ;
1878eb20f36SRui Paulo if (ptrace(PT_IO, proc_getpid(phdl), (caddr_t)&piod, 0) < 0) {
188fcf9fc10SMark Johnston DPRINTF("ERROR: couldn't write instruction at address 0x%jx",
189fcf9fc10SMark Johnston (uintmax_t)address);
190813b2694SMark Johnston ret = -1;
1918eb20f36SRui Paulo }
1928eb20f36SRui Paulo
19392f92525SMark Johnston if (stopped)
194813b2694SMark Johnston /* Restart the process if we had to stop it. */
19592f92525SMark Johnston proc_continue(phdl);
196813b2694SMark Johnston
197813b2694SMark Johnston return (ret);
1988eb20f36SRui Paulo }
1998eb20f36SRui Paulo
2008eb20f36SRui Paulo /*
2018eb20f36SRui Paulo * Decrement pc so that we delete the breakpoint at the correct
2028eb20f36SRui Paulo * address, i.e. at the BREAKPOINT_INSTR address.
203e3c074a0SAndrew Turner *
204e3c074a0SAndrew Turner * This is only needed on some architectures where the pc value
205e3c074a0SAndrew Turner * when reading registers points at the instruction after the
206e3c074a0SAndrew Turner * breakpoint, e.g. x86.
2078eb20f36SRui Paulo */
2088eb20f36SRui Paulo void
proc_bkptregadj(unsigned long * pc)2098eb20f36SRui Paulo proc_bkptregadj(unsigned long *pc)
2108eb20f36SRui Paulo {
211e3c074a0SAndrew Turner
212e3c074a0SAndrew Turner (void)pc;
213e3c074a0SAndrew Turner #ifdef BREAKPOINT_ADJUST_SZ
214e3c074a0SAndrew Turner *pc = *pc - BREAKPOINT_ADJUST_SZ;
215e3c074a0SAndrew Turner #endif
2168eb20f36SRui Paulo }
2178eb20f36SRui Paulo
2188eb20f36SRui Paulo /*
2198eb20f36SRui Paulo * Step over the breakpoint.
2208eb20f36SRui Paulo */
2218eb20f36SRui Paulo int
proc_bkptexec(struct proc_handle * phdl,unsigned long saved)2228eb20f36SRui Paulo proc_bkptexec(struct proc_handle *phdl, unsigned long saved)
2238eb20f36SRui Paulo {
2248eb20f36SRui Paulo unsigned long pc;
2258eb20f36SRui Paulo unsigned long samesaved;
2268eb20f36SRui Paulo int status;
2278eb20f36SRui Paulo
2288eb20f36SRui Paulo if (proc_regget(phdl, REG_PC, &pc) < 0) {
22930e81f7eSMark Johnston DPRINTFX("ERROR: couldn't get PC register");
2308eb20f36SRui Paulo return (-1);
2318eb20f36SRui Paulo }
2328eb20f36SRui Paulo proc_bkptregadj(&pc);
2338eb20f36SRui Paulo if (proc_bkptdel(phdl, pc, saved) < 0) {
23430e81f7eSMark Johnston DPRINTFX("ERROR: couldn't delete breakpoint");
2358eb20f36SRui Paulo return (-1);
2368eb20f36SRui Paulo }
2378eb20f36SRui Paulo /*
2388eb20f36SRui Paulo * Go back in time and step over the new instruction just
2398eb20f36SRui Paulo * set up by proc_bkptdel().
2408eb20f36SRui Paulo */
2418eb20f36SRui Paulo proc_regset(phdl, REG_PC, pc);
2428eb20f36SRui Paulo if (ptrace(PT_STEP, proc_getpid(phdl), (caddr_t)1, 0) < 0) {
24330e81f7eSMark Johnston DPRINTFX("ERROR: ptrace step failed");
2448eb20f36SRui Paulo return (-1);
2458eb20f36SRui Paulo }
2464c74b245SRui Paulo proc_wstatus(phdl);
2474c74b245SRui Paulo status = proc_getwstat(phdl);
2488eb20f36SRui Paulo if (!WIFSTOPPED(status)) {
24930e81f7eSMark Johnston DPRINTFX("ERROR: don't know why process stopped");
2508eb20f36SRui Paulo return (-1);
2518eb20f36SRui Paulo }
2528eb20f36SRui Paulo /*
2538eb20f36SRui Paulo * Restore the breakpoint. The saved instruction should be
2548eb20f36SRui Paulo * the same as the one that we were passed in.
2558eb20f36SRui Paulo */
2568eb20f36SRui Paulo if (proc_bkptset(phdl, pc, &samesaved) < 0) {
25730e81f7eSMark Johnston DPRINTFX("ERROR: couldn't restore breakpoint");
2588eb20f36SRui Paulo return (-1);
2598eb20f36SRui Paulo }
2608eb20f36SRui Paulo assert(samesaved == saved);
2618eb20f36SRui Paulo
2628eb20f36SRui Paulo return (0);
2638eb20f36SRui Paulo }
264