WarlockFish/linux-insides-zh
1
0
Fork 0
mirror of https://github.com/MintCN/linux-insides-zh.git synced 2026-04-24 18:50:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update dlist.md

Browse Source
This commit is contained in:
Ezio
2016-03-05 22:25:57 +08:00
parent e52a6e0ae7
commit cde4ec9ac0
1 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
DataStructures/dlist.md
View File

@@ -4,9 +4,9 @@ Linux 内核里的数据结构——双向链表
双向链表
--------------------------------------------------------------------------------
Linux 内核自己实现了双向链表，可以在[include/linux/list.h](https://github.com/torvalds/linux/blob/master/include/linux/list.h)找到定义。我们将会从双向链表数据结构开始`内核的数据结构`。为什么？因为它在内核里使用的很广泛，你只需要在[free-electrons.com](http://lxr.free-electrons.com/ident?i=list_head) 检索一下就知道了。
Linux 内核自己实现了双向链表，可以在 [include/linux/list.h](https://github.com/torvalds/linux/blob/master/include/linux/list.h) 找到定义。我们将会从双向链表数据结构开始`内核的数据结构`。为什么？因为它在内核里使用的很广泛，你只需要在 [free-electrons.com](http://lxr.free-electrons.com/ident?i=list_head) 检索一下就知道了。
首先让我们看一下在[include/linux/types.h](https://github.com/torvalds/linux/blob/master/include/linux/types.h) 里的主结构体：
首先让我们看一下在 [include/linux/types.h](https://github.com/torvalds/linux/blob/master/include/linux/types.h) 里的主结构体：
```C
struct list_head {
@@ -14,7 +14,7 @@ struct list_head {
};
```
你可能注意到这和你以前见过的双向链表的实现方法是不同的。举个例子来说，在[glib](http://www.gnu.org/software/libc/) 库里是这样实现的：
你可能注意到这和你以前见过的双向链表的实现方法是不同的。举个例子来说，在 [glib](http://www.gnu.org/software/libc/) 库里是这样实现的：
```C
struct GList {
@@ -35,7 +35,7 @@ struct nmi_desc {
};
```
让我们看几个例子来理解一下在内核里是如何使用`list_head` 的。如上所述，在内核里有实在很多不同的地方用到了链表。我们来看一个在杂项字符驱动里面的使用的例子。在 [drivers/char/misc.c](https://github.com/torvalds/linux/blob/master/drivers/char/misc.c) 的杂项字符驱动API 被用来编写处理小型硬件和虚拟设备的小驱动。这些驱动共享相同的主设备号：
让我们看几个例子来理解一下在内核里是如何使用 `list_head` 的。如上所述，在内核里有实在很多不同的地方用到了链表。我们以杂项字符驱动为例来说明双向链表的使用。在 [drivers/char/misc.c](https://github.com/torvalds/linux/blob/master/drivers/char/misc.c) 的杂项字符驱动API 被用来编写处理小型硬件和虚拟设备的小驱动。这些驱动共享相同的主设备号：
```C
#define MISC_MAJOR 10
@@ -67,7 +67,7 @@ crw------- 1 root root 10, 63 Mar 21 12:01 vga_arbiter
crw------- 1 root root 10, 137 Mar 21 12:01 vhci
```
现在让我们看看它是如何使用链表的。首先看一下结构体`miscdevice`：
现在让我们看看它是如何使用链表的。首先看一下结构体 `miscdevice` ：
```C
struct miscdevice
@@ -83,32 +83,32 @@ struct miscdevice
};
```
可以看到结构体的第四个变量`list` 是所有注册过的设备的链表。在源代码文件的开始可以看到这个链表的定义：
我们可以看到结构体的第四个变量 `list` 是所有注册过的设备的链表。在源代码文件的开始可以看到这个链表的定义：
```C
static LIST_HEAD(misc_list);
```
它实际上是对用`list_head` 类型定义的变量的扩展。
它扩展开来实际上就是定义了一个 `list_head` 类型的变量：
```C
#define LIST_HEAD(name) \
struct list_head name = LIST_HEAD_INIT(name)
```
然后使用宏`LIST_HEAD_INIT` 进行初始化，这会使用变量`name` 的地址来填充`prev`和`next` 结构体的两个变量。
然后使用宏 `LIST_HEAD_INIT` 进行初始化，这会使用变量 `name` 的地址来填充 `prev` 和 `next` 结构体的两个变量。
```C
#define LIST_HEAD_INIT(name) { &(name), &(name) }
```
现在来看看注册杂项设备的函数`misc_register`。它在开始就用 `INIT_LIST_HEAD` 初始化了`miscdevice->list`。
现在来看看注册杂项设备的函数 `misc_register` 。它在开始就用 `INIT_LIST_HEAD` 初始化了`miscdevice->list`。
```C
INIT_LIST_HEAD(&misc->list);
```
作用和宏`LIST_HEAD_INIT`一样。
作用和宏 `LIST_HEAD_INIT`一样。
```C
static inline void INIT_LIST_HEAD(struct list_head *list)
@@ -118,13 +118,13 @@ static inline void INIT_LIST_HEAD(struct list_head *list)
}
```
在函数`device_create` 创建了设备后我们就用下面的语句将设备添加到设备链表：
下一步在函数 `device_create` 创建了设备后我们就用下面的语句将设备添加到设备链表：
```
list_add(&misc->list, &misc_list);
```
内核文件`list.h` 提供了项链表添加新项的API 接口。我们来看看它的实现：
内核文件 `list.h` 提供了向链表添加新项的接口函数。我们来看看它的实现：
```C
@@ -134,10 +134,10 @@ static inline void list_add(struct list_head *new, struct list_head *head)
}
```
实际上就是使用3个指定的参数来调用了内部函数`__list_add`：
实际上就是使用3个指定的参数来调用了内部函数 `__list_add`：
* new - 新项。
* head - 新项将会被添加到`head`之前.
* head - 新项将会被添加到`head` 之后.
* head->next - `head` 之后的项。
`__list_add`的实现非常简单：
@@ -154,9 +154,9 @@ static inline void __list_add(struct list_head *new,
}
```
我们会在`prev`和`next` 之间添加一个新项。所以我们用宏`LIST_HEAD_INIT`定义的`misc` 链表会包含指向`miscdevice->list` 的向前指针和向后指针。
我们会在 `prev` 和 `next` 之间添加一个新项。所以我们用宏 `LIST_HEAD_INIT` 定义的 `misc` 链表会包含指向 `miscdevice->list` 的向前指针和向后指针。
这里有一个问题：如何得到列表的内容呢？这里有一个特殊的宏：
这里仍有一个问题：如何得到列表的内容呢？这里有一个特殊的宏：
```C
#define list_entry(ptr, type, member) \
@@ -167,7 +167,7 @@ static inline void __list_add(struct list_head *new,
* ptr - 指向链表头的指针；
* type - 结构体类型;
* member - 在结构体内类型为`list_head` 的变量的名字；
* member - 在结构体内类型为 `list_head` 的变量的名字；
比如说：
@@ -175,14 +175,14 @@ static inline void __list_add(struct list_head *new,
const struct miscdevice *p = list_entry(v, struct miscdevice, list)
```
然后我们就可以使用`p->minor` 或者 `p->name`来访问`miscdevice`。让我们来看看`list_entry` 的实现：
然后我们就可以使用 `p->minor` 或者 `p->name`来访问 `miscdevice`。让我们来看看 `list_entry` 的实现：
```C
#define list_entry(ptr, type, member) \
container_of(ptr, type, member)
```
如我们所见，它仅仅使用相同的参数调用了宏`container_of`。初看这个宏挺奇怪的：
如我们所见，它仅仅使用相同的参数调用了宏 `container_of`。初看这个宏挺奇怪的：
```C
#define container_of(ptr, type, member) ({ \
@@ -204,9 +204,9 @@ int main() {
}
```
最终会打印`2`
最终会打印 `2`
下一点就是`typeof`,它也很简单。就如你从名字所理解的，它仅仅返回了给定变量的类型。当我第一次看到宏`container_of`的实现时，让我觉得最奇怪的就是`container_of`中的0.实际上这个指针巧妙的计算了从结构体特定变量的偏移，这里的`0`刚好就是位宽里的零偏移。让我们看一个简单的例子：
下一点就是 `typeof`,它也很简单。就如你从名字所理解的，它仅仅返回了给定变量的类型。当我第一次看到宏 `container_of` 的实现时，让我觉得最奇怪的就是 `container_of` 中的 0 。实际上这个指针巧妙的计算了从结构体特定变量的偏移，这里的 `0` 刚好就是位宽里的零偏移。让我们看一个简单的例子：
```C
#include <stdio.h>
@@ -214,7 +214,7 @@ int main() {
struct s {
int field1;
char field2;
char field3;
char field3;
};
int main() {
@@ -223,17 +223,17 @@ int main() {
}
```
结果显示`0x5`。
结果显示 `0x5`。
下一个宏`offsetof` 会计算从结构体的某个变量的相对于结构体起始地址的偏移。它的实现和上面类似：
下一个宏 `offsetof` 会计算从结构体的某个变量的相对于结构体起始地址的偏移。它的实现和上面类似：
```C
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
```
现在我们来总结一下宏`container_of`。只需要知道结构体里面类型为`list_head` 的变量的名字和结构体容器的类型，它可以通过结构体的变量`list_head`获得结构体的起始地址。在宏定义的第一行，声明了一个指向结构体成员变量`ptr`的指针`__mptr`，并且把`ptr` 的地址赋给它。现在`ptr` 和`__mptr` 指向了同一个地址。从技术上讲我们并不需要这一行，但是它可以方便的进行类型检查。第一行保证了特定的结构体（参数`type`）包含成员变量`member`。第二行代码会用宏`offsetof`计算成员变量相对于结构体起始地址的偏移，然后从结构体的地址减去这个偏移，最后就得到了结构体。
现在我们来总结一下宏 `container_of`。只需要知道结构体里面类型为 `list_head` 的变量的名字和结构体容器的类型，它可以通过结构体的变量 `list_head` 获得结构体的起始地址。在宏定义的第一行，声明了一个指向结构体成员变量 `ptr` 的指针 `__mptr` ，并且把 `ptr` 的地址赋给它。现在 `ptr` 和 `__mptr` 指向了同一个地址。从技术上讲我们并不需要这一行，但是它可以方便的进行类型检查。第一行保证了特定的结构体（参数 `type`）包含成员变量 `member`。第二行代码会用宏 `offsetof` 计算成员变量相对于结构体起始地址的偏移，然后从结构体的地址减去这个偏移，最后就得到了结构体的起始地址。
当然了`list_add` 和 `list_entry`不是`<linux/list.h>`提供的唯一功能。双向链表的实现还提供了如下API：
当然了 `list_add` 和 `list_entry` 不是 `<linux/list.h>` 提供的唯一函数。双向链表的实现还提供了如下API：
* list_add
* list_add_tail
@@ -247,4 +247,4 @@ int main() {
* list_for_each
* list_for_each_entry
等等很多其它API。
等等很多其它 API。