HcclCommUnsetMemoryRange

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

Notifies an HCCL communicator to invalidate the reserved virtual memory.

Prototype

HcclResult HcclCommUnsetMemoryRange(HcclComm comm, void *baseVirPtr)

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.
baseVirPtr	Input	Base address of reserved virtual memory. The specified base address must have been successfully executed by calling HcclCommSetMemoryRange. Otherwise, an error is reported.

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.

baseVirPtr

Input

Base address of reserved virtual memory.

The specified base address must have been successfully executed by calling HcclCommSetMemoryRange. Otherwise, an error is reported.

Returns

HcclResult: HCCL_SUCCESS on success, or else failure.

Constraints

This API will fail if any active memory allocations still exist within the virtual address space.

Parent topic: Zero-Copy