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. 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_fork.c 8.6 (Berkeley) 4/8/94
  39  * $FreeBSD: src/sys/kern/kern_fork.c,v 1.72.2.13 2003/06/06 20:21:32 tegge Exp $
  40  * $DragonFly: src/sys/kern/kern_fork.c,v 1.3 2003/06/18 06:33:37 dillon Exp $
  41  */
  42
  43 #include "opt_ktrace.h"
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/sysproto.h>
  48 #include <sys/filedesc.h>
  49 #include <sys/kernel.h>
  50 #include <sys/sysctl.h>
  51 #include <sys/malloc.h>
  52 #include <sys/proc.h>
  53 #include <sys/resourcevar.h>
  54 #include <sys/vnode.h>
  55 #include <sys/acct.h>
  56 #include <sys/ktrace.h>
  57 #include <sys/unistd.h>
  58 #include <sys/jail.h>
  59
  60 #include <vm/vm.h>
  61 #include <sys/lock.h>
  62 #include <vm/pmap.h>
  63 #include <vm/vm_map.h>
  64 #include <vm/vm_extern.h>
  65 #include <vm/vm_zone.h>
  66
  67 #include <sys/vmmeter.h>
  68 #include <sys/user.h>
  69
  70 static MALLOC_DEFINE(M_ATFORK, "atfork", "atfork callback");
  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 #ifndef _SYS_SYSPROTO_H_
  85 struct fork_args {
  86         int     dummy;
  87 };
  88 #endif
  89
  90 int forksleep; /* Place for fork1() to sleep on. */
  91
  92 /* ARGSUSED */
  93 int
  94 fork(p, uap)
  95         struct proc *p;
  96         struct fork_args *uap;
  97 {
  98         int error;
  99         struct proc *p2;
 100
 101         error = fork1(p, RFFDG | RFPROC, &p2);
 102         if (error == 0) {
 103                 p->p_retval[0] = p2->p_pid;
 104                 p->p_retval[1] = 0;
 105         }
 106         return error;
 107 }
 108
 109 /* ARGSUSED */
 110 int
 111 vfork(p, uap)
 112         struct proc *p;
 113         struct vfork_args *uap;
 114 {
 115         int error;
 116         struct proc *p2;
 117
 118         error = fork1(p, RFFDG | RFPROC | RFPPWAIT | RFMEM, &p2);
 119         if (error == 0) {
 120                 p->p_retval[0] = p2->p_pid;
 121                 p->p_retval[1] = 0;
 122         }
 123         return error;
 124 }
 125
 126 int
 127 rfork(p, uap)
 128         struct proc *p;
 129         struct rfork_args *uap;
 130 {
 131         int error;
 132         struct proc *p2;
 133
 134         error = fork1(p, uap->flags, &p2);
 135         if (error == 0) {
 136                 p->p_retval[0] = p2 ? p2->p_pid : 0;
 137                 p->p_retval[1] = 0;
 138         }
 139         return error;
 140 }
 141
 142
 143 int     nprocs = 1;             /* process 0 */
 144 static int nextpid = 0;
 145
 146 /*
 147  * Random component to nextpid generation.  We mix in a random factor to make
 148  * it a little harder to predict.  We sanity check the modulus value to avoid
 149  * doing it in critical paths.  Don't let it be too small or we pointlessly
 150  * waste randomness entropy, and don't let it be impossibly large.  Using a
 151  * modulus that is too big causes a LOT more process table scans and slows
 152  * down fork processing as the pidchecked caching is defeated.
 153  */
 154 static int randompid = 0;
 155
 156 static int
 157 sysctl_kern_randompid(SYSCTL_HANDLER_ARGS)
 158 {
 159                 int error, pid;
 160
 161                 pid = randompid;
 162                 error = sysctl_handle_int(oidp, &pid, 0, req);
 163                 if (error || !req->newptr)
 164                         return (error);
 165                 if (pid < 0 || pid > PID_MAX - 100)     /* out of range */
 166                         pid = PID_MAX - 100;
 167                 else if (pid < 2)                       /* NOP */
 168                         pid = 0;
 169                 else if (pid < 100)                     /* Make it reasonable */
 170                         pid = 100;
 171                 randompid = pid;
 172                 return (error);
 173 }
 174
 175 SYSCTL_PROC(_kern, OID_AUTO, randompid, CTLTYPE_INT|CTLFLAG_RW,
 176     0, 0, sysctl_kern_randompid, "I", "Random PID modulus");
 177
 178 int
 179 fork1(p1, flags, procp)
 180         struct proc *p1;
 181         int flags;
 182         struct proc **procp;
 183 {
 184         struct proc *p2, *pptr;
 185         uid_t uid;
 186         struct proc *newproc;
 187         int ok;
 188         static int pidchecked = 0;
 189         struct forklist *ep;
 190         struct filedesc_to_leader *fdtol;
 191
 192         if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
 193                 return (EINVAL);
 194
 195         /*
 196          * Here we don't create a new process, but we divorce
 197          * certain parts of a process from itself.
 198          */
 199         if ((flags & RFPROC) == 0) {
 200
 201                 vm_fork(p1, 0, flags);
 202
 203                 /*
 204                  * Close all file descriptors.
 205                  */
 206                 if (flags & RFCFDG) {
 207                         struct filedesc *fdtmp;
 208                         fdtmp = fdinit(p1);
 209                         fdfree(p1);
 210                         p1->p_fd = fdtmp;
 211                 }
 212
 213                 /*
 214                  * Unshare file descriptors (from parent.)
 215                  */
 216                 if (flags & RFFDG) {
 217                         if (p1->p_fd->fd_refcnt > 1) {
 218                                 struct filedesc *newfd;
 219                                 newfd = fdcopy(p1);
 220                                 fdfree(p1);
 221                                 p1->p_fd = newfd;
 222                         }
 223                 }
 224                 *procp = NULL;
 225                 return (0);
 226         }
 227
 228         /*
 229          * Although process entries are dynamically created, we still keep
 230          * a global limit on the maximum number we will create.  Don't allow
 231          * a nonprivileged user to use the last ten processes; don't let root
 232          * exceed the limit. The variable nprocs is the current number of
 233          * processes, maxproc is the limit.
 234          */
 235         uid = p1->p_cred->p_ruid;
 236         if ((nprocs >= maxproc - 10 && uid != 0) || nprocs >= maxproc) {
 237                 tsleep(&forksleep, PUSER, "fork", hz / 2);
 238                 return (EAGAIN);
 239         }
 240         /*
 241          * Increment the nprocs resource before blocking can occur.  There
 242          * are hard-limits as to the number of processes that can run.
 243          */
 244         nprocs++;
 245
 246         /*
 247          * Increment the count of procs running with this uid. Don't allow
 248          * a nonprivileged user to exceed their current limit.
 249          */
 250         ok = chgproccnt(p1->p_cred->p_uidinfo, 1,
 251                 (uid != 0) ? p1->p_rlimit[RLIMIT_NPROC].rlim_cur : 0);
 252         if (!ok) {
 253                 /*
 254                  * Back out the process count
 255                  */
 256                 nprocs--;
 257                 tsleep(&forksleep, PUSER, "fork", hz / 2);
 258                 return (EAGAIN);
 259         }
 260
 261         /* Allocate new proc. */
 262         newproc = zalloc(proc_zone);
 263
 264         /*
 265          * Setup linkage for kernel based threading
 266          */
 267         if((flags & RFTHREAD) != 0) {
 268                 newproc->p_peers = p1->p_peers;
 269                 p1->p_peers = newproc;
 270                 newproc->p_leader = p1->p_leader;
 271         } else {
 272                 newproc->p_peers = 0;
 273                 newproc->p_leader = newproc;
 274         }
 275
 276         newproc->p_wakeup = 0;
 277         newproc->p_thread.td_proc = newproc; /* YYY */
 278
 279         newproc->p_vmspace = NULL;
 280
 281         /*
 282          * Find an unused process ID.  We remember a range of unused IDs
 283          * ready to use (from nextpid+1 through pidchecked-1).
 284          */
 285         nextpid++;
 286         if (randompid)
 287                 nextpid += arc4random() % randompid;
 288 retry:
 289         /*
 290          * If the process ID prototype has wrapped around,
 291          * restart somewhat above 0, as the low-numbered procs
 292          * tend to include daemons that don't exit.
 293          */
 294         if (nextpid >= PID_MAX) {
 295                 nextpid = nextpid % PID_MAX;
 296                 if (nextpid < 100)
 297                         nextpid += 100;
 298                 pidchecked = 0;
 299         }
 300         if (nextpid >= pidchecked) {
 301                 int doingzomb = 0;
 302
 303                 pidchecked = PID_MAX;
 304                 /*
 305                  * Scan the active and zombie procs to check whether this pid
 306                  * is in use.  Remember the lowest pid that's greater
 307                  * than nextpid, so we can avoid checking for a while.
 308                  */
 309                 p2 = LIST_FIRST(&allproc);
 310 again:
 311                 for (; p2 != 0; p2 = LIST_NEXT(p2, p_list)) {
 312                         while (p2->p_pid == nextpid ||
 313                             p2->p_pgrp->pg_id == nextpid ||
 314                             p2->p_session->s_sid == nextpid) {
 315                                 nextpid++;
 316                                 if (nextpid >= pidchecked)
 317                                         goto retry;
 318                         }
 319                         if (p2->p_pid > nextpid && pidchecked > p2->p_pid)
 320                                 pidchecked = p2->p_pid;
 321                         if (p2->p_pgrp->pg_id > nextpid &&
 322                             pidchecked > p2->p_pgrp->pg_id)
 323                                 pidchecked = p2->p_pgrp->pg_id;
 324                         if (p2->p_session->s_sid > nextpid &&
 325                             pidchecked > p2->p_session->s_sid)
 326                                 pidchecked = p2->p_session->s_sid;
 327                 }
 328                 if (!doingzomb) {
 329                         doingzomb = 1;
 330                         p2 = LIST_FIRST(&zombproc);
 331                         goto again;
 332                 }
 333         }
 334
 335         p2 = newproc;
 336         p2->p_stat = SIDL;                      /* protect against others */
 337         p2->p_pid = nextpid;
 338         LIST_INSERT_HEAD(&allproc, p2, p_list);
 339         LIST_INSERT_HEAD(PIDHASH(p2->p_pid), p2, p_hash);
 340
 341         /*
 342          * Make a proc table entry for the new process.
 343          * Start by zeroing the section of proc that is zero-initialized,
 344          * then copy the section that is copied directly from the parent.
 345          */
 346         bzero(&p2->p_startzero,
 347             (unsigned) ((caddr_t)&p2->p_endzero - (caddr_t)&p2->p_startzero));
 348         bcopy(&p1->p_startcopy, &p2->p_startcopy,
 349             (unsigned) ((caddr_t)&p2->p_endcopy - (caddr_t)&p2->p_startcopy));
 350
 351         p2->p_aioinfo = NULL;
 352
 353         /*
 354          * Duplicate sub-structures as needed.
 355          * Increase reference counts on shared objects.
 356          * The p_stats and p_sigacts substructs are set in vm_fork.
 357          */
 358         p2->p_flag = P_INMEM;
 359         if (p1->p_flag & P_PROFIL)
 360                 startprofclock(p2);
 361         MALLOC(p2->p_cred, struct pcred *, sizeof(struct pcred),
 362             M_SUBPROC, M_WAITOK);
 363         bcopy(p1->p_cred, p2->p_cred, sizeof(*p2->p_cred));
 364         p2->p_cred->p_refcnt = 1;
 365         crhold(p1->p_ucred);
 366         uihold(p1->p_cred->p_uidinfo);
 367
 368         if (p2->p_prison) {
 369                 p2->p_prison->pr_ref++;
 370                 p2->p_flag |= P_JAILED;
 371         }
 372
 373         if (p2->p_args)
 374                 p2->p_args->ar_ref++;
 375
 376         if (flags & RFSIGSHARE) {
 377                 p2->p_procsig = p1->p_procsig;
 378                 p2->p_procsig->ps_refcnt++;
 379                 if (p1->p_sigacts == &p1->p_addr->u_sigacts) {
 380                         struct sigacts *newsigacts;
 381                         int s;
 382
 383                         /* Create the shared sigacts structure */
 384                         MALLOC(newsigacts, struct sigacts *,
 385                             sizeof(struct sigacts), M_SUBPROC, M_WAITOK);
 386                         s = splhigh();
 387                         /*
 388                          * Set p_sigacts to the new shared structure.
 389                          * Note that this is updating p1->p_sigacts at the
 390                          * same time, since p_sigacts is just a pointer to
 391                          * the shared p_procsig->ps_sigacts.
 392                          */
 393                         p2->p_sigacts  = newsigacts;
 394                         bcopy(&p1->p_addr->u_sigacts, p2->p_sigacts,
 395                             sizeof(*p2->p_sigacts));
 396                         *p2->p_sigacts = p1->p_addr->u_sigacts;
 397                         splx(s);
 398                 }
 399         } else {
 400                 MALLOC(p2->p_procsig, struct procsig *, sizeof(struct procsig),
 401                     M_SUBPROC, M_WAITOK);
 402                 bcopy(p1->p_procsig, p2->p_procsig, sizeof(*p2->p_procsig));
 403                 p2->p_procsig->ps_refcnt = 1;
 404                 p2->p_sigacts = NULL;   /* finished in vm_fork() */
 405         }
 406         if (flags & RFLINUXTHPN)
 407                 p2->p_sigparent = SIGUSR1;
 408         else
 409                 p2->p_sigparent = SIGCHLD;
 410
 411         /* bump references to the text vnode (for procfs) */
 412         p2->p_textvp = p1->p_textvp;
 413         if (p2->p_textvp)
 414                 VREF(p2->p_textvp);
 415
 416         if (flags & RFCFDG) {
 417                 p2->p_fd = fdinit(p1);
 418                 fdtol = NULL;
 419         } else if (flags & RFFDG) {
 420                 p2->p_fd = fdcopy(p1);
 421                 fdtol = NULL;
 422         } else {
 423                 p2->p_fd = fdshare(p1);
 424                 if (p1->p_fdtol == NULL)
 425                         p1->p_fdtol =
 426                                 filedesc_to_leader_alloc(NULL,
 427                                                          p1->p_leader);
 428                 if ((flags & RFTHREAD) != 0) {
 429                         /*
 430                          * Shared file descriptor table and
 431                          * shared process leaders.
 432                          */
 433                         fdtol = p1->p_fdtol;
 434                         fdtol->fdl_refcount++;
 435                 } else {
 436                         /*
 437                          * Shared file descriptor table, and
 438                          * different process leaders
 439                          */
 440                         fdtol = filedesc_to_leader_alloc(p1->p_fdtol,
 441                                                          p2);
 442                 }
 443         }
 444         p2->p_fdtol = fdtol;
 445
 446         /*
 447          * If p_limit is still copy-on-write, bump refcnt,
 448          * otherwise get a copy that won't be modified.
 449          * (If PL_SHAREMOD is clear, the structure is shared
 450          * copy-on-write.)
 451          */
 452         if (p1->p_limit->p_lflags & PL_SHAREMOD)
 453                 p2->p_limit = limcopy(p1->p_limit);
 454         else {
 455                 p2->p_limit = p1->p_limit;
 456                 p2->p_limit->p_refcnt++;
 457         }
 458
 459         /*
 460          * Preserve some more flags in subprocess.  P_PROFIL has already
 461          * been preserved.
 462          */
 463         p2->p_flag |= p1->p_flag & (P_SUGID | P_ALTSTACK);
 464         if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
 465                 p2->p_flag |= P_CONTROLT;
 466         if (flags & RFPPWAIT)
 467                 p2->p_flag |= P_PPWAIT;
 468
 469         LIST_INSERT_AFTER(p1, p2, p_pglist);
 470
 471         /*
 472          * Attach the new process to its parent.
 473          *
 474          * If RFNOWAIT is set, the newly created process becomes a child
 475          * of init.  This effectively disassociates the child from the
 476          * parent.
 477          */
 478         if (flags & RFNOWAIT)
 479                 pptr = initproc;
 480         else
 481                 pptr = p1;
 482         p2->p_pptr = pptr;
 483         LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
 484         LIST_INIT(&p2->p_children);
 485
 486 #ifdef KTRACE
 487         /*
 488          * Copy traceflag and tracefile if enabled.  If not inherited,
 489          * these were zeroed above but we still could have a trace race
 490          * so make sure p2's p_tracep is NULL.
 491          */
 492         if ((p1->p_traceflag & KTRFAC_INHERIT) && p2->p_tracep == NULL) {
 493                 p2->p_traceflag = p1->p_traceflag;
 494                 if ((p2->p_tracep = p1->p_tracep) != NULL)
 495                         VREF(p2->p_tracep);
 496         }
 497 #endif
 498
 499         /*
 500          * set priority of child to be that of parent
 501          */
 502         p2->p_estcpu = p1->p_estcpu;
 503
 504         /*
 505          * This begins the section where we must prevent the parent
 506          * from being swapped.
 507          */
 508         PHOLD(p1);
 509
 510         /*
 511          * Finish creating the child process.  It will return via a different
 512          * execution path later.  (ie: directly into user mode)
 513          */
 514         vm_fork(p1, p2, flags);
 515
 516         if (flags == (RFFDG | RFPROC)) {
 517                 cnt.v_forks++;
 518                 cnt.v_forkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
 519         } else if (flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM)) {
 520                 cnt.v_vforks++;
 521                 cnt.v_vforkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
 522         } else if (p1 == &proc0) {
 523                 cnt.v_kthreads++;
 524                 cnt.v_kthreadpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
 525         } else {
 526                 cnt.v_rforks++;
 527                 cnt.v_rforkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
 528         }
 529
 530         /*
 531          * Both processes are set up, now check if any loadable modules want
 532          * to adjust anything.
 533          *   What if they have an error? XXX
 534          */
 535         TAILQ_FOREACH(ep, &fork_list, next) {
 536                 (*ep->function)(p1, p2, flags);
 537         }
 538
 539         /*
 540          * Make child runnable and add to run queue.
 541          */
 542         microtime(&(p2->p_stats->p_start));
 543         p2->p_acflag = AFORK;
 544         (void) splhigh();
 545         p2->p_stat = SRUN;
 546         setrunqueue(p2);
 547         (void) spl0();
 548
 549         /*
 550          * Now can be swapped.
 551          */
 552         PRELE(p1);
 553
 554         /*
 555          * tell any interested parties about the new process
 556          */
 557         KNOTE(&p1->p_klist, NOTE_FORK | p2->p_pid);
 558
 559         /*
 560          * Preserve synchronization semantics of vfork.  If waiting for
 561          * child to exec or exit, set P_PPWAIT on child, and sleep on our
 562          * proc (in case of exit).
 563          */
 564         while (p2->p_flag & P_PPWAIT)
 565                 tsleep(p1, PWAIT, "ppwait", 0);
 566
 567         /*
 568          * Return child proc pointer to parent.
 569          */
 570         *procp = p2;
 571         return (0);
 572 }
 573
 574 /*
 575  * The next two functionms are general routines to handle adding/deleting
 576  * items on the fork callout list.
 577  *
 578  * at_fork():
 579  * Take the arguments given and put them onto the fork callout list,
 580  * However first make sure that it's not already there.
 581  * Returns 0 on success or a standard error number.
 582  */
 583
 584 int
 585 at_fork(function)
 586         forklist_fn function;
 587 {
 588         struct forklist *ep;
 589
 590 #ifdef INVARIANTS
 591         /* let the programmer know if he's been stupid */
 592         if (rm_at_fork(function))
 593                 printf("WARNING: fork callout entry (%p) already present\n",
 594                     function);
 595 #endif
 596         ep = malloc(sizeof(*ep), M_ATFORK, M_NOWAIT);
 597         if (ep == NULL)
 598                 return (ENOMEM);
 599         ep->function = function;
 600         TAILQ_INSERT_TAIL(&fork_list, ep, next);
 601         return (0);
 602 }
 603
 604 /*
 605  * Scan the exit callout list for the given item and remove it..
 606  * Returns the number of items removed (0 or 1)
 607  */
 608
 609 int
 610 rm_at_fork(function)
 611         forklist_fn function;
 612 {
 613         struct forklist *ep;
 614
 615         TAILQ_FOREACH(ep, &fork_list, next) {
 616                 if (ep->function == function) {
 617                         TAILQ_REMOVE(&fork_list, ep, next);
 618                         free(ep, M_ATFORK);
 619                         return(1);
 620                 }
 621         }
 622         return (0);
 623 }