1. 程式人生 > 其它 >redis原始碼閱讀-資料結構篇-跳錶

redis原始碼閱讀-資料結構篇-跳錶

@

目錄

4. 跳錶實現 redis.h 和 t_zset.c

資料結構定義

  • object

    // 包含 meta 和 資料 指標
    #define REDIS_LRU_BITS 24
    typedef struct redisObject {
        unsigned type:4;				// 型別
        unsigned encoding:4;  			// 編碼
        unsigned lru:REDIS_LRU_BITS; 	// 物件最後一次被訪問的時間
        int refcount;					// 引用計數
        void *ptr;						// 指向實際值的指標
    } robj;
    
  • 跳錶節點 value 為 object*

    typedef struct zskiplistNode {
        robj *obj; 							// 成員物件
        double score; 						// 分值
        struct zskiplistNode *backward;		// 後退指標
        struct zskiplistLevel {
            struct zskiplistNode *forward; 	// 前進指標
            unsigned int span;				// 跨度
        } level[]; 							// 層
    } zskiplistNode;
    
  • 跳錶

    // meta 和 首尾指標
    typedef struct zskiplist {
        struct zskiplistNode *header, *tail;	// 表頭節點和表尾節點
        unsigned long length;					// 表中節點的數量
        int level;								// 表中層數最大的節點的層數
    } zskiplist;
    

Helper函式(可跳過,需要時閱讀)

  • 生成隨機層數 O(1)

    // 介於 1 - ZSKIPLIST_MAXLEVEL
    // 層數越大,生成概率越小
    int zslRandomLevel(void) {
        int level = 1;
        while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
            level += 1;
        return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
    }
    
  • 範圍判斷O(1)

    // 資料結構
    // 開區間/閉區間範圍
    typedef struct {
        // 最小值和最大值
        double min, max;
        // 指示最小值和最大值是否*不*包含在範圍之內
        // 值為 1 表示不包含,值為 0 表示包含
        int minex, maxex; 
    } zrangespec;
    
    // 大於等於最小值
    static int zslValueGteMin(double value, zrangespec *spec) {
        return spec->minex ? (value > spec->min) : (value >= spec->min);
    }
    // 小於等於最大值
    static int zslValueLteMax(double value, zrangespec *spec) {
        return spec->maxex ? (value < spec->max) : (value <= spec->max);
    }
    
    // 此處往下的範圍函式,只展示其一
    typedef struct {
        robj *min, *max;  
        int minex, maxex; 
    } zlexrangespec;
    
    static int zslLexValueGteMin(robj *value, zlexrangespec *spec) {
        return spec->minex ?
            (compareStringObjectsForLexRange(value,spec->min) > 0) :
            (compareStringObjectsForLexRange(value,spec->min) >= 0);
    }
    
    static int zslLexValueLteMax(robj *value, zlexrangespec *spec) {
        return spec->maxex ?
            (compareStringObjectsForLexRange(value,spec->max) < 0) :
            (compareStringObjectsForLexRange(value,spec->max) <= 0);
    }
    
  • list 和 範圍是否有交集 O(1)

    // 全list score 範圍判斷,是否有交集
    int zslIsInRange(zskiplist *zsl, zrangespec *range) {
        zskiplistNode *x;
        // 先排除總為空的範圍值
        if (range->min > range->max ||
                (range->min == range->max && (range->minex || range->maxex)))
            return 0;
        // list 按照 score 升序排序
        // 檢查最大分值
        x = zsl->tail;
        if (x == NULL || !zslValueGteMin(x->score,range))
            return 0;
        // 檢查最小分值
        x = zsl->header->level[0].forward;
        if (x == NULL || !zslValueLteMax(x->score,range))
            return 0;
        return 1;
    }
    
  • 第一個範圍內的 node O(logn)

    zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec *range) {
        zskiplistNode *x;
        int i;
        if (!zslIsInRange(zsl,range)) return NULL;
        // 遍歷跳躍表,查詢符合範圍 min 項的節點 T_wrost = O(N), T_avg = O(log N)
        x = zsl->header;
        for (i = zsl->level-1; i >= 0; i--) {
            while (x->level[i].forward &&
                !zslValueGteMin(x->level[i].forward->score,range))
                    x = x->level[i].forward;
        }
        x = x->level[0].forward;
        redisAssert(x != NULL);
        // 檢查節點是否符合範圍的 max 項
        if (!zslValueLteMax(x->score,range)) return NULL;
        return x;
    }
    
  • 最後一個範圍內的 node O(logn)

    zskiplistNode *zslLastInRange(zskiplist *zsl, zrangespec *range) {
        zskiplistNode *x;
        int i;
        // 確保跳躍表中至少有一個節點符合 range 指定的範圍,
        if (!zslIsInRange(zsl,range)) return NULL;
    
        // 遍歷跳躍表,查詢符合範圍 max 項的節點 T_wrost = O(N), T_avg = O(log N)
        x = zsl->header;
        for (i = zsl->level-1; i >= 0; i--) {
            /* Go forward while *IN* range. */
            while (x->level[i].forward &&
                zslValueLteMax(x->level[i].forward->score,range))
                    x = x->level[i].forward;
        }
        redisAssert(x != NULL);
        // 檢查節點是否符合範圍的 min 項
        if (!zslValueGteMin(x->score,range)) return NULL;
        return x;
    }
    

