failure_callback_resource_adaptor.hpp

/*
 * 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/detail/error.hpp>
#include <rmm/mr/device/device_memory_resource.hpp>
 
#include <cstddef>
#include <functional>
#include <utility>
 
namespace rmm::mr {
 
using failure_callback_t = std::function<bool(std::size_t, void*)>;
 
template <typename Upstream, typename ExceptionType = rmm::out_of_memory>
class failure_callback_resource_adaptor final : public device_memory_resource {
 public:
  using exception_type = ExceptionType;  
 
  failure_callback_resource_adaptor(Upstream* upstream,
                                    failure_callback_t callback,
                                    void* callback_arg)
    : upstream_{upstream}, callback_{std::move(callback)}, callback_arg_{callback_arg}
  {
    RMM_EXPECTS(nullptr != upstream, "Unexpected null upstream resource pointer.");
  }
 
  failure_callback_resource_adaptor()                                         = delete;
  ~failure_callback_resource_adaptor() override                               = default;
  failure_callback_resource_adaptor(failure_callback_resource_adaptor const&) = delete;
  failure_callback_resource_adaptor& operator=(failure_callback_resource_adaptor const&) = delete;
  failure_callback_resource_adaptor(failure_callback_resource_adaptor&&) noexcept        = default;
  failure_callback_resource_adaptor& operator=(failure_callback_resource_adaptor&&) noexcept =
    default;
 
  Upstream* get_upstream() const noexcept { return upstream_; }
 
  [[nodiscard]] bool supports_streams() const noexcept override
  {
    return upstream_->supports_streams();
  }
 
  [[nodiscard]] 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
  {
    void* ret{};
 
    while (true) {
      try {
        ret = upstream_->allocate(bytes, stream);
        break;
      } catch (exception_type const& e) {
        if (!callback_(bytes, callback_arg_)) { throw; }
      }
    }
    return ret;
  }
 
  void do_deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream) override
  {
    upstream_->deallocate(ptr, bytes, stream);
  }
 
  [[nodiscard]] bool do_is_equal(device_memory_resource const& other) const noexcept override
  {
    if (this == &other) { return true; }
    auto cast = dynamic_cast<failure_callback_resource_adaptor<Upstream> const*>(&other);
    return cast != nullptr ? upstream_->is_equal(*cast->get_upstream())
                           : upstream_->is_equal(other);
  }
 
  [[nodiscard]] std::pair<std::size_t, std::size_t> do_get_mem_info(
    cuda_stream_view stream) const override
  {
    return upstream_->get_mem_info(stream);
  }
 
  Upstream* upstream_;  // the upstream resource used for satisfying allocation requests
  failure_callback_t callback_;
  void* callback_arg_;
};
 
}  // namespace rmm::mr