resource_ref.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/detail/cccl_adaptors.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/mr/device_memory_resource.hpp>
 
namespace RMM_NAMESPACE {
 
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>>;
 
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};
}
 
// Verify that the device_memory_resource bridge constructors work correctly.
// These assertions validate that resource_ref types can be constructed from raw
// pointers/references.
static_assert(
  std::is_constructible_v<device_resource_ref, mr::device_memory_resource*>,
  "device_resource_ref must be constructible from device_memory_resource* (via bridge)");
static_assert(
  std::is_constructible_v<device_async_resource_ref, mr::device_memory_resource*>,
  "device_async_resource_ref must be constructible from device_memory_resource* (via bridge)");
static_assert(
  std::is_constructible_v<device_resource_ref, mr::device_memory_resource&>,
  "device_resource_ref must be constructible from device_memory_resource& (via bridge)");
static_assert(
  std::is_constructible_v<device_async_resource_ref, mr::device_memory_resource&>,
  "device_async_resource_ref must be constructible from device_memory_resource& (via bridge)");
 
// Verify that RMM resource_ref types can be constructed from corresponding CCCL resource_ref types.
static_assert(
  std::is_constructible_v<device_resource_ref,
                          cuda::mr::synchronous_resource_ref<cuda::mr::device_accessible>>,
  "device_resource_ref must be constructible from CCCL "
  "synchronous_resource_ref<device_accessible>");
static_assert(
  std::is_constructible_v<device_async_resource_ref,
                          cuda::mr::resource_ref<cuda::mr::device_accessible>>,
  "device_async_resource_ref must be constructible from CCCL resource_ref<device_accessible>");
static_assert(
  std::is_constructible_v<host_resource_ref,
                          cuda::mr::synchronous_resource_ref<cuda::mr::host_accessible>>,
  "host_resource_ref must be constructible from CCCL synchronous_resource_ref<host_accessible>");
static_assert(
  std::is_constructible_v<host_async_resource_ref,
                          cuda::mr::resource_ref<cuda::mr::host_accessible>>,
  "host_async_resource_ref must be constructible from CCCL resource_ref<host_accessible>");
static_assert(
  std::is_constructible_v<
    host_device_resource_ref,
    cuda::mr::synchronous_resource_ref<cuda::mr::host_accessible, cuda::mr::device_accessible>>,
  "host_device_resource_ref must be constructible from CCCL "
  "synchronous_resource_ref<host_accessible, device_accessible>");
static_assert(
  std::is_constructible_v<
    host_device_async_resource_ref,
    cuda::mr::resource_ref<cuda::mr::host_accessible, cuda::mr::device_accessible>>,
  "host_device_async_resource_ref must be constructible from CCCL resource_ref<host_accessible, "
  "device_accessible>");
 
// Verify that host_device resource refs can be converted to device-only and host-only resource
// refs. This is needed because a resource that is both host and device accessible can be used in
// contexts that only require one or the other.
static_assert(
  std::is_constructible_v<device_async_resource_ref, host_device_async_resource_ref>,
  "device_async_resource_ref must be constructible from host_device_async_resource_ref");
static_assert(std::is_constructible_v<device_resource_ref, host_device_resource_ref>,
              "device_resource_ref must be constructible from host_device_resource_ref");
static_assert(std::is_constructible_v<host_async_resource_ref, host_device_async_resource_ref>,
              "host_async_resource_ref must be constructible from host_device_async_resource_ref");
static_assert(std::is_constructible_v<host_resource_ref, host_device_resource_ref>,
              "host_resource_ref must be constructible from host_device_resource_ref");
  // end of group
}  // namespace RMM_NAMESPACE