【redis源码阅读】skiplist

---

前言

基于带中文注释的redis3.0源码阅读，github地址：https://github.com/huangz1990/redis-3.0-annotated。redis的基础数据结构skiplist的源码位于zipset.c，其中zsl开头的函数就是skiplist的api。

---

一、数据结构

skiplist和普通链表一样，由多个节点构成。同样的，每个节点存储了成员对象，分值，还有一个后退指针。不同的是skiplist的每个节点上都有一个level数组，而且层数是随机的（1-32层），每层里面有一个前进指针和跨度。前进指针和普通链表节点的next指针差不多，但是不是指向下一个skiplist节点，而是下n个skiplist节点，这个n就是span。

/*
 * 跳跃表节点
 */
typedef struct zskiplistNode {
    // 成员对象
    robj *obj;
    // 分值
    double score;
    // 后退指针
    struct zskiplistNode *backward;
    // 层
    struct zskiplistLevel {
        // 前进指针
        struct zskiplistNode *forward;
        // 到本层下一个节点的跨度
        unsigned int span;
    } level[];
} zskiplistNode;

/*
 * 跳跃表
 */
typedef struct zskiplist {
    // 表头节点和表尾节点
    struct zskiplistNode *header, *tail;
    // 表中节点的数量
    unsigned long length;
    // 表中层数最大的节点的层数
    int level;
} zskiplist;

一个skiplist的结构如图所示，最下面的是zskiplistNode，里面的数值为score，其中head节点不存储数据，且他的level层数一定是所有节点中最大的。zskiplistNode由后退指针连起来。
在每个zskiplistNode上面的是zskiplistLevel，其中的数字表示span。
柱状图最上面的数字表示level层数。

二、查找

给定需要查找的分数s和元素e，skiplist查找流程如下
1、从head节点最顶层开始，通过前进指针查找下一个节点，若前进指针不为空且下一个节点小于（通过分数和元素比较大小）查找节点，则通过前进指针移动到该层的下一个节点查找
2、否则到下一层查找，直到第0层

可以看到每个节点的第0层的跨度都是1，相对于一个普通链表，因此查找时间复杂度最差是O(n)。平均时间复杂度是O(logn)。skiplist的查找过程可以理解为近似二分查找的查找。

三、插入

直接上代码，删除操作的流程和插入类似，就不上了

zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj) {
	// update[i]表示在第i层，新插入节点的前一个节点
    zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
    // rank[i]表示：在查找过程中，在第i层的前置节点在整个链表中的排序
    unsigned int rank[ZSKIPLIST_MAXLEVEL];
    int i, level;
    redisAssert(!isnan(score));

    // 在各个层查找节点的插入位置
    x = zsl->header;
    for (i = zsl->level-1; i >= 0; i--) {
        /* store rank that is crossed to reach the insert position */
        // 如果 i 不是 zsl->level-1 层
        // 那么 i 层的起始 rank 值为 i+1 层的 rank 值
        // 各个层的 rank 值一层层累积
        // 最终 rank[0] 的值就是新节点的前置节点的排位
        // rank[0] 会在后面成为计算 span 值和 rank 值的基础
        rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];

        // 沿着前进指针遍历跳跃表
        while (x->level[i].forward &&
            (x->level[i].forward->score < score ||
                // 比对分值
                (x->level[i].forward->score == score &&
                // 比对成员， T = O(N)
                compareStringObjects(x->level[i].forward->obj,obj) < 0))) {

            // 记录沿途跨越了多少个节点
            rank[i] += x->level[i].span;

            // 移动至下一指针
            x = x->level[i].forward;
        }
        // 记录将要和新节点相连接的节点
        update[i] = x;
    }

    /* we assume the key is not already inside, since we allow duplicated
     * scores, and the re-insertion of score and redis object should never
     * happen since the caller of zslInsert() should test in the hash table
     * if the element is already inside or not. 
     *
     * zslInsert() 的调用者会确保同分值且同成员的元素不会出现，
     * 所以这里不需要进一步进行检查，可以直接创建新元素。
     */

    // 获取一个随机值作为新节点的层数
    // T = O(N)
    level = zslRandomLevel();

    // 如果新节点的层数比表中其他节点的层数都要大
    // 那么初始化表头节点中未使用的层，并将它们记录到 update 数组中
    // 将来也指向新节点
    if (level > zsl->level) {

        // 初始化未使用层
        // T = O(1)
        for (i = zsl->level; i < level; i++) {
            rank[i] = 0;
            update[i] = zsl->header;
            update[i]->level[i].span = zsl->length;
        }

        // 更新表中节点最大层数
        zsl->level = level;
    }

    // 创建新节点
    x = zslCreateNode(level,score,obj);

    // 将前面记录的指针指向新节点，并做相应的设置
    // T = O(1)
    for (i = 0; i < level; i++) {
        
        // 设置新节点的 forward 指针
        x->level[i].forward = update[i]->level[i].forward;
        
        // 将沿途记录的各个节点的 forward 指针指向新节点
        update[i]->level[i].forward = x;

        /* update span covered by update[i] as x is inserted here */
        // 计算节点到下一个节点的跨度
        // update[i]->level[i].span是前置节点到下一个节点的跨度
        // 因为插入了一个节点，所以要用这个跨度减去 前置节点到新节点的跨度 作为新节点的跨度
        // 可以先理解下面那行代码，再回来看这行会好一些，下面画了个图帮助理解
        x->level[i].span = update[i]->level[i].span - (rank[0] - rank[i]);

        // 因为skiplist第0层是普通链表，所以rank[0]是新节点前置节点在整个skiplist中的排位
        // rank[i]是新节点第i层的前置节点
        // rank[0]-rank[i]+1就是新节点第i层前置节点的span
        update[i]->level[i].span = (rank[0] - rank[i]) + 1;
    }

    /* increment span for untouched levels */
    // 未接触的节点的 span 值也需要增一，这些节点直接从表头指向新节点
    // T = O(1)
    for (i = level; i < zsl->level; i++) {
        update[i]->level[i].span++;
    }

    // 设置新节点的后退指针
    x->backward = (update[0] == zsl->header) ? NULL : update[0];
    if (x->level[0].forward)
        x->level[0].forward->backward = x;
    else
        zsl->tail = x;

    // 跳跃表的节点计数增一
    zsl->length++;

    return x;
}

这里画了一个图来理解rank[]的含义已经更新span代码的含义。
假设我们插入一个分数为2.5的节点，节点层数为3

• 在第3层，新节点的前置节点update[2]是head节点，其span为3
• 那么rank[0]-rank[2]就是：第3层，head节点到新节点前置节点的距离
• 新节点到第3层下一个节点的距离就是：原来head到下一个节点的距离 + 1（因为插入了一个节点）再减去 head节点到新节点的距离，即update[2].level[2].span - (rank[0]-rank[2])
• 而head节点到新节点的距离 就是rank[0]-rank[2]+1

要理解span更新的逻辑需要清楚rank[0]-rank[i]算的是什么东西，他算的是：新节点在第i层的前置节点，到新节点在整个链表的前置节点的距离，然后这个距离加一就是第i层前置节点到新节点的距离了。

总结

skiplist的插入、删除、查找平均时间复杂度都是O(logn)。可以理解为能够进行近似二分查找的链表。