cmake/gmxManageSYCL.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2020, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 # OpenCL required version: 1.2 or newer
  36 set(REQUIRED_SYCL_MIN_VERSION_MAJOR 1)
  37 set(REQUIRED_SYCL_MIN_VERSION_MINOR 2)
  38 set(REQUIRED_SYCL_MIN_VERSION ${REQUIRED_SYCL_MIN_VERSION_MAJOR}.${REQUIRED_SYCL_MIN_VERSION_MINOR})
  39
  40 set(GMX_GPU_SYCL ON)
  41
  42 if(GMX_DOUBLE)
  43     message(FATAL_ERROR "SYCL acceleration is not available in double precision")
  44 endif()
  45
  46 include(gmxFindFlagsForSource)
  47
  48 if(CMAKE_CXX_COMPILER MATCHES "dpcpp")
  49     # At least Intel dpcpp defaults to having SYCL enabled for all code. This leads to two problems:
  50     #
  51     # 1. Compiles take ~3x longer, since every file has to be compiled for multiple targets.
  52     # 2. We get a ton of warnings for the device-specific pass when the compiler sees our SIMD code.
  53     #
  54     # To avoid this, we attempt to find a flag to disable SYCL for non-SYCL files. Unfortunately,
  55     # when using gmx_find_flag_for_source() that includes calling check_cxx_compiler_flag(),
  56     # this in turn exposes a bug in dpcpp, where an object file compiles with -fno-sycl leads to
  57     # a failed link stage (when the same flag is not used). Since none of this is critical, we handle
  58     # it by merely checking if it works to compile a source fils with this flag, and choking if SYCL
  59     # is still enabled.
  60
  61     if(NOT CHECK_DISABLE_SYCL_CXX_FLAGS_QUIETLY)
  62         message(STATUS "Checking for flags to disable SYCL")
  63     endif()
  64
  65     gmx_check_source_compiles_with_flags(
  66         "int main() { return 0; }"
  67         "-fno-sycl"
  68         "CXX"
  69         DISABLE_SYCL_CXX_FLAGS_RESULT)
  70
  71     if(DISABLE_SYCL_CXX_FLAGS_RESULT)
  72         set(DISABLE_SYCL_CXX_FLAGS "-fno-sycl")
  73     endif()
  74     if(NOT CHECK_DISABLE_SYCL_CXX_FLAGS_QUIETLY)
  75         if(DISABLE_SYCL_CXX_FLAGS_RESULT)
  76             message(STATUS "Checking for flags to disable SYCL - -fno-sycl")
  77         else()
  78             message(WARNING "Cannot find flags to disable SYCL for non-SYCL hardware-specific C++ code. Expect many warnings, but they are likely benign.")
  79         endif()
  80         set(CHECK_DISABLE_SYCL_CXX_FLAGS_QUIETLY 1 CACHE INTERNAL "Keep quiet on future calls to detect no-SYCL flags" FORCE)
  81     endif()
  82 endif()
  83
  84 # Find the flags to enable (or re-enable) SYCL with Intel extensions. In case we turned it off above,
  85 # it's important that we check the combination of both flags, to make sure the second one re-enables SYCL.
  86 if(NOT CHECK_SYCL_CXX_FLAGS_QUIETLY)
  87     message(STATUS "Checking for flags to enable SYCL")
  88 endif()
  89 gmx_find_flag_for_source(SYCL_CXX_FLAGS_RESULT
  90     "#include <CL/sycl.hpp>
  91      namespace sycl = cl::sycl;
  92      int main(){
  93          constexpr int length = 1000;
  94          sycl::queue q(sycl::default_selector{});
  95          // Check USM extension
  96          sycl::usm_allocator<int, sycl::usm::alloc::shared> q_alloc{q};
  97          std::vector<int, sycl::usm_allocator<int, sycl::usm::alloc::shared>> v(q_alloc);
  98          v.reserve(length);
  99          for(int i = 0; i < length ; i++) { v.push_back(i); }
 100          q.parallel_for<class whatever>(sycl::range<1>{length}, [=, ptr = v.data()] (sycl::id<1> i){ ptr[i] *= 2; }).wait();
 101          return 0;
 102      }
 103      " "CXX" DISABLE_SYCL_CXX_FLAGS SYCL_CXX_FLAGS "-fsycl")
 104
 105 if(NOT CHECK_SYCL_CXX_FLAGS_QUIETLY)
 106     if(SYCL_CXX_FLAGS_RESULT)
 107         message(STATUS "Checking for flags to enable SYCL - ${SYCL_CXX_FLAGS}")
 108     endif()
 109     set(CHECK_SYCL_CXX_FLAGS_QUIETLY 1 CACHE INTERNAL "Keep quiet on future calls to detect SYCL flags" FORCE)
 110 endif()
 111
 112 if(NOT SYCL_CXX_FLAGS_RESULT)
 113     message(ERROR "Cannot compile SYCL with Intel extensions. Try a different compiler or disable SYCL.")
 114 endif()