参考资料（http://www.redisbook.com） 简单动态字符串（sds）是redis底层所使用的字符串表示形式，作用主要有以下两个：

  • 实现字符串对象
  • 在redis内部被用作char *的替代品。

文件依赖

sds.c sds.h zmalloc.h

sds的实现

数据结构

1
2
3
4
5
6
7
typedef char *sds;

struct sdshdr {
    long len;					/* sds已经使用的长度 */
    long free;					/* sds剩余的长度 */
    char buf[];					/* sds */
};

结构示意图


sds对象存储在buf缓冲区中，已经使用的空间长度为len,空闲空间长度为free。

函数

1. sdsOomAbort

1
2
3
4
5
6
#define SDS_ABORT_ON_OOM
/* 内存分配失败时终止进程 */
static void sdsOomAbort(void) {
    fprintf(stderr,"SDS: Out Of Memory (SDS_ABORT_ON_OOM defined)\n");
    abort();
}

该函数是用来在申请内存失败时终止进程的。

2. sdsnewlen

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/* 创建sds，存储内容为init,长度为initlen */
sds sdsnewlen(const void *init, size_t initlen) {
    struct sdshdr *sh;

    sh = zmalloc(sizeof(struct sdshdr)+initlen+1);
#ifdef SDS_ABORT_ON_OOM
    if (sh == NULL) sdsOomAbort();
#else
    if (sh == NULL) return NULL;
#endif
    sh->len = initlen;
    sh->free = 0;
    if (initlen) {
        if (init) memcpy(sh->buf, init, initlen);
        else memset(sh->buf,0,initlen);
    }
    sh->buf[initlen] = '\0';
    return (char*)sh->buf;
}

创建sds，内容为init指向的存储区域存储的内容，长度为initlen。

3. sdsempty

1
2
3
4
/* 创建空的sds */
sds sdsempty(void) {
    return sdsnewlen("",0);
}

该函数是对sdsnewlen的封装，创建一个空的sds对象。

4. sdsnew

1
2
3
4
5
/* 创建sds,存储内容为init */
sds sdsnew(const char *init) {
    size_t initlen = (init == NULL) ? 0 : strlen(init);
    return sdsnewlen(init, initlen);
}

调用sdsnewlen函数，创建一个sds，内容为init指向的存储空间存储的内容。

5. sdslen

1
2
3
4
5
/* 返回sds已经使用的长度 */
size_t sdslen(const sds s) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    return sh->len;
}

返回sds已经使用的长度。

6. sdsdup

1
2
3
4
/* 复制sds */
sds sdsdup(const sds s) {
    return sdsnewlen(s, sdslen(s));
}

复制sds对象，返回新对象。

7. sdsfree

1
2
3
4
5
/* 释放sds */
void sdsfree(sds s) {
    if (s == NULL) return;
    zfree(s-sizeof(struct sdshdr));
}

释放sds对象。

8. sdsavail

1
2
3
4
5
/* 返回sds的剩余空间 */
size_t sdsavail(sds s) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    return sh->free;
}

返回sds的可用空间长度。

9. sdsupdatelen

1
2
3
4
5
6
7
/* 更新sds已经使用的长度 */
void sdsupdatelen(sds s) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    int reallen = strlen(s);
    sh->free += (sh->len-reallen);
    sh->len = reallen;
}

更新sds已经使用的长度和可用长度。

10. sdsMakeRoomFor

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/* 追加sds的总长度 */
static sds sdsMakeRoomFor(sds s, size_t addlen) {
    struct sdshdr *sh, *newsh;
    size_t free = sdsavail(s);
    size_t len, newlen;
    /* sds中剩余的空间足够 */
    if (free >= addlen) return s;
    len = sdslen(s);
    sh = (void*) (s-(sizeof(struct sdshdr)));
    newlen = (len+addlen)*2;	/* 字符串缓冲区的新长度 */
    newsh = zrealloc(sh, sizeof(struct sdshdr)+newlen+1);
#ifdef SDS_ABORT_ON_OOM
    if (newsh == NULL) sdsOomAbort();
#else
    if (newsh == NULL) return NULL;
#endif
    /* 更新sds的剩余长度 */
    newsh->free = newlen - len;
    return newsh->buf;
}

