CMake跨平台编译API配置

项目目录结构的最佳实践

在一个CMake项目中，合理的目录结构可以显著提高开发效率和代码管理的便利性。一个典型的项目通常包括以下几个主要目录：

cmake/：存放CMake相关的配置文件，例如工具链文件和配置生成脚本。
include/：包含项目对外提供的头文件。
src/：存放项目的源代码文件。
test/：用于存放测试代码。
build.sh：构建脚本，用于执行项目的编译和安装。

以上结构不仅适用于小型项目，还能扩展用于更复杂的工程。在此结构下，各个模块可以被清晰地分隔开，便于维护和扩展。此外，顶层的CMakeLists.txt文件负责引入各子模块的CMakeLists.txt文件，形成一个完整的项目构建体系。

如何使用CMake进行交叉编译

交叉编译是指在一个平台上生成另一个平台可执行代码的过程。为了在CMake中实现交叉编译，我们通常需要一个工具链文件（toolchain file），它定义了目标平台的编译器及相关配置。工具链文件的一个例子如下：

set(CMAKE_SYSTEM_NAME Linux)

set(CMAKE_SYSTEM_PROCESSOR arm)



set(CROSS_PREFIX arm-linux-gnueabi-)

set(CMAKE_C_COMPILER ${CROSS_PREFIX}gcc)

set(CMAKE_CXX_COMPILER ${CROSS_PREFIX}g++)



set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)

set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)

set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

通过指定CMAKE_TOOLCHAIN_FILE变量，CMake可以根据工具链文件中的设置来进行交叉编译。这种方法使得同一套源码可以在多个平台之间无缝移植。

配置不同平台的交叉编译环境

通过修改user.env文件中的配置，可以轻松切换不同平台的交叉编译环境。以下是几个常见平台的配置示例：

海思平台dv300

USER_TOOLCHAIN_FILE="/path/to/dv300.toolchain.cmake"

USER_PLATFORM_TYPE="hisi"

USER_PLATFORM_CHIP_TYPE="dv300"

瑞芯微平台rv1109/rv1126

USER_TOOLCHAIN_FILE="/path/to/rv1109.toolchain.cmake"

USER_PLATFORM_TYPE="rockchip"

USER_PLATFORM_CHIP_TYPE="rv1109"

星辰平台ssd222d

USER_TOOLCHAIN_FILE="/path/to/ssd222d.toolchain.cmake"

USER_PLATFORM_TYPE="sigmastar"

USER_PLATFORM_CHIP_TYPE="ssd222d"

通过以上配置，开发者可以在不同的硬件平台之间快速切换，只需更改工具链文件和相关平台参数。

CMakeLists.txt文件的配置要点

CMakeLists.txt是CMake项目的核心配置文件，负责定义项目的构建流程。以下是一个典型的CMakeLists.txt文件的要点：

## 设置CMake的最低版本要求

cmake_minimum_required(VERSION 3.10)



## 定义项目名称和版本

project(mymath VERSION 0.1.0 DESCRIPTION "mymath libraries")



## 检查是否安装了ccache以加速编译

find_program(CCACHE_PROGRAM ccache)

if(CCACHE_PROGRAM)

  message(STATUS "Set up ccache ...")

  set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)

  set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)

else()

  message(WARNING "ccache has not been found")

endif()



## 编译子目录

add_subdirectory(src)

add_subdirectory(test)



## 安装库头文件

install(DIRECTORY include DESTINATION . FILES_MATCHING PATTERN "*.h" PATTERN "*.hpp")

通过合理配置CMakeLists.txt文件，可以确保项目在不同环境下的一致性和可移植性。

使用脚本自动化构建流程

为了简化构建流程，通常会编写一个build.sh脚本来自动化执行CMake的配置、编译和安装过程。以下是一个示例脚本：

#!/bin/bash

set -e

source_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"



user_env_file="$source_dir/user.env"

