This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipfort Module Reference

hipfort Module Reference#

HIPFORT API Reference: hipfort Module Reference
hipfort Module Reference

Data Types

interface  hipinit
 
interface  hipdrivergetversion
 Returns the approximate HIP driver version. More...
 
interface  hipruntimegetversion
 Returns the approximate HIP Runtime version. More...
 
interface  hipdeviceget
 Returns a handle to a compute device. More...
 
interface  hipdevicecomputecapability
 Returns the compute capability of the device. More...
 
interface  hipdevicegetname
 Returns an identifer string for the device. More...
 
interface  hipdevicegetp2pattribute
 Returns a value for attr of link between two devices. More...
 
interface  hipdevicegetpcibusid
 Returns a PCI Bus Id string for the device, overloaded to take int device ID. More...
 
interface  hipdevicegetbypcibusid
 Returns a handle to a compute device. More...
 
interface  hipdevicetotalmem
 Returns the total amount of memory on the device. More...
 
interface  hipdevicesynchronize
 Waits on all active streams on current device. More...
 
interface  hipdevicereset
 The state of current device is discarded and updated to a fresh state. More...
 
interface  hipsetdevice
 Set default device to be used for subsequent hip API calls from this thread. More...
 
interface  hipgetdevice
 Return the default device id for the calling host thread. More...
 
interface  hipgetdevicecount
 Return number of compute-capable devices. More...
 
interface  hipdevicegetattribute
 Query for a specific device attribute. More...
 
interface  hipdevicesetcacheconfig
 Set L1/Shared cache partition. More...
 
interface  hipdevicegetcacheconfig
 Set Cache configuration for a specific function. More...
 
interface  hipdevicegetlimit
 Get Resource limits of current device. More...
 
interface  hipdevicegetsharedmemconfig
 Returns bank width of shared memory for current device. More...
 
interface  hipgetdeviceflags
 Gets the flags set for current device. More...
 
interface  hipdevicesetsharedmemconfig
 The bank width of shared memory on current device is set. More...
 
interface  hipsetdeviceflags
 The current device behavior is changed according the flags passed. More...
 
interface  hipchoosedevice
 Device which matches hipDeviceProp_t is returned. More...
 
interface  hipextgetlinktypeandhopcount
 Returns the link type and hop count between two devices. More...
 
interface  hipipcgetmemhandle
 Gets an interprocess memory handle for an existing device memory allocation. More...
 
interface  hipipcopenmemhandle
 Opens an interprocess memory handle exported from another process and returns a device pointer usable in the local process. More...
 
interface  hipipcclosememhandle
 Close memory mapped with hipIpcOpenMemHandle. More...
 
interface  hipipcgeteventhandle
 Gets an opaque interprocess handle for an event. More...
 
interface  hipipcopeneventhandle
 Opens an interprocess event handles. More...
 
interface  hipfuncsetattribute
 Set attribute for a specific function. More...
 
interface  hipfuncsetcacheconfig
 Set Cache configuration for a specific function. More...
 
interface  hipfuncsetsharedmemconfig
 Set shared memory configuation for a specific function. More...
 
interface  hipgetlasterror
 Return last error returned by any HIP runtime API call and resets the stored error code to hipSuccess. More...
 
interface  hippeekatlasterror
 Return last error returned by any HIP runtime API call. More...
 
interface  hipstreamcreate
 Create an asynchronous stream. More...
 
interface  hipstreamcreatewithflags
 Create an asynchronous stream. More...
 
interface  hipstreamcreatewithpriority
 Create an asynchronous stream with the specified priority. More...
 
interface  hipdevicegetstreampriorityrange
 Returns numerical values that correspond to the least and greatest stream priority. More...
 
interface  hipstreamdestroy
 Destroys the specified stream. More...
 
interface  hipstreamquery
 Return hipSuccess if all of the operations in the specified stream have completed, or hipErrorNotReady if not. More...
 
interface  hipstreamsynchronize
 Wait for all commands in stream to complete. More...
 
