nginx源码剖析(三) —— ngx_queue_t分析

前言

由于之前一直使用的是nginx的1.6.2的版本，所以就以它作为研究对象进行分析，源码没有注释，这里我使用我之前加过注释的文件进行分析。这两个文件是在nginx-1.6.2/src/core的ngx_queue.h和ngx_queue.c文件。

正文

它的源码是通过带控制信息的双端链表实现的，以及它的具体操作是通过一些宏函数实现的。接下来我们一点点分析它的ngx_queue.h和ngx_queue.c文件。

1、ngx_queue.h的宏定义   _NGX_QUEUE_H_INCLUDED_。

          你会经常在开源的代码见到这样的宏定义，这样写的目的是为了防止出现重复包含头文件，造成一些错误。比如说，你第一次包含当前头文件的时候，满足条件，就会进行宏定义，否则就不会执行这段代码，具体它是这样实现的。

#ifndef _NGX_QUEUE_H_INCLUDED_            //保证该头文件不会被重复展开
#define _NGX_QUEUE_H_INCLUDED_


#endif /* _NGX_QUEUE_H_INCLUDED_ */

2、结构体的实现。

typedef struct ngx_queue_s  ngx_queue_t;

struct ngx_queue_s {
    ngx_queue_t  *prev;                  //指向前一个节点
    ngx_queue_t  *next;                  //指向后一个节点
};

3、队列的初始化(初始化控制信息)。

特别说明下：它的控制信息节点和其他的节点是一样的类型，该节点的prev数据域指向尾节点，next指向链表真实的第一个节点。

//初始化队列
#define ngx_queue_init(q)                                                     \
    (q)->prev = q;                                                            \
    (q)->next = q

4、队列的判空。

//队列判空
#define ngx_queue_empty(h)                                                    \
    (h == (h)->prev)

5、队列的头插。

//头插节点
#define ngx_queue_insert_head(h, x)                                           \
    (x)->next = (h)->next;                                                    \
    (x)->next->prev = x;                                                      \
    (x)->prev = h;                                                            \
    (h)->next = x

6、队列的尾插。

//尾插节点
#define ngx_queue_insert_tail(h, x)                                           \
    (x)->prev = (h)->prev;                                                    \
    (x)->prev->next = x;                                                      \
    (x)->next = h;                                                            \
    (h)->prev = x

7、获得队头节点。

//链表的头节点
#define ngx_queue_head(h)                                                     \
    (h)->next

8、获得对尾节点。

//链表的尾节点
#define ngx_queue_last(h)                                                     \
    (h)->prev

9、获得队列控制信息节点。

//链表的控制信息节点
#define ngx_queue_sentinel(h)                                                 \
    (h)

10、获得队列当前节点的后一个节点。

//当前元素的后一个元素
#define ngx_queue_next(q)                                                     \
    (q)->next

11、获得队列当前节点的前一个节点。

//当前元素的前一个元素
#define ngx_queue_prev(q)                                                     \
    (q)->prev

12、删除队列的当前节点(编译时加NGX_DEBUG参数)。

#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

13、删除队列的当前节点(编译时不加参数)。

#define ngx_queue_remove(x)                                                   \
    (x)->next->prev = (x)->prev;                                              \
    (x)->prev->next = (x)->next

#endif

14、分割队列。

//链表分割
#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;

15、链接队列。

//链接队列
#define ngx_queue_add(h, n)                                                   \
    (h)->prev->next = (n)->next;                                              \
    (n)->next->prev = (h)->prev;                                              \
    (h)->prev = (n)->prev;                                                    \
    (h)->prev->next = h;

16、获得队列的节点数据。

//获得节点数据
#define ngx_queue_data(q, type, link)                                         \
    (type *) ((u_char *) q - offsetof(type, link))

17、获得队列的中间节点。

//获得中间节点
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)) {
            return middle;
        }

        next = ngx_queue_next(next);

        if (next == ngx_queue_last(queue)) {
            return middle;
        }
    }
}

18、队列排序(使用插入排序)。

//插入排序
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);
        next = ngx_queue_next(q);

        ngx_queue_remove(q);

        do {
            if (cmp(prev, q) <= 0) {
                break;
            }

            prev = ngx_queue_prev(prev);

        } while (prev != ngx_queue_sentinel(queue));

        ngx_queue_insert_after(prev, q);
    }
}

小结：

       看完上面对于nginx队列部分的整个分析，如果有什么疑惑或者好的建议欢迎留言讨论。至此，nginx队列模块分析部分结束。