(轉)深入理解TAILQ佇列
又開始看libevent了,發現自己已經忘了它使用的基本資料結構,當初看的時候沒有做筆記,結果就是現在又要重看一遍。
發現一個不錯的文章。這個實現主要的不同是使用了二級指標。
先給出一個二級指標的例子。下面這個是個不好的反例,argc需要傳遞tv和time_event進去,所以需要使用結構體。
我們使用了全域性變數和一個二維指標,儲存了time_event的地址。如果使用結構體,那麼儲存的地址需要先初始化。
struct timeval tv; void time_cb(int fd, short event, void *argc) { printf("timer wakeup/n"); event_add((*(struct event**)(argc)), &tv); // reschedule timer } int main(int argc, char **argv) { struct event_base *base = event_base_new(); struct evconnlistener *listener; struct event *signal_event; //void* arg=nullptr; //{ tv.tv_sec = 10; // 10s period tv.tv_usec = 0; struct event *time_event = evtimer_new(base, time_cb, &time_event); evtimer_add(time_event, &tv); //} ....
}
工作的主要內容是tcp/ip,平臺是FreeBSD,而且在核心態開發,所以很多情況下會涉及核心的一些資料結構和巨集,比如說mbuf和TAILQ等。 TAILQ是FreeBSD/linux核心對雙向佇列操作的一種抽象,抽象程度不亞於C++,能實現操作佇列需要的各種操作:插入元素,刪除元素,遍歷佇列等。這個佇列的優點是插入元素很快。 這裡先回顧一下佇列的特點(來自維基百科
佇列,又稱為佇列(英文queue),是先進先出(FIFO, First-In-First-Out)的線性表。在具體應用中通常用連結串列或者陣列來實現。
FreeBSD中的TAILQ把整個佇列頭抽象為一個單獨的資料結構,我們先看看FreeBSD中的TAILQ相關巨集,然後再舉例子理解這些巨集。 這裡用最簡單的一個結構體來理解TAILQ,這個結構體中有一個int型整數,還有兩個分別指向前方和後方的指標。
1.描述前一個和下一個元素的結構體
458 #define TAILQ_ENTRY(type) \ 459 struct { \ 460 struct type *tqe_next; /* next element */ \ 461 struct type **tqe_prev; /* address of previous next element */ \ 462 TRACEBUF \ 463 }
這是TAILQ對兩個指向前後兩個元素指標的抽象,抽象為TAILQ_ENTRY結構體:tqe_next是指向下一個元素的指標,tqe_prev是一個二級指標,指標變數的地址,是前一個元素的tqe_next的地址,解引用(*tqe_prev)之後就是本元素的記憶體地址;TRACEBUF是一個除錯相關的巨集,我們先不管它。舉例: 我們宣告一個結構體,這個結構體只有一個int型整數,還有前驅和後繼指標。
struct int_node{ int num; TAILQ_ENTRY(int_node); };
巨集展開之後就變成:
struct int_node{ int num; struct { struct int_node *tqe_next; /* next element */ sturct int_node **tqe_prev; /* address of previous next element */ }; };
例如:
2.佇列頭
TAILQ把整個佇列頭單獨抽象為一個結構體TAILQ_HEAD,如下:
445 /* 446 * Tail queue declarations. 447 */ 448 #define TAILQ_HEAD(name, type) \ 449 struct name { \ 450 struct type *tqh_first; /* first element */ \ 451 struct type **tqh_last; /* addr of last next element */ \ 452 TRACEBUF \ 453 }
這個巨集實際上使用的時候,會展開成為一個結構體,tqh_first是一個一級指標,指向佇列中的第一個元素;tqh_last是一個二級指標,它指向最後一個元素中的tqe_next(請參考上面的TAILQ_ENTRY),也就是最後一個元素的tqe_next的地址,指標的地址就是二級指標;TRACEBUF是一個用來除錯的巨集,不用管它。舉例: 宣告一個叫做queue_head的佇列頭:
TAILQ_HEAD(int_head, int_node) queue_head;
巨集展開之後就會變成(不管TRACEBUF巨集):
struct int_head { struct int_node *tqh_first; /* first element */ struct int_node **tqh_last; /* addr of last next element */ } queue_head;
如圖:用下面的巨集初始化這個佇列頭:
534 #define TAILQ_INIT(head) do { \ 535 TAILQ_FIRST((head)) = NULL; \ 536 (head)->tqh_last = &TAILQ_FIRST((head)); \ 537 QMD_TRACE_HEAD(head); \ 538 } while (0)
變成:
3.插入元素
插入元素用TAILQ_INSERT_TAIL巨集,由於TAILQ中有一個tqh_last的二級指標,所以插入元素直接插到隊尾,僅用O(1)時間。
578 #define TAILQ_INSERT_TAIL(head, elm, field) do { \ 579 QMD_TAILQ_CHECK_TAIL(head, field); \ 580 TAILQ_NEXT((elm), field) = NULL; \ 581 (elm)->field.tqe_prev = (head)->tqh_last; \ 582 *(head)->tqh_last = (elm); \ 583 (head)->tqh_last = &TAILQ_NEXT((elm), field); \ 584 QMD_TRACE_HEAD(head); \ 585 QMD_TRACE_ELEM(&(elm)->field); \ 586 } while (0)
QMD_TAILQ_CHECK_TAIL,QMD_TRACE_HEAD,QMD_TRACE_ELEM這三個巨集和除錯資訊相關和做一些必要的檢查,我們可以先不管;這個巨集就是在調整相關的指標指向。我們向一個空佇列插入兩個元素2來理解這個巨集: 3.1 580行讓新元素的tqe_next指向空,執行完第580行:3.2 581行讓新元素的tqe_prev賦值為tqh_last,也就是指向佇列頭中的tqh_first的地址,執行完第581行:3.3 582行讓二級指標tqh_last中的內容指向新元素,也就是tqh_first指向新元素,執行完第582行:3.4 583行,佇列頭的tqh_last賦值為新元素的tqe_next的地址(指標的地址,二級指標),執行完第583行:這就是插入2後的整個連結串列。
4.刪除元素
刪除元素用TAILQ_REMOVE巨集
596 #define TAILQ_REMOVE(head, elm, field) do { \ 597 QMD_SAVELINK(oldnext, (elm)->field.tqe_next); \ 598 QMD_SAVELINK(oldprev, (elm)->field.tqe_prev); \ 599 QMD_TAILQ_CHECK_NEXT(elm, field); \ 600 QMD_TAILQ_CHECK_PREV(elm, field); \ 601 if ((TAILQ_NEXT((elm), field)) != NULL) \ 602 TAILQ_NEXT((elm), field)->field.tqe_prev = \ 603 (elm)->field.tqe_prev; \ 604 else { \ 605 (head)->tqh_last = (elm)->field.tqe_prev; \ 606 QMD_TRACE_HEAD(head); \ 607 } \ 608 *(elm)->field.tqe_prev = TAILQ_NEXT((elm), field); \ 609 TRASHIT(*oldnext); \ 610 TRASHIT(*oldprev); \ 611 QMD_TRACE_ELEM(&(elm)->field); \ 612 } while (0)
QMD_SAVELINK,QMD_TAILQ_CHECK_NEXT,QMD_TAILQ_CHECK_PREV,TRASHIT,同樣先不管這幾個巨集。我們從佇列中刪除一個元素來理解這個巨集: 4.1 假設經過上節插入元素2之後,我們用TAILQ_INSERT_TAIL再插入一個元素1,沒有刪除之前的連結串列如下圖:現在假設我們刪除佇列中的第一個元素2 4.2 602和603在調整當前元素的下一個元素的tqe_prev指標,執行完第602行和603行之後:4.3 608調整當前元素tqe_prev中的內容,執行完第608行之後:4.4 釋放結點2的空間之後,最後的連結串列:
5.佇列中的第一個元素
512 #define TAILQ_FIRST(head) ((head)->tqh_first)
6.當前元素的下一個元素
591 #define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
這個巨集比較簡單。
7.遍歷連結串列中的每一個元素
用巨集TAILQ_FOREACH
514 #define TAILQ_FOREACH(var, head, field) \ 515 for ((var) = TAILQ_FIRST((head)); \ 516 (var); \ 517 (var) = TAILQ_NEXT((var), field))