Nginx源碼完全注釋（4）ngx_queue.h / ngx_queue.c

標籤：style   color   io   ar   使用   for   sp   檔案   on   

隊列標頭檔 ngx_queue.h

#include <ngx_config.h>#include <ngx_core.h>#ifndef _NGX_QUEUE_H_INCLUDED_#define _NGX_QUEUE_H_INCLUDED_typedef struct ngx_queue_s  ngx_queue_t;// 隊列的節點，也直接表示隊列。注意這是一個雙向迴圈隊列struct ngx_queue_s {    ngx_queue_t  *prev;    ngx_queue_t  *next;};// 初始化隊列 q 所指向的指標，prev 和 next 都是自己#define ngx_queue_init(q)                                                         (q)->prev = q;                                                                (q)->next = q// 如果表 h == h 的上一個，那麼就是一個空隊列，其實用 next 也可以的#define ngx_queue_empty(h)                                                        (h == (h)->prev)// 向 h 後面插入一個 x#define ngx_queue_insert_head(h, x)                                               (x)->next = (h)->next;                                                        (x)->next->prev = x;                                                          (x)->prev = h;                                                                (h)->next = x// 在後面插入 insert after，就是 insert head#define ngx_queue_insert_after   ngx_queue_insert_head// 向 h 前面插入一個 x#define ngx_queue_insert_tail(h, x)                                               (x)->prev = (h)->prev;                                                        (x)->prev->next = x;                                                          (x)->next = h;                                                                (h)->prev = x// h 表示隊列，第一個元素為 h->next#define ngx_queue_head(h)                                                         (h)->next// h 是頭，h 的上一個就是尾#define ngx_queue_last(h)                                                         (h)->prev#define ngx_queue_sentinel(h)                                                     (h)// 返回節點 q 的下一個#define ngx_queue_next(q)                                                         (q)->next// 返回節點 q 的上一個#define ngx_queue_prev(q)                                                         (q)->prev#if (NGX_DEBUG)// debug 模式下要把 x 的 prev、next 成員置為 0，release 版可以省去此兩句#define ngx_queue_remove(x)                                                       (x)->next->prev = (x)->prev;                                                  (x)->prev->next = (x)->next;                                                  (x)->prev = NULL;                                                             (x)->next = NULL#else// 刪除一個節點#define ngx_queue_remove(x)                                                       (x)->next->prev = (x)->prev;                                                  (x)->prev->next = (x)->next#endif//// split 作用如所示：////  ________________________________________________//  ||--------------------------------------------||//  ||                                            ||// |---| => |---| => … => |---| => |---| => … => |---|   |---|// | h |    |   |         | q |    |   |         |   |   | n |// |---| <= |---| <= … <= |---| <= |---| <= … <= |---|   |---|////  __________________________      __________________________________//  ||----------------------||      ||------------------------------||//  ||                      ||      ||                              ||// |---| => |---| => … => |---|    |---| => |---| => … => |---| => |---|// | h |    |   |         |   |    | q |    |   |         |   |    | n |// |---| <= |---| <= … => |---|    |---| <= |---| <= … <= |---| <= |---|//#define ngx_queue_split(h, q, n)                                                  (n)->prev = (h)->prev;                                                        (n)->prev->next = n;                                                          (n)->next = q;                                                                (h)->prev = (q)->prev;                                                        (h)->prev->next = h;                                                          (q)->prev = n;// 將 n 代表的隊列（n 為隊列頭）接到 h 表示的隊列後面////  _________________________      _________________________//  ||---------------------||      ||---------------------||//  ||                     ||      ||                     ||// |---| => |---| => … => |---|   |---| => |---| => … => |---|// | h |    |   |         |   |   | n |    |n1 |         |   |// |---| <= |---| <= … <= |---|   |---| <= |---| <= … <= |---|////  ________________________________________________________//  ||----------------------------------------------------||//  ||                                                    ||// |---| => |---| => … => |---| =========> |---| => … => |---|// | h |    |   |         |   |            |n1 |         |   |// |---| <= |---| <= … <= |---| <========= |---| <= … <= |---|//#define ngx_queue_add(h, n)                                                       (h)->prev->next = (n)->next;                                                  (n)->next->prev = (h)->prev;                                                  (h)->prev = (n)->prev;                                                        (h)->prev->next = h;// 一般type如下：// typedef struct {//    …//    LINK q// } TYPE// 所以這個宏可以通過 q 找到其所在的結構體 TYPE 變數的地址#define ngx_queue_data(q, type, link)                                             (type *) ((u_char *) q - offsetof(type, link))ngx_queue_t *ngx_queue_middle(ngx_queue_t *queue);void ngx_queue_sort(ngx_queue_t *queue,    ngx_int_t (*cmp)(const ngx_queue_t *, const ngx_queue_t *));#endif /* _NGX_QUEUE_H_INCLUDED_ */

隊列源檔案 ngx_queue.c

#include #include /* * find the middle queue element if the queue has odd number of elements * or the first element of the queue‘s second part otherwise *///// 這是用兩個指標來找鏈表中點的典型應用，在很多技巧性問答中常出現。//ngx_queue_t *ngx_queue_middle(ngx_queue_t *queue){    ngx_queue_t  *middle, *next;    // middle 從第一個節點開始    middle = ngx_queue_head(queue);    // 如果隊列只有一個節點，或者為空白    if (middle == ngx_queue_last(queue)) {        return middle;    }    // next 也從第一個節點開始    next = ngx_queue_head(queue);    for ( ;; ) {        middle = ngx_queue_next(middle);        next = ngx_queue_next(next);        // 偶數個的情況是在這裡返回        if (next == ngx_queue_last(queue)) {            return middle;        }        next = ngx_queue_next(next);        // 奇數個是在這裡返回        if (next == ngx_queue_last(queue)) {            return middle;        }    }}/* the stable insertion sort *///// 這是一個穩定就地排序（Stable In-place Sorting）。演算法的三個效能指標（時間複雜度，空間複雜度，穩定性）// 相比之下，quick sort 和 merge sort 更快。但 quick sort 是非穩定的，merge sort 使用 O(n) 額外空間//voidngx_queue_sort(ngx_queue_t *queue,    ngx_int_t (*cmp)(const ngx_queue_t *, const ngx_queue_t *)){    ngx_queue_t  *q, *prev, *next;    q = ngx_queue_head(queue);    // 空隊列    if (q == ngx_queue_last(queue)) {        return;    }    for (q = ngx_queue_next(q); q != ngx_queue_sentinel(queue); q = next) {        prev = ngx_queue_prev(q);        next = ngx_queue_next(q);        ngx_queue_remove(q);        // 在已排好序的節點中，向前找比 q 的內容小的。比較的標準由 cmp 確定        do {            if (cmp(prev, q) <= 0) {                break;            }            prev = ngx_queue_prev(prev);        } while (prev != ngx_queue_sentinel(queue));        // 找到 prev 是比 q 的內容小的，在 prev 後面插入        ngx_queue_insert_after(prev, q);    }}

從上面可以看出，create 是從 pool 分配定義 list 結構的記憶體，分配表前端節點的記憶體。init 是初始化已有的 list。

Nginx源碼完全注釋（4）ngx_queue.h / ngx_queue.c