redis源码笔记－dict.h

这篇介绍redis最后一个基础数据结构——hash表。可以毫不夸张的说，hash表是redis一切存储的基础，也是redis得以快如飞的基础。

注：其实还有个intset，不过intset是在持久化dump到硬盘时为节省空间设计的，和我们这里谈的不一样。

dict的设计呢，简单的说是一个双表，“一主一从”，不定时rehash，建议大家在读代码前能够对这个设计有所了解。Anyway，随便搜一搜，很多文章的。

dict.h

#ifndef __DICT_H
#define __DICT_H

#define DICT_OK 0
#define DICT_ERR 1

/* Unused arguments generate annoying warnings... */
#define DICT_NOTUSED(V) ((void) V)          //redis实现里很多这种NOTUSED宏，算是作者偷懒吧

typedef struct dictEntry {
    void *key;
    void *val;
    struct dictEntry *next;
} dictEntry;                                 //redis的一个dict表项，存的是key , val， 以及因为redis的hash是用的拉链法，所以有一个指向下一个dictEntry的指针；
                                                 //一个dictEntry的内存占用为12个字节，记住这个数字。

typedef struct dictType {
    unsigned int (*hashFunction)(const void *key);        //hash函数
    void *(*keyDup)(void *privdata, const void *key);     //复制key
    void *(*valDup)(void *privdata, const void *obj);     //复制value
    int (*keyCompare)(void *privdata, const void *key1, const void *key2);      //key的compare函数
    void (*keyDestructor)(void *privdata, void *key);
    void (*valDestructor)(void *privdata, void *obj);
} dictType;                                 //dict的类型

/* 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;
    unsigned long size;    //size
    unsigned long sizemask;
    unsigned long used;    //used
} dictht;      //这个是hash table结构，每个dictionary有两个hash 表，实现的是递增的rehash

typedef struct dict {
    dictType *type;     
    void *privdata;
    dictht ht[2];
    int rehashidx; /* rehashing not in progress if rehashidx == -1 */  //记录是否在rehash的一个flag，rehash进行过程中，有些操作不能进行
    int iterators; /* number of iterators currently running */         //记录在dict上正在执行的iter数
} dict;        //dict的数据结构

/* If safe is set to 1 this is a safe iteartor, that means, you can call
 * dictAdd, dictFind, and other functions against the dictionary even while
 * iterating. Otherwise it is a non safe iterator, and only dictNext()
 * should be called while iterating. */     
     //迭代器按照是否可以执行改变hash表的函数区别为safe iterator和non safe iterator， non safe iterator只能执行dictNext函数

typedef struct dictIterator {
    dict *d;
    int table, index, safe;
    dictEntry *entry, *nextEntry;
} dictIterator;

/* This is the initial size of every hash table */
#define DICT_HT_INITIAL_SIZE     4

/* ------------------------------- Macros ------------------------------------*/
#define dictFreeEntryVal(d, entry) \
    if ((d)->type->valDestructor) \
        (d)->type->valDestructor((d)->privdata, (entry)->val)

#define dictSetHashVal(d, entry, _val_) do { \
    if ((d)->type->valDup) \
        entry->val = (d)->type->valDup((d)->privdata, _val_); \
    else \
        entry->val = (_val_); \
} while(0)

#define dictFreeEntryKey(d, entry) \
    if ((d)->type->keyDestructor) \
        (d)->type->keyDestructor((d)->privdata, (entry)->key)

#define dictSetHashKey(d, entry, _key_) do { \
    if ((d)->type->keyDup) \
        entry->key = (d)->type->keyDup((d)->privdata, _key_); \
    else \
        entry->key = (_key_); \
} while(0)

#define dictCompareHashKeys(d, key1, key2) \
    (((d)->type->keyCompare) ? \
        (d)->type->keyCompare((d)->privdata, key1, key2) : \
        (key1) == (key2))

#define dictHashKey(d, key) (d)->type->hashFunction(key)

#define dictGetEntryKey(he) ((he)->key)
#define dictGetEntryVal(he) ((he)->val)
#define dictSlots(d) ((d)->ht[0].size+(d)->ht[1].size)
#define dictSize(d) ((d)->ht[0].used+(d)->ht[1].used)
#define dictIsRehashing(ht) ((ht)->rehashidx != -1)

/* API */
dict *dictCreate(dictType *type, void *privDataPtr);
int dictExpand(dict *d, unsigned long size);
int dictAdd(dict *d, void *key, void *val);
int dictReplace(dict *d, void *key, void *val);
int dictDelete(dict *d, const void *key);
int dictDeleteNoFree(dict *d, const void *key);
void dictRelease(dict *d);
dictEntry * dictFind(dict *d, const void *key);
void *dictFetchValue(dict *d, const void *key);
int dictResize(dict *d);
dictIterator *dictGetIterator(dict *d);
dictIterator *dictGetSafeIterator(dict *d);
dictEntry *dictNext(dictIterator *iter);
void dictReleaseIterator(dictIterator *iter);
dictEntry *dictGetRandomKey(dict *d);
void dictPrintStats(dict *d);
unsigned int dictGenHashFunction(const unsigned char *buf, int len);
unsigned int dictGenCaseHashFunction(const unsigned char *buf, int len);
void dictEmpty(dict *d);
void dictEnableResize(void);
void dictDisableResize(void);
int dictRehash(dict *d, int n);        //进行多少个dictEntry的rehash
int dictRehashMilliseconds(dict *d, int ms);   //限制rehash执行的时间，这两个函数都在redis的主流程中被调用，避免因为执行rehash，无法响应client请求。

/* Hash table types */
extern dictType dictTypeHeapStringCopyKey;
extern dictType dictTypeHeapStrings;
extern dictType dictTypeHeapStringCopyKeyValue;  //三种预先定义好的dictType，具体定义参考其他文件。

#endif /* __DICT_H */