eventfd

1. 简介

eventfd - create a file descriptor for event notification

eventfd是通过事件通知机制。

int eventfd(unsigned int initval, int flags);

eventfd创建一个“eventfd对象”，可以用作事件等待/通知机制由用户空间应用程序和通知用户空间应用程序事件的内核。这个对象包含由内核维护的无符号64位整数计数器。此计数器已初始化使用参数initval中指定的值。eventfd（）返回一个新的文件描述符，可用于引用eventfd对象。因为是文件描述符，所以它支持read、write、select、poll等。

它可以用于父子进程之间的通信，也可以用于多线程之间的通信。

flags :

EFD_CLOEXEC  此标记设置后，调用exec后子进程得不到这个句柄

EFD_NONBLOCK  非阻塞状态

如果没有设置这个状态的话，read(2)读eventfd,并且计数器的值为0 就一直堵塞在read调用当中。

要是设置了这个标志， 就会返回一个 EAGAIN 错误(errno = EAGAIN)。

EFD_SEMAPHORE 信号量

如果没有设置 ，并且eventfd计数器有一个非零值，那么read返回包含该值的8个字节，并且计数器的值被重置为零。

如果设置了 ，并且eventfd计数器具有非零值，则read（2）返回8个字节，其中包含值1，并且计数器的值递减1。

如果在调用read时eventfd计数器为零，那么调用要么阻塞直到计数器变为非零，要么失败并返回错误EAGAIN（如果文件描述符已完成）

 

2. read

每次成功read 都返回一个8字节整数。如果提供的缓冲区大小小于8字节，则失败，并显示错误EINVAL。如果eventfd设置成阻塞的， read会阻塞在这里，否则会返回一个一个EAGAIN错误。

3. write

它会写入一个 64bit的整数到 eventfd。多次write则会累加。超出上界 0xffff ffff ffff fffe，会返回 -1 并设置 errno 为 EAGAIN。

下面是个官方手册给出的例子

 

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/eventfd.h>
#include <unistd.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, 0);
    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");
    }
}

测试如下

[root@localhost others]# ./evfd 1 2 4 7 14
Child writing 1 to efd
Child writing 2 to efd
Child writing 4 to efd
Child writing 7 to efd
Child writing 14 to efd
Child completed write loop
Parent about to read
Parent read 28 (0x1c) from efd

4. select

 

下面是一个简单的例子（为了节省篇幅，此处省略掉了异常处理和头文件），此处开启一个线程给主线程发送一个事件。

 

static int s_efd = 0;
int create_eventfd() {
    int evtfd = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
    return evtfd;
}

void* my_thread(void *arg) {
    sleep(3);
    uint64_t one = 5;
    ssize_t n = write(s_efd, &one, sizeof one);
}

int main() {
    s_efd = create_eventfd();

    pthread_t th;  
    int ret = pthread_create( &th, NULL, my_thread, NULL );  

    fd_set rdset;
    FD_ZERO(&rdset);
    FD_SET(s_efd, &rdset);
    select(s_efd + 1, &rdset, NULL, NULL, NULL);

    uint64_t one = 0;
    ssize_t n = read(s_efd, &one, sizeof one);
    printf("get data %lu\n", one);

    pthread_join(th,NULL);
    close(s_efd);

    return 0;
}