fixed_size_memory_resource.hpp

Go to the documentation of this file.

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

class RMM_EXPORT fixed_size_memory_resource
  : public cuda::mr::shared_resource<detail::fixed_size_memory_resource_impl> {
  using shared_base = cuda::mr::shared_resource<detail::fixed_size_memory_resource_impl>;
 
 public:
  RMM_CONSTEXPR_FRIEND void get_property(fixed_size_memory_resource const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }
 
  static constexpr std::size_t default_block_size = 1 << 20;  

  static constexpr std::size_t default_blocks_to_preallocate = 128;

  explicit fixed_size_memory_resource(
    cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
    // NOLINTNEXTLINE bugprone-easily-swappable-parameters
    std::size_t block_size            = default_block_size,
    std::size_t blocks_to_preallocate = default_blocks_to_preallocate);
 
  ~fixed_size_memory_resource() = default;

  [[nodiscard]] device_async_resource_ref get_upstream_resource() const noexcept;

  [[nodiscard]] std::size_t get_block_size() const noexcept;
};
 
static_assert(cuda::mr::resource_with<fixed_size_memory_resource, cuda::mr::device_accessible>,
              "fixed_size_memory_resource does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END