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/DerivedTypes.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/ADT/STLExtras.h"
  20 #include "llvm/Config/config.h"
  21 #include "llvm/CodeGen/MachineConstantPool.h"
  22 #include "llvm/CodeGen/MachineFunction.h"
  23 #include "llvm/CodeGen/MachineFunctionPass.h"
  24 #include "llvm/CodeGen/MachineFrameInfo.h"
  25 #include "llvm/CodeGen/MachineInstr.h"
  26 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  27 #include "llvm/CodeGen/MachineRegisterInfo.h"
  28 #include "llvm/CodeGen/Passes.h"
  29 #include "llvm/Target/TargetData.h"
  30 #include "llvm/Target/TargetLowering.h"
  31 #include "llvm/Target/TargetMachine.h"
  32 #include "llvm/Target/TargetFrameInfo.h"
  33 #include "llvm/Support/Compiler.h"
  34 #include "llvm/Support/GraphWriter.h"
  35 #include "llvm/Support/raw_ostream.h"
  36 #include <fstream>
  37 #include <sstream>
  38 using namespace llvm;
  39
  40 namespace {
  41   struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
  42     static char ID;
  43
  44     std::ostream *OS;
  45     const std::string Banner;
  46
  47     Printer (std::ostream *os, const std::string &banner)
  48       : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
  49
  50     const char *getPassName() const { return "MachineFunction Printer"; }
  51
  52     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  53       AU.setPreservesAll();
  54       MachineFunctionPass::getAnalysisUsage(AU);
  55     }
  56
  57     bool runOnMachineFunction(MachineFunction &MF) {
  58       (*OS) << Banner;
  59       MF.print (*OS);
  60       return false;
  61     }
  62   };
  63   char Printer::ID = 0;
  64 }
  65
  66 /// Returns a newly-created MachineFunction Printer pass. The default banner is
  67 /// empty.
  68 ///
  69 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
  70                                                      const std::string &Banner){
  71   return new Printer(OS, Banner);
  72 }
  73
  74 //===---------------------------------------------------------------------===//
  75 // MachineFunction implementation
  76 //===---------------------------------------------------------------------===//
  77
  78 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
  79   MBB->getParent()->DeleteMachineBasicBlock(MBB);
  80 }
  81
  82 MachineFunction::MachineFunction(Function *F,
  83                                  const TargetMachine &TM)
  84   : Fn(F), Target(TM) {
  85   if (TM.getRegisterInfo())
  86     RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
  87                   MachineRegisterInfo(*TM.getRegisterInfo());
  88   else
  89     RegInfo = 0;
  90   MFInfo = 0;
  91   FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
  92                   MachineFrameInfo(*TM.getFrameInfo());
  93   ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
  94                      MachineConstantPool(TM.getTargetData());
  95   Alignment = TM.getTargetLowering()->getFunctionAlignment(F);
  96
  97   // Set up jump table.
  98   const TargetData &TD = *TM.getTargetData();
  99   bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
 100   unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
 101   unsigned TyAlignment = IsPic ?
 102                        TD.getABITypeAlignment(Type::getInt32Ty(F->getContext()))
 103                                : TD.getPointerABIAlignment();
 104   JumpTableInfo = new (Allocator.Allocate<MachineJumpTableInfo>())
 105                       MachineJumpTableInfo(EntrySize, TyAlignment);
 106 }
 107
 108 MachineFunction::~MachineFunction() {
 109   BasicBlocks.clear();
 110   InstructionRecycler.clear(Allocator);
 111   BasicBlockRecycler.clear(Allocator);
 112   if (RegInfo) {
 113     RegInfo->~MachineRegisterInfo();
 114     Allocator.Deallocate(RegInfo);
 115   }
 116   if (MFInfo) {
 117     MFInfo->~MachineFunctionInfo();
 118     Allocator.Deallocate(MFInfo);
 119   }
 120   FrameInfo->~MachineFrameInfo();         Allocator.Deallocate(FrameInfo);
 121   ConstantPool->~MachineConstantPool();   Allocator.Deallocate(ConstantPool);
 122   JumpTableInfo->~MachineJumpTableInfo(); Allocator.Deallocate(JumpTableInfo);
 123 }
 124
 125
 126 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
 127 /// recomputes them.  This guarantees that the MBB numbers are sequential,
 128 /// dense, and match the ordering of the blocks within the function.  If a
 129 /// specific MachineBasicBlock is specified, only that block and those after
 130 /// it are renumbered.
 131 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
 132   if (empty()) { MBBNumbering.clear(); return; }
 133   MachineFunction::iterator MBBI, E = end();
 134   if (MBB == 0)
 135     MBBI = begin();
 136   else
 137     MBBI = MBB;
 138
 139   // Figure out the block number this should have.
 140   unsigned BlockNo = 0;
 141   if (MBBI != begin())
 142     BlockNo = prior(MBBI)->getNumber()+1;
 143
 144   for (; MBBI != E; ++MBBI, ++BlockNo) {
 145     if (MBBI->getNumber() != (int)BlockNo) {
 146       // Remove use of the old number.
 147       if (MBBI->getNumber() != -1) {
 148         assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
 149                "MBB number mismatch!");
 150         MBBNumbering[MBBI->getNumber()] = 0;
 151       }
 152
 153       // If BlockNo is already taken, set that block's number to -1.
 154       if (MBBNumbering[BlockNo])
 155         MBBNumbering[BlockNo]->setNumber(-1);
 156
 157       MBBNumbering[BlockNo] = MBBI;
 158       MBBI->setNumber(BlockNo);
 159     }
 160   }
 161
 162   // Okay, all the blocks are renumbered.  If we have compactified the block
 163   // numbering, shrink MBBNumbering now.
 164   assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
 165   MBBNumbering.resize(BlockNo);
 166 }
 167
 168 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
 169 /// of `new MachineInstr'.
 170 ///
 171 MachineInstr *
 172 MachineFunction::CreateMachineInstr(const TargetInstrDesc &TID,
 173                                     DebugLoc DL, bool NoImp) {
 174   return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
 175     MachineInstr(TID, DL, NoImp);
 176 }
 177
 178 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
 179 /// 'Orig' instruction, identical in all ways except the the instruction
 180 /// has no parent, prev, or next.
 181 ///
 182 MachineInstr *
 183 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
 184   return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
 185              MachineInstr(*this, *Orig);
 186 }
 187
 188 /// DeleteMachineInstr - Delete the given MachineInstr.
 189 ///
 190 void
 191 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
 192   // Clear the instructions memoperands. This must be done manually because
 193   // the instruction's parent pointer is now null, so it can't properly
 194   // deallocate them on its own.
 195   MI->clearMemOperands(*this);
 196
 197   MI->~MachineInstr();
 198   InstructionRecycler.Deallocate(Allocator, MI);
 199 }
 200
 201 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
 202 /// instead of `new MachineBasicBlock'.
 203 ///
 204 MachineBasicBlock *
 205 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
 206   return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
 207              MachineBasicBlock(*this, bb);
 208 }
 209
 210 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
 211 ///
 212 void
 213 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
 214   assert(MBB->getParent() == this && "MBB parent mismatch!");
 215   MBB->~MachineBasicBlock();
 216   BasicBlockRecycler.Deallocate(Allocator, MBB);
 217 }
 218
 219 void MachineFunction::dump() const {
 220   print(*cerr.stream());
 221 }
 222
 223 void MachineFunction::print(std::ostream &OS) const {
 224   OS << "# Machine code for " << Fn->getNameStr() << "():\n";
 225
 226   // Print Frame Information
 227   FrameInfo->print(*this, OS);
 228
 229   // Print JumpTable Information
 230   JumpTableInfo->print(OS);
 231
 232   // Print Constant Pool
 233   {
 234     raw_os_ostream OSS(OS);
 235     ConstantPool->print(OSS);
 236   }
 237
 238   const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
 239
 240   if (RegInfo && !RegInfo->livein_empty()) {
 241     OS << "Live Ins:";
 242     for (MachineRegisterInfo::livein_iterator
 243          I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
 244       if (TRI)
 245         OS << " " << TRI->getName(I->first);
 246       else
 247         OS << " Reg #" << I->first;
 248
 249       if (I->second)
 250         OS << " in VR#" << I->second << " ";
 251     }
 252     OS << "\n";
 253   }
 254   if (RegInfo && !RegInfo->liveout_empty()) {
 255     OS << "Live Outs:";
 256     for (MachineRegisterInfo::liveout_iterator
 257          I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
 258       if (TRI)
 259         OS << " " << TRI->getName(*I);
 260       else
 261         OS << " Reg #" << *I;
 262     OS << "\n";
 263   }
 264
 265   for (const_iterator BB = begin(), E = end(); BB != E; ++BB)
 266     BB->print(OS);
 267
 268   OS << "\n# End machine code for " << Fn->getNameStr() << "().\n\n";
 269 }
 270
 271 namespace llvm {
 272   template<>
 273   struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
 274     static std::string getGraphName(const MachineFunction *F) {
 275       return "CFG for '" + F->getFunction()->getNameStr() + "' function";
 276     }
 277
 278     static std::string getNodeLabel(const MachineBasicBlock *Node,
 279                                     const MachineFunction *Graph,
 280                                     bool ShortNames) {
 281       if (ShortNames && Node->getBasicBlock() &&
 282           !Node->getBasicBlock()->getName().empty())
 283         return Node->getBasicBlock()->getNameStr() + ":";
 284
 285       std::ostringstream Out;
 286       if (ShortNames) {
 287         Out << Node->getNumber() << ':';
 288         return Out.str();
 289       }
 290
 291       Node->print(Out);
 292
 293       std::string OutStr = Out.str();
 294       if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
 295
 296       // Process string output to make it nicer...
 297       for (unsigned i = 0; i != OutStr.length(); ++i)
 298         if (OutStr[i] == '\n') {                            // Left justify
 299           OutStr[i] = '\\';
 300           OutStr.insert(OutStr.begin()+i+1, 'l');
 301         }
 302       return OutStr;
 303     }
 304   };
 305 }
 306
 307 void MachineFunction::viewCFG() const
 308 {
 309 #ifndef NDEBUG
 310   ViewGraph(this, "mf" + getFunction()->getNameStr());
 311 #else
 312   cerr << "SelectionDAG::viewGraph is only available in debug builds on "
 313        << "systems with Graphviz or gv!\n";
 314 #endif // NDEBUG
 315 }
 316
 317 void MachineFunction::viewCFGOnly() const
 318 {
 319 #ifndef NDEBUG
 320   ViewGraph(this, "mf" + getFunction()->getNameStr(), true);
 321 #else
 322   cerr << "SelectionDAG::viewGraph is only available in debug builds on "
 323        << "systems with Graphviz or gv!\n";
 324 #endif // NDEBUG
 325 }
 326
 327 /// addLiveIn - Add the specified physical register as a live-in value and
 328 /// create a corresponding virtual register for it.
 329 unsigned MachineFunction::addLiveIn(unsigned PReg,
 330                                     const TargetRegisterClass *RC) {
 331   assert(RC->contains(PReg) && "Not the correct regclass!");
 332   unsigned VReg = getRegInfo().createVirtualRegister(RC);
 333   getRegInfo().addLiveIn(PReg, VReg);
 334   return VReg;
 335 }
 336
 337 /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
 338 /// source file, line, and column. If none currently exists, create a new
 339 /// DebugLocTuple, and insert it into the DebugIdMap.
 340 unsigned MachineFunction::getOrCreateDebugLocID(GlobalVariable *CompileUnit,
 341                                                 unsigned Line, unsigned Col) {
 342   DebugLocTuple Tuple(CompileUnit, Line, Col);
 343   DenseMap<DebugLocTuple, unsigned>::iterator II
 344     = DebugLocInfo.DebugIdMap.find(Tuple);
 345   if (II != DebugLocInfo.DebugIdMap.end())
 346     return II->second;
 347   // Add a new tuple.
 348   unsigned Id = DebugLocInfo.DebugLocations.size();
 349   DebugLocInfo.DebugLocations.push_back(Tuple);
 350   DebugLocInfo.DebugIdMap[Tuple] = Id;
 351   return Id;
 352 }
 353
 354 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
 355 DebugLocTuple MachineFunction::getDebugLocTuple(DebugLoc DL) const {
 356   unsigned Idx = DL.getIndex();
 357   assert(Idx < DebugLocInfo.DebugLocations.size() &&
 358          "Invalid index into debug locations!");
 359   return DebugLocInfo.DebugLocations[Idx];
 360 }
 361
 362 //===----------------------------------------------------------------------===//
 363 //  MachineFrameInfo implementation
 364 //===----------------------------------------------------------------------===//
 365
 366 /// CreateFixedObject - Create a new object at a fixed location on the stack.
 367 /// All fixed objects should be created before other objects are created for
 368 /// efficiency. By default, fixed objects are immutable. This returns an
 369 /// index with a negative value.
 370 ///
 371 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
 372                                         bool Immutable) {
 373   assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
 374   Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
 375   return -++NumFixedObjects;
 376 }
 377
 378
 379 BitVector
 380 MachineFrameInfo::getPristineRegs(const MachineBasicBlock *MBB) const {
 381   assert(MBB && "MBB must be valid");
 382   const MachineFunction *MF = MBB->getParent();
 383   assert(MF && "MBB must be part of a MachineFunction");
 384   const TargetMachine &TM = MF->getTarget();
 385   const TargetRegisterInfo *TRI = TM.getRegisterInfo();
 386   BitVector BV(TRI->getNumRegs());
 387
 388   // Before CSI is calculated, no registers are considered pristine. They can be
 389   // freely used and PEI will make sure they are saved.
 390   if (!isCalleeSavedInfoValid())
 391     return BV;
 392
 393   for (const unsigned *CSR = TRI->getCalleeSavedRegs(MF); CSR && *CSR; ++CSR)
 394     BV.set(*CSR);
 395
 396   // The entry MBB always has all CSRs pristine.
 397   if (MBB == &MF->front())
 398     return BV;
 399
 400   // On other MBBs the saved CSRs are not pristine.
 401   const std::vector<CalleeSavedInfo> &CSI = getCalleeSavedInfo();
 402   for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
 403          E = CSI.end(); I != E; ++I)
 404     BV.reset(I->getReg());
 405
 406   return BV;
 407 }
 408
 409
 410 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
 411   const TargetFrameInfo *FI = MF.getTarget().getFrameInfo();
 412   int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
 413
 414   for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
 415     const StackObject &SO = Objects[i];
 416     OS << "  <fi#" << (int)(i-NumFixedObjects) << ">: ";
 417     if (SO.Size == ~0ULL) {
 418       OS << "dead\n";
 419       continue;
 420     }
 421     if (SO.Size == 0)
 422       OS << "variable sized";
 423     else
 424       OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
 425     OS << " alignment is " << SO.Alignment << " byte"
 426        << (SO.Alignment != 1 ? "s," : ",");
 427
 428     if (i < NumFixedObjects)
 429       OS << " fixed";
 430     if (i < NumFixedObjects || SO.SPOffset != -1) {
 431       int64_t Off = SO.SPOffset - ValOffset;
 432       OS << " at location [SP";
 433       if (Off > 0)
 434         OS << "+" << Off;
 435       else if (Off < 0)
 436         OS << Off;
 437       OS << "]";
 438     }
 439     OS << "\n";
 440   }
 441
 442   if (HasVarSizedObjects)
 443     OS << "  Stack frame contains variable sized objects\n";
 444 }
 445
 446 void MachineFrameInfo::dump(const MachineFunction &MF) const {
 447   print(MF, *cerr.stream());
 448 }
 449
 450 //===----------------------------------------------------------------------===//
 451 //  MachineJumpTableInfo implementation
 452 //===----------------------------------------------------------------------===//
 453
 454 /// getJumpTableIndex - Create a new jump table entry in the jump table info
 455 /// or return an existing one.
 456 ///
 457 unsigned MachineJumpTableInfo::getJumpTableIndex(
 458                                const std::vector<MachineBasicBlock*> &DestBBs) {
 459   assert(!DestBBs.empty() && "Cannot create an empty jump table!");
 460   for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
 461     if (JumpTables[i].MBBs == DestBBs)
 462       return i;
 463
 464   JumpTables.push_back(MachineJumpTableEntry(DestBBs));
 465   return JumpTables.size()-1;
 466 }
 467
 468 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
 469 /// the jump tables to branch to New instead.
 470 bool
 471 MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
 472                                              MachineBasicBlock *New) {
 473   assert(Old != New && "Not making a change?");
 474   bool MadeChange = false;
 475   for (size_t i = 0, e = JumpTables.size(); i != e; ++i) {
 476     MachineJumpTableEntry &JTE = JumpTables[i];
 477     for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
 478       if (JTE.MBBs[j] == Old) {
 479         JTE.MBBs[j] = New;
 480         MadeChange = true;
 481       }
 482   }
 483   return MadeChange;
 484 }
 485
 486 void MachineJumpTableInfo::print(std::ostream &OS) const {
 487   // FIXME: this is lame, maybe we could print out the MBB numbers or something
 488   // like {1, 2, 4, 5, 3, 0}
 489   for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
 490     OS << "  <jt#" << i << "> has " << JumpTables[i].MBBs.size()
 491        << " entries\n";
 492   }
 493 }
 494
 495 void MachineJumpTableInfo::dump() const { print(*cerr.stream()); }
 496
 497
 498 //===----------------------------------------------------------------------===//
 499 //  MachineConstantPool implementation
 500 //===----------------------------------------------------------------------===//
 501
 502 const Type *MachineConstantPoolEntry::getType() const {
 503   if (isMachineConstantPoolEntry())
 504     return Val.MachineCPVal->getType();
 505   return Val.ConstVal->getType();
 506 }
 507
 508
 509 unsigned MachineConstantPoolEntry::getRelocationInfo() const {
 510   if (isMachineConstantPoolEntry())
 511     return Val.MachineCPVal->getRelocationInfo();
 512   return Val.ConstVal->getRelocationInfo();
 513 }
 514
 515 MachineConstantPool::~MachineConstantPool() {
 516   for (unsigned i = 0, e = Constants.size(); i != e; ++i)
 517     if (Constants[i].isMachineConstantPoolEntry())
 518       delete Constants[i].Val.MachineCPVal;
 519 }
 520
 521 /// getConstantPoolIndex - Create a new entry in the constant pool or return
 522 /// an existing one.  User must specify the log2 of the minimum required
 523 /// alignment for the object.
 524 ///
 525 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
 526                                                    unsigned Alignment) {
 527   assert(Alignment && "Alignment must be specified!");
 528   if (Alignment > PoolAlignment) PoolAlignment = Alignment;
 529
 530   // Check to see if we already have this constant.
 531   //
 532   // FIXME, this could be made much more efficient for large constant pools.
 533   for (unsigned i = 0, e = Constants.size(); i != e; ++i)
 534     if (Constants[i].Val.ConstVal == C &&
 535         (Constants[i].getAlignment() & (Alignment - 1)) == 0)
 536       return i;
 537
 538   Constants.push_back(MachineConstantPoolEntry(C, Alignment));
 539   return Constants.size()-1;
 540 }
 541
 542 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
 543                                                    unsigned Alignment) {
 544   assert(Alignment && "Alignment must be specified!");
 545   if (Alignment > PoolAlignment) PoolAlignment = Alignment;
 546
 547   // Check to see if we already have this constant.
 548   //
 549   // FIXME, this could be made much more efficient for large constant pools.
 550   int Idx = V->getExistingMachineCPValue(this, Alignment);
 551   if (Idx != -1)
 552     return (unsigned)Idx;
 553
 554   Constants.push_back(MachineConstantPoolEntry(V, Alignment));
 555   return Constants.size()-1;
 556 }
 557
 558 void MachineConstantPool::print(raw_ostream &OS) const {
 559   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
 560     OS << "  <cp#" << i << "> is";
 561     if (Constants[i].isMachineConstantPoolEntry())
 562       Constants[i].Val.MachineCPVal->print(OS);
 563     else
 564       OS << *(Value*)Constants[i].Val.ConstVal;
 565     OS << " , alignment=" << Constants[i].getAlignment();
 566     OS << "\n";
 567   }
 568 }
 569
 570 void MachineConstantPool::dump() const { print(errs()); }