arena_memory_resource.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/arena_memory_resource_impl.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <cstddef>
#include <optional>
 
RMM_NAMESPACE_BEGIN
namespace mr {

class RMM_EXPORT arena_memory_resource
  : public cuda::mr::shared_resource<detail::arena_memory_resource_impl> {
  using shared_base = cuda::mr::shared_resource<detail::arena_memory_resource_impl>;
 
 public:
  RMM_CONSTEXPR_FRIEND void get_property(arena_memory_resource const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

  explicit arena_memory_resource(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                                 std::optional<std::size_t> arena_size = std::nullopt,
                                 bool dump_log_on_failure              = false);
 
  ~arena_memory_resource() = default;
};
 
static_assert(cuda::mr::resource_with<arena_memory_resource, cuda::mr::device_accessible>,
              "arena_memory_resource does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END