linux的list常用函数用法速查及应用实例

linux中大量使用了双向链表操作，它们的源码实现在源码目录的/kernel/include/linux/list.h文件中，里边不仅包括普通双向链表的操作，还有hash链表操作。但最常用的还是普通双向链表的操作，这里归纳了普遍双向链表的操作中最最常用的操作，用于速查，并以一个简单的应用实例用以示范。
1、 list双向链表的结构：
struct list_head
{
 struct list_head *next, *prev;
};
双向链表，前赴、后继两个指针，不多说
2、 初始化方法：
要明确：双向链表初始化的结果是，双向链表的前赴、后继两个指针都指向它自己；
(1)、宏函数方式：
#define LIST_HEAD(name) \
 struct list_head name = LIST_HEAD_INIT(name) +
#define LIST_HEAD_INIT(name) { &(name), &(name) }
这种方式的宏函数LIST_HEAD的参数name实际是一个struct list_head类型变量(调用它时只需指定名字即可)，并指定该变量的两个成员(即前赴、后继指针)的值都是它自己，即均指向它自己；
(2)、函数方式：
static inline void INIT_LIST_HEAD(struct list_head *list)
{
 list->next = list;
 list->prev = list;
}
函数的参数是一个struct list_head类型变量地址，在函数体内部指定其前赴、后继指针的值是它自己；
3、 加入节点：
加入节点可以在链表头的后继插入，也可以在其前赴插入，即所谓头插法和尾插法，头插法可如下所示：
Head(next)最新插入节点(next)次新插入节点(next)….最旧节点(next)NULL
插入方式为：
static inline void list_add(struct list_head *new, struct list_head *head)
{
 __list_add(new, head, head->next);
}
函数list_add的第一参数为新节点，第二参数为链表头；
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;
}
尾插法如下所示：
NULL(prev)最旧节点….(prev)次新插入节点(prev)最新插入节点(prev)Head
尾插法和头插法唯一区别是调用__list_add时参数的不同，如下：
static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
 __list_add(new, head->prev, head);
}
4、 删除节点：
删除节点要明确：首先把该节点的前赴和后继的指向关系更新，即更新为：后继prev指向前赴，前赴next指向后继，并且该节点的前赴、后继两个指针分别指向两个特定地方(LIST_POISON1和LIST_POISON2)；
static inline void list_del(struct list_head *entry)
{
 __list_del(entry->prev, entry->next);
 entry->next = LIST_POISON1;
 entry->prev = LIST_POISON2;
}
LIST_POISON1和LIST_POISON2具体怎么回事这里先不关注。
static inline void __list_del(struct list_head * prev, struct list_head * next)
{
 next->prev = prev;
 prev->next = next;
}
5、 判断该链表是否只有头节点：
要明确：在只有头节点自己的链表，相当于刚刚初始化的链表，它的前赴、后继两个指针都指向它自己，所以判断链表是否为空即只有头节点的方法也是这样：
static inline int list_empty(const struct list_head *head)
{
 return head->next == head;
}
6、 链表遍历：
遍历链表可以从两个角度遍历，一个是为了获取到每一个节点地址，另一个是为了获取每一个节点所在结构体的地址(节点所在的结构体往往是实际有用的)，依次如下：
(1)、获取到每一个节点地址：list_for_each(头插法) + list_for_each_prev(尾插法)
#define list_for_each(pos, head) \
 for (pos = (head)->next; prefetch(pos->next), pos != (head); \
         pos = pos->next)
注意prefetch是为了确认pos->next不是NULL，即避免pos取值为NULL，可见，list_for_each就是遍历从头节点的next开始的后面的每一个节点

#define list_for_each_prev(pos, head) \
 for (pos = (head)->prev; prefetch(pos->prev), pos != (head); \
         pos = pos->prev)
和头插法的list_for_each类似，只是遍历的是从头节点的prev开始的后面的每一个节点；
(2)、获取每一个节点所在结构体的地址
#define list_entry(ptr, type, member) \
  container_of(ptr, type, member)
可见list_entry其实就是container_of，即：ptr是大结构体type变量的member成员的实际值，要获取所在的大结构体type变量的地址；
list_entry常常和list_for_each/ list_for_each_prev配合使用，使用后者首先获取节点地址，然后获取节点所在大结构体变量的地址，进而获取这个大结构体变量的其他成员值；
7、 应用实例：
(1)、大结构体的类型及其变量如下：
typedef struct list_ctr
{
    wait_queue_head_t waitq;
    struct list_head list;   //链表头
    unsigned char num;
    unsigned char send_times;
    unsigned char recv_times;
    spinlock_t spinlock;
}list_ctr_t;
list_ctr_t user_ldata;  //链表头所在变量user_ldata
(2)、初始化该双向链表：
INIT_LIST_HEAD (&user_ldata.list);
由前面可知，user_ldata.list的前赴、后继略过指针分别指向它自己；
(3)、加入节点：
 首先确定所加入节点的数据结构类型：
typedef struct list_data
{
struct list_head list;
unsigned char data;
}list_data_t;
这里，list_data_t就是每个节点所在的大结构体；
 搞一个新的大结构体用于插入：
list_data_t *newdata = NULL;
newdata = kmalloc (sizeof(list_data_t), GFP_KERNEL);
 初始化该节点：
INIT_LIST_HEAD (&newdata->list);
 插入节点(这里选用尾插法)：
list_add_tail (&newdata->list, &user_ldata.list);
插入到链表头的后面；
 给该节点的实际内容赋值
newdata->data = data[user_ldata.send_times];
即把所在大结构体的其他成员(这里是data)赋值；
(4)、删除节点：
 判断该链表是否为空(只有链表头)
list_empty (&user_ldata.list)
 准备一个链表节点指针，用于获取到链表每一个节点地址
struct list_head *plist = NULL;
 准备一个大结构体的指针，用于获取每一个节点所在的大结构体地址
list_data_t *olddata = NULL;
 遍历：
list_for_each (plist, &user_ldata.list)
{
    olddata = list_entry (plist, list_data_t, list);
    if (olddata)
        break;
}
用list_for_each不断获取链表的每一个节点，然后用list_entry获取这个节点所在大结构体地址olddata，如果发现olddata不为空则跳出做进一步处理；
 处理后，删除节点：
list_del (&olddata->list);
删除的还是节点，由前面可知，这里是该链表节点前赴、后继两个指针的指向位置的变化，但并没有释放大结构体的内存；
 最终删除整个(大结构体)内容
kfree (olddata);

实际上，上面描述的其实是一个字符设备的动态写入、读取的过程。