---
title: Copy
description: "| 产品 | 是否支持 |"
url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/ascendcopapi/atlasascendc_api_07_0106.html
sourcePath: /source/zh/canncommercial/900/API/ascendcopapi/atlasascendc_api_07_0106.html
indexId: b9279b4f6f72caf80527a00b73976b462bf581e9dac5f73decf522f04f2d9efb76
---
# Copy

#### 产品支持情况

| 产品 | 是否支持 |
| --- | --- |
| Atlas 350 加速卡 | √ |
| Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | √ |
| Atlas 推理系列产品 AI Core | x |
| Atlas 推理系列产品 Vector Core | x |
| Atlas 训练系列产品 | x |


#### 功能说明

VECIN，VECCALC，VECOUT之间的搬运指令，支持mask操作和DataBlock间隔操作。


#### 函数原型

- tensor前n个数据计算
  1 2 3 // 该函数原型仅支持Atlas 350 加速卡 template <typename T, bool isSetMask = true> __aicore__ inline void Copy(const LocalTensor<T>& dst, const LocalTensor<T>& src, const uint32_t count)

- tensor高维切分计算

  - mask逐bit模式
    1 2 template <typename T, bool isSetMask = true> __aicore__ inline void Copy(const LocalTensor<T>& dst, const LocalTensor<T>& src, const uint64_t mask[], const uint8_t repeatTime, const CopyRepeatParams& repeatParams)

  - mask连续模式
    1 2 template <typename T, bool isSetMask = true> __aicore__ inline void Copy(const LocalTensor<T>& dst, const LocalTensor<T>& src, const uint64_t mask, const uint8_t repeatTime, const CopyRepeatParams& repeatParams)


#### 参数说明


**表1 模板参数说明**

| 参数名 | 描述 |
| --- | --- |
| T | 操作数数据类型。 Atlas 350 加速卡，支持的数据类型为：uint8\_t/int8\_t/hifloat8\_t/fp8\_e4m3fn\_t/fp8\_e5m2\_t/fp4x2\_e2m1\_t/fp4x2\_e1m2\_t/fp8\_e8m0\_t/uint16\_t/int16\_t/half/bfloat16\_t/float/uint32\_t/int32\_t/uint64\_t/int64\_t Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：uint16\_t/int16\_t/half/bfloat16\_t/uint32\_t/int32\_t/float Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：uint16\_t/int16\_t/half/bfloat16\_t/uint32\_t/int32\_t/float Atlas 200I/500 A2 推理产品 ，支持的数据类型为：uint16\_t/int16\_t/half/bfloat16\_t/uint32\_t/int32\_t/float |
| isSetMask | 是否在接口内部设置mask。 true，表示在接口内部设置mask。 false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，本接口入参中的mask值必须设置为占位符MASK\_PLACEHOLDER。 |


**表2 参数说明**

| 参数名 | 输入/输出 | 描述 |
| --- | --- | --- |
| dst | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。起始地址需要保证32字节对齐。 |
| src | 输入 | 源操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。起始地址需要保证32字节对齐。 源操作数的数据类型需要与目的操作数保持一致。 |
| count | 输入 | 参与搬运的元素个数。 |
| mask/mask[] | 输入 | mask(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section4252658182)用于控制每次迭代内参与计算的元素。 逐bit模式：可以按位控制哪些元素参与计算，bit位的值为1表示参与计算，0表示不参与。 mask为数组形式，数组长度和数组元素的取值范围和操作数的数据类型有关。当操作数为16位时，数组长度为2，mask[0]、mask[1]∈[0, 264\-1]并且不同时为0；当操作数为32位时，数组长度为1，mask[0]∈(0, 264\-1]；当操作数为64位时，数组长度为1，mask[0]∈(0, 232\-1]。 例如，mask=[8, 0]，8=0b1000，表示仅第4个元素参与计算。 连续模式：表示前面连续的多少个元素参与计算。取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为16位时，mask∈[1, 128]；当操作数为32位时，mask∈[1, 64]；当操作数为64位时，mask∈[1, 32]。 |
| repeatTime | 输入 | 重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。 关于该参数的具体描述请参考高维切分API(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html)。 |
| repeatParams | 输入 | 控制操作数地址步长的数据结构。CopyRepeatParams类型。 具体定义请参考${INSTALL\_DIR}/include/ascendc/basic\_api/interface/kernel\_struct\_data\_copy.h，${INSTALL\_DIR}请替换为CANN软件安装后文件存储路径。 参数说明请参考表3。 |


**表3 CopyRepeatParams结构体参数说明**

| 参数名称 | 含义 |
| --- | --- |
| dstStride、srcStride | 用于设置同一迭代内datablock的地址步长，取值范围为[0,65535]。 同一迭代内datablock的地址步长参数说明请参考dataBlockStride(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section2815124173416)。 |
| dstRepeatSize、srcRepeatSize | 用于设置相邻迭代间的地址步长，取值范围为[0,4095]。 相邻迭代间的地址步长参数说明请参考repeatStride(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section139459347420)。 |


#### 返回值说明

无


#### 约束说明

- 源操作数和目的操作数的起始地址需要保证32字节对齐。
- tensor前n个数据计算接口仅支持Atlas 350 加速卡。
- 针对Atlas 350 加速卡，uint8_t/int8_t/hifloat8_t/fp8_e4m3fn_t/fp8_e5m2_t/fp4x2_e2m1_t/fp4x2_e1m2_t/fp8_e8m0_t/uint64_t/int64_t数据类型仅支持tensor前n个数据计算接口。
- 针对Atlas 350 加速卡，tensor前n个数据计算接口中的isSetMask参数不生效，保持默认值即可。
- Copy和矢量计算API一样，支持和掩码操作API配合使用。但Counter模式配合高维切分计算API时，和通用的Counter模式(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas_ascendc_10_0024.html)有一定差异。具体差异如下：

  - 通用的Counter模式：Mask代表整个矢量计算参与计算的元素个数，迭代次数不生效。
  - Counter模式配合Copy高维切分计算API，Mask代表每次Repeat中处理的元素个数，迭代次数生效。示意图如下：


#### 调用示例

本示例仅展示Compute流程中的部分代码。

本示例中操作数数据类型为int16_t。

- tensor前n个数据计算
  1 AscendC::Copy(dstLocal, srcLocal, 512);

  结果示例如下：

```
输入数据srcLocal：[9 -2 8 ... 9]
输出数据dstLocal:
[9 -2 8 ... 9]
```


- mask连续模式
  1 2 3 4 5 uint64_t mask = 128; // repeatTime = 4, 128 elements one repeat, 512 elements total // dstStride, srcStride = 1, no gap between blocks in one repeat // dstRepStride, srcRepStride = 8, no gap between repeats AscendC::Copy(dstLocal, srcLocal, mask, 4, { 1, 1, 8, 8 });

  结果示例如下：

```
输入数据srcLocal:[9 -2 8 ... 9]
输出数据dstLocal:
[9 -2 8 ... 9]
```


- mask逐bit模式
  1 2 3 4 5 uint64_t mask[2] = { UINT64_MAX, UINT64_MAX }; // repeatTime = 4, 128 elements one repeat, 512 elements total // dstStride, srcStride = 1, no gap between blocks in one repeat // dstRepStride, srcRepStride = 8, no gap between repeats AscendC::Copy(dstLocal, srcLocal, mask, 4, { 1, 1, 8, 8 });

  结果示例如下：

```
输入数据srcLocal：[9 -2 8 ... 9]
输出数据dstLocal:
[9 -2 8 ... 9]
```
