编译环境搭建.md · kangchongtao/note

##该文档适用于win 10 Ubuntu 20.04
## 1.安装 wsl2 环境

1.1 启用适用于 Linux 的 Windows 子系统

```
// wsl 相关命令在powershow中执行，管理员权限打开，下同
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
```
   1.2 启用虚拟机功能

```
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
```
![](./img/image%E5%90%AF%E7%94%A8%E8%99%9A%E6%8B%9F%E6%9C%BA%E5%8A%9F%E8%83%BD.PNG)
   
   1.3 重启计算机

1.4 下载 Linux 内核更新包并安装
        [适用于 x64 计算机的 WSL2 Linux 内核更新包](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi)

1.5 将 WSL 2 设置为默认版本

```
wsl --set-default-version 2   //这里可能报找不到wsl或者1.4安装失败，大概率是1.1和1.2未设置成功，建议重新来一遍。
```

~
    ![输入图片说明](./img/image%E8%AE%BE%E7%BD%AEwsl2.PNG)

1.6 安装Ubuntu 20.04 LTS（应用商店下载即可,建议使用20版本，不同版本内核可能会有不同，当前20版本最稳定）

1.7 打开Ubuntu 20.04 LTS，添加用户名、密码

1.8 wsl扩容（根据实际使用选择做这一步）
    
    参考[微软官方wsl扩容](https://learn.microsoft.com/zh-cn/windows/wsl/disk-space)
    
    具体操作按着文档来即可
    
    解释一下后面可能不好理解的命令

第二步大家如果做了本文档2.1迁移子系统，就容易了

第四步 拿本文档2.1举例的路径来说 命令可以写 Select vdisk file="D:\Ubuntu\ext4.vhdx"
    
    第七步 写大小就好 如  expand vdisk maximum= 512000

第九步后都是在ubuntu中执行

### 另外常用的wsl相关命令

```
wsl -l -v  // 查询当前Ubuntu（已安装的 Linux 发行版）以及查看是wsl1 还是wsl2
wsl --shutdown // 终止wsl，迁移子系统前可以使用
wsl --unregister Ubuntu-20.04   // 删除已有的某个Ubuntu环境，内存不足的时候，有时间可以重置一下自己的环境
```

其他wsl相关问题建议参考[微软官方wsl文档](https://learn.microsoft.com/zh-cn/windows/wsl/)

## 2.配置编译环境

### 2.1 迁移wsl2子系统
    
默认wsl2子系统是在c盘的，一般来说其大小默认为256G、512G, 不迁移容易给c盘整满。
因此迁移wsl2子系统到非系统盘。建议准备一个空的盘300G左右即可，只放迁移后的子系统。
另外一般来说，一套代码加编译产物在150G左右大一点会更好，自己扩容一下wsl2到512G,可以同时使用两套不同分支代码的编译，用起来更方便

2.1.1 迁移子系统需要下载LxRunOffline，下载地址，下载文件[LxRunOffline-v3.5.0-mingw.zip](https://github.com/DDoSolitary/LxRunOffline/releases/download/v3.5.0/LxRunOffline-v3.5.0-mingw.zip)，然后解压到某个目录中。

2.1.2 为其添加环境变量

2.1.4 命令行输入LxRunOffline list查看子系统版本，查到结果即2.1.5中{version}

2.1.5 复制上面的版本号，然后输入LxRunOffline move -n {version} -d {dir}，{version}是版本号，{dir}是迁移目的目录。

```
// 举例 迁移20版本，到D盘Ubuntu目录下，执行会有一会，但是成功后不会打印任何日志，如果报错请向下看常见问题
// powershow中执行
LxRunOffline move -n Ubuntu-20.04 -d D:\Ubuntu
```

2.1.6 映射到本地可以通过\\wsl$\Ubuntu-20.04打开文件所在位置。

![输入图片说明](./img/%E6%98%A0%E5%B0%841.PNG)
![输入图片说明](./img/%E6%98%A0%E5%B0%842.PNG)

### 常见问题
1.wsl 还在运行，执行wsl --shutdown，比重启电脑好用。

2.执行迁移命令时报Couldn’t set the case sensitive attribute of the directory这样的错。需要下载这个版本LxRunOffline-v3.5.0-11-gfdab71a-msvc.zip替换上面那个版本但是网上搜到的下载路径都是404，我放当前仓other_tools文件夹里面，自行下载。

### 2.2 打开Ubuntu 20.04 LTS，切换软件源。

Ubuntu 20.04 LTS下载好后，软件源默认为国外的源，如果没有外网，当你在ubuntu上安装软件时，就会因为网络超时导致软件下载失败。

2.2.1 备份原来的源:

```
// 后续命令，没注释的均在Ubuntu中执行。linux 命令很简单，都是主命令加子命令，加操作对象的路径。
cp -ra /etc/apt/sources.list /etc/apt/sources.list.bak
```

2.2.2 删除原来该文件sources.list内容

```
// vim 编辑文件，不会的自己百度，光标移到最后，按i 进入编辑模式，一个个删吧。
sudo vim /etc/apt/sources.list 
```

2.2.3 清空的sources.list文件中，复制阿里源到该文件，保存退出（复制好后按Esc 进入读模式，然后按shift + : 进入命令行模式，输入wq,然后回车）。

```
deb http://mirrors.aliyun.com/ubuntu/ focal main restricted universe multiverse
deb-src http://mirrors.aliyun.com/ubuntu/ focal main restricted universe multiverse

deb http://mirrors.aliyun.com/ubuntu/ focal-security main restricted universe multiverse
deb-src http://mirrors.aliyun.com/ubuntu/ focal-security main restricted universe multiverse

deb http://mirrors.aliyun.com/ubuntu/ focal-updates main restricted universe multiverse
deb-src http://mirrors.aliyun.com/ubuntu/ focal-updates main restricted universe multiverse

deb http://mirrors.aliyun.com/ubuntu/ focal-proposed main restricted universe multiverse
deb-src http://mirrors.aliyun.com/ubuntu/ focal-proposed main restricted universe multiverse

deb http://mirrors.aliyun.com/ubuntu/ focal-backports main restricted universe multiverse
deb-src http://mirrors.aliyun.com/ubuntu/ focal-backports main restricted universe multiverse
```

ubuntu 22.04建议用下面这个科大源，上面阿里源不好用

```
# 默认注释了源码仓库，如有需要可自行取消注释
deb https://mirrors.ustc.edu.cn/ubuntu/ jammy main restricted universe multiverse
# deb-src https://mirrors.ustc.edu.cn/ubuntu/ jammy main restricted universe multiverse

deb https://mirrors.ustc.edu.cn/ubuntu/ jammy-security main restricted universe multiverse
# deb-src https://mirrors.ustc.edu.cn/ubuntu/ jammy-security main restricted universe multiverse

deb https://mirrors.ustc.edu.cn/ubuntu/ jammy-updates main restricted universe multiverse
# deb-src https://mirrors.ustc.edu.cn/ubuntu/ jammy-updates main restricted universe multiverse

deb https://mirrors.ustc.edu.cn/ubuntu/ jammy-backports main restricted universe multiverse
# deb-src https://mirrors.ustc.edu.cn/ubuntu/ jammy-backports main restricted universe multiverse

# 预发布软件源，不建议启用
# deb https://mirrors.ustc.edu.cn/ubuntu/ jammy-proposed main restricted universe multiverse
# deb-src https://mirrors.ustc.edu.cn/ubuntu/ jammy-proposed main restricted universe multiverse

```

2.2.4 更新缓存和升级

```
// 比较久，耐心等待
sudo apt-get update 
sudo apt-get upgrade
```

### 2.3 拉取代码

随着鸿蒙发展所需要软件或升级、或新增，如果拉取代码、编译代码报错请认真看报错日志，并且后面流程建议看[鸿蒙开源社区](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/get-code/sourcecode-acquire.md)

2.3.1 注册码云[gitee](https://gitee.com/login?redirect_to_url=%2F)帐号。

2.3.2 注册码云SSH公钥，请参考[码云帮助中心](https://gitee.com/help/articles/4191)。

```
//懒人版（认真看注释），依次复制这里命令在Ubuntu中执行就好了
   ssh-keygen -t ed25519 -C "xxxx@xxxx.com"   //改引号中的内容，这里不用非要邮箱，执行后按几次回车键

cat ~/.ssh/id_ed25519.pub                   //查看公钥命令，复制查到的生成的公钥，去这个网址添加，https://gitee.com/profile/sshkeys

ssh -T git@gitee.com                      //首次使用需要确认并添加主机到本机SSH可信列表，就类似打个招呼
```

2.3.3 安装[git客户端](https://gitee.com/link?target=https%3A%2F%2Fgit-scm.com%2Fbook%2Fzh%2Fv2%2F%25E8%25B5%25B7%25E6%25AD%25A5-%25E5%25AE%2589%25E8%25A3%2585-Git)和[git-lfs](https://gitee.com/vcs-all-in-one/git-lfs?_from=gitee_search#downloading)并配置用户信息。

```
//懒人版  在ubuntu 中执行如下命令

sudo apt install git-all

sudo apt-get install git-lfs

git config --global user.name "yourname"
git config --global user.email "your-email-address"
git config --global credential.helper store
```
2.3.4 安装相关依赖软件（时间比较久）

```
for one_tools in `curl -s -k https://gitee.com/landwind/openharmony_oneclick_env_init/raw/master/apt_install.list`;do sudo bash -c "apt-get install -y ${one_tools}"; done

//除上面网址上软件，还需安装
sudo apt-get install libelf-dev

sudo apt-get install libxinerama-dev

sudo apt-get install libxcursor-dev

sudo apt-get install libxrandr-dev

sudo apt-get install libxi-dev

```

2.3.5 执行如下命令安装码云repo工具。

```
mkdir ~/bin
curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 -o ~/bin/repo 
chmod a+x ~/bin/repo
pip3 install -i https://repo.huaweicloud.com/repository/pypi/simple requests
```

2.3.6 将repo添加到环境变量。

```
vim ~/.bashrc               # 编辑环境变量
export PATH=~/bin:$PATH     # 在环境变量的最后添加一行repo路径信息
source ~/.bashrc            # 应用环境变量
```

2.3.6 拉取代码
方式一（推荐）：通过repo + ssh下载（需注册公钥，请参考码云帮助中心）。

```
repo init -u git@gitee.com:openharmony/manifest.git -b master --no-repo-verify
repo sync -c  // 同步代码
repo forall -c 'git lfs pull'  // 更新二进制
```

## 3.编译
3.1 执行脚本，更新工具链

```
./build/prebuilts_download.sh   // 更新工具链
```
3.2 执行编译命令

```
./build.sh --product-name rk3568 --ccache
```

### 常见编译问题
总体策略，看报错是否和你有关，如果不是，去看一下门禁是否大范围失败，如果不是，请按如下步骤操作则同步代码，可解决90%问题

```
// 将本地代码，和远程仓同步，
1. 删除out，rm -rf out   // 放心删，编译一遍后，除非重新换地方 repo init,否则编译速度还是很快的
2. 删除build、prebuilts文件夹、以及相关报错的文件夹
3. repo sync -c // 注意看结尾是否全部同步成功，如果未成功，删除未成功目录，重新同步。如果有修改是不会部分文件是不会同步的，注意保存自己需要的修改
4. 更新二进制：repo forall -c "git lfs pull"
5. 更新工具链：sudo ./build/prebuilts_download.sh
6. ./build.sh --product-name rk3568 --ccache
```

### 3.hdc 命令使用
hdc shell //进入设备调试

hdc list targets  //查看当前设备sn号

hdc kill //终止hdc

hdc file send 本地文件路径 设备路径   //推送本地文件到设备具体位置

hdc file recv 设备文件路径 本地路径    //推出设备文件到本地

hdc install xxx.hap  //安装应用包

## 4.加日志调试
4.1 抓日志 shell 进设备 hilog |grep "ace"   //打印带有ace的日志

## 5.提交代码

```
git clone git@gitee.com:openharmony/arkui_ace_engine.git
git checkout -b 0420
git remote add arkui git@gitee.com:kangchongtao/arkui_ace_engine.git
git add .
git commit -s -m ""
git push arkui HEAD:0420
再次修改后
git add .
git commit -s --amend
git push arkui HEAD:0420 -f
```

其他常用命令

```
git stash //保存当前修改
git pop //把保存的修改恢复
git reset --hard //回退修改不保存，慎用
git diff //查看修改，这个不会显示新增或删除的文件
git diff > 1.diff  //把修改生成差异文件
git apply 1.diff //把差异打到当前分支  --reject  --check 善等分支小命令
git apply --check 1.diff //检查差异与当前分支是否有冲突
git apply --reject 1.diff //把差异打进去，并把有冲突的地方生成同目录同文件名的后缀为.rej的文件
git status //查看修改过的文件
git log //查看提交记录
```

## 6.tdd相关

执行tdd主要过程：拉代码、编译镜像、编译tdd、取tdd到执行环境、执行tdd、看tdd执行结果

1、拉代码见2.3、编译报错见常见编译问题解决

2、编译镜像，有些tdd以来编译产物、且镜像也是你编译tdd的执行环境，建议自己编译、比较着急时，可取临近你拉取代码时间点附近的门禁镜像大概率也可用

3、编译tdd,这里不详细介绍了，会有专门一节介绍BUILD.gn

4、tdd执行环境介绍（需下载python 3.7.9以上版本，3.8的基本都可以）

![输入图片说明](./img/tdd%E7%8E%AF%E5%A2%83.png)

developertest、xdevice文件夹都是由测试部给出的tdd执行需要的工具、最新版可从下面两个仓自行下载，改名后使用，是的这两个文件必须是图中文件夹名称

https://gitee.com/openharmony/testfwk_xdevice

https://gitee.com/openharmony/testfwk_developer_test

testcase该文件夹自行取名，存放需要执行测试用例的地方

![输入图片说明](./img/user_config%E6%96%87%E4%BB%B6.png)

上图为developertest\config文件夹下user_config.xml文件，执行测试套前需修改该文件，请务必看完下面介绍在修改

图中圈的device出，即为你想要把测试套在那个设备下执行，如果只有一台rk设备即可全为空

test_cases 添加即存放测试用例地方的路径，如果不需要跑覆盖率且只有一台设备，填好该字段即可

coverage 即为跑覆盖率需要访问，插桩文件目录，一般为代码仓目录。

6、执行测试用例，双击执行developertest文件夹下start.bat，选任意数字，进入python环境后执行tdd命令即可

run -t UT 执行test_cases下所有测试套

run -t UT -ts flex_test_ng run -t UT 执行test_cases下具体某个测试套如flex_test_ng

run -t UT -ts flex_test_ng -cov coverage  执行test_cases下具体某个测试套如flex_test_ng，并生成覆盖率文件

## 7.crash 问题

解决crash需要两个文件

| 需要的文件 | 存放位置 |
|-------|------|
| crash文件   | hdc shell 进入设备在设备路径/data/log/faultlog/faultlogger下存放记录崩溃的文件 |
| 符号表   | exe.unstripped文件夹或者lib.unstripped夹下 ，具体位置以及文件夹介绍见表格下方 |

carsh文件：或者可以关注/data/log/faultlog/temp文件夹下的崩溃栈，里面的信息更全，小技巧：可以删除该目录下所有文件，重新复现崩溃

符号表：用于反编译，对于tdd来说其文件名与测试套同名

exe.unstripped：多用于存放tdd、fuzz、应用的动态链接库即so文件、存放位置tdd的一般和测试套用例生成路径目录相同

```
如：out\rk3568\exe.unstripped\tests\unittest\ace_engine\components\navigation_test_ng
文件夹存放位置自己编译的out\rk3568\exe.unstripped
门禁里面的在镜像全量包中可以找到
```

lib.unstripped：多用于存放各个子系统底层动态链接库，如咱们的libace.z.so文件就存放在这里，子系统代码仓路径相同

```
如：out\rk3568\lib.unstripped\arkui\ace_engine\libace.z.so
文件夹存放位置自己编译的out\rk3568\lib.unstripped
门禁里面的在镜像全量包中可以找到
```

特别注意：请一定要保证你符号表和崩溃栈对应，如，你当前编译出来的测试套，仅能使用同次编译出来的符号表才能反编译

3、反编译命令

可以在代码根目录下执行prebuilts/clang/ohos/linux-x86_64/llvm/bin/llvm-addr2line -f -i -C -a -e 测试套名 崩溃栈地址 崩溃栈地址 ...

prebuilts文件夹是在代码更新工具链（./build/prebuilts_download.sh）后产生

举例navigation_test_ng崩溃

首先找到其崩溃栈信息文件

![输入图片说明](./img/1.png)

cat cppcrash-navigation_test_ng-0-20230523222501

![输入图片说明](./img/cppcrash-navigation_test_ng-0-20230523222501.png)

执行反编译

![输入图片说明](./img/addr2line.png)

到这里就需要大家根据反编译结果去定位问题啦

介绍下截图里面的一些词

崩溃类型：就是圈的那个，看崩溃建议先看这个，基本可以给这次崩溃定性，如这个就是存在空指针，具体其他的可自行百度，都是可查的

崩溃栈地址：栈顶是实际发生崩溃的位置，但造成崩溃的原因，不一定在这里

波浪号指的是linux的用户目录。 /是linux的根目录，两者关系，在linux中波浪号等同于 /home/kangchongtao/

常见崩溃栈类型：

1、signal6:SIGABRT

这个问题通过搜索可以看到其产生的原因是：c++11中abort()函数发出的退出指令，可以理解为我们主动终止了程序。

一般常见场景，如一些std库函数中对异常值时就会主动abort()，比如std::optional 的value()方法

或者框架中对禁止一些行为或者出现异常值是，主动abort()

排查方向：崩溃栈顶往往就是你触发abort()的地方。先排查是不是标准库使用是否使用正确，再去排查是不是违法了框架规则。

2、signal 11 ：SIGSEGV(SEGV_MAPERR）进程执行了一个无效的内存引用

常见问题1空指针

栈顶就是你空指针调用的位置，这里不一定是你实际写的代码，但是这里空指针是由你的操作造成的。比如，你初始化某些模块、有些值未初始化造成，或者其他线程释放了你的全局指等等。

排查方向，由崩溃栈找到你负责的部分，然后分析这里造成栈顶崩溃的原因，如果此处是多线程，可以打出崩溃线程号，定位失败原因，常见的比如指针提前释放、未初始化、再或者地址踩踏等情况

常见问题2容器、数组访问越界或已销毁

这类栈顶打印的往往是容器的使用日志、还算是比较容易定位，困难点是多线程读写造成的地址踩踏

排查方向：先分析是否有越界行为，再去考虑多线程情况。

kangchongtao/note

简介

发行版

贡献者

近期动态

kangchongtao/note .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

kangchongtao/note