CANN ops-nn 算子 aclnnNonzeroV2 接口详解:两段式调用、参数约束与完整示例

原创2026-09-21 11:21:151,659 阅读
文章标签:人工智能深度学习算子库高性能计算模型量化AscendCANN

CANN ops-nn 算子 aclnnNonzeroV2 接口详解:两段式调用、参数约束与完整示例

导读

aclnnNonzeroV2 是 CANN ops-nn 算子库(index/non_zero 模块)提供的用于在 NPU 上计算张量非零元素位置索引的单算子 API。本文将围绕该接口的官方文档 index/non_zero/docs/aclnnNonzeroV2.md 展开,结合仓库中的接口声明、host 侧算子定义、infershape 实现与可执行示例,完整讲解两段式调用机制、参数语义、返回值错误码、硬件资源约束以及从编写到编译运行的完整实践流程,帮助开发者快速在 Atlas 系列产品上落地非零元素索引计算。

功能说明

aclnnNonzeroV2 用于找出输入张量 self 中所有非零元素的位置。设 self 的维度为 D(即 rank 为 D),self 中非零元素的个数为 N,则输出 out 的 shape 为 D * N,每一列表示一个非零元素的位置坐标,即输出是一个形状为 [D, N] 的二维张量。

例如输入 self 的形状为 [4, 2],其元素为 {0, 1, 2, 3, 4, 5, 6, 7},则非零元素共有 7 个(除首元素 0 外全部非零),输出 out 的形状为 [2, 7],第 i 列是两个坐标分量(行号、列号),对应第 i 个非零元素在原张量中的位置。

对比说明:仓库中还提供了 aclnnNonzero 接口,其输出 shape 为 N * D(每行为一个坐标)。V2 版本将输出组织为 D * N(每列为一个坐标),与 PyTorch 中 torch.nonzero 转置后的结果语义一致——仓库测试脚本 executor_aclnnNonzeroV2.py 正是以 torch.transpose(torch.nonzero(x), 0, 1) 作为 golden 基准进行比对。

产品支持情况

根据文档 index/non_zero/docs/aclnnNonzeroV2.md 与算子 README index/non_zero/README.md,产品支持情况如下:

产品 支持情况
Ascend 950PR / Ascend 950DT 支持
Atlas A3 训练系列产品 / Atlas A3 推理系列产品 支持
Atlas A2 训练系列产品 / Atlas A2 推理系列产品 支持
Atlas 200I/500 A2 推理产品 不支持
Atlas 推理系列产品 支持
Atlas 训练系列产品 支持

从算子定义源码 non_zero_def.cpp 可以看到,AICore 计算配置(OpAICoreConfig)为 ascend950 与 ascend350 两个平台添加了动态编译支持,并开启了 DynamicRankSupportFlag(动态 rank)与 DynamicShapeSupportFlag(动态 shape),这与文档中的产品支持矩阵相互印证。

两段式接口机制

aclnnNonzeroV2 遵循 CANN 单算子 API 的两段式接口调用规范,详细机制参见 docs/zh/context/two_phase_api.md。所谓"两段式",即每个算子被拆分为两个接口:

  1. 第一段接口 aclnnNonzeroV2GetWorkspaceSize:完成入参校验,并计算本次调用所需的 workspace 临时内存大小,同时返回包含算子计算流程的执行器(aclOpExecutor);
  2. 第二段接口 aclnnNonzeroV2:传入已申请的 workspace 与执行器,真正在指定 Stream 上执行计算。

必须先调用第一段接口,再调用第二段接口,且第二段接口不能重复调用。workspace 是指除输入/输出张量外,算子在 NPU 上完成计算所需的临时内存,其大小由第一段接口计算得出。

函数原型

两个接口的原型声明位于头文件 aclnn_nonzero_v2.h,具体如下:

aclnnStatus aclnnNonzeroV2GetWorkspaceSize(
  const aclTensor *self,
  aclTensor       *out,
  uint64_t        *workspaceSize,
  aclOpExecutor  **executor)
aclnnStatus aclnnNonzeroV2(
  void          *workspace,
  uint64_t       workspaceSize,
  aclOpExecutor *executor,
  aclrtStream    stream)

aclnnNonzeroV2GetWorkspaceSize 参数说明

参数表

参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续张量 Tensor
self 输入 待计算的目标张量 - FLOAT、DOUBLE、INT8、UINT8、INT16、UINT16、INT32、UINT32、INT64、UINT64、FLOAT16、BOOL、BFLOAT16 ND - √
out 输出 计算输出张量 - INT64 ND - √
workspaceSize 输出 返回需要在 Device 侧申请的 workspace 大小 - - - - -
executor 输出 返回 op 执行器,包含算子计算流程 - - - - -

平台相关的数据类型差异

  • Atlas 训练系列产品、Atlas 推理系列产品:self 数据类型不支持 BFLOAT16。

维度范围限制