interface  hipstreamwaitevent
 Make the specified compute stream wait for an event. More...
 
interface  hipstreamgetflags
 Return flags associated with this stream. More...
 
interface  hipstreamgetpriority
 Query the priority of a stream. More...
 
interface  hipextstreamcreatewithcumask
 Create an asynchronous stream with the specified CU mask. More...
 
interface  hipextstreamgetcumask
 Get CU mask associated with an asynchronous stream. More...
 
interface  hipstreamaddcallback
 Adds a callback to be called on the host after all currently enqueued items in the stream have completed. More...
 
interface  hipstreamwritevalue32
 Enqueues a write command to the stream. More...
 
interface  hipstreamwritevalue64
 Enqueues a write command to the stream. More...
 
interface  hipeventcreatewithflags
 Create an event with the specified flags. More...
 
interface  hipeventcreate
 Create an event. More...
 
interface  hipeventrecord
 Record an event in the specified stream. More...
 
interface  hipeventdestroy
 Destroy the specified event. More...
 
interface  hipeventsynchronize
 Wait for an event to complete. More...
 
interface  hipeventelapsedtime
 Return the elapsed time between two events. More...
 
interface  hipeventquery
 Query event status. More...
 
interface  hippointergetattributes
 Return attributes for the specified pointer. More...
 
interface  hippointergetattribute
 Returns information about the specified pointer. More...
 
interface  hipdrvpointergetattributes
 Returns information about the specified pointer. More...
 
interface  hipsignalexternalsemaphoresasync
 Signals a set of external semaphore objects. More...
 
interface  hipwaitexternalsemaphoresasync
 Waits on a set of external semaphore objects. More...
 
interface  hipdestroyexternalsemaphore
 Destroys an external semaphore object and releases any references to the underlying resource. More...
 
interface  hipexternalmemorygetmappedbuffer
 Maps a buffer onto an imported memory object. More...
 
interface  hipdestroyexternalmemory
 Destroys an external memory object. More...
 
interface  hipextmallocwithflags
 Allocate memory on the default accelerator. More...
 
interface  hipmallochost
 
interface  hipmemallochost
 
interface  hipmemprefetchasync
 Prefetches memory to the specified destination device using HIP. More...
 
interface  hipmemadvise
 Advise about the usage of a given memory range to HIP. More...
 
interface  hipmemrangegetattribute
 Query an attribute of a given memory range in HIP. More...
 
interface  hipmemrangegetattributes
 Query attributes of a given memory range in HIP. More...
 
interface  hipstreamattachmemasync
 Attach memory to a stream asynchronously in HIP. More...
 
interface  hiphostalloc
 
interface  hipmallocpitch
 Allocates at least width (in bytes) * height bytes of linear memory Padding may occur to ensure alighnment requirements are met for the given row The change in width size due to padding will be returned in *pitch. More...
 
interface  hipmemallocpitch
 Allocates at least width (in bytes) * height bytes of linear memory Padding may occur to ensure alighnment requirements are met for the given row The change in width size due to padding will be returned in *pitch. More...
 
interface  hipfreehost
 
interface  hipmemcpywithstream
 
interface  hipmemcpyhtod
 Copy data from Host to Device. More...
 
interface  hipmemcpydtoh
 Copy data from Device to Host. More...
 
interface  hipmemcpydtod
 Copy data from Device to Device. More...
 
interface  hipmemcpyhtodasync
 Copy data from Host to Device asynchronously. More...
 
interface  hipmemcpydtohasync
 Copy data from Device to Host asynchronously. More...
 
interface  hipmemcpydtodasync
 Copy data from Device to Device asynchronously. More...
 
interface  hipmodulegetglobal
 Returns a global pointer from a module. More...
 
interface  hipgetsymboladdress
 
interface  hipgetsymbolsize
 
interface  hipmemcpytosymbol
 
interface  hipmemcpytosymbolasync
 
interface  hipmemcpyfromsymbol
 
