EBGeometry_MemoryResource.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Robert Marskar <robert.marskar@sintef.no>
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef EBGEOMETRY_MEMORYRESOURCE_HPP
#define EBGEOMETRY_MEMORYRESOURCE_HPP
 
// Std includes
#include <cstddef>
 
// Our includes
#include "EBGeometry_GPU.hpp"
#include "EBGeometry_GPURuntime.hpp"
#include "EBGeometry_Macros.hpp"
 
namespace EBGeometry {
 
inline constexpr size_t PoolBaseAlign = 256;
 
class MemoryResource
{
public:
  MemoryResource() = default;
 
  virtual ~MemoryResource() = default;
 
  MemoryResource(const MemoryResource&) = delete;
 
  MemoryResource&
  operator=(const MemoryResource&) = delete;
 
  [[nodiscard]] EBGEOMETRY_HOST
  virtual void*
  allocate(size_t a_bytes, size_t a_alignment) = 0;
 
  EBGEOMETRY_HOST
  virtual void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept = 0;
 
  [[nodiscard]] EBGEOMETRY_HOST
  virtual bool
  isHostAccessible() const noexcept = 0;
 
  [[nodiscard]] EBGEOMETRY_HOST
  virtual bool
  isDeviceAccessible() const noexcept = 0;
 
  EBGEOMETRY_HOST
  virtual void
  copy(void*                 a_dst,
       const MemoryResource& a_dstResource,
       const void*           a_src,
       const MemoryResource& a_srcResource,
       size_t                a_bytes) const noexcept;
};
 
class HostMemoryResource final : public MemoryResource
{
public:
  HostMemoryResource() = default;
 
  ~HostMemoryResource() override = default;
 
  [[nodiscard]] EBGEOMETRY_HOST
  void*
  allocate(size_t a_bytes, size_t a_alignment) override;
 
  EBGEOMETRY_HOST
  void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept override;
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isHostAccessible() const noexcept override
  {
    return true;
  }
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isDeviceAccessible() const noexcept override
  {
    return false;
  }
};
 
[[nodiscard]] EBGEOMETRY_HOST
HostMemoryResource&
hostMemoryResource() noexcept;
 
class EmulatedDeviceMemoryResource final : public MemoryResource
{
public:
  EmulatedDeviceMemoryResource() = default;
 
  ~EmulatedDeviceMemoryResource() override = default;
 
  [[nodiscard]] EBGEOMETRY_HOST
  void*
  allocate(size_t a_bytes, size_t a_alignment) override;
 
  EBGEOMETRY_HOST
  void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept override;
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isHostAccessible() const noexcept override
  {
    return true;
  }
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isDeviceAccessible() const noexcept override
  {
    return true;
  }
};
 
[[nodiscard]] EBGEOMETRY_HOST
EmulatedDeviceMemoryResource&
emulatedDeviceMemoryResource() noexcept;
 
#if defined(EBGEOMETRY_CUDA) || defined(EBGEOMETRY_HIP) || defined(EBGEOMETRY_DOXYGEN)
 
class DeviceMemoryResource final : public MemoryResource
{
public:
  DeviceMemoryResource() = default;
 
  ~DeviceMemoryResource() override = default;
 
  [[nodiscard]] EBGEOMETRY_HOST
  void*
  allocate(size_t a_bytes, size_t a_alignment) override;
 
  EBGEOMETRY_HOST
  void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept override;
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isHostAccessible() const noexcept override
  {
    return false;
  }
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isDeviceAccessible() const noexcept override
  {
    return true;
  }
 
  EBGEOMETRY_HOST
  void
  copy(void*                 a_dst,
       const MemoryResource& a_dstResource,
       const void*           a_src,
       const MemoryResource& a_srcResource,
       size_t                a_bytes) const noexcept override;
};
 
class ManagedMemoryResource final : public MemoryResource
{
public:
  ManagedMemoryResource() = default;
 
  ~ManagedMemoryResource() override = default;
 
  [[nodiscard]] EBGEOMETRY_HOST
  void*
  allocate(size_t a_bytes, size_t a_alignment) override;
 
  EBGEOMETRY_HOST
  void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept override;
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isHostAccessible() const noexcept override
  {
    return true;
  }
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isDeviceAccessible() const noexcept override
  {
    return true;
  }
 
  EBGEOMETRY_HOST
  void
  copy(void*                 a_dst,
       const MemoryResource& a_dstResource,
       const void*           a_src,
       const MemoryResource& a_srcResource,
       size_t                a_bytes) const noexcept override;
};
 
class PinnedMemoryResource final : public MemoryResource
{
public:
  PinnedMemoryResource() = default;
 
  ~PinnedMemoryResource() override = default;
 
  [[nodiscard]] EBGEOMETRY_HOST
  void*
  allocate(size_t a_bytes, size_t a_alignment) override;
 
  EBGEOMETRY_HOST
  void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept override;
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isHostAccessible() const noexcept override
  {
    return true;
  }
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isDeviceAccessible() const noexcept override
  {
    return false;
  }
 
  EBGEOMETRY_HOST
  void
  copy(void*                 a_dst,
       const MemoryResource& a_dstResource,
       const void*           a_src,
       const MemoryResource& a_srcResource,
       size_t                a_bytes) const noexcept override;
};
 
class MappedMemoryResource final : public MemoryResource
{
public:
  MappedMemoryResource() = default;
 
  ~MappedMemoryResource() override = default;
 
  [[nodiscard]] EBGEOMETRY_HOST
  void*
  allocate(size_t a_bytes, size_t a_alignment) override;
 
  EBGEOMETRY_HOST
  void
  deallocate(void* a_ptr, size_t a_bytes, size_t a_alignment) noexcept override;
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isHostAccessible() const noexcept override
  {
    return true;
  }
 
  [[nodiscard]] EBGEOMETRY_HOST
  bool
  isDeviceAccessible() const noexcept override
  {
    return true;
  }
 
  EBGEOMETRY_HOST
  void
  copy(void*                 a_dst,
       const MemoryResource& a_dstResource,
       const void*           a_src,
       const MemoryResource& a_srcResource,
       size_t                a_bytes) const noexcept override;
};
 
[[nodiscard]] EBGEOMETRY_HOST
DeviceMemoryResource&
deviceMemoryResource() noexcept;
 
[[nodiscard]] EBGEOMETRY_HOST
ManagedMemoryResource&
managedMemoryResource() noexcept;
 
[[nodiscard]] EBGEOMETRY_HOST
PinnedMemoryResource&
pinnedMemoryResource() noexcept;
 
[[nodiscard]] EBGEOMETRY_HOST
MappedMemoryResource&
mappedMemoryResource() noexcept;
 
#endif // EBGEOMETRY_CUDA || EBGEOMETRY_HIP || EBGEOMETRY_DOXYGEN
 
} // namespace EBGeometry
 
#include "EBGeometry_MemoryResourceImplem.hpp"
 
#endif // EBGEOMETRY_MEMORYRESOURCE_HPP