lib/Target/ARM/ARMConstantIslandPass.cpp

   1 //===-- ARMConstantIslandPass.cpp - ARM constant islands --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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/SmallVector.h"
  28 #include "llvm/ADT/STLExtras.h"
  29 #include "llvm/ADT/Statistic.h"
  30 using namespace llvm;
  31
  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");
  36
  37 namespace {
  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.
  43   ///
  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     /// BBSizes - The size of each MachineBasicBlock in bytes of code, indexed
  51     /// by MBB Number.  The two-byte pads required for Thumb alignment are
  52     /// counted as part of the following block (i.e., the offset and size for
  53     /// a padded block will both be ==2 mod 4).
  54     std::vector<unsigned> BBSizes;
  55
  56     /// BBOffsets - the offset of each MBB in bytes, starting from 0.
  57     /// The two-byte pads required for Thumb alignment are counted as part of
  58     /// the following block.
  59     std::vector<unsigned> BBOffsets;
  60
  61     /// WaterList - A sorted list of basic blocks where islands could be placed
  62     /// (i.e. blocks that don't fall through to the following block, due
  63     /// to a return, unreachable, or unconditional branch).
  64     std::vector<MachineBasicBlock*> WaterList;
  65
  66     /// CPUser - One user of a constant pool, keeping the machine instruction
  67     /// pointer, the constant pool being referenced, and the max displacement
  68     /// allowed from the instruction to the CP.
  69     struct CPUser {
  70       MachineInstr *MI;
  71       MachineInstr *CPEMI;
  72       unsigned MaxDisp;
  73       CPUser(MachineInstr *mi, MachineInstr *cpemi, unsigned maxdisp)
  74         : MI(mi), CPEMI(cpemi), MaxDisp(maxdisp) {}
  75     };
  76
  77     /// CPUsers - Keep track of all of the machine instructions that use various
  78     /// constant pools and their max displacement.
  79     std::vector<CPUser> CPUsers;
  80
  81     /// CPEntry - One per constant pool entry, keeping the machine instruction
  82     /// pointer, the constpool index, and the number of CPUser's which
  83     /// reference this entry.
  84     struct CPEntry {
  85       MachineInstr *CPEMI;
  86       unsigned CPI;
  87       unsigned RefCount;
  88       CPEntry(MachineInstr *cpemi, unsigned cpi, unsigned rc = 0)
  89         : CPEMI(cpemi), CPI(cpi), RefCount(rc) {}
  90     };
  91
  92     /// CPEntries - Keep track of all of the constant pool entry machine
  93     /// instructions. For each original constpool index (i.e. those that
  94     /// existed upon entry to this pass), it keeps a vector of entries.
  95     /// Original elements are cloned as we go along; the clones are
  96     /// put in the vector of the original element, but have distinct CPIs.
  97     std::vector<std::vector<CPEntry> > CPEntries;
  98
  99     /// ImmBranch - One per immediate branch, keeping the machine instruction
 100     /// pointer, conditional or unconditional, the max displacement,
 101     /// and (if isCond is true) the corresponding unconditional branch
 102     /// opcode.
 103     struct ImmBranch {
 104       MachineInstr *MI;
 105       unsigned MaxDisp : 31;
 106       bool isCond : 1;
 107       int UncondBr;
 108       ImmBranch(MachineInstr *mi, unsigned maxdisp, bool cond, int ubr)
 109         : MI(mi), MaxDisp(maxdisp), isCond(cond), UncondBr(ubr) {}
 110     };
 111
 112     /// ImmBranches - Keep track of all the immediate branch instructions.
 113     ///
 114     std::vector<ImmBranch> ImmBranches;
 115
 116     /// PushPopMIs - Keep track of all the Thumb push / pop instructions.
 117     ///
 118     SmallVector<MachineInstr*, 4> PushPopMIs;
 119
 120     /// HasFarJump - True if any far jump instruction has been emitted during
 121     /// the branch fix up pass.
 122     bool HasFarJump;
 123
 124     const TargetInstrInfo *TII;
 125     ARMFunctionInfo *AFI;
 126     bool isThumb;
 127     bool isThumb2;
 128   public:
 129     static char ID;
 130     ARMConstantIslands() : MachineFunctionPass(&ID) {}
 131
 132     virtual bool runOnMachineFunction(MachineFunction &Fn);
 133
 134     virtual const char *getPassName() const {
 135       return "ARM constant island placement and branch shortening pass";
 136     }
 137
 138   private:
 139     void DoInitialPlacement(MachineFunction &Fn,
 140                             std::vector<MachineInstr*> &CPEMIs);
 141     CPEntry *findConstPoolEntry(unsigned CPI, const MachineInstr *CPEMI);
 142     void InitialFunctionScan(MachineFunction &Fn,
 143                              const std::vector<MachineInstr*> &CPEMIs);
 144     MachineBasicBlock *SplitBlockBeforeInstr(MachineInstr *MI);
 145     void UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB);
 146     void AdjustBBOffsetsAfter(MachineBasicBlock *BB, int delta);
 147     bool DecrementOldEntry(unsigned CPI, MachineInstr* CPEMI);
 148     int LookForExistingCPEntry(CPUser& U, unsigned UserOffset);
 149     bool LookForWater(CPUser&U, unsigned UserOffset,
 150                       MachineBasicBlock** NewMBB);
 151     MachineBasicBlock* AcceptWater(MachineBasicBlock *WaterBB,
 152                         std::vector<MachineBasicBlock*>::iterator IP);
 153     void CreateNewWater(unsigned CPUserIndex, unsigned UserOffset,
 154                       MachineBasicBlock** NewMBB);
 155     bool HandleConstantPoolUser(MachineFunction &Fn, unsigned CPUserIndex);
 156     void RemoveDeadCPEMI(MachineInstr *CPEMI);
 157     bool RemoveUnusedCPEntries();
 158     bool CPEIsInRange(MachineInstr *MI, unsigned UserOffset,
 159                       MachineInstr *CPEMI, unsigned Disp,
 160                       bool DoDump);
 161     bool WaterIsInRange(unsigned UserOffset, MachineBasicBlock *Water,
 162                         CPUser &U);
 163     bool OffsetIsInRange(unsigned UserOffset, unsigned TrialOffset,
 164                         unsigned Disp, bool NegativeOK);
 165     bool BBIsInRange(MachineInstr *MI, MachineBasicBlock *BB, unsigned Disp);
 166     bool FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br);
 167     bool FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br);
 168     bool FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br);
 169     bool UndoLRSpillRestore();
 170
 171     unsigned GetOffsetOf(MachineInstr *MI) const;
 172     void dumpBBs();
 173     void verify(MachineFunction &Fn);
 174   };
 175   char ARMConstantIslands::ID = 0;
 176 }
 177
 178 /// verify - check BBOffsets, BBSizes, alignment of islands
 179 void ARMConstantIslands::verify(MachineFunction &Fn) {
 180   assert(BBOffsets.size() == BBSizes.size());
 181   for (unsigned i = 1, e = BBOffsets.size(); i != e; ++i)
 182     assert(BBOffsets[i-1]+BBSizes[i-1] == BBOffsets[i]);
 183   if (isThumb) {
 184     for (MachineFunction::iterator MBBI = Fn.begin(), E = Fn.end();
 185          MBBI != E; ++MBBI) {
 186       MachineBasicBlock *MBB = MBBI;
 187       if (!MBB->empty() &&
 188           MBB->begin()->getOpcode() == ARM::CONSTPOOL_ENTRY)
 189         assert((BBOffsets[MBB->getNumber()]%4 == 0 &&
 190                 BBSizes[MBB->getNumber()]%4 == 0) ||
 191                (BBOffsets[MBB->getNumber()]%4 != 0 &&
 192                 BBSizes[MBB->getNumber()]%4 != 0));
 193     }
 194   }
 195 }
 196
 197 /// print block size and offset information - debugging
 198 void ARMConstantIslands::dumpBBs() {
 199   for (unsigned J = 0, E = BBOffsets.size(); J !=E; ++J) {
 200     DOUT << "block " << J << " offset " << BBOffsets[J] <<
 201                             " size " << BBSizes[J] << "\n";
 202   }
 203 }
 204
 205 /// createARMConstantIslandPass - returns an instance of the constpool
 206 /// island pass.
 207 FunctionPass *llvm::createARMConstantIslandPass() {
 208   return new ARMConstantIslands();
 209 }
 210
 211 bool ARMConstantIslands::runOnMachineFunction(MachineFunction &Fn) {
 212   MachineConstantPool &MCP = *Fn.getConstantPool();
 213
 214   TII = Fn.getTarget().getInstrInfo();
 215   AFI = Fn.getInfo<ARMFunctionInfo>();
 216   isThumb = AFI->isThumbFunction();
 217   isThumb2 = AFI->isThumb2Function();
 218
 219   HasFarJump = false;
 220
 221   // Renumber all of the machine basic blocks in the function, guaranteeing that
 222   // the numbers agree with the position of the block in the function.
 223   Fn.RenumberBlocks();
 224
 225   /// Thumb functions containing constant pools get 2-byte alignment.
 226   /// This is so we can keep exact track of where the alignment padding goes.
 227   /// Set default.
 228   AFI->setAlign(isThumb ? 1U : 2U);
 229
 230   // Perform the initial placement of the constant pool entries.  To start with,
 231   // we put them all at the end of the function.
 232   std::vector<MachineInstr*> CPEMIs;
 233   if (!MCP.isEmpty()) {
 234     DoInitialPlacement(Fn, CPEMIs);
 235     if (isThumb)
 236       AFI->setAlign(2U);
 237   }
 238
 239   /// The next UID to take is the first unused one.
 240   AFI->initConstPoolEntryUId(CPEMIs.size());
 241
 242   // Do the initial scan of the function, building up information about the
 243   // sizes of each block, the location of all the water, and finding all of the
 244   // constant pool users.
 245   InitialFunctionScan(Fn, CPEMIs);
 246   CPEMIs.clear();
 247
 248   /// Remove dead constant pool entries.
 249   RemoveUnusedCPEntries();
 250
 251   // Iteratively place constant pool entries and fix up branches until there
 252   // is no change.
 253   bool MadeChange = false;
 254   while (true) {
 255     bool Change = false;
 256     for (unsigned i = 0, e = CPUsers.size(); i != e; ++i)
 257       Change |= HandleConstantPoolUser(Fn, i);
 258     DEBUG(dumpBBs());
 259     for (unsigned i = 0, e = ImmBranches.size(); i != e; ++i)
 260       Change |= FixUpImmediateBr(Fn, ImmBranches[i]);
 261     DEBUG(dumpBBs());
 262     if (!Change)
 263       break;
 264     MadeChange = true;
 265   }
 266
 267   // After a while, this might be made debug-only, but it is not expensive.
 268   verify(Fn);
 269
 270   // If LR has been forced spilled and no far jumps (i.e. BL) has been issued.
 271   // Undo the spill / restore of LR if possible.
 272   if (!HasFarJump && AFI->isLRSpilledForFarJump() && isThumb)
 273     MadeChange |= UndoLRSpillRestore();
 274
 275   BBSizes.clear();
 276   BBOffsets.clear();
 277   WaterList.clear();
 278   CPUsers.clear();
 279   CPEntries.clear();
 280   ImmBranches.clear();
 281   PushPopMIs.clear();
 282
 283   return MadeChange;
 284 }
 285
 286 /// DoInitialPlacement - Perform the initial placement of the constant pool
 287 /// entries.  To start with, we put them all at the end of the function.
 288 void ARMConstantIslands::DoInitialPlacement(MachineFunction &Fn,
 289                                         std::vector<MachineInstr*> &CPEMIs) {
 290   // Create the basic block to hold the CPE's.
 291   MachineBasicBlock *BB = Fn.CreateMachineBasicBlock();
 292   Fn.push_back(BB);
 293
 294   // Add all of the constants from the constant pool to the end block, use an
 295   // identity mapping of CPI's to CPE's.
 296   const std::vector<MachineConstantPoolEntry> &CPs =
 297     Fn.getConstantPool()->getConstants();
 298
 299   const TargetData &TD = *Fn.getTarget().getTargetData();
 300   for (unsigned i = 0, e = CPs.size(); i != e; ++i) {
 301     unsigned Size = TD.getTypeAllocSize(CPs[i].getType());
 302     // Verify that all constant pool entries are a multiple of 4 bytes.  If not,
 303     // we would have to pad them out or something so that instructions stay
 304     // aligned.
 305     assert((Size & 3) == 0 && "CP Entry not multiple of 4 bytes!");
 306     MachineInstr *CPEMI =
 307       BuildMI(BB, DebugLoc::getUnknownLoc(), TII->get(ARM::CONSTPOOL_ENTRY))
 308                            .addImm(i).addConstantPoolIndex(i).addImm(Size);
 309     CPEMIs.push_back(CPEMI);
 310
 311     // Add a new CPEntry, but no corresponding CPUser yet.
 312     std::vector<CPEntry> CPEs;
 313     CPEs.push_back(CPEntry(CPEMI, i));
 314     CPEntries.push_back(CPEs);
 315     NumCPEs++;
 316     DOUT << "Moved CPI#" << i << " to end of function as #" << i << "\n";
 317   }
 318 }
 319
 320 /// BBHasFallthrough - Return true if the specified basic block can fallthrough
 321 /// into the block immediately after it.
 322 static bool BBHasFallthrough(MachineBasicBlock *MBB) {
 323   // Get the next machine basic block in the function.
 324   MachineFunction::iterator MBBI = MBB;
 325   if (next(MBBI) == MBB->getParent()->end())  // Can't fall off end of function.
 326     return false;
 327
 328   MachineBasicBlock *NextBB = next(MBBI);
 329   for (MachineBasicBlock::succ_iterator I = MBB->succ_begin(),
 330        E = MBB->succ_end(); I != E; ++I)
 331     if (*I == NextBB)
 332       return true;
 333
 334   return false;
 335 }
 336
 337 /// findConstPoolEntry - Given the constpool index and CONSTPOOL_ENTRY MI,
 338 /// look up the corresponding CPEntry.
 339 ARMConstantIslands::CPEntry
 340 *ARMConstantIslands::findConstPoolEntry(unsigned CPI,
 341                                         const MachineInstr *CPEMI) {
 342   std::vector<CPEntry> &CPEs = CPEntries[CPI];
 343   // Number of entries per constpool index should be small, just do a
 344   // linear search.
 345   for (unsigned i = 0, e = CPEs.size(); i != e; ++i) {
 346     if (CPEs[i].CPEMI == CPEMI)
 347       return &CPEs[i];
 348   }
 349   return NULL;
 350 }
 351
 352 /// InitialFunctionScan - Do the initial scan of the function, building up
 353 /// information about the sizes of each block, the location of all the water,
 354 /// and finding all of the constant pool users.
 355 void ARMConstantIslands::InitialFunctionScan(MachineFunction &Fn,
 356                                  const std::vector<MachineInstr*> &CPEMIs) {
 357   unsigned Offset = 0;
 358   for (MachineFunction::iterator MBBI = Fn.begin(), E = Fn.end();
 359        MBBI != E; ++MBBI) {
 360     MachineBasicBlock &MBB = *MBBI;
 361
 362     // If this block doesn't fall through into the next MBB, then this is
 363     // 'water' that a constant pool island could be placed.
 364     if (!BBHasFallthrough(&MBB))
 365       WaterList.push_back(&MBB);
 366
 367     unsigned MBBSize = 0;
 368     for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
 369          I != E; ++I) {
 370       // Add instruction size to MBBSize.
 371       MBBSize += TII->GetInstSizeInBytes(I);
 372
 373       int Opc = I->getOpcode();
 374       if (I->getDesc().isBranch()) {
 375         bool isCond = false;
 376         unsigned Bits = 0;
 377         unsigned Scale = 1;
 378         int UOpc = Opc;
 379         switch (Opc) {
 380         case ARM::tBR_JTr:
 381         case ARM::t2BR_JTr:
 382           // A Thumb table jump may involve padding; for the offsets to
 383           // be right, functions containing these must be 4-byte aligned.
 384           AFI->setAlign(2U);
 385           if ((Offset+MBBSize)%4 != 0)
 386             MBBSize += 2;           // padding
 387           continue;   // Does not get an entry in ImmBranches
 388         default:
 389           continue;  // Ignore other JT branches
 390         case ARM::Bcc:
 391           isCond = true;
 392           UOpc = ARM::B;
 393           // Fallthrough
 394         case ARM::B:
 395           Bits = 24;
 396           Scale = 4;
 397           break;
 398         case ARM::tBcc:
 399           isCond = true;
 400           UOpc = ARM::tB;
 401           Bits = 8;
 402           Scale = 2;
 403           break;
 404         case ARM::tB:
 405           Bits = 11;
 406           Scale = 2;
 407           break;
 408         case ARM::t2Bcc:
 409           isCond = true;
 410           UOpc = ARM::t2B;
 411           Bits = 20;
 412           Scale = 2;
 413           break;
 414         case ARM::t2B:
 415           Bits = 24;
 416           Scale = 2;
 417           break;
 418         }
 419
 420         // Record this immediate branch.
 421         unsigned MaxOffs = ((1 << (Bits-1))-1) * Scale;
 422         ImmBranches.push_back(ImmBranch(I, MaxOffs, isCond, UOpc));
 423       }
 424
 425       if (Opc == ARM::tPUSH || Opc == ARM::tPOP_RET)
 426         PushPopMIs.push_back(I);
 427
 428       // Scan the instructions for constant pool operands.
 429       for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op)
 430         if (I->getOperand(op).isCPI()) {
 431           // We found one.  The addressing mode tells us the max displacement
 432           // from the PC that this instruction permits.
 433
 434           // Basic size info comes from the TSFlags field.
 435           unsigned Bits = 0;
 436           unsigned Scale = 1;
 437           unsigned TSFlags = I->getDesc().TSFlags;
 438           switch (TSFlags & ARMII::AddrModeMask) {
 439           default:
 440             // Constant pool entries can reach anything.
 441             if (I->getOpcode() == ARM::CONSTPOOL_ENTRY)
 442               continue;
 443             if (I->getOpcode() == ARM::tLEApcrel) {
 444               Bits = 8;  // Taking the address of a CP entry.
 445               break;
 446             }
 447             assert(0 && "Unknown addressing mode for CP reference!");
 448           case ARMII::AddrMode1: // AM1: 8 bits << 2
 449             Bits = 8;
 450             Scale = 4;  // Taking the address of a CP entry.
 451             break;
 452           case ARMII::AddrMode2:
 453             Bits = 12;  // +-offset_12
 454             break;
 455           case ARMII::AddrMode3:
 456             Bits = 8;   // +-offset_8
 457             break;
 458             // addrmode4 has no immediate offset.
 459           case ARMII::AddrMode5:
 460             Bits = 8;
 461             Scale = 4;  // +-(offset_8*4)
 462             break;
 463           case ARMII::AddrModeT1_1:
 464             Bits = 5;  // +offset_5
 465             break;
 466           case ARMII::AddrModeT1_2:
 467             Bits = 5;
 468             Scale = 2;  // +(offset_5*2)
 469             break;
 470           case ARMII::AddrModeT1_4:
 471             Bits = 5;
 472             Scale = 4;  // +(offset_5*4)
 473             break;
 474           case ARMII::AddrModeT1_s:
 475             Bits = 8;
 476             Scale = 4;  // +(offset_8*4)
 477             break;
 478           case ARMII::AddrModeT2_pc:
 479             Bits = 12;  // +-offset_12
 480             break;
 481           }
 482
 483           // Remember that this is a user of a CP entry.
 484           unsigned CPI = I->getOperand(op).getIndex();
 485           MachineInstr *CPEMI = CPEMIs[CPI];
 486           unsigned MaxOffs = ((1 << Bits)-1) * Scale;
 487           CPUsers.push_back(CPUser(I, CPEMI, MaxOffs));
 488
 489           // Increment corresponding CPEntry reference count.
 490           CPEntry *CPE = findConstPoolEntry(CPI, CPEMI);
 491           assert(CPE && "Cannot find a corresponding CPEntry!");
 492           CPE->RefCount++;
 493
 494           // Instructions can only use one CP entry, don't bother scanning the
 495           // rest of the operands.
 496           break;
 497         }
 498     }
 499
 500     // In thumb mode, if this block is a constpool island, we may need padding
 501     // so it's aligned on 4 byte boundary.
 502     if (isThumb &&
 503         !MBB.empty() &&
 504         MBB.begin()->getOpcode() == ARM::CONSTPOOL_ENTRY &&
 505         (Offset%4) != 0)
 506       MBBSize += 2;
 507
 508     BBSizes.push_back(MBBSize);
 509     BBOffsets.push_back(Offset);
 510     Offset += MBBSize;
 511   }
 512 }
 513
 514 /// GetOffsetOf - Return the current offset of the specified machine instruction
 515 /// from the start of the function.  This offset changes as stuff is moved
 516 /// around inside the function.
 517 unsigned ARMConstantIslands::GetOffsetOf(MachineInstr *MI) const {
 518   MachineBasicBlock *MBB = MI->getParent();
 519
 520   // The offset is composed of two things: the sum of the sizes of all MBB's
 521   // before this instruction's block, and the offset from the start of the block
 522   // it is in.
 523   unsigned Offset = BBOffsets[MBB->getNumber()];
 524
 525   // If we're looking for a CONSTPOOL_ENTRY in Thumb, see if this block has
 526   // alignment padding, and compensate if so.
 527   if (isThumb &&
 528       MI->getOpcode() == ARM::CONSTPOOL_ENTRY &&
 529       Offset%4 != 0)
 530     Offset += 2;
 531
 532   // Sum instructions before MI in MBB.
 533   for (MachineBasicBlock::iterator I = MBB->begin(); ; ++I) {
 534     assert(I != MBB->end() && "Didn't find MI in its own basic block?");
 535     if (&*I == MI) return Offset;
 536     Offset += TII->GetInstSizeInBytes(I);
 537   }
 538 }
 539
 540 /// CompareMBBNumbers - Little predicate function to sort the WaterList by MBB
 541 /// ID.
 542 static bool CompareMBBNumbers(const MachineBasicBlock *LHS,
 543                               const MachineBasicBlock *RHS) {
 544   return LHS->getNumber() < RHS->getNumber();
 545 }
 546
 547 /// UpdateForInsertedWaterBlock - When a block is newly inserted into the
 548 /// machine function, it upsets all of the block numbers.  Renumber the blocks
 549 /// and update the arrays that parallel this numbering.
 550 void ARMConstantIslands::UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB) {
 551   // Renumber the MBB's to keep them consequtive.
 552   NewBB->getParent()->RenumberBlocks(NewBB);
 553
 554   // Insert a size into BBSizes to align it properly with the (newly
 555   // renumbered) block numbers.
 556   BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
 557
 558   // Likewise for BBOffsets.
 559   BBOffsets.insert(BBOffsets.begin()+NewBB->getNumber(), 0);
 560
 561   // Next, update WaterList.  Specifically, we need to add NewMBB as having
 562   // available water after it.
 563   std::vector<MachineBasicBlock*>::iterator IP =
 564     std::lower_bound(WaterList.begin(), WaterList.end(), NewBB,
 565                      CompareMBBNumbers);
 566   WaterList.insert(IP, NewBB);
 567 }
 568
 569
 570 /// Split the basic block containing MI into two blocks, which are joined by
 571 /// an unconditional branch.  Update datastructures and renumber blocks to
 572 /// account for this change and returns the newly created block.
 573 MachineBasicBlock *ARMConstantIslands::SplitBlockBeforeInstr(MachineInstr *MI) {
 574   MachineBasicBlock *OrigBB = MI->getParent();
 575   MachineFunction &MF = *OrigBB->getParent();
 576
 577   // Create a new MBB for the code after the OrigBB.
 578   MachineBasicBlock *NewBB =
 579     MF.CreateMachineBasicBlock(OrigBB->getBasicBlock());
 580   MachineFunction::iterator MBBI = OrigBB; ++MBBI;
 581   MF.insert(MBBI, NewBB);
 582
 583   // Splice the instructions starting with MI over to NewBB.
 584   NewBB->splice(NewBB->end(), OrigBB, MI, OrigBB->end());
 585
 586   // Add an unconditional branch from OrigBB to NewBB.
 587   // Note the new unconditional branch is not being recorded.
 588   // There doesn't seem to be meaningful DebugInfo available; this doesn't
 589   // correspond to anything in the source.
 590   BuildMI(OrigBB, DebugLoc::getUnknownLoc(),
 591           TII->get(isThumb ? ((isThumb2) ? ARM::t2B : ARM::tB) : ARM::B)).addMBB(NewBB);
 592   NumSplit++;
 593
 594   // Update the CFG.  All succs of OrigBB are now succs of NewBB.
 595   while (!OrigBB->succ_empty()) {
 596     MachineBasicBlock *Succ = *OrigBB->succ_begin();
 597     OrigBB->removeSuccessor(Succ);
 598     NewBB->addSuccessor(Succ);
 599
 600     // This pass should be run after register allocation, so there should be no
 601     // PHI nodes to update.
 602     assert((Succ->empty() || Succ->begin()->getOpcode() != TargetInstrInfo::PHI)
 603            && "PHI nodes should be eliminated by now!");
 604   }
 605
 606   // OrigBB branches to NewBB.
 607   OrigBB->addSuccessor(NewBB);
 608
 609   // Update internal data structures to account for the newly inserted MBB.
 610   // This is almost the same as UpdateForInsertedWaterBlock, except that
 611   // the Water goes after OrigBB, not NewBB.
 612   MF.RenumberBlocks(NewBB);
 613
 614   // Insert a size into BBSizes to align it properly with the (newly
 615   // renumbered) block numbers.
 616   BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
 617
 618   // Likewise for BBOffsets.
 619   BBOffsets.insert(BBOffsets.begin()+NewBB->getNumber(), 0);
 620
 621   // Next, update WaterList.  Specifically, we need to add OrigMBB as having
 622   // available water after it (but not if it's already there, which happens
 623   // when splitting before a conditional branch that is followed by an
 624   // unconditional branch - in that case we want to insert NewBB).
 625   std::vector<MachineBasicBlock*>::iterator IP =
 626     std::lower_bound(WaterList.begin(), WaterList.end(), OrigBB,
 627                      CompareMBBNumbers);
 628   MachineBasicBlock* WaterBB = *IP;
 629   if (WaterBB == OrigBB)
 630     WaterList.insert(next(IP), NewBB);
 631   else
 632     WaterList.insert(IP, OrigBB);
 633
 634   // Figure out how large the first NewMBB is.  (It cannot
 635   // contain a constpool_entry or tablejump.)
 636   unsigned NewBBSize = 0;
 637   for (MachineBasicBlock::iterator I = NewBB->begin(), E = NewBB->end();
 638        I != E; ++I)
 639     NewBBSize += TII->GetInstSizeInBytes(I);
 640
 641   unsigned OrigBBI = OrigBB->getNumber();
 642   unsigned NewBBI = NewBB->getNumber();
 643   // Set the size of NewBB in BBSizes.
 644   BBSizes[NewBBI] = NewBBSize;
 645
 646   // We removed instructions from UserMBB, subtract that off from its size.
 647   // Add 2 or 4 to the block to count the unconditional branch we added to it.
 648   unsigned delta = isThumb ? 2 : 4;
 649   BBSizes[OrigBBI] -= NewBBSize - delta;
 650
 651   // ...and adjust BBOffsets for NewBB accordingly.
 652   BBOffsets[NewBBI] = BBOffsets[OrigBBI] + BBSizes[OrigBBI];
 653
 654   // All BBOffsets following these blocks must be modified.
 655   AdjustBBOffsetsAfter(NewBB, delta);
 656
 657   return NewBB;
 658 }
 659
 660 /// OffsetIsInRange - Checks whether UserOffset (the location of a constant pool
 661 /// reference) is within MaxDisp of TrialOffset (a proposed location of a
 662 /// constant pool entry).
 663 bool ARMConstantIslands::OffsetIsInRange(unsigned UserOffset,
 664                       unsigned TrialOffset, unsigned MaxDisp, bool NegativeOK) {
 665   // On Thumb offsets==2 mod 4 are rounded down by the hardware for
 666   // purposes of the displacement computation; compensate for that here.
 667   // Effectively, the valid range of displacements is 2 bytes smaller for such
 668   // references.
 669   if (isThumb && UserOffset%4 !=0)
 670     UserOffset -= 2;
 671   // CPEs will be rounded up to a multiple of 4.
 672   if (isThumb && TrialOffset%4 != 0)
 673     TrialOffset += 2;
 674
 675   if (UserOffset <= TrialOffset) {
 676     // User before the Trial.
 677     if (TrialOffset-UserOffset <= MaxDisp)
 678       return true;
 679   } else if (NegativeOK) {
 680     if (UserOffset-TrialOffset <= MaxDisp)
 681       return true;
 682   }
 683   return false;
 684 }
 685
 686 /// WaterIsInRange - Returns true if a CPE placed after the specified
 687 /// Water (a basic block) will be in range for the specific MI.
 688
 689 bool ARMConstantIslands::WaterIsInRange(unsigned UserOffset,
 690                          MachineBasicBlock* Water, CPUser &U)
 691 {
 692   unsigned MaxDisp = U.MaxDisp;
 693   MachineFunction::iterator I = next(MachineFunction::iterator(Water));
 694   unsigned CPEOffset = BBOffsets[Water->getNumber()] +
 695                        BBSizes[Water->getNumber()];
 696
 697   // If the CPE is to be inserted before the instruction, that will raise
 698   // the offset of the instruction.  (Currently applies only to ARM, so
 699   // no alignment compensation attempted here.)
 700   if (CPEOffset < UserOffset)
 701     UserOffset += U.CPEMI->getOperand(2).getImm();
 702
 703   return OffsetIsInRange (UserOffset, CPEOffset, MaxDisp, !isThumb);
 704 }
 705
 706 /// CPEIsInRange - Returns true if the distance between specific MI and
 707 /// specific ConstPool entry instruction can fit in MI's displacement field.
 708 bool ARMConstantIslands::CPEIsInRange(MachineInstr *MI, unsigned UserOffset,
 709                                       MachineInstr *CPEMI,
 710                                       unsigned MaxDisp, bool DoDump) {
 711   unsigned CPEOffset  = GetOffsetOf(CPEMI);
 712   assert(CPEOffset%4 == 0 && "Misaligned CPE");
 713
 714   if (DoDump) {
 715     DOUT << "User of CPE#" << CPEMI->getOperand(0).getImm()
 716          << " max delta=" << MaxDisp
 717          << " insn address=" << UserOffset
 718          << " CPE address=" << CPEOffset
 719          << " offset=" << int(CPEOffset-UserOffset) << "\t" << *MI;
 720   }
 721
 722   return OffsetIsInRange(UserOffset, CPEOffset, MaxDisp, !isThumb);
 723 }
 724
 725 #ifndef NDEBUG
 726 /// BBIsJumpedOver - Return true of the specified basic block's only predecessor
 727 /// unconditionally branches to its only successor.
 728 static bool BBIsJumpedOver(MachineBasicBlock *MBB) {
 729   if (MBB->pred_size() != 1 || MBB->succ_size() != 1)
 730     return false;
 731
 732   MachineBasicBlock *Succ = *MBB->succ_begin();
 733   MachineBasicBlock *Pred = *MBB->pred_begin();
 734   MachineInstr *PredMI = &Pred->back();
 735   if (PredMI->getOpcode() == ARM::B || PredMI->getOpcode() == ARM::tB
 736       || PredMI->getOpcode() == ARM::t2B)
 737     return PredMI->getOperand(0).getMBB() == Succ;
 738   return false;
 739 }
 740 #endif // NDEBUG
 741
 742 void ARMConstantIslands::AdjustBBOffsetsAfter(MachineBasicBlock *BB,
 743                                               int delta) {
 744   MachineFunction::iterator MBBI = BB; MBBI = next(MBBI);
 745   for(unsigned i=BB->getNumber()+1; i<BB->getParent()->getNumBlockIDs(); i++) {
 746     BBOffsets[i] += delta;
 747     // If some existing blocks have padding, adjust the padding as needed, a
 748     // bit tricky.  delta can be negative so don't use % on that.
 749     if (isThumb) {
 750       MachineBasicBlock *MBB = MBBI;
 751       if (!MBB->empty()) {
 752         // Constant pool entries require padding.
 753         if (MBB->begin()->getOpcode() == ARM::CONSTPOOL_ENTRY) {
 754           unsigned oldOffset = BBOffsets[i] - delta;
 755           if (oldOffset%4==0 && BBOffsets[i]%4!=0) {
 756             // add new padding
 757             BBSizes[i] += 2;
 758             delta += 2;
 759           } else if (oldOffset%4!=0 && BBOffsets[i]%4==0) {
 760             // remove existing padding
 761             BBSizes[i] -=2;
 762             delta -= 2;
 763           }
 764         }
 765         // Thumb jump tables require padding.  They should be at the end;
 766         // following unconditional branches are removed by AnalyzeBranch.
 767         MachineInstr *ThumbJTMI = NULL;
 768         if ((prior(MBB->end())->getOpcode() == ARM::tBR_JTr)
 769             || (prior(MBB->end())->getOpcode() == ARM::t2BR_JTr))
 770           ThumbJTMI = prior(MBB->end());
 771         if (ThumbJTMI) {
 772           unsigned newMIOffset = GetOffsetOf(ThumbJTMI);
 773           unsigned oldMIOffset = newMIOffset - delta;
 774           if (oldMIOffset%4 == 0 && newMIOffset%4 != 0) {
 775             // remove existing padding
 776             BBSizes[i] -= 2;
 777             delta -= 2;
 778           } else if (oldMIOffset%4 != 0 && newMIOffset%4 == 0) {
 779             // add new padding
 780             BBSizes[i] += 2;
 781             delta += 2;
 782           }
 783         }
 784         if (delta==0)
 785           return;
 786       }
 787       MBBI = next(MBBI);
 788     }
 789   }
 790 }
 791
 792 /// DecrementOldEntry - find the constant pool entry with index CPI
 793 /// and instruction CPEMI, and decrement its refcount.  If the refcount
 794 /// becomes 0 remove the entry and instruction.  Returns true if we removed
 795 /// the entry, false if we didn't.
 796
 797 bool ARMConstantIslands::DecrementOldEntry(unsigned CPI, MachineInstr *CPEMI) {
 798   // Find the old entry. Eliminate it if it is no longer used.
 799   CPEntry *CPE = findConstPoolEntry(CPI, CPEMI);
 800   assert(CPE && "Unexpected!");
 801   if (--CPE->RefCount == 0) {
 802     RemoveDeadCPEMI(CPEMI);
 803     CPE->CPEMI = NULL;
 804     NumCPEs--;
 805     return true;
 806   }
 807   return false;
 808 }
 809
 810 /// LookForCPEntryInRange - see if the currently referenced CPE is in range;
 811 /// if not, see if an in-range clone of the CPE is in range, and if so,
 812 /// change the data structures so the user references the clone.  Returns:
 813 /// 0 = no existing entry found
 814 /// 1 = entry found, and there were no code insertions or deletions
 815 /// 2 = entry found, and there were code insertions or deletions
 816 int ARMConstantIslands::LookForExistingCPEntry(CPUser& U, unsigned UserOffset)
 817 {
 818   MachineInstr *UserMI = U.MI;
 819   MachineInstr *CPEMI  = U.CPEMI;
 820
 821   // Check to see if the CPE is already in-range.
 822   if (CPEIsInRange(UserMI, UserOffset, CPEMI, U.MaxDisp, true)) {
 823     DOUT << "In range\n";
 824     return 1;
 825   }
 826
 827   // No.  Look for previously created clones of the CPE that are in range.
 828   unsigned CPI = CPEMI->getOperand(1).getIndex();
 829   std::vector<CPEntry> &CPEs = CPEntries[CPI];
 830   for (unsigned i = 0, e = CPEs.size(); i != e; ++i) {
 831     // We already tried this one
 832     if (CPEs[i].CPEMI == CPEMI)
 833       continue;
 834     // Removing CPEs can leave empty entries, skip
 835     if (CPEs[i].CPEMI == NULL)
 836       continue;
 837     if (CPEIsInRange(UserMI, UserOffset, CPEs[i].CPEMI, U.MaxDisp, false)) {
 838       DOUT << "Replacing CPE#" << CPI << " with CPE#" << CPEs[i].CPI << "\n";
 839       // Point the CPUser node to the replacement
 840       U.CPEMI = CPEs[i].CPEMI;
 841       // Change the CPI in the instruction operand to refer to the clone.
 842       for (unsigned j = 0, e = UserMI->getNumOperands(); j != e; ++j)
 843         if (UserMI->getOperand(j).isCPI()) {
 844           UserMI->getOperand(j).setIndex(CPEs[i].CPI);
 845           break;
 846         }
 847       // Adjust the refcount of the clone...
 848       CPEs[i].RefCount++;
 849       // ...and the original.  If we didn't remove the old entry, none of the
 850       // addresses changed, so we don't need another pass.
 851       return DecrementOldEntry(CPI, CPEMI) ? 2 : 1;
 852     }
 853   }
 854   return 0;
 855 }
 856
 857 /// getUnconditionalBrDisp - Returns the maximum displacement that can fit in
 858 /// the specific unconditional branch instruction.
 859 static inline unsigned getUnconditionalBrDisp(int Opc) {
 860   switch (Opc) {
 861   case ARM::tB:
 862     return ((1<<10)-1)*2;
 863   case ARM::t2B:
 864     return ((1<<23)-1)*2;
 865   default:
 866     break;
 867   }
 868
 869   return ((1<<23)-1)*4;
 870 }
 871
 872 /// AcceptWater - Small amount of common code factored out of the following.
 873
 874 MachineBasicBlock* ARMConstantIslands::AcceptWater(MachineBasicBlock *WaterBB,
 875                           std::vector<MachineBasicBlock*>::iterator IP) {
 876   DOUT << "found water in range\n";
 877   // Remove the original WaterList entry; we want subsequent
 878   // insertions in this vicinity to go after the one we're
 879   // about to insert.  This considerably reduces the number
 880   // of times we have to move the same CPE more than once.
 881   WaterList.erase(IP);
 882   // CPE goes before following block (NewMBB).
 883   return next(MachineFunction::iterator(WaterBB));
 884 }
 885
 886 /// LookForWater - look for an existing entry in the WaterList in which
 887 /// we can place the CPE referenced from U so it's within range of U's MI.
 888 /// Returns true if found, false if not.  If it returns true, *NewMBB
 889 /// is set to the WaterList entry.
 890 /// For ARM, we prefer the water that's farthest away.  For Thumb, prefer
 891 /// water that will not introduce padding to water that will; within each
 892 /// group, prefer the water that's farthest away.
 893
 894 bool ARMConstantIslands::LookForWater(CPUser &U, unsigned UserOffset,
 895                                       MachineBasicBlock** NewMBB) {
 896   std::vector<MachineBasicBlock*>::iterator IPThatWouldPad;
 897   MachineBasicBlock* WaterBBThatWouldPad = NULL;
 898   if (!WaterList.empty()) {
 899     for (std::vector<MachineBasicBlock*>::iterator IP = prior(WaterList.end()),
 900         B = WaterList.begin();; --IP) {
 901       MachineBasicBlock* WaterBB = *IP;
 902       if (WaterIsInRange(UserOffset, WaterBB, U)) {
 903         if (isThumb &&
 904             (BBOffsets[WaterBB->getNumber()] +
 905              BBSizes[WaterBB->getNumber()])%4 != 0) {
 906           // This is valid Water, but would introduce padding.  Remember
 907           // it in case we don't find any Water that doesn't do this.
 908           if (!WaterBBThatWouldPad) {
 909             WaterBBThatWouldPad = WaterBB;
 910             IPThatWouldPad = IP;
 911           }
 912         } else {
 913           *NewMBB = AcceptWater(WaterBB, IP);
 914           return true;
 915         }
 916     }
 917       if (IP == B)
 918         break;
 919     }
 920   }
 921   if (isThumb && WaterBBThatWouldPad) {
 922     *NewMBB = AcceptWater(WaterBBThatWouldPad, IPThatWouldPad);
 923     return true;
 924   }
 925   return false;
 926 }
 927
 928 /// CreateNewWater - No existing WaterList entry will work for
 929 /// CPUsers[CPUserIndex], so create a place to put the CPE.  The end of the
 930 /// block is used if in range, and the conditional branch munged so control
 931 /// flow is correct.  Otherwise the block is split to create a hole with an
 932 /// unconditional branch around it.  In either case *NewMBB is set to a
 933 /// block following which the new island can be inserted (the WaterList
 934 /// is not adjusted).
 935
 936 void ARMConstantIslands::CreateNewWater(unsigned CPUserIndex,
 937                         unsigned UserOffset, MachineBasicBlock** NewMBB) {
 938   CPUser &U = CPUsers[CPUserIndex];
 939   MachineInstr *UserMI = U.MI;
 940   MachineInstr *CPEMI  = U.CPEMI;
 941   MachineBasicBlock *UserMBB = UserMI->getParent();
 942   unsigned OffsetOfNextBlock = BBOffsets[UserMBB->getNumber()] +
 943                                BBSizes[UserMBB->getNumber()];
 944   assert(OffsetOfNextBlock== BBOffsets[UserMBB->getNumber()+1]);
 945
 946   // If the use is at the end of the block, or the end of the block
 947   // is within range, make new water there.  (The addition below is
 948   // for the unconditional branch we will be adding:  4 bytes on ARM,
 949   // 2 on Thumb.  Possible Thumb alignment padding is allowed for
 950   // inside OffsetIsInRange.
 951   // If the block ends in an unconditional branch already, it is water,
 952   // and is known to be out of range, so we'll always be adding a branch.)
 953   if (&UserMBB->back() == UserMI ||
 954       OffsetIsInRange(UserOffset, OffsetOfNextBlock + (isThumb ? 2: 4),
 955            U.MaxDisp, !isThumb)) {
 956     DOUT << "Split at end of block\n";
 957     if (&UserMBB->back() == UserMI)
 958       assert(BBHasFallthrough(UserMBB) && "Expected a fallthrough BB!");
 959     *NewMBB = next(MachineFunction::iterator(UserMBB));
 960     // Add an unconditional branch from UserMBB to fallthrough block.
 961     // Record it for branch lengthening; this new branch will not get out of
 962     // range, but if the preceding conditional branch is out of range, the
 963     // targets will be exchanged, and the altered branch may be out of
 964     // range, so the machinery has to know about it.
 965     int UncondBr = isThumb ? ((isThumb2) ? ARM::t2B : ARM::tB) : ARM::B;
 966     BuildMI(UserMBB, DebugLoc::getUnknownLoc(),
 967             TII->get(UncondBr)).addMBB(*NewMBB);
 968     unsigned MaxDisp = getUnconditionalBrDisp(UncondBr);
 969     ImmBranches.push_back(ImmBranch(&UserMBB->back(),
 970                           MaxDisp, false, UncondBr));
 971     int delta = isThumb ? 2 : 4;
 972     BBSizes[UserMBB->getNumber()] += delta;
 973     AdjustBBOffsetsAfter(UserMBB, delta);
 974   } else {
 975     // What a big block.  Find a place within the block to split it.
 976     // This is a little tricky on Thumb since instructions are 2 bytes
 977     // and constant pool entries are 4 bytes: if instruction I references
 978     // island CPE, and instruction I+1 references CPE', it will
 979     // not work well to put CPE as far forward as possible, since then
 980     // CPE' cannot immediately follow it (that location is 2 bytes
 981     // farther away from I+1 than CPE was from I) and we'd need to create
 982     // a new island.  So, we make a first guess, then walk through the
 983     // instructions between the one currently being looked at and the
 984     // possible insertion point, and make sure any other instructions
 985     // that reference CPEs will be able to use the same island area;
 986     // if not, we back up the insertion point.
 987
 988     // The 4 in the following is for the unconditional branch we'll be
 989     // inserting (allows for long branch on Thumb).  Alignment of the
 990     // island is handled inside OffsetIsInRange.
 991     unsigned BaseInsertOffset = UserOffset + U.MaxDisp -4;
 992     // This could point off the end of the block if we've already got
 993     // constant pool entries following this block; only the last one is
 994     // in the water list.  Back past any possible branches (allow for a
 995     // conditional and a maximally long unconditional).
 996     if (BaseInsertOffset >= BBOffsets[UserMBB->getNumber()+1])
 997       BaseInsertOffset = BBOffsets[UserMBB->getNumber()+1] -
 998                               (isThumb ? 6 : 8);
 999     unsigned EndInsertOffset = BaseInsertOffset +
1000            CPEMI->getOperand(2).getImm();
1001     MachineBasicBlock::iterator MI = UserMI;
1002     ++MI;
1003     unsigned CPUIndex = CPUserIndex+1;
1004     for (unsigned Offset = UserOffset+TII->GetInstSizeInBytes(UserMI);
1005          Offset < BaseInsertOffset;
1006          Offset += TII->GetInstSizeInBytes(MI),
1007             MI = next(MI)) {
1008       if (CPUIndex < CPUsers.size() && CPUsers[CPUIndex].MI == MI) {
1009         if (!OffsetIsInRange(Offset, EndInsertOffset,
1010               CPUsers[CPUIndex].MaxDisp, !isThumb)) {
1011           BaseInsertOffset -= (isThumb ? 2 : 4);
1012           EndInsertOffset -= (isThumb ? 2 : 4);
1013         }
1014         // This is overly conservative, as we don't account for CPEMIs
1015         // being reused within the block, but it doesn't matter much.
1016         EndInsertOffset += CPUsers[CPUIndex].CPEMI->getOperand(2).getImm();
1017         CPUIndex++;
1018       }
1019     }
1020     DOUT << "Split in middle of big block\n";
1021     *NewMBB = SplitBlockBeforeInstr(prior(MI));
1022   }
1023 }
1024
1025 /// HandleConstantPoolUser - Analyze the specified user, checking to see if it
1026 /// is out-of-range.  If so, pick up the constant pool value and move it some
1027 /// place in-range.  Return true if we changed any addresses (thus must run
1028 /// another pass of branch lengthening), false otherwise.
1029 bool ARMConstantIslands::HandleConstantPoolUser(MachineFunction &Fn,
1030                                                 unsigned CPUserIndex) {
1031   CPUser &U = CPUsers[CPUserIndex];
1032   MachineInstr *UserMI = U.MI;
1033   MachineInstr *CPEMI  = U.CPEMI;
1034   unsigned CPI = CPEMI->getOperand(1).getIndex();
1035   unsigned Size = CPEMI->getOperand(2).getImm();
1036   MachineBasicBlock *NewMBB;
1037   // Compute this only once, it's expensive.  The 4 or 8 is the value the
1038   // hardware keeps in the PC (2 insns ahead of the reference).
1039   unsigned UserOffset = GetOffsetOf(UserMI) + (isThumb ? 4 : 8);
1040
1041   // Special case: tLEApcrel are two instructions MI's. The actual user is the
1042   // second instruction.
1043   if (UserMI->getOpcode() == ARM::tLEApcrel)
1044     UserOffset += 2;
1045
1046   // See if the current entry is within range, or there is a clone of it
1047   // in range.
1048   int result = LookForExistingCPEntry(U, UserOffset);
1049   if (result==1) return false;
1050   else if (result==2) return true;
1051
1052   // No existing clone of this CPE is within range.
1053   // We will be generating a new clone.  Get a UID for it.
1054   unsigned ID = AFI->createConstPoolEntryUId();
1055
1056   // Look for water where we can place this CPE.  We look for the farthest one
1057   // away that will work.  Forward references only for now (although later
1058   // we might find some that are backwards).
1059
1060   if (!LookForWater(U, UserOffset, &NewMBB)) {
1061     // No water found.
1062     DOUT << "No water found\n";
1063     CreateNewWater(CPUserIndex, UserOffset, &NewMBB);
1064   }
1065
1066   // Okay, we know we can put an island before NewMBB now, do it!
1067   MachineBasicBlock *NewIsland = Fn.CreateMachineBasicBlock();
1068   Fn.insert(NewMBB, NewIsland);
1069
1070   // Update internal data structures to account for the newly inserted MBB.
1071   UpdateForInsertedWaterBlock(NewIsland);
1072
1073   // Decrement the old entry, and remove it if refcount becomes 0.
1074   DecrementOldEntry(CPI, CPEMI);
1075
1076   // Now that we have an island to add the CPE to, clone the original CPE and
1077   // add it to the island.
1078   U.CPEMI = BuildMI(NewIsland, DebugLoc::getUnknownLoc(),
1079                     TII->get(ARM::CONSTPOOL_ENTRY))
1080                 .addImm(ID).addConstantPoolIndex(CPI).addImm(Size);
1081   CPEntries[CPI].push_back(CPEntry(U.CPEMI, ID, 1));
1082   NumCPEs++;
1083
1084   BBOffsets[NewIsland->getNumber()] = BBOffsets[NewMBB->getNumber()];
1085   // Compensate for .align 2 in thumb mode.
1086   if (isThumb && BBOffsets[NewIsland->getNumber()]%4 != 0)
1087     Size += 2;
1088   // Increase the size of the island block to account for the new entry.
1089   BBSizes[NewIsland->getNumber()] += Size;
1090   AdjustBBOffsetsAfter(NewIsland, Size);
1091
1092   // Finally, change the CPI in the instruction operand to be ID.
1093   for (unsigned i = 0, e = UserMI->getNumOperands(); i != e; ++i)
1094     if (UserMI->getOperand(i).isCPI()) {
1095       UserMI->getOperand(i).setIndex(ID);
1096       break;
1097     }
1098
1099   DOUT << "  Moved CPE to #" << ID << " CPI=" << CPI << "\t" << *UserMI;
1100
1101   return true;
1102 }
1103
1104 /// RemoveDeadCPEMI - Remove a dead constant pool entry instruction. Update
1105 /// sizes and offsets of impacted basic blocks.
1106 void ARMConstantIslands::RemoveDeadCPEMI(MachineInstr *CPEMI) {
1107   MachineBasicBlock *CPEBB = CPEMI->getParent();
1108   unsigned Size = CPEMI->getOperand(2).getImm();
1109   CPEMI->eraseFromParent();
1110   BBSizes[CPEBB->getNumber()] -= Size;
1111   // All succeeding offsets have the current size value added in, fix this.
1112   if (CPEBB->empty()) {
1113     // In thumb mode, the size of island may be  padded by two to compensate for
1114     // the alignment requirement.  Then it will now be 2 when the block is
1115     // empty, so fix this.
1116     // All succeeding offsets have the current size value added in, fix this.
1117     if (BBSizes[CPEBB->getNumber()] != 0) {
1118       Size += BBSizes[CPEBB->getNumber()];
1119       BBSizes[CPEBB->getNumber()] = 0;
1120     }
1121   }
1122   AdjustBBOffsetsAfter(CPEBB, -Size);
1123   // An island has only one predecessor BB and one successor BB. Check if
1124   // this BB's predecessor jumps directly to this BB's successor. This
1125   // shouldn't happen currently.
1126   assert(!BBIsJumpedOver(CPEBB) && "How did this happen?");
1127   // FIXME: remove the empty blocks after all the work is done?
1128 }
1129
1130 /// RemoveUnusedCPEntries - Remove constant pool entries whose refcounts
1131 /// are zero.
1132 bool ARMConstantIslands::RemoveUnusedCPEntries() {
1133   unsigned MadeChange = false;
1134   for (unsigned i = 0, e = CPEntries.size(); i != e; ++i) {
1135       std::vector<CPEntry> &CPEs = CPEntries[i];
1136       for (unsigned j = 0, ee = CPEs.size(); j != ee; ++j) {
1137         if (CPEs[j].RefCount == 0 && CPEs[j].CPEMI) {
1138           RemoveDeadCPEMI(CPEs[j].CPEMI);
1139           CPEs[j].CPEMI = NULL;
1140           MadeChange = true;
1141         }
1142       }
1143   }
1144   return MadeChange;
1145 }
1146
1147 /// BBIsInRange - Returns true if the distance between specific MI and
1148 /// specific BB can fit in MI's displacement field.
1149 bool ARMConstantIslands::BBIsInRange(MachineInstr *MI,MachineBasicBlock *DestBB,
1150                                      unsigned MaxDisp) {
1151   unsigned PCAdj      = isThumb ? 4 : 8;
1152   unsigned BrOffset   = GetOffsetOf(MI) + PCAdj;
1153   unsigned DestOffset = BBOffsets[DestBB->getNumber()];
1154
1155   DOUT << "Branch of destination BB#" << DestBB->getNumber()
1156        << " from BB#" << MI->getParent()->getNumber()
1157        << " max delta=" << MaxDisp
1158        << " from " << GetOffsetOf(MI) << " to " << DestOffset
1159        << " offset " << int(DestOffset-BrOffset) << "\t" << *MI;
1160
1161   if (BrOffset <= DestOffset) {
1162     // Branch before the Dest.
1163     if (DestOffset-BrOffset <= MaxDisp)
1164       return true;
1165   } else {
1166     if (BrOffset-DestOffset <= MaxDisp)
1167       return true;
1168   }
1169   return false;
1170 }
1171
1172 /// FixUpImmediateBr - Fix up an immediate branch whose destination is too far
1173 /// away to fit in its displacement field.
1174 bool ARMConstantIslands::FixUpImmediateBr(MachineFunction &Fn, ImmBranch &Br) {
1175   MachineInstr *MI = Br.MI;
1176   MachineBasicBlock *DestBB = MI->getOperand(0).getMBB();
1177
1178   // Check to see if the DestBB is already in-range.
1179   if (BBIsInRange(MI, DestBB, Br.MaxDisp))
1180     return false;
1181
1182   if (!Br.isCond)
1183     return FixUpUnconditionalBr(Fn, Br);
1184   return FixUpConditionalBr(Fn, Br);
1185 }
1186
1187 /// FixUpUnconditionalBr - Fix up an unconditional branch whose destination is
1188 /// too far away to fit in its displacement field. If the LR register has been
1189 /// spilled in the epilogue, then we can use BL to implement a far jump.
1190 /// Otherwise, add an intermediate branch instruction to a branch.
1191 bool
1192 ARMConstantIslands::FixUpUnconditionalBr(MachineFunction &Fn, ImmBranch &Br) {
1193   MachineInstr *MI = Br.MI;
1194   MachineBasicBlock *MBB = MI->getParent();
1195   assert(isThumb && !isThumb2 && "Expected a Thumb-1 function!");
1196
1197   // Use BL to implement far jump.
1198   Br.MaxDisp = (1 << 21) * 2;
1199   MI->setDesc(TII->get(ARM::tBfar));
1200   BBSizes[MBB->getNumber()] += 2;
1201   AdjustBBOffsetsAfter(MBB, 2);
1202   HasFarJump = true;
1203   NumUBrFixed++;
1204
1205   DOUT << "  Changed B to long jump " << *MI;
1206
1207   return true;
1208 }
1209
1210 /// FixUpConditionalBr - Fix up a conditional branch whose destination is too
1211 /// far away to fit in its displacement field. It is converted to an inverse
1212 /// conditional branch + an unconditional branch to the destination.
1213 bool
1214 ARMConstantIslands::FixUpConditionalBr(MachineFunction &Fn, ImmBranch &Br) {
1215   MachineInstr *MI = Br.MI;
1216   MachineBasicBlock *DestBB = MI->getOperand(0).getMBB();
1217
1218   // Add an unconditional branch to the destination and invert the branch
1219   // condition to jump over it:
1220   // blt L1
1221   // =>
1222   // bge L2
1223   // b   L1
1224   // L2:
1225   ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(1).getImm();
1226   CC = ARMCC::getOppositeCondition(CC);
1227   unsigned CCReg = MI->getOperand(2).getReg();
1228
1229   // If the branch is at the end of its MBB and that has a fall-through block,
1230   // direct the updated conditional branch to the fall-through block. Otherwise,
1231   // split the MBB before the next instruction.
1232   MachineBasicBlock *MBB = MI->getParent();
1233   MachineInstr *BMI = &MBB->back();
1234   bool NeedSplit = (BMI != MI) || !BBHasFallthrough(MBB);
1235
1236   NumCBrFixed++;
1237   if (BMI != MI) {
1238     if (next(MachineBasicBlock::iterator(MI)) == prior(MBB->end()) &&
1239         BMI->getOpcode() == Br.UncondBr) {
1240       // Last MI in the BB is an unconditional branch. Can we simply invert the
1241       // condition and swap destinations:
1242       // beq L1
1243       // b   L2
1244       // =>
1245       // bne L2
1246       // b   L1
1247       MachineBasicBlock *NewDest = BMI->getOperand(0).getMBB();
1248       if (BBIsInRange(MI, NewDest, Br.MaxDisp)) {
1249         DOUT << "  Invert Bcc condition and swap its destination with " << *BMI;
1250         BMI->getOperand(0).setMBB(DestBB);
1251         MI->getOperand(0).setMBB(NewDest);
1252         MI->getOperand(1).setImm(CC);
1253         return true;
1254       }
1255     }
1256   }
1257
1258   if (NeedSplit) {
1259     SplitBlockBeforeInstr(MI);
1260     // No need for the branch to the next block. We're adding an unconditional
1261     // branch to the destination.
1262     int delta = TII->GetInstSizeInBytes(&MBB->back());
1263     BBSizes[MBB->getNumber()] -= delta;
1264     MachineBasicBlock* SplitBB = next(MachineFunction::iterator(MBB));
1265     AdjustBBOffsetsAfter(SplitBB, -delta);
1266     MBB->back().eraseFromParent();
1267     // BBOffsets[SplitBB] is wrong temporarily, fixed below
1268   }
1269   MachineBasicBlock *NextBB = next(MachineFunction::iterator(MBB));
1270
1271   DOUT << "  Insert B to BB#" << DestBB->getNumber()
1272        << " also invert condition and change dest. to BB#"
1273        << NextBB->getNumber() << "\n";
1274
1275   // Insert a new conditional branch and a new unconditional branch.
1276   // Also update the ImmBranch as well as adding a new entry for the new branch.
1277   BuildMI(MBB, DebugLoc::getUnknownLoc(),
1278           TII->get(MI->getOpcode()))
1279     .addMBB(NextBB).addImm(CC).addReg(CCReg);
1280   Br.MI = &MBB->back();
1281   BBSizes[MBB->getNumber()] += TII->GetInstSizeInBytes(&MBB->back());
1282   BuildMI(MBB, DebugLoc::getUnknownLoc(), TII->get(Br.UncondBr)).addMBB(DestBB);
1283   BBSizes[MBB->getNumber()] += TII->GetInstSizeInBytes(&MBB->back());
1284   unsigned MaxDisp = getUnconditionalBrDisp(Br.UncondBr);
1285   ImmBranches.push_back(ImmBranch(&MBB->back(), MaxDisp, false, Br.UncondBr));
1286
1287   // Remove the old conditional branch.  It may or may not still be in MBB.
1288   BBSizes[MI->getParent()->getNumber()] -= TII->GetInstSizeInBytes(MI);
1289   MI->eraseFromParent();
1290
1291   // The net size change is an addition of one unconditional branch.
1292   int delta = TII->GetInstSizeInBytes(&MBB->back());
1293   AdjustBBOffsetsAfter(MBB, delta);
1294   return true;
1295 }
1296
1297 /// UndoLRSpillRestore - Remove Thumb push / pop instructions that only spills
1298 /// LR / restores LR to pc.
1299 bool ARMConstantIslands::UndoLRSpillRestore() {
1300   bool MadeChange = false;
1301   for (unsigned i = 0, e = PushPopMIs.size(); i != e; ++i) {
1302     MachineInstr *MI = PushPopMIs[i];
1303     if (MI->getOpcode() == ARM::tPOP_RET &&
1304         MI->getOperand(0).getReg() == ARM::PC &&
1305         MI->getNumExplicitOperands() == 1) {
1306       BuildMI(MI->getParent(), MI->getDebugLoc(), TII->get(ARM::tBX_RET));
1307       MI->eraseFromParent();
1308       MadeChange = true;
1309     }
1310   }
1311   return MadeChange;
1312 }