渐进式解析 Redis 源码 - 前情

2018-09-25 阅读量

工欲善其事，必先利其器

Redis 作为单进程网络编程的巅峰，除却大家都已经熟知的持久化高效缓存、丰富的存储结构、高可用集群、原子性操作、publish/subscribe、通知等特性，另外还有很多值得借鉴的优秀设计，比如 hyperloglog（基量统计算法）、zmalloc内存分配优化（jemalloc 和 tcmalloc）、multi事务、链地址 hash、zskiplist 跳跃表、ziplist 压缩表 等。

再加上 微博拥有国内最大的 Redis 集群资源（~手动狗头~） 和平时的一些工作需求，不可避免对 Redis 产生极大的兴趣，更更更为优秀的是，redis 源码极其精简，整个核心源码只有 7~8w 行 ~~~

源码结构

我们需要下载 Redis 源码（此文时版本为 4.0.11），首选当然是

1	[wettper@web-lovers src]$ wget http://download.redis.io/releases/redis-4.0.11.tar.gz

核心文件结构如下（ src/ 目录 ）

server.h / server.c Redis 服务器主逻辑
redis-cli.c 客户端
sds.h / sds.c 简单动态字符串
adlist.h / adlist.c 链表
dict.h / dict.c 字典
intset.h / intset.c 整数集合
ziplist.h / ziplist.c 压缩列表
object.c 对象obj
t_string.c 字符串类型逻辑
t_list.c 列表类型逻辑
t_set.c 集合类型逻辑
t_zset.c 有序集合类型逻辑
t_hash.c 哈希类型逻辑
db.c 数据库 db 主逻辑
rdb.h / rdb.c / aof.c RDB / AOF 持久化
syncio.c 复制操作
sentinel.c Sentinel 哨兵
cluster.h / cluster.c 集群
pubsub.c 发布 / 订阅
scripting.c Lua 脚本
slowlog.h / slowlog.c 慢日志

环境工具准备以及调试技巧

Redis 属于免配置的工程，所以不需要执行 configure 而直接 make

[wettper@web-lovers redis-src]$ make CFLAGS='-g -O0 -gdwarf-2 -g3'
   # -g 调试编译
   # -O0 代表放弃编译优化（调试的时候使用，平时一定要使用 -O2 或者 -O3），代码在编译的时候会进行优化，非常不利于按照步骤调试
   # -g3 会将扩展的debug信息编译进二进制文件中，包括宏定义信息，用于调试 宏定义信息
   # -gdwarf-2 DWARF是一种应用比较广泛的可执行链接格式elf，目前有 dwarf-1、dwarf-2、dwarf-3，1版本比较陈旧了，一般使用了2，具体可以去查一下os-debugging官方文档

工具推荐 ctags、cgdb，工具使用方式可以参照之前的文章编译调试模块

如何阅读源码

阅读 Redis 源码需要有一定的 UNIX网络编程基础，另外对于源码阅读，没有必要第一遍就完全理解所有细节，跟着我们的节奏渐进式了解每部分的实现机制，自己实际动手调试细节，方能达到目的。

源码阅读顺序：

自底向上 从耦合关系最小的模块开始读，然后逐渐过度到关系紧密的模块。就好像写程序的测试一样，先从单元测试开始，然后才到功能测试。我在刚开始读 Redis 源码的时候，使用的就是这种方法：先从单独的数据结构模块开始，然后再过渡到高层的功能模块。
从功能入手 通过文件名（模块名）和函数名，快速定位到一个功能的具体实现，然后追踪整个实现的运作流程，从而了解该功能的实现方式。我在读阻塞列表、数据库这种流程和功能都比较复杂，和其他文件耦合也比较多的模块时，使用的就是这样的方法。
自顶向下 从程序的 main() 函数，或者某个特别大的调用者函数为入口，以深度优先或者广度优先的方式阅读它的源码。我在阅读 server.c/serverCron() 、 server.c/main() 和 ae.c/aeMain() 这种有明显调用者性质的函数时，使用的就是这样的方法。

本文作者： wettper
本文链接： http://www.web-lovers.com/redis-source-prepare-env.html
版权声明： 本博客所有文章除特别声明外，均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处！

源码结构

环境工具准备 以及 调试技巧

如何阅读源码

环境工具准备以及调试技巧