通過UNIX域套接字傳遞描述符和 sendmsg/recvmsg 函數
在前面我們介紹了UNIX域套接字編程,更重要的一點是UNIX域套接字可以在同一台主機上各進程之間傳遞文件描述符。
下面先來看兩個函數:
#include <sys/types.h>
#include <sys/socket.h>
ssize_t sendmsg(int sockfd, const struct msghdr *msg, int flags);
ssize_t recvmsg(int sockfd, struct msghdr *msg, int flags);
它們與sendto 和 recvfrom 函數相似,只不過可以傳輸 更復雜的數據結構,不僅可以傳輸一般數據,還可以傳輸額外的數據,即文件描述符。下面來看結構體msghdr :
struct msghdr {
void *msg_name; /* optional address */
socklen_t msg_namelen; /* size of address */
struct iovec *msg_iov; /* scatter/gather array */
size_t msg_iovlen; /* # elements in msg_iov */
void *msg_control; /* ancillary data, see below */
size_t msg_controllen; /* ancillary data buffer len */
int msg_flags; /* flags on received message */
};
如下圖所示:
1、msg_name : 即對等方的地址指針,不關心時設為NULL即可;
2、msg_namelen:地址長度,不關心時設置為0即可;
3、 msg_iov:是結構體iovec 的指針。
struct iovec {
void *iov_base; /* Starting address */
size_t iov_len; /* Number of bytes to transfer */
};
成員iov_base 可以認為是傳輸正常數據時的buf,iov_len 是buf 的大小。
4、msg_iovlen:當有n個 iovec 結構體時,此值為n;
5、msg_control:是一個指向cmsghdr 結構體的指針
struct cmsghdr {
socklen_t cmsg_len; /* data byte count, including header */
int cmsg_level; /* originating protocol */
int cmsg_type; /* protocol- specific type */
/* followed by unsigned char cmsg_data[]; */
};
6、msg_controllen :參見下圖,即cmsghdr 結構體可能不止一個;
7、flags : 一般設置為0即可;
為了對齊,可能存在一些填充字節,跟每個系統的實現有關,但我們不必關心,可以通過一些函數宏來獲取相關的值, 如下:
#include <sys/socket.h>
struct cmsghdr *CMSG_FIRSTHDR(struct msghdr *msgh);
struct cmsghdr *CMSG_NXTHDR(struct msghdr *msgh, struct cmsghdr *cmsg);
size_t CMSG_ALIGN(size_t length);
size_t CMSG_SPACE (size_t length);
size_t CMSG_LEN(size_t length);
unsigned char *CMSG_DATA(struct cmsghdr *cmsg);
下面通過封裝兩個函數,send_fd 和 recv_fd 來進一步認識這些函數宏 的作用:
void send_fd(int sock_fd, int send_fd) { int ret; struct msghdr msg; struct cmsghdr *p_cmsg; struct iovec vec; char cmsgbuf[CMSG_SPACE(sizeof(send_fd))]; int *p_fds; char sendchar = 0; msg.msg_control = cmsgbuf; msg.msg_controllen = sizeof(cmsgbuf); p_cmsg = CMSG_FIRSTHDR(&msg); p_cmsg->cmsg_level = SOL_SOCKET; p_cmsg->cmsg_type = SCM_RIGHTS; p_cmsg->cmsg_len = CMSG_LEN(sizeof(send_fd)); p_fds = (int *)CMSG_DATA(p_cmsg); *p_fds = send_fd; // 通過傳遞輔助數據的方式傳遞文件描述符 msg.msg_name = NULL; msg.msg_namelen = 0; msg.msg_iov = &vec; msg.msg_iovlen = 1; //主要目的不是傳遞數據,故只傳1個字符 msg.msg_flags = 0; vec.iov_base = &sendchar; vec.iov_len = sizeof(sendchar); ret = sendmsg(sock_fd, &msg, 0); if (ret != 1) ERR_EXIT("sendmsg"); } int recv_fd(const int sock_fd) { int ret; struct msghdr msg; char recvchar; struct iovec vec; int recv_fd; char cmsgbuf[CMSG_SPACE(sizeof(recv_fd))]; struct cmsghdr *p_cmsg; int *p_fd; vec.iov_base = &recvchar; vec.iov_len = sizeof(recvchar); msg.msg_name = NULL; msg.msg_namelen = 0; msg.msg_iov = &vec; msg.msg_iovlen = 1; msg.msg_control = cmsgbuf; msg.msg_controllen = sizeof(cmsgbuf); msg.msg_flags = 0; p_fd = (int *)CMSG_DATA(CMSG_FIRSTHDR(&msg)); *p_fd = -1; ret = recvmsg(sock_fd, &msg, 0); if (ret != 1) ERR_EXIT("recvmsg"); p_cmsg = CMSG_FIRSTHDR(&msg); if (p_cmsg == NULL) ERR_EXIT("no passed fd"); p_fd = (int *)CMSG_DATA(p_cmsg); recv_fd = *p_fd; if (recv_fd == -1) ERR_EXIT("no passed fd"); return recv_fd; }
來解釋一下send_fd 函數:
msg.msg_name = NULL;
msg.msg_namelen = 0;
msg.msg_iov = &vec;
msg.msg_iovlen = 1; //主要目的不是傳遞數據,故只傳1個字符
msg.msg_flags = 0;
vec.iov_base = &sendchar;
vec.iov_len = sizeof(sendchar);
這幾行中需要注意的是我們現在的目的不是傳輸正常數據,而是為了傳遞文件描述符,所以只定 義一個1字節的char,其余參照前面對參數的解釋可以理解。
現在我們只有一個cmsghdr 結構體,把需要傳遞的文件 描述符send_fd 長度,也就是需要傳輸的額外數據大小,當作參數傳給CMSG_SPACE 宏,可以得到整個結構體的大小,包括 一些填充字節,如上圖所示,也即
char cmsgbuf[CMSG_SPACE(sizeof(send_fd))];
也就可以進一步得出以 下兩行:
msg.msg_control = cmsgbuf;
msg.msg_controllen = sizeof(cmsgbuf);
接著,需要填充 cmsghdr 結構體,傳入msghdr 指針,CMSG_FIRSTHDR宏可以得到首個cmsghdr 結構體的指針,即
p_cmsg = CMSG_FIRSTHDR(&msg);
然後使用指針來填充各字段,如下:
p_cmsg->cmsg_level = SOL_SOCKET;
p_cmsg->cmsg_type = SCM_RIGHTS;
p_cmsg->cmsg_len = CMSG_LEN(sizeof(send_fd));
傳入send_fd 的大小,CMSG_LEN宏可以得到cmsg_len 字段的大小。
最後,傳 入結構體指針 p_cmsg ,宏CMSG_DATA 可以得到准備存放send_fd 的位置指針,將send_fd 放進去,如下:
p_fds = (int*)CMSG_DATA(p_cmsg);
*p_fds = send_fd; // 通過傳遞輔助數據的方式傳遞文件描 述符
recv_fd 函數就類似了,不再贅述。
可以寫個小程序測試一下:
/************************************************************************* > File Name: uxdomsock_sendfd.c > Author: Simba > Mail: [email protected] > Created Time: Mon 04 Mar 2013 02:01:33 PM CST ************************************************************************/ #include <unistd.h> #include <sys/types.h> #include <sys/socket.h> #include <sys/un.h> #include <stdlib.h> #include <stdio.h> #include <errno.h> #include <string.h> #include <fcntl.h> #define ERR_EXIT(m) \ do \ { \ perror(m); \ exit(EXIT_FAILURE); \ } while(0) int main(void) { int sockfds[2]; /* 只有unix域協議才能在進程間傳遞文件描述符,如果想要在沒有親緣關系的進程間 * 傳遞,則不能用socketpair函數,要用socket()函數 */ if (socketpair(PF_UNIX, SOCK_STREAM, 0, sockfds) < 0) ERR_EXIT("socketpair"); pid_t pid; pid = fork(); if (pid == -1) ERR_EXIT("fork"); /* 如果是父進程打開的文件描述符,子進程可以共享 * 這裡演示的是子進程打開的文件描述符通過封裝的函數傳給父進程 */ if (pid > 0) { close(sockfds[1]); int fd = recv_fd(sockfds[0]); char buf[1024] = {0}; read(fd, buf, sizeof(buf)); printf("buf=%s\n", buf); } else if (pid == 0) { close(sockfds[0]); int fd; fd = open("test.txt", O_RDONLY); if (fd == -1); send_fd(sockfds[1], fd); } return 0; }
我們知道,父進程在fork 之前打開的文件描述符,子進程是可以共享的,但是子進程打開的文件描述符,父進程是不能 共享的,上述程序就是舉例在子進程中打開了一個文件描述符,然後通過send_fd 函數將文件描述符傳遞給父進程,父進程 可以通過recv_fd 函數接收到這個文件描述符。先建立一個文件test.txt 後輸入幾個字符,然後運行程序,輸出如下:
simba@ubuntu:~/Documents/code/linux_programming/UNP/socket$ ./uxdomsock_sendfd
buf=ilove
證 明父進程確實可以打開test.txt 文件。
最後提醒一點,只有unix域協議才能在本機進程間傳遞文件描述符,如果想 要在沒有親緣關系的進程間傳遞,則不能用socketpair函數,要用socket()函數 才行。