OpenHarmony—编译构建指导

概述

OpenHarmony编译子系统是以GN和Ninja构建为基座，对构建和配置粒度进行部件化抽象、对内建模块进行功能增强、对业务模块进行功能扩展的系统，该系统提供以下基本功能：

以部件为最小粒度拼装产品和独立编译。
支持轻量、小型、标准三种系统的解决方案级版本构建，以及用于支撑应用开发者使用IDE开发的SDK开发套件的构建。
支持芯片解决方案厂商的灵活定制和独立编译。

适用范围

本指导适用于轻量、小型、标准三种系统。芯片解决方案配置规则与新增并编译芯片解决方案主要和轻量系统、小型系统相关，其他内容都是通用的。

基本概念及包含关系

在了解编译构建子系统的能力前，应了解如下基本概念：

平台：开发板和内核的组合，不同平台支持的子系统和部件不同。
产品：产品是包含一系列部件的集合，编译后产品的镜像包可以运行在不同的开发板上。
子系统：OpenHarmony整体遵从分层设计，从下向上依次为：内核层、系统服务层、框架层和应用层（详见OpenHarmony技术架构）。系统功能按照"系统 > 子系统 > 部件"逐级展开，在多设备部署场景下，支持根据实际需求裁剪某些非必要的子系统或部件。子系统是一个逻辑概念，它具体由对应的部件构成。
部件：对子系统的进一步拆分，可复用的软件单元，它包含源码、配置文件、资源文件和编译脚本；能独立构建，以二进制方式集成，具备独立验证能力的二进制单元。需要注意的是下文中的芯片解决方案本质是一种特殊的部件。
模块：模块就是编译子系统的一个编译目标，部件也可以是编译目标。
特性：特性是部件用于体现不同产品之间的差异。
GN：Generate Ninja的缩写，用于产生Ninja文件。
Ninja：Ninja是一个专注于速度的小型构建系统。
hb：OpenHarmony的命令行工具，用来执行编译命令。

基于以上概念，编译子系统通过配置来实现编译和打包，该子系统主要包括：模块、部件、子系统、产品。

图1 产品、子系统、部件和模块间关系

图1体现了编译子系统的各部分关系，主要体现为：

子系统是某个路径下所有部件的集合，一个部件只能属于一个子系统。
部件是模块的集合，一个模块只能归属于一个部件。
通过产品配置文件配置一个产品包含的部件列表，部件不同的产品配置可以复用。
部件可以在不同的产品中实现有差异，通过变体或者特性feature实现。
模块就是编译子系统的一个编译目标，部件也可以是编译目标。

运作机制

编译构建可以编译产品、部件和模块，但是不能编译子系统。编译构建流程如下图所示，主要分设置和编译两步：

图2 编译构建流程

hb set: 设置要编译的产品。
hb build: 编译产品、开发板或者部件。编译主要过程如下：
1. 读取编译配置：根据产品选择的开发板，读取开发板config.gni文件内容，主要包括编译工具链、编译链接命令和选项等。
2. 调用GN：调用gn gen命令，读取产品配置生成产品解决方案out目录和Ninja文件。
3. 调用Ninja：调用ninja -C out/board/product启动编译。
4. 系统镜像打包：将部件编译产物打包，设置文件属性和权限，制作文件系统镜像。

约束限制

编译环境目前主要支持Ubuntu18.04和Ubuntu20.04（Ubuntu22.04暂不支持）。

环境配置

安装编译所需的程序包。安装命令：

安装方式一：使用脚本，在当前工程目录执行
```
./build/build_scripts/env_setup.sh
```

安装方式二：apt-get和pip3 install命令安装

apt-get update -y 
apt-get install -y  
# 如果是ubuntu20.04系统请直接安装python3.9，如果是ubuntu18.04请改为安装python3.8
apt-get install -y apt-utils binutils bison flex bc build-essential make mtd-utils gcc-arm-linux-gnueabi u-boot-tools python3.9 python3-pip git zip unzip curl wget gcc g++ ruby dosfstools mtools default-jre default-jdk scons python3-distutils perl openssl libssl-dev cpio git-lfs m4 ccache zlib1g-dev tar rsync liblz4-tool genext2fs binutils-dev device-tree-compiler e2fsprogs git-core gnupg gnutls-bin gperf lib32ncurses5-dev libffi-dev zlib* libelf-dev libx11-dev libgl1-mesa-dev lib32z1-dev xsltproc x11proto-core-dev libc6-dev-i386 libxml2-dev lib32z-dev libdwarf-dev 
apt-get install -y grsync xxd libglib2.0-dev libpixman-1-dev kmod jfsutils reiserfsprogs xfsprogs squashfs-tools  pcmciautils quota ppp libtinfo-dev libtinfo5 libncurses5 libncurses5-dev libncursesw5 libstdc++6  gcc-arm-none-eabi vim ssh locales doxygen
apt-get install -y libxinerama-dev libxcursor-dev libxrandr-dev libxi-dev
# python需要安装以下模块，repo文件在上一章节约束与限制的源码获取中得到。
chmod +x /usr/bin/repo 
pip3 install --trusted-host https://repo.huaweicloud.com -i https://repo.huaweicloud.com/repository/pypi/simple requests setuptools pymongo kconfiglib pycryptodome ecdsa ohos-build pyyaml prompt_toolkit==1.0.14 redis json2html yagmail python-jenkins 
pip3 install esdk-obs-python --trusted-host pypi.org 
pip3 install six --upgrade --ignore-installed six
#还需要安装llvm，hc-gen，gcc_riscv32，Ninja，node-v14.15.4-linux-x64，GN，如果用户使用的shell环境不是bash或者zsh的配置，则需要配置以下环境变量：
# export PATH=/home/tools/llvm/bin:$PATH
# export PATH=/home/tools/hc-gen:$PATH
# export PATH=/home/tools/gcc_riscv32/bin:$PATH
# export PATH=/home/tools/ninja:$PATH
# export PATH=/home/tools/node-v12.20.0-linux-x64/bin:$PATH
# export PATH=/home/tools/gn:$PATH
# export PATH=~/.local/bin:$PATH

注意：上述安装ohos-build的过程中会安装编译工具hb，但有时会出现hb安装不成功的情况，若安装不成功，则按照hb安装重新安装。