kern_fork.c revision 1.87 1 /* $NetBSD: kern_fork.c,v 1.87 2001/11/12 15:25:09 lukem Exp $ */
2
3 /*-
4 * Copyright (c) 1999, 2001 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 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 /*
41 * Copyright (c) 1982, 1986, 1989, 1991, 1993
42 * The Regents of the University of California. All rights reserved.
43 * (c) UNIX System Laboratories, Inc.
44 * All or some portions of this file are derived from material licensed
45 * to the University of California by American Telephone and Telegraph
46 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
47 * the permission of UNIX System Laboratories, Inc.
48 *
49 * Redistribution and use in source and binary forms, with or without
50 * modification, are permitted provided that the following conditions
51 * are met:
52 * 1. Redistributions of source code must retain the above copyright
53 * notice, this list of conditions and the following disclaimer.
54 * 2. Redistributions in binary form must reproduce the above copyright
55 * notice, this list of conditions and the following disclaimer in the
56 * documentation and/or other materials provided with the distribution.
57 * 3. All advertising materials mentioning features or use of this software
58 * must display the following acknowledgement:
59 * This product includes software developed by the University of
60 * California, Berkeley and its contributors.
61 * 4. Neither the name of the University nor the names of its contributors
62 * may be used to endorse or promote products derived from this software
63 * without specific prior written permission.
64 *
65 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
66 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
67 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
68 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
69 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
70 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
71 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
72 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
73 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
74 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
75 * SUCH DAMAGE.
76 *
77 * @(#)kern_fork.c 8.8 (Berkeley) 2/14/95
78 */
79
80 #include <sys/cdefs.h>
81 __KERNEL_RCSID(0, "$NetBSD: kern_fork.c,v 1.87 2001/11/12 15:25:09 lukem Exp $");
82
83 #include "opt_ktrace.h"
84 #include "opt_multiprocessor.h"
85
86 #include <sys/param.h>
87 #include <sys/systm.h>
88 #include <sys/map.h>
89 #include <sys/filedesc.h>
90 #include <sys/kernel.h>
91 #include <sys/malloc.h>
92 #include <sys/pool.h>
93 #include <sys/mount.h>
94 #include <sys/proc.h>
95 #include <sys/resourcevar.h>
96 #include <sys/vnode.h>
97 #include <sys/file.h>
98 #include <sys/acct.h>
99 #include <sys/ktrace.h>
100 #include <sys/vmmeter.h>
101 #include <sys/sched.h>
102 #include <sys/signalvar.h>
103
104 #include <sys/syscallargs.h>
105
106 #include <uvm/uvm_extern.h>
107
108 int nprocs = 1; /* process 0 */
109
110 /*ARGSUSED*/
111 int
112 sys_fork(struct proc *p, void *v, register_t *retval)
113 {
114
115 return (fork1(p, 0, SIGCHLD, NULL, 0, NULL, NULL, retval, NULL));
116 }
117
118 /*
119 * vfork(2) system call compatible with 4.4BSD (i.e. BSD with Mach VM).
120 * Address space is not shared, but parent is blocked until child exit.
121 */
122 /*ARGSUSED*/
123 int
124 sys_vfork(struct proc *p, void *v, register_t *retval)
125 {
126
127 return (fork1(p, FORK_PPWAIT, SIGCHLD, NULL, 0, NULL, NULL,
128 retval, NULL));
129 }
130
131 /*
132 * New vfork(2) system call for NetBSD, which implements original 3BSD vfork(2)
133 * semantics. Address space is shared, and parent is blocked until child exit.
134 */
135 /*ARGSUSED*/
136 int
137 sys___vfork14(struct proc *p, void *v, register_t *retval)
138 {
139
140 return (fork1(p, FORK_PPWAIT|FORK_SHAREVM, SIGCHLD, NULL, 0,
141 NULL, NULL, retval, NULL));
142 }
143
144 /*
145 * Linux-compatible __clone(2) system call.
146 */
147 int
148 sys___clone(struct proc *p, void *v, register_t *retval)
149 {
150 struct sys___clone_args /* {
151 syscallarg(int) flags;
152 syscallarg(void *) stack;
153 } */ *uap = v;
154 int flags, sig;
155
156 /*
157 * We don't support the CLONE_PID or CLONE_PTRACE flags.
158 */
159 if (SCARG(uap, flags) & (CLONE_PID|CLONE_PTRACE))
160 return (EINVAL);
161
162 flags = 0;
163
164 if (SCARG(uap, flags) & CLONE_VM)
165 flags |= FORK_SHAREVM;
166 if (SCARG(uap, flags) & CLONE_FS)
167 flags |= FORK_SHARECWD;
168 if (SCARG(uap, flags) & CLONE_FILES)
169 flags |= FORK_SHAREFILES;
170 if (SCARG(uap, flags) & CLONE_SIGHAND)
171 flags |= FORK_SHARESIGS;
172 if (SCARG(uap, flags) & CLONE_VFORK)
173 flags |= FORK_PPWAIT;
174
175 sig = SCARG(uap, flags) & CLONE_CSIGNAL;
176 if (sig < 0 || sig >= _NSIG)
177 return (EINVAL);
178
179 /*
180 * Note that the Linux API does not provide a portable way of
181 * specifying the stack area; the caller must know if the stack
182 * grows up or down. So, we pass a stack size of 0, so that the
183 * code that makes this adjustment is a noop.
184 */
185 return (fork1(p, flags, sig, SCARG(uap, stack), 0,
186 NULL, NULL, retval, NULL));
187 }
188
189 int
190 fork1(struct proc *p1, int flags, int exitsig, void *stack, size_t stacksize,
191 void (*func)(void *), void *arg, register_t *retval,
192 struct proc **rnewprocp)
193 {
194 struct proc *p2, *tp;
195 uid_t uid;
196 int count, s;
197 vaddr_t uaddr;
198 static int nextpid, pidchecked;
199
200 /*
201 * Although process entries are dynamically created, we still keep
202 * a global limit on the maximum number we will create. Don't allow
203 * a nonprivileged user to use the last process; don't let root
204 * exceed the limit. The variable nprocs is the current number of
205 * processes, maxproc is the limit.
206 */
207 uid = p1->p_cred->p_ruid;
208 if (__predict_false((nprocs >= maxproc - 1 && uid != 0) ||
209 nprocs >= maxproc)) {
210 tablefull("proc", "increase kern.maxproc or NPROC");
211 return (EAGAIN);
212 }
213 nprocs++;
214
215 /*
216 * Increment the count of procs running with this uid. Don't allow
217 * a nonprivileged user to exceed their current limit.
218 */
219 count = chgproccnt(uid, 1);
220 if (__predict_false(uid != 0 && count >
221 p1->p_rlimit[RLIMIT_NPROC].rlim_cur)) {
222 (void)chgproccnt(uid, -1);
223 nprocs--;
224 return (EAGAIN);
225 }
226
227 /*
228 * Allocate virtual address space for the U-area now, while it
229 * is still easy to abort the fork operation if we're out of
230 * kernel virtual address space. The actual U-area pages will
231 * be allocated and wired in vm_fork().
232 */
233
234 #ifndef USPACE_ALIGN
235 #define USPACE_ALIGN 0
236 #endif
237
238 uaddr = uvm_km_valloc_align(kernel_map, USPACE, USPACE_ALIGN);
239 if (__predict_false(uaddr == 0)) {
240 (void)chgproccnt(uid, -1);
241 nprocs--;
242 return (ENOMEM);
243 }
244
245 /*
246 * We are now committed to the fork. From here on, we may
247 * block on resources, but resource allocation may NOT fail.
248 */
249
250 /* Allocate new proc. */
251 p2 = pool_get(&proc_pool, PR_WAITOK);
252
253 /*
254 * Make a proc table entry for the new process.
255 * Start by zeroing the section of proc that is zero-initialized,
256 * then copy the section that is copied directly from the parent.
257 */
258 memset(&p2->p_startzero, 0,
259 (unsigned) ((caddr_t)&p2->p_endzero - (caddr_t)&p2->p_startzero));
260 memcpy(&p2->p_startcopy, &p1->p_startcopy,
261 (unsigned) ((caddr_t)&p2->p_endcopy - (caddr_t)&p2->p_startcopy));
262
263 #if !defined(MULTIPROCESSOR)
264 /*
265 * In the single-processor case, all processes will always run
266 * on the same CPU. So, initialize the child's CPU to the parent's
267 * now. In the multiprocessor case, the child's CPU will be
268 * initialized in the low-level context switch code when the
269 * process runs.
270 */
271 p2->p_cpu = p1->p_cpu;
272 #else
273 /*
274 * zero child's cpu pointer so we don't get trash.
275 */
276 p2->p_cpu = NULL;
277 #endif /* ! MULTIPROCESSOR */
278
279 /*
280 * Duplicate sub-structures as needed.
281 * Increase reference counts on shared objects.
282 * The p_stats and p_sigacts substructs are set in uvm_fork().
283 */
284 p2->p_flag = P_INMEM | (p1->p_flag & P_SUGID);
285 p2->p_emul = p1->p_emul;
286
287 if (p1->p_flag & P_PROFIL)
288 startprofclock(p2);
289 p2->p_cred = pool_get(&pcred_pool, PR_WAITOK);
290 memcpy(p2->p_cred, p1->p_cred, sizeof(*p2->p_cred));
291 p2->p_cred->p_refcnt = 1;
292 crhold(p1->p_ucred);
293
294 /* bump references to the text vnode (for procfs) */
295 p2->p_textvp = p1->p_textvp;
296 if (p2->p_textvp)
297 VREF(p2->p_textvp);
298
299 if (flags & FORK_SHAREFILES)
300 fdshare(p1, p2);
301 else
302 p2->p_fd = fdcopy(p1);
303
304 if (flags & FORK_SHARECWD)
305 cwdshare(p1, p2);
306 else
307 p2->p_cwdi = cwdinit(p1);
308
309 /*
310 * If p_limit is still copy-on-write, bump refcnt,
311 * otherwise get a copy that won't be modified.
312 * (If PL_SHAREMOD is clear, the structure is shared
313 * copy-on-write.)
314 */
315 if (p1->p_limit->p_lflags & PL_SHAREMOD)
316 p2->p_limit = limcopy(p1->p_limit);
317 else {
318 p2->p_limit = p1->p_limit;
319 p2->p_limit->p_refcnt++;
320 }
321
322 if (p1->p_session->s_ttyvp != NULL && p1->p_flag & P_CONTROLT)
323 p2->p_flag |= P_CONTROLT;
324 if (flags & FORK_PPWAIT)
325 p2->p_flag |= P_PPWAIT;
326 LIST_INSERT_AFTER(p1, p2, p_pglist);
327 p2->p_pptr = p1;
328 LIST_INSERT_HEAD(&p1->p_children, p2, p_sibling);
329 LIST_INIT(&p2->p_children);
330
331 callout_init(&p2->p_realit_ch);
332 callout_init(&p2->p_tsleep_ch);
333
334 #ifdef KTRACE
335 /*
336 * Copy traceflag and tracefile if enabled.
337 * If not inherited, these were zeroed above.
338 */
339 if (p1->p_traceflag & KTRFAC_INHERIT) {
340 p2->p_traceflag = p1->p_traceflag;
341 if ((p2->p_tracep = p1->p_tracep) != NULL)
342 ktradref(p2);
343 }
344 #endif
345
346 #ifdef __HAVE_SYSCALL_INTERN
347 (*p2->p_emul->e_syscall_intern)(p2);
348 #endif
349
350 scheduler_fork_hook(p1, p2);
351
352 /*
353 * Create signal actions for the child process.
354 */
355 sigactsinit(p2, p1, flags & FORK_SHARESIGS);
356
357 /*
358 * If emulation has process fork hook, call it now.
359 */
360 if (p2->p_emul->e_proc_fork)
361 (*p2->p_emul->e_proc_fork)(p2, p1);
362
363 /*
364 * This begins the section where we must prevent the parent
365 * from being swapped.
366 */
367 PHOLD(p1);
368
369 /*
370 * Finish creating the child process. It will return through a
371 * different path later.
372 */
373 p2->p_addr = (struct user *)uaddr;
374 uvm_fork(p1, p2, (flags & FORK_SHAREVM) ? TRUE : FALSE,
375 stack, stacksize,
376 (func != NULL) ? func : child_return,
377 (arg != NULL) ? arg : p2);
378
379 /*
380 * BEGIN PID ALLOCATION.
381 */
382 s = proclist_lock_write();
383
384 /*
385 * Find an unused process ID. We remember a range of unused IDs
386 * ready to use (from nextpid+1 through pidchecked-1).
387 */
388 nextpid++;
389 retry:
390 /*
391 * If the process ID prototype has wrapped around,
392 * restart somewhat above 0, as the low-numbered procs
393 * tend to include daemons that don't exit.
394 */
395 if (nextpid >= PID_MAX) {
396 nextpid = 500;
397 pidchecked = 0;
398 }
399 if (nextpid >= pidchecked) {
400 const struct proclist_desc *pd;
401
402 pidchecked = PID_MAX;
403 /*
404 * Scan the process lists to check whether this pid
405 * is in use. Remember the lowest pid that's greater
406 * than nextpid, so we can avoid checking for a while.
407 */
408 pd = proclists;
409 again:
410 LIST_FOREACH(tp, pd->pd_list, p_list) {
411 while (tp->p_pid == nextpid ||
412 tp->p_pgrp->pg_id == nextpid ||
413 tp->p_session->s_sid == nextpid) {
414 nextpid++;
415 if (nextpid >= pidchecked)
416 goto retry;
417 }
418 if (tp->p_pid > nextpid && pidchecked > tp->p_pid)
419 pidchecked = tp->p_pid;
420
421 if (tp->p_pgrp->pg_id > nextpid &&
422 pidchecked > tp->p_pgrp->pg_id)
423 pidchecked = tp->p_pgrp->pg_id;
424
425 if (tp->p_session->s_sid > nextpid &&
426 pidchecked > tp->p_session->s_sid)
427 pidchecked = tp->p_session->s_sid;
428 }
429
430 /*
431 * If there's another list, scan it. If we have checked
432 * them all, we've found one!
433 */
434 pd++;
435 if (pd->pd_list != NULL)
436 goto again;
437 }
438
439 /* Record the pid we've allocated. */
440 p2->p_pid = nextpid;
441
442 /* Record the signal to be delivered to the parent on exit. */
443 p2->p_exitsig = exitsig;
444
445 /*
446 * Put the proc on allproc before unlocking PID allocation
447 * so that waiters won't grab it as soon as we unlock.
448 */
449
450 p2->p_stat = SIDL; /* protect against others */
451 p2->p_forw = p2->p_back = NULL; /* shouldn't be necessary */
452
453 LIST_INSERT_HEAD(&allproc, p2, p_list);
454
455 LIST_INSERT_HEAD(PIDHASH(p2->p_pid), p2, p_hash);
456
457 /*
458 * END PID ALLOCATION.
459 */
460 proclist_unlock_write(s);
461
462 /*
463 * Make child runnable, set start time, and add to run queue.
464 */
465 SCHED_LOCK(s);
466 p2->p_stats->p_start = time;
467 p2->p_acflag = AFORK;
468 p2->p_stat = SRUN;
469 setrunqueue(p2);
470 SCHED_UNLOCK(s);
471
472 /*
473 * Now can be swapped.
474 */
475 PRELE(p1);
476
477 /*
478 * Update stats now that we know the fork was successful.
479 */
480 uvmexp.forks++;
481 if (flags & FORK_PPWAIT)
482 uvmexp.forks_ppwait++;
483 if (flags & FORK_SHAREVM)
484 uvmexp.forks_sharevm++;
485
486 /*
487 * Pass a pointer to the new process to the caller.
488 */
489 if (rnewprocp != NULL)
490 *rnewprocp = p2;
491
492 #ifdef KTRACE
493 if (KTRPOINT(p2, KTR_EMUL))
494 ktremul(p2);
495 #endif
496
497 /*
498 * Preserve synchronization semantics of vfork. If waiting for
499 * child to exec or exit, set P_PPWAIT on child, and sleep on our
500 * proc (in case of exit).
501 */
502 if (flags & FORK_PPWAIT)
503 while (p2->p_flag & P_PPWAIT)
504 tsleep(p1, PWAIT, "ppwait", 0);
505
506 /*
507 * Return child pid to parent process,
508 * marking us as parent via retval[1].
509 */
510 if (retval != NULL) {
511 retval[0] = p2->p_pid;
512 retval[1] = 0;
513 }
514
515 return (0);
516 }
517
518 #if defined(MULTIPROCESSOR)
519 /*
520 * XXX This is a slight hack to get newly-formed processes to
521 * XXX acquire the kernel lock as soon as they run.
522 */
523 void
524 proc_trampoline_mp(void)
525 {
526 struct proc *p;
527
528 p = curproc;
529
530 SCHED_ASSERT_UNLOCKED();
531 KERNEL_PROC_LOCK(p);
532 }
533 #endif
534