tracking_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/tracking_resource_adaptor_impl.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <cstddef>
#include <map>
#include <memory>
#include <string>
 
RMM_NAMESPACE_BEGIN
namespace mr {
class RMM_EXPORT tracking_resource_adaptor
  : public cuda::mr::shared_resource<detail::tracking_resource_adaptor_impl> {
  using shared_base = cuda::mr::shared_resource<detail::tracking_resource_adaptor_impl>;
 
 public:
  using allocation_info = detail::tracking_resource_adaptor_impl::allocation_info;
  using read_lock_t = detail::tracking_resource_adaptor_impl::read_lock_t;
  using write_lock_t = detail::tracking_resource_adaptor_impl::write_lock_t;

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

  tracking_resource_adaptor(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                            bool capture_stacks = false);
 
  ~tracking_resource_adaptor() = default;

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

  [[nodiscard]] std::map<void*, allocation_info> const& get_outstanding_allocations()
    const noexcept;

  [[nodiscard]] std::size_t get_allocated_bytes() const noexcept;

  [[nodiscard]] std::string get_outstanding_allocations_str() const;

  void log_outstanding_allocations() const;
};
 
static_assert(cuda::mr::resource_with<tracking_resource_adaptor, cuda::mr::device_accessible>,
              "tracking_resource_adaptor does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END