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.
146259649a5SNikita Popov   int NumInsts = 0;
147259649a5SNikita Popov   for (const MachineInstr &MI : *MBB)
148259649a5SNikita Popov     if (!MI.isDebugInstr())
149259649a5SNikita Popov       NumInsts++;
150259649a5SNikita Popov 
151259649a5SNikita Popov   // When reprocessing a block, the only thing we need to do is check whether
152259649a5SNikita Popov   // there is now a more recent incoming reaching definition from a predecessor.
153259649a5SNikita Popov   for (MachineBasicBlock *pred : MBB->predecessors()) {
154259649a5SNikita Popov     assert(unsigned(pred->getNumber()) < MBBOutRegsInfos.size() &&
155259649a5SNikita Popov            "Should have pre-allocated MBBInfos for all MBBs");
156259649a5SNikita Popov     const LiveRegsDefInfo &Incoming = MBBOutRegsInfos[pred->getNumber()];
157259649a5SNikita Popov     // Incoming may be empty for dead predecessors.
158259649a5SNikita Popov     if (Incoming.empty())
159259649a5SNikita Popov       continue;
160259649a5SNikita Popov 
161259649a5SNikita Popov     for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit) {
162259649a5SNikita Popov       int Def = Incoming[Unit];
163259649a5SNikita Popov       if (Def == ReachingDefDefaultVal)
164259649a5SNikita Popov         continue;
165259649a5SNikita Popov 
166259649a5SNikita Popov       auto Start = MBBReachingDefs[MBBNumber][Unit].begin();
167259649a5SNikita Popov       if (Start != MBBReachingDefs[MBBNumber][Unit].end() && *Start < 0) {
168259649a5SNikita Popov         if (*Start >= Def)
169259649a5SNikita Popov           continue;
170259649a5SNikita Popov 
171259649a5SNikita Popov         // Update existing reaching def from predecessor to a more recent one.
172259649a5SNikita Popov         *Start = Def;
173259649a5SNikita Popov       } else {
174259649a5SNikita Popov         // Insert new reaching def from predecessor.
175259649a5SNikita Popov         MBBReachingDefs[MBBNumber][Unit].insert(Start, Def);
176259649a5SNikita Popov       }
177259649a5SNikita Popov 
178259649a5SNikita Popov       // Update reaching def at end of of BB. Keep in mind that these are
179259649a5SNikita Popov       // adjusted relative to the end of the basic block.
180259649a5SNikita Popov       if (MBBOutRegsInfos[MBBNumber][Unit] < Def - NumInsts)
181259649a5SNikita Popov         MBBOutRegsInfos[MBBNumber][Unit] = Def - NumInsts;
182259649a5SNikita Popov     }
183259649a5SNikita Popov   }
184259649a5SNikita Popov }
185259649a5SNikita Popov 
1860bf841acSMarina Yatsina void ReachingDefAnalysis::processBasicBlock(
1870bf841acSMarina Yatsina     const LoopTraversal::TraversedMBBInfo &TraversedMBB) {
18876e987b3SNikita Popov   MachineBasicBlock *MBB = TraversedMBB.MBB;
18976e987b3SNikita Popov   LLVM_DEBUG(dbgs() << printMBBReference(*MBB)
19076e987b3SNikita Popov                     << (!TraversedMBB.IsDone ? ": incomplete\n"
19176e987b3SNikita Popov                                              : ": all preds known\n"));
19276e987b3SNikita Popov 
193259649a5SNikita Popov   if (!TraversedMBB.PrimaryPass) {
194259649a5SNikita Popov     // Reprocess MBB that is part of a loop.
195259649a5SNikita Popov     reprocessBasicBlock(MBB);
196259649a5SNikita Popov     return;
197259649a5SNikita Popov   }
198259649a5SNikita Popov 
19976e987b3SNikita Popov   enterBasicBlock(MBB);
20076e987b3SNikita Popov   for (MachineInstr &MI : *MBB) {
201801bf7ebSShiva Chen     if (!MI.isDebugInstr())
2020bf841acSMarina Yatsina       processDefs(&MI);
2030bf841acSMarina Yatsina   }
20476e987b3SNikita Popov   leaveBasicBlock(MBB);
2050bf841acSMarina Yatsina }
2060bf841acSMarina Yatsina 
2070bf841acSMarina Yatsina bool ReachingDefAnalysis::runOnMachineFunction(MachineFunction &mf) {
2080bf841acSMarina Yatsina   MF = &mf;
2090bf841acSMarina Yatsina   TRI = MF->getSubtarget().getRegisterInfo();
210d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "********** REACHING DEFINITION ANALYSIS **********\n");
211659500c0SSam Parker   init();
212659500c0SSam Parker   traverse();
2130bf841acSMarina Yatsina   return false;
2140bf841acSMarina Yatsina }
2150bf841acSMarina Yatsina 
2160bf841acSMarina Yatsina void ReachingDefAnalysis::releaseMemory() {
2170bf841acSMarina Yatsina   // Clear the internal vectors.
2180bf841acSMarina Yatsina   MBBOutRegsInfos.clear();
2190bf841acSMarina Yatsina   MBBReachingDefs.clear();
2200bf841acSMarina Yatsina   InstIds.clear();
221659500c0SSam Parker   LiveRegs.clear();
222659500c0SSam Parker }
223659500c0SSam Parker 
224659500c0SSam Parker void ReachingDefAnalysis::reset() {
225659500c0SSam Parker   releaseMemory();
226659500c0SSam Parker   init();
227659500c0SSam Parker   traverse();
228659500c0SSam Parker }
229659500c0SSam Parker 
230659500c0SSam Parker void ReachingDefAnalysis::init() {
231659500c0SSam Parker   NumRegUnits = TRI->getNumRegUnits();
232659500c0SSam Parker   MBBReachingDefs.resize(MF->getNumBlockIDs());
233659500c0SSam Parker   // Initialize the MBBOutRegsInfos
234659500c0SSam Parker   MBBOutRegsInfos.resize(MF->getNumBlockIDs());
235659500c0SSam Parker   LoopTraversal Traversal;
236659500c0SSam Parker   TraversedMBBOrder = Traversal.traverse(*MF);
237659500c0SSam Parker }
238659500c0SSam Parker 
239659500c0SSam Parker void ReachingDefAnalysis::traverse() {
240659500c0SSam Parker   // Traverse the basic blocks.
241659500c0SSam Parker   for (LoopTraversal::TraversedMBBInfo TraversedMBB : TraversedMBBOrder)
242659500c0SSam Parker     processBasicBlock(TraversedMBB);
243259649a5SNikita Popov #ifndef NDEBUG
244259649a5SNikita Popov   // Make sure reaching defs are sorted and unique.
245659500c0SSam Parker   for (MBBDefsInfo &MBBDefs : MBBReachingDefs) {
246259649a5SNikita Popov     for (MBBRegUnitDefs &RegUnitDefs : MBBDefs) {
247259649a5SNikita Popov       int LastDef = ReachingDefDefaultVal;
248259649a5SNikita Popov       for (int Def : RegUnitDefs) {
249259649a5SNikita Popov         assert(Def > LastDef && "Defs must be sorted and unique");
250259649a5SNikita Popov         LastDef = Def;
251659500c0SSam Parker       }
2520bf841acSMarina Yatsina     }
253259649a5SNikita Popov   }
254259649a5SNikita Popov #endif
255259649a5SNikita Popov }
2560bf841acSMarina Yatsina 
2570d1468dbSSam Parker int ReachingDefAnalysis::getReachingDef(MachineInstr *MI, int PhysReg) const {
2580bf841acSMarina Yatsina   assert(InstIds.count(MI) && "Unexpected machine instuction.");
2590d1468dbSSam Parker   int InstId = InstIds.lookup(MI);
2600f110a88SCraig Topper   int DefRes = ReachingDefDefaultVal;
261e4d63a49SMarina Yatsina   unsigned MBBNumber = MI->getParent()->getNumber();
2620bf841acSMarina Yatsina   assert(MBBNumber < MBBReachingDefs.size() &&
2630bf841acSMarina Yatsina          "Unexpected basic block number.");
2640f110a88SCraig Topper   int LatestDef = ReachingDefDefaultVal;
2650bf841acSMarina Yatsina   for (MCRegUnitIterator Unit(PhysReg, TRI); Unit.isValid(); ++Unit) {
2660bf841acSMarina Yatsina     for (int Def : MBBReachingDefs[MBBNumber][*Unit]) {
2670bf841acSMarina Yatsina       if (Def >= InstId)
2680bf841acSMarina Yatsina         break;
2690bf841acSMarina Yatsina       DefRes = Def;
2700bf841acSMarina Yatsina     }
2710bf841acSMarina Yatsina     LatestDef = std::max(LatestDef, DefRes);
2720bf841acSMarina Yatsina   }
2730bf841acSMarina Yatsina   return LatestDef;
2740bf841acSMarina Yatsina }
2750bf841acSMarina Yatsina 
2761d06e75dSSam Parker MachineInstr* ReachingDefAnalysis::getReachingLocalMIDef(MachineInstr *MI,
2770d1468dbSSam Parker                                                     int PhysReg) const {
278cced971fSSam Parker   return getInstFromId(MI->getParent(), getReachingDef(MI, PhysReg));
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 {
34842350cd8SSam Parker   for (auto &MI : *MBB) {
34905532575SSam Parker     if (MI.isDebugInstr())
35005532575SSam Parker       continue;
35142350cd8SSam Parker     for (auto &MO : MI.operands()) {
352bf61421aSSam Parker       if (!isValidRegUseOf(MO, PhysReg))
35342350cd8SSam Parker         continue;
35442350cd8SSam Parker       if (getReachingDef(&MI, PhysReg) >= 0)
35542350cd8SSam Parker         return false;
35642350cd8SSam Parker       Uses.insert(&MI);
35742350cd8SSam Parker     }
35842350cd8SSam Parker   }
35942350cd8SSam Parker   return isReachingDefLiveOut(&MBB->back(), 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 
3921d06e75dSSam Parker void
3931d06e75dSSam Parker ReachingDefAnalysis::getLiveOuts(MachineBasicBlock *MBB, int PhysReg,
3941d06e75dSSam Parker                                  InstSet &Defs, BlockSet &VisitedBBs) const {
3951d06e75dSSam Parker   if (VisitedBBs.count(MBB))
3961d06e75dSSam Parker     return;
3971d06e75dSSam Parker 
3981d06e75dSSam Parker   VisitedBBs.insert(MBB);
3991d06e75dSSam Parker   LivePhysRegs LiveRegs(*TRI);
4001d06e75dSSam Parker   LiveRegs.addLiveOuts(*MBB);
4011d06e75dSSam Parker   if (!LiveRegs.contains(PhysReg))
4021d06e75dSSam Parker     return;
4031d06e75dSSam Parker 
4041d06e75dSSam Parker   if (auto *Def = getLocalLiveOutMIDef(MBB, PhysReg))
4051d06e75dSSam Parker     Defs.insert(Def);
4061d06e75dSSam Parker   else
4071d06e75dSSam Parker     for (auto *Pred : MBB->predecessors())
4081d06e75dSSam Parker       getLiveOuts(Pred, PhysReg, Defs, VisitedBBs);
4091d06e75dSSam Parker }
4101d06e75dSSam Parker 
4111d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getUniqueReachingMIDef(MachineInstr *MI,
4121d06e75dSSam Parker                                                           int PhysReg) const {
4131d06e75dSSam Parker   // If there's a local def before MI, return it.
4141d06e75dSSam Parker   MachineInstr *LocalDef = getReachingLocalMIDef(MI, PhysReg);
4155618e9beSSam Parker   if (LocalDef && InstIds.lookup(LocalDef) < InstIds.lookup(MI))
4161d06e75dSSam Parker     return LocalDef;
4171d06e75dSSam Parker 
4181d06e75dSSam Parker   SmallPtrSet<MachineBasicBlock*, 4> VisitedBBs;
4191d06e75dSSam Parker   SmallPtrSet<MachineInstr*, 2> Incoming;
4201d06e75dSSam Parker   for (auto *Pred : MI->getParent()->predecessors())
4211d06e75dSSam Parker     getLiveOuts(Pred, PhysReg, Incoming, VisitedBBs);
4221d06e75dSSam Parker 
4231d06e75dSSam Parker   // If we have a local def and an incoming instruction, then there's not a
4241d06e75dSSam Parker   // unique instruction def.
4251d06e75dSSam Parker   if (!Incoming.empty() && LocalDef)
4261d06e75dSSam Parker     return nullptr;
4271d06e75dSSam Parker   else if (Incoming.size() == 1)
4281d06e75dSSam Parker     return *Incoming.begin();
4291d06e75dSSam Parker   else
4301d06e75dSSam Parker     return LocalDef;
4311d06e75dSSam Parker }
4321d06e75dSSam Parker 
4331d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getMIOperand(MachineInstr *MI,
4341d06e75dSSam Parker                                                 unsigned Idx) const {
4351d06e75dSSam Parker   assert(MI->getOperand(Idx).isReg() && "Expected register operand");
4361d06e75dSSam Parker   return getUniqueReachingMIDef(MI, MI->getOperand(Idx).getReg());
4371d06e75dSSam Parker }
4381d06e75dSSam Parker 
4391d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getMIOperand(MachineInstr *MI,
4401d06e75dSSam Parker                                                 MachineOperand &MO) const {
4411d06e75dSSam Parker   assert(MO.isReg() && "Expected register operand");
4421d06e75dSSam Parker   return getUniqueReachingMIDef(MI, MO.getReg());
4431d06e75dSSam Parker }
4441d06e75dSSam Parker 
4450d1468dbSSam Parker bool ReachingDefAnalysis::isRegUsedAfter(MachineInstr *MI, int PhysReg) const {
446cced971fSSam Parker   MachineBasicBlock *MBB = MI->getParent();
447cced971fSSam Parker   LivePhysRegs LiveRegs(*TRI);
448cced971fSSam Parker   LiveRegs.addLiveOuts(*MBB);
449cced971fSSam Parker 
450cced971fSSam Parker   // Yes if the register is live out of the basic block.
451cced971fSSam Parker   if (LiveRegs.contains(PhysReg))
452cced971fSSam Parker     return true;
453cced971fSSam Parker 
454cced971fSSam Parker   // Walk backwards through the block to see if the register is live at some
455cced971fSSam Parker   // point.
456cced971fSSam Parker   for (auto Last = MBB->rbegin(), End = MBB->rend(); Last != End; ++Last) {
457cced971fSSam Parker     LiveRegs.stepBackward(*Last);
458cced971fSSam Parker     if (LiveRegs.contains(PhysReg))
4590d1468dbSSam Parker       return InstIds.lookup(&*Last) > InstIds.lookup(MI);
460cced971fSSam Parker   }
461cced971fSSam Parker   return false;
462cced971fSSam Parker }
463cced971fSSam Parker 
464ac30ea2fSSam Parker bool ReachingDefAnalysis::isRegDefinedAfter(MachineInstr *MI,
465ac30ea2fSSam Parker                                             int PhysReg) const {
466ac30ea2fSSam Parker   MachineBasicBlock *MBB = MI->getParent();
467ac30ea2fSSam Parker   if (getReachingDef(MI, PhysReg) != getReachingDef(&MBB->back(), PhysReg))
468ac30ea2fSSam Parker     return true;
469ac30ea2fSSam Parker 
470ac30ea2fSSam Parker   if (auto *Def = getLocalLiveOutMIDef(MBB, PhysReg))
4711d06e75dSSam Parker     return Def == getReachingLocalMIDef(MI, PhysReg);
472ac30ea2fSSam Parker 
473ac30ea2fSSam Parker   return false;
474ac30ea2fSSam Parker }
475ac30ea2fSSam Parker 
4760d1468dbSSam Parker bool
4770d1468dbSSam Parker ReachingDefAnalysis::isReachingDefLiveOut(MachineInstr *MI, int PhysReg) const {
478acbc9aedSSam Parker   MachineBasicBlock *MBB = MI->getParent();
479acbc9aedSSam Parker   LivePhysRegs LiveRegs(*TRI);
480acbc9aedSSam Parker   LiveRegs.addLiveOuts(*MBB);
481acbc9aedSSam Parker   if (!LiveRegs.contains(PhysReg))
482acbc9aedSSam Parker     return false;
483acbc9aedSSam Parker 
484acbc9aedSSam Parker   MachineInstr *Last = &MBB->back();
485acbc9aedSSam Parker   int Def = getReachingDef(MI, PhysReg);
486acbc9aedSSam Parker   if (getReachingDef(Last, PhysReg) != Def)
487acbc9aedSSam Parker     return false;
488acbc9aedSSam Parker 
489acbc9aedSSam Parker   // Finally check that the last instruction doesn't redefine the register.
490acbc9aedSSam Parker   for (auto &MO : Last->operands())
491bf61421aSSam Parker     if (isValidRegDefOf(MO, PhysReg))
492acbc9aedSSam Parker       return false;
493acbc9aedSSam Parker 
494acbc9aedSSam Parker   return true;
495acbc9aedSSam Parker }
496acbc9aedSSam Parker 
497acbc9aedSSam Parker MachineInstr* ReachingDefAnalysis::getLocalLiveOutMIDef(MachineBasicBlock *MBB,
4980d1468dbSSam Parker                                                         int PhysReg) const {
499acbc9aedSSam Parker   LivePhysRegs LiveRegs(*TRI);
500acbc9aedSSam Parker   LiveRegs.addLiveOuts(*MBB);
501acbc9aedSSam Parker   if (!LiveRegs.contains(PhysReg))
502acbc9aedSSam Parker     return nullptr;
503acbc9aedSSam Parker 
504acbc9aedSSam Parker   MachineInstr *Last = &MBB->back();
505acbc9aedSSam Parker   int Def = getReachingDef(Last, PhysReg);
506acbc9aedSSam Parker   for (auto &MO : Last->operands())
507bf61421aSSam Parker     if (isValidRegDefOf(MO, PhysReg))
508acbc9aedSSam Parker       return Last;
509acbc9aedSSam Parker 
510acbc9aedSSam Parker   return Def < 0 ? nullptr : getInstFromId(MBB, Def);
511acbc9aedSSam Parker }
512ac30ea2fSSam Parker 
5130a8cae10SSam Parker static bool mayHaveSideEffects(MachineInstr &MI) {
5140a8cae10SSam Parker   return MI.mayLoadOrStore() || MI.mayRaiseFPException() ||
5150a8cae10SSam Parker          MI.hasUnmodeledSideEffects() || MI.isTerminator() ||
5160a8cae10SSam Parker          MI.isCall() || MI.isBarrier() || MI.isBranch() || MI.isReturn();
5170a8cae10SSam Parker }
5180a8cae10SSam Parker 
519ac30ea2fSSam Parker // Can we safely move 'From' to just before 'To'? To satisfy this, 'From' must
520ac30ea2fSSam Parker // not define a register that is used by any instructions, after and including,
521ac30ea2fSSam Parker // 'To'. These instructions also must not redefine any of Froms operands.
522ac30ea2fSSam Parker template<typename Iterator>
523ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMove(MachineInstr *From,
524ac30ea2fSSam Parker                                        MachineInstr *To) const {
525ac30ea2fSSam Parker   if (From->getParent() != To->getParent())
526ac30ea2fSSam Parker     return false;
527ac30ea2fSSam Parker 
528ac30ea2fSSam Parker   SmallSet<int, 2> Defs;
529ac30ea2fSSam Parker   // First check that From would compute the same value if moved.
530ac30ea2fSSam Parker   for (auto &MO : From->operands()) {
531bf61421aSSam Parker     if (!isValidReg(MO))
532ac30ea2fSSam Parker       continue;
533ac30ea2fSSam Parker     if (MO.isDef())
534ac30ea2fSSam Parker       Defs.insert(MO.getReg());
535ac30ea2fSSam Parker     else if (!hasSameReachingDef(From, To, MO.getReg()))
536ac30ea2fSSam Parker       return false;
537ac30ea2fSSam Parker   }
538ac30ea2fSSam Parker 
539ac30ea2fSSam Parker   // Now walk checking that the rest of the instructions will compute the same
5400a8cae10SSam Parker   // value and that we're not overwriting anything. Don't move the instruction
541*68b30bc0SCasey Carter   // past any memory, control-flow or other ambiguous instructions.
542ac30ea2fSSam Parker   for (auto I = ++Iterator(From), E = Iterator(To); I != E; ++I) {
5430a8cae10SSam Parker     if (mayHaveSideEffects(*I))
5440a8cae10SSam Parker       return false;
545ac30ea2fSSam Parker     for (auto &MO : I->operands())
5460a8cae10SSam Parker       if (MO.isReg() && MO.getReg() && Defs.count(MO.getReg()))
547ac30ea2fSSam Parker         return false;
548ac30ea2fSSam Parker   }
549ac30ea2fSSam Parker   return true;
550ac30ea2fSSam Parker }
551ac30ea2fSSam Parker 
552ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMoveForwards(MachineInstr *From,
553ac30ea2fSSam Parker                                                MachineInstr *To) const {
554ac30ea2fSSam Parker   return isSafeToMove<MachineBasicBlock::reverse_iterator>(From, To);
555ac30ea2fSSam Parker }
556ac30ea2fSSam Parker 
557ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMoveBackwards(MachineInstr *From,
558ac30ea2fSSam Parker                                                 MachineInstr *To) const {
559ac30ea2fSSam Parker   return isSafeToMove<MachineBasicBlock::iterator>(From, To);
560ac30ea2fSSam Parker }
561ac30ea2fSSam Parker 
562ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI,
563ac30ea2fSSam Parker                                          InstSet &ToRemove) const {
564ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 1> Ignore;
565ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 2> Visited;
566ac30ea2fSSam Parker   return isSafeToRemove(MI, Visited, ToRemove, Ignore);
567ac30ea2fSSam Parker }
568ac30ea2fSSam Parker 
569ac30ea2fSSam Parker bool
570ac30ea2fSSam Parker ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, InstSet &ToRemove,
571ac30ea2fSSam Parker                                     InstSet &Ignore) const {
572ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 2> Visited;
573ac30ea2fSSam Parker   return isSafeToRemove(MI, Visited, ToRemove, Ignore);
574ac30ea2fSSam Parker }
575ac30ea2fSSam Parker 
576ac30ea2fSSam Parker bool
577ac30ea2fSSam Parker ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, InstSet &Visited,
578ac30ea2fSSam Parker                                     InstSet &ToRemove, InstSet &Ignore) const {
579ac30ea2fSSam Parker   if (Visited.count(MI) || Ignore.count(MI))
580ac30ea2fSSam Parker     return true;
5810a8cae10SSam Parker   else if (mayHaveSideEffects(*MI)) {
582ac30ea2fSSam Parker     // Unless told to ignore the instruction, don't remove anything which has
583ac30ea2fSSam Parker     // side effects.
584ac30ea2fSSam Parker     return false;
585ac30ea2fSSam Parker   }
586ac30ea2fSSam Parker 
587ac30ea2fSSam Parker   Visited.insert(MI);
588ac30ea2fSSam Parker   for (auto &MO : MI->operands()) {
589bf61421aSSam Parker     if (!isValidRegDef(MO))
590ac30ea2fSSam Parker       continue;
591ac30ea2fSSam Parker 
592ac30ea2fSSam Parker     SmallPtrSet<MachineInstr*, 4> Uses;
593ac30ea2fSSam Parker     getGlobalUses(MI, MO.getReg(), Uses);
594ac30ea2fSSam Parker 
595ac30ea2fSSam Parker     for (auto I : Uses) {
596ac30ea2fSSam Parker       if (Ignore.count(I) || ToRemove.count(I))
597ac30ea2fSSam Parker         continue;
598ac30ea2fSSam Parker       if (!isSafeToRemove(I, Visited, ToRemove, Ignore))
599ac30ea2fSSam Parker         return false;
600ac30ea2fSSam Parker     }
601ac30ea2fSSam Parker   }
602ac30ea2fSSam Parker   ToRemove.insert(MI);
603ac30ea2fSSam Parker   return true;
604ac30ea2fSSam Parker }
605ac30ea2fSSam Parker 
6065618e9beSSam Parker void ReachingDefAnalysis::collectKilledOperands(MachineInstr *MI,
607a67eb221SSam Parker                                                 InstSet &Dead) const {
608a67eb221SSam Parker   Dead.insert(MI);
609dfe8f5daSSam Parker   auto IsDead = [this, &Dead](MachineInstr *Def, int PhysReg) {
610a67eb221SSam Parker     unsigned LiveDefs = 0;
611bf61421aSSam Parker     for (auto &MO : Def->operands()) {
612bf61421aSSam Parker       if (!isValidRegDef(MO))
613bf61421aSSam Parker         continue;
614a67eb221SSam Parker       if (!MO.isDead())
615a67eb221SSam Parker         ++LiveDefs;
616bf61421aSSam Parker     }
617a67eb221SSam Parker 
618a67eb221SSam Parker     if (LiveDefs > 1)
619a67eb221SSam Parker       return false;
620a67eb221SSam Parker 
621a67eb221SSam Parker     SmallPtrSet<MachineInstr*, 4> Uses;
622a67eb221SSam Parker     getGlobalUses(Def, PhysReg, Uses);
623dfe8f5daSSam Parker     for (auto *Use : Uses)
624dfe8f5daSSam Parker       if (!Dead.count(Use))
625dfe8f5daSSam Parker         return false;
626dfe8f5daSSam Parker     return true;
627a67eb221SSam Parker   };
628a67eb221SSam Parker 
629bf61421aSSam Parker   for (auto &MO : MI->operands()) {
6305618e9beSSam Parker     if (!isValidRegUse(MO))
631a67eb221SSam Parker       continue;
6325618e9beSSam Parker     if (MachineInstr *Def = getMIOperand(MI, MO))
633a67eb221SSam Parker       if (IsDead(Def, MO.getReg()))
6345618e9beSSam Parker         collectKilledOperands(Def, Dead);
635a67eb221SSam Parker   }
636a67eb221SSam Parker }
637a67eb221SSam Parker 
638ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToDefRegAt(MachineInstr *MI,
639ac30ea2fSSam Parker                                            int PhysReg) const {
640ac30ea2fSSam Parker   SmallPtrSet<MachineInstr*, 1> Ignore;
641ac30ea2fSSam Parker   return isSafeToDefRegAt(MI, PhysReg, Ignore);
642ac30ea2fSSam Parker }
643ac30ea2fSSam Parker 
644ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToDefRegAt(MachineInstr *MI, int PhysReg,
645ac30ea2fSSam Parker                                            InstSet &Ignore) const {
646ac30ea2fSSam Parker   // Check for any uses of the register after MI.
647ac30ea2fSSam Parker   if (isRegUsedAfter(MI, PhysReg)) {
6481d06e75dSSam Parker     if (auto *Def = getReachingLocalMIDef(MI, PhysReg)) {
649ac30ea2fSSam Parker       SmallPtrSet<MachineInstr*, 2> Uses;
650ac30ea2fSSam Parker       getReachingLocalUses(Def, PhysReg, Uses);
651ac30ea2fSSam Parker       for (auto *Use : Uses)
652ac30ea2fSSam Parker         if (!Ignore.count(Use))
653ac30ea2fSSam Parker           return false;
654ac30ea2fSSam Parker     } else
655ac30ea2fSSam Parker       return false;
656ac30ea2fSSam Parker   }
657ac30ea2fSSam Parker 
658ac30ea2fSSam Parker   MachineBasicBlock *MBB = MI->getParent();
659ac30ea2fSSam Parker   // Check for any defs after MI.
660ac30ea2fSSam Parker   if (isRegDefinedAfter(MI, PhysReg)) {
661ac30ea2fSSam Parker     auto I = MachineBasicBlock::iterator(MI);
662ac30ea2fSSam Parker     for (auto E = MBB->end(); I != E; ++I) {
663ac30ea2fSSam Parker       if (Ignore.count(&*I))
664ac30ea2fSSam Parker         continue;
665ac30ea2fSSam Parker       for (auto &MO : I->operands())
666bf61421aSSam Parker         if (isValidRegDefOf(MO, PhysReg))
667ac30ea2fSSam Parker           return false;
668ac30ea2fSSam Parker     }
669ac30ea2fSSam Parker   }
670ac30ea2fSSam Parker   return true;
671ac30ea2fSSam Parker }
672