thread_safe_resource_adaptor.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/cuda_stream_view.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/mr/device/device_memory_resource.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cstddef>
#include <mutex>
 
namespace RMM_NAMESPACE {
namespace mr {
template <typename Upstream>
class thread_safe_resource_adaptor final : public device_memory_resource {
 public:
  using lock_t = std::lock_guard<std::mutex>;  
 
  thread_safe_resource_adaptor(device_async_resource_ref upstream) : upstream_{upstream} {}
 
  thread_safe_resource_adaptor(Upstream* upstream)
    : upstream_{to_device_async_resource_ref_checked(upstream)}
  {
  }
 
  thread_safe_resource_adaptor()                                               = delete;
  ~thread_safe_resource_adaptor() override                                     = default;
  thread_safe_resource_adaptor(thread_safe_resource_adaptor const&)            = delete;
  thread_safe_resource_adaptor(thread_safe_resource_adaptor&&)                 = delete;
  thread_safe_resource_adaptor& operator=(thread_safe_resource_adaptor const&) = delete;
  thread_safe_resource_adaptor& operator=(thread_safe_resource_adaptor&&)      = delete;
 
  [[nodiscard]] rmm::device_async_resource_ref get_upstream_resource() const noexcept
  {
    return upstream_;
  }
 
 private:
  void* do_allocate(std::size_t bytes, cuda_stream_view stream) override
  {
    lock_t lock(mtx);
    return get_upstream_resource().allocate(stream, bytes);
  }
 
  void do_deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream) noexcept override
  {
    lock_t lock(mtx);
    get_upstream_resource().deallocate(stream, ptr, bytes);
  }
 
  bool do_is_equal(device_memory_resource const& other) const noexcept override
  {
    if (this == &other) { return true; }
    auto cast = dynamic_cast<thread_safe_resource_adaptor<Upstream> const*>(&other);
    if (cast == nullptr) { return false; }
    return get_upstream_resource() == cast->get_upstream_resource();
  }
 
  std::mutex mutable mtx;  // mutex for thread safe access to upstream
  device_async_resource_ref
    upstream_;  
};
  // end of group
}  // namespace mr
}  // namespace RMM_NAMESPACE