* Use C++ style comments instead of C-style
[oota-llvm.git] / lib / CodeGen / MachineFunction.cpp
index 4d50f89729f594fbdd353c64c23d2624124ec7e5..c1eb30a1966aeb7641aa6cf23e8842299047f303 100644 (file)
-//===-- MachineCodeForMethod.cpp -------------------------------------------=//
+//===-- MachineFunction.cpp -----------------------------------------------===//
 // 
-// Purpose:
-//   Collect native machine code information for a function.
-//   This allows target-specific information about the generated code
-//   to be stored with each function.
-//===---------------------------------------------------------------------===//
+//                     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/MachineCodeForMethod.h"
-#include "llvm/CodeGen/MachineInstr.h"  // For debug output
+#include "llvm/CodeGen/MachineFunction.h"
+#include "llvm/CodeGen/MachineInstr.h"
+#include "llvm/CodeGen/MachineCodeForInstruction.h"
+#include "llvm/CodeGen/SSARegMap.h"
+#include "llvm/CodeGen/MachineFunctionInfo.h"
+#include "llvm/CodeGen/MachineFrameInfo.h"
+#include "llvm/CodeGen/MachineConstantPool.h"
 #include "llvm/Target/TargetMachine.h"
-#include "llvm/Target/MachineFrameInfo.h"
-#include "llvm/Target/MachineCacheInfo.h"
+#include "llvm/Target/TargetFrameInfo.h"
+#include "llvm/Target/TargetCacheInfo.h"
 #include "llvm/Function.h"
-#include "llvm/BasicBlock.h"
 #include "llvm/iOther.h"
-#include <limits.h>
-#include <iostream>
+#include "llvm/Pass.h"
+#include "Config/limits.h"
 
 const int INVALID_FRAME_OFFSET = INT_MAX; // std::numeric_limits<int>::max();
 
-static AnnotationID MCFM_AID(
+static AnnotationID MF_AID(
                  AnnotationManager::getID("CodeGen::MachineCodeForFunction"));
 
+
+//===---------------------------------------------------------------------===//
+// Code generation/destruction passes
+//===---------------------------------------------------------------------===//
+
+namespace {
+  class ConstructMachineFunction : public FunctionPass {
+    TargetMachine &Target;
+  public:
+    ConstructMachineFunction(TargetMachine &T) : Target(T) {}
+    
+    const char *getPassName() const {
+      return "ConstructMachineFunction";
+    }
+    
+    bool runOnFunction(Function &F) {
+      MachineFunction::construct(&F, Target).getInfo()->CalculateArgSize();
+      return false;
+    }
+  };
+
+  struct DestroyMachineFunction : public FunctionPass {
+    const char *getPassName() const { return "FreeMachineFunction"; }
+    
+    static void freeMachineCode(Instruction &I) {
+      MachineCodeForInstruction::destroy(&I);
+    }
+    
+    bool runOnFunction(Function &F) {
+      for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
+        for (BasicBlock::iterator I = FI->begin(), E = FI->end(); I != E; ++I)
+          MachineCodeForInstruction::get(I).dropAllReferences();
+      
+      for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
+        for_each(FI->begin(), FI->end(), freeMachineCode);
+      
+      return false;
+    }
+  };
+
+  struct Printer : public FunctionPass {
+    const char *getPassName() const { return "MachineFunction Printer"; }
+
+    virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+      AU.setPreservesAll();
+    }
+
+    bool runOnFunction(Function &F) {
+      MachineFunction::get(&F).dump();
+      return false;
+    }
+  };
+}
+
+FunctionPass *createMachineCodeConstructionPass(TargetMachine &Target) {
+  return new ConstructMachineFunction(Target);
+}
+
+FunctionPass *createMachineCodeDestructionPass() {
+  return new DestroyMachineFunction();
+}
+
+FunctionPass *createMachineFunctionPrinterPass() {
+  return new Printer();
+}
+
+
+//===---------------------------------------------------------------------===//
+// MachineFunction implementation
+//===---------------------------------------------------------------------===//
+
+MachineFunction::MachineFunction(const Function *F,
+                                 const TargetMachine &TM)
+  : Annotation(MF_AID), Fn(F), Target(TM) {
+  SSARegMapping = new SSARegMap();
+  MFInfo = new MachineFunctionInfo(*this);
+  FrameInfo = new MachineFrameInfo();
+  ConstantPool = new MachineConstantPool();
+}
+
+MachineFunction::~MachineFunction() { 
+  delete SSARegMapping;
+  delete MFInfo;
+  delete FrameInfo;
+  delete ConstantPool;
+}
+
+void MachineFunction::dump() const { print(std::cerr); }
+
+void MachineFunction::print(std::ostream &OS) const {
+  OS << "\n" << *(Value*)Fn->getFunctionType() << " \"" << Fn->getName()
+     << "\"\n";
+
+  // Print Frame Information
+  getFrameInfo()->print(*this, OS);
+
+  // Print Constant Pool
+  getConstantPool()->print(OS);
+  
+  for (const_iterator BB = begin(); BB != end(); ++BB) {
+    const BasicBlock *LBB = BB->getBasicBlock();
+    OS << "\n" << LBB->getName() << " (" << (const void*)LBB << "):\n";
+    for (MachineBasicBlock::const_iterator I = BB->begin(); I != BB->end();++I){
+      OS << "\t";
+      (*I)->print(OS, Target);
+    }
+  }
+  OS << "\nEnd function \"" << Fn->getName() << "\"\n\n";
+}
+
+
 // The next two methods are used to construct and to retrieve
 // the MachineCodeForFunction object for the given function.
 // construct() -- Allocates and initializes for a given function and target
