bingbig / redis

Redis is an in-memory database that persists on disk. The data model is key-value, but many different kind of values are supported: Strings, Lists, Sets, Sorted Sets, Hashes, HyperLogLogs, Bitmaps.

Redis 源码阅读

一个C小白，参考着黄大大的书学习Redis源码！

001 简单动态字符串: Simple dynamic string

2018-08-04 src/sds.h src/sds.c

实现的数据结构（简要）

struct sdshdr {
    uint16_t len; /* 使用了的长度 */
    uint16_t alloc; /* 除了malloc的header和字符串最后的空字符外的长度 */
    unsigned char flags; /* 定义sdshr的类型，3 lsb of type, 5 unused bits */
    char buf[]; /* 字节数组，用与保存字符串 */
};

SDC和C字符串的区别

1. 常数获取字符串长度
2. 杜绝缓冲区溢出
3. 减少字符串修改时带来的内存重分配次数
4. 二进制安全(通过 len 而不是 \0 判断字符结束)
5. 兼容部分C字符串函数

002 链表的实现:

2018-08-05 src/adlist.h src/adlist.c

实现的数据结构

/* 链表节点数据结构 */
typedef struct listNode {
    struct listNode *prev;
    struct listNode *next;
    void *value;
} listNode;

/* 使用list结构体维护链表 */
typedef struct list {
    listNode *head; /* 节点表头 */
    listNode *tail; /* 节点表尾 */
    /* 在结构体中定义函数指针 */ 
    void *(*dup)(void *ptr); /* 节点复制函数，返回指针类型的数据 */
    void (*free)(void *ptr); /* 节点值释放函数 */
    int (*match)(void *ptr, void *key); /* 节点值比对函数 */
    unsigned long len; /* 链表所包含的节点个数 */
} list;

Redis链表特点

1. 双端
2. 无环，头尾指针指向NULL
3. 带有表的头和尾指针
4. 带链表计数器
5. 多态。使用 void * 指针来保存节点值

Redis链表广泛用于Redis的各种功能，比如列表键、发布与订阅、慢查询、监视器等。

003 字典

2018-08-05 src/dict.c dict.h

实现的数据结构

typedef struct dictEntry {          /* 保存hash表中的键值对 */
    void *key;                      /* 键 */
    union {                         /* 值 */
        void *val;
        uint64_t u64;
        int64_t s64;
        double d;
    } v;
    struct dictEntry *next;         /* 指向哈希表中哈希值相同的下一个节点，用于解决键冲突问题 */
} dictEntry;

typedef struct dictType {
    uint64_t (*hashFunction)(const void *key);
    void *(*keyDup)(void *privdata, const void *key);
    void *(*valDup)(void *privdata, const void *obj);
    int (*keyCompare)(void *privdata, const void *key1, const void *key2);
    void (*keyDestructor)(void *privdata, void *key);
    void (*valDestructor)(void *privdata, void *obj);
} dictType;

/* This is our hash table structure. Every dictionary has two of this as we
 * implement incremental rehashing, for the old to the new table. */
typedef struct dictht {         /* 哈希表的结构 */
    dictEntry **table;          /* 哈希表数组，每个元素都是指向dictEntry的指针。起始元素个数为 DICT_HT_INITIAL_SIZE */
    unsigned long size;         /* 哈希表的大小 */
    unsigned long sizemask;     /* 哈希表大小掩码，用于计算索引值，总是等于size-1*/
    unsigned long used;         /* 该哈希表已有的节点（键值对）数目 */
} dictht;

typedef struct dict {           /* 字典的结构 */
    dictType *type;             /* 类型特定函数 */
    void *privdata;             /* 私有数据 */
    dictht ht[2];               /* 二元哈希表 */

    /* rehash时，将ht[0]中的键值对重新hash并迁移到ht[1]中。
     * 当ht[0]为空时，替换ht[1]为ht[0]，新建ht[1]
     * rehash索引进度，值为-1时表示没有在进行rehash
     * */
    long rehashidx;
    unsigned long iterators;    /* 当前运行的迭代器个数 */
} dict;

Redis字典补充资料

1. 字典的遍历dictScan原理
2. 跋山涉水 —— 深入 Redis 字典遍历

004 跳跃表

2018-08-30 /src/server.h

实现的数据结构

typedef struct zskiplistNode {
    sds ele;
    double score;                           /* 分值，跳跃表中的节点按各自的分值从小到大排列 */
    struct zskiplistNode *backward;         /* 后退指针 */
    struct zskiplistLevel {
        struct zskiplistNode *forward;      /* 前进指针 */
        unsigned int span;                  /* 跨度，前进指针所指向节点和当前节点的距离 */
    } level[];                              /* 层 */
} zskiplistNode;

typedef struct zskiplist {
    struct zskiplistNode *header, *tail; /* 跳跃表的头尾指针 */
    unsigned long length;                /* 跳跃表的长度 */
    int level;                           /* 目前跳跃表内，层数最大的那个节点的层数（表头节点不计算在内）*/
} zskiplist;

005 整数集合

2018-08-31 src/intset.h src/intset.c src/endianconv.h

实现的数据结构

typedef struct intset {
    uint32_t encoding;  /** 编码方式 **/
    uint32_t length;    /** 集合包含的元素数目 **/
    int8_t contents[];  /** 保存元素的数组。虽然声明为int8_t类型的数组，但实际上并不保存该类型的值，数组类型取决于encoding属性的值 **/
} intset;

006 压缩列表

2018-09-06 src/ziplist.h src/ziplist.c

压缩列表的结构如下：
<zlbytes> <zltail> <zllen> <entry> <entry> ... <entry> <zlend>

【参考文献和资料】

1. https://github.com/antirez/redis
2. 黄健宏. Redis设计与实现[M]. 机械工业出版社, 2014.