sam_headroom_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/detail/export.hpp>
#include <rmm/mr/detail/sam_headroom_memory_resource_impl.hpp>
 
#include <cuda/memory_resource>
 
#include <cstddef>
 
RMM_NAMESPACE_BEGIN
namespace mr {
class RMM_EXPORT sam_headroom_memory_resource final
  : public cuda::mr::shared_resource<detail::sam_headroom_memory_resource_impl> {
  using shared_base = cuda::mr::shared_resource<detail::sam_headroom_memory_resource_impl>;
 
 public:
  RMM_CONSTEXPR_FRIEND void get_property(sam_headroom_memory_resource const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

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

  explicit sam_headroom_memory_resource(std::size_t headroom);
 
  sam_headroom_memory_resource()  = delete;
  ~sam_headroom_memory_resource() = default;
  sam_headroom_memory_resource(sam_headroom_memory_resource const&) =
    default;  
  sam_headroom_memory_resource(sam_headroom_memory_resource&&) =
    default;  
  sam_headroom_memory_resource& operator=(sam_headroom_memory_resource const&) =
    default;  
  sam_headroom_memory_resource& operator=(sam_headroom_memory_resource&&) =
    default;  
};
 
// static property checks
static_assert(cuda::mr::synchronous_resource<sam_headroom_memory_resource>);
static_assert(cuda::mr::resource<sam_headroom_memory_resource>);
static_assert(
  cuda::mr::synchronous_resource_with<sam_headroom_memory_resource, cuda::mr::device_accessible>);
static_assert(
  cuda::mr::synchronous_resource_with<sam_headroom_memory_resource, cuda::mr::host_accessible>);
static_assert(cuda::mr::resource_with<sam_headroom_memory_resource, cuda::mr::device_accessible>);
static_assert(cuda::mr::resource_with<sam_headroom_memory_resource, cuda::mr::host_accessible>);
  // end of group
}  // namespace mr
RMM_NAMESPACE_END