* 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_log.cpp
* \brief
*/
#include <iostream>
#include <cstdlib>
#include <unistd.h>
#include "passes/pass_log/pass_log.h"
#include "interface/configs/config_manager.h"
#include "interface/program/program.h"
#include "interface/utils/file_utils.h"
#include "utils/host_log/log_manager.h"
#undef MODULE_NAME
#define MODULE_NAME "PassLog"
namespace npu::tile_fwk {
namespace {
const char* kExtractPassLogScriptName = "extract_pass_log.py";
const char* kExtractPassLogScriptInSource = "tools/scripts/extract_pass_log.py";
bool IsFileAccessible(const std::string& path) { return !path.empty() && access(path.c_str(), F_OK) == 0; }
std::string ResolveExtractPassLogScriptPath()
{
const std::string installedScriptPath = GetCurrentSharedLibPath() + "/scripts/" + kExtractPassLogScriptName;
if (IsFileAccessible(installedScriptPath)) {
return installedScriptPath;
}
if (IsFileAccessible(kExtractPassLogScriptInSource)) {
return std::string(kExtractPassLogScriptInSource);
}
return "";
}
}
std::string EscapeShellArg(const std::string& arg)
{
std::string escaped = "'";
for (char c : arg) {
if (c == '\'') {
escaped += "'\\''";
} else {
escaped += c;
}
}
escaped += "'";
return escaped;
}
std::string GetFormatBacktrace(const Operation& op)
{
auto span = op.GetSpan();
if (!span.IsUnknown()) {
return "";
}
std::ostringstream oss;
oss << "[FuncMagic:" << op.BelongTo()->GetFuncMagic() << "]"
<< "[OpMagic:" << op.opmagic << "].";
return oss.str();
}
std::string GetFormatBacktrace(const OperationPtr& op)
{
if (!op) {
return "";
}
return GetFormatBacktrace(*op);
}
std::string GetFormatBacktrace(const Operation* op)
{
if (!op) {
return "";
}
return GetFormatBacktrace(*op);
}
void LogPassRuntime(
const std::string& identifier, Program& program, Function& function,
const std::chrono::time_point<std::chrono::high_resolution_clock>& start)
{
auto end = std::chrono::high_resolution_clock::now();
auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start);
APASS_LOG_INFO_F(
Elements::Function, "The Runtime of pass %s for program %s function %s is %ld us.", identifier.c_str(),
program.Name().c_str(), function.GetMagicName().c_str(), duration.count());
}
void ExtractPassLogByFunction(const Function& function)
{
const std::string scriptPath = ResolveExtractPassLogScriptPath();
if (scriptPath.empty()) {
APASS_LOG_WARN_F(
Elements::Function, "%s not found under install(%s/scripts), or source(%s).", kExtractPassLogScriptName,
GetCurrentSharedLibPath().c_str(), kExtractPassLogScriptInSource);
return;
}
const std::string hostLogDir = LogManager::Instance().GetHostLogDir();
const std::string logPattern = hostLogDir + "/pypto-log-" + std::to_string(getpid()) + "_*.log";
const std::string functionName = function.GetMagicName();
const std::string outputDir = config::LogTopFolder();
const std::string command = "python3 " + EscapeShellArg(scriptPath) + " " + EscapeShellArg(logPattern) + " -f " +
EscapeShellArg(functionName) + " -o " + EscapeShellArg(outputDir) + " --silentmode";
int ret = std::system(command.c_str());
if (ret != 0) {
APASS_LOG_WARN_F(Elements::Function, "extract_pass_log.py failed(ret=%d), command: %s.", ret, command.c_str());
}
}
PassLogUtil::PassLogUtil(Pass& pass, Function& function, size_t passIndex)
{
originLogOutPath_ = config::LogFile();
logFolder_ = pass.LogFolder(config::LogTopFolder(), passIndex);
logFilePath_ = logFolder_ + "/" + (pass.GetName() + function.GetMagicName() + ".log");
}
PassLogUtil::~PassLogUtil()
{
if (!logFolder_.empty()) {
auto files = GetFiles(logFolder_, "");
if (files.empty()) {
(void)DeleteDir(logFolder_);
}
}
}
}