host_memory_resource.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/detail/cuda_memory_resource.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/detail/nvtx/ranges.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cstddef>
 
namespace RMM_NAMESPACE {
namespace mr {
class [[deprecated("host_memory_resource is deprecated in 25.12 and will be removed in 26.02.")]]
host_memory_resource {
 public:
  host_memory_resource()                                = default;
  virtual ~host_memory_resource()                       = default;
  host_memory_resource(host_memory_resource const&)     = default;  
  host_memory_resource(host_memory_resource&&) noexcept = default;  
  host_memory_resource& operator=(host_memory_resource const&) =
    default;  
  host_memory_resource& operator=(host_memory_resource&&) noexcept =
    default;  
 
#ifdef RMM_ENABLE_LEGACY_MR_INTERFACE
#ifdef RMM_DEPRECATE_LEGACY_MR_INTERFACE
  [[deprecated(
    "This function is deprecated. Use allocate_sync(std::size_t bytes, std::size_t alignment) "
    "instead.")]]
#endif
  void* allocate(std::size_t bytes, std::size_t alignment = alignof(std::max_align_t))
  {
    RMM_FUNC_RANGE();
    return do_allocate(bytes, alignment);
  }
 
#ifdef RMM_DEPRECATE_LEGACY_MR_INTERFACE
  [[deprecated(
    "This function is deprecated. Use deallocate_sync(void* ptr, std::size_t bytes, std::size_t "
    "alignment) instead.")]]
#endif
  void deallocate(void* ptr,
                  std::size_t bytes,
                  std::size_t alignment = alignof(std::max_align_t)) noexcept
  {
    RMM_FUNC_RANGE();
    do_deallocate(ptr, bytes, alignment);
  }
#endif  // RMM_ENABLE_LEGACY_MR_INTERFACE
 
  void* allocate_sync(std::size_t bytes, std::size_t alignment = alignof(std::max_align_t))
  {
    RMM_FUNC_RANGE();
    return do_allocate(bytes, alignment);
  }
 
  void deallocate_sync(void* ptr,
                       std::size_t bytes,
                       std::size_t alignment = alignof(std::max_align_t)) noexcept
  {
    RMM_FUNC_RANGE();
    do_deallocate(ptr, bytes, alignment);
  }
 
  [[nodiscard]] bool is_equal(host_memory_resource const& other) const noexcept
  {
    return do_is_equal(other);
  }
 
  [[nodiscard]] bool operator==(host_memory_resource const& other) const noexcept
  {
    return do_is_equal(other);
  }
 
  [[nodiscard]] bool operator!=(host_memory_resource const& other) const noexcept
  {
    return !do_is_equal(other);
  }
 
  friend void get_property(host_memory_resource const&, cuda::mr::host_accessible) noexcept {}
 
 private:
  virtual void* do_allocate(std::size_t bytes,
                            std::size_t alignment = alignof(std::max_align_t)) = 0;
 
  virtual void do_deallocate(void* ptr,
                             std::size_t bytes,
                             std::size_t alignment = alignof(std::max_align_t)) noexcept = 0;
 
  [[nodiscard]] virtual bool do_is_equal(host_memory_resource const& other) const noexcept
  {
    return this == &other;
  }
};
 
// static property checks
static_assert(
  rmm::detail::polyfill::resource_with<host_memory_resource, cuda::mr::host_accessible>);
  // end of group
 
}  // namespace mr
}  // namespace RMM_NAMESPACE