changes.
[IRC.git] / Robust / src / Analysis / SSJava / LocationInference.java
index 03cf57f7570eb5d6e96bd9df3ce4612423a1dbe1..0716bc33dbf3b9ff5bd83633bcbe7098c415bf2a 100644 (file)
@@ -1,8 +1,11 @@
 package Analysis.SSJava;
 
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.FileReader;
+import java.io.FileWriter;
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashMap;
@@ -13,6 +16,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.Stack;
+import java.util.Vector;
 
 import IR.ClassDescriptor;
 import IR.Descriptor;
@@ -81,6 +85,12 @@ public class LocationInference {
 
   private Map<MethodDescriptor, Set<MethodDescriptor>> mapMethodToCalleeSet;
 
+  private Map<MethodDescriptor, Set<FlowNode>> mapMethodDescToParamNodeFlowsToReturnValue;
+
+  private Map<String, Vector<String>> mapFileNameToLineVector;
+
+  private Map<Descriptor, Integer> mapDescToDefinitionLine;
+
   public static final String GLOBALLOC = "GLOBALLOC";
 
   public static final String TOPLOC = "TOPLOC";
@@ -89,6 +99,8 @@ public class LocationInference {
 
   public static final Descriptor TOPDESC = new NameDescriptor(TOPLOC);
 
+  public static String newline = System.getProperty("line.separator");
+
   LocationInfo curMethodInfo;
 
   boolean debug = true;
@@ -109,17 +121,22 @@ public class LocationInference {
     this.mapMethodDescToMethodLocationInfo = new HashMap<MethodDescriptor, MethodLocationInfo>();
     this.mapMethodToCalleeSet = new HashMap<MethodDescriptor, Set<MethodDescriptor>>();
     this.mapClassToLocationInfo = new HashMap<ClassDescriptor, LocationInfo>();
+
+    this.mapFileNameToLineVector = new HashMap<String, Vector<String>>();
+    this.mapDescToDefinitionLine = new HashMap<Descriptor, Integer>();
+    this.mapMethodDescToParamNodeFlowsToReturnValue =
+        new HashMap<MethodDescriptor, Set<FlowNode>>();
   }
 
   public void setupToAnalyze() {
     SymbolTable classtable = state.getClassSymbolTable();
     toanalyzeList.clear();
     toanalyzeList.addAll(classtable.getValueSet());
-    Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
-      public int compare(ClassDescriptor o1, ClassDescriptor o2) {
-        return o1.getClassName().compareToIgnoreCase(o2.getClassName());
-      }
-    });
+    // Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
+    // public int compare(ClassDescriptor o1, ClassDescriptor o2) {
+    // return o1.getClassName().compareToIgnoreCase(o2.getClassName());
+    // }
+    // });
   }
 
   public void setupToAnalazeMethod(ClassDescriptor cd) {
@@ -165,6 +182,361 @@ public class LocationInference {
     // 3) check properties
     checkLattices();
 
+    // 4) generate annotated source codes
+    generateAnnoatedCode();
+
+  }
+
+  private void addMapClassDefinitionToLineNum(ClassDescriptor cd, String strLine, int lineNum) {
+
+    String classSymbol = cd.getSymbol();
+    int idx = classSymbol.lastIndexOf("$");
+    if (idx != -1) {
+      classSymbol = classSymbol.substring(idx + 1);
+    }
+
+    String pattern = "class " + classSymbol + " ";
+    if (strLine.indexOf(pattern) != -1) {
+      mapDescToDefinitionLine.put(cd, lineNum);
+    }
+  }
+
+  private void addMapMethodDefinitionToLineNum(Set<MethodDescriptor> methodSet, String strLine,
+      int lineNum) {
+    for (Iterator iterator = methodSet.iterator(); iterator.hasNext();) {
+      MethodDescriptor md = (MethodDescriptor) iterator.next();
+      String pattern = md.getMethodDeclaration();
+      if (strLine.indexOf(pattern) != -1) {
+        mapDescToDefinitionLine.put(md, lineNum);
+        methodSet.remove(md);
+        return;
+      }
+    }
+
+  }
+
+  private void readOriginalSourceFiles() {
+
+    SymbolTable classtable = state.getClassSymbolTable();
+
+    Set<ClassDescriptor> classDescSet = new HashSet<ClassDescriptor>();
+    classDescSet.addAll(classtable.getValueSet());
+
+    try {
+      // inefficient implement. it may re-visit the same file if the file
+      // contains more than one class definitions.
+      for (Iterator iterator = classDescSet.iterator(); iterator.hasNext();) {
+        ClassDescriptor cd = (ClassDescriptor) iterator.next();
+
+        Set<MethodDescriptor> methodSet = new HashSet<MethodDescriptor>();
+        methodSet.addAll(cd.getMethodTable().getValueSet());
+
+        String sourceFileName = cd.getSourceFileName();
+        Vector<String> lineVec = new Vector<String>();
+
+        mapFileNameToLineVector.put(sourceFileName, lineVec);
+
+        BufferedReader in = new BufferedReader(new FileReader(sourceFileName));
+        String strLine;
+        int lineNum = 1;
+        lineVec.add(""); // the index is started from 1.
+        while ((strLine = in.readLine()) != null) {
+          lineVec.add(lineNum, strLine);
+          addMapClassDefinitionToLineNum(cd, strLine, lineNum);
+          addMapMethodDefinitionToLineNum(methodSet, strLine, lineNum);
+          lineNum++;
+        }
+
+      }
+
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+
+  }
+
+  private String generateLatticeDefinition(Descriptor desc) {
+
+    Set<String> sharedLocSet = new HashSet<String>();
+
+    SSJavaLattice<String> lattice = getLattice(desc);
+    String rtr = "@LATTICE(\"";
+
+    Map<String, Set<String>> map = lattice.getTable();
+    Set<String> keySet = map.keySet();
+    boolean first = true;
+    for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+      String key = (String) iterator.next();
+      if (!key.equals(lattice.getTopItem())) {
+        Set<String> connectedSet = map.get(key);
+
+        if (connectedSet.size() == 1) {
+          if (connectedSet.iterator().next().equals(lattice.getBottomItem())) {
+            if (!first) {
+              rtr += ",";
+            } else {
+              rtr += "LOC,";
+              first = false;
+            }
+            rtr += key;
+            if (lattice.isSharedLoc(key)) {
+              rtr += "," + key + "*";
+            }
+          }
+        }
+
+        for (Iterator iterator2 = connectedSet.iterator(); iterator2.hasNext();) {
+          String loc = (String) iterator2.next();
+          if (!loc.equals(lattice.getBottomItem())) {
+            if (!first) {
+              rtr += ",";
+            } else {
+              rtr += "LOC,";
+              first = false;
+            }
+            rtr += loc + "<" + key;
+            if (lattice.isSharedLoc(key) && (!sharedLocSet.contains(key))) {
+              rtr += "," + key + "*";
+              sharedLocSet.add(key);
+            }
+            if (lattice.isSharedLoc(loc) && (!sharedLocSet.contains(loc))) {
+              rtr += "," + loc + "*";
+              sharedLocSet.add(loc);
+            }
+
+          }
+        }
+      }
+    }
+
+    rtr += "\")";
+
+    if (desc instanceof MethodDescriptor) {
+      TypeDescriptor returnType = ((MethodDescriptor) desc).getReturnType();
+
+      MethodLocationInfo methodLocInfo = getMethodLocationInfo((MethodDescriptor) desc);
+
+      if (returnType != null && (!returnType.isVoid())) {
+        rtr +=
+            "\n@RETURNLOC(\"" + generateLocationAnnoatation(methodLocInfo.getReturnLoc()) + "\")";
+      }
+      rtr += "\n@THISLOC(\"this\")\n@GLOBALLOC(\"GLOBALLOC\")";
+
+      if (lattice.containsKey("PCLOC")) {
+        rtr += "\n@PCLOC(\"PCLOC\")";
+      }
+    }
+
+    return rtr;
+  }
+
+  private void generateAnnoatedCode() {
+
+    readOriginalSourceFiles();
+
+    setupToAnalyze();
+    while (!toAnalyzeIsEmpty()) {
+      ClassDescriptor cd = toAnalyzeNext();
+
+      setupToAnalazeMethod(cd);
+
+      LocationInfo locInfo = mapClassToLocationInfo.get(cd);
+      String sourceFileName = cd.getSourceFileName();
+
+      if (cd.isInterface()) {
+        continue;
+      }
+
+      int classDefLine = mapDescToDefinitionLine.get(cd);
+      Vector<String> sourceVec = mapFileNameToLineVector.get(sourceFileName);
+
+      if (locInfo == null) {
+        locInfo = getLocationInfo(cd);
+      }
+
+      for (Iterator iter = cd.getFields(); iter.hasNext();) {
+        Descriptor fieldDesc = (Descriptor) iter.next();
+        String locIdentifier = locInfo.getFieldInferLocation(fieldDesc).getLocIdentifier();
+        if (!getLattice(cd).containsKey(locIdentifier)) {
+          getLattice(cd).put(locIdentifier);
+        }
+      }
+
+      String fieldLatticeDefStr = generateLatticeDefinition(cd);
+      String annoatedSrc = fieldLatticeDefStr + newline + sourceVec.get(classDefLine);
+      sourceVec.set(classDefLine, annoatedSrc);
+
+      // generate annotations for field declarations
+      LocationInfo fieldLocInfo = getLocationInfo(cd);
+      Map<Descriptor, CompositeLocation> inferLocMap = fieldLocInfo.getMapDescToInferLocation();
+
+      for (Iterator iter = cd.getFields(); iter.hasNext();) {
+        FieldDescriptor fd = (FieldDescriptor) iter.next();
+
+        String locAnnotationStr;
+        if (inferLocMap.containsKey(fd)) {
+          CompositeLocation inferLoc = inferLocMap.get(fd);
+          locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
+        } else {
+          // if the field is not accssed by SS part, just assigns dummy
+          // location
+          locAnnotationStr = "@LOC(\"LOC\")";
+        }
+        int fdLineNum = fd.getLineNum();
+        String orgFieldDeclarationStr = sourceVec.get(fdLineNum);
+        String fieldDeclaration = fd.toString();
+        fieldDeclaration = fieldDeclaration.substring(0, fieldDeclaration.length() - 1);
+
+        String annoatedStr = locAnnotationStr + " " + orgFieldDeclarationStr;
+        sourceVec.set(fdLineNum, annoatedStr);
+
+      }
+
+      while (!toAnalyzeMethodIsEmpty()) {
+        MethodDescriptor md = toAnalyzeMethodNext();
+        SSJavaLattice<String> methodLattice = md2lattice.get(md);
+        if (methodLattice != null) {
+
+          int methodDefLine = md.getLineNum();
+
+          MethodLocationInfo methodLocInfo = getMethodLocationInfo(md);
+
+          Map<Descriptor, CompositeLocation> methodInferLocMap =
+              methodLocInfo.getMapDescToInferLocation();
+          Set<Descriptor> localVarDescSet = methodInferLocMap.keySet();
+
+          for (Iterator iterator = localVarDescSet.iterator(); iterator.hasNext();) {
+            Descriptor localVarDesc = (Descriptor) iterator.next();
+            CompositeLocation inferLoc = methodInferLocMap.get(localVarDesc);
+
+            String locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
+
+            if (!isParameter(md, localVarDesc)) {
+              if (mapDescToDefinitionLine.containsKey(localVarDesc)) {
+                int varLineNum = mapDescToDefinitionLine.get(localVarDesc);
+                String orgSourceLine = sourceVec.get(varLineNum);
+                int idx =
+                    orgSourceLine.indexOf(generateVarDeclaration((VarDescriptor) localVarDesc));
+                assert (idx != -1);
+                String annoatedStr =
+                    orgSourceLine.substring(0, idx) + locAnnotationStr + " "
+                        + orgSourceLine.substring(idx);
+                sourceVec.set(varLineNum, annoatedStr);
+              }
+            } else {
+              String methodDefStr = sourceVec.get(methodDefLine);
+
+              int idx =
+                  getParamLocation(methodDefStr,
+                      generateVarDeclaration((VarDescriptor) localVarDesc));
+
+              System.out.println("#methodDefStr=" + methodDefStr + " localVar="
+                  + generateVarDeclaration((VarDescriptor) localVarDesc) + "   idx=" + idx);
+
+              assert (idx != -1);
+
+              String annoatedStr =
+                  methodDefStr.substring(0, idx) + locAnnotationStr + " "
+                      + methodDefStr.substring(idx);
+              sourceVec.set(methodDefLine, annoatedStr);
+            }
+
+          }
+
+          String methodLatticeDefStr = generateLatticeDefinition(md);
+          String annoatedStr = methodLatticeDefStr + newline + sourceVec.get(methodDefLine);
+          sourceVec.set(methodDefLine, annoatedStr);
+
+        }
+      }
+
+    }
+
+    codeGen();
+  }
+
+  private int getParamLocation(String methodStr, String paramStr) {
+
+    String pattern = paramStr + ",";
+
+    int idx = methodStr.indexOf(pattern);
+    if (idx != -1) {
+      return idx;
+    } else {
+      pattern = paramStr + ")";
+      return methodStr.indexOf(pattern);
+    }
+
+  }
+
+  private String generateVarDeclaration(VarDescriptor varDesc) {
+
+    TypeDescriptor td = varDesc.getType();
+    String rtr = td.toString();
+    if (td.isArray()) {
+      for (int i = 0; i < td.getArrayCount(); i++) {
+        rtr += "[]";
+      }
+    }
+    rtr += " " + varDesc.getName();
+    return rtr;
+
+  }
+
+  private String generateLocationAnnoatation(CompositeLocation loc) {
+
+    String rtr = "";
+    // method location
+    Location methodLoc = loc.get(0);
+    rtr += methodLoc.getLocIdentifier();
+
+    for (int i = 1; i < loc.getSize(); i++) {
+      Location element = loc.get(i);
+      rtr += "," + element.getDescriptor().getSymbol() + "." + element.getLocIdentifier();
+    }
+
+    return rtr;
+  }
+
+  private boolean isParameter(MethodDescriptor md, Descriptor localVarDesc) {
+    return getFlowGraph(md).isParamDesc(localVarDesc);
+  }
+
+  private String extractFileName(String fileName) {
+    int idx = fileName.lastIndexOf("/");
+    if (idx == -1) {
+      return fileName;
+    } else {
+      return fileName.substring(idx + 1);
+    }
+
+  }
+
+  private void codeGen() {
+
+    Set<String> originalFileNameSet = mapFileNameToLineVector.keySet();
+    for (Iterator iterator = originalFileNameSet.iterator(); iterator.hasNext();) {
+      String orgFileName = (String) iterator.next();
+      String outputFileName = extractFileName(orgFileName);
+
+      Vector<String> sourceVec = mapFileNameToLineVector.get(orgFileName);
+
+      try {
+
+        FileWriter fileWriter = new FileWriter("./infer/" + outputFileName);
+        BufferedWriter out = new BufferedWriter(fileWriter);
+
+        for (int i = 0; i < sourceVec.size(); i++) {
+          out.write(sourceVec.get(i));
+          out.newLine();
+        }
+        out.close();
+      } catch (IOException e) {
+        e.printStackTrace();
+      }
+
+    }
+
   }
 
   private void simplifyLattices() {
@@ -184,11 +556,9 @@ public class LocationInference {
 
       while (!toAnalyzeMethodIsEmpty()) {
         MethodDescriptor md = toAnalyzeMethodNext();
-        if (ssjava.needTobeAnnotated(md)) {
-          SSJavaLattice<String> methodLattice = md2lattice.get(md);
-          if (methodLattice != null) {
-            methodLattice.removeRedundantEdges();
-          }
+        SSJavaLattice<String> methodLattice = md2lattice.get(md);
+        if (methodLattice != null) {
+          methodLattice.removeRedundantEdges();
         }
       }
     }
@@ -234,12 +604,10 @@ public class LocationInference {
 
       while (!toAnalyzeMethodIsEmpty()) {
         MethodDescriptor md = toAnalyzeMethodNext();
-        if (ssjava.needTobeAnnotated(md)) {
-          SSJavaLattice<String> methodLattice = md2lattice.get(md);
-          if (methodLattice != null) {
-            ssjava.writeLatticeDotFile(cd, md, methodLattice);
-            debug_printDescriptorToLocNameMapping(md);
-          }
+        SSJavaLattice<String> methodLattice = md2lattice.get(md);
+        if (methodLattice != null) {
+          ssjava.writeLatticeDotFile(cd, md, methodLattice);
+          debug_printDescriptorToLocNameMapping(md);
         }
       }
     }
@@ -512,6 +880,18 @@ public class LocationInference {
       }
     }
 
+    for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
+      FlowNode flowNode = (FlowNode) iterator.next();
+      if (flowNode.isDeclaratonNode()) {
+        CompositeLocation inferLoc = methodInfo.getInferLocation(flowNode.getDescTuple().get(0));
+        String locIdentifier = inferLoc.get(0).getLocIdentifier();
+        if (!methodLattice.containsKey(locIdentifier)) {
+          methodLattice.put(locIdentifier);
+        }
+
+      }
+    }
+
     // create mapping from param idx to inferred composite location
 
     int offset;
@@ -529,36 +909,139 @@ public class LocationInference {
       methodInfo.addMapParamIdxToInferLoc(idx + offset, inferParamLoc);
     }
 
-    // calculate the initial program counter location
-    // PC location is higher than location types of all parameters
-    String pcLocSymbol = "PCLOC";
     Map<Integer, CompositeLocation> mapParamToLoc = methodInfo.getMapParamIdxToInferLoc();
     Set<Integer> keySet = mapParamToLoc.keySet();
-    for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
-      Integer paramIdx = (Integer) iterator.next();
-      CompositeLocation inferLoc = mapParamToLoc.get(paramIdx);
-      String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier();
-      if (!methodLattice.isGreaterThan(pcLocSymbol, paramLocLocalSymbol)) {
-        addRelationHigherToLower(methodLattice, methodInfo, pcLocSymbol, paramLocLocalSymbol);
+
+    if (!ssjava.getMethodContainingSSJavaLoop().equals(md)) {
+      // calculate the initial program counter location
+      // PC location is higher than location types of all parameters
+      String pcLocSymbol = "PCLOC";
+      for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+        Integer paramIdx = (Integer) iterator.next();
+        CompositeLocation inferLoc = mapParamToLoc.get(paramIdx);
+        String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier();
+        if (!methodLattice.isGreaterThan(pcLocSymbol, paramLocLocalSymbol)) {
+          addRelationHigherToLower(methodLattice, methodInfo, pcLocSymbol, paramLocLocalSymbol);
+
+          Set<String> higherLocSet = getHigherLocSymbolThan(methodLattice, paramLocLocalSymbol);
+          higherLocSet.remove(pcLocSymbol);
+          for (Iterator iterator2 = higherLocSet.iterator(); iterator2.hasNext();) {
+            String loc = (String) iterator2.next();
+            addRelationHigherToLower(methodLattice, methodInfo, pcLocSymbol, loc);
+          }
+        }
       }
     }
 
     // calculate a return location
-    // the return location type is lower than all parameters
+    // the return location type is lower than all parameters and location types
+    // of return values
     if (!md.getReturnType().isVoid()) {
 
-      String returnLocSymbol = "RETURNLOC";
+      // first, generate the set of return value location types that starts with
+      // 'this' reference
+
+      Set<CompositeLocation> inferFieldReturnLocSet = new HashSet<CompositeLocation>();
+
+      Set<FlowNode> paramFlowNode = getParamNodeFlowingToReturnValue(md);
+      Set<CompositeLocation> inferParamLocSet = new HashSet<CompositeLocation>();
+      if (paramFlowNode != null) {
+        for (Iterator iterator = paramFlowNode.iterator(); iterator.hasNext();) {
+          FlowNode fn = (FlowNode) iterator.next();
+          CompositeLocation inferLoc =
+              generateInferredCompositeLocation(methodInfo, getFlowGraph(md).getLocationTuple(fn));
+          inferParamLocSet.add(inferLoc);
+        }
+      }
+
+      Set<FlowNode> returnNodeSet = fg.getReturnNodeSet();
+      skip: for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
+        FlowNode returnNode = (FlowNode) iterator.next();
+        CompositeLocation inferReturnLoc =
+            generateInferredCompositeLocation(methodInfo, fg.getLocationTuple(returnNode));
+        System.out.println("@inferReturnLoc=" + inferReturnLoc);
+        if (inferReturnLoc.get(0).getLocIdentifier().equals("this")) {
+          // if the location type of the return value matches "this" reference
+          // then, check whether this return value is equal to/lower than all of
+          // parameters that possibly flow into the return values
+          for (Iterator iterator2 = inferParamLocSet.iterator(); iterator2.hasNext();) {
+            CompositeLocation paramInferLoc = (CompositeLocation) iterator2.next();
+
+            if ((!paramInferLoc.equals(inferReturnLoc))
+                && !isGreaterThan(methodLattice, paramInferLoc, inferReturnLoc)) {
+              continue skip;
+            }
+          }
+          inferFieldReturnLocSet.add(inferReturnLoc);
 
-      for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
-        Integer paramIdx = (Integer) iterator.next();
-        CompositeLocation inferLoc = mapParamToLoc.get(paramIdx);
-        String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier();
-        if (!methodLattice.isGreaterThan(paramLocLocalSymbol, returnLocSymbol)) {
-          addRelationHigherToLower(methodLattice, methodInfo, paramLocLocalSymbol, returnLocSymbol);
         }
       }
+
+      if (inferFieldReturnLocSet.size() > 0) {
+
+        CompositeLocation returnLoc = getLowest(methodLattice, inferFieldReturnLocSet);
+        methodInfo.setReturnLoc(returnLoc);
+
+      } else {
+        String returnLocSymbol = "RETURNLOC";
+        CompositeLocation returnLocInferLoc =
+            new CompositeLocation(new Location(md, returnLocSymbol));
+        methodInfo.setReturnLoc(returnLocInferLoc);
+
+        for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+          Integer paramIdx = (Integer) iterator.next();
+          CompositeLocation inferLoc = mapParamToLoc.get(paramIdx);
+          String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier();
+          if (!methodLattice.isGreaterThan(paramLocLocalSymbol, returnLocSymbol)) {
+            addRelationHigherToLower(methodLattice, methodInfo, paramLocLocalSymbol,
+                returnLocSymbol);
+          }
+        }
+
+        for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
+          FlowNode returnNode = (FlowNode) iterator.next();
+          CompositeLocation inferLoc =
+              generateInferredCompositeLocation(methodInfo, fg.getLocationTuple(returnNode));
+          if (!isGreaterThan(methodLattice, inferLoc, returnLocInferLoc)) {
+            addRelation(methodLattice, methodInfo, inferLoc, returnLocInferLoc);
+          }
+        }
+
+      }
+
+    }
+
+  }
+
+  private Set<String> getHigherLocSymbolThan(SSJavaLattice<String> lattice, String loc) {
+    Set<String> higherLocSet = new HashSet<String>();
+
+    Set<String> locSet = lattice.getTable().keySet();
+    for (Iterator iterator = locSet.iterator(); iterator.hasNext();) {
+      String element = (String) iterator.next();
+      if (lattice.isGreaterThan(element, loc) && (!element.equals(lattice.getTopItem()))) {
+        higherLocSet.add(element);
+      }
     }
+    return higherLocSet;
+  }
+
+  private CompositeLocation getLowest(SSJavaLattice<String> methodLattice,
+      Set<CompositeLocation> set) {
+
+    CompositeLocation lowest = set.iterator().next();
 
+    if (set.size() == 1) {
+      return lowest;
+    }
+
+    for (Iterator iterator = set.iterator(); iterator.hasNext();) {
+      CompositeLocation loc = (CompositeLocation) iterator.next();
+      if (isGreaterThan(methodLattice, lowest, loc)) {
+        lowest = loc;
+      }
+    }
+    return lowest;
   }
 
   private boolean isGreaterThan(SSJavaLattice<String> methodLattice, CompositeLocation comp1,
@@ -727,7 +1210,6 @@ public class LocationInference {
     for (int i = 0; i < localVarInferLoc.getSize(); i++) {
       inferLoc.addLocation(localVarInferLoc.get(i));
     }
-    // System.out.println("@@@@@localVarInferLoc=" + localVarInferLoc);
 
     for (int i = 1; i < tuple.size(); i++) {
       Location cur = tuple.get(i);
@@ -968,6 +1450,9 @@ public class LocationInference {
       }
     });
 
+    System.out.println("prefixList=" + prefixList);
+    System.out.println("reachableNodeSet=" + reachableNodeSet);
+
     // find out reachable nodes that have the longest common prefix
     for (int i = 0; i < prefixList.size(); i++) {
       NTuple<Location> curPrefix = prefixList.get(i);
@@ -1011,6 +1496,7 @@ public class LocationInference {
         if (inferLocation.getTuple().startsWith(curPrefix)) {
           // the same infer location is already existed. no need to do
           // anything
+          System.out.println("NO ATTEMPT TO HAVE A COMPOSITE LOCATION curPrefix=" + curPrefix);
           return true;
         } else {
           // assign a new composite location
@@ -1075,6 +1561,7 @@ public class LocationInference {
 
         }
 
+        System.out.println("curPrefix=" + curPrefix);
         System.out.println("ASSIGN NEW COMPOSITE LOCATION =" + newInferLocation + "    to "
             + flowNode);
 
@@ -1320,7 +1807,9 @@ public class LocationInference {
     return cd2lattice.get(cd);
   }
 
-  public void constructFlowGraph() {
+  public LinkedList<MethodDescriptor> computeMethodList() {
+
+    Set<MethodDescriptor> toSort = new HashSet<MethodDescriptor>();
 
     setupToAnalyze();
 
@@ -1337,10 +1826,6 @@ public class LocationInference {
         MethodDescriptor md = toAnalyzeMethodNext();
         if ((!visited.contains(md))
             && (ssjava.needTobeAnnotated(md) || reachableCallee.contains(md))) {
-          if (state.SSJAVADEBUG) {
-            System.out.println();
-            System.out.println("SSJAVA: Constructing a flow graph: " + md);
-          }
 
           // creates a mapping from a method descriptor to virtual methods
           Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
@@ -1367,25 +1852,48 @@ public class LocationInference {
 
           mapMethodToCalleeSet.put(md, needToAnalyzeCalleeSet);
 
-          // creates a mapping from a parameter descriptor to its index
-          Map<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
-          int offset = md.isStatic() ? 0 : 1;
-          for (int i = 0; i < md.numParameters(); i++) {
-            Descriptor paramDesc = (Descriptor) md.getParameter(i);
-            mapParamDescToIdx.put(paramDesc, new Integer(i + offset));
-          }
-
-          FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
-          mapMethodDescriptorToFlowGraph.put(md, fg);
-
           visited.add(md);
-          analyzeMethodBody(cd, md);
 
+          toSort.add(md);
         }
       }
     }
 
+    return ssjava.topologicalSort(toSort);
+
+  }
+
+  public void constructFlowGraph() {
+
+    LinkedList<MethodDescriptor> methodDescList = computeMethodList();
+
+    while (!methodDescList.isEmpty()) {
+      MethodDescriptor md = methodDescList.removeLast();
+      if (state.SSJAVADEBUG) {
+        System.out.println();
+        System.out.println("SSJAVA: Constructing a flow graph: " + md);
+
+        // creates a mapping from a parameter descriptor to its index
+        Map<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
+        int offset = 0;
+        if (!md.isStatic()) {
+          offset = 1;
+          mapParamDescToIdx.put(md.getThis(), 0);
+        }
+
+        for (int i = 0; i < md.numParameters(); i++) {
+          Descriptor paramDesc = (Descriptor) md.getParameter(i);
+          mapParamDescToIdx.put(paramDesc, new Integer(i + offset));
+        }
+
+        FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
+        mapMethodDescriptorToFlowGraph.put(md, fg);
+
+        analyzeMethodBody(md.getClassDesc(), md);
+      }
+    }
     _debug_printGraph();
+
   }
 
   private void analyzeMethodBody(ClassDescriptor cd, MethodDescriptor md) {
@@ -1468,7 +1976,7 @@ public class LocationInference {
       // annotate the elements of the node set as the return location
       for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
         NTuple<Descriptor> returnDescTuple = (NTuple<Descriptor>) iterator.next();
-        fg.setReturnFlowNode(returnDescTuple);
+        fg.addReturnFlowNode(returnDescTuple);
         for (Iterator iterator2 = implicitFlowTupleSet.iterator(); iterator2.hasNext();) {
           NTuple<Descriptor> implicitFlowDescTuple = (NTuple<Descriptor>) iterator2.next();
           fg.addValueFlowEdge(implicitFlowDescTuple, returnDescTuple);
@@ -1533,9 +2041,11 @@ public class LocationInference {
       DeclarationNode dn, NodeTupleSet implicitFlowTupleSet) {
 
     VarDescriptor vd = dn.getVarDescriptor();
+    mapDescToDefinitionLine.put(vd, dn.getNumLine());
     NTuple<Descriptor> tupleLHS = new NTuple<Descriptor>();
     tupleLHS.add(vd);
-    getFlowGraph(md).createNewFlowNode(tupleLHS);
+    FlowNode fn = getFlowGraph(md).createNewFlowNode(tupleLHS);
+    fn.setDeclarationNode();
 
     if (dn.getExpression() != null) {
 
@@ -1616,7 +2126,8 @@ public class LocationInference {
       break;
 
     case Kind.MethodInvokeNode:
-      analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, implicitFlowTupleSet);
+      analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, nodeSet,
+          implicitFlowTupleSet);
       break;
 
     case Kind.TertiaryNode:
@@ -1685,12 +2196,30 @@ public class LocationInference {
     set.add(min);
   }
 
+  private void addParamNodeFlowingToReturnValue(MethodDescriptor md, FlowNode fn) {
+
+    if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) {
+      mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet<FlowNode>());
+    }
+    mapMethodDescToParamNodeFlowsToReturnValue.get(md).add(fn);
+  }
+
+  private Set<FlowNode> getParamNodeFlowingToReturnValue(MethodDescriptor md) {
+    return mapMethodDescToParamNodeFlowsToReturnValue.get(md);
+  }
+
   private void analyzeFlowMethodInvokeNode(MethodDescriptor md, SymbolTable nametable,
-      MethodInvokeNode min, NodeTupleSet implicitFlowTupleSet) {
+      MethodInvokeNode min, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
+
+    System.out.println("analyzeFlowMethodInvokeNode=" + min.printNode(0));
+
+    if (nodeSet == null) {
+      nodeSet = new NodeTupleSet();
+    }
 
     addMapCallerMethodDescToMethodInvokeNodeSet(md, min);
 
-    MethodDescriptor calleeMD = min.getMethod();
+    MethodDescriptor calleeMethodDesc = min.getMethod();
 
     NameDescriptor baseName = min.getBaseName();
     boolean isSystemout = false;
@@ -1698,69 +2227,92 @@ public class LocationInference {
       isSystemout = baseName.getSymbol().equals("System.out");
     }
 
-    if (!ssjava.isSSJavaUtil(calleeMD.getClassDesc()) && !ssjava.isTrustMethod(calleeMD)
-        && !calleeMD.getModifiers().isNative() && !isSystemout) {
+    if (!ssjava.isSSJavaUtil(calleeMethodDesc.getClassDesc())
+        && !ssjava.isTrustMethod(calleeMethodDesc) && !calleeMethodDesc.getModifiers().isNative()
+        && !isSystemout) {
+
+      FlowGraph calleeFlowGraph = getFlowGraph(calleeMethodDesc);
+      Set<FlowNode> calleeReturnSet = calleeFlowGraph.getReturnNodeSet();
 
-      // CompositeLocation baseLocation = null;
       if (min.getExpression() != null) {
 
         NodeTupleSet baseNodeSet = new NodeTupleSet();
         analyzeFlowExpressionNode(md, nametable, min.getExpression(), baseNodeSet, null,
             implicitFlowTupleSet, false);
 
-      } else {
-        if (min.getMethod().isStatic()) {
-          // String globalLocId = ssjava.getMethodLattice(md).getGlobalLoc();
-          // if (globalLocId == null) {
-          // throw new
-          // Error("Method lattice does not define global variable location at "
-          // + generateErrorMessage(md.getClassDesc(), min));
-          // }
-          // baseLocation = new CompositeLocation(new Location(md,
-          // globalLocId));
-        } else {
-          // 'this' var case
-          // String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
-          // baseLocation = new CompositeLocation(new Location(md, thisLocId));
+        if (!min.getMethod().isStatic()) {
+          addArgIdxMap(min, 0, baseNodeSet);
+          // System.out.println("arg idx=0  argTupleSet=" + baseNodeSet);
+
+          for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) {
+            FlowNode returnNode = (FlowNode) iterator.next();
+            NTuple<Descriptor> returnDescTuple = returnNode.getDescTuple();
+            if (returnDescTuple.startsWith(calleeMethodDesc.getThis())) {
+              // the location type of the return value is started with 'this'
+              // reference
+              for (Iterator<NTuple<Descriptor>> baseIter = baseNodeSet.iterator(); baseIter
+                  .hasNext();) {
+                NTuple<Descriptor> baseTuple = baseIter.next();
+                NTuple<Descriptor> inFlowTuple = new NTuple<Descriptor>(baseTuple.getList());
+                inFlowTuple.addAll(returnDescTuple.subList(1, returnDescTuple.size()));
+                nodeSet.addTuple(inFlowTuple);
+              }
+            } else {
+              Set<FlowNode> inFlowSet = calleeFlowGraph.getIncomingFlowNodeSet(returnNode);
+              for (Iterator iterator2 = inFlowSet.iterator(); iterator2.hasNext();) {
+                FlowNode inFlowNode = (FlowNode) iterator2.next();
+                if (inFlowNode.getDescTuple().startsWith(calleeMethodDesc.getThis())) {
+                  nodeSet.addTupleSet(baseNodeSet);
+                }
+              }
+            }
+          }
         }
       }
 
-      // constraint case:
-      // if (constraint != null) {
-      // int compareResult =
-      // CompositeLattice.compare(constraint, baseLocation, true,
-      // generateErrorMessage(cd, min));
-      // if (compareResult != ComparisonResult.GREATER) {
-      // // if the current constraint is higher than method's THIS location
-      // // no need to check constraints!
-      // CompositeLocation calleeConstraint =
-      // translateCallerLocToCalleeLoc(calleeMD, baseLocation, constraint);
-      // // System.out.println("check method body for constraint:" + calleeMD +
-      // // " calleeConstraint="
-      // // + calleeConstraint);
-      // checkMethodBody(calleeMD.getClassDesc(), calleeMD, calleeConstraint);
-      // }
-      // }
+      // analyze parameter flows
 
-      analyzeFlowMethodParameters(md, nametable, min);
+      if (min.numArgs() > 0) {
 
-      // checkCalleeConstraints(md, nametable, min, baseLocation, constraint);
+        int offset;
+        if (min.getMethod().isStatic()) {
+          offset = 0;
+        } else {
+          offset = 1;
+        }
 
-      // checkCallerArgumentLocationConstraints(md, nametable, min,
-      // baseLocation, constraint);
+        for (int i = 0; i < min.numArgs(); i++) {
+          ExpressionNode en = min.getArg(i);
+          int idx = i + offset;
+          NodeTupleSet argTupleSet = new NodeTupleSet();
+          analyzeFlowExpressionNode(calleeMethodDesc, nametable, en, argTupleSet, false);
+          // if argument is liternal node, argTuple is set to NULL.
+          addArgIdxMap(min, idx, argTupleSet);
+          // System.out.println("arg idx=" + (idx) + "  argTupleSet=" +
+          // argTupleSet);
+          FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx);
+          if (hasInFlowTo(calleeFlowGraph, paramNode, calleeReturnSet)) {
+            addParamNodeFlowingToReturnValue(calleeMethodDesc, paramNode);
+            nodeSet.addTupleSet(argTupleSet);
+          }
+        }
 
-      if (min.getMethod().getReturnType() != null && !min.getMethod().getReturnType().isVoid()) {
-        // If method has a return value, compute the highest possible return
-        // location in the caller's perspective
-        // CompositeLocation ceilingLoc =
-        // computeCeilingLocationForCaller(md, nametable, min, baseLocation,
-        // constraint);
-        // return ceilingLoc;
       }
+
     }
 
-    // return new CompositeLocation(Location.createTopLocation(md));
+  }
 
+  private boolean hasInFlowTo(FlowGraph fg, FlowNode inNode, Set<FlowNode> nodeSet) {
+    // return true if inNode has in-flows to nodeSet
+    Set<FlowNode> reachableSet = fg.getReachableFlowNodeSet(inNode);
+    for (Iterator iterator = reachableSet.iterator(); iterator.hasNext();) {
+      FlowNode fn = (FlowNode) iterator.next();
+      if (nodeSet.contains(fn)) {
+        return true;
+      }
+    }
+    return false;
   }
 
   private NodeTupleSet getNodeTupleSetByArgIdx(MethodInvokeNode min, int idx) {
@@ -1777,7 +2329,7 @@ public class LocationInference {
   }
 
   private void analyzeFlowMethodParameters(MethodDescriptor callermd, SymbolTable nametable,
-      MethodInvokeNode min) {
+      MethodInvokeNode min, NodeTupleSet nodeSet) {
 
     if (min.numArgs() > 0) {
 
@@ -1786,11 +2338,12 @@ public class LocationInference {
         offset = 0;
       } else {
         offset = 1;
-        NTuple<Descriptor> thisArgTuple = new NTuple<Descriptor>();
-        thisArgTuple.add(callermd.getThis());
-        NodeTupleSet argTupleSet = new NodeTupleSet();
-        argTupleSet.addTuple(thisArgTuple);
-        addArgIdxMap(min, 0, argTupleSet);
+        // NTuple<Descriptor> thisArgTuple = new NTuple<Descriptor>();
+        // thisArgTuple.add(callermd.getThis());
+        // NodeTupleSet argTupleSet = new NodeTupleSet();
+        // argTupleSet.addTuple(thisArgTuple);
+        // addArgIdxMap(min, 0, argTupleSet);
+        // nodeSet.addTuple(thisArgTuple);
       }
 
       for (int i = 0; i < min.numArgs(); i++) {
@@ -1799,6 +2352,8 @@ public class LocationInference {
         analyzeFlowExpressionNode(callermd, nametable, en, argTupleSet, false);
         // if argument is liternal node, argTuple is set to NULL.
         addArgIdxMap(min, i + offset, argTupleSet);
+        System.out.println("arg idx=" + (i + offset) + "  argTupleSet=" + argTupleSet);
+        nodeSet.addTupleSet(argTupleSet);
       }
 
     }