DeviceAdapterTag.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_DeviceAdapterTag_h
#define viskores_cont_DeviceAdapterTag_h
 
#include <viskores/StaticAssert.h>
#include <viskores/Types.h>
#include <viskores/internal/Configure.h>
#include <viskores/internal/ExportMacros.h>
 
#include <viskores/cont/viskores_cont_export.h>
 
#include <string>
 
#ifdef VISKORES_DEVICE_ADAPTER
// Rather than use defines to specify the default device adapter
// Viskores now builds for all device adapters and uses runtime controls
// to determine where execution occurs
#error The VISKORES_DEVICE_ADAPTER define is no longer obeyed and needs to be removed
#endif
#ifdef VISKORES_DEFAULT_DEVICE_ADAPTER_TAG
// Rather than use device adapter tag that had no shared parent
// Viskores now uses a runtime device adapter implementation that
// allows for runtime execution selection of what device to execute on
#error The VISKORES_DEFAULT_DEVICE_ADAPTER_TAG define is no longer required and needs to be removed
#endif
 
#define VISKORES_DEVICE_ADAPTER_UNDEFINED -1
#define VISKORES_DEVICE_ADAPTER_SERIAL 1
#define VISKORES_DEVICE_ADAPTER_CUDA 2
#define VISKORES_DEVICE_ADAPTER_TBB 3
#define VISKORES_DEVICE_ADAPTER_OPENMP 4
#define VISKORES_DEVICE_ADAPTER_KOKKOS 5
//VISKORES_DEVICE_ADAPTER_TestAlgorithmGeneral 7
#define VISKORES_MAX_DEVICE_ADAPTER_ID 8
#define VISKORES_DEVICE_ADAPTER_ANY 127
 
namespace viskores
{
namespace cont
{
 
using DeviceAdapterNameType = std::string;
 
struct DeviceAdapterId
{
  constexpr bool operator==(DeviceAdapterId other) const { return this->Value == other.Value; }
  constexpr bool operator!=(DeviceAdapterId other) const { return this->Value != other.Value; }
  constexpr bool operator<(DeviceAdapterId other) const { return this->Value < other.Value; }
 
  constexpr bool IsValueValid() const
  {
    return this->Value > 0 && this->Value < VISKORES_MAX_DEVICE_ADAPTER_ID;
  }
 
  constexpr viskores::Int8 GetValue() const { return this->Value; }
 
  VISKORES_CONT_EXPORT
  DeviceAdapterNameType GetName() const;
 
protected:
  friend DeviceAdapterId make_DeviceAdapterId(viskores::Int8 id);
 
  constexpr explicit DeviceAdapterId(viskores::Int8 id)
    : Value(id)
  {
  }
 
private:
  viskores::Int8 Value;
};
 
VISKORES_CONT_EXPORT
DeviceAdapterId make_DeviceAdapterId(const DeviceAdapterNameType& name);
 
inline DeviceAdapterId make_DeviceAdapterId(viskores::Int8 id)
{
  return DeviceAdapterId(id);
}
 
template <typename DeviceAdapter>
struct DeviceAdapterTraits;
}
}
 
#define VISKORES_VALID_DEVICE_ADAPTER(Name, Id)                          \
  namespace viskores                                                     \
  {                                                                      \
  namespace cont                                                         \
  {                                                                      \
  struct VISKORES_ALWAYS_EXPORT DeviceAdapterTag##Name : DeviceAdapterId \
  {                                                                      \
    constexpr DeviceAdapterTag##Name()                                   \
      : DeviceAdapterId(Id)                                              \
    {                                                                    \
    }                                                                    \
    static constexpr bool IsEnabled = true;                              \
  };                                                                     \
  template <>                                                            \
  struct DeviceAdapterTraits<viskores::cont::DeviceAdapterTag##Name>     \
  {                                                                      \
    static DeviceAdapterNameType GetName()                               \
    {                                                                    \
      return DeviceAdapterNameType(#Name);                               \
    }                                                                    \
  };                                                                     \
  }                                                                      \
  }
 
#define VISKORES_INVALID_DEVICE_ADAPTER(Name, Id)                        \
  namespace viskores                                                     \
  {                                                                      \
  namespace cont                                                         \
  {                                                                      \
  struct VISKORES_ALWAYS_EXPORT DeviceAdapterTag##Name : DeviceAdapterId \
  {                                                                      \
    constexpr DeviceAdapterTag##Name()                                   \
      : DeviceAdapterId(Id)                                              \
    {                                                                    \
    }                                                                    \
    static constexpr bool IsEnabled = false;                             \
  };                                                                     \
  template <>                                                            \
  struct DeviceAdapterTraits<viskores::cont::DeviceAdapterTag##Name>     \
  {                                                                      \
    static DeviceAdapterNameType GetName()                               \
    {                                                                    \
      return DeviceAdapterNameType(#Name);                               \
    }                                                                    \
  };                                                                     \
  }                                                                      \
  }
 
 
VISKORES_VALID_DEVICE_ADAPTER(Any, VISKORES_DEVICE_ADAPTER_ANY)
 
 
VISKORES_INVALID_DEVICE_ADAPTER(Undefined, VISKORES_DEVICE_ADAPTER_UNDEFINED)
 
#define VISKORES_IS_DEVICE_ADAPTER_TAG(tag)                                     \
  static_assert(std::is_base_of<viskores::cont::DeviceAdapterId, tag>::value && \
                  !std::is_same<viskores::cont::DeviceAdapterId, tag>::value,   \
                "Provided type is not a valid Viskores device adapter tag.")
 
#endif //viskores_cont_DeviceAdapterTag_h