0
代码
代码
Issues
Pull Requests
讨论
Wiki
分析
0
cann-robotcann-robotfix ScatterPaKvCache doc
3bb7be9c创建于 14 天前历史提交

aclnnScatterPaKvCache

📄 查看源码

产品支持情况

产品 是否支持
Ascend 950PR/Ascend 950DT √
Atlas A3 训练系列产品/Atlas A3 推理系列产品 √
Atlas A2 训练系列产品/Atlas A2 推理系列产品 √
Atlas 200I/500 A2 推理产品 ×
Atlas 推理系列产品 ×
Atlas 训练系列产品 ×

功能说明

  • 接口功能：更新KvCache中指定位置的key和value。

  • 输入输出支持以下场景：

    • 场景一：

      key:[batch * seq_len, num_head, k_head_size]
value:[batch * seq_len, num_head, v_head_size]
keyCache:[num_blocks, num_head * k_head_size // last_dim_k, block_size, last_dim_k]/[num_blocks, num_head, k_head_size // last_dim_k, block_size, last_dim_k]
valueCache:[num_blocks, num_head * v_head_size // last_dim_v, block_size, last_dim_v]/[num_blocks, num_head, v_head_size // last_dim_v, block_size, last_dim_v]
slotMapping:[batch * seq_len]
cacheMode:"PA_NZ"

last_dim_k = 32 / sizeof(dtypeKey)
last_dim_v = 32 / sizeof(dtypeValue)
(k_head_size * sizeof(dtypeKey)) % 32 == 0
(v_head_size * sizeof(dtypeValue)) % 32 == 0

      其中key和value的type可以相同，也可以不同

    • 场景二：

      key:[batch * seq_len, num_head, k_head_size]
value:[batch * seq_len, num_head, v_head_size]
keyCache:[num_blocks, block_size, num_head, k_head_size]
valueCache:[num_blocks, block_size, num_head, v_head_size]
slotMapping:[batch * seq_len]
cacheMode:"Norm"
scatter_mode:"None"/"Nct"

      其中k_head_size与v_head_size可以不同，也可以相同。

    • 场景三：

      key:[batch, seq_len, num_head, k_head_size]
value:[batch, seq_len, num_head, v_head_size]
keyCache:[num_blocks, block_size, 1, k_head_size]
valueCache:[num_blocks, block_size, 1, v_head_size]
slotMapping:[batch, num_head]
compressLensOptional:[batch, num_head]
seqLensOptional:[batch]
compressSeqOffsetOptional:[batch * num_head]
cacheMode:"Norm"

    • 场景四：

      key:[num_tokens, num_head, k_head_size]
value:[num_tokens, num_head, v_head_size]
keyCache:[num_blocks, block_size, 1, k_head_size]
valueCache:[num_blocks, block_size, 1, v_head_size]
slotMapping:[batch * num_head]
compressLensOptional:[batch * num_head]
seqLensOptional:[batch]
cacheMode:"Norm"
scatter_mode:"Alibi"

    • 场景五：

      key:[num_tokens, num_head, k_head_size]
value:[num_tokens, num_head, v_head_size]
keyCache:[num_blocks, block_size, 1, k_head_size]
valueCache:[num_blocks, block_size, 1, v_head_size]
slotMapping:[batch * num_head]
compressLensOptional:[batch * num_head]
seqLensOptional:[batch]
compressSeqOffsetOptional:[batch * num_head]
cacheMode:"Norm"
scatter_mode:"Rope"/"Omni"

    • 场景六：

      key:[batch * seq_len, num_head, k_head_size]
value:[]
keyCache:[num_blocks, block_size, num_head, k_head_size]
valueCache:[]
slotMapping:[batch * seq_len]
cacheMode:"Norm"
scatter_mode:"None"/"Nct"

    • 场景七：

      key:[num_tokens, num_head, k_head_size]
value:[num_tokens, num_head, v_head_size]
keyCache:[num_blocks, num_head, block_size, k_head_size]
valueCache:[num_blocks, num_head, block_size, v_head_size]
slotMapping:[num_tokens]
cacheMode:"Norm"
scatter_mode:"NHSD"

  • 上述场景根据构造的参数来区别，符合第一种入参构造走场景一，符合第二种构造走场景二，符合第三种构造走场景三，符合第四种构造走场景四，符合第五种构造走场景五，符合第六种构造走场景六。场景一、场景二、场景六没有compressLensOptional、seqLensOptional、compressSeqOffsetOptional这三个可选参数。场景四没有compressSeqOffsetOptional可选参数。

  • Atlas A3 训练系列产品/Atlas A3 推理系列产品、Atlas A2 训练系列产品/Atlas A2 推理系列产品：仅支持场景一、二、四、五、六、七。

  • Ascend 950PR/Ascend 950DT：仅支持场景一、二、四、五。

函数原型

每个算子分为两段式接口，必须先调用“aclnnScatterPaKvCacheGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnScatterPaKvCache”接口执行计算。

aclnnStatus aclnnScatterPaKvCacheGetWorkspaceSize(
  const aclTensor   *key, 
  aclTensor         *keyCacheRef, 
  const aclTensor   *slotMapping, 
  const aclTensor   *value, 
  aclTensor         *valueCacheRef, 
  const aclTensor   *compressLensOptional, 
  const aclTensor   *compressSeqOffsetOptional, 
  const aclTensor   *seqLensOptional, 
  char              *cacheModeOptional, 
  char              *scatterModeOptional, 
  const aclIntArray *stridesOptional, 
  const aclIntArray *offsetsOptional, 
  uint64_t          *workspaceSize, 
  aclOpExecutor    **executor)

aclnnStatus aclnnScatterPaKvCache(
  void          *workspace, 
  uint64_t       workspaceSize, 
  aclOpExecutor *executor, 
  aclrtStream    stream)

aclnnScatterPaKvCacheGetWorkspaceSize

  • 参数说明

    参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor
    key（aclTensor*） 输入 待更新的key值，当前step多个token的key。 - FLOAT16、FLOAT、BFLOAT16、INT8、UINT8、INT16、UINT16、INT32、UINT32、HIFLOAT8、FLOAT8_E5M2、FLOAT8_E4M3FN、FLOAT4_E1M2、FLOAT4_E2M1 ND 3-4 x
    keyCacheRef（aclTensor*） 输入/输出 需要更新的key cache，当前layer的key cache。 当传空指针或"Norm"时，仅支持ND内存排布格式。
    当传"PA_NZ"时，仅支持FRACTAL_NZ内存排布。    		 与key保持一致 ND 4-5 x
    slotMapping（aclTensor*） 输入 每个token key或value在cache中的存储偏移。 - INT32、INT64 ND 1 x
    value（aclTensor*） 输入 待更新的value值，当前step多个token的value。 非0维下shape与key一致 与key保持一致 ND 0、3、4 x
    valueCacheRef（aclTensor*） 输入/输出 需要更新的value cache，当前layer的value cache。 非0维下shape与keyCacheRef一致，当传空指针或"Norm"时，仅支持ND内存排布格式。
    当传"PA_NZ"时，仅支持FRACTAL_NZ内存排布。    		 与key保持一致 ND 0、4、5 x
    compressLensOptional（aclTensor*） 可选输入 压缩量。 - 与slotMapping保持一致 ND 1 x
    compressSeqOffsetOptional（aclTensor*） 可选输入 每个batch每个head的压缩起点。 - 与slotMapping保持一致 ND 1 x
    seqLensOptional（aclTensor*） 可选输入 每个batch的实际seqLens。 - 与slotMapping保持一致 ND 1 x
    cacheModeOptional（char*） 输入 表示keyCacheRef和valueCacheRef的内存排布格式。 当传空指针或"Norm"时，仅支持ND内存排布格式。
    当传"PA_NZ"时，仅支持FRACTAL_NZ内存排布。    		 - - - -
    scatterModeOptional（char*） 输入 表示更新的key和value的状态。 当传空指针或"None"时，表示更新的key和value是非压缩状态且连续。
    当传"Alibi"时，表示更新key和value是基于Alibi结构的压缩状态。
    当传"Rope"时，表示更新key和value是基于Rope结构的压缩状态。
    当传"Omni"时，表示更新key和value是基于Omni结构的压缩状态。
    当传"Nct"时，表示更新的key和value是非压缩状态但非连续。
    当传"NHSD"时，表示keyCacheRef和keyCacheRef的格式时[num_block, num_head, block_size, head_size]。    		 - - - -
    stridesOptional（aclIntArray*） 输入 key和value在非连续状态下的步长。 数组长度为2。其值应该大于0。仅当scatterModeOptional为"Nct"时生效，分别表示strideK和strideV。 - - - -
    offsetsOptional（aclIntArray*） 输入 key和value在非连续状态下的偏移。 数组长度为2。其值应该大于0。仅当scatterModeOptional为"Nct"时生效，分别表示offsetK和offsetV。 - - - -
    workspaceSize（uint64_t*） 输出 返回需要在Device侧申请的workspace大小。 - - - - -
    executor（aclOpExecutor**） 输出 返回op执行器，包含了算子计算流程。 - - - - -

    • Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品：

      • 输入key、keyCacheRef、value、valueCacheRef不支持FLOAT、UINT8、INT16、UINT16、INT32、UINT32、HIFLOAT8、FLOAT8_E5M2、FLOAT8_E4M3FN、FLOAT4_E1M2、FLOAT4_E2M1数据类型。

    • Ascend 950PR/Ascend 950DT：仅场景一、场景二scatter_mode为None时支持FLOAT4_E1M2、FLOAT4_E2M1。

  • 返回值：

    aclnnStatus：返回状态码，具体参见aclnn返回码。

    第一段接口完成入参校验，出现以下场景时报错：

    返回值 错误码 描述
    ACLNN_ERR_PARAM_NULLPTR 161001 传入的key、keyCacheRef、slotMapping、value、valueCacheRef是空指针。
    ACLNN_ERR_PARAM_INVALID 161002 参数key、value的数据类型不在支持的范围之内。
    key、keyCacheRef、value、valueCacheRef的数据类型不一致。
    slotMapping、compressLensOptional、compressSeqOffsetOptional、seqLensOptional的数据类型不一致。
    ACLNN_ERR_PARAM_INVALID 561002 key的维数不等于3维或4维，value的维数不等于0维、3维或4维。

aclnnScatterPaKvCache

  • 参数说明

    参数名 输入/输出 描述
    workspace 输入 在Device侧申请的workspace内存地址。
    workspaceSize 输入 在Device侧申请的workspace大小，由第一段接口aclnnScatterPaKvCacheGetWorkspaceSize获取。
    executor 输入 op执行器，包含了算子计算流程。
    stream 输入 指定执行任务的Stream。

  • 返回值

    aclnnStatus：返回状态码，具体参见aclnn返回码。

约束说明

  • 确定性计算：
    • aclnnScatterPaKvCache默认确定性实现。
  • key、value、keyCacheRef、valueCacheRef的数据类型必须一致；
  • slotMapping、compressLensOptional、compressSeqOffsetOptional、seqLensOptional的数据类型必须一致；
  • slotMapping的取值范围[0,num_blocks*block_size-1]，且slotMapping内的元素值保证不重复，重复时不保证正确性；
  • 当key和value都是3维，则key和value的前两维shape必须相同；
  • 当key和value都是4维，则key和value的前三维shape必须相同，且keyCacheRef和valueCacheRef的第三维必须是1；
  • 当key和value是4维时，compressLensOptional、seqLensOptional为必选参数；当key和value是3维时，compressLensOptional、compressSeqOffsetOptional、seqLensOptional为可选参数；
  • 当key和value都是4维时，slotMapping是二维，且slotMapping的第一维值等于key的第一维为batch，slotMapping的第二维值等于key的第三维为num_head（对应场景三）；
  • 当key和value都是4维时，seqLensOptional是一维，且seqLensOptional的值等于key的第一维为batch（对应场景三）；
  • 当key和value是3维且存在seqLensOptional时，seqLensOptional中所有值的和等于key的第一维为num_blocks（对应场景四、五）；
  • seqLensOptional和compressLensOptional里面的每个元素值必须满足公式：reduceSum(seqLensOptional[i] - compressLensOptional[i]) <= num_blocks * block_size （对应场景三、四、五）。
  • 当cacheModeOptional为“PA_NZ”时，keyCacheRef和valueCacheRef的倒数第二维必须小于UINT16_MAX（对应场景一）。
  • k_head_size和v_head_size必须32字节对齐（对应场景七）。
  • num_head必须小于4095（对应场景七）。
  • block_size * k_head_size和block_size * v_head_size必须小于UINT32_MAX（对应场景七）。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。

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

    #include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_scatter_pa_kv_cache.h"

#define CHECK_RET(cond, return_expr) \
  do {                               \
    if (!(cond)) {                   \
      return_expr;                   \
    }                                \
  } while (0)

#define LOG_PRINT(message, ...)     \
  do {                              \
    printf(message, ##__VA_ARGS__); \
  } while (0)

int64_t GetShapeSize(const std::vector<int64_t>& shape) {
  int64_t shapeSize = 1;
  for (auto i : shape) {
    shapeSize *= i;
  }
  return shapeSize;
}

int Init(int32_t deviceId, aclrtStream* stream) {
// 固定写法，资源初始化
  auto ret = aclInit(nullptr);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
  ret = aclrtSetDevice(deviceId);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret);
  ret = aclrtCreateStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret);
  return 0;
}

template <typename T>
int CreateAclTensor(const std::vector<T>& hostData, const std::vector<int64_t>& shape, void** deviceAddr, aclDataType dataType, aclTensor** tensor, aclFormat format) {
  auto size = GetShapeSize(shape) * sizeof(T);
  // 调用aclrtMalloc申请device侧内存
  auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);
  // 调用aclrtMemcpy将host侧数据拷贝到device侧内存上
  ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);

  // 计算连续tensor的strides
  std::vector<int64_t> strides(shape.size(), 1);
  for (int64_t i = shape.size() - 2; i >= 0; i--) {
    strides[i] = shape[i + 1] * strides[i + 1];
  }

  // 调用aclCreateTensor接口创建aclTensor
  *tensor = aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, format,
                            shape.data(), shape.size(), *deviceAddr);
  return 0;
}

