字符串内部结构

Redis 字符串原始实现指南

注意:本文档由 Redis 创建者 Salvatore Sanfilippo 在 Redis 开发初期(约 2010 年)撰写。自 Redis 2.6 版本起,虚拟内存已被弃用,因此此文档仅供历史参考。

Redis 字符串的实现包含在 sds.c 中(sds 代表简单动态字符串)。该实现作为独立库提供,地址为 https://github.com/antirez/sds

sds.h 中声明的 C 结构 sdshdr 代表一个 Redis 字符串

struct sdshdr {
    long len;
    long free;
    char buf[];
};

buf 字符数组存储实际字符串。

len 字段存储 buf 的长度。这使得获取 Redis 字符串的长度成为 O(1) 操作。

free 字段存储可供使用的额外字节数。

lenfree 字段共同构成 buf 字符数组的元数据。

创建 Redis 字符串

sds.h 中定义了一个名为 sds 的新数据类型,作为字符指针的同义词

typedef char *sds;

sds.c 中定义的 sdsnewlen 函数创建新的 Redis 字符串

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;
}

请记住,Redis 字符串是 struct sdshdr 类型的变量。但是,sdsnewlen 返回字符指针!

这是一个技巧,需要解释一下。

假设我使用 sdsnewlen 创建了一个 Redis 字符串,如下所示

sdsnewlen("redis", 5);

这会创建一个类型为 struct sdshdr 的新变量,为 lenfree 字段以及 buf 字符数组分配内存。

sh = zmalloc(sizeof(struct sdshdr)+initlen+1); // initlen is length of init argument.

sdsnewlen 成功创建 Redis 字符串后,结果类似于

-----------
|5|0|redis|
-----------
^   ^
sh  sh->buf

sdsnewlensh->buf 返回给调用方。

如果需要释放 sh 指向的 Redis 字符串,该怎么办?

您想要 sh 指针,但您只有 sh->buf 指针。

您可以从 sh->buf 获取 sh 指针吗?

可以。使用指针运算。请注意,从上面的 ASCII 图中可以看出,如果从 sh->buf 中减去两个长整型的大小,您将获得 sh 指针。

两个长整型的大小恰好是 struct sdshdr 的大小。

查看 sdslen 函数,并观察此技巧的应用。

size_t sdslen(const sds s) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    return sh->len;
}

了解了此技巧后,您可以轻松浏览 sds.c 中的其余函数。

Redis 字符串实现隐藏在仅接受字符指针的接口后面。Redis 字符串的用户无需关心其实现方式,可以将 Redis 字符串视为字符指针。

RATE THIS PAGE
Back to top ↑