河狸家： Redis 源码的深度剖析

[lock522]

文：河狸家 架构师 陈科

原文链接： http://t.cn/RyuxZQJ

Redis 这个东西很简单，懂 C 语言的同学花一个下午，可以把它的来龙去脉都研究懂。但是，它麻雀虽小五脏俱全。一个常见的软件，比如 Redis ，跑起来该用的东西可能都用一些，如果我们把 Redis 搞懂了，要分析一款其他的软件，思路可能也是差不多的，所以我借这个机会，跟大家分享一下我们解剖一个软件的过程。

分享 Redis ，主要通过以下几个步骤。

启动过程

首先，看一下 Redis 的一个启动过程。任何一款软件，它的很多 C 语言实现的过程，都是从 main 函数这个漏斗开始的。一般任何软件设计的时候，不管是 Redis ，还是阿帕奇，或者乱七八糟的东西，一般 Main 函数都定义在跟它软件名字一样的. C 文件里面，里面 main 函数执行的过程分以下几步：

第一步， Redis 会设置一些回调函数，当前时间，随机数的种子。回调函数实际上什么？举个例子，比如 Q/3 要给 Redis 发送一个关闭的命令，让它去做一些优雅的关闭，做一些扫尾清楚的工作，这个工作如果不设计回调函数，它其实什么都不会干。其实 C 语言的程序跑在操作系统之上， Linux 操作系统本身就是提供给我们事件机制的回调注册功能，所以它会设计这个回调函数，让你注册上，关闭的时候优雅的关闭，然后它在后面可以做一些业务逻辑。

第二步，不管任何软件，肯定有一份配置文件需要配置。首先在服务器端会把它默认的一份配置做一个初始化。

第三步， Redis 在 3.0 版本正式发布之前其实已经有筛选这个模式了，但是这个模式，我很少在生产环境在用。 Redis 可以初始化这个模式，比较复杂。

第四步，解析启动的参数。其实不管什么软件，它在初始化的过程当中，配置都是由两部分组成的。第一部分，静态的配置文件；第二部分，动态启动的时候， main ，就是参数给它的时候进去配置。

第五步，把服务端的东西拿过来，装载 Config 配置文件， loadServerConfig 。

第六步，初始化服务器， initServer 。

第七步，从磁盘装载数据。

第八步，有一个主循环程序开始干活，用来处理客户端的请求，并且把这个请求转到后端的业务逻辑，帮你完成命令执行，然后吐数据，这么一个过程。

服务器的模型

接下来看一下 Redis 服务器的模型。 Redis 实现的过程当中，基于不动的操作系统，封装了不同的模型。举个例子，它在 Linux 上面是基于 epoll 做了一个封装，不管怎么样，它都是以 ae_epoll.c 封装的。封装过程当中有三个步骤，我们用原生调用 epoll 的时候也是三个步骤完成。第一个步骤， aeApiCreate ，就是 epoll 的一个池子，先创建了一个池子的东西。第二、通过 ApiAddEvent 调用 epoll 这个函数，可以往 epoll 池子里面注册事件。第三、 ApiPoll ，通过 epoll_wait 来获取已经响应的事件。

Redis 在服务端初始化 epoll

首先，在 main 函数初始化过程当中调用了 innitServer ，其实就是调用刚才讲的 aeCreateEvent ，创建了 epoll 池子。然后调用函数，设定 EVENTLOOP_FDSET_INCR 。然后设置回调函数，注册的事件响应之后要干活，这是一个循环调用的过程。怎么调呢？我们把 aeCreateEvent 这个函数展开，里面有两个过程， Event 如果这个死循环在调用的过程当中，可以跟两类事件发生交道。第一类事件， aeflieEvent 。第二类事件， aeTimeEvent 。因为 Redis 针对 epoll 再做一次封装的时候，它实现了一个定时器，这个定时器可以把你想要注册到这个定时器里面的一些事件注册进去。举个例子，比如内存淘汰的时候，是一个 LRU 的一个算法，你注册到这个定时器，比如内存达到某个大小，比如限制两兆，当它大于两兆的时候要淘汰，这个时候定时器在这个场景下面就会发生作用。

主循环的实现原理

