cuda_async_memory_resource.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/aligned.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/mr/detail/cuda_async_memory_resource_impl.hpp>
 
#include <cuda/memory_resource>
#include <cuda_runtime_api.h>
 
#include <cstddef>
#include <cstdint>
#include <optional>
 
RMM_NAMESPACE_BEGIN
namespace mr {

class RMM_EXPORT cuda_async_memory_resource final
  : public cuda::mr::shared_resource<detail::cuda_async_memory_resource_impl> {
  using shared_base = cuda::mr::shared_resource<detail::cuda_async_memory_resource_impl>;
 
 public:
  enum class allocation_handle_type : std::int32_t {
    none = cudaMemHandleTypeNone,  
    posix_file_descriptor =
      cudaMemHandleTypePosixFileDescriptor,  
    win32 =
      cudaMemHandleTypeWin32,  
    win32_kmt = cudaMemHandleTypeWin32Kmt,  
    fabric = 0x8  
  };

  RMM_CONSTEXPR_FRIEND void get_property(cuda_async_memory_resource const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

  // NOLINTNEXTLINE(bugprone-easily-swappable-parameters)
  cuda_async_memory_resource(std::optional<std::size_t> initial_pool_size             = {},
                             std::optional<std::size_t> release_threshold             = {},
                             std::optional<allocation_handle_type> export_handle_type = {});

  [[nodiscard]] cudaMemPool_t pool_handle() const noexcept;
 
  ~cuda_async_memory_resource() = default;
  cuda_async_memory_resource(cuda_async_memory_resource const&) =
    default;  
  cuda_async_memory_resource(cuda_async_memory_resource&&) =
    default;  
  cuda_async_memory_resource& operator=(cuda_async_memory_resource const&) =
    default;  
  cuda_async_memory_resource& operator=(cuda_async_memory_resource&&) =
    default;  
};
 
// static property checks
static_assert(cuda::mr::synchronous_resource<cuda_async_memory_resource>);
static_assert(cuda::mr::resource<cuda_async_memory_resource>);
static_assert(
  cuda::mr::synchronous_resource_with<cuda_async_memory_resource, cuda::mr::device_accessible>);
static_assert(cuda::mr::resource_with<cuda_async_memory_resource, cuda::mr::device_accessible>);
  // end of group
}  // namespace mr
RMM_NAMESPACE_END