if [ ! -f "$user_env_file" ]; then

    echo -e "[Warning]: $user_env_file not exists, please copy $user_env_file.sample to $user_env_file and modify it"

else

    . $user_env_file

fi



build_root_dir="$source_dir/build"

install_dir="$source_dir/install"

build_type=${USER_BUILD_TYPE:-"Release"}

build_shared_libs=${USER_BUILD_SHARED_LIBS:-"OFF"}



for i in "$@"; do

    case $i in

    --toolchain_file=*)

        toolchain_file="${i#*=}"

        shift # past argument=value

        ;;

    --clean)

        clean_build="yes"

        shift # past argument with no value

        ;;

    *)

        # unknown option

        ;;

    esac



done



build_dir=$build_root_dir/$platform_type/$chip_type/$build_type



mkdir -p "$build_dir" || true

mkdir -p "$install_dir/include" || true

mkdir -p "$install_dir/lib" || true



## 清除编译

if  $clean_build == "yes" ; then

    echo "clean ..."

    rm $build_root_dir -rf

    rm $install_dir -rf

else

    pushd "$build_dir"

    cmake "$source_dir" -G "$cmake_generator" 

        -DCMAKE_INSTALL_PREFIX="$install_dir" 

        -DCMAKE_TOOLCHAIN_FILE="$toolchain_file" 

        -DPLATFORM_TYPE="$platform_type" 

        -DPLATFORM_CHIP_TYPE="$platform_chip_type" 

        -DCMAKE_BUILD_TYPE="$build_type" 

        -DBUILD_SHARED_LIBS="$build_shared_libs" 



    # 编译

    cmake --build . --parallel

    # 安装

    cmake --build . --target install

    popd

fi

通过这个脚本，开发者可以快速进行不同平台的交叉编译，简化了手动配置的繁琐步骤。

跨平台编译中的注意事项

在跨平台编译中，有几个关键点需要注意：

工具链文件的准确性：确保工具链文件中所定义的编译器和相关路径是正确的。
依赖库的管理：在不同平台上，所需的依赖库可能有所不同，需根据实际情况进行调整。
API兼容性：确保代码中使用的API在目标平台上是可用的，避免使用不兼容的特性。

通过仔细检查和配置，可以减少跨平台编译过程中遇到的问题，提高项目的稳定性和可移植性。

代码块示例与说明

在CMake项目中，代码块是非常重要的组成部分，它们不仅决定了项目的结构，还影响到编译和运行的效率。以下是一些常用的代码块示例：

添加库

autory(. _SRC_FILES)

add_library(${PROJECT_NAME} ${_SRC_FILES})



set_target_properties(

  ${PROJECT_NAME}

  PROPERTIES VERSION ${PROJECT_VERSION}

             SOVERSION ${PROJECT_VERSION_MAJOR})



target_include_directories(

  ${PROJECT_NAME}

  PUBLIC $)



install(

  TARGETS ${PROJECT_NAME}

  EXPORT ${PROJECT_NAME}Targets

  LIBRARY DESTINATION lib

  ARCHIVE DESTINATION lib

  RUNTIME DESTINATION bin)

通过以上代码块，开发者可以定义项目中各个库的构建和安装规则。

FAQ

问：什么是交叉编译？
- 答：交叉编译是指在一个平台上生成适用于另一个平台的可执行代码的过程，通常用于开发嵌入式系统。
问：如何在CMake中使用工具链文件？
- 答：可以通过设置CMAKE_TOOLCHAIN_FILE变量来指定工具链文件，从而进行交叉编译。
问：CMakeLists.txt中的add_subdirectory命令有什么作用？
- 答：add_subdirectory用于将子目录中的CMakeLists.txt文件包含到主构建中，实现模块化的构建管理。
问：如何配置CMake以支持多平台构建？
- 答：可以通过配置不同的工具链文件和编译选项来实现多平台构建。
问：CMake如何处理依赖库的查找？
- 答：CMake通过find_package和include_directories等命令来查找和包含依赖库，确保编译时能够正确链接。