hipmemcpytosymbol Interface Reference

hipmemcpytosymbol Interface Reference#

HIPFORT API Reference: hipfort::hipmemcpytosymbol Interface Reference
hipfort::hipmemcpytosymbol Interface Reference

Copies data to the given symbol on the device. More...

Public Member Functions

integer(kind(hipsuccess)) function hipmemcpytosymbol_ (symbol, src, sizebytes, offset, mykind)
 

Detailed Description

Copies data to the given symbol on the device.

Symbol HIP APIs allow a kernel to define a device-side data symbol which can be accessed on the host side. The symbol can be in __constant or device space. Note that the symbol name needs to be encased in the HIP_SYMBOL macro. This also applies to hipMemcpyFromSymbol, hipGetSymbolAddress, and hipGetSymbolSize. For detailed usage, see the memcpyToSymbol example in the HIP Porting Guide.

Parameters
[out]symbol- pointer to the device symbole
[in]src- pointer to the source address
[in]sizeBytes- size in bytes to copy
[in]offset- offset in bytes from start of symbole
[in]myKind- type of memory transfer
Returns
hipSuccess, hipErrorInvalidValue

Member Function/Subroutine Documentation

◆ hipmemcpytosymbol_()

integer(kind(hipsuccess)) function hipfort::hipmemcpytosymbol::hipmemcpytosymbol_ ( type(c_ptr), value  symbol,
type(c_ptr), value  src,
integer(c_size_t), value  sizebytes,
integer(c_size_t), value  offset,
integer(kind(hipmemcpyhosttohost)), value  mykind 
)

The documentation for this interface was generated from the following file: