Skip to content

JIT: Add a pass to remove unused primary IVs #105107

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 1 commit into from
Jul 19, 2024
+178 −105
Merged

JIT: Add a pass to remove unused primary IVs #105107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions src/coreclr/jit/compiler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7648,6 +7648,8 @@ class Compiler
LoopLocalOccurrences* loopLocals);
bool optCanAndShouldChangeExitTest(GenTree* cond, bool dump);
bool optPrimaryIVHasNonLoopUses(unsigned lclNum, FlowGraphNaturalLoop* loop, LoopLocalOccurrences* loopLocals);

bool optWidenIVs(ScalarEvolutionContext& scevContext, FlowGraphNaturalLoop* loop, LoopLocalOccurrences* loopLocals);
bool optWidenPrimaryIV(FlowGraphNaturalLoop* loop,
unsigned lclNum,
ScevAddRec* addRec,
Expand All @@ -7664,6 +7666,9 @@ class Compiler
void optReplaceWidenedIV(unsigned lclNum, unsigned ssaNum, unsigned newLclNum, Statement* stmt);
void optSinkWidenedIV(unsigned lclNum, unsigned newLclNum, FlowGraphNaturalLoop* loop);

bool optRemoveUnusedIVs(FlowGraphNaturalLoop* loop, LoopLocalOccurrences* loopLocals);
bool optIsUpdateOfIVWithoutSideEffects(GenTree* tree, unsigned lclNum);

// Redundant branch opts
//
PhaseStatus optRedundantBranches();
Expand Down
277 changes: 172 additions & 105 deletions src/coreclr/jit/inductionvariableopts.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,6 +751,77 @@ void Compiler::optBestEffortReplaceNarrowIVUses(
});
}

//------------------------------------------------------------------------
// optWidenIVs: Widen IVs of the specified loop.
//
// Parameters:
// scevContext - Context for scalar evolution
// loop - The loop
// loopLocals - Data structure for locals occurrences
//
// Returns:
// True if any primary IV was widened.
//
bool Compiler::optWidenIVs(ScalarEvolutionContext& scevContext,
FlowGraphNaturalLoop* loop,
LoopLocalOccurrences* loopLocals)
{
Comment on lines +765 to +768
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just factoring IV widening into its own function... the new pass is down below.

JITDUMP("Considering primary IVs of " FMT_LP " for widening\n", loop->GetIndex());

unsigned numWidened = 0;
for (Statement* stmt : loop->GetHeader()->Statements())
{
if (!stmt->IsPhiDefnStmt())
{
break;
}

JITDUMP("\n");
DISPSTMT(stmt);

Scev* scev = scevContext.Analyze(loop->GetHeader(), stmt->GetRootNode());
if (scev == nullptr)
{
JITDUMP(" Could not analyze header PHI\n");
continue;
}

JITDUMP(" => ");
DBEXEC(verbose, scev->Dump(this));
JITDUMP("\n");
if (!scev->OperIs(ScevOper::AddRec))
{
JITDUMP(" Not an addrec\n");
continue;
}

ScevAddRec* addRec = (ScevAddRec*)scev;

unsigned lclNum = stmt->GetRootNode()->AsLclVarCommon()->GetLclNum();
LclVarDsc* lclDsc = lvaGetDesc(lclNum);
JITDUMP(" V%02u is a primary induction variable in " FMT_LP "\n", lclNum, loop->GetIndex());

assert(!lclDsc->lvPromoted);

// For a struct field with occurrences of the parent local we won't
// be able to do much.
if (lclDsc->lvIsStructField && loopLocals->HasAnyOccurrences(loop, lclDsc->lvParentLcl))
{
JITDUMP(" V%02u is a struct field whose parent local V%02u has occurrences inside the loop\n", lclNum,
lclDsc->lvParentLcl);
continue;
}

if (optWidenPrimaryIV(loop, lclNum, addRec, loopLocals))
{
numWidened++;
}
}

Metrics.WidenedIVs += numWidened;
return numWidened > 0;
}

//------------------------------------------------------------------------
// optWidenPrimaryIV: Attempt to widen a primary IV.
//
Expand Down Expand Up @@ -903,6 +974,7 @@ bool Compiler::optWidenPrimaryIV(FlowGraphNaturalLoop* loop,
loopLocals->VisitStatementsWithOccurrences(loop, lclNum, replace);

optSinkWidenedIV(lclNum, newLclNum, loop);
loopLocals->Invalidate(loop);
return true;
}

