RuntimeDeviceTracker.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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 viskores_cont_RuntimeDeviceTracker_h
#define viskores_cont_RuntimeDeviceTracker_h
 
#include <viskores/cont/viskores_cont_export.h>
 
#include <viskores/cont/DeviceAdapterTag.h>
#include <viskores/cont/ErrorBadAllocation.h>
#include <viskores/cont/ErrorBadDevice.h>
#include <viskores/cont/RuntimeDeviceInformation.h>
 
#include <functional>
#include <memory>
 
namespace viskores
{
namespace cont
{
namespace detail
{
 
struct RuntimeDeviceTrackerInternals;
}
class ScopedRuntimeDeviceTracker;
 
class VISKORES_CONT_EXPORT RuntimeDeviceTracker
{
  friend VISKORES_CONT_EXPORT viskores::cont::RuntimeDeviceTracker& GetRuntimeDeviceTracker();
 
public:
  VISKORES_CONT
  ~RuntimeDeviceTracker();
 
  VISKORES_CONT bool CanRunOn(DeviceAdapterId deviceId) const;
 
  VISKORES_CONT void ReportAllocationFailure(viskores::cont::DeviceAdapterId deviceId,
                                             const viskores::cont::ErrorBadAllocation&)
  {
    this->SetDeviceState(deviceId, false);
  }
 
 
  VISKORES_CONT void ReportBadDeviceFailure(viskores::cont::DeviceAdapterId deviceId,
                                            const viskores::cont::ErrorBadDevice&)
  {
    this->SetDeviceState(deviceId, false);
  }
 
  VISKORES_CONT void ResetDevice(viskores::cont::DeviceAdapterId deviceId);
 
  VISKORES_CONT
  void Reset();
 
  VISKORES_CONT void DisableDevice(DeviceAdapterId deviceId);
 
  VISKORES_CONT void ForceDevice(DeviceAdapterId deviceId);
 
  VISKORES_CONT bool GetThreadFriendlyMemAlloc() const;
  VISKORES_CONT void SetThreadFriendlyMemAlloc(bool state);
 
  VISKORES_CONT void CopyStateFrom(const viskores::cont::RuntimeDeviceTracker& tracker);
 
  VISKORES_CONT void SetAbortChecker(const std::function<bool()>& func);
  VISKORES_CONT void ClearAbortChecker();
 
  VISKORES_CONT bool CheckForAbortRequest() const;
 
  VISKORES_CONT void PrintSummary(std::ostream& out) const;
 
private:
  friend class ScopedRuntimeDeviceTracker;
 
  detail::RuntimeDeviceTrackerInternals* Internals;
 
  VISKORES_CONT
  RuntimeDeviceTracker(detail::RuntimeDeviceTrackerInternals* details, bool reset);
 
  VISKORES_CONT
  RuntimeDeviceTracker(const RuntimeDeviceTracker&) = delete;
 
  VISKORES_CONT
  RuntimeDeviceTracker& operator=(const RuntimeDeviceTracker&) = delete;
 
  VISKORES_CONT
  void CheckDevice(viskores::cont::DeviceAdapterId deviceId) const;
 
  VISKORES_CONT
  void SetDeviceState(viskores::cont::DeviceAdapterId deviceId, bool state);
 
  VISKORES_CONT
  void LogEnabledDevices() const;
};
 
VISKORES_CONT_EXPORT
VISKORES_CONT
viskores::cont::RuntimeDeviceTracker& GetRuntimeDeviceTracker();
 
enum struct RuntimeDeviceTrackerMode
{
  // Documentation is below (for better layout in generated documents).
  Force,
  Enable,
  Disable
};
 
 
 
 
//----------------------------------------------------------------------------
class VISKORES_CONT_EXPORT ScopedRuntimeDeviceTracker : public viskores::cont::RuntimeDeviceTracker
{
public:
  VISKORES_CONT ScopedRuntimeDeviceTracker(
    const viskores::cont::RuntimeDeviceTracker& tracker = GetRuntimeDeviceTracker());
 
  VISKORES_CONT ScopedRuntimeDeviceTracker(
    viskores::cont::DeviceAdapterId device,
    RuntimeDeviceTrackerMode mode = RuntimeDeviceTrackerMode::Force,
    const viskores::cont::RuntimeDeviceTracker& tracker = GetRuntimeDeviceTracker());
 
  VISKORES_CONT ScopedRuntimeDeviceTracker(
    const std::function<bool()>& abortChecker,
    const viskores::cont::RuntimeDeviceTracker& tracker = GetRuntimeDeviceTracker());
 
  VISKORES_CONT ~ScopedRuntimeDeviceTracker();
 
private:
  std::unique_ptr<detail::RuntimeDeviceTrackerInternals> SavedState;
};
 
}
} // namespace viskores::cont
 
#endif //viskores_cont_RuntimeDeviceTracker_h