When determining whether a pc relative branch / load displacement fits in the
[oota-llvm.git] / lib / Target / ARM / ARMConstantIslandPass.cpp
1 //===-- ARMConstantIslandPass.cpp - ARM constant islands --------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
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.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #define DEBUG_TYPE "arm-cp-islands"
17 #include "ARM.h"
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/STLExtras.h"
28 #include "llvm/ADT/Statistic.h"
29 #include <iostream>
30 using namespace llvm;
31
32 STATISTIC(NumSplit,    "Number of uncond branches inserted");
33 STATISTIC(NumCBrFixed, "Number of cond branches fixed");
34 STATISTIC(NumUBrFixed, "Number of uncond branches fixed");
35
36 namespace {
37   /// ARMConstantIslands - Due to limited pc-relative displacements, ARM
38   /// requires constant pool entries to be scattered among the instructions
39   /// inside a function.  To do this, it completely ignores the normal LLVM
40   /// constant pool, instead, it places constants where-ever it feels like with
41   /// special instructions.
42   ///
43   /// The terminology used in this pass includes:
44   ///   Islands - Clumps of constants placed in the function.
45   ///   Water   - Potential places where an island could be formed.
46   ///   CPE     - A constant pool entry that has been placed somewhere, which
47   ///             tracks a list of users.
48   class VISIBILITY_HIDDEN ARMConstantIslands : public MachineFunctionPass {
49     /// NextUID - Assign unique ID's to CPE's.
50     unsigned NextUID;
51     
52     /// BBSizes - The size of each MachineBasicBlock in bytes of code, indexed
53     /// by MBB Number.
54     std::vector<unsigned> BBSizes;
55     
56     /// WaterList - A sorted list of basic blocks where islands could be placed
57     /// (i.e. blocks that don't fall through to the following block, due
58     /// to a return, unreachable, or unconditional branch).
59     std::vector<MachineBasicBlock*> WaterList;
60     
61     /// CPUser - One user of a constant pool, keeping the machine instruction
62     /// pointer, the constant pool being referenced, and the max displacement
63     /// allowed from the instruction to the CP.
64     struct CPUser {
65       MachineInstr *MI;
66       MachineInstr *CPEMI;
67       unsigned MaxDisp;
68       CPUser(MachineInstr *mi, MachineInstr *cpemi, unsigned maxdisp)
69         : MI(mi), CPEMI(cpemi), MaxDisp(maxdisp) {}
70     };
71     
72     /// CPUsers - Keep track of all of the machine instructions that use various
73     /// constant pools and their max displacement.
74     std::vector<CPUser> CPUsers;
75     
76     /// ImmBranch - One per immediate branch, keeping the machine instruction
77     /// pointer, conditional or unconditional, the max displacement,
78     /// and (if isCond is true) the corresponding unconditional branch
79     /// opcode.
80     struct ImmBranch {
81       MachineInstr *MI;
82       unsigned MaxDisp : 31;
83       bool isCond : 1;
84       int UncondBr;
85       ImmBranch(MachineInstr *mi, unsigned maxdisp, bool cond, int ubr)
86         : MI(mi), MaxDisp(maxdisp), isCond(cond), UncondBr(ubr) {}
87     };
88
89     /// Branches - Keep track of all the immediate branch instructions.
90     ///
91     std::vector<ImmBranch> ImmBranches;
92
93     /// PushPopMIs - Keep track of all the Thumb push / pop instructions.
94     ///
95     std::vector<MachineInstr*> PushPopMIs;
96
97     /// HasFarJump - True if any far jump instruction has been emitted during
98     /// the branch fix up pass.
99     bool HasFarJump;
100
101     const TargetInstrInfo *TII;
102     const ARMFunctionInfo *AFI;
103   public:
104     virtual bool runOnMachineFunction(MachineFunction &Fn);
105
106     virtual const char *getPassName() const {
107       return "ARM constant island placement and branch shortening pass";
108     }
109     
110   private:
111     void DoInitialPlacement(MachineFunction &Fn,
112                             std::vector<MachineInstr*> &CPEMIs);
113     void InitialFunctionScan(MachineFunction &Fn,
114                              const std::vector<MachineInstr*> &CPEMIs);
115     MachineBasicBlock *SplitBlockBeforeInstr(MachineInstr *MI);
116     void UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB);
117     bool HandleConstantPoolUser(MachineFunction &Fn, CPUser &U);
118     bool CPEIsInRange(MachineInstr *MI, MachineInstr *CPEMI, unsigned Disp);
119     bool BBIsInRange(MachineInstr *MI, MachineBasicBlock *BB, unsigned Disp);
120     bool FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br);
121     bool FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br);
122     bool FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br);
123     bool UndoLRSpillRestore();
124
125     unsigned GetOffsetOf(MachineInstr *MI) const;
126     unsigned GetOffsetOf(MachineBasicBlock *MBB) const;
127   };
128 }
129
130 /// createARMConstantIslandPass - returns an instance of the constpool
131 /// island pass.
132 FunctionPass *llvm::createARMConstantIslandPass() {
133   return new ARMConstantIslands();
134 }
135
136 bool ARMConstantIslands::runOnMachineFunction(MachineFunction &Fn) {
137   MachineConstantPool &MCP = *Fn.getConstantPool();
138   
139   TII = Fn.getTarget().getInstrInfo();
140   AFI = Fn.getInfo<ARMFunctionInfo>();
141
142   HasFarJump = false;
143
144   // Renumber all of the machine basic blocks in the function, guaranteeing that
145   // the numbers agree with the position of the block in the function.
146   Fn.RenumberBlocks();
147
148   // Perform the initial placement of the constant pool entries.  To start with,
149   // we put them all at the end of the function.
150   std::vector<MachineInstr*> CPEMIs;
151   if (!MCP.isEmpty())
152     DoInitialPlacement(Fn, CPEMIs);
153   
154   /// The next UID to take is the first unused one.
155   NextUID = CPEMIs.size();
156   
157   // Do the initial scan of the function, building up information about the
158   // sizes of each block, the location of all the water, and finding all of the
159   // constant pool users.
160   InitialFunctionScan(Fn, CPEMIs);
161   CPEMIs.clear();
162   
163   // Iteratively place constant pool entries and fix up branches until there
164   // is no change.
165   bool MadeChange = false;
166   while (true) {
167     bool Change = false;
168     for (unsigned i = 0, e = CPUsers.size(); i != e; ++i)
169       Change |= HandleConstantPoolUser(Fn, CPUsers[i]);
170     for (unsigned i = 0, e = ImmBranches.size(); i != e; ++i)
171       Change |= FixUpImmediateBr(Fn, ImmBranches[i]);
172     if (!Change)
173       break;
174     MadeChange = true;
175   }
176   
177   // If LR has been forced spilled and no far jumps (i.e. BL) has been issued.
178   // Undo the spill / restore of LR if possible.
179   if (!HasFarJump && AFI->isLRForceSpilled() && AFI->isThumbFunction())
180     MadeChange |= UndoLRSpillRestore();
181
182   BBSizes.clear();
183   WaterList.clear();
184   CPUsers.clear();
185   ImmBranches.clear();
186
187   return MadeChange;
188 }
189
190 /// DoInitialPlacement - Perform the initial placement of the constant pool
191 /// entries.  To start with, we put them all at the end of the function.
192 void ARMConstantIslands::DoInitialPlacement(MachineFunction &Fn,
193                                             std::vector<MachineInstr*> &CPEMIs){
194   // Create the basic block to hold the CPE's.
195   MachineBasicBlock *BB = new MachineBasicBlock();
196   Fn.getBasicBlockList().push_back(BB);
197   
198   // Add all of the constants from the constant pool to the end block, use an
199   // identity mapping of CPI's to CPE's.
200   const std::vector<MachineConstantPoolEntry> &CPs =
201     Fn.getConstantPool()->getConstants();
202   
203   const TargetData &TD = *Fn.getTarget().getTargetData();
204   for (unsigned i = 0, e = CPs.size(); i != e; ++i) {
205     unsigned Size = TD.getTypeSize(CPs[i].getType());
206     // Verify that all constant pool entries are a multiple of 4 bytes.  If not,
207     // we would have to pad them out or something so that instructions stay
208     // aligned.
209     assert((Size & 3) == 0 && "CP Entry not multiple of 4 bytes!");
210     MachineInstr *CPEMI =
211       BuildMI(BB, TII->get(ARM::CONSTPOOL_ENTRY))
212                            .addImm(i).addConstantPoolIndex(i).addImm(Size);
213     CPEMIs.push_back(CPEMI);
214     DEBUG(std::cerr << "Moved CPI#" << i << " to end of function as #"
215                     << i << "\n");
216   }
217 }
218
219 /// BBHasFallthrough - Return true of the specified basic block can fallthrough
220 /// into the block immediately after it.
221 static bool BBHasFallthrough(MachineBasicBlock *MBB) {
222   // Get the next machine basic block in the function.
223   MachineFunction::iterator MBBI = MBB;
224   if (next(MBBI) == MBB->getParent()->end())  // Can't fall off end of function.
225     return false;
226   
227   MachineBasicBlock *NextBB = next(MBBI);
228   for (MachineBasicBlock::succ_iterator I = MBB->succ_begin(),
229        E = MBB->succ_end(); I != E; ++I)
230     if (*I == NextBB)
231       return true;
232   
233   return false;
234 }
235
236 /// InitialFunctionScan - Do the initial scan of the function, building up
237 /// information about the sizes of each block, the location of all the water,
238 /// and finding all of the constant pool users.
239 void ARMConstantIslands::InitialFunctionScan(MachineFunction &Fn,
240                                      const std::vector<MachineInstr*> &CPEMIs) {
241   for (MachineFunction::iterator MBBI = Fn.begin(), E = Fn.end();
242        MBBI != E; ++MBBI) {
243     MachineBasicBlock &MBB = *MBBI;
244     
245     // If this block doesn't fall through into the next MBB, then this is
246     // 'water' that a constant pool island could be placed.
247     if (!BBHasFallthrough(&MBB))
248       WaterList.push_back(&MBB);
249     
250     unsigned MBBSize = 0;
251     for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
252          I != E; ++I) {
253       // Add instruction size to MBBSize.
254       MBBSize += ARM::GetInstSize(I);
255
256       int Opc = I->getOpcode();
257       if (TII->isBranch(Opc)) {
258         bool isCond = false;
259         unsigned Bits = 0;
260         unsigned Scale = 1;
261         int UOpc = Opc;
262         switch (Opc) {
263         default:
264           continue;  // Ignore JT branches
265         case ARM::Bcc:
266           isCond = true;
267           UOpc = ARM::B;
268           // Fallthrough
269         case ARM::B:
270           Bits = 24;
271           Scale = 4;
272           break;
273         case ARM::tBcc:
274           isCond = true;
275           UOpc = ARM::tB;
276           Bits = 8;
277           Scale = 2;
278           break;
279         case ARM::tB:
280           Bits = 11;
281           Scale = 2;
282           break;
283         }
284         unsigned MaxDisp = (1 << (Bits-1)) * Scale;
285         ImmBranches.push_back(ImmBranch(I, MaxDisp, isCond, UOpc));
286       }
287
288       if (Opc == ARM::tPUSH || Opc == ARM::tPOP_RET)
289         PushPopMIs.push_back(I);
290
291       // Scan the instructions for constant pool operands.
292       for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op)
293         if (I->getOperand(op).isConstantPoolIndex()) {
294           // We found one.  The addressing mode tells us the max displacement
295           // from the PC that this instruction permits.
296           unsigned MaxOffs = 0;
297           
298           // Basic size info comes from the TSFlags field.
299           unsigned TSFlags = I->getInstrDescriptor()->TSFlags;
300           switch (TSFlags & ARMII::AddrModeMask) {
301           default: 
302             // Constant pool entries can reach anything.
303             if (I->getOpcode() == ARM::CONSTPOOL_ENTRY)
304               continue;
305             assert(0 && "Unknown addressing mode for CP reference!");
306           case ARMII::AddrMode1: // AM1: 8 bits << 2
307             MaxOffs = 1 << (8+2);   // Taking the address of a CP entry.
308             break;
309           case ARMII::AddrMode2:
310             MaxOffs = 1 << 12;   // +-offset_12
311             break;
312           case ARMII::AddrMode3:
313             MaxOffs = 1 << 8;   // +-offset_8
314             break;
315             // addrmode4 has no immediate offset.
316           case ARMII::AddrMode5:
317             MaxOffs = 1 << (8+2);   // +-(offset_8*4)
318             break;
319           case ARMII::AddrModeT1:
320             MaxOffs = 1 << 5;
321             break;
322           case ARMII::AddrModeT2:
323             MaxOffs = 1 << (5+1);
324             break;
325           case ARMII::AddrModeT4:
326             MaxOffs = 1 << (5+2);
327             break;
328           case ARMII::AddrModeTs:
329             MaxOffs = 1 << (8+2);
330             break;
331           }
332           
333           // Remember that this is a user of a CP entry.
334           MachineInstr *CPEMI =CPEMIs[I->getOperand(op).getConstantPoolIndex()];
335           CPUsers.push_back(CPUser(I, CPEMI, MaxOffs));
336           
337           // Instructions can only use one CP entry, don't bother scanning the
338           // rest of the operands.
339           break;
340         }
341     }
342     BBSizes.push_back(MBBSize);
343   }
344 }
345
346 /// GetOffsetOf - Return the current offset of the specified machine instruction
347 /// from the start of the function.  This offset changes as stuff is moved
348 /// around inside the function.
349 unsigned ARMConstantIslands::GetOffsetOf(MachineInstr *MI) const {
350   MachineBasicBlock *MBB = MI->getParent();
351   
352   // The offset is composed of two things: the sum of the sizes of all MBB's
353   // before this instruction's block, and the offset from the start of the block
354   // it is in.
355   unsigned Offset = 0;
356   
357   // Sum block sizes before MBB.
358   for (unsigned BB = 0, e = MBB->getNumber(); BB != e; ++BB)
359     Offset += BBSizes[BB];
360
361   // Sum instructions before MI in MBB.
362   for (MachineBasicBlock::iterator I = MBB->begin(); ; ++I) {
363     assert(I != MBB->end() && "Didn't find MI in its own basic block?");
364     if (&*I == MI) return Offset;
365     Offset += ARM::GetInstSize(I);
366   }
367 }
368
369 /// GetOffsetOf - Return the current offset of the specified machine BB
370 /// from the start of the function.  This offset changes as stuff is moved
371 /// around inside the function.
372 unsigned ARMConstantIslands::GetOffsetOf(MachineBasicBlock *MBB) const {
373   // Sum block sizes before MBB.
374   unsigned Offset = 0;  
375   for (unsigned BB = 0, e = MBB->getNumber(); BB != e; ++BB)
376     Offset += BBSizes[BB];
377
378   return Offset;
379 }
380
381 /// CompareMBBNumbers - Little predicate function to sort the WaterList by MBB
382 /// ID.
383 static bool CompareMBBNumbers(const MachineBasicBlock *LHS,
384                               const MachineBasicBlock *RHS) {
385   return LHS->getNumber() < RHS->getNumber();
386 }
387
388 /// UpdateForInsertedWaterBlock - When a block is newly inserted into the
389 /// machine function, it upsets all of the block numbers.  Renumber the blocks
390 /// and update the arrays that parallel this numbering.
391 void ARMConstantIslands::UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB) {
392   // Renumber the MBB's to keep them consequtive.
393   NewBB->getParent()->RenumberBlocks(NewBB);
394   
395   // Insert a size into BBSizes to align it properly with the (newly
396   // renumbered) block numbers.
397   BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
398   
399   // Next, update WaterList.  Specifically, we need to add NewMBB as having 
400   // available water after it.
401   std::vector<MachineBasicBlock*>::iterator IP =
402     std::lower_bound(WaterList.begin(), WaterList.end(), NewBB,
403                      CompareMBBNumbers);
404   WaterList.insert(IP, NewBB);
405 }
406
407
408 /// Split the basic block containing MI into two blocks, which are joined by
409 /// an unconditional branch.  Update datastructures and renumber blocks to
410 /// account for this change and returns the newly created block.
411 MachineBasicBlock *ARMConstantIslands::SplitBlockBeforeInstr(MachineInstr *MI) {
412   MachineBasicBlock *OrigBB = MI->getParent();
413   bool isThumb = AFI->isThumbFunction();
414
415   // Create a new MBB for the code after the OrigBB.
416   MachineBasicBlock *NewBB = new MachineBasicBlock(OrigBB->getBasicBlock());
417   MachineFunction::iterator MBBI = OrigBB; ++MBBI;
418   OrigBB->getParent()->getBasicBlockList().insert(MBBI, NewBB);
419   
420   // Splice the instructions starting with MI over to NewBB.
421   NewBB->splice(NewBB->end(), OrigBB, MI, OrigBB->end());
422   
423   // Add an unconditional branch from OrigBB to NewBB.
424   // Note the new unconditional branch is not being recorded.
425   BuildMI(OrigBB, TII->get(isThumb ? ARM::tB : ARM::B)).addMBB(NewBB);
426   NumSplit++;
427   
428   // Update the CFG.  All succs of OrigBB are now succs of NewBB.
429   while (!OrigBB->succ_empty()) {
430     MachineBasicBlock *Succ = *OrigBB->succ_begin();
431     OrigBB->removeSuccessor(Succ);
432     NewBB->addSuccessor(Succ);
433     
434     // This pass should be run after register allocation, so there should be no
435     // PHI nodes to update.
436     assert((Succ->empty() || Succ->begin()->getOpcode() != TargetInstrInfo::PHI)
437            && "PHI nodes should be eliminated by now!");
438   }
439   
440   // OrigBB branches to NewBB.
441   OrigBB->addSuccessor(NewBB);
442   
443   // Update internal data structures to account for the newly inserted MBB.
444   UpdateForInsertedWaterBlock(NewBB);
445   
446   // Figure out how large the first NewMBB is.
447   unsigned NewBBSize = 0;
448   for (MachineBasicBlock::iterator I = NewBB->begin(), E = NewBB->end();
449        I != E; ++I)
450     NewBBSize += ARM::GetInstSize(I);
451   
452   // Set the size of NewBB in BBSizes.
453   BBSizes[NewBB->getNumber()] = NewBBSize;
454   
455   // We removed instructions from UserMBB, subtract that off from its size.
456   // Add 2 or 4 to the block to count the unconditional branch we added to it.
457   BBSizes[OrigBB->getNumber()] -= NewBBSize - (isThumb ? 2 : 4);
458
459   return NewBB;
460 }
461
462 /// CPEIsInRange - Returns true is the distance between specific MI and
463 /// specific ConstPool entry instruction can fit in MI's displacement field.
464 bool ARMConstantIslands::CPEIsInRange(MachineInstr *MI, MachineInstr *CPEMI,
465                                       unsigned MaxDisp) {
466   unsigned PCAdj      = AFI->isThumbFunction() ? 4 : 8;
467   unsigned UserOffset = GetOffsetOf(MI) + PCAdj;
468   unsigned CPEOffset  = GetOffsetOf(CPEMI);
469   
470   DEBUG(std::cerr << "User of CPE#" << CPEMI->getOperand(0).getImm()
471                   << " max delta=" << MaxDisp
472                   << " at offset " << int(UserOffset-CPEOffset) << "\t"
473                   << *MI);
474
475   if (UserOffset < CPEOffset) {
476     // User before the CPE.
477     if (CPEOffset-UserOffset <= MaxDisp)
478       return true;
479   } else if (!AFI->isThumbFunction()) {
480     // Thumb LDR cannot encode negative offset.
481     if (UserOffset-CPEOffset <= MaxDisp)
482       return true;
483   }
484   return false;
485 }
486
487 /// HandleConstantPoolUser - Analyze the specified user, checking to see if it
488 /// is out-of-range.  If so, pick it up the constant pool value and move it some
489 /// place in-range.
490 bool ARMConstantIslands::HandleConstantPoolUser(MachineFunction &Fn, CPUser &U){
491   MachineInstr *UserMI = U.MI;
492   MachineInstr *CPEMI  = U.CPEMI;
493
494   // Check to see if the CPE is already in-range.
495   if (CPEIsInRange(UserMI, CPEMI, U.MaxDisp))
496     return false;
497
498   // Solution guaranteed to work: split the user's MBB right after the user and
499   // insert a clone the CPE into the newly created water.
500
501   MachineBasicBlock *UserMBB = UserMI->getParent();
502   MachineBasicBlock *NewMBB;
503
504   // TODO: Search for the best place to split the code.  In practice, using
505   // loop nesting information to insert these guys outside of loops would be
506   // sufficient.    
507   if (&UserMBB->back() == UserMI) {
508     assert(BBHasFallthrough(UserMBB) && "Expected a fallthrough BB!");
509     NewMBB = next(MachineFunction::iterator(UserMBB));
510     // Add an unconditional branch from UserMBB to fallthrough block.
511     // Note the new unconditional branch is not being recorded.
512     bool isThumb = AFI->isThumbFunction();
513     BuildMI(UserMBB, TII->get(isThumb ? ARM::tB : ARM::B)).addMBB(NewMBB);
514     BBSizes[UserMBB->getNumber()] += isThumb ? 2 : 4;
515   } else {
516     MachineInstr *NextMI = next(MachineBasicBlock::iterator(UserMI));
517     NewMBB = SplitBlockBeforeInstr(NextMI);
518   }
519
520   // Okay, we know we can put an island before UserMBB now, do it!
521   MachineBasicBlock *NewIsland = new MachineBasicBlock();
522   Fn.getBasicBlockList().insert(NewMBB, NewIsland);
523
524   // Update internal data structures to account for the newly inserted MBB.
525   UpdateForInsertedWaterBlock(NewIsland);
526
527   // Now that we have an island to add the CPE to, clone the original CPE and
528   // add it to the island.
529   unsigned ID  = NextUID++;
530   unsigned CPI = CPEMI->getOperand(1).getConstantPoolIndex();
531   unsigned Size = CPEMI->getOperand(2).getImm();
532   
533   // Build a new CPE for this user.
534   U.CPEMI = BuildMI(NewIsland, TII->get(ARM::CONSTPOOL_ENTRY))
535                 .addImm(ID).addConstantPoolIndex(CPI).addImm(Size);
536   
537   // Increase the size of the island block to account for the new entry.
538   BBSizes[NewIsland->getNumber()] += Size;
539   
540   // Finally, change the CPI in the instruction operand to be ID.
541   for (unsigned i = 0, e = UserMI->getNumOperands(); i != e; ++i)
542     if (UserMI->getOperand(i).isConstantPoolIndex()) {
543       UserMI->getOperand(i).setConstantPoolIndex(ID);
544       break;
545     }
546       
547   DEBUG(std::cerr << "  Moved CPE to #" << ID << " CPI=" << CPI << "\t"
548                   << *UserMI);
549       
550   return true;
551 }
552
553 /// BBIsInRange - Returns true is the distance between specific MI and
554 /// specific BB can fit in MI's displacement field.
555 bool ARMConstantIslands::BBIsInRange(MachineInstr *MI,MachineBasicBlock *DestBB,
556                                      unsigned MaxDisp) {
557   unsigned PCAdj      = AFI->isThumbFunction() ? 4 : 8;
558   unsigned BrOffset   = GetOffsetOf(MI) + PCAdj;
559   unsigned DestOffset = GetOffsetOf(DestBB);
560
561   DEBUG(std::cerr << "Branch of destination BB#" << DestBB->getNumber()
562                   << " max delta=" << MaxDisp
563                   << " at offset " << int(BrOffset-DestOffset) << "\t"
564                   << *MI);
565
566   if (BrOffset < DestOffset) {
567     if (DestOffset - BrOffset < MaxDisp)
568       return true;
569   } else {
570     if (BrOffset - DestOffset <= MaxDisp)
571       return true;
572   }
573   return false;
574 }
575
576 /// FixUpImmediateBr - Fix up an immediate branch whose destination is too far
577 /// away to fit in its displacement field.
578 bool ARMConstantIslands::FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br) {
579   MachineInstr *MI = Br.MI;
580   MachineBasicBlock *DestBB = MI->getOperand(0).getMachineBasicBlock();
581
582   // Check to see if the DestBB is already in-range.
583   if (BBIsInRange(MI, DestBB, Br.MaxDisp))
584     return false;
585
586   if (!Br.isCond)
587     return FixUpUnconditionalBr(Fn, Br);
588   return FixUpConditionalBr(Fn, Br);
589 }
590
591 /// FixUpUnconditionalBr - Fix up an unconditional branches whose destination is
592 /// too far away to fit in its displacement field. If LR register has been
593 /// spilled in the epilogue, then we can use BL to implement a far jump.
594 /// Otherwise, add a intermediate branch instruction to to a branch.
595 bool
596 ARMConstantIslands::FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br) {
597   MachineInstr *MI = Br.MI;
598   MachineBasicBlock *MBB = MI->getParent();
599   assert(AFI->isThumbFunction() && "Expected a Thumb function!");
600
601   // Use BL to implement far jump.
602   Br.MaxDisp = (1 << 21) * 2;
603   MI->setInstrDescriptor(TII->get(ARM::tBfar));
604   BBSizes[MBB->getNumber()] += 2;
605   HasFarJump = true;
606   NumUBrFixed++;
607   return true;
608 }
609
610 /// getUnconditionalBrDisp - Returns the maximum displacement that can fit in the
611 /// specific unconditional branch instruction.
612 static inline unsigned getUnconditionalBrDisp(int Opc) {
613   return (Opc == ARM::tB) ? (1<<10)*2 : (1<<23)*4;
614 }
615
616 /// FixUpConditionalBr - Fix up a conditional branches whose destination is too
617 /// far away to fit in its displacement field. It is converted to an inverse
618 /// conditional branch + an unconditional branch to the destination.
619 bool
620 ARMConstantIslands::FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br) {
621   MachineInstr *MI = Br.MI;
622   MachineBasicBlock *DestBB = MI->getOperand(0).getMachineBasicBlock();
623
624   // Add a unconditional branch to the destination and invert the branch
625   // condition to jump over it:
626   // blt L1
627   // =>
628   // bge L2
629   // b   L1
630   // L2:
631   ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(1).getImmedValue();
632   CC = ARMCC::getOppositeCondition(CC);
633
634   // If the branch is at the end of its MBB and that has a fall-through block,
635   // direct the updated conditional branch to the fall-through block. Otherwise,
636   // split the MBB before the next instruction.
637   MachineBasicBlock *MBB = MI->getParent();
638   MachineInstr *BackMI = &MBB->back();
639   bool NeedSplit = (BackMI != MI) || !BBHasFallthrough(MBB);
640
641   NumCBrFixed++;
642   if (BackMI != MI) {
643     if (next(MachineBasicBlock::iterator(MI)) == MBB->back() &&
644         BackMI->getOpcode() == Br.UncondBr) {
645       // Last MI in the BB is a unconditional branch. Can we simply invert the
646       // condition and swap destinations:
647       // beq L1
648       // b   L2
649       // =>
650       // bne L2
651       // b   L1
652       MachineBasicBlock *NewDest = BackMI->getOperand(0).getMachineBasicBlock();
653       if (BBIsInRange(MI, NewDest, Br.MaxDisp)) {
654         BackMI->getOperand(0).setMachineBasicBlock(DestBB);
655         MI->getOperand(0).setMachineBasicBlock(NewDest);
656         MI->getOperand(1).setImm(CC);
657         return true;
658       }
659     }
660   }
661
662   if (NeedSplit) {
663     SplitBlockBeforeInstr(MI);
664     // No need for the branch to the next block. We're adding a unconditional
665     // branch to the destination.
666     MBB->back().eraseFromParent();
667   }
668   MachineBasicBlock *NextBB = next(MachineFunction::iterator(MBB));
669
670   // Insert a unconditional branch and replace the conditional branch.
671   // Also update the ImmBranch as well as adding a new entry for the new branch.
672   BuildMI(MBB, TII->get(MI->getOpcode())).addMBB(NextBB).addImm(CC);
673   Br.MI = &MBB->back();
674   BuildMI(MBB, TII->get(Br.UncondBr)).addMBB(DestBB);
675   unsigned MaxDisp = getUnconditionalBrDisp(Br.UncondBr);
676   ImmBranches.push_back(ImmBranch(&MBB->back(), MaxDisp, false, Br.UncondBr));
677   MI->eraseFromParent();
678
679   // Increase the size of MBB to account for the new unconditional branch.
680   BBSizes[MBB->getNumber()] += ARM::GetInstSize(&MBB->back());
681   return true;
682 }
683
684
685 /// UndoLRSpillRestore - Remove Thumb push / pop instructions that only spills
686 /// LR / restores LR to pc.
687 bool ARMConstantIslands::UndoLRSpillRestore() {
688   bool MadeChange = false;
689   for (unsigned i = 0, e = PushPopMIs.size(); i != e; ++i) {
690     MachineInstr *MI = PushPopMIs[i];
691     if (MI->getNumOperands() == 1) {
692         if (MI->getOpcode() == ARM::tPOP_RET &&
693             MI->getOperand(0).getReg() == ARM::PC)
694           BuildMI(MI->getParent(), TII->get(ARM::tBX_RET));
695         MI->eraseFromParent();
696         MadeChange = true;
697     }
698   }
699   return MadeChange;
700 }