thread_safe_resource_adaptor.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2021, 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/cuda_stream_view.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/mr/device/device_memory_resource.hpp>
 
#include <cstddef>
#include <mutex>
 
namespace rmm::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(Upstream* upstream) : upstream_{upstream}
  {
    RMM_EXPECTS(nullptr != upstream, "Unexpected null upstream resource pointer.");
  }
 
  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;
 
  Upstream* get_upstream() const noexcept { return upstream_; }
 
  bool supports_streams() const noexcept override { return upstream_->supports_streams(); }
 
  bool supports_get_mem_info() const noexcept override
  {
    return upstream_->supports_get_mem_info();
  }
 
 private:
  void* do_allocate(std::size_t bytes, cuda_stream_view stream) override
  {
    lock_t lock(mtx);
    return upstream_->allocate(bytes, stream);
  }
 
  void do_deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream) override
  {
    lock_t lock(mtx);
    upstream_->deallocate(ptr, bytes, stream);
  }
 
  bool do_is_equal(device_memory_resource const& other) const noexcept override
  {
    if (this == &other) { return true; }
    auto thread_safe_other = dynamic_cast<thread_safe_resource_adaptor<Upstream> const*>(&other);
    if (thread_safe_other != nullptr) {
      return upstream_->is_equal(*thread_safe_other->get_upstream());
    }
    return upstream_->is_equal(other);
  }
 
  std::pair<std::size_t, std::size_t> do_get_mem_info(cuda_stream_view stream) const override
  {
    lock_t lock(mtx);
    return upstream_->get_mem_info(stream);
  }
 
  std::mutex mutable mtx;  // mutex for thread safe access to upstream
  Upstream* upstream_;     
};
  // end of group
}  // namespace rmm::mr