mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-01 11:22:21 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
34c0c7754ffdbc03b94de64f55eb046b9bbaec0d
CMake/Modules/FindOpenACC.cmake
Peter Kokot 0fedf1592c Find*: Update *_FOUND variables 
This marks all `<PACKAGENAME>_FOUND` result variables as deprecated
where possible (for `<PackageName>` find modules) to make it clearer
which variable to use.

In CMake 3.3, the FindPackageHandleStandardArgs module was refactored to
set both `<PackageName>_FOUND` and uppercase `<PACKAGENAME>_FOUND`
result variables to the same values. Before that, the FOUND_VAR argument
could be used to set the result variable.

* FindMatlab: Uppercased MATLAB_FOUND is not mentioned as it was never
  documented.
* Documentation for FindPythonInterp and FindPythonLibs modules synced
  accordingly to their deprecation (3.12 instead of 4.2).
* OPENGL_FOUND: deprecation version synced with other find modules.
* DevIL_FOUND was introduced in CMake 3.8. The uppercased variant not
  mentioned as it was previously never documented.

Fixes: #27242
2025-09-23 21:40:58 +02:00

333 lines
11 KiB
CMake
Raw Blame History

# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file LICENSE.rst or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
FindOpenACC
-----------
.. versionadded:: 3.10
Finds and detects the OpenACC support in a compiler:
.. code-block:: cmake
find_package(OpenACC [<version>] [...])
If the compiler supports OpenACC, the flags required to compile with
OpenACC support are returned in variables for the different languages.
Currently, only NVHPC, PGI, GNU and Cray compilers are supported.
Imported Targets
^^^^^^^^^^^^^^^^
This module provides the following :ref:`Imported Targets`:
``OpenACC::OpenACC_<lang>``
.. versionadded:: 3.16
Target encapsulating the usage requirements for using OpenACC from
``<lang>``. This target is available only if OpenACC support is found.
``<lang>`` is one of C, CXX, or Fortran.
Result Variables
^^^^^^^^^^^^^^^^
This module defines the following variables:
``OpenACC_FOUND``
.. versionadded:: 3.25
Boolean indicating that OpenACC flags for at least one language were
found.
This module will set the following variables per language in the
project, where ``<lang>`` is one of C, CXX, or Fortran:
``OpenACC_<lang>_FOUND``
Boolean indicating whether OpenACC support for language ``<lang>`` was
detected.
``OpenACC_<lang>_FLAGS``
OpenACC compiler flags for ``<lang>``, separated by spaces.
``OpenACC_<lang>_OPTIONS``
.. versionadded:: 3.16
OpenACC compiler flags for ``<lang>``, as a list. Suitable for usage
with target_compile_options or target_link_options.
The module will also try to provide the OpenACC version variables:
``OpenACC_<lang>_SPEC_DATE``
Date of the OpenACC specification implemented by the ``<lang>`` compiler.
``OpenACC_<lang>_VERSION_MAJOR``
Major version of OpenACC implemented by the ``<lang>`` compiler.
``OpenACC_<lang>_VERSION_MINOR``
Minor version of OpenACC implemented by the ``<lang>`` compiler.
``OpenACC_<lang>_VERSION``
OpenACC version implemented by the ``<lang>`` compiler.
The specification date is formatted as given in the OpenACC standard:
``yyyymm`` where ``yyyy`` and ``mm`` represents the year and month of
the OpenACC specification implemented by the ``<lang>`` compiler.
Input Variables
^^^^^^^^^^^^^^^
This module accepts the following variables:
``OpenACC_ACCEL_TARGET=<target>``
If set, the correct target accelerator flag set to the ``<target>``
will be returned with the ``OpenACC_<lang>_FLAGS`` variable.
Examples
^^^^^^^^
Finding OpenACC support and linking the imported target to a project target:
.. code-block:: cmake
find_package(OpenACC)
target_link_libraries(example PRIVATE OpenACC::OpenACC_C)
#]=======================================================================]
cmake_policy(PUSH)
cmake_policy(SET CMP0159 NEW) # file(STRINGS) with REGEX updates CMAKE_MATCH_<n>
set(OpenACC_C_CXX_TEST_SOURCE
"
int main(void){
#ifdef _OPENACC
return 0;
#else
breaks_on_purpose
#endif
}
"
)
set(OpenACC_Fortran_TEST_SOURCE
"
program test
#ifndef _OPENACC
breaks_on_purpose
#endif
endprogram test
"
)
set(OpenACC_C_CXX_CHECK_VERSION_SOURCE
"
#include <stdio.h>
const char accver_str[] = { 'I', 'N', 'F', 'O', ':', 'O', 'p', 'e', 'n', 'A',
'C', 'C', '-', 'd', 'a', 't', 'e', '[',
('0' + ((_OPENACC/100000)%10)),
('0' + ((_OPENACC/10000)%10)),
('0' + ((_OPENACC/1000)%10)),
('0' + ((_OPENACC/100)%10)),
('0' + ((_OPENACC/10)%10)),
('0' + ((_OPENACC/1)%10)),
']', '\\0' };
int main(void)
{
puts(accver_str);
return 0;
}
")
set(OpenACC_Fortran_CHECK_VERSION_SOURCE
"
program acc_ver
implicit none
integer, parameter :: zero = ichar('0')
character, dimension(25), parameter :: accver_str =&
(/ 'I', 'N', 'F', 'O', ':', 'O', 'p', 'e', 'n', 'A', 'C', 'C', '-',&
'd', 'a', 't', 'e', '[',&
char(zero + mod(_OPENACC/100000, 10)),&
char(zero + mod(_OPENACC/10000, 10)),&
char(zero + mod(_OPENACC/1000, 10)),&
char(zero + mod(_OPENACC/100, 10)),&
char(zero + mod(_OPENACC/10, 10)),&
char(zero + mod(_OPENACC/1, 10)), ']' /)
print *, accver_str
end program acc_ver
"
)
macro(_OPENACC_PREPARE_SOURCE LANG CONTENT_ID NAME_PREFIX FULLNAME_VAR CONTENT_VAR)
if("${LANG}" STREQUAL "C")
set(${FULLNAME_VAR} "${NAME_PREFIX}.c")
set(${CONTENT_VAR} "${OpenACC_C_CXX_${CONTENT_ID}}")
elseif("${LANG}" STREQUAL "CXX")
set(${FULLNAME_VAR} "${NAME_PREFIX}.cpp")
set(${CONTENT_VAR} "${OpenACC_C_CXX_${CONTENT_ID}}")
elseif("${LANG}" STREQUAL "Fortran")
set(${FULLNAME_VAR} "${NAME_PREFIX}.F90")
set(${CONTENT_VAR} "${OpenACC_Fortran_${CONTENT_ID}}")
endif()
endmacro()
function(_OPENACC_GET_FLAGS_CANDIDATE LANG FLAG_VAR)
set(ACC_FLAG_NVHPC "-acc")
set(ACC_FLAG_PGI "-acc")
set(ACC_FLAG_GNU "-fopenacc")
set(ACC_FLAG_Cray "-h acc")
set(ACC_FLAG_Clang "-fopenacc")
if(DEFINED ACC_FLAG_${CMAKE_${LANG}_COMPILER_ID})
set("${FLAG_VAR}" "${ACC_FLAG_${CMAKE_${LANG}_COMPILER_ID}}" PARENT_SCOPE)
else()
# Fall back to a few common flags.
set("${FLAG_VAR}" ${ACC_FLAG_GNU} ${ACC_FLAG_PGI})
endif()
endfunction()
function(_OPENACC_GET_ACCEL_TARGET_FLAG LANG TARGET FLAG_VAR)
# Find target accelerator flags.
set(ACC_TARGET_FLAG_NVHPC "-ta")
set(ACC_TARGET_FLAG_PGI "-ta")
if(DEFINED ACC_TARGET_FLAG_${CMAKE_${LANG}_COMPILER_ID})
set("${FLAG_VAR}" "${ACC_TARGET_FLAG_${CMAKE_${LANG}_COMPILER_ID}}=${TARGET}" PARENT_SCOPE)
endif()
endfunction()
function(_OPENACC_GET_VERBOSE_FLAG LANG FLAG_VAR)
# Find compiler's verbose flag for OpenACC.
set(ACC_VERBOSE_FLAG_NVHPC "-Minfo=accel")
set(ACC_VERBOSE_FLAG_PGI "-Minfo=accel")
if(DEFINED ACC_VERBOSE_FLAG_${CMAKE_${LANG}_COMPILER_ID})
set("${FLAG_VAR}" "${ACC_VERBOSE_FLAG_${CMAKE_${LANG}_COMPILER_ID}}" PARENT_SCOPE)
endif()
endfunction()
function(_OPENACC_GET_FLAGS LANG FLAG_VAR)
set(FLAG_CANDIDATES "")
_OPENACC_GET_FLAGS_CANDIDATE("${LANG}" FLAG_CANDIDATES)
_OPENACC_PREPARE_SOURCE("${LANG}" TEST_SOURCE OpenACCTryFlag
_OPENACC_TEST_SRC_NAME _OPENACC_TEST_SRC_CONTENT)
foreach(FLAG IN LISTS FLAG_CANDIDATES)
try_compile(OpenACC_FLAG_TEST_RESULT
SOURCE_FROM_VAR "${_OPENACC_TEST_SRC_NAME}" _OPENACC_TEST_SRC_CONTENT
CMAKE_FLAGS "-DCOMPILE_DEFINITIONS:STRING=${FLAG}"
OUTPUT_VARIABLE OpenACC_TRY_COMPILE_OUTPUT
)
if(OpenACC_FLAG_TEST_RESULT)
set("${FLAG_VAR}" "${FLAG}")
if(DEFINED OpenACC_ACCEL_TARGET)
_OPENACC_GET_ACCEL_TARGET_FLAG("${LANG}" "${OpenACC_ACCEL_TARGET}" TARGET_FLAG)
string(APPEND "${FLAG_VAR}" " ${TARGET_FLAG}")
endif()
if(CMAKE_VERBOSE_MAKEFILE)
# -Minfo=accel prints out OpenACC's messages on optimizations.
_OPENACC_GET_VERBOSE_FLAG("${LANG}" OpenACC_VERBOSE_FLAG)
string(APPEND "${FLAG_VAR}" " ${OpenACC_VERBOSE_FLAG}")
endif()
set("${FLAG_VAR}" "${${FLAG_VAR}}" PARENT_SCOPE)
break()
endif()
endforeach()
endfunction()
function(_OPENACC_GET_SPEC_DATE LANG SPEC_DATE)
_OPENACC_PREPARE_SOURCE(${LANG} CHECK_VERSION_SOURCE OpenACCCheckVersion
_OPENACC_TEST_SRC_NAME _OPENACC_TEST_SRC_CONTENT)
set(BIN_FILE "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/FindOpenACC/accver_${LANG}.bin")
try_compile(OpenACC_SPECTEST_${LANG}
SOURCE_FROM_VAR "${_OPENACC_TEST_SRC_NAME}" _OPENACC_TEST_SRC_CONTENT
CMAKE_FLAGS "-DCOMPILE_DEFINITIONS:STRING=${OpenACC_${LANG}_FLAGS}"
COPY_FILE "${BIN_FILE}"
OUTPUT_VARIABLE OUTPUT)
if(${OpenACC_SPECTEST_${LANG}})
file(STRINGS ${BIN_FILE} specstr LIMIT_COUNT 1 REGEX "INFO:OpenACC-date")
set(regex_spec_date ".*INFO:OpenACC-date\\[0*([^]]*)\\].*")
if("${specstr}" MATCHES "${regex_spec_date}")
set(${SPEC_DATE} "${CMAKE_MATCH_1}" PARENT_SCOPE)
endif()
endif()
endfunction()
macro(_OPENACC_SET_VERSION_BY_SPEC_DATE LANG)
set(OpenACC_SPEC_DATE_MAP
# Combined versions, 2.5 onwards
"201510=2.5"
# 2013 08 is the corrected version.
"201308=2.0"
"201306=2.0"
"201111=1.0"
)
string(REGEX MATCHALL "${OpenACC_${LANG}_SPEC_DATE}=([0-9]+)\\.([0-9]+)" _version_match "${OpenACC_SPEC_DATE_MAP}")
if(NOT _version_match STREQUAL "")
set(OpenACC_${LANG}_VERSION_MAJOR ${CMAKE_MATCH_1})
set(OpenACC_${LANG}_VERSION_MINOR ${CMAKE_MATCH_2})
set(OpenACC_${LANG}_VERSION "${OpenACC_${LANG}_VERSION_MAJOR}.${OpenACC_${LANG}_VERSION_MINOR}")
else()
unset(OpenACC_${LANG}_VERSION_MAJOR)
unset(OpenACC_${LANG}_VERSION_MINOR)
unset(OpenACC_${LANG}_VERSION)
endif()
unset(_version_match)
unset(OpenACC_SPEC_DATE_MAP)
endmacro()
include(FindPackageHandleStandardArgs)
foreach (LANG IN ITEMS C CXX Fortran)
if(CMAKE_${LANG}_COMPILER_LOADED)
set(OpenACC_${LANG}_FIND_QUIETLY ${OpenACC_FIND_QUIETLY})
set(OpenACC_${LANG}_FIND_REQUIRED ${OpenACC_FIND_REQUIRED})
set(OpenACC_${LANG}_FIND_VERSION ${OpenACC_FIND_VERSION})
set(OpenACC_${LANG}_FIND_VERSION_EXACT ${OpenACC_FIND_VERSION_EXACT})
if(NOT DEFINED OpenACC_${LANG}_FLAGS)
_OPENACC_GET_FLAGS("${LANG}" OpenACC_${LANG}_FLAGS)
endif()
if(NOT DEFINED OpenACC_${LANG}_OPTIONS)
separate_arguments(OpenACC_${LANG}_OPTIONS NATIVE_COMMAND "${OpenACC_${LANG}_FLAGS}")
endif()
_OPENACC_GET_SPEC_DATE("${LANG}" OpenACC_${LANG}_SPEC_DATE)
_OPENACC_SET_VERSION_BY_SPEC_DATE("${LANG}")
find_package_handle_standard_args(OpenACC_${LANG}
NAME_MISMATCHED
REQUIRED_VARS OpenACC_${LANG}_FLAGS
VERSION_VAR OpenACC_${LANG}_VERSION
)
if(OpenACC_${LANG}_FOUND)
set(OpenACC_FOUND TRUE)
endif()
endif()
endforeach()
foreach (LANG IN ITEMS C CXX Fortran)
if(OpenACC_${LANG}_FOUND AND NOT TARGET OpenACC::OpenACC_${LANG})
add_library(OpenACC::OpenACC_${LANG} INTERFACE IMPORTED)
endif()
if(OpenACC_${LANG}_LIBRARIES)
set_property(TARGET OpenACC::OpenACC_${LANG} PROPERTY
INTERFACE_LINK_LIBRARIES "${OpenACC_${LANG}_LIBRARIES}")
endif()
if(OpenACC_${LANG}_FLAGS)
set_property(TARGET OpenACC::OpenACC_${LANG} PROPERTY
INTERFACE_COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:${LANG}>:SHELL:${OpenACC_${LANG}_FLAGS}>")
set_property(TARGET OpenACC::OpenACC_${LANG} PROPERTY
INTERFACE_LINK_OPTIONS "$<$<COMPILE_LANGUAGE:${LANG}>:SHELL:${OpenACC_${LANG}_FLAGS}>")
unset(_OpenACC_${LANG}_OPTIONS)
endif()
endforeach()
unset(OpenACC_C_CXX_TEST_SOURCE)
unset(OpenACC_Fortran_TEST_SOURCE)
unset(OpenACC_C_CXX_CHECK_VERSION_SOURCE)
unset(OpenACC_Fortran_CHECK_VERSION_SOURCE)
cmake_policy(POP)
Reference in New Issue View Git Blame Copy Permalink