Kokkos_HIP_Space.hpp

/*
//@HEADER
// ************************************************************************
//
//                        Kokkos v. 3.0
//       Copyright (2020) National Technology & Engineering
//               Solutions of Sandia, LLC (NTESS).
//
// Under the terms of Contract DE-NA0003525 with NTESS,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Christian R. Trott (crtrott@sandia.gov)
//
// ************************************************************************
//@HEADER
*/
 
#ifndef KOKKOS_HIPSPACE_HPP
#define KOKKOS_HIPSPACE_HPP
 
#include <Kokkos_Core_fwd.hpp>
 
#if defined(KOKKOS_ENABLE_HIP)
 
#include <iosfwd>
#include <typeinfo>
#include <string>
#include <cstddef>
#include <iosfwd>
 
#include <Kokkos_HostSpace.hpp>
#include <Kokkos_Layout.hpp>
#include <Kokkos_ScratchSpace.hpp>
 
#include <impl/Kokkos_Profiling_Interface.hpp>
#include <impl/Kokkos_ExecSpaceInitializer.hpp>
#include <impl/Kokkos_HostSharedPtr.hpp>
 
#include <hip/hip_runtime_api.h>
/*--------------------------------------------------------------------------*/
 
namespace Kokkos {
namespace Experimental {
class HIPSpace {
 public:
  using memory_space    = HIPSpace;
  using execution_space = Kokkos::Experimental::HIP;
  using device_type     = Kokkos::Device<execution_space, memory_space>;
 
  using size_type = unsigned int;
 
  /*--------------------------------*/
 
  HIPSpace();
  HIPSpace(HIPSpace&& rhs)      = default;
  HIPSpace(const HIPSpace& rhs) = default;
  HIPSpace& operator=(HIPSpace&& rhs) = default;
  HIPSpace& operator=(const HIPSpace& rhs) = default;
  ~HIPSpace()                              = default;
 
  void* allocate(const size_t arg_alloc_size) const;
  void* allocate(const char* arg_label, const size_t arg_alloc_size,
                 const size_t arg_logical_size = 0) const;
 
  void deallocate(void* const arg_alloc_ptr, const size_t arg_alloc_size) const;
  void deallocate(const char* arg_label, void* const arg_alloc_ptr,
                  const size_t arg_alloc_size,
                  const size_t arg_logical_size = 0) const;
 
 private:
  template <class, class, class, class>
  friend class LogicalMemorySpace;
  void* impl_allocate(const char* arg_label, const size_t arg_alloc_size,
                      const size_t arg_logical_size = 0,
                      const Kokkos::Tools::SpaceHandle =
                          Kokkos::Tools::make_space_handle(name())) const;
  void impl_deallocate(const char* arg_label, void* const arg_alloc_ptr,
                       const size_t arg_alloc_size,
                       const size_t arg_logical_size = 0,
                       const Kokkos::Tools::SpaceHandle =
                           Kokkos::Tools::make_space_handle(name())) const;
 
 public:
  static constexpr const char* name() { return "HIP"; }
 
  /*--------------------------------*/
  KOKKOS_DEPRECATED static void access_error();
  KOKKOS_DEPRECATED static void access_error(const void* const);
 
 private:
  int m_device;  
 
  friend class Kokkos::Impl::SharedAllocationRecord<
      Kokkos::Experimental::HIPSpace, void>;
};
 
}  // namespace Experimental
}  // namespace Kokkos
 
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
 
namespace Kokkos {
namespace Experimental {
class HIPHostPinnedSpace {
 public:
 
  using execution_space = HostSpace::execution_space;
  using memory_space    = HIPHostPinnedSpace;
  using device_type     = Kokkos::Device<execution_space, memory_space>;
  using size_type       = unsigned int;
 
  /*--------------------------------*/
 
  HIPHostPinnedSpace();
  HIPHostPinnedSpace(HIPHostPinnedSpace&& rhs)      = default;
  HIPHostPinnedSpace(const HIPHostPinnedSpace& rhs) = default;
  HIPHostPinnedSpace& operator=(HIPHostPinnedSpace&& rhs) = default;
  HIPHostPinnedSpace& operator=(const HIPHostPinnedSpace& rhs) = default;
  ~HIPHostPinnedSpace()                                        = default;
 
  void* allocate(const size_t arg_alloc_size) const;
  void* allocate(const char* arg_label, const size_t arg_alloc_size,
                 const size_t arg_logical_size = 0) const;
 
