xref: /freebsd-14.2/lib/libc/sys/vfork.2 (revision fffcbbcd)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)vfork.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd June 4, 1993
36.Dt VFORK 2
37.Os
38.Sh NAME
39.Nm vfork
40.Nd spawn new process in a virtual memory efficient way
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.Fd #include <unistd.h>
45.Ft int
46.Fn vfork void
47.Sh DESCRIPTION
48.Fn Vfork
49can be used to create new processes without fully copying the address
50space of the old process, which is horrendously inefficient in a paged
51environment.  It is useful when the purpose of
52.Xr fork 2
53would have been to create a new system context for an
54.Xr execve 2 .
55.Fn Vfork
56differs from
57.Xr fork 2
58in that the child borrows the parent's memory and thread of
59control until a call to
60.Xr execve 2
61or an exit (either by a call to
62.Xr _exit 2
63or abnormally).
64The parent process is suspended while the child is using its resources.
65.Pp
66.Fn Vfork
67returns 0 in the child's context and (later) the pid of the child in
68the parent's context.
69.Pp
70.Fn Vfork
71can normally be used just like
72.Xr fork 2 .
73It does not work, however, to return while running in the childs context
74from the procedure that called
75.Fn vfork
76since the eventual return from
77.Fn vfork
78would then return to a no longer existent stack frame.
79Be careful, also, to call
80.Xr _exit 2
81rather than
82.Xr exit 3
83if you can't
84.Xr execve 2 ,
85since
86.Xr exit 3
87will flush and close standard I/O channels, and thereby mess up the
88parent processes standard I/O data structures.
89(Even with
90.Xr fork 2
91it is wrong to call
92.Xr exit 3
93since buffered data would then be flushed twice.)
94.Sh SEE ALSO
95.Xr execve 2 ,
96.Xr fork 2 ,
97.Xr rfork 2 ,
98.Xr sigvec 2 ,
99.Xr wait 2 ,
100.Xr _exit 2 ,
101.Xr exit 3
102.Sh RETURN VALUES
103Same as for
104.Xr fork 2 .
105.Sh BUGS
106This system call will be eliminated when proper system sharing
107mechanisms are implemented.
108Users should not depend on the memory
109sharing semantics of
110.Xr vfork 2
111as it will, in that case, be made synonymous to
112.Xr fork 2 .
113.Pp
114To avoid a possible deadlock situation,
115processes that are children in the middle
116of a
117.Fn vfork
118are never sent
119.Dv SIGTTOU
120or
121.Dv SIGTTIN
122signals; rather,
123output or
124.Xr ioctl 2
125calls
126are allowed
127and input attempts result in an end-of-file indication.
128.Sh HISTORY
129The
130.Fn vfork
131function call appeared in
132.Bx 2.9 .
133