關(guān)于llist.h文件中的鏈表宏講解

水積春塘晚，陰交夏木繁 ——唐·白居易

鏈表宏在linux內(nèi)核、鴻蒙內(nèi)核、rtos和一些開源代碼中用的非常多。鏈表宏是雙向鏈表的經(jīng)典實(shí)現(xiàn)方式，總代碼不超過50行，相當(dāng)精煉。在一些開源框架中，它的數(shù)據(jù)結(jié)構(gòu)，就是以鏈表宏為基礎(chǔ)進(jìn)行搭建(如shttpd，一個(gè)開源的輕量級(jí)、嵌入式服務(wù)器框架)。本篇文章將對(duì)llist.h文件中的鏈表宏進(jìn)行逐個(gè)講解。

1 源碼（llist.h）

llist.h文件的全部源碼如下：

#ifndefLLIST_HEADER_INCLUDED
#defineLLIST_HEADER_INCLUDED

/*
*Linkedlistmacros.
*/
structllhead{
structllhead*prev;
structllhead*next;
};

#defineLL_INIT(N)((N)->next=(N)->prev=(N))

#defineLL_HEAD(H)structllheadH={&H,&H}

#defineLL_ENTRY(P,T,N)((T*)((char*)(P)-offsetof(T,N)))

#defineLL_ADD(H,N)
do{
((H)->next)->prev=(N);
(N)->next=((H)->next);
(N)->prev=(H);
(H)->next=(N);
}while(0)

#defineLL_TAIL(H,N)
do{
((H)->prev)->next=(N);
(N)->prev=((H)->prev);
(N)->next=(H);
(H)->prev=(N);
}while(0)

#defineLL_DEL(N)
do{
((N)->next)->prev=((N)->prev);
((N)->prev)->next=((N)->next);
LL_INIT(N);
}while(0)

#defineLL_EMPTY(N)((N)->next==(N))

#defineLL_FOREACH(H,N)for(N=(H)->next;N!=(H);N=(N)->next)

#defineLL_FOREACH_SAFE(H,N,T)
for(N=(H)->next,T=(N)->next;N!=(H);
N=(T),T=(N)->next)

#endif/*LLIST_HEADER_INCLUDED*/

2 注解

在llist.h中，所用到的鏈表是雙向鏈表，其節(jié)點(diǎn)結(jié)構(gòu)定義如下。在此節(jié)點(diǎn)結(jié)構(gòu)中，其只包含了兩個(gè)指針域，一個(gè)指向直接前驅(qū)，一個(gè)指向直接后繼，沒有定義數(shù)據(jù)域。

structllhead{
structllhead*prev;
structllhead*next;
};

2.1 LL_INIT(N)

宏LL_INIT的定義如下，其作用是將所傳入指針N的兩個(gè)指針域(N)->next和(N)->prev都指向N。目的是完成單個(gè)節(jié)點(diǎn)的初始化工作，如下圖示意了該過程。

#defineLL_INIT(N)((N)->next=(N)->prev=(N))

2.2 LL_HEAD(H)

宏LL_HEAD的定義如下，直接將宏LL_HEAD展開，其意圖很明顯是定義一個(gè)新鏈表H（H表示為傳入宏的參數(shù)名），并且將H的兩個(gè)指針域，都初始化為H地址本身，如下圖示意了該過程。

#defineLL_HEAD(H)structllheadH={&H,&H}

2.3 LL_ENTRY(P,T,N)

宏LL_ENTRY的定義如下，其依賴于宏offsetof。下面先對(duì)宏offsetof進(jìn)行詳細(xì)描述，其功能描述為：

C語言的offsetof()宏，是定義在stddef.h。用于求出一個(gè)struct或union數(shù)據(jù)類型的給定成員的size_t類型的字節(jié)偏移值（相對(duì)于struct或union數(shù)據(jù)類型的開頭）。offsetof()宏有兩個(gè)參數(shù)，分別是結(jié)構(gòu)名與結(jié)構(gòu)內(nèi)的成員名?！S基百科

#defineLL_ENTRY(P,T,N)((T*)((char*)(P)-offsetof(T,N)))

#defineoffsetof(TYPE,MEMBER)((size_t)&((TYPE*)0)->MEMBER)

為了更好的理解宏offsetof，下面按照宏的定義來進(jìn)行拆解說明。

((TYPE *)0)：取整數(shù)零并將其強(qiáng)轉(zhuǎn)換為指向TYPE的指針。

((TYPE *)0)->MEMBER)：引用指向結(jié)構(gòu)成員MEMBER。

