]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/kern_exit.c
- Add a BIT_FFS() macro and use it to replace cpusetffs_obj()
[FreeBSD/FreeBSD.git] / sys / kern / kern_exit.c
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
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  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      @(#)kern_exit.c 8.7 (Berkeley) 2/12/94
35  */
36
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39
40 #include "opt_compat.h"
41 #include "opt_kdtrace.h"
42 #include "opt_ktrace.h"
43 #include "opt_procdesc.h"
44
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/sysproto.h>
48 #include <sys/capability.h>
49 #include <sys/eventhandler.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/lock.h>
53 #include <sys/mutex.h>
54 #include <sys/proc.h>
55 #include <sys/procdesc.h>
56 #include <sys/pioctl.h>
57 #include <sys/jail.h>
58 #include <sys/tty.h>
59 #include <sys/wait.h>
60 #include <sys/vmmeter.h>
61 #include <sys/vnode.h>
62 #include <sys/racct.h>
63 #include <sys/resourcevar.h>
64 #include <sys/sbuf.h>
65 #include <sys/signalvar.h>
66 #include <sys/sched.h>
67 #include <sys/sx.h>
68 #include <sys/syscallsubr.h>
69 #include <sys/syslog.h>
70 #include <sys/ptrace.h>
71 #include <sys/acct.h>           /* for acct_process() function prototype */
72 #include <sys/filedesc.h>
73 #include <sys/sdt.h>
74 #include <sys/shm.h>
75 #include <sys/sem.h>
76 #ifdef KTRACE
77 #include <sys/ktrace.h>
78 #endif
79
80 #include <security/audit/audit.h>
81 #include <security/mac/mac_framework.h>
82
83 #include <vm/vm.h>
84 #include <vm/vm_extern.h>
85 #include <vm/vm_param.h>
86 #include <vm/pmap.h>
87 #include <vm/vm_map.h>
88 #include <vm/vm_page.h>
89 #include <vm/uma.h>
90
91 #ifdef KDTRACE_HOOKS
92 #include <sys/dtrace_bsd.h>
93 dtrace_execexit_func_t  dtrace_fasttrap_exit;
94 #endif
95
96 SDT_PROVIDER_DECLARE(proc);
97 SDT_PROBE_DEFINE(proc, kernel, , exit, exit);
98 SDT_PROBE_ARGTYPE(proc, kernel, , exit, 0, "int");
99
100 /* Hook for NFS teardown procedure. */
101 void (*nlminfo_release_p)(struct proc *p);
102
103 static void
104 clear_orphan(struct proc *p)
105 {
106
107         PROC_LOCK_ASSERT(p, MA_OWNED);
108
109         if (p->p_flag & P_ORPHAN) {
110                 LIST_REMOVE(p, p_orphan);
111                 p->p_flag &= ~P_ORPHAN;
112         }
113 }
114
115 /*
116  * exit -- death of process.
117  */
118 void
119 sys_sys_exit(struct thread *td, struct sys_exit_args *uap)
120 {
121
122         exit1(td, W_EXITCODE(uap->rval, 0));
123         /* NOTREACHED */
124 }
125
126 /*
127  * Exit: deallocate address space and other resources, change proc state to
128  * zombie, and unlink proc from allproc and parent's lists.  Save exit status
129  * and rusage for wait().  Check for child processes and orphan them.
130  */
131 void
132 exit1(struct thread *td, int rv)
133 {
134         struct proc *p, *nq, *q;
135         struct vnode *vtmp;
136         struct vnode *ttyvp = NULL;
137         struct plimit *plim;
138
139         mtx_assert(&Giant, MA_NOTOWNED);
140
141         p = td->td_proc;
142         /*
143          * XXX in case we're rebooting we just let init die in order to
144          * work around an unsolved stack overflow seen very late during
145          * shutdown on sparc64 when the gmirror worker process exists.
146          */
147         if (p == initproc && rebooting == 0) {
148                 printf("init died (signal %d, exit %d)\n",
149                     WTERMSIG(rv), WEXITSTATUS(rv));
150                 panic("Going nowhere without my init!");
151         }
152
153         /*
154          * MUST abort all other threads before proceeding past here.
155          */
156         PROC_LOCK(p);
157         while (p->p_flag & P_HADTHREADS) {
158                 /*
159                  * First check if some other thread got here before us.
160                  * If so, act appropriately: exit or suspend.
161                  */
162                 thread_suspend_check(0);
163
164                 /*
165                  * Kill off the other threads. This requires
166                  * some co-operation from other parts of the kernel
167                  * so it may not be instantaneous.  With this state set
168                  * any thread entering the kernel from userspace will
169                  * thread_exit() in trap().  Any thread attempting to
170                  * sleep will return immediately with EINTR or EWOULDBLOCK
171                  * which will hopefully force them to back out to userland
172                  * freeing resources as they go.  Any thread attempting
173                  * to return to userland will thread_exit() from userret().
174                  * thread_exit() will unsuspend us when the last of the
175                  * other threads exits.
176                  * If there is already a thread singler after resumption,
177                  * calling thread_single will fail; in that case, we just
178                  * re-check all suspension request, the thread should
179                  * either be suspended there or exit.
180                  */
181                 if (!thread_single(SINGLE_EXIT))
182                         break;
183
184                 /*
185                  * All other activity in this process is now stopped.
186                  * Threading support has been turned off.
187                  */
188         }
189         KASSERT(p->p_numthreads == 1,
190             ("exit1: proc %p exiting with %d threads", p, p->p_numthreads));
191         racct_sub(p, RACCT_NTHR, 1);
192         /*
193          * Wakeup anyone in procfs' PIOCWAIT.  They should have a hold
194          * on our vmspace, so we should block below until they have
195          * released their reference to us.  Note that if they have
196          * requested S_EXIT stops we will block here until they ack
197          * via PIOCCONT.
198          */
199         _STOPEVENT(p, S_EXIT, rv);
200
201         /*
202          * Ignore any pending request to stop due to a stop signal.
203          * Once P_WEXIT is set, future requests will be ignored as
204          * well.
205          */
206         p->p_flag &= ~P_STOPPED_SIG;
207         KASSERT(!P_SHOULDSTOP(p), ("exiting process is stopped"));
208
209         /*
210          * Note that we are exiting and do another wakeup of anyone in
211          * PIOCWAIT in case they aren't listening for S_EXIT stops or
212          * decided to wait again after we told them we are exiting.
213          */
214         p->p_flag |= P_WEXIT;
215         wakeup(&p->p_stype);
216
217         /*
218          * Wait for any processes that have a hold on our vmspace to
219          * release their reference.
220          */
221         while (p->p_lock > 0)
222                 msleep(&p->p_lock, &p->p_mtx, PWAIT, "exithold", 0);
223
224         p->p_xstat = rv;        /* Let event handler change exit status */
225         PROC_UNLOCK(p);
226         /* Drain the limit callout while we don't have the proc locked */
227         callout_drain(&p->p_limco);
228
229 #ifdef AUDIT
230         /*
231          * The Sun BSM exit token contains two components: an exit status as
232          * passed to exit(), and a return value to indicate what sort of exit
233          * it was.  The exit status is WEXITSTATUS(rv), but it's not clear
234          * what the return value is.
235          */
236         AUDIT_ARG_EXIT(WEXITSTATUS(rv), 0);
237         AUDIT_SYSCALL_EXIT(0, td);
238 #endif
239
240         /* Are we a task leader? */
241         if (p == p->p_leader) {
242                 mtx_lock(&ppeers_lock);
243                 q = p->p_peers;
244                 while (q != NULL) {
245                         PROC_LOCK(q);
246                         kern_psignal(q, SIGKILL);
247                         PROC_UNLOCK(q);
248                         q = q->p_peers;
249                 }
250                 while (p->p_peers != NULL)
251                         msleep(p, &ppeers_lock, PWAIT, "exit1", 0);
252                 mtx_unlock(&ppeers_lock);
253         }
254
255         /*
256          * Check if any loadable modules need anything done at process exit.
257          * E.g. SYSV IPC stuff
258          * XXX what if one of these generates an error?
259          */
260         EVENTHANDLER_INVOKE(process_exit, p);
261
262         /*
263          * If parent is waiting for us to exit or exec,
264          * P_PPWAIT is set; we will wakeup the parent below.
265          */
266         PROC_LOCK(p);
267         rv = p->p_xstat;        /* Event handler could change exit status */
268         stopprofclock(p);
269         p->p_flag &= ~(P_TRACED | P_PPWAIT | P_PPTRACE);
270
271         /*
272          * Stop the real interval timer.  If the handler is currently
273          * executing, prevent it from rearming itself and let it finish.
274          */
275         if (timevalisset(&p->p_realtimer.it_value) &&
276             callout_stop(&p->p_itcallout) == 0) {
277                 timevalclear(&p->p_realtimer.it_interval);
278                 msleep(&p->p_itcallout, &p->p_mtx, PWAIT, "ritwait", 0);
279                 KASSERT(!timevalisset(&p->p_realtimer.it_value),
280                     ("realtime timer is still armed"));
281         }
282         PROC_UNLOCK(p);
283
284         /*
285          * Reset any sigio structures pointing to us as a result of
286          * F_SETOWN with our pid.
287          */
288         funsetownlst(&p->p_sigiolst);
289
290         /*
291          * If this process has an nlminfo data area (for lockd), release it
292          */
293         if (nlminfo_release_p != NULL && p->p_nlminfo != NULL)
294                 (*nlminfo_release_p)(p);
295
296         /*
297          * Close open files and release open-file table.
298          * This may block!
299          */
300         fdescfree(td);
301
302         /*
303          * If this thread tickled GEOM, we need to wait for the giggling to
304          * stop before we return to userland
305          */
306         if (td->td_pflags & TDP_GEOM)
307                 g_waitidle();
308
309         /*
310          * Remove ourself from our leader's peer list and wake our leader.
311          */
312         mtx_lock(&ppeers_lock);
313         if (p->p_leader->p_peers) {
314                 q = p->p_leader;
315                 while (q->p_peers != p)
316                         q = q->p_peers;
317                 q->p_peers = p->p_peers;
318                 wakeup(p->p_leader);
319         }
320         mtx_unlock(&ppeers_lock);
321
322         vmspace_exit(td);
323
324         sx_xlock(&proctree_lock);
325         if (SESS_LEADER(p)) {
326                 struct session *sp = p->p_session;
327                 struct tty *tp;
328
329                 /*
330                  * s_ttyp is not zero'd; we use this to indicate that
331                  * the session once had a controlling terminal. (for
332                  * logging and informational purposes)
333                  */
334                 SESS_LOCK(sp);
335                 ttyvp = sp->s_ttyvp;
336                 tp = sp->s_ttyp;
337                 sp->s_ttyvp = NULL;
338                 sp->s_ttydp = NULL;
339                 sp->s_leader = NULL;
340                 SESS_UNLOCK(sp);
341
342                 /*
343                  * Signal foreground pgrp and revoke access to
344                  * controlling terminal if it has not been revoked
345                  * already.
346                  *
347                  * Because the TTY may have been revoked in the mean
348                  * time and could already have a new session associated
349                  * with it, make sure we don't send a SIGHUP to a
350                  * foreground process group that does not belong to this
351                  * session.
352                  */
353
354                 if (tp != NULL) {
355                         tty_lock(tp);
356                         if (tp->t_session == sp)
357                                 tty_signal_pgrp(tp, SIGHUP);
358                         tty_unlock(tp);
359                 }
360
361                 if (ttyvp != NULL) {
362                         sx_xunlock(&proctree_lock);
363                         if (vn_lock(ttyvp, LK_EXCLUSIVE) == 0) {
364                                 VOP_REVOKE(ttyvp, REVOKEALL);
365                                 VOP_UNLOCK(ttyvp, 0);
366                         }
367                         sx_xlock(&proctree_lock);
368                 }
369         }
370         fixjobc(p, p->p_pgrp, 0);
371         sx_xunlock(&proctree_lock);
372         (void)acct_process(td);
373
374         /* Release the TTY now we've unlocked everything. */
375         if (ttyvp != NULL)
376                 vrele(ttyvp);
377 #ifdef KTRACE
378         ktrprocexit(td);
379 #endif
380         /*
381          * Release reference to text vnode
382          */
383         if ((vtmp = p->p_textvp) != NULL) {
384                 p->p_textvp = NULL;
385                 vrele(vtmp);
386         }
387
388         /*
389          * Release our limits structure.
390          */
391         PROC_LOCK(p);
392         plim = p->p_limit;
393         p->p_limit = NULL;
394         PROC_UNLOCK(p);
395         lim_free(plim);
396
397         tidhash_remove(td);
398
399         /*
400          * Remove proc from allproc queue and pidhash chain.
401          * Place onto zombproc.  Unlink from parent's child list.
402          */
403         sx_xlock(&allproc_lock);
404         LIST_REMOVE(p, p_list);
405         LIST_INSERT_HEAD(&zombproc, p, p_list);
406         LIST_REMOVE(p, p_hash);
407         sx_xunlock(&allproc_lock);
408
409         /*
410          * Call machine-dependent code to release any
411          * machine-dependent resources other than the address space.
412          * The address space is released by "vmspace_exitfree(p)" in
413          * vm_waitproc().
414          */
415         cpu_exit(td);
416
417         WITNESS_WARN(WARN_PANIC, NULL, "process (pid %d) exiting", p->p_pid);
418
419         /*
420          * Reparent all of our children to init.
421          */
422         sx_xlock(&proctree_lock);
423         q = LIST_FIRST(&p->p_children);
424         if (q != NULL)          /* only need this if any child is S_ZOMB */
425                 wakeup(initproc);
426         for (; q != NULL; q = nq) {
427                 nq = LIST_NEXT(q, p_sibling);
428                 PROC_LOCK(q);
429                 proc_reparent(q, initproc);
430                 q->p_sigparent = SIGCHLD;
431                 /*
432                  * Traced processes are killed
433                  * since their existence means someone is screwing up.
434                  */
435                 if (q->p_flag & P_TRACED) {
436                         struct thread *temp;
437
438                         /*
439                          * Since q was found on our children list, the
440                          * proc_reparent() call moved q to the orphan
441                          * list due to present P_TRACED flag. Clear
442                          * orphan link for q now while q is locked.
443                          */
444                         clear_orphan(q);
445                         q->p_flag &= ~(P_TRACED | P_STOPPED_TRACE);
446                         FOREACH_THREAD_IN_PROC(q, temp)
447                                 temp->td_dbgflags &= ~TDB_SUSPEND;
448                         kern_psignal(q, SIGKILL);
449                 }
450                 PROC_UNLOCK(q);
451         }
452
453         /*
454          * Also get rid of our orphans.
455          */
456         while ((q = LIST_FIRST(&p->p_orphans)) != NULL) {
457                 PROC_LOCK(q);
458                 clear_orphan(q);
459                 PROC_UNLOCK(q);
460         }
461
462         /* Save exit status. */
463         PROC_LOCK(p);
464         p->p_xthread = td;
465
466         /* Tell the prison that we are gone. */
467         prison_proc_free(p->p_ucred->cr_prison);
468
469 #ifdef KDTRACE_HOOKS
470         /*
471          * Tell the DTrace fasttrap provider about the exit if it
472          * has declared an interest.
473          */
474         if (dtrace_fasttrap_exit)
475                 dtrace_fasttrap_exit(p);
476 #endif
477
478         /*
479          * Notify interested parties of our demise.
480          */
481         KNOTE_LOCKED(&p->p_klist, NOTE_EXIT);
482
483 #ifdef KDTRACE_HOOKS
484         int reason = CLD_EXITED;
485         if (WCOREDUMP(rv))
486                 reason = CLD_DUMPED;
487         else if (WIFSIGNALED(rv))
488                 reason = CLD_KILLED;
489         SDT_PROBE(proc, kernel, , exit, reason, 0, 0, 0, 0);
490 #endif
491
492         /*
493          * Just delete all entries in the p_klist. At this point we won't
494          * report any more events, and there are nasty race conditions that
495          * can beat us if we don't.
496          */
497         knlist_clear(&p->p_klist, 1);
498
499         /*
500          * If this is a process with a descriptor, we may not need to deliver
501          * a signal to the parent.  proctree_lock is held over
502          * procdesc_exit() to serialize concurrent calls to close() and
503          * exit().
504          */
505 #ifdef PROCDESC
506         if (p->p_procdesc == NULL || procdesc_exit(p)) {
507 #endif
508                 /*
509                  * Notify parent that we're gone.  If parent has the
510                  * PS_NOCLDWAIT flag set, or if the handler is set to SIG_IGN,
511                  * notify process 1 instead (and hope it will handle this
512                  * situation).
513                  */
514                 PROC_LOCK(p->p_pptr);
515                 mtx_lock(&p->p_pptr->p_sigacts->ps_mtx);
516                 if (p->p_pptr->p_sigacts->ps_flag &
517                     (PS_NOCLDWAIT | PS_CLDSIGIGN)) {
518                         struct proc *pp;
519
520                         mtx_unlock(&p->p_pptr->p_sigacts->ps_mtx);
521                         pp = p->p_pptr;
522                         PROC_UNLOCK(pp);
523                         proc_reparent(p, initproc);
524                         p->p_sigparent = SIGCHLD;
525                         PROC_LOCK(p->p_pptr);
526
527                         /*
528                          * Notify parent, so in case he was wait(2)ing or
529                          * executing waitpid(2) with our pid, he will
530                          * continue.
531                          */
532                         wakeup(pp);
533                 } else
534                         mtx_unlock(&p->p_pptr->p_sigacts->ps_mtx);
535
536                 if (p->p_pptr == initproc)
537                         kern_psignal(p->p_pptr, SIGCHLD);
538                 else if (p->p_sigparent != 0) {
539                         if (p->p_sigparent == SIGCHLD)
540                                 childproc_exited(p);
541                         else    /* LINUX thread */
542                                 kern_psignal(p->p_pptr, p->p_sigparent);
543                 }
544 #ifdef PROCDESC
545         } else
546                 PROC_LOCK(p->p_pptr);
547 #endif
548         sx_xunlock(&proctree_lock);
549
550         /*
551          * The state PRS_ZOMBIE prevents other proesses from sending
552          * signal to the process, to avoid memory leak, we free memory
553          * for signal queue at the time when the state is set.
554          */
555         sigqueue_flush(&p->p_sigqueue);
556         sigqueue_flush(&td->td_sigqueue);
557
558         /*
559          * We have to wait until after acquiring all locks before
560          * changing p_state.  We need to avoid all possible context
561          * switches (including ones from blocking on a mutex) while
562          * marked as a zombie.  We also have to set the zombie state
563          * before we release the parent process' proc lock to avoid
564          * a lost wakeup.  So, we first call wakeup, then we grab the
565          * sched lock, update the state, and release the parent process'
566          * proc lock.
567          */
568         wakeup(p->p_pptr);
569         cv_broadcast(&p->p_pwait);
570         sched_exit(p->p_pptr, td);
571         PROC_SLOCK(p);
572         p->p_state = PRS_ZOMBIE;
573         PROC_UNLOCK(p->p_pptr);
574
575         /*
576          * Hopefully no one will try to deliver a signal to the process this
577          * late in the game.
578          */
579         knlist_destroy(&p->p_klist);
580
581         /*
582          * Save our children's rusage information in our exit rusage.
583          */
584         ruadd(&p->p_ru, &p->p_rux, &p->p_stats->p_cru, &p->p_crux);
585
586         /*
587          * Make sure the scheduler takes this thread out of its tables etc.
588          * This will also release this thread's reference to the ucred.
589          * Other thread parts to release include pcb bits and such.
590          */
591         thread_exit();
592 }
593
594
595 #ifndef _SYS_SYSPROTO_H_
596 struct abort2_args {
597         char *why;
598         int nargs;
599         void **args;
600 };
601 #endif
602
603 int
604 sys_abort2(struct thread *td, struct abort2_args *uap)
605 {
606         struct proc *p = td->td_proc;
607         struct sbuf *sb;
608         void *uargs[16];
609         int error, i, sig;
610
611         /*
612          * Do it right now so we can log either proper call of abort2(), or
613          * note, that invalid argument was passed. 512 is big enough to
614          * handle 16 arguments' descriptions with additional comments.
615          */
616         sb = sbuf_new(NULL, NULL, 512, SBUF_FIXEDLEN);
617         sbuf_clear(sb);
618         sbuf_printf(sb, "%s(pid %d uid %d) aborted: ",
619             p->p_comm, p->p_pid, td->td_ucred->cr_uid);
620         /*
621          * Since we can't return from abort2(), send SIGKILL in cases, where
622          * abort2() was called improperly
623          */
624         sig = SIGKILL;
625         /* Prevent from DoSes from user-space. */
626         if (uap->nargs < 0 || uap->nargs > 16)
627                 goto out;
628         if (uap->nargs > 0) {
629                 if (uap->args == NULL)
630                         goto out;
631                 error = copyin(uap->args, uargs, uap->nargs * sizeof(void *));
632                 if (error != 0)
633                         goto out;
634         }
635         /*
636          * Limit size of 'reason' string to 128. Will fit even when
637          * maximal number of arguments was chosen to be logged.
638          */
639         if (uap->why != NULL) {
640                 error = sbuf_copyin(sb, uap->why, 128);
641                 if (error < 0)
642                         goto out;
643         } else {
644                 sbuf_printf(sb, "(null)");
645         }
646         if (uap->nargs > 0) {
647                 sbuf_printf(sb, "(");
648                 for (i = 0;i < uap->nargs; i++)
649                         sbuf_printf(sb, "%s%p", i == 0 ? "" : ", ", uargs[i]);
650                 sbuf_printf(sb, ")");
651         }
652         /*
653          * Final stage: arguments were proper, string has been
654          * successfully copied from userspace, and copying pointers
655          * from user-space succeed.
656          */
657         sig = SIGABRT;
658 out:
659         if (sig == SIGKILL) {
660                 sbuf_trim(sb);
661                 sbuf_printf(sb, " (Reason text inaccessible)");
662         }
663         sbuf_cat(sb, "\n");
664         sbuf_finish(sb);
665         log(LOG_INFO, "%s", sbuf_data(sb));
666         sbuf_delete(sb);
667         exit1(td, W_EXITCODE(0, sig));
668         return (0);
669 }
670
671
672 #ifdef COMPAT_43
673 /*
674  * The dirty work is handled by kern_wait().
675  */
676 int
677 owait(struct thread *td, struct owait_args *uap __unused)
678 {
679         int error, status;
680
681         error = kern_wait(td, WAIT_ANY, &status, 0, NULL);
682         if (error == 0)
683                 td->td_retval[1] = status;
684         return (error);
685 }
686 #endif /* COMPAT_43 */
687
688 /*
689  * The dirty work is handled by kern_wait().
690  */
691 int
692 sys_wait4(struct thread *td, struct wait4_args *uap)
693 {
694         struct rusage ru, *rup;
695         int error, status;
696
697         if (uap->rusage != NULL)
698                 rup = &ru;
699         else
700                 rup = NULL;
701         error = kern_wait(td, uap->pid, &status, uap->options, rup);
702         if (uap->status != NULL && error == 0)
703                 error = copyout(&status, uap->status, sizeof(status));
704         if (uap->rusage != NULL && error == 0)
705                 error = copyout(&ru, uap->rusage, sizeof(struct rusage));
706         return (error);
707 }
708
709 int
710 sys_wait6(struct thread *td, struct wait6_args *uap)
711 {
712         struct __wrusage wru, *wrup;
713         siginfo_t si, *sip;
714         idtype_t idtype;
715         id_t id;
716         int error, status;
717
718         idtype = uap->idtype;
719         id = uap->id;
720
721         if (uap->wrusage != NULL)
722                 wrup = &wru;
723         else
724                 wrup = NULL;
725
726         if (uap->info != NULL) {
727                 sip = &si;
728                 bzero(sip, sizeof(*sip));
729         } else
730                 sip = NULL;
731
732         /*
733          *  We expect all callers of wait6() to know about WEXITED and
734          *  WTRAPPED.
735          */
736         error = kern_wait6(td, idtype, id, &status, uap->options, wrup, sip);
737
738         if (uap->status != NULL && error == 0)
739                 error = copyout(&status, uap->status, sizeof(status));
740         if (uap->wrusage != NULL && error == 0)
741                 error = copyout(&wru, uap->wrusage, sizeof(wru));
742         if (uap->info != NULL && error == 0)
743                 error = copyout(&si, uap->info, sizeof(si));
744         return (error);
745 }
746
747 /*
748  * Reap the remains of a zombie process and optionally return status and
749  * rusage.  Asserts and will release both the proctree_lock and the process
750  * lock as part of its work.
751  */
752 void
753 proc_reap(struct thread *td, struct proc *p, int *status, int options)
754 {
755         struct proc *q, *t;
756
757         sx_assert(&proctree_lock, SA_XLOCKED);
758         PROC_LOCK_ASSERT(p, MA_OWNED);
759         PROC_SLOCK_ASSERT(p, MA_OWNED);
760         KASSERT(p->p_state == PRS_ZOMBIE, ("proc_reap: !PRS_ZOMBIE"));
761
762         q = td->td_proc;
763
764         PROC_SUNLOCK(p);
765         td->td_retval[0] = p->p_pid;
766         if (status)
767                 *status = p->p_xstat;   /* convert to int */
768         if (options & WNOWAIT) {
769                 /*
770                  *  Only poll, returning the status.  Caller does not wish to
771                  * release the proc struct just yet.
772                  */
773                 PROC_UNLOCK(p);
774                 sx_xunlock(&proctree_lock);
775                 return;
776         }
777
778         PROC_LOCK(q);
779         sigqueue_take(p->p_ksi);
780         PROC_UNLOCK(q);
781         PROC_UNLOCK(p);
782
783         /*
784          * If we got the child via a ptrace 'attach', we need to give it back
785          * to the old parent.
786          */
787         if (p->p_oppid && (t = pfind(p->p_oppid)) != NULL) {
788                 PROC_LOCK(p);
789                 proc_reparent(p, t);
790                 p->p_oppid = 0;
791                 PROC_UNLOCK(p);
792                 pksignal(t, SIGCHLD, p->p_ksi);
793                 wakeup(t);
794                 cv_broadcast(&p->p_pwait);
795                 PROC_UNLOCK(t);
796                 sx_xunlock(&proctree_lock);
797                 return;
798         }
799
800         /*
801          * Remove other references to this process to ensure we have an
802          * exclusive reference.
803          */
804         sx_xlock(&allproc_lock);
805         LIST_REMOVE(p, p_list); /* off zombproc */
806         sx_xunlock(&allproc_lock);
807         LIST_REMOVE(p, p_sibling);
808         PROC_LOCK(p);
809         clear_orphan(p);
810         PROC_UNLOCK(p);
811         leavepgrp(p);
812 #ifdef PROCDESC
813         if (p->p_procdesc != NULL)
814                 procdesc_reap(p);
815 #endif
816         sx_xunlock(&proctree_lock);
817
818         /*
819          * As a side effect of this lock, we know that all other writes to
820          * this proc are visible now, so no more locking is needed for p.
821          */
822         PROC_LOCK(p);
823         p->p_xstat = 0;         /* XXX: why? */
824         PROC_UNLOCK(p);
825         PROC_LOCK(q);
826         ruadd(&q->p_stats->p_cru, &q->p_crux, &p->p_ru, &p->p_rux);
827         PROC_UNLOCK(q);
828
829         /*
830          * Decrement the count of procs running with this uid.
831          */
832         (void)chgproccnt(p->p_ucred->cr_ruidinfo, -1, 0);
833
834         /*
835          * Destroy resource accounting information associated with the process.
836          */
837 #ifdef RACCT
838         PROC_LOCK(p);
839         racct_sub(p, RACCT_NPROC, 1);
840         PROC_UNLOCK(p);
841 #endif
842         racct_proc_exit(p);
843
844         /*
845          * Free credentials, arguments, and sigacts.
846          */
847         crfree(p->p_ucred);
848         p->p_ucred = NULL;
849         pargs_drop(p->p_args);
850         p->p_args = NULL;
851         sigacts_free(p->p_sigacts);
852         p->p_sigacts = NULL;
853
854         /*
855          * Do any thread-system specific cleanups.
856          */
857         thread_wait(p);
858
859         /*
860          * Give vm and machine-dependent layer a chance to free anything that
861          * cpu_exit couldn't release while still running in process context.
862          */
863         vm_waitproc(p);
864 #ifdef MAC
865         mac_proc_destroy(p);
866 #endif
867         KASSERT(FIRST_THREAD_IN_PROC(p),
868             ("proc_reap: no residual thread!"));
869         uma_zfree(proc_zone, p);
870         sx_xlock(&allproc_lock);
871         nprocs--;
872         sx_xunlock(&allproc_lock);
873 }
874
875 static int
876 proc_to_reap(struct thread *td, struct proc *p, idtype_t idtype, id_t id,
877     int *status, int options, struct __wrusage *wrusage, siginfo_t *siginfo)
878 {
879         struct proc *q;
880         struct rusage *rup;
881
882         sx_assert(&proctree_lock, SA_XLOCKED);
883
884         q = td->td_proc;
885         PROC_LOCK(p);
886
887         switch (idtype) {
888         case P_ALL:
889                 break;
890         case P_PID:
891                 if (p->p_pid != (pid_t)id) {
892                         PROC_UNLOCK(p);
893                         return (0);
894                 }
895                 break;
896         case P_PGID:
897                 if (p->p_pgid != (pid_t)id) {
898                         PROC_UNLOCK(p);
899                         return (0);
900                 }
901                 break;
902         case P_SID:
903                 if (p->p_session->s_sid != (pid_t)id) {
904                         PROC_UNLOCK(p);
905                         return (0);
906                 }
907                 break;
908         case P_UID:
909                 if (p->p_ucred->cr_uid != (uid_t)id) {
910                         PROC_UNLOCK(p);
911                         return (0);
912                 }
913                 break;
914         case P_GID:
915                 if (p->p_ucred->cr_gid != (gid_t)id) {
916                         PROC_UNLOCK(p);
917                         return (0);
918                 }
919                 break;
920         case P_JAILID:
921                 if (p->p_ucred->cr_prison == NULL ||
922                     (p->p_ucred->cr_prison->pr_id != (int)id)) {
923                         PROC_UNLOCK(p);
924                         return (0);
925                 }
926                 break;
927         /*
928          * It seems that the thread structures get zeroed out
929          * at process exit.  This makes it impossible to
930          * support P_SETID, P_CID or P_CPUID.
931          */
932         default:
933                 PROC_UNLOCK(p);
934                 return (0);
935         }
936
937         if (p_canwait(td, p)) {
938                 PROC_UNLOCK(p);
939                 return (0);
940         }
941
942         if (((options & WEXITED) == 0) && (p->p_state == PRS_ZOMBIE)) {
943                 PROC_UNLOCK(p);
944                 return (0);
945         }
946
947         /*
948          * This special case handles a kthread spawned by linux_clone
949          * (see linux_misc.c).  The linux_wait4 and linux_waitpid
950          * functions need to be able to distinguish between waiting
951          * on a process and waiting on a thread.  It is a thread if
952          * p_sigparent is not SIGCHLD, and the WLINUXCLONE option
953          * signifies we want to wait for threads and not processes.
954          */
955         if ((p->p_sigparent != SIGCHLD) ^
956             ((options & WLINUXCLONE) != 0)) {
957                 PROC_UNLOCK(p);
958                 return (0);
959         }
960
961         PROC_SLOCK(p);
962
963         if (siginfo != NULL) {
964                 bzero(siginfo, sizeof(*siginfo));
965                 siginfo->si_errno = 0;
966
967                 /*
968                  * SUSv4 requires that the si_signo value is always
969                  * SIGCHLD. Obey it despite the rfork(2) interface
970                  * allows to request other signal for child exit
971                  * notification.
972                  */
973                 siginfo->si_signo = SIGCHLD;
974
975                 /*
976                  *  This is still a rough estimate.  We will fix the
977                  *  cases TRAPPED, STOPPED, and CONTINUED later.
978                  */
979                 if (WCOREDUMP(p->p_xstat))
980                         siginfo->si_code = CLD_DUMPED;
981                 else if (WIFSIGNALED(p->p_xstat))
982                         siginfo->si_code = CLD_KILLED;
983                 else
984                         siginfo->si_code = CLD_EXITED;
985
986                 siginfo->si_pid = p->p_pid;
987                 siginfo->si_uid = p->p_ucred->cr_uid;
988                 siginfo->si_status = p->p_xstat;
989
990                 /*
991                  * The si_addr field would be useful additional
992                  * detail, but apparently the PC value may be lost
993                  * when we reach this point.  bzero() above sets
994                  * siginfo->si_addr to NULL.
995                  */
996         }
997
998         /*
999          * There should be no reason to limit resources usage info to
1000          * exited processes only.  A snapshot about any resources used
1001          * by a stopped process may be exactly what is needed.
1002          */
1003         if (wrusage != NULL) {
1004                 rup = &wrusage->wru_self;
1005                 *rup = p->p_ru;
1006                 calcru(p, &rup->ru_utime, &rup->ru_stime);
1007
1008                 rup = &wrusage->wru_children;
1009                 *rup = p->p_stats->p_cru;
1010                 calccru(p, &rup->ru_utime, &rup->ru_stime);
1011         }
1012
1013         if (p->p_state == PRS_ZOMBIE) {
1014                 proc_reap(td, p, status, options);
1015                 return (-1);
1016         }
1017         PROC_SUNLOCK(p);
1018         PROC_UNLOCK(p);
1019         return (1);
1020 }
1021
1022 int
1023 kern_wait(struct thread *td, pid_t pid, int *status, int options,
1024     struct rusage *rusage)
1025 {
1026         struct __wrusage wru, *wrup;
1027         idtype_t idtype;
1028         id_t id;
1029         int ret;
1030
1031         /*
1032          * Translate the special pid values into the (idtype, pid)
1033          * pair for kern_wait6.  The WAIT_MYPGRP case is handled by
1034          * kern_wait6() on its own.
1035          */
1036         if (pid == WAIT_ANY) {
1037                 idtype = P_ALL;
1038                 id = 0;
1039         } else if (pid < 0) {
1040                 idtype = P_PGID;
1041                 id = (id_t)-pid;
1042         } else {
1043                 idtype = P_PID;
1044                 id = (id_t)pid;
1045         }
1046
1047         if (rusage != NULL)
1048                 wrup = &wru;
1049         else
1050                 wrup = NULL;
1051
1052         /*
1053          * For backward compatibility we implicitly add flags WEXITED
1054          * and WTRAPPED here.
1055          */
1056         options |= WEXITED | WTRAPPED;
1057         ret = kern_wait6(td, idtype, id, status, options, wrup, NULL);
1058         if (rusage != NULL)
1059                 *rusage = wru.wru_self;
1060         return (ret);
1061 }
1062
1063 int
1064 kern_wait6(struct thread *td, idtype_t idtype, id_t id, int *status,
1065     int options, struct __wrusage *wrusage, siginfo_t *siginfo)
1066 {
1067         struct proc *p, *q;
1068         int error, nfound, ret;
1069
1070         AUDIT_ARG_VALUE((int)idtype);   /* XXX - This is likely wrong! */
1071         AUDIT_ARG_PID((pid_t)id);       /* XXX - This may be wrong! */
1072         AUDIT_ARG_VALUE(options);
1073
1074         q = td->td_proc;
1075
1076         if ((pid_t)id == WAIT_MYPGRP && (idtype == P_PID || idtype == P_PGID)) {
1077                 PROC_LOCK(q);
1078                 id = (id_t)q->p_pgid;
1079                 PROC_UNLOCK(q);
1080                 idtype = P_PGID;
1081         }
1082
1083         /* If we don't know the option, just return. */
1084         if ((options & ~(WUNTRACED | WNOHANG | WCONTINUED | WNOWAIT |
1085             WEXITED | WTRAPPED | WLINUXCLONE)) != 0)
1086                 return (EINVAL);
1087         if ((options & (WEXITED | WUNTRACED | WCONTINUED | WTRAPPED)) == 0) {
1088                 /*
1089                  * We will be unable to find any matching processes,
1090                  * because there are no known events to look for.
1091                  * Prefer to return error instead of blocking
1092                  * indefinitely.
1093                  */
1094                 return (EINVAL);
1095         }
1096
1097 loop:
1098         if (q->p_flag & P_STATCHILD) {
1099                 PROC_LOCK(q);
1100                 q->p_flag &= ~P_STATCHILD;
1101                 PROC_UNLOCK(q);
1102         }
1103         nfound = 0;
1104         sx_xlock(&proctree_lock);
1105         LIST_FOREACH(p, &q->p_children, p_sibling) {
1106                 ret = proc_to_reap(td, p, idtype, id, status, options,
1107                     wrusage, siginfo);
1108                 if (ret == 0)
1109                         continue;
1110                 else if (ret == 1)
1111                         nfound++;
1112                 else
1113                         return (0);
1114
1115                 PROC_LOCK(p);
1116                 PROC_SLOCK(p);
1117
1118                 if ((options & WTRAPPED) != 0 &&
1119                     (p->p_flag & P_TRACED) != 0 &&
1120                     (p->p_flag & (P_STOPPED_TRACE | P_STOPPED_SIG)) != 0 &&
1121                     (p->p_suspcount == p->p_numthreads) &&
1122                     ((p->p_flag & P_WAITED) == 0)) {
1123                         PROC_SUNLOCK(p);
1124                         if ((options & WNOWAIT) == 0)
1125                                 p->p_flag |= P_WAITED;
1126                         sx_xunlock(&proctree_lock);
1127                         td->td_retval[0] = p->p_pid;
1128
1129                         if (status != NULL)
1130                                 *status = W_STOPCODE(p->p_xstat);
1131                         if (siginfo != NULL) {
1132                                 siginfo->si_status = p->p_xstat;
1133                                 siginfo->si_code = CLD_TRAPPED;
1134                         }
1135                         if ((options & WNOWAIT) == 0) {
1136                                 PROC_LOCK(q);
1137                                 sigqueue_take(p->p_ksi);
1138                                 PROC_UNLOCK(q);
1139                         }
1140
1141                         PROC_UNLOCK(p);
1142                         return (0);
1143                 }
1144                 if ((options & WUNTRACED) != 0 &&
1145                     (p->p_flag & P_STOPPED_SIG) != 0 &&
1146                     (p->p_suspcount == p->p_numthreads) &&
1147                     ((p->p_flag & P_WAITED) == 0)) {
1148                         PROC_SUNLOCK(p);
1149                         if ((options & WNOWAIT) == 0)
1150                                 p->p_flag |= P_WAITED;
1151                         sx_xunlock(&proctree_lock);
1152                         td->td_retval[0] = p->p_pid;
1153
1154                         if (status != NULL)
1155                                 *status = W_STOPCODE(p->p_xstat);
1156                         if (siginfo != NULL) {
1157                                 siginfo->si_status = p->p_xstat;
1158                                 siginfo->si_code = CLD_STOPPED;
1159                         }
1160                         if ((options & WNOWAIT) == 0) {
1161                                 PROC_LOCK(q);
1162                                 sigqueue_take(p->p_ksi);
1163                                 PROC_UNLOCK(q);
1164                         }
1165
1166                         PROC_UNLOCK(p);
1167                         return (0);
1168                 }
1169                 PROC_SUNLOCK(p);
1170                 if ((options & WCONTINUED) != 0 &&
1171                     (p->p_flag & P_CONTINUED) != 0) {
1172                         sx_xunlock(&proctree_lock);
1173                         td->td_retval[0] = p->p_pid;
1174                         if ((options & WNOWAIT) == 0) {
1175                                 p->p_flag &= ~P_CONTINUED;
1176                                 PROC_LOCK(q);
1177                                 sigqueue_take(p->p_ksi);
1178                                 PROC_UNLOCK(q);
1179                         }
1180                         PROC_UNLOCK(p);
1181
1182                         if (status != NULL)
1183                                 *status = SIGCONT;
1184                         if (siginfo != NULL) {
1185                                 siginfo->si_status = SIGCONT;
1186                                 siginfo->si_code = CLD_CONTINUED;
1187                         }
1188                         return (0);
1189                 }
1190                 PROC_UNLOCK(p);
1191         }
1192
1193         /*
1194          * Look in the orphans list too, to allow the parent to
1195          * collect it's child exit status even if child is being
1196          * debugged.
1197          *
1198          * Debugger detaches from the parent upon successful
1199          * switch-over from parent to child.  At this point due to
1200          * re-parenting the parent loses the child to debugger and a
1201          * wait4(2) call would report that it has no children to wait
1202          * for.  By maintaining a list of orphans we allow the parent
1203          * to successfully wait until the child becomes a zombie.
1204          */
1205         LIST_FOREACH(p, &q->p_orphans, p_orphan) {
1206                 ret = proc_to_reap(td, p, idtype, id, status, options,
1207                     wrusage, siginfo);
1208                 if (ret == 0)
1209                         continue;
1210                 else if (ret == 1)
1211                         nfound++;
1212                 else
1213                         return (0);
1214         }
1215         if (nfound == 0) {
1216                 sx_xunlock(&proctree_lock);
1217                 return (ECHILD);
1218         }
1219         if (options & WNOHANG) {
1220                 sx_xunlock(&proctree_lock);
1221                 td->td_retval[0] = 0;
1222                 return (0);
1223         }
1224         PROC_LOCK(q);
1225         sx_xunlock(&proctree_lock);
1226         if (q->p_flag & P_STATCHILD) {
1227                 q->p_flag &= ~P_STATCHILD;
1228                 error = 0;
1229         } else
1230                 error = msleep(q, &q->p_mtx, PWAIT | PCATCH, "wait", 0);
1231         PROC_UNLOCK(q);
1232         if (error)
1233                 return (error);
1234         goto loop;
1235 }
1236
1237 /*
1238  * Make process 'parent' the new parent of process 'child'.
1239  * Must be called with an exclusive hold of proctree lock.
1240  */
1241 void
1242 proc_reparent(struct proc *child, struct proc *parent)
1243 {
1244
1245         sx_assert(&proctree_lock, SX_XLOCKED);
1246         PROC_LOCK_ASSERT(child, MA_OWNED);
1247         if (child->p_pptr == parent)
1248                 return;
1249
1250         PROC_LOCK(child->p_pptr);
1251         sigqueue_take(child->p_ksi);
1252         PROC_UNLOCK(child->p_pptr);
1253         LIST_REMOVE(child, p_sibling);
1254         LIST_INSERT_HEAD(&parent->p_children, child, p_sibling);
1255
1256         clear_orphan(child);
1257         if (child->p_flag & P_TRACED) {
1258                 LIST_INSERT_HEAD(&child->p_pptr->p_orphans, child, p_orphan);
1259                 child->p_flag |= P_ORPHAN;
1260         }
1261
1262         child->p_pptr = parent;
1263 }