src/gromacs/timing/gpu_timing.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2016,2017, 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 /*! \libinternal \file
  36  *  \brief Declares data types for GPU timing
  37  *
  38  *  \author Szilard Pall <pall.szilard@gmail.com>
  39  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  40  *  \inlibraryapi
  41  */
  42
  43 #ifndef GMX_TIMING_GPU_TIMING_H
  44 #define GMX_TIMING_GPU_TIMING_H
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /*! \internal \brief GPU kernel time and call count. */
  51 struct gmx_kernel_timing_data_t
  52 {
  53     double  t; /**< Accumulated lapsed time */
  54     int     c; /**< Number of calls corresponding to the elapsed time */
  55 };
  56
  57 /*! \internal \brief
  58  *
  59  * PME GPU stages timing events indices, corresponding to the string in PMEStageNames in wallcycle.cpp.
  60  */
  61 enum
  62 {
  63     gtPME_SPLINE = 0,
  64     gtPME_SPREAD,
  65     gtPME_SPLINEANDSPREAD,
  66     gtPME_FFT_R2C,
  67     gtPME_SOLVE,
  68     gtPME_FFT_C2R,
  69     gtPME_GATHER,
  70     gtPME_EVENT_COUNT /* not a stage ID but a static array size */
  71 };
  72
  73 /*! \internal \brief GPU timings for PME. */
  74 struct gmx_wallclock_gpu_pme_t
  75 {
  76     /* A separate PME structure to avoid refactoring the NB code for gmx_wallclock_gpu_t later
  77      * TODO: devise a better GPU timing data structuring.
  78      */
  79     /*! \brief Array of PME GPU timing data. */
  80     gmx_kernel_timing_data_t timing[gtPME_EVENT_COUNT];
  81 };
  82
  83 /*! \internal \brief GPU NB timings for kernels and H2d/D2H transfers. */
  84 struct gmx_wallclock_gpu_nbnxn_t
  85 {
  86     gmx_kernel_timing_data_t ktime[2][2];      /**< table containing the timings of the four
  87                                                         versions of the nonbonded kernels: force-only,
  88                                                         force+energy, force+pruning, and force+energy+pruning */
  89     gmx_kernel_timing_data_t pruneTime;        /**< table containing the timings of the 1st pass prune-only kernels */
  90     gmx_kernel_timing_data_t dynamicPruneTime; /**< table containing the timings of dynamic prune-only kernels */
  91     double                   nb_h2d_t;         /**< host to device transfer time in nb calculation  */
  92     double                   nb_d2h_t;         /**< device to host transfer time in nb calculation */
  93     int                      nb_c;             /**< total call count of the nonbonded gpu operations */
  94     double                   pl_h2d_t;         /**< pair search step host to device transfer time */
  95     int                      pl_h2d_c;         /**< pair search step  host to device transfer call count */
  96 };
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 #endif