xref: /netbsd-src/sys/kern/kern_exit.c (revision ecf6466c633518f478c293c388551b29e46729cc)
1 /*	$NetBSD: kern_exit.c,v 1.280 2020/01/22 12:23:04 ad Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2006, 2007, 2008 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center, and by Andrew Doran.
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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1982, 1986, 1989, 1991, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  * (c) UNIX System Laboratories, Inc.
37  * All or some portions of this file are derived from material licensed
38  * to the University of California by American Telephone and Telegraph
39  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
40  * the permission of UNIX System Laboratories, Inc.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  * 1. Redistributions of source code must retain the above copyright
46  *    notice, this list of conditions and the following disclaimer.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in the
49  *    documentation and/or other materials provided with the distribution.
50  * 3. Neither the name of the University nor the names of its contributors
51  *    may be used to endorse or promote products derived from this software
52  *    without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64  * SUCH DAMAGE.
65  *
66  *	@(#)kern_exit.c	8.10 (Berkeley) 2/23/95
67  */
68 
69 #include <sys/cdefs.h>
70 __KERNEL_RCSID(0, "$NetBSD: kern_exit.c,v 1.280 2020/01/22 12:23:04 ad Exp $");
71 
72 #include "opt_ktrace.h"
73 #include "opt_dtrace.h"
74 #include "opt_sysv.h"
75 
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/ioctl.h>
79 #include <sys/tty.h>
80 #include <sys/time.h>
81 #include <sys/resource.h>
82 #include <sys/kernel.h>
83 #include <sys/proc.h>
84 #include <sys/buf.h>
85 #include <sys/wait.h>
86 #include <sys/file.h>
87 #include <sys/fstrans.h>
88 #include <sys/vnode.h>
89 #include <sys/syslog.h>
90 #include <sys/pool.h>
91 #include <sys/uidinfo.h>
92 #include <sys/ptrace.h>
93 #include <sys/acct.h>
94 #include <sys/filedesc.h>
95 #include <sys/ras.h>
96 #include <sys/signalvar.h>
97 #include <sys/sched.h>
98 #include <sys/mount.h>
99 #include <sys/syscallargs.h>
100 #include <sys/kauth.h>
101 #include <sys/sleepq.h>
102 #include <sys/lockdebug.h>
103 #include <sys/ktrace.h>
104 #include <sys/cpu.h>
105 #include <sys/lwpctl.h>
106 #include <sys/atomic.h>
107 #include <sys/sdt.h>
108 #include <sys/psref.h>
109 
110 #include <uvm/uvm_extern.h>
111 
112 #ifdef DEBUG_EXIT
113 int debug_exit = 0;
114 #define DPRINTF(x) if (debug_exit) printf x
115 #else
116 #define DPRINTF(x)
117 #endif
118 
119 static int find_stopped_child(struct proc *, idtype_t, id_t, int,
120     struct proc **, struct wrusage *, siginfo_t *);
121 static void proc_free(struct proc *, struct wrusage *);
122 
123 /*
124  * DTrace SDT provider definitions
125  */
126 SDT_PROVIDER_DECLARE(proc);
127 SDT_PROBE_DEFINE1(proc, kernel, , exit, "int");
128 
129 /*
130  * Fill in the appropriate signal information, and signal the parent.
131  */
132 /* XXX noclone works around a gcc 4.5 bug on arm */
133 static void __noclone
134 exit_psignal(struct proc *p, struct proc *pp, ksiginfo_t *ksi)
135 {
136 
137 	KSI_INIT(ksi);
138 	if ((ksi->ksi_signo = P_EXITSIG(p)) == SIGCHLD) {
139 		if (p->p_xsig) {
140 			if (p->p_sflag & PS_COREDUMP)
141 				ksi->ksi_code = CLD_DUMPED;
142 			else
143 				ksi->ksi_code = CLD_KILLED;
144 			ksi->ksi_status = p->p_xsig;
145 		} else {
146 			ksi->ksi_code = CLD_EXITED;
147 			ksi->ksi_status = p->p_xexit;
148 		}
149 	} else {
150 		ksi->ksi_code = SI_USER;
151 		ksi->ksi_status = p->p_xsig;
152 	}
153 	/*
154 	 * We fill those in, even for non-SIGCHLD.
155 	 * It's safe to access p->p_cred unlocked here.
156 	 */
157 	ksi->ksi_pid = p->p_pid;
158 	ksi->ksi_uid = kauth_cred_geteuid(p->p_cred);
159 	/* XXX: is this still valid? */
160 	ksi->ksi_utime = p->p_stats->p_ru.ru_utime.tv_sec;
161 	ksi->ksi_stime = p->p_stats->p_ru.ru_stime.tv_sec;
162 }
163 
164 /*
165  * exit --
166  *	Death of process.
167  */
168 int
169 sys_exit(struct lwp *l, const struct sys_exit_args *uap, register_t *retval)
170 {
171 	/* {
172 		syscallarg(int)	rval;
173 	} */
174 	struct proc *p = l->l_proc;
175 
176 	/* Don't call exit1() multiple times in the same process. */
177 	mutex_enter(p->p_lock);
178 	if (p->p_sflag & PS_WEXIT) {
179 		mutex_exit(p->p_lock);
180 		lwp_exit(l);
181 	}
182 
183 	/* exit1() will release the mutex. */
184 	exit1(l, SCARG(uap, rval), 0);
185 	/* NOTREACHED */
186 	return (0);
187 }
188 
189 /*
190  * Exit: deallocate address space and other resources, change proc state
191  * to zombie, and unlink proc from allproc and parent's lists.  Save exit
192  * status and rusage for wait().  Check for child processes and orphan them.
193  *
194  * Must be called with p->p_lock held.  Does not return.
195  */
196 void
197 exit1(struct lwp *l, int exitcode, int signo)
198 {
199 	struct proc	*p, *child, *next_child, *old_parent, *new_parent;
200 	struct pgrp	*pgrp;
201 	ksiginfo_t	ksi;
202 	ksiginfoq_t	kq;
203 	int		wakeinit;
204 
205 	p = l->l_proc;
206 
207 	/* Verify that we hold no locks other than p->p_lock. */
208 	LOCKDEBUG_BARRIER(p->p_lock, 0);
209 	KASSERTMSG(curcpu()->ci_biglock_count == 0, "kernel_lock leaked");
210 	KASSERT(mutex_owned(p->p_lock));
211 	KASSERT(p->p_vmspace != NULL);
212 
213 	if (__predict_false(p == initproc)) {
214 		panic("init died (signal %d, exit %d)", signo, exitcode);
215 	}
216 
217 	p->p_sflag |= PS_WEXIT;
218 
219 	/*
220 	 * Force all other LWPs to exit before we do.  Only then can we
221 	 * begin to tear down the rest of the process state.
222 	 */
223 	if (p->p_nlwps > 1) {
224 		exit_lwps(l);
225 	}
226 
227 	ksiginfo_queue_init(&kq);
228 
229 	/*
230 	 * If we have been asked to stop on exit, do so now.
231 	 */
232 	if (__predict_false(p->p_sflag & PS_STOPEXIT)) {
233 		KERNEL_UNLOCK_ALL(l, &l->l_biglocks);
234 		sigclearall(p, &contsigmask, &kq);
235 
236 		if (!mutex_tryenter(proc_lock)) {
237 			mutex_exit(p->p_lock);
238 			mutex_enter(proc_lock);
239 			mutex_enter(p->p_lock);
240 		}
241 		p->p_waited = 0;
242 		p->p_pptr->p_nstopchild++;
243 		p->p_stat = SSTOP;
244 		mutex_exit(proc_lock);
245 		lwp_lock(l);
246 		p->p_nrlwps--;
247 		l->l_stat = LSSTOP;
248 		lwp_unlock(l);
249 		mutex_exit(p->p_lock);
250 		lwp_lock(l);
251 		spc_lock(l->l_cpu);
252 		mi_switch(l);
253 		mutex_enter(p->p_lock);
254 	}
255 
256 	/*
257 	 * Bin any remaining signals and mark the process as dying so it will
258 	 * not be found for, e.g. signals.
259 	 */
260 	sigfillset(&p->p_sigctx.ps_sigignore);
261 	sigclearall(p, NULL, &kq);
262 	p->p_stat = SDYING;
263 	mutex_exit(p->p_lock);
264 	ksiginfo_queue_drain(&kq);
265 
266 	/* Destroy any lwpctl info. */
267 	if (p->p_lwpctl != NULL)
268 		lwp_ctl_exit();
269 
270 	/*
271 	 * Drain all remaining references that procfs, ptrace and others may
272 	 * have on the process.
273 	 */
274 	rw_enter(&p->p_reflock, RW_WRITER);
275 
276 	DPRINTF(("%s: %d.%d exiting.\n", __func__, p->p_pid, l->l_lid));
277 
278 	timers_free(p, TIMERS_ALL);
279 #if defined(__HAVE_RAS)
280 	ras_purgeall();
281 #endif
282 
283 	/*
284 	 * Close open files, release open-file table and free signal
285 	 * actions.  This may block!
286 	 */
287 	fd_free();
288 	cwdfree(p->p_cwdi);
289 	p->p_cwdi = NULL;
290 	doexithooks(p);
291 	sigactsfree(p->p_sigacts);
292 
293 	/*
294 	 * Write out accounting data.
295 	 */
296 	(void)acct_process(l);
297 
298 #ifdef KTRACE
299 	/*
300 	 * Release trace file.
301 	 */
302 	if (p->p_tracep != NULL) {
303 		mutex_enter(&ktrace_lock);
304 		ktrderef(p);
305 		mutex_exit(&ktrace_lock);
306 	}
307 #endif
308 
309 	p->p_xexit = exitcode;
310 	p->p_xsig = signo;
311 
312 	/*
313 	 * If emulation has process exit hook, call it now.
314 	 * Set the exit status now so that the exit hook has
315 	 * an opportunity to tweak it (COMPAT_LINUX requires
316 	 * this for thread group emulation)
317 	 */
318 	if (p->p_emul->e_proc_exit)
319 		(*p->p_emul->e_proc_exit)(p);
320 
321 	/*
322 	 * Free the VM resources we're still holding on to.
323 	 * We must do this from a valid thread because doing
324 	 * so may block. This frees vmspace, which we don't
325 	 * need anymore. The only remaining lwp is the one
326 	 * we run at this moment, nothing runs in userland
327 	 * anymore.
328 	 */
329 	ruspace(p);	/* Update our vm resource use */
330 	uvm_proc_exit(p);
331 
332 	/*
333 	 * Stop profiling.
334 	 */
335 	if (__predict_false((p->p_stflag & PST_PROFIL) != 0)) {
336 		mutex_spin_enter(&p->p_stmutex);
337 		stopprofclock(p);
338 		mutex_spin_exit(&p->p_stmutex);
339 	}
340 
341 	/*
342 	 * If parent is waiting for us to exit or exec, PL_PPWAIT is set; we
343 	 * wake up the parent early to avoid deadlock.  We can do this once
344 	 * the VM resources are released.
345 	 */
346 	mutex_enter(proc_lock);
347 	if (p->p_lflag & PL_PPWAIT) {
348 		lwp_t *lp;
349 
350 		l->l_lwpctl = NULL; /* was on loan from blocked parent */
351 		p->p_lflag &= ~PL_PPWAIT;
352 
353 		lp = p->p_vforklwp;
354 		p->p_vforklwp = NULL;
355 		lp->l_vforkwaiting = false;
356 		cv_broadcast(&lp->l_waitcv);
357 	}
358 
359 	if (SESS_LEADER(p)) {
360 		struct vnode *vprele = NULL, *vprevoke = NULL;
361 		struct session *sp = p->p_session;
362 		struct tty *tp;
363 
364 		if (sp->s_ttyvp) {
365 			/*
366 			 * Controlling process.
367 			 * Signal foreground pgrp,
368 			 * drain controlling terminal
369 			 * and revoke access to controlling terminal.
370 			 */
371 			tp = sp->s_ttyp;
372 			mutex_spin_enter(&tty_lock);
373 			if (tp->t_session == sp) {
374 				/* we can't guarantee the revoke will do this */
375 				pgrp = tp->t_pgrp;
376 				tp->t_pgrp = NULL;
377 				tp->t_session = NULL;
378 				mutex_spin_exit(&tty_lock);
379 				if (pgrp != NULL) {
380 					pgsignal(pgrp, SIGHUP, 1);
381 				}
382 				mutex_exit(proc_lock);
383 				(void) ttywait(tp);
384 				mutex_enter(proc_lock);
385 
386 				/* The tty could have been revoked. */
387 				vprevoke = sp->s_ttyvp;
388 			} else
389 				mutex_spin_exit(&tty_lock);
390 			vprele = sp->s_ttyvp;
391 			sp->s_ttyvp = NULL;
392 			/*
393 			 * s_ttyp is not zero'd; we use this to indicate
394 			 * that the session once had a controlling terminal.
395 			 * (for logging and informational purposes)
396 			 */
397 		}
398 		sp->s_leader = NULL;
399 
400 		if (vprevoke != NULL || vprele != NULL) {
401 			if (vprevoke != NULL) {
402 				/* Releases proc_lock. */
403 				proc_sessrele(sp);
404 				VOP_REVOKE(vprevoke, REVOKEALL);
405 			} else
406 				mutex_exit(proc_lock);
407 			if (vprele != NULL)
408 				vrele(vprele);
409 			mutex_enter(proc_lock);
410 		}
411 	}
412 	fixjobc(p, p->p_pgrp, 0);
413 
414 	/* Release fstrans private data. */
415 	fstrans_lwp_dtor(l);
416 
417 	/*
418 	 * Finalize the last LWP's specificdata, as well as the
419 	 * specificdata for the proc itself.
420 	 */
421 	lwp_finispecific(l);
422 	proc_finispecific(p);
423 
424 	/*
425 	 * Notify interested parties of our demise.
426 	 */
427 	KNOTE(&p->p_klist, NOTE_EXIT);
428 
429 	SDT_PROBE(proc, kernel, , exit,
430 		((p->p_sflag & PS_COREDUMP) ? CLD_DUMPED :
431 		 (p->p_xsig ? CLD_KILLED : CLD_EXITED)),
432 		0,0,0,0);
433 
434 	/*
435 	 * Reset p_opptr pointer of all former children which got
436 	 * traced by another process and were reparented. We reset
437 	 * it to NULL here; the trace detach code then reparents
438 	 * the child to initproc. We only check allproc list, since
439 	 * eventual former children on zombproc list won't reference
440 	 * p_opptr anymore.
441 	 */
442 	if (__predict_false(p->p_slflag & PSL_CHTRACED)) {
443 		struct proc *q;
444 		PROCLIST_FOREACH(q, &allproc) {
445 			if (q->p_opptr == p)
446 				q->p_opptr = NULL;
447 		}
448 		PROCLIST_FOREACH(q, &zombproc) {
449 			if (q->p_opptr == p)
450 				q->p_opptr = NULL;
451 		}
452 	}
453 
454 	/*
455 	 * Give orphaned children to init(8).
456 	 */
457 	child = LIST_FIRST(&p->p_children);
458 	wakeinit = (child != NULL);
459 	for (; child != NULL; child = next_child) {
460 		next_child = LIST_NEXT(child, p_sibling);
461 
462 		/*
463 		 * Traced processes are killed since their existence
464 		 * means someone is screwing up. Since we reset the
465 		 * trace flags, the logic in sys_wait4() would not be
466 		 * triggered to reparent the process to its
467 		 * original parent, so we must do this here.
468 		 */
469 		if (__predict_false(child->p_slflag & PSL_TRACED)) {
470 			mutex_enter(p->p_lock);
471 			child->p_slflag &=
472 			    ~(PSL_TRACED|PSL_SYSCALL);
473 			mutex_exit(p->p_lock);
474 			if (child->p_opptr != child->p_pptr) {
475 				struct proc *t = child->p_opptr;
476 				proc_reparent(child, t ? t : initproc);
477 				child->p_opptr = NULL;
478 			} else
479 				proc_reparent(child, initproc);
480 			killproc(child, "orphaned traced process");
481 		} else
482 			proc_reparent(child, initproc);
483 	}
484 
485 	/*
486 	 * Move proc from allproc to zombproc, it's now nearly ready to be
487 	 * collected by parent.
488 	 */
489 	LIST_REMOVE(l, l_list);
490 	LIST_REMOVE(p, p_list);
491 	LIST_INSERT_HEAD(&zombproc, p, p_list);
492 
493 	/*
494 	 * Mark the process as dead.  We must do this before we signal
495 	 * the parent.
496 	 */
497 	p->p_stat = SDEAD;
498 
499 	/* Put in front of parent's sibling list for parent to collect it */
500 	old_parent = p->p_pptr;
501 	old_parent->p_nstopchild++;
502 	if (LIST_FIRST(&old_parent->p_children) != p) {
503 		/* Put child where it can be found quickly */
504 		LIST_REMOVE(p, p_sibling);
505 		LIST_INSERT_HEAD(&old_parent->p_children, p, p_sibling);
506 	}
507 
508 	/*
509 	 * Notify parent that we're gone.  If parent has the P_NOCLDWAIT
510 	 * flag set, notify init instead (and hope it will handle
511 	 * this situation).
512 	 */
513 	if (old_parent->p_flag & (PK_NOCLDWAIT|PK_CLDSIGIGN)) {
514 		proc_reparent(p, initproc);
515 		wakeinit = 1;
516 
517 		/*
518 		 * If this was the last child of our parent, notify
519 		 * parent, so in case he was wait(2)ing, he will
520 		 * continue.
521 		 */
522 		if (LIST_FIRST(&old_parent->p_children) == NULL)
523 			cv_broadcast(&old_parent->p_waitcv);
524 	}
525 
526 	/* Reload parent pointer, since p may have been reparented above */
527 	new_parent = p->p_pptr;
528 
529 	if (__predict_false(p->p_exitsig != 0)) {
530 		exit_psignal(p, new_parent, &ksi);
531 		kpsignal(new_parent, &ksi, NULL);
532 	}
533 
534 	/* Calculate the final rusage info.  */
535 	calcru(p, &p->p_stats->p_ru.ru_utime, &p->p_stats->p_ru.ru_stime,
536 	    NULL, NULL);
537 
538 	if (wakeinit)
539 		cv_broadcast(&initproc->p_waitcv);
540 
541 	callout_destroy(&l->l_timeout_ch);
542 
543 	/*
544 	 * Release any PCU resources before becoming a zombie.
545 	 */
546 	pcu_discard_all(l);
547 
548 	mutex_enter(p->p_lock);
549 	/* Free the linux lwp id */
550 	if ((l->l_pflag & LP_PIDLID) != 0 && l->l_lid != p->p_pid)
551 		proc_free_pid(l->l_lid);
552 	lwp_drainrefs(l);
553 	lwp_lock(l);
554 	l->l_prflag &= ~LPR_DETACHED;
555 	l->l_stat = LSZOMB;
556 	lwp_unlock(l);
557 	KASSERT(curlwp == l);
558 	KASSERT(p->p_nrlwps == 1);
559 	KASSERT(p->p_nlwps == 1);
560 	p->p_stat = SZOMB;
561 	p->p_nrlwps--;
562 	p->p_nzlwps++;
563 	p->p_ndlwps = 0;
564 	mutex_exit(p->p_lock);
565 
566 	/*
567 	 * Signal the parent to collect us, and drop the proclist lock.
568 	 * Drop debugger/procfs lock; no new references can be gained.
569 	 */
570 	cv_broadcast(&p->p_pptr->p_waitcv);
571 	rw_exit(&p->p_reflock);
572 	mutex_exit(proc_lock);
573 
574 	/*
575 	 * NOTE: WE ARE NO LONGER ALLOWED TO SLEEP!
576 	 */
577 
578 	/*
579 	 * Give machine-dependent code a chance to free any MD LWP
580 	 * resources.  This must be done before uvm_lwp_exit(), in
581 	 * case these resources are in the PCB.
582 	 */
583 	cpu_lwp_free(l, 1);
584 
585 	/* For the LW_RUNNING check in lwp_free(). */
586 	membar_exit();
587 
588 	/* Switch away into oblivion. */
589 	lwp_lock(l);
590 	spc_lock(l->l_cpu);
591 	mi_switch(l);
592 	panic("exit1");
593 }
594 
595 void
596 exit_lwps(struct lwp *l)
597 {
598 	proc_t *p = l->l_proc;
599 	lwp_t *l2;
600 
601 retry:
602 	KASSERT(mutex_owned(p->p_lock));
603 
604 	/*
605 	 * Interrupt LWPs in interruptable sleep, unsuspend suspended
606 	 * LWPs and then wait for everyone else to finish.
607 	 */
608 	LIST_FOREACH(l2, &p->p_lwps, l_sibling) {
609 		if (l2 == l)
610 			continue;
611 		lwp_lock(l2);
612 		l2->l_flag |= LW_WEXIT;
613 		if ((l2->l_stat == LSSLEEP && (l2->l_flag & LW_SINTR)) ||
614 		    l2->l_stat == LSSUSPENDED || l2->l_stat == LSSTOP) {
615 			l2->l_flag &= ~LW_DBGSUSPEND;
616 		    	/* setrunnable() will release the lock. */
617 			setrunnable(l2);
618 			continue;
619 		}
620 		lwp_unlock(l2);
621 	}
622 
623 	/*
624 	 * Wait for every LWP to exit.  Note: LWPs can get suspended/slept
625 	 * behind us or there may even be new LWPs created.  Therefore, a
626 	 * full retry is required on error.
627 	 */
628 	while (p->p_nlwps > 1) {
629 		if (lwp_wait(l, 0, NULL, true)) {
630 			goto retry;
631 		}
632 	}
633 
634 	KASSERT(p->p_nlwps == 1);
635 }
636 
637 int
638 do_sys_waitid(idtype_t idtype, id_t id, int *pid, int *status, int options,
639     struct wrusage *wru, siginfo_t *si)
640 {
641 	proc_t *child;
642 	int error;
643 
644 
645 	if (wru != NULL)
646 		memset(wru, 0, sizeof(*wru));
647 	if (si != NULL)
648 		memset(si, 0, sizeof(*si));
649 
650 	mutex_enter(proc_lock);
651 	error = find_stopped_child(curproc, idtype, id, options, &child,
652 	    wru, si);
653 	if (child == NULL) {
654 		mutex_exit(proc_lock);
655 		*pid = 0;
656 		*status = 0;
657 		return error;
658 	}
659 	*pid = child->p_pid;
660 
661 	if (child->p_stat == SZOMB) {
662 		/* Child is exiting */
663 		*status = P_WAITSTATUS(child);
664 		/* proc_free() will release the proc_lock. */
665 		if (options & WNOWAIT) {
666 			mutex_exit(proc_lock);
667 		} else {
668 			proc_free(child, wru);
669 		}
670 	} else {
671 		/* Don't mark SIGCONT if we are being stopped */
672 		*status = (child->p_xsig == SIGCONT && child->p_stat != SSTOP) ?
673 		    W_CONTCODE() : W_STOPCODE(child->p_xsig);
674 		mutex_exit(proc_lock);
675 	}
676 	return 0;
677 }
678 
679 int
680 do_sys_wait(int *pid, int *status, int options, struct rusage *ru)
681 {
682 	idtype_t idtype;
683 	id_t id;
684 	int ret;
685 	struct wrusage wru;
686 
687 	/*
688 	 * Translate the special pid values into the (idtype, pid)
689 	 * pair for wait6. The WAIT_MYPGRP case is handled by
690 	 * find_stopped_child() on its own.
691 	 */
692 	if (*pid == WAIT_ANY) {
693 		idtype = P_ALL;
694 		id = 0;
695 	} else if (*pid < 0) {
696 		idtype = P_PGID;
697 		id = (id_t)-*pid;
698 	} else {
699 		idtype = P_PID;
700 		id = (id_t)*pid;
701 	}
702 	options |= WEXITED | WTRAPPED;
703 	ret = do_sys_waitid(idtype, id, pid, status, options, ru ? &wru : NULL,
704 	    NULL);
705 	if (ru)
706 		*ru = wru.wru_self;
707 	return ret;
708 }
709 
710 int
711 sys___wait450(struct lwp *l, const struct sys___wait450_args *uap,
712     register_t *retval)
713 {
714 	/* {
715 		syscallarg(int)			pid;
716 		syscallarg(int *)		status;
717 		syscallarg(int)			options;
718 		syscallarg(struct rusage *)	rusage;
719 	} */
720 	int error, status, pid = SCARG(uap, pid);
721 	struct rusage ru;
722 
723 	error = do_sys_wait(&pid, &status, SCARG(uap, options),
724 	    SCARG(uap, rusage) != NULL ? &ru : NULL);
725 
726 	retval[0] = pid;
727 	if (pid == 0) {
728 		return error;
729 	}
730 	if (SCARG(uap, status)) {
731 		error = copyout(&status, SCARG(uap, status), sizeof(status));
732 	}
733 	if (SCARG(uap, rusage) && error == 0) {
734 		error = copyout(&ru, SCARG(uap, rusage), sizeof(ru));
735 	}
736 	return error;
737 }
738 
739 int
740 sys_wait6(struct lwp *l, const struct sys_wait6_args *uap, register_t *retval)
741 {
742 	/* {
743 		syscallarg(idtype_t)		idtype;
744 		syscallarg(id_t)		id;
745 		syscallarg(int *)		status;
746 		syscallarg(int)			options;
747 		syscallarg(struct wrusage *)	wru;
748 		syscallarg(siginfo_t *)		si;
749 	} */
750 	struct wrusage wru, *wrup;
751 	siginfo_t si, *sip;
752 	idtype_t idtype;
753 	int pid;
754 	id_t id;
755 	int error, status;
756 
757 	idtype = SCARG(uap, idtype);
758 	id = SCARG(uap, id);
759 
760 	if (SCARG(uap, wru) != NULL)
761 		wrup = &wru;
762 	else
763 		wrup = NULL;
764 
765 	if (SCARG(uap, info) != NULL)
766 		sip = &si;
767 	else
768 		sip = NULL;
769 
770 	/*
771 	 *  We expect all callers of wait6() to know about WEXITED and
772 	 *  WTRAPPED.
773 	 */
774 	error = do_sys_waitid(idtype, id, &pid, &status, SCARG(uap, options),
775 	    wrup, sip);
776 
777 	retval[0] = pid; 	/* tell userland who it was */
778 
779 #if 0
780 	/*
781 	 * should we copyout if there was no process, hence no useful data?
782 	 * We don't for an old sytle wait4() (etc) but I believe
783 	 * FreeBSD does for wait6(), so a tossup...  Go with FreeBSD for now.
784 	 */
785 	if (pid == 0)
786 		return error;
787 #endif
788 
789 	if (SCARG(uap, status) != NULL && error == 0)
790 		error = copyout(&status, SCARG(uap, status), sizeof(status));
791 	if (SCARG(uap, wru) != NULL && error == 0)
792 		error = copyout(&wru, SCARG(uap, wru), sizeof(wru));
793 	if (SCARG(uap, info) != NULL && error == 0)
794 		error = copyout(&si, SCARG(uap, info), sizeof(si));
795 	return error;
796 }
797 
798 
799 /*
800  * Find a process that matches the provided criteria, and fill siginfo
801  * and resources if found.
802  * Returns:
803  *	-1: 	Not found, abort early
804  *	 0:	Not matched
805  *	 1:	Matched, there might be more matches
806  *	 2:	This is the only match
807  */
808 static int
809 match_process(const struct proc *pp, struct proc **q, idtype_t idtype, id_t id,
810     int options, struct wrusage *wrusage, siginfo_t *siginfo)
811 {
812 	struct rusage *rup;
813 	struct proc *p = *q;
814 	int rv = 1;
815 
816 	mutex_enter(p->p_lock);
817 	switch (idtype) {
818 	case P_ALL:
819 		break;
820 	case P_PID:
821 		if (p->p_pid != (pid_t)id) {
822 			mutex_exit(p->p_lock);
823 			p = *q = proc_find_raw((pid_t)id);
824 			if (p == NULL || p->p_stat == SIDL || p->p_pptr != pp) {
825 				*q = NULL;
826 				return -1;
827 			}
828 			mutex_enter(p->p_lock);
829 		}
830 		rv++;
831 		break;
832 	case P_PGID:
833 		if (p->p_pgid != (pid_t)id)
834 			goto out;
835 		break;
836 	case P_SID:
837 		if (p->p_session->s_sid != (pid_t)id)
838 			goto out;
839 		break;
840 	case P_UID:
841 		if (kauth_cred_geteuid(p->p_cred) != (uid_t)id)
842 			goto out;
843 		break;
844 	case P_GID:
845 		if (kauth_cred_getegid(p->p_cred) != (gid_t)id)
846 			goto out;
847 		break;
848 	case P_CID:
849 	case P_PSETID:
850 	case P_CPUID:
851 		/* XXX: Implement me */
852 	default:
853 	out:
854 		mutex_exit(p->p_lock);
855 		return 0;
856 	}
857 
858 	if ((options & WEXITED) == 0 && p->p_stat == SZOMB)
859 		goto out;
860 
861 	if (siginfo != NULL) {
862 		siginfo->si_errno = 0;
863 
864 		/*
865 		 * SUSv4 requires that the si_signo value is always
866 		 * SIGCHLD. Obey it despite the rfork(2) interface
867 		 * allows to request other signal for child exit
868 		 * notification.
869 		 */
870 		siginfo->si_signo = SIGCHLD;
871 
872 		/*
873 		 *  This is still a rough estimate.  We will fix the
874 		 *  cases TRAPPED, STOPPED, and CONTINUED later.
875 		 */
876 		if (p->p_sflag & PS_COREDUMP) {
877 			siginfo->si_code = CLD_DUMPED;
878 			siginfo->si_status = p->p_xsig;
879 		} else if (p->p_xsig) {
880 			siginfo->si_code = CLD_KILLED;
881 			siginfo->si_status = p->p_xsig;
882 		} else {
883 			siginfo->si_code = CLD_EXITED;
884 			siginfo->si_status = p->p_xexit;
885 		}
886 
887 		siginfo->si_pid = p->p_pid;
888 		siginfo->si_uid = kauth_cred_geteuid(p->p_cred);
889 		siginfo->si_utime = p->p_stats->p_ru.ru_utime.tv_sec;
890 		siginfo->si_stime = p->p_stats->p_ru.ru_stime.tv_sec;
891 	}
892 
893 	/*
894 	 * There should be no reason to limit resources usage info to
895 	 * exited processes only.  A snapshot about any resources used
896 	 * by a stopped process may be exactly what is needed.
897 	 */
898 	if (wrusage != NULL) {
899 		rup = &wrusage->wru_self;
900 		*rup = p->p_stats->p_ru;
901 		calcru(p, &rup->ru_utime, &rup->ru_stime, NULL, NULL);
902 
903 		rup = &wrusage->wru_children;
904 		*rup = p->p_stats->p_cru;
905 		calcru(p, &rup->ru_utime, &rup->ru_stime, NULL, NULL);
906 	}
907 
908 	mutex_exit(p->p_lock);
909 	return rv;
910 }
911 
912 /*
913  * Determine if there are existing processes being debugged
914  * that used to be (and sometime later will be again) children
915  * of a specific parent (while matching wait criteria)
916  */
917 static bool
918 debugged_child_exists(idtype_t idtype, id_t id, int options, siginfo_t *si,
919     const struct proc *parent)
920 {
921 	struct proc *pp;
922 
923 	/*
924 	 * If we are searching for a specific pid, we can optimise a little
925 	 */
926 	if (idtype == P_PID) {
927 		/*
928 		 * Check the specific process to see if its real parent is us
929 		 */
930 		pp = proc_find_raw((pid_t)id);
931 		if (pp != NULL && pp->p_stat != SIDL && pp->p_opptr == parent) {
932 			/*
933 			 * using P_ALL here avoids match_process() doing the
934 			 * same work that we just did, but incorrectly for
935 			 * this scenario.
936 			 */
937 			if (match_process(parent, &pp, P_ALL, id, options,
938 			    NULL, si))
939 				return true;
940 		}
941 		return false;
942 	}
943 
944 	/*
945 	 * For the hard cases, just look everywhere to see if some
946 	 * stolen (reparented) process is really our lost child.
947 	 * Then check if that process could satisfy the wait conditions.
948 	 */
949 
950 	/*
951 	 * XXX inefficient, but hopefully fairly rare.
952 	 * XXX should really use a list of reparented processes.
953 	 */
954 	PROCLIST_FOREACH(pp, &allproc) {
955 		if (pp->p_stat == SIDL)		/* XXX impossible ?? */
956 			continue;
957 		if (pp->p_opptr == parent &&
958 		    match_process(parent, &pp, idtype, id, options, NULL, si))
959 			return true;
960 	}
961 	PROCLIST_FOREACH(pp, &zombproc) {
962 		if (pp->p_stat == SIDL)		/* XXX impossible ?? */
963 			continue;
964 		if (pp->p_opptr == parent &&
965 		    match_process(parent, &pp, idtype, id, options, NULL, si))
966 			return true;
967 	}
968 
969 	return false;
970 }
971 
972 /*
973  * Scan list of child processes for a child process that has stopped or
974  * exited.  Used by sys_wait4 and 'compat' equivalents.
975  *
976  * Must be called with the proc_lock held, and may release while waiting.
977  */
978 static int
979 find_stopped_child(struct proc *parent, idtype_t idtype, id_t id, int options,
980     struct proc **child_p, struct wrusage *wru, siginfo_t *si)
981 {
982 	struct proc *child, *dead;
983 	int error;
984 
985 	KASSERT(mutex_owned(proc_lock));
986 
987 	if (options & ~WALLOPTS) {
988 		*child_p = NULL;
989 		return EINVAL;
990 	}
991 
992 	if ((options & WSELECTOPTS) == 0) {
993 		/*
994 		 * We will be unable to find any matching processes,
995 		 * because there are no known events to look for.
996 		 * Prefer to return error instead of blocking
997 		 * indefinitely.
998 		 */
999 		*child_p = NULL;
1000 		return EINVAL;
1001 	}
1002 
1003 	if ((pid_t)id == WAIT_MYPGRP && (idtype == P_PID || idtype == P_PGID)) {
1004 		mutex_enter(parent->p_lock);
1005 		id = (id_t)parent->p_pgid;
1006 		mutex_exit(parent->p_lock);
1007 		idtype = P_PGID;
1008 	}
1009 
1010 	for (;;) {
1011 		error = ECHILD;
1012 		dead = NULL;
1013 
1014 		LIST_FOREACH(child, &parent->p_children, p_sibling) {
1015 			int rv = match_process(parent, &child, idtype, id,
1016 			    options, wru, si);
1017 			if (rv == -1)
1018 				break;
1019 			if (rv == 0)
1020 				continue;
1021 
1022 			/*
1023 			 * Wait for processes with p_exitsig != SIGCHLD
1024 			 * processes only if WALTSIG is set; wait for
1025 			 * processes with p_exitsig == SIGCHLD only
1026 			 * if WALTSIG is clear.
1027 			 */
1028 			if (((options & WALLSIG) == 0) &&
1029 			    (options & WALTSIG ? child->p_exitsig == SIGCHLD
1030 						: P_EXITSIG(child) != SIGCHLD)){
1031 				if (rv == 2) {
1032 					child = NULL;
1033 					break;
1034 				}
1035 				continue;
1036 			}
1037 
1038 			error = 0;
1039 			if ((options & WNOZOMBIE) == 0) {
1040 				if (child->p_stat == SZOMB)
1041 					break;
1042 				if (child->p_stat == SDEAD) {
1043 					/*
1044 					 * We may occasionally arrive here
1045 					 * after receiving a signal, but
1046 					 * immediately before the child
1047 					 * process is zombified.  The wait
1048 					 * will be short, so avoid returning
1049 					 * to userspace.
1050 					 */
1051 					dead = child;
1052 				}
1053 			}
1054 
1055 			if ((options & WCONTINUED) != 0 &&
1056 			    child->p_xsig == SIGCONT &&
1057 			    (child->p_sflag & PS_CONTINUED)) {
1058 				if ((options & WNOWAIT) == 0) {
1059 					child->p_sflag &= ~PS_CONTINUED;
1060 					child->p_waited = 1;
1061 					parent->p_nstopchild--;
1062 				}
1063 				if (si) {
1064 					si->si_status = child->p_xsig;
1065 					si->si_code = CLD_CONTINUED;
1066 				}
1067 				break;
1068 			}
1069 
1070 			if ((options & (WTRAPPED|WSTOPPED)) != 0 &&
1071 			    child->p_stat == SSTOP &&
1072 			    child->p_waited == 0 &&
1073 			    ((child->p_slflag & PSL_TRACED) ||
1074 			    options & (WUNTRACED|WSTOPPED))) {
1075 				if ((options & WNOWAIT) == 0) {
1076 					child->p_waited = 1;
1077 					parent->p_nstopchild--;
1078 				}
1079 				if (si) {
1080 					si->si_status = child->p_xsig;
1081 					si->si_code =
1082 					    (child->p_slflag & PSL_TRACED) ?
1083 					    CLD_TRAPPED : CLD_STOPPED;
1084 				}
1085 				break;
1086 			}
1087 			if (parent->p_nstopchild == 0 || rv == 2) {
1088 				child = NULL;
1089 				break;
1090 			}
1091 		}
1092 
1093 		/*
1094 		 * If we found nothing, but we are the bereaved parent
1095 		 * of a stolen child, look and see if that child (or
1096 		 * one of them) meets our search criteria.   If so, then
1097 		 * we cannot succeed, but we can hang (wait...),
1098 		 * or if WNOHANG, return 0 instead of ECHILD
1099 		 */
1100 		if (child == NULL && error == ECHILD &&
1101 		    (parent->p_slflag & PSL_CHTRACED) &&
1102 		    debugged_child_exists(idtype, id, options, si, parent))
1103 			error = 0;
1104 
1105 		if (child != NULL || error != 0 ||
1106 		    ((options & WNOHANG) != 0 && dead == NULL)) {
1107 			*child_p = child;
1108 			return error;
1109 		}
1110 
1111 		/*
1112 		 * Wait for another child process to stop.
1113 		 */
1114 		error = cv_wait_sig(&parent->p_waitcv, proc_lock);
1115 
1116 		if (error != 0) {
1117 			*child_p = NULL;
1118 			return error;
1119 		}
1120 	}
1121 }
1122 
1123 /*
1124  * Free a process after parent has taken all the state info.  Must be called
1125  * with the proclist lock held, and will release before returning.
1126  *
1127  * *ru is returned to the caller, and must be freed by the caller.
1128  */
1129 static void
1130 proc_free(struct proc *p, struct wrusage *wru)
1131 {
1132 	struct proc *parent = p->p_pptr;
1133 	struct lwp *l;
1134 	ksiginfo_t ksi;
1135 	kauth_cred_t cred1, cred2;
1136 	uid_t uid;
1137 
1138 	KASSERT(mutex_owned(proc_lock));
1139 	KASSERT(p->p_nlwps == 1);
1140 	KASSERT(p->p_nzlwps == 1);
1141 	KASSERT(p->p_nrlwps == 0);
1142 	KASSERT(p->p_stat == SZOMB);
1143 
1144 	/*
1145 	 * If we got the child via ptrace(2) or procfs, and
1146 	 * the parent is different (meaning the process was
1147 	 * attached, rather than run as a child), then we need
1148 	 * to give it back to the old parent, and send the
1149 	 * parent the exit signal.  The rest of the cleanup
1150 	 * will be done when the old parent waits on the child.
1151 	 */
1152 	if ((p->p_slflag & PSL_TRACED) != 0 && p->p_opptr != parent) {
1153 		mutex_enter(p->p_lock);
1154 		p->p_slflag &= ~(PSL_TRACED|PSL_SYSCALL);
1155 		mutex_exit(p->p_lock);
1156 		parent = (p->p_opptr == NULL) ? initproc : p->p_opptr;
1157 		proc_reparent(p, parent);
1158 		p->p_opptr = NULL;
1159 		if (p->p_exitsig != 0) {
1160 			exit_psignal(p, parent, &ksi);
1161 			kpsignal(parent, &ksi, NULL);
1162 		}
1163 		cv_broadcast(&parent->p_waitcv);
1164 		mutex_exit(proc_lock);
1165 		return;
1166 	}
1167 
1168 	sched_proc_exit(parent, p);
1169 
1170 	/*
1171 	 * Add child times of exiting process onto its own times.
1172 	 * This cannot be done any earlier else it might get done twice.
1173 	 */
1174 	l = LIST_FIRST(&p->p_lwps);
1175 	p->p_stats->p_ru.ru_nvcsw += (l->l_ncsw - l->l_nivcsw);
1176 	p->p_stats->p_ru.ru_nivcsw += l->l_nivcsw;
1177 	ruadd(&p->p_stats->p_ru, &l->l_ru);
1178 	ruadd(&p->p_stats->p_ru, &p->p_stats->p_cru);
1179 	ruadd(&parent->p_stats->p_cru, &p->p_stats->p_ru);
1180 	if (wru != NULL) {
1181 		wru->wru_self = p->p_stats->p_ru;
1182 		wru->wru_children = p->p_stats->p_cru;
1183 	}
1184 	p->p_xsig = 0;
1185 	p->p_xexit = 0;
1186 
1187 	/*
1188 	 * At this point we are going to start freeing the final resources.
1189 	 * If anyone tries to access the proc structure after here they will
1190 	 * get a shock - bits are missing.  Attempt to make it hard!  We
1191 	 * don't bother with any further locking past this point.
1192 	 */
1193 	p->p_stat = SIDL;		/* not even a zombie any more */
1194 	LIST_REMOVE(p, p_list);	/* off zombproc */
1195 	parent->p_nstopchild--;
1196 	LIST_REMOVE(p, p_sibling);
1197 
1198 	/*
1199 	 * Let pid be reallocated.
1200 	 */
1201 	proc_free_pid(p->p_pid);
1202 
1203 	/*
1204 	 * Unlink process from its process group.
1205 	 * Releases the proc_lock.
1206 	 */
1207 	proc_leavepgrp(p);
1208 
1209 	/*
1210 	 * Delay release until after lwp_free.
1211 	 */
1212 	cred2 = l->l_cred;
1213 
1214 	/*
1215 	 * Free the last LWP's resources.
1216 	 *
1217 	 * lwp_free ensures the LWP is no longer running on another CPU.
1218 	 */
1219 	lwp_free(l, false, true);
1220 
1221 	/*
1222 	 * Now no one except us can reach the process p.
1223 	 */
1224 
1225 	/*
1226 	 * Decrement the count of procs running with this uid.
1227 	 */
1228 	cred1 = p->p_cred;
1229 	uid = kauth_cred_getuid(cred1);
1230 	(void)chgproccnt(uid, -1);
1231 
1232 	/*
1233 	 * Release substructures.
1234 	 */
1235 
1236 	lim_free(p->p_limit);
1237 	pstatsfree(p->p_stats);
1238 	kauth_cred_free(cred1);
1239 	kauth_cred_free(cred2);
1240 
1241 	/*
1242 	 * Release reference to text vnode
1243 	 */
1244 	if (p->p_textvp)
1245 		vrele(p->p_textvp);
1246 	kmem_strfree(p->p_path);
1247 
1248 	mutex_destroy(&p->p_auxlock);
1249 	mutex_obj_free(p->p_lock);
1250 	mutex_destroy(&p->p_stmutex);
1251 	cv_destroy(&p->p_waitcv);
1252 	cv_destroy(&p->p_lwpcv);
1253 	rw_destroy(&p->p_reflock);
1254 
1255 	proc_free_mem(p);
1256 }
1257 
1258 /*
1259  * Change the parent of a process for tracing purposes.
1260  */
1261 void
1262 proc_changeparent(struct proc *t, struct proc *p)
1263 {
1264 	SET(t->p_slflag, PSL_TRACED);
1265 	t->p_opptr = t->p_pptr;
1266 	if (t->p_pptr == p)
1267 		return;
1268 	struct proc *parent = t->p_pptr;
1269 
1270 	if (parent->p_lock < t->p_lock) {
1271 		if (!mutex_tryenter(parent->p_lock)) {
1272 			mutex_exit(t->p_lock);
1273 			mutex_enter(parent->p_lock);
1274 			mutex_enter(t->p_lock);
1275 		}
1276 	} else if (parent->p_lock > t->p_lock) {
1277 		mutex_enter(parent->p_lock);
1278 	}
1279 	parent->p_slflag |= PSL_CHTRACED;
1280 	proc_reparent(t, p);
1281 	if (parent->p_lock != t->p_lock)
1282 		mutex_exit(parent->p_lock);
1283 }
1284 
1285 /*
1286  * make process 'parent' the new parent of process 'child'.
1287  *
1288  * Must be called with proc_lock held.
1289  */
1290 void
1291 proc_reparent(struct proc *child, struct proc *parent)
1292 {
1293 
1294 	KASSERT(mutex_owned(proc_lock));
1295 
1296 	if (child->p_pptr == parent)
1297 		return;
1298 
1299 	if (child->p_stat == SZOMB || child->p_stat == SDEAD ||
1300 	    (child->p_stat == SSTOP && !child->p_waited)) {
1301 		child->p_pptr->p_nstopchild--;
1302 		parent->p_nstopchild++;
1303 	}
1304 	if (parent == initproc) {
1305 		child->p_exitsig = SIGCHLD;
1306 		child->p_ppid = parent->p_pid;
1307 	}
1308 
1309 	LIST_REMOVE(child, p_sibling);
1310 	LIST_INSERT_HEAD(&parent->p_children, child, p_sibling);
1311 	child->p_pptr = parent;
1312 }
1313