1 package Analysis.SSJava;
3 import java.util.HashMap;
4 import java.util.HashSet;
5 import java.util.Iterator;
12 public class BuildLattice {
14 public static int seed = 0;
15 private LocationInference infer;
17 private final HNode topNode;
18 private final HNode bottomNode;
20 public BuildLattice(LocationInference infer) {
22 topNode = new HNode(infer.ssjava.TOP);
23 bottomNode = new HNode(infer.ssjava.BOTTOM);
26 public SSJavaLattice<String> buildLattice(Descriptor desc) {
28 HierarchyGraph inputGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
29 LocationSummary locSummary = infer.getLocationSummary(desc);
31 BasisSet basisSet = inputGraph.computeBasisSet();
32 debug_print(inputGraph);
34 Family family = generateFamily(basisSet);
35 Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = coveringGraph(basisSet, family);
37 SSJavaLattice<String> lattice = buildLattice(basisSet, inputGraph, locSummary, mapImSucc);
42 private SSJavaLattice<String> buildLattice(BasisSet basisSet, HierarchyGraph inputGraph,
43 LocationSummary locSummary, Map<Set<Integer>, Set<Set<Integer>>> mapImSucc) {
45 SSJavaLattice<String> lattice =
46 new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
48 Map<Set<Integer>, String> mapFToLocName = new HashMap<Set<Integer>, String>();
50 Set<Set<Integer>> keySet = mapImSucc.keySet();
51 for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
52 Set<Integer> higher = (Set<Integer>) iterator.next();
54 String higherName = generateElementName(basisSet, inputGraph, mapFToLocName, higher);
56 HNode higherNode = inputGraph.getHNode(higherName);
57 if (higherNode != null && higherNode.isSharedNode()) {
58 lattice.addSharedLoc(higherName);
60 Set<Descriptor> descSet = inputGraph.getDescSetOfNode(higherNode);
61 // System.out.println("higherName=" + higherName + " higherNode=" + higherNode + " descSet="
63 for (Iterator iterator2 = descSet.iterator(); iterator2.hasNext();) {
64 Descriptor d = (Descriptor) iterator2.next();
65 locSummary.addMapHNodeNameToLocationName(d.getSymbol(), higherName);
67 // locSummary.addMapHNodeNameToLocationName(higherName, higherName);
69 Set<Set<Integer>> lowerSet = mapImSucc.get(higher);
70 for (Iterator iterator2 = lowerSet.iterator(); iterator2.hasNext();) {
71 Set<Integer> lower = (Set<Integer>) iterator2.next();
73 String lowerName = generateElementName(basisSet, inputGraph, mapFToLocName, lower);
74 HNode lowerNode = inputGraph.getHNode(lowerName);
75 if (lowerNode != null && lowerNode.isSharedNode()) {
76 lattice.addSharedLoc(lowerName);
79 Set<Descriptor> lowerDescSet = inputGraph.getDescSetOfNode(lowerNode);
80 // System.out.println("lowerName=" + lowerName + " lowerNode=" + lowerNode + " descSet="
82 for (Iterator iterator3 = lowerDescSet.iterator(); iterator3.hasNext();) {
83 Descriptor d = (Descriptor) iterator3.next();
84 locSummary.addMapHNodeNameToLocationName(d.getSymbol(), lowerName);
86 // locSummary.addMapHNodeNameToLocationName(lowerName, lowerName);
88 // System.out.println("higherName=" + higherName + " lowerName=" + lowerName);
89 if (higher.size() == 0) {
91 lattice.put(lowerName);
93 lattice.addRelationHigherToLower(higherName, lowerName);
103 public HNode getCombinationNodeInSCGraph(Descriptor desc, HNode nodeFromSimpleGraph) {
105 HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
107 if (nodeFromSimpleGraph.isSkeleton()) {
108 return scGraph.getCurrentHNode(nodeFromSimpleGraph);
111 Set<HNode> combineSkeletonNodeSet =
112 infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(nodeFromSimpleGraph);
113 HNode combinationNodeInSCGraph =
114 infer.getSkeletonCombinationHierarchyGraph(desc).getMapCombineNodeSetToCombinationNode()
115 .get(combineSkeletonNodeSet);
117 // Set<HNode> combineSkeletonNodeSet =
118 // infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(simpleGraphNode);
119 // HNode combinationNodeInSCGraph =
120 // infer.getSkeletonCombinationHierarchyGraph(desc).getCombinationNode(combineSkeletonNodeSet);
121 return combinationNodeInSCGraph;
124 public SSJavaLattice<String> insertIntermediateNodesToStraightLine(Descriptor desc,
125 SSJavaLattice<String> skeletonLattice) {
127 // perform DFS that starts from each skeleton/combination node and ends by another
128 // skeleton/combination node
130 HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
131 HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
132 LocationSummary locSummary = infer.getLocationSummary(desc);
134 SSJavaLattice<String> lattice = skeletonLattice.clone();
136 Set<HNode> visited = new HashSet<HNode>();
138 Set<HNode> nodeSet = simpleGraph.getNodeSet();
140 Map<TripleItem, String> mapIntermediateLoc = new HashMap<TripleItem, String>();
142 for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
143 HNode node = (HNode) iterator.next();
144 // System.out.println("node=" + node);
145 if (node.isSkeleton() && (!visited.contains(node))) {
148 Set<HNode> outSet = simpleGraph.getOutgoingNodeSet(node);
149 for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
150 HNode outNode = (HNode) iterator2.next();
152 if (!outNode.isSkeleton()) {
153 if (outNode.isCombinationNode()) {
154 // expand the combination node 'outNode'
155 // here we need to expand the corresponding combination location in the lattice
156 HNode combinationNodeInSCGraph = getCombinationNodeInSCGraph(desc, outNode);
158 Set<HNode> combineSkeletonNodeSet =
159 simpleGraph.getCombineSetByCombinationNode(outNode);
161 // System.out.println("combineSkeletonNodeSet=" + combineSkeletonNodeSet);
163 Set<HNode> combinationNodeSet =
164 simpleGraph.getCombinationNodeSetByCombineNodeSet(combineSkeletonNodeSet);
166 // System.out.println("combinationNodeSet=" + combinationNodeSet);
168 Set<HNode> endNodeSetFromSimpleGraph =
169 simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode,
171 // System.out.println("-endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
172 Set<HNode> endCombNodeSet = new HashSet<HNode>();
173 for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
174 HNode endNode = (HNode) iterator3.next();
175 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
177 visited.add(outNode);
179 // follows the straight line up to another skeleton/combination node
180 if (endCombNodeSet.size() > 0) {
182 removeTransitivelyReachToNode(desc, combinationNodeInSCGraph, endCombNodeSet);
183 recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
184 mapIntermediateLoc, 1, locSummary, outNode);
188 // we have a node that is neither combination or skeleton node
189 // System.out.println("%%%skeleton node=" + node + " outNode=" + outNode);
190 HNode startNode = scGraph.getCurrentHNode(node);
192 // if (node.getDescriptor() != null) {
193 // // node is a skeleton node and it might be merged into another node in the SC
195 // startNode = scGraph.getHNode(node.getDescriptor());
197 // // this node has already been merged before the SC graph.
201 Set<HNode> endNodeSetFromSimpleGraph =
202 simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode, null);
204 // System.out.println("endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph
205 // + " from=" + outNode);
206 Set<HNode> endCombNodeSet = new HashSet<HNode>();
207 for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
208 HNode endNode = (HNode) iterator3.next();
209 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
211 // System.out.println("endCombNodeSet=" + endCombNodeSet);
212 visited.add(outNode);
213 if (endCombNodeSet.size() > 0) {
214 // follows the straight line up to another skeleton/combination node
215 endCombNodeSet = removeTransitivelyReachToNode(desc, startNode, endCombNodeSet);
216 } else if (endCombNodeSet.size() == 0) {
217 // the outNode is (directly/transitively) connected to the bottom node
218 // therefore, we just add a dummy bottom HNode to the endCombNodeSet.
219 endCombNodeSet.add(bottomNode);
221 recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
222 mapIntermediateLoc, 1, locSummary, outNode);
228 } else if (!node.isSkeleton() && !node.isCombinationNode() && !node.isMergeNode()
229 && !visited.contains(node)) {
231 // an intermediate node 'node' may be located between "TOP" location and a skeleton node
232 int sizeIncomingNode = simpleGraph.getIncomingNodeSet(node).size();
234 if (sizeIncomingNode == 0) {
235 // this node will be directly connected to the TOP location
236 // start adding the following nodes from this node
238 Set<HNode> endNodeSetFromSimpleGraph =
239 simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(node, null);
241 Set<HNode> endCombNodeSet = new HashSet<HNode>();
242 for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
243 HNode endNode = (HNode) iterator3.next();
244 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
247 HNode startNode = topNode;
248 visited.add(startNode);
249 if (endCombNodeSet.size() > 0) {
250 // follows the straight line up to another skeleton/combination node
251 // endCombNodeSet = removeTransitivelyReachToNode(desc, node, endCombNodeSet);
252 recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
253 mapIntermediateLoc, 1, locSummary, node);
265 private Set<HNode> removeTransitivelyReachToNode(Descriptor desc, HNode startNode,
266 Set<HNode> endNodeSet) {
268 // if an end node is not directly connected to the start node in the SC graph
269 // replace it with a directly connected one which transitively reaches to it.
271 HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
272 Set<HNode> newEndNodeSet = new HashSet<HNode>();
274 for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
275 HNode endNode = (HNode) iterator.next();
276 if (scGraph.isDirectlyConnectedTo(startNode, endNode)) {
277 newEndNodeSet.add(endNode);
280 getDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode);
281 // System.out.println("#### old END NODE=" + endNode + " --->" + newEndNode);
282 newEndNodeSet.add(newEndNode);
286 // System.out.println("removeTransitivelyReachToNode=" + endNodeSet + " newSet=" +
289 return newEndNodeSet;
293 private HNode getDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
294 HNode startNode, HNode endNode) {
295 Set<HNode> connected = new HashSet<HNode>();
296 recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode, connected);
297 return connected.iterator().next();
300 private void recurDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
301 HNode startNode, HNode curNode, Set<HNode> connected) {
303 Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
304 for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
305 HNode inNode = (HNode) iterator.next();
306 if (inNode.equals(startNode)) {
307 connected.add(curNode);
309 // System.out.println("inNode=" + inNode);
310 recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, inNode, connected);
316 private void recurDFSNormalNode(Descriptor desc, SSJavaLattice<String> lattice, HNode startNode,
317 Set<HNode> endNodeSet, Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc,
318 int idx, LocationSummary locSummary, HNode curNode) {
320 TripleItem item = new TripleItem(startNode, endNodeSet, idx);
321 // System.out.println("item=" + item);
322 if (!mapIntermediateLoc.containsKey(item)) {
323 // need to create a new intermediate location in the lattice
324 String newLocName = "ILOC" + (seed++);
327 above = startNode.getName();
329 int prevIdx = idx - 1;
330 TripleItem prevItem = new TripleItem(startNode, endNodeSet, prevIdx);
331 above = mapIntermediateLoc.get(prevItem);
334 Set<String> belowSet = new HashSet<String>();
335 for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
336 HNode endNode = (HNode) iterator.next();
337 belowSet.add(endNode.getName());
340 lattice.insertNewLocationBetween(above, belowSet, newLocName);
342 mapIntermediateLoc.put(item, newLocName);
345 String locName = mapIntermediateLoc.get(item);
346 HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
348 Set<Descriptor> descSet = graph.getDescSetOfNode(curNode);
349 for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
350 Descriptor d = (Descriptor) iterator.next();
351 locSummary.addMapHNodeNameToLocationName(d.getSymbol(), locName);
353 // locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
355 Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
356 for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
357 HNode outNode = (HNode) iterator2.next();
358 if (!outNode.isSkeleton() && !outNode.isCombinationNode() && !visited.contains(outNode)) {
359 visited.add(outNode);
360 recurDFSNormalNode(desc, lattice, startNode, endNodeSet, visited, mapIntermediateLoc,
361 idx + 1, locSummary, outNode);
367 private void recurDFS(Descriptor desc, SSJavaLattice<String> lattice,
368 HNode combinationNodeInSCGraph, Set<HNode> endNodeSet, Set<HNode> visited,
369 Map<TripleItem, String> mapIntermediateLoc, int idx, LocationSummary locSummary, HNode curNode) {
371 TripleItem item = new TripleItem(combinationNodeInSCGraph, endNodeSet, idx);
373 if (!mapIntermediateLoc.containsKey(item)) {
374 // need to create a new intermediate location in the lattice
377 String newLocName = combinationNodeInSCGraph.getName();
378 mapIntermediateLoc.put(item, newLocName);
380 String newLocName = "ILOC" + (seed++);
381 int prevIdx = idx - 1;
382 TripleItem prevItem = new TripleItem(combinationNodeInSCGraph, endNodeSet, prevIdx);
383 above = mapIntermediateLoc.get(prevItem);
385 Set<String> belowSet = new HashSet<String>();
386 for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
387 HNode endNode = (HNode) iterator.next();
388 belowSet.add(endNode.getName());
390 lattice.insertNewLocationBetween(above, belowSet, newLocName);
391 mapIntermediateLoc.put(item, newLocName);
397 HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
398 String locName = mapIntermediateLoc.get(item);
399 Set<Descriptor> descSet = graph.getDescSetOfNode(curNode);
400 for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
401 Descriptor d = (Descriptor) iterator.next();
402 locSummary.addMapHNodeNameToLocationName(d.getSymbol(), locName);
405 // System.out.println("-TripleItem=" + item);
406 // System.out.println("-curNode=" + curNode.getName() + " locName=" + locName);
408 Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
409 for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
410 HNode outNode = (HNode) iterator2.next();
411 if (!outNode.isSkeleton() && !visited.contains(outNode)) {
412 if (combinationNodeInSCGraph.equals(getCombinationNodeInSCGraph(desc, outNode))) {
413 visited.add(outNode);
414 recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited,
415 mapIntermediateLoc, idx + 1, locSummary, outNode);
422 private String generateElementName(BasisSet basisSet, HierarchyGraph inputGraph,
423 Map<Set<Integer>, String> mapF2LocName, Set<Integer> F) {
425 if (mapF2LocName.containsKey(F)) {
426 return mapF2LocName.get(F);
429 HNode node = basisSet.getHNode(F);
431 mapF2LocName.put(F, node.getName());
432 return node.getName();
434 if (inputGraph.BASISTOPELEMENT.equals(F)) {
435 return SSJavaAnalysis.BOTTOM;
437 String str = "LOC" + (seed++);
438 mapF2LocName.put(F, str);
444 private void resetCount(Map<Set<Integer>, Integer> mapFtoCount, Family family) {
445 for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
446 Set<Integer> F = iter.next();
447 mapFtoCount.put(F, 0);
451 private Map<Set<Integer>, Set<Set<Integer>>> coveringGraph(BasisSet basisSet, Family family) {
453 Map<Set<Integer>, Integer> mapFtoCount = new HashMap<Set<Integer>, Integer>();
454 Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = new HashMap<Set<Integer>, Set<Set<Integer>>>();
456 // initialize COUNT(F) to 0 for all elements of the family
457 resetCount(mapFtoCount, family);
459 for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
460 Set<Integer> F = iter.next();
461 Set<HNode> gammaF = family.getGamma(F);
463 Set<HNode> curHNodeSet = basisSet.getHNodeSet();
464 curHNodeSet.removeAll(gammaF);
465 Set<Set<Integer>> Bset = basisSet.getBasisSetByHNodeSet(curHNodeSet);
467 for (Iterator iterator = Bset.iterator(); iterator.hasNext();) {
468 Set<Integer> B = (Set<Integer>) iterator.next();
470 Set<Integer> Fprime = new HashSet<Integer>();
475 mapFtoCount.put(Fprime, mapFtoCount.get(Fprime) + 1);
477 // if |gamma(F')|==COUNT(F') + |gamma(F)|
478 int numGammaFprime = family.getGamma(Fprime).size();
479 int countFprime = mapFtoCount.get(Fprime);
480 int numGammaF = family.getGamma(F).size();
481 if (numGammaFprime == (countFprime + numGammaF)) {
482 // ImSucc(F)=IMSucc(F) union F'
483 addImSucc(mapImSucc, F, Fprime);
487 resetCount(mapFtoCount, family);
490 // System.out.println("mapImSucc=" + mapImSucc);
495 private Set<Set<Integer>> getImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F) {
496 if (!mapImSucc.containsKey(F)) {
497 mapImSucc.put(F, new HashSet<Set<Integer>>());
499 return mapImSucc.get(F);
502 private void addImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F,
503 Set<Integer> Fprime) {
505 if (!mapImSucc.containsKey(F)) {
506 mapImSucc.put(F, new HashSet<Set<Integer>>());
509 mapImSucc.get(F).add(Fprime);
513 private Family generateFamily(BasisSet basisSet) {
515 Family family = new Family();
517 for (Iterator<Set<Integer>> iterator = basisSet.basisIterator(); iterator.hasNext();) {
518 Set<Integer> B = iterator.next();
520 Set<Pair<Set<Integer>, Set<HNode>>> tobeadded = new HashSet<Pair<Set<Integer>, Set<HNode>>>();
522 for (Iterator<Set<Integer>> iterator2 = family.FIterator(); iterator2.hasNext();) {
523 Set<Integer> F = iterator2.next();
525 Set<Integer> Fprime = new HashSet<Integer>();
529 Set<HNode> gammaFPrimeSet = new HashSet<HNode>();
530 gammaFPrimeSet.addAll(family.getGamma(F));
531 gammaFPrimeSet.add(basisSet.getHNode(B));
533 if (!family.containsF(Fprime)) {
534 Pair<Set<Integer>, Set<HNode>> pair =
535 new Pair<Set<Integer>, Set<HNode>>(Fprime, gammaFPrimeSet);
538 family.updateGammaF(Fprime, gammaFPrimeSet);
542 for (Iterator<Pair<Set<Integer>, Set<HNode>>> iterator2 = tobeadded.iterator(); iterator2
544 Pair<Set<Integer>, Set<HNode>> pair = iterator2.next();
545 family.addFElement(pair.getFirst());
546 family.updateGammaF(pair.getFirst(), pair.getSecond());
553 private void debug_print(HierarchyGraph inputGraph) {
554 System.out.println("\nBuild Lattice:" + inputGraph.getName());
555 // System.out.println("Node2Index:\n" + inputGraph.getMapHNodeToUniqueIndex());
556 // System.out.println("Node2Basis:\n" + inputGraph.getMapHNodeToBasis());
565 public Identifier(HNode n, int i) {
570 public int hashCode() {
571 return node.hashCode() + idx;
574 public boolean equals(Object obj) {
576 if (obj instanceof Identifier) {
577 Identifier in = (Identifier) obj;
578 if (node.equals(in.node) && idx == in.idx) {
589 public HNode higherNode;
590 public Set<HNode> lowerNodeSet;
593 public TripleItem(HNode h, Set<HNode> l, int i) {
599 public int hashCode() {
602 if (higherNode != null) {
603 h = higherNode.hashCode();
606 return h + lowerNodeSet.hashCode() + idx;
609 public boolean equals(Object obj) {
611 if (obj instanceof TripleItem) {
612 TripleItem in = (TripleItem) obj;
613 if ((higherNode == null || (higherNode != null && higherNode.equals(in.higherNode)))
614 && lowerNodeSet.equals(in.lowerNodeSet) && idx == in.idx) {
622 public String toString() {
623 return higherNode + "-" + idx + "->" + lowerNodeSet;