記一次傳遞文件句柄引起的血案

apue 上講 Solaris 系統是能夠在進程間經過 STREAMS 管道傳遞文件句柄的。

 

 

書上講道：「在技術上，發送進程實際上向接收進程傳送一個指向一打開文件表項的指針，該指針被分配存放在接收進程的第一個可用描述符項中。」

 

我的很是感興趣，就寫下了下面的兩個程序來驗證 STREAMS 管道是否支持發送接收文件描述符，且發送方與接收方的描述符是否可能不相同。

spipe_server.c

  1 #define MAXLINE 128
  2 
  3 int get_temp_fd ()
  4 {
  5     char fname[128] = "/tmp/outXXXXXX"; 
  6     int fd = mkstemp (fname); 
  7     printf ("create temp file %s with fd %d\n", fname, fd); 
  8     return fd; 
  9 }
 10 
 11 int main (int argc, char *argv[])
 12 {
 13     if (argc < 2) { 
 14         printf ("usage: spipe_server <spipe_client>\n"); 
 15         return 0; 
 16     }
 17 
 18     int n;
 19     int fd[2], fd_to_send, fd_to_recv; 
 20     if (pipe (fd) < 0) {
 21         printf ("pipe error\n"); 
 22         return 0; 
 23     }
 24     printf ("create pipe %d.%d\n", fd[0], fd[1]); 
 25 
 26     char line[MAXLINE]; 
 27     pid_t pid = fork (); 
 28     if (pid < 0) {
 29         printf ("fork error\n"); 
 30         return 0; 
 31     }
 32     else if (pid > 0)
 33     {
 34         close (fd[1]); 
 35         while (fgets (line, MAXLINE, stdin) != NULL) { 
 36             n = strlen (line); 
 37             // create temp file and write requet into it !
 38             fd_to_send = get_temp_fd (); 
 39             if (fd_to_send < 0) {
 40                 printf ("get temp fd failed\n"); 
 41                 return 0; 
 42             }
 43             
 44             if (write (fd_to_send, line, n) != n){
 45                 printf ("write error to file\n"); 
 46                 return 0; 
 47             }
 48 
 49             if (ioctl (fd[0], I_SENDFD, fd_to_send) < 0) {
 50                 printf ("send fd to peer failed, error %d\n", errno); 
 51                 return -1; 
 52             }
 53             else 
 54                 printf ("send fd %d to peer\n", fd_to_send); 
 55 
 56             // after send, fd_to_send is close automatically 
 57             struct strrecvfd recvfd;
 58             if (ioctl (fd[0], I_RECVFD, &recvfd) < 0) {
 59                 printf ("recv fd from peer failed, error %d\n", errno); 
 60                 return -1; 
 61             }
 62             else 
 63             {
 64                 fd_to_recv = recvfd.fd; 
 65                 printf ("recv fd %d from peer\n", fd_to_recv);   
 66             }
 67 
 68             // read response by receving the new fd!
 69             if ((n = read (fd_to_recv, line, MAXLINE)) < 0) {
 70                 printf ("read error from file\n"); 
 71                 return 0; 
 72             }
 73 
 74             close (fd_to_recv); 
 75             if (n == 0) { 
 76                 printf ("child closed pipe\n"); 
 77                 break;
 78             }
 79 
 80             line[n] = 0; 
 81             if (fputs (line, stdout) == EOF) {
 82                 printf ("fputs error\n"); 
 83                 return 0; 
 84             }
 85         }
 86 
 87         if (ferror (stdin)) {
 88             printf ("fputs error\n"); 
 89             return 0; 
 90         }
 91 
 92         return 0; 
 93     }
 94     else { 
 95         close (fd[0]); 
 96         if (fd[1] != STDIN_FILENO) { 
 97             if (dup2 (fd[1], STDIN_FILENO) != STDIN_FILENO) {
 98                 printf ("dup2 error to stdin\n"); 
 99                 return 0; 
100             }
101             //close (fd[0]); 
102         }
103 
104         if (fd[1] != STDOUT_FILENO) { 
105             if (dup2 (fd[1], STDOUT_FILENO) != STDOUT_FILENO) {
106                 printf ("dup2 error to stdout\n"); 
107                 return 0; 
108             }
109             close (fd[1]); 
110         }
111 
112         if (execl (argv[1], argv[1], (char *)0) < 0) {
113             printf ("execl error\n"); 
114             return 0; 
115         }
116     }
117 
118     return 0; 
119 }

server端打開一個 STREAMS 管道（經過pipe），此管道將做爲傳遞文件描述符的通道。

它關閉管道的另外一端，而後在fork出的子進程中將另外一端重定向到子進程的標準輸入、輸出。

以後不斷從console讀入用戶輸入的兩個整數，建立一個臨時文件（get_temp_fd)並將用戶輸入寫入文件，

以後經過管道將此臨時文件傳遞給子進程，而後在管道上等待子進程返回的另外一個臨時文件句柄，

該句柄中包含了兩數相加的結果，將其讀出並展現給console用戶。

 

spipe_client.c

 1 #define MAXLINE 128
 2 
 3 int get_temp_fd ()
 4 {
 5     char fname[128] = "/tmp/inXXXXXX";
 6     int fd = mkstemp (fname);
 7     fprintf (stderr, "create temp file %s with fd %d\n", fname, fd);
 8     return fd;
 9 }
