Redis-0x04-用cmake构建项目

Redis项目是通过make构建的，考虑到以下几点，我觉得有必要通过cmake脚本生成MakeFile

  • cmake的跨平台性

  • 源码的结构自定义组织

但是reids项目本身为了兼容跨平台性以及性能优化，提供了诸多的编译选项，我当前的cmake脚本只关注linux平台

  • linux系统

  • jemalloc内存分配器

1 项目结构

项目的构建分为两个部分

  • 依赖的3rd_party编译，将其编译位链接库

  • 源码，将其编译位可执行程序

2 make

之前看过了MakeFile的rule

3 cmake脚本编写

为了尽可能的简单，因此只关注于linux和mac平台，并且当前只编写了编译redis-server可执行程序的脚本

从MakeFile中可以看出来redis工程共提供了如下6个可执行程序的编译

  • redis-server

  • redis-sentinel

  • redis-check-rdb

  • redis-check-aof

  • redis-cli

  • redis-benchmark

3.1 根目录

3.1.1 CmakeLists.txt文件

负责源码的编译以及链接库

CMakeLists
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
cmake_minimum_required(VERSION 3.28.0)
project(redis_6.2 C)

#[[
1 redis源码
2 前置依赖脚本
3 编译成可执行程序redis-server
4 依赖3rd库 libhiredis.a liblua.a libjemalloc.a
5 系统库
6 链接库
]]

#执行shell
execute_process(
        COMMAND sh ${CMAKE_CURRENT_SOURCE_DIR}/src/mkreleasehdr.sh
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/src
)

#系统库 不同的平台依赖的系统库有差异
set(SYS_LIB -lm -ldl -lresolv -lpthread)
if (LINUX)
    set(SYS_LIB "${SYS_LIB} -latomic -lnsl -lrt -lcrypt -lbsd")
elseif (APPLE)
endif ()

#redis-server的源码文件
set(REDIS_SERVER_SRC
        src/adlist.c
        src/quicklist.c
        src/ae.c
        src/anet.c
        src/dict.c
        src/server.c
        src/sds.c
        src/zmalloc.c
        src/lzf_c.c
        src/lzf_d.c
        src/pqsort.c
        src/zipmap.c
        src/sha1.c
        src/ziplist.c
        src/release.c
        src/networking.c
        src/util.c
        src/object.c
        src/db.c
        src/replication.c
        src/rdb.c
        src/t_string.c
        src/t_list.c
        src/t_set.c
        src/t_zset.c
        src/t_hash.c
        src/config.c
        src/aof.c
        src/pubsub.c
        src/multi.c
        src/debug.c
        src/sort.c
        src/intset.c
        src/syncio.c
        src/cluster.c
        src/crc16.c
        src/endianconv.c
        src/slowlog.c
        src/scripting.c
        src/bio.c
        src/rio.c
        src/rand.c
        src/memtest.c
        src/crcspeed.c
        src/crc64.c
        src/bitops.c
        src/sentinel.c
        src/notify.c
        src/setproctitle.c
        src/blocked.c
        src/hyperloglog.c
        src/latency.c
        src/sparkline.c
        src/redis-check-rdb.c
        src/redis-check-aof.c
        src/geo.c
        src/lazyfree.c
        src/module.c
        src/evict.c
        src/expire.c
        src/geohash.c
        src/geohash_helper.c
        src/childinfo.c
        src/defrag.c
        src/siphash.c
        src/rax.c
        src/t_stream.c
        src/listpack.c
        src/localtime.c
        src/lolwut.c
        src/lolwut5.c
        src/lolwut6.c
        src/acl.c
        src/gopher.c
        src/tracking.c
        src/connection.c
        src/tls.c
        src/sha256.c
        src/timeout.c
        src/setcpuaffinity.c
        src/monotonic.c
        src/mt19937-64.c
)

#external 3rd库
add_subdirectory(deps)

#3rd头文件路径
set(DEPS_HEADER_PATH ${CMAKE_CURRENT_SOURCE_DIR}/deps)
include_directories(${DEPS_HEADER_PATH}/hdr_histogram)
include_directories(${DEPS_HEADER_PATH}/hiredis)
include_directories(${DEPS_HEADER_PATH}/jemalloc/include)
include_directories(${DEPS_HEADER_PATH}/linenoise)
include_directories(${DEPS_HEADER_PATH}/lua/src)

#3rd库路径
set(DEPS_LIB_PATH ${CMAKE_CURRENT_BINARY_DIR}/deps)
link_directories(${DEPS_LIB_PATH}/hdr_histogram)
link_directories(${DEPS_LIB_PATH}/hiredis)
link_directories(${DEPS_LIB_PATH}/jemalloc)
link_directories(${DEPS_LIB_PATH}/linenoise)
link_directories(${DEPS_LIB_PATH}/lua)

add_executable(redis-server ${REDIS_SERVER_SRC})

#链接库文件
target_link_libraries(redis-server
        hiredis
        lua
        ${SYS_LIB}
)

# jemalloc三方库只在linux上用
if (LINUX)
    target_link_libraries(redis-server
            jemalloc
    )
endif ()
3.1.2 configure.sh文件

执行cmake脚本生成Makefile

shell
1
2
3
4
5
6
#!/bin/sh

cmake \
  -G "Unix Makefiles" \
  -S . \
  -B build
3.1.3 build.sh文件

执行make

shell
1
2
3
#!/bin/sh

cd build ; make
3.1.4 run.sh文件

运行redis-server可执行程序

shell
1
2
3
#!/bin/sh

cd build ; ./redis-server

3.2 deps目录

负责编译3rd_party的依赖

CMakeLists
1
2
3
4
5
6
7
8
9
10
11
add_subdirectory(hdr_histogram)
#hiredis是cmake项目
add_subdirectory(hiredis)
#cmake执行shell脚本
# jemalloc只在linux才编译
if (LINUX)
    add_subdirectory(jemalloc)
endif ()
add_subdirectory(linenoise)
add_subdirectory(lua)

3.2.1 deps/hdr_histogram
CMakeLists
1
2
3
add_library(hdr_histogram
    hdr_histogram.h hdr_histogram.c
)
3.2.2 deps/hiredis

hiredis本身就是cmake项目，因此不需要额外编写cmake脚本

3.2.3 deps/jemalloc
3.2.3.1 sh脚本
shell
1
2
3
4
#!/bin/sh

./configure --with-version=5.1.0-0-g0 --with-lg-quantum=3 --with-jemalloc-prefix=je_
make lib/libjemalloc.a
3.2.3.2 cmake脚本
CMakeLists
1
2
3
4
5
6
7
execute_process(
    COMMAND bash "${CMAKE_CURRENT_SOURCE_DIR}/build_jemalloc.sh"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

file(COPY lib/libjemalloc.a DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
file(REMOVE lib/libjemalloc.a)
3.2.4 deps/linenoise
CMakeLists
1
add_library(linenoise linenoise.c)
3.2.5 deps/lua
CMakeLists
1
2
file(GLOB LUA_SRC ./src/*.c)
add_library(lua ${LUA_SRC})
Redis
Redis-0x04-用cmake构建项目
https://bannirui.github.io/2024/04/13/Redis/Redis-0x04-用cmake构建项目/
作者
dingrui
发布于
2024年4月13日
许可协议