Redis 真正的主循环的原理，大致可以分成三步：

第一步，查找一些优先要处理的事件。什么叫优先要处理？你在调用 API 的时候，这个 API 可能作为 Redis 的使用者不会去关注。但是作为 Redis 的开发者他可能会关注到。你首先要让 Redis 执行一个东西，它这个时候会优先去做处理。

第二步，假如说没有优先处理实践，则执⾏aeApiPoll 来处理 epoll 中的就绪事件。

最后，处理定时器任务。

服务器整体架构图

我们可以通过这张图回顾一下它整体服务器的架构，其实就是这么一回事。最中间圆圈，代表了一个死循环。死循环要跑的时候，要干哪些活？我们把逻辑注册到某个池子里面，比如注册到 epoll 的池子里面，或者注册到定时器当中。它都是通过一些回调函数注册的。比如 TCP 的时间要响应，就不停的执行，这么一个过程， Redis 本身实现也不是太复杂。

当你启动 Redis 的时候，它本身就是一个单进程，单线程的模式。所以，我们在事件处理过程当中，要做到非常小心，精确的做一些控制，因为你的事件一旦进到 Redis 里面，比如我们简单的让 Redis 做一个技术器加法运算，如果加法运算时间花的很多，后面的规模可能就一直等在那里，执行不下去了，因为它是单线程，单进程的。所以说，如果你让 Redis 同步在执行的过程当中，它必然是 CPU 密集型的运算，而且能很快计算完毕，把结果推送给你。

请求协议

其实请求的协议，在前面 main 函数执行过程当中会 initSever ，在 initSever 过程当中我们会注册一个 acceptTcpHandler 回调函数，然后这个函数就会被调用了。 Redis 请求协议分称两种，第一、 inline 协议，第二、 multibulk 协议，如果不是各*开头，就是 inline 协议。

首先，看 inline 的协议，调用 processInline 这个函数比较简单，当你把数据发送给服务端，任何的软件都会把这个数据丢到一个缓存区， Redis 里面有一个 querybuf 结构，执行到缓存区，然后存入到 client 的 arg 数组， argc 代表了参数的格式。 processMultibulkBuffer 协议，我们这里有三个参数的数量，比如 3 ，指的是长度 3 ，具体就是这么一个过程。

当我们把这数据完全解析完之后，这个时候就知道它是什么命令了。比如刚才 Set 命令已经解析完，我们知道它是一个 Set 命令，并且知道它的参数是什么。这时候我们会调用 processcommand 这个函数，执行的过程分成 12 个步骤：

第一、假如命令当中包含了 quit ，后面的指令将不会被执行，直接会返回退出来。

第二、如果不包含 quit ，它有一个 cmd 的结构数组，会到里面查找现在命令到底是哪一个，把具体要执行命令的函数执政找到。

第三、检测命令的参数个数。

第四、如果服务器配置需要密码检验功能，调用的命令必须是 authCommand 。

第五、如果服务器有最大内存限制，必须限制性一下 freeMemorylfNeed 这个过程。

第六、如果服务器状态出现了问题，那么停止执行命令。

第七、如果服务器设置了最小的 slave 数量限制，当 slave 数量小于最小 slave 数量的时候，停止执行命令。

第八、如果服务器为 slave ，则不接受 write 命令。

第九、只能支持 pub/sub 相关的命令了。

第十、当 slave 和 mater 的连接已经断开，并且设置了跟 mater 断开后不再提供服务，那么停止执行命令。

第十一、如果服务器正在装载数据中，则不接受命令。


第十二、如果 lua 脚本执行速度太慢了，也会停止执行命令。

在命令真正的执行过程当中， Redis 分成了两个步骤。第一种，假如已经用了刚才讲的事务处理模式， Redis 会把命令在 Q 里面存起来。所以，真正到 EXEC 之前，打开事务模式，把丢过来的命令先在 Q 存起来，真正执行的时候再执行。第二种，假如不是事务模式，这个时候它就会去真正调用这个 proc 函数，把 Redis 命令真正在后台执行。比如，刚才提到的事务模式，通过 MULTI 关键词输入，后面就起到命令模式，如果后面不调用，它就不会真正执行。

命令执行过程

