statistics_resource_adaptor.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2020-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/detail/export.hpp>
#include <rmm/mr/detail/statistics_resource_adaptor_impl.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <cstddef>
#include <utility>
 
RMM_NAMESPACE_BEGIN
namespace mr {
class RMM_EXPORT statistics_resource_adaptor
  : public cuda::mr::shared_resource<detail::statistics_resource_adaptor_impl> {
  using shared_base = cuda::mr::shared_resource<detail::statistics_resource_adaptor_impl>;
 
 public:
  using counter = detail::statistics_resource_adaptor_impl::counter;
  using read_lock_t = detail::statistics_resource_adaptor_impl::read_lock_t;
  using write_lock_t = detail::statistics_resource_adaptor_impl::write_lock_t;

  RMM_CONSTEXPR_FRIEND void get_property(statistics_resource_adaptor const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

  explicit statistics_resource_adaptor(
    cuda::mr::any_resource<cuda::mr::device_accessible> upstream);
 
  ~statistics_resource_adaptor() = default;

  [[nodiscard]] device_async_resource_ref get_upstream_resource() const noexcept;

  [[nodiscard]] counter get_bytes_counter() const noexcept;

  [[nodiscard]] counter get_allocations_counter() const noexcept;

  std::pair<counter, counter> push_counters();

  std::pair<counter, counter> pop_counters();
};
 
static_assert(cuda::mr::resource_with<statistics_resource_adaptor, cuda::mr::device_accessible>,
              "statistics_resource_adaptor does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END