nginx的定时器

还是早就想写这篇了，只不过被老板安排写网站去了，一直没有腾出时间。。。

在nginx中有两种事件类型，其中一种的引发点是epoll，也就是通过epoll来获取事件的源头，另外一种就是定时时间。。在前面的代码中就已经遇到过了，例如当nginx获取到一个客户端的连接时，需要对该连接进行初始化，同时还要给这个连接增加一个定时器，如果都超时了请求的数据都还没有接收完整，那么就直接断开这个连接。。。

这里，nginx中的定时功能并没有采用操作系统提供的定时器，而是自己实现了一个模拟定时器的方法。。。最核心的就是一颗红黑树。。。。

在Ngx_times.c文件中定义了很多关于时间的全局变量，其中对于定时时间最为重要的是：

volatile ngx_msec_t      ngx_current_msec;

ngx_msec_t为一个无符号的整形，用于代表当前的UTC时间，单位是毫秒。。

我们首先来看添加定时事件的函数吧：

//将一个事件加入到红黑树当中，它的超时未timer时间
static ngx_inline void
ngx_event_add_timer(ngx_event_t *ev, ngx_msec_t timer)   //timer说白了就是一个int的值，表示超时的事件，用于表示红黑树节点的key
{
    ngx_msec_t      key;
    ngx_msec_int_t  diff;

    key = ngx_current_msec + timer;  //表示该event的超时时间，为当前时间的值加上超时变量

    if (ev->timer_set) {

        /*
         * Use a previous timer value if difference between it and a new
         * value is less than NGX_TIMER_LAZY_DELAY milliseconds: this allows
         * to minimize the rbtree operations for fast connections.
         */

        diff = (ngx_msec_int_t) (key - ev->timer.key);

        if (ngx_abs(diff) < NGX_TIMER_LAZY_DELAY) {
            ngx_log_debug3(NGX_LOG_DEBUG_EVENT, ev->log, 0,
                           "event timer: %d, old: %M, new: %M",
                            ngx_event_ident(ev->data), ev->timer.key, key);
            return;
        }

        ngx_del_timer(ev);
    }

    ev->timer.key = key;

    ngx_log_debug3(NGX_LOG_DEBUG_EVENT, ev->log, 0,
                   "event timer add: %d: %M:%M",
                    ngx_event_ident(ev->data), timer, ev->timer.key);

    ngx_mutex_lock(ngx_event_timer_mutex);

    ngx_rbtree_insert(&ngx_event_timer_rbtree, &ev->timer);    //事件的timer域插入到红黑树当中

    ngx_mutex_unlock(ngx_event_timer_mutex);

    ev->timer_set = 1;
}

代码其实还是比较的简单，核心就是将当前event的timer插入到事件红黑树当中，其超时时间为当前的时间加上传进来的超时时间。。。

我们接着来看ngx_process_events_and_timers函数，

timer = ngx_event_find_timer(); 

这里用于获取当前事件红黑树中最小的超时时间（也就是红黑树中最左边的节点），将其提供给epoll，让epoll的wait在这个时间内唤醒。。。

接下来再来看ngx_epoll_process_events函数，

   events = epoll_wait(ep, event_list, (int) nevents, timer);    //这个超时事件是从红黑树里面获取的，当前最近的超时，这样可以保证epoll的wait能够在合适的时间内返回，保证定义的超时事件可以执行

    err = (events == -1) ? ngx_errno : 0;

    if (flags & NGX_UPDATE_TIME || ngx_event_timer_alarm) {
        ngx_time_update();
    }

    if (err

每一次wait之后就会调用ngx_time_updateh函数来更新当前的与时间相关的全局变量。。。

接下来回到ngx_process_event_and_timers中，

    if (delta) {
        ngx_event_expire_timers();
    }

这部分代码用于处理所有的超时时间。。来看看它的代码吧：

//处理红黑树中所有超时的事件
void
ngx_event_expire_timers(void)
{
    ngx_event_t        *ev;
    ngx_rbtree_node_t  *node, *root, *sentinel;

    sentinel = ngx_event_timer_rbtree.sentinel;

//死循环，找到所有的超时的timer，然后处理他们
    for ( ;; ) {

        ngx_mutex_lock(ngx_event_timer_mutex);

        root = ngx_event_timer_rbtree.root;

        if (root == sentinel) {
            return;
        }

        node = ngx_rbtree_min(root, sentinel);   //获取key最小的节点

        /* node->key <= ngx_current_time */

        if ((ngx_msec_int_t) (node->key - ngx_current_msec) <= 0) {   //判断该节点是否超时，如果超时的话，就执行处理函数，否则就可以跳出循环了
			//通过偏移来获取当前timer所在的event
            ev = (ngx_event_t *) ((char *) node - offsetof(ngx_event_t, timer));

#if (NGX_THREADS)

            if (ngx_threaded && ngx_trylock(ev->lock) == 0) {

                /*
                 * We cannot change the timer of the event that is being
                 * handled by another thread.  And we cannot easy walk
                 * the rbtree to find next expired timer so we exit the loop.
                 * However, it should be a rare case when the event that is
                 * being handled has an expired timer.
                 */

                ngx_log_debug1(NGX_LOG_DEBUG_EVENT, ev->log, 0,
                               "event %p is busy in expire timers", ev);
                break;
            }
#endif

            ngx_log_debug2(NGX_LOG_DEBUG_EVENT, ev->log, 0,
                           "event timer del: %d: %M",
                           ngx_event_ident(ev->data), ev->timer.key);
//将当前timer移除
            ngx_rbtree_delete(&ngx_event_timer_rbtree, &ev->timer);

            ngx_mutex_unlock(ngx_event_timer_mutex);

#if (NGX_DEBUG)
            ev->timer.left = NULL;
            ev->timer.right = NULL;
            ev->timer.parent = NULL;
#endif

            ev->timer_set = 0;

#if (NGX_THREADS)
            if (ngx_threaded) {
                ev->posted_timedout = 1;

                ngx_post_event(ev, &ngx_posted_events);

                ngx_unlock(ev->lock);

                continue;
            }
#endif

            ev->timedout = 1;

            ev->handler(ev);   //调用event的handler来处理这个事件

            continue;
        }

        break;
    }

    ngx_mutex_unlock(ngx_event_timer_mutex);
}

其实还是很简单的，说白了就是不断的从红黑树中获取key值最小的节点，然后判断它是否已经超时，如果超时的话就将其从红黑树中删除，然后调用处理函数。。。

这样子nginx的定时时间处理也就ok了。。。。