src/gromacs/gpu_utils/gpuregiontimer.h

   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 the GPU region timer implementation/wrapper classes.
  38  *  The implementations live in gpuregiontimer.cuh for CUDA and gpuregiontimer_ocl.h for OpenCL.
  39  *
  40  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  41  */
  42
  43 #ifndef GMX_GPU_UTILS_GPUREGIONTIMER_H
  44 #define GMX_GPU_UTILS_GPUREGIONTIMER_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/gmxassert.h"
  49
  50 //! Debug GPU timers in debug builds only
  51 #if defined(NDEBUG)
  52 static const bool c_debugTimerState = false;
  53 #else
  54 static const bool c_debugTimerState = true;
  55 #endif
  56
  57 /*! \libinternal \brief
  58  * This is a GPU region timing wrapper class.
  59  * It allows for host-side tracking of the accumulated execution timespans in GPU code
  60  * (measuring kernel or transfers duration).
  61  * It also partially tracks the correctness of the timer state transitions,
  62  * as far as current implementation allows (see TODO in getLastRangeTime() for a disabled check).
  63  * Internally it uses GpuRegionTimerImpl for measuring regions.
  64  */
  65 template <typename GpuRegionTimerImpl> class GpuRegionTimerWrapper
  66 {
  67     //! The timer state used for debug-only assertions
  68     enum class TimerState
  69     {
  70         Idle,
  71         Recording,
  72         Stopped
  73     } debugState_ = TimerState::Idle;
  74
  75     //! The number of times the timespan has been measured
  76     unsigned int       callCount_ = 0;
  77     //! The accumulated duration of the timespans measured (milliseconds)
  78     double             totalMilliseconds_ = 0.0;
  79     //! The underlying region timer implementation
  80     GpuRegionTimerImpl impl_;
  81
  82     public:
  83
  84         /*! \brief
  85          * To be called before the region start.
  86          *
  87          * \param[in] s   The GPU command stream where the event being measured takes place.
  88          */
  89         void openTimingRegion(CommandStream s)
  90         {
  91             if (c_debugTimerState)
  92             {
  93                 std::string error = "GPU timer should be idle, but is " + std::string((debugState_ == TimerState::Stopped) ? "stopped" : "recording") + ".";
  94                 GMX_ASSERT(debugState_ == TimerState::Idle, error.c_str());
  95                 debugState_ = TimerState::Recording;
  96             }
  97             impl_.openTimingRegion(s);
  98         }
  99         /*! \brief
 100          * To be called after the region end.
 101          *
 102          * \param[in] s   The GPU command stream where the event being measured takes place.
 103          */
 104         void closeTimingRegion(CommandStream s)
 105         {
 106             if (c_debugTimerState)
 107             {
 108                 std::string error = "GPU timer should be recording, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "stopped") + ".";
 109                 GMX_ASSERT(debugState_ == TimerState::Recording, error.c_str());
 110                 debugState_ = TimerState::Stopped;
 111             }
 112             callCount_++;
 113             impl_.closeTimingRegion(s);
 114         }
 115         /*! \brief
 116          * Accumulates the last timespan of all the events used into the the total duration,
 117          * and resets the internal timer state.
 118          * To be called after closeTimingRegion() and the command stream of the event having been synchronized.
 119          * \returns The last timespan (in milliseconds).
 120          */
 121         double getLastRangeTime()
 122         {
 123             if (c_debugTimerState)
 124             {
 125                 /* The assertion below is commented because it is currently triggered on a special case:
 126                  * the early return before the local non-bonded kernel launch if there is nothing to do.
 127                  * This can be reproduced in OpenCL build by running
 128                  * mdrun-mpi-test -ntmpi 2 --gtest_filter=*Empty*
 129                  * Similarly, the GpuRegionTimerImpl suffers from non-nullptr
 130                  * cl_event conditionals which ideally should only be asserts.
 131                  * TODO: improve internal task scheduling, re-enable the assert, turn conditionals into asserts
 132                  */
 133                 /*
 134                    std::string error = "GPU timer should be stopped, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "recording") + ".";
 135                    GMX_ASSERT(debugState_ == TimerState::Stopped, error.c_str());
 136                  */
 137                 debugState_ = TimerState::Idle;
 138             }
 139             double milliseconds = impl_.getLastRangeTime();
 140             totalMilliseconds_ += milliseconds;
 141             return milliseconds;
 142         }
 143         /*! \brief Resets the implementation and total time/call count to zeroes. */
 144         void reset()
 145         {
 146             if (c_debugTimerState)
 147             {
 148                 debugState_ = TimerState::Idle;
 149             }
 150             totalMilliseconds_ = 0.0;
 151             callCount_         = 0;
 152             impl_.reset();
 153         }
 154         /*! \brief Gets total time recorded (in milliseconds). */
 155         double getTotalTime() const
 156         {
 157             return totalMilliseconds_;
 158         }
 159         /*! \brief Gets total call count recorded. */
 160         unsigned int getCallCount() const
 161         {
 162             return callCount_;
 163         }
 164         /*! \brief
 165          * Gets a pointer to a new timing event for passing into individual GPU API calls
 166          * within the region if they require it (e.g. on OpenCL).
 167          * \returns The pointer to the underlying single command timing event.
 168          */
 169         CommandEvent *fetchNextEvent()
 170         {
 171             if (c_debugTimerState)
 172             {
 173                 std::string error = "GPU timer should be recording, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "stopped") + ".";
 174                 GMX_ASSERT(debugState_ == TimerState::Recording, error.c_str());
 175             }
 176             return impl_.fetchNextEvent();
 177         }
 178 };
 179
 180 #endif