CMakeの変数 CMAKE_BUILD_RPATH_USE_ORIGIN を使うべき？

CMakeの変数 CMAKE_BUILD_RPATH_USE_ORIGIN の詳細解説

CMAKE_BUILD_RPATH_USE_ORIGIN は、ビルドツリー内の共有ライブラリへの参照を相対パスで解決するかどうかを制御する CMake 変数です。これは、ビルドツリーを移動したり、異なる環境で実行したりする場合に、アプリケーションの再配置可能性と信頼性を向上させるのに役立ちます。

デフォルト値

CMAKE_BUILD_RPATH_USE_ORIGIN のデフォルト値は、プラットフォームによって異なります。

• Linux、FreeBSD、OpenBSD、NetBSD、DragonFly BSD: TRUE
• macOS: FALSE
• Windows: FALSE

設定方法

CMAKE_BUILD_RPATH_USE_ORIGIN は、CMake のコマンドラインオプション、CMakeLists.txt ファイル、または CMAKE_MODULE ファイルで設定できます。

• コマンドラインオプション:

cmake -DCMAKE_BUILD_RPATH_USE_ORIGIN=TRUE ..

• CMakeLists.txt ファイル:

set(CMAKE_BUILD_RPATH_USE_ORIGIN TRUE)

• CMAKE_MODULE ファイル:

cmake_minimum_required(VERSION 3.14)

set(CMAKE_BUILD_RPATH_USE_ORIGIN TRUE)

影響を受けるもの

CMAKE_BUILD_RPATH_USE_ORIGIN は、以下のターゲットプロパティに影響を与えます。

• BUILD_RPATH: ビルドツリー内の共有ライブラリへの参照を格納します。
• BUILD_RPATH_USE_LINK_PATH: BUILD_RPATH のエントリがリンクパスから生成されるかどうかを制御します。

使用例

CMAKE_BUILD_RPATH_USE_ORIGIN は、以下のシナリオで役立ちます。

• ビルドツリーを移動する場合: CMAKE_BUILD_RPATH_USE_ORIGIN を TRUE に設定すると、ビルドツリーを移動しても、アプリケーションは必要な共有ライブラリを見つけることができます。
• 異なる環境で実行する場合: CMAKE_BUILD_RPATH_USE_ORIGIN を TRUE に設定すると、異なる環境でアプリケーションを実行しても、アプリケーションは必要な共有ライブラリを見つけることができます。

注意事項

• CMAKE_BUILD_RPATH_USE_ORIGIN は、ビルドツリー内の共有ライブラリへの参照のみを解決します。システムインストールされた共有ライブラリへの参照は影響を受けません。
• CMAKE_BUILD_RPATH_USE_ORIGIN は、すべてのプラットフォームでサポートされているわけではありません。使用前に、ターゲットプラットフォームでサポートされていることを確認してください。
• CMAKE_BUILD_RPATH_USE_ORIGIN を使用すると、アプリケーションのセキュリティが低下する可能性があります。詳細については、CMake のドキュメントを参照してください。

補足

CMAKE_BUILD_RPATH_USE_ORIGIN は、CMake の高度な機能です。使用方法を理解していない場合は、使用しないことをお勧めします。

CMakeLists.txt ファイルのサンプルコード

cmake_minimum_required(VERSION 3.14)

project(MyProject)

add_executable(my_program main.cpp)

オプションの指定

cmake_minimum_required(VERSION 3.14)

project(MyProject)

set(CMAKE_CXX_STANDARD 17)

add_executable(my_program main.cpp)

target_link_libraries(my_program
    ${CMAKE_THREAD_LIBS_INIT}
    ${CMAKE_DL_LIBS})

サブディレクトリの処理

cmake_minimum_required(VERSION 3.14)

project(MyProject)

add_subdirectory(src)

add_executable(my_program main.cpp)

target_link_libraries(my_program
    ${CMAKE_THREAD_LIBS_INIT}
    ${CMAKE_DL_LIBS})

外部ライブラリの使用

cmake_minimum_required(VERSION 3.14)

project(MyProject)

find_package(Threads REQUIRED)

add_executable(my_program main.cpp)

target_link_libraries(my_program
    ${CMAKE_THREAD_LIBS_INIT}
    ${CMAKE_DL_LIBS})

インストール

cmake_minimum_required(VERSION 3.14)

project(MyProject)

add_executable(my_program main.cpp)

install(TARGETS my_program
    RUNTIME DESTINATION bin
    LIBRARY DESTINATION lib)

テスト

cmake_minimum_required(VERSION 3.14)

project(MyProject)

add_executable(my_program main.cpp)

add_test(NAME MyTest
    COMMAND my_program)

enable_testing()

CMAKE_MODULE ファイルのサンプルコード

cmake_minimum_required(VERSION 3.14)

set(CMAKE_BUILD_RPATH_USE_ORIGIN TRUE)

これらのサンプルコードは、CMake の基本的な使用方法を理解するのに役立ちます。詳細については、CMake のドキュメントを参照してください。

CMakeでビルドツリー内の共有ライブラリへの参照を解決する他の方法

絶対パスを使用する

共有ライブラリの絶対パスを直接指定することで、参照を解決することができます。ただし、この方法はビルドツリーを移動するときに問題が発生する可能性があります。

相対パスを使用する

共有ライブラリの相対パスを指定することで、参照を解決することができます。ただし、この方法はアプリケーションのインストール場所に依存するため、移植性が低くなります。

インストール済み共有ライブラリを使用する

共有ライブラリをシステムにインストールすることで、参照を解決することができます。ただし、この方法はすべてのプラットフォームでサポートされているわけではありません。

シンボリックリンクを使用する

共有ライブラリへのシンボリックリンクを作成することで、参照を解決することができます。ただし、この方法はシンボリックリンクが壊れる可能性があるため、信頼性が低くなります。

CMake の rpath オプションを使用する

rpath オプションを使用して、ランタイム時に共有ライブラリを探す場所を指定することができます。ただし、この方法はすべてのプラットフォームでサポートされているわけではありません。

CPack を使用して、アプリケーションをパッケージ化することで、共有ライブラリを含むすべての必要なファイルを一緒に配布することができます。