1# 参考信息
2
3## 关于deps、external_deps的使用
4
5在添加一个模块的时候，需要在BUILD.gn中声明它的依赖，为了便于后续处理部件间依赖关系，我们将依赖分为两种——部件内依赖deps和部件间依赖external_deps。
6
7**依赖分类**
8
9![依赖关系分类](figures/dependency_classification.png)
10
11如上图所示，主要分为部件内依赖（图左）和部件间依赖（图右）。
12
13- 部件内依赖： 现有模块module1属于部件part1，要添加一个属于部件part1的模块module2，module2依赖于module1，这种情况就属于部件内依赖。
14
15- 部件间依赖： 现有模块module1属于部件part1，要添加一个模块module2，module2依赖于module1，module2属于部件part2。模块module2与模块module1分属于两个不同的部件，这种情况就属于部件间依赖。
16
17- 部件内依赖示例：
18
19  ```shell
20  import("//build/ohos.gni")
21  ohos_shared_library("module1") {
22    ……
23    part_name = "part1"   # 必选，所属部件名称
24    ……
25  }
26  ```
27
28  ```shell
29  import("//build/ohos.gni")
30  ohos_shared_library("module2") {
31    ……
32    deps = [
33      "module1的gn target",
34    ……
35   ]                        # 部件内模块依赖
36  part_name = "part1"       # 必选，所属部件名称
37  }
38  ```
39
40- 部件间依赖示例：
41
42  ```shell
43  import("//build/ohos.gni")
44  ohos_shared_library("module1") {
45    ……
46    part_name = "part1"   # 必选，所属部件名称
47    ……
48  }
49  ```
50
51  ```shell
52  import("//build/ohos.gni")
53  ohos_shared_library("module2") {
54    ……
55    external_deps = [
56      "part1:module1",
57    ……
58    ]                      # 部件间模块依赖，这里依赖的模块必须是依赖的部件声明在inner_kits中的模块
59    part_name = "part2"    # 必选，所属部件名称
60  }
61  ```
62
63  ![icon-note.gif](public_sys-resources/icon-note.gif)**注意**：部件间依赖要写在external_deps里面，格式为”部件名:模块名"的形式，并且依赖的模块必须是依赖的部件声明在inner_kits中的模块。
64
65## Sanitizer使用说明
66
67在添加模块时，可选地对该模块开启编译器提供的Sanitizer功能，包括整数溢出排错、控制流完整性检查等。配置的每一项都是可选的，如不指定默认为false或者空。Sanitizer配置示例如下所示：
68``` shell
69  ohos_shared_library("example") {
70    sanitize = {
71      cfi = true                             # 开启控制流完整性检测
72      cfi_cross_dso = true                   # 开启跨so调用的控制流完整性检测
73      integer_overflow = true                # 开启整数溢出检测
74      boundary_sanitize = true               # 开启边界检测
75      ubsan = true                           # 开启部分ubsan选项
76      all_ubsan = true                       # 开启全量ubsan选项
77      debug = true                           # 可选，调测模式，默认是不开启
78      blocklist = "./blocklist.txt"          # 可选，屏蔽名单路径
79    }
80    ...
81  }
82```
83
84**支持的Sanitizer类型**
85
86目前支持开启的Sanitizer：
87
88- 整数溢出排错：unsigned_integer_overflow/signed_integer_overflow/integer_overflow(同时包括无符号和有符号整数溢出两种检查)
89- 控制流完整性：cfi、cfi_cross_dso（跨so的cfi检查）
90- 边界检测：boundary_sanitize
91- 部分未定义行为检测：ubsan(bool,integer-divide-by-zero,return,returns-nonnull-attribute,shift-exponent,unreachable,vla-bound等编译选项)
92- 全量未定义行为检测：all_ubsan(全量undefined behavior sanitizer编译选项)
93
94**发布、调测模式**
95
96通过`debug`选项控制使用发布模式还是调测模式，默认为发布模式，使用`debug = true`显式声明开启调测模式。`debug`选项仅对Sanitizer生效，且与模块是否编译为调试版本无关，但在模块发布版本的编译配置中不应带此选项，或显式地将`debug`设置为`false`，使得Sanitizer处于发布模式。
97
98- 调测模式：用于开发时排查问题。该模式下会输出产生错误相关的丰富信息来辅助定位错误，并且在发生错误后并不会直接中断程序运行，而是会恢复程序运行进一步识别后续的错误。
99
100- 发布模式：保护程序不发生错误或被恶意攻击，在产生错误后直接中断程序不会继续执行。
101
102
103**屏蔽名单**
104
105指定该模块中不受Sanitizer选项影响的函数或源程序文件名单，用于避免良性行为被识别为错误、热点函数产生了不合理、不可接受的开销；该名单需谨慎使用。名单示例如下所示：
106```
107[cfi]
108fun:*([Tt]est|TEST)*
109fun: main
110
111[integer]
112src:example/*.cpp
113```
114
115
116## 开源软件Notice收集策略说明
117
118开源软件Notice是与项目开源相关的文件，收集这些文件的目的是为了符合开源的规范。
119
120**收集目标**
121
122只收集打包到镜像里面的模块对应的License；不打包的都不收集，比如构建过程使用的工具（如clang、python、ninja等）都是不收集的。
123
124静态库本身是不会被打包的，一般是作为动态库或者可执行程序的一部分被打包到系统中的，为了确保完备，静态库的都会收集。
125
126最终合并的NOTICE.txt要体现出镜像中每个文件都是用了哪些License，模块和License要有对应关系。
127
128最终合并的NOTICE.txt文件在/system/etc/ 目录下。
129
130**收集规则**
131
132按照优先级收集License，以下由1到4，优先级依次降低。
133
1341. 模块在BUILD.gn中直接声明自己使用的License文件，优先级最高。如下示例：
135
136   ```shell
137   ohos_shared_library("example") {
138       ...
139       license_file = "path-to-license-file"
140       ...
141   }
142   ```
143
1442. 如果模块没有显式声明，那么编译脚本会在BUILD.gn所在的当前目录中查找Readme.OpenSource文件，解析该文件，找出该文件中声明的license，将其作为模块的License。 如果Readme.OpenSource文件中配置的license文件不存在，直接报错。
145
1463. 如果Readme.OpenSource文件不存在，编译脚本会从当前目录开始，向上层目录寻找（一直找到源码的根目录），默认查找License、Copyright、Notice三个文件，如果找到，则将其作为模块的License。
147
1484. 如果上面三种方式都未找到license，则使用默认的license作为该模块的license；默认license是Apache2.0 License。
149
150需要注意及检查的问题
151
152- 三方的开源软件，比如openssl，icu等，这部分软件基本上在源码目录下都要求配置Readme.OpenSource，要检查Readme.OpenSource文件是否和BUILD.gn文件在同一个目录，以及Readme.OpenSource文件中配置的License文件是否存在以及真实有效。
153- 代码目录下，如果代码使用的不是Apache2.0 License，需要在目录下提供对应的License文件，或者直接在模块中指定license_file。
154- 如果BUILD.gn中添加的源码文件不是当前目录的，需要检查下源码文件所在仓下的license是否和BUILD.gn文件所在仓的一致。
155
156## 加快本地编译的一些参数
157
158编译时，适当选择添加以下的编译参数可以加快编译的过程。
159
160- **添加--ccache参数**:
161  - 原理：ccache会缓存c/c++编译的编译输出，下一次在编译输入不变的情况下，直接复用缓存的产物。
162  - 安装：
163    - 快速安装：执行sudo apt-get install ccache命令。
164    - [官网下载](https://ccache.dev/download.html)，下载二进制文件，把ccache所在路径配置到环境变量。
165  - 使用：执行./build.sh --product-name 产品名 --ccache命令。
166- **添加--fast-rebuild参数**
167  - 原理：编译流程主要分为：preloader->loader->gn->ninja这四个过程，在本地没有修改gn和产品配置相关文件的前提下，添加--fast-rebuild会让你直接从ninja编译开始。
168  - 使用：执行./build.sh --product-name 产品名 --fast-rebuild命令。
169- **添加enable_notice_collection=false参数**
170  - 原理：省略掉收集开源软件模块的license的过程。
171  - 使用：执行./build.sh --product-name 产品名 --gn-args --enable_notice_collection=false --ccache命令。
172- **添加--build-target参数**
173  - 该参数用于指定编译模块，如何找模块的名字：
174    - 相关仓下BUILD.gn中关注group、ohos_shared_library、ohos_executable等关键字。
175    - ./build.sh --product-name 产品名 --build-target 模块名 --build-only-gn生成build.ninja，然后去该文件中查找相关模块名。
176  - 使用：执行./build.sh --product-name 产品名 --build-target ark_js_host_linux_tools_packages命令。
177
178## 查看NinjaTrace
179
180out/rk3568/.ninja_log文件记录了每个模块编译的开始和结束时间(ms)，结束时间和开始时间间隔越短表示模块的编译时间越短，编译性能越高。
181
182从左到右分别表示：start time|end time|mtime|command hash。
183
184![Ninja_Trace](figures/Ninja_Trace.png)
185
186图形化显示编译时间。
187
188- 本地打开ninja trace：
189  解压out/rk3568/build.trace.gz，将build.trace拖到chrome的trace链接chrome://tracing/打开即可。
190- 在CI网站ci.openharmony.cn/events上打开ninja trace：
191  CI上每个编译的输出里面有build.trace.html可直接打开，具体方法是：
192  1. 点击静态检查下的“成功”；
193
194  2. 点击输出列的“输出”即可在左侧的build_trace列看到build.trace.html文件，单击该文件即可打开。
195
196## 定制打包chip_prod镜像使用说明
197
198### 背景
199
200针对同一个芯片解决方案下的子产品的定制能力，将差异能力放到 chip_prod 分区，因此需要支持对不同子产品生成对应的 chip_prod.img。
201
202### 使用步骤
2031. 产品解决方案配置：<br>
204   产品解决方案配置文件config.json中添加`"chipprod_config_path"`配置选项，即`"chipprod_config_path":"子产品定义文件所在的路径"`。
205   其中子产品定义文件的文件名为`chip_product_list.gni`，文件格式为：`chip_product_list = ["productA", "productB", ...]` 。<br>
206   示例：<br>
207   以MyProduct产品定制chipprod镜像为例，//vendor/产品厂商/MyProduct/config.json配置如下：
208   ```shell
209   {
210        "product_name": "MyProduct",                                 # 产品名称
211        "version": "3.0",                                            # config.json的版本号, 固定"3.0"
212        "chipprod_config_path": "",                                  # 存放chipprod配置文件路径，可选项
213	"subsystems": [
214          {
215            "subsystem": "arkui",                                    # 选择的子系统
216            "components": [
217              {
218                  "component": "ace_engine",
219                  "features":[ "ace_engine_feature_enable_web = true",
220                    "ace_engine_feature_enable_accessibility = true" ] }
221            ]
222          },
223          {
224           ......
225          }
226         ......
227         更多子系统和部件
228        }
229   }
230   ```
231
2322. 模块编译配置：<br>
233   某个配置文件在不同的子产品中有差异，比如要打包到productA对应的chip_prod.img中，则模块编译需要配置`install_images`和`module_install_dir`。<br>
234   以`ohos_prebuilt_executable`示例：
235   ```shell
236   ohos_prebuilt_executable("moduleXXX"){
237	install_images = [ "chip_prod" ]
238	module_install_dir = "productA/etc/***"     # module_install_dir指定的路径需要以productA开始。
239   }
240   ```
241
2423.编译命令
243```shell
244./build.sh --product-name {product_name} --build-target chip_prod_image
245```
246
2474. 打包结果:<br>
248   如果定义了子产品productA和productB，即`chip_product_list = ["productA", "productB"],`并且有模块安装到了该产品下，则打包后镜像输出路径如下：
249   ```
250   images/productA/chip_prod.img
251   images/productB/chip_prod.img
252   ```