Refactor scheduler code. Move register-reduction list scheduler to a
[oota-llvm.git] / lib / CodeGen / MachineFunction.cpp
index dd55a9ad735330f422f75cf1028e633cdd44ddd1..02646de18fd1610babe3205cfe12f3b1359e116a 100644 (file)
@@ -1,12 +1,12 @@
 //===-- MachineFunction.cpp -----------------------------------------------===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
-// 
+//
 // Collect native machine code information for a function.  This allows
 // target-specific information about the generated code to be stored with each
 // function.
 #include "llvm/CodeGen/SSARegMap.h"
 #include "llvm/CodeGen/MachineFrameInfo.h"
 #include "llvm/CodeGen/MachineConstantPool.h"
+#include "llvm/CodeGen/MachineJumpTableInfo.h"
 #include "llvm/CodeGen/Passes.h"
 #include "llvm/Target/TargetMachine.h"
 #include "llvm/Target/TargetFrameInfo.h"
 #include "llvm/Function.h"
 #include "llvm/Instructions.h"
-#include "llvm/Type.h"
-#include "../Target/SparcV9/MachineFunctionInfo.h"  // FIXME
-#include "Support/LeakDetector.h"
-#include "Support/GraphWriter.h"
+#include "llvm/Support/LeakDetector.h"
+#include "llvm/Support/GraphWriter.h"
+#include "llvm/Config/config.h"
 #include <fstream>
 #include <iostream>
 #include <sstream>
@@ -34,7 +34,7 @@
 using namespace llvm;
 
 static AnnotationID MF_AID(
-                 AnnotationManager::getID("CodeGen::MachineCodeForFunction"));
+  AnnotationManager::getID("CodeGen::MachineCodeForFunction"));
 
 
 namespace {
@@ -63,7 +63,7 @@ namespace {
 /// stream is std::cerr; the default banner is empty.
 ///
 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
-                                                     const std::string &Banner) {
+                                                     const std::string &Banner){
   return new Printer(OS, Banner);
 }
 
@@ -91,39 +91,41 @@ FunctionPass *llvm::createMachineCodeDeleter() {
 //===---------------------------------------------------------------------===//
 // MachineFunction implementation
 //===---------------------------------------------------------------------===//
-MachineBasicBlock* ilist_traits<MachineBasicBlock>::createNode()
-{
-    MachineBasicBlock* dummy = new MachineBasicBlock();
-    LeakDetector::removeGarbageObject(dummy);
-    return dummy;
+
+MachineBasicBlock* ilist_traits<MachineBasicBlock>::createSentinel() {
+  MachineBasicBlock* dummy = new MachineBasicBlock();
+  LeakDetector::removeGarbageObject(dummy);
+  return dummy;
 }
 
 void ilist_traits<MachineBasicBlock>::transferNodesFromList(
-    iplist<MachineBasicBlock, ilist_traits<MachineBasicBlock> >& toList,
-    ilist_iterator<MachineBasicBlock> first,
-    ilist_iterator<MachineBasicBlock> last)
-{
-    if (Parent != toList.Parent)
-        for (; first != last; ++first)
-            first->Parent = toList.Parent;
+  iplist<MachineBasicBlock, ilist_traits<MachineBasicBlock> >& toList,
+  ilist_iterator<MachineBasicBlock> first,
+  ilist_iterator<MachineBasicBlock> last) {
+  if (Parent != toList.Parent)
+    for (; first != last; ++first)
+      first->Parent = toList.Parent;
 }
 
 MachineFunction::MachineFunction(const Function *F,
                                  const TargetMachine &TM)
-  : Annotation(MF_AID), Fn(F), Target(TM) {
+  : Annotation(MF_AID), Fn(F), Target(TM), UsedPhysRegs(0) {
   SSARegMapping = new SSARegMap();
-  MFInfo = new MachineFunctionInfo(*this);
+  MFInfo = 0;
   FrameInfo = new MachineFrameInfo();
-  ConstantPool = new MachineConstantPool();
+  ConstantPool = new MachineConstantPool(TM.getTargetData());
+  JumpTableInfo = new MachineJumpTableInfo(TM.getTargetData());
   BasicBlocks.Parent = this;
 }
 
-MachineFunction::~MachineFunction() { 
+MachineFunction::~MachineFunction() {
   BasicBlocks.clear();
   delete SSARegMapping;
   delete MFInfo;
   delete FrameInfo;
   delete ConstantPool;
+  delete JumpTableInfo;
+  delete[] UsedPhysRegs;
 }
 
 void MachineFunction::dump() const { print(std::cerr); }
@@ -133,10 +135,35 @@ void MachineFunction::print(std::ostream &OS) const {
 
   // Print Frame Information
   getFrameInfo()->print(*this, OS);
+  
+  // Print JumpTable Information
+  getJumpTableInfo()->print(OS);
 
   // Print Constant Pool
   getConstantPool()->print(OS);
   
+  const MRegisterInfo *MRI = getTarget().getRegisterInfo();
+  
+  if (livein_begin() != livein_end()) {
+    OS << "Live Ins:";
+    for (livein_iterator I = livein_begin(), E = livein_end(); I != E; ++I) {
+      if (MRI)
+        OS << " " << MRI->getName(I->first);
+      else
+        OS << " Reg #" << I->first;
+    }
+    OS << "\n";
+  }
+  if (liveout_begin() != liveout_end()) {
+    OS << "Live Outs:";
+    for (liveout_iterator I = liveout_begin(), E = liveout_end(); I != E; ++I)
+      if (MRI)
+        OS << " " << MRI->getName(*I);
+      else
+        OS << " Reg #" << *I;
+    OS << "\n";
+  }
+  
   for (const_iterator BB = begin(); BB != end(); ++BB)
     BB->print(OS);
 
@@ -150,46 +177,47 @@ void MachineFunction::print(std::ostream &OS) const {
 static bool CFGOnly = false;
 
 namespace llvm {
-template<>
-struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
-  static std::string getGraphName(const MachineFunction *F) {
-    return "CFG for '" + F->getFunction()->getName() + "' function";
-  }
+  template<>
+  struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
+    static std::string getGraphName(const MachineFunction *F) {
+      return "CFG for '" + F->getFunction()->getName() + "' function";
+    }
 
-  static std::string getNodeLabel(const MachineBasicBlock *Node,
-                                  const MachineFunction *Graph) {
-    if (CFGOnly && Node->getBasicBlock() &&
-        !Node->getBasicBlock()->getName().empty())
-      return Node->getBasicBlock()->getName() + ":";
+    static std::string getNodeLabel(const MachineBasicBlock *Node,
+                                    const MachineFunction *Graph) {
+      if (CFGOnly && Node->getBasicBlock() &&
+          !Node->getBasicBlock()->getName().empty())
+        return Node->getBasicBlock()->getName() + ":";
 
-    std::ostringstream Out;
-    if (CFGOnly) {
-      Out << Node->getNumber() << ':';
-      return Out.str();
-    }
+      std::ostringstream Out;
+      if (CFGOnly) {
+        Out << Node->getNumber() << ':';
+        return Out.str();
+      }
 
-    Node->print(Out);
+      Node->print(Out);
 
-    std::string OutStr = Out.str();
-    if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
+      std::string OutStr = Out.str();
+      if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
 
-    // Process string output to make it nicer...
-    for (unsigned i = 0; i != OutStr.length(); ++i)
-      if (OutStr[i] == '\n') {                            // Left justify
-        OutStr[i] = '\\';
-        OutStr.insert(OutStr.begin()+i+1, 'l');
-      }
-    return OutStr;
-  }
-};
+      // Process string output to make it nicer...
+      for (unsigned i = 0; i != OutStr.length(); ++i)
+        if (OutStr[i] == '\n') {                            // Left justify
+          OutStr[i] = '\\';
+          OutStr.insert(OutStr.begin()+i+1, 'l');
+        }
+      return OutStr;
+    }
+  };
 }
 
 void MachineFunction::viewCFG() const
 {
+#ifndef NDEBUG
   std::string Filename = "/tmp/cfg." + getFunction()->getName() + ".dot";
   std::cerr << "Writing '" << Filename << "'... ";
   std::ofstream F(Filename.c_str());
-  
+
   if (!F) {
     std::cerr << "  error opening file for writing!\n";
     return;
@@ -199,6 +227,17 @@ void MachineFunction::viewCFG() const
   F.close();
   std::cerr << "\n";
 
+#ifdef HAVE_GRAPHVIZ
+  std::cerr << "Running 'Graphviz' program... " << std::flush;
+  if (system((LLVM_PATH_GRAPHVIZ " " + Filename).c_str())) {
+    std::cerr << "Error viewing graph: 'Graphviz' not in path?\n";
+  } else {
+    system(("rm " + Filename).c_str());
+    return;
+  }
+#endif  // HAVE_GRAPHVIZ
+
+#ifdef HAVE_GV
   std::cerr << "Running 'dot' program... " << std::flush;
   if (system(("dot -Tps -Nfontname=Courier -Gsize=7.5,10 " + Filename
               + " > /tmp/cfg.tempgraph.ps").c_str())) {
@@ -208,6 +247,15 @@ void MachineFunction::viewCFG() const
     system("gv /tmp/cfg.tempgraph.ps");
   }
   system(("rm " + Filename + " /tmp/cfg.tempgraph.ps").c_str());
+  return;
+#endif  // HAVE_GV
+#endif  // NDEBUG
+  std::cerr << "MachineFunction::viewCFG is only available in debug builds on "
+            << "systems with Graphviz or gv!\n";
+
+#ifndef NDEBUG
+  system(("rm " + Filename).c_str());
+#endif
 }
 
 void MachineFunction::viewCFGOnly() const
@@ -223,7 +271,7 @@ void MachineFunction::viewCFGOnly() const
 // get()       -- Returns a handle to the object.
 //                This should not be called before "construct()"
 //                for a given Function.
-// 
+//
 MachineFunction&
 MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
 {
@@ -255,33 +303,28 @@ void MachineFunction::clearSSARegMap() {
 //  MachineFrameInfo implementation
 //===----------------------------------------------------------------------===//
 
-/// CreateStackObject - Create a stack object for a value of the specified type.
-///
-int MachineFrameInfo::CreateStackObject(const Type *Ty, const TargetData &TD) {
-  return CreateStackObject(TD.getTypeSize(Ty), TD.getTypeAlignment(Ty));
-}
-
-
 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
   int ValOffset = MF.getTarget().getFrameInfo()->getOffsetOfLocalArea();
 
   for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
     const StackObject &SO = Objects[i];
-    OS << "  <fi #" << (int)(i-NumFixedObjects) << "> is ";
+    OS << "  <fi #" << (int)(i-NumFixedObjects) << ">: ";
     if (SO.Size == 0)
       OS << "variable sized";
     else
-      OS << SO.Size << " byte" << (SO.Size != 1 ? "s" : " ");
-    
+      OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
+    OS << " alignment is " << SO.Alignment << " byte"
+       << (SO.Alignment != 1 ? "s," : ",");
+
     if (i < NumFixedObjects)
       OS << " fixed";
     if (i < NumFixedObjects || SO.SPOffset != -1) {
       int Off = SO.SPOffset - ValOffset;
       OS << " at location [SP";
       if (Off > 0)
-       OS << "+" << Off;
+        OS << "+" << Off;
       else if (Off < 0)
-       OS << Off;
+        OS << Off;
       OS << "]";
     }
     OS << "\n";
@@ -297,168 +340,81 @@ void MachineFrameInfo::dump(const MachineFunction &MF) const {
 
 
 //===----------------------------------------------------------------------===//
-//  MachineConstantPool implementation
+//  MachineJumpTableInfo implementation
 //===----------------------------------------------------------------------===//
 
-void MachineConstantPool::print(std::ostream &OS) const {
-  for (unsigned i = 0, e = Constants.size(); i != e; ++i)
-    OS << "  <cp #" << i << "> is" << *(Value*)Constants[i] << "\n";
+/// getJumpTableIndex - Create a new jump table entry in the jump table info
+/// or return an existing one.
+///
+unsigned MachineJumpTableInfo::getJumpTableIndex(
+                                     std::vector<MachineBasicBlock*> &DestBBs) {
+  for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
+    if (JumpTables[i].MBBs == DestBBs)
+      return i;
+  
+  JumpTables.push_back(MachineJumpTableEntry(DestBBs));
+  return JumpTables.size()-1;
 }
 
-void MachineConstantPool::dump() const { print(std::cerr); }
 
-//===----------------------------------------------------------------------===//
-//  MachineFunctionInfo implementation
-//  NOTE: MachineFunctionInfo and its methods are specific to the SparcV9
-//  target - don't use them in other targets.
-//===----------------------------------------------------------------------===//
-
-static unsigned
-ComputeMaxOptionalArgsSize(const TargetMachine& target, const Function *F,
-                           unsigned &maxOptionalNumArgs)
-{
-  unsigned maxSize = 0;
-  
-  for (Function::const_iterator BB = F->begin(), BBE = F->end(); BB !=BBE; ++BB)
-    for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
-      if (const CallInst *callInst = dyn_cast<CallInst>(I))
-        {
-          unsigned numOperands = callInst->getNumOperands() - 1;
-          int numExtra = numOperands-6;
-          if (numExtra <= 0)
-            continue;
-          
-          unsigned sizeForThisCall = numExtra * 8;
-          
-          if (maxSize < sizeForThisCall)
-            maxSize = sizeForThisCall;
-          
-          if ((int)maxOptionalNumArgs < numExtra)
-            maxOptionalNumArgs = (unsigned) numExtra;
-        }
-  
-  return maxSize;
+void MachineJumpTableInfo::print(std::ostream &OS) const {
+  // FIXME: this is lame, maybe we could print out the MBB numbers or something
+  // like {1, 2, 4, 5, 3, 0}
+  for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
+    OS << "  <jt #" << i << "> has " << JumpTables[i].MBBs.size() 
+       << " entries\n";
+  }
 }
 
-// Align data larger than one L1 cache line on L1 cache line boundaries.
-// Align all smaller data on the next higher 2^x boundary (4, 8, ...),
-// but not higher than the alignment of the largest type we support
-// (currently a double word). -- see class TargetData).
-//
-// This function is similar to the corresponding function in EmitAssembly.cpp
-// but they are unrelated.  This one does not align at more than a
-// double-word boundary whereas that one might.
-// 
-inline unsigned
-SizeToAlignment(unsigned size, const TargetMachine& target)
-{
-  const unsigned short cacheLineSize = 16;
-  if (size > (unsigned) cacheLineSize / 2)
-    return cacheLineSize;
-  else
-    for (unsigned sz=1; /*no condition*/; sz *= 2)
-      if (sz >= size || sz >= target.getTargetData().getDoubleAlignment())
-        return sz;
+unsigned MachineJumpTableInfo::getEntrySize() const { 
+  return TD->getPointerSize(); 
 }
 
-
-void MachineFunctionInfo::CalculateArgSize() {
-  maxOptionalArgsSize = ComputeMaxOptionalArgsSize(MF.getTarget(),
-                                                  MF.getFunction(),
-                                                   maxOptionalNumArgs);
-  staticStackSize = maxOptionalArgsSize + 176;
+unsigned MachineJumpTableInfo::getAlignment() const { 
+  return TD->getPointerAlignment(); 
 }
 
-int
-MachineFunctionInfo::computeOffsetforLocalVar(const Value* val,
-                                             unsigned &getPaddedSize,
-                                             unsigned  sizeToUse)
-{
-  if (sizeToUse == 0) {
-    // All integer types smaller than ints promote to 4 byte integers.
-    if (val->getType()->isIntegral() && val->getType()->getPrimitiveSize() < 4)
-      sizeToUse = 4;
-    else
-      sizeToUse = MF.getTarget().getTargetData().getTypeSize(val->getType());
-  }
-  unsigned align = SizeToAlignment(sizeToUse, MF.getTarget());
-
-  bool growUp;
-  int firstOffset = MF.getTarget().getFrameInfo()->getFirstAutomaticVarOffset(MF,
-                                                                            growUp);
-  int offset = growUp? firstOffset + getAutomaticVarsSize()
-                     : firstOffset - (getAutomaticVarsSize() + sizeToUse);
+void MachineJumpTableInfo::dump() const { print(std::cerr); }
 
-  int aligned = MF.getTarget().getFrameInfo()->adjustAlignment(offset, growUp, align);
-  getPaddedSize = sizeToUse + abs(aligned - offset);
 
-  return aligned;
-}
-
-
-int MachineFunctionInfo::allocateLocalVar(const Value* val,
-                                          unsigned sizeToUse) {
-  assert(! automaticVarsAreaFrozen &&
-         "Size of auto vars area has been used to compute an offset so "
-         "no more automatic vars should be allocated!");
-  
-  // Check if we've allocated a stack slot for this value already
-  // 
-  hash_map<const Value*, int>::const_iterator pair = offsets.find(val);
-  if (pair != offsets.end())
-    return pair->second;
-
-  unsigned getPaddedSize;
-  unsigned offset = computeOffsetforLocalVar(val, getPaddedSize, sizeToUse);
-  offsets[val] = offset;
-  incrementAutomaticVarsSize(getPaddedSize);
-  return offset;
-}
+//===----------------------------------------------------------------------===//
+//  MachineConstantPool implementation
+//===----------------------------------------------------------------------===//
 
-int
-MachineFunctionInfo::allocateSpilledValue(const Type* type)
-{
-  assert(! spillsAreaFrozen &&
-         "Size of reg spills area has been used to compute an offset so "
-         "no more register spill slots should be allocated!");
-  
-  unsigned size  = MF.getTarget().getTargetData().getTypeSize(type);
-  unsigned char align = MF.getTarget().getTargetData().getTypeAlignment(type);
+/// getConstantPoolIndex - Create a new entry in the constant pool or return
+/// an existing one.  User must specify an alignment in bytes for the object.
+///
+unsigned MachineConstantPool::getConstantPoolIndex(Constant *C, 
+                                                   unsigned Alignment) {
+  assert(Alignment && "Alignment must be specified!");
+  if (Alignment > PoolAlignment) PoolAlignment = Alignment;
   
-  bool growUp;
-  int firstOffset = MF.getTarget().getFrameInfo()->getRegSpillAreaOffset(MF, growUp);
+  // Check to see if we already have this constant.
+  //
+  // FIXME, this could be made much more efficient for large constant pools.
+  unsigned AlignMask = (1 << Alignment)-1;
+  for (unsigned i = 0, e = Constants.size(); i != e; ++i)
+    if (Constants[i].Val == C && (Constants[i].Offset & AlignMask) == 0)
+      return i;
   
-  int offset = growUp? firstOffset + getRegSpillsSize()
-                     : firstOffset - (getRegSpillsSize() + size);
-
-  int aligned = MF.getTarget().getFrameInfo()->adjustAlignment(offset, growUp, align);
-  size += abs(aligned - offset); // include alignment padding in size
+  unsigned Offset = 0;
+  if (!Constants.empty()) {
+    Offset = Constants.back().Offset;
+    Offset += TD->getTypeSize(Constants.back().Val->getType());
+    Offset = (Offset+AlignMask)&~AlignMask;
+  }
   
-  incrementRegSpillsSize(size);  // update size of reg. spills area
-
-  return aligned;
+  Constants.push_back(MachineConstantPoolEntry(C, Offset));
+  return Constants.size()-1;
 }
 
-int
-MachineFunctionInfo::pushTempValue(unsigned size)
-{
-  unsigned align = SizeToAlignment(size, MF.getTarget());
-
-  bool growUp;
-  int firstOffset = MF.getTarget().getFrameInfo()->getTmpAreaOffset(MF, growUp);
-
-  int offset = growUp? firstOffset + currentTmpValuesSize
-                     : firstOffset - (currentTmpValuesSize + size);
-
-  int aligned = MF.getTarget().getFrameInfo()->adjustAlignment(offset, growUp,
-                                                             align);
-  size += abs(aligned - offset); // include alignment padding in size
-
-  incrementTmpAreaSize(size);    // update "current" size of tmp area
 
-  return aligned;
+void MachineConstantPool::print(std::ostream &OS) const {
+  for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
+    OS << "  <cp #" << i << "> is" << *(Value*)Constants[i].Val;
+    OS << " , offset=" << Constants[i].Offset;
+    OS << "\n";
+  }
 }
 
-void MachineFunctionInfo::popAllTempValues() {
-  resetTmpAreaSize();            // clear tmp area to reuse
-}
+void MachineConstantPool::dump() const { print(std::cerr); }