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

#### 产品支持情况

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


#### 功能说明

调用一次IterateAll，会计算出singleCoreM * singleCoreN大小的C矩阵。迭代顺序可通过tiling参数iterateOrder调整。


#### 函数原型

```
template <bool sync = true> __aicore__ inline void IterateAll(const GlobalTensor<DstT>& gm, uint8_t enAtomic = 0, bool enSequentialWrite = false, bool waitIterateAll = false, bool fakeMsg = false)
```


```
template <bool sync = true> __aicore__ inline void IterateAll(const LocalTensor<DstT>& ubCmatrix, uint8_t enAtomic = 0)
```


#### 参数说明


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

| 参数名 | 描述 |
| --- | --- |
| sync | 获取C矩阵过程分为同步和异步两种模式： 同步：需要同步等待IterateAll执行结束 异步：不需要同步等待IterateAll执行结束 通过该参数设置同步或者异步模式：同步模式设置为true；异步模式设置为false，默认为同步模式。 Atlas 200I/500 A2 推理产品 只支持设置为true。 |


**表2 接口参数说明**

| 参数名 | 输入/输出 | 描述 |
| --- | --- | --- |
| gm | 输出 | C矩阵。类型为GlobalTensor。 Atlas 350 加速卡，支持的数据类型为：half/float/bfloat16\_t/int32\_t/int8\_t/fp8\_e4m3fn\_t/hifloat8\_t Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：half/float/bfloat16\_t/int32\_t/int8\_t Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：half/float/bfloat16\_t/int32\_t/int8\_t Atlas 推理系列产品 AI Core，支持的数据类型为：half/float/int8\_t/int32\_t Atlas 200I/500 A2 推理产品 ，支持的数据类型为half/float/bfloat16\_t/int32\_t |
| ubCmatrix | 输出 | C矩阵。类型为LocalTensor，支持的TPosition为TSCM、VECIN，输出到VECIN Tensor时建议使用Iterate接口。 Atlas 350 加速卡，支持的数据类型为：half/float/bfloat16\_t/int32\_t/int8\_t/fp8\_e4m3fn\_t/hifloat8\_t Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：half/float/bfloat16\_t/int32\_t/int8\_t Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：half/float/bfloat16\_t/int32\_t/int8\_t Atlas 推理系列产品 AI Core不支持包含该参数的原型接口 Atlas 200I/500 A2 推理产品 ，支持的数据类型为half/float/bfloat16\_t/int32\_t |
| enAtomic | 输入 | 是否开启Atomic操作，默认值为0。 参数取值： 0：不开启Atomic操作 1：开启AtomicAdd累加操作 2：开启AtomicMax求最大值操作 3：开启AtomicMin求最小值操作 对于 Atlas 推理系列产品 AI Core，只有输出位置是GM才支持开启Atomic操作。 对于 Atlas 200I/500 A2 推理产品 ，只有输出位置是GM才支持开启Atomic操作。 |
| enSequentialWrite | 输入 | 是否开启连续写模式（连续写，写入[baseM, baseN]；非连续写，写入[singleCoreM, singleCoreN]中对应的位置），默认值false（非连续写模式）。 Atlas 200I/500 A2 推理产品 不支持该参数。 |
| waitIterateAll | 输入 | 仅在异步场景下使用，是否需要通过WaitIterateAll接口等待IterateAll执行结束。 true：需要通过WaitIterateAll接口等待IterateAll执行结束。 false：不需要通过WaitIterateAll接口等待IterateAll执行结束，开发者自行处理等待IterateAll执行结束的过程。 |
| fakeMsg | 输入 | 仅在IBShare场景（模板参数中开启了doIBShareNorm开关）和IntraBlockPartSum场景（模板参数中开启了intraBlockPartSum开关）使用。 IBShare场景 该场景复用L1上相同的A矩阵或B矩阵数据，要求AIV分核调用IterateAll的次数必须匹配，此时需要调用IterateAll并设置fakeMsg为true，不执行真正的计算，仅用来保证IterateAll调用成对出现。默认值为false，表示执行真正的计算。 IntraBlockPartSum场景 用于分离模式下的Vector计算、Cube计算融合，实现多个AIV核的一次Matmul计算结果（baseM \* baseN大小的矩阵分片）在L0C Buffer上累加。默认值为false，表示执行各AIV核的Matmul计算结果在L0C Buffer上累加。 |


#### 返回值说明

无


#### 约束说明

传入的C矩阵地址空间大小需要保证不小于singleCoreM * singleCoreN个元素。


#### 调用示例

IterateAll接口的调用示例如下，更多异步场景的算子样例请参考IterateAll异步场景样例(https://gitcode.com/cann/asc-devkit/tree/9.0.0/examples/01_simd_cpp_api/03_libraries/00_matrix/matmul_async_iterate_all)。

```
REGIST_MATMUL_OBJ(&pipe, GetSysWorkSpacePtr(), mm, &tiling);
mm.SetTensorA(gm_a);
mm.SetTensorB(gm_b);
if (tiling.isBias) {
    mm.SetBias(gmBias);
}
mm.IterateAll(gm_c);    // 计算
mm.End();
```