Robust/src/Analysis/SSJava/LocationInference.java

   1 package Analysis.SSJava;
   2
   3 import java.io.BufferedReader;
   4 import java.io.BufferedWriter;
   5 import java.io.FileReader;
   6 import java.io.FileWriter;
   7 import java.io.IOException;
   8 import java.util.ArrayList;
   9 import java.util.Collections;
  10 import java.util.Comparator;
  11 import java.util.HashMap;
  12 import java.util.HashSet;
  13 import java.util.Iterator;
  14 import java.util.LinkedList;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.Stack;
  19 import java.util.Vector;
  20
  21 import IR.ClassDescriptor;
  22 import IR.Descriptor;
  23 import IR.FieldDescriptor;
  24 import IR.MethodDescriptor;
  25 import IR.NameDescriptor;
  26 import IR.Operation;
  27 import IR.State;
  28 import IR.SymbolTable;
  29 import IR.TypeDescriptor;
  30 import IR.TypeUtil;
  31 import IR.VarDescriptor;
  32 import IR.Tree.ArrayAccessNode;
  33 import IR.Tree.AssignmentNode;
  34 import IR.Tree.BlockExpressionNode;
  35 import IR.Tree.BlockNode;
  36 import IR.Tree.BlockStatementNode;
  37 import IR.Tree.CastNode;
  38 import IR.Tree.CreateObjectNode;
  39 import IR.Tree.DeclarationNode;
  40 import IR.Tree.ExpressionNode;
  41 import IR.Tree.FieldAccessNode;
  42 import IR.Tree.IfStatementNode;
  43 import IR.Tree.Kind;
  44 import IR.Tree.LiteralNode;
  45 import IR.Tree.LoopNode;
  46 import IR.Tree.MethodInvokeNode;
  47 import IR.Tree.NameNode;
  48 import IR.Tree.OpNode;
  49 import IR.Tree.ReturnNode;
  50 import IR.Tree.SubBlockNode;
  51 import IR.Tree.SwitchBlockNode;
  52 import IR.Tree.SwitchStatementNode;
  53 import IR.Tree.TertiaryNode;
  54 import IR.Tree.TreeNode;
  55 import Util.Pair;
  56
  57 public class LocationInference {
  58
  59   static int COUNT = 0;
  60
  61   State state;
  62   SSJavaAnalysis ssjava;
  63   TypeUtil tu;
  64
  65   List<ClassDescriptor> temp_toanalyzeList;
  66   List<MethodDescriptor> temp_toanalyzeMethodList;
  67   Map<MethodDescriptor, FlowGraph> mapMethodDescriptorToFlowGraph;
  68
  69   LinkedList<MethodDescriptor> toanalyze_methodDescList;
  70   Set<ClassDescriptor> toanalyze_classDescSet;
  71
  72   // InheritanceTree<ClassDescriptor> inheritanceTree;
  73
  74   // map a method descriptor to its set of parameter descriptors
  75   Map<MethodDescriptor, Set<Descriptor>> mapMethodDescriptorToParamDescSet;
  76
  77   // keep current descriptors to visit in fixed-point interprocedural analysis,
  78   private Stack<MethodDescriptor> methodDescriptorsToVisitStack;
  79
  80   // map a descriptor to a naive lattice
  81   private Map<Descriptor, SSJavaLattice<String>> desc2naiveLattice;
  82
  83   // map a class descriptor to a field lattice
  84   private Map<ClassDescriptor, SSJavaLattice<String>> cd2lattice;
  85
  86   // map a method descriptor to a method lattice
  87   private Map<MethodDescriptor, SSJavaLattice<String>> md2lattice;
  88
  89   // map a method/class descriptor to a hierarchy graph
  90   private Map<Descriptor, HierarchyGraph> mapDescriptorToHierarchyGraph;
  91
  92   // map a method/class descriptor to a skeleton hierarchy graph
  93   private Map<Descriptor, HierarchyGraph> mapDescriptorToSkeletonHierarchyGraph;
  94
  95   private Map<Descriptor, HierarchyGraph> mapDescriptorToSimpleHierarchyGraph;
  96
  97   // map a method/class descriptor to a skeleton hierarchy graph with combination nodes
  98   private Map<Descriptor, HierarchyGraph> mapDescriptorToCombineSkeletonHierarchyGraph;
  99
 100   // map a descriptor to a simple lattice
 101   private Map<Descriptor, SSJavaLattice<String>> mapDescriptorToSimpleLattice;
 102
 103   // map a method descriptor to the set of method invocation nodes which are
 104   // invoked by the method descriptor
 105   private Map<MethodDescriptor, Set<MethodInvokeNode>> mapMethodDescriptorToMethodInvokeNodeSet;
 106
 107   private Map<MethodInvokeNode, Map<Integer, NTuple<Descriptor>>> mapMethodInvokeNodeToArgIdxMap;
 108
 109   private Map<MethodInvokeNode, NTuple<Descriptor>> mapMethodInvokeNodeToBaseTuple;
 110
 111   private Map<MethodInvokeNode, Set<NTuple<Location>>> mapMethodInvokeNodeToPCLocTupleSet;
 112
 113   private Map<MethodDescriptor, MethodLocationInfo> mapMethodDescToMethodLocationInfo;
 114
 115   private Map<ClassDescriptor, LocationInfo> mapClassToLocationInfo;
 116
 117   private Map<MethodDescriptor, Set<MethodDescriptor>> mapMethodToCalleeSet;
 118
 119   private Map<MethodDescriptor, Set<FlowNode>> mapMethodDescToParamNodeFlowsToReturnValue;
 120
 121   private Map<String, Vector<String>> mapFileNameToLineVector;
 122
 123   private Map<Descriptor, Integer> mapDescToDefinitionLine;
 124
 125   private Map<Descriptor, LocationSummary> mapDescToLocationSummary;
 126
 127   private Map<MethodDescriptor, Set<MethodInvokeNode>> mapMethodDescToMethodInvokeNodeSet;
 128
 129   // maps a method descriptor to a sub global flow graph that captures all value flows caused by the
 130   // set of callees reachable from the method
 131   private Map<MethodDescriptor, GlobalFlowGraph> mapMethodDescriptorToSubGlobalFlowGraph;
 132
 133   private Map<MethodInvokeNode, Map<NTuple<Descriptor>, NTuple<Descriptor>>> mapMethodInvokeNodeToMapCallerArgToCalleeArg;
 134
 135   private Map<MethodDescriptor, Boolean> mapMethodDescriptorToCompositeReturnCase;
 136
 137   private Map<MethodDescriptor, MethodDescriptor> mapMethodDescToHighestOverriddenMethodDesc;
 138
 139   private Map<MethodDescriptor, Set<MethodDescriptor>> mapHighestOverriddenMethodDescToMethodDescSet;
 140
 141   private Map<MethodDescriptor, NTuple<Descriptor>> mapHighestOverriddenMethodDescToReturnLocTuple;
 142
 143   private Map<MethodDescriptor, NTuple<Descriptor>> mapHighestOverriddenMethodDescToPCLocTuple;
 144
 145   private Map<MethodDescriptor, Set<NTuple<Descriptor>>> mapHighestOverriddenMethodDescToSetLowerThanPCLoc;
 146
 147   private Map<MethodDescriptor, Set<NTuple<Descriptor>>> mapHighestOverriddenMethodDescToSetHigherThanRETURNLoc;
 148
 149   public static final String GLOBALLOC = "GLOBALLOC";
 150
 151   public static final String INTERLOC = "INTERLOC";
 152
 153   public static final String PCLOC = "_PCLOC_";
 154
 155   public static final String RLOC = "_RLOC_";
 156
 157   public static final Descriptor GLOBALDESC = new NameDescriptor(GLOBALLOC);
 158
 159   public static final Descriptor TOPDESC = new NameDescriptor(SSJavaAnalysis.TOP);
 160
 161   public static final Descriptor BOTTOMDESC = new NameDescriptor(SSJavaAnalysis.BOTTOM);
 162
 163   public static final Descriptor RETURNLOC = new NameDescriptor(RLOC);
 164
 165   public static final Descriptor LITERALDESC = new NameDescriptor("LITERAL");
 166
 167   public static final HNode TOPHNODE = new HNode(TOPDESC);
 168
 169   public static final HNode BOTTOMHNODE = new HNode(BOTTOMDESC);
 170
 171   public static String newline = System.getProperty("line.separator");
 172
 173   LocationInfo curMethodInfo;
 174
 175   private boolean hasChanges = false;
 176
 177   boolean debug = true;
 178
 179   public static int locSeed = 0;
 180
 181   private Stack<String> arrayAccessNodeStack;
 182
 183   private ClassDescriptor rootClassDescriptor;
 184
 185   private BuildLattice buildLattice;
 186
 187   public static int numLocationsSInfer = 0;
 188   public static int numLocationsNaive = 0;
 189
 190   public LocationInference(SSJavaAnalysis ssjava, State state, TypeUtil tu) {
 191     this.ssjava = ssjava;
 192     this.state = state;
 193     this.tu = tu;
 194     this.toanalyze_classDescSet = new HashSet<ClassDescriptor>();
 195     this.temp_toanalyzeList = new ArrayList<ClassDescriptor>();
 196     this.temp_toanalyzeMethodList = new ArrayList<MethodDescriptor>();
 197     this.mapMethodDescriptorToFlowGraph = new HashMap<MethodDescriptor, FlowGraph>();
 198     this.cd2lattice = new HashMap<ClassDescriptor, SSJavaLattice<String>>();
 199     this.md2lattice = new HashMap<MethodDescriptor, SSJavaLattice<String>>();
 200     this.desc2naiveLattice = new HashMap<Descriptor, SSJavaLattice<String>>();
 201
 202     this.methodDescriptorsToVisitStack = new Stack<MethodDescriptor>();
 203     this.mapMethodDescriptorToMethodInvokeNodeSet =
 204         new HashMap<MethodDescriptor, Set<MethodInvokeNode>>();
 205     this.mapMethodInvokeNodeToArgIdxMap =
 206         new HashMap<MethodInvokeNode, Map<Integer, NTuple<Descriptor>>>();
 207     this.mapMethodDescToMethodLocationInfo = new HashMap<MethodDescriptor, MethodLocationInfo>();
 208     this.mapMethodToCalleeSet = new HashMap<MethodDescriptor, Set<MethodDescriptor>>();
 209     this.mapClassToLocationInfo = new HashMap<ClassDescriptor, LocationInfo>();
 210
 211     this.mapFileNameToLineVector = new HashMap<String, Vector<String>>();
 212     this.mapDescToDefinitionLine = new HashMap<Descriptor, Integer>();
 213     this.mapMethodDescToParamNodeFlowsToReturnValue =
 214         new HashMap<MethodDescriptor, Set<FlowNode>>();
 215
 216     this.mapDescriptorToHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
 217     this.mapMethodInvokeNodeToBaseTuple = new HashMap<MethodInvokeNode, NTuple<Descriptor>>();
 218
 219     this.mapDescriptorToSkeletonHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
 220     this.mapDescriptorToCombineSkeletonHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
 221     this.mapDescriptorToSimpleHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
 222
 223     this.mapDescriptorToSimpleLattice = new HashMap<Descriptor, SSJavaLattice<String>>();
 224
 225     this.mapDescToLocationSummary = new HashMap<Descriptor, LocationSummary>();
 226
 227     this.mapMethodDescriptorToSubGlobalFlowGraph = new HashMap<MethodDescriptor, GlobalFlowGraph>();
 228
 229     this.mapMethodInvokeNodeToMapCallerArgToCalleeArg =
 230         new HashMap<MethodInvokeNode, Map<NTuple<Descriptor>, NTuple<Descriptor>>>();
 231
 232     this.mapMethodInvokeNodeToPCLocTupleSet =
 233         new HashMap<MethodInvokeNode, Set<NTuple<Location>>>();
 234
 235     this.arrayAccessNodeStack = new Stack<String>();
 236
 237     this.mapMethodDescToMethodInvokeNodeSet =
 238         new HashMap<MethodDescriptor, Set<MethodInvokeNode>>();
 239
 240     this.mapMethodDescriptorToCompositeReturnCase = new HashMap<MethodDescriptor, Boolean>();
 241
 242     mapMethodDescToHighestOverriddenMethodDesc = new HashMap<MethodDescriptor, MethodDescriptor>();
 243
 244     mapHighestOverriddenMethodDescToSetLowerThanPCLoc =
 245         new HashMap<MethodDescriptor, Set<NTuple<Descriptor>>>();
 246
 247     mapHighestOverriddenMethodDescToMethodDescSet =
 248         new HashMap<MethodDescriptor, Set<MethodDescriptor>>();
 249
 250     mapHighestOverriddenMethodDescToReturnLocTuple =
 251         new HashMap<MethodDescriptor, NTuple<Descriptor>>();
 252
 253     mapHighestOverriddenMethodDescToPCLocTuple =
 254         new HashMap<MethodDescriptor, NTuple<Descriptor>>();
 255
 256     mapHighestOverriddenMethodDescToSetHigherThanRETURNLoc =
 257         new HashMap<MethodDescriptor, Set<NTuple<Descriptor>>>();
 258
 259     this.buildLattice = new BuildLattice(this);
 260
 261   }
 262
 263   public void setupToAnalyze() {
 264     SymbolTable classtable = state.getClassSymbolTable();
 265     temp_toanalyzeList.clear();
 266     temp_toanalyzeList.addAll(classtable.getValueSet());
 267     // Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
 268     // public int compare(ClassDescriptor o1, ClassDescriptor o2) {
 269     // return o1.getClassName().compareToIgnoreCase(o2.getClassName());
 270     // }
 271     // });
 272   }
 273
 274   public void setupToAnalazeMethod(ClassDescriptor cd) {
 275
 276     SymbolTable methodtable = cd.getMethodTable();
 277     temp_toanalyzeMethodList.clear();
 278     temp_toanalyzeMethodList.addAll(methodtable.getValueSet());
 279     Collections.sort(temp_toanalyzeMethodList, new Comparator<MethodDescriptor>() {
 280       public int compare(MethodDescriptor o1, MethodDescriptor o2) {
 281         return o1.getSymbol().compareToIgnoreCase(o2.getSymbol());
 282       }
 283     });
 284   }
 285
 286   public boolean toAnalyzeMethodIsEmpty() {
 287     return temp_toanalyzeMethodList.isEmpty();
 288   }
 289
 290   public boolean toAnalyzeIsEmpty() {
 291     return temp_toanalyzeList.isEmpty();
 292   }
 293
 294   public ClassDescriptor toAnalyzeNext() {
 295     return temp_toanalyzeList.remove(0);
 296   }
 297
 298   public MethodDescriptor toAnalyzeMethodNext() {
 299     return temp_toanalyzeMethodList.remove(0);
 300   }
 301
 302   public void inference() {
 303
 304     ssjava.init();
 305
 306     // construct value flow graph
 307     constructFlowGraph();
 308
 309     constructGlobalFlowGraph();
 310
 311     checkReturnNodes();
 312
 313     assignCompositeLocation();
 314     updateFlowGraph();
 315     calculateExtraLocations();
 316     addAdditionalOrderingConstraints();
 317
 318     _debug_writeFlowGraph();
 319
 320     buildInheritanceTree();
 321     calculateReturnPCLocInheritance();
 322
 323     constructHierarchyGraph();
 324
 325     addInheritanceConstraintsToHierarchyGraph();
 326
 327     debug_writeHierarchyDotFiles();
 328
 329     simplifyHierarchyGraph();
 330
 331     debug_writeSimpleHierarchyDotFiles();
 332
 333     constructSkeletonHierarchyGraph();
 334
 335     debug_writeSkeletonHierarchyDotFiles();
 336
 337     insertCombinationNodes();
 338
 339     debug_writeSkeletonCombinationHierarchyDotFiles();
 340
 341     buildLatticeInheritanceTree();
 342     // buildLattice();
 343
 344     debug_writeLattices();
 345
 346     updateCompositeLocationAssignments();
 347
 348     generateMethodSummary();
 349
 350     generateAnnoatedCode();
 351
 352     for (Iterator iterator = cd2lattice.keySet().iterator(); iterator.hasNext();) {
 353       ClassDescriptor cd = (ClassDescriptor) iterator.next();
 354       SSJavaLattice<String> lattice = getLattice(cd);
 355       HierarchyGraph hg = mapDescriptorToHierarchyGraph.get(cd);
 356       // System.out.println("~~~\t" + cd + "\t" + lattice.getKeySet().size() + "\t"
 357       // + hg.getNodeSet().size());
 358     }
 359
 360     for (Iterator iterator = md2lattice.keySet().iterator(); iterator.hasNext();) {
 361       MethodDescriptor md = (MethodDescriptor) iterator.next();
 362       SSJavaLattice<String> locOrder = getLattice(md);
 363       // writeLatticeDotFile(md.getClassDesc(), md, getMethodLattice(md));
 364       HierarchyGraph hg = mapDescriptorToHierarchyGraph.get(md);
 365       // System.out.println("~~~\t" + md.getClassDesc() + "_" + md + "\t"
 366       // + locOrder.getKeySet().size() + "\t" + hg.getNodeSet().size());
 367     }
 368
 369     if (state.SSJAVA_INFER_NAIVE_WRITEDOTS) {
 370       System.out.println("The number of elements: Naive=" + numLocationsNaive);
 371     }
 372     System.out.println("The number of elements: SInfer=" + numLocationsSInfer);
 373
 374     System.exit(0);
 375
 376   }
 377
 378   private void calculateReturnPCLocInheritance() {
 379     calculateHighestPCLocInheritance();
 380     calculateLowestReturnLocInheritance();
 381     updateFlowGraphPCReturnLocInheritance();
 382   }
 383
 384   private void updateFlowGraphPCReturnLocInheritance() {
 385
 386     Set<MethodDescriptor> keySet = mapHighestOverriddenMethodDescToMethodDescSet.keySet();
 387     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 388       MethodDescriptor highestMethodDesc = (MethodDescriptor) iterator.next();
 389
 390       if (mapHighestOverriddenMethodDescToMethodDescSet.get(highestMethodDesc).size() == 1) {
 391         continue;
 392       }
 393
 394       Set<MethodDescriptor> methodDescSet =
 395           mapHighestOverriddenMethodDescToMethodDescSet.get(highestMethodDesc);
 396
 397       NTuple<Descriptor> highestPCLocDescTuple =
 398           mapHighestOverriddenMethodDescToPCLocTuple.get(highestMethodDesc);
 399
 400       NTuple<Descriptor> highestRETURNLocDescTuple =
 401           mapHighestOverriddenMethodDescToReturnLocTuple.get(highestMethodDesc);
 402
 403       // System.out.println("\n$$$$$$$$$$$$$$$$updateFlowGraphPCReturnLocInheritance="
 404       // + highestMethodDesc);
 405       // System.out.println("-----highestPCLoc=" + highestPCLocDescTuple);
 406       // System.out.println("-----highestRETURNLoc=" + highestRETURNLocDescTuple);
 407
 408       for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
 409         MethodDescriptor md = (MethodDescriptor) iterator2.next();
 410         // System.out.println("\n --------MD=" + md);
 411         FlowGraph flowGraph = getFlowGraph(md);
 412
 413         MethodSummary summary = getMethodSummary(md);
 414         CompositeLocation curPCLoc = summary.getPCLoc();
 415         NTuple<Descriptor> curPCDescTuple = translateToDescTuple(curPCLoc.getTuple());
 416         // System.out.println("md=" + md + "  curPCLoc=" + curPCLoc);
 417         // System.out.println("highestPCLoc=" + highestPCLocDescTuple);
 418
 419         if (highestPCLocDescTuple == null) {
 420           // this case: PCLOC is top
 421           // System.out.println("###SET PCLOC AS TOP");
 422           if (curPCDescTuple != null && !curPCLoc.get(0).isTop()) {
 423             FlowNode pcFlowNode = flowGraph.getFlowNode(curPCDescTuple);
 424             flowGraph.removeNode(pcFlowNode);
 425           }
 426           summary.setPCLoc(new CompositeLocation(new Location(md, Location.TOP)));
 427         } else {
 428           NTuple<Descriptor> newPCDescTuple = new NTuple<Descriptor>();
 429           if (highestPCLocDescTuple.size() == 1) {
 430             newPCDescTuple.add(highestPCLocDescTuple.get(0));
 431           } else {
 432             newPCDescTuple.add(md.getThis());
 433             newPCDescTuple.add(highestPCLocDescTuple.get(1));
 434           }
 435           if (!curPCDescTuple.equals(newPCDescTuple)) {
 436             FlowNode pcFlowNode = flowGraph.getFlowNode(curPCDescTuple);
 437             flowGraph.updateTuple(pcFlowNode, newPCDescTuple);
 438             // flowGraph.removeNode(pcFlowNode);
 439             Set<NTuple<Descriptor>> descSetLowerThanPCLoc =
 440                 mapHighestOverriddenMethodDescToSetLowerThanPCLoc.get(highestMethodDesc);
 441             for (Iterator iterator3 = descSetLowerThanPCLoc.iterator(); iterator3.hasNext();) {
 442               NTuple<Descriptor> lowerNTuple = (NTuple<Descriptor>) iterator3.next();
 443               flowGraph.addValueFlowEdge(newPCDescTuple, lowerNTuple);
 444             }
 445             CompositeLocation newPCCompLoc =
 446                 new CompositeLocation(translateToLocTuple(md, newPCDescTuple));
 447             summary.setPCLoc(newPCCompLoc);
 448           }
 449
 450         }
 451
 452         // update return loc
 453         if (highestRETURNLocDescTuple != null) {
 454           CompositeLocation curRETURNLoc = summary.getRETURNLoc();
 455           NTuple<Descriptor> curReturnDescTuple = translateToDescTuple(curRETURNLoc.getTuple());
 456
 457           if (!curReturnDescTuple.equals(highestRETURNLocDescTuple)) {
 458             // handle the case that RETURNLOC is started with 'this'...
 459             NTuple<Descriptor> newRETURNLocDescTuple = new NTuple<Descriptor>();
 460             if (highestRETURNLocDescTuple.size() == 1) {
 461               newRETURNLocDescTuple.add(highestRETURNLocDescTuple.get(0));
 462             } else {
 463               newRETURNLocDescTuple.add(md.getThis());
 464               newRETURNLocDescTuple.add(highestRETURNLocDescTuple.get(1));
 465             }
 466
 467             FlowNode returnFlowNode = flowGraph.getFlowNode(curReturnDescTuple);
 468             flowGraph.updateTuple(returnFlowNode, newRETURNLocDescTuple);
 469
 470             Set<NTuple<Descriptor>> descSetHigherThanRETURNLoc =
 471                 mapHighestOverriddenMethodDescToSetHigherThanRETURNLoc.get(highestMethodDesc);
 472             for (Iterator iterator3 = descSetHigherThanRETURNLoc.iterator(); iterator3.hasNext();) {
 473               NTuple<Descriptor> higherNTuple = (NTuple<Descriptor>) iterator3.next();
 474               flowGraph.addValueFlowEdge(higherNTuple, newRETURNLocDescTuple);
 475             }
 476
 477             CompositeLocation newRETURNLocCompLoc =
 478                 new CompositeLocation(translateToLocTuple(md, newRETURNLocDescTuple));
 479             summary.setRETURNLoc(newRETURNLocCompLoc);
 480           }
 481         }
 482       }
 483     }
 484   }
 485
 486   private void calculateHighestPCLocInheritance() {
 487
 488     Set<MethodDescriptor> keySet = mapHighestOverriddenMethodDescToMethodDescSet.keySet();
 489
 490     Map<MethodDescriptor, Integer> mapMethodDescToParamCount =
 491         new HashMap<MethodDescriptor, Integer>();
 492
 493     next: for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 494       MethodDescriptor highestMethodDesc = (MethodDescriptor) iterator.next();
 495
 496       NTuple<Descriptor> tempTuple = null;
 497
 498       if (getMethodSummary(highestMethodDesc).getPCLoc() != null) {
 499
 500         Set<MethodDescriptor> methodDescSet =
 501             mapHighestOverriddenMethodDescToMethodDescSet.get(highestMethodDesc);
 502
 503         if (methodDescSet.size() > 1) {
 504           // System.out.println("---method desc set=" + methodDescSet + "  from=" +
 505           // highestMethodDesc);
 506         } else {
 507           continue next;
 508         }
 509
 510         for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
 511           MethodDescriptor md = (MethodDescriptor) iterator2.next();
 512
 513           FlowGraph flowGraph = getFlowGraph(md);
 514           if (flowGraph == null) {
 515             continue;
 516           }
 517           Set<FlowNode> paramNodeSet = flowGraph.getParamFlowNodeSet();
 518           // System.out.println("###md=" + md + "   paramNodeSet=" + paramNodeSet);
 519
 520           CompositeLocation pcLOC = getMethodSummary(md).getPCLoc();
 521           // System.out.println("---pcLOC=" + pcLOC);
 522
 523           if (md.equals(highestMethodDesc)) {
 524             mapHighestOverriddenMethodDescToPCLocTuple.put(highestMethodDesc,
 525                 translateToDescTuple(pcLOC.getTuple()));
 526           }
 527
 528           if (!pcLOC.get(0).isTop()) {
 529
 530             FlowNode pcFlowNode = flowGraph.getFlowNode(translateToDescTuple(pcLOC.getTuple()));
 531
 532             int count = 0;
 533             for (Iterator iterator3 = paramNodeSet.iterator(); iterator3.hasNext();) {
 534               FlowNode paramNode = (FlowNode) iterator3.next();
 535               if (flowGraph.getReachableSetFrom(pcFlowNode.getCurrentDescTuple().subList(0, 1))
 536                   .contains(paramNode)) {
 537                 count++;
 538               }
 539             }
 540             mapMethodDescToParamCount.put(md, count);
 541
 542           } else {
 543
 544             // the PC location is top
 545             // if one of pcloc among the method inheritance chain has the TOP,
 546             // all methods in the same chain should have the TOP.
 547             mapHighestOverriddenMethodDescToPCLocTuple.remove(highestMethodDesc);
 548             // System.out.println("highest=" + highestMethodDesc + "  HIGHEST PCLOC="
 549             // + mapHighestOverriddenMethodDescToPCLocTuple.get(highestMethodDesc));
 550
 551             Set<NTuple<Descriptor>> descTupleSetLowerThanPC = new HashSet<NTuple<Descriptor>>();
 552             for (Iterator iterator3 = paramNodeSet.iterator(); iterator3.hasNext();) {
 553               FlowNode flowNode = (FlowNode) iterator3.next();
 554               descTupleSetLowerThanPC.add(flowNode.getCurrentDescTuple());
 555             }
 556             mapHighestOverriddenMethodDescToSetLowerThanPCLoc.put(highestMethodDesc,
 557                 descTupleSetLowerThanPC);
 558
 559             continue next;
 560           }
 561         }
 562
 563         // identify which method in the inheritance chain has the highest PCLOC
 564         // basically, finds a method that has the highest count or TOP location
 565         int highestCount = -1;
 566         MethodDescriptor methodDescHighestCount = null;
 567         for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
 568           MethodDescriptor methodDesc = (MethodDescriptor) iterator2.next();
 569           if (mapMethodDescToParamCount.containsKey(methodDesc)) {
 570             int curCount = mapMethodDescToParamCount.get(methodDesc).intValue();
 571             if (highestCount < curCount) {
 572               highestCount = curCount;
 573               methodDescHighestCount = methodDesc;
 574             }
 575           }
 576         }
 577
 578         if (methodDescHighestCount != null) {
 579           FlowGraph flowGraph = getFlowGraph(methodDescHighestCount);
 580           CompositeLocation pcLOC = getMethodSummary(methodDescHighestCount).getPCLoc();
 581           FlowNode pcFlowNode = flowGraph.getFlowNode(translateToDescTuple(pcLOC.getTuple()));
 582           Set<FlowNode> reachableSet =
 583               flowGraph.getReachableSetFrom(pcFlowNode.getCurrentDescTuple().subList(0, 1));
 584
 585           Set<FlowNode> reachableParamNodeSet = new HashSet<FlowNode>();
 586           for (Iterator iterator3 = reachableSet.iterator(); iterator3.hasNext();) {
 587             FlowNode flowNode = (FlowNode) iterator3.next();
 588             if (flowGraph.isParameter(flowNode.getCurrentDescTuple())) {
 589               reachableParamNodeSet.add(flowNode);
 590             }
 591
 592           }
 593
 594           Set<NTuple<Descriptor>> descTupleSetLowerThanPC = new HashSet<NTuple<Descriptor>>();
 595           for (Iterator iterator2 = reachableParamNodeSet.iterator(); iterator2.hasNext();) {
 596             FlowNode flowNode = (FlowNode) iterator2.next();
 597             descTupleSetLowerThanPC.add(flowNode.getCurrentDescTuple());
 598           }
 599
 600           // mapHighestOverriddenMethodDescToPCLocTuple.remove(highestMethodDesc);
 601           mapHighestOverriddenMethodDescToSetLowerThanPCLoc.put(highestMethodDesc,
 602               descTupleSetLowerThanPC);
 603         }
 604
 605       }
 606
 607       // System.out.println("####################################");
 608       // System.out.println("  highest=" + highestMethodDesc + "  HIGHEST PCLOC="
 609       // + mapHighestOverriddenMethodDescToPCLocTuple.get(highestMethodDesc));
 610       // System.out.println("  setLowerThanPCLoc="
 611       // + mapHighestOverriddenMethodDescToSetLowerThanPCLoc.get(highestMethodDesc));
 612     }
 613
 614   }
 615
 616   private void calculateLowestReturnLocInheritance() {
 617
 618     Set<MethodDescriptor> keySet = mapHighestOverriddenMethodDescToMethodDescSet.keySet();
 619
 620     Map<MethodDescriptor, Integer> mapMethodDescToParamCount =
 621         new HashMap<MethodDescriptor, Integer>();
 622
 623     next: for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
 624       MethodDescriptor highestMethodDesc = (MethodDescriptor) iterator.next();
 625
 626       Set<MethodDescriptor> methodDescSet =
 627           mapHighestOverriddenMethodDescToMethodDescSet.get(highestMethodDesc);
 628
 629       if (methodDescSet.size() > 1 && getMethodSummary(highestMethodDesc).getRETURNLoc() != null) {
 630       } else {
 631         continue next;
 632       }
 633
 634       for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
 635         MethodDescriptor md = (MethodDescriptor) iterator2.next();
 636
 637         FlowGraph flowGraph = getFlowGraph(md);
 638         Set<FlowNode> paramNodeSet = flowGraph.getParamFlowNodeSet();
 639
 640         CompositeLocation returnLoc = getMethodSummary(md).getRETURNLoc();
 641
 642         FlowNode returnFlowNode = flowGraph.getFlowNode(translateToDescTuple(returnLoc.getTuple()));
 643
 644         int count = 0;
 645         for (Iterator iterator3 = paramNodeSet.iterator(); iterator3.hasNext();) {
 646           FlowNode paramNode = (FlowNode) iterator3.next();
 647           if (flowGraph.getReachableSetFrom(paramNode.getCurrentDescTuple().subList(0, 1))
 648               .contains(returnFlowNode)) {
 649             count++;
 650           }
 651         }
 652         mapMethodDescToParamCount.put(md, count);
 653         // System.out.println("###returnLoc=" + returnLoc + "    count higher=" + count);
 654       }
 655
 656       // identify which method in the inheritance chain has the highest PCLOC
 657       // basically, finds a method that has the highest count or TOP location
 658       int highestCount = -1;
 659       MethodDescriptor methodDescHighestCount = null;
 660       for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
 661         MethodDescriptor methodDesc = (MethodDescriptor) iterator2.next();
 662         int curCount = mapMethodDescToParamCount.get(methodDesc).intValue();
 663         if (highestCount < curCount) {
 664           highestCount = curCount;
 665           methodDescHighestCount = methodDesc;
 666         }
 667       }
 668
 669       if (methodDescHighestCount != null) {
 670         FlowGraph flowGraph = getFlowGraph(methodDescHighestCount);
 671         CompositeLocation returnLOC = getMethodSummary(methodDescHighestCount).getRETURNLoc();
 672         NTuple<Descriptor> returnLocTuple = translateToDescTuple(returnLOC.getTuple());
 673         FlowNode returnFlowNode = flowGraph.getFlowNode(returnLocTuple);
 674
 675         Set<FlowNode> curMethodParamNodeSet = flowGraph.getParamFlowNodeSet();
 676         Set<NTuple<Descriptor>> descTupleSetHigherThanPC = new HashSet<NTuple<Descriptor>>();
 677         for (Iterator iterator3 = curMethodParamNodeSet.iterator(); iterator3.hasNext();) {
 678           FlowNode paramNode = (FlowNode) iterator3.next();
 679           if (flowGraph.getReachableSetFrom(paramNode.getCurrentDescTuple().subList(0, 1))
 680               .contains(returnFlowNode)) {
 681             descTupleSetHigherThanPC.add(paramNode.getCurrentDescTuple());
 682           }
 683         }
 684
 685         mapHighestOverriddenMethodDescToReturnLocTuple.put(highestMethodDesc, returnLocTuple);
 686         mapHighestOverriddenMethodDescToSetHigherThanRETURNLoc.put(highestMethodDesc,
 687             descTupleSetHigherThanPC);
 688
 689       }
 690
 691       // System.out.println("####################################");
 692       // System.out.println("  highest=" + highestMethodDesc + "  LOWEST RETURNLOC="
 693       // + mapHighestOverriddenMethodDescToReturnLocTuple.get(highestMethodDesc));
 694       // System.out.println("  setHigherThanReturnLoc="
 695       // + mapHighestOverriddenMethodDescToSetHigherThanRETURNLoc.get(highestMethodDesc));
 696
 697     }
 698
 699   }
 700
 701   private void addMapHighestMethodDescToMethodDesc(MethodDescriptor highest, MethodDescriptor md) {
 702     if (!mapHighestOverriddenMethodDescToMethodDescSet.containsKey(highest)) {
 703       mapHighestOverriddenMethodDescToMethodDescSet.put(highest, new HashSet<MethodDescriptor>());
 704     }
 705     mapHighestOverriddenMethodDescToMethodDescSet.get(highest).add(md);
 706   }
 707
 708   private void DFSInheritanceTreeCalculatingHighestOverriddenMethod(ClassDescriptor cd) {
 709
 710     // ClassDescriptor cd = node.getData();
 711
 712     for (Iterator iterator = cd.getMethods(); iterator.hasNext();) {
 713       MethodDescriptor md = (MethodDescriptor) iterator.next();
 714       MethodDescriptor highestMethodDesc = getHighestOverriddenMethod(md.getClassDesc(), md);
 715       mapMethodDescToHighestOverriddenMethodDesc.put(md, highestMethodDesc);
 716       addMapHighestMethodDescToMethodDesc(highestMethodDesc, md);
 717
 718     }
 719
 720     // traverse children
 721     Set<ClassDescriptor> children = getDirectSubClasses(cd);
 722     for (Iterator iterator = children.iterator(); iterator.hasNext();) {
 723       ClassDescriptor child = (ClassDescriptor) iterator.next();
 724       DFSInheritanceTreeCalculatingHighestOverriddenMethod(child);
 725     }
 726
 727   }
 728
 729   private MethodDescriptor getHighestOverriddenMethod(ClassDescriptor curClassDesc,
 730       MethodDescriptor curMethodDesc) {
 731
 732     // Node<ClassDescriptor> curNode = inheritanceTree.getTreeNode(curClassDesc);
 733     // Node<ClassDescriptor> parentNode = curNode.getParent();
 734     ClassDescriptor parentClassDesc = curClassDesc.getSuperDesc();
 735
 736     if (parentClassDesc != null) {
 737       if (parentClassDesc.getMethodTable().contains(curMethodDesc.getSymbol())) {
 738         Set<MethodDescriptor> methodDescSet =
 739             parentClassDesc.getMethodTable().getSet(curMethodDesc.getSymbol());
 740         for (Iterator iterator = methodDescSet.iterator(); iterator.hasNext();) {
 741           MethodDescriptor md = (MethodDescriptor) iterator.next();
 742           if (md.matches(curMethodDesc)) {
 743             return getHighestOverriddenMethod(parentClassDesc, md);
 744           }
 745         }
 746       }
 747       // traverse to the parent!
 748       return getHighestOverriddenMethod(parentClassDesc, curMethodDesc);
 749     }
 750     return curMethodDesc;
 751   }
 752
 753   private void buildInheritanceTree() {
 754
 755     DFSInheritanceTreeCalculatingHighestOverriddenMethod(rootClassDescriptor);
 756
 757   }
 758
 759   private void addInheritanceConstraintsToHierarchyGraph() {
 760
 761     // DFS the inheritance tree and propagates nodes/edges of parent to child
 762
 763     // Node<ClassDescriptor> rootNode = inheritanceTree.getRootNode();
 764     DFSInheritanceTree(rootClassDescriptor);
 765
 766   }
 767
 768   private void DFSInheritanceTree(ClassDescriptor parentClassDescriptor) {
 769
 770     // ClassDescriptor parentClassDescriptor = parentNode.getData();
 771
 772     Set<ClassDescriptor> children = getDirectSubClasses(parentClassDescriptor);
 773     for (Iterator iterator = children.iterator(); iterator.hasNext();) {
 774       ClassDescriptor childClassDescriptor = (ClassDescriptor) iterator.next();
 775
 776       HierarchyGraph parentGraph = getHierarchyGraph(parentClassDescriptor);
 777       HierarchyGraph childGraph = getHierarchyGraph(childClassDescriptor);
 778
 779       Set<HNode> parentNodeSet = parentGraph.getNodeSet();
 780       for (Iterator iterator2 = parentNodeSet.iterator(); iterator2.hasNext();) {
 781         HNode hNode = (HNode) iterator2.next();
 782         childGraph.addNode(hNode);
 783       }
 784
 785       // copies extra information from the parent hierarchy graph
 786       Map<HNode, Set<HNode>> parentMergeNodeMap = parentGraph.getMapHNodetoMergeSet();
 787       Map<HNode, Set<HNode>> childMergeNodeMap = childGraph.getMapHNodetoMergeSet();
 788
 789       Set<HNode> keySet = parentMergeNodeMap.keySet();
 790       for (Iterator iterator2 = keySet.iterator(); iterator2.hasNext();) {
 791         HNode parentKey = (HNode) iterator2.next();
 792         if (!childMergeNodeMap.containsKey(parentKey)) {
 793           childMergeNodeMap.put(parentKey, new HashSet<HNode>());
 794         }
 795         childMergeNodeMap.get(parentKey).addAll(parentMergeNodeMap.get(parentKey));
 796       }
 797
 798       // copies nodes/edges from the parent class...
 799       for (Iterator iterator2 = parentNodeSet.iterator(); iterator2.hasNext();) {
 800         HNode parentHNode = (HNode) iterator2.next();
 801
 802         Set<HNode> parentIncomingHNode = parentGraph.getIncomingNodeSet(parentHNode);
 803         Set<HNode> parentOutgoingHNode = parentGraph.getOutgoingNodeSet(parentHNode);
 804
 805         for (Iterator iterator3 = parentIncomingHNode.iterator(); iterator3.hasNext();) {
 806           HNode inHNode = (HNode) iterator3.next();
 807           childGraph.addEdge(inHNode.getDescriptor(), parentHNode.getDescriptor());
 808         }
 809
 810         for (Iterator iterator3 = parentOutgoingHNode.iterator(); iterator3.hasNext();) {
 811           HNode outHNode = (HNode) iterator3.next();
 812           childGraph.addEdge(parentHNode.getDescriptor(), outHNode.getDescriptor());
 813         }
 814
 815       }
 816
 817       // copies nodes/edges from parent methods to overridden methods
 818
 819       for (Iterator iterator3 = childClassDescriptor.getMethods(); iterator3.hasNext();) {
 820         MethodDescriptor childMethodDescriptor = (MethodDescriptor) iterator3.next();
 821
 822         MethodDescriptor parentMethodDesc =
 823             getParentMethodDesc(childMethodDescriptor.getClassDesc(), childMethodDescriptor);
 824
 825         if (parentMethodDesc != null) {
 826
 827           HierarchyGraph parentMethodGraph = getHierarchyGraph(parentMethodDesc);
 828           HierarchyGraph childMethodGraph = getHierarchyGraph(childMethodDescriptor);
 829
 830           Set<HNode> parentMethodNodeSet = parentMethodGraph.getNodeSet();
 831           for (Iterator iterator2 = parentMethodNodeSet.iterator(); iterator2.hasNext();) {
 832             HNode hNode = (HNode) iterator2.next();
 833             childMethodGraph.addNode(hNode);
 834           }
 835
 836           // copies extra information from the parent hierarchy graph
 837           Map<HNode, Set<HNode>> parentMethodMergeNodeMap =
 838               parentMethodGraph.getMapHNodetoMergeSet();
 839           Map<HNode, Set<HNode>> childMethodMergeNodeMap = childMethodGraph.getMapHNodetoMergeSet();
 840
 841           Set<HNode> methodKeySet = parentMethodMergeNodeMap.keySet();
 842           for (Iterator iterator2 = methodKeySet.iterator(); iterator2.hasNext();) {
 843             HNode parentKey = (HNode) iterator2.next();
 844             if (!childMethodMergeNodeMap.containsKey(parentKey)) {
 845               childMethodMergeNodeMap.put(parentKey, new HashSet<HNode>());
 846             }
 847             childMethodMergeNodeMap.get(parentKey).addAll(parentMethodMergeNodeMap.get(parentKey));
 848           }
 849
 850           // copies nodes/edges from the parent method...
 851           for (Iterator iterator2 = parentMethodGraph.getNodeSet().iterator(); iterator2.hasNext();) {
 852             HNode parentHNode = (HNode) iterator2.next();
 853
 854             Set<HNode> parentIncomingHNode = parentMethodGraph.getIncomingNodeSet(parentHNode);
 855             Set<HNode> parentOutgoingHNode = parentMethodGraph.getOutgoingNodeSet(parentHNode);
 856
 857             for (Iterator iterator4 = parentIncomingHNode.iterator(); iterator4.hasNext();) {
 858               HNode inHNode = (HNode) iterator4.next();
 859               childMethodGraph.addEdge(inHNode, parentHNode);
 860             }
 861
 862             for (Iterator iterator4 = parentOutgoingHNode.iterator(); iterator4.hasNext();) {
 863               HNode outHNode = (HNode) iterator4.next();
 864               childMethodGraph.addEdge(parentHNode, outHNode);
 865             }
 866
 867           }
 868
 869         }
 870
 871       }
 872
 873       DFSInheritanceTree(childClassDescriptor);
 874     }
 875
 876   }
 877
 878   public MethodDescriptor getParentMethodDesc(ClassDescriptor classDesc, MethodDescriptor methodDesc) {
 879
 880     // Node<ClassDescriptor> childNode = inheritanceTree.getTreeNode(classDesc);
 881     ClassDescriptor parentClassDesc = classDesc.getSuperDesc();
 882     // Node<ClassDescriptor> parentNode = childNode.getParent();
 883
 884     if (parentClassDesc != null) {
 885       // ClassDescriptor parentClassDesc = parentNode.getData();
 886       if (parentClassDesc.getMethodTable().contains(methodDesc.getSymbol())) {
 887         Set<MethodDescriptor> methodDescSet =
 888             parentClassDesc.getMethodTable().getSet(methodDesc.getSymbol());
 889         for (Iterator iterator = methodDescSet.iterator(); iterator.hasNext();) {
 890           MethodDescriptor md = (MethodDescriptor) iterator.next();
 891           if (md.matches(methodDesc)) {
 892             return md;
 893           }
 894         }
 895       }
 896
 897       // traverse to the parent!
 898       getParentMethodDesc(parentClassDesc, methodDesc);
 899
 900     }
 901
 902     return null;
 903   }
 904
 905   private void checkReturnNodes() {
 906     LinkedList<MethodDescriptor> methodDescList =
 907         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
 908
 909     while (!methodDescList.isEmpty()) {
 910       MethodDescriptor md = methodDescList.removeLast();
 911
 912       if (md.getReturnType() != null && !md.getReturnType().isVoid()) {
 913         checkFlowNodeReturnThisField(md);
 914       }
 915       // // in this case, this method will return the composite location that starts with 'this'
 916       // FlowGraph flowGraph = getFlowGraph(md);
 917       // Set<FlowNode> returnNodeSet = flowGraph.getReturnNodeSet();
 918       // }
 919
 920     }
 921
 922   }
 923
 924   private void addSuperClasses(ClassDescriptor cd) {
 925     ClassDescriptor parentClassDesc = cd.getSuperDesc();
 926     if (parentClassDesc != null) {
 927       toanalyze_classDescSet.add(parentClassDesc);
 928       addSuperClasses(parentClassDesc);
 929     }
 930   }
 931
 932   private void updateFlowGraph() {
 933
 934     LinkedList<MethodDescriptor> methodDescList =
 935         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
 936
 937     while (!methodDescList.isEmpty()) {
 938       MethodDescriptor md = methodDescList.removeLast();
 939       if (state.SSJAVADEBUG) {
 940         System.out.println();
 941         System.out.println("SSJAVA: Updating a flow graph: " + md);
 942         propagateFlowsFromCalleesWithNoCompositeLocation(md);
 943       }
 944
 945       Set<FlowNode> nodeSet = getFlowGraph(md).getNodeSet();
 946       for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
 947         FlowNode flowNode = (FlowNode) iterator.next();
 948         NTuple<Descriptor> descTuple = flowNode.getCurrentDescTuple();
 949         NTuple<Location> locTuple = translateToLocTuple(md, descTuple);
 950         for (int i = 0; i < locTuple.size(); i++) {
 951           Location loc = locTuple.get(i);
 952           if (loc.getDescriptor() instanceof ClassDescriptor) {
 953             ClassDescriptor classDesc = (ClassDescriptor) loc.getDescriptor();
 954             toanalyze_classDescSet.add(classDesc);
 955             addSuperClasses(classDesc);
 956           } else if (loc.getDescriptor() instanceof MethodDescriptor) {
 957             toanalyze_classDescSet.add(((MethodDescriptor) loc.getDescriptor()).getClassDesc());
 958           }
 959         }
 960
 961       }
 962
 963     }
 964   }
 965
 966   public Map<NTuple<Descriptor>, NTuple<Descriptor>> getMapCallerArgToCalleeParam(
 967       MethodInvokeNode min) {
 968
 969     if (!mapMethodInvokeNodeToMapCallerArgToCalleeArg.containsKey(min)) {
 970       mapMethodInvokeNodeToMapCallerArgToCalleeArg.put(min,
 971           new HashMap<NTuple<Descriptor>, NTuple<Descriptor>>());
 972     }
 973
 974     return mapMethodInvokeNodeToMapCallerArgToCalleeArg.get(min);
 975   }
 976
 977   public void addMapCallerArgToCalleeParam(MethodInvokeNode min, NTuple<Descriptor> callerArg,
 978       NTuple<Descriptor> calleeParam) {
 979     getMapCallerArgToCalleeParam(min).put(callerArg, calleeParam);
 980   }
 981
 982   private void assignCompositeLocation() {
 983     calculateGlobalValueFlowCompositeLocation();
 984     translateCompositeLocationAssignmentToFlowGraph();
 985   }
 986
 987   private void translateCompositeLocationAssignmentToFlowGraph() {
 988     System.out.println("\nSSJAVA: Translate composite location assignments to flow graphs:");
 989     MethodDescriptor methodEventLoopDesc = ssjava.getMethodContainingSSJavaLoop();
 990     translateCompositeLocationAssignmentToFlowGraph(methodEventLoopDesc);
 991   }
 992
 993   private void translateCompositeLocationAssignmentToFlowGraph2() {
 994     System.out.println("\nSSJAVA: Translate composite location assignments to flow graphs:");
 995     MethodDescriptor methodEventLoopDesc = ssjava.getMethodContainingSSJavaLoop();
 996     translateCompositeLocationAssignmentToFlowGraph(methodEventLoopDesc);
 997   }
 998
 999   private void addAdditionalOrderingConstraints() {
1000     System.out.println("\nSSJAVA: Add addtional ordering constriants:");
1001     MethodDescriptor methodEventLoopDesc = ssjava.getMethodContainingSSJavaLoop();
1002     addAddtionalOrderingConstraints(methodEventLoopDesc);
1003     // calculateReturnHolderLocation();
1004   }
1005
1006   private void calculateReturnHolderLocation() {
1007     LinkedList<MethodDescriptor> methodDescList =
1008         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
1009
1010     while (!methodDescList.isEmpty()) {
1011       MethodDescriptor md = methodDescList.removeLast();
1012
1013       FlowGraph fg = getFlowGraph(md);
1014       Set<FlowNode> nodeSet = fg.getNodeSet();
1015       for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
1016         FlowNode flowNode = (FlowNode) iterator.next();
1017         if (flowNode.isFromHolder()) {
1018           calculateCompositeLocationFromFlowGraph(md, flowNode);
1019         }
1020       }
1021
1022     }
1023   }
1024
1025   private void updateCompositeLocationAssignments() {
1026
1027     LinkedList<MethodDescriptor> methodDescList =
1028         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
1029
1030     while (!methodDescList.isEmpty()) {
1031       MethodDescriptor md = methodDescList.removeLast();
1032
1033       // System.out.println("\n#updateCompositeLocationAssignments=" + md);
1034
1035       FlowGraph flowGraph = getFlowGraph(md);
1036
1037       MethodSummary methodSummary = getMethodSummary(md);
1038
1039       Set<FlowNode> nodeSet = flowGraph.getNodeSet();
1040       for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
1041         FlowNode node = (FlowNode) iterator.next();
1042         // System.out.println("-node=" + node + "   node.getDescTuple=" + node.getDescTuple());
1043         if (node.getCompositeLocation() != null) {
1044           CompositeLocation compLoc = node.getCompositeLocation();
1045           CompositeLocation updatedCompLoc = updateCompositeLocation(compLoc);
1046           node.setCompositeLocation(updatedCompLoc);
1047           // System.out.println("---updatedCompLoc1=" + updatedCompLoc);
1048         } else {
1049           NTuple<Descriptor> descTuple = node.getDescTuple();
1050           // System.out.println("update desc=" + descTuple);
1051           CompositeLocation compLoc = convertToCompositeLocation(md, descTuple);
1052           compLoc = updateCompositeLocation(compLoc);
1053           node.setCompositeLocation(compLoc);
1054           // System.out.println("---updatedCompLoc2=" + compLoc);
1055         }
1056
1057         if (node.isDeclaratonNode()) {
1058           Descriptor localVarDesc = node.getDescTuple().get(0);
1059           CompositeLocation compLoc = updateCompositeLocation(node.getCompositeLocation());
1060           methodSummary.addMapVarNameToInferCompLoc(localVarDesc, compLoc);
1061         }
1062       }
1063
1064       // update PCLOC and RETURNLOC if they have a composite location assignment
1065       if (methodSummary.getRETURNLoc() != null) {
1066         methodSummary.setRETURNLoc(updateCompositeLocation(methodSummary.getRETURNLoc()));
1067       }
1068       if (methodSummary.getPCLoc() != null) {
1069         methodSummary.setPCLoc(updateCompositeLocation(methodSummary.getPCLoc()));
1070       }
1071
1072     }
1073
1074   }
1075
1076   private CompositeLocation updateCompositeLocation(CompositeLocation compLoc) {
1077     CompositeLocation updatedCompLoc = new CompositeLocation();
1078     for (int i = 0; i < compLoc.getSize(); i++) {
1079       Location loc = compLoc.get(i);
1080       String nodeIdentifier = loc.getLocIdentifier();
1081       Descriptor enclosingDesc = loc.getDescriptor();
1082       String locName;
1083       if (!enclosingDesc.equals(GLOBALDESC)) {
1084         LocationSummary locSummary = getLocationSummary(enclosingDesc);
1085         // HierarchyGraph scGraph = getSkeletonCombinationHierarchyGraph(enclosingDesc);
1086         HierarchyGraph scGraph = getSimpleHierarchyGraph(enclosingDesc);
1087         if (scGraph != null) {
1088           HNode curNode = scGraph.getCurrentHNode(nodeIdentifier);
1089           // System.out.println("nodeID=" + nodeIdentifier + " curNode=" + curNode
1090           // + "  enclosingDesc=" + enclosingDesc);
1091           if (curNode != null) {
1092             nodeIdentifier = curNode.getName();
1093           }
1094         }
1095         locName = locSummary.getLocationName(nodeIdentifier);
1096       } else {
1097         locName = nodeIdentifier;
1098       }
1099       Location updatedLoc = new Location(enclosingDesc, locName);
1100       updatedCompLoc.addLocation(updatedLoc);
1101     }
1102
1103     return updatedCompLoc;
1104   }
1105
1106   private void translateCompositeLocationAssignmentToFlowGraph(MethodDescriptor mdCaller) {
1107
1108     // System.out.println("\n\n###translateCompositeLocationAssignmentToFlowGraph mdCaller="
1109     // + mdCaller);
1110
1111     // First, assign a composite location to a node in the flow graph
1112     GlobalFlowGraph callerGlobalFlowGraph = getSubGlobalFlowGraph(mdCaller);
1113
1114     FlowGraph callerFlowGraph = getFlowGraph(mdCaller);
1115     Map<Location, CompositeLocation> callerMapLocToCompLoc =
1116         callerGlobalFlowGraph.getMapLocationToInferCompositeLocation();
1117
1118     Set<Location> methodLocSet = callerMapLocToCompLoc.keySet();
1119     for (Iterator iterator = methodLocSet.iterator(); iterator.hasNext();) {
1120       Location methodLoc = (Location) iterator.next();
1121       if (methodLoc.getDescriptor().equals(mdCaller)) {
1122         CompositeLocation inferCompLoc = callerMapLocToCompLoc.get(methodLoc);
1123         assignCompositeLocationToFlowGraph(callerFlowGraph, methodLoc, inferCompLoc);
1124       }
1125     }
1126
1127     Set<MethodInvokeNode> minSet = mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
1128
1129     Set<MethodDescriptor> calleeSet = new HashSet<MethodDescriptor>();
1130     for (Iterator iterator = minSet.iterator(); iterator.hasNext();) {
1131       MethodInvokeNode min = (MethodInvokeNode) iterator.next();
1132       // need to translate a composite location that is started with the base
1133       // tuple of 'min'.
1134       translateMapLocationToInferCompositeLocationToCalleeGraph(callerGlobalFlowGraph, min);
1135       MethodDescriptor mdCallee = min.getMethod();
1136       calleeSet.add(mdCallee);
1137
1138     }
1139
1140     for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
1141       MethodDescriptor callee = (MethodDescriptor) iterator.next();
1142       translateCompositeLocationAssignmentToFlowGraph(callee);
1143     }
1144
1145   }
1146
1147   private void addAddtionalOrderingConstraints(MethodDescriptor mdCaller) {
1148
1149     // First, assign a composite location to a node in the flow graph
1150     GlobalFlowGraph callerGlobalFlowGraph = getSubGlobalFlowGraph(mdCaller);
1151
1152     FlowGraph callerFlowGraph = getFlowGraph(mdCaller);
1153     Map<Location, CompositeLocation> callerMapLocToCompLoc =
1154         callerGlobalFlowGraph.getMapLocationToInferCompositeLocation();
1155     Set<Location> methodLocSet = callerMapLocToCompLoc.keySet();
1156
1157     Set<MethodInvokeNode> minSet = mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
1158
1159     Set<MethodDescriptor> calleeSet = new HashSet<MethodDescriptor>();
1160     for (Iterator iterator = minSet.iterator(); iterator.hasNext();) {
1161       MethodInvokeNode min = (MethodInvokeNode) iterator.next();
1162       MethodDescriptor mdCallee = min.getMethod();
1163       calleeSet.add(mdCallee);
1164
1165       //
1166       // add an additional ordering constraint
1167       // if the first element of a parameter composite location matches 'this' reference,
1168       // the corresponding argument in the caller is required to be higher than the translated
1169       // parameter location in the caller lattice
1170       // TODO
1171       // addOrderingConstraintFromCompLocParamToArg(mdCaller, min);
1172
1173       //
1174       // update return flow nodes in the caller
1175       CompositeLocation returnLoc = getMethodSummary(mdCallee).getRETURNLoc();
1176       // System.out.println("### min=" + min.printNode(0) + "  returnLoc=" + returnLoc);
1177       if (returnLoc != null && returnLoc.get(0).getLocDescriptor().equals(mdCallee.getThis())
1178           && returnLoc.getSize() > 1) {
1179         // System.out.println("###RETURN COMP LOC=" + returnLoc);
1180         NTuple<Location> returnLocTuple = returnLoc.getTuple();
1181         NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
1182         // System.out.println("###basetuple=" + baseTuple);
1183         NTuple<Descriptor> newReturnTuple = baseTuple.clone();
1184         for (int i = 1; i < returnLocTuple.size(); i++) {
1185           newReturnTuple.add(returnLocTuple.get(i).getLocDescriptor());
1186         }
1187         // System.out.println("###NEW RETURN TUPLE FOR CALLER=" + newReturnTuple);
1188
1189         FlowReturnNode holderNode = callerFlowGraph.getFlowReturnNode(min);
1190         NodeTupleSet holderTupleSet =
1191             getNodeTupleSetFromReturnNode(getFlowGraph(mdCaller), holderNode);
1192
1193         callerFlowGraph.getFlowReturnNode(min).setNewTuple(newReturnTuple);
1194
1195         // then need to remove old constraints
1196         // TODO SAT
1197         // System.out.println("###REMOVE OLD CONSTRAINTS=" + holderNode);
1198         for (Iterator<NTuple<Descriptor>> iter = holderTupleSet.iterator(); iter.hasNext();) {
1199           NTuple<Descriptor> tupleFromHolder = iter.next();
1200           Set<FlowEdge> holderOutEdge = callerFlowGraph.getOutEdgeSet(holderNode);
1201           for (Iterator iterator2 = holderOutEdge.iterator(); iterator2.hasNext();) {
1202             FlowEdge outEdge = (FlowEdge) iterator2.next();
1203             NTuple<Descriptor> toberemovedTuple = outEdge.getEndTuple();
1204             // System.out.println("---remove " + tupleFromHolder + " -> " + toberemovedTuple);
1205             callerFlowGraph.removeEdge(tupleFromHolder, toberemovedTuple);
1206           }
1207         }
1208
1209       } else {
1210         // if the return loc set was empty and later pcloc was connected to the return loc
1211         // need to make sure that return loc reflects to this changes.
1212         FlowReturnNode flowReturnNode = callerFlowGraph.getFlowReturnNode(min);
1213         if (flowReturnNode != null && flowReturnNode.getReturnTupleSet().isEmpty()) {
1214
1215           if (needToUpdateReturnLocHolder(min.getMethod(), flowReturnNode)) {
1216             NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
1217             NTuple<Descriptor> newReturnTuple = baseTuple.clone();
1218             flowReturnNode.addTuple(newReturnTuple);
1219           }
1220
1221         }
1222
1223       }
1224
1225     }
1226
1227     for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
1228       MethodDescriptor callee = (MethodDescriptor) iterator.next();
1229       addAddtionalOrderingConstraints(callee);
1230     }
1231
1232   }
1233
1234   private boolean needToUpdateReturnLocHolder(MethodDescriptor mdCallee,
1235       FlowReturnNode flowReturnNode) {
1236     FlowGraph fg = getFlowGraph(mdCallee);
1237     MethodSummary summary = getMethodSummary(mdCallee);
1238     CompositeLocation returnCompLoc = summary.getRETURNLoc();
1239     NTuple<Descriptor> returnDescTuple = translateToDescTuple(returnCompLoc.getTuple());
1240     Set<FlowNode> incomingNodeToReturnNode =
1241         fg.getIncomingFlowNodeSet(fg.getFlowNode(returnDescTuple));
1242     for (Iterator iterator = incomingNodeToReturnNode.iterator(); iterator.hasNext();) {
1243       FlowNode inNode = (FlowNode) iterator.next();
1244       if (inNode.getDescTuple().get(0).equals(mdCallee.getThis())) {
1245         return true;
1246       }
1247     }
1248     return false;
1249   }
1250
1251   private void addMapMethodDescToMethodInvokeNodeSet(MethodInvokeNode min) {
1252     MethodDescriptor md = min.getMethod();
1253     if (!mapMethodDescToMethodInvokeNodeSet.containsKey(md)) {
1254       mapMethodDescToMethodInvokeNodeSet.put(md, new HashSet<MethodInvokeNode>());
1255     }
1256     mapMethodDescToMethodInvokeNodeSet.get(md).add(min);
1257   }
1258
1259   private Set<MethodInvokeNode> getMethodInvokeNodeSetByMethodDesc(MethodDescriptor md) {
1260     if (!mapMethodDescToMethodInvokeNodeSet.containsKey(md)) {
1261       mapMethodDescToMethodInvokeNodeSet.put(md, new HashSet<MethodInvokeNode>());
1262     }
1263     return mapMethodDescToMethodInvokeNodeSet.get(md);
1264   }
1265
1266   public void assignCompositeLocationToFlowGraph(FlowGraph flowGraph, Location loc,
1267       CompositeLocation inferCompLoc) {
1268     Descriptor localDesc = loc.getLocDescriptor();
1269
1270     Set<FlowNode> nodeSet = flowGraph.getNodeSet();
1271     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
1272       FlowNode node = (FlowNode) iterator.next();
1273       if (node.getDescTuple().startsWith(localDesc)
1274           && !node.getDescTuple().get(0).equals(LITERALDESC)) {
1275         // need to assign the inferred composite location to this node
1276         CompositeLocation newCompLoc = generateCompositeLocation(node.getDescTuple(), inferCompLoc);
1277         node.setCompositeLocation(newCompLoc);
1278         // System.out.println("SET Node=" + node + "  inferCompLoc=" + newCompLoc);
1279       }
1280     }
1281   }
1282
1283   private CompositeLocation generateCompositeLocation(NTuple<Descriptor> nodeDescTuple,
1284       CompositeLocation inferCompLoc) {
1285
1286     // System.out.println("generateCompositeLocation=" + nodeDescTuple + " with inferCompLoc="
1287     // + inferCompLoc);
1288
1289     MethodDescriptor md = (MethodDescriptor) inferCompLoc.get(0).getDescriptor();
1290
1291     CompositeLocation newCompLoc = new CompositeLocation();
1292     for (int i = 0; i < inferCompLoc.getSize(); i++) {
1293       newCompLoc.addLocation(inferCompLoc.get(i));
1294     }
1295
1296     Descriptor lastDescOfPrefix = nodeDescTuple.get(0);
1297     Descriptor enclosingDescriptor;
1298     if (lastDescOfPrefix instanceof InterDescriptor) {
1299       enclosingDescriptor = getFlowGraph(md).getEnclosingDescriptor(lastDescOfPrefix);
1300     } else {
1301       enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc();
1302     }
1303
1304     for (int i = 1; i < nodeDescTuple.size(); i++) {
1305       Descriptor desc = nodeDescTuple.get(i);
1306       Location locElement = new Location(enclosingDescriptor, desc);
1307       newCompLoc.addLocation(locElement);
1308
1309       enclosingDescriptor = ((FieldDescriptor) desc).getClassDescriptor();
1310     }
1311
1312     return newCompLoc;
1313   }
1314
1315   private void translateMapLocationToInferCompositeLocationToCalleeGraph(
1316       GlobalFlowGraph callerGraph, MethodInvokeNode min) {
1317
1318     MethodDescriptor mdCallee = min.getMethod();
1319     MethodDescriptor mdCaller = callerGraph.getMethodDescriptor();
1320     Map<Location, CompositeLocation> callerMapLocToCompLoc =
1321         callerGraph.getMapLocationToInferCompositeLocation();
1322
1323     Map<Integer, NTuple<Descriptor>> mapIdxToArgTuple = mapMethodInvokeNodeToArgIdxMap.get(min);
1324
1325     FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
1326     GlobalFlowGraph calleeGlobalGraph = getSubGlobalFlowGraph(mdCallee);
1327
1328     NTuple<Location> baseLocTuple = null;
1329     if (mapMethodInvokeNodeToBaseTuple.containsKey(min)) {
1330       baseLocTuple = translateToLocTuple(mdCaller, mapMethodInvokeNodeToBaseTuple.get(min));
1331     }
1332
1333     // System.out.println("\n-#translate caller=" + mdCaller + " infer composite loc to callee="
1334     // + mdCallee + " baseLocTuple=" + baseLocTuple);
1335
1336     Set<Location> keySet = callerMapLocToCompLoc.keySet();
1337     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
1338       Location key = (Location) iterator.next();
1339       CompositeLocation callerCompLoc = callerMapLocToCompLoc.get(key);
1340
1341       if (!key.getDescriptor().equals(mdCaller)) {
1342
1343         CompositeLocation newCalleeCompLoc;
1344         if (baseLocTuple != null && callerCompLoc.getTuple().startsWith(baseLocTuple)) {
1345           // System.out.println("-----need to translate callerCompLoc=" + callerCompLoc
1346           // + " with baseTuple=" + baseLocTuple);
1347           newCalleeCompLoc =
1348               translateCompositeLocationToCallee(callerCompLoc, baseLocTuple, mdCallee);
1349
1350           calleeGlobalGraph.addMapLocationToInferCompositeLocation(key, newCalleeCompLoc);
1351           // System.out.println("1---key=" + key + "  callerCompLoc=" + callerCompLoc
1352           // + "  newCalleeCompLoc=" + newCalleeCompLoc);
1353           // System.out.println("-----caller=" + mdCaller + "    callee=" + mdCallee);
1354           if (!newCalleeCompLoc.get(0).getDescriptor().equals(mdCallee)) {
1355             System.exit(0);
1356           }
1357
1358           // System.out.println("-----baseLoctuple=" + baseLocTuple);
1359         } else {
1360           // check if it is the global access
1361           Location compLocFirstElement = callerCompLoc.getTuple().get(0);
1362           if (compLocFirstElement.getDescriptor().equals(mdCallee)
1363               && compLocFirstElement.getLocDescriptor().equals(GLOBALDESC)) {
1364
1365             newCalleeCompLoc = new CompositeLocation();
1366             Location newMethodLoc = new Location(mdCallee, GLOBALDESC);
1367
1368             newCalleeCompLoc.addLocation(newMethodLoc);
1369             for (int i = 1; i < callerCompLoc.getSize(); i++) {
1370               newCalleeCompLoc.addLocation(callerCompLoc.get(i));
1371             }
1372             calleeGlobalGraph.addMapLocationToInferCompositeLocation(key, newCalleeCompLoc);
1373             // System.out.println("2---key=" + key + "  callerCompLoc=" + callerCompLoc
1374             // + "  newCalleeCompLoc=" + newCalleeCompLoc);
1375             // System.out.println("-----caller=" + mdCaller + "    callee=" + mdCallee);
1376
1377           } else {
1378             int paramIdx = getParamIdx(callerCompLoc, mapIdxToArgTuple);
1379             if (paramIdx == -1) {
1380               // here, the first element of the current composite location comes from the current
1381               // callee
1382               // so transfer the same composite location to the callee
1383               if (!calleeGlobalGraph.contrainsInferCompositeLocationMapKey(key)) {
1384                 if (callerCompLoc.get(0).getDescriptor().equals(mdCallee)) {
1385                   // System.out.println("3---key=" + key + "  callerCompLoc=" + callerCompLoc
1386                   // + "  newCalleeCompLoc=" + callerCompLoc);
1387                   // System.out.println("-----caller=" + mdCaller + "    callee=" + mdCallee);
1388                   calleeGlobalGraph.addMapLocationToInferCompositeLocation(key, callerCompLoc);
1389                 } else {
1390                   // System.out.println("3---SKIP key=" + key + " callerCompLoc=" + callerCompLoc);
1391                 }
1392               }
1393               continue;
1394             }
1395
1396             // It is the case where two parameters have relative orderings between them by having
1397             // composite locations
1398             // if we found the param idx, it means that the first part of the caller composite
1399             // location corresponds to the one of arguments.
1400             // for example, if the caller argument is <<caller.this>,<Decoder.br>>
1401             // and the current caller composite location mapping
1402             // <<caller.this>,<Decoder.br>,<Br.value>>
1403             // and the parameter which matches with the caller argument is 'Br brParam'
1404             // then, the translated callee composite location will be <<callee.brParam>,<Br.value>>
1405             NTuple<Descriptor> argTuple = mapIdxToArgTuple.get(paramIdx);
1406
1407             FlowNode paramFlowNode = calleeFlowGraph.getParamFlowNode(paramIdx);
1408             NTuple<Location> paramLocTuple =
1409                 translateToLocTuple(mdCallee, paramFlowNode.getDescTuple());
1410             newCalleeCompLoc = new CompositeLocation();
1411             for (int i = 0; i < paramLocTuple.size(); i++) {
1412               newCalleeCompLoc.addLocation(paramLocTuple.get(i));
1413             }
1414             for (int i = argTuple.size(); i < callerCompLoc.getSize(); i++) {
1415               newCalleeCompLoc.addLocation(callerCompLoc.get(i));
1416             }
1417             calleeGlobalGraph.addMapLocationToInferCompositeLocation(key, newCalleeCompLoc);
1418             // System.out.println("4---key=" + key + "  callerCompLoc=" + callerCompLoc
1419             // + "  newCalleeCompLoc=" + newCalleeCompLoc);
1420             // System.out.println("-----caller=" + mdCaller + "    callee=" + mdCallee);
1421
1422           }
1423
1424         }
1425
1426       }
1427     }
1428
1429     // System.out.println("#ASSIGN COMP LOC TO CALLEE PARAMS: callee=" + mdCallee + "  caller="
1430     // + mdCaller);
1431     // If the location of an argument has a composite location
1432     // need to assign a proper composite location to the corresponding callee parameter
1433     Set<Integer> idxSet = mapIdxToArgTuple.keySet();
1434     for (Iterator iterator = idxSet.iterator(); iterator.hasNext();) {
1435       Integer idx = (Integer) iterator.next();
1436
1437       if (idx == 0 && !min.getMethod().isStatic()) {
1438         continue;
1439       }
1440
1441       NTuple<Descriptor> argTuple = mapIdxToArgTuple.get(idx);
1442       // System.out.println("-argTuple=" + argTuple + "   idx=" + idx);
1443       if (argTuple.size() > 0) {
1444         // check if an arg tuple has been already assigned to a composite location
1445         NTuple<Location> argLocTuple = translateToLocTuple(mdCaller, argTuple);
1446         Location argLocalLoc = argLocTuple.get(0);
1447
1448         // if (!isPrimitiveType(argTuple)) {
1449         if (callerMapLocToCompLoc.containsKey(argLocalLoc)) {
1450
1451           CompositeLocation callerCompLoc = callerMapLocToCompLoc.get(argLocalLoc);
1452           for (int i = 1; i < argLocTuple.size(); i++) {
1453             callerCompLoc.addLocation(argLocTuple.get(i));
1454           }
1455
1456           // System.out.println("---callerCompLoc=" + callerCompLoc);
1457
1458           // if (baseLocTuple != null && callerCompLoc.getTuple().startsWith(baseLocTuple)) {
1459
1460           FlowNode calleeParamFlowNode = calleeFlowGraph.getParamFlowNode(idx);
1461
1462           NTuple<Descriptor> calleeParamDescTuple = calleeParamFlowNode.getDescTuple();
1463           NTuple<Location> calleeParamLocTuple =
1464               translateToLocTuple(mdCallee, calleeParamDescTuple);
1465
1466           int refParamIdx = getParamIdx(callerCompLoc, mapIdxToArgTuple);
1467           // System.out.println("-----paramIdx=" + refParamIdx);
1468           if (refParamIdx == 0 && !mdCallee.isStatic()) {
1469
1470             // System.out.println("-------need to translate callerCompLoc=" + callerCompLoc
1471             // + " with baseTuple=" + baseLocTuple + "   calleeParamLocTuple="
1472             // + calleeParamLocTuple);
1473
1474             CompositeLocation newCalleeCompLoc =
1475                 translateCompositeLocationToCallee(callerCompLoc, baseLocTuple, mdCallee);
1476
1477             calleeGlobalGraph.addMapLocationToInferCompositeLocation(calleeParamLocTuple.get(0),
1478                 newCalleeCompLoc);
1479
1480             // System.out.println("---------key=" + calleeParamLocTuple.get(0) + "  callerCompLoc="
1481             // + callerCompLoc + "  newCalleeCompLoc=" + newCalleeCompLoc);
1482
1483           } else if (refParamIdx != -1) {
1484             // the first element of an argument composite location matches with one of paramtere
1485             // composite locations
1486
1487             // System.out.println("-------param match case=");
1488
1489             NTuple<Descriptor> argTupleRef = mapIdxToArgTuple.get(refParamIdx);
1490             FlowNode refParamFlowNode = calleeFlowGraph.getParamFlowNode(refParamIdx);
1491             NTuple<Location> refParamLocTuple =
1492                 translateToLocTuple(mdCallee, refParamFlowNode.getDescTuple());
1493
1494             // System.out.println("---------refParamLocTuple=" + refParamLocTuple
1495             // + "  from argTupleRef=" + argTupleRef);
1496
1497             CompositeLocation newCalleeCompLoc = new CompositeLocation();
1498             for (int i = 0; i < refParamLocTuple.size(); i++) {
1499               newCalleeCompLoc.addLocation(refParamLocTuple.get(i));
1500             }
1501             for (int i = argTupleRef.size(); i < callerCompLoc.getSize(); i++) {
1502               newCalleeCompLoc.addLocation(callerCompLoc.get(i));
1503             }
1504
1505             calleeGlobalGraph.addMapLocationToInferCompositeLocation(calleeParamLocTuple.get(0),
1506                 newCalleeCompLoc);
1507
1508             calleeParamFlowNode.setCompositeLocation(newCalleeCompLoc);
1509             // System.out.println("-----------key=" + calleeParamLocTuple.get(0) +
1510             // "  callerCompLoc="
1511             // + callerCompLoc + "  newCalleeCompLoc=" + newCalleeCompLoc);
1512
1513           } else {
1514             CompositeLocation newCalleeCompLoc =
1515                 calculateCompositeLocationFromSubGlobalGraph(mdCallee, calleeParamFlowNode);
1516             if (newCalleeCompLoc != null) {
1517               calleeGlobalGraph.addMapLocationToInferCompositeLocation(calleeParamLocTuple.get(0),
1518                   newCalleeCompLoc);
1519               calleeParamFlowNode.setCompositeLocation(newCalleeCompLoc);
1520             }
1521           }
1522
1523           // System.out.println("-----------------calleeParamFlowNode="
1524           // + calleeParamFlowNode.getCompositeLocation());
1525
1526           // }
1527
1528         }
1529       }
1530
1531     }
1532
1533   }
1534
1535   private CompositeLocation calculateCompositeLocationFromSubGlobalGraph(MethodDescriptor md,
1536       FlowNode paramNode) {
1537
1538     // System.out.println("#############################################################");
1539     // System.out.println("calculateCompositeLocationFromSubGlobalGraph=" + paramNode);
1540
1541     GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
1542     NTuple<Location> paramLocTuple = translateToLocTuple(md, paramNode.getDescTuple());
1543     GlobalFlowNode paramGlobalNode = subGlobalFlowGraph.getFlowNode(paramLocTuple);
1544
1545     List<NTuple<Location>> prefixList = calculatePrefixList(subGlobalFlowGraph, paramGlobalNode);
1546
1547     Location prefixLoc = paramLocTuple.get(0);
1548
1549     Set<GlobalFlowNode> reachableNodeSet =
1550         subGlobalFlowGraph.getReachableNodeSetByPrefix(paramGlobalNode.getLocTuple().get(0));
1551     // Set<GlobalFlowNode> reachNodeSet = globalFlowGraph.getReachableNodeSetFrom(node);
1552
1553     // System.out.println("node=" + node + "    prefixList=" + prefixList);
1554
1555     for (int i = 0; i < prefixList.size(); i++) {
1556       NTuple<Location> curPrefix = prefixList.get(i);
1557       Set<NTuple<Location>> reachableCommonPrefixSet = new HashSet<NTuple<Location>>();
1558
1559       for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
1560         GlobalFlowNode reachNode = (GlobalFlowNode) iterator2.next();
1561         if (reachNode.getLocTuple().startsWith(curPrefix)) {
1562           reachableCommonPrefixSet.add(reachNode.getLocTuple());
1563         }
1564       }
1565       // System.out.println("reachableCommonPrefixSet=" + reachableCommonPrefixSet);
1566
1567       if (!reachableCommonPrefixSet.isEmpty()) {
1568
1569         MethodDescriptor curPrefixFirstElementMethodDesc =
1570             (MethodDescriptor) curPrefix.get(0).getDescriptor();
1571
1572         MethodDescriptor nodePrefixLocFirstElementMethodDesc =
1573             (MethodDescriptor) prefixLoc.getDescriptor();
1574
1575         // System.out.println("curPrefixFirstElementMethodDesc=" +
1576         // curPrefixFirstElementMethodDesc);
1577         // System.out.println("nodePrefixLocFirstElementMethodDesc="
1578         // + nodePrefixLocFirstElementMethodDesc);
1579
1580         if (curPrefixFirstElementMethodDesc.equals(nodePrefixLocFirstElementMethodDesc)
1581             || isTransitivelyCalledFrom(nodePrefixLocFirstElementMethodDesc,
1582                 curPrefixFirstElementMethodDesc)) {
1583
1584           // TODO
1585           // if (!node.getLocTuple().startsWith(curPrefix.get(0))) {
1586
1587           Location curPrefixLocalLoc = curPrefix.get(0);
1588           if (subGlobalFlowGraph.mapLocationToInferCompositeLocation.containsKey(curPrefixLocalLoc)) {
1589             // in this case, the local variable of the current prefix has already got a composite
1590             // location
1591             // so we just ignore the current composite location.
1592
1593             // System.out.println("HERE WE DO NOT ASSIGN A COMPOSITE LOCATION TO =" + node
1594             // + " DUE TO " + curPrefix);
1595             return null;
1596           }
1597
1598           if (!needToGenerateCompositeLocation(paramGlobalNode, curPrefix)) {
1599             // System.out.println("NO NEED TO GENERATE COMP LOC to " + paramGlobalNode
1600             // + " with prefix=" + curPrefix);
1601             return null;
1602           }
1603
1604           Location targetLocalLoc = paramGlobalNode.getLocTuple().get(0);
1605           CompositeLocation newCompLoc = generateCompositeLocation(curPrefix);
1606           // System.out.println("NEED TO ASSIGN COMP LOC TO " + paramGlobalNode + " with prefix="
1607           // + curPrefix);
1608           // System.out.println("-targetLocalLoc=" + targetLocalLoc + "   - newCompLoc=" +
1609           // newCompLoc);
1610
1611           // makes sure that a newly generated location appears in the hierarchy graph
1612           for (int compIdx = 0; compIdx < newCompLoc.getSize(); compIdx++) {
1613             Location curLoc = newCompLoc.get(compIdx);
1614             getHierarchyGraph(curLoc.getDescriptor()).getHNode(curLoc.getLocDescriptor());
1615           }
1616
1617           subGlobalFlowGraph.addMapLocationToInferCompositeLocation(targetLocalLoc, newCompLoc);
1618
1619           return newCompLoc;
1620
1621         }
1622
1623       }
1624
1625     }
1626     return null;
1627   }
1628
1629   private int getParamIdx(CompositeLocation compLoc,
1630       Map<Integer, NTuple<Descriptor>> mapIdxToArgTuple) {
1631
1632     // if the composite location is started with the argument descriptor
1633     // return the argument's index. o.t. return -1
1634
1635     Set<Integer> keySet = mapIdxToArgTuple.keySet();
1636     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
1637       Integer key = (Integer) iterator.next();
1638       NTuple<Descriptor> argTuple = mapIdxToArgTuple.get(key);
1639       if (argTuple.size() > 0 && translateToDescTuple(compLoc.getTuple()).startsWith(argTuple)) {
1640         // System.out.println("compLoc.getTuple=" + compLoc + " is started with " + argTuple);
1641         return key.intValue();
1642       }
1643     }
1644
1645     return -1;
1646   }
1647
1648   private boolean isPrimitiveType(NTuple<Descriptor> argTuple) {
1649
1650     Descriptor lastDesc = argTuple.get(argTuple.size() - 1);
1651
1652     if (lastDesc instanceof FieldDescriptor) {
1653       return ((FieldDescriptor) lastDesc).getType().isPrimitive();
1654     } else if (lastDesc instanceof VarDescriptor) {
1655       return ((VarDescriptor) lastDesc).getType().isPrimitive();
1656     } else if (lastDesc instanceof InterDescriptor) {
1657       return true;
1658     }
1659
1660     return false;
1661   }
1662
1663   private CompositeLocation translateCompositeLocationToCallee(CompositeLocation callerCompLoc,
1664       NTuple<Location> baseLocTuple, MethodDescriptor mdCallee) {
1665
1666     CompositeLocation newCalleeCompLoc = new CompositeLocation();
1667
1668     Location calleeThisLoc = new Location(mdCallee, mdCallee.getThis());
1669     newCalleeCompLoc.addLocation(calleeThisLoc);
1670
1671     // remove the base tuple from the caller
1672     // ex; In the method invoation foo.bar.methodA(), the callee will have the composite location
1673     // ,which is relative to the 'this' variable, <THIS,...>
1674     for (int i = baseLocTuple.size(); i < callerCompLoc.getSize(); i++) {
1675       newCalleeCompLoc.addLocation(callerCompLoc.get(i));
1676     }
1677
1678     return newCalleeCompLoc;
1679
1680   }
1681
1682   private void calculateGlobalValueFlowCompositeLocation() {
1683
1684     System.out.println("SSJAVA: Calculate composite locations in the global value flow graph");
1685     MethodDescriptor methodDescEventLoop = ssjava.getMethodContainingSSJavaLoop();
1686     GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(methodDescEventLoop);
1687
1688     Set<Location> calculatedPrefixSet = new HashSet<Location>();
1689
1690     Set<GlobalFlowNode> nodeSet = globalFlowGraph.getNodeSet();
1691
1692     next: for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
1693       GlobalFlowNode node = (GlobalFlowNode) iterator.next();
1694
1695       Location prefixLoc = node.getLocTuple().get(0);
1696
1697       if (calculatedPrefixSet.contains(prefixLoc)) {
1698         // the prefix loc has been already assigned to a composite location
1699         continue;
1700       }
1701
1702       calculatedPrefixSet.add(prefixLoc);
1703
1704       // Set<GlobalFlowNode> incomingNodeSet = globalFlowGraph.getIncomingNodeSet(node);
1705       List<NTuple<Location>> prefixList = calculatePrefixList(globalFlowGraph, node);
1706
1707       Set<GlobalFlowNode> reachableNodeSet =
1708           globalFlowGraph.getReachableNodeSetByPrefix(node.getLocTuple().get(0));
1709       // Set<GlobalFlowNode> reachNodeSet = globalFlowGraph.getReachableNodeSetFrom(node);
1710
1711       // System.out.println("node=" + node + "    prefixList=" + prefixList);
1712       // System.out.println("---prefixList=" + prefixList);
1713
1714       nextprefix: for (int i = 0; i < prefixList.size(); i++) {
1715         NTuple<Location> curPrefix = prefixList.get(i);
1716         // System.out.println("---curPrefix=" + curPrefix);
1717         Set<NTuple<Location>> reachableCommonPrefixSet = new HashSet<NTuple<Location>>();
1718
1719         for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
1720           GlobalFlowNode reachNode = (GlobalFlowNode) iterator2.next();
1721           if (reachNode.getLocTuple().startsWith(curPrefix)) {
1722             reachableCommonPrefixSet.add(reachNode.getLocTuple());
1723           }
1724         }
1725         // System.out.println("reachableCommonPrefixSet=" + reachableCommonPrefixSet);
1726
1727         if (!reachableCommonPrefixSet.isEmpty()) {
1728
1729           MethodDescriptor curPrefixFirstElementMethodDesc =
1730               (MethodDescriptor) curPrefix.get(0).getDescriptor();
1731
1732           MethodDescriptor nodePrefixLocFirstElementMethodDesc =
1733               (MethodDescriptor) prefixLoc.getDescriptor();
1734
1735           // System.out.println("curPrefixFirstElementMethodDesc=" +
1736           // curPrefixFirstElementMethodDesc);
1737           // System.out.println("nodePrefixLocFirstElementMethodDesc="
1738           // + nodePrefixLocFirstElementMethodDesc);
1739
1740           if (curPrefixFirstElementMethodDesc.equals(nodePrefixLocFirstElementMethodDesc)
1741               || isTransitivelyCalledFrom(nodePrefixLocFirstElementMethodDesc,
1742                   curPrefixFirstElementMethodDesc)) {
1743
1744             // TODO
1745             // if (!node.getLocTuple().startsWith(curPrefix.get(0))) {
1746
1747             Location curPrefixLocalLoc = curPrefix.get(0);
1748             if (globalFlowGraph.mapLocationToInferCompositeLocation.containsKey(curPrefixLocalLoc)) {
1749               // in this case, the local variable of the current prefix has already got a composite
1750               // location
1751               // so we just ignore the current composite location.
1752
1753               // System.out.println("HERE WE DO NOT ASSIGN A COMPOSITE LOCATION TO =" + node
1754               // + " DUE TO " + curPrefix);
1755
1756               continue next;
1757             }
1758
1759             if (!needToGenerateCompositeLocation(node, curPrefix)) {
1760               // System.out.println("NO NEED TO GENERATE COMP LOC to " + node + " with prefix="
1761               // + curPrefix);
1762               // System.out.println("prefixList=" + prefixList);
1763               // System.out.println("reachableNodeSet=" + reachableNodeSet);
1764               continue nextprefix;
1765             }
1766
1767             Location targetLocalLoc = node.getLocTuple().get(0);
1768             CompositeLocation newCompLoc = generateCompositeLocation(curPrefix);
1769             // System.out.println("NEED TO ASSIGN COMP LOC TO " + node + " with prefix=" +
1770             // curPrefix);
1771             // System.out.println("-targetLocalLoc=" + targetLocalLoc + "   - newCompLoc="
1772             // + newCompLoc);
1773             globalFlowGraph.addMapLocationToInferCompositeLocation(targetLocalLoc, newCompLoc);
1774             // }
1775
1776             continue next;
1777             // }
1778
1779           }
1780
1781         }
1782
1783       }
1784
1785     }
1786   }
1787
1788   private boolean checkFlowNodeReturnThisField(MethodDescriptor md) {
1789
1790     MethodDescriptor methodDescEventLoop = ssjava.getMethodContainingSSJavaLoop();
1791     GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(methodDescEventLoop);
1792
1793     FlowGraph flowGraph = getFlowGraph(md);
1794
1795     ClassDescriptor enclosingDesc = getClassTypeDescriptor(md.getThis());
1796     if (enclosingDesc == null) {
1797       return false;
1798     }
1799
1800     int count = 0;
1801     Set<FlowNode> returnNodeSet = flowGraph.getReturnNodeSet();
1802     Set<GlobalFlowNode> globalReturnNodeSet = new HashSet<GlobalFlowNode>();
1803     for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
1804       FlowNode flowNode = (FlowNode) iterator.next();
1805       NTuple<Location> locTuple = translateToLocTuple(md, flowNode.getDescTuple());
1806       GlobalFlowNode globalReturnNode = globalFlowGraph.getFlowNode(locTuple);
1807       globalReturnNodeSet.add(globalReturnNode);
1808
1809       List<NTuple<Location>> prefixList = calculatePrefixList(globalFlowGraph, globalReturnNode);
1810       for (int i = 0; i < prefixList.size(); i++) {
1811         NTuple<Location> curPrefix = prefixList.get(i);
1812         ClassDescriptor cd =
1813             getClassTypeDescriptor(curPrefix.get(curPrefix.size() - 1).getLocDescriptor());
1814         if (cd != null && cd.equals(enclosingDesc)) {
1815           count++;
1816           break;
1817         }
1818       }
1819
1820     }
1821
1822     if (count == returnNodeSet.size()) {
1823       // in this case, all return nodes in the method returns values coming from a location that
1824       // starts with "this"
1825
1826       // System.out.println("$$$SET RETURN LOC TRUE=" + md);
1827       mapMethodDescriptorToCompositeReturnCase.put(md, Boolean.TRUE);
1828
1829       // NameDescriptor returnLocDesc = new NameDescriptor("RLOC" + (locSeed++));
1830       // NTuple<Descriptor> rDescTuple = new NTuple<Descriptor>();
1831       // rDescTuple.add(md.getThis());
1832       // rDescTuple.add(returnLocDesc);
1833       //
1834       // for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
1835       // FlowNode rnode = (FlowNode) iterator.next();
1836       // flowGraph.addValueFlowEdge(rnode.getDescTuple(), rDescTuple);
1837       // }
1838       //
1839       // getMethodSummary(md).setRETURNLoc(new CompositeLocation(translateToLocTuple(md,
1840       // rDescTuple)));
1841
1842     } else {
1843       mapMethodDescriptorToCompositeReturnCase.put(md, Boolean.FALSE);
1844     }
1845
1846     return mapMethodDescriptorToCompositeReturnCase.get(md).booleanValue();
1847
1848   }
1849
1850   private boolean needToGenerateCompositeLocation(GlobalFlowNode node, NTuple<Location> curPrefix) {
1851     // return true if there is a path between a node to which we want to give a composite location
1852     // and nodes which start with curPrefix
1853
1854     // System.out.println("---needToGenerateCompositeLocation curPrefix=" + curPrefix);
1855
1856     Location targetLocalLoc = node.getLocTuple().get(0);
1857
1858     MethodDescriptor md = (MethodDescriptor) targetLocalLoc.getDescriptor();
1859     FlowGraph flowGraph = getFlowGraph(md);
1860
1861     FlowNode flowNode = flowGraph.getFlowNode(node.getDescTuple());
1862     Set<FlowNode> reachableSet = flowGraph.getReachFlowNodeSetFrom(flowNode);
1863
1864     Set<FlowNode> paramNodeSet = flowGraph.getParamFlowNodeSet();
1865     for (Iterator iterator = paramNodeSet.iterator(); iterator.hasNext();) {
1866       FlowNode paramFlowNode = (FlowNode) iterator.next();
1867       if (curPrefix.startsWith(translateToLocTuple(md, paramFlowNode.getDescTuple()))) {
1868         return true;
1869       }
1870     }
1871
1872     if (targetLocalLoc.getLocDescriptor() instanceof InterDescriptor) {
1873       Pair<MethodInvokeNode, Integer> pair =
1874           ((InterDescriptor) targetLocalLoc.getLocDescriptor()).getMethodArgIdxPair();
1875
1876       if (pair != null) {
1877         // System.out.println("$$$TARGETLOCALLOC HOLDER=" + targetLocalLoc);
1878
1879         MethodInvokeNode min = pair.getFirst();
1880         Integer paramIdx = pair.getSecond();
1881         MethodDescriptor mdCallee = min.getMethod();
1882
1883         FlowNode paramNode = getFlowGraph(mdCallee).getParamFlowNode(paramIdx);
1884         if (checkNodeReachToReturnNode(mdCallee, paramNode)) {
1885           return true;
1886         }
1887
1888       }
1889
1890     }
1891
1892     GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
1893     Set<GlobalFlowNode> subGlobalReachableSet = subGlobalFlowGraph.getReachableNodeSetFrom(node);
1894
1895     if (!md.isStatic()) {
1896       ClassDescriptor currentMethodThisType = getClassTypeDescriptor(md.getThis());
1897       for (int i = 0; i < curPrefix.size(); i++) {
1898         ClassDescriptor prefixType = getClassTypeDescriptor(curPrefix.get(i).getLocDescriptor());
1899         if (prefixType != null && prefixType.equals(currentMethodThisType)) {
1900           // System.out.println("PREFIX TYPE MATCHES WITH=" + currentMethodThisType);
1901
1902           if (mapMethodDescriptorToCompositeReturnCase.containsKey(md)) {
1903             boolean hasCompReturnLocWithThis =
1904                 mapMethodDescriptorToCompositeReturnCase.get(md).booleanValue();
1905             if (hasCompReturnLocWithThis) {
1906               if (checkNodeReachToReturnNode(md, flowNode)) {
1907                 return true;
1908               }
1909             }
1910           }
1911
1912           for (Iterator iterator3 = subGlobalReachableSet.iterator(); iterator3.hasNext();) {
1913             GlobalFlowNode subGlobalReachalbeNode = (GlobalFlowNode) iterator3.next();
1914             if (subGlobalReachalbeNode.getLocTuple().get(0).getLocDescriptor().equals(md.getThis())) {
1915               // System.out.println("PREFIX FOUND=" + subGlobalReachalbeNode);
1916               return true;
1917             }
1918           }
1919         }
1920       }
1921     }
1922
1923     Location lastLocationOfPrefix = curPrefix.get(curPrefix.size() - 1);
1924     // check whether prefix appears in the list of parameters
1925     Set<MethodInvokeNode> minSet = mapMethodDescToMethodInvokeNodeSet.get(md);
1926     // System.out.println("$$$md=" + md + "   minSet=" + minSet);
1927     if (minSet == null) {
1928       return false;
1929     }
1930     found: for (Iterator iterator = minSet.iterator(); iterator.hasNext();) {
1931       MethodInvokeNode min = (MethodInvokeNode) iterator.next();
1932       Map<Integer, NTuple<Descriptor>> map = mapMethodInvokeNodeToArgIdxMap.get(min);
1933       Set<Integer> keySet = map.keySet();
1934       // System.out.println("min=" + min.printNode(0));
1935
1936       for (Iterator iterator2 = keySet.iterator(); iterator2.hasNext();) {
1937         Integer argIdx = (Integer) iterator2.next();
1938         NTuple<Descriptor> argTuple = map.get(argIdx);
1939
1940         if (!(!md.isStatic() && argIdx == 0)) {
1941           // if the argTuple is empty, we don't need to do with anything(LITERAL CASE).
1942           if (argTuple.size() > 0
1943               && argTuple.get(argTuple.size() - 1).equals(lastLocationOfPrefix.getLocDescriptor())) {
1944             NTuple<Location> locTuple =
1945                 translateToLocTuple(md, flowGraph.getParamFlowNode(argIdx).getDescTuple());
1946             lastLocationOfPrefix = locTuple.get(0);
1947             // System.out.println("ARG CASE=" + locTuple);
1948             for (Iterator iterator3 = subGlobalReachableSet.iterator(); iterator3.hasNext();) {
1949               GlobalFlowNode subGlobalReachalbeNode = (GlobalFlowNode) iterator3.next();
1950               // NTuple<Location> locTuple = translateToLocTuple(md, reachalbeNode.getDescTuple());
1951               NTuple<Location> globalReachlocTuple = subGlobalReachalbeNode.getLocTuple();
1952               for (int i = 0; i < globalReachlocTuple.size(); i++) {
1953                 if (globalReachlocTuple.get(i).equals(lastLocationOfPrefix)) {
1954                   // System.out.println("ARG  " + argTuple + "  IS MATCHED WITH="
1955                   // + lastLocationOfPrefix);
1956                   return true;
1957                 }
1958               }
1959             }
1960           }
1961         }
1962       }
1963     }
1964
1965     return false;
1966   }
1967
1968   private boolean checkNodeReachToReturnNode(MethodDescriptor md, FlowNode node) {
1969
1970     FlowGraph flowGraph = getFlowGraph(md);
1971     Set<FlowNode> reachableSet = flowGraph.getReachFlowNodeSetFrom(node);
1972     if (mapMethodDescriptorToCompositeReturnCase.containsKey(md)) {
1973       boolean hasCompReturnLocWithThis =
1974           mapMethodDescriptorToCompositeReturnCase.get(md).booleanValue();
1975
1976       if (hasCompReturnLocWithThis) {
1977         for (Iterator iterator = flowGraph.getReturnNodeSet().iterator(); iterator.hasNext();) {
1978           FlowNode returnFlowNode = (FlowNode) iterator.next();
1979           if (reachableSet.contains(returnFlowNode)) {
1980             return true;
1981           }
1982         }
1983       }
1984     }
1985     return false;
1986   }
1987
1988   private void assignCompositeLocation(CompositeLocation compLocPrefix, GlobalFlowNode node) {
1989     CompositeLocation newCompLoc = compLocPrefix.clone();
1990     NTuple<Location> locTuple = node.getLocTuple();
1991     for (int i = 1; i < locTuple.size(); i++) {
1992       newCompLoc.addLocation(locTuple.get(i));
1993     }
1994     node.setInferCompositeLocation(newCompLoc);
1995   }
1996
1997   private List<NTuple<Location>> calculatePrefixList(GlobalFlowGraph graph, GlobalFlowNode node) {
1998
1999     // System.out.println("\n##### calculatePrefixList node=" + node);
2000
2001     Set<GlobalFlowNode> incomingNodeSetPrefix =
2002         graph.getIncomingNodeSetByPrefix(node.getLocTuple().get(0));
2003     // System.out.println("---incomingNodeSetPrefix=" + incomingNodeSetPrefix);
2004
2005     Set<GlobalFlowNode> reachableNodeSetPrefix =
2006         graph.getReachableNodeSetByPrefix(node.getLocTuple().get(0));
2007     // System.out.println("---reachableNodeSetPrefix=" + reachableNodeSetPrefix);
2008
2009     List<NTuple<Location>> prefixList = new ArrayList<NTuple<Location>>();
2010
2011     for (Iterator iterator = incomingNodeSetPrefix.iterator(); iterator.hasNext();) {
2012       GlobalFlowNode inNode = (GlobalFlowNode) iterator.next();
2013       NTuple<Location> inNodeTuple = inNode.getLocTuple();
2014
2015       if (inNodeTuple.get(0).getLocDescriptor() instanceof InterDescriptor
2016           || inNodeTuple.get(0).getLocDescriptor().equals(GLOBALDESC)) {
2017         continue;
2018       }
2019
2020       for (int i = 1; i < inNodeTuple.size(); i++) {
2021         NTuple<Location> prefix = inNodeTuple.subList(0, i);
2022         if (!prefixList.contains(prefix)) {
2023           prefixList.add(prefix);
2024         }
2025       }
2026     }
2027
2028     Collections.sort(prefixList, new Comparator<NTuple<Location>>() {
2029       public int compare(NTuple<Location> arg0, NTuple<Location> arg1) {
2030         int s0 = arg0.size();
2031         int s1 = arg1.size();
2032         if (s0 > s1) {
2033           return -1;
2034         } else if (s0 == s1) {
2035           return 0;
2036         } else {
2037           return 1;
2038         }
2039       }
2040     });
2041
2042     return prefixList;
2043
2044   }
2045
2046   private CompositeLocation calculateCompositeLocationFromFlowGraph(MethodDescriptor md,
2047       FlowNode node) {
2048
2049     // System.out.println("#############################################################");
2050     // System.out.println("calculateCompositeLocationFromFlowGraph=" + node);
2051
2052     FlowGraph flowGraph = getFlowGraph(md);
2053     // NTuple<Location> paramLocTuple = translateToLocTuple(md, paramNode.getDescTuple());
2054     // GlobalFlowNode paramGlobalNode = subGlobalFlowGraph.getFlowNode(paramLocTuple);
2055
2056     List<NTuple<Location>> prefixList = calculatePrefixListFlowGraph(flowGraph, node);
2057
2058     // Set<GlobalFlowNode> reachableNodeSet =
2059     // subGlobalFlowGraph.getReachableNodeSetByPrefix(paramGlobalNode.getLocTuple().get(0));
2060     //
2061     Set<FlowNode> reachableNodeSet =
2062         flowGraph.getReachableSetFrom(node.getDescTuple().subList(0, 1));
2063
2064     // Set<GlobalFlowNode> reachNodeSet = globalFlowGraph.getReachableNodeSetFrom(node);
2065
2066     // System.out.println("node=" + node + "    prefixList=" + prefixList);
2067
2068     for (int i = 0; i < prefixList.size(); i++) {
2069       NTuple<Location> curPrefix = prefixList.get(i);
2070       Set<NTuple<Location>> reachableCommonPrefixSet = new HashSet<NTuple<Location>>();
2071
2072       for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
2073         FlowNode reachNode = (FlowNode) iterator2.next();
2074         NTuple<Location> reachLocTuple = translateToLocTuple(md, reachNode.getCurrentDescTuple());
2075         if (reachLocTuple.startsWith(curPrefix)) {
2076           reachableCommonPrefixSet.add(reachLocTuple);
2077         }
2078       }
2079       // System.out.println("reachableCommonPrefixSet=" + reachableCommonPrefixSet);
2080
2081       if (!reachableCommonPrefixSet.isEmpty()) {
2082
2083         MethodDescriptor curPrefixFirstElementMethodDesc =
2084             (MethodDescriptor) curPrefix.get(0).getDescriptor();
2085
2086         Location curPrefixLocalLoc = curPrefix.get(0);
2087
2088         Location targetLocalLoc = new Location(md, node.getDescTuple().get(0));
2089         // Location targetLocalLoc = paramGlobalNode.getLocTuple().get(0);
2090
2091         CompositeLocation newCompLoc = generateCompositeLocation(curPrefix);
2092         // System.out.println("NEED2ASSIGN COMP LOC TO " + node + " with prefix=" + curPrefix);
2093         // System.out.println("-targetLocalLoc=" + targetLocalLoc + "   - newCompLoc=" +
2094         // newCompLoc);
2095
2096         node.setCompositeLocation(newCompLoc);
2097
2098         return newCompLoc;
2099
2100       }
2101
2102     }
2103     return null;
2104   }
2105
2106   private List<NTuple<Location>> calculatePrefixListFlowGraph(FlowGraph graph, FlowNode node) {
2107
2108     // System.out.println("\n##### calculatePrefixList node=" + node);
2109
2110     MethodDescriptor md = graph.getMethodDescriptor();
2111     Set<FlowNode> incomingNodeSetPrefix =
2112         graph.getIncomingNodeSetByPrefix(node.getDescTuple().get(0));
2113     // System.out.println("---incomingNodeSetPrefix=" + incomingNodeSetPrefix);
2114
2115     Set<FlowNode> reachableNodeSetPrefix =
2116         graph.getReachableSetFrom(node.getDescTuple().subList(0, 1));
2117     // System.out.println("---reachableNodeSetPrefix=" + reachableNodeSetPrefix);
2118
2119     List<NTuple<Location>> prefixList = new ArrayList<NTuple<Location>>();
2120
2121     for (Iterator iterator = incomingNodeSetPrefix.iterator(); iterator.hasNext();) {
2122       FlowNode inNode = (FlowNode) iterator.next();
2123       NTuple<Location> inNodeTuple = translateToLocTuple(md, inNode.getCurrentDescTuple());
2124
2125       // if (inNodeTuple.get(0).getLocDescriptor() instanceof InterDescriptor
2126       // || inNodeTuple.get(0).getLocDescriptor().equals(GLOBALDESC)) {
2127       // continue;
2128       // }
2129
2130       for (int i = 1; i < inNodeTuple.size(); i++) {
2131         NTuple<Location> prefix = inNodeTuple.subList(0, i);
2132         if (!prefixList.contains(prefix)) {
2133           prefixList.add(prefix);
2134         }
2135       }
2136     }
2137
2138     Collections.sort(prefixList, new Comparator<NTuple<Location>>() {
2139       public int compare(NTuple<Location> arg0, NTuple<Location> arg1) {
2140         int s0 = arg0.size();
2141         int s1 = arg1.size();
2142         if (s0 > s1) {
2143           return -1;
2144         } else if (s0 == s1) {
2145           return 0;
2146         } else {
2147           return 1;
2148         }
2149       }
2150     });
2151
2152     return prefixList;
2153
2154   }
2155
2156   private GlobalFlowGraph constructSubGlobalFlowGraph(FlowGraph flowGraph) {
2157
2158     MethodDescriptor md = flowGraph.getMethodDescriptor();
2159
2160     GlobalFlowGraph globalGraph = getSubGlobalFlowGraph(md);
2161
2162     // Set<FlowNode> nodeSet = flowGraph.getNodeSet();
2163     Set<FlowEdge> edgeSet = flowGraph.getEdgeSet();
2164
2165     for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) {
2166
2167       FlowEdge edge = (FlowEdge) iterator.next();
2168       NTuple<Descriptor> srcDescTuple = edge.getInitTuple();
2169       NTuple<Descriptor> dstDescTuple = edge.getEndTuple();
2170
2171       if (flowGraph.getFlowNode(srcDescTuple) instanceof FlowReturnNode
2172           || flowGraph.getFlowNode(dstDescTuple) instanceof FlowReturnNode) {
2173         continue;
2174       }
2175
2176       // here only keep the first element(method location) of the descriptor
2177       // tuple
2178       NTuple<Location> srcLocTuple = translateToLocTuple(md, srcDescTuple);
2179       NTuple<Location> dstLocTuple = translateToLocTuple(md, dstDescTuple);
2180
2181       globalGraph.addValueFlowEdge(srcLocTuple, dstLocTuple);
2182
2183     }
2184
2185     return globalGraph;
2186   }
2187
2188   private NTuple<Location> translateToLocTuple(MethodDescriptor md, NTuple<Descriptor> descTuple) {
2189
2190     NTuple<Location> locTuple = new NTuple<Location>();
2191
2192     Descriptor enclosingDesc = md;
2193     for (int i = 0; i < descTuple.size(); i++) {
2194       Descriptor desc = descTuple.get(i);
2195
2196       Location loc = new Location(enclosingDesc, desc);
2197       locTuple.add(loc);
2198
2199       if (desc instanceof VarDescriptor) {
2200         enclosingDesc = ((VarDescriptor) desc).getType().getClassDesc();
2201       } else if (desc instanceof FieldDescriptor) {
2202         enclosingDesc = ((FieldDescriptor) desc).getType().getClassDesc();
2203       } else {
2204         enclosingDesc = desc;
2205       }
2206
2207     }
2208
2209     return locTuple;
2210
2211   }
2212
2213   private void addValueFlowsFromCalleeSubGlobalFlowGraph(MethodDescriptor mdCaller) {
2214
2215     // the transformation for a call site propagates flows through parameters
2216     // if the method is virtual, it also grab all relations from any possible
2217     // callees
2218
2219     Set<MethodInvokeNode> setMethodInvokeNode = getMethodInvokeNodeSet(mdCaller);
2220
2221     for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
2222       MethodInvokeNode min = (MethodInvokeNode) iterator.next();
2223       MethodDescriptor mdCallee = min.getMethod();
2224       Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
2225       if (mdCallee.isStatic()) {
2226         setPossibleCallees.add(mdCallee);
2227       } else {
2228         Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getMethods(mdCallee);
2229         // removes method descriptors that are not invoked by the caller
2230         calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller));
2231         setPossibleCallees.addAll(calleeSet);
2232       }
2233
2234       for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) {
2235         MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next();
2236         propagateValueFlowsToCallerFromSubGlobalFlowGraph(min, mdCaller, possibleMdCallee);
2237       }
2238
2239     }
2240
2241   }
2242
2243   private void propagateValueFlowsToCallerFromSubGlobalFlowGraph(MethodInvokeNode min,
2244       MethodDescriptor mdCaller, MethodDescriptor possibleMdCallee) {
2245
2246     // System.out.println("---propagate from " + min.printNode(0) + " to caller=" + mdCaller);
2247     FlowGraph calleeFlowGraph = getFlowGraph(possibleMdCallee);
2248     Map<Integer, NTuple<Descriptor>> mapIdxToArg = mapMethodInvokeNodeToArgIdxMap.get(min);
2249
2250     // System.out.println("-----mapMethodInvokeNodeToArgIdxMap.get(min)="
2251     // + mapMethodInvokeNodeToArgIdxMap.get(min));
2252
2253     Set<Integer> keySet = mapIdxToArg.keySet();
2254     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2255       Integer idx = (Integer) iterator.next();
2256       NTuple<Descriptor> argDescTuple = mapIdxToArg.get(idx);
2257       if (argDescTuple.size() > 0) {
2258         NTuple<Location> argLocTuple = translateToLocTuple(mdCaller, argDescTuple);
2259         NTuple<Descriptor> paramDescTuple = calleeFlowGraph.getParamFlowNode(idx).getDescTuple();
2260         NTuple<Location> paramLocTuple = translateToLocTuple(possibleMdCallee, paramDescTuple);
2261         // System.out.println("-------paramDescTuple=" + paramDescTuple + "->argDescTuple="
2262         // + argDescTuple);
2263         addMapCallerArgToCalleeParam(min, argDescTuple, paramDescTuple);
2264       }
2265     }
2266
2267     // addValueFlowBetweenParametersToCaller(min, mdCaller, possibleMdCallee);
2268
2269     NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
2270     GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(possibleMdCallee);
2271     Set<GlobalFlowNode> calleeNodeSet = calleeSubGlobalGraph.getNodeSet();
2272     for (Iterator iterator = calleeNodeSet.iterator(); iterator.hasNext();) {
2273       GlobalFlowNode calleeNode = (GlobalFlowNode) iterator.next();
2274       addValueFlowFromCalleeNode(min, mdCaller, possibleMdCallee, calleeNode);
2275     }
2276
2277     // System.out.println("$$$GLOBAL PC LOC ADD=" + mdCaller);
2278     Set<NTuple<Location>> pcLocTupleSet = mapMethodInvokeNodeToPCLocTupleSet.get(min);
2279     // System.out.println("---pcLocTupleSet=" + pcLocTupleSet);
2280     GlobalFlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller);
2281     for (Iterator iterator = calleeNodeSet.iterator(); iterator.hasNext();) {
2282       GlobalFlowNode calleeNode = (GlobalFlowNode) iterator.next();
2283       if (calleeNode.isParamNodeWithIncomingFlows()) {
2284         // System.out.println("calleeNode.getLocTuple()" + calleeNode.getLocTuple());
2285         NTuple<Location> callerSrcNodeLocTuple =
2286             translateToCallerLocTuple(min, possibleMdCallee, mdCaller, calleeNode.getLocTuple());
2287         // System.out.println("---callerSrcNodeLocTuple=" + callerSrcNodeLocTuple);
2288         if (callerSrcNodeLocTuple != null && callerSrcNodeLocTuple.size() > 0) {
2289           for (Iterator iterator2 = pcLocTupleSet.iterator(); iterator2.hasNext();) {
2290             NTuple<Location> pcLocTuple = (NTuple<Location>) iterator2.next();
2291
2292             callerSubGlobalGraph.addValueFlowEdge(pcLocTuple, callerSrcNodeLocTuple);
2293           }
2294         }
2295       }
2296
2297     }
2298
2299   }
2300
2301   private void addValueFlowFromCalleeNode(MethodInvokeNode min, MethodDescriptor mdCaller,
2302       MethodDescriptor mdCallee, GlobalFlowNode calleeSrcNode) {
2303
2304     GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(mdCallee);
2305     GlobalFlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller);
2306
2307     // System.out.println("$addValueFlowFromCalleeNode calleeSrcNode=" + calleeSrcNode);
2308
2309     NTuple<Location> callerSrcNodeLocTuple =
2310         translateToCallerLocTuple(min, mdCallee, mdCaller, calleeSrcNode.getLocTuple());
2311     // System.out.println("---callerSrcNodeLocTuple=" + callerSrcNodeLocTuple);
2312
2313     if (callerSrcNodeLocTuple != null && callerSrcNodeLocTuple.size() > 0) {
2314
2315       Set<GlobalFlowNode> outNodeSet = calleeSubGlobalGraph.getOutNodeSet(calleeSrcNode);
2316
2317       for (Iterator iterator = outNodeSet.iterator(); iterator.hasNext();) {
2318         GlobalFlowNode outNode = (GlobalFlowNode) iterator.next();
2319         NTuple<Location> callerDstNodeLocTuple =
2320             translateToCallerLocTuple(min, mdCallee, mdCaller, outNode.getLocTuple());
2321         // System.out.println("outNode=" + outNode + "   callerDstNodeLocTuple="
2322         // + callerDstNodeLocTuple);
2323         if (callerSrcNodeLocTuple != null && callerDstNodeLocTuple != null
2324             && callerSrcNodeLocTuple.size() > 0 && callerDstNodeLocTuple.size() > 0) {
2325           callerSubGlobalGraph.addValueFlowEdge(callerSrcNodeLocTuple, callerDstNodeLocTuple);
2326         }
2327       }
2328     }
2329
2330   }
2331
2332   private NTuple<Location> translateToCallerLocTuple(MethodInvokeNode min,
2333       MethodDescriptor mdCallee, MethodDescriptor mdCaller, NTuple<Location> nodeLocTuple) {
2334     // this method will return the same nodeLocTuple if the corresponding argument is literal
2335     // value.
2336
2337     // System.out.println("translateToCallerLocTuple=" + nodeLocTuple);
2338
2339     FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
2340     NTuple<Descriptor> nodeDescTuple = translateToDescTuple(nodeLocTuple);
2341     if (calleeFlowGraph.isParameter(nodeDescTuple)) {
2342       int paramIdx = calleeFlowGraph.getParamIdx(nodeDescTuple);
2343       NTuple<Descriptor> argDescTuple = mapMethodInvokeNodeToArgIdxMap.get(min).get(paramIdx);
2344
2345       // if (isPrimitive(nodeLocTuple.get(0).getLocDescriptor())) {
2346       // // the type of argument is primitive.
2347       // return nodeLocTuple.clone();
2348       // }
2349       // System.out.println("paramIdx=" + paramIdx + "  argDescTuple=" + argDescTuple + " from min="
2350       // + min.printNode(0));
2351       NTuple<Location> argLocTuple = translateToLocTuple(mdCaller, argDescTuple);
2352
2353       NTuple<Location> callerLocTuple = new NTuple<Location>();
2354
2355       callerLocTuple.addAll(argLocTuple);
2356       for (int i = 1; i < nodeLocTuple.size(); i++) {
2357         callerLocTuple.add(nodeLocTuple.get(i));
2358       }
2359       return callerLocTuple;
2360     } else {
2361       return nodeLocTuple.clone();
2362     }
2363
2364   }
2365
2366   public static boolean isPrimitive(Descriptor desc) {
2367
2368     if (desc instanceof FieldDescriptor) {
2369       return ((FieldDescriptor) desc).getType().isPrimitive();
2370     } else if (desc instanceof VarDescriptor) {
2371       return ((VarDescriptor) desc).getType().isPrimitive();
2372     } else if (desc instanceof InterDescriptor) {
2373       return true;
2374     }
2375
2376     return false;
2377   }
2378
2379   public static boolean isReference(Descriptor desc) {
2380
2381     if (desc instanceof FieldDescriptor) {
2382
2383       TypeDescriptor type = ((FieldDescriptor) desc).getType();
2384       if (type.isArray()) {
2385         return !type.isPrimitive();
2386       } else {
2387         return type.isPtr();
2388       }
2389
2390     } else if (desc instanceof VarDescriptor) {
2391       TypeDescriptor type = ((VarDescriptor) desc).getType();
2392       if (type.isArray()) {
2393         return !type.isPrimitive();
2394       } else {
2395         return type.isPtr();
2396       }
2397     }
2398
2399     return false;
2400   }
2401
2402   private NTuple<Descriptor> translateToDescTuple(NTuple<Location> locTuple) {
2403
2404     NTuple<Descriptor> descTuple = new NTuple<Descriptor>();
2405     for (int i = 0; i < locTuple.size(); i++) {
2406       descTuple.add(locTuple.get(i).getLocDescriptor());
2407     }
2408     return descTuple;
2409
2410   }
2411
2412   public LocationSummary getLocationSummary(Descriptor d) {
2413     if (!mapDescToLocationSummary.containsKey(d)) {
2414       if (d instanceof MethodDescriptor) {
2415         mapDescToLocationSummary.put(d, new MethodSummary((MethodDescriptor) d));
2416       } else if (d instanceof ClassDescriptor) {
2417         mapDescToLocationSummary.put(d, new FieldSummary());
2418       }
2419     }
2420     return mapDescToLocationSummary.get(d);
2421   }
2422
2423   private void generateMethodSummary() {
2424
2425     Set<MethodDescriptor> keySet = md2lattice.keySet();
2426     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2427       MethodDescriptor md = (MethodDescriptor) iterator.next();
2428
2429       System.out.println("\nSSJAVA: generate method summary: " + md);
2430
2431       FlowGraph flowGraph = getFlowGraph(md);
2432       if (flowGraph == null) {
2433         continue;
2434       }
2435       MethodSummary methodSummary = getMethodSummary(md);
2436
2437       HierarchyGraph scGraph = getSkeletonCombinationHierarchyGraph(md);
2438
2439       // set the 'this' reference location
2440       if (!md.isStatic()) {
2441         // System.out.println("setThisLocName=" + scGraph.getHNode(md.getThis()).getName());
2442         methodSummary.setThisLocName(scGraph.getHNode(md.getThis()).getName());
2443       }
2444
2445       // set the 'global' reference location if needed
2446       if (methodSummary.hasGlobalAccess()) {
2447         methodSummary.setGlobalLocName(scGraph.getHNode(GLOBALDESC).getName());
2448       }
2449
2450       // construct a parameter mapping that maps a parameter descriptor to an
2451       // inferred composite location
2452       for (int paramIdx = 0; paramIdx < flowGraph.getNumParameters(); paramIdx++) {
2453         FlowNode flowNode = flowGraph.getParamFlowNode(paramIdx);
2454         CompositeLocation inferredCompLoc =
2455             updateCompositeLocation(flowNode.getCompositeLocation());
2456         // System.out.println("-paramIdx=" + paramIdx + "   infer=" + inferredCompLoc + " original="
2457         // + flowNode.getCompositeLocation());
2458
2459         Descriptor localVarDesc = flowNode.getDescTuple().get(0);
2460         methodSummary.addMapVarNameToInferCompLoc(localVarDesc, inferredCompLoc);
2461         methodSummary.addMapParamIdxToInferLoc(paramIdx, inferredCompLoc);
2462       }
2463
2464     }
2465
2466   }
2467
2468   private boolean hasOrderingRelation(NTuple<Location> locTuple1, NTuple<Location> locTuple2) {
2469
2470     int size = locTuple1.size() >= locTuple2.size() ? locTuple2.size() : locTuple1.size();
2471
2472     for (int idx = 0; idx < size; idx++) {
2473       Location loc1 = locTuple1.get(idx);
2474       Location loc2 = locTuple2.get(idx);
2475
2476       Descriptor desc1 = loc1.getDescriptor();
2477       Descriptor desc2 = loc2.getDescriptor();
2478
2479       if (!desc1.equals(desc2)) {
2480         throw new Error("Fail to compare " + locTuple1 + " and " + locTuple2);
2481       }
2482
2483       Descriptor locDesc1 = loc1.getLocDescriptor();
2484       Descriptor locDesc2 = loc2.getLocDescriptor();
2485
2486       HierarchyGraph hierarchyGraph = getHierarchyGraph(desc1);
2487
2488       HNode node1 = hierarchyGraph.getHNode(locDesc1);
2489       HNode node2 = hierarchyGraph.getHNode(locDesc2);
2490
2491       // System.out.println("---node1=" + node1 + "  node2=" + node2);
2492       // System.out.println("---hierarchyGraph.getIncomingNodeSet(node2)="
2493       // + hierarchyGraph.getIncomingNodeSet(node2));
2494
2495       if (locDesc1.equals(locDesc2)) {
2496         continue;
2497       } else if (!hierarchyGraph.getIncomingNodeSet(node2).contains(node1)
2498           && !hierarchyGraph.getIncomingNodeSet(node1).contains(node2)) {
2499         return false;
2500       } else {
2501         return true;
2502       }
2503
2504     }
2505
2506     return false;
2507
2508   }
2509
2510   private boolean isHigherThan(NTuple<Location> locTuple1, NTuple<Location> locTuple2) {
2511
2512     int size = locTuple1.size() >= locTuple2.size() ? locTuple2.size() : locTuple1.size();
2513
2514     for (int idx = 0; idx < size; idx++) {
2515       Location loc1 = locTuple1.get(idx);
2516       Location loc2 = locTuple2.get(idx);
2517
2518       Descriptor desc1 = loc1.getDescriptor();
2519       Descriptor desc2 = loc2.getDescriptor();
2520
2521       if (!desc1.equals(desc2)) {
2522         throw new Error("Fail to compare " + locTuple1 + " and " + locTuple2);
2523       }
2524
2525       Descriptor locDesc1 = loc1.getLocDescriptor();
2526       Descriptor locDesc2 = loc2.getLocDescriptor();
2527
2528       HierarchyGraph hierarchyGraph = getHierarchyGraph(desc1);
2529
2530       HNode node1 = hierarchyGraph.getHNode(locDesc1);
2531       HNode node2 = hierarchyGraph.getHNode(locDesc2);
2532
2533       // System.out.println("---node1=" + node1 + "  node2=" + node2);
2534       // System.out.println("---hierarchyGraph.getIncomingNodeSet(node2)="
2535       // + hierarchyGraph.getIncomingNodeSet(node2));
2536
2537       if (locDesc1.equals(locDesc2)) {
2538         continue;
2539       } else if (hierarchyGraph.getIncomingNodeSet(node2).contains(node1)) {
2540         return true;
2541       } else {
2542         return false;
2543       }
2544
2545     }
2546
2547     return false;
2548   }
2549
2550   private void debug_writeLattices() {
2551
2552     Set<Descriptor> keySet = mapDescriptorToSimpleLattice.keySet();
2553     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2554       Descriptor key = (Descriptor) iterator.next();
2555       SSJavaLattice<String> simpleLattice = mapDescriptorToSimpleLattice.get(key);
2556       // HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(key);
2557       HierarchyGraph scHierarchyGraph = getSkeletonCombinationHierarchyGraph(key);
2558       if (key instanceof ClassDescriptor) {
2559         writeInferredLatticeDotFile((ClassDescriptor) key, simpleLattice, "_SIMPLE");
2560       } else if (key instanceof MethodDescriptor) {
2561         MethodDescriptor md = (MethodDescriptor) key;
2562         writeInferredLatticeDotFile(md.getClassDesc(), md, simpleLattice, "_SIMPLE");
2563       }
2564
2565       LocationSummary ls = getLocationSummary(key);
2566       // System.out.println("####LOC SUMMARY=" + key + "\n" + ls.getMapHNodeNameToLocationName());
2567     }
2568
2569     Set<ClassDescriptor> cdKeySet = cd2lattice.keySet();
2570     for (Iterator iterator = cdKeySet.iterator(); iterator.hasNext();) {
2571       ClassDescriptor cd = (ClassDescriptor) iterator.next();
2572       // System.out.println("########cd=" + cd);
2573       writeInferredLatticeDotFile((ClassDescriptor) cd, cd2lattice.get(cd), "");
2574       COUNT += cd2lattice.get(cd).getKeySet().size();
2575     }
2576
2577     Set<MethodDescriptor> mdKeySet = md2lattice.keySet();
2578     for (Iterator iterator = mdKeySet.iterator(); iterator.hasNext();) {
2579       MethodDescriptor md = (MethodDescriptor) iterator.next();
2580       writeInferredLatticeDotFile(md.getClassDesc(), md, md2lattice.get(md), "");
2581       COUNT += md2lattice.get(md).getKeySet().size();
2582     }
2583     System.out.println("###COUNT=" + COUNT);
2584
2585     Set<Descriptor> descKeySet = desc2naiveLattice.keySet();
2586     for (Iterator iterator = descKeySet.iterator(); iterator.hasNext();) {
2587       Descriptor desc = (Descriptor) iterator.next();
2588       // System.out.println("########cd=" + cd);
2589
2590       ClassDescriptor cd_naive;
2591       MethodDescriptor md_naive;
2592       if (desc instanceof ClassDescriptor) {
2593         cd_naive = (ClassDescriptor) desc;
2594         md_naive = null;
2595       } else {
2596         md_naive = (MethodDescriptor) desc;
2597         cd_naive = md_naive.getClassDesc();
2598       }
2599
2600       writeInferredLatticeDotFile(cd_naive, md_naive, desc2naiveLattice.get(desc), "_naive");
2601     }
2602   }
2603
2604   private void buildLattice(Descriptor desc) {
2605     // System.out.println("buildLattice=" + desc);
2606     SSJavaLattice<String> simpleLattice = buildLattice.buildLattice(desc);
2607
2608     addMapDescToSimpleLattice(desc, simpleLattice);
2609
2610     if (desc instanceof ClassDescriptor) {
2611       writeInferredLatticeDotFile((ClassDescriptor) desc, null, simpleLattice, "_SC");
2612     } else {
2613       MethodDescriptor md = (MethodDescriptor) desc;
2614       writeInferredLatticeDotFile(md.getClassDesc(), md, simpleLattice, "_SC");
2615     }
2616
2617     HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
2618
2619     // System.out.println("\n## insertIntermediateNodesToStraightLine:"
2620     // + simpleHierarchyGraph.getName());
2621     SSJavaLattice<String> lattice =
2622         buildLattice.insertIntermediateNodesToStraightLine(desc, simpleLattice);
2623
2624     if (lattice == null) {
2625       return;
2626     }
2627     lattice.removeRedundantEdges();
2628
2629     LocationInference.numLocationsSInfer += lattice.getKeySet().size();
2630
2631     if (desc instanceof ClassDescriptor) {
2632       // field lattice
2633       cd2lattice.put((ClassDescriptor) desc, lattice);
2634       // ssjava.writeLatticeDotFile((ClassDescriptor) desc, null, lattice);
2635     } else if (desc instanceof MethodDescriptor) {
2636       // method lattice
2637       md2lattice.put((MethodDescriptor) desc, lattice);
2638       MethodDescriptor md = (MethodDescriptor) desc;
2639       ClassDescriptor cd = md.getClassDesc();
2640       // ssjava.writeLatticeDotFile(cd, md, lattice);
2641     }
2642
2643   }
2644
2645   // deprecated: it builds method/class lattices without considering class inheritance
2646   private void buildLattice() {
2647
2648     Set<Descriptor> keySet = mapDescriptorToCombineSkeletonHierarchyGraph.keySet();
2649     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2650       Descriptor desc = (Descriptor) iterator.next();
2651
2652       SSJavaLattice<String> simpleLattice = buildLattice.buildLattice(desc);
2653
2654       addMapDescToSimpleLattice(desc, simpleLattice);
2655
2656       HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
2657       System.out.println("\n## insertIntermediateNodesToStraightLine:"
2658           + simpleHierarchyGraph.getName());
2659       SSJavaLattice<String> lattice =
2660           buildLattice.insertIntermediateNodesToStraightLine(desc, simpleLattice);
2661       lattice.removeRedundantEdges();
2662
2663       LocationInference.numLocationsSInfer += lattice.getKeySet().size();
2664
2665       if (desc instanceof ClassDescriptor) {
2666         // field lattice
2667         cd2lattice.put((ClassDescriptor) desc, lattice);
2668         // ssjava.writeLatticeDotFile((ClassDescriptor) desc, null, lattice);
2669       } else if (desc instanceof MethodDescriptor) {
2670         // method lattice
2671         md2lattice.put((MethodDescriptor) desc, lattice);
2672         MethodDescriptor md = (MethodDescriptor) desc;
2673         ClassDescriptor cd = md.getClassDesc();
2674         // ssjava.writeLatticeDotFile(cd, md, lattice);
2675       }
2676
2677     }
2678
2679   }
2680
2681   private void buildLatticeInheritanceTree() {
2682     // DFS the inheritance tree and propagates lattice nodes/edges from the parent to children
2683     // Node<ClassDescriptor> rootNode = inheritanceTree.getRootNode();
2684     DFSBuildLatticeInheritanceTree(rootClassDescriptor);
2685   }
2686
2687   public Set<ClassDescriptor> getDirectSubClasses(ClassDescriptor parent) {
2688
2689     Set<ClassDescriptor> result = new HashSet<ClassDescriptor>();
2690
2691     Set<ClassDescriptor> children = tu.getDirectSubClasses(parent);
2692     if (children == null) {
2693       children = new HashSet<ClassDescriptor>();
2694     }
2695
2696     for (Iterator iterator = children.iterator(); iterator.hasNext();) {
2697       ClassDescriptor child = (ClassDescriptor) iterator.next();
2698       if (toanalyze_classDescSet.contains(child)) {
2699         result.add(child);
2700       }
2701     }
2702
2703     return result;
2704   }
2705
2706   private void DFSBuildLatticeInheritanceTree(ClassDescriptor cd) {
2707     // ClassDescriptor cd = node.getData();
2708
2709     ClassDescriptor parentClassDesc = cd.getSuperDesc();
2710     if (parentClassDesc != null) {
2711       Map<TripleItem, String> parentMap = buildLattice.getIntermediateLocMap(parentClassDesc);
2712       buildLattice.setIntermediateLocMap(cd, parentMap);
2713     }
2714
2715     buildLattice(cd);
2716
2717     for (Iterator iterator = cd.getMethods(); iterator.hasNext();) {
2718       MethodDescriptor md = (MethodDescriptor) iterator.next();
2719       if (toanalyze_methodDescList.contains(md)) {
2720         MethodDescriptor parentMethodDesc = getParentMethodDesc(md.getClassDesc(), md);
2721         if (parentMethodDesc != null) {
2722           Map<TripleItem, String> parentMap = buildLattice.getIntermediateLocMap(parentMethodDesc);
2723           Map<TripleItem, String> childMap = new HashMap<TripleItem, String>();
2724           Set<TripleItem> keySet = parentMap.keySet();
2725           for (Iterator iterator2 = keySet.iterator(); iterator2.hasNext();) {
2726             TripleItem key = (TripleItem) iterator2.next();
2727             childMap.put(key, parentMap.get(key));
2728           }
2729           buildLattice.setIntermediateLocMap(md, childMap);
2730         }
2731         buildLattice(md);
2732       }
2733     }
2734
2735     // traverse children
2736     Set<ClassDescriptor> children = tu.getDirectSubClasses(cd);
2737     if (children != null) {
2738       for (Iterator iterator = children.iterator(); iterator.hasNext();) {
2739         ClassDescriptor classDescriptor = (ClassDescriptor) iterator.next();
2740         if (toanalyze_classDescSet.contains(classDescriptor)) {
2741           DFSBuildLatticeInheritanceTree(classDescriptor);
2742         } else {
2743           if (classDescriptor.isAbstract()) {
2744             DFSBuildLatticeInheritanceTree(classDescriptor);
2745           }
2746         }
2747       }
2748     }
2749
2750   }
2751
2752   public void addMapDescToSimpleLattice(Descriptor desc, SSJavaLattice<String> lattice) {
2753     mapDescriptorToSimpleLattice.put(desc, lattice);
2754   }
2755
2756   public SSJavaLattice<String> getSimpleLattice(Descriptor desc) {
2757     return mapDescriptorToSimpleLattice.get(desc);
2758   }
2759
2760   private void simplifyHierarchyGraph() {
2761     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2762     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2763       Descriptor desc = (Descriptor) iterator.next();
2764       // System.out.println("SSJAVA: remove redundant edges: " + desc);
2765       HierarchyGraph simpleHierarchyGraph = getHierarchyGraph(desc).clone();
2766       simpleHierarchyGraph.setName(desc + "_SIMPLE");
2767       simpleHierarchyGraph.removeRedundantEdges();
2768       mapDescriptorToSimpleHierarchyGraph.put(desc, simpleHierarchyGraph);
2769     }
2770   }
2771
2772   private void insertCombinationNodes() {
2773     Set<Descriptor> keySet = mapDescriptorToSkeletonHierarchyGraph.keySet();
2774     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2775       Descriptor desc = (Descriptor) iterator.next();
2776       System.out.println("\nSSJAVA: Inserting Combination Nodes:" + desc);
2777       HierarchyGraph skeletonGraph = getSkeletonHierarchyGraph(desc);
2778       HierarchyGraph skeletonGraphWithCombinationNode = skeletonGraph.clone();
2779       skeletonGraphWithCombinationNode.setName(desc + "_SC");
2780
2781       HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
2782       skeletonGraphWithCombinationNode.insertCombinationNodesToGraph(simpleHierarchyGraph);
2783       // skeletonGraphWithCombinationNode.insertCombinationNodesToGraph(simpleHierarchyGraph,
2784       // skeletonGraph);
2785       // skeletonGraphWithCombinationNode.simplifySkeletonCombinationHierarchyGraph();
2786       skeletonGraphWithCombinationNode.removeRedundantEdges();
2787       mapDescriptorToCombineSkeletonHierarchyGraph.put(desc, skeletonGraphWithCombinationNode);
2788     }
2789   }
2790
2791   private void constructSkeletonHierarchyGraph() {
2792     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2793     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2794       Descriptor desc = (Descriptor) iterator.next();
2795       System.out.println("SSJAVA: Constructing Skeleton Hierarchy Graph: " + desc);
2796       HierarchyGraph simpleGraph = getSimpleHierarchyGraph(desc);
2797       HierarchyGraph skeletonGraph = simpleGraph.generateSkeletonGraph();
2798       skeletonGraph.setMapDescToHNode(simpleGraph.getMapDescToHNode());
2799       skeletonGraph.setMapHNodeToDescSet(simpleGraph.getMapHNodeToDescSet());
2800       skeletonGraph.simplifyHierarchyGraph(this);
2801       mapDescriptorToSkeletonHierarchyGraph.put(desc, skeletonGraph);
2802     }
2803   }
2804
2805   private void recurUpAccumulateInheritanceDesc(Descriptor curDesc, Set<Descriptor> set) {
2806
2807     if (curDesc instanceof ClassDescriptor) {
2808       ClassDescriptor cd = (ClassDescriptor) curDesc;
2809       ClassDescriptor parentClassDesc = cd.getSuperDesc();
2810       if (parentClassDesc != null && !parentClassDesc.equals(rootClassDescriptor)) {
2811         set.add(parentClassDesc);
2812         recurUpAccumulateInheritanceDesc(parentClassDesc, set);
2813       }
2814     } else {
2815       MethodDescriptor md = (MethodDescriptor) curDesc;
2816       ClassDescriptor cd = md.getClassDesc();
2817
2818       // traverse up
2819       ClassDescriptor parentClassDesc = cd.getSuperDesc();
2820       if (parentClassDesc != null && !parentClassDesc.equals(rootClassDescriptor)) {
2821
2822         Set<MethodDescriptor> methodDescSet =
2823             parentClassDesc.getMethodTable().getSet(md.getSymbol());
2824         for (Iterator iterator = methodDescSet.iterator(); iterator.hasNext();) {
2825           MethodDescriptor parentMethodDesc = (MethodDescriptor) iterator.next();
2826           if (parentMethodDesc.matches(md)) {
2827             set.add(parentMethodDesc);
2828             recurUpAccumulateInheritanceDesc(parentMethodDesc, set);
2829           }
2830         }
2831       }
2832
2833     }
2834
2835   }
2836
2837   private void recurDownAccumulateInheritanceDesc(Descriptor curDesc, Set<Descriptor> set) {
2838
2839     if (curDesc instanceof ClassDescriptor) {
2840       ClassDescriptor cd = (ClassDescriptor) curDesc;
2841       ClassDescriptor parentClassDesc = cd.getSuperDesc();
2842       Set<ClassDescriptor> directSubClasses = tu.getDirectSubClasses(cd);
2843       for (Iterator iterator = directSubClasses.iterator(); iterator.hasNext();) {
2844         ClassDescriptor child = (ClassDescriptor) iterator.next();
2845         recurDownAccumulateInheritanceDesc(child, set);
2846       }
2847     } else {
2848       MethodDescriptor md = (MethodDescriptor) curDesc;
2849       ClassDescriptor cd = md.getClassDesc();
2850
2851       // traverse down
2852       Set<ClassDescriptor> directSubClasses = tu.getDirectSubClasses(cd);
2853       for (Iterator iterator = directSubClasses.iterator(); iterator.hasNext();) {
2854         ClassDescriptor child = (ClassDescriptor) iterator.next();
2855
2856         Set<MethodDescriptor> methodDescSet = child.getMethodTable().getSet(md.getSymbol());
2857         for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
2858           MethodDescriptor childMethodDesc = (MethodDescriptor) iterator2.next();
2859           if (childMethodDesc.matches(md)) {
2860             set.add(childMethodDesc);
2861             recurDownAccumulateInheritanceDesc(childMethodDesc, set);
2862           }
2863         }
2864       }
2865
2866     }
2867
2868   }
2869
2870   private void accumulateInheritanceDesc(Descriptor curDesc, Set<Descriptor> set) {
2871
2872     recurUpAccumulateInheritanceDesc(curDesc, set);
2873     recurDownAccumulateInheritanceDesc(curDesc, set);
2874
2875   }
2876
2877   public boolean isValidMergeInheritanceCheck(Descriptor desc, Set<HNode> mergeSet) {
2878
2879     // set up inheritance chain set...
2880     Set<Descriptor> inheritanceDescSet = new HashSet<Descriptor>();
2881     recurUpAccumulateInheritanceDesc(desc, inheritanceDescSet);
2882
2883     nextgraph: for (Iterator iterator = inheritanceDescSet.iterator(); iterator.hasNext();) {
2884       Descriptor inheritDesc = (Descriptor) iterator.next();
2885
2886       if (!desc.equals(inheritDesc)) {
2887         HierarchyGraph graph = getSkeletonCombinationHierarchyGraph(inheritDesc);
2888
2889         // first check whether this graph includes all elements of the merge set
2890         for (Iterator iterator2 = mergeSet.iterator(); iterator2.hasNext();) {
2891           HNode node = (HNode) iterator2.next();
2892           if (!graph.contains(node)) {
2893             continue nextgraph;
2894           }
2895         }
2896
2897         HNode firstNode = mergeSet.iterator().next();
2898
2899         Set<HNode> incomingNode = graph.getIncomingNodeSet(firstNode);
2900         Set<HNode> outgoingNode = graph.getOutgoingNodeSet(firstNode);
2901
2902         for (Iterator iterator2 = mergeSet.iterator(); iterator2.hasNext();) {
2903           HNode node = (HNode) iterator2.next();
2904
2905           if (!graph.getIncomingNodeSet(node).equals(incomingNode)
2906               || !graph.getOutgoingNodeSet(node).equals(outgoingNode)) {
2907             return false;
2908           }
2909
2910         }
2911       }
2912
2913     }
2914
2915     return true;
2916   }
2917
2918   private void debug_writeHierarchyDotFiles() {
2919
2920     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2921     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2922       Descriptor desc = (Descriptor) iterator.next();
2923       getHierarchyGraph(desc).writeGraph();
2924     }
2925
2926   }
2927
2928   private void debug_writeSimpleHierarchyDotFiles() {
2929
2930     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2931     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2932       Descriptor desc = (Descriptor) iterator.next();
2933       getHierarchyGraph(desc).writeGraph();
2934       getSimpleHierarchyGraph(desc).writeGraph();
2935       getSimpleHierarchyGraph(desc).writeGraph(true);
2936     }
2937
2938   }
2939
2940   private void debug_writeSkeletonHierarchyDotFiles() {
2941
2942     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2943     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2944       Descriptor desc = (Descriptor) iterator.next();
2945       getSkeletonHierarchyGraph(desc).writeGraph();
2946     }
2947
2948   }
2949
2950   private void debug_writeSkeletonCombinationHierarchyDotFiles() {
2951
2952     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2953     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2954       Descriptor desc = (Descriptor) iterator.next();
2955       getSkeletonCombinationHierarchyGraph(desc).writeGraph();
2956     }
2957
2958   }
2959
2960   public HierarchyGraph getSimpleHierarchyGraph(Descriptor d) {
2961     return mapDescriptorToSimpleHierarchyGraph.get(d);
2962   }
2963
2964   private HierarchyGraph getSkeletonHierarchyGraph(Descriptor d) {
2965     if (!mapDescriptorToSkeletonHierarchyGraph.containsKey(d)) {
2966       mapDescriptorToSkeletonHierarchyGraph.put(d, new HierarchyGraph(d));
2967     }
2968     return mapDescriptorToSkeletonHierarchyGraph.get(d);
2969   }
2970
2971   public HierarchyGraph getSkeletonCombinationHierarchyGraph(Descriptor d) {
2972     if (!mapDescriptorToCombineSkeletonHierarchyGraph.containsKey(d)) {
2973       mapDescriptorToCombineSkeletonHierarchyGraph.put(d, new HierarchyGraph(d));
2974     }
2975     return mapDescriptorToCombineSkeletonHierarchyGraph.get(d);
2976   }
2977
2978   private void constructHierarchyGraph() {
2979
2980     LinkedList<MethodDescriptor> methodDescList =
2981         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
2982
2983     while (!methodDescList.isEmpty()) {
2984       MethodDescriptor md = methodDescList.removeLast();
2985       if (state.SSJAVADEBUG) {
2986         HierarchyGraph hierarchyGraph = new HierarchyGraph(md);
2987         System.out.println();
2988         System.out.println("SSJAVA: Construcing the hierarchy graph from " + md);
2989         constructHierarchyGraph(md, hierarchyGraph);
2990         mapDescriptorToHierarchyGraph.put(md, hierarchyGraph);
2991
2992       }
2993     }
2994
2995     setupToAnalyze();
2996     while (!toAnalyzeIsEmpty()) {
2997       ClassDescriptor cd = toAnalyzeNext();
2998       HierarchyGraph graph = getHierarchyGraph(cd);
2999       for (Iterator iter = cd.getFields(); iter.hasNext();) {
3000         FieldDescriptor fieldDesc = (FieldDescriptor) iter.next();
3001         if (!(fieldDesc.isStatic() && fieldDesc.isFinal())) {
3002           graph.getHNode(fieldDesc);
3003         }
3004       }
3005     }
3006
3007     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
3008     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
3009       Descriptor key = (Descriptor) iterator.next();
3010       HierarchyGraph graph = getHierarchyGraph(key);
3011
3012       Set<HNode> nodeToBeConnected = new HashSet<HNode>();
3013       for (Iterator iterator2 = graph.getNodeSet().iterator(); iterator2.hasNext();) {
3014         HNode node = (HNode) iterator2.next();
3015         if (!node.isSkeleton() && !node.isCombinationNode()) {
3016           if (graph.getIncomingNodeSet(node).size() == 0) {
3017             nodeToBeConnected.add(node);
3018           }
3019         }
3020       }
3021
3022       for (Iterator iterator2 = nodeToBeConnected.iterator(); iterator2.hasNext();) {
3023         HNode node = (HNode) iterator2.next();
3024         // System.out.println("NEED TO BE CONNECTED TO TOP=" + node);
3025         graph.addEdge(graph.getHNode(TOPDESC), node);
3026       }
3027
3028     }
3029
3030   }
3031
3032   private void constructHierarchyGraph2() {
3033
3034     // do fixed-point analysis
3035
3036     LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
3037
3038     // Collections.sort(descriptorListToAnalyze, new
3039     // Comparator<MethodDescriptor>() {
3040     // public int compare(MethodDescriptor o1, MethodDescriptor o2) {
3041     // return o1.getSymbol().compareToIgnoreCase(o2.getSymbol());
3042     // }
3043     // });
3044
3045     // current descriptors to visit in fixed-point interprocedural analysis,
3046     // prioritized by dependency in the call graph
3047     methodDescriptorsToVisitStack.clear();
3048
3049     Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
3050     methodDescriptorToVistSet.addAll(descriptorListToAnalyze);
3051
3052     while (!descriptorListToAnalyze.isEmpty()) {
3053       MethodDescriptor md = descriptorListToAnalyze.removeFirst();
3054       methodDescriptorsToVisitStack.add(md);
3055     }
3056
3057     // analyze scheduled methods until there are no more to visit
3058     while (!methodDescriptorsToVisitStack.isEmpty()) {
3059       // start to analyze leaf node
3060       MethodDescriptor md = methodDescriptorsToVisitStack.pop();
3061
3062       HierarchyGraph hierarchyGraph = new HierarchyGraph(md);
3063       // MethodSummary methodSummary = new MethodSummary(md);
3064
3065       // MethodLocationInfo methodInfo = new MethodLocationInfo(md);
3066       // curMethodInfo = methodInfo;
3067
3068       System.out.println();
3069       System.out.println("SSJAVA: Construcing the hierarchy graph from " + md);
3070
3071       constructHierarchyGraph(md, hierarchyGraph);
3072
3073       HierarchyGraph prevHierarchyGraph = getHierarchyGraph(md);
3074       // MethodSummary prevMethodSummary = getMethodSummary(md);
3075
3076       if (!hierarchyGraph.equals(prevHierarchyGraph)) {
3077
3078         mapDescriptorToHierarchyGraph.put(md, hierarchyGraph);
3079         // mapDescToLocationSummary.put(md, methodSummary);
3080
3081         // results for callee changed, so enqueue dependents caller for
3082         // further analysis
3083         Iterator<MethodDescriptor> depsItr = ssjava.getDependents(md).iterator();
3084         while (depsItr.hasNext()) {
3085           MethodDescriptor methodNext = depsItr.next();
3086           if (!methodDescriptorsToVisitStack.contains(methodNext)
3087               && methodDescriptorToVistSet.contains(methodNext)) {
3088             methodDescriptorsToVisitStack.add(methodNext);
3089           }
3090         }
3091
3092       }
3093
3094     }
3095
3096     setupToAnalyze();
3097     while (!toAnalyzeIsEmpty()) {
3098       ClassDescriptor cd = toAnalyzeNext();
3099       HierarchyGraph graph = getHierarchyGraph(cd);
3100       for (Iterator iter = cd.getFields(); iter.hasNext();) {
3101         FieldDescriptor fieldDesc = (FieldDescriptor) iter.next();
3102         if (!(fieldDesc.isStatic() && fieldDesc.isFinal())) {
3103           graph.getHNode(fieldDesc);
3104         }
3105       }
3106     }
3107
3108     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
3109     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
3110       Descriptor key = (Descriptor) iterator.next();
3111       HierarchyGraph graph = getHierarchyGraph(key);
3112
3113       Set<HNode> nodeToBeConnected = new HashSet<HNode>();
3114       for (Iterator iterator2 = graph.getNodeSet().iterator(); iterator2.hasNext();) {
3115         HNode node = (HNode) iterator2.next();
3116         if (!node.isSkeleton() && !node.isCombinationNode()) {
3117           if (graph.getIncomingNodeSet(node).size() == 0) {
3118             nodeToBeConnected.add(node);
3119           }
3120         }
3121       }
3122
3123       for (Iterator iterator2 = nodeToBeConnected.iterator(); iterator2.hasNext();) {
3124         HNode node = (HNode) iterator2.next();
3125         // System.out.println("NEED TO BE CONNECTED TO TOP=" + node);
3126         graph.addEdge(graph.getHNode(TOPDESC), node);
3127       }
3128
3129     }
3130
3131   }
3132
3133   private HierarchyGraph getHierarchyGraph(Descriptor d) {
3134     if (!mapDescriptorToHierarchyGraph.containsKey(d)) {
3135       mapDescriptorToHierarchyGraph.put(d, new HierarchyGraph(d));
3136     }
3137     return mapDescriptorToHierarchyGraph.get(d);
3138   }
3139
3140   private void constructHierarchyGraph(MethodDescriptor md, HierarchyGraph methodGraph) {
3141
3142     // visit each node of method flow graph
3143     FlowGraph fg = getFlowGraph(md);
3144     // Set<FlowNode> nodeSet = fg.getNodeSet();
3145
3146     Set<FlowEdge> edgeSet = fg.getEdgeSet();
3147
3148     Set<Descriptor> paramDescSet = fg.getMapParamDescToIdx().keySet();
3149     for (Iterator iterator = paramDescSet.iterator(); iterator.hasNext();) {
3150       Descriptor desc = (Descriptor) iterator.next();
3151       methodGraph.getHNode(desc).setSkeleton(true);
3152     }
3153
3154     // for the method lattice, we need to look at the first element of
3155     // NTuple<Descriptor>
3156     boolean hasGlobalAccess = false;
3157     // for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
3158     // FlowNode originalSrcNode = (FlowNode) iterator.next();
3159     for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) {
3160       FlowEdge edge = (FlowEdge) iterator.next();
3161
3162       FlowNode originalSrcNode = fg.getFlowNode(edge.getInitTuple());
3163       Set<FlowNode> sourceNodeSet = new HashSet<FlowNode>();
3164       if (originalSrcNode instanceof FlowReturnNode) {
3165         FlowReturnNode rnode = (FlowReturnNode) originalSrcNode;
3166         // System.out.println("rnode=" + rnode);
3167         Set<NTuple<Descriptor>> tupleSet = rnode.getReturnTupleSet();
3168         for (Iterator iterator2 = tupleSet.iterator(); iterator2.hasNext();) {
3169           NTuple<Descriptor> nTuple = (NTuple<Descriptor>) iterator2.next();
3170           sourceNodeSet.add(fg.getFlowNode(nTuple));
3171           // System.out.println("&&&SOURCE fg.getFlowNode(nTuple)=" + fg.getFlowNode(nTuple));
3172         }
3173       } else {
3174         sourceNodeSet.add(originalSrcNode);
3175       }
3176
3177       // System.out.println("---sourceNodeSet=" + sourceNodeSet + "  from originalSrcNode="
3178       // + originalSrcNode);
3179
3180       for (Iterator iterator3 = sourceNodeSet.iterator(); iterator3.hasNext();) {
3181         FlowNode srcNode = (FlowNode) iterator3.next();
3182
3183         NTuple<Descriptor> srcNodeTuple = srcNode.getDescTuple();
3184         Descriptor srcLocalDesc = srcNodeTuple.get(0);
3185
3186         if (srcLocalDesc instanceof InterDescriptor
3187             && ((InterDescriptor) srcLocalDesc).getMethodArgIdxPair() != null) {
3188
3189           if (srcNode.getCompositeLocation() == null) {
3190             continue;
3191           }
3192         }
3193
3194         // if the srcNode is started with the global descriptor
3195         // need to set as a skeleton node
3196         if (!hasGlobalAccess && srcNode.getDescTuple().startsWith(GLOBALDESC)) {
3197           hasGlobalAccess = true;
3198         }
3199
3200         // Set<FlowEdge> outEdgeSet = fg.getOutEdgeSet(originalSrcNode);
3201         // for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) {
3202         // FlowEdge outEdge = (FlowEdge) iterator2.next();
3203         // FlowNode originalDstNode = outEdge.getDst();
3204         FlowNode originalDstNode = fg.getFlowNode(edge.getEndTuple());
3205
3206         Set<FlowNode> dstNodeSet = new HashSet<FlowNode>();
3207         if (originalDstNode instanceof FlowReturnNode) {
3208           FlowReturnNode rnode = (FlowReturnNode) originalDstNode;
3209           // System.out.println("\n-returnNode=" + rnode);
3210           Set<NTuple<Descriptor>> tupleSet = rnode.getReturnTupleSet();
3211           for (Iterator iterator4 = tupleSet.iterator(); iterator4.hasNext();) {
3212             NTuple<Descriptor> nTuple = (NTuple<Descriptor>) iterator4.next();
3213             dstNodeSet.add(fg.getFlowNode(nTuple));
3214             // System.out.println("&&&DST fg.getFlowNode(nTuple)=" + fg.getFlowNode(nTuple));
3215           }
3216         } else {
3217           dstNodeSet.add(originalDstNode);
3218         }
3219         // System.out.println("---dstNodeSet=" + dstNodeSet);
3220         for (Iterator iterator4 = dstNodeSet.iterator(); iterator4.hasNext();) {
3221           FlowNode dstNode = (FlowNode) iterator4.next();
3222
3223           NTuple<Descriptor> dstNodeTuple = dstNode.getDescTuple();
3224           Descriptor dstLocalDesc = dstNodeTuple.get(0);
3225
3226           if (dstLocalDesc instanceof InterDescriptor
3227               && ((InterDescriptor) dstLocalDesc).getMethodArgIdxPair() != null) {
3228             if (dstNode.getCompositeLocation() == null) {
3229               // System.out.println("%%%%%%%%%%%%%SKIP=" + dstNode);
3230               continue;
3231             }
3232           }
3233
3234           // if (outEdge.getInitTuple().equals(srcNodeTuple)
3235           // && outEdge.getEndTuple().equals(dstNodeTuple)) {
3236
3237           NTuple<Descriptor> srcCurTuple = srcNode.getCurrentDescTuple();
3238           NTuple<Descriptor> dstCurTuple = dstNode.getCurrentDescTuple();
3239
3240           // //////////////////////////
3241           // inheritance check
3242           if (mapMethodDescToHighestOverriddenMethodDesc.containsKey(md)) {
3243
3244             MethodDescriptor highestOverriddenMethodDesc =
3245                 mapMethodDescToHighestOverriddenMethodDesc.get(md);
3246
3247             if (srcCurTuple.get(srcCurTuple.size() - 1).getSymbol().startsWith(PCLOC)) {
3248             }
3249
3250           }
3251           // //////////////////////////
3252
3253           // System.out.println("-srcCurTuple=" + srcCurTuple + "  dstCurTuple=" + dstCurTuple
3254           // + "  srcNode=" + srcNode + "   dstNode=" + dstNode);
3255
3256           // srcCurTuple = translateBaseTuple(srcNode, srcCurTuple);
3257           // dstCurTuple = translateBaseTuple(dstNode, dstCurTuple);
3258
3259           if ((srcCurTuple.size() > 1 && dstCurTuple.size() > 1)
3260               && srcCurTuple.get(0).equals(dstCurTuple.get(0))) {
3261
3262             // value flows between fields
3263             Descriptor desc = srcCurTuple.get(0);
3264             ClassDescriptor classDesc;
3265
3266             if (desc.equals(GLOBALDESC)) {
3267               classDesc = md.getClassDesc();
3268             } else {
3269               VarDescriptor varDesc = (VarDescriptor) srcCurTuple.get(0);
3270               classDesc = varDesc.getType().getClassDesc();
3271             }
3272             extractFlowsBetweenFields(classDesc, srcNode, dstNode, 1);
3273
3274           } else if ((srcCurTuple.size() == 1 && dstCurTuple.size() == 1)
3275               || ((srcCurTuple.size() > 1 || dstCurTuple.size() > 1) && !srcCurTuple.get(0).equals(
3276                   dstCurTuple.get(0)))) {
3277
3278             // value flow between a primitive local var - a primitive local var or local var -
3279             // field
3280
3281             Descriptor srcDesc = srcCurTuple.get(0);
3282             Descriptor dstDesc = dstCurTuple.get(0);
3283
3284             methodGraph.addEdge(srcDesc, dstDesc);
3285
3286             if (fg.isParamDesc(srcDesc)) {
3287               methodGraph.setParamHNode(srcDesc);
3288             }
3289             if (fg.isParamDesc(dstDesc)) {
3290               methodGraph.setParamHNode(dstDesc);
3291             }
3292
3293           }
3294
3295           // }
3296           // }
3297
3298         }
3299
3300       }
3301
3302     }
3303
3304     // If the method accesses static fields
3305     // set hasGloabalAccess true in the method summary.
3306     if (hasGlobalAccess) {
3307       getMethodSummary(md).setHasGlobalAccess();
3308     }
3309     methodGraph.getHNode(GLOBALDESC).setSkeleton(true);
3310
3311     if (ssjava.getMethodContainingSSJavaLoop().equals(md)) {
3312       // if the current method contains the event loop
3313       // we need to set all nodes of the hierarchy graph as a skeleton node
3314       Set<HNode> hnodeSet = methodGraph.getNodeSet();
3315       for (Iterator iterator = hnodeSet.iterator(); iterator.hasNext();) {
3316         HNode hnode = (HNode) iterator.next();
3317         hnode.setSkeleton(true);
3318       }
3319     }
3320
3321   }
3322
3323   private NTuple<Descriptor> translateBaseTuple(FlowNode flowNode, NTuple<Descriptor> inTuple) {
3324
3325     if (flowNode.getBaseTuple() != null) {
3326
3327       NTuple<Descriptor> translatedTuple = new NTuple<Descriptor>();
3328
3329       NTuple<Descriptor> baseTuple = flowNode.getBaseTuple();
3330
3331       for (int i = 0; i < baseTuple.size(); i++) {
3332         translatedTuple.add(baseTuple.get(i));
3333       }
3334
3335       for (int i = 1; i < inTuple.size(); i++) {
3336         translatedTuple.add(inTuple.get(i));
3337       }
3338
3339       // System.out.println("------TRANSLATED " + inTuple + " -> " + translatedTuple);
3340       return translatedTuple;
3341
3342     } else {
3343       return inTuple;
3344     }
3345
3346   }
3347
3348   private MethodSummary getMethodSummary(MethodDescriptor md) {
3349     if (!mapDescToLocationSummary.containsKey(md)) {
3350       mapDescToLocationSummary.put(md, new MethodSummary(md));
3351     }
3352     return (MethodSummary) mapDescToLocationSummary.get(md);
3353   }
3354
3355   private void addMapClassDefinitionToLineNum(ClassDescriptor cd, String strLine, int lineNum) {
3356
3357     String classSymbol = cd.getSymbol();
3358     int idx = classSymbol.lastIndexOf("$");
3359     if (idx != -1) {
3360       classSymbol = classSymbol.substring(idx + 1);
3361     }
3362
3363     String pattern = "class " + classSymbol + " ";
3364     if (strLine.indexOf(pattern) != -1) {
3365       mapDescToDefinitionLine.put(cd, lineNum);
3366     }
3367   }
3368
3369   private void addMapMethodDefinitionToLineNum(Set<MethodDescriptor> methodSet, String strLine,
3370       int lineNum) {
3371     for (Iterator iterator = methodSet.iterator(); iterator.hasNext();) {
3372       MethodDescriptor md = (MethodDescriptor) iterator.next();
3373       String pattern = md.getMethodDeclaration();
3374       if (strLine.indexOf(pattern) != -1) {
3375         mapDescToDefinitionLine.put(md, lineNum);
3376         methodSet.remove(md);
3377         return;
3378       }
3379     }
3380
3381   }
3382
3383   private void readOriginalSourceFiles() {
3384
3385     SymbolTable classtable = state.getClassSymbolTable();
3386
3387     Set<ClassDescriptor> classDescSet = new HashSet<ClassDescriptor>();
3388     classDescSet.addAll(classtable.getValueSet());
3389
3390     try {
3391       // inefficient implement. it may re-visit the same file if the file
3392       // contains more than one class definitions.
3393       for (Iterator iterator = classDescSet.iterator(); iterator.hasNext();) {
3394         ClassDescriptor cd = (ClassDescriptor) iterator.next();
3395
3396         Set<MethodDescriptor> methodSet = new HashSet<MethodDescriptor>();
3397         methodSet.addAll(cd.getMethodTable().getValueSet());
3398
3399         String sourceFileName = cd.getSourceFileName();
3400         Vector<String> lineVec = new Vector<String>();
3401
3402         mapFileNameToLineVector.put(sourceFileName, lineVec);
3403
3404         BufferedReader in = new BufferedReader(new FileReader(sourceFileName));
3405         String strLine;
3406         int lineNum = 1;
3407         lineVec.add(""); // the index is started from 1.
3408         while ((strLine = in.readLine()) != null) {
3409           lineVec.add(lineNum, strLine);
3410           addMapClassDefinitionToLineNum(cd, strLine, lineNum);
3411           addMapMethodDefinitionToLineNum(methodSet, strLine, lineNum);
3412           lineNum++;
3413         }
3414
3415       }
3416
3417     } catch (IOException e) {
3418       e.printStackTrace();
3419     }
3420
3421   }
3422
3423   private String generateLatticeDefinition(Descriptor desc) {
3424
3425     Set<String> sharedLocSet = new HashSet<String>();
3426
3427     SSJavaLattice<String> lattice = getLattice(desc);
3428     String rtr = "@LATTICE(\"";
3429
3430     Map<String, Set<String>> map = lattice.getTable();
3431     Set<String> keySet = map.keySet();
3432
3433     // System.out.println("@generateLatticeDefinition=" + desc + "      map=" + map);
3434
3435     boolean first = true;
3436     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
3437       String key = (String) iterator.next();
3438       if (!key.equals(lattice.getTopItem())) {
3439         Set<String> connectedSet = map.get(key);
3440
3441         if (connectedSet.size() == 1) {
3442           if (connectedSet.iterator().next().equals(lattice.getBottomItem())) {
3443             if (!first) {
3444               rtr += ",";
3445             } else {
3446               rtr += "LOC,";
3447               first = false;
3448             }
3449             rtr += key;
3450             if (lattice.isSharedLoc(key)) {
3451               rtr += "," + key + "*";
3452             }
3453           }
3454         }
3455
3456         for (Iterator iterator2 = connectedSet.iterator(); iterator2.hasNext();) {
3457           String loc = (String) iterator2.next();
3458           if (!loc.equals(lattice.getBottomItem())) {
3459             if (!first) {
3460               rtr += ",";
3461             } else {
3462               rtr += "LOC,";
3463               first = false;
3464             }
3465             rtr += loc + "<" + key;
3466             if (lattice.isSharedLoc(key) && (!sharedLocSet.contains(key))) {
3467               rtr += "," + key + "*";
3468               sharedLocSet.add(key);
3469             }
3470             if (lattice.isSharedLoc(loc) && (!sharedLocSet.contains(loc))) {
3471               rtr += "," + loc + "*";
3472               sharedLocSet.add(loc);
3473             }
3474
3475           }
3476         }
3477       }
3478     }
3479
3480     if (desc instanceof MethodDescriptor) {
3481       // System.out.println("#EXTRA LOC DECLARATION GEN=" + desc);
3482
3483       MethodDescriptor md = (MethodDescriptor) desc;
3484       MethodSummary methodSummary = getMethodSummary(md);
3485
3486       TypeDescriptor returnType = ((MethodDescriptor) desc).getReturnType();
3487       if (!ssjava.getMethodContainingSSJavaLoop().equals(desc) && returnType != null
3488           && (!returnType.isVoid())) {
3489         CompositeLocation returnLoc = methodSummary.getRETURNLoc();
3490         if (returnLoc.getSize() == 1) {
3491           String returnLocStr = generateLocationAnnoatation(methodSummary.getRETURNLoc());
3492           if (rtr.indexOf(returnLocStr) == -1) {
3493             rtr += "," + returnLocStr;
3494           }
3495         }
3496       }
3497       rtr += "\")";
3498
3499       if (!ssjava.getMethodContainingSSJavaLoop().equals(desc)) {
3500         if (returnType != null && (!returnType.isVoid())) {
3501           rtr +=
3502               "\n@RETURNLOC(\"" + generateLocationAnnoatation(methodSummary.getRETURNLoc()) + "\")";
3503         }
3504
3505         CompositeLocation pcLoc = methodSummary.getPCLoc();
3506         if ((pcLoc != null) && (!pcLoc.get(0).isTop())) {
3507           rtr += "\n@PCLOC(\"" + generateLocationAnnoatation(pcLoc) + "\")";
3508         }
3509       }
3510
3511       if (!md.isStatic()) {
3512         rtr += "\n@THISLOC(\"" + methodSummary.getThisLocName() + "\")";
3513       }
3514       rtr += "\n@GLOBALLOC(\"" + methodSummary.getGlobalLocName() + "\")";
3515
3516     } else {
3517       rtr += "\")";
3518     }
3519
3520     return rtr;
3521   }
3522
3523   private void generateAnnoatedCode() {
3524
3525     readOriginalSourceFiles();
3526
3527     setupToAnalyze();
3528     while (!toAnalyzeIsEmpty()) {
3529       ClassDescriptor cd = toAnalyzeNext();
3530
3531       setupToAnalazeMethod(cd);
3532
3533       String sourceFileName = cd.getSourceFileName();
3534
3535       if (cd.isInterface()) {
3536         continue;
3537       }
3538
3539       int classDefLine = mapDescToDefinitionLine.get(cd);
3540       Vector<String> sourceVec = mapFileNameToLineVector.get(sourceFileName);
3541
3542       LocationSummary fieldLocSummary = getLocationSummary(cd);
3543
3544       String fieldLatticeDefStr = generateLatticeDefinition(cd);
3545       String annoatedSrc = fieldLatticeDefStr + newline + sourceVec.get(classDefLine);
3546       sourceVec.set(classDefLine, annoatedSrc);
3547
3548       // generate annotations for field declarations
3549       // Map<Descriptor, CompositeLocation> inferLocMap = fieldLocInfo.getMapDescToInferLocation();
3550       Map<String, String> mapFieldNameToLocName = fieldLocSummary.getMapHNodeNameToLocationName();
3551
3552       for (Iterator iter = cd.getFields(); iter.hasNext();) {
3553         FieldDescriptor fd = (FieldDescriptor) iter.next();
3554
3555         String locAnnotationStr;
3556         // CompositeLocation inferLoc = inferLocMap.get(fd);
3557         String locName = mapFieldNameToLocName.get(fd.getSymbol());
3558
3559         if (locName != null) {
3560           // infer loc is null if the corresponding field is static and final
3561           // locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
3562           locAnnotationStr = "@LOC(\"" + locName + "\")";
3563           int fdLineNum = fd.getLineNum();
3564           String orgFieldDeclarationStr = sourceVec.get(fdLineNum);
3565           String fieldDeclaration = fd.toString();
3566           fieldDeclaration = fieldDeclaration.substring(0, fieldDeclaration.length() - 1);
3567           String annoatedStr = locAnnotationStr + " " + orgFieldDeclarationStr;
3568           sourceVec.set(fdLineNum, annoatedStr);
3569         }
3570
3571       }
3572
3573       while (!toAnalyzeMethodIsEmpty()) {
3574         MethodDescriptor md = toAnalyzeMethodNext();
3575
3576         if (!ssjava.needTobeAnnotated(md)) {
3577           continue;
3578         }
3579
3580         SSJavaLattice<String> methodLattice = md2lattice.get(md);
3581         // System.out.println("md=" + md + " methodLattice=" + methodLattice);
3582         if (methodLattice != null) {
3583
3584           int methodDefLine = md.getLineNum();
3585
3586           // MethodLocationInfo methodLocInfo = getMethodLocationInfo(md);
3587           // Map<Descriptor, CompositeLocation> methodInferLocMap =
3588           // methodLocInfo.getMapDescToInferLocation();
3589
3590           MethodSummary methodSummary = getMethodSummary(md);
3591
3592           Map<Descriptor, CompositeLocation> mapVarDescToInferLoc =
3593               methodSummary.getMapVarDescToInferCompositeLocation();
3594           // System.out.println("-----md=" + md + " methodDefLine=" + methodDefLine);
3595           // System.out.println("-----mapVarDescToInferLoc=" + mapVarDescToInferLoc);
3596
3597           Set<Descriptor> localVarDescSet = mapVarDescToInferLoc.keySet();
3598
3599           Set<String> localLocElementSet = methodLattice.getElementSet();
3600
3601           for (Iterator iterator = localVarDescSet.iterator(); iterator.hasNext();) {
3602             Descriptor localVarDesc = (Descriptor) iterator.next();
3603             // System.out.println("-------localVarDesc=" + localVarDesc);
3604             CompositeLocation inferLoc = mapVarDescToInferLoc.get(localVarDesc);
3605
3606             String localLocIdentifier = inferLoc.get(0).getLocIdentifier();
3607             if (!localLocElementSet.contains(localLocIdentifier)) {
3608               methodLattice.put(localLocIdentifier);
3609             }
3610
3611             String locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
3612
3613             if (!isParameter(md, localVarDesc)) {
3614               if (mapDescToDefinitionLine.containsKey(localVarDesc)) {
3615                 int varLineNum = mapDescToDefinitionLine.get(localVarDesc);
3616                 String orgSourceLine = sourceVec.get(varLineNum);
3617                 // System.out.println("varLineNum=" + varLineNum + "  org src=" + orgSourceLine);
3618                 int idx =
3619                     orgSourceLine.indexOf(generateVarDeclaration((VarDescriptor) localVarDesc));
3620                 // System.out.println("idx=" + idx
3621                 // + "  generateVarDeclaration((VarDescriptor) localVarDesc)="
3622                 // + generateVarDeclaration((VarDescriptor) localVarDesc));
3623                 assert (idx != -1);
3624                 String annoatedStr =
3625                     orgSourceLine.substring(0, idx) + locAnnotationStr + " "
3626                         + orgSourceLine.substring(idx);
3627                 sourceVec.set(varLineNum, annoatedStr);
3628               }
3629             } else {
3630               String methodDefStr = sourceVec.get(methodDefLine);
3631
3632               int idx =
3633                   getParamLocation(methodDefStr,
3634                       generateVarDeclaration((VarDescriptor) localVarDesc));
3635               // System.out.println("methodDefStr=" + methodDefStr + " localVarDesc=" + localVarDesc
3636               // + " idx=" + idx);
3637               assert (idx != -1);
3638
3639               String annoatedStr =
3640                   methodDefStr.substring(0, idx) + locAnnotationStr + " "
3641                       + methodDefStr.substring(idx);
3642               sourceVec.set(methodDefLine, annoatedStr);
3643             }
3644
3645           }
3646
3647           // check if the lattice has to have the location type for the this
3648           // reference...
3649
3650           // boolean needToAddthisRef = hasThisReference(md);
3651           // if (localLocElementSet.contains("this")) {
3652           // methodLattice.put("this");
3653           // }
3654
3655           String methodLatticeDefStr = generateLatticeDefinition(md);
3656           String annoatedStr = methodLatticeDefStr + newline + sourceVec.get(methodDefLine);
3657           sourceVec.set(methodDefLine, annoatedStr);
3658
3659         }
3660       }
3661
3662     }
3663
3664     codeGen();
3665   }
3666
3667   private boolean hasThisReference(MethodDescriptor md) {
3668
3669     FlowGraph fg = getFlowGraph(md);
3670     Set<FlowNode> nodeSet = fg.getNodeSet();
3671     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
3672       FlowNode flowNode = (FlowNode) iterator.next();
3673       if (flowNode.getDescTuple().get(0).equals(md.getThis())) {
3674         return true;
3675       }
3676     }
3677
3678     return false;
3679   }
3680
3681   private int getParamLocation(String methodStr, String paramStr) {
3682
3683     String pattern = paramStr + ",";
3684
3685     int idx = methodStr.indexOf(pattern);
3686     if (idx != -1) {
3687       return idx;
3688     } else {
3689       pattern = paramStr + ")";
3690       return methodStr.indexOf(pattern);
3691     }
3692
3693   }
3694
3695   private String generateVarDeclaration(VarDescriptor varDesc) {
3696
3697     TypeDescriptor td = varDesc.getType();
3698     String rtr = td.toString();
3699     if (td.isArray()) {
3700       for (int i = 0; i < td.getArrayCount(); i++) {
3701         rtr += "[]";
3702       }
3703     }
3704     rtr += " " + varDesc.getName();
3705     return rtr;
3706
3707   }
3708
3709   private String generateLocationAnnoatation(CompositeLocation loc) {
3710     String rtr = "";
3711     // method location
3712     Location methodLoc = loc.get(0);
3713     rtr += methodLoc.getLocIdentifier();
3714
3715     for (int i = 1; i < loc.getSize(); i++) {
3716       Location element = loc.get(i);
3717       rtr += "," + element.getDescriptor().getSymbol() + "." + element.getLocIdentifier();
3718     }
3719
3720     return rtr;
3721   }
3722
3723   private boolean isParameter(MethodDescriptor md, Descriptor localVarDesc) {
3724     return getFlowGraph(md).isParamDesc(localVarDesc);
3725   }
3726
3727   private String extractFileName(String fileName) {
3728     int idx = fileName.lastIndexOf("/");
3729     if (idx == -1) {
3730       return fileName;
3731     } else {
3732       return fileName.substring(idx + 1);
3733     }
3734
3735   }
3736
3737   private void codeGen() {
3738
3739     Set<String> originalFileNameSet = mapFileNameToLineVector.keySet();
3740     for (Iterator iterator = originalFileNameSet.iterator(); iterator.hasNext();) {
3741       String orgFileName = (String) iterator.next();
3742       String outputFileName = extractFileName(orgFileName);
3743
3744       Vector<String> sourceVec = mapFileNameToLineVector.get(orgFileName);
3745
3746       try {
3747
3748         FileWriter fileWriter = new FileWriter("./infer/" + outputFileName);
3749         BufferedWriter out = new BufferedWriter(fileWriter);
3750
3751         for (int i = 0; i < sourceVec.size(); i++) {
3752           out.write(sourceVec.get(i));
3753           out.newLine();
3754         }
3755         out.close();
3756       } catch (IOException e) {
3757         e.printStackTrace();
3758       }
3759
3760     }
3761
3762   }
3763
3764   private void checkLattices() {
3765
3766     LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
3767
3768     // current descriptors to visit in fixed-point interprocedural analysis,
3769     // prioritized by
3770     // dependency in the call graph
3771     methodDescriptorsToVisitStack.clear();
3772
3773     // descriptorListToAnalyze.removeFirst();
3774
3775     Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
3776     methodDescriptorToVistSet.addAll(descriptorListToAnalyze);
3777
3778     while (!descriptorListToAnalyze.isEmpty()) {
3779       MethodDescriptor md = descriptorListToAnalyze.removeFirst();
3780       checkLatticesOfVirtualMethods(md);
3781     }
3782
3783   }
3784
3785   private void debug_writeLatticeDotFile() {
3786     // generate lattice dot file
3787
3788     setupToAnalyze();
3789
3790     while (!toAnalyzeIsEmpty()) {
3791       ClassDescriptor cd = toAnalyzeNext();
3792
3793       setupToAnalazeMethod(cd);
3794
3795       SSJavaLattice<String> classLattice = cd2lattice.get(cd);
3796       if (classLattice != null) {
3797         ssjava.writeLatticeDotFile(cd, null, classLattice);
3798         // debug_printDescriptorToLocNameMapping(cd);
3799       }
3800
3801       while (!toAnalyzeMethodIsEmpty()) {
3802         MethodDescriptor md = toAnalyzeMethodNext();
3803         SSJavaLattice<String> methodLattice = md2lattice.get(md);
3804         if (methodLattice != null) {
3805           ssjava.writeLatticeDotFile(cd, md, methodLattice);
3806           // debug_printDescriptorToLocNameMapping(md);
3807         }
3808       }
3809     }
3810
3811   }
3812
3813   private void debug_printDescriptorToLocNameMapping(Descriptor desc) {
3814
3815     LocationInfo info = getLocationInfo(desc);
3816     System.out.println("## " + desc + " ##");
3817     System.out.println(info.getMapDescToInferLocation());
3818     LocationInfo locInfo = getLocationInfo(desc);
3819     System.out.println("mapping=" + locInfo.getMapLocSymbolToDescSet());
3820     System.out.println("###################");
3821
3822   }
3823
3824   private void calculateExtraLocations() {
3825
3826     // LinkedList<MethodDescriptor> methodDescList = ssjava.getSortedDescriptors();
3827     LinkedList<MethodDescriptor> methodDescList =
3828         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
3829     for (Iterator iterator = methodDescList.iterator(); iterator.hasNext();) {
3830       MethodDescriptor md = (MethodDescriptor) iterator.next();
3831       if (!ssjava.getMethodContainingSSJavaLoop().equals(md)) {
3832         calculateExtraLocations(md);
3833       }
3834     }
3835
3836   }
3837
3838   private void checkLatticesOfVirtualMethods(MethodDescriptor md) {
3839
3840     if (!md.isStatic()) {
3841       Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
3842       setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md));
3843
3844       for (Iterator iterator = setPossibleCallees.iterator(); iterator.hasNext();) {
3845         MethodDescriptor mdCallee = (MethodDescriptor) iterator.next();
3846         if (!md.equals(mdCallee)) {
3847           checkConsistency(md, mdCallee);
3848         }
3849       }
3850
3851     }
3852
3853   }
3854
3855   private void checkConsistency(MethodDescriptor md1, MethodDescriptor md2) {
3856
3857     // check that two lattice have the same relations between parameters(+PC
3858     // LOC, GLOBAL_LOC RETURN LOC)
3859
3860     List<CompositeLocation> list1 = new ArrayList<CompositeLocation>();
3861     List<CompositeLocation> list2 = new ArrayList<CompositeLocation>();
3862
3863     MethodLocationInfo locInfo1 = getMethodLocationInfo(md1);
3864     MethodLocationInfo locInfo2 = getMethodLocationInfo(md2);
3865
3866     Map<Integer, CompositeLocation> paramMap1 = locInfo1.getMapParamIdxToInferLoc();
3867     Map<Integer, CompositeLocation> paramMap2 = locInfo2.getMapParamIdxToInferLoc();
3868
3869     int numParam = locInfo1.getMapParamIdxToInferLoc().keySet().size();
3870
3871     // add location types of paramters
3872     for (int idx = 0; idx < numParam; idx++) {
3873       list1.add(paramMap1.get(Integer.valueOf(idx)));
3874       list2.add(paramMap2.get(Integer.valueOf(idx)));
3875     }
3876
3877     // add program counter location
3878     list1.add(locInfo1.getPCLoc());
3879     list2.add(locInfo2.getPCLoc());
3880
3881     if (!md1.getReturnType().isVoid()) {
3882       // add return value location
3883       CompositeLocation rtrLoc1 = getMethodLocationInfo(md1).getReturnLoc();
3884       CompositeLocation rtrLoc2 = getMethodLocationInfo(md2).getReturnLoc();
3885       list1.add(rtrLoc1);
3886       list2.add(rtrLoc2);
3887     }
3888
3889     // add global location type
3890     if (md1.isStatic()) {
3891       CompositeLocation globalLoc1 =
3892           new CompositeLocation(new Location(md1, locInfo1.getGlobalLocName()));
3893       CompositeLocation globalLoc2 =
3894           new CompositeLocation(new Location(md2, locInfo2.getGlobalLocName()));
3895       list1.add(globalLoc1);
3896       list2.add(globalLoc2);
3897     }
3898
3899     for (int i = 0; i < list1.size(); i++) {
3900       CompositeLocation locA1 = list1.get(i);
3901       CompositeLocation locA2 = list2.get(i);
3902       for (int k = 0; k < list1.size(); k++) {
3903         if (i != k) {
3904           CompositeLocation locB1 = list1.get(k);
3905           CompositeLocation locB2 = list2.get(k);
3906           boolean r1 = isGreaterThan(getLattice(md1), locA1, locB1);
3907
3908           boolean r2 = isGreaterThan(getLattice(md1), locA2, locB2);
3909
3910           if (r1 != r2) {
3911             throw new Error("The method " + md1 + " is not consistent with the method " + md2
3912                 + ".:: They have a different ordering relation between locations (" + locA1 + ","
3913                 + locB1 + ") and (" + locA2 + "," + locB2 + ").");
3914           }
3915         }
3916       }
3917     }
3918
3919   }
3920
3921   private String getSymbol(int idx, FlowNode node) {
3922     Descriptor desc = node.getDescTuple().get(idx);
3923     return desc.getSymbol();
3924   }
3925
3926   private Descriptor getDescriptor(int idx, FlowNode node) {
3927     Descriptor desc = node.getDescTuple().get(idx);
3928     return desc;
3929   }
3930
3931   private void calculatePCLOC(MethodDescriptor md) {
3932
3933     // System.out.println("#CalculatePCLOC");
3934     MethodSummary methodSummary = getMethodSummary(md);
3935     FlowGraph fg = getFlowGraph(md);
3936     Map<Integer, CompositeLocation> mapParamToLoc = methodSummary.getMapParamIdxToInferLoc();
3937
3938     // calculate the initial program counter location
3939     // PC location is higher than location types of parameters which has incoming flows.
3940
3941     Set<NTuple<Location>> paramLocTupleHavingInFlowSet = new HashSet<NTuple<Location>>();
3942     Set<Descriptor> paramDescNOTHavingInFlowSet = new HashSet<Descriptor>();
3943     // Set<FlowNode> paramNodeNOThavingInFlowSet = new HashSet<FlowNode>();
3944
3945     int numParams = fg.getNumParameters();
3946     for (int i = 0; i < numParams; i++) {
3947       FlowNode paramFlowNode = fg.getParamFlowNode(i);
3948       Descriptor prefix = paramFlowNode.getDescTuple().get(0);
3949       NTuple<Descriptor> paramDescTuple = paramFlowNode.getCurrentDescTuple();
3950       NTuple<Location> paramLocTuple = translateToLocTuple(md, paramDescTuple);
3951
3952       Set<FlowNode> inNodeToParamSet = fg.getIncomingNodeSetByPrefix(prefix);
3953       if (inNodeToParamSet.size() > 0) {
3954         // parameter has in-value flows
3955
3956         for (Iterator iterator = inNodeToParamSet.iterator(); iterator.hasNext();) {
3957           FlowNode inNode = (FlowNode) iterator.next();
3958           Set<FlowEdge> outEdgeSet = fg.getOutEdgeSet(inNode);
3959           for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) {
3960             FlowEdge flowEdge = (FlowEdge) iterator2.next();
3961             if (flowEdge.getEndTuple().startsWith(prefix)) {
3962               NTuple<Location> paramLocTupleWithIncomingFlow =
3963                   translateToLocTuple(md, flowEdge.getEndTuple());
3964               paramLocTupleHavingInFlowSet.add(paramLocTupleWithIncomingFlow);
3965             }
3966           }
3967         }
3968
3969         // paramLocTupleHavingInFlowSet.add(paramLocTuple);
3970       } else {
3971         // paramNodeNOThavingInFlowSet.add(fg.getFlowNode(paramDescTuple));
3972         paramDescNOTHavingInFlowSet.add(prefix);
3973       }
3974     }
3975
3976     // System.out.println("paramLocTupleHavingInFlowSet=" + paramLocTupleHavingInFlowSet);
3977
3978     if (paramLocTupleHavingInFlowSet.size() > 0
3979         && !coversAllParamters(md, fg, paramLocTupleHavingInFlowSet)) {
3980
3981       // Here, generates a location in the method lattice that is higher than the
3982       // paramLocTupleHavingInFlowSet
3983       NTuple<Location> pcLocTuple =
3984           generateLocTupleRelativeTo(md, paramLocTupleHavingInFlowSet, PCLOC);
3985
3986       NTuple<Descriptor> pcDescTuple = translateToDescTuple(pcLocTuple);
3987
3988       // System.out.println("pcLoc=" + pcLocTuple);
3989
3990       CompositeLocation curPCLoc = methodSummary.getPCLoc();
3991       if (curPCLoc.get(0).isTop() || pcLocTuple.size() > curPCLoc.getSize()) {
3992         methodSummary.setPCLoc(new CompositeLocation(pcLocTuple));
3993
3994         Set<FlowNode> flowNodeLowerthanPCLocSet = new HashSet<FlowNode>();
3995         GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
3996         // add ordering relations s.t. PCLOC is higher than all flow nodes except the set of
3997         // parameters that do not have incoming flows
3998         for (Iterator iterator = fg.getNodeSet().iterator(); iterator.hasNext();) {
3999           FlowNode node = (FlowNode) iterator.next();
4000
4001           if (!(node instanceof FlowReturnNode)) {
4002             if (!paramDescNOTHavingInFlowSet.contains(node.getCurrentDescTuple().get(0))) {
4003               flowNodeLowerthanPCLocSet.add(node);
4004               fg.addValueFlowEdge(pcDescTuple, node.getDescTuple());
4005
4006               subGlobalFlowGraph.addValueFlowEdge(pcLocTuple,
4007                   translateToLocTuple(md, node.getDescTuple()));
4008             }
4009           } else {
4010             // System.out.println("***SKIP PCLOC -> RETURNLOC=" + node);
4011           }
4012
4013         }
4014         fg.getFlowNode(translateToDescTuple(pcLocTuple)).setSkeleton(true);
4015
4016         if (pcLocTuple.get(0).getLocDescriptor().equals(md.getThis())) {
4017           for (Iterator iterator = flowNodeLowerthanPCLocSet.iterator(); iterator.hasNext();) {
4018             FlowNode lowerNode = (FlowNode) iterator.next();
4019             if (lowerNode.getDescTuple().size() == 1 && lowerNode.getCompositeLocation() == null) {
4020               NTuple<Location> lowerLocTuple = translateToLocTuple(md, lowerNode.getDescTuple());
4021               CompositeLocation newComp =
4022                   calculateCompositeLocationFromSubGlobalGraph(md, lowerNode);
4023               if (newComp != null) {
4024                 subGlobalFlowGraph.addMapLocationToInferCompositeLocation(lowerLocTuple.get(0),
4025                     newComp);
4026                 lowerNode.setCompositeLocation(newComp);
4027                 // System.out.println("NEW COMP LOC=" + newComp + "    to lowerNode=" + lowerNode);
4028               }
4029
4030             }
4031
4032           }
4033         }
4034
4035       }
4036
4037     }
4038   }
4039
4040   private int countFirstDescriptorSetSize(Set<NTuple<Location>> set) {
4041
4042     Set<Descriptor> descSet = new HashSet<Descriptor>();
4043
4044     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
4045       NTuple<Location> locTuple = (NTuple<Location>) iterator.next();
4046       descSet.add(locTuple.get(0).getLocDescriptor());
4047     }
4048
4049     return descSet.size();
4050   }
4051
4052   private boolean coversAllParamters(MethodDescriptor md, FlowGraph fg,
4053       Set<NTuple<Location>> paramLocTupleHavingInFlowSet) {
4054
4055     int numParam = fg.getNumParameters();
4056     // int size = paramLocTupleHavingInFlowSet.size();
4057     int size = countFirstDescriptorSetSize(paramLocTupleHavingInFlowSet);
4058
4059     // System.out.println("numParam=" + numParam + "     size=" + size);
4060
4061     // if (!md.isStatic()) {
4062     //
4063     // // if the method is not static && there is a parameter composite location &&
4064     // // it is started with 'this',
4065     // // paramLocTupleHavingInFlowSet need to have 'this' parameter.
4066     //
4067     // FlowNode thisParamNode = fg.getParamFlowNode(0);
4068     // NTuple<Location> thisParamLocTuple =
4069     // translateToLocTuple(md, thisParamNode.getCurrentDescTuple());
4070     //
4071     // if (!paramLocTupleHavingInFlowSet.contains(thisParamLocTuple)) {
4072     //
4073     // for (Iterator iterator = paramLocTupleHavingInFlowSet.iterator(); iterator.hasNext();) {
4074     // NTuple<Location> paramTuple = (NTuple<Location>) iterator.next();
4075     // if (paramTuple.size() > 1 && paramTuple.get(0).getLocDescriptor().equals(md.getThis())) {
4076     // // paramLocTupleHavingInFlowSet.add(thisParamLocTuple);
4077     // // break;
4078     // size++;
4079     // }
4080     // }
4081     //
4082     // }
4083     // }
4084
4085     if (size == numParam) {
4086       return true;
4087     } else {
4088       return false;
4089     }
4090
4091   }
4092
4093   private void calculateRETURNLOC(MethodDescriptor md) {
4094
4095     // System.out.println("#calculateRETURNLOC= " + md);
4096
4097     // calculate a return location:
4098     // the return location type is lower than all parameters and the location of return values
4099     MethodSummary methodSummary = getMethodSummary(md);
4100     // if (methodSummary.getRETURNLoc() != null) {
4101     // System.out.println("$HERE?");
4102     // return;
4103     // }
4104
4105     FlowGraph fg = getFlowGraph(md);
4106     Map<Integer, CompositeLocation> mapParamToLoc = methodSummary.getMapParamIdxToInferLoc();
4107     Set<Integer> paramIdxSet = mapParamToLoc.keySet();
4108
4109     if (md.getReturnType() != null && !md.getReturnType().isVoid()) {
4110       // first, generate the set of return value location types that starts
4111       // with 'this' reference
4112
4113       Set<FlowNode> paramFlowNodeFlowingToReturnValueSet = getParamNodeFlowingToReturnValue(md);
4114       // System.out.println("paramFlowNodeFlowingToReturnValueSet="
4115       // + paramFlowNodeFlowingToReturnValueSet);
4116
4117       Set<NTuple<Location>> tupleToBeHigherThanReturnLocSet = new HashSet<NTuple<Location>>();
4118       for (Iterator iterator = paramFlowNodeFlowingToReturnValueSet.iterator(); iterator.hasNext();) {
4119         FlowNode fn = (FlowNode) iterator.next();
4120         NTuple<Descriptor> paramDescTuple = fn.getCurrentDescTuple();
4121         tupleToBeHigherThanReturnLocSet.add(translateToLocTuple(md, paramDescTuple));
4122       }
4123
4124       Set<FlowNode> returnNodeSet = fg.getReturnNodeSet();
4125       for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
4126         FlowNode returnNode = (FlowNode) iterator.next();
4127         NTuple<Descriptor> returnDescTuple = returnNode.getCurrentDescTuple();
4128         tupleToBeHigherThanReturnLocSet.add(translateToLocTuple(md, returnDescTuple));
4129       }
4130       // System.out.println("-flow graph's returnNodeSet=" + returnNodeSet);
4131       // System.out.println("tupleSetToBeHigherThanReturnLoc=" + tupleToBeHigherThanReturnLocSet);
4132
4133       // Here, generates a return location in the method lattice that is lower than the
4134       // locFlowingToReturnValueSet
4135       NTuple<Location> returnLocTuple =
4136           generateLocTupleRelativeTo(md, tupleToBeHigherThanReturnLocSet, RLOC);
4137
4138       // System.out.println("returnLocTuple=" + returnLocTuple);
4139       NTuple<Descriptor> returnDescTuple = translateToDescTuple(returnLocTuple);
4140       CompositeLocation curReturnLoc = methodSummary.getRETURNLoc();
4141       if (curReturnLoc == null || returnDescTuple.size() > curReturnLoc.getSize()) {
4142         methodSummary.setRETURNLoc(new CompositeLocation(returnLocTuple));
4143
4144         for (Iterator iterator = tupleToBeHigherThanReturnLocSet.iterator(); iterator.hasNext();) {
4145           NTuple<Location> higherTuple = (NTuple<Location>) iterator.next();
4146           fg.addValueFlowEdge(translateToDescTuple(higherTuple), returnDescTuple);
4147         }
4148         fg.getFlowNode(returnDescTuple).setSkeleton(true);
4149
4150       }
4151
4152       // makes sure that PCLOC is higher than RETURNLOC
4153       CompositeLocation pcLoc = methodSummary.getPCLoc();
4154       if (!pcLoc.get(0).isTop()) {
4155         NTuple<Descriptor> pcLocDescTuple = translateToDescTuple(pcLoc.getTuple());
4156         fg.addValueFlowEdge(pcLocDescTuple, returnDescTuple);
4157       }
4158
4159     }
4160
4161   }
4162
4163   private void calculateExtraLocations(MethodDescriptor md) {
4164     // calcualte pcloc, returnloc,...
4165
4166     System.out.println("\nSSJAVA:Calculate PCLOC/RETURNLOC locations: " + md);
4167
4168     calculatePCLOC(md);
4169     calculateRETURNLOC(md);
4170
4171   }
4172
4173   private NTuple<Location> generateLocTupleRelativeTo(MethodDescriptor md,
4174       Set<NTuple<Location>> paramLocTupleHavingInFlowSet, String locNamePrefix) {
4175
4176     // System.out.println("-generateLocTupleRelativeTo=" + paramLocTupleHavingInFlowSet);
4177
4178     NTuple<Location> higherLocTuple = new NTuple<Location>();
4179
4180     VarDescriptor thisVarDesc = md.getThis();
4181     // check if all paramter loc tuple is started with 'this' reference
4182     boolean hasParamNotStartedWithThisRef = false;
4183
4184     int minSize = 0;
4185
4186     Set<NTuple<Location>> paramLocTupleStartedWithThis = new HashSet<NTuple<Location>>();
4187
4188     next: for (Iterator iterator = paramLocTupleHavingInFlowSet.iterator(); iterator.hasNext();) {
4189       NTuple<Location> paramLocTuple = (NTuple<Location>) iterator.next();
4190       Descriptor paramLocalDesc = paramLocTuple.get(0).getLocDescriptor();
4191       if (!paramLocalDesc.equals(thisVarDesc)) {
4192
4193         Set<FlowNode> inNodeSet = getFlowGraph(md).getIncomingNodeSetByPrefix(paramLocalDesc);
4194         for (Iterator iterator2 = inNodeSet.iterator(); iterator2.hasNext();) {
4195           FlowNode flowNode = (FlowNode) iterator2.next();
4196           if (flowNode.getDescTuple().startsWith(thisVarDesc)) {
4197             // System.out.println("paramLocTuple=" + paramLocTuple + " is lower than THIS");
4198             continue next;
4199           }
4200         }
4201         hasParamNotStartedWithThisRef = true;
4202
4203       } else if (paramLocTuple.size() > 1) {
4204         paramLocTupleStartedWithThis.add(paramLocTuple);
4205         if (minSize == 0 || minSize > paramLocTuple.size()) {
4206           minSize = paramLocTuple.size();
4207         }
4208       }
4209     }
4210
4211     // System.out.println("---paramLocTupleStartedWithThis=" + paramLocTupleStartedWithThis);
4212     Descriptor enclosingDesc = md;
4213     if (hasParamNotStartedWithThisRef) {
4214       // in this case, PCLOC will be the local location
4215     } else {
4216       // all parameter is started with 'this', so PCLOC will be set relative to the composite
4217       // location started with 'this'.
4218       // for (int idx = 0; idx < minSize - 1; idx++) {
4219       for (int idx = 0; idx < 1; idx++) {
4220         Set<Descriptor> locDescSet = new HashSet<Descriptor>();
4221         Location curLoc = null;
4222         NTuple<Location> paramLocTuple = null;
4223         for (Iterator iterator = paramLocTupleStartedWithThis.iterator(); iterator.hasNext();) {
4224           paramLocTuple = (NTuple<Location>) iterator.next();
4225           // System.out.println("-----paramLocTuple=" + paramLocTuple + "  idx=" + idx);
4226           curLoc = paramLocTuple.get(idx);
4227           Descriptor locDesc = curLoc.getLocDescriptor();
4228           locDescSet.add(locDesc);
4229         }
4230         // System.out.println("-----locDescSet=" + locDescSet + " idx=" + idx);
4231         if (locDescSet.size() != 1) {
4232           break;
4233         }
4234         Location newLocElement = new Location(curLoc.getDescriptor(), curLoc.getLocDescriptor());
4235         // System.out.println("newLocElement" + newLocElement);
4236         higherLocTuple.add(newLocElement);
4237         enclosingDesc = getClassTypeDescriptor(curLoc.getLocDescriptor());
4238       }
4239
4240     }
4241
4242     String locIdentifier = locNamePrefix + (locSeed++);
4243     NameDescriptor locDesc = new NameDescriptor(locIdentifier);
4244     Location newLoc = new Location(enclosingDesc, locDesc);
4245     higherLocTuple.add(newLoc);
4246     // System.out.println("---new loc tuple=" + higherLocTuple);
4247
4248     return higherLocTuple;
4249
4250   }
4251
4252   public ClassDescriptor getClassTypeDescriptor(Descriptor in) {
4253
4254     if (in instanceof VarDescriptor) {
4255       return ((VarDescriptor) in).getType().getClassDesc();
4256     } else if (in instanceof FieldDescriptor) {
4257       return ((FieldDescriptor) in).getType().getClassDesc();
4258     }
4259     // else if (in instanceof LocationDescriptor) {
4260     // // here is the case that the descriptor 'in' is the last element of the assigned composite
4261     // // location
4262     // return ((VarDescriptor) locTuple.get(0).getLocDescriptor()).getType().getClassDesc();
4263     // }
4264     else {
4265       return null;
4266     }
4267
4268   }
4269
4270   private Set<NTuple<Location>> calculateHighestLocTupleSet(
4271       Set<NTuple<Location>> paramLocTupleHavingInFlowSet) {
4272
4273     Set<NTuple<Location>> highestSet = new HashSet<NTuple<Location>>();
4274
4275     Iterator<NTuple<Location>> iterator = paramLocTupleHavingInFlowSet.iterator();
4276     NTuple<Location> highest = iterator.next();
4277
4278     for (; iterator.hasNext();) {
4279       NTuple<Location> curLocTuple = (NTuple<Location>) iterator.next();
4280       if (isHigherThan(curLocTuple, highest)) {
4281         // System.out.println(curLocTuple + " is greater than " + highest);
4282         highest = curLocTuple;
4283       }
4284     }
4285
4286     highestSet.add(highest);
4287
4288     MethodDescriptor md = (MethodDescriptor) highest.get(0).getDescriptor();
4289     VarDescriptor thisVarDesc = md.getThis();
4290
4291     // System.out.println("highest=" + highest);
4292
4293     for (Iterator<NTuple<Location>> iter = paramLocTupleHavingInFlowSet.iterator(); iter.hasNext();) {
4294       NTuple<Location> curLocTuple = iter.next();
4295
4296       if (!curLocTuple.equals(highest) && !hasOrderingRelation(highest, curLocTuple)) {
4297
4298         // System.out.println("add it to the highest set=" + curLocTuple);
4299         highestSet.add(curLocTuple);
4300
4301       }
4302     }
4303
4304     return highestSet;
4305
4306   }
4307
4308   private Set<String> getHigherLocSymbolThan(SSJavaLattice<String> lattice, String loc) {
4309     Set<String> higherLocSet = new HashSet<String>();
4310
4311     Set<String> locSet = lattice.getTable().keySet();
4312     for (Iterator iterator = locSet.iterator(); iterator.hasNext();) {
4313       String element = (String) iterator.next();
4314       if (lattice.isGreaterThan(element, loc) && (!element.equals(lattice.getTopItem()))) {
4315         higherLocSet.add(element);
4316       }
4317     }
4318     return higherLocSet;
4319   }
4320
4321   private CompositeLocation getLowest(SSJavaLattice<String> methodLattice,
4322       Set<CompositeLocation> set) {
4323
4324     CompositeLocation lowest = set.iterator().next();
4325
4326     if (set.size() == 1) {
4327       return lowest;
4328     }
4329
4330     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
4331       CompositeLocation loc = (CompositeLocation) iterator.next();
4332
4333       if ((!loc.equals(lowest)) && (!isComparable(methodLattice, lowest, loc))) {
4334         // if there is a case where composite locations are incomparable, just
4335         // return null
4336         return null;
4337       }
4338
4339       if ((!loc.equals(lowest)) && isGreaterThan(methodLattice, lowest, loc)) {
4340         lowest = loc;
4341       }
4342     }
4343     return lowest;
4344   }
4345
4346   private boolean isComparable(SSJavaLattice<String> methodLattice, CompositeLocation comp1,
4347       CompositeLocation comp2) {
4348
4349     int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize();
4350
4351     for (int idx = 0; idx < size; idx++) {
4352       Location loc1 = comp1.get(idx);
4353       Location loc2 = comp2.get(idx);
4354
4355       Descriptor desc1 = loc1.getDescriptor();
4356       Descriptor desc2 = loc2.getDescriptor();
4357
4358       if (!desc1.equals(desc2)) {
4359         throw new Error("Fail to compare " + comp1 + " and " + comp2);
4360       }
4361
4362       String symbol1 = loc1.getLocIdentifier();
4363       String symbol2 = loc2.getLocIdentifier();
4364
4365       SSJavaLattice<String> lattice;
4366       if (idx == 0) {
4367         lattice = methodLattice;
4368       } else {
4369         lattice = getLattice(desc1);
4370       }
4371
4372       if (symbol1.equals(symbol2)) {
4373         continue;
4374       } else if (!lattice.isComparable(symbol1, symbol2)) {
4375         return false;
4376       }
4377
4378     }
4379
4380     return true;
4381   }
4382
4383   private boolean isGreaterThan(SSJavaLattice<String> methodLattice, CompositeLocation comp1,
4384       CompositeLocation comp2) {
4385
4386     int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize();
4387
4388     for (int idx = 0; idx < size; idx++) {
4389       Location loc1 = comp1.get(idx);
4390       Location loc2 = comp2.get(idx);
4391
4392       Descriptor desc1 = loc1.getDescriptor();
4393       Descriptor desc2 = loc2.getDescriptor();
4394
4395       if (!desc1.equals(desc2)) {
4396         throw new Error("Fail to compare " + comp1 + " and " + comp2);
4397       }
4398
4399       String symbol1 = loc1.getLocIdentifier();
4400       String symbol2 = loc2.getLocIdentifier();
4401
4402       SSJavaLattice<String> lattice;
4403       if (idx == 0) {
4404         lattice = methodLattice;
4405       } else {
4406         lattice = getLattice(desc1);
4407       }
4408
4409       if (symbol1.equals(symbol2)) {
4410         continue;
4411       } else if (lattice.isGreaterThan(symbol1, symbol2)) {
4412         return true;
4413       } else {
4414         return false;
4415       }
4416
4417     }
4418
4419     return false;
4420   }
4421
4422   private GlobalFlowGraph getSubGlobalFlowGraph(MethodDescriptor md) {
4423
4424     if (!mapMethodDescriptorToSubGlobalFlowGraph.containsKey(md)) {
4425       mapMethodDescriptorToSubGlobalFlowGraph.put(md, new GlobalFlowGraph(md));
4426     }
4427     return mapMethodDescriptorToSubGlobalFlowGraph.get(md);
4428   }
4429
4430   private void propagateFlowsToCallerWithNoCompositeLocation(MethodInvokeNode min,
4431       MethodDescriptor mdCaller, MethodDescriptor mdCallee) {
4432
4433     // System.out.println("-propagateFlowsToCallerWithNoCompositeLocation=" + min.printNode(0));
4434     // if the parameter A reaches to the parameter B
4435     // then, add an edge the argument A -> the argument B to the caller's flow
4436     // graph
4437
4438     FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
4439     FlowGraph callerFlowGraph = getFlowGraph(mdCaller);
4440     int numParam = calleeFlowGraph.getNumParameters();
4441
4442     for (int i = 0; i < numParam; i++) {
4443       for (int k = 0; k < numParam; k++) {
4444
4445         if (i != k) {
4446
4447           FlowNode paramNode1 = calleeFlowGraph.getParamFlowNode(i);
4448           FlowNode paramNode2 = calleeFlowGraph.getParamFlowNode(k);
4449
4450           NTuple<Descriptor> arg1Tuple = getNodeTupleByArgIdx(min, i);
4451           NTuple<Descriptor> arg2Tuple = getNodeTupleByArgIdx(min, k);
4452
4453           // check if the callee propagates an ordering constraints through
4454           // parameters
4455
4456           // Set<FlowNode> localReachSet = calleeFlowGraph.getLocalReachFlowNodeSetFrom(paramNode1);
4457           Set<FlowNode> localReachSet =
4458               calleeFlowGraph.getReachableSetFrom(paramNode1.getDescTuple());
4459
4460           NTuple<Descriptor> paramDescTuple1 = paramNode1.getCurrentDescTuple();
4461           NTuple<Descriptor> paramDescTuple2 = paramNode2.getCurrentDescTuple();
4462
4463           // System.out.println("-param1CurTuple=" + paramDescTuple1 + " param2CurTuple="
4464           // + paramDescTuple2);
4465           // System.out.println("-- localReachSet from param1=" + localReachSet);
4466
4467           if (paramDescTuple1.get(0).equals(paramDescTuple2.get(0))) {
4468             // if two parameters share the same prefix
4469             // it already has been assigned to a composite location
4470             // so we don't need to add an additional ordering relation caused by these two
4471             // paramters.
4472             continue;
4473           }
4474
4475           if (arg1Tuple.size() > 0 && arg2Tuple.size() > 0
4476               && containsPrefix(paramNode2.getDescTuple().get(0), localReachSet)) {
4477             // need to propagate an ordering relation s.t. arg1 is higher
4478             // than arg2
4479             // System.out.println("-param1=" + paramNode1 + " is higher than param2=" + paramNode2);
4480
4481             // add a new flow between the corresponding arguments.
4482             callerFlowGraph.addValueFlowEdge(arg1Tuple, arg2Tuple);
4483             // System.out.println("arg1=" + arg1Tuple + "   arg2=" + arg2Tuple);
4484
4485             // System.out
4486             // .println("-arg1Tuple=" + arg1Tuple + " is higher than arg2Tuple=" + arg2Tuple);
4487
4488           }
4489
4490           // System.out.println();
4491         }
4492       }
4493     }
4494
4495     // if a parameter has a composite location and the first element of the parameter location
4496     // matches the callee's 'this'
4497     // we have a more specific constraint: the caller's corresponding argument is higher than the
4498     // parameter location which is translated into the caller
4499
4500     for (int idx = 0; idx < numParam; idx++) {
4501       FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx);
4502       CompositeLocation compLoc = paramNode.getCompositeLocation();
4503       // System.out.println("paramNode=" + paramNode + "   compLoc=" + compLoc);
4504       if (compLoc != null && compLoc.get(0).getLocDescriptor().equals(min.getMethod().getThis())) {
4505         // System.out.println("$$$COMPLOC CASE=" + compLoc + "  idx=" + idx);
4506
4507         NTuple<Descriptor> argTuple = getNodeTupleByArgIdx(min, idx);
4508         // System.out.println("--- argTuple=" + argTuple + " current compLoc="
4509         // + callerFlowGraph.getFlowNode(argTuple).getCompositeLocation());
4510
4511         NTuple<Descriptor> translatedParamTuple =
4512             translateCompositeLocationToCaller(idx, min, compLoc);
4513         // System.out.println("add a flow edge= " + argTuple + "->" + translatedParamTuple);
4514         callerFlowGraph.addValueFlowEdge(argTuple, translatedParamTuple);
4515
4516         Set<NTuple<Location>> pcLocTupleSet = getPCLocTupleSet(min);
4517         for (Iterator iterator = pcLocTupleSet.iterator(); iterator.hasNext();) {
4518           NTuple<Location> pcLocTuple = (NTuple<Location>) iterator.next();
4519           callerFlowGraph.addValueFlowEdge(translateToDescTuple(pcLocTuple), translatedParamTuple);
4520         }
4521
4522       }
4523     }
4524
4525   }
4526
4527   private boolean containsPrefix(Descriptor prefixDesc, Set<FlowNode> set) {
4528
4529     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
4530       FlowNode flowNode = (FlowNode) iterator.next();
4531       if (flowNode.getDescTuple().startsWith(prefixDesc)) {
4532         // System.out.println("FOUND=" + flowNode);
4533         return true;
4534       }
4535     }
4536     return false;
4537   }
4538
4539   private NTuple<Descriptor> translateCompositeLocationToCaller(int idx, MethodInvokeNode min,
4540       CompositeLocation compLocForParam1) {
4541
4542     NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
4543
4544     NTuple<Descriptor> tuple = new NTuple<Descriptor>();
4545     for (int i = 0; i < baseTuple.size(); i++) {
4546       tuple.add(baseTuple.get(i));
4547     }
4548
4549     for (int i = 1; i < compLocForParam1.getSize(); i++) {
4550       Location loc = compLocForParam1.get(i);
4551       tuple.add(loc.getLocDescriptor());
4552     }
4553
4554     return tuple;
4555   }
4556
4557   private CompositeLocation generateCompositeLocation(NTuple<Location> prefixLocTuple) {
4558
4559     // System.out.println("generateCompositeLocation=" + prefixLocTuple);
4560
4561     CompositeLocation newCompLoc = new CompositeLocation();
4562     for (int i = 0; i < prefixLocTuple.size(); i++) {
4563       newCompLoc.addLocation(prefixLocTuple.get(i));
4564     }
4565
4566     Descriptor lastDescOfPrefix = prefixLocTuple.get(prefixLocTuple.size() - 1).getLocDescriptor();
4567
4568     ClassDescriptor enclosingDescriptor;
4569     if (lastDescOfPrefix instanceof FieldDescriptor) {
4570       enclosingDescriptor = ((FieldDescriptor) lastDescOfPrefix).getType().getClassDesc();
4571       // System.out.println("enclosingDescriptor0=" + enclosingDescriptor);
4572     } else if (lastDescOfPrefix.equals(GLOBALDESC)) {
4573       MethodDescriptor currentMethodDesc = (MethodDescriptor) prefixLocTuple.get(0).getDescriptor();
4574       enclosingDescriptor = currentMethodDesc.getClassDesc();
4575     } else {
4576       // var descriptor case
4577       enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc();
4578     }
4579     // System.out.println("enclosingDescriptor=" + enclosingDescriptor);
4580
4581     LocationDescriptor newLocDescriptor = generateNewLocationDescriptor();
4582     newLocDescriptor.setEnclosingClassDesc(enclosingDescriptor);
4583
4584     Location newLoc = new Location(enclosingDescriptor, newLocDescriptor.getSymbol());
4585     newLoc.setLocDescriptor(newLocDescriptor);
4586     newCompLoc.addLocation(newLoc);
4587
4588     // System.out.println("--newCompLoc=" + newCompLoc);
4589     return newCompLoc;
4590   }
4591
4592   private CompositeLocation generateCompositeLocation(MethodDescriptor md,
4593       NTuple<Descriptor> paramPrefix) {
4594
4595     // System.out.println("generateCompositeLocation=" + paramPrefix);
4596
4597     CompositeLocation newCompLoc = convertToCompositeLocation(md, paramPrefix);
4598
4599     Descriptor lastDescOfPrefix = paramPrefix.get(paramPrefix.size() - 1);
4600     // System.out.println("lastDescOfPrefix=" + lastDescOfPrefix + "  kind="
4601     // + lastDescOfPrefix.getClass());
4602     ClassDescriptor enclosingDescriptor;
4603     if (lastDescOfPrefix instanceof FieldDescriptor) {
4604       enclosingDescriptor = ((FieldDescriptor) lastDescOfPrefix).getType().getClassDesc();
4605       // System.out.println("enclosingDescriptor0=" + enclosingDescriptor);
4606     } else {
4607       // var descriptor case
4608       enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc();
4609     }
4610     // System.out.println("enclosingDescriptor=" + enclosingDescriptor);
4611
4612     LocationDescriptor newLocDescriptor = generateNewLocationDescriptor();
4613     newLocDescriptor.setEnclosingClassDesc(enclosingDescriptor);
4614
4615     Location newLoc = new Location(enclosingDescriptor, newLocDescriptor.getSymbol());
4616     newLoc.setLocDescriptor(newLocDescriptor);
4617     newCompLoc.addLocation(newLoc);
4618
4619     // System.out.println("--newCompLoc=" + newCompLoc);
4620     return newCompLoc;
4621   }
4622
4623   private List<NTuple<Descriptor>> translatePrefixListToCallee(Descriptor baseRef,
4624       MethodDescriptor mdCallee, List<NTuple<Descriptor>> callerPrefixList) {
4625
4626     List<NTuple<Descriptor>> calleePrefixList = new ArrayList<NTuple<Descriptor>>();
4627
4628     for (int i = 0; i < callerPrefixList.size(); i++) {
4629       NTuple<Descriptor> prefix = callerPrefixList.get(i);
4630       if (prefix.startsWith(baseRef)) {
4631         NTuple<Descriptor> calleePrefix = new NTuple<Descriptor>();
4632         calleePrefix.add(mdCallee.getThis());
4633         for (int k = 1; k < prefix.size(); k++) {
4634           calleePrefix.add(prefix.get(k));
4635         }
4636         calleePrefixList.add(calleePrefix);
4637       }
4638     }
4639
4640     return calleePrefixList;
4641
4642   }
4643
4644   public CompositeLocation convertToCompositeLocation(MethodDescriptor md, NTuple<Descriptor> tuple) {
4645
4646     CompositeLocation compLoc = new CompositeLocation();
4647
4648     Descriptor enclosingDescriptor = md;
4649
4650     for (int i = 0; i < tuple.size(); i++) {
4651       Descriptor curDescriptor = tuple.get(i);
4652       Location locElement = new Location(enclosingDescriptor, curDescriptor.getSymbol());
4653       locElement.setLocDescriptor(curDescriptor);
4654       compLoc.addLocation(locElement);
4655
4656       if (curDescriptor instanceof VarDescriptor) {
4657         enclosingDescriptor = md.getClassDesc();
4658       } else if (curDescriptor instanceof FieldDescriptor) {
4659         enclosingDescriptor = ((FieldDescriptor) curDescriptor).getClassDescriptor();
4660       } else if (curDescriptor instanceof NameDescriptor) {
4661         // it is "GLOBAL LOC" case!
4662         enclosingDescriptor = GLOBALDESC;
4663       } else if (curDescriptor instanceof InterDescriptor) {
4664         enclosingDescriptor = getFlowGraph(md).getEnclosingDescriptor(curDescriptor);
4665       } else {
4666         enclosingDescriptor = null;
4667       }
4668
4669     }
4670
4671     return compLoc;
4672   }
4673
4674   private LocationDescriptor generateNewLocationDescriptor() {
4675     return new LocationDescriptor("Loc" + (locSeed++));
4676   }
4677
4678   private int getPrefixIndex(NTuple<Descriptor> tuple1, NTuple<Descriptor> tuple2) {
4679
4680     // return the index where the prefix shared by tuple1 and tuple2 is ended
4681     // if there is no prefix shared by both of them, return -1
4682
4683     int minSize = tuple1.size();
4684     if (minSize > tuple2.size()) {
4685       minSize = tuple2.size();
4686     }
4687
4688     int idx = -1;
4689     for (int i = 0; i < minSize; i++) {
4690       if (!tuple1.get(i).equals(tuple2.get(i))) {
4691         break;
4692       } else {
4693         idx++;
4694       }
4695     }
4696
4697     return idx;
4698   }
4699
4700   private CompositeLocation generateInferredCompositeLocation(MethodLocationInfo methodInfo,
4701       NTuple<Location> tuple) {
4702
4703     // first, retrieve inferred location by the local var descriptor
4704     CompositeLocation inferLoc = new CompositeLocation();
4705
4706     CompositeLocation localVarInferLoc =
4707         methodInfo.getInferLocation(tuple.get(0).getLocDescriptor());
4708
4709     localVarInferLoc.get(0).setLocDescriptor(tuple.get(0).getLocDescriptor());
4710
4711     for (int i = 0; i < localVarInferLoc.getSize(); i++) {
4712       inferLoc.addLocation(localVarInferLoc.get(i));
4713     }
4714
4715     for (int i = 1; i < tuple.size(); i++) {
4716       Location cur = tuple.get(i);
4717       Descriptor enclosingDesc = cur.getDescriptor();
4718       Descriptor curDesc = cur.getLocDescriptor();
4719
4720       Location inferLocElement;
4721       if (curDesc == null) {
4722         // in this case, we have a newly generated location.
4723         inferLocElement = new Location(enclosingDesc, cur.getLocIdentifier());
4724       } else {
4725         String fieldLocSymbol =
4726             getLocationInfo(enclosingDesc).getInferLocation(curDesc).get(0).getLocIdentifier();
4727         inferLocElement = new Location(enclosingDesc, fieldLocSymbol);
4728         inferLocElement.setLocDescriptor(curDesc);
4729       }
4730
4731       inferLoc.addLocation(inferLocElement);
4732
4733     }
4734
4735     assert (inferLoc.get(0).getLocDescriptor().getSymbol() == inferLoc.get(0).getLocIdentifier());
4736     return inferLoc;
4737   }
4738
4739   public LocationInfo getLocationInfo(Descriptor d) {
4740     if (d instanceof MethodDescriptor) {
4741       return getMethodLocationInfo((MethodDescriptor) d);
4742     } else {
4743       return getFieldLocationInfo((ClassDescriptor) d);
4744     }
4745   }
4746
4747   private MethodLocationInfo getMethodLocationInfo(MethodDescriptor md) {
4748
4749     if (!mapMethodDescToMethodLocationInfo.containsKey(md)) {
4750       mapMethodDescToMethodLocationInfo.put(md, new MethodLocationInfo(md));
4751     }
4752
4753     return mapMethodDescToMethodLocationInfo.get(md);
4754
4755   }
4756
4757   private LocationInfo getFieldLocationInfo(ClassDescriptor cd) {
4758
4759     if (!mapClassToLocationInfo.containsKey(cd)) {
4760       mapClassToLocationInfo.put(cd, new LocationInfo(cd));
4761     }
4762
4763     return mapClassToLocationInfo.get(cd);
4764
4765   }
4766
4767   private void addPrefixMapping(Map<NTuple<Location>, Set<NTuple<Location>>> map,
4768       NTuple<Location> prefix, NTuple<Location> element) {
4769
4770     if (!map.containsKey(prefix)) {
4771       map.put(prefix, new HashSet<NTuple<Location>>());
4772     }
4773     map.get(prefix).add(element);
4774   }
4775
4776   private boolean containsNonPrimitiveElement(Set<Descriptor> descSet) {
4777     for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
4778       Descriptor desc = (Descriptor) iterator.next();
4779
4780       if (desc.equals(LocationInference.GLOBALDESC)) {
4781         return true;
4782       } else if (desc instanceof VarDescriptor) {
4783         if (!((VarDescriptor) desc).getType().isPrimitive()) {
4784           return true;
4785         }
4786       } else if (desc instanceof FieldDescriptor) {
4787         if (!((FieldDescriptor) desc).getType().isPrimitive()) {
4788           return true;
4789         }
4790       }
4791
4792     }
4793     return false;
4794   }
4795
4796   public SSJavaLattice<String> getLattice(Descriptor d) {
4797     if (d instanceof MethodDescriptor) {
4798       return getMethodLattice((MethodDescriptor) d);
4799     } else {
4800       return getFieldLattice((ClassDescriptor) d);
4801     }
4802   }
4803
4804   private SSJavaLattice<String> getMethodLattice(MethodDescriptor md) {
4805     if (!md2lattice.containsKey(md)) {
4806       md2lattice.put(md, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
4807     }
4808     return md2lattice.get(md);
4809   }
4810
4811   private void setMethodLattice(MethodDescriptor md, SSJavaLattice<String> lattice) {
4812     md2lattice.put(md, lattice);
4813   }
4814
4815   private void extractFlowsBetweenFields(ClassDescriptor cd, FlowNode srcNode, FlowNode dstNode,
4816       int idx) {
4817
4818     NTuple<Descriptor> srcCurTuple = srcNode.getCurrentDescTuple();
4819     NTuple<Descriptor> dstCurTuple = dstNode.getCurrentDescTuple();
4820
4821     if (srcCurTuple.get(idx).equals(dstCurTuple.get(idx)) && srcCurTuple.size() > (idx + 1)
4822         && dstCurTuple.size() > (idx + 1)) {
4823       // value flow between fields: we don't need to add a binary relation
4824       // for this case
4825
4826       Descriptor desc = srcCurTuple.get(idx);
4827       ClassDescriptor classDesc;
4828
4829       if (idx == 0) {
4830         classDesc = ((VarDescriptor) desc).getType().getClassDesc();
4831       } else {
4832         if (desc instanceof FieldDescriptor) {
4833           classDesc = ((FieldDescriptor) desc).getType().getClassDesc();
4834         } else {
4835           // this case is that the local variable has a composite location assignment
4836           // the following element after the composite location to the local variable
4837           // has the enclosing descriptor of the local variable
4838           Descriptor localDesc = srcNode.getDescTuple().get(0);
4839           classDesc = ((VarDescriptor) localDesc).getType().getClassDesc();
4840         }
4841       }
4842       extractFlowsBetweenFields(classDesc, srcNode, dstNode, idx + 1);
4843
4844     } else {
4845
4846       Descriptor srcFieldDesc = srcCurTuple.get(idx);
4847       Descriptor dstFieldDesc = dstCurTuple.get(idx);
4848
4849       // System.out.println("srcFieldDesc=" + srcFieldDesc + "  dstFieldDesc=" + dstFieldDesc
4850       // + "   idx=" + idx);
4851       if (!srcFieldDesc.equals(dstFieldDesc)) {
4852         // add a new edge
4853         // System.out.println("-ADD EDGE");
4854         getHierarchyGraph(cd).addEdge(srcFieldDesc, dstFieldDesc);
4855       } else if (!isReference(srcFieldDesc) && !isReference(dstFieldDesc)) {
4856         // System.out.println("-ADD EDGE");
4857         getHierarchyGraph(cd).addEdge(srcFieldDesc, dstFieldDesc);
4858       }
4859
4860     }
4861
4862   }
4863
4864   public SSJavaLattice<String> getFieldLattice(ClassDescriptor cd) {
4865     if (!cd2lattice.containsKey(cd)) {
4866       cd2lattice.put(cd, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
4867     }
4868     return cd2lattice.get(cd);
4869   }
4870
4871   public LinkedList<MethodDescriptor> computeMethodList() {
4872
4873     Set<MethodDescriptor> toSort = new HashSet<MethodDescriptor>();
4874
4875     setupToAnalyze();
4876
4877     Set<MethodDescriptor> visited = new HashSet<MethodDescriptor>();
4878     Set<MethodDescriptor> reachableCallee = new HashSet<MethodDescriptor>();
4879
4880     while (!toAnalyzeIsEmpty()) {
4881       ClassDescriptor cd = toAnalyzeNext();
4882
4883       if (cd.getClassName().equals("Object")) {
4884         rootClassDescriptor = cd;
4885         // inheritanceTree = new InheritanceTree<ClassDescriptor>(cd);
4886       }
4887
4888       setupToAnalazeMethod(cd);
4889       temp_toanalyzeMethodList.removeAll(visited);
4890
4891       while (!toAnalyzeMethodIsEmpty()) {
4892         MethodDescriptor md = toAnalyzeMethodNext();
4893         if ((!visited.contains(md))
4894             && (ssjava.needTobeAnnotated(md) || reachableCallee.contains(md))) {
4895
4896           // creates a mapping from a method descriptor to virtual methods
4897           Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
4898           if (md.isStatic()) {
4899             setPossibleCallees.add(md);
4900           } else {
4901             setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md));
4902           }
4903
4904           Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getCalleeSet(md);
4905           Set<MethodDescriptor> needToAnalyzeCalleeSet = new HashSet<MethodDescriptor>();
4906
4907           for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
4908             MethodDescriptor calleemd = (MethodDescriptor) iterator.next();
4909             if ((!ssjava.isTrustMethod(calleemd))
4910                 && (!ssjava.isSSJavaUtil(calleemd.getClassDesc()))
4911                 && (!calleemd.getModifiers().isNative())) {
4912               if (!visited.contains(calleemd)) {
4913                 temp_toanalyzeMethodList.add(calleemd);
4914               }
4915               reachableCallee.add(calleemd);
4916               needToAnalyzeCalleeSet.add(calleemd);
4917             }
4918           }
4919
4920           mapMethodToCalleeSet.put(md, needToAnalyzeCalleeSet);
4921
4922           visited.add(md);
4923
4924           toSort.add(md);
4925         }
4926       }
4927     }
4928
4929     return ssjava.topologicalSort(toSort);
4930
4931   }
4932
4933   public boolean isTransitivelyCalledFrom(MethodDescriptor callee, MethodDescriptor caller) {
4934     // if the callee is transitively invoked from the caller
4935     // return true;
4936
4937     int callerIdx = toanalyze_methodDescList.indexOf(caller);
4938     int calleeIdx = toanalyze_methodDescList.indexOf(callee);
4939
4940     if (callerIdx < calleeIdx) {
4941       return true;
4942     }
4943
4944     return false;
4945
4946   }
4947
4948   public void constructFlowGraph() {
4949
4950     System.out.println("");
4951     toanalyze_methodDescList = computeMethodList();
4952
4953     // hack... it seems that there is a problem with topological sorting.
4954     // so String.toString(Object o) is appeared too higher in the call chain.
4955     MethodDescriptor mdToString1 = null;
4956     MethodDescriptor mdToString2 = null;
4957     for (Iterator iterator = toanalyze_methodDescList.iterator(); iterator.hasNext();) {
4958       MethodDescriptor md = (MethodDescriptor) iterator.next();
4959       if (md.toString().equals("public static String String.valueOf(Object o)")) {
4960         mdToString1 = md;
4961       }
4962       if (md.toString().equals("public String Object.toString()")) {
4963         mdToString2 = md;
4964       }
4965     }
4966
4967     if (mdToString1 != null) {
4968       toanalyze_methodDescList.remove(mdToString1);
4969       toanalyze_methodDescList.addLast(mdToString1);
4970     }
4971     if (mdToString2 != null) {
4972       toanalyze_methodDescList.remove(mdToString2);
4973       toanalyze_methodDescList.addLast(mdToString2);
4974     }
4975
4976     LinkedList<MethodDescriptor> methodDescList =
4977         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
4978
4979     // System.out.println("@@@methodDescList=" + methodDescList);
4980     // System.exit(0);
4981
4982     while (!methodDescList.isEmpty()) {
4983       MethodDescriptor md = methodDescList.removeLast();
4984       if (state.SSJAVADEBUG) {
4985         System.out.println();
4986         System.out.println("SSJAVA: Constructing a flow graph: " + md);
4987
4988         // creates a mapping from a parameter descriptor to its index
4989         Map<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
4990         int offset = 0;
4991         if (!md.isStatic()) {
4992           offset = 1;
4993           mapParamDescToIdx.put(md.getThis(), 0);
4994         }
4995
4996         for (int i = 0; i < md.numParameters(); i++) {
4997           Descriptor paramDesc = (Descriptor) md.getParameter(i);
4998           mapParamDescToIdx.put(paramDesc, new Integer(i + offset));
4999         }
5000
5001         FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
5002         mapMethodDescriptorToFlowGraph.put(md, fg);
5003
5004         analyzeMethodBody(md.getClassDesc(), md);
5005
5006         // System.out.println("##constructSubGlobalFlowGraph");
5007         // GlobalFlowGraph subGlobalFlowGraph = constructSubGlobalFlowGraph(fg);
5008         // mapMethodDescriptorToSubGlobalFlowGraph.put(md, subGlobalFlowGraph);
5009         //
5010         // // TODO
5011         // System.out.println("##addValueFlowsFromCalleeSubGlobalFlowGraph");
5012         // addValueFlowsFromCalleeSubGlobalFlowGraph(md, subGlobalFlowGraph);
5013         // subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
5014         //
5015         // propagateFlowsFromCalleesWithNoCompositeLocation(md);
5016       }
5017     }
5018     // _debug_printGraph();
5019
5020   }
5021
5022   private void constructGlobalFlowGraph() {
5023     LinkedList<MethodDescriptor> methodDescList =
5024         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
5025
5026     while (!methodDescList.isEmpty()) {
5027       MethodDescriptor md = methodDescList.removeLast();
5028       if (state.SSJAVADEBUG) {
5029         System.out.println();
5030         System.out.println("SSJAVA: Constructing a sub global flow graph: " + md);
5031
5032         constructSubGlobalFlowGraph(getFlowGraph(md));
5033
5034         // TODO
5035         // System.out.println("-add Value Flows From CalleeSubGlobalFlowGraph");
5036         addValueFlowsFromCalleeSubGlobalFlowGraph(md);
5037         // subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
5038
5039         // System.out.println("-propagate Flows From Callees With No CompositeLocation");
5040         // propagateFlowsFromCalleesWithNoCompositeLocation(md);
5041
5042         // mark if a parameter has incoming flows
5043         checkParamNodesInSubGlobalFlowGraph(md);
5044
5045       }
5046     }
5047   }
5048
5049   private void checkParamNodesInSubGlobalFlowGraph(MethodDescriptor md) {
5050     GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
5051     FlowGraph flowGraph = getFlowGraph(md);
5052
5053     Set<FlowNode> paramFlowNodeSet = flowGraph.getParamFlowNodeSet();
5054     for (Iterator iterator = paramFlowNodeSet.iterator(); iterator.hasNext();) {
5055       FlowNode paramFlowNode = (FlowNode) iterator.next();
5056       // System.out.println("paramFlowNode=" + paramFlowNode);
5057       NTuple<Descriptor> paramDescTuple = paramFlowNode.getDescTuple();
5058       NTuple<Location> paramLocTuple = translateToLocTuple(md, paramDescTuple);
5059       GlobalFlowNode paramGlobalNode = globalFlowGraph.getFlowNode(paramLocTuple);
5060
5061       Set<GlobalFlowNode> incomingNodeSet =
5062           globalFlowGraph.getIncomingNodeSetByPrefix(paramLocTuple.get(0));
5063
5064       if (incomingNodeSet.size() > 0) {
5065         paramGlobalNode.setParamNodeWithIncomingFlows(true);
5066       }
5067
5068     }
5069   }
5070
5071   private Set<MethodInvokeNode> getMethodInvokeNodeSet(MethodDescriptor md) {
5072     if (!mapMethodDescriptorToMethodInvokeNodeSet.containsKey(md)) {
5073       mapMethodDescriptorToMethodInvokeNodeSet.put(md, new HashSet<MethodInvokeNode>());
5074     }
5075     return mapMethodDescriptorToMethodInvokeNodeSet.get(md);
5076   }
5077
5078   private void propagateFlowsFromCalleesWithNoCompositeLocation(MethodDescriptor mdCaller) {
5079
5080     // the transformation for a call site propagates flows through parameters
5081     // if the method is virtual, it also grab all relations from any possible
5082     // callees
5083
5084     Set<MethodInvokeNode> setMethodInvokeNode =
5085         mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
5086
5087     if (setMethodInvokeNode != null) {
5088
5089       for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
5090         MethodInvokeNode min = (MethodInvokeNode) iterator.next();
5091         MethodDescriptor mdCallee = min.getMethod();
5092         Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
5093         if (mdCallee.isStatic()) {
5094           setPossibleCallees.add(mdCallee);
5095         } else {
5096           Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getMethods(mdCallee);
5097           // removes method descriptors that are not invoked by the caller
5098           calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller));
5099           setPossibleCallees.addAll(calleeSet);
5100         }
5101
5102         for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) {
5103           MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next();
5104           propagateFlowsToCallerWithNoCompositeLocation(min, mdCaller, possibleMdCallee);
5105         }
5106
5107       }
5108     }
5109
5110   }
5111
5112   private void analyzeMethodBody(ClassDescriptor cd, MethodDescriptor md) {
5113     BlockNode bn = state.getMethodBody(md);
5114     NodeTupleSet implicitFlowTupleSet = new NodeTupleSet();
5115     analyzeFlowBlockNode(md, md.getParameterTable(), bn, implicitFlowTupleSet);
5116   }
5117
5118   private void analyzeFlowBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn,
5119       NodeTupleSet implicitFlowTupleSet) {
5120
5121     bn.getVarTable().setParent(nametable);
5122     for (int i = 0; i < bn.size(); i++) {
5123       BlockStatementNode bsn = bn.get(i);
5124       analyzeBlockStatementNode(md, bn.getVarTable(), bsn, implicitFlowTupleSet);
5125     }
5126
5127   }
5128
5129   private void analyzeBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
5130       BlockStatementNode bsn, NodeTupleSet implicitFlowTupleSet) {
5131
5132     switch (bsn.kind()) {
5133     case Kind.BlockExpressionNode:
5134       analyzeBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, implicitFlowTupleSet);
5135       break;
5136
5137     case Kind.DeclarationNode:
5138       analyzeFlowDeclarationNode(md, nametable, (DeclarationNode) bsn, implicitFlowTupleSet);
5139       break;
5140
5141     case Kind.IfStatementNode:
5142       analyzeFlowIfStatementNode(md, nametable, (IfStatementNode) bsn, implicitFlowTupleSet);
5143       break;
5144
5145     case Kind.LoopNode:
5146       analyzeFlowLoopNode(md, nametable, (LoopNode) bsn, implicitFlowTupleSet);
5147       break;
5148
5149     case Kind.ReturnNode:
5150       analyzeFlowReturnNode(md, nametable, (ReturnNode) bsn, implicitFlowTupleSet);
5151       break;
5152
5153     case Kind.SubBlockNode:
5154       analyzeFlowSubBlockNode(md, nametable, (SubBlockNode) bsn, implicitFlowTupleSet);
5155       break;
5156
5157     case Kind.ContinueBreakNode:
5158       break;
5159
5160     case Kind.SwitchStatementNode:
5161       analyzeSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, implicitFlowTupleSet);
5162       break;
5163
5164     }
5165
5166   }
5167
5168   private void analyzeSwitchBlockNode(MethodDescriptor md, SymbolTable nametable,
5169       SwitchBlockNode sbn, NodeTupleSet implicitFlowTupleSet) {
5170
5171     analyzeFlowBlockNode(md, nametable, sbn.getSwitchBlockStatement(), implicitFlowTupleSet);
5172
5173   }
5174
5175   private void analyzeSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
5176       SwitchStatementNode ssn, NodeTupleSet implicitFlowTupleSet) {
5177
5178     NodeTupleSet condTupleNode = new NodeTupleSet();
5179     analyzeFlowExpressionNode(md, nametable, ssn.getCondition(), condTupleNode, null,
5180         implicitFlowTupleSet, false);
5181
5182     NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5183
5184     newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5185     newImplicitTupleSet.addTupleSet(condTupleNode);
5186
5187     if (needToGenerateInterLoc(newImplicitTupleSet)) {
5188       // need to create an intermediate node for the GLB of conditional
5189       // locations & implicit flows
5190
5191       NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5192       for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
5193         NTuple<Descriptor> tuple = idxIter.next();
5194         addFlowGraphEdge(md, tuple, interTuple);
5195       }
5196       newImplicitTupleSet.clear();
5197       newImplicitTupleSet.addTuple(interTuple);
5198     }
5199
5200     BlockNode sbn = ssn.getSwitchBody();
5201     for (int i = 0; i < sbn.size(); i++) {
5202       analyzeSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), newImplicitTupleSet);
5203     }
5204
5205   }
5206
5207   private void analyzeFlowSubBlockNode(MethodDescriptor md, SymbolTable nametable,
5208       SubBlockNode sbn, NodeTupleSet implicitFlowTupleSet) {
5209     analyzeFlowBlockNode(md, nametable, sbn.getBlockNode(), implicitFlowTupleSet);
5210   }
5211
5212   private void analyzeFlowReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn,
5213       NodeTupleSet implicitFlowTupleSet) {
5214
5215     // System.out.println("-analyzeFlowReturnNode=" + rn.printNode(0));
5216     ExpressionNode returnExp = rn.getReturnExpression();
5217
5218     if (returnExp != null) {
5219       NodeTupleSet nodeSet = new NodeTupleSet();
5220       // if a return expression returns a literal value, nodeSet is empty
5221       analyzeFlowExpressionNode(md, nametable, returnExp, nodeSet, false);
5222       FlowGraph fg = getFlowGraph(md);
5223
5224       // if (implicitFlowTupleSet.size() == 1
5225       // &&
5226       // fg.getFlowNode(implicitFlowTupleSet.iterator().next()).isIntermediate())
5227       // {
5228       //
5229       // // since there is already an intermediate node for the GLB of implicit
5230       // flows
5231       // // we don't need to create another intermediate node.
5232       // // just re-use the intermediate node for implicit flows.
5233       //
5234       // FlowNode meetNode =
5235       // fg.getFlowNode(implicitFlowTupleSet.iterator().next());
5236       //
5237       // for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
5238       // NTuple<Descriptor> returnNodeTuple = (NTuple<Descriptor>)
5239       // iterator.next();
5240       // fg.addValueFlowEdge(returnNodeTuple, meetNode.getDescTuple());
5241       // }
5242       //
5243       // }
5244
5245       NodeTupleSet currentFlowTupleSet = new NodeTupleSet();
5246
5247       // add tuples from return node
5248       currentFlowTupleSet.addTupleSet(nodeSet);
5249
5250       // add tuples corresponding to the current implicit flows
5251       currentFlowTupleSet.addTupleSet(implicitFlowTupleSet);
5252
5253       // System.out.println("---currentFlowTupleSet=" + currentFlowTupleSet);
5254
5255       if (needToGenerateInterLoc(currentFlowTupleSet)) {
5256
5257         FlowNode meetNode = fg.createIntermediateNode();
5258         for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) {
5259           NTuple<Descriptor> currentFlowTuple = (NTuple<Descriptor>) iterator.next();
5260           fg.addValueFlowEdge(currentFlowTuple, meetNode.getDescTuple());
5261         }
5262         fg.addReturnFlowNode(meetNode.getDescTuple());
5263       } else {
5264         // currentFlowTupleSet = removeLiteralTuple(currentFlowTupleSet);
5265         for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) {
5266           NTuple<Descriptor> currentFlowTuple = (NTuple<Descriptor>) iterator.next();
5267           fg.addReturnFlowNode(currentFlowTuple);
5268         }
5269       }
5270
5271     }
5272
5273   }
5274
5275   private NodeTupleSet removeLiteralTuple(NodeTupleSet inSet) {
5276     NodeTupleSet tupleSet = new NodeTupleSet();
5277     for (Iterator<NTuple<Descriptor>> iter = inSet.iterator(); iter.hasNext();) {
5278       NTuple<Descriptor> tuple = iter.next();
5279       if (!tuple.get(0).equals(LITERALDESC)) {
5280         tupleSet.addTuple(tuple);
5281       }
5282     }
5283     return tupleSet;
5284   }
5285
5286   private boolean needToGenerateInterLoc(NodeTupleSet tupleSet) {
5287     int size = 0;
5288     for (Iterator<NTuple<Descriptor>> iter = tupleSet.iterator(); iter.hasNext();) {
5289       NTuple<Descriptor> descTuple = iter.next();
5290       if (!descTuple.get(0).equals(LITERALDESC)) {
5291         size++;
5292       }
5293     }
5294     if (size > 1) {
5295       // System.out.println("needToGenerateInterLoc=" + tupleSet + "  size=" + size);
5296       return true;
5297     } else {
5298       return false;
5299     }
5300   }
5301
5302   private void analyzeFlowLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln,
5303       NodeTupleSet implicitFlowTupleSet) {
5304
5305     if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
5306
5307       NodeTupleSet condTupleNode = new NodeTupleSet();
5308       analyzeFlowExpressionNode(md, nametable, ln.getCondition(), condTupleNode, null,
5309           implicitFlowTupleSet, false);
5310
5311       NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5312
5313       newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5314       newImplicitTupleSet.addTupleSet(condTupleNode);
5315
5316       newImplicitTupleSet.addGlobalFlowTupleSet(implicitFlowTupleSet.getGlobalLocTupleSet());
5317       newImplicitTupleSet.addGlobalFlowTupleSet(condTupleNode.getGlobalLocTupleSet());
5318
5319       if (needToGenerateInterLoc(newImplicitTupleSet)) {
5320         // need to create an intermediate node for the GLB of conditional
5321         // locations & implicit flows
5322
5323         NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5324         for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter
5325             .hasNext();) {
5326           NTuple<Descriptor> tuple = idxIter.next();
5327           addFlowGraphEdge(md, tuple, interTuple);
5328         }
5329         newImplicitTupleSet.clear();
5330         newImplicitTupleSet.addTuple(interTuple);
5331
5332       }
5333
5334       // ///////////
5335       // System.out.println("condTupleNode="+condTupleNode);
5336       // NTuple<Descriptor> interTuple =
5337       // getFlowGraph(md).createIntermediateNode().getDescTuple();
5338       //
5339       // for (Iterator<NTuple<Descriptor>> idxIter = condTupleNode.iterator();
5340       // idxIter.hasNext();) {
5341       // NTuple<Descriptor> tuple = idxIter.next();
5342       // addFlowGraphEdge(md, tuple, interTuple);
5343       // }
5344
5345       // for (Iterator<NTuple<Descriptor>> idxIter =
5346       // implicitFlowTupleSet.iterator(); idxIter
5347       // .hasNext();) {
5348       // NTuple<Descriptor> tuple = idxIter.next();
5349       // addFlowGraphEdge(md, tuple, interTuple);
5350       // }
5351
5352       // NodeTupleSet newImplicitSet = new NodeTupleSet();
5353       // newImplicitSet.addTuple(interTuple);
5354       analyzeFlowBlockNode(md, nametable, ln.getBody(), newImplicitTupleSet);
5355       // ///////////
5356
5357       // condTupleNode.addTupleSet(implicitFlowTupleSet);
5358
5359       // add edges from condNodeTupleSet to all nodes of conditional nodes
5360       // analyzeFlowBlockNode(md, nametable, ln.getBody(), condTupleNode);
5361
5362     } else {
5363       // check 'for loop' case
5364       BlockNode bn = ln.getInitializer();
5365       bn.getVarTable().setParent(nametable);
5366       for (int i = 0; i < bn.size(); i++) {
5367         BlockStatementNode bsn = bn.get(i);
5368         analyzeBlockStatementNode(md, bn.getVarTable(), bsn, implicitFlowTupleSet);
5369       }
5370
5371       NodeTupleSet condTupleNode = new NodeTupleSet();
5372       analyzeFlowExpressionNode(md, bn.getVarTable(), ln.getCondition(), condTupleNode, null,
5373           implicitFlowTupleSet, false);
5374
5375       NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5376       newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5377       newImplicitTupleSet.addTupleSet(condTupleNode);
5378
5379       if (needToGenerateInterLoc(newImplicitTupleSet)) {
5380         // need to create an intermediate node for the GLB of conditional
5381         // locations & implicit flows
5382
5383         NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5384         for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter
5385             .hasNext();) {
5386           NTuple<Descriptor> tuple = idxIter.next();
5387           addFlowGraphEdge(md, tuple, interTuple);
5388         }
5389         newImplicitTupleSet.clear();
5390         newImplicitTupleSet.addTuple(interTuple);
5391
5392       }
5393
5394       // ///////////
5395       // NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5396       //
5397       // for (Iterator<NTuple<Descriptor>> idxIter = condTupleNode.iterator(); idxIter.hasNext();) {
5398       // NTuple<Descriptor> tuple = idxIter.next();
5399       // addFlowGraphEdge(md, tuple, interTuple);
5400       // }
5401       //
5402       // for (Iterator<NTuple<Descriptor>> idxIter = implicitFlowTupleSet.iterator(); idxIter
5403       // .hasNext();) {
5404       // NTuple<Descriptor> tuple = idxIter.next();
5405       // addFlowGraphEdge(md, tuple, interTuple);
5406       // }
5407       //
5408       // NodeTupleSet newImplicitSet = new NodeTupleSet();
5409       // newImplicitSet.addTuple(interTuple);
5410       analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(), newImplicitTupleSet);
5411       analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(), newImplicitTupleSet);
5412       // ///////////
5413
5414       // condTupleNode.addTupleSet(implicitFlowTupleSet);
5415       //
5416       // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(),
5417       // condTupleNode);
5418       // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(),
5419       // condTupleNode);
5420
5421     }
5422
5423   }
5424
5425   private void analyzeFlowIfStatementNode(MethodDescriptor md, SymbolTable nametable,
5426       IfStatementNode isn, NodeTupleSet implicitFlowTupleSet) {
5427
5428     // System.out.println("analyzeFlowIfStatementNode=" + isn.printNode(0));
5429
5430     NodeTupleSet condTupleNode = new NodeTupleSet();
5431     analyzeFlowExpressionNode(md, nametable, isn.getCondition(), condTupleNode, null,
5432         implicitFlowTupleSet, false);
5433
5434     NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5435
5436     newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5437     newImplicitTupleSet.addTupleSet(condTupleNode);
5438
5439     // System.out.println("$$$GGGcondTupleNode=" + condTupleNode.getGlobalLocTupleSet());
5440     // System.out.println("-condTupleNode=" + condTupleNode);
5441     // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
5442     // System.out.println("-newImplicitTupleSet=" + newImplicitTupleSet);
5443
5444     if (needToGenerateInterLoc(newImplicitTupleSet)) {
5445
5446       // need to create an intermediate node for the GLB of conditional locations & implicit flows
5447       NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5448       for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
5449         NTuple<Descriptor> tuple = idxIter.next();
5450         addFlowGraphEdge(md, tuple, interTuple);
5451       }
5452       newImplicitTupleSet.clear();
5453       newImplicitTupleSet.addTuple(interTuple);
5454     }
5455
5456     // GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
5457     // for (Iterator<NTuple<Location>> iterator = condTupleNode.globalIterator();
5458     // iterator.hasNext();) {
5459     // NTuple<Location> calleeReturnLocTuple = iterator.next();
5460     // for (Iterator<NTuple<Descriptor>> iter2 = newImplicitTupleSet.iterator(); iter2.hasNext();) {
5461     // NTuple<Descriptor> callerImplicitTuple = iter2.next();
5462     // globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
5463     // translateToLocTuple(md, callerImplicitTuple));
5464     // }
5465     // }
5466     newImplicitTupleSet.addGlobalFlowTupleSet(condTupleNode.getGlobalLocTupleSet());
5467
5468     analyzeFlowBlockNode(md, nametable, isn.getTrueBlock(), newImplicitTupleSet);
5469
5470     if (isn.getFalseBlock() != null) {
5471       analyzeFlowBlockNode(md, nametable, isn.getFalseBlock(), newImplicitTupleSet);
5472     }
5473
5474   }
5475
5476   private void analyzeFlowDeclarationNode(MethodDescriptor md, SymbolTable nametable,
5477       DeclarationNode dn, NodeTupleSet implicitFlowTupleSet) {
5478
5479     VarDescriptor vd = dn.getVarDescriptor();
5480     mapDescToDefinitionLine.put(vd, dn.getNumLine());
5481     NTuple<Descriptor> tupleLHS = new NTuple<Descriptor>();
5482     tupleLHS.add(vd);
5483     FlowNode fn = getFlowGraph(md).createNewFlowNode(tupleLHS);
5484     fn.setDeclarationNode();
5485
5486     if (dn.getExpression() != null) {
5487       // System.out.println("-analyzeFlowDeclarationNode=" + dn.printNode(0));
5488
5489       NodeTupleSet nodeSetRHS = new NodeTupleSet();
5490       analyzeFlowExpressionNode(md, nametable, dn.getExpression(), nodeSetRHS, null,
5491           implicitFlowTupleSet, false);
5492
5493       // creates edges from RHS to LHS
5494       NTuple<Descriptor> interTuple = null;
5495       if (needToGenerateInterLoc(nodeSetRHS)) {
5496         interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5497       }
5498
5499       for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
5500         NTuple<Descriptor> fromTuple = iter.next();
5501         // System.out.println("fromTuple=" + fromTuple + "  interTuple=" + interTuple + " tupleLSH="
5502         // + tupleLHS);
5503         addFlowGraphEdge(md, fromTuple, interTuple, tupleLHS);
5504       }
5505
5506       // creates edges from implicitFlowTupleSet to LHS
5507       for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
5508         NTuple<Descriptor> implicitTuple = iter.next();
5509         addFlowGraphEdge(md, implicitTuple, tupleLHS);
5510       }
5511
5512       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
5513       for (Iterator<NTuple<Location>> iterator = nodeSetRHS.globalIterator(); iterator.hasNext();) {
5514         NTuple<Location> calleeReturnLocTuple = iterator.next();
5515
5516         globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple, translateToLocTuple(md, tupleLHS));
5517       }
5518
5519       for (Iterator<NTuple<Location>> iterator = implicitFlowTupleSet.globalIterator(); iterator
5520           .hasNext();) {
5521         NTuple<Location> implicitGlobalTuple = iterator.next();
5522
5523         globalFlowGraph.addValueFlowEdge(implicitGlobalTuple, translateToLocTuple(md, tupleLHS));
5524       }
5525
5526       // System.out.println("-nodeSetRHS=" + nodeSetRHS);
5527       // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
5528
5529     }
5530
5531   }
5532
5533   private void analyzeBlockExpressionNode(MethodDescriptor md, SymbolTable nametable,
5534       BlockExpressionNode ben, NodeTupleSet implicitFlowTupleSet) {
5535     analyzeFlowExpressionNode(md, nametable, ben.getExpression(), null, null, implicitFlowTupleSet,
5536         false);
5537   }
5538
5539   private NTuple<Descriptor> analyzeFlowExpressionNode(MethodDescriptor md, SymbolTable nametable,
5540       ExpressionNode en, NodeTupleSet nodeSet, boolean isLHS) {
5541     return analyzeFlowExpressionNode(md, nametable, en, nodeSet, null, new NodeTupleSet(), isLHS);
5542   }
5543
5544   private NTuple<Descriptor> analyzeFlowExpressionNode(MethodDescriptor md, SymbolTable nametable,
5545       ExpressionNode en, NodeTupleSet nodeSet, NTuple<Descriptor> base,
5546       NodeTupleSet implicitFlowTupleSet, boolean isLHS) {
5547
5548     // System.out.println("en=" + en.printNode(0) + "   class=" + en.getClass());
5549
5550     // note that expression node can create more than one flow node
5551     // nodeSet contains of flow nodes
5552     // base is always assigned to null except the case of a name node!
5553     NTuple<Descriptor> flowTuple;
5554     switch (en.kind()) {
5555     case Kind.AssignmentNode:
5556       analyzeFlowAssignmentNode(md, nametable, (AssignmentNode) en, nodeSet, base,
5557           implicitFlowTupleSet);
5558       break;
5559
5560     case Kind.FieldAccessNode:
5561       flowTuple =
5562           analyzeFlowFieldAccessNode(md, nametable, (FieldAccessNode) en, nodeSet, base,
5563               implicitFlowTupleSet, isLHS);
5564       if (flowTuple != null) {
5565         nodeSet.addTuple(flowTuple);
5566       }
5567       return flowTuple;
5568
5569     case Kind.NameNode:
5570       NodeTupleSet nameNodeSet = new NodeTupleSet();
5571       flowTuple =
5572           analyzeFlowNameNode(md, nametable, (NameNode) en, nameNodeSet, base, implicitFlowTupleSet);
5573       if (flowTuple != null) {
5574         nodeSet.addTuple(flowTuple);
5575       }
5576       return flowTuple;
5577
5578     case Kind.OpNode:
5579       analyzeFlowOpNode(md, nametable, (OpNode) en, nodeSet, implicitFlowTupleSet);
5580       break;
5581
5582     case Kind.CreateObjectNode:
5583       analyzeCreateObjectNode(md, nametable, (CreateObjectNode) en, nodeSet, implicitFlowTupleSet);
5584       break;
5585
5586     case Kind.ArrayAccessNode:
5587       analyzeFlowArrayAccessNode(md, nametable, (ArrayAccessNode) en, nodeSet, isLHS);
5588       break;
5589
5590     case Kind.LiteralNode:
5591       analyzeFlowLiteralNode(md, nametable, (LiteralNode) en, nodeSet);
5592       break;
5593
5594     case Kind.MethodInvokeNode:
5595       analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, nodeSet,
5596           implicitFlowTupleSet);
5597       break;
5598
5599     case Kind.TertiaryNode:
5600       analyzeFlowTertiaryNode(md, nametable, (TertiaryNode) en, nodeSet, implicitFlowTupleSet);
5601       break;
5602
5603     case Kind.CastNode:
5604       analyzeFlowCastNode(md, nametable, (CastNode) en, nodeSet, base, implicitFlowTupleSet);
5605       break;
5606     // case Kind.InstanceOfNode:
5607     // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
5608     // return null;
5609
5610     // case Kind.ArrayInitializerNode:
5611     // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
5612     // td);
5613     // return null;
5614
5615     // case Kind.ClassTypeNode:
5616     // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
5617     // return null;
5618
5619     // case Kind.OffsetNode:
5620     // checkOffsetNode(md, nametable, (OffsetNode)en, td);
5621     // return null;
5622
5623     }
5624
5625     return null;
5626
5627   }
5628
5629   private void analyzeFlowCastNode(MethodDescriptor md, SymbolTable nametable, CastNode cn,
5630       NodeTupleSet nodeSet, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
5631
5632     analyzeFlowExpressionNode(md, nametable, cn.getExpression(), nodeSet, base,
5633         implicitFlowTupleSet, false);
5634
5635   }
5636
5637   private void analyzeFlowTertiaryNode(MethodDescriptor md, SymbolTable nametable, TertiaryNode tn,
5638       NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
5639
5640     // System.out.println("analyzeFlowTertiaryNode=" + tn.printNode(0));
5641
5642     NodeTupleSet tertiaryTupleNode = new NodeTupleSet();
5643     analyzeFlowExpressionNode(md, nametable, tn.getCond(), tertiaryTupleNode, null,
5644         implicitFlowTupleSet, false);
5645
5646     NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5647     newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5648     newImplicitTupleSet.addTupleSet(tertiaryTupleNode);
5649
5650     // System.out.println("$$$GGGcondTupleNode=" + tertiaryTupleNode.getGlobalLocTupleSet());
5651     // System.out.println("-tertiaryTupleNode=" + tertiaryTupleNode);
5652     // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
5653     // System.out.println("-newImplicitTupleSet=" + newImplicitTupleSet);
5654
5655     if (needToGenerateInterLoc(newImplicitTupleSet)) {
5656       // need to create an intermediate node for the GLB of conditional locations & implicit flows
5657       NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5658       for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
5659         NTuple<Descriptor> tuple = idxIter.next();
5660         addFlowGraphEdge(md, tuple, interTuple);
5661       }
5662       newImplicitTupleSet.clear();
5663       newImplicitTupleSet.addTuple(interTuple);
5664     }
5665
5666     newImplicitTupleSet.addGlobalFlowTupleSet(tertiaryTupleNode.getGlobalLocTupleSet());
5667
5668     // System.out.println("---------newImplicitTupleSet=" + newImplicitTupleSet);
5669
5670     // add edges from tertiaryTupleNode to all nodes of conditional nodes
5671     // tertiaryTupleNode.addTupleSet(implicitFlowTupleSet);
5672     analyzeFlowExpressionNode(md, nametable, tn.getTrueExpr(), tertiaryTupleNode, null,
5673         newImplicitTupleSet, false);
5674
5675     analyzeFlowExpressionNode(md, nametable, tn.getFalseExpr(), tertiaryTupleNode, null,
5676         newImplicitTupleSet, false);
5677
5678     nodeSet.addGlobalFlowTupleSet(tertiaryTupleNode.getGlobalLocTupleSet());
5679     nodeSet.addTupleSet(tertiaryTupleNode);
5680
5681     // System.out.println("#tertiary node set=" + nodeSet);
5682   }
5683
5684   private void addMapCallerMethodDescToMethodInvokeNodeSet(MethodDescriptor caller,
5685       MethodInvokeNode min) {
5686     Set<MethodInvokeNode> set = mapMethodDescriptorToMethodInvokeNodeSet.get(caller);
5687     if (set == null) {
5688       set = new HashSet<MethodInvokeNode>();
5689       mapMethodDescriptorToMethodInvokeNodeSet.put(caller, set);
5690     }
5691     set.add(min);
5692   }
5693
5694   private void addParamNodeFlowingToReturnValue(MethodDescriptor md, FlowNode fn) {
5695
5696     if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) {
5697       mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet<FlowNode>());
5698     }
5699     mapMethodDescToParamNodeFlowsToReturnValue.get(md).add(fn);
5700   }
5701
5702   private Set<FlowNode> getParamNodeFlowingToReturnValue(MethodDescriptor md) {
5703
5704     if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) {
5705       mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet<FlowNode>());
5706     }
5707
5708     return mapMethodDescToParamNodeFlowsToReturnValue.get(md);
5709   }
5710
5711   private Set<NTuple<Location>> getPCLocTupleSet(MethodInvokeNode min) {
5712     if (!mapMethodInvokeNodeToPCLocTupleSet.containsKey(min)) {
5713       mapMethodInvokeNodeToPCLocTupleSet.put(min, new HashSet<NTuple<Location>>());
5714     }
5715     return mapMethodInvokeNodeToPCLocTupleSet.get(min);
5716   }
5717
5718   private void analyzeFlowMethodInvokeNode(MethodDescriptor mdCaller, SymbolTable nametable,
5719       MethodInvokeNode min, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
5720
5721     // System.out.println("analyzeFlowMethodInvokeNode=" + min.printNode(0));
5722
5723     if (!toanalyze_methodDescList.contains(min.getMethod())) {
5724       return;
5725     }
5726
5727     addMapMethodDescToMethodInvokeNodeSet(min);
5728
5729     Set<NTuple<Location>> pcLocTupleSet = getPCLocTupleSet(min);
5730     for (Iterator iterator = implicitFlowTupleSet.iterator(); iterator.hasNext();) {
5731       NTuple<Descriptor> pcDescTuple = (NTuple<Descriptor>) iterator.next();
5732       if (!pcDescTuple.get(0).equals(LITERALDESC)) {
5733         // here we don't need to add the literal value as a PC location
5734         pcLocTupleSet.add(translateToLocTuple(mdCaller, pcDescTuple));
5735       }
5736     }
5737
5738     mapMethodInvokeNodeToArgIdxMap.put(min, new HashMap<Integer, NTuple<Descriptor>>());
5739
5740     if (nodeSet == null) {
5741       nodeSet = new NodeTupleSet();
5742     }
5743
5744     MethodDescriptor mdCallee = min.getMethod();
5745
5746     NameDescriptor baseName = min.getBaseName();
5747     boolean isSystemout = false;
5748     if (baseName != null) {
5749       isSystemout = baseName.getSymbol().equals("System.out");
5750     }
5751
5752     if (!ssjava.isSSJavaUtil(mdCallee.getClassDesc()) && !ssjava.isTrustMethod(mdCallee)
5753         && !isSystemout) {
5754
5755       addMapCallerMethodDescToMethodInvokeNodeSet(mdCaller, min);
5756
5757       FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
5758       // System.out.println("mdCallee=" + mdCallee + " calleeFlowGraph=" + calleeFlowGraph);
5759       Set<FlowNode> calleeReturnSet = calleeFlowGraph.getReturnNodeSet();
5760
5761       // System.out.println("---calleeReturnSet=" + calleeReturnSet);
5762
5763       NodeTupleSet tupleSet = new NodeTupleSet();
5764
5765       if (min.getExpression() != null) {
5766
5767         NodeTupleSet baseNodeSet = new NodeTupleSet();
5768         analyzeFlowExpressionNode(mdCaller, nametable, min.getExpression(), baseNodeSet, null,
5769             implicitFlowTupleSet, false);
5770         // System.out.println("baseNodeSet=" + baseNodeSet);
5771
5772         assert (baseNodeSet.size() == 1);
5773         NTuple<Descriptor> baseTuple = baseNodeSet.iterator().next();
5774         if (baseTuple.get(0) instanceof InterDescriptor) {
5775           if (baseTuple.size() > 1) {
5776             throw new Error();
5777           }
5778           FlowNode interNode = getFlowGraph(mdCaller).getFlowNode(baseTuple);
5779           baseTuple = translateBaseTuple(interNode, baseTuple);
5780         }
5781         mapMethodInvokeNodeToBaseTuple.put(min, baseTuple);
5782
5783         if (!min.getMethod().isStatic()) {
5784           addArgIdxMap(min, 0, baseTuple);
5785
5786           for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) {
5787             FlowNode returnNode = (FlowNode) iterator.next();
5788             NTuple<Descriptor> returnDescTuple = returnNode.getDescTuple();
5789             if (returnDescTuple.startsWith(mdCallee.getThis())) {
5790               // the location type of the return value is started with 'this'
5791               // reference
5792               NTuple<Descriptor> inFlowTuple = new NTuple<Descriptor>(baseTuple.getList());
5793
5794               if (inFlowTuple.get(0) instanceof InterDescriptor) {
5795                 // min.getExpression()
5796               } else {
5797
5798               }
5799
5800               inFlowTuple.addAll(returnDescTuple.subList(1, returnDescTuple.size()));
5801               // nodeSet.addTuple(inFlowTuple);
5802               // System.out.println("1CREATE A NEW TUPLE=" + inFlowTuple + "  from="
5803               // + mdCallee.getThis());
5804               // tupleSet.addTuple(inFlowTuple);
5805               tupleSet.addTuple(baseTuple);
5806             } else {
5807               // TODO
5808               // System.out.println("returnNode=" + returnNode);
5809               Set<FlowNode> inFlowSet = calleeFlowGraph.getIncomingFlowNodeSet(returnNode);
5810               // System.out.println("inFlowSet=" + inFlowSet + "   from retrunNode=" + returnNode);
5811               for (Iterator iterator2 = inFlowSet.iterator(); iterator2.hasNext();) {
5812                 FlowNode inFlowNode = (FlowNode) iterator2.next();
5813                 if (inFlowNode.getDescTuple().startsWith(mdCallee.getThis())) {
5814                   // nodeSet.addTupleSet(baseNodeSet);
5815                   // System.out.println("2CREATE A NEW TUPLE=" + baseNodeSet + "  from="
5816                   // + mdCallee.getThis());
5817                   tupleSet.addTupleSet(baseNodeSet);
5818                 }
5819               }
5820             }
5821           }
5822         }
5823
5824       }
5825       // analyze parameter flows
5826
5827       if (min.numArgs() > 0) {
5828
5829         int offset;
5830         if (min.getMethod().isStatic()) {
5831           offset = 0;
5832         } else {
5833           offset = 1;
5834         }
5835
5836         for (int i = 0; i < min.numArgs(); i++) {
5837           ExpressionNode en = min.getArg(i);
5838           int idx = i + offset;
5839           NodeTupleSet argTupleSet = new NodeTupleSet();
5840           analyzeFlowExpressionNode(mdCaller, nametable, en, argTupleSet, false);
5841           // if argument is liternal node, argTuple is set to NULL
5842           // System.out.println("---arg idx=" + idx + "   argTupleSet=" + argTupleSet);
5843           NTuple<Descriptor> argTuple = generateArgTuple(mdCaller, argTupleSet);
5844
5845           // if an argument is literal value,
5846           // we need to create an itermediate node so that we could assign a composite location to
5847           // that node if needed
5848           if (argTuple.size() > 0
5849               && (argTuple.get(0).equals(GLOBALDESC) || argTuple.get(0).equals(LITERALDESC))) {
5850             /*
5851              * System.out.println("***GLOBAL ARG TUPLE CASE=" + argTuple); System.out.println("8");
5852              *
5853              * NTuple<Descriptor> interTuple =
5854              * getFlowGraph(mdCaller).createIntermediateNode().getDescTuple(); ((InterDescriptor)
5855              * interTuple.get(0)).setMethodArgIdxPair(min, idx); addFlowGraphEdge(mdCaller,
5856              * argTuple, interTuple); argTuple = interTuple; addArgIdxMap(min, idx, argTuple);
5857              * System.out.println("new min mapping i=" + idx + "  ->" + argTuple);
5858              */
5859             argTuple = new NTuple<Descriptor>();
5860           }
5861
5862           addArgIdxMap(min, idx, argTuple);
5863
5864           FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx);
5865
5866           // check whether a param node in the callee graph has incoming flows
5867           // if it has incoming flows, the corresponding arg should be lower than the current PC
5868           // Descriptor prefix = paramNode.getDescTuple().get(0);
5869           // if (calleeFlowGraph.getIncomingNodeSetByPrefix(prefix).size() > 0) {
5870           // for (Iterator<NTuple<Descriptor>> iterator = implicitFlowTupleSet.iterator(); iterator
5871           // .hasNext();) {
5872           // NTuple<Descriptor> pcTuple = iterator.next();
5873           // System.out.println("add edge pcTuple =" + pcTuple + " -> " + argTuple);
5874           // addFlowGraphEdge(md, pcTuple, argTuple);
5875           // }
5876           // }
5877
5878           // System.out.println("paramNode=" + paramNode + "  calleeReturnSet=" + calleeReturnSet);
5879           if (hasInFlowTo(calleeFlowGraph, paramNode, calleeReturnSet)
5880               || mdCallee.getModifiers().isNative()) {
5881             addParamNodeFlowingToReturnValue(mdCallee, paramNode);
5882             // nodeSet.addTupleSet(argTupleSet);
5883             // System.out.println("3CREATE A NEW TUPLE=" + argTupleSet + "  from=" + paramNode);
5884             tupleSet.addTupleSet(argTupleSet);
5885           }
5886         }
5887
5888       }
5889
5890       if (mdCallee.getReturnType() != null && !mdCallee.getReturnType().isVoid()) {
5891         FlowReturnNode returnHolderNode = getFlowGraph(mdCaller).createReturnNode(min);
5892
5893         if (needToGenerateInterLoc(tupleSet)) {
5894           FlowGraph fg = getFlowGraph(mdCaller);
5895           FlowNode interNode = fg.createIntermediateNode();
5896           interNode.setFormHolder(true);
5897
5898           NTuple<Descriptor> interTuple = interNode.getDescTuple();
5899
5900           for (Iterator iterator = tupleSet.iterator(); iterator.hasNext();) {
5901             NTuple<Descriptor> tuple = (NTuple<Descriptor>) iterator.next();
5902
5903             Set<NTuple<Descriptor>> addSet = new HashSet<NTuple<Descriptor>>();
5904             FlowNode node = fg.getFlowNode(tuple);
5905             if (node instanceof FlowReturnNode) {
5906               addSet.addAll(fg.getReturnTupleSet(((FlowReturnNode) node).getReturnTupleSet()));
5907             } else {
5908               addSet.add(tuple);
5909             }
5910             for (Iterator iterator2 = addSet.iterator(); iterator2.hasNext();) {
5911               NTuple<Descriptor> higher = (NTuple<Descriptor>) iterator2.next();
5912               addFlowGraphEdge(mdCaller, higher, interTuple);
5913             }
5914           }
5915
5916           returnHolderNode.addTuple(interTuple);
5917
5918           nodeSet.addTuple(interTuple);
5919           // System.out.println("ADD TUPLESET=" + interTuple + " to returnnode=" +
5920           // returnHolderNode);
5921
5922         } else {
5923           returnHolderNode.addTupleSet(tupleSet);
5924           // System.out.println("ADD TUPLESET=" + tupleSet + " to returnnode=" + returnHolderNode);
5925         }
5926         // setNode.addTupleSet(tupleSet);
5927         // NodeTupleSet setFromReturnNode=new NodeTupleSet();
5928         // setFromReturnNode.addTuple(tuple);
5929
5930         NodeTupleSet holderTupleSet =
5931             getNodeTupleSetFromReturnNode(getFlowGraph(mdCaller), returnHolderNode);
5932
5933         // System.out.println("HOLDER TUPLE SET=" + holderTupleSet);
5934         nodeSet.addTupleSet(holderTupleSet);
5935
5936         nodeSet.addTuple(returnHolderNode.getDescTuple());
5937       }
5938
5939       // propagateFlowsFromCallee(min, md, min.getMethod());
5940
5941       // when generating the global flow graph,
5942       // we need to add ordering relations from the set of callee return loc tuple to LHS of the
5943       // caller assignment
5944       for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) {
5945         FlowNode calleeReturnNode = (FlowNode) iterator.next();
5946         NTuple<Location> calleeReturnLocTuple =
5947             translateToLocTuple(mdCallee, calleeReturnNode.getDescTuple());
5948         // System.out.println("calleeReturnLocTuple=" + calleeReturnLocTuple);
5949         NTuple<Location> transaltedToCaller =
5950             translateToCallerLocTuple(min, mdCallee, mdCaller, calleeReturnLocTuple);
5951         // System.out.println("translateToCallerLocTuple="
5952         // + translateToCallerLocTuple(min, mdCallee, mdCaller, calleeReturnLocTuple));
5953         if (transaltedToCaller.size() > 0) {
5954           nodeSet.addGlobalFlowTuple(translateToCallerLocTuple(min, mdCallee, mdCaller,
5955               calleeReturnLocTuple));
5956         }
5957       }
5958
5959       // System.out.println("min nodeSet=" + nodeSet);
5960
5961     }
5962
5963   }
5964
5965   private NodeTupleSet getNodeTupleSetFromReturnNode(FlowGraph fg, FlowReturnNode node) {
5966     NodeTupleSet nts = new NodeTupleSet();
5967
5968     Set<NTuple<Descriptor>> returnSet = node.getReturnTupleSet();
5969
5970     for (Iterator iterator = returnSet.iterator(); iterator.hasNext();) {
5971       NTuple<Descriptor> tuple = (NTuple<Descriptor>) iterator.next();
5972       FlowNode flowNode = fg.getFlowNode(tuple);
5973       if (flowNode instanceof FlowReturnNode) {
5974         returnSet.addAll(recurGetNode(fg, (FlowReturnNode) flowNode));
5975       } else {
5976         returnSet.add(tuple);
5977       }
5978     }
5979
5980     for (Iterator iterator = returnSet.iterator(); iterator.hasNext();) {
5981       NTuple<Descriptor> nTuple = (NTuple<Descriptor>) iterator.next();
5982       nts.addTuple(nTuple);
5983     }
5984
5985     return nts;
5986
5987   }
5988
5989   private Set<NTuple<Descriptor>> recurGetNode(FlowGraph fg, FlowReturnNode rnode) {
5990
5991     Set<NTuple<Descriptor>> tupleSet = new HashSet<NTuple<Descriptor>>();
5992
5993     Set<NTuple<Descriptor>> returnSet = rnode.getReturnTupleSet();
5994     for (Iterator iterator = returnSet.iterator(); iterator.hasNext();) {
5995       NTuple<Descriptor> tuple = (NTuple<Descriptor>) iterator.next();
5996       FlowNode flowNode = fg.getFlowNode(tuple);
5997       if (flowNode instanceof FlowReturnNode) {
5998         tupleSet.addAll(recurGetNode(fg, (FlowReturnNode) flowNode));
5999       }
6000       tupleSet.add(tuple);
6001     }
6002
6003     return tupleSet;
6004   }
6005
6006   private NTuple<Descriptor> generateArgTuple(MethodDescriptor mdCaller, NodeTupleSet argTupleSet) {
6007
6008     int size = 0;
6009
6010     // if argTupleSet is empty, it comes from the top location
6011     if (argTupleSet.size() == 0) {
6012       NTuple<Descriptor> descTuple = new NTuple<Descriptor>();
6013       descTuple.add(LITERALDESC);
6014       return descTuple;
6015     }
6016
6017     Set<NTuple<Descriptor>> argTupleSetNonLiteral = new HashSet<NTuple<Descriptor>>();
6018
6019     for (Iterator<NTuple<Descriptor>> iter = argTupleSet.iterator(); iter.hasNext();) {
6020       NTuple<Descriptor> descTuple = iter.next();
6021       if (!descTuple.get(0).equals(LITERALDESC)) {
6022         argTupleSetNonLiteral.add(descTuple);
6023       }
6024     }
6025
6026     if (argTupleSetNonLiteral.size() > 1) {
6027
6028       NTuple<Descriptor> interTuple =
6029           getFlowGraph(mdCaller).createIntermediateNode().getDescTuple();
6030       for (Iterator<NTuple<Descriptor>> idxIter = argTupleSet.iterator(); idxIter.hasNext();) {
6031         NTuple<Descriptor> tuple = idxIter.next();
6032         addFlowGraphEdge(mdCaller, tuple, interTuple);
6033       }
6034       return interTuple;
6035     } else if (argTupleSetNonLiteral.size() == 1) {
6036       return argTupleSetNonLiteral.iterator().next();
6037     } else {
6038       return argTupleSet.iterator().next();
6039     }
6040
6041   }
6042
6043   private boolean hasInFlowTo(FlowGraph fg, FlowNode inNode, Set<FlowNode> nodeSet) {
6044     // return true if inNode has in-flows to nodeSet
6045
6046     if (nodeSet.contains(inNode)) {
6047       // in this case, the method directly returns a parameter variable.
6048       return true;
6049     }
6050     // Set<FlowNode> reachableSet = fg.getReachFlowNodeSetFrom(inNode);
6051     Set<FlowNode> reachableSet = fg.getReachableSetFrom(inNode.getDescTuple());
6052     // System.out.println("inNode=" + inNode + "  reachalbeSet=" + reachableSet);
6053
6054     for (Iterator iterator = reachableSet.iterator(); iterator.hasNext();) {
6055       FlowNode fn = (FlowNode) iterator.next();
6056       if (nodeSet.contains(fn)) {
6057         return true;
6058       }
6059     }
6060     return false;
6061   }
6062
6063   private NTuple<Descriptor> getNodeTupleByArgIdx(MethodInvokeNode min, int idx) {
6064     return mapMethodInvokeNodeToArgIdxMap.get(min).get(new Integer(idx));
6065   }
6066
6067   private void addArgIdxMap(MethodInvokeNode min, int idx, NTuple<Descriptor> argTuple /*
6068                                                                                         * NodeTupleSet
6069                                                                                         * tupleSet
6070                                                                                         */) {
6071     Map<Integer, NTuple<Descriptor>> mapIdxToTuple = mapMethodInvokeNodeToArgIdxMap.get(min);
6072     if (mapIdxToTuple == null) {
6073       mapIdxToTuple = new HashMap<Integer, NTuple<Descriptor>>();
6074       mapMethodInvokeNodeToArgIdxMap.put(min, mapIdxToTuple);
6075     }
6076     mapIdxToTuple.put(new Integer(idx), argTuple);
6077   }
6078
6079   private void analyzeFlowLiteralNode(MethodDescriptor md, SymbolTable nametable, LiteralNode en,
6080       NodeTupleSet nodeSet) {
6081     NTuple<Descriptor> tuple = new NTuple<Descriptor>();
6082     tuple.add(LITERALDESC);
6083     nodeSet.addTuple(tuple);
6084   }
6085
6086   private void analyzeFlowArrayAccessNode(MethodDescriptor md, SymbolTable nametable,
6087       ArrayAccessNode aan, NodeTupleSet nodeSet, boolean isLHS) {
6088
6089     // System.out.println("analyzeFlowArrayAccessNode aan=" + aan.printNode(0));
6090     String currentArrayAccessNodeExpStr = aan.printNode(0);
6091     arrayAccessNodeStack.push(aan.printNode(0));
6092
6093     NodeTupleSet expNodeTupleSet = new NodeTupleSet();
6094     NTuple<Descriptor> base =
6095         analyzeFlowExpressionNode(md, nametable, aan.getExpression(), expNodeTupleSet, isLHS);
6096     // System.out.println("-base=" + base);
6097
6098     nodeSet.setMethodInvokeBaseDescTuple(base);
6099     NodeTupleSet idxNodeTupleSet = new NodeTupleSet();
6100     analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, isLHS);
6101
6102     arrayAccessNodeStack.pop();
6103
6104     if (isLHS) {
6105       // need to create an edge from idx to array
6106       for (Iterator<NTuple<Descriptor>> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) {
6107         NTuple<Descriptor> idxTuple = idxIter.next();
6108         for (Iterator<NTuple<Descriptor>> arrIter = expNodeTupleSet.iterator(); arrIter.hasNext();) {
6109           NTuple<Descriptor> arrTuple = arrIter.next();
6110           getFlowGraph(md).addValueFlowEdge(idxTuple, arrTuple);
6111         }
6112       }
6113
6114       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6115       for (Iterator<NTuple<Location>> iterator = idxNodeTupleSet.globalIterator(); iterator
6116           .hasNext();) {
6117         NTuple<Location> calleeReturnLocTuple = iterator.next();
6118         for (Iterator<NTuple<Descriptor>> arrIter = expNodeTupleSet.iterator(); arrIter.hasNext();) {
6119           NTuple<Descriptor> arrTuple = arrIter.next();
6120
6121           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple, translateToLocTuple(md, arrTuple));
6122         }
6123       }
6124
6125       nodeSet.addTupleSet(expNodeTupleSet);
6126     } else {
6127
6128       NodeTupleSet nodeSetArrayAccessExp = new NodeTupleSet();
6129
6130       nodeSetArrayAccessExp.addTupleSet(expNodeTupleSet);
6131       nodeSetArrayAccessExp.addTupleSet(idxNodeTupleSet);
6132
6133       if (arrayAccessNodeStack.isEmpty()
6134           || !arrayAccessNodeStack.peek().startsWith(currentArrayAccessNodeExpStr)) {
6135
6136         if (needToGenerateInterLoc(nodeSetArrayAccessExp)) {
6137           FlowNode interNode = getFlowGraph(md).createIntermediateNode();
6138           NTuple<Descriptor> interTuple = interNode.getDescTuple();
6139
6140           for (Iterator<NTuple<Descriptor>> iter = nodeSetArrayAccessExp.iterator(); iter.hasNext();) {
6141             NTuple<Descriptor> higherTuple = iter.next();
6142             addFlowGraphEdge(md, higherTuple, interTuple);
6143           }
6144           nodeSetArrayAccessExp.clear();
6145           nodeSetArrayAccessExp.addTuple(interTuple);
6146           FlowGraph fg = getFlowGraph(md);
6147
6148           // System.out.println("base=" + base);
6149           if (base != null) {
6150             fg.addMapInterLocNodeToEnclosingDescriptor(interTuple.get(0),
6151                 getClassTypeDescriptor(base.get(base.size() - 1)));
6152             interNode.setBaseTuple(base);
6153           }
6154         }
6155       }
6156
6157       nodeSet.addGlobalFlowTupleSet(idxNodeTupleSet.getGlobalLocTupleSet());
6158       nodeSet.addTupleSet(nodeSetArrayAccessExp);
6159
6160     }
6161
6162   }
6163
6164   private void analyzeCreateObjectNode(MethodDescriptor md, SymbolTable nametable,
6165       CreateObjectNode en, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
6166     // System.out.println("#analyzeCreateObjectNode=" + en.printNode(0));
6167     int numArgs = en.numArgs();
6168     NodeTupleSet argSet = new NodeTupleSet();
6169
6170     for (int i = 0; i < numArgs; i++) {
6171       analyzeFlowExpressionNode(md, nametable, en.getArg(i), argSet, null, implicitFlowTupleSet,
6172           false);
6173     }
6174
6175     // System.out.println("###argSet=" + argSet);
6176     nodeSet.addTupleSet(argSet);
6177
6178   }
6179
6180   private void analyzeFlowOpNode(MethodDescriptor md, SymbolTable nametable, OpNode on,
6181       NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
6182
6183     NodeTupleSet leftOpSet = new NodeTupleSet();
6184     NodeTupleSet rightOpSet = new NodeTupleSet();
6185
6186     // System.out.println("analyzeFlowOpNode=" + on.printNode(0));
6187
6188     // left operand
6189     analyzeFlowExpressionNode(md, nametable, on.getLeft(), leftOpSet, null, implicitFlowTupleSet,
6190         false);
6191
6192     if (on.getRight() != null) {
6193       // right operand
6194       analyzeFlowExpressionNode(md, nametable, on.getRight(), rightOpSet, null,
6195           implicitFlowTupleSet, false);
6196     }
6197
6198     Operation op = on.getOp();
6199
6200     switch (op.getOp()) {
6201
6202     case Operation.UNARYPLUS:
6203     case Operation.UNARYMINUS:
6204     case Operation.LOGIC_NOT:
6205       // single operand
6206       nodeSet.addTupleSet(leftOpSet);
6207       break;
6208
6209     case Operation.LOGIC_OR:
6210     case Operation.LOGIC_AND:
6211     case Operation.COMP:
6212     case Operation.BIT_OR:
6213     case Operation.BIT_XOR:
6214     case Operation.BIT_AND:
6215     case Operation.ISAVAILABLE:
6216     case Operation.EQUAL:
6217     case Operation.NOTEQUAL:
6218     case Operation.LT:
6219     case Operation.GT:
6220     case Operation.LTE:
6221     case Operation.GTE:
6222     case Operation.ADD:
6223     case Operation.SUB:
6224     case Operation.MULT:
6225     case Operation.DIV:
6226     case Operation.MOD:
6227     case Operation.LEFTSHIFT:
6228     case Operation.RIGHTSHIFT:
6229     case Operation.URIGHTSHIFT:
6230
6231       // there are two operands
6232       nodeSet.addTupleSet(leftOpSet);
6233       nodeSet.addTupleSet(rightOpSet);
6234
6235       nodeSet.addGlobalFlowTupleSet(leftOpSet.getGlobalLocTupleSet());
6236       nodeSet.addGlobalFlowTupleSet(rightOpSet.getGlobalLocTupleSet());
6237
6238       break;
6239
6240     default:
6241       throw new Error(op.toString());
6242     }
6243
6244   }
6245
6246   private NTuple<Descriptor> analyzeFlowNameNode(MethodDescriptor md, SymbolTable nametable,
6247       NameNode nn, NodeTupleSet nodeSet, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
6248
6249     if (base == null) {
6250       base = new NTuple<Descriptor>();
6251     }
6252
6253     NameDescriptor nd = nn.getName();
6254
6255     if (nd.getBase() != null) {
6256       base =
6257           analyzeFlowExpressionNode(md, nametable, nn.getExpression(), nodeSet, base,
6258               implicitFlowTupleSet, false);
6259       if (base == null) {
6260         // base node has the top location
6261         return base;
6262       }
6263     } else {
6264       String varname = nd.toString();
6265       if (varname.equals("this")) {
6266         // 'this' itself!
6267         base.add(md.getThis());
6268         return base;
6269       }
6270
6271       Descriptor d = (Descriptor) nametable.get(varname);
6272
6273       if (d instanceof VarDescriptor) {
6274         VarDescriptor vd = (VarDescriptor) d;
6275         base.add(vd);
6276       } else if (d instanceof FieldDescriptor) {
6277         // the type of field descriptor has a location!
6278         FieldDescriptor fd = (FieldDescriptor) d;
6279         if (fd.isStatic()) {
6280           if (fd.isFinal()) {
6281             // if it is 'static final', no need to have flow node for the TOP
6282             // location
6283             return null;
6284           } else {
6285             // if 'static', assign the default GLOBAL LOCATION to the first
6286             // element of the tuple
6287             base.add(GLOBALDESC);
6288           }
6289         } else {
6290           // the location of field access starts from this, followed by field
6291           // location
6292           base.add(md.getThis());
6293         }
6294
6295         base.add(fd);
6296       } else if (d == null) {
6297         // access static field
6298         base.add(GLOBALDESC);
6299         base.add(nn.getField());
6300         return base;
6301
6302         // FieldDescriptor fd = nn.getField();addFlowGraphEdge
6303         //
6304         // MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
6305         // String globalLocId = localLattice.getGlobalLoc();
6306         // if (globalLocId == null) {
6307         // throw new
6308         // Error("Method lattice does not define global variable location at "
6309         // + generateErrorMessage(md.getClassDesc(), nn));
6310         // }
6311         // loc.addLocation(new Location(md, globalLocId));
6312         //
6313         // Location fieldLoc = (Location) fd.getType().getExtension();
6314         // loc.addLocation(fieldLoc);
6315         //
6316         // return loc;
6317
6318       }
6319     }
6320     getFlowGraph(md).createNewFlowNode(base);
6321
6322     return base;
6323
6324   }
6325
6326   private NTuple<Descriptor> analyzeFlowFieldAccessNode(MethodDescriptor md, SymbolTable nametable,
6327       FieldAccessNode fan, NodeTupleSet nodeSet, NTuple<Descriptor> base,
6328       NodeTupleSet implicitFlowTupleSet, boolean isLHS) {
6329     // System.out.println("analyzeFlowFieldAccessNode=" + fan.printNode(0));
6330
6331     String currentArrayAccessNodeExpStr = null;
6332     ExpressionNode left = fan.getExpression();
6333     TypeDescriptor ltd = left.getType();
6334     FieldDescriptor fd = fan.getField();
6335     ArrayAccessNode aan = null;
6336
6337     String varName = null;
6338     if (left.kind() == Kind.NameNode) {
6339       NameDescriptor nd = ((NameNode) left).getName();
6340       varName = nd.toString();
6341     }
6342
6343     if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
6344       // using a class name directly or access using this
6345       if (fd.isStatic() && fd.isFinal()) {
6346         return null;
6347       }
6348     }
6349
6350     NodeTupleSet idxNodeTupleSet = new NodeTupleSet();
6351
6352     boolean isArrayCase = false;
6353     if (left instanceof ArrayAccessNode) {
6354
6355       isArrayCase = true;
6356       aan = (ArrayAccessNode) left;
6357
6358       currentArrayAccessNodeExpStr = aan.printNode(0);
6359       arrayAccessNodeStack.push(currentArrayAccessNodeExpStr);
6360
6361       left = aan.getExpression();
6362       analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, base,
6363           implicitFlowTupleSet, isLHS);
6364
6365     }
6366     base =
6367         analyzeFlowExpressionNode(md, nametable, left, nodeSet, base, implicitFlowTupleSet, isLHS);
6368
6369     if (base == null) {
6370       // in this case, field is TOP location
6371       return null;
6372     } else {
6373
6374       NTuple<Descriptor> flowFieldTuple = new NTuple<Descriptor>(base.toList());
6375
6376       if (!left.getType().isPrimitive()) {
6377         if (!fd.getSymbol().equals("length")) {
6378           // array.length access, just have the location of the array
6379           flowFieldTuple.add(fd);
6380           nodeSet.removeTuple(base);
6381         }
6382       }
6383       getFlowGraph(md).createNewFlowNode(flowFieldTuple);
6384
6385       if (isLHS) {
6386         for (Iterator<NTuple<Descriptor>> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) {
6387           NTuple<Descriptor> idxTuple = idxIter.next();
6388           getFlowGraph(md).addValueFlowEdge(idxTuple, flowFieldTuple);
6389         }
6390
6391         GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6392         for (Iterator<NTuple<Location>> iterator = idxNodeTupleSet.globalIterator(); iterator
6393             .hasNext();) {
6394           NTuple<Location> calleeReturnLocTuple = iterator.next();
6395
6396           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6397               translateToLocTuple(md, flowFieldTuple));
6398         }
6399
6400       } else {
6401         nodeSet.addTupleSet(idxNodeTupleSet);
6402
6403         // if it is the array case and not the LHS case
6404         if (isArrayCase) {
6405           arrayAccessNodeStack.pop();
6406
6407           if (arrayAccessNodeStack.isEmpty()
6408               || !arrayAccessNodeStack.peek().startsWith(currentArrayAccessNodeExpStr)) {
6409             NodeTupleSet nodeSetArrayAccessExp = new NodeTupleSet();
6410
6411             nodeSetArrayAccessExp.addTuple(flowFieldTuple);
6412             nodeSetArrayAccessExp.addTupleSet(idxNodeTupleSet);
6413             nodeSetArrayAccessExp.addTupleSet(nodeSet);
6414
6415             if (needToGenerateInterLoc(nodeSetArrayAccessExp)) {
6416               // System.out.println("nodeSetArrayAccessExp=" + nodeSetArrayAccessExp);
6417               // System.out.println("idxNodeTupleSet.getGlobalLocTupleSet()="
6418               // + idxNodeTupleSet.getGlobalLocTupleSet());
6419
6420               NTuple<Descriptor> interTuple =
6421                   getFlowGraph(md).createIntermediateNode().getDescTuple();
6422
6423               for (Iterator<NTuple<Descriptor>> iter = nodeSetArrayAccessExp.iterator(); iter
6424                   .hasNext();) {
6425                 NTuple<Descriptor> higherTuple = iter.next();
6426                 addFlowGraphEdge(md, higherTuple, interTuple);
6427               }
6428
6429               FlowGraph fg = getFlowGraph(md);
6430               fg.addMapInterLocNodeToEnclosingDescriptor(interTuple.get(0),
6431                   getClassTypeDescriptor(base.get(base.size() - 1)));
6432
6433               nodeSet.clear();
6434               flowFieldTuple = interTuple;
6435             }
6436             nodeSet.addGlobalFlowTupleSet(idxNodeTupleSet.getGlobalLocTupleSet());
6437           }
6438
6439         }
6440
6441       }
6442       return flowFieldTuple;
6443     }
6444
6445   }
6446
6447   private void debug_printTreeNode(TreeNode tn) {
6448
6449     System.out.println("DEBUG: " + tn.printNode(0) + "                line#=" + tn.getNumLine());
6450
6451   }
6452
6453   private void analyzeFlowAssignmentNode(MethodDescriptor md, SymbolTable nametable,
6454       AssignmentNode an, NodeTupleSet nodeSet, NTuple<Descriptor> base,
6455       NodeTupleSet implicitFlowTupleSet) {
6456
6457     NodeTupleSet nodeSetRHS = new NodeTupleSet();
6458     NodeTupleSet nodeSetLHS = new NodeTupleSet();
6459
6460     boolean postinc = true;
6461     if (an.getOperation().getBaseOp() == null
6462         || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
6463             .getBaseOp().getOp() != Operation.POSTDEC)) {
6464       postinc = false;
6465     }
6466     // if LHS is array access node, need to capture value flows between an array
6467     // and its index value
6468     analyzeFlowExpressionNode(md, nametable, an.getDest(), nodeSetLHS, null, implicitFlowTupleSet,
6469         true);
6470
6471     if (!postinc) {
6472       // analyze value flows of rhs expression
6473       analyzeFlowExpressionNode(md, nametable, an.getSrc(), nodeSetRHS, null, implicitFlowTupleSet,
6474           false);
6475
6476       // System.out.println("-analyzeFlowAssignmentNode=" + an.printNode(0));
6477       // System.out.println("-nodeSetLHS=" + nodeSetLHS);
6478       // System.out.println("-nodeSetRHS=" + nodeSetRHS);
6479       // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
6480       // System.out.println("-");
6481
6482       if (an.getOperation().getOp() >= 2 && an.getOperation().getOp() <= 12) {
6483         // if assignment contains OP+EQ operator, creates edges from LHS to LHS
6484
6485         for (Iterator<NTuple<Descriptor>> iter = nodeSetLHS.iterator(); iter.hasNext();) {
6486           NTuple<Descriptor> fromTuple = iter.next();
6487           for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6488             NTuple<Descriptor> toTuple = iter2.next();
6489             addFlowGraphEdge(md, fromTuple, toTuple);
6490           }
6491         }
6492       }
6493
6494       // creates edges from RHS to LHS
6495       NTuple<Descriptor> interTuple = null;
6496       if (needToGenerateInterLoc(nodeSetRHS)) {
6497         interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
6498       }
6499
6500       for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
6501         NTuple<Descriptor> fromTuple = iter.next();
6502         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6503           NTuple<Descriptor> toTuple = iter2.next();
6504           addFlowGraphEdge(md, fromTuple, interTuple, toTuple);
6505         }
6506       }
6507
6508       // creates edges from implicitFlowTupleSet to LHS
6509       for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
6510         NTuple<Descriptor> fromTuple = iter.next();
6511         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6512           NTuple<Descriptor> toTuple = iter2.next();
6513           addFlowGraphEdge(md, fromTuple, toTuple);
6514         }
6515       }
6516
6517       // create global flow edges if the callee gives return value flows to the caller
6518       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6519       for (Iterator<NTuple<Location>> iterator = nodeSetRHS.globalIterator(); iterator.hasNext();) {
6520         NTuple<Location> calleeReturnLocTuple = iterator.next();
6521         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6522           NTuple<Descriptor> callerLHSTuple = iter2.next();
6523           // System.out.println("$$$ GLOBAL FLOW ADD=" + calleeReturnLocTuple + " -> "
6524           // + translateToLocTuple(md, callerLHSTuple));
6525
6526           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6527               translateToLocTuple(md, callerLHSTuple));
6528         }
6529       }
6530
6531       for (Iterator<NTuple<Location>> iterator = implicitFlowTupleSet.globalIterator(); iterator
6532           .hasNext();) {
6533         NTuple<Location> calleeReturnLocTuple = iterator.next();
6534         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6535           NTuple<Descriptor> callerLHSTuple = iter2.next();
6536
6537           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6538               translateToLocTuple(md, callerLHSTuple));
6539           // System.out.println("$$$ GLOBAL FLOW PCLOC ADD=" + calleeReturnLocTuple + " -> "
6540           // + translateToLocTuple(md, callerLHSTuple));
6541         }
6542       }
6543
6544     } else {
6545       // postinc case
6546
6547       for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6548         NTuple<Descriptor> tuple = iter2.next();
6549         addFlowGraphEdge(md, tuple, tuple);
6550       }
6551
6552       // creates edges from implicitFlowTupleSet to LHS
6553       for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
6554         NTuple<Descriptor> fromTuple = iter.next();
6555         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6556           NTuple<Descriptor> toTuple = iter2.next();
6557           addFlowGraphEdge(md, fromTuple, toTuple);
6558         }
6559       }
6560
6561       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6562       for (Iterator<NTuple<Location>> iterator = implicitFlowTupleSet.globalIterator(); iterator
6563           .hasNext();) {
6564         NTuple<Location> calleeReturnLocTuple = iterator.next();
6565         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6566           NTuple<Descriptor> callerLHSTuple = iter2.next();
6567           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6568               translateToLocTuple(md, callerLHSTuple));
6569           // System.out.println("$$$ GLOBAL FLOW PC ADD=" + calleeReturnLocTuple + " -> "
6570           // + translateToLocTuple(md, callerLHSTuple));
6571         }
6572       }
6573
6574     }
6575
6576     if (nodeSet != null) {
6577       nodeSet.addTupleSet(nodeSetLHS);
6578       nodeSet.addGlobalFlowTupleSet(nodeSetLHS.getGlobalLocTupleSet());
6579     }
6580   }
6581
6582   public FlowGraph getFlowGraph(MethodDescriptor md) {
6583     return mapMethodDescriptorToFlowGraph.get(md);
6584   }
6585
6586   private boolean addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from,
6587       NTuple<Descriptor> to) {
6588     FlowGraph graph = getFlowGraph(md);
6589     graph.addValueFlowEdge(from, to);
6590     return true;
6591   }
6592
6593   private void addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from,
6594       NTuple<Descriptor> inter, NTuple<Descriptor> to) {
6595
6596     FlowGraph graph = getFlowGraph(md);
6597
6598     if (inter != null) {
6599       graph.addValueFlowEdge(from, inter);
6600       graph.addValueFlowEdge(inter, to);
6601     } else {
6602       graph.addValueFlowEdge(from, to);
6603     }
6604
6605   }
6606
6607   public void writeInferredLatticeDotFile(ClassDescriptor cd, SSJavaLattice<String> locOrder,
6608       String nameSuffix) {
6609     // System.out.println("@cd=" + cd);
6610     // System.out.println("@sharedLoc=" + locOrder.getSharedLocSet());
6611     writeInferredLatticeDotFile(cd, null, locOrder, nameSuffix);
6612   }
6613
6614   public void writeInferredLatticeDotFile(ClassDescriptor cd, MethodDescriptor md,
6615       SSJavaLattice<String> locOrder, String nameSuffix) {
6616
6617     String fileName = "lattice_";
6618     if (md != null) {
6619       fileName +=
6620           cd.getSymbol().replaceAll("[\\W_]", "") + "_" + md.toString().replaceAll("[\\W_]", "");
6621     } else {
6622       fileName += cd.getSymbol().replaceAll("[\\W_]", "");
6623     }
6624
6625     fileName += nameSuffix;
6626
6627     System.out.println("***lattice=" + fileName + "    setsize=" + locOrder.getKeySet().size());
6628
6629     Set<Pair<String, String>> pairSet = locOrder.getOrderingPairSet();
6630
6631     Set<String> addedLocSet = new HashSet<String>();
6632
6633     if (pairSet.size() > 0) {
6634       try {
6635         BufferedWriter bw = new BufferedWriter(new FileWriter(fileName + ".dot"));
6636
6637         bw.write("digraph " + fileName + " {\n");
6638
6639         for (Iterator iterator = pairSet.iterator(); iterator.hasNext();) {
6640           // pair is in the form of <higher, lower>
6641           Pair<String, String> pair = (Pair<String, String>) iterator.next();
6642
6643           String highLocId = pair.getFirst();
6644           String lowLocId = pair.getSecond();
6645           if (!addedLocSet.contains(highLocId)) {
6646             addedLocSet.add(highLocId);
6647             drawNode(bw, locOrder, highLocId);
6648           }
6649
6650           if (!addedLocSet.contains(lowLocId)) {
6651             addedLocSet.add(lowLocId);
6652             drawNode(bw, locOrder, lowLocId);
6653           }
6654
6655           bw.write(highLocId + " -> " + lowLocId + ";\n");
6656         }
6657         bw.write("}\n");
6658         bw.close();
6659
6660       } catch (IOException e) {
6661         e.printStackTrace();
6662       }
6663
6664     }
6665
6666   }
6667
6668   private String convertMergeSetToString(HierarchyGraph graph, Set<HNode> mergeSet) {
6669     String str = "";
6670     for (Iterator iterator = mergeSet.iterator(); iterator.hasNext();) {
6671       HNode merged = (HNode) iterator.next();
6672       if (merged.isMergeNode()) {
6673         str += convertMergeSetToString(graph, graph.getMapHNodetoMergeSet().get(merged));
6674       } else {
6675         str += " " + merged.getName();
6676       }
6677     }
6678     return str;
6679   }
6680
6681   public void addNaiveLattice(Descriptor desc, SSJavaLattice<String> lattice) {
6682     desc2naiveLattice.put(desc, lattice);
6683   }
6684
6685   private void drawNode(BufferedWriter bw, SSJavaLattice<String> lattice, String locName)
6686       throws IOException {
6687
6688     String prettyStr;
6689     if (lattice.isSharedLoc(locName)) {
6690       prettyStr = locName + "*";
6691     } else {
6692       prettyStr = locName;
6693     }
6694     // HNode node = graph.getHNode(locName);
6695     // if (node != null && node.isMergeNode()) {
6696     // Set<HNode> mergeSet = graph.getMapHNodetoMergeSet().get(node);
6697     // prettyStr += ":" + convertMergeSetToString(graph, mergeSet);
6698     // }
6699     bw.write(locName + " [label=\"" + prettyStr + "\"]" + ";\n");
6700   }
6701
6702   public void _debug_writeFlowGraph() {
6703     Set<MethodDescriptor> keySet = mapMethodDescriptorToFlowGraph.keySet();
6704
6705     for (Iterator<MethodDescriptor> iterator = keySet.iterator(); iterator.hasNext();) {
6706       MethodDescriptor md = (MethodDescriptor) iterator.next();
6707       FlowGraph fg = mapMethodDescriptorToFlowGraph.get(md);
6708       GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
6709       try {
6710         fg.writeGraph();
6711         subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
6712       } catch (IOException e) {
6713         e.printStackTrace();
6714       }
6715     }
6716
6717   }
6718
6719 }
6720
6721 class CyclicFlowException extends Exception {
6722
6723 }
6724
6725 class InterDescriptor extends Descriptor {
6726
6727   Pair<MethodInvokeNode, Integer> minArgIdxPair;
6728
6729   public InterDescriptor(String name) {
6730     super(name);
6731   }
6732
6733   public void setMethodArgIdxPair(MethodInvokeNode min, int idx) {
6734     minArgIdxPair = new Pair<MethodInvokeNode, Integer>(min, new Integer(idx));
6735   }
6736
6737   public Pair<MethodInvokeNode, Integer> getMethodArgIdxPair() {
6738     return minArgIdxPair;
6739   }
6740
6741 }