Introduction to Named Pipes

September 1st, 1997 by Andy Vaught in

A very useful Linux feature is named pipes which enable different processes to communicate.
Your rating: None Average: 4.3 (76 votes)

One of the fundamental features that makes Linux and other Unices useful is the “pipe”. Pipes allow separate processes to communicate without having been designed explicitly to work together. This allows tools quite narrow in their function to be combined in complex ways.

A simple example of using a pipe is the command:

ls | grep x

When bash examines the command line, it finds the vertical bar character | that separates the two commands. Bash and other shells run both commands, connecting the output of the first to the input of the second. The ls program produces a list of files in the current directory, while the grep program reads the output of ls and prints only those lines containing the letter x.

The above, familiar to most Unix users, is an example of an “unnamed pipe”. The pipe exists only inside the kernel and cannot be accessed by processes that created it, in this case, the bash shell. For those who don't already know, a parent process is the first process started by a program that in turn creates separate child processes that execute the program.

The other sort of pipe is a “named” pipe, which is sometimes called a FIFO. FIFO stands for “First In, First Out” and refers to the property that the order of bytes going in is the same coming out. The “name” of a named pipe is actually a file name within the file system. Pipes are shown by ls as any other file with a couple of differences:

% ls -l fifo1
prw-r--r--   1 andy  users    0 Jan 22 23:11 fifo1|

The p in the leftmost column indicates that fifo1 is a pipe. The rest of the permission bits control who can read or write to the pipe just like a regular file. On systems with a modern ls, the | character at the end of the file name is another clue, and on Linux systems with the color option enabled, fifo| is printed in red by default.

On older Linux systems, named pipes are created by the mknod program, usually located in the /etc directory. On more modern systems, mkfifo is a standard utility. The mkfifo program takes one or more file names as arguments for this task and creates pipes with those names. For example, to create a named pipe with the name pipe1 give the command:

mkfifo pipe

The simplest way to show how named pipes work is with an example. Suppose we've created pipe as shown above. In one virtual console1, type:

ls -l > pipe1
and in another type:
cat < pipe
Voila! The output of the command run on the first console shows up on the second console. Note that the order in which you run the commands doesn't matter.

If you haven't used virtual consoles before, see the article “Keyboards, Consoles and VT Cruising” by John M. Fisk in the November 1996 Linux Journal.

If you watch closely, you'll notice that the first command you run appears to hang. This happens because the other end of the pipe is not yet connected, and so the kernel suspends the first process until the second process opens the pipe. In Unix jargon, the process is said to be “blocked”, since it is waiting for something to happen.

One very useful application of named pipes is to allow totally unrelated programs to communicate with each other. For example, a program that services requests of some sort (print files, access a database) could open the pipe for reading. Then, another process could make a request by opening the pipe and writing a command. That is, the “server” can perform a task on behalf of the “client”. Blocking can also happen if the client isn't writing, or the server isn't reading.

Pipe Madness

Create two named pipes, pipe1 and pipe2. Run the commands:

echo -n x | cat - pipe1 > pipe2 &
cat <pipe2 > pipe1

On screen, it will not appear that anything is happening, but if you run top (a command similar to ps for showing process status), you'll see that both cat programs are running like crazy copying the letter x back and forth in an endless loop.

After you press ctrl-C to get out of the loop, you may receive the message “broken pipe”. This error occurs when a process writing to a pipe when the process reading the pipe closes its end. Since the reader is gone, the data has no place to go. Normally, the writer will finish writing its data and close the pipe. At this point, the reader sees the EOF (end of file) and executes the request.

Whether or not the “broken pipe” message is issued depends on events at the exact instant the ctrl-C is pressed. If the second cat has just read the x, pressing ctrl-C stops the second cat, pipe1 is closed and the first cat stops quietly, i.e., without a message. On the other hand, if the second cat is waiting for the first to write the x, ctrl-C causes pipe2 to close before the first cat can write to it, and the error message is issued. This sort of random behavior is known as a “race condition”.

Command Substitution

Bash uses named pipes in a really neat way. Recall that when you enclose a command in parenthesis, the command is actually run in a “subshell”; that is, the shell clones itself and the clone interprets the command(s) within the parenthesis. Since the outer shell is running only a single “command”, the output of a complete set of commands can be redirected as a unit. For example, the command:

(ls -l; ls -l) >ls.out

writes two copies of the current directory listing to the file ls.out.

