用途
本技能用于指导如何正确运行 make 以完成 stellar-core 的构建,并帮助理解其构建系统结构。适用于需要从源码构建 stellar-core 的开发者。
构建系统结构
构建采用递归 make 结构。lib 目录下包含多个 vendored 项目,它们使用各自的 Makefile;同时有一个主要的 src/Makefile.am 定义了大部分构建内容。
运行 make 的规则
必须遵守以下操作规范:
- 始终运行
make -j $(nproc)以获得完整并行构建。 - 始终从顶层目录运行。
- 始终使用
2>&1 | tail -N限制输出。 - 在添加文件后,始终运行
git add <somefile> && ./make-mks,以确保该文件被纳入构建。 - 禁止从子目录运行。
- 禁止对其他目录使用
make -C <somedir>。 - 禁止手动运行 cargo,应让 make 来运行它。
- 禁止编辑 Makefile 或 Makefile.in,只能编辑 Makefile.am。
主要目标
all:隐式目标,构建 src/stellar-core。check:先构建全部,然后运行单元测试和集成测试。clean:移除构建产物。format:使用标准规则自动格式化源代码。
如果构建过程中出现任何问题或令人困惑的情况,首先运行 make clean 并重试。配置时应使用 --enable-ccache,这意味着重新构建通常非常廉价,尤其是在使用 make -j $(nproc) 时。
Rust 构建
src/Makefile.am 还委托 cargo 构建 stellar-core 在 src/rust 中的 Rust 组件,以及 src/rust/soroban 中的所有子模块。这种集成相当微妙,应始终让 src/Makefile.am 负责调用 cargo。
生成文件
多个源文件是生成的:
- src/protocol-{curr,next} 中的所有 .x 文件由 lib/xdrpp 中的 xdrpp 代码生成器转换为 .cpp 和 .h 文件。
- src/util/xdrquery 中的部分 XDR 查询系统由 flex 和 bison 构建。
- 类似 src/main/StellarCoreVersion.cpp 的文件将当前版本信息烘焙为 stellar-core 中的字符串常量。
- 最后,Rust 桥接文件 src/rust/RustBridge.{cpp,h} 由 cxxbridge 工具从 src/rust/bridge.rs 生成。
编辑 makefile
大多数情况下不需要编辑 Makefile.am 或 src/Makefile.am。构建中包含的文件由脚本 ./make-mks 驱动,该脚本列出 git 跟踪的文件并基于它们定义 makefile 变量。一旦将 .cpp 或 .h 文件添加到 git 并重新运行 ./make-mks,它就会被添加到构建中。
适用场景
适用于需要从源码构建 stellar-core 的开发者,尤其是在添加新源文件、排查构建问题或理解构建系统时。
限制
资料未提供关于平台、依赖版本、收费或价格等信息。