更新 src/compile/sharebuild.md

2025-12-04 06:05:48 +00:00
parent c3fc09ece7
commit dcd05056db
1 changed files with 64 additions and 79 deletions
--- a/src/compile/sharebuild.md
+++ b/src/compile/sharebuild.md
@@ -1,79 +1,64 @@
-# 分布式编译系统ShareBuild
+# ShareBuild分布式共享编译工作站
-![alt text](/public/compile/promotional-graphic-cloudbuild.jpg)
+
-##  为什么需要分布式编译？
+##  ShareBuild的适用场景
- 大型项目过长的编译耗时将会给开发、测试和调试都带来延迟，所以缩短大型项目的编译时间的分布式编译系统有重要意义
+
- 使用分布式编译系统编译项目可以利用计算机集群提高编译效率，缩短项目编译时间
+在同一局域网内工作的小型团队，ShareBuild以P2P共享架构将空闲算力贡献给团队其他成员，从而为每个团队成员提供编译加速效果。
- 在实际开发时，同一个团队大量的编译任务时相同的。CloudBuild提供的编译缓存可以避免重复上传和重复编译，从而进一步加快编译效率
+
-
+## ShareBuild QuickStart
-## 总体架构
+
-### 系统总体架构
+* 同一个局域网内的A、B、C等所有节点上安装ninja2:
-![alt text](/public/compile/architecture.png)
+
- Ninja：客户端，该机器上需要保存有完整的待编译项目源代码。
+```
- Action Cache：服务端缓存，主要保存编译任务的执行结果。
+wget -c https://raw.githubusercontent.com/ninja-cloudbuild/ninja2/refs/heads/main/install.sh && chmod +x install.sh && sudo ./install.sh
- CAS Cache：服务端缓存，主要保存客户端上传的依赖文件，编译结果文件。
+```
- Scheduler：任务调度器，将编译任务id分发到各个编译节点。
+
- Redis：主要存储具体的编译任务供编译节点领取执行，也可存储Action Cache和 CAS Cache中的内容加速编译。
+* 启用ShareBuild的前置要求（二选一即可）
- MySQL：主要存储编译过程中的任务统计信息。
+
- Executor：各个编译节点
+ 1. 所有节点上均安装配置好了项目的编译环境，即所有节点上均能采用ninja成功单机编译项目。
-
+ 2. 选择任一节点上作为项目开发环境，项目中使用.devcontainer/devcontainer.json 配置了image镜像（示例如下），依次镜像创建的开发容器中能采用ninja成功单机编译项目。
-### 部署示意图
+
-![alt text](/public/compile/system-diagram.png)
+```
-CloudBuild主程序分为三个部分：Client、Server、Executor。
+ {
- Client：运行在客户端，和用户对接，用于生成待执行的远程编译任务， 同时也作为本地编译节点执行本地任务。
+  "name": "DevContainer",
- Server：运行在主服务器，主要用于连接各个编译节点，以及 将客户端上传的编译任务调度到与其连接的各个编译节点上。
+  "image": "devstar.cn/devstar/DevContainer:latest" # 仅作示例，务必使用您已安装配置好项目编译环境的容器镜像！
- Executor：运行在编译节点，负责接收并执行编译任务，是编译任务真正执行的地方。
+ }
-
+```
-### 系统分层结构
+
-![alt text](/public/compile/layered-system-architecture.png)
+* 选择任一节点上作为项目开发环境，开启ShareBuild模式，然后进行分布式编译。
-
+
-## 运行原理与流程
+项目根目录下创建ninja2.conf 文件如下即可开启ShareBuild模式：
-
+```
-### 分布式编译原理
+sharebuid:true
-![alt text](/public/compile/compiler-principles.png)
+```
-
+这时使用ninja编译将自动进入ShareBuild模式分布式编译项目。
-### CloudBuild客户端
+
-CloudBuild客户端基于Ninja改造，有下面这些优势
+> 如果直接使用ninja命令编译项目，也可以加上-s参数表示启用ShareBuild模式，示例如下：
- 兼容使用Ninja编译的项目
+```
- 使用远程执行的方式提高编译时并发度
+ninja -s -r `realpath ../`            #启动分布式编译，注意-r 指定项目根目录
- 使用编译缓存减少需要编译的任务数量
+ninja -t clean                        #清除编译产物
-
+````
-### CloudBuild服务端
+
- 使用远程执行的方法提高编译时并发度，实现了任务分发至远程节点同步执行
+* 对一些特殊项目的补充说明
- 使用分布式任务调度提高任务调度效率和计算节点资源利用率，避免集中式调度的任务阻塞问题
+
- 使用编译缓存结合内容寻址存储技术减少网络传输量、避免重复上传与重复编译
+除以上常规的ShareBuild配置外，对于一些特殊项目需要做一些额外的配置，补充说明如下：
-
+
-### CloudBuild优势
+## 使用ShareBuild编译Android开源项目（AOSP）
- 低成本：组成executor的机器不需要使用专门的高性能计算型机器，可使用多个平价的空闲机器
+
- 高效：CloudBuild实现分布式编译的功能，相比单机大大提升并发度
+除按照以上方法准备好编译环境和开启ShareBuild模式外，以AOSP14项目为例，还需要替换ninja和准备.sharebuild.yml来过滤掉一些无法远程编译的命令，具体操作如下：
- 兼容Ninja：CloudBuild客户端基于Ninja改造，对于使用Ninja构建和可以转换为Ninja构建的项目不用额外修改构建清单
+
-
+```
-### CloudBuild执行流程
+cp /usr/bin/android_ninja prebuilts/build-tools/linux-x86/bin/ninja
- 客户端: 生成远程任务->生成任务依赖->发送任务与依赖
+cp /etc/ninja2/aosp14/.sharebuild.yml ./
- 服务端：检查任务缓存->检查依赖完整性->调度任务
+```
- 编译结点：还原文件目录->还原文件目录->返回编译结果
+
-
+然后就可以单机编译一样使用make命令来分布式编译Android开源项目（AOSP）。
-## AOSP和LLVM上的应用
+
-### LLVM上的应用效果
+## 使用ShareBuild编译鸿蒙开源项目（OpenHarmony）
-![alt text](/public/compile/table1.png)
+
-### AOSP上的应用效果
+todo
-![alt text](/public/compile/table2.png)
+
-### CloudBuild硬件资源利用率
+## 版权声明
-4核CPU利用率:
+
-![alt text](/public/compile/CPU-utilization-4.png)
+Copyright @ Mengning Software
-8核CPU利用率:
+
-![alt text](/public/compile/CPU-utilization-8.png)
+梦宁软件（江苏）有限公司 版权所有
 16核CPU利用率:
 ![alt text](/public/compile/CPU-utilization-16.png)
 ## CloudBuild使用方法
 ### CloudBuild安装
 ![alt text](/public/compile/cloudbuild-installation.png)
 CloudBuild项目地址：https://gitee.com/cloudbuild888/cloudbuild.git
 ### CloudBuild分布式编译
 ![alt text](/public/compile/cloudbuild-distributed-compilation.png)
 LLVM项目地址：https://gitee.com/mirrors/LLVM.git