Redis实现 -- 链表

Redis实现 – 链表

一、链表的特点

链表作为一种常用的数据结构，链表内置在许多的高级语言中，比如Java中：LinkedList等集合类工具。

链表是一种线性表，和数组不同的是，他不能随机访问结点，只能顺序的访问。同时它可以通过增删结点来灵活地调整链表的长度。

链表结构

二、Redis中的链表

C语言中没有设计这种数据结构，因此Redis构建了自己的链表实现。

1、链表的实现

源代码在adlist.h中

//结点信息
typedef struct listNode {
    // 前置节点
    struct listNode *prev;
    // 后置节点
    struct listNode *next;
    // 节点的值
    void *value;
} listNode;
C

可以看到，这是一个双向链表。

image-20210705134653786

//链表信息
typedef struct list {

    // 表头节点
    listNode *head;

    // 表尾节点
    listNode *tail;

    // 节点值复制函数
    void *(*dup)(void *ptr);

    // 节点值释放函数
    void (*free)(void *ptr);

    // 节点值对比函数
    int (*match)(void *ptr, void *key);

    // 链表所包含的节点数量
    unsigned long len;

} list;
C

同时，Redis还设计了一个list结构，为链表提供了表头指针head，表尾指针tail，链表长度len，还提供了一些特定的函数。

• dup：用于复制链表结点所保存的值
• free：用于释放链表结点所保存的值
• match：用于对比链表结点所保存的值和另一个输入值是否相等

链表结构

Redis中定义了一些宏函数，这些函数都是Redis中链表的核心操作。

// 返回给定链表所包含的节点数量
#define listLength(l) ((l)->len)

// 返回给定链表的表头节点
#define listFirst(l) ((l)->head)

// 返回给定链表的表尾节点
#define listLast(l) ((l)->tail)

// 返回给定节点的前置节点
#define listPrevNode(n) ((n)->prev)

// 返回给定节点的后置节点
#define listNextNode(n) ((n)->next)

// 返回给定节点的值
#define listNodeValue(n) ((n)->value)

// 将链表 l 的值复制函数设置为 m
#define listSetDupMethod(l,m) ((l)->dup = (m))

// 将链表 l 的值释放函数设置为 m
#define listSetFreeMethod(l,m) ((l)->free = (m))

// 将链表的对比函数设置为 m
#define listSetMatchMethod(l,m) ((l)->match = (m))

// 返回给定链表的值复制函数
#define listGetDupMethod(l) ((l)->dup)

// 返回给定链表的值释放函数
#define listGetFree(l) ((l)->free)

// 返回给定链表的值对比函数
#define listGetMatchMethod(l) ((l)->match)
C

2、Redis中的链表特点

1. 双向链表：结点中带有prev和next指针。
2. 不是循环链表：表头指针的prev指向null，表尾指针的next指向null。
3. List结构：list结构中有len，head，tail等属性。
4. 多态：链表结点使用void*指针来保存节点值，并且可以通过list结构的dup、free、match三个属性为结点值设置类型特定函数，所以链表可以用于保存各种不同类型的值。

三、Redis中链表源码

1、创建一个新的链表

//创建一个新的链表
list *listCreate(void)
{
    struct list *list;

    // 分配内存
    if ((list = zmalloc(sizeof(*list))) == NULL)
        return NULL;

    // 初始化属性
    list->head = list->tail = NULL;
    list->len = 0;
    list->dup = NULL;
    list->free = NULL;
    list->match = NULL;

    return list;
}
C

2、添加结点到表尾

//将一个包含有给定值指针 value 的新节点添加到链表的表尾
list *listAddNodeTail(list *list, void *value)
{
    listNode *node;

    // 为新节点分配内存
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;

    // 保存值指针
    node->value = value;

    // 目标链表为空
    if (list->len == 0) {
        list->head = list->tail = node;
        node->prev = node->next = NULL;
    // 目标链表非空
    } else {
        node->prev = list->tail;
        node->next = NULL;
        list->tail->next = node;
        list->tail = node;
    }

    // 更新链表节点数
    list->len++;

    return list;
}
C

