Major overhaul of stack frame management.
[oota-llvm.git] / lib / CodeGen / InstrSelection / InstrForest.cpp
index 12475b016d9ebfa6138e6b19f2cc63321d952392..d460bb77e23ff6f51e5e353098aeba342e44de95 100644 (file)
 // 
 //---------------------------------------------------------------------------
 
-//*************************** User Include Files ***************************/
-
 #include "llvm/CodeGen/InstrForest.h"
 #include "llvm/Method.h"
 #include "llvm/iTerminators.h"
 #include "llvm/iMemory.h"
+#include "llvm/iOther.h"
 #include "llvm/ConstPoolVals.h"
 #include "llvm/BasicBlock.h"
 #include "llvm/CodeGen/MachineInstr.h"
-
+#include "llvm/Support/STLExtras.h"
 
 //------------------------------------------------------------------------ 
 // class InstrTreeNode
 //------------------------------------------------------------------------ 
 
-
-InstrTreeNode::InstrTreeNode(InstrTreeNodeType nodeType,
-                            Value* _val)
-  : treeNodeType(nodeType),
-    val(_val)
-{
-  basicNode.leftChild = NULL;
-  basicNode.rightChild = NULL;
-  basicNode.parent = NULL;
-  basicNode.opLabel = InvalidOp;
-  basicNode.treeNodePtr = this;
-}
-
 void
-InstrTreeNode::dump(int dumpChildren,
-                   int indent) const
+InstrTreeNode::dump(int dumpChildren, int indent) const
 {
-  this->dumpNode(indent);
+  dumpNode(indent);
   
   if (dumpChildren)
     {
-      if (leftChild())
-       leftChild()->dump(dumpChildren, indent+1);
-      if (rightChild())
-       rightChild()->dump(dumpChildren, indent+1);
+      if (LeftChild)
+       LeftChild->dump(dumpChildren, indent+1);
+      if (RightChild)
+       RightChild->dump(dumpChildren, indent+1);
     }
 }
 
 
-InstructionNode::InstructionNode(Instruction* _instr)
-  : InstrTreeNode(NTInstructionNode, _instr)
+InstructionNode::InstructionNode(Instruction* I)
+  : InstrTreeNode(NTInstructionNode, I)
 {
-  OpLabel opLabel = _instr->getOpcode();
+  opLabel = I->getOpcode();
 
   // Distinguish special cases of some instructions such as Ret and Br
   // 
-  if (opLabel == Instruction::Ret && ((ReturnInst*) _instr)->getReturnValue())
+  if (opLabel == Instruction::Ret && cast<ReturnInst>(I)->getReturnValue())
     {
-      opLabel = RetValueOp;             // ret(value) operation
+      opLabel = RetValueOp;                     // ret(value) operation
     }
-  else if (opLabel == Instruction::Br && ! ((BranchInst*) _instr)->isUnconditional())
+  else if (opLabel ==Instruction::Br && !cast<BranchInst>(I)->isUnconditional())
     {
       opLabel = BrCondOp;              // br(cond) operation
     }
@@ -85,44 +70,48 @@ InstructionNode::InstructionNode(Instruction* _instr)
     {
       opLabel = SetCCOp;               // common label for all SetCC ops
     }
-  else if (opLabel == Instruction::Alloca && _instr->getNumOperands() > 0)
+  else if (opLabel == Instruction::Alloca && I->getNumOperands() > 0)
     {
       opLabel = AllocaN;                // Alloca(ptr, N) operation
     }
   else if ((opLabel == Instruction::Load ||
-           opLabel == Instruction::GetElementPtr)
-          && ((MemAccessInst*)_instr)->getFirstOffsetIdx() > 0)
+           opLabel == Instruction::GetElementPtr) &&
+          ((MemAccessInst*)I)->getFirstOffsetIdx() > 0)
     {
       opLabel = opLabel + 100;          // load/getElem with index vector
     }
+  else if (opLabel == Instruction::And ||
+           opLabel == Instruction::Or ||
+           opLabel == Instruction::Xor ||
+           opLabel == Instruction::Not)
+    {
+      // Distinguish bitwise operators from logical operators!
+      if (I->getType() != Type::BoolTy)
+        opLabel = opLabel + 100;        // bitwise operator
+    }
   else if (opLabel == Instruction::Cast)
     {
-      const Type* instrValueType = _instr->getType();
-      switch(instrValueType->getPrimitiveID())
+      const Type *ITy = I->getType();
+      switch(ITy->getPrimitiveID())
        {
-       case Type::BoolTyID:    opLabel = ToBoolTy;  break;
-       case Type::UByteTyID:   opLabel = ToUByteTy; break;
-       case Type::SByteTyID:   opLabel = ToSByteTy; break;
-       case Type::UShortTyID:  opLabel = ToUShortTy; break;
-       case Type::ShortTyID:   opLabel = ToShortTy; break;
-       case Type::UIntTyID:    opLabel = ToUIntTy; break;
-       case Type::IntTyID:     opLabel = ToIntTy; break;
-       case Type::ULongTyID:   opLabel = ToULongTy; break;
-       case Type::LongTyID:    opLabel = ToLongTy; break;
-       case Type::FloatTyID:   opLabel = ToFloatTy; break;
-       case Type::DoubleTyID:  opLabel = ToDoubleTy; break;
+       case Type::BoolTyID:    opLabel = ToBoolTy;    break;
+       case Type::UByteTyID:   opLabel = ToUByteTy;   break;
+       case Type::SByteTyID:   opLabel = ToSByteTy;   break;
+       case Type::UShortTyID:  opLabel = ToUShortTy;  break;
+       case Type::ShortTyID:   opLabel = ToShortTy;   break;
+       case Type::UIntTyID:    opLabel = ToUIntTy;    break;
+       case Type::IntTyID:     opLabel = ToIntTy;     break;
+       case Type::ULongTyID:   opLabel = ToULongTy;   break;
+       case Type::LongTyID:    opLabel = ToLongTy;    break;
+       case Type::FloatTyID:   opLabel = ToFloatTy;   break;
+       case Type::DoubleTyID:  opLabel = ToDoubleTy;  break;
+       case Type::ArrayTyID:   opLabel = ToArrayTy;   break;
+       case Type::PointerTyID: opLabel = ToPointerTy; break;
        default:
-         if (instrValueType->isArrayType())
-           opLabel = ToArrayTy;
-         else if (instrValueType->isPointerType())
-           opLabel = ToPointerTy;
-         else
-           ; // Just use `Cast' opcode otherwise. It's probably ignored.
+         // Just use `Cast' opcode otherwise. It's probably ignored.
          break;
        }
     }
-  
-  basicNode.opLabel = opLabel;
 }
 
 
@@ -134,7 +123,7 @@ InstructionNode::dumpNode(int indent) const
   
   cout << getInstruction()->getOpcodeName();
   
-  const vector<MachineInstr*>mvec = getInstruction()->getMachineInstrVec();
+  const vector<MachineInstr*> &mvec = getInstruction()->getMachineInstrVec();
   if (mvec.size() > 0)
     cout << "\tMachine Instructions:  ";
   for (unsigned int i=0; i < mvec.size(); i++)
@@ -148,12 +137,6 @@ InstructionNode::dumpNode(int indent) const
 }
 
 
-VRegListNode::VRegListNode()
-  : InstrTreeNode(NTVRegListNode, NULL)
-{
-  basicNode.opLabel = VRegListOp;
-}
-
 void
 VRegListNode::dumpNode(int indent) const
 {
@@ -164,12 +147,6 @@ VRegListNode::dumpNode(int indent) const
 }
 
 
-VRegNode::VRegNode(Value* _val)
-  : InstrTreeNode(NTVRegNode, _val)
-{
-  basicNode.opLabel = VRegNodeOp;
-}
-
 void
 VRegNode::dumpNode(int indent) const
 {
@@ -180,13 +157,6 @@ VRegNode::dumpNode(int indent) const
        << (int) getValue()->getValueType() << ")" << endl;
 }
 
-
-ConstantNode::ConstantNode(ConstPoolVal* constVal)
-  : InstrTreeNode(NTConstNode, constVal)
-{
-  basicNode.opLabel = ConstantNodeOp;
-}
-
 void
 ConstantNode::dumpNode(int indent) const
 {
@@ -197,13 +167,6 @@ ConstantNode::dumpNode(int indent) const
        << (int) getValue()->getValueType() << ")" << endl;
 }
 