10 
11 int main (void)
12 {
13     int ret, fdin, fdout, n, int1, int2; 
14     char line[MAXLINE]; 
15 
16     struct strrecvfd recvfd;
17     if (ioctl (STDIN_FILENO, I_RECVFD, &recvfd) < 0) {
18         fprintf (stderr, "recv fd from peer failed, error %d\n", errno); 
19         return -1; 
20     }
21 
22     fdin = recvfd.fd; 
23     fprintf (stderr, "recv fd %d, position %u\n", fdin, tell(fdin)); 
24     fdout = get_temp_fd (); 
25     if (fdout < 0) { 
26         fprintf (stderr, "get temp fd failed\n"); 
27         return -1; 
28     }
29 
30     n = read (fdin, line, MAXLINE);
31     if (n > 0) {
32         line[n] = 0; 
33         fprintf (stderr, "source: %s\n", line); 
34         if (sscanf (line, "%d%d", &int1, &int2) == 2) { 
35             sprintf (line, "%d\n", int1 + int2); 
36             n = strlen (line); 
37             if (write (fdout, line, n) != n) {
38                 fprintf (stderr, "write error\n"); 
39                 return 0; 
40             }
41         }
42         else { 
43             if (write (fdout, "invalid args\n", 13) != 13) {
44                 fprintf (stderr, "write msg error\n"); 
45                 return 0; 
46             }
47         }
48 
49         if (lseek (fdout, 0, SEEK_SET) < 0)
50             fprintf (stderr, "seek to begin failed\n"); 
51         else 
52             fprintf (stderr, "seek to head\n"); 
53 
54         if (ioctl (STDOUT_FILENO, I_SENDFD, fdout) < 0) {
55             fprintf (stderr, "send fd to peer failed, error %d\n", errno); 
56             return -1; 
57         }
58 
59         // fdout will be automatically closed by send_fd
60         fprintf (stderr, "send fd %d\n", fdout); 
61     }
62 
63     close (fdin); 
64     return 0; 

 

client 做爲子進程由於已經被父進程重定向了標準輸入、標準輸出，就簡單多了，

從標準輸入接收一個文件描述符做爲輸入，讀取內容並解析後計算相加結果，

再取另外一個臨時文件（get_temp_fd）用來保存結果，並將該文件描述符回傳給父進程。

 

簡單的修改了下 Makefile 文件、編譯、運行，結果卻不是很理想：

-bash-3.2$ ./spipe_server ./spipe_client
create pipe 3.4
2 5
create temp file /tmp/outo3a4Il with fd 4
send fd 4 to peer
recv fd 3
create temp file /tmp/ino3aaJl with fd 4
recv fd from peer failed, error 2

 

能夠看到 server 到 client 的文件句柄傳遞成功了，在 server 端句柄號爲 4，傳遞到 client 端後變爲 3.

可是在 server 端等待接收文件句柄時卻發生了錯誤，這是怎麼回事?

查了一下錯誤碼 2，爲ENOENT，沒有對應的文件或目錄。

這就奇怪了，讀取管道返回這個錯誤的惟一緣由只能是管道被關閉，難道子進程已經不在了麼？

爲此，在 client 最後添加一句日誌輸出：

    if (n > 0)
         ....
    else
        fprintf (stderr, "no more data\n"); 

再運行 demo，果真發現多了一句：

no more data

 

看來確實是由於子進程退出致使管道關閉了。

那爲何子進程什麼數據也沒有從臨時文件句柄中讀到呢?

一開始懷疑是數據寫入後，沒有 flush 到磁盤，從而致使另外一端沒有讀到，因而在寫入數據以後、發送句柄以前，加了如下代碼：

            if (fsync (fd_to_send) < 0)
                printf ("sync file failed\n"); 
            else 
                printf ("sync data to file\n");

再運行 demo，果真發現多了一句：

sync data to file

 

數據同步成功了。可是結果仍是同樣，沒有改善。

走到這邊真的是有點想不通了，琢磨了一宿，晚上忽然想到會不會是文件偏移沒有歸位致使的。

次日回來，立馬在接收端打印了一下文件偏移 (offset)：

fprintf (stderr, "recv fd %d, position %u\n", fdin, tell(fdin)); 

 

 再運行 demo，輸出的偏移果真有問題！

recv fd 3, position 4

 

這下緣由清楚了，原來是接收進程與發送進程共享了文件句柄的偏移，致使再讀取的過程當中直接讀到了文件尾。

修改代碼，在發送文件句柄以前重置文件偏移：

            if (lseek (fd_to_send, 0, SEEK_SET) < 0)
                printf ("seek to begin failed\n");  
            else
                printf ("seek to head\n");

同理，在 client 端作相同的修改。編譯、運行，這下好了：

-bash-3.2$ ./spipe_server ./spipe_client
create pipe 3.4
2 8
create temp file /tmp/outGGaiLl with fd 4
seek to head
send fd 4 to peer
recv fd 3, position 0
create temp file /tmp/inHGaqLl with fd 4
source: 2 8

seek to head
send fd 4
recv fd 5 from peer, position 0
10

 

能夠正確的獲得計算結果。

這一圈下來能夠更好的體會一下傳遞文件句柄與傳遞文件名再打開文件效果的區別，

前者共享了以前進程的文件句柄相關的信息（例如文件偏移量），也是個人代碼出問題的緣由。

 

從寫這個小 demo 的過程當中，我理解到書本知識到可運行的代碼之間，仍是有不少細節須要處理的，

有時看書就感受本身會了，但到了實踐就可能會遇到這樣那樣的問題（這些問題甚至和你要測試的東西無關），

動手解決問題的過程其實也加深了對書本知識的瞭解，正所謂：」紙上得來終覺淺，絕知此事要躬行「，

以此小文與各位共勉！