sys/kern/kern_fork.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)kern_fork.c 8.6 (Berkeley) 4/8/94
  37  */
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include "opt_ktrace.h"
  43 #include "opt_kstack_pages.h"
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/sysproto.h>
  48 #include <sys/eventhandler.h>
  49 #include <sys/fcntl.h>
  50 #include <sys/filedesc.h>
  51 #include <sys/jail.h>
  52 #include <sys/kernel.h>
  53 #include <sys/kthread.h>
  54 #include <sys/sysctl.h>
  55 #include <sys/lock.h>
  56 #include <sys/malloc.h>
  57 #include <sys/mutex.h>
  58 #include <sys/priv.h>
  59 #include <sys/proc.h>
  60 #include <sys/procdesc.h>
  61 #include <sys/pioctl.h>
  62 #include <sys/ptrace.h>
  63 #include <sys/racct.h>
  64 #include <sys/resourcevar.h>
  65 #include <sys/sched.h>
  66 #include <sys/syscall.h>
  67 #include <sys/vmmeter.h>
  68 #include <sys/vnode.h>
  69 #include <sys/acct.h>
  70 #include <sys/ktr.h>
  71 #include <sys/ktrace.h>
  72 #include <sys/unistd.h>
  73 #include <sys/sdt.h>
  74 #include <sys/sx.h>
  75 #include <sys/sysent.h>
  76 #include <sys/signalvar.h>
  77
  78 #include <security/audit/audit.h>
  79 #include <security/mac/mac_framework.h>
  80
  81 #include <vm/vm.h>
  82 #include <vm/pmap.h>
  83 #include <vm/vm_map.h>
  84 #include <vm/vm_extern.h>
  85 #include <vm/uma.h>
  86
  87 #ifdef KDTRACE_HOOKS
  88 #include <sys/dtrace_bsd.h>
  89 dtrace_fork_func_t      dtrace_fasttrap_fork;
  90 #endif
  91
  92 SDT_PROVIDER_DECLARE(proc);
  93 SDT_PROBE_DEFINE3(proc, , , create, "struct proc *", "struct proc *", "int");
  94
  95 #ifndef _SYS_SYSPROTO_H_
  96 struct fork_args {
  97         int     dummy;
  98 };
  99 #endif
 100
 101 EVENTHANDLER_LIST_DECLARE(process_fork);
 102
 103 /* ARGSUSED */
 104 int
 105 sys_fork(struct thread *td, struct fork_args *uap)
 106 {
 107         struct fork_req fr;
 108         int error, pid;
 109
 110         bzero(&fr, sizeof(fr));
 111         fr.fr_flags = RFFDG | RFPROC;
 112         fr.fr_pidp = &pid;
 113         error = fork1(td, &fr);
 114         if (error == 0) {
 115                 td->td_retval[0] = pid;
 116                 td->td_retval[1] = 0;
 117         }
 118         return (error);
 119 }
 120
 121 /* ARGUSED */
 122 int
 123 sys_pdfork(struct thread *td, struct pdfork_args *uap)
 124 {
 125         struct fork_req fr;
 126         int error, fd, pid;
 127
 128         bzero(&fr, sizeof(fr));
 129         fr.fr_flags = RFFDG | RFPROC | RFPROCDESC;
 130         fr.fr_pidp = &pid;
 131         fr.fr_pd_fd = &fd;
 132         fr.fr_pd_flags = uap->flags;
 133         /*
 134          * It is necessary to return fd by reference because 0 is a valid file
 135          * descriptor number, and the child needs to be able to distinguish
 136          * itself from the parent using the return value.
 137          */
 138         error = fork1(td, &fr);
 139         if (error == 0) {
 140                 td->td_retval[0] = pid;
 141                 td->td_retval[1] = 0;
 142                 error = copyout(&fd, uap->fdp, sizeof(fd));
 143         }
 144         return (error);
 145 }
 146
 147 /* ARGSUSED */
 148 int
 149 sys_vfork(struct thread *td, struct vfork_args *uap)
 150 {
 151         struct fork_req fr;
 152         int error, pid;
 153
 154         bzero(&fr, sizeof(fr));
 155         fr.fr_flags = RFFDG | RFPROC | RFPPWAIT | RFMEM;
 156         fr.fr_pidp = &pid;
 157         error = fork1(td, &fr);
 158         if (error == 0) {
 159                 td->td_retval[0] = pid;
 160                 td->td_retval[1] = 0;
 161         }
 162         return (error);
 163 }
 164
 165 int
 166 sys_rfork(struct thread *td, struct rfork_args *uap)
 167 {
 168         struct fork_req fr;
 169         int error, pid;
 170
 171         /* Don't allow kernel-only flags. */
 172         if ((uap->flags & RFKERNELONLY) != 0)
 173                 return (EINVAL);
 174
 175         AUDIT_ARG_FFLAGS(uap->flags);
 176         bzero(&fr, sizeof(fr));
 177         fr.fr_flags = uap->flags;
 178         fr.fr_pidp = &pid;
 179         error = fork1(td, &fr);
 180         if (error == 0) {
 181                 td->td_retval[0] = pid;
 182                 td->td_retval[1] = 0;
 183         }
 184         return (error);
 185 }
 186
 187 int     nprocs = 1;             /* process 0 */
 188 int     lastpid = 0;
 189 SYSCTL_INT(_kern, OID_AUTO, lastpid, CTLFLAG_RD, &lastpid, 0,
 190     "Last used PID");
 191
 192 /*
 193  * Random component to lastpid generation.  We mix in a random factor to make
 194  * it a little harder to predict.  We sanity check the modulus value to avoid
 195  * doing it in critical paths.  Don't let it be too small or we pointlessly
 196  * waste randomness entropy, and don't let it be impossibly large.  Using a
 197  * modulus that is too big causes a LOT more process table scans and slows
 198  * down fork processing as the pidchecked caching is defeated.
 199  */
 200 static int randompid = 0;
 201
 202 static int
 203 sysctl_kern_randompid(SYSCTL_HANDLER_ARGS)
 204 {
 205         int error, pid;
 206
 207         error = sysctl_wire_old_buffer(req, sizeof(int));
 208         if (error != 0)
 209                 return(error);
 210         sx_xlock(&allproc_lock);
 211         pid = randompid;
 212         error = sysctl_handle_int(oidp, &pid, 0, req);
 213         if (error == 0 && req->newptr != NULL) {
 214                 if (pid == 0)
 215                         randompid = 0;
 216                 else if (pid == 1)
 217                         /* generate a random PID modulus between 100 and 1123 */
 218                         randompid = 100 + arc4random() % 1024;
 219                 else if (pid < 0 || pid > pid_max - 100)
 220                         /* out of range */
 221                         randompid = pid_max - 100;
 222                 else if (pid < 100)
 223                         /* Make it reasonable */
 224                         randompid = 100;
 225                 else
 226                         randompid = pid;
 227         }
 228         sx_xunlock(&allproc_lock);
 229         return (error);
 230 }
 231
 232 SYSCTL_PROC(_kern, OID_AUTO, randompid, CTLTYPE_INT|CTLFLAG_RW,
 233     0, 0, sysctl_kern_randompid, "I", "Random PID modulus. Special values: 0: disable, 1: choose random value");
 234
 235 static int
 236 fork_findpid(int flags)
 237 {
 238         struct proc *p;
 239         int trypid;
 240         static int pidchecked = 0;
 241
 242         /*
 243          * Requires allproc_lock in order to iterate over the list
 244          * of processes, and proctree_lock to access p_pgrp.
 245          */
 246         sx_assert(&allproc_lock, SX_LOCKED);
 247         sx_assert(&proctree_lock, SX_LOCKED);
 248
 249         /*
 250          * Find an unused process ID.  We remember a range of unused IDs
 251          * ready to use (from lastpid+1 through pidchecked-1).
 252          *
 253          * If RFHIGHPID is set (used during system boot), do not allocate
 254          * low-numbered pids.
 255          */
 256         trypid = lastpid + 1;
 257         if (flags & RFHIGHPID) {
 258                 if (trypid < 10)
 259                         trypid = 10;
 260         } else {
 261                 if (randompid)
 262                         trypid += arc4random() % randompid;
 263         }
 264 retry:
 265         /*
 266          * If the process ID prototype has wrapped around,
 267          * restart somewhat above 0, as the low-numbered procs
 268          * tend to include daemons that don't exit.
 269          */
 270         if (trypid >= pid_max) {
 271                 trypid = trypid % pid_max;
 272                 if (trypid < 100)
 273                         trypid += 100;
 274                 pidchecked = 0;
 275         }
 276         if (trypid >= pidchecked) {
 277                 int doingzomb = 0;
 278
 279                 pidchecked = PID_MAX;
 280                 /*
 281                  * Scan the active and zombie procs to check whether this pid
 282                  * is in use.  Remember the lowest pid that's greater
 283                  * than trypid, so we can avoid checking for a while.
 284                  *
 285                  * Avoid reuse of the process group id, session id or
 286                  * the reaper subtree id.  Note that for process group
 287                  * and sessions, the amount of reserved pids is
 288                  * limited by process limit.  For the subtree ids, the
 289                  * id is kept reserved only while there is a
 290                  * non-reaped process in the subtree, so amount of
 291                  * reserved pids is limited by process limit times
 292                  * two.
 293                  */
 294                 p = LIST_FIRST(&allproc);
 295 again:
 296                 for (; p != NULL; p = LIST_NEXT(p, p_list)) {
 297                         while (p->p_pid == trypid ||
 298                             p->p_reapsubtree == trypid ||
 299                             (p->p_pgrp != NULL &&
 300                             (p->p_pgrp->pg_id == trypid ||
 301                             (p->p_session != NULL &&
 302                             p->p_session->s_sid == trypid)))) {
 303                                 trypid++;
 304                                 if (trypid >= pidchecked)
 305                                         goto retry;
 306                         }
 307                         if (p->p_pid > trypid && pidchecked > p->p_pid)
 308                                 pidchecked = p->p_pid;
 309                         if (p->p_pgrp != NULL) {
 310                                 if (p->p_pgrp->pg_id > trypid &&
 311                                     pidchecked > p->p_pgrp->pg_id)
 312                                         pidchecked = p->p_pgrp->pg_id;
 313                                 if (p->p_session != NULL &&
 314                                     p->p_session->s_sid > trypid &&
 315                                     pidchecked > p->p_session->s_sid)
 316                                         pidchecked = p->p_session->s_sid;
 317                         }
 318                 }
 319                 if (!doingzomb) {
 320                         doingzomb = 1;
 321                         p = LIST_FIRST(&zombproc);
 322                         goto again;
 323                 }
 324         }
 325
 326         /*
 327          * RFHIGHPID does not mess with the lastpid counter during boot.
 328          */
 329         if (flags & RFHIGHPID)
 330                 pidchecked = 0;
 331         else
 332                 lastpid = trypid;
 333
 334         return (trypid);
 335 }
 336
 337 static int
 338 fork_norfproc(struct thread *td, int flags)
 339 {
 340         int error;
 341         struct proc *p1;
 342
 343         KASSERT((flags & RFPROC) == 0,
 344             ("fork_norfproc called with RFPROC set"));
 345         p1 = td->td_proc;
 346
 347         if (((p1->p_flag & (P_HADTHREADS|P_SYSTEM)) == P_HADTHREADS) &&
 348             (flags & (RFCFDG | RFFDG))) {
 349                 PROC_LOCK(p1);
 350                 if (thread_single(p1, SINGLE_BOUNDARY)) {
 351                         PROC_UNLOCK(p1);
 352                         return (ERESTART);
 353                 }
 354                 PROC_UNLOCK(p1);
 355         }
 356
 357         error = vm_forkproc(td, NULL, NULL, NULL, flags);
 358         if (error)
 359                 goto fail;
 360
 361         /*
 362          * Close all file descriptors.
 363          */
 364         if (flags & RFCFDG) {
 365                 struct filedesc *fdtmp;
 366                 fdtmp = fdinit(td->td_proc->p_fd, false);
 367                 fdescfree(td);
 368                 p1->p_fd = fdtmp;
 369         }
 370
 371         /*
 372          * Unshare file descriptors (from parent).
 373          */
 374         if (flags & RFFDG)
 375                 fdunshare(td);
 376
 377 fail:
 378         if (((p1->p_flag & (P_HADTHREADS|P_SYSTEM)) == P_HADTHREADS) &&
 379             (flags & (RFCFDG | RFFDG))) {
 380                 PROC_LOCK(p1);
 381                 thread_single_end(p1, SINGLE_BOUNDARY);
 382                 PROC_UNLOCK(p1);
 383         }
 384         return (error);
 385 }
 386
 387 static void
 388 do_fork(struct thread *td, struct fork_req *fr, struct proc *p2, struct thread *td2,
 389     struct vmspace *vm2, struct file *fp_procdesc)
 390 {
 391         struct proc *p1, *pptr;
 392         int trypid;
 393         struct filedesc *fd;
 394         struct filedesc_to_leader *fdtol;
 395         struct sigacts *newsigacts;
 396
 397         sx_assert(&proctree_lock, SX_LOCKED);
 398         sx_assert(&allproc_lock, SX_XLOCKED);
 399
 400         p1 = td->td_proc;
 401
 402         trypid = fork_findpid(fr->fr_flags);
 403
 404         p2->p_state = PRS_NEW;          /* protect against others */
 405         p2->p_pid = trypid;
 406         AUDIT_ARG_PID(p2->p_pid);
 407         LIST_INSERT_HEAD(&allproc, p2, p_list);
 408         allproc_gen++;
 409         LIST_INSERT_HEAD(PIDHASH(p2->p_pid), p2, p_hash);
 410         PROC_LOCK(p2);
 411         PROC_LOCK(p1);
 412
 413         sx_xunlock(&allproc_lock);
 414         sx_xunlock(&proctree_lock);
 415
 416         bcopy(&p1->p_startcopy, &p2->p_startcopy,
 417             __rangeof(struct proc, p_startcopy, p_endcopy));
 418         p2->p_fctl0 = p1->p_fctl0;
 419         pargs_hold(p2->p_args);
 420
 421         PROC_UNLOCK(p1);
 422
 423         bzero(&p2->p_startzero,
 424             __rangeof(struct proc, p_startzero, p_endzero));
 425
 426         /* Tell the prison that we exist. */
 427         prison_proc_hold(p2->p_ucred->cr_prison);
 428
 429         PROC_UNLOCK(p2);
 430
 431         tidhash_add(td2);
 432
 433         /*
 434          * Malloc things while we don't hold any locks.
 435          */
 436         if (fr->fr_flags & RFSIGSHARE)
 437                 newsigacts = NULL;
 438         else
 439                 newsigacts = sigacts_alloc();
 440
 441         /*
 442          * Copy filedesc.
 443          */
 444         if (fr->fr_flags & RFCFDG) {
 445                 fd = fdinit(p1->p_fd, false);
 446                 fdtol = NULL;
 447         } else if (fr->fr_flags & RFFDG) {
 448                 fd = fdcopy(p1->p_fd);
 449                 fdtol = NULL;
 450         } else {
 451                 fd = fdshare(p1->p_fd);
 452                 if (p1->p_fdtol == NULL)
 453                         p1->p_fdtol = filedesc_to_leader_alloc(NULL, NULL,
 454                             p1->p_leader);
 455                 if ((fr->fr_flags & RFTHREAD) != 0) {
 456                         /*
 457                          * Shared file descriptor table, and shared
 458                          * process leaders.
 459                          */
 460                         fdtol = p1->p_fdtol;
 461                         FILEDESC_XLOCK(p1->p_fd);
 462                         fdtol->fdl_refcount++;
 463                         FILEDESC_XUNLOCK(p1->p_fd);
 464                 } else {
 465                         /*
 466                          * Shared file descriptor table, and different
 467                          * process leaders.
 468                          */
 469                         fdtol = filedesc_to_leader_alloc(p1->p_fdtol,
 470                             p1->p_fd, p2);
 471                 }
 472         }
 473         /*
 474          * Make a proc table entry for the new process.
 475          * Start by zeroing the section of proc that is zero-initialized,
 476          * then copy the section that is copied directly from the parent.
 477          */
 478
 479         PROC_LOCK(p2);
 480         PROC_LOCK(p1);
 481
 482         bzero(&td2->td_startzero,
 483             __rangeof(struct thread, td_startzero, td_endzero));
 484
 485         bcopy(&td->td_startcopy, &td2->td_startcopy,
 486             __rangeof(struct thread, td_startcopy, td_endcopy));
 487
 488         bcopy(&p2->p_comm, &td2->td_name, sizeof(td2->td_name));
 489         td2->td_sigstk = td->td_sigstk;
 490         td2->td_flags = TDF_INMEM;
 491         td2->td_lend_user_pri = PRI_MAX;
 492
 493 #ifdef VIMAGE
 494         td2->td_vnet = NULL;
 495         td2->td_vnet_lpush = NULL;
 496 #endif
 497
 498         /*
 499          * Allow the scheduler to initialize the child.
 500          */
 501         thread_lock(td);
 502         sched_fork(td, td2);
 503         thread_unlock(td);
 504
 505         /*
 506          * Duplicate sub-structures as needed.
 507          * Increase reference counts on shared objects.
 508          */
 509         p2->p_flag = P_INMEM;
 510         p2->p_flag2 = p1->p_flag2 & (P2_NOTRACE | P2_NOTRACE_EXEC | P2_TRAPCAP);
 511         p2->p_swtick = ticks;
 512         if (p1->p_flag & P_PROFIL)
 513                 startprofclock(p2);
 514
 515         if (fr->fr_flags & RFSIGSHARE) {
 516                 p2->p_sigacts = sigacts_hold(p1->p_sigacts);
 517         } else {
 518                 sigacts_copy(newsigacts, p1->p_sigacts);
 519                 p2->p_sigacts = newsigacts;
 520         }
 521
 522         if (fr->fr_flags & RFTSIGZMB)
 523                 p2->p_sigparent = RFTSIGNUM(fr->fr_flags);
 524         else if (fr->fr_flags & RFLINUXTHPN)
 525                 p2->p_sigparent = SIGUSR1;
 526         else
 527                 p2->p_sigparent = SIGCHLD;
 528
 529         p2->p_textvp = p1->p_textvp;
 530         p2->p_fd = fd;
 531         p2->p_fdtol = fdtol;
 532
 533         if (p1->p_flag2 & P2_INHERIT_PROTECTED) {
 534                 p2->p_flag |= P_PROTECTED;
 535                 p2->p_flag2 |= P2_INHERIT_PROTECTED;
 536         }
 537
 538         /*
 539          * p_limit is copy-on-write.  Bump its refcount.
 540          */
 541         lim_fork(p1, p2);
 542
 543         thread_cow_get_proc(td2, p2);
 544
 545         pstats_fork(p1->p_stats, p2->p_stats);
 546
 547         PROC_UNLOCK(p1);
 548         PROC_UNLOCK(p2);
 549
 550         /* Bump references to the text vnode (for procfs). */
 551         if (p2->p_textvp)
 552                 vrefact(p2->p_textvp);
 553
 554         /*
 555          * Set up linkage for kernel based threading.
 556          */
 557         if ((fr->fr_flags & RFTHREAD) != 0) {
 558                 mtx_lock(&ppeers_lock);
 559                 p2->p_peers = p1->p_peers;
 560                 p1->p_peers = p2;
 561                 p2->p_leader = p1->p_leader;
 562                 mtx_unlock(&ppeers_lock);
 563                 PROC_LOCK(p1->p_leader);
 564                 if ((p1->p_leader->p_flag & P_WEXIT) != 0) {
 565                         PROC_UNLOCK(p1->p_leader);
 566                         /*
 567                          * The task leader is exiting, so process p1 is
 568                          * going to be killed shortly.  Since p1 obviously
 569                          * isn't dead yet, we know that the leader is either
 570                          * sending SIGKILL's to all the processes in this
 571                          * task or is sleeping waiting for all the peers to
 572                          * exit.  We let p1 complete the fork, but we need
 573                          * to go ahead and kill the new process p2 since
 574                          * the task leader may not get a chance to send
 575                          * SIGKILL to it.  We leave it on the list so that
 576                          * the task leader will wait for this new process
 577                          * to commit suicide.
 578                          */
 579                         PROC_LOCK(p2);
 580                         kern_psignal(p2, SIGKILL);
 581                         PROC_UNLOCK(p2);
 582                 } else
 583                         PROC_UNLOCK(p1->p_leader);
 584         } else {
 585                 p2->p_peers = NULL;
 586                 p2->p_leader = p2;
 587         }
 588
 589         sx_xlock(&proctree_lock);
 590         PGRP_LOCK(p1->p_pgrp);
 591         PROC_LOCK(p2);
 592         PROC_LOCK(p1);
 593
 594         /*
 595          * Preserve some more flags in subprocess.  P_PROFIL has already
 596          * been preserved.
 597          */
 598         p2->p_flag |= p1->p_flag & P_SUGID;
 599         td2->td_pflags |= (td->td_pflags & TDP_ALTSTACK) | TDP_FORKING;
 600         SESS_LOCK(p1->p_session);
 601         if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
 602                 p2->p_flag |= P_CONTROLT;
 603         SESS_UNLOCK(p1->p_session);
 604         if (fr->fr_flags & RFPPWAIT)
 605                 p2->p_flag |= P_PPWAIT;
 606
 607         p2->p_pgrp = p1->p_pgrp;
 608         LIST_INSERT_AFTER(p1, p2, p_pglist);
 609         PGRP_UNLOCK(p1->p_pgrp);
 610         LIST_INIT(&p2->p_children);
 611         LIST_INIT(&p2->p_orphans);
 612
 613         callout_init_mtx(&p2->p_itcallout, &p2->p_mtx, 0);
 614
 615         /*
 616          * If PF_FORK is set, the child process inherits the
 617          * procfs ioctl flags from its parent.
 618          */
 619         if (p1->p_pfsflags & PF_FORK) {
 620                 p2->p_stops = p1->p_stops;
 621                 p2->p_pfsflags = p1->p_pfsflags;
 622         }
 623
 624         /*
 625          * This begins the section where we must prevent the parent
 626          * from being swapped.
 627          */
 628         _PHOLD(p1);
 629         PROC_UNLOCK(p1);
 630
 631         /*
 632          * Attach the new process to its parent.
 633          *
 634          * If RFNOWAIT is set, the newly created process becomes a child
 635          * of init.  This effectively disassociates the child from the
 636          * parent.
 637          */
 638         if ((fr->fr_flags & RFNOWAIT) != 0) {
 639                 pptr = p1->p_reaper;
 640                 p2->p_reaper = pptr;
 641         } else {
 642                 p2->p_reaper = (p1->p_treeflag & P_TREE_REAPER) != 0 ?
 643                     p1 : p1->p_reaper;
 644                 pptr = p1;
 645         }
 646         p2->p_pptr = pptr;
 647         LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
 648         LIST_INIT(&p2->p_reaplist);
 649         LIST_INSERT_HEAD(&p2->p_reaper->p_reaplist, p2, p_reapsibling);
 650         if (p2->p_reaper == p1)
 651                 p2->p_reapsubtree = p2->p_pid;
 652         sx_xunlock(&proctree_lock);
 653
 654         /* Inform accounting that we have forked. */
 655         p2->p_acflag = AFORK;
 656         PROC_UNLOCK(p2);
 657
 658 #ifdef KTRACE
 659         ktrprocfork(p1, p2);
 660 #endif
 661
 662         /*
 663          * Finish creating the child process.  It will return via a different
 664          * execution path later.  (ie: directly into user mode)
 665          */
 666         vm_forkproc(td, p2, td2, vm2, fr->fr_flags);
 667
 668         if (fr->fr_flags == (RFFDG | RFPROC)) {
 669                 VM_CNT_INC(v_forks);
 670                 VM_CNT_ADD(v_forkpages, p2->p_vmspace->vm_dsize +
 671                     p2->p_vmspace->vm_ssize);
 672         } else if (fr->fr_flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM)) {
 673                 VM_CNT_INC(v_vforks);
 674                 VM_CNT_ADD(v_vforkpages, p2->p_vmspace->vm_dsize +
 675                     p2->p_vmspace->vm_ssize);
 676         } else if (p1 == &proc0) {
 677                 VM_CNT_INC(v_kthreads);
 678                 VM_CNT_ADD(v_kthreadpages, p2->p_vmspace->vm_dsize +
 679                     p2->p_vmspace->vm_ssize);
 680         } else {
 681                 VM_CNT_INC(v_rforks);
 682                 VM_CNT_ADD(v_rforkpages, p2->p_vmspace->vm_dsize +
 683                     p2->p_vmspace->vm_ssize);
 684         }
 685
 686         /*
 687          * Associate the process descriptor with the process before anything
 688          * can happen that might cause that process to need the descriptor.
 689          * However, don't do this until after fork(2) can no longer fail.
 690          */
 691         if (fr->fr_flags & RFPROCDESC)
 692                 procdesc_new(p2, fr->fr_pd_flags);
 693
 694         /*
 695          * Both processes are set up, now check if any loadable modules want
 696          * to adjust anything.
 697          */
 698         EVENTHANDLER_DIRECT_INVOKE(process_fork, p1, p2, fr->fr_flags);
 699
 700         /*
 701          * Set the child start time and mark the process as being complete.
 702          */
 703         PROC_LOCK(p2);
 704         PROC_LOCK(p1);
 705         microuptime(&p2->p_stats->p_start);
 706         PROC_SLOCK(p2);
 707         p2->p_state = PRS_NORMAL;
 708         PROC_SUNLOCK(p2);
 709
 710 #ifdef KDTRACE_HOOKS
 711         /*
 712          * Tell the DTrace fasttrap provider about the new process so that any
 713          * tracepoints inherited from the parent can be removed. We have to do
 714          * this only after p_state is PRS_NORMAL since the fasttrap module will
 715          * use pfind() later on.
 716          */
 717         if ((fr->fr_flags & RFMEM) == 0 && dtrace_fasttrap_fork)
 718                 dtrace_fasttrap_fork(p1, p2);
 719 #endif
 720         /*
 721          * Hold the process so that it cannot exit after we make it runnable,
 722          * but before we wait for the debugger.
 723          */
 724         _PHOLD(p2);
 725         if (fr->fr_flags & RFPPWAIT) {
 726                 td->td_pflags |= TDP_RFPPWAIT;
 727                 td->td_rfppwait_p = p2;
 728                 td->td_dbgflags |= TDB_VFORK;
 729         }
 730         PROC_UNLOCK(p2);
 731
 732         /*
 733          * Now can be swapped.
 734          */
 735         _PRELE(p1);
 736         PROC_UNLOCK(p1);
 737
 738         /*
 739          * Tell any interested parties about the new process.
 740          */
 741         knote_fork(p1->p_klist, p2->p_pid);
 742         SDT_PROBE3(proc, , , create, p2, p1, fr->fr_flags);
 743
 744         if (fr->fr_flags & RFPROCDESC) {
 745                 procdesc_finit(p2->p_procdesc, fp_procdesc);
 746                 fdrop(fp_procdesc, td);
 747         }
 748
 749         /*
 750          * Speculative check for PTRACE_FORK. PTRACE_FORK is not
 751          * synced with forks in progress so it is OK if we miss it
 752          * if being set atm.
 753          */
 754         if ((p1->p_ptevents & PTRACE_FORK) != 0) {
 755                 sx_xlock(&proctree_lock);
 756                 PROC_LOCK(p2);
 757
 758                 /*
 759                  * p1->p_ptevents & p1->p_pptr are protected by both
 760                  * process and proctree locks for modifications,
 761                  * so owning proctree_lock allows the race-free read.
 762                  */
 763                 if ((p1->p_ptevents & PTRACE_FORK) != 0) {
 764                         /*
 765                          * Arrange for debugger to receive the fork event.
 766                          *
 767                          * We can report PL_FLAG_FORKED regardless of
 768                          * P_FOLLOWFORK settings, but it does not make a sense
 769                          * for runaway child.
 770                          */
 771                         td->td_dbgflags |= TDB_FORK;
 772                         td->td_dbg_forked = p2->p_pid;
 773                         td2->td_dbgflags |= TDB_STOPATFORK;
 774                         proc_set_traced(p2, true);
 775                         CTR2(KTR_PTRACE,
 776                             "do_fork: attaching to new child pid %d: oppid %d",
 777                             p2->p_pid, p2->p_oppid);
 778                         proc_reparent(p2, p1->p_pptr);
 779                 }
 780                 PROC_UNLOCK(p2);
 781                 sx_xunlock(&proctree_lock);
 782         }
 783
 784         if ((fr->fr_flags & RFSTOPPED) == 0) {
 785                 /*
 786                  * If RFSTOPPED not requested, make child runnable and
 787                  * add to run queue.
 788                  */
 789                 thread_lock(td2);
 790                 TD_SET_CAN_RUN(td2);
 791                 sched_add(td2, SRQ_BORING);
 792                 thread_unlock(td2);
 793                 if (fr->fr_pidp != NULL)
 794                         *fr->fr_pidp = p2->p_pid;
 795         } else {
 796                 *fr->fr_procp = p2;
 797         }
 798
 799         PROC_LOCK(p2);
 800         _PRELE(p2);
 801         racct_proc_fork_done(p2);
 802         PROC_UNLOCK(p2);
 803 }
 804
 805 int
 806 fork1(struct thread *td, struct fork_req *fr)
 807 {
 808         struct proc *p1, *newproc;
 809         struct thread *td2;
 810         struct vmspace *vm2;
 811         struct file *fp_procdesc;
 812         vm_ooffset_t mem_charged;
 813         int error, nprocs_new, ok;
 814         static int curfail;
 815         static struct timeval lastfail;
 816         int flags, pages;
 817
 818         flags = fr->fr_flags;
 819         pages = fr->fr_pages;
 820
 821         if ((flags & RFSTOPPED) != 0)
 822                 MPASS(fr->fr_procp != NULL && fr->fr_pidp == NULL);
 823         else
 824                 MPASS(fr->fr_procp == NULL);
 825
 826         /* Check for the undefined or unimplemented flags. */
 827         if ((flags & ~(RFFLAGS | RFTSIGFLAGS(RFTSIGMASK))) != 0)
 828                 return (EINVAL);
 829
 830         /* Signal value requires RFTSIGZMB. */
 831         if ((flags & RFTSIGFLAGS(RFTSIGMASK)) != 0 && (flags & RFTSIGZMB) == 0)
 832                 return (EINVAL);
 833
 834         /* Can't copy and clear. */
 835         if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
 836                 return (EINVAL);
 837
 838         /* Check the validity of the signal number. */
 839         if ((flags & RFTSIGZMB) != 0 && (u_int)RFTSIGNUM(flags) > _SIG_MAXSIG)
 840                 return (EINVAL);
 841
 842         if ((flags & RFPROCDESC) != 0) {
 843                 /* Can't not create a process yet get a process descriptor. */
 844                 if ((flags & RFPROC) == 0)
 845                         return (EINVAL);
 846
 847                 /* Must provide a place to put a procdesc if creating one. */
 848                 if (fr->fr_pd_fd == NULL)
 849                         return (EINVAL);
 850
 851                 /* Check if we are using supported flags. */
 852                 if ((fr->fr_pd_flags & ~PD_ALLOWED_AT_FORK) != 0)
 853                         return (EINVAL);
 854         }
 855
 856         p1 = td->td_proc;
 857
 858         /*
 859          * Here we don't create a new process, but we divorce
 860          * certain parts of a process from itself.
 861          */
 862         if ((flags & RFPROC) == 0) {
 863                 if (fr->fr_procp != NULL)
 864                         *fr->fr_procp = NULL;
 865                 else if (fr->fr_pidp != NULL)
 866                         *fr->fr_pidp = 0;
 867                 return (fork_norfproc(td, flags));
 868         }
 869
 870         fp_procdesc = NULL;
 871         newproc = NULL;
 872         vm2 = NULL;
 873
 874         /*
 875          * Increment the nprocs resource before allocations occur.
 876          * Although process entries are dynamically created, we still
 877          * keep a global limit on the maximum number we will
 878          * create. There are hard-limits as to the number of processes
 879          * that can run, established by the KVA and memory usage for
 880          * the process data.
 881          *
 882          * Don't allow a nonprivileged user to use the last ten
 883          * processes; don't let root exceed the limit.
 884          */
 885         nprocs_new = atomic_fetchadd_int(&nprocs, 1) + 1;
 886         if ((nprocs_new >= maxproc - 10 && priv_check_cred(td->td_ucred,
 887             PRIV_MAXPROC, 0) != 0) || nprocs_new >= maxproc) {
 888                 error = EAGAIN;
 889                 sx_xlock(&allproc_lock);
 890                 if (ppsratecheck(&lastfail, &curfail, 1)) {
 891                         printf("maxproc limit exceeded by uid %u (pid %d); "
 892                             "see tuning(7) and login.conf(5)\n",
 893                             td->td_ucred->cr_ruid, p1->p_pid);
 894                 }
 895                 sx_xunlock(&allproc_lock);
 896                 goto fail2;
 897         }
 898
 899         /*
 900          * If required, create a process descriptor in the parent first; we
 901          * will abandon it if something goes wrong. We don't finit() until
 902          * later.
 903          */
 904         if (flags & RFPROCDESC) {
 905                 error = procdesc_falloc(td, &fp_procdesc, fr->fr_pd_fd,
 906                     fr->fr_pd_flags, fr->fr_pd_fcaps);
 907                 if (error != 0)
 908                         goto fail2;
 909         }
 910
 911         mem_charged = 0;
 912         if (pages == 0)
 913                 pages = kstack_pages;
 914         /* Allocate new proc. */
 915         newproc = uma_zalloc(proc_zone, M_WAITOK);
 916         td2 = FIRST_THREAD_IN_PROC(newproc);
 917         if (td2 == NULL) {
 918                 td2 = thread_alloc(pages);
 919                 if (td2 == NULL) {
 920                         error = ENOMEM;
 921                         goto fail2;
 922                 }
 923                 proc_linkup(newproc, td2);
 924         } else {
 925                 if (td2->td_kstack == 0 || td2->td_kstack_pages != pages) {
 926                         if (td2->td_kstack != 0)
 927                                 vm_thread_dispose(td2);
 928                         if (!thread_alloc_stack(td2, pages)) {
 929                                 error = ENOMEM;
 930                                 goto fail2;
 931                         }
 932                 }
 933         }
 934
 935         if ((flags & RFMEM) == 0) {
 936                 vm2 = vmspace_fork(p1->p_vmspace, &mem_charged);
 937                 if (vm2 == NULL) {
 938                         error = ENOMEM;
 939                         goto fail2;
 940                 }
 941                 if (!swap_reserve(mem_charged)) {
 942                         /*
 943                          * The swap reservation failed. The accounting
 944                          * from the entries of the copied vm2 will be
 945                          * subtracted in vmspace_free(), so force the
 946                          * reservation there.
 947                          */
 948                         swap_reserve_force(mem_charged);
 949                         error = ENOMEM;
 950                         goto fail2;
 951                 }
 952         } else
 953                 vm2 = NULL;
 954
 955         /*
 956          * XXX: This is ugly; when we copy resource usage, we need to bump
 957          *      per-cred resource counters.
 958          */
 959         proc_set_cred_init(newproc, crhold(td->td_ucred));
 960
 961         /*
 962          * Initialize resource accounting for the child process.
 963          */
 964         error = racct_proc_fork(p1, newproc);
 965         if (error != 0) {
 966                 error = EAGAIN;
 967                 goto fail1;
 968         }
 969
 970 #ifdef MAC
 971         mac_proc_init(newproc);
 972 #endif
 973         newproc->p_klist = knlist_alloc(&newproc->p_mtx);
 974         STAILQ_INIT(&newproc->p_ktr);
 975
 976         /* We have to lock the process tree while we look for a pid. */
 977         sx_xlock(&proctree_lock);
 978         sx_xlock(&allproc_lock);
 979
 980         /*
 981          * Increment the count of procs running with this uid. Don't allow
 982          * a nonprivileged user to exceed their current limit.
 983          *
 984          * XXXRW: Can we avoid privilege here if it's not needed?
 985          */
 986         error = priv_check_cred(td->td_ucred, PRIV_PROC_LIMIT, 0);
 987         if (error == 0)
 988                 ok = chgproccnt(td->td_ucred->cr_ruidinfo, 1, 0);
 989         else {
 990                 ok = chgproccnt(td->td_ucred->cr_ruidinfo, 1,
 991                     lim_cur(td, RLIMIT_NPROC));
 992         }
 993         if (ok) {
 994                 do_fork(td, fr, newproc, td2, vm2, fp_procdesc);
 995                 return (0);
 996         }
 997
 998         error = EAGAIN;
 999         sx_xunlock(&allproc_lock);
1000         sx_xunlock(&proctree_lock);
1001 #ifdef MAC
1002         mac_proc_destroy(newproc);
1003 #endif
1004         racct_proc_exit(newproc);
1005 fail1:
1006         crfree(newproc->p_ucred);
1007         newproc->p_ucred = NULL;
1008 fail2:
1009         if (vm2 != NULL)
1010                 vmspace_free(vm2);
1011         uma_zfree(proc_zone, newproc);
1012         if ((flags & RFPROCDESC) != 0 && fp_procdesc != NULL) {
1013                 fdclose(td, fp_procdesc, *fr->fr_pd_fd);
1014                 fdrop(fp_procdesc, td);
1015         }
1016         atomic_add_int(&nprocs, -1);
1017         pause("fork", hz / 2);
1018         return (error);
1019 }
1020
1021 /*
1022  * Handle the return of a child process from fork1().  This function
1023  * is called from the MD fork_trampoline() entry point.
1024  */
1025 void
1026 fork_exit(void (*callout)(void *, struct trapframe *), void *arg,
1027     struct trapframe *frame)
1028 {
1029         struct proc *p;
1030         struct thread *td;
1031         struct thread *dtd;
1032
1033         td = curthread;
1034         p = td->td_proc;
1035         KASSERT(p->p_state == PRS_NORMAL, ("executing process is still new"));
1036
1037         CTR4(KTR_PROC, "fork_exit: new thread %p (td_sched %p, pid %d, %s)",
1038             td, td_get_sched(td), p->p_pid, td->td_name);
1039
1040         sched_fork_exit(td);
1041         /*
1042         * Processes normally resume in mi_switch() after being
1043         * cpu_switch()'ed to, but when children start up they arrive here
1044         * instead, so we must do much the same things as mi_switch() would.
1045         */
1046         if ((dtd = PCPU_GET(deadthread))) {
1047                 PCPU_SET(deadthread, NULL);
1048                 thread_stash(dtd);
1049         }
1050         thread_unlock(td);
1051
1052         /*
1053          * cpu_fork_kthread_handler intercepts this function call to
1054          * have this call a non-return function to stay in kernel mode.
1055          * initproc has its own fork handler, but it does return.
1056          */
1057         KASSERT(callout != NULL, ("NULL callout in fork_exit"));
1058         callout(arg, frame);
1059
1060         /*
1061          * Check if a kernel thread misbehaved and returned from its main
1062          * function.
1063          */
1064         if (p->p_flag & P_KPROC) {
1065                 printf("Kernel thread \"%s\" (pid %d) exited prematurely.\n",
1066                     td->td_name, p->p_pid);
1067                 kthread_exit();
1068         }
1069         mtx_assert(&Giant, MA_NOTOWNED);
1070
1071         if (p->p_sysent->sv_schedtail != NULL)
1072                 (p->p_sysent->sv_schedtail)(td);
1073         td->td_pflags &= ~TDP_FORKING;
1074 }
1075
1076 /*
1077  * Simplified back end of syscall(), used when returning from fork()
1078  * directly into user mode.  This function is passed in to fork_exit()
1079  * as the first parameter and is called when returning to a new
1080  * userland process.
1081  */
1082 void
1083 fork_return(struct thread *td, struct trapframe *frame)
1084 {
1085         struct proc *p;
1086
1087         p = td->td_proc;
1088         if (td->td_dbgflags & TDB_STOPATFORK) {
1089                 PROC_LOCK(p);
1090                 if ((p->p_flag & P_TRACED) != 0) {
1091                         /*
1092                          * Inform the debugger if one is still present.
1093                          */
1094                         td->td_dbgflags |= TDB_CHILD | TDB_SCX | TDB_FSTP;
1095                         ptracestop(td, SIGSTOP, NULL);
1096                         td->td_dbgflags &= ~(TDB_CHILD | TDB_SCX);
1097                 } else {
1098                         /*
1099                          * ... otherwise clear the request.
1100                          */
1101                         td->td_dbgflags &= ~TDB_STOPATFORK;
1102                 }
1103                 PROC_UNLOCK(p);
1104         } else if (p->p_flag & P_TRACED || td->td_dbgflags & TDB_BORN) {
1105                 /*
1106                  * This is the start of a new thread in a traced
1107                  * process.  Report a system call exit event.
1108                  */
1109                 PROC_LOCK(p);
1110                 td->td_dbgflags |= TDB_SCX;
1111                 _STOPEVENT(p, S_SCX, td->td_sa.code);
1112                 if ((p->p_ptevents & PTRACE_SCX) != 0 ||
1113                     (td->td_dbgflags & TDB_BORN) != 0)
1114                         ptracestop(td, SIGTRAP, NULL);
1115                 td->td_dbgflags &= ~(TDB_SCX | TDB_BORN);
1116                 PROC_UNLOCK(p);
1117         }
1118
1119         userret(td, frame);
1120
1121 #ifdef KTRACE
1122         if (KTRPOINT(td, KTR_SYSRET))
1123                 ktrsysret(SYS_fork, 0, 0);
1124 #endif
1125 }