X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=Robust%2Fsrc%2FAnalysis%2FSSJava%2FLocationInference.java;h=6594444c987a90ec76aef8c5baf42b6c875cae56;hb=d77839806b116bae81d35232998b6c1ac3ddf23d;hp=ed8bb86dabd44ad91e904851c79fd3e3e7c80260;hpb=91395d24f0facd4c9d37aa9818212c259b60e4c8;p=IRC.git diff --git a/Robust/src/Analysis/SSJava/LocationInference.java b/Robust/src/Analysis/SSJava/LocationInference.java index ed8bb86d..6594444c 100644 --- a/Robust/src/Analysis/SSJava/LocationInference.java +++ b/Robust/src/Analysis/SSJava/LocationInference.java @@ -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; @@ -43,6 +47,7 @@ import IR.Tree.NameNode; import IR.Tree.OpNode; import IR.Tree.ReturnNode; import IR.Tree.SubBlockNode; +import IR.Tree.SwitchBlockNode; import IR.Tree.SwitchStatementNode; import IR.Tree.TertiaryNode; import IR.Tree.TreeNode; @@ -53,10 +58,12 @@ public class LocationInference { State state; SSJavaAnalysis ssjava; - List toanalyzeList; - List toanalyzeMethodList; + List temp_toanalyzeList; + List temp_toanalyzeMethodList; Map mapMethodDescriptorToFlowGraph; + LinkedList toanalyze_methodDescList; + // map a method descriptor to its set of parameter descriptors Map> mapMethodDescriptorToParamDescSet; @@ -69,11 +76,27 @@ public class LocationInference { // map a method descriptor to a method lattice private Map> md2lattice; + // map a method/class descriptor to a hierarchy graph + private Map mapDescriptorToHierarchyGraph; + + // map a method/class descriptor to a skeleton hierarchy graph + private Map mapDescriptorToSkeletonHierarchyGraph; + + private Map mapDescriptorToSimpleHierarchyGraph; + + // map a method/class descriptor to a skeleton hierarchy graph with combination nodes + private Map mapDescriptorToCombineSkeletonHierarchyGraph; + + // map a descriptor to a simple lattice + private Map> mapDescriptorToSimpleLattice; + // map a method descriptor to the set of method invocation nodes which are // invoked by the method descriptor private Map> mapMethodDescriptorToMethodInvokeNodeSet; - private Map> mapMethodInvokeNodeToArgIdxMap; + private Map>> mapMethodInvokeNodeToArgIdxMap; + + private Map> mapMethodInvokeNodeToBaseTuple; private Map mapMethodDescToMethodLocationInfo; @@ -81,23 +104,55 @@ public class LocationInference { private Map> mapMethodToCalleeSet; + private Map> mapMethodDescToParamNodeFlowsToReturnValue; + + private Map> mapFileNameToLineVector; + + private Map mapDescToDefinitionLine; + + private Map mapDescToLocationSummary; + + // maps a method descriptor to a sub global flow graph that captures all value flows caused by the + // set of callees reachable from the method + private Map mapMethodDescriptorToSubGlobalFlowGraph; + + private Map, NTuple>> mapMethodInvokeNodeToMapCallerArgToCalleeArg; + public static final String GLOBALLOC = "GLOBALLOC"; - public static final String TOPLOC = "TOPLOC"; + public static final String INTERLOC = "INTERLOC"; + + public static final String PCLOC = "_PCLOC_"; + + public static final String RLOC = "_RLOC_"; public static final Descriptor GLOBALDESC = new NameDescriptor(GLOBALLOC); - public static final Descriptor TOPDESC = new NameDescriptor(TOPLOC); + public static final Descriptor TOPDESC = new NameDescriptor(SSJavaAnalysis.TOP); + + public static final Descriptor BOTTOMDESC = new NameDescriptor(SSJavaAnalysis.BOTTOM); + + public static final Descriptor RETURNLOC = new NameDescriptor(RLOC); + + public static final Descriptor LITERALDESC = new NameDescriptor("LITERAL"); + + public static final HNode TOPHNODE = new HNode(TOPDESC); + + public static final HNode BOTTOMHNODE = new HNode(BOTTOMDESC); + + public static String newline = System.getProperty("line.separator"); LocationInfo curMethodInfo; boolean debug = true; + public static int locSeed = 0; + public LocationInference(SSJavaAnalysis ssjava, State state) { this.ssjava = ssjava; this.state = state; - this.toanalyzeList = new ArrayList(); - this.toanalyzeMethodList = new ArrayList(); + this.temp_toanalyzeList = new ArrayList(); + this.temp_toanalyzeMethodList = new ArrayList(); this.mapMethodDescriptorToFlowGraph = new HashMap(); this.cd2lattice = new HashMap>(); this.md2lattice = new HashMap>(); @@ -105,29 +160,51 @@ public class LocationInference { this.mapMethodDescriptorToMethodInvokeNodeSet = new HashMap>(); this.mapMethodInvokeNodeToArgIdxMap = - new HashMap>(); + new HashMap>>(); this.mapMethodDescToMethodLocationInfo = new HashMap(); this.mapMethodToCalleeSet = new HashMap>(); this.mapClassToLocationInfo = new HashMap(); + + this.mapFileNameToLineVector = new HashMap>(); + this.mapDescToDefinitionLine = new HashMap(); + this.mapMethodDescToParamNodeFlowsToReturnValue = + new HashMap>(); + + this.mapDescriptorToHierarchyGraph = new HashMap(); + this.mapMethodInvokeNodeToBaseTuple = new HashMap>(); + + this.mapDescriptorToSkeletonHierarchyGraph = new HashMap(); + this.mapDescriptorToCombineSkeletonHierarchyGraph = new HashMap(); + this.mapDescriptorToSimpleHierarchyGraph = new HashMap(); + + this.mapDescriptorToSimpleLattice = new HashMap>(); + + this.mapDescToLocationSummary = new HashMap(); + + this.mapMethodDescriptorToSubGlobalFlowGraph = new HashMap(); + + this.mapMethodInvokeNodeToMapCallerArgToCalleeArg = + new HashMap, NTuple>>(); + } public void setupToAnalyze() { SymbolTable classtable = state.getClassSymbolTable(); - toanalyzeList.clear(); - toanalyzeList.addAll(classtable.getValueSet()); - Collections.sort(toanalyzeList, new Comparator() { - public int compare(ClassDescriptor o1, ClassDescriptor o2) { - return o1.getClassName().compareToIgnoreCase(o2.getClassName()); - } - }); + temp_toanalyzeList.clear(); + temp_toanalyzeList.addAll(classtable.getValueSet()); + // Collections.sort(toanalyzeList, new Comparator() { + // public int compare(ClassDescriptor o1, ClassDescriptor o2) { + // return o1.getClassName().compareToIgnoreCase(o2.getClassName()); + // } + // }); } public void setupToAnalazeMethod(ClassDescriptor cd) { SymbolTable methodtable = cd.getMethodTable(); - toanalyzeMethodList.clear(); - toanalyzeMethodList.addAll(methodtable.getValueSet()); - Collections.sort(toanalyzeMethodList, new Comparator() { + temp_toanalyzeMethodList.clear(); + temp_toanalyzeMethodList.addAll(methodtable.getValueSet()); + Collections.sort(temp_toanalyzeMethodList, new Comparator() { public int compare(MethodDescriptor o1, MethodDescriptor o2) { return o1.getSymbol().compareToIgnoreCase(o2.getSymbol()); } @@ -135,1101 +212,3372 @@ public class LocationInference { } public boolean toAnalyzeMethodIsEmpty() { - return toanalyzeMethodList.isEmpty(); + return temp_toanalyzeMethodList.isEmpty(); } public boolean toAnalyzeIsEmpty() { - return toanalyzeList.isEmpty(); + return temp_toanalyzeList.isEmpty(); } public ClassDescriptor toAnalyzeNext() { - return toanalyzeList.remove(0); + return temp_toanalyzeList.remove(0); } public MethodDescriptor toAnalyzeMethodNext() { - return toanalyzeMethodList.remove(0); + return temp_toanalyzeMethodList.remove(0); } public void inference() { - // 1) construct value flow graph + ssjava.init(); + + // construct value flow graph constructFlowGraph(); - // 2) construct lattices - inferLattices(); + assignCompositeLocation(); - simplifyLattices(); + // calculate RETURNLOC,PCLOC + calculateExtraLocations(); - debug_writeLatticeDotFile(); + _debug_writeFlowGraph(); - // 3) check properties - checkLattices(); + // System.exit(0); - } + constructHierarchyGraph(); - private void simplifyLattices() { + debug_writeHierarchyDotFiles(); - // generate lattice dot file - setupToAnalyze(); + simplifyHierarchyGraph(); - while (!toAnalyzeIsEmpty()) { - ClassDescriptor cd = toAnalyzeNext(); + debug_writeSimpleHierarchyDotFiles(); - setupToAnalazeMethod(cd); + constructSkeletonHierarchyGraph(); - SSJavaLattice classLattice = cd2lattice.get(cd); - if (classLattice != null) { - classLattice.removeRedundantEdges(); - } + debug_writeSkeletonHierarchyDotFiles(); - while (!toAnalyzeMethodIsEmpty()) { - MethodDescriptor md = toAnalyzeMethodNext(); - if (ssjava.needTobeAnnotated(md)) { - SSJavaLattice methodLattice = md2lattice.get(md); - if (methodLattice != null) { - methodLattice.removeRedundantEdges(); - } - } - } - } + insertCombinationNodes(); - } + debug_writeSkeletonCombinationHierarchyDotFiles(); - private void checkLattices() { + buildLattice(); - LinkedList descriptorListToAnalyze = ssjava.getSortedDescriptors(); + debug_writeLattices(); - // current descriptors to visit in fixed-point interprocedural analysis, - // prioritized by - // dependency in the call graph - methodDescriptorsToVisitStack.clear(); + updateCompositeLocationAssignments(); - descriptorListToAnalyze.removeFirst(); + generateMethodSummary(); - Set methodDescriptorToVistSet = new HashSet(); - methodDescriptorToVistSet.addAll(descriptorListToAnalyze); + generateAnnoatedCode(); - while (!descriptorListToAnalyze.isEmpty()) { - MethodDescriptor md = descriptorListToAnalyze.removeFirst(); - checkLatticesOfVirtualMethods(md); + System.exit(0); + + } + + public Map, NTuple> getMapCallerArgToCalleeParam( + MethodInvokeNode min) { + + if (!mapMethodInvokeNodeToMapCallerArgToCalleeArg.containsKey(min)) { + mapMethodInvokeNodeToMapCallerArgToCalleeArg.put(min, + new HashMap, NTuple>()); } + return mapMethodInvokeNodeToMapCallerArgToCalleeArg.get(min); } - private void debug_writeLatticeDotFile() { - // generate lattice dot file + public void addMapCallerArgToCalleeParam(MethodInvokeNode min, NTuple callerArg, + NTuple calleeParam) { + getMapCallerArgToCalleeParam(min).put(callerArg, calleeParam); + } - setupToAnalyze(); + private void assignCompositeLocation() { + calculateGlobalValueFlowCompositeLocation(); + translateCompositeLocationAssignmentToFlowGraph(); + } - while (!toAnalyzeIsEmpty()) { - ClassDescriptor cd = toAnalyzeNext(); + private void translateCompositeLocationAssignmentToFlowGraph() { + System.out.println("\nSSJAVA: Translate composite location assignments to flow graphs:"); + MethodDescriptor methodEventLoopDesc = ssjava.getMethodContainingSSJavaLoop(); + translateCompositeLocationAssignmentToFlowGraph(methodEventLoopDesc); + } - setupToAnalazeMethod(cd); + private void updateCompositeLocationAssignments() { - SSJavaLattice classLattice = cd2lattice.get(cd); - if (classLattice != null) { - ssjava.writeLatticeDotFile(cd, null, classLattice); - debug_printDescriptorToLocNameMapping(cd); + LinkedList methodDescList = + (LinkedList) toanalyze_methodDescList.clone(); + + while (!methodDescList.isEmpty()) { + MethodDescriptor md = methodDescList.removeLast(); + + System.out.println("\n#updateCompositeLocationAssignments=" + md); + + FlowGraph flowGraph = getFlowGraph(md); + + MethodSummary methodSummary = getMethodSummary(md); + + Set nodeSet = flowGraph.getNodeSet(); + for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + FlowNode node = (FlowNode) iterator.next(); + System.out.println("-node=" + node + " node.getDescTuple=" + node.getDescTuple()); + if (node.getCompositeLocation() != null) { + CompositeLocation compLoc = node.getCompositeLocation(); + CompositeLocation updatedCompLoc = updateCompositeLocation(compLoc); + node.setCompositeLocation(updatedCompLoc); + System.out.println("---updatedCompLoc1=" + updatedCompLoc); + } else { + NTuple descTuple = node.getDescTuple(); + System.out.println("update desc=" + descTuple); + CompositeLocation compLoc = convertToCompositeLocation(md, descTuple); + compLoc = updateCompositeLocation(compLoc); + node.setCompositeLocation(compLoc); + System.out.println("---updatedCompLoc2=" + compLoc); + } + + if (node.isDeclaratonNode()) { + Descriptor localVarDesc = node.getDescTuple().get(0); + CompositeLocation compLoc = updateCompositeLocation(node.getCompositeLocation()); + methodSummary.addMapVarNameToInferCompLoc(localVarDesc, compLoc); + } } - while (!toAnalyzeMethodIsEmpty()) { - MethodDescriptor md = toAnalyzeMethodNext(); - if (ssjava.needTobeAnnotated(md)) { - SSJavaLattice methodLattice = md2lattice.get(md); - if (methodLattice != null) { - ssjava.writeLatticeDotFile(cd, md, methodLattice); - debug_printDescriptorToLocNameMapping(md); + // update PCLOC and RETURNLOC if they have a composite location assignment + if (methodSummary.getRETURNLoc() != null) { + methodSummary.setRETURNLoc(updateCompositeLocation(methodSummary.getRETURNLoc())); + } + if (methodSummary.getPCLoc() != null) { + methodSummary.setPCLoc(updateCompositeLocation(methodSummary.getPCLoc())); + } + + } + + } + + private CompositeLocation updateCompositeLocation(CompositeLocation compLoc) { + CompositeLocation updatedCompLoc = new CompositeLocation(); + for (int i = 0; i < compLoc.getSize(); i++) { + Location loc = compLoc.get(i); + String nodeIdentifier = loc.getLocIdentifier(); + Descriptor enclosingDesc = loc.getDescriptor(); + String locName; + if (!enclosingDesc.equals(GLOBALDESC)) { + LocationSummary locSummary = getLocationSummary(enclosingDesc); + HierarchyGraph scGraph = getSkeletonCombinationHierarchyGraph(enclosingDesc); + if (scGraph != null) { + HNode curNode = scGraph.getCurrentHNode(nodeIdentifier); + if (curNode != null) { + nodeIdentifier = curNode.getName(); } } + locName = locSummary.getLocationName(nodeIdentifier); + } else { + locName = nodeIdentifier; } + Location updatedLoc = new Location(enclosingDesc, locName); + updatedCompLoc.addLocation(updatedLoc); } + return updatedCompLoc; } - private void debug_printDescriptorToLocNameMapping(Descriptor desc) { + private void translateCompositeLocationAssignmentToFlowGraph(MethodDescriptor mdCaller) { - LocationInfo info = getLocationInfo(desc); - System.out.println("## " + desc + " ##"); - System.out.println(info.getMapDescToInferLocation()); - LocationInfo locInfo = getLocationInfo(desc); - System.out.println("mapping=" + locInfo.getMapLocSymbolToDescSet()); - System.out.println("###################"); + // First, assign a composite location to a node in the flow graph + GlobalFlowGraph callerGlobalFlowGraph = getSubGlobalFlowGraph(mdCaller); - } + FlowGraph callerFlowGraph = getFlowGraph(mdCaller); + Map callerMapLocToCompLoc = + callerGlobalFlowGraph.getMapLocationToInferCompositeLocation(); + Set methodLocSet = callerMapLocToCompLoc.keySet(); + for (Iterator iterator = methodLocSet.iterator(); iterator.hasNext();) { + Location methodLoc = (Location) iterator.next(); + if (methodLoc.getDescriptor().equals(mdCaller)) { + CompositeLocation inferCompLoc = callerMapLocToCompLoc.get(methodLoc); + assignCompositeLocationToFlowGraph(callerFlowGraph, methodLoc, inferCompLoc); + } + } - private void inferLattices() { + Set minSet = mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller); - // do fixed-point analysis + Set calleeSet = new HashSet(); + for (Iterator iterator = minSet.iterator(); iterator.hasNext();) { + MethodInvokeNode min = (MethodInvokeNode) iterator.next(); + // need to translate a composite location that is started with the base + // tuple of 'min'. + translateMapLocationToInferCompositeLocationToCalleeGraph(callerGlobalFlowGraph, min); + calleeSet.add(min.getMethod()); + } - LinkedList descriptorListToAnalyze = ssjava.getSortedDescriptors(); + for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) { + MethodDescriptor callee = (MethodDescriptor) iterator.next(); + translateCompositeLocationAssignmentToFlowGraph(callee); + } - Collections.sort(descriptorListToAnalyze, new Comparator() { - public int compare(MethodDescriptor o1, MethodDescriptor o2) { - return o1.getSymbol().compareToIgnoreCase(o2.getSymbol()); + } + + public void assignCompositeLocationToFlowGraph(FlowGraph flowGraph, Location loc, + CompositeLocation inferCompLoc) { + Descriptor localDesc = loc.getLocDescriptor(); + + Set nodeSet = flowGraph.getNodeSet(); + for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + FlowNode node = (FlowNode) iterator.next(); + if (node.getDescTuple().startsWith(localDesc) + && !node.getDescTuple().get(0).equals(LITERALDESC)) { + // need to assign the inferred composite location to this node + CompositeLocation newCompLoc = generateCompositeLocation(node.getDescTuple(), inferCompLoc); + node.setCompositeLocation(newCompLoc); + System.out.println("SET Node=" + node + " inferCompLoc=" + newCompLoc); } - }); + } + } - // current descriptors to visit in fixed-point interprocedural analysis, - // prioritized by - // dependency in the call graph - methodDescriptorsToVisitStack.clear(); + private CompositeLocation generateCompositeLocation(NTuple nodeDescTuple, + CompositeLocation inferCompLoc) { - descriptorListToAnalyze.removeFirst(); + System.out.println("generateCompositeLocation=" + nodeDescTuple + " with inferCompLoc=" + + inferCompLoc); - Set methodDescriptorToVistSet = new HashSet(); - methodDescriptorToVistSet.addAll(descriptorListToAnalyze); + CompositeLocation newCompLoc = new CompositeLocation(); + for (int i = 0; i < inferCompLoc.getSize(); i++) { + newCompLoc.addLocation(inferCompLoc.get(i)); + } - while (!descriptorListToAnalyze.isEmpty()) { - MethodDescriptor md = descriptorListToAnalyze.removeFirst(); - methodDescriptorsToVisitStack.add(md); + Descriptor lastDescOfPrefix = nodeDescTuple.get(0); + Descriptor enclosingDescriptor; + if (lastDescOfPrefix instanceof InterDescriptor) { + enclosingDescriptor = null; + } else { + enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc(); } - // analyze scheduled methods until there are no more to visit - while (!methodDescriptorsToVisitStack.isEmpty()) { - // start to analyze leaf node - MethodDescriptor md = methodDescriptorsToVisitStack.pop(); + for (int i = 1; i < nodeDescTuple.size(); i++) { + Descriptor desc = nodeDescTuple.get(i); + Location locElement = new Location(enclosingDescriptor, desc); + newCompLoc.addLocation(locElement); - SSJavaLattice methodLattice = - new SSJavaLattice(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM); + enclosingDescriptor = ((FieldDescriptor) desc).getClassDescriptor(); + } - MethodLocationInfo methodInfo = new MethodLocationInfo(md); - curMethodInfo = methodInfo; + return newCompLoc; + } - System.out.println(); - System.out.println("SSJAVA: Inferencing the lattice from " + md); + private void translateMapLocationToInferCompositeLocationToCalleeGraph( + GlobalFlowGraph callerGraph, MethodInvokeNode min) { - try { - analyzeMethodLattice(md, methodLattice, methodInfo); - } catch (CyclicFlowException e) { - throw new Error("Fail to generate the method lattice for " + md); - } + MethodDescriptor mdCallee = min.getMethod(); + MethodDescriptor mdCaller = callerGraph.getMethodDescriptor(); + Map callerMapLocToCompLoc = + callerGraph.getMapLocationToInferCompositeLocation(); - SSJavaLattice prevMethodLattice = getMethodLattice(md); - MethodLocationInfo prevMethodInfo = getMethodLocationInfo(md); + FlowGraph calleeFlowGraph = getFlowGraph(mdCallee); + GlobalFlowGraph calleeGlobalGraph = getSubGlobalFlowGraph(mdCallee); - if ((!methodLattice.equals(prevMethodLattice)) || (!methodInfo.equals(prevMethodInfo))) { + NTuple baseLocTuple = null; + if (mapMethodInvokeNodeToBaseTuple.containsKey(min)) { + baseLocTuple = translateToLocTuple(mdCaller, mapMethodInvokeNodeToBaseTuple.get(min)); + } - setMethodLattice(md, methodLattice); - setMethodLocInfo(md, methodInfo); + // System.out.println("\n-translate caller infer composite loc to callee=" + mdCallee + // + " baseLocTuple=" + baseLocTuple); + Set keySet = callerMapLocToCompLoc.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Location key = (Location) iterator.next(); + CompositeLocation callerCompLoc = callerMapLocToCompLoc.get(key); - // results for callee changed, so enqueue dependents caller for - // further analysis - Iterator depsItr = ssjava.getDependents(md).iterator(); - while (depsItr.hasNext()) { - MethodDescriptor methodNext = depsItr.next(); - if (!methodDescriptorsToVisitStack.contains(methodNext) - && methodDescriptorToVistSet.contains(methodNext)) { - methodDescriptorsToVisitStack.add(methodNext); - } - } + if (!key.getDescriptor().equals(mdCaller)) { - } + CompositeLocation newCalleeCompLoc; + if (baseLocTuple != null && callerCompLoc.getTuple().startsWith(baseLocTuple)) { + // System.out.println("---need to translate callerCompLoc=" + callerCompLoc + // + " with baseTuple=" + baseLocTuple); + newCalleeCompLoc = + translateCompositeLocationToCallee(callerCompLoc, baseLocTuple, mdCallee); - } - } + calleeGlobalGraph.addMapLocationToInferCompositeLocation(key, newCalleeCompLoc); + // System.out.println("---callee loc=" + key + " newCalleeCompLoc=" + newCalleeCompLoc); + } else { + // check if it is the global access + Location compLocFirstElement = callerCompLoc.getTuple().get(0); + if (compLocFirstElement.getDescriptor().equals(mdCallee) + && compLocFirstElement.getLocDescriptor().equals(GLOBALDESC)) { - private void setMethodLocInfo(MethodDescriptor md, MethodLocationInfo methodInfo) { - mapMethodDescToMethodLocationInfo.put(md, methodInfo); - } + newCalleeCompLoc = new CompositeLocation(); + Location newMethodLoc = new Location(mdCallee, GLOBALDESC); - private void checkLatticesOfVirtualMethods(MethodDescriptor md) { + newCalleeCompLoc.addLocation(newMethodLoc); + for (int i = 1; i < callerCompLoc.getSize(); i++) { + newCalleeCompLoc.addLocation(callerCompLoc.get(i)); + } + calleeGlobalGraph.addMapLocationToInferCompositeLocation(key, newCalleeCompLoc); - if (!md.isStatic()) { - Set setPossibleCallees = new HashSet(); - setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md)); + } - for (Iterator iterator = setPossibleCallees.iterator(); iterator.hasNext();) { - MethodDescriptor mdCallee = (MethodDescriptor) iterator.next(); - if (!md.equals(mdCallee)) { - checkConsistency(md, mdCallee); } - } + } } - } - - private void checkConsistency(MethodDescriptor md1, MethodDescriptor md2) { + // System.out.println("-----*AFTER TRANSLATING COMP LOC MAPPING, CALLEE MAPPING=" + // + calleeGlobalGraph.getMapLocationToInferCompositeLocation()); - // check that two lattice have the same relations between parameters(+PC - // LOC, GLOBAL_LOC RETURN LOC) + // If the location of an argument has a composite location + // need to assign a proper composite location to the corresponding callee parameter + // System.out.println("---translate arg composite location to callee param. min=" + // + min.printNode(0)); + Map> mapIdxToArgTuple = mapMethodInvokeNodeToArgIdxMap.get(min); + Set idxSet = mapIdxToArgTuple.keySet(); + for (Iterator iterator = idxSet.iterator(); iterator.hasNext();) { + Integer idx = (Integer) iterator.next(); - List list1 = new ArrayList(); - List list2 = new ArrayList(); + if (idx == 0 && !min.getMethod().isStatic()) { + continue; + } - MethodLocationInfo locInfo1 = getMethodLocationInfo(md1); - MethodLocationInfo locInfo2 = getMethodLocationInfo(md2); + NTuple argTuple = mapIdxToArgTuple.get(idx); + if (argTuple.size() > 0) { + // check if an arg tuple has been already assigned to a composite location + NTuple argLocTuple = translateToLocTuple(mdCaller, argTuple); + Location argLocalLoc = argLocTuple.get(0); - Map paramMap1 = locInfo1.getMapParamIdxToInferLoc(); - Map paramMap2 = locInfo2.getMapParamIdxToInferLoc(); + // if (!isPrimitiveType(argTuple)) { + if (callerMapLocToCompLoc.containsKey(argLocalLoc)) { - int numParam = locInfo1.getMapParamIdxToInferLoc().keySet().size(); + CompositeLocation callerCompLoc = callerMapLocToCompLoc.get(argLocalLoc); + for (int i = 1; i < argLocTuple.size(); i++) { + callerCompLoc.addLocation(argLocTuple.get(i)); + } - // add location types of paramters - for (int idx = 0; idx < numParam; idx++) { - list1.add(paramMap1.get(Integer.valueOf(idx))); - list2.add(paramMap2.get(Integer.valueOf(idx))); - } + if (baseLocTuple != null && callerCompLoc.getTuple().startsWith(baseLocTuple)) { - // add program counter location - list1.add(locInfo1.getPCLoc()); - list2.add(locInfo2.getPCLoc()); + FlowNode calleeParamFlowNode = calleeFlowGraph.getParamFlowNode(idx); + NTuple calleeParamDescTuple = calleeParamFlowNode.getDescTuple(); + NTuple calleeParamLocTuple = + translateToLocTuple(mdCallee, calleeParamDescTuple); - if (!md1.getReturnType().isVoid()) { - // add return value location - CompositeLocation rtrLoc1 = - new CompositeLocation(new Location(md1, locInfo1.getReturnLocName())); - CompositeLocation rtrLoc2 = - new CompositeLocation(new Location(md2, locInfo2.getReturnLocName())); - list1.add(rtrLoc1); - list2.add(rtrLoc2); - } + System.out.println("---need to translate callerCompLoc=" + callerCompLoc + + " with baseTuple=" + baseLocTuple + " calleeParamLocTuple=" + + calleeParamLocTuple); - // add global location type - if (md1.isStatic()) { - CompositeLocation globalLoc1 = - new CompositeLocation(new Location(md1, locInfo1.getGlobalLocName())); - CompositeLocation globalLoc2 = - new CompositeLocation(new Location(md2, locInfo2.getGlobalLocName())); - list1.add(globalLoc1); - list2.add(globalLoc2); - } + CompositeLocation newCalleeCompLoc = + translateCompositeLocationToCallee(callerCompLoc, baseLocTuple, mdCallee); - for (int i = 0; i < list1.size(); i++) { - CompositeLocation locA1 = list1.get(i); - CompositeLocation locA2 = list2.get(i); - for (int k = 0; k < list1.size(); k++) { - if (i != k) { - CompositeLocation locB1 = list1.get(k); - CompositeLocation locB2 = list2.get(k); - boolean r1 = isGreaterThan(getLattice(md1), locA1, locB1); + calleeGlobalGraph.addMapLocationToInferCompositeLocation(calleeParamLocTuple.get(0), + newCalleeCompLoc); - boolean r2 = isGreaterThan(getLattice(md1), locA2, locB2); + System.out.println("---callee loc=" + calleeParamLocTuple.get(0) + + " newCalleeCompLoc=" + newCalleeCompLoc); - if (r1 != r2) { - throw new Error("The method " + md1 + " is not consistent with the method " + md2 - + ".:: They have a different ordering relation between locations (" + locA1 + "," - + locB1 + ") and (" + locA2 + "," + locB2 + ")."); + // System.out.println("###need to assign composite location to=" + calleeParamDescTuple + // + " with baseTuple=" + baseLocTuple); } + } } + } } - private String getSymbol(int idx, FlowNode node) { - Descriptor desc = node.getDescTuple().get(idx); - return desc.getSymbol(); - } + private boolean isPrimitiveType(NTuple argTuple) { - private Descriptor getDescriptor(int idx, FlowNode node) { - Descriptor desc = node.getDescTuple().get(idx); - return desc; + Descriptor lastDesc = argTuple.get(argTuple.size() - 1); + + if (lastDesc instanceof FieldDescriptor) { + return ((FieldDescriptor) lastDesc).getType().isPrimitive(); + } else if (lastDesc instanceof VarDescriptor) { + return ((VarDescriptor) lastDesc).getType().isPrimitive(); + } + + return true; } - private void analyzeMethodLattice(MethodDescriptor md, SSJavaLattice methodLattice, - MethodLocationInfo methodInfo) throws CyclicFlowException { + private CompositeLocation translateCompositeLocationToCallee(CompositeLocation callerCompLoc, + NTuple baseLocTuple, MethodDescriptor mdCallee) { - // first take a look at method invocation nodes to newly added relations - // from the callee - analyzeLatticeMethodInvocationNode(md, methodLattice, methodInfo); + CompositeLocation newCalleeCompLoc = new CompositeLocation(); - if (!md.isStatic()) { - // set the this location - String thisLocSymbol = md.getThis().getSymbol(); - methodInfo.setThisLocName(thisLocSymbol); + Location calleeThisLoc = new Location(mdCallee, mdCallee.getThis()); + newCalleeCompLoc.addLocation(calleeThisLoc); + + // remove the base tuple from the caller + // ex; In the method invoation foo.bar.methodA(), the callee will have the composite location + // ,which is relative to the 'this' variable, + for (int i = baseLocTuple.size(); i < callerCompLoc.getSize(); i++) { + newCalleeCompLoc.addLocation(callerCompLoc.get(i)); } - // set the global location - methodInfo.setGlobalLocName(LocationInference.GLOBALLOC); - methodInfo.mapDescriptorToLocation(GLOBALDESC, new CompositeLocation( - new Location(md, GLOBALLOC))); + return newCalleeCompLoc; - // visit each node of method flow graph - FlowGraph fg = getFlowGraph(md); - Set nodeSet = fg.getNodeSet(); + } - // for the method lattice, we need to look at the first element of - // NTuple - for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { - FlowNode srcNode = (FlowNode) iterator.next(); + private void calculateGlobalValueFlowCompositeLocation() { - Set outEdgeSet = srcNode.getOutEdgeSet(); - for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) { - FlowEdge outEdge = (FlowEdge) iterator2.next(); - FlowNode dstNode = outEdge.getDst(); + System.out.println("SSJAVA: Calculate composite locations in the global value flow graph"); + MethodDescriptor methodDescEventLoop = ssjava.getMethodContainingSSJavaLoop(); + GlobalFlowGraph globalFlowGraph = getSubGlobalFlowGraph(methodDescEventLoop); - NTuple srcNodeTuple = srcNode.getDescTuple(); - NTuple dstNodeTuple = dstNode.getDescTuple(); + Set calculatedPrefixSet = new HashSet(); - if (outEdge.getInitTuple().equals(srcNodeTuple) - && outEdge.getEndTuple().equals(dstNodeTuple)) { + Set nodeSet = globalFlowGraph.getNodeSet(); - if ((srcNodeTuple.size() > 1 && dstNodeTuple.size() > 1) - && srcNodeTuple.get(0).equals(dstNodeTuple.get(0))) { + next: for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + GlobalFlowNode node = (GlobalFlowNode) iterator.next(); - // value flows between fields - Descriptor desc = srcNodeTuple.get(0); - ClassDescriptor classDesc; + Location prefixLoc = node.getLocTuple().get(0); - if (desc.equals(GLOBALDESC)) { - classDesc = md.getClassDesc(); - } else { - VarDescriptor varDesc = (VarDescriptor) srcNodeTuple.get(0); - classDesc = varDesc.getType().getClassDesc(); - } - - extractRelationFromFieldFlows(classDesc, srcNode, dstNode, 1); - - } else if (srcNodeTuple.size() == 1 || dstNodeTuple.size() == 1) { - // for the method lattice, we need to look at the first element of - // NTuple - // in this case, take a look at connected nodes at the local level - addRelationToLattice(md, methodLattice, methodInfo, srcNode, dstNode); - } else { - - if (!srcNode.getDescTuple().get(0).equals(dstNode.getDescTuple().get(0))) { - // in this case, take a look at connected nodes at the local level - addRelationToLattice(md, methodLattice, methodInfo, srcNode, dstNode); - } else { - Descriptor srcDesc = srcNode.getDescTuple().get(0); - Descriptor dstDesc = dstNode.getDescTuple().get(0); - recursivelyAddCompositeRelation(md, fg, methodInfo, srcNode, dstNode, srcDesc, - dstDesc); - // recursiveAddRelationToLattice(1, md, srcNode, dstNode); - } - } - - } + if (calculatedPrefixSet.contains(prefixLoc)) { + // the prefix loc has been already assigned to a composite location + continue; } - } - - // create mapping from param idx to inferred composite location - int offset; - if (!md.isStatic()) { - // add 'this' reference location - offset = 1; - methodInfo.addMapParamIdxToInferLoc(0, methodInfo.getInferLocation(md.getThis())); - } else { - offset = 0; - } + calculatedPrefixSet.add(prefixLoc); - for (int idx = 0; idx < md.numParameters(); idx++) { - Descriptor paramDesc = md.getParameter(idx); - CompositeLocation inferParamLoc = methodInfo.getInferLocation(paramDesc); - methodInfo.addMapParamIdxToInferLoc(idx + offset, inferParamLoc); - } + // Set incomingNodeSet = globalFlowGraph.getIncomingNodeSet(node); + List> prefixList = calculatePrefixList(globalFlowGraph, node); - // calculate the initial program counter location - // PC location is higher than location types of all parameters - String pcLocSymbol = "PCLOC"; - Map mapParamToLoc = methodInfo.getMapParamIdxToInferLoc(); - Set 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); - } - } + Set reachableNodeSet = + globalFlowGraph.getReachableNodeSetByPrefix(node.getLocTuple().get(0)); + // Set reachNodeSet = globalFlowGraph.getReachableNodeSetFrom(node); - // calculate a return location - // the return location type is lower than all parameters - if (!md.getReturnType().isVoid()) { + // System.out.println("node=" + node + " prefixList=" + prefixList + " reachableNodeSet=" + // + reachableNodeSet); - String returnLocSymbol = "RETURNLOC"; + for (int i = 0; i < prefixList.size(); i++) { + NTuple curPrefix = prefixList.get(i); + Set> reachableCommonPrefixSet = new HashSet>(); - 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 iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) { + GlobalFlowNode reachNode = (GlobalFlowNode) iterator2.next(); + if (reachNode.getLocTuple().startsWith(curPrefix)) { + reachableCommonPrefixSet.add(reachNode.getLocTuple()); + } } - } - } - } + if (!reachableCommonPrefixSet.isEmpty()) { - private boolean isGreaterThan(SSJavaLattice methodLattice, CompositeLocation comp1, - CompositeLocation comp2) { + MethodDescriptor curPrefixFirstElementMethodDesc = + (MethodDescriptor) curPrefix.get(0).getDescriptor(); - int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize(); + MethodDescriptor nodePrefixLocFirstElementMethodDesc = + (MethodDescriptor) prefixLoc.getDescriptor(); - for (int idx = 0; idx < size; idx++) { - Location loc1 = comp1.get(idx); - Location loc2 = comp2.get(idx); + if (curPrefixFirstElementMethodDesc.equals(nodePrefixLocFirstElementMethodDesc) + || isTransitivelyCalledFrom(nodePrefixLocFirstElementMethodDesc, + curPrefixFirstElementMethodDesc)) { - Descriptor desc1 = loc1.getDescriptor(); - Descriptor desc2 = loc2.getDescriptor(); + // TODO + // if (!node.getLocTuple().startsWith(curPrefix.get(0))) { - if (!desc1.equals(desc2)) { - throw new Error("Fail to compare " + comp1 + " and " + comp2); - } + Location curPrefixLocalLoc = curPrefix.get(0); + if (globalFlowGraph.mapLocationToInferCompositeLocation.containsKey(curPrefixLocalLoc)) { + // in this case, the local variable of the current prefix has already got a composite + // location + // so we just ignore the current composite location. - String symbol1 = loc1.getLocIdentifier(); - String symbol2 = loc2.getLocIdentifier(); + // System.out.println("HERE WE DO NOT ASSIGN A COMPOSITE LOCATION TO =" + node + // + " DUE TO " + curPrefix); - SSJavaLattice lattice; - if (idx == 0) { - lattice = methodLattice; - } else { - lattice = getLattice(desc1); - } - if (symbol1.equals(symbol2)) { - continue; - } else if (lattice.isGreaterThan(symbol1, symbol2)) { - return true; - } else { - return false; - } + continue next; + } - } + Location targetLocalLoc = node.getLocTuple().get(0); + // CompositeLocation curCompLoc = globalFlowGraph.getCompositeLocation(targetLocalLoc); + // if ((curPrefix.size() + 1) > curCompLoc.getSize()) { - return false; - } + CompositeLocation newCompLoc = generateCompositeLocation(curPrefix); + System.out.println("NEED TO ASSIGN COMP LOC TO " + node + " with prefix=" + curPrefix); + System.out.println("- newCompLoc=" + newCompLoc); + globalFlowGraph.addMapLocationToInferCompositeLocation(targetLocalLoc, newCompLoc); + // } - private void recursiveAddRelationToLattice(int idx, MethodDescriptor md, - CompositeLocation srcInferLoc, CompositeLocation dstInferLoc) throws CyclicFlowException { + continue next; + // } - String srcLocSymbol = srcInferLoc.get(idx).getLocIdentifier(); - String dstLocSymbol = dstInferLoc.get(idx).getLocIdentifier(); + } - if (srcLocSymbol.equals(dstLocSymbol)) { - recursiveAddRelationToLattice(idx + 1, md, srcInferLoc, dstInferLoc); - } else { + } - Descriptor parentDesc = srcInferLoc.get(idx).getDescriptor(); - LocationInfo locInfo = getLocationInfo(parentDesc); + } - addRelationHigherToLower(getLattice(parentDesc), getLocationInfo(parentDesc), srcLocSymbol, - dstLocSymbol); } + // Set inNodeSet = + // graph.getIncomingNodeSetWithPrefix(prefix); + // System.out.println("inNodeSet=" + inNodeSet + " from=" + node); + } + private void assignCompositeLocation(CompositeLocation compLocPrefix, GlobalFlowNode node) { + CompositeLocation newCompLoc = compLocPrefix.clone(); + NTuple locTuple = node.getLocTuple(); + for (int i = 1; i < locTuple.size(); i++) { + newCompLoc.addLocation(locTuple.get(i)); + } + node.setInferCompositeLocation(newCompLoc); } - private void analyzeLatticeMethodInvocationNode(MethodDescriptor mdCaller, - SSJavaLattice methodLattice, MethodLocationInfo methodInfo) - throws CyclicFlowException { + private List> calculatePrefixList(GlobalFlowGraph graph, GlobalFlowNode node) { - // the transformation for a call site propagates all relations between - // parameters from the callee - // if the method is virtual, it also grab all relations from any possible - // callees + System.out.println("\n##### calculatePrefixList node=" + node); - Set setMethodInvokeNode = - mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller); + Set incomingNodeSetPrefix = + graph.getIncomingNodeSetByPrefix(node.getLocTuple().get(0)); + // System.out.println("incomingNodeSetPrefix=" + incomingNodeSetPrefix); + // + // Set reachableNodeSetPrefix = + // graph.getReachableNodeSetByPrefix(node.getLocTuple().get(0)); + // System.out.println("reachableNodeSetPrefix=" + reachableNodeSetPrefix); - if (setMethodInvokeNode != null) { + List> prefixList = new ArrayList>(); - for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) { - MethodInvokeNode min = (MethodInvokeNode) iterator.next(); - MethodDescriptor mdCallee = min.getMethod(); - Set setPossibleCallees = new HashSet(); - if (mdCallee.isStatic()) { - setPossibleCallees.add(mdCallee); - } else { - Set calleeSet = ssjava.getCallGraph().getMethods(mdCallee); - // removes method descriptors that are not invoked by the caller - calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller)); - setPossibleCallees.addAll(calleeSet); - } + for (Iterator iterator = incomingNodeSetPrefix.iterator(); iterator.hasNext();) { + GlobalFlowNode inNode = (GlobalFlowNode) iterator.next(); + NTuple inNodeTuple = inNode.getLocTuple(); - for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) { - MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next(); - propagateRelationToCaller(min, mdCaller, possibleMdCallee, methodLattice, methodInfo); + for (int i = 1; i < inNodeTuple.size(); i++) { + NTuple prefix = inNodeTuple.subList(0, i); + if (!prefixList.contains(prefix)) { + prefixList.add(prefix); } - } } - } + Collections.sort(prefixList, new Comparator>() { + public int compare(NTuple arg0, NTuple arg1) { + int s0 = arg0.size(); + int s1 = arg1.size(); + if (s0 > s1) { + return -1; + } else if (s0 == s1) { + return 0; + } else { + return 1; + } + } + }); - private void propagateRelationToCaller(MethodInvokeNode min, MethodDescriptor mdCaller, - MethodDescriptor possibleMdCallee, SSJavaLattice methodLattice, - MethodLocationInfo methodInfo) throws CyclicFlowException { + // remove a prefix which is not suitable for generating composite location + Location localVarLoc = node.getLocTuple().get(0); + MethodDescriptor md = (MethodDescriptor) localVarLoc.getDescriptor(); + ClassDescriptor cd = md.getClassDesc(); - SSJavaLattice calleeLattice = getMethodLattice(possibleMdCallee); - MethodLocationInfo calleeLocInfo = getMethodLocationInfo(possibleMdCallee); - FlowGraph calleeFlowGraph = getFlowGraph(possibleMdCallee); + int idx = 0; - int numParam = calleeLocInfo.getNumParam(); - for (int i = 0; i < numParam; i++) { - CompositeLocation param1 = calleeLocInfo.getParamCompositeLocation(i); - for (int k = 0; k < numParam; k++) { - if (i != k) { - CompositeLocation param2 = calleeLocInfo.getParamCompositeLocation(k); - if (isGreaterThan(getLattice(possibleMdCallee), param1, param2)) { - NodeTupleSet argDescTupleSet1 = getNodeTupleSetByArgIdx(min, i); - NodeTupleSet argDescTupleSet2 = getNodeTupleSetByArgIdx(min, k); + Set> toberemoved = new HashSet>(); + for (int i = 0; i < prefixList.size(); i++) { + NTuple prefixLocTuple = prefixList.get(i); + if (!containsClassDesc(cd, prefixLocTuple)) { + toberemoved.add(prefixLocTuple); + } + } - // the callee has the relation in which param1 is higher than param2 - // therefore, the caller has to have the relation in which arg1 is - // higher than arg2 + prefixList.removeAll(toberemoved); - for (Iterator> iterator = argDescTupleSet1.iterator(); iterator - .hasNext();) { - NTuple argDescTuple1 = iterator.next(); + return prefixList; - for (Iterator> iterator2 = argDescTupleSet2.iterator(); iterator2 - .hasNext();) { - NTuple argDescTuple2 = iterator2.next(); + // List> prefixList = new ArrayList>(); + // + // for (Iterator iterator = incomingNodeSet.iterator(); iterator.hasNext();) { + // GlobalFlowNode inNode = (GlobalFlowNode) iterator.next(); + // NTuple inNodeTuple = inNode.getLocTuple(); + // + // for (int i = 1; i < inNodeTuple.size(); i++) { + // NTuple prefix = inNodeTuple.subList(0, i); + // if (!prefixList.contains(prefix)) { + // prefixList.add(prefix); + // } + // } + // } + // + // Collections.sort(prefixList, new Comparator>() { + // public int compare(NTuple arg0, NTuple arg1) { + // int s0 = arg0.size(); + // int s1 = arg1.size(); + // if (s0 > s1) { + // return -1; + // } else if (s0 == s1) { + // return 0; + // } else { + // return 1; + // } + // } + // }); + // return prefixList; + } - // retreive inferred location by the local var descriptor + private boolean containsClassDesc(ClassDescriptor cd, NTuple prefixLocTuple) { + for (int i = 0; i < prefixLocTuple.size(); i++) { + Location loc = prefixLocTuple.get(i); + Descriptor locDesc = loc.getLocDescriptor(); + if (locDesc != null) { + ClassDescriptor type = getClassTypeDescriptor(locDesc); + if (type != null && type.equals(cd)) { + return true; + } + } + } + return false; + } - NTuple tuple1 = getFlowGraph(mdCaller).getLocationTuple(argDescTuple1); - NTuple tuple2 = getFlowGraph(mdCaller).getLocationTuple(argDescTuple2); + private GlobalFlowGraph constructSubGlobalFlowGraph(FlowGraph flowGraph) { - // CompositeLocation higherInferLoc = - // methodInfo.getInferLocation(argTuple1.get(0)); - // CompositeLocation lowerInferLoc = - // methodInfo.getInferLocation(argTuple2.get(0)); + MethodDescriptor md = flowGraph.getMethodDescriptor(); - CompositeLocation inferLoc1 = generateInferredCompositeLocation(methodInfo, tuple1); - CompositeLocation inferLoc2 = generateInferredCompositeLocation(methodInfo, tuple2); + GlobalFlowGraph globalGraph = new GlobalFlowGraph(md); - addRelation(methodLattice, methodInfo, inferLoc1, inferLoc2); + // Set nodeSet = flowGraph.getNodeSet(); + Set edgeSet = flowGraph.getEdgeSet(); - } + for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) { - } + FlowEdge edge = (FlowEdge) iterator.next(); + NTuple srcDescTuple = edge.getInitTuple(); + NTuple dstDescTuple = edge.getEndTuple(); - } - } - } - } + // here only keep the first element(method location) of the descriptor + // tuple + NTuple srcLocTuple = translateToLocTuple(md, srcDescTuple); + // Location srcMethodLoc = srcLocTuple.get(0); + // Descriptor srcVarDesc = srcMethodLoc.getLocDescriptor(); + // // if (flowGraph.isParamDesc(srcVarDesc) && + // (!srcVarDesc.equals(md.getThis()))) { + // if (!srcVarDesc.equals(md.getThis())) { + // srcLocTuple = new NTuple(); + // Location loc = new Location(md, srcVarDesc); + // srcLocTuple.add(loc); + // } + // + NTuple dstLocTuple = translateToLocTuple(md, dstDescTuple); + // Location dstMethodLoc = dstLocTuple.get(0); + // Descriptor dstVarDesc = dstMethodLoc.getLocDescriptor(); + // if (!dstVarDesc.equals(md.getThis())) { + // dstLocTuple = new NTuple(); + // Location loc = new Location(md, dstVarDesc); + // dstLocTuple.add(loc); + // } - } + globalGraph.addValueFlowEdge(srcLocTuple, dstLocTuple); - private CompositeLocation generateInferredCompositeLocation(MethodLocationInfo methodInfo, - NTuple tuple) { + } - // first, retrieve inferred location by the local var descriptor - CompositeLocation inferLoc = new CompositeLocation(); + return globalGraph; + } - CompositeLocation localVarInferLoc = - methodInfo.getInferLocation(tuple.get(0).getLocDescriptor()); + private NTuple translateToLocTuple(MethodDescriptor md, NTuple descTuple) { - for (int i = 0; i < localVarInferLoc.getSize(); i++) { - inferLoc.addLocation(localVarInferLoc.get(i)); - } + NTuple locTuple = new NTuple(); - for (int i = 1; i < tuple.size(); i++) { - Location cur = tuple.get(i); - Descriptor enclosingDesc = cur.getDescriptor(); - Descriptor curDesc = cur.getLocDescriptor(); + Descriptor enclosingDesc = md; + // System.out.println("md=" + md + " descTuple=" + descTuple); + for (int i = 0; i < descTuple.size(); i++) { + Descriptor desc = descTuple.get(i); - String fieldLocSymbol = - getLocationInfo(enclosingDesc).getInferLocation(curDesc).get(0).getLocIdentifier(); - Location inferLocElement = new Location(enclosingDesc, fieldLocSymbol); + Location loc = new Location(enclosingDesc, desc); + locTuple.add(loc); - inferLoc.addLocation(inferLocElement); + if (desc instanceof VarDescriptor) { + enclosingDesc = ((VarDescriptor) desc).getType().getClassDesc(); + } else if (desc instanceof FieldDescriptor) { + enclosingDesc = ((FieldDescriptor) desc).getType().getClassDesc(); + } else { + // TODO: inter descriptor case + enclosingDesc = desc; + } } - return inferLoc; + return locTuple; + } - private void addRelation(SSJavaLattice methodLattice, MethodLocationInfo methodInfo, - CompositeLocation srcInferLoc, CompositeLocation dstInferLoc) throws CyclicFlowException { + private void addValueFlowsFromCalleeSubGlobalFlowGraph(MethodDescriptor mdCaller, + GlobalFlowGraph subGlobalFlowGraph) { - System.out.println("--- srcInferLoc=" + srcInferLoc + " dstInferLoc=" + dstInferLoc); - String srcLocalLocSymbol = srcInferLoc.get(0).getLocIdentifier(); - String dstLocalLocSymbol = dstInferLoc.get(0).getLocIdentifier(); + // the transformation for a call site propagates flows through parameters + // if the method is virtual, it also grab all relations from any possible + // callees - if (srcInferLoc.getSize() == 1 && dstInferLoc.getSize() == 1) { - // add a new relation to the local lattice - addRelationHigherToLower(methodLattice, methodInfo, srcLocalLocSymbol, dstLocalLocSymbol); - } else if (srcInferLoc.getSize() > 1 && dstInferLoc.getSize() > 1) { - // both src and dst have assigned to a composite location + Set setMethodInvokeNode = getMethodInvokeNodeSet(mdCaller); - if (!srcLocalLocSymbol.equals(dstLocalLocSymbol)) { - addRelationHigherToLower(methodLattice, methodInfo, srcLocalLocSymbol, dstLocalLocSymbol); + for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) { + MethodInvokeNode min = (MethodInvokeNode) iterator.next(); + MethodDescriptor mdCallee = min.getMethod(); + Set setPossibleCallees = new HashSet(); + if (mdCallee.isStatic()) { + setPossibleCallees.add(mdCallee); } else { - recursivelyAddRelation(1, srcInferLoc, dstInferLoc); + Set calleeSet = ssjava.getCallGraph().getMethods(mdCallee); + // removes method descriptors that are not invoked by the caller + calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller)); + setPossibleCallees.addAll(calleeSet); } - } else { - // either src or dst has assigned to a composite location - if (!srcLocalLocSymbol.equals(dstLocalLocSymbol)) { - addRelationHigherToLower(methodLattice, methodInfo, srcLocalLocSymbol, dstLocalLocSymbol); + + for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) { + MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next(); + propagateValueFlowsToCallerFromSubGlobalFlowGraph(min, mdCaller, possibleMdCallee); } - } - System.out.println(); + } } - public LocationInfo getLocationInfo(Descriptor d) { - if (d instanceof MethodDescriptor) { - return getMethodLocationInfo((MethodDescriptor) d); - } else { - return getFieldLocationInfo((ClassDescriptor) d); - } - } + private void propagateValueFlowsToCallerFromSubGlobalFlowGraph(MethodInvokeNode min, + MethodDescriptor mdCaller, MethodDescriptor possibleMdCallee) { - private MethodLocationInfo getMethodLocationInfo(MethodDescriptor md) { + System.out.println("---propagate from " + min.printNode(0) + " to caller=" + mdCaller); + FlowGraph calleeFlowGraph = getFlowGraph(possibleMdCallee); + Map> mapIdxToArg = mapMethodInvokeNodeToArgIdxMap.get(min); - if (!mapMethodDescToMethodLocationInfo.containsKey(md)) { - mapMethodDescToMethodLocationInfo.put(md, new MethodLocationInfo(md)); + System.out.println("-----mapMethodInvokeNodeToArgIdxMap.get(min)=" + + mapMethodInvokeNodeToArgIdxMap.get(min)); + Set keySet = mapIdxToArg.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Integer idx = (Integer) iterator.next(); + NTuple argDescTuple = mapIdxToArg.get(idx); + if (argDescTuple.size() > 0) { + NTuple argLocTuple = translateToLocTuple(mdCaller, argDescTuple); + NTuple paramDescTuple = calleeFlowGraph.getParamFlowNode(idx).getDescTuple(); + NTuple paramLocTuple = translateToLocTuple(possibleMdCallee, paramDescTuple); + addMapCallerArgToCalleeParam(min, argDescTuple, paramDescTuple); + } } - return mapMethodDescToMethodLocationInfo.get(md); - - } - - private LocationInfo getFieldLocationInfo(ClassDescriptor cd) { - - if (!mapClassToLocationInfo.containsKey(cd)) { - mapClassToLocationInfo.put(cd, new LocationInfo(cd)); + NTuple baseTuple = mapMethodInvokeNodeToBaseTuple.get(min); + GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(possibleMdCallee); + Set calleeNodeSet = calleeSubGlobalGraph.getNodeSet(); + for (Iterator iterator = calleeNodeSet.iterator(); iterator.hasNext();) { + GlobalFlowNode calleeNode = (GlobalFlowNode) iterator.next(); + addValueFlowFromCalleeNode(min, mdCaller, possibleMdCallee, calleeNode); } - return mapClassToLocationInfo.get(cd); + // int numParam = calleeFlowGraph.getNumParameters(); + // for (int idx = 0; idx < numParam; idx++) { + // + // FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx); + // + // NTuple paramLocTuple = + // translateToLocTuple(possibleMdCallee, paramNode.getCurrentDescTuple()); + // + // GlobalFlowNode globalParamNode = + // calleeSubGlobalGraph.getFlowNode(paramLocTuple); + // + // NTuple argTuple = + // mapMethodInvokeNodeToArgIdxMap.get(min).get(idx); + // + // NTuple argLocTuple = translateToLocTuple(mdCaller, argTuple); + // + // System.out.println("argTupleSet=" + argLocTuple + " param=" + + // paramLocTuple); + // // here, it adds all value flows reachable from the paramNode in the + // callee's flow graph + // + // addValueFlowsFromCalleeParam(mdCaller, argLocTuple, baseLocTuple, + // possibleMdCallee, + // globalParamNode); + // } + // + // // TODO + // // FlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller); + // // FlowGraph calleeSubGlobalGraph = + // getSubGlobalFlowGraph(possibleMdCallee); + // // + // // int numParam = calleeSubGlobalGraph.getNumParameters(); + // // for (int idx = 0; idx < numParam; idx++) { + // // FlowNode paramNode = calleeSubGlobalGraph.getParamFlowNode(idx); + // // NTuple argTuple = + // mapMethodInvokeNodeToArgIdxMap.get(min).get(idx); + // // System.out.println("argTupleSet=" + argTuple + " param=" + + // paramNode); + // // // here, it adds all value flows reachable from the paramNode in the + // callee's flow graph + // // addValueFlowsFromCalleeParam(min, calleeSubGlobalGraph, paramNode, + // callerSubGlobalGraph, + // // argTuple, baseTuple); + // // } } - private void addRelationToLattice(MethodDescriptor md, SSJavaLattice methodLattice, - MethodLocationInfo methodInfo, FlowNode srcNode, FlowNode dstNode) throws CyclicFlowException { + private void addValueFlowFromCalleeNode(MethodInvokeNode min, MethodDescriptor mdCaller, + MethodDescriptor mdCallee, GlobalFlowNode calleeSrcNode) { - System.out.println(); - System.out.println("### addRelationToLattice src=" + srcNode + " dst=" + dstNode); + GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(mdCallee); + GlobalFlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller); - // add a new binary relation of dstNode < srcNode - FlowGraph flowGraph = getFlowGraph(md); - - calculateCompositeLocation(flowGraph, methodLattice, methodInfo, srcNode); + NTuple callerSrcNodeLocTuple = + translateToCallerLocTuple(min, mdCallee, mdCaller, calleeSrcNode.getLocTuple()); - CompositeLocation srcInferLoc = - generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(srcNode)); - CompositeLocation dstInferLoc = - generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(dstNode)); + if (callerSrcNodeLocTuple != null) { + Set outNodeSet = calleeSubGlobalGraph.getOutNodeSet(calleeSrcNode); - try { - addRelation(methodLattice, methodInfo, srcInferLoc, dstInferLoc); - } catch (CyclicFlowException e) { - // there is a cyclic value flow... try to calculate a composite location - // for the destination node - calculateCompositeLocation(flowGraph, methodLattice, methodInfo, dstNode); - dstInferLoc = - generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(dstNode)); - try { - addRelation(methodLattice, methodInfo, srcInferLoc, dstInferLoc); - } catch (CyclicFlowException e1) { - throw new Error("Failed to merge cyclic value flows into a shared location."); + for (Iterator iterator = outNodeSet.iterator(); iterator.hasNext();) { + GlobalFlowNode outNode = (GlobalFlowNode) iterator.next(); + NTuple callerDstNodeLocTuple = + translateToCallerLocTuple(min, mdCallee, mdCaller, outNode.getLocTuple()); + if (callerDstNodeLocTuple != null) { + callerSubGlobalGraph.addValueFlowEdge(callerSrcNodeLocTuple, callerDstNodeLocTuple); + } } } } - private void recursivelyAddRelation(int idx, CompositeLocation srcInferLoc, - CompositeLocation dstInferLoc) throws CyclicFlowException { + private NTuple translateToCallerLocTuple(MethodInvokeNode min, + MethodDescriptor mdCallee, MethodDescriptor mdCaller, NTuple nodeLocTuple) { + // this method will return the same nodeLocTuple if the corresponding argument is literal + // value. + + FlowGraph calleeFlowGraph = getFlowGraph(mdCallee); - String srcLocSymbol = srcInferLoc.get(idx).getLocIdentifier(); - String dstLocSymbol = dstInferLoc.get(idx).getLocIdentifier(); + NTuple nodeDescTuple = translateToDescTuple(nodeLocTuple); + if (calleeFlowGraph.isParameter(nodeDescTuple)) { + int paramIdx = calleeFlowGraph.getParamIdx(nodeDescTuple); + NTuple argDescTuple = mapMethodInvokeNodeToArgIdxMap.get(min).get(paramIdx); + + if (isPrimitive(nodeLocTuple.get(0).getLocDescriptor())) { + // the type of argument is primitive. + return nodeLocTuple.clone(); + } + NTuple argLocTuple = translateToLocTuple(mdCaller, argDescTuple); - Descriptor parentDesc = srcInferLoc.get(idx).getDescriptor(); + NTuple callerLocTuple = new NTuple(); - if (srcLocSymbol.equals(dstLocSymbol)) { - // check if it is the case of shared location - if (srcInferLoc.getSize() == (idx + 1) && dstInferLoc.getSize() == (idx + 1)) { - Location inferLocElement = srcInferLoc.get(idx); - getLattice(inferLocElement.getDescriptor()) - .addSharedLoc(inferLocElement.getLocIdentifier()); - } else if (srcInferLoc.getSize() > (idx + 1) && dstInferLoc.getSize() > (idx + 1)) { - recursivelyAddRelation(idx + 1, srcInferLoc, dstInferLoc); + callerLocTuple.addAll(argLocTuple); + for (int i = 1; i < nodeLocTuple.size(); i++) { + callerLocTuple.add(nodeLocTuple.get(i)); } + return callerLocTuple; } else { - addRelationHigherToLower(getLattice(parentDesc), getLocationInfo(parentDesc), srcLocSymbol, - dstLocSymbol); + return nodeLocTuple.clone(); } + } - private void recursivelyAddCompositeRelation(MethodDescriptor md, FlowGraph flowGraph, - MethodLocationInfo methodInfo, FlowNode srcNode, FlowNode dstNode, Descriptor srcDesc, - Descriptor dstDesc) throws CyclicFlowException { + public static boolean isPrimitive(Descriptor desc) { - CompositeLocation inferSrcLoc; - CompositeLocation inferDstLoc = methodInfo.getInferLocation(dstDesc); + if (desc instanceof FieldDescriptor) { + return ((FieldDescriptor) desc).getType().isPrimitive(); + } else if (desc instanceof VarDescriptor) { + return ((VarDescriptor) desc).getType().isPrimitive(); + } else if (desc instanceof InterDescriptor) { + return true; + } - if (srcNode.getDescTuple().size() > 1) { - // field access - inferSrcLoc = new CompositeLocation(); + return false; + } - NTuple locTuple = flowGraph.getLocationTuple(srcNode); - for (int i = 0; i < locTuple.size(); i++) { - inferSrcLoc.addLocation(locTuple.get(i)); - } + private NTuple translateToDescTuple(NTuple locTuple) { - } else { - inferSrcLoc = methodInfo.getInferLocation(srcDesc); + NTuple descTuple = new NTuple(); + for (int i = 0; i < locTuple.size(); i++) { + descTuple.add(locTuple.get(i).getLocDescriptor()); } + return descTuple; - if (dstNode.getDescTuple().size() > 1) { - // field access - inferDstLoc = new CompositeLocation(); + } - NTuple locTuple = flowGraph.getLocationTuple(dstNode); - for (int i = 0; i < locTuple.size(); i++) { - inferDstLoc.addLocation(locTuple.get(i)); - } + private void addValueFlowsFromCalleeParam(MethodDescriptor mdCaller, + NTuple argLocTuple, NTuple baseLocTuple, MethodDescriptor mdCallee, + GlobalFlowNode globalParamNode) { - } else { - inferDstLoc = methodInfo.getInferLocation(dstDesc); - } + Set visited = new HashSet(); + visited.add(globalParamNode); + recurAddValueFlowsFromCalleeParam(mdCaller, argLocTuple, baseLocTuple, mdCallee, + globalParamNode); - recursiveAddRelationToLattice(1, md, inferSrcLoc, inferDstLoc); } - private void addPrefixMapping(Map, Set>> map, - NTuple prefix, NTuple element) { + private void recurAddValueFlowsFromCalleeParam(MethodDescriptor mdCaller, + NTuple argLocTuple, NTuple baseLocTuple, MethodDescriptor mdCallee, + GlobalFlowNode calleeCurNode) { + + // FlowGraph calleeFlowGraph = getFlowGraph(mdCallee); + // GlobalFlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(mdCallee); + // + // NTuple curNodeLocTuple = calleeCurNode.getLocTuple(); + // NTuple curNodeDescTuple = calleeCurNode.getDescTuple(); + // if (calleeFlowGraph.isParameter(curNodeDescTuple)) { + // curNodeLocTuple = translateToCaller(argLocTuple, curNodeLocTuple); + // } + // + // Set outNodeSet = + // calleeSubGlobalGraph.getOutNodeSet(calleeCurNode); + // for (Iterator iterator = outNodeSet.iterator(); iterator.hasNext();) { + // GlobalFlowNode outNode = (GlobalFlowNode) iterator.next(); + // + // NTuple curNodeLocTuple = calleeCurNode.getLocTuple(); + // NTuple curNodeDescTuple = calleeCurNode.getDescTuple(); + // if (calleeFlowGraph.isParameter(curNodeDescTuple)) { + // curNodeLocTuple = translateToCaller(argLocTuple, curNodeLocTuple); + // } + // + // outNode.getDescTuple(); + // + // if (calleeFlowGraph.is) + // + // if (calleeSubGlobalGraph.isParameter(srcDescTuple)) { + // // destination node is started with 'parameter' + // // need to translate it in terms of the caller's a node + // srcDescTuple = + // translateToCaller(min, calleeSubGlobalGraph.getParamIdx(srcDescTuple), + // srcDescTuple); + // } + // + // } + // + // Set edgeSet = + // calleeSubGlobalGraph.getOutEdgeSetStartingFrom(calleeSrcNode); + // for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) { + // FlowEdge flowEdge = (FlowEdge) iterator.next(); + // + // NTuple srcDescTuple = flowEdge.getInitTuple(); + // NTuple dstDescTuple = flowEdge.getEndTuple(); + // + // FlowNode dstNode = calleeSubGlobalGraph.getFlowNode(dstDescTuple); + // + // if (calleeSubGlobalGraph.isParameter(srcDescTuple)) { + // // destination node is started with 'parameter' + // // need to translate it in terms of the caller's a node + // srcDescTuple = + // translateToCaller(min, calleeSubGlobalGraph.getParamIdx(srcDescTuple), + // srcDescTuple); + // } + // + // if (calleeSubGlobalGraph.isParameter(dstDescTuple)) { + // // destination node is started with 'parameter' + // // need to translate it in terms of the caller's a node + // dstDescTuple = + // translateToCaller(min, calleeSubGlobalGraph.getParamIdx(dstDescTuple), + // dstDescTuple); + // } + // + // callerSubGlobalGraph.addValueFlowEdge(srcDescTuple, dstDescTuple); + // + // if (!visited.contains(dstNode)) { + // visited.add(dstNode); + // recurAddValueFlowsFromCalleeParam(min, calleeSubGlobalGraph, dstNode, + // callerSubGlobalGraph, + // dstDescTuple, visited, baseTuple); + // } + // + // } - if (!map.containsKey(prefix)) { - map.put(prefix, new HashSet>()); - } - map.get(prefix).add(element); } - private boolean calculateCompositeLocation(FlowGraph flowGraph, - SSJavaLattice methodLattice, MethodLocationInfo methodInfo, FlowNode flowNode) - throws CyclicFlowException { + private NTuple translateToCaller(NTuple argLocTuple, + NTuple curNodeLocTuple) { - Descriptor localVarDesc = flowNode.getDescTuple().get(0); + NTuple callerLocTuple = new NTuple(); - Set inNodeSet = flowGraph.getIncomingFlowNodeSet(flowNode); - Set reachableNodeSet = flowGraph.getReachableFlowNodeSet(flowNode); + callerLocTuple.addAll(argLocTuple); + for (int i = 1; i < curNodeLocTuple.size(); i++) { + callerLocTuple.add(curNodeLocTuple.get(i)); + } - Map, Set>> mapPrefixToIncomingLocTupleSet = - new HashMap, Set>>(); + return callerLocTuple; + } - Set localInNodeSet = new HashSet(); - Set localOutNodeSet = new HashSet(); + private void recurAddValueFlowsFromCalleeParam(MethodInvokeNode min, + FlowGraph calleeSubGlobalGraph, FlowNode calleeSrcNode, FlowGraph callerSubGlobalGraph, + NTuple callerSrcTuple, Set visited, NTuple baseTuple) { - CompositeLocation flowNodeInferLoc = - generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(flowNode)); + MethodDescriptor mdCallee = calleeSubGlobalGraph.getMethodDescriptor(); - List> prefixList = new ArrayList>(); + // Set edgeSet = + // calleeSubGlobalGraph.getOutEdgeSet(calleeSrcNode); + Set edgeSet = calleeSubGlobalGraph.getOutEdgeSetStartingFrom(calleeSrcNode); + for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) { + FlowEdge flowEdge = (FlowEdge) iterator.next(); - for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) { - FlowNode inNode = (FlowNode) iterator.next(); - NTuple inTuple = flowGraph.getLocationTuple(inNode); + NTuple srcDescTuple = flowEdge.getInitTuple(); + NTuple dstDescTuple = flowEdge.getEndTuple(); - if (inTuple.size() > 1) { - for (int i = 1; i < inTuple.size(); i++) { - NTuple prefix = inTuple.subList(0, i); - if (!prefixList.contains(prefix)) { - prefixList.add(prefix); - } - addPrefixMapping(mapPrefixToIncomingLocTupleSet, prefix, inTuple); - } - } else { - localInNodeSet.add(inNode); - } - } + FlowNode dstNode = calleeSubGlobalGraph.getFlowNode(dstDescTuple); - Collections.sort(prefixList, new Comparator>() { - public int compare(NTuple arg0, NTuple arg1) { - int s0 = arg0.size(); - int s1 = arg1.size(); - if (s0 > s1) { - return -1; - } else if (s0 == s1) { - return 0; - } else { - return 1; - } + if (calleeSubGlobalGraph.isParameter(srcDescTuple)) { + // destination node is started with 'parameter' + // need to translate it in terms of the caller's a node + srcDescTuple = + translateToCaller(min, calleeSubGlobalGraph.getParamIdx(srcDescTuple), srcDescTuple); } - }); - for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) { - FlowNode reachableNode = (FlowNode) iterator2.next(); - if (reachableNode.getDescTuple().size() == 1) { - localOutNodeSet.add(reachableNode); + if (calleeSubGlobalGraph.isParameter(dstDescTuple)) { + // destination node is started with 'parameter' + // need to translate it in terms of the caller's a node + dstDescTuple = + translateToCaller(min, calleeSubGlobalGraph.getParamIdx(dstDescTuple), dstDescTuple); } - } - // find out reachable nodes that have the longest common prefix - for (int i = 0; i < prefixList.size(); i++) { - NTuple curPrefix = prefixList.get(i); - Set> reachableCommonPrefixSet = new HashSet>(); + callerSubGlobalGraph.addValueFlowEdge(srcDescTuple, dstDescTuple); - for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) { - FlowNode reachableNode = (FlowNode) iterator2.next(); - NTuple reachLocTuple = flowGraph.getLocationTuple(reachableNode); - if (reachLocTuple.startsWith(curPrefix)) { - reachableCommonPrefixSet.add(reachLocTuple); - } + if (!visited.contains(dstNode)) { + visited.add(dstNode); + recurAddValueFlowsFromCalleeParam(min, calleeSubGlobalGraph, dstNode, callerSubGlobalGraph, + dstDescTuple, visited, baseTuple); } - // check if the lattice has the relation in which higher prefix is - // actually lower than the current node - CompositeLocation prefixInferLoc = generateInferredCompositeLocation(methodInfo, curPrefix); - if (isGreaterThan(methodLattice, flowNodeInferLoc, prefixInferLoc)) { - reachableCommonPrefixSet.add(curPrefix); - } + } - if (!reachableCommonPrefixSet.isEmpty()) { - // found reachable nodes that start with the prefix curPrefix - // need to assign a composite location + } - // first, check if there are more than one the set of locations that has - // the same length of the longest reachable prefix, no way to assign - // a composite location to the input local var - prefixSanityCheck(prefixList, i, flowGraph, reachableNodeSet); + private NTuple translateToCaller(MethodInvokeNode min, int paramIdx, + NTuple srcDescTuple) { - Set> incomingCommonPrefixSet = - mapPrefixToIncomingLocTupleSet.get(curPrefix); + NTuple callerTuple = new NTuple(); - int idx = curPrefix.size(); - NTuple element = incomingCommonPrefixSet.iterator().next(); - Descriptor desc = element.get(idx).getDescriptor(); + NTuple argTuple = mapMethodInvokeNodeToArgIdxMap.get(min).get(paramIdx); - SSJavaLattice lattice = getLattice(desc); - LocationInfo locInfo = getLocationInfo(desc); + for (int i = 0; i < argTuple.size(); i++) { + callerTuple.add(argTuple.get(i)); + } - // CompositeLocation inferLocation = - // methodInfo.getInferLocation(flowNode); - CompositeLocation inferLocation = methodInfo.getInferLocation(localVarDesc); + for (int i = 1; i < srcDescTuple.size(); i++) { + callerTuple.add(srcDescTuple.get(i)); + } - String newlyInsertedLocName; - if (inferLocation.getSize() == 1) { - // need to replace the old local location with a new composite - // location + return callerTuple; + } - String oldMethodLocationSymbol = inferLocation.get(0).getLocIdentifier(); + private NTuple traslateToCalleeParamTupleToCallerArgTuple( + NTuple calleeInitTuple, NTuple callerSrcTuple) { - String newLocSymbol = "Loc" + (SSJavaLattice.seed++); - inferLocation = new CompositeLocation(); - for (int locIdx = 0; locIdx < curPrefix.size(); locIdx++) { - inferLocation.addLocation(curPrefix.get(locIdx)); - } - Location fieldLoc = new Location(desc, newLocSymbol); - inferLocation.addLocation(fieldLoc); + NTuple callerInitTuple = new NTuple(); - methodInfo.mapDescriptorToLocation(localVarDesc, inferLocation); - addMapLocSymbolToInferredLocation(methodInfo.md, localVarDesc, inferLocation); - methodInfo.removeMaplocalVarToLocSet(localVarDesc); + for (int i = 0; i < callerSrcTuple.size(); i++) { + callerInitTuple.add(callerSrcTuple.get(i)); + } - String newMethodLocationSymbol = curPrefix.get(0).getLocIdentifier(); + for (int i = 1; i < calleeInitTuple.size(); i++) { + callerInitTuple.add(calleeInitTuple.get(i)); + } - replaceOldLocWithNewLoc(methodLattice, oldMethodLocationSymbol, newMethodLocationSymbol); + return callerInitTuple; + } - } else { + public LocationSummary getLocationSummary(Descriptor d) { + if (!mapDescToLocationSummary.containsKey(d)) { + if (d instanceof MethodDescriptor) { + mapDescToLocationSummary.put(d, new MethodSummary((MethodDescriptor) d)); + } else if (d instanceof ClassDescriptor) { + mapDescToLocationSummary.put(d, new FieldSummary()); + } + } + return mapDescToLocationSummary.get(d); + } - String localLocName = methodInfo.getInferLocation(localVarDesc).get(0).getLocIdentifier(); - return true; + private void generateMethodSummary() { - } + Set keySet = md2lattice.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + MethodDescriptor md = (MethodDescriptor) iterator.next(); + + System.out.println("\nSSJAVA: generate method summary: " + md); + + FlowGraph flowGraph = getFlowGraph(md); + MethodSummary methodSummary = getMethodSummary(md); + + HierarchyGraph scGraph = getSkeletonCombinationHierarchyGraph(md); + + // set the 'this' reference location + if (!md.isStatic()) { + System.out.println("setThisLocName=" + scGraph.getHNode(md.getThis()).getName()); + methodSummary.setThisLocName(scGraph.getHNode(md.getThis()).getName()); + } + + // set the 'global' reference location if needed + if (methodSummary.hasGlobalAccess()) { + methodSummary.setGlobalLocName(scGraph.getHNode(GLOBALDESC).getName()); + } + + // construct a parameter mapping that maps a parameter descriptor to an + // inferred composite location + for (int paramIdx = 0; paramIdx < flowGraph.getNumParameters(); paramIdx++) { + FlowNode flowNode = flowGraph.getParamFlowNode(paramIdx); + CompositeLocation inferredCompLoc = + updateCompositeLocation(flowNode.getCompositeLocation()); + // NTuple descTuple = flowNode.getDescTuple(); + // + // CompositeLocation assignedCompLoc = flowNode.getCompositeLocation(); + // CompositeLocation inferredCompLoc; + // if (assignedCompLoc != null) { + // inferredCompLoc = translateCompositeLocation(assignedCompLoc); + // } else { + // Descriptor locDesc = descTuple.get(0); + // Location loc = new Location(md, locDesc.getSymbol()); + // loc.setLocDescriptor(locDesc); + // inferredCompLoc = new CompositeLocation(loc); + // } + System.out.println("-paramIdx=" + paramIdx + " infer=" + inferredCompLoc + " original=" + + flowNode.getCompositeLocation()); + + Descriptor localVarDesc = flowNode.getDescTuple().get(0); + methodSummary.addMapVarNameToInferCompLoc(localVarDesc, inferredCompLoc); + methodSummary.addMapParamIdxToInferLoc(paramIdx, inferredCompLoc); + } + + } + + } + + private boolean hasOrderingRelation(NTuple locTuple1, NTuple locTuple2) { + + int size = locTuple1.size() >= locTuple2.size() ? locTuple2.size() : locTuple1.size(); + + for (int idx = 0; idx < size; idx++) { + Location loc1 = locTuple1.get(idx); + Location loc2 = locTuple2.get(idx); + + Descriptor desc1 = loc1.getDescriptor(); + Descriptor desc2 = loc2.getDescriptor(); + + if (!desc1.equals(desc2)) { + throw new Error("Fail to compare " + locTuple1 + " and " + locTuple2); + } + + Descriptor locDesc1 = loc1.getLocDescriptor(); + Descriptor locDesc2 = loc2.getLocDescriptor(); + + HierarchyGraph hierarchyGraph = getHierarchyGraph(desc1); + + HNode node1 = hierarchyGraph.getHNode(locDesc1); + HNode node2 = hierarchyGraph.getHNode(locDesc2); + + System.out.println("---node1=" + node1 + " node2=" + node2); + System.out.println("---hierarchyGraph.getIncomingNodeSet(node2)=" + + hierarchyGraph.getIncomingNodeSet(node2)); + + if (locDesc1.equals(locDesc2)) { + continue; + } else if (!hierarchyGraph.getIncomingNodeSet(node2).contains(node1) + && !hierarchyGraph.getIncomingNodeSet(node1).contains(node2)) { + return false; + } else { + return true; + } + + } + + return false; + + } + + private boolean isHigherThan(NTuple locTuple1, NTuple locTuple2) { + + int size = locTuple1.size() >= locTuple2.size() ? locTuple2.size() : locTuple1.size(); + + for (int idx = 0; idx < size; idx++) { + Location loc1 = locTuple1.get(idx); + Location loc2 = locTuple2.get(idx); + + Descriptor desc1 = loc1.getDescriptor(); + Descriptor desc2 = loc2.getDescriptor(); + + if (!desc1.equals(desc2)) { + throw new Error("Fail to compare " + locTuple1 + " and " + locTuple2); + } + + Descriptor locDesc1 = loc1.getLocDescriptor(); + Descriptor locDesc2 = loc2.getLocDescriptor(); + + HierarchyGraph hierarchyGraph = getHierarchyGraph(desc1); + + HNode node1 = hierarchyGraph.getHNode(locDesc1); + HNode node2 = hierarchyGraph.getHNode(locDesc2); + + System.out.println("---node1=" + node1 + " node2=" + node2); + System.out.println("---hierarchyGraph.getIncomingNodeSet(node2)=" + + hierarchyGraph.getIncomingNodeSet(node2)); + + if (locDesc1.equals(locDesc2)) { + continue; + } else if (hierarchyGraph.getIncomingNodeSet(node2).contains(node1)) { + return true; + } else { + return false; + } + + } + + return false; + } + + private CompositeLocation translateCompositeLocation(CompositeLocation compLoc) { + CompositeLocation newCompLoc = new CompositeLocation(); + + // System.out.println("compLoc=" + compLoc); + for (int i = 0; i < compLoc.getSize(); i++) { + Location loc = compLoc.get(i); + Descriptor enclosingDescriptor = loc.getDescriptor(); + Descriptor locDescriptor = loc.getLocDescriptor(); + + HNode hnode = getHierarchyGraph(enclosingDescriptor).getHNode(locDescriptor); + // System.out.println("-hnode=" + hnode + " from=" + locDescriptor + + // " enclosingDescriptor=" + // + enclosingDescriptor); + // System.out.println("-getLocationSummary(enclosingDescriptor)=" + // + getLocationSummary(enclosingDescriptor)); + String locName = getLocationSummary(enclosingDescriptor).getLocationName(hnode.getName()); + // System.out.println("-locName=" + locName); + Location newLoc = new Location(enclosingDescriptor, locName); + newLoc.setLocDescriptor(locDescriptor); + newCompLoc.addLocation(newLoc); + } + + return newCompLoc; + } + + private void debug_writeLattices() { + + Set keySet = mapDescriptorToSimpleLattice.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor key = (Descriptor) iterator.next(); + SSJavaLattice simpleLattice = mapDescriptorToSimpleLattice.get(key); + // HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(key); + HierarchyGraph scHierarchyGraph = getSkeletonCombinationHierarchyGraph(key); + if (key instanceof ClassDescriptor) { + writeInferredLatticeDotFile((ClassDescriptor) key, scHierarchyGraph, simpleLattice, + "_SIMPLE"); + } else if (key instanceof MethodDescriptor) { + MethodDescriptor md = (MethodDescriptor) key; + writeInferredLatticeDotFile(md.getClassDesc(), md, scHierarchyGraph, simpleLattice, + "_SIMPLE"); + } + + LocationSummary ls = getLocationSummary(key); + System.out.println("####LOC SUMMARY=" + key + "\n" + ls.getMapHNodeNameToLocationName()); + } + + Set cdKeySet = cd2lattice.keySet(); + for (Iterator iterator = cdKeySet.iterator(); iterator.hasNext();) { + ClassDescriptor cd = (ClassDescriptor) iterator.next(); + writeInferredLatticeDotFile((ClassDescriptor) cd, getSkeletonCombinationHierarchyGraph(cd), + cd2lattice.get(cd), ""); + } + + Set mdKeySet = md2lattice.keySet(); + for (Iterator iterator = mdKeySet.iterator(); iterator.hasNext();) { + MethodDescriptor md = (MethodDescriptor) iterator.next(); + writeInferredLatticeDotFile(md.getClassDesc(), md, getSkeletonCombinationHierarchyGraph(md), + md2lattice.get(md), ""); + } + + } + + private void buildLattice() { + + BuildLattice buildLattice = new BuildLattice(this); + + Set keySet = mapDescriptorToCombineSkeletonHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + + SSJavaLattice simpleLattice = buildLattice.buildLattice(desc); + + addMapDescToSimpleLattice(desc, simpleLattice); + + HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc); + System.out.println("\n## insertIntermediateNodesToStraightLine:" + + simpleHierarchyGraph.getName()); + SSJavaLattice lattice = + buildLattice.insertIntermediateNodesToStraightLine(desc, simpleLattice); + lattice.removeRedundantEdges(); + + if (desc instanceof ClassDescriptor) { + // field lattice + cd2lattice.put((ClassDescriptor) desc, lattice); + // ssjava.writeLatticeDotFile((ClassDescriptor) desc, null, lattice); + } else if (desc instanceof MethodDescriptor) { + // method lattice + md2lattice.put((MethodDescriptor) desc, lattice); + MethodDescriptor md = (MethodDescriptor) desc; + ClassDescriptor cd = md.getClassDesc(); + // ssjava.writeLatticeDotFile(cd, md, lattice); + } + + // System.out.println("\nSSJAVA: Insering Combination Nodes:" + desc); + // HierarchyGraph skeletonGraph = getSkeletonHierarchyGraph(desc); + // HierarchyGraph skeletonGraphWithCombinationNode = + // skeletonGraph.clone(); + // skeletonGraphWithCombinationNode.setName(desc + "_SC"); + // + // HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc); + // System.out.println("Identifying Combination Nodes:"); + // skeletonGraphWithCombinationNode.insertCombinationNodesToGraph(simpleHierarchyGraph); + // skeletonGraphWithCombinationNode.simplifySkeletonCombinationHierarchyGraph(); + // mapDescriptorToCombineSkeletonHierarchyGraph.put(desc, + // skeletonGraphWithCombinationNode); + } + + } + + public void addMapDescToSimpleLattice(Descriptor desc, SSJavaLattice lattice) { + mapDescriptorToSimpleLattice.put(desc, lattice); + } + + public SSJavaLattice getSimpleLattice(Descriptor desc) { + return mapDescriptorToSimpleLattice.get(desc); + } + + private void simplifyHierarchyGraph() { + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + System.out.println("SSJAVA: remove redundant edges: " + desc); + HierarchyGraph simpleHierarchyGraph = getHierarchyGraph(desc).clone(); + simpleHierarchyGraph.setName(desc + "_SIMPLE"); + simpleHierarchyGraph.removeRedundantEdges(); + mapDescriptorToSimpleHierarchyGraph.put(desc, simpleHierarchyGraph); + } + } + + private void insertCombinationNodes() { + Set keySet = mapDescriptorToSkeletonHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + System.out.println("\nSSJAVA: Insering Combination Nodes:" + desc); + HierarchyGraph skeletonGraph = getSkeletonHierarchyGraph(desc); + HierarchyGraph skeletonGraphWithCombinationNode = skeletonGraph.clone(); + skeletonGraphWithCombinationNode.setName(desc + "_SC"); + + HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc); + System.out.println("Identifying Combination Nodes:"); + skeletonGraphWithCombinationNode.insertCombinationNodesToGraph(simpleHierarchyGraph); + skeletonGraphWithCombinationNode.simplifySkeletonCombinationHierarchyGraph(); + mapDescriptorToCombineSkeletonHierarchyGraph.put(desc, skeletonGraphWithCombinationNode); + } + } + + private void constructSkeletonHierarchyGraph() { + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + System.out.println("SSJAVA: Constructing Skeleton Hierarchy Graph: " + desc); + HierarchyGraph simpleGraph = getSimpleHierarchyGraph(desc); + HierarchyGraph skeletonGraph = simpleGraph.generateSkeletonGraph(); + skeletonGraph.setMapDescToHNode(simpleGraph.getMapDescToHNode()); + skeletonGraph.setMapHNodeToDescSet(simpleGraph.getMapHNodeToDescSet()); + skeletonGraph.simplifyHierarchyGraph(); + // skeletonGraph.combineRedundantNodes(false); + // skeletonGraph.removeRedundantEdges(); + mapDescriptorToSkeletonHierarchyGraph.put(desc, skeletonGraph); + } + } + + private void debug_writeHierarchyDotFiles() { + + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + getHierarchyGraph(desc).writeGraph(); + } + + } + + private void debug_writeSimpleHierarchyDotFiles() { + + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + getHierarchyGraph(desc).writeGraph(); + getSimpleHierarchyGraph(desc).writeGraph(); + } + + } + + private void debug_writeSkeletonHierarchyDotFiles() { + + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + getSkeletonHierarchyGraph(desc).writeGraph(); + } + + } + + private void debug_writeSkeletonCombinationHierarchyDotFiles() { + + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + getSkeletonCombinationHierarchyGraph(desc).writeGraph(); + } + + } + + public HierarchyGraph getSimpleHierarchyGraph(Descriptor d) { + return mapDescriptorToSimpleHierarchyGraph.get(d); + } + + private HierarchyGraph getSkeletonHierarchyGraph(Descriptor d) { + if (!mapDescriptorToSkeletonHierarchyGraph.containsKey(d)) { + mapDescriptorToSkeletonHierarchyGraph.put(d, new HierarchyGraph(d)); + } + return mapDescriptorToSkeletonHierarchyGraph.get(d); + } + + public HierarchyGraph getSkeletonCombinationHierarchyGraph(Descriptor d) { + if (!mapDescriptorToCombineSkeletonHierarchyGraph.containsKey(d)) { + mapDescriptorToCombineSkeletonHierarchyGraph.put(d, new HierarchyGraph(d)); + } + return mapDescriptorToCombineSkeletonHierarchyGraph.get(d); + } + + private void constructHierarchyGraph() { + + // do fixed-point analysis + + LinkedList descriptorListToAnalyze = ssjava.getSortedDescriptors(); + + // Collections.sort(descriptorListToAnalyze, new + // Comparator() { + // public int compare(MethodDescriptor o1, MethodDescriptor o2) { + // return o1.getSymbol().compareToIgnoreCase(o2.getSymbol()); + // } + // }); + + // current descriptors to visit in fixed-point interprocedural analysis, + // prioritized by dependency in the call graph + methodDescriptorsToVisitStack.clear(); + + Set methodDescriptorToVistSet = new HashSet(); + methodDescriptorToVistSet.addAll(descriptorListToAnalyze); + + while (!descriptorListToAnalyze.isEmpty()) { + MethodDescriptor md = descriptorListToAnalyze.removeFirst(); + methodDescriptorsToVisitStack.add(md); + } + + // analyze scheduled methods until there are no more to visit + while (!methodDescriptorsToVisitStack.isEmpty()) { + // start to analyze leaf node + MethodDescriptor md = methodDescriptorsToVisitStack.pop(); + + HierarchyGraph hierarchyGraph = new HierarchyGraph(md); + // MethodSummary methodSummary = new MethodSummary(md); + + // MethodLocationInfo methodInfo = new MethodLocationInfo(md); + // curMethodInfo = methodInfo; + + System.out.println(); + System.out.println("SSJAVA: Construcing the hierarchy graph from " + md); + + constructHierarchyGraph(md, hierarchyGraph); + + HierarchyGraph prevHierarchyGraph = getHierarchyGraph(md); + // MethodSummary prevMethodSummary = getMethodSummary(md); + + if (!hierarchyGraph.equals(prevHierarchyGraph)) { + + mapDescriptorToHierarchyGraph.put(md, hierarchyGraph); + // mapDescToLocationSummary.put(md, methodSummary); + + // results for callee changed, so enqueue dependents caller for + // further analysis + Iterator depsItr = ssjava.getDependents(md).iterator(); + while (depsItr.hasNext()) { + MethodDescriptor methodNext = depsItr.next(); + if (!methodDescriptorsToVisitStack.contains(methodNext) + && methodDescriptorToVistSet.contains(methodNext)) { + methodDescriptorsToVisitStack.add(methodNext); + } + } + + } + + } + + setupToAnalyze(); + while (!toAnalyzeIsEmpty()) { + ClassDescriptor cd = toAnalyzeNext(); + HierarchyGraph graph = getHierarchyGraph(cd); + for (Iterator iter = cd.getFields(); iter.hasNext();) { + FieldDescriptor fieldDesc = (FieldDescriptor) iter.next(); + if (!(fieldDesc.isStatic() && fieldDesc.isFinal())) { + graph.getHNode(fieldDesc); + } + } + } + + Set keySet = mapDescriptorToHierarchyGraph.keySet(); + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + Descriptor key = (Descriptor) iterator.next(); + HierarchyGraph graph = getHierarchyGraph(key); + + Set nodeToBeConnected = new HashSet(); + for (Iterator iterator2 = graph.getNodeSet().iterator(); iterator2.hasNext();) { + HNode node = (HNode) iterator2.next(); + if (!node.isSkeleton() && !node.isCombinationNode()) { + if (graph.getIncomingNodeSet(node).size() == 0) { + nodeToBeConnected.add(node); + } + } + } + + for (Iterator iterator2 = nodeToBeConnected.iterator(); iterator2.hasNext();) { + HNode node = (HNode) iterator2.next(); + System.out.println("NEED TO BE CONNECTED TO TOP=" + node); + graph.addEdge(graph.getHNode(TOPDESC), node); + } + + } + + } + + private HierarchyGraph getHierarchyGraph(Descriptor d) { + if (!mapDescriptorToHierarchyGraph.containsKey(d)) { + mapDescriptorToHierarchyGraph.put(d, new HierarchyGraph(d)); + } + return mapDescriptorToHierarchyGraph.get(d); + } + + private void constructHierarchyGraph(MethodDescriptor md, HierarchyGraph methodGraph) { + + // visit each node of method flow graph + FlowGraph fg = getFlowGraph(md); + Set nodeSet = fg.getNodeSet(); + + Set paramDescSet = fg.getMapParamDescToIdx().keySet(); + for (Iterator iterator = paramDescSet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + methodGraph.getHNode(desc).setSkeleton(true); + } + + // for the method lattice, we need to look at the first element of + // NTuple + boolean hasGlobalAccess = false; + for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + FlowNode srcNode = (FlowNode) iterator.next(); + + // if the srcNode is started with the global descriptor + // need to set as a skeleton node + if (!hasGlobalAccess && srcNode.getDescTuple().startsWith(GLOBALDESC)) { + hasGlobalAccess = true; + } + + Set outEdgeSet = fg.getOutEdgeSet(srcNode); + for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) { + FlowEdge outEdge = (FlowEdge) iterator2.next(); + FlowNode dstNode = outEdge.getDst(); + + NTuple srcNodeTuple = srcNode.getDescTuple(); + NTuple dstNodeTuple = dstNode.getDescTuple(); + + if (outEdge.getInitTuple().equals(srcNodeTuple) + && outEdge.getEndTuple().equals(dstNodeTuple)) { + + NTuple srcCurTuple = srcNode.getCurrentDescTuple(); + NTuple dstCurTuple = dstNode.getCurrentDescTuple(); + + if ((srcCurTuple.size() > 1 && dstCurTuple.size() > 1) + && srcCurTuple.get(0).equals(dstCurTuple.get(0))) { + + // value flows between fields + Descriptor desc = srcCurTuple.get(0); + ClassDescriptor classDesc; + + if (desc.equals(GLOBALDESC)) { + classDesc = md.getClassDesc(); + } else { + VarDescriptor varDesc = (VarDescriptor) srcCurTuple.get(0); + classDesc = varDesc.getType().getClassDesc(); + } + extractFlowsBetweenFields(classDesc, srcNode, dstNode, 1); + + } else { + // value flow between local var - local var or local var - field + + Descriptor srcDesc = srcCurTuple.get(0); + Descriptor dstDesc = dstCurTuple.get(0); + + methodGraph.addEdge(srcDesc, dstDesc); + + if (fg.isParamDesc(srcDesc)) { + methodGraph.setParamHNode(srcDesc); + } + if (fg.isParamDesc(dstDesc)) { + methodGraph.setParamHNode(dstDesc); + } + + } + + } + } + } + + // If the method accesses static fields + // set hasGloabalAccess true in the method summary. + if (hasGlobalAccess) { + getMethodSummary(md).setHasGlobalAccess(); + } + methodGraph.getHNode(GLOBALDESC).setSkeleton(true); + + if (ssjava.getMethodContainingSSJavaLoop().equals(md)) { + // if the current method contains the event loop + // we need to set all nodes of the hierarchy graph as a skeleton node + Set hnodeSet = methodGraph.getNodeSet(); + for (Iterator iterator = hnodeSet.iterator(); iterator.hasNext();) { + HNode hnode = (HNode) iterator.next(); + hnode.setSkeleton(true); + } + } + + } + + private MethodSummary getMethodSummary(MethodDescriptor md) { + if (!mapDescToLocationSummary.containsKey(md)) { + mapDescToLocationSummary.put(md, new MethodSummary(md)); + } + return (MethodSummary) mapDescToLocationSummary.get(md); + } + + 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 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 classDescSet = new HashSet(); + 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 methodSet = new HashSet(); + methodSet.addAll(cd.getMethodTable().getValueSet()); + + String sourceFileName = cd.getSourceFileName(); + Vector lineVec = new Vector(); + + 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 sharedLocSet = new HashSet(); + + SSJavaLattice lattice = getLattice(desc); + String rtr = "@LATTICE(\""; + + Map> map = lattice.getTable(); + Set keySet = map.keySet(); + boolean first = true; + for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { + String key = (String) iterator.next(); + if (!key.equals(lattice.getTopItem())) { + Set 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) { + System.out.println("#EXTRA LOC DECLARATION GEN=" + desc); + + MethodDescriptor md = (MethodDescriptor) desc; + MethodSummary methodSummary = getMethodSummary(md); + + if (!ssjava.getMethodContainingSSJavaLoop().equals(desc)) { + TypeDescriptor returnType = ((MethodDescriptor) desc).getReturnType(); + if (returnType != null && (!returnType.isVoid())) { + rtr += + "\n@RETURNLOC(\"" + generateLocationAnnoatation(methodSummary.getRETURNLoc()) + "\")"; + } + CompositeLocation pcLoc = methodSummary.getPCLoc(); + if ((pcLoc != null) && (!pcLoc.get(0).isTop())) { + rtr += "\n@PCLOC(\"" + generateLocationAnnoatation(pcLoc) + "\")"; + } + } + + if (!md.isStatic()) { + rtr += "\n@THISLOC(\"" + methodSummary.getThisLocName() + "\")"; + } + rtr += "\n@GLOBALLOC(\"" + methodSummary.getGlobalLocName() + "\")"; + + } + + return rtr; + } + + private void generateAnnoatedCode() { + + readOriginalSourceFiles(); + + setupToAnalyze(); + while (!toAnalyzeIsEmpty()) { + ClassDescriptor cd = toAnalyzeNext(); + + setupToAnalazeMethod(cd); + + String sourceFileName = cd.getSourceFileName(); + + if (cd.isInterface()) { + continue; + } + + int classDefLine = mapDescToDefinitionLine.get(cd); + Vector sourceVec = mapFileNameToLineVector.get(sourceFileName); + + LocationSummary fieldLocSummary = getLocationSummary(cd); + + String fieldLatticeDefStr = generateLatticeDefinition(cd); + String annoatedSrc = fieldLatticeDefStr + newline + sourceVec.get(classDefLine); + sourceVec.set(classDefLine, annoatedSrc); + + // generate annotations for field declarations + // Map inferLocMap = fieldLocInfo.getMapDescToInferLocation(); + Map mapFieldNameToLocName = fieldLocSummary.getMapHNodeNameToLocationName(); + + for (Iterator iter = cd.getFields(); iter.hasNext();) { + FieldDescriptor fd = (FieldDescriptor) iter.next(); + + String locAnnotationStr; + // CompositeLocation inferLoc = inferLocMap.get(fd); + String locName = mapFieldNameToLocName.get(fd.getSymbol()); + + if (locName != null) { + // infer loc is null if the corresponding field is static and final + // locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")"; + locAnnotationStr = "@LOC(\"" + locName + "\")"; + 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(); + + if (!ssjava.needTobeAnnotated(md)) { + continue; + } + + SSJavaLattice methodLattice = md2lattice.get(md); + if (methodLattice != null) { + + int methodDefLine = md.getLineNum(); + + // MethodLocationInfo methodLocInfo = getMethodLocationInfo(md); + // Map methodInferLocMap = + // methodLocInfo.getMapDescToInferLocation(); + + MethodSummary methodSummary = getMethodSummary(md); + + Map mapVarDescToInferLoc = + methodSummary.getMapVarDescToInferCompositeLocation(); + System.out.println("-----md=" + md); + System.out.println("-----mapVarDescToInferLoc=" + mapVarDescToInferLoc); + + Set localVarDescSet = mapVarDescToInferLoc.keySet(); + + Set localLocElementSet = methodLattice.getElementSet(); + + for (Iterator iterator = localVarDescSet.iterator(); iterator.hasNext();) { + Descriptor localVarDesc = (Descriptor) iterator.next(); + System.out.println("-------localVarDesc=" + localVarDesc); + CompositeLocation inferLoc = mapVarDescToInferLoc.get(localVarDesc); + + String localLocIdentifier = inferLoc.get(0).getLocIdentifier(); + if (!localLocElementSet.contains(localLocIdentifier)) { + methodLattice.put(localLocIdentifier); + } + + 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 + " localVarDesc=" + localVarDesc + + " idx=" + idx); + assert (idx != -1); + + String annoatedStr = + methodDefStr.substring(0, idx) + locAnnotationStr + " " + + methodDefStr.substring(idx); + sourceVec.set(methodDefLine, annoatedStr); + } + + } + + // check if the lattice has to have the location type for the this + // reference... + + // boolean needToAddthisRef = hasThisReference(md); + // if (localLocElementSet.contains("this")) { + // methodLattice.put("this"); + // } + + String methodLatticeDefStr = generateLatticeDefinition(md); + String annoatedStr = methodLatticeDefStr + newline + sourceVec.get(methodDefLine); + sourceVec.set(methodDefLine, annoatedStr); + + } + } + + } + + codeGen(); + } + + private boolean hasThisReference(MethodDescriptor md) { + + FlowGraph fg = getFlowGraph(md); + Set nodeSet = fg.getNodeSet(); + for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + FlowNode flowNode = (FlowNode) iterator.next(); + if (flowNode.getDescTuple().get(0).equals(md.getThis())) { + return true; + } + } + + return false; + } + + 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) { + System.out.println("loc=" + 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 originalFileNameSet = mapFileNameToLineVector.keySet(); + for (Iterator iterator = originalFileNameSet.iterator(); iterator.hasNext();) { + String orgFileName = (String) iterator.next(); + String outputFileName = extractFileName(orgFileName); + + Vector 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 checkLattices() { + + LinkedList descriptorListToAnalyze = ssjava.getSortedDescriptors(); + + // current descriptors to visit in fixed-point interprocedural analysis, + // prioritized by + // dependency in the call graph + methodDescriptorsToVisitStack.clear(); + + // descriptorListToAnalyze.removeFirst(); + + Set methodDescriptorToVistSet = new HashSet(); + methodDescriptorToVistSet.addAll(descriptorListToAnalyze); + + while (!descriptorListToAnalyze.isEmpty()) { + MethodDescriptor md = descriptorListToAnalyze.removeFirst(); + checkLatticesOfVirtualMethods(md); + } + + } + + private void debug_writeLatticeDotFile() { + // generate lattice dot file + + setupToAnalyze(); + + while (!toAnalyzeIsEmpty()) { + ClassDescriptor cd = toAnalyzeNext(); + + setupToAnalazeMethod(cd); + + SSJavaLattice classLattice = cd2lattice.get(cd); + if (classLattice != null) { + ssjava.writeLatticeDotFile(cd, null, classLattice); + debug_printDescriptorToLocNameMapping(cd); + } + + while (!toAnalyzeMethodIsEmpty()) { + MethodDescriptor md = toAnalyzeMethodNext(); + SSJavaLattice methodLattice = md2lattice.get(md); + if (methodLattice != null) { + ssjava.writeLatticeDotFile(cd, md, methodLattice); + debug_printDescriptorToLocNameMapping(md); + } + } + } + + } + + private void debug_printDescriptorToLocNameMapping(Descriptor desc) { + + LocationInfo info = getLocationInfo(desc); + System.out.println("## " + desc + " ##"); + System.out.println(info.getMapDescToInferLocation()); + LocationInfo locInfo = getLocationInfo(desc); + System.out.println("mapping=" + locInfo.getMapLocSymbolToDescSet()); + System.out.println("###################"); + + } + + private void calculateExtraLocations() { + + LinkedList methodDescList = ssjava.getSortedDescriptors(); + for (Iterator iterator = methodDescList.iterator(); iterator.hasNext();) { + MethodDescriptor md = (MethodDescriptor) iterator.next(); + if (!ssjava.getMethodContainingSSJavaLoop().equals(md)) { + calculateExtraLocations(md); + } + } + + } + + private void checkLatticesOfVirtualMethods(MethodDescriptor md) { + + if (!md.isStatic()) { + Set setPossibleCallees = new HashSet(); + setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md)); + + for (Iterator iterator = setPossibleCallees.iterator(); iterator.hasNext();) { + MethodDescriptor mdCallee = (MethodDescriptor) iterator.next(); + if (!md.equals(mdCallee)) { + checkConsistency(md, mdCallee); + } + } + + } + + } + + private void checkConsistency(MethodDescriptor md1, MethodDescriptor md2) { + + // check that two lattice have the same relations between parameters(+PC + // LOC, GLOBAL_LOC RETURN LOC) + + List list1 = new ArrayList(); + List list2 = new ArrayList(); + + MethodLocationInfo locInfo1 = getMethodLocationInfo(md1); + MethodLocationInfo locInfo2 = getMethodLocationInfo(md2); + + Map paramMap1 = locInfo1.getMapParamIdxToInferLoc(); + Map paramMap2 = locInfo2.getMapParamIdxToInferLoc(); + + int numParam = locInfo1.getMapParamIdxToInferLoc().keySet().size(); + + // add location types of paramters + for (int idx = 0; idx < numParam; idx++) { + list1.add(paramMap1.get(Integer.valueOf(idx))); + list2.add(paramMap2.get(Integer.valueOf(idx))); + } + + // add program counter location + list1.add(locInfo1.getPCLoc()); + list2.add(locInfo2.getPCLoc()); + + if (!md1.getReturnType().isVoid()) { + // add return value location + CompositeLocation rtrLoc1 = getMethodLocationInfo(md1).getReturnLoc(); + CompositeLocation rtrLoc2 = getMethodLocationInfo(md2).getReturnLoc(); + list1.add(rtrLoc1); + list2.add(rtrLoc2); + } + + // add global location type + if (md1.isStatic()) { + CompositeLocation globalLoc1 = + new CompositeLocation(new Location(md1, locInfo1.getGlobalLocName())); + CompositeLocation globalLoc2 = + new CompositeLocation(new Location(md2, locInfo2.getGlobalLocName())); + list1.add(globalLoc1); + list2.add(globalLoc2); + } + + for (int i = 0; i < list1.size(); i++) { + CompositeLocation locA1 = list1.get(i); + CompositeLocation locA2 = list2.get(i); + for (int k = 0; k < list1.size(); k++) { + if (i != k) { + CompositeLocation locB1 = list1.get(k); + CompositeLocation locB2 = list2.get(k); + boolean r1 = isGreaterThan(getLattice(md1), locA1, locB1); + + boolean r2 = isGreaterThan(getLattice(md1), locA2, locB2); + + if (r1 != r2) { + throw new Error("The method " + md1 + " is not consistent with the method " + md2 + + ".:: They have a different ordering relation between locations (" + locA1 + "," + + locB1 + ") and (" + locA2 + "," + locB2 + ")."); + } + } + } + } + + } + + private String getSymbol(int idx, FlowNode node) { + Descriptor desc = node.getDescTuple().get(idx); + return desc.getSymbol(); + } + + private Descriptor getDescriptor(int idx, FlowNode node) { + Descriptor desc = node.getDescTuple().get(idx); + return desc; + } + + private void calculatePCLOC(MethodDescriptor md) { + + System.out.println("#calcualtePCLOC"); + MethodSummary methodSummary = getMethodSummary(md); + FlowGraph fg = getFlowGraph(md); + Map mapParamToLoc = methodSummary.getMapParamIdxToInferLoc(); + + // calculate the initial program counter location + // PC location is higher than location types of parameters which has incoming flows. + + Set> paramLocTupleHavingInFlowSet = new HashSet>(); + Set paramDescNOTHavingInFlowSet = new HashSet(); + // Set paramNodeNOThavingInFlowSet = new HashSet(); + + int numParams = fg.getNumParameters(); + for (int i = 0; i < numParams; i++) { + FlowNode paramFlowNode = fg.getParamFlowNode(i); + Descriptor prefix = paramFlowNode.getDescTuple().get(0); + NTuple paramDescTuple = paramFlowNode.getCurrentDescTuple(); + NTuple paramLocTuple = translateToLocTuple(md, paramDescTuple); + + if (fg.getIncomingNodeSetByPrefix(prefix).size() > 0) { + // parameter has in-value flows + paramLocTupleHavingInFlowSet.add(paramLocTuple); + } else { + // paramNodeNOThavingInFlowSet.add(fg.getFlowNode(paramDescTuple)); + paramDescNOTHavingInFlowSet.add(prefix); + } + } + + System.out.println("paramNodeNOThavingInFlowSet=" + paramDescNOTHavingInFlowSet); + + if (paramLocTupleHavingInFlowSet.size() > 0 + && !coversAllParamters(md, fg, paramLocTupleHavingInFlowSet)) { + + // Here, generates a location in the method lattice that is higher than the + // paramLocTupleHavingInFlowSet + NTuple pcLocTuple = + generateLocTupleRelativeTo(md, paramLocTupleHavingInFlowSet, PCLOC); + + NTuple pcDescTuple = translateToDescTuple(pcLocTuple); + + // add ordering relations s.t. PCLOC is higher than all flow nodes except the set of + // parameters that do not have incoming flows + + for (Iterator iterator = fg.getNodeSet().iterator(); iterator.hasNext();) { + FlowNode node = (FlowNode) iterator.next(); + + if (!paramDescNOTHavingInFlowSet.contains(node.getCurrentDescTuple().get(0))) { + fg.addValueFlowEdge(pcDescTuple, node.getDescTuple()); + } + } + + System.out.println("pcLoc=" + pcLocTuple); + + methodSummary.setPCLoc(new CompositeLocation(pcLocTuple)); + } + } + + private boolean coversAllParamters(MethodDescriptor md, FlowGraph fg, + Set> paramLocTupleHavingInFlowSet) { + + int numParam = fg.getNumParameters(); + int size = paramLocTupleHavingInFlowSet.size(); + + if (!md.isStatic()) { + + // if the method is not static && there is a parameter composite location && + // it is started with 'this', + // paramLocTupleHavingInFlowSet need to have 'this' parameter. + + FlowNode thisParamNode = fg.getParamFlowNode(0); + NTuple thisParamLocTuple = + translateToLocTuple(md, thisParamNode.getCurrentDescTuple()); + + if (!paramLocTupleHavingInFlowSet.contains(thisParamLocTuple)) { + + for (Iterator iterator = paramLocTupleHavingInFlowSet.iterator(); iterator.hasNext();) { + NTuple paramTuple = (NTuple) iterator.next(); + if (paramTuple.size() > 1 && paramTuple.get(0).getLocDescriptor().equals(md.getThis())) { + // paramLocTupleHavingInFlowSet.add(thisParamLocTuple); + // break; + size++; + } + } + + } + } + + if (size == numParam) { + return true; + } else { + return false; + } + + } + + private void calculateRETURNLOC(MethodDescriptor md) { + + System.out.println("#calculateRETURNLOC= " + md); + // calculate a return location: + // the return location type is lower than all parameters and the location of return values + MethodSummary methodSummary = getMethodSummary(md); + FlowGraph fg = getFlowGraph(md); + Map mapParamToLoc = methodSummary.getMapParamIdxToInferLoc(); + Set paramIdxSet = mapParamToLoc.keySet(); + + if (!md.getReturnType().isVoid()) { + // first, generate the set of return value location types that starts + // with 'this' reference + + Set paramFlowNodeFlowingToReturnValueSet = getParamNodeFlowingToReturnValue(md); + System.out.println("paramFlowNodeFlowingToReturnValueSet=" + + paramFlowNodeFlowingToReturnValueSet); + + Set> tupleToBeHigherThanReturnLocSet = new HashSet>(); + for (Iterator iterator = paramFlowNodeFlowingToReturnValueSet.iterator(); iterator.hasNext();) { + FlowNode fn = (FlowNode) iterator.next(); + NTuple paramDescTuple = fn.getCurrentDescTuple(); + tupleToBeHigherThanReturnLocSet.add(translateToLocTuple(md, paramDescTuple)); + } + + Set returnNodeSet = fg.getReturnNodeSet(); + for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) { + FlowNode returnNode = (FlowNode) iterator.next(); + NTuple returnDescTuple = returnNode.getCurrentDescTuple(); + tupleToBeHigherThanReturnLocSet.add(translateToLocTuple(md, returnDescTuple)); + } + System.out.println("-flow graph's returnNodeSet=" + returnNodeSet); + System.out.println("tupleSetToBeHigherThanReturnLoc=" + tupleToBeHigherThanReturnLocSet); + + // Here, generates a return location in the method lattice that is lower than the + // locFlowingToReturnValueSet + NTuple returnLocTuple = + generateLocTupleRelativeTo(md, tupleToBeHigherThanReturnLocSet, RLOC); + + System.out.println("returnLocTuple=" + returnLocTuple); + + NTuple returnDescTuple = translateToDescTuple(returnLocTuple); + for (Iterator iterator = tupleToBeHigherThanReturnLocSet.iterator(); iterator.hasNext();) { + NTuple higherTuple = (NTuple) iterator.next(); + fg.addValueFlowEdge(translateToDescTuple(higherTuple), returnDescTuple); + } + + fg.getFlowNode(returnDescTuple).setSkeleton(true); + System.out.println("fg node set=" + fg.getNodeSet()); + + methodSummary.setRETURNLoc(new CompositeLocation(returnLocTuple)); + + // skip: for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) { + // FlowNode returnNode = (FlowNode) iterator.next(); + // + // NTuple returnDescTuple = returnNode.getCurrentDescTuple(); + // NTuple returnLocTuple = translateToLocTuple(md, returnDescTuple); + // + // if (returnLocTuple.get(0).getLocDescriptor().equals(md.getThis())) { + // // 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(returnLocTuple)) + // && !isGreaterThan(methodLattice, paramInferLoc, inferReturnLoc)) { + // continue skip; + // } + // } + // inferFieldReturnLocSet.add(returnLocTuple); + // + // } + // } + + // if (inferFieldReturnLocSet.size() > 0) { + // + // // CompositeLocation returnLoc = getLowest(methodLattice, inferFieldReturnLocSet); + // CompositeLocation returnLoc = null; + // if (returnLoc == null) { + // // in this case, assign <'this',bottom> to the RETURNLOC + // returnLoc = new CompositeLocation(new Location(md, md.getThis().getSymbol())); + // returnLoc.addLocation(new Location(md.getClassDesc(), getLattice(md.getClassDesc()) + // .getBottomItem())); + // } + // methodInfo.setReturnLoc(returnLoc); + // + // } else { + // String returnLocSymbol = "RETURNLOC"; + // CompositeLocation returnLocInferLoc = + // new CompositeLocation(new Location(md, returnLocSymbol)); + // methodInfo.setReturnLoc(returnLocInferLoc); + // + // for (Iterator iterator = paramIdxSet.iterator(); iterator.hasNext();) { + // Integer paramIdx = (Integer) iterator.next(); + // CompositeLocation inferLoc = mapParamToLoc.get(paramIdx); + // String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier(); + // if (!methodLattice.isGreaterThan(paramLocLocalSymbol, returnLocSymbol)) { + // // TODO + // // 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)) { + // // TODO + // // addRelation(methodLattice, methodInfo, inferLoc, + // // returnLocInferLoc); + // } + // } + // + // } + + } + } + + private void calculateExtraLocations(MethodDescriptor md) { + // calcualte pcloc, returnloc,... + + System.out.println("\nSSJAVA:Calculate PCLOC/RETURNLOC locations: " + md); + + calculatePCLOC(md); + calculateRETURNLOC(md); + + } + + private NTuple generateLocTupleRelativeTo(MethodDescriptor md, + Set> paramLocTupleHavingInFlowSet, String locNamePrefix) { + + System.out.println("-generateLocTupleRelativeTo=" + paramLocTupleHavingInFlowSet); + + NTuple higherLocTuple = new NTuple(); + + VarDescriptor thisVarDesc = md.getThis(); + // check if all paramter loc tuple is started with 'this' reference + boolean hasParamNotStartedWithThisRef = false; + + int minSize = 0; + + Set> paramLocTupleStartedWithThis = new HashSet>(); + + for (Iterator iterator = paramLocTupleHavingInFlowSet.iterator(); iterator.hasNext();) { + NTuple paramLocTuple = (NTuple) iterator.next(); + if (!paramLocTuple.get(0).getLocDescriptor().equals(thisVarDesc)) { + hasParamNotStartedWithThisRef = true; + } else if (paramLocTuple.size() > 1) { + paramLocTupleStartedWithThis.add(paramLocTuple); + if (minSize == 0 || minSize > paramLocTuple.size()) { + minSize = paramLocTuple.size(); + } + } + } + + System.out.println("---paramLocTupleStartedWithThis=" + paramLocTupleStartedWithThis); + Descriptor enclosingDesc = md; + if (hasParamNotStartedWithThisRef) { + // in this case, PCLOC will be the local location + } else { + // all parameter is started with 'this', so PCLOC will be set relative to the composite + // location started with 'this'. + for (int idx = 0; idx < minSize - 1; idx++) { + Set locDescSet = new HashSet(); + Location curLoc = null; + NTuple paramLocTuple = null; + for (Iterator iterator = paramLocTupleStartedWithThis.iterator(); iterator.hasNext();) { + paramLocTuple = (NTuple) iterator.next(); + System.out.println("-----paramLocTuple=" + paramLocTuple + " idx=" + idx); + curLoc = paramLocTuple.get(idx); + Descriptor locDesc = curLoc.getLocDescriptor(); + locDescSet.add(locDesc); + } + System.out.println("-----locDescSet=" + locDescSet + " idx=" + idx); + if (locDescSet.size() != 1) { + break; + } + Location newLocElement = new Location(curLoc.getDescriptor(), curLoc.getLocDescriptor()); + higherLocTuple.add(newLocElement); + enclosingDesc = getClassTypeDescriptor(curLoc.getLocDescriptor()); + } + + } + + String pcLocIdentifier = locNamePrefix + (locSeed++); + NameDescriptor pcLocDesc = new NameDescriptor(pcLocIdentifier); + Location newLoc = new Location(enclosingDesc, pcLocDesc); + higherLocTuple.add(newLoc); + + System.out.println("---new loc tuple=" + higherLocTuple); + + return higherLocTuple; + + } + + public ClassDescriptor getClassTypeDescriptor(Descriptor in) { + + if (in instanceof VarDescriptor) { + return ((VarDescriptor) in).getType().getClassDesc(); + } else if (in instanceof FieldDescriptor) { + return ((FieldDescriptor) in).getType().getClassDesc(); + } + // else if (in instanceof LocationDescriptor) { + // // here is the case that the descriptor 'in' is the last element of the assigned composite + // // location + // return ((VarDescriptor) locTuple.get(0).getLocDescriptor()).getType().getClassDesc(); + // } + else { + return null; + } + + } + + private Set> calculateHighestLocTupleSet( + Set> paramLocTupleHavingInFlowSet) { + + Set> highestSet = new HashSet>(); + + Iterator> iterator = paramLocTupleHavingInFlowSet.iterator(); + NTuple highest = iterator.next(); + + for (; iterator.hasNext();) { + NTuple curLocTuple = (NTuple) iterator.next(); + if (isHigherThan(curLocTuple, highest)) { + System.out.println(curLocTuple + " is greater than " + highest); + highest = curLocTuple; + } + } + + highestSet.add(highest); + + MethodDescriptor md = (MethodDescriptor) highest.get(0).getDescriptor(); + VarDescriptor thisVarDesc = md.getThis(); + + System.out.println("highest=" + highest); + + for (Iterator> iter = paramLocTupleHavingInFlowSet.iterator(); iter.hasNext();) { + NTuple curLocTuple = iter.next(); + + if (!curLocTuple.equals(highest) && !hasOrderingRelation(highest, curLocTuple)) { + + System.out.println("add it to the highest set=" + curLocTuple); + highestSet.add(curLocTuple); + + } + } + + return highestSet; + + } + + private void calculateExtraLocations2(MethodDescriptor md) { + // calcualte pcloc, returnloc,... + + SSJavaLattice methodLattice = getMethodLattice(md); + MethodLocationInfo methodInfo = getMethodLocationInfo(md); + FlowGraph fg = getFlowGraph(md); + Set nodeSet = fg.getNodeSet(); + + 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); + } + + } + } + + Map mapParamToLoc = methodInfo.getMapParamIdxToInferLoc(); + Set paramIdxSet = mapParamToLoc.keySet(); + + if (!ssjava.getMethodContainingSSJavaLoop().equals(md)) { + // calculate the initial program counter location + // PC location is higher than location types of all parameters + String pcLocSymbol = "PCLOC"; + + Set paramInFlowSet = new HashSet(); + + for (Iterator iterator = paramIdxSet.iterator(); iterator.hasNext();) { + Integer paramIdx = (Integer) iterator.next(); + + FlowNode paramFlowNode = fg.getParamFlowNode(paramIdx); + + if (fg.getIncomingFlowNodeSet(paramFlowNode).size() > 0) { + // parameter has in-value flows + CompositeLocation inferLoc = mapParamToLoc.get(paramIdx); + paramInFlowSet.add(inferLoc); + } + } + + if (paramInFlowSet.size() > 0) { + CompositeLocation lowestLoc = getLowest(methodLattice, paramInFlowSet); + assert (lowestLoc != null); + methodInfo.setPCLoc(lowestLoc); + } + + } + + // calculate a return location + // the return location type is lower than all parameters and location + // types + // of return values + if (!md.getReturnType().isVoid()) { + // first, generate the set of return value location types that starts + // with + // 'this' reference + + Set inferFieldReturnLocSet = new HashSet(); + + Set paramFlowNode = getParamNodeFlowingToReturnValue(md); + Set inferParamLocSet = new HashSet(); + 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); + } + } - newlyInsertedLocName = inferLocation.get(inferLocation.getSize() - 1).getLocIdentifier(); + Set returnNodeSet = fg.getReturnNodeSet(); + + skip: for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) { + FlowNode returnNode = (FlowNode) iterator.next(); + CompositeLocation inferReturnLoc = + generateInferredCompositeLocation(methodInfo, fg.getLocationTuple(returnNode)); + 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 = incomingCommonPrefixSet.iterator(); iterator.hasNext();) { - NTuple tuple = (NTuple) iterator.next(); + if (inferFieldReturnLocSet.size() > 0) { - Location loc = tuple.get(idx); - String higher = locInfo.getFieldInferLocation(loc.getLocDescriptor()).getLocIdentifier(); - System.out.println("--"); - System.out.println("add in-flow relation:"); - addRelationHigherToLower(lattice, locInfo, higher, newlyInsertedLocName); + CompositeLocation returnLoc = getLowest(methodLattice, inferFieldReturnLocSet); + if (returnLoc == null) { + // in this case, assign <'this',bottom> to the RETURNLOC + returnLoc = new CompositeLocation(new Location(md, md.getThis().getSymbol())); + returnLoc.addLocation(new Location(md.getClassDesc(), getLattice(md.getClassDesc()) + .getBottomItem())); } - System.out.println("end of add-inflow relation"); + methodInfo.setReturnLoc(returnLoc); - for (Iterator iterator = localInNodeSet.iterator(); iterator.hasNext();) { - FlowNode localNode = (FlowNode) iterator.next(); + } else { + String returnLocSymbol = "RETURNLOC"; + CompositeLocation returnLocInferLoc = + new CompositeLocation(new Location(md, returnLocSymbol)); + methodInfo.setReturnLoc(returnLocInferLoc); + + for (Iterator iterator = paramIdxSet.iterator(); iterator.hasNext();) { + Integer paramIdx = (Integer) iterator.next(); + CompositeLocation inferLoc = mapParamToLoc.get(paramIdx); + String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier(); + if (!methodLattice.isGreaterThan(paramLocLocalSymbol, returnLocSymbol)) { + // TODO + // addRelationHigherToLower(methodLattice, methodInfo, + // paramLocLocalSymbol, + // returnLocSymbol); + } + } - if (localNode.equals(flowNode)) { - continue; + for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) { + FlowNode returnNode = (FlowNode) iterator.next(); + CompositeLocation inferLoc = + generateInferredCompositeLocation(methodInfo, fg.getLocationTuple(returnNode)); + if (!isGreaterThan(methodLattice, inferLoc, returnLocInferLoc)) { + // TODO + // addRelation(methodLattice, methodInfo, inferLoc, + // returnLocInferLoc); } + } + + } + + } + } + + private Set getHigherLocSymbolThan(SSJavaLattice lattice, String loc) { + Set higherLocSet = new HashSet(); + + Set 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 methodLattice, + Set 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 ((!loc.equals(lowest)) && (!isComparable(methodLattice, lowest, loc))) { + // if there is a case where composite locations are incomparable, just + // return null + return null; + } + + if ((!loc.equals(lowest)) && isGreaterThan(methodLattice, lowest, loc)) { + lowest = loc; + } + } + return lowest; + } + + private boolean isComparable(SSJavaLattice methodLattice, CompositeLocation comp1, + CompositeLocation comp2) { + + int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize(); + + for (int idx = 0; idx < size; idx++) { + Location loc1 = comp1.get(idx); + Location loc2 = comp2.get(idx); + + Descriptor desc1 = loc1.getDescriptor(); + Descriptor desc2 = loc2.getDescriptor(); + + if (!desc1.equals(desc2)) { + throw new Error("Fail to compare " + comp1 + " and " + comp2); + } + + String symbol1 = loc1.getLocIdentifier(); + String symbol2 = loc2.getLocIdentifier(); + + SSJavaLattice lattice; + if (idx == 0) { + lattice = methodLattice; + } else { + lattice = getLattice(desc1); + } + + if (symbol1.equals(symbol2)) { + continue; + } else if (!lattice.isComparable(symbol1, symbol2)) { + return false; + } + + } + + return true; + } + + private boolean isGreaterThan(SSJavaLattice methodLattice, CompositeLocation comp1, + CompositeLocation comp2) { + + int size = comp1.getSize() >= comp2.getSize() ? comp2.getSize() : comp1.getSize(); + + for (int idx = 0; idx < size; idx++) { + Location loc1 = comp1.get(idx); + Location loc2 = comp2.get(idx); + + Descriptor desc1 = loc1.getDescriptor(); + Descriptor desc2 = loc2.getDescriptor(); + + if (!desc1.equals(desc2)) { + throw new Error("Fail to compare " + comp1 + " and " + comp2); + } + + String symbol1 = loc1.getLocIdentifier(); + String symbol2 = loc2.getLocIdentifier(); + + SSJavaLattice lattice; + if (idx == 0) { + lattice = methodLattice; + } else { + lattice = getLattice(desc1); + } + + if (symbol1.equals(symbol2)) { + continue; + } else if (lattice.isGreaterThan(symbol1, symbol2)) { + return true; + } else { + return false; + } + + } + + return false; + } + + private void contributeCalleeFlows(MethodInvokeNode min, MethodDescriptor mdCaller, + MethodDescriptor mdCallee) { + + System.out.println("\n##contributeCalleeFlows callee=" + mdCallee + "TO caller=" + mdCaller); + + getSubGlobalFlowGraph(mdCallee); + + } + + private GlobalFlowGraph getSubGlobalFlowGraph(MethodDescriptor md) { + return mapMethodDescriptorToSubGlobalFlowGraph.get(md); + } + + private void propagateFlowsToCallerWithNoCompositeLocation(MethodInvokeNode min, + MethodDescriptor mdCaller, MethodDescriptor mdCallee) { + + // if the parameter A reaches to the parameter B + // then, add an edge the argument A -> the argument B to the caller's flow + // graph + + FlowGraph calleeFlowGraph = getFlowGraph(mdCallee); + FlowGraph callerFlowGraph = getFlowGraph(mdCaller); + int numParam = calleeFlowGraph.getNumParameters(); + + for (int i = 0; i < numParam; i++) { + for (int k = 0; k < numParam; k++) { + + if (i != k) { - CompositeLocation inNodeInferLoc = - generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(localNode)); + FlowNode paramNode1 = calleeFlowGraph.getParamFlowNode(i); + FlowNode paramNode2 = calleeFlowGraph.getParamFlowNode(k); - if (isCompositeLocation(inNodeInferLoc)) { - // need to make sure that newLocSymbol is lower than the infernode - // location in the field lattice - System.out.println("--- srcNode=" + localNode + " dstNode=" + flowNode); - addRelation(methodLattice, methodInfo, inNodeInferLoc, inferLocation); + NTuple arg1Tuple = getNodeTupleByArgIdx(min, i); + NTuple arg2Tuple = getNodeTupleByArgIdx(min, k); + + // check if the callee propagates an ordering constraints through + // parameters + + Set localReachSet = calleeFlowGraph.getLocalReachFlowNodeSetFrom(paramNode1); + // System.out.println("-param1=" + paramNode1 + " is higher than param2=" + paramNode2); + // System.out.println("-- localReachSet from param1=" + localReachSet); + + if (arg1Tuple.size() > 0 && arg2Tuple.size() > 0 && localReachSet.contains(paramNode2)) { + // need to propagate an ordering relation s.t. arg1 is higher + // than arg2 + + // System.out + // .println("-arg1Tuple=" + arg1Tuple + " is higher than arg2Tuple=" + arg2Tuple); + + // otherwise, flows between method/field locations... + callerFlowGraph.addValueFlowEdge(arg1Tuple, arg2Tuple); + // System.out.println("arg1=" + arg1Tuple + " arg2=" + arg2Tuple); } + System.out.println(); } + } + } + // System.out.println("##\n"); + + } + + private void propagateFlowsToCaller(MethodInvokeNode min, MethodDescriptor mdCaller, + MethodDescriptor mdCallee) { + + System.out.println("\n##PROPAGATE callee=" + mdCallee + "TO caller=" + mdCaller); + + // if the parameter A reaches to the parameter B + // then, add an edge the argument A -> the argument B to the caller's flow + // graph + + // TODO + // also if a parameter is a composite location and is started with "this" + // reference, + // need to make sure that the corresponding argument is higher than the + // translated location of + // the parameter. + + FlowGraph calleeFlowGraph = getFlowGraph(mdCallee); + FlowGraph callerFlowGraph = getFlowGraph(mdCaller); + int numParam = calleeFlowGraph.getNumParameters(); + + for (int i = 0; i < numParam; i++) { + for (int k = 0; k < numParam; k++) { + + if (i != k) { + + FlowNode paramNode1 = calleeFlowGraph.getParamFlowNode(i); + FlowNode paramNode2 = calleeFlowGraph.getParamFlowNode(k); + + System.out.println("param1=" + paramNode1 + " curDescTuple=" + + paramNode1.getCurrentDescTuple()); + System.out.println("param2=" + paramNode2 + " curDescTuple=" + + paramNode2.getCurrentDescTuple()); + + // TODO: deprecated method + // NodeTupleSet tupleSetArg1 = getNodeTupleSetByArgIdx(min, i); + // NodeTupleSet tupleSetArg2 = getNodeTupleSetByArgIdx(min, k); + NodeTupleSet tupleSetArg1 = null; + NodeTupleSet tupleSetArg2 = null; + + for (Iterator> iter1 = tupleSetArg1.iterator(); iter1.hasNext();) { + NTuple arg1Tuple = iter1.next(); + + for (Iterator> iter2 = tupleSetArg2.iterator(); iter2.hasNext();) { + NTuple arg2Tuple = iter2.next(); + + // check if the callee propagates an ordering constraints through + // parameters + + Set localReachSet = + calleeFlowGraph.getLocalReachFlowNodeSetFrom(paramNode1); + + if (localReachSet.contains(paramNode2)) { + // need to propagate an ordering relation s.t. arg1 is higher + // than arg2 + + System.out + .println("-param1=" + paramNode1 + " is higher than param2=" + paramNode2); + System.out.println("-arg1Tuple=" + arg1Tuple + " is higher than arg2Tuple=" + + arg2Tuple); + + if (!min.getMethod().isStatic()) { + // check if this is the case that values flow to/from the + // current object reference 'this' + + NTuple baseTuple = mapMethodInvokeNodeToBaseTuple.get(min); + Descriptor baseRef = baseTuple.get(baseTuple.size() - 1); + + System.out.println("paramNode1.getCurrentDescTuple()=" + + paramNode1.getCurrentDescTuple()); + // calculate the prefix of the argument + + if (arg2Tuple.size() == 1 && arg2Tuple.get(0).equals(baseRef)) { + // in this case, the callee flow causes a caller flow to the + // object whose method + // is invoked. + + if (!paramNode1.getCurrentDescTuple().startsWith(mdCallee.getThis())) { + // check whether ??? + + NTuple param1Prefix = + calculatePrefixForParam(callerFlowGraph, calleeFlowGraph, min, arg1Tuple, + paramNode1); + + if (param1Prefix != null && param1Prefix.startsWith(mdCallee.getThis())) { + // in this case, we need to create a new edge + // 'this.FIELD'->'this' + // but we couldn't... instead we assign a new composite + // location started + // with 'this' reference to the corresponding parameter + + CompositeLocation compLocForParam1 = + generateCompositeLocation(mdCallee, param1Prefix); + + System.out + .println("set comp loc=" + compLocForParam1 + " to " + paramNode1); + paramNode1.setCompositeLocation(compLocForParam1); + + // then, we need to make sure that the corresponding + // argument in the caller + // is required to be higher than or equal to the + // translated parameter + // location + + NTuple translatedParamTuple = + translateCompositeLocationToCaller(min, compLocForParam1); + + // TODO : check if the arg >= the tranlated parameter + + System.out.println("add a flow edge= " + arg1Tuple + "->" + + translatedParamTuple); + callerFlowGraph.addValueFlowEdge(arg1Tuple, translatedParamTuple); + + continue; + + } + + } else { + // param1 has already been assigned a composite location + + System.out.println("--param1 has already been assigned a composite location"); + CompositeLocation compLocForParam1 = paramNode1.getCompositeLocation(); + NTuple translatedParamTuple = + translateCompositeLocationToCaller(min, compLocForParam1); + + // TODO : check if the arg >= the tranlated parameter + + System.out.println("add a flow edge= " + arg1Tuple + "->" + + translatedParamTuple); + callerFlowGraph.addValueFlowEdge(arg1Tuple, translatedParamTuple); + + continue; + + } + + } else if (arg1Tuple.size() == 1 && arg1Tuple.get(0).equals(baseRef)) { + // in this case, the callee flow causes a caller flow + // originated from the object + // whose + // method is invoked. + + System.out.println("###FROM CASE"); + + if (!paramNode2.getCurrentDescTuple().startsWith(mdCallee.getThis())) { + + NTuple param2Prefix = + calculatePrefixForParam(callerFlowGraph, calleeFlowGraph, min, arg2Tuple, + paramNode2); + + if (param2Prefix != null && param2Prefix.startsWith(mdCallee.getThis())) { + // in this case, we need to create a new edge 'this' -> + // 'this.FIELD' but we couldn't... instead we assign the + // corresponding + // parameter a new composite location started with + // 'this' reference + + CompositeLocation compLocForParam2 = + generateCompositeLocation(mdCallee, param2Prefix); + + // System.out.println("set comp loc=" + compLocForParam2 + // + + // " to " + paramNode2); + paramNode1.setCompositeLocation(compLocForParam2); + continue; + } + } + + } + } + + // otherwise, flows between method/field locations... + callerFlowGraph.addValueFlowEdge(arg1Tuple, arg2Tuple); + System.out.println("arg1=" + arg1Tuple + " arg2=" + arg2Tuple); + + } + + } - for (Iterator iterator = reachableCommonPrefixSet.iterator(); iterator.hasNext();) { - NTuple tuple = (NTuple) iterator.next(); - if (tuple.size() > idx) { - Location loc = tuple.get(idx); - String lower = locInfo.getFieldInferLocation(loc.getLocDescriptor()).getLocIdentifier(); - // lattice.addRelationHigherToLower(newlyInsertedLocName, lower); - System.out.println("add out-flow relation:"); - addRelationHigherToLower(lattice, locInfo, newlyInsertedLocName, lower); } + System.out.println(); + } + } + } + System.out.println("##\n"); + } + + private NTuple translateCompositeLocationToCaller(MethodInvokeNode min, + CompositeLocation compLocForParam1) { + NTuple baseTuple = mapMethodInvokeNodeToBaseTuple.get(min); + + NTuple tuple = new NTuple(); + + for (int i = 0; i < baseTuple.size(); i++) { + tuple.add(baseTuple.get(i)); + } + + for (int i = 1; i < compLocForParam1.getSize(); i++) { + Location loc = compLocForParam1.get(i); + tuple.add(loc.getLocDescriptor()); + } + + return tuple; + } + + private CompositeLocation generateCompositeLocation(NTuple prefixLocTuple) { + + System.out.println("generateCompositeLocation=" + prefixLocTuple); + + CompositeLocation newCompLoc = new CompositeLocation(); + for (int i = 0; i < prefixLocTuple.size(); i++) { + newCompLoc.addLocation(prefixLocTuple.get(i)); + } + + Descriptor lastDescOfPrefix = prefixLocTuple.get(prefixLocTuple.size() - 1).getLocDescriptor(); + + ClassDescriptor enclosingDescriptor; + if (lastDescOfPrefix instanceof FieldDescriptor) { + enclosingDescriptor = ((FieldDescriptor) lastDescOfPrefix).getType().getClassDesc(); + // System.out.println("enclosingDescriptor0=" + enclosingDescriptor); + } else if (lastDescOfPrefix.equals(GLOBALDESC)) { + MethodDescriptor currentMethodDesc = (MethodDescriptor) prefixLocTuple.get(0).getDescriptor(); + enclosingDescriptor = currentMethodDesc.getClassDesc(); + } else { + // var descriptor case + enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc(); + } + // System.out.println("enclosingDescriptor=" + enclosingDescriptor); + + LocationDescriptor newLocDescriptor = generateNewLocationDescriptor(); + newLocDescriptor.setEnclosingClassDesc(enclosingDescriptor); + + Location newLoc = new Location(enclosingDescriptor, newLocDescriptor.getSymbol()); + newLoc.setLocDescriptor(newLocDescriptor); + newCompLoc.addLocation(newLoc); + + // System.out.println("--newCompLoc=" + newCompLoc); + return newCompLoc; + } + + private CompositeLocation generateCompositeLocation(MethodDescriptor md, + NTuple paramPrefix) { + + System.out.println("generateCompositeLocation=" + paramPrefix); + + CompositeLocation newCompLoc = convertToCompositeLocation(md, paramPrefix); + + Descriptor lastDescOfPrefix = paramPrefix.get(paramPrefix.size() - 1); + // System.out.println("lastDescOfPrefix=" + lastDescOfPrefix + " kind=" + // + lastDescOfPrefix.getClass()); + ClassDescriptor enclosingDescriptor; + if (lastDescOfPrefix instanceof FieldDescriptor) { + enclosingDescriptor = ((FieldDescriptor) lastDescOfPrefix).getType().getClassDesc(); + // System.out.println("enclosingDescriptor0=" + enclosingDescriptor); + } else { + // var descriptor case + enclosingDescriptor = ((VarDescriptor) lastDescOfPrefix).getType().getClassDesc(); + } + // System.out.println("enclosingDescriptor=" + enclosingDescriptor); + + LocationDescriptor newLocDescriptor = generateNewLocationDescriptor(); + newLocDescriptor.setEnclosingClassDesc(enclosingDescriptor); + + Location newLoc = new Location(enclosingDescriptor, newLocDescriptor.getSymbol()); + newLoc.setLocDescriptor(newLocDescriptor); + newCompLoc.addLocation(newLoc); + + // System.out.println("--newCompLoc=" + newCompLoc); + return newCompLoc; + } + + private NTuple calculatePrefixForParam(FlowGraph callerFlowGraph, + FlowGraph calleeFlowGraph, MethodInvokeNode min, NTuple arg1Tuple, + FlowNode paramNode1) { + + NTuple baseTuple = mapMethodInvokeNodeToBaseTuple.get(min); + Descriptor baseRef = baseTuple.get(baseTuple.size() - 1); + System.out.println("baseRef=" + baseRef); + + FlowNode flowNodeArg1 = callerFlowGraph.getFlowNode(arg1Tuple); + List> callerPrefixList = calculatePrefixList(callerFlowGraph, flowNodeArg1); + System.out.println("callerPrefixList=" + callerPrefixList); + + List> prefixList = calculatePrefixList(calleeFlowGraph, paramNode1); + System.out.println("###prefixList from node=" + paramNode1 + " =" + prefixList); + + List> calleePrefixList = + translatePrefixListToCallee(baseRef, min.getMethod(), callerPrefixList); + + System.out.println("calleePrefixList=" + calleePrefixList); + + Set reachNodeSetFromParam1 = calleeFlowGraph.getReachFlowNodeSetFrom(paramNode1); + System.out.println("reachNodeSetFromParam1=" + reachNodeSetFromParam1); + + for (int i = 0; i < calleePrefixList.size(); i++) { + NTuple curPrefix = calleePrefixList.get(i); + Set> reachableCommonPrefixSet = new HashSet>(); + + for (Iterator iterator2 = reachNodeSetFromParam1.iterator(); iterator2.hasNext();) { + FlowNode reachNode = (FlowNode) iterator2.next(); + if (reachNode.getCurrentDescTuple().startsWith(curPrefix)) { + reachableCommonPrefixSet.add(reachNode.getCurrentDescTuple()); + } + } + + if (!reachableCommonPrefixSet.isEmpty()) { + System.out.println("###REACHABLECOMONPREFIX=" + reachableCommonPrefixSet + + " with curPreFix=" + curPrefix); + return curPrefix; + } + + } + + return null; + } + + private List> translatePrefixListToCallee(Descriptor baseRef, + MethodDescriptor mdCallee, List> callerPrefixList) { + + List> calleePrefixList = new ArrayList>(); + + for (int i = 0; i < callerPrefixList.size(); i++) { + NTuple prefix = callerPrefixList.get(i); + if (prefix.startsWith(baseRef)) { + NTuple calleePrefix = new NTuple(); + calleePrefix.add(mdCallee.getThis()); + for (int k = 1; k < prefix.size(); k++) { + calleePrefix.add(prefix.get(k)); } - System.out.println("end of add out-flow relation"); + calleePrefixList.add(calleePrefix); + } + } + + return calleePrefixList; + + } + + private List> calculatePrefixList(FlowGraph flowGraph, FlowNode flowNode) { + + System.out.println("\n##### calculatePrefixList=" + flowNode); + + Set inNodeSet = flowGraph.getIncomingFlowNodeSet(flowNode); + inNodeSet.add(flowNode); - for (Iterator iterator = localOutNodeSet.iterator(); iterator.hasNext();) { - FlowNode localOutNode = (FlowNode) iterator.next(); + System.out.println("inNodeSet=" + inNodeSet); - if (localOutNode.equals(flowNode)) { - continue; - } + List> prefixList = new ArrayList>(); - CompositeLocation outNodeInferLoc = - generateInferredCompositeLocation(methodInfo, - flowGraph.getLocationTuple(localOutNode)); + for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) { + FlowNode inNode = (FlowNode) iterator.next(); - if (isCompositeLocation(outNodeInferLoc)) { - // need to make sure that newLocSymbol is higher than the infernode - // location - System.out.println("--- srcNode=" + flowNode + " dstNode=" + localOutNode); + NTuple inNodeTuple = inNode.getCurrentDescTuple(); - addRelation(methodLattice, methodInfo, inferLocation, outNodeInferLoc); + // CompositeLocation inNodeInferredLoc = + // generateInferredCompositeLocation(methodInfo, inNodeTuple); + // NTuple inNodeInferredLocTuple = inNodeInferredLoc.getTuple(); - } + for (int i = 1; i < inNodeTuple.size(); i++) { + NTuple prefix = inNodeTuple.subList(0, i); + if (!prefixList.contains(prefix)) { + prefixList.add(prefix); } - - return true; } - } - return false; + Collections.sort(prefixList, new Comparator>() { + public int compare(NTuple arg0, NTuple arg1) { + int s0 = arg0.size(); + int s1 = arg1.size(); + if (s0 > s1) { + return -1; + } else if (s0 == s1) { + return 0; + } else { + return 1; + } + } + }); + + return prefixList; } - private void addMapLocSymbolToInferredLocation(MethodDescriptor md, Descriptor localVar, - CompositeLocation inferLoc) { + public CompositeLocation convertToCompositeLocation(MethodDescriptor md, NTuple tuple) { - Location locElement = inferLoc.get((inferLoc.getSize() - 1)); - Descriptor enclosingDesc = locElement.getDescriptor(); - LocationInfo locInfo = getLocationInfo(enclosingDesc); - locInfo.addMapLocSymbolToRelatedInferLoc(locElement.getLocIdentifier(), md, localVar); - } + CompositeLocation compLoc = new CompositeLocation(); - private boolean isCompositeLocation(CompositeLocation cl) { - return cl.getSize() > 1; - } + Descriptor enclosingDescriptor = md; - private boolean containsNonPrimitiveElement(Set descSet) { - for (Iterator iterator = descSet.iterator(); iterator.hasNext();) { - Descriptor desc = (Descriptor) iterator.next(); + for (int i = 0; i < tuple.size(); i++) { + Descriptor curDescriptor = tuple.get(i); + Location locElement = new Location(enclosingDescriptor, curDescriptor.getSymbol()); + locElement.setLocDescriptor(curDescriptor); + compLoc.addLocation(locElement); - if (desc.equals(LocationInference.GLOBALDESC)) { - return true; - } else if (desc instanceof VarDescriptor) { - if (!((VarDescriptor) desc).getType().isPrimitive()) { - return true; - } - } else if (desc instanceof FieldDescriptor) { - if (!((FieldDescriptor) desc).getType().isPrimitive()) { - return true; - } + if (curDescriptor instanceof VarDescriptor) { + enclosingDescriptor = md.getClassDesc(); + } else if (curDescriptor instanceof FieldDescriptor) { + enclosingDescriptor = ((FieldDescriptor) curDescriptor).getClassDescriptor(); + } else if (curDescriptor instanceof NameDescriptor) { + // it is "GLOBAL LOC" case! + enclosingDescriptor = GLOBALDESC; + } else { + enclosingDescriptor = null; } } - return false; + + return compLoc; + } + + private LocationDescriptor generateNewLocationDescriptor() { + return new LocationDescriptor("Loc" + (locSeed++)); } - private void addRelationHigherToLower(SSJavaLattice lattice, LocationInfo locInfo, - String higher, String lower) throws CyclicFlowException { + private int getPrefixIndex(NTuple tuple1, NTuple tuple2) { - // if (higher.equals(lower) && lattice.isSharedLoc(higher)) { - // return; - // } - Set cycleElementSet = lattice.getPossibleCycleElements(higher, lower); + // return the index where the prefix shared by tuple1 and tuple2 is ended + // if there is no prefix shared by both of them, return -1 - boolean hasNonPrimitiveElement = false; - for (Iterator iterator = cycleElementSet.iterator(); iterator.hasNext();) { - String cycleElementLocSymbol = (String) iterator.next(); + int minSize = tuple1.size(); + if (minSize > tuple2.size()) { + minSize = tuple2.size(); + } - Set descSet = locInfo.getDescSet(cycleElementLocSymbol); - if (containsNonPrimitiveElement(descSet)) { - hasNonPrimitiveElement = true; + int idx = -1; + for (int i = 0; i < minSize; i++) { + if (!tuple1.get(i).equals(tuple2.get(i))) { break; + } else { + idx++; } } - if (hasNonPrimitiveElement) { - System.out.println("#Check cycle= " + lower + " < " + higher + " cycleElementSet=" - + cycleElementSet); - // if there is non-primitive element in the cycle, no way to merge cyclic - // elements into the shared location - throw new CyclicFlowException(); - } - - if (cycleElementSet.size() > 0) { + return idx; + } - String newSharedLoc = "SharedLoc" + (SSJavaLattice.seed++); + private CompositeLocation generateInferredCompositeLocation(MethodLocationInfo methodInfo, + NTuple tuple) { - lattice.mergeIntoSharedLocation(cycleElementSet, newSharedLoc); + // first, retrieve inferred location by the local var descriptor + CompositeLocation inferLoc = new CompositeLocation(); - for (Iterator iterator = cycleElementSet.iterator(); iterator.hasNext();) { - String oldLocSymbol = (String) iterator.next(); + CompositeLocation localVarInferLoc = + methodInfo.getInferLocation(tuple.get(0).getLocDescriptor()); - Set> inferLocSet = locInfo.getRelatedInferLocSet(oldLocSymbol); - for (Iterator iterator2 = inferLocSet.iterator(); iterator2.hasNext();) { - Pair pair = (Pair) iterator2.next(); - Descriptor enclosingDesc = pair.getFirst(); - Descriptor desc = pair.getSecond(); + localVarInferLoc.get(0).setLocDescriptor(tuple.get(0).getLocDescriptor()); - CompositeLocation inferLoc; - if (curMethodInfo.md.equals(enclosingDesc)) { - inferLoc = curMethodInfo.getInferLocation(desc); - } else { - inferLoc = getLocationInfo(enclosingDesc).getInferLocation(desc); - } + for (int i = 0; i < localVarInferLoc.getSize(); i++) { + inferLoc.addLocation(localVarInferLoc.get(i)); + } - Location locElement = inferLoc.get(inferLoc.getSize() - 1); + for (int i = 1; i < tuple.size(); i++) { + Location cur = tuple.get(i); + Descriptor enclosingDesc = cur.getDescriptor(); + Descriptor curDesc = cur.getLocDescriptor(); - locElement.setLocIdentifier(newSharedLoc); - locInfo.addMapLocSymbolToRelatedInferLoc(newSharedLoc, enclosingDesc, desc); + Location inferLocElement; + if (curDesc == null) { + // in this case, we have a newly generated location. + inferLocElement = new Location(enclosingDesc, cur.getLocIdentifier()); + } else { + String fieldLocSymbol = + getLocationInfo(enclosingDesc).getInferLocation(curDesc).get(0).getLocIdentifier(); + inferLocElement = new Location(enclosingDesc, fieldLocSymbol); + inferLocElement.setLocDescriptor(curDesc); + } - } - locInfo.removeRelatedInferLocSet(oldLocSymbol, newSharedLoc); + inferLoc.addLocation(inferLocElement); - } + } - lattice.addSharedLoc(newSharedLoc); + assert (inferLoc.get(0).getLocDescriptor().getSymbol() == inferLoc.get(0).getLocIdentifier()); + return inferLoc; + } - } else if (!lattice.isGreaterThan(higher, lower)) { - lattice.addRelationHigherToLower(higher, lower); + public LocationInfo getLocationInfo(Descriptor d) { + if (d instanceof MethodDescriptor) { + return getMethodLocationInfo((MethodDescriptor) d); + } else { + return getFieldLocationInfo((ClassDescriptor) d); } } - private void replaceOldLocWithNewLoc(SSJavaLattice methodLattice, String oldLocSymbol, - String newLocSymbol) { + private MethodLocationInfo getMethodLocationInfo(MethodDescriptor md) { - if (methodLattice.containsKey(oldLocSymbol)) { - methodLattice.substituteLocation(oldLocSymbol, newLocSymbol); + if (!mapMethodDescToMethodLocationInfo.containsKey(md)) { + mapMethodDescToMethodLocationInfo.put(md, new MethodLocationInfo(md)); } + return mapMethodDescToMethodLocationInfo.get(md); + } - private void prefixSanityCheck(List> prefixList, int curIdx, - FlowGraph flowGraph, Set reachableNodeSet) { + private LocationInfo getFieldLocationInfo(ClassDescriptor cd) { - NTuple curPrefix = prefixList.get(curIdx); + if (!mapClassToLocationInfo.containsKey(cd)) { + mapClassToLocationInfo.put(cd, new LocationInfo(cd)); + } - for (int i = curIdx + 1; i < prefixList.size(); i++) { - NTuple prefixTuple = prefixList.get(i); + return mapClassToLocationInfo.get(cd); - if (curPrefix.startsWith(prefixTuple)) { - continue; - } + } - for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) { - FlowNode reachableNode = (FlowNode) iterator2.next(); - NTuple reachLocTuple = flowGraph.getLocationTuple(reachableNode); - if (reachLocTuple.startsWith(prefixTuple)) { - // TODO - throw new Error("Failed to generate a composite location"); - } - } + private void addPrefixMapping(Map, Set>> map, + NTuple prefix, NTuple element) { + + if (!map.containsKey(prefix)) { + map.put(prefix, new HashSet>()); } + map.get(prefix).add(element); } - public boolean isPrimitiveLocalVariable(FlowNode node) { - VarDescriptor varDesc = (VarDescriptor) node.getDescTuple().get(0); - return varDesc.getType().isPrimitive(); + private boolean containsNonPrimitiveElement(Set descSet) { + for (Iterator iterator = descSet.iterator(); iterator.hasNext();) { + Descriptor desc = (Descriptor) iterator.next(); + + if (desc.equals(LocationInference.GLOBALDESC)) { + return true; + } else if (desc instanceof VarDescriptor) { + if (!((VarDescriptor) desc).getType().isPrimitive()) { + return true; + } + } else if (desc instanceof FieldDescriptor) { + if (!((FieldDescriptor) desc).getType().isPrimitive()) { + return true; + } + } + + } + return false; } private SSJavaLattice getLattice(Descriptor d) { @@ -1251,38 +3599,42 @@ public class LocationInference { md2lattice.put(md, lattice); } - private void extractRelationFromFieldFlows(ClassDescriptor cd, FlowNode srcNode, - FlowNode dstNode, int idx) throws CyclicFlowException { + private void extractFlowsBetweenFields(ClassDescriptor cd, FlowNode srcNode, FlowNode dstNode, + int idx) { - if (srcNode.getDescTuple().get(idx).equals(dstNode.getDescTuple().get(idx)) - && srcNode.getDescTuple().size() > (idx + 1) && dstNode.getDescTuple().size() > (idx + 1)) { + NTuple srcCurTuple = srcNode.getCurrentDescTuple(); + NTuple dstCurTuple = dstNode.getCurrentDescTuple(); + + if (srcCurTuple.get(idx).equals(dstCurTuple.get(idx)) && srcCurTuple.size() > (idx + 1) + && dstCurTuple.size() > (idx + 1)) { // value flow between fields: we don't need to add a binary relation // for this case - Descriptor desc = srcNode.getDescTuple().get(idx); + Descriptor desc = srcCurTuple.get(idx); ClassDescriptor classDesc; if (idx == 0) { classDesc = ((VarDescriptor) desc).getType().getClassDesc(); } else { - classDesc = ((FieldDescriptor) desc).getType().getClassDesc(); + if (desc instanceof FieldDescriptor) { + classDesc = ((FieldDescriptor) desc).getType().getClassDesc(); + } else { + // this case is that the local variable has a composite location assignment + // the following element after the composite location to the local variable + // has the enclosing descriptor of the local variable + Descriptor localDesc = srcNode.getDescTuple().get(0); + classDesc = ((VarDescriptor) localDesc).getType().getClassDesc(); + } } - - extractRelationFromFieldFlows(classDesc, srcNode, dstNode, idx + 1); + extractFlowsBetweenFields(classDesc, srcNode, dstNode, idx + 1); } else { - Descriptor srcFieldDesc = srcNode.getDescTuple().get(idx); - Descriptor dstFieldDesc = dstNode.getDescTuple().get(idx); - - // add a new binary relation of dstNode < srcNode - SSJavaLattice fieldLattice = getFieldLattice(cd); - LocationInfo fieldInfo = getFieldLocationInfo(cd); - - String srcSymbol = fieldInfo.getFieldInferLocation(srcFieldDesc).getLocIdentifier(); - String dstSymbol = fieldInfo.getFieldInferLocation(dstFieldDesc).getLocIdentifier(); + Descriptor srcFieldDesc = srcCurTuple.get(idx); + Descriptor dstFieldDesc = dstCurTuple.get(idx); - addRelationHigherToLower(fieldLattice, fieldInfo, srcSymbol, dstSymbol); + // add a new edge + getHierarchyGraph(cd).addEdge(srcFieldDesc, dstFieldDesc); } @@ -1295,7 +3647,9 @@ public class LocationInference { return cd2lattice.get(cd); } - public void constructFlowGraph() { + public LinkedList computeMethodList() { + + Set toSort = new HashSet(); setupToAnalyze(); @@ -1306,61 +3660,288 @@ public class LocationInference { ClassDescriptor cd = toAnalyzeNext(); setupToAnalazeMethod(cd); - toanalyzeMethodList.removeAll(visited); + temp_toanalyzeMethodList.removeAll(visited); while (!toAnalyzeMethodIsEmpty()) { 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 setPossibleCallees = new HashSet(); + if (md.isStatic()) { + setPossibleCallees.add(md); + } else { + setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md)); + } + + Set calleeSet = ssjava.getCallGraph().getCalleeSet(md); + Set needToAnalyzeCalleeSet = new HashSet(); + + for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) { + MethodDescriptor calleemd = (MethodDescriptor) iterator.next(); + if ((!ssjava.isTrustMethod(calleemd)) + && (!ssjava.isSSJavaUtil(calleemd.getClassDesc()))) { + if (!visited.contains(calleemd)) { + temp_toanalyzeMethodList.add(calleemd); + } + reachableCallee.add(calleemd); + needToAnalyzeCalleeSet.add(calleemd); + } + } + + mapMethodToCalleeSet.put(md, needToAnalyzeCalleeSet); + + visited.add(md); + + toSort.add(md); + } + } + } + + return ssjava.topologicalSort(toSort); + + } + + public boolean isTransitivelyCalledFrom(MethodDescriptor callee, MethodDescriptor caller) { + // if the callee is transitively invoked from the caller + // return true; + + int callerIdx = toanalyze_methodDescList.indexOf(caller); + int calleeIdx = toanalyze_methodDescList.indexOf(callee); + + if (callerIdx < calleeIdx) { + return true; + } + + return false; + + } + + public void constructFlowGraph() { + + System.out.println(""); + toanalyze_methodDescList = computeMethodList(); + + LinkedList methodDescList = + (LinkedList) toanalyze_methodDescList.clone(); + + System.out.println("@@@methodDescList=" + methodDescList); + // System.exit(0); + + 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 mapParamDescToIdx = new HashMap(); + 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); + + // System.out.println("##constructSubGlobalFlowGraph"); + // GlobalFlowGraph subGlobalFlowGraph = constructSubGlobalFlowGraph(fg); + // mapMethodDescriptorToSubGlobalFlowGraph.put(md, subGlobalFlowGraph); + // + // // TODO + // System.out.println("##addValueFlowsFromCalleeSubGlobalFlowGraph"); + // addValueFlowsFromCalleeSubGlobalFlowGraph(md, subGlobalFlowGraph); + // subGlobalFlowGraph.writeGraph("_SUBGLOBAL"); + // + // propagateFlowsFromCalleesWithNoCompositeLocation(md); + + } + } + // _debug_printGraph(); + + methodDescList = (LinkedList) toanalyze_methodDescList.clone(); + + while (!methodDescList.isEmpty()) { + MethodDescriptor md = methodDescList.removeLast(); + if (state.SSJAVADEBUG) { + System.out.println(); + System.out.println("SSJAVA: Constructing a sub global flow graph: " + md); + + GlobalFlowGraph subGlobalFlowGraph = constructSubGlobalFlowGraph(getFlowGraph(md)); + mapMethodDescriptorToSubGlobalFlowGraph.put(md, subGlobalFlowGraph); + + // TODO + System.out.println("-add Value Flows From CalleeSubGlobalFlowGraph"); + addValueFlowsFromCalleeSubGlobalFlowGraph(md, subGlobalFlowGraph); + subGlobalFlowGraph.writeGraph("_SUBGLOBAL"); + + System.out.println("-propagate Flows From Callees With No CompositeLocation"); + propagateFlowsFromCalleesWithNoCompositeLocation(md); + + } + } + + } + + private Set getMethodInvokeNodeSet(MethodDescriptor md) { + if (!mapMethodDescriptorToMethodInvokeNodeSet.containsKey(md)) { + mapMethodDescriptorToMethodInvokeNodeSet.put(md, new HashSet()); + } + return mapMethodDescriptorToMethodInvokeNodeSet.get(md); + } + + private void constructSubGlobalFlowGraph(MethodDescriptor md) { + + FlowGraph flowGraph = getFlowGraph(md); + + Set setMethodInvokeNode = getMethodInvokeNodeSet(md); + + for (Iterator iter = setMethodInvokeNode.iterator(); iter.hasNext();) { + MethodInvokeNode min = iter.next(); + propagateFlowsFromMethodInvokeNode(md, min); + } + + } + + private void propagateFlowsFromMethodInvokeNode(MethodDescriptor mdCaller, MethodInvokeNode min) { + // the transformation for a call site propagates flows through parameters + // if the method is virtual, it also grab all relations from any possible + // callees + + MethodDescriptor mdCallee = min.getMethod(); + Set setPossibleCallees = new HashSet(); + if (mdCallee.isStatic()) { + setPossibleCallees.add(mdCallee); + } else { + Set calleeSet = ssjava.getCallGraph().getMethods(mdCallee); + // removes method descriptors that are not invoked by the caller + calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller)); + setPossibleCallees.addAll(calleeSet); + } + + for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) { + MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next(); + contributeCalleeFlows(min, mdCaller, possibleMdCallee); + } + + } + + private void assignCompositeLocation(MethodDescriptor md) { + + FlowGraph flowGraph = getFlowGraph(md); + + Set nodeSet = flowGraph.getNodeSet(); + + next: for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + FlowNode flowNode = (FlowNode) iterator.next(); + + // assign a composite location only to the local variable + if (flowNode.getCurrentDescTuple().size() == 1) { + + List> prefixList = calculatePrefixList(flowGraph, flowNode); + Set reachSet = flowGraph.getReachFlowNodeSetFrom(flowNode); + + for (int i = 0; i < prefixList.size(); i++) { + NTuple curPrefix = prefixList.get(i); + Set> reachableCommonPrefixSet = new HashSet>(); + + for (Iterator iterator2 = reachSet.iterator(); iterator2.hasNext();) { + FlowNode reachNode = (FlowNode) iterator2.next(); + if (reachNode.getCurrentDescTuple().startsWith(curPrefix)) { + reachableCommonPrefixSet.add(reachNode.getCurrentDescTuple()); + } + } + + if (!reachableCommonPrefixSet.isEmpty()) { + System.out.println("NEED TO ASSIGN COMP LOC TO " + flowNode + " with prefix=" + + curPrefix); + CompositeLocation newCompLoc = generateCompositeLocation(md, curPrefix); + flowNode.setCompositeLocation(newCompLoc); + continue next; } - // creates a mapping from a method descriptor to virtual methods - Set setPossibleCallees = new HashSet(); - if (md.isStatic()) { - setPossibleCallees.add(md); - } else { - setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md)); - } + } + } + + } + + } + + private void propagateFlowsFromCalleesWithNoCompositeLocation(MethodDescriptor mdCaller) { + + // the transformation for a call site propagates flows through parameters + // if the method is virtual, it also grab all relations from any possible + // callees + + Set setMethodInvokeNode = + mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller); + + if (setMethodInvokeNode != null) { + + for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) { + MethodInvokeNode min = (MethodInvokeNode) iterator.next(); + MethodDescriptor mdCallee = min.getMethod(); + Set setPossibleCallees = new HashSet(); + if (mdCallee.isStatic()) { + setPossibleCallees.add(mdCallee); + } else { + Set calleeSet = ssjava.getCallGraph().getMethods(mdCallee); + // removes method descriptors that are not invoked by the caller + calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller)); + setPossibleCallees.addAll(calleeSet); + } + + for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) { + MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next(); + propagateFlowsToCallerWithNoCompositeLocation(min, mdCaller, possibleMdCallee); + } + + } + } - Set calleeSet = ssjava.getCallGraph().getCalleeSet(md); - Set needToAnalyzeCalleeSet = new HashSet(); + } - for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) { - MethodDescriptor calleemd = (MethodDescriptor) iterator.next(); - if ((!ssjava.isTrustMethod(calleemd)) - && (!ssjava.isSSJavaUtil(calleemd.getClassDesc()))) { - if (!visited.contains(calleemd)) { - toanalyzeMethodList.add(calleemd); - } - reachableCallee.add(calleemd); - needToAnalyzeCalleeSet.add(calleemd); - } - } + private void propagateFlowsFromCallees(MethodDescriptor mdCaller) { - mapMethodToCalleeSet.put(md, needToAnalyzeCalleeSet); + // the transformation for a call site propagates flows through parameters + // if the method is virtual, it also grab all relations from any possible + // callees - // creates a mapping from a parameter descriptor to its index - Map mapParamDescToIdx = new HashMap(); - 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)); - } + Set setMethodInvokeNode = + mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller); - FlowGraph fg = new FlowGraph(md, mapParamDescToIdx); - mapMethodDescriptorToFlowGraph.put(md, fg); + if (setMethodInvokeNode != null) { - visited.add(md); - analyzeMethodBody(cd, md); + for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) { + MethodInvokeNode min = (MethodInvokeNode) iterator.next(); + MethodDescriptor mdCallee = min.getMethod(); + Set setPossibleCallees = new HashSet(); + if (mdCallee.isStatic()) { + setPossibleCallees.add(mdCallee); + } else { + Set calleeSet = ssjava.getCallGraph().getMethods(mdCallee); + // removes method descriptors that are not invoked by the caller + calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller)); + setPossibleCallees.addAll(calleeSet); + } + for (Iterator iterator2 = setPossibleCallees.iterator(); iterator2.hasNext();) { + MethodDescriptor possibleMdCallee = (MethodDescriptor) iterator2.next(); + propagateFlowsToCaller(min, mdCaller, possibleMdCallee); } + } } - _debug_printGraph(); } private void analyzeMethodBody(ClassDescriptor cd, MethodDescriptor md) { @@ -1412,16 +3993,49 @@ public class LocationInference { break; case Kind.SwitchStatementNode: - analyzeSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn); + analyzeSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, implicitFlowTupleSet); break; } } + private void analyzeSwitchBlockNode(MethodDescriptor md, SymbolTable nametable, + SwitchBlockNode sbn, NodeTupleSet implicitFlowTupleSet) { + + analyzeFlowBlockNode(md, nametable, sbn.getSwitchBlockStatement(), implicitFlowTupleSet); + + } + private void analyzeSwitchStatementNode(MethodDescriptor md, SymbolTable nametable, - SwitchStatementNode bsn) { - // TODO Auto-generated method stub + SwitchStatementNode ssn, NodeTupleSet implicitFlowTupleSet) { + + NodeTupleSet condTupleNode = new NodeTupleSet(); + analyzeFlowExpressionNode(md, nametable, ssn.getCondition(), condTupleNode, null, + implicitFlowTupleSet, false); + + NodeTupleSet newImplicitTupleSet = new NodeTupleSet(); + + newImplicitTupleSet.addTupleSet(implicitFlowTupleSet); + newImplicitTupleSet.addTupleSet(condTupleNode); + + if (needToGenerateInterLoc(newImplicitTupleSet)) { + // need to create an intermediate node for the GLB of conditional + // locations & implicit flows + NTuple interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + for (Iterator> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) { + NTuple tuple = idxIter.next(); + addFlowGraphEdge(md, tuple, interTuple); + } + newImplicitTupleSet.clear(); + newImplicitTupleSet.addTuple(interTuple); + } + + BlockNode sbn = ssn.getSwitchBody(); + for (int i = 0; i < sbn.size(); i++) { + analyzeSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), newImplicitTupleSet); + } + } private void analyzeFlowSubBlockNode(MethodDescriptor md, SymbolTable nametable, @@ -1432,25 +4046,90 @@ public class LocationInference { private void analyzeFlowReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn, NodeTupleSet implicitFlowTupleSet) { + System.out.println("-analyzeFlowReturnNode=" + rn.printNode(0)); ExpressionNode returnExp = rn.getReturnExpression(); if (returnExp != null) { NodeTupleSet nodeSet = new NodeTupleSet(); + // if a return expression returns a literal value, nodeSet is empty analyzeFlowExpressionNode(md, nametable, returnExp, nodeSet, false); - FlowGraph fg = getFlowGraph(md); - // annotate the elements of the node set as the return location - for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { - NTuple returnDescTuple = (NTuple) iterator.next(); - fg.setReturnFlowNode(returnDescTuple); - for (Iterator iterator2 = implicitFlowTupleSet.iterator(); iterator2.hasNext();) { - NTuple implicitFlowDescTuple = (NTuple) iterator2.next(); - fg.addValueFlowEdge(implicitFlowDescTuple, returnDescTuple); + // if (implicitFlowTupleSet.size() == 1 + // && + // fg.getFlowNode(implicitFlowTupleSet.iterator().next()).isIntermediate()) + // { + // + // // since there is already an intermediate node for the GLB of implicit + // flows + // // we don't need to create another intermediate node. + // // just re-use the intermediate node for implicit flows. + // + // FlowNode meetNode = + // fg.getFlowNode(implicitFlowTupleSet.iterator().next()); + // + // for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) { + // NTuple returnNodeTuple = (NTuple) + // iterator.next(); + // fg.addValueFlowEdge(returnNodeTuple, meetNode.getDescTuple()); + // } + // + // } + + NodeTupleSet currentFlowTupleSet = new NodeTupleSet(); + + // add tuples from return node + currentFlowTupleSet.addTupleSet(nodeSet); + + // add tuples corresponding to the current implicit flows + currentFlowTupleSet.addTupleSet(implicitFlowTupleSet); + + System.out.println("---currentFlowTupleSet=" + currentFlowTupleSet); + + if (needToGenerateInterLoc(currentFlowTupleSet)) { + System.out.println("---needToGenerateInterLoc"); + FlowNode meetNode = fg.createIntermediateNode(); + for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) { + NTuple currentFlowTuple = (NTuple) iterator.next(); + fg.addValueFlowEdge(currentFlowTuple, meetNode.getDescTuple()); + } + fg.addReturnFlowNode(meetNode.getDescTuple()); + } else { + // currentFlowTupleSet = removeLiteralTuple(currentFlowTupleSet); + for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) { + NTuple currentFlowTuple = (NTuple) iterator.next(); + fg.addReturnFlowNode(currentFlowTuple); } } + + } + + } + + private NodeTupleSet removeLiteralTuple(NodeTupleSet inSet) { + NodeTupleSet tupleSet = new NodeTupleSet(); + for (Iterator> iter = inSet.iterator(); iter.hasNext();) { + NTuple tuple = iter.next(); + if (!tuple.get(0).equals(LITERALDESC)) { + tupleSet.addTuple(tuple); + } } + return tupleSet; + } + private boolean needToGenerateInterLoc(NodeTupleSet tupleSet) { + int size = 0; + for (Iterator> iter = tupleSet.iterator(); iter.hasNext();) { + NTuple descTuple = iter.next(); + if (!descTuple.get(0).equals(LITERALDESC)) { + size++; + } + } + if (size > 1) { + return true; + } else { + return false; + } } private void analyzeFlowLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln, @@ -1461,10 +4140,53 @@ public class LocationInference { NodeTupleSet condTupleNode = new NodeTupleSet(); analyzeFlowExpressionNode(md, nametable, ln.getCondition(), condTupleNode, null, implicitFlowTupleSet, false); - condTupleNode.addTupleSet(implicitFlowTupleSet); + + NodeTupleSet newImplicitTupleSet = new NodeTupleSet(); + + newImplicitTupleSet.addTupleSet(implicitFlowTupleSet); + newImplicitTupleSet.addTupleSet(condTupleNode); + + if (needToGenerateInterLoc(newImplicitTupleSet)) { + // need to create an intermediate node for the GLB of conditional + // locations & implicit flows + NTuple interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + for (Iterator> idxIter = newImplicitTupleSet.iterator(); idxIter + .hasNext();) { + NTuple tuple = idxIter.next(); + addFlowGraphEdge(md, tuple, interTuple); + } + newImplicitTupleSet.clear(); + newImplicitTupleSet.addTuple(interTuple); + + } + + // /////////// + // System.out.println("condTupleNode="+condTupleNode); + // NTuple interTuple = + // getFlowGraph(md).createIntermediateNode().getDescTuple(); + // + // for (Iterator> idxIter = condTupleNode.iterator(); + // idxIter.hasNext();) { + // NTuple tuple = idxIter.next(); + // addFlowGraphEdge(md, tuple, interTuple); + // } + + // for (Iterator> idxIter = + // implicitFlowTupleSet.iterator(); idxIter + // .hasNext();) { + // NTuple tuple = idxIter.next(); + // addFlowGraphEdge(md, tuple, interTuple); + // } + + // NodeTupleSet newImplicitSet = new NodeTupleSet(); + // newImplicitSet.addTuple(interTuple); + analyzeFlowBlockNode(md, nametable, ln.getBody(), newImplicitTupleSet); + // /////////// + + // condTupleNode.addTupleSet(implicitFlowTupleSet); // add edges from condNodeTupleSet to all nodes of conditional nodes - analyzeFlowBlockNode(md, nametable, ln.getBody(), condTupleNode); + // analyzeFlowBlockNode(md, nametable, ln.getBody(), condTupleNode); } else { // check 'for loop' case @@ -1478,10 +4200,51 @@ public class LocationInference { NodeTupleSet condTupleNode = new NodeTupleSet(); analyzeFlowExpressionNode(md, bn.getVarTable(), ln.getCondition(), condTupleNode, null, implicitFlowTupleSet, false); - condTupleNode.addTupleSet(implicitFlowTupleSet); - analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(), condTupleNode); - analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(), condTupleNode); + NodeTupleSet newImplicitTupleSet = new NodeTupleSet(); + newImplicitTupleSet.addTupleSet(implicitFlowTupleSet); + newImplicitTupleSet.addTupleSet(condTupleNode); + + if (needToGenerateInterLoc(newImplicitTupleSet)) { + // need to create an intermediate node for the GLB of conditional + // locations & implicit flows + NTuple interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + for (Iterator> idxIter = newImplicitTupleSet.iterator(); idxIter + .hasNext();) { + NTuple tuple = idxIter.next(); + addFlowGraphEdge(md, tuple, interTuple); + } + newImplicitTupleSet.clear(); + newImplicitTupleSet.addTuple(interTuple); + + } + + // /////////// + // NTuple interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + // + // for (Iterator> idxIter = condTupleNode.iterator(); idxIter.hasNext();) { + // NTuple tuple = idxIter.next(); + // addFlowGraphEdge(md, tuple, interTuple); + // } + // + // for (Iterator> idxIter = implicitFlowTupleSet.iterator(); idxIter + // .hasNext();) { + // NTuple tuple = idxIter.next(); + // addFlowGraphEdge(md, tuple, interTuple); + // } + // + // NodeTupleSet newImplicitSet = new NodeTupleSet(); + // newImplicitSet.addTuple(interTuple); + analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(), newImplicitTupleSet); + analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(), newImplicitTupleSet); + // /////////// + + // condTupleNode.addTupleSet(implicitFlowTupleSet); + // + // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(), + // condTupleNode); + // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(), + // condTupleNode); } @@ -1490,16 +4253,37 @@ public class LocationInference { private void analyzeFlowIfStatementNode(MethodDescriptor md, SymbolTable nametable, IfStatementNode isn, NodeTupleSet implicitFlowTupleSet) { + // System.out.println("analyzeFlowIfStatementNode=" + isn.printNode(0)); + NodeTupleSet condTupleNode = new NodeTupleSet(); analyzeFlowExpressionNode(md, nametable, isn.getCondition(), condTupleNode, null, implicitFlowTupleSet, false); - // add edges from condNodeTupleSet to all nodes of conditional nodes - condTupleNode.addTupleSet(implicitFlowTupleSet); - analyzeFlowBlockNode(md, nametable, isn.getTrueBlock(), condTupleNode); + NodeTupleSet newImplicitTupleSet = new NodeTupleSet(); + + newImplicitTupleSet.addTupleSet(implicitFlowTupleSet); + newImplicitTupleSet.addTupleSet(condTupleNode); + + // System.out.println("condTupleNode=" + condTupleNode); + // System.out.println("implicitFlowTupleSet=" + implicitFlowTupleSet); + // System.out.println("newImplicitTupleSet=" + newImplicitTupleSet); + + if (needToGenerateInterLoc(newImplicitTupleSet)) { + + // need to create an intermediate node for the GLB of conditional locations & implicit flows + NTuple interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + for (Iterator> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) { + NTuple tuple = idxIter.next(); + addFlowGraphEdge(md, tuple, interTuple); + } + newImplicitTupleSet.clear(); + newImplicitTupleSet.addTuple(interTuple); + } + + analyzeFlowBlockNode(md, nametable, isn.getTrueBlock(), newImplicitTupleSet); if (isn.getFalseBlock() != null) { - analyzeFlowBlockNode(md, nametable, isn.getFalseBlock(), condTupleNode); + analyzeFlowBlockNode(md, nametable, isn.getFalseBlock(), newImplicitTupleSet); } } @@ -1508,20 +4292,33 @@ public class LocationInference { DeclarationNode dn, NodeTupleSet implicitFlowTupleSet) { VarDescriptor vd = dn.getVarDescriptor(); + mapDescToDefinitionLine.put(vd, dn.getNumLine()); NTuple tupleLHS = new NTuple(); tupleLHS.add(vd); - getFlowGraph(md).createNewFlowNode(tupleLHS); + FlowNode fn = getFlowGraph(md).createNewFlowNode(tupleLHS); + fn.setDeclarationNode(); if (dn.getExpression() != null) { - NodeTupleSet tupleSetRHS = new NodeTupleSet(); - analyzeFlowExpressionNode(md, nametable, dn.getExpression(), tupleSetRHS, null, + NodeTupleSet nodeSetRHS = new NodeTupleSet(); + analyzeFlowExpressionNode(md, nametable, dn.getExpression(), nodeSetRHS, null, implicitFlowTupleSet, false); - // add a new flow edge from rhs to lhs - for (Iterator> iter = tupleSetRHS.iterator(); iter.hasNext();) { - NTuple from = iter.next(); - addFlowGraphEdge(md, from, tupleLHS); + // creates edges from RHS to LHS + NTuple interTuple = null; + if (needToGenerateInterLoc(nodeSetRHS)) { + interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + } + + for (Iterator> iter = nodeSetRHS.iterator(); iter.hasNext();) { + NTuple fromTuple = iter.next(); + addFlowGraphEdge(md, fromTuple, interTuple, tupleLHS); + } + + // creates edges from implicitFlowTupleSet to LHS + for (Iterator> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) { + NTuple implicitTuple = iter.next(); + addFlowGraphEdge(md, implicitTuple, tupleLHS); } } @@ -1552,7 +4349,8 @@ public class LocationInference { switch (en.kind()) { case Kind.AssignmentNode: - analyzeFlowAssignmentNode(md, nametable, (AssignmentNode) en, base, implicitFlowTupleSet); + analyzeFlowAssignmentNode(md, nametable, (AssignmentNode) en, nodeSet, base, + implicitFlowTupleSet); break; case Kind.FieldAccessNode: @@ -1586,11 +4384,12 @@ public class LocationInference { break; case Kind.LiteralNode: - analyzeLiteralNode(md, nametable, (LiteralNode) en); + analyzeFlowLiteralNode(md, nametable, (LiteralNode) en, nodeSet); break; case Kind.MethodInvokeNode: - analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, implicitFlowTupleSet); + analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, nodeSet, + implicitFlowTupleSet); break; case Kind.TertiaryNode: @@ -1659,12 +4458,35 @@ public class LocationInference { set.add(min); } + private void addParamNodeFlowingToReturnValue(MethodDescriptor md, FlowNode fn) { + + if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) { + mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet()); + } + mapMethodDescToParamNodeFlowsToReturnValue.get(md).add(fn); + } + + private Set getParamNodeFlowingToReturnValue(MethodDescriptor md) { + + if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) { + mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet()); + } + + return mapMethodDescToParamNodeFlowsToReturnValue.get(md); + } + private void analyzeFlowMethodInvokeNode(MethodDescriptor md, SymbolTable nametable, - MethodInvokeNode min, NodeTupleSet implicitFlowTupleSet) { + MethodInvokeNode min, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) { - addMapCallerMethodDescToMethodInvokeNodeSet(md, min); + System.out.println("analyzeFlowMethodInvokeNode=" + min.printNode(0)); - MethodDescriptor calleeMD = min.getMethod(); + mapMethodInvokeNodeToArgIdxMap.put(min, new HashMap>()); + + if (nodeSet == null) { + nodeSet = new NodeTupleSet(); + } + + MethodDescriptor calleeMethodDesc = min.getMethod(); NameDescriptor baseName = min.getBaseName(); boolean isSystemout = false; @@ -1672,129 +4494,157 @@ 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) && !isSystemout) { + + addMapCallerMethodDescToMethodInvokeNodeSet(md, min); + + FlowGraph calleeFlowGraph = getFlowGraph(calleeMethodDesc); + Set calleeReturnSet = calleeFlowGraph.getReturnNodeSet(); + + // System.out.println("-calleeReturnSet=" + calleeReturnSet); - // CompositeLocation baseLocation = null; if (min.getExpression() != null) { NodeTupleSet baseNodeSet = new NodeTupleSet(); analyzeFlowExpressionNode(md, nametable, min.getExpression(), baseNodeSet, null, implicitFlowTupleSet, false); - } else { + assert (baseNodeSet.size() == 1); + NTuple baseTuple = baseNodeSet.iterator().next(); + mapMethodInvokeNodeToBaseTuple.put(min, baseTuple); + + if (!min.getMethod().isStatic()) { + addArgIdxMap(min, 0, baseTuple); + + for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) { + FlowNode returnNode = (FlowNode) iterator.next(); + NTuple returnDescTuple = returnNode.getDescTuple(); + if (returnDescTuple.startsWith(calleeMethodDesc.getThis())) { + // the location type of the return value is started with 'this' + // reference + NTuple inFlowTuple = new NTuple(baseTuple.getList()); + inFlowTuple.addAll(returnDescTuple.subList(1, returnDescTuple.size())); + nodeSet.addTuple(inFlowTuple); + } else { + // TODO + Set inFlowSet = calleeFlowGraph.getIncomingFlowNodeSet(returnNode); + // System.out.println("inFlowSet=" + inFlowSet + " from retrunNode=" + returnNode); + for (Iterator iterator2 = inFlowSet.iterator(); iterator2.hasNext();) { + FlowNode inFlowNode = (FlowNode) iterator2.next(); + if (inFlowNode.getDescTuple().startsWith(calleeMethodDesc.getThis())) { + nodeSet.addTupleSet(baseNodeSet); + } + } + } + } + } + + } + + // analyze parameter flows + + if (min.numArgs() > 0) { + + int offset; 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)); + offset = 0; } else { - // 'this' var case - // String thisLocId = ssjava.getMethodLattice(md).getThisLoc(); - // baseLocation = new CompositeLocation(new Location(md, thisLocId)); - } - } - - // 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); - // } - // } + offset = 1; + } - analyzeFlowMethodParameters(md, nametable, min); + for (int i = 0; i < min.numArgs(); i++) { + ExpressionNode en = min.getArg(i); + int idx = i + offset; + NodeTupleSet argTupleSet = new NodeTupleSet(); + analyzeFlowExpressionNode(md, nametable, en, argTupleSet, false); + // if argument is liternal node, argTuple is set to NULL + + NTuple argTuple = new NTuple(); + if (needToGenerateInterLoc(argTupleSet)) { + NTuple interTuple = + getFlowGraph(md).createIntermediateNode().getDescTuple(); + for (Iterator> idxIter = argTupleSet.iterator(); idxIter.hasNext();) { + NTuple tuple = idxIter.next(); + addFlowGraphEdge(md, tuple, interTuple); + } + argTuple = interTuple; + } else if (argTupleSet.size() == 1) { + argTuple = argTupleSet.iterator().next(); + } else { + argTuple = new NTuple(); + } - // checkCalleeConstraints(md, nametable, min, baseLocation, constraint); + addArgIdxMap(min, idx, argTuple); - // checkCallerArgumentLocationConstraints(md, nametable, min, - // baseLocation, constraint); + FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx); + if (hasInFlowTo(calleeFlowGraph, paramNode, calleeReturnSet) + || calleeMethodDesc.getModifiers().isNative()) { + 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 NodeTupleSet getNodeTupleSetByArgIdx(MethodInvokeNode min, int idx) { - return mapMethodInvokeNodeToArgIdxMap.get(min).get(new Integer(idx)); - } + // propagateFlowsFromCallee(min, md, min.getMethod()); - private void addArgIdxMap(MethodInvokeNode min, int idx, NodeTupleSet tupleSet) { - Map mapIdxToTupleSet = mapMethodInvokeNodeToArgIdxMap.get(min); - if (mapIdxToTupleSet == null) { - mapIdxToTupleSet = new HashMap(); - mapMethodInvokeNodeToArgIdxMap.put(min, mapIdxToTupleSet); + System.out.println("min nodeSet=" + nodeSet); } - mapIdxToTupleSet.put(new Integer(idx), tupleSet); - } - private void analyzeFlowMethodParameters(MethodDescriptor callermd, SymbolTable nametable, - MethodInvokeNode min) { + } - if (min.numArgs() > 0) { + private boolean hasInFlowTo(FlowGraph fg, FlowNode inNode, Set nodeSet) { + // return true if inNode has in-flows to nodeSet - int offset; - if (min.getMethod().isStatic()) { - offset = 0; - } else { - offset = 1; - NTuple thisArgTuple = new NTuple(); - thisArgTuple.add(callermd.getThis()); - NodeTupleSet argTupleSet = new NodeTupleSet(); - argTupleSet.addTuple(thisArgTuple); - addArgIdxMap(min, 0, argTupleSet); - } + // Set reachableSet = fg.getReachFlowNodeSetFrom(inNode); + Set reachableSet = fg.getReachableSetFrom(inNode.getDescTuple()); + System.out.println("inNode=" + inNode + " reachalbeSet=" + reachableSet); - for (int i = 0; i < min.numArgs(); i++) { - ExpressionNode en = min.getArg(i); - NodeTupleSet argTupleSet = new NodeTupleSet(); - analyzeFlowExpressionNode(callermd, nametable, en, argTupleSet, false); - // if argument is liternal node, argTuple is set to NULL. - addArgIdxMap(min, i + offset, argTupleSet); + for (Iterator iterator = reachableSet.iterator(); iterator.hasNext();) { + FlowNode fn = (FlowNode) iterator.next(); + if (nodeSet.contains(fn)) { + return true; } - } + return false; + } + private NTuple getNodeTupleByArgIdx(MethodInvokeNode min, int idx) { + return mapMethodInvokeNodeToArgIdxMap.get(min).get(new Integer(idx)); } - private void analyzeLiteralNode(MethodDescriptor md, SymbolTable nametable, LiteralNode en) { + private void addArgIdxMap(MethodInvokeNode min, int idx, NTuple argTuple /* + * NodeTupleSet + * tupleSet + */) { + Map> mapIdxToTuple = mapMethodInvokeNodeToArgIdxMap.get(min); + if (mapIdxToTuple == null) { + mapIdxToTuple = new HashMap>(); + mapMethodInvokeNodeToArgIdxMap.put(min, mapIdxToTuple); + } + mapIdxToTuple.put(new Integer(idx), argTuple); + } + private void analyzeFlowLiteralNode(MethodDescriptor md, SymbolTable nametable, LiteralNode en, + NodeTupleSet nodeSet) { + NTuple tuple = new NTuple(); + tuple.add(LITERALDESC); + nodeSet.addTuple(tuple); } private void analyzeFlowArrayAccessNode(MethodDescriptor md, SymbolTable nametable, ArrayAccessNode aan, NodeTupleSet nodeSet, boolean isLHS) { NodeTupleSet expNodeTupleSet = new NodeTupleSet(); - analyzeFlowExpressionNode(md, nametable, aan.getExpression(), expNodeTupleSet, isLHS); + NTuple base = + analyzeFlowExpressionNode(md, nametable, aan.getExpression(), expNodeTupleSet, isLHS); NodeTupleSet idxNodeTupleSet = new NodeTupleSet(); analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, isLHS); if (isLHS) { // need to create an edge from idx to array - for (Iterator> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) { NTuple idxTuple = idxIter.next(); for (Iterator> arrIter = expNodeTupleSet.iterator(); arrIter.hasNext();) { @@ -1805,8 +4655,24 @@ public class LocationInference { nodeSet.addTupleSet(expNodeTupleSet); } else { - nodeSet.addTupleSet(expNodeTupleSet); - nodeSet.addTupleSet(idxNodeTupleSet); + + NodeTupleSet nodeSetArrayAccessExp = new NodeTupleSet(); + + nodeSetArrayAccessExp.addTupleSet(expNodeTupleSet); + nodeSetArrayAccessExp.addTupleSet(idxNodeTupleSet); + + if (needToGenerateInterLoc(nodeSetArrayAccessExp)) { + NTuple interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + + for (Iterator> iter = nodeSetArrayAccessExp.iterator(); iter.hasNext();) { + NTuple higherTuple = iter.next(); + addFlowGraphEdge(md, higherTuple, interTuple); + } + nodeSetArrayAccessExp.clear(); + nodeSetArrayAccessExp.addTuple(interTuple); + } + + nodeSet.addTupleSet(nodeSetArrayAccessExp); } } @@ -1879,6 +4745,8 @@ public class LocationInference { private NTuple analyzeFlowNameNode(MethodDescriptor md, SymbolTable nametable, NameNode nn, NodeTupleSet nodeSet, NTuple base, NodeTupleSet implicitFlowTupleSet) { + System.out.println("analyzeFlowNameNode=" + nn.printNode(0)); + if (base == null) { base = new NTuple(); } @@ -1913,6 +4781,7 @@ public class LocationInference { if (fd.isFinal()) { // if it is 'static final', no need to have flow node for the TOP // location + System.out.println("STATIC FINAL"); return null; } else { // if 'static', assign the default GLOBAL LOCATION to the first @@ -1929,7 +4798,7 @@ public class LocationInference { } else if (d == null) { // access static field base.add(GLOBALDESC); - // base.add(nn.getField()); + base.add(nn.getField()); return base; // FieldDescriptor fd = nn.getField();addFlowGraphEdge @@ -1950,7 +4819,6 @@ public class LocationInference { } } - getFlowGraph(md).createNewFlowNode(base); return base; @@ -1978,32 +4846,45 @@ public class LocationInference { } } + NodeTupleSet idxNodeTupleSet = new NodeTupleSet(); + if (left instanceof ArrayAccessNode) { ArrayAccessNode aan = (ArrayAccessNode) left; left = aan.getExpression(); - analyzeFlowExpressionNode(md, nametable, aan.getIndex(), nodeSet, base, implicitFlowTupleSet, - isLHS); + analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, base, + implicitFlowTupleSet, isLHS); + + nodeSet.addTupleSet(idxNodeTupleSet); } - // fanNodeSet base = analyzeFlowExpressionNode(md, nametable, left, nodeSet, base, implicitFlowTupleSet, isLHS); + if (base == null) { // in this case, field is TOP location return null; } else { + NTuple flowFieldTuple = new NTuple(base.toList()); + if (!left.getType().isPrimitive()) { if (!fd.getSymbol().equals("length")) { // array.length access, just have the location of the array - base.add(fd); + flowFieldTuple.add(fd); + nodeSet.removeTuple(base); } } + getFlowGraph(md).createNewFlowNode(flowFieldTuple); - getFlowGraph(md).createNewFlowNode(base); - return base; + if (isLHS) { + for (Iterator> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) { + NTuple idxTuple = idxIter.next(); + getFlowGraph(md).addValueFlowEdge(idxTuple, flowFieldTuple); + } + } + return flowFieldTuple; } @@ -2016,7 +4897,8 @@ public class LocationInference { } private void analyzeFlowAssignmentNode(MethodDescriptor md, SymbolTable nametable, - AssignmentNode an, NTuple base, NodeTupleSet implicitFlowTupleSet) { + AssignmentNode an, NodeTupleSet nodeSet, NTuple base, + NodeTupleSet implicitFlowTupleSet) { NodeTupleSet nodeSetRHS = new NodeTupleSet(); NodeTupleSet nodeSetLHS = new NodeTupleSet(); @@ -2045,6 +4927,7 @@ public class LocationInference { if (an.getOperation().getOp() >= 2 && an.getOperation().getOp() <= 12) { // if assignment contains OP+EQ operator, creates edges from LHS to LHS + for (Iterator> iter = nodeSetLHS.iterator(); iter.hasNext();) { NTuple fromTuple = iter.next(); for (Iterator> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) { @@ -2055,11 +4938,16 @@ public class LocationInference { } // creates edges from RHS to LHS + NTuple interTuple = null; + if (needToGenerateInterLoc(nodeSetRHS)) { + interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple(); + } + for (Iterator> iter = nodeSetRHS.iterator(); iter.hasNext();) { NTuple fromTuple = iter.next(); for (Iterator> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) { NTuple toTuple = iter2.next(); - addFlowGraphEdge(md, fromTuple, toTuple); + addFlowGraphEdge(md, fromTuple, interTuple, toTuple); } } @@ -2074,6 +4962,7 @@ public class LocationInference { } else { // postinc case + for (Iterator> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) { NTuple tuple = iter2.next(); addFlowGraphEdge(md, tuple, tuple); @@ -2090,6 +4979,9 @@ public class LocationInference { } + if (nodeSet != null) { + nodeSet.addTupleSet(nodeSetLHS); + } } public FlowGraph getFlowGraph(MethodDescriptor md) { @@ -2098,14 +4990,120 @@ public class LocationInference { private boolean addFlowGraphEdge(MethodDescriptor md, NTuple from, NTuple to) { - // TODO - // return true if it adds a new edge FlowGraph graph = getFlowGraph(md); graph.addValueFlowEdge(from, to); return true; } - public void _debug_printGraph() { + private void addFlowGraphEdge(MethodDescriptor md, NTuple from, + NTuple inter, NTuple to) { + + FlowGraph graph = getFlowGraph(md); + + if (inter != null) { + graph.addValueFlowEdge(from, inter); + graph.addValueFlowEdge(inter, to); + } else { + graph.addValueFlowEdge(from, to); + } + + } + + public void writeInferredLatticeDotFile(ClassDescriptor cd, HierarchyGraph simpleHierarchyGraph, + SSJavaLattice locOrder, String nameSuffix) { + writeInferredLatticeDotFile(cd, null, simpleHierarchyGraph, locOrder, nameSuffix); + } + + public void writeInferredLatticeDotFile(ClassDescriptor cd, MethodDescriptor md, + HierarchyGraph simpleHierarchyGraph, SSJavaLattice locOrder, String nameSuffix) { + + String fileName = "lattice_"; + if (md != null) { + fileName += + /* cd.getSymbol().replaceAll("[\\W_]", "") + "_" + */md.toString().replaceAll("[\\W_]", ""); + } else { + fileName += cd.getSymbol().replaceAll("[\\W_]", ""); + } + + fileName += nameSuffix; + + Set> pairSet = locOrder.getOrderingPairSet(); + + Set addedLocSet = new HashSet(); + + if (pairSet.size() > 0) { + try { + BufferedWriter bw = new BufferedWriter(new FileWriter(fileName + ".dot")); + + bw.write("digraph " + fileName + " {\n"); + + for (Iterator iterator = pairSet.iterator(); iterator.hasNext();) { + // pair is in the form of + Pair pair = (Pair) iterator.next(); + + String highLocId = pair.getFirst(); + String lowLocId = pair.getSecond(); + + if (!addedLocSet.contains(highLocId)) { + addedLocSet.add(highLocId); + drawNode(bw, locOrder, simpleHierarchyGraph, highLocId); + } + + if (!addedLocSet.contains(lowLocId)) { + addedLocSet.add(lowLocId); + drawNode(bw, locOrder, simpleHierarchyGraph, lowLocId); + } + + bw.write(highLocId + " -> " + lowLocId + ";\n"); + } + bw.write("}\n"); + bw.close(); + + } catch (IOException e) { + e.printStackTrace(); + } + + } + + } + + private String convertMergeSetToString(HierarchyGraph graph, Set mergeSet) { + String str = ""; + for (Iterator iterator = mergeSet.iterator(); iterator.hasNext();) { + HNode merged = (HNode) iterator.next(); + if (merged.isMergeNode()) { + str += convertMergeSetToString(graph, graph.getMapHNodetoMergeSet().get(merged)); + } else { + str += " " + merged.getName(); + } + } + return str; + } + + private void drawNode(BufferedWriter bw, SSJavaLattice lattice, HierarchyGraph graph, + String locName) throws IOException { + + HNode node = graph.getHNode(locName); + + if (node == null) { + return; + } + + String prettyStr; + if (lattice.isSharedLoc(locName)) { + prettyStr = locName + "*"; + } else { + prettyStr = locName; + } + + if (node.isMergeNode()) { + Set mergeSet = graph.getMapHNodetoMergeSet().get(node); + prettyStr += ":" + convertMergeSetToString(graph, mergeSet); + } + bw.write(locName + " [label=\"" + prettyStr + "\"]" + ";\n"); + } + + public void _debug_writeFlowGraph() { Set keySet = mapMethodDescriptorToFlowGraph.keySet(); for (Iterator iterator = keySet.iterator(); iterator.hasNext();) { @@ -2125,3 +5123,11 @@ public class LocationInference { class CyclicFlowException extends Exception { } + +class InterDescriptor extends Descriptor { + + public InterDescriptor(String name) { + super(name); + } + +}