Skip to content

Add an option -sil-break-before-pass-count #72274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion include/swift/SILOptimizer/PassManager/PassManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ class SILPassManager {

unsigned maxNumPassesToRun = UINT_MAX;
unsigned maxNumSubpassesToRun = UINT_MAX;
unsigned breakBeforePassCount = UINT_MAX;

/// For invoking Swift passes.
SwiftPassInvocation swiftPassInvocation;
Expand Down Expand Up @@ -428,7 +429,8 @@ class SILPassManager {
void runSwiftModuleVerification();

private:
void parsePassCount(StringRef countsStr);
void parsePassesToRunCount(StringRef countsStr);
void parseBreakBeforePassCount(StringRef countsStr);

bool doPrintBefore(SILTransform *T, SILFunction *F);

Expand Down Expand Up @@ -461,6 +463,9 @@ class SILPassManager {
/// options) whether we should continue running passes.
bool continueTransforming();

/// Break before running a pass.
bool breakBeforeRunning(StringRef fnName, SILFunctionTransform *SFT);

/// Return true if all analyses are unlocked.
bool analysesUnlocked();

Expand Down
44 changes: 34 additions & 10 deletions lib/SILOptimizer/PassManager/PassManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ llvm::cl::opt<std::string> SILBreakOnPass(
"sil-break-on-pass", llvm::cl::init(""),
llvm::cl::desc("Break before running a particular function pass"));

llvm::cl::opt<std::string>
SILBreakBeforePassCount("sil-break-before-pass-count", llvm::cl::init(""),
llvm::cl::desc("Break before running pass number"));

llvm::cl::list<std::string>
SILPrintFunction("sil-print-function", llvm::cl::CommaSeparated,
llvm::cl::desc("Only print out the sil for this function"));
Expand Down Expand Up @@ -403,7 +407,7 @@ SILPassManager::SILPassManager(SILModule *M, bool isMandatory,
#include "swift/SILOptimizer/Analysis/Analysis.def"

if (!SILNumOptPassesToRun.empty()) {
parsePassCount(SILNumOptPassesToRun);
parsePassesToRunCount(SILNumOptPassesToRun);
} else if (!SILPassCountConfigFile.empty()) {
StringRef moduleName = M->getSwiftModule()->getName().str();
std::fstream fs(SILPassCountConfigFile);
Expand All @@ -417,13 +421,17 @@ SILPassManager::SILPassManager(SILModule *M, bool isMandatory,
StringRef modName = pair.first;
StringRef countsStr = pair.second;
if (modName == moduleName) {
parsePassCount(countsStr);
parsePassesToRunCount(countsStr);
break;
}
}
fs.close();
}

if (!SILBreakBeforePassCount.empty()) {
parseBreakBeforePassCount(SILBreakBeforePassCount);
}

for (SILAnalysis *A : Analyses) {
A->initialize(this);
}
Expand All @@ -434,7 +442,7 @@ SILPassManager::SILPassManager(SILModule *M, bool isMandatory,
M->registerDeserializationNotificationHandler(std::move(handler));
}

void SILPassManager::parsePassCount(StringRef countsStr) {
void SILPassManager::parsePassesToRunCount(StringRef countsStr) {
bool validFormat = true;
if (countsStr.consumeInteger(10, maxNumPassesToRun))
validFormat = false;
Expand All @@ -449,6 +457,17 @@ void SILPassManager::parsePassCount(StringRef countsStr) {
}
}

void SILPassManager::parseBreakBeforePassCount(StringRef countsStr) {
bool validFormat = true;
if (countsStr.consumeInteger(10, breakBeforePassCount))
validFormat = false;
if (!validFormat || !countsStr.empty()) {
llvm::errs()
<< "error: wrong format of -sil-break-before-pass-count option\n";
exit(1);
}
}

bool SILPassManager::continueTransforming() {
if (isMandatory)
return true;
Expand Down Expand Up @@ -486,19 +505,24 @@ bool SILPassManager::analysesUnlocked() {
// Test the function and pass names we're given against the debug
// options that force us to break prior to a given pass and/or on a
// given function.
static bool breakBeforeRunning(StringRef fnName, SILFunctionTransform *SFT) {
if (SILBreakOnFun.empty() && SILBreakOnPass.empty())
bool SILPassManager::breakBeforeRunning(StringRef fnName,
SILFunctionTransform *SFT) {
if (SILBreakOnFun.empty() && SILBreakOnPass.empty() &&
SILBreakBeforePassCount.empty())
return false;

if (SILBreakOnFun.empty()
&& (SFT->getID() == SILBreakOnPass || SFT->getTag() == SILBreakOnPass))
if (!SILBreakOnPass.empty() &&
(SFT->getID() == SILBreakOnPass || SFT->getTag() == SILBreakOnPass))
return true;

if (SILBreakOnPass.empty() && fnName == SILBreakOnFun)
if (!SILBreakOnFun.empty() && fnName == SILBreakOnFun)
return true;

return fnName == SILBreakOnFun
&& (SFT->getID() == SILBreakOnPass || SFT->getTag() == SILBreakOnPass);
if (!SILBreakBeforePassCount.empty() &&
breakBeforePassCount == NumPassesRun) {
return true;
}
return false;
}

void SILPassManager::dumpPassInfo(const char *Title, SILTransform *Tr,
Expand Down