Redis学习——链表源码分析

0. 前言

　　Redis 中的链表是以通用链表的形式实现的，而对于链表的用途来说，主要的功能就是增删改查，所以对于查找来说，redis其提供了一个match函数指针，用户负责实现其具体的匹配操作，从而实现通用化。

 　　涉及的文件：adlist.h/adlist.c

1. 数据结构

typedef struct listNode {
    struct listNode *prev;
    struct listNode *next;
    void *value;                //通用实现，可以存放任意类型的数据
} listNode;

typedef struct listIter {
    listNode *next;
    int direction;          //用于控制链表遍历的方向
} listIter;

typedef struct list {
    listNode *head;                     //表头
    listNode *tail;                         //表尾
    void *(*dup)(void *ptr);        //用于复制ptr值，实现深度复制
    void (*free)(void *ptr);           //释放对应类型结构的内存
    int (*match)(void *ptr, void *key); //自定义匹配key
    unsigned long len;                  //节点数量
} list;

 　

#define listSetDupMethod(l,m) ((l)->dup = (m))
#define listSetFreeMethod(l,m) ((l)->free = (m))
#define listSetMatchMethod(l,m) ((l)->match = (m))

　　其中提供了dup,free,match的函数指针，用户可以通过设置该函数指针，来存取特定类型的数据。

2. API实现：

　　只提取几个主要的API，该文件完整的注释在GitHud上(用户名：jabnih)

a. listRelease

　　对于释放链表的操作，其中对于每个节点的释放会判断用户是否设置了free函数，若有则执行用户的操作，用以释放特定类型数据。例如：value为指向一个从堆分配的字符数组，在释放该节点的时候，就需要先释放value内存

对于free可以实现为：

void free(void * value)
{
    if( value )
        free( (char *)value );
}

 //释放链表
void listRelease(list *list)
{
    unsigned long len;
    listNode *current, *next;

    current = list->head;
    len = list->len;
    while(len--) {
        next = current->next;
        //若设置了free函数，则调用该自定义free函数
        if (list->free) list->free(current->value);
        
        zfree(current);
        current = next;
    }
    zfree(list);
}

b. listDup

　　当执行复制的时候，对于设置了dup函数可以实现深度复制或自定义复制的功能。

//复制链表，若有链表有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;

        //将复制后的节点添加的copy链表尾部
        if (listAddNodeTail(copy, value) == NULL) {
            listRelease(copy);
            listReleaseIterator(iter);
            return NULL;
        }
    }
    listReleaseIterator(iter);
    return copy;
}

c. listSearchKey

 //查找节点,如果设置了match方法，则使用match方法比较，否则仅仅比较节点的value值
listNode *listSearchKey(list *list, void *key)
{
    listIter *iter;
    listNode *node;

    iter = listGetIterator(list, AL_START_HEAD);
    while((node = listNext(iter)) != NULL) {
        if (list->match) {
            if (list->match(node->value, key)) {
                //这里可以将下面两条语句改为break(下同)，最后return NULL改为 return node
                listReleaseIterator(iter);
                return node;
            }
        } else {
            if (key == node->value) {
                listReleaseIterator(iter);
                return node;
            }
        }
    }
    listReleaseIterator(iter);
    return NULL;
}

3. 总结

　　1. 通用链表实现

　　2. 对外提供扩展，用户可以自定义查找，复制，释放的功能。