failure_callback_resource_adaptor.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/aligned.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/mr/detail/failure_callback_resource_adaptor_impl.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <cstddef>
#include <utility>
 
RMM_NAMESPACE_BEGIN
namespace mr {

template <typename ExceptionType = rmm::out_of_memory>
class failure_callback_resource_adaptor
  : public cuda::mr::shared_resource<
      detail::failure_callback_resource_adaptor_impl<ExceptionType>> {
  using shared_base =
    cuda::mr::shared_resource<detail::failure_callback_resource_adaptor_impl<ExceptionType>>;
 
 public:
  using exception_type = ExceptionType;  

  RMM_CONSTEXPR_FRIEND void get_property(failure_callback_resource_adaptor const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

  failure_callback_resource_adaptor(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                                    failure_callback_t callback,
                                    void* callback_arg)
    : shared_base(cuda::mr::make_shared_resource<
                  detail::failure_callback_resource_adaptor_impl<ExceptionType>>(
        std::move(upstream), std::move(callback), callback_arg))
  {
  }
 
  ~failure_callback_resource_adaptor() = default;

  [[nodiscard]] device_async_resource_ref get_upstream_resource() const noexcept
  {
    return this->get().get_upstream_resource();
  }
};
 
static_assert(
  cuda::mr::resource_with<failure_callback_resource_adaptor<>, cuda::mr::device_accessible>,
  "failure_callback_resource_adaptor does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END