list_for_each_entry/list_entry/container_of

参考：

http://blog.sina.com.cn/s/blog_5e99b41e0100rxgf.html

http://hi.baidu.com/shiftedmind/blog/item/1a7c8381e6a67fa56d8119da.html

         在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()循环

………………

}

宏list_for_each_entry的实现：

[cpp] view plaincopyprint?

1. /** 
2.  * list_for_each_entry  -   iterate over list of given type 
3.  * @pos:    the type * to use as a loop cursor. 
4.  * @head:   the head for your list. 
5.  * @member: the name of the list_struct within the struct. 
6.  */  
7. #define list_for_each_entry(pos, head, member)              \  
8.     for (pos = list_entry((head)->next, typeof(*pos), member);   \  
9.          prefetch(pos->member.next), &pos->member != (head);  \  
10.          pos = list_entry(pos->member.next, typeof(*pos), member))  

/**
 * list_for_each_entry	-	iterate over list of given type
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 */
#define list_for_each_entry(pos, head, member)				\
	for (pos = list_entry((head)->next, typeof(*pos), member);	\
	     prefetch(pos->member.next), &pos->member != (head); 	\
	     pos = list_entry(pos->member.next, typeof(*pos), member))

对程序中for循环的三步分析：

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

         pos相当于循环中返回的循环变量，这里就是返回一个结构体指针。实现过程如下：

函数list_entry():

[cpp] view plaincopyprint?

1. /** 
2.  * list_entry - get the struct for this entry 
3.  * @ptr:    the &struct list_head pointer. 
4.  * @type:   the type of the struct this is embedded in. 
5.  * @member: the name of the list_struct within the struct. 
6.  */  
7. #define list_entry(ptr, type, member) \  
8.     container_of(ptr, type, member)  

/**
 * list_entry - get the struct for this entry
 * @ptr:	the &struct list_head pointer.
 * @type:	the type of the struct this is embedded in.
 * @member:	the name of the list_struct within the struct.
 */
#define list_entry(ptr, type, member) \
	container_of(ptr, type, member)

跟进：container_of这个函数：

         这个不做重点分析，这个函数的做用是：它的作用显而易见，那就是根据一个结构体变量中的一个域成员变量的指针来获取指向整个结构体变量的指针。

[cpp] view plaincopyprint?

1. /** 
2.  * container_of - cast a member of a structure out to the containing structure 
3.  * @ptr:    the pointer to the member. 
4.  * @type:   the type of the container struct this is embedded in. 
5.  * @member: the name of the member within the struct. 
6.  * 
7.  */  
8. #define container_of(ptr, type, member) ({          \  
9.     const typeof(((type *)0)->member)*__mptr = (ptr);    \  
10.              (type *)((char *)__mptr - offsetof(type, member)); })  

/**
 * container_of - cast a member of a structure out to the containing structure
 * @ptr:    the pointer to the member.
 * @type:   the type of the container struct this is embedded in.
 * @member: the name of the member within the struct.
 *
 */
#define container_of(ptr, type, member) ({          \
	const typeof(((type *)0)->member)*__mptr = (ptr);    \
		     (type *)((char *)__mptr - offsetof(type, member)); })

所以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。