Redis的网络模型是基于I/O多路复用程序来实现的。源码中包含四种多路复用函数库epoll、select、evport、kqueue。在程序编译时会根据系统自动选择这四种库其中之一。下面以epoll为例,来分析Redis的I/O模块的源码。
epoll系统调用方法Redis网络事件处理模块的代码都是围绕epoll那三个系统方法来写的。先把这三个方法弄清楚,后面就不难了。
epfd = epoll_create(1024);创建epoll实例
参数:表示该 epoll 实例最多可监听的 socket fd(文件描述符)数量。
返回: epoll 专用的文件描述符。
管理epoll中的事件,对事件进行注册、修改和删除。
参数: epfd:epoll实例的文件描述符; op:取值三种:EPOLL_CTL_ADD 注册、EPOLL_CTL_MOD 修 改、EPOLL_CTL_DEL 删除; fd:socket的文件描述符; epoll_event *event:事件event代表一个事件,类似于Java NIO中的channel“通道”。epoll_event 的结构如下:
typedef union epoll_data { void *ptr; int fd; /* socket文件描述符 */ __uint32_t u32; __uint64_t u64; } epoll_data_t; struct epoll_event { __uint32_t events; /* Epoll events 就是各种待监听操作的操作码求与的结果,例如EPOLLIN(fd可读)、EPOLLOUT(fd可写) */ epoll_data_t data; /* User data variable */ }; int epoll_wait(int epfd, struct epoll_event * events, intmaxevents, int timeout);等待事件是否就绪,类似于Java NIO中 select 方法。如果事件就绪,将就绪的event存入events数组中。
参数 epfd:epoll实例的文件描述符; events:已就绪的事件数组; intmaxevents:每次能处理的事件数; timeout:阻塞时间,等待产生就绪事件的超时值。 源码分析 事件Redis事件系统中将事件分为两种类型:
文件事件;网络套接字对应的事件;
时间事件:Redis中一些定时操作事件,例如 serverCron 函数。
下面从事件的注册、触发两个流程对源码进行分析
绑定事件 建立 eventLoop在 initServer方法(由 redis.c 的 main 函数调用) 中,在建立 RedisDb 对象的同时,会初始化一个“eventLoop”对象,我称之为事件处理器对象。结构体的关键成员变量如下所示:
struct aeEventLoop{ aeFileEvent *events;//已注册的文件事件数组 aeFiredEvent *fired;//已就绪的文件事件数组 aeTimeEvent *timeEventHead;//时间事件数组 ... }初始化 eventLoop 在 ae.c 的“aeCreateEventLoop”方法中执行。该方法中除了初始化 eventLoop 还调用如下方法初始化了一个 epoll 实例。
/* * ae_epoll.c * 创建一个新的 epoll 实例,并将它赋值给 eventLoop */ static int aeApiCreate(aeEventLoop *eventLoop) { aeApiState *state = zmalloc(sizeof(aeApiState)); if (!state) return -1; // 初始化事件槽空间 state->events = zmalloc(sizeof(struct epoll_event)*eventLoop->setsize); if (!state->events) { zfree(state); return -1; } // 创建 epoll 实例 state->epfd = epoll_create(1024); /* 1024 is just a hint for the kernel */ if (state->epfd == -1) { zfree(state->events); zfree(state); return -1; } // 赋值给 eventLoop eventLoop->apidata = state; return 0; }也正是在此处调用了系统方法“epoll_create”。这里的state是一个aeApiState结构,如下所示:
/* * 事件状态 */ typedef struct aeApiState { // epoll 实例描述符 int epfd; // 事件槽 struct epoll_event *events; } aeApiState;这个 state 由 eventLoop->apidata 来记录。
绑定ip端口与句柄通过 listenToPort 方法开启TCP端口,每个IP端口会对应一个文件描述符 ipfd(因为服务器可能会有多个ip地址)
// 打开 TCP 监听端口,用于等待客户端的命令请求 if (server.port != 0 && listenToPort(server.port,server.ipfd,&server.ipfd_count) == REDIS_ERR) exit(1);注意:*eventLoop 和 ipfd 分别被 server.el 和 server.ipfd[] 引用。server 是结构体 RedisServer 的实例,是Redis的全局变量。
注册事件如下所示代码,为每一个文件描述符绑定一个事件函数
// initServer方法: for (j = 0; j < server.ipfd_count; j++) { if (aeCreateFileEvent(server.el, server.ipfd[j], AE_READABLE, acceptTcpHandler,NULL) == AE_ERR) { redisPanic( "Unrecoverable error creating server.ipfd file event."); } } // ae.c 中的 aeCreateFileEvent 方法 /* * 根据 mask 参数的值,监听 fd 文件的状态, * 当 fd 可用时,执行 proc 函数 */ int aeCreateFileEvent(aeEventLoop *eventLoop, int fd, int mask, aeFileProc *proc, void *clientData) { if (fd >= eventLoop->setsize) { errno = ERANGE; return AE_ERR; } if (fd >= eventLoop->setsize) return AE_ERR; // 取出文件事件结构 aeFileEvent *fe = &eventLoop->events[fd]; // 监听指定 fd 的指定事件 if (aeApiAddEvent(eventLoop, fd, mask) == -1) return AE_ERR; // 设置文件事件类型,以及事件的处理器 fe->mask |= mask; if (mask & AE_READABLE) fe->rfileProc = proc; if (mask & AE_WRITABLE) fe->wfileProc = proc; // 私有数据 fe->clientData = clientData; // 如果有需要,更新事件处理器的最大 fd if (fd > eventLoop->maxfd) eventLoop->maxfd = fd; return AE_OK; }