redis源码阅读—adlist

链表的定义

每一个节点都是listNode，拥有前驱节点，后继节点和值，其实就是C语言中链表中的结点。

typedef struct listNode {
    struct listNode *prev; //前驱节点，如果是list的头结点，则prev指向NULL 
    struct listNode *next; //后继节点，如果是list尾部结点，则next指向NULL
    void *value; //节点的值
} listNode;

只要有多个节点就可以组成一个链表了，但是redis再在外面封装了一层，也就是使用adlist.h/list来实现，这样操作起来更加方便。

typedef struct list {
    // 表头节点
    listNode *head;
    // 表尾节点
    listNode *tail;
    // 链表所包含的节点数量
    unsigned long len;
    // 节点值复制函数
    void *(*dup)(void *ptr);
    // 节点值释放函数
    void (*free)(void *ptr);
    // 节点值对比函数
    int (*match)(void *ptr, void *key);
} list;

list 结构为链表提供了表头指针 head 、表尾指针 tail ， 以及链表长度计数器 len ， 而 dup 、 free 和 match 成员则是用于实现多态链表所需的类型特定函数：

• dup 函数用于复制链表节点所保存的值；
• free 函数用于释放链表节点所保存的值；
• match 函数则用于对比链表节点所保存的值和另一个输入值是否相等。

链表逻辑图

链表的创建和操作源码阅读

创建表头

我们创建list表结构，首先需要判断当前是否有可分配的空间来创建，使用zmalloc方法来分配空间，如果分配不了，则返回NULL，如果可以分配，则继续。接着赋值list的头节点head和尾节点tail为NULL，len为0，赋值相关函数为NULL。最后返回结果list。

/* Create a new list. The created list can be freed with
 * AlFreeList(), but private value of every node need to be freed
 * by the user before to call AlFreeList().
 *
 * On error, NULL is returned. Otherwise the pointer to the new list. */

//创建一个表头，返回值是链表结构的指针 
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;
}

清空表

传入list的指针，首先定义当前节点current，使其指向头指针，定义len，使其等于list的长度。接着进行循环，每次len减一，定义新节点next，始终指向当前节点current的下一个节点，如果有值，则释放该节点，当前节点current后移，next节点同样后移。直到len为0，释放完所有节点，退出循环。最后赋值list的头节点head和尾节点tail为NULL，len为0。

注意：这边和SDS一样，清空并不是直接删除list，而是删除其数据，外层的list结构仍然存在。这其实上是惰性删除。

/* Remove all the elements from the list without destroying the list itself. */
void listEmpty(list *list)
{
    unsigned long len;
    //定义两个节点指针
    listNode *current, *next;

    //当前节点执行list的头指针位置 即list的第一个元素
    current = list->head;
    //len为list的长度   
    len = list->len;
    //循环 每次len减一
    while(len--) {
        //先让下一个指针指向下一个节点，因为底下直接释放当前节点，如果不在此处复制，底下就获取不到了
        next = current->next;
        //释放当前节点的值
        if (list->free) list->free(current->value);
         //释放当前节点
        zfree(current);
        //当前节点等于刚才的下一个节点next，即开始往后移，开始下一轮循环
        current = next;
    }
    //释放完给头指针head,尾指针tail赋值为NULL
    list->head = list->tail = NULL;
    //len赋值为0
    list->len = 0;
}

添加元素到表头

添加元素到表头，首先新建一个新节点node，判断是否有内存分配，如果有，则继续，如果没有，则返回NULL，退出方法。这边新节点是用来存在输入参数中的value的，所以需要内存。接着将新节点node的value值赋值为输入参数value。最后需要调整list的头指针，尾指针，原来第一个节点的指针情况（这边看下图，描述起来有点混乱，图片一目了然）。最最后，就是list的len加1，返回list。

举个例子，如果要在list中插入节点f，首先将节点的头指针赋值为空（对应步骤1），然后将新节点的尾指针next指向第一个节点（对应步骤2），将第一个节点的prev指向新节点（对应步骤3），最后将list的头指针head指向新节点（对应步骤4）。这边需要注意的是，步骤2和步骤3需要在步骤4前面，不然会找到第一个节点。

