redis之动态字符串sds的实现

目录

引言：

C语言:

sds

SDS的实现

 C语言与SDS对比

1）常数复杂度获取字符串长度（以内存换时间）。

2）杜绝缓冲区溢出。

3）减少修改字符串长度时所需的内存重分配次数。

1.空间预分配：

2..惰性空间释放

4）二进制安全。

5）兼容部分C字符串函数

（6）总结和SDSAPI

总结：

 API

---

引言：

Redis没有直接使用C语言传统的字符串表示（以空字符结尾的字符 数组，以下简称C字符串），而是自己构建了一种名为简单动态字符串 （simple dynamic string，SDS）的抽象类型，并将SDS用作Redis的默认 字符串表示

C语言:

C字符串只会作为字符串字面量（string literal）用在 一些无须对字符串值进行修改的地方

redisLog(REDIS_WARNING,"Redis is now ready to exit, bye bye...");

sds

1.当Redis需要的不仅仅是一个字符串字面量，而是一个可以被修改 的字符串值时，Redis就会使用SDS来表示字符串值

SET msg "hello world"

那么Redis将在数据库中创建一个新的键值对，其中：

·键值对的键是一个字符串对象，对象的底层实现是一个保存着字 符串“msg”的SDS。

·键值对的值也是一个字符串对象，对象的底层实现是一个保存着 字符串“hello world”的SDS

redis> RPUSH fruits "apple" "banana" "cherry"
(integer) 3

键值对的键是一个字符串对象，对象的底层实现是一个保存了字 符串“fruits”的SDS。

2.·键值对的值是一个列表对象，列表对象包含了三个字符串对象， 这三个字符串对象分别由三个SDS实现：

第一个SDS保存着字符 串“apple”，第二个SDS保存着字符串“banana”，第三个SDS保存着字符 串“cherry”。

除了用来保存数据库中的字符串值之外，SDS还被用作缓冲区 （buffer）：AOF模块中的AOF缓冲区，以及客户端状态中的输入缓冲 区，都是由SDS实现的

SDS的实现

struct sdshdr {
//
记录buf
数组中已使用字节的数量
//
等于SDS
所保存字符串的长度
int len;
//
记录buf
数组中未使用字节的数量
int free;
//
字节数组，用于保存字符串
char buf[];
};

 下图示意一：

 SDS遵循C字符串以空字符结尾的惯例，保存空字符的1字节空间不 计算在SDS的len属性里面，并且为空字符分配额外的1字节空间，以及 添加空字符到字符串末尾等操作，都是由SDS函数自动完成的，所以这 个空字符对于SDS的使用者来说是完全透明的。遵循空字符结尾这一惯 例的好处是，SDS可以直接重用一部分C字符串函数库里面的函数

举例：

举个例子，如果我们有一个指向图2-1所示SDS的指针s，那么我们 可以直接使用/printf函数，通过执行以下语句：

printf("%s", s->buf);

来打印出SDS保存的字符串值“Redis”，而无须为SDS编写专门的打 印函数

下图示意二：

这个SDS和之前展示的SDS一样，都 保存了字符串值“Redis”。这个SDS和之前展示的SDS的区别在于，这个 SDS为buf数组分配了五字节未使用空间，所以它的free属性的值为 5（图中使用五个空格来表示五字节的未使用空间）

 C语言与SDS对比

  C语言使用长度为N+1的字符数组来表示长度为N的字符 串，并且字符数组的最后一个元素总是空字符'\0'

下图展现一个“redis"的字符串 

1）常数复杂度获取字符串长度（以内存换时间）。

1.因为C字符串并不记录自身的长度信息，所以为了获取一个C字符 串的长度，程序必须遍历整个字符串，对遇到的每个字符进行计数，直 到遇到代表字符串结尾的空字符为止，这个操作的复杂度为O（N）（不做解释）

2.和C字符串不同，因为SDS在len属性中记录了SDS本身的长度，所 以获取一个SDS长度的复杂度仅为O（1）（参考上图和数据结构）

对于下图展示的SDS来说，程序只要访问SDS的len属 性，就可以立即知道SDS的长度为11字节

 设置和更新SDS长度的工作是由SDS的API在执行时自动完成的， 使用SDS无须进行任何手动修改长度的工作

2）杜绝缓冲区溢出。

除了获取字符串长度的复杂度高之外，C字符串不记录自身长度带 来的另一个问题是容易造成缓冲区溢出（buffer overflow）。举个例子，char*strcat函数可以将src字符串中的内容拼接到dest字符串的 末尾：

char *strcat(char *dest, const char *src);

因为C字符串不记录自身的长度，所以strcat假定用户在执行这个函 数时，已经为dest分配了足够多的内存，可以容纳src字符串中的所有内 容，而一旦这个假定不成立时，就会产生缓冲区溢出 

与C字符串不同，SDS的空间分配策略完全杜绝了发生缓冲区溢出 的可能性：当SDS API需要对SDS进行修改时，API会先检查SDS的空间 是否满足修改所需的要求，如果不满足的话，API会自动将SDS的空间 扩展至执行修改所需的大小，然后才执行实际的修改操作，所以使用 SDS既不需要手动修改SDS的空间大小，也不会出现前面所说的缓冲区 溢出问题

sdscat(s, " Cluster");

 其中SDS值下图所示，那么sdscat将在执行拼接操作之前检查s 的长度是否足够，在发现s目前的空间不足以拼接"Cluster"之后，sdscat 就会先扩展s的空间，然后才执行拼接"Cluster"的操作，拼接操作完成之 后的SDS如下下图所示。

 note：

