1. 程式人生 > >Linux queue.h之TAILQ隊列分析

Linux queue.h之TAILQ隊列分析

freebsd free tel 所有 lis img 對象 processor 宏定義

轉自

這兩天想看看memcached的實現,所以先學習了libevent,使用起來還是比較簡單的,其實是對select/poll/kqueue等的封裝,學習libevent過程中又遇到了linux下隊列的使用,簡單分析如下,權當做記錄:

libevent中的例子中使用的是FreeBSD下的queue.h,在linux的/usr/include/sys/queue.h也有該頭文件,但是是一個縮減版本,而且沒有看到queue 的access method,不知道是不是跟我們的linux服務器版本有關,沒辦法google了一下,找到了FreeBSD 下queue.h的定義,我們看一下tail queue的定義

C代碼 技術分享圖片
  1. #define TAILQ_HEAD(name, type) \
  2. struct name { \
  3. struct type *tqh_first; /* first element */ \
  4. struct type **tqh_last; /* addr of last next element */\
  5. }
  6. #define TAILQ_ENTRY(type) \
  7. struct { \
  8. struct type *tqe_next; /* next element */ \
  9. struct type **tqe_prev;/* addr of previous next element*/ \
  10. }
  11. #define TAILQ_INIT(head) do { \
  12. (head)->tqh_first = NULL; \
  13. (head)->tqh_last = &(head)->tqh_first; \
  14. } while (0)
  15. #define TAILQ_INSERT_TAIL(head, elm, field) do { \
  16. (elm)->field.tqe_next = NULL; \
  17. (elm)->field.tqe_prev = (head)->tqh_last; \
  18. *(head)->tqh_last = (elm); \
  19. (head)->tqh_last = &(elm)->field.tqe_next; \
  20. } while (0)
  21. #define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \
  22. (elm)->field.tqe_prev = (listelm)->field.tqe_prev; \
  23. (elm)->field.tqe_next = (listelm); \
  24. *(listelm)->field.tqe_prev = (elm); \
  25. (listelm)->field.tqe_prev = &(elm)->field.tqe_next; \
  26. } while (0)
  27. #define TAILQ_FIRST(head) ((head)->tqh_first)
  28. #define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
  29. ....


我們就先分析上面的這些定義,先看個應用的例子

C代碼 技術分享圖片
  1. #include <stdio.h>
  2. #include <stdlib.h>
  3. #include "queue.h"
  4. struct QUEUE_ITEM{
  5. int value;
  6. TAILQ_ENTRY(QUEUE_ITEM) entries;
  7. };
  8. TAILQ_HEAD(,QUEUE_ITEM) queue_head;
  9. int main(int argc,char **argv){
  10. struct QUEUE_ITEM *item;
  11. struct QUEUE_ITEM *tmp_item;
  12. TAILQ_INIT(&queue_head);
  13. int i=0;
  14. for(i=5;i<10;i+=2){
  15. item=malloc(sizeof(item));
  16. item->value=i;
  17. TAILQ_INSERT_TAIL(&queue_head, item, entries);
  18. }
  19. struct QUEUE_ITEM *ins_item;
  20. ins_item=malloc(sizeof(ins_item));
  21. ins_item->value=100;
  22. TAILQ_INSERT_BEFORE(item,ins_item,entries);
  23. tmp_item=TAILQ_FIRST(&queue_head);
  24. printf("first element is %d\n",tmp_item->value);
  25. tmp_item=TAILQ_NEXT(tmp_item,entries);
  26. printf("next element is %d\n",tmp_item->value);
  27. tmp_item=TAILQ_NEXT(tmp_item,entries);
  28. printf("next element is %d\n",tmp_item->value);
  29. tmp_item=TAILQ_NEXT(tmp_item,entries);
  30. printf("next element is %d\n",tmp_item->value);
  31. }


結果:
Java代碼 技術分享圖片
  1. first element is 5
  2. next element is 7
  3. next element is 100
  4. next element is 9


分析:
QUEUE_ITEM 是我們定義的存放在隊列裏的東東,簡單起見只包括一個int值
TAILQ_ENTRY(QUEUE_ITEM) entries 主要是存放下一個對象和前一個對象的指針,具體見 header

根據頭文件進行宏替換後,實際我們聲明的是這樣的結構:

C代碼 技術分享圖片
  1. struct QUEUE_ITEM{
  2. int value;
  3. struct {
  4. struct QUEUE_ITEM *tqe_next;
  5. struct QUEUE_ITEM **tqe_prev;
  6. }entries;
  7. };


TAILQ_HEAD(,QUEUE_ITEM) queue_head; 實際是
C代碼 技術分享圖片
  1. struct {
  2. struct QUEUE_ITEM *tqh_first;
  3. struct QUEUE_ITEM **tqh_last;
  4. }queue_head;


接著我們定義了QUEUE_ITEM的兩個指針變量item和tmp_item

TAILQ_INIT(&queue_head); 相當於是
C代碼 技術分享圖片
  1. do {
  2. (&queue_head)->tqh_first = NULL;
  3. (&queue_head)->tqh_last = &(&queue_head)->tqh_first;
  4. } while (0);

head的初始化如 下圖1

