src/gromacs/taskassignment/usergpuids.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 routines for handling user-specified GPU IDs.
  42  *
  43  * \author Mark Abraham <mark.j.abraham@gmail.com>
  44  * \ingroup module_taskassignment
  45  * \inlibraryapi
  46  */
  47 #ifndef GMX_TASKASSIGNMENT_USERGPUIDS_H
  48 #define GMX_TASKASSIGNMENT_USERGPUIDS_H
  49
  50 #include <cstddef>
  51
  52 #include <string>
  53 #include <vector>
  54
  55 #include "gromacs/utility/arrayref.h"
  56
  57 struct gmx_gpu_info_t;
  58
  59 namespace gmx
  60 {
  61
  62 /*! \brief Parse a GPU ID specifier string into a container describing device IDs exposed to the run.
  63  *
  64  * \param[in]   gpuIdString  String like "013" or "0,1,3" typically
  65  *                           supplied by the user to mdrun -gpu_id.
  66  *                           Must contain only unique decimal digits, or only decimal
  67  *                           digits separated by comma delimiters. A terminal
  68  *                           comma is accceptable (and required to specify a
  69  *                           single ID that is larger than 9).
  70  *
  71  * \returns  A vector of unique GPU IDs.
  72  *
  73  * \throws   std::bad_alloc     If out of memory.
  74  *           InvalidInputError  If an invalid character is found (ie not a digit or ',') or if
  75  *                              identifiers are duplicated in the specifier list.
  76  */
  77 std::vector<int> parseUserGpuIdString(const std::string& gpuIdString);
  78
  79 /*! \brief Implement GPU ID selection by returning the available GPU
  80  * IDs on this physical node that are compatible.
  81  *
  82  * If the string supplied by the user is empty, then return the IDs of
  83  * all compatible GPUs on this physical node. Otherwise, check the
  84  * user specified compatible GPUs and return their IDs.
  85  *
  86  * \param[in]  gpuInfo                Information detected about GPUs on this physical node
  87  * \param[in]  gpuIdsAvailableString  String like "013" or "0,1,3" typically
  88  *                                    supplied by the user to mdrun -gpu_id.
  89  *                                    Must contain only unique decimal digits, or only decimal
  90  *                                    digits separated by comma delimiters. A terminal
  91  *                                    comma is accceptable (and required to specify a
  92  *                                    single ID that is larger than 9).
  93  *
  94  * \returns  A vector of unique compatible GPU IDs on this physical node.
  95  *
  96  * \throws   std::bad_alloc     If out of memory.
  97  *           InvalidInputError  If an invalid character is found (ie not a digit or ',') or if
  98  *                              identifiers are duplicated in the specifier list.
  99  *           InvalidInputError  If gpuIdsAvailableString specifies GPU IDs that are
 100  *                              not compatible.
 101  */
 102 std::vector<int> makeGpuIdsToUse(const gmx_gpu_info_t& gpuInfo, const std::string& gpuIdsAvailableString);
 103
 104 /*! \brief Parse a GPU ID specifier string into a container describing device ID to task mapping.
 105  *
 106  * \param[in]   gpuIdString  String like "0011" or "0,0,1,1" typically
 107  *                           supplied by the user to mdrun -gputasks.
 108  *                           Must contain only decimal digits, or only decimal
 109  *                           digits separated by comma delimiters. A terminal
 110  *                           comma is accceptable (and required to specify a
 111  *                           single ID that is larger than 9).
 112  *
 113  * \returns  A vector of GPU IDs.
 114  *
 115  * \throws   std::bad_alloc     If out of memory.
 116  *           InvalidInputError  If an invalid character is found (ie not a digit or ',').
 117  */
 118 std::vector<int> parseUserTaskAssignmentString(const std::string& gpuIdString);
 119
 120
 121 /*! \brief Make a vector containing \c numGpuTasks IDs of the IDs found in \c compatibleGpus.
 122  *
 123  * \throws  std::bad_alloc          If out of memory
 124  *
 125  * \returns A sorted vector of IDs of compatible vectors, whose
 126  * length matches that of the number of GPU tasks required.
 127  */
 128 std::vector<int> makeGpuIds(ArrayRef<const int> compatibleGpus, size_t numGpuTasks);
 129
 130 /*! \brief Convert a container of GPU deviced IDs to a string that
 131  * can be used by gmx tune_pme as input to mdrun -gputasks.
 132  *
 133  * Produce a valid input for mdrun -gputasks that refers to the device
 134  * IDs in \c gpuIds but produces a mapping for \c
 135  * totalNumberOfTasks tasks. Note that gmx tune_pme does not
 136  * currently support filling mdrun -gputasks.
 137  *
 138  * \param[in]   gpuIds              Container of device IDs
 139  * \param[in]   totalNumberOfTasks  Total number of tasks for the output mapping produced by the returned string.
 140  *
 141  * \returns  A string that is suitable to pass to mdrun -gputasks.
 142  *
 143  * \throws   std::bad_alloc     If out of memory.
 144  */
 145 std::string makeGpuIdString(const std::vector<int>& gpuIds, int totalNumberOfTasks);
 146
 147 /*! \brief Check that all user-selected GPUs are compatible.
 148  *
 149  * Given the \c gpuIds and \c hardwareInfo, throw if
 150  * any selected GPUs is not compatible.
 151  *
 152  * The error is given with a suitable descriptive message, which will
 153  * have context if this check is done after the hardware detection
 154  * results have been reported to the user. However, note that only the
 155  * GPUs detected on the master rank are reported, because of the
 156  * existing limitations of that reporting.
 157  *
 158  * \todo Note that the selected GPUs can be different on each rank,
 159  * and the IDs of compatible GPUs can be different on each node, so
 160  * this routine ought to do communication to determine whether all
 161  * ranks are able to proceed. Currently this relies on the MPI runtime
 162  * to kill the other processes because GROMACS lacks the appropriate
 163  * infrastructure to do a good job of coordinating error messages and
 164  * behaviour across MPMD ranks and multiple simulations.
 165  *
 166  * \param[in]   gpu_info        Information detected about GPUs
 167  * \param[in]   compatibleGpus  Vector of GPUs that are compatible
 168  * \param[in]   gpuIds          The GPU IDs selected by the user.
 169  *
 170  * \throws  std::bad_alloc          If out of memory
 171  *          InconsistentInputError  If the assigned GPUs are not valid
 172  */
 173 void checkUserGpuIds(const gmx_gpu_info_t&   gpu_info,
 174                      const std::vector<int>& compatibleGpus,
 175                      const std::vector<int>& gpuIds);
 176
 177 } // namespace gmx
 178
 179 #endif