GetWindowsInAddr

Applicability

Product	Supported
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	x
Atlas inference product's AI Core	x
Atlas inference product's Vector Core	x
Atlas training products	x

Function

Obtains the WindowsIn start address of inter-card communication data, which can be directly used as the input and output address for computation, reducing copy operations. By default, this API works on all cores. You can also specify a core by setting GetBlockIdx before calling this API.

Prototype

__aicore__ inline GM_ADDR GetWindowsInAddr(uint32_t rankId)

Parameters

**Table 1** API parameters
Parameter	Input/Output	Description
rankId	Input	ID of the rank to be queried.

Returns

Returns the WindowsIn start address of inter-card communication data of the corresponding rank. If rankId is invalid, nullptr is returned.

Restrictions

None

Example

REGISTER_TILING_DEFAULT(ReduceScatterCustomTilingData); // ReduceScatterCustomTilingData is a structure defined in the operator header file.
GET_TILING_DATA_WITH_STRUCT(ReduceScatterCustomTilingData, tilingData, tilingGM);
Hccl hccl;
GM_ADDR contextGM = AscendC::GetHcclContext<0>();  // Obtain the HCCL context on the kernel of the Ascend C custom operator.
hccl.InitV2(contextGM, &tilingData);

auto winInAddr = hccl.GetWindowsInAddr(0);
auto winOutAddr = hccl.GetWindowsOutAddr(0);
auto rankId = hccl.GetRankId();
auto rankDim = hccl.GetRankDim();  // Four cards

Parent topic: HCCL Kernel APIs