002 Linux内核中双向链表的经典实现

范蠡

发布于 2019-07-10 15:07:00

1.8K0

发布于 2019-07-10 15:07:00

概要

本文对双向链表进行探讨，介绍的内容是Linux内核中双向链表的经典实现和用法。其中，也会涉及到Linux内核中非常常用的两个经典宏定义offsetof和container_of。内容包括： 1.Linux中的两个经典宏定义 2.Linux中双向链表的经典实现

Linux中的两个经典宏定义

倘若你查看过Linux Kernel的源码，那么你对 offsetof 和 container_of 这两个宏应该不陌生。这两个宏最初是极客写出的，后来在Linux内核中被推广使用。 1.offsetof 1.1 offsetof介绍 定义：offsetof在linux内核的include/linux/stddef.h中定义。

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

说明：获得结构体(TYPE)的变量成员(MEMBER)在此结构体中的偏移量。 (01) ( (TYPE *)0 ) 将零转型为TYPE类型指针，即TYPE类型的指针的地址是0。 (02) ((TYPE *)0)->MEMBER 访问结构中的数据成员。 (03) &( ( (TYPE )0 )->MEMBER ) 取出数据成员的地址。由于TYPE的地址是0，这里获取到的地址就是相对MEMBER在TYPE中的偏移。 (04) (size_t)(&(((TYPE)0)->MEMBER)) 结果转换类型。对于32位系统而言，size_t是unsigned int类型；对于64位系统而言，size_t是unsigned long类型。 1.2 offsetof示例 代码(offset_test.c):

 1 #include <stdio.h>
 2 // 获得结构体(TYPE)的变量成员(MEMBER)在此结构体中的偏移量。
 3 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 4 struct student
 5 {
 6     char gender;
 7     int id;
 8     int age;
 9     char name[20];
10 };
11
12 void main()
13 {
14     int gender_offset, id_offset, age_offset, name_offset;
15     gender_offset = offsetof(struct student, gender);
16     id_offset = offsetof(struct student, id);
17     age_offset = offsetof(struct student, age);
18     name_offset = offsetof(struct student, name);
19     printf("gender_offset = %d\n", gender_offset);
20     printf("id_offset = %d\n", id_offset);
21     printf("age_offset = %d\n", age_offset);
22     printf("name_offset = %d\n", name_offset);
23 }

结果：

1 gender_offset = 0
2 id_offset = 4
3 age_offset = 8
4 name_offset = 12

说明：简单说说"为什么id的偏移值是4，而不是1"。我的运行环境是linux系统，32位的x86架构。这就意味着cpu的数据总线宽度为32，每次能够读取4字节数据。gcc对代码进行处理的时候，是按照4字节对齐的。所以，即使gender是char(一个字节)类型，但是它仍然是4字节对齐的！ 1.3 offsetof图解

TYPE是结构体，它代表"整体"；而MEMBER是成员，它是整体中的某一部分。将offsetof看作一个数学问题来看待，问题就相当简单了：已知'整体'和该整体中'某一个部分'，而计算该部分在整体中的偏移 2.container_of 2.1 container_of介绍 定义：container_of在linux内核的include/linux/kernel.h中定义。

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

说明：根据"结构体(type)变量"中的"域成员变量(member)的指针(ptr)"来获取指向整个结构体变量的指针。 (01) typeof( ( (type *)0)->member ) 取出member成员的变量类型。 (02) const typeof( ((type *)0)->member ) *__mptr = (ptr) 定义变量__mptr指针，并将ptr赋值给__mptr。经过这一步，__mptr为member数据类型的常量指针，其指向ptr所指向的地址。 (04) (char *)__mptr 将__mptr转换为字节型指针。 (05) offsetof(type,member)) 就是获取"member成员"在"结构体type"中的位置偏移。 (06) (char *)__mptr - offsetof(type,member)) 就是用来获取"结构体type"的指针的起始地址（为char *型指针）。 (07) (type *)( (char *)__mptr - offsetof(type,member) ) 就是将"char *类型的结构体type的指针"转换为"type *类型的结构体type的指针"。 2.2 container_of示例 代码(container_test.c):

 1 #include <stdio.h>
 2 #include <string.h>
 3 // 获得结构体(TYPE)的变量成员(MEMBER)在此结构体中的偏移量。
 4 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 5 // 根据"结构体(type)变量"中的"域成员变量(member)的指针(ptr)"来获取指向整个结构体变量的指针
 6 #define container_of(ptr, type, member) ({          \
 7     const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 8     (type *)( (char *)__mptr - offsetof(type,member) );})
 9 struct student
