Redis源码阅读-字符串

sds实际指向的是buf的地址，而且在每个字符串末尾会自动添加一个\0，所以可以用在所有c str的场合。需要sds的长度等信息时，通过向前偏移找到sdshdr提取信息。字符串扩容时会分配超出实际大小的空间，多余空间通过free记录。这样可以降低后面字符串的空间分配频次，提升效率。注意：\0没有算入len和free。

sds结构

3.操作

sds会根据需要动态扩容，所以大部分修改sds的操作函数的返回值类型都是sds。

3.1.创建

可以以下几种方式创建sds：

以`const void *`和`size_t`指定一块内存

sdsnewlen通过init和initlen创建一个sds。如果init为NULL，字符串内容以0填充。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


sds sdsnewlen(const void *init, size_t initlen) {
    struct sdshdr *sh;

    // 如果init不为NULL，通过init内容创建
    // 否则创建长度为initlen的以0填充的字符串
    if (init) {
        // +1为了存放最后的\0
        sh = zmalloc(sizeof(struct sdshdr)+initlen+1);
    } else {
        // zcalloc会将分配的空间用0填充
        sh = zcalloc(sizeof(struct sdshdr)+initlen+1);
    }
    // 空间不足
    if (sh == NULL) return NULL;
    sh->len = initlen;
    sh->free = 0;
    if (initlen && init)
        memcpy(sh->buf, init, initlen);
    // 添加末尾的\0
    sh->buf[initlen] = '\0';
    return (char*)sh->buf;
}

以`const char *`类型的参数

sdsnew通过init创建sds，长度通过strlen获取。

1
2
3
4
5


sds sdsnew(const char *init) {
    // 获取长度，转给sdsnewlen处理
    size_t initlen = (init == NULL) ? 0 : strlen(init);
    return sdsnewlen(init, initlen);
}

不带参数创建空`sds`

sdsempty创建一个空的sds字符串。

1
2
3
4


sds sdsempty(void) {
    // 调用sdsnewlen创建
    return sdsnewlen("", 0);
}

从已有的`sds`复制

sdsdup复制一份sds。

1
2
3
4


sds sdsdup(const sds s) {
    // 以s的内容重新创建一个sds
    return sdsnewlen(s, sdslen(s));
}

以`long long`类型的参数

sdsfromlonglong通过一个long long类型的值构造一个sds。

1
2
3
4
5
6
7


sds sdsfromlonglong(long long value) {
    char buf[SDS_LLSTR_SIZE];
    // sdsll2str将value转为字符串存在buf中，返回长度
    int len = sdsll2str(buf,value);

    return sdsnewlen(buf, len);
}

3.2.销毁

sdsfree释放sds分配的空间。不能直接调用zfree，因为指针前面还有头部信息。

1
2
3
4
5


void sdsfree(sds s) {
    if (s == NULL) return;
    // 需要偏移到头部free
    zfree(s-sizeof(struct sdshdr));
}

3.3.查询基本信息

获取字符串长度

调用sdslen获取实际长度（因为可能存入二进制\0，不能使用strlen获取）。

1
2
3
4
5
6


static inline size_t sdslen(const sds s) {
    // 向前偏移找到sdshdr
    struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
    // 取出长度
    return sh->len;
}

获取空闲空间

调用sdsavail获取空闲空间。

1
2
3
4
5
6


static inline size_t sdsavail(const sds s) {
    // 向前偏移找到sdshdr
    struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
    // 取出空闲空间
    return sh->free;
}

占用内存大小

调用sdsAllocSize获取sds分配的空间大小，包括头部，字符串长度，字符串末尾的\0，空闲空间长度。

1
2
3
4
5


size_t sdsAllocSize(sds s) {
    struct sdshdr *sh = (void*) (s-sizeof(struct sdshdr));

    return sizeof(*sh)+sh->len+sh->free+1;
}

3.4.修改

sds提供多种修改字符串修改操作。

更新长度

调用sdsupdatelen根据buf指向内容更新长度，以\0结尾。

1
2
3
4
5
6
7
8
9


void sdsupdatelen(sds s) {
    // 向前偏移获取sdshdr
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    // 通过strlen获取长度
    int reallen = strlen(s);
    // 更新长度和空闲大小
    sh->free += (sh->len-reallen);
    sh->len = reallen;
}

这个方法主要用在手动修改sds内容时，更新sdshdr信息。

1
2
3
4


s = sdsnew("foobar");
s[2] = '\0';
sdsupdatelen(s);
printf("%d\n", sdslen(s)); // 输出2

上面例子中，如果没有调用sdsupdatelen，输出结果将会是6。

清空`sds`

调用sdsclear清空sds的内容。

1
2
3
4
5
6
7
8


