Redis5.0 数据结构之整数集合intset源码详解

前言

文本将基于源码分析Redis中整数集合intset的数据结构以及使用中的主要操作，主要包括元素添加、整数集合升级、元素删除以及元素查找的函数实现源码分析。

本文源码版本为Redis 5.0，本篇博文中出现的源码均可以在intset.h以及intset.c两个文件中找到。源码阅读不易，如出现纰漏或理解错误，还望读者指正。

intset概述

整数集合intset是集合键（set）的底层实现之一，当一个set集合只包含少量整数值元素时(主要原因是数量越多效率越低)，Redis会使用intset作为集合键的底层实现。

intset可以保存Redis中int16_t、int32_t和int64_t类型的整数，并且保证集合中不会出现重复的元素。

集合中的元素类型是统一的，即要么全是int16_t类型，要么全是int32_t类型，此处涉及到升级操作，即例如全是int16_t类型的数据中添加了一个int32_t类型的值，此时需要改变集合内全部的数据类型，集合一旦升级后无论发生什么，不再降级。

源码解析

数据结构

intset的数据结构定义如下：

typedef struct intset {
   
	// 编码方式
    uint32_t encoding;
    // 集合包含元素数量 即contents长度
    uint32_t length;
    // 实际保存元素的数组 数组内数值从小到大排列
    int8_t contents[];
} intset;

元素添加

元素添加函数函数为intsetAdd，源码如下

/* Insert an integer in the intset */
intset *intsetAdd(intset *is, int64_t value, uint8_t *success) {
   
	// 首先调用函数计算value值的长度 用于比较当前intset编码长度是否够用
	// _intsetValueEncoding函数见下 内容易懂 不多加解释
    uint8_t valenc = _intsetValueEncoding(value);
    uint32_t pos;
    // 默认认定添加成功 添加失败指intset里已经存在了value值
    if (success) *success = 1;

    /* Upgrade encoding if necessary. If we need to upgrade, we know that
     * this value should be either appended (if > 0) or prepended (if < 0),
     * because it lies outside the range of existing values. */
	// 判断当前的value长度与intset的编码长度大小
	// intrev32ifbe函数用作大小端转换
	/
	// 代码走到if分支 说明两件事 一是intset一定需要升级 二是添加必然成功
    if (valenc > intrev32ifbe(is->encoding)) {
   
        /* This always succeeds, so we don't need to curry *success. */
        // 调用升级并添加函数 该函数逻辑流程见下文
        return intsetUpgradeAndAdd(is,value);
	// 代码走到该分支说明不需要升级 但有可能添加失败 需要检查value是否存在
    } else {
   
        /* Abort if the value is already present in the set.
         * This call will populate "pos" with the right position to insert
         * the value when it cannot be found. */
        
        // 如果从intset中查询到了value 则不需要添加 设置添加标识为0标识添加失败后返回
        // 执行intsetSearch后pos被赋值 值为value应该在的位置
        if (intsetSearch(is,value,&pos)) {
   
            if (success) *success = 0;
            return is;
        }
        
		// 首先为intset重新分配空间 长度为原长度+1 函数见下
        is = intsetResize(is,intrev32ifbe(is->length)+1);
        // 如果value值不是应该在contents末尾 需要将所有大于value的值向后移动 函数见下
        if (pos < intrev32ifbe(is->length)) intsetMoveTail(is,pos,pos+1);
    }

	// 将新元素添加到contents数组中的pos位置 函数见下
    _intsetSet(is,pos,value);
    // 用于表示contents长度的计数器+1
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);
    return is;
}

// 获取value值的编码长度
static uint8_t _intsetValueEncoding