interface  hipmemcpyfromsymbolasync
 
interface  hipmemset
 Fills the first sizeBytes bytes of the memory area pointed to by dest with the ant byte value value. More...
 
interface  hipmemsetd8
 Fills the first sizeBytes bytes of the memory area pointed to by dest with the ant byte value value. More...
 
interface  hipmemsetd8async
 Fills the first sizeBytes bytes of the memory area pointed to by dest with the ant byte value value. More...
 
interface  hipmemsetd16
 Fills the first sizeBytes bytes of the memory area pointed to by dest with the ant short value value. More...
 
interface  hipmemsetd16async
 Fills the first sizeBytes bytes of the memory area pointed to by dest with the ant short value value. More...
 
interface  hipmemsetd32
 Fills the memory area pointed to by dest with the ant integer value for specified number of times. More...
 
interface  hipmemsetasync
 Fills the first sizeBytes bytes of the memory area pointed to by dev with the ant byte value value. More...
 
interface  hipmemsetd32async
 Fills the memory area pointed to by dev with the ant integer value for specified number of times. More...
 
interface  hipmemset2d
 Fills the memory area pointed to by dst with the ant value. More...
 
interface  hipmemset2dasync
 Fills asynchronously the memory area pointed to by dst with the ant value. More...
 
interface  hipmemset3d
 Fills synchronously the memory area pointed to by pitchedDevPtr with the ant value. More...
 
interface  hipmemset3dasync
 Fills asynchronously the memory area pointed to by pitchedDevPtr with the ant value. More...
 
interface  hipmemgetinfo
 Query memory info. More...
 
interface  hipmemptrgetinfo
 
interface  hipmallocarray
 Allocate an array on the device. More...
 
interface  hiparraycreate
 
interface  hiparraydestroy
 
interface  hiparray3dcreate
 
interface  hipmalloc3d
 
interface  hipfreearray
 Frees an array on the device. More...
 
interface  hipfreemipmappedarray
 Frees a mipmapped array on the device. More...
 
interface  hipmalloc3darray
 Allocate an array on the device. More...
 
interface  hipmallocmipmappedarray
 Allocate a mipmapped array on the device. More...
 
interface  hipgetmipmappedarraylevel
 Gets a mipmap level of a HIP mipmapped array. More...
 
interface  hipmemcpyparam2d
 Copies memory for 2D arrays. More...
 
interface  hipmemcpyparam2dasync
 Copies memory for 2D arrays. More...
 
interface  hipmemcpy2dtoarray
 Copies data between host and device. More...
 
interface  hipmemcpy2dtoarrayasync
 Copies data between host and device. More...
 
interface  hipmemcpytoarray
 
interface  hipmemcpyfromarray
 
interface  hipmemcpy2dfromarray
 Copies data between host and device. More...
 
interface  hipmemcpy2dfromarrayasync
 Copies data between host and device asynchronously. More...
 
interface  hipmemcpyatoh
 Copies data between host and device. More...
 
interface  hipmemcpyhtoa
 Copies data between host and device. More...
 
interface  hipmemcpy3d
 Copies data between host and device. More...
 
interface  hipmemcpy3dasync
 Copies data between host and device asynchronously. More...
 
interface  hipdrvmemcpy3d
 Copies data between host and device. More...
 
interface  hipdrvmemcpy3dasync
 Copies data between host and device asynchronously. More...
 
interface  hipdevicecanaccesspeer
 Determine if a device can access a peer's memory. More...
 
interface  hipdeviceenablepeeraccess
 Enable direct access from current device's virtual address space to memory allocations physically located on a peer device. More...
 
interface  hipdevicedisablepeeraccess
 Disable direct access from current device's virtual address space to memory allocations physically located on a peer device. More...
 
interface  hipmemgetaddressrange
 Get information on memory allocations. More...
 
interface  hipmemcpypeer
 Copies memory from one device to memory on another device. More...
 
interface  hipmemcpypeerasync
 Copies memory from one device to memory on another device. More...
 
