JOB_POOL_PRECOMPILE_HEADER プロパティ徹底解説

CMake の JOB_POOL_PRECOMPILE_HEADER プロパティ

JOB_POOL_PRECOMPILE_HEADER は、Ninja マルチビルドシステムを使用する場合、プリコンパイル済みヘッダー生成の並列処理を制御する CMake プロパティです。このプロパティを設定することで、ビルド時間の短縮を期待できます。

詳細

• 対象: Ninja マルチビルドシステムのみ
• 機能: プリコンパイル済みヘッダー生成の並列度を指定
• デフォルト値: CMAKE_JOB_POOL_COMPILE の値
• 設定方法:
  • ターゲットプロパティとして: set_property(TARGET myexe PROPERTY JOB_POOL_PRECOMPILE_HEADER <pool_name>)
  • CMake 変数として: set(CMAKE_JOB_POOL_PRECOMPILE_HEADER <pool_name>)

設定例

# 2 つのジョブプールを使ってプリコンパイル済みヘッダーを生成
set_property(TARGET myexe PROPERTY JOB_POOL_PRECOMPILE_HEADER two_jobs)

# 全てのターゲットで 4 つのジョブプールを使う
set(CMAKE_JOB_POOL_PRECOMPILE_HEADER four_jobs)

注意事項

• Ninja マルチビルドシステム以外では無視されます。
• ジョブプールは事前に定義しておく必要があります。詳細は JOB_POOLS プロパティを参照してください。
• 並列度を上げすぎると、システム負荷が大きくなり、逆にビルド時間が長くなる可能性があります。

JOB_POOL_PRECOMPILE_HEADER プロパティは、Ninja マルチビルドシステムでプリコンパイル済みヘッダー生成を並列化し、ビルド時間の短縮に役立ちます。設定方法や注意事項を理解し、適切な値を設定することで、効率的なビルドを実現しましょう。

CMake の JOB_POOL_PRECOMPILE_HEADER プロパティ - サンプルコード

ターゲットプロパティとして設定

add_library(mylib SHARED mylib.c mylib.h)

# mylib ターゲットのみ、2 つのジョブプールを使ってプリコンパイル済みヘッダーを生成
set_property(TARGET mylib PROPERTY JOB_POOL_PRECOMPILE_HEADER two_jobs)

add_executable(myexe main.c mylib.h)

target_link_libraries(myexe mylib)

CMake 変数として設定

set(CMAKE_JOB_POOL_SIZE 4)

add_library(mylib1 SHARED mylib1.c mylib1.h)
add_library(mylib2 SHARED mylib2.c mylib2.h)

# 全てのターゲットで、4 つのジョブプールを使ってプリコンパイル済みヘッダーを生成
set(CMAKE_JOB_POOL_PRECOMPILE_HEADER four_jobs)

add_executable(myexe1 main.c mylib1.h)
add_executable(myexe2 main.c mylib2.h)

target_link_libraries(myexe1 mylib1)
target_link_libraries(myexe2 mylib2)

ジョブプールを定義

# 2 つのジョブプールを定義
set(JOB_POOLS two_jobs four_jobs)

set_property(JOB_POOL two_jobs POOL_SIZE 2)
set_property(JOB_POOL four_jobs POOL_SIZE 4)

add_library(mylib SHARED mylib.c mylib.h)

# mylib ターゲットで、two_jobs ジョブプールを使ってプリコンパイル済みヘッダーを生成
set_property(TARGET mylib PROPERTY JOB_POOL_PRECOMPILE_HEADER two_jobs)

add_executable(myexe main.c mylib.h)

target_link_libraries(myexe mylib)

プリコンパイル済みヘッダー生成の有効化/無効化

add_library(mylib SHARED mylib.c mylib.h)

# mylib ターゲットで、プリコンパイル済みヘッダー生成を無効化
set_property(TARGET mylib PROPERTY JOB_POOL_PRECOMPILE_HEADER NO)

add_executable(myexe main.c mylib.h)

target_link_libraries(myexe mylib)

上記のサンプルコードを参考に、JOB_POOL_PRECOMPILE_HEADER プロパティを適切に設定し、ビルド時間の短縮を実現しましょう。

CMake でプリコンパイル済みヘッダー生成を並列化する他の方法

CMAKE_CXX_FLAGS または CMAKE_C_FLAGS に -j オプションを追加することで、コンパイラに並列処理を指示できます。

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -j4")

add_library(mylib SHARED mylib.c mylib.h)

add_executable(myexe main.c mylib.h)

target_link_libraries(myexe mylib)

make の -j オプションを使用

make コマンドに -j オプションを追加することで、ビルド全体の並列処理を指示できます。

cmake ..
make -j4

Ninja マルチビルドシステムは、デフォルトで並列処理を行うため、JOB_POOL_PRECOMPILE_HEADER プロパティを設定する必要はありません。

cmake .. -G Ninja
ninja

比較

どの方法が最適かは、プロジェクトの規模や環境によって異なります。それぞれの方法の特徴を理解し、適切な方法を選択しましょう。