Program Listing for File MemoryResourceTypes.hpp

↰ Return to documentation for file (umpire/resource/MemoryResourceTypes.hpp)

//////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2016-20, Lawrence Livermore National Security, LLC and Umpire
// project contributors. See the COPYRIGHT file for details.
//
// SPDX-License-Identifier: (MIT)
//////////////////////////////////////////////////////////////////////////////
#ifndef UMPIRE_MemoryResourceTypes_HPP
#define UMPIRE_MemoryResourceTypes_HPP

#include <cstddef>
#include <string>

#include "umpire/util/Macros.hpp"

namespace umpire {
namespace resource {

struct MemoryResourceTypeHash {
  template <typename T>
  std::size_t operator()(T t) const noexcept
  {
    return static_cast<std::size_t>(t);
  }
};

enum MemoryResourceType {
  Host,
  Device,
  Unified,
  Pinned,
  Constant,
  File,
  Unknown
};

inline std::string resource_to_string(MemoryResourceType type)
{
  switch (type) {
    case Host:
      return "HOST";
    case Device:
      return "DEVICE";
    case Unified:
      return "UM";
    case Pinned:
      return "PINNED";
    case Constant:
      return "DEVICE_CONST";
    case File:
      return "FILE";
    default:
      UMPIRE_ERROR("Unkown resource type: " << type);
      //
      // The UMPIRE_ERROR macro above does not return.  It instead throws
      // an exception.  However, for some reason, nvcc throws a warning
      // "warning: missing return statement at end of non-void function"
      // even though the following line cannot be reached.  Adding this
      // fake return statement to work around the incorrect warning.
      //
#if defined(__CUDACC__) && defined(__CUDA_ARCH__)
      return "Unknown";
#endif
  }
}

inline MemoryResourceType string_to_resource(const std::string& resource)
{
  if (resource == "HOST")
    return MemoryResourceType::Host;
  else if (resource == "DEVICE")
    return MemoryResourceType::Device;
  else if (resource == "UM")
    return MemoryResourceType::Unified;
  else if (resource == "PINNED")
    return MemoryResourceType::Pinned;
  else if (resource == "DEVICE_CONST")
    return MemoryResourceType::Constant;
  else if (resource == "FILE")
    return MemoryResourceType::File;
  else {
    UMPIRE_ERROR("Unkown resource name: " << resource);

    //
    // The UMPIRE_ERROR macro above does not return.  It instead throws
    // an exception.  However, for some reason, nvcc throws a warning
    // "warning: missing return statement at end of non-void function"
    // even though the following line cannot be reached.  Adding this
    // fake return statement to work around the incorrect warning.
    //
#if defined(__CUDACC__) && defined(__CUDA_ARCH__)
    return MemoryResourceType::Unknown;
#endif
  }
}

inline int resource_to_device_id(const std::string& resource)
{
  int device_id{0};
  if (resource.find("::") != std::string::npos) {
    device_id = std::stoi(resource.substr(resource.find("::") + 2));
  }
  return device_id;
}

} // end of namespace resource
} // end of namespace umpire

#endif