@@ -29,49 +151,117 @@ static AnnotationID MCFM_AID(
 //                This should not be called before "construct()"
 //                for a given Function.
 // 
-MachineCodeForMethod&
-MachineCodeForMethod::construct(const Function *M, const TargetMachine &Tar)
+MachineFunction&
+MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
 {
-  assert(M->getAnnotation(MCFM_AID) == 0 &&
+  assert(Fn->getAnnotation(MF_AID) == 0 &&
          "Object already exists for this function!");
-  MachineCodeForMethod* mcInfo = new MachineCodeForMethod(M, Tar);
-  M->addAnnotation(mcInfo);
+  MachineFunction* mcInfo = new MachineFunction(Fn, Tar);
+  Fn->addAnnotation(mcInfo);
   return *mcInfo;
 }
 
 void
-MachineCodeForMethod::destruct(const Function *M)
+MachineFunction::destruct(const Function *Fn)
 {
-  bool Deleted = M->deleteAnnotation(MCFM_AID);
+  bool Deleted = Fn->deleteAnnotation(MF_AID);
   assert(Deleted && "Machine code did not exist for function!");
 }
 
-MachineCodeForMethod&
-MachineCodeForMethod::get(const Function *F)
+MachineFunction& MachineFunction::get(const Function *F)
 {
-  MachineCodeForMethod *mc = (MachineCodeForMethod*)F->getAnnotation(MCFM_AID);
+  MachineFunction *mc = (MachineFunction*)F->getAnnotation(MF_AID);
   assert(mc && "Call construct() method first to allocate the object");
   return *mc;
 }
 
+void MachineFunction::clearSSARegMap() {
+  delete SSARegMapping;
+  SSARegMapping = 0;
+}
+
+//===----------------------------------------------------------------------===//
+//  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));
+}
+
+int MachineFrameInfo::CreateStackObject(const TargetRegisterClass *RC) {
+  return CreateStackObject(RC->getSize(), RC->getAlignment());
+}
+
+
+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 ";
+    if (SO.Size == 0)
+      OS << "variable sized";
+    else
+      OS << SO.Size << " byte" << (SO.Size != 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;
+      else if (Off < 0)
+       OS << Off;
+      OS << "]";
+    }
+    OS << "\n";
+  }
+
+  if (HasVarSizedObjects)
+    OS << "  Stack frame contains variable sized objects\n";
+}
+
+void MachineFrameInfo::dump(const MachineFunction &MF) const {
+  print(MF, std::cerr);
+}
+
+
+//===----------------------------------------------------------------------===//
+//  MachineConstantPool 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";
+}
+
+void MachineConstantPool::dump() const { print(std::cerr); }
+
+//===----------------------------------------------------------------------===//
+//  MachineFunctionInfo implementation
+//===----------------------------------------------------------------------===//
+
 static unsigned
 ComputeMaxOptionalArgsSize(const TargetMachine& target, const Function *F,
                            unsigned &maxOptionalNumArgs)
 {
-  const MachineFrameInfo& frameInfo = target.getFrameInfo();
+  const TargetFrameInfo &frameInfo = target.getFrameInfo();
   
   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))