接著我們通過循環分配了幾個元素,並賦值
C代碼 技術分享圖片
  1. TAILQ_INSERT_TAIL(&queue_head, item, entries); 相當於執行
  2. do {
  3. (item)->entries.tqe_next = NULL;
  4. (item)->entries.tqe_prev = (&queue_head)->tqh_last;
  5. *(&queue_head)->tqh_last = (item);
  6. (&queue_head)->tqh_last = &(item)->entries.tqe_next;
  7. } while (0);

也就是我們的循環執行下面代碼段,結果分析見圖2,3
C代碼 技術分享圖片
  1. for(i=5;i<10;i+=2){
  2. item=malloc(sizeof(item));
  3. item->value=i;
  4. do {
  5. (item)->entries.tqe_next = NULL;
  6. //首次執行相當於item->entries.tqe_prev=&(&queue_head)->tqh_first
  7. //以後執行相當於是(item)->entries.tqe_prev=&(前一個item)->entries.tqe_next;
  8. (item)->entries.tqe_prev = (&queue_head)->tqh_last;
  9. //首次執行相當於(&queue_head)->tqh_first=item
  10. //以後執行相當於是(前一個item)->entries.tqe_next=當前item
  11. *(&queue_head)->tqh_last = (item);
  12. (&queue_head)->tqh_last = &(item)->entries.tqe_next;
  13. } while (0);
  14. }

C代碼 技術分享圖片
  1. 最終建立的鏈表結構如圖,下面看一下insert操作,經過宏替換後代碼如下
  2. struct QUEUE_ITEM *ins_item;
  3. ins_item=malloc(sizeof(ins_item));
  4. ins_item->value=100;
  5. do {
  6. (ins_item)->entries.tqe_prev = (item)->entries.tqe_prev;
  7. (ins_item)->entries.tqe_next = (item);
  8. //這句話體現了TAILQ的特色,tqe_prev是前一個元素的下個元素地址,
  9. //所以正好應該是當前插入item的地址
  10. *(item)->entries.tqe_prev = (ins_item);
  11. (item)->entries.tqe_prev = &(ins_item)->entries.tqe_next;
  12. } while (0);


技術分享圖片

總結:TAILQ的最大特點就是每個entry的二級指針tqe_prev其存放的是前一個元素的下個元素地址,呵呵,聽起來都很拗口
我現在就是不知道為什麽linux的queue.h只有建立tailq的宏定義而缺少所有的access method,初涉linux c編程,請大家指教

附經過宏替換後的所有代碼
C代碼 技術分享圖片
  1. #include "stdio.h"
  2. #include "stdlib.h"
  3. struct QUEUE_ITEM{
  4. int value;
  5. struct {
  6. struct QUEUE_ITEM *tqe_next;
  7. struct QUEUE_ITEM **tqe_prev;
  8. }entries;
  9. };
  10. struct {
  11. struct QUEUE_ITEM *tqh_first;
  12. struct QUEUE_ITEM **tqh_last;
  13. }queue_head;
  14. int main(int argc,char **argv){
  15. struct QUEUE_ITEM *item;
  16. struct QUEUE_ITEM *tmp_item;
  17. do {
  18. (&queue_head)->tqh_first = NULL;
  19. (&queue_head)->tqh_last = &(&queue_head)->tqh_first;
  20. } while (0);
  21. int i=0;
  22. for(i=5;i<10;i+=2){
  23. item=malloc(sizeof(item));
  24. item->value=i;
  25. do {
  26. (item)->entries.tqe_next = NULL;
  27. //首次執行相當於item->entries.tqe_prev=&(&queue_head)->tqh_first
  28. //以後執行相當於是(item)->entries.tqe_prev=&(前一個item)->entries.tqe_next;
  29. (item)->entries.tqe_prev = (&queue_head)->tqh_last;
  30. //首次執行相當於(&queue_head)->tqh_first=item
  31. //以後執行相當於是(前一個item)->entries.tqe_next=當前item
  32. *(&queue_head)->tqh_last = (item);
  33. (&queue_head)->tqh_last = &(item)->entries.tqe_next;
  34. } while (0);
  35. }
  36. struct QUEUE_ITEM *ins_item;
  37. ins_item=malloc(sizeof(ins_item));
  38. ins_item->value=100;
  39. do {
  40. (ins_item)->entries.tqe_prev = (item)->entries.tqe_prev;
  41. (ins_item)->entries.tqe_next = (item);
  42. *(item)->entries.tqe_prev = (ins_item);
  43. (item)->entries.tqe_prev = &(ins_item)->entries.tqe_next;
  44. } while (0);
  45. tmp_item=((&queue_head)->tqh_first);
  46. printf("first element is %d\n",tmp_item->value);
  47. tmp_item=((tmp_item)->entries.tqe_next);
  48. printf("next element is %d\n",tmp_item->value);
  49. tmp_item=((tmp_item)->entries.tqe_next);
  50. printf("next element is %d\n",tmp_item->value);
  51. tmp_item=((tmp_item)->entries.tqe_next);
  52. printf("next element is %d\n",tmp_item->value);
  53. }

Linux queue.h之TAILQ隊列分析