void sdsclear(sds s) {
    // 向前偏移找到sdshdr
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    // 更新len和free，并将第一个字符设置为'\0'
    sh->free += sh->len;
    sh->len = 0;
    sh->buf[0] = '\0';
}

释放空闲空间

sdsRemoveFreeSpace释放sds中空闲的空间。

1
2
3
4
5
6
7
8
9


sds sdsRemoveFreeSpace(sds s) {
    struct sdshdr *sh;

    sh = (void*) (s-(sizeof(struct sdshdr)));
    // +1为了存放末尾的\0
    sh = zrealloc(sh, sizeof(struct sdshdr)+sh->len+1);
    sh->free = 0;
    return sh->buf;
}

增加/减少字符串长度

调用sdsIncrLen增加或减少字符串长度。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


void sdsIncrLen(sds s, int incr) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));

    if (incr >= 0)
        // 不能超过空闲空间大小
        assert(sh->free >= (unsigned int)incr);
    else
        // 不能超过现有字符串长度
        assert(sh->len >= (unsigned int)incr);
    sh->len += incr;
    sh->free -= incr;
    // 设置新的字符串末尾的\0
    s[sh->len] = '\0';
}

转换为小写

sdstolower将sds中字符转为小写形式。

1
2
3
4
5


void sdstolower(sds s) {
    int len = sdslen(s), j;

    for (j = 0; j < len; j++) s[j] = tolower(s[j]);
}

转换为大写

sdstoupper将sds中字符转为大写形式。

1
2
3
4
5


void sdstoupper(sds s) {
    int len = sdslen(s), j;

    for (j = 0; j < len; j++) s[j] = toupper(s[j]);
}

以`const void *`和`size_t`指定的内存覆盖

sdscpylen将以t和len指向的内存copy到sds中，覆盖现有内容。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


sds sdscpylen(sds s, const void *t, size_t len) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    size_t totlen = sh->free+sh->len;

    // 空间不够，重新分配
    if (totlen < len) {
        s = sdsMakeRoomFor(s,len-sh->len);
        if (s == NULL) return NULL;
        sh = (void*) (s-(sizeof(struct sdshdr)));
        totlen = sh->free+sh->len;
    }
    // copy内容
    memcpy(s, t, len);
    s[len] = '\0';
    sh->len = len;
    sh->free = totlen -  len;
    return s;
}

以`const char *`指定内容覆盖

sdscpy将t的内容copy到sds中，覆盖现有内容。

1
2
3


sds sdscpy(sds s, const char *t) {
    return sdscpylen(s, t, strlen(t));
}

移除首尾指定字符

sdstrim从sds左右删除cset中指定的字符。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


sds sdstrim(sds s, const char *cset) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    char *start, *end, *sp, *ep;
    size_t len;

    sp = start = s;
    ep = end = s+sdslen(s)-1;
    // 移除左边的字符
    while(sp <= end && strchr(cset, *sp)) sp++;
    // 移除右边的字符
    while(ep > start && strchr(cset, *ep)) ep--;
    len = (sp > ep) ? 0 : ((ep-sp)+1);
    // 将有效字符串移到buf位置
    if (sh->buf != sp) memmove(sh->buf, sp, len);
    sh->buf[len] = '\0';
    sh->free = sh->free+(sh->len-len);
    sh->len = len;
    return s;
}

保留指定范围

sdsrange只保留sds中起始位置start，结束位置end之间的字符。位置可以为负数，表示从尾部开始计算。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31


void sdsrange(sds s, int start, int end) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    size_t newlen, len = sdslen(s);

    if (len == 0) return 0;
    // 位置为负数，+len算出绝对位置
    if (start < 0) {
        start = len+start;
        if (start < 0) start = 0;
    }
    if (end < 0) {
        end = len+end;
        if (end < 0) end = 0;
    }
    newlen = (start > end) ? 0 : (end-start)+1;
    if (newlen != 0) {
        // 位置超出len处理
        if (start >= (signed)len) {
            newlen = 0;
        } else if (end >= (signed)len) {
            end = len - 1;
            newlen = (start > end) ? 0 : (end-start)+1;
        }
    } else {
        start = 0;
    }
    if (start && newlen) memmove(sh->buf, sh->buf+start, newlen);
    sh->buf[newlen] = 0;
    sh->free = sh->free+(sh->len-newlen);
    sh->len = newlen;
}

3.5.扩容

sds可以动态扩容。当sds空闲空间不足以容纳操作所需时，会调用以下函数扩容：

`sdsMakeRoomFor`

分配空间，使sds中可以多容纳额外的addlen个字符。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