+      if (const CallInst *callInst = dyn_cast<CallInst>(I))
         {
           unsigned numOperands = callInst->getNumOperands() - 1;
           int numExtra = (int)numOperands-frameInfo.getNumFixedOutgoingArgs();
           if (numExtra <= 0)
             continue;
           
-          unsigned int sizeForThisCall;
+          unsigned sizeForThisCall;
           if (frameInfo.argsOnStackHaveFixedSize())
             {
               int argSize = frameInfo.getSizeOfEachArgOnStack(); 
@@ -84,7 +274,7 @@ ComputeMaxOptionalArgsSize(const TargetMachine& target, const Function *F,
                      "compute MaxOptionalArgsSize");
               sizeForThisCall = 0;
               for (unsigned i = 0; i < numOperands; ++i)
-                sizeForThisCall += target.findOptimalStorageSize(callInst->
+                sizeForThisCall += target.getTargetData().getTypeSize(callInst->
                                               getOperand(i)->getType());
             }
           
@@ -99,81 +289,59 @@ ComputeMaxOptionalArgsSize(const TargetMachine& target, const Function *F,
 }
 
 // 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, ...).
+// 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 HAS BEEN COPIED FROM EMITASSEMBLY.CPP AND
-// SHOULD BE USED DIRECTLY THERE
+// 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 int
-SizeToAlignment(unsigned int size, const TargetMachine& target)
+inline unsigned
+SizeToAlignment(unsigned size, const TargetMachine& target)
 {
   unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1); 
   if (size > (unsigned) cacheLineSize / 2)
     return cacheLineSize;
   else
     for (unsigned sz=1; /*no condition*/; sz *= 2)
-      if (sz >= size)
+      if (sz >= size || sz >= target.getTargetData().getDoubleAlignment())
         return sz;
 }
 
 
-
-/*ctor*/
-MachineCodeForMethod::MachineCodeForMethod(const Function *F,
-                                           const TargetMachine& target)
-  : Annotation(MCFM_AID),
-    method(F), staticStackSize(0),
-    automaticVarsSize(0), regSpillsSize(0),
-    maxOptionalArgsSize(0), maxOptionalNumArgs(0),
-    currentTmpValuesSize(0), maxTmpValuesSize(0), compiledAsLeaf(false),
-    spillsAreaFrozen(false), automaticVarsAreaFrozen(false)
-{
-  maxOptionalArgsSize = ComputeMaxOptionalArgsSize(target, method,
+void MachineFunctionInfo::CalculateArgSize() {
+  maxOptionalArgsSize = ComputeMaxOptionalArgsSize(MF.getTarget(),
+                                                  MF.getFunction(),
                                                    maxOptionalNumArgs);
   staticStackSize = maxOptionalArgsSize
-                    + target.getFrameInfo().getMinStackFrameSize();
+    + MF.getTarget().getFrameInfo().getMinStackFrameSize();
 }
 
 int
-MachineCodeForMethod::computeOffsetforLocalVar(const TargetMachine& target,
-                                               const Value* val,
-                                               unsigned int& getPaddedSize,
-                                               unsigned int  sizeToUse = 0)
+MachineFunctionInfo::computeOffsetforLocalVar(const Value* val,
+                                             unsigned &getPaddedSize,
+                                             unsigned  sizeToUse)
 {
-  bool growUp;
-  int firstOffset =target.getFrameInfo().getFirstAutomaticVarOffset(*this,
-                                                                    growUp);
-  unsigned char align;
   if (sizeToUse == 0)
-    {
-      sizeToUse = target.findOptimalStorageSize(val->getType());
-      // align = target.DataLayout.getTypeAlignment(val->getType());
-    }
-  
-  align = SizeToAlignment(sizeToUse, target);
-          
-  int offset = getAutomaticVarsSize();
-  if (! growUp)
-    offset += sizeToUse; 
-      
-  if (unsigned int mod = offset % align)
-    {
-      offset        += align - mod;
-      getPaddedSize  = sizeToUse + align - mod;
-    }
-  else
-    getPaddedSize  = sizeToUse;
-  
-  offset = growUp? firstOffset + offset
-    : firstOffset - offset;
-  
-  return offset;
+    sizeToUse = MF.getTarget().findOptimalStorageSize(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);
+
+  int aligned = MF.getTarget().getFrameInfo().adjustAlignment(offset, growUp, align);
+  getPaddedSize = sizeToUse + abs(aligned - offset);
+
+  return aligned;
 }
 
 int
-MachineCodeForMethod::allocateLocalVar(const TargetMachine& target,
-                                       const Value* val,
-                                       unsigned int sizeToUse = 0)
+MachineFunctionInfo::allocateLocalVar(const Value* val,
+                                     unsigned sizeToUse)
 {
   assert(! automaticVarsAreaFrozen &&
          "Size of auto vars area has been used to compute an offset so "
@@ -184,104 +352,65 @@ MachineCodeForMethod::allocateLocalVar(const TargetMachine& target,
   int offset = getOffset(val);
   if (offset == INVALID_FRAME_OFFSET)
     {
-      unsigned int getPaddedSize;
-      offset = this->computeOffsetforLocalVar(target, val, getPaddedSize,
-                                              sizeToUse);
+      unsigned getPaddedSize;
+      offset = computeOffsetforLocalVar(val, getPaddedSize, sizeToUse);
       offsets[val] = offset;
       incrementAutomaticVarsSize(getPaddedSize);
     }
   return offset;
 }
-  
+
 int
-MachineCodeForMethod::allocateSpilledValue(const TargetMachine& target,
-                                           const Type* type)
+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 int size  = target.findOptimalStorageSize(type);
-  unsigned char align = target.DataLayout.getTypeAlignment(type);
+  unsigned size  = MF.getTarget().getTargetData().getTypeSize(type);
+  unsigned char align = MF.getTarget().getTargetData().getTypeAlignment(type);
   
   bool growUp;
-  int firstOffset = target.getFrameInfo().getRegSpillAreaOffset(*this, growUp);
-  
-  int offset = getRegSpillsSize();
-  if (! growUp)
-    offset += size; 
+  int firstOffset = MF.getTarget().getFrameInfo().getRegSpillAreaOffset(MF, growUp);
   
-  if (unsigned int mod = offset % align)
-    {
-      offset    += align - mod;
-      size += align - mod;
-    }
-  
-  offset = growUp? firstOffset + offset
-                 : firstOffset - offset;
-  
-  incrementRegSpillsSize(size);
+  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
   
-  return offset;
+  incrementRegSpillsSize(size);  // update size of reg. spills area
+
+  return aligned;
 }
 
 int
-MachineCodeForMethod::pushTempValue(const TargetMachine& target,
-                                    unsigned int size)
+MachineFunctionInfo::pushTempValue(unsigned size)
 {
-  // Compute a power-of-2 alignment according to the possible sizes,
-  // but not greater than the alignment of the largest type we support
-  // (currently a double word -- see class TargetData).
-  unsigned char align = 1;
-  for (; align < size && align < target.DataLayout.getDoubleAlignment();
-         align = 2*align)
-    ;
-  
+  unsigned align = SizeToAlignment(size, MF.getTarget());
+
   bool growUp;
-  int firstTmpOffset = target.getFrameInfo().getTmpAreaOffset(*this, growUp);
-  
-  int offset = currentTmpValuesSize;
-  if (! growUp)
-    offset += size; 
-  
-  if (unsigned int mod = offset % align)
-    {
-      offset += align - mod;
-      size   += align - mod;
-    }
-  
-  offset = growUp ? firstTmpOffset + offset : firstTmpOffset - offset;
-  
-  incrementTmpAreaSize(size);
-  return offset;
-}
+  int firstOffset = MF.getTarget().getFrameInfo().getTmpAreaOffset(MF, growUp);
 
-void
-MachineCodeForMethod::popAllTempValues(const TargetMachine& target)
-{
-  resetTmpAreaSize();
+  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;
 }
 
-int
-MachineCodeForMethod::getOffset(const Value* val) const
-{
-  std::hash_map<const Value*, int>::const_iterator pair = offsets.find(val);
-  return (pair == offsets.end())? INVALID_FRAME_OFFSET : pair->second;
+void MachineFunctionInfo::popAllTempValues() {
+  resetTmpAreaSize();            // clear tmp area to reuse
 }
 
-void
-MachineCodeForMethod::dump() const
+int
+MachineFunctionInfo::getOffset(const Value* val) const
 {
-  std::cerr << "\n" << method->getReturnType()
-            << " \"" << method->getName() << "\"\n";
-  
-  for (Function::const_iterator BB = method->begin(); BB != method->end(); ++BB)
-    {
-      std::cerr << "\n" << BB->getName() << " (" << *BB << ")" << ":\n";
-
-      MachineCodeForBasicBlock& mvec = BB->getMachineInstrVec();
-      for (unsigned i=0; i < mvec.size(); i++)
-       std::cerr << "\t" << *mvec[i];
-    } 
-  std::cerr << "\nEnd function \"" << method->getName() << "\"\n\n";
+  hash_map<const Value*, int>::const_iterator pair = offsets.find(val);
+  return (pair == offsets.end()) ? INVALID_FRAME_OFFSET : pair->second;
 }