2 * Copyright (c) 1993 Jan-Simon Pendry
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the University of
20 * California, Berkeley and its contributors.
21 * 4. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * @(#)procfs_ctl.c 8.4 (Berkeley) 6/15/94
40 * $FreeBSD: src/sys/miscfs/procfs/procfs_ctl.c,v 1.20.2.2 2002/01/22 17:22:59 nectar Exp $
41 * $DragonFly: src/sys/vfs/procfs/procfs_ctl.c,v 1.9 2006/09/03 18:29:17 dillon Exp $
44 #include <sys/param.h>
45 #include <sys/systm.h>
47 #include <sys/vnode.h>
48 #include <sys/ptrace.h>
49 #include <sys/signalvar.h>
50 #include <vfs/procfs/procfs.h>
59 * True iff process (p) is in trace wait state
60 * relative to process (curp)
62 #define TRACE_WAIT_P(curp, p) \
63 (((p)->p_flag & P_STOPPED) && \
64 (p)->p_pptr == (curp) && \
65 ((p)->p_flag & P_TRACED))
67 #define PROCFS_CTL_ATTACH 1
68 #define PROCFS_CTL_DETACH 2
69 #define PROCFS_CTL_STEP 3
70 #define PROCFS_CTL_RUN 4
71 #define PROCFS_CTL_WAIT 5
73 static vfs_namemap_t ctlnames[] = {
74 /* special /proc commands */
75 { "attach", PROCFS_CTL_ATTACH },
76 { "detach", PROCFS_CTL_DETACH },
77 { "step", PROCFS_CTL_STEP },
78 { "run", PROCFS_CTL_RUN },
79 { "wait", PROCFS_CTL_WAIT },
83 static vfs_namemap_t signames[] = {
84 /* regular signal names */
85 { "hup", SIGHUP }, { "int", SIGINT },
86 { "quit", SIGQUIT }, { "ill", SIGILL },
87 { "trap", SIGTRAP }, { "abrt", SIGABRT },
88 { "iot", SIGIOT }, { "emt", SIGEMT },
89 { "fpe", SIGFPE }, { "kill", SIGKILL },
90 { "bus", SIGBUS }, { "segv", SIGSEGV },
91 { "sys", SIGSYS }, { "pipe", SIGPIPE },
92 { "alrm", SIGALRM }, { "term", SIGTERM },
93 { "urg", SIGURG }, { "stop", SIGSTOP },
94 { "tstp", SIGTSTP }, { "cont", SIGCONT },
95 { "chld", SIGCHLD }, { "ttin", SIGTTIN },
96 { "ttou", SIGTTOU }, { "io", SIGIO },
97 { "xcpu", SIGXCPU }, { "xfsz", SIGXFSZ },
98 { "vtalrm", SIGVTALRM }, { "prof", SIGPROF },
99 { "winch", SIGWINCH }, { "info", SIGINFO },
100 { "usr1", SIGUSR1 }, { "usr2", SIGUSR2 },
104 static int procfs_control (struct proc *curp, struct proc *p, int op);
107 procfs_control(struct proc *curp, struct proc *p, int op)
111 /* Can't trace a process that's currently exec'ing. */
112 if ((p->p_flag & P_INEXEC) != 0)
115 * Authorization check: rely on normal debugging protection, except
116 * allow processes to disengage debugging on a process onto which
117 * they have previously attached, but no longer have permission to
120 if (op != PROCFS_CTL_DETACH) {
121 if (securelevel > 0 && p->p_pid == 1)
124 if (!CHECKIO(curp, p) || p_trespass(curp->p_ucred, p->p_ucred))
129 * Attach - attaches the target process for debugging
130 * by the calling process.
132 if (op == PROCFS_CTL_ATTACH) {
133 /* check whether already being traced */
134 if (p->p_flag & P_TRACED)
137 /* can't trace yourself! */
138 if (p->p_pid == curp->p_pid)
142 * Go ahead and set the trace flag.
143 * Save the old parent (it's reset in
144 * _DETACH, and also in kern_exit.c:wait4()
145 * Reparent the process so that the tracing
146 * proc gets to see all the action.
149 p->p_flag |= P_TRACED;
151 p->p_xstat = 0; /* XXX ? */
152 if (p->p_pptr != curp) {
153 p->p_oppid = p->p_pptr->p_pid;
154 proc_reparent(p, curp);
161 * Target process must be stopped, owned by (curp) and
162 * be set up for tracing (P_TRACED flag set).
163 * Allow DETACH to take place at any time for sanity.
164 * Allow WAIT any time, of course.
167 case PROCFS_CTL_DETACH:
168 case PROCFS_CTL_WAIT:
172 if (!TRACE_WAIT_P(curp, p))
179 * do single-step fixup if needed
185 * Don't deliver any signal by default.
186 * To continue with a signal, just send
187 * the signal name to the ctl file
193 * Detach. Cleans up the target process, reparent it if possible
194 * and set it running once more.
196 case PROCFS_CTL_DETACH:
197 /* if not being traced, then this is a painless no-op */
198 if ((p->p_flag & P_TRACED) == 0)
201 /* not being traced any more */
202 p->p_flag &= ~P_TRACED;
204 /* remove pending SIGTRAP, else the process will die */
205 SIGDELSET(p->p_siglist, SIGTRAP);
207 /* give process back to original parent */
208 if (p->p_oppid != p->p_pptr->p_pid) {
211 pp = pfind(p->p_oppid);
213 proc_reparent(p, pp);
217 p->p_flag &= ~P_WAITED; /* XXX ? */
218 wakeup((caddr_t) curp); /* XXX for CTL_WAIT below ? */
223 * Step. Let the target process execute a single instruction.
225 case PROCFS_CTL_STEP:
227 error = procfs_sstep(p);
234 * Run. Let the target process continue running until a breakpoint
235 * or some other trap.
241 * Wait for the target process to stop.
242 * If the target is not being traced then just wait
245 case PROCFS_CTL_WAIT:
247 if (p->p_flag & P_TRACED) {
249 (p->p_flag & P_STOPPED) == 0 &&
250 (p->p_flag & P_TRACED) &&
251 (p->p_pptr == curp)) {
252 error = tsleep((caddr_t) p,
253 PCATCH, "procfsx", 0);
255 if (error == 0 && !TRACE_WAIT_P(curp, p))
258 while (error == 0 && (p->p_flag & P_STOPPED) == 0) {
259 error = tsleep((caddr_t) p,
260 PCATCH, "procfs", 0);
266 panic("procfs_control");
270 * If the process is in a stopped state, make it runnable again.
271 * Do not set P_BREAKTSLEEP - that is, do not break a tsleep that
272 * might be in progress.
274 if (p->p_flag & P_STOPPED)
280 procfs_doctl(struct proc *curp, struct proc *p, struct pfsnode *pfs,
285 char msg[PROCFS_CTLLEN+1];
288 if (uio->uio_rw != UIO_WRITE)
291 xlen = PROCFS_CTLLEN;
292 error = vfs_getuserstr(uio, msg, &xlen);
297 * Map signal names into signal generation
298 * or debug control. Unknown commands and/or signals
301 * Sending a signal while the process is being debugged
302 * also has the side effect of letting the target continue
303 * to run. There is no way to single-step a signal delivery.
307 nm = vfs_findname(ctlnames, msg, xlen);
309 error = procfs_control(curp, p, nm->nm_val);
311 nm = vfs_findname(signames, msg, xlen);
313 if (TRACE_WAIT_P(curp, p)) {
314 p->p_xstat = nm->nm_val;
319 * Make the process runnable but do not
324 ksignal(p, nm->nm_val);