Bash – How to a shell script avoid the SIGPIPE that would be caused by use of closed file descriptor

bashshellshell-script

A shell script can lose its standard and other file descriptors if the other end goes away. One way this can happen is by terminating a ssh client used to launch the script:

$ ssh localhost test
^C

This launches a bash script called test over SSH and a CtrlC is used to terminate the ssh command. This does not terminate test which continues running but it does close the attached file descriptors (e.g. standard input/output/error).

If test tries to use those closed file descriptors then it will terminate with a SIGPIPE. A simple echo will suffice.

One of the things test might have is a log function that uses echo to write messages to the systemd journal and also to standard error. Something like this:

log() {
 echo "$*" | systemd-cat -t test
 echo >&2 "$*"
}

The second echo raises a SIGPIPE after the ssh session is killed (CtrlC). This can be protected against, so that execution continues without the offending echo, by putting the echo in a subshell:

( echo >&2 "$*" )

But is there a better way?

Best Answer

You could if you want ignore SIGPIPE in the script:

trap "" PIPE

Related Solutions

Shell – When to Use an Additional File Descriptor

Most commands have a single input channel (standard input, file descriptor 0) and a single output channel (standard output, file descriptor 1) or else operate on several files which they open by themselves (so you pass them a file name). (That's in addition from standard error (fd 2), which usually filters up all the way to the user.) It is however sometimes convenient to have a command that acts as a filter from several sources or to several targets. For example, here's a simple script that separates the odd-numbered lines in a file from the even-numbered ones

while IFS= read -r line; do
  printf '%s\n' "$line"
  if IFS= read -r line; then printf '%s\n' "$line" >&3; fi
done >odd.txt 3>even.txt

Now suppose you want to apply a different filter to the odd-number lines and to the even-numbered lines (but not put them back together, that would be a different problem, not feasible from the shell in general). In the shell, you can only pipe a command's standard output to another command; to pipe another file descriptor, you need to redirect it to fd 1 first.

{ while … done | odd-filter >filtered-odd.txt; } 3>&1 | even-filter >filtered-even.txt

Another, simpler use case is filtering the error output of a command.

exec M>&N redirects a file descriptor to another one for the remainder of the script (or until another such command changes the file descriptors again). There is some overlap in functionality between exec M>&N and somecommand M>&N. The exec form is more powerful in that it does not have to be nested:

exec 8<&0 9>&1
exec >output12
command1
exec <input23
command2
exec >&9
command3
exec <&8

Other examples that may be of interest:

What does “3>&1 1>&2 2>&3” do in a script? (it swaps stdout with stderr)
File descriptors & shell scripting
How big is the pipe buffer?
Bash script testing if a command has run correctly

And for even more examples:

questions tagged io-redirection
questions tagged file-descriptors
search for examples on this site in the Data Explorer (a public read-only copy of the Stack Exchange database)

_{P.S. This is a surprising question coming from the author of the most upvoted post on the site that uses redirection through fd 3!}

Related Question