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/cuda_device.hpp>
#include <rmm/mr/per_device_resource.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <concepts>
#include <utility>
 
namespace cudf {
 
inline rmm::device_async_resource_ref get_current_device_resource_ref()
{
  return rmm::mr::get_current_device_resource_ref();
}
 
class memory_resources {
 public:
  template <typename Resource>
  memory_resources(Resource&& output_mr)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    requires std::constructible_from<rmm::device_async_resource_ref, Resource&&>
#endif
    : _output_mr{std::forward<Resource>(output_mr)},
      _temporary_mr{cudf::get_current_device_resource_ref()}
  {
  }
 
  template <typename OutputResource, typename TemporaryResource>
  memory_resources(OutputResource&& output_mr, TemporaryResource&& temporary_mr)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    requires(std::constructible_from<rmm::device_async_resource_ref, OutputResource &&> and
             std::constructible_from<rmm::device_async_resource_ref, TemporaryResource &&>)
#endif
    : _output_mr{std::forward<OutputResource>(output_mr)},
      _temporary_mr{std::forward<TemporaryResource>(temporary_mr)}
  {
  }
 
  [[nodiscard]] rmm::device_async_resource_ref get_output_mr() const noexcept { return _output_mr; }
 
  [[nodiscard]] rmm::device_async_resource_ref get_temporary_mr() const noexcept
  {
    return _temporary_mr;
  }
 
 private:
  rmm::device_async_resource_ref _output_mr;
  rmm::device_async_resource_ref _temporary_mr;
};
 
inline cuda::mr::any_resource<cuda::mr::device_accessible> set_current_device_resource(
  cuda::mr::any_resource<cuda::mr::device_accessible> mr)
{
  return rmm::mr::set_current_device_resource(std::move(mr));
}
 
[[deprecated("Use set_current_device_resource instead.")]]  //
inline cuda::mr::any_resource<cuda::mr::device_accessible>
set_current_device_resource_ref(rmm::device_async_resource_ref mr)
{
  return set_current_device_resource(cuda::mr::any_resource<cuda::mr::device_accessible>{mr});
}
 
inline cuda::mr::any_resource<cuda::mr::device_accessible> reset_current_device_resource()
{
  return rmm::mr::reset_current_device_resource();
}
 
[[deprecated("Use reset_current_device_resource instead.")]]  //
inline cuda::mr::any_resource<cuda::mr::device_accessible>
reset_current_device_resource_ref()
{
  return reset_current_device_resource();
}
  // end of group
}  // namespace cudf