hiplaunchhostfunc Interface Reference#
Enqueues a host function call in a stream. More...
Public Member Functions | |
| integer(kind(hipsuccess)) function | hiplaunchhostfunc_ (stream, fn, userdata) |
Detailed Description
Enqueues a host function call in a stream.
- Parameters
-
[in] stream - The stream to enqueue work in. [in] fn - The function to call once enqueued preceeding operations are complete. [in] userData - User-specified data to be passed to the function.
- Returns
hipSuccess,hipErrorInvalidResourceHandle,hipErrorInvalidValue,hipErrorNotSupported
The host function to call in this API will be executed after the preceding operations in the stream are complete. The function is a blocking operation that blocks operations in the stream that follow it, until the function is returned. Event synchronization and internal callback functions make sure enqueued operations will execute in order, in the stream.
The host function must not make any HIP API calls. The host function is non-reentrant. It must not perform sychronization with any operation that may depend on other processing execution but is not enqueued to run earlier in the stream.
Host functions that are enqueued respectively in different non-blocking streams can run concurrently.
- Warning
- This API is marked as beta, meaning, while this is feature complete, it is still open to changes and may have outstanding issues.
Member Function/Subroutine Documentation
◆ hiplaunchhostfunc_()
| integer(kind(hipsuccess)) function hipfort::hiplaunchhostfunc::hiplaunchhostfunc_ | ( | type(c_ptr), value | stream, |
| type(c_funptr), value | fn, | ||
| type(c_ptr), value | userdata | ||
| ) |
The documentation for this interface was generated from the following file: