redis源码分析[01]-双向链表结构-队列的底层实现-adlist

1. redis 的 list类型的底层实现就是用的双向链表-adlist,以下是数据结构

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);//本链表的复制方法
    void (*free)(void *ptr);//本链表的内存回收方法
    int (*match)(void *ptr, void *key);//本链表对节点的比较方法
    unsigned long len;//本链表的长度
} list;

2. 以下是针对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;
}

//回收一个链表的方法，从表头开始，逐个释放
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);
}

//向表头添加一个节点，并赋值为value
list *listAddNodeHead(list *list, void *value)
{
    listNode *node;

    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;
    if (list->len == 0) {//如果此时链表长度为0则表头表尾指针都指向这个新节点
        list->head = list->tail = node;
        node->prev = node->next = NULL;
    } else {
        node->prev = NULL;//第一个节点的上一个节点永远为null
        node->next = list->head;
        list->head->prev = node;
        list->head = node;
    }
    list->len++;
    return list;
}

//向表尾添加一个节点，并赋值为value
list *listAddNodeTail(list *list, void *value)
{
    listNode *node;

    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;
    if (list->len == 0) {//如果此时链表长度为0则表头表尾指针都指向这个新节点
        list->head = list->tail = node;
        node->prev = node->next = NULL;
    } else {
        node->prev = list->tail;
        node->next = NULL;//最后一个节点的下一个节点永远为null
        list->tail->next = node;
        list->tail = node;
    }
    list->len++;
    return list;
}
//向链表list插入一个新节点，值为value,参照节点是old_node,由after决定是前还是后
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) {//新节点在参照节点之后
        node->prev = old_node;//新节点的上一个节点指向参照节点
        node->next = old_node->next;
        if (list->tail == old_node) {
            list->tail = node;
        }
    } else {
        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;
}

//从链表中删除一个节点，先调整相邻节点的指针，然后回收内存即可
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--;
}

//创建一个迭代器
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;
}

//回收一个迭代器
void listReleaseIterator(listIter *iter) {
    zfree(iter);
}

//重置迭代器，方向是正向
void listRewind(list *list, listIter *li) {
    li->next = list->head;
    li->direction = AL_START_HEAD;
}
//重置迭代器，方向是逆向
void listRewindTail(list *list, listIter *li) {
    li->next = list->tail;
    li->direction = AL_START_TAIL;
}

//根据迭代器返回下一个迭代的节点
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;
}

//复制一个链表
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;
    listRewind(orig, &iter);
    while((node = listNext(&iter)) != NULL) {
        void *value;

        if (copy->dup) {
            value = copy->dup(node->value);
            if (value == NULL) {
                listRelease(copy);
                return NULL;
            }
        } else
            value = node->value;
        if (listAddNodeTail(copy, value) == NULL) {
            listRelease(copy);
            return NULL;
        }
    }
    return copy;
}

//迭代链表，查找匹配key的节点
listNode *listSearchKey(list *list, void *key)
{
    listIter iter;
    listNode *node;

    listRewind(list, &iter);
    while((node = listNext(&iter)) != NULL) {
        if (list->match) {
            if (list->match(node->value, key)) {
                return node;
            }
        } else {
            if (key == node->value) {
                return node;
            }
        }
    }
    return NULL;
}

//迭代list,找到第index个节点
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;
}

//旋转list一次，即将一个尾节点移到链表的头部
void listRotate(list *list) {
    listNode *tail = list->tail;

    if (listLength(list) <= 1) return;

    /* Detach current tail */
    list->tail = tail->prev;
    list->tail->next = NULL;
    /* Move it as head */
    list->head->prev = tail;
    tail->prev = NULL;
    tail->next = list->head;
    list->head = tail;
}