system_memory_resource.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/aligned.hpp>
#include <rmm/cuda_device.hpp>
#include <rmm/detail/export.hpp>
 
#include <cuda/memory_resource>
#include <cuda/stream>
#include <cuda_runtime_api.h>
 
#include <cstddef>
 
RMM_NAMESPACE_BEGIN
namespace mr {
 
namespace detail {
RMM_EXPORT bool is_system_memory_supported(cuda_device_id device_id);
}  // namespace detail

class RMM_EXPORT system_memory_resource final {
 public:
  system_memory_resource();
  ~system_memory_resource()                             = default;
  system_memory_resource(system_memory_resource const&) = default;  
  system_memory_resource(system_memory_resource&&)      = default;  
  system_memory_resource& operator=(system_memory_resource const&) =
    default;  
  system_memory_resource& operator=(system_memory_resource&&) =
    default;  

  [[nodiscard]] void* allocate([[maybe_unused]] cuda::stream_ref stream,
                               std::size_t bytes,
                               std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT);

  void deallocate(cuda::stream_ref stream,
                  void* ptr,
                  std::size_t bytes,
                  std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT) noexcept;

  [[nodiscard]] void* allocate_sync(std::size_t bytes,
                                    std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT);

  void deallocate_sync(void* ptr,
                       std::size_t bytes,
                       std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT) noexcept;

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

  RMM_CONSTEXPR_FRIEND void get_property(system_memory_resource const&,
                                         cuda::mr::host_accessible) noexcept
  {
  }

  [[nodiscard]] bool operator==(system_memory_resource const&) const noexcept;

  [[nodiscard]] bool operator!=(system_memory_resource const&) const noexcept;
};
 
// static property checks
static_assert(cuda::mr::synchronous_resource<system_memory_resource>);
static_assert(cuda::mr::resource<system_memory_resource>);
static_assert(
  cuda::mr::synchronous_resource_with<system_memory_resource, cuda::mr::device_accessible>);
static_assert(
  cuda::mr::synchronous_resource_with<system_memory_resource, cuda::mr::host_accessible>);
static_assert(cuda::mr::resource_with<system_memory_resource, cuda::mr::device_accessible>);
static_assert(cuda::mr::resource_with<system_memory_resource, cuda::mr::host_accessible>);  // end of group
}  // namespace mr
RMM_NAMESPACE_END