node 建構函式 O(1)

// 分配 skiplist node的記憶體,設定 meta
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;
}

建構函式 O(1)

zskiplist *zslCreate(void) {
    int j;
    zskiplist *zsl;
    zsl = zmalloc(sizeof(*zsl));	// 分配空間
    zsl->level = 1; 				// 設定高度和起始層數
    zsl->length = 0;
    zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL); // 初始化表頭節點,具有最大level,輔助節點不設值
    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;				// 表尾初始為 NULL
    return zsl;
}

node 解構函式 O(1)

不負責 object 的析構,只減少引用計數

void zslFreeNode(zskiplistNode *node) {
    decrRefCount(node->obj);
    zfree(node);
}

解構函式 O(n)

只負責本身 和 所有 node 的析構

不負責 object 的析構,只減少引用計數

void zslFree(zskiplist *zsl) {
    // level 0 可遍歷所有節點
    zskiplistNode *node = zsl->header->level[0].forward, *next;
    zfree(zsl->header);		// 釋放表頭
    while(node) { 			// 釋放表中所有節點
        next = node->level[0].forward;
        zslFreeNode(node);
        node = next;
    }
    zfree(zsl);				// 釋放跳躍表結構
}

insert object O(logn)

zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj) {
   	zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
    unsigned int rank[ZSKIPLIST_MAXLEVEL];
    int i, level;
    x = zsl->header;	// 在各個層查詢節點的插入位置 T_wrost = O(N), T_avg = O(log N)
    for (i = zsl->level-1; i >= 0; i--) {
        // 如果 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];
        // 沿著前進指標遍歷跳躍表, T_wrost = O(N^2), T_avg = O(N log N)
        while (x->level[i].forward && 					// 非空
            (x->level[i].forward->score < score ||		// score 大 或者
                (x->level[i].forward->score == score && // score 相等 並且 obj 大
                compareStringObjects(x->level[i].forward->obj,obj) < 0))) {
            rank[i] += x->level[i].span; 				// 記錄沿途跨越了多少個節點
            x = x->level[i].forward;  					// 移動至下一指標
        }												// 直到 x 的 score 大 或者 obj 大
        update[i] = x; 	// 記錄將要和新節點相連線的節點
    }
    level = zslRandomLevel();   // 獲取一個隨機值作為新節點的層數
    if (level > zsl->level) {	// 出現新level,注意初始level為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); // 建立新節點
    for (i = 0; i < level; i++) {		// 將前面記錄的指標指向新節點,並做相應的設定
        x->level[i].forward = update[i]->level[i].forward;// 設定新節點的 forward 指標
        update[i]->level[i].forward = x;// 將沿途記錄的各個節點的 forward 指標指向新節點
        x->level[i].span = update[i]->level[i].span - (rank[0] - rank[i]);// 計算新節點跨越的節點數量
        update[i]->level[i].span = (rank[0] - rank[i]) + 1;// 更新新節點插入之後,沿途節點的 span 值
    }
    for (i = level; i < zsl->level; i++) {// 未接觸的節點的 span 值也需要增一,這些節點直接從表頭指向新節點
        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;
}

delete object O(logn)

// O(1)
// 確定的node,帶有 insert 時相同的 update陣列,僅刪除連結串列結構,不涉及記憶體
void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
    int i;
    for (i = 0; i < zsl->level; i++) {  // 更新所有和被刪除節點 x 有關的節點的指標,解除它們之間的關係
        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;
        }
    }
    if (x->level[0].forward) {// 更新被刪除節點 x 的前進和後退指標
        x->level[0].forward->backward = x->backward;
    } else {
        zsl->tail = x->backward;
    }
    // 更新跳躍表最大層數(只在被刪除節點是跳躍表中最高的節點時才執行)
    while(zsl->level > 1 && zsl->header->level[zsl->level-1].forward == NULL)
        zsl->level--;
    // 跳躍表節點計數器減一
    zsl->length--;
}

