1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/*
* Copyright 2008-2021 NVIDIA Corporation
* Modifications Copyright© 2019-2024 Advanced Micro Devices, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*! \file
* \brief A pointer to an object which resides in memory associated with the
* \c device system.
*/
#pragma once
#include <thrust/detail/config.h>
#include <thrust/memory.h>
THRUST_NAMESPACE_BEGIN
/*! \addtogroup memory_management Memory Management
* \{
*/
template <typename T> class device_reference;
/*! \brief \c device_ptr is a pointer-like object which points to an object that
* resides in memory associated with the \ref device system.
*
* \c device_ptr has pointer semantics: it may be dereferenced safely from
* anywhere, including the host, and may be manipulated with pointer
* arithmetic.
*
* \c device_ptr can be created with \ref device_new, \ref device_malloc,
* \ref device_malloc_allocator, \ref device_allocator, or
* \ref device_pointer_cast, or by explicitly calling its constructor with a
* raw pointer.
*
* The raw pointer contained in a \c device_ptr may be obtained via \c get
* member function or the \ref raw_pointer_cast free function.
*
* \ref algorithms operating on \c device_ptr types will automatically be
* dispatched to the \ref device system.
*
* \note \c device_ptr is not a smart pointer; it is the programmer's
* responsibility to deallocate memory pointed to by \c device_ptr.
*
* \see device_new
* \see device_malloc
* \see device_malloc_allocator
* \see device_allocator
* \see device_pointer_cast
* \see raw_pointer_cast
*/
template <typename T>
class device_ptr
: public thrust::pointer<
T,
thrust::device_system_tag,
thrust::device_reference<T>,
thrust::device_ptr<T>
>
{
private:
using super_t = thrust::pointer<
T,
thrust::device_system_tag,
thrust::device_reference<T>,
thrust::device_ptr<T>
>;
public:
/*! \brief Construct a null \c device_ptr.
*
* \post <tt>get() == nullptr</tt>.
*/
THRUST_HOST_DEVICE
device_ptr() : super_t() {}
/*! \brief Construct a null \c device_ptr.
*
* \param - A null pointer.
*
* \post <tt>get() == nullptr</tt>.
*/
THRUST_HOST_DEVICE
device_ptr(std::nullptr_t) : super_t(nullptr) {}
/*! \brief Construct a \c device_ptr from a raw pointer which is
* convertible to \c T*.
*
* \tparam U A type whose pointer is convertible to \c T*.
* \param ptr A raw pointer to a \c U in device memory to construct from.
*
* \pre <tt>std::is_convertible_v<U*, T*> == true</tt>.
*
* \pre \c ptr points to a location in device memory.
*
* \post <tt>get() == nullptr</tt>.
*/
template <typename U>
THRUST_HOST_DEVICE
explicit device_ptr(U* ptr) : super_t(ptr) {}
/*! \brief Copy construct a \c device_ptr from another \c device_ptr whose
* pointer type is convertible to \c T*.
*
* \tparam U A type whose pointer is convertible to \c T*.
* \param other A \c device_ptr to a \c U to construct from.
*
* \pre <tt>std::is_convertible_v<U*, T*> == true</tt>.
*
* \post <tt>get() == other.get()</tt>.
*/
template <typename U>
THRUST_HOST_DEVICE
device_ptr(device_ptr<U> const& other) : super_t(other) {}
/*! \brief Set this \c device_ptr to point to the same object as another
* \c device_ptr whose pointer type is convertible to \c T*.
*
* \tparam U A type whose pointer is convertible to \c T*.
* \param other A \c device_ptr to a \c U to assign from.
*
* \pre <tt>std::is_convertible_v<U*, T*> == true</tt>.
*
* \post <tt>get() == other.get()</tt>.
*
* \return \c *this.
*/
template <typename U>
THRUST_HOST_DEVICE
device_ptr &operator=(device_ptr<U> const& other)
{
super_t::operator=(other);
return *this;
}
/*! \brief Set this \c device_ptr to null.
*
* \param - A null pointer.
*
* \post <tt>get() == nullptr</tt>.
*
* \return \c *this.
*/
THRUST_HOST_DEVICE
device_ptr& operator=(std::nullptr_t)
{
super_t::operator=(nullptr);
return *this;
}
#if THRUST_DOXYGEN
/*! \brief Return the raw pointer that this \c device_ptr points to.
*/
THRUST_HOST_DEVICE
T* get() const;
#endif
};
#if THRUST_DOXYGEN
/*! Write the address that a \c device_ptr points to to an output stream.
*
* \param os The output stream.
* \param dp The \c device_ptr to output.
*
* \return \c os.
*/
template <typename T, typename CharT, typename Traits>
THRUST_HOST std::basic_ostream<CharT, Traits>&
operator<<(std::basic_ostream<CharT, Traits>& os, device_ptr<T> const& dp);
#endif
/*! \brief Create a \c device_ptr from a raw pointer.
*
* \tparam T Any type.
* \param ptr A raw pointer to a \c T in device memory.
*
* \pre \c ptr points to a location in device memory.
*
* \return A \c device_ptr<T> pointing to \c ptr.
*/
template <typename T>
THRUST_HOST_DEVICE
device_ptr<T> device_pointer_cast(T* ptr);
/*! \brief Create a \c device_ptr from another \c device_ptr.
*
* \tparam T Any type.
* \param dptr A \c device_ptr to a \c T.
*/
template<typename T>
THRUST_HOST_DEVICE
device_ptr<T> device_pointer_cast(device_ptr<T> const& dptr);
/*! \} // memory_management
*/
THRUST_NAMESPACE_END
#include <thrust/detail/device_ptr.inl>
#include <thrust/detail/raw_pointer_cast.h>
|
