Redis设计与实现——简单动态字符串SDS

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

在 Redis 里面， C 字符串只会作为字符串字面量（string literal）， 用在一些无须对字符串值进行修改的地方，比如打印日志。

SDS 的定义

每个 sds.h / sdshdr 结构表示一个 SDS 值，在 Redis 3.2 版本以前，SDS 的结构如下：

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

• free 属性的值为 0 ， 表示这个 SDS 没有分配任何未使用空间。
• len 属性的值为 5 ， 表示这个 SDS 保存了一个 5 字节长的字符串。
• buf 属性是一个 char 类型的数组， 数组的前 5 个字节分别保存了 'R' 、 'e' 、 'd' 、 'i' 、 's' 5 个字符， 而最后一个字节则保存了空字符 '\0' 。

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

字段 len 和 free 各占 4 字节，紧接着存放字符串。

这样做有以下几个好处：

• 用单独的变量 len 和 free，可以方便地获取字符串长度和剩余空间；
• 内容存储在动态数组 buf 中，SDS 对上层暴露的指针指向 buf，而不是指向结构体 SDS。因此，上层可以像读取 C 字符串一样读取 SDS 的内容，兼容 C 语言处理字符串的各种函数，同时也能通过 buf 地址的偏移，方便地获取其他变量；
• 读写字符串不依赖于 \0，保证二进制安全。

在 C 语言中，\0 表示字符串结束，如果字符串中本身就包含 \0 字符，那么字符串就会在 \0 处被截断，即非二进制安全；若通过使用一个 len 属性，来判断字符串是否结束，就可以保证读写字符串时不受到 \0 的影响，则是二进制安全。同时 len 属性也能保证在 O(1) 时间内获取字符串的长度。

但其实以上的设计是存在一些问题的，对于不同长度的字符串，是否有必要使用 len 和 free 这 2 个 4 字节的变量？4 字节的 len，可表示的字符串长度为 2^32-1，而在实际应用中，存放于 Redis 中的字符串往往没有这么长，因此，空间的使用上能否进一步压缩？

SDS 与 C 字符串的区别

根据传统， C 语言使用长度为 N+1 的字符数组来表示长度为 N 的字符串， 并且字符数组的最后一个元素总是空字符 '\0' 。C 语言使用的这种简单的字符串表示方式， 并不能满足 Redis 对字符串在安全性、效率、以及功能方面的要求。

C 字符串	SDS
获取字符串长度的复杂度为 O(N) 。	获取字符串长度的复杂度为 O(1) 。
API 是不安全的，可能会造成缓冲区溢出。	API 是安全的，不会造成缓冲区溢出。
修改字符串长度 N 次必然需要执行 N 次内存重分配。	修改字符串长度 N 次最多需要执行 N 次内存重分配。
只能保存文本数据。	可以保存文本或者二进制数据。
可以使用所有 <string.h> 库中的函数。	可以使用一部分 <string.h> 库中的函数。

常数复杂度获取字符串长度

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

和 C 字符串不同，SDS 在 len 属性中记录了 SDS 本身的长度， 所以获取一个 SDS 长度的复杂度仅为 O(1) 。

通过使用 SDS 而不是 C 字符串， Redis 将获取字符串长度所需的复杂度从 O(N) 降低到了 O(1) ， 这确保了获取字符串长度的工作不会成为 Redis 的性能瓶颈。

杜绝缓冲区溢出

C字符串不记录自身长度带来的另一个问题是很容易造成缓冲区溢出。比如使用字符串拼接函数 stract 的时候，如果目标数组 dest 没有分配足够的内存，可能会造成缓冲区溢出，即新增字符串覆盖掉目标数组 dest 在内存中紧邻着的 C 字符串原有的数据。

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

减少修改字符串时带来的内存重分配次数

因为 C 字符串的长度和底层数组的长度之间存在紧密关联， 所以每次增长或者缩短一个 C 字符串， 程序都要对这个数组进行一次内存重分配操作：

• 如果程序执行的是增长字符串的操作， 比如拼接操作（append）， 那么在执行这个操作之前， 程序需要先通过内存重分配来扩展底层数组的空间大小 —— 如果忘了这一步就会产生缓冲区溢出。
• 如果程序执行的是缩短字符串的操作， 比如截断操作（trim）， 那么在执行这个操作之后， 程序需要通过内存重分配来释放字符串不再使用的那部分空间 —— 如果忘了这一步就会产生内存泄漏。

因为内存重分配涉及复杂的算法， 并且可能需要执行系统调用， 所以通常是个比较耗时的操作。Redis 作为数据库， 经常被用于速度要求严苛、数据被频繁修改的场合， 如果每次修改字符串的长度都需要执行一次内存重分配的话， 那么光是执行内存重分配的时间就会占去修改字符串所用时间的一大部分， 如果这种修改频繁地发生的话， 可能还会对性能造成影响。

为了避免 C 字符串的这种缺陷， SDS 通过未使用空间解除了字符串长度和底层数组长度之间的关联： 在 SDS 中， buf 数组的长度不一定就是字符数量加 1， 数组里面可以包含未使用的字节， 而这些字节的数量就由 SDS 的 free 属性记录。

通过未使用空间， SDS 实现了空间预分配和惰性空间释放两种优化策略。

1、空间预分配：

空间预分配用于优化 SDS 的字符串增长操作： 简单来说就是当字节数组空间不足需要进行扩展时，总是会预留一部分空闲空间。

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

• 如果对 SDS 进行修改之后， SDS 的长度（也即是 len 属性的值）将小于 1 MB ， 那么多分配和 len 属性同样大小的未使用空间， 这时 SDS len 属性的值将和 free 属性的值相同。
• 如果对 SDS 进行修改之后， SDS 的长度将大于等于 1 MB ， 那么程序会多分配 1 MB 的未使用空间。

通过空间预分配策略， Redis 可以减少连续执行字符串增长操作所需的内存重分配次数。

2、惰性空间释放：

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

通过惰性空间释放策略， SDS 避免了缩短字符串时所需的内存重分配操作， 并为将来可能有的增长操作提供了优化。同时SDS也提供直接释放SDS里面未使用空间的API，让我们在需要的时候，真正的释放掉多余的空间， 所以不用担心惰性空间释放策略会造成内存浪费。

二进制安全

C 字符串中的字符必须符合某种编码，并且除了字符串末尾之外，其它位置不允许出现空字符，这些限制使得 C 字符串只能保存文本数据，而不能保存像图片、音频、视频、压缩文件这样的二进制数据。

为了确保 Redis 可以适用于各种不同的使用场景， SDS 的 API 都是二进制安全的（binary-safe）： 所有 SDS API 都会以处理二进制的方式来处理 SDS 存放在 buf 数组里的数据。这也是我们将 SDS 的 buf 属性称为字节数组的原因 —— Redis 不是用这个数组来保存字符， 而是用它来保存一系列二进制数据。

因为 SDS 使用 len 属性的值而不是空字符来判断字符串是否结束。

兼容部分 C 字符串函数

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

通过遵循 C 字符串以空字符结尾的惯例， SDS 可以在有需要时重用 <string.h> 函数库， 从而避免了不必要的代码重复。

参考资料

《Redis 设计与实现》——黄健宏