10 {
11     char gender;
12     int id;
13     int age;
14     char name[20];
15 };
16
17 void main()
18 {
19     struct student stu;
20     struct student *pstu;
21     stu.gender = '1';
22     stu.id = 9527;
23     stu.age = 24;
24     strcpy(stu.name, "zhouxingxing");
25     // 根据"id地址" 获取 "结构体的地址"。
26     pstu = container_of(&stu.id, struct student, id);
27     // 根据获取到的结构体student的地址，访问其它成员
28     printf("gender= %c\n", pstu->gender);
29     printf("age= %d\n", pstu->age);
30     printf("name= %s\n", pstu->name);
31 }

结果：

1 gender= 1
2 age= 24
3 name= zhouxingxing

2.3 container_of图解

type是结构体，它代表"整体"；而member是成员，它是整体中的某一部分，而且member的地址是已知的。将offsetof看作一个数学问题来看待，问题就相当简单了：已知'整体'和该整体中'某一个部分'，要根据该部分的地址，计算出整体的地址。

Linux中双向链表的经典实现

1.Linux中双向链表介绍 Linux双向链表的定义主要涉及到两个文件： include/linux/types.h include/linux/list.h Linux中双向链表的使用思想 它是将双向链表节点嵌套在其它的结构体中；在遍历链表的时候，根据双链表节点的指针获取"它所在结构体的指针"，从而再获取数据。我举个例子来说明，可能比较容易理解。假设存在一个社区中有很多人，每个人都有姓名和年龄。通过双向链表将人进行关联的模型图如下：

person代表人，它有name和age属性。为了通过双向链表对person进行链接，我们在person中添加了list_head属性。通过list_head，我们就将person关联起来了。

1 struct person 
2 { 
3     int age; 
4     char name[20];
5     struct list_head list; 
6 };

2.Linux中双向链表的源码分析 (01). 节点定义

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

虽然名称list_head，但是它既是双向链表的表头，也代表双向链表的节点。 (02). 初始化节点

1 #define LIST_HEAD_INIT(name) { &(name), &(name) }
2 #define LIST_HEAD(name) \
3     struct list_head name = LIST_HEAD_INIT(name)
4 static inline void INIT_LIST_HEAD(struct list_head *list)
5 {
6     list->next = list;
7     list->prev = list;
8 }

LIST_HEAD的作用是定义表头(节点)：新建双向链表表头name，并设置name的前继节点和后继节点都是指向name本身。 LIST_HEAD_INIT的作用是初始化节点：设置name节点的前继节点和后继节点都是指向name本身。 INIT_LIST_HEAD和LIST_HEAD_INIT一样，是初始化节点：将list节点的前继节点和后继节点都是指向list本身。 (03). 添加节点

 1 static inline void __list_add(struct list_head *new,
 2                   struct list_head *prev,
 3                   struct list_head *next)
 4 {
 5     next->prev = new;
 6     new->next = next;
 7     new->prev = prev;
 8     prev->next = new;
 9 }
10
11 static inline void list_add(struct list_head *new, struct list_head *head)
12 {
13     __list_add(new, head, head->next);
14 }
15
16 static inline void list_add_tail(struct list_head *new, struct list_head *head)
17 {
18     __list_add(new, head->prev, head);
19 }

list_add(new, prev, next)的作用是添加节点：将new插入到prev和next之间。在linux中，以""开头的函数意味着是内核的内部接口，外部不应该调用该接口。 list_add(new, head)的作用是添加new节点：将new添加到head之后，是new称为head的后继节点。 list_add_tail(new, head)的作用是添加new节点：将new添加到head之前，即将new添加到双链表的末尾。 (04). 删除节点

 1 static inline void __list_del(struct list_head * prev, struct list_head * next)
 2 {
 3     next->prev = prev;
 4     prev->next = next;
 5 }
 6
 7 static inline void list_del(struct list_head *entry)
 8 {
 9     __list_del(entry->prev, entry->next);
10 }
11
12 static inline void __list_del_entry(struct list_head *entry)
13 {
14     __list_del(entry->prev, entry->next);
15 }
16
17 static inline void list_del_init(struct list_head *entry)
18 {
19     __list_del_entry(entry);
20     INIT_LIST_HEAD(entry);
21 }

