]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/kern_fork.c
mandoc: import version 1.14.6
[FreeBSD/FreeBSD.git] / 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         int error;
311         struct proc *p1;
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         if ((p1->p_flag & (P_HADTHREADS | P_SYSTEM)) == P_HADTHREADS &&
323             ((flags & (RFCFDG | RFFDG)) != 0 || (flags & RFMEM) == 0)) {
324                 PROC_LOCK(p1);
325                 if (thread_single(p1, SINGLE_BOUNDARY)) {
326                         PROC_UNLOCK(p1);
327                         return (ERESTART);
328                 }
329                 PROC_UNLOCK(p1);
330         }
331
332         error = vm_forkproc(td, NULL, NULL, NULL, flags);
333         if (error)
334                 goto fail;
335
336         /*
337          * Close all file descriptors.
338          */
339         if (flags & RFCFDG) {
340                 struct filedesc *fdtmp;
341                 struct pwddesc *pdtmp;
342                 pdtmp = pdinit(td->td_proc->p_pd, false);
343                 fdtmp = fdinit(td->td_proc->p_fd, false, NULL);
344                 pdescfree(td);
345                 fdescfree(td);
346                 p1->p_fd = fdtmp;
347                 p1->p_pd = pdtmp;
348         }
349
350         /*
351          * Unshare file descriptors (from parent).
352          */
353         if (flags & RFFDG) {
354                 fdunshare(td);
355                 pdunshare(td);
356         }
357
358 fail:
359         if ((p1->p_flag & (P_HADTHREADS | P_SYSTEM)) == P_HADTHREADS &&
360             ((flags & (RFCFDG | RFFDG)) != 0 || (flags & RFMEM) == 0)) {
361                 PROC_LOCK(p1);
362                 thread_single_end(p1, SINGLE_BOUNDARY);
363                 PROC_UNLOCK(p1);
364         }
365         return (error);
366 }
367
368 static void
369 do_fork(struct thread *td, struct fork_req *fr, struct proc *p2, struct thread *td2,
370     struct vmspace *vm2, struct file *fp_procdesc)
371 {
372         struct proc *p1, *pptr;
373         struct filedesc *fd;
374         struct filedesc_to_leader *fdtol;
375         struct pwddesc *pd;
376         struct sigacts *newsigacts;
377
378         p1 = td->td_proc;
379
380         PROC_LOCK(p1);
381         bcopy(&p1->p_startcopy, &p2->p_startcopy,
382             __rangeof(struct proc, p_startcopy, p_endcopy));
383         pargs_hold(p2->p_args);
384         PROC_UNLOCK(p1);
385
386         bzero(&p2->p_startzero,
387             __rangeof(struct proc, p_startzero, p_endzero));
388
389         /* Tell the prison that we exist. */
390         prison_proc_hold(p2->p_ucred->cr_prison);
391
392         p2->p_state = PRS_NEW;          /* protect against others */
393         p2->p_pid = fork_findpid(fr->fr_flags);
394         AUDIT_ARG_PID(p2->p_pid);
395         TSFORK(p2->p_pid, p1->p_pid);
396
397         sx_xlock(&allproc_lock);
398         LIST_INSERT_HEAD(&allproc, p2, p_list);
399         allproc_gen++;
400         sx_xunlock(&allproc_lock);
401
402         sx_xlock(PIDHASHLOCK(p2->p_pid));
403         LIST_INSERT_HEAD(PIDHASH(p2->p_pid), p2, p_hash);
404         sx_xunlock(PIDHASHLOCK(p2->p_pid));
405
406         tidhash_add(td2);
407
408         /*
409          * Malloc things while we don't hold any locks.
410          */
411         if (fr->fr_flags & RFSIGSHARE)
412                 newsigacts = NULL;
413         else
414                 newsigacts = sigacts_alloc();
415
416         /*
417          * Copy filedesc.
418          */
419         if (fr->fr_flags & RFCFDG) {
420                 pd = pdinit(p1->p_pd, false);
421                 fd = fdinit(p1->p_fd, false, NULL);
422                 fdtol = NULL;
423         } else if (fr->fr_flags & RFFDG) {
424                 if (fr->fr_flags2 & FR2_SHARE_PATHS)
425                         pd = pdshare(p1->p_pd);
426                 else
427                         pd = pdcopy(p1->p_pd);
428                 fd = fdcopy(p1->p_fd);
429                 fdtol = NULL;
430         } else {
431                 if (fr->fr_flags2 & FR2_SHARE_PATHS)
432                         pd = pdcopy(p1->p_pd);
433                 else
434                         pd = pdshare(p1->p_pd);
435                 fd = fdshare(p1->p_fd);
436                 if (p1->p_fdtol == NULL)
437                         p1->p_fdtol = filedesc_to_leader_alloc(NULL, NULL,
438                             p1->p_leader);
439                 if ((fr->fr_flags & RFTHREAD) != 0) {
440                         /*
441                          * Shared file descriptor table, and shared
442                          * process leaders.
443                          */
444                         fdtol = p1->p_fdtol;
445                         FILEDESC_XLOCK(p1->p_fd);
446                         fdtol->fdl_refcount++;
447                         FILEDESC_XUNLOCK(p1->p_fd);
448                 } else {
449                         /*
450                          * Shared file descriptor table, and different
451                          * process leaders.
452                          */
453                         fdtol = filedesc_to_leader_alloc(p1->p_fdtol,
454                             p1->p_fd, p2);
455                 }
456         }
457         /*
458          * Make a proc table entry for the new process.
459          * Start by zeroing the section of proc that is zero-initialized,
460          * then copy the section that is copied directly from the parent.
461          */
462
463         PROC_LOCK(p2);
464         PROC_LOCK(p1);
465
466         bzero(&td2->td_startzero,
467             __rangeof(struct thread, td_startzero, td_endzero));
468
469         bcopy(&td->td_startcopy, &td2->td_startcopy,
470             __rangeof(struct thread, td_startcopy, td_endcopy));
471
472         bcopy(&p2->p_comm, &td2->td_name, sizeof(td2->td_name));
473         td2->td_sigstk = td->td_sigstk;
474         td2->td_flags = TDF_INMEM;
475         td2->td_lend_user_pri = PRI_MAX;
476
477 #ifdef VIMAGE
478         td2->td_vnet = NULL;
479         td2->td_vnet_lpush = NULL;
480 #endif
481
482         /*
483          * Allow the scheduler to initialize the child.
484          */
485         thread_lock(td);
486         sched_fork(td, td2);
487         thread_unlock(td);
488
489         /*
490          * Duplicate sub-structures as needed.
491          * Increase reference counts on shared objects.
492          */
493         p2->p_flag = P_INMEM;
494         p2->p_flag2 = p1->p_flag2 & (P2_ASLR_DISABLE | P2_ASLR_ENABLE |
495             P2_ASLR_IGNSTART | P2_NOTRACE | P2_NOTRACE_EXEC |
496             P2_PROTMAX_ENABLE | P2_PROTMAX_DISABLE | P2_TRAPCAP |
497             P2_STKGAP_DISABLE | P2_STKGAP_DISABLE_EXEC | P2_NO_NEW_PRIVS |
498             P2_WXORX_DISABLE | P2_WXORX_ENABLE_EXEC);
499         p2->p_swtick = ticks;
500         if (p1->p_flag & P_PROFIL)
501                 startprofclock(p2);
502
503         if (fr->fr_flags & RFSIGSHARE) {
504                 p2->p_sigacts = sigacts_hold(p1->p_sigacts);
505         } else {
506                 sigacts_copy(newsigacts, p1->p_sigacts);
507                 p2->p_sigacts = newsigacts;
508                 if ((fr->fr_flags2 & (FR2_DROPSIG_CAUGHT | FR2_KPROC)) != 0) {
509                         mtx_lock(&p2->p_sigacts->ps_mtx);
510                         if ((fr->fr_flags2 & FR2_DROPSIG_CAUGHT) != 0)
511                                 sig_drop_caught(p2);
512                         if ((fr->fr_flags2 & FR2_KPROC) != 0)
513                                 p2->p_sigacts->ps_flag |= PS_NOCLDWAIT;
514                         mtx_unlock(&p2->p_sigacts->ps_mtx);
515                 }
516         }
517
518         if (fr->fr_flags & RFTSIGZMB)
519                 p2->p_sigparent = RFTSIGNUM(fr->fr_flags);
520         else if (fr->fr_flags & RFLINUXTHPN)
521                 p2->p_sigparent = SIGUSR1;
522         else
523                 p2->p_sigparent = SIGCHLD;
524
525         if ((fr->fr_flags2 & FR2_KPROC) != 0) {
526                 p2->p_flag |= P_SYSTEM | P_KPROC;
527                 td2->td_pflags |= TDP_KTHREAD;
528         }
529
530         p2->p_textvp = p1->p_textvp;
531         p2->p_textdvp = p1->p_textdvp;
532         p2->p_fd = fd;
533         p2->p_fdtol = fdtol;
534         p2->p_pd = pd;
535
536         if (p1->p_flag2 & P2_INHERIT_PROTECTED) {
537                 p2->p_flag |= P_PROTECTED;
538                 p2->p_flag2 |= P2_INHERIT_PROTECTED;
539         }
540
541         /*
542          * p_limit is copy-on-write.  Bump its refcount.
543          */
544         lim_fork(p1, p2);
545
546         thread_cow_get_proc(td2, p2);
547
548         pstats_fork(p1->p_stats, p2->p_stats);
549
550         PROC_UNLOCK(p1);
551         PROC_UNLOCK(p2);
552
553         /*
554          * Bump references to the text vnode and directory, and copy
555          * the hardlink name.
556          */
557         if (p2->p_textvp != NULL)
558                 vrefact(p2->p_textvp);
559         if (p2->p_textdvp != NULL)
560                 vrefact(p2->p_textdvp);
561         p2->p_binname = p1->p_binname == NULL ? NULL :
562             strdup(p1->p_binname, M_PARGS);
563
564         /*
565          * Set up linkage for kernel based threading.
566          */
567         if ((fr->fr_flags & RFTHREAD) != 0) {
568                 mtx_lock(&ppeers_lock);
569                 p2->p_peers = p1->p_peers;
570                 p1->p_peers = p2;
571                 p2->p_leader = p1->p_leader;
572                 mtx_unlock(&ppeers_lock);
573                 PROC_LOCK(p1->p_leader);
574                 if ((p1->p_leader->p_flag & P_WEXIT) != 0) {
575                         PROC_UNLOCK(p1->p_leader);
576                         /*
577                          * The task leader is exiting, so process p1 is
578                          * going to be killed shortly.  Since p1 obviously
579                          * isn't dead yet, we know that the leader is either
580                          * sending SIGKILL's to all the processes in this
581                          * task or is sleeping waiting for all the peers to
582                          * exit.  We let p1 complete the fork, but we need
583                          * to go ahead and kill the new process p2 since
584                          * the task leader may not get a chance to send
585                          * SIGKILL to it.  We leave it on the list so that
586                          * the task leader will wait for this new process
587                          * to commit suicide.
588                          */
589                         PROC_LOCK(p2);
590                         kern_psignal(p2, SIGKILL);
591                         PROC_UNLOCK(p2);
592                 } else
593                         PROC_UNLOCK(p1->p_leader);
594         } else {
595                 p2->p_peers = NULL;
596                 p2->p_leader = p2;
597         }
598
599         sx_xlock(&proctree_lock);
600         PGRP_LOCK(p1->p_pgrp);
601         PROC_LOCK(p2);
602         PROC_LOCK(p1);
603
604         /*
605          * Preserve some more flags in subprocess.  P_PROFIL has already
606          * been preserved.
607          */
608         p2->p_flag |= p1->p_flag & P_SUGID;
609         td2->td_pflags |= (td->td_pflags & (TDP_ALTSTACK | TDP_SIGFASTBLOCK));
610         SESS_LOCK(p1->p_session);
611         if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
612                 p2->p_flag |= P_CONTROLT;
613         SESS_UNLOCK(p1->p_session);
614         if (fr->fr_flags & RFPPWAIT)
615                 p2->p_flag |= P_PPWAIT;
616
617         p2->p_pgrp = p1->p_pgrp;
618         LIST_INSERT_AFTER(p1, p2, p_pglist);
619         PGRP_UNLOCK(p1->p_pgrp);
620         LIST_INIT(&p2->p_children);
621         LIST_INIT(&p2->p_orphans);
622
623         callout_init_mtx(&p2->p_itcallout, &p2->p_mtx, 0);
624         TAILQ_INIT(&p2->p_kqtim_stop);
625
626         /*
627          * This begins the section where we must prevent the parent
628          * from being swapped.
629          */
630         _PHOLD(p1);
631         PROC_UNLOCK(p1);
632
633         /*
634          * Attach the new process to its parent.
635          *
636          * If RFNOWAIT is set, the newly created process becomes a child
637          * of init.  This effectively disassociates the child from the
638          * parent.
639          */
640         if ((fr->fr_flags & RFNOWAIT) != 0) {
641                 pptr = p1->p_reaper;
642                 p2->p_reaper = pptr;
643         } else {
644                 p2->p_reaper = (p1->p_treeflag & P_TREE_REAPER) != 0 ?
645                     p1 : p1->p_reaper;
646                 pptr = p1;
647         }
648         p2->p_pptr = pptr;
649         p2->p_oppid = pptr->p_pid;
650         LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
651         LIST_INIT(&p2->p_reaplist);
652         LIST_INSERT_HEAD(&p2->p_reaper->p_reaplist, p2, p_reapsibling);
653         if (p2->p_reaper == p1 && p1 != initproc) {
654                 p2->p_reapsubtree = p2->p_pid;
655                 proc_id_set_cond(PROC_ID_REAP, p2->p_pid);
656         }
657         sx_xunlock(&proctree_lock);
658
659         /* Inform accounting that we have forked. */
660         p2->p_acflag = AFORK;
661         PROC_UNLOCK(p2);
662
663 #ifdef KTRACE
664         ktrprocfork(p1, p2);
665 #endif
666
667         /*
668          * Finish creating the child process.  It will return via a different
669          * execution path later.  (ie: directly into user mode)
670          */
671         vm_forkproc(td, p2, td2, vm2, fr->fr_flags);
672
673         if (fr->fr_flags == (RFFDG | RFPROC)) {
674                 VM_CNT_INC(v_forks);
675                 VM_CNT_ADD(v_forkpages, p2->p_vmspace->vm_dsize +
676                     p2->p_vmspace->vm_ssize);
677         } else if (fr->fr_flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM)) {
678                 VM_CNT_INC(v_vforks);
679                 VM_CNT_ADD(v_vforkpages, p2->p_vmspace->vm_dsize +
680                     p2->p_vmspace->vm_ssize);
681         } else if (p1 == &proc0) {
682                 VM_CNT_INC(v_kthreads);
683                 VM_CNT_ADD(v_kthreadpages, p2->p_vmspace->vm_dsize +
684                     p2->p_vmspace->vm_ssize);
685         } else {
686                 VM_CNT_INC(v_rforks);
687                 VM_CNT_ADD(v_rforkpages, p2->p_vmspace->vm_dsize +
688                     p2->p_vmspace->vm_ssize);
689         }
690
691         /*
692          * Associate the process descriptor with the process before anything
693          * can happen that might cause that process to need the descriptor.
694          * However, don't do this until after fork(2) can no longer fail.
695          */
696         if (fr->fr_flags & RFPROCDESC)
697                 procdesc_new(p2, fr->fr_pd_flags);
698
699         /*
700          * Both processes are set up, now check if any loadable modules want
701          * to adjust anything.
702          */
703         EVENTHANDLER_DIRECT_INVOKE(process_fork, p1, p2, fr->fr_flags);
704
705         /*
706          * Set the child start time and mark the process as being complete.
707          */
708         PROC_LOCK(p2);
709         PROC_LOCK(p1);
710         microuptime(&p2->p_stats->p_start);
711         PROC_SLOCK(p2);
712         p2->p_state = PRS_NORMAL;
713         PROC_SUNLOCK(p2);
714
715 #ifdef KDTRACE_HOOKS
716         /*
717          * Tell the DTrace fasttrap provider about the new process so that any
718          * tracepoints inherited from the parent can be removed. We have to do
719          * this only after p_state is PRS_NORMAL since the fasttrap module will
720          * use pfind() later on.
721          */
722         if ((fr->fr_flags & RFMEM) == 0 && dtrace_fasttrap_fork)
723                 dtrace_fasttrap_fork(p1, p2);
724 #endif
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          * Tell any interested parties about the new process.
734          */
735         knote_fork(p1->p_klist, p2->p_pid);
736
737         /*
738          * Now can be swapped.
739          */
740         _PRELE(p1);
741         PROC_UNLOCK(p1);
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, false);
779                 }
780                 PROC_UNLOCK(p2);
781                 sx_xunlock(&proctree_lock);
782         }
783
784         racct_proc_fork_done(p2);
785
786         if ((fr->fr_flags & RFSTOPPED) == 0) {
787                 if (fr->fr_pidp != NULL)
788                         *fr->fr_pidp = p2->p_pid;
789                 /*
790                  * If RFSTOPPED not requested, make child runnable and
791                  * add to run queue.
792                  */
793                 thread_lock(td2);
794                 TD_SET_CAN_RUN(td2);
795                 sched_add(td2, SRQ_BORING);
796         } else {
797                 *fr->fr_procp = p2;
798         }
799 }
800
801 void
802 fork_rfppwait(struct thread *td)
803 {
804         struct proc *p, *p2;
805
806         MPASS(td->td_pflags & TDP_RFPPWAIT);
807
808         p = td->td_proc;
809         /*
810          * Preserve synchronization semantics of vfork.  If
811          * waiting for child to exec or exit, fork set
812          * P_PPWAIT on child, and there we sleep on our proc
813          * (in case of exit).
814          *
815          * Do it after the ptracestop() above is finished, to
816          * not block our debugger until child execs or exits
817          * to finish vfork wait.
818          */
819         td->td_pflags &= ~TDP_RFPPWAIT;
820         p2 = td->td_rfppwait_p;
821 again:
822         PROC_LOCK(p2);
823         while (p2->p_flag & P_PPWAIT) {
824                 PROC_LOCK(p);
825                 if (thread_suspend_check_needed()) {
826                         PROC_UNLOCK(p2);
827                         thread_suspend_check(0);
828                         PROC_UNLOCK(p);
829                         goto again;
830                 } else {
831                         PROC_UNLOCK(p);
832                 }
833                 cv_timedwait(&p2->p_pwait, &p2->p_mtx, hz);
834         }
835         PROC_UNLOCK(p2);
836
837         if (td->td_dbgflags & TDB_VFORK) {
838                 PROC_LOCK(p);
839                 if (p->p_ptevents & PTRACE_VFORK)
840                         ptracestop(td, SIGTRAP, NULL);
841                 td->td_dbgflags &= ~TDB_VFORK;
842                 PROC_UNLOCK(p);
843         }
844 }
845
846 int
847 fork1(struct thread *td, struct fork_req *fr)
848 {
849         struct proc *p1, *newproc;
850         struct thread *td2;
851         struct vmspace *vm2;
852         struct ucred *cred;
853         struct file *fp_procdesc;
854         vm_ooffset_t mem_charged;
855         int error, nprocs_new;
856         static int curfail;
857         static struct timeval lastfail;
858         int flags, pages;
859
860         flags = fr->fr_flags;
861         pages = fr->fr_pages;
862
863         if ((flags & RFSTOPPED) != 0)
864                 MPASS(fr->fr_procp != NULL && fr->fr_pidp == NULL);
865         else
866                 MPASS(fr->fr_procp == NULL);
867
868         /* Check for the undefined or unimplemented flags. */
869         if ((flags & ~(RFFLAGS | RFTSIGFLAGS(RFTSIGMASK))) != 0)
870                 return (EINVAL);
871
872         /* Signal value requires RFTSIGZMB. */
873         if ((flags & RFTSIGFLAGS(RFTSIGMASK)) != 0 && (flags & RFTSIGZMB) == 0)
874                 return (EINVAL);
875
876         /* Can't copy and clear. */
877         if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
878                 return (EINVAL);
879
880         /* Check the validity of the signal number. */
881         if ((flags & RFTSIGZMB) != 0 && (u_int)RFTSIGNUM(flags) > _SIG_MAXSIG)
882                 return (EINVAL);
883
884         if ((flags & RFPROCDESC) != 0) {
885                 /* Can't not create a process yet get a process descriptor. */
886                 if ((flags & RFPROC) == 0)
887                         return (EINVAL);
888
889                 /* Must provide a place to put a procdesc if creating one. */
890                 if (fr->fr_pd_fd == NULL)
891                         return (EINVAL);
892
893                 /* Check if we are using supported flags. */
894                 if ((fr->fr_pd_flags & ~PD_ALLOWED_AT_FORK) != 0)
895                         return (EINVAL);
896         }
897
898         p1 = td->td_proc;
899
900         /*
901          * Here we don't create a new process, but we divorce
902          * certain parts of a process from itself.
903          */
904         if ((flags & RFPROC) == 0) {
905                 if (fr->fr_procp != NULL)
906                         *fr->fr_procp = NULL;
907                 else if (fr->fr_pidp != NULL)
908                         *fr->fr_pidp = 0;
909                 return (fork_norfproc(td, flags));
910         }
911
912         fp_procdesc = NULL;
913         newproc = NULL;
914         vm2 = NULL;
915
916         /*
917          * Increment the nprocs resource before allocations occur.
918          * Although process entries are dynamically created, we still
919          * keep a global limit on the maximum number we will
920          * create. There are hard-limits as to the number of processes
921          * that can run, established by the KVA and memory usage for
922          * the process data.
923          *
924          * Don't allow a nonprivileged user to use the last ten
925          * processes; don't let root exceed the limit.
926          */
927         nprocs_new = atomic_fetchadd_int(&nprocs, 1) + 1;
928         if (nprocs_new >= maxproc - 10) {
929                 if (priv_check_cred(td->td_ucred, PRIV_MAXPROC) != 0 ||
930                     nprocs_new >= maxproc) {
931                         error = EAGAIN;
932                         sx_xlock(&allproc_lock);
933                         if (ppsratecheck(&lastfail, &curfail, 1)) {
934                                 printf("maxproc limit exceeded by uid %u "
935                                     "(pid %d); see tuning(7) and "
936                                     "login.conf(5)\n",
937                                     td->td_ucred->cr_ruid, p1->p_pid);
938                         }
939                         sx_xunlock(&allproc_lock);
940                         goto fail2;
941                 }
942         }
943
944         /*
945          * If required, create a process descriptor in the parent first; we
946          * will abandon it if something goes wrong. We don't finit() until
947          * later.
948          */
949         if (flags & RFPROCDESC) {
950                 error = procdesc_falloc(td, &fp_procdesc, fr->fr_pd_fd,
951                     fr->fr_pd_flags, fr->fr_pd_fcaps);
952                 if (error != 0)
953                         goto fail2;
954                 AUDIT_ARG_FD(*fr->fr_pd_fd);
955         }
956
957         mem_charged = 0;
958         if (pages == 0)
959                 pages = kstack_pages;
960         /* Allocate new proc. */
961         newproc = uma_zalloc(proc_zone, M_WAITOK);
962         td2 = FIRST_THREAD_IN_PROC(newproc);
963         if (td2 == NULL) {
964                 td2 = thread_alloc(pages);
965                 if (td2 == NULL) {
966                         error = ENOMEM;
967                         goto fail2;
968                 }
969                 proc_linkup(newproc, td2);
970         } else {
971                 kmsan_thread_alloc(td2);
972                 if (td2->td_kstack == 0 || td2->td_kstack_pages != pages) {
973                         if (td2->td_kstack != 0)
974                                 vm_thread_dispose(td2);
975                         if (!thread_alloc_stack(td2, pages)) {
976                                 error = ENOMEM;
977                                 goto fail2;
978                         }
979                 }
980         }
981
982         if ((flags & RFMEM) == 0) {
983                 vm2 = vmspace_fork(p1->p_vmspace, &mem_charged);
984                 if (vm2 == NULL) {
985                         error = ENOMEM;
986                         goto fail2;
987                 }
988                 if (!swap_reserve(mem_charged)) {
989                         /*
990                          * The swap reservation failed. The accounting
991                          * from the entries of the copied vm2 will be
992                          * subtracted in vmspace_free(), so force the
993                          * reservation there.
994                          */
995                         swap_reserve_force(mem_charged);
996                         error = ENOMEM;
997                         goto fail2;
998                 }
999         } else
1000                 vm2 = NULL;
1001
1002         /*
1003          * XXX: This is ugly; when we copy resource usage, we need to bump
1004          *      per-cred resource counters.
1005          */
1006         proc_set_cred_init(newproc, td->td_ucred);
1007
1008         /*
1009          * Initialize resource accounting for the child process.
1010          */
1011         error = racct_proc_fork(p1, newproc);
1012         if (error != 0) {
1013                 error = EAGAIN;
1014                 goto fail1;
1015         }
1016
1017 #ifdef MAC
1018         mac_proc_init(newproc);
1019 #endif
1020         newproc->p_klist = knlist_alloc(&newproc->p_mtx);
1021         STAILQ_INIT(&newproc->p_ktr);
1022
1023         /*
1024          * Increment the count of procs running with this uid. Don't allow
1025          * a nonprivileged user to exceed their current limit.
1026          */
1027         cred = td->td_ucred;
1028         if (!chgproccnt(cred->cr_ruidinfo, 1, lim_cur(td, RLIMIT_NPROC))) {
1029                 if (priv_check_cred(cred, PRIV_PROC_LIMIT) != 0)
1030                         goto fail0;
1031                 chgproccnt(cred->cr_ruidinfo, 1, 0);
1032         }
1033
1034         do_fork(td, fr, newproc, td2, vm2, fp_procdesc);
1035         return (0);
1036 fail0:
1037         error = EAGAIN;
1038 #ifdef MAC
1039         mac_proc_destroy(newproc);
1040 #endif
1041         racct_proc_exit(newproc);
1042 fail1:
1043         proc_unset_cred(newproc);
1044 fail2:
1045         if (vm2 != NULL)
1046                 vmspace_free(vm2);
1047         uma_zfree(proc_zone, newproc);
1048         if ((flags & RFPROCDESC) != 0 && fp_procdesc != NULL) {
1049                 fdclose(td, fp_procdesc, *fr->fr_pd_fd);
1050                 fdrop(fp_procdesc, td);
1051         }
1052         atomic_add_int(&nprocs, -1);
1053         pause("fork", hz / 2);
1054         return (error);
1055 }
1056
1057 /*
1058  * Handle the return of a child process from fork1().  This function
1059  * is called from the MD fork_trampoline() entry point.
1060  */
1061 void
1062 fork_exit(void (*callout)(void *, struct trapframe *), void *arg,
1063     struct trapframe *frame)
1064 {
1065         struct proc *p;
1066         struct thread *td;
1067         struct thread *dtd;
1068
1069         kmsan_mark(frame, sizeof(*frame), KMSAN_STATE_INITED);
1070
1071         td = curthread;
1072         p = td->td_proc;
1073         KASSERT(p->p_state == PRS_NORMAL, ("executing process is still new"));
1074
1075         CTR4(KTR_PROC, "fork_exit: new thread %p (td_sched %p, pid %d, %s)",
1076             td, td_get_sched(td), p->p_pid, td->td_name);
1077
1078         sched_fork_exit(td);
1079         /*
1080         * Processes normally resume in mi_switch() after being
1081         * cpu_switch()'ed to, but when children start up they arrive here
1082         * instead, so we must do much the same things as mi_switch() would.
1083         */
1084         if ((dtd = PCPU_GET(deadthread))) {
1085                 PCPU_SET(deadthread, NULL);
1086                 thread_stash(dtd);
1087         }
1088         thread_unlock(td);
1089
1090         /*
1091          * cpu_fork_kthread_handler intercepts this function call to
1092          * have this call a non-return function to stay in kernel mode.
1093          * initproc has its own fork handler, but it does return.
1094          */
1095         KASSERT(callout != NULL, ("NULL callout in fork_exit"));
1096         callout(arg, frame);
1097
1098         /*
1099          * Check if a kernel thread misbehaved and returned from its main
1100          * function.
1101          */
1102         if (p->p_flag & P_KPROC) {
1103                 printf("Kernel thread \"%s\" (pid %d) exited prematurely.\n",
1104                     td->td_name, p->p_pid);
1105                 kthread_exit();
1106         }
1107         mtx_assert(&Giant, MA_NOTOWNED);
1108
1109         if (p->p_sysent->sv_schedtail != NULL)
1110                 (p->p_sysent->sv_schedtail)(td);
1111 }
1112
1113 /*
1114  * Simplified back end of syscall(), used when returning from fork()
1115  * directly into user mode.  This function is passed in to fork_exit()
1116  * as the first parameter and is called when returning to a new
1117  * userland process.
1118  */
1119 void
1120 fork_return(struct thread *td, struct trapframe *frame)
1121 {
1122         struct proc *p;
1123
1124         p = td->td_proc;
1125         if (td->td_dbgflags & TDB_STOPATFORK) {
1126                 PROC_LOCK(p);
1127                 if ((p->p_flag & P_TRACED) != 0) {
1128                         /*
1129                          * Inform the debugger if one is still present.
1130                          */
1131                         td->td_dbgflags |= TDB_CHILD | TDB_SCX | TDB_FSTP;
1132                         ptracestop(td, SIGSTOP, NULL);
1133                         td->td_dbgflags &= ~(TDB_CHILD | TDB_SCX);
1134                 } else {
1135                         /*
1136                          * ... otherwise clear the request.
1137                          */
1138                         td->td_dbgflags &= ~TDB_STOPATFORK;
1139                 }
1140                 PROC_UNLOCK(p);
1141         } else if (p->p_flag & P_TRACED || td->td_dbgflags & TDB_BORN) {
1142                 /*
1143                  * This is the start of a new thread in a traced
1144                  * process.  Report a system call exit event.
1145                  */
1146                 PROC_LOCK(p);
1147                 td->td_dbgflags |= TDB_SCX;
1148                 if ((p->p_ptevents & PTRACE_SCX) != 0 ||
1149                     (td->td_dbgflags & TDB_BORN) != 0)
1150                         ptracestop(td, SIGTRAP, NULL);
1151                 td->td_dbgflags &= ~(TDB_SCX | TDB_BORN);
1152                 PROC_UNLOCK(p);
1153         }
1154
1155         /*
1156          * If the prison was killed mid-fork, die along with it.
1157          */
1158         if (!prison_isalive(td->td_ucred->cr_prison))
1159                 exit1(td, 0, SIGKILL);
1160
1161         userret(td, frame);
1162
1163 #ifdef KTRACE
1164         if (KTRPOINT(td, KTR_SYSRET))
1165                 ktrsysret(SYS_fork, 0, 0);
1166 #endif
1167 }