Pipes and FIFOs
***************

A pipe is a mechanism for interprocess communication; data written to the pipe by one process can be read by another process.  The data is handled in a first-in, first-out (FIFO) order.  The pipe has no name; it is created for one use and both ends must be inherited from the single process which created the pipe.

A FIFO special file is similar to a pipe, but instead of being an anonymous, temporary connection, a FIFO has a name or names like any other file.  Processes open the FIFO by name in order to communicate through it.

A pipe or FIFO has to be open at both ends simultaneously.  If you read from a pipe or FIFO file that doesn't have any processes writing to it (perhaps because they have all closed the file, or exited), the read returns end-of-file.  Writing to a pipe or FIFO that doesn't have a reading process is treated as an error condition; it generates a SIGPIPE signal, and fails with error code EPIPE if the signal is handled or blocked.

Neither pipes nor FIFO special files allow file positioning.  Both reading and writing operations happen sequentially; reading from the beginning of the file and writing at the end.

Creating a Pipe
===============

The primitive for creating a pipe is the pipe function.  This creates both the reading and writing ends of the pipe.  It is not very useful for a single process to use a pipe to talk to itself.  In typical use, a process creates a pipe just before it forks one or more child processes (see Creating a Process).  The pipe is then used for communication either between the parent or child processes, or between two sibling processes.

The pipe function is declared in the header file unistd.h.

 -- Function: int pipe (int FILEDES[2])
     The pipe function creates a pipe and puts the file descriptors for the reading and writing ends of the pipe (respectively) into FILEDES[0] and FILEDES[1].

     An easy way to remember that the input end comes first is that file descriptor 0 is standard input, and file descriptor 1 is standard output.

     If successful, pipe returns a value of 0.  On failure, -1 is returned.  The following errno error conditions are defined for this function:

     EMFILE
          The process has too many files open.

     ENFILE
          There are too many open files in the entire system.  See Error Codes, for more information about ENFILE.  This error never occurs in the GNU system.

Here is an example of a simple program that creates a pipe.  This program uses the fork function (see Creating a Process) to create a child process.  The parent process writes data to the pipe, which is read by the child process.

          [file pipe.c.texi not included]

Pipe to a Subprocess
====================

A common use of pipes is to send data to or receive data from a program being run as a subprocess.  One way of doing this is by using a combination of pipe (to create the pipe), fork (to create the subprocess), dup2 (to force the subprocess to use the pipe as its standard input or output channel), and exec (to execute the new program).  Or, you can use popen and pclose.

The advantage of using popen and pclose is that the interface is much simpler and easier to use.  But it doesn't offer as much flexibility as using the low-level functions directly.

 -- Function: FILE * popen (const char *COMMAND, const char *MODE)
     The popen function is closely related to the system function; see Running a Command.  It executes the shell command COMMAND as a subprocess.  However, instead of waiting for the command to complete, it creates a pipe to the subprocess and returns a stream that corresponds to that pipe.

     If you specify a MODE argument of "r", you can read from the stream to retrieve data from the standard output channel of the subprocess. The subprocess inherits its standard input channel from the parent process.

     Similarly, if you specify a MODE argument of "w", you can write to the stream to send data to the standard input channel of the subprocess.  The subprocess inherits its standard output channel from the parent process.

     In the event of an error popen returns a null pointer.  This might happen if the pipe or stream cannot be created, if the subprocess cannot be forked, or if the program cannot be executed.

 -- Function: int pclose (FILE *STREAM)
     The pclose function is used to close a stream created by popen. It waits for the child process to terminate and returns its status value, as for the system function.

Here is an example showing how to use popen and pclose to filter output through another program, in this case the paging program more.

          [file popen.c.texi not included]

FIFO Special Files
==================

A FIFO special file is similar to a pipe, except that it is created in a different way.  Instead of being an anonymous communications channel, a FIFO special file is entered into the file system by calling mkfifo.

Once you have created a FIFO special file in this way, any process can open it for reading or writing, in the same way as an ordinary file. However, it has to be open at both ends simultaneously before you can proceed to do any input or output operations on it.  Opening a FIFO for reading normally blocks until some other process opens the same FIFO for writing, and vice versa.

The mkfifo function is declared in the header file sys/stat.h.

 -- Function: int mkfifo (const char *FILENAME, mode_t MODE)
     The mkfifo function makes a FIFO special file with name FILENAME.  The MODE argument is used to set the file's permissions; see Setting Permissions.

     The normal, successful return value from mkfifo is 0.  In the case of an error, -1 is returned.  In addition to the usual file name errors (see File Name Errors), the following errno error conditions are defined for this function:

     EEXIST
          The named file already exists.

     ENOSPC
          The directory or file system cannot be extended.

     EROFS
          The directory that would contain the file resides on a read-only file system.

Atomicity of Pipe I/O
=====================

Reading or writing pipe data is atomic if the size of data written is not greater than PIPE_BUF.  This means that the data transfer seems to be an instantaneous unit, in that nothing else in the system can observe a state in which it is partially complete.  Atomic I/O may not begin right away (it may need to wait for buffer space or for data), but once it does begin it finishes immediately.

Reading or writing a larger amount of data may not be atomic; for example, output data from other processes sharing the descriptor may be interspersed.  Also, once PIPE_BUF characters have been written, further writes will block until some characters are read.

See Limits for Files, for information about the PIPE_BUF parameter.