Skip to content

Instantly share code, notes, and snippets.

@wanyakun
Last active March 21, 2018 00:30
Show Gist options
  • Save wanyakun/65f1590256e85cf90c5098930bc79cd8 to your computer and use it in GitHub Desktop.
Save wanyakun/65f1590256e85cf90c5098930bc79cd8 to your computer and use it in GitHub Desktop.
Linux中双向链表

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

1. Linux中的两个经典宏定义

offsetof

定义:offsetof在linux内核的include/linux/stddef.h中定义

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

说明:获得结构体(TYPE)的变量成员(MEMBER)在次结构体的偏移量。

  • ((TYPE *)0) 将零转型为TYPE类型指针,即TYPE类型的指针地址是0
  • ((TYPE *)0)->MEMBER 访问结构中的数据成员
  • &(((TYPE *)0)->MEMBER)) 取出数据成员的地址。由于TYPE的地址是0,这里获取到的地址就是相对MEMBER在TYPE中的偏移量。
  • (size_t) &((TYPE *)0)->MEMBER) 结果转换类型。对于32位系统,size_t是unsigned int类型,对于64位系统,size_t是unsigned long类型。

示例:

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

struct Person {
    char gender;
    int id;
    int age;
    char name[20];
};

int main(int argc, char const *argv[])
    int genderOffset, idOffset, ageOffset, nameOffset;
    genderOffset = offsetof(struct Person, gender);
    idOffset = offsetof(struct Person, id);
    ageOffset = offsetof(struct Person, age);
    nameOffset = offsetof(struct Person, name);
    
    printf("gender offset = %d\n", genderOffset);
    printf("id offset = %d\n", idOffset);
    printf("age offset = %d\n", ageOffset);
    printf("name offset = %d\n", nameOffset);

	return 0;
}
2. Linux中双向链表的经典实现

Linux中双向链表介绍

Linux双向链表的定义主要涉及到两个文件: include/linux/types.h include/linux/list.h

Linux中双向链表的使用思想

它是将双向链表节点嵌套在其它的结构体中;在遍历链表的时候,根据双链表节点的指针获取"它所在结构体的指针",从而再获取数据。

例子来说明,可能比较容易理解。假设存在一个社区中有很多人,每个人都有姓名和年龄。通过双向链表将人进行关联的模型图如下:

graph LR
subgraph person
list1[list_head]
end

subgraph person
list2[list_head]
end

subgraph person
list3[list_head]
end

subgraph person
list...[...]
end

subgraph person
listN[list_head]
end

list1 --- list2
list2 --- list3
list3 --- list...
list... --- listN
Loading

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

