list_for_each_entry淺析

list_for_each原型：

#define list_for_each(pos, head) \

 

for (pos = (head)->next, prefetch(pos->next); pos !=

(head); \

 

pos = pos->next, prefetch(pos->next))

它實際上是一個 for 循環，利用傳入的 pos 作為循環變量，從表頭 head 開始，逐項向后（ next

方向）移動 pos ，直至又回到 head （ prefetch() 可以不考慮，用於預取以提高遍歷速度）。

注意：此宏必要把list_head放在數據結構第一項成員，至此，它的地址也就是結構變量

的地址。

list_for_each_entry：

在Linux內核源碼中，經常要對鏈表進行操作，其中一個很重要的宏是list_for_each_entry：
意思大體如下：
假設只有兩個結點，則第一個member代表head，
list_for_each_entry的作用就是循環遍歷每一個pos中的member子項。

圖1：


宏list_for_each_entry: 

1.    
2. 406#define list_for_each_entry(pos, head, member)                          \
3. 407        for (pos = list_entry((head)->next, typeof(*pos), member);      \
4. 408             prefetch(pos->member.next), &pos->member != (head);        \
5. 409             pos = list_entry(pos->member.next, typeof(*pos), member))

復制代碼
list_entry((head)->next, typeof(*pos), member)返回(head)->next物理指針所處位置向前減去offsetof()個字節數據之后, 其父變量pos的物理地址,父變量的類型在編譯時由typeof(*pos)自動返回.
所以list_for_each_entry遍歷head 下面掛接的類型為typeof(*pos)的childs結構體們,當然每個child結構體包含struct list_head node之類相似的雙向鏈表list_head類型項,就這樣通過循環pos將依次指向雙向鏈表上的各個child.(member就是child類型中 被定義的變量名)

其中用到了函數list_entry():
這個函數的作用在圖1中表示就是可以通過已知的指向member子項的指針，獲得整個結構體的指針（地址）

2. 334#define list_entry(ptr, type, member) \
3. 335        container_of(ptr, type, member)

復制代碼
和函數prefetch：

1. #define prefetch(x) __builtin_prefetch(x)

復制代碼
其中用到了builtin_prefetch:
prefetch的含義是告訴cpu那些元素有可能馬上就要用到，告訴cpu預取一下，這樣可以提高速度
其中用到了函數container_of():

2. 493#define container_of(ptr, type, member) ({                      \
3. 494        const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
4. 495        (type *)( (char *)__mptr - offsetof(type,member) );})

其中又用到了offsetof（）函數：
lxr上找到的源碼：

1. #define offset_of(type, memb) \
2.   47        ((unsigned long)(&((type *)0)->memb))

offsetof(TYPE, MEMBER)
該宏在Linux內核代碼(版本2.6.22)中定義如下：
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER); 
分析：
(TYPE *)0,將 0 強制轉換為 TYPE 型指針，記 p = (TYPE *)0，p是指向TYPE的指針，它的值是0。那么 p->MEMBER 就是 MEMBER 這個元素了，而&(p->MEMBER)就是MENBER的地址，而基地址為0，這樣就巧妙的轉化為了TYPE中的偏移量。再把結果強制轉 換為size_t型的就OK了，size_t其實也就是int。
typedef __kernel_size_t  size_t;
typedef unsigned int __kernel_size_t; 
可見，該宏的作用就是求出MEMBER在TYPE中的偏移量。

  在Linux內核源碼中，經常要對鏈表進行操作，其中一個很重要的宏是list_for_each_entry：

意思大體如下：

         假設下面幾個結點，則第一個member代表head，list_for_each_entry的作用就是循環遍歷每一個pos中的member子項。

list_for_each_entry應用：

         它實際上是一個 for 循環，利用傳入的 pos 作為循環變量，從表頭 head 開始，逐項向后（next 方向）移動 pos，直至又回head（prefetch() 可以不考慮，用於預取以提高遍歷速度 ）。 

在程序中的使用如下：

list_for_each_entry（pos , head,member）

{       

………………

      addr =    pos;  //對返回值pos的操作，這樣更容易去理解list_for_each_entry，可以把它看作for()循環

………………

}

對程序中for循環的三步分析：

（1），pos = list_entry((head)->next, typeof(*pos), member)

         pos相當於循環中返回的循環變量，這里就是返回一個結構體指針。實現過程如下：

跟進：container_of這個函數：

         這個不做重點分析，這個函數的做用是：它的作用顯而易見，那就是根據一個結構體變量中的一個域成員變量的指針來獲取指向整個結構體變量的指針。

 

所以list_entry()的作用為：如上圖所示，可以以通過已知的指向member子項的指針，獲得整個結構體的指針（地址）

 

（2），   prefetch(pos->member.next),&pos->member!= (head);  

 

         prefetch的含義是告訴cpu那些元素有可能馬上就要用到，告訴cpu預取一下，這樣可以提高速度，用於預取以提高遍歷速度；

 

         &pos->member !=(head)  ，這個判斷循環條件。

 

（3），  pos= list_entry(pos->member.next, typeof(*pos), member)) 

 

         和第（1）實現相似，用於逐項向后（next 方向）移動 pos。