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/bitstring.h>
  48 #include <sys/sysproto.h>
  49 #include <sys/eventhandler.h>
  50 #include <sys/fcntl.h>
  51 #include <sys/filedesc.h>
  52 #include <sys/jail.h>
  53 #include <sys/kernel.h>
  54 #include <sys/kthread.h>
  55 #include <sys/sysctl.h>
  56 #include <sys/lock.h>
  57 #include <sys/malloc.h>
  58 #include <sys/msan.h>
  59 #include <sys/mutex.h>
  60 #include <sys/priv.h>
  61 #include <sys/proc.h>
  62 #include <sys/procdesc.h>
  63 #include <sys/ptrace.h>
  64 #include <sys/racct.h>
  65 #include <sys/resourcevar.h>
  66 #include <sys/sched.h>
  67 #include <sys/syscall.h>
  68 #include <sys/vmmeter.h>
  69 #include <sys/vnode.h>
  70 #include <sys/acct.h>
  71 #include <sys/ktr.h>
  72 #include <sys/ktrace.h>
  73 #include <sys/unistd.h>
  74 #include <sys/sdt.h>
  75 #include <sys/sx.h>
  76 #include <sys/sysent.h>
  77 #include <sys/signalvar.h>
  78
  79 #include <security/audit/audit.h>
  80 #include <security/mac/mac_framework.h>
  81
  82 #include <vm/vm.h>
  83 #include <vm/pmap.h>
  84 #include <vm/vm_map.h>
  85 #include <vm/vm_extern.h>
  86 #include <vm/uma.h>
  87
  88 #ifdef KDTRACE_HOOKS
  89 #include <sys/dtrace_bsd.h>
  90 dtrace_fork_func_t      dtrace_fasttrap_fork;
  91 #endif
  92
  93 SDT_PROVIDER_DECLARE(proc);
  94 SDT_PROBE_DEFINE3(proc, , , create, "struct proc *", "struct proc *", "int");
  95
  96 #ifndef _SYS_SYSPROTO_H_
  97 struct fork_args {
  98         int     dummy;
  99 };
 100 #endif
 101
 102 /* ARGSUSED */
 103 int
 104 sys_fork(struct thread *td, struct fork_args *uap)
 105 {
 106         struct fork_req fr;
 107         int error, pid;
 108
 109         bzero(&fr, sizeof(fr));
 110         fr.fr_flags = RFFDG | RFPROC;
 111         fr.fr_pidp = &pid;
 112         error = fork1(td, &fr);
 113         if (error == 0) {
 114                 td->td_retval[0] = pid;
 115                 td->td_retval[1] = 0;
 116         }
 117         return (error);
 118 }
 119
 120 /* ARGUSED */
 121 int
 122 sys_pdfork(struct thread *td, struct pdfork_args *uap)
 123 {
 124         struct fork_req fr;
 125         int error, fd, pid;
 126
 127         bzero(&fr, sizeof(fr));
 128         fr.fr_flags = RFFDG | RFPROC | RFPROCDESC;
 129         fr.fr_pidp = &pid;
 130         fr.fr_pd_fd = &fd;
 131         fr.fr_pd_flags = uap->flags;
 132         AUDIT_ARG_FFLAGS(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         /* RFSPAWN must not appear with others */
 175         if ((uap->flags & RFSPAWN) != 0 && uap->flags != RFSPAWN)
 176                 return (EINVAL);
 177
 178         AUDIT_ARG_FFLAGS(uap->flags);
 179         bzero(&fr, sizeof(fr));
 180         if ((uap->flags & RFSPAWN) != 0) {
 181                 fr.fr_flags = RFFDG | RFPROC | RFPPWAIT | RFMEM;
 182                 fr.fr_flags2 = FR2_DROPSIG_CAUGHT;
 183         } else {
 184                 fr.fr_flags = uap->flags;
 185         }
 186         fr.fr_pidp = &pid;
 187         error = fork1(td, &fr);
 188         if (error == 0) {
 189                 td->td_retval[0] = pid;
 190                 td->td_retval[1] = 0;
 191         }
 192         return (error);
 193 }
 194
 195 int __exclusive_cache_line      nprocs = 1;             /* process 0 */
 196 int     lastpid = 0;
 197 SYSCTL_INT(_kern, OID_AUTO, lastpid, CTLFLAG_RD, &lastpid, 0,
 198     "Last used PID");
 199
 200 /*
 201  * Random component to lastpid generation.  We mix in a random factor to make
 202  * it a little harder to predict.  We sanity check the modulus value to avoid
 203  * doing it in critical paths.  Don't let it be too small or we pointlessly
 204  * waste randomness entropy, and don't let it be impossibly large.  Using a
 205  * modulus that is too big causes a LOT more process table scans and slows
 206  * down fork processing as the pidchecked caching is defeated.
 207  */
 208 static int randompid = 0;
 209
 210 static int
 211 sysctl_kern_randompid(SYSCTL_HANDLER_ARGS)
 212 {
 213         int error, pid;
 214
 215         error = sysctl_wire_old_buffer(req, sizeof(int));
 216         if (error != 0)
 217                 return(error);
 218         sx_xlock(&allproc_lock);
 219         pid = randompid;
 220         error = sysctl_handle_int(oidp, &pid, 0, req);
 221         if (error == 0 && req->newptr != NULL) {
 222                 if (pid == 0)
 223                         randompid = 0;
 224                 else if (pid == 1)
 225                         /* generate a random PID modulus between 100 and 1123 */
 226                         randompid = 100 + arc4random() % 1024;
 227                 else if (pid < 0 || pid > pid_max - 100)
 228                         /* out of range */
 229                         randompid = pid_max - 100;
 230                 else if (pid < 100)
 231                         /* Make it reasonable */
 232                         randompid = 100;
 233                 else
 234                         randompid = pid;
 235         }
 236         sx_xunlock(&allproc_lock);
 237         return (error);
 238 }
 239
 240 SYSCTL_PROC(_kern, OID_AUTO, randompid,
 241     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 0,
 242     sysctl_kern_randompid, "I",
 243     "Random PID modulus. Special values: 0: disable, 1: choose random value");
 244
 245 extern bitstr_t proc_id_pidmap;
 246 extern bitstr_t proc_id_grpidmap;
 247 extern bitstr_t proc_id_sessidmap;
 248 extern bitstr_t proc_id_reapmap;
 249
 250 /*
 251  * Find an unused process ID
 252  *
 253  * If RFHIGHPID is set (used during system boot), do not allocate
 254  * low-numbered pids.
 255  */
 256 static int
 257 fork_findpid(int flags)
 258 {
 259         pid_t result;
 260         int trypid, random;
 261
 262         /*
 263          * Avoid calling arc4random with procid_lock held.
 264          */
 265         random = 0;
 266         if (__predict_false(randompid))
 267                 random = arc4random() % randompid;
 268
 269         mtx_lock(&procid_lock);
 270
 271         trypid = lastpid + 1;
 272         if (flags & RFHIGHPID) {
 273                 if (trypid < 10)
 274                         trypid = 10;
 275         } else {
 276                 trypid += random;
 277         }
 278 retry:
 279         if (trypid >= pid_max)
 280                 trypid = 2;
 281
 282         bit_ffc_at(&proc_id_pidmap, trypid, pid_max, &result);
 283         if (result == -1) {
 284                 KASSERT(trypid != 2, ("unexpectedly ran out of IDs"));
 285                 trypid = 2;
 286                 goto retry;
 287         }
 288         if (bit_test(&proc_id_grpidmap, result) ||
 289             bit_test(&proc_id_sessidmap, result) ||
 290             bit_test(&proc_id_reapmap, result)) {
 291                 trypid = result + 1;
 292                 goto retry;
 293         }
 294
 295         /*
 296          * RFHIGHPID does not mess with the lastpid counter during boot.
 297          */
 298         if ((flags & RFHIGHPID) == 0)
 299                 lastpid = result;
 300
 301         bit_set(&proc_id_pidmap, result);
 302         mtx_unlock(&procid_lock);
 303
 304         return (result);
 305 }
 306
 307 static int
 308 fork_norfproc(struct thread *td, int flags)
 309 {
 310         struct proc *p1;
 311         int error;
 312
 313         KASSERT((flags & RFPROC) == 0,
 314             ("fork_norfproc called with RFPROC set"));
 315         p1 = td->td_proc;
 316
 317         /*
 318          * Quiesce other threads if necessary.  If RFMEM is not specified we
 319          * must ensure that other threads do not concurrently create a second
 320          * process sharing the vmspace, see vmspace_unshare().
 321          */
 322 again:
 323         if ((p1->p_flag & (P_HADTHREADS | P_SYSTEM)) == P_HADTHREADS &&
 324             ((flags & (RFCFDG | RFFDG)) != 0 || (flags & RFMEM) == 0)) {
 325                 PROC_LOCK(p1);
 326                 while (p1->p_singlethr > 0) {
 327                         error = msleep(&p1->p_singlethr, &p1->p_mtx,
 328                             PWAIT | PCATCH, "rfork1t", 0);
 329                         if (error != 0) {
 330                                 PROC_UNLOCK(p1);
 331                                 return (ERESTART);
 332                         }
 333                         goto again;
 334                 }
 335                 if (thread_single(p1, SINGLE_BOUNDARY)) {
 336                         PROC_UNLOCK(p1);
 337                         return (ERESTART);
 338                 }
 339                 PROC_UNLOCK(p1);
 340         }
 341
 342         error = vm_forkproc(td, NULL, NULL, NULL, flags);
 343         if (error != 0)
 344                 goto fail;
 345
 346         /*
 347          * Close all file descriptors.
 348          */
 349         if ((flags & RFCFDG) != 0) {
 350                 struct filedesc *fdtmp;
 351                 struct pwddesc *pdtmp;
 352
 353                 pdtmp = pdinit(td->td_proc->p_pd, false);
 354                 fdtmp = fdinit();
 355                 pdescfree(td);
 356                 fdescfree(td);
 357                 p1->p_fd = fdtmp;
 358                 p1->p_pd = pdtmp;
 359         }
 360
 361         /*
 362          * Unshare file descriptors (from parent).
 363          */
 364         if ((flags & RFFDG) != 0) {
 365                 fdunshare(td);
 366                 pdunshare(td);
 367         }
 368
 369 fail:
 370         if ((p1->p_flag & (P_HADTHREADS | P_SYSTEM)) == P_HADTHREADS &&
 371             ((flags & (RFCFDG | RFFDG)) != 0 || (flags & RFMEM) == 0)) {
 372                 PROC_LOCK(p1);
 373                 thread_single_end(p1, SINGLE_BOUNDARY);
 374                 PROC_UNLOCK(p1);
 375         }
 376         return (error);
 377 }
 378
 379 static void
 380 do_fork(struct thread *td, struct fork_req *fr, struct proc *p2, struct thread *td2,
 381     struct vmspace *vm2, struct file *fp_procdesc)
 382 {
 383         struct proc *p1, *pptr;
 384         struct filedesc *fd;
 385         struct filedesc_to_leader *fdtol;
 386         struct pwddesc *pd;
 387         struct sigacts *newsigacts;
 388
 389         p1 = td->td_proc;
 390
 391         PROC_LOCK(p1);
 392         bcopy(&p1->p_startcopy, &p2->p_startcopy,
 393             __rangeof(struct proc, p_startcopy, p_endcopy));
 394         pargs_hold(p2->p_args);
 395         PROC_UNLOCK(p1);
 396
 397         bzero(&p2->p_startzero,
 398             __rangeof(struct proc, p_startzero, p_endzero));
 399
 400         /* Tell the prison that we exist. */
 401         prison_proc_hold(p2->p_ucred->cr_prison);
 402
 403         p2->p_state = PRS_NEW;          /* protect against others */
 404         p2->p_pid = fork_findpid(fr->fr_flags);
 405         AUDIT_ARG_PID(p2->p_pid);
 406         TSFORK(p2->p_pid, p1->p_pid);
 407
 408         sx_xlock(&allproc_lock);
 409         LIST_INSERT_HEAD(&allproc, p2, p_list);
 410         allproc_gen++;
 411         sx_xunlock(&allproc_lock);
 412
 413         sx_xlock(PIDHASHLOCK(p2->p_pid));
 414         LIST_INSERT_HEAD(PIDHASH(p2->p_pid), p2, p_hash);
 415         sx_xunlock(PIDHASHLOCK(p2->p_pid));
 416
 417         tidhash_add(td2);
 418
 419         /*
 420          * Malloc things while we don't hold any locks.
 421          */
 422         if (fr->fr_flags & RFSIGSHARE)
 423                 newsigacts = NULL;
 424         else
 425                 newsigacts = sigacts_alloc();
 426
 427         /*
 428          * Copy filedesc.
 429          */
 430         if (fr->fr_flags & RFCFDG) {
 431                 pd = pdinit(p1->p_pd, false);
 432                 fd = fdinit();
 433                 fdtol = NULL;
 434         } else if (fr->fr_flags & RFFDG) {
 435                 if (fr->fr_flags2 & FR2_SHARE_PATHS)
 436                         pd = pdshare(p1->p_pd);
 437                 else
 438                         pd = pdcopy(p1->p_pd);
 439                 fd = fdcopy(p1->p_fd);
 440                 fdtol = NULL;
 441         } else {
 442                 if (fr->fr_flags2 & FR2_SHARE_PATHS)
 443                         pd = pdcopy(p1->p_pd);
 444                 else
 445                         pd = pdshare(p1->p_pd);
 446                 fd = fdshare(p1->p_fd);
 447                 if (p1->p_fdtol == NULL)
 448                         p1->p_fdtol = filedesc_to_leader_alloc(NULL, NULL,
 449                             p1->p_leader);
 450                 if ((fr->fr_flags & RFTHREAD) != 0) {
 451                         /*
 452                          * Shared file descriptor table, and shared
 453                          * process leaders.
 454                          */
 455                         fdtol = filedesc_to_leader_share(p1->p_fdtol, p1->p_fd);
 456                 } else {
 457                         /*
 458                          * Shared file descriptor table, and different
 459                          * process leaders.
 460                          */
 461                         fdtol = filedesc_to_leader_alloc(p1->p_fdtol,
 462                             p1->p_fd, p2);
 463                 }
 464         }
 465         /*
 466          * Make a proc table entry for the new process.
 467          * Start by zeroing the section of proc that is zero-initialized,
 468          * then copy the section that is copied directly from the parent.
 469          */
 470
 471         PROC_LOCK(p2);
 472         PROC_LOCK(p1);
 473
 474         bzero(&td2->td_startzero,
 475             __rangeof(struct thread, td_startzero, td_endzero));
 476
 477         bcopy(&td->td_startcopy, &td2->td_startcopy,
 478             __rangeof(struct thread, td_startcopy, td_endcopy));
 479
 480         bcopy(&p2->p_comm, &td2->td_name, sizeof(td2->td_name));
 481         td2->td_sigstk = td->td_sigstk;
 482         td2->td_flags = TDF_INMEM;
 483         td2->td_lend_user_pri = PRI_MAX;
 484
 485 #ifdef VIMAGE
 486         td2->td_vnet = NULL;
 487         td2->td_vnet_lpush = NULL;
 488 #endif
 489
 490         /*
 491          * Allow the scheduler to initialize the child.
 492          */
 493         thread_lock(td);
 494         sched_fork(td, td2);
 495         /*
 496          * Request AST to check for TDP_RFPPWAIT.  Do it here
 497          * to avoid calling thread_lock() again.
 498          */
 499         if ((fr->fr_flags & RFPPWAIT) != 0)
 500                 ast_sched_locked(td, TDA_VFORK);
 501         thread_unlock(td);
 502
 503         /*
 504          * Duplicate sub-structures as needed.
 505          * Increase reference counts on shared objects.
 506          */
 507         p2->p_flag = P_INMEM;
 508         p2->p_flag2 = p1->p_flag2 & (P2_ASLR_DISABLE | P2_ASLR_ENABLE |
 509             P2_ASLR_IGNSTART | P2_NOTRACE | P2_NOTRACE_EXEC |
 510             P2_PROTMAX_ENABLE | P2_PROTMAX_DISABLE | P2_TRAPCAP |
 511             P2_STKGAP_DISABLE | P2_STKGAP_DISABLE_EXEC | P2_NO_NEW_PRIVS |
 512             P2_WXORX_DISABLE | P2_WXORX_ENABLE_EXEC);
 513         p2->p_swtick = ticks;
 514         if (p1->p_flag & P_PROFIL)
 515                 startprofclock(p2);
 516
 517         if (fr->fr_flags & RFSIGSHARE) {
 518                 p2->p_sigacts = sigacts_hold(p1->p_sigacts);
 519         } else {
 520                 sigacts_copy(newsigacts, p1->p_sigacts);
 521                 p2->p_sigacts = newsigacts;
 522                 if ((fr->fr_flags2 & (FR2_DROPSIG_CAUGHT | FR2_KPROC)) != 0) {
 523                         mtx_lock(&p2->p_sigacts->ps_mtx);
 524                         if ((fr->fr_flags2 & FR2_DROPSIG_CAUGHT) != 0)
 525                                 sig_drop_caught(p2);
 526                         if ((fr->fr_flags2 & FR2_KPROC) != 0)
 527                                 p2->p_sigacts->ps_flag |= PS_NOCLDWAIT;
 528                         mtx_unlock(&p2->p_sigacts->ps_mtx);
 529                 }
 530         }
 531
 532         if (fr->fr_flags & RFTSIGZMB)
 533                 p2->p_sigparent = RFTSIGNUM(fr->fr_flags);
 534         else if (fr->fr_flags & RFLINUXTHPN)
 535                 p2->p_sigparent = SIGUSR1;
 536         else
 537                 p2->p_sigparent = SIGCHLD;
 538
 539         if ((fr->fr_flags2 & FR2_KPROC) != 0) {
 540                 p2->p_flag |= P_SYSTEM | P_KPROC;
 541                 td2->td_pflags |= TDP_KTHREAD;
 542         }
 543
 544         p2->p_textvp = p1->p_textvp;
 545         p2->p_textdvp = p1->p_textdvp;
 546         p2->p_fd = fd;
 547         p2->p_fdtol = fdtol;
 548         p2->p_pd = pd;
 549
 550         if (p1->p_flag2 & P2_INHERIT_PROTECTED) {
 551                 p2->p_flag |= P_PROTECTED;
 552                 p2->p_flag2 |= P2_INHERIT_PROTECTED;
 553         }
 554
 555         /*
 556          * p_limit is copy-on-write.  Bump its refcount.
 557          */
 558         lim_fork(p1, p2);
 559
 560         thread_cow_get_proc(td2, p2);
 561
 562         pstats_fork(p1->p_stats, p2->p_stats);
 563
 564         PROC_UNLOCK(p1);
 565         PROC_UNLOCK(p2);
 566
 567         /*
 568          * Bump references to the text vnode and directory, and copy
 569          * the hardlink name.
 570          */
 571         if (p2->p_textvp != NULL)
 572                 vrefact(p2->p_textvp);
 573         if (p2->p_textdvp != NULL)
 574                 vrefact(p2->p_textdvp);
 575         p2->p_binname = p1->p_binname == NULL ? NULL :
 576             strdup(p1->p_binname, M_PARGS);
 577
 578         /*
 579          * Set up linkage for kernel based threading.
 580          */
 581         if ((fr->fr_flags & RFTHREAD) != 0) {
 582                 mtx_lock(&ppeers_lock);
 583                 p2->p_peers = p1->p_peers;
 584                 p1->p_peers = p2;
 585                 p2->p_leader = p1->p_leader;
 586                 mtx_unlock(&ppeers_lock);
 587                 PROC_LOCK(p1->p_leader);
 588                 if ((p1->p_leader->p_flag & P_WEXIT) != 0) {
 589                         PROC_UNLOCK(p1->p_leader);
 590                         /*
 591                          * The task leader is exiting, so process p1 is
 592                          * going to be killed shortly.  Since p1 obviously
 593                          * isn't dead yet, we know that the leader is either
 594                          * sending SIGKILL's to all the processes in this
 595                          * task or is sleeping waiting for all the peers to
 596                          * exit.  We let p1 complete the fork, but we need
 597                          * to go ahead and kill the new process p2 since
 598                          * the task leader may not get a chance to send
 599                          * SIGKILL to it.  We leave it on the list so that
 600                          * the task leader will wait for this new process
 601                          * to commit suicide.
 602                          */
 603                         PROC_LOCK(p2);
 604                         kern_psignal(p2, SIGKILL);
 605                         PROC_UNLOCK(p2);
 606                 } else
 607                         PROC_UNLOCK(p1->p_leader);
 608         } else {
 609                 p2->p_peers = NULL;
 610                 p2->p_leader = p2;
 611         }
 612
 613         sx_xlock(&proctree_lock);
 614         PGRP_LOCK(p1->p_pgrp);
 615         PROC_LOCK(p2);
 616         PROC_LOCK(p1);
 617
 618         /*
 619          * Preserve some more flags in subprocess.  P_PROFIL has already
 620          * been preserved.
 621          */
 622         p2->p_flag |= p1->p_flag & P_SUGID;
 623         td2->td_pflags |= (td->td_pflags & (TDP_ALTSTACK | TDP_SIGFASTBLOCK));
 624         SESS_LOCK(p1->p_session);
 625         if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
 626                 p2->p_flag |= P_CONTROLT;
 627         SESS_UNLOCK(p1->p_session);
 628         if (fr->fr_flags & RFPPWAIT)
 629                 p2->p_flag |= P_PPWAIT;
 630
 631         p2->p_pgrp = p1->p_pgrp;
 632         LIST_INSERT_AFTER(p1, p2, p_pglist);
 633         PGRP_UNLOCK(p1->p_pgrp);
 634         LIST_INIT(&p2->p_children);
 635         LIST_INIT(&p2->p_orphans);
 636
 637         callout_init_mtx(&p2->p_itcallout, &p2->p_mtx, 0);
 638         TAILQ_INIT(&p2->p_kqtim_stop);
 639
 640         /*
 641          * This begins the section where we must prevent the parent
 642          * from being swapped.
 643          */
 644         _PHOLD(p1);
 645         PROC_UNLOCK(p1);
 646
 647         /*
 648          * Attach the new process to its parent.
 649          *
 650          * If RFNOWAIT is set, the newly created process becomes a child
 651          * of init.  This effectively disassociates the child from the
 652          * parent.
 653          */
 654         if ((fr->fr_flags & RFNOWAIT) != 0) {
 655                 pptr = p1->p_reaper;
 656                 p2->p_reaper = pptr;
 657         } else {
 658                 p2->p_reaper = (p1->p_treeflag & P_TREE_REAPER) != 0 ?
 659                     p1 : p1->p_reaper;
 660                 pptr = p1;
 661         }
 662         p2->p_pptr = pptr;
 663         p2->p_oppid = pptr->p_pid;
 664         LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
 665         LIST_INIT(&p2->p_reaplist);
 666         LIST_INSERT_HEAD(&p2->p_reaper->p_reaplist, p2, p_reapsibling);
 667         if (p2->p_reaper == p1 && p1 != initproc) {
 668                 p2->p_reapsubtree = p2->p_pid;
 669                 proc_id_set_cond(PROC_ID_REAP, p2->p_pid);
 670         }
 671         sx_xunlock(&proctree_lock);
 672
 673         /* Inform accounting that we have forked. */
 674         p2->p_acflag = AFORK;
 675         PROC_UNLOCK(p2);
 676
 677 #ifdef KTRACE
 678         ktrprocfork(p1, p2);
 679 #endif
 680
 681         /*
 682          * Finish creating the child process.  It will return via a different
 683          * execution path later.  (ie: directly into user mode)
 684          */
 685         vm_forkproc(td, p2, td2, vm2, fr->fr_flags);
 686
 687         if (fr->fr_flags == (RFFDG | RFPROC)) {
 688                 VM_CNT_INC(v_forks);
 689                 VM_CNT_ADD(v_forkpages, p2->p_vmspace->vm_dsize +
 690                     p2->p_vmspace->vm_ssize);
 691         } else if (fr->fr_flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM)) {
 692                 VM_CNT_INC(v_vforks);
 693                 VM_CNT_ADD(v_vforkpages, p2->p_vmspace->vm_dsize +
 694                     p2->p_vmspace->vm_ssize);
 695         } else if (p1 == &proc0) {
 696                 VM_CNT_INC(v_kthreads);
 697                 VM_CNT_ADD(v_kthreadpages, p2->p_vmspace->vm_dsize +
 698                     p2->p_vmspace->vm_ssize);
 699         } else {
 700                 VM_CNT_INC(v_rforks);
 701                 VM_CNT_ADD(v_rforkpages, p2->p_vmspace->vm_dsize +
 702                     p2->p_vmspace->vm_ssize);
 703         }
 704
 705         /*
 706          * Associate the process descriptor with the process before anything
 707          * can happen that might cause that process to need the descriptor.
 708          * However, don't do this until after fork(2) can no longer fail.
 709          */
 710         if (fr->fr_flags & RFPROCDESC)
 711                 procdesc_new(p2, fr->fr_pd_flags);
 712
 713         /*
 714          * Both processes are set up, now check if any loadable modules want
 715          * to adjust anything.
 716          */
 717         EVENTHANDLER_DIRECT_INVOKE(process_fork, p1, p2, fr->fr_flags);
 718
 719         /*
 720          * Set the child start time and mark the process as being complete.
 721          */
 722         PROC_LOCK(p2);
 723         PROC_LOCK(p1);
 724         microuptime(&p2->p_stats->p_start);
 725         PROC_SLOCK(p2);
 726         p2->p_state = PRS_NORMAL;
 727         PROC_SUNLOCK(p2);
 728
 729 #ifdef KDTRACE_HOOKS
 730         /*
 731          * Tell the DTrace fasttrap provider about the new process so that any
 732          * tracepoints inherited from the parent can be removed. We have to do
 733          * this only after p_state is PRS_NORMAL since the fasttrap module will
 734          * use pfind() later on.
 735          */
 736         if ((fr->fr_flags & RFMEM) == 0 && dtrace_fasttrap_fork)
 737                 dtrace_fasttrap_fork(p1, p2);
 738 #endif
 739         if (fr->fr_flags & RFPPWAIT) {
 740                 td->td_pflags |= TDP_RFPPWAIT;
 741                 td->td_rfppwait_p = p2;
 742                 td->td_dbgflags |= TDB_VFORK;
 743         }
 744         PROC_UNLOCK(p2);
 745
 746         /*
 747          * Tell any interested parties about the new process.
 748          */
 749         knote_fork(p1->p_klist, p2->p_pid);
 750
 751         /*
 752          * Now can be swapped.
 753          */
 754         _PRELE(p1);
 755         PROC_UNLOCK(p1);
 756         SDT_PROBE3(proc, , , create, p2, p1, fr->fr_flags);
 757
 758         if (fr->fr_flags & RFPROCDESC) {
 759                 procdesc_finit(p2->p_procdesc, fp_procdesc);
 760                 fdrop(fp_procdesc, td);
 761         }
 762
 763         /*
 764          * Speculative check for PTRACE_FORK. PTRACE_FORK is not
 765          * synced with forks in progress so it is OK if we miss it
 766          * if being set atm.
 767          */
 768         if ((p1->p_ptevents & PTRACE_FORK) != 0) {
 769                 sx_xlock(&proctree_lock);
 770                 PROC_LOCK(p2);
 771
 772                 /*
 773                  * p1->p_ptevents & p1->p_pptr are protected by both
 774                  * process and proctree locks for modifications,
 775                  * so owning proctree_lock allows the race-free read.
 776                  */
 777                 if ((p1->p_ptevents & PTRACE_FORK) != 0) {
 778                         /*
 779                          * Arrange for debugger to receive the fork event.
 780                          *
 781                          * We can report PL_FLAG_FORKED regardless of
 782                          * P_FOLLOWFORK settings, but it does not make a sense
 783                          * for runaway child.
 784                          */
 785                         td->td_dbgflags |= TDB_FORK;
 786                         td->td_dbg_forked = p2->p_pid;
 787                         td2->td_dbgflags |= TDB_STOPATFORK;
 788                         proc_set_traced(p2, true);
 789                         CTR2(KTR_PTRACE,
 790                             "do_fork: attaching to new child pid %d: oppid %d",
 791                             p2->p_pid, p2->p_oppid);
 792                         proc_reparent(p2, p1->p_pptr, false);
 793                 }
 794                 PROC_UNLOCK(p2);
 795                 sx_xunlock(&proctree_lock);
 796         }
 797
 798         racct_proc_fork_done(p2);
 799
 800         if ((fr->fr_flags & RFSTOPPED) == 0) {
 801                 if (fr->fr_pidp != NULL)
 802                         *fr->fr_pidp = p2->p_pid;
 803                 /*
 804                  * If RFSTOPPED not requested, make child runnable and
 805                  * add to run queue.
 806                  */
 807                 thread_lock(td2);
 808                 TD_SET_CAN_RUN(td2);
 809                 sched_add(td2, SRQ_BORING);
 810         } else {
 811                 *fr->fr_procp = p2;
 812         }
 813 }
 814
 815 static void
 816 ast_vfork(struct thread *td, int tda __unused)
 817 {
 818         struct proc *p, *p2;
 819
 820         MPASS(td->td_pflags & TDP_RFPPWAIT);
 821
 822         p = td->td_proc;
 823         /*
 824          * Preserve synchronization semantics of vfork.  If
 825          * waiting for child to exec or exit, fork set
 826          * P_PPWAIT on child, and there we sleep on our proc
 827          * (in case of exit).
 828          *
 829          * Do it after the ptracestop() above is finished, to
 830          * not block our debugger until child execs or exits
 831          * to finish vfork wait.
 832          */
 833         td->td_pflags &= ~TDP_RFPPWAIT;
 834         p2 = td->td_rfppwait_p;
 835 again:
 836         PROC_LOCK(p2);
 837         while (p2->p_flag & P_PPWAIT) {
 838                 PROC_LOCK(p);
 839                 if (thread_suspend_check_needed()) {
 840                         PROC_UNLOCK(p2);
 841                         thread_suspend_check(0);
 842                         PROC_UNLOCK(p);
 843                         goto again;
 844                 } else {
 845                         PROC_UNLOCK(p);
 846                 }
 847                 cv_timedwait(&p2->p_pwait, &p2->p_mtx, hz);
 848         }
 849         PROC_UNLOCK(p2);
 850
 851         if (td->td_dbgflags & TDB_VFORK) {
 852                 PROC_LOCK(p);
 853                 if (p->p_ptevents & PTRACE_VFORK)
 854                         ptracestop(td, SIGTRAP, NULL);
 855                 td->td_dbgflags &= ~TDB_VFORK;
 856                 PROC_UNLOCK(p);
 857         }
 858 }
 859
 860 int
 861 fork1(struct thread *td, struct fork_req *fr)
 862 {
 863         struct proc *p1, *newproc;
 864         struct thread *td2;
 865         struct vmspace *vm2;
 866         struct ucred *cred;
 867         struct file *fp_procdesc;
 868         vm_ooffset_t mem_charged;
 869         int error, nprocs_new;
 870         static int curfail;
 871         static struct timeval lastfail;
 872         int flags, pages;
 873
 874         flags = fr->fr_flags;
 875         pages = fr->fr_pages;
 876
 877         if ((flags & RFSTOPPED) != 0)
 878                 MPASS(fr->fr_procp != NULL && fr->fr_pidp == NULL);
 879         else
 880                 MPASS(fr->fr_procp == NULL);
 881
 882         /* Check for the undefined or unimplemented flags. */
 883         if ((flags & ~(RFFLAGS | RFTSIGFLAGS(RFTSIGMASK))) != 0)
 884                 return (EINVAL);
 885
 886         /* Signal value requires RFTSIGZMB. */
 887         if ((flags & RFTSIGFLAGS(RFTSIGMASK)) != 0 && (flags & RFTSIGZMB) == 0)
 888                 return (EINVAL);
 889
 890         /* Can't copy and clear. */
 891         if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
 892                 return (EINVAL);
 893
 894         /* Check the validity of the signal number. */
 895         if ((flags & RFTSIGZMB) != 0 && (u_int)RFTSIGNUM(flags) > _SIG_MAXSIG)
 896                 return (EINVAL);
 897
 898         if ((flags & RFPROCDESC) != 0) {
 899                 /* Can't not create a process yet get a process descriptor. */
 900                 if ((flags & RFPROC) == 0)
 901                         return (EINVAL);
 902
 903                 /* Must provide a place to put a procdesc if creating one. */
 904                 if (fr->fr_pd_fd == NULL)
 905                         return (EINVAL);
 906
 907                 /* Check if we are using supported flags. */
 908                 if ((fr->fr_pd_flags & ~PD_ALLOWED_AT_FORK) != 0)
 909                         return (EINVAL);
 910         }
 911
 912         p1 = td->td_proc;
 913
 914         /*
 915          * Here we don't create a new process, but we divorce
 916          * certain parts of a process from itself.
 917          */
 918         if ((flags & RFPROC) == 0) {
 919                 if (fr->fr_procp != NULL)
 920                         *fr->fr_procp = NULL;
 921                 else if (fr->fr_pidp != NULL)
 922                         *fr->fr_pidp = 0;
 923                 return (fork_norfproc(td, flags));
 924         }
 925
 926         fp_procdesc = NULL;
 927         newproc = NULL;
 928         vm2 = NULL;
 929
 930         /*
 931          * Increment the nprocs resource before allocations occur.
 932          * Although process entries are dynamically created, we still
 933          * keep a global limit on the maximum number we will
 934          * create. There are hard-limits as to the number of processes
 935          * that can run, established by the KVA and memory usage for
 936          * the process data.
 937          *
 938          * Don't allow a nonprivileged user to use the last ten
 939          * processes; don't let root exceed the limit.
 940          */
 941         nprocs_new = atomic_fetchadd_int(&nprocs, 1) + 1;
 942         if (nprocs_new >= maxproc - 10) {
 943                 if (priv_check_cred(td->td_ucred, PRIV_MAXPROC) != 0 ||
 944                     nprocs_new >= maxproc) {
 945                         error = EAGAIN;
 946                         sx_xlock(&allproc_lock);
 947                         if (ppsratecheck(&lastfail, &curfail, 1)) {
 948                                 printf("maxproc limit exceeded by uid %u "
 949                                     "(pid %d); see tuning(7) and "
 950                                     "login.conf(5)\n",
 951                                     td->td_ucred->cr_ruid, p1->p_pid);
 952                         }
 953                         sx_xunlock(&allproc_lock);
 954                         goto fail2;
 955                 }
 956         }
 957
 958         /*
 959          * If required, create a process descriptor in the parent first; we
 960          * will abandon it if something goes wrong. We don't finit() until
 961          * later.
 962          */
 963         if (flags & RFPROCDESC) {
 964                 error = procdesc_falloc(td, &fp_procdesc, fr->fr_pd_fd,
 965                     fr->fr_pd_flags, fr->fr_pd_fcaps);
 966                 if (error != 0)
 967                         goto fail2;
 968                 AUDIT_ARG_FD(*fr->fr_pd_fd);
 969         }
 970
 971         mem_charged = 0;
 972         if (pages == 0)
 973                 pages = kstack_pages;
 974         /* Allocate new proc. */
 975         newproc = uma_zalloc(proc_zone, M_WAITOK);
 976         td2 = FIRST_THREAD_IN_PROC(newproc);
 977         if (td2 == NULL) {
 978                 td2 = thread_alloc(pages);
 979                 if (td2 == NULL) {
 980                         error = ENOMEM;
 981                         goto fail2;
 982                 }
 983                 proc_linkup(newproc, td2);
 984         } else {
 985                 kmsan_thread_alloc(td2);
 986                 if (td2->td_kstack == 0 || td2->td_kstack_pages != pages) {
 987                         if (td2->td_kstack != 0)
 988                                 vm_thread_dispose(td2);
 989                         if (!thread_alloc_stack(td2, pages)) {
 990                                 error = ENOMEM;
 991                                 goto fail2;
 992                         }
 993                 }
 994         }
 995
 996         if ((flags & RFMEM) == 0) {
 997                 vm2 = vmspace_fork(p1->p_vmspace, &mem_charged);
 998                 if (vm2 == NULL) {
 999                         error = ENOMEM;
1000                         goto fail2;
1001                 }
1002                 if (!swap_reserve(mem_charged)) {
1003                         /*
1004                          * The swap reservation failed. The accounting
1005                          * from the entries of the copied vm2 will be
1006                          * subtracted in vmspace_free(), so force the
1007                          * reservation there.
1008                          */
1009                         swap_reserve_force(mem_charged);
1010                         error = ENOMEM;
1011                         goto fail2;
1012                 }
1013         } else
1014                 vm2 = NULL;
1015
1016         /*
1017          * XXX: This is ugly; when we copy resource usage, we need to bump
1018          *      per-cred resource counters.
1019          */
1020         proc_set_cred_init(newproc, td->td_ucred);
1021
1022         /*
1023          * Initialize resource accounting for the child process.
1024          */
1025         error = racct_proc_fork(p1, newproc);
1026         if (error != 0) {
1027                 error = EAGAIN;
1028                 goto fail1;
1029         }
1030
1031 #ifdef MAC
1032         mac_proc_init(newproc);
1033 #endif
1034         newproc->p_klist = knlist_alloc(&newproc->p_mtx);
1035         STAILQ_INIT(&newproc->p_ktr);
1036
1037         /*
1038          * Increment the count of procs running with this uid. Don't allow
1039          * a nonprivileged user to exceed their current limit.
1040          */
1041         cred = td->td_ucred;
1042         if (!chgproccnt(cred->cr_ruidinfo, 1, lim_cur(td, RLIMIT_NPROC))) {
1043                 if (priv_check_cred(cred, PRIV_PROC_LIMIT) != 0)
1044                         goto fail0;
1045                 chgproccnt(cred->cr_ruidinfo, 1, 0);
1046         }
1047
1048         do_fork(td, fr, newproc, td2, vm2, fp_procdesc);
1049         return (0);
1050 fail0:
1051         error = EAGAIN;
1052 #ifdef MAC
1053         mac_proc_destroy(newproc);
1054 #endif
1055         racct_proc_exit(newproc);
1056 fail1:
1057         proc_unset_cred(newproc);
1058 fail2:
1059         if (vm2 != NULL)
1060                 vmspace_free(vm2);
1061         uma_zfree(proc_zone, newproc);
1062         if ((flags & RFPROCDESC) != 0 && fp_procdesc != NULL) {
1063                 fdclose(td, fp_procdesc, *fr->fr_pd_fd);
1064                 fdrop(fp_procdesc, td);
1065         }
1066         atomic_add_int(&nprocs, -1);
1067         pause("fork", hz / 2);
1068         return (error);
1069 }
1070
1071 /*
1072  * Handle the return of a child process from fork1().  This function
1073  * is called from the MD fork_trampoline() entry point.
1074  */
1075 void
1076 fork_exit(void (*callout)(void *, struct trapframe *), void *arg,
1077     struct trapframe *frame)
1078 {
1079         struct proc *p;
1080         struct thread *td;
1081         struct thread *dtd;
1082
1083         kmsan_mark(frame, sizeof(*frame), KMSAN_STATE_INITED);
1084
1085         td = curthread;
1086         p = td->td_proc;
1087         KASSERT(p->p_state == PRS_NORMAL, ("executing process is still new"));
1088
1089         CTR4(KTR_PROC, "fork_exit: new thread %p (td_sched %p, pid %d, %s)",
1090             td, td_get_sched(td), p->p_pid, td->td_name);
1091
1092         sched_fork_exit(td);
1093         /*
1094         * Processes normally resume in mi_switch() after being
1095         * cpu_switch()'ed to, but when children start up they arrive here
1096         * instead, so we must do much the same things as mi_switch() would.
1097         */
1098         if ((dtd = PCPU_GET(deadthread))) {
1099                 PCPU_SET(deadthread, NULL);
1100                 thread_stash(dtd);
1101         }
1102         thread_unlock(td);
1103
1104         /*
1105          * cpu_fork_kthread_handler intercepts this function call to
1106          * have this call a non-return function to stay in kernel mode.
1107          * initproc has its own fork handler, but it does return.
1108          */
1109         KASSERT(callout != NULL, ("NULL callout in fork_exit"));
1110         callout(arg, frame);
1111
1112         /*
1113          * Check if a kernel thread misbehaved and returned from its main
1114          * function.
1115          */
1116         if (p->p_flag & P_KPROC) {
1117                 printf("Kernel thread \"%s\" (pid %d) exited prematurely.\n",
1118                     td->td_name, p->p_pid);
1119                 kthread_exit();
1120         }
1121         mtx_assert(&Giant, MA_NOTOWNED);
1122
1123         if (p->p_sysent->sv_schedtail != NULL)
1124                 (p->p_sysent->sv_schedtail)(td);
1125 }
1126
1127 /*
1128  * Simplified back end of syscall(), used when returning from fork()
1129  * directly into user mode.  This function is passed in to fork_exit()
1130  * as the first parameter and is called when returning to a new
1131  * userland process.
1132  */
1133 void
1134 fork_return(struct thread *td, struct trapframe *frame)
1135 {
1136         struct proc *p;
1137
1138         p = td->td_proc;
1139         if (td->td_dbgflags & TDB_STOPATFORK) {
1140                 PROC_LOCK(p);
1141                 if ((p->p_flag & P_TRACED) != 0) {
1142                         /*
1143                          * Inform the debugger if one is still present.
1144                          */
1145                         td->td_dbgflags |= TDB_CHILD | TDB_SCX | TDB_FSTP;
1146                         ptracestop(td, SIGSTOP, NULL);
1147                         td->td_dbgflags &= ~(TDB_CHILD | TDB_SCX);
1148                 } else {
1149                         /*
1150                          * ... otherwise clear the request.
1151                          */
1152                         td->td_dbgflags &= ~TDB_STOPATFORK;
1153                 }
1154                 PROC_UNLOCK(p);
1155         } else if (p->p_flag & P_TRACED || td->td_dbgflags & TDB_BORN) {
1156                 /*
1157                  * This is the start of a new thread in a traced
1158                  * process.  Report a system call exit event.
1159                  */
1160                 PROC_LOCK(p);
1161                 td->td_dbgflags |= TDB_SCX;
1162                 if ((p->p_ptevents & PTRACE_SCX) != 0 ||
1163                     (td->td_dbgflags & TDB_BORN) != 0)
1164                         ptracestop(td, SIGTRAP, NULL);
1165                 td->td_dbgflags &= ~(TDB_SCX | TDB_BORN);
1166                 PROC_UNLOCK(p);
1167         }
1168
1169         /*
1170          * If the prison was killed mid-fork, die along with it.
1171          */
1172         if (!prison_isalive(td->td_ucred->cr_prison))
1173                 exit1(td, 0, SIGKILL);
1174
1175         userret(td, frame);
1176
1177 #ifdef KTRACE
1178         if (KTRPOINT(td, KTR_SYSRET))
1179                 ktrsysret(SYS_fork, 0, 0);
1180 #endif
1181 }
1182
1183 static void
1184 fork_init(void *arg __unused)
1185 {
1186         ast_register(TDA_VFORK, ASTR_ASTF_REQUIRED | ASTR_TDP, TDP_RFPPWAIT,
1187             ast_vfork);
1188 }
1189 SYSINIT(fork, SI_SUB_INTRINSIC, SI_ORDER_ANY, fork_init, NULL);