  void deallocate(void* const arg_alloc_ptr, const size_t arg_alloc_size) const;
  void deallocate(const char* arg_label, void* const arg_alloc_ptr,
                  const size_t arg_alloc_size,
                  const size_t arg_logical_size = 0) const;
 
 private:
  template <class, class, class, class>
  friend class LogicalMemorySpace;
  void* impl_allocate(const char* arg_label, const size_t arg_alloc_size,
                      const size_t arg_logical_size = 0,
                      const Kokkos::Tools::SpaceHandle =
                          Kokkos::Tools::make_space_handle(name())) const;
  void impl_deallocate(const char* arg_label, void* const arg_alloc_ptr,
                       const size_t arg_alloc_size,
                       const size_t arg_logical_size = 0,
                       const Kokkos::Tools::SpaceHandle =
                           Kokkos::Tools::make_space_handle(name())) const;
 
 public:
  static constexpr const char* name() { return "HIPHostPinned"; }
 
  /*--------------------------------*/
};
}  // namespace Experimental
}  // namespace Kokkos
 
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
 
namespace Kokkos {
namespace Impl {
 
static_assert(
    Kokkos::Impl::MemorySpaceAccess<Kokkos::Experimental::HIPSpace,
                                    Kokkos::Experimental::HIPSpace>::assignable,
    "");
 
//----------------------------------------
 
template <>
struct MemorySpaceAccess<Kokkos::HostSpace, Kokkos::Experimental::HIPSpace> {
  enum : bool { assignable = false };
  enum : bool { accessible = false };
  enum : bool { deepcopy = true };
};
 
template <>
struct MemorySpaceAccess<Kokkos::HostSpace,
                         Kokkos::Experimental::HIPHostPinnedSpace> {
  // HostSpace::execution_space == HIPHostPinnedSpace::execution_space
  enum : bool { assignable = true };
  enum : bool { accessible = true };
  enum : bool { deepcopy = true };
};
 
//----------------------------------------
 
template <>
struct MemorySpaceAccess<Kokkos::Experimental::HIPSpace, Kokkos::HostSpace> {
  enum : bool { assignable = false };
  enum : bool { accessible = false };
  enum : bool { deepcopy = true };
};
 
template <>
struct MemorySpaceAccess<Kokkos::Experimental::HIPSpace,
                         Kokkos::Experimental::HIPHostPinnedSpace> {
  // HIPSpace::execution_space != HIPHostPinnedSpace::execution_space
  enum : bool { assignable = false };
  enum : bool { accessible = true };  // HIPSpace::execution_space
  enum : bool { deepcopy = true };
};
 
//----------------------------------------
// HIPHostPinnedSpace::execution_space == HostSpace::execution_space
// HIPHostPinnedSpace accessible to both HIP and Host
 
template <>
struct MemorySpaceAccess<Kokkos::Experimental::HIPHostPinnedSpace,
                         Kokkos::HostSpace> {
  enum : bool { assignable = false };  // Cannot access from HIP
  enum : bool { accessible = true };   // HIPHostPinnedSpace::execution_space
  enum : bool { deepcopy = true };
};
 
template <>
struct MemorySpaceAccess<Kokkos::Experimental::HIPHostPinnedSpace,
                         Kokkos::Experimental::HIPSpace> {
  enum : bool { assignable = false };  // Cannot access from Host
  enum : bool { accessible = false };
  enum : bool { deepcopy = true };
};
 
};  // namespace Impl
//----------------------------------------
 
}  // namespace Kokkos
 
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
 
