callback_memory_resource.hpp
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
7 #include <rmm/detail/export.hpp>
8 #include <rmm/mr/detail/callback_memory_resource_impl.hpp>
9 #include <rmm/resource_ref.hpp>
10 
11 #include <cuda/memory_resource>
12 #include <cuda/stream>
13 
14 #include <cstddef>
15 #include <functional>
16 
17 RMM_NAMESPACE_BEGIN
18 namespace mr {
37 using allocate_callback_t = std::function<void*(std::size_t, cuda::stream_ref, void*)>;
38 
53 using deallocate_callback_t = std::function<void(void*, std::size_t, cuda::stream_ref, void*)>;
54 
55 namespace detail {
56 class callback_memory_resource_impl;
57 }
58 
66 class RMM_EXPORT callback_memory_resource
67  : public cuda::mr::shared_resource<detail::callback_memory_resource_impl> {
68  using shared_base = cuda::mr::shared_resource<detail::callback_memory_resource_impl>;
69 
70  public:
74  RMM_CONSTEXPR_FRIEND void get_property(callback_memory_resource const&,
75  cuda::mr::device_accessible) noexcept
76  {
77  }
78 
95  deallocate_callback_t deallocate_callback,
96  void* allocate_callback_arg = nullptr,
97  void* deallocate_callback_arg = nullptr);
98 
99  callback_memory_resource() = delete;
100  ~callback_memory_resource() = default;
101 };
102 
103 static_assert(cuda::mr::resource_with<callback_memory_resource, cuda::mr::device_accessible>,
104  "callback_memory_resource does not satisfy the cuda::mr::resource concept");
105  // end of group
107 } // namespace mr
108 RMM_NAMESPACE_END
A device memory resource that uses the provided callbacks for memory allocation and deallocation.
Definition: callback_memory_resource.hpp:67
friend void get_property(callback_memory_resource const &, cuda::mr::device_accessible) noexcept
Enables the cuda::mr::device_accessible property.
Definition: callback_memory_resource.hpp:74
callback_memory_resource(allocate_callback_t allocate_callback, deallocate_callback_t deallocate_callback, void *allocate_callback_arg=nullptr, void *deallocate_callback_arg=nullptr)
Construct a new callback memory resource.
std::function< void *(std::size_t, cuda::stream_ref, void *)> allocate_callback_t
Callback function type used by callback memory resource for allocation.
Definition: callback_memory_resource.hpp:37
std::function< void(void *, std::size_t, cuda::stream_ref, void *)> deallocate_callback_t
Callback function type used by callback_memory_resource for deallocation.
Definition: callback_memory_resource.hpp:53