// 尋找並刪除帶有 score 的 obj,釋放 node 記憶體
int zslDelete(zskiplist *zsl, double score, robj *obj) {
    zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
    int i;
    // 遍歷跳躍表,查詢目標節點,並記錄所有沿途節點, T_wrost = O(N), T_avg = O(log N)
    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,obj) < 0)))
            x = x->level[i].forward;												// 比較繼續
        update[i] = x;	// 此節點小於目標節點
    }
    //檢查詢到的元素 x ,只有在它的分值和物件都相同時,才將它刪除。
    x = x->level[0].forward;
    if (x && score == x->score && equalStringObjects(x->obj,obj)) {
        zslDeleteNode(zsl, x, update);
        zslFreeNode(x);
        return 1;
    } else {
        return 0; 
    }
    return 0; 
}

根據score,範圍刪除 O(logn)

unsigned long zslDeleteRangeByScore(zskiplist *zsl, zrangespec *range, dict *dict){
    zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
    unsigned long removed = 0;
    int i;
    // 記錄所有和被刪除節點(們)有關的節點 T_wrost = O(N) , T_avg = O(log N)
    x = zsl->header;
    for (i = zsl->level-1; i >= 0; i--) {
        while (x->level[i].forward && (range->minex ?
            x->level[i].forward->score <= range->min :
            x->level[i].forward->score < range->min))
                x = x->level[i].forward;
        update[i] = x;
    }
    x = x->level[0].forward; // 定位到給定範圍開始的第一個節點
    while (x && 			// 刪除範圍中的所有節點
           (range->maxex ? x->score < range->max : x->score <= range->max)){
        // 記錄下個節點的指標
        zskiplistNode *next = x->level[0].forward;
        zslDeleteNode(zsl,x,update);
        dictDelete(dict,x->obj);
        zslFreeNode(x);
        removed++;
        x = next;
    }
    return removed;
}

根據rank,範圍刪除 O(logn)

unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
    zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
    unsigned long traversed = 0, removed = 0;
    int i;
    // 找到start,並記錄所有沿途指標 T_wrost = O(N) , T_avg = O(log N)
    x = zsl->header;
    for (i = zsl->level-1; i >= 0; i--) {
        while (x->level[i].forward && (traversed + x->level[i].span) < start) {
            traversed += x->level[i].span;
            x = x->level[i].forward;
        }
        update[i] = x;
    }
    traversed++; 						// 移動到排位的起始的第一個節點
    x = x->level[0].forward;
    while (x && traversed <= end) {		// 刪除所有在給定排位範圍內的節點
        zskiplistNode *next = x->level[0].forward;// 記錄下一節點的指標
        zslDeleteNode(zsl,x,update);	// 從跳躍表中刪除節點
        dictDelete(dict,x->obj);     	// 從字典中刪除節點
        zslFreeNode(x);					// 釋放節點結構
        removed++;						// 為刪除計數器增一
        traversed++;					// 為排位計數器增一
        x = next;						// 處理下個節點
    }
    return removed;						// 返回被刪除節點的數量
}

獲取 rank O(logn)

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;				// 沿著前進指標遍歷跳躍表
        }
        if (x->obj && equalStringObjects(x->obj,o)) {// 確認是否 equal,否則繼續
            return rank;
        }
    }
    return 0;
}

get by rank O(logn)

zskiplistNode* zslGetElementByRank(zskiplist *zsl, unsigned long rank) {
    zskiplistNode *x;
    unsigned long traversed = 0;
    int i;
    x = zsl->header;
    for (i = zsl->level-1; i >= 0; i--) {
        while (x->level[i].forward // 遍歷跳躍表並累積越過的節點數量
               && (traversed + x->level[i].span) <= rank){
            traversed += x->level[i].span;
            x = x->level[i].forward;
        }
        if (traversed == rank) {	// 找到節點
            return x;
        }
    }
    return NULL;				// 沒找到目標節點
}