/*
* This file is part of the GROMACS molecular simulation package.
*
- * Copyright (c) 2016,2017,2018, by the GROMACS development team, led by
+ * Copyright (c) 2016,2017,2018,2019,2020 by the GROMACS development team.
+ * Copyright (c) 2021, by the GROMACS development team, led by
* Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
* and including many others, as listed in the AUTHORS file in the
* top-level source directory and at http://www.gromacs.org.
* as far as current implementation allows (see TODO in getLastRangeTime() for a disabled check).
* Internally it uses GpuRegionTimerImpl for measuring regions.
*/
-template <typename GpuRegionTimerImpl> class GpuRegionTimerWrapper
+template<typename GpuRegionTimerImpl>
+class GpuRegionTimerWrapper
{
//! The timer state used for debug-only assertions
enum class TimerState
} debugState_ = TimerState::Idle;
//! The number of times the timespan has been measured
- unsigned int callCount_ = 0;
+ unsigned int callCount_ = 0;
//! The accumulated duration of the timespans measured (milliseconds)
- double totalMilliseconds_ = 0.0;
+ double totalMilliseconds_ = 0.0;
//! The underlying region timer implementation
GpuRegionTimerImpl impl_;
- public:
-
- /*! \brief
- * To be called before the region start.
- *
- * \param[in] s The GPU command stream where the event being measured takes place.
- */
- void openTimingRegion(CommandStream s)
- {
- if (c_debugTimerState)
- {
- std::string error = "GPU timer should be idle, but is " + std::string((debugState_ == TimerState::Stopped) ? "stopped" : "recording") + ".";
- GMX_ASSERT(debugState_ == TimerState::Idle, error.c_str());
- debugState_ = TimerState::Recording;
- }
- impl_.openTimingRegion(s);
- }
- /*! \brief
- * To be called after the region end.
- *
- * \param[in] s The GPU command stream where the event being measured takes place.
- */
- void closeTimingRegion(CommandStream s)
- {
- if (c_debugTimerState)
- {
- std::string error = "GPU timer should be recording, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "stopped") + ".";
- GMX_ASSERT(debugState_ == TimerState::Recording, error.c_str());
- debugState_ = TimerState::Stopped;
- }
- callCount_++;
- impl_.closeTimingRegion(s);
- }
- /*! \brief
- * Accumulates the last timespan of all the events used into the the total duration,
- * and resets the internal timer state.
- * To be called after closeTimingRegion() and the command stream of the event having been synchronized.
- * \returns The last timespan (in milliseconds).
- */
- double getLastRangeTime()
+public:
+ /*! \brief
+ * To be called before the region start.
+ *
+ * \param[in] deviceStream The GPU command stream where the event being measured takes place.
+ */
+ void openTimingRegion(const DeviceStream& deviceStream)
+ {
+ if (c_debugTimerState)
{
- if (c_debugTimerState)
- {
- /* The assertion below is commented because it is currently triggered on a special case:
- * the early return before the local non-bonded kernel launch if there is nothing to do.
- * This can be reproduced in OpenCL build by running
- * mdrun-mpi-test -ntmpi 2 --gtest_filter=*Empty*
- * Similarly, the GpuRegionTimerImpl suffers from non-nullptr
- * cl_event conditionals which ideally should only be asserts.
- * TODO: improve internal task scheduling, re-enable the assert, turn conditionals into asserts
- */
- /*
- std::string error = "GPU timer should be stopped, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "recording") + ".";
- GMX_ASSERT(debugState_ == TimerState::Stopped, error.c_str());
- */
- debugState_ = TimerState::Idle;
- }
- double milliseconds = impl_.getLastRangeTime();
- totalMilliseconds_ += milliseconds;
- return milliseconds;
+ std::string error = "GPU timer should be idle, but is "
+ + std::string((debugState_ == TimerState::Stopped) ? "stopped" : "recording")
+ + ".";
+ GMX_ASSERT(debugState_ == TimerState::Idle, error.c_str());
+ debugState_ = TimerState::Recording;
}
- /*! \brief Resets the implementation and total time/call count to zeroes. */
- void reset()
+ impl_.openTimingRegion(deviceStream);
+ }
+ /*! \brief
+ * To be called after the region end.
+ *
+ * \param[in] deviceStream The GPU command stream where the event being measured takes place.
+ */
+ void closeTimingRegion(const DeviceStream& deviceStream)
+ {
+ if (c_debugTimerState)
{
- if (c_debugTimerState)
- {
- debugState_ = TimerState::Idle;
- }
- totalMilliseconds_ = 0.0;
- callCount_ = 0;
- impl_.reset();
+ std::string error = "GPU timer should be recording, but is "
+ + std::string((debugState_ == TimerState::Idle) ? "idle" : "stopped")
+ + ".";
+ GMX_ASSERT(debugState_ == TimerState::Recording, error.c_str());
+ debugState_ = TimerState::Stopped;
}
- /*! \brief Gets total time recorded (in milliseconds). */
- double getTotalTime() const
+ callCount_++;
+ impl_.closeTimingRegion(deviceStream);
+ }
+ /*! \brief
+ * Accumulates the last timespan of all the events used into the total duration,
+ * and resets the internal timer state.
+ * To be called after closeTimingRegion() and the command stream of the event having been
+ * synchronized.
+ * \returns The last timespan (in milliseconds).
+ */
+ double getLastRangeTime()
+ {
+ if (c_debugTimerState)
{
- return totalMilliseconds_;
+ /* The assertion below is commented because it is currently triggered on a special case:
+ * the early return before the local non-bonded kernel launch if there is nothing to do.
+ * This can be reproduced in OpenCL build by running
+ * mdrun-mpi-test -ntmpi 2 --gtest_filter=*Empty*
+ * Similarly, the GpuRegionTimerImpl suffers from non-nullptr
+ * cl_event conditionals which ideally should only be asserts.
+ * TODO: improve internal task scheduling, re-enable the assert, turn conditionals into asserts
+ */
+ /*
+ std::string error = "GPU timer should be stopped, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "recording") + ".";
+ GMX_ASSERT(debugState_ == TimerState::Stopped, error.c_str());
+ */
+ debugState_ = TimerState::Idle;
}
- /*! \brief Gets total call count recorded. */
- unsigned int getCallCount() const
+ double milliseconds = impl_.getLastRangeTime();
+ totalMilliseconds_ += milliseconds;
+ return milliseconds;
+ }
+ /*! \brief Resets the implementation and total time/call count to zeroes. */
+ void reset()
+ {
+ if (c_debugTimerState)
{
- return callCount_;
+ debugState_ = TimerState::Idle;
}
- /*! \brief
- * Gets a pointer to a new timing event for passing into individual GPU API calls
- * within the region if they require it (e.g. on OpenCL).
- * \returns The pointer to the underlying single command timing event.
- */
- CommandEvent *fetchNextEvent()
+ totalMilliseconds_ = 0.0;
+ callCount_ = 0;
+ impl_.reset();
+ }
+ /*! \brief Gets total time recorded (in milliseconds). */
+ double getTotalTime() const { return totalMilliseconds_; }
+ /*! \brief Gets total call count recorded. */
+ unsigned int getCallCount() const { return callCount_; }
+ /*! \brief
+ * Gets a pointer to a new timing event for passing into individual GPU API calls
+ * within the region if they require it (e.g. on OpenCL).
+ * \returns The pointer to the underlying single command timing event.
+ */
+ CommandEvent* fetchNextEvent()
+ {
+ if (c_debugTimerState)
{
- if (c_debugTimerState)
- {
- std::string error = "GPU timer should be recording, but is " + std::string((debugState_ == TimerState::Idle) ? "idle" : "stopped") + ".";
- GMX_ASSERT(debugState_ == TimerState::Recording, error.c_str());
- }
- return impl_.fetchNextEvent();
+ std::string error = "GPU timer should be recording, but is "
+ + std::string((debugState_ == TimerState::Idle) ? "idle" : "stopped")
+ + ".";
+ GMX_ASSERT(debugState_ == TimerState::Recording, error.c_str());
}
+ return impl_.fetchNextEvent();
+ }
};
#endif
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff