使用eventfd创建一个用于事件通知的文件描述符

2017-11-30 本文已影响647人 EVANMORE

函数定义和头文件

#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()的行为。

[REF]

Linux Programmer's Manual - EVENTFD