为sds增加空间。

11. sdscatlen

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* s连接长度为len的t */
sds sdscatlen(sds s, 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)));
    memcpy(s+curlen, t, len);
	sh->len = curlen+len;
	sh->free = sh->free-len;
	s[curlen+len] = '\0';
	return s;
}

s链接长度为len的t。

12. sdscat

1
2
3
4
/* s和t连接 */
sds sdscat(sds s, char *t) {
    return sdscatlen(s, t, strlen(t));
}

调用sdscatlen，链接s和t

13. sdscpylen

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
/* 将s的内容替换为长度为len的t */
sds sdscpylen(sds s, char *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-totlen);
        if (s == NULL) return NULL;
        sh = (void*) (s-(sizeof(struct sdshdr)));
        totlen = sh->free+sh->len;
    }
    memcpy(s, t, len);
    s[len] = '\0';
    sh->len = len;
    sh->free = totlen-len;
    return s;
}
``` 
将s的内容替换为长度为len的t。 

#### 14\. sdscpy

``` c
/* 封装sdscpylen */
sds sdscpy(sds s, char *t) {
    return sdscpylen(s, t, strlen(t));
}

调用sdscpylen，将s的内容替换为长度为len的t。

15. sdscatprintf

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
/* 输出内容到s的后面 */
sds sdscatprintf(sds s, const char *fmt, ...) {
    va_list ap;
	char *buf, *t;
	size_t buflen = 32;

    while(1) {
        buf = zmalloc(buflen);
    #ifdef SDS_ABORT_ON_OOM
        if (buf == NULL) sdsOomAbort();
    #else
        if (buf == NULL) return NULL;
    #endif
        buf[buflen-2] = '\0';	/* 使用'\0'作为标志位 */
        va_start(ap, fmt);
        vsnprintf(buf, buflen, fmt, ap);
        va_end(ap);				
        if (buf[buflen-2] != '\0') { /* 标志位被覆盖 */
            zfree(buf);				 /* 说明长度不足 */
            buflen *= 2;
            continue;
        }
        break;
    }
    t = sdscat(s, buf);			/* 将buf接到s的面 */
    zfree(buf);
    return t;
}

输出内容按指定的格式到buf缓冲区中，然后将buf连接到s的后面。

16. sdstrim

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/* 截断sds,strchr返回指定字符在指定字符串出现的位置的指针 */
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);
    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;
}

这个函数没弄明白有什么用处， 大体上是从s中去掉cset。

17. sdsrange

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
/* 将s截断到从start到end的范围 */
sds sdsrange(sds s, long start, long end) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    size_t newlen, len = sdslen(s);

    if (len == 0) return s;
    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) {
        if (start >= (signed)len) start = len-1;
        if (end >= (signed)len) end = len-1;
        newlen = (start > end) ? 0 : (end-start)+1;
    } else {
        start = 0;
    }
    if (start != 0) memmove(sh->buf, sh->buf+start, newlen);
    sh->buf[newlen] = 0;
    sh->free = sh->free+(sh->len-newlen);
    sh->len = newlen;
    return s;
}

s只保留start到end的部分，对于start或end小于0的情况，要做适当的转换。
当start大于end时，相当于把sds清空。
复制内存用的是memmove，该函数适用于源内存区域和目标内存区域有重叠的情况，如果不重叠，可以使用memcpy。

18. 大小写转换