&((TYPE *)0)->MEMBER)：取出MEMBER的地址。

((size_t) &((TYPE *)0)->MEMBER)：將結(jié)果轉(zhuǎn)換為適當(dāng)?shù)臄?shù)據(jù)類型。

由于該結(jié)構(gòu)體是以0地址開頭，所以最后該宏返回的結(jié)果就是該成員相對(duì)于結(jié)構(gòu)體開頭的偏移量。有了對(duì)宏offsetof的理解，再來看宏LL_ENTRY就比較好理解了。宏LL_ENTRY的功能是，根據(jù)結(jié)構(gòu)體變量(T)中的域成員變量(N)的指針(P)來獲取指向整個(gè)結(jié)構(gòu)體變量的指針，下面來做拆解說明：

offsetof(T, N)：計(jì)算成員N相對(duì)于其結(jié)構(gòu)體T開頭的偏移量。

((char *)(P)：將指針P強(qiáng)轉(zhuǎn)為字符指針類型，保證其做+/-運(yùn)算時(shí)是以字節(jié)為單位。

(char *)(P) - offsetof(T, N))：P為成員N的指針，減去偏移量，指針到了結(jié)構(gòu)體開頭位置。

((T *)((char *)(P)- offsetof(T, N)))：將指針強(qiáng)轉(zhuǎn)，得到了整個(gè)結(jié)構(gòu)體指針。

宏LL_ENTRY的作用和linux中的宏container_of作用基本一樣，該宏定義如下：

#definecontainer_of(ptr,type,member)({
consttypeof(((type*)0)->member)*__mptr=(ptr);
(type*)((char*)__mptr-offsetof(type,member));})

2.4 LL_ADD(H, N)

宏LL_ADD的定義如下，其作用是向雙向鏈表H的頭部添加節(jié)點(diǎn)N。根據(jù)LL_ADD定義的語句順序，對(duì)照著圖片分析，會(huì)更加清晰。如下圖，上面這張圖片展示了添加節(jié)點(diǎn)N之前的結(jié)構(gòu)，下圖展示了添加節(jié)點(diǎn)N之后的結(jié)構(gòu)。

#defineLL_ADD(H,N)
do{
((H)->next)->prev=(N);
(N)->next=((H)->next);
(N)->prev=(H);
(H)->next=(N);
}while(0)

2.5 LL_TAIL(H, N)

宏LL_TAIL的定義如下，其作用是將節(jié)點(diǎn)N添加到雙向鏈表H的尾部。宏LL_TAIL的定義如下，其作用是向雙向鏈表H的頭部添加節(jié)點(diǎn)N。根據(jù)LL_TAIL定義的語句順序，對(duì)照著圖片分析，會(huì)更加清晰。如下圖，上面這張圖片展示了添加節(jié)點(diǎn)N之前的結(jié)構(gòu)，下圖展示了添加節(jié)點(diǎn)N之后的結(jié)構(gòu)，可以和LL_ADD的結(jié)果進(jìn)行對(duì)照。

#defineLL_TAIL(H,N)
do{
((H)->prev)->next=(N);
(N)->prev=((H)->prev);
(N)->next=(H);
(H)->prev=(N);
}while(0)

2.6 LL_DEL(N)

宏LL_DEL的定義如下，其作用是將節(jié)點(diǎn)N從雙向鏈表中刪除，并且節(jié)點(diǎn)N回到初始狀態(tài)(其指針僅指向自身，不再指向其它地方)。

#defineLL_DEL(N)
do{
((N)->next)->prev=((N)->prev);
((N)->prev)->next=((N)->next);
LL_INIT(N);
}while(0)

2.7 LL_EMPTY(N)

宏LL_EMPTY的定義如下，其作用是判斷鏈表N是否為空鏈表，返回布爾值false/true。如果節(jié)點(diǎn)的直接后繼next指向其自身，就認(rèn)為其為空節(jié)點(diǎn)。

#defineLL_EMPTY(N)((N)->next==(N))

2.8 LL_FOREACH(H,N)

宏LL_FOREACH的定義如下，其作用是在雙向鏈表H中，循環(huán)遍歷出節(jié)點(diǎn)。

#defineLL_FOREACH(H,N)for(N=(H)->next;N!=(H);N=(N)->next)

2.9 LL_FOREACH_SAFE(H,N,T)

