Matmul算子开启L0缓存功能直调样例

概述

本样例介绍Matmul API中使能L0缓存的使用方式。以左矩阵A为例，L0缓存指在数据从A1搬运到A2的MTE1搬运过程，当A1中数据搬运到A2后，该缓存的数据保持在A2中，同时缓存数据依次与B2中不同的数据完成乘加运算。使能L0缓存可以减少MTE1重复搬运，从而提升性能。

L0缓存没有对外开关，由Matmul API内部根据用户配置的shape信息自动推导是否可以开启L0缓存，当前仅支持L0A缓存，使能场景要求如下：

• 需要配置全部常量化Tiling场景，即singleCoreM/singleCoreN/singleCoreK和baseM/baseN/baseK均需通过常量化接口设置；
• singleCoreM=baseM同时singleCoreK=baseK。

支持的产品

• Ascend 950PR/Ascend 950DT
• Atlas A3 训练系列产品/Atlas A3 推理系列产品
• Atlas A2 训练系列产品/Atlas A2 推理系列产品

目录结构介绍

├── matmul_l0cache
│   └── scripts
│       ├── gen_data.py         // 输入数据和真值数据生成脚本文件
│       └── verify_result.py    // 真值对比文件
│   ├── CMakeLists.txt          // 编译工程文件
│   ├── data_utils.h            // 数据读入写出函数
│   └── matmul.asc              // Ascend C算子实现 & 调用样例

算子描述

• 算子功能：

  Matmul算子调用Matmul高阶API对输入的A，B矩阵做矩阵乘和加bias偏置，使能A矩阵的L0缓存，减少MTE1重复搬运，提升算子性能。

• 算子规格：

  算子类型(OpType)	Matmul
  算子输入	name	shape	data type	format	isTrans
  	a	(2560, 128)	float16	ND	false
  	b	(128, 2048)	float16	ND	false
  	bias	(2048, )	float	ND	-
  算子输出	c	(2560, 2048)	float	ND	-
  核函数名	matmul_custom

• 算子实现：

  • 算子Kernel实现

    • 计算逻辑：C = A * B + Bias。
      • A、B为源操作数，A为左矩阵，形状为[M, K]；B为右矩阵，形状为[K, N]。
      • C为目的操作数，存放矩阵乘结果的矩阵，形状为[M, N]。
      • Bias为矩阵乘偏置，形状为[1, N]。对A*B结果矩阵的每一行都采用该Bias进行偏置。
    • 具体步骤：
      • 创建Matmul对象。
        设置MatmulShapeParams，满足：singleCoreM=baseM、singleCoreK=baseK，调用GetMMConfig接口获取自定义MatmulConfig。调用GetMatmulApiTiling接口获取常量化的Matmul Tiling参数。

        constexpr static int32_t SINGLE_M = 256; // custom matmul kernel support max value of M Dim shape
        constexpr static int32_t SINGLE_N = 1024; // custom matmul kernel support max value of N Dim shape
        constexpr static int32_t SINGLE_K = 128; // custom matmul kernel support max value of K Dim shape
        constexpr static int32_t BASE_M = 256;  // BASEM * BASE_K * sizeof(typeC) <=L0A size
        constexpr static int32_t BASE_N = 128;  // BASEN * BASE_K * sizeof(typeB) <=L0B size
        constexpr static int32_t BASE_K = 128;   // BASEM * BASE_N * sizeof(typeC) <=L0C size
        constexpr static MatmulShapeParams shapeParams = { SINGLE_M, SINGLE_N, SINGLE_K, BASE_M, BASE_N, BASE_K };
        constexpr static MatmulConfig CUSTOM_CFG = GetMMConfig<MatmulConfigMode::CONFIG_NORM>(shapeParams);
        constexpr static auto CONSTANT_CFG = AscendC::GetMatmulApiTiling<A_TYPE, B_TYPE, C_TYPE, BIAS_TYPE>(CUSTOM_CFG);
        AscendC::Matmul<A_TYPE, B_TYPE, C_TYPE, BIAS_TYPE, CONSTANT_CFG> matmulObj;
        

      • 初始化操作。
      • 设置左矩阵A、右矩阵B、Bias。
      • 进行矩阵乘操作。
      • 结束矩阵乘操作。

  • 算子Tiling实现

    • Ascend C提供一组Matmul Tiling API，方便用户获取Matmul kernel计算时所需的Tiling参数。只需要传入A/B/C矩阵等信息，调用API接口，即可获取到TCubeTiling结构体中的相关参数。
    • 获取Tiling参数的流程如下：
      • 创建一个Tiling对象。
      • 设置A、B、C、Bias的参数类型信息；M、N、Ka、Kb形状信息等。
      • 调用GetTiling接口，获取Tiling信息。

  • 调用实现
    使用内核调用符<<<>>>调用核函数。

编译运行

在本样例根目录下执行如下步骤，编译并执行算子。

• 配置环境变量
  请根据当前环境上CANN开发套件包的安装方式，选择对应配置环境变量的命令。

  • 默认路径，root用户安装CANN软件包

    source /usr/local/Ascend/ascend-toolkit/set_env.sh
    

  • 默认路径，非root用户安装CANN软件包

    source $HOME/Ascend/ascend-toolkit/set_env.sh
    

  • 指定路径install_path，安装CANN软件包

    source ${install_path}/ascend-toolkit/set_env.sh
    

• 样例执行

  mkdir -p build && cd build;    # 创建并进入build目录
  cmake ..;make -j;    # 编译工程
  python3 ../scripts/gen_data.py    # 生成测试输入数据
  ./demo                        # 执行编译生成的可执行程序，执行样例
  python3 ../scripts/verify_result.py output/output.bin output/golden.bin    # 验证输出结果是否正确，确认算法逻辑正确
  

  执行结果如下，说明精度对比成功。

  test pass!