刚才事务执行时候的命令过程，会把队列里面的命令一个一个拿出来，然后去执行的过程。一个正常命令的执行过程，主要是分成几个步骤：

第一，假如有监视器状态的客户端，首先会把命令发送给客户端。什么叫监视器？举个例子，我是 mater slave 机制的，首先要把这个机制告诉 slave ，你要去执行这条命令。

第二、真正执行。

第三、开启慢查询。

第四、监视就是监视器的命令，哪条命令要执行了，什么日志，什么参数都会发送给我，这是第一步要执行的，只有真正执行完，才会把这个工作发送给 AOF 和 Slave ，这样才符合逻辑。

AddReply 会注册写事件到 epoll 里面去，通过 prepareClientToWrite 。第二、会调用 _addReplyToBuffer 数据写到 buf 中。下一次执行的时候才会循环这个动作，这样每次做的时候， TPS 在单线程，单进程的情况下还能达到理想的状况。第三、假如 buf 为不够大，会添加到链表里面去。

其实 RedisDb 最最核心的实现就是一个置顶的实现，比如有存数据的置顶，就是要不要过期，其实也是存在置顶里面。举个例子，有些请求它其实会阻塞的，阻塞到哪里？有一个阻塞器置顶。当阻塞已经就绪了，有一个就绪的 1 K 的置顶，还可以坚持某个 K 。置顶的具体实现，就不再讲了。

核心数据结构

因为我们最终服务器其实都跟核心的数据结构操作相关。首先，看 string 这个东西，其实 string 就是一个 struct 指针，可以描述长度，还剩余多少等等这些东西。看一下 struct 指针到底怎么指的，它会把 sdshdr 放到内存的前面，把 buf 放到内存的后面。 Redis 检索怎么查找到 sdshdr 这个区域，一般通过目前 buf 最前置的指针减去 sdshdr 这个长度，就知道 sdshdr 在哪里。

我们知道字符串其实就是一个 struct 结构，接下来看一下 hash 结构怎么实现的。 hash 本质是基于 ziplist 的实现，关于 ziplist 的实现， ziplist 通过文本定义了一个数据结构。其实 ziplist 可以认为里面是一个一个的元素。我们理解 hash_max 的时候，有一个 hash_max_ziplist_value 的结构，就是通过这张图描述的这种方式把里面的东西捞出来了。当然， ziplist 在存储 hash 的时候， hash 通过两种方式存的。第一、 ziplist 这种结构。因为 ziplist 具体的长度是可以设置的，当你的长度超过了某个数值之后，它就会转成 dict 的这个结构，最最原始的 dict 的结构，这样它存储的时候都存到 dict 的结构体里面去了。

list 其实就是我们通常用的比较经典的这种双向链表，头指针，尾指针，定义了 list 。接下来还有一个 set 。其实 Redis set 还是存在 dict 这样的结构里面的，因为 list 只有 Velue 没有 Key 。 Redis 还有一个数据结构叫 Sorted Sets ，它是为了加速检索的过程，用到以空间换时间的方式。举个例子，可能有些场景用搜索引擎构建的时候，觉得太麻烦，会建几张表做索引，其实 Sorted Sets 也是一样的，就是通过 span 结构实现了多级索引查询的过程。可以在这个 Velue 之上通过多级指针进行检索。 Redis 里面有一个 pub/sub_channels 这么一个属性，当有什么东西要给客户端的时候，会到这个队列里面查看有没有注册上来的客户端。

事务处理当中，可能还要注意几点：

首先，假如客户端的 flag 是 DIRTY_CAS 或者是 DIRTY_EXEC ，就放弃执行事务了。

第二、在事务执行期间，取消对 key 的 Watch 。

第三、遍历执行队列中的命令。

第四、通过 ReplicationFeedmonitors 服务器同步给 Monitors 客户端进程。

持久化 rdb 的过程，其实 Redis 服务器分成两个步骤，第一、 rdb 的持久化，第二、 AOF 的持久化，基于 rdb 的持久化方式，服务器启动的时候，首先会调用 serverparamslen 的函数，然后 rdb 的工作会把内存里面存的数据，原封不动的拷贝，存储到本地磁盘当中去。 rdbSave 不是让组件程序看这个活，我们需要 fork 一个子进程专门做 rdeSave 的数。

