Nginx数据结构之ngx_queue_t

Nginx数据结构之ngx_queue_t

ngx_queue_t是具有头结点的双向链表结构
链表作为顺序容器的优势,高效插入、删除、合并操作
优势

  1. 实现了排序功能
  2. 非常轻量级,是一个纯粹的双向链表,他不负责链表所占内存的分配
  3. 支持链表合并

初始结构

代码展现

1
2
3
4
5
6
7
8
9
10
11
12
13

/**
* 队列结构,其实质是具有头节点的双向循环链表
*/
typedef struct ngx_queue_s ngx_queue_t;

/**
* 队列中每个节点结构,只有两个指针,并没有数据区
*/
struct ngx_queue_s {
ngx_queue_t *prev;
ngx_queue_t *next;
};

图解

基础宏

ngx_queue_init 代码

1
2
3
4
5
6
7
/**
* q为链表容器结构体ngx_queue_t的指针
* 链表容器q初始化,会设置为空的链表
*/
#define ngx_queue_init(q) \
(q)->prev = q; \
(q)->next = q

ngx_queue_init 图解

ngx_queue_empty 代码

1
2
3
4
5
/**
* 检测链表容器是否为空
*/
#define ngx_queue_empty(h) \
(h == (h)->prev)

ngx_queue_insert_head 代码

1
2
3
4
5
6
7
8
9
10
/**
* 将元素x,插入h链表的头部
*/
#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

ngx_queue_insert_head 图解

ngx_queue_insert_tail 代码

1
2
3
4
5
6
7
8
/**
* 将元素x,插入h链表的尾部
*/
#define ngx_queue_insert_tail(h, x) \
(x)->prev = (h)->prev; \
(x)->prev->next = x; \
(x)->next = h; \
(h)->prev = x

ngx_queue_insert_tail 图解

ngx_queue_split 代码

1
2
3
4
5
6
7
8
9
10
11
12
/**
* h为链表容器结构体ngx_queue_t的指针 该函数用于拆分链表
* h是链表容器,而q是链表h中的一个元素。
* 将链表h以元素q为界拆分成两个链表 h 和 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;

ngx_queue_split 图解

ngx_queue_add 代码

1
2
3
4
5
6
7
8
9
/**
* h为链表容器结构体ngx_queue_t的指针,n为另一个链表容器结构体ngx_queue_t的指针
* 合并链表,将n链表添加到h链表的末尾
*/
#define ngx_queue_add(h, n) \
(h)->prev->next = (n)->next; \
(n)->next->prev = (h)->prev; \
(h)->prev = (n)->prev; \
(h)->prev->next = h;

ngx_queue_add 图解

基础宏

代码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/**
* 链表的头元素
*/
#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)->next

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

函数

ngx_queue_middle 代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/**
* 找中间元素
*/
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);

//开始循环
//1.采用了每循环一次,middle向后移一个指针
//2.每循环一次,next向后移动两个指针
//3.middle走一步,next走两步,当next走到尾元素,则正好输出middle,完美
for ( ;; ) {
//从头元素开始,middle依次向后,每循环一次,向后移一个指针
middle = ngx_queue_next(middle);

//也是从头元素开始,next,每循环一次,向后移动两个指针
//next每移动一次之后,要判读next与最后一个元素是否相等
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;
}
}
}

ngx_queue_sort 排序代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/**
* 无须的双向链表,排序成有序的双向链表 很好玩,很精妙的逻辑
*/
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);

//移除q元素
ngx_queue_remove(q);

//该循环保证了,q大于prev的最大值,一定q放在了最大值prev的后面
do {
//当q大于prev时,退出循环
if (cmp(prev, q) <= 0) {
break;
}

prev = ngx_queue_prev(prev);

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

//将q元素插入在prev的后面,保证q元素大于prev
ngx_queue_insert_after(prev, q);
}
}

代码注释 https://github.com/gxpisme/read_nginx/commit/4bd1d147dd92d8c93ad89a53236c7309484c5940

xpisme wechat
微信号