2007-11-28 06:47:08 +08:00
|
|
|
//===- MachineLoopInfo.cpp - Natural Loop Calculator ----------------------===//
|
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
2007-11-28 06:47:08 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file defines the MachineLoopInfo class that is used to identify natural
|
|
|
|
// loops and determine the loop depth of various nodes of the CFG. Note that
|
2012-06-20 11:42:09 +08:00
|
|
|
// the loops identified may actually be several natural loops that share the
|
2007-11-28 06:47:08 +08:00
|
|
|
// same header node... not just a single natural loop.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "llvm/CodeGen/MachineLoopInfo.h"
|
2012-12-04 00:50:05 +08:00
|
|
|
#include "llvm/Analysis/LoopInfoImpl.h"
|
2007-11-28 06:47:08 +08:00
|
|
|
#include "llvm/CodeGen/MachineDominators.h"
|
2021-01-08 17:04:56 +08:00
|
|
|
#include "llvm/CodeGen/MachineRegisterInfo.h"
|
2022-03-10 20:54:41 +08:00
|
|
|
#include "llvm/CodeGen/Passes.h"
|
2021-07-24 03:28:55 +08:00
|
|
|
#include "llvm/CodeGen/TargetInstrInfo.h"
|
2021-01-08 17:04:56 +08:00
|
|
|
#include "llvm/CodeGen/TargetSubtargetInfo.h"
|
2018-04-30 22:59:11 +08:00
|
|
|
#include "llvm/Config/llvm-config.h"
|
Sink all InitializePasses.h includes
This file lists every pass in LLVM, and is included by Pass.h, which is
very popular. Every time we add, remove, or rename a pass in LLVM, it
caused lots of recompilation.
I found this fact by looking at this table, which is sorted by the
number of times a file was changed over the last 100,000 git commits
multiplied by the number of object files that depend on it in the
current checkout:
recompiles touches affected_files header
342380 95 3604 llvm/include/llvm/ADT/STLExtras.h
314730 234 1345 llvm/include/llvm/InitializePasses.h
307036 118 2602 llvm/include/llvm/ADT/APInt.h
213049 59 3611 llvm/include/llvm/Support/MathExtras.h
170422 47 3626 llvm/include/llvm/Support/Compiler.h
162225 45 3605 llvm/include/llvm/ADT/Optional.h
158319 63 2513 llvm/include/llvm/ADT/Triple.h
140322 39 3598 llvm/include/llvm/ADT/StringRef.h
137647 59 2333 llvm/include/llvm/Support/Error.h
131619 73 1803 llvm/include/llvm/Support/FileSystem.h
Before this change, touching InitializePasses.h would cause 1345 files
to recompile. After this change, touching it only causes 550 compiles in
an incremental rebuild.
Reviewers: bkramer, asbirlea, bollu, jdoerfert
Differential Revision: https://reviews.llvm.org/D70211
2019-11-14 05:15:01 +08:00
|
|
|
#include "llvm/InitializePasses.h"
|
2022-03-10 20:54:41 +08:00
|
|
|
#include "llvm/Support/Debug.h"
|
|
|
|
#include "llvm/Support/raw_ostream.h"
|
2021-01-08 17:04:56 +08:00
|
|
|
|
2007-11-28 06:47:08 +08:00
|
|
|
using namespace llvm;
|
|
|
|
|
2012-06-20 11:42:09 +08:00
|
|
|
// Explicitly instantiate methods in LoopInfoImpl.h for MI-level Loops.
|
|
|
|
template class llvm::LoopBase<MachineBasicBlock, MachineLoop>;
|
|
|
|
template class llvm::LoopInfoBase<MachineBasicBlock, MachineLoop>;
|
2007-11-28 06:47:08 +08:00
|
|
|
|
2008-01-06 07:29:51 +08:00
|
|
|
char MachineLoopInfo::ID = 0;
|
Sink all InitializePasses.h includes
This file lists every pass in LLVM, and is included by Pass.h, which is
very popular. Every time we add, remove, or rename a pass in LLVM, it
caused lots of recompilation.
I found this fact by looking at this table, which is sorted by the
number of times a file was changed over the last 100,000 git commits
multiplied by the number of object files that depend on it in the
current checkout:
recompiles touches affected_files header
342380 95 3604 llvm/include/llvm/ADT/STLExtras.h
314730 234 1345 llvm/include/llvm/InitializePasses.h
307036 118 2602 llvm/include/llvm/ADT/APInt.h
213049 59 3611 llvm/include/llvm/Support/MathExtras.h
170422 47 3626 llvm/include/llvm/Support/Compiler.h
162225 45 3605 llvm/include/llvm/ADT/Optional.h
158319 63 2513 llvm/include/llvm/ADT/Triple.h
140322 39 3598 llvm/include/llvm/ADT/StringRef.h
137647 59 2333 llvm/include/llvm/Support/Error.h
131619 73 1803 llvm/include/llvm/Support/FileSystem.h
Before this change, touching InitializePasses.h would cause 1345 files
to recompile. After this change, touching it only causes 550 compiles in
an incremental rebuild.
Reviewers: bkramer, asbirlea, bollu, jdoerfert
Differential Revision: https://reviews.llvm.org/D70211
2019-11-14 05:15:01 +08:00
|
|
|
MachineLoopInfo::MachineLoopInfo() : MachineFunctionPass(ID) {
|
|
|
|
initializeMachineLoopInfoPass(*PassRegistry::getPassRegistry());
|
|
|
|
}
|
2010-10-13 03:48:12 +08:00
|
|
|
INITIALIZE_PASS_BEGIN(MachineLoopInfo, "machine-loops",
|
|
|
|
"Machine Natural Loop Construction", true, true)
|
|
|
|
INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
|
|
|
|
INITIALIZE_PASS_END(MachineLoopInfo, "machine-loops",
|
2010-10-08 06:25:06 +08:00
|
|
|
"Machine Natural Loop Construction", true, true)
|
2008-01-05 04:54:55 +08:00
|
|
|
|
2010-08-07 02:33:48 +08:00
|
|
|
char &llvm::MachineLoopInfoID = MachineLoopInfo::ID;
|
2007-11-28 06:47:08 +08:00
|
|
|
|
|
|
|
bool MachineLoopInfo::runOnMachineFunction(MachineFunction &) {
|
2019-10-29 03:35:34 +08:00
|
|
|
calculate(getAnalysis<MachineDominatorTree>());
|
2019-10-21 04:39:33 +08:00
|
|
|
return false;
|
2019-10-19 00:46:01 +08:00
|
|
|
}
|
|
|
|
|
2019-10-29 03:35:34 +08:00
|
|
|
void MachineLoopInfo::calculate(MachineDominatorTree &MDT) {
|
|
|
|
releaseMemory();
|
|
|
|
LI.analyze(MDT.getBase());
|
|
|
|
}
|
|
|
|
|
2007-11-28 06:47:08 +08:00
|
|
|
void MachineLoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
|
|
|
|
AU.setPreservesAll();
|
|
|
|
AU.addRequired<MachineDominatorTree>();
|
2009-08-01 02:16:33 +08:00
|
|
|
MachineFunctionPass::getAnalysisUsage(AU);
|
2007-11-28 06:47:08 +08:00
|
|
|
}
|
2009-10-20 12:16:37 +08:00
|
|
|
|
|
|
|
MachineBasicBlock *MachineLoop::getTopBlock() {
|
|
|
|
MachineBasicBlock *TopMBB = getHeader();
|
|
|
|
MachineFunction::iterator Begin = TopMBB->getParent()->begin();
|
2016-02-22 04:39:50 +08:00
|
|
|
if (TopMBB->getIterator() != Begin) {
|
2015-10-10 03:40:45 +08:00
|
|
|
MachineBasicBlock *PriorMBB = &*std::prev(TopMBB->getIterator());
|
2009-10-20 12:16:37 +08:00
|
|
|
while (contains(PriorMBB)) {
|
|
|
|
TopMBB = PriorMBB;
|
2016-02-22 04:39:50 +08:00
|
|
|
if (TopMBB->getIterator() == Begin)
|
|
|
|
break;
|
2015-10-10 03:40:45 +08:00
|
|
|
PriorMBB = &*std::prev(TopMBB->getIterator());
|
2009-10-20 12:16:37 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return TopMBB;
|
|
|
|
}
|
|
|
|
|
|
|
|
MachineBasicBlock *MachineLoop::getBottomBlock() {
|
|
|
|
MachineBasicBlock *BotMBB = getHeader();
|
|
|
|
MachineFunction::iterator End = BotMBB->getParent()->end();
|
2016-02-22 04:39:50 +08:00
|
|
|
if (BotMBB->getIterator() != std::prev(End)) {
|
2015-10-10 03:40:45 +08:00
|
|
|
MachineBasicBlock *NextMBB = &*std::next(BotMBB->getIterator());
|
2009-10-20 12:16:37 +08:00
|
|
|
while (contains(NextMBB)) {
|
|
|
|
BotMBB = NextMBB;
|
2015-10-10 03:40:45 +08:00
|
|
|
if (BotMBB == &*std::next(BotMBB->getIterator()))
|
|
|
|
break;
|
|
|
|
NextMBB = &*std::next(BotMBB->getIterator());
|
2009-10-20 12:16:37 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return BotMBB;
|
|
|
|
}
|
2010-01-06 05:08:02 +08:00
|
|
|
|
2016-08-15 16:22:42 +08:00
|
|
|
MachineBasicBlock *MachineLoop::findLoopControlBlock() {
|
|
|
|
if (MachineBasicBlock *Latch = getLoopLatch()) {
|
|
|
|
if (isLoopExiting(Latch))
|
|
|
|
return Latch;
|
|
|
|
else
|
|
|
|
return getExitingBlock();
|
|
|
|
}
|
|
|
|
return nullptr;
|
|
|
|
}
|
|
|
|
|
2017-01-26 07:20:33 +08:00
|
|
|
DebugLoc MachineLoop::getStartLoc() const {
|
|
|
|
// Try the pre-header first.
|
|
|
|
if (MachineBasicBlock *PHeadMBB = getLoopPreheader())
|
|
|
|
if (const BasicBlock *PHeadBB = PHeadMBB->getBasicBlock())
|
|
|
|
if (DebugLoc DL = PHeadBB->getTerminator()->getDebugLoc())
|
|
|
|
return DL;
|
|
|
|
|
|
|
|
// If we have no pre-header or there are no instructions with debug
|
|
|
|
// info in it, try the header.
|
|
|
|
if (MachineBasicBlock *HeadMBB = getHeader())
|
|
|
|
if (const BasicBlock *HeadBB = HeadMBB->getBasicBlock())
|
|
|
|
return HeadBB->getTerminator()->getDebugLoc();
|
|
|
|
|
|
|
|
return DebugLoc();
|
|
|
|
}
|
|
|
|
|
2016-08-15 16:22:42 +08:00
|
|
|
MachineBasicBlock *
|
2021-05-24 19:22:15 +08:00
|
|
|
MachineLoopInfo::findLoopPreheader(MachineLoop *L, bool SpeculativePreheader,
|
|
|
|
bool FindMultiLoopPreheader) const {
|
2016-08-15 16:22:42 +08:00
|
|
|
if (MachineBasicBlock *PB = L->getLoopPreheader())
|
|
|
|
return PB;
|
|
|
|
|
|
|
|
if (!SpeculativePreheader)
|
|
|
|
return nullptr;
|
|
|
|
|
|
|
|
MachineBasicBlock *HB = L->getHeader(), *LB = L->getLoopLatch();
|
|
|
|
if (HB->pred_size() != 2 || HB->hasAddressTaken())
|
|
|
|
return nullptr;
|
|
|
|
// Find the predecessor of the header that is not the latch block.
|
|
|
|
MachineBasicBlock *Preheader = nullptr;
|
|
|
|
for (MachineBasicBlock *P : HB->predecessors()) {
|
|
|
|
if (P == LB)
|
|
|
|
continue;
|
|
|
|
// Sanity.
|
|
|
|
if (Preheader)
|
|
|
|
return nullptr;
|
|
|
|
Preheader = P;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check if the preheader candidate is a successor of any other loop
|
|
|
|
// headers. We want to avoid having two loop setups in the same block.
|
2021-05-24 19:22:15 +08:00
|
|
|
if (!FindMultiLoopPreheader) {
|
|
|
|
for (MachineBasicBlock *S : Preheader->successors()) {
|
|
|
|
if (S == HB)
|
|
|
|
continue;
|
|
|
|
MachineLoop *T = getLoopFor(S);
|
|
|
|
if (T && T->getHeader() == S)
|
|
|
|
return nullptr;
|
|
|
|
}
|
2016-08-15 16:22:42 +08:00
|
|
|
}
|
|
|
|
return Preheader;
|
|
|
|
}
|
|
|
|
|
2021-01-08 17:04:56 +08:00
|
|
|
bool MachineLoop::isLoopInvariant(MachineInstr &I) const {
|
|
|
|
MachineFunction *MF = I.getParent()->getParent();
|
|
|
|
MachineRegisterInfo *MRI = &MF->getRegInfo();
|
2021-07-24 03:28:55 +08:00
|
|
|
const TargetSubtargetInfo &ST = MF->getSubtarget();
|
|
|
|
const TargetRegisterInfo *TRI = ST.getRegisterInfo();
|
|
|
|
const TargetInstrInfo *TII = ST.getInstrInfo();
|
2021-01-08 17:04:56 +08:00
|
|
|
|
|
|
|
// The instruction is loop invariant if all of its operands are.
|
|
|
|
for (const MachineOperand &MO : I.operands()) {
|
|
|
|
if (!MO.isReg())
|
|
|
|
continue;
|
|
|
|
|
|
|
|
Register Reg = MO.getReg();
|
|
|
|
if (Reg == 0) continue;
|
|
|
|
|
|
|
|
// An instruction that uses or defines a physical register can't e.g. be
|
|
|
|
// hoisted, so mark this as not invariant.
|
|
|
|
if (Register::isPhysicalRegister(Reg)) {
|
|
|
|
if (MO.isUse()) {
|
|
|
|
// If the physreg has no defs anywhere, it's just an ambient register
|
|
|
|
// and we can freely move its uses. Alternatively, if it's allocatable,
|
|
|
|
// it could get allocated to something with a def during allocation.
|
|
|
|
// However, if the physreg is known to always be caller saved/restored
|
|
|
|
// then this use is safe to hoist.
|
|
|
|
if (!MRI->isConstantPhysReg(Reg) &&
|
2021-07-24 03:28:55 +08:00
|
|
|
!(TRI->isCallerPreservedPhysReg(Reg.asMCReg(), *I.getMF())) &&
|
|
|
|
!TII->isIgnorableUse(MO))
|
2021-01-08 17:04:56 +08:00
|
|
|
return false;
|
|
|
|
// Otherwise it's safe to move.
|
|
|
|
continue;
|
|
|
|
} else if (!MO.isDead()) {
|
|
|
|
// A def that isn't dead can't be moved.
|
|
|
|
return false;
|
|
|
|
} else if (getHeader()->isLiveIn(Reg)) {
|
|
|
|
// If the reg is live into the loop, we can't hoist an instruction
|
|
|
|
// which would clobber it.
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!MO.isUse())
|
|
|
|
continue;
|
|
|
|
|
|
|
|
assert(MRI->getVRegDef(Reg) &&
|
|
|
|
"Machine instr not mapped for this vreg?!");
|
|
|
|
|
|
|
|
// If the loop contains the definition of an operand, then the instruction
|
|
|
|
// isn't loop invariant.
|
|
|
|
if (contains(MRI->getVRegDef(Reg)))
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// If we got this far, the instruction is loop invariant!
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2017-10-15 22:32:27 +08:00
|
|
|
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
|
2016-01-30 04:50:44 +08:00
|
|
|
LLVM_DUMP_METHOD void MachineLoop::dump() const {
|
2010-01-06 05:08:02 +08:00
|
|
|
print(dbgs());
|
|
|
|
}
|
2012-09-07 03:06:06 +08:00
|
|
|
#endif
|