interface  hipctxcreate
 
interface  hipctxdestroy
 
interface  hipctxpopcurrent
 
interface  hipctxpushcurrent
 
interface  hipctxsetcurrent
 
interface  hipctxgetcurrent
 
interface  hipctxgetdevice
 
interface  hipctxgetapiversion
 
interface  hipctxgetcacheconfig
 
interface  hipctxsetcacheconfig
 
interface  hipctxsetsharedmemconfig
 
interface  hipctxgetsharedmemconfig
 
interface  hipctxsynchronize
 
interface  hipctxgetflags
 
interface  hipctxenablepeeraccess
 
interface  hipctxdisablepeeraccess
 
interface  hipdeviceprimaryctxgetstate
 Get the state of the primary context. More...
 
interface  hipdeviceprimaryctxrelease
 Release the primary context on the GPU. More...
 
interface  hipdeviceprimaryctxretain
 Retain the primary context on the GPU. More...
 
interface  hipdeviceprimaryctxreset
 Resets the primary context on the GPU. More...
 
interface  hipdeviceprimaryctxsetflags
 Set flags for the primary context. More...
 
interface  hipmoduleload
 Loads code object from file into a hipModule_t. More...
 
interface  hipmoduleunload
 Frees the module. More...
 
interface  hipmodulegetfunction
 Function with kname will be extracted if present in module. More...
 
interface  hipfuncgetattributes
 Find out attributes for a given function. More...
 
interface  hipfuncgetattribute
 Find out a specific attribute for a given function. More...
 
interface  hipmodulegettexref
 returns the handle of the texture reference with the name from the module. More...
 
interface  hipmoduleloaddata
 builds module from code object which resides in host memory. More...
 
interface  hipmoduleloaddataex
 builds module from code object which resides in host memory. More...
 
interface  hipmodulelaunchkernel
 launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelparams or extra More...
 
interface  hiplaunchcooperativekernel
 launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelparams or extra, where thread blocks can cooperate and synchronize as they execute More...
 
interface  hiplaunchcooperativekernelmultidevice
 Launches kernels on multiple devices where thread blocks can cooperate and synchronize as they execute. More...
 
interface  hipextlaunchmultikernelmultidevice
 Launches kernels on multiple devices and guarantees all specified kernels are dispatched on respective streams before enqueuing any other work on the specified streams from any other threads. More...
 
interface  hipmoduleoccupancymaxpotentialblocksize
 
interface  hipmoduleoccupancymaxpotentialblocksizewithflags
 
interface  hipmoduleoccupancymaxactiveblockspermultiprocessor
 Returns occupancy for a device function. More...
 
interface  hipoccupancymaxactiveblockspermultiprocessor
 Returns occupancy for a device function. More...
 
interface  hipoccupancymaxactiveblockspermultiprocessorwithflags
 Returns occupancy for a device function. More...
 
interface  hipoccupancymaxpotentialblocksize
 determine the grid and block sizes to achieves maximum occupancy for a kernel More...
 
interface  hipprofilerstart
 
interface  hipprofilerstop
 
interface  hipconfigurecall
 Configure a kernel launch. More...
 
interface  hipsetupargument
 Set a kernel argument. More...
 
interface  hiplaunchbyptr
 Launch a kernel. More...
 
interface  hiplaunchkernel
 C compliant kernel launch API. More...
 
interface  hipdrvmemcpy2dunaligned
 Copies memory for 2D arrays. More...
 
interface  hipextlaunchkernel
 Launches kernel from the pointer address, with arguments and shared memory on stream. More...
 
interface  hipbindtexture
 
interface  hipbindtexture2d
 
interface  hipbindtexturetoarray
 
interface  hipgettexturealignmentoffset
 
interface  hipunbindtexture
 
interface  hiptexrefgetaddress
 
interface  hiptexrefgetaddressmode
 
interface  hiptexrefgetfiltermode
 
interface  hiptexrefgetflags
 
interface  hiptexrefgetformat
 
