SuperAPI AI 工具集

configuring-the-build

编程与开发

查看项目

更新于 10-16 06:39

技能介绍

本技能说明如何修改 stellar-core 的构建配置,以启用或禁用构建变体、切换编译器或编译标志,或为构建做其他准备。

构建流程

构建从运行 ./autogen.sh 开始。autogen.sh 会运行 autoconf,将 configure.ac 转换为 configure;同时运行 automake,将 Makefile.am 转换为 Makefile.in,将 src/Makefile.am 转换为 src/Makefile.in。随后运行 ./configure,将 Makefile.in 转换为 Makefile,将 src/Makefile.in 转换为 src/Makefile;configure 还会将 config.h.in 转换为包含一些变量的 config.h,并写入 config.log,如果出现错误,错误信息会记录在其中。

必须始终从顶层目录运行 ./autogen.sh 和 ./configure,绝不要从子目录运行。必须始终使用 --enable-ccache 进行配置以启用缓存。必须始终使用 --enable-sdfprefs 进行配置以抑制嘈杂的构建输出。绝不要直接编辑 configure,只能编辑 configure.ac。绝不要直接编辑 Makefile 或 Makefile.in,只能编辑 Makefile.am。要更改配置设置,请使用新标志重新运行 ./configure。可以通过查看 config.log 的开头来了解现有配置标志。

配置变量

要将编译器从 clang 切换为 gcc,请更改传递给 CC 和 CXX 的值。例如运行 CXX=g++ CC=gcc ./configure ... 以使用 gcc 进行配置。构建应始终能在 gcc 和 clang 下工作。

要更改编译标志(例如打开或关闭优化,或调试信息),请更改 CXXFLAGS。例如运行 CXXFLAGS='-O0 -g' ./configure ... 以构建非优化且带调试信息的版本。通常不需要更改这些。

有时需要切换到 C++ 标准库的不同实现。为此,请在 CXXFLAGS 中显式传递 -stdlib=libc++ 或 -stdlib=libstdc++。但同样,通常不需要这样做。

配置标志

以下是一些可能想要更改的常见配置标志:

--disable-tests 关闭 BUILD_TESTS,从而从 core 中排除单元测试和所有测试支持基础设施。我们希望此构建变体能够工作,因为它是我们发布的版本,但在开发中不常见。

--disable-postgres 关闭 core 中的 postgresql 后端支持,仅保留 sqlite。测试运行更快,这也是我们希望其工作的配置(我们将来会完全移除 postgres)。

还有一些标志用于为不同类型的测试打开编译时插桩。如果进行特定诊断测试,和/或检查“是否有任何东西意外损坏”,请打开这些标志。如果打开其中任何一个,将需要进行干净构建——目标文件的内容会不正确。

--enable-asan 打开地址消毒器。

--enable-threadsanitizer 同上,但用于线程消毒器。

--enable-memcheck 同上,但用于 memcheck。

--enable-undefinedcheck 同上,但用于未定义行为消毒器。

--enable-extrachecks 打开 C++ 标准库调试,会减慢速度。

--enable-fuzz 使用模糊测试插桩构建 core,并包含模糊测试目标。

通过直接阅读 configure.ac 可以了解更多,但上述说明应足以应对 99% 的任务。尽量不要对配置做过于奇怪的操作。

如有疑问,或遇到卡住的情况,可以随时重新运行 ./autogen.sh 和 ./configure。