Replaced uses of deprecated `MachineFunction::get(BasicBlock *BB)'.
[oota-llvm.git] / lib / Target / SparcV9 / LiveVar / BBLiveVar.cpp
index 81bbd387564b00aa03a77fba76bd410c7ef8dd3d..4b07ebc6323bb4fb346e317b91270fba1ba3243e 100644 (file)
@@ -5,18 +5,41 @@
 //===----------------------------------------------------------------------===//
 
 #include "BBLiveVar.h"
-#include "llvm/Analysis/LiveVar/MethodLiveVarInfo.h"
+#include "llvm/Analysis/LiveVar/FunctionLiveVarInfo.h"
 #include "llvm/CodeGen/MachineInstr.h"
-#include "llvm/BasicBlock.h"
+#include "llvm/CodeGen/MachineBasicBlock.h"
+#include "llvm/Support/CFG.h"
+#include "Support/SetOperations.h"
 
 /// BROKEN: Should not include sparc stuff directly into here
 #include "../../Target/Sparc/SparcInternals.h"  //  Only for PHI defn
 
 using std::cerr;
 
-BBLiveVar::BBLiveVar(const BasicBlock *bb, unsigned id)
-  : BB(bb), POID(id) {
+static AnnotationID AID(AnnotationManager::getID("Analysis::BBLiveVar"));
+
+BBLiveVar *BBLiveVar::CreateOnBB(const BasicBlock &BB, MachineBasicBlock &MBB,
+                                 unsigned POID) {
+  BBLiveVar *Result = new BBLiveVar(BB, MBB, POID);
+  BB.addAnnotation(Result);
+  return Result;
+}
+
+BBLiveVar *BBLiveVar::GetFromBB(const BasicBlock &BB) {
+  return (BBLiveVar*)BB.getAnnotation(AID);
+}
+
+void BBLiveVar::RemoveFromBB(const BasicBlock &BB) {
+  bool Deleted = BB.deleteAnnotation(AID);
+  assert(Deleted && "BBLiveVar annotation did not exist!");
+}
+
+
+BBLiveVar::BBLiveVar(const BasicBlock &bb, MachineBasicBlock &mbb, unsigned id)
+  : Annotation(AID), BB(bb), MBB(mbb), POID(id) {
   InSetChanged = OutSetChanged = false;
+
+  calcDefUseSets();
 }
 
 //-----------------------------------------------------------------------------
@@ -27,22 +50,20 @@ BBLiveVar::BBLiveVar(const BasicBlock *bb, unsigned id)
 //-----------------------------------------------------------------------------
 
 void BBLiveVar::calcDefUseSets() {
-  // get the iterator for machine instructions
-  const MachineCodeForBasicBlock &MIVec = BB->getMachineInstrVec();
-
   // iterate over all the machine instructions in BB
-  for (MachineCodeForBasicBlock::const_reverse_iterator MII = MIVec.rbegin(),
-         MIE = MIVec.rend(); MII != MIE; ++MII) {
+  for (MachineBasicBlock::const_reverse_iterator MII = MBB.rbegin(),
+         MIE = MBB.rend(); MII != MIE; ++MII) {
     const MachineInstr *MI = *MII;
     
-    if (DEBUG_LV > 1) {                            // debug msg
+    if (DEBUG_LV >= LV_DEBUG_Verbose) {
       cerr << " *Iterating over machine instr ";
       MI->dump();
       cerr << "\n";
     }
 
     // iterate over  MI operands to find defs
-    for (MachineInstr::val_const_op_iterator OpI(MI); !OpI.done(); ++OpI)
+    for (MachineInstr::const_val_op_iterator OpI = MI->begin(), OpE = MI->end();
+         OpI != OpE; ++OpI)
       if (OpI.isDef())      // add to Defs only if this operand is a def
        addDef(*OpI);
 
@@ -51,41 +72,51 @@ void BBLiveVar::calcDefUseSets() {
       if (MI->implicitRefIsDefined(i))
        addDef(MI->getImplicitRef(i));
     
-    bool IsPhi = MI->getOpCode() == PHI;
     // iterate over MI operands to find uses
-    for (MachineInstr::val_const_op_iterator OpI(MI); !OpI.done(); ++OpI) {
+    for (MachineInstr::const_val_op_iterator OpI = MI->begin(), OpE = MI->end();
+         OpI != OpE; ++OpI) {
       const Value *Op = *OpI;
 
-      if (Op->getType()->isLabelType())    
+      if (isa<BasicBlock>(Op))
        continue;             // don't process labels
 
-      if (!OpI.isDef()) {   // add to Defs only if this operand is a use
-       addUse(Op);
-
-       if (IsPhi) {         // for a phi node
-         // put args into the PhiArgMap (Val -> BB)
+      if (!OpI.isDef() || OpI.isDefAndUse()) {
+                                // add to Uses only if this operand is a use
+        //
+        // *** WARNING: The following code for handling dummy PHI machine
+        //     instructions is untested.  The previous code was broken and I
+        //     fixed it, but it turned out to be unused as long as Phi
+        //     elimination is performed during instruction selection.
+        // 
+        // Put Phi operands in UseSet for the incoming edge, not node.
+        // They must not "hide" later defs, and must be handled specially
+        // during set propagation over the CFG.
+       if (MI->getOpCode() == PHI) {         // for a phi node
           const Value *ArgVal = Op;
-         const Value *BBVal = *++OpI; // increment to point to BB of value
+         const BasicBlock *PredBB = cast<BasicBlock>(*++OpI); // next ptr is BB
          
-         PhiArgMap[ArgVal] = cast<BasicBlock>(BBVal); 
+         PredToEdgeInSetMap[PredBB].insert(ArgVal); 
          
-         if (DEBUG_LV > 1)
+         if (DEBUG_LV >= LV_DEBUG_Verbose)
            cerr << "   - phi operand " << RAV(ArgVal) << " came from BB "
-                 << RAV(PhiArgMap[ArgVal]) << "\n";
+                 << RAV(PredBB) << "\n";
        } // if( IsPhi )
+        else {
+          // It is not a Phi use: add to regular use set and remove later defs.
+          addUse(Op);
+        }
       } // if a use
     } // for all operands
 
     // do for implicit operands as well
     for (unsigned i = 0; i < MI->getNumImplicitRefs(); ++i) {
-      assert(!IsPhi && "Phi cannot have implicit opeands");
+      assert(MI->getOpCode() != PHI && "Phi cannot have implicit opeands");
       const Value *Op = MI->getImplicitRef(i);
 
-      if (Op->getType()->isLabelType())             // don't process labels
+      if (Op->getType() == Type::LabelTy)             // don't process labels
        continue;
 
-      if (!MI->implicitRefIsDefined(i))
+      if (!MI->implicitRefIsDefined(i) || MI->implicitRefIsDefinedAndUsed(i) )
        addUse(Op);
     }
   } // for all machine instructions
@@ -96,12 +127,12 @@ void BBLiveVar::calcDefUseSets() {
 //-----------------------------------------------------------------------------
 // To add an operand which is a def
 //-----------------------------------------------------------------------------
-void  BBLiveVar::addDef(const Value *Op) {
+void BBLiveVar::addDef(const Value *Op) {
   DefSet.insert(Op);     // operand is a def - so add to def set
-  InSet.erase(Op);       // this definition kills any uses
+  InSet.erase(Op);       // this definition kills any later uses
   InSetChanged = true; 
 
-  if (DEBUG_LV > 1) cerr << "  +Def: " << RAV(Op) << "\n";
+  if (DEBUG_LV >= LV_DEBUG_Verbose) cerr << "  +Def: " << RAV(Op) << "\n";
 }
 
 
@@ -110,25 +141,24 @@ void  BBLiveVar::addDef(const Value *Op) {
 //-----------------------------------------------------------------------------
 void  BBLiveVar::addUse(const Value *Op) {
   InSet.insert(Op);   // An operand is a use - so add to use set
-  OutSet.erase(Op);   // remove if there is a def below this use
+  DefSet.erase(Op);   // remove if there is a def below this use
   InSetChanged = true; 
 
-  if (DEBUG_LV > 1) cerr << "   Use: " << RAV(Op) << "\n";
+  if (DEBUG_LV >= LV_DEBUG_Verbose) cerr << "   Use: " << RAV(Op) << "\n";
 }
 
 
 //-----------------------------------------------------------------------------
 // Applies the transfer function to a basic block to produce the InSet using
-// the outset. 
+// the OutSet. 
 //-----------------------------------------------------------------------------
 
 bool BBLiveVar::applyTransferFunc() {
   // IMPORTANT: caller should check whether the OutSet changed 
   //           (else no point in calling)
 
-  LiveVarSet OutMinusDef;     // set to hold (Out[B] - Def[B])
-  OutMinusDef.setDifference(&OutSet, &DefSet);
-  InSetChanged = InSet.setUnion(&OutMinusDef);
+  ValueSet OutMinusDef = set_difference(OutSet, DefSet);
+  InSetChanged = set_union(InSet, OutMinusDef);
  
   OutSetChanged = false;      // no change to OutSet since transf func applied
   return InSetChanged;
@@ -136,25 +166,32 @@ bool BBLiveVar::applyTransferFunc() {
 
 
 //-----------------------------------------------------------------------------
-// calculates Out set using In sets of the predecessors
+// calculates Out set using In sets of the successors
 //-----------------------------------------------------------------------------
 
-bool BBLiveVar::setPropagate(LiveVarSet *OutSet, const LiveVarSet *InSet, 
+bool BBLiveVar::setPropagate(ValueSet *OutSet, const ValueSet *InSet, 
                              const BasicBlock *PredBB) {
   bool Changed = false;
-
-  // for all all elements in InSet
-  for (LiveVarSet::const_iterator InIt = InSet->begin(), InE = InSet->end();
-       InIt != InE; ++InIt) {  
-    const BasicBlock *PredBBOfPhiArg = PhiArgMap[*InIt];
-
-    // if this var is not a phi arg OR 
-    // it's a phi arg and the var went down from this BB
-    if (!PredBBOfPhiArg || PredBBOfPhiArg == PredBB)
-      if (OutSet->insert(*InIt).second)
-        Changed = true;
-  }
-
+  
+  // merge all members of InSet into OutSet of the predecessor
+  for (ValueSet::const_iterator InIt = InSet->begin(), InE = InSet->end();
+       InIt != InE; ++InIt)
+    if ((OutSet->insert(*InIt)).second)
+      Changed = true;
+  
+  // 
+  //**** WARNING: The following code for handling dummy PHI machine
+  //     instructions is untested.  See explanation above.
+  // 
+  // then merge all members of the EdgeInSet for the predecessor into the OutSet
+  const ValueSet& EdgeInSet = PredToEdgeInSetMap[PredBB];
+  for (ValueSet::const_iterator InIt = EdgeInSet.begin(), InE = EdgeInSet.end();
+       InIt != InE; ++InIt)
+    if ((OutSet->insert(*InIt)).second)
+      Changed = true;
+  // 
+  //****
+  
   return Changed;
 } 
 
@@ -163,18 +200,18 @@ bool BBLiveVar::setPropagate(LiveVarSet *OutSet, const LiveVarSet *InSet,
 // propogates in set to OutSets of PREDECESSORs
 //-----------------------------------------------------------------------------
 
-bool BBLiveVar::applyFlowFunc(std::map<const BasicBlock *, BBLiveVar *> &LVMap){
+bool BBLiveVar::applyFlowFunc({
   // IMPORTANT: caller should check whether inset changed 
   //            (else no point in calling)
-
+  
   // If this BB changed any OutSets of preds whose POID is lower, than we need
   // another iteration...
   //
   bool needAnotherIt = false;  
 
-  for (BasicBlock::pred_const_iterator PI = BB->pred_begin(),
-         PE = BB->pred_begin(); PI != PE ; ++PI) {
-    BBLiveVar *PredLVBB = LVMap[*PI];
+  for (pred_const_iterator PI = pred_begin(&BB), PE = pred_end(&BB);
+       PI != PE ; ++PI) {
+    BBLiveVar *PredLVBB = BBLiveVar::GetFromBB(**PI);
 
     // do set union
     if (setPropagate(&PredLVBB->OutSet, &InSet, *PI)) {  
@@ -194,14 +231,14 @@ bool BBLiveVar::applyFlowFunc(std::map<const BasicBlock *, BBLiveVar *> &LVMap){
 // ----------------- Methods For Debugging (Printing) -----------------
 
 void BBLiveVar::printAllSets() const {
-  cerr << "  Defs: ";   DefSet.printSet();  cerr << "\n";
-  cerr << "  In: ";   InSet.printSet();  cerr << "\n";
-  cerr << "  Out: ";   OutSet.printSet();  cerr << "\n";
+  cerr << "  Defs: "; printSet(DefSet);  cerr << "\n";
+  cerr << "  In: ";  printSet(InSet);  cerr << "\n";
+  cerr << "  Out: "; printSet(OutSet);  cerr << "\n";
 }
 
 void BBLiveVar::printInOutSets() const {
-  cerr << "  In: ";   InSet.printSet();  cerr << "\n";
-  cerr << "  Out: ";  OutSet.printSet();  cerr << "\n";
+  cerr << "  In: ";   printSet(InSet);  cerr << "\n";
+  cerr << "  Out: ";  printSet(OutSet);  cerr << "\n";
 }