nginx源码学习1 ngx_queue

一直想研究下nginx源码，每次从main开始，总是会深入到各种细节无法整体。
所以想从基础的数据结构开始，再到系统的数据结构，毕竟好的项目知道数据结构，基本就可以了解项目的架构了。

//ngx_queue.h

/*
 * Copyright (C) Igor Sysoev
 * Copyright (C) Nginx, Inc.
 */


//#include <ngx_config.h>
//#include <ngx_core.h>
#include <stddef.h>//offsetof

#ifndef _NGX_QUEUE_H_INCLUDED_
#define _NGX_QUEUE_H_INCLUDED_
typedef int        ngx_int_t;

/*
--------
prev
next
只有前驱和后驱指针，没有分配内存的功能
--------
ngx_queue_init()
ngx_queue_empty()
ngx_queue_insert_head()
ngx_queue_insert_tail()
ngx_queue_head()
ngx_queue_tail()
ngx_queue_sentinel()
ngx_queue_remove()
ngx_queue_split()
ngx_queue_add()
ngx_queue_middle()
ngx_queue_sort()
_________
ngx_queue_next()
ngx_queue_prev()
ngx_queue_data()
ngx_queue_insert_after()
_________
*/

typedef struct ngx_queue_s  ngx_queue_t;

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

//q为哨兵节点
#define ngx_queue_init(q)                                                     \
    (q)->prev = q;                                                            \
    (q)->next = q

//h->prev为尾节点，h->next为头节点
#define ngx_queue_empty(h)                                                    \
    (h == (h)->prev)

/*
往链表h头部添加节点x，链表用哨兵表示
h为哨兵节点，x为数据节点
h->prev为链表尾节点，所以ngx_queue_empty(h)
h->next为链表头节点

1）将原来的头节点放到要插入节点x的next
2）原来的头节点(h->next)其prev变为新的头节点x
3）x变为头节点，其prev为哨兵h
4）哨兵的next变为x节点
*/
#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

/*
往链表h尾部插入节点x
1）h->prev为原尾节点，x变为尾节点，那x->prev就为h->prev
2）x变为尾节点，原尾节点的next应该为x
3）x为尾节点，其next为哨兵
4）哨兵的prev为新尾节点
*/
#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)->next


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

#endif

/*
链表h按元素q拆分，拆分后链表n的头节点为元素q，拆分后链表h不含元素q
1）h的尾节点赋值给n的尾节点
2）n的尾节点的next为哨兵n
3）n的头节点为q
4）h的尾节点为q的前一个节点
5）h的尾节点的next为哨兵h
6）q的prev为哨兵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添加到链表h
1）h的尾节点的next变为n的头节点
2）n的头节点的prev变为h的尾节点
3）h的尾节点变为n的尾节点
4）h的尾节点的next为哨兵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;

//获取数据，q为链表，type为包含ngx_queue_t的节点，link为ngx_queue_t的成员
#define ngx_queue_data(q, type, link)                                         \
    (type *) ((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

/*
 * Copyright (C) Igor Sysoev
 * Copyright (C) Nginx, Inc.
 */


//#include <ngx_config.h>
//#include <ngx_core.h>

#include "ngx_queue.h"
/*
 * 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 = ngx_queue_head(queue);

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

    next = ngx_queue_head(queue);
    //单双数  很有意思的算法
    //每次循环next比middle多走一步，如果next为尾节点，middle为中间节点
    //很经典的算法，面试经常考到
    for ( ;; ) {
        //第二个节点
        middle = ngx_queue_next(middle);
        //第二个节点
        next = ngx_queue_next(next);
        //就2个节点
        if (next == ngx_queue_last(queue)) {
            return middle;
        }
        //第三个节点
        next = ngx_queue_next(next);
        //有3个节点
        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);
        next = ngx_queue_next(q);

        ngx_queue_remove(q);

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

        } while (prev != ngx_queue_sentinel(queue));
        //q和prev换了下位置
        ngx_queue_insert_after(prev, q);
    }
}


//main.c 写着调着，有点乱
#include "ngx_queue.h"

#include <stdio.h>
#include <assert.h>
/*
--------
prev
next
--------
ngx_queue_init()
ngx_queue_empty()
ngx_queue_insert_head()
ngx_queue_insert_tail()
ngx_queue_head()
ngx_queue_tail()
ngx_queue_sentinel()
ngx_queue_remove()
ngx_queue_split()
ngx_queue_add()
ngx_queue_middle()
ngx_queue_sort()
_________
ngx_queue_next()
ngx_queue_prev()
ngx_queue_data()
ngx_queue_insert_after()
_________
*/

typedef struct{
    ngx_queue_t queue;
    int data;   
}my_queue;

int cmp(const ngx_queue_t *a, const ngx_queue_t *b)
{
    my_queue *pa = ngx_queue_data(a, my_queue, queue);
    my_queue *pb = ngx_queue_data(b, my_queue, queue);

    return (pa->data - pb->data);
}

int main(void)
{
    ngx_queue_t s;//sentinel
    ngx_queue_init(&s);

    my_queue node[6];
    for(int i=0; i<6; ++i){
        node[i].data = i;
    }

    assert(ngx_queue_empty(&s));
    assert(ngx_queue_sentinel(&s));

    ngx_queue_insert_head(&s, &node[4].queue);
    ngx_queue_insert_after(&s, &node[3].queue);
    ngx_queue_insert_tail(&s, &node[5].queue);

    ngx_queue_t *tmp;

    tmp = ngx_queue_head(&s);
    my_queue *m;
    m = ngx_queue_data(tmp, my_queue, queue);
    printf("3: %d\n", m->data);

    tmp = ngx_queue_last(&s);
    m = ngx_queue_data(tmp, my_queue, queue);
    printf("5: %d\n", m->data);

    tmp = ngx_queue_middle(&s);
    m = ngx_queue_data(tmp, my_queue, queue);
    printf("4: %d\n", m->data);

    ngx_queue_t q;
    ngx_queue_init(&q);
    for(int i=0; i<3; ++i){
        ngx_queue_insert_tail(&q, &node[i].queue);
    }

    ngx_queue_add(&q, &s);
    for(tmp=ngx_queue_head(&q); tmp!=ngx_queue_sentinel(&q); tmp=ngx_queue_next(tmp)){
        m = ngx_queue_data(tmp, my_queue, queue);
        printf("%d\n", m->data);
    }

    tmp = ngx_queue_middle(&q);
    m = ngx_queue_data(tmp, my_queue, queue);
    printf("middle 3: %d\n", m->data);

    ngx_queue_t n;
    ngx_queue_split(&q, tmp, &n);
    ngx_queue_remove(tmp);
    for(tmp=ngx_queue_head(&n); tmp!=ngx_queue_sentinel(&n); tmp=ngx_queue_next(tmp)){
        m = ngx_queue_data(tmp, my_queue, queue);
        printf("%d\n", m->data);
    }

    ngx_queue_insert_head(&q, &node[5].queue);
    ngx_queue_sort(&q, &cmp);
    for(tmp=ngx_queue_last(&q); tmp!=ngx_queue_sentinel(&q); tmp=ngx_queue_prev(tmp)){
        m = ngx_queue_data(tmp, my_queue, queue);
        printf("%d\n", m->data);
    }

    return 0;
}