interface  hiptexrefgetmaxanisotropy
 
interface  hiptexrefgetmipmapfiltermode
 
interface  hiptexrefgetmipmaplevelbias
 
interface  hiptexrefgetmipmaplevelclamp
 
interface  hiptexrefgetmipmappedarray
 
interface  hiptexrefsetaddress
 
interface  hiptexrefsetaddress2d
 
interface  hiptexrefsetmaxanisotropy
 
interface  hipbindtexturetomipmappedarray
 
interface  hipcreatetextureobject
 
interface  hipdestroytextureobject
 
interface  hipgetchanneldesc
 
interface  hipgettextureobjectresourcedesc
 
interface  hipgettextureobjectresourceviewdesc
 
interface  hipgettextureobjecttexturedesc
 
interface  hiptexrefsetaddressmode
 
interface  hiptexrefsetarray
 
interface  hiptexrefsetfiltermode
 
interface  hiptexrefsetflags
 
interface  hiptexrefsetformat
 
interface  hiptexobjectcreate
 
interface  hiptexobjectdestroy
 
interface  hiptexobjectgetresourcedesc
 
interface  hiptexobjectgetresourceviewdesc
 
interface  hiptexobjectgettexturedesc
 
interface  hiptexrefsetbordercolor
 
interface  hiptexrefsetmipmapfiltermode
 
interface  hiptexrefsetmipmaplevelbias
 
interface  hiptexrefsetmipmaplevelclamp
 
interface  hiptexrefsetmipmappedarray
 
interface  hipmipmappedarraycreate
 
interface  hipmipmappedarraydestroy
 
interface  hipmipmappedarraygetlevel
 
interface  hipregisterapicallback
 
interface  hipremoveapicallback
 
interface  hipregisteractivitycallback
 
interface  hipremoveactivitycallback
 
interface  hipstreambegincapture
 Begins graph capture on a stream. More...
 
interface  hipstreamendcapture
 Ends capture on a stream, returning the captured graph. More...
 
interface  hipstreamgetcaptureinfo
 Get capture status of a stream. More...
 
interface  hipstreamgetcaptureinfo_v2
 Get stream's capture state. More...
 
interface  hipstreamiscapturing
 Get stream's capture state. More...
 
interface  hipstreamupdatecapturedependencies
 Update the set of dependencies in a capturing stream. More...
 
interface  hipgraphcreate
 Creates a graph. More...
 
interface  hipgraphdestroy
 Destroys a graph. More...
 
interface  hipgraphadddependencies
 Adds dependency edges to a graph. More...
 
interface  hipgraphremovedependencies
 Removes dependency edges from a graph. More...
 
interface  hipgraphgetedges
 Returns a graph's dependency edges. More...
 
interface  hipgraphgetnodes
 Returns graph nodes. More...
 
interface  hipgraphgetrootnodes
 Returns graph's root nodes. More...
 
interface  hipgraphnodegetdependencies
 Returns a node's dependencies. More...
 
interface  hipgraphnodegetdependentnodes
 Returns a node's dependent nodes. More...
 
interface  hipgraphnodegettype
 Returns a node's type. More...
 
interface  hipgraphdestroynode
 Remove a node from the graph. More...
 
interface  hipgraphclone
 Clones a graph. More...
 
interface  hipgraphnodefindinclone
 Finds a cloned version of a node. More...
 
interface  hipgraphinstantiate
 Creates an executable graph from a graph. More...
 
interface  hipgraphinstantiatewithflags
 Creates an executable graph from a graph. More...
 
interface  hipgraphlaunch
 launches an executable graph in a stream More...
 
interface  hipgraphexecdestroy
 Destroys an executable graph. More...
 
interface  hipgraphexecupdate
 Check whether an executable graph can be updated with a graph and perform the update if * possible. More...
 
interface  hipgraphaddkernelnode
 Creates a kernel execution node and adds it to a graph. More...
 
interface  hipgraphkernelnodegetparams
 Gets kernel node's parameters. More...
 