Atlas 训练系列产品、Atlas 推理系列产品、Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品:由于硬件资源限制,输出索引要求在 int32 精度范围内,因此输入的某一维度不能超过 int32 的表示范围(即单维长度应满足 0 <= dim <= INT32_MAX)。

返回值(错误码)

第一段接口完成入参校验,出现以下场景时报错,返回 aclnnStatus 状态码(完整返回码定义参见 docs/zh/context/aclnn_return_code.md):

返回值 错误码 描述
ACLNN_ERR_PARAM_NULLPTR 161001 传入的 self 或 out 是空指针。
ACLNN_ERR_PARAM_INVALID 161002 self 或 out 的数据类型不在支持的范围之内。
ACLNN_ERR_PARAM_INVALID 161002 self 的 shape 某一维范围不满足要求。

源码级的参数校验流程

接口实现位于 aclnn_nonzero_v2.cpp,其校验逻辑 CheckParams 依次执行:

  1. CheckNotNull:检查 self、out 是否为空指针,失败返回 ACLNN_ERR_PARAM_NULLPTR(161001);
  2. CheckDtypeValid:检查 self 的数据类型是否在支持列表内,并校验 out 必须为 INT64,失败返回 ACLNN_ERR_PARAM_INVALID(161002);
  3. CheckShape:检查输入输出维度不超过 MAX_SUPPORT_DIMS_NUMS;
  4. CheckDims:检查输入 shape 合法性。

值得关注的是源码中针对不同平台维护了多份数据类型支持列表:

  • ASCEND910_DTYPE_SUPPORT_LIST:FLOAT、FLOAT16、INT8、UINT8、INT16、UINT16、INT32、UINT32、INT64、UINT64、DOUBLE、BOOL(不含 BF16);
  • ASCEND910B_DTYPE_SUPPORT_LIST:在上述基础上追加 DT_BF16;
  • ASCEND910B_AICORE_DTYPE_SUPPORT_LIST 与 REGBASE_AICORE_DTYPE_SUPPORT_LIST:用于判断当前 dtype 是否可走 AiCore 加速路径。

其中 IsAiCoreSupport 根据当前 NPU 架构(DAV_2201 或 RegBase 平台)与 dtype 判断是否启用 AiCore 实现;对于 0 维标量输入则关闭 AiCore 路径。若 out 为非连续张量,实现还会通过 l0op::Contiguous 与 l0op::ViewCopy 保证输出落位正确,这也解释了文档参数表中"非连续张量 Tensor:√"的支持标记。

此外,当输入或输出为空张量(IsEmpty)时,第一段接口直接将 workspaceSize 置 0 并返回成功,无需分配 workspace。

aclnnNonzeroV2 参数说明

第二段接口参数如下:

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

返回值同样为 aclnnStatus 状态码,具体参见 docs/zh/context/aclnn_return_code.md。第二段接口内部通过 CommonOpExecutorRun 完成实际计算下发(见 aclnn_nonzero_v2.cpp)。

约束说明

使用 aclnnNonzeroV2 时需注意以下约束:

  • 确定性计算:aclnnNonzeroV2 默认采用确定性实现,多次调用在相同输入下输出结果确定一致(确定性计算机制详见 docs/zh/context/determinism_compute.md)。
  • 输出内存申请:接口的输出 size 需要按照最大的输出 size 申请(即输入全部为非 0 的场景),实测输出 size 不能超过 2G;同时该接口使用的 workspace 也比较大,需要关注是否超过 Device 内存大小。
  • 索引精度限制:由于硬件资源限制,输出索引要求在 int32 精度范围内,输入某一维度不能超过 int32 的表示范围(参见上文"维度范围限制")。

调用示例

仓库提供了可直接运行的完整示例 test_aclnn_non_zero_v2.cpp,其流程与文档中的示例代码一致,下面给出完整代码(文档原始示例见 aclnnNonzeroV2.md 的"调用示例"小节,此处与仓库示例文件对齐):

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_nonzero_v2.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)
{
    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, aclFormat::ACL_FORMAT_ND,
                              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> selfShape = {4, 2};
    // 实际使用按照"self元素总数"作为最大的N值,申请out内存
    std::vector<int64_t> outShape = {2, 8};
    void* selfDeviceAddr = nullptr;
    void* outDeviceAddr = nullptr;
    aclTensor* self = nullptr;
    aclTensor* out = nullptr;
    std::vector<float> selfHostData = {0, 1, 2, 3, 4, 5, 6, 7};
    std::vector<int64_t> outHostData(16, 0);
    // 创建self aclTensor
    ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建out aclTensor
    ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_INT64, &out);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 3. 调用CANN算子库API,需要修改为具体的API名称
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
    // 调用aclnnNonzeroV2第一段接口
    ret = aclnnNonzeroV2GetWorkspaceSize(self, out, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnNonzeroV2GetWorkspaceSize 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);
    }
    // 调用aclnnNonzeroV2第二段接口
    ret = aclnnNonzeroV2(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnNonzeroV2 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(outShape);
    std::vector<int64_t> resultData(size, 0);
    ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), outDeviceAddr,
                      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: %ld\n", i, resultData[i]);
    }

    // 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改
    aclDestroyTensor(self);
    aclDestroyTensor(out);

    // 7.释放device资源,需要根据具体API的接口定义修改
    aclrtFree(selfDeviceAddr);
    aclrtFree(outDeviceAddr);
    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
    return 0;
}

