Practical use for moving file descriptors

Quentin

According to the bash man page:

The redirection operator

   [n]<&digit-

moves the file descriptor digit to file descriptor n, or the standard input (file descriptor 0) if n is not specified. digit is closed after being dupli‐cated to n.

What does it mean to "move" a file descriptor to another one? What are the typical situations for such practice?

Stéphane Chazelas

3>&4- is a ksh93 extension also supported by bash and that is short for 3>&4 4>&-, that is 3 now points to where 4 used to, and 4 is now closed, so what was pointed to by 4 has now moved to 3.

Typical usage would be in cases where you've duplicated stdin or stdout to save a copy of it and want to restore it, like in:

Suppose you want to capture the stderr of a command (and stderr only) while leaving stdout alone in a variable.

Command substitution var=$(cmd), creates a pipe. The writing end of the pipe becomes cmd's stdout (file descriptor 1) and the other end is read by the shell to fill up the variable.

Now, if you want stderr to go to the variable, you could do: var=$(cmd 2>&1). Now both fd 1 (stdout) and 2 (stderr) go to the pipe (and eventually to the variable), which is only half of what we want.

If we do var=$(cmd 2>&1-) (short for var=$(cmd 2>&1 >&-), now only cmd's stderr goes to the pipe, but fd 1 is closed. If cmd tries to write any output, that would return with a EBADF error, if it opens a file, it will get the first free fd and the open file will be assigned it to stdout unless the command guards against that! Not what we want either.

If we want the stdout of cmd to be left alone, that is to point to the same resource that it pointed to outside the command substitution, then we need somehow to bring that resource inside the command substitution. For that we can do a copy of stdout outside the command substitution to take it inside.

{
  var=$(cmd)
} 3>&1

Which is a cleaner way to write:

exec 3>&1
var=$(cmd)
exec 3>&-

(which also has the benefit of restoring fd 3 instead of closing it in the end).

Then upon the { (or the exec 3>&1) and up to the }, both fd 1 and 3 point to the same resource fd 1 pointed to initially. fd 3 will also point to that resource inside the command substitution (command substitution only redirects the fd 1, stdout). So above, for cmd, we've got for fds 1, 2, 3:

  1. the pipe to var
  2. untouched
  3. same as what 1 points to outside the command substitution

If we change it to:

{
  var=$(cmd 2>&1 >&3)
} 3>&1-

Then it becomes:

  1. same as what 1 points to outside the command substitution
  2. the pipe to var
  3. same as what 1 points to outside the command substitution

Now, we've got what we wanted: stderr goes to the pipe and stdout is left untouched. However, we're leaking that fd 3 to cmd.

While commands (by convention) assume fds 0 to 2 to be open and be standard input, output and error, they don't assume anything of other fds. Most likely they will leave that fd 3 untouched. If they need another file descriptor, they'll just do an open()/dup()/socket()... which will return the first available file descriptor. If (like a shell script that does exec 3>&1) they need to use that fd specifically, they will first assign it to something (and in that process, the resource held by our fd 3 will be released by that process).

It's good practice to close that fd 3 since cmd doesn't make use of it, but it's no big deal if we leave it assigned before we call cmd. The problems may be: that cmd (and potentially other processes that it spawns) has one fewer fd available to it. A potentially more serious problem is if the resource that that fd points to may end up held by a process spawned by that cmd in background. It can be a concern if that resource is a pipe or other inter-process communication channel (like when your script is being run as script_output=$(your-script)), as that will mean the process reading from the other end will never see end-of-file until that background process terminates.

So here, it's better to write:

{
  var=$(cmd 2>&1 >&3 3>&-)
} 3>&1

Which, with bash can be shorten to:

{
  var=$(cmd 2>&1 >&3-)
} 3>&1

To sum up the reasons why it's rarely used:

  1. it's non-standard and just syntactic sugar. You've got to balance saving a few keystrokes with making your script less portable and less obvious to people not used to that uncommon feature.
  2. The need to close the original fd after duplicating it is often overlooked because most of the time, we don't suffer from the consequence, so we just do >&3 instead of >&3- or >&3 3>&-.

Proof that it's rarely used, as you found out is that it is bogus in bash. In bash compound-command 3>&4- or any-builtin 3>&4- leaves fd 4 closed even after compound-command or any-builtin has returned. A patch to fix the issue is now (2013-02-19) available.

Collected from the Internet

Please contact [email protected] to delete if infringement.

edited at
0

Comments

0 comments
Login to comment

Related

From Dev

Moving file descriptors in zsh

From Dev

How to use flock and file descriptors to lock a file and write to the locked file?

From Dev

are there generally available programs that use file descriptors more than 2?

From Dev

bash - use exec for file descriptors using environment variables

From Dev

When should I use file descriptors in bash scripting?

From Dev

File descriptors before fork()

From Dev

Redirecting file descriptors

From Dev

Python not closing file descriptors

From Dev

Reading file descriptors

From Dev

select is not saving file descriptors

From Dev

closing the unwanted file descriptors

From Dev

What are these file descriptors for?

From Dev

What and Why? - File Descriptors

From Dev

Special file descriptors

From Dev

Duplication of file descriptors in redirection

From Dev

File descriptors across exec

From Dev

File descriptors and redirect in bash

From Dev

File descriptors & shell scripting

From Dev

Reading file descriptors

From Dev

Leaking file descriptors

From Dev

Sharing file descriptors

From Dev

What are these auxiliary file descriptors?

From Dev

Debian max file descriptors

From Dev

File Descriptors and Redirection

From Dev

Reason to use File Descriptors Linked to stdin Rather than use stdin Directly?

From Dev

File Descriptors and File Handles (and C)

From Dev

File Descriptors and File Handles (and C)

From Dev

Understanding File Streams and File Descriptors

From Dev

can you use Swift ARC for prompt deallocation of scarce resources (file descriptors, network sockets)?