lib/libc/sys/pipe.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 .\"     @(#)pipe.2      8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/sys/pipe.2,v 1.13.2.5 2001/12/14 18:34:01 ru Exp $
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt PIPE 2
  33 .Os
  34 .Sh NAME
  35 .Nm pipe ,
  36 .Nm pipe2
  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"
  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 bidirectional data flow,
  54 and allocates a pair of file descriptors.
  55 .Pp
  56 The
  57 .Fn pipe2
  58 system call allows control over the attributes of the file descriptors
  59 via the
  60 .Fa flags
  61 argument.
  62 Values for
  63 .Fa flags
  64 are constructed by a bitwise-inclusive OR of flags from the following
  65 list, defined in
  66 .In fcntl.h :
  67 .Bl -tag -width ".Dv O_NONBLOCK"
  68 .It Dv O_CLOEXEC
  69 Set the close-on-exec flag for the new file descriptors.
  70 .It Dv O_NONBLOCK
  71 Set the non-blocking flag for the ends of the pipe.
  72 .El
  73 .Pp
  74 If the
  75 .Fa flags
  76 argument is 0, the behavior is identical to a call to
  77 .Fn pipe .
  78 .Pp
  79 By convention, the first descriptor is normally used as the
  80 .Em read end
  81 of the pipe,
  82 and the second is normally the
  83 .Em write end ,
  84 so that data written to
  85 .Fa fildes[1]
  86 appears on (i.e., can be read from)
  87 .Fa fildes[0] .
  88 This allows the output of one program to be
  89 sent
  90 to another program:
  91 the source's standard output is set up to be
  92 the write end of the pipe,
  93 and the sink's standard input is set up to be
  94 the read end of the pipe.
  95 The pipe itself persists until all its associated descriptors are
  96 closed.
  97 .Pp
  98 A pipe that has had an end closed is considered
  99 .Em widowed .
 100 Writing on such a pipe causes the writing process to receive
 101 a
 102 .Dv SIGPIPE
 103 signal.
 104 Widowing a pipe is the only way to deliver end-of-file to a reader:
 105 after the reader consumes any buffered data, reading a widowed pipe
 106 returns a zero count.
 107 .Pp
 108 The bidirectional nature of this implementation of pipes is not
 109 portable to older systems, so it is recommended to use the convention
 110 for using the endpoints in the traditional manner when using a
 111 pipe in one direction.
 112 .Sh RETURN VALUES
 113 .Rv -std pipe
 114 .Sh ERRORS
 115 The
 116 .Fn pipe
 117 and
 118 .Fn pipe2
 119 system calls will fail if:
 120 .Bl -tag -width Er
 121 .It Bq Er EMFILE
 122 Too many descriptors are active.
 123 .It Bq Er ENFILE
 124 The system file table is full.
 125 .It Bq Er EFAULT
 126 The
 127 .Fa fildes
 128 buffer is in an invalid area of the process's address
 129 space.
 130 .El
 131 .Pp
 132 The
 133 .Fn pipe2
 134 system call will also fail if:
 135 .Bl -tag -width Er
 136 .It Bq Er EINVAL
 137 The
 138 .Fa flags
 139 argument is invalid.
 140 .El
 141 .Sh SEE ALSO
 142 .Xr sh 1 ,
 143 .Xr fork 2 ,
 144 .Xr read 2 ,
 145 .Xr socketpair 2 ,
 146 .Xr write 2
 147 .Sh HISTORY
 148 A
 149 .Fn pipe
 150 function call appeared in
 151 .At v3 .
 152 .Pp
 153 Bidirectional pipes were first used on
 154 .At V.4 .