mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
125 lines
4.9 KiB
C++
125 lines
4.9 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//============================================================================
|
|
#ifndef vtk_m_cont_Timer_h
|
|
#define vtk_m_cont_Timer_h
|
|
|
|
#include <vtkm/cont/DeviceAdapterTag.h>
|
|
|
|
#include <vtkm/cont/vtkm_cont_export.h>
|
|
|
|
#include <memory>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
namespace detail
|
|
{
|
|
struct EnabledDeviceTimerImpls;
|
|
}
|
|
|
|
/// A class that can be used to time operations in VTK-m that might be occuring
|
|
/// in parallel. Users are recommended to provide a device adapter at construction
|
|
/// time which matches the one being used to execute algorithms to ensure that thread
|
|
/// synchronization is correct and accurate.
|
|
/// If no device adapter is provided at construction time, the maximum
|
|
/// elapsed time of all enabled deivces will be returned. Normally cuda is expected to
|
|
/// have the longest execution time if enabled.
|
|
/// Per device adapter time query is also supported. It's useful when users want to reuse
|
|
/// the same timer to measure the cuda kernal call as well as the cuda device execution.
|
|
/// It is also possible to change the device adapter after construction by calling the form
|
|
/// of the Reset method with a new DeviceAdapterId.
|
|
///
|
|
/// The there is no guaranteed resolution of the time but should generally be
|
|
/// good to about a millisecond.
|
|
///
|
|
class VTKM_CONT_EXPORT Timer
|
|
{
|
|
public:
|
|
VTKM_CONT
|
|
Timer();
|
|
|
|
VTKM_CONT Timer(vtkm::cont::DeviceAdapterId device);
|
|
|
|
VTKM_CONT ~Timer();
|
|
|
|
/// @brief Restores the initial state of the :class:`vtkm::cont::Timer`.
|
|
///
|
|
/// All previous recorded time is erased. `Reset()` optionally takes a device
|
|
/// adapter tag or id that specifies on which device to time and synchronize.
|
|
VTKM_CONT void Reset();
|
|
|
|
/// Resets the timer and changes the device to time on.
|
|
VTKM_CONT void Reset(vtkm::cont::DeviceAdapterId device);
|
|
|
|
/// @brief Causes the `Timer` to begin timing.
|
|
///
|
|
/// The elapsed time will record an interval beginning when this method is called.
|
|
VTKM_CONT void Start();
|
|
|
|
/// @brief Causes the `Timer()` to finish timing.
|
|
///
|
|
/// The elapsed time will record an interval ending when this method is called.
|
|
/// It is invalid to stop the timer if `Started()` is not true.
|
|
VTKM_CONT void Stop();
|
|
|
|
/// @brief Returns true if `Start()` has been called.
|
|
///
|
|
/// It is invalid to try to get the elapsed time if `Started()` is not true.
|
|
VTKM_CONT bool Started() const;
|
|
|
|
/// @brief Returns true if `Timer::Stop()` has been called.
|
|
///
|
|
/// If `Stopped()` is true, then the elapsed time will no longer increase.
|
|
/// If `Stopped()` is false and `Started()` is true, then the timer is still running.
|
|
VTKM_CONT bool Stopped() const;
|
|
|
|
/// Used to check if Timer has finished the synchronization to get the result from the device.
|
|
VTKM_CONT bool Ready() const;
|
|
|
|
/// @brief Returns the amount of time that has elapsed between calling `Start()` and `Stop()`.
|
|
///
|
|
/// If `Stop()` was not called, then the amount of time between calling `Start()` and
|
|
/// `GetElapsedTime()` is returned. `GetElapsedTime()` can optionally take a device
|
|
/// adapter tag or id to specify for which device to return the elapsed time. Returns the
|
|
/// device for which this timer is synchronized. If the device adapter has the same
|
|
/// id as `vtkm::cont::DeviceAdapterTagAny`, then the timer will synchronize all devices.
|
|
VTKM_CONT
|
|
vtkm::Float64 GetElapsedTime() const;
|
|
|
|
/// @brief Returns the id of the device adapter for which this timer is synchronized.
|
|
///
|
|
/// If the device adapter has the same id as `vtkm::cont::DeviceAdapterTagAny`
|
|
/// (the default), then the timer will synchronize on all devices.
|
|
VTKM_CONT vtkm::cont::DeviceAdapterId GetDevice() const { return this->Device; }
|
|
|
|
/// Synchronize the device(s) that this timer is monitoring without starting or stopping the
|
|
/// timer. This is useful for ensuring that external events are synchronized to this timer.
|
|
///
|
|
/// Note that this method will allways block until the device(s) finish even if the
|
|
/// `Start`/`Stop` methods do not actually block. For example, the timer for CUDA does not
|
|
/// actually wait for asynchronous operations to finish. Rather, it inserts a fence and
|
|
/// records the time as fences are encounted. But regardless, this `Synchronize` method
|
|
/// will block for the CUDA device.
|
|
VTKM_CONT void Synchronize() const;
|
|
|
|
private:
|
|
/// Some timers are ill-defined when copied, so disallow that for all timers.
|
|
VTKM_CONT Timer(const Timer&) = delete;
|
|
VTKM_CONT void operator=(const Timer&) = delete;
|
|
|
|
vtkm::cont::DeviceAdapterId Device;
|
|
std::unique_ptr<detail::EnabledDeviceTimerImpls> Internal;
|
|
};
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_Timer_h
|