Scatter(ISASI)
产品支持情况
- Ascend 950PR/Ascend 950DT：支持
- Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持
- Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持
- Atlas 200I/500 A2 推理产品：支持
- Atlas 推理系列产品AI Core：支持
- Atlas 推理系列产品Vector Core：不支持
- Atlas 训练系列产品：不支持
说明
该API不支持Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品，如果需要在上述AI处理器实现数据离散功能，建议参考Scatter兼容样例进行适配。
功能说明
头文件路径为："basic_api/kernel_operator_vec_scatter_intf.h"。
给定一个连续的输入张量和一个目的地址偏移张量，Scatter指令根据偏移地址生成新的结果张量后将输入张量分散到结果张量中。
将源操作数src中的元素按照指定的位置（由dstOffset和dstBaseAddr共同作用）分散到目的操作数dst中。
函数原型
tensor前n个数据计算
C++template <typename T> __aicore__ inline void Scatter(const LocalTensor<T>& dst, const LocalTensor<T>& src, const LocalTensor<uint32_t>& dstOffset, const uint32_t dstBaseAddr, const uint32_t count)tensor高维切分计算
mask逐bit模式
C++template <typename T> __aicore__ inline void Scatter(const LocalTensor<T>& dst, const LocalTensor<T>& src, const LocalTensor<uint32_t>& dstOffset, const uint32_t dstBaseAddr, const uint64_t mask[], const uint8_t repeatTime, const uint8_t srcRepStride)mask连续模式
C++template <typename T> __aicore__ inline void Scatter(const LocalTensor<T>& dst, const LocalTensor<T>& src, const LocalTensor<uint32_t>& dstOffset, const uint32_t dstBaseAddr, const uint64_t mask, const uint8_t repeatTime, const uint8_t srcRepStride)
参数说明
表1 模板参数说明
| 参数名 | 描述 |
|---|---|
| T | 操作数数据类型。 |
表2 参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| dst | 输出 | 目的操作数，类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要按照32字节对齐。 |
| src | 输入 | 源操作数，类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要按照32字节对齐。 |
| dstOffset | 输入 | 每个元素在dst中对应的地址偏移，类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 该偏移量是相对于dst的起始基地址dstBaseAddr而言的。单位为字节。取值要求见约束说明。 |
| dstBaseAddr | 输入 | 用于指定dst的起始偏移地址，单位为字节。取值应保证dst元素类型位宽对齐，否则会导致非预期行为。 |
| count | 输入 | 参与计算的元素个数。 参数取值范围和操作数的数据类型有关，数据类型不同，能够处理的元素个数最大值不同，最大处理的数据量不能超过UB大小限制。 |
| mask/mask[] | 输入 | mask用于控制每次迭代内参与计算的元素。 设置详见掩码操作。 |
| repeatTime | 输入 | 指令迭代次数。针对不同的型号，每个迭代处理的DataBlock可能存在差异，详见约束说明。 |
| srcRepStride | 输入 | 相邻迭代间的地址步长，单位是DataBlock（32Bytes）。 |
数据类型
Ascend 950PR/Ascend 950DT，支持的数据类型为：int8_t、uint8_t、int16_t、uint16_t、half、bfloat16_t、int32_t、uint32_t、float、int64_t、uint64_t。int8_t、uint8_t数据类型仅支持tensor前n个数据计算接口。
Atlas 200I/500 A2 推理产品，支持的数据类型为：int8_t、uint8_t、int16_t、uint16_t、half、int32_t、uint32_t、float。
Atlas 推理系列产品AI Core，支持的数据类型为：uint16_t、half、uint32_t、float。
约束说明
操作数地址对齐要求请参见通用地址对齐约束。
操作数地址重叠约束请参考通用地址重叠约束。
dstOffset的取值要求如下：
- 偏移地址不能有相同值，如果存在2个或者多个偏移重复的情况，行为是不可预期的。
- 取值应保证dst元素类型位宽对齐。
- 偏移地址后不能超出UB大小数据的范围。
- 针对以下型号，地址偏移的取值范围：当操作数为8位时，取值范围为[0, 2^16-1]；当操作数为16位时，取值范围为[0, 2^17-1]，当操作数为32位或者64位时，不能超出uint32_t的范围。
- Ascend 950PR/Ascend 950DT
- Atlas 200I/500 A2 推理产品
- 针对以下型号，地址偏移的取值范围：不能超出uint32_t的范围。
- Atlas 推理系列产品AI Core
dstBaseAddr的取值应保证dst元素类型位宽对齐，否则会导致非预期行为，程序没有崩溃报错，但数据发生错位，导致结果张量不符合预期。
repeatTime取值范围：repeatTime∈[0,255]。
- 针对Ascend 950PR/Ascend 950DT，该接口通过VF调用Reg矢量计算API实现兼容，当参数count或repeatTime取值为0时，不保证该接口被视为NOP（空操作）。
- 针对以下型号，当操作数为8位时，每次迭代完成4个DataBlock的数据收集；其他情况下，每次迭代完成8个DataBlock的数据收集。
- Ascend 950PR/Ascend 950DT
- Atlas 200I/500 A2 推理产品
- 针对以下型号，每次迭代完成8个DataBlock的数据收集。
- Atlas 推理系列产品AI Core
调用示例
完整使用样例请参见Scatter兼容性样例。
uint32_t COUNT = 128;
AscendC::Scatter(dstLocal, srcLocal, dstOffsetLocal, (uint32_t)0, COUNT); // dstOffsetLocal用于存储源操作数的每个元素在dst中对应的地址偏移
结果示例：
输入数据dstOffsetLocal:
[254 252 250 ... 4 2 0]
输入数据srcLocal（128个half类型数据）:
[0 1 2 ... 125 126 127]
输出数据dstGlobal:
[127 126 125 ... 2 1 0]