在Linux下链表使用介绍三：链表常用接口函数

 在上一篇我们介绍了内核下链表的基本原理，接下来从应用角度出发介绍常用的接口函数。

 

1.1 container_of

/* 原型 */  
#define container_of(ptr, type, member) 

/* 功能 */
已知某一个成员变量的名字、指针和结构体类型的情况下，计算结构体的指针，也就是计算结构体的起始地址。

/* 参数 */
ptr：   某一个成员的指针
type：  结构体类型
member：成员变量名字

 

1.2 offsetof

/* 原型 */
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)

/* 功能 */
在已知某一个成员变量的名字和结构体类型的情况下，计算该成员相对于结构体的起始地址的偏移量

/* 参数 */
TYPE：  结构体类型名称
MEMBER：结构体中成员

/* 返回 */
该成员相对于结构体的起始地址的偏移量

 

1.3 LIST_HEAD_INIT

/* 原型 */
#define LIST_HEAD_INIT(name) { &(name), &(name); }

/* 功能 */
初始化一个结点名字为name的双向循环链表的头结点

/* 参数 */
name：结点名字

 

1.4 LIST_HEAD

/* 原型 */
#define LIST_HEAD(name)

/* 功能 */
初始化一个结点名字为name的双向循环链表的头结点

/* 参数 */
name：结点名字

 

1.5  INIT_LIST_HEAD

/* 原型 */
static inline void INIT_LIST_HEAD(struct list_head *list)

/* 功能 */
初始化一个结点名字为name的双向循环链表的头结点

/* 参数 */
list：结点名字

 

1.6 list_add

//原型
static inline void list_add(struct list_head *new, struct list_head *head)

//功能
添加结点new到链表头

//参数
new：新的结点
head：链表头

 

1.7 list_add_tail

//原型
static inline void list_add_tail(struct list_head *new, struct list_head *head)

//功能
添加结点new到链表尾

//参数
new：新的结点
head：链表头

 

1.8 list_del 

//原型
static inline void list_del(struct list_head *entry)

//功能
删除结点entry，将entry的prev指向LIST_POISON1，next指向LIST_POISON2.

//参数
entry：被删除结点

//说明
指向LIST_POISON不会引起缺页错误。

 

1.9 list_move

//原型
static inline void list_move(struct list_head *list, struct list_head *head)

//功能
先将list节点从原链表中删除，然后将其添加到head链表的表头

//参数
list：移除结点
head：链表表头。

 

1.10 list_empty

//原型
static inline int list_empty(const struct list_head *head)

//功能
判断head链表是否为空链表，是返回1，否则返回为0；

//参数
head：链表表头。

//返回
0或1

 

1.11 list_entry

//原型
#define list_entry(ptr, type, member)

//功能
获取type类型结构体的起始指针

//参数
ptr：type类型的结构体中member成员的指针
type：结构体类型
member：结构体中成员

//返回
结构体的起始指针

 

1.12 list_for_each

//原型
#define list_for_each(pos, head)

//功能
从head节点开始（不包括head节点！）遍历它的每一个节点！

//参数
pos：循环指针
head：链表头

 

1.13 list_for_each_safe

//原型
#define list_for_each_safe(pos, n, head)

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

//参数
pos：循环指针
n：缓存节点
head：链表头

 

1.14 list_for_each_entry

//原型
#define list_for_each_entry(pos, head, member)                  

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

//参数
pos：结构体指针
head：链表头
member：结构体成员

 

1.15 list_for_each_entry_safe

//原型
#define list_for_each_entry_safe(pos, n, head, member)        

//功能
先保存下一个要遍历的节点！从head下一个节点向后遍历链表。

//参数
pos：结构体指针
n：缓冲节点
head：链表头
member：结构体成员

 

以上列出了常用的一些链表操作接口，更多接口定义请参考内核代码 /include/linux/list.h

 

本文参考以下博客https://blog.csdn.net/lmjjw/article/details/9833025.