10bf841acSMarina Yatsina //===---- ReachingDefAnalysis.cpp - Reaching Def Analysis ---*- C++ -*-----===//
20bf841acSMarina Yatsina //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60bf841acSMarina Yatsina //
70bf841acSMarina Yatsina //===----------------------------------------------------------------------===//
80bf841acSMarina Yatsina 
9ac30ea2fSSam Parker #include "llvm/ADT/SmallSet.h"
10cced971fSSam Parker #include "llvm/CodeGen/LivePhysRegs.h"
110bf841acSMarina Yatsina #include "llvm/CodeGen/ReachingDefAnalysis.h"
120bf841acSMarina Yatsina #include "llvm/CodeGen/TargetRegisterInfo.h"
130bf841acSMarina Yatsina #include "llvm/CodeGen/TargetSubtargetInfo.h"
141d7b4136SReid Kleckner #include "llvm/Support/Debug.h"
150bf841acSMarina Yatsina 
160bf841acSMarina Yatsina using namespace llvm;
170bf841acSMarina Yatsina 
180bf841acSMarina Yatsina #define DEBUG_TYPE "reaching-deps-analysis"
190bf841acSMarina Yatsina 
200bf841acSMarina Yatsina char ReachingDefAnalysis::ID = 0;
210bf841acSMarina Yatsina INITIALIZE_PASS(ReachingDefAnalysis, DEBUG_TYPE, "ReachingDefAnalysis", false,
220bf841acSMarina Yatsina                 true)
230bf841acSMarina Yatsina 
24247a177cSBenjamin Kramer static bool isValidReg(const MachineOperand &MO) {
25bf61421aSSam Parker   return MO.isReg() && MO.getReg();
26bf61421aSSam Parker }
27bf61421aSSam Parker 
28247a177cSBenjamin Kramer static bool isValidRegUse(const MachineOperand &MO) {
29bf61421aSSam Parker   return isValidReg(MO) && MO.isUse();
30bf61421aSSam Parker }
31bf61421aSSam Parker 
32247a177cSBenjamin Kramer static bool isValidRegUseOf(const MachineOperand &MO, int PhysReg) {
33bf61421aSSam Parker   return isValidRegUse(MO) && MO.getReg() == PhysReg;
34bf61421aSSam Parker }
35bf61421aSSam Parker 
36247a177cSBenjamin Kramer static bool isValidRegDef(const MachineOperand &MO) {
37bf61421aSSam Parker   return isValidReg(MO) && MO.isDef();
38bf61421aSSam Parker }
39bf61421aSSam Parker 
40247a177cSBenjamin Kramer static bool isValidRegDefOf(const MachineOperand &MO, int PhysReg) {
41bf61421aSSam Parker   return isValidRegDef(MO) && MO.getReg() == PhysReg;
42bf61421aSSam Parker }
43bf61421aSSam Parker 
4476e987b3SNikita Popov void ReachingDefAnalysis::enterBasicBlock(MachineBasicBlock *MBB) {
45e4d63a49SMarina Yatsina   unsigned MBBNumber = MBB->getNumber();
460bf841acSMarina Yatsina   assert(MBBNumber < MBBReachingDefs.size() &&
470bf841acSMarina Yatsina          "Unexpected basic block number.");
480bf841acSMarina Yatsina   MBBReachingDefs[MBBNumber].resize(NumRegUnits);
490bf841acSMarina Yatsina 
500bf841acSMarina Yatsina   // Reset instruction counter in each basic block.
510bf841acSMarina Yatsina   CurInstr = 0;
520bf841acSMarina Yatsina 
530bf841acSMarina Yatsina   // Set up LiveRegs to represent registers entering MBB.
540bf841acSMarina Yatsina   // Default values are 'nothing happened a long time ago'.
550bf841acSMarina Yatsina   if (LiveRegs.empty())
560f110a88SCraig Topper     LiveRegs.assign(NumRegUnits, ReachingDefDefaultVal);
570bf841acSMarina Yatsina 
580bf841acSMarina Yatsina   // This is the entry block.
590bf841acSMarina Yatsina   if (MBB->pred_empty()) {
600bf841acSMarina Yatsina     for (const auto &LI : MBB->liveins()) {
610bf841acSMarina Yatsina       for (MCRegUnitIterator Unit(LI.PhysReg, TRI); Unit.isValid(); ++Unit) {
620bf841acSMarina Yatsina         // Treat function live-ins as if they were defined just before the first
630bf841acSMarina Yatsina         // instruction.  Usually, function arguments are set up immediately
640bf841acSMarina Yatsina         // before the call.
65361c29d7SNikita Popov         if (LiveRegs[*Unit] != -1) {
660bf841acSMarina Yatsina           LiveRegs[*Unit] = -1;
67361c29d7SNikita Popov           MBBReachingDefs[MBBNumber][*Unit].push_back(-1);
68361c29d7SNikita Popov         }
690bf841acSMarina Yatsina       }
700bf841acSMarina Yatsina     }
71d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << printMBBReference(*MBB) << ": entry\n");
720bf841acSMarina Yatsina     return;
730bf841acSMarina Yatsina   }
740bf841acSMarina Yatsina 
750bf841acSMarina Yatsina   // Try to coalesce live-out registers from predecessors.
760bf841acSMarina Yatsina   for (MachineBasicBlock *pred : MBB->predecessors()) {
77e4d63a49SMarina Yatsina     assert(unsigned(pred->getNumber()) < MBBOutRegsInfos.size() &&
780bf841acSMarina Yatsina            "Should have pre-allocated MBBInfos for all MBBs");
790bf841acSMarina Yatsina     const LiveRegsDefInfo &Incoming = MBBOutRegsInfos[pred->getNumber()];
800bf841acSMarina Yatsina     // Incoming is null if this is a backedge from a BB
810bf841acSMarina Yatsina     // we haven't processed yet
820bf841acSMarina Yatsina     if (Incoming.empty())
830bf841acSMarina Yatsina       continue;
840bf841acSMarina Yatsina 
85e8b83f7dSNikita Popov     // Find the most recent reaching definition from a predecessor.
86e8b83f7dSNikita Popov     for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit)
870bf841acSMarina Yatsina       LiveRegs[Unit] = std::max(LiveRegs[Unit], Incoming[Unit]);
88e8b83f7dSNikita Popov   }
89e8b83f7dSNikita Popov 
90e8b83f7dSNikita Popov   // Insert the most recent reaching definition we found.
91e8b83f7dSNikita Popov   for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit)
92e8b83f7dSNikita Popov     if (LiveRegs[Unit] != ReachingDefDefaultVal)
930bf841acSMarina Yatsina       MBBReachingDefs[MBBNumber][Unit].push_back(LiveRegs[Unit]);
940bf841acSMarina Yatsina }
950bf841acSMarina Yatsina 
9676e987b3SNikita Popov void ReachingDefAnalysis::leaveBasicBlock(MachineBasicBlock *MBB) {
970bf841acSMarina Yatsina   assert(!LiveRegs.empty() && "Must enter basic block first.");
9876e987b3SNikita Popov   unsigned MBBNumber = MBB->getNumber();
990bf841acSMarina Yatsina   assert(MBBNumber < MBBOutRegsInfos.size() &&
1000bf841acSMarina Yatsina          "Unexpected basic block number.");
1010bf841acSMarina Yatsina   // Save register clearances at end of MBB - used by enterBasicBlock().
1020bf841acSMarina Yatsina   MBBOutRegsInfos[MBBNumber] = LiveRegs;
1030bf841acSMarina Yatsina 
1040bf841acSMarina Yatsina   // While processing the basic block, we kept `Def` relative to the start
1050bf841acSMarina Yatsina   // of the basic block for convenience. However, future use of this information
1060bf841acSMarina Yatsina   // only cares about the clearance from the end of the block, so adjust
1070bf841acSMarina Yatsina   // everything to be relative to the end of the basic block.
1080bf841acSMarina Yatsina   for (int &OutLiveReg : MBBOutRegsInfos[MBBNumber])
1098d75df14SNikita Popov     if (OutLiveReg != ReachingDefDefaultVal)
1100bf841acSMarina Yatsina       OutLiveReg -= CurInstr;
1110bf841acSMarina Yatsina   LiveRegs.clear();
1120bf841acSMarina Yatsina }
1130bf841acSMarina Yatsina 
1140bf841acSMarina Yatsina void ReachingDefAnalysis::processDefs(MachineInstr *MI) {
115801bf7ebSShiva Chen   assert(!MI->isDebugInstr() && "Won't process debug instructions");
1160bf841acSMarina Yatsina 
117e4d63a49SMarina Yatsina   unsigned MBBNumber = MI->getParent()->getNumber();
1180bf841acSMarina Yatsina   assert(MBBNumber < MBBReachingDefs.size() &&
1190bf841acSMarina Yatsina          "Unexpected basic block number.");
120bf61421aSSam Parker 
121bf61421aSSam Parker   for (auto &MO : MI->operands()) {
122bf61421aSSam Parker     if (!isValidRegDef(MO))
1230bf841acSMarina Yatsina       continue;
1240bf841acSMarina Yatsina     for (MCRegUnitIterator Unit(MO.getReg(), TRI); Unit.isValid(); ++Unit) {
1250bf841acSMarina Yatsina       // This instruction explicitly defines the current reg unit.
126361c29d7SNikita Popov       LLVM_DEBUG(dbgs() << printReg(*Unit, TRI) << ":\t" << CurInstr
127d34e60caSNicola Zaghen                         << '\t' << *MI);
1280bf841acSMarina Yatsina 
1290bf841acSMarina Yatsina       // How many instructions since this reg unit was last written?
130361c29d7SNikita Popov       if (LiveRegs[*Unit] != CurInstr) {
1310bf841acSMarina Yatsina         LiveRegs[*Unit] = CurInstr;
1320bf841acSMarina Yatsina         MBBReachingDefs[MBBNumber][*Unit].push_back(CurInstr);
1330bf841acSMarina Yatsina       }
1340bf841acSMarina Yatsina     }
135361c29d7SNikita Popov   }
1360bf841acSMarina Yatsina   InstIds[MI] = CurInstr;
1370bf841acSMarina Yatsina   ++CurInstr;
1380bf841acSMarina Yatsina }
1390bf841acSMarina Yatsina 
140259649a5SNikita Popov void ReachingDefAnalysis::reprocessBasicBlock(MachineBasicBlock *MBB) {
141259649a5SNikita Popov   unsigned MBBNumber = MBB->getNumber();
142259649a5SNikita Popov   assert(MBBNumber < MBBReachingDefs.size() &&
143259649a5SNikita Popov          "Unexpected basic block number.");
144259649a5SNikita Popov 
145259649a5SNikita Popov   // Count number of non-debug instructions for end of block adjustment.
1468f92f3c2SSam Parker   auto NonDbgInsts =
1478f92f3c2SSam Parker     instructionsWithoutDebug(MBB->instr_begin(), MBB->instr_end());
1488f92f3c2SSam Parker   int NumInsts = std::distance(NonDbgInsts.begin(), NonDbgInsts.end());
149259649a5SNikita Popov 
150259649a5SNikita Popov   // When reprocessing a block, the only thing we need to do is check whether
151259649a5SNikita Popov   // there is now a more recent incoming reaching definition from a predecessor.
152259649a5SNikita Popov   for (MachineBasicBlock *pred : MBB->predecessors()) {
153259649a5SNikita Popov     assert(unsigned(pred->getNumber()) < MBBOutRegsInfos.size() &&
154259649a5SNikita Popov            "Should have pre-allocated MBBInfos for all MBBs");
155259649a5SNikita Popov     const LiveRegsDefInfo &Incoming = MBBOutRegsInfos[pred->getNumber()];
156259649a5SNikita Popov     // Incoming may be empty for dead predecessors.
157259649a5SNikita Popov     if (Incoming.empty())
158259649a5SNikita Popov       continue;
159259649a5SNikita Popov 
160259649a5SNikita Popov     for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit) {
161259649a5SNikita Popov       int Def = Incoming[Unit];
162259649a5SNikita Popov       if (Def == ReachingDefDefaultVal)
163259649a5SNikita Popov         continue;
164259649a5SNikita Popov 
165259649a5SNikita Popov       auto Start = MBBReachingDefs[MBBNumber][Unit].begin();
166259649a5SNikita Popov       if (Start != MBBReachingDefs[MBBNumber][Unit].end() && *Start < 0) {
167259649a5SNikita Popov         if (*Start >= Def)
168259649a5SNikita Popov           continue;
169259649a5SNikita Popov 
170259649a5SNikita Popov         // Update existing reaching def from predecessor to a more recent one.
171259649a5SNikita Popov         *Start = Def;
172259649a5SNikita Popov       } else {
173259649a5SNikita Popov         // Insert new reaching def from predecessor.
174259649a5SNikita Popov         MBBReachingDefs[MBBNumber][Unit].insert(Start, Def);
175259649a5SNikita Popov       }
176259649a5SNikita Popov 
177259649a5SNikita Popov       // Update reaching def at end of of BB. Keep in mind that these are
178259649a5SNikita Popov       // adjusted relative to the end of the basic block.
179259649a5SNikita Popov       if (MBBOutRegsInfos[MBBNumber][Unit] < Def - NumInsts)
180259649a5SNikita Popov         MBBOutRegsInfos[MBBNumber][Unit] = Def - NumInsts;
181259649a5SNikita Popov     }
182259649a5SNikita Popov   }
183259649a5SNikita Popov }
184259649a5SNikita Popov 
1850bf841acSMarina Yatsina void ReachingDefAnalysis::processBasicBlock(
1860bf841acSMarina Yatsina     const LoopTraversal::TraversedMBBInfo &TraversedMBB) {
18776e987b3SNikita Popov   MachineBasicBlock *MBB = TraversedMBB.MBB;
18876e987b3SNikita Popov   LLVM_DEBUG(dbgs() << printMBBReference(*MBB)
18976e987b3SNikita Popov                     << (!TraversedMBB.IsDone ? ": incomplete\n"
19076e987b3SNikita Popov                                              : ": all preds known\n"));
19176e987b3SNikita Popov 
192259649a5SNikita Popov   if (!TraversedMBB.PrimaryPass) {
193259649a5SNikita Popov     // Reprocess MBB that is part of a loop.
194259649a5SNikita Popov     reprocessBasicBlock(MBB);
195259649a5SNikita Popov     return;
196259649a5SNikita Popov   }
197259649a5SNikita Popov 
19876e987b3SNikita Popov   enterBasicBlock(MBB);
1998f92f3c2SSam Parker   for (MachineInstr &MI :
2008f92f3c2SSam Parker        instructionsWithoutDebug(MBB->instr_begin(), MBB->instr_end()))
2010bf841acSMarina Yatsina     processDefs(&MI);
20276e987b3SNikita Popov   leaveBasicBlock(MBB);
2030bf841acSMarina Yatsina }
2040bf841acSMarina Yatsina 
2050bf841acSMarina Yatsina bool ReachingDefAnalysis::runOnMachineFunction(MachineFunction &mf) {
2060bf841acSMarina Yatsina   MF = &mf;
2070bf841acSMarina Yatsina   TRI = MF->getSubtarget().getRegisterInfo();
208d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "********** REACHING DEFINITION ANALYSIS **********\n");
209659500c0SSam Parker   init();
210659500c0SSam Parker   traverse();
2110bf841acSMarina Yatsina   return false;
2120bf841acSMarina Yatsina }
2130bf841acSMarina Yatsina 
2140bf841acSMarina Yatsina void ReachingDefAnalysis::releaseMemory() {
2150bf841acSMarina Yatsina   // Clear the internal vectors.
2160bf841acSMarina Yatsina   MBBOutRegsInfos.clear();
2170bf841acSMarina Yatsina   MBBReachingDefs.clear();
2180bf841acSMarina Yatsina   InstIds.clear();
219659500c0SSam Parker   LiveRegs.clear();
220659500c0SSam Parker }
221659500c0SSam Parker 
222659500c0SSam Parker void ReachingDefAnalysis::reset() {
223659500c0SSam Parker   releaseMemory();
224659500c0SSam Parker   init();
225659500c0SSam Parker   traverse();
226659500c0SSam Parker }
227659500c0SSam Parker 
228659500c0SSam Parker void ReachingDefAnalysis::init() {
229659500c0SSam Parker   NumRegUnits = TRI->getNumRegUnits();
230659500c0SSam Parker   MBBReachingDefs.resize(MF->getNumBlockIDs());
231659500c0SSam Parker   // Initialize the MBBOutRegsInfos
232659500c0SSam Parker   MBBOutRegsInfos.resize(MF->getNumBlockIDs());
233659500c0SSam Parker   LoopTraversal Traversal;
234659500c0SSam Parker   TraversedMBBOrder = Traversal.traverse(*MF);
235659500c0SSam Parker }
236659500c0SSam Parker 
237659500c0SSam Parker void ReachingDefAnalysis::traverse() {
238659500c0SSam Parker   // Traverse the basic blocks.
239659500c0SSam Parker   for (LoopTraversal::TraversedMBBInfo TraversedMBB : TraversedMBBOrder)
240659500c0SSam Parker     processBasicBlock(TraversedMBB);
241259649a5SNikita Popov #ifndef NDEBUG
242259649a5SNikita Popov   // Make sure reaching defs are sorted and unique.
243659500c0SSam Parker   for (MBBDefsInfo &MBBDefs : MBBReachingDefs) {
244259649a5SNikita Popov     for (MBBRegUnitDefs &RegUnitDefs : MBBDefs) {
245259649a5SNikita Popov       int LastDef = ReachingDefDefaultVal;
246259649a5SNikita Popov       for (int Def : RegUnitDefs) {
247259649a5SNikita Popov         assert(Def > LastDef && "Defs must be sorted and unique");
248259649a5SNikita Popov         LastDef = Def;
249659500c0SSam Parker       }
2500bf841acSMarina Yatsina     }
251259649a5SNikita Popov   }
252259649a5SNikita Popov #endif
253259649a5SNikita Popov }
2540bf841acSMarina Yatsina 
2550d1468dbSSam Parker int ReachingDefAnalysis::getReachingDef(MachineInstr *MI, int PhysReg) const {
2560bf841acSMarina Yatsina   assert(InstIds.count(MI) && "Unexpected machine instuction.");
2570d1468dbSSam Parker   int InstId = InstIds.lookup(MI);
2580f110a88SCraig Topper   int DefRes = ReachingDefDefaultVal;
259e4d63a49SMarina Yatsina   unsigned MBBNumber = MI->getParent()->getNumber();
2600bf841acSMarina Yatsina   assert(MBBNumber < MBBReachingDefs.size() &&
2610bf841acSMarina Yatsina          "Unexpected basic block number.");
2620f110a88SCraig Topper   int LatestDef = ReachingDefDefaultVal;
2630bf841acSMarina Yatsina   for (MCRegUnitIterator Unit(PhysReg, TRI); Unit.isValid(); ++Unit) {
2640bf841acSMarina Yatsina     for (int Def : MBBReachingDefs[MBBNumber][*Unit]) {
2650bf841acSMarina Yatsina       if (Def >= InstId)
2660bf841acSMarina Yatsina         break;
2670bf841acSMarina Yatsina       DefRes = Def;
2680bf841acSMarina Yatsina     }
2690bf841acSMarina Yatsina     LatestDef = std::max(LatestDef, DefRes);
2700bf841acSMarina Yatsina   }
2710bf841acSMarina Yatsina   return LatestDef;
2720bf841acSMarina Yatsina }
2730bf841acSMarina Yatsina 
2741d06e75dSSam Parker MachineInstr* ReachingDefAnalysis::getReachingLocalMIDef(MachineInstr *MI,
2750d1468dbSSam Parker                                                          int PhysReg) const {
27685a5c65fSSam Parker   return hasLocalDefBefore(MI, PhysReg)
27785a5c65fSSam Parker     ? getInstFromId(MI->getParent(), getReachingDef(MI, PhysReg))
27885a5c65fSSam Parker     : nullptr;
279cced971fSSam Parker }
280cced971fSSam Parker 
28128166816SSam Parker bool ReachingDefAnalysis::hasSameReachingDef(MachineInstr *A, MachineInstr *B,
2820d1468dbSSam Parker                                              int PhysReg) const {
28328166816SSam Parker   MachineBasicBlock *ParentA = A->getParent();
28428166816SSam Parker   MachineBasicBlock *ParentB = B->getParent();
28528166816SSam Parker   if (ParentA != ParentB)
28628166816SSam Parker     return false;
28728166816SSam Parker 
28828166816SSam Parker   return getReachingDef(A, PhysReg) == getReachingDef(B, PhysReg);
28928166816SSam Parker }
29028166816SSam Parker 
291cced971fSSam Parker MachineInstr *ReachingDefAnalysis::getInstFromId(MachineBasicBlock *MBB,
2920d1468dbSSam Parker                                                  int InstId) const {
29328166816SSam Parker   assert(static_cast<size_t>(MBB->getNumber()) < MBBReachingDefs.size() &&
294cced971fSSam Parker          "Unexpected basic block number.");
295cced971fSSam Parker   assert(InstId < static_cast<int>(MBB->size()) &&
296cced971fSSam Parker          "Unexpected instruction id.");
297cced971fSSam Parker 
298cced971fSSam Parker   if (InstId < 0)
299cced971fSSam Parker     return nullptr;
300cced971fSSam Parker 
301cced971fSSam Parker   for (auto &MI : *MBB) {
30293b0536fSSjoerd Meijer     auto F = InstIds.find(&MI);
30393b0536fSSjoerd Meijer     if (F != InstIds.end() && F->second == InstId)
304cced971fSSam Parker       return &MI;
305cced971fSSam Parker   }
30693b0536fSSjoerd Meijer 
307cced971fSSam Parker   return nullptr;
308cced971fSSam Parker }
309cced971fSSam Parker 
3100d1468dbSSam Parker int
3110d1468dbSSam Parker ReachingDefAnalysis::getClearance(MachineInstr *MI, MCPhysReg PhysReg) const {
3120bf841acSMarina Yatsina   assert(InstIds.count(MI) && "Unexpected machine instuction.");
3130d1468dbSSam Parker   return InstIds.lookup(MI) - getReachingDef(MI, PhysReg);
3140bf841acSMarina Yatsina }
315cced971fSSam Parker 
316ac30ea2fSSam Parker bool
317ac30ea2fSSam Parker ReachingDefAnalysis::hasLocalDefBefore(MachineInstr *MI, int PhysReg) const {
318ac30ea2fSSam Parker   return getReachingDef(MI, PhysReg) >= 0;
319ac30ea2fSSam Parker }
320ac30ea2fSSam Parker 
32128166816SSam Parker void ReachingDefAnalysis::getReachingLocalUses(MachineInstr *Def, int PhysReg,
3227ad879caSSam Parker                                                InstSet &Uses) const {
32328166816SSam Parker   MachineBasicBlock *MBB = Def->getParent();
32428166816SSam Parker   MachineBasicBlock::iterator MI = MachineBasicBlock::iterator(Def);
32528166816SSam Parker   while (++MI != MBB->end()) {
32605532575SSam Parker     if (MI->isDebugInstr())
32705532575SSam Parker       continue;
32805532575SSam Parker 
32928166816SSam Parker     // If/when we find a new reaching def, we know that there's no more uses
33028166816SSam Parker     // of 'Def'.
3311d06e75dSSam Parker     if (getReachingLocalMIDef(&*MI, PhysReg) != Def)
33228166816SSam Parker       return;
33328166816SSam Parker 
334acbc9aedSSam Parker     for (auto &MO : MI->operands()) {
335bf61421aSSam Parker       if (!isValidRegUseOf(MO, PhysReg))
336acbc9aedSSam Parker         continue;
337acbc9aedSSam Parker 
33842350cd8SSam Parker       Uses.insert(&*MI);
33928166816SSam Parker       if (MO.isKill())
34028166816SSam Parker         return;
34128166816SSam Parker     }
34228166816SSam Parker   }
34328166816SSam Parker }
34428166816SSam Parker 
3450d1468dbSSam Parker bool
3460d1468dbSSam Parker ReachingDefAnalysis::getLiveInUses(MachineBasicBlock *MBB, int PhysReg,
3477ad879caSSam Parker                                    InstSet &Uses) const {
3488f92f3c2SSam Parker   for (MachineInstr &MI :
3498f92f3c2SSam Parker        instructionsWithoutDebug(MBB->instr_begin(), MBB->instr_end())) {
35042350cd8SSam Parker     for (auto &MO : MI.operands()) {
351bf61421aSSam Parker       if (!isValidRegUseOf(MO, PhysReg))
35242350cd8SSam Parker         continue;
35342350cd8SSam Parker       if (getReachingDef(&MI, PhysReg) >= 0)
35442350cd8SSam Parker         return false;
35542350cd8SSam Parker       Uses.insert(&MI);
35642350cd8SSam Parker     }
35742350cd8SSam Parker   }
3588f92f3c2SSam Parker   MachineInstr *Last = &*MBB->getLastNonDebugInstr();
3598f92f3c2SSam Parker   return isReachingDefLiveOut(Last, PhysReg);
36042350cd8SSam Parker }
36142350cd8SSam Parker 
3620d1468dbSSam Parker void
3630d1468dbSSam Parker ReachingDefAnalysis::getGlobalUses(MachineInstr *MI, int PhysReg,
3647ad879caSSam Parker                                    InstSet &Uses) const {
36542350cd8SSam Parker   MachineBasicBlock *MBB = MI->getParent();
36642350cd8SSam Parker 
36742350cd8SSam Parker   // Collect the uses that each def touches within the block.
36842350cd8SSam Parker   getReachingLocalUses(MI, PhysReg, Uses);
36942350cd8SSam Parker 
37042350cd8SSam Parker   // Handle live-out values.
37142350cd8SSam Parker   if (auto *LiveOut = getLocalLiveOutMIDef(MI->getParent(), PhysReg)) {
37242350cd8SSam Parker     if (LiveOut != MI)
37342350cd8SSam Parker       return;
37442350cd8SSam Parker 
37542350cd8SSam Parker     SmallVector<MachineBasicBlock*, 4> ToVisit;
37642350cd8SSam Parker     ToVisit.insert(ToVisit.begin(), MBB->successors().begin(),
37742350cd8SSam Parker                    MBB->successors().end());
37842350cd8SSam Parker     SmallPtrSet<MachineBasicBlock*, 4>Visited;
37942350cd8SSam Parker     while (!ToVisit.empty()) {
38042350cd8SSam Parker       MachineBasicBlock *MBB = ToVisit.back();
38142350cd8SSam Parker       ToVisit.pop_back();
38242350cd8SSam Parker       if (Visited.count(MBB) || !MBB->isLiveIn(PhysReg))
38342350cd8SSam Parker         continue;
38442350cd8SSam Parker       if (getLiveInUses(MBB, PhysReg, Uses))
38542350cd8SSam Parker         ToVisit.insert(ToVisit.end(), MBB->successors().begin(),
38642350cd8SSam Parker                        MBB->successors().end());
38742350cd8SSam Parker       Visited.insert(MBB);
38842350cd8SSam Parker     }
38942350cd8SSam Parker   }
390cced971fSSam Parker }
391cced971fSSam Parker 
392b30adfb5SSam Parker void
393b30adfb5SSam Parker ReachingDefAnalysis::getGlobalReachingDefs(MachineInstr *MI, int PhysReg,
394b30adfb5SSam Parker                                            InstSet &Defs) const {
395b30adfb5SSam Parker   if (auto *Def = getUniqueReachingMIDef(MI, PhysReg)) {
396b30adfb5SSam Parker     Defs.insert(Def);
397b30adfb5SSam Parker     return;
398b30adfb5SSam Parker   }
399b30adfb5SSam Parker 
400b30adfb5SSam Parker   for (auto *MBB : MI->getParent()->predecessors())
401b30adfb5SSam Parker     getLiveOuts(MBB, PhysReg, Defs);
402b30adfb5SSam Parker }
403b30adfb5SSam Parker 
4043ee580d0SSam Parker void ReachingDefAnalysis::getLiveOuts(MachineBasicBlock *MBB, int PhysReg,
4053ee580d0SSam Parker                                       InstSet &Defs) const {
4063ee580d0SSam Parker   SmallPtrSet<MachineBasicBlock*, 2> VisitedBBs;
4073ee580d0SSam Parker   getLiveOuts(MBB, PhysReg, Defs, VisitedBBs);
4083ee580d0SSam Parker }
4093ee580d0SSam Parker 
4101d06e75dSSam Parker void
4111d06e75dSSam Parker ReachingDefAnalysis::getLiveOuts(MachineBasicBlock *MBB, int PhysReg,
4121d06e75dSSam Parker                                  InstSet &Defs, BlockSet &VisitedBBs) const {
4131d06e75dSSam Parker   if (VisitedBBs.count(MBB))
4141d06e75dSSam Parker     return;
4151d06e75dSSam Parker 
4161d06e75dSSam Parker   VisitedBBs.insert(MBB);
4171d06e75dSSam Parker   LivePhysRegs LiveRegs(*TRI);
4181d06e75dSSam Parker   LiveRegs.addLiveOuts(*MBB);
4191d06e75dSSam Parker   if (!LiveRegs.contains(PhysReg))
4201d06e75dSSam Parker     return;
4211d06e75dSSam Parker 
4221d06e75dSSam Parker   if (auto *Def = getLocalLiveOutMIDef(MBB, PhysReg))
4231d06e75dSSam Parker     Defs.insert(Def);
4241d06e75dSSam Parker   else
4251d06e75dSSam Parker     for (auto *Pred : MBB->predecessors())
4261d06e75dSSam Parker       getLiveOuts(Pred, PhysReg, Defs, VisitedBBs);
4271d06e75dSSam Parker }
4281d06e75dSSam Parker 
4291d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getUniqueReachingMIDef(MachineInstr *MI,
4301d06e75dSSam Parker                                                           int PhysReg) const {
4311d06e75dSSam Parker   // If there's a local def before MI, return it.
4321d06e75dSSam Parker   MachineInstr *LocalDef = getReachingLocalMIDef(MI, PhysReg);
4335618e9beSSam Parker   if (LocalDef && InstIds.lookup(LocalDef) < InstIds.lookup(MI))
4341d06e75dSSam Parker     return LocalDef;
4351d06e75dSSam Parker 
4361d06e75dSSam Parker   SmallPtrSet<MachineInstr*, 2> Incoming;
43785dd852aSSam Tebbs   MachineBasicBlock *Parent = MI->getParent();
43885dd852aSSam Tebbs   for (auto *Pred : Parent->predecessors())
4391c421046SSam Parker     getLiveOuts(Pred, PhysReg, Incoming);
4401d06e75dSSam Parker 
4411c421046SSam Parker   // Check that we have a single incoming value and that it does not
4421c421046SSam Parker   // come from the same block as MI - since it would mean that the def
4431c421046SSam Parker   // is executed after MI.
4441c421046SSam Parker   if (Incoming.size() == 1 && (*Incoming.begin())->getParent() != Parent)
4451d06e75dSSam Parker     return *Incoming.begin();
4461c421046SSam Parker   return nullptr;
4471d06e75dSSam Parker }
4481d06e75dSSam Parker 
4491d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getMIOperand(MachineInstr *MI,
4501d06e75dSSam Parker                                                 unsigned Idx) const {
4511d06e75dSSam Parker   assert(MI->getOperand(Idx).isReg() && "Expected register operand");
4521d06e75dSSam Parker   return getUniqueReachingMIDef(MI, MI->getOperand(Idx).getReg());
4531d06e75dSSam Parker }
4541d06e75dSSam Parker 
4551d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getMIOperand(MachineInstr *MI,
4561d06e75dSSam Parker                                                 MachineOperand &MO) const {
4571d06e75dSSam Parker   assert(MO.isReg() && "Expected register operand");
4581d06e75dSSam Parker   return getUniqueReachingMIDef(MI, MO.getReg());
4591d06e75dSSam Parker }
4601d06e75dSSam Parker 
4610d1468dbSSam Parker bool ReachingDefAnalysis::isRegUsedAfter(MachineInstr *MI, int PhysReg) const {
462cced971fSSam Parker   MachineBasicBlock *MBB = MI->getParent();
463cced971fSSam Parker   LivePhysRegs LiveRegs(*TRI);
464cced971fSSam Parker   LiveRegs.addLiveOuts(*MBB);
465cced971fSSam Parker 
466cced971fSSam Parker   // Yes if the register is live out of the basic block.
467cced971fSSam Parker   if (LiveRegs.contains(PhysReg))
468cced971fSSam Parker     return true;
469cced971fSSam Parker 
470cced971fSSam Parker   // Walk backwards through the block to see if the register is live at some
471cced971fSSam Parker   // point.
4728f92f3c2SSam Parker   for (MachineInstr &Last :
4738f92f3c2SSam Parker        instructionsWithoutDebug(MBB->instr_rbegin(), MBB->instr_rend())) {
4748f92f3c2SSam Parker     LiveRegs.stepBackward(Last);
475cced971fSSam Parker     if (LiveRegs.contains(PhysReg))
4768f92f3c2SSam Parker       return InstIds.lookup(&Last) > InstIds.lookup(MI);
477cced971fSSam Parker   }
478cced971fSSam Parker   return false;
479cced971fSSam Parker }
480cced971fSSam Parker 
481ac30ea2fSSam Parker bool ReachingDefAnalysis::isRegDefinedAfter(MachineInstr *MI,
482ac30ea2fSSam Parker                                             int PhysReg) const {
483ac30ea2fSSam Parker   MachineBasicBlock *MBB = MI->getParent();
4848f92f3c2SSam Parker   MachineInstr *Last = &*MBB->getLastNonDebugInstr();
4858f92f3c2SSam Parker   if (getReachingDef(MI, PhysReg) != getReachingDef(Last, PhysReg))
486ac30ea2fSSam Parker     return true;
487ac30ea2fSSam Parker 
488ac30ea2fSSam Parker   if (auto *Def = getLocalLiveOutMIDef(MBB, PhysReg))
4891d06e75dSSam Parker     return Def == getReachingLocalMIDef(MI, PhysReg);
490ac30ea2fSSam Parker 
491ac30ea2fSSam Parker   return false;
492ac30ea2fSSam Parker }
493ac30ea2fSSam Parker 
4940d1468dbSSam Parker bool
4950d1468dbSSam Parker ReachingDefAnalysis::isReachingDefLiveOut(MachineInstr *MI, int PhysReg) const {
496acbc9aedSSam Parker   MachineBasicBlock *MBB = MI->getParent();
497acbc9aedSSam Parker   LivePhysRegs LiveRegs(*TRI);
498acbc9aedSSam Parker   LiveRegs.addLiveOuts(*MBB);
499acbc9aedSSam Parker   if (!LiveRegs.contains(PhysReg))
500acbc9aedSSam Parker     return false;
501acbc9aedSSam Parker 
5028f92f3c2SSam Parker   MachineInstr *Last = &*MBB->getLastNonDebugInstr();
503acbc9aedSSam Parker   int Def = getReachingDef(MI, PhysReg);
504acbc9aedSSam Parker   if (getReachingDef(Last, PhysReg) != Def)
505acbc9aedSSam Parker     return false;
506acbc9aedSSam Parker 
507acbc9aedSSam Parker   // Finally check that the last instruction doesn't redefine the register.
508acbc9aedSSam Parker   for (auto &MO : Last->operands())
509bf61421aSSam Parker     if (isValidRegDefOf(MO, PhysReg))
510acbc9aedSSam Parker       return false;
511acbc9aedSSam Parker 
512acbc9aedSSam Parker   return true;
513acbc9aedSSam Parker }
514acbc9aedSSam Parker 
515acbc9aedSSam Parker MachineInstr* ReachingDefAnalysis::getLocalLiveOutMIDef(MachineBasicBlock *MBB,
5160d1468dbSSam Parker                                                         int PhysReg) const {
517acbc9aedSSam Parker   LivePhysRegs LiveRegs(*TRI);
518acbc9aedSSam Parker   LiveRegs.addLiveOuts(*MBB);
519acbc9aedSSam Parker   if (!LiveRegs.contains(PhysReg))
520acbc9aedSSam Parker     return nullptr;
521acbc9aedSSam Parker 
5228f92f3c2SSam Parker   MachineInstr *Last = &*MBB->getLastNonDebugInstr();
523acbc9aedSSam Parker   int Def = getReachingDef(Last, PhysReg);
524acbc9aedSSam Parker   for (auto &MO : Last->operands())
525bf61421aSSam Parker     if (isValidRegDefOf(MO, PhysReg))
526acbc9aedSSam Parker       return Last;
527acbc9aedSSam Parker 
528acbc9aedSSam Parker   return Def < 0 ? nullptr : getInstFromId(MBB, Def);
529acbc9aedSSam Parker }
530ac30ea2fSSam Parker 
5310a8cae10SSam Parker static bool mayHaveSideEffects(MachineInstr &MI) {
5320a8cae10SSam Parker   return MI.mayLoadOrStore() || MI.mayRaiseFPException() ||
5330a8cae10SSam Parker          MI.hasUnmodeledSideEffects() || MI.isTerminator() ||
5340a8cae10SSam Parker          MI.isCall() || MI.isBarrier() || MI.isBranch() || MI.isReturn();
5350a8cae10SSam Parker }
5360a8cae10SSam Parker 
537ac30ea2fSSam Parker // Can we safely move 'From' to just before 'To'? To satisfy this, 'From' must
538ac30ea2fSSam Parker // not define a register that is used by any instructions, after and including,
539ac30ea2fSSam Parker // 'To'. These instructions also must not redefine any of Froms operands.
540ac30ea2fSSam Parker template<typename Iterator>
541ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMove(MachineInstr *From,
542ac30ea2fSSam Parker                                        MachineInstr *To) const {
543700f93e9SSam Parker   if (From->getParent() != To->getParent() || From == To)
544ac30ea2fSSam Parker     return false;
545ac30ea2fSSam Parker 
546ac30ea2fSSam Parker   SmallSet<int, 2> Defs;
547ac30ea2fSSam Parker   // First check that From would compute the same value if moved.
548ac30ea2fSSam Parker   for (auto &MO : From->operands()) {
549bf61421aSSam Parker     if (!isValidReg(MO))
550ac30ea2fSSam Parker       continue;
551ac30ea2fSSam Parker     if (MO.isDef())
552ac30ea2fSSam Parker       Defs.insert(MO.getReg());
553ac30ea2fSSam Parker     else if (!hasSameReachingDef(From, To, MO.getReg()))
554ac30ea2fSSam Parker       return false;
555ac30ea2fSSam Parker   }
556ac30ea2fSSam Parker 
557ac30ea2fSSam Parker   // Now walk checking that the rest of the instructions will compute the same
5580a8cae10SSam Parker   // value and that we're not overwriting anything. Don't move the instruction
55968b30bc0SCasey Carter   // past any memory, control-flow or other ambiguous instructions.
560ac30ea2fSSam Parker   for (auto I = ++Iterator(From), E = Iterator(To); I != E; ++I) {
5610a8cae10SSam Parker     if (mayHaveSideEffects(*I))
5620a8cae10SSam Parker       return false;
563ac30ea2fSSam Parker     for (auto &MO : I->operands())
5640a8cae10SSam Parker       if (MO.isReg() && MO.getReg() && Defs.count(MO.getReg()))
565ac30ea2fSSam Parker         return false;
566ac30ea2fSSam Parker   }
567ac30ea2fSSam Parker   return true;
568ac30ea2fSSam Parker }
569ac30ea2fSSam Parker 
570ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMoveForwards(MachineInstr *From,
571ac30ea2fSSam Parker                                                MachineInstr *To) const {
572700f93e9SSam Parker   using Iterator = MachineBasicBlock::iterator;
573700f93e9SSam Parker   // Walk forwards until we find the instruction.
574700f93e9SSam Parker   for (auto I = Iterator(From), E = From->getParent()->end(); I != E; ++I)
575700f93e9SSam Parker     if (&*I == To)
576700f93e9SSam Parker       return isSafeToMove<Iterator>(From, To);
577700f93e9SSam Parker   return false;
578ac30ea2fSSam Parker }
579ac30ea2fSSam Parker 
580ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMoveBackwards(MachineInstr *From,
581ac30ea2fSSam Parker                                                 MachineInstr *To) const {
582700f93e9SSam Parker   using Iterator = MachineBasicBlock::reverse_iterator;
583700f93e9SSam Parker   // Walk backwards until we find the instruction.
584700f93e9SSam Parker   for (auto I = Iterator(From), E = From->getParent()->rend(); I != E; ++I)
585700f93e9SSam Parker     if (&*I == To)
586700f93e9SSam Parker       return isSafeToMove<Iterator>(From, To);
587700f93e9SSam Parker   return false;
588ac30ea2fSSam Parker }
589ac30ea2fSSam Parker 
590ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI,
591ac30ea2fSSam Parker                                          InstSet &ToRemove) const {
592ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 1> Ignore;
593ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 2> Visited;
594ac30ea2fSSam Parker   return isSafeToRemove(MI, Visited, ToRemove, Ignore);
595ac30ea2fSSam Parker }
596ac30ea2fSSam Parker 
597ac30ea2fSSam Parker bool
598ac30ea2fSSam Parker ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, InstSet &ToRemove,
599ac30ea2fSSam Parker                                     InstSet &Ignore) const {
600ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 2> Visited;
601ac30ea2fSSam Parker   return isSafeToRemove(MI, Visited, ToRemove, Ignore);
602ac30ea2fSSam Parker }
603ac30ea2fSSam Parker 
604ac30ea2fSSam Parker bool
605ac30ea2fSSam Parker ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, InstSet &Visited,
606ac30ea2fSSam Parker                                     InstSet &ToRemove, InstSet &Ignore) const {
607ac30ea2fSSam Parker   if (Visited.count(MI) || Ignore.count(MI))
608ac30ea2fSSam Parker     return true;
6090a8cae10SSam Parker   else if (mayHaveSideEffects(*MI)) {
610ac30ea2fSSam Parker     // Unless told to ignore the instruction, don't remove anything which has
611ac30ea2fSSam Parker     // side effects.
612ac30ea2fSSam Parker     return false;
613ac30ea2fSSam Parker   }
614ac30ea2fSSam Parker 
615ac30ea2fSSam Parker   Visited.insert(MI);
616ac30ea2fSSam Parker   for (auto &MO : MI->operands()) {
617bf61421aSSam Parker     if (!isValidRegDef(MO))
618ac30ea2fSSam Parker       continue;
619ac30ea2fSSam Parker 
620ac30ea2fSSam Parker     SmallPtrSet<MachineInstr*, 4> Uses;
621ac30ea2fSSam Parker     getGlobalUses(MI, MO.getReg(), Uses);
622ac30ea2fSSam Parker 
623ac30ea2fSSam Parker     for (auto I : Uses) {
624ac30ea2fSSam Parker       if (Ignore.count(I) || ToRemove.count(I))
625ac30ea2fSSam Parker         continue;
626ac30ea2fSSam Parker       if (!isSafeToRemove(I, Visited, ToRemove, Ignore))
627ac30ea2fSSam Parker         return false;
628ac30ea2fSSam Parker     }
629ac30ea2fSSam Parker   }
630ac30ea2fSSam Parker   ToRemove.insert(MI);
631ac30ea2fSSam Parker   return true;
632ac30ea2fSSam Parker }
633ac30ea2fSSam Parker 
6345618e9beSSam Parker void ReachingDefAnalysis::collectKilledOperands(MachineInstr *MI,
635a67eb221SSam Parker                                                 InstSet &Dead) const {
636a67eb221SSam Parker   Dead.insert(MI);
637dfe8f5daSSam Parker   auto IsDead = [this, &Dead](MachineInstr *Def, int PhysReg) {
638*779a8a02SSam Parker     if (mayHaveSideEffects(*Def))
639*779a8a02SSam Parker       return false;
640*779a8a02SSam Parker 
641a67eb221SSam Parker     unsigned LiveDefs = 0;
642bf61421aSSam Parker     for (auto &MO : Def->operands()) {
643bf61421aSSam Parker       if (!isValidRegDef(MO))
644bf61421aSSam Parker         continue;
645a67eb221SSam Parker       if (!MO.isDead())
646a67eb221SSam Parker         ++LiveDefs;
647bf61421aSSam Parker     }
648a67eb221SSam Parker 
649a67eb221SSam Parker     if (LiveDefs > 1)
650a67eb221SSam Parker       return false;
651a67eb221SSam Parker 
652a67eb221SSam Parker     SmallPtrSet<MachineInstr*, 4> Uses;
653a67eb221SSam Parker     getGlobalUses(Def, PhysReg, Uses);
654dfe8f5daSSam Parker     for (auto *Use : Uses)
655dfe8f5daSSam Parker       if (!Dead.count(Use))
656dfe8f5daSSam Parker         return false;
657dfe8f5daSSam Parker     return true;
658a67eb221SSam Parker   };
659a67eb221SSam Parker 
660bf61421aSSam Parker   for (auto &MO : MI->operands()) {
6615618e9beSSam Parker     if (!isValidRegUse(MO))
662a67eb221SSam Parker       continue;
6635618e9beSSam Parker     if (MachineInstr *Def = getMIOperand(MI, MO))
664a67eb221SSam Parker       if (IsDead(Def, MO.getReg()))
6655618e9beSSam Parker         collectKilledOperands(Def, Dead);
666a67eb221SSam Parker   }
667a67eb221SSam Parker }
668a67eb221SSam Parker 
669ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToDefRegAt(MachineInstr *MI,
670ac30ea2fSSam Parker                                            int PhysReg) const {
671ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 1> Ignore;
672ac30ea2fSSam Parker   return isSafeToDefRegAt(MI, PhysReg, Ignore);
673ac30ea2fSSam Parker }
674ac30ea2fSSam Parker 
675ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToDefRegAt(MachineInstr *MI, int PhysReg,
676ac30ea2fSSam Parker                                            InstSet &Ignore) const {
677ac30ea2fSSam Parker   // Check for any uses of the register after MI.
678ac30ea2fSSam Parker   if (isRegUsedAfter(MI, PhysReg)) {
6791d06e75dSSam Parker     if (auto *Def = getReachingLocalMIDef(MI, PhysReg)) {
680ac30ea2fSSam Parker       SmallPtrSet<MachineInstr*, 2> Uses;
681ac30ea2fSSam Parker       getReachingLocalUses(Def, PhysReg, Uses);
682ac30ea2fSSam Parker       for (auto *Use : Uses)
683ac30ea2fSSam Parker         if (!Ignore.count(Use))
684ac30ea2fSSam Parker           return false;
685ac30ea2fSSam Parker     } else
686ac30ea2fSSam Parker       return false;
687ac30ea2fSSam Parker   }
688ac30ea2fSSam Parker 
689ac30ea2fSSam Parker   MachineBasicBlock *MBB = MI->getParent();
690ac30ea2fSSam Parker   // Check for any defs after MI.
691ac30ea2fSSam Parker   if (isRegDefinedAfter(MI, PhysReg)) {
692ac30ea2fSSam Parker     auto I = MachineBasicBlock::iterator(MI);
693ac30ea2fSSam Parker     for (auto E = MBB->end(); I != E; ++I) {
694ac30ea2fSSam Parker       if (Ignore.count(&*I))
695ac30ea2fSSam Parker         continue;
696ac30ea2fSSam Parker       for (auto &MO : I->operands())
697bf61421aSSam Parker         if (isValidRegDefOf(MO, PhysReg))
698ac30ea2fSSam Parker           return false;
699ac30ea2fSSam Parker     }
700ac30ea2fSSam Parker   }
701ac30ea2fSSam Parker   return true;
702ac30ea2fSSam Parker }
703