-
-LabelNode::LabelNode(BasicBlock* _bblock)
-  : InstrTreeNode(NTLabelNode, _bblock)
-{
-  basicNode.opLabel = LabelNodeOp;
-}
-
 void
 LabelNode::dumpNode(int indent) const
 {
@@ -219,34 +182,30 @@ LabelNode::dumpNode(int indent) const
 // A forest of instruction trees, usually for a single method.
 //------------------------------------------------------------------------ 
 
-void
-InstrForest::buildTreesForMethod(Method *method)
+InstrForest::InstrForest(Method *M)
 {
-  for (Method::inst_iterator instrIter = method->inst_begin();
-       instrIter != method->inst_end();
-       ++instrIter)
-    {
-      Instruction *instr = *instrIter;
-      (void) this->buildTreeForInstruction(instr);
-    } 
+  for (Method::inst_iterator I = M->inst_begin(); I != M->inst_end(); ++I)
+    this->buildTreeForInstruction(*I);
 }
 
+InstrForest::~InstrForest()
+{
+  for (hash_map<const Instruction*, InstructionNode*>:: iterator I = begin();
+       I != end(); ++I)
+      delete (*I).second;
+}
 
 void
 InstrForest::dump() const
 {
-  for (hash_set<InstructionNode*>::const_iterator
-        treeRootIter = treeRoots.begin();
-       treeRootIter != treeRoots.end();
-       ++treeRootIter)
-    {
-      (*treeRootIter)->dump(/*dumpChildren*/ 1, /*indent*/ 0);
-    }
+  for (hash_set<InstructionNode*>::const_iterator I = treeRoots.begin();
+       I != treeRoots.end(); ++I)
+    (*I)->dump(/*dumpChildren*/ 1, /*indent*/ 0);
 }
 
 inline void
-InstrForest::noteTreeNodeForInstr(Instructioninstr,
-                                 InstructionNodetreeNode)
+InstrForest::noteTreeNodeForInstr(Instruction *instr,
+                                 InstructionNode *treeNode)
 {
   assert(treeNode->getNodeType() == InstrTreeNode::NTInstructionNode);
   (*this)[instr] = treeNode;
@@ -255,31 +214,31 @@ InstrForest::noteTreeNodeForInstr(Instruction* instr,
 
 
 inline void
-InstrForest::setLeftChild(InstrTreeNode* parent, InstrTreeNode* child)
+InstrForest::setLeftChild(InstrTreeNode *Par, InstrTreeNode *Chld)
 {
-  parent->basicNode.leftChild = & child->basicNode;
-  child->basicNode.parent = & parent->basicNode;
-  if (child->getNodeType() == InstrTreeNode::NTInstructionNode)
-    treeRoots.erase((InstructionNode*) child); // no longer a tree root
+  Par->LeftChild = Chld;
+  Chld->Parent = Par;
+  if (Chld->getNodeType() == InstrTreeNode::NTInstructionNode)
+    treeRoots.erase((InstructionNode*)Chld); // no longer a tree root
 }
 
-
 inline void
-InstrForest::setRightChild(InstrTreeNode* parent, InstrTreeNode* child)
+InstrForest::setRightChild(InstrTreeNode *Par, InstrTreeNode *Chld)
 {
-  parent->basicNode.rightChild = & child->basicNode;
-  child->basicNode.parent = & parent->basicNode;
-  if (child->getNodeType() == InstrTreeNode::NTInstructionNode)
-    treeRoots.erase((InstructionNode*) child); // no longer a tree root
+  Par->RightChild = Chld;
+  Chld->Parent = Par;
+  if (Chld->getNodeType() == InstrTreeNode::NTInstructionNode)
+    treeRoots.erase((InstructionNode*)Chld); // no longer a tree root
 }
 
 
 InstructionNode*
-InstrForest::buildTreeForInstruction(Instructioninstr)
+InstrForest::buildTreeForInstruction(Instruction *instr)
 {
-  InstructionNode* treeNode = this->getTreeNodeForInstr(instr);
-  if (treeNode != NULL)
-    {// treeNode has already been constructed for this instruction
+  InstructionNode *treeNode = getTreeNodeForInstr(instr);
+  if (treeNode)
+    {
+      // treeNode has already been constructed for this instruction
       assert(treeNode->getInstruction() == instr);
       return treeNode;
     }
@@ -287,11 +246,16 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
   // Otherwise, create a new tree node for this instruction.
   // 
   treeNode = new InstructionNode(instr);
-  this->noteTreeNodeForInstr(instr, treeNode);
+  noteTreeNodeForInstr(instr, treeNode);
+  
+  if (instr->getOpcode() == Instruction::Call)
+    { // Operands of call instruction
+      return treeNode;
+    }
   
   // If the instruction has more than 2 instruction operands,
   // then we need to create artificial list nodes to hold them.
-  // (Note that we only not count operands that get tree nodes, and not
+  // (Note that we only count operands that get tree nodes, and not
   // others such as branch labels for a branch or switch instruction.)
   //
   // To do this efficiently, we'll walk all operands, build treeNodes
@@ -302,16 +266,15 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
   // 
   int numChildren = 0;
   const unsigned int MAX_CHILD = 8;
-  static InstrTreeNodefixedChildArray[MAX_CHILD];
-  InstrTreeNode** childArray =
+  static InstrTreeNode *fixedChildArray[MAX_CHILD];
+  InstrTreeNode **childArray =
     (instr->getNumOperands() > MAX_CHILD)
-    ? new (InstrTreeNode*)[instr->getNumOperands()]
-    : fixedChildArray;
+    ? new (InstrTreeNode*)[instr->getNumOperands()] : fixedChildArray;
   
   //
   // Walk the operands of the instruction
   // 
-  for (Instruction::op_iterator O=instr->op_begin(); O != instr->op_end(); ++O)
+  for (Instruction::op_iterator O = instr->op_begin(); O!=instr->op_end(); ++O)
     {
       Value* operand = *O;
       
@@ -319,23 +282,25 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
       // method or module.  If the operand is an address type (i.e., label
       // or method) that is used in an non-branching operation, e.g., `add'.
       // that should be considered a data value.
-      
+    
       // Check latter condition here just to simplify the next IF.
       bool includeAddressOperand =
-       ((operand->getValueType() == Value::BasicBlockVal
-         || operand->getValueType() == Value::MethodVal)
-        && ! instr->isTerminator());
-        
-      if (   includeAddressOperand
-         || operand->getValueType() == Value::InstructionVal
-         || operand->getValueType() == Value::ConstantVal
-         || operand->getValueType() == Value::MethodArgumentVal)
-       {// This operand is a data value
-         
+       (isa<BasicBlock>(operand) || isa<Method>(operand))
+       && !instr->isTerminator();
+    
+      if (includeAddressOperand || isa<Instruction>(operand) ||
+         isa<ConstPoolVal>(operand) || isa<MethodArgument>(operand) ||
+         isa<GlobalVariable>(operand))
+       {
+         // This operand is a data value
+       
          // An instruction that computes the incoming value is added as a
          // child of the current instruction if:
          //   the value has only a single use
          //   AND both instructions are in the same basic block.
+         //   AND the current instruction is not a PHI (because the incoming
+         //            value is conceptually in a predecessor block,
+         //            even though it may be in the same static block)
          // 
          // (Note that if the value has only a single use (viz., `instr'),
          //  the def of the value can be safely moved just before instr
@@ -345,26 +310,26 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
          // is used directly, i.e., made a child of the instruction node.
          // 
          InstrTreeNode* opTreeNode;
-         if (operand->getValueType() == Value::InstructionVal
-             && operand->use_size() == 1
-             && ((Instruction*)operand)->getParent() == instr->getParent())
+         if (isa<Instruction>(operand) && operand->use_size() == 1 &&
+             cast<Instruction>(operand)->getParent() == instr->getParent() &&
+             !isa<PHINode>(instr) &&
+             instr->getOpcode() != Instruction::Call)
            {
              // Recursively create a treeNode for it.
-             opTreeNode =this->buildTreeForInstruction((Instruction*)operand);
+             opTreeNode = buildTreeForInstruction((Instruction*)operand);
            }
-         else if (operand->getValueType() == Value::ConstantVal)
+         else if (ConstPoolVal *CPV = dyn_cast<ConstPoolVal>(operand))
            {
              // Create a leaf node for a constant
-             opTreeNode = new ConstantNode((ConstPoolVal*) operand);
+             opTreeNode = new ConstantNode(CPV);
            }
          else
            {
              // Create a leaf node for the virtual register
              opTreeNode = new VRegNode(operand);
            }
-         
-         childArray[numChildren] = opTreeNode;
-         numChildren++;
+
+         childArray[numChildren++] = opTreeNode;
        }
     }
   
@@ -377,8 +342,7 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
   // and VRegList nodes as internal nodes.
   //-------------------------------------------------------------------- 
   
-  InstrTreeNode* parent = treeNode;            // new VRegListNode();
-  int n;
+  InstrTreeNode *parent = treeNode;
   
   if (numChildren > 2)
     {
@@ -392,14 +356,17 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
   
   // Insert the first child as a direct child
   if (numChildren >= 1)
-    this->setLeftChild(parent, childArray[0]);
+    setLeftChild(parent, childArray[0]);
+
+  int n;
   
   // Create a list node for children 2 .. N-1, if any
   for (n = numChildren-1; n >= 2; n--)
-    { // We have more than two children
-      InstrTreeNode* listNode = new VRegListNode();
-      this->setRightChild(parent, listNode);
-      this->setLeftChild(listNode, childArray[numChildren - n]);
+    {
+      // We have more than two children
+      InstrTreeNode *listNode = new VRegListNode();
+      setRightChild(parent, listNode);
+      setLeftChild(listNode, childArray[numChildren - n]);
       parent = listNode;
     }
   
@@ -407,13 +374,11 @@ InstrForest::buildTreeForInstruction(Instruction* instr)
   if (numChildren >= 2)
     {
       assert(n == 1);
-      this->setRightChild(parent, childArray[numChildren - 1]);
+      setRightChild(parent, childArray[numChildren - 1]);
     }
   
   if (childArray != fixedChildArray)
-    {
-      delete[] childArray; 
-    }
+    delete [] childArray; 
   
   return treeNode;
 }