original/man2/pipe.2

   1 .\" Copyright (C) 2005, 2008, Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\" (A few fragments remain from an earlier (1992) version by
   3 .\" Drew Eckhardt <drew@cs.colorado.edu>.)
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" Modified by Michael Haardt <michael@moria.de>
  28 .\" Modified 1993-07-23 by Rik Faith <faith@cs.unc.edu>
  29 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  30 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  31 .\" Modified 2005, mtk: added an example program
  32 .\" Modified 2008-01-09, mtk: rewrote DESCRIPTION; minor additions
  33 .\"     to EXAMPLE text.
  34 .\" 2008-10-10, mtk: add description of pipe2()
  35 .\"
  36 .TH PIPE 2 2014-02-11 "Linux" "Linux Programmer's Manual"
  37 .SH NAME
  38 pipe, pipe2 \- create pipe
  39 .SH SYNOPSIS
  40 .nf
  41 .B #include <unistd.h>
  42 .sp
  43 .BI "int pipe(int " pipefd "[2]);"
  44 .sp
  45 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  46 .BR "#include <fcntl.h>" "              /* Obtain O_* constant definitions */
  47 .B #include <unistd.h>
  48 .sp
  49 .BI "int pipe2(int " pipefd "[2], int " flags );
  50 .fi
  51 .SH DESCRIPTION
  52 .BR pipe ()
  53 creates a pipe, a unidirectional data channel that
  54 can be used for interprocess communication.
  55 The array
  56 .IR pipefd
  57 is used to return two file descriptors referring to the ends of the pipe.
  58 .IR pipefd[0]
  59 refers to the read end of the pipe.
  60 .IR pipefd[1]
  61 refers to the write end of the pipe.
  62 Data written to the write end of the pipe is buffered by the kernel
  63 until it is read from the read end of the pipe.
  64 For further details, see
  65 .BR pipe (7).
  66
  67 If
  68 .IR flags
  69 is 0, then
  70 .BR pipe2 ()
  71 is the same as
  72 .BR pipe ().
  73 The following values can be bitwise ORed in
  74 .IR flags
  75 to obtain different behavior:
  76 .TP
  77 .B O_CLOEXEC
  78 Set the close-on-exec
  79 .RB ( FD_CLOEXEC )
  80 flag on the two new file descriptors.
  81 See the description of the same flag in
  82 .BR open (2)
  83 for reasons why this may be useful.
  84 .TP
  85 .BR O_DIRECT " (since Linux 3.4)"
  86 .\" commit 9883035ae7edef3ec62ad215611cb8e17d6a1a5d
  87 Create a pipe that performs I/O in "packet" mode.
  88 Each
  89 .BR write (2)
  90 to the pipe is dealt with as a separate packet, and
  91 .BR read (2)s
  92 from the pipe will read one packet at a time.
  93 Note the following points:
  94 .RS
  95 .IP * 3
  96 Writes of greater than
  97 .BR PIPE_BUF
  98 bytes (see
  99 .BR pipe (7))
 100 will be split into multiple packets.
 101 .IP *
 102 If a
 103 .BR read (2)
 104 specifies a buffer size that is smaller than the next packet,
 105 then the requested number of bytes are read,
 106 and the excess bytes in the packet are discarded.
 107 Specifying a buffer size of
 108 .BR PIPE_BUF
 109 will be sufficient to read the largest possible packets
 110 (see the previous point).
 111 .IP *
 112 Zero-length packets are not supported.
 113 (A
 114 .BR read (2)
 115 that specifies a buffer size of zero is a no-op, and returns 0.)
 116 .RE
 117 .IP
 118 Older kernels that do not support this flag will indicate this via an
 119 .B EINVAL
 120 error.
 121 .TP
 122 .B O_NONBLOCK
 123 Set the
 124 .BR O_NONBLOCK
 125 file status flag on the two new open file descriptions.
 126 Using this flag saves extra calls to
 127 .BR fcntl (2)
 128 to achieve the same result.
 129 .SH RETURN VALUE
 130 On success, zero is returned.
 131 On error, \-1 is returned, and
 132 .I errno
 133 is set appropriately.
 134 .SH ERRORS
 135 .TP
 136 .B EFAULT
 137 .I pipefd
 138 is not valid.
 139 .TP
 140 .B EINVAL
 141 .RB ( pipe2 ())
 142 Invalid value in
 143 .IR flags .
 144 .TP
 145 .B EMFILE
 146 Too many file descriptors are in use by the process.
 147 .TP
 148 .B ENFILE
 149 The system limit on the total number of open files has been reached.
 150 .SH VERSIONS
 151 .BR pipe2 ()
 152 was added to Linux in version 2.6.27;
 153 glibc support is available starting with
 154 version 2.9.
 155 .SH CONFORMING TO
 156 .BR pipe ():
 157 POSIX.1-2001.
 158
 159 .BR pipe2 ()
 160 is Linux-specific.
 161 .SH EXAMPLE
 162 .\" fork.2 refers to this example program.
 163 The following program creates a pipe, and then
 164 .BR fork (2)s
 165 to create a child process;
 166 the child inherits a duplicate set of file
 167 descriptors that refer to the same pipe.
 168 After the
 169 .BR fork (2),
 170 each process closes the descriptors that it doesn't need for the pipe
 171 (see
 172 .BR pipe (7)).
 173 The parent then writes the string contained in the program's
 174 command-line argument to the pipe,
 175 and the child reads this string a byte at a time from the pipe
 176 and echoes it on standard output.
 177 .SS Program source
 178 .nf
 179 #include <sys/types.h>
 180 #include <sys/wait.h>
 181 #include <stdio.h>
 182 #include <stdlib.h>
 183 #include <unistd.h>
 184 #include <string.h>
 185
 186 int
 187 main(int argc, char *argv[])
 188 {
 189     int pipefd[2];
 190     pid_t cpid;
 191     char buf;
 192
 193     if (argc != 2) {
 194         fprintf(stderr, "Usage: %s <string>\\n", argv[0]);
 195         exit(EXIT_FAILURE);
 196     }
 197
 198     if (pipe(pipefd) == \-1) {
 199         perror("pipe");
 200         exit(EXIT_FAILURE);
 201     }
 202
 203     cpid = fork();
 204     if (cpid == \-1) {
 205         perror("fork");
 206         exit(EXIT_FAILURE);
 207     }
 208
 209     if (cpid == 0) {    /* Child reads from pipe */
 210         close(pipefd[1]);          /* Close unused write end */
 211
 212         while (read(pipefd[0], &buf, 1) > 0)
 213             write(STDOUT_FILENO, &buf, 1);
 214
 215         write(STDOUT_FILENO, "\\n", 1);
 216         close(pipefd[0]);
 217         _exit(EXIT_SUCCESS);
 218
 219     } else {            /* Parent writes argv[1] to pipe */
 220         close(pipefd[0]);          /* Close unused read end */
 221         write(pipefd[1], argv[1], strlen(argv[1]));
 222         close(pipefd[1]);          /* Reader will see EOF */
 223         wait(NULL);                /* Wait for child */
 224         exit(EXIT_SUCCESS);
 225     }
 226 }
 227 .fi
 228 .SH SEE ALSO
 229 .BR fork (2),
 230 .BR read (2),
 231 .BR socketpair (2),
 232 .BR write (2),
 233 .BR popen (3),
 234 .BR pipe (7)
 235 .SH COLOPHON
 236 This page is part of release 3.67 of the Linux
 237 .I man-pages
 238 project.
 239 A description of the project,
 240 information about reporting bugs,
 241 and the latest version of this page,
 242 can be found at
 243 \%http://www.kernel.org/doc/man\-pages/.