1# 标准系统编译构建指导<a name="ZH-CN_TOPIC_0000001076490572"></a> 2 3- [概述](#section17466112012244) 4 - [基本概念](#section445513507246) 5 - [运作机制](#section12541217142510) 6 - [约束与限制](#section886933762513) 7 8- [编译构建使用指导](#section16901215262) 9 - [目录结构](#section109065332264) 10 - [编译命令](#section123265539266) 11 - [开发步骤](#section591084422719) 12 13 14## 概述<a name="section17466112012244"></a> 15 16编译构建子系统提供了一个基于gn和ninja的编译构建框架。主要提供以下功能： 17 18- 构建不同芯片平台的产品。如：Hi3516DV300平台。 19 20- 根据产品配置，按照组件组装打包产品需要的能力。 21 22### 基本概念<a name="section445513507246"></a> 23 24在了解编译构建子系统的能力前，应了解如下基本概念： 25 26- 平台 27 28 开发板和内核的组合，不同平台支持的子系统和组件不同。 29 30- 子系统 31 32 OpenHarmony整体遵从分层设计，从下向上依次为：内核层、系统服务层、框架层和应用层。系统功能按照“系统 \> 子系统 \> 组件”逐级展开，在多设备部署场景下，支持根据实际需求裁剪某些非必要的子系统或组件。子系统是一个逻辑概念，它具体由对应的组件构成。 33 34- 组件 35 36 对子系统的进一步拆分，可复用的软件单元，它包含源码、配置文件、资源文件和编译脚本；能独立构建，以二进制方式集成，具备独立验证能力的二进制单元。 37 38- gn 39 40 Generate ninja的缩写，用于产生ninja文件。 41 42- ninja 43 44 ninja是一个专注于速度的小型构建系统。 45 46 47### 运作机制<a name="section12541217142510"></a> 48 49OpenHarmony侧的编译构建流程主要包括编译命令行解析，调用gn，执行ninja： 50 51- 命令行解析：解析待编译的产品名称，加载相关配置。 52- 调用gn: 根据命令行解析的产品名称和编译类型，配置编译工具链和全局的编译选项。 53- 执行ninja：启动编译并生成对应的产品版本。 54 55### 约束与限制<a name="section886933762513"></a> 56 57- 需按照[源码获取](../get-code/sourcecode-acquire.md)指导下载全量源码（采用方式三获取）。 58- 编译环境需要Ubuntu18.04及以上版本。 59- 安装编译所需的程序包。 60 61 安装命令： 62 63 ``` 64 sudo apt-get install binutils git-core gnupg flex bison gperf build-essential zip curl zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 lib32ncurses5-dev x11proto-core-dev libx11-dev lib32z-dev ccache libgl1-mesa-dev libxml2-utils xsltproc unzip m4 65 ``` 66 67 68## 编译构建使用指导<a name="section16901215262"></a> 69 70### 目录结构<a name="section109065332264"></a> 71 72``` 73/build # 编译构建主目录 74├── config # 编译相关的配置项 75├── core 76│ └── gn # 编译入口BUILD.gn配置 77├── loader # 各个组件配置加载、模板生成 78├── ohos # OpenHarmony编译打包流程配置 79│ ├── kits # kits编译打包模板和处理流程 80│ ├── ndk # ndk模板和处理流程 81│ ├── notice # notice模板和处理流程 82│ ├── packages # 版本打包模板和处理流程 83│ ├── sa_profile # sa模板和处理流程 84│ ├── sdk # sdk模板和处理流程，包括sdk中包含的模块配置 85│ └── testfwk # 测试相关的处理 86├── scripts # 编译相关的python脚本 87├── templates # c/c++编译模板定义 88└── toolchain # 编译工具链配置 89``` 90 91### 编译命令<a name="section123265539266"></a> 92 93- 代码根目录下执行全量版本的编译命令： 94 95 ``` 96 ./build.sh --product-name {product_name} 97 ``` 98 99 \{product\_name\}为当前版本支持的平台。比如：Hi3516DV300等。 100 101 编译完成后，结果镜像保存在 out/{device_name}/packages/phone/images/ 目录下。 102 103- 编译命令支持选项： 104 105 ``` 106 --product-name # 必须 编译的产品名称，如：Hi3516DV300 107 --build-target # 可选 指定编译目标，可以指定多个 108 --gn-args # 可选 gn参数，支持指定多个 109 --ccache # 可选 编译使用ccache，需要本地安装ccache 110 ``` 111 112 113### 开发步骤<a name="section591084422719"></a> 114 1151. 添加组件。 116 117 本节以添加一个自定义的组件为例，描述如何编译组件，编译库、编译可执行文件等。 118 119 示例组件partA由feature1、feature2和feature3组成，feature1的编译目标为一个动态库，feature2的目标为一个可执行程序，feature3的目标为一个etc配置文件。 120 121 示例组件partA的配置需要添加到一个子系统中，本次示例将添加到subsystem\_examples子系统中（subsystem\_examples子系统定义在test/examples/目录）。 122 123 示例组件partA的完整目录结构如下： 124 125 ``` 126 test/examples/partA 127 ├── feature1 128 │ ├── BUILD.gn 129 │ ├── include 130 │ │ └── helloworld1.h 131 │ └── src 132 │ └── helloworld1.cpp 133 ├── feature2 134 │ ├── BUILD.gn 135 │ ├── include 136 │ │ └── helloworld2.h 137 │ └── src 138 │ └── helloworld2.cpp 139 └── feature3 140 ├── BUILD.gn 141 └── src 142 └── config.conf 143 ``` 144 145 示例1：编写动态库gn脚本test/examples/partA/feature1/BUILD.gn，示例如下： 146 147 ``` 148 config("helloworld_lib_config") { 149 include_dirs = [ "include" ] 150 } 151 152 ohos_shared_library("helloworld_lib") { 153 sources = [ 154 "include/helloworld1.h", 155 "src/helloworld1.cpp", 156 ] 157 public_configs = [ ":helloworld_lib_config" ] 158 part_name = "partA" 159 } 160 ``` 161 162 示例2：编写可执行文件gn脚本test/examples/partA/feature2/BUILD.gn，示例如下： 163 164 ``` 165 ohos_executable("helloworld_bin") { 166 sources = [ 167 "src/helloworld2.cpp" 168 ] 169 include_dirs = [ "include" ] 170 deps = [ # 依赖组件内模块 171 "../feature1:helloworld_lib" 172 ] 173 external_deps = [ "partB:module1" ] # （可选）如果有跨组件的依赖，格式为“组件名:模块名” 174 install_enable = true # 可执行程序缺省不安装，需要安装时需要指定 175 part_name = "partA" 176 } 177 ``` 178 179 示例3：编写etc模块gn脚本test/examples/partA/feature3/BUILD.gn，示例如下： 180 181 ``` 182 ohos_prebuilt_etc("feature3_etc") { 183 source = "src/config.conf" 184 relative_install_dir = "init" #可选，模块安装相对路径，相对于默认安装路径；默认在/system/etc目录 185 part_name = "partA" 186 } 187 ``` 188 189 示例4：在子系统的ohos.build中添加组件配置：test/examples/ohos.build。每个子系统有一个ohos.build配置文件，在子系统的根目录下。示例如下： 190 191 ``` 192 "partA": { 193 "module_list": [ 194 "//test/examples/partA/feature1:helloworld_lib", 195 "//test/examples/partA/feature2:helloworld_bin", 196 "//test/examples/partA/feature3:feature3_etc", 197 ], 198 "inner_kits": [ 199 200 ], 201 "system_kits": [ 202 203 ], 204 "test_list": [ 205 206 ] 207 } 208 ``` 209 210 一个组件包含module\_list、inner\_kits、system\_kits、test\_list四个部分的声明，其中： 211 212 - module\_list：组件所包含的模块列表； 213 - inner\_kits：组件提供给其它组件调用的接口，其他组件的模块可以在external\_deps中添加依赖的模块； 214 - system\_kits：组件提供给开发者开发应用的接口； 215 - test\_list：组件中对应模块的测试用例； 216 2172. 将组件添加到产品配置中。 218 219 在产品的配置中添加组件，产品对应的配置文件：productdefine/common/products/\{product-name\}.json。 220 221 在产品配置文件中添加 "subsystem\_examples:partA"，表示该产品中会编译并打包partA到版本中。 222 2233. 编译。 224 225 以编译Hi3516DV300为例，编译命令如下： 226 227 ``` 228 ./build.sh --product-name Hi3516DV300 --ccache 229 ``` 230 2314. 编译输出。 232 233 编译所生成的文件都归档在out/hi3516dv300/目录下，结果镜像输出在 out/hi3516dv300/packages/phone/images/ 目录下。 234 235 236