Communicator Information

Rocprofiler SDK Developer API 0.5.0 ROCm Profiling API and tools

Functions

Communicator Information

Functions
ncclResult_t	ncclCommCount (const ncclComm_t comm, int *count)
	Gets the number of ranks in the communicator clique.
ncclResult_t	ncclCommCuDevice (const ncclComm_t comm, int *device)
	Get the ROCm device index associated with a communicator.
ncclResult_t	ncclCommUserRank (const ncclComm_t comm, int *rank)
	Get the rank associated with a communicator.

Detailed Description

API calls that query communicator information

Function Documentation

◆ ncclCommCount()

ncclResult_t ncclCommCount	(	const ncclComm_t	comm,
		int *	count
	)

Gets the number of ranks in the communicator clique.

Returns the number of ranks in the communicator clique (as set during initialization)

Returns

Result code. See Result Codes for more details.

Parameters

[in]	comm	Communicator to query
[out]	count	Pointer to where number of ranks will be stored

◆ ncclCommCuDevice()

ncclResult_t ncclCommCuDevice	(	const ncclComm_t	comm,
		int *	device
	)

Get the ROCm device index associated with a communicator.

Returns the ROCm device number associated with the provided communicator.

Returns

Result code. See Result Codes for more details.

Parameters

[in]	comm	Communicator to query
[out]	device	Pointer to where the associated ROCm device index will be stored

◆ ncclCommUserRank()

ncclResult_t ncclCommUserRank	(	const ncclComm_t	comm,
		int *	rank
	)

Get the rank associated with a communicator.

Returns the user-ordered "rank" associated with the provided communicator.

Returns

Result code. See Result Codes for more details.

Parameters

[in]	comm	Communicator to query
[out]	rank	Pointer to where the associated rank will be stored

---

Generated by  1.9.8