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