RuntimeDeviceTracker.h

Go to the documentation of this file.

//============================================================================
//  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_RuntimeDeviceTracker_h
#define vtk_m_cont_RuntimeDeviceTracker_h
 
#include <vtkm/cont/vtkm_cont_export.h>
 
#include <vtkm/cont/DeviceAdapterTag.h>
#include <vtkm/cont/ErrorBadAllocation.h>
#include <vtkm/cont/ErrorBadDevice.h>
#include <vtkm/cont/RuntimeDeviceInformation.h>
 
#include <functional>
#include <memory>
 
namespace vtkm
{
namespace cont
{
namespace detail
{
 
struct RuntimeDeviceTrackerInternals;
}
class ScopedRuntimeDeviceTracker;
 
class VTKM_CONT_EXPORT RuntimeDeviceTracker
{
  friend VTKM_CONT_EXPORT vtkm::cont::RuntimeDeviceTracker& GetRuntimeDeviceTracker();
 
public:
  VTKM_CONT
  ~RuntimeDeviceTracker();
 
  VTKM_CONT bool CanRunOn(DeviceAdapterId deviceId) const;
 
  VTKM_CONT void ReportAllocationFailure(vtkm::cont::DeviceAdapterId deviceId,
                                         const vtkm::cont::ErrorBadAllocation&)
  {
    this->SetDeviceState(deviceId, false);
  }
 
 
  VTKM_CONT void ReportBadDeviceFailure(vtkm::cont::DeviceAdapterId deviceId,
                                        const vtkm::cont::ErrorBadDevice&)
  {
    this->SetDeviceState(deviceId, false);
  }
 
  VTKM_CONT void ResetDevice(vtkm::cont::DeviceAdapterId deviceId);
 
  VTKM_CONT
  void Reset();
 
  VTKM_CONT void DisableDevice(DeviceAdapterId deviceId);
 
  VTKM_CONT void ForceDevice(DeviceAdapterId deviceId);
 
  VTKM_CONT bool GetThreadFriendlyMemAlloc() const;
  VTKM_CONT void SetThreadFriendlyMemAlloc(bool state);
 
  VTKM_CONT void CopyStateFrom(const vtkm::cont::RuntimeDeviceTracker& tracker);
 
  VTKM_CONT void SetAbortChecker(const std::function<bool()>& func);
  VTKM_CONT void ClearAbortChecker();
 
  VTKM_CONT bool CheckForAbortRequest() const;
 
  VTKM_CONT void PrintSummary(std::ostream& out) const;
 
private:
  friend class ScopedRuntimeDeviceTracker;
 
  detail::RuntimeDeviceTrackerInternals* Internals;
 
  VTKM_CONT
  RuntimeDeviceTracker(detail::RuntimeDeviceTrackerInternals* details, bool reset);
 
  VTKM_CONT
  RuntimeDeviceTracker(const RuntimeDeviceTracker&) = delete;
 
  VTKM_CONT
  RuntimeDeviceTracker& operator=(const RuntimeDeviceTracker&) = delete;
 
  VTKM_CONT
  void CheckDevice(vtkm::cont::DeviceAdapterId deviceId) const;
 
  VTKM_CONT
  void SetDeviceState(vtkm::cont::DeviceAdapterId deviceId, bool state);
 
  VTKM_CONT
  void LogEnabledDevices() const;
};
 
VTKM_CONT_EXPORT
VTKM_CONT
vtkm::cont::RuntimeDeviceTracker& GetRuntimeDeviceTracker();
 
enum struct RuntimeDeviceTrackerMode
{
  // Documentation is below (for better layout in generated documents).
  Force,
  Enable,
  Disable
};
 
 
 
 
//----------------------------------------------------------------------------
class VTKM_CONT_EXPORT ScopedRuntimeDeviceTracker : public vtkm::cont::RuntimeDeviceTracker
{
public:
  VTKM_CONT ScopedRuntimeDeviceTracker(
    const vtkm::cont::RuntimeDeviceTracker& tracker = GetRuntimeDeviceTracker());
 
  VTKM_CONT ScopedRuntimeDeviceTracker(
    vtkm::cont::DeviceAdapterId device,
    RuntimeDeviceTrackerMode mode = RuntimeDeviceTrackerMode::Force,
    const vtkm::cont::RuntimeDeviceTracker& tracker = GetRuntimeDeviceTracker());
 
  VTKM_CONT ScopedRuntimeDeviceTracker(
    const std::function<bool()>& abortChecker,
    const vtkm::cont::RuntimeDeviceTracker& tracker = GetRuntimeDeviceTracker());
 
  VTKM_CONT ~ScopedRuntimeDeviceTracker();
 
private:
  std::unique_ptr<detail::RuntimeDeviceTrackerInternals> SavedState;
};
 
}
} // namespace vtkm::cont
 
#endif //vtk_m_cont_RuntimeDeviceTracker_h