asc-devkit 算子原型注册:NeedCheckSupportFlag 融合阶段参数校验开关详解
asc-devkit 算子原型注册:NeedCheckSupportFlag 融合阶段参数校验开关详解
导读
在 asc-devkit(CANN 昇腾 AI 处理器算子开发套件)中,算子原型注册与管理是算子能否被图编译框架正确识别、融合与调度的关键环节。NeedCheckSupportFlag 是 OpAICoreConfig 类提供的配置项之一,用于控制算子融合阶段是否调用算子参数校验函数对输入 data type 与 shape 进行校验。读完本文,你将掌握该开关的语义、函数原型、默认值与配套的 SetCheckSupport 校验函数注册方式,并能基于仓库中的完整示例在自己的算子原型中正确启用融合阶段参数校验。
功能说明:融合阶段的 data type 与 shape 校验开关
NeedCheckSupportFlag(bool flag) 用于标识是否在算子融合阶段调用算子参数校验函数进行 data type 与 shape 的校验。其取值语义如下:
- 配置为
true:框架在算子融合阶段会调用通过 SetCheckSupport 注册的算子参数校验函数,检查算子是否支持指定的输入。此场景下,算子开发者必须自行实现算子参数校验的回调函数并完成注册,否则开关将无从生效。 - 配置为
false:表示不需要在融合阶段进行该校验,框架不会触发参数校验回调。
从仓库文档看,该配置项在 AddConfig 默认配置表 和 OpAICoreConfig 构造函数初始化表 中的默认值均为 false。也就是说,在不显式配置时,算子默认不会在融合阶段执行参数校验;只有当算子确实需要"按参数内容决定是否支持"时,才需要显式打开该开关。
函数原型
OpAICoreConfig &NeedCheckSupportFlag(bool flag)
该接口属于 OpAICoreConfig 的链式配置方法,返回 OpAICoreConfig 引用,因此可以与其他配置项连续调用,例如:
OpAICoreConfig aicConfig;
aicConfig.DynamicCompileStaticFlag(true)
.DynamicFormatFlag(true)
.DynamicRankSupportFlag(true)
.DynamicShapeSupportFlag(true)
.NeedCheckSupportFlag(true)
.PrecisionReduceFlag(true);
参数说明
| 参数 | 输入/输出 | 说明 |
|---|---|---|
flag |
输入 | 标识是否在算子融合阶段调用算子参数校验函数进行 data type 与 shape 的校验。取 true 时启用校验,取 false 时关闭校验(默认)。 |
返回值说明
返回 OpAICoreConfig 类引用,用于继续链式配置其他项。关于 OpAICoreConfig 的完整接口清单,可参考 OpAICoreConfig,它涵盖了 Input、Output、DynamicCompileStaticFlag、DynamicFormatFlag、DynamicRankSupportFlag、DynamicShapeSupportFlag、NeedCheckSupportFlag、PrecisionReduceFlag、ExtendCfgInfo 及 operator= 等配置项。
约束说明
该接口本身无额外约束。
配套机制:通过 SetCheckSupport 注册参数校验函数
NeedCheckSupportFlag(true) 只是"开关",真正的校验逻辑由 SetCheckSupport 注册的校验函数提供,两者必须搭配使用:
- 若需在算子融合阶段进行算子参数校验,先实现算子参数校验回调函数,并通过
SetCheckSupport注册; - 同时将
NeedCheckSupportFlag配置为true,算子编译和融合阶段才会调用注册的校验函数; - 若校验函数校验通过,表示 AI Core 支持该算子参数,框架会选择 AI Core 上的相应算子执行;否则会继续查询 AI CPU 算子库并执行(即回落 / fallback 机制)。
校验函数类型定义
SetCheckSupport 的函数原型为:
OpAICoreDef &SetCheckSupport(optiling::OP_CHECK_FUNC func)
其中 OP_CHECK_FUNC 定义为:
using OP_CHECK_FUNC = ge::graphStatus (*)(const ge::Operator &op, ge::AscendString &result);
- 入参:
const ge::Operator &op,算子的描述信息,包括算子的输入、输出、属性等。 - 出参:
ge::AscendString &result,包含校验返回码和原因的字符串,格式如下:
{"ret_code": "1","reason": "your reason"}
- 校验成功时函数返回
ge::GRAPH_SUCCESS;校验失败时返回ge::GRAPH_FAILED。
调用示例:自定义 Add 算子的完整配置
以下示例完整展示了"实现校验函数 + 注册 + 打开开关"三个步骤(出自 SetCheckSupport 调用示例)。
第一步:实现参数校验函数。 本例对第一个输入参数 x 的 shape 进行校验,仅支持第一个维度为 8 的场景:
static ge::graphStatus CheckSupported(const ge::Operator &op, ge::AscendString &result)
{
std::string resultJsonStr;
// 仅支持第一个输入参数shape的第一个维度为8,其他shape不支持
if (op.GetInputDesc(0).GetShape().GetDim(0) == 8) {
resultJsonStr = R"({"ret_code": "1","reason": "x.dim[0] is 8"})";
result = ge::AscendString(resultJsonStr.c_str());
return ge::GRAPH_SUCCESS;
}
resultJsonStr = R"({"ret_code": "0","reason": "xxx"})";
result = ge::AscendString(resultJsonStr.c_str());
return ge::GRAPH_FAILED;
}
第二步:在算子原型中注册校验函数并打开开关。 在 AddCustom : public OpDef 构造函数中,通过 AICore().SetCheckSupport(...) 注册校验回调,再通过 OpAICoreConfig 链式配置 NeedCheckSupportFlag(true),最后用 AddConfig 绑定到具体的 AI 处理器型号:
class AddCustom : public OpDef {
public:
AddCustom(const char* name) : OpDef(name)
{
this->Input("x")
.ParamType(REQUIRED);
this->Input("y")
.ParamType(REQUIRED);
this->Output("z")
.ParamType(REQUIRED);
this->SetInferShape(ge::InferShape);
this->AICore()
.SetTiling(optiling::TilingFunc)
.SetTilingParse(optiling::TilingPrepare)
.SetOpSelectFormat(optiling::OpSelectFormat)
.SetCheckSupport(optiling::CheckSupported);
OpAICoreConfig aicConfig;
aicConfig.DynamicCompileStaticFlag(true)
.DynamicFormatFlag(true)
.DynamicRankSupportFlag(true)
.DynamicShapeSupportFlag(true)
.NeedCheckSupportFlag(true)
.PrecisionReduceFlag(true);
// 注意:soc_version请替换成实际的AI处理器型号
this->AICore().AddConfig("soc_version", aicConfig);
}
};
关于算子原型定义的更多背景(OpDef 类的定义位置、Input/Output/Attr 声明、OP_ADD 注册方式),可阅读仓库指南 算子原型定义。
典型使用场景:AI Core / AI CPU 执行路径选择
NeedCheckSupportFlag 的价值体现在融合阶段的"能力探测"流程中。当一个算子同时存在 AI Core 实现和 AI CPU(或 Host CPU)实现时,框架需要在融合阶段确认当前算子参数是否真的能被 AI Core 支持:
- 融合阶段框架调用
CheckSupported校验函数; - 校验通过(返回
ge::GRAPH_SUCCESS,ret_code为"1")→ 选择 AI Core 算子执行; - 校验失败(返回
ge::GRAPH_FAILED)→ 继续查询 AI CPU 算子库并执行。
这种机制使得同一算子可以在不同输入 shape/dtype 下灵活切换执行后端,是融合图场景下保证算子正确性与性能的重要保障。
与其他配置方式的协作与优先级
NeedCheckSupportFlag 作为 OpAICoreConfig 的组成项,可以随配置对象通过两种方式挂载到算子原型上:
- 方式一:在算子原型构造函数中创建
OpAICoreConfig,并通过AICore().AddConfig(soc, aicConfig)注册(见上文示例); - 方式二:在独立文件中通过 REGISTER_OP_AICORE_CONFIG 宏注册差异化配置,便于按芯片或模块拆分维护:
#include "register/op_config_registry.h"
namespace ops {
REGISTER_OP_AICORE_CONFIG(AddCustom, ascendxxx2, []() {
ops::OpAICoreConfig config("ascendxxx2");
return config;
});
}
优先级约束:若算子同时使用 AddConfig 注册算子支持的 AI 处理器型号及 OpAICoreConfig 信息,且 AI 处理器型号相同时,通过 AddConfig 方式注册的配置优先级更高,会覆盖 REGISTER_OP_AICORE_CONFIG 宏注册的 OpAICoreConfig 信息(参见 REGISTER_OP_AICORE_CONFIG 约束说明 与 AddConfig)。
此外还需注意:
OpAICoreConfig构造函数默认不初始化这些配置项(无参构造),而传入soc的构造函数会将NeedCheckSupportFlag初始化为false(参见 OpAICoreConfig 构造函数);- 当
AICore().AddConfig("soc")不传aicore_config时,NeedCheckSupportFlag同样取默认值false(参见 AddConfig 默认配置表); AddConfig的soc参数填写规则参考算子工程目录下编译配置项文件CMakePresets.json中的ASCEND_COMPUTE_UNIT字段,该字段取值在使用 msOpGen 创建工程时自动生成。
总结
NeedCheckSupportFlag 是 asc-devkit 算子原型注册体系中控制"融合阶段参数校验"的关键开关,与 SetCheckSupport 注册的 OP_CHECK_FUNC 校验回调构成完整的能力探测链路。正确理解其默认值(false)、true/false 语义、链式调用方式以及与 AddConfig / REGISTER_OP_AICORE_CONFIG 的优先级关系,能够帮助算子开发者准确设计多后端(AI Core / AI CPU)算子的执行路径选择逻辑,避免因漏开开关导致融合阶段校验缺失,或因校验函数未注册导致开关形同虚设。相关接口的完整文档可继续查阅 原型注册与管理 下的 OpAICoreConfig 与 OpAICoreDef 章节。