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 skeleton lattice
 101   private Map<Descriptor, SSJavaLattice<String>> mapDescriptorToSkeletonLattice;
 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.mapDescriptorToSkeletonLattice = 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             // if (node.getLocTuple().get(0).getDescriptor().getSymbol().equals("get_scale_factors")
1777             // || node.getLocTuple().get(0).getDescriptor().getSymbol()
1778             // .equals("get_LSF_scale_data")){
1779             // Set<GlobalFlowNode> debugInNodeSet =
1780             // globalFlowGraph.debug_getIncomingNodeSetFromPrefix(node, curPrefix);
1781             // }
1782             continue next;
1783             // }
1784
1785           }
1786
1787         }
1788
1789       }
1790
1791     }
1792   }
1793
1794   private boolean checkFlowNodeReturnThisField(MethodDescriptor md) {
1795
1796     MethodDescriptor methodDescEventLoop = ssjava.getMethodContainingSSJavaLoop();
1797     GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(methodDescEventLoop);
1798
1799     FlowGraph flowGraph = getFlowGraph(md);
1800
1801     ClassDescriptor enclosingDesc = getClassTypeDescriptor(md.getThis());
1802     if (enclosingDesc == null) {
1803       return false;
1804     }
1805
1806     int count = 0;
1807     Set<FlowNode> returnNodeSet = flowGraph.getReturnNodeSet();
1808     Set<GlobalFlowNode> globalReturnNodeSet = new HashSet<GlobalFlowNode>();
1809     for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
1810       FlowNode flowNode = (FlowNode) iterator.next();
1811       NTuple<Location> locTuple = translateToLocTuple(md, flowNode.getDescTuple());
1812       GlobalFlowNode globalReturnNode = globalFlowGraph.getFlowNode(locTuple);
1813       globalReturnNodeSet.add(globalReturnNode);
1814
1815       List<NTuple<Location>> prefixList = calculatePrefixList(globalFlowGraph, globalReturnNode);
1816       for (int i = 0; i < prefixList.size(); i++) {
1817         NTuple<Location> curPrefix = prefixList.get(i);
1818         ClassDescriptor cd =
1819             getClassTypeDescriptor(curPrefix.get(curPrefix.size() - 1).getLocDescriptor());
1820         if (cd != null && cd.equals(enclosingDesc)) {
1821           count++;
1822           break;
1823         }
1824       }
1825
1826     }
1827
1828     if (count == returnNodeSet.size()) {
1829       // in this case, all return nodes in the method returns values coming from a location that
1830       // starts with "this"
1831
1832       // System.out.println("$$$SET RETURN LOC TRUE=" + md);
1833       mapMethodDescriptorToCompositeReturnCase.put(md, Boolean.TRUE);
1834
1835       // NameDescriptor returnLocDesc = new NameDescriptor("RLOC" + (locSeed++));
1836       // NTuple<Descriptor> rDescTuple = new NTuple<Descriptor>();
1837       // rDescTuple.add(md.getThis());
1838       // rDescTuple.add(returnLocDesc);
1839       //
1840       // for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
1841       // FlowNode rnode = (FlowNode) iterator.next();
1842       // flowGraph.addValueFlowEdge(rnode.getDescTuple(), rDescTuple);
1843       // }
1844       //
1845       // getMethodSummary(md).setRETURNLoc(new CompositeLocation(translateToLocTuple(md,
1846       // rDescTuple)));
1847
1848     } else {
1849       mapMethodDescriptorToCompositeReturnCase.put(md, Boolean.FALSE);
1850     }
1851
1852     return mapMethodDescriptorToCompositeReturnCase.get(md).booleanValue();
1853
1854   }
1855
1856   private boolean needToGenerateCompositeLocation(GlobalFlowNode node, NTuple<Location> curPrefix) {
1857     // return true if there is a path between a node to which we want to give a composite location
1858     // and nodes which start with curPrefix
1859
1860     // System.out.println("---needToGenerateCompositeLocation curPrefix=" + curPrefix);
1861
1862     Location targetLocalLoc = node.getLocTuple().get(0);
1863
1864     MethodDescriptor md = (MethodDescriptor) targetLocalLoc.getDescriptor();
1865     FlowGraph flowGraph = getFlowGraph(md);
1866
1867     FlowNode flowNode = flowGraph.getFlowNode(node.getDescTuple());
1868     Set<FlowNode> reachableSet = flowGraph.getReachFlowNodeSetFrom(flowNode);
1869
1870     Set<FlowNode> paramNodeSet = flowGraph.getParamFlowNodeSet();
1871     for (Iterator iterator = paramNodeSet.iterator(); iterator.hasNext();) {
1872       FlowNode paramFlowNode = (FlowNode) iterator.next();
1873       if (curPrefix.startsWith(translateToLocTuple(md, paramFlowNode.getDescTuple()))) {
1874         return true;
1875       }
1876     }
1877
1878     if (targetLocalLoc.getLocDescriptor() instanceof InterDescriptor) {
1879       Pair<MethodInvokeNode, Integer> pair =
1880           ((InterDescriptor) targetLocalLoc.getLocDescriptor()).getMethodArgIdxPair();
1881
1882       if (pair != null) {
1883         // System.out.println("$$$TARGETLOCALLOC HOLDER=" + targetLocalLoc);
1884
1885         MethodInvokeNode min = pair.getFirst();
1886         Integer paramIdx = pair.getSecond();
1887         MethodDescriptor mdCallee = min.getMethod();
1888
1889         FlowNode paramNode = getFlowGraph(mdCallee).getParamFlowNode(paramIdx);
1890         if (checkNodeReachToReturnNode(mdCallee, paramNode)) {
1891           return true;
1892         }
1893
1894       }
1895
1896     }
1897
1898     GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
1899     Set<GlobalFlowNode> subGlobalReachableSet = subGlobalFlowGraph.getReachableNodeSetFrom(node);
1900
1901     if (!md.isStatic()) {
1902       ClassDescriptor currentMethodThisType = getClassTypeDescriptor(md.getThis());
1903       for (int i = 0; i < curPrefix.size(); i++) {
1904         ClassDescriptor prefixType = getClassTypeDescriptor(curPrefix.get(i).getLocDescriptor());
1905         if (prefixType != null && prefixType.equals(currentMethodThisType)) {
1906           // System.out.println("PREFIX TYPE MATCHES WITH=" + currentMethodThisType);
1907
1908           if (mapMethodDescriptorToCompositeReturnCase.containsKey(md)) {
1909             boolean hasCompReturnLocWithThis =
1910                 mapMethodDescriptorToCompositeReturnCase.get(md).booleanValue();
1911             if (hasCompReturnLocWithThis) {
1912               if (checkNodeReachToReturnNode(md, flowNode)) {
1913                 return true;
1914               }
1915             }
1916           }
1917
1918           for (Iterator iterator3 = subGlobalReachableSet.iterator(); iterator3.hasNext();) {
1919             GlobalFlowNode subGlobalReachalbeNode = (GlobalFlowNode) iterator3.next();
1920             if (subGlobalReachalbeNode.getLocTuple().get(0).getLocDescriptor().equals(md.getThis())) {
1921               // System.out.println("PREFIX FOUND=" + subGlobalReachalbeNode);
1922               return true;
1923             }
1924           }
1925         }
1926       }
1927     }
1928
1929     Location lastLocationOfPrefix = curPrefix.get(curPrefix.size() - 1);
1930     // check whether prefix appears in the list of parameters
1931     Set<MethodInvokeNode> minSet = mapMethodDescToMethodInvokeNodeSet.get(md);
1932     // System.out.println("$$$md=" + md + "   minSet=" + minSet);
1933     if (minSet == null) {
1934       return false;
1935     }
1936     found: for (Iterator iterator = minSet.iterator(); iterator.hasNext();) {
1937       MethodInvokeNode min = (MethodInvokeNode) iterator.next();
1938       Map<Integer, NTuple<Descriptor>> map = mapMethodInvokeNodeToArgIdxMap.get(min);
1939       Set<Integer> keySet = map.keySet();
1940       // System.out.println("min=" + min.printNode(0));
1941
1942       for (Iterator iterator2 = keySet.iterator(); iterator2.hasNext();) {
1943         Integer argIdx = (Integer) iterator2.next();
1944         NTuple<Descriptor> argTuple = map.get(argIdx);
1945
1946         if (!(!md.isStatic() && argIdx == 0)) {
1947           // if the argTuple is empty, we don't need to do with anything(LITERAL CASE).
1948           if (argTuple.size() > 0
1949               && argTuple.get(argTuple.size() - 1).equals(lastLocationOfPrefix.getLocDescriptor())) {
1950             NTuple<Location> locTuple =
1951                 translateToLocTuple(md, flowGraph.getParamFlowNode(argIdx).getDescTuple());
1952             lastLocationOfPrefix = locTuple.get(0);
1953             // System.out.println("ARG CASE=" + locTuple);
1954             for (Iterator iterator3 = subGlobalReachableSet.iterator(); iterator3.hasNext();) {
1955               GlobalFlowNode subGlobalReachalbeNode = (GlobalFlowNode) iterator3.next();
1956               // NTuple<Location> locTuple = translateToLocTuple(md, reachalbeNode.getDescTuple());
1957               NTuple<Location> globalReachlocTuple = subGlobalReachalbeNode.getLocTuple();
1958               for (int i = 0; i < globalReachlocTuple.size(); i++) {
1959                 if (globalReachlocTuple.get(i).equals(lastLocationOfPrefix)) {
1960                   // System.out.println("ARG  " + argTuple + "  IS MATCHED WITH="
1961                   // + lastLocationOfPrefix);
1962                   return true;
1963                 }
1964               }
1965             }
1966           }
1967         }
1968       }
1969     }
1970
1971     return false;
1972   }
1973
1974   private boolean checkNodeReachToReturnNode(MethodDescriptor md, FlowNode node) {
1975
1976     FlowGraph flowGraph = getFlowGraph(md);
1977     Set<FlowNode> reachableSet = flowGraph.getReachFlowNodeSetFrom(node);
1978     if (mapMethodDescriptorToCompositeReturnCase.containsKey(md)) {
1979       boolean hasCompReturnLocWithThis =
1980           mapMethodDescriptorToCompositeReturnCase.get(md).booleanValue();
1981
1982       if (hasCompReturnLocWithThis) {
1983         for (Iterator iterator = flowGraph.getReturnNodeSet().iterator(); iterator.hasNext();) {
1984           FlowNode returnFlowNode = (FlowNode) iterator.next();
1985           if (reachableSet.contains(returnFlowNode)) {
1986             return true;
1987           }
1988         }
1989       }
1990     }
1991     return false;
1992   }
1993
1994   private void assignCompositeLocation(CompositeLocation compLocPrefix, GlobalFlowNode node) {
1995     CompositeLocation newCompLoc = compLocPrefix.clone();
1996     NTuple<Location> locTuple = node.getLocTuple();
1997     for (int i = 1; i < locTuple.size(); i++) {
1998       newCompLoc.addLocation(locTuple.get(i));
1999     }
2000     node.setInferCompositeLocation(newCompLoc);
2001   }
2002
2003   private List<NTuple<Location>> calculatePrefixList(GlobalFlowGraph graph, GlobalFlowNode node) {
2004
2005     // System.out.println("\n##### calculatePrefixList node=" + node);
2006
2007     Set<GlobalFlowNode> incomingNodeSetPrefix =
2008         graph.getIncomingNodeSetByPrefix(node.getLocTuple().get(0));
2009     // System.out.println("---incomingNodeSetPrefix=" + incomingNodeSetPrefix);
2010
2011     Set<GlobalFlowNode> reachableNodeSetPrefix =
2012         graph.getReachableNodeSetByPrefix(node.getLocTuple().get(0));
2013     // System.out.println("---reachableNodeSetPrefix=" + reachableNodeSetPrefix);
2014
2015     List<NTuple<Location>> prefixList = new ArrayList<NTuple<Location>>();
2016
2017     for (Iterator iterator = incomingNodeSetPrefix.iterator(); iterator.hasNext();) {
2018       GlobalFlowNode inNode = (GlobalFlowNode) iterator.next();
2019       NTuple<Location> inNodeTuple = inNode.getLocTuple();
2020
2021       if (inNodeTuple.get(0).getLocDescriptor() instanceof InterDescriptor
2022           || inNodeTuple.get(0).getLocDescriptor().equals(GLOBALDESC)) {
2023         continue;
2024       }
2025
2026       for (int i = 1; i < inNodeTuple.size(); i++) {
2027         NTuple<Location> prefix = inNodeTuple.subList(0, i);
2028         if (!prefixList.contains(prefix)) {
2029           prefixList.add(prefix);
2030         }
2031       }
2032     }
2033
2034     Collections.sort(prefixList, new Comparator<NTuple<Location>>() {
2035       public int compare(NTuple<Location> arg0, NTuple<Location> arg1) {
2036         int s0 = arg0.size();
2037         int s1 = arg1.size();
2038         if (s0 > s1) {
2039           return -1;
2040         } else if (s0 == s1) {
2041           return 0;
2042         } else {
2043           return 1;
2044         }
2045       }
2046     });
2047
2048     return prefixList;
2049
2050   }
2051
2052   private CompositeLocation calculateCompositeLocationFromFlowGraph(MethodDescriptor md,
2053       FlowNode node) {
2054
2055     // System.out.println("#############################################################");
2056     // System.out.println("calculateCompositeLocationFromFlowGraph=" + node);
2057
2058     FlowGraph flowGraph = getFlowGraph(md);
2059     // NTuple<Location> paramLocTuple = translateToLocTuple(md, paramNode.getDescTuple());
2060     // GlobalFlowNode paramGlobalNode = subGlobalFlowGraph.getFlowNode(paramLocTuple);
2061
2062     List<NTuple<Location>> prefixList = calculatePrefixListFlowGraph(flowGraph, node);
2063
2064     // Set<GlobalFlowNode> reachableNodeSet =
2065     // subGlobalFlowGraph.getReachableNodeSetByPrefix(paramGlobalNode.getLocTuple().get(0));
2066     //
2067     Set<FlowNode> reachableNodeSet =
2068         flowGraph.getReachableSetFrom(node.getDescTuple().subList(0, 1));
2069
2070     // Set<GlobalFlowNode> reachNodeSet = globalFlowGraph.getReachableNodeSetFrom(node);
2071
2072     // System.out.println("node=" + node + "    prefixList=" + prefixList);
2073
2074     for (int i = 0; i < prefixList.size(); i++) {
2075       NTuple<Location> curPrefix = prefixList.get(i);
2076       Set<NTuple<Location>> reachableCommonPrefixSet = new HashSet<NTuple<Location>>();
2077
2078       for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
2079         FlowNode reachNode = (FlowNode) iterator2.next();
2080         NTuple<Location> reachLocTuple = translateToLocTuple(md, reachNode.getCurrentDescTuple());
2081         if (reachLocTuple.startsWith(curPrefix)) {
2082           reachableCommonPrefixSet.add(reachLocTuple);
2083         }
2084       }
2085       // System.out.println("reachableCommonPrefixSet=" + reachableCommonPrefixSet);
2086
2087       if (!reachableCommonPrefixSet.isEmpty()) {
2088
2089         MethodDescriptor curPrefixFirstElementMethodDesc =
2090             (MethodDescriptor) curPrefix.get(0).getDescriptor();
2091
2092         Location curPrefixLocalLoc = curPrefix.get(0);
2093
2094         Location targetLocalLoc = new Location(md, node.getDescTuple().get(0));
2095         // Location targetLocalLoc = paramGlobalNode.getLocTuple().get(0);
2096
2097         CompositeLocation newCompLoc = generateCompositeLocation(curPrefix);
2098         // System.out.println("NEED2ASSIGN COMP LOC TO " + node + " with prefix=" + curPrefix);
2099         // System.out.println("-targetLocalLoc=" + targetLocalLoc + "   - newCompLoc=" +
2100         // newCompLoc);
2101
2102         node.setCompositeLocation(newCompLoc);
2103
2104         return newCompLoc;
2105
2106       }
2107
2108     }
2109     return null;
2110   }
2111
2112   private List<NTuple<Location>> calculatePrefixListFlowGraph(FlowGraph graph, FlowNode node) {
2113
2114     // System.out.println("\n##### calculatePrefixList node=" + node);
2115
2116     MethodDescriptor md = graph.getMethodDescriptor();
2117     Set<FlowNode> incomingNodeSetPrefix =
2118         graph.getIncomingNodeSetByPrefix(node.getDescTuple().get(0));
2119     // System.out.println("---incomingNodeSetPrefix=" + incomingNodeSetPrefix);
2120
2121     Set<FlowNode> reachableNodeSetPrefix =
2122         graph.getReachableSetFrom(node.getDescTuple().subList(0, 1));
2123     // System.out.println("---reachableNodeSetPrefix=" + reachableNodeSetPrefix);
2124
2125     List<NTuple<Location>> prefixList = new ArrayList<NTuple<Location>>();
2126
2127     for (Iterator iterator = incomingNodeSetPrefix.iterator(); iterator.hasNext();) {
2128       FlowNode inNode = (FlowNode) iterator.next();
2129       NTuple<Location> inNodeTuple = translateToLocTuple(md, inNode.getCurrentDescTuple());
2130
2131       // if (inNodeTuple.get(0).getLocDescriptor() instanceof InterDescriptor
2132       // || inNodeTuple.get(0).getLocDescriptor().equals(GLOBALDESC)) {
2133       // continue;
2134       // }
2135
2136       for (int i = 1; i < inNodeTuple.size(); i++) {
2137         NTuple<Location> prefix = inNodeTuple.subList(0, i);
2138         if (!prefixList.contains(prefix)) {
2139           prefixList.add(prefix);
2140         }
2141       }
2142     }
2143
2144     Collections.sort(prefixList, new Comparator<NTuple<Location>>() {
2145       public int compare(NTuple<Location> arg0, NTuple<Location> arg1) {
2146         int s0 = arg0.size();
2147         int s1 = arg1.size();
2148         if (s0 > s1) {
2149           return -1;
2150         } else if (s0 == s1) {
2151           return 0;
2152         } else {
2153           return 1;
2154         }
2155       }
2156     });
2157
2158     return prefixList;
2159
2160   }
2161
2162   private GlobalFlowGraph constructSubGlobalFlowGraph(FlowGraph flowGraph) {
2163
2164     MethodDescriptor md = flowGraph.getMethodDescriptor();
2165
2166     GlobalFlowGraph globalGraph = getSubGlobalFlowGraph(md);
2167
2168     // Set<FlowNode> nodeSet = flowGraph.getNodeSet();
2169     Set<FlowEdge> edgeSet = flowGraph.getEdgeSet();
2170
2171     for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) {
2172
2173       FlowEdge edge = (FlowEdge) iterator.next();
2174       NTuple<Descriptor> srcDescTuple = edge.getInitTuple();
2175       NTuple<Descriptor> dstDescTuple = edge.getEndTuple();
2176
2177       if (flowGraph.getFlowNode(srcDescTuple) instanceof FlowReturnNode
2178           || flowGraph.getFlowNode(dstDescTuple) instanceof FlowReturnNode) {
2179         continue;
2180       }
2181
2182       // here only keep the first element(method location) of the descriptor
2183       // tuple
2184       NTuple<Location> srcLocTuple = translateToLocTuple(md, srcDescTuple);
2185       NTuple<Location> dstLocTuple = translateToLocTuple(md, dstDescTuple);
2186
2187       globalGraph.addValueFlowEdge(srcLocTuple, dstLocTuple);
2188
2189     }
2190
2191     return globalGraph;
2192   }
2193
2194   private NTuple<Location> translateToLocTuple(MethodDescriptor md, NTuple<Descriptor> descTuple) {
2195
2196     NTuple<Location> locTuple = new NTuple<Location>();
2197
2198     Descriptor enclosingDesc = md;
2199     for (int i = 0; i < descTuple.size(); i++) {
2200       Descriptor desc = descTuple.get(i);
2201
2202       Location loc = new Location(enclosingDesc, desc);
2203       locTuple.add(loc);
2204
2205       if (desc instanceof VarDescriptor) {
2206         enclosingDesc = ((VarDescriptor) desc).getType().getClassDesc();
2207       } else if (desc instanceof FieldDescriptor) {
2208         enclosingDesc = ((FieldDescriptor) desc).getType().getClassDesc();
2209       } else {
2210         enclosingDesc = desc;
2211       }
2212
2213     }
2214
2215     return locTuple;
2216
2217   }
2218
2219   private void addValueFlowsFromCalleeSubGlobalFlowGraph(MethodDescriptor mdCaller) {
2220
2221     // the transformation for a call site propagates flows through parameters
2222     // if the method is virtual, it also grab all relations from any possible
2223     // callees
2224
2225     Set<MethodInvokeNode> setMethodInvokeNode = getMethodInvokeNodeSet(mdCaller);
2226
2227     for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
2228       MethodInvokeNode min = (MethodInvokeNode) iterator.next();
2229       MethodDescriptor mdCallee = min.getMethod();
2230       Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
2231       if (mdCallee.isStatic()) {
2232         setPossibleCallees.add(mdCallee);
2233       } else {
2234         Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getMethods(mdCallee);
2235         // removes method descriptors that are not invoked by the caller
2236         calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller));
2237         setPossibleCallees.addAll(calleeSet);
2238       }
2239
2240       for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) {
2241         MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next();
2242         propagateValueFlowsToCallerFromSubGlobalFlowGraph(min, mdCaller, possibleMdCallee);
2243       }
2244
2245     }
2246
2247   }
2248
2249   private void propagateValueFlowsToCallerFromSubGlobalFlowGraph(MethodInvokeNode min,
2250       MethodDescriptor mdCaller, MethodDescriptor possibleMdCallee) {
2251
2252     // System.out.println("---propagate from " + min.printNode(0) + " to caller=" + mdCaller);
2253     FlowGraph calleeFlowGraph = getFlowGraph(possibleMdCallee);
2254     Map<Integer, NTuple<Descriptor>> mapIdxToArg = mapMethodInvokeNodeToArgIdxMap.get(min);
2255
2256     // System.out.println("-----mapMethodInvokeNodeToArgIdxMap.get(min)="
2257     // + mapMethodInvokeNodeToArgIdxMap.get(min));
2258
2259     Set<Integer> keySet = mapIdxToArg.keySet();
2260     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2261       Integer idx = (Integer) iterator.next();
2262       NTuple<Descriptor> argDescTuple = mapIdxToArg.get(idx);
2263       if (argDescTuple.size() > 0) {
2264         NTuple<Location> argLocTuple = translateToLocTuple(mdCaller, argDescTuple);
2265         NTuple<Descriptor> paramDescTuple = calleeFlowGraph.getParamFlowNode(idx).getDescTuple();
2266         NTuple<Location> paramLocTuple = translateToLocTuple(possibleMdCallee, paramDescTuple);
2267         // System.out.println("-------paramDescTuple=" + paramDescTuple + "->argDescTuple="
2268         // + argDescTuple);
2269         addMapCallerArgToCalleeParam(min, argDescTuple, paramDescTuple);
2270       }
2271     }
2272
2273     // addValueFlowBetweenParametersToCaller(min, mdCaller, possibleMdCallee);
2274
2275     NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
2276     GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(possibleMdCallee);
2277     Set<GlobalFlowNode> calleeNodeSet = calleeSubGlobalGraph.getNodeSet();
2278     for (Iterator iterator = calleeNodeSet.iterator(); iterator.hasNext();) {
2279       GlobalFlowNode calleeNode = (GlobalFlowNode) iterator.next();
2280       addValueFlowFromCalleeNode(min, mdCaller, possibleMdCallee, calleeNode);
2281     }
2282
2283     // System.out.println("$$$GLOBAL PC LOC ADD=" + mdCaller);
2284     Set<NTuple<Location>> pcLocTupleSet = mapMethodInvokeNodeToPCLocTupleSet.get(min);
2285     // System.out.println("---pcLocTupleSet=" + pcLocTupleSet);
2286     GlobalFlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller);
2287     for (Iterator iterator = calleeNodeSet.iterator(); iterator.hasNext();) {
2288       GlobalFlowNode calleeNode = (GlobalFlowNode) iterator.next();
2289       if (calleeNode.isParamNodeWithIncomingFlows()) {
2290         // System.out.println("calleeNode.getLocTuple()" + calleeNode.getLocTuple());
2291         NTuple<Location> callerSrcNodeLocTuple =
2292             translateToCallerLocTuple(min, possibleMdCallee, mdCaller, calleeNode.getLocTuple());
2293         // System.out.println("---callerSrcNodeLocTuple=" + callerSrcNodeLocTuple);
2294         if (callerSrcNodeLocTuple != null && callerSrcNodeLocTuple.size() > 0) {
2295           for (Iterator iterator2 = pcLocTupleSet.iterator(); iterator2.hasNext();) {
2296             NTuple<Location> pcLocTuple = (NTuple<Location>) iterator2.next();
2297
2298             callerSubGlobalGraph.addValueFlowEdge(pcLocTuple, callerSrcNodeLocTuple);
2299           }
2300         }
2301       }
2302
2303     }
2304
2305   }
2306
2307   private void addValueFlowFromCalleeNode(MethodInvokeNode min, MethodDescriptor mdCaller,
2308       MethodDescriptor mdCallee, GlobalFlowNode calleeSrcNode) {
2309
2310     GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(mdCallee);
2311     GlobalFlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller);
2312
2313     // System.out.println("$addValueFlowFromCalleeNode calleeSrcNode=" + calleeSrcNode);
2314
2315     NTuple<Location> callerSrcNodeLocTuple =
2316         translateToCallerLocTuple(min, mdCallee, mdCaller, calleeSrcNode.getLocTuple());
2317     // System.out.println("---callerSrcNodeLocTuple=" + callerSrcNodeLocTuple);
2318
2319     if (callerSrcNodeLocTuple != null && callerSrcNodeLocTuple.size() > 0) {
2320
2321       Set<GlobalFlowNode> outNodeSet = calleeSubGlobalGraph.getOutNodeSet(calleeSrcNode);
2322
2323       for (Iterator iterator = outNodeSet.iterator(); iterator.hasNext();) {
2324         GlobalFlowNode outNode = (GlobalFlowNode) iterator.next();
2325         NTuple<Location> callerDstNodeLocTuple =
2326             translateToCallerLocTuple(min, mdCallee, mdCaller, outNode.getLocTuple());
2327         // System.out.println("outNode=" + outNode + "   callerDstNodeLocTuple="
2328         // + callerDstNodeLocTuple);
2329         if (callerSrcNodeLocTuple != null && callerDstNodeLocTuple != null
2330             && callerSrcNodeLocTuple.size() > 0 && callerDstNodeLocTuple.size() > 0) {
2331           callerSubGlobalGraph.addValueFlowEdge(callerSrcNodeLocTuple, callerDstNodeLocTuple);
2332         }
2333       }
2334     }
2335
2336   }
2337
2338   private NTuple<Location> translateToCallerLocTuple(MethodInvokeNode min,
2339       MethodDescriptor mdCallee, MethodDescriptor mdCaller, NTuple<Location> nodeLocTuple) {
2340     // this method will return the same nodeLocTuple if the corresponding argument is literal
2341     // value.
2342
2343     // System.out.println("translateToCallerLocTuple=" + nodeLocTuple);
2344
2345     FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
2346     NTuple<Descriptor> nodeDescTuple = translateToDescTuple(nodeLocTuple);
2347     if (calleeFlowGraph.isParameter(nodeDescTuple)) {
2348       int paramIdx = calleeFlowGraph.getParamIdx(nodeDescTuple);
2349       NTuple<Descriptor> argDescTuple = mapMethodInvokeNodeToArgIdxMap.get(min).get(paramIdx);
2350
2351       // if (isPrimitive(nodeLocTuple.get(0).getLocDescriptor())) {
2352       // // the type of argument is primitive.
2353       // return nodeLocTuple.clone();
2354       // }
2355       // System.out.println("paramIdx=" + paramIdx + "  argDescTuple=" + argDescTuple + " from min="
2356       // + min.printNode(0));
2357       NTuple<Location> argLocTuple = translateToLocTuple(mdCaller, argDescTuple);
2358
2359       NTuple<Location> callerLocTuple = new NTuple<Location>();
2360
2361       callerLocTuple.addAll(argLocTuple);
2362       for (int i = 1; i < nodeLocTuple.size(); i++) {
2363         callerLocTuple.add(nodeLocTuple.get(i));
2364       }
2365       return callerLocTuple;
2366     } else {
2367       return nodeLocTuple.clone();
2368     }
2369
2370   }
2371
2372   public static boolean isPrimitive(Descriptor desc) {
2373
2374     if (desc instanceof FieldDescriptor) {
2375       return ((FieldDescriptor) desc).getType().isPrimitive();
2376     } else if (desc instanceof VarDescriptor) {
2377       return ((VarDescriptor) desc).getType().isPrimitive();
2378     } else if (desc instanceof InterDescriptor) {
2379       return true;
2380     }
2381
2382     return false;
2383   }
2384
2385   public static boolean isReference(Descriptor desc) {
2386
2387     if (desc instanceof FieldDescriptor) {
2388
2389       TypeDescriptor type = ((FieldDescriptor) desc).getType();
2390       if (type.isArray()) {
2391         return !type.isPrimitive();
2392       } else {
2393         return type.isPtr();
2394       }
2395
2396     } else if (desc instanceof VarDescriptor) {
2397       TypeDescriptor type = ((VarDescriptor) desc).getType();
2398       if (type.isArray()) {
2399         return !type.isPrimitive();
2400       } else {
2401         return type.isPtr();
2402       }
2403     }
2404
2405     return false;
2406   }
2407
2408   private NTuple<Descriptor> translateToDescTuple(NTuple<Location> locTuple) {
2409
2410     NTuple<Descriptor> descTuple = new NTuple<Descriptor>();
2411     for (int i = 0; i < locTuple.size(); i++) {
2412       descTuple.add(locTuple.get(i).getLocDescriptor());
2413     }
2414     return descTuple;
2415
2416   }
2417
2418   public LocationSummary getLocationSummary(Descriptor d) {
2419     if (!mapDescToLocationSummary.containsKey(d)) {
2420       if (d instanceof MethodDescriptor) {
2421         mapDescToLocationSummary.put(d, new MethodSummary((MethodDescriptor) d));
2422       } else if (d instanceof ClassDescriptor) {
2423         mapDescToLocationSummary.put(d, new FieldSummary());
2424       }
2425     }
2426     return mapDescToLocationSummary.get(d);
2427   }
2428
2429   private void generateMethodSummary() {
2430
2431     Set<MethodDescriptor> keySet = md2lattice.keySet();
2432     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2433       MethodDescriptor md = (MethodDescriptor) iterator.next();
2434
2435       System.out.println("\nSSJAVA: generate method summary: " + md);
2436
2437       FlowGraph flowGraph = getFlowGraph(md);
2438       if (flowGraph == null) {
2439         continue;
2440       }
2441       MethodSummary methodSummary = getMethodSummary(md);
2442
2443       HierarchyGraph scGraph = getSkeletonCombinationHierarchyGraph(md);
2444
2445       // set the 'this' reference location
2446       if (!md.isStatic()) {
2447         // System.out.println("setThisLocName=" + scGraph.getHNode(md.getThis()).getName());
2448         methodSummary.setThisLocName(scGraph.getHNode(md.getThis()).getName());
2449       }
2450
2451       // set the 'global' reference location if needed
2452       if (methodSummary.hasGlobalAccess()) {
2453         methodSummary.setGlobalLocName(scGraph.getHNode(GLOBALDESC).getName());
2454       }
2455
2456       // construct a parameter mapping that maps a parameter descriptor to an
2457       // inferred composite location
2458       for (int paramIdx = 0; paramIdx < flowGraph.getNumParameters(); paramIdx++) {
2459         FlowNode flowNode = flowGraph.getParamFlowNode(paramIdx);
2460         CompositeLocation inferredCompLoc =
2461             updateCompositeLocation(flowNode.getCompositeLocation());
2462         // System.out.println("-paramIdx=" + paramIdx + "   infer=" + inferredCompLoc + " original="
2463         // + flowNode.getCompositeLocation());
2464
2465         Descriptor localVarDesc = flowNode.getDescTuple().get(0);
2466         methodSummary.addMapVarNameToInferCompLoc(localVarDesc, inferredCompLoc);
2467         methodSummary.addMapParamIdxToInferLoc(paramIdx, inferredCompLoc);
2468       }
2469
2470     }
2471
2472   }
2473
2474   private boolean hasOrderingRelation(NTuple<Location> locTuple1, NTuple<Location> locTuple2) {
2475
2476     int size = locTuple1.size() >= locTuple2.size() ? locTuple2.size() : locTuple1.size();
2477
2478     for (int idx = 0; idx < size; idx++) {
2479       Location loc1 = locTuple1.get(idx);
2480       Location loc2 = locTuple2.get(idx);
2481
2482       Descriptor desc1 = loc1.getDescriptor();
2483       Descriptor desc2 = loc2.getDescriptor();
2484
2485       if (!desc1.equals(desc2)) {
2486         throw new Error("Fail to compare " + locTuple1 + " and " + locTuple2);
2487       }
2488
2489       Descriptor locDesc1 = loc1.getLocDescriptor();
2490       Descriptor locDesc2 = loc2.getLocDescriptor();
2491
2492       HierarchyGraph hierarchyGraph = getHierarchyGraph(desc1);
2493
2494       HNode node1 = hierarchyGraph.getHNode(locDesc1);
2495       HNode node2 = hierarchyGraph.getHNode(locDesc2);
2496
2497       // System.out.println("---node1=" + node1 + "  node2=" + node2);
2498       // System.out.println("---hierarchyGraph.getIncomingNodeSet(node2)="
2499       // + hierarchyGraph.getIncomingNodeSet(node2));
2500
2501       if (locDesc1.equals(locDesc2)) {
2502         continue;
2503       } else if (!hierarchyGraph.getIncomingNodeSet(node2).contains(node1)
2504           && !hierarchyGraph.getIncomingNodeSet(node1).contains(node2)) {
2505         return false;
2506       } else {
2507         return true;
2508       }
2509
2510     }
2511
2512     return false;
2513
2514   }
2515
2516   private boolean isHigherThan(NTuple<Location> locTuple1, NTuple<Location> locTuple2) {
2517
2518     int size = locTuple1.size() >= locTuple2.size() ? locTuple2.size() : locTuple1.size();
2519
2520     for (int idx = 0; idx < size; idx++) {
2521       Location loc1 = locTuple1.get(idx);
2522       Location loc2 = locTuple2.get(idx);
2523
2524       Descriptor desc1 = loc1.getDescriptor();
2525       Descriptor desc2 = loc2.getDescriptor();
2526
2527       if (!desc1.equals(desc2)) {
2528         throw new Error("Fail to compare " + locTuple1 + " and " + locTuple2);
2529       }
2530
2531       Descriptor locDesc1 = loc1.getLocDescriptor();
2532       Descriptor locDesc2 = loc2.getLocDescriptor();
2533
2534       HierarchyGraph hierarchyGraph = getHierarchyGraph(desc1);
2535
2536       HNode node1 = hierarchyGraph.getHNode(locDesc1);
2537       HNode node2 = hierarchyGraph.getHNode(locDesc2);
2538
2539       // System.out.println("---node1=" + node1 + "  node2=" + node2);
2540       // System.out.println("---hierarchyGraph.getIncomingNodeSet(node2)="
2541       // + hierarchyGraph.getIncomingNodeSet(node2));
2542
2543       if (locDesc1.equals(locDesc2)) {
2544         continue;
2545       } else if (hierarchyGraph.getIncomingNodeSet(node2).contains(node1)) {
2546         return true;
2547       } else {
2548         return false;
2549       }
2550
2551     }
2552
2553     return false;
2554   }
2555
2556   private void debug_writeLattices() {
2557
2558     Set<Descriptor> keySet = mapDescriptorToSkeletonLattice.keySet();
2559     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2560       Descriptor key = (Descriptor) iterator.next();
2561       SSJavaLattice<String> skeletonLattice = mapDescriptorToSkeletonLattice.get(key);
2562       // HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(key);
2563       HierarchyGraph scHierarchyGraph = getSkeletonCombinationHierarchyGraph(key);
2564       if (key instanceof ClassDescriptor) {
2565         writeInferredLatticeDotFile((ClassDescriptor) key, skeletonLattice, "_SKELETON");
2566       } else if (key instanceof MethodDescriptor) {
2567         MethodDescriptor md = (MethodDescriptor) key;
2568         writeInferredLatticeDotFile(md.getClassDesc(), md, skeletonLattice, "_SKELETON");
2569       }
2570
2571       LocationSummary ls = getLocationSummary(key);
2572       // System.out.println("####LOC SUMMARY=" + key + "\n" + ls.getMapHNodeNameToLocationName());
2573     }
2574
2575     Set<ClassDescriptor> cdKeySet = cd2lattice.keySet();
2576     for (Iterator iterator = cdKeySet.iterator(); iterator.hasNext();) {
2577       ClassDescriptor cd = (ClassDescriptor) iterator.next();
2578       // System.out.println("########cd=" + cd);
2579       writeInferredLatticeDotFile((ClassDescriptor) cd, cd2lattice.get(cd), "");
2580       COUNT += cd2lattice.get(cd).getKeySet().size();
2581     }
2582
2583     Set<MethodDescriptor> mdKeySet = md2lattice.keySet();
2584     for (Iterator iterator = mdKeySet.iterator(); iterator.hasNext();) {
2585       MethodDescriptor md = (MethodDescriptor) iterator.next();
2586       writeInferredLatticeDotFile(md.getClassDesc(), md, md2lattice.get(md), "");
2587       COUNT += md2lattice.get(md).getKeySet().size();
2588     }
2589     System.out.println("###COUNT=" + COUNT);
2590
2591     Set<Descriptor> descKeySet = desc2naiveLattice.keySet();
2592     for (Iterator iterator = descKeySet.iterator(); iterator.hasNext();) {
2593       Descriptor desc = (Descriptor) iterator.next();
2594       // System.out.println("########cd=" + cd);
2595
2596       ClassDescriptor cd_naive;
2597       MethodDescriptor md_naive;
2598       if (desc instanceof ClassDescriptor) {
2599         cd_naive = (ClassDescriptor) desc;
2600         md_naive = null;
2601       } else {
2602         md_naive = (MethodDescriptor) desc;
2603         cd_naive = md_naive.getClassDesc();
2604       }
2605
2606       writeInferredLatticeDotFile(cd_naive, md_naive, desc2naiveLattice.get(desc), "_naive");
2607     }
2608   }
2609
2610   private void buildLattice(Descriptor desc) {
2611     // System.out.println("buildLattice=" + desc);
2612     SSJavaLattice<String> skeletonLattice = buildLattice.buildLattice(desc);
2613
2614     addMapDescToSkeletonLattice(desc, skeletonLattice);
2615
2616     // write a dot file before everything is done
2617     if (desc instanceof ClassDescriptor) {
2618       writeInferredLatticeDotFile((ClassDescriptor) desc, null, skeletonLattice, "_SC");
2619     } else {
2620       MethodDescriptor md = (MethodDescriptor) desc;
2621       writeInferredLatticeDotFile(md.getClassDesc(), md, skeletonLattice, "_SC");
2622     }
2623
2624     HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
2625
2626     // System.out.println("\n## insertIntermediateNodesToStraightLine:"
2627     // + simpleHierarchyGraph.getName());
2628     SSJavaLattice<String> lattice =
2629         buildLattice.insertIntermediateNodesToStraightLine(desc, skeletonLattice);
2630
2631     if (lattice == null) {
2632       return;
2633     }
2634     lattice.removeRedundantEdges();
2635
2636     LocationInference.numLocationsSInfer += lattice.getKeySet().size();
2637
2638     if (desc instanceof ClassDescriptor) {
2639       // field lattice
2640       cd2lattice.put((ClassDescriptor) desc, lattice);
2641       ssjava.writeLatticeDotFile((ClassDescriptor) desc, null, lattice);
2642     } else if (desc instanceof MethodDescriptor) {
2643       // method lattice
2644       md2lattice.put((MethodDescriptor) desc, lattice);
2645       MethodDescriptor md = (MethodDescriptor) desc;
2646       ClassDescriptor cd = md.getClassDesc();
2647       ssjava.writeLatticeDotFile(cd, md, lattice);
2648     }
2649
2650   }
2651
2652   // deprecated: it builds method/class lattices without considering class inheritance
2653   private void buildLattice() {
2654
2655     Set<Descriptor> keySet = mapDescriptorToCombineSkeletonHierarchyGraph.keySet();
2656     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2657       Descriptor desc = (Descriptor) iterator.next();
2658
2659       SSJavaLattice<String> simpleLattice = buildLattice.buildLattice(desc);
2660
2661       addMapDescToSkeletonLattice(desc, simpleLattice);
2662
2663       HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
2664       System.out.println("\n## insertIntermediateNodesToStraightLine:"
2665           + simpleHierarchyGraph.getName());
2666       SSJavaLattice<String> lattice =
2667           buildLattice.insertIntermediateNodesToStraightLine(desc, simpleLattice);
2668       lattice.removeRedundantEdges();
2669
2670       LocationInference.numLocationsSInfer += lattice.getKeySet().size();
2671
2672       if (desc instanceof ClassDescriptor) {
2673         // field lattice
2674         cd2lattice.put((ClassDescriptor) desc, lattice);
2675         // ssjava.writeLatticeDotFile((ClassDescriptor) desc, null, lattice);
2676       } else if (desc instanceof MethodDescriptor) {
2677         // method lattice
2678         md2lattice.put((MethodDescriptor) desc, lattice);
2679         MethodDescriptor md = (MethodDescriptor) desc;
2680         ClassDescriptor cd = md.getClassDesc();
2681         // ssjava.writeLatticeDotFile(cd, md, lattice);
2682       }
2683
2684     }
2685
2686   }
2687
2688   private void buildLatticeInheritanceTree() {
2689     // DFS the inheritance tree and propagates lattice nodes/edges from the parent to children
2690     // Node<ClassDescriptor> rootNode = inheritanceTree.getRootNode();
2691     DFSBuildLatticeInheritanceTree(rootClassDescriptor);
2692   }
2693
2694   public Set<ClassDescriptor> getDirectSubClasses(ClassDescriptor parent) {
2695
2696     Set<ClassDescriptor> result = new HashSet<ClassDescriptor>();
2697
2698     Set<ClassDescriptor> children = tu.getDirectSubClasses(parent);
2699     if (children == null) {
2700       children = new HashSet<ClassDescriptor>();
2701     }
2702
2703     for (Iterator iterator = children.iterator(); iterator.hasNext();) {
2704       ClassDescriptor child = (ClassDescriptor) iterator.next();
2705       if (toanalyze_classDescSet.contains(child)) {
2706         result.add(child);
2707       }
2708     }
2709
2710     return result;
2711   }
2712
2713   private void DFSBuildLatticeInheritanceTree(ClassDescriptor cd) {
2714     // ClassDescriptor cd = node.getData();
2715
2716     ClassDescriptor parentClassDesc = cd.getSuperDesc();
2717     if (parentClassDesc != null) {
2718       Map<TripleItem, String> parentMap = buildLattice.getIntermediateLocMap(parentClassDesc);
2719       buildLattice.setIntermediateLocMap(cd, parentMap);
2720     }
2721
2722     buildLattice(cd);
2723
2724     for (Iterator iterator = cd.getMethods(); iterator.hasNext();) {
2725       MethodDescriptor md = (MethodDescriptor) iterator.next();
2726       if (toanalyze_methodDescList.contains(md)) {
2727         MethodDescriptor parentMethodDesc = getParentMethodDesc(md.getClassDesc(), md);
2728         if (parentMethodDesc != null) {
2729           Map<TripleItem, String> parentMap = buildLattice.getIntermediateLocMap(parentMethodDesc);
2730           Map<TripleItem, String> childMap = new HashMap<TripleItem, String>();
2731           Set<TripleItem> keySet = parentMap.keySet();
2732           for (Iterator iterator2 = keySet.iterator(); iterator2.hasNext();) {
2733             TripleItem key = (TripleItem) iterator2.next();
2734             childMap.put(key, parentMap.get(key));
2735           }
2736           buildLattice.setIntermediateLocMap(md, childMap);
2737         }
2738         buildLattice(md);
2739       }
2740     }
2741
2742     // traverse children
2743     Set<ClassDescriptor> children = tu.getDirectSubClasses(cd);
2744     if (children != null) {
2745       for (Iterator iterator = children.iterator(); iterator.hasNext();) {
2746         ClassDescriptor classDescriptor = (ClassDescriptor) iterator.next();
2747         if (toanalyze_classDescSet.contains(classDescriptor)) {
2748           DFSBuildLatticeInheritanceTree(classDescriptor);
2749         } else {
2750           if (classDescriptor.isAbstract()) {
2751             DFSBuildLatticeInheritanceTree(classDescriptor);
2752           }
2753         }
2754       }
2755     }
2756
2757   }
2758
2759   public void addMapDescToSkeletonLattice(Descriptor desc, SSJavaLattice<String> lattice) {
2760     mapDescriptorToSkeletonLattice.put(desc, lattice);
2761   }
2762
2763   public SSJavaLattice<String> getSkeletonLattice(Descriptor desc) {
2764     return mapDescriptorToSkeletonLattice.get(desc);
2765   }
2766
2767   private void simplifyHierarchyGraph() {
2768     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2769     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2770       Descriptor desc = (Descriptor) iterator.next();
2771       // System.out.println("SSJAVA: remove redundant edges: " + desc);
2772       HierarchyGraph simpleHierarchyGraph = getHierarchyGraph(desc).clone();
2773       simpleHierarchyGraph.setName(desc + "_SIMPLE");
2774       simpleHierarchyGraph.removeRedundantEdges();
2775       mapDescriptorToSimpleHierarchyGraph.put(desc, simpleHierarchyGraph);
2776     }
2777   }
2778
2779   private void insertCombinationNodes() {
2780     Set<Descriptor> keySet = mapDescriptorToSkeletonHierarchyGraph.keySet();
2781     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2782       Descriptor desc = (Descriptor) iterator.next();
2783       System.out.println("\nSSJAVA: Inserting Combination Nodes:" + desc);
2784       HierarchyGraph skeletonGraph = getSkeletonHierarchyGraph(desc);
2785       HierarchyGraph skeletonGraphWithCombinationNode = skeletonGraph.clone();
2786       skeletonGraphWithCombinationNode.setSCGraph(true);
2787       skeletonGraphWithCombinationNode.setName(desc + "_SC");
2788
2789       HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
2790       skeletonGraphWithCombinationNode.insertCombinationNodesToGraph(simpleHierarchyGraph);
2791       // skeletonGraphWithCombinationNode.insertCombinationNodesToGraph(simpleHierarchyGraph,
2792       // skeletonGraph);
2793       // skeletonGraphWithCombinationNode.simplifySkeletonCombinationHierarchyGraph();
2794       skeletonGraphWithCombinationNode.removeRedundantEdges();
2795       mapDescriptorToCombineSkeletonHierarchyGraph.put(desc, skeletonGraphWithCombinationNode);
2796     }
2797   }
2798
2799   private void constructSkeletonHierarchyGraph() {
2800     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2801     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2802       Descriptor desc = (Descriptor) iterator.next();
2803       System.out.println("SSJAVA: Constructing Skeleton Hierarchy Graph: " + desc);
2804       HierarchyGraph simpleGraph = getSimpleHierarchyGraph(desc);
2805       HierarchyGraph skeletonGraph = simpleGraph.generateSkeletonGraph();
2806       skeletonGraph.setMapDescToHNode(simpleGraph.getMapDescToHNode());
2807       skeletonGraph.setMapHNodeToDescSet(simpleGraph.getMapHNodeToDescSet());
2808       skeletonGraph.simplifyHierarchyGraph(this);
2809       mapDescriptorToSkeletonHierarchyGraph.put(desc, skeletonGraph);
2810     }
2811   }
2812
2813   private void recurUpAccumulateInheritanceDesc(Descriptor curDesc, Set<Descriptor> set) {
2814
2815     if (curDesc instanceof ClassDescriptor) {
2816       ClassDescriptor cd = (ClassDescriptor) curDesc;
2817       ClassDescriptor parentClassDesc = cd.getSuperDesc();
2818       if (parentClassDesc != null && !parentClassDesc.equals(rootClassDescriptor)) {
2819         set.add(parentClassDesc);
2820         recurUpAccumulateInheritanceDesc(parentClassDesc, set);
2821       }
2822     } else {
2823       MethodDescriptor md = (MethodDescriptor) curDesc;
2824       ClassDescriptor cd = md.getClassDesc();
2825
2826       // traverse up
2827       ClassDescriptor parentClassDesc = cd.getSuperDesc();
2828       if (parentClassDesc != null && !parentClassDesc.equals(rootClassDescriptor)) {
2829
2830         Set<MethodDescriptor> methodDescSet =
2831             parentClassDesc.getMethodTable().getSet(md.getSymbol());
2832         for (Iterator iterator = methodDescSet.iterator(); iterator.hasNext();) {
2833           MethodDescriptor parentMethodDesc = (MethodDescriptor) iterator.next();
2834           if (parentMethodDesc.matches(md)) {
2835             set.add(parentMethodDesc);
2836             recurUpAccumulateInheritanceDesc(parentMethodDesc, set);
2837           }
2838         }
2839       }
2840
2841     }
2842
2843   }
2844
2845   private void recurDownAccumulateInheritanceDesc(Descriptor curDesc, Set<Descriptor> set) {
2846
2847     if (curDesc instanceof ClassDescriptor) {
2848       ClassDescriptor cd = (ClassDescriptor) curDesc;
2849       ClassDescriptor parentClassDesc = cd.getSuperDesc();
2850       Set<ClassDescriptor> directSubClasses = tu.getDirectSubClasses(cd);
2851       for (Iterator iterator = directSubClasses.iterator(); iterator.hasNext();) {
2852         ClassDescriptor child = (ClassDescriptor) iterator.next();
2853         recurDownAccumulateInheritanceDesc(child, set);
2854       }
2855     } else {
2856       MethodDescriptor md = (MethodDescriptor) curDesc;
2857       ClassDescriptor cd = md.getClassDesc();
2858
2859       // traverse down
2860       Set<ClassDescriptor> directSubClasses = tu.getDirectSubClasses(cd);
2861       for (Iterator iterator = directSubClasses.iterator(); iterator.hasNext();) {
2862         ClassDescriptor child = (ClassDescriptor) iterator.next();
2863
2864         Set<MethodDescriptor> methodDescSet = child.getMethodTable().getSet(md.getSymbol());
2865         for (Iterator iterator2 = methodDescSet.iterator(); iterator2.hasNext();) {
2866           MethodDescriptor childMethodDesc = (MethodDescriptor) iterator2.next();
2867           if (childMethodDesc.matches(md)) {
2868             set.add(childMethodDesc);
2869             recurDownAccumulateInheritanceDesc(childMethodDesc, set);
2870           }
2871         }
2872       }
2873
2874     }
2875
2876   }
2877
2878   private void accumulateInheritanceDesc(Descriptor curDesc, Set<Descriptor> set) {
2879
2880     recurUpAccumulateInheritanceDesc(curDesc, set);
2881     recurDownAccumulateInheritanceDesc(curDesc, set);
2882
2883   }
2884
2885   public boolean isValidMergeInheritanceCheck(Descriptor desc, Set<HNode> mergeSet) {
2886
2887     // set up inheritance chain set...
2888     Set<Descriptor> inheritanceDescSet = new HashSet<Descriptor>();
2889     recurUpAccumulateInheritanceDesc(desc, inheritanceDescSet);
2890
2891     nextgraph: for (Iterator iterator = inheritanceDescSet.iterator(); iterator.hasNext();) {
2892       Descriptor inheritDesc = (Descriptor) iterator.next();
2893
2894       if (!desc.equals(inheritDesc)) {
2895         HierarchyGraph graph = getSkeletonCombinationHierarchyGraph(inheritDesc);
2896
2897         // first check whether this graph includes all elements of the merge set
2898         for (Iterator iterator2 = mergeSet.iterator(); iterator2.hasNext();) {
2899           HNode node = (HNode) iterator2.next();
2900           if (!graph.contains(node)) {
2901             continue nextgraph;
2902           }
2903         }
2904
2905         HNode firstNode = mergeSet.iterator().next();
2906
2907         Set<HNode> incomingNode = graph.getIncomingNodeSet(firstNode);
2908         Set<HNode> outgoingNode = graph.getOutgoingNodeSet(firstNode);
2909
2910         for (Iterator iterator2 = mergeSet.iterator(); iterator2.hasNext();) {
2911           HNode node = (HNode) iterator2.next();
2912
2913           if (!graph.getIncomingNodeSet(node).equals(incomingNode)
2914               || !graph.getOutgoingNodeSet(node).equals(outgoingNode)) {
2915             return false;
2916           }
2917
2918         }
2919       }
2920
2921     }
2922
2923     return true;
2924   }
2925
2926   private void debug_writeHierarchyDotFiles() {
2927
2928     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2929     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2930       Descriptor desc = (Descriptor) iterator.next();
2931       getHierarchyGraph(desc).writeGraph();
2932     }
2933
2934   }
2935
2936   private void debug_writeSimpleHierarchyDotFiles() {
2937
2938     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2939     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2940       Descriptor desc = (Descriptor) iterator.next();
2941       getHierarchyGraph(desc).writeGraph();
2942       getSimpleHierarchyGraph(desc).writeGraph();
2943       getSimpleHierarchyGraph(desc).writeGraph(true);
2944     }
2945
2946   }
2947
2948   private void debug_writeSkeletonHierarchyDotFiles() {
2949
2950     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2951     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2952       Descriptor desc = (Descriptor) iterator.next();
2953       getSkeletonHierarchyGraph(desc).writeGraph();
2954     }
2955
2956   }
2957
2958   private void debug_writeSkeletonCombinationHierarchyDotFiles() {
2959
2960     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
2961     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
2962       Descriptor desc = (Descriptor) iterator.next();
2963       getSkeletonCombinationHierarchyGraph(desc).writeGraph();
2964     }
2965
2966   }
2967
2968   public HierarchyGraph getSimpleHierarchyGraph(Descriptor d) {
2969     return mapDescriptorToSimpleHierarchyGraph.get(d);
2970   }
2971
2972   private HierarchyGraph getSkeletonHierarchyGraph(Descriptor d) {
2973     if (!mapDescriptorToSkeletonHierarchyGraph.containsKey(d)) {
2974       mapDescriptorToSkeletonHierarchyGraph.put(d, new HierarchyGraph(d));
2975     }
2976     return mapDescriptorToSkeletonHierarchyGraph.get(d);
2977   }
2978
2979   public HierarchyGraph getSkeletonCombinationHierarchyGraph(Descriptor d) {
2980     if (!mapDescriptorToCombineSkeletonHierarchyGraph.containsKey(d)) {
2981       mapDescriptorToCombineSkeletonHierarchyGraph.put(d, new HierarchyGraph(d));
2982     }
2983     return mapDescriptorToCombineSkeletonHierarchyGraph.get(d);
2984   }
2985
2986   private void constructHierarchyGraph() {
2987
2988     LinkedList<MethodDescriptor> methodDescList =
2989         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
2990
2991     while (!methodDescList.isEmpty()) {
2992       MethodDescriptor md = methodDescList.removeLast();
2993       if (state.SSJAVADEBUG) {
2994         HierarchyGraph hierarchyGraph = new HierarchyGraph(md);
2995         System.out.println();
2996         System.out.println("SSJAVA: Construcing the hierarchy graph from " + md);
2997         constructHierarchyGraph(md, hierarchyGraph);
2998         mapDescriptorToHierarchyGraph.put(md, hierarchyGraph);
2999
3000       }
3001     }
3002
3003     setupToAnalyze();
3004     while (!toAnalyzeIsEmpty()) {
3005       ClassDescriptor cd = toAnalyzeNext();
3006       HierarchyGraph graph = getHierarchyGraph(cd);
3007       for (Iterator iter = cd.getFields(); iter.hasNext();) {
3008         FieldDescriptor fieldDesc = (FieldDescriptor) iter.next();
3009         if (!(fieldDesc.isStatic() && fieldDesc.isFinal())) {
3010           graph.getHNode(fieldDesc);
3011         }
3012       }
3013     }
3014
3015     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
3016     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
3017       Descriptor key = (Descriptor) iterator.next();
3018       HierarchyGraph graph = getHierarchyGraph(key);
3019
3020       Set<HNode> nodeToBeConnected = new HashSet<HNode>();
3021       for (Iterator iterator2 = graph.getNodeSet().iterator(); iterator2.hasNext();) {
3022         HNode node = (HNode) iterator2.next();
3023         if (!node.isSkeleton() && !node.isCombinationNode()) {
3024           if (graph.getIncomingNodeSet(node).size() == 0) {
3025             nodeToBeConnected.add(node);
3026           }
3027         }
3028       }
3029
3030       for (Iterator iterator2 = nodeToBeConnected.iterator(); iterator2.hasNext();) {
3031         HNode node = (HNode) iterator2.next();
3032         // System.out.println("NEED TO BE CONNECTED TO TOP=" + node);
3033         graph.addEdge(graph.getHNode(TOPDESC), node);
3034       }
3035
3036     }
3037
3038   }
3039
3040   private void constructHierarchyGraph2() {
3041
3042     // do fixed-point analysis
3043
3044     LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
3045
3046     // Collections.sort(descriptorListToAnalyze, new
3047     // Comparator<MethodDescriptor>() {
3048     // public int compare(MethodDescriptor o1, MethodDescriptor o2) {
3049     // return o1.getSymbol().compareToIgnoreCase(o2.getSymbol());
3050     // }
3051     // });
3052
3053     // current descriptors to visit in fixed-point interprocedural analysis,
3054     // prioritized by dependency in the call graph
3055     methodDescriptorsToVisitStack.clear();
3056
3057     Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
3058     methodDescriptorToVistSet.addAll(descriptorListToAnalyze);
3059
3060     while (!descriptorListToAnalyze.isEmpty()) {
3061       MethodDescriptor md = descriptorListToAnalyze.removeFirst();
3062       methodDescriptorsToVisitStack.add(md);
3063     }
3064
3065     // analyze scheduled methods until there are no more to visit
3066     while (!methodDescriptorsToVisitStack.isEmpty()) {
3067       // start to analyze leaf node
3068       MethodDescriptor md = methodDescriptorsToVisitStack.pop();
3069
3070       HierarchyGraph hierarchyGraph = new HierarchyGraph(md);
3071       // MethodSummary methodSummary = new MethodSummary(md);
3072
3073       // MethodLocationInfo methodInfo = new MethodLocationInfo(md);
3074       // curMethodInfo = methodInfo;
3075
3076       System.out.println();
3077       System.out.println("SSJAVA: Construcing the hierarchy graph from " + md);
3078
3079       constructHierarchyGraph(md, hierarchyGraph);
3080
3081       HierarchyGraph prevHierarchyGraph = getHierarchyGraph(md);
3082       // MethodSummary prevMethodSummary = getMethodSummary(md);
3083
3084       if (!hierarchyGraph.equals(prevHierarchyGraph)) {
3085
3086         mapDescriptorToHierarchyGraph.put(md, hierarchyGraph);
3087         // mapDescToLocationSummary.put(md, methodSummary);
3088
3089         // results for callee changed, so enqueue dependents caller for
3090         // further analysis
3091         Iterator<MethodDescriptor> depsItr = ssjava.getDependents(md).iterator();
3092         while (depsItr.hasNext()) {
3093           MethodDescriptor methodNext = depsItr.next();
3094           if (!methodDescriptorsToVisitStack.contains(methodNext)
3095               && methodDescriptorToVistSet.contains(methodNext)) {
3096             methodDescriptorsToVisitStack.add(methodNext);
3097           }
3098         }
3099
3100       }
3101
3102     }
3103
3104     setupToAnalyze();
3105     while (!toAnalyzeIsEmpty()) {
3106       ClassDescriptor cd = toAnalyzeNext();
3107       HierarchyGraph graph = getHierarchyGraph(cd);
3108       for (Iterator iter = cd.getFields(); iter.hasNext();) {
3109         FieldDescriptor fieldDesc = (FieldDescriptor) iter.next();
3110         if (!(fieldDesc.isStatic() && fieldDesc.isFinal())) {
3111           graph.getHNode(fieldDesc);
3112         }
3113       }
3114     }
3115
3116     Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
3117     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
3118       Descriptor key = (Descriptor) iterator.next();
3119       HierarchyGraph graph = getHierarchyGraph(key);
3120
3121       Set<HNode> nodeToBeConnected = new HashSet<HNode>();
3122       for (Iterator iterator2 = graph.getNodeSet().iterator(); iterator2.hasNext();) {
3123         HNode node = (HNode) iterator2.next();
3124         if (!node.isSkeleton() && !node.isCombinationNode()) {
3125           if (graph.getIncomingNodeSet(node).size() == 0) {
3126             nodeToBeConnected.add(node);
3127           }
3128         }
3129       }
3130
3131       for (Iterator iterator2 = nodeToBeConnected.iterator(); iterator2.hasNext();) {
3132         HNode node = (HNode) iterator2.next();
3133         // System.out.println("NEED TO BE CONNECTED TO TOP=" + node);
3134         graph.addEdge(graph.getHNode(TOPDESC), node);
3135       }
3136
3137     }
3138
3139   }
3140
3141   private HierarchyGraph getHierarchyGraph(Descriptor d) {
3142     if (!mapDescriptorToHierarchyGraph.containsKey(d)) {
3143       mapDescriptorToHierarchyGraph.put(d, new HierarchyGraph(d));
3144     }
3145     return mapDescriptorToHierarchyGraph.get(d);
3146   }
3147
3148   private void constructHierarchyGraph(MethodDescriptor md, HierarchyGraph methodGraph) {
3149
3150     // visit each node of method flow graph
3151     FlowGraph fg = getFlowGraph(md);
3152     // Set<FlowNode> nodeSet = fg.getNodeSet();
3153
3154     Set<FlowEdge> edgeSet = fg.getEdgeSet();
3155
3156     Set<Descriptor> paramDescSet = fg.getMapParamDescToIdx().keySet();
3157     for (Iterator iterator = paramDescSet.iterator(); iterator.hasNext();) {
3158       Descriptor desc = (Descriptor) iterator.next();
3159       methodGraph.getHNode(desc).setSkeleton(true);
3160     }
3161
3162     // for the method lattice, we need to look at the first element of
3163     // NTuple<Descriptor>
3164     boolean hasGlobalAccess = false;
3165     // for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
3166     // FlowNode originalSrcNode = (FlowNode) iterator.next();
3167     for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) {
3168       FlowEdge edge = (FlowEdge) iterator.next();
3169
3170       FlowNode originalSrcNode = fg.getFlowNode(edge.getInitTuple());
3171       Set<FlowNode> sourceNodeSet = new HashSet<FlowNode>();
3172       if (originalSrcNode instanceof FlowReturnNode) {
3173         FlowReturnNode rnode = (FlowReturnNode) originalSrcNode;
3174         // System.out.println("rnode=" + rnode);
3175         Set<NTuple<Descriptor>> tupleSet = rnode.getReturnTupleSet();
3176         for (Iterator iterator2 = tupleSet.iterator(); iterator2.hasNext();) {
3177           NTuple<Descriptor> nTuple = (NTuple<Descriptor>) iterator2.next();
3178           sourceNodeSet.add(fg.getFlowNode(nTuple));
3179           // System.out.println("&&&SOURCE fg.getFlowNode(nTuple)=" + fg.getFlowNode(nTuple));
3180         }
3181       } else {
3182         sourceNodeSet.add(originalSrcNode);
3183       }
3184
3185       // System.out.println("---sourceNodeSet=" + sourceNodeSet + "  from originalSrcNode="
3186       // + originalSrcNode);
3187
3188       for (Iterator iterator3 = sourceNodeSet.iterator(); iterator3.hasNext();) {
3189         FlowNode srcNode = (FlowNode) iterator3.next();
3190
3191         NTuple<Descriptor> srcNodeTuple = srcNode.getDescTuple();
3192         Descriptor srcLocalDesc = srcNodeTuple.get(0);
3193
3194         if (srcLocalDesc instanceof InterDescriptor
3195             && ((InterDescriptor) srcLocalDesc).getMethodArgIdxPair() != null) {
3196
3197           if (srcNode.getCompositeLocation() == null) {
3198             continue;
3199           }
3200         }
3201
3202         // if the srcNode is started with the global descriptor
3203         // need to set as a skeleton node
3204         if (!hasGlobalAccess && srcNode.getDescTuple().startsWith(GLOBALDESC)) {
3205           hasGlobalAccess = true;
3206         }
3207
3208         // Set<FlowEdge> outEdgeSet = fg.getOutEdgeSet(originalSrcNode);
3209         // for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) {
3210         // FlowEdge outEdge = (FlowEdge) iterator2.next();
3211         // FlowNode originalDstNode = outEdge.getDst();
3212         FlowNode originalDstNode = fg.getFlowNode(edge.getEndTuple());
3213
3214         Set<FlowNode> dstNodeSet = new HashSet<FlowNode>();
3215         if (originalDstNode instanceof FlowReturnNode) {
3216           FlowReturnNode rnode = (FlowReturnNode) originalDstNode;
3217           // System.out.println("\n-returnNode=" + rnode);
3218           Set<NTuple<Descriptor>> tupleSet = rnode.getReturnTupleSet();
3219           for (Iterator iterator4 = tupleSet.iterator(); iterator4.hasNext();) {
3220             NTuple<Descriptor> nTuple = (NTuple<Descriptor>) iterator4.next();
3221             dstNodeSet.add(fg.getFlowNode(nTuple));
3222             // System.out.println("&&&DST fg.getFlowNode(nTuple)=" + fg.getFlowNode(nTuple));
3223           }
3224         } else {
3225           dstNodeSet.add(originalDstNode);
3226         }
3227         // System.out.println("---dstNodeSet=" + dstNodeSet);
3228         for (Iterator iterator4 = dstNodeSet.iterator(); iterator4.hasNext();) {
3229           FlowNode dstNode = (FlowNode) iterator4.next();
3230
3231           NTuple<Descriptor> dstNodeTuple = dstNode.getDescTuple();
3232           Descriptor dstLocalDesc = dstNodeTuple.get(0);
3233
3234           if (dstLocalDesc instanceof InterDescriptor
3235               && ((InterDescriptor) dstLocalDesc).getMethodArgIdxPair() != null) {
3236             if (dstNode.getCompositeLocation() == null) {
3237               // System.out.println("%%%%%%%%%%%%%SKIP=" + dstNode);
3238               continue;
3239             }
3240           }
3241
3242           // if (outEdge.getInitTuple().equals(srcNodeTuple)
3243           // && outEdge.getEndTuple().equals(dstNodeTuple)) {
3244
3245           NTuple<Descriptor> srcCurTuple = srcNode.getCurrentDescTuple();
3246           NTuple<Descriptor> dstCurTuple = dstNode.getCurrentDescTuple();
3247
3248           // //////////////////////////
3249           // inheritance check
3250           if (mapMethodDescToHighestOverriddenMethodDesc.containsKey(md)) {
3251
3252             MethodDescriptor highestOverriddenMethodDesc =
3253                 mapMethodDescToHighestOverriddenMethodDesc.get(md);
3254
3255             if (srcCurTuple.get(srcCurTuple.size() - 1).getSymbol().startsWith(PCLOC)) {
3256             }
3257
3258           }
3259           // //////////////////////////
3260
3261           // System.out.println("-srcCurTuple=" + srcCurTuple + "  dstCurTuple=" + dstCurTuple
3262           // + "  srcNode=" + srcNode + "   dstNode=" + dstNode);
3263
3264           // srcCurTuple = translateBaseTuple(srcNode, srcCurTuple);
3265           // dstCurTuple = translateBaseTuple(dstNode, dstCurTuple);
3266
3267           if ((srcCurTuple.size() > 1 && dstCurTuple.size() > 1)
3268               && srcCurTuple.get(0).equals(dstCurTuple.get(0))) {
3269
3270             // value flows between fields
3271             Descriptor desc = srcCurTuple.get(0);
3272             ClassDescriptor classDesc;
3273
3274             if (desc.equals(GLOBALDESC)) {
3275               classDesc = md.getClassDesc();
3276             } else {
3277               VarDescriptor varDesc = (VarDescriptor) srcCurTuple.get(0);
3278               classDesc = varDesc.getType().getClassDesc();
3279             }
3280             extractFlowsBetweenFields(classDesc, srcNode, dstNode, 1);
3281
3282           } else if ((srcCurTuple.size() == 1 && dstCurTuple.size() == 1)
3283               || ((srcCurTuple.size() > 1 || dstCurTuple.size() > 1) && !srcCurTuple.get(0).equals(
3284                   dstCurTuple.get(0)))) {
3285
3286             // value flow between a primitive local var - a primitive local var or local var -
3287             // field
3288
3289             Descriptor srcDesc = srcCurTuple.get(0);
3290             Descriptor dstDesc = dstCurTuple.get(0);
3291
3292             methodGraph.addEdge(srcDesc, dstDesc);
3293
3294             if (fg.isParamDesc(srcDesc)) {
3295               methodGraph.setParamHNode(srcDesc);
3296             }
3297             if (fg.isParamDesc(dstDesc)) {
3298               methodGraph.setParamHNode(dstDesc);
3299             }
3300
3301           }
3302
3303           // }
3304           // }
3305
3306         }
3307
3308       }
3309
3310     }
3311
3312     // If the method accesses static fields
3313     // set hasGloabalAccess true in the method summary.
3314     if (hasGlobalAccess) {
3315       getMethodSummary(md).setHasGlobalAccess();
3316     }
3317     methodGraph.getHNode(GLOBALDESC).setSkeleton(true);
3318
3319     if (ssjava.getMethodContainingSSJavaLoop().equals(md)) {
3320       // if the current method contains the event loop
3321       // we need to set all nodes of the hierarchy graph as a skeleton node
3322       Set<HNode> hnodeSet = methodGraph.getNodeSet();
3323       for (Iterator iterator = hnodeSet.iterator(); iterator.hasNext();) {
3324         HNode hnode = (HNode) iterator.next();
3325         hnode.setSkeleton(true);
3326       }
3327     }
3328
3329   }
3330
3331   private NTuple<Descriptor> translateBaseTuple(FlowNode flowNode, NTuple<Descriptor> inTuple) {
3332
3333     if (flowNode.getBaseTuple() != null) {
3334
3335       NTuple<Descriptor> translatedTuple = new NTuple<Descriptor>();
3336
3337       NTuple<Descriptor> baseTuple = flowNode.getBaseTuple();
3338
3339       for (int i = 0; i < baseTuple.size(); i++) {
3340         translatedTuple.add(baseTuple.get(i));
3341       }
3342
3343       for (int i = 1; i < inTuple.size(); i++) {
3344         translatedTuple.add(inTuple.get(i));
3345       }
3346
3347       // System.out.println("------TRANSLATED " + inTuple + " -> " + translatedTuple);
3348       return translatedTuple;
3349
3350     } else {
3351       return inTuple;
3352     }
3353
3354   }
3355
3356   private MethodSummary getMethodSummary(MethodDescriptor md) {
3357     if (!mapDescToLocationSummary.containsKey(md)) {
3358       mapDescToLocationSummary.put(md, new MethodSummary(md));
3359     }
3360     return (MethodSummary) mapDescToLocationSummary.get(md);
3361   }
3362
3363   private void addMapClassDefinitionToLineNum(ClassDescriptor cd, String strLine, int lineNum) {
3364
3365     String classSymbol = cd.getSymbol();
3366     int idx = classSymbol.lastIndexOf("$");
3367     if (idx != -1) {
3368       classSymbol = classSymbol.substring(idx + 1);
3369     }
3370
3371     String pattern = "class " + classSymbol + " ";
3372     if (strLine.indexOf(pattern) != -1) {
3373       mapDescToDefinitionLine.put(cd, lineNum);
3374     }
3375   }
3376
3377   private void addMapMethodDefinitionToLineNum(Set<MethodDescriptor> methodSet, String strLine,
3378       int lineNum) {
3379     for (Iterator iterator = methodSet.iterator(); iterator.hasNext();) {
3380       MethodDescriptor md = (MethodDescriptor) iterator.next();
3381       String pattern = md.getMethodDeclaration();
3382       if (strLine.indexOf(pattern) != -1) {
3383         mapDescToDefinitionLine.put(md, lineNum);
3384         methodSet.remove(md);
3385         return;
3386       }
3387     }
3388
3389   }
3390
3391   private void readOriginalSourceFiles() {
3392
3393     SymbolTable classtable = state.getClassSymbolTable();
3394
3395     Set<ClassDescriptor> classDescSet = new HashSet<ClassDescriptor>();
3396     classDescSet.addAll(classtable.getValueSet());
3397
3398     try {
3399       // inefficient implement. it may re-visit the same file if the file
3400       // contains more than one class definitions.
3401       for (Iterator iterator = classDescSet.iterator(); iterator.hasNext();) {
3402         ClassDescriptor cd = (ClassDescriptor) iterator.next();
3403
3404         Set<MethodDescriptor> methodSet = new HashSet<MethodDescriptor>();
3405         methodSet.addAll(cd.getMethodTable().getValueSet());
3406
3407         String sourceFileName = cd.getSourceFileName();
3408         Vector<String> lineVec = new Vector<String>();
3409
3410         mapFileNameToLineVector.put(sourceFileName, lineVec);
3411
3412         BufferedReader in = new BufferedReader(new FileReader(sourceFileName));
3413         String strLine;
3414         int lineNum = 1;
3415         lineVec.add(""); // the index is started from 1.
3416         while ((strLine = in.readLine()) != null) {
3417           lineVec.add(lineNum, strLine);
3418           addMapClassDefinitionToLineNum(cd, strLine, lineNum);
3419           addMapMethodDefinitionToLineNum(methodSet, strLine, lineNum);
3420           lineNum++;
3421         }
3422
3423       }
3424
3425     } catch (IOException e) {
3426       e.printStackTrace();
3427     }
3428
3429   }
3430
3431   private String generateLatticeDefinition(Descriptor desc) {
3432
3433     Set<String> sharedLocSet = new HashSet<String>();
3434
3435     SSJavaLattice<String> lattice = getLattice(desc);
3436     String rtr = "@LATTICE(\"";
3437
3438     Map<String, Set<String>> map = lattice.getTable();
3439     Set<String> keySet = map.keySet();
3440
3441     // System.out.println("@generateLatticeDefinition=" + desc + "      map=" + map);
3442
3443     boolean first = true;
3444     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
3445       String key = (String) iterator.next();
3446       if (!key.equals(lattice.getTopItem())) {
3447         Set<String> connectedSet = map.get(key);
3448
3449         if (connectedSet.size() == 1) {
3450           if (connectedSet.iterator().next().equals(lattice.getBottomItem())) {
3451             if (!first) {
3452               rtr += ",";
3453             } else {
3454               rtr += "LOC,";
3455               first = false;
3456             }
3457             rtr += key;
3458             if (lattice.isSharedLoc(key)) {
3459               rtr += "," + key + "*";
3460             }
3461           }
3462         }
3463
3464         for (Iterator iterator2 = connectedSet.iterator(); iterator2.hasNext();) {
3465           String loc = (String) iterator2.next();
3466           if (!loc.equals(lattice.getBottomItem())) {
3467             if (!first) {
3468               rtr += ",";
3469             } else {
3470               rtr += "LOC,";
3471               first = false;
3472             }
3473             rtr += loc + "<" + key;
3474             if (lattice.isSharedLoc(key) && (!sharedLocSet.contains(key))) {
3475               rtr += "," + key + "*";
3476               sharedLocSet.add(key);
3477             }
3478             if (lattice.isSharedLoc(loc) && (!sharedLocSet.contains(loc))) {
3479               rtr += "," + loc + "*";
3480               sharedLocSet.add(loc);
3481             }
3482
3483           }
3484         }
3485       }
3486     }
3487
3488     if (desc instanceof MethodDescriptor) {
3489       // System.out.println("#EXTRA LOC DECLARATION GEN=" + desc);
3490
3491       MethodDescriptor md = (MethodDescriptor) desc;
3492       MethodSummary methodSummary = getMethodSummary(md);
3493
3494       TypeDescriptor returnType = ((MethodDescriptor) desc).getReturnType();
3495       if (!ssjava.getMethodContainingSSJavaLoop().equals(desc) && returnType != null
3496           && (!returnType.isVoid())) {
3497         CompositeLocation returnLoc = methodSummary.getRETURNLoc();
3498         if (returnLoc.getSize() == 1) {
3499           String returnLocStr = generateLocationAnnoatation(methodSummary.getRETURNLoc());
3500           if (rtr.indexOf(returnLocStr) == -1) {
3501             rtr += "," + returnLocStr;
3502           }
3503         }
3504       }
3505       rtr += "\")";
3506
3507       if (!ssjava.getMethodContainingSSJavaLoop().equals(desc)) {
3508         if (returnType != null && (!returnType.isVoid())) {
3509           rtr +=
3510               "\n@RETURNLOC(\"" + generateLocationAnnoatation(methodSummary.getRETURNLoc()) + "\")";
3511         }
3512
3513         CompositeLocation pcLoc = methodSummary.getPCLoc();
3514         if ((pcLoc != null) && (!pcLoc.get(0).isTop())) {
3515           rtr += "\n@PCLOC(\"" + generateLocationAnnoatation(pcLoc) + "\")";
3516         }
3517       }
3518
3519       if (!md.isStatic()) {
3520         rtr += "\n@THISLOC(\"" + methodSummary.getThisLocName() + "\")";
3521       }
3522       rtr += "\n@GLOBALLOC(\"" + methodSummary.getGlobalLocName() + "\")";
3523
3524     } else {
3525       rtr += "\")";
3526     }
3527
3528     return rtr;
3529   }
3530
3531   private void generateAnnoatedCode() {
3532
3533     readOriginalSourceFiles();
3534
3535     setupToAnalyze();
3536     while (!toAnalyzeIsEmpty()) {
3537       ClassDescriptor cd = toAnalyzeNext();
3538
3539       setupToAnalazeMethod(cd);
3540
3541       String sourceFileName = cd.getSourceFileName();
3542
3543       if (cd.isInterface()) {
3544         continue;
3545       }
3546
3547       int classDefLine = mapDescToDefinitionLine.get(cd);
3548       Vector<String> sourceVec = mapFileNameToLineVector.get(sourceFileName);
3549
3550       LocationSummary fieldLocSummary = getLocationSummary(cd);
3551
3552       String fieldLatticeDefStr = generateLatticeDefinition(cd);
3553       String annoatedSrc = fieldLatticeDefStr + newline + sourceVec.get(classDefLine);
3554       sourceVec.set(classDefLine, annoatedSrc);
3555
3556       // generate annotations for field declarations
3557       // Map<Descriptor, CompositeLocation> inferLocMap = fieldLocInfo.getMapDescToInferLocation();
3558       Map<String, String> mapFieldNameToLocName = fieldLocSummary.getMapHNodeNameToLocationName();
3559
3560       for (Iterator iter = cd.getFields(); iter.hasNext();) {
3561         FieldDescriptor fd = (FieldDescriptor) iter.next();
3562
3563         String locAnnotationStr;
3564         // CompositeLocation inferLoc = inferLocMap.get(fd);
3565         String locName = mapFieldNameToLocName.get(fd.getSymbol());
3566
3567         if (locName != null) {
3568           // infer loc is null if the corresponding field is static and final
3569           // locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
3570           locAnnotationStr = "@LOC(\"" + locName + "\")";
3571           int fdLineNum = fd.getLineNum();
3572           String orgFieldDeclarationStr = sourceVec.get(fdLineNum);
3573           String fieldDeclaration = fd.toString();
3574           fieldDeclaration = fieldDeclaration.substring(0, fieldDeclaration.length() - 1);
3575           String annoatedStr = locAnnotationStr + " " + orgFieldDeclarationStr;
3576           sourceVec.set(fdLineNum, annoatedStr);
3577         }
3578
3579       }
3580
3581       while (!toAnalyzeMethodIsEmpty()) {
3582         MethodDescriptor md = toAnalyzeMethodNext();
3583
3584         if (!ssjava.needTobeAnnotated(md)) {
3585           continue;
3586         }
3587
3588         SSJavaLattice<String> methodLattice = md2lattice.get(md);
3589         // System.out.println("md=" + md + " methodLattice=" + methodLattice);
3590         if (methodLattice != null) {
3591
3592           int methodDefLine = md.getLineNum();
3593
3594           // MethodLocationInfo methodLocInfo = getMethodLocationInfo(md);
3595           // Map<Descriptor, CompositeLocation> methodInferLocMap =
3596           // methodLocInfo.getMapDescToInferLocation();
3597
3598           MethodSummary methodSummary = getMethodSummary(md);
3599
3600           Map<Descriptor, CompositeLocation> mapVarDescToInferLoc =
3601               methodSummary.getMapVarDescToInferCompositeLocation();
3602           // System.out.println("-----md=" + md + " methodDefLine=" + methodDefLine);
3603           // System.out.println("-----mapVarDescToInferLoc=" + mapVarDescToInferLoc);
3604
3605           Set<Descriptor> localVarDescSet = mapVarDescToInferLoc.keySet();
3606
3607           Set<String> localLocElementSet = methodLattice.getElementSet();
3608
3609           for (Iterator iterator = localVarDescSet.iterator(); iterator.hasNext();) {
3610             Descriptor localVarDesc = (Descriptor) iterator.next();
3611             // System.out.println("-------localVarDesc=" + localVarDesc);
3612             CompositeLocation inferLoc = mapVarDescToInferLoc.get(localVarDesc);
3613
3614             String localLocIdentifier = inferLoc.get(0).getLocIdentifier();
3615             if (!localLocElementSet.contains(localLocIdentifier)) {
3616               methodLattice.put(localLocIdentifier);
3617             }
3618
3619             String locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
3620
3621             if (!isParameter(md, localVarDesc)) {
3622               if (mapDescToDefinitionLine.containsKey(localVarDesc)) {
3623                 int varLineNum = mapDescToDefinitionLine.get(localVarDesc);
3624                 String orgSourceLine = sourceVec.get(varLineNum);
3625                 // System.out.println("varLineNum=" + varLineNum + "  org src=" + orgSourceLine);
3626                 int idx =
3627                     orgSourceLine.indexOf(generateVarDeclaration((VarDescriptor) localVarDesc));
3628                 // System.out.println("idx=" + idx
3629                 // + "  generateVarDeclaration((VarDescriptor) localVarDesc)="
3630                 // + generateVarDeclaration((VarDescriptor) localVarDesc));
3631                 assert (idx != -1);
3632                 String annoatedStr =
3633                     orgSourceLine.substring(0, idx) + locAnnotationStr + " "
3634                         + orgSourceLine.substring(idx);
3635                 sourceVec.set(varLineNum, annoatedStr);
3636               }
3637             } else {
3638               String methodDefStr = sourceVec.get(methodDefLine);
3639
3640               int idx =
3641                   getParamLocation(methodDefStr,
3642                       generateVarDeclaration((VarDescriptor) localVarDesc));
3643               // System.out.println("methodDefStr=" + methodDefStr + " localVarDesc=" + localVarDesc
3644               // + " idx=" + idx);
3645               assert (idx != -1);
3646
3647               String annoatedStr =
3648                   methodDefStr.substring(0, idx) + locAnnotationStr + " "
3649                       + methodDefStr.substring(idx);
3650               sourceVec.set(methodDefLine, annoatedStr);
3651             }
3652
3653           }
3654
3655           // check if the lattice has to have the location type for the this
3656           // reference...
3657
3658           // boolean needToAddthisRef = hasThisReference(md);
3659           // if (localLocElementSet.contains("this")) {
3660           // methodLattice.put("this");
3661           // }
3662
3663           String methodLatticeDefStr = generateLatticeDefinition(md);
3664           String annoatedStr = methodLatticeDefStr + newline + sourceVec.get(methodDefLine);
3665           sourceVec.set(methodDefLine, annoatedStr);
3666
3667         }
3668       }
3669
3670     }
3671
3672     codeGen();
3673   }
3674
3675   private boolean hasThisReference(MethodDescriptor md) {
3676
3677     FlowGraph fg = getFlowGraph(md);
3678     Set<FlowNode> nodeSet = fg.getNodeSet();
3679     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
3680       FlowNode flowNode = (FlowNode) iterator.next();
3681       if (flowNode.getDescTuple().get(0).equals(md.getThis())) {
3682         return true;
3683       }
3684     }
3685
3686     return false;
3687   }
3688
3689   private int getParamLocation(String methodStr, String paramStr) {
3690
3691     String pattern = paramStr + ",";
3692
3693     int idx = methodStr.indexOf(pattern);
3694     if (idx != -1) {
3695       return idx;
3696     } else {
3697       pattern = paramStr + ")";
3698       return methodStr.indexOf(pattern);
3699     }
3700
3701   }
3702
3703   private String generateVarDeclaration(VarDescriptor varDesc) {
3704
3705     TypeDescriptor td = varDesc.getType();
3706     String rtr = td.toString();
3707     if (td.isArray()) {
3708       for (int i = 0; i < td.getArrayCount(); i++) {
3709         rtr += "[]";
3710       }
3711     }
3712     rtr += " " + varDesc.getName();
3713     return rtr;
3714
3715   }
3716
3717   private String generateLocationAnnoatation(CompositeLocation loc) {
3718     String rtr = "";
3719     // method location
3720     Location methodLoc = loc.get(0);
3721     rtr += methodLoc.getLocIdentifier();
3722
3723     for (int i = 1; i < loc.getSize(); i++) {
3724       Location element = loc.get(i);
3725       rtr += "," + element.getDescriptor().getSymbol() + "." + element.getLocIdentifier();
3726     }
3727
3728     return rtr;
3729   }
3730
3731   private boolean isParameter(MethodDescriptor md, Descriptor localVarDesc) {
3732     return getFlowGraph(md).isParamDesc(localVarDesc);
3733   }
3734
3735   private String extractFileName(String fileName) {
3736     int idx = fileName.lastIndexOf("/");
3737     if (idx == -1) {
3738       return fileName;
3739     } else {
3740       return fileName.substring(idx + 1);
3741     }
3742
3743   }
3744
3745   private void codeGen() {
3746
3747     Set<String> originalFileNameSet = mapFileNameToLineVector.keySet();
3748     for (Iterator iterator = originalFileNameSet.iterator(); iterator.hasNext();) {
3749       String orgFileName = (String) iterator.next();
3750       String outputFileName = extractFileName(orgFileName);
3751
3752       Vector<String> sourceVec = mapFileNameToLineVector.get(orgFileName);
3753
3754       try {
3755
3756         FileWriter fileWriter = new FileWriter("./infer/" + outputFileName);
3757         BufferedWriter out = new BufferedWriter(fileWriter);
3758
3759         for (int i = 0; i < sourceVec.size(); i++) {
3760           out.write(sourceVec.get(i));
3761           out.newLine();
3762         }
3763         out.close();
3764       } catch (IOException e) {
3765         e.printStackTrace();
3766       }
3767
3768     }
3769
3770   }
3771
3772   private void checkLattices() {
3773
3774     LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
3775
3776     // current descriptors to visit in fixed-point interprocedural analysis,
3777     // prioritized by
3778     // dependency in the call graph
3779     methodDescriptorsToVisitStack.clear();
3780
3781     // descriptorListToAnalyze.removeFirst();
3782
3783     Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
3784     methodDescriptorToVistSet.addAll(descriptorListToAnalyze);
3785
3786     while (!descriptorListToAnalyze.isEmpty()) {
3787       MethodDescriptor md = descriptorListToAnalyze.removeFirst();
3788       checkLatticesOfVirtualMethods(md);
3789     }
3790
3791   }
3792
3793   private void debug_writeLatticeDotFile() {
3794     // generate lattice dot file
3795
3796     setupToAnalyze();
3797
3798     while (!toAnalyzeIsEmpty()) {
3799       ClassDescriptor cd = toAnalyzeNext();
3800
3801       setupToAnalazeMethod(cd);
3802
3803       SSJavaLattice<String> classLattice = cd2lattice.get(cd);
3804       if (classLattice != null) {
3805         ssjava.writeLatticeDotFile(cd, null, classLattice);
3806         // debug_printDescriptorToLocNameMapping(cd);
3807       }
3808
3809       while (!toAnalyzeMethodIsEmpty()) {
3810         MethodDescriptor md = toAnalyzeMethodNext();
3811         SSJavaLattice<String> methodLattice = md2lattice.get(md);
3812         if (methodLattice != null) {
3813           ssjava.writeLatticeDotFile(cd, md, methodLattice);
3814           // debug_printDescriptorToLocNameMapping(md);
3815         }
3816       }
3817     }
3818
3819   }
3820
3821   private void debug_printDescriptorToLocNameMapping(Descriptor desc) {
3822
3823     LocationInfo info = getLocationInfo(desc);
3824     System.out.println("## " + desc + " ##");
3825     System.out.println(info.getMapDescToInferLocation());
3826     LocationInfo locInfo = getLocationInfo(desc);
3827     System.out.println("mapping=" + locInfo.getMapLocSymbolToDescSet());
3828     System.out.println("###################");
3829
3830   }
3831
3832   private void calculateExtraLocations() {
3833
3834     // LinkedList<MethodDescriptor> methodDescList = ssjava.getSortedDescriptors();
3835     LinkedList<MethodDescriptor> methodDescList =
3836         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
3837     for (Iterator iterator = methodDescList.iterator(); iterator.hasNext();) {
3838       MethodDescriptor md = (MethodDescriptor) iterator.next();
3839       if (!ssjava.getMethodContainingSSJavaLoop().equals(md)) {
3840         calculateExtraLocations(md);
3841       }
3842     }
3843
3844   }
3845
3846   private void checkLatticesOfVirtualMethods(MethodDescriptor md) {
3847
3848     if (!md.isStatic()) {
3849       Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
3850       setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md));
3851
3852       for (Iterator iterator = setPossibleCallees.iterator(); iterator.hasNext();) {
3853         MethodDescriptor mdCallee = (MethodDescriptor) iterator.next();
3854         if (!md.equals(mdCallee)) {
3855           checkConsistency(md, mdCallee);
3856         }
3857       }
3858
3859     }
3860
3861   }
3862
3863   private void checkConsistency(MethodDescriptor md1, MethodDescriptor md2) {
3864
3865     // check that two lattice have the same relations between parameters(+PC
3866     // LOC, GLOBAL_LOC RETURN LOC)
3867
3868     List<CompositeLocation> list1 = new ArrayList<CompositeLocation>();
3869     List<CompositeLocation> list2 = new ArrayList<CompositeLocation>();
3870
3871     MethodLocationInfo locInfo1 = getMethodLocationInfo(md1);
3872     MethodLocationInfo locInfo2 = getMethodLocationInfo(md2);
3873
3874     Map<Integer, CompositeLocation> paramMap1 = locInfo1.getMapParamIdxToInferLoc();
3875     Map<Integer, CompositeLocation> paramMap2 = locInfo2.getMapParamIdxToInferLoc();
3876
3877     int numParam = locInfo1.getMapParamIdxToInferLoc().keySet().size();
3878
3879     // add location types of paramters
3880     for (int idx = 0; idx < numParam; idx++) {
3881       list1.add(paramMap1.get(Integer.valueOf(idx)));
3882       list2.add(paramMap2.get(Integer.valueOf(idx)));
3883     }
3884
3885     // add program counter location
3886     list1.add(locInfo1.getPCLoc());
3887     list2.add(locInfo2.getPCLoc());
3888
3889     if (!md1.getReturnType().isVoid()) {
3890       // add return value location
3891       CompositeLocation rtrLoc1 = getMethodLocationInfo(md1).getReturnLoc();
3892       CompositeLocation rtrLoc2 = getMethodLocationInfo(md2).getReturnLoc();
3893       list1.add(rtrLoc1);
3894       list2.add(rtrLoc2);
3895     }
3896
3897     // add global location type
3898     if (md1.isStatic()) {
3899       CompositeLocation globalLoc1 =
3900           new CompositeLocation(new Location(md1, locInfo1.getGlobalLocName()));
3901       CompositeLocation globalLoc2 =
3902           new CompositeLocation(new Location(md2, locInfo2.getGlobalLocName()));
3903       list1.add(globalLoc1);
3904       list2.add(globalLoc2);
3905     }
3906
3907     for (int i = 0; i < list1.size(); i++) {
3908       CompositeLocation locA1 = list1.get(i);
3909       CompositeLocation locA2 = list2.get(i);
3910       for (int k = 0; k < list1.size(); k++) {
3911         if (i != k) {
3912           CompositeLocation locB1 = list1.get(k);
3913           CompositeLocation locB2 = list2.get(k);
3914           boolean r1 = isGreaterThan(getLattice(md1), locA1, locB1);
3915
3916           boolean r2 = isGreaterThan(getLattice(md1), locA2, locB2);
3917
3918           if (r1 != r2) {
3919             throw new Error("The method " + md1 + " is not consistent with the method " + md2
3920                 + ".:: They have a different ordering relation between locations (" + locA1 + ","
3921                 + locB1 + ") and (" + locA2 + "," + locB2 + ").");
3922           }
3923         }
3924       }
3925     }
3926
3927   }
3928
3929   private String getSymbol(int idx, FlowNode node) {
3930     Descriptor desc = node.getDescTuple().get(idx);
3931     return desc.getSymbol();
3932   }
3933
3934   private Descriptor getDescriptor(int idx, FlowNode node) {
3935     Descriptor desc = node.getDescTuple().get(idx);
3936     return desc;
3937   }
3938
3939   private void calculatePCLOC(MethodDescriptor md) {
3940
3941     // System.out.println("#CalculatePCLOC");
3942     MethodSummary methodSummary = getMethodSummary(md);
3943     FlowGraph fg = getFlowGraph(md);
3944     Map<Integer, CompositeLocation> mapParamToLoc = methodSummary.getMapParamIdxToInferLoc();
3945
3946     // calculate the initial program counter location
3947     // PC location is higher than location types of parameters which has incoming flows.
3948
3949     Set<NTuple<Location>> paramLocTupleHavingInFlowSet = new HashSet<NTuple<Location>>();
3950     Set<Descriptor> paramDescNOTHavingInFlowSet = new HashSet<Descriptor>();
3951     // Set<FlowNode> paramNodeNOThavingInFlowSet = new HashSet<FlowNode>();
3952
3953     int numParams = fg.getNumParameters();
3954     for (int i = 0; i < numParams; i++) {
3955       FlowNode paramFlowNode = fg.getParamFlowNode(i);
3956       Descriptor prefix = paramFlowNode.getDescTuple().get(0);
3957       NTuple<Descriptor> paramDescTuple = paramFlowNode.getCurrentDescTuple();
3958       NTuple<Location> paramLocTuple = translateToLocTuple(md, paramDescTuple);
3959
3960       Set<FlowNode> inNodeToParamSet = fg.getIncomingNodeSetByPrefix(prefix);
3961       if (inNodeToParamSet.size() > 0) {
3962         // parameter has in-value flows
3963
3964         for (Iterator iterator = inNodeToParamSet.iterator(); iterator.hasNext();) {
3965           FlowNode inNode = (FlowNode) iterator.next();
3966           Set<FlowEdge> outEdgeSet = fg.getOutEdgeSet(inNode);
3967           for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) {
3968             FlowEdge flowEdge = (FlowEdge) iterator2.next();
3969             if (flowEdge.getEndTuple().startsWith(prefix)) {
3970               NTuple<Location> paramLocTupleWithIncomingFlow =
3971                   translateToLocTuple(md, flowEdge.getEndTuple());
3972               paramLocTupleHavingInFlowSet.add(paramLocTupleWithIncomingFlow);
3973             }
3974           }
3975         }
3976
3977         // paramLocTupleHavingInFlowSet.add(paramLocTuple);
3978       } else {
3979         // paramNodeNOThavingInFlowSet.add(fg.getFlowNode(paramDescTuple));
3980         paramDescNOTHavingInFlowSet.add(prefix);
3981       }
3982     }
3983
3984     // System.out.println("paramLocTupleHavingInFlowSet=" + paramLocTupleHavingInFlowSet);
3985
3986     if (paramLocTupleHavingInFlowSet.size() > 0
3987         && !coversAllParamters(md, fg, paramLocTupleHavingInFlowSet)) {
3988
3989       // Here, generates a location in the method lattice that is higher than the
3990       // paramLocTupleHavingInFlowSet
3991       NTuple<Location> pcLocTuple =
3992           generateLocTupleRelativeTo(md, paramLocTupleHavingInFlowSet, PCLOC);
3993
3994       NTuple<Descriptor> pcDescTuple = translateToDescTuple(pcLocTuple);
3995
3996       // System.out.println("pcLoc=" + pcLocTuple);
3997
3998       CompositeLocation curPCLoc = methodSummary.getPCLoc();
3999       if (curPCLoc.get(0).isTop() || pcLocTuple.size() > curPCLoc.getSize()) {
4000         methodSummary.setPCLoc(new CompositeLocation(pcLocTuple));
4001
4002         Set<FlowNode> flowNodeLowerthanPCLocSet = new HashSet<FlowNode>();
4003         GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
4004         // add ordering relations s.t. PCLOC is higher than all flow nodes except the set of
4005         // parameters that do not have incoming flows
4006         for (Iterator iterator = fg.getNodeSet().iterator(); iterator.hasNext();) {
4007           FlowNode node = (FlowNode) iterator.next();
4008
4009           if (!(node instanceof FlowReturnNode)) {
4010             if (!paramDescNOTHavingInFlowSet.contains(node.getCurrentDescTuple().get(0))) {
4011               flowNodeLowerthanPCLocSet.add(node);
4012               fg.addValueFlowEdge(pcDescTuple, node.getDescTuple());
4013
4014               subGlobalFlowGraph.addValueFlowEdge(pcLocTuple,
4015                   translateToLocTuple(md, node.getDescTuple()));
4016             }
4017           } else {
4018             // System.out.println("***SKIP PCLOC -> RETURNLOC=" + node);
4019           }
4020
4021         }
4022         fg.getFlowNode(translateToDescTuple(pcLocTuple)).setSkeleton(true);
4023
4024         if (pcLocTuple.get(0).getLocDescriptor().equals(md.getThis())) {
4025           for (Iterator iterator = flowNodeLowerthanPCLocSet.iterator(); iterator.hasNext();) {
4026             FlowNode lowerNode = (FlowNode) iterator.next();
4027             if (lowerNode.getDescTuple().size() == 1 && lowerNode.getCompositeLocation() == null) {
4028               NTuple<Location> lowerLocTuple = translateToLocTuple(md, lowerNode.getDescTuple());
4029               CompositeLocation newComp =
4030                   calculateCompositeLocationFromSubGlobalGraph(md, lowerNode);
4031               if (newComp != null) {
4032                 subGlobalFlowGraph.addMapLocationToInferCompositeLocation(lowerLocTuple.get(0),
4033                     newComp);
4034                 lowerNode.setCompositeLocation(newComp);
4035                 // System.out.println("NEW COMP LOC=" + newComp + "    to lowerNode=" + lowerNode);
4036               }
4037
4038             }
4039
4040           }
4041         }
4042
4043       }
4044
4045     }
4046   }
4047
4048   private int countFirstDescriptorSetSize(Set<NTuple<Location>> set) {
4049
4050     Set<Descriptor> descSet = new HashSet<Descriptor>();
4051
4052     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
4053       NTuple<Location> locTuple = (NTuple<Location>) iterator.next();
4054       descSet.add(locTuple.get(0).getLocDescriptor());
4055     }
4056
4057     return descSet.size();
4058   }
4059
4060   private boolean coversAllParamters(MethodDescriptor md, FlowGraph fg,
4061       Set<NTuple<Location>> paramLocTupleHavingInFlowSet) {
4062
4063     int numParam = fg.getNumParameters();
4064     // int size = paramLocTupleHavingInFlowSet.size();
4065     int size = countFirstDescriptorSetSize(paramLocTupleHavingInFlowSet);
4066
4067     // System.out.println("numParam=" + numParam + "     size=" + size);
4068
4069     // if (!md.isStatic()) {
4070     //
4071     // // if the method is not static && there is a parameter composite location &&
4072     // // it is started with 'this',
4073     // // paramLocTupleHavingInFlowSet need to have 'this' parameter.
4074     //
4075     // FlowNode thisParamNode = fg.getParamFlowNode(0);
4076     // NTuple<Location> thisParamLocTuple =
4077     // translateToLocTuple(md, thisParamNode.getCurrentDescTuple());
4078     //
4079     // if (!paramLocTupleHavingInFlowSet.contains(thisParamLocTuple)) {
4080     //
4081     // for (Iterator iterator = paramLocTupleHavingInFlowSet.iterator(); iterator.hasNext();) {
4082     // NTuple<Location> paramTuple = (NTuple<Location>) iterator.next();
4083     // if (paramTuple.size() > 1 && paramTuple.get(0).getLocDescriptor().equals(md.getThis())) {
4084     // // paramLocTupleHavingInFlowSet.add(thisParamLocTuple);
4085     // // break;
4086     // size++;
4087     // }
4088     // }
4089     //
4090     // }
4091     // }
4092
4093     if (size == numParam) {
4094       return true;
4095     } else {
4096       return false;
4097     }
4098
4099   }
4100
4101   private void calculateRETURNLOC(MethodDescriptor md) {
4102
4103     // System.out.println("#calculateRETURNLOC= " + md);
4104
4105     // calculate a return location:
4106     // the return location type is lower than all parameters and the location of return values
4107     MethodSummary methodSummary = getMethodSummary(md);
4108     // if (methodSummary.getRETURNLoc() != null) {
4109     // System.out.println("$HERE?");
4110     // return;
4111     // }
4112
4113     FlowGraph fg = getFlowGraph(md);
4114     Map<Integer, CompositeLocation> mapParamToLoc = methodSummary.getMapParamIdxToInferLoc();
4115     Set<Integer> paramIdxSet = mapParamToLoc.keySet();
4116
4117     if (md.getReturnType() != null && !md.getReturnType().isVoid()) {
4118       // first, generate the set of return value location types that starts
4119       // with 'this' reference
4120
4121       Set<FlowNode> paramFlowNodeFlowingToReturnValueSet = getParamNodeFlowingToReturnValue(md);
4122       // System.out.println("paramFlowNodeFlowingToReturnValueSet="
4123       // + paramFlowNodeFlowingToReturnValueSet);
4124
4125       Set<NTuple<Location>> tupleToBeHigherThanReturnLocSet = new HashSet<NTuple<Location>>();
4126       for (Iterator iterator = paramFlowNodeFlowingToReturnValueSet.iterator(); iterator.hasNext();) {
4127         FlowNode fn = (FlowNode) iterator.next();
4128         NTuple<Descriptor> paramDescTuple = fn.getCurrentDescTuple();
4129         tupleToBeHigherThanReturnLocSet.add(translateToLocTuple(md, paramDescTuple));
4130       }
4131
4132       Set<FlowNode> returnNodeSet = fg.getReturnNodeSet();
4133       for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
4134         FlowNode returnNode = (FlowNode) iterator.next();
4135         NTuple<Descriptor> returnDescTuple = returnNode.getCurrentDescTuple();
4136         tupleToBeHigherThanReturnLocSet.add(translateToLocTuple(md, returnDescTuple));
4137       }
4138       // System.out.println("-flow graph's returnNodeSet=" + returnNodeSet);
4139       // System.out.println("tupleSetToBeHigherThanReturnLoc=" + tupleToBeHigherThanReturnLocSet);
4140
4141       // Here, generates a return location in the method lattice that is lower than the
4142       // locFlowingToReturnValueSet
4143       NTuple<Location> returnLocTuple =
4144           generateLocTupleRelativeTo(md, tupleToBeHigherThanReturnLocSet, RLOC);
4145
4146       // System.out.println("returnLocTuple=" + returnLocTuple);
4147       NTuple<Descriptor> returnDescTuple = translateToDescTuple(returnLocTuple);
4148       CompositeLocation curReturnLoc = methodSummary.getRETURNLoc();
4149       if (curReturnLoc == null || returnDescTuple.size() > curReturnLoc.getSize()) {
4150         methodSummary.setRETURNLoc(new CompositeLocation(returnLocTuple));
4151
4152         for (Iterator iterator = tupleToBeHigherThanReturnLocSet.iterator(); iterator.hasNext();) {
4153           NTuple<Location> higherTuple = (NTuple<Location>) iterator.next();
4154           fg.addValueFlowEdge(translateToDescTuple(higherTuple), returnDescTuple);
4155         }
4156         fg.getFlowNode(returnDescTuple).setSkeleton(true);
4157
4158       }
4159
4160       // makes sure that PCLOC is higher than RETURNLOC
4161       CompositeLocation pcLoc = methodSummary.getPCLoc();
4162       if (!pcLoc.get(0).isTop()) {
4163         NTuple<Descriptor> pcLocDescTuple = translateToDescTuple(pcLoc.getTuple());
4164         fg.addValueFlowEdge(pcLocDescTuple, returnDescTuple);
4165       }
4166
4167     }
4168
4169   }
4170
4171   private void calculateExtraLocations(MethodDescriptor md) {
4172     // calcualte pcloc, returnloc,...
4173
4174     System.out.println("\nSSJAVA:Calculate PCLOC/RETURNLOC locations: " + md);
4175
4176     calculatePCLOC(md);
4177     calculateRETURNLOC(md);
4178
4179   }
4180
4181   private NTuple<Location> generateLocTupleRelativeTo(MethodDescriptor md,
4182       Set<NTuple<Location>> paramLocTupleHavingInFlowSet, String locNamePrefix) {
4183
4184     // System.out.println("-generateLocTupleRelativeTo=" + paramLocTupleHavingInFlowSet);
4185
4186     NTuple<Location> higherLocTuple = new NTuple<Location>();
4187
4188     VarDescriptor thisVarDesc = md.getThis();
4189     // check if all paramter loc tuple is started with 'this' reference
4190     boolean hasParamNotStartedWithThisRef = false;
4191
4192     int minSize = 0;
4193
4194     Set<NTuple<Location>> paramLocTupleStartedWithThis = new HashSet<NTuple<Location>>();
4195
4196     next: for (Iterator iterator = paramLocTupleHavingInFlowSet.iterator(); iterator.hasNext();) {
4197       NTuple<Location> paramLocTuple = (NTuple<Location>) iterator.next();
4198       Descriptor paramLocalDesc = paramLocTuple.get(0).getLocDescriptor();
4199       if (!paramLocalDesc.equals(thisVarDesc)) {
4200
4201         Set<FlowNode> inNodeSet = getFlowGraph(md).getIncomingNodeSetByPrefix(paramLocalDesc);
4202         for (Iterator iterator2 = inNodeSet.iterator(); iterator2.hasNext();) {
4203           FlowNode flowNode = (FlowNode) iterator2.next();
4204           if (flowNode.getDescTuple().startsWith(thisVarDesc)) {
4205             // System.out.println("paramLocTuple=" + paramLocTuple + " is lower than THIS");
4206             continue next;
4207           }
4208         }
4209         hasParamNotStartedWithThisRef = true;
4210
4211       } else if (paramLocTuple.size() > 1) {
4212         paramLocTupleStartedWithThis.add(paramLocTuple);
4213         if (minSize == 0 || minSize > paramLocTuple.size()) {
4214           minSize = paramLocTuple.size();
4215         }
4216       }
4217     }
4218
4219     // System.out.println("---paramLocTupleStartedWithThis=" + paramLocTupleStartedWithThis);
4220     Descriptor enclosingDesc = md;
4221     if (hasParamNotStartedWithThisRef) {
4222       // in this case, PCLOC will be the local location
4223     } else {
4224       // all parameter is started with 'this', so PCLOC will be set relative to the composite
4225       // location started with 'this'.
4226       // for (int idx = 0; idx < minSize - 1; idx++) {
4227       for (int idx = 0; idx < 1; idx++) {
4228         Set<Descriptor> locDescSet = new HashSet<Descriptor>();
4229         Location curLoc = null;
4230         NTuple<Location> paramLocTuple = null;
4231         for (Iterator iterator = paramLocTupleStartedWithThis.iterator(); iterator.hasNext();) {
4232           paramLocTuple = (NTuple<Location>) iterator.next();
4233           // System.out.println("-----paramLocTuple=" + paramLocTuple + "  idx=" + idx);
4234           curLoc = paramLocTuple.get(idx);
4235           Descriptor locDesc = curLoc.getLocDescriptor();
4236           locDescSet.add(locDesc);
4237         }
4238         // System.out.println("-----locDescSet=" + locDescSet + " idx=" + idx);
4239         if (locDescSet.size() != 1) {
4240           break;
4241         }
4242         Location newLocElement = new Location(curLoc.getDescriptor(), curLoc.getLocDescriptor());
4243         // System.out.println("newLocElement" + newLocElement);
4244         higherLocTuple.add(newLocElement);
4245         enclosingDesc = getClassTypeDescriptor(curLoc.getLocDescriptor());
4246       }
4247
4248     }
4249
4250     String locIdentifier = locNamePrefix + (locSeed++);
4251     NameDescriptor locDesc = new NameDescriptor(locIdentifier);
4252     Location newLoc = new Location(enclosingDesc, locDesc);
4253     higherLocTuple.add(newLoc);
4254     // System.out.println("---new loc tuple=" + higherLocTuple);
4255
4256     return higherLocTuple;
4257
4258   }
4259
4260   public ClassDescriptor getClassTypeDescriptor(Descriptor in) {
4261
4262     if (in instanceof VarDescriptor) {
4263       return ((VarDescriptor) in).getType().getClassDesc();
4264     } else if (in instanceof FieldDescriptor) {
4265       return ((FieldDescriptor) in).getType().getClassDesc();
4266     }
4267     // else if (in instanceof LocationDescriptor) {
4268     // // here is the case that the descriptor 'in' is the last element of the assigned composite
4269     // // location
4270     // return ((VarDescriptor) locTuple.get(0).getLocDescriptor()).getType().getClassDesc();
4271     // }
4272     else {
4273       return null;
4274     }
4275
4276   }
4277
4278   private Set<NTuple<Location>> calculateHighestLocTupleSet(
4279       Set<NTuple<Location>> paramLocTupleHavingInFlowSet) {
4280
4281     Set<NTuple<Location>> highestSet = new HashSet<NTuple<Location>>();
4282
4283     Iterator<NTuple<Location>> iterator = paramLocTupleHavingInFlowSet.iterator();
4284     NTuple<Location> highest = iterator.next();
4285
4286     for (; iterator.hasNext();) {
4287       NTuple<Location> curLocTuple = (NTuple<Location>) iterator.next();
4288       if (isHigherThan(curLocTuple, highest)) {
4289         // System.out.println(curLocTuple + " is greater than " + highest);
4290         highest = curLocTuple;
4291       }
4292     }
4293
4294     highestSet.add(highest);
4295
4296     MethodDescriptor md = (MethodDescriptor) highest.get(0).getDescriptor();
4297     VarDescriptor thisVarDesc = md.getThis();
4298
4299     // System.out.println("highest=" + highest);
4300
4301     for (Iterator<NTuple<Location>> iter = paramLocTupleHavingInFlowSet.iterator(); iter.hasNext();) {
4302       NTuple<Location> curLocTuple = iter.next();
4303
4304       if (!curLocTuple.equals(highest) && !hasOrderingRelation(highest, curLocTuple)) {
4305
4306         // System.out.println("add it to the highest set=" + curLocTuple);
4307         highestSet.add(curLocTuple);
4308
4309       }
4310     }
4311
4312     return highestSet;
4313
4314   }
4315
4316   private Set<String> getHigherLocSymbolThan(SSJavaLattice<String> lattice, String loc) {
4317     Set<String> higherLocSet = new HashSet<String>();
4318
4319     Set<String> locSet = lattice.getTable().keySet();
4320     for (Iterator iterator = locSet.iterator(); iterator.hasNext();) {
4321       String element = (String) iterator.next();
4322       if (lattice.isGreaterThan(element, loc) && (!element.equals(lattice.getTopItem()))) {
4323         higherLocSet.add(element);
4324       }
4325     }
4326     return higherLocSet;
4327   }
4328
4329   private CompositeLocation getLowest(SSJavaLattice<String> methodLattice,
4330       Set<CompositeLocation> set) {
4331
4332     CompositeLocation lowest = set.iterator().next();
4333
4334     if (set.size() == 1) {
4335       return lowest;
4336     }
4337
4338     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
4339       CompositeLocation loc = (CompositeLocation) iterator.next();
4340
4341       if ((!loc.equals(lowest)) && (!isComparable(methodLattice, lowest, loc))) {
4342         // if there is a case where composite locations are incomparable, just
4343         // return null
4344         return null;
4345       }
4346
4347       if ((!loc.equals(lowest)) && isGreaterThan(methodLattice, lowest, loc)) {
4348         lowest = loc;
4349       }
4350     }
4351     return lowest;
4352   }
4353
4354   private boolean isComparable(SSJavaLattice<String> methodLattice, CompositeLocation comp1,
4355       CompositeLocation comp2) {
4356
4357     int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize();
4358
4359     for (int idx = 0; idx < size; idx++) {
4360       Location loc1 = comp1.get(idx);
4361       Location loc2 = comp2.get(idx);
4362
4363       Descriptor desc1 = loc1.getDescriptor();
4364       Descriptor desc2 = loc2.getDescriptor();
4365
4366       if (!desc1.equals(desc2)) {
4367         throw new Error("Fail to compare " + comp1 + " and " + comp2);
4368       }
4369
4370       String symbol1 = loc1.getLocIdentifier();
4371       String symbol2 = loc2.getLocIdentifier();
4372
4373       SSJavaLattice<String> lattice;
4374       if (idx == 0) {
4375         lattice = methodLattice;
4376       } else {
4377         lattice = getLattice(desc1);
4378       }
4379
4380       if (symbol1.equals(symbol2)) {
4381         continue;
4382       } else if (!lattice.isComparable(symbol1, symbol2)) {
4383         return false;
4384       }
4385
4386     }
4387
4388     return true;
4389   }
4390
4391   private boolean isGreaterThan(SSJavaLattice<String> methodLattice, CompositeLocation comp1,
4392       CompositeLocation comp2) {
4393
4394     int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize();
4395
4396     for (int idx = 0; idx < size; idx++) {
4397       Location loc1 = comp1.get(idx);
4398       Location loc2 = comp2.get(idx);
4399
4400       Descriptor desc1 = loc1.getDescriptor();
4401       Descriptor desc2 = loc2.getDescriptor();
4402
4403       if (!desc1.equals(desc2)) {
4404         throw new Error("Fail to compare " + comp1 + " and " + comp2);
4405       }
4406
4407       String symbol1 = loc1.getLocIdentifier();
4408       String symbol2 = loc2.getLocIdentifier();
4409
4410       SSJavaLattice<String> lattice;
4411       if (idx == 0) {
4412         lattice = methodLattice;
4413       } else {
4414         lattice = getLattice(desc1);
4415       }
4416
4417       if (symbol1.equals(symbol2)) {
4418         continue;
4419       } else if (lattice.isGreaterThan(symbol1, symbol2)) {
4420         return true;
4421       } else {
4422         return false;
4423       }
4424
4425     }
4426
4427     return false;
4428   }
4429
4430   private GlobalFlowGraph getSubGlobalFlowGraph(MethodDescriptor md) {
4431
4432     if (!mapMethodDescriptorToSubGlobalFlowGraph.containsKey(md)) {
4433       mapMethodDescriptorToSubGlobalFlowGraph.put(md, new GlobalFlowGraph(md));
4434     }
4435     return mapMethodDescriptorToSubGlobalFlowGraph.get(md);
4436   }
4437
4438   private void propagateFlowsToCallerWithNoCompositeLocation(MethodInvokeNode min,
4439       MethodDescriptor mdCaller, MethodDescriptor mdCallee) {
4440
4441     // System.out.println("-propagateFlowsToCallerWithNoCompositeLocation=" + min.printNode(0));
4442     // if the parameter A reaches to the parameter B
4443     // then, add an edge the argument A -> the argument B to the caller's flow
4444     // graph
4445
4446     FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
4447     FlowGraph callerFlowGraph = getFlowGraph(mdCaller);
4448     int numParam = calleeFlowGraph.getNumParameters();
4449
4450     for (int i = 0; i < numParam; i++) {
4451       for (int k = 0; k < numParam; k++) {
4452
4453         if (i != k) {
4454
4455           FlowNode paramNode1 = calleeFlowGraph.getParamFlowNode(i);
4456           FlowNode paramNode2 = calleeFlowGraph.getParamFlowNode(k);
4457
4458           NTuple<Descriptor> arg1Tuple = getNodeTupleByArgIdx(min, i);
4459           NTuple<Descriptor> arg2Tuple = getNodeTupleByArgIdx(min, k);
4460
4461           // check if the callee propagates an ordering constraints through
4462           // parameters
4463
4464           // Set<FlowNode> localReachSet = calleeFlowGraph.getLocalReachFlowNodeSetFrom(paramNode1);
4465           Set<FlowNode> localReachSet =
4466               calleeFlowGraph.getReachableSetFrom(paramNode1.getDescTuple());
4467
4468           NTuple<Descriptor> paramDescTuple1 = paramNode1.getCurrentDescTuple();
4469           NTuple<Descriptor> paramDescTuple2 = paramNode2.getCurrentDescTuple();
4470
4471           // System.out.println("-param1CurTuple=" + paramDescTuple1 + " param2CurTuple="
4472           // + paramDescTuple2);
4473           // System.out.println("-- localReachSet from param1=" + localReachSet);
4474
4475           if (paramDescTuple1.get(0).equals(paramDescTuple2.get(0))) {
4476             // if two parameters share the same prefix
4477             // it already has been assigned to a composite location
4478             // so we don't need to add an additional ordering relation caused by these two
4479             // paramters.
4480             continue;
4481           }
4482
4483           if (arg1Tuple.size() > 0 && arg2Tuple.size() > 0
4484               && containsPrefix(paramNode2.getDescTuple().get(0), localReachSet)) {
4485             // need to propagate an ordering relation s.t. arg1 is higher
4486             // than arg2
4487             // System.out.println("-param1=" + paramNode1 + " is higher than param2=" + paramNode2);
4488
4489             // add a new flow between the corresponding arguments.
4490             callerFlowGraph.addValueFlowEdge(arg1Tuple, arg2Tuple);
4491             // System.out.println("arg1=" + arg1Tuple + "   arg2=" + arg2Tuple);
4492
4493             // System.out
4494             // .println("-arg1Tuple=" + arg1Tuple + " is higher than arg2Tuple=" + arg2Tuple);
4495
4496           }
4497
4498           // System.out.println();
4499         }
4500       }
4501     }
4502
4503     // if a parameter has a composite location and the first element of the parameter location
4504     // matches the callee's 'this'
4505     // we have a more specific constraint: the caller's corresponding argument is higher than the
4506     // parameter location which is translated into the caller
4507
4508     for (int idx = 0; idx < numParam; idx++) {
4509       FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx);
4510       CompositeLocation compLoc = paramNode.getCompositeLocation();
4511       // System.out.println("paramNode=" + paramNode + "   compLoc=" + compLoc);
4512       if (compLoc != null && compLoc.get(0).getLocDescriptor().equals(min.getMethod().getThis())) {
4513         // System.out.println("$$$COMPLOC CASE=" + compLoc + "  idx=" + idx);
4514
4515         NTuple<Descriptor> argTuple = getNodeTupleByArgIdx(min, idx);
4516         // System.out.println("--- argTuple=" + argTuple + " current compLoc="
4517         // + callerFlowGraph.getFlowNode(argTuple).getCompositeLocation());
4518
4519         NTuple<Descriptor> translatedParamTuple =
4520             translateCompositeLocationToCaller(idx, min, compLoc);
4521         // System.out.println("add a flow edge= " + argTuple + "->" + translatedParamTuple);
4522         callerFlowGraph.addValueFlowEdge(argTuple, translatedParamTuple);
4523
4524         Set<NTuple<Location>> pcLocTupleSet = getPCLocTupleSet(min);
4525         for (Iterator iterator = pcLocTupleSet.iterator(); iterator.hasNext();) {
4526           NTuple<Location> pcLocTuple = (NTuple<Location>) iterator.next();
4527           callerFlowGraph.addValueFlowEdge(translateToDescTuple(pcLocTuple), translatedParamTuple);
4528         }
4529
4530       }
4531     }
4532
4533   }
4534
4535   private boolean containsPrefix(Descriptor prefixDesc, Set<FlowNode> set) {
4536
4537     for (Iterator iterator = set.iterator(); iterator.hasNext();) {
4538       FlowNode flowNode = (FlowNode) iterator.next();
4539       if (flowNode.getDescTuple().startsWith(prefixDesc)) {
4540         // System.out.println("FOUND=" + flowNode);
4541         return true;
4542       }
4543     }
4544     return false;
4545   }
4546
4547   private NTuple<Descriptor> translateCompositeLocationToCaller(int idx, MethodInvokeNode min,
4548       CompositeLocation compLocForParam1) {
4549
4550     NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
4551
4552     NTuple<Descriptor> tuple = new NTuple<Descriptor>();
4553     for (int i = 0; i < baseTuple.size(); i++) {
4554       tuple.add(baseTuple.get(i));
4555     }
4556
4557     for (int i = 1; i < compLocForParam1.getSize(); i++) {
4558       Location loc = compLocForParam1.get(i);
4559       tuple.add(loc.getLocDescriptor());
4560     }
4561
4562     return tuple;
4563   }
4564
4565   private CompositeLocation generateCompositeLocation(NTuple<Location> prefixLocTuple) {
4566
4567     // System.out.println("generateCompositeLocation=" + prefixLocTuple);
4568
4569     CompositeLocation newCompLoc = new CompositeLocation();
4570     for (int i = 0; i < prefixLocTuple.size(); i++) {
4571       newCompLoc.addLocation(prefixLocTuple.get(i));
4572     }
4573
4574     Descriptor lastDescOfPrefix = prefixLocTuple.get(prefixLocTuple.size() - 1).getLocDescriptor();
4575
4576     ClassDescriptor enclosingDescriptor;
4577     if (lastDescOfPrefix instanceof FieldDescriptor) {
4578       enclosingDescriptor = ((FieldDescriptor) lastDescOfPrefix).getType().getClassDesc();
4579       // System.out.println("enclosingDescriptor0=" + enclosingDescriptor);
4580     } else if (lastDescOfPrefix.equals(GLOBALDESC)) {
4581       MethodDescriptor currentMethodDesc = (MethodDescriptor) prefixLocTuple.get(0).getDescriptor();
4582       enclosingDescriptor = currentMethodDesc.getClassDesc();
4583     } else {
4584       // var descriptor case
4585       enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc();
4586     }
4587     // System.out.println("enclosingDescriptor=" + enclosingDescriptor);
4588
4589     LocationDescriptor newLocDescriptor = generateNewLocationDescriptor();
4590     newLocDescriptor.setEnclosingClassDesc(enclosingDescriptor);
4591
4592     Location newLoc = new Location(enclosingDescriptor, newLocDescriptor.getSymbol());
4593     newLoc.setLocDescriptor(newLocDescriptor);
4594     newCompLoc.addLocation(newLoc);
4595
4596     // System.out.println("--newCompLoc=" + newCompLoc);
4597     return newCompLoc;
4598   }
4599
4600   private CompositeLocation generateCompositeLocation(MethodDescriptor md,
4601       NTuple<Descriptor> paramPrefix) {
4602
4603     // System.out.println("generateCompositeLocation=" + paramPrefix);
4604
4605     CompositeLocation newCompLoc = convertToCompositeLocation(md, paramPrefix);
4606
4607     Descriptor lastDescOfPrefix = paramPrefix.get(paramPrefix.size() - 1);
4608     // System.out.println("lastDescOfPrefix=" + lastDescOfPrefix + "  kind="
4609     // + lastDescOfPrefix.getClass());
4610     ClassDescriptor enclosingDescriptor;
4611     if (lastDescOfPrefix instanceof FieldDescriptor) {
4612       enclosingDescriptor = ((FieldDescriptor) lastDescOfPrefix).getType().getClassDesc();
4613       // System.out.println("enclosingDescriptor0=" + enclosingDescriptor);
4614     } else {
4615       // var descriptor case
4616       enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc();
4617     }
4618     // System.out.println("enclosingDescriptor=" + enclosingDescriptor);
4619
4620     LocationDescriptor newLocDescriptor = generateNewLocationDescriptor();
4621     newLocDescriptor.setEnclosingClassDesc(enclosingDescriptor);
4622
4623     Location newLoc = new Location(enclosingDescriptor, newLocDescriptor.getSymbol());
4624     newLoc.setLocDescriptor(newLocDescriptor);
4625     newCompLoc.addLocation(newLoc);
4626
4627     // System.out.println("--newCompLoc=" + newCompLoc);
4628     return newCompLoc;
4629   }
4630
4631   private List<NTuple<Descriptor>> translatePrefixListToCallee(Descriptor baseRef,
4632       MethodDescriptor mdCallee, List<NTuple<Descriptor>> callerPrefixList) {
4633
4634     List<NTuple<Descriptor>> calleePrefixList = new ArrayList<NTuple<Descriptor>>();
4635
4636     for (int i = 0; i < callerPrefixList.size(); i++) {
4637       NTuple<Descriptor> prefix = callerPrefixList.get(i);
4638       if (prefix.startsWith(baseRef)) {
4639         NTuple<Descriptor> calleePrefix = new NTuple<Descriptor>();
4640         calleePrefix.add(mdCallee.getThis());
4641         for (int k = 1; k < prefix.size(); k++) {
4642           calleePrefix.add(prefix.get(k));
4643         }
4644         calleePrefixList.add(calleePrefix);
4645       }
4646     }
4647
4648     return calleePrefixList;
4649
4650   }
4651
4652   public CompositeLocation convertToCompositeLocation(MethodDescriptor md, NTuple<Descriptor> tuple) {
4653
4654     CompositeLocation compLoc = new CompositeLocation();
4655
4656     Descriptor enclosingDescriptor = md;
4657
4658     for (int i = 0; i < tuple.size(); i++) {
4659       Descriptor curDescriptor = tuple.get(i);
4660       Location locElement = new Location(enclosingDescriptor, curDescriptor.getSymbol());
4661       locElement.setLocDescriptor(curDescriptor);
4662       compLoc.addLocation(locElement);
4663
4664       if (curDescriptor instanceof VarDescriptor) {
4665         enclosingDescriptor = md.getClassDesc();
4666       } else if (curDescriptor instanceof FieldDescriptor) {
4667         enclosingDescriptor = ((FieldDescriptor) curDescriptor).getClassDescriptor();
4668       } else if (curDescriptor instanceof NameDescriptor) {
4669         // it is "GLOBAL LOC" case!
4670         enclosingDescriptor = GLOBALDESC;
4671       } else if (curDescriptor instanceof InterDescriptor) {
4672         enclosingDescriptor = getFlowGraph(md).getEnclosingDescriptor(curDescriptor);
4673       } else {
4674         enclosingDescriptor = null;
4675       }
4676
4677     }
4678
4679     return compLoc;
4680   }
4681
4682   private LocationDescriptor generateNewLocationDescriptor() {
4683     return new LocationDescriptor("Loc" + (locSeed++));
4684   }
4685
4686   private int getPrefixIndex(NTuple<Descriptor> tuple1, NTuple<Descriptor> tuple2) {
4687
4688     // return the index where the prefix shared by tuple1 and tuple2 is ended
4689     // if there is no prefix shared by both of them, return -1
4690
4691     int minSize = tuple1.size();
4692     if (minSize > tuple2.size()) {
4693       minSize = tuple2.size();
4694     }
4695
4696     int idx = -1;
4697     for (int i = 0; i < minSize; i++) {
4698       if (!tuple1.get(i).equals(tuple2.get(i))) {
4699         break;
4700       } else {
4701         idx++;
4702       }
4703     }
4704
4705     return idx;
4706   }
4707
4708   private CompositeLocation generateInferredCompositeLocation(MethodLocationInfo methodInfo,
4709       NTuple<Location> tuple) {
4710
4711     // first, retrieve inferred location by the local var descriptor
4712     CompositeLocation inferLoc = new CompositeLocation();
4713
4714     CompositeLocation localVarInferLoc =
4715         methodInfo.getInferLocation(tuple.get(0).getLocDescriptor());
4716
4717     localVarInferLoc.get(0).setLocDescriptor(tuple.get(0).getLocDescriptor());
4718
4719     for (int i = 0; i < localVarInferLoc.getSize(); i++) {
4720       inferLoc.addLocation(localVarInferLoc.get(i));
4721     }
4722
4723     for (int i = 1; i < tuple.size(); i++) {
4724       Location cur = tuple.get(i);
4725       Descriptor enclosingDesc = cur.getDescriptor();
4726       Descriptor curDesc = cur.getLocDescriptor();
4727
4728       Location inferLocElement;
4729       if (curDesc == null) {
4730         // in this case, we have a newly generated location.
4731         inferLocElement = new Location(enclosingDesc, cur.getLocIdentifier());
4732       } else {
4733         String fieldLocSymbol =
4734             getLocationInfo(enclosingDesc).getInferLocation(curDesc).get(0).getLocIdentifier();
4735         inferLocElement = new Location(enclosingDesc, fieldLocSymbol);
4736         inferLocElement.setLocDescriptor(curDesc);
4737       }
4738
4739       inferLoc.addLocation(inferLocElement);
4740
4741     }
4742
4743     assert (inferLoc.get(0).getLocDescriptor().getSymbol() == inferLoc.get(0).getLocIdentifier());
4744     return inferLoc;
4745   }
4746
4747   public LocationInfo getLocationInfo(Descriptor d) {
4748     if (d instanceof MethodDescriptor) {
4749       return getMethodLocationInfo((MethodDescriptor) d);
4750     } else {
4751       return getFieldLocationInfo((ClassDescriptor) d);
4752     }
4753   }
4754
4755   private MethodLocationInfo getMethodLocationInfo(MethodDescriptor md) {
4756
4757     if (!mapMethodDescToMethodLocationInfo.containsKey(md)) {
4758       mapMethodDescToMethodLocationInfo.put(md, new MethodLocationInfo(md));
4759     }
4760
4761     return mapMethodDescToMethodLocationInfo.get(md);
4762
4763   }
4764
4765   private LocationInfo getFieldLocationInfo(ClassDescriptor cd) {
4766
4767     if (!mapClassToLocationInfo.containsKey(cd)) {
4768       mapClassToLocationInfo.put(cd, new LocationInfo(cd));
4769     }
4770
4771     return mapClassToLocationInfo.get(cd);
4772
4773   }
4774
4775   private void addPrefixMapping(Map<NTuple<Location>, Set<NTuple<Location>>> map,
4776       NTuple<Location> prefix, NTuple<Location> element) {
4777
4778     if (!map.containsKey(prefix)) {
4779       map.put(prefix, new HashSet<NTuple<Location>>());
4780     }
4781     map.get(prefix).add(element);
4782   }
4783
4784   private boolean containsNonPrimitiveElement(Set<Descriptor> descSet) {
4785     for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
4786       Descriptor desc = (Descriptor) iterator.next();
4787
4788       if (desc.equals(LocationInference.GLOBALDESC)) {
4789         return true;
4790       } else if (desc instanceof VarDescriptor) {
4791         if (!((VarDescriptor) desc).getType().isPrimitive()) {
4792           return true;
4793         }
4794       } else if (desc instanceof FieldDescriptor) {
4795         if (!((FieldDescriptor) desc).getType().isPrimitive()) {
4796           return true;
4797         }
4798       }
4799
4800     }
4801     return false;
4802   }
4803
4804   public SSJavaLattice<String> getLattice(Descriptor d) {
4805     if (d instanceof MethodDescriptor) {
4806       return getMethodLattice((MethodDescriptor) d);
4807     } else {
4808       return getFieldLattice((ClassDescriptor) d);
4809     }
4810   }
4811
4812   private SSJavaLattice<String> getMethodLattice(MethodDescriptor md) {
4813     if (!md2lattice.containsKey(md)) {
4814       md2lattice.put(md, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
4815     }
4816     return md2lattice.get(md);
4817   }
4818
4819   private void setMethodLattice(MethodDescriptor md, SSJavaLattice<String> lattice) {
4820     md2lattice.put(md, lattice);
4821   }
4822
4823   private void extractFlowsBetweenFields(ClassDescriptor cd, FlowNode srcNode, FlowNode dstNode,
4824       int idx) {
4825
4826     NTuple<Descriptor> srcCurTuple = srcNode.getCurrentDescTuple();
4827     NTuple<Descriptor> dstCurTuple = dstNode.getCurrentDescTuple();
4828
4829     if (srcCurTuple.get(idx).equals(dstCurTuple.get(idx)) && srcCurTuple.size() > (idx + 1)
4830         && dstCurTuple.size() > (idx + 1)) {
4831       // value flow between fields: we don't need to add a binary relation
4832       // for this case
4833
4834       Descriptor desc = srcCurTuple.get(idx);
4835       ClassDescriptor classDesc;
4836
4837       if (idx == 0) {
4838         classDesc = ((VarDescriptor) desc).getType().getClassDesc();
4839       } else {
4840         if (desc instanceof FieldDescriptor) {
4841           classDesc = ((FieldDescriptor) desc).getType().getClassDesc();
4842         } else {
4843           // this case is that the local variable has a composite location assignment
4844           // the following element after the composite location to the local variable
4845           // has the enclosing descriptor of the local variable
4846           Descriptor localDesc = srcNode.getDescTuple().get(0);
4847           classDesc = ((VarDescriptor) localDesc).getType().getClassDesc();
4848         }
4849       }
4850       extractFlowsBetweenFields(classDesc, srcNode, dstNode, idx + 1);
4851
4852     } else {
4853
4854       Descriptor srcFieldDesc = srcCurTuple.get(idx);
4855       Descriptor dstFieldDesc = dstCurTuple.get(idx);
4856
4857       // System.out.println("srcFieldDesc=" + srcFieldDesc + "  dstFieldDesc=" + dstFieldDesc
4858       // + "   idx=" + idx);
4859       if (!srcFieldDesc.equals(dstFieldDesc)) {
4860         // add a new edge
4861         // System.out.println("-ADD EDGE");
4862         getHierarchyGraph(cd).addEdge(srcFieldDesc, dstFieldDesc);
4863       } else if (!isReference(srcFieldDesc) && !isReference(dstFieldDesc)) {
4864         // System.out.println("-ADD EDGE");
4865         getHierarchyGraph(cd).addEdge(srcFieldDesc, dstFieldDesc);
4866       }
4867
4868     }
4869
4870   }
4871
4872   public SSJavaLattice<String> getFieldLattice(ClassDescriptor cd) {
4873     if (!cd2lattice.containsKey(cd)) {
4874       cd2lattice.put(cd, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
4875     }
4876     return cd2lattice.get(cd);
4877   }
4878
4879   public LinkedList<MethodDescriptor> computeMethodList() {
4880
4881     Set<MethodDescriptor> toSort = new HashSet<MethodDescriptor>();
4882
4883     setupToAnalyze();
4884
4885     Set<MethodDescriptor> visited = new HashSet<MethodDescriptor>();
4886     Set<MethodDescriptor> reachableCallee = new HashSet<MethodDescriptor>();
4887
4888     while (!toAnalyzeIsEmpty()) {
4889       ClassDescriptor cd = toAnalyzeNext();
4890
4891       if (cd.getClassName().equals("Object")) {
4892         rootClassDescriptor = cd;
4893         // inheritanceTree = new InheritanceTree<ClassDescriptor>(cd);
4894       }
4895
4896       setupToAnalazeMethod(cd);
4897       temp_toanalyzeMethodList.removeAll(visited);
4898
4899       while (!toAnalyzeMethodIsEmpty()) {
4900         MethodDescriptor md = toAnalyzeMethodNext();
4901         if ((!visited.contains(md))
4902             && (ssjava.needTobeAnnotated(md) || reachableCallee.contains(md))) {
4903
4904           // creates a mapping from a method descriptor to virtual methods
4905           Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
4906           if (md.isStatic()) {
4907             setPossibleCallees.add(md);
4908           } else {
4909             setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md));
4910           }
4911
4912           Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getCalleeSet(md);
4913           Set<MethodDescriptor> needToAnalyzeCalleeSet = new HashSet<MethodDescriptor>();
4914
4915           for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
4916             MethodDescriptor calleemd = (MethodDescriptor) iterator.next();
4917             if ((!ssjava.isTrustMethod(calleemd))
4918                 && (!ssjava.isSSJavaUtil(calleemd.getClassDesc()))
4919                 && (!calleemd.getModifiers().isNative())) {
4920               if (!visited.contains(calleemd)) {
4921                 temp_toanalyzeMethodList.add(calleemd);
4922               }
4923               reachableCallee.add(calleemd);
4924               needToAnalyzeCalleeSet.add(calleemd);
4925             }
4926           }
4927
4928           mapMethodToCalleeSet.put(md, needToAnalyzeCalleeSet);
4929
4930           visited.add(md);
4931
4932           toSort.add(md);
4933         }
4934       }
4935     }
4936
4937     return ssjava.topologicalSort(toSort);
4938
4939   }
4940
4941   public boolean isTransitivelyCalledFrom(MethodDescriptor callee, MethodDescriptor caller) {
4942     // if the callee is transitively invoked from the caller
4943     // return true;
4944
4945     int callerIdx = toanalyze_methodDescList.indexOf(caller);
4946     int calleeIdx = toanalyze_methodDescList.indexOf(callee);
4947
4948     if (callerIdx < calleeIdx) {
4949       return true;
4950     }
4951
4952     return false;
4953
4954   }
4955
4956   public void constructFlowGraph() {
4957
4958     System.out.println("");
4959     toanalyze_methodDescList = computeMethodList();
4960
4961     // hack... it seems that there is a problem with topological sorting.
4962     // so String.toString(Object o) is appeared too higher in the call chain.
4963     MethodDescriptor mdToString1 = null;
4964     MethodDescriptor mdToString2 = null;
4965     for (Iterator iterator = toanalyze_methodDescList.iterator(); iterator.hasNext();) {
4966       MethodDescriptor md = (MethodDescriptor) iterator.next();
4967       if (md.toString().equals("public static String String.valueOf(Object o)")) {
4968         mdToString1 = md;
4969       }
4970       if (md.toString().equals("public String Object.toString()")) {
4971         mdToString2 = md;
4972       }
4973     }
4974
4975     if (mdToString1 != null) {
4976       toanalyze_methodDescList.remove(mdToString1);
4977       toanalyze_methodDescList.addLast(mdToString1);
4978     }
4979     if (mdToString2 != null) {
4980       toanalyze_methodDescList.remove(mdToString2);
4981       toanalyze_methodDescList.addLast(mdToString2);
4982     }
4983
4984     LinkedList<MethodDescriptor> methodDescList =
4985         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
4986
4987     // System.out.println("@@@methodDescList=" + methodDescList);
4988     // System.exit(0);
4989
4990     while (!methodDescList.isEmpty()) {
4991       MethodDescriptor md = methodDescList.removeLast();
4992       if (state.SSJAVADEBUG) {
4993         System.out.println();
4994         System.out.println("SSJAVA: Constructing a flow graph: " + md);
4995
4996         // creates a mapping from a parameter descriptor to its index
4997         Map<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
4998         int offset = 0;
4999         if (!md.isStatic()) {
5000           offset = 1;
5001           mapParamDescToIdx.put(md.getThis(), 0);
5002         }
5003
5004         for (int i = 0; i < md.numParameters(); i++) {
5005           Descriptor paramDesc = (Descriptor) md.getParameter(i);
5006           mapParamDescToIdx.put(paramDesc, new Integer(i + offset));
5007         }
5008
5009         FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
5010         mapMethodDescriptorToFlowGraph.put(md, fg);
5011
5012         analyzeMethodBody(md.getClassDesc(), md);
5013
5014         // System.out.println("##constructSubGlobalFlowGraph");
5015         // GlobalFlowGraph subGlobalFlowGraph = constructSubGlobalFlowGraph(fg);
5016         // mapMethodDescriptorToSubGlobalFlowGraph.put(md, subGlobalFlowGraph);
5017         //
5018         // // TODO
5019         // System.out.println("##addValueFlowsFromCalleeSubGlobalFlowGraph");
5020         // addValueFlowsFromCalleeSubGlobalFlowGraph(md, subGlobalFlowGraph);
5021         // subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
5022         //
5023         // propagateFlowsFromCalleesWithNoCompositeLocation(md);
5024       }
5025     }
5026     // _debug_printGraph();
5027
5028   }
5029
5030   private void constructGlobalFlowGraph() {
5031     LinkedList<MethodDescriptor> methodDescList =
5032         (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
5033
5034     while (!methodDescList.isEmpty()) {
5035       MethodDescriptor md = methodDescList.removeLast();
5036       if (state.SSJAVADEBUG) {
5037         System.out.println();
5038         System.out.println("SSJAVA: Constructing a sub global flow graph: " + md);
5039
5040         constructSubGlobalFlowGraph(getFlowGraph(md));
5041
5042         // TODO
5043         // System.out.println("-add Value Flows From CalleeSubGlobalFlowGraph");
5044         addValueFlowsFromCalleeSubGlobalFlowGraph(md);
5045         // subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
5046
5047         // System.out.println("-propagate Flows From Callees With No CompositeLocation");
5048         // propagateFlowsFromCalleesWithNoCompositeLocation(md);
5049
5050         // mark if a parameter has incoming flows
5051         checkParamNodesInSubGlobalFlowGraph(md);
5052
5053       }
5054     }
5055   }
5056
5057   private void checkParamNodesInSubGlobalFlowGraph(MethodDescriptor md) {
5058     GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
5059     FlowGraph flowGraph = getFlowGraph(md);
5060
5061     Set<FlowNode> paramFlowNodeSet = flowGraph.getParamFlowNodeSet();
5062     for (Iterator iterator = paramFlowNodeSet.iterator(); iterator.hasNext();) {
5063       FlowNode paramFlowNode = (FlowNode) iterator.next();
5064       // System.out.println("paramFlowNode=" + paramFlowNode);
5065       NTuple<Descriptor> paramDescTuple = paramFlowNode.getDescTuple();
5066       NTuple<Location> paramLocTuple = translateToLocTuple(md, paramDescTuple);
5067       GlobalFlowNode paramGlobalNode = globalFlowGraph.getFlowNode(paramLocTuple);
5068
5069       Set<GlobalFlowNode> incomingNodeSet =
5070           globalFlowGraph.getIncomingNodeSetByPrefix(paramLocTuple.get(0));
5071
5072       if (incomingNodeSet.size() > 0) {
5073         paramGlobalNode.setParamNodeWithIncomingFlows(true);
5074       }
5075
5076     }
5077   }
5078
5079   private Set<MethodInvokeNode> getMethodInvokeNodeSet(MethodDescriptor md) {
5080     if (!mapMethodDescriptorToMethodInvokeNodeSet.containsKey(md)) {
5081       mapMethodDescriptorToMethodInvokeNodeSet.put(md, new HashSet<MethodInvokeNode>());
5082     }
5083     return mapMethodDescriptorToMethodInvokeNodeSet.get(md);
5084   }
5085
5086   private void propagateFlowsFromCalleesWithNoCompositeLocation(MethodDescriptor mdCaller) {
5087
5088     // the transformation for a call site propagates flows through parameters
5089     // if the method is virtual, it also grab all relations from any possible
5090     // callees
5091
5092     Set<MethodInvokeNode> setMethodInvokeNode =
5093         mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
5094
5095     if (setMethodInvokeNode != null) {
5096
5097       for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
5098         MethodInvokeNode min = (MethodInvokeNode) iterator.next();
5099         MethodDescriptor mdCallee = min.getMethod();
5100         Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
5101         if (mdCallee.isStatic()) {
5102           setPossibleCallees.add(mdCallee);
5103         } else {
5104           Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getMethods(mdCallee);
5105           // removes method descriptors that are not invoked by the caller
5106           calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller));
5107           setPossibleCallees.addAll(calleeSet);
5108         }
5109
5110         for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) {
5111           MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next();
5112           propagateFlowsToCallerWithNoCompositeLocation(min, mdCaller, possibleMdCallee);
5113         }
5114
5115       }
5116     }
5117
5118   }
5119
5120   private void analyzeMethodBody(ClassDescriptor cd, MethodDescriptor md) {
5121     BlockNode bn = state.getMethodBody(md);
5122     NodeTupleSet implicitFlowTupleSet = new NodeTupleSet();
5123     analyzeFlowBlockNode(md, md.getParameterTable(), bn, implicitFlowTupleSet);
5124   }
5125
5126   private void analyzeFlowBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn,
5127       NodeTupleSet implicitFlowTupleSet) {
5128
5129     bn.getVarTable().setParent(nametable);
5130     for (int i = 0; i < bn.size(); i++) {
5131       BlockStatementNode bsn = bn.get(i);
5132       analyzeBlockStatementNode(md, bn.getVarTable(), bsn, implicitFlowTupleSet);
5133     }
5134
5135   }
5136
5137   private void analyzeBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
5138       BlockStatementNode bsn, NodeTupleSet implicitFlowTupleSet) {
5139
5140     switch (bsn.kind()) {
5141     case Kind.BlockExpressionNode:
5142       analyzeBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, implicitFlowTupleSet);
5143       break;
5144
5145     case Kind.DeclarationNode:
5146       analyzeFlowDeclarationNode(md, nametable, (DeclarationNode) bsn, implicitFlowTupleSet);
5147       break;
5148
5149     case Kind.IfStatementNode:
5150       analyzeFlowIfStatementNode(md, nametable, (IfStatementNode) bsn, implicitFlowTupleSet);
5151       break;
5152
5153     case Kind.LoopNode:
5154       analyzeFlowLoopNode(md, nametable, (LoopNode) bsn, implicitFlowTupleSet);
5155       break;
5156
5157     case Kind.ReturnNode:
5158       analyzeFlowReturnNode(md, nametable, (ReturnNode) bsn, implicitFlowTupleSet);
5159       break;
5160
5161     case Kind.SubBlockNode:
5162       analyzeFlowSubBlockNode(md, nametable, (SubBlockNode) bsn, implicitFlowTupleSet);
5163       break;
5164
5165     case Kind.ContinueBreakNode:
5166       break;
5167
5168     case Kind.SwitchStatementNode:
5169       analyzeSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, implicitFlowTupleSet);
5170       break;
5171
5172     }
5173
5174   }
5175
5176   private void analyzeSwitchBlockNode(MethodDescriptor md, SymbolTable nametable,
5177       SwitchBlockNode sbn, NodeTupleSet implicitFlowTupleSet) {
5178
5179     analyzeFlowBlockNode(md, nametable, sbn.getSwitchBlockStatement(), implicitFlowTupleSet);
5180
5181   }
5182
5183   private void analyzeSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
5184       SwitchStatementNode ssn, NodeTupleSet implicitFlowTupleSet) {
5185
5186     NodeTupleSet condTupleNode = new NodeTupleSet();
5187     analyzeFlowExpressionNode(md, nametable, ssn.getCondition(), condTupleNode, null,
5188         implicitFlowTupleSet, false);
5189
5190     NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5191
5192     newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5193     newImplicitTupleSet.addTupleSet(condTupleNode);
5194
5195     if (needToGenerateInterLoc(newImplicitTupleSet)) {
5196       // need to create an intermediate node for the GLB of conditional
5197       // locations & implicit flows
5198
5199       NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5200       for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
5201         NTuple<Descriptor> tuple = idxIter.next();
5202         addFlowGraphEdge(md, tuple, interTuple);
5203       }
5204       newImplicitTupleSet.clear();
5205       newImplicitTupleSet.addTuple(interTuple);
5206     }
5207
5208     BlockNode sbn = ssn.getSwitchBody();
5209     for (int i = 0; i < sbn.size(); i++) {
5210       analyzeSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), newImplicitTupleSet);
5211     }
5212
5213   }
5214
5215   private void analyzeFlowSubBlockNode(MethodDescriptor md, SymbolTable nametable,
5216       SubBlockNode sbn, NodeTupleSet implicitFlowTupleSet) {
5217     analyzeFlowBlockNode(md, nametable, sbn.getBlockNode(), implicitFlowTupleSet);
5218   }
5219
5220   private void analyzeFlowReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn,
5221       NodeTupleSet implicitFlowTupleSet) {
5222
5223     // System.out.println("-analyzeFlowReturnNode=" + rn.printNode(0));
5224     ExpressionNode returnExp = rn.getReturnExpression();
5225
5226     if (returnExp != null) {
5227       NodeTupleSet nodeSet = new NodeTupleSet();
5228       // if a return expression returns a literal value, nodeSet is empty
5229       analyzeFlowExpressionNode(md, nametable, returnExp, nodeSet, false);
5230       FlowGraph fg = getFlowGraph(md);
5231
5232       // if (implicitFlowTupleSet.size() == 1
5233       // &&
5234       // fg.getFlowNode(implicitFlowTupleSet.iterator().next()).isIntermediate())
5235       // {
5236       //
5237       // // since there is already an intermediate node for the GLB of implicit
5238       // flows
5239       // // we don't need to create another intermediate node.
5240       // // just re-use the intermediate node for implicit flows.
5241       //
5242       // FlowNode meetNode =
5243       // fg.getFlowNode(implicitFlowTupleSet.iterator().next());
5244       //
5245       // for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
5246       // NTuple<Descriptor> returnNodeTuple = (NTuple<Descriptor>)
5247       // iterator.next();
5248       // fg.addValueFlowEdge(returnNodeTuple, meetNode.getDescTuple());
5249       // }
5250       //
5251       // }
5252
5253       NodeTupleSet currentFlowTupleSet = new NodeTupleSet();
5254
5255       // add tuples from return node
5256       currentFlowTupleSet.addTupleSet(nodeSet);
5257
5258       // add tuples corresponding to the current implicit flows
5259       currentFlowTupleSet.addTupleSet(implicitFlowTupleSet);
5260
5261       // System.out.println("---currentFlowTupleSet=" + currentFlowTupleSet);
5262
5263       if (needToGenerateInterLoc(currentFlowTupleSet)) {
5264
5265         FlowNode meetNode = fg.createIntermediateNode();
5266         for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) {
5267           NTuple<Descriptor> currentFlowTuple = (NTuple<Descriptor>) iterator.next();
5268           fg.addValueFlowEdge(currentFlowTuple, meetNode.getDescTuple());
5269         }
5270         fg.addReturnFlowNode(meetNode.getDescTuple());
5271       } else {
5272         // currentFlowTupleSet = removeLiteralTuple(currentFlowTupleSet);
5273         for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) {
5274           NTuple<Descriptor> currentFlowTuple = (NTuple<Descriptor>) iterator.next();
5275           fg.addReturnFlowNode(currentFlowTuple);
5276         }
5277       }
5278
5279     }
5280
5281   }
5282
5283   private NodeTupleSet removeLiteralTuple(NodeTupleSet inSet) {
5284     NodeTupleSet tupleSet = new NodeTupleSet();
5285     for (Iterator<NTuple<Descriptor>> iter = inSet.iterator(); iter.hasNext();) {
5286       NTuple<Descriptor> tuple = iter.next();
5287       if (!tuple.get(0).equals(LITERALDESC)) {
5288         tupleSet.addTuple(tuple);
5289       }
5290     }
5291     return tupleSet;
5292   }
5293
5294   private boolean needToGenerateInterLoc(NodeTupleSet tupleSet) {
5295     int size = 0;
5296     for (Iterator<NTuple<Descriptor>> iter = tupleSet.iterator(); iter.hasNext();) {
5297       NTuple<Descriptor> descTuple = iter.next();
5298       if (!descTuple.get(0).equals(LITERALDESC)) {
5299         size++;
5300       }
5301     }
5302     if (size > 1) {
5303       // System.out.println("needToGenerateInterLoc=" + tupleSet + "  size=" + size);
5304       return true;
5305     } else {
5306       return false;
5307     }
5308   }
5309
5310   private void analyzeFlowLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln,
5311       NodeTupleSet implicitFlowTupleSet) {
5312
5313     if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
5314
5315       NodeTupleSet condTupleNode = new NodeTupleSet();
5316       analyzeFlowExpressionNode(md, nametable, ln.getCondition(), condTupleNode, null,
5317           implicitFlowTupleSet, false);
5318
5319       NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5320
5321       newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5322       newImplicitTupleSet.addTupleSet(condTupleNode);
5323
5324       newImplicitTupleSet.addGlobalFlowTupleSet(implicitFlowTupleSet.getGlobalLocTupleSet());
5325       newImplicitTupleSet.addGlobalFlowTupleSet(condTupleNode.getGlobalLocTupleSet());
5326
5327       if (needToGenerateInterLoc(newImplicitTupleSet)) {
5328         // need to create an intermediate node for the GLB of conditional
5329         // locations & implicit flows
5330
5331         NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5332         for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter
5333             .hasNext();) {
5334           NTuple<Descriptor> tuple = idxIter.next();
5335           addFlowGraphEdge(md, tuple, interTuple);
5336         }
5337         newImplicitTupleSet.clear();
5338         newImplicitTupleSet.addTuple(interTuple);
5339
5340       }
5341
5342       // ///////////
5343       // System.out.println("condTupleNode="+condTupleNode);
5344       // NTuple<Descriptor> interTuple =
5345       // getFlowGraph(md).createIntermediateNode().getDescTuple();
5346       //
5347       // for (Iterator<NTuple<Descriptor>> idxIter = condTupleNode.iterator();
5348       // idxIter.hasNext();) {
5349       // NTuple<Descriptor> tuple = idxIter.next();
5350       // addFlowGraphEdge(md, tuple, interTuple);
5351       // }
5352
5353       // for (Iterator<NTuple<Descriptor>> idxIter =
5354       // implicitFlowTupleSet.iterator(); idxIter
5355       // .hasNext();) {
5356       // NTuple<Descriptor> tuple = idxIter.next();
5357       // addFlowGraphEdge(md, tuple, interTuple);
5358       // }
5359
5360       // NodeTupleSet newImplicitSet = new NodeTupleSet();
5361       // newImplicitSet.addTuple(interTuple);
5362       analyzeFlowBlockNode(md, nametable, ln.getBody(), newImplicitTupleSet);
5363       // ///////////
5364
5365       // condTupleNode.addTupleSet(implicitFlowTupleSet);
5366
5367       // add edges from condNodeTupleSet to all nodes of conditional nodes
5368       // analyzeFlowBlockNode(md, nametable, ln.getBody(), condTupleNode);
5369
5370     } else {
5371       // check 'for loop' case
5372       BlockNode bn = ln.getInitializer();
5373       bn.getVarTable().setParent(nametable);
5374       for (int i = 0; i < bn.size(); i++) {
5375         BlockStatementNode bsn = bn.get(i);
5376         analyzeBlockStatementNode(md, bn.getVarTable(), bsn, implicitFlowTupleSet);
5377       }
5378
5379       NodeTupleSet condTupleNode = new NodeTupleSet();
5380       analyzeFlowExpressionNode(md, bn.getVarTable(), ln.getCondition(), condTupleNode, null,
5381           implicitFlowTupleSet, false);
5382
5383       NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5384       newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5385       newImplicitTupleSet.addTupleSet(condTupleNode);
5386
5387       if (needToGenerateInterLoc(newImplicitTupleSet)) {
5388         // need to create an intermediate node for the GLB of conditional
5389         // locations & implicit flows
5390
5391         NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5392         for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter
5393             .hasNext();) {
5394           NTuple<Descriptor> tuple = idxIter.next();
5395           addFlowGraphEdge(md, tuple, interTuple);
5396         }
5397         newImplicitTupleSet.clear();
5398         newImplicitTupleSet.addTuple(interTuple);
5399
5400       }
5401
5402       // ///////////
5403       // NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5404       //
5405       // for (Iterator<NTuple<Descriptor>> idxIter = condTupleNode.iterator(); idxIter.hasNext();) {
5406       // NTuple<Descriptor> tuple = idxIter.next();
5407       // addFlowGraphEdge(md, tuple, interTuple);
5408       // }
5409       //
5410       // for (Iterator<NTuple<Descriptor>> idxIter = implicitFlowTupleSet.iterator(); idxIter
5411       // .hasNext();) {
5412       // NTuple<Descriptor> tuple = idxIter.next();
5413       // addFlowGraphEdge(md, tuple, interTuple);
5414       // }
5415       //
5416       // NodeTupleSet newImplicitSet = new NodeTupleSet();
5417       // newImplicitSet.addTuple(interTuple);
5418       analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(), newImplicitTupleSet);
5419       analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(), newImplicitTupleSet);
5420       // ///////////
5421
5422       // condTupleNode.addTupleSet(implicitFlowTupleSet);
5423       //
5424       // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(),
5425       // condTupleNode);
5426       // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(),
5427       // condTupleNode);
5428
5429     }
5430
5431   }
5432
5433   private void analyzeFlowIfStatementNode(MethodDescriptor md, SymbolTable nametable,
5434       IfStatementNode isn, NodeTupleSet implicitFlowTupleSet) {
5435
5436     // System.out.println("analyzeFlowIfStatementNode=" + isn.printNode(0));
5437
5438     NodeTupleSet condTupleNode = new NodeTupleSet();
5439     analyzeFlowExpressionNode(md, nametable, isn.getCondition(), condTupleNode, null,
5440         implicitFlowTupleSet, false);
5441
5442     NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5443
5444     newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5445     newImplicitTupleSet.addTupleSet(condTupleNode);
5446
5447     // System.out.println("$$$GGGcondTupleNode=" + condTupleNode.getGlobalLocTupleSet());
5448     // System.out.println("-condTupleNode=" + condTupleNode);
5449     // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
5450     // System.out.println("-newImplicitTupleSet=" + newImplicitTupleSet);
5451
5452     if (needToGenerateInterLoc(newImplicitTupleSet)) {
5453
5454       // need to create an intermediate node for the GLB of conditional locations & implicit flows
5455       NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5456       for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
5457         NTuple<Descriptor> tuple = idxIter.next();
5458         addFlowGraphEdge(md, tuple, interTuple);
5459       }
5460       newImplicitTupleSet.clear();
5461       newImplicitTupleSet.addTuple(interTuple);
5462     }
5463
5464     // GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
5465     // for (Iterator<NTuple<Location>> iterator = condTupleNode.globalIterator();
5466     // iterator.hasNext();) {
5467     // NTuple<Location> calleeReturnLocTuple = iterator.next();
5468     // for (Iterator<NTuple<Descriptor>> iter2 = newImplicitTupleSet.iterator(); iter2.hasNext();) {
5469     // NTuple<Descriptor> callerImplicitTuple = iter2.next();
5470     // globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
5471     // translateToLocTuple(md, callerImplicitTuple));
5472     // }
5473     // }
5474     newImplicitTupleSet.addGlobalFlowTupleSet(condTupleNode.getGlobalLocTupleSet());
5475
5476     analyzeFlowBlockNode(md, nametable, isn.getTrueBlock(), newImplicitTupleSet);
5477
5478     if (isn.getFalseBlock() != null) {
5479       analyzeFlowBlockNode(md, nametable, isn.getFalseBlock(), newImplicitTupleSet);
5480     }
5481
5482   }
5483
5484   private void analyzeFlowDeclarationNode(MethodDescriptor md, SymbolTable nametable,
5485       DeclarationNode dn, NodeTupleSet implicitFlowTupleSet) {
5486
5487     VarDescriptor vd = dn.getVarDescriptor();
5488     mapDescToDefinitionLine.put(vd, dn.getNumLine());
5489     NTuple<Descriptor> tupleLHS = new NTuple<Descriptor>();
5490     tupleLHS.add(vd);
5491     FlowNode fn = getFlowGraph(md).createNewFlowNode(tupleLHS);
5492     fn.setDeclarationNode();
5493
5494     if (dn.getExpression() != null) {
5495       // System.out.println("-analyzeFlowDeclarationNode=" + dn.printNode(0));
5496
5497       NodeTupleSet nodeSetRHS = new NodeTupleSet();
5498       analyzeFlowExpressionNode(md, nametable, dn.getExpression(), nodeSetRHS, null,
5499           implicitFlowTupleSet, false);
5500
5501       // creates edges from RHS to LHS
5502       NTuple<Descriptor> interTuple = null;
5503       if (needToGenerateInterLoc(nodeSetRHS)) {
5504         interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5505       }
5506
5507       for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
5508         NTuple<Descriptor> fromTuple = iter.next();
5509         // System.out.println("fromTuple=" + fromTuple + "  interTuple=" + interTuple + " tupleLSH="
5510         // + tupleLHS);
5511         addFlowGraphEdge(md, fromTuple, interTuple, tupleLHS);
5512       }
5513
5514       // creates edges from implicitFlowTupleSet to LHS
5515       for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
5516         NTuple<Descriptor> implicitTuple = iter.next();
5517         addFlowGraphEdge(md, implicitTuple, tupleLHS);
5518       }
5519
5520       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
5521       for (Iterator<NTuple<Location>> iterator = nodeSetRHS.globalIterator(); iterator.hasNext();) {
5522         NTuple<Location> calleeReturnLocTuple = iterator.next();
5523
5524         globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple, translateToLocTuple(md, tupleLHS));
5525       }
5526
5527       for (Iterator<NTuple<Location>> iterator = implicitFlowTupleSet.globalIterator(); iterator
5528           .hasNext();) {
5529         NTuple<Location> implicitGlobalTuple = iterator.next();
5530
5531         globalFlowGraph.addValueFlowEdge(implicitGlobalTuple, translateToLocTuple(md, tupleLHS));
5532       }
5533
5534       // System.out.println("-nodeSetRHS=" + nodeSetRHS);
5535       // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
5536
5537     }
5538
5539   }
5540
5541   private void analyzeBlockExpressionNode(MethodDescriptor md, SymbolTable nametable,
5542       BlockExpressionNode ben, NodeTupleSet implicitFlowTupleSet) {
5543     analyzeFlowExpressionNode(md, nametable, ben.getExpression(), null, null, implicitFlowTupleSet,
5544         false);
5545   }
5546
5547   private NTuple<Descriptor> analyzeFlowExpressionNode(MethodDescriptor md, SymbolTable nametable,
5548       ExpressionNode en, NodeTupleSet nodeSet, boolean isLHS) {
5549     return analyzeFlowExpressionNode(md, nametable, en, nodeSet, null, new NodeTupleSet(), isLHS);
5550   }
5551
5552   private NTuple<Descriptor> analyzeFlowExpressionNode(MethodDescriptor md, SymbolTable nametable,
5553       ExpressionNode en, NodeTupleSet nodeSet, NTuple<Descriptor> base,
5554       NodeTupleSet implicitFlowTupleSet, boolean isLHS) {
5555
5556     // System.out.println("en=" + en.printNode(0) + "   class=" + en.getClass());
5557
5558     // note that expression node can create more than one flow node
5559     // nodeSet contains of flow nodes
5560     // base is always assigned to null except the case of a name node!
5561     NTuple<Descriptor> flowTuple;
5562     switch (en.kind()) {
5563     case Kind.AssignmentNode:
5564       analyzeFlowAssignmentNode(md, nametable, (AssignmentNode) en, nodeSet, base,
5565           implicitFlowTupleSet);
5566       break;
5567
5568     case Kind.FieldAccessNode:
5569       flowTuple =
5570           analyzeFlowFieldAccessNode(md, nametable, (FieldAccessNode) en, nodeSet, base,
5571               implicitFlowTupleSet, isLHS);
5572       if (flowTuple != null) {
5573         nodeSet.addTuple(flowTuple);
5574       }
5575       return flowTuple;
5576
5577     case Kind.NameNode:
5578       NodeTupleSet nameNodeSet = new NodeTupleSet();
5579       flowTuple =
5580           analyzeFlowNameNode(md, nametable, (NameNode) en, nameNodeSet, base, implicitFlowTupleSet);
5581       if (flowTuple != null) {
5582         nodeSet.addTuple(flowTuple);
5583       }
5584       return flowTuple;
5585
5586     case Kind.OpNode:
5587       analyzeFlowOpNode(md, nametable, (OpNode) en, nodeSet, implicitFlowTupleSet);
5588       break;
5589
5590     case Kind.CreateObjectNode:
5591       analyzeCreateObjectNode(md, nametable, (CreateObjectNode) en, nodeSet, implicitFlowTupleSet);
5592       break;
5593
5594     case Kind.ArrayAccessNode:
5595       analyzeFlowArrayAccessNode(md, nametable, (ArrayAccessNode) en, nodeSet, isLHS);
5596       break;
5597
5598     case Kind.LiteralNode:
5599       analyzeFlowLiteralNode(md, nametable, (LiteralNode) en, nodeSet);
5600       break;
5601
5602     case Kind.MethodInvokeNode:
5603       analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, nodeSet,
5604           implicitFlowTupleSet);
5605       break;
5606
5607     case Kind.TertiaryNode:
5608       analyzeFlowTertiaryNode(md, nametable, (TertiaryNode) en, nodeSet, implicitFlowTupleSet);
5609       break;
5610
5611     case Kind.CastNode:
5612       analyzeFlowCastNode(md, nametable, (CastNode) en, nodeSet, base, implicitFlowTupleSet);
5613       break;
5614     // case Kind.InstanceOfNode:
5615     // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
5616     // return null;
5617
5618     // case Kind.ArrayInitializerNode:
5619     // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
5620     // td);
5621     // return null;
5622
5623     // case Kind.ClassTypeNode:
5624     // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
5625     // return null;
5626
5627     // case Kind.OffsetNode:
5628     // checkOffsetNode(md, nametable, (OffsetNode)en, td);
5629     // return null;
5630
5631     }
5632
5633     return null;
5634
5635   }
5636
5637   private void analyzeFlowCastNode(MethodDescriptor md, SymbolTable nametable, CastNode cn,
5638       NodeTupleSet nodeSet, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
5639
5640     analyzeFlowExpressionNode(md, nametable, cn.getExpression(), nodeSet, base,
5641         implicitFlowTupleSet, false);
5642
5643   }
5644
5645   private void analyzeFlowTertiaryNode(MethodDescriptor md, SymbolTable nametable, TertiaryNode tn,
5646       NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
5647
5648     // System.out.println("analyzeFlowTertiaryNode=" + tn.printNode(0));
5649
5650     NodeTupleSet tertiaryTupleNode = new NodeTupleSet();
5651     analyzeFlowExpressionNode(md, nametable, tn.getCond(), tertiaryTupleNode, null,
5652         implicitFlowTupleSet, false);
5653
5654     NodeTupleSet newImplicitTupleSet = new NodeTupleSet();
5655     newImplicitTupleSet.addTupleSet(implicitFlowTupleSet);
5656     newImplicitTupleSet.addTupleSet(tertiaryTupleNode);
5657
5658     // System.out.println("$$$GGGcondTupleNode=" + tertiaryTupleNode.getGlobalLocTupleSet());
5659     // System.out.println("-tertiaryTupleNode=" + tertiaryTupleNode);
5660     // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
5661     // System.out.println("-newImplicitTupleSet=" + newImplicitTupleSet);
5662
5663     if (needToGenerateInterLoc(newImplicitTupleSet)) {
5664       // need to create an intermediate node for the GLB of conditional locations & implicit flows
5665       NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
5666       for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
5667         NTuple<Descriptor> tuple = idxIter.next();
5668         addFlowGraphEdge(md, tuple, interTuple);
5669       }
5670       newImplicitTupleSet.clear();
5671       newImplicitTupleSet.addTuple(interTuple);
5672     }
5673
5674     newImplicitTupleSet.addGlobalFlowTupleSet(tertiaryTupleNode.getGlobalLocTupleSet());
5675
5676     // System.out.println("---------newImplicitTupleSet=" + newImplicitTupleSet);
5677
5678     // add edges from tertiaryTupleNode to all nodes of conditional nodes
5679     // tertiaryTupleNode.addTupleSet(implicitFlowTupleSet);
5680     analyzeFlowExpressionNode(md, nametable, tn.getTrueExpr(), tertiaryTupleNode, null,
5681         newImplicitTupleSet, false);
5682
5683     analyzeFlowExpressionNode(md, nametable, tn.getFalseExpr(), tertiaryTupleNode, null,
5684         newImplicitTupleSet, false);
5685
5686     nodeSet.addGlobalFlowTupleSet(tertiaryTupleNode.getGlobalLocTupleSet());
5687     nodeSet.addTupleSet(tertiaryTupleNode);
5688
5689     // System.out.println("#tertiary node set=" + nodeSet);
5690   }
5691
5692   private void addMapCallerMethodDescToMethodInvokeNodeSet(MethodDescriptor caller,
5693       MethodInvokeNode min) {
5694     Set<MethodInvokeNode> set = mapMethodDescriptorToMethodInvokeNodeSet.get(caller);
5695     if (set == null) {
5696       set = new HashSet<MethodInvokeNode>();
5697       mapMethodDescriptorToMethodInvokeNodeSet.put(caller, set);
5698     }
5699     set.add(min);
5700   }
5701
5702   private void addParamNodeFlowingToReturnValue(MethodDescriptor md, FlowNode fn) {
5703
5704     if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) {
5705       mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet<FlowNode>());
5706     }
5707     mapMethodDescToParamNodeFlowsToReturnValue.get(md).add(fn);
5708   }
5709
5710   private Set<FlowNode> getParamNodeFlowingToReturnValue(MethodDescriptor md) {
5711
5712     if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) {
5713       mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet<FlowNode>());
5714     }
5715
5716     return mapMethodDescToParamNodeFlowsToReturnValue.get(md);
5717   }
5718
5719   private Set<NTuple<Location>> getPCLocTupleSet(MethodInvokeNode min) {
5720     if (!mapMethodInvokeNodeToPCLocTupleSet.containsKey(min)) {
5721       mapMethodInvokeNodeToPCLocTupleSet.put(min, new HashSet<NTuple<Location>>());
5722     }
5723     return mapMethodInvokeNodeToPCLocTupleSet.get(min);
5724   }
5725
5726   private void analyzeFlowMethodInvokeNode(MethodDescriptor mdCaller, SymbolTable nametable,
5727       MethodInvokeNode min, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
5728
5729     // System.out.println("analyzeFlowMethodInvokeNode=" + min.printNode(0));
5730
5731     if (!toanalyze_methodDescList.contains(min.getMethod())) {
5732       return;
5733     }
5734
5735     addMapMethodDescToMethodInvokeNodeSet(min);
5736
5737     Set<NTuple<Location>> pcLocTupleSet = getPCLocTupleSet(min);
5738     for (Iterator iterator = implicitFlowTupleSet.iterator(); iterator.hasNext();) {
5739       NTuple<Descriptor> pcDescTuple = (NTuple<Descriptor>) iterator.next();
5740       if (!pcDescTuple.get(0).equals(LITERALDESC)) {
5741         // here we don't need to add the literal value as a PC location
5742         pcLocTupleSet.add(translateToLocTuple(mdCaller, pcDescTuple));
5743       }
5744     }
5745
5746     mapMethodInvokeNodeToArgIdxMap.put(min, new HashMap<Integer, NTuple<Descriptor>>());
5747
5748     if (nodeSet == null) {
5749       nodeSet = new NodeTupleSet();
5750     }
5751
5752     MethodDescriptor mdCallee = min.getMethod();
5753
5754     NameDescriptor baseName = min.getBaseName();
5755     boolean isSystemout = false;
5756     if (baseName != null) {
5757       isSystemout = baseName.getSymbol().equals("System.out");
5758     }
5759
5760     if (!ssjava.isSSJavaUtil(mdCallee.getClassDesc()) && !ssjava.isTrustMethod(mdCallee)
5761         && !isSystemout) {
5762
5763       addMapCallerMethodDescToMethodInvokeNodeSet(mdCaller, min);
5764
5765       FlowGraph calleeFlowGraph = getFlowGraph(mdCallee);
5766       // System.out.println("mdCallee=" + mdCallee + " calleeFlowGraph=" + calleeFlowGraph);
5767       Set<FlowNode> calleeReturnSet = calleeFlowGraph.getReturnNodeSet();
5768
5769       // System.out.println("---calleeReturnSet=" + calleeReturnSet);
5770
5771       NodeTupleSet tupleSet = new NodeTupleSet();
5772
5773       if (min.getExpression() != null) {
5774
5775         NodeTupleSet baseNodeSet = new NodeTupleSet();
5776         analyzeFlowExpressionNode(mdCaller, nametable, min.getExpression(), baseNodeSet, null,
5777             implicitFlowTupleSet, false);
5778         // System.out.println("baseNodeSet=" + baseNodeSet);
5779
5780         assert (baseNodeSet.size() == 1);
5781         NTuple<Descriptor> baseTuple = baseNodeSet.iterator().next();
5782         if (baseTuple.get(0) instanceof InterDescriptor) {
5783           if (baseTuple.size() > 1) {
5784             throw new Error();
5785           }
5786           FlowNode interNode = getFlowGraph(mdCaller).getFlowNode(baseTuple);
5787           baseTuple = translateBaseTuple(interNode, baseTuple);
5788         }
5789         mapMethodInvokeNodeToBaseTuple.put(min, baseTuple);
5790
5791         if (!min.getMethod().isStatic()) {
5792           addArgIdxMap(min, 0, baseTuple);
5793
5794           for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) {
5795             FlowNode returnNode = (FlowNode) iterator.next();
5796             NTuple<Descriptor> returnDescTuple = returnNode.getDescTuple();
5797             if (returnDescTuple.startsWith(mdCallee.getThis())) {
5798               // the location type of the return value is started with 'this'
5799               // reference
5800               NTuple<Descriptor> inFlowTuple = new NTuple<Descriptor>(baseTuple.getList());
5801
5802               if (inFlowTuple.get(0) instanceof InterDescriptor) {
5803                 // min.getExpression()
5804               } else {
5805
5806               }
5807
5808               inFlowTuple.addAll(returnDescTuple.subList(1, returnDescTuple.size()));
5809               // nodeSet.addTuple(inFlowTuple);
5810               // System.out.println("1CREATE A NEW TUPLE=" + inFlowTuple + "  from="
5811               // + mdCallee.getThis());
5812               // tupleSet.addTuple(inFlowTuple);
5813               tupleSet.addTuple(baseTuple);
5814             } else {
5815               // TODO
5816               // System.out.println("returnNode=" + returnNode);
5817               Set<FlowNode> inFlowSet = calleeFlowGraph.getIncomingFlowNodeSet(returnNode);
5818               // System.out.println("inFlowSet=" + inFlowSet + "   from retrunNode=" + returnNode);
5819               for (Iterator iterator2 = inFlowSet.iterator(); iterator2.hasNext();) {
5820                 FlowNode inFlowNode = (FlowNode) iterator2.next();
5821                 if (inFlowNode.getDescTuple().startsWith(mdCallee.getThis())) {
5822                   // nodeSet.addTupleSet(baseNodeSet);
5823                   // System.out.println("2CREATE A NEW TUPLE=" + baseNodeSet + "  from="
5824                   // + mdCallee.getThis());
5825                   tupleSet.addTupleSet(baseNodeSet);
5826                 }
5827               }
5828             }
5829           }
5830         }
5831
5832       }
5833       // analyze parameter flows
5834
5835       if (min.numArgs() > 0) {
5836
5837         int offset;
5838         if (min.getMethod().isStatic()) {
5839           offset = 0;
5840         } else {
5841           offset = 1;
5842         }
5843
5844         for (int i = 0; i < min.numArgs(); i++) {
5845           ExpressionNode en = min.getArg(i);
5846           int idx = i + offset;
5847           NodeTupleSet argTupleSet = new NodeTupleSet();
5848           analyzeFlowExpressionNode(mdCaller, nametable, en, argTupleSet, false);
5849           // if argument is liternal node, argTuple is set to NULL
5850           // System.out.println("---arg idx=" + idx + "   argTupleSet=" + argTupleSet);
5851           NTuple<Descriptor> argTuple = generateArgTuple(mdCaller, argTupleSet);
5852
5853           // if an argument is literal value,
5854           // we need to create an itermediate node so that we could assign a composite location to
5855           // that node if needed
5856           if (argTuple.size() > 0
5857               && (argTuple.get(0).equals(GLOBALDESC) || argTuple.get(0).equals(LITERALDESC))) {
5858             /*
5859              * System.out.println("***GLOBAL ARG TUPLE CASE=" + argTuple); System.out.println("8");
5860              *
5861              * NTuple<Descriptor> interTuple =
5862              * getFlowGraph(mdCaller).createIntermediateNode().getDescTuple(); ((InterDescriptor)
5863              * interTuple.get(0)).setMethodArgIdxPair(min, idx); addFlowGraphEdge(mdCaller,
5864              * argTuple, interTuple); argTuple = interTuple; addArgIdxMap(min, idx, argTuple);
5865              * System.out.println("new min mapping i=" + idx + "  ->" + argTuple);
5866              */
5867             argTuple = new NTuple<Descriptor>();
5868           }
5869
5870           addArgIdxMap(min, idx, argTuple);
5871
5872           FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx);
5873
5874           // check whether a param node in the callee graph has incoming flows
5875           // if it has incoming flows, the corresponding arg should be lower than the current PC
5876           // Descriptor prefix = paramNode.getDescTuple().get(0);
5877           // if (calleeFlowGraph.getIncomingNodeSetByPrefix(prefix).size() > 0) {
5878           // for (Iterator<NTuple<Descriptor>> iterator = implicitFlowTupleSet.iterator(); iterator
5879           // .hasNext();) {
5880           // NTuple<Descriptor> pcTuple = iterator.next();
5881           // System.out.println("add edge pcTuple =" + pcTuple + " -> " + argTuple);
5882           // addFlowGraphEdge(md, pcTuple, argTuple);
5883           // }
5884           // }
5885
5886           // System.out.println("paramNode=" + paramNode + "  calleeReturnSet=" + calleeReturnSet);
5887           if (hasInFlowTo(calleeFlowGraph, paramNode, calleeReturnSet)
5888               || mdCallee.getModifiers().isNative()) {
5889             addParamNodeFlowingToReturnValue(mdCallee, paramNode);
5890             // nodeSet.addTupleSet(argTupleSet);
5891             // System.out.println("3CREATE A NEW TUPLE=" + argTupleSet + "  from=" + paramNode);
5892             tupleSet.addTupleSet(argTupleSet);
5893           }
5894         }
5895
5896       }
5897
5898       if (mdCallee.getReturnType() != null && !mdCallee.getReturnType().isVoid()) {
5899         FlowReturnNode returnHolderNode = getFlowGraph(mdCaller).createReturnNode(min);
5900
5901         if (needToGenerateInterLoc(tupleSet)) {
5902           FlowGraph fg = getFlowGraph(mdCaller);
5903           FlowNode interNode = fg.createIntermediateNode();
5904           interNode.setFormHolder(true);
5905
5906           NTuple<Descriptor> interTuple = interNode.getDescTuple();
5907
5908           for (Iterator iterator = tupleSet.iterator(); iterator.hasNext();) {
5909             NTuple<Descriptor> tuple = (NTuple<Descriptor>) iterator.next();
5910
5911             Set<NTuple<Descriptor>> addSet = new HashSet<NTuple<Descriptor>>();
5912             FlowNode node = fg.getFlowNode(tuple);
5913             if (node instanceof FlowReturnNode) {
5914               addSet.addAll(fg.getReturnTupleSet(((FlowReturnNode) node).getReturnTupleSet()));
5915             } else {
5916               addSet.add(tuple);
5917             }
5918             for (Iterator iterator2 = addSet.iterator(); iterator2.hasNext();) {
5919               NTuple<Descriptor> higher = (NTuple<Descriptor>) iterator2.next();
5920               addFlowGraphEdge(mdCaller, higher, interTuple);
5921             }
5922           }
5923
5924           returnHolderNode.addTuple(interTuple);
5925
5926           nodeSet.addTuple(interTuple);
5927           // System.out.println("ADD TUPLESET=" + interTuple + " to returnnode=" +
5928           // returnHolderNode);
5929
5930         } else {
5931           returnHolderNode.addTupleSet(tupleSet);
5932           // System.out.println("ADD TUPLESET=" + tupleSet + " to returnnode=" + returnHolderNode);
5933         }
5934         // setNode.addTupleSet(tupleSet);
5935         // NodeTupleSet setFromReturnNode=new NodeTupleSet();
5936         // setFromReturnNode.addTuple(tuple);
5937
5938         NodeTupleSet holderTupleSet =
5939             getNodeTupleSetFromReturnNode(getFlowGraph(mdCaller), returnHolderNode);
5940
5941         // System.out.println("HOLDER TUPLE SET=" + holderTupleSet);
5942         nodeSet.addTupleSet(holderTupleSet);
5943
5944         nodeSet.addTuple(returnHolderNode.getDescTuple());
5945       }
5946
5947       // propagateFlowsFromCallee(min, md, min.getMethod());
5948
5949       // when generating the global flow graph,
5950       // we need to add ordering relations from the set of callee return loc tuple to LHS of the
5951       // caller assignment
5952       for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) {
5953         FlowNode calleeReturnNode = (FlowNode) iterator.next();
5954         NTuple<Location> calleeReturnLocTuple =
5955             translateToLocTuple(mdCallee, calleeReturnNode.getDescTuple());
5956         // System.out.println("calleeReturnLocTuple=" + calleeReturnLocTuple);
5957         NTuple<Location> transaltedToCaller =
5958             translateToCallerLocTuple(min, mdCallee, mdCaller, calleeReturnLocTuple);
5959         // System.out.println("translateToCallerLocTuple="
5960         // + translateToCallerLocTuple(min, mdCallee, mdCaller, calleeReturnLocTuple));
5961         if (transaltedToCaller.size() > 0) {
5962           nodeSet.addGlobalFlowTuple(translateToCallerLocTuple(min, mdCallee, mdCaller,
5963               calleeReturnLocTuple));
5964         }
5965       }
5966
5967       // System.out.println("min nodeSet=" + nodeSet);
5968
5969     }
5970
5971   }
5972
5973   private NodeTupleSet getNodeTupleSetFromReturnNode(FlowGraph fg, FlowReturnNode node) {
5974     NodeTupleSet nts = new NodeTupleSet();
5975
5976     Set<NTuple<Descriptor>> returnSet = node.getReturnTupleSet();
5977
5978     for (Iterator iterator = returnSet.iterator(); iterator.hasNext();) {
5979       NTuple<Descriptor> tuple = (NTuple<Descriptor>) iterator.next();
5980       FlowNode flowNode = fg.getFlowNode(tuple);
5981       if (flowNode instanceof FlowReturnNode) {
5982         returnSet.addAll(recurGetNode(fg, (FlowReturnNode) flowNode));
5983       } else {
5984         returnSet.add(tuple);
5985       }
5986     }
5987
5988     for (Iterator iterator = returnSet.iterator(); iterator.hasNext();) {
5989       NTuple<Descriptor> nTuple = (NTuple<Descriptor>) iterator.next();
5990       nts.addTuple(nTuple);
5991     }
5992
5993     return nts;
5994
5995   }
5996
5997   private Set<NTuple<Descriptor>> recurGetNode(FlowGraph fg, FlowReturnNode rnode) {
5998
5999     Set<NTuple<Descriptor>> tupleSet = new HashSet<NTuple<Descriptor>>();
6000
6001     Set<NTuple<Descriptor>> returnSet = rnode.getReturnTupleSet();
6002     for (Iterator iterator = returnSet.iterator(); iterator.hasNext();) {
6003       NTuple<Descriptor> tuple = (NTuple<Descriptor>) iterator.next();
6004       FlowNode flowNode = fg.getFlowNode(tuple);
6005       if (flowNode instanceof FlowReturnNode) {
6006         tupleSet.addAll(recurGetNode(fg, (FlowReturnNode) flowNode));
6007       }
6008       tupleSet.add(tuple);
6009     }
6010
6011     return tupleSet;
6012   }
6013
6014   private NTuple<Descriptor> generateArgTuple(MethodDescriptor mdCaller, NodeTupleSet argTupleSet) {
6015
6016     int size = 0;
6017
6018     // if argTupleSet is empty, it comes from the top location
6019     if (argTupleSet.size() == 0) {
6020       NTuple<Descriptor> descTuple = new NTuple<Descriptor>();
6021       descTuple.add(LITERALDESC);
6022       return descTuple;
6023     }
6024
6025     Set<NTuple<Descriptor>> argTupleSetNonLiteral = new HashSet<NTuple<Descriptor>>();
6026
6027     for (Iterator<NTuple<Descriptor>> iter = argTupleSet.iterator(); iter.hasNext();) {
6028       NTuple<Descriptor> descTuple = iter.next();
6029       if (!descTuple.get(0).equals(LITERALDESC)) {
6030         argTupleSetNonLiteral.add(descTuple);
6031       }
6032     }
6033
6034     if (argTupleSetNonLiteral.size() > 1) {
6035
6036       NTuple<Descriptor> interTuple =
6037           getFlowGraph(mdCaller).createIntermediateNode().getDescTuple();
6038       for (Iterator<NTuple<Descriptor>> idxIter = argTupleSet.iterator(); idxIter.hasNext();) {
6039         NTuple<Descriptor> tuple = idxIter.next();
6040         addFlowGraphEdge(mdCaller, tuple, interTuple);
6041       }
6042       return interTuple;
6043     } else if (argTupleSetNonLiteral.size() == 1) {
6044       return argTupleSetNonLiteral.iterator().next();
6045     } else {
6046       return argTupleSet.iterator().next();
6047     }
6048
6049   }
6050
6051   private boolean hasInFlowTo(FlowGraph fg, FlowNode inNode, Set<FlowNode> nodeSet) {
6052     // return true if inNode has in-flows to nodeSet
6053
6054     if (nodeSet.contains(inNode)) {
6055       // in this case, the method directly returns a parameter variable.
6056       return true;
6057     }
6058     // Set<FlowNode> reachableSet = fg.getReachFlowNodeSetFrom(inNode);
6059     Set<FlowNode> reachableSet = fg.getReachableSetFrom(inNode.getDescTuple());
6060     // System.out.println("inNode=" + inNode + "  reachalbeSet=" + reachableSet);
6061
6062     for (Iterator iterator = reachableSet.iterator(); iterator.hasNext();) {
6063       FlowNode fn = (FlowNode) iterator.next();
6064       if (nodeSet.contains(fn)) {
6065         return true;
6066       }
6067     }
6068     return false;
6069   }
6070
6071   private NTuple<Descriptor> getNodeTupleByArgIdx(MethodInvokeNode min, int idx) {
6072     return mapMethodInvokeNodeToArgIdxMap.get(min).get(new Integer(idx));
6073   }
6074
6075   private void addArgIdxMap(MethodInvokeNode min, int idx, NTuple<Descriptor> argTuple /*
6076                                                                                         * NodeTupleSet
6077                                                                                         * tupleSet
6078                                                                                         */) {
6079     Map<Integer, NTuple<Descriptor>> mapIdxToTuple = mapMethodInvokeNodeToArgIdxMap.get(min);
6080     if (mapIdxToTuple == null) {
6081       mapIdxToTuple = new HashMap<Integer, NTuple<Descriptor>>();
6082       mapMethodInvokeNodeToArgIdxMap.put(min, mapIdxToTuple);
6083     }
6084     mapIdxToTuple.put(new Integer(idx), argTuple);
6085   }
6086
6087   private void analyzeFlowLiteralNode(MethodDescriptor md, SymbolTable nametable, LiteralNode en,
6088       NodeTupleSet nodeSet) {
6089     NTuple<Descriptor> tuple = new NTuple<Descriptor>();
6090     tuple.add(LITERALDESC);
6091     nodeSet.addTuple(tuple);
6092   }
6093
6094   private void analyzeFlowArrayAccessNode(MethodDescriptor md, SymbolTable nametable,
6095       ArrayAccessNode aan, NodeTupleSet nodeSet, boolean isLHS) {
6096
6097     // System.out.println("analyzeFlowArrayAccessNode aan=" + aan.printNode(0));
6098     String currentArrayAccessNodeExpStr = aan.printNode(0);
6099     arrayAccessNodeStack.push(aan.printNode(0));
6100
6101     NodeTupleSet expNodeTupleSet = new NodeTupleSet();
6102     NTuple<Descriptor> base =
6103         analyzeFlowExpressionNode(md, nametable, aan.getExpression(), expNodeTupleSet, isLHS);
6104     // System.out.println("-base=" + base);
6105
6106     nodeSet.setMethodInvokeBaseDescTuple(base);
6107     NodeTupleSet idxNodeTupleSet = new NodeTupleSet();
6108     analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, isLHS);
6109
6110     arrayAccessNodeStack.pop();
6111
6112     if (isLHS) {
6113       // need to create an edge from idx to array
6114       for (Iterator<NTuple<Descriptor>> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) {
6115         NTuple<Descriptor> idxTuple = idxIter.next();
6116         for (Iterator<NTuple<Descriptor>> arrIter = expNodeTupleSet.iterator(); arrIter.hasNext();) {
6117           NTuple<Descriptor> arrTuple = arrIter.next();
6118           getFlowGraph(md).addValueFlowEdge(idxTuple, arrTuple);
6119         }
6120       }
6121
6122       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6123       for (Iterator<NTuple<Location>> iterator = idxNodeTupleSet.globalIterator(); iterator
6124           .hasNext();) {
6125         NTuple<Location> calleeReturnLocTuple = iterator.next();
6126         for (Iterator<NTuple<Descriptor>> arrIter = expNodeTupleSet.iterator(); arrIter.hasNext();) {
6127           NTuple<Descriptor> arrTuple = arrIter.next();
6128
6129           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple, translateToLocTuple(md, arrTuple));
6130         }
6131       }
6132
6133       nodeSet.addTupleSet(expNodeTupleSet);
6134     } else {
6135
6136       NodeTupleSet nodeSetArrayAccessExp = new NodeTupleSet();
6137
6138       nodeSetArrayAccessExp.addTupleSet(expNodeTupleSet);
6139       nodeSetArrayAccessExp.addTupleSet(idxNodeTupleSet);
6140
6141       if (arrayAccessNodeStack.isEmpty()
6142           || !arrayAccessNodeStack.peek().startsWith(currentArrayAccessNodeExpStr)) {
6143
6144         if (needToGenerateInterLoc(nodeSetArrayAccessExp)) {
6145           FlowNode interNode = getFlowGraph(md).createIntermediateNode();
6146           NTuple<Descriptor> interTuple = interNode.getDescTuple();
6147
6148           for (Iterator<NTuple<Descriptor>> iter = nodeSetArrayAccessExp.iterator(); iter.hasNext();) {
6149             NTuple<Descriptor> higherTuple = iter.next();
6150             addFlowGraphEdge(md, higherTuple, interTuple);
6151           }
6152           nodeSetArrayAccessExp.clear();
6153           nodeSetArrayAccessExp.addTuple(interTuple);
6154           FlowGraph fg = getFlowGraph(md);
6155
6156           // System.out.println("base=" + base);
6157           if (base != null) {
6158             fg.addMapInterLocNodeToEnclosingDescriptor(interTuple.get(0),
6159                 getClassTypeDescriptor(base.get(base.size() - 1)));
6160             interNode.setBaseTuple(base);
6161           }
6162         }
6163       }
6164
6165       nodeSet.addGlobalFlowTupleSet(idxNodeTupleSet.getGlobalLocTupleSet());
6166       nodeSet.addTupleSet(nodeSetArrayAccessExp);
6167
6168     }
6169
6170   }
6171
6172   private void analyzeCreateObjectNode(MethodDescriptor md, SymbolTable nametable,
6173       CreateObjectNode en, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
6174     // System.out.println("#analyzeCreateObjectNode=" + en.printNode(0));
6175     int numArgs = en.numArgs();
6176     NodeTupleSet argSet = new NodeTupleSet();
6177
6178     for (int i = 0; i < numArgs; i++) {
6179       analyzeFlowExpressionNode(md, nametable, en.getArg(i), argSet, null, implicitFlowTupleSet,
6180           false);
6181     }
6182
6183     // System.out.println("###argSet=" + argSet);
6184     nodeSet.addTupleSet(argSet);
6185
6186   }
6187
6188   private void analyzeFlowOpNode(MethodDescriptor md, SymbolTable nametable, OpNode on,
6189       NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
6190
6191     NodeTupleSet leftOpSet = new NodeTupleSet();
6192     NodeTupleSet rightOpSet = new NodeTupleSet();
6193
6194     // System.out.println("analyzeFlowOpNode=" + on.printNode(0));
6195
6196     // left operand
6197     analyzeFlowExpressionNode(md, nametable, on.getLeft(), leftOpSet, null, implicitFlowTupleSet,
6198         false);
6199
6200     if (on.getRight() != null) {
6201       // right operand
6202       analyzeFlowExpressionNode(md, nametable, on.getRight(), rightOpSet, null,
6203           implicitFlowTupleSet, false);
6204     }
6205
6206     Operation op = on.getOp();
6207
6208     switch (op.getOp()) {
6209
6210     case Operation.UNARYPLUS:
6211     case Operation.UNARYMINUS:
6212     case Operation.LOGIC_NOT:
6213       // single operand
6214       nodeSet.addTupleSet(leftOpSet);
6215       break;
6216
6217     case Operation.LOGIC_OR:
6218     case Operation.LOGIC_AND:
6219     case Operation.COMP:
6220     case Operation.BIT_OR:
6221     case Operation.BIT_XOR:
6222     case Operation.BIT_AND:
6223     case Operation.ISAVAILABLE:
6224     case Operation.EQUAL:
6225     case Operation.NOTEQUAL:
6226     case Operation.LT:
6227     case Operation.GT:
6228     case Operation.LTE:
6229     case Operation.GTE:
6230     case Operation.ADD:
6231     case Operation.SUB:
6232     case Operation.MULT:
6233     case Operation.DIV:
6234     case Operation.MOD:
6235     case Operation.LEFTSHIFT:
6236     case Operation.RIGHTSHIFT:
6237     case Operation.URIGHTSHIFT:
6238
6239       // there are two operands
6240       nodeSet.addTupleSet(leftOpSet);
6241       nodeSet.addTupleSet(rightOpSet);
6242
6243       nodeSet.addGlobalFlowTupleSet(leftOpSet.getGlobalLocTupleSet());
6244       nodeSet.addGlobalFlowTupleSet(rightOpSet.getGlobalLocTupleSet());
6245
6246       break;
6247
6248     default:
6249       throw new Error(op.toString());
6250     }
6251
6252   }
6253
6254   private NTuple<Descriptor> analyzeFlowNameNode(MethodDescriptor md, SymbolTable nametable,
6255       NameNode nn, NodeTupleSet nodeSet, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
6256
6257     if (base == null) {
6258       base = new NTuple<Descriptor>();
6259     }
6260
6261     NameDescriptor nd = nn.getName();
6262
6263     if (nd.getBase() != null) {
6264       base =
6265           analyzeFlowExpressionNode(md, nametable, nn.getExpression(), nodeSet, base,
6266               implicitFlowTupleSet, false);
6267       if (base == null) {
6268         // base node has the top location
6269         return base;
6270       }
6271     } else {
6272       String varname = nd.toString();
6273       if (varname.equals("this")) {
6274         // 'this' itself!
6275         base.add(md.getThis());
6276         return base;
6277       }
6278
6279       Descriptor d = (Descriptor) nametable.get(varname);
6280
6281       if (d instanceof VarDescriptor) {
6282         VarDescriptor vd = (VarDescriptor) d;
6283         base.add(vd);
6284       } else if (d instanceof FieldDescriptor) {
6285         // the type of field descriptor has a location!
6286         FieldDescriptor fd = (FieldDescriptor) d;
6287         if (fd.isStatic()) {
6288           if (fd.isFinal()) {
6289             // if it is 'static final', no need to have flow node for the TOP
6290             // location
6291             return null;
6292           } else {
6293             // if 'static', assign the default GLOBAL LOCATION to the first
6294             // element of the tuple
6295             base.add(GLOBALDESC);
6296           }
6297         } else {
6298           // the location of field access starts from this, followed by field
6299           // location
6300           base.add(md.getThis());
6301         }
6302
6303         base.add(fd);
6304       } else if (d == null) {
6305         // access static field
6306         base.add(GLOBALDESC);
6307         base.add(nn.getField());
6308         return base;
6309
6310         // FieldDescriptor fd = nn.getField();addFlowGraphEdge
6311         //
6312         // MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
6313         // String globalLocId = localLattice.getGlobalLoc();
6314         // if (globalLocId == null) {
6315         // throw new
6316         // Error("Method lattice does not define global variable location at "
6317         // + generateErrorMessage(md.getClassDesc(), nn));
6318         // }
6319         // loc.addLocation(new Location(md, globalLocId));
6320         //
6321         // Location fieldLoc = (Location) fd.getType().getExtension();
6322         // loc.addLocation(fieldLoc);
6323         //
6324         // return loc;
6325
6326       }
6327     }
6328     getFlowGraph(md).createNewFlowNode(base);
6329
6330     return base;
6331
6332   }
6333
6334   private NTuple<Descriptor> analyzeFlowFieldAccessNode(MethodDescriptor md, SymbolTable nametable,
6335       FieldAccessNode fan, NodeTupleSet nodeSet, NTuple<Descriptor> base,
6336       NodeTupleSet implicitFlowTupleSet, boolean isLHS) {
6337     // System.out.println("analyzeFlowFieldAccessNode=" + fan.printNode(0));
6338
6339     String currentArrayAccessNodeExpStr = null;
6340     ExpressionNode left = fan.getExpression();
6341     TypeDescriptor ltd = left.getType();
6342     FieldDescriptor fd = fan.getField();
6343     ArrayAccessNode aan = null;
6344
6345     String varName = null;
6346     if (left.kind() == Kind.NameNode) {
6347       NameDescriptor nd = ((NameNode) left).getName();
6348       varName = nd.toString();
6349     }
6350
6351     if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
6352       // using a class name directly or access using this
6353       if (fd.isStatic() && fd.isFinal()) {
6354         return null;
6355       }
6356     }
6357
6358     NodeTupleSet idxNodeTupleSet = new NodeTupleSet();
6359
6360     boolean isArrayCase = false;
6361     if (left instanceof ArrayAccessNode) {
6362
6363       isArrayCase = true;
6364       aan = (ArrayAccessNode) left;
6365
6366       currentArrayAccessNodeExpStr = aan.printNode(0);
6367       arrayAccessNodeStack.push(currentArrayAccessNodeExpStr);
6368
6369       left = aan.getExpression();
6370       analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, base,
6371           implicitFlowTupleSet, isLHS);
6372
6373     }
6374     base =
6375         analyzeFlowExpressionNode(md, nametable, left, nodeSet, base, implicitFlowTupleSet, isLHS);
6376
6377     if (base == null) {
6378       // in this case, field is TOP location
6379       return null;
6380     } else {
6381
6382       NTuple<Descriptor> flowFieldTuple = new NTuple<Descriptor>(base.toList());
6383
6384       if (!left.getType().isPrimitive()) {
6385         if (!fd.getSymbol().equals("length")) {
6386           // array.length access, just have the location of the array
6387           flowFieldTuple.add(fd);
6388           nodeSet.removeTuple(base);
6389         }
6390       }
6391       getFlowGraph(md).createNewFlowNode(flowFieldTuple);
6392
6393       if (isLHS) {
6394         for (Iterator<NTuple<Descriptor>> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) {
6395           NTuple<Descriptor> idxTuple = idxIter.next();
6396           getFlowGraph(md).addValueFlowEdge(idxTuple, flowFieldTuple);
6397         }
6398
6399         GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6400         for (Iterator<NTuple<Location>> iterator = idxNodeTupleSet.globalIterator(); iterator
6401             .hasNext();) {
6402           NTuple<Location> calleeReturnLocTuple = iterator.next();
6403
6404           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6405               translateToLocTuple(md, flowFieldTuple));
6406         }
6407
6408       } else {
6409         nodeSet.addTupleSet(idxNodeTupleSet);
6410
6411         // if it is the array case and not the LHS case
6412         if (isArrayCase) {
6413           arrayAccessNodeStack.pop();
6414
6415           if (arrayAccessNodeStack.isEmpty()
6416               || !arrayAccessNodeStack.peek().startsWith(currentArrayAccessNodeExpStr)) {
6417             NodeTupleSet nodeSetArrayAccessExp = new NodeTupleSet();
6418
6419             nodeSetArrayAccessExp.addTuple(flowFieldTuple);
6420             nodeSetArrayAccessExp.addTupleSet(idxNodeTupleSet);
6421             nodeSetArrayAccessExp.addTupleSet(nodeSet);
6422
6423             if (needToGenerateInterLoc(nodeSetArrayAccessExp)) {
6424               // System.out.println("nodeSetArrayAccessExp=" + nodeSetArrayAccessExp);
6425               // System.out.println("idxNodeTupleSet.getGlobalLocTupleSet()="
6426               // + idxNodeTupleSet.getGlobalLocTupleSet());
6427
6428               NTuple<Descriptor> interTuple =
6429                   getFlowGraph(md).createIntermediateNode().getDescTuple();
6430
6431               for (Iterator<NTuple<Descriptor>> iter = nodeSetArrayAccessExp.iterator(); iter
6432                   .hasNext();) {
6433                 NTuple<Descriptor> higherTuple = iter.next();
6434                 addFlowGraphEdge(md, higherTuple, interTuple);
6435               }
6436
6437               FlowGraph fg = getFlowGraph(md);
6438               fg.addMapInterLocNodeToEnclosingDescriptor(interTuple.get(0),
6439                   getClassTypeDescriptor(base.get(base.size() - 1)));
6440
6441               nodeSet.clear();
6442               flowFieldTuple = interTuple;
6443             }
6444             nodeSet.addGlobalFlowTupleSet(idxNodeTupleSet.getGlobalLocTupleSet());
6445           }
6446
6447         }
6448
6449       }
6450       return flowFieldTuple;
6451     }
6452
6453   }
6454
6455   private void debug_printTreeNode(TreeNode tn) {
6456
6457     System.out.println("DEBUG: " + tn.printNode(0) + "                line#=" + tn.getNumLine());
6458
6459   }
6460
6461   private void analyzeFlowAssignmentNode(MethodDescriptor md, SymbolTable nametable,
6462       AssignmentNode an, NodeTupleSet nodeSet, NTuple<Descriptor> base,
6463       NodeTupleSet implicitFlowTupleSet) {
6464
6465     NodeTupleSet nodeSetRHS = new NodeTupleSet();
6466     NodeTupleSet nodeSetLHS = new NodeTupleSet();
6467
6468     boolean postinc = true;
6469     if (an.getOperation().getBaseOp() == null
6470         || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
6471             .getBaseOp().getOp() != Operation.POSTDEC)) {
6472       postinc = false;
6473     }
6474     // if LHS is array access node, need to capture value flows between an array
6475     // and its index value
6476     analyzeFlowExpressionNode(md, nametable, an.getDest(), nodeSetLHS, null, implicitFlowTupleSet,
6477         true);
6478
6479     if (!postinc) {
6480       // analyze value flows of rhs expression
6481       analyzeFlowExpressionNode(md, nametable, an.getSrc(), nodeSetRHS, null, implicitFlowTupleSet,
6482           false);
6483
6484       // System.out.println("-analyzeFlowAssignmentNode=" + an.printNode(0));
6485       // System.out.println("-nodeSetLHS=" + nodeSetLHS);
6486       // System.out.println("-nodeSetRHS=" + nodeSetRHS);
6487       // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
6488       // System.out.println("-");
6489
6490       if (an.getOperation().getOp() >= 2 && an.getOperation().getOp() <= 12) {
6491         // if assignment contains OP+EQ operator, creates edges from LHS to LHS
6492
6493         for (Iterator<NTuple<Descriptor>> iter = nodeSetLHS.iterator(); iter.hasNext();) {
6494           NTuple<Descriptor> fromTuple = iter.next();
6495           for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6496             NTuple<Descriptor> toTuple = iter2.next();
6497             addFlowGraphEdge(md, fromTuple, toTuple);
6498           }
6499         }
6500       }
6501
6502       // creates edges from RHS to LHS
6503       NTuple<Descriptor> interTuple = null;
6504       if (needToGenerateInterLoc(nodeSetRHS)) {
6505         interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
6506       }
6507
6508       for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
6509         NTuple<Descriptor> fromTuple = iter.next();
6510         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6511           NTuple<Descriptor> toTuple = iter2.next();
6512           addFlowGraphEdge(md, fromTuple, interTuple, toTuple);
6513         }
6514       }
6515
6516       // creates edges from implicitFlowTupleSet to LHS
6517       for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
6518         NTuple<Descriptor> fromTuple = iter.next();
6519         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6520           NTuple<Descriptor> toTuple = iter2.next();
6521           addFlowGraphEdge(md, fromTuple, toTuple);
6522         }
6523       }
6524
6525       // create global flow edges if the callee gives return value flows to the caller
6526       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6527       for (Iterator<NTuple<Location>> iterator = nodeSetRHS.globalIterator(); iterator.hasNext();) {
6528         NTuple<Location> calleeReturnLocTuple = iterator.next();
6529         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6530           NTuple<Descriptor> callerLHSTuple = iter2.next();
6531           // System.out.println("$$$ GLOBAL FLOW ADD=" + calleeReturnLocTuple + " -> "
6532           // + translateToLocTuple(md, callerLHSTuple));
6533
6534           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6535               translateToLocTuple(md, callerLHSTuple));
6536         }
6537       }
6538
6539       for (Iterator<NTuple<Location>> iterator = implicitFlowTupleSet.globalIterator(); iterator
6540           .hasNext();) {
6541         NTuple<Location> calleeReturnLocTuple = iterator.next();
6542         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6543           NTuple<Descriptor> callerLHSTuple = iter2.next();
6544
6545           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6546               translateToLocTuple(md, callerLHSTuple));
6547           // System.out.println("$$$ GLOBAL FLOW PCLOC ADD=" + calleeReturnLocTuple + " -> "
6548           // + translateToLocTuple(md, callerLHSTuple));
6549         }
6550       }
6551
6552     } else {
6553       // postinc case
6554
6555       for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6556         NTuple<Descriptor> tuple = iter2.next();
6557         addFlowGraphEdge(md, tuple, tuple);
6558       }
6559
6560       // creates edges from implicitFlowTupleSet to LHS
6561       for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
6562         NTuple<Descriptor> fromTuple = iter.next();
6563         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6564           NTuple<Descriptor> toTuple = iter2.next();
6565           addFlowGraphEdge(md, fromTuple, toTuple);
6566         }
6567       }
6568
6569       GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(md);
6570       for (Iterator<NTuple<Location>> iterator = implicitFlowTupleSet.globalIterator(); iterator
6571           .hasNext();) {
6572         NTuple<Location> calleeReturnLocTuple = iterator.next();
6573         for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
6574           NTuple<Descriptor> callerLHSTuple = iter2.next();
6575           globalFlowGraph.addValueFlowEdge(calleeReturnLocTuple,
6576               translateToLocTuple(md, callerLHSTuple));
6577           // System.out.println("$$$ GLOBAL FLOW PC ADD=" + calleeReturnLocTuple + " -> "
6578           // + translateToLocTuple(md, callerLHSTuple));
6579         }
6580       }
6581
6582     }
6583
6584     if (nodeSet != null) {
6585       nodeSet.addTupleSet(nodeSetLHS);
6586       nodeSet.addGlobalFlowTupleSet(nodeSetLHS.getGlobalLocTupleSet());
6587     }
6588   }
6589
6590   public FlowGraph getFlowGraph(MethodDescriptor md) {
6591     return mapMethodDescriptorToFlowGraph.get(md);
6592   }
6593
6594   private boolean addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from,
6595       NTuple<Descriptor> to) {
6596     FlowGraph graph = getFlowGraph(md);
6597     graph.addValueFlowEdge(from, to);
6598     return true;
6599   }
6600
6601   private void addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from,
6602       NTuple<Descriptor> inter, NTuple<Descriptor> to) {
6603
6604     FlowGraph graph = getFlowGraph(md);
6605
6606     if (inter != null) {
6607       graph.addValueFlowEdge(from, inter);
6608       graph.addValueFlowEdge(inter, to);
6609     } else {
6610       graph.addValueFlowEdge(from, to);
6611     }
6612
6613   }
6614
6615   public void writeInferredLatticeDotFile(ClassDescriptor cd, SSJavaLattice<String> locOrder,
6616       String nameSuffix) {
6617     // System.out.println("@cd=" + cd);
6618     // System.out.println("@sharedLoc=" + locOrder.getSharedLocSet());
6619     writeInferredLatticeDotFile(cd, null, locOrder, nameSuffix);
6620   }
6621
6622   public void writeInferredLatticeDotFile(ClassDescriptor cd, MethodDescriptor md,
6623       SSJavaLattice<String> locOrder, String nameSuffix) {
6624
6625     String fileName = "lattice_";
6626     if (md != null) {
6627       fileName +=
6628           cd.getSymbol().replaceAll("[\\W_]", "") + "_" + md.toString().replaceAll("[\\W_]", "");
6629     } else {
6630       fileName += cd.getSymbol().replaceAll("[\\W_]", "");
6631     }
6632
6633     fileName += nameSuffix;
6634
6635     System.out.println("***lattice=" + fileName + "    setsize=" + locOrder.getKeySet().size());
6636
6637     Set<Pair<String, String>> pairSet = locOrder.getOrderingPairSet();
6638
6639     Set<String> addedLocSet = new HashSet<String>();
6640
6641     if (pairSet.size() > 0) {
6642       try {
6643         BufferedWriter bw = new BufferedWriter(new FileWriter(fileName + ".dot"));
6644
6645         bw.write("digraph " + fileName + " {\n");
6646
6647         for (Iterator iterator = pairSet.iterator(); iterator.hasNext();) {
6648           // pair is in the form of <higher, lower>
6649           Pair<String, String> pair = (Pair<String, String>) iterator.next();
6650
6651           String highLocId = pair.getFirst();
6652           String lowLocId = pair.getSecond();
6653           if (!addedLocSet.contains(highLocId)) {
6654             addedLocSet.add(highLocId);
6655             drawNode(bw, locOrder, highLocId);
6656           }
6657
6658           if (!addedLocSet.contains(lowLocId)) {
6659             addedLocSet.add(lowLocId);
6660             drawNode(bw, locOrder, lowLocId);
6661           }
6662
6663           bw.write(highLocId + " -> " + lowLocId + ";\n");
6664         }
6665         bw.write("}\n");
6666         bw.close();
6667
6668       } catch (IOException e) {
6669         e.printStackTrace();
6670       }
6671
6672     }
6673
6674   }
6675
6676   private String convertMergeSetToString(HierarchyGraph graph, Set<HNode> mergeSet) {
6677     String str = "";
6678     for (Iterator iterator = mergeSet.iterator(); iterator.hasNext();) {
6679       HNode merged = (HNode) iterator.next();
6680       if (merged.isMergeNode()) {
6681         str += convertMergeSetToString(graph, graph.getMapHNodetoMergeSet().get(merged));
6682       } else {
6683         str += " " + merged.getName();
6684       }
6685     }
6686     return str;
6687   }
6688
6689   public void addNaiveLattice(Descriptor desc, SSJavaLattice<String> lattice) {
6690     desc2naiveLattice.put(desc, lattice);
6691   }
6692
6693   private void drawNode(BufferedWriter bw, SSJavaLattice<String> lattice, String locName)
6694       throws IOException {
6695
6696     String prettyStr;
6697     if (lattice.isSharedLoc(locName)) {
6698       prettyStr = locName + "*";
6699     } else {
6700       prettyStr = locName;
6701     }
6702     // HNode node = graph.getHNode(locName);
6703     // if (node != null && node.isMergeNode()) {
6704     // Set<HNode> mergeSet = graph.getMapHNodetoMergeSet().get(node);
6705     // prettyStr += ":" + convertMergeSetToString(graph, mergeSet);
6706     // }
6707     bw.write(locName + " [label=\"" + prettyStr + "\"]" + ";\n");
6708   }
6709
6710   public void _debug_writeFlowGraph() {
6711     Set<MethodDescriptor> keySet = mapMethodDescriptorToFlowGraph.keySet();
6712
6713     for (Iterator<MethodDescriptor> iterator = keySet.iterator(); iterator.hasNext();) {
6714       MethodDescriptor md = (MethodDescriptor) iterator.next();
6715       FlowGraph fg = mapMethodDescriptorToFlowGraph.get(md);
6716       GlobalFlowGraph subGlobalFlowGraph = getSubGlobalFlowGraph(md);
6717       try {
6718         fg.writeGraph();
6719         subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
6720       } catch (IOException e) {
6721         e.printStackTrace();
6722       }
6723     }
6724
6725   }
6726
6727 }
6728
6729 class CyclicFlowException extends Exception {
6730
6731 }
6732
6733 class InterDescriptor extends Descriptor {
6734
6735   Pair<MethodInvokeNode, Integer> minArgIdxPair;
6736
6737   public InterDescriptor(String name) {
6738     super(name);
6739   }
6740
6741   public void setMethodArgIdxPair(MethodInvokeNode min, int idx) {
6742     minArgIdxPair = new Pair<MethodInvokeNode, Integer>(min, new Integer(idx));
6743   }
6744
6745   public Pair<MethodInvokeNode, Integer> getMethodArgIdxPair() {
6746     return minArgIdxPair;
6747   }
6748
6749 }