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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)kern_exit.c 8.7 (Berkeley) 2/12/94
  39  * $FreeBSD: src/sys/kern/kern_exit.c,v 1.92.2.11 2003/01/13 22:51:16 dillon Exp $
  40  * $DragonFly: src/sys/kern/kern_exit.c,v 1.91 2008/05/18 20:02:02 nth Exp $
  41  */
  42
  43 #include "opt_compat.h"
  44 #include "opt_ktrace.h"
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/sysproto.h>
  49 #include <sys/kernel.h>
  50 #include <sys/malloc.h>
  51 #include <sys/proc.h>
  52 #include <sys/ktrace.h>
  53 #include <sys/pioctl.h>
  54 #include <sys/tty.h>
  55 #include <sys/wait.h>
  56 #include <sys/vnode.h>
  57 #include <sys/resourcevar.h>
  58 #include <sys/signalvar.h>
  59 #include <sys/taskqueue.h>
  60 #include <sys/ptrace.h>
  61 #include <sys/acct.h>           /* for acct_process() function prototype */
  62 #include <sys/filedesc.h>
  63 #include <sys/shm.h>
  64 #include <sys/sem.h>
  65 #include <sys/aio.h>
  66 #include <sys/jail.h>
  67 #include <sys/kern_syscall.h>
  68 #include <sys/upcall.h>
  69 #include <sys/caps.h>
  70 #include <sys/unistd.h>
  71 #include <sys/eventhandler.h>
  72 #include <sys/dsched.h>
  73
  74 #include <vm/vm.h>
  75 #include <vm/vm_param.h>
  76 #include <sys/lock.h>
  77 #include <vm/pmap.h>
  78 #include <vm/vm_map.h>
  79 #include <vm/vm_extern.h>
  80 #include <sys/user.h>
  81
  82 #include <sys/refcount.h>
  83 #include <sys/thread2.h>
  84 #include <sys/sysref2.h>
  85 #include <sys/mplock2.h>
  86
  87 static void reaplwps(void *context, int dummy);
  88 static void reaplwp(struct lwp *lp);
  89 static void killlwps(struct lwp *lp);
  90
  91 static MALLOC_DEFINE(M_ATEXIT, "atexit", "atexit callback");
  92 static MALLOC_DEFINE(M_ZOMBIE, "zombie", "zombie proc status");
  93
  94 static struct lwkt_token deadlwp_token = LWKT_TOKEN_INITIALIZER(deadlwp_token);
  95
  96 /*
  97  * callout list for things to do at exit time
  98  */
  99 struct exitlist {
 100         exitlist_fn function;
 101         TAILQ_ENTRY(exitlist) next;
 102 };
 103
 104 TAILQ_HEAD(exit_list_head, exitlist);
 105 static struct exit_list_head exit_list = TAILQ_HEAD_INITIALIZER(exit_list);
 106
 107 /*
 108  * LWP reaper data
 109  */
 110 struct task *deadlwp_task[MAXCPU];
 111 struct lwplist deadlwp_list[MAXCPU];
 112
 113 /*
 114  * exit --
 115  *      Death of process.
 116  *
 117  * SYS_EXIT_ARGS(int rval)
 118  */
 119 int
 120 sys_exit(struct exit_args *uap)
 121 {
 122         exit1(W_EXITCODE(uap->rval, 0));
 123         /* NOTREACHED */
 124 }
 125
 126 /*
 127  * Extended exit --
 128  *      Death of a lwp or process with optional bells and whistles.
 129  *
 130  * MPALMOSTSAFE
 131  */
 132 int
 133 sys_extexit(struct extexit_args *uap)
 134 {
 135         struct proc *p = curproc;
 136         int action, who;
 137         int error;
 138
 139         action = EXTEXIT_ACTION(uap->how);
 140         who = EXTEXIT_WHO(uap->how);
 141
 142         /* Check parameters before we might perform some action */
 143         switch (who) {
 144         case EXTEXIT_PROC:
 145         case EXTEXIT_LWP:
 146                 break;
 147         default:
 148                 return (EINVAL);
 149         }
 150
 151         switch (action) {
 152         case EXTEXIT_SIMPLE:
 153                 break;
 154         case EXTEXIT_SETINT:
 155                 error = copyout(&uap->status, uap->addr, sizeof(uap->status));
 156                 if (error)
 157                         return (error);
 158                 break;
 159         default:
 160                 return (EINVAL);
 161         }
 162
 163         lwkt_gettoken(&p->p_token);
 164
 165         switch (who) {
 166         case EXTEXIT_LWP:
 167                 /*
 168                  * Be sure only to perform a simple lwp exit if there is at
 169                  * least one more lwp in the proc, which will call exit1()
 170                  * later, otherwise the proc will be an UNDEAD and not even a
 171                  * SZOMB!
 172                  */
 173                 if (p->p_nthreads > 1) {
 174                         lwp_exit(0);    /* called w/ p_token held */
 175                         /* NOT REACHED */
 176                 }
 177                 /* else last lwp in proc:  do the real thing */
 178                 /* FALLTHROUGH */
 179         default:        /* to help gcc */
 180         case EXTEXIT_PROC:
 181                 lwkt_reltoken(&p->p_token);
 182                 exit1(W_EXITCODE(uap->status, 0));
 183                 /* NOTREACHED */
 184         }
 185
 186         /* NOTREACHED */
 187         lwkt_reltoken(&p->p_token);     /* safety */
 188 }
 189
 190 /*
 191  * Kill all lwps associated with the current process except the
 192  * current lwp.   Return an error if we race another thread trying to
 193  * do the same thing and lose the race.
 194  *
 195  * If forexec is non-zero the current thread and process flags are
 196  * cleaned up so they can be reused.
 197  */
 198 int
 199 killalllwps(int forexec)
 200 {
 201         struct lwp *lp = curthread->td_lwp;
 202         struct proc *p = lp->lwp_proc;
 203
 204         /*
 205          * Interlock against P_WEXIT.  Only one of the process's thread
 206          * is allowed to do the master exit.
 207          */
 208         if (p->p_flag & P_WEXIT)
 209                 return (EALREADY);
 210         p->p_flag |= P_WEXIT;
 211
 212         /*
 213          * Interlock with LWP_WEXIT and kill any remaining LWPs
 214          */
 215         lp->lwp_flag |= LWP_WEXIT;
 216         if (p->p_nthreads > 1)
 217                 killlwps(lp);
 218
 219         /*
 220          * If doing this for an exec, clean up the remaining thread
 221          * (us) for continuing operation after all the other threads
 222          * have been killed.
 223          */
 224         if (forexec) {
 225                 lp->lwp_flag &= ~LWP_WEXIT;
 226                 p->p_flag &= ~P_WEXIT;
 227         }
 228         return(0);
 229 }
 230
 231 /*
 232  * Kill all LWPs except the current one.  Do not try to signal
 233  * LWPs which have exited on their own or have already been
 234  * signaled.
 235  */
 236 static void
 237 killlwps(struct lwp *lp)
 238 {
 239         struct proc *p = lp->lwp_proc;
 240         struct lwp *tlp;
 241
 242         /*
 243          * Kill the remaining LWPs.  We must send the signal before setting
 244          * LWP_WEXIT.  The setting of WEXIT is optional but helps reduce
 245          * races.  tlp must be held across the call as it might block and
 246          * allow the target lwp to rip itself out from under our loop.
 247          */
 248         FOREACH_LWP_IN_PROC(tlp, p) {
 249                 LWPHOLD(tlp);
 250                 if ((tlp->lwp_flag & LWP_WEXIT) == 0) {
 251                         lwpsignal(p, tlp, SIGKILL);
 252                         tlp->lwp_flag |= LWP_WEXIT;
 253                 }
 254                 LWPRELE(tlp);
 255         }
 256
 257         /*
 258          * Wait for everything to clear out.
 259          */
 260         while (p->p_nthreads > 1) {
 261                 tsleep(&p->p_nthreads, 0, "killlwps", 0);
 262         }
 263 }
 264
 265 /*
 266  * Exit: deallocate address space and other resources, change proc state
 267  * to zombie, and unlink proc from allproc and parent's lists.  Save exit
 268  * status and rusage for wait().  Check for child processes and orphan them.
 269  */
 270 void
 271 exit1(int rv)
 272 {
 273         struct thread *td = curthread;
 274         struct proc *p = td->td_proc;
 275         struct lwp *lp = td->td_lwp;
 276         struct proc *q, *nq;
 277         struct vmspace *vm;
 278         struct vnode *vtmp;
 279         struct exitlist *ep;
 280         int error;
 281
 282         lwkt_gettoken(&p->p_token);
 283
 284         if (p->p_pid == 1) {
 285                 kprintf("init died (signal %d, exit %d)\n",
 286                     WTERMSIG(rv), WEXITSTATUS(rv));
 287                 panic("Going nowhere without my init!");
 288         }
 289         varsymset_clean(&p->p_varsymset);
 290         lockuninit(&p->p_varsymset.vx_lock);
 291         /*
 292          * Kill all lwps associated with the current process, return an
 293          * error if we race another thread trying to do the same thing
 294          * and lose the race.
 295          */
 296         error = killalllwps(0);
 297         if (error) {
 298                 lwp_exit(0);
 299                 /* NOT REACHED */
 300         }
 301
 302         caps_exit(lp->lwp_thread);
 303
 304         /* are we a task leader? */
 305         if (p == p->p_leader) {
 306                 struct kill_args killArgs;
 307                 killArgs.signum = SIGKILL;
 308                 q = p->p_peers;
 309                 while(q) {
 310                         killArgs.pid = q->p_pid;
 311                         /*
 312                          * The interface for kill is better
 313                          * than the internal signal
 314                          */
 315                         sys_kill(&killArgs);
 316                         nq = q;
 317                         q = q->p_peers;
 318                 }
 319                 while (p->p_peers)
 320                         tsleep((caddr_t)p, 0, "exit1", 0);
 321         }
 322
 323 #ifdef PGINPROF
 324         vmsizmon();
 325 #endif
 326         STOPEVENT(p, S_EXIT, rv);
 327         wakeup(&p->p_stype);    /* Wakeup anyone in procfs' PIOCWAIT */
 328
 329         /*
 330          * Check if any loadable modules need anything done at process exit.
 331          * e.g. SYSV IPC stuff
 332          * XXX what if one of these generates an error?
 333          */
 334         p->p_xstat = rv;
 335         EVENTHANDLER_INVOKE(process_exit, p);
 336
 337         /*
 338          * XXX: imho, the eventhandler stuff is much cleaner than this.
 339          *      Maybe we should move everything to use eventhandler.
 340          */
 341         TAILQ_FOREACH(ep, &exit_list, next)
 342                 (*ep->function)(td);
 343
 344         if (p->p_flag & P_PROFIL)
 345                 stopprofclock(p);
 346         /*
 347          * If parent is waiting for us to exit or exec,
 348          * P_PPWAIT is set; we will wakeup the parent below.
 349          */
 350         p->p_flag &= ~(P_TRACED | P_PPWAIT);
 351         SIGEMPTYSET(p->p_siglist);
 352         SIGEMPTYSET(lp->lwp_siglist);
 353         if (timevalisset(&p->p_realtimer.it_value))
 354                 callout_stop(&p->p_ithandle);
 355
 356         /*
 357          * Reset any sigio structures pointing to us as a result of
 358          * F_SETOWN with our pid.
 359          */
 360         funsetownlst(&p->p_sigiolst);
 361
 362         /*
 363          * Close open files and release open-file table.
 364          * This may block!
 365          */
 366         fdfree(p, NULL);
 367
 368         if(p->p_leader->p_peers) {
 369                 q = p->p_leader;
 370                 while(q->p_peers != p)
 371                         q = q->p_peers;
 372                 q->p_peers = p->p_peers;
 373                 wakeup((caddr_t)p->p_leader);
 374         }
 375
 376         /*
 377          * XXX Shutdown SYSV semaphores
 378          */
 379         semexit(p);
 380
 381         KKASSERT(p->p_numposixlocks == 0);
 382
 383         /* The next two chunks should probably be moved to vmspace_exit. */
 384         vm = p->p_vmspace;
 385
 386         /*
 387          * Release upcalls associated with this process
 388          */
 389         if (vm->vm_upcalls)
 390                 upc_release(vm, lp);
 391
 392         /*
 393          * Clean up data related to virtual kernel operation.  Clean up
 394          * any vkernel context related to the current lwp now so we can
 395          * destroy p_vkernel.
 396          */
 397         if (p->p_vkernel) {
 398                 vkernel_lwp_exit(lp);
 399                 vkernel_exit(p);
 400         }
 401
 402         /*
 403          * Release user portion of address space.
 404          * This releases references to vnodes,
 405          * which could cause I/O if the file has been unlinked.
 406          * Need to do this early enough that we can still sleep.
 407          * Can't free the entire vmspace as the kernel stack
 408          * may be mapped within that space also.
 409          *
 410          * Processes sharing the same vmspace may exit in one order, and
 411          * get cleaned up by vmspace_exit() in a different order.  The
 412          * last exiting process to reach this point releases as much of
 413          * the environment as it can, and the last process cleaned up
 414          * by vmspace_exit() (which decrements exitingcnt) cleans up the
 415          * remainder.
 416          */
 417         vmspace_exitbump(vm);
 418         sysref_put(&vm->vm_sysref);
 419
 420         if (SESS_LEADER(p)) {
 421                 struct session *sp = p->p_session;
 422
 423                 if (sp->s_ttyvp) {
 424                         /*
 425                          * We are the controlling process.  Signal the
 426                          * foreground process group, drain the controlling
 427                          * terminal, and revoke access to the controlling
 428                          * terminal.
 429                          *
 430                          * NOTE: while waiting for the process group to exit
 431                          * it is possible that one of the processes in the
 432                          * group will revoke the tty, so the ttyclosesession()
 433                          * function will re-check sp->s_ttyvp.
 434                          */
 435                         if (sp->s_ttyp && (sp->s_ttyp->t_session == sp)) {
 436                                 if (sp->s_ttyp->t_pgrp)
 437                                         pgsignal(sp->s_ttyp->t_pgrp, SIGHUP, 1);
 438                                 ttywait(sp->s_ttyp);
 439                                 ttyclosesession(sp, 1); /* also revoke */
 440                         }
 441                         /*
 442                          * Release the tty.  If someone has it open via
 443                          * /dev/tty then close it (since they no longer can
 444                          * once we've NULL'd it out).
 445                          */
 446                         ttyclosesession(sp, 0);
 447
 448                         /*
 449                          * s_ttyp is not zero'd; we use this to indicate
 450                          * that the session once had a controlling terminal.
 451                          * (for logging and informational purposes)
 452                          */
 453                 }
 454                 sp->s_leader = NULL;
 455         }
 456         fixjobc(p, p->p_pgrp, 0);
 457         (void)acct_process(p);
 458 #ifdef KTRACE
 459         /*
 460          * release trace file
 461          */
 462         if (p->p_tracenode)
 463                 ktrdestroy(&p->p_tracenode);
 464         p->p_traceflag = 0;
 465 #endif
 466         /*
 467          * Release reference to text vnode
 468          */
 469         if ((vtmp = p->p_textvp) != NULL) {
 470                 p->p_textvp = NULL;
 471                 vrele(vtmp);
 472         }
 473
 474         /* Release namecache handle to text file */
 475         if (p->p_textnch.ncp)
 476                 cache_drop(&p->p_textnch);
 477
 478         /*
 479          * Move the process to the zombie list.  This will block
 480          * until the process p_lock count reaches 0.  The process will
 481          * not be reaped until TDF_EXITING is set by cpu_thread_exit(),
 482          * which is called from cpu_proc_exit().
 483          */
 484         proc_move_allproc_zombie(p);
 485
 486         /*
 487          * Reparent all of this process's children to the init process.
 488          * We must hold initproc->p_token in order to mess with
 489          * initproc->p_children.  We already hold p->p_token (to remove
 490          * the children from our list).
 491          */
 492         q = LIST_FIRST(&p->p_children);
 493         if (q) {
 494                 lwkt_gettoken(&initproc->p_token);
 495                 while (q) {
 496                         nq = LIST_NEXT(q, p_sibling);
 497                         LIST_REMOVE(q, p_sibling);
 498                         LIST_INSERT_HEAD(&initproc->p_children, q, p_sibling);
 499                         q->p_pptr = initproc;
 500                         q->p_sigparent = SIGCHLD;
 501                         /*
 502                          * Traced processes are killed
 503                          * since their existence means someone is screwing up.
 504                          */
 505                         if (q->p_flag & P_TRACED) {
 506                                 q->p_flag &= ~P_TRACED;
 507                                 ksignal(q, SIGKILL);
 508                         }
 509                         q = nq;
 510                 }
 511                 lwkt_reltoken(&initproc->p_token);
 512                 wakeup(initproc);
 513         }
 514
 515         /*
 516          * Save exit status and final rusage info, adding in child rusage
 517          * info and self times.
 518          */
 519         calcru_proc(p, &p->p_ru);
 520         ruadd(&p->p_ru, &p->p_cru);
 521
 522         /*
 523          * notify interested parties of our demise.
 524          */
 525         KNOTE(&p->p_klist, NOTE_EXIT);
 526
 527         /*
 528          * Notify parent that we're gone.  If parent has the PS_NOCLDWAIT
 529          * flag set, notify process 1 instead (and hope it will handle
 530          * this situation).
 531          */
 532         if (p->p_pptr->p_sigacts->ps_flag & PS_NOCLDWAIT) {
 533                 struct proc *pp = p->p_pptr;
 534
 535                 PHOLD(pp);
 536                 proc_reparent(p, initproc);
 537
 538                 /*
 539                  * If this was the last child of our parent, notify
 540                  * parent, so in case he was wait(2)ing, he will
 541                  * continue.  This function interlocks with pptr->p_token.
 542                  */
 543                 if (LIST_EMPTY(&pp->p_children))
 544                         wakeup((caddr_t)pp);
 545                 PRELE(pp);
 546         }
 547
 548         /* lwkt_gettoken(&proc_token); */
 549         q = p->p_pptr;
 550         PHOLD(q);
 551         if (p->p_sigparent && q != initproc) {
 552                 ksignal(q, p->p_sigparent);
 553         } else {
 554                 ksignal(q, SIGCHLD);
 555         }
 556         wakeup(p->p_pptr);
 557         PRELE(q);
 558         /* lwkt_reltoken(&proc_token); */
 559         /* NOTE: p->p_pptr can get ripped out */
 560         /*
 561          * cpu_exit is responsible for clearing curproc, since
 562          * it is heavily integrated with the thread/switching sequence.
 563          *
 564          * Other substructures are freed from wait().
 565          */
 566         plimit_free(p);
 567
 568         /*
 569          * Release the current user process designation on the process so
 570          * the userland scheduler can work in someone else.
 571          */
 572         p->p_usched->release_curproc(lp);
 573
 574         /*
 575          * Finally, call machine-dependent code to release as many of the
 576          * lwp's resources as we can and halt execution of this thread.
 577          */
 578         lwp_exit(1);
 579 }
 580
 581 /*
 582  * Eventually called by every exiting LWP
 583  *
 584  * p->p_token must be held.  mplock may be held and will be released.
 585  */
 586 void
 587 lwp_exit(int masterexit)
 588 {
 589         struct thread *td = curthread;
 590         struct lwp *lp = td->td_lwp;
 591         struct proc *p = lp->lwp_proc;
 592
 593         /*
 594          * lwp_exit() may be called without setting LWP_WEXIT, so
 595          * make sure it is set here.
 596          */
 597         ASSERT_LWKT_TOKEN_HELD(&p->p_token);
 598         lp->lwp_flag |= LWP_WEXIT;
 599
 600         /*
 601          * Clean up any virtualization
 602          */
 603         if (lp->lwp_vkernel)
 604                 vkernel_lwp_exit(lp);
 605
 606         /*
 607          * Clean up select/poll support
 608          */
 609         kqueue_terminate(&lp->lwp_kqueue);
 610
 611         /*
 612          * Clean up any syscall-cached ucred
 613          */
 614         if (td->td_ucred) {
 615                 crfree(td->td_ucred);
 616                 td->td_ucred = NULL;
 617         }
 618
 619         /*
 620          * Nobody actually wakes us when the lock
 621          * count reaches zero, so just wait one tick.
 622          */
 623         while (lp->lwp_lock > 0)
 624                 tsleep(lp, 0, "lwpexit", 1);
 625
 626         /* Hand down resource usage to our proc */
 627         ruadd(&p->p_ru, &lp->lwp_ru);
 628
 629         /*
 630          * If we don't hold the process until the LWP is reaped wait*()
 631          * may try to dispose of its vmspace before all the LWPs have
 632          * actually terminated.
 633          */
 634         PHOLD(p);
 635
 636         /*
 637          * Do any remaining work that might block on us.  We should be
 638          * coded such that further blocking is ok after decrementing
 639          * p_nthreads but don't take the chance.
 640          */
 641         dsched_exit_thread(td);
 642         biosched_done(curthread);
 643
 644         /*
 645          * We have to use the reaper for all the LWPs except the one doing
 646          * the master exit.  The LWP doing the master exit can just be
 647          * left on p_lwps and the process reaper will deal with it
 648          * synchronously, which is much faster.
 649          *
 650          * Wakeup anyone waiting on p_nthreads to drop to 1 or 0.
 651          */
 652         if (masterexit == 0) {
 653                 lwp_rb_tree_RB_REMOVE(&p->p_lwp_tree, lp);
 654                 --p->p_nthreads;
 655                 if (p->p_nthreads <= 1)
 656                         wakeup(&p->p_nthreads);
 657                 lwkt_gettoken(&deadlwp_token);
 658                 LIST_INSERT_HEAD(&deadlwp_list[mycpuid], lp, u.lwp_reap_entry);
 659                 taskqueue_enqueue(taskqueue_thread[mycpuid],
 660                                   deadlwp_task[mycpuid]);
 661                 lwkt_reltoken(&deadlwp_token);
 662         } else {
 663                 --p->p_nthreads;
 664                 if (p->p_nthreads <= 1)
 665                         wakeup(&p->p_nthreads);
 666         }
 667
 668         /*
 669          * Release p_token.  The mp_token may also be held and we depend on
 670          * the lwkt_switch() code to clean it up.
 671          */
 672         lwkt_reltoken(&p->p_token);
 673         cpu_lwp_exit();
 674 }
 675
 676 /*
 677  * Wait until a lwp is completely dead.
 678  *
 679  * If the thread is still executing, which can't be waited upon,
 680  * return failure.  The caller is responsible of waiting a little
 681  * bit and checking again.
 682  *
 683  * Suggested use:
 684  * while (!lwp_wait(lp))
 685  *      tsleep(lp, 0, "lwpwait", 1);
 686  */
 687 static int
 688 lwp_wait(struct lwp *lp)
 689 {
 690         struct thread *td = lp->lwp_thread;;
 691
 692         KKASSERT(lwkt_preempted_proc() != lp);
 693
 694         while (lp->lwp_lock > 0)
 695                 tsleep(lp, 0, "lwpwait1", 1);
 696
 697         lwkt_wait_free(td);
 698
 699         /*
 700          * The lwp's thread may still be in the middle
 701          * of switching away, we can't rip its stack out from
 702          * under it until TDF_EXITING is set and both
 703          * TDF_RUNNING and TDF_PREEMPT_LOCK are clear.
 704          * TDF_PREEMPT_LOCK must be checked because TDF_RUNNING
 705          * will be cleared temporarily if a thread gets
 706          * preempted.
 707          *
 708          * YYY no wakeup occurs, so we simply return failure
 709          * and let the caller deal with sleeping and calling
 710          * us again.
 711          */
 712         if ((td->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK|
 713                              TDF_EXITING|TDF_RUNQ)) != TDF_EXITING) {
 714                 return (0);
 715         }
 716         KASSERT((td->td_flags & TDF_TSLEEPQ) == 0,
 717                 ("lwp_wait: td %p (%s) still on sleep queue", td, td->td_comm));
 718         return (1);
 719 }
 720
 721 /*
 722  * Release the resources associated with a lwp.
 723  * The lwp must be completely dead.
 724  */
 725 void
 726 lwp_dispose(struct lwp *lp)
 727 {
 728         struct thread *td = lp->lwp_thread;;
 729
 730         KKASSERT(lwkt_preempted_proc() != lp);
 731         KKASSERT(td->td_refs == 0);
 732         KKASSERT((td->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK|TDF_EXITING)) ==
 733                  TDF_EXITING);
 734
 735         PRELE(lp->lwp_proc);
 736         lp->lwp_proc = NULL;
 737         if (td != NULL) {
 738                 td->td_proc = NULL;
 739                 td->td_lwp = NULL;
 740                 lp->lwp_thread = NULL;
 741                 lwkt_free_thread(td);
 742         }
 743         kfree(lp, M_LWP);
 744 }
 745
 746 /*
 747  * MPSAFE
 748  */
 749 int
 750 sys_wait4(struct wait_args *uap)
 751 {
 752         struct rusage rusage;
 753         int error, status;
 754
 755         error = kern_wait(uap->pid, (uap->status ? &status : NULL),
 756                           uap->options, (uap->rusage ? &rusage : NULL),
 757                           &uap->sysmsg_result);
 758
 759         if (error == 0 && uap->status)
 760                 error = copyout(&status, uap->status, sizeof(*uap->status));
 761         if (error == 0 && uap->rusage)
 762                 error = copyout(&rusage, uap->rusage, sizeof(*uap->rusage));
 763         return (error);
 764 }
 765
 766 /*
 767  * wait1()
 768  *
 769  * wait_args(int pid, int *status, int options, struct rusage *rusage)
 770  *
 771  * MPALMOSTSAFE
 772  */
 773 int
 774 kern_wait(pid_t pid, int *status, int options, struct rusage *rusage, int *res)
 775 {
 776         struct thread *td = curthread;
 777         struct lwp *lp;
 778         struct proc *q = td->td_proc;
 779         struct proc *p, *t;
 780         struct pargs *pa;
 781         struct sigacts *ps;
 782         int nfound, error;
 783
 784         if (pid == 0)
 785                 pid = -q->p_pgid;
 786         if (options &~ (WUNTRACED|WNOHANG|WCONTINUED|WLINUXCLONE))
 787                 return (EINVAL);
 788
 789         lwkt_gettoken(&q->p_token);
 790 loop:
 791         /*
 792          * All sorts of things can change due to blocking so we have to loop
 793          * all the way back up here.
 794          *
 795          * The problem is that if a process group is stopped and the parent
 796          * is doing a wait*(..., WUNTRACED, ...), it will see the STOP
 797          * of the child and then stop itself when it tries to return from the
 798          * system call.  When the process group is resumed the parent will
 799          * then get the STOP status even though the child has now resumed
 800          * (a followup wait*() will get the CONT status).
 801          *
 802          * Previously the CONT would overwrite the STOP because the tstop
 803          * was handled within tsleep(), and the parent would only see
 804          * the CONT when both are stopped and continued together.  This little
 805          * two-line hack restores this effect.
 806          */
 807         while (q->p_stat == SSTOP)
 808             tstop();
 809
 810         nfound = 0;
 811
 812         LIST_FOREACH(p, &q->p_children, p_sibling) {
 813                 if (pid != WAIT_ANY &&
 814                     p->p_pid != pid && p->p_pgid != -pid) {
 815                         continue;
 816                 }
 817
 818                 /*
 819                  * This special case handles a kthread spawned by linux_clone
 820                  * (see linux_misc.c).  The linux_wait4 and linux_waitpid
 821                  * functions need to be able to distinguish between waiting
 822                  * on a process and waiting on a thread.  It is a thread if
 823                  * p_sigparent is not SIGCHLD, and the WLINUXCLONE option
 824                  * signifies we want to wait for threads and not processes.
 825                  */
 826                 if ((p->p_sigparent != SIGCHLD) ^
 827                     ((options & WLINUXCLONE) != 0)) {
 828                         continue;
 829                 }
 830
 831                 nfound++;
 832                 if (p->p_stat == SZOMB) {
 833                         /*
 834                          * We may go into SZOMB with threads still present.
 835                          * We must wait for them to exit before we can reap
 836                          * the master thread, otherwise we may race reaping
 837                          * non-master threads.
 838                          */
 839                         lwkt_gettoken(&p->p_token);
 840                         while (p->p_nthreads > 0) {
 841                                 tsleep(&p->p_nthreads, 0, "lwpzomb", hz);
 842                         }
 843
 844                         /*
 845                          * Reap any LWPs left in p->p_lwps.  This is usually
 846                          * just the last LWP.  This must be done before
 847                          * we loop on p_lock since the lwps hold a ref on
 848                          * it as a vmspace interlock.
 849                          *
 850                          * Once that is accomplished p_nthreads had better
 851                          * be zero.
 852                          */
 853                         while ((lp = RB_ROOT(&p->p_lwp_tree)) != NULL) {
 854                                 lwp_rb_tree_RB_REMOVE(&p->p_lwp_tree, lp);
 855                                 reaplwp(lp);
 856                         }
 857                         KKASSERT(p->p_nthreads == 0);
 858                         lwkt_reltoken(&p->p_token);
 859
 860                         /*
 861                          * Don't do anything really bad until all references
 862                          * to the process go away.  This may include other
 863                          * LWPs which are still in the process of being
 864                          * reaped.  We can't just pull the rug out from under
 865                          * them because they may still be using the VM space.
 866                          *
 867                          * Certain kernel facilities such as /proc will also
 868                          * put a hold on the process for short periods of
 869                          * time.
 870                          */
 871                         while (p->p_lock)
 872                                 tsleep(p, 0, "reap3", hz);
 873
 874                         /* Take care of our return values. */
 875                         *res = p->p_pid;
 876                         if (status)
 877                                 *status = p->p_xstat;
 878                         if (rusage)
 879                                 *rusage = p->p_ru;
 880                         /*
 881                          * If we got the child via a ptrace 'attach',
 882                          * we need to give it back to the old parent.
 883                          */
 884                         if (p->p_oppid && (t = pfind(p->p_oppid)) != NULL) {
 885                                 p->p_oppid = 0;
 886                                 proc_reparent(p, t);
 887                                 ksignal(t, SIGCHLD);
 888                                 wakeup((caddr_t)t);
 889                                 error = 0;
 890                                 PRELE(t);
 891                                 goto done;
 892                         }
 893
 894                         /*
 895                          * Unlink the proc from its process group so that
 896                          * the following operations won't lead to an
 897                          * inconsistent state for processes running down
 898                          * the zombie list.
 899                          */
 900                         KKASSERT(p->p_lock == 0);
 901                         proc_remove_zombie(p);
 902                         leavepgrp(p);
 903
 904                         p->p_xstat = 0;
 905                         ruadd(&q->p_cru, &p->p_ru);
 906
 907                         /*
 908                          * Decrement the count of procs running with this uid.
 909                          */
 910                         chgproccnt(p->p_ucred->cr_ruidinfo, -1, 0);
 911
 912                         /*
 913                          * Free up credentials.
 914                          */
 915                         crfree(p->p_ucred);
 916                         p->p_ucred = NULL;
 917
 918                         /*
 919                          * Remove unused arguments
 920                          */
 921                         pa = p->p_args;
 922                         p->p_args = NULL;
 923                         if (pa && refcount_release(&pa->ar_ref)) {
 924                                 kfree(pa, M_PARGS);
 925                                 pa = NULL;
 926                         }
 927
 928                         ps = p->p_sigacts;
 929                         p->p_sigacts = NULL;
 930                         if (ps && refcount_release(&ps->ps_refcnt)) {
 931                                 kfree(ps, M_SUBPROC);
 932                                 ps = NULL;
 933                         }
 934
 935                         vm_waitproc(p);
 936                         kfree(p, M_PROC);
 937                         nprocs--;
 938                         error = 0;
 939                         goto done;
 940                 }
 941                 if (p->p_stat == SSTOP && (p->p_flag & P_WAITED) == 0 &&
 942                     (p->p_flag & P_TRACED || options & WUNTRACED)) {
 943                         p->p_flag |= P_WAITED;
 944
 945                         *res = p->p_pid;
 946                         if (status)
 947                                 *status = W_STOPCODE(p->p_xstat);
 948                         /* Zero rusage so we get something consistent. */
 949                         if (rusage)
 950                                 bzero(rusage, sizeof(rusage));
 951                         error = 0;
 952                         goto done;
 953                 }
 954                 if (options & WCONTINUED && (p->p_flag & P_CONTINUED)) {
 955                         *res = p->p_pid;
 956                         p->p_flag &= ~P_CONTINUED;
 957
 958                         if (status)
 959                                 *status = SIGCONT;
 960                         error = 0;
 961                         goto done;
 962                 }
 963         }
 964         if (nfound == 0) {
 965                 error = ECHILD;
 966                 goto done;
 967         }
 968         if (options & WNOHANG) {
 969                 *res = 0;
 970                 error = 0;
 971                 goto done;
 972         }
 973
 974         /*
 975          * Wait for signal - interlocked using q->p_token.
 976          */
 977         error = tsleep(q, PCATCH, "wait", 0);
 978         if (error) {
 979 done:
 980                 lwkt_reltoken(&q->p_token);
 981                 return (error);
 982         }
 983         goto loop;
 984 }
 985
 986 /*
 987  * Make process 'parent' the new parent of process 'child'.
 988  *
 989  * p_children/p_sibling requires the parent's token, and
 990  * changing pptr requires the child's token, so we have to
 991  * get three tokens to do this operation.
 992  */
 993 void
 994 proc_reparent(struct proc *child, struct proc *parent)
 995 {
 996         struct proc *opp = child->p_pptr;
 997
 998         if (opp == parent)
 999                 return;
1000         PHOLD(opp);
1001         PHOLD(parent);
1002         lwkt_gettoken(&opp->p_token);
1003         lwkt_gettoken(&child->p_token);
1004         lwkt_gettoken(&parent->p_token);
1005         KKASSERT(child->p_pptr == opp);
1006         LIST_REMOVE(child, p_sibling);
1007         LIST_INSERT_HEAD(&parent->p_children, child, p_sibling);
1008         child->p_pptr = parent;
1009         lwkt_reltoken(&parent->p_token);
1010         lwkt_reltoken(&child->p_token);
1011         lwkt_reltoken(&opp->p_token);
1012         PRELE(parent);
1013         PRELE(opp);
1014 }
1015
1016 /*
1017  * The next two functions are to handle adding/deleting items on the
1018  * exit callout list
1019  *
1020  * at_exit():
1021  * Take the arguments given and put them onto the exit callout list,
1022  * However first make sure that it's not already there.
1023  * returns 0 on success.
1024  */
1025
1026 int
1027 at_exit(exitlist_fn function)
1028 {
1029         struct exitlist *ep;
1030
1031 #ifdef INVARIANTS
1032         /* Be noisy if the programmer has lost track of things */
1033         if (rm_at_exit(function))
1034                 kprintf("WARNING: exit callout entry (%p) already present\n",
1035                     function);
1036 #endif
1037         ep = kmalloc(sizeof(*ep), M_ATEXIT, M_NOWAIT);
1038         if (ep == NULL)
1039                 return (ENOMEM);
1040         ep->function = function;
1041         TAILQ_INSERT_TAIL(&exit_list, ep, next);
1042         return (0);
1043 }
1044
1045 /*
1046  * Scan the exit callout list for the given item and remove it.
1047  * Returns the number of items removed (0 or 1)
1048  */
1049 int
1050 rm_at_exit(exitlist_fn function)
1051 {
1052         struct exitlist *ep;
1053
1054         TAILQ_FOREACH(ep, &exit_list, next) {
1055                 if (ep->function == function) {
1056                         TAILQ_REMOVE(&exit_list, ep, next);
1057                         kfree(ep, M_ATEXIT);
1058                         return(1);
1059                 }
1060         }
1061         return (0);
1062 }
1063
1064 /*
1065  * LWP reaper related code.
1066  */
1067 static void
1068 reaplwps(void *context, int dummy)
1069 {
1070         struct lwplist *lwplist = context;
1071         struct lwp *lp;
1072
1073         lwkt_gettoken(&deadlwp_token);
1074         while ((lp = LIST_FIRST(lwplist))) {
1075                 LIST_REMOVE(lp, u.lwp_reap_entry);
1076                 reaplwp(lp);
1077         }
1078         lwkt_reltoken(&deadlwp_token);
1079 }
1080
1081 static void
1082 reaplwp(struct lwp *lp)
1083 {
1084         while (lwp_wait(lp) == 0)
1085                 tsleep(lp, 0, "lwpreap", 1);
1086         lwp_dispose(lp);
1087 }
1088
1089 static void
1090 deadlwp_init(void)
1091 {
1092         int cpu;
1093
1094         for (cpu = 0; cpu < ncpus; cpu++) {
1095                 LIST_INIT(&deadlwp_list[cpu]);
1096                 deadlwp_task[cpu] = kmalloc(sizeof(*deadlwp_task[cpu]), M_DEVBUF, M_WAITOK);
1097                 TASK_INIT(deadlwp_task[cpu], 0, reaplwps, &deadlwp_list[cpu]);
1098         }
1099 }
1100
1101 SYSINIT(deadlwpinit, SI_SUB_CONFIGURE, SI_ORDER_ANY, deadlwp_init, NULL);