sds sdsMakeRoomFor(sds s, size_t addlen) {
    struct sdshdr *sh, *newsh;
    size_t free = sdsavail(s);
    size_t len, newlen;

    // 空闲空间足够
    if (free >= addlen) return s;
    len = sdslen(s);
    sh = (void*) (s-(sizeof(struct sdshdr)));
    newlen = (len+addlen);
    // 如果小于预分配最大长度，额外分配newlen长度的空间。否则多分配SDS_MAX_PREALLOC长度空间
    if (newlen < SDS_MAX_PREALLOC)
        newlen *= 2;
    else
        newlen += SDS_MAX_PREALLOC;
    // +1用于存放末尾的\0
    newsh = zrealloc(sh, sizeof(struct sdshdr)+newlen+1);
    if (newsh == NULL) return NULL;

    newsh->free = newlen - len;
    return newsh->buf;
}

`sdsgrowzero`

增加字符串长度，以0填充增加的部分。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


sds sdsgrowzero(sds s, size_t len) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    size_t totlen, curlen = sh->len;

    // len小于curlen，不做处理
    if (len <= curlen) return s;
    s = sdsMakeRoomFor(s,len-curlen);
    if (s == NULL) return NULL;

    sh = (void*)(s-(sizeof(struct sdshdr)));
    memset(s+curlen,0,(len-curlen+1));
    totlen = sh->len+sh->free;
    sh->len = len;
    sh->free = totlen-sh->len;
    // 因为memset将所有的都设置为0了，不用特地设置sh->buf[sh->len] = '\0'
}

3.6.拼接

以`const void *`和`size_t`指定一块内存

sdscatlen将由t和len指定的内容拼接到现有字符串的后面。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


sds sdscatlen(sds s, const void *t, size_t len) {
    struct sdshdr *sh;
    size_t curlen = sdslen(s);

    // 分配足够的空间
    s = sdsMakeRoomFor(s,len);
    if (s == NULL) return NULL;
    sh = (void*) (s-(sizeof(struct sdshdr)));
    // 将t内容copy到字符串尾部
    memcpy(s+curlen, t, len);
    // 更新长度
    sh->len = curlen + len;
    sh->free = sh->free-len;
    // 设置\0
    s[curlen+len] = '\0';
    return s;
}

以`const char *`类型的参数

sdscat将t拼接到现有字符串的后面。

1
2
3


sds sdscat(sds s, const char *t) {
    return sdscatlen(s, t, strlen(t));
}

拼接已有`sds`对象

将已有的一个sds拼接到另一个sds的后面。

1
2
3


sds sdscatsds(sds s, const sds t) {
    return sdscatlen(s, t, sdslen(t));
}

以`const char *`和`va_list`指定的可变参数

sdscatvprintf将格式fmt和ap指定的可变参数拼接到sds的后面。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


sds sdscatvprintf(sds s, const char *fmt, va_list ap) {
    va_list cpy;
    char staticbuf[1024], *buf = staticbuf, *t;
    size_t buflen = strlen(fmt) * 2;

    if (buflen > sizeof(staticbuf)) {
        buf = zmalloc(buflen);
        if (buf == NULL) return NULL
    } else {
        buflen = sizeof(staticbuf);
    }

    while(1) {
        // 尝试通过将位置buflen-2设置为\0，然后使用vsnprintf将内容输出到buf中。
        // 如果\0被覆盖，说明大小超出。需要重新分配大写，再次尝试。
        buf[buflen-2] = '\0';
        va_copy(cpy,ap);
        vsnprintf(buf, buflen, fmt, cpy);
        va_end(cpy);
        if (buf[buflen-2] != '\0') {
            if (buf != staticbuf) zfree(buf);
            buflen *= 2;
            buf = zmalloc(buflen);
            if (buf == NULL) return NULL;
            continue;
        }
        break;
    }

    t = sdscat(s, buf);
    if (buf != staticbuf) zfree(buf);
    return t;
}

以`const char *`和`...`指定的可变参数

sdscatprintf通过格式fmt将可变参数拼接到sds的后面。

1
2
3
4
5
6
7
8


sds sdscatprintf(sds s, const char *fmt, ...) {
    va_list ap;
    char *t;
    va_start(ap, fmt);
    t = sdscatvprintf(s,fmt,ap);
    va_end(ap);
    return t;
}

以`const char *`和`...`指定的可变参数（redis自己实现的）

sdscatfmt与sdscatprintf功能类似，但是速度更快，只支持部分格式操作符。

1
2
3
4
5
6
7


%s - C字符串
%S - sds字符串
%i - 有符号整数
%I - 64位有符号整数
%u - 无符号整数
%U - 64位无符号整数
%% - %

1
2
3


sds sdscatfmt(sds s, char const *fmt, ...) {
    // ...
}

3.7.拆分

sdssplitlen以sep和seplen分隔字符串s，根据得到的每个子字符串创建sds数组并返回。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47