__list_del(prev, next) 和__list_del_entry(entry)都是linux内核的内部接口。 __list_del(prev, next) 的作用是从双链表中删除prev和next之间的节点。 __list_del_entry(entry) 的作用是从双链表中删除entry节点。

list_del(entry) 和 list_del_init(entry)是linux内核的对外接口。 list_del(entry) 的作用是从双链表中删除entry节点。 list_del_init(entry) 的作用是从双链表中删除entry节点，并将entry节点的前继节点和后继节点都指向entry本身。 (05). 替换节点

1 static inline void list_replace(struct list_head *old,
2                 struct list_head *new)
3 {
4     new->next = old->next;
5     new->next->prev = new;
6     new->prev = old->prev;
7     new->prev->next = new;
8 }

list_replace(old, new)的作用是用new节点替换old节点。 (06). 判断双链表是否为空

1 static inline int list_empty(const struct list_head *head)
2 {
3     return head->next == head;
4 }

list_empty(head)的作用是判断双链表是否为空。它是通过区分"表头的后继节点"是不是"表头本身"来进行判断的。 (07). 获取节点

1 #define list_entry(ptr, type, member) \
2     container_of(ptr, type, member)

list_entry(ptr, type, member) 实际上是调用的container_of宏。它的作用是：根据"结构体(type)变量"中的"域成员变量(member)的指针(ptr)"来获取指向整个结构体变量的指针。 (08). 遍历节点

1 #define list_for_each(pos, head) \
2     for (pos = (head)->next; pos != (head); pos = pos->next)
3
4 #define list_for_each_safe(pos, n, head) \
5     for (pos = (head)->next, n = pos->next; pos != (head); \
6         pos = n, n = pos->next)

list_for_each(pos, head)和list_for_each_safe(pos, n, head)的作用都是遍历链表。但是它们的用途不一样！ list_for_each(pos, head)通常用于获取节点，而不能用到删除节点的场景。 list_for_each_safe(pos, n, head)通常删除节点的场景。 3.Linux中双向链表的使用示例 双向链表代码(list.h):

 1 #ifndef _LIST_HEAD_H
 2 #define _LIST_HEAD_H
 3 // 双向链表节点
 4 struct list_head {
 5     struct list_head *next, *prev;
 6 };
 7
 8 // 初始化节点：设置name节点的前继节点和后继节点都是指向name本身。
 9 #define LIST_HEAD_INIT(name) { &(name), &(name) }
