xref: /netbsd-src/sys/kern/sys_ptrace.c (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: sys_ptrace.c,v 1.6 2019/12/24 14:50:59 kamil Exp $	*/
2 
3 /*-
4  * Copyright (c) 2008, 2009 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*-
33  * Copyright (c) 1982, 1986, 1989, 1993
34  *	The Regents of the University of California.  All rights reserved.
35  * (c) UNIX System Laboratories, Inc.
36  * All or some portions of this file are derived from material licensed
37  * to the University of California by American Telephone and Telegraph
38  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
39  * the permission of UNIX System Laboratories, Inc.
40  *
41  * This code is derived from software contributed to Berkeley by
42  * Jan-Simon Pendry.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. Neither the name of the University nor the names of its contributors
53  *    may be used to endorse or promote products derived from this software
54  *    without specific prior written permission.
55  *
56  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
57  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
58  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
59  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
60  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
61  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
62  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
64  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
65  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66  * SUCH DAMAGE.
67  *
68  *	from: @(#)sys_process.c	8.1 (Berkeley) 6/10/93
69  */
70 
71 /*-
72  * Copyright (c) 1993 Jan-Simon Pendry.
73  * Copyright (c) 1994 Christopher G. Demetriou.  All rights reserved.
74  *
75  * This code is derived from software contributed to Berkeley by
76  * Jan-Simon Pendry.
77  *
78  * Redistribution and use in source and binary forms, with or without
79  * modification, are permitted provided that the following conditions
80  * are met:
81  * 1. Redistributions of source code must retain the above copyright
82  *    notice, this list of conditions and the following disclaimer.
83  * 2. Redistributions in binary form must reproduce the above copyright
84  *    notice, this list of conditions and the following disclaimer in the
85  *    documentation and/or other materials provided with the distribution.
86  * 3. All advertising materials mentioning features or use of this software
87  *    must display the following acknowledgement:
88  *	This product includes software developed by the University of
89  *	California, Berkeley and its contributors.
90  * 4. Neither the name of the University nor the names of its contributors
91  *    may be used to endorse or promote products derived from this software
92  *    without specific prior written permission.
93  *
94  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
95  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
98  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
99  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
100  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
104  * SUCH DAMAGE.
105  *
106  *	from: @(#)sys_process.c	8.1 (Berkeley) 6/10/93
107  */
108 
109 /*
110  * References:
111  *	(1) Bach's "The Design of the UNIX Operating System",
112  *	(2) sys/miscfs/procfs from UCB's 4.4BSD-Lite distribution,
113  *	(3) the "4.4BSD Programmer's Reference Manual" published
114  *		by USENIX and O'Reilly & Associates.
115  * The 4.4BSD PRM does a reasonably good job of documenting what the various
116  * ptrace() requests should actually do, and its text is quoted several times
117  * in this file.
118  */
119 
120 #include <sys/cdefs.h>
121 __KERNEL_RCSID(0, "$NetBSD: sys_ptrace.c,v 1.6 2019/12/24 14:50:59 kamil Exp $");
122 
123 #ifdef _KERNEL_OPT
124 #include "opt_ptrace.h"
125 #endif
126 
127 #include <sys/param.h>
128 #include <sys/systm.h>
129 #include <sys/proc.h>
130 #include <sys/errno.h>
131 #include <sys/exec.h>
132 #include <sys/pax.h>
133 #include <sys/ptrace.h>
134 #include <sys/uio.h>
135 #include <sys/ras.h>
136 #include <sys/kmem.h>
137 #include <sys/kauth.h>
138 #include <sys/mount.h>
139 #include <sys/syscallargs.h>
140 #include <sys/syscallvar.h>
141 #include <sys/syscall.h>
142 #include <sys/module.h>
143 
144 #include <uvm/uvm_extern.h>
145 
146 #include <machine/reg.h>
147 
148 /*
149  * PTRACE methods
150  */
151 
152 static int
153 ptrace_copyin_piod(struct ptrace_io_desc *piod, const void *addr, size_t len)
154 {
155 	if (len != 0 && sizeof(*piod) != len)
156 		return EINVAL;
157 
158 	return copyin(addr, piod, sizeof(*piod));
159 }
160 
161 static int
162 ptrace_copyout_piod(const struct ptrace_io_desc *piod, void *addr, size_t len)
163 {
164 	if (len != 0 && sizeof(*piod) != len)
165 		return EINVAL;
166 
167 	return copyout(piod, addr, sizeof(*piod));
168 }
169 
170 static int
171 ptrace_copyin_siginfo(struct ptrace_siginfo *psi, const void *addr, size_t len)
172 {
173 	if (sizeof(*psi) != len)
174 		return EINVAL;
175 
176 	return copyin(addr, psi, sizeof(*psi));
177 }
178 
179 static int
180 ptrace_copyout_siginfo(const struct ptrace_siginfo *psi, void *addr, size_t len)
181 {
182 	if (sizeof(*psi) != len)
183 		return EINVAL;
184 
185 	return copyout(psi, addr, sizeof(*psi));
186 }
187 
188 static int
189 ptrace_copyout_lwpstatus(const struct ptrace_lwpstatus *pls, void *addr,
190     size_t len)
191 {
192 
193 	return copyout(pls, addr, len);
194 }
195 
196 static struct ptrace_methods native_ptm = {
197 	.ptm_copyin_piod = ptrace_copyin_piod,
198 	.ptm_copyout_piod = ptrace_copyout_piod,
199 	.ptm_copyin_siginfo = ptrace_copyin_siginfo,
200 	.ptm_copyout_siginfo = ptrace_copyout_siginfo,
201 	.ptm_copyout_lwpstatus = ptrace_copyout_lwpstatus,
202 	.ptm_doregs = process_doregs,
203 	.ptm_dofpregs = process_dofpregs,
204 	.ptm_dodbregs = process_dodbregs,
205 };
206 
207 static const struct syscall_package ptrace_syscalls[] = {
208 	{ SYS_ptrace, 0, (sy_call_t *)sys_ptrace },
209 	{ 0, 0, NULL },
210 };
211 
212 /*
213  * Process debugging system call.
214  */
215 int
216 sys_ptrace(struct lwp *l, const struct sys_ptrace_args *uap, register_t *retval)
217 {
218 	/* {
219 		syscallarg(int) req;
220 		syscallarg(pid_t) pid;
221 		syscallarg(void *) addr;
222 		syscallarg(int) data;
223 	} */
224 
225         return do_ptrace(&native_ptm, l, SCARG(uap, req), SCARG(uap, pid),
226             SCARG(uap, addr), SCARG(uap, data), retval);
227 }
228 
229 #define	DEPS	"ptrace_common"
230 
231 MODULE(MODULE_CLASS_EXEC, ptrace, DEPS);
232 
233 static int
234 ptrace_modcmd(modcmd_t cmd, void *arg)
235 {
236 	int error;
237 
238 	switch (cmd) {
239 	case MODULE_CMD_INIT:
240 		error = syscall_establish(&emul_netbsd, ptrace_syscalls);
241 		break;
242 	case MODULE_CMD_FINI:
243 		error = syscall_disestablish(&emul_netbsd, ptrace_syscalls);
244 		break;
245 	default:
246 		error = ENOTTY;
247 		break;
248 	}
249 	return error;
250 }
251