namespace Kokkos {
namespace Impl {
 
void DeepCopyAsyncHIP(void* dst, const void* src, size_t n);
 
template <>
struct DeepCopy<Kokkos::Experimental::HIPSpace, Kokkos::Experimental::HIPSpace,
                Kokkos::Experimental::HIP> {
  DeepCopy(void* dst, const void* src, size_t);
  DeepCopy(const Kokkos::Experimental::HIP&, void* dst, const void* src,
           size_t);
};
 
template <>
struct DeepCopy<Kokkos::Experimental::HIPSpace, HostSpace,
                Kokkos::Experimental::HIP> {
  DeepCopy(void* dst, const void* src, size_t);
  DeepCopy(const Kokkos::Experimental::HIP&, void* dst, const void* src,
           size_t);
};
 
template <>
struct DeepCopy<HostSpace, Kokkos::Experimental::HIPSpace,
                Kokkos::Experimental::HIP> {
  DeepCopy(void* dst, const void* src, size_t);
  DeepCopy(const Kokkos::Experimental::HIP&, void* dst, const void* src,
           size_t);
};
 
template <class ExecutionSpace>
struct DeepCopy<Kokkos::Experimental::HIPSpace, Kokkos::Experimental::HIPSpace,
                ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<Kokkos::Experimental::HIPSpace,
                   Kokkos::Experimental::HIPSpace, Kokkos::Experimental::HIP>(
        dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <class ExecutionSpace>
struct DeepCopy<Kokkos::Experimental::HIPSpace, HostSpace, ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<Kokkos::Experimental::HIPSpace, HostSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <class ExecutionSpace>
struct DeepCopy<HostSpace, Kokkos::Experimental::HIPSpace, ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<HostSpace, Kokkos::Experimental::HIPSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <>
struct DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace,
                Kokkos::Experimental::HIPHostPinnedSpace,
                Kokkos::Experimental::HIP> {
  DeepCopy(void* dst, const void* src, size_t);
  DeepCopy(const Kokkos::Experimental::HIP&, void* dst, const void* src,
           size_t);
};
 
template <>
struct DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace, HostSpace,
                Kokkos::Experimental::HIP> {
  DeepCopy(void* dst, const void* src, size_t);
  DeepCopy(const Kokkos::Experimental::HIP&, void* dst, const void* src,
           size_t);
};
 
template <>
struct DeepCopy<HostSpace, Kokkos::Experimental::HIPHostPinnedSpace,
                Kokkos::Experimental::HIP> {
  DeepCopy(void* dst, const void* src, size_t);
  DeepCopy(const Kokkos::Experimental::HIP&, void* dst, const void* src,
           size_t);
};
 
template <class ExecutionSpace>
struct DeepCopy<Kokkos::Experimental::HIPSpace,
                Kokkos::Experimental::HIPHostPinnedSpace, ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<Kokkos::Experimental::HIPSpace, HostSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <class ExecutionSpace>
struct DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace,
                Kokkos::Experimental::HIPSpace, ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<HostSpace, Kokkos::Experimental::HIPSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <class ExecutionSpace>
struct DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace,
                Kokkos::Experimental::HIPHostPinnedSpace, ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace,
                   Kokkos::Experimental::HIPHostPinnedSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <class ExecutionSpace>
struct DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace, HostSpace,
                ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<Kokkos::Experimental::HIPHostPinnedSpace, HostSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
 
template <class ExecutionSpace>
struct DeepCopy<HostSpace, Kokkos::Experimental::HIPHostPinnedSpace,
                ExecutionSpace> {
  inline DeepCopy(void* dst, const void* src, size_t n) {
    (void)DeepCopy<HostSpace, Kokkos::Experimental::HIPHostPinnedSpace,
                   Kokkos::Experimental::HIP>(dst, src, n);
  }
 
  inline DeepCopy(const ExecutionSpace& exec, void* dst, const void* src,
                  size_t n) {
    exec.fence();
    DeepCopyAsyncHIP(dst, src, n);
  }
};
}  // namespace Impl
}  // namespace Kokkos
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
 
namespace Kokkos {
namespace Impl {
 
template <>
class SharedAllocationRecord<Kokkos::Experimental::HIPSpace, void>
    : public HostInaccessibleSharedAllocationRecordCommon<
          Kokkos::Experimental::HIPSpace> {
 private:
  friend class SharedAllocationRecordCommon<Kokkos::Experimental::HIPSpace>;
  friend class HostInaccessibleSharedAllocationRecordCommon<
      Kokkos::Experimental::HIPSpace>;
  using base_t = HostInaccessibleSharedAllocationRecordCommon<
      Kokkos::Experimental::HIPSpace>;
  using RecordBase = SharedAllocationRecord<void, void>;
 
  SharedAllocationRecord(const SharedAllocationRecord&) = delete;
  SharedAllocationRecord& operator=(const SharedAllocationRecord&) = delete;
 
#ifdef KOKKOS_ENABLE_DEBUG
  static RecordBase s_root_record;
#endif
 
  const Kokkos::Experimental::HIPSpace m_space;
 
 protected:
  ~SharedAllocationRecord();
 
  SharedAllocationRecord(
      const Kokkos::Experimental::HIPSpace& arg_space,
      const std::string& arg_label, const size_t arg_alloc_size,
      const RecordBase::function_type arg_dealloc = &base_t::deallocate);
};
 
template <>
class SharedAllocationRecord<Kokkos::Experimental::HIPHostPinnedSpace, void>
    : public SharedAllocationRecordCommon<
          Kokkos::Experimental::HIPHostPinnedSpace> {
 private:
  friend class SharedAllocationRecordCommon<
      Kokkos::Experimental::HIPHostPinnedSpace>;
  using base_t =
      SharedAllocationRecordCommon<Kokkos::Experimental::HIPHostPinnedSpace>;
  using RecordBase = SharedAllocationRecord<void, void>;
 
  SharedAllocationRecord(const SharedAllocationRecord&) = delete;
  SharedAllocationRecord& operator=(const SharedAllocationRecord&) = delete;
 
#ifdef KOKKOS_ENABLE_DEBUG
  static RecordBase s_root_record;
#endif
 
  const Kokkos::Experimental::HIPHostPinnedSpace m_space;
 
 protected:
  ~SharedAllocationRecord();
  SharedAllocationRecord() = default;
 
  SharedAllocationRecord(
      const Kokkos::Experimental::HIPHostPinnedSpace& arg_space,
      const std::string& arg_label, const size_t arg_alloc_size,
      const RecordBase::function_type arg_dealloc = &base_t::deallocate);
};
}  // namespace Impl
}  // namespace Kokkos
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
 
namespace Kokkos {
namespace Experimental {
namespace Impl {
class HIPInternal;
}
class HIP {
 public:
  //------------------------------------
 
 
  using execution_space = HIP;
  using memory_space    = HIPSpace;
  using device_type     = Kokkos::Device<execution_space, memory_space>;
 