1
2
3
4
5
6
7
8
9
10
11
12
/* 将s装换为小写 */
void sdstolower(sds s) {
    int len = sdslen(s), j;

    for (j = 0; j < len; j++) s[j] = tolower(s[j]);
}
/* 将s装换为大写 */
void sdstoupper(sds s) {
    int len = sdslen(s), j;

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

这两个函数没什么好说的。

19. sdscmp

1
2
3
4
5
6
7
8
9
10
11
12
/* 比较s1和s2，s1>s2,返回值大于0；s1<s2,返回值小于0；等于0时，s1=s2 */
int sdscmp(sds s1, sds s2) {
    size_t l1, l2, minlen;
    int cmp;

    l1 = sdslen(s1);
    l2 = sdslen(s2);
    minlen = (l1 < l2) ? l1 : l2;
    cmp = memcmp(s1,s2,minlen);
    if (cmp == 0) return l1-l2;
        return cmp;
}

该函数用于比较两个sds对象 

* 大于0： s1>s2
* 小于0： s1<s2
* 等于0： s1=s2

20. sdssplitlen

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/* 切割字符串，*count存储的切割后的子串数目 */
/* Split 's' with separator in 'sep'. An array
* of sds strings is returned. *count will be set
* by reference to the number of tokens returned.
*
* On out of memory, zero length string, zero length
* separator, NULL is returned.
*
* Note that 'sep' is able to split a string using
* a multi-character separator. For example
* sdssplit("foo_-_bar","_-_"); will return two
* elements "foo" and "bar".
*
* This version of the function is binary-safe but
* requires length arguments. sdssplit() is just the
* same function but for zero-terminated strings.
*/
sds *sdssplitlen(char *s, int len, char *sep, int seplen, int *count) {
    int elements = 0, slots = 5, start = 0, j;
    /* slots的初始值为5,此时是假设s最多被分为5个子串，不够时可以扩展 */
    sds *tokens = zmalloc(sizeof(sds)*slots);
#ifdef SDS_ABORT_ON_OOM
    if (tokens == NULL) sdsOomAbort(); /* 分配内存失败 */
#endif
    if (seplen < 1 || len < 0 || tokens == NULL) return NULL;
    for (j = 0; j < (len-(seplen-1)); j++) {
        /* make sure there is room for the next element and the final one */
        if (slots < elements+2) { /* slots的值不足 */
            sds *newtokens;

            slots *= 2;            /* 增大slots */
            newtokens = zrealloc(tokens,sizeof(sds)*slots);
            if (newtokens == NULL) { /* 分配内存失败 */
#ifdef SDS_ABORT_ON_OOM
                sdsOomAbort();    
#else  
                goto cleanup;    /* 清理已经分配的空间 */
#endif
            }
            tokens = newtokens;
        } /* 开始查找分隔串 */
        /* search the separator */
        if ((seplen == 1 && *(s+j) == sep[0]) || (memcmp(s+j,sep,seplen) == 0)) {
            tokens[elements] = sdsnewlen(s+start,j-start); /* 找到分隔串 */
            if (tokens[elements] == NULL) {                   /* 上一部操作失败 */
#ifdef SDS_ABORT_ON_OOM
                sdsOomAbort();
#else
                goto cleanup;
#endif
             }
            elements++;
            start = j+seplen;
            j = j+seplen-1; /* skip the separator */
        }
    }
    /* Add the final element. We are sure there is room in the tokens array. */
    tokens[elements] = sdsnewlen(s+start,len-start); /* 添加最后一个子串 */
    if (tokens[elements] == NULL) {                     /* 上一步操作失败 */
#ifdef SDS_ABORT_ON_OOM
    sdsOomAbort();
#else
    goto cleanup;
#endif
    }
    elements++;
    *count = elements;
    return tokens;

#ifndef SDS_ABORT_ON_OOM
cleanup:                        /* 操作失败，释放已经分配的内存 */
    {
        int i;
        for (i = 0; i < elements; i++) sdsfree(tokens[i]);
        zfree(tokens);
        return NULL;
    }
#endif
}

该函数是用来切割sds的，比如”abcde”可以被分隔符”bc”切割，分成”a”和”de”两个sds对象。

分隔符可以是一个或多个字符。

本函数提到了一个“二进制安全”的概念，程序不应对字符串里面保存的数据做任何假设,数据可以是以 \0 结尾的 C 字符串,也可以是单纯的字节数组,或者其他格式的数据。比如说前面有的函数使用了strlen这个函数，它期待参数是已‘\0’结尾的c字符串，该函数就不是和二进制安全的。
个人觉得，该函数说是“二进制安全”的，只是因为由函数的调用者指定s和sep的长度，而不是自己对字符串做一些假设，然后自己去求。

(结束)