Result Codes

Result Codes#

Rocprofiler SDK Developer API: Result Codes
Rocprofiler SDK Developer API 0.5.0
ROCm Profiling API and tools
Result Codes

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

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.

56{
57 ncclSuccess = 0, /*!< No error */
58 ncclUnhandledCudaError = 1, /*!< Unhandled HIP error */
59 ncclSystemError = 2, /*!< Unhandled system error */
60 ncclInternalError = 3, /*!< Internal Error - Please report to RCCL developers */
61 ncclInvalidArgument = 4, /*!< Invalid argument */
62 ncclInvalidUsage = 5, /*!< Invalid usage */
63 ncclRemoteError = 6, /*!< Remote process exited or there was a network error */
64 ncclInProgress = 7, /*!< RCCL operation in progress */
65 ncclNumResults = 8 /*!< Number of result types */
ncclResult_t
Result type.
Definition rccl.h:56
@ ncclInvalidUsage
Definition rccl.h:62
@ ncclInProgress
Definition rccl.h:64
@ ncclNumResults
Definition rccl.h:65
@ ncclRemoteError
Definition rccl.h:63
@ ncclSystemError
Definition rccl.h:59
@ ncclInternalError
Definition rccl.h:60
@ ncclSuccess
Definition rccl.h:57
@ ncclInvalidArgument
Definition rccl.h:61
@ ncclUnhandledCudaError
Definition rccl.h:58