  using array_layout = LayoutLeft;
  using size_type    = HIPSpace::size_type;
 
  using scratch_memory_space = ScratchMemorySpace<HIP>;
 
  HIP();
  HIP(hipStream_t stream);
 
  //------------------------------------
 
 
  KOKKOS_INLINE_FUNCTION static int in_parallel() {
#if defined(__HIP_ARCH__)
    return true;
#else
    return false;
#endif
  }
 
  static void impl_static_fence();
 
  void fence() const;
 
  hipStream_t hip_stream() const;
 
  static void print_configuration(std::ostream&, const bool detail = false);
 
  static void impl_finalize();
 
  struct SelectDevice {
    int hip_device_id;
    SelectDevice() : hip_device_id(0) {}
    explicit SelectDevice(int id) : hip_device_id(id) {}
  };
 
  int hip_device() const;
  static hipDeviceProp_t const& hip_device_prop();
 
  static void impl_initialize(const SelectDevice = SelectDevice());
 
  static int impl_is_initialized();
 
  //  static size_type device_arch();
 
  static size_type detect_device_count();
 
  static int concurrency();
  static const char* name();
 
  inline Impl::HIPInternal* impl_internal_space_instance() const {
    return m_space_instance.get();
  }
 
  uint32_t impl_instance_id() const noexcept { return 0; }
 
 private:
  Kokkos::Impl::HostSharedPtr<Impl::HIPInternal> m_space_instance;
};
}  // namespace Experimental
namespace Tools {
namespace Experimental {
template <>
struct DeviceTypeTraits<Kokkos::Experimental::HIP> {
  static constexpr DeviceType id = DeviceType::HIP;
};
}  // namespace Experimental
}  // namespace Tools
 
namespace Impl {
 
class HIPSpaceInitializer : public Kokkos::Impl::ExecSpaceInitializerBase {
 public:
  HIPSpaceInitializer()  = default;
  ~HIPSpaceInitializer() = default;
  void initialize(const InitArguments& args) final;
  void finalize(const bool) final;
  void fence() final;
  void print_configuration(std::ostream& msg, const bool detail) final;
};
 
}  // namespace Impl
}  // namespace Kokkos
 
namespace Kokkos {
namespace Impl {
 
template <>
struct MemorySpaceAccess<Kokkos::Experimental::HIPSpace,
                         Kokkos::Experimental::HIP::scratch_memory_space> {
  enum : bool { assignable = false };
  enum : bool { accessible = true };
  enum : bool { deepcopy = false };
};
 
}  // namespace Impl
}  // namespace Kokkos
 
#endif /* #if defined( KOKKOS_ENABLE_HIP ) */
#endif /* #define KOKKOS_HIPSPACE_HPP */