src/gromacs/ewald/pme_gpu_timings.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,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
  36 /*! \internal \file
  37  *  \brief Defines PME GPU timing functions.
  38  *
  39  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  * \ingroup module_ewald
  41  */
  42
  43 #ifndef GMX_EWALD_PME_GPU_TIMINGS_H
  44 #define GMX_EWALD_PME_GPU_TIMINGS_H
  45
  46 #include <cstddef>
  47
  48 struct gmx_wallclock_gpu_pme_t;
  49 struct PmeGpu;
  50
  51 enum class PmeStage : int;
  52
  53 /*! \libinternal \brief
  54  * Starts timing the certain PME GPU stage during a single computation (if timings are enabled).
  55  *
  56  * \param[in] pmeGpu         The PME GPU data structure.
  57  * \param[in] pmeStageId     The PME GPU stage gtPME_ index from the enum in src/gromacs/timing/gpu_timing.h
  58  */
  59 void pme_gpu_start_timing(const PmeGpu* pmeGpu, PmeStage pmeStageId);
  60
  61 /*! \libinternal \brief
  62  * Stops timing the certain PME GPU stage during a single computation (if timings are enabled).
  63  *
  64  * \param[in] pmeGpu         The PME GPU data structure.
  65  * \param[in] pmeStageId     The PME GPU stage gtPME_ index from the enum in src/gromacs/timing/gpu_timing.h
  66  */
  67 void pme_gpu_stop_timing(const PmeGpu* pmeGpu, PmeStage pmeStageId);
  68
  69 /*! \brief
  70  * Tells if CUDA-based performance tracking is enabled for PME.
  71  *
  72  * \param[in] pmeGpu         The PME GPU data structure.
  73  * \returns                  True if timings are enabled, false otherwise.
  74  */
  75 bool pme_gpu_timings_enabled(const PmeGpu* pmeGpu);
  76
  77 /*! \libinternal \brief
  78  * Finalizes all the active PME GPU stage timings for the current computation. Should be called at the end of every computation.
  79  *
  80  * \param[in] pmeGpu         The PME GPU structure.
  81  */
  82 void pme_gpu_update_timings(const PmeGpu* pmeGpu);
  83
  84 /*! \libinternal \brief
  85  * Updates the internal list of active PME GPU stages (if timings are enabled).
  86  *
  87  * \param[in] pmeGpu         The PME GPU data structure.
  88  */
  89 void pme_gpu_reinit_timings(const PmeGpu* pmeGpu);
  90
  91 /*! \brief
  92  * Resets the PME GPU timings. To be called at the reset MD step.
  93  *
  94  * \param[in] pmeGpu         The PME GPU structure.
  95  */
  96 void pme_gpu_reset_timings(const PmeGpu* pmeGpu);
  97
  98 /*! \libinternal \brief
  99  * Copies the PME GPU timings to the gmx_wallclock_gpu_t structure (for log output). To be called at the run end.
 100  *
 101  * \param[in] pmeGpu         The PME GPU structure.
 102  * \param[in] timings        The gmx_wallclock_gpu_pme_t structure.
 103  */
 104 void pme_gpu_get_timings(const PmeGpu* pmeGpu, gmx_wallclock_gpu_pme_t* timings);
 105
 106 #endif