src/gromacs/taskassignment/reportgpuusage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019,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 /*! \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 /*! \internal
  40  * \file
  41  * \brief Declares routine for reporting GPU usage.
  42  *
  43  * \author Mark Abraham <mark.j.abraham@gmail.com>
  44  * \ingroup module_taskassignment
  45  */
  46 #ifndef GMX_TASKASSIGNMENT_REPORTGPUUSAGE_H
  47 #define GMX_TASKASSIGNMENT_REPORTGPUUSAGE_H
  48
  49 #include <cstdlib>
  50
  51 #include <vector>
  52
  53 enum class PmeRunMode;
  54
  55 namespace gmx
  56 {
  57
  58 class MDLogger;
  59 struct GpuTaskMapping;
  60 template<typename T>
  61 class ArrayRef;
  62 using GpuTaskAssignment = std::vector<GpuTaskMapping>;
  63
  64 /*! \brief Log a report on how GPUs are being used on
  65  * the ranks of the physical node of rank 0 of the simulation.
  66  *
  67  * \todo It could be useful to report also whether any nodes differed,
  68  * and in what way.
  69  *
  70  * \param[in]  mdlog                               Logging object.
  71  * \param[in]  gpuTaskAssignmentOnRanksOfThisNode  The selected GPU IDs.
  72  * \param[in]  numGpuTasksOnThisNode               The number of GPU tasks on this node.
  73  * \param[in]  numPpRanks                          Number of PP ranks on this node
  74  * \param[in]  printHostName                       Print the hostname in the usage information
  75  * \param[in]  useGpuForBonded                     Whether GPU PP tasks will do bonded work on GPU
  76  * \param[in]  pmeRunMode                          Describes the execution of PME tasks
  77  * \param[in]  useGpuForUpdate                     Whether update will run on the GPU.
  78  *
  79  * \throws     std::bad_alloc if out of memory */
  80 void reportGpuUsage(const MDLogger&                   mdlog,
  81                     ArrayRef<const GpuTaskAssignment> gpuTaskAssignmentOnRanksOfThisNode,
  82                     size_t                            numGpuTasksOnThisNode,
  83                     size_t                            numPpRanks,
  84                     bool                              printHostName,
  85                     bool                              useGpuForBonded,
  86                     PmeRunMode                        pmeRunMode,
  87                     bool                              useGpuForUpdate);
  88
  89 } // namespace gmx
  90
  91 #endif