10 // 定义表头(节点)：新建双向链表表头name，并设置name的前继节点和后继节点都是指向name本身。
11 #define LIST_HEAD(name) \
12     struct list_head name = LIST_HEAD_INIT(name)
13 // 初始化节点：将list节点的前继节点和后继节点都是指向list本身。
14 static inline void INIT_LIST_HEAD(struct list_head *list)
15 {
16     list->next = list;
17     list->prev = list;
18 }
19
20 // 添加节点：将new插入到prev和next之间。
21 static inline void __list_add(struct list_head *new,
22                   struct list_head *prev,
23                   struct list_head *next)
24 {
25     next->prev = new;
26     new->next = next;
27     new->prev = prev;
28     prev->next = new;
29 }
30
31 // 添加new节点：将new添加到head之后，是new称为head的后继节点。
32 static inline void list_add(struct list_head *new, struct list_head *head)
33 {
34     __list_add(new, head, head->next);
35 }
36
37 // 添加new节点：将new添加到head之前，即将new添加到双链表的末尾。
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 // 从双链表中删除entry节点。
44 static inline void __list_del(struct list_head * prev, struct list_head * next)
45 {
46     next->prev = prev;
47     prev->next = next;
48 }
49
50 // 从双链表中删除entry节点。
51 static inline void list_del(struct list_head *entry)
52 {
53     __list_del(entry->prev, entry->next);
54 }
55
56 // 从双链表中删除entry节点。
57 static inline void __list_del_entry(struct list_head *entry)
58 {
59     __list_del(entry->prev, entry->next);
60 }
61
62 // 从双链表中删除entry节点，并将entry节点的前继节点和后继节点都指向entry本身。
63 static inline void list_del_init(struct list_head *entry)
64 {
65     __list_del_entry(entry);
66     INIT_LIST_HEAD(entry);
67 }
68
69 // 用new节点取代old节点
70 static inline void list_replace(struct list_head *old,
71                 struct list_head *new)
72 {
73     new->next = old->next;
74     new->next->prev = new;
75     new->prev = old->prev;
76     new->prev->next = new;
77 }
78
79 // 双链表是否为空
80 static inline int list_empty(const struct list_head *head)
81 {
82     return head->next == head;
83 }
84 // 获取"MEMBER成员"在"结构体TYPE"中的位置偏移
85 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
86 // 根据"结构体(type)变量"中的"域成员变量(member)的指针(ptr)"来获取指向整个结构体变量的指针
87 #define container_of(ptr, type, member) ({          \
88     const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
89     (type *)( (char *)__mptr - offsetof(type,member) );})
90 // 遍历双向链表
91 #define list_for_each(pos, head) \
92     for (pos = (head)->next; pos != (head); pos = pos->next)
93 #define list_for_each_safe(pos, n, head) \
94     for (pos = (head)->next, n = pos->next; pos != (head); \
95         pos = n, n = pos->next)
96 #define list_entry(ptr, type, member) \
97     container_of(ptr, type, member)
98 #endif

双向链表测试代码(test.c):

 1 #include <stdio.h> 
 2 #include <stdlib.h>
 3 #include <string.h>
 4 #include "list.h" 
 5 struct person 
 6 { 
 7     int age; 
 8     char name[20];
 9     struct list_head list; 
10 };
11
12 void main(int argc, char* argv[]) 
13 { 
14     struct person *pperson; 
15     struct person person_head; 
16     struct list_head *pos, *next; 
17     int i;
18     // 初始化双链表的表头 
19     INIT_LIST_HEAD(&person_head.list); 
20     // 添加节点
21     for (i=0; i<5; i++)
22     {
23         pperson = (struct person*)malloc(sizeof(struct person));
24         pperson->age = (i+1)*10;
25         sprintf(pperson->name, "%d", i+1);
26         // 将节点链接到链表的末尾 
27         // 如果想把节点链接到链表的表头后面，则使用 list_add
28         list_add_tail(&(pperson->list), &(person_head.list));
29     }
30
31     // 遍历链表
32     printf("==== 1st iterator d-link ====\n"); 
33     list_for_each(pos, &person_head.list) 
34     { 
35         pperson = list_entry(pos, struct person, list); 
36         printf("name:%-2s, age:%d\n", pperson->name, pperson->age); 
37     } 
38
39     // 删除节点age为20的节点
40     printf("==== delete node(age:20) ====\n");
41     list_for_each_safe(pos, next, &person_head.list)
42     {
43         pperson = list_entry(pos, struct person, list);
44         if(pperson->age == 20)
45         {
46             list_del_init(pos);
47             free(pperson);
48         }
49     }
50
51     // 再次遍历链表
52     printf("==== 2nd iterator d-link ====\n");
53     list_for_each(pos, &person_head.list)
54     {
55         pperson = list_entry(pos, struct person, list);
56         printf("name:%-2s, age:%d\n", pperson->name, pperson->age);
57     }
58
59     // 释放资源
60     list_for_each_safe(pos, next, &person_head.list)
61     {
62         pperson = list_entry(pos, struct person, list); 
63         list_del_init(pos); 
64         free(pperson); 
65     }      
66 }

运行结果：

 1 ==== 1st iterator d-link ====
 2 name:1 , age:10
 3 name:2 , age:20
 4 name:3 , age:30
 5 name:4 , age:40
 6 name:5 , age:50
 7 ==== delete node(age:20) ====
 8 ==== 2nd iterator d-link ====
 9 name:1 , age:10
10 name:3 , age:30
11 name:4 , age:40
12 name:5 , age:50

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2019-07-09，如有侵权请联系 cloudcommunity@tencent.com 删除

linux