run ooojava and rcrpointer that print out effects and annotate them with the source...
[IRC.git] / Robust / src / Analysis / Disjoint / EffectsAnalysis.java
index 0e81f1b84111db6ddae6f56386898f5cb516bc8f..90d2b8e342d2ed42cec4465e0597965a70d615ca 100644 (file)
@@ -1,16 +1,16 @@
 package Analysis.Disjoint;
 
 import java.util.*;
+import java.util.Map.Entry;
 import java.io.*;
 
-import IR.FieldDescriptor;
-import IR.Flat.FlatCall;
-import IR.Flat.FlatMethod;
-import IR.Flat.TempDescriptor;
-import IR.Flat.FlatSESEEnterNode;
+import IR.*;
+import IR.Flat.*;
+import Analysis.Pointer.Edge;
+import Analysis.Pointer.AllocFactory.AllocNode;
 
 /////////////////////////////////////////////
-// 
+//
 //  Effects analysis computes read/write/strong
 //  update and other sorts of effects for the
 //  scope of a method or rblock.  The effects
@@ -27,146 +27,213 @@ import IR.Flat.FlatSESEEnterNode;
 
 public class EffectsAnalysis {
 
-  private Hashtable<FlatMethod, EffectSet> fm2effectSet;
+  // the effects analysis should combine taints
+  // that match except for predicates--preds just
+  // support interprocedural analysis
+  private Hashtable<Taint, Set<Effect>> taint2effects;
+
+  // redundant views of the effect set for
+  // efficient retrieval
+  private Hashtable<FlatSESEEnterNode, Hashtable<Taint, Set<Effect>> > sese2te;
+  private Hashtable<FlatNode,          Hashtable<Taint, Set<Effect>> > stallSite2te;
+
+  public static State state;
+  public static BuildStateMachines buildStateMachines;
+
 
   public EffectsAnalysis() {
-    fm2effectSet = new Hashtable<FlatMethod, EffectSet>();
+    taint2effects = new Hashtable<Taint, Set<Effect>>();
+
+    sese2te      = new Hashtable<FlatSESEEnterNode, Hashtable<Taint, Set<Effect>> >();
+    stallSite2te = new Hashtable<FlatNode,          Hashtable<Taint, Set<Effect>> >();
   }
 
-  public void analyzeFlatFieldNode(FlatMethod fmContaining, ReachGraph rg, TempDescriptor rhs, FieldDescriptor fld) {
 
-    VariableNode vn = rg.td2vn.get(rhs);
+  public Set<Effect> getEffects(Taint t) {
+    Taint tNoPreds = Canonical.changePredsTo(t,
+                                             ReachGraph.predsEmpty
+                                             );
+    return taint2effects.get(tNoPreds);
+  }
 
-    for (Iterator<RefEdge> iterator = vn.iteratorToReferencees(); iterator.hasNext();) {
-      RefEdge edge = iterator.next();
-      TaintSet taintSet = edge.getTaints();
-      AllocSite affectedAlloc = edge.getDst().getAllocSite();
-      for (Iterator<Taint> taintSetIter = taintSet.iterator(); taintSetIter.hasNext();) {
-        Taint taint = taintSetIter.next();
+  public Iterator iteratorTaintEffectPairs() {
+    return taint2effects.entrySet().iterator();
+  }
 
-        EffectSet effectSet = fm2effectSet.get(fmContaining);
-        if (effectSet == null) {
-          effectSet = new EffectSet();
-        }
-        
-        Effect effect = new Effect(affectedAlloc, Effect.read, fld);
-        effectSet.addEffect(taint, effect);
+  protected void add(Taint t, Effect e, FlatNode currentProgramPoint) {
+    Taint tNoPreds = Canonical.changePredsTo(t,
+                                             ReachGraph.predsEmpty
+                                             );
+
+    if( state.RCR ) {
+      buildStateMachines.addToStateMachine(t, e, currentProgramPoint);
+    }
+
+    // add to the global bag
+    Set<Effect> effectSet = taint2effects.get(tNoPreds);
+    if (effectSet == null) {
+      effectSet = new HashSet<Effect>();
+    }
+    effectSet.add(e);
+    taint2effects.put(tNoPreds, effectSet);
 
-        fm2effectSet.put(fmContaining, effectSet);
+    // add to the alternate retrieval bags
+    if( t.getSESE() != null ) {
+      FlatSESEEnterNode sese = t.getSESE();
+
+      Hashtable<Taint, Set<Effect>> te = sese2te.get(sese);
+      if( te == null ) {
+        te = new Hashtable<Taint, Set<Effect>>();
+      }
+
+      Set<Effect> effects = te.get(tNoPreds);
+      if (effects == null) {
+        effects = new HashSet<Effect>();
+      }
+      effects.add(e);
+      te.put(tNoPreds, effects);
+
+      sese2te.put(sese, te);
+
+    } else {
+      assert t.getStallSite() != null;
+      FlatNode stallSite = t.getStallSite();
+
+      Hashtable<Taint, Set<Effect>> te = stallSite2te.get(stallSite);
+      if( te == null ) {
+        te = new Hashtable<Taint, Set<Effect>>();
+      }
+
+      Set<Effect> effects = te.get(tNoPreds);
+      if (effects == null) {
+        effects = new HashSet<Effect>();
       }
+      effects.add(e);
+      te.put(tNoPreds, effects);
+      stallSite2te.put(stallSite, te);
     }
   }
 
-  public void analyzeFlatSetFieldNode(FlatMethod fmContaining, ReachGraph rg, TempDescriptor lhs, FieldDescriptor fld, boolean strongUpdate) {
 
-    VariableNode vn = rg.td2vn.get(lhs);
+  public Hashtable<Taint, Set<Effect>> get(FlatSESEEnterNode sese) {
+    return sese2te.get(sese);
+  }
 
-    for (Iterator<RefEdge> iterator = vn.iteratorToReferencees(); iterator.hasNext();) {
-      RefEdge edge = iterator.next();
-      TaintSet taintSet = edge.getTaints();
-      AllocSite affectedAlloc = edge.getDst().getAllocSite();
-      for (Iterator<Taint> taintSetIter = taintSet.iterator(); taintSetIter.hasNext();) {
-        Taint taint = taintSetIter.next();
+  public Hashtable<Taint, Set<Effect>> get(FlatNode stallSite) {
+    return stallSite2te.get(stallSite);
+  }
 
-        EffectSet effectSet = fm2effectSet.get(fmContaining);
-        if (effectSet == null) {
-          effectSet = new EffectSet();
-        }
-        
-        Effect effect = new Effect(affectedAlloc, Effect.write, fld);
-        effectSet.addEffect(taint, effect);
 
-        if (strongUpdate) {
-          effectSet.addEffect(taint, 
-                              new Effect(affectedAlloc,
-                                         Effect.strongupdate,
-                                         fld)
-                              );
-        }
 
-        fm2effectSet.put(fmContaining, effectSet);
+  public void analyzeFlatFieldNode(ReachGraph rg, TempDescriptor rhs, FieldDescriptor fld, FlatNode currentProgramPoint) {
+
+    VariableNode vn = rg.td2vn.get(rhs);
+    if( vn == null ) {
+      return;
+    }
+
+    for (Iterator<RefEdge> iterator = vn.iteratorToReferencees(); iterator.hasNext(); ) {
+      RefEdge edge          = iterator.next();
+      TaintSet taintSet      = edge.getTaints();
+      AllocSite affectedAlloc = edge.getDst().getAllocSite();
+      Effect    effect        = new Effect(affectedAlloc, Effect.read, fld, currentProgramPoint);
+
+      for (Iterator<Taint> taintSetIter = taintSet.iterator(); taintSetIter.hasNext(); ) {
+        Taint taint = taintSetIter.next();
+        add(taint, effect, currentProgramPoint);
       }
     }
   }
 
-  public void analyzeFlatCall(FlatMethod fmContaining, FlatMethod fmCallee, Hashtable<Taint, TaintSet> tCallee2tsCaller) {
-    
-    EffectSet esCaller = getEffectSet(fmContaining);
-    if( esCaller == null ) {
-      esCaller = new EffectSet();
+  public void analyzeFlatFieldNode(Set<Edge> sources, FieldDescriptor fld, FlatNode currentProgramPoint) {
+    for (Edge edge:sources) {
+      TaintSet  taintSet      = edge.getTaints();
+      Alloc     affectedAlloc = edge.getDst().getAllocSite();
+      Effect    effect        = new Effect(affectedAlloc, Effect.read, fld, currentProgramPoint);
+
+      if (taintSet!=null)
+        for (Taint taint : taintSet.getTaints()) {
+          add(taint, effect, currentProgramPoint);
+        }
     }
-    
-    EffectSet esCallee = getEffectSet(fmCallee);
-    if( esCallee == null ) {
-      esCallee = new EffectSet();
+  }
+
+  public void analyzeFlatSetFieldNode(ReachGraph rg, TempDescriptor lhs, FieldDescriptor fld, FlatNode currentProgramPoint, boolean strongUpdate) {
+
+    VariableNode vn = rg.td2vn.get(lhs);
+    if( vn == null ) {
+      return;
     }
 
-    Iterator meItr = esCallee.getAllEffectPairs();
-    while( meItr.hasNext() ) {
-      Map.Entry       me      = (Map.Entry)       meItr.next();
-      Taint           tCallee = (Taint)           me.getKey();
-      HashSet<Effect> effects = (HashSet<Effect>) me.getValue();
+    for (Iterator<RefEdge> iterator = vn.iteratorToReferencees(); iterator.hasNext(); ) {
+      RefEdge edge          = iterator.next();
+      TaintSet taintSet      = edge.getTaints();
+      AllocSite affectedAlloc = edge.getDst().getAllocSite();
+      Effect    effect        = new Effect(affectedAlloc, Effect.write, fld, currentProgramPoint);
+      Effect    effectSU      = null;
 
-      if( tCallee2tsCaller.containsKey( tCallee ) ) {
+      if (strongUpdate) {
+        effectSU = new Effect(affectedAlloc, Effect.strongupdate, fld, currentProgramPoint);
+      }
 
-        Iterator<Taint> tItr = tCallee2tsCaller.get( tCallee ).iterator();
-        while( tItr.hasNext() ) {
-          Taint tCaller = tItr.next();
+      for (Iterator<Taint> taintSetIter = taintSet.iterator(); taintSetIter.hasNext(); ) {
+        Taint taint = taintSetIter.next();
+        add(taint, effect, currentProgramPoint);
 
-          Iterator<Effect> eItr = effects.iterator();
-          while( eItr.hasNext() ) {
-            Effect e = eItr.next();
-            
-            esCaller.addEffect( tCaller, e );
-          }
+        if (strongUpdate) {
+          add(taint, effectSU, currentProgramPoint);
         }
       }
     }
+  }
 
-    fm2effectSet.put(fmContaining, esCaller);    
+
+  public void analyzeFlatSetFieldNode(Set<Edge> dstedges, FieldDescriptor fld, FlatNode currentProgramPoint) {
+    for (Edge edge : dstedges) {
+      TaintSet taintSet = edge.getTaints();
+      Alloc affectedAlloc = edge.getDst().getAllocSite();
+      Effect effect = new Effect(affectedAlloc, Effect.write, fld, currentProgramPoint);
+      if (taintSet!=null)
+        for (Taint taint : taintSet.getTaints()) {
+          add(taint, effect, currentProgramPoint);
+        }
+    }
   }
 
-  public EffectSet getEffectSet(FlatMethod fm) {
-    return fm2effectSet.get(fm);
+
+  public String toString() {
+    return taint2effects.toString();
   }
 
-  public void writeEffectsPerMethod( String outfile ) {
+  public void writeEffects(String outfile) {
     try {
       BufferedWriter bw = new BufferedWriter(new FileWriter(outfile));
-      
-      bw.write( "Effects\n\n" );
-
-      Iterator meItr1 = fm2effectSet.entrySet().iterator();
-      while( meItr1.hasNext() ) {
-        Map.Entry  me1 = (Map.Entry)  meItr1.next();
-        FlatMethod fm  = (FlatMethod) me1.getKey();
-        EffectSet  es  = (EffectSet)  me1.getValue();
-
-        bw.write( "\n"+fm+"\n--------------\n" );
-
-        Iterator meItr2 = es.getAllEffectPairs();
-        while( meItr2.hasNext() ) {
-          Map.Entry       me2     = (Map.Entry)       meItr2.next();
-          Taint           taint   = (Taint)           me2.getKey();
-          HashSet<Effect> effects = (HashSet<Effect>) me2.getValue();
-
-          Iterator<Effect> eItr = effects.iterator();
-          while( eItr.hasNext() ) {
-            Effect e = eItr.next();
-            
-            bw.write( "  "+taint+"-->"+e+"\n" );
-          }
+
+      bw.write("Effects\n---------------\n\n");
+
+      Iterator meItr = taint2effects.entrySet().iterator();
+      while( meItr.hasNext() ) {
+        Map.Entry me      = (Map.Entry)meItr.next();
+        Taint taint   = (Taint)       me.getKey();
+        Set<Effect> effects = (Set<Effect>)me.getValue();
+
+        Iterator<Effect> eItr = effects.iterator();
+        while( eItr.hasNext() ) {
+          Effect e = eItr.next();
+
+          bw.write(taint+"-->"+e+"\n");
         }
       }
 
       bw.close();
-    } catch( IOException e ) {}
+    } catch( IOException e ) {
+    }
   }
 
   /*
    * public MethodEffects getMethodEffectsByMethodContext(MethodContext mc){
    * return mapMethodContextToMethodEffects.get(mc); }
-   * 
+   *
    * public void createNewMapping(MethodContext mcNew) { if(!methodeffects)
    * return; if (!mapMethodContextToMethodEffects.containsKey(mcNew)) {
    * MethodEffects meNew = new MethodEffects();
@@ -188,66 +255,70 @@ public class EffectsAnalysis {
    * return; MethodEffects me = mapMethodContextToMethodEffects.get(mc);
    * me.analyzeFlatFieldNode(og, srcDesc, fieldDesc);
    * mapMethodContextToMethodEffects.put(mc, me); }
-   * 
+   *
    * public void analyzeFlatSetFieldNode(MethodContext mc, OwnershipGraph og,
    * TempDescriptor dstDesc, FieldDescriptor fieldDesc) { if(!methodeffects)
    * return; MethodEffects me = mapMethodContextToMethodEffects.get(mc);
    * me.analyzeFlatSetFieldNode(og, dstDesc, fieldDesc);
    * mapMethodContextToMethodEffects.put(mc, me); }
-   * 
+   *
    * public void analyzeFlatSetElementNode(MethodContext mc, OwnershipGraph og,
    * TempDescriptor dstDesc, FieldDescriptor fieldDesc) { if(!methodeffects)
    * return; MethodEffects me = mapMethodContextToMethodEffects.get(mc);
    * me.analyzeFlatSetElementNode(og, dstDesc, fieldDesc);
    * mapMethodContextToMethodEffects.put(mc, me); }
-   * 
+   *
    * public void analyzeFlatElementNode(MethodContext mc, OwnershipGraph og,
    * TempDescriptor dstDesc, FieldDescriptor fieldDesc) { if(!methodeffects)
    * return; MethodEffects me = mapMethodContextToMethodEffects.get(mc);
    * me.analyzeFlatElementNode(og, dstDesc, fieldDesc);
    * mapMethodContextToMethodEffects.put(mc, me); }
-   * 
-   * 
+   *
+   *
    * public void writeMethodEffectsResult() throws IOException {
-   * 
+   *
    * try { BufferedWriter bw = new BufferedWriter(new FileWriter(
    * "MethodEffects_report.txt"));
-   * 
+   *
    * Set<MethodContext> mcSet = mapMethodContextToMethodEffects.keySet();
    * Iterator<MethodContext> mcIter = mcSet.iterator(); while (mcIter.hasNext())
    * { MethodContext mc = mcIter.next(); MethodDescriptor md =
    * (MethodDescriptor) mc.getDescriptor();
-   * 
+   *
    * int startIdx = 0; if (!md.isStatic()) { startIdx = 1; }
-   * 
+   *
    * MethodEffects me = mapMethodContextToMethodEffects.get(mc); EffectsSet
    * effectsSet = me.getEffects();
-   * 
+   *
    * bw.write("Method " + mc + " :\n"); for (int i = startIdx; i <
    * md.numParameters() + startIdx; i++) {
-   * 
+   *
    * String paramName = md.getParamName(i - startIdx);
-   * 
+   *
    * Set<EffectsKey> effectSet = effectsSet.getReadingSet(i); String keyStr =
    * "{"; if (effectSet != null) { Iterator<EffectsKey> effectIter =
    * effectSet.iterator(); while (effectIter.hasNext()) { EffectsKey key =
    * effectIter.next(); keyStr += " " + key; } } keyStr += " }";
    * bw.write("  Paramter " + paramName + " ReadingSet=" + keyStr + "\n");
-   * 
+   *
    * effectSet = effectsSet.getWritingSet(new Integer(i)); keyStr = "{"; if
    * (effectSet != null) { Iterator<EffectsKey> effectIter =
    * effectSet.iterator(); while (effectIter.hasNext()) { EffectsKey key =
    * effectIter.next(); keyStr += " " + key; } }
-   * 
+   *
    * keyStr += " }"; bw.write("  Paramter " + paramName + " WritingngSet=" +
    * keyStr + "\n");
-   * 
+   *
    * } bw.write("\n");
-   * 
+   *
    * }
-   * 
+   *
    * bw.close(); } catch (IOException e) { System.err.println(e); }
-   * 
+   *
    * }
    */
+
+  public Hashtable<Taint, Set<Effect>> getAllEffects() {
+    return taint2effects;
+  }
 }