Redis源码分析——SDS

Redis中基于C字符串构建了一种新的简单动态字符串SDS，作为对象的一种底层实现方式。它保存了C风格字符串以’\0’结尾的惯例，可以使用C字符串函数。由于SDS中保存了字符串的长度，所以可以以O(1)的时间复杂度获取长度而不是C字符串的O(n)。C字符串容易溢出的缺点也改进掉了，因为SDS操作时如果空间不够，会重新分配空间。对于空间的管理，SDS中使用预分配和懒惰释放的方式，减少对内存空间的反复分配和释放，提高了效率。SDS也是二进制安全的，他的长度是由长度字段保证的，字符数组中可以存放任意字符。

当前SDS源码已经读完，也做了注释，代码有1k多，逻辑都比较简单，现在把头文件注释放上。

/* SDSLib, A C dynamic strings library
 *
 * Copyright (c) 2006-2010, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __SDS_H
#define __SDS_H

// 内存预分配大小，重新分配内存时会用到，参考函数sdsMakeRoomFor实现
// 当需要内存<SDS_MAX_PREALLOC，则分配2倍内存
// 否则分配需要内存+SDS_MAX_PREALLOC
#define SDS_MAX_PREALLOC (1024*1024)

#include <sys/types.h>
#include <stdarg.h> // 定义了变长参数处理相关的宏

typedef char *sds; // sds本质就是C字符串

// 封装的动态字符串结构体，二进制安全，因为有len做长度判断而不是基于'\0'
struct sdshdr {
    unsigned int len; // 字符串长度，已使用空间
    unsigned int free; // 未使用空间
    char buf[]; // 字符串数据，sds就是该地址
};

// 获取字符串长度
static inline size_t sdslen(const sds s) {
    struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
    return sh->len;
}

// 获取剩余空间
static inline size_t sdsavail(const sds s) {
    struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
    return sh->free;
}

// 以init为内容，initlen为长度，创建SDS
sds sdsnewlen(const void *init, size_t initlen); 
// 以C字符串init创建SDS
sds sdsnew(const char *init);
// 创建空字符串
sds sdsempty(void);
// 该声明无用，与前面内联函数重复，估计是代码优化时未删除该声明
size_t sdslen(const sds s);
// 复制SDS
sds sdsdup(const sds s);
// 释放SDS
void sdsfree(sds s);
// 该声明无用，与前面内联函数重复，估计是代码优化时未删除该声明
size_t sdsavail(const sds s);
// 扩大SDS到指定长度，新增部分赋值为0
sds sdsgrowzero(sds s, size_t len);
// 追加len长度内容t到SDS，原sds指针失效
sds sdscatlen(sds s, const void *t, size_t len);
// 追加C字符串，原sds指针失效
sds sdscat(sds s, const char *t);
// 追加sds，原s指针失效
sds sdscatsds(sds s, const sds t);
// 把SDS内容变t，长度为len，原SDS指针失效
sds sdscpylen(sds s, const char *t, size_t len);
// 同上，但t为C字符串
sds sdscpy(sds s, const char *t);
// 将ap中多个元素按fmt格式化后追加到s
sds sdscatvprintf(sds s, const char *fmt, va_list ap);
// 将不定数目的参数格式化后追加到s
#ifdef __GNUC__
// 利用GNU的__attribute__机制增加函数属性
// format告诉编译器按printf函数参数格式进行检查
// 2表示格式化字符串的位置
// 3表示第一个变参的位置
sds sdscatprintf(sds s, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
sds sdscatprintf(sds s, const char *fmt, ...);
#endif

// 将不定数目的参数格式化后追加到s，速度更快，不依赖sprintf族函数
sds sdscatfmt(sds s, char const *fmt, ...);
// 删除s两端属于cset的字符，遇到不属于的即停止
sds sdstrim(sds s, const char *cset);
// 将s缩小，截取索引start和end之间的内容，索引可以为负
void sdsrange(sds s, int start, int end);
// 更新长度，即第一个'\0'
void sdsupdatelen(sds s);
// 清空字符串，没有释放空间，只是将第一个字符置0，修改len和free
void sdsclear(sds s);
// 字符串比较
int sdscmp(const sds s1, const sds s2);
// 将s按照分隔符sep分隔为数组，返回数组长度为count
sds *sdssplitlen(const char *s, int len, const char *sep, int seplen, int *count);
// 释放分隔后的数组
void sdsfreesplitres(sds *tokens, int count);
// 转化为小写
void sdstolower(sds s);
// 转化为大写
void sdstoupper(sds s);
// 将整数转化为SDS
sds sdsfromlonglong(long long value);
// 将不可见字符追加到s中
sds sdscatrepr(sds s, const char *p, size_t len);
// 将一行字符按空字符(isspace)分隔
sds *sdssplitargs(const char *line, int *argc);
// 将s中属于from的字符替换成to中对应的字符
sds sdsmapchars(sds s, const char *from, const char *to, size_t setlen);
// 将多个字符串用sep连接，然后存放到SDS
sds sdsjoin(char **argv, int argc, char *sep);

/* Low level functions exposed to the user API */
// 增加未使用空间
sds sdsMakeRoomFor(sds s, size_t addlen);
// 增加len，缩小free，负数反操作
void sdsIncrLen(sds s, int incr);
// 删除并释放未使用空间
sds sdsRemoveFreeSpace(sds s);
// 获取SDS总空间
size_t sdsAllocSize(sds s);

#endif