1 # See for https://openmp.llvm.org/SupportAndFAQ.html for instructions on how
2 # to build offload with CMake.
4 cmake_minimum_required(VERSION 3.20.0)
5 set(LLVM_SUBPROJECT_TITLE "liboffload")
7 if ("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
8 set(OPENMP_STANDALONE_BUILD TRUE)
9 project(offload C CXX ASM)
11 set(OPENMP_STANDALONE_BUILD FALSE)
14 # Check that the library can actually be built.
15 if(APPLE OR WIN32 OR WASM)
16 message(WARNING "libomptarget cannot be built on Windows and MacOS X!")
18 elseif(NOT "cxx_std_17" IN_LIST CMAKE_CXX_COMPILE_FEATURES)
19 message(WARNING "Host compiler must support C++17 to build libomptarget!")
21 elseif(NOT CMAKE_SIZEOF_VOID_P EQUAL 8)
22 message(WARNING "libomptarget on 32-bit systems is not supported!")
26 if(OPENMP_STANDALONE_BUILD)
27 set(OFFLOAD_LIBDIR_SUFFIX "" CACHE STRING
28 "Suffix of lib installation directory, e.g. 64 => lib64")
29 set(OFFLOAD_INSTALL_LIBDIR "lib${OFFLOAD_LIBDIR_SUFFIX}" CACHE STRING
30 "Path where built offload libraries should be installed.")
32 # When building in tree we install the runtime according to the LLVM settings.
33 if(LLVM_ENABLE_PER_TARGET_RUNTIME_DIR AND NOT APPLE)
34 set(OFFLOAD_INSTALL_LIBDIR lib${LLVM_LIBDIR_SUFFIX}/${LLVM_DEFAULT_TARGET_TRIPLE} CACHE STRING
35 "Path where built offload libraries should be installed.")
37 set(OFFLOAD_INSTALL_LIBDIR "lib${LLVM_LIBDIR_SUFFIX}" CACHE STRING
38 "Path where built offload libraries should be installed.")
42 set(LLVM_COMMON_CMAKE_UTILS ${CMAKE_CURRENT_SOURCE_DIR}/../cmake)
44 # Add path for custom modules
45 list(INSERT CMAKE_MODULE_PATH 0
46 "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
47 "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
48 "${CMAKE_CURRENT_SOURCE_DIR}/../runtimes/cmake/Modules"
49 "${LLVM_COMMON_CMAKE_UTILS}"
50 "${LLVM_COMMON_CMAKE_UTILS}/Modules"
53 if (OPENMP_STANDALONE_BUILD)
54 # CMAKE_BUILD_TYPE was not set, default to Release.
55 if (NOT CMAKE_BUILD_TYPE)
56 set(CMAKE_BUILD_TYPE Release)
59 # Group common settings.
60 set(OPENMP_ENABLE_WERROR FALSE CACHE BOOL
61 "Enable -Werror flags to turn warnings into errors for supporting compilers.")
62 set(OPENMP_LIBDIR_SUFFIX "" CACHE STRING
63 "Suffix of lib installation directory, e.g. 64 => lib64")
64 # Do not use OPENMP_LIBDIR_SUFFIX directly, use OPENMP_INSTALL_LIBDIR.
65 set(OPENMP_INSTALL_LIBDIR "lib${OPENMP_LIBDIR_SUFFIX}")
67 # Used by llvm_add_tool() and tests.
68 set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_CURRENT_BINARY_DIR})
70 # Group test settings.
71 set(OPENMP_TEST_C_COMPILER ${CMAKE_C_COMPILER} CACHE STRING
72 "C compiler to use for testing OpenMP runtime libraries.")
73 set(OPENMP_TEST_CXX_COMPILER ${CMAKE_CXX_COMPILER} CACHE STRING
74 "C++ compiler to use for testing OpenMP runtime libraries.")
75 set(OPENMP_TEST_Fortran_COMPILER ${CMAKE_Fortran_COMPILER} CACHE STRING
76 "FORTRAN compiler to use for testing OpenMP runtime libraries.")
77 set(OPENMP_LLVM_TOOLS_DIR "" CACHE PATH "Path to LLVM tools for testing.")
79 set(CMAKE_CXX_STANDARD 17 CACHE STRING "C++ standard to conform to")
80 set(CMAKE_CXX_STANDARD_REQUIRED NO)
81 set(CMAKE_CXX_EXTENSIONS NO)
83 set(OPENMP_ENABLE_WERROR ${LLVM_ENABLE_WERROR})
84 # If building in tree, we honor the same install suffix LLVM uses.
85 set(OPENMP_INSTALL_LIBDIR "lib${LLVM_LIBDIR_SUFFIX}")
88 set(OPENMP_TEST_C_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang)
89 set(OPENMP_TEST_CXX_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang++)
91 set(OPENMP_TEST_C_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang.exe)
92 set(OPENMP_TEST_CXX_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang++.exe)
97 set(OPENMP_TEST_Fortran_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/flang)
99 set(OPENMP_TEST_Fortran_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/flang.exe)
102 # Set fortran test compiler if flang is found
103 if (EXISTS "${OPENMP_TEST_Fortran_COMPILER}")
104 message("Using local flang build at ${OPENMP_TEST_Fortran_COMPILER}")
106 unset(OPENMP_TEST_Fortran_COMPILER)
109 # If not standalone, set CMAKE_CXX_STANDARD but don't set the global cache value,
110 # only set it locally for OpenMP.
111 set(CMAKE_CXX_STANDARD 17)
112 set(CMAKE_CXX_STANDARD_REQUIRED NO)
113 set(CMAKE_CXX_EXTENSIONS NO)
116 # Set the path of all resulting libraries to a unified location so that it can
117 # be used for testing.
118 set(LIBOMPTARGET_LIBRARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
119 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${LIBOMPTARGET_LIBRARY_DIR})
120 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${LIBOMPTARGET_LIBRARY_DIR})
121 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${LIBOMPTARGET_LIBRARY_DIR})
123 if(NOT LLVM_LIBRARY_OUTPUT_INTDIR)
124 set(LIBOMPTARGET_INTDIR ${LIBOMPTARGET_LIBRARY_DIR})
126 set(LIBOMPTARGET_INTDIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
129 # Get dependencies for the different components of the project.
130 include(LibomptargetGetDependencies)
132 # Set up testing infrastructure.
133 include(OpenMPTesting)
135 include(CheckCXXCompilerFlag)
136 check_cxx_compiler_flag(-Werror=global-constructors OFFLOAD_HAVE_WERROR_CTOR)
138 # LLVM source tree is required at build time for libomptarget
139 if (NOT LIBOMPTARGET_LLVM_INCLUDE_DIRS)
140 message(FATAL_ERROR "Missing definition for LIBOMPTARGET_LLVM_INCLUDE_DIRS")
143 if(DEFINED LIBOMPTARGET_BUILD_CUDA_PLUGIN OR
144 DEFINED LIBOMPTARGET_BUILD_AMDGPU_PLUGIN)
145 message(WARNING "Option removed, use 'LIBOMPTARGET_PLUGINS_TO_BUILD' instead")
148 set(LIBOMPTARGET_ALL_PLUGIN_TARGETS amdgpu cuda host)
149 set(LIBOMPTARGET_PLUGINS_TO_BUILD "all" CACHE STRING
150 "Semicolon-separated list of plugins to use: cuda, amdgpu, host or \"all\".")
152 if(LIBOMPTARGET_PLUGINS_TO_BUILD STREQUAL "all")
153 set(LIBOMPTARGET_PLUGINS_TO_BUILD ${LIBOMPTARGET_ALL_PLUGIN_TARGETS})
156 if(NOT CMAKE_SYSTEM_NAME MATCHES "Linux" AND
157 "host" IN_LIST LIBOMPTARGET_PLUGINS_TO_BUILD)
158 message(STATUS "Not building host plugin: only Linux systems are supported")
159 list(REMOVE_ITEM LIBOMPTARGET_PLUGINS_TO_BUILD "host")
161 if(NOT (CMAKE_SYSTEM_PROCESSOR MATCHES "(x86_64)|(ppc64le)|(aarch64)$"
162 AND CMAKE_SYSTEM_NAME MATCHES "Linux"))
163 if("amdgpu" IN_LIST LIBOMPTARGET_PLUGINS_TO_BUILD)
164 message(STATUS "Not building AMDGPU plugin: only support AMDGPU in "
165 "Linux x86_64, ppc64le, or aarch64 hosts")
166 list(REMOVE_ITEM LIBOMPTARGET_PLUGINS_TO_BUILD "amdgpu")
168 if("cuda" IN_LIST LIBOMPTARGET_PLUGINS_TO_BUILD)
169 message(STATUS "Not building CUDA plugin: only support CUDA in "
170 "Linux x86_64, ppc64le, or aarch64 hosts")
171 list(REMOVE_ITEM LIBOMPTARGET_PLUGINS_TO_BUILD "cuda")
174 message(STATUS "Building the offload library with support for "
175 "the \"${LIBOMPTARGET_PLUGINS_TO_BUILD}\" plugins")
177 set(LIBOMPTARGET_DLOPEN_PLUGINS "${LIBOMPTARGET_PLUGINS_TO_BUILD}" CACHE STRING
178 "Semicolon-separated list of plugins to use 'dlopen' for runtime linking")
180 set(LIBOMPTARGET_ENUM_PLUGIN_TARGETS "")
181 foreach(plugin IN LISTS LIBOMPTARGET_PLUGINS_TO_BUILD)
182 set(LIBOMPTARGET_ENUM_PLUGIN_TARGETS
183 "${LIBOMPTARGET_ENUM_PLUGIN_TARGETS}PLUGIN_TARGET(${plugin})\n")
185 string(STRIP ${LIBOMPTARGET_ENUM_PLUGIN_TARGETS} LIBOMPTARGET_ENUM_PLUGIN_TARGETS)
187 ${CMAKE_CURRENT_SOURCE_DIR}/include/Shared/Targets.def.in
188 ${CMAKE_CURRENT_BINARY_DIR}/include/Shared/Targets.def
191 include_directories(${LIBOMPTARGET_LLVM_INCLUDE_DIRS})
193 # This is a list of all the targets that are supported/tested right now.
194 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} aarch64-unknown-linux-gnu")
195 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} aarch64-unknown-linux-gnu-LTO")
196 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} amdgcn-amd-amdhsa")
197 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} powerpc64le-ibm-linux-gnu")
198 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} powerpc64le-ibm-linux-gnu-LTO")
199 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} powerpc64-ibm-linux-gnu")
200 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} powerpc64-ibm-linux-gnu-LTO")
201 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} x86_64-unknown-linux-gnu")
202 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} x86_64-unknown-linux-gnu-LTO")
203 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} nvptx64-nvidia-cuda")
204 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} nvptx64-nvidia-cuda-LTO")
205 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} nvptx64-nvidia-cuda-JIT-LTO")
206 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} s390x-ibm-linux-gnu")
207 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} s390x-ibm-linux-gnu-LTO")
208 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} riscv64-unknown-linux-gnu")
209 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} riscv64-unknown-linux-gnu-LTO")
210 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} loongarch64-unknown-linux-gnu")
211 set (LIBOMPTARGET_ALL_TARGETS "${LIBOMPTARGET_ALL_TARGETS} loongarch64-unknown-linux-gnu-LTO")
213 # Once the plugins for the different targets are validated, they will be added to
214 # the list of supported targets in the current system.
215 set (LIBOMPTARGET_SYSTEM_TARGETS "")
216 set (LIBOMPTARGET_TESTED_PLUGINS "")
218 # Check whether using debug mode. In debug mode, allow dumping progress
219 # messages at runtime by default. Otherwise, it can be enabled
220 # independently using the LIBOMPTARGET_ENABLE_DEBUG option.
221 string( TOLOWER "${CMAKE_BUILD_TYPE}" LIBOMPTARGET_CMAKE_BUILD_TYPE)
222 if(LIBOMPTARGET_CMAKE_BUILD_TYPE MATCHES debug)
223 option(LIBOMPTARGET_ENABLE_DEBUG "Allow debug output with the environment variable LIBOMPTARGET_DEBUG=1" ON)
225 option(LIBOMPTARGET_ENABLE_DEBUG "Allow debug output with the environment variable LIBOMPTARGET_DEBUG=1" OFF)
227 if(LIBOMPTARGET_ENABLE_DEBUG)
228 add_definitions(-DOMPTARGET_DEBUG)
231 # No exceptions and no RTTI, except if requested.
232 set(offload_compile_flags -fno-exceptions)
233 if(NOT LLVM_ENABLE_RTTI)
234 set(offload_compile_flags ${offload_compile_flags} -fno-rtti)
236 if(OFFLOAD_HAVE_WERROR_CTOR)
237 list(APPEND offload_compile_flags -Werror=global-constructors)
240 # TODO: Consider enabling LTO by default if supported.
241 # https://cmake.org/cmake/help/latest/module/CheckIPOSupported.html can be used
242 # to test for working LTO. However, before CMake 3.24 this will test the
243 # default linker and ignore options such as LLVM_ENABLE_LLD. As a result, CMake
244 # would test whether LTO works with the default linker but build with another one.
245 # In a typical scenario, libomptarget is compiled with the in-tree Clang, but
246 # linked with ld.gold, which requires the LLVMgold plugin, when it actually
247 # would work with the lld linker (or also fail because the system lld is too old
248 # to understand opaque pointers). Using gcc as the compiler would pass the test, but fail
249 # when linking with lld since does not understand gcc's LTO format.
250 set(LIBOMPTARGET_USE_LTO FALSE CACHE BOOL "Use LTO for the offload runtimes if available")
251 if (LIBOMPTARGET_USE_LTO)
252 # CMake sets CMAKE_CXX_COMPILE_OPTIONS_IPO depending on the compiler and is
253 # also what CheckIPOSupported uses to test support.
254 list(APPEND offload_compile_flags ${CMAKE_CXX_COMPILE_OPTIONS_IPO})
255 list(APPEND offload_link_flags ${CMAKE_CXX_COMPILE_OPTIONS_IPO})
258 if(OPENMP_STANDALONE_BUILD)
259 if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
261 OUTPUT_STRIP_TRAILING_WHITESPACE
262 COMMAND ${CMAKE_CXX_COMPILER} --print-resource-dir
263 RESULT_VARIABLE COMMAND_RETURN_CODE
264 OUTPUT_VARIABLE COMPILER_RESOURCE_DIR
268 set(LIBOMP_HAVE_OMPT_SUPPORT FALSE)
269 set(LIBOMP_OMPT_SUPPORT FALSE)
272 LIBOMP_OMP_TOOLS_INCLUDE_DIR
276 ${COMPILER_RESOURCE_DIR}/include
277 ${CMAKE_INSTALL_PREFIX}/include
280 if(LIBOMP_OMP_TOOLS_INCLUDE_DIR)
281 set(LIBOMP_HAVE_OMPT_SUPPORT TRUE)
282 set(LIBOMP_OMPT_SUPPORT TRUE)
285 # LLVM_LIBRARY_DIRS set by find_package(LLVM) in LibomptargetGetDependencies
291 ${CMAKE_INSTALL_PREFIX}/lib
301 ${COMPILER_RESOURCE_DIR}/include
302 ${CMAKE_INSTALL_PREFIX}/include
305 get_filename_component(LIBOMP_LIBRARY_DIR ${LIBOMP_STANDALONE} DIRECTORY)
307 set(OPENMP_TEST_FLAGS "" CACHE STRING
308 "Extra compiler flags to send to the test compiler.")
309 set(OPENMP_TEST_OPENMP_FLAGS ${OPENMP_TEST_COMPILER_OPENMP_FLAGS} CACHE STRING
310 "OpenMP compiler flag to use for testing OpenMP runtime libraries.")
311 set(LIBOMPTARGET_OPENMP_HEADER_FOLDER "${LIBOMP_INCLUDE_DIR}" CACHE STRING
312 "Path to folder containing omp.h")
313 set(LIBOMPTARGET_OPENMP_HOST_RTL_FOLDER "${LIBOMP_LIBRARY_DIR}" CACHE STRING
314 "Path to folder containing libomp.so, and libLLVMSupport.so with profiling enabled")
317 macro(pythonize_bool var)
325 if(OPENMP_STANDALONE_BUILD OR TARGET omp)
326 # Check LIBOMP_HAVE_VERSION_SCRIPT_FLAG
327 include(LLVMCheckCompilerLinkerFlag)
329 llvm_check_compiler_linker_flag(C "-Wl,--version-script=${CMAKE_CURRENT_LIST_DIR}/../openmp/runtime/src/exports_test_so.txt" LIBOMP_HAVE_VERSION_SCRIPT_FLAG)
333 # OMPT support for libomptarget
334 # Follow host OMPT support and check if host support has been requested.
335 # LIBOMP_HAVE_OMPT_SUPPORT indicates whether host OMPT support has been implemented.
336 # LIBOMP_OMPT_SUPPORT indicates whether host OMPT support has been requested (default is ON).
337 # LIBOMPTARGET_OMPT_SUPPORT indicates whether target OMPT support has been requested (default is ON).
338 set(OMPT_TARGET_DEFAULT FALSE)
339 if ((LIBOMP_HAVE_OMPT_SUPPORT) AND (LIBOMP_OMPT_SUPPORT) AND (NOT WIN32))
340 set (OMPT_TARGET_DEFAULT TRUE)
342 set(LIBOMPTARGET_OMPT_SUPPORT ${OMPT_TARGET_DEFAULT} CACHE BOOL "OMPT-target-support?")
343 if ((OMPT_TARGET_DEFAULT) AND (LIBOMPTARGET_OMPT_SUPPORT))
344 add_definitions(-DOMPT_SUPPORT=1)
345 message(STATUS "OMPT target enabled")
347 set(LIBOMPTARGET_OMPT_SUPPORT FALSE)
348 message(STATUS "OMPT target disabled")
351 pythonize_bool(LIBOMPTARGET_OMPT_SUPPORT)
353 if(${LLVM_LIBC_GPU_BUILD})
354 set(LIBOMPTARGET_HAS_LIBC TRUE)
356 set(LIBOMPTARGET_HAS_LIBC FALSE)
358 set(LIBOMPTARGET_GPU_LIBC_SUPPORT ${LIBOMPTARGET_HAS_LIBC} CACHE BOOL
359 "Libomptarget support for the GPU libc")
360 pythonize_bool(LIBOMPTARGET_GPU_LIBC_SUPPORT)
362 set(LIBOMPTARGET_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include)
363 set(LIBOMPTARGET_BINARY_INCLUDE_DIR ${CMAKE_CURRENT_BINARY_DIR}/include)
364 message(STATUS "OpenMP tools dir in libomptarget: ${LIBOMP_OMP_TOOLS_INCLUDE_DIR}")
365 if(LIBOMP_OMP_TOOLS_INCLUDE_DIR)
366 include_directories(${LIBOMP_OMP_TOOLS_INCLUDE_DIR})
369 set(LIBOMPTARGET_LLVM_LIBRARY_DIR "${LLVM_LIBRARY_DIR}" CACHE STRING
370 "Path to folder containing llvm library libomptarget.so")
371 set(LIBOMPTARGET_LLVM_LIBRARY_INTDIR "${LIBOMPTARGET_INTDIR}" CACHE STRING
372 "Path to folder where intermediate libraries will be output")
374 # Build offloading plugins and device RTLs if they are available.
375 add_subdirectory(plugins-nextgen)
376 add_subdirectory(DeviceRTL)
377 add_subdirectory(tools)
379 # Build target agnostic offloading library.
380 add_subdirectory(src)
382 add_subdirectory(tools/offload-tblgen)
383 add_subdirectory(liboffload)
386 add_subdirectory(test)
388 # Add unit tests if GMock/GTest is present
389 if (EXISTS ${LLVM_THIRD_PARTY_DIR}/unittest)
390 if (NOT TARGET llvm_gtest)
391 add_subdirectory(${LLVM_THIRD_PARTY_DIR}/unittest ${CMAKE_CURRENT_BINARY_DIR}/third-party/unittest)
393 add_subdirectory(unittests)