Status Codes#
Most operations return a status code to indicate success or error. More...
Enumerations | |
| enum | roctracer_status_t { ROCTRACER_STATUS_SUCCESS = 0 , ROCTRACER_STATUS_ERROR = -1 , ROCTRACER_STATUS_ERROR_INVALID_DOMAIN_ID = -2 , ROCTRACER_STATUS_ERROR_INVALID_ARGUMENT = -3 , ROCTRACER_STATUS_ERROR_DEFAULT_POOL_UNDEFINED = -4 , ROCTRACER_STATUS_ERROR_DEFAULT_POOL_ALREADY_DEFINED = -5 , ROCTRACER_STATUS_ERROR_MEMORY_ALLOCATION = -6 , ROCTRACER_STATUS_ERROR_MISMATCHED_EXTERNAL_CORRELATION_ID = -7 , ROCTRACER_STATUS_ERROR_NOT_IMPLEMENTED = -8 , ROCTRACER_STATUS_UNINIT = 2 , ROCTRACER_STATUS_BREAK = 3 , ROCTRACER_STATUS_BAD_DOMAIN = ROCTRACER_STATUS_ERROR_INVALID_DOMAIN_ID , ROCTRACER_STATUS_BAD_PARAMETER = ROCTRACER_STATUS_ERROR_INVALID_ARGUMENT , ROCTRACER_STATUS_HIP_API_ERR = 6 , ROCTRACER_STATUS_HIP_OPS_ERR = 7 , ROCTRACER_STATUS_HCC_OPS_ERR = ROCTRACER_STATUS_HIP_OPS_ERR , ROCTRACER_STATUS_HSA_ERR = 7 , ROCTRACER_STATUS_ROCTX_ERR = 8 } |
| ROC Tracer API status codes. More... | |
Functions | |
| ROCTRACER_API const char * | roctracer_error_string () ROCTRACER_VERSION_4_1 |
| Query the textual description of the last error for the current thread. More... | |
Detailed Description
Most operations return a status code to indicate success or error.
Enumeration Type Documentation
◆ roctracer_status_t
| enum roctracer_status_t |
ROC Tracer API status codes.
| Enumerator | |
|---|---|
| ROCTRACER_STATUS_SUCCESS | The function has executed successfully. |
| ROCTRACER_STATUS_ERROR | A generic error has occurred. |
| ROCTRACER_STATUS_ERROR_INVALID_DOMAIN_ID | The domain ID is invalid. |
| ROCTRACER_STATUS_ERROR_INVALID_ARGUMENT | An invalid argument was given to the function. |
| ROCTRACER_STATUS_ERROR_DEFAULT_POOL_UNDEFINED | No default pool is defined. |
| ROCTRACER_STATUS_ERROR_DEFAULT_POOL_ALREADY_DEFINED | The default pool is already defined. |
| ROCTRACER_STATUS_ERROR_MEMORY_ALLOCATION | Memory allocation error. |
| ROCTRACER_STATUS_ERROR_MISMATCHED_EXTERNAL_CORRELATION_ID | External correlation ID pop mismatch. |
| ROCTRACER_STATUS_ERROR_NOT_IMPLEMENTED | The operation is not currently implemented. This error may be reported by any function. Check the Known Limitations and Restrictions section to determine the status of the library implementation of the interface. |
| ROCTRACER_STATUS_UNINIT | Deprecated error code. |
| ROCTRACER_STATUS_BREAK | Deprecated error code. |
| ROCTRACER_STATUS_BAD_DOMAIN | Deprecated error code. |
| ROCTRACER_STATUS_BAD_PARAMETER | Deprecated error code. |
| ROCTRACER_STATUS_HIP_API_ERR | Deprecated error code. |
| ROCTRACER_STATUS_HIP_OPS_ERR | Deprecated error code. |
| ROCTRACER_STATUS_HCC_OPS_ERR | Deprecated error code. |
| ROCTRACER_STATUS_HSA_ERR | Deprecated error code. |
| ROCTRACER_STATUS_ROCTX_ERR | Deprecated error code. |
Function Documentation
◆ roctracer_error_string()
| ROCTRACER_API const char* roctracer_error_string | ( | ) |
Query the textual description of the last error for the current thread.
Returns a NUL terminated string describing the error of the last ROC Tracer API call by the calling thread that did not return success. The empty string is returned if there is no previous error. The last error is not cleared.
- Returns
- Return the error string. The caller owns the returned string and should use
free()to deallocate it.