pinned_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/aligned.hpp>
#include <rmm/cuda_stream_view.hpp>
#include <rmm/detail/aligned.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/error.hpp>
#include <rmm/mr/host/host_memory_resource.hpp>
 
#include <cstddef>
 
namespace RMM_NAMESPACE {
namespace mr {
class [[deprecated(
  "pinned_memory_resource is deprecated in 25.12 and will be removed in 26.02. "
  "Use pinned_host_memory_resource instead.")]] pinned_memory_resource final
  : public host_memory_resource {
 public:
  pinned_memory_resource()                              = default;
  ~pinned_memory_resource() override                    = default;
  pinned_memory_resource(pinned_memory_resource const&) = default;  
  pinned_memory_resource(pinned_memory_resource&&)      = default;  
  pinned_memory_resource& operator=(pinned_memory_resource const&) =
    default;  
  pinned_memory_resource& operator=(pinned_memory_resource&&) =
    default;  
 
#ifdef RMM_ENABLE_LEGACY_MR_INTERFACE
#ifdef RMM_DEPRECATE_LEGACY_MR_INTERFACE
  [[deprecated(
    "This function is deprecated. Use allocate(cuda_stream_view stream, std::size_t bytes, "
    "std::size_t alignment) instead.")]]
#endif
  [[nodiscard]] void*
  allocate_async(std::size_t bytes, std::size_t alignment, cuda_stream_view)
  {
    return do_allocate(bytes, alignment);
  }
 
#ifdef RMM_DEPRECATE_LEGACY_MR_INTERFACE
  [[deprecated(
    "This function is deprecated. Use allocate(cuda_stream_view stream, std::size_t bytes, "
    "std::size_t alignment) instead.")]]
#endif
  [[nodiscard]] void*
  allocate_async(std::size_t bytes, cuda_stream_view)
  {
    return do_allocate(bytes);
  }
 
#ifdef RMM_DEPRECATE_LEGACY_MR_INTERFACE
  [[deprecated(
    "This function is deprecated. Use deallocate(cuda_stream_view stream, void* ptr, std::size_t "
    "bytes, std::size_t alignment) instead.")]]
#endif
  void deallocate_async(void* ptr,
                        std::size_t bytes,
                        std::size_t alignment,
                        cuda_stream_view) noexcept
  {
    do_deallocate(ptr, bytes);
  }
 
  // Explicitly inherit the allocate and deallocate functions from the host_memory_resource class.
  // Due to inheritance and name hiding rules, we need to declare these with "using" when we
  // override allocate and deallocate for CCCL 3.1.0+ compatibility.
  // Note: These methods are deprecated. Use allocate_sync/deallocate_sync or the stream-based
  // overloads instead.
  using host_memory_resource::allocate;
  using host_memory_resource::deallocate;
#endif  // RMM_ENABLE_LEGACY_MR_INTERFACE
 
  void* allocate(cuda_stream_view stream,
                 std::size_t bytes,
                 std::size_t alignment = rmm::RMM_DEFAULT_HOST_ALIGNMENT)
  {
    return do_allocate(bytes, alignment);
  }
 
  void deallocate(cuda_stream_view stream,
                  void* ptr,
                  std::size_t bytes,
                  std::size_t alignment = rmm::RMM_DEFAULT_HOST_ALIGNMENT) noexcept
  {
    return do_deallocate(ptr, bytes, alignment);
  }
 
  friend void get_property(pinned_memory_resource const&, cuda::mr::device_accessible) noexcept {}
 
 private:
  void* do_allocate(std::size_t bytes,
                    std::size_t alignment = rmm::RMM_DEFAULT_HOST_ALIGNMENT) override
  {
    // don't allocate anything if the user requested zero bytes
    if (0 == bytes) { return nullptr; }
 
    RMM_EXPECTS(rmm::is_supported_alignment(alignment),
                "Allocation alignment is not a power of 2.",
                rmm::bad_alloc);
 
    return rmm::detail::aligned_host_allocate(bytes, alignment, [](std::size_t size) {
      void* ptr{nullptr};
      RMM_CUDA_TRY_ALLOC(cudaMallocHost(&ptr, size), size);
      return ptr;
    });
  }
 
  void do_deallocate(void* ptr,
                     std::size_t bytes,
                     std::size_t alignment = rmm::RMM_DEFAULT_HOST_ALIGNMENT) noexcept override
  {
    if (nullptr == ptr) { return; }
    rmm::detail::aligned_host_deallocate(
      ptr, bytes, alignment, [](void* ptr) { RMM_ASSERT_CUDA_SUCCESS(cudaFreeHost(ptr)); });
  }
};
 
// static property checks
static_assert(rmm::detail::polyfill::async_resource_with<pinned_memory_resource,
                                                         cuda::mr::host_accessible,
                                                         cuda::mr::device_accessible>);
  // end of group
}  // namespace mr
}  // namespace RMM_NAMESPACE