1 package Analysis.SSJava;
3 import java.io.BufferedWriter;
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;
12 import java.util.Map.Entry;
14 import Analysis.OoOJava.ConflictEdge;
15 import Analysis.OoOJava.ConflictNode;
17 import IR.FieldDescriptor;
18 import IR.MethodDescriptor;
19 import IR.VarDescriptor;
21 public class FlowGraph {
25 Set<FlowNode> nodeSet;
26 Set<FlowNode> returnNodeSet;
29 // maps the composite representation of field/var descriptors to infer nodes
30 Map<NTuple<Descriptor>, FlowNode> mapDescTupleToInferNode;
32 // maps an infer node to the set of neighbors which is pointed by the node
33 Map<NTuple<Descriptor>, Set<FlowNode>> mapNodeToNeighborSet;
35 // maps a paramter descriptor to its index
36 Map<Descriptor, Integer> mapParamDescToIdx;
39 public FlowGraph(MethodDescriptor md, Map<Descriptor, Integer> mapParamDescToIdx) {
41 this.nodeSet = new HashSet<FlowNode>();
42 this.mapDescTupleToInferNode = new HashMap<NTuple<Descriptor>, FlowNode>();
43 this.mapNodeToNeighborSet = new HashMap<NTuple<Descriptor>, Set<FlowNode>>();
44 this.mapParamDescToIdx = new HashMap<Descriptor, Integer>();
45 this.mapParamDescToIdx.putAll(mapParamDescToIdx);
46 this.returnNodeSet = new HashSet<FlowNode>();
48 // create a node for 'this' varialbe
49 NTuple<Descriptor> thisDescTuple = new NTuple<Descriptor>();
50 thisDescTuple.add(md.getThis());
51 FlowNode thisNode = new FlowNode(thisDescTuple, true);
52 NTuple<Descriptor> thisVarTuple = new NTuple<Descriptor>();
53 thisVarTuple.add(md.getThis());
54 createNewFlowNode(thisVarTuple);
55 thisVarNode = thisNode;
59 public Set<FlowNode> getNodeSet() {
63 public Set<FlowNode> getParameterNodeSet() {
64 Set<FlowNode> paramNodeSet = new HashSet<FlowNode>();
65 for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
66 FlowNode fn = (FlowNode) iterator.next();
67 if (fn.isParameter()) {
74 public void addNeighbor(FlowNode node, FlowNode neighbor) {
75 Set<FlowNode> set = mapNodeToNeighborSet.get(node);
77 set = new HashSet<FlowNode>();
81 System.out.println("add a new neighbor " + neighbor + " to " + node);
84 public boolean hasEdge(NTuple<Descriptor> fromDescTuple, NTuple<Descriptor> toDescTuple) {
86 FlowNode fromNode = mapDescTupleToInferNode.get(fromDescTuple);
87 FlowNode toNode = mapDescTupleToInferNode.get(toDescTuple);
89 Set<FlowEdge> fromNodeOutEdgeSet = fromNode.getOutEdgeSet();
90 for (Iterator iterator = fromNodeOutEdgeSet.iterator(); iterator.hasNext();) {
91 FlowEdge flowEdge = (FlowEdge) iterator.next();
92 if (flowEdge.getDst().equals(toNode)) {
95 if (hasEdge(flowEdge.getDst().getDescTuple(), toDescTuple)) {
104 public void addValueFlowEdge(NTuple<Descriptor> fromDescTuple, NTuple<Descriptor> toDescTuple) {
106 FlowNode fromNode = mapDescTupleToInferNode.get(fromDescTuple);
107 FlowNode toNode = mapDescTupleToInferNode.get(toDescTuple);
109 System.out.println("create an edge from " + fromNode + " to " + toNode);
111 int fromTupleSize = fromDescTuple.size();
112 NTuple<Descriptor> curTuple = new NTuple<Descriptor>();
113 for (int i = 0; i < fromTupleSize; i++) {
114 Descriptor desc = fromDescTuple.get(i);
116 addFlowEdge(getFlowNode(curTuple), toNode, fromDescTuple, toDescTuple);
119 int toTupleSize = toDescTuple.size();
120 curTuple = new NTuple<Descriptor>();
121 for (int i = 0; i < toTupleSize; i++) {
122 Descriptor desc = toDescTuple.get(i);
124 addFlowEdge(fromNode, getFlowNode(curTuple), fromDescTuple, toDescTuple);
129 private void addFlowEdge(FlowNode fromNode, FlowNode toNode, NTuple<Descriptor> initTuple,
130 NTuple<Descriptor> endTuple) {
132 FlowEdge edge = new FlowEdge(fromNode, toNode, initTuple, endTuple);
133 fromNode.addOutEdge(edge);
135 System.out.println("add a new edge=" + edge);
139 public FlowNode getFlowNode(NTuple<Descriptor> descTuple) {
140 if (mapDescTupleToInferNode.containsKey(descTuple)) {
141 return mapDescTupleToInferNode.get(descTuple);
143 FlowNode node = createNewFlowNode(descTuple);
148 public FlowNode getThisVarNode() {
152 public FlowNode createNewFlowNode(NTuple<Descriptor> tuple) {
154 if (!mapDescTupleToInferNode.containsKey(tuple)) {
156 FlowNode node = new FlowNode(tuple, isParamter(tuple));
157 mapDescTupleToInferNode.put(tuple, node);
160 if (tuple.size() > 1) {
161 NTuple<Descriptor> baseTuple = tuple.subList(0, tuple.size() - 1);
162 getFlowNode(baseTuple).addFieldNode(node);
165 System.out.println("Creating new node=" + node);
168 return mapDescTupleToInferNode.get(tuple);
173 public void setReturnFlowNode(NTuple<Descriptor> tuple) {
175 if (!mapDescTupleToInferNode.containsKey(tuple)) {
176 createNewFlowNode(tuple);
179 FlowNode node = mapDescTupleToInferNode.get(tuple);
180 node.setReturn(true);
182 returnNodeSet.add(node);
185 public Set<FlowNode> getReturnNodeSet() {
186 return returnNodeSet;
189 public boolean isParamter(NTuple<Descriptor> tuple) {
190 // return true if a descriptor tuple is started with a parameter descriptor
191 Descriptor firstIdxDesc = tuple.get(0);
192 return mapParamDescToIdx.containsKey(firstIdxDesc);
195 public int getParamIdx(NTuple<Descriptor> tuple) {
196 Descriptor firstDesc = tuple.get(0);
197 return mapParamDescToIdx.get(firstDesc).intValue();
200 private void drawEdges(FlowNode node, BufferedWriter bw, Set<FlowNode> addedNodeSet,
201 Set<FlowEdge> addedEdgeSet) throws IOException {
203 Set<FlowEdge> edgeSet = node.getOutEdgeSet();
205 for (Iterator<FlowEdge> iterator = edgeSet.iterator(); iterator.hasNext();) {
206 FlowEdge flowEdge = iterator.next();
208 FlowNode u = flowEdge.getSrc();
209 FlowNode v = flowEdge.getDst();
211 if (u.getDescTuple().equals(flowEdge.getInitTuple())
212 && v.getDescTuple().equals(flowEdge.getEndTuple())) {
213 // only draw an edge of the actual value flow
215 if (!addedEdgeSet.contains(flowEdge)) {
217 if (!addedNodeSet.contains(u)) {
221 if (!addedNodeSet.contains(v)) {
226 bw.write("" + u.getID() + " -> " + v.getID() + ";\n");
227 addedEdgeSet.add(flowEdge);
235 private void drawNode(FlowNode node, BufferedWriter bw) throws IOException {
236 bw.write(node.getID() + " [label=\"" + node.getPrettyID() + "\"]" + ";\n");
239 public void writeGraph() throws java.io.IOException {
241 String graphName = "flowgraph_" + md.toString();
242 graphName = graphName.replaceAll("[\\W]", "");
244 BufferedWriter bw = new BufferedWriter(new FileWriter(graphName + ".dot"));
245 bw.write("digraph " + graphName + " {\n");
246 bw.write("compound=true;\n");
248 // then visit every flow node
250 Iterator<FlowNode> iter = nodeSet.iterator();
252 Set<FlowEdge> addedEdgeSet = new HashSet<FlowEdge>();
253 Set<FlowNode> addedNodeSet = new HashSet<FlowNode>();
255 while (iter.hasNext()) {
256 FlowNode node = iter.next();
258 if (node.getDescTuple().size() == 1) {
259 // here, we just care about the local variable
260 if (node.getFieldNodeSet().size() > 0) {
261 drawSubgraph(node, bw, addedEdgeSet);
264 drawEdges(node, bw, addedNodeSet, addedEdgeSet);
273 public boolean constainsNode(FlowNode node) {
274 return nodeSet.contains(node);
277 private void drawSubgraph(FlowNode node, BufferedWriter bw, Set<FlowEdge> addedSet)
280 bw.write("subgraph cluster_" + node.getID() + "{\n");
281 bw.write("label=\"" + node.getPrettyID() + "\";\n");
283 Set<FlowNode> fieldNodeSet = node.getFieldNodeSet();
284 for (Iterator iterator = fieldNodeSet.iterator(); iterator.hasNext();) {
285 FlowNode fieldNode = (FlowNode) iterator.next();
286 if (fieldNode.getFieldNodeSet().size() > 0) {
287 drawSubgraph(fieldNode, bw, addedSet);
289 Descriptor desc = fieldNode.getDescTuple().getLastElement();
290 if (desc instanceof VarDescriptor) {
291 VarDescriptor varDesc = (VarDescriptor) desc;
292 if (varDesc.getType().isPrimitive()) {
293 bw.write(fieldNode.getID() + " [label=\"" + fieldNode.getPrettyID() + "\"];\n");
295 } else if (desc instanceof FieldDescriptor) {
296 FieldDescriptor fieldDesc = (FieldDescriptor) desc;
297 if (fieldDesc.getType().isPrimitive()) {
298 bw.write(fieldNode.getID() + " [label=\"" + fieldNode.getPrettyID() + "\"];\n");