CMakeにおけるCMAKE_CROSSCOMPILING変数の詳細解説

2024-04-02

CMakeにおけるCMAKE_CROSSCOMPILING変数の詳細解説

CMAKE_CROSSCOMPILING変数は、CMakeがクロスコンパイル環境で実行されているかどうかを判断するために使用されます。これは、ターゲットプラットフォームとビルドプラットフォームが異なる場合に設定されます。

設定方法

CMAKE_CROSSCOMPILING変数は、以下の方法で設定できます。

CMakeコマンドラインオプション：

cmake -DCMAKE_CROSSCOMPILING=ON ...

ツールチェーンファイル：

set(CMAKE_SYSTEM_NAME "Linux")
set(CMAKE_CROSSCOMPILING TRUE)

CMakeLists.txtファイル：

if(NOT CMAKE_CROSSCOMPILING)
  message(FATAL_ERROR "This project must be cross-compiled.")
endif()

影響

CMAKE_CROSSCOMPILING変数が設定されると、CMakeは以下の動作を行います。

クロスコンパイルに必要なツールチェーンファイルを読み込みます。
ターゲットプラットフォームに合わせたビルド設定を生成します。
クロスコンパイルに特化したモジュールやターゲットを検出します。

注意事項

CMAKE_CROSSCOMPILING変数は、CMakeがクロスコンパイル環境で実行されているかどうかを判断するためにのみ使用されます。
ターゲットプラットフォームとビルドプラットフォームが異なる場合、CMAKE_SYSTEM_NAME変数も設定する必要があります。
クロスコンパイルを行うには、適切なツールチェーンがインストールされている必要があります。

補足

以下のキーワードは、Google検索で関連情報を見つけるのに役立ちます。
- CMake CMAKE_CROSSCOMPILING
- CMake クロスコンパイル
- CMake ツールチェーンファイル

例

以下の例は、CMAKE_CROSSCOMPILING変数を使用して、ARMアーキテクチャ向けのプログラムをクロスコンパイルする方法を示しています。

# CMakeLists.txt

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_CROSSCOMPILING TRUE)

find_program(CROSS_COMPILE_CC arm-linux-gcc)

add_executable(my_program my_program.c)

set_target_properties(my_program PROPERTIES
  COMPILE_FLAGS "-mcpu=cortex-a7"
  LINK_FLAGS "-Wl,-rpath-link=/usr/lib/arm-linux-gnueabihf"
)

target_link_libraries(my_program -lstdc++ -lm)

この例では、CMAKE_SYSTEM_NAME変数がLinux-armに設定され、CMAKE_CROSSCOMPILING変数がTRUEに設定されています。これは、CMakeにARMアーキテクチャ向けのプログラムをクロスコンパイルするように指示します。

find_programコマンドは、arm-linux-gccクロスコンパイラを見つけます。このクロスコンパイラは、my_program.cソースファイルを使用して、ARMアーキテクチャ向けのプログラムをコンパイルするために使用されます。

set_target_propertiesコマンドは、my_programターゲットのコンパイルとリンクオプションを設定します。

target_link_librariesコマンドは、my_programターゲットに必要なライブラリをリンクします。

この例は、CMAKE_CROSSCOMPILING変数を使用して、クロスコンパイルを行う方法を示す基本的な例です。詳細については、上記のCMakeドキュメントを参照してください。

CMakeにおけるCMAKE_CROSSCOMPILING変数のサンプルコード

# CMakeLists.txt

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_CROSSCOMPILING TRUE)

find_program(CROSS_COMPILE_CC arm-linux-gcc)

add_executable(my_program my_program.c)

set_target_properties(my_program PROPERTIES
  COMPILE_FLAGS "-mcpu=cortex-a7"
  LINK_FLAGS "-Wl,-rpath-link=/usr/lib/arm-linux-gnueabihf"
)

target_link_libraries(my_program -lstdc++ -lm)

クロスコンパイル環境で動作するテストを実行する

# CMakeLists.txt

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_CROSSCOMPILING TRUE)

find_program(CROSS_COMPILE_CC arm-linux-gcc)

add_executable(my_test my_test.c)

set_target_properties(my_test PROPERTIES
  COMPILE_FLAGS "-mcpu=cortex-a7"
  LINK_FLAGS "-Wl,-rpath-link=/usr/lib/arm-linux-gnueabihf"
)

target_link_libraries(my_test -lstdc++ -lm)

add_test(NAME my_test_cross
  COMMAND ${CROSS_COMPILE_CC} -o my_test_cross my_test.c
  WORKING_DIRECTORY ${CMAKE_BINARY_DIR})

