nginx進階資料結構源碼分析（一）-----雙向連結清單

ng_queue_t是Nginx提供的一個順序容器，它以雙向連結清單的方式将資料組織在一起。

連結清單作為順序容器的優勢在于，它可以高效的執行插入、删除、合并等操作，在移動連結清單中的元素時隻需要修改指針的指向，是以，它很适合頻繁修改容器的場合。

相對于其他順序容器，它的優勢有以下三點：

  （1）  實作了排序功能，采用額是插入排序，雖然不太适合超大規模資料的排序，但是簡單實用。

（2）  它非常輕量級，不負責連結清單元素所占記憶體的配置設定。ngx_queue_t隻是把這些配置設定号記憶體的元素用雙向連結清單連結起來

（3）  支援兩個連結清單的合并。

Nginx在設計這個雙向連結清單時，由于容器與元素共用了ngx_queue_t結構體，為了避免此結構體成員的意義混亂，Nginx封裝了連結清單容器與元素的所有方法。

ngx_queue_t的頭檔案：

typedef struct ngx_queue_s  ngx_queue_t;

struct ngx_queue_s {
    ngx_queue_t  *prev;
    ngx_queue_t  *next;
};


#define ngx_queue_init(q)                                                     \初始化，為空，都指向容器結構體
    (q)->prev = q;                                                            \
    (q)->next = q


#define ngx_queue_empty(h)                                                    \是否為空
    (h == (h)->prev)


#define ngx_queue_insert_head(h, x)                                           \插傳入連結表容器頭部
    (x)->next = (h)->next;                                                    \
    (x)->next->prev = x;                                                      \
    (x)->prev = h;                                                            \
    (h)->next = x


#define ngx_queue_insert_after   ngx_queue_insert_head


#define ngx_queue_insert_tail(h, x)                                           \插傳入連結表容器尾部
    (x)->prev = (h)->prev;                                                    \
    (x)->prev->next = x;                                                      \
    (x)->next = h;                                                            \
    (h)->prev = x


#define ngx_queue_head(h)                                                     \傳回第一個結構體指針
    (h)->next


#define ngx_queue_last(h)                                                     \傳回最後一個結構體指針
    (h)->prev


#define ngx_queue_sentinel(h)                                                 \傳回容器結構體指針
    (h)


#define ngx_queue_next(q)                                                     \傳回q的下一個元素
    (q)->next


#define ngx_queue_prev(q)                                                     \傳回q的上一個元素
    (q)->prev


#if (NGX_DEBUG)

#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
    (x)->next->prev = (x)->prev;                                              \
    (x)->prev->next = (x)->next

#endif


#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;


#define ngx_queue_add(h, n)                                                   \合并連結清單
    (h)->prev->next = (n)->next;                                              \
    (n)->next->prev = (h)->prev;                                              \
    (h)->prev = (n)->prev;                                                    \
    (h)->prev->next = h;


#define ngx_queue_data(q, type, link)                                         \傳回q所屬結構體位址
    (type *) ((u_char *) q - offsetof(type, link))
           

ngx_queue_t的實作檔案中隻有兩個方法：一個是傳回連結清單中的中心元素，還有一個是對連結清單排序。

ngx_queue_t *
ngx_queue_middle(ngx_queue_t *queue)                       //傳回連結清單中心元素
{
    ngx_queue_t  *middle, *next;

    middle = ngx_queue_head(queue);

    if (middle == ngx_queue_last(queue)) {               //特殊情況也要單獨判斷，如果隻有一個，則傳回這個元素
        return middle;
    }

    next = ngx_queue_head(queue);

    for ( ;; ) {
        middle = ngx_queue_next(middle);                 //一個指針走一步，另外一個指針走兩步

        next = ngx_queue_next(next);

        if (next == ngx_queue_last(queue)) {              //next每走一步都要判斷一下的
            return middle;
        }

        next = ngx_queue_next(next);

        if (next == ngx_queue_last(queue)) {               //這也要判斷，考慮真全面啊
            return middle;
        }
    }
}


/* the stable insertion sort */

void
ngx_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);  //分别儲存q的前後節點
        next = ngx_queue_next(q);

        ngx_queue_remove(q);

        do {
            if (cmp(prev, q) <= 0) {  //若prev小于，這個循環結束
                break;
            }

            prev = ngx_queue_prev(prev);//否則跟前面一個元素比

        } while (prev != ngx_queue_sentinel(queue));//這個為結束條件，prev為連結清單結構體結束

        ngx_queue_insert_after(prev, q);//插入q
    }
}