Move the code that inserts a new process into the allproc list into its
[dragonfly.git] / sys / kern / kern_fork.c
1 /*
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.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
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.
25  *
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
36  * SUCH DAMAGE.
37  *
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.49 2006/05/24 18:59:48 dillon Exp $
41  */
42
43 #include "opt_ktrace.h"
44
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>
52 #include <sys/proc.h>
53 #include <sys/resourcevar.h>
54 #include <sys/vnode.h>
55 #include <sys/acct.h>
56 #include <sys/ktrace.h>
57 #include <sys/unistd.h>
58 #include <sys/jail.h>
59 #include <sys/caps.h>
60
61 #include <vm/vm.h>
62 #include <sys/lock.h>
63 #include <vm/pmap.h>
64 #include <vm/vm_map.h>
65 #include <vm/vm_extern.h>
66 #include <vm/vm_zone.h>
67
68 #include <sys/vmmeter.h>
69 #include <sys/user.h>
70 #include <sys/thread2.h>
71
72 static MALLOC_DEFINE(M_ATFORK, "atfork", "atfork callback");
73
74 /*
75  * These are the stuctures used to create a callout list for things to do
76  * when forking a process
77  */
78 struct forklist {
79         forklist_fn function;
80         TAILQ_ENTRY(forklist) next;
81 };
82
83 TAILQ_HEAD(forklist_head, forklist);
84 static struct forklist_head fork_list = TAILQ_HEAD_INITIALIZER(fork_list);
85
86 int forksleep; /* Place for fork1() to sleep on. */
87
88 /* ARGSUSED */
89 int
90 fork(struct fork_args *uap)
91 {
92         struct lwp *lp = curthread->td_lwp;
93         struct proc *p2;
94         int error;
95
96         error = fork1(lp, RFFDG | RFPROC, &p2);
97         if (error == 0) {
98                 start_forked_proc(lp, p2);
99                 uap->sysmsg_fds[0] = p2->p_pid;
100                 uap->sysmsg_fds[1] = 0;
101         }
102         return error;
103 }
104
105 /* ARGSUSED */
106 int
107 vfork(struct vfork_args *uap)
108 {
109         struct lwp *lp = curthread->td_lwp;
110         struct proc *p2;
111         int error;
112
113         error = fork1(lp, RFFDG | RFPROC | RFPPWAIT | RFMEM, &p2);
114         if (error == 0) {
115                 start_forked_proc(lp, p2);
116                 uap->sysmsg_fds[0] = p2->p_pid;
117                 uap->sysmsg_fds[1] = 0;
118         }
119         return error;
120 }
121
122 /*
123  * Handle rforks.  An rfork may (1) operate on the current process without
124  * creating a new, (2) create a new process that shared the current process's
125  * vmspace, signals, and/or descriptors, or (3) create a new process that does
126  * not share these things (normal fork).
127  *
128  * Note that we only call start_forked_proc() if a new process is actually
129  * created.
130  *
131  * rfork { int flags }
132  */
133 int
134 rfork(struct rfork_args *uap)
135 {
136         struct lwp *lp = curthread->td_lwp;
137         struct proc *p2;
138         int error;
139
140         if ((uap->flags & RFKERNELONLY) != 0)
141                 return (EINVAL);
142
143         error = fork1(lp, uap->flags, &p2);
144         if (error == 0) {
145                 if (p2)
146                         start_forked_proc(lp, p2);
147                 uap->sysmsg_fds[0] = p2 ? p2->p_pid : 0;
148                 uap->sysmsg_fds[1] = 0;
149         }
150         return error;
151 }
152
153
154 int     nprocs = 1;             /* process 0 */
155
156 int
157 fork1(struct lwp *lp1, int flags, struct proc **procp)
158 {
159         struct proc *p1 = lp1->lwp_proc;
160         struct proc *p2, *pptr;
161         struct lwp *lp2;
162         uid_t uid;
163         int ok;
164         static int curfail = 0;
165         static struct timeval lastfail;
166         struct forklist *ep;
167         struct filedesc_to_leader *fdtol;
168
169         if ((flags & (RFFDG|RFCFDG)) == (RFFDG|RFCFDG))
170                 return (EINVAL);
171
172         /*
173          * Here we don't create a new process, but we divorce
174          * certain parts of a process from itself.
175          */
176         if ((flags & RFPROC) == 0) {
177
178                 vm_fork(p1, 0, flags);
179
180                 /*
181                  * Close all file descriptors.
182                  */
183                 if (flags & RFCFDG) {
184                         struct filedesc *fdtmp;
185                         fdtmp = fdinit(p1);
186                         fdfree(p1);
187                         p1->p_fd = fdtmp;
188                 }
189
190                 /*
191                  * Unshare file descriptors (from parent.)
192                  */
193                 if (flags & RFFDG) {
194                         if (p1->p_fd->fd_refcnt > 1) {
195                                 struct filedesc *newfd;
196                                 newfd = fdcopy(p1);
197                                 fdfree(p1);
198                                 p1->p_fd = newfd;
199                         }
200                 }
201                 *procp = NULL;
202                 return (0);
203         }
204
205         /*
206          * Although process entries are dynamically created, we still keep
207          * a global limit on the maximum number we will create.  Don't allow
208          * a nonprivileged user to use the last ten processes; don't let root
209          * exceed the limit. The variable nprocs is the current number of
210          * processes, maxproc is the limit.
211          */
212         uid = p1->p_ucred->cr_ruid;
213         if ((nprocs >= maxproc - 10 && uid != 0) || nprocs >= maxproc) {
214                 if (ppsratecheck(&lastfail, &curfail, 1))
215                         printf("maxproc limit exceeded by uid %d, please "
216                                "see tuning(7) and login.conf(5).\n", uid);
217                 tsleep(&forksleep, 0, "fork", hz / 2);
218                 return (EAGAIN);
219         }
220         /*
221          * Increment the nprocs resource before blocking can occur.  There
222          * are hard-limits as to the number of processes that can run.
223          */
224         nprocs++;
225
226         /*
227          * Increment the count of procs running with this uid. Don't allow
228          * a nonprivileged user to exceed their current limit.
229          */
230         ok = chgproccnt(p1->p_ucred->cr_ruidinfo, 1,
231                 (uid != 0) ? p1->p_rlimit[RLIMIT_NPROC].rlim_cur : 0);
232         if (!ok) {
233                 /*
234                  * Back out the process count
235                  */
236                 nprocs--;
237                 if (ppsratecheck(&lastfail, &curfail, 1))
238                         printf("maxproc limit exceeded by uid %d, please "
239                                "see tuning(7) and login.conf(5).\n", uid);
240                 tsleep(&forksleep, 0, "fork", hz / 2);
241                 return (EAGAIN);
242         }
243
244         /* Allocate new proc. */
245         p2 = zalloc(proc_zone);
246
247         /*
248          * Setup linkage for kernel based threading XXX lwp
249          */
250         if (flags & RFTHREAD) {
251                 p2->p_peers = p1->p_peers;
252                 p1->p_peers = p2;
253                 p2->p_leader = p1->p_leader;
254         } else {
255                 p2->p_peers = NULL;
256                 p2->p_leader = p2;
257         }
258
259         p2->p_wakeup = 0;
260         p2->p_vmspace = NULL;
261         p2->p_numposixlocks = 0;
262         p2->p_emuldata = NULL;
263         TAILQ_INIT(&p2->p_lwp.lwp_sysmsgq);
264         LIST_INIT(&p2->p_lwps);
265
266         /* XXX lwp */
267         lp2 = &p2->p_lwp;
268         lp2->lwp_proc = p2;
269         lp2->lwp_tid = 0;
270         LIST_INSERT_HEAD(&p2->p_lwps, lp2, lwp_list);
271         p2->p_nthreads = 1;
272         p2->p_nstopped = 0;
273         p2->p_lasttid = 0;
274
275         /*
276          * Setting the state to SIDL protects the partially initialized
277          * process once it starts getting hooked into the rest of the system.
278          */
279         p2->p_stat = SIDL;
280         proc_add_allproc(p2);
281
282         /*
283          * Make a proc table entry for the new process.
284          * Start by zeroing the section of proc that is zero-initialized,
285          * then copy the section that is copied directly from the parent.
286          */
287         bzero(&p2->p_startzero,
288             (unsigned) ((caddr_t)&p2->p_endzero - (caddr_t)&p2->p_startzero));
289         bzero(&lp2->lwp_startzero,
290             (unsigned) ((caddr_t)&lp2->lwp_endzero -
291                         (caddr_t)&lp2->lwp_startzero));
292         bcopy(&p1->p_startcopy, &p2->p_startcopy,
293             (unsigned) ((caddr_t)&p2->p_endcopy - (caddr_t)&p2->p_startcopy));
294         bcopy(&p1->p_lwp.lwp_startcopy, &lp2->lwp_startcopy,
295             (unsigned) ((caddr_t)&lp2->lwp_endcopy -
296                         (caddr_t)&lp2->lwp_startcopy));
297
298         p2->p_aioinfo = NULL;
299
300         /*
301          * Duplicate sub-structures as needed.
302          * Increase reference counts on shared objects.
303          * The p_stats and p_sigacts substructs are set in vm_fork.
304          * p_lock is in the copy area and must be cleared.
305          */
306         p2->p_flag = 0;
307         p2->p_lock = 0;
308         if (p1->p_flag & P_PROFIL)
309                 startprofclock(p2);
310         p2->p_ucred = crhold(p1->p_ucred);
311
312         if (jailed(p2->p_ucred))
313                 p2->p_flag |= P_JAILED;
314
315         if (p2->p_args)
316                 p2->p_args->ar_ref++;
317
318         if (flags & RFSIGSHARE) {
319                 p2->p_procsig = p1->p_procsig;
320                 p2->p_procsig->ps_refcnt++;
321                 if (p1->p_sigacts == &p1->p_addr->u_sigacts) {
322                         struct sigacts *newsigacts;
323
324                         /* Create the shared sigacts structure */
325                         MALLOC(newsigacts, struct sigacts *,
326                             sizeof(struct sigacts), M_SUBPROC, M_WAITOK);
327                         crit_enter();
328                         /*
329                          * Set p_sigacts to the new shared structure.
330                          * Note that this is updating p1->p_sigacts at the
331                          * same time, since p_sigacts is just a pointer to
332                          * the shared p_procsig->ps_sigacts.
333                          */
334                         p2->p_sigacts  = newsigacts;
335                         bcopy(&p1->p_addr->u_sigacts, p2->p_sigacts,
336                             sizeof(*p2->p_sigacts));
337                         *p2->p_sigacts = p1->p_addr->u_sigacts;
338                         crit_exit();
339                 }
340         } else {
341                 MALLOC(p2->p_procsig, struct procsig *, sizeof(struct procsig),
342                     M_SUBPROC, M_WAITOK);
343                 bcopy(p1->p_procsig, p2->p_procsig, sizeof(*p2->p_procsig));
344                 p2->p_procsig->ps_refcnt = 1;
345                 p2->p_sigacts = NULL;   /* finished in vm_fork() */
346         }
347         if (flags & RFLINUXTHPN) 
348                 p2->p_sigparent = SIGUSR1;
349         else
350                 p2->p_sigparent = SIGCHLD;
351
352         /* bump references to the text vnode (for procfs) */
353         p2->p_textvp = p1->p_textvp;
354         if (p2->p_textvp)
355                 vref(p2->p_textvp);
356
357         if (flags & RFCFDG) {
358                 p2->p_fd = fdinit(p1);
359                 fdtol = NULL;
360         } else if (flags & RFFDG) {
361                 p2->p_fd = fdcopy(p1);
362                 fdtol = NULL;
363         } else {
364                 p2->p_fd = fdshare(p1);
365                 if (p1->p_fdtol == NULL)
366                         p1->p_fdtol =
367                                 filedesc_to_leader_alloc(NULL,
368                                                          p1->p_leader);
369                 if ((flags & RFTHREAD) != 0) {
370                         /*
371                          * Shared file descriptor table and
372                          * shared process leaders.
373                          */
374                         fdtol = p1->p_fdtol;
375                         fdtol->fdl_refcount++;
376                 } else {
377                         /* 
378                          * Shared file descriptor table, and
379                          * different process leaders 
380                          */
381                         fdtol = filedesc_to_leader_alloc(p1->p_fdtol, p2);
382                 }
383         }
384         p2->p_fdtol = fdtol;
385         p2->p_limit = plimit_fork(p1->p_limit);
386
387         /*
388          * Preserve some more flags in subprocess.  P_PROFIL has already
389          * been preserved.
390          */
391         p2->p_flag |= p1->p_flag & (P_SUGID | P_ALTSTACK);
392         if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
393                 p2->p_flag |= P_CONTROLT;
394         if (flags & RFPPWAIT)
395                 p2->p_flag |= P_PPWAIT;
396
397         /*
398          * Once we are on a pglist we may receive signals.  XXX we might
399          * race a ^C being sent to the process group by not receiving it
400          * at all prior to this line.
401          */
402         LIST_INSERT_AFTER(p1, p2, p_pglist);
403
404         /*
405          * Attach the new process to its parent.
406          *
407          * If RFNOWAIT is set, the newly created process becomes a child
408          * of init.  This effectively disassociates the child from the
409          * parent.
410          */
411         if (flags & RFNOWAIT)
412                 pptr = initproc;
413         else
414                 pptr = p1;
415         p2->p_pptr = pptr;
416         LIST_INSERT_HEAD(&pptr->p_children, p2, p_sibling);
417         LIST_INIT(&p2->p_children);
418         varsymset_init(&p2->p_varsymset, &p1->p_varsymset);
419         callout_init(&p2->p_ithandle);
420
421 #ifdef KTRACE
422         /*
423          * Copy traceflag and tracefile if enabled.  If not inherited,
424          * these were zeroed above but we still could have a trace race
425          * so make sure p2's p_tracenode is NULL.
426          */
427         if ((p1->p_traceflag & KTRFAC_INHERIT) && p2->p_tracenode == NULL) {
428                 p2->p_traceflag = p1->p_traceflag;
429                 p2->p_tracenode = ktrinherit(p1->p_tracenode);
430         }
431 #endif
432
433         /*
434          * Inherit the scheduler and initialize scheduler-related fields. 
435          * Set cpbase to the last timeout that occured (not the upcoming
436          * timeout).
437          */
438         p2->p_usched = p1->p_usched;
439         lp2->lwp_cpbase = mycpu->gd_schedclock.time -
440                         mycpu->gd_schedclock.periodic;
441         p2->p_usched->heuristic_forking(&p1->p_lwp, lp2);
442
443         /*
444          * This begins the section where we must prevent the parent
445          * from being swapped.
446          */
447         PHOLD(p1);
448
449         /*
450          * Finish creating the child process.  It will return via a different
451          * execution path later.  (ie: directly into user mode)
452          */
453         vm_fork(p1, p2, flags);
454         caps_fork(p1, p2, flags);
455
456         if (flags == (RFFDG | RFPROC)) {
457                 mycpu->gd_cnt.v_forks++;
458                 mycpu->gd_cnt.v_forkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
459         } else if (flags == (RFFDG | RFPROC | RFPPWAIT | RFMEM)) {
460                 mycpu->gd_cnt.v_vforks++;
461                 mycpu->gd_cnt.v_vforkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
462         } else if (p1 == &proc0) {
463                 mycpu->gd_cnt.v_kthreads++;
464                 mycpu->gd_cnt.v_kthreadpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
465         } else {
466                 mycpu->gd_cnt.v_rforks++;
467                 mycpu->gd_cnt.v_rforkpages += p2->p_vmspace->vm_dsize + p2->p_vmspace->vm_ssize;
468         }
469
470         /*
471          * Both processes are set up, now check if any loadable modules want
472          * to adjust anything.
473          *   What if they have an error? XXX
474          */
475         TAILQ_FOREACH(ep, &fork_list, next) {
476                 (*ep->function)(p1, p2, flags);
477         }
478
479         /*
480          * Set the start time.  Note that the process is not runnable.  The
481          * caller is responsible for making it runnable.
482          */
483         microtime(&p2->p_start);
484         p2->p_acflag = AFORK;
485
486         /*
487          * tell any interested parties about the new process
488          */
489         KNOTE(&p1->p_klist, NOTE_FORK | p2->p_pid);
490
491         /*
492          * Return child proc pointer to parent.
493          */
494         *procp = p2;
495         return (0);
496 }
497
498 /*
499  * The next two functionms are general routines to handle adding/deleting
500  * items on the fork callout list.
501  *
502  * at_fork():
503  * Take the arguments given and put them onto the fork callout list,
504  * However first make sure that it's not already there.
505  * Returns 0 on success or a standard error number.
506  */
507 int
508 at_fork(forklist_fn function)
509 {
510         struct forklist *ep;
511
512 #ifdef INVARIANTS
513         /* let the programmer know if he's been stupid */
514         if (rm_at_fork(function)) {
515                 printf("WARNING: fork callout entry (%p) already present\n",
516                     function);
517         }
518 #endif
519         ep = malloc(sizeof(*ep), M_ATFORK, M_WAITOK|M_ZERO);
520         ep->function = function;
521         TAILQ_INSERT_TAIL(&fork_list, ep, next);
522         return (0);
523 }
524
525 /*
526  * Scan the exit callout list for the given item and remove it..
527  * Returns the number of items removed (0 or 1)
528  */
529 int
530 rm_at_fork(forklist_fn function)
531 {
532         struct forklist *ep;
533
534         TAILQ_FOREACH(ep, &fork_list, next) {
535                 if (ep->function == function) {
536                         TAILQ_REMOVE(&fork_list, ep, next);
537                         free(ep, M_ATFORK);
538                         return(1);
539                 }
540         }       
541         return (0);
542 }
543
544 /*
545  * Add a forked process to the run queue after any remaining setup, such
546  * as setting the fork handler, has been completed.
547  */
548 void
549 start_forked_proc(struct lwp *lp1, struct proc *p2)
550 {
551         struct lwp *lp2;
552
553         KKASSERT(p2 != NULL && p2->p_nthreads == 1);
554
555         lp2 = LIST_FIRST(&p2->p_lwps);
556
557         /*
558          * Move from SIDL to RUN queue, and activate the process's thread.
559          * Activation of the thread effectively makes the process "a"
560          * current process, so we do not setrunqueue().
561          *
562          * YYY setrunqueue works here but we should clean up the trampoline
563          * code so we just schedule the LWKT thread and let the trampoline
564          * deal with the userland scheduler on return to userland.
565          */
566         KASSERT(p2->p_stat == SIDL,
567             ("cannot start forked process, bad status: %p", p2));
568         p2->p_usched->resetpriority(lp2);
569         crit_enter();
570         p2->p_stat = SRUN;
571         p2->p_usched->setrunqueue(lp2);
572         crit_exit();
573
574         /*
575          * Now can be swapped.
576          */
577         PRELE(lp1->lwp_proc);
578
579         /*
580          * Preserve synchronization semantics of vfork.  If waiting for
581          * child to exec or exit, set P_PPWAIT on child, and sleep on our
582          * proc (in case of exit).
583          */
584         while (p2->p_flag & P_PPWAIT)
585                 tsleep(lp1->lwp_proc, 0, "ppwait", 0);
586 }