device_memory_resource.hpp

/*
 * Copyright (c) 2019-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/aligned.hpp>
 
#include <cstddef>
#include <utility>
 
namespace rmm::mr {
 
class device_memory_resource {
 public:
  device_memory_resource()                              = default;
  virtual ~device_memory_resource()                     = default;
  device_memory_resource(device_memory_resource const&) = default;
  device_memory_resource& operator=(device_memory_resource const&) = default;
  device_memory_resource(device_memory_resource&&) noexcept        = default;
  device_memory_resource& operator=(device_memory_resource&&) noexcept = default;
 
  void* allocate(std::size_t bytes, cuda_stream_view stream = cuda_stream_view{})
  {
    return do_allocate(rmm::detail::align_up(bytes, allocation_size_alignment), stream);
  }
 
  void deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream = cuda_stream_view{})
  {
    do_deallocate(ptr, rmm::detail::align_up(bytes, allocation_size_alignment), stream);
  }
 
  [[nodiscard]] bool is_equal(device_memory_resource const& other) const noexcept
  {
    return do_is_equal(other);
  }
 
  [[nodiscard]] virtual bool supports_streams() const noexcept = 0;
 
  [[nodiscard]] virtual bool supports_get_mem_info() const noexcept = 0;
 
  [[nodiscard]] std::pair<std::size_t, std::size_t> get_mem_info(cuda_stream_view stream) const
  {
    return do_get_mem_info(stream);
  }
 
 private:
  // All allocations are padded to a multiple of allocation_size_alignment bytes.
  static constexpr auto allocation_size_alignment = std::size_t{8};
 
  virtual void* do_allocate(std::size_t bytes, cuda_stream_view stream) = 0;
 
  virtual void do_deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream) = 0;
 
  [[nodiscard]] virtual bool do_is_equal(device_memory_resource const& other) const noexcept
  {
    return this == &other;
  }
 
  [[nodiscard]] virtual std::pair<std::size_t, std::size_t> do_get_mem_info(
    cuda_stream_view stream) const = 0;
};
}  // namespace rmm::mr