在MacOSX上使用VSCode 查阅、调试NGINX代码

原文作者：宗兆伟
原文链接：在MacOSX上使用VSCode 查阅、调试NGINX代码 - NGINX开源社区
转载来源：NGINX开源社区

NGINX是一款十分流行的开源软件，代码量有17万行。如何从代码学习、研读它成为一个很挑战的问题。如果能够凭借VSCode等调试工具的能力边调试跟踪边学习，效率和效果要好很多。

网上关于用GCC、GDB去编译调试NGINX代码的文章有很多。但是实际配置起来会出现各种各样的问题。

这里经过实际验证把验证的过程总结下来，希望对大家有帮助。

编译器的选择

我们先了解下 gcc 与 clang llvm 的关系:

gcc和clang 都是编译器。
gcc诞生于GNU，clang和苹果关系更密切一些。
clang 是 llvm的前端，他们共同组成了macOSX上编译套件。

我们不建议使用GCC、GDB在macosx上调试NGINX，而建议使用在macOSX上兼容性更好的的编译套件，

MacOSX上使用GDB还会出现以下问题：

Unable to find Mach task port for process-id 57304: (os/kern) failure (0x5).
 (please check gdb is codesigned - see taskgated(8))

如果想彻底解决这个问题，尝试此方法。

使用clang 编译调试NGINX

下载NGINX 源码

自行下载

安装编译环境及依赖

clang llvm lldb: brew install --with-clang llvm

lldb 和 clang 已经包含在llvm的安装中。

本文章描述的搭建过程使用的版本为：

[zong@BEI-ML-00005205 nginx-codes-learning]$ clang -v
Apple LLVM version 10.0.1 (clang-1001.0.46.4)
Target: x86_64-apple-darwin18.7.0
Thread model: posix
InstalledDir: /Library/Developer/CommandLineTools/usr/bin
[zong@BEI-ML-00005205 nginx-codes-learning]$ lldb -v
lldb-1001.0.13.3
  Swift-5.0

pcre zlib openssl: brew install xx

使用brew search 可以查找是否存在相关的依赖包。

使用brew install 安装相应的依赖包。

编译NGINX源码

编译NGINX的过程封装：GitHub - zongzw-nginx/vscode-nginx

build-cc.sh中使用intercept-build 作为编译工具，而不是用make 或者 bear make，是因为在OSX上对特定目录下的可以执行文件做了限制，具体可以参考：

GitHub - rizsotto/Bear: Bear is a tool that generates a compilation database for clang tooling.

Security extension/modes on different operating systems might disable library preloads. In this case Bear behaves normally, but the result compilation database will be empty. (Please make sure it's not the case when reporting bugs.) Notable examples for enabled security modes are: OS X 10.11 (check with csrutil status | grep 'System Integrity Protection'), and Fedora, CentOS, RHEL (check with sestatus | grep 'SELinux status').

因此，我们使用scan-build 这个编译器的wrapper: GitHub - rizsotto/scan-build: Clang's scan-build re-implementation in python

使用scan-build的model 1即可：

Use compiler wrappers to make actions. The compiler wrappers does run the real compiler and the analyzer. This is the default behaviour, can be enforced with --override-compiler flag.
intercept-build --override-compiler make CC=intercept-cc CXX=intercept-c++ all

顺便可以生成compile_commands.json