set_tests_properties(my_test_cross PROPERTIES
  RUN_UNDER_EMULATOR "qemu-arm"
)

クロスコンパイルされたプログラムをインストールする

# CMakeLists.txt

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_CROSSCOMPILING TRUE)

find_program(CROSS_COMPILE_CC arm-linux-gcc)

add_executable(my_program my_program.c)

set_target_properties(my_program PROPERTIES
  COMPILE_FLAGS "-mcpu=cortex-a7"
  LINK_FLAGS "-Wl,-rpath-link=/usr/lib/arm-linux-gnueabihf"
)

target_link_libraries(my_program -lstdc++ -lm)

install(TARGETS my_program
  RUNTIME DESTINATION /usr/bin
  LIBRARY DESTINATION /usr/lib
  ARCHIVE DESTINATION /usr/lib/archive)

クロスコンパイル環境で動作するC++プログラムを作成する

# CMakeLists.txt

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_CROSSCOMPILING TRUE)

find_program(CROSS_COMPILE_CXX arm-linux-g++)

add_executable(my_program my_program.cpp)

set_target_properties(my_program PROPERTIES
  COMPILE_FLAGS "-mcpu=cortex-a7"
  LINK_FLAGS "-Wl,-rpath-link=/usr/lib/arm-linux-gnueabihf"
)

target_link_libraries(my_program -lstdc++ -lm)

クロスコンパイル環境で動作するFortranプログラムを作成する

# CMakeLists.txt

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_CROSSCOMPILING TRUE)

find_program(CROSS_COMPILE_FC arm-linux-gfortran)

add_executable(my_program my_program.f90)

set_target_properties(my_program PROPERTIES
  COMPILE_FLAGS "-mcpu=cortex-a7"
  LINK_FLAGS "-Wl,-rpath-link=/usr/lib/arm-linux-gnueabihf"
)

target_link_libraries(my_program -lstdc++ -lm)

これらのサンプルコードは、CMAKE_CROSSCOMPILING変数を使用して、クロスコンパイルを行う方法を示す基本的な例です。詳細については、上記のCMakeドキュメントを参照してください。

CMakeにおけるCMAKE_CROSSCOMPILING変数以外のクロスコンパイル方法

ツールチェーンファイルを使用する

ツールチェーンファイルは、CMakeに特定のターゲットプラットフォーム向けのビルド設定を指示するために使用されます。ツールチェーンファイルは、CMakeの標準ツールチェーンファイルを使用することも、独自に作成することもできます。

例

# toolchain-arm.cmake

set(CMAKE_SYSTEM_NAME "Linux-arm")
set(CMAKE_C_COMPILER   "arm-linux-gcc")
set(CMAKE_CXX_COMPILER  "arm-linux-g++")
set(CMAKE_LINKER        "arm-linux-ld")

# その他のターゲットプラットフォーム固有の設定

上記の例では、toolchain-arm.cmakeという名前のツールチェーンファイルを作成しています。このファイルは、CMakeにARMアーキテクチャ向けのビルド設定を指示します。

CMakeLists.txtファイルで、CMAKE_TOOLCHAIN_FILE変数を使用してツールチェーンファイルを指定できます。

例

# CMakeLists.txt

set(CMAKE_TOOLCHAIN_FILE "toolchain-arm.cmake")

# ここにプロジェクトのビルド設定

手動でコンパイラオプションを設定する

CMAKE_C_COMPILER、CMAKE_CXX_COMPILER、CMAKE_LINKERなどの変数を使用して、手動でコンパイラオプションを設定することもできます。

例

# CMakeLists.txt

set(CMAKE_C_COMPILER   "arm-linux-gcc")
set(CMAKE_CXX_COMPILER  "arm-linux-g++")
set(CMAKE_LINKER        "arm-linux-ld")

set(CMAKE_C_FLAGS "-mcpu=cortex-a7")
set(CMAKE_CXX_FLAGS "-mcpu=cortex-a7")

# ここにプロジェクトのビルド設定

外部ツールを使用する

CPackなどの外部ツールを使用して、クロスコンパイルされたプログラムをパッケージ化することもできます。

例

# CMakeLists.txt

# プロジェクトのビルド設定

cpack(
  BUNDLE "my_program"
  OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/dist
)

上記の例では、CPackを使用して、my_programという名前のプログラムをクロスコンパイルし、distディレクトリにパッケージ化しています。

CMAKE_CROSSCOMPILING変数は、CMakeでクロスコンパイルを行うための最も簡単な方法ですが、他の方法も存在します。どの方法を使用するかは、プロジェクトの要件と環境によって異なります。

CMakeにおけるCMAKE_CROSSCOMPILING変数の詳細解説