lib/libc/sys/pipe.2

   1 .\"     $NetBSD: pipe.2,v 1.29 2013/04/23 23:39:13 elric Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)pipe.2      8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd January 23, 2012
  33 .Dt PIPE 2
  34 .Os
  35 .Sh NAME
  36 .Nm pipe
  37 .Nd create descriptor pair for interprocess communication
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft int
  43 .Fn pipe "int fildes[2]"
  44 .Ft int
  45 .Fn pipe2 "int fildes[2]" "int flags"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn pipe
  49 function
  50 creates a
  51 .Em pipe ,
  52 which is an object allowing
  53 unidirectional data flow,
  54 and allocates a pair of file descriptors.
  55 The first descriptor connects to the
  56 .Em read end
  57 of the pipe,
  58 and the second connects to the
  59 .Em write end  ,
  60 so that data written to
  61 .Fa fildes[1]
  62 appears on (i.e., can be read from)
  63 .Fa fildes[0] .
  64 This allows the output of one program to be
  65 sent
  66 to another program:
  67 the source's standard output is set up to be
  68 the write end of the pipe,
  69 and the sink's standard input is set up to be
  70 the read end of the pipe.
  71 The pipe itself persists until all its associated descriptors are
  72 closed.
  73 .Pp
  74 A pipe whose read or write end has been closed is considered
  75 .Em widowed .
  76 Writing on such a pipe causes the writing process to receive
  77 a
  78 .Dv SIGPIPE
  79 signal.
  80 Widowing a pipe is the only way to deliver end-of-file to a reader:
  81 after the reader consumes any buffered data, reading a widowed pipe
  82 returns a zero count.
  83 .Pp
  84 The
  85 .Fn pipe2
  86 function
  87 behaves exactly like
  88 .Fn pipe
  89 only it allows extra
  90 .Fa flags
  91 to be set on the returned file descriptor.
  92 The following flags are valid:
  93 .Bl -tag -width O_NONBLOCK -offset indent
  94 .It Dv O_CLOEXEC
  95 Set the
  96 .Dq close-on-exec
  97 property.
  98 .It Dv O_NONBLOCK
  99 Sets non-blocking I/O.
 100 .It Dv O_NOSIGPIPE
 101 Return
 102 .Er EPIPE
 103 instead of raising
 104 .Dv SIGPIPE .
 105 .El
 106 .Sh RETURN VALUES
 107 On successful creation of the pipe, zero is returned.
 108 Otherwise, a value of \-1 is returned and the variable
 109 .Va errno
 110 set to indicate the
 111 error.
 112 .Sh ERRORS
 113 The
 114 .Fn pipe
 115 and
 116 .Fn pipe2
 117 calls will fail if:
 118 .Bl -tag -width Er
 119 .It Bq Er EFAULT
 120 The
 121 .Fa fildes
 122 buffer is in an invalid area of the process's address space.
 123 The reliable detection of this error cannot be guaranteed; when not
 124 detected, a signal may be delivered to the process, indicating an
 125 address violation.
 126 .It Bq Er EMFILE
 127 Too many descriptors are active.
 128 .It Bq Er ENFILE
 129 The system file table is full.
 130 .El
 131 .Pp
 132 .Fn pipe2
 133 will also fail if:
 134 .Bl -tag -width Er
 135 .It Bq Er EINVAL
 136 .Fa flags
 137 is other than
 138 .Dv O_NONBLOCK ,
 139 .Dv O_NOSIGPIPE
 140 or
 141 .Dv O_CLOEXEC .
 142 .El
 143 .Sh SEE ALSO
 144 .Xr sh 1 ,
 145 .Xr fork 2 ,
 146 .Xr read 2 ,
 147 .Xr socketpair 2 ,
 148 .Xr write 2
 149 .Sh STANDARDS
 150 The
 151 .Fn pipe
 152 function conforms to
 153 .St -p1003.1-90 .
 154 .Sh HISTORY
 155 A
 156 .Fn pipe
 157 function call appeared in
 158 .At v6 .
 159 The
 160 .Fn pipe2
 161 function is inspired from Linux and appeared in
 162 .Nx 6.0 .