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-07-08 "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 The constant
 102 .BR PIPE_BUF
 103 is defined in
 104 .IR <limits.h> .
 105 .IP *
 106 If a
 107 .BR read (2)
 108 specifies a buffer size that is smaller than the next packet,
 109 then the requested number of bytes are read,
 110 and the excess bytes in the packet are discarded.
 111 Specifying a buffer size of
 112 .BR PIPE_BUF
 113 will be sufficient to read the largest possible packets
 114 (see the previous point).
 115 .IP *
 116 Zero-length packets are not supported.
 117 (A
 118 .BR read (2)
 119 that specifies a buffer size of zero is a no-op, and returns 0.)
 120 .RE
 121 .IP
 122 Older kernels that do not support this flag will indicate this via an
 123 .B EINVAL
 124 error.
 125 .TP
 126 .B O_NONBLOCK
 127 Set the
 128 .BR O_NONBLOCK
 129 file status flag on the two new open file descriptions.
 130 Using this flag saves extra calls to
 131 .BR fcntl (2)
 132 to achieve the same result.
 133 .SH RETURN VALUE
 134 On success, zero is returned.
 135 On error, \-1 is returned, and
 136 .I errno
 137 is set appropriately.
 138 .SH ERRORS
 139 .TP
 140 .B EFAULT
 141 .I pipefd
 142 is not valid.
 143 .TP
 144 .B EINVAL
 145 .RB ( pipe2 ())
 146 Invalid value in
 147 .IR flags .
 148 .TP
 149 .B EMFILE
 150 Too many file descriptors are in use by the process.
 151 .TP
 152 .B ENFILE
 153 The system limit on the total number of open files has been reached.
 154 .SH VERSIONS
 155 .BR pipe2 ()
 156 was added to Linux in version 2.6.27;
 157 glibc support is available starting with
 158 version 2.9.
 159 .SH CONFORMING TO
 160 .BR pipe ():
 161 POSIX.1-2001.
 162
 163 .BR pipe2 ()
 164 is Linux-specific.
 165 .SH EXAMPLE
 166 .\" fork.2 refers to this example program.
 167 The following program creates a pipe, and then
 168 .BR fork (2)s
 169 to create a child process;
 170 the child inherits a duplicate set of file
 171 descriptors that refer to the same pipe.
 172 After the
 173 .BR fork (2),
 174 each process closes the descriptors that it doesn't need for the pipe
 175 (see
 176 .BR pipe (7)).
 177 The parent then writes the string contained in the program's
 178 command-line argument to the pipe,
 179 and the child reads this string a byte at a time from the pipe
 180 and echoes it on standard output.
 181 .SS Program source
 182 .nf
 183 #include <sys/types.h>
 184 #include <sys/wait.h>
 185 #include <stdio.h>
 186 #include <stdlib.h>
 187 #include <unistd.h>
 188 #include <string.h>
 189
 190 int
 191 main(int argc, char *argv[])
 192 {
 193     int pipefd[2];
 194     pid_t cpid;
 195     char buf;
 196
 197     if (argc != 2) {
 198         fprintf(stderr, "Usage: %s <string>\\n", argv[0]);
 199         exit(EXIT_FAILURE);
 200     }
 201
 202     if (pipe(pipefd) == \-1) {
 203         perror("pipe");
 204         exit(EXIT_FAILURE);
 205     }
 206
 207     cpid = fork();
 208     if (cpid == \-1) {
 209         perror("fork");
 210         exit(EXIT_FAILURE);
 211     }
 212
 213     if (cpid == 0) {    /* Child reads from pipe */
 214         close(pipefd[1]);          /* Close unused write end */
 215
 216         while (read(pipefd[0], &buf, 1) > 0)
 217             write(STDOUT_FILENO, &buf, 1);
 218
 219         write(STDOUT_FILENO, "\\n", 1);
 220         close(pipefd[0]);
 221         _exit(EXIT_SUCCESS);
 222
 223     } else {            /* Parent writes argv[1] to pipe */
 224         close(pipefd[0]);          /* Close unused read end */
 225         write(pipefd[1], argv[1], strlen(argv[1]));
 226         close(pipefd[1]);          /* Reader will see EOF */
 227         wait(NULL);                /* Wait for child */
 228         exit(EXIT_SUCCESS);
 229     }
 230 }
 231 .fi
 232 .SH SEE ALSO
 233 .BR fork (2),
 234 .BR read (2),
 235 .BR socketpair (2),
 236 .BR write (2),
 237 .BR popen (3),
 238 .BR pipe (7)
 239 .SH COLOPHON
 240 This page is part of release 3.78 of the Linux
 241 .I man-pages
 242 project.
 243 A description of the project,
 244 information about reporting bugs,
 245 and the latest version of this page,
 246 can be found at
 247 \%http://www.kernel.org/doc/man\-pages/.