Error Checking Calls

Rocprofiler SDK Developer API 0.5.0 ROCm Profiling API and tools

Functions

Error Checking Calls

Functions
const char *	ncclGetErrorString (ncclResult_t result)
	Returns a string for each result code.
const char *	ncclGetLastError (ncclComm_t comm)
ncclResult_t	ncclCommGetAsyncError (ncclComm_t comm, ncclResult_t *asyncError)
	Checks whether the comm has encountered any asynchronous errors.

Detailed Description

API calls that check for errors

Function Documentation

◆ ncclCommGetAsyncError()

ncclResult_t ncclCommGetAsyncError	(	ncclComm_t	comm,
		ncclResult_t *	asyncError
	)

Checks whether the comm has encountered any asynchronous errors.

Query whether the provided communicator has encountered any asynchronous errors

Returns

Result code. See Result Codes for more details.

Parameters

[in]	comm	Communicator to query
[out]	asyncError	Pointer to where result code will be stored

◆ ncclGetErrorString()

const char * ncclGetErrorString

(

ncclResult_t

result

)

Returns a string for each result code.

Returns a human-readable string describing the given result code.

Returns

String containing description of result code.

Parameters

[in]

result

Result code to get description for

◆ ncclGetLastError()

const char * ncclGetLastError

(

ncclComm_t

comm

)

---

Generated by  1.9.8