sds *sdssplitlen(const char *s, int len, const char *sep, int seplen, int *count) {
    int elements = 0, slots = 5, start = 0, j;
    sds *tokens;

    if (seplen < 1 || len < 0) return NULL;

    tokens = zmalloc(sizeof(sds)*slots);
    if (tokens == NULL) return NULL;

    if (len == 0) {
        *count = 0;
        return tokens;
    }
    for (j = 0; j < (len-(seplen-1)); j++) {
        // +2为下一个和最后一个分配空间
        if (slots < elements+2) {
            sds *newtokens;

            slots *= 2;
            newtokens = zrealloc(tokens,sizeof(sds)*slots);
            if (newtokens == NULL) goto cleanup;
            tokens = newtokens;
        }
        if ((seplen == 1 && *(s+j) == sep[0]) || (memcmp(s+j,sep,seplen) == 0)) {
            // 构造sds
            tokens[elements] = sdsnewlen(s+start,j-start);
            if (tokens[elements] == NULL) goto cleanup;
            elements++;
            start = j+seplen;
            // 跳过分隔符
            j = j+seplen-1;
        }
    }
    tokens[elements] = sdsnewlen(s+start,len-start);
    if (tokens[elements] == NULL) goto cleanup;
    elements++;
    *count = elements;
    return tokens;

cleanup:
    {
        int i;
        for (i = 0; i < elements; i++) sdsfree(tokens[i]);
        zfree(tokens);
        return NULL;
    }
}

sdssplitlen返回的sds数组需要调用sdsfreesplitres释放：

1
2
3
4
5
6


void sdsfreesplitres(sds *tokens, int count) {
    if (!tokens) return;
    while(count--)
        sdsfree(tokens[count]);
    zfree(tokens);
}

3.8.连接

sdsjoin将字符串数组拼接成以sep分隔的一个sds。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


sds sdsjoin(char **argv, int argc, char *sep) {
    sds join = sdsempty();
    int j ;

    for (j = 0; j < argc; j++) {
        // 拼接字符串
        join = sdscat(join, argv[j]);
        // 如果不是最后一个，拼接分隔符
        if (j != argc-1) join = sdscat(join,sep);
    }
    return join;
}

3.9.映射

sdsmapchars将sds在from中的字符转为to中的对应字符。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


sds sdsmapchars(sds s, const char *from, const char *to, size_t setlen) {
    size_t j, i, l = sdslen(s);

    for (j = 0; j < l; j++) {
        for (i = 0; i < setlen; i++) {
            if (s[j] == from[i]) {
                s[j] = to[i];
                break;
            }
        }
    }
    return s;
}

3.10.比较

sdscmp使用memcmp比较两个sds内容。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


int sdscmp(const sds s1, const sds s2) {
    size_t l1, l2, minlen;
    int cmp;

    // 如果s1>s2，返回整数
    // 如果s1<s2，返回负数
    // 如果s1==s2，返回0
    l1 = sdslen(s1);
    l2 = sdslen(s2);
    minlen = (l1 < l2) ? l1 : l2;
    cmp = memcmp(s1,s2,minlen);
    if (cmp == 0) return l1-l2;
    return cmp;
}

4.总结

原生的C语言字符串有这样或那样的问题，例如获取长度性能不高，二进制不安全等，所以很多第三方库都是自己实现字符串结构。

文章目录

目录：

1.概述

实现

3.操作

3.1.创建

以const void *和size_t指定一块内存

以const char *类型的参数

不带参数创建空sds

从已有的sds复制

以long long类型的参数

3.2.销毁

3.3.查询基本信息

获取字符串长度

获取空闲空间

占用内存大小

3.4.修改

更新长度

清空sds

释放空闲空间

增加/减少字符串长度

转换为小写

转换为大写

以const void *和size_t指定的内存覆盖

以const char *指定内容覆盖

移除首尾指定字符

保留指定范围

3.5.扩容

sdsMakeRoomFor

sdsgrowzero

3.6.拼接

以const void *和size_t指定一块内存

以const char *类型的参数

拼接已有sds对象

以const char *和va_list指定的可变参数

以const char *和...指定的可变参数

以const char *和...指定的可变参数（redis自己实现的）

3.7.拆分

3.8.连接

3.9.映射

3.10.比较

4.总结

以`const void *`和`size_t`指定一块内存

以`const char *`类型的参数

不带参数创建空`sds`

从已有的`sds`复制

以`long long`类型的参数

清空`sds`

以`const void *`和`size_t`指定的内存覆盖

以`const char *`指定内容覆盖

`sdsMakeRoomFor`

`sdsgrowzero`

以`const void *`和`size_t`指定一块内存

以`const char *`类型的参数

拼接已有`sds`对象

以`const char *`和`va_list`指定的可变参数

以`const char *`和`...`指定的可变参数

以`const char *`和`...`指定的可变参数（redis自己实现的）