statistics_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/mr/device/device_memory_resource.hpp>
 
#include <cstddef>
#include <mutex>
#include <shared_mutex>
 
namespace rmm::mr {
template <typename Upstream>
class statistics_resource_adaptor final : public device_memory_resource {
 public:
  // can be a std::shared_mutex once C++17 is adopted
  using read_lock_t =
    std::shared_lock<std::shared_timed_mutex>;  
  using write_lock_t =
    std::unique_lock<std::shared_timed_mutex>;  
  struct counter {
    int64_t value{0};  
    int64_t peak{0};   
    int64_t total{0};  
 
    counter& operator+=(int64_t val)
    {
      value += val;
      total += val;
      peak = std::max(value, peak);
      return *this;
    }
 
    counter& operator-=(int64_t val)
    {
      value -= val;
      return *this;
    }
  };
 
  statistics_resource_adaptor(Upstream* upstream) : upstream_{upstream}
  {
    RMM_EXPECTS(nullptr != upstream, "Unexpected null upstream resource pointer.");
  }
 
  statistics_resource_adaptor()                                              = delete;
  ~statistics_resource_adaptor() override                                    = default;
  statistics_resource_adaptor(statistics_resource_adaptor const&)            = delete;
  statistics_resource_adaptor& operator=(statistics_resource_adaptor const&) = delete;
  statistics_resource_adaptor(statistics_resource_adaptor&&) noexcept =
    default;  
  statistics_resource_adaptor& operator=(statistics_resource_adaptor&&) noexcept =
    default;  
 
  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();
  }
 
  counter get_bytes_counter() const noexcept
  {
    read_lock_t lock(mtx_);
 
    return bytes_;
  }
 
  counter get_allocations_counter() const noexcept
  {
    read_lock_t lock(mtx_);
 
    return allocations_;
  }
 
 private:
  void* do_allocate(std::size_t bytes, cuda_stream_view stream) override
  {
    void* ptr = upstream_->allocate(bytes, stream);
 
    // increment the stats
    {
      write_lock_t lock(mtx_);
 
      // Increment the allocation_count_ while we have the lock
      bytes_ += bytes;
      allocations_ += 1;
    }
 
    return ptr;
  }
 
  void do_deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream) override
  {
    upstream_->deallocate(ptr, bytes, stream);
 
    {
      write_lock_t lock(mtx_);
 
      // Decrement the current allocated counts.
      bytes_ -= bytes;
      allocations_ -= 1;
    }
  }
 
  bool do_is_equal(device_memory_resource const& other) const noexcept override
  {
    if (this == &other) { return true; }
    auto cast = dynamic_cast<statistics_resource_adaptor<Upstream> const*>(&other);
    return cast != nullptr ? upstream_->is_equal(*cast->get_upstream())
                           : upstream_->is_equal(other);
  }
 
  std::pair<std::size_t, std::size_t> do_get_mem_info(cuda_stream_view stream) const override
  {
    return upstream_->get_mem_info(stream);
  }
 
  counter bytes_;                        // peak, current and total allocated bytes
  counter allocations_;                  // peak, current and total allocation count
  std::shared_timed_mutex mutable mtx_;  // mutex for thread safe access to allocations_
  Upstream* upstream_;  // the upstream resource used for satisfying allocation requests
};
 
template <typename Upstream>
statistics_resource_adaptor<Upstream> make_statistics_adaptor(Upstream* upstream)
{
  return statistics_resource_adaptor<Upstream>{upstream};
}
  // end of group
}  // namespace rmm::mr