1 //===-- ARMConstantIslandPass.cpp - ARM constant islands --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains a pass that splits the constant pool up into 'islands'
11 // which are scattered through-out the function. This is required due to the
12 // limited pc-relative displacements that ARM has.
14 //===----------------------------------------------------------------------===//
16 #define DEBUG_TYPE "arm-cp-islands"
18 #include "ARMMachineFunctionInfo.h"
19 #include "ARMInstrInfo.h"
20 #include "llvm/CodeGen/MachineConstantPool.h"
21 #include "llvm/CodeGen/MachineFunctionPass.h"
22 #include "llvm/CodeGen/MachineInstrBuilder.h"
23 #include "llvm/Target/TargetData.h"
24 #include "llvm/Target/TargetMachine.h"
25 #include "llvm/Support/Compiler.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/ADT/SmallVector.h"
28 #include "llvm/ADT/STLExtras.h"
29 #include "llvm/ADT/Statistic.h"
32 STATISTIC(NumCPEs, "Number of constpool entries");
33 STATISTIC(NumSplit, "Number of uncond branches inserted");
34 STATISTIC(NumCBrFixed, "Number of cond branches fixed");
35 STATISTIC(NumUBrFixed, "Number of uncond branches fixed");
38 /// ARMConstantIslands - Due to limited PC-relative displacements, ARM
39 /// requires constant pool entries to be scattered among the instructions
40 /// inside a function. To do this, it completely ignores the normal LLVM
41 /// constant pool; instead, it places constants wherever it feels like with
42 /// special instructions.
44 /// The terminology used in this pass includes:
45 /// Islands - Clumps of constants placed in the function.
46 /// Water - Potential places where an island could be formed.
47 /// CPE - A constant pool entry that has been placed somewhere, which
48 /// tracks a list of users.
49 class VISIBILITY_HIDDEN ARMConstantIslands : public MachineFunctionPass {
50 /// NextUID - Assign unique ID's to CPE's.
53 /// BBSizes - The size of each MachineBasicBlock in bytes of code, indexed
55 std::vector<unsigned> BBSizes;
57 /// BBOffsets - the offset of each MBB in bytes, starting from 0.
58 std::vector<unsigned> BBOffsets;
60 /// WaterList - A sorted list of basic blocks where islands could be placed
61 /// (i.e. blocks that don't fall through to the following block, due
62 /// to a return, unreachable, or unconditional branch).
63 std::vector<MachineBasicBlock*> WaterList;
65 /// CPUser - One user of a constant pool, keeping the machine instruction
66 /// pointer, the constant pool being referenced, and the max displacement
67 /// allowed from the instruction to the CP.
72 CPUser(MachineInstr *mi, MachineInstr *cpemi, unsigned maxdisp)
73 : MI(mi), CPEMI(cpemi), MaxDisp(maxdisp) {}
76 /// CPUsers - Keep track of all of the machine instructions that use various
77 /// constant pools and their max displacement.
78 std::vector<CPUser> CPUsers;
80 /// CPEntry - One per constant pool entry, keeping the machine instruction
81 /// pointer, the constpool index, and the number of CPUser's which
82 /// reference this entry.
87 CPEntry(MachineInstr *cpemi, unsigned cpi, unsigned rc = 0)
88 : CPEMI(cpemi), CPI(cpi), RefCount(rc) {}
91 /// CPEntries - Keep track of all of the constant pool entry machine
92 /// instructions. For each original constpool index (i.e. those that
93 /// existed upon entry to this pass), it keeps a vector of entries.
94 /// Original elements are cloned as we go along; the clones are
95 /// put in the vector of the original element, but have distinct CPIs.
96 std::vector<std::vector<CPEntry> > CPEntries;
98 /// ImmBranch - One per immediate branch, keeping the machine instruction
99 /// pointer, conditional or unconditional, the max displacement,
100 /// and (if isCond is true) the corresponding unconditional branch
104 unsigned MaxDisp : 31;
107 ImmBranch(MachineInstr *mi, unsigned maxdisp, bool cond, int ubr)
108 : MI(mi), MaxDisp(maxdisp), isCond(cond), UncondBr(ubr) {}
111 /// Branches - Keep track of all the immediate branch instructions.
113 std::vector<ImmBranch> ImmBranches;
115 /// PushPopMIs - Keep track of all the Thumb push / pop instructions.
117 SmallVector<MachineInstr*, 4> PushPopMIs;
119 /// HasFarJump - True if any far jump instruction has been emitted during
120 /// the branch fix up pass.
123 const TargetInstrInfo *TII;
126 virtual bool runOnMachineFunction(MachineFunction &Fn);
128 virtual const char *getPassName() const {
129 return "ARM constant island placement and branch shortening pass";
133 void DoInitialPlacement(MachineFunction &Fn,
134 std::vector<MachineInstr*> &CPEMIs);
135 CPEntry *findConstPoolEntry(unsigned CPI, const MachineInstr *CPEMI);
136 void InitialFunctionScan(MachineFunction &Fn,
137 const std::vector<MachineInstr*> &CPEMIs);
138 MachineBasicBlock *SplitBlockBeforeInstr(MachineInstr *MI);
139 void UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB);
140 void AdjustBBOffsetsAfter(MachineBasicBlock *BB, int delta);
141 bool DecrementOldEntry(unsigned CPI, MachineInstr* CPEMI);
142 int LookForExistingCPEntry(CPUser& U, unsigned UserOffset);
143 bool LookForWater(CPUser&U, unsigned UserOffset, bool* PadNewWater,
144 MachineBasicBlock** NewMBB);
145 void CreateNewWater(unsigned CPUserIndex, unsigned UserOffset,
146 MachineBasicBlock** NewMBB);
147 bool HandleConstantPoolUser(MachineFunction &Fn, unsigned CPUserIndex);
148 void RemoveDeadCPEMI(MachineInstr *CPEMI);
149 bool RemoveUnusedCPEntries();
150 bool CPEIsInRange(MachineInstr *MI, unsigned UserOffset,
151 MachineInstr *CPEMI, unsigned Disp,
153 bool WaterIsInRange(unsigned UserOffset, MachineBasicBlock *Water,
155 bool OffsetIsInRange(unsigned UserOffset, unsigned TrialOffset,
156 unsigned Disp, bool NegativeOK);
157 bool BBIsInRange(MachineInstr *MI, MachineBasicBlock *BB, unsigned Disp);
158 bool FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br);
159 bool FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br);
160 bool FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br);
161 bool UndoLRSpillRestore();
163 unsigned GetOffsetOf(MachineInstr *MI) const;
167 /// createARMConstantIslandPass - returns an instance of the constpool
169 FunctionPass *llvm::createARMConstantIslandPass() {
170 return new ARMConstantIslands();
173 bool ARMConstantIslands::runOnMachineFunction(MachineFunction &Fn) {
174 MachineConstantPool &MCP = *Fn.getConstantPool();
175 ARMFunctionInfo *AFI = Fn.getInfo<ARMFunctionInfo>();
177 TII = Fn.getTarget().getInstrInfo();
178 isThumb = AFI->isThumbFunction();
182 // Renumber all of the machine basic blocks in the function, guaranteeing that
183 // the numbers agree with the position of the block in the function.
186 /// Thumb functions containing constant pools get 2-byte alignment. This is so
187 /// we can keep exact track of where the alignment padding goes. Set default.
188 AFI->setAlign(isThumb ? 1U : 2U);
190 // Perform the initial placement of the constant pool entries. To start with,
191 // we put them all at the end of the function.
192 std::vector<MachineInstr*> CPEMIs;
193 if (!MCP.isEmpty()) {
194 DoInitialPlacement(Fn, CPEMIs);
199 /// The next UID to take is the first unused one.
200 NextUID = CPEMIs.size();
202 // Do the initial scan of the function, building up information about the
203 // sizes of each block, the location of all the water, and finding all of the
204 // constant pool users.
205 InitialFunctionScan(Fn, CPEMIs);
208 /// Remove dead constant pool entries.
209 RemoveUnusedCPEntries();
211 // Iteratively place constant pool entries and fix up branches until there
213 bool MadeChange = false;
216 for (unsigned i = 0, e = CPUsers.size(); i != e; ++i)
217 Change |= HandleConstantPoolUser(Fn, i);
218 for (unsigned i = 0, e = ImmBranches.size(); i != e; ++i)
219 Change |= FixUpImmediateBr(Fn, ImmBranches[i]);
225 // If LR has been forced spilled and no far jumps (i.e. BL) has been issued.
226 // Undo the spill / restore of LR if possible.
227 if (!HasFarJump && AFI->isLRSpilledForFarJump() && isThumb)
228 MadeChange |= UndoLRSpillRestore();
241 /// DoInitialPlacement - Perform the initial placement of the constant pool
242 /// entries. To start with, we put them all at the end of the function.
243 void ARMConstantIslands::DoInitialPlacement(MachineFunction &Fn,
244 std::vector<MachineInstr*> &CPEMIs){
245 // Create the basic block to hold the CPE's.
246 MachineBasicBlock *BB = new MachineBasicBlock();
247 Fn.getBasicBlockList().push_back(BB);
249 // Add all of the constants from the constant pool to the end block, use an
250 // identity mapping of CPI's to CPE's.
251 const std::vector<MachineConstantPoolEntry> &CPs =
252 Fn.getConstantPool()->getConstants();
254 const TargetData &TD = *Fn.getTarget().getTargetData();
255 for (unsigned i = 0, e = CPs.size(); i != e; ++i) {
256 unsigned Size = TD.getTypeSize(CPs[i].getType());
257 // Verify that all constant pool entries are a multiple of 4 bytes. If not,
258 // we would have to pad them out or something so that instructions stay
260 assert((Size & 3) == 0 && "CP Entry not multiple of 4 bytes!");
261 MachineInstr *CPEMI =
262 BuildMI(BB, TII->get(ARM::CONSTPOOL_ENTRY))
263 .addImm(i).addConstantPoolIndex(i).addImm(Size);
264 CPEMIs.push_back(CPEMI);
266 // Add a new CPEntry, but no corresponding CPUser yet.
267 std::vector<CPEntry> CPEs;
268 CPEs.push_back(CPEntry(CPEMI, i));
269 CPEntries.push_back(CPEs);
271 DOUT << "Moved CPI#" << i << " to end of function as #" << i << "\n";
275 /// BBHasFallthrough - Return true if the specified basic block can fallthrough
276 /// into the block immediately after it.
277 static bool BBHasFallthrough(MachineBasicBlock *MBB) {
278 // Get the next machine basic block in the function.
279 MachineFunction::iterator MBBI = MBB;
280 if (next(MBBI) == MBB->getParent()->end()) // Can't fall off end of function.
283 MachineBasicBlock *NextBB = next(MBBI);
284 for (MachineBasicBlock::succ_iterator I = MBB->succ_begin(),
285 E = MBB->succ_end(); I != E; ++I)
292 /// findConstPoolEntry - Given the constpool index and CONSTPOOL_ENTRY MI,
293 /// look up the corresponding CPEntry.
294 ARMConstantIslands::CPEntry
295 *ARMConstantIslands::findConstPoolEntry(unsigned CPI,
296 const MachineInstr *CPEMI) {
297 std::vector<CPEntry> &CPEs = CPEntries[CPI];
298 // Number of entries per constpool index should be small, just do a
300 for (unsigned i = 0, e = CPEs.size(); i != e; ++i) {
301 if (CPEs[i].CPEMI == CPEMI)
307 /// InitialFunctionScan - Do the initial scan of the function, building up
308 /// information about the sizes of each block, the location of all the water,
309 /// and finding all of the constant pool users.
310 void ARMConstantIslands::InitialFunctionScan(MachineFunction &Fn,
311 const std::vector<MachineInstr*> &CPEMIs) {
313 for (MachineFunction::iterator MBBI = Fn.begin(), E = Fn.end();
315 MachineBasicBlock &MBB = *MBBI;
317 // If this block doesn't fall through into the next MBB, then this is
318 // 'water' that a constant pool island could be placed.
319 if (!BBHasFallthrough(&MBB))
320 WaterList.push_back(&MBB);
322 unsigned MBBSize = 0;
323 for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
325 // Add instruction size to MBBSize.
326 MBBSize += ARM::GetInstSize(I);
328 int Opc = I->getOpcode();
329 if (TII->isBranch(Opc)) {
336 continue; // Ignore JT branches
357 // Record this immediate branch.
358 unsigned MaxOffs = ((1 << (Bits-1))-1) * Scale;
359 ImmBranches.push_back(ImmBranch(I, MaxOffs, isCond, UOpc));
362 if (Opc == ARM::tPUSH || Opc == ARM::tPOP_RET)
363 PushPopMIs.push_back(I);
365 // Scan the instructions for constant pool operands.
366 for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op)
367 if (I->getOperand(op).isConstantPoolIndex()) {
368 // We found one. The addressing mode tells us the max displacement
369 // from the PC that this instruction permits.
371 // Basic size info comes from the TSFlags field.
374 unsigned TSFlags = I->getInstrDescriptor()->TSFlags;
375 switch (TSFlags & ARMII::AddrModeMask) {
377 // Constant pool entries can reach anything.
378 if (I->getOpcode() == ARM::CONSTPOOL_ENTRY)
380 assert(0 && "Unknown addressing mode for CP reference!");
381 case ARMII::AddrMode1: // AM1: 8 bits << 2
383 Scale = 4; // Taking the address of a CP entry.
385 case ARMII::AddrMode2:
386 Bits = 12; // +-offset_12
388 case ARMII::AddrMode3:
389 Bits = 8; // +-offset_8
391 // addrmode4 has no immediate offset.
392 case ARMII::AddrMode5:
394 Scale = 4; // +-(offset_8*4)
396 case ARMII::AddrModeT1:
397 Bits = 5; // +offset_5
399 case ARMII::AddrModeT2:
401 Scale = 2; // +(offset_5*2)
403 case ARMII::AddrModeT4:
405 Scale = 4; // +(offset_5*4)
407 case ARMII::AddrModeTs:
409 Scale = 4; // +(offset_8*4)
413 // Remember that this is a user of a CP entry.
414 unsigned CPI = I->getOperand(op).getConstantPoolIndex();
415 MachineInstr *CPEMI = CPEMIs[CPI];
416 unsigned MaxOffs = ((1 << Bits)-1) * Scale;
417 CPUsers.push_back(CPUser(I, CPEMI, MaxOffs));
419 // Increment corresponding CPEntry reference count.
420 CPEntry *CPE = findConstPoolEntry(CPI, CPEMI);
421 assert(CPE && "Cannot find a corresponding CPEntry!");
424 // Instructions can only use one CP entry, don't bother scanning the
425 // rest of the operands.
430 // In thumb mode, if this block is a constpool island, pessimistically
431 // assume it needs to be padded by two byte so it's aligned on 4 byte
435 MBB.begin()->getOpcode() == ARM::CONSTPOOL_ENTRY)
438 BBSizes.push_back(MBBSize);
439 BBOffsets.push_back(Offset);
444 /// GetOffsetOf - Return the current offset of the specified machine instruction
445 /// from the start of the function. This offset changes as stuff is moved
446 /// around inside the function.
447 unsigned ARMConstantIslands::GetOffsetOf(MachineInstr *MI) const {
448 MachineBasicBlock *MBB = MI->getParent();
450 // The offset is composed of two things: the sum of the sizes of all MBB's
451 // before this instruction's block, and the offset from the start of the block
453 unsigned Offset = BBOffsets[MBB->getNumber()];
455 // Sum instructions before MI in MBB.
456 for (MachineBasicBlock::iterator I = MBB->begin(); ; ++I) {
457 assert(I != MBB->end() && "Didn't find MI in its own basic block?");
458 if (&*I == MI) return Offset;
459 Offset += ARM::GetInstSize(I);
463 /// CompareMBBNumbers - Little predicate function to sort the WaterList by MBB
465 static bool CompareMBBNumbers(const MachineBasicBlock *LHS,
466 const MachineBasicBlock *RHS) {
467 return LHS->getNumber() < RHS->getNumber();
470 /// UpdateForInsertedWaterBlock - When a block is newly inserted into the
471 /// machine function, it upsets all of the block numbers. Renumber the blocks
472 /// and update the arrays that parallel this numbering.
473 void ARMConstantIslands::UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB) {
474 // Renumber the MBB's to keep them consequtive.
475 NewBB->getParent()->RenumberBlocks(NewBB);
477 // Insert a size into BBSizes to align it properly with the (newly
478 // renumbered) block numbers.
479 BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
481 // Likewise for BBOffsets.
482 BBOffsets.insert(BBOffsets.begin()+NewBB->getNumber(), 0);
484 // Next, update WaterList. Specifically, we need to add NewMBB as having
485 // available water after it.
486 std::vector<MachineBasicBlock*>::iterator IP =
487 std::lower_bound(WaterList.begin(), WaterList.end(), NewBB,
489 WaterList.insert(IP, NewBB);
493 /// Split the basic block containing MI into two blocks, which are joined by
494 /// an unconditional branch. Update datastructures and renumber blocks to
495 /// account for this change and returns the newly created block.
496 MachineBasicBlock *ARMConstantIslands::SplitBlockBeforeInstr(MachineInstr *MI) {
497 MachineBasicBlock *OrigBB = MI->getParent();
499 // Create a new MBB for the code after the OrigBB.
500 MachineBasicBlock *NewBB = new MachineBasicBlock(OrigBB->getBasicBlock());
501 MachineFunction::iterator MBBI = OrigBB; ++MBBI;
502 OrigBB->getParent()->getBasicBlockList().insert(MBBI, NewBB);
504 // Splice the instructions starting with MI over to NewBB.
505 NewBB->splice(NewBB->end(), OrigBB, MI, OrigBB->end());
507 // Add an unconditional branch from OrigBB to NewBB.
508 // Note the new unconditional branch is not being recorded.
509 BuildMI(OrigBB, TII->get(isThumb ? ARM::tB : ARM::B)).addMBB(NewBB);
512 // Update the CFG. All succs of OrigBB are now succs of NewBB.
513 while (!OrigBB->succ_empty()) {
514 MachineBasicBlock *Succ = *OrigBB->succ_begin();
515 OrigBB->removeSuccessor(Succ);
516 NewBB->addSuccessor(Succ);
518 // This pass should be run after register allocation, so there should be no
519 // PHI nodes to update.
520 assert((Succ->empty() || Succ->begin()->getOpcode() != TargetInstrInfo::PHI)
521 && "PHI nodes should be eliminated by now!");
524 // OrigBB branches to NewBB.
525 OrigBB->addSuccessor(NewBB);
527 // Update internal data structures to account for the newly inserted MBB.
528 // This is almost the same as UpdateForInsertedWaterBlock, except that
529 // the Water goes after OrigBB, not NewBB.
530 NewBB->getParent()->RenumberBlocks(NewBB);
532 // Insert a size into BBSizes to align it properly with the (newly
533 // renumbered) block numbers.
534 BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
536 // Likewise for BBOffsets.
537 BBOffsets.insert(BBOffsets.begin()+NewBB->getNumber(), 0);
539 // Next, update WaterList. Specifically, we need to add OrigMBB as having
540 // available water after it (but not if it's already there, which happens
541 // when splitting before a conditional branch that is followed by an
542 // unconditional branch - in that case we want to insert NewBB).
543 std::vector<MachineBasicBlock*>::iterator IP =
544 std::lower_bound(WaterList.begin(), WaterList.end(), OrigBB,
546 MachineBasicBlock* WaterBB = *IP;
547 if (WaterBB == OrigBB)
548 WaterList.insert(next(IP), NewBB);
550 WaterList.insert(IP, OrigBB);
552 // Figure out how large the first NewMBB is.
553 unsigned NewBBSize = 0;
554 for (MachineBasicBlock::iterator I = NewBB->begin(), E = NewBB->end();
556 NewBBSize += ARM::GetInstSize(I);
558 unsigned OrigBBI = OrigBB->getNumber();
559 unsigned NewBBI = NewBB->getNumber();
560 // Set the size of NewBB in BBSizes.
561 BBSizes[NewBBI] = NewBBSize;
563 // We removed instructions from UserMBB, subtract that off from its size.
564 // Add 2 or 4 to the block to count the unconditional branch we added to it.
565 unsigned delta = isThumb ? 2 : 4;
566 BBSizes[OrigBBI] -= NewBBSize - delta;
568 // ...and adjust BBOffsets for NewBB accordingly.
569 BBOffsets[NewBBI] = BBOffsets[OrigBBI] + BBSizes[OrigBBI];
571 // All BBOffsets following these blocks must be modified.
572 AdjustBBOffsetsAfter(NewBB, delta);
577 /// OffsetIsInRange - Checks whether UserOffset is within MaxDisp of
579 bool ARMConstantIslands::OffsetIsInRange(unsigned UserOffset,
580 unsigned TrialOffset, unsigned MaxDisp, bool NegativeOK) {
581 if (UserOffset <= TrialOffset) {
582 // User before the Trial.
583 if (TrialOffset-UserOffset <= MaxDisp)
585 } else if (NegativeOK) {
586 if (UserOffset-TrialOffset <= MaxDisp)
592 /// WaterIsInRange - Returns true if a CPE placed after the specified
593 /// Water (a basic block) will be in range for the specific MI.
595 bool ARMConstantIslands::WaterIsInRange(unsigned UserOffset,
596 MachineBasicBlock* Water, unsigned MaxDisp)
598 unsigned CPEOffset = BBOffsets[Water->getNumber()] +
599 BBSizes[Water->getNumber()];
600 // If the Water is a constpool island, it has already been aligned.
604 Water->begin()->getOpcode() != ARM::CONSTPOOL_ENTRY))
607 // If the CPE is to be inserted before the instruction, that will raise
608 // the offset of the instruction.
609 if (CPEOffset < UserOffset)
610 UserOffset += isThumb ? 2 : 4;
612 return OffsetIsInRange (UserOffset, CPEOffset, MaxDisp, !isThumb);
615 /// CPEIsInRange - Returns true if the distance between specific MI and
616 /// specific ConstPool entry instruction can fit in MI's displacement field.
617 bool ARMConstantIslands::CPEIsInRange(MachineInstr *MI, unsigned UserOffset,
619 unsigned MaxDisp, bool DoDump) {
620 // In thumb mode, pessimistically assumes the .align 2 before the first CPE
621 // in the island adds two byte padding.
622 unsigned AlignAdj = isThumb ? 2 : 0;
623 unsigned CPEOffset = GetOffsetOf(CPEMI) + AlignAdj;
626 DOUT << "User of CPE#" << CPEMI->getOperand(0).getImm()
627 << " max delta=" << MaxDisp
628 << " insn address=" << UserOffset
629 << " CPE address=" << CPEOffset
630 << " offset=" << int(CPEOffset-UserOffset) << "\t" << *MI;
633 return OffsetIsInRange(UserOffset, CPEOffset, MaxDisp, !isThumb);
636 /// BBIsJumpedOver - Return true of the specified basic block's only predecessor
637 /// unconditionally branches to its only successor.
638 static bool BBIsJumpedOver(MachineBasicBlock *MBB) {
639 if (MBB->pred_size() != 1 || MBB->succ_size() != 1)
642 MachineBasicBlock *Succ = *MBB->succ_begin();
643 MachineBasicBlock *Pred = *MBB->pred_begin();
644 MachineInstr *PredMI = &Pred->back();
645 if (PredMI->getOpcode() == ARM::B || PredMI->getOpcode() == ARM::tB)
646 return PredMI->getOperand(0).getMBB() == Succ;
650 void ARMConstantIslands::AdjustBBOffsetsAfter(MachineBasicBlock *BB, int delta)
652 MachineFunction::iterator MBBI = BB->getParent()->end();
653 for(unsigned i=BB->getNumber()+1; i<BB->getParent()->getNumBlockIDs(); i++)
654 BBOffsets[i] += delta;
657 /// DecrementOldEntry - find the constant pool entry with index CPI
658 /// and instruction CPEMI, and decrement its refcount. If the refcount
659 /// becomes 0 remove the entry and instruction. Returns true if we removed
660 /// the entry, false if we didn't.
662 bool ARMConstantIslands::DecrementOldEntry(unsigned CPI, MachineInstr *CPEMI) {
663 // Find the old entry. Eliminate it if it is no longer used.
664 CPEntry *CPE = findConstPoolEntry(CPI, CPEMI);
665 assert(CPE && "Unexpected!");
666 if (--CPE->RefCount == 0) {
667 RemoveDeadCPEMI(CPEMI);
675 /// LookForCPEntryInRange - see if the currently referenced CPE is in range;
676 /// if not, see if an in-range clone of the CPE is in range, and if so,
677 /// change the data structures so the user references the clone. Returns:
678 /// 0 = no existing entry found
679 /// 1 = entry found, and there were no code insertions or deletions
680 /// 2 = entry found, and there were code insertions or deletions
681 int ARMConstantIslands::LookForExistingCPEntry(CPUser& U, unsigned UserOffset)
683 MachineInstr *UserMI = U.MI;
684 MachineInstr *CPEMI = U.CPEMI;
686 // Check to see if the CPE is already in-range.
687 if (CPEIsInRange(UserMI, UserOffset, CPEMI, U.MaxDisp, true)) {
688 DOUT << "In range\n";
692 // No. Look for previously created clones of the CPE that are in range.
693 unsigned CPI = CPEMI->getOperand(1).getConstantPoolIndex();
694 std::vector<CPEntry> &CPEs = CPEntries[CPI];
695 for (unsigned i = 0, e = CPEs.size(); i != e; ++i) {
696 // We already tried this one
697 if (CPEs[i].CPEMI == CPEMI)
699 // Removing CPEs can leave empty entries, skip
700 if (CPEs[i].CPEMI == NULL)
702 if (CPEIsInRange(UserMI, UserOffset, CPEs[i].CPEMI, U.MaxDisp, false)) {
703 DOUT << "Replacing CPE#" << CPI << " with CPE#" << CPEs[i].CPI << "\n";
704 // Point the CPUser node to the replacement
705 U.CPEMI = CPEs[i].CPEMI;
706 // Change the CPI in the instruction operand to refer to the clone.
707 for (unsigned j = 0, e = UserMI->getNumOperands(); j != e; ++j)
708 if (UserMI->getOperand(j).isConstantPoolIndex()) {
709 UserMI->getOperand(j).setConstantPoolIndex(CPEs[i].CPI);
712 // Adjust the refcount of the clone...
714 // ...and the original. If we didn't remove the old entry, none of the
715 // addresses changed, so we don't need another pass.
716 return DecrementOldEntry(CPI, CPEMI) ? 2 : 1;
722 /// getUnconditionalBrDisp - Returns the maximum displacement that can fit in
723 /// the specific unconditional branch instruction.
724 static inline unsigned getUnconditionalBrDisp(int Opc) {
725 return (Opc == ARM::tB) ? ((1<<10)-1)*2 : ((1<<23)-1)*4;
728 /// LookForWater - look for an existing entry in the WaterList in which
729 /// we can place the CPE referenced from U so it's within range of U's MI.
730 /// Returns true if found, false if not. If it returns true, *NewMBB
731 /// is set to the WaterList entry, and *PadNewWater is set to false if
732 /// the WaterList entry is an island.
734 bool ARMConstantIslands::LookForWater(CPUser &U, unsigned UserOffset,
735 bool *PadNewWater, MachineBasicBlock** NewMBB) {
736 if (!WaterList.empty()) {
737 for (std::vector<MachineBasicBlock*>::iterator IP = prior(WaterList.end()),
738 B = WaterList.begin();; --IP) {
739 MachineBasicBlock* WaterBB = *IP;
740 if (WaterIsInRange(UserOffset, WaterBB, U.MaxDisp)) {
741 DOUT << "found water in range\n";
742 // CPE goes before following block (NewMBB).
743 *NewMBB = next(MachineFunction::iterator(WaterBB));
744 // If WaterBB is an island, don't pad the new island.
745 // If WaterBB is empty, go backwards until we find something that
746 // isn't. WaterBB may become empty if it's an island whose
747 // contents were moved farther back.
749 MachineBasicBlock* BB = WaterBB;
751 BB = prior(MachineFunction::iterator(BB));
752 if (BB->begin()->getOpcode() == ARM::CONSTPOOL_ENTRY)
753 *PadNewWater = false;
755 // Remove the original WaterList entry; we want subsequent
756 // insertions in this vicinity to go after the one we're
757 // about to insert. This considerably reduces the number
758 // of times we have to move the same CPE more than once.
769 /// CreateNewWater - No existing WaterList entry will work for
770 /// CPUsers[CPUserIndex], so create a place to put the CPE. The end of the
771 /// block is used if in range, and the conditional branch munged so control
772 /// flow is correct. Otherwise the block is split to create a hole with an
773 /// unconditional branch around it. In either case *NewMBB is set to a
774 /// block following which the new island can be inserted (the WaterList
775 /// is not adjusted).
777 void ARMConstantIslands::CreateNewWater(unsigned CPUserIndex,
778 unsigned UserOffset, MachineBasicBlock** NewMBB) {
779 CPUser &U = CPUsers[CPUserIndex];
780 MachineInstr *UserMI = U.MI;
781 MachineInstr *CPEMI = U.CPEMI;
782 MachineBasicBlock *UserMBB = UserMI->getParent();
783 unsigned OffsetOfNextBlock = BBOffsets[UserMBB->getNumber()] +
784 BBSizes[UserMBB->getNumber()];
785 assert(OffsetOfNextBlock = BBOffsets[UserMBB->getNumber()+1]);
787 // If the use is at the end of the block, or the end of the block
788 // is within range, make new water there. (The +2 or 4 below is
789 // for the unconditional branch we will be adding. If the block ends in
790 // an unconditional branch already, it is water, and is known to
791 // be out of range, so we'll always be adding one.)
792 if (&UserMBB->back() == UserMI ||
793 OffsetIsInRange(UserOffset, OffsetOfNextBlock + (isThumb ? 2 : 4),
794 U.MaxDisp, !isThumb)) {
795 DOUT << "Split at end of block\n";
796 if (&UserMBB->back() == UserMI)
797 assert(BBHasFallthrough(UserMBB) && "Expected a fallthrough BB!");
798 *NewMBB = next(MachineFunction::iterator(UserMBB));
799 // Add an unconditional branch from UserMBB to fallthrough block.
800 // Record it for branch lengthening; this new branch will not get out of
801 // range, but if the preceding conditional branch is out of range, the
802 // targets will be exchanged, and the altered branch may be out of
803 // range, so the machinery has to know about it.
804 int UncondBr = isThumb ? ARM::tB : ARM::B;
805 BuildMI(UserMBB, TII->get(UncondBr)).addMBB(*NewMBB);
806 unsigned MaxDisp = getUnconditionalBrDisp(UncondBr);
807 ImmBranches.push_back(ImmBranch(&UserMBB->back(),
808 MaxDisp, false, UncondBr));
809 int delta = isThumb ? 2 : 4;
810 BBSizes[UserMBB->getNumber()] += delta;
811 AdjustBBOffsetsAfter(UserMBB, delta);
813 // What a big block. Find a place within the block to split it.
814 // This is a little tricky on Thumb since instructions are 2 bytes
815 // and constant pool entries are 4 bytes: if instruction I references
816 // island CPE, and instruction I+1 references CPE', it will
817 // not work well to put CPE as far forward as possible, since then
818 // CPE' cannot immediately follow it (that location is 2 bytes
819 // farther away from I+1 than CPE was from I) and we'd need to create
821 // The 4 in the following is for the unconditional branch we'll be
822 // inserting (allows for long branch on Thumb). The 2 or 0 is for
823 // alignment of the island.
824 unsigned BaseInsertOffset = UserOffset + U.MaxDisp -4 + (isThumb ? 2 : 0);
825 // This could point off the end of the block if we've already got
826 // constant pool entries following this block; only the last one is
827 // in the water list. Back past any possible branches (allow for a
828 // conditional and a maximally long unconditional).
829 if (BaseInsertOffset >= BBOffsets[UserMBB->getNumber()+1])
830 BaseInsertOffset = BBOffsets[UserMBB->getNumber()+1] -
832 unsigned EndInsertOffset = BaseInsertOffset +
833 CPEMI->getOperand(2).getImm();
834 MachineBasicBlock::iterator MI = UserMI;
836 unsigned CPUIndex = CPUserIndex+1;
837 for (unsigned Offset = UserOffset+ARM::GetInstSize(UserMI);
838 Offset < BaseInsertOffset;
839 Offset += ARM::GetInstSize(MI),
841 if (CPUIndex < CPUsers.size() && CPUsers[CPUIndex].MI == MI) {
842 if (!OffsetIsInRange(Offset, EndInsertOffset,
843 CPUsers[CPUIndex].MaxDisp, !isThumb)) {
844 BaseInsertOffset -= (isThumb ? 2 : 4);
845 EndInsertOffset -= (isThumb ? 2 : 4);
847 // This is overly conservative, as we don't account for CPEMIs
848 // being reused within the block, but it doesn't matter much.
849 EndInsertOffset += CPUsers[CPUIndex].CPEMI->getOperand(2).getImm();
853 DOUT << "Split in middle of big block\n";
854 *NewMBB = SplitBlockBeforeInstr(prior(MI));
858 /// HandleConstantPoolUser - Analyze the specified user, checking to see if it
859 /// is out-of-range. If so, pick it up the constant pool value and move it some
860 /// place in-range. Return true if we changed any addresses (thus must run
861 /// another pass of branch lengthening), false otherwise.
862 bool ARMConstantIslands::HandleConstantPoolUser(MachineFunction &Fn,
863 unsigned CPUserIndex){
864 CPUser &U = CPUsers[CPUserIndex];
865 MachineInstr *UserMI = U.MI;
866 MachineInstr *CPEMI = U.CPEMI;
867 unsigned CPI = CPEMI->getOperand(1).getConstantPoolIndex();
868 unsigned Size = CPEMI->getOperand(2).getImm();
869 MachineBasicBlock *NewMBB;
870 // Compute this only once, it's expensive
871 unsigned UserOffset = GetOffsetOf(UserMI) + (isThumb ? 4 : 8);
873 // See if the current entry is within range, or there is a clone of it
875 int result = LookForExistingCPEntry(U, UserOffset);
876 if (result==1) return false;
877 else if (result==2) return true;
879 // No existing clone of this CPE is within range.
880 // We will be generating a new clone. Get a UID for it.
881 unsigned ID = NextUID++;
883 // Look for water where we can place this CPE. We look for the farthest one
884 // away that will work. Forward references only for now (although later
885 // we might find some that are backwards).
886 bool PadNewWater = true;
888 if (!LookForWater(U, UserOffset, &PadNewWater, &NewMBB)) {
890 DOUT << "No water found\n";
891 CreateNewWater(CPUserIndex, UserOffset, &NewMBB);
894 // Okay, we know we can put an island before NewMBB now, do it!
895 MachineBasicBlock *NewIsland = new MachineBasicBlock();
896 Fn.getBasicBlockList().insert(NewMBB, NewIsland);
898 // Update internal data structures to account for the newly inserted MBB.
899 UpdateForInsertedWaterBlock(NewIsland);
901 // Decrement the old entry, and remove it if refcount becomes 0.
902 DecrementOldEntry(CPI, CPEMI);
904 // Now that we have an island to add the CPE to, clone the original CPE and
905 // add it to the island.
906 U.CPEMI = BuildMI(NewIsland, TII->get(ARM::CONSTPOOL_ENTRY))
907 .addImm(ID).addConstantPoolIndex(CPI).addImm(Size);
908 CPEntries[CPI].push_back(CPEntry(U.CPEMI, ID, 1));
911 // Compensate for .align 2 in thumb mode.
912 if (isThumb && PadNewWater) Size += 2;
913 // Increase the size of the island block to account for the new entry.
914 BBSizes[NewIsland->getNumber()] += Size;
915 BBOffsets[NewIsland->getNumber()] = BBOffsets[NewMBB->getNumber()];
916 AdjustBBOffsetsAfter(NewIsland, Size);
918 // Finally, change the CPI in the instruction operand to be ID.
919 for (unsigned i = 0, e = UserMI->getNumOperands(); i != e; ++i)
920 if (UserMI->getOperand(i).isConstantPoolIndex()) {
921 UserMI->getOperand(i).setConstantPoolIndex(ID);
925 DOUT << " Moved CPE to #" << ID << " CPI=" << CPI << "\t" << *UserMI;
930 /// RemoveDeadCPEMI - Remove a dead constant pool entry instruction. Update
931 /// sizes and offsets of impacted basic blocks.
932 void ARMConstantIslands::RemoveDeadCPEMI(MachineInstr *CPEMI) {
933 MachineBasicBlock *CPEBB = CPEMI->getParent();
934 if (CPEBB->empty()) {
935 // In thumb mode, the size of island is padded by two to compensate for
936 // the alignment requirement. Thus it will now be 2 when the block is
937 // empty, so fix this.
938 // All succeeding offsets have the current size value added in, fix this.
939 if (BBSizes[CPEBB->getNumber()] != 0) {
940 AdjustBBOffsetsAfter(CPEBB, -BBSizes[CPEBB->getNumber()]);
941 BBSizes[CPEBB->getNumber()] = 0;
943 // An island has only one predecessor BB and one successor BB. Check if
944 // this BB's predecessor jumps directly to this BB's successor. This
945 // shouldn't happen currently.
946 assert(!BBIsJumpedOver(CPEBB) && "How did this happen?");
947 // FIXME: remove the empty blocks after all the work is done?
949 unsigned Size = CPEMI->getOperand(2).getImm();
950 BBSizes[CPEBB->getNumber()] -= Size;
951 // All succeeding offsets have the current size value added in, fix this.
952 AdjustBBOffsetsAfter(CPEBB, -Size);
955 CPEMI->eraseFromParent();
958 /// RemoveUnusedCPEntries - Remove constant pool entries whose refcounts
960 bool ARMConstantIslands::RemoveUnusedCPEntries() {
961 unsigned MadeChange = false;
962 for (unsigned i = 0, e = CPEntries.size(); i != e; ++i) {
963 std::vector<CPEntry> &CPEs = CPEntries[i];
964 for (unsigned j = 0, ee = CPEs.size(); j != ee; ++j) {
965 if (CPEs[j].RefCount == 0 && CPEs[j].CPEMI) {
966 RemoveDeadCPEMI(CPEs[j].CPEMI);
967 CPEs[j].CPEMI = NULL;
975 /// BBIsInRange - Returns true if the distance between specific MI and
976 /// specific BB can fit in MI's displacement field.
977 bool ARMConstantIslands::BBIsInRange(MachineInstr *MI,MachineBasicBlock *DestBB,
979 unsigned PCAdj = isThumb ? 4 : 8;
980 unsigned BrOffset = GetOffsetOf(MI) + PCAdj;
981 unsigned DestOffset = BBOffsets[DestBB->getNumber()];
983 DOUT << "Branch of destination BB#" << DestBB->getNumber()
984 << " from BB#" << MI->getParent()->getNumber()
985 << " max delta=" << MaxDisp
986 << " at offset " << int(DestOffset-BrOffset) << "\t" << *MI;
988 return OffsetIsInRange(BrOffset, DestOffset, MaxDisp, true);
991 /// FixUpImmediateBr - Fix up an immediate branch whose destination is too far
992 /// away to fit in its displacement field.
993 bool ARMConstantIslands::FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br) {
994 MachineInstr *MI = Br.MI;
995 MachineBasicBlock *DestBB = MI->getOperand(0).getMachineBasicBlock();
997 // Check to see if the DestBB is already in-range.
998 if (BBIsInRange(MI, DestBB, Br.MaxDisp))
1002 return FixUpUnconditionalBr(Fn, Br);
1003 return FixUpConditionalBr(Fn, Br);
1006 /// FixUpUnconditionalBr - Fix up an unconditional branch whose destination is
1007 /// too far away to fit in its displacement field. If the LR register has been
1008 /// spilled in the epilogue, then we can use BL to implement a far jump.
1009 /// Otherwise, add an intermediate branch instruction to to a branch.
1011 ARMConstantIslands::FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br) {
1012 MachineInstr *MI = Br.MI;
1013 MachineBasicBlock *MBB = MI->getParent();
1014 assert(isThumb && "Expected a Thumb function!");
1016 // Use BL to implement far jump.
1017 Br.MaxDisp = (1 << 21) * 2;
1018 MI->setInstrDescriptor(TII->get(ARM::tBfar));
1019 BBSizes[MBB->getNumber()] += 2;
1020 AdjustBBOffsetsAfter(MBB, 2);
1024 DOUT << " Changed B to long jump " << *MI;
1029 /// FixUpConditionalBr - Fix up a conditional branch whose destination is too
1030 /// far away to fit in its displacement field. It is converted to an inverse
1031 /// conditional branch + an unconditional branch to the destination.
1033 ARMConstantIslands::FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br) {
1034 MachineInstr *MI = Br.MI;
1035 MachineBasicBlock *DestBB = MI->getOperand(0).getMachineBasicBlock();
1037 // Add a unconditional branch to the destination and invert the branch
1038 // condition to jump over it:
1044 ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(1).getImmedValue();
1045 CC = ARMCC::getOppositeCondition(CC);
1047 // If the branch is at the end of its MBB and that has a fall-through block,
1048 // direct the updated conditional branch to the fall-through block. Otherwise,
1049 // split the MBB before the next instruction.
1050 MachineBasicBlock *MBB = MI->getParent();
1051 MachineInstr *BMI = &MBB->back();
1052 bool NeedSplit = (BMI != MI) || !BBHasFallthrough(MBB);
1056 if (next(MachineBasicBlock::iterator(MI)) == MBB->back() &&
1057 BMI->getOpcode() == Br.UncondBr) {
1058 // Last MI in the BB is a unconditional branch. Can we simply invert the
1059 // condition and swap destinations:
1065 MachineBasicBlock *NewDest = BMI->getOperand(0).getMachineBasicBlock();
1066 if (BBIsInRange(MI, NewDest, Br.MaxDisp)) {
1067 DOUT << " Invert Bcc condition and swap its destination with " << *BMI;
1068 BMI->getOperand(0).setMachineBasicBlock(DestBB);
1069 MI->getOperand(0).setMachineBasicBlock(NewDest);
1070 MI->getOperand(1).setImm(CC);
1077 SplitBlockBeforeInstr(MI);
1078 // No need for the branch to the next block. We're adding a unconditional
1079 // branch to the destination.
1080 int delta = ARM::GetInstSize(&MBB->back());
1081 BBSizes[MBB->getNumber()] -= delta;
1082 AdjustBBOffsetsAfter(MBB, -delta);
1083 MBB->back().eraseFromParent();
1085 MachineBasicBlock *NextBB = next(MachineFunction::iterator(MBB));
1087 DOUT << " Insert B to BB#" << DestBB->getNumber()
1088 << " also invert condition and change dest. to BB#"
1089 << NextBB->getNumber() << "\n";
1091 // Insert a new conditional branch and a new unconditional branch.
1092 // Also update the ImmBranch as well as adding a new entry for the new branch.
1093 BuildMI(MBB, TII->get(MI->getOpcode())).addMBB(NextBB).addImm(CC);
1094 Br.MI = &MBB->back();
1095 BBSizes[MBB->getNumber()] += ARM::GetInstSize(&MBB->back());
1096 BuildMI(MBB, TII->get(Br.UncondBr)).addMBB(DestBB);
1097 BBSizes[MBB->getNumber()] += ARM::GetInstSize(&MBB->back());
1098 unsigned MaxDisp = getUnconditionalBrDisp(Br.UncondBr);
1099 ImmBranches.push_back(ImmBranch(&MBB->back(), MaxDisp, false, Br.UncondBr));
1101 // Remove the old conditional branch. It may or may not still be in MBB.
1102 BBSizes[MI->getParent()->getNumber()] -= ARM::GetInstSize(MI);
1103 MI->eraseFromParent();
1105 // The net size change is an addition of one unconditional branch.
1106 int delta = ARM::GetInstSize(&MBB->back());
1107 AdjustBBOffsetsAfter(MBB, delta);
1111 /// UndoLRSpillRestore - Remove Thumb push / pop instructions that only spills
1112 /// LR / restores LR to pc.
1113 bool ARMConstantIslands::UndoLRSpillRestore() {
1114 bool MadeChange = false;
1115 for (unsigned i = 0, e = PushPopMIs.size(); i != e; ++i) {
1116 MachineInstr *MI = PushPopMIs[i];
1117 if (MI->getNumOperands() == 1) {
1118 if (MI->getOpcode() == ARM::tPOP_RET &&
1119 MI->getOperand(0).getReg() == ARM::PC)
1120 BuildMI(MI->getParent(), TII->get(ARM::tBX_RET));
1121 MI->eraseFromParent();