3.5 檢測OpenMP的并行環境 · cmake-cookbook

# 3.5 檢測OpenMP的并行環境 **NOTE**:*此示例代碼可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-03/recipe-05 中找到，有一個C++和一個Fortran示例。該示例在CMake 3.5版(或更高版本)中是有效的，并且已經在GNU/Linux、macOS和Windows上進行過測試。https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-03/recipe-05 中也有一個適用于CMake 3.5的示例。* 目前，市面上的計算機幾乎都是多核機器，對于性能敏感的程序，我們必須關注這些多核處理器，并在編程模型中使用并發。OpenMP是多核處理器上并行性的標準之一。為了從OpenMP并行化中獲得性能收益，通常不需要修改或重寫現有程序。一旦確定了代碼中的性能關鍵部分，例如：使用分析工具，程序員就可以通過預處理器指令，指示編譯器為這些區域生成可并行的代碼。本示例中，我們將展示如何編譯一個包含OpenMP指令的程序(前提是使用一個支持OpenMP的編譯器)。有許多支持OpenMP的Fortran、C和C++編譯器。對于相對較新的CMake版本，為OpenMP提供了非常好的支持。本示例將展示如何在使用CMake 3.9或更高版本時，使用簡單C++和Fortran程序來鏈接到OpenMP。 **NOTE**:*根據Linux發行版的不同，Clang編譯器的默認版本可能不支持OpenMP。使用或非蘋果版本的Clang(例如，Conda提供的)或GNU編譯器,除非單獨安裝libomp庫(https://iscinumpy.gitlab.io/post/omp-on-high-sierra/ )，否則本節示例將無法在macOS上工作。* ## 準備工作 C和C++程序可以通過包含`omp.h`頭文件和鏈接到正確的庫，來使用OpenMP功能。編譯器將在性能關鍵部分之前添加預處理指令，并生成并行代碼。在本示例中，我們將構建以下示例源代碼(`example.cpp`)。這段代碼從1到N求和，其中N作為命令行參數: ```c++ #include <iostream> #include <omp.h> #include <string> int main(int argc, char *argv[]) { std::cout << "number of available processors: " << omp_get_num_procs() << std::endl; std::cout << "number of threads: " << omp_get_max_threads() << std::endl; auto n = std::stol(argv[1]); std::cout << "we will form sum of numbers from 1 to " << n << std::endl; // start timer auto t0 = omp_get_wtime(); auto s = 0LL; #pragma omp parallel for reduction(+ : s) for (auto i = 1; i <= n; i++) { s += i; } // stop timer auto t1 = omp_get_wtime(); std::cout << "sum: " << s << std::endl; std::cout << "elapsed wall clock time: " << t1 - t0 << " seconds" << std::endl; return 0; } ``` 在Fortran語言中，需要使用`omp_lib`模塊并鏈接到庫。在性能關鍵部分之前的代碼注釋中，可以再次使用并行指令。例如：`F90`需要包含以下內容: ```fortran program example use omp_lib implicit none integer(8) :: i, n, s character(len=32) :: arg real(8) :: t0, t1 print *, "number of available processors:", omp_get_num_procs() print *, "number of threads:", omp_get_max_threads() call get_command_argument(1, arg) read(arg , *) n print *, "we will form sum of numbers from 1 to", n ! start timer t0 = omp_get_wtime() s = 0 !$omp parallel do reduction(+:s) do i = 1, n s = s + i end do ! stop timer t1 = omp_get_wtime() print *, "sum:", s print *, "elapsed wall clock time (seconds):", t1 - t0 end program ``` ## 具體實施對于C++和Fortran的例子，`CMakeLists.txt`將遵循一個模板，該模板在這兩種語言上很相似： 1. 兩者都定義了CMake最低版本、項目名稱和語言(CXX或Fortran；我們將展示C++版本): ```cmake cmake_minimum_required(VERSION 3.9 FATAL_ERROR) project(recipe-05 LANGUAGES CXX) ``` 2. 使用C++11標準: ```cmake set(CMAKE_CXX_STANDARD 11) set(CMAKE_CXX_EXTENSIONS OFF) set(CMAKE_CXX_STANDARD_REQUIRED ON) ``` 3. 調用find_package來搜索OpenMP: ```cmake find_package(OpenMP REQUIRED) ``` 4. 最后，我們定義可執行目標，并鏈接到FindOpenMP模塊提供的導入目標(在Fortran的情況下，我們鏈接到`OpenMP::OpenMP_Fortran`): ```cmake add_executable(example example.cpp) target_link_libraries(example PUBLIC OpenMP::OpenMP_CXX ) ``` 5. 現在，可以配置和構建代碼了: ```shell $ mkdir -p build $ cd build $ cmake .. $ cmake --build . ``` 6. 并行測試(在本例中使用了4個內核): ```shell $ ./example 1000000000 number of available processors: 4 number of threads: 4 we will form sum of numbers from 1 to 1000000000 sum: 500000000500000000 elapsed wall clock time: 1.08343 seconds ``` 7. 為了比較，我們可以重新運行這個例子，并將OpenMP線程的數量設置為1: ```shell $ env OMP_NUM_THREADS=1 ./example 1000000000 number of available processors: 4 number of threads: 1 we will form sum of numbers from 1 to 1000000000 sum: 500000000500000000 elapsed wall clock time: 2.96427 seconds ``` ## 工作原理我們的示例很簡單：編譯代碼，并運行在多個內核上時，我們會看到加速效果。加速效果并不是`OMP_NUM_THREADS`的倍數，不過本示例中并不關心，因為我們更關注的是如何使用CMake配置需要使用OpenMP的項目。我們發現鏈接到OpenMP非常簡單，這要感謝`FindOpenMP`模塊: ```cmake target_link_libraries(example PUBLIC OpenMP::OpenMP_CXX ) ``` 我們不關心編譯標志或包含目錄——這些設置和依賴項是在`OpenMP::OpenMP_CXX`中定義的(`IMPORTED`類型)。如第1章第3節中提到的，`IMPORTED`庫是偽目標，它完全是我們自己項目的外部依賴項。要使用OpenMP，需要設置一些編譯器標志，包括目錄和鏈接庫。所有這些都包含在`OpenMP::OpenMP_CXX`的屬性上，并通過使用`target_link_libraries`命令傳遞給`example`。這使得在CMake中，使用庫變得非常容易。我們可以使用`cmake_print_properties`命令打印接口的屬性，該命令由`CMakePrintHelpers.CMake`模塊提供: ```cmake include(CMakePrintHelpers) cmake_print_properties( TARGETS OpenMP::OpenMP_CXX PROPERTIES INTERFACE_COMPILE_OPTIONS INTERFACE_INCLUDE_DIRECTORIES INTERFACE_LINK_LIBRARIES ) ``` 所有屬性都有`INTERFACE_`前綴，因為這些屬性對所需目標，需要以接口形式提供，并且目標以接口的方式使用OpenMP。對于低于3.9的CMake版本: ```cmake add_executable(example example.cpp) target_compile_options(example PUBLIC ${OpenMP_CXX_FLAGS} ) set_target_properties(example PROPERTIES LINK_FLAGS ${OpenMP_CXX_FLAGS} ) ``` 對于低于3.5的CMake版本，我們需要為Fortran項目顯式定義編譯標志。在這個示例中，我們討論了C++和Fortran。相同的參數和方法對于C項目也有效。