lib/CodeGen/MachineFunction.cpp

   1 //===-- MachineFunction.cpp -----------------------------------------------===//
   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 // Collect native machine code information for a function.  This allows
  11 // target-specific information about the generated code to be stored with each
  12 // function.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/CodeGen/MachineFunction.h"
  17 #include "llvm/ADT/STLExtras.h"
  18 #include "llvm/ADT/SmallString.h"
  19 #include "llvm/Analysis/ConstantFolding.h"
  20 #include "llvm/Assembly/Writer.h"
  21 #include "llvm/CodeGen/MachineConstantPool.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/CodeGen/MachineFunctionPass.h"
  24 #include "llvm/CodeGen/MachineInstr.h"
  25 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  26 #include "llvm/CodeGen/MachineModuleInfo.h"
  27 #include "llvm/CodeGen/MachineRegisterInfo.h"
  28 #include "llvm/CodeGen/Passes.h"
  29 #include "llvm/DebugInfo.h"
  30 #include "llvm/IR/DataLayout.h"
  31 #include "llvm/IR/Function.h"
  32 #include "llvm/MC/MCAsmInfo.h"
  33 #include "llvm/MC/MCContext.h"
  34 #include "llvm/Support/Debug.h"
  35 #include "llvm/Support/GraphWriter.h"
  36 #include "llvm/Support/raw_ostream.h"
  37 #include "llvm/Target/TargetFrameLowering.h"
  38 #include "llvm/Target/TargetLowering.h"
  39 #include "llvm/Target/TargetMachine.h"
  40 using namespace llvm;
  41
  42 //===----------------------------------------------------------------------===//
  43 // MachineFunction implementation
  44 //===----------------------------------------------------------------------===//
  45
  46 // Out of line virtual method.
  47 MachineFunctionInfo::~MachineFunctionInfo() {}
  48
  49 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
  50   MBB->getParent()->DeleteMachineBasicBlock(MBB);
  51 }
  52
  53 MachineFunction::MachineFunction(const Function *F, const TargetMachine &TM,
  54                                  unsigned FunctionNum, MachineModuleInfo &mmi,
  55                                  GCModuleInfo* gmi)
  56   : Fn(F), Target(TM), Ctx(mmi.getContext()), MMI(mmi), GMI(gmi) {
  57   if (TM.getRegisterInfo())
  58     RegInfo = new (Allocator) MachineRegisterInfo(TM);
  59   else
  60     RegInfo = 0;
  61
  62   MFInfo = 0;
  63   FrameInfo =
  64     new (Allocator) MachineFrameInfo(TM,!F->hasFnAttribute("no-realign-stack"));
  65
  66   if (Fn->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
  67                                        Attribute::StackAlignment))
  68     FrameInfo->ensureMaxAlignment(Fn->getAttributes().
  69                                 getStackAlignment(AttributeSet::FunctionIndex));
  70
  71   ConstantPool = new (Allocator) MachineConstantPool(TM);
  72   Alignment = TM.getTargetLowering()->getMinFunctionAlignment();
  73
  74   // FIXME: Shouldn't use pref alignment if explicit alignment is set on Fn.
  75   if (!Fn->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
  76                                         Attribute::OptimizeForSize))
  77     Alignment = std::max(Alignment,
  78                          TM.getTargetLowering()->getPrefFunctionAlignment());
  79
  80   FunctionNumber = FunctionNum;
  81   JumpTableInfo = 0;
  82 }
  83
  84 MachineFunction::~MachineFunction() {
  85   // Don't call destructors on MachineInstr and MachineOperand. All of their
  86   // memory comes from the BumpPtrAllocator which is about to be purged.
  87   //
  88   // Do call MachineBasicBlock destructors, it contains std::vectors.
  89   for (iterator I = begin(), E = end(); I != E; I = BasicBlocks.erase(I))
  90     I->Insts.clearAndLeakNodesUnsafely();
  91
  92   InstructionRecycler.clear(Allocator);
  93   OperandRecycler.clear(Allocator);
  94   BasicBlockRecycler.clear(Allocator);
  95   if (RegInfo) {
  96     RegInfo->~MachineRegisterInfo();
  97     Allocator.Deallocate(RegInfo);
  98   }
  99   if (MFInfo) {
 100     MFInfo->~MachineFunctionInfo();
 101     Allocator.Deallocate(MFInfo);
 102   }
 103
 104   FrameInfo->~MachineFrameInfo();
 105   Allocator.Deallocate(FrameInfo);
 106
 107   ConstantPool->~MachineConstantPool();
 108   Allocator.Deallocate(ConstantPool);
 109
 110   if (JumpTableInfo) {
 111     JumpTableInfo->~MachineJumpTableInfo();
 112     Allocator.Deallocate(JumpTableInfo);
 113   }
 114 }
 115
 116 /// getOrCreateJumpTableInfo - Get the JumpTableInfo for this function, if it
 117 /// does already exist, allocate one.
 118 MachineJumpTableInfo *MachineFunction::
 119 getOrCreateJumpTableInfo(unsigned EntryKind) {
 120   if (JumpTableInfo) return JumpTableInfo;
 121
 122   JumpTableInfo = new (Allocator)
 123     MachineJumpTableInfo((MachineJumpTableInfo::JTEntryKind)EntryKind);
 124   return JumpTableInfo;
 125 }
 126
 127 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
 128 /// recomputes them.  This guarantees that the MBB numbers are sequential,
 129 /// dense, and match the ordering of the blocks within the function.  If a
 130 /// specific MachineBasicBlock is specified, only that block and those after
 131 /// it are renumbered.
 132 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
 133   if (empty()) { MBBNumbering.clear(); return; }
 134   MachineFunction::iterator MBBI, E = end();
 135   if (MBB == 0)
 136     MBBI = begin();
 137   else
 138     MBBI = MBB;
 139
 140   // Figure out the block number this should have.
 141   unsigned BlockNo = 0;
 142   if (MBBI != begin())
 143     BlockNo = prior(MBBI)->getNumber()+1;
 144
 145   for (; MBBI != E; ++MBBI, ++BlockNo) {
 146     if (MBBI->getNumber() != (int)BlockNo) {
 147       // Remove use of the old number.
 148       if (MBBI->getNumber() != -1) {
 149         assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
 150                "MBB number mismatch!");
 151         MBBNumbering[MBBI->getNumber()] = 0;
 152       }
 153
 154       // If BlockNo is already taken, set that block's number to -1.
 155       if (MBBNumbering[BlockNo])
 156         MBBNumbering[BlockNo]->setNumber(-1);
 157
 158       MBBNumbering[BlockNo] = MBBI;
 159       MBBI->setNumber(BlockNo);
 160     }
 161   }
 162
 163   // Okay, all the blocks are renumbered.  If we have compactified the block
 164   // numbering, shrink MBBNumbering now.
 165   assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
 166   MBBNumbering.resize(BlockNo);
 167 }
 168
 169 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
 170 /// of `new MachineInstr'.
 171 ///
 172 MachineInstr *
 173 MachineFunction::CreateMachineInstr(const MCInstrDesc &MCID,
 174                                     DebugLoc DL, bool NoImp) {
 175   return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
 176     MachineInstr(*this, MCID, DL, NoImp);
 177 }
 178
 179 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
 180 /// 'Orig' instruction, identical in all ways except the instruction
 181 /// has no parent, prev, or next.
 182 ///
 183 MachineInstr *
 184 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
 185   return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
 186              MachineInstr(*this, *Orig);
 187 }
 188
 189 /// DeleteMachineInstr - Delete the given MachineInstr.
 190 ///
 191 /// This function also serves as the MachineInstr destructor - the real
 192 /// ~MachineInstr() destructor must be empty.
 193 void
 194 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
 195   // Strip it for parts. The operand array and the MI object itself are
 196   // independently recyclable.
 197   if (MI->Operands)
 198     deallocateOperandArray(MI->CapOperands, MI->Operands);
 199   // Don't call ~MachineInstr() which must be trivial anyway because
 200   // ~MachineFunction drops whole lists of MachineInstrs wihout calling their
 201   // destructors.
 202   InstructionRecycler.Deallocate(Allocator, MI);
 203 }
 204
 205 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
 206 /// instead of `new MachineBasicBlock'.
 207 ///
 208 MachineBasicBlock *
 209 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
 210   return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
 211              MachineBasicBlock(*this, bb);
 212 }
 213
 214 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
 215 ///
 216 void
 217 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
 218   assert(MBB->getParent() == this && "MBB parent mismatch!");
 219   MBB->~MachineBasicBlock();
 220   BasicBlockRecycler.Deallocate(Allocator, MBB);
 221 }
 222
 223 MachineMemOperand *
 224 MachineFunction::getMachineMemOperand(MachinePointerInfo PtrInfo, unsigned f,
 225                                       uint64_t s, unsigned base_alignment,
 226                                       const MDNode *TBAAInfo,
 227                                       const MDNode *Ranges) {
 228   return new (Allocator) MachineMemOperand(PtrInfo, f, s, base_alignment,
 229                                            TBAAInfo, Ranges);
 230 }
 231
 232 MachineMemOperand *
 233 MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
 234                                       int64_t Offset, uint64_t Size) {
 235   return new (Allocator)
 236              MachineMemOperand(MachinePointerInfo(MMO->getValue(),
 237                                                   MMO->getOffset()+Offset),
 238                                MMO->getFlags(), Size,
 239                                MMO->getBaseAlignment(), 0);
 240 }
 241
 242 MachineInstr::mmo_iterator
 243 MachineFunction::allocateMemRefsArray(unsigned long Num) {
 244   return Allocator.Allocate<MachineMemOperand *>(Num);
 245 }
 246
 247 std::pair<MachineInstr::mmo_iterator, MachineInstr::mmo_iterator>
 248 MachineFunction::extractLoadMemRefs(MachineInstr::mmo_iterator Begin,
 249                                     MachineInstr::mmo_iterator End) {
 250   // Count the number of load mem refs.
 251   unsigned Num = 0;
 252   for (MachineInstr::mmo_iterator I = Begin; I != End; ++I)
 253     if ((*I)->isLoad())
 254       ++Num;
 255
 256   // Allocate a new array and populate it with the load information.
 257   MachineInstr::mmo_iterator Result = allocateMemRefsArray(Num);
 258   unsigned Index = 0;
 259   for (MachineInstr::mmo_iterator I = Begin; I != End; ++I) {
 260     if ((*I)->isLoad()) {
 261       if (!(*I)->isStore())
 262         // Reuse the MMO.
 263         Result[Index] = *I;
 264       else {
 265         // Clone the MMO and unset the store flag.
 266         MachineMemOperand *JustLoad =
 267           getMachineMemOperand((*I)->getPointerInfo(),
 268                                (*I)->getFlags() & ~MachineMemOperand::MOStore,
 269                                (*I)->getSize(), (*I)->getBaseAlignment(),
 270                                (*I)->getTBAAInfo());
 271         Result[Index] = JustLoad;
 272       }
 273       ++Index;
 274     }
 275   }
 276   return std::make_pair(Result, Result + Num);
 277 }
 278
 279 std::pair<MachineInstr::mmo_iterator, MachineInstr::mmo_iterator>
 280 MachineFunction::extractStoreMemRefs(MachineInstr::mmo_iterator Begin,
 281                                      MachineInstr::mmo_iterator End) {
 282   // Count the number of load mem refs.
 283   unsigned Num = 0;
 284   for (MachineInstr::mmo_iterator I = Begin; I != End; ++I)
 285     if ((*I)->isStore())
 286       ++Num;
 287
 288   // Allocate a new array and populate it with the store information.
 289   MachineInstr::mmo_iterator Result = allocateMemRefsArray(Num);
 290   unsigned Index = 0;
 291   for (MachineInstr::mmo_iterator I = Begin; I != End; ++I) {
 292     if ((*I)->isStore()) {
 293       if (!(*I)->isLoad())
 294         // Reuse the MMO.
 295         Result[Index] = *I;
 296       else {
 297         // Clone the MMO and unset the load flag.
 298         MachineMemOperand *JustStore =
 299           getMachineMemOperand((*I)->getPointerInfo(),
 300                                (*I)->getFlags() & ~MachineMemOperand::MOLoad,
 301                                (*I)->getSize(), (*I)->getBaseAlignment(),
 302                                (*I)->getTBAAInfo());
 303         Result[Index] = JustStore;
 304       }
 305       ++Index;
 306     }
 307   }
 308   return std::make_pair(Result, Result + Num);
 309 }
 310
 311 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 312 void MachineFunction::dump() const {
 313   print(dbgs());
 314 }
 315 #endif
 316
 317 StringRef MachineFunction::getName() const {
 318   assert(getFunction() && "No function!");
 319   return getFunction()->getName();
 320 }
 321
 322 void MachineFunction::print(raw_ostream &OS, SlotIndexes *Indexes) const {
 323   OS << "# Machine code for function " << getName() << ": ";
 324   if (RegInfo) {
 325     OS << (RegInfo->isSSA() ? "SSA" : "Post SSA");
 326     if (!RegInfo->tracksLiveness())
 327       OS << ", not tracking liveness";
 328   }
 329   OS << '\n';
 330
 331   // Print Frame Information
 332   FrameInfo->print(*this, OS);
 333
 334   // Print JumpTable Information
 335   if (JumpTableInfo)
 336     JumpTableInfo->print(OS);
 337
 338   // Print Constant Pool
 339   ConstantPool->print(OS);
 340
 341   const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
 342
 343   if (RegInfo && !RegInfo->livein_empty()) {
 344     OS << "Function Live Ins: ";
 345     for (MachineRegisterInfo::livein_iterator
 346          I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
 347       OS << PrintReg(I->first, TRI);
 348       if (I->second)
 349         OS << " in " << PrintReg(I->second, TRI);
 350       if (llvm::next(I) != E)
 351         OS << ", ";
 352     }
 353     OS << '\n';
 354   }
 355
 356   for (const_iterator BB = begin(), E = end(); BB != E; ++BB) {
 357     OS << '\n';
 358     BB->print(OS, Indexes);
 359   }
 360
 361   OS << "\n# End machine code for function " << getName() << ".\n\n";
 362 }
 363
 364 namespace llvm {
 365   template<>
 366   struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
 367
 368   DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
 369
 370     static std::string getGraphName(const MachineFunction *F) {
 371       return "CFG for '" + F->getName().str() + "' function";
 372     }
 373
 374     std::string getNodeLabel(const MachineBasicBlock *Node,
 375                              const MachineFunction *Graph) {
 376       std::string OutStr;
 377       {
 378         raw_string_ostream OSS(OutStr);
 379
 380         if (isSimple()) {
 381           OSS << "BB#" << Node->getNumber();
 382           if (const BasicBlock *BB = Node->getBasicBlock())
 383             OSS << ": " << BB->getName();
 384         } else
 385           Node->print(OSS);
 386       }
 387
 388       if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
 389
 390       // Process string output to make it nicer...
 391       for (unsigned i = 0; i != OutStr.length(); ++i)
 392         if (OutStr[i] == '\n') {                            // Left justify
 393           OutStr[i] = '\\';
 394           OutStr.insert(OutStr.begin()+i+1, 'l');
 395         }
 396       return OutStr;
 397     }
 398   };
 399 }
 400
 401 void MachineFunction::viewCFG() const
 402 {
 403 #ifndef NDEBUG
 404   ViewGraph(this, "mf" + getName());
 405 #else
 406   errs() << "MachineFunction::viewCFG is only available in debug builds on "
 407          << "systems with Graphviz or gv!\n";
 408 #endif // NDEBUG
 409 }
 410
 411 void MachineFunction::viewCFGOnly() const
 412 {
 413 #ifndef NDEBUG
 414   ViewGraph(this, "mf" + getName(), true);
 415 #else
 416   errs() << "MachineFunction::viewCFGOnly is only available in debug builds on "
 417          << "systems with Graphviz or gv!\n";
 418 #endif // NDEBUG
 419 }
 420
 421 /// addLiveIn - Add the specified physical register as a live-in value and
 422 /// create a corresponding virtual register for it.
 423 unsigned MachineFunction::addLiveIn(unsigned PReg,
 424                                     const TargetRegisterClass *RC) {
 425   MachineRegisterInfo &MRI = getRegInfo();
 426   unsigned VReg = MRI.getLiveInVirtReg(PReg);
 427   if (VReg) {
 428     const TargetRegisterClass *VRegRC = MRI.getRegClass(VReg);
 429     (void)VRegRC;
 430     // A physical register can be added several times.
 431     // Between two calls, the register class of the related virtual register
 432     // may have been constrained to match some operation constraints.
 433     // In that case, check that the current register class includes the
 434     // physical register and is a sub class of the specified RC.
 435     assert((VRegRC == RC || (VRegRC->contains(PReg) &&
 436                              RC->hasSubClassEq(VRegRC))) &&
 437             "Register class mismatch!");
 438     return VReg;
 439   }
 440   VReg = MRI.createVirtualRegister(RC);
 441   MRI.addLiveIn(PReg, VReg);
 442   return VReg;
 443 }
 444
 445 /// getJTISymbol - Return the MCSymbol for the specified non-empty jump table.
 446 /// If isLinkerPrivate is specified, an 'l' label is returned, otherwise a
 447 /// normal 'L' label is returned.
 448 MCSymbol *MachineFunction::getJTISymbol(unsigned JTI, MCContext &Ctx,
 449                                         bool isLinkerPrivate) const {
 450   assert(JumpTableInfo && "No jump tables");
 451   assert(JTI < JumpTableInfo->getJumpTables().size() && "Invalid JTI!");
 452   const MCAsmInfo &MAI = *getTarget().getMCAsmInfo();
 453
 454   const char *Prefix = isLinkerPrivate ? MAI.getLinkerPrivateGlobalPrefix() :
 455                                          MAI.getPrivateGlobalPrefix();
 456   SmallString<60> Name;
 457   raw_svector_ostream(Name)
 458     << Prefix << "JTI" << getFunctionNumber() << '_' << JTI;
 459   return Ctx.GetOrCreateSymbol(Name.str());
 460 }
 461
 462 /// getPICBaseSymbol - Return a function-local symbol to represent the PIC
 463 /// base.
 464 MCSymbol *MachineFunction::getPICBaseSymbol() const {
 465   const MCAsmInfo &MAI = *Target.getMCAsmInfo();
 466   return Ctx.GetOrCreateSymbol(Twine(MAI.getPrivateGlobalPrefix())+
 467                                Twine(getFunctionNumber())+"$pb");
 468 }
 469
 470 //===----------------------------------------------------------------------===//
 471 //  MachineFrameInfo implementation
 472 //===----------------------------------------------------------------------===//
 473
 474 const TargetFrameLowering *MachineFrameInfo::getFrameLowering() const {
 475   return TM.getFrameLowering();
 476 }
 477
 478 /// ensureMaxAlignment - Make sure the function is at least Align bytes
 479 /// aligned.
 480 void MachineFrameInfo::ensureMaxAlignment(unsigned Align) {
 481   if (!getFrameLowering()->isStackRealignable() || !RealignOption)
 482     assert(Align <= getFrameLowering()->getStackAlignment() &&
 483            "For targets without stack realignment, Align is out of limit!");
 484   if (MaxAlignment < Align) MaxAlignment = Align;
 485 }
 486
 487 /// clampStackAlignment - Clamp the alignment if requested and emit a warning.
 488 static inline unsigned clampStackAlignment(bool ShouldClamp, unsigned Align,
 489                                            unsigned StackAlign) {
 490   if (!ShouldClamp || Align <= StackAlign)
 491     return Align;
 492   DEBUG(dbgs() << "Warning: requested alignment " << Align
 493                << " exceeds the stack alignment " << StackAlign
 494                << " when stack realignment is off" << '\n');
 495   return StackAlign;
 496 }
 497
 498 /// CreateStackObject - Create a new statically sized stack object, returning
 499 /// a nonnegative identifier to represent it.
 500 ///
 501 int MachineFrameInfo::CreateStackObject(uint64_t Size, unsigned Alignment,
 502                       bool isSS, bool MayNeedSP, const AllocaInst *Alloca) {
 503   assert(Size != 0 && "Cannot allocate zero size stack objects!");
 504   Alignment =
 505     clampStackAlignment(!getFrameLowering()->isStackRealignable() ||
 506                           !RealignOption,
 507                         Alignment, getFrameLowering()->getStackAlignment());
 508   Objects.push_back(StackObject(Size, Alignment, 0, false, isSS, MayNeedSP,
 509                                 Alloca));
 510   int Index = (int)Objects.size() - NumFixedObjects - 1;
 511   assert(Index >= 0 && "Bad frame index!");
 512   ensureMaxAlignment(Alignment);
 513   return Index;
 514 }
 515
 516 /// CreateSpillStackObject - Create a new statically sized stack object that
 517 /// represents a spill slot, returning a nonnegative identifier to represent
 518 /// it.
 519 ///
 520 int MachineFrameInfo::CreateSpillStackObject(uint64_t Size,
 521                                              unsigned Alignment) {
 522   Alignment =
 523     clampStackAlignment(!getFrameLowering()->isStackRealignable() ||
 524                           !RealignOption,
 525                         Alignment, getFrameLowering()->getStackAlignment());
 526   CreateStackObject(Size, Alignment, true, false);
 527   int Index = (int)Objects.size() - NumFixedObjects - 1;
 528   ensureMaxAlignment(Alignment);
 529   return Index;
 530 }
 531
 532 /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 533 /// variable sized object has been created.  This must be created whenever a
 534 /// variable sized object is created, whether or not the index returned is
 535 /// actually used.
 536 ///
 537 int MachineFrameInfo::CreateVariableSizedObject(unsigned Alignment) {
 538   HasVarSizedObjects = true;
 539   Alignment =
 540     clampStackAlignment(!getFrameLowering()->isStackRealignable() ||
 541                           !RealignOption,
 542                         Alignment, getFrameLowering()->getStackAlignment());
 543   Objects.push_back(StackObject(0, Alignment, 0, false, false, true, 0));
 544   ensureMaxAlignment(Alignment);
 545   return (int)Objects.size()-NumFixedObjects-1;
 546 }
 547
 548 /// CreateFixedObject - Create a new object at a fixed location on the stack.
 549 /// All fixed objects should be created before other objects are created for
 550 /// efficiency. By default, fixed objects are immutable. This returns an
 551 /// index with a negative value.
 552 ///
 553 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
 554                                         bool Immutable) {
 555   assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
 556   // The alignment of the frame index can be determined from its offset from
 557   // the incoming frame position.  If the frame object is at offset 32 and
 558   // the stack is guaranteed to be 16-byte aligned, then we know that the
 559   // object is 16-byte aligned.
 560   unsigned StackAlign = getFrameLowering()->getStackAlignment();
 561   unsigned Align = MinAlign(SPOffset, StackAlign);
 562   Align =
 563     clampStackAlignment(!getFrameLowering()->isStackRealignable() ||
 564                           !RealignOption,
 565                         Align, getFrameLowering()->getStackAlignment());
 566   Objects.insert(Objects.begin(), StackObject(Size, Align, SPOffset, Immutable,
 567                                               /*isSS*/   false,
 568                                               /*NeedSP*/ false,
 569                                               /*Alloca*/ 0));
 570   return -++NumFixedObjects;
 571 }
 572
 573
 574 BitVector
 575 MachineFrameInfo::getPristineRegs(const MachineBasicBlock *MBB) const {
 576   assert(MBB && "MBB must be valid");
 577   const MachineFunction *MF = MBB->getParent();
 578   assert(MF && "MBB must be part of a MachineFunction");
 579   const TargetMachine &TM = MF->getTarget();
 580   const TargetRegisterInfo *TRI = TM.getRegisterInfo();
 581   BitVector BV(TRI->getNumRegs());
 582
 583   // Before CSI is calculated, no registers are considered pristine. They can be
 584   // freely used and PEI will make sure they are saved.
 585   if (!isCalleeSavedInfoValid())
 586     return BV;
 587
 588   for (const uint16_t *CSR = TRI->getCalleeSavedRegs(MF); CSR && *CSR; ++CSR)
 589     BV.set(*CSR);
 590
 591   // The entry MBB always has all CSRs pristine.
 592   if (MBB == &MF->front())
 593     return BV;
 594
 595   // On other MBBs the saved CSRs are not pristine.
 596   const std::vector<CalleeSavedInfo> &CSI = getCalleeSavedInfo();
 597   for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
 598          E = CSI.end(); I != E; ++I)
 599     BV.reset(I->getReg());
 600
 601   return BV;
 602 }
 603
 604 unsigned MachineFrameInfo::estimateStackSize(const MachineFunction &MF) const {
 605   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
 606   const TargetRegisterInfo *RegInfo = MF.getTarget().getRegisterInfo();
 607   unsigned MaxAlign = getMaxAlignment();
 608   int Offset = 0;
 609
 610   // This code is very, very similar to PEI::calculateFrameObjectOffsets().
 611   // It really should be refactored to share code. Until then, changes
 612   // should keep in mind that there's tight coupling between the two.
 613
 614   for (int i = getObjectIndexBegin(); i != 0; ++i) {
 615     int FixedOff = -getObjectOffset(i);
 616     if (FixedOff > Offset) Offset = FixedOff;
 617   }
 618   for (unsigned i = 0, e = getObjectIndexEnd(); i != e; ++i) {
 619     if (isDeadObjectIndex(i))
 620       continue;
 621     Offset += getObjectSize(i);
 622     unsigned Align = getObjectAlignment(i);
 623     // Adjust to alignment boundary
 624     Offset = (Offset+Align-1)/Align*Align;
 625
 626     MaxAlign = std::max(Align, MaxAlign);
 627   }
 628
 629   if (adjustsStack() && TFI->hasReservedCallFrame(MF))
 630     Offset += getMaxCallFrameSize();
 631
 632   // Round up the size to a multiple of the alignment.  If the function has
 633   // any calls or alloca's, align to the target's StackAlignment value to
 634   // ensure that the callee's frame or the alloca data is suitably aligned;
 635   // otherwise, for leaf functions, align to the TransientStackAlignment
 636   // value.
 637   unsigned StackAlign;
 638   if (adjustsStack() || hasVarSizedObjects() ||
 639       (RegInfo->needsStackRealignment(MF) && getObjectIndexEnd() != 0))
 640     StackAlign = TFI->getStackAlignment();
 641   else
 642     StackAlign = TFI->getTransientStackAlignment();
 643
 644   // If the frame pointer is eliminated, all frame offsets will be relative to
 645   // SP not FP. Align to MaxAlign so this works.
 646   StackAlign = std::max(StackAlign, MaxAlign);
 647   unsigned AlignMask = StackAlign - 1;
 648   Offset = (Offset + AlignMask) & ~uint64_t(AlignMask);
 649
 650   return (unsigned)Offset;
 651 }
 652
 653 void MachineFrameInfo::print(const MachineFunction &MF, raw_ostream &OS) const{
 654   if (Objects.empty()) return;
 655
 656   const TargetFrameLowering *FI = MF.getTarget().getFrameLowering();
 657   int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
 658
 659   OS << "Frame Objects:\n";
 660
 661   for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
 662     const StackObject &SO = Objects[i];
 663     OS << "  fi#" << (int)(i-NumFixedObjects) << ": ";
 664     if (SO.Size == ~0ULL) {
 665       OS << "dead\n";
 666       continue;
 667     }
 668     if (SO.Size == 0)
 669       OS << "variable sized";
 670     else
 671       OS << "size=" << SO.Size;
 672     OS << ", align=" << SO.Alignment;
 673
 674     if (i < NumFixedObjects)
 675       OS << ", fixed";
 676     if (i < NumFixedObjects || SO.SPOffset != -1) {
 677       int64_t Off = SO.SPOffset - ValOffset;
 678       OS << ", at location [SP";
 679       if (Off > 0)
 680         OS << "+" << Off;
 681       else if (Off < 0)
 682         OS << Off;
 683       OS << "]";
 684     }
 685     OS << "\n";
 686   }
 687 }
 688
 689 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 690 void MachineFrameInfo::dump(const MachineFunction &MF) const {
 691   print(MF, dbgs());
 692 }
 693 #endif
 694
 695 //===----------------------------------------------------------------------===//
 696 //  MachineJumpTableInfo implementation
 697 //===----------------------------------------------------------------------===//
 698
 699 /// getEntrySize - Return the size of each entry in the jump table.
 700 unsigned MachineJumpTableInfo::getEntrySize(const DataLayout &TD) const {
 701   // The size of a jump table entry is 4 bytes unless the entry is just the
 702   // address of a block, in which case it is the pointer size.
 703   switch (getEntryKind()) {
 704   case MachineJumpTableInfo::EK_BlockAddress:
 705     return TD.getPointerSize();
 706   case MachineJumpTableInfo::EK_GPRel64BlockAddress:
 707     return 8;
 708   case MachineJumpTableInfo::EK_GPRel32BlockAddress:
 709   case MachineJumpTableInfo::EK_LabelDifference32:
 710   case MachineJumpTableInfo::EK_Custom32:
 711     return 4;
 712   case MachineJumpTableInfo::EK_Inline:
 713     return 0;
 714   }
 715   llvm_unreachable("Unknown jump table encoding!");
 716 }
 717
 718 /// getEntryAlignment - Return the alignment of each entry in the jump table.
 719 unsigned MachineJumpTableInfo::getEntryAlignment(const DataLayout &TD) const {
 720   // The alignment of a jump table entry is the alignment of int32 unless the
 721   // entry is just the address of a block, in which case it is the pointer
 722   // alignment.
 723   switch (getEntryKind()) {
 724   case MachineJumpTableInfo::EK_BlockAddress:
 725     return TD.getPointerABIAlignment();
 726   case MachineJumpTableInfo::EK_GPRel64BlockAddress:
 727     return TD.getABIIntegerTypeAlignment(64);
 728   case MachineJumpTableInfo::EK_GPRel32BlockAddress:
 729   case MachineJumpTableInfo::EK_LabelDifference32:
 730   case MachineJumpTableInfo::EK_Custom32:
 731     return TD.getABIIntegerTypeAlignment(32);
 732   case MachineJumpTableInfo::EK_Inline:
 733     return 1;
 734   }
 735   llvm_unreachable("Unknown jump table encoding!");
 736 }
 737
 738 /// createJumpTableIndex - Create a new jump table entry in the jump table info.
 739 ///
 740 unsigned MachineJumpTableInfo::createJumpTableIndex(
 741                                const std::vector<MachineBasicBlock*> &DestBBs) {
 742   assert(!DestBBs.empty() && "Cannot create an empty jump table!");
 743   JumpTables.push_back(MachineJumpTableEntry(DestBBs));
 744   return JumpTables.size()-1;
 745 }
 746
 747 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
 748 /// the jump tables to branch to New instead.
 749 bool MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
 750                                                   MachineBasicBlock *New) {
 751   assert(Old != New && "Not making a change?");
 752   bool MadeChange = false;
 753   for (size_t i = 0, e = JumpTables.size(); i != e; ++i)
 754     ReplaceMBBInJumpTable(i, Old, New);
 755   return MadeChange;
 756 }
 757
 758 /// ReplaceMBBInJumpTable - If Old is a target of the jump tables, update
 759 /// the jump table to branch to New instead.
 760 bool MachineJumpTableInfo::ReplaceMBBInJumpTable(unsigned Idx,
 761                                                  MachineBasicBlock *Old,
 762                                                  MachineBasicBlock *New) {
 763   assert(Old != New && "Not making a change?");
 764   bool MadeChange = false;
 765   MachineJumpTableEntry &JTE = JumpTables[Idx];
 766   for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
 767     if (JTE.MBBs[j] == Old) {
 768       JTE.MBBs[j] = New;
 769       MadeChange = true;
 770     }
 771   return MadeChange;
 772 }
 773
 774 void MachineJumpTableInfo::print(raw_ostream &OS) const {
 775   if (JumpTables.empty()) return;
 776
 777   OS << "Jump Tables:\n";
 778
 779   for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
 780     OS << "  jt#" << i << ": ";
 781     for (unsigned j = 0, f = JumpTables[i].MBBs.size(); j != f; ++j)
 782       OS << " BB#" << JumpTables[i].MBBs[j]->getNumber();
 783   }
 784
 785   OS << '\n';
 786 }
 787
 788 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 789 void MachineJumpTableInfo::dump() const { print(dbgs()); }
 790 #endif
 791
 792
 793 //===----------------------------------------------------------------------===//
 794 //  MachineConstantPool implementation
 795 //===----------------------------------------------------------------------===//
 796
 797 void MachineConstantPoolValue::anchor() { }
 798
 799 const DataLayout *MachineConstantPool::getDataLayout() const {
 800   return TM.getDataLayout();
 801 }
 802
 803 Type *MachineConstantPoolEntry::getType() const {
 804   if (isMachineConstantPoolEntry())
 805     return Val.MachineCPVal->getType();
 806   return Val.ConstVal->getType();
 807 }
 808
 809
 810 unsigned MachineConstantPoolEntry::getRelocationInfo() const {
 811   if (isMachineConstantPoolEntry())
 812     return Val.MachineCPVal->getRelocationInfo();
 813   return Val.ConstVal->getRelocationInfo();
 814 }
 815
 816 MachineConstantPool::~MachineConstantPool() {
 817   for (unsigned i = 0, e = Constants.size(); i != e; ++i)
 818     if (Constants[i].isMachineConstantPoolEntry())
 819       delete Constants[i].Val.MachineCPVal;
 820   for (DenseSet<MachineConstantPoolValue*>::iterator I =
 821        MachineCPVsSharingEntries.begin(), E = MachineCPVsSharingEntries.end();
 822        I != E; ++I)
 823     delete *I;
 824 }
 825
 826 /// CanShareConstantPoolEntry - Test whether the given two constants
 827 /// can be allocated the same constant pool entry.
 828 static bool CanShareConstantPoolEntry(const Constant *A, const Constant *B,
 829                                       const DataLayout *TD) {
 830   // Handle the trivial case quickly.
 831   if (A == B) return true;
 832
 833   // If they have the same type but weren't the same constant, quickly
 834   // reject them.
 835   if (A->getType() == B->getType()) return false;
 836
 837   // We can't handle structs or arrays.
 838   if (isa<StructType>(A->getType()) || isa<ArrayType>(A->getType()) ||
 839       isa<StructType>(B->getType()) || isa<ArrayType>(B->getType()))
 840     return false;
 841
 842   // For now, only support constants with the same size.
 843   uint64_t StoreSize = TD->getTypeStoreSize(A->getType());
 844   if (StoreSize != TD->getTypeStoreSize(B->getType()) ||
 845       StoreSize > 128)
 846     return false;
 847
 848   Type *IntTy = IntegerType::get(A->getContext(), StoreSize*8);
 849
 850   // Try constant folding a bitcast of both instructions to an integer.  If we
 851   // get two identical ConstantInt's, then we are good to share them.  We use
 852   // the constant folding APIs to do this so that we get the benefit of
 853   // DataLayout.
 854   if (isa<PointerType>(A->getType()))
 855     A = ConstantFoldInstOperands(Instruction::PtrToInt, IntTy,
 856                                  const_cast<Constant*>(A), TD);
 857   else if (A->getType() != IntTy)
 858     A = ConstantFoldInstOperands(Instruction::BitCast, IntTy,
 859                                  const_cast<Constant*>(A), TD);
 860   if (isa<PointerType>(B->getType()))
 861     B = ConstantFoldInstOperands(Instruction::PtrToInt, IntTy,
 862                                  const_cast<Constant*>(B), TD);
 863   else if (B->getType() != IntTy)
 864     B = ConstantFoldInstOperands(Instruction::BitCast, IntTy,
 865                                  const_cast<Constant*>(B), TD);
 866
 867   return A == B;
 868 }
 869
 870 /// getConstantPoolIndex - Create a new entry in the constant pool or return
 871 /// an existing one.  User must specify the log2 of the minimum required
 872 /// alignment for the object.
 873 ///
 874 unsigned MachineConstantPool::getConstantPoolIndex(const Constant *C,
 875                                                    unsigned Alignment) {
 876   assert(Alignment && "Alignment must be specified!");
 877   if (Alignment > PoolAlignment) PoolAlignment = Alignment;
 878
 879   // Check to see if we already have this constant.
 880   //
 881   // FIXME, this could be made much more efficient for large constant pools.
 882   for (unsigned i = 0, e = Constants.size(); i != e; ++i)
 883     if (!Constants[i].isMachineConstantPoolEntry() &&
 884         CanShareConstantPoolEntry(Constants[i].Val.ConstVal, C,
 885                                   getDataLayout())) {
 886       if ((unsigned)Constants[i].getAlignment() < Alignment)
 887         Constants[i].Alignment = Alignment;
 888       return i;
 889     }
 890
 891   Constants.push_back(MachineConstantPoolEntry(C, Alignment));
 892   return Constants.size()-1;
 893 }
 894
 895 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
 896                                                    unsigned Alignment) {
 897   assert(Alignment && "Alignment must be specified!");
 898   if (Alignment > PoolAlignment) PoolAlignment = Alignment;
 899
 900   // Check to see if we already have this constant.
 901   //
 902   // FIXME, this could be made much more efficient for large constant pools.
 903   int Idx = V->getExistingMachineCPValue(this, Alignment);
 904   if (Idx != -1) {
 905     MachineCPVsSharingEntries.insert(V);
 906     return (unsigned)Idx;
 907   }
 908
 909   Constants.push_back(MachineConstantPoolEntry(V, Alignment));
 910   return Constants.size()-1;
 911 }
 912
 913 void MachineConstantPool::print(raw_ostream &OS) const {
 914   if (Constants.empty()) return;
 915
 916   OS << "Constant Pool:\n";
 917   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
 918     OS << "  cp#" << i << ": ";
 919     if (Constants[i].isMachineConstantPoolEntry())
 920       Constants[i].Val.MachineCPVal->print(OS);
 921     else
 922       WriteAsOperand(OS, Constants[i].Val.ConstVal, /*PrintType=*/false);
 923     OS << ", align=" << Constants[i].getAlignment();
 924     OS << "\n";
 925   }
 926 }
 927
 928 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 929 void MachineConstantPool::dump() const { print(dbgs()); }
 930 #endif