mesytec-mnode/external/taskflow-3.8.0/taskflow/cuda/cuda_memory.hpp

856 lines
20 KiB
C++
Raw Normal View History

2025-01-04 01:25:05 +01:00
#pragma once
#include "cuda_device.hpp"
/**
@file cuda_memory.hpp
@brief CUDA memory utilities include file
*/
namespace tf {
// ----------------------------------------------------------------------------
// memory
// ----------------------------------------------------------------------------
/**
@brief queries the free memory (expensive call)
*/
inline size_t cuda_get_free_mem(int d) {
cudaScopedDevice ctx(d);
size_t free, total;
TF_CHECK_CUDA(
cudaMemGetInfo(&free, &total), "failed to get mem info on device ", d
);
return free;
}
/**
@brief queries the total available memory (expensive call)
*/
inline size_t cuda_get_total_mem(int d) {
cudaScopedDevice ctx(d);
size_t free, total;
TF_CHECK_CUDA(
cudaMemGetInfo(&free, &total), "failed to get mem info on device ", d
);
return total;
}
/**
@brief allocates memory on the given device for holding @c N elements of type @c T
The function calls @c cudaMalloc to allocate <tt>N*sizeof(T)</tt> bytes of memory
on the given device @c d and returns a pointer to the starting address of
the device memory.
*/
template <typename T>
T* cuda_malloc_device(size_t N, int d) {
cudaScopedDevice ctx(d);
T* ptr {nullptr};
TF_CHECK_CUDA(
cudaMalloc(&ptr, N*sizeof(T)),
"failed to allocate memory (", N*sizeof(T), "bytes) on device ", d
)
return ptr;
}
/**
@brief allocates memory on the current device associated with the caller
The function calls malloc_device from the current device associated
with the caller.
*/
template <typename T>
T* cuda_malloc_device(size_t N) {
T* ptr {nullptr};
TF_CHECK_CUDA(
cudaMalloc(&ptr, N*sizeof(T)),
"failed to allocate memory (", N*sizeof(T), "bytes)"
)
return ptr;
}
/**
@brief allocates shared memory for holding @c N elements of type @c T
The function calls @c cudaMallocManaged to allocate <tt>N*sizeof(T)</tt> bytes
of memory and returns a pointer to the starting address of the shared memory.
*/
template <typename T>
T* cuda_malloc_shared(size_t N) {
T* ptr {nullptr};
TF_CHECK_CUDA(
cudaMallocManaged(&ptr, N*sizeof(T)),
"failed to allocate shared memory (", N*sizeof(T), "bytes)"
)
return ptr;
}
/**
@brief frees memory on the GPU device
@tparam T pointer type
@param ptr device pointer to memory to free
@param d device context identifier
This methods call @c cudaFree to free the memory space pointed to by @c ptr
using the given device context.
*/
template <typename T>
void cuda_free(T* ptr, int d) {
cudaScopedDevice ctx(d);
TF_CHECK_CUDA(cudaFree(ptr), "failed to free memory ", ptr, " on GPU ", d);
}
/**
@brief frees memory on the GPU device
@tparam T pointer type
@param ptr device pointer to memory to free
This methods call @c cudaFree to free the memory space pointed to by @c ptr
using the current device context of the caller.
*/
template <typename T>
void cuda_free(T* ptr) {
TF_CHECK_CUDA(cudaFree(ptr), "failed to free memory ", ptr);
}
/**
@brief copies data between host and device asynchronously through a stream
@param stream stream identifier
@param dst destination memory address
@param src source memory address
@param count size in bytes to copy
The method calls @c cudaMemcpyAsync with the given @c stream
using @c cudaMemcpyDefault to infer the memory space of the source and
the destination pointers. The memory areas may not overlap.
*/
inline void cuda_memcpy_async(
cudaStream_t stream, void* dst, const void* src, size_t count
) {
TF_CHECK_CUDA(
cudaMemcpyAsync(dst, src, count, cudaMemcpyDefault, stream),
"failed to perform cudaMemcpyAsync"
);
}
/**
@brief initializes or sets GPU memory to the given value byte by byte
@param stream stream identifier
@param devPtr pointer to GPU memory
@param value value to set for each byte of the specified memory
@param count size in bytes to set
The method calls @c cudaMemsetAsync with the given @c stream
to fill the first @c count bytes of the memory area pointed to by @c devPtr
with the constant byte value @c value.
*/
inline void cuda_memset_async(
cudaStream_t stream, void* devPtr, int value, size_t count
){
TF_CHECK_CUDA(
cudaMemsetAsync(devPtr, value, count, stream),
"failed to perform cudaMemsetAsync"
);
}
// ----------------------------------------------------------------------------
// Shared Memory
// ----------------------------------------------------------------------------
//
// Because dynamically sized shared memory arrays are declared "extern",
// we can't templatize them directly. To get around this, we declare a
// simple wrapper struct that will declare the extern array with a different
// name depending on the type. This avoids compiler errors about duplicate
// definitions.
//
// To use dynamically allocated shared memory in a templatized __global__ or
// __device__ function, just replace code like this:
//
// template<class T>
// __global__ void
// foo( T* g_idata, T* g_odata)
// {
// // Shared mem size is determined by the host app at run time
// extern __shared__ T sdata[];
// ...
// doStuff(sdata);
// ...
// }
//
// With this:
//
// template<class T>
// __global__ void
// foo( T* g_idata, T* g_odata)
// {
// // Shared mem size is determined by the host app at run time
// cudaSharedMemory<T> smem;
// T* sdata = smem.get();
// ...
// doStuff(sdata);
// ...
// }
// ----------------------------------------------------------------------------
// This is the un-specialized struct. Note that we prevent instantiation of this
// struct by putting an undefined symbol in the function body so it won't compile.
/**
@private
*/
template <typename T>
struct cudaSharedMemory
{
// Ensure that we won't compile any un-specialized types
__device__ T *get()
{
extern __device__ void error(void);
error();
return NULL;
}
};
// Following are the specializations for the following types.
// int, uint, char, uchar, short, ushort, long, ulong, bool, float, and double
// One could also specialize it for user-defined types.
/**
@private
*/
template <>
struct cudaSharedMemory <int>
{
__device__ int *get()
{
extern __shared__ int s_int[];
return s_int;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <unsigned int>
{
__device__ unsigned int *get()
{
extern __shared__ unsigned int s_uint[];
return s_uint;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <char>
{
__device__ char *get()
{
extern __shared__ char s_char[];
return s_char;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <unsigned char>
{
__device__ unsigned char *get()
{
extern __shared__ unsigned char s_uchar[];
return s_uchar;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <short>
{
__device__ short *get()
{
extern __shared__ short s_short[];
return s_short;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <unsigned short>
{
__device__ unsigned short *get()
{
extern __shared__ unsigned short s_ushort[];
return s_ushort;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <long>
{
__device__ long *get()
{
extern __shared__ long s_long[];
return s_long;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <unsigned long>
{
__device__ unsigned long *get()
{
extern __shared__ unsigned long s_ulong[];
return s_ulong;
}
};
//template <>
//struct cudaSharedMemory <size_t>
//{
// __device__ size_t *get()
// {
// extern __shared__ size_t s_sizet[];
// return s_sizet;
// }
//};
/**
@private
*/
template <>
struct cudaSharedMemory <bool>
{
__device__ bool *get()
{
extern __shared__ bool s_bool[];
return s_bool;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <float>
{
__device__ float *get()
{
extern __shared__ float s_float[];
return s_float;
}
};
/**
@private
*/
template <>
struct cudaSharedMemory <double>
{
__device__ double *get()
{
extern __shared__ double s_double[];
return s_double;
}
};
// ----------------------------------------------------------------------------
// cudaDeviceAllocator
// ----------------------------------------------------------------------------
/**
@class cudaDeviceAllocator
@brief class to create a CUDA device allocator
@tparam T element type
A %cudaDeviceAllocator enables device-specific allocation for
standard library containers. It is typically passed as template parameter
when declaring standard library containers (e.g. std::vector).
*/
template<typename T>
class cudaDeviceAllocator {
public:
/**
@brief element type
*/
using value_type = T;
/**
@brief element pointer type
*/
using pointer = T*;
/**
@brief element reference type
*/
using reference = T&;
/**
@brief const element pointer type
*/
using const_pointer = const T*;
/**
@brief constant element reference type
*/
using const_reference = const T&;
/**
@brief size type
*/
using size_type = std::size_t;
/**
@brief pointer difference type
*/
using difference_type = std::ptrdiff_t;
/**
@brief its member type @c U is the equivalent allocator type to allocate elements of type U
*/
template<typename U>
struct rebind {
/**
@brief allocator of a different data type
*/
using other = cudaDeviceAllocator<U>;
};
/**
@brief Constructs a device allocator object.
*/
cudaDeviceAllocator() noexcept {}
/**
@brief Constructs a device allocator object from another device allocator object.
*/
cudaDeviceAllocator( const cudaDeviceAllocator& ) noexcept {}
/**
@brief Constructs a device allocator object from another device allocator
object with a different element type.
*/
template<typename U>
cudaDeviceAllocator( const cudaDeviceAllocator<U>& ) noexcept {}
/**
@brief Destructs the device allocator object.
*/
~cudaDeviceAllocator() noexcept {}
/**
@brief Returns the address of x.
This effectively means returning &x.
@param x reference to an object
@return a pointer to the object
*/
pointer address( reference x ) { return &x; }
/**
@brief Returns the address of x.
This effectively means returning &x.
@param x reference to an object
@return a pointer to the object
*/
const_pointer address( const_reference x ) const { return &x; }
/**
@brief allocates block of storage.
Attempts to allocate a block of storage with a size large enough to contain
@c n elements of member type, @c value_type, and returns a pointer
to the first element.
The storage is aligned appropriately for object of type @c value_type,
but they are not constructed.
The block of storage is allocated using cudaMalloc and throws std::bad_alloc
if it cannot allocate the total amount of storage requested.
@param n number of elements (each of size sizeof(value_type)) to be allocated
@return a pointer to the initial element in the block of storage.
*/
pointer allocate( size_type n, const void* = 0 )
{
void* ptr = NULL;
TF_CHECK_CUDA(
cudaMalloc( &ptr, n*sizeof(T) ),
"failed to allocate ", n, " elements (", n*sizeof(T), "bytes)"
)
return static_cast<pointer>(ptr);
}
/**
@brief Releases a block of storage previously allocated with member allocate and not yet released
The elements in the array are not destroyed by a call to this member function.
@param ptr pointer to a block of storage previously allocated with allocate
*/
void deallocate( pointer ptr, size_type )
{
if(ptr){
cudaFree(ptr);
}
}
/**
@brief returns the maximum number of elements that could potentially
be allocated by this allocator
A call to member allocate with the value returned by this function
can still fail to allocate the requested storage.
@return the number of elements that might be allocated as maximum
by a call to member allocate
*/
size_type max_size() const noexcept { return size_type {-1}; }
/**
@brief ignored to avoid de-referencing device pointer from the host
*/
void construct( pointer, const_reference) { }
/**
@brief ignored to avoid de-referencing device pointer from the host
*/
void destroy( pointer) { }
/**
@brief compares two allocator of different types using @c ==
Device allocators of different types are always equal to each other
because the storage allocated by the allocator @c a1 can be deallocated
through @c a2.
*/
template <typename U>
bool operator == (const cudaDeviceAllocator<U>&) const noexcept {
return true;
}
/**
@brief compares two allocator of different types using @c !=
Device allocators of different types are always equal to each other
because the storage allocated by the allocator @c a1 can be deallocated
through @c a2.
*/
template <typename U>
bool operator != (const cudaDeviceAllocator<U>&) const noexcept {
return false;
}
};
// ----------------------------------------------------------------------------
// cudaUSMAllocator
// ----------------------------------------------------------------------------
/**
@class cudaUSMAllocator
@brief class to create a unified shared memory (USM) allocator
@tparam T element type
A %cudaUSMAllocator enables using unified shared memory (USM) allocation for
standard library containers. It is typically passed as template parameter
when declaring standard library containers (e.g. std::vector).
*/
template<typename T>
class cudaUSMAllocator {
public:
/**
@brief element type
*/
using value_type = T;
/**
@brief element pointer type
*/
using pointer = T*;
/**
@brief element reference type
*/
using reference = T&;
/**
@brief const element pointer type
*/
using const_pointer = const T*;
/**
@brief constant element reference type
*/
using const_reference = const T&;
/**
@brief size type
*/
using size_type = std::size_t;
/**
@brief pointer difference type
*/
using difference_type = std::ptrdiff_t;
/**
@brief its member type @c U is the equivalent allocator type to allocate elements of type U
*/
template<typename U>
struct rebind {
/**
@brief allocator of a different data type
*/
using other = cudaUSMAllocator<U>;
};
/**
@brief Constructs a device allocator object.
*/
cudaUSMAllocator() noexcept {}
/**
@brief Constructs a device allocator object from another device allocator object.
*/
cudaUSMAllocator( const cudaUSMAllocator& ) noexcept {}
/**
@brief Constructs a device allocator object from another device allocator
object with a different element type.
*/
template<typename U>
cudaUSMAllocator( const cudaUSMAllocator<U>& ) noexcept {}
/**
@brief Destructs the device allocator object.
*/
~cudaUSMAllocator() noexcept {}
/**
@brief Returns the address of x.
This effectively means returning &x.
@param x reference to an object
@return a pointer to the object
*/
pointer address( reference x ) { return &x; }
/**
@brief Returns the address of x.
This effectively means returning &x.
@param x reference to an object
@return a pointer to the object
*/
const_pointer address( const_reference x ) const { return &x; }
/**
@brief allocates block of storage.
Attempts to allocate a block of storage with a size large enough to contain
@c n elements of member type, @c value_type, and returns a pointer
to the first element.
The storage is aligned appropriately for object of type @c value_type,
but they are not constructed.
The block of storage is allocated using cudaMalloc and throws std::bad_alloc
if it cannot allocate the total amount of storage requested.
@param n number of elements (each of size sizeof(value_type)) to be allocated
@return a pointer to the initial element in the block of storage.
*/
pointer allocate( size_type n, const void* = 0 )
{
void* ptr {nullptr};
TF_CHECK_CUDA(
cudaMallocManaged( &ptr, n*sizeof(T) ),
"failed to allocate ", n, " elements (", n*sizeof(T), "bytes)"
)
return static_cast<pointer>(ptr);
}
/**
@brief Releases a block of storage previously allocated with member allocate and not yet released
The elements in the array are not destroyed by a call to this member function.
@param ptr pointer to a block of storage previously allocated with allocate
*/
void deallocate( pointer ptr, size_type )
{
if(ptr){
cudaFree(ptr);
}
}
/**
@brief returns the maximum number of elements that could potentially
be allocated by this allocator
A call to member allocate with the value returned by this function
can still fail to allocate the requested storage.
@return the number of elements that might be allocated as maximum
by a call to member allocate
*/
size_type max_size() const noexcept { return size_type {-1}; }
/**
@brief Constructs an element object on the location pointed by ptr.
@param ptr pointer to a location with enough storage soace to contain
an element of type @c value_type
@param val value to initialize the constructed element to
*/
void construct( pointer ptr, const_reference val ) {
new ((void*)ptr) value_type(val);
}
/**
@brief destroys in-place the object pointed by @c ptr
Notice that this does not deallocate the storage for the element but calls
its destructor.
@param ptr pointer to the object to be destroye
*/
void destroy( pointer ptr ) {
ptr->~value_type();
}
/**
@brief compares two allocator of different types using @c ==
USM allocators of different types are always equal to each other
because the storage allocated by the allocator @c a1 can be deallocated
through @c a2.
*/
template <typename U>
bool operator == (const cudaUSMAllocator<U>&) const noexcept {
return true;
}
/**
@brief compares two allocator of different types using @c !=
USM allocators of different types are always equal to each other
because the storage allocated by the allocator @c a1 can be deallocated
through @c a2.
*/
template <typename U>
bool operator != (const cudaUSMAllocator<U>&) const noexcept {
return false;
}
};
// ----------------------------------------------------------------------------
// GPU vector object
// ----------------------------------------------------------------------------
//template <typename T>
//using cudaDeviceVector = std::vector<NoInit<T>, cudaDeviceAllocator<NoInit<T>>>;
//template <typename T>
//using cudaUSMVector = std::vector<T, cudaUSMAllocator<T>>;
/**
@private
*/
template <typename T>
class cudaDeviceVector {
public:
cudaDeviceVector() = default;
cudaDeviceVector(size_t N) : _N {N} {
if(N) {
TF_CHECK_CUDA(
cudaMalloc(&_data, N*sizeof(T)),
"failed to allocate device memory (", N*sizeof(T), " bytes)"
);
}
}
cudaDeviceVector(cudaDeviceVector&& rhs) :
_data{rhs._data}, _N {rhs._N} {
rhs._data = nullptr;
rhs._N = 0;
}
~cudaDeviceVector() {
if(_data) {
cudaFree(_data);
}
}
cudaDeviceVector& operator = (cudaDeviceVector&& rhs) {
if(_data) {
cudaFree(_data);
}
_data = rhs._data;
_N = rhs._N;
rhs._data = nullptr;
rhs._N = 0;
return *this;
}
size_t size() const { return _N; }
T* data() { return _data; }
const T* data() const { return _data; }
cudaDeviceVector(const cudaDeviceVector&) = delete;
cudaDeviceVector& operator = (const cudaDeviceVector&) = delete;
private:
T* _data {nullptr};
size_t _N {0};
};
} // end of namespace tf -----------------------------------------------------