* Copyright (c) 2025 Huawei Technologies Co., Ltd.
* This program is free software, you can redistribute it and/or modify it under the terms and conditions of
* CANN Open Software License Agreement Version 2.0 (the "License").
* Please refer to the License for details. You may not use this file except in compliance with the License.
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
* See LICENSE in the root of the software repository for the full text of the License.
*/
#include "graph/passes/control_flow_and_stream/cond_pass.h"
#include "framework/common/op/ge_op_utils.h"
#include "graph/utils/graph_utils.h"
#include "graph/utils/type_utils.h"
#include "graph/utils/node_utils.h"
#include "common/checker.h"
namespace ge {
namespace {
const char *const kStringLength = "StringLength";
constexpr int32_t kCondSubgraphIndex = 0;
}
Status CondPass::Run(NodePtr &node) {
ComputeGraphPtr graph = nullptr;
OutDataAnchorPtr peer_out_anchor = nullptr;
InDataAnchorPtr cond_in_anchor = nullptr;
Status ret = GetCondInfo(node, graph, peer_out_anchor, cond_in_anchor);
if (ret == NOT_CHANGED) {
return SUCCESS;
} else if (ret != SUCCESS) {
GELOGE(FAILED, "[Get][CondInfo] for node %s failed.", node->GetName().c_str());
return FAILED;
}
OpDescPtr op_desc = cond_in_anchor->GetOwnerNode()->GetOpDesc();
GE_CHECK_NOTNULL(op_desc);
GELOGI("Handle cond for node %s.", op_desc->GetName().c_str());
const auto &cond_tensor_ptr = op_desc->MutableInputDesc(cond_in_anchor->GetIdx());
GE_CHECK_NOTNULL(cond_tensor_ptr);
GeTensorDesc &cond_tensor = *cond_tensor_ptr;
if (cond_tensor.MutableShape().GetDim(0) == UNKNOWN_DIM_NUM) {
GELOGI("Output tensor rank of Cond is unknown.");
if (cond_tensor.GetDataType() == DT_STRING) {
GE_CHK_STATUS_RET(HandleStringCond(peer_out_anchor, cond_in_anchor),
"[Handle][StringCond] for op:%s failed.", op_desc->GetName().c_str());
}
return SUCCESS;
}
if (!cond_tensor.GetShape().IsScalar()) {
GE_CHK_STATUS_RET(HandleNonScalarCond(peer_out_anchor, cond_in_anchor),
"[Handle][NonScalarCond] for op:%s failed.", op_desc->GetName().c_str());
} else {
switch (cond_tensor.GetDataType()) {
case DT_STRING:
GE_CHK_STATUS_RET(HandleStringCond(peer_out_anchor, cond_in_anchor),
"[Handle][StringCond] for op:%s failed.", op_desc->GetName().c_str());
break;
case DT_BOOL:
case DT_FLOAT:
case DT_DOUBLE:
case DT_UINT8:
case DT_INT16:
case DT_INT8:
case DT_INT64:
GE_CHK_STATUS_RET(HandleScalarCond(peer_out_anchor, cond_in_anchor, cond_tensor.GetDataType()),
"[Handle][ScalarCond] for op:%s failed.", op_desc->GetName().c_str());
break;
case DT_INT32:
break;
default:
REPORT_INNER_ERR_MSG("E19999",
"data_type:%d of index:%d input tensor in op:%s(%s) check invalid",
cond_tensor.GetDataType(), cond_in_anchor->GetIdx(),
op_desc->GetName().c_str(), op_desc->GetType().c_str());
GELOGE(FAILED, "[Check][Param] data_type:%d of index:%d input tensor in op:%s(%s) is invalid",
cond_tensor.GetDataType(), cond_in_anchor->GetIdx(),
op_desc->GetName().c_str(), op_desc->GetType().c_str());
return FAILED;
}
}
cond_tensor.SetDataType(DT_INT32);
cond_tensor.SetOriginDataType(DT_INT32);
cond_tensor.SetShape(GeShape());
cond_tensor.SetOriginShape(GeShape());
return SUCCESS;
}
Status CondPass::GetCondInfo(const NodePtr &node, ComputeGraphPtr &graph, OutDataAnchorPtr &peer_out_anchor,
InDataAnchorPtr &cond_in_anchor) const {
GE_CHECK_NOTNULL(node);
std::string type = node->GetType();
if (kIfOpTypes.count(type) != 0) {
if (GetCondInfoForIf(node, graph, peer_out_anchor, cond_in_anchor) != SUCCESS) {
GELOGE(FAILED, "[Get][CondInfo] for if node:%s failed.", node->GetName().c_str());
return FAILED;
}
} else if (kWhileOpTypes.count(type) != 0) {
if (GetCondInfoForWhile(node, graph, peer_out_anchor, cond_in_anchor) != SUCCESS) {
GELOGE(FAILED, "[Get][CondInfo] for while node:%s failed.", node->GetName().c_str());
return FAILED;
}
} else {
return NOT_CHANGED;
}
return SUCCESS;
}
Status CondPass::GetCondInfoForIf(const NodePtr &node, ComputeGraphPtr &graph, OutDataAnchorPtr &peer_out_anchor,
InDataAnchorPtr &cond_in_anchor) const {
graph = node->GetOwnerComputeGraph();
GE_CHECK_NOTNULL(graph);
cond_in_anchor = node->GetInDataAnchor(IF_COND_INPUT);
GE_CHECK_NOTNULL(cond_in_anchor);
peer_out_anchor = cond_in_anchor->GetPeerOutAnchor();
GE_CHECK_NOTNULL(peer_out_anchor);
return SUCCESS;
}
Status CondPass::GetCondInfoForWhile(const NodePtr &node, ComputeGraphPtr &graph, OutDataAnchorPtr &peer_out_anchor,
InDataAnchorPtr &cond_in_anchor) const {
OpDescPtr op_desc = node->GetOpDesc();
GE_CHECK_NOTNULL(op_desc);
std::string cond_graph_instance_name = op_desc->GetSubgraphInstanceName(kCondSubgraphIndex);
GE_ASSERT_TRUE(!cond_graph_instance_name.empty(), "[Get][SubgraphName] is empty, node:%s.", node->GetNamePtr());
graph = GraphUtils::FindRootGraph(node->GetOwnerComputeGraph())->GetSubgraph(cond_graph_instance_name);
GE_CHECK_NOTNULL(graph);
NodePtr net_output_node = graph->FindFirstNodeMatchType(NETOUTPUT);
GE_CHECK_NOTNULL(net_output_node);
uint32_t output_num = net_output_node->GetAllInDataAnchorsSize();
if (output_num != 1) {
REPORT_INNER_ERR_MSG("E19999", "Input data anchor num:%u of op:%s(%s) not equal to 1, check invalid",
output_num, op_desc->GetName().c_str(), op_desc->GetType().c_str());
GELOGE(FAILED, "[Check][Param] output size of cond_graph is invalid, expect 1 but %u exactly, while_node:%s.",
output_num, node->GetName().c_str());
return FAILED;
}
cond_in_anchor = net_output_node->GetInDataAnchor(0);
GE_CHECK_NOTNULL(cond_in_anchor);
peer_out_anchor = cond_in_anchor->GetPeerOutAnchor();
GE_CHECK_NOTNULL(peer_out_anchor);
return SUCCESS;
}
Status CondPass::HandleNonScalarCond(const OutDataAnchorPtr &peer_out_anchor,
const InDataAnchorPtr &cond_in_anchor) {
GELOGI("Handle cond with non-scalar cond-input.");
return InsertNode(peer_out_anchor, cond_in_anchor, SIZE);
}
Status CondPass::HandleStringCond(const OutDataAnchorPtr &peer_out_anchor,
const InDataAnchorPtr &cond_in_anchor) {
GELOGI("Handle cond with scalar-string cond-input.");
return InsertNode(peer_out_anchor, cond_in_anchor, kStringLength);
}
Status CondPass::HandleScalarCond(const OutDataAnchorPtr &peer_out_anchor,
const InDataAnchorPtr &cond_in_anchor, DataType src_type) {
GE_CHECK_NOTNULL(cond_in_anchor);
GE_CHECK_NOTNULL(peer_out_anchor);
GE_CHECK_NOTNULL(peer_out_anchor->GetOwnerNode()->GetOpDesc());
GELOGI("Handle cond with scalar cond-input.");
GeTensorDesc tensor = peer_out_anchor->GetOwnerNode()->GetOpDesc()->GetOutputDesc(peer_out_anchor->GetIdx());
std::string cast_name = cond_in_anchor->GetOwnerNode()->GetName() + "_Cast";
OpDescPtr cast_op = AddCastOpDesc(cast_name, tensor, src_type, DT_INT32);
if (cast_op == nullptr) {
GELOGE(FAILED, "[Add][CastNode] failed, name:%s.", cast_name.c_str());
return FAILED;
}
const auto cast_node = GraphUtils::InsertNodeAfter(peer_out_anchor, {cond_in_anchor}, cast_op);
GE_ASSERT_NOTNULL(cast_node);
AddRePassNode(cast_node);
return SUCCESS;
}
Status CondPass::InsertNode(const OutDataAnchorPtr &peer_out_anchor,
const InDataAnchorPtr &in_data_anchor, const std::string &type) {
GE_CHECK_NOTNULL(peer_out_anchor);
GE_CHECK_NOTNULL(in_data_anchor);
GELOGD("Begin to insert %s node.", type.c_str());
GE_CHECK_NOTNULL(peer_out_anchor->GetOwnerNode()->GetOpDesc());
GE_CHECK_NOTNULL(in_data_anchor->GetOwnerNode()->GetOpDesc());
GeTensorDesc in_tensor = peer_out_anchor->GetOwnerNode()->GetOpDesc()->GetOutputDesc(peer_out_anchor->GetIdx());
GeTensorDesc out_tensor = in_data_anchor->GetOwnerNode()->GetOpDesc()->GetInputDesc(in_data_anchor->GetIdx());
out_tensor.SetDataType(DT_INT32);
out_tensor.SetOriginDataType(DT_INT32);
out_tensor.SetShape(in_tensor.GetShape());
out_tensor.SetOriginShape(in_tensor.GetOriginShape());
OpDescBuilder op_desc_builder(in_data_anchor->GetOwnerNode()->GetName() + "_" + type, type);
OpDescPtr op_desc = op_desc_builder.AddInput("x", in_tensor).AddOutput("y", out_tensor).Build();
if (op_desc == nullptr) {
REPORT_INNER_ERR_MSG("E19999", "Create op_desc:%s(%s) failed",
(in_data_anchor->GetOwnerNode()->GetName() + "_" + type).c_str(), type.c_str());
GELOGE(FAILED, "[Create][OpDesc] %s(%s) failed.",
(in_data_anchor->GetOwnerNode()->GetName() + "_" + type).c_str(), type.c_str());
return FAILED;
}
NodePtr new_node = GraphUtils::InsertNodeAfter(peer_out_anchor, {in_data_anchor}, op_desc);
GE_ASSERT_NOTNULL(new_node);
AddRePassNode(new_node);
return SUCCESS;
}
OpDescPtr CondPass::AddCastOpDesc(const std::string &name, const GeTensorDesc &tensor,
DataType src, DataType dst) const {
GELOGI("Begin to create cast op: %s, from %d to %d", name.c_str(), src, dst);
GeTensorDesc in_tensor = tensor;
in_tensor.SetDataType(src);
in_tensor.SetOriginDataType(src);
GeTensorDesc out_tensor = tensor;
out_tensor.SetDataType(dst);
out_tensor.SetOriginDataType(dst);
OpDescBuilder op_desc_builder(name, CAST);
OpDescPtr cast_desc = op_desc_builder.AddInput("x", in_tensor).AddOutput("y", out_tensor).Build();
if (cast_desc == nullptr) {
REPORT_INNER_ERR_MSG("E19999", "Create op_desc:%s(%s) failed", name.c_str(), CAST);
GELOGE(FAILED, "[Create][OpDesc] failed, name:%s(%s).", name.c_str(), CAST);
return nullptr;
}
if (!(AttrUtils::SetInt(cast_desc, CAST_ATTR_SRCT, src) &&
AttrUtils::SetInt(cast_desc, CAST_ATTR_DSTT, dst) &&
AttrUtils::SetInt(cast_desc, CAST_ATTR_DST_TYPE, dst) &&
AttrUtils::SetBool(cast_desc, CAST_ATTR_TRUNCATE, false))) {
REPORT_INNER_ERR_MSG("E19999", "Set Attr:%s, %s, %s, %s to node:%s(%s) not all success",
CAST_ATTR_SRCT.c_str(), CAST_ATTR_DSTT.c_str(),
CAST_ATTR_DST_TYPE.c_str(), CAST_ATTR_TRUNCATE.c_str(),
cast_desc->GetName().c_str(), cast_desc->GetType().c_str());
GELOGE(FAILED, "[Set][Attr] %s, %s, %s, %s to node:%s(%s) not all success",
CAST_ATTR_SRCT.c_str(), CAST_ATTR_DSTT.c_str(),
CAST_ATTR_DST_TYPE.c_str(), CAST_ATTR_TRUNCATE.c_str(),
cast_desc->GetName().c_str(), cast_desc->GetType().c_str());
return nullptr;
}
return cast_desc;
}
REG_PASS_OPTION("CondPass").LEVELS(OoLevel::kO0);
}