linux高级I/O函数splice与tee

雨点打透心脏的1/2处 2022-06-12 23:13 538阅读 0赞

### **splice()** ###

> splice函数是linux系统提供的高级I/O函数，同sendfile系统调用函数一样，也是零拷贝操作函数。splice函数用于在两个文件描述符之间的**移动数据**。

### **函数原型:** ###

#include <fcntl.h> 
    ssize_t splice(int fd_in, loff_t *off_in, int fd_out, loff_t* off_out, size_t len, unsigned int flags);

--------------------

### **函数参数:** ###

*  fd\_in参数是待输入描述符。如果它是一个管道文件描述符，则off\_in必须设置为NULL；如果off\_in不是一个管道文件描述符（比如socket），那么off\_in表示从输入数据流的何处开始读取数据，此时若为NULL，则从输入数据流的当前偏移位置读入。
 *  fd\_out/off\_out参数的含义与fd\_in/off\_in相同，不过用于输出数据流。
 *  len参数指定移动数据的长度。
 *  flags参数则控制数据如何移动，它可以设置成下表中的某些值的按位或。

splice的flags参数的常用值及其含义：

<table> 
 <thead> 
  <tr> 
   <th>常用值</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SPLICE_F_MOVE</td> 
   <td>如果合适的话，按整页内存移动数据。这只是给内核的一个提示。不过，因为它的实现存在BUG，所以自内核2.6.21后，它实际上没有任何效果</td> 
  </tr> 
  <tr> 
   <td>SPLICE_F_NONBLOCK</td> 
   <td>非阻塞的splice操作，但实际效果还会受文件描述符本身的阻塞状态影响</td> 
  </tr> 
  <tr> 
   <td>SPLICE_F_MORE</td> 
   <td>告知操作系统内核下一个 splice 系统调用将会有更多的数据传来</td> 
  </tr> 
  <tr> 
   <td>SPLICE_F_GIFT</td> 
   <td>对splice没有效果</td> 
  </tr> 
 </tbody> 
</table>

**注意：使用splice函数时，fd\_in和fd\_out必须至少有一个是管道文件描述符。**

--------------------

### **函数返回值：** ###

调用成功时返回移动的字节数量。它可能返回0，表示没有数据需要移动，这通常发生在从管道中读数据（fd\_in是管道文件描述符）而该管道没有被写入任何数据时。  
失败时返回-1，并设置errno。常见的errno如下表所示。

splice函数可能产生的errno及其含义：

<table> 
 <thead> 
  <tr> 
   <th>错误</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>EBADF</td> 
   <td>参数所指文件描述符有错</td> 
  </tr> 
  <tr> 
   <td>EINVAL</td> 
   <td>目标文件系统不支持splice，或者目标文件以追加方式打开，或者两个文件描述符都不是管道文件描述符，或者某个offset参数被用于不支持随机访问的设备（比如字符设备）</td> 
  </tr> 
  <tr> 
   <td>ENOMEM</td> 
   <td>内存不够</td> 
  </tr> 
  <tr> 
   <td>ESPIPE</td> 
   <td>参数fd_in（或fd_out）是管道文件描述符，而off_in（或off_out）不为NULL</td> 
  </tr> 
 </tbody> 
</table>

--------------------

### **使用splice函数实现简单的回射服务器：** ###

我们通过使用splice函数，实现一个简单的echo服务器。

//使用splice实现的回显服务器 
    #include <stdio.h> 
    #include <stdlib.h> 
    #include <unistd.h> 
    #include <sys/socket.h> 
    #include <netinet/in.h> 
    #include <arpa/inet.h> 
    #include <assert.h> 
    #include <errno.h> 
    #include <string.h> 
    #include <fcntl.h> 
    
    
    int main(int argc, char **argv)  
    {  
    
        if (argc <= 2) {  
            printf("usage: %s ip port\n", basename(argv[0]));  
            return 1;  
        }  
    
        const char *ip = argv[1];  
        int port = atoi(argv[2]);  
    
        struct sockaddr_in address;  
        bzero(&address, sizeof(address));  
        address.sin_family = AF_INET;  
        address.sin_port = htons(port);  
        inet_pton(AF_INET, ip, &address.sin_addr);  
    
        int sock = socket(PF_INET, SOCK_STREAM, 0);  
        assert(sock >= 0);  
    
        int reuse = 1;  
        setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &reuse, sizeof(reuse));  
    
        int ret = bind(sock, (struct sockaddr*)&address, sizeof(address));  
        assert(ret != -1);  
    
        ret = listen(sock, 5);  
        assert(ret != -1);  
    
        struct sockaddr_in client;  
        socklen_t client_addrlength = sizeof(client);  
    
        int connfd = accept(sock, (struct sockaddr*)&client, &client_addrlength);  
        if (connfd < 0) {  
            printf("errno is: %s\n", strerror(errno));  
        }  
        else {  
            int pipefd[2];  
    
            ret = pipe(pipefd);  //创建管道 
            assert(ret != -1);  
    
            //将connfd上流入的客户端数据定向到管道中 
            ret = splice(connfd, NULL, pipefd[1], NULL,  
                            32768, SPLICE_F_MORE | SPLICE_F_MOVE);  
            assert(ret != -1);  
    
            //将管道的输出定向到connfd连接文件符上 
            ret = splice(pipefd[0], NULL, connfd, NULL,  
                            32768, SPLICE_F_MORE | SPLICE_F_MOVE);  
            assert(ret != -1);                
    
            close(connfd);  
        }  
    
        close(sock);  
    
        return 0;  
    }

--------------------

### **tee()** ###

> tee函数在两个管道文件描述符之间复制数据，也是零拷贝操作。与splice函数不同，它不消耗数据，因此源文件描述符上的数据仍然可以用于后续的读操作。

### **函数原型：** ###

#include<fcntl.h>
    ssize_t tee(int fd_in, int fd_out, size_t len,unsigned int flags);

--------------------

### **函数参数：** ###

该函数的参数含义与splice相同（但fd\_in和fd\_out必须都是管道文件描述符）。

--------------------

### **函数返回值：** ###

tee函数成功时返回在两个文件描述符之间复制的数据数量（字节数）。返回0表示没有复制任何数据。tee失败时返回-1并设置errno。