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