sdscat不仅对这个SDS进行了拼接操作， 它还为SDS分配了13字节的未使用空间，并且拼接之后的字符串也正好 是13字节长，这种现象既不是bug也不是巧合，它和SDS的空间分配策 略有关

3）减少修改字符串长度时所需的内存重分配次数。

因为C字符串并不记录自身的长度，所以对 于一个包含了N个字符的C字符串来说，这个C字符串的底层实现总是一 个N+1个字符长的数组（额外的一个字符空间用于保存空字符）。因为 C字符串的长度和底层数组的长度之间存在着这种关联性，所以每次增 长或者缩短一个C字符串，程序都总要对保存这个C字符串的数组进行 一次内存重分配操作：

1.如果程序执行的是增长字符串的操作，比如拼接操作 （append），那么在执行这个操作之前，程序需要先通过内存重分配来 扩展底层数组的空间大小——如果忘了这一步就会产生缓冲区溢出。 ·

2.如果程序执行的是缩短字符串的操作，比如截断操作（trim），那 么在执行这个操作之后，程序需要通过内存重分配来释放字符串不再使 用的那部分空间——如果忘了这一步就会产生内存泄漏

因为内存重分配涉及复杂的算法，并且可能需要执行系统调用，所 以它通常是一个比较耗时的操作：

·在一般程序中，如果修改字符串长度的情况不太常出现，那么每 次修改都执行一次内存重分配是可以接受的。

但是Redis作为数据库，经常被用于速度要求严苛、数据被频繁修 改的场合，如果每次修改字符串的长度都需要执行一次内存重分配的 话，那么光是执行内存重分配的时间就会占去修改字符串所用时间的一 大部分，如果这种修改频繁地发生的话，可能还会对性能造成影响:

1.空间预分配：

空间预分配用于优化SDS的字符串增长操作：当SDS的API对一个 SDS进行修改，并且需要对SDS进行空间扩展的时候，程序不仅会为 SDS分配修改所必须要的空间，还会为SDS分配额外的未使用空间

其中，额外分配的未使用空间数量由以下公式决定：

如果对SDS进行修改之后，SDS的长度（也即是len属性的值）将 小于1MB，那么程序分配和len属性同样大小的未使用空间，这时SDS len属性的值将和free属性的值相同。举个例子，如果进行修改之后， SDS的len将变成13字节，那么程序也会分配13字节的未使用空间，SDS 的buf数组的实际长度将变成13+13+1=27字节（额外的一字节用于保存 空字符）。

·如果对SDS进行修改之后，SDS的长度将大于等于1MB，那么程序 会分配1MB的未使用空间。举个例子，如果进行修改之后，SDS的len将 变成30MB，那么程序会分配1MB的未使用空间，SDS的buf数组的实际 长度将为30MB+1MB+1byte

2..惰性空间释放

惰性空间释放用于优化SDS的字符串缩短操作：当SDS的API需要 缩短SDS保存的字符串时，程序并不立即使用内存重分配来回收缩短后 多出来的字节，而是使用free属性将这些字节的数量记录起来，并等待 将来使用

举例使用：

sdstrim函数接受一个SDS和一个C字符串作为参数，移 除SDS中所有在C字符串中出现过的字符

sdstrim(s, "XY"); //
移除SDS
字符串中的所有'X'
和'Y'

 结果：

 注意执行sdstrim之后的SDS并没有释放多出来的8字节空间，而是 将这8字节空间作为未使用空间保留在了SDS里面，如果将来要对SDS进 行增长操作的话，这些未使用空间就可能会派上用场‘ 

4）二进制安全。

C字符串中的字符必须符合某种编码（比如ASCII），并且除了字 符串的末尾之外，字符串里面不能包含空字符，否则最先被程序读入的 空字符将被误认为是字符串结尾，这些限制使得C字符串只能保存文本 数据，而不能保存像图片、音频、视频、压缩文件这样的二进制数据

举个例子，如果有一种使用空字符来分割多个单词的特殊数据格 式，如图2-17所示，那么这种格式就不能使用C字符串来保存，因为C字 符串所用的函数只会识别出其中的"Redis"，而忽略之后的"Cluster

 虽然数据库一般用于保存文本数据，但使用数据库来保存二进制数 据的场景也不少见，因此，为了确保Redis可以适用于各种不同的使用 场景，SDS的API都是二进制安全的（binary-safe），所有SDS API都会 以处理二进制的方式来处理SDS存放在buf数组里的数据，程序不会对其中的数据做任何限制、过滤、或者假设，数据在写入时是什么样的，它被读取时就是什么样

例如，使用SDS来保存之前提到的特殊数据格式就没有任何问题， 因为SDS使用len属性的值而不是空字符来判断字符串是否结束

5）兼容部分C字符串函数

虽然SDS的API都是二进制安全的，但它们一样遵循C字符串以空字 符结尾的惯例：这些API总会将SDS保存的数据的末尾设置为空字符， 并且总会在为buf数组分配空间时多分配一个字节来容纳这个空字符， 这是为了让那些保存文本数据的SDS可以重用一部分库 函数。

举个例子，如下图所示，如果我们有一个保存文本数据的SDS值 sds，那么我们就可以重用/strcasecmp函数，使用它来对比SDS

strcasecmp(sds->buf, "hello world");

（6）总结和SDSAPI

总结：

 API