1 、创建临时文件： temp-%d 为 rdb

2 、调用 rdbSaveRio 将 db 中的数据獬入到临时文件。

3 、调用 fflush ， fsync 将缓存中的数据刷新到磁盘。

4 、将 temp 文件重命名为正式的 rdb 文件，后面就是这些描述，这些描述跟前面讲的 Redis 的数据结构其实是对应起来的，然后以这种方式存到这个里面去。

aof 存储的格式和刚才我们请求协议里面讲到的协议是一模一样的，就是纯文本的，比如 set 什么东西，就是一模一样的东西存在这个文件里面。假如开启了 aof 这个功能，会把你历史执行的命令记录原封不动都存在里面，这样这个文件会越来越大。当然， Redis 提供给我们一个功能，可以把 aof 命令压缩。在每次 Redis 重启之后，如果开启了 aof 功能，就会重载 aof 文件中的数据执行命令。然后 Redis 提供了 rewriteaof 定期压缩的功能，其实就是把 db 中的数据重新生成一份新的 aof 。

Redis 的内存分配还是比较简单，不像 memorycash 。 Redis 通过调用原生的函数直接向操作系统申请内存。当内存不停的申请，在使用一段时间之后， Redis 会处罚一些淘汰的策略。这个淘汰分成两种，一种是主动淘汰，举个例子，当我们在调用 RandomKey 等这些函数的时候，首先会主动的淘汰一些内存，这个就叫主动淘汰。还有一种淘汰是 lru 的淘汰，当你在执行的过程当中，如果内存不够，就会处罚 lru 的淘汰算法。另外，还有被动淘汰，前面讲到因为我们在 main 函数调用真正的 epoll 死循环的前置有一个 beforeSleep ， beforeSleep 函数里面会在 databasesCron 定时器都调用 activeExpireCycle 。

Replication 机制

RedisReplication 的机制，分为客户端请求和服务器的处理。我们启动客户端的时候， main 函数里面会调用 serverCron ，在 serverCron 里又会调用 ReplicationCron 这个函数，每隔一秒钟会触发这个函数。

Replication 机制的工作原理。假如说，我们支持 psync 这个协议，服务端会发送我现在的 runid 和 offset 。相当于 rdb 同步到哪个地方了，会把 offset 发送给客户端，每个客户端都会保持一个 cashed_master 节点，就是长链接断掉之后，还会有一个 cashed_master 在。假如不支持 psync 协议，则发送 sync 协议。

服务器端的实现，主要由 syncCommand 实现，它主要的执行过程是这样的。

第一、 psync 这种模式，首先会进行 runid 和 offset 的校验，并发送新的给客户端。

第二、 psync 最后会把现在内存里面增量的数据发送给客户端。

第三、如果全量同步，首先会触发一个 bgsave ，把内存里面的数据，本地保存一份，再推给客户端。如果我们没有定制过的 Redis 服务器，直接从 Redis 那个网站上下载的 Redis 服务器，如果在全量同步的时候，客户端连接太多，调用的时候就会断掉。

第四、触发 sync 的过程。如果是全量，先 rdb 保存一份，再把全量的数据托管。

定制开发 Redis

首先，在 Redis.c 文件找到 RedisCommandTable ，添加命令，比如添加“ test ”， testCommannd ，-5 的函数。

第二、添加命令处理函数。完了我们要修改这个 makefile 文件，最终编译打包。其实真正做的时候没有那么简单，因为 Redis 在内部，你在调用过程当中，会用到它很多内部的函数。所以，你要真正的完整开发定制一个 Redis ，步骤是这样，但是需要把这些函数从头到尾学习一遍，如果你自己又去开发函数，会把 Redis 搞得乱七八糟，很糟糕，可能不一定能跑的很好。

• 本文整理自 UPYUN Open Talk 主题技术沙龙第十四期的讲师现场分享内容。

• 查看 & 下载讲师课件及现场视频、了解更多该活动产生的技术分享内容，请关注 UPYUN 微信公众号（ upaiyun ）

更正一下“核心数据结构”这个章节的第三张图。

[solitude2]

糕手