函數定義和頭文件
#include <sys/eventfd.h>
int eventfd(unsigned int initval, int flags);
簡述
eventfd()函數會創建一個“eventfd”對象,用戶空間的應用程序可以用這個eventfd來實現事件的等待或通知機制,也可以用于內核通知新的事件到用戶空間應用程序。 這個對象包含一個64-bit的整形計數器,內核空間維護這個計數器,創建這個計數器的時候使用第一個入參initval來初始化計數器。
函數的第二個參數通過bit mask標識,可以有以下標志位
- EFD_CLOEXEC
- EFD_NONBLOCK
- EFD_SEMAPHORE: 提供類似于信號量的機制
eventfd函數返回一個新的文件描述符(fd),指向新創建的eventfd對象,可以對這個描述符進行如下操作
- 文件描述符的read(2)操作
每次成功的操作都返回一個8字節的整數
- 如果沒有設置EFD_SEMAPHORE,并且eventfd計數器非0,返回計數器的值(8字節),eventfd置為0
- 如果設置了EFD_SEMAPHORE,并且eventfd計數器非0,返回值為1(8字節),計數器的值遞減1
- 如果eventfd計數器為0,那么read(2)操作會阻塞直到計數器非0;但是如果文件描述符設置了NONBLOCK,那么會返回一個錯誤(EAGAIN)
- 文件描述符的write(2)操作
write操作會往eventfd計數器上累加一個8字節的整數值。 - 文件描述符的poll(2)/select(2)操作
返回的file descriptor支持poll(2)操作和select(2)操作。
拿poll()操作為例,它會監控一組文件描述符,來判斷是否可以對這個文件描述符進行I/O操作。這組文件描述符通過如下的結構體格式來指定.
struct pollfd {
int fd; //文件描述符
short events; // 請求的事件,例如POLLIN
short revents; // 返回的事件
};
- 文件描述符的close(2)操作
當文件描述符不再需要時,需要close這個文件描述符,當eventfd對象相關的所有的文件描述符都被關了,這個eventfd對象會被內核釋放。
NOTES
如果只是使用管道pipe來進行事件通知,那么應用程序可以用eventfd文件描述符來替換pipe。使用eventfd值需要一個文件描述符,而pipe則需要兩個。
eventfd的一個關鍵的特點是,它可以像其他的文件描述符一樣,使用select(),poll()等函數來監控。利用poll函數可以進行I/O的復用。
示例一(read/write操作)
#include <sys/eventfd.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h> /* Definition of uint64_t */
#define handle_error(msg) \
do { perror(msg); exit(EXIT_FAILURE); } while (0)
int
main(int argc, char *argv[])
{
int efd, j;
uint64_t u;
ssize_t s;
if (argc < 2) {
fprintf(stderr, "Usage: %s <num>...\n", argv[0]);
exit(EXIT_FAILURE);
}
efd = eventfd(0, EFD_SEMAPHORE | EFD_NONBLOCK);
if (efd == -1)
handle_error("eventfd");
switch (fork()) {
case 0:
for (j = 1; j < argc; j++) {
printf("Child writing %s to efd\n", argv[j]);
u = strtoull(argv[j], NULL, 0);
/* strtoull() allows various bases */
//s = write(efd, &u, sizeof(uint64_t));
if (s != sizeof(uint64_t))
handle_error("write");
}
printf("Child completed write loop\n");
exit(EXIT_SUCCESS);
default:
sleep(2);
printf("Parent about to read\n");
s = read(efd, &u, sizeof(uint64_t));
if (s != sizeof(uint64_t))
handle_error("read");
printf("Parent read %llu (0x%llx) from efd\n",
(unsigned long long) u, (unsigned long long) u);
exit(EXIT_SUCCESS);
case -1:
handle_error("fork");
}
}
這段代碼中創建了一個新的eventfd對象,并返回了文件描述符
- 子進程把數字寫入文件描述符
- 父進程在等待兩秒后,去讀取文件描述符,并打印出來。
這里可以嘗試修改eventfd函數的第二個入參flags來觀察會有什么不同的變化。按如下命令運行程序
./eventfd 4 5 6
- 如果flags設置為0,父進程讀取并打印的結果是20,這個時候計數器置為0
- 如果flags設置了EFD_SEMAPHORE,父進程讀取并打印的結果為1,計數器遞減1
- 如果flags沒有設置EFD_NONBLOCK,然后子進程中不往文件描述符寫入8字節的值,那么父進程會一直阻塞,程序會阻塞在那里。
- 如果flags設置了EFD_NONBLOCK,然后子進程中不往文件描述符寫入8字節的值,會打印一個錯誤,同時父進程退出。
示例二(poll操作)
#include <sys/eventfd.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h> /* Definition of uint64_t */
#include <poll.h>
#define handle_error(msg) \
do { perror(msg); exit(EXIT_FAILURE); } while (0)
int
main(int argc, char *argv[])
{
int efd, j;
uint64_t u;
ssize_t s;
if (argc < 2) {
fprintf(stderr, "Usage: %s <num>...\n", argv[0]);
exit(EXIT_FAILURE);
}
efd = eventfd(0, EFD_SEMAPHORE); //EFD_NONBLOCK
if (efd == -1)
handle_error("eventfd");
switch (fork()) {
case 0:
for (j = 1; j < argc; j++) {
printf("Child writing %s to efd\n", argv[j]);
u = strtoull(argv[j], NULL, 0);
/* strtoull() allows various bases */
s = write(efd, &u, sizeof(uint64_t));
if (s != sizeof(uint64_t))
handle_error("write");
}
printf("Child completed write loop\n");
exit(EXIT_SUCCESS);
default:
sleep(1);
printf("Parent about to read\n");
while (1)
{
struct pollfd item;
item.fd = efd;
item.events = POLLIN;
item.revents = 0;
int ret = poll(&item, 1, -1);
if (ret == -1)
{
printf("error");
exit(EXIT_SUCCESS);
}
else if(item.revents & POLLIN > 0)
{
s = read(efd, &u, sizeof(uint64_t));
printf("Parent read %llu (0x%llx) from efd\n",
(unsigned long long) u, (unsigned long long) u);
}
else if(ret == 0)
{
printf("timeout\n");
exit(EXIT_SUCCESS);
}
}
exit(EXIT_SUCCESS);
case -1:
handle_error("fork");
}
}
這個示例中子進程會使用poll函數去監控file descriptor上的I/O事件,timeout設置成-1,poll函數會阻塞等待文件描述符的計數器非零。
創建文件描述符的時候可以通過修改flags來設置不同的描述符行為,運行如下命令行查看不同的運行結果。
./eventfd 1 2
- 如果flags設置成0,子進程中poll成功一次,打印出來結果為3,同時計數器置0。然后poll函數會阻塞;
- 如果flags設置為EFD_SEMAPHORE,子進程中poll成功3次,每次打印的結果都是1,每次計數器遞減1。最后poll函數會阻塞;
- 如果flags設置了EFD_NONBLOCK,子進程中的行為和之前一樣。也就是說這個標志不影響poll的行為,只會影響read()的行為。