Redis 源码阅读三：Intset

Intset 实现redis的整数集合结构，它使用有序数组来表示集合，其结构体如下：

typedef struct intset {
    uint32_t encoding;
    uint32_t length;
    int8_t contents[];
} intset;

encoding 表示Inset的编码类型，有三种类型：INTSET_ENC_INT16, INTSET_ENC_INT32, INTSET_ENC_INT64，标识int16_t，int32_t，int64_t类型的数组，初始时是int16_t类型，当向集合中添加的元素超过该类型所能表示的范围时，升级元素类型。例如，如果开始时int32_t，当添加一个超过该类型能表示的数时，且int64_t可以表示时，把整个数组的类型升级到int64_t，再添加该元素。它们的宏定义如下：

 #define INTSET_ENC_INT16 (sizeof(int16_t))

#define INTSET_ENC_INT32 (sizeof(int32_t))
#define INTSET_ENC_INT64 (sizeof(int64_t))

如下函数根据值的范围，返回保存它需要的类型：

/* Return the required encoding for the provided value. */
static uint8_t _intsetValueEncoding(int64_t v) {
    if (v < INT32_MIN || v > INT32_MAX)
        return INTSET_ENC_INT64;
    else if (v < INT16_MIN || v > INT16_MAX)
        return INTSET_ENC_INT32;
    else
        return INTSET_ENC_INT16;
}

如下函数更新并添加新元素：

/* Upgrades the intset to a larger encoding and inserts the given integer. */
static intset *intsetUpgradeAndAdd(intset *is, int64_t value) {
    uint8_t curenc = intrev32ifbe(is->encoding);
    uint8_t newenc = _intsetValueEncoding(value);
    int length = intrev32ifbe(is->length);
    int prepend = value < 0 ? 1 : 0;  //如果value值小于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. */
    while(length--)
        _intsetSet(is,length+prepend,_intsetGetEncoded(is,length,curenc));     //由于当value值小于0时，value会被插入到数组头，那么需要把原先的值往后移一个位置

    /* Set the value at the beginning or the end. */
    if (prepend)                         //如果value值小于0，插入到表头
        _intsetSet(is,0,value);
    else
        _intsetSet(is,intrev32ifbe(is->length),value);
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);
    return is;
}

length是Intset中的元素个数，contents[] 用于存放数组元素，即集合。

下面分析下几个主要的API:

1.  intsetNew(void)

/* Create an empty intset. */
intset *intsetNew(void) {
    intset *is = zmalloc(sizeof(intset));
    is->encoding = intrev32ifbe(INTSET_ENC_INT16);
    is->length = 0;
    return is;
}

该函数通过调用zmalloc给一个新的intset分配内存，并初始化encoding和length。

2. intsetResize

/* Resize the intset */
static intset *intsetResize(intset *is, uint32_t len) {
    uint32_t size = len*intrev32ifbe(is->encoding);   //根据encoding类型获得数组需要的内存空间大小
    is = zrealloc(is,sizeof(intset)+size);             //重新分配内存空间	
    return is;
}

3. intsetSearch

/* Search for the position of "value". Return 1 when the value was found and
 * sets "pos" to the position of the value within the intset. Return 0 when
 * the value is not present in the intset and sets "pos" to the position
 * where "value" can be inserted. */
static uint8_t intsetSearch(intset *is, int64_t value, uint32_t *pos) {
    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) {               //如果长度等于0，直接返回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. */
        if (value > _intsetGet(is,intrev32ifbe(is->length)-1)) {                 //如果value的值大于当前元素类型的取值范围时直接返回0，pos保存length
            if (pos) *pos = intrev32ifbe(is->length);
            return 0;
        } else if (value < _intsetGet(is,0)) {             //如果value的值小于数组第一个元素（即最小值），返回0，*pos=0
            if (pos) *pos = 0;
            return 0;
        }
    }

    while(max >= min) {                  //使用二分查找
        mid = (min+max)/2;
        cur = _intsetGet(is,mid);
        if (value > cur) {
            min = mid+1;
        } else if (value < cur) {
            max = mid-1;
        } else {
            break;
        }
    }

    if (value == cur) {
        if (pos) *pos = mid;
        return 1;
    } else {
        if (pos) *pos = min;
        return 0;
    }
}

该函数首先判断value是否满足几个临界值，如果不满足就直接返回，否则，使用二分查找，搜索该值在intset的位置。

4. intsetAdd

/* Insert an integer in the intset */
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. */
    if (valenc > intrev32ifbe(is->encoding)) {                      //当value值的编码大于encoding时，调用intsetUpgradeAndAdd，更新数组和插入value

        /* 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. */
        if (intsetSearch(is,value,&pos)) {                           //如果value已经在数组中，那直接返回
            if (success) *success = 0;
            return is;
        }

        is = intsetResize(is,intrev32ifbe(is->length)+1);                    //重新分配内存
        if (pos < intrev32ifbe(is->length)) intsetMoveTail(is,pos,pos+1);     //移动pos后的元素
    }

    _intsetSet(is,pos,value);                                      //插入value
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);
    return is;
}

该函数向intset中添加一个新值value，首先判断该值的类型是否比intset中的大，如果是就升级类型并添加该value，否则，搜索该值在intset中的位置，如果找到直接返回，没找到就重新分配内存，移动其后的元素，添加value，更改length。

5. intsetRemove

/* Delete integer from intset */
intset *intsetRemove(intset *is, int64_t value, int *success) {
    uint8_t valenc = _intsetValueEncoding(value);
    uint32_t pos;
    if (success) *success = 0;

    if (valenc <= intrev32ifbe(is->encoding) && intsetSearch(is,value,&pos)) {
        uint32_t len = intrev32ifbe(is->length);

        /* We know we can delete */
        if (success) *success = 1;

        /* Overwrite value with tail and update length */
        if (pos < (len-1)) intsetMoveTail(is,pos+1,pos);
        is = intsetResize(is,len-1);
        is->length = intrev32ifbe(len-1);
    }
    return is;
}

该函数从intset中删除value，if语句保证该值的类型小于等于encoding，且intset中有这个值，移动该值后面的元素，通过intsetResize重新分配内存，释放该值的空间。