int main() {
  // 1. （固定写法）device/stream初始化，参考acl API手册
  // 根据自己的实际device填写deviceId
  int32_t deviceId = 0;
  aclrtStream stream;
  auto ret = Init(deviceId, &stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

  // 2. 构造输入与输出，需要根据API的接口自定义构造
  std::vector<int64_t> keyShape = {2, 2, 32};
  std::vector<int64_t> keyCacheShape = {1, 4, 32, 16};
  std::vector<int64_t> slotMappingShape = {2};
  std::vector<int64_t> valueShape = {2, 2, 32};
  std::vector<int64_t> valueCacheShape = {1, 4, 32, 16};

  void* keyDeviceAddr = nullptr;
  void* valueDeviceAddr = nullptr;
  void* slotMappingDeviceAddr = nullptr;
  void* keyCacheDeviceAddr = nullptr;
  void* valueCacheDeviceAddr = nullptr;
  void* compressLensDeviceAddr = nullptr;
  void* compressSeqOffsetDeviceAddr = nullptr;
  void* seqLensDeviceAddr = nullptr;

  aclTensor* key = nullptr;
  aclTensor* value = nullptr;
  aclTensor* slotMapping = nullptr;
  aclTensor* keyCache = nullptr;
  aclTensor* valueCache = nullptr;
  aclTensor* compressLens = nullptr;
  aclTensor* compressSeqOffset = nullptr;
  aclTensor* seqLens = nullptr;
  char * cacheMode = "PA_NZ";
  char * scatterMode = "None";

  std::vector<int16_t> hostKey(128, 1);
  std::vector<int16_t> hostValue(128, 1);
  std::vector<int32_t> hostSlotMapping(2, 1);
  std::vector<int16_t> hostKeyCacheRef(2048, 1);
  std::vector<int16_t> hostValueCacheRef(2048, 1);
  std::vector<int64_t> hostStrides(2, 1);
  std::vector<int64_t> hostOffsets(2, 0);

  // 创建key aclTensor
  ret = CreateAclTensor(hostKey, keyShape, &keyDeviceAddr, aclDataType::ACL_FLOAT16, &key, aclFormat::ACL_FORMAT_ND);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建value aclTensor
  ret = CreateAclTensor(hostValue, valueShape, &valueDeviceAddr, aclDataType::ACL_FLOAT16, &value, aclFormat::ACL_FORMAT_ND);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建slotMapping aclTensor
  ret = CreateAclTensor(hostSlotMapping, slotMappingShape, &slotMappingDeviceAddr, aclDataType::ACL_INT32, &slotMapping, aclFormat::ACL_FORMAT_ND);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建keyCache aclTensor
  ret = CreateAclTensor(hostKeyCacheRef, keyCacheShape, &keyCacheDeviceAddr, aclDataType::ACL_FLOAT16, &keyCache, aclFormat::ACL_FORMAT_ND);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建valueCache aclTensor
  ret = CreateAclTensor(hostValueCacheRef, valueCacheShape, &valueCacheDeviceAddr, aclDataType::ACL_FLOAT16, &valueCache, aclFormat::ACL_FORMAT_ND);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  aclIntArray *strides = aclCreateIntArray(hostStrides.data(), 2);
  CHECK_RET(strides != nullptr, return ACL_ERROR_INTERNAL_ERROR);
  aclIntArray *offsets = aclCreateIntArray(hostOffsets.data(), 2);
  CHECK_RET(offsets != nullptr, return ACL_ERROR_INTERNAL_ERROR);

  // 3. 调用CANN算子库API，需要修改为具体的Api名称
  uint64_t workspaceSize = 0;
  aclOpExecutor* executor;
  // 调用aclnnScatterPaKvCache第一段接口
  ret = aclnnScatterPaKvCacheGetWorkspaceSize(key, keyCache, slotMapping, value, valueCache, compressLens, compressSeqOffset, seqLens, cacheMode, scatterMode, strides, offsets, &workspaceSize, &executor);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnScatterPaKvCacheGetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
  // 根据第一段接口计算出的workspaceSize申请device内存
  void* workspaceAddr = nullptr;
  if (workspaceSize > 0) {
    ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
  }
  // 调用aclnnScatterPaKvCache第二段接口
  ret = aclnnScatterPaKvCache(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnScatterPaKvCache failed. ERROR: %d\n", ret); return ret);

  // 4. （固定写法）同步等待任务执行结束
  ret = aclrtSynchronizeStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);

  // 5. 获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
  auto size = GetShapeSize(keyCacheShape);
  std::vector<float> resultData(size, 0);
  ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), keyCacheDeviceAddr,
                    size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
  for (int64_t i = 0; i < size; i++) {
      LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]);
  }

  // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
  aclDestroyTensor(key);
  aclDestroyTensor(value);
  aclDestroyTensor(slotMapping);
  aclDestroyTensor(keyCache);
  aclDestroyTensor(valueCache);
  aclDestroyTensor(compressLens);
  aclDestroyTensor(compressSeqOffset);
  aclDestroyTensor(seqLens);
  aclDestroyIntArray(strides);
  aclDestroyIntArray(offsets);
  // 7. 释放device资源，需要根据具体API的接口定义参数
  aclrtFree(keyDeviceAddr);
  aclrtFree(valueDeviceAddr);
  aclrtFree(slotMappingDeviceAddr);
  aclrtFree(keyCacheDeviceAddr);
  aclrtFree(valueCacheDeviceAddr);
   if (workspaceSize > 0) {
    aclrtFree(workspaceAddr);
  }
  aclrtDestroyStream(stream);
  aclrtResetDevice(deviceId);
  aclFinalize();
  return 0;
}