nginx queue

/*
 * Copyright (C) Igor Sysoev
 */




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




#ifndef _NGX_QUEUE_H_INCLUDED_
#define _NGX_QUEUE_H_INCLUDED_




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




#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)                                         \
    (type *) ((u_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_ */

/*
 * Copyright (C) Igor Sysoev
 */




#include <ngx_config.h>
#include <ngx_core.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


 怎样寻找队列中间的那个元素呢？ 用两个指针，一个指针next每次循环走两步，
 
 一个指针middle每次循环走1步，这样就能找到中间位置的元素了，就是middle


 */


ngx_queue_t *
ngx_queue_middle( ngx_queue_t *queue )
{
    ngx_queue_t  *middle, *next;


    middle = ngx_queue_head( queue ); //middle初始化指向第一个元素


    if ( middle == ngx_queue_last( queue ) )  //空链表，返回头部位置
{
        return middle;
    }


    next = ngx_queue_head( queue );  // next初始化也指向第一个元素


    for ( ; ; )
{
        middle = ngx_queue_next( middle );


        next = ngx_queue_next( next );


        if ( next == ngx_queue_last( queue  ) ) // next到了最后了，返回middle
{
            return middle;
        }


        next = ngx_queue_next( next );


        if ( next == ngx_queue_last( queue ) ) //next到了最后了，返回middle元素
{
            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 );


//将q从队列中卸下


        ngx_queue_remove( q );


//按照排序规则，向前找到q这个元素应该插入的位置，插入


        do 
{
            if ( cmp( prev, q ) <= 0 )  // 比较函数可以设定为升序或者是降序 
{
                break;
            }


            prev = ngx_queue_prev( prev );


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


//将q插入到prev的后面


        ngx_queue_insert_after( prev, q );
    }
}