kern_fork.c revision 1.131 1 /* $NetBSD: kern_fork.c,v 1.131 2007/02/15 15:13:10 ad Exp $ */
2
3 /*-
4 * Copyright (c) 1999, 2001, 2004 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center.
10 * This code is derived from software contributed to The NetBSD Foundation
11 * by Charles M. Hannum.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the NetBSD
24 * Foundation, Inc. and its contributors.
25 * 4. Neither the name of The NetBSD Foundation nor the names of its
26 * contributors may be used to endorse or promote products derived
27 * from this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39 * POSSIBILITY OF SUCH DAMAGE.
40 */
41
42 /*
43 * Copyright (c) 1982, 1986, 1989, 1991, 1993
44 * The Regents of the University of California. All rights reserved.
45 * (c) UNIX System Laboratories, Inc.
46 * All or some portions of this file are derived from material licensed
47 * to the University of California by American Telephone and Telegraph
48 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
49 * the permission of UNIX System Laboratories, Inc.
50 *
51 * Redistribution and use in source and binary forms, with or without
52 * modification, are permitted provided that the following conditions
53 * are met:
54 * 1. Redistributions of source code must retain the above copyright
55 * notice, this list of conditions and the following disclaimer.
56 * 2. Redistributions in binary form must reproduce the above copyright
57 * notice, this list of conditions and the following disclaimer in the
58 * documentation and/or other materials provided with the distribution.
59 * 3. Neither the name of the University nor the names of its contributors
60 * may be used to endorse or promote products derived from this software
61 * without specific prior written permission.
62 *
63 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
64 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
65 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
66 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
67 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
68 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
69 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
70 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
71 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
72 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
73 * SUCH DAMAGE.
74 *
75 * @(#)kern_fork.c 8.8 (Berkeley) 2/14/95
76 */
77
78 #include <sys/cdefs.h>
79 __KERNEL_RCSID(0, "$NetBSD: kern_fork.c,v 1.131 2007/02/15 15:13:10 ad Exp $");
80
81 #include "opt_ktrace.h"
82 #include "opt_systrace.h"
83 #include "opt_multiprocessor.h"
84
85 #include <sys/param.h>
86 #include <sys/systm.h>
87 #include <sys/filedesc.h>
88 #include <sys/kernel.h>
89 #include <sys/malloc.h>
90 #include <sys/pool.h>
91 #include <sys/mount.h>
92 #include <sys/proc.h>
93 #include <sys/ras.h>
94 #include <sys/resourcevar.h>
95 #include <sys/vnode.h>
96 #include <sys/file.h>
97 #include <sys/acct.h>
98 #include <sys/ktrace.h>
99 #include <sys/vmmeter.h>
100 #include <sys/sched.h>
101 #include <sys/signalvar.h>
102 #include <sys/systrace.h>
103 #include <sys/kauth.h>
104
105 #include <sys/syscallargs.h>
106
107 #include <uvm/uvm_extern.h>
108
109
110 int nprocs = 1; /* process 0 */
111
112 /*
113 * Number of ticks to sleep if fork() would fail due to process hitting
114 * limits. Exported in miliseconds to userland via sysctl.
115 */
116 int forkfsleep = 0;
117
118 /*ARGSUSED*/
119 int
120 sys_fork(struct lwp *l, void *v, register_t *retval)
121 {
122
123 return (fork1(l, 0, SIGCHLD, NULL, 0, NULL, NULL, retval, NULL));
124 }
125
126 /*
127 * vfork(2) system call compatible with 4.4BSD (i.e. BSD with Mach VM).
128 * Address space is not shared, but parent is blocked until child exit.
129 */
130 /*ARGSUSED*/
131 int
132 sys_vfork(struct lwp *l, void *v, register_t *retval)
133 {
134
135 return (fork1(l, FORK_PPWAIT, SIGCHLD, NULL, 0, NULL, NULL,
136 retval, NULL));
137 }
138
139 /*
140 * New vfork(2) system call for NetBSD, which implements original 3BSD vfork(2)
141 * semantics. Address space is shared, and parent is blocked until child exit.
142 */
143 /*ARGSUSED*/
144 int
145 sys___vfork14(struct lwp *l, void *v, register_t *retval)
146 {
147
148 return (fork1(l, FORK_PPWAIT|FORK_SHAREVM, SIGCHLD, NULL, 0,
149 NULL, NULL, retval, NULL));
150 }
151
152 /*
153 * Linux-compatible __clone(2) system call.
154 */
155 int
156 sys___clone(struct lwp *l, void *v, register_t *retval)
157 {
158 struct sys___clone_args /* {
159 syscallarg(int) flags;
160 syscallarg(void *) stack;
161 } */ *uap = v;
162 int flags, sig;
163
164 /*
165 * We don't support the CLONE_PID or CLONE_PTRACE flags.
166 */
167 if (SCARG(uap, flags) & (CLONE_PID|CLONE_PTRACE))
168 return (EINVAL);
169
170 /*
171 * Linux enforces CLONE_VM with CLONE_SIGHAND, do same.
172 */
173 if (SCARG(uap, flags) & CLONE_SIGHAND
174 && (SCARG(uap, flags) & CLONE_VM) == 0)
175 return (EINVAL);
176
177 flags = 0;
178
179 if (SCARG(uap, flags) & CLONE_VM)
180 flags |= FORK_SHAREVM;
181 if (SCARG(uap, flags) & CLONE_FS)
182 flags |= FORK_SHARECWD;
183 if (SCARG(uap, flags) & CLONE_FILES)
184 flags |= FORK_SHAREFILES;
185 if (SCARG(uap, flags) & CLONE_SIGHAND)
186 flags |= FORK_SHARESIGS;
187 if (SCARG(uap, flags) & CLONE_VFORK)
188 flags |= FORK_PPWAIT;
189
190 sig = SCARG(uap, flags) & CLONE_CSIGNAL;
191 if (sig < 0 || sig >= _NSIG)
192 return (EINVAL);
193
194 /*
195 * Note that the Linux API does not provide a portable way of
196 * specifying the stack area; the caller must know if the stack
197 * grows up or down. So, we pass a stack size of 0, so that the
198 * code that makes this adjustment is a noop.
199 */
200 return (fork1(l, flags, sig, SCARG(uap, stack), 0,
201 NULL, NULL, retval, NULL));
202 }
203
204 /* print the 'table full' message once per 10 seconds */
205 struct timeval fork_tfmrate = { 10, 0 };
206
207 /*
208 * General fork call. Note that another LWP in the process may call exec()
209 * or exit() while we are forking. It's safe to continue here, because
210 * neither operation will complete until all LWPs have exited the process.
211 */
212 int
213 fork1(struct lwp *l1, int flags, int exitsig, void *stack, size_t stacksize,
214 void (*func)(void *), void *arg, register_t *retval,
215 struct proc **rnewprocp)
216 {
217 struct proc *p1, *p2, *parent;
218 uid_t uid;
219 struct lwp *l2;
220 int count;
221 vaddr_t uaddr;
222 boolean_t inmem;
223 int tmp;
224
225 /*
226 * Although process entries are dynamically created, we still keep
227 * a global limit on the maximum number we will create. Don't allow
228 * a nonprivileged user to use the last few processes; don't let root
229 * exceed the limit. The variable nprocs is the current number of
230 * processes, maxproc is the limit.
231 */
232 p1 = l1->l_proc;
233 mutex_enter(&p1->p_mutex);
234 uid = kauth_cred_getuid(p1->p_cred);
235 mutex_exit(&p1->p_mutex);
236 if (__predict_false((nprocs >= maxproc - 5 && uid != 0) ||
237 nprocs >= maxproc)) {
238 static struct timeval lasttfm;
239
240 if (ratecheck(&lasttfm, &fork_tfmrate))
241 tablefull("proc", "increase kern.maxproc or NPROC");
242 if (forkfsleep)
243 (void)tsleep(&nprocs, PUSER, "forkmx", forkfsleep);
244 return (EAGAIN);
245 }
246 nprocs++;
247
248 /*
249 * Increment the count of procs running with this uid. Don't allow
250 * a nonprivileged user to exceed their current limit.
251 */
252 count = chgproccnt(uid, 1);
253 if (__predict_false(uid != 0 && count >
254 p1->p_rlimit[RLIMIT_NPROC].rlim_cur)) {
255 (void)chgproccnt(uid, -1);
256 nprocs--;
257 if (forkfsleep)
258 (void)tsleep(&nprocs, PUSER, "forkulim", forkfsleep);
259 return (EAGAIN);
260 }
261
262 /*
263 * Allocate virtual address space for the U-area now, while it
264 * is still easy to abort the fork operation if we're out of
265 * kernel virtual address space. The actual U-area pages will
266 * be allocated and wired in uvm_fork() if needed.
267 */
268
269 inmem = uvm_uarea_alloc(&uaddr);
270 if (__predict_false(uaddr == 0)) {
271 (void)chgproccnt(uid, -1);
272 nprocs--;
273 return (ENOMEM);
274 }
275
276 /*
277 * We are now committed to the fork. From here on, we may
278 * block on resources, but resource allocation may NOT fail.
279 */
280
281 /* Allocate new proc. */
282 p2 = proc_alloc();
283
284 /*
285 * Make a proc table entry for the new process.
286 * Start by zeroing the section of proc that is zero-initialized,
287 * then copy the section that is copied directly from the parent.
288 */
289 memset(&p2->p_startzero, 0,
290 (unsigned) ((caddr_t)&p2->p_endzero - (caddr_t)&p2->p_startzero));
291 memcpy(&p2->p_startcopy, &p1->p_startcopy,
292 (unsigned) ((caddr_t)&p2->p_endcopy - (caddr_t)&p2->p_startcopy));
293
294 CIRCLEQ_INIT(&p2->p_sigpend.sp_info);
295
296 LIST_INIT(&p2->p_lwps);
297 LIST_INIT(&p2->p_sigwaiters);
298
299 /*
300 * Duplicate sub-structures as needed.
301 * Increase reference counts on shared objects.
302 * The p_stats and p_sigacts substructs are set in uvm_fork().
303 * Inherit flags we want to keep. The flags related to SIGCHLD
304 * handling are important in order to keep a consistent behaviour
305 * for the child after the fork.
306 */
307 p2->p_flag = p1->p_flag & (P_SUGID | P_NOCLDWAIT | P_CLDSIGIGN);
308 p2->p_emul = p1->p_emul;
309 p2->p_execsw = p1->p_execsw;
310
311 if (flags & FORK_SYSTEM) {
312 /*
313 * Mark it as a system process. Set P_NOCLDWAIT so that
314 * children are reparented to init(8) when they exit.
315 * init(8) can easily wait them out for us.
316 */
317 p2->p_flag |= (P_SYSTEM | P_NOCLDWAIT);
318 }
319
320 /* XXX p_smutex can be IPL_VM except for audio drivers */
321 mutex_init(&p2->p_smutex, MUTEX_SPIN, IPL_SCHED);
322 mutex_init(&p2->p_stmutex, MUTEX_SPIN, IPL_STATCLOCK);
323 mutex_init(&p2->p_rasmutex, MUTEX_SPIN, IPL_NONE);
324 mutex_init(&p2->p_mutex, MUTEX_DEFAULT, IPL_NONE);
325 cv_init(&p2->p_refcv, "drainref");
326 cv_init(&p2->p_waitcv, "wait");
327 cv_init(&p2->p_lwpcv, "lwpwait");
328
329 p2->p_refcnt = 1;
330 kauth_proc_fork(p1, p2);
331
332 LIST_INIT(&p2->p_raslist);
333 #if defined(__HAVE_RAS)
334 ras_fork(p1, p2);
335 #endif
336
337 /* bump references to the text vnode (for procfs) */
338 p2->p_textvp = p1->p_textvp;
339 if (p2->p_textvp)
340 VREF(p2->p_textvp);
341
342 if (flags & FORK_SHAREFILES)
343 fdshare(p1, p2);
344 else if (flags & FORK_CLEANFILES)
345 p2->p_fd = fdinit(p1);
346 else
347 p2->p_fd = fdcopy(p1);
348
349 if (flags & FORK_SHARECWD)
350 cwdshare(p1, p2);
351 else
352 p2->p_cwdi = cwdinit(p1);
353
354 /*
355 * If p_limit is still copy-on-write, bump refcnt,
356 * otherwise get a copy that won't be modified.
357 * (If PL_SHAREMOD is clear, the structure is shared
358 * copy-on-write.)
359 */
360 if (p1->p_limit->p_lflags & PL_SHAREMOD) {
361 mutex_enter(&p1->p_mutex);
362 p2->p_limit = limcopy(p1);
363 mutex_exit(&p1->p_mutex);
364 } else {
365 simple_lock(&p1->p_limit->p_slock);
366 p1->p_limit->p_refcnt++;
367 simple_unlock(&p1->p_limit->p_slock);
368 p2->p_limit = p1->p_limit;
369 }
370
371 p2->p_sflag = ((flags & FORK_PPWAIT) ? PS_PPWAIT : 0);
372 p2->p_lflag = 0;
373 p2->p_slflag = 0;
374 parent = (flags & FORK_NOWAIT) ? initproc : p1;
375 p2->p_pptr = parent;
376 LIST_INIT(&p2->p_children);
377
378
379 #ifdef KTRACE
380 /*
381 * Copy traceflag and tracefile if enabled.
382 * If not inherited, these were zeroed above.
383 */
384 if (p1->p_traceflag & KTRFAC_INHERIT) {
385 mutex_enter(&ktrace_mutex);
386 p2->p_traceflag = p1->p_traceflag;
387 if ((p2->p_tracep = p1->p_tracep) != NULL)
388 ktradref(p2);
389 mutex_exit(&ktrace_mutex);
390 }
391 #endif
392
393 /*
394 * Create signal actions for the child process.
395 */
396 mutex_enter(&p1->p_smutex);
397 p2->p_sigacts = sigactsinit(p1, flags & FORK_SHARESIGS);
398 p2->p_sflag |=
399 (p1->p_sflag & (PS_STOPFORK | PS_STOPEXEC | PS_NOCLDSTOP));
400 scheduler_fork_hook(p1, p2);
401 mutex_exit(&p1->p_smutex);
402
403 p2->p_stflag = p1->p_stflag;
404
405 /*
406 * p_stats.
407 * Copy parts of p_stats, and zero out the rest.
408 */
409 p2->p_stats = pstatscopy(p1->p_stats);
410
411 /*
412 * If emulation has process fork hook, call it now.
413 */
414 if (p2->p_emul->e_proc_fork)
415 (*p2->p_emul->e_proc_fork)(p2, p1, flags);
416
417 /*
418 * ...and finally, any other random fork hooks that subsystems
419 * might have registered.
420 */
421 doforkhooks(p2, p1);
422
423 /*
424 * This begins the section where we must prevent the parent
425 * from being swapped.
426 */
427 PHOLD(l1);
428
429 uvm_proc_fork(p1, p2, (flags & FORK_SHAREVM) ? TRUE : FALSE);
430
431 /*
432 * Finish creating the child process.
433 * It will return through a different path later.
434 */
435 newlwp(l1, p2, uaddr, inmem, 0, stack, stacksize,
436 (func != NULL) ? func : child_return,
437 arg, &l2);
438
439 /*
440 * It's now safe for the scheduler and other processes to see the
441 * child process.
442 */
443 rw_enter(&proclist_lock, RW_WRITER);
444
445 if (p1->p_session->s_ttyvp != NULL && p1->p_lflag & PL_CONTROLT)
446 p2->p_lflag |= PL_CONTROLT;
447
448 LIST_INSERT_HEAD(&parent->p_children, p2, p_sibling);
449 p2->p_exitsig = exitsig; /* signal for parent on exit */
450
451 mutex_enter(&proclist_mutex);
452 LIST_INSERT_AFTER(p1, p2, p_pglist);
453 LIST_INSERT_HEAD(&allproc, p2, p_list);
454 mutex_exit(&proclist_mutex);
455
456 rw_exit(&proclist_lock);
457
458 #ifdef SYSTRACE
459 /* Tell systrace what's happening. */
460 if (ISSET(p1->p_flag, P_SYSTRACE))
461 systrace_sys_fork(p1, p2);
462 #endif
463
464 #ifdef __HAVE_SYSCALL_INTERN
465 (*p2->p_emul->e_syscall_intern)(p2);
466 #endif
467
468 /*
469 * Now can be swapped.
470 */
471 PRELE(l1);
472
473 /*
474 * Notify any interested parties about the new process.
475 */
476 KNOTE(&p1->p_klist, NOTE_FORK | p2->p_pid);
477
478 /*
479 * Update stats now that we know the fork was successful.
480 */
481 uvmexp.forks++;
482 if (flags & FORK_PPWAIT)
483 uvmexp.forks_ppwait++;
484 if (flags & FORK_SHAREVM)
485 uvmexp.forks_sharevm++;
486
487 /*
488 * Pass a pointer to the new process to the caller.
489 */
490 if (rnewprocp != NULL)
491 *rnewprocp = p2;
492
493 #ifdef KTRACE
494 if (KTRPOINT(p2, KTR_EMUL))
495 p2->p_traceflag |= KTRFAC_TRC_EMUL;
496 #endif
497
498 /*
499 * Make child runnable, set start time, and add to run queue except
500 * if the parent requested the child to start in SSTOP state.
501 */
502 tmp = (p2->p_userret != NULL ? L_WUSERRET : 0);
503 mutex_enter(&proclist_mutex);
504 mutex_enter(&p2->p_smutex);
505
506 getmicrotime(&p2->p_stats->p_start);
507 p2->p_acflag = AFORK;
508 if (p2->p_sflag & PS_STOPFORK) {
509 lwp_lock(l2);
510 p2->p_nrlwps = 0;
511 p2->p_stat = SSTOP;
512 p2->p_waited = 0;
513 p1->p_nstopchild++;
514 l2->l_stat = LSSTOP;
515 l2->l_flag |= tmp;
516 lwp_unlock(l2);
517 } else {
518 p2->p_nrlwps = 1;
519 p2->p_stat = SACTIVE;
520 lwp_lock(l2);
521 l2->l_stat = LSRUN;
522 l2->l_flag |= tmp;
523 setrunqueue(l2);
524 lwp_unlock(l2);
525 }
526
527 mutex_exit(&proclist_mutex);
528
529 /*
530 * Start profiling.
531 */
532 if ((p2->p_stflag & PST_PROFIL) != 0) {
533 mutex_spin_enter(&p2->p_stmutex);
534 startprofclock(p2);
535 mutex_spin_exit(&p2->p_stmutex);
536 }
537
538 /*
539 * Preserve synchronization semantics of vfork. If waiting for
540 * child to exec or exit, set PS_PPWAIT on child, and sleep on our
541 * proc (in case of exit).
542 */
543 if (flags & FORK_PPWAIT)
544 while (p2->p_sflag & PS_PPWAIT)
545 cv_wait(&p1->p_waitcv, &p2->p_smutex);
546
547 mutex_exit(&p2->p_smutex);
548
549 /*
550 * Return child pid to parent process,
551 * marking us as parent via retval[1].
552 */
553 if (retval != NULL) {
554 retval[0] = p2->p_pid;
555 retval[1] = 0;
556 }
557
558 return (0);
559 }
560
561 #if defined(MULTIPROCESSOR)
562 /*
563 * XXX This is a slight hack to get newly-formed processes to
564 * XXX acquire the kernel lock as soon as they run.
565 */
566 void
567 proc_trampoline_mp(void)
568 {
569 struct lwp *l;
570
571 l = curlwp;
572
573 KERNEL_LOCK(1, l);
574 }
575 #endif
576