Command substitution occurs when you put a < or > in front of the left parenthesis. For instance, typing the command:

cat <(ls -l)

results in the command ls -l executing in a subshell as usual, but redirects the output to a temporary named pipe, which bash creates, names and later deletes. Therefore, cat has a valid file name to read from, and we see the output of ls -l, taking one more step than usual to do so. Similarly, giving >(commands) results in Bash naming a temporary pipe, which the commands inside the parenthesis read for input.

If you want to see whether two directories contain the same file names, run the single command:

cmp <(ls /dir1) <(ls /dir2)

The compare program cmp will see the names of two files which it will read and compare.

Command substitution also makes the tee command (used to view and save the output of a command) much more useful in that you can cause a single stream of input to be read by multiple readers without resorting to temporary files—bash does all the work for you. The command:

ls | tee >(grep foo | wc >foo.count) \
         >(grep bar | wc >bar.count) \
         | grep baz | wc >baz.count

counts the number of occurrences of foo, bar and baz in the output of ls and writes this information to three separate files. Command substitutions can even be nested:

cat <(cat <(cat <(ls -l))))
works as a very roundabout way to list the current directory.

As you can see, while the unnamed pipes allow simple commands to be strung together, named pipes, with a little help from bash, allow whole trees of pipes to be created. The possibilities are limited only by your imagination.

Andy Vaught is currently a PhD candidate in computational physics at Arizona State University and has been running Linux since 1.1. He enjoys flying with the Civil Air Patrol as well as skiing. He can be reached at andy@maxwell.la.asu.edu.

__________________________


Special Magazine Offer -- Free Gift with Subscription
Receive a free digital copy of Linux Journal's System Administration Special Edition as well as instant online access to current and past issues. CLICK HERE for offer

Linux Journal: delivering readers the advice and inspiration they need to get the most out of their Linux systems since 1994.

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
phuongjolly's picture

i need be help

On October 24th, 2009 phuongjolly (not verified) says:

Hi Andy Vaught!
I am Phuongjolly
I have a problem:
i created two file: the first's use for read data, the second file is use for display data
readfile.sh
#!/bin/sh
a=1
b=1

exit 0

displayfile.sh
#!bin/sh
c=`expr $a + $b`
echo "Sum is $c"
exit 0

then:
bash$: /bin/bash ./readfile.sh | /bin/bash ./displayfile.sh
and have an error, but i don't know what's error
Can you help me, please! Thanks

Chris Bruner's picture

Also works with cygwin

On April 14th, 2008 Chris Bruner (not verified) says:

If you have cygwin installed, you can try out this article. Works great.

A slight typo in the first example

mkfifo pipe

The simplest way to show how named pipes work is with an example. Suppose we've created pipe as shown above. In one virtual console1, type:

ls -l > pipe1

and in another type:

cat < pipe

the ls -l > pipe1 should be ls -l > pipe

Anonymous's picture

named pipes

On October 31st, 2007 Anonymous (not verified) says:

Linux code for a client/server program using named pipes to sare some data between clients through a server

kanchan's picture

named pipes

On September 10th, 2007 kanchan (not verified) says:

How to use the named pipes for conversation between 2 processes?
Please write the program for me.

guhnoo's picture

What i do not understand is

On August 14th, 2007 guhnoo (not verified) says:

What i do not understand is the following:
When i do

mkfifo pipe pipe2; echo foo >pipe & cat pipe >pipe2 & cat < pipe2 >pipe

it sends the foo back and forth and i get a high cpu, however when I do

mkfifo pipe pipe2; echo foo >pipe & cat pipe >pipe2 & cat pipe2 >pipe

my cpu doesn't raise, so the foo isn't send back and forth. My question is:
why doesn't the latter work? does cat pipe2 >pipe differ from cat < pipe2 >pipe ?

Anonymous's picture

I was wondering the same

On October 8th, 2008 Anonymous (not verified) says:

I was wondering the same thing. Perhaps it has something to do with the order the pipes are set up (due to bash syntax and precedence)? I'm looking for an answer to this as well.

Same guy as directly above's picture

I see

On October 8th, 2008 Same guy as directly above (not verified) says:

I tried
cat pipe2 | cat > pipe1

and it worked. Then I realized that in

cat pipe2 >pipe1

The string "pipe2" is passed to cat as an argument, and therefore cat must run to open the filestream to pipe2. But cat cannot run in this case until pipe1 has something running on the other end accepting input. The thing on the other end is:

