sys/kern/kern_fork.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. 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_fork.c 8.6 (Berkeley) 4/8/94
  35  * $FreeBSD: src/sys/kern/kern_fork.c,v 1.72.2.14 2003/06/26 04:15:10 silby Exp $
  36  */
  37
  38 #include "opt_ktrace.h"
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/sysproto.h>
  43 #include <sys/filedesc.h>
  44 #include <sys/kernel.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/malloc.h>
  47 #include <sys/proc.h>
  48 #include <sys/resourcevar.h>
  49 #include <sys/vnode.h>
  50 #include <sys/acct.h>
  51 #include <sys/ktrace.h>
  52 #include <sys/unistd.h>
  53 #include <sys/jail.h>
  54
  55 #include <vm/vm.h>
  56 #include <sys/lock.h>
  57 #include <vm/pmap.h>
  58 #include <vm/vm_map.h>
  59 #include <vm/vm_extern.h>
  60
  61 #include <sys/vmmeter.h>
  62 #include <sys/refcount.h>
  63 #include <sys/thread2.h>
  64 #include <sys/signal2.h>
  65 #include <sys/spinlock2.h>
  66
  67 #include <sys/dsched.h>
  68
  69 static MALLOC_DEFINE(M_ATFORK, "atfork", "atfork callback");
  70 static MALLOC_DEFINE(M_REAPER, "reaper", "process reapers");
  71
  72 /*
  73  * These are the stuctures used to create a callout list for things to do
  74  * when forking a process
  75  */
  76 struct forklist {
  77         forklist_fn function;
  78         TAILQ_ENTRY(forklist) next;
  79 };
  80
  81 TAILQ_HEAD(forklist_head, forklist);
  82 static struct forklist_head fork_list = TAILQ_HEAD_INITIALIZER(fork_list);
  83
  84 static struct lwp *lwp_fork(struct lwp *, struct proc *, int flags);
  85
  86 int forksleep; /* Place for fork1() to sleep on. */
  87
  88 /*
  89  * Red-Black tree support for LWPs
  90  */
  91
  92 static int
  93 rb_lwp_compare(struct lwp *lp1, struct lwp *lp2)
  94 {
  95         if (lp1->lwp_tid < lp2->lwp_tid)
  96                 return(-1);
  97         if (lp1->lwp_tid > lp2->lwp_tid)
  98                 return(1);
  99         return(0);
 100 }
 101
 102 RB_GENERATE2(lwp_rb_tree, lwp, u.lwp_rbnode, rb_lwp_compare, lwpid_t, lwp_tid);
 103
 104 /*
 105  * fork() system call
 106  */
 107 int
 108 sys_fork(struct fork_args *uap)
 109 {
 110         struct lwp *lp = curthread->td_lwp;
 111         struct proc *p2;
 112         int error;
 113
 114         error = fork1(lp, RFFDG | RFPROC | RFPGLOCK, &p2);
 115         if (error == 0) {
 116                 PHOLD(p2);
 117                 start_forked_proc(lp, p2);
 118                 uap->sysmsg_fds[0] = p2->p_pid;
 119                 uap->sysmsg_fds[1] = 0;
 120                 PRELE(p2);
 121         }
 122         return error;
 123 }
 124
 125 /*
 126  * vfork() system call
 127  */
 128 int
 129 sys_vfork(struct vfork_args *uap)
 130 {
 131         struct lwp *lp = curthread->td_lwp;
 132         struct proc *p2;
 133         int error;
 134
 135         error = fork1(lp, RFFDG | RFPROC | RFPPWAIT | RFMEM | RFPGLOCK, &p2);
 136         if (error == 0) {
 137                 PHOLD(p2);
 138                 start_forked_proc(lp, p2);
 139                 uap->sysmsg_fds[0] = p2->p_pid;
 140                 uap->sysmsg_fds[1] = 0;
 141                 PRELE(p2);
 142         }
 143         return error;
 144 }
 145
 146 /*
 147  * Handle rforks.  An rfork may (1) operate on the current process without
 148  * creating a new, (2) create a new process that shared the current process's
 149  * vmspace, signals, and/or descriptors, or (3) create a new process that does
 150  * not share these things (normal fork).
 151  *
 152  * Note that we only call start_forked_proc() if a new process is actually
 153  * created.
 154  *
 155  * rfork { int flags }
 156  */
 157 int
 158 sys_rfork(struct rfork_args *uap)
 159 {
 160         struct lwp *lp = curthread->td_lwp;
 161         struct proc *p2;
 162         int error;
 163
 164         if ((uap->flags & RFKERNELONLY) != 0)
 165                 return (EINVAL);
 166
 167         error = fork1(lp, uap->flags | RFPGLOCK, &p2);
 168         if (error == 0) {
 169                 if (p2) {
 170                         PHOLD(p2);
 171                         start_forked_proc(lp, p2);
 172                         uap->sysmsg_fds[0] = p2->p_pid;
 173                         uap->sysmsg_fds[1] = 0;
 174                         PRELE(p2);
 175                 } else {
 176                         uap->sysmsg_fds[0] = 0;
 177                         uap->sysmsg_fds[1] = 0;
 178                 }
 179         }
 180         return error;
 181 }
 182
 183 /*
 184  * Low level thread create used by pthreads.
 185  */
 186 int
 187 sys_lwp_create(struct lwp_create_args *uap)
 188 {
 189         struct proc *p = curproc;
 190         struct lwp *lp;
 191         struct lwp_params params;
 192         int error;
 193
 194         error = copyin(uap->params, &params, sizeof(params));
 195         if (error)
 196                 goto fail2;
 197
 198         lwkt_gettoken(&p->p_token);
 199         plimit_lwp_fork(p);     /* force exclusive access */
 200         lp = lwp_fork(curthread->td_lwp, p, RFPROC);
 201         error = cpu_prepare_lwp(lp, &params);
 202         if (error)
 203                 goto fail;
 204         if (params.tid1 != NULL &&
 205             (error = copyout(&lp->lwp_tid, params.tid1, sizeof(lp->lwp_tid))))
 206                 goto fail;
 207         if (params.tid2 != NULL &&
 208             (error = copyout(&lp->lwp_tid, params.tid2, sizeof(lp->lwp_tid))))
 209                 goto fail;
 210
 211         /*
 212          * Now schedule the new lwp.
 213          */
 214         p->p_usched->resetpriority(lp);
 215         crit_enter();
 216         lp->lwp_stat = LSRUN;
 217         p->p_usched->setrunqueue(lp);
 218         crit_exit();
 219         lwkt_reltoken(&p->p_token);
 220
 221         return (0);
 222
 223 fail:
 224         lwp_rb_tree_RB_REMOVE(&p->p_lwp_tree, lp);
 225         --p->p_nthreads;
 226         /* lwp_dispose expects an exited lwp, and a held proc */
 227         atomic_set_int(&lp->lwp_mpflags, LWP_MP_WEXIT);
 228         lp->lwp_thread->td_flags |= TDF_EXITING;
 229         lwkt_remove_tdallq(lp->lwp_thread);
 230         PHOLD(p);
 231         biosched_done(lp->lwp_thread);
 232         dsched_exit_thread(lp->lwp_thread);
 233         lwp_dispose(lp);
 234         lwkt_reltoken(&p->p_token);
 235 fail2:
 236         return (error);
 237 }
 238
 239 int     nprocs = 1;             /* process 0 */
 240
 241 int
 242 fork1(struct lwp *lp1, int flags, struct proc **procp)
 243 {
 244         struct proc *p1 = lp1->lwp_proc;
 245         struct proc *p2;
 246         struct proc *pptr;
 247         struct pgrp *p1grp;
 248         struct pgrp *plkgrp;
 249         uid_t uid;
 250         int ok, error;
 251         static int curfail = 0;
 252         static struct timeval lastfail;
 253         struct forklist *ep;
 254         struct filedesc_to_leader *fdtol;
 255
 256         if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
 257                 return (EINVAL);
 258
 259         lwkt_gettoken(&p1->p_token);
 260         plkgrp = NULL;
 261         p2 = NULL;
 262
 263         /*
 264          * Here we don't create a new process, but we divorce
 265          * certain parts of a process from itself.
 266          */
 267         if ((flags & RFPROC) == 0) {
 268                 /*
 269                  * This kind of stunt does not work anymore if
 270                  * there are native threads (lwps) running
 271                  */
 272                 if (p1->p_nthreads != 1) {
 273                         error = EINVAL;
 274                         goto done;
 275                 }
 276
 277                 vm_fork(p1, 0, flags);
 278
 279                 /*
 280                  * Close all file descriptors.
 281                  */
 282                 if (flags & RFCFDG) {
 283                         struct filedesc *fdtmp;
 284                         fdtmp = fdinit(p1);
 285                         fdfree(p1, fdtmp);
 286                 }
 287
 288                 /*
 289                  * Unshare file descriptors (from parent.)
 290                  */
 291                 if (flags & RFFDG) {
 292                         if (p1->p_fd->fd_refcnt > 1) {
 293                                 struct filedesc *newfd;
 294                                 error = fdcopy(p1, &newfd);
 295                                 if (error != 0) {
 296                                         error = ENOMEM;
 297                                         goto done;
 298                                 }
 299                                 fdfree(p1, newfd);
 300                         }
 301                 }
 302                 *procp = NULL;
 303                 error = 0;
 304                 goto done;
 305         }
 306
 307         /*
 308          * Interlock against process group signal delivery.  If signals
 309          * are pending after the interlock is obtained we have to restart
 310          * the system call to process the signals.  If we don't the child
 311          * can miss a pgsignal (such as ^C) sent during the fork.
 312          *
 313          * We can't use CURSIG() here because it will process any STOPs
 314          * and cause the process group lock to be held indefinitely.  If
 315          * a STOP occurs, the fork will be restarted after the CONT.
 316          */
 317         p1grp = p1->p_pgrp;
 318         if ((flags & RFPGLOCK) && (plkgrp = p1->p_pgrp) != NULL) {
 319                 pgref(plkgrp);
 320                 lockmgr(&plkgrp->pg_lock, LK_SHARED);
 321                 if (CURSIG_NOBLOCK(lp1)) {
 322                         error = ERESTART;
 323                         goto done;
 324                 }
 325         }
 326
 327         /*
 328          * Although process entries are dynamically created, we still keep
 329          * a global limit on the maximum number we will create.  Don't allow
 330          * a nonprivileged user to use the last ten processes; don't let root
 331          * exceed the limit. The variable nprocs is the current number of
 332          * processes, maxproc is the limit.
 333          */
 334         uid = lp1->lwp_thread->td_ucred->cr_ruid;
 335         if ((nprocs >= maxproc - 10 && uid != 0) || nprocs >= maxproc) {
 336                 if (ppsratecheck(&lastfail, &curfail, 1))
 337                         kprintf("maxproc limit exceeded by uid %d, please "
 338                                "see tuning(7) and login.conf(5).\n", uid);
 339                 tsleep(&forksleep, 0, "fork", hz / 2);
 340                 error = EAGAIN;
 341                 goto done;
 342         }
 343
 344         /*
 345          * Increment the nprocs resource before blocking can occur.  There
 346          * are hard-limits as to the number of processes that can run.
 347          */
 348         atomic_add_int(&nprocs, 1);
 349
 350         /*
 351          * Increment the count of procs running with this uid. Don't allow
 352          * a nonprivileged user to exceed their current limit.
 353          */
 354         ok = chgproccnt(lp1->lwp_thread->td_ucred->cr_ruidinfo, 1,
 355                 (uid != 0) ? p1->p_rlimit[RLIMIT_NPROC].rlim_cur : 0);
 356         if (!ok) {
 357                 /*
 358                  * Back out the process count
 359                  */
 360                 atomic_add_int(&nprocs, -1);
 361                 if (ppsratecheck(&lastfail, &curfail, 1))
 362                         kprintf("maxproc limit exceeded by uid %d, please "
 363                                "see tuning(7) and login.conf(5).\n", uid);
 364                 tsleep(&forksleep, 0, "fork", hz / 2);
 365                 error = EAGAIN;
 366                 goto done;
 367         }
 368
 369         /*
 370          * Allocate a new process, don't get fancy: zero the structure.
 371          */
 372         p2 = kmalloc(sizeof(struct proc), M_PROC, M_WAITOK|M_ZERO);
 373
 374         /*
 375          * Core initialization.  SIDL is a safety state that protects the
 376          * partially initialized process once it starts getting hooked
 377          * into system structures and becomes addressable.
 378          *
 379          * We must be sure to acquire p2->p_token as well, we must hold it
 380          * once the process is on the allproc list to avoid things such
 381          * as competing modifications to p_flags.
 382          */
 383         mycpu->gd_forkid += ncpus;
 384         p2->p_forkid = mycpu->gd_forkid + mycpu->gd_cpuid;
 385         p2->p_lasttid = -1;     /* first tid will be 0 */
 386         p2->p_stat = SIDL;
 387
 388         /*
 389          * NOTE: Process 0 will not have a reaper, but process 1 (init) and
 390          *       all other processes always will.
 391          */
 392         if ((p2->p_reaper = p1->p_reaper) != NULL)
 393                 reaper_hold(p2->p_reaper);
 394
 395         RB_INIT(&p2->p_lwp_tree);
 396         spin_init(&p2->p_spin, "procfork1");
 397         lwkt_token_init(&p2->p_token, "proc");
 398         lwkt_gettoken(&p2->p_token);
 399
 400         /*
 401          * Setup linkage for kernel based threading XXX lwp.  Also add the
 402          * process to the allproclist.
 403          *
 404          * The process structure is addressable after this point.
 405          */
 406         if (flags & RFTHREAD) {
 407                 p2->p_peers = p1->p_peers;
 408                 p1->p_peers = p2;
 409                 p2->p_leader = p1->p_leader;
 410         } else {
 411                 p2->p_leader = p2;
 412         }
 413         proc_add_allproc(p2);
 414
 415         /*
 416          * Initialize the section which is copied verbatim from the parent.
 417          */
 418         bcopy(&p1->p_startcopy, &p2->p_startcopy,
 419               ((caddr_t)&p2->p_endcopy - (caddr_t)&p2->p_startcopy));
 420
 421         /*
 422          * Duplicate sub-structures as needed.  Increase reference counts
 423          * on shared objects.
 424          *
 425          * NOTE: because we are now on the allproc list it is possible for
 426          *       other consumers to gain temporary references to p2
 427          *       (p2->p_lock can change).
 428          */
 429         if (p1->p_flags & P_PROFIL)
 430                 startprofclock(p2);
 431         p2->p_ucred = crhold(lp1->lwp_thread->td_ucred);
 432
 433         if (jailed(p2->p_ucred))
 434                 p2->p_flags |= P_JAILED;
 435
 436         if (p2->p_args)
 437                 refcount_acquire(&p2->p_args->ar_ref);
 438
 439         p2->p_usched = p1->p_usched;
 440         /* XXX: verify copy of the secondary iosched stuff */
 441         dsched_new_proc(p2);
 442
 443         if (flags & RFSIGSHARE) {
 444                 p2->p_sigacts = p1->p_sigacts;
 445                 refcount_acquire(&p2->p_sigacts->ps_refcnt);
 446         } else {
 447                 p2->p_sigacts = kmalloc(sizeof(*p2->p_sigacts),
 448                                         M_SUBPROC, M_WAITOK);
 449                 bcopy(p1->p_sigacts, p2->p_sigacts, sizeof(*p2->p_sigacts));
 450                 refcount_init(&p2->p_sigacts->ps_refcnt, 1);
 451         }
 452         if (flags & RFLINUXTHPN)
 453                 p2->p_sigparent = SIGUSR1;
 454         else
 455                 p2->p_sigparent = SIGCHLD;
 456
 457         /* bump references to the text vnode (for procfs) */
 458         p2->p_textvp = p1->p_textvp;
 459         if (p2->p_textvp)
 460                 vref(p2->p_textvp);
 461
 462         /* copy namecache handle to the text file */
 463         if (p1->p_textnch.mount)
 464                 cache_copy(&p1->p_textnch, &p2->p_textnch);
 465
 466         /*
 467          * Handle file descriptors
 468          */
 469         if (flags & RFCFDG) {
 470                 p2->p_fd = fdinit(p1);
 471                 fdtol = NULL;
 472         } else if (flags & RFFDG) {
 473                 error = fdcopy(p1, &p2->p_fd);
 474                 if (error != 0) {
 475                         error = ENOMEM;
 476                         goto done;
 477                 }
 478                 fdtol = NULL;
 479         } else {
 480                 p2->p_fd = fdshare(p1);
 481                 if (p1->p_fdtol == NULL) {
 482                         p1->p_fdtol = filedesc_to_leader_alloc(NULL,
 483                                                                p1->p_leader);
 484                 }
 485                 if ((flags & RFTHREAD) != 0) {
 486                         /*
 487                          * Shared file descriptor table and
 488                          * shared process leaders.
 489                          */
 490                         fdtol = p1->p_fdtol;
 491                         fdtol->fdl_refcount++;
 492                 } else {
 493                         /*
 494                          * Shared file descriptor table, and
 495                          * different process leaders
 496                          */
 497                         fdtol = filedesc_to_leader_alloc(p1->p_fdtol, p2);
 498                 }
 499         }
 500         p2->p_fdtol = fdtol;
 501         p2->p_limit = plimit_fork(p1);
 502
 503         /*
 504          * Preserve some more flags in subprocess.  P_PROFIL has already
 505          * been preserved.
 506          */
 507         p2->p_flags |= p1->p_flags & P_SUGID;
 508         if (p1->p_session->s_ttyvp != NULL && (p1->p_flags & P_CONTROLT))
 509                 p2->p_flags |= P_CONTROLT;
 510         if (flags & RFPPWAIT) {
 511                 p2->p_flags |= P_PPWAIT;
 512                 if (p1->p_upmap)
 513                         p1->p_upmap->invfork = 1;
 514         }
 515
 516
 517         /*
 518          * Inherit the virtual kernel structure (allows a virtual kernel
 519          * to fork to simulate multiple cpus).
 520          */
 521         if (p1->p_vkernel)
 522                 vkernel_inherit(p1, p2);
 523
 524         /*
 525          * Once we are on a pglist we may receive signals.  XXX we might
 526          * race a ^C being sent to the process group by not receiving it
 527          * at all prior to this line.
 528          */
 529         pgref(p1grp);
 530         lwkt_gettoken(&p1grp->pg_token);
 531         LIST_INSERT_AFTER(p1, p2, p_pglist);
 532         lwkt_reltoken(&p1grp->pg_token);
 533
 534         /*
 535          * Attach the new process to its parent.
 536          *
 537          * If RFNOWAIT is set, the newly created process becomes a child
 538          * of init.  This effectively disassociates the child from the
 539          * parent.
 540          */
 541         if (flags & RFNOWAIT)
 542                 pptr = initproc;
 543         else
 544                 pptr = p1;
 545         p2->p_pptr = pptr;
 546         LIST_INIT(&p2->p_children);
 547
 548         lwkt_gettoken(&pptr->p_token);
 549         LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
 550         lwkt_reltoken(&pptr->p_token);
 551
 552         varsymset_init(&p2->p_varsymset, &p1->p_varsymset);
 553         callout_init_mp(&p2->p_ithandle);
 554
 555 #ifdef KTRACE
 556         /*
 557          * Copy traceflag and tracefile if enabled.  If not inherited,
 558          * these were zeroed above but we still could have a trace race
 559          * so make sure p2's p_tracenode is NULL.
 560          */
 561         if ((p1->p_traceflag & KTRFAC_INHERIT) && p2->p_tracenode == NULL) {
 562                 p2->p_traceflag = p1->p_traceflag;
 563                 p2->p_tracenode = ktrinherit(p1->p_tracenode);
 564         }
 565 #endif
 566
 567         /*
 568          * This begins the section where we must prevent the parent
 569          * from being swapped.
 570          *
 571          * Gets PRELE'd in the caller in start_forked_proc().
 572          */
 573         PHOLD(p1);
 574
 575         vm_fork(p1, p2, flags);
 576
 577         /*
 578          * Create the first lwp associated with the new proc.
 579          * It will return via a different execution path later, directly
 580          * into userland, after it was put on the runq by
 581          * start_forked_proc().
 582          */
 583         lwp_fork(lp1, p2, flags);
 584
 585         if (flags == (RFFDG | RFPROC | RFPGLOCK)) {
 586                 mycpu->gd_cnt.v_forks++;
 587                 mycpu->gd_cnt.v_forkpages += p2->p_vmspace->vm_dsize +
 588                                              p2->p_vmspace->vm_ssize;
 589         } else if (flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM | RFPGLOCK)) {
 590                 mycpu->gd_cnt.v_vforks++;
 591                 mycpu->gd_cnt.v_vforkpages += p2->p_vmspace->vm_dsize +
 592                                               p2->p_vmspace->vm_ssize;
 593         } else if (p1 == &proc0) {
 594                 mycpu->gd_cnt.v_kthreads++;
 595                 mycpu->gd_cnt.v_kthreadpages += p2->p_vmspace->vm_dsize +
 596                                                 p2->p_vmspace->vm_ssize;
 597         } else {
 598                 mycpu->gd_cnt.v_rforks++;
 599                 mycpu->gd_cnt.v_rforkpages += p2->p_vmspace->vm_dsize +
 600                                               p2->p_vmspace->vm_ssize;
 601         }
 602
 603         /*
 604          * Both processes are set up, now check if any loadable modules want
 605          * to adjust anything.
 606          *   What if they have an error? XXX
 607          */
 608         TAILQ_FOREACH(ep, &fork_list, next) {
 609                 (*ep->function)(p1, p2, flags);
 610         }
 611
 612         /*
 613          * Set the start time.  Note that the process is not runnable.  The
 614          * caller is responsible for making it runnable.
 615          */
 616         microtime(&p2->p_start);
 617         p2->p_acflag = AFORK;
 618
 619         /*
 620          * tell any interested parties about the new process
 621          */
 622         KNOTE(&p1->p_klist, NOTE_FORK | p2->p_pid);
 623
 624         /*
 625          * Return child proc pointer to parent.
 626          */
 627         *procp = p2;
 628         error = 0;
 629 done:
 630         if (p2)
 631                 lwkt_reltoken(&p2->p_token);
 632         lwkt_reltoken(&p1->p_token);
 633         if (plkgrp) {
 634                 lockmgr(&plkgrp->pg_lock, LK_RELEASE);
 635                 pgrel(plkgrp);
 636         }
 637         return (error);
 638 }
 639
 640 static struct lwp *
 641 lwp_fork(struct lwp *origlp, struct proc *destproc, int flags)
 642 {
 643         globaldata_t gd = mycpu;
 644         struct lwp *lp;
 645         struct thread *td;
 646
 647         lp = kmalloc(sizeof(struct lwp), M_LWP, M_WAITOK|M_ZERO);
 648
 649         lp->lwp_proc = destproc;
 650         lp->lwp_vmspace = destproc->p_vmspace;
 651         lp->lwp_stat = LSRUN;
 652         bcopy(&origlp->lwp_startcopy, &lp->lwp_startcopy,
 653             (unsigned) ((caddr_t)&lp->lwp_endcopy -
 654                         (caddr_t)&lp->lwp_startcopy));
 655         lp->lwp_flags |= origlp->lwp_flags & LWP_ALTSTACK;
 656         /*
 657          * Set cpbase to the last timeout that occured (not the upcoming
 658          * timeout).
 659          *
 660          * A critical section is required since a timer IPI can update
 661          * scheduler specific data.
 662          */
 663         crit_enter();
 664         lp->lwp_cpbase = gd->gd_schedclock.time - gd->gd_schedclock.periodic;
 665         destproc->p_usched->heuristic_forking(origlp, lp);
 666         crit_exit();
 667         CPUMASK_ANDMASK(lp->lwp_cpumask, usched_mastermask);
 668         lwkt_token_init(&lp->lwp_token, "lwp_token");
 669         spin_init(&lp->lwp_spin, "lwptoken");
 670
 671         /*
 672          * Assign the thread to the current cpu to begin with so we
 673          * can manipulate it.
 674          */
 675         td = lwkt_alloc_thread(NULL, LWKT_THREAD_STACK, gd->gd_cpuid, 0);
 676         lp->lwp_thread = td;
 677         td->td_ucred = crhold(destproc->p_ucred);
 678         td->td_proc = destproc;
 679         td->td_lwp = lp;
 680         td->td_switch = cpu_heavy_switch;
 681 #ifdef NO_LWKT_SPLIT_USERPRI
 682         lwkt_setpri(td, TDPRI_USER_NORM);
 683 #else
 684         lwkt_setpri(td, TDPRI_KERN_USER);
 685 #endif
 686         lwkt_set_comm(td, "%s", destproc->p_comm);
 687
 688         /*
 689          * cpu_fork will copy and update the pcb, set up the kernel stack,
 690          * and make the child ready to run.
 691          */
 692         cpu_fork(origlp, lp, flags);
 693         kqueue_init(&lp->lwp_kqueue, destproc->p_fd);
 694
 695         /*
 696          * Assign a TID to the lp.  Loop until the insert succeeds (returns
 697          * NULL).
 698          */
 699         lp->lwp_tid = destproc->p_lasttid;
 700         do {
 701                 if (++lp->lwp_tid < 0)
 702                         lp->lwp_tid = 1;
 703         } while (lwp_rb_tree_RB_INSERT(&destproc->p_lwp_tree, lp) != NULL);
 704         destproc->p_lasttid = lp->lwp_tid;
 705         destproc->p_nthreads++;
 706
 707         /*
 708          * This flag is set and never cleared.  It means that the process
 709          * was threaded at some point.  Used to improve exit performance.
 710          */
 711         destproc->p_flags |= P_MAYBETHREADED;
 712
 713         return (lp);
 714 }
 715
 716 /*
 717  * The next two functionms are general routines to handle adding/deleting
 718  * items on the fork callout list.
 719  *
 720  * at_fork():
 721  * Take the arguments given and put them onto the fork callout list,
 722  * However first make sure that it's not already there.
 723  * Returns 0 on success or a standard error number.
 724  */
 725 int
 726 at_fork(forklist_fn function)
 727 {
 728         struct forklist *ep;
 729
 730 #ifdef INVARIANTS
 731         /* let the programmer know if he's been stupid */
 732         if (rm_at_fork(function)) {
 733                 kprintf("WARNING: fork callout entry (%p) already present\n",
 734                     function);
 735         }
 736 #endif
 737         ep = kmalloc(sizeof(*ep), M_ATFORK, M_WAITOK|M_ZERO);
 738         ep->function = function;
 739         TAILQ_INSERT_TAIL(&fork_list, ep, next);
 740         return (0);
 741 }
 742
 743 /*
 744  * Scan the exit callout list for the given item and remove it..
 745  * Returns the number of items removed (0 or 1)
 746  */
 747 int
 748 rm_at_fork(forklist_fn function)
 749 {
 750         struct forklist *ep;
 751
 752         TAILQ_FOREACH(ep, &fork_list, next) {
 753                 if (ep->function == function) {
 754                         TAILQ_REMOVE(&fork_list, ep, next);
 755                         kfree(ep, M_ATFORK);
 756                         return(1);
 757                 }
 758         }
 759         return (0);
 760 }
 761
 762 /*
 763  * Add a forked process to the run queue after any remaining setup, such
 764  * as setting the fork handler, has been completed.
 765  *
 766  * p2 is held by the caller.
 767  */
 768 void
 769 start_forked_proc(struct lwp *lp1, struct proc *p2)
 770 {
 771         struct lwp *lp2 = ONLY_LWP_IN_PROC(p2);
 772         int pflags;
 773
 774         /*
 775          * Move from SIDL to RUN queue, and activate the process's thread.
 776          * Activation of the thread effectively makes the process "a"
 777          * current process, so we do not setrunqueue().
 778          *
 779          * YYY setrunqueue works here but we should clean up the trampoline
 780          * code so we just schedule the LWKT thread and let the trampoline
 781          * deal with the userland scheduler on return to userland.
 782          */
 783         KASSERT(p2->p_stat == SIDL,
 784             ("cannot start forked process, bad status: %p", p2));
 785         p2->p_usched->resetpriority(lp2);
 786         crit_enter();
 787         p2->p_stat = SACTIVE;
 788         lp2->lwp_stat = LSRUN;
 789         p2->p_usched->setrunqueue(lp2);
 790         crit_exit();
 791
 792         /*
 793          * Now can be swapped.
 794          */
 795         PRELE(lp1->lwp_proc);
 796
 797         /*
 798          * Preserve synchronization semantics of vfork.  P_PPWAIT is set in
 799          * the child until it has retired the parent's resources.  The parent
 800          * must wait for the flag to be cleared by the child.
 801          *
 802          * Interlock the flag/tsleep with atomic ops to avoid unnecessary
 803          * p_token conflicts.
 804          *
 805          * XXX Is this use of an atomic op on a field that is not normally
 806          *     manipulated with atomic ops ok?
 807          */
 808         while ((pflags = p2->p_flags) & P_PPWAIT) {
 809                 cpu_ccfence();
 810                 tsleep_interlock(lp1->lwp_proc, 0);
 811                 if (atomic_cmpset_int(&p2->p_flags, pflags, pflags))
 812                         tsleep(lp1->lwp_proc, PINTERLOCKED, "ppwait", 0);
 813         }
 814 }
 815
 816 /*
 817  * procctl (idtype_t idtype, id_t id, int cmd, void *arg)
 818  */
 819 int
 820 sys_procctl(struct procctl_args *uap)
 821 {
 822         struct proc *p = curproc;
 823         struct proc *p2;
 824         struct sysreaper *reap;
 825         union reaper_info udata;
 826         int error;
 827
 828         if (uap->idtype != P_PID || uap->id != (id_t)p->p_pid)
 829                 return EINVAL;
 830
 831         switch(uap->cmd) {
 832         case PROC_REAP_ACQUIRE:
 833                 lwkt_gettoken(&p->p_token);
 834                 reap = kmalloc(sizeof(*reap), M_REAPER, M_WAITOK|M_ZERO);
 835                 if (p->p_reaper == NULL || p->p_reaper->p != p) {
 836                         reaper_init(p, reap);
 837                         error = 0;
 838                 } else {
 839                         kfree(reap, M_REAPER);
 840                         error = EALREADY;
 841                 }
 842                 lwkt_reltoken(&p->p_token);
 843                 break;
 844         case PROC_REAP_RELEASE:
 845                 lwkt_gettoken(&p->p_token);
 846 release_again:
 847                 reap = p->p_reaper;
 848                 KKASSERT(reap != NULL);
 849                 if (reap->p == p) {
 850                         reaper_hold(reap);      /* in case of thread race */
 851                         lockmgr(&reap->lock, LK_EXCLUSIVE);
 852                         if (reap->p != p) {
 853                                 lockmgr(&reap->lock, LK_RELEASE);
 854                                 reaper_drop(reap);
 855                                 goto release_again;
 856                         }
 857                         reap->p = NULL;
 858                         p->p_reaper = reap->parent;
 859                         if (p->p_reaper)
 860                                 reaper_hold(p->p_reaper);
 861                         lockmgr(&reap->lock, LK_RELEASE);
 862                         reaper_drop(reap);      /* our ref */
 863                         reaper_drop(reap);      /* old p_reaper ref */
 864                         error = 0;
 865                 } else {
 866                         error = ENOTCONN;
 867                 }
 868                 lwkt_reltoken(&p->p_token);
 869                 break;
 870         case PROC_REAP_STATUS:
 871                 bzero(&udata, sizeof(udata));
 872                 lwkt_gettoken_shared(&p->p_token);
 873                 if ((reap = p->p_reaper) != NULL && reap->p == p) {
 874                         udata.status.flags = reap->flags;
 875                         udata.status.refs = reap->refs - 1; /* minus ours */
 876                 }
 877                 p2 = LIST_FIRST(&p->p_children);
 878                 udata.status.pid_head = p2 ? p2->p_pid : -1;
 879                 lwkt_reltoken(&p->p_token);
 880
 881                 if (uap->data) {
 882                         error = copyout(&udata, uap->data,
 883                                         sizeof(udata.status));
 884                 } else {
 885                         error = 0;
 886                 }
 887                 break;
 888         default:
 889                 error = EINVAL;
 890                 break;
 891         }
 892         return error;
 893 }
 894
 895 /*
 896  * Bump ref on reaper, preventing destruction
 897  */
 898 void
 899 reaper_hold(struct sysreaper *reap)
 900 {
 901         KKASSERT(reap->refs > 0);
 902         refcount_acquire(&reap->refs);
 903 }
 904
 905 /*
 906  * Drop ref on reaper, destroy the structure on the 1->0
 907  * transition and loop on the parent.
 908  */
 909 void
 910 reaper_drop(struct sysreaper *next)
 911 {
 912         struct sysreaper *reap;
 913
 914         while ((reap = next) != NULL) {
 915                 if (refcount_release(&reap->refs)) {
 916                         next = reap->parent;
 917                         KKASSERT(reap->p == NULL);
 918                         reap->parent = NULL;
 919                         kfree(reap, M_REAPER);
 920                 } else {
 921                         next = NULL;
 922                 }
 923         }
 924 }
 925
 926 /*
 927  * Initialize a static or newly allocated reaper structure
 928  */
 929 void
 930 reaper_init(struct proc *p, struct sysreaper *reap)
 931 {
 932         reap->parent = p->p_reaper;
 933         reap->p = p;
 934         if (p == initproc) {
 935                 reap->flags = REAPER_STAT_OWNED | REAPER_STAT_REALINIT;
 936                 reap->refs = 2;
 937         } else {
 938                 reap->flags = REAPER_STAT_OWNED;
 939                 reap->refs = 1;
 940         }
 941         lockinit(&reap->lock, "subrp", 0, 0);
 942         cpu_sfence();
 943         p->p_reaper = reap;
 944 }
 945
 946 /*
 947  * Called with p->p_token held during exit.
 948  *
 949  * This is a bit simpler than RELEASE because there are no threads remaining
 950  * to race.  We only release if we own the reaper, the exit code will handle
 951  * the final p_reaper release.
 952  */
 953 struct sysreaper *
 954 reaper_exit(struct proc *p)
 955 {
 956         struct sysreaper *reap;
 957
 958         /*
 959          * Release acquired reaper
 960          */
 961         if ((reap = p->p_reaper) != NULL && reap->p == p) {
 962                 lockmgr(&reap->lock, LK_EXCLUSIVE);
 963                 p->p_reaper = reap->parent;
 964                 if (p->p_reaper)
 965                         reaper_hold(p->p_reaper);
 966                 reap->p = NULL;
 967                 lockmgr(&reap->lock, LK_RELEASE);
 968                 reaper_drop(reap);
 969         }
 970
 971         /*
 972          * Return and clear reaper (caller is holding p_token for us)
 973          * (reap->p does not equal p).  Caller must drop it.
 974          */
 975         if ((reap = p->p_reaper) != NULL) {
 976                 p->p_reaper = NULL;
 977         }
 978         return reap;
 979 }
 980
 981 /*
 982  * Return a held (PHOLD) process representing the reaper for process (p).
 983  * NULL should not normally be returned.  Caller should PRELE() the returned
 984  * reaper process when finished.
 985  *
 986  * Remove dead internal nodes while we are at it.
 987  *
 988  * Process (p)'s token must be held on call.
 989  * The returned process's token is NOT acquired by this routine.
 990  */
 991 struct proc *
 992 reaper_get(struct sysreaper *reap)
 993 {
 994         struct sysreaper *next;
 995         struct proc *reproc;
 996
 997         if (reap == NULL)
 998                 return NULL;
 999
1000         /*
1001          * Extra hold for loop
1002          */
1003         reaper_hold(reap);
1004
1005         while (reap) {
1006                 lockmgr(&reap->lock, LK_SHARED);
1007                 if (reap->p) {
1008                         /*
1009                          * Probable reaper
1010                          */
1011                         if (reap->p) {
1012                                 reproc = reap->p;
1013                                 PHOLD(reproc);
1014                                 lockmgr(&reap->lock, LK_RELEASE);
1015                                 reaper_drop(reap);
1016                                 return reproc;
1017                         }
1018
1019                         /*
1020                          * Raced, try again
1021                          */
1022                         lockmgr(&reap->lock, LK_RELEASE);
1023                         continue;
1024                 }
1025
1026                 /*
1027                  * Traverse upwards in the reaper topology, destroy
1028                  * dead internal nodes when possible.
1029                  *
1030                  * NOTE: Our ref on next means that a dead node should
1031                  *       have 2 (ours and reap->parent's).
1032                  */
1033                 next = reap->parent;
1034                 while (next) {
1035                         reaper_hold(next);
1036                         if (next->refs == 2 && next->p == NULL) {
1037                                 lockmgr(&reap->lock, LK_RELEASE);
1038                                 lockmgr(&reap->lock, LK_EXCLUSIVE);
1039                                 if (next->refs == 2 &&
1040                                     reap->parent == next &&
1041                                     next->p == NULL) {
1042                                         /*
1043                                          * reap->parent inherits ref from next.
1044                                          */
1045                                         reap->parent = next->parent;
1046                                         next->parent = NULL;
1047                                         reaper_drop(next);      /* ours */
1048                                         reaper_drop(next);      /* old parent */
1049                                         next = reap->parent;
1050                                         continue;       /* possible chain */
1051                                 }
1052                         }
1053                         break;
1054                 }
1055                 lockmgr(&reap->lock, LK_RELEASE);
1056                 reaper_drop(reap);
1057                 reap = next;
1058         }
1059         return NULL;
1060 }