changes: now it generates simple lattice without having intermediate nodes for the...
[IRC.git] / Robust / src / Analysis / SSJava / BuildLattice.java
1 package Analysis.SSJava;
2
3 import java.util.HashMap;
4 import java.util.HashSet;
5 import java.util.Iterator;
6 import java.util.Map;
7 import java.util.Set;
8
9 import IR.Descriptor;
10 import Util.Pair;
11
12 public class BuildLattice {
13
14   public static int seed = 0;
15   private LocationInference infer;
16
17   public BuildLattice(LocationInference infer) {
18     this.infer = infer;
19   }
20
21   public SSJavaLattice<String> buildLattice(Descriptor desc) {
22
23     HierarchyGraph inputGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
24     LocationSummary locSummary = infer.getLocationSummary(desc);
25
26     BasisSet basisSet = inputGraph.computeBasisSet();
27     debug_print(inputGraph);
28
29     Family family = generateFamily(basisSet);
30     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = coveringGraph(basisSet, family);
31
32     SSJavaLattice<String> lattice = buildLattice(basisSet, inputGraph, locSummary, mapImSucc);
33     return lattice;
34
35   }
36
37   private SSJavaLattice<String> buildLattice(BasisSet basisSet, HierarchyGraph inputGraph,
38       LocationSummary locSummary, Map<Set<Integer>, Set<Set<Integer>>> mapImSucc) {
39
40     SSJavaLattice<String> lattice =
41         new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
42
43     Map<Set<Integer>, String> mapFToLocName = new HashMap<Set<Integer>, String>();
44
45     Set<Set<Integer>> keySet = mapImSucc.keySet();
46     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
47       Set<Integer> higher = (Set<Integer>) iterator.next();
48
49       String higherName = generateElementName(basisSet, inputGraph, mapFToLocName, higher);
50       locSummary.addMapHNodeNameToLocationName(higherName, higherName);
51
52       HNode higherNode = inputGraph.getHNode(higherName);
53       if (higherNode != null && higherNode.isSharedNode()) {
54         lattice.addSharedLoc(higherName);
55       }
56
57       Set<Set<Integer>> lowerSet = mapImSucc.get(higher);
58       for (Iterator iterator2 = lowerSet.iterator(); iterator2.hasNext();) {
59         Set<Integer> lower = (Set<Integer>) iterator2.next();
60
61         String lowerName = generateElementName(basisSet, inputGraph, mapFToLocName, lower);
62         locSummary.addMapHNodeNameToLocationName(lowerName, lowerName);
63
64         HNode lowerNode = inputGraph.getHNode(higherName);
65         if (lowerNode != null && lowerNode.isSharedNode()) {
66           lattice.addSharedLoc(lowerName);
67         }
68
69         if (higher.size() == 0) {
70           // empty case
71           lattice.put(lowerName);
72         } else {
73           lattice.addRelationHigherToLower(higherName, lowerName);
74         }
75
76       }
77
78     }
79
80     return lattice;
81   }
82
83   public HNode getCombinationNodeInSCGraph(Descriptor desc, HNode nodeFromSimpleGraph) {
84
85     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
86
87     if (nodeFromSimpleGraph.isSkeleton()) {
88       return scGraph.getCurrentHNode(nodeFromSimpleGraph);
89     }
90
91     Set<HNode> combineSkeletonNodeSet =
92         infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(nodeFromSimpleGraph);
93     HNode combinationNodeInSCGraph =
94         infer.getSkeletonCombinationHierarchyGraph(desc).getMapCombineNodeSetToCombinationNode()
95             .get(combineSkeletonNodeSet);
96
97     // Set<HNode> combineSkeletonNodeSet =
98     // infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(simpleGraphNode);
99     // HNode combinationNodeInSCGraph =
100     // infer.getSkeletonCombinationHierarchyGraph(desc).getCombinationNode(combineSkeletonNodeSet);
101     return combinationNodeInSCGraph;
102   }
103
104   public SSJavaLattice<String> insertIntermediateNodesToStraightLine(Descriptor desc,
105       SSJavaLattice<String> skeletonLattice) {
106
107     // perform DFS that starts from each skeleton/combination node and ends by another
108     // skeleton/combination node
109
110     HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
111     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
112     LocationSummary locSummary = infer.getLocationSummary(desc);
113
114     SSJavaLattice<String> lattice = skeletonLattice.clone();
115
116     Set<HNode> visited = new HashSet<HNode>();
117
118     Set<HNode> nodeSet = simpleGraph.getNodeSet();
119
120     Map<TripleItem, String> mapIntermediateLoc = new HashMap<TripleItem, String>();
121
122
123     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
124       HNode node = (HNode) iterator.next();
125       if (node.isSkeleton() && (!visited.contains(node))) {
126         visited.add(node);
127
128         Set<HNode> outSet = simpleGraph.getOutgoingNodeSet(node);
129         for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
130           HNode outNode = (HNode) iterator2.next();
131
132           if (!outNode.isSkeleton()) {
133             if (outNode.isCombinationNode()) {
134               // expand the combination node 'outNode'
135               System.out.println("-COMBINATION NODE=" + outNode);
136               // here we need to expand the corresponding combination location in the lattice
137               HNode combinationNodeInSCGraph = getCombinationNodeInSCGraph(desc, outNode);
138
139               Set<HNode> combineSkeletonNodeSet =
140                   simpleGraph.getCombineSetByCombinationNode(outNode);
141
142               System.out.println("combineSkeletonNodeSet=" + combineSkeletonNodeSet);
143
144               Set<HNode> combinationNodeSet =
145                   simpleGraph.getCombinationNodeSetByCombineNodeSet(combineSkeletonNodeSet);
146
147               System.out.println("combinationNodeSet=" + combinationNodeSet);
148
149               Set<HNode> endNodeSetFromSimpleGraph =
150                   simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode,
151                       combinationNodeSet);
152               System.out.println("-endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
153               Set<HNode> endCombNodeSet = new HashSet<HNode>();
154               for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
155                 HNode endNode = (HNode) iterator3.next();
156                 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
157               }
158               System.out.println("-endCombNodeSet=" + endCombNodeSet);
159               visited.add(outNode);
160
161               // follows the straight line up to another skeleton/combination node
162               if (endCombNodeSet.size() > 0) {
163                 endCombNodeSet =
164                     removeTransitivelyReachToNode(desc, combinationNodeInSCGraph, endCombNodeSet);
165                 recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
166                     mapIntermediateLoc, 1, locSummary, outNode);
167                 // recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
168                 // mapIntermediateLoc, 1, locSummary, outNode);
169               }
170
171             } else {
172               // we have a node that is neither combination or skeleton node
173               System.out.println("skeleton node=" + node + "  outNode=" + outNode);
174               HNode startNode = scGraph.getCurrentHNode(node);
175
176               // if (node.getDescriptor() != null) {
177               // // node is a skeleton node and it might be merged into another node in the SC
178               // graph.
179               // startNode = scGraph.getHNode(node.getDescriptor());
180               // } else {
181               // // this node has already been merged before the SC graph.
182               // startNode = node;
183               // }
184
185               Set<HNode> endNodeSetFromSimpleGraph =
186                   simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode, null);
187
188               System.out.println("endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph
189                   + "   from=" + outNode);
190               Set<HNode> endCombNodeSet = new HashSet<HNode>();
191               for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
192                 HNode endNode = (HNode) iterator3.next();
193                 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
194               }
195
196               visited.add(outNode);
197               if (endCombNodeSet.size() > 0) {
198                 // follows the straight line up to another skeleton/combination node
199                 endCombNodeSet = removeTransitivelyReachToNode(desc, startNode, endCombNodeSet);
200                 recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
201                     mapIntermediateLoc, 1, locSummary, outNode);
202               }
203             }
204
205           }
206
207         }
208       } else if (!node.isSkeleton() && !node.isCombinationNode() && !node.isMergeNode()
209           && !visited.contains(node)) {
210         // an intermediate node 'node' may be located between "TOP" location and a skeleton node
211         // but there is no such a case.
212
213         // Set<HNode> outNodeSet = simpleGraph.getOutgoingNodeSet(node);
214         // Set<String> belowSkeletonLocNameSet = new HashSet<String>();
215         // for (Iterator iterator2 = outNodeSet.iterator(); iterator2.hasNext();) {
216         // HNode outNode = (HNode) iterator2.next();
217         // if (outNode.isSkeleton()) {
218         // belowSkeletonLocNameSet.add(scGraph.getCurrentHNode(outNode).getName());
219         // }
220         // }
221         // String newLocName = "ILOC" + (seed++);
222         // lattice.insertNewLocationBetween(lattice.getTopItem(), belowSkeletonLocNameSet,
223         // newLocName);
224         // locSummary.addMapHNodeNameToLocationName(node.getName(), newLocName);
225
226       }
227     }
228
229     return lattice;
230
231   }
232
233   private Set<HNode> removeTransitivelyReachToNode(Descriptor desc, HNode startNode,
234       Set<HNode> endNodeSet) {
235
236     // if an end node is not directly connected to the start node in the SC graph
237     // replace it with a directly connected one which transitively reaches to it.
238
239     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
240     Set<HNode> newEndNodeSet = new HashSet<HNode>();
241
242     for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
243       HNode endNode = (HNode) iterator.next();
244       if (scGraph.isDirectlyConnectedTo(startNode, endNode)) {
245         newEndNodeSet.add(endNode);
246       } else {
247         HNode newEndNode =
248             getDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode);
249         System.out.println("#### old END NODE=" + endNode + " --->" + newEndNode);
250         newEndNodeSet.add(newEndNode);
251       }
252     }
253
254     System.out.println("removeTransitivelyReachToNode=" + endNodeSet + "  newSet=" + newEndNodeSet);
255
256     return newEndNodeSet;
257
258   }
259
260   private HNode getDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
261       HNode startNode, HNode endNode) {
262     Set<HNode> connected = new HashSet<HNode>();
263     recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode, connected);
264     return connected.iterator().next();
265   }
266
267   private void recurDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
268       HNode startNode, HNode curNode, Set<HNode> connected) {
269
270     Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
271     for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
272       HNode inNode = (HNode) iterator.next();
273       if (inNode.equals(startNode)) {
274         connected.add(curNode);
275       } else {
276         System.out.println("inNode=" + inNode);
277         recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, inNode, connected);
278       }
279     }
280
281   }
282
283   private void recurDFSNormalNode(Descriptor desc, SSJavaLattice<String> lattice, HNode startNode,
284       Set<HNode> endNodeSet, Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc,
285       int idx, LocationSummary locSummary, HNode curNode) {
286
287     TripleItem item = new TripleItem(startNode, endNodeSet, idx);
288     System.out.println("item=" + item);
289     if (!mapIntermediateLoc.containsKey(item)) {
290       // need to create a new intermediate location in the lattice
291       String newLocName = "ILOC" + (seed++);
292       String above;
293       if (idx == 1) {
294         above = startNode.getName();
295       } else {
296         int prevIdx = idx - 1;
297         TripleItem prevItem = new TripleItem(startNode, endNodeSet, prevIdx);
298         above = mapIntermediateLoc.get(prevItem);
299       }
300
301       Set<String> belowSet = new HashSet<String>();
302       for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
303         HNode endNode = (HNode) iterator.next();
304         belowSet.add(endNode.getName());
305       }
306
307       lattice.insertNewLocationBetween(above, belowSet, newLocName);
308
309       mapIntermediateLoc.put(item, newLocName);
310     }
311
312     String locName = mapIntermediateLoc.get(item);
313     locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
314
315     HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
316     Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
317     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
318       HNode outNode = (HNode) iterator2.next();
319       if (!outNode.isSkeleton() && !outNode.isCombinationNode() && !visited.contains(outNode)) {
320         visited.add(outNode);
321         recurDFSNormalNode(desc, lattice, startNode, endNodeSet, visited, mapIntermediateLoc,
322             idx + 1, locSummary, outNode);
323       }
324     }
325
326   }
327
328   private void recurDFS(Descriptor desc, SSJavaLattice<String> lattice,
329       HNode combinationNodeInSCGraph, Set<HNode> endNodeSet, Set<HNode> visited,
330       Map<TripleItem, String> mapIntermediateLoc, int idx, LocationSummary locSummary, HNode curNode) {
331
332     TripleItem item = new TripleItem(combinationNodeInSCGraph, endNodeSet, idx);
333
334     if (!mapIntermediateLoc.containsKey(item)) {
335       // need to create a new intermediate location in the lattice
336       String above;
337       if (idx == 1) {
338         String newLocName = combinationNodeInSCGraph.getName();
339         mapIntermediateLoc.put(item, newLocName);
340       } else {
341         String newLocName = "ILOC" + (seed++);
342         int prevIdx = idx - 1;
343         TripleItem prevItem = new TripleItem(combinationNodeInSCGraph, endNodeSet, prevIdx);
344         above = mapIntermediateLoc.get(prevItem);
345
346         Set<String> belowSet = new HashSet<String>();
347         for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
348           HNode endNode = (HNode) iterator.next();
349           belowSet.add(endNode.getName());
350         }
351         lattice.insertNewLocationBetween(above, belowSet, newLocName);
352         mapIntermediateLoc.put(item, newLocName);
353
354       }
355
356     }
357
358     String locName = mapIntermediateLoc.get(item);
359     locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
360
361     System.out.println("-TripleItem=" + item);
362     System.out.println("-curNode=" + curNode.getName() + " locName=" + locName);
363
364     HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
365     Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
366     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
367       HNode outNode = (HNode) iterator2.next();
368       if (!outNode.isSkeleton() && !visited.contains(outNode)) {
369         if (combinationNodeInSCGraph.equals(getCombinationNodeInSCGraph(desc, outNode))) {
370           visited.add(outNode);
371           recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited,
372               mapIntermediateLoc, idx + 1, locSummary, outNode);
373         }
374       }
375     }
376
377   }
378
379   private String generateElementName(BasisSet basisSet, HierarchyGraph inputGraph,
380       Map<Set<Integer>, String> mapF2LocName, Set<Integer> F) {
381
382     if (mapF2LocName.containsKey(F)) {
383       return mapF2LocName.get(F);
384     }
385
386     HNode node = basisSet.getHNode(F);
387     if (node != null) {
388       mapF2LocName.put(F, node.getName());
389       return node.getName();
390     } else {
391       if (inputGraph.BASISTOPELEMENT.equals(F)) {
392         return SSJavaAnalysis.BOTTOM;
393       } else {
394         String str = "LOC" + (seed++);
395         mapF2LocName.put(F, str);
396         return str;
397       }
398     }
399   }
400
401   private void resetCount(Map<Set<Integer>, Integer> mapFtoCount, Family family) {
402     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
403       Set<Integer> F = iter.next();
404       mapFtoCount.put(F, 0);
405     }
406   }
407
408   private Map<Set<Integer>, Set<Set<Integer>>> coveringGraph(BasisSet basisSet, Family family) {
409
410     Map<Set<Integer>, Integer> mapFtoCount = new HashMap<Set<Integer>, Integer>();
411     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = new HashMap<Set<Integer>, Set<Set<Integer>>>();
412
413     // initialize COUNT(F) to 0 for all elements of the family
414     resetCount(mapFtoCount, family);
415
416     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
417       Set<Integer> F = iter.next();
418       Set<HNode> gammaF = family.getGamma(F);
419
420       Set<HNode> curHNodeSet = basisSet.getHNodeSet();
421       curHNodeSet.removeAll(gammaF);
422       Set<Set<Integer>> Bset = basisSet.getBasisSetByHNodeSet(curHNodeSet);
423
424       for (Iterator iterator = Bset.iterator(); iterator.hasNext();) {
425         Set<Integer> B = (Set<Integer>) iterator.next();
426
427         Set<Integer> Fprime = new HashSet<Integer>();
428         Fprime.addAll(F);
429         Fprime.addAll(B);
430
431         // COUNT(F')++;
432         mapFtoCount.put(Fprime, mapFtoCount.get(Fprime) + 1);
433
434         // if |gamma(F')|==COUNT(F') + |gamma(F)|
435         int numGammaFprime = family.getGamma(Fprime).size();
436         int countFprime = mapFtoCount.get(Fprime);
437         int numGammaF = family.getGamma(F).size();
438         if (numGammaFprime == (countFprime + numGammaF)) {
439           // ImSucc(F)=IMSucc(F) union F'
440           addImSucc(mapImSucc, F, Fprime);
441         }
442
443       }
444       resetCount(mapFtoCount, family);
445     }
446
447     System.out.println("mapImSucc=" + mapImSucc);
448
449     return mapImSucc;
450   }
451
452   private Set<Set<Integer>> getImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F) {
453     if (!mapImSucc.containsKey(F)) {
454       mapImSucc.put(F, new HashSet<Set<Integer>>());
455     }
456     return mapImSucc.get(F);
457   }
458
459   private void addImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F,
460       Set<Integer> Fprime) {
461
462     if (!mapImSucc.containsKey(F)) {
463       mapImSucc.put(F, new HashSet<Set<Integer>>());
464     }
465
466     mapImSucc.get(F).add(Fprime);
467
468   }
469
470   private Family generateFamily(BasisSet basisSet) {
471
472     Family family = new Family();
473
474     for (Iterator<Set<Integer>> iterator = basisSet.basisIterator(); iterator.hasNext();) {
475       Set<Integer> B = iterator.next();
476
477       Set<Pair<Set<Integer>, Set<HNode>>> tobeadded = new HashSet<Pair<Set<Integer>, Set<HNode>>>();
478
479       for (Iterator<Set<Integer>> iterator2 = family.FIterator(); iterator2.hasNext();) {
480         Set<Integer> F = iterator2.next();
481
482         Set<Integer> Fprime = new HashSet<Integer>();
483         Fprime.addAll(F);
484         Fprime.addAll(B);
485
486         Set<HNode> gammaFPrimeSet = new HashSet<HNode>();
487         gammaFPrimeSet.addAll(family.getGamma(F));
488         gammaFPrimeSet.add(basisSet.getHNode(B));
489
490         if (!family.containsF(Fprime)) {
491           Pair<Set<Integer>, Set<HNode>> pair =
492               new Pair<Set<Integer>, Set<HNode>>(Fprime, gammaFPrimeSet);
493           tobeadded.add(pair);
494         } else {
495           family.updateGammaF(Fprime, gammaFPrimeSet);
496         }
497       }
498
499       for (Iterator<Pair<Set<Integer>, Set<HNode>>> iterator2 = tobeadded.iterator(); iterator2
500           .hasNext();) {
501         Pair<Set<Integer>, Set<HNode>> pair = iterator2.next();
502         family.addFElement(pair.getFirst());
503         family.updateGammaF(pair.getFirst(), pair.getSecond());
504       }
505
506     }
507     return family;
508   }
509
510   private void debug_print(HierarchyGraph inputGraph) {
511     System.out.println("\nBuild Lattice:" + inputGraph.getName());
512     System.out.println("Node2Index:\n" + inputGraph.getMapHNodeToUniqueIndex());
513     System.out.println("Node2Basis:\n" + inputGraph.getMapHNodeToBasis());
514   }
515
516 }
517
518 class Identifier {
519   public HNode node;
520   public int idx;
521
522   public Identifier(HNode n, int i) {
523     node = n;
524     idx = i;
525   }
526
527   public int hashCode() {
528     return node.hashCode() + idx;
529   }
530
531   public boolean equals(Object obj) {
532
533     if (obj instanceof Identifier) {
534       Identifier in = (Identifier) obj;
535       if (node.equals(in.node) && idx == in.idx) {
536         return true;
537       }
538     }
539
540     return false;
541   }
542
543 }
544
545 class TripleItem {
546   public HNode higherNode;
547   public Set<HNode> lowerNodeSet;
548   public int idx;
549
550   public TripleItem(HNode h, Set<HNode> l, int i) {
551     higherNode = h;
552     lowerNodeSet = l;
553     idx = i;
554   }
555
556   public int hashCode() {
557     return higherNode.hashCode() + lowerNodeSet.hashCode() + idx;
558   }
559
560   public boolean equals(Object obj) {
561
562     if (obj instanceof TripleItem) {
563       TripleItem in = (TripleItem) obj;
564       if (higherNode.equals(in.higherNode) && lowerNodeSet.equals(in.lowerNodeSet) && idx == in.idx) {
565         return true;
566       }
567     }
568
569     return false;
570   }
571
572   public String toString() {
573     return higherNode + "-" + idx + "->" + lowerNodeSet;
574   }
575 }