src/gromacs/gpu_utils/gpuregiontimer.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  36 /*! \libinternal \file
  37  *  \brief Implements the GPU region timer for CUDA.
  38  *
  39  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  *
  41  *  \inlibraryapi
  42  */
  43
  44 #ifndef GMX_GPU_UTILS_GPUREGIONTIMER_CUH
  45 #define GMX_GPU_UTILS_GPUREGIONTIMER_CUH
  46
  47 #include "gromacs/gpu_utils/cudautils.cuh"
  48
  49 #include "gpuregiontimer.h"
  50
  51 template <> struct GpuTraits<GpuFramework::CUDA>
  52 {
  53     using CommandStream = cudaStream_t;
  54     using CommandEvent  = void;
  55 };
  56
  57 //! Short-hand for external use
  58 using             GpuRegionTimer = GpuRegionTimerWrapper<GpuFramework::CUDA>;
  59
  60 template <> class GpuRegionTimerImpl<GpuFramework::CUDA>
  61 {
  62     //! Short-hand
  63     using       CommandStream = typename GpuTraits<GpuFramework::CUDA>::CommandStream;
  64     //! The underlying timing event pair - the beginning and the end of the timespan
  65     cudaEvent_t eventStart_, eventStop_;
  66
  67     public:
  68
  69         GpuRegionTimerImpl()
  70         {
  71             const int eventFlags = cudaEventDefault;
  72             CU_RET_ERR(cudaEventCreate(&eventStart_, eventFlags), "GPU timing creation failure");
  73             CU_RET_ERR(cudaEventCreate(&eventStop_, eventFlags), "GPU timing creation failure");
  74         }
  75
  76         ~GpuRegionTimerImpl()
  77         {
  78             CU_RET_ERR(cudaEventDestroy(eventStart_), "GPU timing destruction failure");
  79             CU_RET_ERR(cudaEventDestroy(eventStop_), "GPU timing destruction failure");
  80         }
  81
  82         inline void openTimingRegion(CommandStream s)
  83         {
  84             CU_RET_ERR(cudaEventRecord(eventStart_, s), "GPU timing recording failure");
  85         }
  86
  87         inline void closeTimingRegion(CommandStream s)
  88         {
  89             CU_RET_ERR(cudaEventRecord(eventStop_, s), "GPU timing recording failure");
  90         }
  91
  92         inline double getLastRangeTime()
  93         {
  94             float milliseconds = 0.0;
  95             CU_RET_ERR(cudaEventElapsedTime(&milliseconds, eventStart_, eventStop_), "GPU timing update failure");
  96             reset();
  97             return milliseconds;
  98         }
  99
 100         inline void reset(){}
 101 };
 102
 103 #endif