Nginx 定時器事件 · 理解 Nginx 源碼

### 概述 ? ? ? 在 Nginx 中定時器事件的實現與內核無關。在事件模塊中，當等待的事件不能在指定的時間內到達，則會觸發Nginx 的超時機制，超時機制會對發生超時的事件進行管理，并對這些超時事件作出處理。對于定時事件的管理包括兩方面：定時事件對象的組織形式和定時事件對象的超時檢測。 ### 定時事件的組織 ? ? ? Nginx 的定時器由紅黑樹實現的。在保存事件的結構體ngx_event_t 中有三個關于時間管理的成員，如下所示： ~~~ struct ngx_event_s{ ... /* 標志位，為1表示當前事件已超時 */ unsigned timedout:1; /* 標志位，為1表示當前事件存在于由紅黑樹維護的定時器中 */ unsigned timer_set:1; /* 由紅黑樹維護的定時器 */ ngx_rbtree_node_t timer; ... }; ~~~ ? ? ? Nginx 設置兩個關于定時器的全局變量。在文件[src/event/ngx_event_timer.c](http://lxr.nginx.org/source/src/event/ngx_event_timer.c)中定義： ~~~ /* 所有定時器事件組成的紅黑樹 */ ngx_thread_volatile ngx_rbtree_t ngx_event_timer_rbtree; /* 紅黑樹的哨兵節點 */ static ngx_rbtree_node_t ngx_event_timer_sentinel; ~~~ ? ? ? 這棵紅黑樹的每一個節點代表一個事件 ngx_event_t 結構體中的成員timer，ngx_rbtree_node_t 節點代表事件的超時時間，以這個超時時間的大小組成的紅黑樹ngx_event_timer_rbtree，則該紅黑樹中最左邊的節點代表最可能超時的事件。 ? ? ? 定時器事件初始化實際上調用紅黑樹的初始化，其在文件 [src/event/ngx_event_timer.c](http://lxr.nginx.org/source/src/event/ngx_event_timer.c)中定義： ~~~ /* 定時器事件初始化 */ ngx_int_t ngx_event_timer_init(ngx_log_t *log) { /* 初始化紅黑樹 */ ngx_rbtree_init(&ngx_event_timer_rbtree, &ngx_event_timer_sentinel, ngx_rbtree_insert_timer_value); /* 下面是針對多線程環境 */ #if (NGX_THREADS) if (ngx_event_timer_mutex) { ngx_event_timer_mutex->log = log; return NGX_OK; } ngx_event_timer_mutex = ngx_mutex_init(log, 0); if (ngx_event_timer_mutex == NULL) { return NGX_ERROR; } #endif return NGX_OK; } ~~~ ### 定時事件的超時檢測 ? ? ? 當需要對某個事件進行超時檢測時，只需要將該事件添加到定時器紅黑樹中即可，由函數 ngx_event_add_timer，將一個事件從定時器紅黑樹中刪除由函數 ngx_event_del_timer 實現。以下的函數都在文件 [src/event/ngx_event_timer.h](http://lxr.nginx.org/source/src/event/ngx_event_timer.h)中定義： ~~~ /* 從定時器中移除事件 */ static ngx_inline void ngx_event_del_timer(ngx_event_t *ev) { ngx_log_debug2(NGX_LOG_DEBUG_EVENT, ev->log, 0, "event timer del: %d: %M", ngx_event_ident(ev->data), ev->timer.key); ngx_mutex_lock(ngx_event_timer_mutex); /* 從紅黑樹中移除指定事件的節點對象 */ 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; } /* 將事件添加到定時器中 */ static ngx_inline void ngx_event_add_timer(ngx_event_t *ev, ngx_msec_t timer) { ngx_msec_t key; ngx_msec_int_t diff; /* 設置事件對象節點的鍵值 */ key = ngx_current_msec + timer; /* 判斷事件的相應標志位 */ 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); ngx_mutex_unlock(ngx_event_timer_mutex); /* 設置標志位 */ ev->timer_set = 1; } ~~~ ? ? ? 判斷一個函數是否超時由函數 ngx_event_find_timer 實現，檢查定時器所有事件由函數ngx_event_expire_timer 實現。以下的函數都在文件[src/event/ngx_event_timer.c](http://lxr.nginx.org/source/src/event/ngx_event_timer.c)中定義： ~~~ /* 找出定時器紅黑樹最左邊的節點 */ ngx_msec_t ngx_event_find_timer(void) { ngx_msec_int_t timer; ngx_rbtree_node_t *node, *root, *sentinel; /* 若紅黑樹為空 */ if (ngx_event_timer_rbtree.root == &ngx_event_timer_sentinel) { return NGX_TIMER_INFINITE; } ngx_mutex_lock(ngx_event_timer_mutex); root = ngx_event_timer_rbtree.root; sentinel = ngx_event_timer_rbtree.sentinel; /* 找出紅黑樹最小的節點，即最左邊的節點 */ node = ngx_rbtree_min(root, sentinel); ngx_mutex_unlock(ngx_event_timer_mutex); /* 計算最左節點鍵值與當前時間的差值timer，當timer大于0表示不超時，不大于0表示超時 */ timer = (ngx_msec_int_t) (node->key - ngx_current_msec); /* * 若timer大于0，則事件不超時，返回該值； * 若timer不大于0，則事件超時，返回0，標志觸發超時事件； */ return (ngx_msec_t) (timer > 0 ? timer : 0); } /* 檢查定時器中所有事件 */ void ngx_event_expire_timers(void) { ngx_event_t *ev; ngx_rbtree_node_t *node, *root, *sentinel; sentinel = ngx_event_timer_rbtree.sentinel; /* 循環檢查 */ for ( ;; ) { ngx_mutex_lock(ngx_event_timer_mutex); root = ngx_event_timer_rbtree.root; /* 若定時器紅黑樹為空，則直接返回，不做任何處理 */ if (root == sentinel) { return; } /* 找出定時器紅黑樹最左邊的節點，即最小的節點，同時也是最有可能超時的事件對象 */ node = ngx_rbtree_min(root, sentinel); /* node->key <= ngx_current_time */ /* 若檢查到的當前事件已超時 */ if ((ngx_msec_int_t) (node->key - ngx_current_msec) <= 0) { /* 獲取超時的具體事件 */ 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); /* 將已超時事件對象從現有定時器紅黑樹中移除 */ 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;/* 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;/* 1表示已經超時 */ /* 調用已超時事件的處理函數對該事件進行處理 */ ev->handler(ev); continue; } break; } ngx_mutex_unlock(ngx_event_timer_mutex); } ~~~ 參考資料《深入剖析Nginx》《深入理解Nginx》