dup和dup2函数

womking 2008-10-20

展开全文

dup和dup2函数（ZZ）

dup和dup2也是两个非常有用的调用，它们的作用都是用来复制一个文件的描述符。它们经常用来重定向进程的stdin、stdout和stderr。这两个函数的原形如下：

                        #include <unistd.h>5NKLinux联盟
    int dup( int oldfd );5NKLinux联盟
    int dup2( int oldfd, int targetfd )5NKLinux联盟

                        5NKLinux联盟

利用函数dup，我们可以复制一个描述符。传给该函数一个既有的描述符，它就会返回一个新的描述符，这个新的描述符是传给它的描述符的拷贝。这意味着，这两个描述符共享同一个数据结构。例如，如果我们对一个文件描述符执行lseek操作，得到的第一个文件的位置和第二个是一样的。下面是用来说明dup函数使用方法的代码片段：

                            int fd1, fd2;5NKLinux联盟
    ...5NKLinux联盟
fd2 = dup( fd1 );5NKLinux联盟

                        5NKLinux联盟

需要注意的是，我们可以在调用fork之前建立一个描述符，这与调用dup建立描述符的效果是一样的，子进程也同样会收到一个复制出来的描述符。

dup2函数跟dup函数相似，但dup2函数允许调用者规定一个有效描述符和目标描述符的id。dup2函数成功返回时，目标描述符（dup2函数的第二个参数）将变成源描述符（dup2函数的第一个参数）的复制品，换句话说，两个文件描述符现在都指向同一个文件，并且是函数第一个参数指向的文件。下面我们用一段代码加以说明：

                             int oldfd;5NKLinux联盟
    oldfd = open("app_log", (O_RDWR | O_CREATE), 0644 );5NKLinux联盟
    dup2( oldfd, 1 );5NKLinux联盟
    close( oldfd );5NKLinux联盟

                        5NKLinux联盟

    本例中，我们打开了一个新文件，称为“app_log”，并收到一个文件描述符，该描述符叫做fd1。我们调用dup2函数，参数为oldfd和1，这会导致用我们新打开的文件描述符替换掉由1代表的文件描述符（即stdout，因为标准输出文件的id为1）。任何写到stdout的东西，现在都将改为写入名为“app_log”的文件中。需要注意的是，dup2函数在复制了oldfd之后，会立即将其关闭，但不会关掉新近打开的文件描述符，因为文件描述符1现在也指向它。

    下面我们介绍一个更加深入的示例代码。回忆一下本文前面讲的命令行管道，在那里，我们将ls –1命令的标准输出作为标准输入连接到wc –l命令。接下来，我们就用一个C程序来加以说明这个过程的实现。代码如下面的示例代码3所示。

    在示例代码3中，首先在第9行代码中建立一个管道，然后将应用程序分成两个进程：一个子进程（第13–16行）和一个父进程（第20–23行）。接下来，在子进程中首先关闭stdout描述符（第13行），然后提供了ls –1命令功能，不过它不是写到stdout（第13行），而是写到我们建立的管道的输入端，这是通过dup函数来完成重定向的。在第14行，使用dup2 函数把stdout重定向到管道（pfds[1]）。之后，马上关掉管道的输入端。然后，使用execlp函数把子进程的映像替换为命令ls –1的进程映像，一旦该命令执行，它的任何输出都将发给管道的输入端。

    现在来研究一下管道的接收端。从代码中可以看出，管道的接收端是由父进程来担当的。首先关闭stdin描述符（第20行），因为我们不会从机器的键盘等标准设备文件来接收数据的输入，而是从其它程序的输出中接收数据。然后，再一次用到dup2函数（第21行），让stdin变成管道的输出端，这是通过让文件描述符0（即常规的stdin）等于pfds[0]来实现的。关闭管道的stdout端（pfds[1]），因为在这里用不到它。最后，使用 execlp函数把父进程的映像替换为命令wc -1的进程映像，命令wc -1把管道的内容作为它的输入（第23行）。

                        示例代码3：利用C实现命令的流水线操作的代码5NKLinux联盟
5NKLinux联盟
     1:       #include <stdio.h>5NKLinux联盟
     2:       #include <stdlib.h>5NKLinux联盟
     3:       #include <unistd.h>5NKLinux联盟
     4:5NKLinux联盟
     5:       int main()5NKLinux联盟
     6:       ...{5NKLinux联盟
     7:         int pfds[2];5NKLinux联盟
     8:5NKLinux联盟
     9:         if ( pipe(pfds) == 0 ) ...{5NKLinux联盟
     10:5NKLinux联盟
     11:           if ( fork() == 0 ) ...{5NKLinux联盟
     12:5NKLinux联盟
     13:             close(1);5NKLinux联盟
     14:             dup2( pfds[1], 1 );5NKLinux联盟
     15:             close( pfds[0] );5NKLinux联盟
     16:             execlp( "ls", "ls", "-1", NULL );5NKLinux联盟
     17:5NKLinux联盟
     18:           } else ...{5NKLinux联盟
     19:5NKLinux联盟
     20:             close(0);5NKLinux联盟
     21:             dup2( pfds[0], 0 );5NKLinux联盟
     22:             close( pfds[1] );5NKLinux联盟
     23:             execlp( "wc", "wc", "-l", NULL );5NKLinux联盟
     24:5NKLinux联盟
     25:           }5NKLinux联盟
     26:5NKLinux联盟
     27:         }5NKLinux联盟
     28:5NKLinux联盟
     29:         return 0;5NKLinux联盟
     30:       }5NKLinux联盟
5NKLinux联盟

                        5NKLinux联盟

     在该程序中，需要格外关注的是，我们的子进程把它的输出重定向的管道的输入，然后，父进程将它的输入重定向到管道的输出。这在实际的应用程序开发中是非常有用的一种技术。
1. 文件描述符在内核中数据结构

    在具体说dup/dup2之前，　我认为有必要先了解一下文件描述符在内核中的形态。

一个进程在此存在期间，会有一些文件被打开，从而会返回一些文件描述符，从shell

中运行一个进程，默认会有3个文件描述符存在(0、１、2), 0与进程的标准输入相关联，

１与进程的标准输出相关联，2与进程的标准错误输出相关联，一个进程当前有哪些打开

的文件描述符可以通过/proc/进程ID/fd目录查看。　下图可以清楚的说明问题：

　　进程表项
————————————————

　　　fd标志　文件指针
      _____________________
fd 0:|________|____________|------------> 文件表
fd 1:|________|____________|
fd 2:|________|____________|
fd 3:|________|____________|
     |     .......         |
     |_____________________|

                图１
　　　　　　　
文件表中包含:文件状态标志、当前文件偏移量、v节点指针，这些不是本文讨论的

重点，我们只需要知道每个打开的文件描述符(fd标志)在进程表中都有自己的文件表

项，由文件指针指向。

2. dup/dup2函数

APUE和man文档都用一句话简明的说出了这两个函数的作用：复制一个现存的文件描述符。

#include <unistd.h>

int dup(int oldfd);

int dup2(int oldfd, int newfd);

从图１来分析这个过程，当调用dup函数时，内核在进程中创建一个新的文件描述符，此

描述符是当前可用文件描述符的最小数值，这个文件描述符指向oldfd所拥有的文件表项。

　　进程表项
————————————————

　　　fd标志　文件指针
      _____________________
fd 0:|________|____________|                   ______
fd 1:|________|____________|----------------> |      |
fd 2:|________|____________|                  |文件表|
fd 3:|________|____________|----------------> |______|
     |     .......         |
     |_____________________|

                图2：调用dup后的示意图

如图2 所示，假如oldfd的值为1, 当前文件描述符的最小值为3,　那么新描述符3指向

描述符１所拥有的文件表项。

dup2和dup的区别就是可以用newfd参数指定新描述符的数值，如果newfd已经打开，则

先将其关闭。如果newfd等于oldfd，则dup2返回newfd, 而不关闭它。dup2函数返回的新

文件描述符同样与参数oldfd共享同一文件表项。

APUE用另外一个种方法说明了这个问题：

实际上，调用dup(oldfd)；

等效与
        fcntl(oldfd, F_DUPFD, 0)

而调用dup2(oldfd, newfd)；

等效与
        close(oldfd)；
        fcntl(oldfd, F_DUPFD, newfd)；

3. CGI中dup2

写过CGI程序的人都清楚，当浏览器使用post方法提交表单数据时，CGI读数据是从标准

输入stdin, 写数据是写到标准输出stdout(c语言利用printf函数)。按照我们正常的理

解，printf的输出应该在终端显示，原来CGI程序使用dup2函数将STDOUT_FINLENO(这个

宏在unitstd.h定义，为１)这个文件描述符重定向到了连接套接字。

dup2(connfd, STDOUT_FILENO)；　／*实际情况还涉及到了管道，不是本文的重点*/

如第一节所说，　一个进程默认的文件描述符１(STDOUT_FILENO)是和标准输出stdout相

关联的，对于内核而言，所有打开的文件都通过文件描述符引用，而内核并不知道流的

存在(比如stdin、stdout)，所以printf函数输出到stdout的数据最后都写到了文件描述

符１里面。至于文件描述符0、１、2与标准输入、标准输出、标准错误输出相关联，这

只是shell以及很多应用程序的惯例，而与内核无关。

用下面的流图可以说明问题:(ps: 虽然不是流图关系，但是还是有助于理解)

printf －> stdout －> STDOUT_FILENO(1) －> 终端(tty)

printf最后的输出到了终端设备，文件描述符１指向当前的终端可以这么理解：

STDOUT_FILENO = open("/dev/tty", O_RDWR);

使用dup2之后STDOUT_FILENO不再指向终端设备，　而是指向connfd, 所以printf的

输出最后写到了connfd。是不是很优美？:)

4. 如何在CGI程序的fork子进程中还原STDOUT_FILENO

如果你能看到这里，感谢你的耐心，　我知道很多人可能感觉有点复杂，　其实

复杂的问题就是一个个小问题的集合。所以弄清楚每个小问题就OK了，第三节中

说道，STDOUT_FILENO被重定向到了connfd套接字，　有时候我们可能想在CGI程序

中调用后台脚本执行，而这些脚本中难免会有一些输入输出，　我们知道fork之后，

子进程继承了父进程的所有文件描述符，所以这些脚本的输入输出并不会如我们愿

输出到终端设备，而是和connfd想关联了，这个显然会扰乱网页的输出。那么如何

恢复STDOUT_FILENO和终端关联呢？

方法１：在dup2之前保存原有的文件描述符，然后恢复。

代码实现如下：

savefd = dup(STDOUT_FILENO);　／*savefd此时指向终端*/

dup2(connfd, STDOUT_FILENO);   /*STDOUT_FILENO(1) 被重新指向connfd*/

..... /*处理一些事情*/

dup2(savefd, STDOUT_FILENO); /*STDOUT_FILENO(1)　恢复指向savefd*/

很遗憾CGI程序无法使用这种方法，　因为dup2这些不是在CGI程序中完成的，而是在

web server中实现的，修改web server并不是个好主意。

方法2: 追本溯源，打开当前终端恢复STDOUT_FILENO。

分析第三节的流图，　STDOUT_FILENO是如何和终端关联的？　我们重头做一遍不就行

了，　代码实现如下：

ttyfd = open("/dev/tty", O_RDWR);

dup2(ttyfd, STDOUT_FILENO);

close(ttyfd);

/dev/tty是程序运行所在的终端，　这个应该通过一种方法获得。实践证明这种方法

是可行的，但是我总感觉有些不妥，不知道为什么，可能一些潜在的问题还没出现。

目前我就想到这两种方法，　不知道你有什么好的想法？　有的话希望告诉我:)