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 "ARMAddressingModes.h"
  19 #include "ARMMachineFunctionInfo.h"
  20 #include "ARMInstrInfo.h"
  21 #include "llvm/CodeGen/MachineConstantPool.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/CodeGen/MachineInstrBuilder.h"
  24 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  25 #include "llvm/Target/TargetData.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/ADT/SmallSet.h"
  31 #include "llvm/ADT/SmallVector.h"
  32 #include "llvm/ADT/STLExtras.h"
  33 #include "llvm/ADT/Statistic.h"
  34 #include "llvm/Support/CommandLine.h"
  35 #include <algorithm>
  36 using namespace llvm;
  37
  38 STATISTIC(NumCPEs,       "Number of constpool entries");
  39 STATISTIC(NumSplit,      "Number of uncond branches inserted");
  40 STATISTIC(NumCBrFixed,   "Number of cond branches fixed");
  41 STATISTIC(NumUBrFixed,   "Number of uncond branches fixed");
  42 STATISTIC(NumTBs,        "Number of table branches generated");
  43 STATISTIC(NumT2CPShrunk, "Number of Thumb2 constantpool instructions shrunk");
  44 STATISTIC(NumT2BrShrunk, "Number of Thumb2 immediate branches shrunk");
  45 STATISTIC(NumCBZ,        "Number of CBZ / CBNZ formed");
  46 STATISTIC(NumJTMoved,    "Number of jump table destination blocks moved");
  47 STATISTIC(NumJTInserted, "Number of jump table intermediate blocks inserted");
  48
  49
  50 static cl::opt<bool>
  51 AdjustJumpTableBlocks("arm-adjust-jump-tables", cl::Hidden, cl::init(true),
  52           cl::desc("Adjust basic block layout to better use TB[BH]"));
  53
  54 namespace {
  55   /// ARMConstantIslands - Due to limited PC-relative displacements, ARM
  56   /// requires constant pool entries to be scattered among the instructions
  57   /// inside a function.  To do this, it completely ignores the normal LLVM
  58   /// constant pool; instead, it places constants wherever it feels like with
  59   /// special instructions.
  60   ///
  61   /// The terminology used in this pass includes:
  62   ///   Islands - Clumps of constants placed in the function.
  63   ///   Water   - Potential places where an island could be formed.
  64   ///   CPE     - A constant pool entry that has been placed somewhere, which
  65   ///             tracks a list of users.
  66   class ARMConstantIslands : public MachineFunctionPass {
  67     /// BBSizes - The size of each MachineBasicBlock in bytes of code, indexed
  68     /// by MBB Number.  The two-byte pads required for Thumb alignment are
  69     /// counted as part of the following block (i.e., the offset and size for
  70     /// a padded block will both be ==2 mod 4).
  71     std::vector<unsigned> BBSizes;
  72
  73     /// BBOffsets - the offset of each MBB in bytes, starting from 0.
  74     /// The two-byte pads required for Thumb alignment are counted as part of
  75     /// the following block.
  76     std::vector<unsigned> BBOffsets;
  77
  78     /// WaterList - A sorted list of basic blocks where islands could be placed
  79     /// (i.e. blocks that don't fall through to the following block, due
  80     /// to a return, unreachable, or unconditional branch).
  81     std::vector<MachineBasicBlock*> WaterList;
  82
  83     /// NewWaterList - The subset of WaterList that was created since the
  84     /// previous iteration by inserting unconditional branches.
  85     SmallSet<MachineBasicBlock*, 4> NewWaterList;
  86
  87     typedef std::vector<MachineBasicBlock*>::iterator water_iterator;
  88
  89     /// CPUser - One user of a constant pool, keeping the machine instruction
  90     /// pointer, the constant pool being referenced, and the max displacement
  91     /// allowed from the instruction to the CP.  The HighWaterMark records the
  92     /// highest basic block where a new CPEntry can be placed.  To ensure this
  93     /// pass terminates, the CP entries are initially placed at the end of the
  94     /// function and then move monotonically to lower addresses.  The
  95     /// exception to this rule is when the current CP entry for a particular
  96     /// CPUser is out of range, but there is another CP entry for the same
  97     /// constant value in range.  We want to use the existing in-range CP
  98     /// entry, but if it later moves out of range, the search for new water
  99     /// should resume where it left off.  The HighWaterMark is used to record
 100     /// that point.
 101     struct CPUser {
 102       MachineInstr *MI;
 103       MachineInstr *CPEMI;
 104       MachineBasicBlock *HighWaterMark;
 105       unsigned MaxDisp;
 106       bool NegOk;
 107       bool IsSoImm;
 108       CPUser(MachineInstr *mi, MachineInstr *cpemi, unsigned maxdisp,
 109              bool neg, bool soimm)
 110         : MI(mi), CPEMI(cpemi), MaxDisp(maxdisp), NegOk(neg), IsSoImm(soimm) {
 111         HighWaterMark = CPEMI->getParent();
 112       }
 113     };
 114
 115     /// CPUsers - Keep track of all of the machine instructions that use various
 116     /// constant pools and their max displacement.
 117     std::vector<CPUser> CPUsers;
 118
 119     /// CPEntry - One per constant pool entry, keeping the machine instruction
 120     /// pointer, the constpool index, and the number of CPUser's which
 121     /// reference this entry.
 122     struct CPEntry {
 123       MachineInstr *CPEMI;
 124       unsigned CPI;
 125       unsigned RefCount;
 126       CPEntry(MachineInstr *cpemi, unsigned cpi, unsigned rc = 0)
 127         : CPEMI(cpemi), CPI(cpi), RefCount(rc) {}
 128     };
 129
 130     /// CPEntries - Keep track of all of the constant pool entry machine
 131     /// instructions. For each original constpool index (i.e. those that
 132     /// existed upon entry to this pass), it keeps a vector of entries.
 133     /// Original elements are cloned as we go along; the clones are
 134     /// put in the vector of the original element, but have distinct CPIs.
 135     std::vector<std::vector<CPEntry> > CPEntries;
 136
 137     /// ImmBranch - One per immediate branch, keeping the machine instruction
 138     /// pointer, conditional or unconditional, the max displacement,
 139     /// and (if isCond is true) the corresponding unconditional branch
 140     /// opcode.
 141     struct ImmBranch {
 142       MachineInstr *MI;
 143       unsigned MaxDisp : 31;
 144       bool isCond : 1;
 145       int UncondBr;
 146       ImmBranch(MachineInstr *mi, unsigned maxdisp, bool cond, int ubr)
 147         : MI(mi), MaxDisp(maxdisp), isCond(cond), UncondBr(ubr) {}
 148     };
 149
 150     /// ImmBranches - Keep track of all the immediate branch instructions.
 151     ///
 152     std::vector<ImmBranch> ImmBranches;
 153
 154     /// PushPopMIs - Keep track of all the Thumb push / pop instructions.
 155     ///
 156     SmallVector<MachineInstr*, 4> PushPopMIs;
 157
 158     /// T2JumpTables - Keep track of all the Thumb2 jumptable instructions.
 159     SmallVector<MachineInstr*, 4> T2JumpTables;
 160
 161     /// HasFarJump - True if any far jump instruction has been emitted during
 162     /// the branch fix up pass.
 163     bool HasFarJump;
 164
 165     /// HasInlineAsm - True if the function contains inline assembly.
 166     bool HasInlineAsm;
 167
 168     const TargetInstrInfo *TII;
 169     const ARMSubtarget *STI;
 170     ARMFunctionInfo *AFI;
 171     bool isThumb;
 172     bool isThumb1;
 173     bool isThumb2;
 174   public:
 175     static char ID;
 176     ARMConstantIslands() : MachineFunctionPass(&ID) {}
 177
 178     virtual bool runOnMachineFunction(MachineFunction &MF);
 179
 180     virtual const char *getPassName() const {
 181       return "ARM constant island placement and branch shortening pass";
 182     }
 183
 184   private:
 185     void DoInitialPlacement(MachineFunction &MF,
 186                             std::vector<MachineInstr*> &CPEMIs);
 187     CPEntry *findConstPoolEntry(unsigned CPI, const MachineInstr *CPEMI);
 188     void JumpTableFunctionScan(MachineFunction &MF);
 189     void InitialFunctionScan(MachineFunction &MF,
 190                              const std::vector<MachineInstr*> &CPEMIs);
 191     MachineBasicBlock *SplitBlockBeforeInstr(MachineInstr *MI);
 192     void UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB);
 193     void AdjustBBOffsetsAfter(MachineBasicBlock *BB, int delta);
 194     bool DecrementOldEntry(unsigned CPI, MachineInstr* CPEMI);
 195     int LookForExistingCPEntry(CPUser& U, unsigned UserOffset);
 196     bool LookForWater(CPUser&U, unsigned UserOffset, water_iterator &WaterIter);
 197     void CreateNewWater(unsigned CPUserIndex, unsigned UserOffset,
 198                         MachineBasicBlock *&NewMBB);
 199     bool HandleConstantPoolUser(MachineFunction &MF, unsigned CPUserIndex);
 200     void RemoveDeadCPEMI(MachineInstr *CPEMI);
 201     bool RemoveUnusedCPEntries();
 202     bool CPEIsInRange(MachineInstr *MI, unsigned UserOffset,
 203                       MachineInstr *CPEMI, unsigned Disp, bool NegOk,
 204                       bool DoDump = false);
 205     bool WaterIsInRange(unsigned UserOffset, MachineBasicBlock *Water,
 206                         CPUser &U);
 207     bool OffsetIsInRange(unsigned UserOffset, unsigned TrialOffset,
 208                          unsigned Disp, bool NegativeOK, bool IsSoImm = false);
 209     bool BBIsInRange(MachineInstr *MI, MachineBasicBlock *BB, unsigned Disp);
 210     bool FixUpImmediateBr(MachineFunction &MF, ImmBranch &Br);
 211     bool FixUpConditionalBr(MachineFunction &MF, ImmBranch &Br);
 212     bool FixUpUnconditionalBr(MachineFunction &MF, ImmBranch &Br);
 213     bool UndoLRSpillRestore();
 214     bool OptimizeThumb2Instructions(MachineFunction &MF);
 215     bool OptimizeThumb2Branches(MachineFunction &MF);
 216     bool ReorderThumb2JumpTables(MachineFunction &MF);
 217     bool OptimizeThumb2JumpTables(MachineFunction &MF);
 218     MachineBasicBlock *AdjustJTTargetBlockForward(MachineBasicBlock *BB,
 219                                                   MachineBasicBlock *JTBB);
 220
 221     unsigned GetOffsetOf(MachineInstr *MI) const;
 222     void dumpBBs();
 223     void verify(MachineFunction &MF);
 224   };
 225   char ARMConstantIslands::ID = 0;
 226 }
 227
 228 /// verify - check BBOffsets, BBSizes, alignment of islands
 229 void ARMConstantIslands::verify(MachineFunction &MF) {
 230   assert(BBOffsets.size() == BBSizes.size());
 231   for (unsigned i = 1, e = BBOffsets.size(); i != e; ++i)
 232     assert(BBOffsets[i-1]+BBSizes[i-1] == BBOffsets[i]);
 233   if (!isThumb)
 234     return;
 235 #ifndef NDEBUG
 236   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
 237        MBBI != E; ++MBBI) {
 238     MachineBasicBlock *MBB = MBBI;
 239     if (!MBB->empty() &&
 240         MBB->begin()->getOpcode() == ARM::CONSTPOOL_ENTRY) {
 241       unsigned MBBId = MBB->getNumber();
 242       assert(HasInlineAsm ||
 243              (BBOffsets[MBBId]%4 == 0 && BBSizes[MBBId]%4 == 0) ||
 244              (BBOffsets[MBBId]%4 != 0 && BBSizes[MBBId]%4 != 0));
 245     }
 246   }
 247   for (unsigned i = 0, e = CPUsers.size(); i != e; ++i) {
 248     CPUser &U = CPUsers[i];
 249     unsigned UserOffset = GetOffsetOf(U.MI) + (isThumb ? 4 : 8);
 250     unsigned CPEOffset  = GetOffsetOf(U.CPEMI);
 251     unsigned Disp = UserOffset < CPEOffset ? CPEOffset - UserOffset :
 252       UserOffset - CPEOffset;
 253     assert(Disp <= U.MaxDisp || "Constant pool entry out of range!");
 254   }
 255 #endif
 256 }
 257
 258 /// print block size and offset information - debugging
 259 void ARMConstantIslands::dumpBBs() {
 260   for (unsigned J = 0, E = BBOffsets.size(); J !=E; ++J) {
 261     DEBUG(errs() << "block " << J << " offset " << BBOffsets[J]
 262                  << " size " << BBSizes[J] << "\n");
 263   }
 264 }
 265
 266 /// createARMConstantIslandPass - returns an instance of the constpool
 267 /// island pass.
 268 FunctionPass *llvm::createARMConstantIslandPass() {
 269   return new ARMConstantIslands();
 270 }
 271
 272 bool ARMConstantIslands::runOnMachineFunction(MachineFunction &MF) {
 273   MachineConstantPool &MCP = *MF.getConstantPool();
 274
 275   TII = MF.getTarget().getInstrInfo();
 276   AFI = MF.getInfo<ARMFunctionInfo>();
 277   STI = &MF.getTarget().getSubtarget<ARMSubtarget>();
 278
 279   isThumb = AFI->isThumbFunction();
 280   isThumb1 = AFI->isThumb1OnlyFunction();
 281   isThumb2 = AFI->isThumb2Function();
 282
 283   HasFarJump = false;
 284   HasInlineAsm = false;
 285
 286   // Renumber all of the machine basic blocks in the function, guaranteeing that
 287   // the numbers agree with the position of the block in the function.
 288   MF.RenumberBlocks();
 289
 290   // Try to reorder and otherwise adjust the block layout to make good use
 291   // of the TB[BH] instructions.
 292   bool MadeChange = false;
 293   if (isThumb2 && AdjustJumpTableBlocks) {
 294     JumpTableFunctionScan(MF);
 295     MadeChange |= ReorderThumb2JumpTables(MF);
 296     // Data is out of date, so clear it. It'll be re-computed later.
 297     T2JumpTables.clear();
 298     // Blocks may have shifted around. Keep the numbering up to date.
 299     MF.RenumberBlocks();
 300   }
 301
 302   // Thumb1 functions containing constant pools get 4-byte alignment.
 303   // This is so we can keep exact track of where the alignment padding goes.
 304
 305   // ARM and Thumb2 functions need to be 4-byte aligned.
 306   if (!isThumb1)
 307     MF.EnsureAlignment(2);  // 2 = log2(4)
 308
 309   // Perform the initial placement of the constant pool entries.  To start with,
 310   // we put them all at the end of the function.
 311   std::vector<MachineInstr*> CPEMIs;
 312   if (!MCP.isEmpty()) {
 313     DoInitialPlacement(MF, CPEMIs);
 314     if (isThumb1)
 315       MF.EnsureAlignment(2);  // 2 = log2(4)
 316   }
 317
 318   /// The next UID to take is the first unused one.
 319   AFI->initConstPoolEntryUId(CPEMIs.size());
 320
 321   // Do the initial scan of the function, building up information about the
 322   // sizes of each block, the location of all the water, and finding all of the
 323   // constant pool users.
 324   InitialFunctionScan(MF, CPEMIs);
 325   CPEMIs.clear();
 326
 327   /// Remove dead constant pool entries.
 328   RemoveUnusedCPEntries();
 329
 330   // Iteratively place constant pool entries and fix up branches until there
 331   // is no change.
 332   unsigned NoCPIters = 0, NoBRIters = 0;
 333   while (true) {
 334     bool CPChange = false;
 335     for (unsigned i = 0, e = CPUsers.size(); i != e; ++i)
 336       CPChange |= HandleConstantPoolUser(MF, i);
 337     if (CPChange && ++NoCPIters > 30)
 338       llvm_unreachable("Constant Island pass failed to converge!");
 339     DEBUG(dumpBBs());
 340
 341     // Clear NewWaterList now.  If we split a block for branches, it should
 342     // appear as "new water" for the next iteration of constant pool placement.
 343     NewWaterList.clear();
 344
 345     bool BRChange = false;
 346     for (unsigned i = 0, e = ImmBranches.size(); i != e; ++i)
 347       BRChange |= FixUpImmediateBr(MF, ImmBranches[i]);
 348     if (BRChange && ++NoBRIters > 30)
 349       llvm_unreachable("Branch Fix Up pass failed to converge!");
 350     DEBUG(dumpBBs());
 351
 352     if (!CPChange && !BRChange)
 353       break;
 354     MadeChange = true;
 355   }
 356
 357   // Shrink 32-bit Thumb2 branch, load, and store instructions.
 358   if (isThumb2)
 359     MadeChange |= OptimizeThumb2Instructions(MF);
 360
 361   // After a while, this might be made debug-only, but it is not expensive.
 362   verify(MF);
 363
 364   // If LR has been forced spilled and no far jumps (i.e. BL) has been issued.
 365   // Undo the spill / restore of LR if possible.
 366   if (isThumb && !HasFarJump && AFI->isLRSpilledForFarJump())
 367     MadeChange |= UndoLRSpillRestore();
 368
 369   BBSizes.clear();
 370   BBOffsets.clear();
 371   WaterList.clear();
 372   CPUsers.clear();
 373   CPEntries.clear();
 374   ImmBranches.clear();
 375   PushPopMIs.clear();
 376   T2JumpTables.clear();
 377
 378   return MadeChange;
 379 }
 380
 381 /// DoInitialPlacement - Perform the initial placement of the constant pool
 382 /// entries.  To start with, we put them all at the end of the function.
 383 void ARMConstantIslands::DoInitialPlacement(MachineFunction &MF,
 384                                         std::vector<MachineInstr*> &CPEMIs) {
 385   // Create the basic block to hold the CPE's.
 386   MachineBasicBlock *BB = MF.CreateMachineBasicBlock();
 387   MF.push_back(BB);
 388
 389   // Add all of the constants from the constant pool to the end block, use an
 390   // identity mapping of CPI's to CPE's.
 391   const std::vector<MachineConstantPoolEntry> &CPs =
 392     MF.getConstantPool()->getConstants();
 393
 394   const TargetData &TD = *MF.getTarget().getTargetData();
 395   for (unsigned i = 0, e = CPs.size(); i != e; ++i) {
 396     unsigned Size = TD.getTypeAllocSize(CPs[i].getType());
 397     // Verify that all constant pool entries are a multiple of 4 bytes.  If not,
 398     // we would have to pad them out or something so that instructions stay
 399     // aligned.
 400     assert((Size & 3) == 0 && "CP Entry not multiple of 4 bytes!");
 401     MachineInstr *CPEMI =
 402       BuildMI(BB, DebugLoc(), TII->get(ARM::CONSTPOOL_ENTRY))
 403         .addImm(i).addConstantPoolIndex(i).addImm(Size);
 404     CPEMIs.push_back(CPEMI);
 405
 406     // Add a new CPEntry, but no corresponding CPUser yet.
 407     std::vector<CPEntry> CPEs;
 408     CPEs.push_back(CPEntry(CPEMI, i));
 409     CPEntries.push_back(CPEs);
 410     NumCPEs++;
 411     DEBUG(errs() << "Moved CPI#" << i << " to end of function as #" << i
 412                  << "\n");
 413   }
 414 }
 415
 416 /// BBHasFallthrough - Return true if the specified basic block can fallthrough
 417 /// into the block immediately after it.
 418 static bool BBHasFallthrough(MachineBasicBlock *MBB) {
 419   // Get the next machine basic block in the function.
 420   MachineFunction::iterator MBBI = MBB;
 421   if (llvm::next(MBBI) == MBB->getParent()->end())  // Can't fall off end of function.
 422     return false;
 423
 424   MachineBasicBlock *NextBB = llvm::next(MBBI);
 425   for (MachineBasicBlock::succ_iterator I = MBB->succ_begin(),
 426        E = MBB->succ_end(); I != E; ++I)
 427     if (*I == NextBB)
 428       return true;
 429
 430   return false;
 431 }
 432
 433 /// findConstPoolEntry - Given the constpool index and CONSTPOOL_ENTRY MI,
 434 /// look up the corresponding CPEntry.
 435 ARMConstantIslands::CPEntry
 436 *ARMConstantIslands::findConstPoolEntry(unsigned CPI,
 437                                         const MachineInstr *CPEMI) {
 438   std::vector<CPEntry> &CPEs = CPEntries[CPI];
 439   // Number of entries per constpool index should be small, just do a
 440   // linear search.
 441   for (unsigned i = 0, e = CPEs.size(); i != e; ++i) {
 442     if (CPEs[i].CPEMI == CPEMI)
 443       return &CPEs[i];
 444   }
 445   return NULL;
 446 }
 447
 448 /// JumpTableFunctionScan - Do a scan of the function, building up
 449 /// information about the sizes of each block and the locations of all
 450 /// the jump tables.
 451 void ARMConstantIslands::JumpTableFunctionScan(MachineFunction &MF) {
 452   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
 453        MBBI != E; ++MBBI) {
 454     MachineBasicBlock &MBB = *MBBI;
 455
 456     for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
 457          I != E; ++I)
 458       if (I->getDesc().isBranch() && I->getOpcode() == ARM::t2BR_JT)
 459         T2JumpTables.push_back(I);
 460   }
 461 }
 462
 463 /// InitialFunctionScan - Do the initial scan of the function, building up
 464 /// information about the sizes of each block, the location of all the water,
 465 /// and finding all of the constant pool users.
 466 void ARMConstantIslands::InitialFunctionScan(MachineFunction &MF,
 467                                  const std::vector<MachineInstr*> &CPEMIs) {
 468   // First thing, see if the function has any inline assembly in it. If so,
 469   // we have to be conservative about alignment assumptions, as we don't
 470   // know for sure the size of any instructions in the inline assembly.
 471   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
 472        MBBI != E; ++MBBI) {
 473     MachineBasicBlock &MBB = *MBBI;
 474     for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
 475          I != E; ++I)
 476       if (I->getOpcode() == ARM::INLINEASM)
 477         HasInlineAsm = true;
 478   }
 479
 480   // Now go back through the instructions and build up our data structures
 481   unsigned Offset = 0;
 482   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
 483        MBBI != E; ++MBBI) {
 484     MachineBasicBlock &MBB = *MBBI;
 485
 486     // If this block doesn't fall through into the next MBB, then this is
 487     // 'water' that a constant pool island could be placed.
 488     if (!BBHasFallthrough(&MBB))
 489       WaterList.push_back(&MBB);
 490
 491     unsigned MBBSize = 0;
 492     for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
 493          I != E; ++I) {
 494       // Add instruction size to MBBSize.
 495       MBBSize += TII->GetInstSizeInBytes(I);
 496
 497       int Opc = I->getOpcode();
 498       if (I->getDesc().isBranch()) {
 499         bool isCond = false;
 500         unsigned Bits = 0;
 501         unsigned Scale = 1;
 502         int UOpc = Opc;
 503         switch (Opc) {
 504         default:
 505           continue;  // Ignore other JT branches
 506         case ARM::tBR_JTr:
 507           // A Thumb1 table jump may involve padding; for the offsets to
 508           // be right, functions containing these must be 4-byte aligned.
 509           MF.EnsureAlignment(2U);
 510           if ((Offset+MBBSize)%4 != 0 || HasInlineAsm)
 511             // FIXME: Add a pseudo ALIGN instruction instead.
 512             MBBSize += 2;           // padding
 513           continue;   // Does not get an entry in ImmBranches
 514         case ARM::t2BR_JT:
 515           T2JumpTables.push_back(I);
 516           continue;   // Does not get an entry in ImmBranches
 517         case ARM::Bcc:
 518           isCond = true;
 519           UOpc = ARM::B;
 520           // Fallthrough
 521         case ARM::B:
 522           Bits = 24;
 523           Scale = 4;
 524           break;
 525         case ARM::tBcc:
 526           isCond = true;
 527           UOpc = ARM::tB;
 528           Bits = 8;
 529           Scale = 2;
 530           break;
 531         case ARM::tB:
 532           Bits = 11;
 533           Scale = 2;
 534           break;
 535         case ARM::t2Bcc:
 536           isCond = true;
 537           UOpc = ARM::t2B;
 538           Bits = 20;
 539           Scale = 2;
 540           break;
 541         case ARM::t2B:
 542           Bits = 24;
 543           Scale = 2;
 544           break;
 545         }
 546
 547         // Record this immediate branch.
 548         unsigned MaxOffs = ((1 << (Bits-1))-1) * Scale;
 549         ImmBranches.push_back(ImmBranch(I, MaxOffs, isCond, UOpc));
 550       }
 551
 552       if (Opc == ARM::tPUSH || Opc == ARM::tPOP_RET)
 553         PushPopMIs.push_back(I);
 554
 555       if (Opc == ARM::CONSTPOOL_ENTRY)
 556         continue;
 557
 558       // Scan the instructions for constant pool operands.
 559       for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op)
 560         if (I->getOperand(op).isCPI()) {
 561           // We found one.  The addressing mode tells us the max displacement
 562           // from the PC that this instruction permits.
 563
 564           // Basic size info comes from the TSFlags field.
 565           unsigned Bits = 0;
 566           unsigned Scale = 1;
 567           bool NegOk = false;
 568           bool IsSoImm = false;
 569
 570           switch (Opc) {
 571           default:
 572             llvm_unreachable("Unknown addressing mode for CP reference!");
 573             break;
 574
 575           // Taking the address of a CP entry.
 576           case ARM::LEApcrel:
 577             // This takes a SoImm, which is 8 bit immediate rotated. We'll
 578             // pretend the maximum offset is 255 * 4. Since each instruction
 579             // 4 byte wide, this is always correct. We'll check for other
 580             // displacements that fits in a SoImm as well.
 581             Bits = 8;
 582             Scale = 4;
 583             NegOk = true;
 584             IsSoImm = true;
 585             break;
 586           case ARM::t2LEApcrel:
 587             Bits = 12;
 588             NegOk = true;
 589             break;
 590           case ARM::tLEApcrel:
 591             Bits = 8;
 592             Scale = 4;
 593             break;
 594
 595           case ARM::LDR:
 596           case ARM::LDRcp:
 597           case ARM::t2LDRpci:
 598             Bits = 12;  // +-offset_12
 599             NegOk = true;
 600             break;
 601
 602           case ARM::tLDRpci:
 603           case ARM::tLDRcp:
 604             Bits = 8;
 605             Scale = 4;  // +(offset_8*4)
 606             break;
 607
 608           case ARM::VLDRD:
 609           case ARM::VLDRS:
 610             Bits = 8;
 611             Scale = 4;  // +-(offset_8*4)
 612             NegOk = true;
 613             break;
 614           }
 615
 616           // Remember that this is a user of a CP entry.
 617           unsigned CPI = I->getOperand(op).getIndex();
 618           MachineInstr *CPEMI = CPEMIs[CPI];
 619           unsigned MaxOffs = ((1 << Bits)-1) * Scale;
 620           CPUsers.push_back(CPUser(I, CPEMI, MaxOffs, NegOk, IsSoImm));
 621
 622           // Increment corresponding CPEntry reference count.
 623           CPEntry *CPE = findConstPoolEntry(CPI, CPEMI);
 624           assert(CPE && "Cannot find a corresponding CPEntry!");
 625           CPE->RefCount++;
 626
 627           // Instructions can only use one CP entry, don't bother scanning the
 628           // rest of the operands.
 629           break;
 630         }
 631     }
 632
 633     // In thumb mode, if this block is a constpool island, we may need padding
 634     // so it's aligned on 4 byte boundary.
 635     if (isThumb &&
 636         !MBB.empty() &&
 637         MBB.begin()->getOpcode() == ARM::CONSTPOOL_ENTRY &&
 638         ((Offset%4) != 0 || HasInlineAsm))
 639       MBBSize += 2;
 640
 641     BBSizes.push_back(MBBSize);
 642     BBOffsets.push_back(Offset);
 643     Offset += MBBSize;
 644   }
 645 }
 646
 647 /// GetOffsetOf - Return the current offset of the specified machine instruction
 648 /// from the start of the function.  This offset changes as stuff is moved
 649 /// around inside the function.
 650 unsigned ARMConstantIslands::GetOffsetOf(MachineInstr *MI) const {
 651   MachineBasicBlock *MBB = MI->getParent();
 652
 653   // The offset is composed of two things: the sum of the sizes of all MBB's
 654   // before this instruction's block, and the offset from the start of the block
 655   // it is in.
 656   unsigned Offset = BBOffsets[MBB->getNumber()];
 657
 658   // If we're looking for a CONSTPOOL_ENTRY in Thumb, see if this block has
 659   // alignment padding, and compensate if so.
 660   if (isThumb &&
 661       MI->getOpcode() == ARM::CONSTPOOL_ENTRY &&
 662       (Offset%4 != 0 || HasInlineAsm))
 663     Offset += 2;
 664
 665   // Sum instructions before MI in MBB.
 666   for (MachineBasicBlock::iterator I = MBB->begin(); ; ++I) {
 667     assert(I != MBB->end() && "Didn't find MI in its own basic block?");
 668     if (&*I == MI) return Offset;
 669     Offset += TII->GetInstSizeInBytes(I);
 670   }
 671 }
 672
 673 /// CompareMBBNumbers - Little predicate function to sort the WaterList by MBB
 674 /// ID.
 675 static bool CompareMBBNumbers(const MachineBasicBlock *LHS,
 676                               const MachineBasicBlock *RHS) {
 677   return LHS->getNumber() < RHS->getNumber();
 678 }
 679
 680 /// UpdateForInsertedWaterBlock - When a block is newly inserted into the
 681 /// machine function, it upsets all of the block numbers.  Renumber the blocks
 682 /// and update the arrays that parallel this numbering.
 683 void ARMConstantIslands::UpdateForInsertedWaterBlock(MachineBasicBlock *NewBB) {
 684   // Renumber the MBB's to keep them consequtive.
 685   NewBB->getParent()->RenumberBlocks(NewBB);
 686
 687   // Insert a size into BBSizes to align it properly with the (newly
 688   // renumbered) block numbers.
 689   BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
 690
 691   // Likewise for BBOffsets.
 692   BBOffsets.insert(BBOffsets.begin()+NewBB->getNumber(), 0);
 693
 694   // Next, update WaterList.  Specifically, we need to add NewMBB as having
 695   // available water after it.
 696   water_iterator IP =
 697     std::lower_bound(WaterList.begin(), WaterList.end(), NewBB,
 698                      CompareMBBNumbers);
 699   WaterList.insert(IP, NewBB);
 700 }
 701
 702
 703 /// Split the basic block containing MI into two blocks, which are joined by
 704 /// an unconditional branch.  Update data structures and renumber blocks to
 705 /// account for this change and returns the newly created block.
 706 MachineBasicBlock *ARMConstantIslands::SplitBlockBeforeInstr(MachineInstr *MI) {
 707   MachineBasicBlock *OrigBB = MI->getParent();
 708   MachineFunction &MF = *OrigBB->getParent();
 709
 710   // Create a new MBB for the code after the OrigBB.
 711   MachineBasicBlock *NewBB =
 712     MF.CreateMachineBasicBlock(OrigBB->getBasicBlock());
 713   MachineFunction::iterator MBBI = OrigBB; ++MBBI;
 714   MF.insert(MBBI, NewBB);
 715
 716   // Splice the instructions starting with MI over to NewBB.
 717   NewBB->splice(NewBB->end(), OrigBB, MI, OrigBB->end());
 718
 719   // Add an unconditional branch from OrigBB to NewBB.
 720   // Note the new unconditional branch is not being recorded.
 721   // There doesn't seem to be meaningful DebugInfo available; this doesn't
 722   // correspond to anything in the source.
 723   unsigned Opc = isThumb ? (isThumb2 ? ARM::t2B : ARM::tB) : ARM::B;
 724   BuildMI(OrigBB, DebugLoc(), TII->get(Opc)).addMBB(NewBB);
 725   NumSplit++;
 726
 727   // Update the CFG.  All succs of OrigBB are now succs of NewBB.
 728   while (!OrigBB->succ_empty()) {
 729     MachineBasicBlock *Succ = *OrigBB->succ_begin();
 730     OrigBB->removeSuccessor(Succ);
 731     NewBB->addSuccessor(Succ);
 732
 733     // This pass should be run after register allocation, so there should be no
 734     // PHI nodes to update.
 735     assert((Succ->empty() || !Succ->begin()->isPHI())
 736            && "PHI nodes should be eliminated by now!");
 737   }
 738
 739   // OrigBB branches to NewBB.
 740   OrigBB->addSuccessor(NewBB);
 741
 742   // Update internal data structures to account for the newly inserted MBB.
 743   // This is almost the same as UpdateForInsertedWaterBlock, except that
 744   // the Water goes after OrigBB, not NewBB.
 745   MF.RenumberBlocks(NewBB);
 746
 747   // Insert a size into BBSizes to align it properly with the (newly
 748   // renumbered) block numbers.
 749   BBSizes.insert(BBSizes.begin()+NewBB->getNumber(), 0);
 750
 751   // Likewise for BBOffsets.
 752   BBOffsets.insert(BBOffsets.begin()+NewBB->getNumber(), 0);
 753
 754   // Next, update WaterList.  Specifically, we need to add OrigMBB as having
 755   // available water after it (but not if it's already there, which happens
 756   // when splitting before a conditional branch that is followed by an
 757   // unconditional branch - in that case we want to insert NewBB).
 758   water_iterator IP =
 759     std::lower_bound(WaterList.begin(), WaterList.end(), OrigBB,
 760                      CompareMBBNumbers);
 761   MachineBasicBlock* WaterBB = *IP;
 762   if (WaterBB == OrigBB)
 763     WaterList.insert(llvm::next(IP), NewBB);
 764   else
 765     WaterList.insert(IP, OrigBB);
 766   NewWaterList.insert(OrigBB);
 767
 768   // Figure out how large the first NewMBB is.  (It cannot
 769   // contain a constpool_entry or tablejump.)
 770   unsigned NewBBSize = 0;
 771   for (MachineBasicBlock::iterator I = NewBB->begin(), E = NewBB->end();
 772        I != E; ++I)
 773     NewBBSize += TII->GetInstSizeInBytes(I);
 774
 775   unsigned OrigBBI = OrigBB->getNumber();
 776   unsigned NewBBI = NewBB->getNumber();
 777   // Set the size of NewBB in BBSizes.
 778   BBSizes[NewBBI] = NewBBSize;
 779
 780   // We removed instructions from UserMBB, subtract that off from its size.
 781   // Add 2 or 4 to the block to count the unconditional branch we added to it.
 782   int delta = isThumb1 ? 2 : 4;
 783   BBSizes[OrigBBI] -= NewBBSize - delta;
 784
 785   // ...and adjust BBOffsets for NewBB accordingly.
 786   BBOffsets[NewBBI] = BBOffsets[OrigBBI] + BBSizes[OrigBBI];
 787
 788   // All BBOffsets following these blocks must be modified.
 789   AdjustBBOffsetsAfter(NewBB, delta);
 790
 791   return NewBB;
 792 }
 793
 794 /// OffsetIsInRange - Checks whether UserOffset (the location of a constant pool
 795 /// reference) is within MaxDisp of TrialOffset (a proposed location of a
 796 /// constant pool entry).
 797 bool ARMConstantIslands::OffsetIsInRange(unsigned UserOffset,
 798                                          unsigned TrialOffset, unsigned MaxDisp,
 799                                          bool NegativeOK, bool IsSoImm) {
 800   // On Thumb offsets==2 mod 4 are rounded down by the hardware for
 801   // purposes of the displacement computation; compensate for that here.
 802   // Effectively, the valid range of displacements is 2 bytes smaller for such
 803   // references.
 804   unsigned TotalAdj = 0;
 805   if (isThumb && UserOffset%4 !=0) {
 806     UserOffset -= 2;
 807     TotalAdj = 2;
 808   }
 809   // CPEs will be rounded up to a multiple of 4.
 810   if (isThumb && TrialOffset%4 != 0) {
 811     TrialOffset += 2;
 812     TotalAdj += 2;
 813   }
 814
 815   // In Thumb2 mode, later branch adjustments can shift instructions up and
 816   // cause alignment change. In the worst case scenario this can cause the
 817   // user's effective address to be subtracted by 2 and the CPE's address to
 818   // be plus 2.
 819   if (isThumb2 && TotalAdj != 4)
 820     MaxDisp -= (4 - TotalAdj);
 821
 822   if (UserOffset <= TrialOffset) {
 823     // User before the Trial.
 824     if (TrialOffset - UserOffset <= MaxDisp)
 825       return true;
 826     // FIXME: Make use full range of soimm values.
 827   } else if (NegativeOK) {
 828     if (UserOffset - TrialOffset <= MaxDisp)
 829       return true;
 830     // FIXME: Make use full range of soimm values.
 831   }
 832   return false;
 833 }
 834
 835 /// WaterIsInRange - Returns true if a CPE placed after the specified
 836 /// Water (a basic block) will be in range for the specific MI.
 837
 838 bool ARMConstantIslands::WaterIsInRange(unsigned UserOffset,
 839                                         MachineBasicBlock* Water, CPUser &U) {
 840   unsigned MaxDisp = U.MaxDisp;
 841   unsigned CPEOffset = BBOffsets[Water->getNumber()] +
 842                        BBSizes[Water->getNumber()];
 843
 844   // If the CPE is to be inserted before the instruction, that will raise
 845   // the offset of the instruction.
 846   if (CPEOffset < UserOffset)
 847     UserOffset += U.CPEMI->getOperand(2).getImm();
 848
 849   return OffsetIsInRange(UserOffset, CPEOffset, MaxDisp, U.NegOk, U.IsSoImm);
 850 }
 851
 852 /// CPEIsInRange - Returns true if the distance between specific MI and
 853 /// specific ConstPool entry instruction can fit in MI's displacement field.
 854 bool ARMConstantIslands::CPEIsInRange(MachineInstr *MI, unsigned UserOffset,
 855                                       MachineInstr *CPEMI, unsigned MaxDisp,
 856                                       bool NegOk, bool DoDump) {
 857   unsigned CPEOffset  = GetOffsetOf(CPEMI);
 858   assert((CPEOffset%4 == 0 || HasInlineAsm) && "Misaligned CPE");
 859
 860   if (DoDump) {
 861     DEBUG(errs() << "User of CPE#" << CPEMI->getOperand(0).getImm()
 862                  << " max delta=" << MaxDisp
 863                  << " insn address=" << UserOffset
 864                  << " CPE address=" << CPEOffset
 865                  << " offset=" << int(CPEOffset-UserOffset) << "\t" << *MI);
 866   }
 867
 868   return OffsetIsInRange(UserOffset, CPEOffset, MaxDisp, NegOk);
 869 }
 870
 871 #ifndef NDEBUG
 872 /// BBIsJumpedOver - Return true of the specified basic block's only predecessor
 873 /// unconditionally branches to its only successor.
 874 static bool BBIsJumpedOver(MachineBasicBlock *MBB) {
 875   if (MBB->pred_size() != 1 || MBB->succ_size() != 1)
 876     return false;
 877
 878   MachineBasicBlock *Succ = *MBB->succ_begin();
 879   MachineBasicBlock *Pred = *MBB->pred_begin();
 880   MachineInstr *PredMI = &Pred->back();
 881   if (PredMI->getOpcode() == ARM::B || PredMI->getOpcode() == ARM::tB
 882       || PredMI->getOpcode() == ARM::t2B)
 883     return PredMI->getOperand(0).getMBB() == Succ;
 884   return false;
 885 }
 886 #endif // NDEBUG
 887
 888 void ARMConstantIslands::AdjustBBOffsetsAfter(MachineBasicBlock *BB,
 889                                               int delta) {
 890   MachineFunction::iterator MBBI = BB; MBBI = llvm::next(MBBI);
 891   for(unsigned i = BB->getNumber()+1, e = BB->getParent()->getNumBlockIDs();
 892       i < e; ++i) {
 893     BBOffsets[i] += delta;
 894     // If some existing blocks have padding, adjust the padding as needed, a
 895     // bit tricky.  delta can be negative so don't use % on that.
 896     if (!isThumb)
 897       continue;
 898     MachineBasicBlock *MBB = MBBI;
 899     if (!MBB->empty() && !HasInlineAsm) {
 900       // Constant pool entries require padding.
 901       if (MBB->begin()->getOpcode() == ARM::CONSTPOOL_ENTRY) {
 902         unsigned OldOffset = BBOffsets[i] - delta;
 903         if ((OldOffset%4) == 0 && (BBOffsets[i]%4) != 0) {
 904           // add new padding
 905           BBSizes[i] += 2;
 906           delta += 2;
 907         } else if ((OldOffset%4) != 0 && (BBOffsets[i]%4) == 0) {
 908           // remove existing padding
 909           BBSizes[i] -= 2;
 910           delta -= 2;
 911         }
 912       }
 913       // Thumb1 jump tables require padding.  They should be at the end;
 914       // following unconditional branches are removed by AnalyzeBranch.
 915       MachineInstr *ThumbJTMI = prior(MBB->end());
 916       if (ThumbJTMI->getOpcode() == ARM::tBR_JTr) {
 917         unsigned NewMIOffset = GetOffsetOf(ThumbJTMI);
 918         unsigned OldMIOffset = NewMIOffset - delta;
 919         if ((OldMIOffset%4) == 0 && (NewMIOffset%4) != 0) {
 920           // remove existing padding
 921           BBSizes[i] -= 2;
 922           delta -= 2;
 923         } else if ((OldMIOffset%4) != 0 && (NewMIOffset%4) == 0) {
 924           // add new padding
 925           BBSizes[i] += 2;
 926           delta += 2;
 927         }
 928       }
 929       if (delta==0)
 930         return;
 931     }
 932     MBBI = llvm::next(MBBI);
 933   }
 934 }
 935
 936 /// DecrementOldEntry - find the constant pool entry with index CPI
 937 /// and instruction CPEMI, and decrement its refcount.  If the refcount
 938 /// becomes 0 remove the entry and instruction.  Returns true if we removed
 939 /// the entry, false if we didn't.
 940
 941 bool ARMConstantIslands::DecrementOldEntry(unsigned CPI, MachineInstr *CPEMI) {
 942   // Find the old entry. Eliminate it if it is no longer used.
 943   CPEntry *CPE = findConstPoolEntry(CPI, CPEMI);
 944   assert(CPE && "Unexpected!");
 945   if (--CPE->RefCount == 0) {
 946     RemoveDeadCPEMI(CPEMI);
 947     CPE->CPEMI = NULL;
 948     NumCPEs--;
 949     return true;
 950   }
 951   return false;
 952 }
 953
 954 /// LookForCPEntryInRange - see if the currently referenced CPE is in range;
 955 /// if not, see if an in-range clone of the CPE is in range, and if so,
 956 /// change the data structures so the user references the clone.  Returns:
 957 /// 0 = no existing entry found
 958 /// 1 = entry found, and there were no code insertions or deletions
 959 /// 2 = entry found, and there were code insertions or deletions
 960 int ARMConstantIslands::LookForExistingCPEntry(CPUser& U, unsigned UserOffset)
 961 {
 962   MachineInstr *UserMI = U.MI;
 963   MachineInstr *CPEMI  = U.CPEMI;
 964
 965   // Check to see if the CPE is already in-range.
 966   if (CPEIsInRange(UserMI, UserOffset, CPEMI, U.MaxDisp, U.NegOk, true)) {
 967     DEBUG(errs() << "In range\n");
 968     return 1;
 969   }
 970
 971   // No.  Look for previously created clones of the CPE that are in range.
 972   unsigned CPI = CPEMI->getOperand(1).getIndex();
 973   std::vector<CPEntry> &CPEs = CPEntries[CPI];
 974   for (unsigned i = 0, e = CPEs.size(); i != e; ++i) {
 975     // We already tried this one
 976     if (CPEs[i].CPEMI == CPEMI)
 977       continue;
 978     // Removing CPEs can leave empty entries, skip
 979     if (CPEs[i].CPEMI == NULL)
 980       continue;
 981     if (CPEIsInRange(UserMI, UserOffset, CPEs[i].CPEMI, U.MaxDisp, U.NegOk)) {
 982       DEBUG(errs() << "Replacing CPE#" << CPI << " with CPE#"
 983                    << CPEs[i].CPI << "\n");
 984       // Point the CPUser node to the replacement
 985       U.CPEMI = CPEs[i].CPEMI;
 986       // Change the CPI in the instruction operand to refer to the clone.
 987       for (unsigned j = 0, e = UserMI->getNumOperands(); j != e; ++j)
 988         if (UserMI->getOperand(j).isCPI()) {
 989           UserMI->getOperand(j).setIndex(CPEs[i].CPI);
 990           break;
 991         }
 992       // Adjust the refcount of the clone...
 993       CPEs[i].RefCount++;
 994       // ...and the original.  If we didn't remove the old entry, none of the
 995       // addresses changed, so we don't need another pass.
 996       return DecrementOldEntry(CPI, CPEMI) ? 2 : 1;
 997     }
 998   }
 999   return 0;
1000 }
1001
1002 /// getUnconditionalBrDisp - Returns the maximum displacement that can fit in
1003 /// the specific unconditional branch instruction.
1004 static inline unsigned getUnconditionalBrDisp(int Opc) {
1005   switch (Opc) {
1006   case ARM::tB:
1007     return ((1<<10)-1)*2;
1008   case ARM::t2B:
1009     return ((1<<23)-1)*2;
1010   default:
1011     break;
1012   }
1013
1014   return ((1<<23)-1)*4;
1015 }
1016
1017 /// LookForWater - Look for an existing entry in the WaterList in which
1018 /// we can place the CPE referenced from U so it's within range of U's MI.
1019 /// Returns true if found, false if not.  If it returns true, WaterIter
1020 /// is set to the WaterList entry.  For Thumb, prefer water that will not
1021 /// introduce padding to water that will.  To ensure that this pass
1022 /// terminates, the CPE location for a particular CPUser is only allowed to
1023 /// move to a lower address, so search backward from the end of the list and
1024 /// prefer the first water that is in range.
1025 bool ARMConstantIslands::LookForWater(CPUser &U, unsigned UserOffset,
1026                                       water_iterator &WaterIter) {
1027   if (WaterList.empty())
1028     return false;
1029
1030   bool FoundWaterThatWouldPad = false;
1031   water_iterator IPThatWouldPad;
1032   for (water_iterator IP = prior(WaterList.end()),
1033          B = WaterList.begin();; --IP) {
1034     MachineBasicBlock* WaterBB = *IP;
1035     // Check if water is in range and is either at a lower address than the
1036     // current "high water mark" or a new water block that was created since
1037     // the previous iteration by inserting an unconditional branch.  In the
1038     // latter case, we want to allow resetting the high water mark back to
1039     // this new water since we haven't seen it before.  Inserting branches
1040     // should be relatively uncommon and when it does happen, we want to be
1041     // sure to take advantage of it for all the CPEs near that block, so that
1042     // we don't insert more branches than necessary.
1043     if (WaterIsInRange(UserOffset, WaterBB, U) &&
1044         (WaterBB->getNumber() < U.HighWaterMark->getNumber() ||
1045          NewWaterList.count(WaterBB))) {
1046       unsigned WBBId = WaterBB->getNumber();
1047       if (isThumb &&
1048           (BBOffsets[WBBId] + BBSizes[WBBId])%4 != 0) {
1049         // This is valid Water, but would introduce padding.  Remember
1050         // it in case we don't find any Water that doesn't do this.
1051         if (!FoundWaterThatWouldPad) {
1052           FoundWaterThatWouldPad = true;
1053           IPThatWouldPad = IP;
1054         }
1055       } else {
1056         WaterIter = IP;
1057         return true;
1058       }
1059     }
1060     if (IP == B)
1061       break;
1062   }
1063   if (FoundWaterThatWouldPad) {
1064     WaterIter = IPThatWouldPad;
1065     return true;
1066   }
1067   return false;
1068 }
1069
1070 /// CreateNewWater - No existing WaterList entry will work for
1071 /// CPUsers[CPUserIndex], so create a place to put the CPE.  The end of the
1072 /// block is used if in range, and the conditional branch munged so control
1073 /// flow is correct.  Otherwise the block is split to create a hole with an
1074 /// unconditional branch around it.  In either case NewMBB is set to a
1075 /// block following which the new island can be inserted (the WaterList
1076 /// is not adjusted).
1077 void ARMConstantIslands::CreateNewWater(unsigned CPUserIndex,
1078                                         unsigned UserOffset,
1079                                         MachineBasicBlock *&NewMBB) {
1080   CPUser &U = CPUsers[CPUserIndex];
1081   MachineInstr *UserMI = U.MI;
1082   MachineInstr *CPEMI  = U.CPEMI;
1083   MachineBasicBlock *UserMBB = UserMI->getParent();
1084   unsigned OffsetOfNextBlock = BBOffsets[UserMBB->getNumber()] +
1085                                BBSizes[UserMBB->getNumber()];
1086   assert(OffsetOfNextBlock== BBOffsets[UserMBB->getNumber()+1]);
1087
1088   // If the block does not end in an unconditional branch already, and if the
1089   // end of the block is within range, make new water there.  (The addition
1090   // below is for the unconditional branch we will be adding: 4 bytes on ARM +
1091   // Thumb2, 2 on Thumb1.  Possible Thumb1 alignment padding is allowed for
1092   // inside OffsetIsInRange.
1093   if (BBHasFallthrough(UserMBB) &&
1094       OffsetIsInRange(UserOffset, OffsetOfNextBlock + (isThumb1 ? 2: 4),
1095                       U.MaxDisp, U.NegOk, U.IsSoImm)) {
1096     DEBUG(errs() << "Split at end of block\n");
1097     if (&UserMBB->back() == UserMI)
1098       assert(BBHasFallthrough(UserMBB) && "Expected a fallthrough BB!");
1099     NewMBB = llvm::next(MachineFunction::iterator(UserMBB));
1100     // Add an unconditional branch from UserMBB to fallthrough block.
1101     // Record it for branch lengthening; this new branch will not get out of
1102     // range, but if the preceding conditional branch is out of range, the
1103     // targets will be exchanged, and the altered branch may be out of
1104     // range, so the machinery has to know about it.
1105     int UncondBr = isThumb ? ((isThumb2) ? ARM::t2B : ARM::tB) : ARM::B;
1106     BuildMI(UserMBB, DebugLoc(), TII->get(UncondBr)).addMBB(NewMBB);
1107     unsigned MaxDisp = getUnconditionalBrDisp(UncondBr);
1108     ImmBranches.push_back(ImmBranch(&UserMBB->back(),
1109                           MaxDisp, false, UncondBr));
1110     int delta = isThumb1 ? 2 : 4;
1111     BBSizes[UserMBB->getNumber()] += delta;
1112     AdjustBBOffsetsAfter(UserMBB, delta);
1113   } else {
1114     // What a big block.  Find a place within the block to split it.
1115     // This is a little tricky on Thumb1 since instructions are 2 bytes
1116     // and constant pool entries are 4 bytes: if instruction I references
1117     // island CPE, and instruction I+1 references CPE', it will
1118     // not work well to put CPE as far forward as possible, since then
1119     // CPE' cannot immediately follow it (that location is 2 bytes
1120     // farther away from I+1 than CPE was from I) and we'd need to create
1121     // a new island.  So, we make a first guess, then walk through the
1122     // instructions between the one currently being looked at and the
1123     // possible insertion point, and make sure any other instructions
1124     // that reference CPEs will be able to use the same island area;
1125     // if not, we back up the insertion point.
1126
1127     // The 4 in the following is for the unconditional branch we'll be
1128     // inserting (allows for long branch on Thumb1).  Alignment of the
1129     // island is handled inside OffsetIsInRange.
1130     unsigned BaseInsertOffset = UserOffset + U.MaxDisp -4;
1131     // This could point off the end of the block if we've already got
1132     // constant pool entries following this block; only the last one is
1133     // in the water list.  Back past any possible branches (allow for a
1134     // conditional and a maximally long unconditional).
1135     if (BaseInsertOffset >= BBOffsets[UserMBB->getNumber()+1])
1136       BaseInsertOffset = BBOffsets[UserMBB->getNumber()+1] -
1137                               (isThumb1 ? 6 : 8);
1138     unsigned EndInsertOffset = BaseInsertOffset +
1139            CPEMI->getOperand(2).getImm();
1140     MachineBasicBlock::iterator MI = UserMI;
1141     ++MI;
1142     unsigned CPUIndex = CPUserIndex+1;
1143     for (unsigned Offset = UserOffset+TII->GetInstSizeInBytes(UserMI);
1144          Offset < BaseInsertOffset;
1145          Offset += TII->GetInstSizeInBytes(MI),
1146             MI = llvm::next(MI)) {
1147       if (CPUIndex < CPUsers.size() && CPUsers[CPUIndex].MI == MI) {
1148         CPUser &U = CPUsers[CPUIndex];
1149         if (!OffsetIsInRange(Offset, EndInsertOffset,
1150                              U.MaxDisp, U.NegOk, U.IsSoImm)) {
1151           BaseInsertOffset -= (isThumb1 ? 2 : 4);
1152           EndInsertOffset  -= (isThumb1 ? 2 : 4);
1153         }
1154         // This is overly conservative, as we don't account for CPEMIs
1155         // being reused within the block, but it doesn't matter much.
1156         EndInsertOffset += CPUsers[CPUIndex].CPEMI->getOperand(2).getImm();
1157         CPUIndex++;
1158       }
1159     }
1160     DEBUG(errs() << "Split in middle of big block\n");
1161     NewMBB = SplitBlockBeforeInstr(prior(MI));
1162   }
1163 }
1164
1165 /// HandleConstantPoolUser - Analyze the specified user, checking to see if it
1166 /// is out-of-range.  If so, pick up the constant pool value and move it some
1167 /// place in-range.  Return true if we changed any addresses (thus must run
1168 /// another pass of branch lengthening), false otherwise.
1169 bool ARMConstantIslands::HandleConstantPoolUser(MachineFunction &MF,
1170                                                 unsigned CPUserIndex) {
1171   CPUser &U = CPUsers[CPUserIndex];
1172   MachineInstr *UserMI = U.MI;
1173   MachineInstr *CPEMI  = U.CPEMI;
1174   unsigned CPI = CPEMI->getOperand(1).getIndex();
1175   unsigned Size = CPEMI->getOperand(2).getImm();
1176   // Compute this only once, it's expensive.  The 4 or 8 is the value the
1177   // hardware keeps in the PC.
1178   unsigned UserOffset = GetOffsetOf(UserMI) + (isThumb ? 4 : 8);
1179
1180   // See if the current entry is within range, or there is a clone of it
1181   // in range.
1182   int result = LookForExistingCPEntry(U, UserOffset);
1183   if (result==1) return false;
1184   else if (result==2) return true;
1185
1186   // No existing clone of this CPE is within range.
1187   // We will be generating a new clone.  Get a UID for it.
1188   unsigned ID = AFI->createConstPoolEntryUId();
1189
1190   // Look for water where we can place this CPE.
1191   MachineBasicBlock *NewIsland = MF.CreateMachineBasicBlock();
1192   MachineBasicBlock *NewMBB;
1193   water_iterator IP;
1194   if (LookForWater(U, UserOffset, IP)) {
1195     DEBUG(errs() << "found water in range\n");
1196     MachineBasicBlock *WaterBB = *IP;
1197
1198     // If the original WaterList entry was "new water" on this iteration,
1199     // propagate that to the new island.  This is just keeping NewWaterList
1200     // updated to match the WaterList, which will be updated below.
1201     if (NewWaterList.count(WaterBB)) {
1202       NewWaterList.erase(WaterBB);
1203       NewWaterList.insert(NewIsland);
1204     }
1205     // The new CPE goes before the following block (NewMBB).
1206     NewMBB = llvm::next(MachineFunction::iterator(WaterBB));
1207
1208   } else {
1209     // No water found.
1210     DEBUG(errs() << "No water found\n");
1211     CreateNewWater(CPUserIndex, UserOffset, NewMBB);
1212
1213     // SplitBlockBeforeInstr adds to WaterList, which is important when it is
1214     // called while handling branches so that the water will be seen on the
1215     // next iteration for constant pools, but in this context, we don't want
1216     // it.  Check for this so it will be removed from the WaterList.
1217     // Also remove any entry from NewWaterList.
1218     MachineBasicBlock *WaterBB = prior(MachineFunction::iterator(NewMBB));
1219     IP = std::find(WaterList.begin(), WaterList.end(), WaterBB);
1220     if (IP != WaterList.end())
1221       NewWaterList.erase(WaterBB);
1222
1223     // We are adding new water.  Update NewWaterList.
1224     NewWaterList.insert(NewIsland);
1225   }
1226
1227   // Remove the original WaterList entry; we want subsequent insertions in
1228   // this vicinity to go after the one we're about to insert.  This
1229   // considerably reduces the number of times we have to move the same CPE
1230   // more than once and is also important to ensure the algorithm terminates.
1231   if (IP != WaterList.end())
1232     WaterList.erase(IP);
1233
1234   // Okay, we know we can put an island before NewMBB now, do it!
1235   MF.insert(NewMBB, NewIsland);
1236
1237   // Update internal data structures to account for the newly inserted MBB.
1238   UpdateForInsertedWaterBlock(NewIsland);
1239
1240   // Decrement the old entry, and remove it if refcount becomes 0.
1241   DecrementOldEntry(CPI, CPEMI);
1242
1243   // Now that we have an island to add the CPE to, clone the original CPE and
1244   // add it to the island.
1245   U.HighWaterMark = NewIsland;
1246   U.CPEMI = BuildMI(NewIsland, DebugLoc(), TII->get(ARM::CONSTPOOL_ENTRY))
1247                 .addImm(ID).addConstantPoolIndex(CPI).addImm(Size);
1248   CPEntries[CPI].push_back(CPEntry(U.CPEMI, ID, 1));
1249   NumCPEs++;
1250
1251   BBOffsets[NewIsland->getNumber()] = BBOffsets[NewMBB->getNumber()];
1252   // Compensate for .align 2 in thumb mode.
1253   if (isThumb && (BBOffsets[NewIsland->getNumber()]%4 != 0 || HasInlineAsm))
1254     Size += 2;
1255   // Increase the size of the island block to account for the new entry.
1256   BBSizes[NewIsland->getNumber()] += Size;
1257   AdjustBBOffsetsAfter(NewIsland, Size);
1258
1259   // Finally, change the CPI in the instruction operand to be ID.
1260   for (unsigned i = 0, e = UserMI->getNumOperands(); i != e; ++i)
1261     if (UserMI->getOperand(i).isCPI()) {
1262       UserMI->getOperand(i).setIndex(ID);
1263       break;
1264     }
1265
1266   DEBUG(errs() << "  Moved CPE to #" << ID << " CPI=" << CPI
1267            << '\t' << *UserMI);
1268
1269   return true;
1270 }
1271
1272 /// RemoveDeadCPEMI - Remove a dead constant pool entry instruction. Update
1273 /// sizes and offsets of impacted basic blocks.
1274 void ARMConstantIslands::RemoveDeadCPEMI(MachineInstr *CPEMI) {
1275   MachineBasicBlock *CPEBB = CPEMI->getParent();
1276   unsigned Size = CPEMI->getOperand(2).getImm();
1277   CPEMI->eraseFromParent();
1278   BBSizes[CPEBB->getNumber()] -= Size;
1279   // All succeeding offsets have the current size value added in, fix this.
1280   if (CPEBB->empty()) {
1281     // In thumb1 mode, the size of island may be padded by two to compensate for
1282     // the alignment requirement.  Then it will now be 2 when the block is
1283     // empty, so fix this.
1284     // All succeeding offsets have the current size value added in, fix this.
1285     if (BBSizes[CPEBB->getNumber()] != 0) {
1286       Size += BBSizes[CPEBB->getNumber()];
1287       BBSizes[CPEBB->getNumber()] = 0;
1288     }
1289   }
1290   AdjustBBOffsetsAfter(CPEBB, -Size);
1291   // An island has only one predecessor BB and one successor BB. Check if
1292   // this BB's predecessor jumps directly to this BB's successor. This
1293   // shouldn't happen currently.
1294   assert(!BBIsJumpedOver(CPEBB) && "How did this happen?");
1295   // FIXME: remove the empty blocks after all the work is done?
1296 }
1297
1298 /// RemoveUnusedCPEntries - Remove constant pool entries whose refcounts
1299 /// are zero.
1300 bool ARMConstantIslands::RemoveUnusedCPEntries() {
1301   unsigned MadeChange = false;
1302   for (unsigned i = 0, e = CPEntries.size(); i != e; ++i) {
1303       std::vector<CPEntry> &CPEs = CPEntries[i];
1304       for (unsigned j = 0, ee = CPEs.size(); j != ee; ++j) {
1305         if (CPEs[j].RefCount == 0 && CPEs[j].CPEMI) {
1306           RemoveDeadCPEMI(CPEs[j].CPEMI);
1307           CPEs[j].CPEMI = NULL;
1308           MadeChange = true;
1309         }
1310       }
1311   }
1312   return MadeChange;
1313 }
1314
1315 /// BBIsInRange - Returns true if the distance between specific MI and
1316 /// specific BB can fit in MI's displacement field.
1317 bool ARMConstantIslands::BBIsInRange(MachineInstr *MI,MachineBasicBlock *DestBB,
1318                                      unsigned MaxDisp) {
1319   unsigned PCAdj      = isThumb ? 4 : 8;
1320   unsigned BrOffset   = GetOffsetOf(MI) + PCAdj;
1321   unsigned DestOffset = BBOffsets[DestBB->getNumber()];
1322
1323   DEBUG(errs() << "Branch of destination BB#" << DestBB->getNumber()
1324                << " from BB#" << MI->getParent()->getNumber()
1325                << " max delta=" << MaxDisp
1326                << " from " << GetOffsetOf(MI) << " to " << DestOffset
1327                << " offset " << int(DestOffset-BrOffset) << "\t" << *MI);
1328
1329   if (BrOffset <= DestOffset) {
1330     // Branch before the Dest.
1331     if (DestOffset-BrOffset <= MaxDisp)
1332       return true;
1333   } else {
1334     if (BrOffset-DestOffset <= MaxDisp)
1335       return true;
1336   }
1337   return false;
1338 }
1339
1340 /// FixUpImmediateBr - Fix up an immediate branch whose destination is too far
1341 /// away to fit in its displacement field.
1342 bool ARMConstantIslands::FixUpImmediateBr(MachineFunction &MF, ImmBranch &Br) {
1343   MachineInstr *MI = Br.MI;
1344   MachineBasicBlock *DestBB = MI->getOperand(0).getMBB();
1345
1346   // Check to see if the DestBB is already in-range.
1347   if (BBIsInRange(MI, DestBB, Br.MaxDisp))
1348     return false;
1349
1350   if (!Br.isCond)
1351     return FixUpUnconditionalBr(MF, Br);
1352   return FixUpConditionalBr(MF, Br);
1353 }
1354
1355 /// FixUpUnconditionalBr - Fix up an unconditional branch whose destination is
1356 /// too far away to fit in its displacement field. If the LR register has been
1357 /// spilled in the epilogue, then we can use BL to implement a far jump.
1358 /// Otherwise, add an intermediate branch instruction to a branch.
1359 bool
1360 ARMConstantIslands::FixUpUnconditionalBr(MachineFunction &MF, ImmBranch &Br) {
1361   MachineInstr *MI = Br.MI;
1362   MachineBasicBlock *MBB = MI->getParent();
1363   if (!isThumb1)
1364     llvm_unreachable("FixUpUnconditionalBr is Thumb1 only!");
1365
1366   // Use BL to implement far jump.
1367   Br.MaxDisp = (1 << 21) * 2;
1368   MI->setDesc(TII->get(ARM::tBfar));
1369   BBSizes[MBB->getNumber()] += 2;
1370   AdjustBBOffsetsAfter(MBB, 2);
1371   HasFarJump = true;
1372   NumUBrFixed++;
1373
1374   DEBUG(errs() << "  Changed B to long jump " << *MI);
1375
1376   return true;
1377 }
1378
1379 /// FixUpConditionalBr - Fix up a conditional branch whose destination is too
1380 /// far away to fit in its displacement field. It is converted to an inverse
1381 /// conditional branch + an unconditional branch to the destination.
1382 bool
1383 ARMConstantIslands::FixUpConditionalBr(MachineFunction &MF, ImmBranch &Br) {
1384   MachineInstr *MI = Br.MI;
1385   MachineBasicBlock *DestBB = MI->getOperand(0).getMBB();
1386
1387   // Add an unconditional branch to the destination and invert the branch
1388   // condition to jump over it:
1389   // blt L1
1390   // =>
1391   // bge L2
1392   // b   L1
1393   // L2:
1394   ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(1).getImm();
1395   CC = ARMCC::getOppositeCondition(CC);
1396   unsigned CCReg = MI->getOperand(2).getReg();
1397
1398   // If the branch is at the end of its MBB and that has a fall-through block,
1399   // direct the updated conditional branch to the fall-through block. Otherwise,
1400   // split the MBB before the next instruction.
1401   MachineBasicBlock *MBB = MI->getParent();
1402   MachineInstr *BMI = &MBB->back();
1403   bool NeedSplit = (BMI != MI) || !BBHasFallthrough(MBB);
1404
1405   NumCBrFixed++;
1406   if (BMI != MI) {
1407     if (llvm::next(MachineBasicBlock::iterator(MI)) == prior(MBB->end()) &&
1408         BMI->getOpcode() == Br.UncondBr) {
1409       // Last MI in the BB is an unconditional branch. Can we simply invert the
1410       // condition and swap destinations:
1411       // beq L1
1412       // b   L2
1413       // =>
1414       // bne L2
1415       // b   L1
1416       MachineBasicBlock *NewDest = BMI->getOperand(0).getMBB();
1417       if (BBIsInRange(MI, NewDest, Br.MaxDisp)) {
1418         DEBUG(errs() << "  Invert Bcc condition and swap its destination with "
1419                      << *BMI);
1420         BMI->getOperand(0).setMBB(DestBB);
1421         MI->getOperand(0).setMBB(NewDest);
1422         MI->getOperand(1).setImm(CC);
1423         return true;
1424       }
1425     }
1426   }
1427
1428   if (NeedSplit) {
1429     SplitBlockBeforeInstr(MI);
1430     // No need for the branch to the next block. We're adding an unconditional
1431     // branch to the destination.
1432     int delta = TII->GetInstSizeInBytes(&MBB->back());
1433     BBSizes[MBB->getNumber()] -= delta;
1434     MachineBasicBlock* SplitBB = llvm::next(MachineFunction::iterator(MBB));
1435     AdjustBBOffsetsAfter(SplitBB, -delta);
1436     MBB->back().eraseFromParent();
1437     // BBOffsets[SplitBB] is wrong temporarily, fixed below
1438   }
1439   MachineBasicBlock *NextBB = llvm::next(MachineFunction::iterator(MBB));
1440
1441   DEBUG(errs() << "  Insert B to BB#" << DestBB->getNumber()
1442                << " also invert condition and change dest. to BB#"
1443                << NextBB->getNumber() << "\n");
1444
1445   // Insert a new conditional branch and a new unconditional branch.
1446   // Also update the ImmBranch as well as adding a new entry for the new branch.
1447   BuildMI(MBB, DebugLoc(), TII->get(MI->getOpcode()))
1448     .addMBB(NextBB).addImm(CC).addReg(CCReg);
1449   Br.MI = &MBB->back();
1450   BBSizes[MBB->getNumber()] += TII->GetInstSizeInBytes(&MBB->back());
1451   BuildMI(MBB, DebugLoc(), TII->get(Br.UncondBr)).addMBB(DestBB);
1452   BBSizes[MBB->getNumber()] += TII->GetInstSizeInBytes(&MBB->back());
1453   unsigned MaxDisp = getUnconditionalBrDisp(Br.UncondBr);
1454   ImmBranches.push_back(ImmBranch(&MBB->back(), MaxDisp, false, Br.UncondBr));
1455
1456   // Remove the old conditional branch.  It may or may not still be in MBB.
1457   BBSizes[MI->getParent()->getNumber()] -= TII->GetInstSizeInBytes(MI);
1458   MI->eraseFromParent();
1459
1460   // The net size change is an addition of one unconditional branch.
1461   int delta = TII->GetInstSizeInBytes(&MBB->back());
1462   AdjustBBOffsetsAfter(MBB, delta);
1463   return true;
1464 }
1465
1466 /// UndoLRSpillRestore - Remove Thumb push / pop instructions that only spills
1467 /// LR / restores LR to pc. FIXME: This is done here because it's only possible
1468 /// to do this if tBfar is not used.
1469 bool ARMConstantIslands::UndoLRSpillRestore() {
1470   bool MadeChange = false;
1471   for (unsigned i = 0, e = PushPopMIs.size(); i != e; ++i) {
1472     MachineInstr *MI = PushPopMIs[i];
1473     // First two operands are predicates.
1474     if (MI->getOpcode() == ARM::tPOP_RET &&
1475         MI->getOperand(2).getReg() == ARM::PC &&
1476         MI->getNumExplicitOperands() == 3) {
1477       BuildMI(MI->getParent(), MI->getDebugLoc(), TII->get(ARM::tBX_RET));
1478       MI->eraseFromParent();
1479       MadeChange = true;
1480     }
1481   }
1482   return MadeChange;
1483 }
1484
1485 bool ARMConstantIslands::OptimizeThumb2Instructions(MachineFunction &MF) {
1486   bool MadeChange = false;
1487
1488   // Shrink ADR and LDR from constantpool.
1489   for (unsigned i = 0, e = CPUsers.size(); i != e; ++i) {
1490     CPUser &U = CPUsers[i];
1491     unsigned Opcode = U.MI->getOpcode();
1492     unsigned NewOpc = 0;
1493     unsigned Scale = 1;
1494     unsigned Bits = 0;
1495     switch (Opcode) {
1496     default: break;
1497     case ARM::t2LEApcrel:
1498       if (isARMLowRegister(U.MI->getOperand(0).getReg())) {
1499         NewOpc = ARM::tLEApcrel;
1500         Bits = 8;
1501         Scale = 4;
1502       }
1503       break;
1504     case ARM::t2LDRpci:
1505       if (isARMLowRegister(U.MI->getOperand(0).getReg())) {
1506         NewOpc = ARM::tLDRpci;
1507         Bits = 8;
1508         Scale = 4;
1509       }
1510       break;
1511     }
1512
1513     if (!NewOpc)
1514       continue;
1515
1516     unsigned UserOffset = GetOffsetOf(U.MI) + 4;
1517     unsigned MaxOffs = ((1 << Bits) - 1) * Scale;
1518     // FIXME: Check if offset is multiple of scale if scale is not 4.
1519     if (CPEIsInRange(U.MI, UserOffset, U.CPEMI, MaxOffs, false, true)) {
1520       U.MI->setDesc(TII->get(NewOpc));
1521       MachineBasicBlock *MBB = U.MI->getParent();
1522       BBSizes[MBB->getNumber()] -= 2;
1523       AdjustBBOffsetsAfter(MBB, -2);
1524       ++NumT2CPShrunk;
1525       MadeChange = true;
1526     }
1527   }
1528
1529   MadeChange |= OptimizeThumb2Branches(MF);
1530   MadeChange |= OptimizeThumb2JumpTables(MF);
1531   return MadeChange;
1532 }
1533
1534 bool ARMConstantIslands::OptimizeThumb2Branches(MachineFunction &MF) {
1535   bool MadeChange = false;
1536
1537   for (unsigned i = 0, e = ImmBranches.size(); i != e; ++i) {
1538     ImmBranch &Br = ImmBranches[i];
1539     unsigned Opcode = Br.MI->getOpcode();
1540     unsigned NewOpc = 0;
1541     unsigned Scale = 1;
1542     unsigned Bits = 0;
1543     switch (Opcode) {
1544     default: break;
1545     case ARM::t2B:
1546       NewOpc = ARM::tB;
1547       Bits = 11;
1548       Scale = 2;
1549       break;
1550     case ARM::t2Bcc: {
1551       NewOpc = ARM::tBcc;
1552       Bits = 8;
1553       Scale = 2;
1554       break;
1555     }
1556     }
1557     if (NewOpc) {
1558       unsigned MaxOffs = ((1 << (Bits-1))-1) * Scale;
1559       MachineBasicBlock *DestBB = Br.MI->getOperand(0).getMBB();
1560       if (BBIsInRange(Br.MI, DestBB, MaxOffs)) {
1561         Br.MI->setDesc(TII->get(NewOpc));
1562         MachineBasicBlock *MBB = Br.MI->getParent();
1563         BBSizes[MBB->getNumber()] -= 2;
1564         AdjustBBOffsetsAfter(MBB, -2);
1565         ++NumT2BrShrunk;
1566         MadeChange = true;
1567       }
1568     }
1569
1570     Opcode = Br.MI->getOpcode();
1571     if (Opcode != ARM::tBcc)
1572       continue;
1573
1574     NewOpc = 0;
1575     unsigned PredReg = 0;
1576     ARMCC::CondCodes Pred = llvm::getInstrPredicate(Br.MI, PredReg);
1577     if (Pred == ARMCC::EQ)
1578       NewOpc = ARM::tCBZ;
1579     else if (Pred == ARMCC::NE)
1580       NewOpc = ARM::tCBNZ;
1581     if (!NewOpc)
1582       continue;
1583     MachineBasicBlock *DestBB = Br.MI->getOperand(0).getMBB();
1584     // Check if the distance is within 126. Subtract starting offset by 2
1585     // because the cmp will be eliminated.
1586     unsigned BrOffset = GetOffsetOf(Br.MI) + 4 - 2;
1587     unsigned DestOffset = BBOffsets[DestBB->getNumber()];
1588     if (BrOffset < DestOffset && (DestOffset - BrOffset) <= 126) {
1589       MachineBasicBlock::iterator CmpMI = Br.MI; --CmpMI;
1590       if (CmpMI->getOpcode() == ARM::tCMPzi8) {
1591         unsigned Reg = CmpMI->getOperand(0).getReg();
1592         Pred = llvm::getInstrPredicate(CmpMI, PredReg);
1593         if (Pred == ARMCC::AL &&
1594             CmpMI->getOperand(1).getImm() == 0 &&
1595             isARMLowRegister(Reg)) {
1596           MachineBasicBlock *MBB = Br.MI->getParent();
1597           MachineInstr *NewBR =
1598             BuildMI(*MBB, CmpMI, Br.MI->getDebugLoc(), TII->get(NewOpc))
1599             .addReg(Reg).addMBB(DestBB, Br.MI->getOperand(0).getTargetFlags());
1600           CmpMI->eraseFromParent();
1601           Br.MI->eraseFromParent();
1602           Br.MI = NewBR;
1603           BBSizes[MBB->getNumber()] -= 2;
1604           AdjustBBOffsetsAfter(MBB, -2);
1605           ++NumCBZ;
1606           MadeChange = true;
1607         }
1608       }
1609     }
1610   }
1611
1612   return MadeChange;
1613 }
1614
1615 /// OptimizeThumb2JumpTables - Use tbb / tbh instructions to generate smaller
1616 /// jumptables when it's possible.
1617 bool ARMConstantIslands::OptimizeThumb2JumpTables(MachineFunction &MF) {
1618   bool MadeChange = false;
1619
1620   // FIXME: After the tables are shrunk, can we get rid some of the
1621   // constantpool tables?
1622   MachineJumpTableInfo *MJTI = MF.getJumpTableInfo();
1623   if (MJTI == 0) return false;
1624
1625   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1626   for (unsigned i = 0, e = T2JumpTables.size(); i != e; ++i) {
1627     MachineInstr *MI = T2JumpTables[i];
1628     const TargetInstrDesc &TID = MI->getDesc();
1629     unsigned NumOps = TID.getNumOperands();
1630     unsigned JTOpIdx = NumOps - (TID.isPredicable() ? 3 : 2);
1631     MachineOperand JTOP = MI->getOperand(JTOpIdx);
1632     unsigned JTI = JTOP.getIndex();
1633     assert(JTI < JT.size());
1634
1635     bool ByteOk = true;
1636     bool HalfWordOk = true;
1637     unsigned JTOffset = GetOffsetOf(MI) + 4;
1638     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1639     for (unsigned j = 0, ee = JTBBs.size(); j != ee; ++j) {
1640       MachineBasicBlock *MBB = JTBBs[j];
1641       unsigned DstOffset = BBOffsets[MBB->getNumber()];
1642       // Negative offset is not ok. FIXME: We should change BB layout to make
1643       // sure all the branches are forward.
1644       if (ByteOk && (DstOffset - JTOffset) > ((1<<8)-1)*2)
1645         ByteOk = false;
1646       unsigned TBHLimit = ((1<<16)-1)*2;
1647       if (HalfWordOk && (DstOffset - JTOffset) > TBHLimit)
1648         HalfWordOk = false;
1649       if (!ByteOk && !HalfWordOk)
1650         break;
1651     }
1652
1653     if (ByteOk || HalfWordOk) {
1654       MachineBasicBlock *MBB = MI->getParent();
1655       unsigned BaseReg = MI->getOperand(0).getReg();
1656       bool BaseRegKill = MI->getOperand(0).isKill();
1657       if (!BaseRegKill)
1658         continue;
1659       unsigned IdxReg = MI->getOperand(1).getReg();
1660       bool IdxRegKill = MI->getOperand(1).isKill();
1661       MachineBasicBlock::iterator PrevI = MI;
1662       if (PrevI == MBB->begin())
1663         continue;
1664
1665       MachineInstr *AddrMI = --PrevI;
1666       bool OptOk = true;
1667       // Examine the instruction that calculate the jumptable entry address.
1668       // If it's not the one just before the t2BR_JT, we won't delete it, then
1669       // it's not worth doing the optimization.
1670       for (unsigned k = 0, eee = AddrMI->getNumOperands(); k != eee; ++k) {
1671         const MachineOperand &MO = AddrMI->getOperand(k);
1672         if (!MO.isReg() || !MO.getReg())
1673           continue;
1674         if (MO.isDef() && MO.getReg() != BaseReg) {
1675           OptOk = false;
1676           break;
1677         }
1678         if (MO.isUse() && !MO.isKill() && MO.getReg() != IdxReg) {
1679           OptOk = false;
1680           break;
1681         }
1682       }
1683       if (!OptOk)
1684         continue;
1685
1686       // The previous instruction should be a tLEApcrel or t2LEApcrelJT, we want
1687       // to delete it as well.
1688       MachineInstr *LeaMI = --PrevI;
1689       if ((LeaMI->getOpcode() != ARM::tLEApcrelJT &&
1690            LeaMI->getOpcode() != ARM::t2LEApcrelJT) ||
1691           LeaMI->getOperand(0).getReg() != BaseReg)
1692         OptOk = false;
1693
1694       if (!OptOk)
1695         continue;
1696
1697       unsigned Opc = ByteOk ? ARM::t2TBB : ARM::t2TBH;
1698       MachineInstr *NewJTMI = BuildMI(MBB, MI->getDebugLoc(), TII->get(Opc))
1699         .addReg(IdxReg, getKillRegState(IdxRegKill))
1700         .addJumpTableIndex(JTI, JTOP.getTargetFlags())
1701         .addImm(MI->getOperand(JTOpIdx+1).getImm());
1702       // FIXME: Insert an "ALIGN" instruction to ensure the next instruction
1703       // is 2-byte aligned. For now, asm printer will fix it up.
1704       unsigned NewSize = TII->GetInstSizeInBytes(NewJTMI);
1705       unsigned OrigSize = TII->GetInstSizeInBytes(AddrMI);
1706       OrigSize += TII->GetInstSizeInBytes(LeaMI);
1707       OrigSize += TII->GetInstSizeInBytes(MI);
1708
1709       AddrMI->eraseFromParent();
1710       LeaMI->eraseFromParent();
1711       MI->eraseFromParent();
1712
1713       int delta = OrigSize - NewSize;
1714       BBSizes[MBB->getNumber()] -= delta;
1715       AdjustBBOffsetsAfter(MBB, -delta);
1716
1717       ++NumTBs;
1718       MadeChange = true;
1719     }
1720   }
1721
1722   return MadeChange;
1723 }
1724
1725 /// ReorderThumb2JumpTables - Adjust the function's block layout to ensure that
1726 /// jump tables always branch forwards, since that's what tbb and tbh need.
1727 bool ARMConstantIslands::ReorderThumb2JumpTables(MachineFunction &MF) {
1728   bool MadeChange = false;
1729
1730   MachineJumpTableInfo *MJTI = MF.getJumpTableInfo();
1731   if (MJTI == 0) return false;
1732
1733   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1734   for (unsigned i = 0, e = T2JumpTables.size(); i != e; ++i) {
1735     MachineInstr *MI = T2JumpTables[i];
1736     const TargetInstrDesc &TID = MI->getDesc();
1737     unsigned NumOps = TID.getNumOperands();
1738     unsigned JTOpIdx = NumOps - (TID.isPredicable() ? 3 : 2);
1739     MachineOperand JTOP = MI->getOperand(JTOpIdx);
1740     unsigned JTI = JTOP.getIndex();
1741     assert(JTI < JT.size());
1742
1743     // We prefer if target blocks for the jump table come after the jump
1744     // instruction so we can use TB[BH]. Loop through the target blocks
1745     // and try to adjust them such that that's true.
1746     int JTNumber = MI->getParent()->getNumber();
1747     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1748     for (unsigned j = 0, ee = JTBBs.size(); j != ee; ++j) {
1749       MachineBasicBlock *MBB = JTBBs[j];
1750       int DTNumber = MBB->getNumber();
1751
1752       if (DTNumber < JTNumber) {
1753         // The destination precedes the switch. Try to move the block forward
1754         // so we have a positive offset.
1755         MachineBasicBlock *NewBB =
1756           AdjustJTTargetBlockForward(MBB, MI->getParent());
1757         if (NewBB)
1758           MJTI->ReplaceMBBInJumpTable(JTI, JTBBs[j], NewBB);
1759         MadeChange = true;
1760       }
1761     }
1762   }
1763
1764   return MadeChange;
1765 }
1766
1767 MachineBasicBlock *ARMConstantIslands::
1768 AdjustJTTargetBlockForward(MachineBasicBlock *BB, MachineBasicBlock *JTBB)
1769 {
1770   MachineFunction &MF = *BB->getParent();
1771
1772   // If it's the destination block is terminated by an unconditional branch,
1773   // try to move it; otherwise, create a new block following the jump
1774   // table that branches back to the actual target. This is a very simple
1775   // heuristic. FIXME: We can definitely improve it.
1776   MachineBasicBlock *TBB = 0, *FBB = 0;
1777   SmallVector<MachineOperand, 4> Cond;
1778   SmallVector<MachineOperand, 4> CondPrior;
1779   MachineFunction::iterator BBi = BB;
1780   MachineFunction::iterator OldPrior = prior(BBi);
1781
1782   // If the block terminator isn't analyzable, don't try to move the block
1783   bool B = TII->AnalyzeBranch(*BB, TBB, FBB, Cond);
1784
1785   // If the block ends in an unconditional branch, move it. The prior block
1786   // has to have an analyzable terminator for us to move this one. Be paranoid
1787   // and make sure we're not trying to move the entry block of the function.
1788   if (!B && Cond.empty() && BB != MF.begin() &&
1789       !TII->AnalyzeBranch(*OldPrior, TBB, FBB, CondPrior)) {
1790     BB->moveAfter(JTBB);
1791     OldPrior->updateTerminator();
1792     BB->updateTerminator();
1793     // Update numbering to account for the block being moved.
1794     MF.RenumberBlocks();
1795     ++NumJTMoved;
1796     return NULL;
1797   }
1798
1799   // Create a new MBB for the code after the jump BB.
1800   MachineBasicBlock *NewBB =
1801     MF.CreateMachineBasicBlock(JTBB->getBasicBlock());
1802   MachineFunction::iterator MBBI = JTBB; ++MBBI;
1803   MF.insert(MBBI, NewBB);
1804
1805   // Add an unconditional branch from NewBB to BB.
1806   // There doesn't seem to be meaningful DebugInfo available; this doesn't
1807   // correspond directly to anything in the source.
1808   assert (isThumb2 && "Adjusting for TB[BH] but not in Thumb2?");
1809   BuildMI(NewBB, DebugLoc(), TII->get(ARM::t2B)).addMBB(BB);
1810
1811   // Update internal data structures to account for the newly inserted MBB.
1812   MF.RenumberBlocks(NewBB);
1813
1814   // Update the CFG.
1815   NewBB->addSuccessor(BB);
1816   JTBB->removeSuccessor(BB);
1817   JTBB->addSuccessor(NewBB);
1818
1819   ++NumJTInserted;
1820   return NewBB;
1821 }