All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
host_memory_resource.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2025, NVIDIA CORPORATION.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
18 #include <rmm/detail/export.hpp>
19 #include <rmm/detail/nvtx/ranges.hpp>
20 
21 #include <cuda/memory_resource>
22 
23 #include <cstddef>
24 
25 namespace RMM_NAMESPACE {
26 namespace mr {
58  public:
59  host_memory_resource() = default;
60  virtual ~host_memory_resource() = default;
64  default;
65  host_memory_resource& operator=(host_memory_resource&&) noexcept =
66  default;
67 
80  void* allocate(std::size_t bytes, std::size_t alignment = alignof(std::max_align_t))
81  {
82  RMM_FUNC_RANGE();
83  return do_allocate(bytes, alignment);
84  }
85 
99  void deallocate(void* ptr, std::size_t bytes, std::size_t alignment = alignof(std::max_align_t))
100  {
101  RMM_FUNC_RANGE();
102  do_deallocate(ptr, bytes, alignment);
103  }
104 
117  [[nodiscard]] bool is_equal(host_memory_resource const& other) const noexcept
118  {
119  return do_is_equal(other);
120  }
121 
129  [[nodiscard]] bool operator==(host_memory_resource const& other) const noexcept
130  {
131  return do_is_equal(other);
132  }
133 
141  [[nodiscard]] bool operator!=(host_memory_resource const& other) const noexcept
142  {
143  return !do_is_equal(other);
144  }
145 
151  friend void get_property(host_memory_resource const&, cuda::mr::host_accessible) noexcept {}
152 
153  private:
166  virtual void* do_allocate(std::size_t bytes,
167  std::size_t alignment = alignof(std::max_align_t)) = 0;
168 
182  virtual void do_deallocate(void* ptr,
183  std::size_t bytes,
184  std::size_t alignment = alignof(std::max_align_t)) = 0;
185 
198  [[nodiscard]] virtual bool do_is_equal(host_memory_resource const& other) const noexcept
199  {
200  return this == &other;
201  }
202 };
203 static_assert(cuda::mr::resource_with<host_memory_resource, cuda::mr::host_accessible>); // end of group
205 
206 } // namespace mr
207 } // namespace RMM_NAMESPACE
Base class for host memory allocation.
Definition: host_memory_resource.hpp:57
bool is_equal(host_memory_resource const &other) const noexcept
Compare this resource to another.
Definition: host_memory_resource.hpp:117
host_memory_resource(host_memory_resource &&) noexcept=default
Default move constructor.
host_memory_resource(host_memory_resource const &)=default
Default copy constructor.
bool operator==(host_memory_resource const &other) const noexcept
Comparison operator with another host_memory_resource.
Definition: host_memory_resource.hpp:129
friend void get_property(host_memory_resource const &, cuda::mr::host_accessible) noexcept
Enables the cuda::mr::host_accessible property.
Definition: host_memory_resource.hpp:151
void deallocate(void *ptr, std::size_t bytes, std::size_t alignment=alignof(std::max_align_t))
Deallocate memory pointed to by ptr.
Definition: host_memory_resource.hpp:99
bool operator!=(host_memory_resource const &other) const noexcept
Comparison operator with another host_memory_resource.
Definition: host_memory_resource.hpp:141