1# CMake方式组织编译的库移植 2 3 4以double-conversion库为例，其移植过程如下文所示。 5 6 7## 源码获取 8 9从仓库[获取double-conversion源码](https://github.com/google/double-conversion)，其目录结构如下表： 10 11 **表1** 源码目录结构 12 13| 名称 | 描述 | 14| -------- | -------- | 15| double-conversion/cmake/ | CMake组织编译使用到的模板 | 16| double-conversion/double-conversion/ | 源文件目录 | 17| double-conversion/msvc/ | - | 18| double-conversion/test/ | 测试用例源文件 | 19| double-conversion/.gitignore | - | 20| double-conversion/AUTHORS | - | 21| double-conversion/BUILD | - | 22| double-conversion/CMakeLists.txt | CMake方式顶层编译组织文件 | 23| double-conversion/COPYING | - | 24| double-conversion/Changelog | - | 25| double-conversion/LICENSE | - | 26| double-conversion/Makefile | - | 27| double-conversion/README.md | - | 28| double-conversion/SConstruct | - | 29| double-conversion/WORKSPACE | - | 30 31 32## 移植思路 33 34移植思路：通过修改工具链，交叉编译该三方库，生成OpenHarmony平台的可执行文件，最后再通过GN调用CMake的方式添加到OpenHarmony工程中。 35 36 37## 交叉编译 38 39 40### 编译参考 41 42代码仓库的[README.md](https://github.com/google/double-conversion/blob/master/README.md)中详细介绍了使用CMake编译double-conversion库的步骤，以及测试方法。本文参考该指导设置该库的编译配置，并完成测试。若开发人员在移植过程中对该库的编译选项配置有疑惑的地方，可参考该指导。对于其他使用CMake可独立编译的三方库，在移植时可以参考其自带的编译指导。 43 44 45### 设置执行交叉编译 46 47CMake方式可通过指定工具链进行交叉编译，修改并编译该库，生成OpenHarmony平台的可执行文件，步骤如下： 48 491. 设置工具链 50 将下列clang工具链配置添加到该工程的顶层CMakeLists.txt（即表1中的该文件）中即可。 51 52 ``` 53 set(CMAKE_CROSSCOMPILING TRUE) 54 set(CMAKE_SYSTEM_NAME Generic) 55 set(CMAKE_CXX_COMPILER_ID Clang) 56 set(CMAKE_TOOLCHAIN_PREFIX llvm-) 57 #指定c编译工具（确保工具链所在路径已经添加到了PATH环境变量中）和编译标志，使用clang编译时标志中必须指定--target，否则无法交叉编译。 58 set(CMAKE_C_COMPILER clang) 59 set(CMAKE_C_FLAGS "--target=arm-liteos -D__clang__ -march=armv7-a -w -mfloat-abi=softfp -mcpu=cortex-a7 -mfpu=neon-vfpv4") 60 #指定c++编译工具（确保工具链所在路径已经添加到了PATH环境变量中）和编译标志，必须指定--target，否则无法交叉编译。 61 set(CMAKE_CXX_COMPILER clang++) 62 set(CMAKE_CXX_FLAGS "--target=arm-liteos -D__clang__ -march=armv7-a -w -mfloat-abi=softfp -mcpu=cortex-a7 -mfpu=neon-vfpv4") 63 #指定链接工具和链接标志，必须指定--target和--sysroot，其中OHOS_ROOT_PATH可通过cmake命令后缀参数来指定。 64 set(MY_LINK_FLAGS "--target=arm-liteos --sysroot=${OHOS_SYSROOT_PATH}") 65 set(CMAKE_LINKER clang) 66 set(CMAKE_CXX_LINKER clang++) 67 set(CMAKE_C_LINKER clang) 68 set(CMAKE_C_LINK_EXECUTABLE 69 "${CMAKE_C_LINKER} ${MY_LINK_FLAGS} <FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>") 70 set(CMAKE_CXX_LINK_EXECUTABLE 71 "${CMAKE_CXX_LINKER} ${MY_LINK_FLAGS} <FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>") 72 #指定链接库的查找路径。 73 set(CMAKE_SYSROOT ${OHOS_SYSROOT_PATH}) 74 ``` 75 762. 执行编译 77 linux命令行中进入double-conversion的源文件目录（即标1所示目录），执行下列命令： 78 79 80 ``` 81 mkdir build && cd build 82 cmake .. -DBUILD_TESTING=ON -DOHOS_SYSROOT_PATH="..." 83 make -j 84 ``` 85 86 其中OHOS_SYSROOT_PATH需用绝对路径指定出sysroot目录的位置，以OpenHarmony为例即目录out/hispark_xxx/ipcamera_hispark_xxx/sysroot的绝对路径。上述目录会在全量编译后生成，因此移植前先完成一次全量编译。 87 883. 查看结果 89 步骤2操作完成后，build目录下会生成静态库文件和测试用例： 90 91 **表2** 编译生成文件目录结构 92 93 | 名称 | 描述 | 94 | -------- | -------- | 95 | double-conversion/build/libdouble-conversion.a | 生成的静态库文件 | 96 | double-conversion/build/test/ | 目录下存放生成的测试用例和相关CMake缓存文件 | 97 | double-conversion/build/CMakeCache.txt | CMake构建过程中的缓存文件 | 98 | double-conversion/build/CMakeFiles/ | - | 99 | double-conversion/build/cmake_install.cmake | - | 100 | double-conversion/build/CTestTestfile.cmake | - | 101 | double-conversion/build/DartConfiguration.tcl | - | 102 | double-conversion/build/generated/ | - | 103 | double-conversion/build/Makefile | - | 104 | double-conversion/build/Testing/ | - | 105 106 107## 测试 108 1091. 搭建OpenHarmony环境 110 以Hi3516DV300为例，编译出OpenHarmony镜像，烧写到开发板，相关操作可参考[快速入门小型系统部分](../quick-start/quickstart-overview.md)。 111 112 进入系统如下所示： 113 114 **图1** OpenHarmony启动成功界面 115 116  117 1182. 挂载nfs目录，将表2中test目录下cctest可执行文件放入nfs目录 119 1203. 执行用例 121 该库采用非交叉编译时用例是通过make test执行，CMake会有相关的执行结果统计；交叉编译时无法使用该方法，因此可直接执行生成的测试文件完成测试。 122 123 - 挂载成功后执行下列命令可列出用例所有条目： 124 125 126 ``` 127 cd nfs 128 ./cctest --list 129 ``` 130 131 上述命令执行结果部分展示： 132 133 134 ``` 135 test-bignum/Assign< 136 test-bignum/ShiftLeft< 137 test-bignum/AddUInt64< 138 test-bignum/AddBignum< 139 test-bignum/SubtractBignum< 140 test-bignum/MultiplyUInt32< 141 test-bignum/MultiplyUInt64< 142 test-bignum/MultiplyPowerOfTen< 143 test-bignum/DivideModuloIntBignum< 144 test-bignum/Compare< 145 test-bignum/PlusCompare< 146 test-bignum/Square< 147 test-bignum/AssignPowerUInt16< 148 test-bignum-dtoa/BignumDtoaVariousDoubles< 149 test-bignum-dtoa/BignumDtoaShortestVariousFloats< 150 test-bignum-dtoa/BignumDtoaGayShortest< 151 test-bignum-dtoa/BignumDtoaGayShortestSingle< 152 test-bignum-dtoa/BignumDtoaGayFixed< 153 test-bignum-dtoa/BignumDtoaGayPrecision< 154 test-conversions/DoubleToShortest< 155 test-conversions/DoubleToShortestSingle< 156 ... 157 ``` 158 159 - 以test-bignum条目为例，执行下列命令开始测试： 160 161 162 ``` 163 ./cctest test-bignum 164 ``` 165 166 测试结果如下则表示通过： 167 168 169 ``` 170 Ran 13 tests. 171 ``` 172 173 174## 将该库编译添加到OpenHarmony工程中 175 1761. 复制库到OpenHarmony工程中 177 拷贝已经能够成功交叉编译的库到OpenHarmony的third_party目录，为了不修改要移植的三方库目录下的BUILD.gn文件，再添加一层目录放置新增的gn转CMake编译适配文件，新增的文件有BUILD.gn、build_thirdparty.py、 config.gni，新增后的目录结构如下所示。 178 179 **表3** 添加到工程后的目录结构 180 181 | 名称 | 描述 | 182 | -------- | -------- | 183 | OpenHarmony/third_party/double-conversion/BUILD.gn | 将三方库加入工程的gn适配文件 | 184 | OpenHarmony/third_party/double-conversion/build_thirdparty.py | GN调用shell命令脚本文件，由上面GN文件将相关命令传入，实现GN转CMake | 185 | OpenHarmony/third_party/double-conversion/config.gni | 三方库编译配置文件，可修改该文件来配置用例是否参与构建等 | 186 | OpenHarmony/third_party/double-conversion/double-conversion/ | 要移植的三方库目录 | 187 1882. 添加gn到CMake适配文件 189 - **新增的BUILD.gn文件实现如下，其他采用CMake方式可独立编译的三方库移植到OpenHarmony平台时只需修改路径即可**。 190 191 192 ``` 193 import("config.gni") 194 group("double-conversion") { 195 if (ohos_build_thirdparty_migrated_from_fuchisa == true) { 196 deps = [":make"] 197 } 198 } 199 if (ohos_build_thirdparty_migrated_from_fuchisa == true) { 200 action("make") { 201 script = "//third_party/double-conversion/build_thirdparty.py" 202 outputs = ["$root_out_dir/log_dc.txt"] 203 exec_path = rebase_path(rebase_path("./build", ohos_third_party_dir)) 204 command = "rm * .* -rf && $CMAKE_TOOLS_PATH/cmake .. $CMAKE_FLAG $CMAKE_TOOLCHAIN_FLAG && make -j" 205 args = [ 206 "--path=$exec_path", 207 "--command=${command}" 208 ] 209 } 210 } 211 ``` 212 213 - **新增的config.gni用于配置该库，实现如下，其他采用CMake方式可独立编译的三方库移植到OpenHarmony时只需修改CMAKE_FLAG的配置即可。** 214 215 216 ``` 217 #CMAKE_FLAG: config compile feature 218 CMAKE_FLAG = "-DBUILD_TESTING=ON -DCMAKE_CXX_STANDARD=11" 219 220 #toolchain：follow up-layer，depend on $ohos_build_compiler 221 if (ohos_build_compiler == "clang") { 222 CMAKE_TOOLCHAIN_FLAG = "-DOHOS_SYSROOT_PATH=${root_out_dir}sysroot" 223 } else { 224 CMAKE_TOOLCHAIN_FLAG = "" 225 } 226 227 #CMake tools path,no need setting if this path already joined to $PATH. 228 CMAKE_TOOLS_PATH = "setting CMake tools path..." 229 ``` 230 231 - **新增的build_thirdparty.py实现如下，其他采用CMake方式可独立编译的三方库移植到OpenHarmony时无需修改即可使用。** 232 233 234 ``` 235 import os 236 import sys 237 from subprocess import Popen 238 import argparse 239 import shlex 240 241 def cmd_exec(command): 242 cmd = shlex.split(command) 243 proc = Popen(cmd) 244 proc.wait() 245 ret_code = proc.returncode 246 if ret_code != 0: 247 raise Exception("{} failed, return code is {}".format(cmd, ret_code)) 248 249 def main(): 250 parser = argparse.ArgumentParser() 251 parser.add_argument('--path', help='Build path.') 252 parser.add_argument('--command', help='Build command.') 253 parser.add_argument('--enable', help='enable python.', nargs='*') 254 args = parser.parse_args() 255 256 if args.enable: 257 if args.enable[0] == 'false': 258 return 259 260 if args.path: 261 curr_dir = os.getcwd() 262 os.chdir(args.path) 263 if args.command: 264 if '&&' in args.command: 265 command = args.command.split('&&') 266 for data in command: 267 cmd_exec(data) 268 else: 269 cmd_exec(args.command) 270 os.chdir(curr_dir) 271 272 if __name__ == '__main__': 273 sys.exit(main()) 274 ``` 275 276 - 在配置文件中添加开关控制该库编译，默认设为关闭 277 278 在//build/lite/ohos_var.gni文件中添加下列配置： 279 280 281 ``` 282 declare_args() { 283 ohos_build_thirdparty_migrated_from_fuchisa = true 284 } 285 ``` 286 2873. 编译构建 288 手动单独构建： 289 290 执行下列命令 291 292 293 ``` 294 hb build -T //third_party/double-conversion:double-conversion 295 ``` 296 297 编译成功则build目录下会生成静态库文件和测试用例 298