//添加一个元素到表头 
list *listAddNodeHead(list *list, void *value)
{
    listNode *node;
 
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;//为当前节点赋值 
    //如果当前list为空 
    if (list->len == 0) {
        list->head = list->tail = node;//头尾指针都指向该节点 
        node->prev = node->next = NULL;//当前节点的头尾指针都为null 
    } else {//如果当前list不为空 
        node->prev = NULL;//新节点的前驱指向为null 
        node->next = list->head;//新节点的后继指向原来的的头节点
        list->head->prev = node;//原来的头节点的前驱指向新节点 
        list->head = node;//链表的头指针指向新节点 
    }
    list->len++;//list长度+1 
    return list;
}

添加元素到表尾

添加元素到表尾，首先新建一个新节点node，判断是否有内存分配，如果有，则继续，如果没有，则返回NULL，退出方法。这边新节点是用来存在输入参数中的value的，所以需要内存。接着将新节点node的value值赋值为输入参数value。最后需要调整list的头指针，尾指针，原来最后一个节点的指针情况（这边看下图，描述起来有点混乱，图片一目了然）。最最后，就是list的len加1，返回list。

举个例子，如果要在list中插入节点f，首先将节点的尾指针赋值为空（对应步骤1），然后将新节点的头指针指向最后一个节点（对应步骤2），将最后一个节点的next指向新节点（对应步骤3），最后将list的尾指针tail指向新节点（对应步骤4）。

//添加元素到表尾
list *listAddNodeTail(list *list, void *value)
{
    //新建节点node
    listNode *node;
    //尝试分配内存
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    //为新节点node赋值
    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;
    }
    //len加1
    list->len++;
    return list;
} 

插入

为list的某个节点old_node的after（前后）插入新值value，首先新建一个新节点node，判断是否有内存分配，如果有，则继续，如果没有，则返回NULL，退出方法。这边新节点是用来存在输入参数中的value的，所以需要内存。（这段话是不是听的耳朵都起茧子啦🤣）接着根据after的值确定是在节点old_node的前面插入新数据，还是在节点old_node的后面插入新数据，具体的是指针的调整。最后len加1，返回list。

//在list的某个位置old_node的after(前后)插入value值 
list *listInsertNode(list *list, listNode *old_node, void *value, int after) {
    listNode *node;
 
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;
    if (after) {//大于0，后面插入新节点 
        node->prev = old_node;
        node->next = old_node->next;
        if (list->tail == old_node) {
            list->tail = node;
        }
    } else {//小于0，前面插入新节点 
        node->next = old_node;
        node->prev = old_node->prev;
        if (list->head == old_node) {
            list->head = node;
        }
    }
    if (node->prev != NULL) {
        node->prev->next = node;
    }
    if (node->next != NULL) {
        node->next->prev = node;
    }
    list->len++;
    return list;
}

删除

从list中删除节点node，如果该节点的前面存在节点，使其前面一个节点的next指针指向node后面一个节点的地址，其实就是跳过了node节点，如果该节点的前面不存在节点，则将list的头指针指向node的下一节点地址。同样的，如果该节点的后面存在节点，逻辑一样的。最后释放要删除的节点node内存，len减1。

//从链表list中删除某个节点node 
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;
    //释放当前节点node的值
    if (list->free) list->free(node->value);
    //释放内存 
    zfree(node);
     //len-1 
    list->len--;
}

---

还有一些其他的API

listIter *listGetIterator(list *list, int direction);
listNode *listNext(listIter *iter);
void listReleaseIterator(listIter *iter);
list *listDup(list *orig);
listNode *listSearchKey(list *list, void *key);
listNode *listIndex(list *list, long index);
void listRewind(list *list, listIter *li);
void listRewindTail(list *list, listIter *li);
void listRotate(list *list);
void listJoin(list *l, list *o);

参考文章：双向链表都不懂，还说懂Redis?