Robust/src/Analysis/SSJava/FlowGraph.java

   1 package Analysis.SSJava;
   2
   3 import java.io.BufferedWriter;
   4 import java.io.File;
   5 import java.io.FileWriter;
   6 import java.io.IOException;
   7 import java.util.HashMap;
   8 import java.util.HashSet;
   9 import java.util.Iterator;
  10 import java.util.Map;
  11 import java.util.Set;
  12 import java.util.Map.Entry;
  13
  14 import Analysis.OoOJava.ConflictEdge;
  15 import Analysis.OoOJava.ConflictNode;
  16 import IR.Descriptor;
  17 import IR.FieldDescriptor;
  18 import IR.MethodDescriptor;
  19 import IR.VarDescriptor;
  20
  21 public class FlowGraph {
  22
  23   MethodDescriptor md;
  24
  25   Set<FlowNode> nodeSet;
  26   FlowNode thisVarNode;
  27
  28   // maps the composite representation of field/var descriptors to infer nodes
  29   Map<NTuple<Descriptor>, FlowNode> mapDescTupleToInferNode;
  30
  31   // maps an infer node to the set of neighbors which is pointed by the node
  32   Map<NTuple<Descriptor>, Set<FlowNode>> mapNodeToNeighborSet;
  33
  34   // maps a paramter descriptor to its index
  35   Map<Descriptor, Integer> mapParamDescToIdx;
  36   boolean debug = true;
  37
  38   public FlowGraph(MethodDescriptor md, Map<Descriptor, Integer> mapParamDescToIdx) {
  39     this.md = md;
  40     nodeSet = new HashSet<FlowNode>();
  41     mapDescTupleToInferNode = new HashMap<NTuple<Descriptor>, FlowNode>();
  42     mapNodeToNeighborSet = new HashMap<NTuple<Descriptor>, Set<FlowNode>>();
  43     this.mapParamDescToIdx = new HashMap<Descriptor, Integer>();
  44     this.mapParamDescToIdx.putAll(mapParamDescToIdx);
  45
  46     // create a node for 'this' varialbe
  47     NTuple<Descriptor> thisDescTuple = new NTuple<Descriptor>();
  48     thisDescTuple.add(md.getThis());
  49     FlowNode thisNode = new FlowNode(thisDescTuple, true);
  50     NTuple<Descriptor> thisVarTuple = new NTuple<Descriptor>();
  51     thisVarTuple.add(md.getThis());
  52     createNewFlowNode(thisVarTuple);
  53     thisVarNode = thisNode;
  54
  55   }
  56
  57   public Set<FlowNode> getNodeSet() {
  58     return nodeSet;
  59   }
  60
  61   public Set<FlowNode> getParameterNodeSet() {
  62     Set<FlowNode> paramNodeSet = new HashSet<FlowNode>();
  63     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
  64       FlowNode fn = (FlowNode) iterator.next();
  65       if (fn.isParameter()) {
  66         paramNodeSet.add(fn);
  67       }
  68     }
  69     return paramNodeSet;
  70   }
  71
  72   public void addNeighbor(FlowNode node, FlowNode neighbor) {
  73     Set<FlowNode> set = mapNodeToNeighborSet.get(node);
  74     if (set == null) {
  75       set = new HashSet<FlowNode>();
  76     }
  77     set.add(neighbor);
  78
  79     System.out.println("add a new neighbor " + neighbor + " to " + node);
  80   }
  81
  82   public boolean hasEdge(NTuple<Descriptor> fromDescTuple, NTuple<Descriptor> toDescTuple) {
  83
  84     FlowNode fromNode = mapDescTupleToInferNode.get(fromDescTuple);
  85     FlowNode toNode = mapDescTupleToInferNode.get(toDescTuple);
  86
  87     Set<FlowEdge> fromNodeOutEdgeSet = fromNode.getOutEdgeSet();
  88     for (Iterator iterator = fromNodeOutEdgeSet.iterator(); iterator.hasNext();) {
  89       FlowEdge flowEdge = (FlowEdge) iterator.next();
  90       if (flowEdge.getDst().equals(toNode)) {
  91         return true;
  92       } else {
  93         if (hasEdge(flowEdge.getDst().getDescTuple(), toDescTuple)) {
  94           return true;
  95         }
  96       }
  97     }
  98
  99     return false;
 100   }
 101
 102   public void addValueFlowEdge(NTuple<Descriptor> fromDescTuple, NTuple<Descriptor> toDescTuple) {
 103
 104     FlowNode fromNode = mapDescTupleToInferNode.get(fromDescTuple);
 105     FlowNode toNode = mapDescTupleToInferNode.get(toDescTuple);
 106
 107     System.out.println("create an edge from " + fromNode + " to " + toNode);
 108
 109     int fromTupleSize = fromDescTuple.size();
 110     NTuple<Descriptor> curTuple = new NTuple<Descriptor>();
 111     for (int i = 0; i < fromTupleSize; i++) {
 112       Descriptor desc = fromDescTuple.get(i);
 113       curTuple.add(desc);
 114       addFlowEdge(getFlowNode(curTuple), toNode, fromDescTuple, toDescTuple);
 115     }
 116
 117     int toTupleSize = toDescTuple.size();
 118     curTuple = new NTuple<Descriptor>();
 119     for (int i = 0; i < toTupleSize; i++) {
 120       Descriptor desc = toDescTuple.get(i);
 121       curTuple.add(desc);
 122       addFlowEdge(fromNode, getFlowNode(curTuple), fromDescTuple, toDescTuple);
 123     }
 124
 125   }
 126
 127   private void addFlowEdge(FlowNode fromNode, FlowNode toNode, NTuple<Descriptor> initTuple,
 128       NTuple<Descriptor> endTuple) {
 129
 130     FlowEdge edge = new FlowEdge(fromNode, toNode, initTuple, endTuple);
 131     fromNode.addOutEdge(edge);
 132
 133     System.out.println("add a new edge=" + edge);
 134
 135   }
 136
 137   public FlowNode getFlowNode(NTuple<Descriptor> descTuple) {
 138     if (mapDescTupleToInferNode.containsKey(descTuple)) {
 139       return mapDescTupleToInferNode.get(descTuple);
 140     } else {
 141       FlowNode node = createNewFlowNode(descTuple);
 142       return node;
 143     }
 144   }
 145
 146   public FlowNode getThisVarNode() {
 147     return thisVarNode;
 148   }
 149
 150   public FlowNode createNewFlowNode(NTuple<Descriptor> tuple) {
 151
 152     if (!mapDescTupleToInferNode.containsKey(tuple)) {
 153
 154       FlowNode node = new FlowNode(tuple, isParamter(tuple));
 155       mapDescTupleToInferNode.put(tuple, node);
 156       nodeSet.add(node);
 157
 158       if (tuple.size() > 1) {
 159         NTuple<Descriptor> baseTuple = tuple.subList(0, tuple.size() - 1);
 160         getFlowNode(baseTuple).addFieldNode(node);
 161       }
 162
 163       System.out.println("Creating new node=" + node);
 164       return node;
 165     } else {
 166       return mapDescTupleToInferNode.get(tuple);
 167     }
 168
 169   }
 170
 171   public boolean isParamter(NTuple<Descriptor> tuple) {
 172     // return true if a descriptor tuple is started with a parameter descriptor
 173     Descriptor firstIdxDesc = tuple.get(0);
 174     return mapParamDescToIdx.containsKey(firstIdxDesc);
 175   }
 176
 177   public int getParamIdx(NTuple<Descriptor> tuple) {
 178     Descriptor firstDesc = tuple.get(0);
 179     return mapParamDescToIdx.get(firstDesc).intValue();
 180   }
 181
 182   private void drawEdges(FlowNode node, BufferedWriter bw, Set<FlowNode> addedNodeSet,
 183       Set<FlowEdge> addedEdgeSet) throws IOException {
 184
 185     Set<FlowEdge> edgeSet = node.getOutEdgeSet();
 186
 187     for (Iterator<FlowEdge> iterator = edgeSet.iterator(); iterator.hasNext();) {
 188       FlowEdge flowEdge = iterator.next();
 189
 190       FlowNode u = flowEdge.getSrc();
 191       FlowNode v = flowEdge.getDst();
 192
 193       if (u.getDescTuple().equals(flowEdge.getInitTuple())
 194           && v.getDescTuple().equals(flowEdge.getEndTuple())) {
 195         // only draw an edge of the actual value flow
 196
 197         if (!addedEdgeSet.contains(flowEdge)) {
 198
 199           if (!addedNodeSet.contains(u)) {
 200             drawNode(u, bw);
 201             addedNodeSet.add(u);
 202           }
 203           if (!addedNodeSet.contains(v)) {
 204             drawNode(v, bw);
 205             addedNodeSet.add(v);
 206           }
 207
 208           bw.write("" + u.getID() + " -> " + v.getID() + ";\n");
 209           addedEdgeSet.add(flowEdge);
 210         }
 211       }
 212
 213     }
 214
 215   }
 216
 217   private void drawNode(FlowNode node, BufferedWriter bw) throws IOException {
 218     bw.write(node.getID() + " [label=\"" + node.getPrettyID() + "\"]" + ";\n");
 219   }
 220
 221   public void writeGraph() throws java.io.IOException {
 222
 223     String graphName = md.toString();
 224     graphName = graphName.replaceAll("[\\W]", "");
 225
 226     BufferedWriter bw = new BufferedWriter(new FileWriter(graphName + ".dot"));
 227     bw.write("digraph " + graphName + " {\n");
 228     bw.write("compound=true;\n");
 229
 230     // then visit every flow node
 231
 232     Iterator<FlowNode> iter = nodeSet.iterator();
 233
 234     Set<FlowEdge> addedEdgeSet = new HashSet<FlowEdge>();
 235     Set<FlowNode> addedNodeSet = new HashSet<FlowNode>();
 236
 237     while (iter.hasNext()) {
 238       FlowNode node = iter.next();
 239
 240       if (node.getDescTuple().size() == 1) {
 241         // here, we just care about the local variable
 242         if (node.getFieldNodeSet().size() > 0) {
 243           drawSubgraph(node, bw, addedEdgeSet);
 244         }
 245       }
 246       drawEdges(node, bw, addedNodeSet, addedEdgeSet);
 247
 248     }
 249
 250     bw.write("}\n");
 251     bw.close();
 252
 253   }
 254
 255   public boolean constainsNode(FlowNode node) {
 256     return nodeSet.contains(node);
 257   }
 258
 259   private void drawSubgraph(FlowNode node, BufferedWriter bw, Set<FlowEdge> addedSet)
 260       throws IOException {
 261
 262     bw.write("subgraph cluster_" + node.getID() + "{\n");
 263     bw.write("label=\"" + node.getPrettyID() + "\";\n");
 264
 265     Set<FlowNode> fieldNodeSet = node.getFieldNodeSet();
 266     for (Iterator iterator = fieldNodeSet.iterator(); iterator.hasNext();) {
 267       FlowNode fieldNode = (FlowNode) iterator.next();
 268       if (fieldNode.getFieldNodeSet().size() > 0) {
 269         drawSubgraph(fieldNode, bw, addedSet);
 270       } else {
 271         Descriptor desc = fieldNode.getDescTuple().getLastElement();
 272         if (desc instanceof VarDescriptor) {
 273           VarDescriptor varDesc = (VarDescriptor) desc;
 274           if (varDesc.getType().isPrimitive()) {
 275             bw.write(fieldNode.getID() + " [label=\"" + fieldNode.getPrettyID() + "\"];\n");
 276           }
 277         } else if (desc instanceof FieldDescriptor) {
 278           FieldDescriptor fieldDesc = (FieldDescriptor) desc;
 279           if (fieldDesc.getType().isPrimitive()) {
 280             bw.write(fieldNode.getID() + " [label=\"" + fieldNode.getPrettyID() + "\"];\n");
 281           }
 282         }
 283       }
 284     }
 285
 286     bw.write("}\n");
 287   }
 288 }