Linux内核链表及list_entry解析

链表是一些包含数据的独立数据结构的集合，链表中的每一个节点通过链或者指针连接在一起。程序通过指针访问链表中的节点。链表一般分为单链表和双链表。

1.单链表

单链表中，每个节点包含指向下一个节点的指针。链表最有一个节点的指针字段值为NULL，表明链表后面不再有其它节点。下面是一张单链表的图：

对应的数据结构为：

C代码  

1. typedef struct NODE  
2. {  
3.     int value;  
4.     struct NODE *next;        
5. }Node;  

2.双链表

在一个双链表中，每个节点都包含两个指针——指向前一个节点的指针和指向后一个节点的指针。这样的好处是我们可以从任何方向遍历双链表。

对应的节点数据类型为：

C代码  

1. typedef struct NODE  
2. {  
3.     int value;  
4.     struct NODE *fwd;         
5.     struct NODE *bwd;  
6. }Node;  

3.linux内核链表

此处以2.6.31.13内核版本作为分析基础。不同版本之间的区别不大。链表结构定义为（节选自include/linux/list.h）：

C代码  

1. struct list_head {  
2.     struct list_head *next, *prev;  
3. };  

  内核链表包含指向next和prev的指针，是一个双链表，不过不同于一般的双链表，内核链表不包含数据域，通常被用作双循环链表，当需要用到十字链表时，使用内核链表也很方便。

3.1 声明和初始化

linux内核提供了两种方式初始化链表。一种是使用LIST_HEAD()这个宏：

C代码  

1. #define LIST_HEAD_INIT(name) { &(name), &(name) }  
2.   
3. #define LIST_HEAD(name) \  
4.         struct list_head name = LIST_HEAD_INIT(name)  

 

另外有一个内联函数用于运行时初始化：

C代码  

1. static inline void INIT_LIST_HEAD(struct list_head *list)  
2. {  
3.     list->next = list;  
4.     list->prev = list;  
5. }  

3.2 添加、删除

下面都是些很基本的操作，只要弄清楚了链表的原理，都很容易理解。

C代码  

1. /* 
2. * Insert a new entry between two known consecutive entries. 
3. * 
4. * This is only for internal list manipulation where we know 
5. * the prev/next entries already! 
6. */  
7. static inline void __list_add(struct list_head *new,  
8.                               struct list_head *prev,  
9.                               struct list_head *next)  
10. {  
11.         next->prev = new;  
12.         new->next = next;  
13.         new->prev = prev;  
14.         prev->next = new;  
15. }  
16.   
17. /** 
18. * list_add - add a new entry 
19. * @new: new entry to be added 
20. * @head: list head to add it after 
21. * 
22. * Insert a new entry after the specified head. 
23. * This is good for implementing stacks. 
24. */  
25. static inline void list_add(struct list_head *new, struct list_head *head)  
26. {  
27.         __list_add(new, head, head->next);  
28. }  
29.   
30. /** 
31. * list_add_tail - add a new entry 
32. * @new: new entry to be added 
33. * @head: list head to add it before 
34. * 
35. * Insert a new entry before the specified head. 
36. * This is useful for implementing queues. 
37. */  
38. static inline void list_add_tail(struct list_head *new, struct list_head *head)  
39. {  
40.         __list_add(new, head->prev, head);  
41. }  
42.   
43. static inline void __list_del(struct list_head * prev, struct list_head * next)  
44. {  
45.         next->prev = prev;  
46.         prev->next = next;  
47. }  
48.   
49. static inline void list_del(struct list_head *entry)  
50. {  
51.         __list_del(entry->prev, entry->next);  
52.         entry->next = LIST_POISON1;  
53.         entry->prev = LIST_POISON2;  
54. }  
55.   
56. static inline void list_del_init(struct list_head *entry)  
57. {  
58.         __list_del(entry->prev, entry->next);  
59.         INIT_LIST_HEAD(entry);  
60. }  
61.   
62. static inline void list_move(struct list_head *list, struct list_head *head)  
63. {  
64.         __list_del(list->prev, list->next);  
65.         list_add(list, head);  
66. }  
67.   
68. static inline void list_move_tail(struct list_head *list,  
69.                                   struct list_head *head)  
70. {  
71.         __list_del(list->prev, list->next);  
72.         list_add_tail(list, head);  
73. }  
74.   
75. static inline int list_empty(const struct list_head *head)  
76. {  
77.         return head->next == head;  
78. }  

3.3 获取链表节点

linux链表中仅保存了list_head成员变量的地址，那么我们如何通过这个list_head的成员访问到它所有者节点的数据呢？linux提供了list_entry这个宏，ptr是指向该数据中list_head成员的指针，type是节点的类型，member是节点类型中list_head成员的变量名。

 

C代码  

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)  

  container_of宏定义在include/linux/kernel.h

C代码  

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) );})  

offsetof在include/linux/stddef.h中

C代码  

1. #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)  

获得节点对象指针的原理图如下所示：

((type *)0)->member，它将0地址强制转换为type结构的指针，再访问到type结构中的member成员。offsetof取得list_head成员msg_node相对于结构体的偏移量。将指向当前节点对象member的地址减去偏移量，就可以得到节点地址，再将它转成指向节点结构类型的指针。

linux链表的基本操作已经完成了，其它如链表遍历的操作可查看list.h源码，有很详细的说明。