3、添加结点到表头

//将一个包含有给定值指针 value 的新节点添加到链表的表头
list *listAddNodeHead(list *list, void *value)
{
    listNode *node;

    // 为节点分配内存
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;

    // 保存值指针
    node->value = value;

    // 添加节点到空链表
    if (list->len == 0) {
        list->head = list->tail = node;
        node->prev = node->next = NULL;
    // 添加节点到非空链表
    } else {
        node->prev = NULL;
        node->next = list->head;
        list->head->prev = node;
        list->head = node;
    }

    // 更新链表节点数
    list->len++;

    return list;
}
C

4、释放整个链表

void listRelease(list *list)
{
    unsigned long len;
    listNode *current, *next;

    // 指向头指针
    current = list->head;
    // 遍历整个链表
    len = list->len;
    while(len--) {
        next = current->next;

        // 如果有设置值释放函数，那么调用它
        if (list->free) list->free(current->value);
        // 释放节点结构
        zfree(current);
        current = next;
    }

    // 释放链表结构
    zfree(list);
}
C

5、删除给定结点

void listDelNode(list *list, listNode *node)
{
    // 调整前置节点的指针
    if (node->prev)
        node->prev->next = node->next;
    else
        list->head = node->next;

    // 调整后置节点的指针
    if (node->next)
        node->next->prev = node->prev;
    else
        list->tail = node->prev;

    // 释放值
    if (list->free) list->free(node->value);

    // 释放节点
    zfree(node);

    // 链表数减一
    list->len--;
}
C

6、创建一个迭代器

//为给定链表创建一个迭代器，
//之后每次对这个迭代器调用 listNext 都返回被迭代到的链表节点
listIter *listGetIterator(list *list, int direction)
{
    // 为迭代器分配内存
    listIter *iter;
    if ((iter = zmalloc(sizeof(*iter))) == NULL) return NULL;

    // 根据迭代方向，设置迭代器的起始节点
    if (direction == AL_START_HEAD)
        iter->next = list->head;
    else
        iter->next = list->tail;

    // 记录迭代方向
    iter->direction = direction;

    return iter;
}
C

7、返回迭代器当前所指向的节点

//返回迭代器当前所指向的节点
//删除当前节点是允许的，但不能修改链表里的其他节点。
listNode *listNext(listIter *iter)
{
    listNode *current = iter->next;

    if (current != NULL) {
        // 根据方向选择下一个节点
        if (iter->direction == AL_START_HEAD)
            // 保存下一个节点，防止当前节点被删除而造成指针丢失
            iter->next = current->next;
        else
            // 保存下一个节点，防止当前节点被删除而造成指针丢失
            iter->next = current->prev;
    }

    return current;
}
C

8、复制整个链表

//复制成功返回输入链表的副本，
//如果因为内存不足而造成复制失败，返回 NULL 。
//如果链表有设置值复制函数 dup ，那么对值的复制将使用复制函数进行，
//否则，新节点将和旧节点共享同一个指针。
list *listDup(list *orig)
{
    list *copy;
    listIter *iter;
    listNode *node;

    // 创建新链表
    if ((copy = listCreate()) == NULL)
        return NULL;

    // 设置节点值处理函数
    copy->dup = orig->dup;
    copy->free = orig->free;
    copy->match = orig->match;

    // 迭代整个输入链表
    iter = listGetIterator(orig, AL_START_HEAD);
    while((node = listNext(iter)) != NULL) {
        void *value;

        // 复制节点值到新节点
        if (copy->dup) {
            value = copy->dup(node->value);
            if (value == NULL) {
                listRelease(copy);
                listReleaseIterator(iter);
                return NULL;
            }
        } else
            value = node->value;

        // 将节点添加到链表
        if (listAddNodeTail(copy, value) == NULL) {
            listRelease(copy);
            listReleaseIterator(iter);
            return NULL;
        }
    }

    // 释放迭代器
    listReleaseIterator(iter);

    // 返回副本
    return copy;
}
C