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