lib/libc/sys/fork.2

   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 .\"     @(#)fork.2      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/fork.2,v 1.9.2.6 2002/07/30 19:04:25 silby Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt FORK 2
  37 .Os
  38 .Sh NAME
  39 .Nm fork
  40 .Nd create a new process
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .In unistd.h
  46 .Ft pid_t
  47 .Fn fork void
  48 .Sh DESCRIPTION
  49 .Fn Fork
  50 causes creation of a new process.
  51 The new process (child process) is an exact copy of the
  52 calling process (parent process) except for the following:
  53 .Bl -bullet -offset indent
  54 .It
  55 The child process has a unique process ID.
  56 .It
  57 The child process has a different parent
  58 process ID (i.e., the process ID of the parent process).
  59 .It
  60 The child process has its own copy of the parent's descriptors.
  61 These descriptors reference the same underlying objects, so that,
  62 for instance, file pointers in file objects are shared between
  63 the child and the parent, so that an
  64 .Xr lseek 2
  65 on a descriptor in the child process can affect a subsequent
  66 .Xr read 2
  67 or
  68 .Xr write 2
  69 by the parent.
  70 This descriptor copying is also used by the shell to
  71 establish standard input and output for newly created processes
  72 as well as to set up pipes.
  73 .It
  74 The child process' resource utilizations
  75 are set to 0; see
  76 .Xr setrlimit 2 .
  77 .It
  78 All interval timers are cleared; see
  79 .Xr setitimer 2 .
  80 .El
  81 .Sh RETURN VALUES
  82 Upon successful completion,
  83 .Fn fork
  84 returns a value
  85 of 0 to the child process and returns the process ID of the child
  86 process to the parent process.  Otherwise, a value of -1 is returned
  87 to the parent process, no child process is created, and the global
  88 variable
  89 .Va errno
  90 is set to indicate the error.
  91 .Sh ERRORS
  92 .Fn Fork
  93 will fail and no child process will be created if:
  94 .Bl -tag -width Er
  95 .It Bq Er EAGAIN
  96 The system-imposed limit on the total
  97 number of processes under execution would be exceeded.
  98 The limit is given by the
  99 .Xr sysctl 3
 100 MIB variable
 101 .Dv KERN_MAXPROC .
 102 (The limit is actually ten less than this
 103 except for the super user).
 104 .It Bq Er EAGAIN
 105 The user is not the super user, and
 106 the system-imposed limit
 107 on the total number of
 108 processes under execution by a single user would be exceeded.
 109 The limit is given by the
 110 .Xr sysctl 3
 111 MIB variable
 112 .Dv KERN_MAXPROCPERUID .
 113 .It Bq Er EAGAIN
 114 The user is not the super user, and
 115 the soft resource limit corresponding to the resource parameter
 116 .Dv RLIMIT_NPROC
 117 would be exceeded (see
 118 .Xr getrlimit 2 ) .
 119 .It Bq Er ENOMEM
 120 There is insufficient swap space for the new process.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr execve 2 ,
 124 .Xr rfork 2 ,
 125 .Xr setitimer 2 ,
 126 .Xr setrlimit 2 ,
 127 .Xr vfork 2 ,
 128 .Xr wait 2
 129 .Sh HISTORY
 130 A
 131 .Fn fork
 132 function call appeared in
 133 .At v6 .