三方庫(kù)移植OpenHarmony過(guò)程

戰(zhàn)碼先鋒，PR征集令（以下簡(jiǎn)稱(chēng)“戰(zhàn)碼先鋒”）第二期正如火如荼地進(jìn)行中，涉及OpenAtom OpenHarmony（以下簡(jiǎn)稱(chēng)“OpenHarmony”）主干倉(cāng)、SIG倉(cāng)、三方庫(kù)，共計(jì)1000+代碼倉(cāng)任君挑戰(zhàn)。

在戰(zhàn)碼先鋒活動(dòng)中，我們注意到開(kāi)發(fā)者對(duì)三方庫(kù)移植有著濃厚的興趣。三方庫(kù)是基于標(biāo)準(zhǔn)Linux系統(tǒng)的C/C++開(kāi)源庫(kù)，例如OpenCV、LZMA壓縮算法、ZXing-cpp圖像處理庫(kù)，三方庫(kù)移植能為OpenHarmony項(xiàng)目補(bǔ)齊更多功能或組件，對(duì)繁榮生態(tài)非常重要。

三方庫(kù)移植也為參與OpenHarmony貢獻(xiàn)提供了另外一種思路，我們希望通過(guò)實(shí)戰(zhàn)經(jīng)驗(yàn)的分享鼓勵(lì)更多感興趣的開(kāi)發(fā)者動(dòng)手移植自己心儀的三方庫(kù)。為此，我們邀請(qǐng)目前還是一名大三學(xué)生，也是戰(zhàn)碼先鋒優(yōu)秀貢獻(xiàn)者，OpenHarmony啃論文俱樂(lè)部?jī)?yōu)秀學(xué)員——賈佳豪（社區(qū)網(wǎng)名：離北況歸）進(jìn)行分享，他在完成了一個(gè)三方庫(kù)在OpenHarmony標(biāo)準(zhǔn)系統(tǒng)上的移植工作后，總結(jié)了以下經(jīng)驗(yàn)。

四步實(shí)現(xiàn)三方庫(kù)移植：1、在Linux下編譯要移植的三倉(cāng)庫(kù)，分析編譯過(guò)程；2、將要移植的三方庫(kù)加入編譯框架中以及產(chǎn)品引用；3、增量編譯出動(dòng)態(tài)鏈接庫(kù)和可執(zhí)行文件推送到開(kāi)發(fā)板上；4、在開(kāi)發(fā)板上驗(yàn)證移植是否成功、API接口導(dǎo)出。

第一步

三方庫(kù)下載最新分支代碼后在Linux下編譯，分析編譯過(guò)程。 觀察原生庫(kù)目錄結(jié)構(gòu)或者Readme可以知道該如何編譯，一般有如下兩種編譯方式： ①在原生庫(kù)根目錄中，存在CMakeLists.txt文件。在原生庫(kù)下新建build目錄通過(guò)cmake或者cmake-gui生成makeflie然后make。 ②在原生庫(kù)目錄中存在autogen.sh,configure.ac文件，原生庫(kù)使用Makefile.am構(gòu)建，./autogen.sh再./configure命令生成Makefile，最后make、make install。

在Linux下編譯原生庫(kù)要配置好編譯環(huán)境，安裝cmake、make、automake等工具。

分析編譯過(guò)程：

提取編譯出動(dòng)態(tài)鏈接庫(kù)和測(cè)試用的可執(zhí)行文件需要的源文件和頭文件、編譯時(shí)添加的cflag、編譯器參數(shù)以及編譯需要鏈接的庫(kù)。該過(guò)程分為如下兩種情況：

①在cmake生成makefile的過(guò)程中分析build.make、depend.make、flags.make、link.txt等得出三方庫(kù)對(duì)應(yīng)的依賴(lài)關(guān)系。

②使用Makefile.am構(gòu)建的三方庫(kù)通過(guò)分析make.am內(nèi)容可以直接分析編譯動(dòng)態(tài)鏈接庫(kù)和測(cè)試用的可執(zhí)行文件需要哪些源文件，而編譯需要添加的編譯器參數(shù)和需要鏈接的庫(kù)則通過(guò)分析三方庫(kù)父目錄makefile文件提取。

第二步

根據(jù)第一步分析得到的結(jié)果把三方庫(kù)加入OpenHarmony編譯構(gòu)建體系。 ①定義子系統(tǒng)并加入編譯框架。首先把三方庫(kù)放置在OpenHarmony源碼third_party目錄下作為子系統(tǒng)目錄。子系統(tǒng)目錄下創(chuàng)建ohos.build文件，構(gòu)建時(shí)會(huì)先讀取該文件。

把子系統(tǒng)配置到build/subsystem_config.json.

②定義組件并加入子系統(tǒng)：在上述定義子系統(tǒng)時(shí)添加的ohos.build文件中，我們已經(jīng)定義好了對(duì)應(yīng)的組件。

