Redis跳躍表源碼解析

跳躍表是一種有序的資料結構，支援平均O(logN)、最壞O(N)複雜度的節點尋找。跳躍表應用在有序集合鍵和叢集節點的情境上。本文參考Redis3.0版本的源碼，注釋參考了黃建宏的注釋，並加上自己的理解。對於跳躍表和節點的定義是在redis.h中，而常用API的實現是在t_zset.c中。

定義：

/* * 跳躍表 */typedef struct zskiplist {    // 表前端節點和表尾節點    struct zskiplistNode *header, *tail;    // 表中節點的數量，不包含前端節點    unsigned long length;    // 表中層數最大的節點的層數，不包含前端節點    int level;} zskiplist;

/* ZSETs use a specialized version of Skiplists *//* * 跳躍表節點 */typedef struct zskiplistNode {    // 成員對象    robj *obj;    // 分值    double score;    // 後退指標    struct zskiplistNode *backward;    // 層    struct zskiplistLevel {        // 前進指標        struct zskiplistNode *forward;        // 跨度        unsigned int span;    } level[];} zskiplistNode;

以下為一個可能的跳躍表示例：

建立：zslCreate

/* * 建立並返回一個新的跳躍表 * * T = O(1) */zskiplist *zslCreate(void) {    int j;    zskiplist *zsl;    // 分配空間    zsl = zmalloc(sizeof(*zsl));    // 設定高度和起始層數    zsl->level = 1;    zsl->length = 0;    // 初始化表前端節點    // T = O(1)    zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);    for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {        zsl->header->level[j].forward = NULL;        zsl->header->level[j].span = 0;    }    zsl->header->backward = NULL;    // 設定表尾    zsl->tail = NULL;    return zsl;}

/* * 建立一個層數為 level 的跳躍表節點， * 並將節點的成員對象設定為 obj ，分值設定為 score 。 * * 傳回值為新建立的跳躍表節點 * * T = O(1) */zskiplistNode *zslCreateNode(int level, double score, robj *obj) {        // 分配空間    zskiplistNode *zn = zmalloc(sizeof(*zn)+level*sizeof(struct zskiplistLevel));    // 設定屬性    zn->score = score;    zn->obj = obj;    return zn;}

插入：最為核心的API

/* * 建立一個成員為 obj ，分值為 score 的新節點， * 並將這個新節點插入到跳躍表 zsl 中。 *  * 函數的傳回值為新節點。 */zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj) {    //這個update很巧妙，記錄了離插入位置最近的那個節點，儲存的是level[i].forward    //如果在跳躍表上追蹤記錄軌跡，則是豎折形狀。    zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x; //32    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 */        // rank[i]用來記錄第i層達到插入位置的所跨越的節點總數,也就是該層最接近(小於)給定score的排名         // rank[0]則是離插入位置最近的節點的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;            //初始化前端節點中未觸及到的區間[zsl->level,level)            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]..update[0]   插入x後順序: update[i]..update[0]..x          // rank[0]-rank[i]表示的是update[i]和update[0]之間的跨度span        // update[i]->level[i].span表示的是update[i]與update[i]->level[i]->forward之間的span         x->level[i].span = update[i]->level[i].span - (rank[0] - rank[i]);        // 更新新節點插入之後，沿途節點的 span 值        // 其中的 +1 計算的是新節點，表示時從update[i]->level[i]到x的span        update[i]->level[i].span = (rank[0] - rank[i]) + 1;    }    /* increment span for untouched levels */    //如果新節點的level小於跳躍表的最大層數，未接觸的節點的 span 值也需要增一，因為橫跨在新節點上方，這些節點直接從表頭指向新節點    // T = O(1)    for (i = level; i < zsl->level; i++) {        update[i]->level[i].span++;    }    // 設定新節點的後退指標    // 新節點可能直接插在前端節點的後面，這種情況下update[0]為header    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;}

/* Returns a random level for the new skiplist node we are going to create. * * 返回一個隨機值，用作新跳躍表節點的層數。 * * The return value of this function is between 1 and ZSKIPLIST_MAXLEVEL * (both inclusive), with a powerlaw-alike distribution where higher * levels are less likely to be returned.  * * 傳回值介乎 1 和 ZSKIPLIST_MAXLEVEL 之間（包含 ZSKIPLIST_MAXLEVEL）， * 根據隨機演算法所使用的冪次定律，越大的值產生的幾率越小。 * * T = O(N) */int zslRandomLevel(void) {    int level = 1;    while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))        level += 1;    return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;}

特別注意的是，這個層數建立時是根據冪次定律來隨機產生一個1-32之間的值。具體演算法參見隨機演算法。

刪除

/* Delete an element with matching score/object from the skiplist.  * * 從跳躍表 zsl 中刪除包含給定節點 score 並且帶有指定對象 obj 的節點。 * * T_wrost = O(N^2), T_avg = O(N log N) */int zslDelete(zskiplist *zsl, double score, robj *obj) {    zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;    int i;    // 遍曆跳躍表，尋找目標節點，並記錄所有沿途節點    // T_wrost = O(N^2), T_avg = O(N log N)    x = zsl->header;    for (i = zsl->level-1; i >= 0; i--) {        // 遍曆跳躍表的複雜度為 T_wrost = O(N), T_avg = O(log N)        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)))            // 沿著前進指標移動            x = x->level[i].forward;        // 記錄沿途節點        update[i] = x;    }    /* We may have multiple elements with the same score, what we need     * is to find the element with both the right score and object.      *     * 檢尋找到的元素 x ，只有在它的分值和對象都相同時，才將它刪除。     */    x = x->level[0].forward;    if (x && score == x->score && equalStringObjects(x->obj,obj)) {        // T = O(1)        zslDeleteNode(zsl, x, update);        // T = O(1)        zslFreeNode(x);        return 1;    } else {        return 0; /* not found */    }    return 0; /* not found */}

內部刪除：

/* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank  *  * 內部刪除函數， * 被 zslDelete 、 zslDeleteRangeByScore 和 zslDeleteByRank 等函數調用。 * * T = O(1) * 輸入update為與刪除節點x相關的前置節點數組，與插入操作的中的update類似 */void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {    int i;    // 更新所有和被刪除節點 x 有關的節點的指標，解除它們之間的關係    // 兩種情況:    // (1)與刪除節點x直接相連的：相加減1    // (2)橫跨刪除節點的：直接減1    // T = O(1)    for (i = 0; i < zsl->level; i++) {        if (update[i]->level[i].forward == x) {            update[i]->level[i].span += x->level[i].span - 1;            update[i]->level[i].forward = x->level[i].forward;        } else {            update[i]->level[i].span -= 1;        }    }    // 更新被刪除節點 x 的前進和後退指標：非尾節點和尾節點分別處理    if (x->level[0].forward) {        x->level[0].forward->backward = x->backward;    } else {        zsl->tail = x->backward;    }    // 更新跳躍表最大層數（只在被刪除節點是跳躍表中最高的節點時才執行）    // T = O(1)    // 遍曆前端節點的level數組，直到找到第一個前進指標不為NULL的    while(zsl->level > 1 && zsl->header->level[zsl->level-1].forward == NULL)        zsl->level--;    // 跳躍表節點計數器減一    zsl->length--;}

zslGetRank：

/* Find the rank for an element by both score and key. * * 尋找包含給定分值和成員對象的節點在跳躍表中的排位。 * * Returns 0 when the element cannot be found, rank otherwise. * * 如果沒有包含給定分值和成員對象的節點，返回 0 ，否則返回排位。 * * Note that the rank is 1-based due to the span of zsl->header to the * first element.  * * 注意，因為跳躍表的表頭也被計算在內，所以返回的排位以 1 為起始值。 * * T_wrost = O(N), T_avg = O(log N) */unsigned long zslGetRank(zskiplist *zsl, double score, robj *o) {    zskiplistNode *x;    unsigned long rank = 0;    int i;    // 遍曆整個跳躍表    x = zsl->header;    for (i = zsl->level-1; i >= 0; i--) {        // 遍曆節點並對比元素        while (x->level[i].forward &&            (x->level[i].forward->score < score ||                // 比對分值                (x->level[i].forward->score == score &&                // 比對成員對象                compareStringObjects(x->level[i].forward->obj,o) <= 0))) {            // 累積跨越的節點數量            rank += x->level[i].span;            // 沿著前進指標遍曆跳躍表            x = x->level[i].forward;        }        /* x might be equal to zsl->header, so test if obj is non-NULL */        // x可能為空白節點，需要進行非空判斷。必須確保不僅分值相等，而且成員對象也要相等        // T = O(N)        if (x->obj && equalStringObjects(x->obj,o)) {            return rank;        }    }    // 沒找到    return 0;}

參考文獻：

https://blog.csdn.net/men_wen/article/details/70040026

https://blog.csdn.net/kisimple/article/details/38706729

http://makaidong.com/yongning99/1/88707_10585499.html