nginx-0x01-cmake编译

Q 为什么要用cmake构建项目

A Clion对make项目支持很不友好，没法在阅读源码时丝滑跳转，即使用compiledb辅助也不尽如人意，最好的方式就是用把项目变成cmake项目

1 cmake脚本

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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
cmake_minimum_required(VERSION 3.30)
project(nginx LANGUAGES C CXX)

set(CMAKE_C_STANDARD 99)
set(CMAKE_CXX_STANDARD 11)

set(NGX_PLATFORM "" CACHE STRING "NGX platform to build for")

include(CheckCSourceCompiles)
include(CheckCSourceRuns)
include(CheckTypeSize)
include(TestBigEndian)

# nginx配置文件所在目录 /usr/local/conf
get_filename_component(NGX_CONF_PREFIX "${NGX_CONF_PATH}" DIRECTORY)

# 模板生成文件
configure_file(ngx_auto_headers.h.in ${CMAKE_CURRENT_BINARY_DIR}/ngx_auto_headers.h)
configure_file(ngx_auto_config.h.in ${CMAKE_CURRENT_BINARY_DIR}/ngx_auto_config.h)
configure_file(ngx_modules.c.in ${CMAKE_CURRENT_BINARY_DIR}/ngx_modules.c)

# core源码
set(CORE_SRCS
        src/core/nginx.c
        src/core/ngx_log.c
        src/core/ngx_palloc.c
        src/core/ngx_array.c
        src/core/ngx_list.c
        src/core/ngx_hash.c
        src/core/ngx_buf.c
        src/core/ngx_queue.c
        src/core/ngx_output_chain.c
        src/core/ngx_string.c
        src/core/ngx_parse.c
        src/core/ngx_parse_time.c
        src/core/ngx_inet.c
        src/core/ngx_file.c
        src/core/ngx_crc32.c
        src/core/ngx_murmurhash.c
        src/core/ngx_md5.c
        src/core/ngx_sha1.c
        src/core/ngx_rbtree.c
        src/core/ngx_radix_tree.c
        src/core/ngx_slab.c
        src/core/ngx_times.c
        src/core/ngx_shmtx.c
        src/core/ngx_connection.c
        src/core/ngx_cycle.c
        src/core/ngx_spinlock.c
        src/core/ngx_rwlock.c
        src/core/ngx_cpuinfo.c
        src/core/ngx_conf_file.c
        src/core/ngx_module.c
        src/core/ngx_resolver.c
        src/core/ngx_open_file_cache.c
        src/core/ngx_crypt.c
        src/core/ngx_proxy_protocol.c
        src/core/ngx_syslog.c
        src/core/ngx_regex.c
)

# event源码
set(EVENT_SRCS
        src/event/ngx_event.c
        src/event/ngx_event_timer.c
        src/event/ngx_event_posted.c
        src/event/ngx_event_accept.c
        src/event/ngx_event_udp.c
        src/event/ngx_event_connect.c
        src/event/ngx_event_pipe.c
)

# kq源码
set(KQ_SRCS src/event/modules/ngx_kqueue_module.c)

# unix系统
set(UNIX_SRCS
        src/os/unix/ngx_time.c
        src/os/unix/ngx_errno.c
        src/os/unix/ngx_alloc.c
        src/os/unix/ngx_files.c
        src/os/unix/ngx_socket.c
        src/os/unix/ngx_recv.c
        src/os/unix/ngx_readv_chain.c
        src/os/unix/ngx_udp_recv.c
        src/os/unix/ngx_send.c
        src/os/unix/ngx_writev_chain.c
        src/os/unix/ngx_udp_send.c
        src/os/unix/ngx_udp_sendmsg_chain.c
        src/os/unix/ngx_channel.c
        src/os/unix/ngx_shmem.c
        src/os/unix/ngx_process.c
        src/os/unix/ngx_daemon.c
        src/os/unix/ngx_setaffinity.c
        src/os/unix/ngx_setproctitle.c
        src/os/unix/ngx_posix_init.c
        src/os/unix/ngx_user.c
        src/os/unix/ngx_dlopen.c
        src/os/unix/ngx_process_cycle.c
        src/os/unix/ngx_darwin_init.c
        src/os/unix/ngx_darwin_sendfile_chain.c
)

