CMake ルールを定義する

GitHub でソースを見る

投稿者: Mason Tran

SiLabs からの寄稿者

CMake のビルドシステムは、ビルド ターゲットを定義する CMakeLists.txt ファイルに依存しています。リポジトリのルートにある CMakeLists.txt はビルドツリーの最上位にあり、ビルドプロセスで使用するさまざまなターゲット、オプション、マクロを定義するのに適しています。

最初に定義する値は、プロジェクト名とサポートされているプラットフォームです。

この例では、プロジェクト名を ot-efr32、バージョンを 0.0.1 に設定します。また、ot-efr32 でサポートされている efr32 プラットフォームのリストである変数 EFR32_PLATFORM_VALUES も定義します。この例のために複数のプラットフォームを定義しているが、_PLATFORM_VALUES 変数のプラットフォームを 1 つにしても問題ない。

cmake_minimum_required(VERSION 3.10.2)
project(ot-efr32 VERSION 0.0.1)

set(EFR32_PLATFORM_VALUES
    "efr32mg1"
    "efr32mg12"
    "efr32mg13"
    "efr32mg21"
)

CMakeLists.txt ファイルには、サポートされていないプラットフォーム用にリリースされたビルドを中止するためのチェックが含まれています。

set_property(CACHE EFR32_PLATFORM PROPERTY STRINGS ${EFR32_PLATFORM_VALUES})
if(NOT EFR32_PLATFORM IN_LIST EFR32_PLATFORM_VALUES)
    message(FATAL_ERROR "Please select a supported platform: ${EFR32_PLATFORM_VALUES}")
endif()

次に定義する必要がある変数は OT_PLATFORM_LIB です。この変数は、プラットフォームにリンクするために OpenThread サンプル アプリケーションで使用されます。

set(OT_PLATFORM_LIB "openthread-${EFR32_PLATFORM}")

OpenThread CMake のオプション

CMake 変数を定義することで、OpenThread のさまざまな機能を有効または無効にできます。

ot-efr32 プラットフォームでは、外部の mbedTLS ライブラリ silabs-mbedtls が使用されます。

set(OT_BUILTIN_MBEDTLS_MANAGEMENT OFF CACHE BOOL "disable builtin mbedtls management" FORCE)
set(OT_EXTERNAL_MBEDTLS "silabs-mbedtls" CACHE STRING "use silabs mbedtls" FORCE)
set(OT_MBEDTLS ${OT_EXTERNAL_MBEDTLS})

出力ディレクトリを定義する

さまざまなターゲット ファイルの出力ディレクトリは、以下の変数を使用して構成できます。

set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)

OpenThread をビルドツリーに追加する

ビルドツリーに openthread サブモジュールを含めるには:

add_subdirectory(openthread)

ビルド プロパティを OpenThread に渡す

このファイルの最後のセクションでは、ビルド プロパティ（定義、オプション、インクルード ディレクトリなど）を定義できます。これらのプロパティは openthread ビルドツリーとプラットフォーム ライブラリに追加します。

これらの定義を追加する簡単な方法は、ot-config ターゲットを使用することです。このターゲットは phony ターゲットで、構成を定義するためだけに使用されます。openthread のほぼすべての CMake ターゲットとリンクされています。

# Define config filename macros
target_compile_definitions(ot-config INTERFACE
    OPENTHREAD_CONFIG_FILE="openthread-core-efr32-config.h"
    OPENTHREAD_PROJECT_CORE_CONFIG_FILE="openthread-core-efr32-config.h"
    OPENTHREAD_CORE_CONFIG_PLATFORM_CHECK_FILE="openthread-core-efr32-config-check.h"
)

# Disable -Wshadow and -Wpedantic
target_compile_options(ot-config INTERFACE
    -Wno-shadow
    -Wno-pedantic
)

# Add platform dirs to "include" dirs
target_include_directories(ot-config INTERFACE
    ${PROJECT_SOURCE_DIR}/src/src
    ${PROJECT_SOURCE_DIR}/src/${EFR32_PLATFORM}
    ${PROJECT_SOURCE_DIR}/src/${EFR32_PLATFORM}/crypto
)

ビルドツリーにサブディレクトリを追加する

最上位の構成が定義されたので、次はビルドサブディレクトリに別のサブディレクトリを追加します。

src フォルダには、プラットフォーム抽象化レイヤのソースコードがあります。third_party フォルダには、サードパーティのコードが含まれます。

リポジトリにサンプル アプリケーションを含める場合は、examples フォルダを作成し、ビルドツリーにも追加します。

add_subdirectory(src)
add_subdirectory(third_party)

# Optional
add_subdirectory(examples)

src ディレクトリ

これはリポジトリの中心となるもので、プラットフォーム抽象化レイヤが実装されています。他にも必要なファイルがいくつか含まれています。

src/arm-none-eabi.cmake

これは、CMake がビルドプロセスで使用するいくつかの変数を定義するツールチェーン ファイルです。最初に、このファイルの ot-efr32 バージョンをコピーして、プラットフォームに合わせて変更することをおすすめします。

src/CMakeLists.txt

ここで、プラットフォーム ライブラリのソースファイル、パス、コンパイラ フラグを定義します。単一プラットフォームのみをサポートするリポジトリの場合、このファイルの良い例は ot-cc2538 です。

単一のリポジトリで複数のプラットフォームをサポートできます。また、複数のプラットフォーム リポジトリを参照できます。ot-efr32 と ot-nrf528xx をご覧ください。