Expand Down Expand Up @@ -1036,29 +1108,12 @@ bool Compiler::optMakeExitTestDownwardsCounted(ScalarEvolutionContext& scevConte
return true;
}

GenTree* rootNode = stmt->GetRootNode();
if (!rootNode->OperIsLocalStore())
{
// Cannot reason about this use of the local, cannot remove
// TODO-CQ: In some cases it may be profitable to compute the
// value in terms of the down-counting IV.
return false;
}

if (rootNode->AsLclVarCommon()->GetLclNum() != candidateLclNum)
{
// Used to compute a value stored to some other local, cannot remove
return false;
}

if ((rootNode->AsLclVarCommon()->Data()->gtFlags & GTF_SIDE_EFFECT) != 0)
if (optIsUpdateOfIVWithoutSideEffects(stmt->GetRootNode(), candidateLclNum))
{
// May be used inside the data node for something that has side effects, cannot remove
return false;
return true;
}

// Can remove this store
return true;
return false;
};

if (!loopLocals->VisitStatementsWithOccurrences(loop, candidateLclNum, checkRemovableUse))
Expand Down Expand Up @@ -1152,26 +1207,9 @@ bool Compiler::optMakeExitTestDownwardsCounted(ScalarEvolutionContext& scevConte

JITDUMP("\n Updated exit test:\n");
DISPSTMT(jtrueStmt);

JITDUMP("\n Now removing uses of old IVs\n");

for (int i = 0; i < removableLocals.Height(); i++)
{
unsigned removableLcl = removableLocals.Bottom(i);
JITDUMP(" Removing uses of V%02u\n", removableLcl);
auto deleteStatement = [=](BasicBlock* block, Statement* stmt) {
if (stmt != jtrueStmt)
{
fgRemoveStmt(block, stmt);
}

return true;
};

loopLocals->VisitStatementsWithOccurrences(loop, removableLcl, deleteStatement);
}

JITDUMP("\n");

loopLocals->Invalidate(loop);
return true;
}

Expand Down Expand Up @@ -1612,18 +1650,10 @@ bool StrengthReductionContext::InitializeCursors(GenTreeLclVarCommon* primaryIVL
bool StrengthReductionContext::IsUseExpectedToBeRemoved(BasicBlock* block, Statement* stmt, GenTreeLclVarCommon* tree)
{
unsigned primaryIVLclNum = tree->GetLclNum();
if (stmt->GetRootNode()->OperIsLocalStore())
if (m_comp->optIsUpdateOfIVWithoutSideEffects(stmt->GetRootNode(), tree->GetLclNum()))
{
GenTreeLclVarCommon* lcl = stmt->GetRootNode()->AsLclVarCommon();
if ((lcl->GetLclNum() == primaryIVLclNum) && ((lcl->Data()->gtFlags & GTF_SIDE_EFFECT) == 0))
{
// Store to the primary IV without side effects; if we end
// up strength reducing, then this store is expected to be
// removed by making the loop downwards counted.
return true;
}

return false;
// Removal of unused IVs will get rid of this.
return true;
}

bool isInsideExitTest =
Expand Down Expand Up @@ -2077,6 +2107,92 @@ BasicBlock* StrengthReductionContext::FindUpdateInsertionPoint(ArrayStack<Cursor
return insertionPoint;
}

//------------------------------------------------------------------------
// optRemoveUnusedIVs: Remove IVs that are only used for self-updates.
//
// Parameters:
// loop - The loop
// loopLocals - Locals of the loop
//
// Returns:
// True if any primary IV was removed.
//
bool Compiler::optRemoveUnusedIVs(FlowGraphNaturalLoop* loop, LoopLocalOccurrences* loopLocals)
{
JITDUMP(" Now looking for unnecessary primary IVs\n");

unsigned numRemoved = 0;
for (Statement* stmt : loop->GetHeader()->Statements())
{
if (!stmt->IsPhiDefnStmt())
{
break;
}

unsigned lclNum = stmt->GetRootNode()->AsLclVarCommon()->GetLclNum();
JITDUMP(" V%02u", lclNum);
if (optPrimaryIVHasNonLoopUses(lclNum, loop, loopLocals))
{
JITDUMP(" has non-loop uses, cannot remove\n");
continue;
}

auto visit = [=](BasicBlock* block, Statement* stmt) {
return optIsUpdateOfIVWithoutSideEffects(stmt->GetRootNode(), lclNum);
};

if (!loopLocals->VisitStatementsWithOccurrences(loop, lclNum, visit))
{
JITDUMP(" has essential uses, cannot remove\n");
continue;
}

JITDUMP(" has no essential uses and will be removed\n", lclNum);
auto remove = [=](BasicBlock* block, Statement* stmt) {
JITDUMP(" Removing " FMT_STMT "\n", stmt->GetID());
fgRemoveStmt(block, stmt);
return true;
};

loopLocals->VisitStatementsWithOccurrences(loop, lclNum, remove);
numRemoved++;
loopLocals->Invalidate(loop);
}

Metrics.UnusedIVsRemoved += numRemoved;
return numRemoved > 0;
}

//------------------------------------------------------------------------
// optIsUpdateOfIVWithoutSideEffects: Check if a tree is an update of a
// specific local with no other side effects.
//
// Returns:
// True if so.
//
bool Compiler::optIsUpdateOfIVWithoutSideEffects(GenTree* tree, unsigned lclNum)
{
if (!tree->OperIsLocalStore())
{
return false;
}

GenTreeLclVarCommon* store = tree->AsLclVarCommon();
if (store->GetLclNum() != lclNum)
{
// Store that uses the local as a source; this primary IV is used
return false;
}

if ((store->Data()->gtFlags & GTF_SIDE_EFFECT) != 0)
{
// Primary IV may be used inside a side effect
return false;
}

return true;
}

//------------------------------------------------------------------------
// optInductionVariables: Try and optimize induction variables in the method.
//
Expand Down Expand Up @@ -2147,66 +2263,17 @@ PhaseStatus Compiler::optInductionVariables()
// addressing modes can include the zero/sign-extension of the index
// for free.
#if defined(TARGET_XARCH) && defined(TARGET_64BIT)
int numWidened = 0;

JITDUMP("Considering primary IVs of " FMT_LP " for widening\n", loop->GetIndex());

for (Statement* stmt : loop->GetHeader()->Statements())
if (optWidenIVs(scevContext, loop, &loopLocals))
{
if (!stmt->IsPhiDefnStmt())
{
break;
}

JITDUMP("\n");
DISPSTMT(stmt);

Scev* scev = scevContext.Analyze(loop->GetHeader(), stmt->GetRootNode());
if (scev == nullptr)
{
JITDUMP(" Could not analyze header PHI\n");
continue;
}

JITDUMP(" => ");
DBEXEC(verbose, scev->Dump(this));
JITDUMP("\n");
if (!scev->OperIs(ScevOper::AddRec))
{
JITDUMP(" Not an addrec\n");
continue;
}

ScevAddRec* addRec = (ScevAddRec*)scev;

unsigned lclNum = stmt->GetRootNode()->AsLclVarCommon()->GetLclNum();
LclVarDsc* lclDsc = lvaGetDesc(lclNum);
JITDUMP(" V%02u is a primary induction variable in " FMT_LP "\n", lclNum, loop->GetIndex());

assert(!lclDsc->lvPromoted);

// For a struct field with occurrences of the parent local we won't
// be able to do much.
if (lclDsc->lvIsStructField && loopLocals.HasAnyOccurrences(loop, lclDsc->lvParentLcl))
{
JITDUMP(" V%02u is a struct field whose parent local V%02u has occurrences inside the loop\n", lclNum,
lclDsc->lvParentLcl);
continue;
}

if (optWidenPrimaryIV(loop, lclNum, addRec, &loopLocals))
{
numWidened++;
changed = true;
}
Metrics.LoopsIVWidened++;
changed = true;
}
#endif

Metrics.WidenedIVs += numWidened;
if (numWidened > 0)
if (optRemoveUnusedIVs(loop, &loopLocals))
{
Metrics.LoopsIVWidened++;
changed = true;
}
#endif
}

fgInvalidateDfsTree();
Expand Down
1 change: 1 addition & 0 deletions src/coreclr/jit/jitmetadatalist.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ JITMETADATAMETRIC(LoopAlignmentCandidates, int, 0)
JITMETADATAMETRIC(LoopsAligned, int, 0)
JITMETADATAMETRIC(LoopsIVWidened, int, 0)
JITMETADATAMETRIC(WidenedIVs, int, 0)
JITMETADATAMETRIC(UnusedIVsRemoved, int, 0)
JITMETADATAMETRIC(LoopsMadeDownwardsCounted, int, 0)
JITMETADATAMETRIC(LoopsStrengthReduced, int, 0)
JITMETADATAMETRIC(VarsInSsa, int, 0)
Expand Down