# mac系统
set(MAC_SRCS
        ${CORE_SRCS}
        ${EVENT_SRCS}
        ${UNIX_SRCS}
        ${KQ_SRCS}
)

# 模版文件源码
set(NGX_MODULE_SRCS ${CMAKE_BINARY_DIR}/ngx_modules.c)

# http模块源码
set(HTTP_SRCS
        src/http/ngx_http.c
        src/http/ngx_http_core_module.c
        src/http/ngx_http_special_response.c
        src/http/ngx_http_request.c
        src/http/ngx_http_parse.c
        src/http/modules/ngx_http_log_module.c
        src/http/ngx_http_request_body.c
        src/http/ngx_http_variables.c
        src/http/ngx_http_script.c
        src/http/ngx_http_upstream.c
        src/http/ngx_http_upstream_round_robin.c
        src/http/ngx_http_file_cache.c
        src/http/ngx_http_write_filter_module.c
        src/http/ngx_http_header_filter_module.c
        src/http/modules/ngx_http_chunked_filter_module.c
        src/http/modules/ngx_http_range_filter_module.c
        src/http/modules/ngx_http_gzip_filter_module.c
        src/http/ngx_http_postpone_filter_module.c
        src/http/modules/ngx_http_ssi_filter_module.c
        src/http/modules/ngx_http_charset_filter_module.c
        src/http/modules/ngx_http_userid_filter_module.c
        src/http/modules/ngx_http_headers_filter_module.c
        src/http/ngx_http_copy_filter_module.c
        src/http/modules/ngx_http_not_modified_filter_module.c
        src/http/modules/ngx_http_static_module.c
        src/http/modules/ngx_http_autoindex_module.c
        src/http/modules/ngx_http_index_module.c
        src/http/modules/ngx_http_mirror_module.c
        src/http/modules/ngx_http_try_files_module.c
        src/http/modules/ngx_http_auth_basic_module.c
        src/http/modules/ngx_http_access_module.c
        src/http/modules/ngx_http_limit_conn_module.c
        src/http/modules/ngx_http_limit_req_module.c
        src/http/modules/ngx_http_geo_module.c
        src/http/modules/ngx_http_map_module.c
        src/http/modules/ngx_http_split_clients_module.c
        src/http/modules/ngx_http_referer_module.c
        src/http/modules/ngx_http_rewrite_module.c
        src/http/modules/ngx_http_proxy_module.c
        src/http/modules/ngx_http_fastcgi_module.c
        src/http/modules/ngx_http_uwsgi_module.c
        src/http/modules/ngx_http_scgi_module.c
        src/http/modules/ngx_http_memcached_module.c
        src/http/modules/ngx_http_empty_gif_module.c
        src/http/modules/ngx_http_browser_module.c
        src/http/modules/ngx_http_upstream_hash_module.c
        src/http/modules/ngx_http_upstream_ip_hash_module.c
        src/http/modules/ngx_http_upstream_least_conn_module.c
        src/http/modules/ngx_http_upstream_random_module.c
        src/http/modules/ngx_http_upstream_keepalive_module.c
        src/http/modules/ngx_http_upstream_zone_module.c
)

