binning_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/binning_memory_resource_impl.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <cstddef>
#include <optional>
 
RMM_NAMESPACE_BEGIN
namespace mr {

class RMM_EXPORT binning_memory_resource
  : public cuda::mr::shared_resource<detail::binning_memory_resource_impl> {
  using shared_base = cuda::mr::shared_resource<detail::binning_memory_resource_impl>;
 
 public:
  RMM_CONSTEXPR_FRIEND void get_property(binning_memory_resource const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

  explicit binning_memory_resource(cuda::mr::any_resource<cuda::mr::device_accessible> upstream);

  binning_memory_resource(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                          int8_t min_size_exponent,  // NOLINT(bugprone-easily-swappable-parameters)
                          int8_t max_size_exponent);
 
  ~binning_memory_resource() = default;

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

  void add_bin(std::size_t allocation_size,
               std::optional<device_async_resource_ref> bin_resource = std::nullopt);
};
 
static_assert(cuda::mr::resource_with<binning_memory_resource, cuda::mr::device_accessible>,
              "binning_memory_resource does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END