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" 10d6391209SKazu Hirata #include "llvm/ADT/SetOperations.h" 11cced971fSSam Parker #include "llvm/CodeGen/LivePhysRegs.h" 120bf841acSMarina Yatsina #include "llvm/CodeGen/ReachingDefAnalysis.h" 130bf841acSMarina Yatsina #include "llvm/CodeGen/TargetRegisterInfo.h" 140bf841acSMarina Yatsina #include "llvm/CodeGen/TargetSubtargetInfo.h" 151d7b4136SReid Kleckner #include "llvm/Support/Debug.h" 160bf841acSMarina Yatsina 170bf841acSMarina Yatsina using namespace llvm; 180bf841acSMarina Yatsina 190bf841acSMarina Yatsina #define DEBUG_TYPE "reaching-deps-analysis" 200bf841acSMarina Yatsina 210bf841acSMarina Yatsina char ReachingDefAnalysis::ID = 0; 220bf841acSMarina Yatsina INITIALIZE_PASS(ReachingDefAnalysis, DEBUG_TYPE, "ReachingDefAnalysis", false, 230bf841acSMarina Yatsina true) 240bf841acSMarina Yatsina 25247a177cSBenjamin Kramer static bool isValidReg(const MachineOperand &MO) { 26bf61421aSSam Parker return MO.isReg() && MO.getReg(); 27bf61421aSSam Parker } 28bf61421aSSam Parker 29247a177cSBenjamin Kramer static bool isValidRegUse(const MachineOperand &MO) { 30bf61421aSSam Parker return isValidReg(MO) && MO.isUse(); 31bf61421aSSam Parker } 32bf61421aSSam Parker 33e24537d4SMircea Trofin static bool isValidRegUseOf(const MachineOperand &MO, MCRegister PhysReg) { 34bf61421aSSam Parker return isValidRegUse(MO) && MO.getReg() == PhysReg; 35bf61421aSSam Parker } 36bf61421aSSam Parker 37247a177cSBenjamin Kramer static bool isValidRegDef(const MachineOperand &MO) { 38bf61421aSSam Parker return isValidReg(MO) && MO.isDef(); 39bf61421aSSam Parker } 40bf61421aSSam Parker 41e24537d4SMircea Trofin static bool isValidRegDefOf(const MachineOperand &MO, MCRegister PhysReg) { 42bf61421aSSam Parker return isValidRegDef(MO) && MO.getReg() == PhysReg; 43bf61421aSSam Parker } 44bf61421aSSam Parker 4576e987b3SNikita Popov void ReachingDefAnalysis::enterBasicBlock(MachineBasicBlock *MBB) { 46e4d63a49SMarina Yatsina unsigned MBBNumber = MBB->getNumber(); 470bf841acSMarina Yatsina assert(MBBNumber < MBBReachingDefs.size() && 480bf841acSMarina Yatsina "Unexpected basic block number."); 490bf841acSMarina Yatsina MBBReachingDefs[MBBNumber].resize(NumRegUnits); 500bf841acSMarina Yatsina 510bf841acSMarina Yatsina // Reset instruction counter in each basic block. 520bf841acSMarina Yatsina CurInstr = 0; 530bf841acSMarina Yatsina 540bf841acSMarina Yatsina // Set up LiveRegs to represent registers entering MBB. 550bf841acSMarina Yatsina // Default values are 'nothing happened a long time ago'. 560bf841acSMarina Yatsina if (LiveRegs.empty()) 570f110a88SCraig Topper LiveRegs.assign(NumRegUnits, ReachingDefDefaultVal); 580bf841acSMarina Yatsina 590bf841acSMarina Yatsina // This is the entry block. 600bf841acSMarina Yatsina if (MBB->pred_empty()) { 610bf841acSMarina Yatsina for (const auto &LI : MBB->liveins()) { 620bf841acSMarina Yatsina for (MCRegUnitIterator Unit(LI.PhysReg, TRI); Unit.isValid(); ++Unit) { 630bf841acSMarina Yatsina // Treat function live-ins as if they were defined just before the first 640bf841acSMarina Yatsina // instruction. Usually, function arguments are set up immediately 650bf841acSMarina Yatsina // before the call. 66361c29d7SNikita Popov if (LiveRegs[*Unit] != -1) { 670bf841acSMarina Yatsina LiveRegs[*Unit] = -1; 68361c29d7SNikita Popov MBBReachingDefs[MBBNumber][*Unit].push_back(-1); 69361c29d7SNikita Popov } 700bf841acSMarina Yatsina } 710bf841acSMarina Yatsina } 72d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << printMBBReference(*MBB) << ": entry\n"); 730bf841acSMarina Yatsina return; 740bf841acSMarina Yatsina } 750bf841acSMarina Yatsina 760bf841acSMarina Yatsina // Try to coalesce live-out registers from predecessors. 770bf841acSMarina Yatsina for (MachineBasicBlock *pred : MBB->predecessors()) { 78e4d63a49SMarina Yatsina assert(unsigned(pred->getNumber()) < MBBOutRegsInfos.size() && 790bf841acSMarina Yatsina "Should have pre-allocated MBBInfos for all MBBs"); 800bf841acSMarina Yatsina const LiveRegsDefInfo &Incoming = MBBOutRegsInfos[pred->getNumber()]; 810bf841acSMarina Yatsina // Incoming is null if this is a backedge from a BB 820bf841acSMarina Yatsina // we haven't processed yet 830bf841acSMarina Yatsina if (Incoming.empty()) 840bf841acSMarina Yatsina continue; 850bf841acSMarina Yatsina 86e8b83f7dSNikita Popov // Find the most recent reaching definition from a predecessor. 87e8b83f7dSNikita Popov for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit) 880bf841acSMarina Yatsina LiveRegs[Unit] = std::max(LiveRegs[Unit], Incoming[Unit]); 89e8b83f7dSNikita Popov } 90e8b83f7dSNikita Popov 91e8b83f7dSNikita Popov // Insert the most recent reaching definition we found. 92e8b83f7dSNikita Popov for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit) 93e8b83f7dSNikita Popov if (LiveRegs[Unit] != ReachingDefDefaultVal) 940bf841acSMarina Yatsina MBBReachingDefs[MBBNumber][Unit].push_back(LiveRegs[Unit]); 950bf841acSMarina Yatsina } 960bf841acSMarina Yatsina 9776e987b3SNikita Popov void ReachingDefAnalysis::leaveBasicBlock(MachineBasicBlock *MBB) { 980bf841acSMarina Yatsina assert(!LiveRegs.empty() && "Must enter basic block first."); 9976e987b3SNikita Popov unsigned MBBNumber = MBB->getNumber(); 1000bf841acSMarina Yatsina assert(MBBNumber < MBBOutRegsInfos.size() && 1010bf841acSMarina Yatsina "Unexpected basic block number."); 1020bf841acSMarina Yatsina // Save register clearances at end of MBB - used by enterBasicBlock(). 1030bf841acSMarina Yatsina MBBOutRegsInfos[MBBNumber] = LiveRegs; 1040bf841acSMarina Yatsina 1050bf841acSMarina Yatsina // While processing the basic block, we kept `Def` relative to the start 1060bf841acSMarina Yatsina // of the basic block for convenience. However, future use of this information 1070bf841acSMarina Yatsina // only cares about the clearance from the end of the block, so adjust 1080bf841acSMarina Yatsina // everything to be relative to the end of the basic block. 1090bf841acSMarina Yatsina for (int &OutLiveReg : MBBOutRegsInfos[MBBNumber]) 1108d75df14SNikita Popov if (OutLiveReg != ReachingDefDefaultVal) 1110bf841acSMarina Yatsina OutLiveReg -= CurInstr; 1120bf841acSMarina Yatsina LiveRegs.clear(); 1130bf841acSMarina Yatsina } 1140bf841acSMarina Yatsina 1150bf841acSMarina Yatsina void ReachingDefAnalysis::processDefs(MachineInstr *MI) { 116801bf7ebSShiva Chen assert(!MI->isDebugInstr() && "Won't process debug instructions"); 1170bf841acSMarina Yatsina 118e4d63a49SMarina Yatsina unsigned MBBNumber = MI->getParent()->getNumber(); 1190bf841acSMarina Yatsina assert(MBBNumber < MBBReachingDefs.size() && 1200bf841acSMarina Yatsina "Unexpected basic block number."); 121bf61421aSSam Parker 122bf61421aSSam Parker for (auto &MO : MI->operands()) { 123bf61421aSSam Parker if (!isValidRegDef(MO)) 1240bf841acSMarina Yatsina continue; 125e24537d4SMircea Trofin for (MCRegUnitIterator Unit(MO.getReg().asMCReg(), TRI); Unit.isValid(); 126e24537d4SMircea Trofin ++Unit) { 1270bf841acSMarina Yatsina // This instruction explicitly defines the current reg unit. 128*b3d38327SDavid Green LLVM_DEBUG(dbgs() << printRegUnit(*Unit, TRI) << ":\t" << CurInstr 129d34e60caSNicola Zaghen << '\t' << *MI); 1300bf841acSMarina Yatsina 1310bf841acSMarina Yatsina // How many instructions since this reg unit was last written? 132361c29d7SNikita Popov if (LiveRegs[*Unit] != CurInstr) { 1330bf841acSMarina Yatsina LiveRegs[*Unit] = CurInstr; 1340bf841acSMarina Yatsina MBBReachingDefs[MBBNumber][*Unit].push_back(CurInstr); 1350bf841acSMarina Yatsina } 1360bf841acSMarina Yatsina } 137361c29d7SNikita Popov } 1380bf841acSMarina Yatsina InstIds[MI] = CurInstr; 1390bf841acSMarina Yatsina ++CurInstr; 1400bf841acSMarina Yatsina } 1410bf841acSMarina Yatsina 142259649a5SNikita Popov void ReachingDefAnalysis::reprocessBasicBlock(MachineBasicBlock *MBB) { 143259649a5SNikita Popov unsigned MBBNumber = MBB->getNumber(); 144259649a5SNikita Popov assert(MBBNumber < MBBReachingDefs.size() && 145259649a5SNikita Popov "Unexpected basic block number."); 146259649a5SNikita Popov 147259649a5SNikita Popov // Count number of non-debug instructions for end of block adjustment. 1488f92f3c2SSam Parker auto NonDbgInsts = 1498f92f3c2SSam Parker instructionsWithoutDebug(MBB->instr_begin(), MBB->instr_end()); 1508f92f3c2SSam Parker int NumInsts = std::distance(NonDbgInsts.begin(), NonDbgInsts.end()); 151259649a5SNikita Popov 152259649a5SNikita Popov // When reprocessing a block, the only thing we need to do is check whether 153259649a5SNikita Popov // there is now a more recent incoming reaching definition from a predecessor. 154259649a5SNikita Popov for (MachineBasicBlock *pred : MBB->predecessors()) { 155259649a5SNikita Popov assert(unsigned(pred->getNumber()) < MBBOutRegsInfos.size() && 156259649a5SNikita Popov "Should have pre-allocated MBBInfos for all MBBs"); 157259649a5SNikita Popov const LiveRegsDefInfo &Incoming = MBBOutRegsInfos[pred->getNumber()]; 158259649a5SNikita Popov // Incoming may be empty for dead predecessors. 159259649a5SNikita Popov if (Incoming.empty()) 160259649a5SNikita Popov continue; 161259649a5SNikita Popov 162259649a5SNikita Popov for (unsigned Unit = 0; Unit != NumRegUnits; ++Unit) { 163259649a5SNikita Popov int Def = Incoming[Unit]; 164259649a5SNikita Popov if (Def == ReachingDefDefaultVal) 165259649a5SNikita Popov continue; 166259649a5SNikita Popov 167259649a5SNikita Popov auto Start = MBBReachingDefs[MBBNumber][Unit].begin(); 168259649a5SNikita Popov if (Start != MBBReachingDefs[MBBNumber][Unit].end() && *Start < 0) { 169259649a5SNikita Popov if (*Start >= Def) 170259649a5SNikita Popov continue; 171259649a5SNikita Popov 172259649a5SNikita Popov // Update existing reaching def from predecessor to a more recent one. 173259649a5SNikita Popov *Start = Def; 174259649a5SNikita Popov } else { 175259649a5SNikita Popov // Insert new reaching def from predecessor. 176259649a5SNikita Popov MBBReachingDefs[MBBNumber][Unit].insert(Start, Def); 177259649a5SNikita Popov } 178259649a5SNikita Popov 179259649a5SNikita Popov // Update reaching def at end of of BB. Keep in mind that these are 180259649a5SNikita Popov // adjusted relative to the end of the basic block. 181259649a5SNikita Popov if (MBBOutRegsInfos[MBBNumber][Unit] < Def - NumInsts) 182259649a5SNikita Popov MBBOutRegsInfos[MBBNumber][Unit] = Def - NumInsts; 183259649a5SNikita Popov } 184259649a5SNikita Popov } 185259649a5SNikita Popov } 186259649a5SNikita Popov 1870bf841acSMarina Yatsina void ReachingDefAnalysis::processBasicBlock( 1880bf841acSMarina Yatsina const LoopTraversal::TraversedMBBInfo &TraversedMBB) { 18976e987b3SNikita Popov MachineBasicBlock *MBB = TraversedMBB.MBB; 19076e987b3SNikita Popov LLVM_DEBUG(dbgs() << printMBBReference(*MBB) 19176e987b3SNikita Popov << (!TraversedMBB.IsDone ? ": incomplete\n" 19276e987b3SNikita Popov : ": all preds known\n")); 19376e987b3SNikita Popov 194259649a5SNikita Popov if (!TraversedMBB.PrimaryPass) { 195259649a5SNikita Popov // Reprocess MBB that is part of a loop. 196259649a5SNikita Popov reprocessBasicBlock(MBB); 197259649a5SNikita Popov return; 198259649a5SNikita Popov } 199259649a5SNikita Popov 20076e987b3SNikita Popov enterBasicBlock(MBB); 2018f92f3c2SSam Parker for (MachineInstr &MI : 2028f92f3c2SSam Parker instructionsWithoutDebug(MBB->instr_begin(), MBB->instr_end())) 2030bf841acSMarina Yatsina processDefs(&MI); 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 257e24537d4SMircea Trofin int ReachingDefAnalysis::getReachingDef(MachineInstr *MI, 258e24537d4SMircea Trofin MCRegister PhysReg) const { 2590bf841acSMarina Yatsina assert(InstIds.count(MI) && "Unexpected machine instuction."); 2600d1468dbSSam Parker int InstId = InstIds.lookup(MI); 2610f110a88SCraig Topper int DefRes = ReachingDefDefaultVal; 262e4d63a49SMarina Yatsina unsigned MBBNumber = MI->getParent()->getNumber(); 2630bf841acSMarina Yatsina assert(MBBNumber < MBBReachingDefs.size() && 2640bf841acSMarina Yatsina "Unexpected basic block number."); 2650f110a88SCraig Topper int LatestDef = ReachingDefDefaultVal; 2660bf841acSMarina Yatsina for (MCRegUnitIterator Unit(PhysReg, TRI); Unit.isValid(); ++Unit) { 2670bf841acSMarina Yatsina for (int Def : MBBReachingDefs[MBBNumber][*Unit]) { 2680bf841acSMarina Yatsina if (Def >= InstId) 2690bf841acSMarina Yatsina break; 2700bf841acSMarina Yatsina DefRes = Def; 2710bf841acSMarina Yatsina } 2720bf841acSMarina Yatsina LatestDef = std::max(LatestDef, DefRes); 2730bf841acSMarina Yatsina } 2740bf841acSMarina Yatsina return LatestDef; 2750bf841acSMarina Yatsina } 2760bf841acSMarina Yatsina 277e24537d4SMircea Trofin MachineInstr * 278e24537d4SMircea Trofin ReachingDefAnalysis::getReachingLocalMIDef(MachineInstr *MI, 279e24537d4SMircea Trofin MCRegister PhysReg) const { 28085a5c65fSSam Parker return hasLocalDefBefore(MI, PhysReg) 28185a5c65fSSam Parker ? getInstFromId(MI->getParent(), getReachingDef(MI, PhysReg)) 28285a5c65fSSam Parker : nullptr; 283cced971fSSam Parker } 284cced971fSSam Parker 28528166816SSam Parker bool ReachingDefAnalysis::hasSameReachingDef(MachineInstr *A, MachineInstr *B, 286e24537d4SMircea Trofin MCRegister PhysReg) const { 28728166816SSam Parker MachineBasicBlock *ParentA = A->getParent(); 28828166816SSam Parker MachineBasicBlock *ParentB = B->getParent(); 28928166816SSam Parker if (ParentA != ParentB) 29028166816SSam Parker return false; 29128166816SSam Parker 29228166816SSam Parker return getReachingDef(A, PhysReg) == getReachingDef(B, PhysReg); 29328166816SSam Parker } 29428166816SSam Parker 295cced971fSSam Parker MachineInstr *ReachingDefAnalysis::getInstFromId(MachineBasicBlock *MBB, 2960d1468dbSSam Parker int InstId) const { 29728166816SSam Parker assert(static_cast<size_t>(MBB->getNumber()) < MBBReachingDefs.size() && 298cced971fSSam Parker "Unexpected basic block number."); 299cced971fSSam Parker assert(InstId < static_cast<int>(MBB->size()) && 300cced971fSSam Parker "Unexpected instruction id."); 301cced971fSSam Parker 302cced971fSSam Parker if (InstId < 0) 303cced971fSSam Parker return nullptr; 304cced971fSSam Parker 305cced971fSSam Parker for (auto &MI : *MBB) { 30693b0536fSSjoerd Meijer auto F = InstIds.find(&MI); 30793b0536fSSjoerd Meijer if (F != InstIds.end() && F->second == InstId) 308cced971fSSam Parker return &MI; 309cced971fSSam Parker } 31093b0536fSSjoerd Meijer 311cced971fSSam Parker return nullptr; 312cced971fSSam Parker } 313cced971fSSam Parker 314e24537d4SMircea Trofin int ReachingDefAnalysis::getClearance(MachineInstr *MI, 315e24537d4SMircea Trofin MCRegister PhysReg) const { 3160bf841acSMarina Yatsina assert(InstIds.count(MI) && "Unexpected machine instuction."); 3170d1468dbSSam Parker return InstIds.lookup(MI) - getReachingDef(MI, PhysReg); 3180bf841acSMarina Yatsina } 319cced971fSSam Parker 320e24537d4SMircea Trofin bool ReachingDefAnalysis::hasLocalDefBefore(MachineInstr *MI, 321e24537d4SMircea Trofin MCRegister PhysReg) const { 322ac30ea2fSSam Parker return getReachingDef(MI, PhysReg) >= 0; 323ac30ea2fSSam Parker } 324ac30ea2fSSam Parker 325e24537d4SMircea Trofin void ReachingDefAnalysis::getReachingLocalUses(MachineInstr *Def, 326e24537d4SMircea Trofin MCRegister PhysReg, 3277ad879caSSam Parker InstSet &Uses) const { 32828166816SSam Parker MachineBasicBlock *MBB = Def->getParent(); 32928166816SSam Parker MachineBasicBlock::iterator MI = MachineBasicBlock::iterator(Def); 33028166816SSam Parker while (++MI != MBB->end()) { 33105532575SSam Parker if (MI->isDebugInstr()) 33205532575SSam Parker continue; 33305532575SSam Parker 33428166816SSam Parker // If/when we find a new reaching def, we know that there's no more uses 33528166816SSam Parker // of 'Def'. 3361d06e75dSSam Parker if (getReachingLocalMIDef(&*MI, PhysReg) != Def) 33728166816SSam Parker return; 33828166816SSam Parker 339acbc9aedSSam Parker for (auto &MO : MI->operands()) { 340bf61421aSSam Parker if (!isValidRegUseOf(MO, PhysReg)) 341acbc9aedSSam Parker continue; 342acbc9aedSSam Parker 34342350cd8SSam Parker Uses.insert(&*MI); 34428166816SSam Parker if (MO.isKill()) 34528166816SSam Parker return; 34628166816SSam Parker } 34728166816SSam Parker } 34828166816SSam Parker } 34928166816SSam Parker 350e24537d4SMircea Trofin bool ReachingDefAnalysis::getLiveInUses(MachineBasicBlock *MBB, 351e24537d4SMircea Trofin MCRegister PhysReg, 3527ad879caSSam Parker InstSet &Uses) const { 3538f92f3c2SSam Parker for (MachineInstr &MI : 3548f92f3c2SSam Parker instructionsWithoutDebug(MBB->instr_begin(), MBB->instr_end())) { 35542350cd8SSam Parker for (auto &MO : MI.operands()) { 356bf61421aSSam Parker if (!isValidRegUseOf(MO, PhysReg)) 35742350cd8SSam Parker continue; 35842350cd8SSam Parker if (getReachingDef(&MI, PhysReg) >= 0) 35942350cd8SSam Parker return false; 36042350cd8SSam Parker Uses.insert(&MI); 36142350cd8SSam Parker } 36242350cd8SSam Parker } 363cb27006aSDavid Green auto Last = MBB->getLastNonDebugInstr(); 364cb27006aSDavid Green if (Last == MBB->end()) 365cb27006aSDavid Green return true; 366cb27006aSDavid Green return isReachingDefLiveOut(&*Last, PhysReg); 36742350cd8SSam Parker } 36842350cd8SSam Parker 369e24537d4SMircea Trofin void ReachingDefAnalysis::getGlobalUses(MachineInstr *MI, MCRegister PhysReg, 3707ad879caSSam Parker InstSet &Uses) const { 37142350cd8SSam Parker MachineBasicBlock *MBB = MI->getParent(); 37242350cd8SSam Parker 37342350cd8SSam Parker // Collect the uses that each def touches within the block. 37442350cd8SSam Parker getReachingLocalUses(MI, PhysReg, Uses); 37542350cd8SSam Parker 37642350cd8SSam Parker // Handle live-out values. 37742350cd8SSam Parker if (auto *LiveOut = getLocalLiveOutMIDef(MI->getParent(), PhysReg)) { 37842350cd8SSam Parker if (LiveOut != MI) 37942350cd8SSam Parker return; 38042350cd8SSam Parker 3817bc76fd0SKazu Hirata SmallVector<MachineBasicBlock *, 4> ToVisit(MBB->successors()); 38242350cd8SSam Parker SmallPtrSet<MachineBasicBlock*, 4>Visited; 38342350cd8SSam Parker while (!ToVisit.empty()) { 38442350cd8SSam Parker MachineBasicBlock *MBB = ToVisit.back(); 38542350cd8SSam Parker ToVisit.pop_back(); 38642350cd8SSam Parker if (Visited.count(MBB) || !MBB->isLiveIn(PhysReg)) 38742350cd8SSam Parker continue; 38842350cd8SSam Parker if (getLiveInUses(MBB, PhysReg, Uses)) 3891e3ed091SKazu Hirata llvm::append_range(ToVisit, MBB->successors()); 39042350cd8SSam Parker Visited.insert(MBB); 39142350cd8SSam Parker } 39242350cd8SSam Parker } 393cced971fSSam Parker } 394cced971fSSam Parker 395e24537d4SMircea Trofin void ReachingDefAnalysis::getGlobalReachingDefs(MachineInstr *MI, 396e24537d4SMircea Trofin MCRegister PhysReg, 397b30adfb5SSam Parker InstSet &Defs) const { 398b30adfb5SSam Parker if (auto *Def = getUniqueReachingMIDef(MI, PhysReg)) { 399b30adfb5SSam Parker Defs.insert(Def); 400b30adfb5SSam Parker return; 401b30adfb5SSam Parker } 402b30adfb5SSam Parker 403b30adfb5SSam Parker for (auto *MBB : MI->getParent()->predecessors()) 404b30adfb5SSam Parker getLiveOuts(MBB, PhysReg, Defs); 405b30adfb5SSam Parker } 406b30adfb5SSam Parker 407e24537d4SMircea Trofin void ReachingDefAnalysis::getLiveOuts(MachineBasicBlock *MBB, 408e24537d4SMircea Trofin MCRegister PhysReg, InstSet &Defs) const { 4093ee580d0SSam Parker SmallPtrSet<MachineBasicBlock*, 2> VisitedBBs; 4103ee580d0SSam Parker getLiveOuts(MBB, PhysReg, Defs, VisitedBBs); 4113ee580d0SSam Parker } 4123ee580d0SSam Parker 413e24537d4SMircea Trofin void ReachingDefAnalysis::getLiveOuts(MachineBasicBlock *MBB, 414e24537d4SMircea Trofin MCRegister PhysReg, InstSet &Defs, 415e24537d4SMircea Trofin BlockSet &VisitedBBs) const { 4161d06e75dSSam Parker if (VisitedBBs.count(MBB)) 4171d06e75dSSam Parker return; 4181d06e75dSSam Parker 4191d06e75dSSam Parker VisitedBBs.insert(MBB); 4201d06e75dSSam Parker LivePhysRegs LiveRegs(*TRI); 4211d06e75dSSam Parker LiveRegs.addLiveOuts(*MBB); 4221d06e75dSSam Parker if (!LiveRegs.contains(PhysReg)) 4231d06e75dSSam Parker return; 4241d06e75dSSam Parker 4251d06e75dSSam Parker if (auto *Def = getLocalLiveOutMIDef(MBB, PhysReg)) 4261d06e75dSSam Parker Defs.insert(Def); 4271d06e75dSSam Parker else 4281d06e75dSSam Parker for (auto *Pred : MBB->predecessors()) 4291d06e75dSSam Parker getLiveOuts(Pred, PhysReg, Defs, VisitedBBs); 4301d06e75dSSam Parker } 4311d06e75dSSam Parker 432e24537d4SMircea Trofin MachineInstr * 433e24537d4SMircea Trofin ReachingDefAnalysis::getUniqueReachingMIDef(MachineInstr *MI, 434e24537d4SMircea Trofin MCRegister PhysReg) const { 4351d06e75dSSam Parker // If there's a local def before MI, return it. 4361d06e75dSSam Parker MachineInstr *LocalDef = getReachingLocalMIDef(MI, PhysReg); 4375618e9beSSam Parker if (LocalDef && InstIds.lookup(LocalDef) < InstIds.lookup(MI)) 4381d06e75dSSam Parker return LocalDef; 4391d06e75dSSam Parker 4401d06e75dSSam Parker SmallPtrSet<MachineInstr*, 2> Incoming; 44185dd852aSSam Tebbs MachineBasicBlock *Parent = MI->getParent(); 44285dd852aSSam Tebbs for (auto *Pred : Parent->predecessors()) 4431c421046SSam Parker getLiveOuts(Pred, PhysReg, Incoming); 4441d06e75dSSam Parker 4451c421046SSam Parker // Check that we have a single incoming value and that it does not 4461c421046SSam Parker // come from the same block as MI - since it would mean that the def 4471c421046SSam Parker // is executed after MI. 4481c421046SSam Parker if (Incoming.size() == 1 && (*Incoming.begin())->getParent() != Parent) 4491d06e75dSSam Parker return *Incoming.begin(); 4501c421046SSam Parker return nullptr; 4511d06e75dSSam Parker } 4521d06e75dSSam Parker 4531d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getMIOperand(MachineInstr *MI, 4541d06e75dSSam Parker unsigned Idx) const { 4551d06e75dSSam Parker assert(MI->getOperand(Idx).isReg() && "Expected register operand"); 4561d06e75dSSam Parker return getUniqueReachingMIDef(MI, MI->getOperand(Idx).getReg()); 4571d06e75dSSam Parker } 4581d06e75dSSam Parker 4591d06e75dSSam Parker MachineInstr *ReachingDefAnalysis::getMIOperand(MachineInstr *MI, 4601d06e75dSSam Parker MachineOperand &MO) const { 4611d06e75dSSam Parker assert(MO.isReg() && "Expected register operand"); 4621d06e75dSSam Parker return getUniqueReachingMIDef(MI, MO.getReg()); 4631d06e75dSSam Parker } 4641d06e75dSSam Parker 465e24537d4SMircea Trofin bool ReachingDefAnalysis::isRegUsedAfter(MachineInstr *MI, 466e24537d4SMircea Trofin MCRegister PhysReg) const { 467cced971fSSam Parker MachineBasicBlock *MBB = MI->getParent(); 468cced971fSSam Parker LivePhysRegs LiveRegs(*TRI); 469cced971fSSam Parker LiveRegs.addLiveOuts(*MBB); 470cced971fSSam Parker 471cced971fSSam Parker // Yes if the register is live out of the basic block. 472cced971fSSam Parker if (LiveRegs.contains(PhysReg)) 473cced971fSSam Parker return true; 474cced971fSSam Parker 475cced971fSSam Parker // Walk backwards through the block to see if the register is live at some 476cced971fSSam Parker // point. 4778f92f3c2SSam Parker for (MachineInstr &Last : 4788f92f3c2SSam Parker instructionsWithoutDebug(MBB->instr_rbegin(), MBB->instr_rend())) { 4798f92f3c2SSam Parker LiveRegs.stepBackward(Last); 480cced971fSSam Parker if (LiveRegs.contains(PhysReg)) 4818f92f3c2SSam Parker return InstIds.lookup(&Last) > InstIds.lookup(MI); 482cced971fSSam Parker } 483cced971fSSam Parker return false; 484cced971fSSam Parker } 485cced971fSSam Parker 486ac30ea2fSSam Parker bool ReachingDefAnalysis::isRegDefinedAfter(MachineInstr *MI, 487e24537d4SMircea Trofin MCRegister PhysReg) const { 488ac30ea2fSSam Parker MachineBasicBlock *MBB = MI->getParent(); 489cb27006aSDavid Green auto Last = MBB->getLastNonDebugInstr(); 490cb27006aSDavid Green if (Last != MBB->end() && 491cb27006aSDavid Green getReachingDef(MI, PhysReg) != getReachingDef(&*Last, PhysReg)) 492ac30ea2fSSam Parker return true; 493ac30ea2fSSam Parker 494ac30ea2fSSam Parker if (auto *Def = getLocalLiveOutMIDef(MBB, PhysReg)) 4951d06e75dSSam Parker return Def == getReachingLocalMIDef(MI, PhysReg); 496ac30ea2fSSam Parker 497ac30ea2fSSam Parker return false; 498ac30ea2fSSam Parker } 499ac30ea2fSSam Parker 500e24537d4SMircea Trofin bool ReachingDefAnalysis::isReachingDefLiveOut(MachineInstr *MI, 501e24537d4SMircea Trofin MCRegister PhysReg) const { 502acbc9aedSSam Parker MachineBasicBlock *MBB = MI->getParent(); 503acbc9aedSSam Parker LivePhysRegs LiveRegs(*TRI); 504acbc9aedSSam Parker LiveRegs.addLiveOuts(*MBB); 505acbc9aedSSam Parker if (!LiveRegs.contains(PhysReg)) 506acbc9aedSSam Parker return false; 507acbc9aedSSam Parker 508cb27006aSDavid Green auto Last = MBB->getLastNonDebugInstr(); 509acbc9aedSSam Parker int Def = getReachingDef(MI, PhysReg); 510cb27006aSDavid Green if (Last != MBB->end() && getReachingDef(&*Last, PhysReg) != Def) 511acbc9aedSSam Parker return false; 512acbc9aedSSam Parker 513acbc9aedSSam Parker // Finally check that the last instruction doesn't redefine the register. 514acbc9aedSSam Parker for (auto &MO : Last->operands()) 515bf61421aSSam Parker if (isValidRegDefOf(MO, PhysReg)) 516acbc9aedSSam Parker return false; 517acbc9aedSSam Parker 518acbc9aedSSam Parker return true; 519acbc9aedSSam Parker } 520acbc9aedSSam Parker 521e24537d4SMircea Trofin MachineInstr * 522e24537d4SMircea Trofin ReachingDefAnalysis::getLocalLiveOutMIDef(MachineBasicBlock *MBB, 523e24537d4SMircea Trofin MCRegister PhysReg) const { 524acbc9aedSSam Parker LivePhysRegs LiveRegs(*TRI); 525acbc9aedSSam Parker LiveRegs.addLiveOuts(*MBB); 526acbc9aedSSam Parker if (!LiveRegs.contains(PhysReg)) 527acbc9aedSSam Parker return nullptr; 528acbc9aedSSam Parker 529cb27006aSDavid Green auto Last = MBB->getLastNonDebugInstr(); 530cb27006aSDavid Green if (Last == MBB->end()) 531cb27006aSDavid Green return nullptr; 532cb27006aSDavid Green 533cb27006aSDavid Green int Def = getReachingDef(&*Last, PhysReg); 534acbc9aedSSam Parker for (auto &MO : Last->operands()) 535bf61421aSSam Parker if (isValidRegDefOf(MO, PhysReg)) 536cb27006aSDavid Green return &*Last; 537acbc9aedSSam Parker 538acbc9aedSSam Parker return Def < 0 ? nullptr : getInstFromId(MBB, Def); 539acbc9aedSSam Parker } 540ac30ea2fSSam Parker 5410a8cae10SSam Parker static bool mayHaveSideEffects(MachineInstr &MI) { 5420a8cae10SSam Parker return MI.mayLoadOrStore() || MI.mayRaiseFPException() || 5430a8cae10SSam Parker MI.hasUnmodeledSideEffects() || MI.isTerminator() || 5440a8cae10SSam Parker MI.isCall() || MI.isBarrier() || MI.isBranch() || MI.isReturn(); 5450a8cae10SSam Parker } 5460a8cae10SSam Parker 547ac30ea2fSSam Parker // Can we safely move 'From' to just before 'To'? To satisfy this, 'From' must 548ac30ea2fSSam Parker // not define a register that is used by any instructions, after and including, 549ac30ea2fSSam Parker // 'To'. These instructions also must not redefine any of Froms operands. 550ac30ea2fSSam Parker template<typename Iterator> 551ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMove(MachineInstr *From, 552ac30ea2fSSam Parker MachineInstr *To) const { 553700f93e9SSam Parker if (From->getParent() != To->getParent() || From == To) 554ac30ea2fSSam Parker return false; 555ac30ea2fSSam Parker 556ac30ea2fSSam Parker SmallSet<int, 2> Defs; 557ac30ea2fSSam Parker // First check that From would compute the same value if moved. 558ac30ea2fSSam Parker for (auto &MO : From->operands()) { 559bf61421aSSam Parker if (!isValidReg(MO)) 560ac30ea2fSSam Parker continue; 561ac30ea2fSSam Parker if (MO.isDef()) 562ac30ea2fSSam Parker Defs.insert(MO.getReg()); 563ac30ea2fSSam Parker else if (!hasSameReachingDef(From, To, MO.getReg())) 564ac30ea2fSSam Parker return false; 565ac30ea2fSSam Parker } 566ac30ea2fSSam Parker 567ac30ea2fSSam Parker // Now walk checking that the rest of the instructions will compute the same 5680a8cae10SSam Parker // value and that we're not overwriting anything. Don't move the instruction 56968b30bc0SCasey Carter // past any memory, control-flow or other ambiguous instructions. 570ac30ea2fSSam Parker for (auto I = ++Iterator(From), E = Iterator(To); I != E; ++I) { 5710a8cae10SSam Parker if (mayHaveSideEffects(*I)) 5720a8cae10SSam Parker return false; 573ac30ea2fSSam Parker for (auto &MO : I->operands()) 5740a8cae10SSam Parker if (MO.isReg() && MO.getReg() && Defs.count(MO.getReg())) 575ac30ea2fSSam Parker return false; 576ac30ea2fSSam Parker } 577ac30ea2fSSam Parker return true; 578ac30ea2fSSam Parker } 579ac30ea2fSSam Parker 580ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToMoveForwards(MachineInstr *From, 581ac30ea2fSSam Parker MachineInstr *To) const { 582700f93e9SSam Parker using Iterator = MachineBasicBlock::iterator; 583700f93e9SSam Parker // Walk forwards until we find the instruction. 584700f93e9SSam Parker for (auto I = Iterator(From), E = From->getParent()->end(); 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::isSafeToMoveBackwards(MachineInstr *From, 591ac30ea2fSSam Parker MachineInstr *To) const { 592700f93e9SSam Parker using Iterator = MachineBasicBlock::reverse_iterator; 593700f93e9SSam Parker // Walk backwards until we find the instruction. 594700f93e9SSam Parker for (auto I = Iterator(From), E = From->getParent()->rend(); I != E; ++I) 595700f93e9SSam Parker if (&*I == To) 596700f93e9SSam Parker return isSafeToMove<Iterator>(From, To); 597700f93e9SSam Parker return false; 598ac30ea2fSSam Parker } 599ac30ea2fSSam Parker 600ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, 601ac30ea2fSSam Parker InstSet &ToRemove) const { 602ac30ea2fSSam Parker SmallPtrSet<MachineInstr*, 1> Ignore; 603ac30ea2fSSam Parker SmallPtrSet<MachineInstr*, 2> Visited; 604ac30ea2fSSam Parker return isSafeToRemove(MI, Visited, ToRemove, Ignore); 605ac30ea2fSSam Parker } 606ac30ea2fSSam Parker 607ac30ea2fSSam Parker bool 608ac30ea2fSSam Parker ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, InstSet &ToRemove, 609ac30ea2fSSam Parker InstSet &Ignore) const { 610ac30ea2fSSam Parker SmallPtrSet<MachineInstr*, 2> Visited; 611ac30ea2fSSam Parker return isSafeToRemove(MI, Visited, ToRemove, Ignore); 612ac30ea2fSSam Parker } 613ac30ea2fSSam Parker 614ac30ea2fSSam Parker bool 615ac30ea2fSSam Parker ReachingDefAnalysis::isSafeToRemove(MachineInstr *MI, InstSet &Visited, 616ac30ea2fSSam Parker InstSet &ToRemove, InstSet &Ignore) const { 617ac30ea2fSSam Parker if (Visited.count(MI) || Ignore.count(MI)) 618ac30ea2fSSam Parker return true; 6190a8cae10SSam Parker else if (mayHaveSideEffects(*MI)) { 620ac30ea2fSSam Parker // Unless told to ignore the instruction, don't remove anything which has 621ac30ea2fSSam Parker // side effects. 622ac30ea2fSSam Parker return false; 623ac30ea2fSSam Parker } 624ac30ea2fSSam Parker 625ac30ea2fSSam Parker Visited.insert(MI); 626ac30ea2fSSam Parker for (auto &MO : MI->operands()) { 627bf61421aSSam Parker if (!isValidRegDef(MO)) 628ac30ea2fSSam Parker continue; 629ac30ea2fSSam Parker 630ac30ea2fSSam Parker SmallPtrSet<MachineInstr*, 4> Uses; 631ac30ea2fSSam Parker getGlobalUses(MI, MO.getReg(), Uses); 632ac30ea2fSSam Parker 633ac30ea2fSSam Parker for (auto I : Uses) { 634ac30ea2fSSam Parker if (Ignore.count(I) || ToRemove.count(I)) 635ac30ea2fSSam Parker continue; 636ac30ea2fSSam Parker if (!isSafeToRemove(I, Visited, ToRemove, Ignore)) 637ac30ea2fSSam Parker return false; 638ac30ea2fSSam Parker } 639ac30ea2fSSam Parker } 640ac30ea2fSSam Parker ToRemove.insert(MI); 641ac30ea2fSSam Parker return true; 642ac30ea2fSSam Parker } 643ac30ea2fSSam Parker 6445618e9beSSam Parker void ReachingDefAnalysis::collectKilledOperands(MachineInstr *MI, 645a67eb221SSam Parker InstSet &Dead) const { 646a67eb221SSam Parker Dead.insert(MI); 647e24537d4SMircea Trofin auto IsDead = [this, &Dead](MachineInstr *Def, MCRegister PhysReg) { 648779a8a02SSam Parker if (mayHaveSideEffects(*Def)) 649779a8a02SSam Parker return false; 650779a8a02SSam Parker 651a67eb221SSam Parker unsigned LiveDefs = 0; 652bf61421aSSam Parker for (auto &MO : Def->operands()) { 653bf61421aSSam Parker if (!isValidRegDef(MO)) 654bf61421aSSam Parker continue; 655a67eb221SSam Parker if (!MO.isDead()) 656a67eb221SSam Parker ++LiveDefs; 657bf61421aSSam Parker } 658a67eb221SSam Parker 659a67eb221SSam Parker if (LiveDefs > 1) 660a67eb221SSam Parker return false; 661a67eb221SSam Parker 662a67eb221SSam Parker SmallPtrSet<MachineInstr*, 4> Uses; 663a67eb221SSam Parker getGlobalUses(Def, PhysReg, Uses); 664d6391209SKazu Hirata return llvm::set_is_subset(Uses, Dead); 665a67eb221SSam Parker }; 666a67eb221SSam Parker 667bf61421aSSam Parker for (auto &MO : MI->operands()) { 6685618e9beSSam Parker if (!isValidRegUse(MO)) 669a67eb221SSam Parker continue; 6705618e9beSSam Parker if (MachineInstr *Def = getMIOperand(MI, MO)) 671a67eb221SSam Parker if (IsDead(Def, MO.getReg())) 6725618e9beSSam Parker collectKilledOperands(Def, Dead); 673a67eb221SSam Parker } 674a67eb221SSam Parker } 675a67eb221SSam Parker 676ac30ea2fSSam Parker bool ReachingDefAnalysis::isSafeToDefRegAt(MachineInstr *MI, 677e24537d4SMircea Trofin MCRegister PhysReg) const { 678ac30ea2fSSam Parker SmallPtrSet<MachineInstr*, 1> Ignore; 679ac30ea2fSSam Parker return isSafeToDefRegAt(MI, PhysReg, Ignore); 680ac30ea2fSSam Parker } 681ac30ea2fSSam Parker 682e24537d4SMircea Trofin bool ReachingDefAnalysis::isSafeToDefRegAt(MachineInstr *MI, MCRegister PhysReg, 683ac30ea2fSSam Parker InstSet &Ignore) const { 684ac30ea2fSSam Parker // Check for any uses of the register after MI. 685ac30ea2fSSam Parker if (isRegUsedAfter(MI, PhysReg)) { 6861d06e75dSSam Parker if (auto *Def = getReachingLocalMIDef(MI, PhysReg)) { 687ac30ea2fSSam Parker SmallPtrSet<MachineInstr*, 2> Uses; 6883f88c10aSSam Parker getGlobalUses(Def, PhysReg, Uses); 689d6391209SKazu Hirata if (!llvm::set_is_subset(Uses, Ignore)) 690ac30ea2fSSam Parker return false; 691ac30ea2fSSam Parker } else 692ac30ea2fSSam Parker return false; 693ac30ea2fSSam Parker } 694ac30ea2fSSam Parker 695ac30ea2fSSam Parker MachineBasicBlock *MBB = MI->getParent(); 696ac30ea2fSSam Parker // Check for any defs after MI. 697ac30ea2fSSam Parker if (isRegDefinedAfter(MI, PhysReg)) { 698ac30ea2fSSam Parker auto I = MachineBasicBlock::iterator(MI); 699ac30ea2fSSam Parker for (auto E = MBB->end(); I != E; ++I) { 700ac30ea2fSSam Parker if (Ignore.count(&*I)) 701ac30ea2fSSam Parker continue; 702ac30ea2fSSam Parker for (auto &MO : I->operands()) 703bf61421aSSam Parker if (isValidRegDefOf(MO, PhysReg)) 704ac30ea2fSSam Parker return false; 705ac30ea2fSSam Parker } 706ac30ea2fSSam Parker } 707ac30ea2fSSam Parker return true; 708ac30ea2fSSam Parker } 709