HcclCommDeactivateCommMemory

This API is for trial use and may be changed in later versions. Therefore, it cannot be used in commercial products.

Applicability

Product	Supported
Atlas 350 Accelerator Card	☓
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	☓
Atlas 200I/500 A2 inference product	☓
Atlas inference product	☓
Atlas training product	☓

For Atlas A2 training product/Atlas A2 inference product, only the Atlas 800T A2 training server, Atlas 900 A2 PoD cluster basic unit, and Atlas 200T A2 Box16 heterogeneous subrack are supported.

Function

Deactivates a virtual memory. If the address of a deactivated virtual memory is used for collective communication, the zero-copy function will not be enabled.

Prototype

HcclResult HcclCommDeactivateCommMemory(HcclComm comm, void *virPtr)

Parameters

Parameter	Input/Output	Description
comm	Input	HCCL communicator. You are advised to use the largest-scale communicator within the server, that is, the communicator that covers the maximum number of devices.
virPtr	Input	Start address of the virtual address to be deactivated, that is, the virtual memory address specified by the virPtr parameter of the HcclCommActivateCommMemory API. Note that the specified virtual memory must be successfully activated, and only the entire address block can be deactivated.

Parameter

Input/Output

Description

comm

Input

HCCL communicator. You are advised to use the largest-scale communicator within the server, that is, the communicator that covers the maximum number of devices.

virPtr

Input

Start address of the virtual address to be deactivated, that is, the virtual memory address specified by the virPtr parameter of the HcclCommActivateCommMemory API.

Note that the specified virtual memory must be successfully activated, and only the entire address block can be deactivated.

Returns

HcclResult: HCCL_SUCCESS on success, or else failure.

Constraints

None.

Parent topic: Zero-Copy