事件库

什么是事件库，Redis 的原始事件库是如何实现的？

注意：此文档由 Redis 创建者 Salvatore Sanfilippo 在 Redis 开发早期（约 2010 年）编写，不一定反映最新的 Redis 实现。

为什么需要事件库？

让我们通过一系列问答来弄清楚。

问：你期望网络服务器始终做什么？
答：监听其监听端口上的入站连接并接受它们。

问：调用 accept 会产生一个描述符。我该怎么做？
答：保存描述符并对其执行非阻塞读/写操作。

问：为什么读/写必须是非阻塞的？
答：如果文件操作（即使 Unix 中的套接字也是文件）被阻塞，那么当服务器在文件 I/O 操作中被阻塞时，它如何接受其他连接请求。

问：我想我必须对套接字执行许多这样的非阻塞操作，才能看到它何时准备就绪。我说的对吗？
答：是的。这就是事件库为您所做的。现在您明白了。

问：事件库如何执行其操作？
答：它们使用操作系统的轮询功能以及计时器。

问：那么，有没有任何开源事件库可以执行您刚才描述的操作？
答：是的。libevent 和 libev 是两个这样的事件库，我可以脱口而出。

问：Redis 是否使用此类开源事件库来处理套接字 I/O？
答：不。由于各种原因，Redis 使用其自己的事件库。

Redis 事件库

Redis 实现了自己的事件库。事件库在 ae.c 中实现。

了解 Redis 事件库的工作原理的最佳方法是了解 Redis 如何使用它。

事件循环初始化

在 redis.c 中定义的 initServer 函数初始化 redisServer 结构变量的多个字段。其中一个字段是 Redis 事件循环 el

aeEventLoop *el

initServer 通过调用在 ae.c 中定义的 aeCreateEventLoop 来初始化 server.el 字段。aeEventLoop 的定义如下

typedef struct aeEventLoop
{
    int maxfd;
    long long timeEventNextId;
    aeFileEvent events[AE_SETSIZE]; /* Registered events */
    aeFiredEvent fired[AE_SETSIZE]; /* Fired events */
    aeTimeEvent *timeEventHead;
    int stop;
    void *apidata; /* This is used for polling API specific data */
    aeBeforeSleepProc *beforesleep;
} aeEventLoop;

`aeCreateEventLoop`

aeCreateEventLoop 首先 malloc aeEventLoop 结构，然后调用 ae_epoll.c:aeApiCreate。

aeApiCreate malloc aeApiState，它有两个字段 - epfd，它保存由 epoll_create 调用返回的 epoll 文件描述符，以及 events，它属于 Linux epoll 库定义的 struct epoll_event 类型。events 字段的使用将在后面描述。

接下来是 ae.c:aeCreateTimeEvent。但在那之前，initServer 调用 anet.c:anetTcpServer，它创建一个并返回一个侦听描述符。该描述符默认侦听端口 6379。返回的侦听描述符存储在 server.fd 字段中。

`aeCreateTimeEvent`

aeCreateTimeEvent 接受以下内容作为参数

eventLoop：这是 redis.c 中的 server.el
milliseconds：从当前时间到计时器到期后的毫秒数。
proc：函数指针。存储计时器到期后必须调用的函数的地址。
clientData：通常为 NULL。
finalizerProc：在从计时事件列表中删除计时事件之前必须调用的函数的指针。

initServer 调用 aeCreateTimeEvent 将计时事件添加到 server.el 的 timeEventHead 字段。timeEventHead 是指向此类计时事件列表的指针。以下是 redis.c:initServer 函数中对 aeCreateTimeEvent 的调用

aeCreateTimeEvent(server.el /*eventLoop*/, 1 /*milliseconds*/, serverCron /*proc*/, NULL /*clientData*/, NULL /*finalizerProc*/);

redis.c:serverCron 执行许多操作，有助于保持 Redis 正常运行。

`aeCreateFileEvent`

aeCreateFileEvent 函数的本质是执行 epoll_ctl 系统调用，该调用在由 anetTcpServer 创建的侦听描述符上添加对 EPOLLIN 事件的监视，并将其与通过调用 aeCreateEventLoop 创建的 epoll 描述符相关联。

以下是当从 redis.c:initServer 调用时，aeCreateFileEvent 确切执行的操作的说明。

initServer 将以下参数传递给 aeCreateFileEvent

server.el：由 aeCreateEventLoop 创建的事件循环。epoll 描述符从 server.el 获得。
server.fd：监听描述符，还用作从 eventLoop->events 表中访问相关文件事件结构的索引，并存储回调函数等额外信息。
AE_READABLE：表示必须监视 server.fd 以查找 EPOLLIN 事件。
acceptHandler：当正在监视的事件就绪时必须执行的函数。此函数指针存储在 eventLoop->events[server.fd]->rfileProc 中。

这完成了 Redis 事件循环的初始化。

事件循环处理

从 redis.c:main 调用的 ae.c:aeMain 执行处理在上一个阶段初始化的事件循环的任务。

ae.c:aeMain 在一个 while 循环中调用 ae.c:aeProcessEvents，该循环处理待处理的时间和文件事件。

`aeProcessEvents`

ae.c:aeProcessEvents 通过在事件循环上调用 ae.c:aeSearchNearestTimer 来查找将在最短时间内挂起的事件。在我们的案例中，事件循环中只有一个计时器事件，该事件是由 ae.c:aeCreateTimeEvent 创建的。

请记住，由 aeCreateTimeEvent 创建的计时器事件现在可能已经过去，因为它有一个一毫秒的到期时间。由于计时器已经到期，tvp timeval 结构变量的秒和微秒字段被初始化为零。

tvp 结构变量连同事件循环变量一起传递给 ae_epoll.c:aeApiPoll。

aeApiPoll 函数对 epoll 描述符执行 epoll_wait，并使用详细信息填充 eventLoop->fired 表

fd：现在准备根据掩码值执行读/写操作的描述符。
mask：现在可以在相应描述符上执行的读/写事件。

aeApiPoll 返回准备操作的此类文件事件的数量。现在将事情放在上下文中，如果任何客户端请求连接，则 aeApiPoll 会注意到它，并使用描述符（即监听描述符）的条目和掩码（即 AE_READABLE）填充 eventLoop->fired 表。

现在，aeProcessEvents 调用注册为回调的 redis.c:acceptHandler。acceptHandler 对监听描述符执行 accept，返回与客户端的已连接描述符。redis.c:createClient 通过调用 ae.c:aeCreateFileEvent 在已连接描述符上添加文件事件，如下所示

if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
    readQueryFromClient, c) == AE_ERR) {
    freeClient(c);
    return NULL;
}

c 是 redisClient 结构变量，c->fd 是已连接描述符。

接下来，ae.c:aeProcessEvent 调用 ae.c:processTimeEvents

`processTimeEvents`

ae.processTimeEvents 从 eventLoop->timeEventHead 开始迭代时间事件列表。

对于已过的每个定时事件，processTimeEvents 调用已注册的回调。在这种情况下，它调用已注册的唯一定时事件回调，即 redis.c:serverCron。回调返回必须再次调用回调后的毫秒数。此更改通过调用 ae.c:aeAddMilliSeconds 记录，并且将在 ae.c:aeMain while 循环的下次迭代中处理。

就是这样。

事件库

为什么需要事件库？

Redis 事件库

事件循环初始化

aeCreateEventLoop

aeCreateTimeEvent

aeCreateFileEvent