struct person {
  int age;
  char name[20];
  struct list_head list;
}
//
// list.h
// DataStructureAndAlgorithm
//
// Created by wanyakun on 2016/10/28.
// Copyright © 2016年 com.ucaiyuan. All rights reserved.
//
#ifndef _LIST_HEAD_H
#define _LIST_HEAD_H
/*
(01). 节点定义, 虽然名称list_head,但是它既是双向链表的表头,也代表双向链表的节点。
*/
// 双向链表节点
struct list_head {
struct list_head *next, *prev;
};
/*
(02). 初始化节点
LIST_HEAD的作用是定义表头(节点):新建双向链表表头name,并设置name的前继节点和后继节点都是指向name本身。
LIST_HEAD_INIT的作用是初始化节点:设置name节点的前继节点和后继节点都是指向name本身。
INIT_LIST_HEAD和LIST_HEAD_INIT一样,是初始化节点:将list节点的前继节点和后继节点都是指向list本身。
*/
// 初始化节点:设置name节点的前继节点和后继节点都是指向name本身。
#define LIST_HEAD_INIT(name) { &(name), &(name) }
// 定义表头(节点):新建双向链表表头name,并设置name的前继节点和后继节点都是指向name本身。
#define LIST_HEAD(name) \
struct list_head name = LIST_HEAD_INIT(name)
// 初始化节点:将list节点的前继节点和后继节点都是指向list本身。
static inline void INIT_LIST_HEAD(struct list_head *list)
{
list->next = list;
list->prev = list;
}
/*
(03). 添加节点
__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添加到双链表的末尾。
*/
// 添加节点:将new插入到prev和next之间。
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;
}
// 添加new节点:将new添加到head之后,是new称为head的后继节点。
static inline void list_add(struct list_head *new, struct list_head *head)
{
__list_add(new, head, head->next);
}
// 添加new节点:将new添加到head之前,即将new添加到双链表的末尾。
static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
__list_add(new, head->prev, head);
}
/*
(04). 删除节点
__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本身。
*/
// 从双链表中删除entry节点。
static inline void __list_del(struct list_head * prev, struct list_head * next)
{
next->prev = prev;
prev->next = next;
}
// 从双链表中删除entry节点。
static inline void list_del(struct list_head *entry)
{
__list_del(entry->prev, entry->next);
}
// 从双链表中删除entry节点。
static inline void __list_del_entry(struct list_head *entry)
{
__list_del(entry->prev, entry->next);
}
// 从双链表中删除entry节点,并将entry节点的前继节点和后继节点都指向entry本身。
static inline void list_del_init(struct list_head *entry)
{
__list_del_entry(entry);
INIT_LIST_HEAD(entry);
}
/*
(05). 替换节点
list_replace(old, new)的作用是用new节点替换old节点。
*/
// 用new节点取代old节点
static inline void list_replace(struct list_head *old,
struct list_head *new)
{
new->next = old->next;
new->next->prev = new;
new->prev = old->prev;
new->prev->next = new;
}
/*
(06). 判断双链表是否为空
list_empty(head)的作用是判断双链表是否为空。它是通过区分"表头的后继节点"是不是"表头本身"来进行判断的。
*/
// 双链表是否为空
static inline int list_empty(const struct list_head *head)
{
return head->next == head;
}
// 获取"MEMBER成员"在"结构体TYPE"中的位置偏移
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
// 根据"结构体(type)变量"中的"域成员变量(member)的指针(ptr)"来获取指向整个结构体变量的指针
#define container_of(ptr, type, member) ({ \
const typeof( ((type *)0)->member ) *__mptr = (ptr); \
(type *)( (char *)__mptr - offsetof(type,member) );})
/*
(08). 遍历节点
list_for_each(pos, head)和list_for_each_safe(pos, n, head)的作用都是遍历链表。但是它们的用途不一样!
list_for_each(pos, head)通常用于获取节点,而不能用到删除节点的场景。
list_for_each_safe(pos, n, head)通常删除节点的场景。
*/
// 遍历双向链表
#define list_for_each(pos, head) \
for (pos = (head)->next; pos != (head); pos = pos->next)
#define list_for_each_safe(pos, n, head) \
for (pos = (head)->next, n = pos->next; pos != (head); \
pos = n, n = pos->next)
/*
(07). 获取节点
ist_entry(ptr, type, member) 实际上是调用的container_of宏。
它的作用是:根据"结构体(type)变量"中的"域成员变量(member)的指针(ptr)"来获取指向整个结构体变量的指针。
*/
#define list_entry(ptr, type, member) \
container_of(ptr, type, member)
#endif /* list_h */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "list.h"
struct person
{
int age;
char name[20];
struct list_head list;
};
void main(int argc, char* argv[])
{
struct person *pperson;
struct person person_head;
struct list_head *pos, *next;
int i;
// 初始化双链表的表头
INIT_LIST_HEAD(&person_head.list);
// 添加节点
for (i=0; i<5; i++)
{
pperson = (struct person*)malloc(sizeof(struct person));
pperson->age = (i+1)*10;
sprintf(pperson->name, "%d", i+1);
// 将节点链接到链表的末尾
// 如果想把节点链接到链表的表头后面,则使用 list_add
list_add_tail(&(pperson->list), &(person_head.list));
}
// 遍历链表
printf("==== 1st iterator d-link ====\n");
list_for_each(pos, &person_head.list)
{
pperson = list_entry(pos, struct person, list);
printf("name:%-2s, age:%d\n", pperson->name, pperson->age);
}
// 删除节点age为20的节点
printf("==== delete node(age:20) ====\n");
list_for_each_safe(pos, next, &person_head.list)
{
pperson = list_entry(pos, struct person, list);
if(pperson->age == 20)
{
list_del_init(pos);
free(pperson);
}
}
// 再次遍历链表
printf("==== 2nd iterator d-link ====\n");
list_for_each(pos, &person_head.list)
{
pperson = list_entry(pos, struct person, list);
printf("name:%-2s, age:%d\n", pperson->name, pperson->age);
}
// 释放资源
list_for_each_safe(pos, next, &person_head.list)
{
pperson = list_entry(pos, struct person, list);
list_del_init(pos);
free(pperson);
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment