* 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.
*/
* \file pass.cpp
* \brief
*/
#include "passes/pass_interface/pass.h"
#include <fstream>
#include "tilefwk/tilefwk.h"
#include "interface/program/program.h"
#include "interface/function/function.h"
#include "interface/utils/file_utils.h"
#include "passes/pass_log/pass_log.h"
#define MODULE_NAME "Pass"
static constexpr size_t PASS_NUM_DIGITS = 2;
namespace npu::tile_fwk {
Pass::Pass(std::string name) : name_(std::move(name)) {}
const std::string& Pass::LogFolder(const std::string& topFolder, size_t i) const
{
if (CreateLogFolder(topFolder, i) == FAILED) {
APASS_LOG_WARN_F(Elements::Function, "Create log folder failed.");
passFolder_ = topFolder;
}
return passFolder_;
}
Status Pass::CreateLogFolder(const std::string& topFolder, size_t i) const
{
if (!topFolder.empty()) {
passFolder_ = topFolder;
}
std::stringstream ss;
ss << std::setw(PASS_NUM_DIGITS) << std::setfill('0') << i;
passFolder_ = passFolder_ + "/Pass_" + ss.str() + "_" + name_;
bool res = CreateDir(passFolder_);
if (res == false) {
APASS_LOG_ERROR_F(Elements::Function, "Failed to create directory: [%s].", passFolder_.c_str());
return FAILED;
}
return SUCCESS;
}
void Pass::DoHealthCheckBefore(Function& function, const std::string& folderPath)
{
(void)function;
(void)folderPath;
return;
}
void Pass::DoHealthCheckAfter(Function& function, const std::string& folderPath)
{
(void)function;
(void)folderPath;
return;
}
Status Pass::Run(Function& function, const std::string& strategy, const std::string& identifier, size_t runtimeIdx)
{
identifier_ = identifier;
strategy_ = strategy;
passRuntimeIndex_ = runtimeIdx;
if (passDfxconfigs_.disablePass) {
APASS_LOG_WARN_F(Elements::Function, "Pass [%s] is skipped.", identifier_.c_str());
return SUCCESS;
}
if (PreRun(function) == FAILED) {
APASS_LOG_ERROR_F(Elements::Function, "PreRun pass [%s] failed.", identifier_.c_str());
return FAILED;
}
if (RunOnFunction(function) == FAILED) {
APASS_LOG_ERROR_F(Elements::Function, "Run pass [%s] failed.", identifier_.c_str());
return FAILED;
}
if (PostRun(function) == FAILED) {
APASS_LOG_ERROR_F(Elements::Function, "PostRun pass [%s] failed.", identifier_.c_str());
return FAILED;
}
identifier_.clear();
strategy_.clear();
return SUCCESS;
}
std::string Pass::GetDumpFilePrefix(Function& function, bool before, Function* subFunction, int subFuncId)
{
constexpr int printWide = 3;
constexpr int funcPrintWide = 2;
const auto& filePrefix = identifier_ + "_" + function.GetMagicName();
std::string stageName = before ? "Before" : "After";
std::stringstream ss;
ss << stageName << "_";
if (subFunction == nullptr) {
ss << std::setw(printWide) << std::setfill('0') << passRuntimeIndex_ << "_" << filePrefix;
return ss.str();
}
ss << std::setw(printWide) << std::setfill('0') << passRuntimeIndex_ << "_" << filePrefix << "_LEAF_program_id_"
<< std::setw(funcPrintWide) << std::setfill('0') << subFuncId << "_" << subFunction->GetFunctionHash().GetHash();
return ss.str();
}
Status Pass::PrintFunction(Function& function, const std::string& logFolder, bool beforeFunction = true)
{
std::string stageName = beforeFunction ? "Before" : "After";
APASS_LOG_INFO_F(Elements::Function, "Dump function %s pass [%s].", stageName.c_str(), identifier_.c_str());
if (function.rootFunc_ != nullptr) {
std::stringstream ssRoot;
ssRoot << GetDumpFilePrefix(function, beforeFunction) << "_Root_.tifwkgr";
std::ofstream file(logFolder + "/" + ssRoot.str());
if (file.is_open()) {
file << function.rootFunc_->Dump();
file.close();
}
std::stringstream ss;
for (auto& subProgram : function.rootFunc_->programs_) {
ss.str("");
ss << GetDumpFilePrefix(function, beforeFunction, subProgram.second, subProgram.first) << ".tifwkgr";
std::ofstream subFile(logFolder + "/" + ss.str());
if (subFile.is_open()) {
subFile << subProgram.second->Dump();
subFile.close();
}
}
}
{
std::stringstream ssInner;
ssInner << GetDumpFilePrefix(function, beforeFunction) << ".tifwkgr";
std::ofstream file(logFolder + "/" + ssInner.str());
if (file.is_open()) {
file << function.Dump();
file.close();
}
}
return SUCCESS;
}
Status Pass::DumpFunctionJson(Function& function, const std::string& logFolder, bool beforeFunction = true)
{
std::string stageName = beforeFunction ? "Before" : "After";
APASS_LOG_INFO_F(Elements::Function, "Dump function %s pass [%s].", stageName.c_str(), identifier_.c_str());
std::stringstream ss;
ss << GetDumpFilePrefix(function, beforeFunction) << ".json";
function.DumpJsonFile(logFolder + "/" + ss.str());
if (function.rootFunc_ != nullptr) {
ss.str("");
ss << GetDumpFilePrefix(function, beforeFunction) << "_ROOT.json";
function.rootFunc_->DumpJsonFile(logFolder + "/" + ss.str());
for (auto& subProgram : function.rootFunc_->programs_) {
ss.str("");
ss << GetDumpFilePrefix(function, beforeFunction, subProgram.second, subProgram.first) << ".json";
subProgram.second->DumpJsonFile(logFolder + "/" + ss.str());
}
}
return SUCCESS;
}
Status Pass::DumpGraphJson(Function& function, const std::string& fileName)
{
if (fileName.find("BlockGraph") == std::string::npos) {
function.DumpJsonFile(fileName + ".json");
return SUCCESS;
}
if (function.rootFunc_ != nullptr) {
for (auto& subProgram : function.rootFunc_->programs_) {
std::stringstream ss;
ss << fileName << "_" << subProgram.first << ".json";
subProgram.second->DumpJsonFile(ss.str());
}
}
return SUCCESS;
}
Status Pass::CreateGraphFolder(Function& function)
{
if (passDfxconfigs_.dumpGraph) {
graphFolder_ = config::LogTopFolder() + '/' + function.GetMagicName();
bool res = CreateDir(graphFolder_);
if (res == false) {
APASS_LOG_ERROR_F(Elements::Function, "Failed to create directory: [%s].", graphFolder_.c_str());
return FAILED;
}
}
return SUCCESS;
}
void Pass::handlePreRunDumpGraph(Function& function)
{
std::string fileName;
if (CreateGraphFolder(function) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Create graph directory failed.");
}
if (passDfxconfigs_.dumpGraph) {
if (name_ == "ExpandFunction") {
fileName = graphFolder_ + "/End_TensorGraph";
if (DumpGraphJson(function, fileName) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump End TensorGraph json failed.");
}
}
if (name_ == "RemoveRedundantReshape") {
fileName = graphFolder_ + "/Begin_TensorGraph";
if (DumpGraphJson(function, fileName) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump Begin TensorGraph json failed.");
}
}
}
if (passDfxconfigs_.dumpGraph) {
if (name_ == "SubgraphToFunction") {
fileName = graphFolder_ + "/End_TileGraph";
if (DumpGraphJson(function, fileName) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump End TileGraph json failed.");
}
}
}
if (passDfxconfigs_.dumpGraph) {
if (DumpFunctionJson(function, passFolder_, true) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump function json before pass failed.");
}
}
}
Status Pass::PreRun(Function& function)
{
std::string fileName;
if (passDfxconfigs_.printGraph) {
if (PrintFunction(function, passFolder_, true) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Print function before pass failed.");
}
}
handlePreRunDumpGraph(function);
if (DefaultEnabledPreCheck(function) != SUCCESS) {
APASS_LOG_ERROR_F(Elements::Function, "Precheck the necessary items of pass [%s] failed.", identifier_.c_str());
return FAILED;
}
if (passDfxconfigs_.preCheck) {
if (PreCheck(function) != SUCCESS) {
APASS_LOG_ERROR_F(Elements::Function, "Precheck of pass [%s] failed.", identifier_.c_str());
return FAILED;
}
}
if (passDfxconfigs_.healthCheck) {
DoHealthCheckBefore(function, passFolder_);
}
return SUCCESS;
}
Status Pass::PostRun(Function& function)
{
std::string fileName;
if (passDfxconfigs_.printGraph) {
if (PrintFunction(function, passFolder_, false) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Print function after pass failed.");
}
}
if (passDfxconfigs_.dumpGraph && name_ == "ExpandFunction") {
if (name_ == "ExpandFunction") {
fileName = graphFolder_ + "/Begin_TileGraph";
if (DumpGraphJson(function, fileName) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump Begin TileGraph json failed.");
}
}
}
if (passDfxconfigs_.dumpGraph) {
if (name_ == "SubgraphToFunction") {
fileName = graphFolder_ + "/Begin_BlockGraph";
if (DumpGraphJson(function, fileName) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump Begin BlockGraph json failed.");
}
}
if (name_ == "CodegenPreproc") {
fileName = graphFolder_ + "/End_BlockGraph";
if (DumpGraphJson(function, fileName) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump End BlockGraph json failed.");
}
}
}
if (passDfxconfigs_.dumpGraph) {
if (DumpFunctionJson(function, passFolder_, false) != SUCCESS) {
APASS_LOG_WARN_F(Elements::Function, "Dump function json after pass failed.");
}
}
if (DefaultEnabledPostCheck(function) != SUCCESS) {
APASS_LOG_ERROR_F(
Elements::Function, "Postcheck the necessary items of pass [%s] failed.", identifier_.c_str());
return FAILED;
}
if (passDfxconfigs_.postCheck) {
if (PostCheck(function) != SUCCESS) {
APASS_LOG_ERROR_F(Elements::Function, "Postcheck of pass [%s] failed.", identifier_.c_str());
return FAILED;
}
}
if (passDfxconfigs_.healthCheck) {
DoHealthCheckAfter(function, passFolder_);
}
return SUCCESS;
}
Status Pass::PreCheck(Function& function)
{
(void)function;
return SUCCESS;
}
Status Pass::PostCheck(Function& function)
{
(void)function;
return SUCCESS;
}
Status Pass::DefaultEnabledPreCheck(Function& function)
{
(void)function;
return SUCCESS;
}
Status Pass::DefaultEnabledPostCheck(Function& function)
{
(void)function;
return SUCCESS;
}
}
