changes on the SJava inference
[IRC.git] / 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   boolean debug = true;
35
36   public FlowGraph(MethodDescriptor md) {
37     this.md = md;
38     nodeSet = new HashSet<FlowNode>();
39     mapDescTupleToInferNode = new HashMap<NTuple<Descriptor>, FlowNode>();
40     mapNodeToNeighborSet = new HashMap<NTuple<Descriptor>, Set<FlowNode>>();
41
42     // create a node for 'this' varialbe
43     NTuple<Descriptor> thisDescTuple = new NTuple<Descriptor>();
44     thisDescTuple.add(md.getThis());
45     FlowNode thisNode = new FlowNode(thisDescTuple);
46     NTuple<Descriptor> thisVarTuple = new NTuple<Descriptor>();
47     thisVarTuple.add(md.getThis());
48     createNewFlowNode(thisVarTuple);
49     thisVarNode = thisNode;
50
51   }
52
53   public Set<FlowNode> getNodeSet() {
54     return nodeSet;
55   }
56
57   public void addNeighbor(FlowNode node, FlowNode neighbor) {
58     Set<FlowNode> set = mapNodeToNeighborSet.get(node);
59     if (set == null) {
60       set = new HashSet<FlowNode>();
61     }
62     set.add(neighbor);
63
64     System.out.println("add a new neighbor " + neighbor + " to " + node);
65   }
66
67   public void addValueFlowEdge(NTuple<Descriptor> fromDescTuple, NTuple<Descriptor> toDescTuple) {
68
69     FlowNode fromNode = mapDescTupleToInferNode.get(fromDescTuple);
70     FlowNode toNode = mapDescTupleToInferNode.get(toDescTuple);
71
72     System.out.println("create an edge from " + fromNode + " to " + toNode);
73
74     int fromTupleSize = fromDescTuple.size();
75     NTuple<Descriptor> curTuple = new NTuple<Descriptor>();
76     for (int i = 0; i < fromTupleSize; i++) {
77       Descriptor desc = fromDescTuple.get(i);
78       curTuple.add(desc);
79       addFlowEdge(getFlowNode(curTuple), toNode, fromDescTuple, toDescTuple);
80     }
81
82     int toTupleSize = toDescTuple.size();
83     curTuple = new NTuple<Descriptor>();
84     for (int i = 0; i < toTupleSize; i++) {
85       Descriptor desc = toDescTuple.get(i);
86       curTuple.add(desc);
87       addFlowEdge(fromNode, getFlowNode(curTuple), fromDescTuple, toDescTuple);
88     }
89
90   }
91
92   private void addFlowEdge(FlowNode fromNode, FlowNode toNode, NTuple<Descriptor> initTuple,
93       NTuple<Descriptor> endTuple) {
94
95     FlowEdge edge = new FlowEdge(fromNode, toNode, initTuple, endTuple);
96     fromNode.addOutEdge(edge);
97
98     System.out.println("add a new edge=" + edge);
99
100   }
101
102   public FlowNode getFlowNode(NTuple<Descriptor> descTuple) {
103     if (mapDescTupleToInferNode.containsKey(descTuple)) {
104       return mapDescTupleToInferNode.get(descTuple);
105     } else {
106       FlowNode node = createNewFlowNode(descTuple);
107       return node;
108     }
109   }
110
111   public FlowNode getThisVarNode() {
112     return thisVarNode;
113   }
114
115   public FlowNode createNewFlowNode(NTuple<Descriptor> tuple) {
116
117     if (!mapDescTupleToInferNode.containsKey(tuple)) {
118       FlowNode node = new FlowNode(tuple);
119       mapDescTupleToInferNode.put(tuple, node);
120       nodeSet.add(node);
121
122       if (tuple.size() > 1) {
123         NTuple<Descriptor> baseTuple = tuple.subList(0, tuple.size() - 1);
124         getFlowNode(baseTuple).addFieldNode(node);
125       }
126
127       System.out.println("Creating new node=" + node);
128       return node;
129     } else {
130       return mapDescTupleToInferNode.get(tuple);
131     }
132
133   }
134
135   private void drawEdges(FlowNode node, BufferedWriter bw, Set<FlowNode> addedNodeSet,
136       Set<FlowEdge> addedEdgeSet) throws IOException {
137
138     Set<FlowEdge> edgeSet = node.getOutEdgeSet();
139
140     for (Iterator<FlowEdge> iterator = edgeSet.iterator(); iterator.hasNext();) {
141       FlowEdge flowEdge = iterator.next();
142
143       FlowNode u = flowEdge.getSrc();
144       FlowNode v = flowEdge.getDst();
145
146       if (u.getDescTuple().equals(flowEdge.getInitTuple())
147           && v.getDescTuple().equals(flowEdge.getEndTuple())) {
148         // only draw an edge of the actual value flow
149
150         if (!addedEdgeSet.contains(flowEdge)) {
151
152           if (!addedNodeSet.contains(u)) {
153             drawNode(u, bw);
154             addedNodeSet.add(u);
155           }
156           if (!addedNodeSet.contains(v)) {
157             drawNode(v, bw);
158             addedNodeSet.add(v);
159           }
160
161           bw.write("" + u.getID() + " -> " + v.getID() + ";\n");
162           addedEdgeSet.add(flowEdge);
163         }
164       }
165
166     }
167
168   }
169
170   private void drawNode(FlowNode node, BufferedWriter bw) throws IOException {
171     bw.write(node.getID() + " [label=\"" + node.getPrettyID() + "\"]" + ";\n");
172   }
173
174   public void writeGraph() throws java.io.IOException {
175
176     String graphName = md.toString();
177     graphName = graphName.replaceAll("[\\W]", "");
178
179     BufferedWriter bw = new BufferedWriter(new FileWriter(graphName + ".dot"));
180     bw.write("digraph " + graphName + " {\n");
181     bw.write("compound=true;\n");
182
183     // then visit every flow node
184
185     Iterator<FlowNode> iter = nodeSet.iterator();
186
187     Set<FlowEdge> addedEdgeSet = new HashSet<FlowEdge>();
188     Set<FlowNode> addedNodeSet = new HashSet<FlowNode>();
189
190     while (iter.hasNext()) {
191       FlowNode node = iter.next();
192
193       if (node.getDescTuple().size() == 1) {
194         // here, we just care about the local variable
195         if (node.getFieldNodeSet().size() > 0) {
196           drawSubgraph(node, bw, addedEdgeSet);
197         }
198       }
199       drawEdges(node, bw, addedNodeSet, addedEdgeSet);
200
201     }
202
203     bw.write("}\n");
204     bw.close();
205
206   }
207
208   public boolean constainsNode(FlowNode node) {
209     return nodeSet.contains(node);
210   }
211
212   private void drawSubgraph(FlowNode node, BufferedWriter bw, Set<FlowEdge> addedSet)
213       throws IOException {
214
215     bw.write("subgraph cluster_" + node.getID() + "{\n");
216     bw.write("label=\"" + node.getPrettyID() + "\";\n");
217
218     Set<FlowNode> fieldNodeSet = node.getFieldNodeSet();
219     for (Iterator iterator = fieldNodeSet.iterator(); iterator.hasNext();) {
220       FlowNode fieldNode = (FlowNode) iterator.next();
221       if (fieldNode.getFieldNodeSet().size() > 0) {
222         drawSubgraph(fieldNode, bw, addedSet);
223       } else {
224         Descriptor desc = fieldNode.getDescTuple().getLastElement();
225         if (desc instanceof VarDescriptor) {
226           VarDescriptor varDesc = (VarDescriptor) desc;
227           if (varDesc.getType().isPrimitive()) {
228             bw.write(fieldNode.getID() + " [label=\"" + fieldNode.getPrettyID() + "\"];\n");
229           }
230         } else if (desc instanceof FieldDescriptor) {
231           FieldDescriptor fieldDesc = (FieldDescriptor) desc;
232           if (fieldDesc.getType().isPrimitive()) {
233             bw.write(fieldNode.getID() + " [label=\"" + fieldNode.getPrettyID() + "\"];\n");
234           }
235         }
236       }
237     }
238
239     bw.write("}\n");
240   }
241 }