nginx源码分析
nginx-1.11.1
参考书籍《深入理解nginx模块开发与架构解析》
事件处理模块概述
Nginx的高效请求的处理依赖于事件管理机制,本次默认的场景是Linux操作系统下的epoll,Nginx基于该事件管理机制实现事件管理机制,本文就主要分析一下Nginx的具体的操作流程。
事件处理的流程
在前文的分析中,最终worker子进程工作的时候就是通过,ngx_process_events函数来处理,该函数为宏定义如下所示;
#define ngx_process_events ngx_event_actions.process_events
由于event模块会在编译的时候根据不同的操作系统选择不同的模块加载,本文分析的是epoll的模式,即加载的是ngx_epoll_module.c模块,查看该结构的定义;
typedef struct {
ngx_int_t (*add)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags); // 添加事件监听模块
ngx_int_t (*del)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags); // 删除事件监听模块
ngx_int_t (*enable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
ngx_int_t (*disable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
ngx_int_t (*add_conn)(ngx_connection_t *c); // 添加一个新的连接
ngx_int_t (*del_conn)(ngx_connection_t *c, ngx_uint_t flags); // 删除一个连接事件
ngx_int_t (*notify)(ngx_event_handler_pt handler);
ngx_int_t (*process_events)(ngx_cycle_t *cycle, ngx_msec_t timer,
ngx_uint_t flags); // 事件循环中处理的方法
ngx_int_t (*init)(ngx_cycle_t *cycle, ngx_msec_t timer); // 初始化事件
void (*done)(ngx_cycle_t *cycle); // 退出事件循环时调用的方法
} ngx_event_actions_t;
typedef struct {
ngx_str_t *name; // 模块名称
void *(*create_conf)(ngx_cycle_t *cycle); // 模块的创建调用方法
char *(*init_conf)(ngx_cycle_t *cycle, void *conf); // 模块的初始化方法
ngx_event_actions_t actions; // 模块的操作方法
} ngx_event_module_t;
此时,就把模块上相关的操作方法就设置到了模块里面,此时查看ngx_epoll_module.c中的模块的方法定义;
ngx_event_module_t ngx_epoll_module_ctx = {
&epoll_name,
ngx_epoll_create_conf, /* create configuration */
ngx_epoll_init_conf, /* init configuration */
{
ngx_epoll_add_event, /* add an event */ // 添加读事件
ngx_epoll_del_event, /* delete an event */ // 添加写事件
ngx_epoll_add_event, /* enable an event */
ngx_epoll_del_event, /* disable an event */
ngx_epoll_add_connection, /* add an connection */
ngx_epoll_del_connection, /* delete an connection */
#if (NGX_HAVE_EVENTFD)
ngx_epoll_notify, /* trigger a notify */
#else
NULL, /* trigger a notify */
#endif
ngx_epoll_process_events, /* process the events */ // 事件处理方法
ngx_epoll_init, /* init the events */
ngx_epoll_done, /* done the events */
}
};
此时在处理事件的时候,就调用了ngx_epoll_process_events方法,
static ngx_int_t
ngx_epoll_process_events(ngx_cycle_t *cycle, ngx_msec_t timer, ngx_uint_t flags)
{
int events;
uint32_t revents;
ngx_int_t instance, i;
ngx_uint_t level;
ngx_err_t err;
ngx_event_t *rev, *wev;
ngx_queue_t *queue;
ngx_connection_t *c;
/* NGX_TIMER_INFINITE == INFTIM */
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"epoll timer: %M", timer);
events = epoll_wait(ep, event_list, (int) nevents, timer); // 传入定时器 获取监听列表上面是否有事件发生
err = (events == -1) ? ngx_errno : 0; // 是否出错
if (flags & NGX_UPDATE_TIME || ngx_event_timer_alarm) {
ngx_time_update(); // 检查flags传入是否更新时间
}
if (err) { // 如果有事件发生
if (err == NGX_EINTR) {
if (ngx_event_timer_alarm) {
ngx_event_timer_alarm = 0;
return NGX_OK; // 如果是定时器事件则正常返回
}
level = NGX_LOG_INFO;
} else {
level = NGX_LOG_ALERT;
}
ngx_log_error(level, cycle->log, err, "epoll_wait() failed");
return NGX_ERROR; // 否则就返回错误码
}
if (events == 0) { // 如果没有事件发生
if (timer != NGX_TIMER_INFINITE) { // 如果与超时时间不等则ok
return NGX_OK;
}
ngx_log_error(NGX_LOG_ALERT, cycle->log, 0,
"epoll_wait() returned no events without timeout");
return NGX_ERROR; // 否则记录错误并返回
}
for (i = 0; i < events; i++) { // 遍历响应事件列表
c = event_list[i].data.ptr; // 获取监听事件操作指针
instance = (uintptr_t) c & 1;
c = (ngx_connection_t *) ((uintptr_t) c & (uintptr_t) ~1);
rev = c->read; // 获取读处理
if (c->fd == -1 || rev->instance != instance) {
/*
* the stale event from a file descriptor
* that was just closed in this iteration
*/
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"epoll: stale event %p", c);
continue;
}
revents = event_list[i].events; // 获取事件
ngx_log_debug3(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"epoll: fd:%d ev:%04XD d:%p",
c->fd, revents, event_list[i].data.ptr);
if (revents & (EPOLLERR|EPOLLHUP)) {
ngx_log_debug2(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"epoll_wait() error on fd:%d ev:%04XD",
c->fd, revents); // 检查是否事件出错
}
#if 0
if (revents & ~(EPOLLIN|EPOLLOUT|EPOLLERR|EPOLLHUP)) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, 0,
"strange epoll_wait() events fd:%d ev:%04XD",
c->fd, revents);
}
#endif
if ((revents & (EPOLLERR|EPOLLHUP))
&& (revents & (EPOLLIN|EPOLLOUT)) == 0)
{
/*
* if the error events were returned without EPOLLIN or EPOLLOUT,
* then add these flags to handle the events at least in one
* active handler
*/
revents |= EPOLLIN|EPOLLOUT;
}
if ((revents & EPOLLIN) && rev->active) { // 有读事件并且该事件活跃
#if (NGX_HAVE_EPOLLRDHUP)
if (revents & EPOLLRDHUP) {
rev->pending_eof = 1;
}
rev->available = 1;
#endif
rev->ready = 1; // 设置可接受状态
if (flags & NGX_POST_EVENTS) { // 检查是不是新进连接
queue = rev->accept ? &ngx_posted_accept_events
: &ngx_posted_events;
ngx_post_event(rev, queue); // 处理新进请求 将事件放入相应队列中
} else {
rev->handler(rev); // 直接处理该请求
}
}
wev = c->write; // 写事件
if ((revents & EPOLLOUT) && wev->active) {
if (c->fd == -1 || wev->instance != instance) {
/*
* the stale event from a file descriptor
* that was just closed in this iteration
*/
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"epoll: stale event %p", c);
continue;
}
wev->ready = 1; // 写事件就绪
#if (NGX_THREADS)
wev->complete = 1;
#endif
if (flags & NGX_POST_EVENTS) {
ngx_post_event(wev, &ngx_posted_events); // 加入到写队列中
} else {
wev->handler(wev); // 直接处理该事件
}
}
}
return NGX_OK;
}
通过该函数的处理流程待明白了epoll模块作为读写事件的处理机制,进行相关的事件触发处理,通过监听读与写事件从而完成对请求的处理。从代码流程可知,通过将新进入的建立连接的请求列表ngx_posted_accept_events与处理读写请求列表ngx_posted_events从而将两个列表进行分开处理。
总结
本文主要就是分析了Nginx在worker启动之后进行的请求的处理的一个大致流程,与epoll的执行的流程相同,注册相关事件并等待该事件发生,然后调用相关的handler回调方法去执行,从而完成请求的处理。由于本人才疏学浅,如有错误请批评指正。