HcclCommInitRootInfo
Description
Initializes the HCCL based on rootInfo to create an HCCL communicator.
Prototype
HcclResult HcclCommInitRootInfo(uint32_t nRanks, const HcclRootInfo *rootInfo, uint32_t rank, HcclComm *comm)
Parameters
|
Parameter |
Input/Output |
Description |
|---|---|---|
|
nRanks |
Input |
Number of ranks in a cluster. |
|
rootInfo |
Input |
Root rank information including the IP address and ID of the root rank, which is generated by HcclGetRootInfo. |
|
rank |
Input |
ID of the current rank. |
|
comm |
Output |
Pointer to the initialized communicator. For details about the definition of the HcclComm type, see HcclComm. |
Returns
HcclResult: HCCL_SUCCESS on success; else, failure.
Constraints
- The values of nRanks and rootInfo of all ranks in the same communicator must be the same.
- This API can be called only in serial mode. Concurrent calls to this API are not supported.
Applicability
Parent topic: Communicator Management