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