roctxprofilerpause Interface Reference#
hipfort_roctx::roctxprofilerpause Interface Reference
Request any currently running profiling tool that is should stop collecting data. More...
Public Member Functions | |
| integer(c_int) function | roctxprofilerpause_ (tid) |
Detailed Description
Request any currently running profiling tool that is should stop collecting data.
Within a profiling tool, it is recommended that the tool cache all active contexts at the time of the request and then stop them. By convention, the application should pass zero to indicate a global pause of the profiler in the current process. If the application wishes to pause only the current thread, the application should obtain the thread ID via roctxGetThreadId.
- Parameters
-
[in] tid Zero for all threads in current process or non-zero for a specific thread
- Returns
- int A profiling tool may choose to set this value to a non-zero value to indicate a failure while executing the request or lack of support. If the profiling tool supports pausing but is already paused, the tool should ignore the request and return zero.
Member Function/Subroutine Documentation
◆ roctxprofilerpause_()
| integer(c_int) function hipfort_roctx::roctxprofilerpause::roctxprofilerpause_ | ( | integer(c_int64_t), value | tid | ) |
The documentation for this interface was generated from the following file: