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 IR.MethodDescriptor;
  11 import IR.NameDescriptor;
  12 import Util.Pair;
  13
  14 public class BuildLattice {
  15
  16   private LocationInference infer;
  17   private Map<HNode, TripleItem> mapSharedNodeToTripleItem;
  18   private Map<HNode, Integer> mapHNodeToHighestIndex;
  19
  20   public BuildLattice(LocationInference infer) {
  21     this.infer = infer;
  22     this.mapSharedNodeToTripleItem = new HashMap<HNode, TripleItem>();
  23     this.mapHNodeToHighestIndex = new HashMap<HNode, Integer>();
  24   }
  25
  26   public SSJavaLattice<String> buildLattice(Descriptor desc) {
  27
  28     HierarchyGraph inputGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
  29     LocationSummary locSummary = infer.getLocationSummary(desc);
  30
  31     Set<HNode> nodeSetWithCompositeLocation = new HashSet<HNode>();
  32     if (desc instanceof MethodDescriptor) {
  33       FlowGraph flowGraph = infer.getFlowGraph((MethodDescriptor) desc);
  34
  35       for (Iterator iterator = inputGraph.getNodeSet().iterator(); iterator.hasNext();) {
  36         HNode hnode = (HNode) iterator.next();
  37         Descriptor hnodeDesc = hnode.getDescriptor();
  38         if (hnodeDesc != null) {
  39           NTuple<Descriptor> descTuple = new NTuple<Descriptor>();
  40           descTuple.add(hnodeDesc);
  41
  42           if (flowGraph.contains(descTuple)) {
  43             FlowNode flowNode = flowGraph.getFlowNode(descTuple);
  44             if (flowNode.getCompositeLocation() != null) {
  45               nodeSetWithCompositeLocation.add(hnode);
  46             }
  47           }
  48
  49         }
  50       }
  51
  52     }
  53
  54     BasisSet basisSet = inputGraph.computeBasisSet(nodeSetWithCompositeLocation);
  55     debug_print(inputGraph);
  56
  57     Family family = generateFamily(basisSet);
  58     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = coveringGraph(basisSet, family);
  59
  60     SSJavaLattice<String> lattice = buildLattice(desc, basisSet, inputGraph, locSummary, mapImSucc);
  61     return lattice;
  62
  63   }
  64
  65   private SSJavaLattice<String> buildLattice(Descriptor desc, BasisSet basisSet,
  66       HierarchyGraph inputGraph, LocationSummary locSummary,
  67       Map<Set<Integer>, Set<Set<Integer>>> mapImSucc) {
  68
  69     HierarchyGraph simpleHierarchyGraph = infer.getSimpleHierarchyGraph(desc);
  70
  71     SSJavaLattice<String> lattice =
  72         new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
  73
  74     Map<Set<Integer>, String> mapFToLocName = new HashMap<Set<Integer>, String>();
  75
  76     Set<Set<Integer>> keySet = mapImSucc.keySet();
  77     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
  78       Set<Integer> higher = (Set<Integer>) iterator.next();
  79
  80       String higherName = generateElementName(basisSet, inputGraph, mapFToLocName, higher);
  81
  82       HNode higherNode = inputGraph.getHNode(higherName);
  83
  84       if (higherNode == null) {
  85         NameDescriptor d = new NameDescriptor(higherName);
  86         higherNode = inputGraph.getHNode(d);
  87         higherNode.setSkeleton(true);
  88       }
  89
  90       if (higherNode != null && higherNode.isSharedNode()) {
  91         lattice.addSharedLoc(higherName);
  92       }
  93       Set<Descriptor> descSet = inputGraph.getDescSetOfNode(higherNode);
  94       // System.out.println("higherName=" + higherName + "  higherNode=" + higherNode + "  descSet="
  95       // + descSet);
  96       for (Iterator iterator2 = descSet.iterator(); iterator2.hasNext();) {
  97         Descriptor d = (Descriptor) iterator2.next();
  98         locSummary.addMapHNodeNameToLocationName(d.getSymbol(), higherName);
  99       }
 100       // locSummary.addMapHNodeNameToLocationName(higherName, higherName);
 101
 102       Set<Set<Integer>> lowerSet = mapImSucc.get(higher);
 103       for (Iterator iterator2 = lowerSet.iterator(); iterator2.hasNext();) {
 104         Set<Integer> lower = (Set<Integer>) iterator2.next();
 105
 106         String lowerName = generateElementName(basisSet, inputGraph, mapFToLocName, lower);
 107         HNode lowerNode = inputGraph.getHNode(lowerName);
 108
 109         if (lowerNode == null && !lowerName.equals(SSJavaAnalysis.BOTTOM)) {
 110           NameDescriptor d = new NameDescriptor(lowerName);
 111           lowerNode = inputGraph.getHNode(d);
 112           lowerNode.setSkeleton(true);
 113         }
 114
 115         if (lowerNode != null && !inputGraph.isDirectlyConnectedTo(higherNode, lowerNode)) {
 116           inputGraph.addEdge(higherNode, lowerNode);
 117         }
 118
 119         if (lowerNode != null && lowerNode.isSharedNode()) {
 120           lattice.addSharedLoc(lowerName);
 121         }
 122
 123         Set<Descriptor> lowerDescSet = inputGraph.getDescSetOfNode(lowerNode);
 124         // System.out.println("lowerName=" + lowerName + "  lowerNode=" + lowerNode + "  descSet="
 125         // + lowerDescSet);
 126         for (Iterator iterator3 = lowerDescSet.iterator(); iterator3.hasNext();) {
 127           Descriptor d = (Descriptor) iterator3.next();
 128           locSummary.addMapHNodeNameToLocationName(d.getSymbol(), lowerName);
 129         }
 130         // locSummary.addMapHNodeNameToLocationName(lowerName, lowerName);
 131
 132         if (higher.size() == 0) {
 133           // empty case
 134           lattice.put(lowerName);
 135         } else {
 136           lattice.addRelationHigherToLower(higherName, lowerName);
 137         }
 138
 139       }
 140
 141     }
 142
 143     return lattice;
 144   }
 145
 146   public HNode getCombinationNodeInSCGraph(Descriptor desc, HNode nodeFromSimpleGraph) {
 147
 148     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
 149
 150     if (nodeFromSimpleGraph.isSkeleton()) {
 151       return scGraph.getCurrentHNode(nodeFromSimpleGraph);
 152     }
 153
 154     Set<HNode> combineSkeletonNodeSet =
 155         infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(nodeFromSimpleGraph);
 156     HNode combinationNodeInSCGraph =
 157         infer.getSkeletonCombinationHierarchyGraph(desc).getMapCombineNodeSetToCombinationNode()
 158             .get(combineSkeletonNodeSet);
 159
 160     // Set<HNode> combineSkeletonNodeSet =
 161     // infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(simpleGraphNode);
 162     // HNode combinationNodeInSCGraph =
 163     // infer.getSkeletonCombinationHierarchyGraph(desc).getCombinationNode(combineSkeletonNodeSet);
 164     return combinationNodeInSCGraph;
 165   }
 166
 167   public SSJavaLattice<String> insertIntermediateNodesToStraightLine(Descriptor desc,
 168       SSJavaLattice<String> skeletonLattice) {
 169
 170     // perform DFS that starts from each skeleton/combination node and ends by another
 171     // skeleton/combination node
 172
 173     mapSharedNodeToTripleItem.clear();
 174
 175     HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
 176     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
 177     LocationSummary locSummary = infer.getLocationSummary(desc);
 178
 179     SSJavaLattice<String> lattice = skeletonLattice.clone();
 180
 181     Set<HNode> visited = new HashSet<HNode>();
 182
 183     Set<HNode> nodeSet = simpleGraph.getNodeSet();
 184
 185     Map<TripleItem, String> mapIntermediateLoc = new HashMap<TripleItem, String>();
 186
 187     // System.out.println("*insert=" + desc);
 188     // System.out.println("***nodeSet=" + nodeSet);
 189     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 190       HNode node = (HNode) iterator.next();
 191       System.out.println("node=" + node);
 192
 193       if (node.isSkeleton() && (!visited.contains(node))) {
 194         visited.add(node);
 195
 196         Set<HNode> outSet = simpleGraph.getOutgoingNodeSet(node);
 197         for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
 198           HNode outNode = (HNode) iterator2.next();
 199
 200           if (!outNode.isSkeleton()) {
 201             if (outNode.isCombinationNode()) {
 202               if (visited.containsAll(simpleGraph.getIncomingNodeSet(outNode))) {
 203                 // if (needToExpandCombinationNode(desc, outNode)) {
 204                 expandCombinationNode(desc, lattice, visited, mapIntermediateLoc, locSummary,
 205                     outNode);
 206                 // }
 207               }
 208             } else {
 209               // we have a node that is neither combination or skeleton node
 210               // System.out.println("%%%skeleton node=" + node + "  outNode=" + outNode);
 211               HNode startNode = scGraph.getCurrentHNode(node);
 212
 213               // if (node.getDescriptor() != null) {
 214               // // node is a skeleton node and it might be merged into another node in the SC
 215               // graph.
 216               // startNode = scGraph.getHNode(node.getDescriptor());
 217               // } else {
 218               // // this node has already been merged before the SC graph.
 219               // startNode = node;
 220               // }
 221
 222               Set<HNode> endNodeSetFromSimpleGraph =
 223                   simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode, null);
 224
 225               // System.out.println("endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph
 226               // + "   from=" + outNode);
 227               Set<HNode> endCombNodeSet = new HashSet<HNode>();
 228               for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
 229                 HNode endNode = (HNode) iterator3.next();
 230                 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
 231               }
 232               // System.out.println("endCombNodeSet=" + endCombNodeSet);
 233               visited.add(outNode);
 234               if (endCombNodeSet.size() > 0) {
 235                 // follows the straight line up to another skeleton/combination node
 236                 endCombNodeSet = removeTransitivelyReachToNode(desc, startNode, endCombNodeSet);
 237               } else if (endCombNodeSet.size() == 0) {
 238                 // the outNode is (directly/transitively) connected to the bottom node
 239                 // therefore, we just add a dummy bottom HNode to the endCombNodeSet.
 240                 endCombNodeSet.add(LocationInference.BOTTOMHNODE);
 241               }
 242
 243               recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
 244                   mapIntermediateLoc, 1, locSummary, outNode);
 245             }
 246
 247           }
 248
 249         }
 250       } else if (!node.isSkeleton() && !node.isCombinationNode() && !node.isMergeNode()
 251           && !visited.contains(node)) {
 252
 253         System.out.println("n=" + node);
 254
 255         // an intermediate node 'node' may be located between "TOP" location and a skeleton node
 256         if (simpleGraph.getIncomingNodeSet(node).size() == 0) {
 257
 258           // this node will be directly connected to the TOP location
 259           // start adding the following nodes from this node
 260
 261           Set<HNode> endNodeSetFromSimpleGraph =
 262               simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(node, null);
 263
 264           Set<HNode> endCombNodeSet = new HashSet<HNode>();
 265           for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
 266             HNode endNode = (HNode) iterator3.next();
 267             endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
 268           }
 269
 270           System.out.println("endCombNodeSet=" + endCombNodeSet);
 271           HNode startNode = LocationInference.TOPHNODE;
 272           visited.add(startNode);
 273           if (endCombNodeSet.size() > 0) {
 274             // follows the straight line up to another skeleton/combination node
 275             // endCombNodeSet = removeTransitivelyReachToNode(desc, node, endCombNodeSet);
 276             recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
 277                 mapIntermediateLoc, 1, locSummary, node);
 278           }
 279
 280         }
 281
 282       }
 283     }
 284
 285     // add shared locations
 286     Set<HNode> sharedNodeSet = mapSharedNodeToTripleItem.keySet();
 287     for (Iterator iterator = sharedNodeSet.iterator(); iterator.hasNext();) {
 288       HNode sharedNode = (HNode) iterator.next();
 289       TripleItem item = mapSharedNodeToTripleItem.get(sharedNode);
 290       String nonSharedLocName = mapIntermediateLoc.get(item);
 291       // System.out.println("sharedNode=" + sharedNode + "    locName=" + nonSharedLocName);
 292
 293       String newLocName;
 294       if (locSummary.getHNodeNameSetByLatticeLoationName(nonSharedLocName) != null
 295           && !lattice.isSharedLoc(nonSharedLocName)) {
 296         // need to generate a new shared location in the lattice, which is one level lower than the
 297         // 'locName' location
 298         newLocName = "ILOC" + (LocationInference.locSeed++);
 299
 300         // Set<String> aboveElementSet = getAboveElementSet(lattice, locName);
 301         Set<String> belowElementSet = new HashSet<String>();
 302         belowElementSet.addAll(lattice.get(nonSharedLocName));
 303
 304         // System.out.println("nonSharedLocName=" + nonSharedLocName + "   belowElementSet="
 305         // + belowElementSet + "  newLocName=" + newLocName);
 306
 307         lattice.insertNewLocationBetween(nonSharedLocName, belowElementSet, newLocName);
 308       } else {
 309         newLocName = nonSharedLocName;
 310       }
 311
 312       lattice.addSharedLoc(newLocName);
 313       HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
 314       Set<Descriptor> descSet = graph.getDescSetOfNode(sharedNode);
 315       for (Iterator iterator2 = descSet.iterator(); iterator2.hasNext();) {
 316         Descriptor d = (Descriptor) iterator2.next();
 317         locSummary.addMapHNodeNameToLocationName(d.getSymbol(), newLocName);
 318       }
 319       locSummary.addMapHNodeNameToLocationName(sharedNode.getName(), newLocName);
 320
 321     }
 322
 323     return lattice;
 324
 325   }
 326
 327   private Set<String> getAboveElementSet(SSJavaLattice<String> lattice, String loc) {
 328
 329     Set<String> aboveSet = new HashSet<String>();
 330
 331     Map<String, Set<String>> latticeMap = lattice.getTable();
 332     Set<String> keySet = latticeMap.keySet();
 333     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 334       String key = (String) iterator.next();
 335       if (latticeMap.get(key).contains(loc)) {
 336         aboveSet.add(key);
 337       }
 338     }
 339
 340     return aboveSet;
 341   }
 342
 343   private boolean needToExpandCombinationNode(Descriptor desc, HNode cnode) {
 344
 345     System.out.println("needToExpandCombinationNode?=" + cnode);
 346
 347     HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
 348     // HNode combinationNodeInSCGraph = getCombinationNodeInSCGraph(desc, cnode);
 349     Set<HNode> combineSkeletonNodeSet = simpleGraph.getCombineSetByCombinationNode(cnode);
 350     Set<HNode> combinationNodeSetInSimpleGraph =
 351         simpleGraph.getCombinationNodeSetByCombineNodeSet(combineSkeletonNodeSet);
 352     System.out.println("---combinationNodeSetInSimpleGraph=" + combinationNodeSetInSimpleGraph);
 353     Set<HNode> inNodeSetToCNode = simpleGraph.getIncomingNodeSet(cnode);
 354     System.out.println("------inNodeSetToCNode=" + inNodeSetToCNode);
 355     for (Iterator iterator = combinationNodeSetInSimpleGraph.iterator(); iterator.hasNext();) {
 356       HNode nodeBelongToTheSameCombinationNode = (HNode) iterator.next();
 357       if (inNodeSetToCNode.contains(nodeBelongToTheSameCombinationNode)) {
 358         // the combination node 'cnode' is not the highest location among the same combination node
 359         return false;
 360       }
 361     }
 362
 363     return true;
 364   }
 365
 366   private void expandCombinationNode(Descriptor desc, SSJavaLattice<String> lattice,
 367       Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc, LocationSummary locSummary,
 368       HNode cnode) {
 369
 370     // expand the combination node 'outNode'
 371     // here we need to expand the corresponding combination location in the lattice
 372     HNode combinationNodeInSCGraph = getCombinationNodeInSCGraph(desc, cnode);
 373
 374     System.out.println("expandCombinationNode=" + cnode + "  cnode in scgraph="
 375         + combinationNodeInSCGraph);
 376
 377     if (combinationNodeInSCGraph == null) {
 378       return;
 379     }
 380
 381     HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
 382
 383     Set<HNode> combineSkeletonNodeSet = simpleGraph.getCombineSetByCombinationNode(cnode);
 384
 385     // System.out.println("combineSkeletonNodeSet=" + combineSkeletonNodeSet);
 386
 387     Set<HNode> combinationNodeSet =
 388         simpleGraph.getCombinationNodeSetByCombineNodeSet(combineSkeletonNodeSet);
 389
 390     // System.out.println("combinationNodeSet=" + combinationNodeSet);
 391
 392     Set<HNode> endNodeSetFromSimpleGraph =
 393         simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(cnode, combinationNodeSet);
 394     // System.out.println("-endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
 395     Set<HNode> endCombNodeSet = new HashSet<HNode>();
 396     for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
 397       HNode endNode = (HNode) iterator3.next();
 398       endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
 399     }
 400     visited.add(cnode);
 401
 402     // follows the straight line up to another skeleton/combination node
 403     if (endCombNodeSet.size() > 0) {
 404       // System.out.println("---endCombNodeSet=" + endCombNodeSet);
 405       endCombNodeSet =
 406           removeTransitivelyReachToNode(desc, combinationNodeInSCGraph, endCombNodeSet);
 407
 408       recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
 409           mapIntermediateLoc, 1, locSummary, cnode);
 410     } else {
 411       endCombNodeSet.add(LocationInference.BOTTOMHNODE);
 412       // System.out.println("---endCombNodeSet is zero");
 413       // System.out.println("---endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
 414       // System.out.println("---incoming=" + simpleGraph.getIncomingNodeSet(cnode));
 415       recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
 416           mapIntermediateLoc, 1, locSummary, cnode);
 417
 418     }
 419
 420   }
 421
 422   private Set<HNode> removeTransitivelyReachToNode(Descriptor desc, HNode startNode,
 423       Set<HNode> endNodeSet) {
 424
 425     // if an end node is not directly connected to the start node in the SC graph
 426     // replace it with a directly connected one which transitively reaches to it.
 427
 428     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
 429
 430     Set<HNode> newEndNodeSet = new HashSet<HNode>();
 431     for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
 432       HNode endNode = (HNode) iterator.next();
 433       if (scGraph.isDirectlyConnectedTo(startNode, endNode)) {
 434         newEndNodeSet.add(endNode);
 435       } else {
 436         HNode newEndNode =
 437             getDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode);
 438         // System.out.println("#### old END NODE=" + endNode + " --->" + newEndNode);
 439         newEndNodeSet.add(newEndNode);
 440       }
 441     }
 442
 443     // System.out.println("removeTransitivelyReachToNode=" + endNodeSet + "  newSet=" +
 444     // newEndNodeSet);
 445
 446     return newEndNodeSet;
 447
 448   }
 449
 450   private HNode getDirectlyReachableSCNodeFromEndNode(HierarchyGraph scGraph, HNode startNode,
 451       Set<HNode> endNodeSet) {
 452
 453     // System.out.println("getDirectlyReachableSCNodeFromEndNode start=" + startNode +
 454     // " endNodeSet="
 455     // + endNodeSet);
 456     Set<HNode> newStartNodeSet = new HashSet<HNode>();
 457
 458     for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
 459       HNode endNode = (HNode) iterator.next();
 460       Set<HNode> connectedToEndNodeSet = scGraph.getIncomingNodeSet(endNode);
 461
 462       for (Iterator iterator2 = connectedToEndNodeSet.iterator(); iterator2.hasNext();) {
 463         HNode curNode = (HNode) iterator2.next();
 464         if (recurConnectedFromStartNode(scGraph, startNode, curNode, new HashSet<HNode>())) {
 465           newStartNodeSet.add(curNode);
 466         }
 467       }
 468     }
 469
 470     // System.out.println("newStartNodeSet=" + newStartNodeSet);
 471
 472     if (newStartNodeSet.size() == 0) {
 473       newStartNodeSet.add(startNode);
 474     }
 475
 476     return newStartNodeSet.iterator().next();
 477   }
 478
 479   private boolean recurConnectedFromStartNode(HierarchyGraph scGraph, HNode startNode,
 480       HNode curNode, Set<HNode> visited) {
 481     // return true if curNode is transitively connected from the startNode
 482
 483     boolean isConnected = false;
 484     Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
 485     for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
 486       HNode in = (HNode) iterator.next();
 487       if (in.equals(startNode)) {
 488         return true;
 489       } else {
 490         visited.add(in);
 491         isConnected |= recurConnectedFromStartNode(scGraph, startNode, in, visited);
 492       }
 493     }
 494
 495     return isConnected;
 496   }
 497
 498   private HNode getDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
 499       HNode startNode, HNode endNode) {
 500     // System.out.println("getDirectlyReachableNodeFromStartNodeReachToEndNode start=" + startNode
 501     // + " end=" + endNode);
 502     Set<HNode> connected = new HashSet<HNode>();
 503     recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode, connected);
 504     if (connected.size() == 0) {
 505       connected.add(endNode);
 506     }
 507     // System.out.println("connected=" + connected);
 508
 509     return connected.iterator().next();
 510   }
 511
 512   private void recurDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
 513       HNode startNode, HNode curNode, Set<HNode> connected) {
 514
 515     Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
 516     for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
 517       HNode inNode = (HNode) iterator.next();
 518       if (inNode.equals(startNode)) {
 519         connected.add(curNode);
 520       } else {
 521         recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, inNode, connected);
 522       }
 523     }
 524
 525   }
 526
 527   private void recurDFSNormalNode(Descriptor desc, SSJavaLattice<String> lattice, HNode startNode,
 528       Set<HNode> endNodeSet, Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc,
 529       int idx, LocationSummary locSummary, HNode curNode) {
 530
 531     TripleItem item = new TripleItem(startNode, endNodeSet, idx);
 532     // System.out.println("item=" + item);
 533     if (!mapIntermediateLoc.containsKey(item)) {
 534       // need to create a new intermediate location in the lattice
 535       String newLocName = "ILOC" + (LocationInference.locSeed++);
 536       String above;
 537       if (idx == 1) {
 538         above = startNode.getName();
 539       } else {
 540         int prevIdx = idx - 1;
 541         TripleItem prevItem = new TripleItem(startNode, endNodeSet, prevIdx);
 542         above = mapIntermediateLoc.get(prevItem);
 543       }
 544
 545       Set<String> belowSet = new HashSet<String>();
 546       for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
 547         HNode endNode = (HNode) iterator.next();
 548         String locName;
 549         if (locSummary.getMapHNodeNameToLocationName().containsKey(endNode.getName())) {
 550           locName = locSummary.getLocationName(endNode.getName());
 551         } else {
 552           locName = endNode.getName();
 553         }
 554         belowSet.add(locName);
 555       }
 556       lattice.insertNewLocationBetween(above, belowSet, newLocName);
 557
 558       mapIntermediateLoc.put(item, newLocName);
 559     }
 560
 561     String locName = mapIntermediateLoc.get(item);
 562     HierarchyGraph simpleHierarchyGraph = infer.getSimpleHierarchyGraph(desc);
 563
 564     if (curNode.isSharedNode()) {
 565       // if the current node is shared location, add a shared location to the lattice later
 566       mapSharedNodeToTripleItem.put(curNode, item);
 567     } else {
 568       Set<Descriptor> descSet = simpleHierarchyGraph.getDescSetOfNode(curNode);
 569       for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
 570         Descriptor d = (Descriptor) iterator.next();
 571         locSummary.addMapHNodeNameToLocationName(d.getSymbol(), locName);
 572       }
 573       locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
 574     }
 575
 576     System.out.println("-TripleItem normal=" + item);
 577     System.out.println("-curNode=" + curNode.getName() + " S=" + curNode.isSharedNode()
 578         + " locName=" + locName + "  isC=" + curNode.isCombinationNode());
 579
 580     Set<HNode> outSet = simpleHierarchyGraph.getOutgoingNodeSet(curNode);
 581     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
 582       HNode outNode = (HNode) iterator2.next();
 583
 584       Set<HNode> incomingHNodeSetToOutNode = simpleHierarchyGraph.getIncomingNodeSet(outNode);
 585       System.out.println("outNode=" + outNode);
 586       System.out.println("---incomingHNodeSetToOutNode=" + incomingHNodeSetToOutNode);
 587
 588       if (!outNode.isSkeleton() && !outNode.isCombinationNode() && !visited.contains(outNode)) {
 589         if (visited.containsAll(simpleHierarchyGraph.getIncomingNodeSet(outNode))) {
 590           visited.add(outNode);
 591           int newidx = getCurrentHighestIndex(outNode, idx + 1);
 592           recurDFSNormalNode(desc, lattice, startNode, endNodeSet, visited, mapIntermediateLoc,
 593               newidx, locSummary, outNode);
 594           // recurDFSNormalNode(desc, lattice, startNode, endNodeSet, visited, mapIntermediateLoc,
 595           // idx + 1, locSummary, outNode);
 596         } else {
 597           updateHighestIndex(outNode, idx + 1);
 598           System.out.println("NOT RECUR");
 599         }
 600       } else if (!outNode.isSkeleton() && outNode.isCombinationNode() && !visited.contains(outNode)) {
 601         if (needToExpandCombinationNode(desc, outNode)) {
 602           System.out.println("NEED TO");
 603           expandCombinationNode(desc, lattice, visited, mapIntermediateLoc, locSummary, outNode);
 604         } else {
 605           System.out.println("NOT NEED TO");
 606         }
 607       }
 608
 609     }
 610
 611   }
 612
 613   private void recurDFS(Descriptor desc, SSJavaLattice<String> lattice,
 614       HNode combinationNodeInSCGraph, Set<HNode> endNodeSet, Set<HNode> visited,
 615       Map<TripleItem, String> mapIntermediateLoc, int idx, LocationSummary locSummary, HNode curNode) {
 616
 617     TripleItem item = new TripleItem(combinationNodeInSCGraph, endNodeSet, idx);
 618
 619     if (!mapIntermediateLoc.containsKey(item)) {
 620       // need to create a new intermediate location in the lattice
 621       String above;
 622       if (idx == 1) {
 623         String newLocName = combinationNodeInSCGraph.getName();
 624         mapIntermediateLoc.put(item, newLocName);
 625       } else {
 626         String newLocName = "ILOC" + (LocationInference.locSeed++);
 627         int prevIdx = idx - 1;
 628         TripleItem prevItem = new TripleItem(combinationNodeInSCGraph, endNodeSet, prevIdx);
 629         above = mapIntermediateLoc.get(prevItem);
 630
 631         Set<String> belowSet = new HashSet<String>();
 632         for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
 633           HNode endNode = (HNode) iterator.next();
 634           belowSet.add(endNode.getName());
 635         }
 636         lattice.insertNewLocationBetween(above, belowSet, newLocName);
 637         mapIntermediateLoc.put(item, newLocName);
 638       }
 639
 640     }
 641
 642     // TODO
 643     // Do we need to skip the combination node and assign a shared location to the next node?
 644     // if (idx == 1 && curNode.isSharedNode()) {
 645     // System.out.println("THE FIRST COMBINATION NODE EXPANSION IS SHARED!");
 646     // recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited, mapIntermediateLoc,
 647     // idx + 1, locSummary, curNode);
 648     // return;
 649     // }
 650
 651     HierarchyGraph simpleHierarchyGraph = infer.getSimpleHierarchyGraph(desc);
 652     String locName = mapIntermediateLoc.get(item);
 653     if (curNode.isSharedNode()) {
 654       // if the current node is shared location, add a shared location to the lattice later
 655       mapSharedNodeToTripleItem.put(curNode, item);
 656     } else {
 657       Set<Descriptor> descSet = simpleHierarchyGraph.getDescSetOfNode(curNode);
 658       for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
 659         Descriptor d = (Descriptor) iterator.next();
 660         locSummary.addMapHNodeNameToLocationName(d.getSymbol(), locName);
 661       }
 662       locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
 663     }
 664
 665     System.out.println("-TripleItem=" + item);
 666     System.out.println("-curNode=" + curNode.getName() + " S=" + curNode.isSharedNode()
 667         + " locName=" + locName);
 668
 669     Set<HNode> outSet = simpleHierarchyGraph.getOutgoingNodeSet(curNode);
 670     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
 671       HNode outNode = (HNode) iterator2.next();
 672       System.out.println("---recurDFS outNode=" + outNode);
 673       System.out.println("---cur combinationNodeInSCGraph=" + combinationNodeInSCGraph);
 674       System.out.println("---outNode combinationNodeInSCGraph="
 675           + getCombinationNodeInSCGraph(desc, outNode));
 676
 677       if (!outNode.isSkeleton() && !visited.contains(outNode)) {
 678         if (outNode.isCombinationNode()) {
 679
 680           Set<HNode> combineSkeletonNodeSet =
 681               simpleHierarchyGraph.getCombineSetByCombinationNode(outNode);
 682           Set<HNode> incomingHNodeSetToOutNode = simpleHierarchyGraph.getIncomingNodeSet(outNode);
 683           // extract nodes belong to the same combine node
 684           Set<HNode> incomingCombinedHNodeSet = new HashSet<HNode>();
 685           for (Iterator iterator = incomingHNodeSetToOutNode.iterator(); iterator.hasNext();) {
 686             HNode inNode = (HNode) iterator.next();
 687             if (combineSkeletonNodeSet.contains(inNode)) {
 688               incomingCombinedHNodeSet.add(inNode);
 689             }
 690           }
 691           System.out.println("-----incomingCombinedHNodeSet=" + incomingCombinedHNodeSet);
 692
 693           // check whether the next combination node is different from the current node
 694           if (combinationNodeInSCGraph.equals(getCombinationNodeInSCGraph(desc, outNode))) {
 695             if (visited.containsAll(incomingCombinedHNodeSet)) {
 696               visited.add(outNode);
 697               System.out.println("-------curIdx=" + (idx + 1));
 698               int newIdx = getCurrentHighestIndex(outNode, idx + 1);
 699               System.out.println("-------newIdx=" + newIdx);
 700               recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited,
 701                   mapIntermediateLoc, newIdx, locSummary, outNode);
 702               // recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited,
 703               // mapIntermediateLoc, idx + 1, locSummary, outNode);
 704             } else {
 705               updateHighestIndex(outNode, idx + 1);
 706               System.out.println("-----NOT RECUR!");
 707             }
 708           } else {
 709             if (needToExpandCombinationNode(desc, outNode)) {
 710               System.out.println("NEED TO");
 711               expandCombinationNode(desc, lattice, visited, mapIntermediateLoc, locSummary, outNode);
 712             } else {
 713               System.out.println("NOT NEED TO");
 714             }
 715
 716           }
 717         }
 718       }
 719       // }
 720
 721     }
 722
 723   }
 724
 725   private int getCurrentHighestIndex(HNode node, int curIdx) {
 726     int recordedIdx = getCurrentHighestIndex(node);
 727     if (recordedIdx > curIdx) {
 728       return recordedIdx;
 729     } else {
 730       return curIdx;
 731     }
 732   }
 733
 734   private int getCurrentHighestIndex(HNode node) {
 735     if (!mapHNodeToHighestIndex.containsKey(node)) {
 736       mapHNodeToHighestIndex.put(node, new Integer(-1));
 737     }
 738     return mapHNodeToHighestIndex.get(node).intValue();
 739   }
 740
 741   private void updateHighestIndex(HNode node, int idx) {
 742     if (idx > getCurrentHighestIndex(node)) {
 743       mapHNodeToHighestIndex.put(node, new Integer(idx));
 744     }
 745   }
 746
 747   private String generateElementName(BasisSet basisSet, HierarchyGraph inputGraph,
 748       Map<Set<Integer>, String> mapF2LocName, Set<Integer> F) {
 749
 750     if (mapF2LocName.containsKey(F)) {
 751       return mapF2LocName.get(F);
 752     }
 753
 754     HNode node = basisSet.getHNode(F);
 755     if (node != null) {
 756       mapF2LocName.put(F, node.getName());
 757       return node.getName();
 758     } else {
 759       if (inputGraph.BASISTOPELEMENT.equals(F)) {
 760         return SSJavaAnalysis.BOTTOM;
 761       } else {
 762         String str = "LOC" + (LocationInference.locSeed++);
 763         mapF2LocName.put(F, str);
 764         return str;
 765       }
 766     }
 767   }
 768
 769   private void resetCount(Map<Set<Integer>, Integer> mapFtoCount, Family family) {
 770     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
 771       Set<Integer> F = iter.next();
 772       mapFtoCount.put(F, 0);
 773     }
 774   }
 775
 776   private Map<Set<Integer>, Set<Set<Integer>>> coveringGraph(BasisSet basisSet, Family family) {
 777
 778     Map<Set<Integer>, Integer> mapFtoCount = new HashMap<Set<Integer>, Integer>();
 779     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = new HashMap<Set<Integer>, Set<Set<Integer>>>();
 780
 781     // initialize COUNT(F) to 0 for all elements of the family
 782     resetCount(mapFtoCount, family);
 783
 784     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
 785       Set<Integer> F = iter.next();
 786       Set<HNode> gammaF = family.getGamma(F);
 787
 788       Set<HNode> curHNodeSet = basisSet.getHNodeSet();
 789       curHNodeSet.removeAll(gammaF);
 790       Set<Set<Integer>> Bset = basisSet.getBasisSetByHNodeSet(curHNodeSet);
 791
 792       for (Iterator iterator = Bset.iterator(); iterator.hasNext();) {
 793         Set<Integer> B = (Set<Integer>) iterator.next();
 794
 795         Set<Integer> Fprime = new HashSet<Integer>();
 796         Fprime.addAll(F);
 797         Fprime.addAll(B);
 798
 799         // COUNT(F')++;
 800         mapFtoCount.put(Fprime, mapFtoCount.get(Fprime) + 1);
 801
 802         // if |gamma(F')|==COUNT(F') + |gamma(F)|
 803         int numGammaFprime = family.getGamma(Fprime).size();
 804         int countFprime = mapFtoCount.get(Fprime);
 805         int numGammaF = family.getGamma(F).size();
 806         if (numGammaFprime == (countFprime + numGammaF)) {
 807           // ImSucc(F)=IMSucc(F) union F'
 808           addImSucc(mapImSucc, F, Fprime);
 809         }
 810
 811       }
 812       resetCount(mapFtoCount, family);
 813     }
 814
 815     // System.out.println("mapImSucc=" + mapImSucc);
 816
 817     return mapImSucc;
 818   }
 819
 820   private Set<Set<Integer>> getImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F) {
 821     if (!mapImSucc.containsKey(F)) {
 822       mapImSucc.put(F, new HashSet<Set<Integer>>());
 823     }
 824     return mapImSucc.get(F);
 825   }
 826
 827   private void addImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F,
 828       Set<Integer> Fprime) {
 829
 830     if (!mapImSucc.containsKey(F)) {
 831       mapImSucc.put(F, new HashSet<Set<Integer>>());
 832     }
 833
 834     mapImSucc.get(F).add(Fprime);
 835
 836   }
 837
 838   private Family generateFamily(BasisSet basisSet) {
 839
 840     Family family = new Family();
 841
 842     for (Iterator<Set<Integer>> iterator = basisSet.basisIterator(); iterator.hasNext();) {
 843       Set<Integer> B = iterator.next();
 844
 845       Set<Pair<Set<Integer>, Set<HNode>>> tobeadded = new HashSet<Pair<Set<Integer>, Set<HNode>>>();
 846
 847       for (Iterator<Set<Integer>> iterator2 = family.FIterator(); iterator2.hasNext();) {
 848         Set<Integer> F = iterator2.next();
 849
 850         Set<Integer> Fprime = new HashSet<Integer>();
 851         Fprime.addAll(F);
 852         Fprime.addAll(B);
 853
 854         Set<HNode> gammaFPrimeSet = new HashSet<HNode>();
 855         gammaFPrimeSet.addAll(family.getGamma(F));
 856         gammaFPrimeSet.add(basisSet.getHNode(B));
 857
 858         if (!family.containsF(Fprime)) {
 859           Pair<Set<Integer>, Set<HNode>> pair =
 860               new Pair<Set<Integer>, Set<HNode>>(Fprime, gammaFPrimeSet);
 861           tobeadded.add(pair);
 862         } else {
 863           family.updateGammaF(Fprime, gammaFPrimeSet);
 864         }
 865       }
 866
 867       for (Iterator<Pair<Set<Integer>, Set<HNode>>> iterator2 = tobeadded.iterator(); iterator2
 868           .hasNext();) {
 869         Pair<Set<Integer>, Set<HNode>> pair = iterator2.next();
 870         family.addFElement(pair.getFirst());
 871         family.updateGammaF(pair.getFirst(), pair.getSecond());
 872       }
 873
 874     }
 875     return family;
 876   }
 877
 878   private void debug_print(HierarchyGraph inputGraph) {
 879     System.out.println("\nBuild Lattice:" + inputGraph.getName());
 880     // System.out.println("Node2Index:\n" + inputGraph.getMapHNodeToUniqueIndex());
 881     // System.out.println("Node2Basis:\n" + inputGraph.getMapHNodeToBasis());
 882   }
 883
 884 }
 885
 886 class Identifier {
 887   public HNode node;
 888   public int idx;
 889
 890   public Identifier(HNode n, int i) {
 891     node = n;
 892     idx = i;
 893   }
 894
 895   public int hashCode() {
 896     return node.hashCode() + idx;
 897   }
 898
 899   public boolean equals(Object obj) {
 900
 901     if (obj instanceof Identifier) {
 902       Identifier in = (Identifier) obj;
 903       if (node.equals(in.node) && idx == in.idx) {
 904         return true;
 905       }
 906     }
 907
 908     return false;
 909   }
 910
 911 }
 912
 913 class TripleItem {
 914   public HNode higherNode;
 915   public Set<HNode> lowerNodeSet;
 916   public int idx;
 917   public boolean isShared;
 918
 919   public TripleItem(HNode h, Set<HNode> l, int i) {
 920     higherNode = h;
 921     lowerNodeSet = l;
 922     idx = i;
 923     isShared = false;
 924   }
 925
 926   public void setShared(boolean in) {
 927     this.isShared = in;
 928   }
 929
 930   public boolean isShared() {
 931     return isShared;
 932   }
 933
 934   public int hashCode() {
 935
 936     int h = 0;
 937     if (higherNode != null) {
 938       h = higherNode.hashCode();
 939     }
 940
 941     if (isShared) {
 942       h++;
 943     }
 944
 945     return h + lowerNodeSet.hashCode() + idx;
 946   }
 947
 948   public boolean equals(Object obj) {
 949
 950     if (obj instanceof TripleItem) {
 951       TripleItem in = (TripleItem) obj;
 952       if ((higherNode == null || (higherNode != null && higherNode.equals(in.higherNode)))
 953           && lowerNodeSet.equals(in.lowerNodeSet) && idx == in.idx && isShared == in.isShared()) {
 954         return true;
 955       }
 956     }
 957
 958     return false;
 959   }
 960
 961   public String toString() {
 962     String rtr = higherNode + "-" + idx + "->" + lowerNodeSet;
 963     if (isShared) {
 964       rtr += " S";
 965     }
 966     return rtr;
 967   }
 968 }