nginx之queue的具体使用

目录一、简介二、数据结构三、相关API3.1 初始化一个队列3.2 判断队列是否为空3.3 队头插入节点3.4 队尾插入节点3.5 从队列中移除某个节点3.6 将队列从某个节点拆分成两个队列3.7 将两个队列合并成一个队列3.8 队列排序3.9 获取队列中间节点3.10 获取原始数据

一、简介

​ nginx队列和linux内核中的链表有一样的结构，只有一个连接头（只有两个指针），任何包含这个结构的数据都可以连接在一起。有点像物联网，万物互联，只要能上网都可以连接。

​ nginx队列是带头节点的一个双向链表。

二、数据结构

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

三、相关API

3.1 初始化一个队列

#define ngx_queue_init(q) (q)->prev = q; (q)->next = q

3.2 判断队列是否为空

只有一个头节点，则为空。有头节点的双向链表相比无头的双向链表，各种插入、删除等操作都更简单。

#define ngx_queue_empty(h) (h == (h)->prev)

3.3 队头插入节点

#define ngx_queue_insert_head(h, x) (x)->next = (h)->next; (x)->next->prev = x; (x)->prev = h; (h)->next = x

头部插入节点后

3.4 队尾插入节点

#define ngx_queue_insert_tail(h, x) (x)->prev = (h)->prev; (x)->prev->next = x; (x)->next = h; (h)->prev = x

尾部插入节点后

3.5 从队列中移除某个节点

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

移除x节点后

可以看到移除节点x后，x和队列还有一定的联系，所以对x的操作一定要小心，不然可能将整个队列损坏。一般将x->prev,x->next都置空。

3.6 将队列从某个节点拆分成两个队列

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

将队列h从节点q拆分为h和n两个队列，并且q节点在n队列中。

拆分完后

3.7 将两个队列合并成一个队列

#define ngx_queue_add(h, n) (h)->prev->next = (n)->next; (n)->next->prev = (h)->prev; (h)->prev = (n)->prev; (h)->prev->next = h;

合并后

3.8 队列排序

#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 #define ngx_queue_insert_after ngx_queue_insert_head

使用标准的插入排序算法，通过传递的回调函数cmp进行比较，将整个队列排序。

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); } }

3.9 获取队列中间节点

通过快慢指针的方式获取中间节点。

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

3.10 获取原始数据

#define ngx_queue_data(q, type, link) (type *) ((u_char *) q – offsetof(type, link))

从队列中获取的节点类型都是ngx_queue_s，而不是实际的数据类型，需要将ngx_queue_s转换为原始的类型。其中offsetof是一个内置的表达式，计算某个成员变量在类型中的偏移量。

通过偏移计算到计算到原始类型地址，然后进行类型强转获取原始类型。

比如如下调用q = ngx_queue_last(&cache->expire_queue); file = ngx_queue_data(q, ngx_cached_open_file_t, queue);

q的地址减去offset获取到ngx_cached_open_file_t的地址，然后在强转为对应的类型。