src/gromacs/ewald/pme-timings.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018, 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 /*! \libinternal \file
  37  *  \brief Defines PME GPU timing functions.
  38  *
  39  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  */
  41
  42 #ifndef GMX_EWALD_PME_TIMINGS_CUH
  43 #define GMX_EWALD_PME_TIMINGS_CUH
  44
  45 #include "gromacs/gpu_utils/gpuregiontimer.cuh"
  46 #include "gromacs/timing/gpu_timing.h"       // TODO: move include to the source files
  47
  48 struct PmeGpu;
  49
  50 /*! \libinternal \brief
  51  * Starts timing the certain PME GPU stage during a single computation (if timings are enabled).
  52  *
  53  * \param[in] pmeGpu         The PME GPU data structure.
  54  * \param[in] PMEStageId     The PME GPU stage gtPME_ index from the enum in src/gromacs/timing/gpu_timing.h
  55  */
  56 void pme_gpu_start_timing(const PmeGpu *pmeGpu, size_t PMEStageId);
  57
  58 /*! \libinternal \brief
  59  * Returns raw timing event from the corresponding GpuRegionTimer (if timings are enabled).
  60  * In CUDA result can be nullptr stub, per GpuRegionTimer implementation.
  61  *
  62  * \param[in] pmeGpu         The PME GPU data structure.
  63  * \param[in] PMEStageId     The PME GPU stage gtPME_ index from the enum in src/gromacs/timing/gpu_timing.h
  64  */
  65 CommandEvent *pme_gpu_fetch_timing_event(const PmeGpu *pmeGpu, size_t PMEStageId);
  66
  67 /*! \libinternal \brief
  68  * Stops timing the certain PME GPU stage during a single computation (if timings are enabled).
  69  *
  70  * \param[in] pmeGpu         The PME GPU data structure.
  71  * \param[in] PMEStageId     The PME GPU stage gtPME_ index from the enum in src/gromacs/timing/gpu_timing.h
  72  */
  73 void pme_gpu_stop_timing(const PmeGpu *pmeGpu, size_t PMEStageId);
  74
  75 #endif