echo -n x | cat - pipe1 > pipe2

Which is blocked until something connects to pipe2. Well, the _other_ cat isn't connected to pipe2, because it hasn't been able to run, which it must do to open the filestream.

I _think_ I am on the right track here. When you go:

cat pipe1

Cat is connected to pipe2 without having to do any work, because pipe2 is coming in via stdin.

Can someone confirm that this is indeed what is happening?

Anonymous's picture

Ugh

On October 8th, 2008 Anonymous (not verified) says:

I meant:

cat < pipe2 > pipe1

at the end there. Dumb formatting.

Anonymous's picture

Hey, thanks for the article.

On May 30th, 2007 Anonymous (not verified) says:

Hey, thanks for the article. It was really helpful.

SeHe's picture

Brilliant info

On August 15th, 2007 SeHe (not verified) says:

I second all the commenters: highly informative stuff. It lead me to the following gem, after having spent 2 days looking into perl modules, C++ libraries and even rsynclib to do streaming diffs on fifos:


diff -ur <(xxd pop.sig) <(xxd pop2.sig) | kompare -o -

Cheers

Sehe's picture

But ... no sigar

On May 30th, 2008 Sehe (not verified) says:

Today I found out that it is not actually streaming (because of the non-linear nature of diff(1))

This woke me up:

sehe@sehe-desktop:~$ diff -Ewbur <(xxd /dev/dvdrw1) <(ssh koolu xxd /dev/dvdrw)
diff: memory exhausted

Anonymous's picture

Difference between mknod and mkfifo function

On February 15th, 2007 Anonymous (not verified) says:

What is the difference between mknod and mkfifo command?

Imran's picture

A good article

On September 20th, 2006 Imran (not verified) says:

Hi,
A nice article on pipes.

I have a few questions here.

1)How to flush stdio buffers associated with the pipe.
2)What happens when there is no space on the pipe to accomodate the flushed data of the stdio buffer?

Imran

vince^II's picture

as seen in bash 3

On October 27th, 2006 vince^II (not verified) says:

Have a look here:
http://en.wikipedia.org/wiki/Bash#I.2FO_redirection

# close FD6
exec 6>&-

Jim Wings's picture

Problem using named pipes in a shell script

On June 22nd, 2006 Jim Wings (not verified) says:

I am having a problem with using named pipes in a shell script (ksh or borne shell). As a test do something like this:

----------- cut --------
#!/bin/ksh
# This is shell script: "read_pipe"

mkfifo /tmp/event_pipe

while true
do
read EVENT </tmp/event_pipe
echo $EVENT >>/tmp/event.log
done
----------- cut -------------

Run the script via: "nohup read_pipe &".

Do something like: "cat /etc/passwd >/tmp/event_pipe". You will get some of the password file in the "/tmp/event.log", but not all of it. I tried various ways of doing the "read", but still get the same results. If I send data slowly (sleep 1 second between each line of data) it works. So what am I doing wrong? I tried a loop with "tail -f /tmp/event_pipe | while read EVENT", still the same result.
The purpose of "read_pipe" script when it does "real work", will be to process each "line" of data as it comes in. I don't know how fast the lines of data will come in, and I am afraid I will miss lines, based on the testing I did with "cat /etc/passwd". It almost appears I am overloading the "named pipe" and it is not blocking correctly. Anyone done something like this? Any ideas? Thanks.

E. Choroba's picture

RE: Problem using named pipes in a shell script

On June 5th, 2007 E. Choroba (not verified) says:

Try crumble your loop into two loops:


while true
do
cat /tmp/event_pipe | while read line
do echo $line >> /tmp/event.log
done
done

Or use exec 3< /tmp/event_pipe and read -u3.

Jean D. Fongang's picture

How do we keep the stream from closing?

On July 4th, 2006 Jean D. Fongang (not verified) says:

Thanx for your very infromative article. We can only find this kind of stuff on LJ.

I have been trying for sometime to keep the mysql client connected after executing a SQL script, and the words "named pipes" just poped to my mind. However, although I managed to put it to use in some scenarios, I fail to keep the stream flowing.

on the first shell I do this:
linux:/var/lib/mysql/replMySQL # mysql -u root -p1234 < pipe1
linux:/var/lib/mysql/replMySQL #

As soon as I do
linux:/var/lib/mysql/replMySQL # echo 'FLUSH TABLES WITH READ LOCK;' > pipe1

