lighttpd1.4.18代码分析(二)--fdevents结构体解析

lighttpd中采取了类似于OO中面向对象的方式封装了各种平台对网络IO的事件处理,这其中包括:
OS                 Method         Config Value
all             select         select
Unix             poll         poll
Linux 2.4+         rt-signals     linux-rtsig
Linux 2.6+         epoll         linux-sysepoll
Solaris         /dev/poll     solaris-devpoll
FreeBSD, ...     kqueue         freebsd-kqueue
NetBSD     kqueue     kqueue

所有的网络IO事件都要满足这个数据结构的要求, 这个名为fdevents的结构体可以看成是OO中虚拟基类, 而每种具体的实现则可以看成是
继承并且实现了该虚拟基类中纯虚函数的派生类:

typedef struct fdevents {
    fdevent_handler_t type;

    fdnode **fdarray;
    size_t maxfds;

#ifdef USE_LINUX_SIGIO
    int in_sigio;
    int signum;
    sigset_t sigset;
    siginfo_t siginfo;
    bitset *sigbset;
#endif
#ifdef USE_LINUX_EPOLL
    int epoll_fd;
    struct epoll_event *epoll_events;
#endif
#ifdef USE_POLL
    struct pollfd *pollfds;

    size_t size;
    size_t used;

    buffer_int unused;
#endif
#ifdef USE_SELECT
    fd_set select_read;
    fd_set select_write;
    fd_set select_error;

    fd_set select_set_read;
    fd_set select_set_write;
    fd_set select_set_error;

    int select_max_fd;
#endif
#ifdef USE_SOLARIS_DEVPOLL
    int devpoll_fd;
    struct pollfd *devpollfds;
#endif
#ifdef USE_FREEBSD_KQUEUE
    int kq_fd;
    struct kevent *kq_results;
    bitset *kq_bevents;
#endif
#ifdef USE_SOLARIS_PORT
    int port_fd;
#endif
    int (*reset)(struct fdevents *ev);
    void (*free)(struct fdevents *ev);

    int (*event_add)(struct fdevents *ev, int fde_ndx, int fd, int events);
    int (*event_del)(struct fdevents *ev, int fde_ndx, int fd);
    int (*event_get_revent)(struct fdevents *ev, size_t ndx);
    int (*event_get_fd)(struct fdevents *ev, size_t ndx);

    int (*event_next_fdndx)(struct fdevents *ev, int ndx);

    int (*poll)(struct fdevents *ev, int timeout_ms);

    int (*fcntl_set)(struct fdevents *ev, int fd);
} fdevents;

该结构体中包含了一些公有的参数, 也就是类似OO中虚拟基类中的成员变量, 无论是哪个派生类继承之后都会有这部分的成员,
如最前面的几个成员:
    fdevent_handler_t type;

    fdnode **fdarray;
    size_t maxfds;
   
其中type是如下类型的枚举:

typedef enum 
{ 
    FDEVENT_HANDLER_UNSET,
    FDEVENT_HANDLER_SELECT,
    FDEVENT_HANDLER_POLL,
    FDEVENT_HANDLER_LINUX_RTSIG,
    FDEVENT_HANDLER_LINUX_SYSEPOLL,
    FDEVENT_HANDLER_SOLARIS_DEVPOLL,
    FDEVENT_HANDLER_FREEBSD_KQUEUE,
    FDEVENT_HANDLER_SOLARIS_PORT
} fdevent_handler_t;

, 其实也就是各个不同IO事件类型.
   
fdarray是一个存放fdnode *类型的数组:

typedef struct _fdnode {
    fdevent_handler handler;
    void *ctx;
    int fd;

    struct _fdnode *prev, *next;
} fdnode;

这个结构体中, handler是一个回调函数, 在事件触发时进行回调(后面我们会讲到), ctx是一个context, 根据不同的fd进行区分.
fd就不必多说了, 是socket fd, 可能是服务器监听所有的fd, 也可能是accept之后与client相关的fd.再后面的两个参数, 将这个结构体
变为了一个链表中的一个节点.

maxfds, 这个成员用于存放可以处理的最大数量.

除了这些公有成员外, 根据编译时的预编译宏, 该结构体还有其它的成员, 这些成员就相当于OO中具体每个派生类自己私有的成员.

在这个结构体的最后, 是一组函数指针, 也就是OO中的纯虚函数, 每个派生类都要根据这些接口自己进行实现,我分别给加上了一些简单的注释:

    // 重置某个fdevents
    int (*reset)(struct fdevents *ev);
    // 释放fdevents指针
    void (*free)(struct fdevents *ev);

    // 向fdevents中添加一个fd, events表示这个fd对哪些事件感兴趣
    int (*event_add)(struct fdevents *ev, int fde_ndx, int fd, int events);
    // 向fdevents中删除一个fd
    int (*event_del)(struct fdevents *ev, int fde_ndx, int fd);
    // 根据fd在fdevents中的fdarray中的index, 获取该fd目前对哪些事件感兴趣
    int (*event_get_revent)(struct fdevents *ev, size_t ndx);
    // 根据fd在fdevents中的fdarray中的index, 获取要进行处理的fd
    int (*event_get_fd)(struct fdevents *ev, size_t ndx);
    // 获取下一个需要进行处理的fd在fdarray中的index
    int (*event_next_fdndx)(struct fdevents *ev, int ndx);
    // 轮询, timeout_ms是超时参数, 单位是微秒
    int (*poll)(struct fdevents *ev, int timeout_ms);
    // 这个接口一般都没有实现, 为NULL
    int (*fcntl_set)(struct fdevents *ev, int fd);

在上面的函数中, 参数int events的值为以下几种:

#define BV(x) (1 << x)

#define FDEVENT_IN     BV(0)
#define FDEVENT_PRI    BV(1)
#define FDEVENT_OUT    BV(2)
#define FDEVENT_ERR    BV(3)
#define FDEVENT_HUP    BV(4)
#define FDEVENT_NVAL   BV(5)

从这里可以看到, 具体判断某个事件是否发生, 需要采用的掩码操作进行判断, 而不是一般的比较操作, 如:
if (events & FDEVENT_IN) 而不是 if (events == FDEVENT_IN)
因此, 一个fd, 当前所关注的事件类型可以不止一个而是有多个.

了解了这个结构体之后, 也就了解了lighttpd中每种网络IO事件必须处理的事件类型及它们对外的接口.下一节开始讲解在lighttpd中是如何使用这个事件处理器的.