1f22ef01cSRoman Divacky //===-- llvm/CodeGen/MachineBasicBlock.cpp ----------------------*- C++ -*-===// 2f22ef01cSRoman Divacky // 3f22ef01cSRoman Divacky // The LLVM Compiler Infrastructure 4f22ef01cSRoman Divacky // 5f22ef01cSRoman Divacky // This file is distributed under the University of Illinois Open Source 6f22ef01cSRoman Divacky // License. See LICENSE.TXT for details. 7f22ef01cSRoman Divacky // 8f22ef01cSRoman Divacky //===----------------------------------------------------------------------===// 9f22ef01cSRoman Divacky // 10f22ef01cSRoman Divacky // Collect the sequence of machine instructions for a basic block. 11f22ef01cSRoman Divacky // 12f22ef01cSRoman Divacky //===----------------------------------------------------------------------===// 13f22ef01cSRoman Divacky 14f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineBasicBlock.h" 15139f7f9bSDimitry Andric #include "llvm/ADT/SmallPtrSet.h" 16139f7f9bSDimitry Andric #include "llvm/CodeGen/LiveIntervalAnalysis.h" 17ffd1746dSEd Schouten #include "llvm/CodeGen/LiveVariables.h" 18ffd1746dSEd Schouten #include "llvm/CodeGen/MachineDominators.h" 19f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineFunction.h" 20*6beeb091SDimitry Andric #include "llvm/CodeGen/MachineInstrBuilder.h" 21ffd1746dSEd Schouten #include "llvm/CodeGen/MachineLoopInfo.h" 22139f7f9bSDimitry Andric #include "llvm/CodeGen/MachineRegisterInfo.h" 232754fe60SDimitry Andric #include "llvm/CodeGen/SlotIndexes.h" 24139f7f9bSDimitry Andric #include "llvm/IR/BasicBlock.h" 25139f7f9bSDimitry Andric #include "llvm/IR/DataLayout.h" 267a7e6055SDimitry Andric #include "llvm/IR/DebugInfoMetadata.h" 273dac3a9bSDimitry Andric #include "llvm/IR/ModuleSlotTracker.h" 28f22ef01cSRoman Divacky #include "llvm/MC/MCAsmInfo.h" 29f22ef01cSRoman Divacky #include "llvm/MC/MCContext.h" 307d523365SDimitry Andric #include "llvm/Support/DataTypes.h" 31f22ef01cSRoman Divacky #include "llvm/Support/Debug.h" 32f22ef01cSRoman Divacky #include "llvm/Support/raw_ostream.h" 33139f7f9bSDimitry Andric #include "llvm/Target/TargetInstrInfo.h" 34139f7f9bSDimitry Andric #include "llvm/Target/TargetMachine.h" 35139f7f9bSDimitry Andric #include "llvm/Target/TargetRegisterInfo.h" 3639d628a0SDimitry Andric #include "llvm/Target/TargetSubtargetInfo.h" 37f22ef01cSRoman Divacky #include <algorithm> 38f22ef01cSRoman Divacky using namespace llvm; 39f22ef01cSRoman Divacky 4091bc56edSDimitry Andric #define DEBUG_TYPE "codegen" 4191bc56edSDimitry Andric 427d523365SDimitry Andric MachineBasicBlock::MachineBasicBlock(MachineFunction &MF, const BasicBlock *B) 437d523365SDimitry Andric : BB(B), Number(-1), xParent(&MF) { 44f22ef01cSRoman Divacky Insts.Parent = this; 45f22ef01cSRoman Divacky } 46f22ef01cSRoman Divacky 47f22ef01cSRoman Divacky MachineBasicBlock::~MachineBasicBlock() { 48f22ef01cSRoman Divacky } 49f22ef01cSRoman Divacky 507d523365SDimitry Andric /// Return the MCSymbol for this basic block. 51f22ef01cSRoman Divacky MCSymbol *MachineBasicBlock::getSymbol() const { 52284c1978SDimitry Andric if (!CachedMCSymbol) { 53f22ef01cSRoman Divacky const MachineFunction *MF = getParent(); 54f22ef01cSRoman Divacky MCContext &Ctx = MF->getContext(); 55d88c1a5aSDimitry Andric auto Prefix = Ctx.getAsmInfo()->getPrivateLabelPrefix(); 567d523365SDimitry Andric assert(getNumber() >= 0 && "cannot get label for unreachable MBB"); 57ff0cc061SDimitry Andric CachedMCSymbol = Ctx.getOrCreateSymbol(Twine(Prefix) + "BB" + 58284c1978SDimitry Andric Twine(MF->getFunctionNumber()) + 59284c1978SDimitry Andric "_" + Twine(getNumber())); 60284c1978SDimitry Andric } 61284c1978SDimitry Andric 62284c1978SDimitry Andric return CachedMCSymbol; 63f22ef01cSRoman Divacky } 64f22ef01cSRoman Divacky 65f22ef01cSRoman Divacky 66f22ef01cSRoman Divacky raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineBasicBlock &MBB) { 67f22ef01cSRoman Divacky MBB.print(OS); 68f22ef01cSRoman Divacky return OS; 69f22ef01cSRoman Divacky } 70f22ef01cSRoman Divacky 717d523365SDimitry Andric /// When an MBB is added to an MF, we need to update the parent pointer of the 727d523365SDimitry Andric /// MBB, the MBB numbering, and any instructions in the MBB to be on the right 737d523365SDimitry Andric /// operand list for registers. 74f22ef01cSRoman Divacky /// 75f22ef01cSRoman Divacky /// MBBs start out as #-1. When a MBB is added to a MachineFunction, it 76f22ef01cSRoman Divacky /// gets the next available unique MBB number. If it is removed from a 77f22ef01cSRoman Divacky /// MachineFunction, it goes back to being #-1. 78d88c1a5aSDimitry Andric void ilist_callback_traits<MachineBasicBlock>::addNodeToList( 79d88c1a5aSDimitry Andric MachineBasicBlock *N) { 80f22ef01cSRoman Divacky MachineFunction &MF = *N->getParent(); 81f22ef01cSRoman Divacky N->Number = MF.addToMBBNumbering(N); 82f22ef01cSRoman Divacky 83f22ef01cSRoman Divacky // Make sure the instructions have their operands in the reginfo lists. 84f22ef01cSRoman Divacky MachineRegisterInfo &RegInfo = MF.getRegInfo(); 85dff0c46cSDimitry Andric for (MachineBasicBlock::instr_iterator 86dff0c46cSDimitry Andric I = N->instr_begin(), E = N->instr_end(); I != E; ++I) 87f22ef01cSRoman Divacky I->AddRegOperandsToUseLists(RegInfo); 88f22ef01cSRoman Divacky } 89f22ef01cSRoman Divacky 90d88c1a5aSDimitry Andric void ilist_callback_traits<MachineBasicBlock>::removeNodeFromList( 91d88c1a5aSDimitry Andric MachineBasicBlock *N) { 92f22ef01cSRoman Divacky N->getParent()->removeFromMBBNumbering(N->Number); 93f22ef01cSRoman Divacky N->Number = -1; 94f22ef01cSRoman Divacky } 95f22ef01cSRoman Divacky 967d523365SDimitry Andric /// When we add an instruction to a basic block list, we update its parent 977d523365SDimitry Andric /// pointer and add its operands from reg use/def lists if appropriate. 98f22ef01cSRoman Divacky void ilist_traits<MachineInstr>::addNodeToList(MachineInstr *N) { 9991bc56edSDimitry Andric assert(!N->getParent() && "machine instruction already in a basic block"); 100f22ef01cSRoman Divacky N->setParent(Parent); 101f22ef01cSRoman Divacky 102f22ef01cSRoman Divacky // Add the instruction's register operands to their corresponding 103f22ef01cSRoman Divacky // use/def lists. 104f22ef01cSRoman Divacky MachineFunction *MF = Parent->getParent(); 105f22ef01cSRoman Divacky N->AddRegOperandsToUseLists(MF->getRegInfo()); 106f22ef01cSRoman Divacky } 107f22ef01cSRoman Divacky 1087d523365SDimitry Andric /// When we remove an instruction from a basic block list, we update its parent 1097d523365SDimitry Andric /// pointer and remove its operands from reg use/def lists if appropriate. 110f22ef01cSRoman Divacky void ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr *N) { 11191bc56edSDimitry Andric assert(N->getParent() && "machine instruction not in a basic block"); 112f22ef01cSRoman Divacky 113f22ef01cSRoman Divacky // Remove from the use/def lists. 1147ae0e2c9SDimitry Andric if (MachineFunction *MF = N->getParent()->getParent()) 1157ae0e2c9SDimitry Andric N->RemoveRegOperandsFromUseLists(MF->getRegInfo()); 116f22ef01cSRoman Divacky 11791bc56edSDimitry Andric N->setParent(nullptr); 118f22ef01cSRoman Divacky } 119f22ef01cSRoman Divacky 1207d523365SDimitry Andric /// When moving a range of instructions from one MBB list to another, we need to 1217d523365SDimitry Andric /// update the parent pointers and the use/def lists. 122d88c1a5aSDimitry Andric void ilist_traits<MachineInstr>::transferNodesFromList(ilist_traits &FromList, 123d88c1a5aSDimitry Andric instr_iterator First, 124d88c1a5aSDimitry Andric instr_iterator Last) { 1257d523365SDimitry Andric assert(Parent->getParent() == FromList.Parent->getParent() && 126f22ef01cSRoman Divacky "MachineInstr parent mismatch!"); 127d88c1a5aSDimitry Andric assert(this != &FromList && "Called without a real transfer..."); 128d88c1a5aSDimitry Andric assert(Parent != FromList.Parent && "Two lists have the same parent?"); 129f22ef01cSRoman Divacky 130f22ef01cSRoman Divacky // If splicing between two blocks within the same function, just update the 131f22ef01cSRoman Divacky // parent pointers. 1327d523365SDimitry Andric for (; First != Last; ++First) 1337d523365SDimitry Andric First->setParent(Parent); 134f22ef01cSRoman Divacky } 135f22ef01cSRoman Divacky 136f22ef01cSRoman Divacky void ilist_traits<MachineInstr>::deleteNode(MachineInstr *MI) { 137f22ef01cSRoman Divacky assert(!MI->getParent() && "MI is still in a block!"); 138f22ef01cSRoman Divacky Parent->getParent()->DeleteMachineInstr(MI); 139f22ef01cSRoman Divacky } 140f22ef01cSRoman Divacky 141ffd1746dSEd Schouten MachineBasicBlock::iterator MachineBasicBlock::getFirstNonPHI() { 142dff0c46cSDimitry Andric instr_iterator I = instr_begin(), E = instr_end(); 143dff0c46cSDimitry Andric while (I != E && I->isPHI()) 144ffd1746dSEd Schouten ++I; 1453861d79fSDimitry Andric assert((I == E || !I->isInsideBundle()) && 1463861d79fSDimitry Andric "First non-phi MI cannot be inside a bundle!"); 147ffd1746dSEd Schouten return I; 148ffd1746dSEd Schouten } 149ffd1746dSEd Schouten 1502754fe60SDimitry Andric MachineBasicBlock::iterator 1512754fe60SDimitry Andric MachineBasicBlock::SkipPHIsAndLabels(MachineBasicBlock::iterator I) { 1527a7e6055SDimitry Andric const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo(); 1537a7e6055SDimitry Andric 154dff0c46cSDimitry Andric iterator E = end(); 1557a7e6055SDimitry Andric while (I != E && (I->isPHI() || I->isPosition() || 1567a7e6055SDimitry Andric TII->isBasicBlockPrologue(*I))) 157d88c1a5aSDimitry Andric ++I; 158d88c1a5aSDimitry Andric // FIXME: This needs to change if we wish to bundle labels 159d88c1a5aSDimitry Andric // inside the bundle. 160d88c1a5aSDimitry Andric assert((I == E || !I->isInsideBundle()) && 161d88c1a5aSDimitry Andric "First non-phi / non-label instruction is inside a bundle!"); 162d88c1a5aSDimitry Andric return I; 163d88c1a5aSDimitry Andric } 164d88c1a5aSDimitry Andric 165d88c1a5aSDimitry Andric MachineBasicBlock::iterator 166d88c1a5aSDimitry Andric MachineBasicBlock::SkipPHIsLabelsAndDebug(MachineBasicBlock::iterator I) { 1677a7e6055SDimitry Andric const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo(); 1687a7e6055SDimitry Andric 169d88c1a5aSDimitry Andric iterator E = end(); 1707a7e6055SDimitry Andric while (I != E && (I->isPHI() || I->isPosition() || I->isDebugValue() || 1717a7e6055SDimitry Andric TII->isBasicBlockPrologue(*I))) 1722754fe60SDimitry Andric ++I; 173dff0c46cSDimitry Andric // FIXME: This needs to change if we wish to bundle labels / dbg_values 174dff0c46cSDimitry Andric // inside the bundle. 1753861d79fSDimitry Andric assert((I == E || !I->isInsideBundle()) && 176d88c1a5aSDimitry Andric "First non-phi / non-label / non-debug " 177d88c1a5aSDimitry Andric "instruction is inside a bundle!"); 1782754fe60SDimitry Andric return I; 1792754fe60SDimitry Andric } 1802754fe60SDimitry Andric 181f22ef01cSRoman Divacky MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() { 182dff0c46cSDimitry Andric iterator B = begin(), E = end(), I = E; 183dff0c46cSDimitry Andric while (I != B && ((--I)->isTerminator() || I->isDebugValue())) 184f22ef01cSRoman Divacky ; /*noop */ 185dff0c46cSDimitry Andric while (I != E && !I->isTerminator()) 186dff0c46cSDimitry Andric ++I; 187dff0c46cSDimitry Andric return I; 188dff0c46cSDimitry Andric } 189dff0c46cSDimitry Andric 190dff0c46cSDimitry Andric MachineBasicBlock::instr_iterator MachineBasicBlock::getFirstInstrTerminator() { 191dff0c46cSDimitry Andric instr_iterator B = instr_begin(), E = instr_end(), I = E; 192dff0c46cSDimitry Andric while (I != B && ((--I)->isTerminator() || I->isDebugValue())) 193dff0c46cSDimitry Andric ; /*noop */ 194dff0c46cSDimitry Andric while (I != E && !I->isTerminator()) 1952754fe60SDimitry Andric ++I; 196f22ef01cSRoman Divacky return I; 197f22ef01cSRoman Divacky } 198f22ef01cSRoman Divacky 1993dac3a9bSDimitry Andric MachineBasicBlock::iterator MachineBasicBlock::getFirstNonDebugInstr() { 2003dac3a9bSDimitry Andric // Skip over begin-of-block dbg_value instructions. 201d88c1a5aSDimitry Andric return skipDebugInstructionsForward(begin(), end()); 2023dac3a9bSDimitry Andric } 2033dac3a9bSDimitry Andric 2042754fe60SDimitry Andric MachineBasicBlock::iterator MachineBasicBlock::getLastNonDebugInstr() { 205dff0c46cSDimitry Andric // Skip over end-of-block dbg_value instructions. 206dff0c46cSDimitry Andric instr_iterator B = instr_begin(), I = instr_end(); 2072754fe60SDimitry Andric while (I != B) { 2082754fe60SDimitry Andric --I; 209dff0c46cSDimitry Andric // Return instruction that starts a bundle. 210dff0c46cSDimitry Andric if (I->isDebugValue() || I->isInsideBundle()) 211dff0c46cSDimitry Andric continue; 212dff0c46cSDimitry Andric return I; 213dff0c46cSDimitry Andric } 214dff0c46cSDimitry Andric // The block is all debug values. 215dff0c46cSDimitry Andric return end(); 216dff0c46cSDimitry Andric } 217dff0c46cSDimitry Andric 2187d523365SDimitry Andric bool MachineBasicBlock::hasEHPadSuccessor() const { 2197d523365SDimitry Andric for (const_succ_iterator I = succ_begin(), E = succ_end(); I != E; ++I) 2207d523365SDimitry Andric if ((*I)->isEHPad()) 2217d523365SDimitry Andric return true; 2227d523365SDimitry Andric return false; 2237d523365SDimitry Andric } 2247d523365SDimitry Andric 2253861d79fSDimitry Andric #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 2263ca95b02SDimitry Andric LLVM_DUMP_METHOD void MachineBasicBlock::dump() const { 227f22ef01cSRoman Divacky print(dbgs()); 228f22ef01cSRoman Divacky } 2293861d79fSDimitry Andric #endif 230f22ef01cSRoman Divacky 231f22ef01cSRoman Divacky StringRef MachineBasicBlock::getName() const { 232f22ef01cSRoman Divacky if (const BasicBlock *LBB = getBasicBlock()) 233f22ef01cSRoman Divacky return LBB->getName(); 234f22ef01cSRoman Divacky else 2357a7e6055SDimitry Andric return StringRef("", 0); 236f22ef01cSRoman Divacky } 237f22ef01cSRoman Divacky 238dff0c46cSDimitry Andric /// Return a hopefully unique identifier for this block. 239dff0c46cSDimitry Andric std::string MachineBasicBlock::getFullName() const { 240dff0c46cSDimitry Andric std::string Name; 241dff0c46cSDimitry Andric if (getParent()) 2423861d79fSDimitry Andric Name = (getParent()->getName() + ":").str(); 243dff0c46cSDimitry Andric if (getBasicBlock()) 244dff0c46cSDimitry Andric Name += getBasicBlock()->getName(); 245dff0c46cSDimitry Andric else 246ff0cc061SDimitry Andric Name += ("BB" + Twine(getNumber())).str(); 247dff0c46cSDimitry Andric return Name; 248dff0c46cSDimitry Andric } 249dff0c46cSDimitry Andric 2503ca95b02SDimitry Andric void MachineBasicBlock::print(raw_ostream &OS, const SlotIndexes *Indexes) 2513ca95b02SDimitry Andric const { 252f22ef01cSRoman Divacky const MachineFunction *MF = getParent(); 253f22ef01cSRoman Divacky if (!MF) { 254f22ef01cSRoman Divacky OS << "Can't print out MachineBasicBlock because parent MachineFunction" 255f22ef01cSRoman Divacky << " is null\n"; 256f22ef01cSRoman Divacky return; 257f22ef01cSRoman Divacky } 2583dac3a9bSDimitry Andric const Function *F = MF->getFunction(); 2593dac3a9bSDimitry Andric const Module *M = F ? F->getParent() : nullptr; 2603dac3a9bSDimitry Andric ModuleSlotTracker MST(M); 2613dac3a9bSDimitry Andric print(OS, MST, Indexes); 2623dac3a9bSDimitry Andric } 2633dac3a9bSDimitry Andric 2643dac3a9bSDimitry Andric void MachineBasicBlock::print(raw_ostream &OS, ModuleSlotTracker &MST, 2653ca95b02SDimitry Andric const SlotIndexes *Indexes) const { 2663dac3a9bSDimitry Andric const MachineFunction *MF = getParent(); 2673dac3a9bSDimitry Andric if (!MF) { 2683dac3a9bSDimitry Andric OS << "Can't print out MachineBasicBlock because parent MachineFunction" 2693dac3a9bSDimitry Andric << " is null\n"; 2703dac3a9bSDimitry Andric return; 2713dac3a9bSDimitry Andric } 272f22ef01cSRoman Divacky 2732754fe60SDimitry Andric if (Indexes) 2742754fe60SDimitry Andric OS << Indexes->getMBBStartIdx(this) << '\t'; 2752754fe60SDimitry Andric 276f22ef01cSRoman Divacky OS << "BB#" << getNumber() << ": "; 277f22ef01cSRoman Divacky 278f22ef01cSRoman Divacky const char *Comma = ""; 279f22ef01cSRoman Divacky if (const BasicBlock *LBB = getBasicBlock()) { 280f22ef01cSRoman Divacky OS << Comma << "derived from LLVM BB "; 2813dac3a9bSDimitry Andric LBB->printAsOperand(OS, /*PrintType=*/false, MST); 282f22ef01cSRoman Divacky Comma = ", "; 283f22ef01cSRoman Divacky } 2847d523365SDimitry Andric if (isEHPad()) { OS << Comma << "EH LANDING PAD"; Comma = ", "; } 285f22ef01cSRoman Divacky if (hasAddressTaken()) { OS << Comma << "ADDRESS TAKEN"; Comma = ", "; } 2867ae0e2c9SDimitry Andric if (Alignment) 287dff0c46cSDimitry Andric OS << Comma << "Align " << Alignment << " (" << (1u << Alignment) 288dff0c46cSDimitry Andric << " bytes)"; 289dff0c46cSDimitry Andric 290f22ef01cSRoman Divacky OS << '\n'; 291f22ef01cSRoman Divacky 29239d628a0SDimitry Andric const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo(); 293f22ef01cSRoman Divacky if (!livein_empty()) { 2942754fe60SDimitry Andric if (Indexes) OS << '\t'; 295f22ef01cSRoman Divacky OS << " Live Ins:"; 29695ec533aSDimitry Andric for (const auto &LI : LiveIns) { 2977d523365SDimitry Andric OS << ' ' << PrintReg(LI.PhysReg, TRI); 298d88c1a5aSDimitry Andric if (!LI.LaneMask.all()) 2997d523365SDimitry Andric OS << ':' << PrintLaneMask(LI.LaneMask); 3007d523365SDimitry Andric } 301f22ef01cSRoman Divacky OS << '\n'; 302f22ef01cSRoman Divacky } 303f22ef01cSRoman Divacky // Print the preds of this block according to the CFG. 304f22ef01cSRoman Divacky if (!pred_empty()) { 3052754fe60SDimitry Andric if (Indexes) OS << '\t'; 306f22ef01cSRoman Divacky OS << " Predecessors according to CFG:"; 307f22ef01cSRoman Divacky for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI) 308f22ef01cSRoman Divacky OS << " BB#" << (*PI)->getNumber(); 309f22ef01cSRoman Divacky OS << '\n'; 310f22ef01cSRoman Divacky } 311f22ef01cSRoman Divacky 3123ca95b02SDimitry Andric for (auto &I : instrs()) { 3132754fe60SDimitry Andric if (Indexes) { 3143ca95b02SDimitry Andric if (Indexes->hasIndex(I)) 3153ca95b02SDimitry Andric OS << Indexes->getInstructionIndex(I); 3162754fe60SDimitry Andric OS << '\t'; 3172754fe60SDimitry Andric } 318f22ef01cSRoman Divacky OS << '\t'; 3193ca95b02SDimitry Andric if (I.isInsideBundle()) 320dff0c46cSDimitry Andric OS << " * "; 3213ca95b02SDimitry Andric I.print(OS, MST); 322f22ef01cSRoman Divacky } 323f22ef01cSRoman Divacky 324f22ef01cSRoman Divacky // Print the successors of this block according to the CFG. 325f22ef01cSRoman Divacky if (!succ_empty()) { 3262754fe60SDimitry Andric if (Indexes) OS << '\t'; 327f22ef01cSRoman Divacky OS << " Successors according to CFG:"; 3287ae0e2c9SDimitry Andric for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI) { 329f22ef01cSRoman Divacky OS << " BB#" << (*SI)->getNumber(); 3307d523365SDimitry Andric if (!Probs.empty()) 3317d523365SDimitry Andric OS << '(' << *getProbabilityIterator(SI) << ')'; 3327ae0e2c9SDimitry Andric } 333f22ef01cSRoman Divacky OS << '\n'; 334f22ef01cSRoman Divacky } 335f22ef01cSRoman Divacky } 336f22ef01cSRoman Divacky 3377d523365SDimitry Andric void MachineBasicBlock::printAsOperand(raw_ostream &OS, 3387d523365SDimitry Andric bool /*PrintType*/) const { 33991bc56edSDimitry Andric OS << "BB#" << getNumber(); 34091bc56edSDimitry Andric } 34191bc56edSDimitry Andric 3427d523365SDimitry Andric void MachineBasicBlock::removeLiveIn(MCPhysReg Reg, LaneBitmask LaneMask) { 343d88c1a5aSDimitry Andric LiveInVector::iterator I = find_if( 344d88c1a5aSDimitry Andric LiveIns, [Reg](const RegisterMaskPair &LI) { return LI.PhysReg == Reg; }); 3457d523365SDimitry Andric if (I == LiveIns.end()) 3467d523365SDimitry Andric return; 3477d523365SDimitry Andric 3487d523365SDimitry Andric I->LaneMask &= ~LaneMask; 349d88c1a5aSDimitry Andric if (I->LaneMask.none()) 350f22ef01cSRoman Divacky LiveIns.erase(I); 351f22ef01cSRoman Divacky } 352f22ef01cSRoman Divacky 353f9448bf3SDimitry Andric MachineBasicBlock::livein_iterator 354f9448bf3SDimitry Andric MachineBasicBlock::removeLiveIn(MachineBasicBlock::livein_iterator I) { 355f9448bf3SDimitry Andric // Get non-const version of iterator. 356f9448bf3SDimitry Andric LiveInVector::iterator LI = LiveIns.begin() + (I - LiveIns.begin()); 357f9448bf3SDimitry Andric return LiveIns.erase(LI); 358f9448bf3SDimitry Andric } 359f9448bf3SDimitry Andric 3607d523365SDimitry Andric bool MachineBasicBlock::isLiveIn(MCPhysReg Reg, LaneBitmask LaneMask) const { 361d88c1a5aSDimitry Andric livein_iterator I = find_if( 362d88c1a5aSDimitry Andric LiveIns, [Reg](const RegisterMaskPair &LI) { return LI.PhysReg == Reg; }); 363d88c1a5aSDimitry Andric return I != livein_end() && (I->LaneMask & LaneMask).any(); 3647d523365SDimitry Andric } 3657d523365SDimitry Andric 3667d523365SDimitry Andric void MachineBasicBlock::sortUniqueLiveIns() { 3677d523365SDimitry Andric std::sort(LiveIns.begin(), LiveIns.end(), 3687d523365SDimitry Andric [](const RegisterMaskPair &LI0, const RegisterMaskPair &LI1) { 3697d523365SDimitry Andric return LI0.PhysReg < LI1.PhysReg; 3707d523365SDimitry Andric }); 3717d523365SDimitry Andric // Liveins are sorted by physreg now we can merge their lanemasks. 3727d523365SDimitry Andric LiveInVector::const_iterator I = LiveIns.begin(); 3737d523365SDimitry Andric LiveInVector::const_iterator J; 3747d523365SDimitry Andric LiveInVector::iterator Out = LiveIns.begin(); 3757d523365SDimitry Andric for (; I != LiveIns.end(); ++Out, I = J) { 3767d523365SDimitry Andric unsigned PhysReg = I->PhysReg; 3777d523365SDimitry Andric LaneBitmask LaneMask = I->LaneMask; 3787d523365SDimitry Andric for (J = std::next(I); J != LiveIns.end() && J->PhysReg == PhysReg; ++J) 3797d523365SDimitry Andric LaneMask |= J->LaneMask; 3807d523365SDimitry Andric Out->PhysReg = PhysReg; 3817d523365SDimitry Andric Out->LaneMask = LaneMask; 3827d523365SDimitry Andric } 3837d523365SDimitry Andric LiveIns.erase(Out, LiveIns.end()); 384f22ef01cSRoman Divacky } 385f22ef01cSRoman Divacky 386*6beeb091SDimitry Andric unsigned 3877d523365SDimitry Andric MachineBasicBlock::addLiveIn(MCPhysReg PhysReg, const TargetRegisterClass *RC) { 388*6beeb091SDimitry Andric assert(getParent() && "MBB must be inserted in function"); 389*6beeb091SDimitry Andric assert(TargetRegisterInfo::isPhysicalRegister(PhysReg) && "Expected physreg"); 390*6beeb091SDimitry Andric assert(RC && "Register class is required"); 3917d523365SDimitry Andric assert((isEHPad() || this == &getParent()->front()) && 392*6beeb091SDimitry Andric "Only the entry block and landing pads can have physreg live ins"); 393*6beeb091SDimitry Andric 394*6beeb091SDimitry Andric bool LiveIn = isLiveIn(PhysReg); 395*6beeb091SDimitry Andric iterator I = SkipPHIsAndLabels(begin()), E = end(); 396*6beeb091SDimitry Andric MachineRegisterInfo &MRI = getParent()->getRegInfo(); 39739d628a0SDimitry Andric const TargetInstrInfo &TII = *getParent()->getSubtarget().getInstrInfo(); 398*6beeb091SDimitry Andric 399*6beeb091SDimitry Andric // Look for an existing copy. 400*6beeb091SDimitry Andric if (LiveIn) 401*6beeb091SDimitry Andric for (;I != E && I->isCopy(); ++I) 402*6beeb091SDimitry Andric if (I->getOperand(1).getReg() == PhysReg) { 403*6beeb091SDimitry Andric unsigned VirtReg = I->getOperand(0).getReg(); 404*6beeb091SDimitry Andric if (!MRI.constrainRegClass(VirtReg, RC)) 405*6beeb091SDimitry Andric llvm_unreachable("Incompatible live-in register class."); 406*6beeb091SDimitry Andric return VirtReg; 407*6beeb091SDimitry Andric } 408*6beeb091SDimitry Andric 409*6beeb091SDimitry Andric // No luck, create a virtual register. 410*6beeb091SDimitry Andric unsigned VirtReg = MRI.createVirtualRegister(RC); 411*6beeb091SDimitry Andric BuildMI(*this, I, DebugLoc(), TII.get(TargetOpcode::COPY), VirtReg) 412*6beeb091SDimitry Andric .addReg(PhysReg, RegState::Kill); 413*6beeb091SDimitry Andric if (!LiveIn) 414*6beeb091SDimitry Andric addLiveIn(PhysReg); 415*6beeb091SDimitry Andric return VirtReg; 416*6beeb091SDimitry Andric } 417*6beeb091SDimitry Andric 418f22ef01cSRoman Divacky void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) { 4197d523365SDimitry Andric getParent()->splice(NewAfter->getIterator(), getIterator()); 420f22ef01cSRoman Divacky } 421f22ef01cSRoman Divacky 422f22ef01cSRoman Divacky void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) { 4237d523365SDimitry Andric getParent()->splice(++NewBefore->getIterator(), getIterator()); 424f22ef01cSRoman Divacky } 425f22ef01cSRoman Divacky 426f22ef01cSRoman Divacky void MachineBasicBlock::updateTerminator() { 42739d628a0SDimitry Andric const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo(); 428f22ef01cSRoman Divacky // A block with no successors has no concerns with fall-through edges. 4293ca95b02SDimitry Andric if (this->succ_empty()) 4303ca95b02SDimitry Andric return; 431f22ef01cSRoman Divacky 43291bc56edSDimitry Andric MachineBasicBlock *TBB = nullptr, *FBB = nullptr; 433f22ef01cSRoman Divacky SmallVector<MachineOperand, 4> Cond; 4347a7e6055SDimitry Andric DebugLoc DL = findBranchDebugLoc(); 4353ca95b02SDimitry Andric bool B = TII->analyzeBranch(*this, TBB, FBB, Cond); 436f22ef01cSRoman Divacky (void) B; 437f22ef01cSRoman Divacky assert(!B && "UpdateTerminators requires analyzable predecessors!"); 438f22ef01cSRoman Divacky if (Cond.empty()) { 439f22ef01cSRoman Divacky if (TBB) { 4403ca95b02SDimitry Andric // The block has an unconditional branch. If its successor is now its 4413ca95b02SDimitry Andric // layout successor, delete the branch. 442f22ef01cSRoman Divacky if (isLayoutSuccessor(TBB)) 443d88c1a5aSDimitry Andric TII->removeBranch(*this); 444f22ef01cSRoman Divacky } else { 4453ca95b02SDimitry Andric // The block has an unconditional fallthrough. If its successor is not its 4463ca95b02SDimitry Andric // layout successor, insert a branch. First we have to locate the only 4473ca95b02SDimitry Andric // non-landing-pad successor, as that is the fallthrough block. 448dff0c46cSDimitry Andric for (succ_iterator SI = succ_begin(), SE = succ_end(); SI != SE; ++SI) { 4497d523365SDimitry Andric if ((*SI)->isEHPad()) 450dff0c46cSDimitry Andric continue; 451dff0c46cSDimitry Andric assert(!TBB && "Found more than one non-landing-pad successor!"); 452dff0c46cSDimitry Andric TBB = *SI; 453dff0c46cSDimitry Andric } 454dff0c46cSDimitry Andric 4553ca95b02SDimitry Andric // If there is no non-landing-pad successor, the block has no fall-through 4563ca95b02SDimitry Andric // edges to be concerned with. 457dff0c46cSDimitry Andric if (!TBB) 458dff0c46cSDimitry Andric return; 459dff0c46cSDimitry Andric 460dff0c46cSDimitry Andric // Finally update the unconditional successor to be reached via a branch 461dff0c46cSDimitry Andric // if it would not be reached by fallthrough. 462f22ef01cSRoman Divacky if (!isLayoutSuccessor(TBB)) 463d88c1a5aSDimitry Andric TII->insertBranch(*this, TBB, nullptr, Cond, DL); 464f22ef01cSRoman Divacky } 4653ca95b02SDimitry Andric return; 4663ca95b02SDimitry Andric } 4673ca95b02SDimitry Andric 468f22ef01cSRoman Divacky if (FBB) { 469f22ef01cSRoman Divacky // The block has a non-fallthrough conditional branch. If one of its 470f22ef01cSRoman Divacky // successors is its layout successor, rewrite it to a fallthrough 471f22ef01cSRoman Divacky // conditional branch. 472f22ef01cSRoman Divacky if (isLayoutSuccessor(TBB)) { 473d88c1a5aSDimitry Andric if (TII->reverseBranchCondition(Cond)) 474f22ef01cSRoman Divacky return; 475d88c1a5aSDimitry Andric TII->removeBranch(*this); 476d88c1a5aSDimitry Andric TII->insertBranch(*this, FBB, nullptr, Cond, DL); 477f22ef01cSRoman Divacky } else if (isLayoutSuccessor(FBB)) { 478d88c1a5aSDimitry Andric TII->removeBranch(*this); 479d88c1a5aSDimitry Andric TII->insertBranch(*this, TBB, nullptr, Cond, DL); 480f22ef01cSRoman Divacky } 4813ca95b02SDimitry Andric return; 4823ca95b02SDimitry Andric } 4833ca95b02SDimitry Andric 4843ca95b02SDimitry Andric // Walk through the successors and find the successor which is not a landing 4853ca95b02SDimitry Andric // pad and is not the conditional branch destination (in TBB) as the 4863ca95b02SDimitry Andric // fallthrough successor. 48791bc56edSDimitry Andric MachineBasicBlock *FallthroughBB = nullptr; 488cb4dff85SDimitry Andric for (succ_iterator SI = succ_begin(), SE = succ_end(); SI != SE; ++SI) { 4897d523365SDimitry Andric if ((*SI)->isEHPad() || *SI == TBB) 490cb4dff85SDimitry Andric continue; 491cb4dff85SDimitry Andric assert(!FallthroughBB && "Found more than one fallthrough successor."); 492cb4dff85SDimitry Andric FallthroughBB = *SI; 493cb4dff85SDimitry Andric } 4943ca95b02SDimitry Andric 4953ca95b02SDimitry Andric if (!FallthroughBB) { 4963ca95b02SDimitry Andric if (canFallThrough()) { 4973ca95b02SDimitry Andric // We fallthrough to the same basic block as the conditional jump targets. 4983ca95b02SDimitry Andric // Remove the conditional jump, leaving unconditional fallthrough. 4993ca95b02SDimitry Andric // FIXME: This does not seem like a reasonable pattern to support, but it 5003ca95b02SDimitry Andric // has been seen in the wild coming out of degenerate ARM test cases. 501d88c1a5aSDimitry Andric TII->removeBranch(*this); 502cb4dff85SDimitry Andric 5033ca95b02SDimitry Andric // Finally update the unconditional successor to be reached via a branch if 5043ca95b02SDimitry Andric // it would not be reached by fallthrough. 505cb4dff85SDimitry Andric if (!isLayoutSuccessor(TBB)) 506d88c1a5aSDimitry Andric TII->insertBranch(*this, TBB, nullptr, Cond, DL); 507cb4dff85SDimitry Andric return; 508cb4dff85SDimitry Andric } 509cb4dff85SDimitry Andric 5103ca95b02SDimitry Andric // We enter here iff exactly one successor is TBB which cannot fallthrough 5113ca95b02SDimitry Andric // and the rest successors if any are EHPads. In this case, we need to 5123ca95b02SDimitry Andric // change the conditional branch into unconditional branch. 513d88c1a5aSDimitry Andric TII->removeBranch(*this); 5143ca95b02SDimitry Andric Cond.clear(); 515d88c1a5aSDimitry Andric TII->insertBranch(*this, TBB, nullptr, Cond, DL); 5163ca95b02SDimitry Andric return; 5173ca95b02SDimitry Andric } 5183ca95b02SDimitry Andric 519f22ef01cSRoman Divacky // The block has a fallthrough conditional branch. 520f22ef01cSRoman Divacky if (isLayoutSuccessor(TBB)) { 521d88c1a5aSDimitry Andric if (TII->reverseBranchCondition(Cond)) { 522f22ef01cSRoman Divacky // We can't reverse the condition, add an unconditional branch. 523f22ef01cSRoman Divacky Cond.clear(); 524d88c1a5aSDimitry Andric TII->insertBranch(*this, FallthroughBB, nullptr, Cond, DL); 525f22ef01cSRoman Divacky return; 526f22ef01cSRoman Divacky } 527d88c1a5aSDimitry Andric TII->removeBranch(*this); 528d88c1a5aSDimitry Andric TII->insertBranch(*this, FallthroughBB, nullptr, Cond, DL); 529cb4dff85SDimitry Andric } else if (!isLayoutSuccessor(FallthroughBB)) { 530d88c1a5aSDimitry Andric TII->removeBranch(*this); 531d88c1a5aSDimitry Andric TII->insertBranch(*this, TBB, FallthroughBB, Cond, DL); 532f22ef01cSRoman Divacky } 533f22ef01cSRoman Divacky } 534f22ef01cSRoman Divacky 5357d523365SDimitry Andric void MachineBasicBlock::validateSuccProbs() const { 5367d523365SDimitry Andric #ifndef NDEBUG 5377d523365SDimitry Andric int64_t Sum = 0; 5387d523365SDimitry Andric for (auto Prob : Probs) 5397d523365SDimitry Andric Sum += Prob.getNumerator(); 5407d523365SDimitry Andric // Due to precision issue, we assume that the sum of probabilities is one if 5417d523365SDimitry Andric // the difference between the sum of their numerators and the denominator is 5427d523365SDimitry Andric // no greater than the number of successors. 5437d523365SDimitry Andric assert((uint64_t)std::abs(Sum - BranchProbability::getDenominator()) <= 5447d523365SDimitry Andric Probs.size() && 5457d523365SDimitry Andric "The sum of successors's probabilities exceeds one."); 5467d523365SDimitry Andric #endif // NDEBUG 547f22ef01cSRoman Divacky } 548f22ef01cSRoman Divacky 5497d523365SDimitry Andric void MachineBasicBlock::addSuccessor(MachineBasicBlock *Succ, 5507d523365SDimitry Andric BranchProbability Prob) { 5517d523365SDimitry Andric // Probability list is either empty (if successor list isn't empty, this means 5527d523365SDimitry Andric // disabled optimization) or has the same size as successor list. 5537d523365SDimitry Andric if (!(Probs.empty() && !Successors.empty())) 5547d523365SDimitry Andric Probs.push_back(Prob); 5557d523365SDimitry Andric Successors.push_back(Succ); 5567d523365SDimitry Andric Succ->addPredecessor(this); 55717a519f9SDimitry Andric } 55817a519f9SDimitry Andric 5597d523365SDimitry Andric void MachineBasicBlock::addSuccessorWithoutProb(MachineBasicBlock *Succ) { 5607d523365SDimitry Andric // We need to make sure probability list is either empty or has the same size 5617d523365SDimitry Andric // of successor list. When this function is called, we can safely delete all 5627d523365SDimitry Andric // probability in the list. 5637d523365SDimitry Andric Probs.clear(); 5647d523365SDimitry Andric Successors.push_back(Succ); 5657d523365SDimitry Andric Succ->addPredecessor(this); 5667d523365SDimitry Andric } 5677d523365SDimitry Andric 5687d523365SDimitry Andric void MachineBasicBlock::removeSuccessor(MachineBasicBlock *Succ, 5697d523365SDimitry Andric bool NormalizeSuccProbs) { 570d88c1a5aSDimitry Andric succ_iterator I = find(Successors, Succ); 5717d523365SDimitry Andric removeSuccessor(I, NormalizeSuccProbs); 572f22ef01cSRoman Divacky } 573f22ef01cSRoman Divacky 574f22ef01cSRoman Divacky MachineBasicBlock::succ_iterator 5757d523365SDimitry Andric MachineBasicBlock::removeSuccessor(succ_iterator I, bool NormalizeSuccProbs) { 576f22ef01cSRoman Divacky assert(I != Successors.end() && "Not a current successor!"); 57717a519f9SDimitry Andric 5787d523365SDimitry Andric // If probability list is empty it means we don't use it (disabled 5797d523365SDimitry Andric // optimization). 5807d523365SDimitry Andric if (!Probs.empty()) { 5817d523365SDimitry Andric probability_iterator WI = getProbabilityIterator(I); 5827d523365SDimitry Andric Probs.erase(WI); 5837d523365SDimitry Andric if (NormalizeSuccProbs) 5847d523365SDimitry Andric normalizeSuccProbs(); 58517a519f9SDimitry Andric } 58617a519f9SDimitry Andric 587f22ef01cSRoman Divacky (*I)->removePredecessor(this); 588f22ef01cSRoman Divacky return Successors.erase(I); 589f22ef01cSRoman Divacky } 590f22ef01cSRoman Divacky 59117a519f9SDimitry Andric void MachineBasicBlock::replaceSuccessor(MachineBasicBlock *Old, 59217a519f9SDimitry Andric MachineBasicBlock *New) { 5937ae0e2c9SDimitry Andric if (Old == New) 5947ae0e2c9SDimitry Andric return; 59517a519f9SDimitry Andric 5967ae0e2c9SDimitry Andric succ_iterator E = succ_end(); 5977ae0e2c9SDimitry Andric succ_iterator NewI = E; 5987ae0e2c9SDimitry Andric succ_iterator OldI = E; 5997ae0e2c9SDimitry Andric for (succ_iterator I = succ_begin(); I != E; ++I) { 6007ae0e2c9SDimitry Andric if (*I == Old) { 6017ae0e2c9SDimitry Andric OldI = I; 6027ae0e2c9SDimitry Andric if (NewI != E) 6037ae0e2c9SDimitry Andric break; 6047ae0e2c9SDimitry Andric } 6057ae0e2c9SDimitry Andric if (*I == New) { 6067ae0e2c9SDimitry Andric NewI = I; 6077ae0e2c9SDimitry Andric if (OldI != E) 6087ae0e2c9SDimitry Andric break; 6097ae0e2c9SDimitry Andric } 6107ae0e2c9SDimitry Andric } 6117ae0e2c9SDimitry Andric assert(OldI != E && "Old is not a successor of this block"); 6127ae0e2c9SDimitry Andric 6137ae0e2c9SDimitry Andric // If New isn't already a successor, let it take Old's place. 6147ae0e2c9SDimitry Andric if (NewI == E) { 6157d523365SDimitry Andric Old->removePredecessor(this); 6167ae0e2c9SDimitry Andric New->addPredecessor(this); 6177ae0e2c9SDimitry Andric *OldI = New; 6187ae0e2c9SDimitry Andric return; 61917a519f9SDimitry Andric } 62017a519f9SDimitry Andric 6217ae0e2c9SDimitry Andric // New is already a successor. 6227d523365SDimitry Andric // Update its probability instead of adding a duplicate edge. 6237d523365SDimitry Andric if (!Probs.empty()) { 6247d523365SDimitry Andric auto ProbIter = getProbabilityIterator(NewI); 6257d523365SDimitry Andric if (!ProbIter->isUnknown()) 6267d523365SDimitry Andric *ProbIter += *getProbabilityIterator(OldI); 6277ae0e2c9SDimitry Andric } 6287d523365SDimitry Andric removeSuccessor(OldI); 62917a519f9SDimitry Andric } 63017a519f9SDimitry Andric 6317d523365SDimitry Andric void MachineBasicBlock::addPredecessor(MachineBasicBlock *Pred) { 6327d523365SDimitry Andric Predecessors.push_back(Pred); 633f22ef01cSRoman Divacky } 634f22ef01cSRoman Divacky 6357d523365SDimitry Andric void MachineBasicBlock::removePredecessor(MachineBasicBlock *Pred) { 636d88c1a5aSDimitry Andric pred_iterator I = find(Predecessors, Pred); 637f22ef01cSRoman Divacky assert(I != Predecessors.end() && "Pred is not a predecessor of this block!"); 638f22ef01cSRoman Divacky Predecessors.erase(I); 639f22ef01cSRoman Divacky } 640f22ef01cSRoman Divacky 6417d523365SDimitry Andric void MachineBasicBlock::transferSuccessors(MachineBasicBlock *FromMBB) { 6427d523365SDimitry Andric if (this == FromMBB) 643f22ef01cSRoman Divacky return; 644f22ef01cSRoman Divacky 6457d523365SDimitry Andric while (!FromMBB->succ_empty()) { 6467d523365SDimitry Andric MachineBasicBlock *Succ = *FromMBB->succ_begin(); 64717a519f9SDimitry Andric 6487d523365SDimitry Andric // If probability list is empty it means we don't use it (disabled optimization). 6497d523365SDimitry Andric if (!FromMBB->Probs.empty()) { 6507d523365SDimitry Andric auto Prob = *FromMBB->Probs.begin(); 6517d523365SDimitry Andric addSuccessor(Succ, Prob); 6527d523365SDimitry Andric } else 6537d523365SDimitry Andric addSuccessorWithoutProb(Succ); 65417a519f9SDimitry Andric 6557d523365SDimitry Andric FromMBB->removeSuccessor(Succ); 656ffd1746dSEd Schouten } 657ffd1746dSEd Schouten } 658f22ef01cSRoman Divacky 659ffd1746dSEd Schouten void 6607d523365SDimitry Andric MachineBasicBlock::transferSuccessorsAndUpdatePHIs(MachineBasicBlock *FromMBB) { 6617d523365SDimitry Andric if (this == FromMBB) 662ffd1746dSEd Schouten return; 663ffd1746dSEd Schouten 6647d523365SDimitry Andric while (!FromMBB->succ_empty()) { 6657d523365SDimitry Andric MachineBasicBlock *Succ = *FromMBB->succ_begin(); 6667d523365SDimitry Andric if (!FromMBB->Probs.empty()) { 6677d523365SDimitry Andric auto Prob = *FromMBB->Probs.begin(); 6687d523365SDimitry Andric addSuccessor(Succ, Prob); 6697d523365SDimitry Andric } else 6707d523365SDimitry Andric addSuccessorWithoutProb(Succ); 6717d523365SDimitry Andric FromMBB->removeSuccessor(Succ); 672ffd1746dSEd Schouten 673ffd1746dSEd Schouten // Fix up any PHI nodes in the successor. 674dff0c46cSDimitry Andric for (MachineBasicBlock::instr_iterator MI = Succ->instr_begin(), 675dff0c46cSDimitry Andric ME = Succ->instr_end(); MI != ME && MI->isPHI(); ++MI) 676ffd1746dSEd Schouten for (unsigned i = 2, e = MI->getNumOperands()+1; i != e; i += 2) { 677ffd1746dSEd Schouten MachineOperand &MO = MI->getOperand(i); 6787d523365SDimitry Andric if (MO.getMBB() == FromMBB) 679ffd1746dSEd Schouten MO.setMBB(this); 680ffd1746dSEd Schouten } 681ffd1746dSEd Schouten } 6827d523365SDimitry Andric normalizeSuccProbs(); 683f22ef01cSRoman Divacky } 684f22ef01cSRoman Divacky 6857ae0e2c9SDimitry Andric bool MachineBasicBlock::isPredecessor(const MachineBasicBlock *MBB) const { 686d88c1a5aSDimitry Andric return is_contained(predecessors(), MBB); 6877ae0e2c9SDimitry Andric } 6887ae0e2c9SDimitry Andric 689f22ef01cSRoman Divacky bool MachineBasicBlock::isSuccessor(const MachineBasicBlock *MBB) const { 690d88c1a5aSDimitry Andric return is_contained(successors(), MBB); 691f22ef01cSRoman Divacky } 692f22ef01cSRoman Divacky 693f22ef01cSRoman Divacky bool MachineBasicBlock::isLayoutSuccessor(const MachineBasicBlock *MBB) const { 694f22ef01cSRoman Divacky MachineFunction::const_iterator I(this); 69591bc56edSDimitry Andric return std::next(I) == MachineFunction::const_iterator(MBB); 696f22ef01cSRoman Divacky } 697f22ef01cSRoman Divacky 6987a7e6055SDimitry Andric MachineBasicBlock *MachineBasicBlock::getFallThrough() { 6997d523365SDimitry Andric MachineFunction::iterator Fallthrough = getIterator(); 700f22ef01cSRoman Divacky ++Fallthrough; 701f22ef01cSRoman Divacky // If FallthroughBlock is off the end of the function, it can't fall through. 702f22ef01cSRoman Divacky if (Fallthrough == getParent()->end()) 7037a7e6055SDimitry Andric return nullptr; 704f22ef01cSRoman Divacky 705f22ef01cSRoman Divacky // If FallthroughBlock isn't a successor, no fallthrough is possible. 7067d523365SDimitry Andric if (!isSuccessor(&*Fallthrough)) 7077a7e6055SDimitry Andric return nullptr; 708f22ef01cSRoman Divacky 709f22ef01cSRoman Divacky // Analyze the branches, if any, at the end of the block. 71091bc56edSDimitry Andric MachineBasicBlock *TBB = nullptr, *FBB = nullptr; 711f22ef01cSRoman Divacky SmallVector<MachineOperand, 4> Cond; 71239d628a0SDimitry Andric const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo(); 7133ca95b02SDimitry Andric if (TII->analyzeBranch(*this, TBB, FBB, Cond)) { 714f22ef01cSRoman Divacky // If we couldn't analyze the branch, examine the last instruction. 715f22ef01cSRoman Divacky // If the block doesn't end in a known control barrier, assume fallthrough 716dff0c46cSDimitry Andric // is possible. The isPredicated check is needed because this code can be 717f22ef01cSRoman Divacky // called during IfConversion, where an instruction which is normally a 718dff0c46cSDimitry Andric // Barrier is predicated and thus no longer an actual control barrier. 7197a7e6055SDimitry Andric return (empty() || !back().isBarrier() || TII->isPredicated(back())) 7207a7e6055SDimitry Andric ? &*Fallthrough 7217a7e6055SDimitry Andric : nullptr; 722f22ef01cSRoman Divacky } 723f22ef01cSRoman Divacky 724f22ef01cSRoman Divacky // If there is no branch, control always falls through. 7257a7e6055SDimitry Andric if (!TBB) return &*Fallthrough; 726f22ef01cSRoman Divacky 727f22ef01cSRoman Divacky // If there is some explicit branch to the fallthrough block, it can obviously 728f22ef01cSRoman Divacky // reach, even though the branch should get folded to fall through implicitly. 729f22ef01cSRoman Divacky if (MachineFunction::iterator(TBB) == Fallthrough || 730f22ef01cSRoman Divacky MachineFunction::iterator(FBB) == Fallthrough) 7317a7e6055SDimitry Andric return &*Fallthrough; 732f22ef01cSRoman Divacky 733f22ef01cSRoman Divacky // If it's an unconditional branch to some block not the fall through, it 734f22ef01cSRoman Divacky // doesn't fall through. 7357a7e6055SDimitry Andric if (Cond.empty()) return nullptr; 736f22ef01cSRoman Divacky 737f22ef01cSRoman Divacky // Otherwise, if it is conditional and has no explicit false block, it falls 738f22ef01cSRoman Divacky // through. 7397a7e6055SDimitry Andric return (FBB == nullptr) ? &*Fallthrough : nullptr; 7407a7e6055SDimitry Andric } 7417a7e6055SDimitry Andric 7427a7e6055SDimitry Andric bool MachineBasicBlock::canFallThrough() { 7437a7e6055SDimitry Andric return getFallThrough() != nullptr; 744f22ef01cSRoman Divacky } 745f22ef01cSRoman Divacky 7463ca95b02SDimitry Andric MachineBasicBlock *MachineBasicBlock::SplitCriticalEdge(MachineBasicBlock *Succ, 7473ca95b02SDimitry Andric Pass &P) { 7483ca95b02SDimitry Andric if (!canSplitCriticalEdge(Succ)) 74991bc56edSDimitry Andric return nullptr; 7507ae0e2c9SDimitry Andric 751ffd1746dSEd Schouten MachineFunction *MF = getParent(); 7527d523365SDimitry Andric DebugLoc DL; // FIXME: this is nowhere 753ffd1746dSEd Schouten 754ffd1746dSEd Schouten MachineBasicBlock *NMBB = MF->CreateMachineBasicBlock(); 75591bc56edSDimitry Andric MF->insert(std::next(MachineFunction::iterator(this)), NMBB); 756e580952dSDimitry Andric DEBUG(dbgs() << "Splitting critical edge:" 757ffd1746dSEd Schouten " BB#" << getNumber() 758ffd1746dSEd Schouten << " -- BB#" << NMBB->getNumber() 759ffd1746dSEd Schouten << " -- BB#" << Succ->getNumber() << '\n'); 760ffd1746dSEd Schouten 7613ca95b02SDimitry Andric LiveIntervals *LIS = P.getAnalysisIfAvailable<LiveIntervals>(); 7623ca95b02SDimitry Andric SlotIndexes *Indexes = P.getAnalysisIfAvailable<SlotIndexes>(); 763139f7f9bSDimitry Andric if (LIS) 764139f7f9bSDimitry Andric LIS->insertMBBInMaps(NMBB); 765139f7f9bSDimitry Andric else if (Indexes) 766139f7f9bSDimitry Andric Indexes->insertMBBInMaps(NMBB); 767139f7f9bSDimitry Andric 768bd5abe19SDimitry Andric // On some targets like Mips, branches may kill virtual registers. Make sure 769bd5abe19SDimitry Andric // that LiveVariables is properly updated after updateTerminator replaces the 770bd5abe19SDimitry Andric // terminators. 7713ca95b02SDimitry Andric LiveVariables *LV = P.getAnalysisIfAvailable<LiveVariables>(); 772bd5abe19SDimitry Andric 773bd5abe19SDimitry Andric // Collect a list of virtual registers killed by the terminators. 774bd5abe19SDimitry Andric SmallVector<unsigned, 4> KilledRegs; 775bd5abe19SDimitry Andric if (LV) 776dff0c46cSDimitry Andric for (instr_iterator I = getFirstInstrTerminator(), E = instr_end(); 777dff0c46cSDimitry Andric I != E; ++I) { 7787d523365SDimitry Andric MachineInstr *MI = &*I; 779bd5abe19SDimitry Andric for (MachineInstr::mop_iterator OI = MI->operands_begin(), 780bd5abe19SDimitry Andric OE = MI->operands_end(); OI != OE; ++OI) { 781dff0c46cSDimitry Andric if (!OI->isReg() || OI->getReg() == 0 || 782dff0c46cSDimitry Andric !OI->isUse() || !OI->isKill() || OI->isUndef()) 783bd5abe19SDimitry Andric continue; 784bd5abe19SDimitry Andric unsigned Reg = OI->getReg(); 785dff0c46cSDimitry Andric if (TargetRegisterInfo::isPhysicalRegister(Reg) || 7863ca95b02SDimitry Andric LV->getVarInfo(Reg).removeKill(*MI)) { 787bd5abe19SDimitry Andric KilledRegs.push_back(Reg); 788bd5abe19SDimitry Andric DEBUG(dbgs() << "Removing terminator kill: " << *MI); 789bd5abe19SDimitry Andric OI->setIsKill(false); 790bd5abe19SDimitry Andric } 791bd5abe19SDimitry Andric } 792bd5abe19SDimitry Andric } 793bd5abe19SDimitry Andric 794139f7f9bSDimitry Andric SmallVector<unsigned, 4> UsedRegs; 795139f7f9bSDimitry Andric if (LIS) { 796139f7f9bSDimitry Andric for (instr_iterator I = getFirstInstrTerminator(), E = instr_end(); 797139f7f9bSDimitry Andric I != E; ++I) { 7987d523365SDimitry Andric MachineInstr *MI = &*I; 799139f7f9bSDimitry Andric 800139f7f9bSDimitry Andric for (MachineInstr::mop_iterator OI = MI->operands_begin(), 801139f7f9bSDimitry Andric OE = MI->operands_end(); OI != OE; ++OI) { 802139f7f9bSDimitry Andric if (!OI->isReg() || OI->getReg() == 0) 803139f7f9bSDimitry Andric continue; 804139f7f9bSDimitry Andric 805139f7f9bSDimitry Andric unsigned Reg = OI->getReg(); 806d88c1a5aSDimitry Andric if (!is_contained(UsedRegs, Reg)) 807139f7f9bSDimitry Andric UsedRegs.push_back(Reg); 808139f7f9bSDimitry Andric } 809139f7f9bSDimitry Andric } 810139f7f9bSDimitry Andric } 811139f7f9bSDimitry Andric 812ffd1746dSEd Schouten ReplaceUsesOfBlockWith(Succ, NMBB); 813139f7f9bSDimitry Andric 814139f7f9bSDimitry Andric // If updateTerminator() removes instructions, we need to remove them from 815139f7f9bSDimitry Andric // SlotIndexes. 816139f7f9bSDimitry Andric SmallVector<MachineInstr*, 4> Terminators; 817139f7f9bSDimitry Andric if (Indexes) { 818139f7f9bSDimitry Andric for (instr_iterator I = getFirstInstrTerminator(), E = instr_end(); 819139f7f9bSDimitry Andric I != E; ++I) 8207d523365SDimitry Andric Terminators.push_back(&*I); 821139f7f9bSDimitry Andric } 822139f7f9bSDimitry Andric 823ffd1746dSEd Schouten updateTerminator(); 824ffd1746dSEd Schouten 825139f7f9bSDimitry Andric if (Indexes) { 826139f7f9bSDimitry Andric SmallVector<MachineInstr*, 4> NewTerminators; 827139f7f9bSDimitry Andric for (instr_iterator I = getFirstInstrTerminator(), E = instr_end(); 828139f7f9bSDimitry Andric I != E; ++I) 8297d523365SDimitry Andric NewTerminators.push_back(&*I); 830139f7f9bSDimitry Andric 831139f7f9bSDimitry Andric for (SmallVectorImpl<MachineInstr*>::iterator I = Terminators.begin(), 832139f7f9bSDimitry Andric E = Terminators.end(); I != E; ++I) { 833d88c1a5aSDimitry Andric if (!is_contained(NewTerminators, *I)) 8343ca95b02SDimitry Andric Indexes->removeMachineInstrFromMaps(**I); 835139f7f9bSDimitry Andric } 836139f7f9bSDimitry Andric } 837139f7f9bSDimitry Andric 838ffd1746dSEd Schouten // Insert unconditional "jump Succ" instruction in NMBB if necessary. 839ffd1746dSEd Schouten NMBB->addSuccessor(Succ); 840ffd1746dSEd Schouten if (!NMBB->isLayoutSuccessor(Succ)) { 8413ca95b02SDimitry Andric SmallVector<MachineOperand, 4> Cond; 8423ca95b02SDimitry Andric const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo(); 843d88c1a5aSDimitry Andric TII->insertBranch(*NMBB, Succ, nullptr, Cond, DL); 844139f7f9bSDimitry Andric 845139f7f9bSDimitry Andric if (Indexes) { 8463ca95b02SDimitry Andric for (MachineInstr &MI : NMBB->instrs()) { 847139f7f9bSDimitry Andric // Some instructions may have been moved to NMBB by updateTerminator(), 848139f7f9bSDimitry Andric // so we first remove any instruction that already has an index. 8493ca95b02SDimitry Andric if (Indexes->hasIndex(MI)) 8503ca95b02SDimitry Andric Indexes->removeMachineInstrFromMaps(MI); 8513ca95b02SDimitry Andric Indexes->insertMachineInstrInMaps(MI); 852139f7f9bSDimitry Andric } 853139f7f9bSDimitry Andric } 854ffd1746dSEd Schouten } 855ffd1746dSEd Schouten 856ffd1746dSEd Schouten // Fix PHI nodes in Succ so they refer to NMBB instead of this 857dff0c46cSDimitry Andric for (MachineBasicBlock::instr_iterator 858dff0c46cSDimitry Andric i = Succ->instr_begin(),e = Succ->instr_end(); 859ffd1746dSEd Schouten i != e && i->isPHI(); ++i) 860ffd1746dSEd Schouten for (unsigned ni = 1, ne = i->getNumOperands(); ni != ne; ni += 2) 861ffd1746dSEd Schouten if (i->getOperand(ni+1).getMBB() == this) 862ffd1746dSEd Schouten i->getOperand(ni+1).setMBB(NMBB); 863ffd1746dSEd Schouten 8646122f3e6SDimitry Andric // Inherit live-ins from the successor 8657d523365SDimitry Andric for (const auto &LI : Succ->liveins()) 8667d523365SDimitry Andric NMBB->addLiveIn(LI); 8676122f3e6SDimitry Andric 868bd5abe19SDimitry Andric // Update LiveVariables. 86939d628a0SDimitry Andric const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo(); 870bd5abe19SDimitry Andric if (LV) { 871bd5abe19SDimitry Andric // Restore kills of virtual registers that were killed by the terminators. 872bd5abe19SDimitry Andric while (!KilledRegs.empty()) { 873bd5abe19SDimitry Andric unsigned Reg = KilledRegs.pop_back_val(); 874dff0c46cSDimitry Andric for (instr_iterator I = instr_end(), E = instr_begin(); I != E;) { 875dff0c46cSDimitry Andric if (!(--I)->addRegisterKilled(Reg, TRI, /* addIfNotFound= */ false)) 876bd5abe19SDimitry Andric continue; 877dff0c46cSDimitry Andric if (TargetRegisterInfo::isVirtualRegister(Reg)) 8787d523365SDimitry Andric LV->getVarInfo(Reg).Kills.push_back(&*I); 879bd5abe19SDimitry Andric DEBUG(dbgs() << "Restored terminator kill: " << *I); 880bd5abe19SDimitry Andric break; 881bd5abe19SDimitry Andric } 882bd5abe19SDimitry Andric } 883bd5abe19SDimitry Andric // Update relevant live-through information. 884ffd1746dSEd Schouten LV->addNewBlock(NMBB, this, Succ); 885bd5abe19SDimitry Andric } 886ffd1746dSEd Schouten 887139f7f9bSDimitry Andric if (LIS) { 888139f7f9bSDimitry Andric // After splitting the edge and updating SlotIndexes, live intervals may be 889139f7f9bSDimitry Andric // in one of two situations, depending on whether this block was the last in 8907d523365SDimitry Andric // the function. If the original block was the last in the function, all 8917d523365SDimitry Andric // live intervals will end prior to the beginning of the new split block. If 8927d523365SDimitry Andric // the original block was not at the end of the function, all live intervals 8937d523365SDimitry Andric // will extend to the end of the new split block. 894139f7f9bSDimitry Andric 895139f7f9bSDimitry Andric bool isLastMBB = 89691bc56edSDimitry Andric std::next(MachineFunction::iterator(NMBB)) == getParent()->end(); 897139f7f9bSDimitry Andric 898139f7f9bSDimitry Andric SlotIndex StartIndex = Indexes->getMBBEndIdx(this); 899139f7f9bSDimitry Andric SlotIndex PrevIndex = StartIndex.getPrevSlot(); 900139f7f9bSDimitry Andric SlotIndex EndIndex = Indexes->getMBBEndIdx(NMBB); 901139f7f9bSDimitry Andric 902139f7f9bSDimitry Andric // Find the registers used from NMBB in PHIs in Succ. 903139f7f9bSDimitry Andric SmallSet<unsigned, 8> PHISrcRegs; 904139f7f9bSDimitry Andric for (MachineBasicBlock::instr_iterator 905139f7f9bSDimitry Andric I = Succ->instr_begin(), E = Succ->instr_end(); 906139f7f9bSDimitry Andric I != E && I->isPHI(); ++I) { 907139f7f9bSDimitry Andric for (unsigned ni = 1, ne = I->getNumOperands(); ni != ne; ni += 2) { 908139f7f9bSDimitry Andric if (I->getOperand(ni+1).getMBB() == NMBB) { 909139f7f9bSDimitry Andric MachineOperand &MO = I->getOperand(ni); 910139f7f9bSDimitry Andric unsigned Reg = MO.getReg(); 911139f7f9bSDimitry Andric PHISrcRegs.insert(Reg); 912139f7f9bSDimitry Andric if (MO.isUndef()) 913139f7f9bSDimitry Andric continue; 914139f7f9bSDimitry Andric 915139f7f9bSDimitry Andric LiveInterval &LI = LIS->getInterval(Reg); 916139f7f9bSDimitry Andric VNInfo *VNI = LI.getVNInfoAt(PrevIndex); 9177d523365SDimitry Andric assert(VNI && 9187d523365SDimitry Andric "PHI sources should be live out of their predecessors."); 919f785676fSDimitry Andric LI.addSegment(LiveInterval::Segment(StartIndex, EndIndex, VNI)); 920139f7f9bSDimitry Andric } 921139f7f9bSDimitry Andric } 922139f7f9bSDimitry Andric } 923139f7f9bSDimitry Andric 924139f7f9bSDimitry Andric MachineRegisterInfo *MRI = &getParent()->getRegInfo(); 925139f7f9bSDimitry Andric for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) { 926139f7f9bSDimitry Andric unsigned Reg = TargetRegisterInfo::index2VirtReg(i); 927139f7f9bSDimitry Andric if (PHISrcRegs.count(Reg) || !LIS->hasInterval(Reg)) 928139f7f9bSDimitry Andric continue; 929139f7f9bSDimitry Andric 930139f7f9bSDimitry Andric LiveInterval &LI = LIS->getInterval(Reg); 931139f7f9bSDimitry Andric if (!LI.liveAt(PrevIndex)) 932139f7f9bSDimitry Andric continue; 933139f7f9bSDimitry Andric 934139f7f9bSDimitry Andric bool isLiveOut = LI.liveAt(LIS->getMBBStartIdx(Succ)); 935139f7f9bSDimitry Andric if (isLiveOut && isLastMBB) { 936139f7f9bSDimitry Andric VNInfo *VNI = LI.getVNInfoAt(PrevIndex); 937139f7f9bSDimitry Andric assert(VNI && "LiveInterval should have VNInfo where it is live."); 938f785676fSDimitry Andric LI.addSegment(LiveInterval::Segment(StartIndex, EndIndex, VNI)); 939139f7f9bSDimitry Andric } else if (!isLiveOut && !isLastMBB) { 940f785676fSDimitry Andric LI.removeSegment(StartIndex, EndIndex); 941139f7f9bSDimitry Andric } 942139f7f9bSDimitry Andric } 943139f7f9bSDimitry Andric 944139f7f9bSDimitry Andric // Update all intervals for registers whose uses may have been modified by 945139f7f9bSDimitry Andric // updateTerminator(). 946139f7f9bSDimitry Andric LIS->repairIntervalsInRange(this, getFirstTerminator(), end(), UsedRegs); 947139f7f9bSDimitry Andric } 948139f7f9bSDimitry Andric 949ffd1746dSEd Schouten if (MachineDominatorTree *MDT = 9503ca95b02SDimitry Andric P.getAnalysisIfAvailable<MachineDominatorTree>()) 95139d628a0SDimitry Andric MDT->recordSplitCriticalEdge(this, Succ, NMBB); 952e580952dSDimitry Andric 9533ca95b02SDimitry Andric if (MachineLoopInfo *MLI = P.getAnalysisIfAvailable<MachineLoopInfo>()) 954ffd1746dSEd Schouten if (MachineLoop *TIL = MLI->getLoopFor(this)) { 955ffd1746dSEd Schouten // If one or the other blocks were not in a loop, the new block is not 956ffd1746dSEd Schouten // either, and thus LI doesn't need to be updated. 957ffd1746dSEd Schouten if (MachineLoop *DestLoop = MLI->getLoopFor(Succ)) { 958ffd1746dSEd Schouten if (TIL == DestLoop) { 959ffd1746dSEd Schouten // Both in the same loop, the NMBB joins loop. 960ffd1746dSEd Schouten DestLoop->addBasicBlockToLoop(NMBB, MLI->getBase()); 961ffd1746dSEd Schouten } else if (TIL->contains(DestLoop)) { 962ffd1746dSEd Schouten // Edge from an outer loop to an inner loop. Add to the outer loop. 963ffd1746dSEd Schouten TIL->addBasicBlockToLoop(NMBB, MLI->getBase()); 964ffd1746dSEd Schouten } else if (DestLoop->contains(TIL)) { 965ffd1746dSEd Schouten // Edge from an inner loop to an outer loop. Add to the outer loop. 966ffd1746dSEd Schouten DestLoop->addBasicBlockToLoop(NMBB, MLI->getBase()); 967ffd1746dSEd Schouten } else { 968ffd1746dSEd Schouten // Edge from two loops with no containment relation. Because these 969ffd1746dSEd Schouten // are natural loops, we know that the destination block must be the 970ffd1746dSEd Schouten // header of its loop (adding a branch into a loop elsewhere would 971ffd1746dSEd Schouten // create an irreducible loop). 972ffd1746dSEd Schouten assert(DestLoop->getHeader() == Succ && 973ffd1746dSEd Schouten "Should not create irreducible loops!"); 974ffd1746dSEd Schouten if (MachineLoop *P = DestLoop->getParentLoop()) 975ffd1746dSEd Schouten P->addBasicBlockToLoop(NMBB, MLI->getBase()); 976ffd1746dSEd Schouten } 977ffd1746dSEd Schouten } 978ffd1746dSEd Schouten } 979ffd1746dSEd Schouten 980ffd1746dSEd Schouten return NMBB; 981ffd1746dSEd Schouten } 982ffd1746dSEd Schouten 9833ca95b02SDimitry Andric bool MachineBasicBlock::canSplitCriticalEdge( 9843ca95b02SDimitry Andric const MachineBasicBlock *Succ) const { 9853ca95b02SDimitry Andric // Splitting the critical edge to a landing pad block is non-trivial. Don't do 9863ca95b02SDimitry Andric // it in this generic function. 9873ca95b02SDimitry Andric if (Succ->isEHPad()) 9883ca95b02SDimitry Andric return false; 9893ca95b02SDimitry Andric 9903ca95b02SDimitry Andric const MachineFunction *MF = getParent(); 9913ca95b02SDimitry Andric 9923ca95b02SDimitry Andric // Performance might be harmed on HW that implements branching using exec mask 9933ca95b02SDimitry Andric // where both sides of the branches are always executed. 9943ca95b02SDimitry Andric if (MF->getTarget().requiresStructuredCFG()) 9953ca95b02SDimitry Andric return false; 9963ca95b02SDimitry Andric 9973ca95b02SDimitry Andric // We may need to update this's terminator, but we can't do that if 9983ca95b02SDimitry Andric // AnalyzeBranch fails. If this uses a jump table, we won't touch it. 9993ca95b02SDimitry Andric const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo(); 10003ca95b02SDimitry Andric MachineBasicBlock *TBB = nullptr, *FBB = nullptr; 10013ca95b02SDimitry Andric SmallVector<MachineOperand, 4> Cond; 10023ca95b02SDimitry Andric // AnalyzeBanch should modify this, since we did not allow modification. 10033ca95b02SDimitry Andric if (TII->analyzeBranch(*const_cast<MachineBasicBlock *>(this), TBB, FBB, Cond, 10043ca95b02SDimitry Andric /*AllowModify*/ false)) 10053ca95b02SDimitry Andric return false; 10063ca95b02SDimitry Andric 10073ca95b02SDimitry Andric // Avoid bugpoint weirdness: A block may end with a conditional branch but 10083ca95b02SDimitry Andric // jumps to the same MBB is either case. We have duplicate CFG edges in that 10093ca95b02SDimitry Andric // case that we can't handle. Since this never happens in properly optimized 10103ca95b02SDimitry Andric // code, just skip those edges. 10113ca95b02SDimitry Andric if (TBB && TBB == FBB) { 10123ca95b02SDimitry Andric DEBUG(dbgs() << "Won't split critical edge after degenerate BB#" 10133ca95b02SDimitry Andric << getNumber() << '\n'); 10143ca95b02SDimitry Andric return false; 10153ca95b02SDimitry Andric } 10163ca95b02SDimitry Andric return true; 10173ca95b02SDimitry Andric } 10183ca95b02SDimitry Andric 1019139f7f9bSDimitry Andric /// Prepare MI to be removed from its bundle. This fixes bundle flags on MI's 1020139f7f9bSDimitry Andric /// neighboring instructions so the bundle won't be broken by removing MI. 1021139f7f9bSDimitry Andric static void unbundleSingleMI(MachineInstr *MI) { 1022139f7f9bSDimitry Andric // Removing the first instruction in a bundle. 1023139f7f9bSDimitry Andric if (MI->isBundledWithSucc() && !MI->isBundledWithPred()) 1024139f7f9bSDimitry Andric MI->unbundleFromSucc(); 1025139f7f9bSDimitry Andric // Removing the last instruction in a bundle. 1026139f7f9bSDimitry Andric if (MI->isBundledWithPred() && !MI->isBundledWithSucc()) 1027139f7f9bSDimitry Andric MI->unbundleFromPred(); 1028139f7f9bSDimitry Andric // If MI is not bundled, or if it is internal to a bundle, the neighbor flags 1029139f7f9bSDimitry Andric // are already fine. 1030dff0c46cSDimitry Andric } 1031dff0c46cSDimitry Andric 1032139f7f9bSDimitry Andric MachineBasicBlock::instr_iterator 1033139f7f9bSDimitry Andric MachineBasicBlock::erase(MachineBasicBlock::instr_iterator I) { 10347d523365SDimitry Andric unbundleSingleMI(&*I); 1035139f7f9bSDimitry Andric return Insts.erase(I); 1036dff0c46cSDimitry Andric } 1037dff0c46cSDimitry Andric 1038139f7f9bSDimitry Andric MachineInstr *MachineBasicBlock::remove_instr(MachineInstr *MI) { 1039139f7f9bSDimitry Andric unbundleSingleMI(MI); 1040139f7f9bSDimitry Andric MI->clearFlag(MachineInstr::BundledPred); 1041139f7f9bSDimitry Andric MI->clearFlag(MachineInstr::BundledSucc); 1042139f7f9bSDimitry Andric return Insts.remove(MI); 1043dff0c46cSDimitry Andric } 1044dff0c46cSDimitry Andric 1045139f7f9bSDimitry Andric MachineBasicBlock::instr_iterator 1046139f7f9bSDimitry Andric MachineBasicBlock::insert(instr_iterator I, MachineInstr *MI) { 1047139f7f9bSDimitry Andric assert(!MI->isBundledWithPred() && !MI->isBundledWithSucc() && 1048139f7f9bSDimitry Andric "Cannot insert instruction with bundle flags"); 1049139f7f9bSDimitry Andric // Set the bundle flags when inserting inside a bundle. 1050139f7f9bSDimitry Andric if (I != instr_end() && I->isBundledWithPred()) { 1051139f7f9bSDimitry Andric MI->setFlag(MachineInstr::BundledPred); 1052139f7f9bSDimitry Andric MI->setFlag(MachineInstr::BundledSucc); 1053dff0c46cSDimitry Andric } 1054139f7f9bSDimitry Andric return Insts.insert(I, MI); 1055dff0c46cSDimitry Andric } 1056dff0c46cSDimitry Andric 10577d523365SDimitry Andric /// This method unlinks 'this' from the containing function, and returns it, but 10587d523365SDimitry Andric /// does not delete it. 1059f22ef01cSRoman Divacky MachineBasicBlock *MachineBasicBlock::removeFromParent() { 1060f22ef01cSRoman Divacky assert(getParent() && "Not embedded in a function!"); 1061f22ef01cSRoman Divacky getParent()->remove(this); 1062f22ef01cSRoman Divacky return this; 1063f22ef01cSRoman Divacky } 1064f22ef01cSRoman Divacky 10657d523365SDimitry Andric /// This method unlinks 'this' from the containing function, and deletes it. 1066f22ef01cSRoman Divacky void MachineBasicBlock::eraseFromParent() { 1067f22ef01cSRoman Divacky assert(getParent() && "Not embedded in a function!"); 1068f22ef01cSRoman Divacky getParent()->erase(this); 1069f22ef01cSRoman Divacky } 1070f22ef01cSRoman Divacky 10717d523365SDimitry Andric /// Given a machine basic block that branched to 'Old', change the code and CFG 10727d523365SDimitry Andric /// so that it branches to 'New' instead. 1073f22ef01cSRoman Divacky void MachineBasicBlock::ReplaceUsesOfBlockWith(MachineBasicBlock *Old, 1074f22ef01cSRoman Divacky MachineBasicBlock *New) { 1075f22ef01cSRoman Divacky assert(Old != New && "Cannot replace self with self!"); 1076f22ef01cSRoman Divacky 1077dff0c46cSDimitry Andric MachineBasicBlock::instr_iterator I = instr_end(); 1078dff0c46cSDimitry Andric while (I != instr_begin()) { 1079f22ef01cSRoman Divacky --I; 1080dff0c46cSDimitry Andric if (!I->isTerminator()) break; 1081f22ef01cSRoman Divacky 1082f22ef01cSRoman Divacky // Scan the operands of this machine instruction, replacing any uses of Old 1083f22ef01cSRoman Divacky // with New. 1084f22ef01cSRoman Divacky for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) 1085f22ef01cSRoman Divacky if (I->getOperand(i).isMBB() && 1086f22ef01cSRoman Divacky I->getOperand(i).getMBB() == Old) 1087f22ef01cSRoman Divacky I->getOperand(i).setMBB(New); 1088f22ef01cSRoman Divacky } 1089f22ef01cSRoman Divacky 1090f22ef01cSRoman Divacky // Update the successor information. 109117a519f9SDimitry Andric replaceSuccessor(Old, New); 1092f22ef01cSRoman Divacky } 1093f22ef01cSRoman Divacky 10947d523365SDimitry Andric /// Various pieces of code can cause excess edges in the CFG to be inserted. If 10957d523365SDimitry Andric /// we have proven that MBB can only branch to DestA and DestB, remove any other 10967d523365SDimitry Andric /// MBB successors from the CFG. DestA and DestB can be null. 1097f22ef01cSRoman Divacky /// 1098f22ef01cSRoman Divacky /// Besides DestA and DestB, retain other edges leading to LandingPads 1099f22ef01cSRoman Divacky /// (currently there can be only one; we don't check or require that here). 1100f22ef01cSRoman Divacky /// Note it is possible that DestA and/or DestB are LandingPads. 1101f22ef01cSRoman Divacky bool MachineBasicBlock::CorrectExtraCFGEdges(MachineBasicBlock *DestA, 1102f22ef01cSRoman Divacky MachineBasicBlock *DestB, 11037d523365SDimitry Andric bool IsCond) { 1104f22ef01cSRoman Divacky // The values of DestA and DestB frequently come from a call to the 1105f22ef01cSRoman Divacky // 'TargetInstrInfo::AnalyzeBranch' method. We take our meaning of the initial 1106f22ef01cSRoman Divacky // values from there. 1107f22ef01cSRoman Divacky // 1108f22ef01cSRoman Divacky // 1. If both DestA and DestB are null, then the block ends with no branches 1109f22ef01cSRoman Divacky // (it falls through to its successor). 11107d523365SDimitry Andric // 2. If DestA is set, DestB is null, and IsCond is false, then the block ends 1111f22ef01cSRoman Divacky // with only an unconditional branch. 11127d523365SDimitry Andric // 3. If DestA is set, DestB is null, and IsCond is true, then the block ends 1113f22ef01cSRoman Divacky // with a conditional branch that falls through to a successor (DestB). 11147d523365SDimitry Andric // 4. If DestA and DestB is set and IsCond is true, then the block ends with a 1115f22ef01cSRoman Divacky // conditional branch followed by an unconditional branch. DestA is the 1116f22ef01cSRoman Divacky // 'true' destination and DestB is the 'false' destination. 1117f22ef01cSRoman Divacky 1118f22ef01cSRoman Divacky bool Changed = false; 1119f22ef01cSRoman Divacky 1120d88c1a5aSDimitry Andric MachineBasicBlock *FallThru = getNextNode(); 1121f22ef01cSRoman Divacky 112291bc56edSDimitry Andric if (!DestA && !DestB) { 1123f22ef01cSRoman Divacky // Block falls through to successor. 1124d88c1a5aSDimitry Andric DestA = FallThru; 1125d88c1a5aSDimitry Andric DestB = FallThru; 112691bc56edSDimitry Andric } else if (DestA && !DestB) { 11277d523365SDimitry Andric if (IsCond) 1128f22ef01cSRoman Divacky // Block ends in conditional jump that falls through to successor. 1129d88c1a5aSDimitry Andric DestB = FallThru; 1130f22ef01cSRoman Divacky } else { 11317d523365SDimitry Andric assert(DestA && DestB && IsCond && 1132f22ef01cSRoman Divacky "CFG in a bad state. Cannot correct CFG edges"); 1133f22ef01cSRoman Divacky } 1134f22ef01cSRoman Divacky 1135f22ef01cSRoman Divacky // Remove superfluous edges. I.e., those which aren't destinations of this 1136f22ef01cSRoman Divacky // basic block, duplicate edges, or landing pads. 1137f22ef01cSRoman Divacky SmallPtrSet<const MachineBasicBlock*, 8> SeenMBBs; 1138f22ef01cSRoman Divacky MachineBasicBlock::succ_iterator SI = succ_begin(); 1139f22ef01cSRoman Divacky while (SI != succ_end()) { 1140f22ef01cSRoman Divacky const MachineBasicBlock *MBB = *SI; 114139d628a0SDimitry Andric if (!SeenMBBs.insert(MBB).second || 11427d523365SDimitry Andric (MBB != DestA && MBB != DestB && !MBB->isEHPad())) { 1143f22ef01cSRoman Divacky // This is a superfluous edge, remove it. 1144f22ef01cSRoman Divacky SI = removeSuccessor(SI); 1145f22ef01cSRoman Divacky Changed = true; 1146f22ef01cSRoman Divacky } else { 1147f22ef01cSRoman Divacky ++SI; 1148f22ef01cSRoman Divacky } 1149f22ef01cSRoman Divacky } 1150f22ef01cSRoman Divacky 11517d523365SDimitry Andric if (Changed) 11527d523365SDimitry Andric normalizeSuccProbs(); 1153f22ef01cSRoman Divacky return Changed; 1154f22ef01cSRoman Divacky } 1155f22ef01cSRoman Divacky 11567d523365SDimitry Andric /// Find the next valid DebugLoc starting at MBBI, skipping any DBG_VALUE 11577d523365SDimitry Andric /// instructions. Return UnknownLoc if there is none. 1158f22ef01cSRoman Divacky DebugLoc 1159dff0c46cSDimitry Andric MachineBasicBlock::findDebugLoc(instr_iterator MBBI) { 1160f22ef01cSRoman Divacky // Skip debug declarations, we don't want a DebugLoc from them. 1161d88c1a5aSDimitry Andric MBBI = skipDebugInstructionsForward(MBBI, instr_end()); 1162d88c1a5aSDimitry Andric if (MBBI != instr_end()) 1163d88c1a5aSDimitry Andric return MBBI->getDebugLoc(); 1164d88c1a5aSDimitry Andric return {}; 1165f22ef01cSRoman Divacky } 1166f22ef01cSRoman Divacky 11677a7e6055SDimitry Andric /// Find and return the merged DebugLoc of the branch instructions of the block. 11687a7e6055SDimitry Andric /// Return UnknownLoc if there is none. 11697a7e6055SDimitry Andric DebugLoc 11707a7e6055SDimitry Andric MachineBasicBlock::findBranchDebugLoc() { 11717a7e6055SDimitry Andric DebugLoc DL; 11727a7e6055SDimitry Andric auto TI = getFirstTerminator(); 11737a7e6055SDimitry Andric while (TI != end() && !TI->isBranch()) 11747a7e6055SDimitry Andric ++TI; 11757a7e6055SDimitry Andric 11767a7e6055SDimitry Andric if (TI != end()) { 11777a7e6055SDimitry Andric DL = TI->getDebugLoc(); 11787a7e6055SDimitry Andric for (++TI ; TI != end() ; ++TI) 11797a7e6055SDimitry Andric if (TI->isBranch()) 11807a7e6055SDimitry Andric DL = DILocation::getMergedLocation(DL, TI->getDebugLoc()); 11817a7e6055SDimitry Andric } 11827a7e6055SDimitry Andric return DL; 11837a7e6055SDimitry Andric } 11847a7e6055SDimitry Andric 11857d523365SDimitry Andric /// Return probability of the edge from this block to MBB. 11867d523365SDimitry Andric BranchProbability 11877d523365SDimitry Andric MachineBasicBlock::getSuccProbability(const_succ_iterator Succ) const { 11887d523365SDimitry Andric if (Probs.empty()) 11897d523365SDimitry Andric return BranchProbability(1, succ_size()); 119017a519f9SDimitry Andric 11917d523365SDimitry Andric const auto &Prob = *getProbabilityIterator(Succ); 11927d523365SDimitry Andric if (Prob.isUnknown()) { 11937d523365SDimitry Andric // For unknown probabilities, collect the sum of all known ones, and evenly 11947d523365SDimitry Andric // ditribute the complemental of the sum to each unknown probability. 11957d523365SDimitry Andric unsigned KnownProbNum = 0; 11967d523365SDimitry Andric auto Sum = BranchProbability::getZero(); 11977d523365SDimitry Andric for (auto &P : Probs) { 11987d523365SDimitry Andric if (!P.isUnknown()) { 11997d523365SDimitry Andric Sum += P; 12007d523365SDimitry Andric KnownProbNum++; 12017d523365SDimitry Andric } 12027d523365SDimitry Andric } 12037d523365SDimitry Andric return Sum.getCompl() / (Probs.size() - KnownProbNum); 12047d523365SDimitry Andric } else 12057d523365SDimitry Andric return Prob; 120617a519f9SDimitry Andric } 120717a519f9SDimitry Andric 12087d523365SDimitry Andric /// Set successor probability of a given iterator. 12097d523365SDimitry Andric void MachineBasicBlock::setSuccProbability(succ_iterator I, 12107d523365SDimitry Andric BranchProbability Prob) { 12117d523365SDimitry Andric assert(!Prob.isUnknown()); 12127d523365SDimitry Andric if (Probs.empty()) 121391bc56edSDimitry Andric return; 12147d523365SDimitry Andric *getProbabilityIterator(I) = Prob; 121591bc56edSDimitry Andric } 121691bc56edSDimitry Andric 12177d523365SDimitry Andric /// Return probability iterator corresonding to the I successor iterator 12187d523365SDimitry Andric MachineBasicBlock::const_probability_iterator 12197d523365SDimitry Andric MachineBasicBlock::getProbabilityIterator( 12207d523365SDimitry Andric MachineBasicBlock::const_succ_iterator I) const { 12217d523365SDimitry Andric assert(Probs.size() == Successors.size() && "Async probability list!"); 1222dff0c46cSDimitry Andric const size_t index = std::distance(Successors.begin(), I); 12237d523365SDimitry Andric assert(index < Probs.size() && "Not a current successor!"); 12247d523365SDimitry Andric return Probs.begin() + index; 12257d523365SDimitry Andric } 12267d523365SDimitry Andric 12277d523365SDimitry Andric /// Return probability iterator corresonding to the I successor iterator. 12287d523365SDimitry Andric MachineBasicBlock::probability_iterator 12297d523365SDimitry Andric MachineBasicBlock::getProbabilityIterator(MachineBasicBlock::succ_iterator I) { 12307d523365SDimitry Andric assert(Probs.size() == Successors.size() && "Async probability list!"); 12317d523365SDimitry Andric const size_t index = std::distance(Successors.begin(), I); 12327d523365SDimitry Andric assert(index < Probs.size() && "Not a current successor!"); 12337d523365SDimitry Andric return Probs.begin() + index; 1234dff0c46cSDimitry Andric } 1235dff0c46cSDimitry Andric 12363861d79fSDimitry Andric /// Return whether (physical) register "Reg" has been <def>ined and not <kill>ed 12373861d79fSDimitry Andric /// as of just before "MI". 12383861d79fSDimitry Andric /// 12393861d79fSDimitry Andric /// Search is localised to a neighborhood of 12403861d79fSDimitry Andric /// Neighborhood instructions before (searching for defs or kills) and N 12413861d79fSDimitry Andric /// instructions after (searching just for defs) MI. 12423861d79fSDimitry Andric MachineBasicBlock::LivenessQueryResult 12433861d79fSDimitry Andric MachineBasicBlock::computeRegisterLiveness(const TargetRegisterInfo *TRI, 1244ff0cc061SDimitry Andric unsigned Reg, const_iterator Before, 1245ff0cc061SDimitry Andric unsigned Neighborhood) const { 12463861d79fSDimitry Andric unsigned N = Neighborhood; 12473861d79fSDimitry Andric 1248ff0cc061SDimitry Andric // Start by searching backwards from Before, looking for kills, reads or defs. 1249ff0cc061SDimitry Andric const_iterator I(Before); 12503861d79fSDimitry Andric // If this is the first insn in the block, don't search backwards. 1251ff0cc061SDimitry Andric if (I != begin()) { 12523861d79fSDimitry Andric do { 12533861d79fSDimitry Andric --I; 12543861d79fSDimitry Andric 12557d523365SDimitry Andric MachineOperandIteratorBase::PhysRegInfo Info = 12563ca95b02SDimitry Andric ConstMIOperands(*I).analyzePhysReg(Reg, TRI); 12573861d79fSDimitry Andric 12587d523365SDimitry Andric // Defs happen after uses so they take precedence if both are present. 1259139f7f9bSDimitry Andric 12607d523365SDimitry Andric // Register is dead after a dead def of the full register. 12617d523365SDimitry Andric if (Info.DeadDef) 12623861d79fSDimitry Andric return LQR_Dead; 12637d523365SDimitry Andric // Register is (at least partially) live after a def. 12643ca95b02SDimitry Andric if (Info.Defined) { 12653ca95b02SDimitry Andric if (!Info.PartialDeadDef) 12667d523365SDimitry Andric return LQR_Live; 12673ca95b02SDimitry Andric // As soon as we saw a partial definition (dead or not), 12683ca95b02SDimitry Andric // we cannot tell if the value is partial live without 12693ca95b02SDimitry Andric // tracking the lanemasks. We are not going to do this, 12703ca95b02SDimitry Andric // so fall back on the remaining of the analysis. 12713ca95b02SDimitry Andric break; 12723ca95b02SDimitry Andric } 12737d523365SDimitry Andric // Register is dead after a full kill or clobber and no def. 12747d523365SDimitry Andric if (Info.Killed || Info.Clobbered) 12757d523365SDimitry Andric return LQR_Dead; 12767d523365SDimitry Andric // Register must be live if we read it. 12777d523365SDimitry Andric if (Info.Read) 12787d523365SDimitry Andric return LQR_Live; 1279ff0cc061SDimitry Andric } while (I != begin() && --N > 0); 12803861d79fSDimitry Andric } 12813861d79fSDimitry Andric 12823861d79fSDimitry Andric // Did we get to the start of the block? 1283ff0cc061SDimitry Andric if (I == begin()) { 12843861d79fSDimitry Andric // If so, the register's state is definitely defined by the live-in state. 12857d523365SDimitry Andric for (MCRegAliasIterator RAI(Reg, TRI, /*IncludeSelf=*/true); RAI.isValid(); 12867d523365SDimitry Andric ++RAI) 1287ff0cc061SDimitry Andric if (isLiveIn(*RAI)) 12887d523365SDimitry Andric return LQR_Live; 12893861d79fSDimitry Andric 12903861d79fSDimitry Andric return LQR_Dead; 12913861d79fSDimitry Andric } 12923861d79fSDimitry Andric 12933861d79fSDimitry Andric N = Neighborhood; 12943861d79fSDimitry Andric 1295ff0cc061SDimitry Andric // Try searching forwards from Before, looking for reads or defs. 1296ff0cc061SDimitry Andric I = const_iterator(Before); 12973861d79fSDimitry Andric // If this is the last insn in the block, don't search forwards. 1298ff0cc061SDimitry Andric if (I != end()) { 1299ff0cc061SDimitry Andric for (++I; I != end() && N > 0; ++I, --N) { 13007d523365SDimitry Andric MachineOperandIteratorBase::PhysRegInfo Info = 13013ca95b02SDimitry Andric ConstMIOperands(*I).analyzePhysReg(Reg, TRI); 13023861d79fSDimitry Andric 13037d523365SDimitry Andric // Register is live when we read it here. 13047d523365SDimitry Andric if (Info.Read) 13057d523365SDimitry Andric return LQR_Live; 13067d523365SDimitry Andric // Register is dead if we can fully overwrite or clobber it here. 13077d523365SDimitry Andric if (Info.FullyDefined || Info.Clobbered) 13083861d79fSDimitry Andric return LQR_Dead; 13093861d79fSDimitry Andric } 13103861d79fSDimitry Andric } 13113861d79fSDimitry Andric 13123861d79fSDimitry Andric // At this point we have no idea of the liveness of the register. 13133861d79fSDimitry Andric return LQR_Unknown; 13143861d79fSDimitry Andric } 13157d523365SDimitry Andric 13167d523365SDimitry Andric const uint32_t * 13177d523365SDimitry Andric MachineBasicBlock::getBeginClobberMask(const TargetRegisterInfo *TRI) const { 13187d523365SDimitry Andric // EH funclet entry does not preserve any registers. 13197d523365SDimitry Andric return isEHFuncletEntry() ? TRI->getNoPreservedMask() : nullptr; 13207d523365SDimitry Andric } 13217d523365SDimitry Andric 13227d523365SDimitry Andric const uint32_t * 13237d523365SDimitry Andric MachineBasicBlock::getEndClobberMask(const TargetRegisterInfo *TRI) const { 13247d523365SDimitry Andric // If we see a return block with successors, this must be a funclet return, 13257d523365SDimitry Andric // which does not preserve any registers. If there are no successors, we don't 13267d523365SDimitry Andric // care what kind of return it is, putting a mask after it is a no-op. 13277d523365SDimitry Andric return isReturnBlock() && !succ_empty() ? TRI->getNoPreservedMask() : nullptr; 13287d523365SDimitry Andric } 1329d88c1a5aSDimitry Andric 1330d88c1a5aSDimitry Andric void MachineBasicBlock::clearLiveIns() { 1331d88c1a5aSDimitry Andric LiveIns.clear(); 1332d88c1a5aSDimitry Andric } 133395ec533aSDimitry Andric 133495ec533aSDimitry Andric MachineBasicBlock::livein_iterator MachineBasicBlock::livein_begin() const { 133595ec533aSDimitry Andric assert(getParent()->getProperties().hasProperty( 133695ec533aSDimitry Andric MachineFunctionProperties::Property::TracksLiveness) && 133795ec533aSDimitry Andric "Liveness information is accurate"); 133895ec533aSDimitry Andric return LiveIns.begin(); 133995ec533aSDimitry Andric } 1340