on the second shell, the mysql client sees the EOF, executes and exits.

My actual problem is to keep the mysqlclient connected after the 'FLUSH TABLES WITH READ LOCK;', so that I can do a certified backup from within a script and then release the connection and the lock. This script will be part of a solution in which I might not be able to put python or perl.

Anonymous's picture

Keeping the stream open

On July 26th, 2007 Anonymous (not verified) says:

Apparently, the stream closes when all writers have closed, so to keep the stream from closing open another writer that doesn't actually write anything. There must be better examples, but the following will work:

sleep 999999999 > pipe1 &

Anonymous's picture

This was quite helpful. I

On May 21st, 2006 Anonymous (not verified) says:

This was quite helpful. I was wondering however if there was a way to keep a process attached to a pipe permanently. When I used the above examples, the output process worked just fine for one command and then needed to be reattached. I'll keep researching and write back if I find anything on my own.

Anonymous's picture

The answer is yes. I

On May 22nd, 2006 Anonymous (not verified) says:

The answer is yes. I solved my problem with:

tail -f <name_of_pipe> | <process_to_handle_output> &

Jean D. Fongang's picture

Re: How do we keep the stream from closing?

On July 4th, 2006 Jean D. Fongang (not verified) says:

how can be the mysql client in this case? It didn't work.

Kaolin Fire's picture

Awesome, thank you!

On November 30th, 2005 Kaolin Fire (not verified) says:

I wanted to give C-Kermit a dynamic list of files to upload (using svn diff), and (as above) "named pipe" somehow popped into my head as maybe something I could use. I'd never sat down to figure them out, and _magic_!

Anonymous's picture

Re: Named Pipes YOUR CODE IS BAD

On February 29th, 2004 Anonymous says:

Your code with ls and tee is wrong. It gives:

Missing name for redirect.

Fix it.

Anonymous's picture

try using bash!!!

On February 16th, 2007 Anonymous (not verified) says:

try using bash!!!

Anonymous's picture

Re: Named Pipes

On August 1st, 2004 Anonymous says:

the code with ls and tee works for me. I suggest that you stop shouting and check that you copied it correcly when you tried it. And that you're really running bash.

Anonymous's picture

Re: Linux Apprentice: Introduction to Named Pipes

On April 4th, 2002 Anonymous says:

Thanks a lot it helped me a lot to understand named pipes

cevher's picture

Very helpful. Thanks.

On September 2nd, 2005 cevher (not verified) says:

Very helpful.
Thanks.

Anonymous's picture

Doesn't work for me ;(

On December 15th, 2007 Anonymous (not verified) says:

Doesn't work in Windows 2000 cmd shell for me. This linux stuff is for the birds.

Anonymous2's picture

Dear bird: "Cmd.exe" is not

On July 6th, 2009 Anonymous2 (not verified) says:

Dear bird: "Cmd.exe" is not Bash, as you probably know.

For using Bash under Windows please see Msys (www.mingw.org) or Cygwin (www.cygwin.com).

zzen's picture

Thanks indeed

On October 26th, 2005 zzen (not verified) says:

I needed to replace a filename parameter with command output, without taking up the stdin, but had no idea how. By some unknown magic, the phrase "named pipe" sprung to my mind. I googled for it, your article came up first, it was very clear, brief and informative - and ultimately helped me solve my problem in a few minutes. Thanks!

Post new comment

Please note that comments may not appear immediately, so there is no need to repost your comment.
The content of this field is kept private and will not be shown publicly.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <pre> <ul> <ol> <li> <dl> <dt> <dd> <i> <b>
  • Lines and paragraphs break automatically.

More information about formatting options

Newsletter

Each week Linux Journal editors will tell you what's hot in the world of Linux. You will receive late breaking news, technical tips and tricks, and links to in-depth stories featured on www.linuxjournal.com.
Sign up for our Email Newsletter

Tech Tip Videos

From the Magazine

December 2009, #188

If last month's Infrastrucuture issue was too "big" for you then try on this month's Embedded issue. Find out how to use Player for programming mobile robots, build a humidity controller for your root cellar, find out how to reduce the boot time of your embedded system, and if you're new to embedded systems find out the basics that go into one. You can also read about the Beagle Board, the Mesh Potato and a spate of other interestingly named items. And along with our regular columns don't miss our new monthly column: Economy Size Geek.







Read this issue