redis源码分析(一):搭建调试环境

源码的获取方式就不说了,推荐一个带注释的3.x版本:https://github.com/huangz1990/redis-3.0-annotated
拿到源码以后,可以看到其目录结构,


JjdeMacBook-Pro:redis-3.0-annotated-unstable jjchen$ ls
00-RELEASENOTES     COPYING         Makefile        deps            runtest-cluster     src
BUGS            INSTALL         README          redis.conf      runtest-sentinel    tests
CONTRIBUTING        MANIFESTO       README.rst      runtest         sentinel.conf       utils

这里我们先只关注src:源码目录,deps:部分脚本类头文件依赖。
进入src之后,可以看到源码都在当前目录下了,查看makefile文件,可以看到执行make以后,实际生成了六个可执行文件:

  • redis-server: redis 服务端

  • redis-cli: redis 命令行工具

  • redis-sentinel redis 哨兵(多机下使用,实际就是redis-server)

  • redis-check-dump,redis-benchmark,redis-check-aof 一些redis工具。

我们现在只关注服务端的程序,查看makefile文件,可得到redis-server 依赖的obj文件。

REDIS_SERVER_OBJ=adlist.o ae.o anet.o dict.o redis.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.o cluster.o crc16.o endianconv.o slowlog.o scripting.o bio.o rio.o rand.o memtest.o crc64.o bitops.o sentinel.o notify.o setproctitle.o blocked.o hyperloglog.o

选择一种ide工具将对应的.c文件添加到项目,我这里选择的是xcode,并添加相应的头文件,库文件。我按照功能将这些.c文件进行了分类,结果是这样的:

localhost:server302 jjchen$ tree
.
├── cluster
│   ├── cluster.c
│   ├── cluster.h
│   ├── replication.c
│   ├── sentinel.c
│   └── syncio.c
├── db
│   ├── bitops.c
│   ├── blocked.c
│   ├── datastruct
│   │   ├── adlist.c
│   │   ├── adlist.h
│   │   ├── dict.c
│   │   ├── dict.h
│   │   ├── hyperloglog.c
│   │   ├── intset.c
│   │   ├── intset.h
│   │   ├── pqsort.c
│   │   ├── pqsort.h
│   │   ├── sds.c
│   │   ├── sds.h
│   │   ├── sort.c
│   │   ├── t_list.c
│   │   ├── t_set.c
│   │   ├── t_string.c
│   │   ├── t_zset.c
│   │   ├── ziplist.c
│   │   ├── ziplist.h
│   │   ├── zipmap.c
│   │   └── zipmap.h
│   ├── db.c
│   ├── multi.c
│   ├── notify.c
│   ├── object.c
│   ├── pubsub.c
│   ├── redis.c
│   ├── redis.h
│   └── storage
│       ├── aof.c
│       ├── bio.c
│       ├── bio.h
│       ├── rdb.c
│       ├── rdb.h
│       ├── slowlog.c
│       └── slowlog.h
├── encoding
│   ├── crc16.c
│   ├── crc64.c
│   ├── crc64.h
│   ├── endianconv.c
│   ├── endianconv.h
│   ├── lzf.h
│   ├── lzfP.h
│   ├── lzf_c.c
│   ├── lzf_d.c
│   ├── sha1.c
│   ├── sha1.h
│   └── t_hash.c
├── network
│   ├── ae.c
│   ├── ae.h
│   ├── ae_kqueue.c
│   ├── anet.c
│   ├── anet.h
│   └── networking.c
├── others
│   ├── asciilogo.h
│   ├── config.c
│   ├── config.h
│   ├── debug.c
│   ├── fmacros.h
│   ├── memtest.c
│   ├── redisassert.h
│   ├── release.c
│   ├── release.h
│   ├── scripting.c
│   ├── setproctitle.c
│   └── version.h
└── utils
    ├── rand.c
    ├── rand.h
    ├── rio.c
    ├── rio.h
    ├── util.c
    ├── util.h
    ├── zmalloc.c
    └── zmalloc.h

下面简述各文件组的作用:

  • cluster:多机环境实现。
  • db:redis服务的实现,重点。
  • encoding: 数据编码有关的实现
  • network: 与网络相关的代码,客户端连接实现。
  • others: 杂项,低优先级
  • utils: 一些辅助类

对比2.x的redis,除了增加功能以外,大大缩减了redis.c文件的大小,把里面的数据结构抽取到新的文件里面,更易于阅读。
启用debug模式调试服务端,在terminal上开个redis-cli,就可以开始自嗨了。

你可能感兴趣的:(redis源码分析(一):搭建调试环境)