示例代码的关键要点:

  • 示例中输入 self 形状为 [4, 2](共 8 个元素,最多 7 个非零),因此按"元素总数 8"作为最大 N 值申请输出 out 形状为 [2, 8](D=2 维,N 最大 8),预留了全非零场景下的输出空间;
  • 第一段接口返回后,若 workspaceSize > 0 才需要申请 workspace 内存,并在使用结束后释放;
  • 输出结果通过 aclrtMemcpy 从 Device 拷回 Host 侧打印。

编译与运行

详细的编译与运行流程参见 docs/zh/context/compile_and_run_sample.md,核心步骤如下:

  1. 准备代码与编译脚本:将上述示例保存为 test_aclnn_non_zero_v2.cpp,并准备对应的 CMakeLists.txt(可参考该文档中的模板,将源文件替换为 test_aclnn_non_zero_v2.cpp)。注意链接 CANN 的库文件(如 libascendcl.so、libnnopbase.so、libopapi_math.so、libopapi_nn.so)。
  2. 配置环境变量:安装 CANN 软件后,执行 source ${INSTALL_DIR}/set_env.sh 使环境变量生效(${INSTALL_DIR} 为 CANN 软件安装路径)。
  3. 编译:
    mkdir -p build
    cd build
    cmake ../ -DCMAKE_CXX_COMPILER=g++ -DCMAKE_SKIP_RPATH=TRUE
    make
    
  4. 运行:编译成功后可执行文件位于 bin 目录下,进入该目录运行即可:
    cd bin
    ./opapi_test
    
  5. 报错排查:若执行结果报错,可使用 aclGetRecentErrMsg 接口获取具体异常信息,并结合 docs/zh/context/aclnn_return_code.md 中的返回码表定位问题。

底层实现与测试印证

Host 侧算子定义

算子定义文件 non_zero_def.cpp 中,输入 x 支持 FLOAT、FLOAT16、BF16、BOOL、INT8、UINT8、INT16、UINT16、INT32、UINT32、INT64 等数据类型,输出 y 对应为 INT32 或 INT64,全部采用 ND 格式,并声明了可选的 transpose 属性(BOOL,默认 false)——该属性控制输出是按 [N, D] 还是 [D, N] 组织坐标。

Infershape 推导

在 non_zero_infershape.cpp 中,InferShape4NonZero 将输出固定为 2 维:当 transpose 为 true 时输出 shape 为 [D, N](对应 aclnnNonzeroV2 的语义),否则为 [N, D];其中非零个数 N 在动态 shape 场景下标记为 UNKNOWN_DIM,并由 InferShapeRange4NonZero 给出输出范围(最大为输入元素总数、最小为 0)。InferDataType4NonZero 则根据属性将输出数据类型设置为 INT64,与文档中 out 必须为 INT64 的约束一致。

Kernel 实现

算子核函数位于 op_kernel/arch35,针对不同维度(dim1 ~ dim8)分别实现了 non_zero_small_mask_trans_*(小规模 + 转置输出)与 non_zero_big_mask_dim*(大规模掩码)等多套模板,用于处理不同规模输入下的非零索引计算;这些实现与文档中"输出按列组织坐标"的语义严格对应。

测试用例

仓库在 tests/ut 目录提供了 host 侧单测(如 test_aclnn_nonzero_v2.cpp、infershape 单测 test_non_zero_infershape.cpp),以及在 tests/st/aclnnNonzeroV2 提供的 ATK 场景测试与 PyTorch golden 脚本,可帮助验证接口在真实 NPU 上的行为与官方语义一致。

总结

aclnnNonzeroV2 是 CANN ops-nn 算子库中用于获取张量非零元素位置索引的高效实现:它通过两段式接口完成"workspace 规划 + 计算执行"的分离,支持丰富的输入数据类型与 ND 格式(含非连续张量),在 Atlas 训练/推理系列及 Ascend 950 等平台提供确定性计算能力。实际使用时需重点把握三点:一是严格按两段式顺序调用且第二段接口不可重复执行;二是按输入元素总数(全非零场景)预留输出内存并关注 2G 上限与 workspace 开销;三是注意各平台对 BFLOAT16 支持与 int32 索引范围限制的差异。结合仓库提供的 示例代码 与 编译运行指南,即可快速完成从编码到 NPU 上运行验证的全流程。

登录后查看全文
ops-nn