rocprofiler-sdk-roctx/roctx.h File Reference#
|
ROCTx Developer API 0.6.0
ROCm Profiling API and tools
|
ROCTx API interface for AMD code annotation and profiling. More...
#include <stddef.h>#include <stdint.h>#include "rocprofiler-sdk-roctx/defines.h"#include "rocprofiler-sdk-roctx/types.h"#include "rocprofiler-sdk-roctx/version.h"
Include dependency graph for roctx.h:Go to the source code of this file.
Macros | |
| #define | roctxRangeStart(message) roctxRangeStartA(message) |
| #define | roctxMark(message) roctxMarkA(message) |
| #define | roctxRangePush(message) roctxRangePushA(message) |
Functions | |
| void | roctxMarkA (const char *message) ROCTX_API ROCTX_NONNULL(1) |
| int | roctxRangePushA (const char *message) ROCTX_API ROCTX_NONNULL(1) |
| int | roctxRangePop () ROCTX_API |
| roctx_range_id_t | roctxRangeStartA (const char *message) ROCTX_API ROCTX_NONNULL(1) |
| Starts a process range. | |
| void | roctxRangeStop (roctx_range_id_t id) ROCTX_API |
| int | roctxProfilerPause (roctx_thread_id_t tid) ROCTX_API |
| Request any currently running profiling tool that is should stop collecting data. | |
| int | roctxProfilerResume (roctx_thread_id_t tid) ROCTX_API |
| Request any currently running profiling tool that is should resume collecting data. | |
| int | roctxNameOsThread (const char *) ROCTX_API ROCTX_NONNULL(1) |
| Indicate to a profiling tool that, where possible, you would like the current CPU OS thread to be labeled by the provided name in the output of the profiling tool. | |
| int | roctxNameHsaAgent (const char *name, const struct hsa_agent_s *) ROCTX_API ROCTX_NONNULL(1 |
| Indicate to a profiling tool that, where possible, you would like the given HSA agent to be labeled by the provided name in the output of the profiling tool. | |
| int int | roctxNameHipDevice (const char *name, int device_id) ROCTX_API ROCTX_NONNULL(1) |
| Indicate to a profiling tool that, where possible, you would like the given HIP device id to be labeled by the provided name in the output of the profiling tool. | |
| int | roctxNameHipStream (const char *name, const struct ihipStream_t *stream) ROCTX_API ROCTX_NONNULL(1) |
| Indicate to a profiling tool that, where possible, you would like the given HIP stream to be labeled by the provided name in the output of the profiling tool. | |
| int | roctxGetThreadId (roctx_thread_id_t *tid) ROCTX_API ROCTX_NONNULL(1) |
Retrieve a id value for the current thread which will be identical to the id value a profiling tool gets via rocprofiler_get_thread_id(rocprofiler_thread_id_t*) | |
Detailed Description
ROCTx API interface for AMD code annotation and profiling.
Definition in file roctx.h.
Macro Definition Documentation
◆ roctxMark
| #define roctxMark | ( | message | ) | roctxMarkA(message) |
◆ roctxRangePush
| #define roctxRangePush | ( | message | ) | roctxRangePushA(message) |
◆ roctxRangeStart
| #define roctxRangeStart | ( | message | ) | roctxRangeStartA(message) |
Generated by
1.9.8