redis源码阅读—intset(整数集合)_redis _intsetvalueencoding

#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) //小于32位的最小值 大于32位的最大值
return INTSET_ENC_INT64; // 64位
else if (v < INT16_MIN || v > INT16_MAX) //小于1616位的最小值 大于位的最大值
return INTSET_ENC_INT32; // 32位
else
return INTSET_ENC_INT16; //16位
}

> 
> 其次， 比较新元素的编码`valenc`与 当前集合的编码`is->encoding`。  
>   
>  1). valenc>is->encoding ： 表明当前集合无法存储新元素，需对集合进行升级。  
>  2). valenc<=is->encoding：此时，集合无需升级。优先判断新元素是否存在。若存在，则return ； 反之，扩充集合空间，为新元素腾出位置，最后添加新元素.
> 
> 
> 


`intsetAdd` 内部调用多个函数，其中`intsetUpgradeAndAdd、intsetSearch、intsetMoveTail` 尤为关键，在整个intset相关操作中，起到“承上启下”的作用，能突出地体现intset的设计思想与灵魂。


#### 升级源码


`是对集合进行升级，并添加新元素`

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;
is->encoding = intrev32ifbe(newenc);
//扩充空间
is = intsetResize(is,intrev32ifbe(is->length)+1);
//移动集合元素
while(length–)
_intsetSet(is,length+prepend,_intsetGetEncoded(is,length,curenc));
//prepend = 1：表明value是最小的负数，将新元素添加到集合首位。
//prepend = 0：表明value是最大的整数，将新元素添加至集合尾部。
if (prepend)
_intsetSet(is,0,value);
else
_intsetSet(is,intrev32ifbe(is->length),value);
//设置长度
is->length = intrev32ifbe(intrev32ifbe(is->length)+1);
return is;
}

> 
> 执行流程：扩充集合空间（`intsetResize`）->集合元素设置新编码（`_intsetSet`）->向集合头/尾部添加新元素（`_intsetSet`）。
> 
> 
> 

/* Resize the intset */
static intset *intsetResize(intset *is, uint32_t len) {
uint32_t size = len*intrev32ifbe(is->encoding);
is = zrealloc(is,sizeof(intset)+size);
return is;
}

/* Set the value at pos, using the configured encoding. */
static void _intsetSet(intset *is, int pos, int64_t value) {
uint32_t encoding = intrev32ifbe(is->encoding);

if (encoding == INTSET_ENC_INT64) {
    ((int64_t\*)is->contents)[pos] = value;
    memrev64ifbe(((int64_t\*)is->contents)+pos);
} else if (encoding == INTSET_ENC_INT32) {
    ((int32_t\*)is->contents)[pos] = value;
    memrev32ifbe(((int32_t\*)is->contents)+pos);
} else {
    ((int16_t\*)is->contents)[pos] = value;
    memrev16ifbe(((int16_t\*)is->contents)+pos);
}

}

> 
> 新元素的位置是由 prepend 变量控制。而prepend是根据 value 值定义的。  
>  当value<0 时，表明 value 小于当前集合所有元素 , 系统将 value 作为集合第一个元素。  
>  当value>=0时, 表明 value 大于当前集合所有元素 , 系统将 value 添加到集合的尾部。
> 
> 
> 


#### 查找源码


`查找集合元素，判断value是否已存在。若元素存在，则返回1; 反之, 返回0。`

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;
if (intrev32ifbe(is->length) == 0) {
if (pos) *pos = 0;
return 0;
} else {
if (value > _intsetGet(is,intrev32ifbe(is->length)-1)) {
//大于集合中最大的数
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;
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;
}
}

> 
> 采用 “二分法”的算法查找搜索  
>  因此，可以推断出,intset是一种有序的集合。当元素存在时，pos 代表该元素所在的集合下标。当元素不存在时，pos 表示该元素添加的位置。
> 
> 
> 


#### 移动源码

static void intsetMoveTail(intset *is, uint32_t from, uint32_t to) {
void *src, *dst;
uint32_t bytes = intrev32ifbe(is->length)-from;
uint32_t encoding = intrev32ifbe(is->encoding);
if (encoding == INTSET_ENC_INT64) {
src = (int64_t*)is->contents+from;
dst = (int64_t*)is->contents+to;
bytes *= sizeof(int64_t);
} else if (encoding == INTSET_ENC_INT32) {
//…省略部分代码…
} else {
//…省略部分代码…
}
memmove(dst,src,bytes);
}

> 
> intsetMoveTail 将集合from位置之后的元素 移至 to位置，内部使用c语言memmove函数保证移动过程中数据的完整性。下面给出简单的实例。  
>  ![在这里插入图片描述](https://img-blog.csdnimg.cn/20210109173408978.png)  
>  **回顾 intsetAdd 整个流程，可以看出集合始终保持有序的结构。内部使用二分查找算法，定位新元素的位置。**  
>  当新元素编码 > 集合编码时，表明集合需要升级，同时根据新元素值来确定所添加的位置（头部或尾部）。  
>  当新元素编码<=集合编码时，表明集合无需升级，系统会将集合大于value的元素往后移动一位，为新元素腾出空间。
> 
> 
> 


### 移除某个元素


`从集合中移除某个元素`

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);
if (success) *success = 1;
//向前移动一位
if (pos < (len-1)) intsetMoveTail(is,pos+1,pos);
is = intsetResize(is,len-1);
//长度-1
is->length = intrev32ifbe(len-1);
}
return is;
}

> 
> 从上面的代码可以看出，intsetRemove 设计非常巧妙。首先，通过判断value 编码过滤一部分无效的搜索。当 value 编码在集合范围内时，才会intsetSearch 进行查找。当找到元素时，将 pos 之后的元素向前移动一个单元。最后，重置集合大小并设置集合长度。
> 
> 
> 


### 查找


`内部调用intsetSearch()`

uint8_t intsetFind(intset *is, int64_t value) {
uint8_t valenc = _intsetValueEncoding(value);
return valenc <= intrev32ifbe(is->encoding) && intsetSearch(is,value,NULL);
}

### 降级


**intset内部只有”编码升级”的过程，没有”降级”的操作。当将唯一一个高位元素从将集合移除时，此时，集合不会转换为低位编码集合。**



![img](https://img-blog.csdnimg.cn/img_convert/938db828959a8a768627db2af3abcf37.png)
![img](https://img-blog.csdnimg.cn/img_convert/1a219dc427e80445f3d47228b4fd0163.png)

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

加入社区》https://bbs.csdn.net/forums/4304bb5a486d4c3ab8389e65ecb71ac0
”降级”的操作。当将唯一一个高位元素从将集合移除时，此时，集合不会转换为低位编码集合。**



[外链图片转存中...(img-deJS3chg-1725711206834)]
[外链图片转存中...(img-A2VfwNF7-1725711206834)]

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

加入社区》https://bbs.csdn.net/forums/4304bb5a486d4c3ab8389e65ecb71ac0