ngx_epoll_add_event

1 定义ngx_epoll_add_event 函数 定义在 ./nginx-1.24.0/src/event/modules/ngx_epoll_module.cstaticngx_int_tngx_epoll_add_event(ngx_event_t*ev,ngx_int_tevent,ngx_uint_tflags){intop;uint32_tevents,prev;ngx_event_t*e;ngx_connection_t*c;structepoll_eventee;cev-data;events(uint32_t)event;if(eventNGX_READ_EVENT){ec-write;prevEPOLLOUT;#if(NGX_READ_EVENT!EPOLLIN|EPOLLRDHUP)eventsEPOLLIN|EPOLLRDHUP;#endif}else{ec-read;prevEPOLLIN|EPOLLRDHUP;#if(NGX_WRITE_EVENT!EPOLLOUT)eventsEPOLLOUT;#endif}if(e-active){opEPOLL_CTL_MOD;events|prev;}else{opEPOLL_CTL_ADD;}#if(NGX_HAVE_EPOLLEXCLUSIVENGX_HAVE_EPOLLRDHUP)if(flagsNGX_EXCLUSIVE_EVENT){events~EPOLLRDHUP;}#endifee.eventsevents|(uint32_t)flags;ee.data.ptr(void*)((uintptr_t)c|ev-instance);ngx_log_debug3(NGX_LOG_DEBUG_EVENT,ev-log,0,epoll add event: fd:%d op:%d ev:%08XD,c-fd,op,ee.events);if(epoll_ctl(ep,op,c-fd,ee)-1){ngx_log_error(NGX_LOG_ALERT,ev-log,ngx_errno,epoll_ctl(%d, %d) failed,op,c-fd);returnNGX_ERROR;}ev-active1;#if0ev-oneshot(flagsNGX_ONESHOT_EVENT)?1:0;#endifreturnNGX_OK;}ngx_epoll_add_event 函数的作用是 负责将 NGINX 的读或写事件注册到 Linux epoll 实例中。 它根据事件类型构造对应的 epoll 监听掩码读:EPOLLIN|EPOLLRDHUP写:EPOLLOUT 并自动判断应该向 epoll 添加新 fd 还是修改已有事件 若同一连接的另一事件已活跃则合并事件掩码进行修改避免覆盖 最后通过 epoll_ctl 完成操作使连接的事件得以被异步监控。2 详解1 函数签名staticngx_int_tngx_epoll_add_event(ngx_event_t*ev,ngx_int_tevent,ngx_uint_tflags)返回值 成功返回 NGX_OK值为 0 失败返回 NGX_ERROR值为 -1参数1 ngx_event_t *ev 指向 ngx_event_t 结构的指针 是本次要注册监听的事件参数2 ngx_int_t event 事件类型 指明当前要注册的是读事件还是写事件NGX_READ_EVENT监听可读事件对应 EPOLLIN | EPOLLRDHUP NGX_WRITE_EVENT监听可写事件对应 EPOLLOUT参数3 ngx_uint_t flags 用来控制 epoll 行为的 控制标志 多个标志可通过按位或 | 组合传入2 逻辑流程1 局部变量 2 获取连接对象 3 事件配置 4 epoll_ctl 注册事件监听 5 返回成功1 局部变量{intop;uint32_tevents,prev;ngx_event_t*e;ngx_connection_t*c;structepoll_eventee;2 获取连接对象cev-data;从事件对象中取出连接指针。 Nginx 中每个事件ngx_event_t的 data 字段都指向其所属的 ngx_connection_t 结构 这样可以通过事件快速访问连接的所有信息3 事件配置events(uint32_t)event;初始化目标事件掩码。 将调用方传入的 Nginx 抽象事件常量强转为 32 位无符号整型。 作为初始值后续会根据实际情况做 位运算if(eventNGX_READ_EVENT){ec-write;prevEPOLLOUT;#if(NGX_READ_EVENT!EPOLLIN|EPOLLRDHUP)eventsEPOLLIN|EPOLLRDHUP;#endif}else{ec-read;prevEPOLLIN|EPOLLRDHUP;#if(NGX_WRITE_EVENT!EPOLLOUT)eventsEPOLLOUT;#endif}#1-1 判断要操作的事件是否为读事件 若为读事件则将对立事件指针 e 指向连接的写事件。 这是因为在一个连接上读写事件是成对存在的 当添加读事件时需要关心写事件当前是否已经注册以便做修改还是添加的决定 #1-2 如果写事件已经活跃那么它在 epoll 中监听的标志通常是 EPOLLOUT可写。 这里预设 prev 为 EPOLLOUT当执行 EPOLL_CTL_MOD 时 将会通过 events | prev 把写事件标志合并进去从而不会丢失写事件的监听。 #1-3 这是条件编译 如果宏 NGX_READ_EVENT 的值不等于 EPOLLIN|EPOLLRDHUP 则把 events 设置为这两个标志的位或。 该条件编译通常为真因为 Nginx 定义的 NGX_READ_EVENT 往往是一个简单的枚举值如 0 与真正的 epoll 位掩码不同。所以这里就是正确设置了读事件的监听集合。 EPOLLIN 数据可读包括正常数据和优先带数据。 EPOLLRDHUP 对端关闭连接或仅关闭写半部半关闭 这是 Linux 2.6.17 引入的标志允许应用区分对端完全关闭和只关闭写。#2-1 否则即 event 为 NGX_WRITE_EVENT处理写事件 对于写事件对立事件是连接的读事件因此 e 指向读事件 #2-2 如果读事件已经活跃则它监听的标志通常是 EPOLLIN|EPOLLRDHUP。 这里设定 prev 为这个组合以便在修改模式下保留读事件的监听。 #2-3 条件编译 如果 NGX_WRITE_EVENT 宏的值不等于 EPOLLOUT 则将 events 设为 EPOLLOUT可写。 这也是常见情况因为写事件枚举值通常不与 EPOLLOUT 直接相等。if(e-active){opEPOLL_CTL_MOD;events|prev;}else{opEPOLL_CTL_ADD;}#1 检查对立事件是否已经处于活跃状态即是否已被 epoll 监控。 e-active 标志会在事件成功通过 epoll_ctl 添加/修改后被置为 1。 若对立事件活跃说明该连接对应的文件描述符fd已经在 epoll 中被监听 epoll 是以 fd 为索引的一个 fd 只能被添加一次后续都需要修改。 因此本次操作必须是 修改EPOLL_CTL_MOD不能是添加。 设置操作码为 EPOLL_CTL_MOD表示修改已存在 fd 的监听事件 把对立事件的原有监听标志prev合并到当前要设置的 events 中。 因为 epoll 修改事件时新的事件掩码会完全覆盖原来的掩码 所以必须显式把另一方向的事件重新包含进去否则另一方向的监听就会丢失。#2 对立事件不活跃说明该 fd 是第一次注册事件或者之前的事件已被删除因而执行添加操作 操作码设为 EPOLL_CTL_ADD将 fd 首次加入 epoll 监听列表#if(NGX_HAVE_EPOLLEXCLUSIVENGX_HAVE_EPOLLRDHUP)if(flagsNGX_EXCLUSIVE_EVENT){events~EPOLLRDHUP;}#endif这是一个条件编译块 只有在系统支持 EPOLLEXCLUSIVE 并且也支持 EPOLLRDHUP 时才会编译。 EPOLLEXCLUSIVE 是 Linux 4.5 引入的标志 用于多进程/多线程共享同一个监听 socket 时 以独占方式唤醒等待队列中的进程避免惊群效应thundering herd。 然而在某些内核实现上 EPOLLEXCLUSIVE 与 EPOLLRDHUP 一起使用可能会有问题例如某些场景下破坏独占语义或造成未定义行为。因此 Nginx 在这里主动清除 EPOLLRDHUP 标志。 如果调用传入了 NGX_EXCLUSIVE_EVENT 标志 则执行 events ~EPOLLRDHUP从事件掩码中去掉 EPOLLRDHUP 位。ee.eventsevents|(uint32_t)flags;ee.data.ptr(void*)((uintptr_t)c|ev-instance);ngx_log_debug3(NGX_LOG_DEBUG_EVENT,ev-log,0,epoll add event: fd:%d op:%d ev:%08XD,c-fd,op,ee.events);#1 构建最终传递给 epoll_ctl 的事件标志。 将前面得到的 events例如 EPOLLIN|EPOLLOUT|EPOLLRDHUP 与传入的 flags可能包含 EPOLLET、EPOLLONESHOT、EPOLLEXCLUSIVE 等做位或 得到完整的 epoll 事件掩码。 注意 flags 的类型是 ngx_uint_t这里显式转换为 uint32_t 以匹配 ee.events 的类型#2 设置 epoll 事件携带的用户数据 ee.data.ptr 是 void *通常用来存放事件相关的上下文指针。 Nginx 将连接指针 c 与事件的 instance 标志做位或存入 ptr。 原因c 是一个指针其地址由于内存对齐至少 4 或 8 字节对齐而最低若干位始终为 0。 ev-instance 是一个 0 或 1 的整数用来标识事件是否过期。 当 epoll 触发事件时Nginx 会取出 ptr通过隔离低位得到原来的连接指针(c ptr ~1) 同时通过最低位判断 instance 是否与当前事件记录的 instance 一致 从而识别并丢弃旧事件例如连接已关闭但残留的事件。 这样的位复用避免了额外内存开销是一种精巧的设计#3 输出调试日志4 epoll_ctl 注册事件监听if(epoll_ctl(ep,op,c-fd,ee)-1){ngx_log_error(NGX_LOG_ALERT,ev-log,ngx_errno,epoll_ctl(%d, %d) failed,op,c-fd);returnNGX_ERROR;}调用 Linux 系统调用 epoll_ctl对全局 epoll 实例 ep该模块内的全局变量执行 op 操作 修改 fd c-fd 的监听事件为 ee 所描述的内容。 返回值 -1 表示调用失败。ev-active1;#if0ev-oneshot(flagsNGX_ONESHOT_EVENT)?1:0;#endif将当前事件的 active 标志置为 1表示该事件现在已被 epoll 成功监听。 这个标志会在将来移除事件或事件处理时被清除同时上面的逻辑也依靠它来判断对立事件的状态5 返回成功returnNGX_OK;}