宏LL_FOREACH_SAFE的定義如下，其作用是在雙向鏈表H中，循環(huán)遍歷出節(jié)點(diǎn)N，因?yàn)槠溆刑崆按鎯?chǔ)N的下一個(gè)節(jié)點(diǎn)T。即使N節(jié)點(diǎn)被清理掉，也不影響其下一個(gè)節(jié)點(diǎn)的遍歷，所以該宏一般用來做循環(huán)清除雙向鏈表中節(jié)點(diǎn)的操作，而宏LL_FOREACH僅用來遍歷雙向鏈表。

#defineLL_FOREACH_SAFE(H,N,T)
for(N=(H)->next,T=(N)->next;N!=(H);
N=(T),T=(N)->next)

3 使用案例

有人可能會(huì)有疑惑，這個(gè)雙向鏈表定義如此簡(jiǎn)單，只有前驅(qū)和后繼兩個(gè)指針，甚至連數(shù)據(jù)域都沒有，那實(shí)際該如何使用呢？這個(gè)可能就是這組雙向鏈表宏的精妙之處。其在使用過程中并不需要數(shù)據(jù)域，而是通過指針將結(jié)構(gòu)體串聯(lián)成雙向鏈表，并且通過該指針借助 LL_ENTRY宏 能還原出該結(jié)構(gòu)體指針，從而達(dá)到操作具體結(jié)構(gòu)體的目的。

如下例子雖然不是完整能跑的程序，但是足夠說明雙向鏈表宏的關(guān)鍵用法。程序源碼如下，現(xiàn)對(duì)照代碼，描述雙向鏈表宏的大致使用步驟：

定義一個(gè)結(jié)構(gòu)體，結(jié)構(gòu)體中必須包含struct llheadlink;雙向鏈表節(jié)點(diǎn)，這是后續(xù)能通過遍歷雙向鏈表節(jié)點(diǎn)，還原出該結(jié)構(gòu)體指針的關(guān)鍵；

通過LL_HEAD(listeners);，創(chuàng)建一個(gè)雙向鏈表的頭為listeners；

在具體邏輯中，肯定有地方通過LL_TAIL(&listeners, &l->link);或者LL_ADD(H, N)，向雙向鏈表的頭listeners添加節(jié)點(diǎn)；

在需要操作1.所定義的結(jié)構(gòu)體時(shí)，通過LL_FOREACH(&listeners, lp)遍歷出節(jié)點(diǎn)指針；

這是最精華的一步，通過4.遍歷出來的節(jié)點(diǎn)，傳入宏LL_ENTRY(lp, struct listener, link);中，還原出節(jié)點(diǎn)所在的結(jié)構(gòu)體指針，根據(jù)邏輯的需要對(duì)結(jié)構(gòu)體進(jìn)行具體相應(yīng)的操作；

通過宏LL_FOREACH_SAFE來遍歷雙向鏈表，LL_DEL來刪除遍歷出來的節(jié)點(diǎn)，達(dá)到清空鏈表的作用。

structllhead{
structllhead*prev;
structllhead*next;
};

structlistener{
structllheadlink;
structshttpd_ctx*ctx;/*Contextthatsocketbelongs*/
intsock;/*Listeningsocket*/
intis_ssl;/*ShouldbeSSL-ed*/
};

staticLL_HEAD(listeners);/*Listoflisteningsockets*/

structlistener*l;
LL_TAIL(&listeners,&l->link);

structllhead*lp;
LL_FOREACH(&listeners,lp){
l=LL_ENTRY(lp,structlistener,link);
FD_SET(l->sock,&read_set);
if(l->sock>max_fd)
max_fd=l->sock;
DBG(("FD_SET(%d)(listening)",l->sock));
}

structllhead*lp,*tmp;
LL_FOREACH_SAFE(&listeners,lp,tmp){
l=LL_ENTRY(lp,structlistener,link);
(void)closesocket(l->sock);
LL_DEL(&l->link);
free(l);
}

4 總結(jié)

LL_ENTRY(P,T,N)宏是這一組宏的核心，其在具體使用中的功能可以概括為，通過傳入鏈表節(jié)點(diǎn)P，還原出節(jié)點(diǎn)所在結(jié)構(gòu)體的指針，進(jìn)而能對(duì)結(jié)構(gòu)體進(jìn)行相應(yīng)操作；

這一組雙向鏈表宏其實(shí)形成的是一個(gè)循環(huán)雙向鏈表；

這些宏最初是極客寫出的，后來在Linux內(nèi)核中被推廣使用。

原文標(biāo)題：嵌入式開發(fā)中100%會(huì)用的幾個(gè)宏，建議收藏

文章出處：【微信公眾號(hào)：一口Linux】歡迎添加關(guān)注！文章轉(zhuǎn)載請(qǐng)注明出處。