Redis学习——SDS字符串源码分析

时间：2023-03-08 17:13:48

0. 前言

　　这里对Redis底层字符串的实现分析，但是看完其实现还没有完整的一个概念，即不太清楚作者为什么要这样子设计，只能窥知一点，需要看完redis如何使用再回头来体会，有不足之处还望告知。

　　涉及文件：sds.h/sds.c

1.  数据结构：　　

 typedef char *sds;

 struct sdshdr {

     unsigned int len;    //buf中已使用的字节数

     unsigned int free;    //buf中未使用的字节数

     char buf[];        //缓冲区

 };

　　这里向外提供的api所返回的类型都是sds类型(字符串)，这样的话也能够复用一部分的C字符串函数。

　　这里采用sdshdr结构，存放了字符串长度信息，保证了二进制数据安全，即不仅可以存放字符串，也可用于存放其它二进制数据

2. API实现：

　　只提取几个API，该文件完整的注释在GitHud上(用户名：jabnih)

a. sdsnewlen

　　创建一个sds字符串，其它几个创建API都是基于这个API。

　　创建时采用一次性分配其所需要的空间，即对于buf不进行再次分配，减少了malloc等的调用，同时在释放的时候也减少free次数

 //创建一个sds字符串，初始内容为init所指向的内容，buf空间为initlen大小

 sds sdsnewlen(const void *init, size_t initlen) {

     struct sdshdr *sh;

     //这里需要注意

     if (init) {

         //init不为空，则使用malloc，所申请的空间不会初始化

         sh = zmalloc(sizeof(struct sdshdr)+initlen+);

     } else {

         //init为空，使用calloc，所申请的空间会被初始化为0

         sh = zcalloc(sizeof(struct sdshdr)+initlen+);

     }

     if (sh == NULL) return NULL;

     sh->len = initlen;

     sh->free = ;

     //这里如果init为NULL，则该buf的内容均为0

     if (initlen && init)

         memcpy(sh->buf, init, initlen);

     sh->buf[initlen] = '\0';

     return (char*)sh->buf;

 }

b. sdsMakeRoomFor

　　该API的内存分配策略为：在小于SDS_MAX_PREALLOC（即1M）时，会预分配出多一倍的空间，在大于该阈值时，每次只预分配多SDS_MAX_PREALLOC内存。

  //保证sds字符串有足够的剩余未使用空间（大于或等于addlen）

 sds sdsMakeRoomFor(sds s, size_t addlen) {

     struct sdshdr *sh, *newsh;

     size_t free = sdsavail(s);

     size_t len, newlen;

     //其剩余的空间满足addlen大小

     if (free >= addlen) return s;

     //不满足addlen大小，需要重新分配

     len = sdslen(s);

     sh = (void*) (s-(sizeof(struct sdshdr)));

     //新空间所需使用的大小为当前sds使用的长度加上addlen

     newlen = (len+addlen);

     //如果新空间大小比设定的阈值小，则以2倍的增长速度预分配一些空间

     if (newlen < SDS_MAX_PREALLOC)

         newlen *= ;

     else

         //比设定阈值大，则只增加PREALLOC预分配大小

         newlen += SDS_MAX_PREALLOC;

     //重新分配空间

     newsh = zrealloc(sh, sizeof(struct sdshdr)+newlen+);

     if (newsh == NULL) return NULL;

     newsh->free = newlen - len;

     return newsh->buf;

 }

c. sdsRemoveFreeSpace

  //去除sds字符串中未使用的空间，一般在内存紧张的时候使用

 sds sdsRemoveFreeSpace(sds s) {

     struct sdshdr *sh;

     sh = (void*) (s-(sizeof(struct sdshdr)));

     sh = zrealloc(sh, sizeof(struct sdshdr)+sh->len+);

     sh->free = ;

     return sh->buf;

 }

d. sdsclear

  //清空sds字符串，但是不释放空间

 void sdsclear(sds s) {

     struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));

     sh->free += sh->len;

     sh->len = ;

     sh->buf[] = '\0';

 }

3. 总结：

　　1. 二进制数据安全

　　2. 预分配空间，可以懒惰释放，在内存紧张的时候也可以缩减不需要的内存

　　3. 使用该API可以实现内存动态扩展（即不需要考虑内存空间是否足够）

　　4. 边界检查

相关文章