Callback Activity APIs

Callback Activity APIs#

HIP Runtime API Reference: Callback Activity APIs
Callback Activity APIs
Collaboration diagram for Callback Activity APIs:

Functions

const char * hipApiName (uint32_t id)
 Returns HIP API name by ID.
 
const char * hipKernelNameRef (const hipFunction_t f)
 Returns kernel name reference by function name.
 
const char * hipKernelNameRefByPtr (const void *hostFunction, hipStream_t stream)
 Retrives kernel for a given host pointer, unless stated otherwise.
 
int hipGetStreamDeviceId (hipStream_t stream)
 Returns device ID on the stream.
 

Detailed Description

This section describes the callback/Activity of HIP runtime API.

Function Documentation

◆ hipApiName()

const char * hipApiName ( uint32_t  id)

Returns HIP API name by ID.

Parameters
[in]idID of HIP API
Returns
hipSuccess, hipErrorInvalidValue

◆ hipGetStreamDeviceId()

int hipGetStreamDeviceId ( hipStream_t  stream)

Returns device ID on the stream.

Parameters
[in]streamStream of device executed on.
Returns
hipSuccess, hipErrorInvalidValue

◆ hipKernelNameRef()

const char * hipKernelNameRef ( const hipFunction_t  f)

Returns kernel name reference by function name.

Parameters
[in]fName of function
Returns
hipSuccess, hipErrorInvalidValue

◆ hipKernelNameRefByPtr()

const char * hipKernelNameRefByPtr ( const void *  hostFunction,
hipStream_t  stream 
)

Retrives kernel for a given host pointer, unless stated otherwise.

Parameters
[in]hostFunctionPointer of host function.
[in]streamStream the kernel is executed on.
Returns
hipSuccess, hipErrorInvalidValue