resource_ref.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2024-2025, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <rmm/detail/cccl_adaptors.hpp>
#include <rmm/detail/cuda_memory_resource.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
 
namespace RMM_NAMESPACE {
 
#if CCCL_MAJOR_VERSION > 3 || (CCCL_MAJOR_VERSION == 3 && CCCL_MINOR_VERSION >= 1)
 
using device_resource_ref =
  detail::cccl_resource_ref<cuda::mr::synchronous_resource_ref<cuda::mr::device_accessible>>;
 
using device_async_resource_ref =
  detail::cccl_async_resource_ref<cuda::mr::resource_ref<cuda::mr::device_accessible>>;
 
using host_resource_ref =
  detail::cccl_resource_ref<cuda::mr::synchronous_resource_ref<cuda::mr::host_accessible>>;
 
using host_async_resource_ref =
  detail::cccl_async_resource_ref<cuda::mr::resource_ref<cuda::mr::host_accessible>>;
 
using host_device_resource_ref = detail::cccl_resource_ref<
  cuda::mr::synchronous_resource_ref<cuda::mr::host_accessible, cuda::mr::device_accessible>>;
 
using host_device_async_resource_ref = detail::cccl_async_resource_ref<
  cuda::mr::resource_ref<cuda::mr::host_accessible, cuda::mr::device_accessible>>;
 
#else
 
using device_resource_ref =
  detail::cccl_resource_ref<cuda::mr::resource_ref<cuda::mr::device_accessible>>;
 
using device_async_resource_ref =
  detail::cccl_async_resource_ref<cuda::mr::async_resource_ref<cuda::mr::device_accessible>>;
 
using host_resource_ref =
  detail::cccl_resource_ref<cuda::mr::resource_ref<cuda::mr::host_accessible>>;
 
using host_async_resource_ref =
  detail::cccl_async_resource_ref<cuda::mr::async_resource_ref<cuda::mr::host_accessible>>;
 
using host_device_resource_ref = detail::cccl_resource_ref<
  cuda::mr::resource_ref<cuda::mr::host_accessible, cuda::mr::device_accessible>>;
 
using host_device_async_resource_ref = detail::cccl_async_resource_ref<
  cuda::mr::async_resource_ref<cuda::mr::host_accessible, cuda::mr::device_accessible>>;
 
#endif
 
template <class Resource>
device_async_resource_ref to_device_async_resource_ref_checked(Resource* res)
{
  RMM_EXPECTS(res, "Unexpected null resource pointer.");
  return device_async_resource_ref{*res};
}
  // end of group
}  // namespace RMM_NAMESPACE