头文件list.h

开头就说明了这里的list.h文件来自Linux Kernel（*/include/linux/list.h），只是去除了列表项的硬件预加载部分。

在Centos7主机上可以看到

相当于Linux Kernel的list.h源码解读

1.代码解析

1.1双向链表定义

struct list_head {
struct list_head *next, *prev;
};

1.2双向链表初始化

1.2.1 LIST_HEAD_INIT宏函数

#define LIST_HEAD_INIT(name) { &(name), &(name) }

#define LIST_HEAD(name) \
struct list_head name = LIST_HEAD_INIT(name)

进行宏替换后就是

struct list_head name ={ &(name), &(name) }

1.2.2 INIT_LIST_HEAD内联函数

static inline void INIT_LIST_HEAD(struct list_head *list)
{
    list->next = list;
    list->prev = list;
}

1.2.3 初始化示范test_list_init.c

#include<stdio.h>
struct list_head
{
        struct list_head *prev, *next;
};
#define LIST_HEAD_INIT(name) {&(name), &(name)}
#define LIST_HEAD(name) \
        struct list_head name = LIST_HEAD_INIT(name)

static inline void INIT_LIST_HEAD(struct list_head *list)
{
        list->prev = list;
        list->next = list;
}
int main(void)
{
        LIST_HEAD(temp1);
        printf("the address of prev :%x.\nthe address of next :%x\n", temp1.prev, temp1.next);
        struct list_head temp2;
        INIT_LIST_HEAD(&temp2);
        printf("the address of prev :%x.\nthe address of next :%x\n", temp2.prev, temp2.next);
        return 0;
}

image.png

1.3 双向链表的插入

static inline void __list_add(struct list_head *new,
struct list_head *prev,
struct list_head *next)
{
next->prev = new;
new->next = next;
new->prev = prev;
prev->next = new;
}

1.3.1 头插法

static inline void osn_list_add(struct list_head *new, struct list_head *head)
{
__list_add(new, head, head->next);
}

Note:没搞懂这里为什么加个osn前缀，原本是list_add，现在是osn_list_add。

1.3.2 尾插法

static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
__list_add(new, head->prev, head);
}

1.4 双向链表的删除

static inline void __list_del(struct list_head *prev, struct list_head *next)
{
next->prev = prev;
prev->next = next;
}

static inline void list_del(struct list_head *entry)
{
__list_del(entry->prev, entry->next);
entry->next = (void *) 0;
entry->prev = (void *) 0;
}

可以看到就是个简单的链表节点删除过程，同时把删除节点的前后指针设为无法访问。

static inline void list_del_init(struct list_head *entry)
{
__list_del(entry->prev, entry->next);
INIT_LIST_HEAD(entry);
}

删除节点后初始化，前后指针都指向自己

1.5 双向链表节点的移动

static inline void list_move(struct list_head *list, struct list_head *head)
{
__list_del(list->prev, list->next);
osn_list_add(list, head);
}

从A链表删除后头插法插入B链表

static inline void list_move_tail(struct list_head *list,
struct list_head *head)
{
__list_del(list->prev, list->next);
list_add_tail(list, head);
}

从A链表删除后尾插法插入B链表

1.6 双向链表判空操作

static inline int list_empty(struct list_head *head)
{
return head->next == head;
}

1.7 双向链表裁剪操作

static inline void __list_splice(struct list_head *list,
struct list_head *head)
{
struct list_head *first = list->next;
struct list_head *last = list->prev;
struct list_head *at = head->next;

first->prev = head;
head->next = first;

last->next = at;
at->prev = last;
}


static inline void list_splice(struct list_head *list, struct list_head *head)
{
if (!list_empty(list))
__list_splice(list, head);
}

先对list判空，非空就把list链表除头节点外裁剪到head头节点在的链表中。函数不安全，list节点可以继续访问其他节点。

static inline void list_splice_init(struct list_head *list,
struct list_head *head)
{
if (!list_empty(list)) {
__list_splice(list, head);
INIT_LIST_HEAD(list);
}
}

多了一步list重新初始化的过程。

1.8 获取type类型结构体的起始指针

/**
* 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) \
((type *)((char *)(ptr)-(unsigned long)(&((type *)0)->member)))

(unsigned long)(&((type *)0)->member)))将0x0地址强制转换为type *类型，然后取type中的成员member地址，因为起始地址为0，得到的member的地址就直接是该成员相对于type对象的偏移地址了。
所以该语句的功能是：得到type类型对象中member成员的地址偏移量。
先将ptr强制转换为char *类型（因为char *类型进行加减的话，加减量为sizeof(char)*offset，char占一个字节空间，这样指针加减的步长就是1个字节，实现加一减一。）
整句话的意思就是：得到指向type的指针，已知成员的地址，然后减去这个成员相对于整个结构对象的地址偏移量，得到这个数据对象的地址。

1.9 双向链表的遍历

#define list_for_each(pos, head) \
for (pos = (head)->next; pos != (head); \
pos = pos->next)


#define list_for_each_prev(pos, head) \
for (pos = (head)->prev; pos != (head); \
pos = pos->prev)

就是从前往后，从后往前的区别

#define list_for_each_safe(pos, n, head) \
for (pos = (head)->next, n = pos->next; pos != (head); \
pos = n, n = pos->next)

Note:从head节点开始（不包括head节点！）遍历它的每一个节点！它用n先将下一个要遍历的节点保存起来，防止删除本节点后，无法找到下一个节点，而出现错误！

1.10 结构体链表的遍历

#define list_for_each_entry(pos, head, member)                \
for (pos = list_entry((head)->next, typeof(*pos), member);    \
&pos->member != (head);                     \
pos = list_entry(pos->member.next, typeof(*pos), member))

已知指向某个结构体的指针pos，以及指向它中member成员的指针head，从下一个结构体开始向后遍历这个结构体链

#define list_for_each_entry_safe(pos, n, head, member)            \
for (pos = list_entry((head)->next, typeof(*pos), member),    \
n = list_entry(pos->member.next, typeof(*pos), member);    \
&pos->member != (head);                     \
pos = n, n = list_entry(n->member.next, typeof(*n), member))

Note:同理，先保存下一个要遍历的节点！从head下一个节点向后遍历链表。

参考网址

list.h使用说明
linux内核list.h分析(一)
linux内核list.h分析(二)
【Linux内核数据结构】最为经典的链表list