Redis源码学习(1)-Redis中的双端链表实现

Redis是一个开源的使用ANSI C语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库，并提供多种语言的API。Redis的源代码比较小巧精干，早期版本只有两万多行代码，即使是本系列所用的5.0.8版本的源代码，其代码量也不超过十万行，非常适合于学习。本系列将从基础的与其他部分关联度不大的基础数据结构开始，逐步探寻Redis系统设计的精妙之处，而笔者作为初学者，亦将此作为自己代码学习历程上的一个记录，并以此监督自己坚持学习下去。

双端链表基础数据结构

在src/adlist.h头文件中，定义Redis双端链表的基础数据结构，包括链表节点，链表本体以及链表迭代器的数据结构


typedef struct listNode {

    struct listNode *prev;

    struct listNode *next;

    void *value;

} listNode;

其中listNode.value字段用于保存指向真实数据内存的指针。


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;

上述是双端链表本体的数据结构，其中list.len字段维护了链表的长度，这样可以让我们不需要遍历整个链表就可以获得链表的长度，此处需要吐槽一下g++ 4.8.5中的计算链表长度的方法，竟然是采用遍历的方法计算:


size_type

size() const _GLIBCXX_NOEXCEPT

{

return std::distance(begin(), end());

}

而数据结构中的三个函数指针，则可以根据需要，进行赋值，以定制化的根据不同数据类型实现不同的功能。


typedef struct listIter {

    listNode *next;

    int direction;

} listIter;

这个则是链表迭代器的结构体定义，listIter.direction则是标记了这个迭代器迭代的方向。

宏定义的基础操作

|宏定义|含义|

|#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)|返回节点的value节点指针|

|#define listSetDupMethod(l,m) ((l)->dup = (m))|为链表设定节点拷贝方法|

|#define listSetFreeMethod(l,m) ((l)->free = (m))|为链表设定节点释放方法|

|#define listSetMatchMethod(l,m) ((l)->match = (m))|为链表设定比较方法|

|#define listGetDupMethod(l) ((l)->dup)|返回链表拷贝方法的函数指针|

|#define listGetFree(l) ((l)->free)|返回链表释放方法的函数指针|

|#define listGetMatchMethod(l) ((l)->match)|返回链表比较方法的函数指针|

双端链表操作接口API

链表的创建、释放


list *listCreate(void);

这个函数会调用zmalloc函数，动态分配一个双端链表的结构体，如果分配失败，该函数会返回NULL指针；如果分配成功，那么会对list.head，list.tail，list.len字段进行初始化，成功后返回双端链表对象的指针。但是需要注意的是，list.dup，list.free，list.match这三个字段默认设置为NULL，如果有特殊需要设置的情况下，可以后续调用listSetDupMethod，listSetFreeMethod，listGetDupMethod手动设置。


void listEmpty(list *list);

这个函数会从链表中删除并释放所有的节点，如果这个链表定义了list.free的回调函数，那么在释放节点之前，会对节点listNode.value调用list.free进行处理；

这个函数并不会释放这个链表本身。


void listRelease(list *list);

这个函数通过调用listEmpty清空链表的元素，同时调用zfree来释放链表对象的内存。

链表节点的增加、删除与查找


list *listAddNodeHead(list *list, void *value);

list *listAddNodeTail(list *list, void *value)；

这两个函数会向链表头部或者尾部插入一个节点，这个节点将以给定的value指针多为节点的listNode.value。


list *listInsertNode(list *list, listNode *old_node, void *value, int after);

向链表的指定位置插入一个新的节点，这个指定的位置由old_node节点标记，如果after为1，则表示新的节点插入到old_node节点后面，否则插入到该节点的前面。


void listDelNode(list *list, listNode *node);

从链表list中，删除给定的node节点。


listNode *listSearchKey(list *list, void *key);

从list链表中搜索listNode.value等于key的节点，这里的等于的含义在于：

如果list链表中设置了list.match接口，那么通过list.match来判断是否等于。
如果没有定义list.match，那么直接比较二者是否指向同一内存。


if (list->match) {

    if (list->match(node->value, key)) {

        return node;

    }

} else {

    if (key == node->value) {

        return node;

    }

}


listNode *listIndex(list *list, long index);

这个函数用于对链表进行索引操作，这个索引值既可以是zero-based的正向索引，也可以使用从-1开始的一个反向索引，执行结束后，返回索引对应的节点的指针:


listNode *listIndex(list *list, long index) {

    listNode *n;

    if (index < 0) {

        index = (-index)-1;

        n = list->tail;

        while(index-- && n) n = n->prev;

    } else {

        n = list->head;

        while(index-- && n) n = n->next;

    }

    return n;

}

链表迭代器


listIter *listGetIterator(list *list, int direction);

void listReleaseIterator(listIter *iter);

listNode *listNext(listIter *iter);

其中listGetIterator可以根据传入的方向参数，生成一个正向或者反向迭代器，方向参数的定义在src/adlist.h头文件中：


#define AL_START_HEAD 0 //用于生成正向迭代器

#define AL_START_TAIL 1 //用于生成反向迭代器

而listReleaseIterator则用于释放一个迭代器；listNext用于对迭代器执行迭代操作，返回迭代器当前所指向的节点指针，同时根据方向，将迭代器移动到下一个操作。上述生成链表迭代器的操作所产生的迭代器是一个在堆空间上动态分配的迭代器，这个迭代器可以通过指针，在整个程序的生命周期有效，直到调用listReleaseIterator将其释放。而当我们仅仅需要在一个函数内，将链表迭代器作为局部变量使用的话，我们可以使用下面两个函数，来对栈上的局部迭代器进行初始化，同时系统会在函数调用结束后，自动释放该局部迭代器：


void listRewind(list *list, listIter *li);

void listRewindTail(list *list, listIter *li);

这两个函数分别用于初始化一个正向迭代器以及以及反向迭代器。其具体的用法可以如下所示：


listIter iter;

listNode *node;

listRewind(l, &iter);

while((node = listNext(&iter)) != NULL) {

//TODO:

}

链表特殊操作


list *listDup(list *orig);

该函数用于拷贝整个链表，如果通过listSetDupMethod为链表设置了Dup方法，那么将执行一次深度拷贝工作，也就是使用list.dup函数来对节点进行构造；否则的话，将执行一次浅拷贝，即将原始节点的value指针，赋值给新节点，也就是两个节点均引用同一个value。


void listRotate(list *list);

这个函数用于对链表执行翻转操作，也就是将链表的尾节点转移到链表的头部，循环调用该链表，可以实现翻转链表的操作。


void listJoin(list *l, list *o);

这个函数用于对两个链表执行连接操作，也就是将o链表中元素按照顺序连接到l链表的后面。

喜欢的同学可以扫描二维码，关注我的微信公众号，马基雅维利incoding