Result Codes

Result Codes#

Rocprofiler SDK Developer API: Result Codes

Rocprofiler SDK Developer API 0.6.0

ROCm Profiling API and tools

The various result codes that RCCL API calls may return. More...

Enumerations
enum	ncclResult_t { ncclSuccess = 0 , ncclUnhandledCudaError = 1 , ncclSystemError = 2 , ncclInternalError = 3 , ncclInvalidArgument = 4 , ncclInvalidUsage = 5 , ncclRemoteError = 6 , ncclInProgress = 7 , ncclNumResults = 8 }
	Result type. More...

Detailed Description

The various result codes that RCCL API calls may return.

Enumeration Type Documentation

◆ ncclResult_t

enum ncclResult_t

Result type.

Return codes aside from ncclSuccess indicate that a call has failed

Enumerator
ncclSuccess	No error
ncclUnhandledCudaError	Unhandled HIP error
ncclSystemError	Unhandled system error
ncclInternalError	Internal Error - Please report to RCCL developers
ncclInvalidArgument	Invalid argument
ncclInvalidUsage	Invalid usage
ncclRemoteError	Remote process exited or there was a network error
ncclInProgress	RCCL operation in progress
ncclNumResults	Number of result types

Definition at line 55 of file rccl.h.

{
    ncclSuccess            = 0, /*!< No error */
    ncclUnhandledCudaError = 1, /*!< Unhandled HIP error */
    ncclSystemError        = 2, /*!< Unhandled system error */
    ncclInternalError      = 3, /*!< Internal Error - Please report to RCCL developers */
    ncclInvalidArgument    = 4, /*!< Invalid argument */
    ncclInvalidUsage       = 5, /*!< Invalid usage */
    ncclRemoteError        = 6, /*!< Remote process exited or there was a network error */
    ncclInProgress         = 7, /*!< RCCL operation in progress */
    ncclNumResults         = 8  /*!< Number of result types */
} ncclResult_t;

Result Codes

Result Codes#

Enumerations

Detailed Description

Enumeration Type Documentation

◆ ncclResult_t