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