src/gromacs/nbnxm/opencl/nbnxm_ocl_jit_support.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,2017,2018,2019, 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 /*! \internal \file
  36  *  \brief Defines functions that support JIT compilation (e.g. for OpenCL)
  37  *
  38  *  \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  39  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  40  *  \ingroup module_nbnxm
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <stdlib.h>
  45
  46 #include <cassert>
  47
  48 #include <string>
  49
  50 #include "gromacs/gpu_utils/gpu_utils.h"
  51 #include "gromacs/gpu_utils/ocl_compiler.h"
  52 #include "gromacs/mdtypes/interaction_const.h"
  53 #include "gromacs/mdtypes/md_enums.h"
  54 #include "gromacs/nbnxm/gpu_jit_support.h"
  55 #include "gromacs/nbnxm/nbnxm_gpu.h"
  56 #include "gromacs/pbcutil/ishift.h"
  57 #include "gromacs/utility/cstringutil.h"
  58 #include "gromacs/utility/exceptions.h"
  59 #include "gromacs/utility/fatalerror.h"
  60 #include "gromacs/utility/stringutil.h"
  61
  62 #include "nbnxm_ocl_types.h"
  63
  64 /*! \brief Stringifies the input argument
  65  */
  66 #define STRINGIFY_PARAM(c) #c
  67
  68 /*! \brief Stringifies the result of expansion of a macro argument
  69  */
  70 #define STRINGIFY_MACRO(c) STRINGIFY_PARAM(c)
  71
  72 /*! \brief Array of the defines needed to generate a specific eel flavour
  73  *
  74  * The twin-cutoff entries are not normally used, because those setups are
  75  * not available to the user. FastGen takes care of generating both
  76  * single- and twin-cutoff versions because PME tuning might need both.
  77  */
  78 static const char* kernel_electrostatic_family_definitions[] = {
  79     " -DEL_CUTOFF -DEELNAME=_ElecCut",
  80     " -DEL_RF -DEELNAME=_ElecRF",
  81     " -DEL_EWALD_TAB -DEELNAME=_ElecEwQSTab",
  82     " -DEL_EWALD_TAB -DVDW_CUTOFF_CHECK -DEELNAME=_ElecEwQSTabTwinCut",
  83     " -DEL_EWALD_ANA -DEELNAME=_ElecEw",
  84     " -DEL_EWALD_ANA -DVDW_CUTOFF_CHECK -DEELNAME=_ElecEwTwinCut"
  85 };
  86
  87 /*! \brief Array of the defines needed to generate a specific vdw flavour
  88  */
  89 static const char* kernel_VdW_family_definitions[] = {
  90     " -DVDWNAME=_VdwLJ",
  91     " -DLJ_COMB_GEOM -DVDWNAME=_VdwLJCombGeom",
  92     " -DLJ_COMB_LB -DVDWNAME=_VdwLJCombLB",
  93     " -DLJ_FORCE_SWITCH -DVDWNAME=_VdwLJFsw",
  94     " -DLJ_POT_SWITCH -DVDWNAME=_VdwLJPsw",
  95     " -DLJ_EWALD_COMB_GEOM -DVDWNAME=_VdwLJEwCombGeom",
  96     " -DLJ_EWALD_COMB_LB -DVDWNAME=_VdwLJEwCombLB"
  97 };
  98
  99 /*! \brief Returns a string with the compiler defines required to avoid all flavour generation
 100  *
 101  * For example if flavour eelOclRF with evdwOclFSWITCH, the output will be such that the corresponding
 102  * kernel flavour is generated:
 103  * -DGMX_OCL_FASTGEN          (will replace flavour generator nbnxn_ocl_kernels.clh with nbnxn_ocl_kernels_fastgen.clh)
 104  * -DEL_RF                    (The eelOclRF flavour)
 105  * -DEELNAME=_ElecRF          (The first part of the generated kernel name )
 106  * -DLJ_EWALD_COMB_GEOM       (The evdwOclFSWITCH flavour)
 107  * -DVDWNAME=_VdwLJEwCombGeom (The second part of the generated kernel name )
 108  *
 109  * prune/energy are still generated as originally. It is only the flavour-level that has changed, so that
 110  * only the required flavour for the simulation is compiled.
 111  *
 112  * If eeltype is single-range Ewald, then we need to add the
 113  * twin-cutoff flavour kernels to the JIT, because PME tuning might
 114  * need it. This path sets -DGMX_OCL_FASTGEN_ADD_TWINCUT, which
 115  * triggers the use of nbnxn_ocl_kernels_fastgen_add_twincut.clh. This
 116  * hard-codes the generation of extra kernels that have the same base
 117  * flavour, and add the required -DVDW_CUTOFF_CHECK and "TwinCut" to
 118  * the kernel name.
 119  *
 120  * If FastGen is not active, then nothing needs to be returned. The
 121  * JIT defaults to compiling all kernel flavours.
 122  *
 123  * \param[in]  bFastGen    Whether FastGen should be used
 124  * \param[in]  eeltype     Electrostatics kernel flavour for FastGen
 125  * \param[in]  vdwtype     VDW kernel flavour for FastGen
 126  * \return                 String with the defines if FastGen is active
 127  *
 128  * \throws std::bad_alloc if out of memory
 129  */
 130 static std::string makeDefinesForKernelTypes(bool bFastGen, int eeltype, int vdwtype)
 131 {
 132     std::string defines_for_kernel_types;
 133
 134     if (bFastGen)
 135     {
 136         bool bIsEwaldSingleCutoff = (eeltype == eelOclEWALD_TAB || eeltype == eelOclEWALD_ANA);
 137
 138         if (bIsEwaldSingleCutoff)
 139         {
 140             defines_for_kernel_types += "-DGMX_OCL_FASTGEN_ADD_TWINCUT";
 141         }
 142         else
 143         {
 144             /* This triggers the use of
 145                nbnxn_ocl_kernels_fastgen.clh. */
 146             defines_for_kernel_types += "-DGMX_OCL_FASTGEN";
 147         }
 148         defines_for_kernel_types += kernel_electrostatic_family_definitions[eeltype];
 149         defines_for_kernel_types += kernel_VdW_family_definitions[vdwtype];
 150     }
 151
 152     return defines_for_kernel_types;
 153 }
 154
 155 /*! \brief Compiles nbnxn kernels for OpenCL GPU given by \p mygpu
 156  *
 157  * With OpenCL, a call to this function must not precede nbnxn_gpu_init() (which also calls it).
 158  *
 159  * Doing bFastGen means only the requested kernels are compiled,
 160  * significantly reducing the total compilation time. If false, all
 161  * OpenCL kernels are compiled.
 162  *
 163  * A fatal error results if compilation fails.
 164  *
 165  * \param[inout] nb  Manages OpenCL non-bonded calculations; compiled kernels returned in dev_info members
 166  *
 167  * Does not throw
 168  */
 169 void nbnxn_gpu_compile_kernels(gmx_nbnxn_ocl_t* nb)
 170 {
 171     gmx_bool   bFastGen = TRUE;
 172     cl_program program  = nullptr;
 173
 174     if (getenv("GMX_OCL_NOFASTGEN") != nullptr)
 175     {
 176         bFastGen = FALSE;
 177     }
 178
 179     /* Need to catch std::bad_alloc here and during compilation string
 180        handling. */
 181     try
 182     {
 183         std::string extraDefines =
 184                 makeDefinesForKernelTypes(bFastGen, nb->nbparam->eeltype, nb->nbparam->vdwtype);
 185
 186         /* Here we pass macros and static const int variables defined
 187          * in include files outside the opencl as macros, to avoid
 188          * including those files in the JIT compilation that happens
 189          * at runtime. This is particularly a problem for headers that
 190          * depend on config.h, such as pairlist.h. */
 191         extraDefines += gmx::formatString(
 192                 " -DNBNXN_GPU_CLUSTER_SIZE=%d "
 193                 "%s",
 194                 c_nbnxnGpuClusterSize, /* Defined in nbnxn_pairlist.h */
 195                 (nb->bPrefetchLjParam) ? "-DIATYPE_SHMEM" : "");
 196         try
 197         {
 198             /* TODO when we have a proper MPI-aware logging module,
 199                the log output here should be written there */
 200             program = gmx::ocl::compileProgram(
 201                     stderr, "gromacs/nbnxm/opencl", "nbnxm_ocl_kernels.cl", extraDefines,
 202                     nb->dev_rundata->context, nb->dev_info->ocl_gpu_id.ocl_device_id,
 203                     nb->dev_info->vendor_e);
 204         }
 205         catch (gmx::GromacsException& e)
 206         {
 207             e.prependContext(gmx::formatString("Failed to compile NBNXN kernels for GPU #%s\n",
 208                                                nb->dev_info->device_name));
 209             throw;
 210         }
 211     }
 212     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 213
 214     nb->dev_rundata->program = program;
 215 }