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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)fork.2      8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/sys/fork.2,v 1.9.2.6 2002/07/30 19:04:25 silby Exp $
  30 .\" $DragonFly: src/lib/libc/sys/fork.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt FORK 2
  34 .Os
  35 .Sh NAME
  36 .Nm fork
  37 .Nd create a new process
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In unistd.h
  43 .Ft pid_t
  44 .Fn fork void
  45 .Sh DESCRIPTION
  46 .Fn Fork
  47 causes creation of a new process.
  48 The new process (child process) is an exact copy of the
  49 calling process (parent process) except for the following:
  50 .Bl -bullet -offset indent
  51 .It
  52 The child process has a unique process ID.
  53 .It
  54 The child process has a different parent
  55 process ID (i.e., the process ID of the parent process).
  56 .It
  57 The child process has its own copy of the parent's descriptors.
  58 These descriptors reference the same underlying objects, so that,
  59 for instance, file pointers in file objects are shared between
  60 the child and the parent, so that an
  61 .Xr lseek 2
  62 on a descriptor in the child process can affect a subsequent
  63 .Xr read 2
  64 or
  65 .Xr write 2
  66 by the parent.
  67 This descriptor copying is also used by the shell to
  68 establish standard input and output for newly created processes
  69 as well as to set up pipes.
  70 .It
  71 The child process' resource utilizations
  72 are set to 0; see
  73 .Xr setrlimit 2 .
  74 .It
  75 All interval timers are cleared; see
  76 .Xr setitimer 2 .
  77 .El
  78 .Sh RETURN VALUES
  79 Upon successful completion,
  80 .Fn fork
  81 returns a value
  82 of 0 to the child process and returns the process ID of the child
  83 process to the parent process.  Otherwise, a value of -1 is returned
  84 to the parent process, no child process is created, and the global
  85 variable
  86 .Va errno
  87 is set to indicate the error.
  88 .Sh ERRORS
  89 .Fn Fork
  90 will fail and no child process will be created if:
  91 .Bl -tag -width Er
  92 .It Bq Er EAGAIN
  93 The system-imposed limit on the total
  94 number of processes under execution would be exceeded.
  95 The limit is given by the
  96 .Xr sysctl 3
  97 MIB variable
  98 .Dv KERN_MAXPROC .
  99 (The limit is actually ten less than this
 100 except for the super user).
 101 .It Bq Er EAGAIN
 102 The user is not the super user, and
 103 the system-imposed limit
 104 on the total number of
 105 processes under execution by a single user would be exceeded.
 106 The limit is given by the
 107 .Xr sysctl 3
 108 MIB variable
 109 .Dv KERN_MAXPROCPERUID .
 110 .It Bq Er EAGAIN
 111 The user is not the super user, and
 112 the soft resource limit corresponding to the resource parameter
 113 .Dv RLIMIT_NPROC
 114 would be exceeded (see
 115 .Xr getrlimit 2 ) .
 116 .It Bq Er ENOMEM
 117 There is insufficient swap space for the new process.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr execve 2 ,
 121 .Xr rfork 2 ,
 122 .Xr setitimer 2 ,
 123 .Xr setrlimit 2 ,
 124 .Xr vfork 2 ,
 125 .Xr wait 2
 126 .Sh HISTORY
 127 A
 128 .Fn fork
 129 function call appeared in
 130 .At v6 .