All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
device_uvector.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 
17 #pragma once
18 
19 #include <rmm/cuda_stream_view.hpp>
20 #include <rmm/detail/error.hpp>
21 #include <rmm/detail/exec_check_disable.hpp>
22 #include <rmm/detail/export.hpp>
23 #include <rmm/device_buffer.hpp>
25 #include <rmm/resource_ref.hpp>
26 
27 #include <cuda/memory_resource>
28 
29 #include <cstddef>
30 #include <type_traits>
31 #include <utility>
32 
33 namespace RMM_NAMESPACE {
77 template <typename T>
79  static_assert(std::is_trivially_copyable_v<T>,
80  "device_uvector only supports types that are trivially copyable.");
81 
82  public:
83  using value_type = T;
84  using size_type = std::size_t;
85  using reference = value_type&;
86  using const_reference = value_type const&;
88  using pointer = value_type*;
89  using const_pointer = value_type const*;
90  using iterator = pointer;
92 
93  RMM_EXEC_CHECK_DISABLE
94  ~device_uvector() = default;
95 
96  RMM_EXEC_CHECK_DISABLE
97  device_uvector(device_uvector&&) noexcept = default;
98 
99  RMM_EXEC_CHECK_DISABLE
100  device_uvector& operator=(device_uvector&&) noexcept =
101  default;
102 
106  device_uvector(device_uvector const&) = delete;
107 
111  device_uvector& operator=(device_uvector const&) = delete;
112 
116  device_uvector() = delete;
117 
129  explicit device_uvector(std::size_t size,
130  cuda_stream_view stream,
132  : _storage{elements_to_bytes(size), stream, mr}
133  {
134  }
135 
145  explicit device_uvector(device_uvector const& other,
146  cuda_stream_view stream,
148  : _storage{other._storage, stream, mr}
149  {
150  }
151 
160  [[nodiscard]] pointer element_ptr(std::size_t element_index) noexcept
161  {
162  assert(element_index < size());
163  return data() + element_index;
164  }
165 
174  [[nodiscard]] const_pointer element_ptr(std::size_t element_index) const noexcept
175  {
176  assert(element_index < size());
177  return data() + element_index;
178  }
179 
216  void set_element_async(std::size_t element_index,
217  value_type const& value,
218  cuda_stream_view stream)
219  {
220  RMM_EXPECTS(
221  element_index < size(), "Attempt to access out of bounds element.", rmm::out_of_range);
222 
223  if constexpr (std::is_same_v<value_type, bool>) {
224  RMM_CUDA_TRY(
225  cudaMemsetAsync(element_ptr(element_index), value, sizeof(value), stream.value()));
226  return;
227  }
228 
229  if constexpr (std::is_fundamental_v<value_type>) {
230  if (value == value_type{0}) {
231  set_element_to_zero_async(element_index, stream);
232  return;
233  }
234  }
235 
236  RMM_CUDA_TRY(cudaMemcpyAsync(
237  element_ptr(element_index), &value, sizeof(value), cudaMemcpyDefault, stream.value()));
238  }
239 
240  // We delete the r-value reference overload to prevent asynchronously copying from a literal or
241  // implicit temporary value after it is deleted or goes out of scope.
242  void set_element_async(std::size_t, value_type const&&, cuda_stream_view) = delete;
243 
266  void set_element_to_zero_async(std::size_t element_index, cuda_stream_view stream)
267  {
268  RMM_EXPECTS(
269  element_index < size(), "Attempt to access out of bounds element.", rmm::out_of_range);
270  RMM_CUDA_TRY(
271  cudaMemsetAsync(element_ptr(element_index), 0, sizeof(value_type), stream.value()));
272  }
273 
303  void set_element(std::size_t element_index, T const& value, cuda_stream_view stream)
304  {
305  set_element_async(element_index, value, stream);
306  stream.synchronize_no_throw();
307  }
308 
321  [[nodiscard]] value_type element(std::size_t element_index, cuda_stream_view stream) const
322  {
323  RMM_EXPECTS(
324  element_index < size(), "Attempt to access out of bounds element.", rmm::out_of_range);
325  value_type value;
326  RMM_CUDA_TRY(cudaMemcpyAsync(
327  &value, element_ptr(element_index), sizeof(value), cudaMemcpyDefault, stream.value()));
328  stream.synchronize();
329  return value;
330  }
331 
343  [[nodiscard]] value_type front_element(cuda_stream_view stream) const
344  {
345  return element(0, stream);
346  }
347 
359  [[nodiscard]] value_type back_element(cuda_stream_view stream) const
360  {
361  return element(size() - 1, stream);
362  }
363 
376  void reserve(std::size_t new_capacity, cuda_stream_view stream)
377  {
378  _storage.reserve(elements_to_bytes(new_capacity), stream);
379  }
380 
397  void resize(std::size_t new_size, cuda_stream_view stream)
398  {
399  _storage.resize(elements_to_bytes(new_size), stream);
400  }
401 
409  void shrink_to_fit(cuda_stream_view stream) { _storage.shrink_to_fit(stream); }
410 
416  device_buffer release() noexcept { return std::move(_storage); }
417 
424  [[nodiscard]] std::size_t capacity() const noexcept
425  {
426  return bytes_to_elements(_storage.capacity());
427  }
428 
437  [[nodiscard]] pointer data() noexcept { return static_cast<pointer>(_storage.data()); }
438 
447  [[nodiscard]] const_pointer data() const noexcept
448  {
449  return static_cast<const_pointer>(_storage.data());
450  }
451 
459  [[nodiscard]] iterator begin() noexcept { return data(); }
460 
468  [[nodiscard]] const_iterator cbegin() const noexcept { return data(); }
469 
477  [[nodiscard]] const_iterator begin() const noexcept { return cbegin(); }
478 
487  [[nodiscard]] iterator end() noexcept { return data() + size(); }
488 
497  [[nodiscard]] const_iterator cend() const noexcept { return data() + size(); }
498 
507  [[nodiscard]] const_iterator end() const noexcept { return cend(); }
508 
512  [[nodiscard]] std::size_t size() const noexcept { return bytes_to_elements(_storage.size()); }
513 
517  [[nodiscard]] std::int64_t ssize() const noexcept
518  {
519  assert(size() < static_cast<std::size_t>(std::numeric_limits<int64_t>::max()) &&
520  "Size overflows signed integer");
521  return static_cast<int64_t>(size());
522  }
523 
527  [[nodiscard]] bool is_empty() const noexcept { return size() == 0; }
528 
533  [[nodiscard]] rmm::device_async_resource_ref memory_resource() const noexcept
534  {
535  return _storage.memory_resource();
536  }
537 
541  [[nodiscard]] cuda_stream_view stream() const noexcept { return _storage.stream(); }
542 
554  void set_stream(cuda_stream_view stream) noexcept { _storage.set_stream(stream); }
555 
556  private:
557  device_buffer _storage{};
558 
559  [[nodiscard]] std::size_t constexpr elements_to_bytes(std::size_t num_elements) const noexcept
560  {
561  return num_elements * sizeof(value_type);
562  }
563 
564  [[nodiscard]] std::size_t constexpr bytes_to_elements(std::size_t num_bytes) const noexcept
565  {
566  return num_bytes / sizeof(value_type);
567  }
568 };
569  // end of group
571 } // namespace RMM_NAMESPACE
Strongly-typed non-owning wrapper for CUDA streams with default constructor.
Definition: cuda_stream_view.hpp:39
constexpr cudaStream_t value() const noexcept
Get the wrapped stream.
Definition: cuda_stream_view.hpp:73
void synchronize() const
Synchronize the viewed CUDA stream.
Definition: cuda_stream_view.hpp:106
void synchronize_no_throw() const noexcept
Synchronize the viewed CUDA stream. Does not throw if there is an error.
Definition: cuda_stream_view.hpp:113
RAII construct for device memory allocation.
Definition: device_buffer.hpp:83
An uninitialized vector of elements in device memory.
Definition: device_uvector.hpp:78
const_iterator cend() const noexcept
Returns a const_iterator to the element following the last element of the vector.
Definition: device_uvector.hpp:497
std::size_t capacity() const noexcept
Returns the number of elements that can be held in currently allocated storage.
Definition: device_uvector.hpp:424
void resize(std::size_t new_size, cuda_stream_view stream)
Resizes the vector to contain new_size elements.
Definition: device_uvector.hpp:397
value_type * pointer
The type of the pointer returned by data()
Definition: device_uvector.hpp:88
const_pointer element_ptr(std::size_t element_index) const noexcept
Returns pointer to the specified element.
Definition: device_uvector.hpp:174
bool is_empty() const noexcept
true if the vector contains no elements, i.e. size() == 0
Definition: device_uvector.hpp:527
const_pointer data() const noexcept
Returns const pointer to underlying device storage.
Definition: device_uvector.hpp:447
std::size_t size() const noexcept
The number of elements in the vector.
Definition: device_uvector.hpp:512
pointer data() noexcept
Returns pointer to underlying device storage.
Definition: device_uvector.hpp:437
void shrink_to_fit(cuda_stream_view stream)
Forces deallocation of unused device memory.
Definition: device_uvector.hpp:409
iterator end() noexcept
Returns an iterator to the element following the last element of the vector.
Definition: device_uvector.hpp:487
std::size_t size_type
The type used for the size of the vector.
Definition: device_uvector.hpp:84
pointer element_ptr(std::size_t element_index) noexcept
Returns pointer to the specified element.
Definition: device_uvector.hpp:160
std::int64_t ssize() const noexcept
The signed number of elements in the vector.
Definition: device_uvector.hpp:517
T value_type
T; stored value type.
Definition: device_uvector.hpp:83
const_iterator cbegin() const noexcept
Returns a const_iterator to the first element.
Definition: device_uvector.hpp:468
value_type back_element(cuda_stream_view stream) const
Returns the last element.
Definition: device_uvector.hpp:359
void set_element_to_zero_async(std::size_t element_index, cuda_stream_view stream)
Asynchronously sets the specified element to zero in device memory.
Definition: device_uvector.hpp:266
const_pointer const_iterator
The type of the const iterator returned by cbegin()
Definition: device_uvector.hpp:91
device_buffer release() noexcept
Release ownership of device memory storage.
Definition: device_uvector.hpp:416
void set_element_async(std::size_t element_index, value_type const &value, cuda_stream_view stream)
Performs an asynchronous copy of v to the specified element in device memory.
Definition: device_uvector.hpp:216
device_uvector(device_uvector &&) noexcept=default
Default move constructor.
pointer iterator
The type of the iterator returned by begin()
Definition: device_uvector.hpp:90
value_type & reference
value_type&; reference type returned by operator[](size_type)
Definition: device_uvector.hpp:85
const_iterator end() const noexcept
Returns an iterator to the element following the last element of the vector.
Definition: device_uvector.hpp:507
void reserve(std::size_t new_capacity, cuda_stream_view stream)
Increases the capacity of the vector to new_capacity elements.
Definition: device_uvector.hpp:376
value_type element(std::size_t element_index, cuda_stream_view stream) const
Returns the specified element from device memory.
Definition: device_uvector.hpp:321
value_type front_element(cuda_stream_view stream) const
Returns the first element.
Definition: device_uvector.hpp:343
value_type const * const_pointer
The type of the pointer returned by data() const.
Definition: device_uvector.hpp:89
device_uvector(device_uvector const &other, cuda_stream_view stream, device_async_resource_ref mr=mr::get_current_device_resource_ref())
Construct a new device_uvector by deep copying the contents of another device_uvector.
Definition: device_uvector.hpp:145
value_type const & const_reference
Definition: device_uvector.hpp:87
void set_element(std::size_t element_index, T const &value, cuda_stream_view stream)
Performs a synchronous copy of v to the specified element in device memory.
Definition: device_uvector.hpp:303
const_iterator begin() const noexcept
Returns a const_iterator to the first element.
Definition: device_uvector.hpp:477
iterator begin() noexcept
Returns an iterator to the first element.
Definition: device_uvector.hpp:459
Exception thrown when attempting to access outside of a defined range.
Definition: error.hpp:110
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
Alias for a cuda::mr::async_resource_ref with the property cuda::mr::device_accessible.
Definition: resource_ref.hpp:41
device_async_resource_ref get_current_device_resource_ref()
Get the device_async_resource_ref for the current device.
Definition: per_device_resource.hpp:411
Management of per-device device_memory_resources.