Robust/src/Analysis/SSJava/HierarchyGraph.java

   1 package Analysis.SSJava;
   2
   3 import java.io.BufferedWriter;
   4 import java.io.FileWriter;
   5 import java.io.IOException;
   6 import java.util.HashMap;
   7 import java.util.HashSet;
   8 import java.util.Iterator;
   9 import java.util.Map;
  10 import java.util.Set;
  11
  12 import IR.Descriptor;
  13 import IR.FieldDescriptor;
  14 import IR.VarDescriptor;
  15
  16 public class HierarchyGraph {
  17
  18   Descriptor desc;
  19
  20   String name;
  21
  22   // graph structure
  23   Map<HNode, Set<HNode>> mapHNodeToIncomingSet;
  24   Map<HNode, Set<HNode>> mapHNodeToOutgoingSet;
  25
  26   Map<Descriptor, HNode> mapDescToHNode;
  27   Map<HNode, Set<Descriptor>> mapHNodeToDescSet;
  28   Map<HNode, HNode> mapHNodeToCurrentHNode; // tracking which node corresponds to the initial node
  29   Map<HNode, Set<HNode>> mapMergeNodetoMergingSet;
  30
  31   // data structures for a combination node
  32   Map<Set<HNode>, HNode> mapSkeletonNodeSetToCombinationNode;
  33   Map<HNode, Set<HNode>> mapCombinationNodeToCombineNodeSet;
  34   Map<Set<HNode>, HNode> mapCombineNodeSetToCombinationNode;
  35   Map<Set<HNode>, Set<HNode>> mapCombineNodeSetToOutgoingNodeSet;
  36
  37   Set<HNode> nodeSet;
  38
  39   public static int seed = 0;
  40
  41   // for the lattice generation
  42   Map<HNode, Integer> mapHNodeToUniqueIndex;
  43   Map<HNode, Set<Integer>> mapHNodeToBasis;
  44   Set<Integer> BASISTOPELEMENT;
  45
  46   public HierarchyGraph() {
  47     mapHNodeToIncomingSet = new HashMap<HNode, Set<HNode>>();
  48     mapHNodeToOutgoingSet = new HashMap<HNode, Set<HNode>>();
  49     mapHNodeToDescSet = new HashMap<HNode, Set<Descriptor>>();
  50     mapDescToHNode = new HashMap<Descriptor, HNode>();
  51     mapSkeletonNodeSetToCombinationNode = new HashMap<Set<HNode>, HNode>();
  52     mapCombinationNodeToCombineNodeSet = new HashMap<HNode, Set<HNode>>();
  53     mapCombineNodeSetToOutgoingNodeSet = new HashMap<Set<HNode>, Set<HNode>>();
  54     mapCombineNodeSetToCombinationNode = new HashMap<Set<HNode>, HNode>();
  55     nodeSet = new HashSet<HNode>();
  56
  57     mapHNodeToUniqueIndex = new HashMap<HNode, Integer>();
  58     mapHNodeToBasis = new HashMap<HNode, Set<Integer>>();
  59
  60     mapMergeNodetoMergingSet = new HashMap<HNode, Set<HNode>>();
  61
  62     mapHNodeToCurrentHNode = new HashMap<HNode, HNode>();
  63
  64   }
  65
  66   public Descriptor getDesc() {
  67     return desc;
  68   }
  69
  70   public void setDesc(Descriptor desc) {
  71     this.desc = desc;
  72   }
  73
  74   public String getName() {
  75     return name;
  76   }
  77
  78   public void setName(String name) {
  79     this.name = name;
  80   }
  81
  82   public HierarchyGraph(Descriptor d) {
  83     this();
  84     desc = d;
  85     name = d.toString();
  86   }
  87
  88   public Map<HNode, Set<Descriptor>> getMapHNodeToDescSet() {
  89     return mapHNodeToDescSet;
  90   }
  91
  92   public void setMapHNodeToDescSet(Map<HNode, Set<Descriptor>> map) {
  93     mapHNodeToDescSet.putAll(map);
  94   }
  95
  96   public Map<HNode, HNode> getMapHNodeToCurrentHNode() {
  97     return mapHNodeToCurrentHNode;
  98   }
  99
 100   public void setMapHNodeToCurrentHNode(Map<HNode, HNode> mapHNodeToCurrentHNode) {
 101     this.mapHNodeToCurrentHNode = mapHNodeToCurrentHNode;
 102   }
 103
 104   public Map<Descriptor, HNode> getMapDescToHNode() {
 105     return mapDescToHNode;
 106   }
 107
 108   public void setMapDescToHNode(Map<Descriptor, HNode> map) {
 109     mapDescToHNode.putAll(map);
 110   }
 111
 112   public Set<HNode> getNodeSet() {
 113     return nodeSet;
 114   }
 115
 116   public void addEdge(HNode srcHNode, HNode dstHNode) {
 117
 118     if (!nodeSet.contains(srcHNode)) {
 119       nodeSet.add(srcHNode);
 120     }
 121
 122     if (!nodeSet.contains(dstHNode)) {
 123       nodeSet.add(dstHNode);
 124     }
 125
 126     Set<HNode> possibleCycleSet = getPossibleCycleNodes(srcHNode, dstHNode);
 127
 128     if (possibleCycleSet.size() > 0) {
 129
 130       if (possibleCycleSet.size() == 1) {
 131         if (dstHNode.isSharedNode()) {
 132           // it has already been assigned shared node.
 133         } else {
 134           dstHNode.setSharedNode(true);
 135         }
 136         return;
 137       }
 138
 139       HNode newMergeNode = mergeNodes(possibleCycleSet, false);
 140       newMergeNode.setSharedNode(true);
 141       System.out.println("### INTRODUCE A NEW MERGE NODE: " + newMergeNode);
 142       System.out.println("### CYCLIC VALUE FLOW: " + srcHNode + " -> " + dstHNode);
 143     } else {
 144       getIncomingNodeSet(dstHNode).add(srcHNode);
 145       getOutgoingNodeSet(srcHNode).add(dstHNode);
 146       System.out.println("add an edge " + srcHNode + " -> " + dstHNode);
 147     }
 148
 149   }
 150
 151   public void addNode(HNode node) {
 152     nodeSet.add(node);
 153   }
 154
 155   public void addEdge(Descriptor src, Descriptor dst) {
 156     HNode srcHNode = getHNode(src);
 157     HNode dstHNode = getHNode(dst);
 158
 159     addEdge(srcHNode, dstHNode);
 160
 161   }
 162
 163   public void setParamHNode(Descriptor d) {
 164     getHNode(d).setSkeleton(true);
 165   }
 166
 167   public HNode getHNode(Descriptor d) {
 168     if (!mapDescToHNode.containsKey(d)) {
 169       HNode newNode = new HNode(d);
 170       if (d instanceof FieldDescriptor) {
 171         newNode.setSkeleton(true);
 172       }
 173       mappingDescriptorToHNode(d, newNode);
 174       nodeSet.add(newNode);
 175     }
 176     return mapDescToHNode.get(d);
 177   }
 178
 179   public HNode getHNode(String name) {
 180     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 181       HNode node = (HNode) iterator.next();
 182       if (node.getName().equals(name)) {
 183         return node;
 184       }
 185     }
 186     return null;
 187   }
 188
 189   private void mappingDescriptorToHNode(Descriptor desc, HNode node) {
 190     mapDescToHNode.put(desc, node);
 191     if (!mapHNodeToDescSet.containsKey(node)) {
 192       mapHNodeToDescSet.put(node, new HashSet<Descriptor>());
 193     }
 194     mapHNodeToDescSet.get(node).add(desc);
 195   }
 196
 197   public HierarchyGraph generateSkeletonGraph() {
 198
 199     // compose a skeleton graph that only consists of fields or parameters
 200     HierarchyGraph skeletonGraph = new HierarchyGraph(desc);
 201     skeletonGraph.setName(desc + "_SKELETON");
 202
 203     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 204       HNode src = (HNode) iterator.next();
 205       if (src.isSkeleton()) {
 206         Set<HNode> reachSet = getDirectlyReachSkeletonSet(src);
 207         if (reachSet.size() > 0) {
 208           for (Iterator iterator2 = reachSet.iterator(); iterator2.hasNext();) {
 209             HNode dst = (HNode) iterator2.next();
 210             skeletonGraph.addEdge(src, dst);
 211           }
 212         } else {
 213           skeletonGraph.addNode(src);
 214         }
 215       }
 216     }
 217
 218     skeletonGraph.setMapDescToHNode(getMapDescToHNode());
 219     skeletonGraph.setMapHNodeToDescSet(getMapHNodeToDescSet());
 220     skeletonGraph.setMapHNodetoMergeSet(getMapHNodetoMergeSet());
 221     skeletonGraph.setMapHNodeToCurrentHNode(getMapHNodeToCurrentHNode());
 222
 223     return skeletonGraph;
 224
 225   }
 226
 227   private Set<HNode> getDirectlyReachSkeletonSet(HNode node) {
 228
 229     Set<HNode> visited = new HashSet<HNode>();
 230     Set<HNode> connected = new HashSet<HNode>();
 231     recurReachSkeletonSet(node, connected, visited);
 232
 233     return connected;
 234   }
 235
 236   public void removeRedundantEdges() {
 237
 238     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 239       HNode src = (HNode) iterator.next();
 240       Set<HNode> connectedSet = getOutgoingNodeSet(src);
 241       Set<HNode> toberemovedSet = new HashSet<HNode>();
 242       for (Iterator iterator2 = connectedSet.iterator(); iterator2.hasNext();) {
 243         HNode dst = (HNode) iterator2.next();
 244         Set<HNode> otherNeighborSet = new HashSet<HNode>();
 245         otherNeighborSet.addAll(connectedSet);
 246         otherNeighborSet.remove(dst);
 247         for (Iterator iterator3 = otherNeighborSet.iterator(); iterator3.hasNext();) {
 248           HNode neighbor = (HNode) iterator3.next();
 249           if (reachTo(neighbor, dst, new HashSet<HNode>())) {
 250             toberemovedSet.add(dst);
 251           }
 252         }
 253       }
 254       if (toberemovedSet.size() > 0) {
 255         connectedSet.removeAll(toberemovedSet);
 256
 257         for (Iterator iterator2 = toberemovedSet.iterator(); iterator2.hasNext();) {
 258           HNode node = (HNode) iterator2.next();
 259           getIncomingNodeSet(node).remove(src);
 260         }
 261
 262       }
 263     }
 264
 265   }
 266
 267   public void simplifyHierarchyGraph() {
 268     removeRedundantEdges();
 269     combineRedundantNodes(false);
 270   }
 271
 272   public void simplifySkeletonCombinationHierarchyGraph() {
 273     removeRedundantEdges();
 274     combineRedundantNodes(true);
 275   }
 276
 277   public void combineRedundantNodes(boolean onlyCombinationNodes) {
 278     // Combine field/parameter nodes who have the same set of incoming/outgoing edges.
 279     boolean isUpdated = false;
 280     do {
 281       isUpdated = combineTwoRedundatnNodes(onlyCombinationNodes);
 282     } while (isUpdated);
 283   }
 284
 285   public Set<HNode> getIncomingNodeSet(HNode node) {
 286     if (!mapHNodeToIncomingSet.containsKey(node)) {
 287       mapHNodeToIncomingSet.put(node, new HashSet<HNode>());
 288     }
 289     return mapHNodeToIncomingSet.get(node);
 290   }
 291
 292   public Set<HNode> getOutgoingNodeSet(HNode node) {
 293     if (!mapHNodeToOutgoingSet.containsKey(node)) {
 294       mapHNodeToOutgoingSet.put(node, new HashSet<HNode>());
 295     }
 296     return mapHNodeToOutgoingSet.get(node);
 297   }
 298
 299   private boolean combineTwoRedundatnNodes(boolean onlyCombinationNodes) {
 300     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 301       HNode node1 = (HNode) iterator.next();
 302
 303       if ((onlyCombinationNodes && (!node1.isCombinationNode()))
 304           || (!onlyCombinationNodes && (!node1.isSkeleton()))) {
 305         continue;
 306       }
 307
 308       Set<HNode> incomingNodeSet1 = getIncomingNodeSet(node1);
 309       Set<HNode> outgoingNodeSet1 = getOutgoingNodeSet(node1);
 310
 311       for (Iterator iterator2 = nodeSet.iterator(); iterator2.hasNext();) {
 312         HNode node2 = (HNode) iterator2.next();
 313
 314         if ((onlyCombinationNodes && (!node2.isCombinationNode()))
 315             || (!onlyCombinationNodes && (!node2.isSkeleton()))) {
 316           continue;
 317         }
 318
 319         if (!isEligibleForMerging(node1, node2)) {
 320           continue;
 321         }
 322
 323         if (!node1.equals(node2)) {
 324
 325           Set<HNode> incomingNodeSet2 = getIncomingNodeSet(node2);
 326           Set<HNode> outgoingNodeSet2 = getOutgoingNodeSet(node2);
 327
 328           if (incomingNodeSet1.equals(incomingNodeSet2)
 329               && outgoingNodeSet1.equals(outgoingNodeSet2)) {
 330             // need to merge node1 and node2
 331
 332             Set<HNode> mergeSet = new HashSet<HNode>();
 333             mergeSet.add(node1);
 334             mergeSet.add(node2);
 335             mergeNodes(mergeSet, onlyCombinationNodes);
 336             return true;
 337           }
 338
 339         }
 340       }
 341
 342     }
 343     return false;
 344   }
 345
 346   private boolean isEligibleForMerging(HNode node1, HNode node2) {
 347
 348     System.out.println("********isEligibleForMerging=" + node1 + " " + node2);
 349
 350     if (node1.isSharedNode() || node2.isSharedNode()) {
 351
 352       // if either of nodes is a shared node,
 353       // all descriptors of node1 & node2 should have a primitive type
 354
 355       Set<Descriptor> descSet = new HashSet<Descriptor>();
 356       descSet.addAll(getDescSetOfNode(node1));
 357       descSet.addAll(getDescSetOfNode(node2));
 358
 359       for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
 360         Descriptor desc = (Descriptor) iterator.next();
 361         if (!LocationInference.isPrimitive(desc)) {
 362           return false;
 363         }
 364       }
 365       System.out.println("******** true");
 366       return true;
 367     }
 368     return false;
 369   }
 370
 371   private void addEdgeWithNoCycleCheck(HNode srcHNode, HNode dstHNode) {
 372     getIncomingNodeSet(dstHNode).add(srcHNode);
 373     getOutgoingNodeSet(srcHNode).add(dstHNode);
 374     System.out.println("addEdgeWithNoCycleCheck src=" + srcHNode + " -> " + dstHNode);
 375   }
 376
 377   private HNode mergeNodes(Set<HNode> set, boolean onlyCombinationNodes) {
 378
 379     Set<HNode> incomingNodeSet = new HashSet<HNode>();
 380     Set<HNode> outgoingNodeSet = new HashSet<HNode>();
 381
 382     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
 383       HNode node = (HNode) iterator.next();
 384       incomingNodeSet.addAll(getIncomingNodeSet(node));
 385       outgoingNodeSet.addAll(getOutgoingNodeSet(node));
 386     }
 387
 388     String nodeName;
 389     boolean isMergeNode = false;
 390     if (onlyCombinationNodes) {
 391       nodeName = "Comb" + (seed++);
 392     } else {
 393       nodeName = "Node" + (seed++);
 394       isMergeNode = true;
 395     }
 396     HNode newMergeNode = new HNode(nodeName);
 397     newMergeNode.setMergeNode(isMergeNode);
 398
 399     nodeSet.add(newMergeNode);
 400     nodeSet.removeAll(set);
 401
 402     // if the input set contains a skeleton node, need to set a new merge node as skeleton also
 403     boolean hasSkeleton = false;
 404     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
 405       HNode inNode = (HNode) iterator.next();
 406       if (inNode.isSkeleton()) {
 407         hasSkeleton = true;
 408         break;
 409       }
 410     }
 411     System.out.println("--Set merging node=" + newMergeNode + " as a skeleton=" + set
 412         + " hasSkeleton=" + hasSkeleton);
 413     newMergeNode.setSkeleton(hasSkeleton);
 414
 415     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
 416       HNode node = (HNode) iterator.next();
 417       Set<Descriptor> descSetOfNode = getDescSetOfNode(node);
 418       for (Iterator iterator2 = descSetOfNode.iterator(); iterator2.hasNext();) {
 419         Descriptor desc = (Descriptor) iterator2.next();
 420         mappingDescriptorToHNode(desc, newMergeNode);
 421       }
 422     }
 423
 424     for (Iterator iterator = incomingNodeSet.iterator(); iterator.hasNext();) {
 425       HNode inNode = (HNode) iterator.next();
 426       Set<HNode> outSet = getOutgoingNodeSet(inNode);
 427       outSet.removeAll(set);
 428       if (!set.contains(inNode)) {
 429         addEdgeWithNoCycleCheck(inNode, newMergeNode);
 430       }
 431     }
 432
 433     for (Iterator iterator = outgoingNodeSet.iterator(); iterator.hasNext();) {
 434       HNode outNode = (HNode) iterator.next();
 435       Set<HNode> inSet = getIncomingNodeSet(outNode);
 436       inSet.removeAll(set);
 437       if (!set.contains(outNode)) {
 438         addEdgeWithNoCycleCheck(newMergeNode, outNode);
 439       }
 440     }
 441
 442     Set<HNode> mergedSkeletonNode = new HashSet<HNode>();
 443     for (Iterator<HNode> iter = set.iterator(); iter.hasNext();) {
 444       HNode merged = iter.next();
 445       if (merged.isSkeleton()) {
 446         mergedSkeletonNode.add(merged);
 447       }
 448     }
 449     mapMergeNodetoMergingSet.put(newMergeNode, mergedSkeletonNode);
 450     for (Iterator iterator = mergedSkeletonNode.iterator(); iterator.hasNext();) {
 451       HNode mergedNode = (HNode) iterator.next();
 452       addMapHNodeToCurrentHNode(mergedNode, newMergeNode);
 453     }
 454     System.out.println("\n###mergedSkeletonNode=" + mergedSkeletonNode);
 455     System.out.println("###MERGING NODE=" + set + " new node=" + newMergeNode);
 456
 457     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
 458       HNode hNode = (HNode) iterator.next();
 459       System.out.println("old=" + hNode + "----->newNode=" + getCurrentHNode(hNode));
 460     }
 461
 462     return newMergeNode;
 463   }
 464
 465   private void addMapHNodeToCurrentHNode(HNode curNode, HNode newNode) {
 466     if (curNode.isMergeNode()) {
 467       Set<HNode> mergingSet = getMergingSet(curNode);
 468       mergingSet.add(curNode);
 469       System.out.println("addMapHNodeToCurrentHNode curNode=" + curNode + " meringSet="
 470           + mergingSet);
 471       for (Iterator iterator = mergingSet.iterator(); iterator.hasNext();) {
 472         HNode mergingNode = (HNode) iterator.next();
 473         mapHNodeToCurrentHNode.put(mergingNode, newNode);
 474       }
 475     } else {
 476       mapHNodeToCurrentHNode.put(curNode, newNode);
 477     }
 478   }
 479
 480   public HNode getCurrentHNode(HNode node) {
 481     if (!mapHNodeToCurrentHNode.containsKey(node)) {
 482       mapHNodeToCurrentHNode.put(node, node);
 483     }
 484     return mapHNodeToCurrentHNode.get(node);
 485   }
 486
 487   private Set<HNode> getMergingSet(HNode mergeNode) {
 488     Set<HNode> mergingSet = new HashSet<HNode>();
 489     Set<HNode> mergedNode = mapMergeNodetoMergingSet.get(mergeNode);
 490     for (Iterator iterator = mergedNode.iterator(); iterator.hasNext();) {
 491       HNode node = (HNode) iterator.next();
 492       if (node.isMergeNode()) {
 493         mergingSet.add(node);
 494         mergingSet.addAll(getMergingSet(node));
 495       } else {
 496         mergingSet.add(node);
 497       }
 498     }
 499     return mergingSet;
 500   }
 501
 502   public Set<Descriptor> getDescSetOfNode(HNode node) {
 503     if (!mapHNodeToDescSet.containsKey(node)) {
 504       mapHNodeToDescSet.put(node, new HashSet<Descriptor>());
 505     }
 506     return mapHNodeToDescSet.get(node);
 507   }
 508
 509   private boolean reachTo(HNode src, HNode dst, Set<HNode> visited) {
 510     Set<HNode> connectedSet = getOutgoingNodeSet(src);
 511     for (Iterator<HNode> iterator = connectedSet.iterator(); iterator.hasNext();) {
 512       HNode n = iterator.next();
 513       if (n.equals(dst)) {
 514         return true;
 515       }
 516       if (!visited.contains(n)) {
 517         visited.add(n);
 518         if (reachTo(n, dst, visited)) {
 519           return true;
 520         }
 521       }
 522     }
 523     return false;
 524   }
 525
 526   private void recurReachSkeletonSet(HNode node, Set<HNode> connected, Set<HNode> visited) {
 527
 528     Set<HNode> outSet = getOutgoingNodeSet(node);
 529     for (Iterator iterator = outSet.iterator(); iterator.hasNext();) {
 530       HNode outNode = (HNode) iterator.next();
 531
 532       if (outNode.isSkeleton()) {
 533         connected.add(outNode);
 534       } else if (!visited.contains(outNode)) {
 535         visited.add(outNode);
 536         recurReachSkeletonSet(outNode, connected, visited);
 537       }
 538     }
 539
 540   }
 541
 542   public Set<HNode> getDirectlyReachableSkeletonCombinationNodeFrom(HNode node,
 543       Set<HNode> combinationNodeSet) {
 544     Set<HNode> reachable = new HashSet<HNode>();
 545     Set<HNode> visited = new HashSet<HNode>();
 546     visited.add(node);
 547     recurDirectlyReachableSkeletonCombinationNodeFrom(node, visited, reachable, combinationNodeSet);
 548     return reachable;
 549   }
 550
 551   public void recurDirectlyReachableSkeletonCombinationNodeFrom(HNode node, Set<HNode> visited,
 552       Set<HNode> reachable, Set<HNode> combinationNodeSet) {
 553
 554     Set<HNode> outSet = getOutgoingNodeSet(node);
 555     for (Iterator iterator = outSet.iterator(); iterator.hasNext();) {
 556       HNode out = (HNode) iterator.next();
 557
 558       if (!visited.contains(out)) {
 559         visited.add(out);
 560         if (out.isSkeleton()) {
 561           reachable.add(out);
 562         } else if (out.isCombinationNode()) {
 563           if (combinationNodeSet == null) {
 564             reachable.add(out);
 565           } else if (!combinationNodeSet.contains(out)) {
 566             reachable.add(out);
 567           } else {
 568             recurDirectlyReachableSkeletonCombinationNodeFrom(out, visited, reachable,
 569                 combinationNodeSet);
 570           }
 571         } else {
 572           recurDirectlyReachableSkeletonCombinationNodeFrom(out, visited, reachable,
 573               combinationNodeSet);
 574         }
 575
 576       }
 577
 578     }
 579
 580   }
 581
 582   public HNode getDirectlyReachableSkeletonCombinationNodeFrom(HNode node) {
 583     Set<HNode> visited = new HashSet<HNode>();
 584     return recurDirectlyReachableSkeletonCombinationNodeFrom(node, visited);
 585   }
 586
 587   public HNode recurDirectlyReachableSkeletonCombinationNodeFrom(HNode node, Set<HNode> visited) {
 588
 589     Set<HNode> outSet = getOutgoingNodeSet(node);
 590     for (Iterator iterator = outSet.iterator(); iterator.hasNext();) {
 591       HNode out = (HNode) iterator.next();
 592       // if (!visited.contains(out)) {
 593       if (out.isCombinationNode() || out.isSkeleton()) {
 594         return out;
 595       } else {
 596         // visited.add(out);
 597         return getDirectlyReachableSkeletonCombinationNodeFrom(out);
 598       }
 599     }
 600     // }
 601
 602     return null;
 603   }
 604
 605   public Set<HNode> getPossibleCycleNodes(HNode src, HNode dst) {
 606     // if an edge from src to dst introduces a new cycle flow,
 607     // the method returns the set of elements consisting of the cycle
 608     Set<HNode> cycleNodeSet = new HashSet<HNode>();
 609     // if the dst node reaches to the src node, the new relation
 610     // introduces a cycle to the lattice
 611     if (dst.equals(src)) {
 612       cycleNodeSet.add(dst);
 613       cycleNodeSet.add(src);
 614     } else if (reachTo(dst, src)) {
 615       cycleNodeSet.add(dst);
 616       cycleNodeSet.add(src);
 617       getInBetweenElements(dst, src, cycleNodeSet);
 618     }
 619     return cycleNodeSet;
 620   }
 621
 622   private void getInBetweenElements(HNode start, HNode end, Set<HNode> nodeSet) {
 623     Set<HNode> connectedSet = getOutgoingNodeSet(start);
 624     for (Iterator iterator = connectedSet.iterator(); iterator.hasNext();) {
 625       HNode cur = (HNode) iterator.next();
 626       if ((!start.equals(cur)) && (!cur.equals(end)) && reachTo(cur, end)) {
 627         nodeSet.add(cur);
 628         getInBetweenElements(cur, end, nodeSet);
 629       }
 630     }
 631   }
 632
 633   public boolean reachTo(HNode node1, HNode node2) {
 634     return reachTo(node1, node2, new HashSet<HNode>());
 635   }
 636
 637   public Set<HNode> getCombineSetByCombinationNode(HNode node) {
 638     if (!mapCombinationNodeToCombineNodeSet.containsKey(node)) {
 639       mapCombinationNodeToCombineNodeSet.put(node, new HashSet<HNode>());
 640     }
 641     return mapCombinationNodeToCombineNodeSet.get(node);
 642   }
 643
 644   public HNode getCombinationNode(Set<HNode> combineSet) {
 645     if (!mapCombineNodeSetToCombinationNode.containsKey(combineSet)) {
 646       String name = "COMB" + (seed++);
 647       HNode node = new HNode(name);
 648       node.setCombinationNode(true);
 649       nodeSet.add(node);
 650       mapCombineNodeSetToCombinationNode.put(combineSet, node);
 651       mapCombinationNodeToCombineNodeSet.put(node, combineSet);
 652     }
 653
 654     return mapCombineNodeSetToCombinationNode.get(combineSet);
 655   }
 656
 657   public Map<Set<HNode>, HNode> getMapCombineNodeSetToCombinationNode() {
 658     return mapCombineNodeSetToCombinationNode;
 659   }
 660
 661   public Set<Set<HNode>> getCombineNodeSet() {
 662     return mapCombineNodeSetToOutgoingNodeSet.keySet();
 663   }
 664
 665   public void insertCombinationNodesToGraph(HierarchyGraph simpleHierarchyGraph) {
 666     // add a new combination node where parameter/field flows are actually combined.
 667
 668     simpleHierarchyGraph.identifyCombinationNodes();
 669
 670     Set<Set<HNode>> keySet = simpleHierarchyGraph.getCombineNodeSet();
 671     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 672       Set<HNode> combineSet = (Set<HNode>) iterator.next();
 673       System.out.println("--combineSet=" + combineSet);
 674       HNode combinationNode = getCombinationNode(combineSet);
 675       System.out.println("--combinationNode=" + combinationNode);
 676       // add an edge from a skeleton node to a combination node
 677       for (Iterator iterator2 = combineSet.iterator(); iterator2.hasNext();) {
 678         HNode inSkeletonNode = (HNode) iterator2.next();
 679         // System.out.println("--inSkeletonNode=" + inSkeletonNode + "  desc="
 680         // + inSkeletonNode.getDescriptor());
 681         HNode srcNode;
 682         if (inSkeletonNode.getDescriptor() == null) {
 683           // the node is merging one...
 684           srcNode = inSkeletonNode;
 685         } else {
 686           srcNode = getHNode(inSkeletonNode.getDescriptor());
 687         }
 688         // System.out.println("--srcNode=" + srcNode);
 689         addEdgeWithNoCycleCheck(srcNode, combinationNode);
 690       }
 691
 692       // add an edge from the combination node to outgoing nodes
 693       Set<HNode> outSet = simpleHierarchyGraph.getOutgoingNodeSetByCombineSet(combineSet);
 694       for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
 695         HNode curNode = (HNode) iterator2.next();
 696         if (curNode.isCombinationNode()) {
 697           Set<HNode> combineNode = simpleHierarchyGraph.getCombineSetByCombinationNode(curNode);
 698           HNode outNode = getCombinationNode(combineNode);
 699           addEdgeWithNoCycleCheck(combinationNode, outNode);
 700         } else if (curNode.isSkeleton()) {
 701           // HNode dstNode2 = getHNode(curNode.getDescriptor());
 702           HNode dstNode = getCurrentHNode(curNode);
 703           // System.out.println("-----curNode=" + curNode + "------->" + dstNode + "    dstNode2="
 704           // + dstNode2);
 705           addEdgeWithNoCycleCheck(combinationNode, dstNode);
 706         }
 707       }
 708
 709       System.out.println("--");
 710
 711     }
 712
 713   }
 714
 715   private void addCombinationNode(HNode curNode, Set<HNode> reachToSet, Set<HNode> reachableSet) {
 716     if (!mapSkeletonNodeSetToCombinationNode.containsKey(reachToSet)) {
 717       // need to create a new combination node
 718       String nodeName = "Comb" + (seed++);
 719       HNode newCombinationNode = new HNode(nodeName);
 720       newCombinationNode.setCombinationNode(true);
 721
 722       nodeSet.add(newCombinationNode);
 723       mapSkeletonNodeSetToCombinationNode.put(reachToSet, newCombinationNode);
 724
 725       for (Iterator iterator = reachToSet.iterator(); iterator.hasNext();) {
 726         HNode reachToNode = (HNode) iterator.next();
 727         addEdge(reachToNode, newCombinationNode);
 728       }
 729
 730     }
 731
 732     HNode combinationNode = mapSkeletonNodeSetToCombinationNode.get(reachToSet);
 733     for (Iterator iterator = reachableSet.iterator(); iterator.hasNext();) {
 734       HNode reachableNode = (HNode) iterator.next();
 735       addEdge(combinationNode, reachableNode);
 736     }
 737
 738   }
 739
 740   private Set<HNode> getSkeleteNodeSetReachTo(HNode node) {
 741
 742     Set<HNode> reachToSet = new HashSet<HNode>();
 743     Set<HNode> visited = new HashSet<HNode>();
 744     recurSkeletonReachTo(node, reachToSet, visited);
 745
 746     // if a node reaches to one of elements in the reachToSet, we do not need to keep it
 747     // because the node is not directly connected to the combination node
 748
 749     removeRedundantReachToNodes(reachToSet);
 750
 751     return reachToSet;
 752   }
 753
 754   private void removeRedundantReachToNodes(Set<HNode> reachToSet) {
 755
 756     Set<HNode> toberemoved = new HashSet<HNode>();
 757     for (Iterator iterator = reachToSet.iterator(); iterator.hasNext();) {
 758       HNode cur = (HNode) iterator.next();
 759
 760       for (Iterator iterator2 = reachToSet.iterator(); iterator2.hasNext();) {
 761         HNode dst = (HNode) iterator2.next();
 762         if (!cur.equals(dst) && reachTo(cur, dst)) {
 763           // it is redundant
 764           toberemoved.add(cur);
 765         }
 766       }
 767     }
 768     reachToSet.removeAll(toberemoved);
 769   }
 770
 771   private void recurSkeletonReachTo(HNode node, Set<HNode> reachToSet, Set<HNode> visited) {
 772
 773     Set<HNode> inSet = getIncomingNodeSet(node);
 774     for (Iterator iterator = inSet.iterator(); iterator.hasNext();) {
 775       HNode inNode = (HNode) iterator.next();
 776
 777       if (inNode.isSkeleton()) {
 778         reachToSet.add(inNode);
 779       } else if (!visited.contains(inNode)) {
 780         visited.add(inNode);
 781         recurSkeletonReachTo(inNode, reachToSet, visited);
 782       }
 783     }
 784
 785   }
 786
 787   public Map<HNode, Set<HNode>> getMapHNodeToOutgoingSet() {
 788     return mapHNodeToOutgoingSet;
 789   }
 790
 791   public Map<HNode, Set<HNode>> getMapHNodeToIncomingSet() {
 792     return mapHNodeToIncomingSet;
 793   }
 794
 795   public void setMapHNodeToOutgoingSet(Map<HNode, Set<HNode>> in) {
 796     mapHNodeToOutgoingSet.clear();
 797     Set<HNode> keySet = in.keySet();
 798     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 799       HNode key = (HNode) iterator.next();
 800       Set<HNode> inSet = in.get(key);
 801       Set<HNode> newSet = new HashSet<HNode>();
 802       newSet.addAll(inSet);
 803       mapHNodeToOutgoingSet.put(key, newSet);
 804     }
 805   }
 806
 807   public void setMapHNodeToIncomingSet(Map<HNode, Set<HNode>> in) {
 808     mapHNodeToIncomingSet.clear();
 809     Set<HNode> keySet = in.keySet();
 810     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 811       HNode key = (HNode) iterator.next();
 812       Set<HNode> inSet = in.get(key);
 813       Set<HNode> newSet = new HashSet<HNode>();
 814       newSet.addAll(inSet);
 815       mapHNodeToIncomingSet.put(key, newSet);
 816     }
 817   }
 818
 819   public void setNodeSet(Set<HNode> inSet) {
 820     nodeSet.clear();
 821     nodeSet.addAll(inSet);
 822   }
 823
 824   public HierarchyGraph clone() {
 825     HierarchyGraph clone = new HierarchyGraph();
 826     clone.setDesc(getDesc());
 827     clone.setName(getName());
 828     clone.setNodeSet(getNodeSet());
 829     clone.setMapHNodeToIncomingSet(getMapHNodeToIncomingSet());
 830     clone.setMapHNodeToOutgoingSet(getMapHNodeToOutgoingSet());
 831     clone.setMapDescToHNode(getMapDescToHNode());
 832     clone.setMapHNodeToDescSet(getMapHNodeToDescSet());
 833     clone.setMapHNodetoMergeSet(getMapHNodetoMergeSet());
 834     clone.setMapHNodeToCurrentHNode(getMapHNodeToCurrentHNode());
 835     return clone;
 836   }
 837
 838   public Map<HNode, Set<HNode>> getMapHNodetoMergeSet() {
 839     return mapMergeNodetoMergingSet;
 840   }
 841
 842   public void setMapHNodetoMergeSet(Map<HNode, Set<HNode>> mapHNodetoMergeSet) {
 843     this.mapMergeNodetoMergingSet = mapHNodetoMergeSet;
 844   }
 845
 846   public Set<HNode> getOutgoingNodeSetByCombineSet(Set<HNode> combineSet) {
 847
 848     if (!mapCombineNodeSetToOutgoingNodeSet.containsKey(combineSet)) {
 849       mapCombineNodeSetToOutgoingNodeSet.put(combineSet, new HashSet<HNode>());
 850     }
 851     return mapCombineNodeSetToOutgoingNodeSet.get(combineSet);
 852   }
 853
 854   public void identifyCombinationNodes() {
 855
 856     // 1) set combination node flag if a node combines more than one skeleton node.
 857     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 858       HNode node = (HNode) iterator.next();
 859       if (!node.isSkeleton()) {
 860         Set<HNode> reachToSet = getSkeleteNodeSetReachTo(node);
 861         if (reachToSet.size() > 1) {
 862           // if (countSkeletonNodes(reachToSet) > 1) {
 863           System.out.println("-node=" + node + "  reachToSet=" + reachToSet);
 864           System.out.println("-set combinationnode=" + node);
 865           node.setCombinationNode(true);
 866           mapCombinationNodeToCombineNodeSet.put(node, reachToSet);
 867         }
 868       }
 869     }
 870
 871     // 2) compute the outgoing set that needs to be directly connected from the combination node
 872     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 873       HNode node = (HNode) iterator.next();
 874       if (node.isCombinationNode()) {
 875         Set<HNode> combineSet = mapCombinationNodeToCombineNodeSet.get(node);
 876         Set<HNode> outSet = getDirectlyReachableNodeSetFromCombinationNode(node);
 877         addMapCombineSetToOutgoingSet(combineSet, outSet);
 878       }
 879     }
 880
 881   }
 882
 883   public Map<HNode, Set<HNode>> getMapCombinationNodeToCombineNodeSet() {
 884     return mapCombinationNodeToCombineNodeSet;
 885   }
 886
 887   public int countSkeletonNodes(Set<HNode> set) {
 888     int count = 0;
 889
 890     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
 891       HNode node = (HNode) iterator.next();
 892       Set<Descriptor> descSet = getDescSetOfNode(node);
 893       count += descSet.size();
 894     }
 895
 896     return count;
 897   }
 898
 899   private void addMapCombineSetToOutgoingSet(Set<HNode> combineSet, Set<HNode> outSet) {
 900     if (!mapCombineNodeSetToOutgoingNodeSet.containsKey(combineSet)) {
 901       mapCombineNodeSetToOutgoingNodeSet.put(combineSet, new HashSet<HNode>());
 902     }
 903     mapCombineNodeSetToOutgoingNodeSet.get(combineSet).addAll(outSet);
 904   }
 905
 906   private Set<HNode> getDirectlyReachableNodeSetFromCombinationNode(HNode node) {
 907     // the method returns the set of nodes that are reachable from the current node
 908     // and do not combine the same set of skeleton nodes...
 909
 910     Set<HNode> visited = new HashSet<HNode>();
 911     Set<HNode> reachableSet = new HashSet<HNode>();
 912     Set<HNode> combineSet = mapCombinationNodeToCombineNodeSet.get(node);
 913
 914     recurDirectlyReachableNodeSetFromCombinationNode(node, combineSet, reachableSet, visited);
 915
 916     return reachableSet;
 917   }
 918
 919   private void recurDirectlyReachableNodeSetFromCombinationNode(HNode node, Set<HNode> combineSet,
 920       Set<HNode> reachableSet, Set<HNode> visited) {
 921
 922     Set<HNode> outSet = getOutgoingNodeSet(node);
 923     for (Iterator iterator = outSet.iterator(); iterator.hasNext();) {
 924       HNode outNode = (HNode) iterator.next();
 925
 926       if (outNode.isCombinationNode()) {
 927         Set<HNode> combineSetOfOutNode = mapCombinationNodeToCombineNodeSet.get(outNode);
 928         if (combineSetOfOutNode.equals(combineSet)) {
 929           recurDirectlyReachableNodeSetFromCombinationNode(outNode, combineSet, reachableSet,
 930               visited);
 931         } else {
 932           reachableSet.add(outNode);
 933         }
 934       } else if (outNode.isSkeleton()) {
 935         reachableSet.add(outNode);
 936       }
 937
 938     }
 939
 940   }
 941
 942   private Set<HNode> getReachableNodeSetFrom(HNode node) {
 943
 944     Set<HNode> reachableSet = new HashSet<HNode>();
 945     Set<HNode> visited = new HashSet<HNode>();
 946
 947     recurReachableNodeSetFrom(node, reachableSet, visited);
 948
 949     return reachableSet;
 950   }
 951
 952   private void recurReachableNodeSetFrom(HNode node, Set<HNode> reachableSet, Set<HNode> visited) {
 953
 954     Set<HNode> outgoingNodeSet = getOutgoingNodeSet(node);
 955     for (Iterator iterator = outgoingNodeSet.iterator(); iterator.hasNext();) {
 956       HNode outNode = (HNode) iterator.next();
 957       reachableSet.add(outNode);
 958       if (!visited.contains(outNode)) {
 959         visited.add(outNode);
 960         recurReachableNodeSetFrom(outNode, reachableSet, visited);
 961       }
 962     }
 963
 964   }
 965
 966   public void assignUniqueIndexToNode() {
 967     int idx = 1;
 968     System.out.println("nodeSet=" + nodeSet);
 969     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 970       HNode node = (HNode) iterator.next();
 971       mapHNodeToUniqueIndex.put(node, idx);
 972       idx++;
 973     }
 974
 975     BASISTOPELEMENT = new HashSet<Integer>();
 976     for (int i = 1; i < idx + 1; i++) {
 977       BASISTOPELEMENT.add(i);
 978     }
 979   }
 980
 981   public BasisSet computeBasisSet(Set<HNode> notGenerateSet) {
 982
 983     // assign a unique index to a node
 984     assignUniqueIndexToNode();
 985
 986     // compute basis for each node
 987     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 988       HNode node = (HNode) iterator.next();
 989
 990       if (notGenerateSet.contains(node)) {
 991         System.out.println("%%%SKIP =" + node);
 992         continue;
 993       }
 994       Set<Integer> basis = new HashSet<Integer>();
 995       basis.addAll(BASISTOPELEMENT);
 996
 997       Set<HNode> reachableNodeSet = getReachableNodeSetFrom(node);
 998       System.out.println("node=" + node + "    reachableNodeSet=" + reachableNodeSet);
 999       System.out.println("mapHNodeToUniqueIndex.get(node)=" + mapHNodeToUniqueIndex.get(node));
1000       // if a node is reachable from the current node
1001       // need to remove the index of the reachable node from the basis
1002
1003       basis.remove(getHNodeIndex(node));
1004       for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
1005         HNode reachableNode = (HNode) iterator2.next();
1006         System.out.println("reachableNode=" + reachableNode);
1007         System.out.println("getHNodeIndex(reachableNode))="
1008             + mapHNodeToUniqueIndex.get(reachableNode));
1009         int idx = getHNodeIndex(reachableNode);
1010         basis.remove(idx);
1011       }
1012
1013       mapHNodeToBasis.put(node, basis);
1014     }
1015
1016     // construct the basis set
1017
1018     BasisSet basisSet = new BasisSet();
1019
1020     Set<HNode> keySet = mapHNodeToBasis.keySet();
1021     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
1022       HNode node = (HNode) iterator.next();
1023       Set<Integer> basis = mapHNodeToBasis.get(node);
1024       basisSet.addElement(basis, node);
1025     }
1026
1027     return basisSet;
1028
1029   }
1030
1031   public int getHNodeIndex(HNode node) {
1032     return mapHNodeToUniqueIndex.get(node).intValue();
1033   }
1034
1035   public Map<HNode, Integer> getMapHNodeToUniqueIndex() {
1036     return mapHNodeToUniqueIndex;
1037   }
1038
1039   public Map<HNode, Set<Integer>> getMapHNodeToBasis() {
1040     return mapHNodeToBasis;
1041   }
1042
1043   public Set<HNode> getCombinationNodeSetByCombineNodeSet(Set<HNode> combineSkeletonNodeSet) {
1044
1045     Set<HNode> combinationNodeSet = new HashSet<HNode>();
1046     Set<HNode> keySet = mapCombinationNodeToCombineNodeSet.keySet();
1047     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
1048       HNode key = (HNode) iterator.next();
1049
1050       if (mapCombinationNodeToCombineNodeSet.get(key).equals(combineSkeletonNodeSet)) {
1051         combinationNodeSet.add(key);
1052       }
1053     }
1054
1055     return combinationNodeSet;
1056   }
1057
1058   public void writeGraph() {
1059
1060     String graphName = "hierarchy" + name;
1061     graphName = graphName.replaceAll("[\\W]", "");
1062
1063     try {
1064       BufferedWriter bw = new BufferedWriter(new FileWriter(graphName + ".dot"));
1065
1066       bw.write("digraph " + graphName + " {\n");
1067
1068       Iterator<HNode> iter = nodeSet.iterator();
1069
1070       Set<HNode> addedNodeSet = new HashSet<HNode>();
1071
1072       while (iter.hasNext()) {
1073         HNode u = iter.next();
1074
1075         Set<HNode> outSet = getOutgoingNodeSet(u);
1076
1077         if (outSet.size() == 0) {
1078           if (!addedNodeSet.contains(u)) {
1079             drawNode(bw, u);
1080             addedNodeSet.add(u);
1081           }
1082         } else {
1083           for (Iterator iterator = outSet.iterator(); iterator.hasNext();) {
1084             HNode v = (HNode) iterator.next();
1085             if (!addedNodeSet.contains(u)) {
1086               drawNode(bw, u);
1087               addedNodeSet.add(u);
1088             }
1089             if (!addedNodeSet.contains(v)) {
1090               drawNode(bw, v);
1091               addedNodeSet.add(v);
1092             }
1093             bw.write("" + u.getName() + " -> " + v.getName() + ";\n");
1094           }
1095         }
1096
1097       }
1098
1099       bw.write("}\n");
1100       bw.close();
1101
1102     } catch (IOException e) {
1103       e.printStackTrace();
1104     }
1105   }
1106
1107   public boolean contains(HNode node) {
1108     return nodeSet.contains(node);
1109   }
1110
1111   public boolean isDirectlyConnectedTo(HNode src, HNode dst) {
1112     return getOutgoingNodeSet(src).contains(dst);
1113   }
1114
1115   private String convertMergeSetToString(Set<HNode> mergeSet) {
1116     String str = "";
1117     for (Iterator iterator = mergeSet.iterator(); iterator.hasNext();) {
1118       HNode merged = (HNode) iterator.next();
1119       if (merged.isMergeNode()) {
1120         str += " " + convertMergeSetToString(mapMergeNodetoMergingSet.get(merged));
1121       } else {
1122         str += " " + merged.getName();
1123       }
1124     }
1125     return str;
1126   }
1127
1128   private void drawNode(BufferedWriter bw, HNode node) throws IOException {
1129     String nodeName;
1130     if (node.isMergeNode()) {
1131       nodeName = node.getNamePropertyString();
1132       Set<HNode> mergeSet = mapMergeNodetoMergingSet.get(node);
1133       nodeName += ":" + convertMergeSetToString(mergeSet);
1134     } else {
1135       nodeName = node.getNamePropertyString();
1136     }
1137     bw.write(node.getName() + " [label=\"" + nodeName + "\"]" + ";\n");
1138   }
1139
1140   public int countHopFromTopLocation(HNode node) {
1141
1142     Set<HNode> inNodeSet = getIncomingNodeSet(node);
1143     int count = 0;
1144     if (inNodeSet.size() > 0) {
1145       count = recurCountHopFromTopLocation(inNodeSet, 1);
1146     }
1147
1148     return count;
1149   }
1150
1151   private int recurCountHopFromTopLocation(Set<HNode> nodeSet, int curCount) {
1152
1153     int max = curCount;
1154     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
1155       HNode node = (HNode) iterator.next();
1156       Set<HNode> inNodeSet = getIncomingNodeSet(node);
1157       if (inNodeSet.size() > 0) {
1158         int recurCount = recurCountHopFromTopLocation(inNodeSet, curCount + 1);
1159         if (max < recurCount) {
1160           max = recurCount;
1161         }
1162       }
1163     }
1164     return max;
1165   }
1166
1167 }