src/gromacs/taskassignment/decidegpuusage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019,2020,2021, 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 /*! \libinternal \file
  36  * \brief Declares functionality for deciding whether tasks will run on GPUs.
  37  *
  38  * \author Mark Abraham <mark.j.abraham@gmail.com>
  39  * \ingroup module_taskassignment
  40  * \inlibraryapi
  41  */
  42
  43 #ifndef GMX_TASKASSIGNMENT_DECIDEGPUUSAGE_H
  44 #define GMX_TASKASSIGNMENT_DECIDEGPUUSAGE_H
  45
  46 #include <vector>
  47
  48 struct gmx_hw_info_t;
  49 struct gmx_mtop_t;
  50 struct t_inputrec;
  51 enum class PmeRunMode;
  52
  53 namespace gmx
  54 {
  55
  56 class MDLogger;
  57
  58 //! Record where a compute task is targetted.
  59 enum class TaskTarget : int
  60 {
  61     Auto,
  62     Cpu,
  63     Gpu
  64 };
  65
  66 //! Help pass GPU-emulation parameters with type safety.
  67 enum class EmulateGpuNonbonded : bool
  68 {
  69     //! Do not emulate GPUs.
  70     No,
  71     //! Do emulate GPUs.
  72     Yes
  73 };
  74
  75 /*! \libinternal
  76  *  \brief Structure that holds boolean flags corresponding to the development
  77  *        features present enabled through environment variables.
  78  *
  79  */
  80 struct DevelopmentFeatureFlags
  81 {
  82     //! True if the Buffer ops development feature is enabled
  83     // TODO: when the trigger of the buffer ops offload is fully automated this should go away
  84     bool enableGpuBufferOps = false;
  85     //! If true, forces 'mdrun -update auto' default to 'gpu'
  86     bool forceGpuUpdateDefault = false;
  87     //! True if the GPU halo exchange development feature is enabled
  88     bool enableGpuHaloExchange = false;
  89     //! True if the PME PP direct communication GPU development feature is enabled
  90     bool enableGpuPmePPComm = false;
  91     //! True if the CUDA-aware MPI is being used for GPU direct communication feature
  92     bool usingCudaAwareMpi = false;
  93 };
  94
  95
  96 class MDAtoms;
  97
  98 /*! \brief Decide whether this thread-MPI simulation will run
  99  * nonbonded tasks on GPUs.
 100  *
 101  * The number of GPU tasks and devices influences both the choice of
 102  * the number of ranks, and checks upon any such choice made by the
 103  * user. So we need to consider this before any automated choice of
 104  * the number of thread-MPI ranks.
 105  *
 106  * \param[in] nonbondedTarget              The user's choice for mdrun -nb for where to assign
 107  *                                         short-ranged nonbonded interaction tasks.
 108  * \param[in] haveAvailableDevices         Whether there are available devices.
 109  * \param[in] userGpuTaskAssignment        The user-specified assignment of GPU tasks to device IDs.
 110  * \param[in] emulateGpuNonbonded          Whether we will emulate GPU calculation of nonbonded
 111  *                                         interactions.
 112  * \param[in] buildSupportsNonbondedOnGpu  Whether GROMACS was built with GPU support.
 113  * \param[in] nonbondedOnGpuIsUseful       Whether computing nonbonded interactions on a GPU is
 114  *                                         useful for this calculation.
 115  * \param[in] numRanksPerSimulation        The number of ranks in each simulation.
 116  *
 117  * \returns    Whether the simulation will run nonbonded tasks on GPUs.
 118  *
 119  * \throws     std::bad_alloc          If out of memory
 120  *             InconsistentInputError  If the user requirements are inconsistent. */
 121 bool decideWhetherToUseGpusForNonbondedWithThreadMpi(TaskTarget              nonbondedTarget,
 122                                                      bool                    haveAvailableDevices,
 123                                                      const std::vector<int>& userGpuTaskAssignment,
 124                                                      EmulateGpuNonbonded     emulateGpuNonbonded,
 125                                                      bool buildSupportsNonbondedOnGpu,
 126                                                      bool nonbondedOnGpuIsUseful,
 127                                                      int  numRanksPerSimulation);
 128
 129 /*! \brief Decide whether this thread-MPI simulation will run
 130  * PME tasks on GPUs.
 131  *
 132  * The number of GPU tasks and devices influences both the choice of
 133  * the number of ranks, and checks upon any such choice made by the
 134  * user. So we need to consider this before any automated choice of
 135  * the number of thread-MPI ranks.
 136  *
 137  * \param[in]  useGpuForNonbonded        Whether GPUs will be used for nonbonded interactions.
 138  * \param[in]  pmeTarget                 The user's choice for mdrun -pme for where to assign
 139  *                                       long-ranged PME nonbonded interaction tasks.
 140  * \param[in]  numDevicesToUse           The number of compatible GPUs that the user permitted us to use.
 141  * \param[in]  userGpuTaskAssignment     The user-specified assignment of GPU tasks to device IDs.
 142  * \param[in]  hardwareInfo              Hardware information
 143  * \param[in]  inputrec                  The user input
 144  * \param[in]  numRanksPerSimulation     The number of ranks in each simulation.
 145  * \param[in]  numPmeRanksPerSimulation  The number of PME ranks in each simulation.
 146  *
 147  * \returns    Whether the simulation will run PME tasks on GPUs.
 148  *
 149  * \throws     std::bad_alloc          If out of memory
 150  *             InconsistentInputError  If the user requirements are inconsistent. */
 151 bool decideWhetherToUseGpusForPmeWithThreadMpi(bool                    useGpuForNonbonded,
 152                                                TaskTarget              pmeTarget,
 153                                                int                     numDevicesToUse,
 154                                                const std::vector<int>& userGpuTaskAssignment,
 155                                                const gmx_hw_info_t&    hardwareInfo,
 156                                                const t_inputrec&       inputrec,
 157                                                int                     numRanksPerSimulation,
 158                                                int                     numPmeRanksPerSimulation);
 159
 160 /*! \brief Decide whether the simulation will try to run nonbonded
 161  * tasks on GPUs.
 162  *
 163  * The final decision cannot be made until after the duty of the rank
 164  * is known. But we need to know if nonbonded will run on GPUs for
 165  * setting up DD (particularly rlist) and determining duty. If the
 166  * user requires GPUs for the tasks of that duty, then it will be an
 167  * error when none are found.
 168  *
 169  * With thread-MPI, calls have been made to
 170  * decideWhetherToUseGpusForNonbondedWithThreadMpi() and
 171  * decideWhetherToUseGpusForPmeWithThreadMpi() to help determine
 172  * the number of ranks and run some checks, but the final
 173  * decision is made in this routine, along with many more
 174  * consistency checks.
 175  *
 176  * \param[in]  nonbondedTarget             The user's choice for mdrun -nb for where to assign short-ranged nonbonded interaction tasks.
 177  * \param[in]  userGpuTaskAssignment       The user-specified assignment of GPU tasks to device IDs.
 178  * \param[in]  emulateGpuNonbonded         Whether we will emulate GPU calculation of nonbonded interactions.
 179  * \param[in]  buildSupportsNonbondedOnGpu Whether GROMACS was build with GPU support.
 180  * \param[in]  nonbondedOnGpuIsUseful      Whether computing nonbonded interactions on a GPU is useful for this calculation.
 181  * \param[in]  gpusWereDetected            Whether compatible GPUs were detected on any node.
 182  *
 183  * \returns    Whether the simulation will run nonbonded and PME tasks, respectively, on GPUs.
 184  *
 185  * \throws     std::bad_alloc          If out of memory
 186  *             InconsistentInputError  If the user requirements are inconsistent. */
 187 bool decideWhetherToUseGpusForNonbonded(TaskTarget              nonbondedTarget,
 188                                         const std::vector<int>& userGpuTaskAssignment,
 189                                         EmulateGpuNonbonded     emulateGpuNonbonded,
 190                                         bool                    buildSupportsNonbondedOnGpu,
 191                                         bool                    nonbondedOnGpuIsUseful,
 192                                         bool                    gpusWereDetected);
 193
 194 /*! \brief Decide whether the simulation will try to run tasks of
 195  * different types on GPUs.
 196  *
 197  * The final decision cannot be made until after the duty of the rank
 198  * is known. But we need to know if nonbonded will run on GPUs for
 199  * setting up DD (particularly rlist) and determining duty. If the
 200  * user requires GPUs for the tasks of that duty, then it will be an
 201  * error when none are found.
 202  *
 203  * With thread-MPI, calls have been made to
 204  * decideWhetherToUseGpusForNonbondedWithThreadMpi() and
 205  * decideWhetherToUseGpusForPmeWithThreadMpi() to help determine
 206  * the number of ranks and run some checks, but the final
 207  * decision is made in this routine, along with many more
 208  * consistency checks.
 209  *
 210  * \param[in]  useGpuForNonbonded        Whether GPUs will be used for nonbonded interactions.
 211  * \param[in]  pmeTarget                 The user's choice for mdrun -pme for where to assign long-ranged PME nonbonded interaction tasks.
 212  * \param[in]  userGpuTaskAssignment     The user-specified assignment of GPU tasks to device IDs.
 213  * \param[in]  hardwareInfo              Hardware information
 214  * \param[in]  inputrec                  The user input
 215  * \param[in]  numRanksPerSimulation     The number of ranks in each simulation.
 216  * \param[in]  numPmeRanksPerSimulation  The number of PME ranks in each simulation.
 217  * \param[in]  gpusWereDetected          Whether compatible GPUs were detected on any node.
 218  *
 219  * \returns    Whether the simulation will run nonbonded and PME tasks, respectively, on GPUs.
 220  *
 221  * \throws     std::bad_alloc          If out of memory
 222  *             InconsistentInputError  If the user requirements are inconsistent. */
 223 bool decideWhetherToUseGpusForPme(bool                    useGpuForNonbonded,
 224                                   TaskTarget              pmeTarget,
 225                                   const std::vector<int>& userGpuTaskAssignment,
 226                                   const gmx_hw_info_t&    hardwareInfo,
 227                                   const t_inputrec&       inputrec,
 228                                   int                     numRanksPerSimulation,
 229                                   int                     numPmeRanksPerSimulation,
 230                                   bool                    gpusWereDetected);
 231
 232 /*! \brief Determine PME run mode.
 233  *
 234  * Given the PME task assignment in \p useGpuForPme and the user-provided
 235  * FFT task target in \p pmeFftTarget, returns a PME run mode for the
 236  * current run. It also checks the compatibility of the two.
 237  *
 238  * \note Aborts the run upon incompatible values of \p useGpuForPme and \p pmeFftTarget.
 239  *
 240  * \param[in]  useGpuForPme              PME task assignment, true if PME task is mapped to the GPU.
 241  * \param[in]  pmeFftTarget              The user's choice for -pmefft for where to assign the FFT
 242  * work of the PME task. \param[in]  inputrec                  The user input record
 243  * */
 244 PmeRunMode determinePmeRunMode(bool useGpuForPme, const TaskTarget& pmeFftTarget, const t_inputrec& inputrec);
 245
 246 /*! \brief Decide whether the simulation will try to run bonded tasks on GPUs.
 247  *
 248  * \param[in]  useGpuForNonbonded        Whether GPUs will be used for nonbonded interactions.
 249  * \param[in]  useGpuForPme              Whether GPUs will be used for PME interactions.
 250  * \param[in]  bondedTarget              The user's choice for mdrun -bonded for where to assign tasks.
 251  * \param[in]  inputrec                  The user input.
 252  * \param[in]  mtop                      The global topology.
 253  * \param[in]  numPmeRanksPerSimulation  The number of PME ranks in each simulation, can be -1 for auto.
 254  * \param[in]  gpusWereDetected          Whether compatible GPUs were detected on any node.
 255  *
 256  * \returns    Whether the simulation will run bondeded tasks on GPUs.
 257  *
 258  * \throws     std::bad_alloc          If out of memory
 259  *             InconsistentInputError  If the user requirements are inconsistent. */
 260 bool decideWhetherToUseGpusForBonded(bool              useGpuForNonbonded,
 261                                      bool              useGpuForPme,
 262                                      TaskTarget        bondedTarget,
 263                                      const t_inputrec& inputrec,
 264                                      const gmx_mtop_t& mtop,
 265                                      int               numPmeRanksPerSimulation,
 266                                      bool              gpusWereDetected);
 267
 268 /*! \brief Decide whether to use GPU for update.
 269  *
 270  * \param[in]  isDomainDecomposition        Whether there more than one domain.
 271  * \param[in]  useUpdateGroups              If the constraints can be split across domains.
 272  * \param[in]  pmeRunMode                   PME running mode: CPU, GPU or mixed.
 273  * \param[in]  havePmeOnlyRank              If there is a PME-only rank in the simulation.
 274  * \param[in]  useGpuForNonbonded           Whether GPUs will be used for nonbonded interactions.
 275  * \param[in]  updateTarget                 User choice for running simulation on GPU.
 276  * \param[in]  gpusWereDetected             Whether compatible GPUs were detected on any node.
 277  * \param[in]  inputrec                     The user input.
 278  * \param[in]  mtop                         The global topology.
 279  * \param[in]  useEssentialDynamics         If essential dynamics is active.
 280  * \param[in]  doOrientationRestraints      If orientation restraints are enabled.
 281  * \param[in]  haveFrozenAtoms              If this simulation has frozen atoms (see Issue #3920).
 282  * \param[in]  doRerun                      It this is a rerun.
 283  * \param[in]  devFlags                     GPU development / experimental feature flags.
 284  * \param[in]  mdlog                        MD logger.
 285  *
 286  * \returns    Whether complete simulation can be run on GPU.
 287  * \throws     std::bad_alloc            If out of memory
 288  *             InconsistentInputError    If the user requirements are inconsistent.
 289  */
 290 bool decideWhetherToUseGpuForUpdate(bool                           isDomainDecomposition,
 291                                     bool                           useUpdateGroups,
 292                                     PmeRunMode                     pmeRunMode,
 293                                     bool                           havePmeOnlyRank,
 294                                     bool                           useGpuForNonbonded,
 295                                     TaskTarget                     updateTarget,
 296                                     bool                           gpusWereDetected,
 297                                     const t_inputrec&              inputrec,
 298                                     const gmx_mtop_t&              mtop,
 299                                     bool                           useEssentialDynamics,
 300                                     bool                           doOrientationRestraints,
 301                                     bool                           haveFrozenAtoms,
 302                                     bool                           doRerun,
 303                                     const DevelopmentFeatureFlags& devFlags,
 304                                     const gmx::MDLogger&           mdlog);
 305
 306
 307 /*! \brief Decide whether to use GPU for halo exchange.
 308  *
 309  * \param[in]  devFlags                     GPU development / experimental feature flags.
 310  * \param[in]  havePPDomainDecomposition    Whether PP domain decomposition is in use.
 311  * \param[in]  useGpuForNonbonded           Whether GPUs will be used for nonbonded interactions.
 312  * \param[in]  useModularSimulator          Whether modularsimulator is in use.
 313  * \param[in]  doRerun                      Whether this is a rerun.
 314  * \param[in]  haveEnergyMinimization       Whether energy minimization is in use.
 315  *
 316  * \returns    Whether halo exchange can be run on GPU.
 317  */
 318 bool decideWhetherToUseGpuForHalo(const DevelopmentFeatureFlags& devFlags,
 319                                   bool                           havePPDomainDecomposition,
 320                                   bool                           useGpuForNonbonded,
 321                                   bool                           useModularSimulator,
 322                                   bool                           doRerun,
 323                                   bool                           haveEnergyMinimization);
 324
 325 } // namespace gmx
 326
 327 #endif