xref: /freebsd/sys/kern/kern_fork.c (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
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 	pargs_hold(p2->p_args);
419 
420 	PROC_UNLOCK(p1);
421 
422 	bzero(&p2->p_startzero,
423 	    __rangeof(struct proc, p_startzero, p_endzero));
424 
425 	/* Tell the prison that we exist. */
426 	prison_proc_hold(p2->p_ucred->cr_prison);
427 
428 	PROC_UNLOCK(p2);
429 
430 	tidhash_add(td2);
431 
432 	/*
433 	 * Malloc things while we don't hold any locks.
434 	 */
435 	if (fr->fr_flags & RFSIGSHARE)
436 		newsigacts = NULL;
437 	else
438 		newsigacts = sigacts_alloc();
439 
440 	/*
441 	 * Copy filedesc.
442 	 */
443 	if (fr->fr_flags & RFCFDG) {
444 		fd = fdinit(p1->p_fd, false);
445 		fdtol = NULL;
446 	} else if (fr->fr_flags & RFFDG) {
447 		fd = fdcopy(p1->p_fd);
448 		fdtol = NULL;
449 	} else {
450 		fd = fdshare(p1->p_fd);
451 		if (p1->p_fdtol == NULL)
452 			p1->p_fdtol = filedesc_to_leader_alloc(NULL, NULL,
453 			    p1->p_leader);
454 		if ((fr->fr_flags & RFTHREAD) != 0) {
455 			/*
456 			 * Shared file descriptor table, and shared
457 			 * process leaders.
458 			 */
459 			fdtol = p1->p_fdtol;
460 			FILEDESC_XLOCK(p1->p_fd);
461 			fdtol->fdl_refcount++;
462 			FILEDESC_XUNLOCK(p1->p_fd);
463 		} else {
464 			/*
465 			 * Shared file descriptor table, and different
466 			 * process leaders.
467 			 */
468 			fdtol = filedesc_to_leader_alloc(p1->p_fdtol,
469 			    p1->p_fd, p2);
470 		}
471 	}
472 	/*
473 	 * Make a proc table entry for the new process.
474 	 * Start by zeroing the section of proc that is zero-initialized,
475 	 * then copy the section that is copied directly from the parent.
476 	 */
477 
478 	PROC_LOCK(p2);
479 	PROC_LOCK(p1);
480 
481 	bzero(&td2->td_startzero,
482 	    __rangeof(struct thread, td_startzero, td_endzero));
483 
484 	bcopy(&td->td_startcopy, &td2->td_startcopy,
485 	    __rangeof(struct thread, td_startcopy, td_endcopy));
486 
487 	bcopy(&p2->p_comm, &td2->td_name, sizeof(td2->td_name));
488 	td2->td_sigstk = td->td_sigstk;
489 	td2->td_flags = TDF_INMEM;
490 	td2->td_lend_user_pri = PRI_MAX;
491 
492 #ifdef VIMAGE
493 	td2->td_vnet = NULL;
494 	td2->td_vnet_lpush = NULL;
495 #endif
496 
497 	/*
498 	 * Allow the scheduler to initialize the child.
499 	 */
500 	thread_lock(td);
501 	sched_fork(td, td2);
502 	thread_unlock(td);
503 
504 	/*
505 	 * Duplicate sub-structures as needed.
506 	 * Increase reference counts on shared objects.
507 	 */
508 	p2->p_flag = P_INMEM;
509 	p2->p_flag2 = p1->p_flag2 & (P2_NOTRACE | P2_NOTRACE_EXEC | P2_TRAPCAP);
510 	p2->p_swtick = ticks;
511 	if (p1->p_flag & P_PROFIL)
512 		startprofclock(p2);
513 
514 	if (fr->fr_flags & RFSIGSHARE) {
515 		p2->p_sigacts = sigacts_hold(p1->p_sigacts);
516 	} else {
517 		sigacts_copy(newsigacts, p1->p_sigacts);
518 		p2->p_sigacts = newsigacts;
519 	}
520 
521 	if (fr->fr_flags & RFTSIGZMB)
522 	        p2->p_sigparent = RFTSIGNUM(fr->fr_flags);
523 	else if (fr->fr_flags & RFLINUXTHPN)
524 	        p2->p_sigparent = SIGUSR1;
525 	else
526 	        p2->p_sigparent = SIGCHLD;
527 
528 	p2->p_textvp = p1->p_textvp;
529 	p2->p_fd = fd;
530 	p2->p_fdtol = fdtol;
531 
532 	if (p1->p_flag2 & P2_INHERIT_PROTECTED) {
533 		p2->p_flag |= P_PROTECTED;
534 		p2->p_flag2 |= P2_INHERIT_PROTECTED;
535 	}
536 
537 	/*
538 	 * p_limit is copy-on-write.  Bump its refcount.
539 	 */
540 	lim_fork(p1, p2);
541 
542 	thread_cow_get_proc(td2, p2);
543 
544 	pstats_fork(p1->p_stats, p2->p_stats);
545 
546 	PROC_UNLOCK(p1);
547 	PROC_UNLOCK(p2);
548 
549 	/* Bump references to the text vnode (for procfs). */
550 	if (p2->p_textvp)
551 		vrefact(p2->p_textvp);
552 
553 	/*
554 	 * Set up linkage for kernel based threading.
555 	 */
556 	if ((fr->fr_flags & RFTHREAD) != 0) {
557 		mtx_lock(&ppeers_lock);
558 		p2->p_peers = p1->p_peers;
559 		p1->p_peers = p2;
560 		p2->p_leader = p1->p_leader;
561 		mtx_unlock(&ppeers_lock);
562 		PROC_LOCK(p1->p_leader);
563 		if ((p1->p_leader->p_flag & P_WEXIT) != 0) {
564 			PROC_UNLOCK(p1->p_leader);
565 			/*
566 			 * The task leader is exiting, so process p1 is
567 			 * going to be killed shortly.  Since p1 obviously
568 			 * isn't dead yet, we know that the leader is either
569 			 * sending SIGKILL's to all the processes in this
570 			 * task or is sleeping waiting for all the peers to
571 			 * exit.  We let p1 complete the fork, but we need
572 			 * to go ahead and kill the new process p2 since
573 			 * the task leader may not get a chance to send
574 			 * SIGKILL to it.  We leave it on the list so that
575 			 * the task leader will wait for this new process
576 			 * to commit suicide.
577 			 */
578 			PROC_LOCK(p2);
579 			kern_psignal(p2, SIGKILL);
580 			PROC_UNLOCK(p2);
581 		} else
582 			PROC_UNLOCK(p1->p_leader);
583 	} else {
584 		p2->p_peers = NULL;
585 		p2->p_leader = p2;
586 	}
587 
588 	sx_xlock(&proctree_lock);
589 	PGRP_LOCK(p1->p_pgrp);
590 	PROC_LOCK(p2);
591 	PROC_LOCK(p1);
592 
593 	/*
594 	 * Preserve some more flags in subprocess.  P_PROFIL has already
595 	 * been preserved.
596 	 */
597 	p2->p_flag |= p1->p_flag & P_SUGID;
598 	td2->td_pflags |= (td->td_pflags & TDP_ALTSTACK) | TDP_FORKING;
599 	SESS_LOCK(p1->p_session);
600 	if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
601 		p2->p_flag |= P_CONTROLT;
602 	SESS_UNLOCK(p1->p_session);
603 	if (fr->fr_flags & RFPPWAIT)
604 		p2->p_flag |= P_PPWAIT;
605 
606 	p2->p_pgrp = p1->p_pgrp;
607 	LIST_INSERT_AFTER(p1, p2, p_pglist);
608 	PGRP_UNLOCK(p1->p_pgrp);
609 	LIST_INIT(&p2->p_children);
610 	LIST_INIT(&p2->p_orphans);
611 
612 	callout_init_mtx(&p2->p_itcallout, &p2->p_mtx, 0);
613 
614 	/*
615 	 * If PF_FORK is set, the child process inherits the
616 	 * procfs ioctl flags from its parent.
617 	 */
618 	if (p1->p_pfsflags & PF_FORK) {
619 		p2->p_stops = p1->p_stops;
620 		p2->p_pfsflags = p1->p_pfsflags;
621 	}
622 
623 	/*
624 	 * This begins the section where we must prevent the parent
625 	 * from being swapped.
626 	 */
627 	_PHOLD(p1);
628 	PROC_UNLOCK(p1);
629 
630 	/*
631 	 * Attach the new process to its parent.
632 	 *
633 	 * If RFNOWAIT is set, the newly created process becomes a child
634 	 * of init.  This effectively disassociates the child from the
635 	 * parent.
636 	 */
637 	if ((fr->fr_flags & RFNOWAIT) != 0) {
638 		pptr = p1->p_reaper;
639 		p2->p_reaper = pptr;
640 	} else {
641 		p2->p_reaper = (p1->p_treeflag & P_TREE_REAPER) != 0 ?
642 		    p1 : p1->p_reaper;
643 		pptr = p1;
644 	}
645 	p2->p_pptr = pptr;
646 	LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
647 	LIST_INIT(&p2->p_reaplist);
648 	LIST_INSERT_HEAD(&p2->p_reaper->p_reaplist, p2, p_reapsibling);
649 	if (p2->p_reaper == p1)
650 		p2->p_reapsubtree = p2->p_pid;
651 	sx_xunlock(&proctree_lock);
652 
653 	/* Inform accounting that we have forked. */
654 	p2->p_acflag = AFORK;
655 	PROC_UNLOCK(p2);
656 
657 #ifdef KTRACE
658 	ktrprocfork(p1, p2);
659 #endif
660 
661 	/*
662 	 * Finish creating the child process.  It will return via a different
663 	 * execution path later.  (ie: directly into user mode)
664 	 */
665 	vm_forkproc(td, p2, td2, vm2, fr->fr_flags);
666 
667 	if (fr->fr_flags == (RFFDG | RFPROC)) {
668 		VM_CNT_INC(v_forks);
669 		VM_CNT_ADD(v_forkpages, p2->p_vmspace->vm_dsize +
670 		    p2->p_vmspace->vm_ssize);
671 	} else if (fr->fr_flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM)) {
672 		VM_CNT_INC(v_vforks);
673 		VM_CNT_ADD(v_vforkpages, p2->p_vmspace->vm_dsize +
674 		    p2->p_vmspace->vm_ssize);
675 	} else if (p1 == &proc0) {
676 		VM_CNT_INC(v_kthreads);
677 		VM_CNT_ADD(v_kthreadpages, p2->p_vmspace->vm_dsize +
678 		    p2->p_vmspace->vm_ssize);
679 	} else {
680 		VM_CNT_INC(v_rforks);
681 		VM_CNT_ADD(v_rforkpages, p2->p_vmspace->vm_dsize +
682 		    p2->p_vmspace->vm_ssize);
683 	}
684 
685 	/*
686 	 * Associate the process descriptor with the process before anything
687 	 * can happen that might cause that process to need the descriptor.
688 	 * However, don't do this until after fork(2) can no longer fail.
689 	 */
690 	if (fr->fr_flags & RFPROCDESC)
691 		procdesc_new(p2, fr->fr_pd_flags);
692 
693 	/*
694 	 * Both processes are set up, now check if any loadable modules want
695 	 * to adjust anything.
696 	 */
697 	EVENTHANDLER_DIRECT_INVOKE(process_fork, p1, p2, fr->fr_flags);
698 
699 	/*
700 	 * Set the child start time and mark the process as being complete.
701 	 */
702 	PROC_LOCK(p2);
703 	PROC_LOCK(p1);
704 	microuptime(&p2->p_stats->p_start);
705 	PROC_SLOCK(p2);
706 	p2->p_state = PRS_NORMAL;
707 	PROC_SUNLOCK(p2);
708 
709 #ifdef KDTRACE_HOOKS
710 	/*
711 	 * Tell the DTrace fasttrap provider about the new process so that any
712 	 * tracepoints inherited from the parent can be removed. We have to do
713 	 * this only after p_state is PRS_NORMAL since the fasttrap module will
714 	 * use pfind() later on.
715 	 */
716 	if ((fr->fr_flags & RFMEM) == 0 && dtrace_fasttrap_fork)
717 		dtrace_fasttrap_fork(p1, p2);
718 #endif
719 	/*
720 	 * Hold the process so that it cannot exit after we make it runnable,
721 	 * but before we wait for the debugger.
722 	 */
723 	_PHOLD(p2);
724 	if (p1->p_ptevents & PTRACE_FORK) {
725 		/*
726 		 * Arrange for debugger to receive the fork event.
727 		 *
728 		 * We can report PL_FLAG_FORKED regardless of
729 		 * P_FOLLOWFORK settings, but it does not make a sense
730 		 * for runaway child.
731 		 */
732 		td->td_dbgflags |= TDB_FORK;
733 		td->td_dbg_forked = p2->p_pid;
734 		td2->td_dbgflags |= TDB_STOPATFORK;
735 	}
736 	if (fr->fr_flags & RFPPWAIT) {
737 		td->td_pflags |= TDP_RFPPWAIT;
738 		td->td_rfppwait_p = p2;
739 		td->td_dbgflags |= TDB_VFORK;
740 	}
741 	PROC_UNLOCK(p2);
742 
743 	/*
744 	 * Now can be swapped.
745 	 */
746 	_PRELE(p1);
747 	PROC_UNLOCK(p1);
748 
749 	/*
750 	 * Tell any interested parties about the new process.
751 	 */
752 	knote_fork(p1->p_klist, p2->p_pid);
753 	SDT_PROBE3(proc, , , create, p2, p1, fr->fr_flags);
754 
755 	if (fr->fr_flags & RFPROCDESC) {
756 		procdesc_finit(p2->p_procdesc, fp_procdesc);
757 		fdrop(fp_procdesc, td);
758 	}
759 
760 	if ((fr->fr_flags & RFSTOPPED) == 0) {
761 		/*
762 		 * If RFSTOPPED not requested, make child runnable and
763 		 * add to run queue.
764 		 */
765 		thread_lock(td2);
766 		TD_SET_CAN_RUN(td2);
767 		sched_add(td2, SRQ_BORING);
768 		thread_unlock(td2);
769 		if (fr->fr_pidp != NULL)
770 			*fr->fr_pidp = p2->p_pid;
771 	} else {
772 		*fr->fr_procp = p2;
773 	}
774 
775 	PROC_LOCK(p2);
776 	/*
777 	 * Wait until debugger is attached to child.
778 	 */
779 	while (td2->td_proc == p2 && (td2->td_dbgflags & TDB_STOPATFORK) != 0)
780 		cv_wait(&p2->p_dbgwait, &p2->p_mtx);
781 	_PRELE(p2);
782 	racct_proc_fork_done(p2);
783 	PROC_UNLOCK(p2);
784 }
785 
786 int
787 fork1(struct thread *td, struct fork_req *fr)
788 {
789 	struct proc *p1, *newproc;
790 	struct thread *td2;
791 	struct vmspace *vm2;
792 	struct file *fp_procdesc;
793 	vm_ooffset_t mem_charged;
794 	int error, nprocs_new, ok;
795 	static int curfail;
796 	static struct timeval lastfail;
797 	int flags, pages;
798 
799 	flags = fr->fr_flags;
800 	pages = fr->fr_pages;
801 
802 	if ((flags & RFSTOPPED) != 0)
803 		MPASS(fr->fr_procp != NULL && fr->fr_pidp == NULL);
804 	else
805 		MPASS(fr->fr_procp == NULL);
806 
807 	/* Check for the undefined or unimplemented flags. */
808 	if ((flags & ~(RFFLAGS | RFTSIGFLAGS(RFTSIGMASK))) != 0)
809 		return (EINVAL);
810 
811 	/* Signal value requires RFTSIGZMB. */
812 	if ((flags & RFTSIGFLAGS(RFTSIGMASK)) != 0 && (flags & RFTSIGZMB) == 0)
813 		return (EINVAL);
814 
815 	/* Can't copy and clear. */
816 	if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
817 		return (EINVAL);
818 
819 	/* Check the validity of the signal number. */
820 	if ((flags & RFTSIGZMB) != 0 && (u_int)RFTSIGNUM(flags) > _SIG_MAXSIG)
821 		return (EINVAL);
822 
823 	if ((flags & RFPROCDESC) != 0) {
824 		/* Can't not create a process yet get a process descriptor. */
825 		if ((flags & RFPROC) == 0)
826 			return (EINVAL);
827 
828 		/* Must provide a place to put a procdesc if creating one. */
829 		if (fr->fr_pd_fd == NULL)
830 			return (EINVAL);
831 
832 		/* Check if we are using supported flags. */
833 		if ((fr->fr_pd_flags & ~PD_ALLOWED_AT_FORK) != 0)
834 			return (EINVAL);
835 	}
836 
837 	p1 = td->td_proc;
838 
839 	/*
840 	 * Here we don't create a new process, but we divorce
841 	 * certain parts of a process from itself.
842 	 */
843 	if ((flags & RFPROC) == 0) {
844 		if (fr->fr_procp != NULL)
845 			*fr->fr_procp = NULL;
846 		else if (fr->fr_pidp != NULL)
847 			*fr->fr_pidp = 0;
848 		return (fork_norfproc(td, flags));
849 	}
850 
851 	fp_procdesc = NULL;
852 	newproc = NULL;
853 	vm2 = NULL;
854 
855 	/*
856 	 * Increment the nprocs resource before allocations occur.
857 	 * Although process entries are dynamically created, we still
858 	 * keep a global limit on the maximum number we will
859 	 * create. There are hard-limits as to the number of processes
860 	 * that can run, established by the KVA and memory usage for
861 	 * the process data.
862 	 *
863 	 * Don't allow a nonprivileged user to use the last ten
864 	 * processes; don't let root exceed the limit.
865 	 */
866 	nprocs_new = atomic_fetchadd_int(&nprocs, 1) + 1;
867 	if ((nprocs_new >= maxproc - 10 && priv_check_cred(td->td_ucred,
868 	    PRIV_MAXPROC, 0) != 0) || nprocs_new >= maxproc) {
869 		error = EAGAIN;
870 		sx_xlock(&allproc_lock);
871 		if (ppsratecheck(&lastfail, &curfail, 1)) {
872 			printf("maxproc limit exceeded by uid %u (pid %d); "
873 			    "see tuning(7) and login.conf(5)\n",
874 			    td->td_ucred->cr_ruid, p1->p_pid);
875 		}
876 		sx_xunlock(&allproc_lock);
877 		goto fail2;
878 	}
879 
880 	/*
881 	 * If required, create a process descriptor in the parent first; we
882 	 * will abandon it if something goes wrong. We don't finit() until
883 	 * later.
884 	 */
885 	if (flags & RFPROCDESC) {
886 		error = procdesc_falloc(td, &fp_procdesc, fr->fr_pd_fd,
887 		    fr->fr_pd_flags, fr->fr_pd_fcaps);
888 		if (error != 0)
889 			goto fail2;
890 	}
891 
892 	mem_charged = 0;
893 	if (pages == 0)
894 		pages = kstack_pages;
895 	/* Allocate new proc. */
896 	newproc = uma_zalloc(proc_zone, M_WAITOK);
897 	td2 = FIRST_THREAD_IN_PROC(newproc);
898 	if (td2 == NULL) {
899 		td2 = thread_alloc(pages);
900 		if (td2 == NULL) {
901 			error = ENOMEM;
902 			goto fail2;
903 		}
904 		proc_linkup(newproc, td2);
905 	} else {
906 		if (td2->td_kstack == 0 || td2->td_kstack_pages != pages) {
907 			if (td2->td_kstack != 0)
908 				vm_thread_dispose(td2);
909 			if (!thread_alloc_stack(td2, pages)) {
910 				error = ENOMEM;
911 				goto fail2;
912 			}
913 		}
914 	}
915 
916 	if ((flags & RFMEM) == 0) {
917 		vm2 = vmspace_fork(p1->p_vmspace, &mem_charged);
918 		if (vm2 == NULL) {
919 			error = ENOMEM;
920 			goto fail2;
921 		}
922 		if (!swap_reserve(mem_charged)) {
923 			/*
924 			 * The swap reservation failed. The accounting
925 			 * from the entries of the copied vm2 will be
926 			 * subtracted in vmspace_free(), so force the
927 			 * reservation there.
928 			 */
929 			swap_reserve_force(mem_charged);
930 			error = ENOMEM;
931 			goto fail2;
932 		}
933 	} else
934 		vm2 = NULL;
935 
936 	/*
937 	 * XXX: This is ugly; when we copy resource usage, we need to bump
938 	 *      per-cred resource counters.
939 	 */
940 	proc_set_cred_init(newproc, crhold(td->td_ucred));
941 
942 	/*
943 	 * Initialize resource accounting for the child process.
944 	 */
945 	error = racct_proc_fork(p1, newproc);
946 	if (error != 0) {
947 		error = EAGAIN;
948 		goto fail1;
949 	}
950 
951 #ifdef MAC
952 	mac_proc_init(newproc);
953 #endif
954 	newproc->p_klist = knlist_alloc(&newproc->p_mtx);
955 	STAILQ_INIT(&newproc->p_ktr);
956 
957 	/* We have to lock the process tree while we look for a pid. */
958 	sx_xlock(&proctree_lock);
959 	sx_xlock(&allproc_lock);
960 
961 	/*
962 	 * Increment the count of procs running with this uid. Don't allow
963 	 * a nonprivileged user to exceed their current limit.
964 	 *
965 	 * XXXRW: Can we avoid privilege here if it's not needed?
966 	 */
967 	error = priv_check_cred(td->td_ucred, PRIV_PROC_LIMIT, 0);
968 	if (error == 0)
969 		ok = chgproccnt(td->td_ucred->cr_ruidinfo, 1, 0);
970 	else {
971 		ok = chgproccnt(td->td_ucred->cr_ruidinfo, 1,
972 		    lim_cur(td, RLIMIT_NPROC));
973 	}
974 	if (ok) {
975 		do_fork(td, fr, newproc, td2, vm2, fp_procdesc);
976 		return (0);
977 	}
978 
979 	error = EAGAIN;
980 	sx_xunlock(&allproc_lock);
981 	sx_xunlock(&proctree_lock);
982 #ifdef MAC
983 	mac_proc_destroy(newproc);
984 #endif
985 	racct_proc_exit(newproc);
986 fail1:
987 	crfree(newproc->p_ucred);
988 	newproc->p_ucred = NULL;
989 fail2:
990 	if (vm2 != NULL)
991 		vmspace_free(vm2);
992 	uma_zfree(proc_zone, newproc);
993 	if ((flags & RFPROCDESC) != 0 && fp_procdesc != NULL) {
994 		fdclose(td, fp_procdesc, *fr->fr_pd_fd);
995 		fdrop(fp_procdesc, td);
996 	}
997 	atomic_add_int(&nprocs, -1);
998 	pause("fork", hz / 2);
999 	return (error);
1000 }
1001 
1002 /*
1003  * Handle the return of a child process from fork1().  This function
1004  * is called from the MD fork_trampoline() entry point.
1005  */
1006 void
1007 fork_exit(void (*callout)(void *, struct trapframe *), void *arg,
1008     struct trapframe *frame)
1009 {
1010 	struct proc *p;
1011 	struct thread *td;
1012 	struct thread *dtd;
1013 
1014 	td = curthread;
1015 	p = td->td_proc;
1016 	KASSERT(p->p_state == PRS_NORMAL, ("executing process is still new"));
1017 
1018 	CTR4(KTR_PROC, "fork_exit: new thread %p (td_sched %p, pid %d, %s)",
1019 	    td, td_get_sched(td), p->p_pid, td->td_name);
1020 
1021 	sched_fork_exit(td);
1022 	/*
1023 	* Processes normally resume in mi_switch() after being
1024 	* cpu_switch()'ed to, but when children start up they arrive here
1025 	* instead, so we must do much the same things as mi_switch() would.
1026 	*/
1027 	if ((dtd = PCPU_GET(deadthread))) {
1028 		PCPU_SET(deadthread, NULL);
1029 		thread_stash(dtd);
1030 	}
1031 	thread_unlock(td);
1032 
1033 	/*
1034 	 * cpu_fork_kthread_handler intercepts this function call to
1035 	 * have this call a non-return function to stay in kernel mode.
1036 	 * initproc has its own fork handler, but it does return.
1037 	 */
1038 	KASSERT(callout != NULL, ("NULL callout in fork_exit"));
1039 	callout(arg, frame);
1040 
1041 	/*
1042 	 * Check if a kernel thread misbehaved and returned from its main
1043 	 * function.
1044 	 */
1045 	if (p->p_flag & P_KPROC) {
1046 		printf("Kernel thread \"%s\" (pid %d) exited prematurely.\n",
1047 		    td->td_name, p->p_pid);
1048 		kthread_exit();
1049 	}
1050 	mtx_assert(&Giant, MA_NOTOWNED);
1051 
1052 	if (p->p_sysent->sv_schedtail != NULL)
1053 		(p->p_sysent->sv_schedtail)(td);
1054 	td->td_pflags &= ~TDP_FORKING;
1055 }
1056 
1057 /*
1058  * Simplified back end of syscall(), used when returning from fork()
1059  * directly into user mode.  This function is passed in to fork_exit()
1060  * as the first parameter and is called when returning to a new
1061  * userland process.
1062  */
1063 void
1064 fork_return(struct thread *td, struct trapframe *frame)
1065 {
1066 	struct proc *p, *dbg;
1067 
1068 	p = td->td_proc;
1069 	if (td->td_dbgflags & TDB_STOPATFORK) {
1070 		sx_xlock(&proctree_lock);
1071 		PROC_LOCK(p);
1072 		if (p->p_pptr->p_ptevents & PTRACE_FORK) {
1073 			/*
1074 			 * If debugger still wants auto-attach for the
1075 			 * parent's children, do it now.
1076 			 */
1077 			dbg = p->p_pptr->p_pptr;
1078 			proc_set_traced(p, true);
1079 			CTR2(KTR_PTRACE,
1080 		    "fork_return: attaching to new child pid %d: oppid %d",
1081 			    p->p_pid, p->p_oppid);
1082 			proc_reparent(p, dbg);
1083 			sx_xunlock(&proctree_lock);
1084 			td->td_dbgflags |= TDB_CHILD | TDB_SCX | TDB_FSTP;
1085 			ptracestop(td, SIGSTOP, NULL);
1086 			td->td_dbgflags &= ~(TDB_CHILD | TDB_SCX);
1087 		} else {
1088 			/*
1089 			 * ... otherwise clear the request.
1090 			 */
1091 			sx_xunlock(&proctree_lock);
1092 			td->td_dbgflags &= ~TDB_STOPATFORK;
1093 			cv_broadcast(&p->p_dbgwait);
1094 		}
1095 		PROC_UNLOCK(p);
1096 	} else if (p->p_flag & P_TRACED || td->td_dbgflags & TDB_BORN) {
1097  		/*
1098 		 * This is the start of a new thread in a traced
1099 		 * process.  Report a system call exit event.
1100 		 */
1101 		PROC_LOCK(p);
1102 		td->td_dbgflags |= TDB_SCX;
1103 		_STOPEVENT(p, S_SCX, td->td_sa.code);
1104 		if ((p->p_ptevents & PTRACE_SCX) != 0 ||
1105 		    (td->td_dbgflags & TDB_BORN) != 0)
1106 			ptracestop(td, SIGTRAP, NULL);
1107 		td->td_dbgflags &= ~(TDB_SCX | TDB_BORN);
1108 		PROC_UNLOCK(p);
1109 	}
1110 
1111 	userret(td, frame);
1112 
1113 #ifdef KTRACE
1114 	if (KTRPOINT(td, KTR_SYSRET))
1115 		ktrsysret(SYS_fork, 0, 0);
1116 #endif
1117 }
1118