Struct rustacuda::memory::DevicePointer [−][src]
#[repr(transparent)]pub struct DevicePointer<T>(_)
where
T: ?Sized;
Expand description
A pointer to device memory.
DevicePointer
cannot be dereferenced by the CPU, as it is a pointer to a memory allocation in
the device. It can be safely copied to the device (eg. as part of a kernel launch) and either
unwrapped or transmuted to an appropriate pointer.
DevicePointer
is guaranteed to have an equivalent internal representation to a raw pointer.
Thus, it can be safely reinterpreted or transmuted to *mut T
. It is safe to pass a
DevicePointer
through an FFI boundary to C code expecting a *mut T
, so long as the code on
the other side of that boundary does not attempt to dereference the pointer on the CPU. It is
thus possible to pass a DevicePointer
to a CUDA kernel written in C.
Implementations
Wrap the given raw pointer in a DevicePointer. The given pointer is assumed to be a valid, device pointer or null.
Safety
The given pointer must have been allocated with cuda_malloc
or
be null.
Examples
use rustacuda::memory::*; use std::ptr; unsafe { let null : *mut u64 = ptr::null_mut(); assert!(DevicePointer::wrap(null).is_null()); }
Returns the contained pointer as a raw pointer. The returned pointer is not valid on the CPU and must not be dereferenced.
Examples
use rustacuda::memory::*; unsafe { let dev_ptr = cuda_malloc::<u64>(1).unwrap(); let ptr: *const u64 = dev_ptr.as_raw(); cuda_free(dev_ptr); }
Returns the contained pointer as a mutable raw pointer. The returned pointer is not valid on the CPU and must not be dereferenced.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(1).unwrap(); let ptr: *mut u64 = dev_ptr.as_raw_mut(); cuda_free(dev_ptr); }
Returns true if the pointer is null.
Examples
use rustacuda::memory::*; use std::ptr; unsafe { let null : *mut u64 = ptr::null_mut(); assert!(DevicePointer::wrap(null).is_null()); }
Returns a null device pointer.
Examples:
use rustacuda::memory::*; let ptr : DevicePointer<u64> = DevicePointer::null(); assert!(ptr.is_null());
Calculates the offset from a device pointer.
count
is in units of T; eg. a count
of 3 represents a pointer offset of
3 * size_of::<T>()
bytes.
Safety
If any of the following conditions are violated, the result is Undefined Behavior:
-
Both the starting and resulting pointer must be either in bounds or one byte past the end of the same allocated object.
-
The computed offset, in bytes, cannot overflow an
isize
. -
The offset being in bounds cannot rely on “wrapping around” the address space. That is, the infinite-precision sum, in bytes must fit in a usize.
Consider using wrapping_offset
instead if these constraints are
difficult to satisfy. The only advantage of this method is that it
enables more aggressive compiler optimizations.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(5).unwrap(); let offset = dev_ptr.offset(1); // Points to the 2nd u64 in the buffer cuda_free(dev_ptr); // Must free the buffer using the original pointer }
Calculates the offset from a device pointer using wrapping arithmetic.
count
is in units of T; eg. a count
of 3 represents a pointer offset of
3 * size_of::<T>()
bytes.
Safety
The resulting pointer does not need to be in bounds, but it is
potentially hazardous to dereference (which requires unsafe
).
In particular, the resulting pointer may not be used to access a
different allocated object than the one self
points to. In other
words, x.wrapping_offset(y.wrapping_offset_from(x))
is
not the same as y
, and dereferencing it is undefined behavior
unless x
and y
point into the same allocated object.
Always use .offset(count)
instead when possible, because offset
allows the compiler to optimize better. If you need to cross object
boundaries, cast the pointer to an integer and do the arithmetic there.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(5).unwrap(); let offset = dev_ptr.wrapping_offset(1); // Points to the 2nd u64 in the buffer cuda_free(dev_ptr); // Must free the buffer using the original pointer }
Calculates the offset from a pointer (convenience for .offset(count as isize)
).
count
is in units of T; e.g. a count
of 3 represents a pointer
offset of 3 * size_of::<T>()
bytes.
Safety
If any of the following conditions are violated, the result is Undefined Behavior:
-
Both the starting and resulting pointer must be either in bounds or one byte past the end of an allocated object.
-
The computed offset, in bytes, cannot overflow an
isize
. -
The offset being in bounds cannot rely on “wrapping around” the address space. That is, the infinite-precision sum must fit in a
usize
.
Consider using wrapping_offset
instead if these constraints are
difficult to satisfy. The only advantage of this method is that it
enables more aggressive compiler optimizations.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(5).unwrap(); let offset = dev_ptr.add(1); // Points to the 2nd u64 in the buffer cuda_free(dev_ptr); // Must free the buffer using the original pointer }
Calculates the offset from a pointer (convenience for
.offset((count as isize).wrapping_neg())
).
count
is in units of T; e.g. a count
of 3 represents a pointer
offset of 3 * size_of::<T>()
bytes.
Safety
If any of the following conditions are violated, the result is Undefined Behavior:
-
Both the starting and resulting pointer must be either in bounds or one byte past the end of an allocated object.
-
The computed offset, in bytes, cannot overflow an
isize
. -
The offset being in bounds cannot rely on “wrapping around” the address space. That is, the infinite-precision sum must fit in a
usize
.
Consider using wrapping_offset
instead if these constraints are
difficult to satisfy. The only advantage of this method is that it
enables more aggressive compiler optimizations.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(5).unwrap(); let offset = dev_ptr.add(4).sub(3); // Points to the 2nd u64 in the buffer cuda_free(dev_ptr); // Must free the buffer using the original pointer }
Calculates the offset from a pointer using wrapping arithmetic.
(convenience for .wrapping_offset(count as isize)
)
count
is in units of T; e.g. a count
of 3 represents a pointer
offset of 3 * size_of::<T>()
bytes.
Safety
The resulting pointer does not need to be in bounds, but it is potentially hazardous to dereference.
Always use .add(count)
instead when possible, because add
allows the compiler to optimize better.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(5).unwrap(); let offset = dev_ptr.wrapping_add(1); // Points to the 2nd u64 in the buffer cuda_free(dev_ptr); // Must free the buffer using the original pointer }
Calculates the offset from a pointer using wrapping arithmetic.
(convenience for .wrapping_offset((count as isize).wrapping_sub())
)
count
is in units of T; e.g. a count
of 3 represents a pointer
offset of 3 * size_of::<T>()
bytes.
Safety
The resulting pointer does not need to be in bounds, but it is
potentially hazardous to dereference (which requires unsafe
).
Always use .sub(count)
instead when possible, because sub
allows the compiler to optimize better.
Examples
use rustacuda::memory::*; unsafe { let mut dev_ptr = cuda_malloc::<u64>(5).unwrap(); let offset = dev_ptr.wrapping_add(4).wrapping_sub(3); // Points to the 2nd u64 in the buffer cuda_free(dev_ptr); // Must free the buffer using the original pointer }
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl<T: ?Sized> RefUnwindSafe for DevicePointer<T> where
T: RefUnwindSafe,
impl<T> !Send for DevicePointer<T>
impl<T> !Sync for DevicePointer<T>
impl<T: ?Sized> Unpin for DevicePointer<T>
impl<T: ?Sized> UnwindSafe for DevicePointer<T> where
T: RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more