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
 285         // Record this immediate branch.
 286         unsigned MaxOffs = (1 << (Bits-1)) * Scale;
 287         ImmBranches.push_back(ImmBranch(I, MaxOffs, isCond, UOpc));
 288       }
 289
 290       if (Opc == ARM::tPUSH || Opc == ARM::tPOP_RET)
 291         PushPopMIs.push_back(I);
 292
 293       // Scan the instructions for constant pool operands.
 294       for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op)
 295         if (I->getOperand(op).isConstantPoolIndex()) {
 296           // We found one.  The addressing mode tells us the max displacement
 297           // from the PC that this instruction permits.
 298
 299           // Basic size info comes from the TSFlags field.
 300           unsigned Bits = 0;
 301           unsigned Scale = 1;
 302           unsigned TSFlags = I->getInstrDescriptor()->TSFlags;
 303           switch (TSFlags & ARMII::AddrModeMask) {
 304           default:
 305             // Constant pool entries can reach anything.
 306             if (I->getOpcode() == ARM::CONSTPOOL_ENTRY)
 307               continue;
 308             assert(0 && "Unknown addressing mode for CP reference!");
 309           case ARMII::AddrMode1: // AM1: 8 bits << 2
 310             Bits = 8;
 311             Scale = 4;  // Taking the address of a CP entry.
 312             break;
 313           case ARMII::AddrMode2:
 314             Bits = 12;  // +-offset_12
 315             break;
 316           case ARMII::AddrMode3:
 317             Bits = 8;   // +-offset_8
 318             break;
 319             // addrmode4 has no immediate offset.
 320           case ARMII::AddrMode5:
 321             Bits = 8;
 322             Scale = 4;  // +-(offset_8*4)
 323             break;
 324           case ARMII::AddrModeT1:
 325             Bits = 5;  // +offset_5
 326             break;
 327           case ARMII::AddrModeT2:
 328             Bits = 5;
 329             Scale = 2;  // +(offset_5*2)
 330             break;
 331           case ARMII::AddrModeT4:
 332             Bits = 5;
 333             Scale = 4;  // +(offset_5*4)
 334             break;
 335           case ARMII::AddrModeTs:
 336             Bits = 8;
 337             Scale = 4;  // +(offset_8*4)
 338             break;
 339           }
 340
 341           // Remember that this is a user of a CP entry.
 342           MachineInstr *CPEMI =CPEMIs[I->getOperand(op).getConstantPoolIndex()];
 343           unsigned MaxOffs = ((1 << Bits)-1) * Scale;
 344           CPUsers.push_back(CPUser(I, CPEMI, MaxOffs));
 345
 346           // Instructions can only use one CP entry, don't bother scanning the
 347           // rest of the operands.
 348           break;
 349         }
 350     }
 351
 352     // In thumb mode, if this block is a constpool island, pessmisticly assume
 353     // it needs to be padded by two byte so it's aligned on 4 byte boundary.
 354     if (AFI->isThumbFunction() &&
 355         !MBB.empty() &&
 356         MBB.begin()->getOpcode() == ARM::CONSTPOOL_ENTRY)
 357       MBBSize += 2;
 358
 359     BBSizes.push_back(MBBSize);
 360   }
 361 }
 362
 363 /// GetOffsetOf - Return the current offset of the specified machine instruction
 364 /// from the start of the function.  This offset changes as stuff is moved
 365 /// around inside the function.
 366 unsigned ARMConstantIslands::GetOffsetOf(MachineInstr *MI) const {
 367   MachineBasicBlock *MBB = MI->getParent();
 368
 369   // The offset is composed of two things: the sum of the sizes of all MBB's
 370   // before this instruction's block, and the offset from the start of the block
 371   // it is in.
 372   unsigned Offset = 0;
 373
 374   // Sum block sizes before MBB.
 375   for (unsigned BB = 0, e = MBB->getNumber(); BB != e; ++BB)
 376     Offset += BBSizes[BB];
 377
 378   // Sum instructions before MI in MBB.
 379   for (MachineBasicBlock::iterator I = MBB->begin(); ; ++I) {
 380     assert(I != MBB->end() && "Didn't find MI in its own basic block?");
 381     if (&*I == MI) return Offset;
 382     Offset += ARM::GetInstSize(I);
 383   }
 384 }
 385
 386 /// GetOffsetOf - Return the current offset of the specified machine BB
 387 /// from the start of the function.  This offset changes as stuff is moved
 388 /// around inside the function.
 389 unsigned ARMConstantIslands::GetOffsetOf(MachineBasicBlock *MBB) const {
 390   // Sum block sizes before MBB.
 391   unsigned Offset = 0;
 392   for (unsigned BB = 0, e = MBB->getNumber(); BB != e; ++BB)
 393     Offset += BBSizes[BB];
 394
 395   return Offset;
 396 }
 397
 398 /// CompareMBBNumbers - Little predicate function to sort the WaterList by MBB
 399 /// ID.
 400 static bool CompareMBBNumbers(const MachineBasicBlock *LHS,
 401                               const MachineBasicBlock *RHS) {
 402   return LHS->getNumber() < RHS->getNumber();
 403 }
 404
 405 /// UpdateForInsertedWaterBlock - When a block is newly inserted into the
 406 /// machine function, it upsets all of the block numbers.  Renumber the blocks
 407 /// and update the arrays that parallel this numbering.
 408 void ARMConstantIslands::UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB) {
 409   // Renumber the MBB's to keep them consequtive.
 410   NewBB->getParent()->RenumberBlocks(NewBB);
 411
 412   // Insert a size into BBSizes to align it properly with the (newly
 413   // renumbered) block numbers.
 414   BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
 415
 416   // Next, update WaterList.  Specifically, we need to add NewMBB as having
 417   // available water after it.
 418   std::vector<MachineBasicBlock*>::iterator IP =
 419     std::lower_bound(WaterList.begin(), WaterList.end(), NewBB,
 420                      CompareMBBNumbers);
 421   WaterList.insert(IP, NewBB);
 422 }
 423
 424
 425 /// Split the basic block containing MI into two blocks, which are joined by
 426 /// an unconditional branch.  Update datastructures and renumber blocks to
 427 /// account for this change and returns the newly created block.
 428 MachineBasicBlock *ARMConstantIslands::SplitBlockBeforeInstr(MachineInstr *MI) {
 429   MachineBasicBlock *OrigBB = MI->getParent();
 430   bool isThumb = AFI->isThumbFunction();
 431
 432   // Create a new MBB for the code after the OrigBB.
 433   MachineBasicBlock *NewBB = new MachineBasicBlock(OrigBB->getBasicBlock());
 434   MachineFunction::iterator MBBI = OrigBB; ++MBBI;
 435   OrigBB->getParent()->getBasicBlockList().insert(MBBI, NewBB);
 436
 437   // Splice the instructions starting with MI over to NewBB.
 438   NewBB->splice(NewBB->end(), OrigBB, MI, OrigBB->end());
 439
 440   // Add an unconditional branch from OrigBB to NewBB.
 441   // Note the new unconditional branch is not being recorded.
 442   BuildMI(OrigBB, TII->get(isThumb ? ARM::tB : ARM::B)).addMBB(NewBB);
 443   NumSplit++;
 444
 445   // Update the CFG.  All succs of OrigBB are now succs of NewBB.
 446   while (!OrigBB->succ_empty()) {
 447     MachineBasicBlock *Succ = *OrigBB->succ_begin();
 448     OrigBB->removeSuccessor(Succ);
 449     NewBB->addSuccessor(Succ);
 450
 451     // This pass should be run after register allocation, so there should be no
 452     // PHI nodes to update.
 453     assert((Succ->empty() || Succ->begin()->getOpcode() != TargetInstrInfo::PHI)
 454            && "PHI nodes should be eliminated by now!");
 455   }
 456
 457   // OrigBB branches to NewBB.
 458   OrigBB->addSuccessor(NewBB);
 459
 460   // Update internal data structures to account for the newly inserted MBB.
 461   UpdateForInsertedWaterBlock(NewBB);
 462
 463   // Figure out how large the first NewMBB is.
 464   unsigned NewBBSize = 0;
 465   for (MachineBasicBlock::iterator I = NewBB->begin(), E = NewBB->end();
 466        I != E; ++I)
 467     NewBBSize += ARM::GetInstSize(I);
 468
 469   // Set the size of NewBB in BBSizes.
 470   BBSizes[NewBB->getNumber()] = NewBBSize;
 471
 472   // We removed instructions from UserMBB, subtract that off from its size.
 473   // Add 2 or 4 to the block to count the unconditional branch we added to it.
 474   BBSizes[OrigBB->getNumber()] -= NewBBSize - (isThumb ? 2 : 4);
 475
 476   return NewBB;
 477 }
 478
 479 /// CPEIsInRange - Returns true is the distance between specific MI and
 480 /// specific ConstPool entry instruction can fit in MI's displacement field.
 481 bool ARMConstantIslands::CPEIsInRange(MachineInstr *MI, MachineInstr *CPEMI,
 482                                       unsigned MaxDisp) {
 483   unsigned PCAdj      = AFI->isThumbFunction() ? 4 : 8;
 484   unsigned UserOffset = GetOffsetOf(MI) + PCAdj;
 485   // In thumb mode, pessmisticly assumes the .align 2 before the first CPE
 486   // in the island adds two byte padding.
 487   unsigned AlignAdj   = AFI->isThumbFunction() ? 2 : 0;
 488   unsigned CPEOffset  = GetOffsetOf(CPEMI) + AlignAdj;
 489
 490   DEBUG(std::cerr << "User of CPE#" << CPEMI->getOperand(0).getImm()
 491                   << " max delta=" << MaxDisp
 492                   << " at offset " << int(UserOffset-CPEOffset) << "\t"
 493                   << *MI);
 494
 495   if (UserOffset <= CPEOffset) {
 496     // User before the CPE.
 497     if (CPEOffset-UserOffset <= MaxDisp)
 498       return true;
 499   } else if (!AFI->isThumbFunction()) {
 500     // Thumb LDR cannot encode negative offset.
 501     if (UserOffset-CPEOffset <= MaxDisp)
 502       return true;
 503   }
 504   return false;
 505 }
 506
 507 /// HandleConstantPoolUser - Analyze the specified user, checking to see if it
 508 /// is out-of-range.  If so, pick it up the constant pool value and move it some
 509 /// place in-range.
 510 bool ARMConstantIslands::HandleConstantPoolUser(MachineFunction &Fn, CPUser &U){
 511   MachineInstr *UserMI = U.MI;
 512   MachineInstr *CPEMI  = U.CPEMI;
 513
 514   // Check to see if the CPE is already in-range.
 515   if (CPEIsInRange(UserMI, CPEMI, U.MaxDisp))
 516     return false;
 517
 518   // Solution guaranteed to work: split the user's MBB right after the user and
 519   // insert a clone the CPE into the newly created water.
 520
 521   MachineBasicBlock *UserMBB = UserMI->getParent();
 522   MachineBasicBlock *NewMBB;
 523
 524   // TODO: Search for the best place to split the code.  In practice, using
 525   // loop nesting information to insert these guys outside of loops would be
 526   // sufficient.
 527   bool isThumb = AFI->isThumbFunction();
 528   if (&UserMBB->back() == UserMI) {
 529     assert(BBHasFallthrough(UserMBB) && "Expected a fallthrough BB!");
 530     NewMBB = next(MachineFunction::iterator(UserMBB));
 531     // Add an unconditional branch from UserMBB to fallthrough block.
 532     // Note the new unconditional branch is not being recorded.
 533     BuildMI(UserMBB, TII->get(isThumb ? ARM::tB : ARM::B)).addMBB(NewMBB);
 534     BBSizes[UserMBB->getNumber()] += isThumb ? 2 : 4;
 535   } else {
 536     MachineInstr *NextMI = next(MachineBasicBlock::iterator(UserMI));
 537     NewMBB = SplitBlockBeforeInstr(NextMI);
 538   }
 539
 540   // Okay, we know we can put an island before UserMBB now, do it!
 541   MachineBasicBlock *NewIsland = new MachineBasicBlock();
 542   Fn.getBasicBlockList().insert(NewMBB, NewIsland);
 543
 544   // Update internal data structures to account for the newly inserted MBB.
 545   UpdateForInsertedWaterBlock(NewIsland);
 546
 547   // Now that we have an island to add the CPE to, clone the original CPE and
 548   // add it to the island.
 549   unsigned ID  = NextUID++;
 550   unsigned CPI = CPEMI->getOperand(1).getConstantPoolIndex();
 551   unsigned Size = CPEMI->getOperand(2).getImm();
 552
 553   // Build a new CPE for this user.
 554   U.CPEMI = BuildMI(NewIsland, TII->get(ARM::CONSTPOOL_ENTRY))
 555                 .addImm(ID).addConstantPoolIndex(CPI).addImm(Size);
 556
 557   // Compensate for .align 2 in thumb mode.
 558   if (isThumb) Size += 2;
 559   // Increase the size of the island block to account for the new entry.
 560   BBSizes[NewIsland->getNumber()] += Size;
 561
 562   // Finally, change the CPI in the instruction operand to be ID.
 563   for (unsigned i = 0, e = UserMI->getNumOperands(); i != e; ++i)
 564     if (UserMI->getOperand(i).isConstantPoolIndex()) {
 565       UserMI->getOperand(i).setConstantPoolIndex(ID);
 566       break;
 567     }
 568
 569   DEBUG(std::cerr << "  Moved CPE to #" << ID << " CPI=" << CPI << "\t"
 570                   << *UserMI);
 571
 572   return true;
 573 }
 574
 575 /// BBIsInRange - Returns true is the distance between specific MI and
 576 /// specific BB can fit in MI's displacement field.
 577 bool ARMConstantIslands::BBIsInRange(MachineInstr *MI,MachineBasicBlock *DestBB,
 578                                      unsigned MaxDisp) {
 579   unsigned PCAdj      = AFI->isThumbFunction() ? 4 : 8;
 580   unsigned BrOffset   = GetOffsetOf(MI) + PCAdj;
 581   unsigned DestOffset = GetOffsetOf(DestBB);
 582
 583   DEBUG(std::cerr << "Branch of destination BB#" << DestBB->getNumber()
 584                   << " max delta=" << MaxDisp
 585                   << " at offset " << int(BrOffset-DestOffset) << "\t"
 586                   << *MI);
 587
 588   if (BrOffset <= DestOffset) {
 589     if (DestOffset - BrOffset <= MaxDisp)
 590       return true;
 591   } else {
 592     if (BrOffset - DestOffset <= MaxDisp)
 593       return true;
 594   }
 595   return false;
 596 }
 597
 598 /// FixUpImmediateBr - Fix up an immediate branch whose destination is too far
 599 /// away to fit in its displacement field.
 600 bool ARMConstantIslands::FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br) {
 601   MachineInstr *MI = Br.MI;
 602   MachineBasicBlock *DestBB = MI->getOperand(0).getMachineBasicBlock();
 603
 604   // Check to see if the DestBB is already in-range.
 605   if (BBIsInRange(MI, DestBB, Br.MaxDisp))
 606     return false;
 607
 608   if (!Br.isCond)
 609     return FixUpUnconditionalBr(Fn, Br);
 610   return FixUpConditionalBr(Fn, Br);
 611 }
 612
 613 /// FixUpUnconditionalBr - Fix up an unconditional branches whose destination is
 614 /// too far away to fit in its displacement field. If LR register has been
 615 /// spilled in the epilogue, then we can use BL to implement a far jump.
 616 /// Otherwise, add a intermediate branch instruction to to a branch.
 617 bool
 618 ARMConstantIslands::FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br) {
 619   MachineInstr *MI = Br.MI;
 620   MachineBasicBlock *MBB = MI->getParent();
 621   assert(AFI->isThumbFunction() && "Expected a Thumb function!");
 622
 623   // Use BL to implement far jump.
 624   Br.MaxDisp = (1 << 21) * 2;
 625   MI->setInstrDescriptor(TII->get(ARM::tBfar));
 626   BBSizes[MBB->getNumber()] += 2;
 627   HasFarJump = true;
 628   NumUBrFixed++;
 629   return true;
 630 }
 631
 632 /// getUnconditionalBrDisp - Returns the maximum displacement that can fit in the
 633 /// specific unconditional branch instruction.
 634 static inline unsigned getUnconditionalBrDisp(int Opc) {
 635   return (Opc == ARM::tB) ? (1<<10)*2 : (1<<23)*4;
 636 }
 637
 638 /// FixUpConditionalBr - Fix up a conditional branches whose destination is too
 639 /// far away to fit in its displacement field. It is converted to an inverse
 640 /// conditional branch + an unconditional branch to the destination.
 641 bool
 642 ARMConstantIslands::FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br) {
 643   MachineInstr *MI = Br.MI;
 644   MachineBasicBlock *DestBB = MI->getOperand(0).getMachineBasicBlock();
 645
 646   // Add a unconditional branch to the destination and invert the branch
 647   // condition to jump over it:
 648   // blt L1
 649   // =>
 650   // bge L2
 651   // b   L1
 652   // L2:
 653   ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(1).getImmedValue();
 654   CC = ARMCC::getOppositeCondition(CC);
 655
 656   // If the branch is at the end of its MBB and that has a fall-through block,
 657   // direct the updated conditional branch to the fall-through block. Otherwise,
 658   // split the MBB before the next instruction.
 659   MachineBasicBlock *MBB = MI->getParent();
 660   MachineInstr *BackMI = &MBB->back();
 661   bool NeedSplit = (BackMI != MI) || !BBHasFallthrough(MBB);
 662
 663   NumCBrFixed++;
 664   if (BackMI != MI) {
 665     if (next(MachineBasicBlock::iterator(MI)) == MBB->back() &&
 666         BackMI->getOpcode() == Br.UncondBr) {
 667       // Last MI in the BB is a unconditional branch. Can we simply invert the
 668       // condition and swap destinations:
 669       // beq L1
 670       // b   L2
 671       // =>
 672       // bne L2
 673       // b   L1
 674       MachineBasicBlock *NewDest = BackMI->getOperand(0).getMachineBasicBlock();
 675       if (BBIsInRange(MI, NewDest, Br.MaxDisp)) {
 676         BackMI->getOperand(0).setMachineBasicBlock(DestBB);
 677         MI->getOperand(0).setMachineBasicBlock(NewDest);
 678         MI->getOperand(1).setImm(CC);
 679         return true;
 680       }
 681     }
 682   }
 683
 684   if (NeedSplit) {
 685     SplitBlockBeforeInstr(MI);
 686     // No need for the branch to the next block. We're adding a unconditional
 687     // branch to the destination.
 688     MBB->back().eraseFromParent();
 689   }
 690   MachineBasicBlock *NextBB = next(MachineFunction::iterator(MBB));
 691
 692   // Insert a unconditional branch and replace the conditional branch.
 693   // Also update the ImmBranch as well as adding a new entry for the new branch.
 694   BuildMI(MBB, TII->get(MI->getOpcode())).addMBB(NextBB).addImm(CC);
 695   Br.MI = &MBB->back();
 696   BuildMI(MBB, TII->get(Br.UncondBr)).addMBB(DestBB);
 697   unsigned MaxDisp = getUnconditionalBrDisp(Br.UncondBr);
 698   ImmBranches.push_back(ImmBranch(&MBB->back(), MaxDisp, false, Br.UncondBr));
 699   MI->eraseFromParent();
 700
 701   // Increase the size of MBB to account for the new unconditional branch.
 702   BBSizes[MBB->getNumber()] += ARM::GetInstSize(&MBB->back());
 703   return true;
 704 }
 705
 706
 707 /// UndoLRSpillRestore - Remove Thumb push / pop instructions that only spills
 708 /// LR / restores LR to pc.
 709 bool ARMConstantIslands::UndoLRSpillRestore() {
 710   bool MadeChange = false;
 711   for (unsigned i = 0, e = PushPopMIs.size(); i != e; ++i) {
 712     MachineInstr *MI = PushPopMIs[i];
 713     if (MI->getNumOperands() == 1) {
 714         if (MI->getOpcode() == ARM::tPOP_RET &&
 715             MI->getOperand(0).getReg() == ARM::PC)
 716           BuildMI(MI->getParent(), TII->get(ARM::tBX_RET));
 717         MI->eraseFromParent();
 718         MadeChange = true;
 719     }
 720   }
 721   return MadeChange;
 722 }