libevent中的tail queue详细分析

libevent库中第一个出现的问题就是它的event结构体用了tail queue，这个结构是在linux中/usr/include/sys/queue.h定义。

libevent库中防止未定义又定义了一遍。

定义如下：

#define TAILQ_HEAD(name, type)              \
struct name {                       \
    struct type *tqh_first; /* first element */ \
    struct type **tqh_last; /* addr of last next element */\
}  
    
#define TAILQ_ENTRY(type)                   \
struct {                            \
    struct type *tqe_next;  /* next element */      \
    struct type **tqe_prev;/* addr of previous next element*/ \
}                                                                  
    
#define TAILQ_INIT(head) do {               \
    (head)->tqh_first = NULL;                \
    (head)->tqh_last = &(head)->tqh_first;        \
    } while (0)  
    
#define TAILQ_INSERT_TAIL(head, elm, field) do {        \
    (elm)->field.tqe_next = NULL;            \
    (elm)->field.tqe_prev = (head)->tqh_last;     \
    *(head)->tqh_last = (elm);               \
    (head)->tqh_last = &(elm)->field.tqe_next;        \
} while (0)  
    
#define TAILQ_INSERT_BEFORE(listelm, elm, field) do {       \
    (elm)->field.tqe_prev = (listelm)->field.tqe_prev;    \
    (elm)->field.tqe_next = (listelm);           \
    *(listelm)->field.tqe_prev = (elm);          \
    (listelm)->field.tqe_prev = &(elm)->field.tqe_next;   \
} while (0)  

#define TAILQ_FIRST(head)       ((head)->tqh_first)  
#define TAILQ_NEXT(elm, field)      ((elm)->field.tqe_next) 
#define TAILQ_LAST(head, headname)                  \
    (*(((struct headname *)((head)->tqh_last))->tqh_last))  
    /* XXX */  
#define TAILQ_PREV(elm, headname, field)                \
    (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))

实际上它就是一个双向链表，而且这个链表的head拥有一个指向链表第一个结点的first指针，和指向最后一个结点的next域地址的一个二级指针last。

这个last虽然是指向最后一个结点的next域地址，我们可以通过它来以O(1)时间找到链表最后一个结点。

prev和next相当于前驱和后继，实际上prev是一个二级指针，指向前驱的next域地址。

下面来分步分析：

1.初始化

#define TAILQ_INIT(head) do {               \
    (head)->tqh_first = NULL;                \
    (head)->tqh_last = &(head)->tqh_first;        \
    } while (0)  

这个相当于初始化head结点，效果如图：

注意：是first指向NULL，因为它没有下一个结点，last指向first的地址即可。

2.尾插

#define TAILQ_INSERT_TAIL(head, elm, field) do {        \
    (elm)->field.tqe_next = NULL;            \
    (elm)->field.tqe_prev = (head)->tqh_last;     \
    *(head)->tqh_last = (elm);               \
    (head)->tqh_last = &(elm)->field.tqe_next;        \
} while (0) 

效果如图：

注意：尾插是不用管head节点的first指针，只用管last指针就行了。

3.链表总体效果：

该链表就是一个head结点掌握头部和尾部，中间结点prev指向前一个节点的next域的地址，自己的next域指向下一个结点的地址。

4.重中之重：next和prev

#define TAILQ_ENTRY(type)                   \
struct {                            \
    struct type *tqe_next;  /* next element */      \
    struct type **tqe_prev;/* addr of previous next element*/ \
}     

不知道你有没有注意到，这里是先声明next,后声明prev。

这个和下面两个宏求值有关系，下面两个宏就是依赖于此的：

#define TAILQ_LAST(head, headname)                  \
    (*(((struct headname *)((head)->tqh_last))->tqh_last))  
    /* XXX */  
#define TAILQ_PREV(elm, headname, field)                \
    (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))

比如第一个：

      1.先求head->tqh_last 即最后一个结点的next域地址。

      2.强转为head结点类型，由于head结构体和普通节点内部的field结构体都是由一个指针和二级指针组成，大小是一样的。由于next域先声明，位于内存低位，它的地址加上偏移量4就可以调用prev。于是调用强转后的last就相当于调用prev，找到最后一个结点的上一个结点的next域地址，然后*解引用，即得到最后一个结点。这就是利用last二级指针来访问最后一个结点的精髓。

我参考了该博客： http://blog.csdn.net/yusiguyuan/article/details/19629659

示例如下：

#include <stdio.h>  
#include <stdlib.h>  
#include "my_queue.h"  

struct QUEUE_ITEM{  
    int value;  
    TAILQ_ENTRY(QUEUE_ITEM) entries;  
};

TAILQ_HEAD(,QUEUE_ITEM) queue_head;  
    
int main(int argc,char **argv){  
    struct QUEUE_ITEM *item;  
    struct QUEUE_ITEM *tmp_item;  
    
    TAILQ_INIT(&queue_head);  
    int i=0;  
    for(i=5;i<10;i+=2){  
        item=(QUEUE_ITEM*)malloc(sizeof(item));  
        item->value=i;  
        TAILQ_INSERT_TAIL(&queue_head, item, entries);  
    }   

    struct QUEUE_ITEM *ins_item;  
    ins_item=(QUEUE_ITEM*)malloc(sizeof(ins_item)); 
    ins_item->value=100;  
    TAILQ_INSERT_BEFORE(item,ins_item,entries);    
    tmp_item=TAILQ_FIRST(&queue_head);  
    printf("first element is %d\n",tmp_item->value);  
    tmp_item=TAILQ_NEXT(tmp_item,entries);  
    printf("next element is %d\n",tmp_item->value);  
    tmp_item=TAILQ_NEXT(tmp_item,entries); 
    printf("next element is %d\n",tmp_item->value);  
    tmp_item=TAILQ_NEXT(tmp_item,entries);  
    printf("next element is %d\n",tmp_item->value);
}