interface  hipgraphkernelnodesetparams
 Sets a kernel node's parameters. More...
 
interface  hipgraphexeckernelnodesetparams
 Sets the parameters for a kernel node in the given graphExec. More...
 
interface  hipgraphaddmemcpynode
 Creates a memcpy node and adds it to a graph. More...
 
interface  hipgraphmemcpynodegetparams
 Gets a memcpy node's parameters. More...
 
interface  hipgraphmemcpynodesetparams
 Sets a memcpy node's parameters. More...
 
interface  hipgraphexecmemcpynodesetparams
 Sets the parameters for a memcpy node in the given graphExec. More...
 
interface  hipgraphaddmemcpynode1d
 Creates a 1D memcpy node and adds it to a graph. More...
 
interface  hipgraphmemcpynodesetparams1d
 Sets a memcpy node's parameters to perform a 1-dimensional copy. More...
 
interface  hipgraphexecmemcpynodesetparams1d
 Sets the parameters for a memcpy node in the given graphExec to perform a 1-dimensional copy. More...
 
interface  hipgraphaddmemcpynodefromsymbol
 Creates a memcpy node to copy from a symbol on the device and adds it to a graph. More...
 
interface  hipgraphmemcpynodesetparamsfromsymbol
 Sets a memcpy node's parameters to copy from a symbol on the device. More...
 
interface  hipgraphexecmemcpynodesetparamsfromsymbol
 Sets the parameters for a memcpy node in the given graphExec to copy from a symbol on the. More...
 
interface  hipgraphaddmemcpynodetosymbol
 Creates a memcpy node to copy to a symbol on the device and adds it to a graph. More...
 
interface  hipgraphmemcpynodesetparamstosymbol
 Sets a memcpy node's parameters to copy to a symbol on the device. More...
 
interface  hipgraphexecmemcpynodesetparamstosymbol
 Sets the parameters for a memcpy node in the given graphExec to copy to a symbol on the device. More...
 
interface  hipgraphaddmemsetnode
 Creates a memset node and adds it to a graph. More...
 
interface  hipgraphmemsetnodegetparams
 Gets a memset node's parameters. More...
 
interface  hipgraphmemsetnodesetparams
 Sets a memset node's parameters. More...
 
interface  hipgraphexecmemsetnodesetparams
 Sets the parameters for a memset node in the given graphExec. More...
 
interface  hipgraphaddhostnode
 Creates a host execution node and adds it to a graph. More...
 
interface  hipgraphhostnodegetparams
 Returns a host node's parameters. More...
 
interface  hipgraphhostnodesetparams
 Sets a host node's parameters. More...
 
interface  hipgraphexechostnodesetparams
 Sets the parameters for a host node in the given graphExec. More...
 
interface  hipgraphaddchildgraphnode
 Creates a child graph node and adds it to a graph. More...
 
interface  hipgraphchildgraphnodegetgraph
 Gets a handle to the embedded graph of a child graph node. More...
 
interface  hipgraphexecchildgraphnodesetparams
 Updates node parameters in the child graph node in the given graphExec. More...
 
interface  hipgraphaddemptynode
 Creates an empty node and adds it to a graph. More...
 
interface  hipgraphaddeventrecordnode
 Creates an event record node and adds it to a graph. More...
 
interface  hipgrapheventrecordnodegetevent
 Returns the event associated with an event record node. More...
 
interface  hipgrapheventrecordnodesetevent
 Sets an event record node's event. More...
 
interface  hipgraphexeceventrecordnodesetevent
 Sets the event for an event record node in the given graphExec. More...
 
interface  hipgraphaddeventwaitnode
 Creates an event wait node and adds it to a graph. More...
 
interface  hipgrapheventwaitnodegetevent
 Returns the event associated with an event wait node. More...
 
interface  hipgrapheventwaitnodesetevent
 Sets an event wait node's event. More...
 
interface  hipgraphexeceventwaitnodesetevent
 Sets the event for an event record node in the given graphExec. More...