src/gromacs/taskassignment/taskassignment.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \defgroup module_taskassignment Assigning simulation tasks to hardware (taskassignment)
  36  * \ingroup group_mdrun
  37  * \brief Provides code that manages assignment of simulation tasks to hardware.
  38  */
  39 /*! \libinternal
  40  * \file
  41  * \brief Declares high-level functionality for managing assigning
  42  * tasks on ranks of a node to hardware on that node, and the factory
  43  * function to build the correct flavours of gmx::INodeTaskAssigner
  44  * required to implement the user's requirements.
  45  *
  46  * \author Mark Abraham <mark.j.abraham@gmail.com>
  47  * \ingroup module_taskassignment
  48  * \inlibraryapi
  49  */
  50 #ifndef GMX_TASKASSIGNMENT_TASKASSIGNMENT_H
  51 #define GMX_TASKASSIGNMENT_TASKASSIGNMENT_H
  52
  53 #include <vector>
  54
  55 #include "gromacs/utility/basedefinitions.h"
  56
  57 struct gmx_device_info_t;
  58 struct gmx_hw_info_t;
  59 struct gmx_multisim_t;
  60 struct t_commrec;
  61
  62 enum class PmeRunMode;
  63
  64 namespace gmx
  65 {
  66
  67 enum class TaskTarget;
  68 class MDLogger;
  69 class PhysicalNodeCommunicator;
  70
  71 /*! \brief Types of compute tasks that can be run on a GPU.
  72  *
  73  * These names refer to existing practice in GROMACS, which is not
  74  * strictly accurate. */
  75 enum class GpuTask : int
  76 {
  77     //! Short-ranged interactions.
  78     Nonbonded,
  79     //! Long-ranged interactions.
  80     Pme,
  81     //! Number of possible tasks.
  82     Count
  83 };
  84
  85 /*! \libinternal
  86  * \brief Specifies the GPU deviceID_ available for task_ to use. */
  87 struct GpuTaskMapping
  88 {
  89     //! The type of this GPU task.
  90     GpuTask task_;
  91     //! Device ID on this node to which this GPU task is mapped.
  92     int deviceId_;
  93 };
  94
  95 //! Container of GPU tasks on a rank, specifying the task type and GPU device ID, e.g. potentially ready for consumption by the modules on that rank.
  96 using GpuTaskAssignment = std::vector<GpuTaskMapping>;
  97
  98 class GpuTaskAssignments;
  99
 100 /*! \libinternal
 101  * \brief Builder for the GpuTaskAssignments for all ranks on this
 102  * node.
 103  *
 104  * This will coordinate the final stages of task assignment and
 105  * reporting, and build the GpuTaskAssignments object used to
 106  * configure the modules that might run tasks on GPUs.
 107  *
 108  * Communicates between ranks on a node to coordinate task assignment
 109  * between them onto available hardware, e.g. accelerators.
 110  *
 111  * \todo Later, this might become a loop over all registered modules
 112  * relevant to the mdp inputs, to find those that have such tasks.
 113  *
 114  * \todo Later we might need the concept of computeTasksOnThisRank,
 115  * from which we construct gpuTasksOnThisRank.
 116  *
 117  * Currently the DD code assigns duty to ranks that can
 118  * include PP work that currently can be executed on a single
 119  * GPU, if present and compatible.  This has to be coordinated
 120  * across PP ranks on a node, with possible multiple devices
 121  * or sharing devices on a node, either from the user
 122  * selection, or automatically. */
 123 class GpuTaskAssignmentsBuilder
 124 {
 125 public:
 126     //! Constructor
 127     GpuTaskAssignmentsBuilder();
 128
 129     /*! \brief Builds a GpuTaskAssignments
 130      *
 131      * This method reconciles
 132      *
 133      *   - user mdrun command-line options,
 134      *   - the results of hardware detection
 135      *   - the duty assigned by the DD setup,
 136      *   - the requested simulation modules, and
 137      *   - the possible existence of multi-simulations
 138      *
 139      * to assign the GPUs on each physical node to the tasks on
 140      * the ranks of that node. It throws InconsistentInputError
 141      * when a/the useful GPU task assignment is not possible.
 142      *
 143      * \param[in]  gpuIdsToUse            The compatible GPUs that the user permitted us to use.
 144      * \param[in]  userGpuTaskAssignment  The user-specified assignment of GPU tasks to device IDs.
 145      * \param[in]  hardwareInfo           The detected hardware
 146      * \param[in]  cr                     Communication object.
 147      * \param[in]  ms                     Multi-simulation handler.
 148      * \param[in]  physicalNodeComm       Communication object for this physical node.
 149      * \param[in]  nonbondedTarget        The user's choice for mdrun -nb for where to assign
 150      *                                    short-ranged nonbonded interaction tasks.
 151      * \param[in]  pmeTarget              The user's choice for mdrun -pme for where to assign
 152      *                                    long-ranged PME nonbonded interaction tasks.
 153      * \param[in]  bondedTarget           The user's choice for mdrun -bonded for where to assign tasks.
 154      * \param[in]  updateTarget           The user's choice for mdrun -update for where to assign tasks.
 155      * \param[in]  useGpuForNonbonded     Whether GPUs will be used for nonbonded interactions.
 156      * \param[in]  useGpuForPme           Whether GPUs will be used for PME interactions.
 157      * \param[in]  rankHasPpTask          Whether this rank has a PP task
 158      * \param[in]  rankHasPmeTask         Whether this rank has a PME task
 159      *
 160      * \throws   std::bad_alloc          If out of memory.
 161      *           InconsistentInputError  If user and/or detected inputs are inconsistent.
 162      */
 163     GpuTaskAssignments build(const std::vector<int>&         gpuIdsToUse,
 164                              const std::vector<int>&         userGpuTaskAssignment,
 165                              const gmx_hw_info_t&            hardwareInfo,
 166                              const t_commrec*                cr,
 167                              const gmx_multisim_t*           ms,
 168                              const PhysicalNodeCommunicator& physicalNodeComm,
 169                              TaskTarget                      nonbondedTarget,
 170                              TaskTarget                      pmeTarget,
 171                              TaskTarget                      bondedTarget,
 172                              TaskTarget                      updateTarget,
 173                              bool                            useGpuForNonbonded,
 174                              bool                            useGpuForPme,
 175                              bool                            rankHasPpTask,
 176                              bool                            rankHasPmeTask);
 177 };
 178
 179 /*! \libinternal
 180  * \brief Contains the GPU task assignment for all ranks on this
 181  * physical node.
 182  *
 183  * This can be used to configure the modules that might run tasks on
 184  * GPUs.
 185  *
 186  * This assignment is made by a GpuTaskAssignmentsBuilder object. */
 187 class GpuTaskAssignments
 188 {
 189 public:
 190     //! Public move constructor to use with the builder
 191     GpuTaskAssignments(GpuTaskAssignments&& source) noexcept = default;
 192
 193 private:
 194     // Let the builder handle construction
 195     friend class GpuTaskAssignmentsBuilder;
 196     //! Private constructor so only the builder can construct
 197     GpuTaskAssignments(const gmx_hw_info_t& hardwareInfo);
 198     /*! \brief Information about hardware on this physical node
 199      *
 200      * The lifetime of the object referred to must exceed that
 201      * of this object. */
 202     const gmx_hw_info_t& hardwareInfo_;
 203     //! The GPU task assignment for all ranks on this node
 204     std::vector<GpuTaskAssignment> assignmentForAllRanksOnThisNode_;
 205     /*! \brief The index of this rank within those on this node.
 206      *
 207      * This is useful for indexing into \c
 208      * assignmentForAllRanksOnThisNode_. */
 209     index indexOfThisRank_ = -1;
 210     //! Number of GPU tasks on this node.
 211     size_t numGpuTasksOnThisNode_ = 0;
 212     //! Number of ranks on this physical node.
 213     size_t numRanksOnThisNode_ = 0;
 214
 215 public:
 216     /*! \brief Log a report on how GPUs are being used on
 217      * the ranks of the physical node of rank 0 of the simulation.
 218      *
 219      * \todo It could be useful to report also whether any nodes differed,
 220      * and in what way.
 221      *
 222      * \param[in]  mdlog           Logging object.
 223      * \param[in]  printHostName   Print the hostname in the usage information
 224      * \param[in]  useGpuForBonded Whether GPU PP tasks will do bonded work on the GPU
 225      * \param[in]  pmeRunMode      Describes the execution of PME tasks
 226      *
 227      * \throws     std::bad_alloc if out of memory */
 228     void reportGpuUsage(const MDLogger& mdlog, bool printHostName, bool useGpuForBonded, PmeRunMode pmeRunMode);
 229     /*! \brief Logs to \c mdlog information that may help a user
 230      * learn how to let mdrun make a task assignment that runs
 231      * faster.
 232      *
 233      * \param[in]  mdlog                        Logging object.
 234      * \param[in]  numCompatibleGpusOnThisNode  The number of compatible GPUs on this node.
 235      * */
 236     void logPerformanceHints(const MDLogger& mdlog, size_t numCompatibleGpusOnThisNode);
 237     /*! \brief Return handle to the initialized GPU to use for the
 238      * nonbonded task on this rank, if any.
 239      *
 240      * Returns nullptr if no such task is assigned to this rank.
 241      *
 242      * \todo This also sets up DLB for device sharing, where
 243      * appropriate, but that responsbility should move
 244      * elsewhere. */
 245     gmx_device_info_t* initNonbondedDevice(const t_commrec* cr) const;
 246     /*! \brief Return handle to the initialized GPU to use for the
 247      * PME task on this rank, if any.
 248      *
 249      * Returns nullptr if no such task is assigned to this rank. */
 250     gmx_device_info_t* initPmeDevice() const;
 251     //! Return whether this rank has a PME task running on a GPU
 252     bool thisRankHasPmeGpuTask() const;
 253     //! Return whether this rank has any task running on a GPU
 254     bool thisRankHasAnyGpuTask() const;
 255 };
 256
 257 //! Function for whether the task of \c mapping has value \c TaskType.
 258 template<GpuTask TaskType>
 259 bool hasTaskType(const GpuTaskMapping& mapping)
 260 {
 261     return mapping.task_ == TaskType;
 262 }
 263
 264 } // namespace gmx
 265
 266 #endif