Redis IntSet深度剖析：从跟上理解IntSet的编码升级机制

前言

在Redis中有一个Set类型，用来存储不重复的元素，在Java中有类似的数据结构HashSet，底层是基于hash表来实现的。

而Redis中Set的实现也是类似的，底层实现方式之一就是IntSet，在存储的元素都是整数的时候，会使用IntSet这种更省空间的方式来存储数据。

什么是IntSet？

IntSet是Redis中Set集合的一种实现方式，基于整数数组来实现，并且具备长度可变、有序等特征。

当我们添加的元素都是整数的时候，会使用IntSet进行存储，如下所示：

127.0.0.1:6370> sadd s1 1 2 3 4
(integer) 4
127.0.0.1:6370> object encoding s1
"intset"

IntSet底层结构

IntSet定义如下：

typedef struct intset {
    uint32_t encoding; // 编码方式，支持存放16位，32位，64位的整数
    uint32_t length; // 元素个数
    int8_t contents[]; // 整数数组，保存集合数据
} intset;

其中encoding编码方式有三种：

• INTSET_ENC_INT16：2字节整数，范围类似于Java的short，每2个字节表示一个整数元素
• INTSET_ENC_INT32：4字节整数，范围类似于Java的int，每4个字节表示一个整数元素
• INTSET_ENC_INT64：8节整数，范围类似于Java的long，每8个字节表示一个整数元素

虽然从结构体的定义上看到将intset的contents声明为int8_t类型，但实际上contents数组不会保存任何int8_t类型的值，contents保存的真正类型取决于encoding的编码方式。

为了查找方便，Redis会将IntSet中所有的整数按照升序依次保存在contents数组中，结构图如下： 数组中每个数组都在int16_t的范围内，因此采用的编码方式是INTSET_ENC_INT16，每部分占用的字节数如下：

• encoding：4字节
• length：4字节
• contents：2字节*length=6字节

IntSet新增流程

IntSet新增逻辑实现在intsetAdd()函数中，核心逻辑如下：

源代码如下：

intset *intsetAdd(intset *is, int64_t value, uint8_t *success) {
    // 获取插入值的编码
    uint8_t valenc = _intsetValueEncoding(value);
    // 要插入的位置
    uint32_t pos;
    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. */
    // 判断插入值的编码是不是超过了当前intset的编码
    if (valenc > intrev32ifbe(is->encoding)) {
        /* This always succeeds, so we don't need to curry *success. */
        // 超出编码，需要升级
        return intsetUpgradeAndAdd(is,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一样的元素的角标pos
        if (intsetSearch(is,value,&pos)) {
            // 如果找到了，则无需插入，直接结束并返回失败
            if (success) *success = 0;
            return is;
        }

        // 数组扩容
        is = intsetResize(is,intrev32ifbe(is->length)+1);
        // 如果需要插入的位置不在末尾，则移动数组中pos之后的元素到pos+1，给新元素腾出空间
        if (pos < intrev32ifbe(is->length)) intsetMoveTail(is,pos,pos+1);
    }

    // 插入新元素
    _intsetSet(is,pos,value);
    // 修改元素个数
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);
    return is;
}

IntSet升级流程

假设现在有个IntSet，元素为5、10、12，采用的编码是INTSET_ENC_INT16，则每个元素占用2个字节，如下图所示： int16_t最大值是32767，此时我们再往里添加一个整数88888，很明显超出了INTSET_ENC_INT16的范围，此时intset就会自动升级编码到合适的大小。

升级流程如下：

• 根据插入值获取最新的编码
• 升级编码为INTSET_ENC_INT32, 每个整数占4字节，并按照新的编码方式及元素个数扩容数组
• 倒序依次将数组中的元素拷贝到扩容后的正确位置
• 将待添加的元素放入数组末尾
• 最后将encoding属性改为INTSET_ENC_INT32，并递增length属性

升级后如下图所示： 需要注意的是，升级后每个元素占用的字节数发生了变化，所以需要移动元素，是从数组末尾从后向前移动的，为什么是从后向前移动呢？假设一下，如果是从前向后移动，数字5本来是2个字节，现在变为4个字节，从前向后就会将10给覆盖掉。并且升级完后不支持降级。

IntSet升级逻辑实现在intsetUpgradeAndAdd()函数中，核心逻辑如下：

static intset *intsetUpgradeAndAdd(intset *is, int64_t value) {
    // 获取当前intset编码类型
    uint8_t curenc = intrev32ifbe(is->encoding);
    // 获取新编码
    uint8_t newenc = _intsetValueEncoding(value);
    // 获取元素个数
    int length = intrev32ifbe(is->length);
    // 判断新元素是大于0还是小于0 ，小于0插入队首、大于0插入队尾
    int prepend = value < 0 ? 1 : 0;

    /* First set new encoding and resize */
    // 重置编码为新编码
    is->encoding = intrev32ifbe(newenc);
    // 重置数组大小
    is = intsetResize(is,intrev32ifbe(is->length)+1);

    /* Upgrade back-to-front so we don't overwrite values.
     * Note that the "prepend" variable is used to make sure we have an empty
     * space at either the beginning or the end of the intset. */
    // 倒序遍历，逐个搬运元素到新的位置，_intsetGetEncoded按照旧编码方式查找旧元素
    while(length--)
        // _intsetSet按照新编码方式插入新元素
        _intsetSet(is,length+prepend,_intsetGetEncoded(is,length,curenc));

    /* Set the value at the beginning or the end. */
    /* 插入新元素，prepend决定是队首还是队尾*/
    if (prepend)
        // 插入队首
        _intsetSet(is,0,value);
    else
        // 插入队尾
        _intsetSet(is,intrev32ifbe(is->length),value);
    // 修改元素个数
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);
    return is;
}

IntSet查找数据

在前面讲解添加元素流程的时候有一个检查目标值是否存在的步骤，就是通过intsetSearch()函数进行查找元素是否存在，源代码如下：

static uint8_t intsetSearch(intset *is, int64_t value, uint32_t *pos) {
    // 初始化二分查找需要的min、max、mid
    int min = 0, max = intrev32ifbe(is->length)-1, mid = -1;
    int64_t cur = -1;

    /* The value can never be found when the set is empty */
    // 如果数组为空则不用找了
    if (intrev32ifbe(is->length) == 0) {
        if (pos) *pos = 0;
        return 0;
    } else {
        /* Check for the case where we know we cannot find the value,
         * but do know the insert position. */
        // 数组不为空，判断value是否大于最大值，小于最小值
        if (value > _intsetGet(is,max)) { // 大于最大值，不用找了，插入队尾
            if (pos) *pos = intrev32ifbe(is->length);
            return 0;
        } else if (value < _intsetGet(is,0)) { // 小于最小值，不用找了，插入队首
            if (pos) *pos = 0;
            return 0;
        }
    }

    // 二分查找
    while(max >= min) {
        // 计算中间的索引值
        mid = ((unsigned int)min + (unsigned int)max) >> 1;
        // 获取mid指向的元素值
        cur = _intsetGet(is,mid);
        // 如果目标值大于cur值
        if (value > cur) {
            min = mid+1;
        }
        // 如果目标值小于cur值
        else if (value < cur) {
            max = mid-1;
        } else {
            break;
        }
    }

    // 目标值与cur相等
    if (value == cur) {
        if (pos) *pos = mid;
        return 1;
    } else {
        if (pos) *pos = min;
        return 0;
    }
}

我们都知道IntSet中存储的全部都是整数，并且是有序的，因此就可以利用二分查找来查找数据。

intsetSearch()首先会进行边界检查，如果intset数组为空或者插入值大于最大值，小于最小值就不用找了，直接返回。以上条件都不满足，接着就会通过二分查找来进行查找数据，最后还会修改pos指针，pos指针就是新元素要插入的位置。

总结

IntSet可以看作是一个特殊的整数数组，具备一些特点：

• IntSet中的元素具备唯一性，有序性
• 具备编码升级机制，通过不同的编码类型来节省内存空间
• 底层采用二分查找来提高查询效率