2 * Copyright (c) 1982, 1986, 1989, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)kern_fork.c 8.6 (Berkeley) 4/8/94
39 * $FreeBSD: src/sys/kern/kern_fork.c,v 1.72.2.14 2003/06/26 04:15:10 silby Exp $
40 * $DragonFly: src/sys/kern/kern_fork.c,v 1.77 2008/05/18 20:02:02 nth Exp $
43 #include "opt_ktrace.h"
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/sysproto.h>
48 #include <sys/filedesc.h>
49 #include <sys/kernel.h>
50 #include <sys/sysctl.h>
51 #include <sys/malloc.h>
53 #include <sys/resourcevar.h>
54 #include <sys/vnode.h>
56 #include <sys/ktrace.h>
57 #include <sys/unistd.h>
64 #include <vm/vm_map.h>
65 #include <vm/vm_extern.h>
67 #include <sys/vmmeter.h>
68 #include <sys/refcount.h>
69 #include <sys/thread2.h>
70 #include <sys/signal2.h>
71 #include <sys/spinlock2.h>
73 #include <sys/dsched.h>
75 static MALLOC_DEFINE(M_ATFORK, "atfork", "atfork callback");
78 * These are the stuctures used to create a callout list for things to do
79 * when forking a process
83 TAILQ_ENTRY(forklist) next;
86 TAILQ_HEAD(forklist_head, forklist);
87 static struct forklist_head fork_list = TAILQ_HEAD_INITIALIZER(fork_list);
89 static struct lwp *lwp_fork(struct lwp *, struct proc *, int flags);
91 int forksleep; /* Place for fork1() to sleep on. */
94 * Red-Black tree support for LWPs
98 rb_lwp_compare(struct lwp *lp1, struct lwp *lp2)
100 if (lp1->lwp_tid < lp2->lwp_tid)
102 if (lp1->lwp_tid > lp2->lwp_tid)
107 RB_GENERATE2(lwp_rb_tree, lwp, u.lwp_rbnode, rb_lwp_compare, lwpid_t, lwp_tid);
115 sys_fork(struct fork_args *uap)
117 struct lwp *lp = curthread->td_lwp;
121 error = fork1(lp, RFFDG | RFPROC | RFPGLOCK, &p2);
123 start_forked_proc(lp, p2);
124 uap->sysmsg_fds[0] = p2->p_pid;
125 uap->sysmsg_fds[1] = 0;
134 sys_vfork(struct vfork_args *uap)
136 struct lwp *lp = curthread->td_lwp;
140 error = fork1(lp, RFFDG | RFPROC | RFPPWAIT | RFMEM | RFPGLOCK, &p2);
142 start_forked_proc(lp, p2);
143 uap->sysmsg_fds[0] = p2->p_pid;
144 uap->sysmsg_fds[1] = 0;
150 * Handle rforks. An rfork may (1) operate on the current process without
151 * creating a new, (2) create a new process that shared the current process's
152 * vmspace, signals, and/or descriptors, or (3) create a new process that does
153 * not share these things (normal fork).
155 * Note that we only call start_forked_proc() if a new process is actually
158 * rfork { int flags }
163 sys_rfork(struct rfork_args *uap)
165 struct lwp *lp = curthread->td_lwp;
169 if ((uap->flags & RFKERNELONLY) != 0)
172 error = fork1(lp, uap->flags | RFPGLOCK, &p2);
175 start_forked_proc(lp, p2);
176 uap->sysmsg_fds[0] = p2 ? p2->p_pid : 0;
177 uap->sysmsg_fds[1] = 0;
186 sys_lwp_create(struct lwp_create_args *uap)
188 struct proc *p = curproc;
190 struct lwp_params params;
193 error = copyin(uap->params, ¶ms, sizeof(params));
197 lwkt_gettoken(&p->p_token);
198 plimit_lwp_fork(p); /* force exclusive access */
199 lp = lwp_fork(curthread->td_lwp, p, RFPROC);
200 error = cpu_prepare_lwp(lp, ¶ms);
203 if (params.tid1 != NULL &&
204 (error = copyout(&lp->lwp_tid, params.tid1, sizeof(lp->lwp_tid))))
206 if (params.tid2 != NULL &&
207 (error = copyout(&lp->lwp_tid, params.tid2, sizeof(lp->lwp_tid))))
211 * Now schedule the new lwp.
213 p->p_usched->resetpriority(lp);
215 lp->lwp_stat = LSRUN;
216 p->p_usched->setrunqueue(lp);
218 lwkt_reltoken(&p->p_token);
223 lwp_rb_tree_RB_REMOVE(&p->p_lwp_tree, lp);
225 /* lwp_dispose expects an exited lwp, and a held proc */
226 lp->lwp_flag |= LWP_WEXIT;
227 lp->lwp_thread->td_flags |= TDF_EXITING;
228 lwkt_remove_tdallq(lp->lwp_thread);
231 lwkt_reltoken(&p->p_token);
236 int nprocs = 1; /* process 0 */
239 fork1(struct lwp *lp1, int flags, struct proc **procp)
241 struct proc *p1 = lp1->lwp_proc;
242 struct proc *p2, *pptr;
247 static int curfail = 0;
248 static struct timeval lastfail;
250 struct filedesc_to_leader *fdtol;
252 if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
255 lwkt_gettoken(&p1->p_token);
259 * Here we don't create a new process, but we divorce
260 * certain parts of a process from itself.
262 if ((flags & RFPROC) == 0) {
264 * This kind of stunt does not work anymore if
265 * there are native threads (lwps) running
267 if (p1->p_nthreads != 1) {
272 vm_fork(p1, 0, flags);
275 * Close all file descriptors.
277 if (flags & RFCFDG) {
278 struct filedesc *fdtmp;
284 * Unshare file descriptors (from parent.)
287 if (p1->p_fd->fd_refcnt > 1) {
288 struct filedesc *newfd;
289 error = fdcopy(p1, &newfd);
303 * Interlock against process group signal delivery. If signals
304 * are pending after the interlock is obtained we have to restart
305 * the system call to process the signals. If we don't the child
306 * can miss a pgsignal (such as ^C) sent during the fork.
308 * We can't use CURSIG() here because it will process any STOPs
309 * and cause the process group lock to be held indefinitely. If
310 * a STOP occurs, the fork will be restarted after the CONT.
313 if ((flags & RFPGLOCK) && (plkgrp = p1->p_pgrp) != NULL) {
315 lockmgr(&plkgrp->pg_lock, LK_SHARED);
316 if (CURSIG_NOBLOCK(lp1)) {
323 * Although process entries are dynamically created, we still keep
324 * a global limit on the maximum number we will create. Don't allow
325 * a nonprivileged user to use the last ten processes; don't let root
326 * exceed the limit. The variable nprocs is the current number of
327 * processes, maxproc is the limit.
329 uid = lp1->lwp_thread->td_ucred->cr_ruid;
330 if ((nprocs >= maxproc - 10 && uid != 0) || nprocs >= maxproc) {
331 if (ppsratecheck(&lastfail, &curfail, 1))
332 kprintf("maxproc limit exceeded by uid %d, please "
333 "see tuning(7) and login.conf(5).\n", uid);
334 tsleep(&forksleep, 0, "fork", hz / 2);
340 * Increment the nprocs resource before blocking can occur. There
341 * are hard-limits as to the number of processes that can run.
343 atomic_add_int(&nprocs, 1);
346 * Increment the count of procs running with this uid. Don't allow
347 * a nonprivileged user to exceed their current limit.
349 ok = chgproccnt(lp1->lwp_thread->td_ucred->cr_ruidinfo, 1,
350 (uid != 0) ? p1->p_rlimit[RLIMIT_NPROC].rlim_cur : 0);
353 * Back out the process count
355 atomic_add_int(&nprocs, -1);
356 if (ppsratecheck(&lastfail, &curfail, 1))
357 kprintf("maxproc limit exceeded by uid %d, please "
358 "see tuning(7) and login.conf(5).\n", uid);
359 tsleep(&forksleep, 0, "fork", hz / 2);
364 /* Allocate new proc. */
365 p2 = kmalloc(sizeof(struct proc), M_PROC, M_WAITOK|M_ZERO);
368 * Setup linkage for kernel based threading XXX lwp
370 if (flags & RFTHREAD) {
371 p2->p_peers = p1->p_peers;
373 p2->p_leader = p1->p_leader;
378 RB_INIT(&p2->p_lwp_tree);
379 spin_init(&p2->p_spin);
380 lwkt_token_init(&p2->p_token, "proc");
381 p2->p_lasttid = -1; /* first tid will be 0 */
384 * Setting the state to SIDL protects the partially initialized
385 * process once it starts getting hooked into the rest of the system.
388 proc_add_allproc(p2);
391 * Make a proc table entry for the new process.
392 * The whole structure was zeroed above, so copy the section that is
393 * copied directly from the parent.
395 bcopy(&p1->p_startcopy, &p2->p_startcopy,
396 (unsigned) ((caddr_t)&p2->p_endcopy - (caddr_t)&p2->p_startcopy));
399 * Duplicate sub-structures as needed. Increase reference counts
402 * NOTE: because we are now on the allproc list it is possible for
403 * other consumers to gain temporary references to p2
404 * (p2->p_lock can change).
406 if (p1->p_flag & P_PROFIL)
408 p2->p_ucred = crhold(lp1->lwp_thread->td_ucred);
410 if (jailed(p2->p_ucred))
411 p2->p_flag |= P_JAILED;
414 refcount_acquire(&p2->p_args->ar_ref);
416 p2->p_usched = p1->p_usched;
417 /* XXX: verify copy of the secondary iosched stuff */
420 if (flags & RFSIGSHARE) {
421 p2->p_sigacts = p1->p_sigacts;
422 refcount_acquire(&p2->p_sigacts->ps_refcnt);
424 p2->p_sigacts = kmalloc(sizeof(*p2->p_sigacts),
425 M_SUBPROC, M_WAITOK);
426 bcopy(p1->p_sigacts, p2->p_sigacts, sizeof(*p2->p_sigacts));
427 refcount_init(&p2->p_sigacts->ps_refcnt, 1);
429 if (flags & RFLINUXTHPN)
430 p2->p_sigparent = SIGUSR1;
432 p2->p_sigparent = SIGCHLD;
434 /* bump references to the text vnode (for procfs) */
435 p2->p_textvp = p1->p_textvp;
439 /* copy namecache handle to the text file */
440 if (p1->p_textnch.mount)
441 cache_copy(&p1->p_textnch, &p2->p_textnch);
444 * Handle file descriptors
446 if (flags & RFCFDG) {
447 p2->p_fd = fdinit(p1);
449 } else if (flags & RFFDG) {
450 error = fdcopy(p1, &p2->p_fd);
457 p2->p_fd = fdshare(p1);
458 if (p1->p_fdtol == NULL) {
459 lwkt_gettoken(&p1->p_token);
461 filedesc_to_leader_alloc(NULL,
463 lwkt_reltoken(&p1->p_token);
465 if ((flags & RFTHREAD) != 0) {
467 * Shared file descriptor table and
468 * shared process leaders.
471 fdtol->fdl_refcount++;
474 * Shared file descriptor table, and
475 * different process leaders
477 fdtol = filedesc_to_leader_alloc(p1->p_fdtol, p2);
481 p2->p_limit = plimit_fork(p1);
484 * Preserve some more flags in subprocess. P_PROFIL has already
487 p2->p_flag |= p1->p_flag & P_SUGID;
488 if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
489 p2->p_flag |= P_CONTROLT;
490 if (flags & RFPPWAIT)
491 p2->p_flag |= P_PPWAIT;
494 * Inherit the virtual kernel structure (allows a virtual kernel
495 * to fork to simulate multiple cpus).
498 vkernel_inherit(p1, p2);
501 * Once we are on a pglist we may receive signals. XXX we might
502 * race a ^C being sent to the process group by not receiving it
503 * at all prior to this line.
506 lwkt_gettoken(&p1grp->pg_token);
507 LIST_INSERT_AFTER(p1, p2, p_pglist);
508 lwkt_reltoken(&p1grp->pg_token);
511 * Attach the new process to its parent.
513 * If RFNOWAIT is set, the newly created process becomes a child
514 * of init. This effectively disassociates the child from the
517 if (flags & RFNOWAIT)
522 LIST_INIT(&p2->p_children);
524 lwkt_gettoken(&pptr->p_token);
525 LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
526 lwkt_reltoken(&pptr->p_token);
528 varsymset_init(&p2->p_varsymset, &p1->p_varsymset);
529 callout_init_mp(&p2->p_ithandle);
533 * Copy traceflag and tracefile if enabled. If not inherited,
534 * these were zeroed above but we still could have a trace race
535 * so make sure p2's p_tracenode is NULL.
537 if ((p1->p_traceflag & KTRFAC_INHERIT) && p2->p_tracenode == NULL) {
538 p2->p_traceflag = p1->p_traceflag;
539 p2->p_tracenode = ktrinherit(p1->p_tracenode);
544 * This begins the section where we must prevent the parent
545 * from being swapped.
547 * Gets PRELE'd in the caller in start_forked_proc().
551 vm_fork(p1, p2, flags);
554 * Create the first lwp associated with the new proc.
555 * It will return via a different execution path later, directly
556 * into userland, after it was put on the runq by
557 * start_forked_proc().
559 lwp_fork(lp1, p2, flags);
561 if (flags == (RFFDG | RFPROC | RFPGLOCK)) {
562 mycpu->gd_cnt.v_forks++;
563 mycpu->gd_cnt.v_forkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
564 } else if (flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM | RFPGLOCK)) {
565 mycpu->gd_cnt.v_vforks++;
566 mycpu->gd_cnt.v_vforkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
567 } else if (p1 == &proc0) {
568 mycpu->gd_cnt.v_kthreads++;
569 mycpu->gd_cnt.v_kthreadpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
571 mycpu->gd_cnt.v_rforks++;
572 mycpu->gd_cnt.v_rforkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
576 * Both processes are set up, now check if any loadable modules want
577 * to adjust anything.
578 * What if they have an error? XXX
580 TAILQ_FOREACH(ep, &fork_list, next) {
581 (*ep->function)(p1, p2, flags);
585 * Set the start time. Note that the process is not runnable. The
586 * caller is responsible for making it runnable.
588 microtime(&p2->p_start);
589 p2->p_acflag = AFORK;
592 * tell any interested parties about the new process
594 KNOTE(&p1->p_klist, NOTE_FORK | p2->p_pid);
597 * Return child proc pointer to parent.
602 lwkt_reltoken(&p1->p_token);
604 lockmgr(&plkgrp->pg_lock, LK_RELEASE);
611 lwp_fork(struct lwp *origlp, struct proc *destproc, int flags)
613 globaldata_t gd = mycpu;
617 lp = kmalloc(sizeof(struct lwp), M_LWP, M_WAITOK|M_ZERO);
619 lp->lwp_proc = destproc;
620 lp->lwp_vmspace = destproc->p_vmspace;
621 lp->lwp_stat = LSRUN;
622 bcopy(&origlp->lwp_startcopy, &lp->lwp_startcopy,
623 (unsigned) ((caddr_t)&lp->lwp_endcopy -
624 (caddr_t)&lp->lwp_startcopy));
625 lp->lwp_flag |= origlp->lwp_flag & LWP_ALTSTACK;
627 * Set cpbase to the last timeout that occured (not the upcoming
630 * A critical section is required since a timer IPI can update
631 * scheduler specific data.
634 lp->lwp_cpbase = gd->gd_schedclock.time - gd->gd_schedclock.periodic;
635 destproc->p_usched->heuristic_forking(origlp, lp);
637 lp->lwp_cpumask &= usched_mastermask;
638 lwkt_token_init(&lp->lwp_token, "lwp_token");
639 spin_init(&lp->lwp_spin);
642 * Assign the thread to the current cpu to begin with so we
645 td = lwkt_alloc_thread(NULL, LWKT_THREAD_STACK, gd->gd_cpuid, 0);
647 td->td_proc = destproc;
649 td->td_switch = cpu_heavy_switch;
650 lwkt_setpri(td, TDPRI_KERN_USER);
651 lwkt_set_comm(td, "%s", destproc->p_comm);
654 * cpu_fork will copy and update the pcb, set up the kernel stack,
655 * and make the child ready to run.
657 cpu_fork(origlp, lp, flags);
658 caps_fork(origlp->lwp_thread, lp->lwp_thread);
659 kqueue_init(&lp->lwp_kqueue, destproc->p_fd);
662 * Assign a TID to the lp. Loop until the insert succeeds (returns
665 lp->lwp_tid = destproc->p_lasttid;
667 if (++lp->lwp_tid < 0)
669 } while (lwp_rb_tree_RB_INSERT(&destproc->p_lwp_tree, lp) != NULL);
670 destproc->p_lasttid = lp->lwp_tid;
671 destproc->p_nthreads++;
677 * The next two functionms are general routines to handle adding/deleting
678 * items on the fork callout list.
681 * Take the arguments given and put them onto the fork callout list,
682 * However first make sure that it's not already there.
683 * Returns 0 on success or a standard error number.
686 at_fork(forklist_fn function)
691 /* let the programmer know if he's been stupid */
692 if (rm_at_fork(function)) {
693 kprintf("WARNING: fork callout entry (%p) already present\n",
697 ep = kmalloc(sizeof(*ep), M_ATFORK, M_WAITOK|M_ZERO);
698 ep->function = function;
699 TAILQ_INSERT_TAIL(&fork_list, ep, next);
704 * Scan the exit callout list for the given item and remove it..
705 * Returns the number of items removed (0 or 1)
708 rm_at_fork(forklist_fn function)
712 TAILQ_FOREACH(ep, &fork_list, next) {
713 if (ep->function == function) {
714 TAILQ_REMOVE(&fork_list, ep, next);
723 * Add a forked process to the run queue after any remaining setup, such
724 * as setting the fork handler, has been completed.
727 start_forked_proc(struct lwp *lp1, struct proc *p2)
729 struct lwp *lp2 = ONLY_LWP_IN_PROC(p2);
732 * Move from SIDL to RUN queue, and activate the process's thread.
733 * Activation of the thread effectively makes the process "a"
734 * current process, so we do not setrunqueue().
736 * YYY setrunqueue works here but we should clean up the trampoline
737 * code so we just schedule the LWKT thread and let the trampoline
738 * deal with the userland scheduler on return to userland.
740 KASSERT(p2->p_stat == SIDL,
741 ("cannot start forked process, bad status: %p", p2));
742 p2->p_usched->resetpriority(lp2);
744 p2->p_stat = SACTIVE;
745 lp2->lwp_stat = LSRUN;
746 p2->p_usched->setrunqueue(lp2);
750 * Now can be swapped.
752 PRELE(lp1->lwp_proc);
755 * Preserve synchronization semantics of vfork. If waiting for
756 * child to exec or exit, set P_PPWAIT on child, and sleep on our
757 * proc (in case of exec or exit).
759 * We must hold our p_token to interlock the flag/tsleep
761 lwkt_gettoken(&p2->p_token);
762 while (p2->p_flag & P_PPWAIT)
763 tsleep(lp1->lwp_proc, 0, "ppwait", 0);
764 lwkt_reltoken(&p2->p_token);