module_list所定義的為該組件的目標(biāo)，上述定義的目標(biāo)為測(cè)試用的可執(zhí)行文件。

③定義目標(biāo)并加入組件：在編寫(xiě)gn文的時(shí)候，我們定義的動(dòng)態(tài)庫(kù)以及測(cè)試可執(zhí)行程序都是我們的目標(biāo)模塊，在每個(gè)目標(biāo)模塊中添加對(duì)應(yīng)的組件名后即將我們的目標(biāo)模塊加入該組件中。

④產(chǎn)品引用：把子系統(tǒng)及其組件加入產(chǎn)品定義中，以rk3568為例，產(chǎn)品定義文件存在vendor/hihope/rk3568/config.json，以下內(nèi)容添加到config.json中：

第三步

增量編譯出動(dòng)態(tài)鏈接庫(kù)和可執(zhí)行文件，在OpenHarmony源碼執(zhí)行。

./build.sh --product-name rk3568 --ccache --build-target=移植的三方庫(kù)名稱(chēng) --target-cpu arm64

（ohos更新到3.2版本后，支持64位系統(tǒng)的編譯，默認(rèn)情況下編譯的都是32位系統(tǒng)，在編譯命令中添加--target-cpu arm64即可構(gòu)建64位系統(tǒng)）

第一次編譯可能會(huì)報(bào)錯(cuò)，我們根據(jù)報(bào)錯(cuò)信息調(diào)整編寫(xiě)的gn文件。消除clang編譯警告，例如-Wimplicit-function-declaration改為-Wno-implicit-function-declaration添加到gn文的cflags信息里面。不推薦直接全量編譯出鏡像燒錄到開(kāi)發(fā)板上。將耗費(fèi)較多時(shí)間，也不便編譯調(diào)試。編譯成功生成的動(dòng)態(tài)鏈接庫(kù)和測(cè)試用的可執(zhí)行文件在out目錄下。

第四步

在開(kāi)發(fā)板上驗(yàn)證移植是否成功、API接口導(dǎo)出。

利用hdc_std工具將編譯出的so動(dòng)態(tài)鏈接庫(kù)和測(cè)試用的可執(zhí)行文件放到開(kāi)發(fā)板上，驗(yàn)證移植的三方庫(kù)功能是否正常。

API是指應(yīng)用程序編程接口，通過(guò)API接口可以實(shí)現(xiàn)指定的功能，而不需要了解其內(nèi)部實(shí)現(xiàn)細(xì)節(jié)。API接口導(dǎo)出在pc端，需要編譯生成的動(dòng)態(tài)鏈接庫(kù)和測(cè)試用的可執(zhí)行文件。API接口導(dǎo)出思路如下：

①新建allHeads.h，該頭文件中包含所有庫(kù)對(duì)外導(dǎo)出的頭文件

②新增allDySos目錄，該目錄下放置生成的動(dòng)態(tài)庫(kù)

③新增allTests目錄，該目錄下放置所有生成的測(cè)試用的可執(zhí)行文件

④新建自動(dòng)化測(cè)試腳本export_interface.sh，腳本如下，執(zhí)行時(shí)需要給腳本傳入編譯頭文件的參數(shù)例如./export_interface.sh -I頭文件所在路徑-D宏定義（編譯所有動(dòng)態(tài)庫(kù)時(shí)，cflags/cflags_cc中的參數(shù)）

cxx="0"：mixed_api() {
    while read line    do        if [ $cxx != "1" -o "$4" == "1" ];then            tmp=$line        else            tmp=`echo $line | sed "s/(.*$//g" | sed "s/^.*:://g"`        fi        res=`cat $2 |grep "$tmp" -F`        if [ "$res" != "" ];then            echo "$line" >> $3        fi    done < $1}

以上是部分代碼展現(xiàn)，閱覽全部代碼請(qǐng)打開(kāi)鏈接

https://gitee.com/openharmony-sig/contest/tree/master/2022_OpenHarmony_thirdparty/speexdsp

再次總結(jié)四步要點(diǎn)：1、在Linux下編譯要移植的三倉(cāng)庫(kù)，分析編譯過(guò)程；2、將要移植的三方庫(kù)加入編譯框架中以及產(chǎn)品引用；3、增量編譯出動(dòng)態(tài)鏈接庫(kù)和可執(zhí)行文件推送到開(kāi)發(fā)板上。4、在開(kāi)發(fā)板上驗(yàn)證移植是否成功、API接口導(dǎo)出。

備注：三方庫(kù)的移植需要搭建好OpenHarmony南向開(kāi)發(fā)環(huán)境，也需要有開(kāi)發(fā)板和掌握hdc_std工具的使用。另外，這樣移植有一個(gè)前提，與平臺(tái)無(wú)關(guān)（即庫(kù)不涉及對(duì)os_api有依賴(lài)，不涉及opensl以及opengl，ohos上這兩個(gè)庫(kù)和業(yè)界的有一定差異，不涉及硬件，不涉及驅(qū)動(dòng)）。