changes.
[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     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
122       HNode node = (HNode) iterator.next();
123       if (node.isSkeleton() && (!visited.contains(node))) {
124         visited.add(node);
125
126         Set<HNode> outSet = simpleGraph.getOutgoingNodeSet(node);
127         for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
128           HNode outNode = (HNode) iterator2.next();
129
130           if (!outNode.isSkeleton()) {
131             if (outNode.isCombinationNode()) {
132               // expand the combination node 'outNode'
133               System.out.println("-COMBINATION NODE=" + outNode);
134               // here we need to expand the corresponding combination location in the lattice
135               HNode combinationNodeInSCGraph = getCombinationNodeInSCGraph(desc, outNode);
136
137               Set<HNode> combineSkeletonNodeSet =
138                   simpleGraph.getCombineSetByCombinationNode(outNode);
139
140               System.out.println("combineSkeletonNodeSet=" + combineSkeletonNodeSet);
141
142               Set<HNode> combinationNodeSet =
143                   simpleGraph.getCombinationNodeSetByCombineNodeSet(combineSkeletonNodeSet);
144
145               System.out.println("combinationNodeSet=" + combinationNodeSet);
146
147               Set<HNode> endNodeSetFromSimpleGraph =
148                   simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode,
149                       combinationNodeSet);
150               System.out.println("-endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
151               Set<HNode> endCombNodeSet = new HashSet<HNode>();
152               for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
153                 HNode endNode = (HNode) iterator3.next();
154                 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
155               }
156               System.out.println("-endCombNodeSet=" + endCombNodeSet);
157               visited.add(outNode);
158
159               // follows the straight line up to another skeleton/combination node
160               if (endCombNodeSet.size() > 0) {
161                 endCombNodeSet =
162                     removeTransitivelyReachToNode(desc, combinationNodeInSCGraph, endCombNodeSet);
163                 recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
164                     mapIntermediateLoc, 1, locSummary, outNode);
165                 // recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
166                 // mapIntermediateLoc, 1, locSummary, outNode);
167               }
168
169             } else {
170               // we have a node that is neither combination or skeleton node
171               System.out.println("skeleton node=" + node + "  outNode=" + outNode);
172               HNode startNode = scGraph.getCurrentHNode(node);
173
174               // if (node.getDescriptor() != null) {
175               // // node is a skeleton node and it might be merged into another node in the SC
176               // graph.
177               // startNode = scGraph.getHNode(node.getDescriptor());
178               // } else {
179               // // this node has already been merged before the SC graph.
180               // startNode = node;
181               // }
182
183               Set<HNode> endNodeSetFromSimpleGraph =
184                   simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode, null);
185
186               System.out.println("endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph
187                   + "   from=" + outNode);
188               Set<HNode> endCombNodeSet = new HashSet<HNode>();
189               for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
190                 HNode endNode = (HNode) iterator3.next();
191                 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
192               }
193
194               visited.add(outNode);
195               if (endCombNodeSet.size() > 0) {
196                 // follows the straight line up to another skeleton/combination node
197                 endCombNodeSet = removeTransitivelyReachToNode(desc, startNode, endCombNodeSet);
198                 recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
199                     mapIntermediateLoc, 1, locSummary, outNode);
200               }
201             }
202
203           }
204
205         }
206       } else if (!node.isSkeleton() && !node.isCombinationNode() && !node.isMergeNode()
207           && !visited.contains(node)) {
208         // an intermediate node 'node' is located between "TOP" location and a skeleton node
209
210         Set<HNode> outNodeSet = simpleGraph.getOutgoingNodeSet(node);
211         Set<String> belowSkeletonLocNameSet = new HashSet<String>();
212         for (Iterator iterator2 = outNodeSet.iterator(); iterator2.hasNext();) {
213           HNode outNode = (HNode) iterator2.next();
214           if (outNode.isSkeleton()) {
215             belowSkeletonLocNameSet.add(scGraph.getCurrentHNode(outNode).getName());
216           }
217         }
218         String newLocName = "ILOC" + (seed++);
219         lattice.insertNewLocationBetween(lattice.getTopItem(), belowSkeletonLocNameSet, newLocName);
220         locSummary.addMapHNodeNameToLocationName(node.getName(), newLocName);
221       }
222     }
223
224     return lattice;
225
226   }
227
228   private Set<HNode> removeTransitivelyReachToNode(Descriptor desc, HNode startNode,
229       Set<HNode> endNodeSet) {
230
231     // if an end node is not directly connected to the start node in the SC graph
232     // replace it with a directly connected one which transitively reaches to it.
233
234     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
235     Set<HNode> newEndNodeSet = new HashSet<HNode>();
236
237     for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
238       HNode endNode = (HNode) iterator.next();
239       if (scGraph.isDirectlyConnectedTo(startNode, endNode)) {
240         newEndNodeSet.add(endNode);
241       } else {
242         HNode newEndNode =
243             getDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode);
244         System.out.println("#### old END NODE=" + endNode + " --->" + newEndNode);
245         newEndNodeSet.add(newEndNode);
246       }
247     }
248
249     System.out.println("removeTransitivelyReachToNode=" + endNodeSet + "  newSet=" + newEndNodeSet);
250
251     return newEndNodeSet;
252
253   }
254
255   private HNode getDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
256       HNode startNode, HNode endNode) {
257     Set<HNode> connected = new HashSet<HNode>();
258     recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode, connected);
259     return connected.iterator().next();
260   }
261
262   private void recurDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
263       HNode startNode, HNode curNode, Set<HNode> connected) {
264
265     Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
266     for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
267       HNode inNode = (HNode) iterator.next();
268       if (inNode.equals(startNode)) {
269         connected.add(curNode);
270       } else {
271         System.out.println("inNode=" + inNode);
272         recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, inNode, connected);
273       }
274     }
275
276   }
277
278   private void recurDFSNormalNode(Descriptor desc, SSJavaLattice<String> lattice, HNode startNode,
279       Set<HNode> endNodeSet, Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc,
280       int idx, LocationSummary locSummary, HNode curNode) {
281
282     TripleItem item = new TripleItem(startNode, endNodeSet, idx);
283     System.out.println("item=" + item);
284     if (!mapIntermediateLoc.containsKey(item)) {
285       // need to create a new intermediate location in the lattice
286       String newLocName = "ILOC" + (seed++);
287       String above;
288       if (idx == 1) {
289         above = startNode.getName();
290       } else {
291         int prevIdx = idx - 1;
292         TripleItem prevItem = new TripleItem(startNode, endNodeSet, prevIdx);
293         above = mapIntermediateLoc.get(prevItem);
294       }
295
296       Set<String> belowSet = new HashSet<String>();
297       for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
298         HNode endNode = (HNode) iterator.next();
299         belowSet.add(endNode.getName());
300       }
301
302       lattice.insertNewLocationBetween(above, belowSet, newLocName);
303
304       mapIntermediateLoc.put(item, newLocName);
305     }
306
307     String locName = mapIntermediateLoc.get(item);
308     locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
309
310     HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
311     Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
312     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
313       HNode outNode = (HNode) iterator2.next();
314       if (!outNode.isSkeleton() && !outNode.isCombinationNode() && !visited.contains(outNode)) {
315         visited.add(outNode);
316         recurDFSNormalNode(desc, lattice, startNode, endNodeSet, visited, mapIntermediateLoc,
317             idx + 1, locSummary, outNode);
318       }
319     }
320
321   }
322
323   private void recurDFS(Descriptor desc, SSJavaLattice<String> lattice,
324       HNode combinationNodeInSCGraph, Set<HNode> endNodeSet, Set<HNode> visited,
325       Map<TripleItem, String> mapIntermediateLoc, int idx, LocationSummary locSummary, HNode curNode) {
326
327     TripleItem item = new TripleItem(combinationNodeInSCGraph, endNodeSet, idx);
328
329     if (!mapIntermediateLoc.containsKey(item)) {
330       // need to create a new intermediate location in the lattice
331       String above;
332       if (idx == 1) {
333         String newLocName = combinationNodeInSCGraph.getName();
334         mapIntermediateLoc.put(item, newLocName);
335       } else {
336         String newLocName = "ILOC" + (seed++);
337         int prevIdx = idx - 1;
338         TripleItem prevItem = new TripleItem(combinationNodeInSCGraph, endNodeSet, prevIdx);
339         above = mapIntermediateLoc.get(prevItem);
340
341         Set<String> belowSet = new HashSet<String>();
342         for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
343           HNode endNode = (HNode) iterator.next();
344           belowSet.add(endNode.getName());
345         }
346         lattice.insertNewLocationBetween(above, belowSet, newLocName);
347         mapIntermediateLoc.put(item, newLocName);
348
349       }
350
351     }
352
353     String locName = mapIntermediateLoc.get(item);
354     locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
355
356     System.out.println("-TripleItem=" + item);
357     System.out.println("-curNode=" + curNode.getName() + " locName=" + locName);
358
359     HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
360     Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
361     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
362       HNode outNode = (HNode) iterator2.next();
363       if (!outNode.isSkeleton() && !visited.contains(outNode)) {
364         if (combinationNodeInSCGraph.equals(getCombinationNodeInSCGraph(desc, outNode))) {
365           visited.add(outNode);
366           recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited,
367               mapIntermediateLoc, idx + 1, locSummary, outNode);
368         }
369       }
370     }
371
372   }
373
374   private String generateElementName(BasisSet basisSet, HierarchyGraph inputGraph,
375       Map<Set<Integer>, String> mapF2LocName, Set<Integer> F) {
376
377     if (mapF2LocName.containsKey(F)) {
378       return mapF2LocName.get(F);
379     }
380
381     HNode node = basisSet.getHNode(F);
382     if (node != null) {
383       mapF2LocName.put(F, node.getName());
384       return node.getName();
385     } else {
386       if (inputGraph.BASISTOPELEMENT.equals(F)) {
387         return SSJavaAnalysis.BOTTOM;
388       } else {
389         String str = "LOC" + (seed++);
390         mapF2LocName.put(F, str);
391         return str;
392       }
393     }
394   }
395
396   private void resetCount(Map<Set<Integer>, Integer> mapFtoCount, Family family) {
397     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
398       Set<Integer> F = iter.next();
399       mapFtoCount.put(F, 0);
400     }
401   }
402
403   private Map<Set<Integer>, Set<Set<Integer>>> coveringGraph(BasisSet basisSet, Family family) {
404
405     Map<Set<Integer>, Integer> mapFtoCount = new HashMap<Set<Integer>, Integer>();
406     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = new HashMap<Set<Integer>, Set<Set<Integer>>>();
407
408     // initialize COUNT(F) to 0 for all elements of the family
409     resetCount(mapFtoCount, family);
410
411     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
412       Set<Integer> F = iter.next();
413       Set<HNode> gammaF = family.getGamma(F);
414
415       Set<HNode> curHNodeSet = basisSet.getHNodeSet();
416       curHNodeSet.removeAll(gammaF);
417       Set<Set<Integer>> Bset = basisSet.getBasisSetByHNodeSet(curHNodeSet);
418
419       for (Iterator iterator = Bset.iterator(); iterator.hasNext();) {
420         Set<Integer> B = (Set<Integer>) iterator.next();
421
422         Set<Integer> Fprime = new HashSet<Integer>();
423         Fprime.addAll(F);
424         Fprime.addAll(B);
425
426         // COUNT(F')++;
427         mapFtoCount.put(Fprime, mapFtoCount.get(Fprime) + 1);
428
429         // if |gamma(F')|==COUNT(F') + |gamma(F)|
430         int numGammaFprime = family.getGamma(Fprime).size();
431         int countFprime = mapFtoCount.get(Fprime);
432         int numGammaF = family.getGamma(F).size();
433         if (numGammaFprime == (countFprime + numGammaF)) {
434           // ImSucc(F)=IMSucc(F) union F'
435           addImSucc(mapImSucc, F, Fprime);
436         }
437
438       }
439       resetCount(mapFtoCount, family);
440     }
441
442     System.out.println("mapImSucc=" + mapImSucc);
443
444     return mapImSucc;
445   }
446
447   private Set<Set<Integer>> getImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F) {
448     if (!mapImSucc.containsKey(F)) {
449       mapImSucc.put(F, new HashSet<Set<Integer>>());
450     }
451     return mapImSucc.get(F);
452   }
453
454   private void addImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F,
455       Set<Integer> Fprime) {
456
457     if (!mapImSucc.containsKey(F)) {
458       mapImSucc.put(F, new HashSet<Set<Integer>>());
459     }
460
461     mapImSucc.get(F).add(Fprime);
462
463   }
464
465   private Family generateFamily(BasisSet basisSet) {
466
467     Family family = new Family();
468
469     for (Iterator<Set<Integer>> iterator = basisSet.basisIterator(); iterator.hasNext();) {
470       Set<Integer> B = iterator.next();
471
472       Set<Pair<Set<Integer>, Set<HNode>>> tobeadded = new HashSet<Pair<Set<Integer>, Set<HNode>>>();
473
474       for (Iterator<Set<Integer>> iterator2 = family.FIterator(); iterator2.hasNext();) {
475         Set<Integer> F = iterator2.next();
476
477         Set<Integer> Fprime = new HashSet<Integer>();
478         Fprime.addAll(F);
479         Fprime.addAll(B);
480
481         Set<HNode> gammaFPrimeSet = new HashSet<HNode>();
482         gammaFPrimeSet.addAll(family.getGamma(F));
483         gammaFPrimeSet.add(basisSet.getHNode(B));
484
485         if (!family.containsF(Fprime)) {
486           Pair<Set<Integer>, Set<HNode>> pair =
487               new Pair<Set<Integer>, Set<HNode>>(Fprime, gammaFPrimeSet);
488           tobeadded.add(pair);
489         } else {
490           family.updateGammaF(Fprime, gammaFPrimeSet);
491         }
492       }
493
494       for (Iterator<Pair<Set<Integer>, Set<HNode>>> iterator2 = tobeadded.iterator(); iterator2
495           .hasNext();) {
496         Pair<Set<Integer>, Set<HNode>> pair = iterator2.next();
497         family.addFElement(pair.getFirst());
498         family.updateGammaF(pair.getFirst(), pair.getSecond());
499       }
500
501     }
502     return family;
503   }
504
505   private void debug_print(HierarchyGraph inputGraph) {
506     System.out.println("\nBuild Lattice:" + inputGraph.getName());
507     System.out.println("Node2Index:\n" + inputGraph.getMapHNodeToUniqueIndex());
508     System.out.println("Node2Basis:\n" + inputGraph.getMapHNodeToBasis());
509   }
510
511 }
512
513 class Identifier {
514   public HNode node;
515   public int idx;
516
517   public Identifier(HNode n, int i) {
518     node = n;
519     idx = i;
520   }
521
522   public int hashCode() {
523     return node.hashCode() + idx;
524   }
525
526   public boolean equals(Object obj) {
527
528     if (obj instanceof Identifier) {
529       Identifier in = (Identifier) obj;
530       if (node.equals(in.node) && idx == in.idx) {
531         return true;
532       }
533     }
534
535     return false;
536   }
537
538 }
539
540 class TripleItem {
541   public HNode higherNode;
542   public Set<HNode> lowerNodeSet;
543   public int idx;
544
545   public TripleItem(HNode h, Set<HNode> l, int i) {
546     higherNode = h;
547     lowerNodeSet = l;
548     idx = i;
549   }
550
551   public int hashCode() {
552     return higherNode.hashCode() + lowerNodeSet.hashCode() + idx;
553   }
554
555   public boolean equals(Object obj) {
556
557     if (obj instanceof TripleItem) {
558       TripleItem in = (TripleItem) obj;
559       if (higherNode.equals(in.higherNode) && lowerNodeSet.equals(in.lowerNodeSet) && idx == in.idx) {
560         return true;
561       }
562     }
563
564     return false;
565   }
566
567   public String toString() {
568     return higherNode + "-" + idx + "->" + lowerNodeSet;
569   }
570 }