if (NGX_PLATFORM STREQUAL "")
    execute_process(COMMAND uname -s
            OUTPUT_VARIABLE NGX_SYSTEM
            ERROR_QUIET
            OUTPUT_STRIP_TRAILING_WHITESPACE)
    execute_process(COMMAND uname -r
            OUTPUT_VARIABLE NGX_RELEASE
            ERROR_QUIET
            OUTPUT_STRIP_TRAILING_WHITESPACE)
    execute_process(COMMAND uname -s
            OUTPUT_VARIABLE NGX_MACHINE
            ERROR_QUIET
            OUTPUT_STRIP_TRAILING_WHITESPACE)
    set(NGX_PLATFORM "${NGX_SYSTEM}:${NGX_RELEASE}:${NGX_MACHINE}")
endif ()
message(STATUS "ngx: checking for OS, building for ${NGX_PLATFORM}")

# 指定宏
add_definitions(-D_GNU_SOURCE -D_FILE_OFFSET_BITS=64)
set(CMAKE_REQUIRED_DEFINITIONS "-D_GNU_SOURCE -D_FILE_OFFSET_BITS=64")

# cpu架构arm64
set(NGX_CPU_CACHE_LINE 64)

TEST_BIG_ENDIAN(SYSTEM_IS_BIG_ENDIAN)

# 启用pkg-config模块
find_package(PkgConfig REQUIRED)
# pkg检测库
list(APPEND REQ_LIB_LIST libpcre zlib)
message(STATUS "要链接的库 ${REQ_LIB_LIST}")
# 依赖的库别名REQ
pkg_check_modules(REQ REQUIRED ${REQ_LIB_LIST})
# 所有依赖库的头文件路径
message(STATUS "链接库的头文件路径 ${REQ_INCLUDE_DIRS}")
include_directories(${REQ_INCLUDE_DIRS})
# 所有依赖库的库文件路径
message(STATUS "链接库的路径 ${REQ_LIBRARY_DIRS}")
link_directories(${REQ_LIBRARY_DIRS})

# 编译参数
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-unused-parameter")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unused-parameter")

# 头文件路径
include_directories(src/core)
include_directories(src/event)
include_directories(src/event/modules)
include_directories(src/event/quic)
include_directories(src/os/unix)
include_directories(src/http)
include_directories(src/http/modules)
# 模板文件
include_directories(${CMAKE_CURRENT_BINARY_DIR})
include_directories(/opt/homebrew/include)
include_directories(/Users/dingrui/MyApp/zlib/zlib-1.3.1)

# 编译可执行文件nginx
add_executable(${PROJECT_NAME}
        ${MAC_SRCS}
        ${NGX_MODULE_SRCS}
        ${HTTP_SRCS}
)

# 链接库
message(STATUS "链接库 ${REQ_LIBRARIES}")
target_link_libraries(${PROJECT_NAME}
        ${REQ_LIBRARIES}
)

# 安装路径 /usr/local
# 安装可执行文件
set(NGX_DIR "${CMAKE_INSTALL_PREFIX}/nginx" CACHE STRING "")
set(NGX_BIN_DIR "${CMAKE_INSTALL_PREFIX}/nginx/sbin" CACHE STRING "")
# nginx的配置文件
set(NGX_CONF_DIR "${CMAKE_INSTALL_PREFIX}/nginx/conf" CACHE STRING "")
# 日志目录
set(NGX_LOG_DIR "${CMAKE_INSTALL_PREFIX}/nginx/logs" CACHE STRING "")
# 可执行程序
install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION ${NGX_BIN_DIR})
# 默认服务
install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/docs/html" DESTINATION ${NGX_BIN_DIR})
# 配置文件
install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/conf" DESTINATION ${NGX_DIR})
# 日志目录
install(DIRECTORY DESTINATION ${NGX_LOG_DIR})
TXT

2 运行

不需要更改配置文件，使用默认端口，先检查80端口占用情况sudo lsof -i:80，被占用就先sudo kill -9 ${port}

1
sudo ./build/nginx
SH
nginx
nginx-0x01-cmake编译
https://bannirui.github.io/2025/02/26/nginx/nginx-0x01-cmake编译/
作者
dingrui
发布于
2025年2月26日
许可协议