cuda_memory_resource.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-2026, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/aligned.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
 
#include <cuda/memory_resource>
#include <cuda/stream_ref>
 
#include <cstddef>
 
namespace RMM_NAMESPACE {
namespace mr {
class cuda_memory_resource final {
 public:
  cuda_memory_resource()                            = default;
  ~cuda_memory_resource()                           = default;
  cuda_memory_resource(cuda_memory_resource const&) = default;  
  cuda_memory_resource(cuda_memory_resource&&)      = default;  
  cuda_memory_resource& operator=(cuda_memory_resource const&) =
    default;  
  cuda_memory_resource& operator=(cuda_memory_resource&&) =
    default;  
 
  void* allocate([[maybe_unused]] cuda::stream_ref stream,
                 std::size_t bytes,
                 [[maybe_unused]] std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT)
  {
    void* ptr{nullptr};
    RMM_CUDA_TRY_ALLOC(cudaMalloc(&ptr, bytes), bytes);
    return ptr;
  }
 
  void deallocate([[maybe_unused]] cuda::stream_ref stream,
                  void* ptr,
                  [[maybe_unused]] std::size_t bytes,
                  [[maybe_unused]] std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT) noexcept
  {
    RMM_ASSERT_CUDA_SUCCESS_SAFE_SHUTDOWN(cudaFree(ptr));
  }
 
  void* allocate_sync(std::size_t bytes, std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT)
  {
    auto* ptr = allocate(cuda::stream_ref{cudaStream_t{nullptr}}, bytes, alignment);
    RMM_CUDA_TRY(cudaStreamSynchronize(cudaStream_t{nullptr}));
    return ptr;
  }
 
  void deallocate_sync(void* ptr,
                       std::size_t bytes,
                       std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT) noexcept
  {
    deallocate(cuda::stream_ref{cudaStream_t{nullptr}}, ptr, bytes, alignment);
  }
 
  RMM_CONSTEXPR_FRIEND void get_property(cuda_memory_resource const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }
 
  [[nodiscard]] bool operator==(cuda_memory_resource const&) const noexcept { return true; }
 
  [[nodiscard]] bool operator!=(cuda_memory_resource const&) const noexcept { return false; }
};
 
// static property checks
static_assert(cuda::mr::synchronous_resource<cuda_memory_resource>);
static_assert(cuda::mr::resource<cuda_memory_resource>);
static_assert(
  cuda::mr::synchronous_resource_with<cuda_memory_resource, cuda::mr::device_accessible>);
static_assert(cuda::mr::resource_with<cuda_memory_resource, cuda::mr::device_accessible>);
  // end of group
}  // namespace mr
}  // namespace RMM_NAMESPACE