Skip to content

[GlobalISel] Put legalizer rule debug behind a verbose option. #138277

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.

Sign up for GitHub

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 2 commits into from
May 17, 2025
Merged

[GlobalISel] Put legalizer rule debug behind a verbose option. #138277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
345440e
[GlobalISel] Put legalizer rule debug behind a verbose option.
davemgreen May 2, 2025
97592c5
Formatting and brackets
davemgreen May 6, 2025
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
69 changes: 47 additions & 22 deletions llvm/lib/CodeGen/GlobalISel/LegalizerInfo.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ cl::opt<bool> llvm::DisableGISelLegalityCheck(
cl::desc("Don't verify that MIR is fully legal between GlobalISel passes"),
cl::Hidden);

cl::opt<bool> VerboseVerifyLegalizerInfo(
"verbose-gisel-verify-legalizer-info",
cl::desc("Print more information to dbgs about GlobalISel legalizer rules "
"being verified"),
cl::Hidden);

raw_ostream &llvm::operator<<(raw_ostream &OS, LegalizeAction Action) {
switch (Action) {
case Legal:
Expand Down Expand Up @@ -211,20 +217,28 @@ LegalizeActionStep LegalizeRuleSet::apply(const LegalityQuery &Query) const {
bool LegalizeRuleSet::verifyTypeIdxsCoverage(unsigned NumTypeIdxs) const {
#ifndef NDEBUG
if (Rules.empty()) {
LLVM_DEBUG(
dbgs() << ".. type index coverage check SKIPPED: no rules defined\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. type index coverage check SKIPPED: "
<< "no rules defined\n");
}
return true;
}
const int64_t FirstUncovered = TypeIdxsCovered.find_first_unset();
if (FirstUncovered < 0) {
LLVM_DEBUG(dbgs() << ".. type index coverage check SKIPPED:"
" user-defined predicate detected\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. type index coverage check SKIPPED:"
" user-defined predicate detected\n");
}
return true;
}
const bool AllCovered = (FirstUncovered >= NumTypeIdxs);
if (NumTypeIdxs > 0)
LLVM_DEBUG(dbgs() << ".. the first uncovered type index: " << FirstUncovered
<< ", " << (AllCovered ? "OK" : "FAIL") << "\n");
if (NumTypeIdxs > 0) {
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. the first uncovered type index: "
<< FirstUncovered << ", "
<< (AllCovered ? "OK" : "FAIL") << "\n");
}
}
return AllCovered;
#else
return true;
Expand All @@ -234,19 +248,25 @@ bool LegalizeRuleSet::verifyTypeIdxsCoverage(unsigned NumTypeIdxs) const {
bool LegalizeRuleSet::verifyImmIdxsCoverage(unsigned NumImmIdxs) const {
#ifndef NDEBUG
if (Rules.empty()) {
LLVM_DEBUG(
dbgs() << ".. imm index coverage check SKIPPED: no rules defined\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. imm index coverage check SKIPPED: "
<< "no rules defined\n");
}
return true;
}
const int64_t FirstUncovered = ImmIdxsCovered.find_first_unset();
if (FirstUncovered < 0) {
LLVM_DEBUG(dbgs() << ".. imm index coverage check SKIPPED:"
" user-defined predicate detected\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. imm index coverage check SKIPPED:"
" user-defined predicate detected\n");
}
return true;
}
const bool AllCovered = (FirstUncovered >= NumImmIdxs);
LLVM_DEBUG(dbgs() << ".. the first uncovered imm index: " << FirstUncovered
<< ", " << (AllCovered ? "OK" : "FAIL") << "\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. the first uncovered imm index: " << FirstUncovered
<< ", " << (AllCovered ? "OK" : "FAIL") << "\n");
}
return AllCovered;
#else
return true;
Expand Down Expand Up @@ -274,8 +294,10 @@ unsigned LegalizerInfo::getOpcodeIdxForOpcode(unsigned Opcode) const {
unsigned LegalizerInfo::getActionDefinitionsIdx(unsigned Opcode) const {
unsigned OpcodeIdx = getOpcodeIdxForOpcode(Opcode);
if (unsigned Alias = RulesForOpcode[OpcodeIdx].getAlias()) {
LLVM_DEBUG(dbgs() << ".. opcode " << Opcode << " is aliased to " << Alias
<< "\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << ".. opcode " << Opcode << " is aliased to " << Alias
<< "\n");
}
OpcodeIdx = getOpcodeIdxForOpcode(Alias);
assert(RulesForOpcode[OpcodeIdx].getAlias() == 0 && "Cannot chain aliases");
}
Expand Down Expand Up @@ -396,11 +418,13 @@ void LegalizerInfo::verify(const MCInstrInfo &MII) const {
? std::max(OpInfo.getGenericImmIndex() + 1U, Acc)
: Acc;
});
LLVM_DEBUG(dbgs() << MII.getName(Opcode) << " (opcode " << Opcode
<< "): " << NumTypeIdxs << " type ind"
<< (NumTypeIdxs == 1 ? "ex" : "ices") << ", "
<< NumImmIdxs << " imm ind"
<< (NumImmIdxs == 1 ? "ex" : "ices") << "\n");
if (VerboseVerifyLegalizerInfo) {
LLVM_DEBUG(dbgs() << MII.getName(Opcode) << " (opcode " << Opcode
<< "): " << NumTypeIdxs << " type ind"
<< (NumTypeIdxs == 1 ? "ex" : "ices") << ", "
<< NumImmIdxs << " imm ind"
<< (NumImmIdxs == 1 ? "ex" : "ices") << "\n");
}
const LegalizeRuleSet &RuleSet = getActionDefinitions(Opcode);
if (!RuleSet.verifyTypeIdxsCoverage(NumTypeIdxs))
FailedOpcodes.push_back(Opcode);
Expand All @@ -413,8 +437,9 @@ void LegalizerInfo::verify(const MCInstrInfo &MII) const {
errs() << " " << MII.getName(Opcode);
errs() << "\n";

report_fatal_error("ill-defined LegalizerInfo"
", try -debug-only=legalizer-info for details");
report_fatal_error("ill-defined LegalizerInfo, try "
"-debug-only=legalizer-info and "
"-verbose-gisel-verify-legalizer-info for details");
}
#endif
}
Expand Down
2 changes: 1 addition & 1 deletion llvm/test/CodeGen/AArch64/GlobalISel/legalizer-info-validation.mir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# RUN: llc -mtriple=aarch64-- -run-pass=legalizer %s \
# RUN: -mcpu=cortex-a75 -o - 2>&1 | FileCheck %s --check-prefixes=CHECK

# RUN: llc -mtriple=aarch64-- -run-pass=legalizer %s -debug-only=legalizer-info \
# RUN: llc -mtriple=aarch64-- -run-pass=legalizer %s -debug-only=legalizer-info -verbose-gisel-verify-legalizer-info \
# RUN: -mcpu=cortex-a75 -o - 2>&1 | FileCheck %s --check-prefixes=CHECK,DEBUG

# REQUIRES: asserts
Expand Down
4 changes: 2 additions & 2 deletions llvm/test/CodeGen/RISCV/GlobalISel/legalizer-info-validation.mir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
# RUN: llc -mtriple=riscv64-- -run-pass=legalizer %s \
# RUN: -mattr=+m,+zbb,+zfh,+v -o - 2>&1 | FileCheck %s --check-prefixes=CHECK

# RUN: llc -mtriple=riscv32-- -run-pass=legalizer %s -debug-only=legalizer-info \
# RUN: llc -mtriple=riscv32-- -run-pass=legalizer %s -debug-only=legalizer-info -verbose-gisel-verify-legalizer-info \
# RUN: -mattr=+m,+zbb,+zfh,+v -o - 2>&1 | FileCheck %s --check-prefixes=CHECK,DEBUG,DEBUG-RV32
# RUN: llc -mtriple=riscv64-- -run-pass=legalizer %s -debug-only=legalizer-info \
# RUN: llc -mtriple=riscv64-- -run-pass=legalizer %s -debug-only=legalizer-info -verbose-gisel-verify-legalizer-info \
# RUN: -mattr=+m,+zbb,+zfh,+v -o - 2>&1 | FileCheck %s --check-prefixes=CHECK,DEBUG,DEBUG-RV64

# REQUIRES: asserts
Expand Down