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.Collections;
import java.util.Map;
import java.util.Set;
import java.util.Stack;
+import java.util.Vector;
-import Analysis.SSJava.FlowDownCheck.ComparisonResult;
-import Analysis.SSJava.FlowDownCheck.CompositeLattice;
import IR.ClassDescriptor;
import IR.Descriptor;
import IR.FieldDescriptor;
import IR.SymbolTable;
import IR.TypeDescriptor;
import IR.VarDescriptor;
-import IR.Flat.FlatMethod;
import IR.Tree.ArrayAccessNode;
import IR.Tree.AssignmentNode;
import IR.Tree.BlockExpressionNode;
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;
+import Util.Pair;
public class LocationInference {
State state;
SSJavaAnalysis ssjava;
- List<ClassDescriptor> toanalyzeList;
- List<MethodDescriptor> toanalyzeMethodList;
+ List<ClassDescriptor> temp_toanalyzeList;
+ List<MethodDescriptor> temp_toanalyzeMethodList;
Map<MethodDescriptor, FlowGraph> mapMethodDescriptorToFlowGraph;
+ LinkedList<MethodDescriptor> toanalyze_methodDescList;
+
// map a method descriptor to its set of parameter descriptors
Map<MethodDescriptor, Set<Descriptor>> mapMethodDescriptorToParamDescSet;
// map a method descriptor to a method lattice
private Map<MethodDescriptor, SSJavaLattice<String>> md2lattice;
- // map a method descriptor to a lattice mapping
- private Map<MethodDescriptor, Map<VarDescriptor, String>> md2LatticeMapping;
+ // map a method/class descriptor to a hierarchy graph
+ private Map<Descriptor, HierarchyGraph> mapDescriptorToHierarchyGraph;
+
+ // map a method/class descriptor to a skeleton hierarchy graph
+ private Map<Descriptor, HierarchyGraph> mapDescriptorToSkeletonHierarchyGraph;
- // map a method descriptor to a lattice mapping
- private Map<MethodDescriptor, Map<FieldDescriptor, String>> cd2LatticeMapping;
+ private Map<Descriptor, HierarchyGraph> mapDescriptorToSimpleHierarchyGraph;
- // map a method descriptor to the set of hierarchy relations that are
- // contributed from the callee
- private Map<MethodDescriptor, Set<ParamIndexRelation>> mapMethodDescriptorToCalleeParamRelationSet;
+ // map a method/class descriptor to a skeleton hierarchy graph with combination nodes
+ private Map<Descriptor, HierarchyGraph> mapDescriptorToCombineSkeletonHierarchyGraph;
+
+ // map a descriptor to a simple lattice
+ private Map<Descriptor, SSJavaLattice<String>> mapDescriptorToSimpleLattice;
// map a method descriptor to the set of method invocation nodes which are
// invoked by the method descriptor
private Map<MethodDescriptor, Set<MethodInvokeNode>> mapMethodDescriptorToMethodInvokeNodeSet;
- private Map<MethodInvokeNode, Map<Integer, NTuple<Descriptor>>> mapMethodInvokeNodeToArgIdxMap;
+ private Map<MethodInvokeNode, Map<Integer, NodeTupleSet>> mapMethodInvokeNodeToArgIdxMap;
+
+ private Map<MethodInvokeNode, NTuple<Descriptor>> mapMethodInvokeNodeToBaseTuple;
+
+ private Map<MethodDescriptor, MethodLocationInfo> mapMethodDescToMethodLocationInfo;
+
+ private Map<ClassDescriptor, LocationInfo> mapClassToLocationInfo;
+
+ private Map<MethodDescriptor, Set<MethodDescriptor>> mapMethodToCalleeSet;
+
+ private Map<MethodDescriptor, Set<FlowNode>> mapMethodDescToParamNodeFlowsToReturnValue;
+
+ private Map<String, Vector<String>> mapFileNameToLineVector;
+
+ private Map<Descriptor, Integer> mapDescToDefinitionLine;
+
+ private Map<Descriptor, LocationSummary> 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<MethodDescriptor, FlowGraph> mapMethodDescriptorToSubGlobalFlowGraph;
+
+ public static final String GLOBALLOC = "GLOBALLOC";
+
+ public static final String TOPLOC = "TOPLOC";
+
+ public static final String INTERLOC = "INTERLOC";
+
+ public static final Descriptor GLOBALDESC = new NameDescriptor(GLOBALLOC);
+
+ public static final Descriptor TOPDESC = new NameDescriptor(TOPLOC);
+
+ public static String newline = System.getProperty("line.separator");
+
+ LocationInfo curMethodInfo;
boolean debug = true;
+ private static int locSeed = 0;
+
public LocationInference(SSJavaAnalysis ssjava, State state) {
this.ssjava = ssjava;
this.state = state;
- this.toanalyzeList = new ArrayList<ClassDescriptor>();
- this.toanalyzeMethodList = new ArrayList<MethodDescriptor>();
+ this.temp_toanalyzeList = new ArrayList<ClassDescriptor>();
+ this.temp_toanalyzeMethodList = new ArrayList<MethodDescriptor>();
this.mapMethodDescriptorToFlowGraph = new HashMap<MethodDescriptor, FlowGraph>();
this.cd2lattice = new HashMap<ClassDescriptor, SSJavaLattice<String>>();
this.md2lattice = new HashMap<MethodDescriptor, SSJavaLattice<String>>();
this.methodDescriptorsToVisitStack = new Stack<MethodDescriptor>();
- this.md2LatticeMapping = new HashMap<MethodDescriptor, Map<VarDescriptor, String>>();
- this.cd2LatticeMapping = new HashMap<MethodDescriptor, Map<FieldDescriptor, String>>();
- this.mapMethodDescriptorToCalleeParamRelationSet =
- new HashMap<MethodDescriptor, Set<ParamIndexRelation>>();
this.mapMethodDescriptorToMethodInvokeNodeSet =
new HashMap<MethodDescriptor, Set<MethodInvokeNode>>();
this.mapMethodInvokeNodeToArgIdxMap =
- new HashMap<MethodInvokeNode, Map<Integer, NTuple<Descriptor>>>();
+ new HashMap<MethodInvokeNode, Map<Integer, NodeTupleSet>>();
+ this.mapMethodDescToMethodLocationInfo = new HashMap<MethodDescriptor, MethodLocationInfo>();
+ this.mapMethodToCalleeSet = new HashMap<MethodDescriptor, Set<MethodDescriptor>>();
+ this.mapClassToLocationInfo = new HashMap<ClassDescriptor, LocationInfo>();
+
+ this.mapFileNameToLineVector = new HashMap<String, Vector<String>>();
+ this.mapDescToDefinitionLine = new HashMap<Descriptor, Integer>();
+ this.mapMethodDescToParamNodeFlowsToReturnValue =
+ new HashMap<MethodDescriptor, Set<FlowNode>>();
+
+ this.mapDescriptorToHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
+ this.mapMethodInvokeNodeToBaseTuple = new HashMap<MethodInvokeNode, NTuple<Descriptor>>();
+
+ this.mapDescriptorToSkeletonHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
+ this.mapDescriptorToCombineSkeletonHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
+ this.mapDescriptorToSimpleHierarchyGraph = new HashMap<Descriptor, HierarchyGraph>();
+
+ this.mapDescriptorToSimpleLattice = new HashMap<Descriptor, SSJavaLattice<String>>();
+
+ this.mapDescToLocationSummary = new HashMap<Descriptor, LocationSummary>();
+
+ mapMethodDescriptorToSubGlobalFlowGraph = new HashMap<MethodDescriptor, FlowGraph>();
}
public void setupToAnalyze() {
SymbolTable classtable = state.getClassSymbolTable();
- toanalyzeList.clear();
- toanalyzeList.addAll(classtable.getValueSet());
- Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
- public int compare(ClassDescriptor o1, ClassDescriptor o2) {
- return o1.getClassName().compareToIgnoreCase(o2.getClassName());
- }
- });
+ temp_toanalyzeList.clear();
+ temp_toanalyzeList.addAll(classtable.getValueSet());
+ // Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
+ // 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<MethodDescriptor>() {
+ temp_toanalyzeMethodList.clear();
+ temp_toanalyzeMethodList.addAll(methodtable.getValueSet());
+ Collections.sort(temp_toanalyzeMethodList, new Comparator<MethodDescriptor>() {
public int compare(MethodDescriptor o1, MethodDescriptor o2) {
return o1.getSymbol().compareToIgnoreCase(o2.getSymbol());
}
}
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
constructFlowGraph();
+ constructGlobalFlowGraph();
+
+ System.exit(0);
+
+ constructHierarchyGraph();
+
+ debug_writeHierarchyDotFiles();
+
+ simplifyHierarchyGraph();
+
+ debug_writeSimpleHierarchyDotFiles();
+
+ constructSkeletonHierarchyGraph();
+
+ debug_writeSkeletonHierarchyDotFiles();
+
+ insertCombinationNodes();
+
+ debug_writeSkeletonCombinationHierarchyDotFiles();
+
+ buildLattice();
+
+ debug_writeLattices();
+
+ generateMethodSummary();
+
+ System.exit(0);
+
// 2) construct lattices
inferLattices();
+ simplifyLattices();
+
+ // 3) check properties
+ checkLattices();
+
+ // calculate RETURNLOC,PCLOC
+ calculateExtraLocations();
+
debug_writeLatticeDotFile();
+ // 4) generate annotated source codes
+ generateAnnoatedCode();
+
}
- private void debug_writeLatticeDotFile() {
- // generate lattice dot file
+ private void constructGlobalFlowGraph() {
- setupToAnalyze();
+ System.out.println("");
+ LinkedList<MethodDescriptor> methodDescList =
+ (LinkedList<MethodDescriptor>) toanalyze_methodDescList.clone();
- while (!toAnalyzeIsEmpty()) {
- ClassDescriptor cd = toAnalyzeNext();
+ System.out.println("@@@methodDescList=" + methodDescList);
+ // System.exit(0);
- setupToAnalazeMethod(cd);
+ while (!methodDescList.isEmpty()) {
+ MethodDescriptor md = methodDescList.removeLast();
+ if (state.SSJAVADEBUG) {
+ System.out.println();
+ System.out.println("SSJAVA: Constructing a global flow graph: " + md);
+
+ FlowGraph flowGraph = getFlowGraph(md);
+ FlowGraph subGlobalFlowGraph = flowGraph.clone();
+ mapMethodDescriptorToSubGlobalFlowGraph.put(md, subGlobalFlowGraph);
+
+ addValueFlowsFromCalleeSubGlobalFlowGraph(md, subGlobalFlowGraph);
+
+ try {
+ subGlobalFlowGraph.writeGraph("_SUBGLOBAL");
+ } catch (IOException e) {
+ e.printStackTrace();
+ }
+ // FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
+ // mapMethodDescriptorToFlowGraph.put(md, fg);
+ // analyzeMethodBody(md.getClassDesc(), md);
- SSJavaLattice<String> classLattice = cd2lattice.get(cd);
- if (classLattice != null) {
- ssjava.writeLatticeDotFile(cd, classLattice);
}
+ }
+ // _debug_printGraph();
- while (!toAnalyzeMethodIsEmpty()) {
- MethodDescriptor md = toAnalyzeMethodNext();
- if (ssjava.needTobeAnnotated(md)) {
- SSJavaLattice<String> methodLattice = md2lattice.get(md);
- if (methodLattice != null) {
- ssjava.writeLatticeDotFile(cd, methodLattice);
- }
+ }
+
+ private void addValueFlowsFromCalleeSubGlobalFlowGraph(MethodDescriptor mdCaller,
+ FlowGraph subGlobalFlowGraph) {
+
+ // 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<MethodInvokeNode> setMethodInvokeNode = getMethodInvokeNodeSet(mdCaller);
+
+ for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
+ MethodInvokeNode min = (MethodInvokeNode) iterator.next();
+ MethodDescriptor mdCallee = min.getMethod();
+ Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ if (mdCallee.isStatic()) {
+ setPossibleCallees.add(mdCallee);
+ } else {
+ Set<MethodDescriptor> 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();
+ propagateValueFlowsToCallerFromSubGlobalFlowGraph(min, mdCaller, possibleMdCallee);
+ // propagateFlowsToCallerWithNoCompositeLocation(min, mdCaller, possibleMdCallee);
+ }
+
+ }
+
+ }
+
+ private void propagateValueFlowsToCallerFromSubGlobalFlowGraph(MethodInvokeNode min,
+ MethodDescriptor mdCaller, MethodDescriptor possibleMdCallee) {
+
+ NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
+
+ FlowGraph callerSubGlobalGraph = getSubGlobalFlowGraph(mdCaller);
+ FlowGraph calleeSubGlobalGraph = getSubGlobalFlowGraph(possibleMdCallee);
+
+ int numParam = calleeSubGlobalGraph.getNumParameters();
+ for (int idx = 0; idx < numParam; idx++) {
+ FlowNode paramNode = calleeSubGlobalGraph.getParamFlowNode(idx);
+ NodeTupleSet argTupleSet = mapMethodInvokeNodeToArgIdxMap.get(min).get(idx);
+ System.out.println("argTupleSet=" + argTupleSet + " param=" + paramNode);
+ for (Iterator<NTuple<Descriptor>> iter = argTupleSet.iterator(); iter.hasNext();) {
+ NTuple<Descriptor> argTuple = iter.next();
+ addValueFlowsFromCalleeParam(calleeSubGlobalGraph, paramNode, callerSubGlobalGraph,
+ argTuple, baseTuple);
+ }
+ }
+
+ }
+
+ private void addValueFlowsFromCalleeParam(FlowGraph calleeSubGlobalGraph, FlowNode paramNode,
+ FlowGraph callerSubGlobalGraph, NTuple<Descriptor> argTuple, NTuple<Descriptor> baseTuple) {
+
+ Set<FlowNode> visited = new HashSet<FlowNode>();
+
+ visited.add(paramNode);
+ recurAddValueFlowsFromCalleeParam(calleeSubGlobalGraph, paramNode, callerSubGlobalGraph,
+ argTuple, visited, baseTuple);
+ }
+
+ private void recurAddValueFlowsFromCalleeParam(FlowGraph calleeSubGlobalGraph,
+ FlowNode calleeSrcNode, FlowGraph callerSubGlobalGraph, NTuple<Descriptor> callerSrcTuple,
+ Set<FlowNode> visited, NTuple<Descriptor> baseTuple) {
+
+ MethodDescriptor mdCallee = calleeSubGlobalGraph.getMethodDescriptor();
+
+ Set<FlowEdge> edgeSet = calleeSubGlobalGraph.getOutEdgeSet(calleeSrcNode);
+ for (Iterator iterator = edgeSet.iterator(); iterator.hasNext();) {
+ FlowEdge flowEdge = (FlowEdge) iterator.next();
+ FlowNode dstNode = flowEdge.getDst();
+
+ NTuple<Descriptor> dstDescTuple = dstNode.getCurrentDescTuple();
+ if (dstDescTuple.get(0).equals(mdCallee.getThis())) {
+ // destination node is started with 'this' variable
+ // need to translate it in terms of the caller's base node
+ dstDescTuple = translateToCaller(dstDescTuple, baseTuple);
+ }
+
+ callerSubGlobalGraph.addValueFlowEdge(callerSrcTuple, dstDescTuple);
+
+ if (!visited.contains(dstNode)) {
+ visited.add(dstNode);
+ recurAddValueFlowsFromCalleeParam(calleeSubGlobalGraph, dstNode, callerSubGlobalGraph,
+ dstDescTuple, visited, baseTuple);
+ }
+
+ }
+
+ }
+
+ private NTuple<Descriptor> translateToCaller(NTuple<Descriptor> dstDescTuple,
+ NTuple<Descriptor> baseTuple) {
+ NTuple<Descriptor> callerDescTuple = new NTuple<Descriptor>();
+
+ callerDescTuple.addAll(baseTuple);
+ for (int i = 1; i < dstDescTuple.size(); i++) {
+ callerDescTuple.add(dstDescTuple.get(i));
+ }
+
+ return callerDescTuple;
+ }
+
+ 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);
+ }
+
+ private void generateMethodSummary() {
+
+ Set<MethodDescriptor> 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);
+
+ // 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);
+ NTuple<Descriptor> 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);
+ methodSummary.addMapParamIdxToInferLoc(paramIdx, inferredCompLoc);
}
+
}
}
- private void inferLattices() {
+ 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<Descriptor> keySet = mapDescriptorToSimpleLattice.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Descriptor key = (Descriptor) iterator.next();
+ SSJavaLattice<String> 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<ClassDescriptor> cdKeySet = cd2lattice.keySet();
+ for (Iterator iterator = cdKeySet.iterator(); iterator.hasNext();) {
+ ClassDescriptor cd = (ClassDescriptor) iterator.next();
+ writeInferredLatticeDotFile((ClassDescriptor) cd, getSkeletonCombinationHierarchyGraph(cd),
+ cd2lattice.get(cd), "");
+ }
+
+ Set<MethodDescriptor> 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<Descriptor> keySet = mapDescriptorToCombineSkeletonHierarchyGraph.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Descriptor desc = (Descriptor) iterator.next();
+
+ SSJavaLattice<String> simpleLattice = buildLattice.buildLattice(desc);
+
+ addMapDescToSimpleLattice(desc, simpleLattice);
+
+ HierarchyGraph simpleHierarchyGraph = getSimpleHierarchyGraph(desc);
+ System.out.println("## insertIntermediateNodesToStraightLine:"
+ + simpleHierarchyGraph.getName());
+ SSJavaLattice<String> 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<String> lattice) {
+ mapDescriptorToSimpleLattice.put(desc, lattice);
+ }
+
+ public SSJavaLattice<String> getSimpleLattice(Descriptor desc) {
+ return mapDescriptorToSimpleLattice.get(desc);
+ }
+
+ private void simplifyHierarchyGraph() {
+ Set<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Descriptor desc = (Descriptor) iterator.next();
+ HierarchyGraph simpleHierarchyGraph = getHierarchyGraph(desc).clone();
+ simpleHierarchyGraph.setName(desc + "_SIMPLE");
+ simpleHierarchyGraph.removeRedundantEdges();
+ // simpleHierarchyGraph.simplifyHierarchyGraph();
+ mapDescriptorToSimpleHierarchyGraph.put(desc, simpleHierarchyGraph);
+ }
+ }
+
+ private void insertCombinationNodes() {
+ Set<Descriptor> 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<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Descriptor desc = (Descriptor) iterator.next();
+ 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<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Descriptor desc = (Descriptor) iterator.next();
+ getHierarchyGraph(desc).writeGraph();
+ }
+
+ }
+
+ private void debug_writeSimpleHierarchyDotFiles() {
+
+ Set<Descriptor> 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<Descriptor> keySet = mapDescriptorToHierarchyGraph.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Descriptor desc = (Descriptor) iterator.next();
+ getSkeletonHierarchyGraph(desc).writeGraph();
+ }
+
+ }
+
+ private void debug_writeSkeletonCombinationHierarchyDotFiles() {
+
+ Set<Descriptor> 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
- // perform method READ/OVERWRITE analysis
+ ssjava.init();
LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
+ // Collections.sort(descriptorListToAnalyze, new
+ // Comparator<MethodDescriptor>() {
+ // 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
+ // prioritized by dependency in the call graph
methodDescriptorsToVisitStack.clear();
- descriptorListToAnalyze.removeFirst();
-
Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
methodDescriptorToVistSet.addAll(descriptorListToAnalyze);
while (!methodDescriptorsToVisitStack.isEmpty()) {
// start to analyze leaf node
MethodDescriptor md = methodDescriptorsToVisitStack.pop();
- FlatMethod fm = state.getMethodFlat(md);
- SSJavaLattice<String> methodLattice =
- new SSJavaLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM);
+ HierarchyGraph hierarchyGraph = new HierarchyGraph(md);
+ // MethodSummary methodSummary = new MethodSummary(md);
- System.out.println("SSJAVA: Inferencing the lattice from " + md);
+ // MethodLocationInfo methodInfo = new MethodLocationInfo(md);
+ // curMethodInfo = methodInfo;
+
+ System.out.println();
+ System.out.println("SSJAVA: Construcing the hierarchy graph from " + md);
- analyzeMethodLattice(md, methodLattice);
+ constructHierarchyGraph(md, hierarchyGraph);
- SSJavaLattice<String> prevMethodLattice = md2lattice.get(md);
+ HierarchyGraph prevHierarchyGraph = getHierarchyGraph(md);
+ // MethodSummary prevMethodSummary = getMethodSummary(md);
- if (!methodLattice.equals(prevMethodLattice)) {
- md2lattice.put(md, methodLattice);
+ if (!hierarchyGraph.equals(prevHierarchyGraph)) {
+
+ mapDescriptorToHierarchyGraph.put(md, hierarchyGraph);
+ // mapDescToLocationSummary.put(md, methodSummary);
// results for callee changed, so enqueue dependents caller for
// further analysis
}
- private String getSymbol(int idx, FlowNode node) {
- Descriptor desc = node.getDescTuple().get(idx);
- return desc.getSymbol();
- }
-
- private void addMappingDescriptorToLocationIdentifer(MethodDescriptor methodDesc,
- VarDescriptor varDesc, String identifier) {
- if (!md2LatticeMapping.containsKey(methodDesc)) {
- md2LatticeMapping.put(methodDesc, new HashMap<VarDescriptor, String>());
+ private HierarchyGraph getHierarchyGraph(Descriptor d) {
+ if (!mapDescriptorToHierarchyGraph.containsKey(d)) {
+ mapDescriptorToHierarchyGraph.put(d, new HierarchyGraph(d));
}
-
+ return mapDescriptorToHierarchyGraph.get(d);
}
- private void analyzeMethodLattice(MethodDescriptor md, SSJavaLattice<String> methodLattice) {
+ private void constructHierarchyGraph(MethodDescriptor md, HierarchyGraph methodGraph) {
// visit each node of method flow graph
-
FlowGraph fg = getFlowGraph(md);
Set<FlowNode> nodeSet = fg.getNodeSet();
+ Set<Descriptor> 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<Descriptor>
-
for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
FlowNode srcNode = (FlowNode) iterator.next();
- // first, take a look at directly connected nodes
- Set<FlowEdge> outEdgeSet = srcNode.getOutEdgeSet();
+ Set<FlowEdge> outEdgeSet = fg.getOutEdgeSet(srcNode);
for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) {
FlowEdge outEdge = (FlowEdge) iterator2.next();
FlowNode dstNode = outEdge.getDst();
- addRelationToLattice(md, methodLattice, srcNode, dstNode);
+ NTuple<Descriptor> srcNodeTuple = srcNode.getDescTuple();
+ NTuple<Descriptor> dstNodeTuple = dstNode.getDescTuple();
- // second, take a look at all nodes that are reachable from the source
- // node
- recursiveVisitNodes(md, srcNode, dstNode);
+ if (outEdge.getInitTuple().equals(srcNodeTuple)
+ && outEdge.getEndTuple().equals(dstNodeTuple)) {
- }
+ NTuple<Descriptor> srcCurTuple = srcNode.getCurrentDescTuple();
+ NTuple<Descriptor> 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;
- private void addRelationToLattice(MethodDescriptor md, SSJavaLattice<String> methodLattice,
- FlowNode srcNode, FlowNode dstNode) {
- if ((srcNode.getDescTuple().size() > 1 && dstNode.getDescTuple().size() > 1)
- && srcNode.getDescTuple().get(0).equals(dstNode.getDescTuple().get(0))) {
- // value flow between fields: we don't need to add a binary relation
- // for this case
+ if (desc.equals(GLOBALDESC)) {
+ classDesc = md.getClassDesc();
+ } else {
+ VarDescriptor varDesc = (VarDescriptor) srcCurTuple.get(0);
+ classDesc = varDesc.getType().getClassDesc();
+ }
+ extractFlowsBetweenFields(classDesc, srcNode, dstNode, 1);
- VarDescriptor varDesc = (VarDescriptor) srcNode.getDescTuple().get(0);
- ClassDescriptor varClassDesc = varDesc.getType().getClassDesc();
+ } else {
+ // value flow between local var - local var or local var - field
- extractRelationFromFieldFlows(varClassDesc, srcNode, dstNode, 1);
- return;
- }
+ Descriptor srcDesc = srcCurTuple.get(0);
+ Descriptor dstDesc = dstCurTuple.get(0);
- // add a new binary relation of dstNode < srcNode
+ methodGraph.addEdge(srcDesc, dstDesc);
- String srcSymbol = getSymbol(0, srcNode);
- String dstSymbol = getSymbol(0, dstNode);
+ if (fg.isParamDesc(srcDesc)) {
+ methodGraph.setParamHNode(srcDesc);
+ }
+ if (fg.isParamDesc(dstDesc)) {
+ methodGraph.setParamHNode(dstDesc);
+ }
- methodLattice.addRelationHigherToLower(srcSymbol, dstSymbol);
+ }
- if (srcNode.isParameter() && dstNode.isParameter()) {
- propagateRelationToCaller(md, srcNode, dstNode);
+ }
+ }
}
- }
- private SSJavaLattice<String> getMethodLattice(MethodDescriptor md) {
+ }
- if (!md2lattice.containsKey(md)) {
- md2lattice.put(md, new SSJavaLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM));
+ private MethodSummary getMethodSummary(MethodDescriptor md) {
+ if (!mapDescToLocationSummary.containsKey(md)) {
+ mapDescToLocationSummary.put(md, new MethodSummary(md));
}
- return md2lattice.get(md);
+ return (MethodSummary) mapDescToLocationSummary.get(md);
}
- private void propagateRelationToCaller(MethodDescriptor calleeMethodDesc, FlowNode srcNode,
- FlowNode newVisitNode) {
+ 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);
+ }
+ }
- FlowGraph calleeFlowGraph = getFlowGraph(calleeMethodDesc);
+ private void addMapMethodDefinitionToLineNum(Set<MethodDescriptor> methodSet, String strLine,
+ int lineNum) {
+ for (Iterator iterator = methodSet.iterator(); iterator.hasNext();) {
+ MethodDescriptor md = (MethodDescriptor) iterator.next();
+ String pattern = md.getMethodDeclaration();
+ if (strLine.indexOf(pattern) != -1) {
+ mapDescToDefinitionLine.put(md, lineNum);
+ methodSet.remove(md);
+ return;
+ }
+ }
- int higherLocIdxCallee = calleeFlowGraph.getParamIdx(srcNode.getDescTuple());
- int lowerLocIdxCallee = calleeFlowGraph.getParamIdx(newVisitNode.getDescTuple());
+ }
- System.out.println(" ssjava.getDependents(md)=" + ssjava.getDependents(calleeMethodDesc));
- Iterator<MethodDescriptor> depsItr = ssjava.getDependents(calleeMethodDesc).iterator();
- while (depsItr.hasNext()) {
- MethodDescriptor callerMethodDesc = depsItr.next();
+ private void readOriginalSourceFiles() {
- SSJavaLattice<String> callerMethodLattice = md2lattice.get(callerMethodDesc);
+ SymbolTable classtable = state.getClassSymbolTable();
- Set<MethodInvokeNode> minSet = mapMethodDescriptorToMethodInvokeNodeSet.get(callerMethodDesc);
- for (Iterator iterator = minSet.iterator(); iterator.hasNext();) {
- MethodInvokeNode methodInvokeNode = (MethodInvokeNode) iterator.next();
- if (methodInvokeNode.getMethod().equals(calleeMethodDesc)) {
- // need to propagate a relation from the callee to the caller
- // TODO
+ Set<ClassDescriptor> classDescSet = new HashSet<ClassDescriptor>();
+ classDescSet.addAll(classtable.getValueSet());
- System.out.println("higherLocIdxCallee=" + higherLocIdxCallee);
- System.out.println("lowerLocIdxCallee=" + lowerLocIdxCallee);
+ 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();
- NTuple<Descriptor> higherArg = getArgTupleByArgIdx(methodInvokeNode, higherLocIdxCallee);
- NTuple<Descriptor> lowerArg = getArgTupleByArgIdx(methodInvokeNode, lowerLocIdxCallee);
+ Set<MethodDescriptor> methodSet = new HashSet<MethodDescriptor>();
+ methodSet.addAll(cd.getMethodTable().getValueSet());
- FlowNode callerHigherFlowNode = getFlowGraph(callerMethodDesc).getFlowNode(higherArg);
- FlowNode calleeHigherFlowNode = getFlowGraph(callerMethodDesc).getFlowNode(lowerArg);
+ String sourceFileName = cd.getSourceFileName();
+ Vector<String> lineVec = new Vector<String>();
- addRelationToLattice(callerMethodDesc, getMethodLattice(callerMethodDesc),
- callerHigherFlowNode, calleeHigherFlowNode);
+ 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 void recursiveVisitNodes(MethodDescriptor md, FlowNode srcNode, FlowNode currentVisitNode) {
+ private String generateLatticeDefinition(Descriptor desc) {
+
+ Set<String> sharedLocSet = new HashSet<String>();
+
+ SSJavaLattice<String> lattice = getLattice(desc);
+ String rtr = "@LATTICE(\"";
+
+ Map<String, Set<String>> map = lattice.getTable();
+ Set<String> keySet = map.keySet();
+ boolean first = true;
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ String key = (String) iterator.next();
+ if (!key.equals(lattice.getTopItem())) {
+ Set<String> connectedSet = map.get(key);
+
+ if (connectedSet.size() == 1) {
+ if (connectedSet.iterator().next().equals(lattice.getBottomItem())) {
+ if (!first) {
+ rtr += ",";
+ } else {
+ rtr += "LOC,";
+ first = false;
+ }
+ rtr += key;
+ if (lattice.isSharedLoc(key)) {
+ rtr += "," + key + "*";
+ }
+ }
+ }
+
+ for (Iterator iterator2 = connectedSet.iterator(); iterator2.hasNext();) {
+ String loc = (String) iterator2.next();
+ if (!loc.equals(lattice.getBottomItem())) {
+ if (!first) {
+ rtr += ",";
+ } else {
+ rtr += "LOC,";
+ first = false;
+ }
+ rtr += loc + "<" + key;
+ if (lattice.isSharedLoc(key) && (!sharedLocSet.contains(key))) {
+ rtr += "," + key + "*";
+ sharedLocSet.add(key);
+ }
+ if (lattice.isSharedLoc(loc) && (!sharedLocSet.contains(loc))) {
+ rtr += "," + loc + "*";
+ sharedLocSet.add(loc);
+ }
+
+ }
+ }
+ }
+ }
+
+ rtr += "\")";
+
+ if (desc instanceof MethodDescriptor) {
+ TypeDescriptor returnType = ((MethodDescriptor) desc).getReturnType();
+
+ MethodLocationInfo methodLocInfo = getMethodLocationInfo((MethodDescriptor) desc);
+
+ if (returnType != null && (!returnType.isVoid())) {
+ rtr +=
+ "\n@RETURNLOC(\"" + generateLocationAnnoatation(methodLocInfo.getReturnLoc()) + "\")";
+ }
+
+ rtr += "\n@THISLOC(\"this\")";
+ rtr += "\n@GLOBALLOC(\"GLOBALLOC\")";
+
+ CompositeLocation pcLoc = methodLocInfo.getPCLoc();
+ if ((pcLoc != null) && (!pcLoc.get(0).isTop())) {
+ rtr += "\n@PCLOC(\"" + generateLocationAnnoatation(pcLoc) + "\")";
+ }
+
+ }
+
+ return rtr;
+ }
+
+ private void generateAnnoatedCode() {
+
+ readOriginalSourceFiles();
+
+ setupToAnalyze();
+ while (!toAnalyzeIsEmpty()) {
+ ClassDescriptor cd = toAnalyzeNext();
+
+ setupToAnalazeMethod(cd);
+
+ LocationInfo locInfo = mapClassToLocationInfo.get(cd);
+ String sourceFileName = cd.getSourceFileName();
+
+ if (cd.isInterface()) {
+ continue;
+ }
+
+ int classDefLine = mapDescToDefinitionLine.get(cd);
+ Vector<String> sourceVec = mapFileNameToLineVector.get(sourceFileName);
+
+ if (locInfo == null) {
+ locInfo = getLocationInfo(cd);
+ }
+
+ for (Iterator iter = cd.getFields(); iter.hasNext();) {
+ FieldDescriptor fieldDesc = (FieldDescriptor) iter.next();
+ if (!(fieldDesc.isStatic() && fieldDesc.isFinal())) {
+ String locIdentifier = locInfo.getFieldInferLocation(fieldDesc).getLocIdentifier();
+ if (!getLattice(cd).getElementSet().contains(locIdentifier)) {
+ getLattice(cd).put(locIdentifier);
+ }
+ }
+ }
+
+ String fieldLatticeDefStr = generateLatticeDefinition(cd);
+ String annoatedSrc = fieldLatticeDefStr + newline + sourceVec.get(classDefLine);
+ sourceVec.set(classDefLine, annoatedSrc);
+
+ // generate annotations for field declarations
+ LocationInfo fieldLocInfo = getLocationInfo(cd);
+ Map<Descriptor, CompositeLocation> inferLocMap = fieldLocInfo.getMapDescToInferLocation();
+
+ for (Iterator iter = cd.getFields(); iter.hasNext();) {
+ FieldDescriptor fd = (FieldDescriptor) iter.next();
+
+ String locAnnotationStr;
+ CompositeLocation inferLoc = inferLocMap.get(fd);
+
+ if (inferLoc != null) {
+ // infer loc is null if the corresponding field is static and final
+ locAnnotationStr = "@LOC(\"" + generateLocationAnnoatation(inferLoc) + "\")";
+ 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<String> methodLattice = md2lattice.get(md);
+ if (methodLattice != null) {
+
+ int methodDefLine = md.getLineNum();
+
+ MethodLocationInfo methodLocInfo = getMethodLocationInfo(md);
+
+ Map<Descriptor, CompositeLocation> methodInferLocMap =
+ methodLocInfo.getMapDescToInferLocation();
+ Set<Descriptor> localVarDescSet = methodInferLocMap.keySet();
+
+ Set<String> localLocElementSet = methodLattice.getElementSet();
+
+ for (Iterator iterator = localVarDescSet.iterator(); iterator.hasNext();) {
+ Descriptor localVarDesc = (Descriptor) iterator.next();
+ CompositeLocation inferLoc = methodInferLocMap.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));
+
+ 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<FlowNode> 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) {
+ String rtr = "";
+ // method location
+ Location methodLoc = loc.get(0);
+ rtr += methodLoc.getLocIdentifier();
+
+ for (int i = 1; i < loc.getSize(); i++) {
+ Location element = loc.get(i);
+ rtr += "," + element.getDescriptor().getSymbol() + "." + element.getLocIdentifier();
+ }
+
+ return rtr;
+ }
+
+ private boolean isParameter(MethodDescriptor md, Descriptor localVarDesc) {
+ return getFlowGraph(md).isParamDesc(localVarDesc);
+ }
+
+ private String extractFileName(String fileName) {
+ int idx = fileName.lastIndexOf("/");
+ if (idx == -1) {
+ return fileName;
+ } else {
+ return fileName.substring(idx + 1);
+ }
+
+ }
+
+ private void codeGen() {
+
+ Set<String> originalFileNameSet = mapFileNameToLineVector.keySet();
+ for (Iterator iterator = originalFileNameSet.iterator(); iterator.hasNext();) {
+ String orgFileName = (String) iterator.next();
+ String outputFileName = extractFileName(orgFileName);
+
+ Vector<String> sourceVec = mapFileNameToLineVector.get(orgFileName);
+
+ try {
+
+ FileWriter fileWriter = new FileWriter("./infer/" + outputFileName);
+ BufferedWriter out = new BufferedWriter(fileWriter);
+
+ for (int i = 0; i < sourceVec.size(); i++) {
+ out.write(sourceVec.get(i));
+ out.newLine();
+ }
+ out.close();
+ } catch (IOException e) {
+ e.printStackTrace();
+ }
+
+ }
+
+ }
+
+ private void simplifyLattices() {
+
+ setupToAnalyze();
+
+ while (!toAnalyzeIsEmpty()) {
+ ClassDescriptor cd = toAnalyzeNext();
+ setupToAnalazeMethod(cd);
+
+ SSJavaLattice<String> classLattice = cd2lattice.get(cd);
+ if (classLattice != null) {
+ System.out.println("@@@check lattice=" + cd);
+ checkLatticeProperty(cd, classLattice);
+ }
+
+ while (!toAnalyzeMethodIsEmpty()) {
+ MethodDescriptor md = toAnalyzeMethodNext();
+ SSJavaLattice<String> methodLattice = md2lattice.get(md);
+ if (methodLattice != null) {
+ System.out.println("@@@check lattice=" + md);
+ checkLatticeProperty(md, methodLattice);
+ }
+ }
+ }
+
+ setupToAnalyze();
+
+ while (!toAnalyzeIsEmpty()) {
+ ClassDescriptor cd = toAnalyzeNext();
+
+ setupToAnalazeMethod(cd);
+
+ SSJavaLattice<String> classLattice = cd2lattice.get(cd);
+ if (classLattice != null) {
+ classLattice.removeRedundantEdges();
+ }
+
+ while (!toAnalyzeMethodIsEmpty()) {
+ MethodDescriptor md = toAnalyzeMethodNext();
+ SSJavaLattice<String> methodLattice = md2lattice.get(md);
+ if (methodLattice != null) {
+ methodLattice.removeRedundantEdges();
+ }
+ }
+ }
+
+ }
+
+ private boolean checkLatticeProperty(Descriptor d, SSJavaLattice<String> lattice) {
+ // if two elements has the same incoming node set,
+ // we need to merge two elements ...
+
+ boolean isUpdated;
+ boolean isModified = false;
+ do {
+ isUpdated = removeNodeSharingSameIncomingNodes(d, lattice);
+ if (!isModified && isUpdated) {
+ isModified = true;
+ }
+ } while (isUpdated);
+
+ return isModified;
+ }
+
+ private boolean removeNodeSharingSameIncomingNodes(Descriptor d, SSJavaLattice<String> lattice) {
+ LocationInfo locInfo = getLocationInfo(d);
+ Map<String, Set<String>> map = lattice.getIncomingElementMap();
+ Set<String> keySet = map.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ String key = (String) iterator.next();
+ Set<String> incomingSetKey = map.get(key);
+
+ // System.out.println("key=" + key + " incomingSetKey=" +
+ // incomingSetKey);
+ if (incomingSetKey.size() > 0) {
+ for (Iterator iterator2 = keySet.iterator(); iterator2.hasNext();) {
+ String cur = (String) iterator2.next();
+ if (!cur.equals(key)) {
+ Set<String> incomingSetCur = map.get(cur);
+ if (incomingSetCur.equals(incomingSetKey)) {
+ if (!(incomingSetCur.size() == 1 && incomingSetCur.contains(lattice.getTopItem()))) {
+ // NEED TO MERGE HERE!!!!
+ System.out.println("@@@Try merge=" + cur + " " + key);
+
+ Set<String> mergeSet = new HashSet<String>();
+ mergeSet.add(cur);
+ mergeSet.add(key);
+
+ String newMergeLoc = "MLoc" + (SSJavaLattice.seed++);
+
+ System.out.println("---ASSIGN NEW MERGE LOC=" + newMergeLoc + " to " + mergeSet);
+ lattice.mergeIntoNewLocation(mergeSet, newMergeLoc);
+
+ for (Iterator miterator = mergeSet.iterator(); miterator.hasNext();) {
+ String oldLocSymbol = (String) miterator.next();
+
+ Set<Pair<Descriptor, Descriptor>> inferLocSet =
+ locInfo.getRelatedInferLocSet(oldLocSymbol);
+ System.out.println("---update related locations=" + inferLocSet
+ + " oldLocSymbol=" + oldLocSymbol);
+
+ for (Iterator miterator2 = inferLocSet.iterator(); miterator2.hasNext();) {
+ Pair<Descriptor, Descriptor> pair =
+ (Pair<Descriptor, Descriptor>) miterator2.next();
+ Descriptor enclosingDesc = pair.getFirst();
+ Descriptor desc = pair.getSecond();
+
+ System.out.println("---inferLoc pair=" + pair);
+
+ CompositeLocation inferLoc =
+ getLocationInfo(enclosingDesc).getInferLocation(desc);
+ System.out.println("oldLoc=" + inferLoc);
+ // if (curMethodInfo.md.equals(enclosingDesc)) {
+ // inferLoc = curMethodInfo.getInferLocation(desc);
+ // } else {
+ // inferLoc =
+ // getLocationInfo(enclosingDesc).getInferLocation(desc);
+ // }
+
+ Location locElement = inferLoc.get(inferLoc.getSize() - 1);
+
+ locElement.setLocIdentifier(newMergeLoc);
+ locInfo.addMapLocSymbolToRelatedInferLoc(newMergeLoc, enclosingDesc, desc);
+
+ // if (curMethodInfo.md.equals(enclosingDesc)) {
+ // inferLoc = curMethodInfo.getInferLocation(desc);
+ // } else {
+ // inferLoc =
+ // getLocationInfo(enclosingDesc).getInferLocation(desc);
+ // }
+
+ inferLoc = getLocationInfo(enclosingDesc).getInferLocation(desc);
+ System.out.println("---New Infer Loc=" + inferLoc);
+
+ }
+
+ locInfo.removeRelatedInferLocSet(oldLocSymbol, newMergeLoc);
+
+ }
+
+ for (Iterator iterator3 = mergeSet.iterator(); iterator3.hasNext();) {
+ String oldLoc = (String) iterator3.next();
+ lattice.remove(oldLoc);
+ }
+ return true;
+ }
+ }
+ }
+ }
+ }
+
+ }
+ return false;
+ }
+
+ private void checkLattices() {
+
+ LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
+
+ // current descriptors to visit in fixed-point interprocedural analysis,
+ // prioritized by
+ // dependency in the call graph
+ methodDescriptorsToVisitStack.clear();
+
+ // descriptorListToAnalyze.removeFirst();
+
+ Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
+ 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<String> classLattice = cd2lattice.get(cd);
+ if (classLattice != null) {
+ ssjava.writeLatticeDotFile(cd, null, classLattice);
+ debug_printDescriptorToLocNameMapping(cd);
+ }
+
+ while (!toAnalyzeMethodIsEmpty()) {
+ MethodDescriptor md = toAnalyzeMethodNext();
+ SSJavaLattice<String> 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 inferLattices() {
+
+ // do fixed-point analysis
+
+ ssjava.init();
+ LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
+
+ // Collections.sort(descriptorListToAnalyze, new
+ // Comparator<MethodDescriptor>() {
+ // 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();
+
+ // descriptorListToAnalyze.removeFirst();
+
+ Set<MethodDescriptor> methodDescriptorToVistSet = new HashSet<MethodDescriptor>();
+ 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();
+
+ SSJavaLattice<String> methodLattice =
+ new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
+
+ MethodLocationInfo methodInfo = new MethodLocationInfo(md);
+ curMethodInfo = methodInfo;
+
+ System.out.println();
+ System.out.println("SSJAVA: Inferencing the lattice from " + md);
+
+ try {
+ analyzeMethodLattice(md, methodLattice, methodInfo);
+ } catch (CyclicFlowException e) {
+ throw new Error("Fail to generate the method lattice for " + md);
+ }
+
+ SSJavaLattice<String> prevMethodLattice = getMethodLattice(md);
+ MethodLocationInfo prevMethodInfo = getMethodLocationInfo(md);
+
+ if ((!methodLattice.equals(prevMethodLattice)) || (!methodInfo.equals(prevMethodInfo))) {
+
+ setMethodLattice(md, methodLattice);
+ setMethodLocInfo(md, methodInfo);
+
+ // results for callee changed, so enqueue dependents caller for
+ // further analysis
+ Iterator<MethodDescriptor> depsItr = ssjava.getDependents(md).iterator();
+ while (depsItr.hasNext()) {
+ MethodDescriptor methodNext = depsItr.next();
+ if (!methodDescriptorsToVisitStack.contains(methodNext)
+ && methodDescriptorToVistSet.contains(methodNext)) {
+ methodDescriptorsToVisitStack.add(methodNext);
+ }
+ }
+
+ }
+
+ }
+
+ }
+
+ private void calculateExtraLocations() {
+ LinkedList<MethodDescriptor> descriptorListToAnalyze = ssjava.getSortedDescriptors();
+ for (Iterator iterator = descriptorListToAnalyze.iterator(); iterator.hasNext();) {
+ MethodDescriptor md = (MethodDescriptor) iterator.next();
+ calculateExtraLocations(md);
+ }
+ }
+
+ private void setMethodLocInfo(MethodDescriptor md, MethodLocationInfo methodInfo) {
+ mapMethodDescToMethodLocationInfo.put(md, methodInfo);
+ }
+
+ private void checkLatticesOfVirtualMethods(MethodDescriptor md) {
+
+ if (!md.isStatic()) {
+ Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ 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<CompositeLocation> list1 = new ArrayList<CompositeLocation>();
+ List<CompositeLocation> list2 = new ArrayList<CompositeLocation>();
+
+ MethodLocationInfo locInfo1 = getMethodLocationInfo(md1);
+ MethodLocationInfo locInfo2 = getMethodLocationInfo(md2);
+
+ Map<Integer, CompositeLocation> paramMap1 = locInfo1.getMapParamIdxToInferLoc();
+ Map<Integer, CompositeLocation> 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 analyzeMethodLattice(MethodDescriptor md, SSJavaLattice<String> methodLattice,
+ MethodLocationInfo methodInfo) throws CyclicFlowException {
+
+ // first take a look at method invocation nodes to newly added relations
+ // from the callee
+ analyzeLatticeMethodInvocationNode(md, methodLattice, methodInfo);
+
+ if (!md.isStatic()) {
+ // set the this location
+ String thisLocSymbol = md.getThis().getSymbol();
+ methodInfo.setThisLocName(thisLocSymbol);
+ }
+
+ // set the global location
+ methodInfo.setGlobalLocName(LocationInference.GLOBALLOC);
+ methodInfo.mapDescriptorToLocation(GLOBALDESC, new CompositeLocation(
+ new Location(md, GLOBALLOC)));
+
+ // visit each node of method flow graph
+ FlowGraph fg = getFlowGraph(md);
+ Set<FlowNode> nodeSet = fg.getNodeSet();
+
+ // for the method lattice, we need to look at the first element of
+ // NTuple<Descriptor>
+ for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
+ FlowNode srcNode = (FlowNode) iterator.next();
+
+ Set<FlowEdge> outEdgeSet = fg.getOutEdgeSet(srcNode);
+ for (Iterator iterator2 = outEdgeSet.iterator(); iterator2.hasNext();) {
+ FlowEdge outEdge = (FlowEdge) iterator2.next();
+ FlowNode dstNode = outEdge.getDst();
+
+ NTuple<Descriptor> srcNodeTuple = srcNode.getDescTuple();
+ NTuple<Descriptor> dstNodeTuple = dstNode.getDescTuple();
+
+ if (outEdge.getInitTuple().equals(srcNodeTuple)
+ && outEdge.getEndTuple().equals(dstNodeTuple)) {
+
+ if ((srcNodeTuple.size() > 1 && dstNodeTuple.size() > 1)
+ && srcNodeTuple.get(0).equals(dstNodeTuple.get(0))) {
+
+ // value flows between fields
+ Descriptor desc = srcNodeTuple.get(0);
+ ClassDescriptor classDesc;
+
+ if (desc.equals(GLOBALDESC)) {
+ classDesc = md.getClassDesc();
+ } else {
+ VarDescriptor varDesc = (VarDescriptor) srcNodeTuple.get(0);
+ classDesc = varDesc.getType().getClassDesc();
+ }
+ extractRelationFromFieldFlows(classDesc, srcNode, dstNode, 1);
+
+ } else {
+ // value flow between local var - local var or local var - field
+ addRelationToLattice(md, methodLattice, methodInfo, srcNode, dstNode);
+ }
+ }
+ }
+ }
+
+ // 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;
+ }
+
+ for (int idx = 0; idx < md.numParameters(); idx++) {
+ Descriptor paramDesc = md.getParameter(idx);
+ CompositeLocation inferParamLoc = methodInfo.getInferLocation(paramDesc);
+ methodInfo.addMapParamIdxToInferLoc(idx + offset, inferParamLoc);
+ }
+
+ }
+
+ private void calculateExtraLocations(MethodDescriptor md) {
+ // calcualte pcloc, returnloc,...
+
+ SSJavaLattice<String> methodLattice = getMethodLattice(md);
+ MethodLocationInfo methodInfo = getMethodLocationInfo(md);
+ FlowGraph fg = getFlowGraph(md);
+ Set<FlowNode> 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<Integer, CompositeLocation> mapParamToLoc = methodInfo.getMapParamIdxToInferLoc();
+ Set<Integer> paramIdxSet = mapParamToLoc.keySet();
+
+ try {
+ 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<CompositeLocation> paramInFlowSet = new HashSet<CompositeLocation>();
+
+ 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<CompositeLocation> inferFieldReturnLocSet = new HashSet<CompositeLocation>();
+
+ Set<FlowNode> paramFlowNode = getParamNodeFlowingToReturnValue(md);
+ Set<CompositeLocation> inferParamLocSet = new HashSet<CompositeLocation>();
+ if (paramFlowNode != null) {
+ for (Iterator iterator = paramFlowNode.iterator(); iterator.hasNext();) {
+ FlowNode fn = (FlowNode) iterator.next();
+ CompositeLocation inferLoc =
+ generateInferredCompositeLocation(methodInfo, getFlowGraph(md).getLocationTuple(fn));
+ inferParamLocSet.add(inferLoc);
+ }
+ }
+
+ Set<FlowNode> returnNodeSet = fg.getReturnNodeSet();
+
+ skip: for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode returnNode = (FlowNode) iterator.next();
+ CompositeLocation inferReturnLoc =
+ generateInferredCompositeLocation(methodInfo, fg.getLocationTuple(returnNode));
+ 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);
+
+ }
+ }
+
+ if (inferFieldReturnLocSet.size() > 0) {
+
+ 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()));
+ }
+ 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)) {
+ addRelationHigherToLower(methodLattice, methodInfo, paramLocLocalSymbol,
+ returnLocSymbol);
+ }
+ }
+
+ for (Iterator iterator = returnNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode returnNode = (FlowNode) iterator.next();
+ CompositeLocation inferLoc =
+ generateInferredCompositeLocation(methodInfo, fg.getLocationTuple(returnNode));
+ if (!isGreaterThan(methodLattice, inferLoc, returnLocInferLoc)) {
+ addRelation(methodLattice, methodInfo, inferLoc, returnLocInferLoc);
+ }
+ }
+
+ }
+
+ }
+ } catch (CyclicFlowException e) {
+ e.printStackTrace();
+ }
+
+ }
+
+ private Set<String> getHigherLocSymbolThan(SSJavaLattice<String> lattice, String loc) {
+ Set<String> higherLocSet = new HashSet<String>();
+
+ Set<String> locSet = lattice.getTable().keySet();
+ for (Iterator iterator = locSet.iterator(); iterator.hasNext();) {
+ String element = (String) iterator.next();
+ if (lattice.isGreaterThan(element, loc) && (!element.equals(lattice.getTopItem()))) {
+ higherLocSet.add(element);
+ }
+ }
+ return higherLocSet;
+ }
+
+ private CompositeLocation getLowest(SSJavaLattice<String> methodLattice,
+ Set<CompositeLocation> set) {
+
+ CompositeLocation lowest = set.iterator().next();
+
+ if (set.size() == 1) {
+ return lowest;
+ }
+
+ for (Iterator iterator = set.iterator(); iterator.hasNext();) {
+ CompositeLocation loc = (CompositeLocation) iterator.next();
+
+ if ((!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<String> 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<String> 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<String> 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<String> 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 recursiveAddRelationToLattice(int idx, MethodDescriptor md,
+ CompositeLocation srcInferLoc, CompositeLocation dstInferLoc) throws CyclicFlowException {
+
+ 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);
+ }
+
+ }
+
+ // private void propagateFlowsFromCallee(MethodInvokeNode min, MethodDescriptor mdCaller,
+ // MethodDescriptor mdCallee) {
+ //
+ // // 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
+ //
+ // Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ // if (mdCallee.isStatic()) {
+ // setPossibleCallees.add(mdCallee);
+ // } else {
+ // Set<MethodDescriptor> 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);
+ // }
+ //
+ // }
+
+ private void contributeCalleeFlows(MethodInvokeNode min, MethodDescriptor mdCaller,
+ MethodDescriptor mdCallee) {
+
+ System.out.println("\n##contributeCalleeFlows callee=" + mdCallee + "TO caller=" + mdCaller);
+
+ getSubGlobalFlowGraph(mdCallee);
+
+ }
+
+ private FlowGraph getSubGlobalFlowGraph(MethodDescriptor md) {
+ return mapMethodDescriptorToSubGlobalFlowGraph.get(md);
+ }
+
+ private void propagateFlowsToCallerWithNoCompositeLocation(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
+
+ 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);
+
+ NodeTupleSet tupleSetArg1 = getNodeTupleSetByArgIdx(min, i);
+ NodeTupleSet tupleSetArg2 = getNodeTupleSetByArgIdx(min, k);
+
+ for (Iterator<NTuple<Descriptor>> iter1 = tupleSetArg1.iterator(); iter1.hasNext();) {
+ NTuple<Descriptor> arg1Tuple = iter1.next();
+
+ for (Iterator<NTuple<Descriptor>> iter2 = tupleSetArg2.iterator(); iter2.hasNext();) {
+ NTuple<Descriptor> arg2Tuple = iter2.next();
+
+ // check if the callee propagates an ordering constraints through
+ // parameters
+
+ Set<FlowNode> 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);
+
+ // 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());
+
+ NodeTupleSet tupleSetArg1 = getNodeTupleSetByArgIdx(min, i);
+ NodeTupleSet tupleSetArg2 = getNodeTupleSetByArgIdx(min, k);
+
+ for (Iterator<NTuple<Descriptor>> iter1 = tupleSetArg1.iterator(); iter1.hasNext();) {
+ NTuple<Descriptor> arg1Tuple = iter1.next();
+
+ for (Iterator<NTuple<Descriptor>> iter2 = tupleSetArg2.iterator(); iter2.hasNext();) {
+ NTuple<Descriptor> arg2Tuple = iter2.next();
+
+ // check if the callee propagates an ordering constraints through
+ // parameters
+
+ Set<FlowNode> 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<Descriptor> 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<Descriptor> 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<Descriptor> 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<Descriptor> 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<Descriptor> 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);
+
+ }
+
+ }
+
+ }
+ System.out.println();
+ }
+ }
+ }
+ System.out.println("##\n");
+ }
+
+ private NTuple<Descriptor> translateCompositeLocationToCaller(MethodInvokeNode min,
+ CompositeLocation compLocForParam1) {
+ NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
+
+ NTuple<Descriptor> tuple = new NTuple<Descriptor>();
+
+ 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(MethodDescriptor md,
+ NTuple<Descriptor> 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<Descriptor> calculatePrefixForParam(FlowGraph callerFlowGraph,
+ FlowGraph calleeFlowGraph, MethodInvokeNode min, NTuple<Descriptor> arg1Tuple,
+ FlowNode paramNode1) {
+
+ NTuple<Descriptor> baseTuple = mapMethodInvokeNodeToBaseTuple.get(min);
+ Descriptor baseRef = baseTuple.get(baseTuple.size() - 1);
+ System.out.println("baseRef=" + baseRef);
+
+ FlowNode flowNodeArg1 = callerFlowGraph.getFlowNode(arg1Tuple);
+ List<NTuple<Descriptor>> callerPrefixList = calculatePrefixList(callerFlowGraph, flowNodeArg1);
+ System.out.println("callerPrefixList=" + callerPrefixList);
+
+ List<NTuple<Descriptor>> prefixList = calculatePrefixList(calleeFlowGraph, paramNode1);
+ System.out.println("###prefixList from node=" + paramNode1 + " =" + prefixList);
+
+ List<NTuple<Descriptor>> calleePrefixList =
+ translatePrefixListToCallee(baseRef, min.getMethod(), callerPrefixList);
+
+ System.out.println("calleePrefixList=" + calleePrefixList);
+
+ Set<FlowNode> reachNodeSetFromParam1 = calleeFlowGraph.getReachFlowNodeSetFrom(paramNode1);
+ System.out.println("reachNodeSetFromParam1=" + reachNodeSetFromParam1);
+
+ for (int i = 0; i < calleePrefixList.size(); i++) {
+ NTuple<Descriptor> curPrefix = calleePrefixList.get(i);
+ Set<NTuple<Descriptor>> reachableCommonPrefixSet = new HashSet<NTuple<Descriptor>>();
+
+ 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<NTuple<Descriptor>> translatePrefixListToCallee(Descriptor baseRef,
+ MethodDescriptor mdCallee, List<NTuple<Descriptor>> callerPrefixList) {
+
+ List<NTuple<Descriptor>> calleePrefixList = new ArrayList<NTuple<Descriptor>>();
+
+ for (int i = 0; i < callerPrefixList.size(); i++) {
+ NTuple<Descriptor> prefix = callerPrefixList.get(i);
+ if (prefix.startsWith(baseRef)) {
+ NTuple<Descriptor> calleePrefix = new NTuple<Descriptor>();
+ calleePrefix.add(mdCallee.getThis());
+ for (int k = 1; k < prefix.size(); k++) {
+ calleePrefix.add(prefix.get(k));
+ }
+ calleePrefixList.add(calleePrefix);
+ }
+ }
+
+ return calleePrefixList;
+
+ }
+
+ private List<NTuple<Descriptor>> calculatePrefixList(FlowGraph flowGraph, FlowNode flowNode) {
+
+ System.out.println("\n##### calculatePrefixList=" + flowNode);
+
+ Set<FlowNode> inNodeSet = flowGraph.getIncomingFlowNodeSet(flowNode);
+ inNodeSet.add(flowNode);
+
+ System.out.println("inNodeSet=" + inNodeSet);
+
+ List<NTuple<Descriptor>> prefixList = new ArrayList<NTuple<Descriptor>>();
+
+ for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode inNode = (FlowNode) iterator.next();
+
+ NTuple<Descriptor> inNodeTuple = inNode.getCurrentDescTuple();
+
+ // CompositeLocation inNodeInferredLoc =
+ // generateInferredCompositeLocation(methodInfo, inNodeTuple);
+ // NTuple<Location> inNodeInferredLocTuple = inNodeInferredLoc.getTuple();
+
+ for (int i = 1; i < inNodeTuple.size(); i++) {
+ NTuple<Descriptor> prefix = inNodeTuple.subList(0, i);
+ if (!prefixList.contains(prefix)) {
+ prefixList.add(prefix);
+ }
+ }
+ }
+
+ Collections.sort(prefixList, new Comparator<NTuple<Descriptor>>() {
+ public int compare(NTuple<Descriptor> arg0, NTuple<Descriptor> 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;
+
+ }
+
+ public CompositeLocation convertToCompositeLocation(MethodDescriptor md, NTuple<Descriptor> tuple) {
+
+ CompositeLocation compLoc = new CompositeLocation();
+
+ Descriptor enclosingDescriptor = md;
+
+ 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 (curDescriptor instanceof VarDescriptor) {
+ enclosingDescriptor = md.getClassDesc();
+ } else if (curDescriptor instanceof NameDescriptor) {
+ // it is "GLOBAL LOC" case!
+ enclosingDescriptor = GLOBALDESC;
+ } else {
+ enclosingDescriptor = ((FieldDescriptor) curDescriptor).getClassDescriptor();
+ }
+
+ }
+
+ System.out.println("-convertToCompositeLocation from=" + tuple + " to " + compLoc);
+
+ return compLoc;
+ }
+
+ private LocationDescriptor generateNewLocationDescriptor() {
+ return new LocationDescriptor("Loc" + (locSeed++));
+ }
+
+ private int getPrefixIndex(NTuple<Descriptor> tuple1, NTuple<Descriptor> tuple2) {
+
+ // 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
+
+ int minSize = tuple1.size();
+ if (minSize > tuple2.size()) {
+ minSize = tuple2.size();
+ }
+
+ int idx = -1;
+ for (int i = 0; i < minSize; i++) {
+ if (!tuple1.get(i).equals(tuple2.get(i))) {
+ break;
+ } else {
+ idx++;
+ }
+ }
+
+ return idx;
+ }
+
+ private void analyzeLatticeMethodInvocationNode(MethodDescriptor mdCaller,
+ SSJavaLattice<String> methodLattice, MethodLocationInfo methodInfo)
+ throws CyclicFlowException {
+
+ // 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
+
+ Set<MethodInvokeNode> setMethodInvokeNode =
+ mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
+
+ if (setMethodInvokeNode != null) {
+
+ for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
+ MethodInvokeNode min = (MethodInvokeNode) iterator.next();
+ MethodDescriptor mdCallee = min.getMethod();
+ Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ if (mdCallee.isStatic()) {
+ setPossibleCallees.add(mdCallee);
+ } else {
+ Set<MethodDescriptor> 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();
+ propagateRelationToCaller(min, mdCaller, possibleMdCallee, methodLattice, methodInfo);
+ }
+
+ }
+ }
+
+ }
+
+ private void propagateRelationToCaller(MethodInvokeNode min, MethodDescriptor mdCaller,
+ MethodDescriptor possibleMdCallee, SSJavaLattice<String> methodLattice,
+ MethodLocationInfo methodInfo) throws CyclicFlowException {
+
+ SSJavaLattice<String> calleeLattice = getMethodLattice(possibleMdCallee);
+ MethodLocationInfo calleeLocInfo = getMethodLocationInfo(possibleMdCallee);
+ FlowGraph calleeFlowGraph = getFlowGraph(possibleMdCallee);
+
+ 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);
+
+ // 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
+
+ for (Iterator<NTuple<Descriptor>> iterator = argDescTupleSet1.iterator(); iterator
+ .hasNext();) {
+ NTuple<Descriptor> argDescTuple1 = iterator.next();
+
+ for (Iterator<NTuple<Descriptor>> iterator2 = argDescTupleSet2.iterator(); iterator2
+ .hasNext();) {
+ NTuple<Descriptor> argDescTuple2 = iterator2.next();
+
+ // retreive inferred location by the local var descriptor
+
+ NTuple<Location> tuple1 = getFlowGraph(mdCaller).getLocationTuple(argDescTuple1);
+ NTuple<Location> tuple2 = getFlowGraph(mdCaller).getLocationTuple(argDescTuple2);
+
+ // CompositeLocation higherInferLoc =
+ // methodInfo.getInferLocation(argTuple1.get(0));
+ // CompositeLocation lowerInferLoc =
+ // methodInfo.getInferLocation(argTuple2.get(0));
+
+ CompositeLocation inferLoc1 = generateInferredCompositeLocation(methodInfo, tuple1);
+ CompositeLocation inferLoc2 = generateInferredCompositeLocation(methodInfo, tuple2);
+
+ // addRelation(methodLattice, methodInfo, inferLoc1, inferLoc2);
+
+ addFlowGraphEdge(mdCaller, argDescTuple1, argDescTuple2);
+
+ }
+
+ }
+
+ }
+ }
+ }
+ }
+
+ }
+
+ private CompositeLocation generateInferredCompositeLocation(MethodLocationInfo methodInfo,
+ NTuple<Location> tuple) {
+
+ // first, retrieve inferred location by the local var descriptor
+ CompositeLocation inferLoc = new CompositeLocation();
+
+ CompositeLocation localVarInferLoc =
+ methodInfo.getInferLocation(tuple.get(0).getLocDescriptor());
+
+ localVarInferLoc.get(0).setLocDescriptor(tuple.get(0).getLocDescriptor());
+
+ for (int i = 0; i < localVarInferLoc.getSize(); i++) {
+ inferLoc.addLocation(localVarInferLoc.get(i));
+ }
+
+ for (int i = 1; i < tuple.size(); i++) {
+ Location cur = tuple.get(i);
+ Descriptor enclosingDesc = cur.getDescriptor();
+ Descriptor curDesc = cur.getLocDescriptor();
+
+ 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);
+ }
+
+ inferLoc.addLocation(inferLocElement);
+
+ }
+
+ assert (inferLoc.get(0).getLocDescriptor().getSymbol() == inferLoc.get(0).getLocIdentifier());
+ return inferLoc;
+ }
+
+ private void addRelation(SSJavaLattice<String> methodLattice, MethodLocationInfo methodInfo,
+ CompositeLocation srcInferLoc, CompositeLocation dstInferLoc) throws CyclicFlowException {
+
+ System.out.println("addRelation --- srcInferLoc=" + srcInferLoc + " dstInferLoc="
+ + dstInferLoc);
+ String srcLocalLocSymbol = srcInferLoc.get(0).getLocIdentifier();
+ String dstLocalLocSymbol = dstInferLoc.get(0).getLocIdentifier();
+
+ 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
+
+ if (!srcLocalLocSymbol.equals(dstLocalLocSymbol)) {
+ addRelationHigherToLower(methodLattice, methodInfo, srcLocalLocSymbol, dstLocalLocSymbol);
+ } else {
+ recursivelyAddRelation(1, srcInferLoc, dstInferLoc);
+ }
+ } else {
+ // either src or dst has assigned to a composite location
+ if (!srcLocalLocSymbol.equals(dstLocalLocSymbol)) {
+ addRelationHigherToLower(methodLattice, methodInfo, srcLocalLocSymbol, dstLocalLocSymbol);
+ }
+ }
+
+ System.out.println();
+
+ }
+
+ public LocationInfo getLocationInfo(Descriptor d) {
+ if (d instanceof MethodDescriptor) {
+ return getMethodLocationInfo((MethodDescriptor) d);
+ } else {
+ return getFieldLocationInfo((ClassDescriptor) d);
+ }
+ }
+
+ private MethodLocationInfo getMethodLocationInfo(MethodDescriptor md) {
+
+ if (!mapMethodDescToMethodLocationInfo.containsKey(md)) {
+ mapMethodDescToMethodLocationInfo.put(md, new MethodLocationInfo(md));
+ }
+
+ return mapMethodDescToMethodLocationInfo.get(md);
+
+ }
+
+ private LocationInfo getFieldLocationInfo(ClassDescriptor cd) {
+
+ if (!mapClassToLocationInfo.containsKey(cd)) {
+ mapClassToLocationInfo.put(cd, new LocationInfo(cd));
+ }
+
+ return mapClassToLocationInfo.get(cd);
+
+ }
+
+ private void addRelationToLattice(MethodDescriptor md, SSJavaLattice<String> methodLattice,
+ MethodLocationInfo methodInfo, FlowNode srcNode, FlowNode dstNode) throws CyclicFlowException {
+
+ System.out.println();
+ System.out.println("### addRelationToLattice src=" + srcNode + " dst=" + dstNode);
+
+ // add a new binary relation of dstNode < srcNode
+ FlowGraph flowGraph = getFlowGraph(md);
+ try {
+ System.out.println("***** src composite case::");
+ calculateCompositeLocation(flowGraph, methodLattice, methodInfo, srcNode, null);
+
+ CompositeLocation srcInferLoc =
+ generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(srcNode));
+ CompositeLocation dstInferLoc =
+ generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(dstNode));
+ addRelation(methodLattice, methodInfo, srcInferLoc, dstInferLoc);
+ } catch (CyclicFlowException e) {
+ // there is a cyclic value flow... try to calculate a composite location
+ // for the destination node
+ System.out.println("***** dst composite case::");
+ calculateCompositeLocation(flowGraph, methodLattice, methodInfo, dstNode, srcNode);
+ CompositeLocation srcInferLoc =
+ generateInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(srcNode));
+ CompositeLocation 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.");
+ }
+ }
+
+ }
+
+ private void recursivelyAddRelation(int idx, CompositeLocation srcInferLoc,
+ CompositeLocation dstInferLoc) throws CyclicFlowException {
+
+ String srcLocSymbol = srcInferLoc.get(idx).getLocIdentifier();
+ String dstLocSymbol = dstInferLoc.get(idx).getLocIdentifier();
+
+ Descriptor parentDesc = srcInferLoc.get(idx).getDescriptor();
+
+ 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);
+ System.out.println("SET SHARED LOCATION=" + inferLocElement);
+ getLattice(inferLocElement.getDescriptor())
+ .addSharedLoc(inferLocElement.getLocIdentifier());
+ } else if (srcInferLoc.getSize() > (idx + 1) && dstInferLoc.getSize() > (idx + 1)) {
+ recursivelyAddRelation(idx + 1, srcInferLoc, dstInferLoc);
+ }
+ } else {
+ addRelationHigherToLower(getLattice(parentDesc), getLocationInfo(parentDesc), srcLocSymbol,
+ dstLocSymbol);
+ }
+ }
+
+ private void recursivelyAddCompositeRelation(MethodDescriptor md, FlowGraph flowGraph,
+ MethodLocationInfo methodInfo, FlowNode srcNode, FlowNode dstNode, Descriptor srcDesc,
+ Descriptor dstDesc) throws CyclicFlowException {
+
+ CompositeLocation inferSrcLoc;
+ CompositeLocation inferDstLoc = methodInfo.getInferLocation(dstDesc);
+
+ if (srcNode.getDescTuple().size() > 1) {
+ // field access
+ inferSrcLoc = new CompositeLocation();
+
+ NTuple<Location> locTuple = flowGraph.getLocationTuple(srcNode);
+ for (int i = 0; i < locTuple.size(); i++) {
+ inferSrcLoc.addLocation(locTuple.get(i));
+ }
+
+ } else {
+ inferSrcLoc = methodInfo.getInferLocation(srcDesc);
+ }
+
+ if (dstNode.getDescTuple().size() > 1) {
+ // field access
+ inferDstLoc = new CompositeLocation();
+
+ NTuple<Location> locTuple = flowGraph.getLocationTuple(dstNode);
+ for (int i = 0; i < locTuple.size(); i++) {
+ inferDstLoc.addLocation(locTuple.get(i));
+ }
+
+ } else {
+ inferDstLoc = methodInfo.getInferLocation(dstDesc);
+ }
+
+ recursiveAddRelationToLattice(1, md, inferSrcLoc, inferDstLoc);
+ }
+
+ private void addPrefixMapping(Map<NTuple<Location>, Set<NTuple<Location>>> map,
+ NTuple<Location> prefix, NTuple<Location> element) {
+
+ if (!map.containsKey(prefix)) {
+ map.put(prefix, new HashSet<NTuple<Location>>());
+ }
+ map.get(prefix).add(element);
+ }
+
+ private boolean calculateCompositeLocation(FlowGraph flowGraph,
+ SSJavaLattice<String> methodLattice, MethodLocationInfo methodInfo, FlowNode flowNode,
+ FlowNode srcNode) throws CyclicFlowException {
+
+ Descriptor localVarDesc = flowNode.getDescTuple().get(0);
+ NTuple<Location> flowNodelocTuple = flowGraph.getLocationTuple(flowNode);
+
+ if (localVarDesc.equals(methodInfo.getMethodDesc())) {
+ return false;
+ }
+
+ Set<FlowNode> inNodeSet = flowGraph.getIncomingFlowNodeSet(flowNode);
+ Set<FlowNode> reachableNodeSet = flowGraph.getReachFlowNodeSetFrom(flowNode);
+
+ Map<NTuple<Location>, Set<NTuple<Location>>> mapPrefixToIncomingLocTupleSet =
+ new HashMap<NTuple<Location>, Set<NTuple<Location>>>();
+
+ List<NTuple<Location>> prefixList = new ArrayList<NTuple<Location>>();
+
+ for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode inNode = (FlowNode) iterator.next();
+ NTuple<Location> inNodeTuple = flowGraph.getLocationTuple(inNode);
+
+ CompositeLocation inNodeInferredLoc =
+ generateInferredCompositeLocation(methodInfo, inNodeTuple);
+
+ NTuple<Location> inNodeInferredLocTuple = inNodeInferredLoc.getTuple();
+
+ for (int i = 1; i < inNodeInferredLocTuple.size(); i++) {
+ NTuple<Location> prefix = inNodeInferredLocTuple.subList(0, i);
+ if (!prefixList.contains(prefix)) {
+ prefixList.add(prefix);
+ }
+ addPrefixMapping(mapPrefixToIncomingLocTupleSet, prefix, inNodeInferredLocTuple);
+ }
+ }
+
+ Collections.sort(prefixList, new Comparator<NTuple<Location>>() {
+ public int compare(NTuple<Location> arg0, NTuple<Location> arg1) {
+ int s0 = arg0.size();
+ int s1 = arg1.size();
+ if (s0 > s1) {
+ return -1;
+ } else if (s0 == s1) {
+ return 0;
+ } else {
+ return 1;
+ }
+ }
+ });
+
+ // System.out.println("prefixList=" + prefixList);
+ // System.out.println("reachableNodeSet=" + reachableNodeSet);
+
+ // find out reachable nodes that have the longest common prefix
+ for (int i = 0; i < prefixList.size(); i++) {
+ NTuple<Location> curPrefix = prefixList.get(i);
+ Set<NTuple<Location>> reachableCommonPrefixSet = new HashSet<NTuple<Location>>();
+
+ for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
+ FlowNode reachableNode = (FlowNode) iterator2.next();
+ NTuple<Location> reachLocTuple = flowGraph.getLocationTuple(reachableNode);
+ CompositeLocation reachLocInferLoc =
+ generateInferredCompositeLocation(methodInfo, reachLocTuple);
+ if (reachLocInferLoc.getTuple().startsWith(curPrefix)) {
+ reachableCommonPrefixSet.add(reachLocTuple);
+ }
+ }
+
+ 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);
+
+ Set<NTuple<Location>> incomingCommonPrefixSet =
+ mapPrefixToIncomingLocTupleSet.get(curPrefix);
+
+ int idx = curPrefix.size();
+ NTuple<Location> element = incomingCommonPrefixSet.iterator().next();
+ Descriptor desc = element.get(idx).getDescriptor();
+
+ SSJavaLattice<String> lattice = getLattice(desc);
+ LocationInfo locInfo = getLocationInfo(desc);
+
+ CompositeLocation inferLocation =
+ generateInferredCompositeLocation(methodInfo, flowNodelocTuple);
+
+ // methodInfo.getInferLocation(localVarDesc);
+ CompositeLocation newInferLocation = new CompositeLocation();
+
+ if (inferLocation.getTuple().startsWith(curPrefix)) {
+ // the same infer location is already existed. no need to do
+ // anything
+ System.out.println("NO ATTEMPT TO MAKE A COMPOSITE LOCATION curPrefix=" + curPrefix);
+
+ // TODO: refactoring!
+ if (srcNode != null) {
+ CompositeLocation newLoc = new CompositeLocation();
+ String newLocSymbol = "Loc" + (SSJavaLattice.seed++);
+ for (int locIdx = 0; locIdx < curPrefix.size(); locIdx++) {
+ newLoc.addLocation(curPrefix.get(locIdx));
+ }
+ Location newLocationElement = new Location(desc, newLocSymbol);
+ newLoc.addLocation(newLocationElement);
+
+ Descriptor srcLocalVar = srcNode.getDescTuple().get(0);
+ methodInfo.mapDescriptorToLocation(srcLocalVar, newLoc.clone());
+ addMapLocSymbolToInferredLocation(methodInfo.getMethodDesc(), srcLocalVar, newLoc);
+ methodInfo.removeMaplocalVarToLocSet(srcLocalVar);
+
+ // add the field/var descriptor to the set of the location symbol
+ int lastIdx = srcNode.getDescTuple().size() - 1;
+ Descriptor lastFlowNodeDesc = srcNode.getDescTuple().get(lastIdx);
+ NTuple<Location> srcNodelocTuple = flowGraph.getLocationTuple(srcNode);
+ Descriptor enclosinglastLastFlowNodeDesc = srcNodelocTuple.get(lastIdx).getDescriptor();
+
+ CompositeLocation newlyInferredLocForFlowNode =
+ generateInferredCompositeLocation(methodInfo, srcNodelocTuple);
+ Location lastInferLocElement =
+ newlyInferredLocForFlowNode.get(newlyInferredLocForFlowNode.getSize() - 1);
+ Descriptor enclosingLastInferLocElement = lastInferLocElement.getDescriptor();
+
+ // getLocationInfo(enclosingLastInferLocElement).addMapLocSymbolToDescSet(
+ // lastInferLocElement.getLocIdentifier(), lastFlowNodeDesc);
+ getLocationInfo(enclosingLastInferLocElement).addMapLocSymbolToRelatedInferLoc(
+ lastInferLocElement.getLocIdentifier(), enclosinglastLastFlowNodeDesc,
+ lastFlowNodeDesc);
+
+ System.out.println("@@@@@@@ ASSIGN " + newLoc + " to SRC=" + srcNode);
+ }
+
+ return true;
+ } else {
+ // assign a new composite location
+
+ // String oldMethodLocationSymbol =
+ // inferLocation.get(0).getLocIdentifier();
+ String newLocSymbol = "Loc" + (SSJavaLattice.seed++);
+ for (int locIdx = 0; locIdx < curPrefix.size(); locIdx++) {
+ newInferLocation.addLocation(curPrefix.get(locIdx));
+ }
+ Location newLocationElement = new Location(desc, newLocSymbol);
+ newInferLocation.addLocation(newLocationElement);
+
+ // maps local variable to location types of the common prefix
+ methodInfo.mapDescriptorToLocation(localVarDesc, newInferLocation.clone());
+
+ // methodInfo.mapDescriptorToLocation(localVarDesc, newInferLocation);
+ addMapLocSymbolToInferredLocation(methodInfo.getMethodDesc(), localVarDesc,
+ newInferLocation);
+ methodInfo.removeMaplocalVarToLocSet(localVarDesc);
+
+ // add the field/var descriptor to the set of the location symbol
+ int lastIdx = flowNode.getDescTuple().size() - 1;
+ Descriptor lastFlowNodeDesc = flowNode.getDescTuple().get(lastIdx);
+ Descriptor enclosinglastLastFlowNodeDesc = flowNodelocTuple.get(lastIdx).getDescriptor();
+
+ CompositeLocation newlyInferredLocForFlowNode =
+ generateInferredCompositeLocation(methodInfo, flowNodelocTuple);
+ Location lastInferLocElement =
+ newlyInferredLocForFlowNode.get(newlyInferredLocForFlowNode.getSize() - 1);
+ Descriptor enclosingLastInferLocElement = lastInferLocElement.getDescriptor();
+
+ // getLocationInfo(enclosingLastInferLocElement).addMapLocSymbolToDescSet(
+ // lastInferLocElement.getLocIdentifier(), lastFlowNodeDesc);
+ getLocationInfo(enclosingLastInferLocElement).addMapLocSymbolToRelatedInferLoc(
+ lastInferLocElement.getLocIdentifier(), enclosinglastLastFlowNodeDesc,
+ lastFlowNodeDesc);
+
+ // clean up the previous location
+ // Location prevInferLocElement =
+ // inferLocation.get(inferLocation.getSize() - 1);
+ // Descriptor prevEnclosingDesc = prevInferLocElement.getDescriptor();
+ //
+ // SSJavaLattice<String> targetLattice;
+ // LocationInfo targetInfo;
+ // if (prevEnclosingDesc.equals(methodInfo.getMethodDesc())) {
+ // targetLattice = methodLattice;
+ // targetInfo = methodInfo;
+ // } else {
+ // targetLattice = getLattice(prevInferLocElement.getDescriptor());
+ // targetInfo = getLocationInfo(prevInferLocElement.getDescriptor());
+ // }
+ //
+ // Set<Pair<Descriptor, Descriptor>> associstedDescSet =
+ // targetInfo.getRelatedInferLocSet(prevInferLocElement.getLocIdentifier());
+ //
+ // if (associstedDescSet.size() == 1) {
+ // targetLattice.remove(prevInferLocElement.getLocIdentifier());
+ // } else {
+ // associstedDescSet.remove(lastFlowNodeDesc);
+ // }
+
+ }
+
+ System.out.println("curPrefix=" + curPrefix);
+ System.out.println("ASSIGN NEW COMPOSITE LOCATION =" + newInferLocation + " to "
+ + flowNode);
+
+ String newlyInsertedLocName =
+ newInferLocation.get(newInferLocation.getSize() - 1).getLocIdentifier();
+
+ System.out.println("-- add in-flow");
+ for (Iterator iterator = incomingCommonPrefixSet.iterator(); iterator.hasNext();) {
+ NTuple<Location> tuple = (NTuple<Location>) iterator.next();
+ Location loc = tuple.get(idx);
+ String higher = loc.getLocIdentifier();
+ addRelationHigherToLower(lattice, locInfo, higher, newlyInsertedLocName);
+ }
+
+ System.out.println("-- add out flow");
+ for (Iterator iterator = reachableCommonPrefixSet.iterator(); iterator.hasNext();) {
+ NTuple<Location> tuple = (NTuple<Location>) iterator.next();
+ if (tuple.size() > idx) {
+ Location loc = tuple.get(idx);
+ String lower = loc.getLocIdentifier();
+ // String lower =
+ // locInfo.getFieldInferLocation(loc.getLocDescriptor()).getLocIdentifier();
+ addRelationHigherToLower(lattice, locInfo, newlyInsertedLocName, lower);
+ }
+ }
+
+ return true;
+ }
+
+ }
+
+ return false;
+
+ }
+
+ private void addMapLocSymbolToInferredLocation(MethodDescriptor md, Descriptor localVar,
+ CompositeLocation inferLoc) {
+
+ Location locElement = inferLoc.get((inferLoc.getSize() - 1));
+ Descriptor enclosingDesc = locElement.getDescriptor();
+ LocationInfo locInfo = getLocationInfo(enclosingDesc);
+ locInfo.addMapLocSymbolToRelatedInferLoc(locElement.getLocIdentifier(), md, localVar);
+ }
+
+ private boolean isCompositeLocation(CompositeLocation cl) {
+ return cl.getSize() > 1;
+ }
+
+ private boolean containsNonPrimitiveElement(Set<Descriptor> 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 void addRelationHigherToLower(SSJavaLattice<String> lattice, LocationInfo locInfo,
+ String higher, String lower) throws CyclicFlowException {
+
+ System.out.println("---addRelationHigherToLower " + higher + " -> " + lower
+ + " to the lattice of " + locInfo.getDescIdentifier());
+ // if (higher.equals(lower) && lattice.isSharedLoc(higher)) {
+ // return;
+ // }
+ Set<String> cycleElementSet = lattice.getPossibleCycleElements(higher, lower);
+
+ boolean hasNonPrimitiveElement = false;
+ for (Iterator iterator = cycleElementSet.iterator(); iterator.hasNext();) {
+ String cycleElementLocSymbol = (String) iterator.next();
+
+ Set<Descriptor> descSet = locInfo.getDescSet(cycleElementLocSymbol);
+ if (containsNonPrimitiveElement(descSet)) {
+ hasNonPrimitiveElement = true;
+ break;
+ }
+ }
+
+ 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) {
+
+ String newSharedLoc = "SharedLoc" + (SSJavaLattice.seed++);
+
+ System.out.println("---ASSIGN NEW SHARED LOC=" + newSharedLoc + " to " + cycleElementSet);
+ lattice.mergeIntoNewLocation(cycleElementSet, newSharedLoc);
+ lattice.addSharedLoc(newSharedLoc);
+
+ for (Iterator iterator = cycleElementSet.iterator(); iterator.hasNext();) {
+ String oldLocSymbol = (String) iterator.next();
+
+ Set<Pair<Descriptor, Descriptor>> inferLocSet = locInfo.getRelatedInferLocSet(oldLocSymbol);
+ System.out.println("---update related locations=" + inferLocSet);
+ for (Iterator iterator2 = inferLocSet.iterator(); iterator2.hasNext();) {
+ Pair<Descriptor, Descriptor> pair = (Pair<Descriptor, Descriptor>) iterator2.next();
+ Descriptor enclosingDesc = pair.getFirst();
+ Descriptor desc = pair.getSecond();
+
+ CompositeLocation inferLoc;
+ if (curMethodInfo.md.equals(enclosingDesc)) {
+ inferLoc = curMethodInfo.getInferLocation(desc);
+ } else {
+ inferLoc = getLocationInfo(enclosingDesc).getInferLocation(desc);
+ }
+
+ Location locElement = inferLoc.get(inferLoc.getSize() - 1);
+
+ locElement.setLocIdentifier(newSharedLoc);
+ locInfo.addMapLocSymbolToRelatedInferLoc(newSharedLoc, enclosingDesc, desc);
+
+ if (curMethodInfo.md.equals(enclosingDesc)) {
+ inferLoc = curMethodInfo.getInferLocation(desc);
+ } else {
+ inferLoc = getLocationInfo(enclosingDesc).getInferLocation(desc);
+ }
+ System.out.println("---New Infer Loc=" + inferLoc);
+
+ }
+ locInfo.removeRelatedInferLocSet(oldLocSymbol, newSharedLoc);
+
+ }
+
+ lattice.addSharedLoc(newSharedLoc);
+
+ } else if (!lattice.isGreaterThan(higher, lower)) {
+ lattice.addRelationHigherToLower(higher, lower);
+ }
+ }
+
+ private void replaceOldLocWithNewLoc(SSJavaLattice<String> methodLattice, String oldLocSymbol,
+ String newLocSymbol) {
+
+ if (methodLattice.containsKey(oldLocSymbol)) {
+ methodLattice.substituteLocation(oldLocSymbol, newLocSymbol);
+ }
+
+ }
+
+ private void prefixSanityCheck(List<NTuple<Location>> prefixList, int curIdx,
+ FlowGraph flowGraph, Set<FlowNode> reachableNodeSet) {
+
+ NTuple<Location> curPrefix = prefixList.get(curIdx);
+
+ for (int i = curIdx + 1; i < prefixList.size(); i++) {
+ NTuple<Location> prefixTuple = prefixList.get(i);
+
+ if (curPrefix.startsWith(prefixTuple)) {
+ continue;
+ }
+
+ for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
+ FlowNode reachableNode = (FlowNode) iterator2.next();
+ NTuple<Location> reachLocTuple = flowGraph.getLocationTuple(reachableNode);
+ if (reachLocTuple.startsWith(prefixTuple)) {
+ // TODO
+ throw new Error("Failed to generate a composite location");
+ }
+ }
+ }
+ }
+
+ public boolean isPrimitiveLocalVariable(FlowNode node) {
+ VarDescriptor varDesc = (VarDescriptor) node.getDescTuple().get(0);
+ return varDesc.getType().isPrimitive();
+ }
+
+ private SSJavaLattice<String> getLattice(Descriptor d) {
+ if (d instanceof MethodDescriptor) {
+ return getMethodLattice((MethodDescriptor) d);
+ } else {
+ return getFieldLattice((ClassDescriptor) d);
+ }
+ }
+
+ private SSJavaLattice<String> getMethodLattice(MethodDescriptor md) {
+ if (!md2lattice.containsKey(md)) {
+ md2lattice.put(md, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
+ }
+ return md2lattice.get(md);
+ }
+
+ private void setMethodLattice(MethodDescriptor md, SSJavaLattice<String> lattice) {
+ md2lattice.put(md, lattice);
+ }
+
+ private void extractFlowsBetweenFields(ClassDescriptor cd, FlowNode srcNode, FlowNode dstNode,
+ int idx) {
+
+ NTuple<Descriptor> srcCurTuple = srcNode.getCurrentDescTuple();
+ NTuple<Descriptor> 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 = srcCurTuple.get(idx);
+ ClassDescriptor classDesc;
+
+ if (idx == 0) {
+ classDesc = ((VarDescriptor) desc).getType().getClassDesc();
+ } else {
+ classDesc = ((FieldDescriptor) desc).getType().getClassDesc();
+ }
+
+ extractFlowsBetweenFields(classDesc, srcNode, dstNode, idx + 1);
+
+ } else {
+
+ Descriptor srcFieldDesc = srcCurTuple.get(idx);
+ Descriptor dstFieldDesc = dstCurTuple.get(idx);
+
+ // add a new edge
+ getHierarchyGraph(cd).addEdge(srcFieldDesc, dstFieldDesc);
+
+ }
+
+ }
+
+ private void extractRelationFromFieldFlows(ClassDescriptor cd, FlowNode srcNode,
+ FlowNode dstNode, int idx) throws CyclicFlowException {
+
+ if (srcNode.getDescTuple().get(idx).equals(dstNode.getDescTuple().get(idx))
+ && srcNode.getDescTuple().size() > (idx + 1) && dstNode.getDescTuple().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);
+ ClassDescriptor classDesc;
+
+ if (idx == 0) {
+ classDesc = ((VarDescriptor) desc).getType().getClassDesc();
+ } else {
+ classDesc = ((FieldDescriptor) desc).getType().getClassDesc();
+ }
+
+ extractRelationFromFieldFlows(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<String> fieldLattice = getFieldLattice(cd);
+ LocationInfo fieldInfo = getFieldLocationInfo(cd);
+
+ String srcSymbol = fieldInfo.getFieldInferLocation(srcFieldDesc).getLocIdentifier();
+ String dstSymbol = fieldInfo.getFieldInferLocation(dstFieldDesc).getLocIdentifier();
+
+ addRelationHigherToLower(fieldLattice, fieldInfo, srcSymbol, dstSymbol);
+
+ }
+
+ }
+
+ public SSJavaLattice<String> getFieldLattice(ClassDescriptor cd) {
+ if (!cd2lattice.containsKey(cd)) {
+ cd2lattice.put(cd, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
+ }
+ return cd2lattice.get(cd);
+ }
+
+ public LinkedList<MethodDescriptor> computeMethodList() {
+
+ Set<MethodDescriptor> toSort = new HashSet<MethodDescriptor>();
+
+ setupToAnalyze();
+
+ Set<MethodDescriptor> visited = new HashSet<MethodDescriptor>();
+ Set<MethodDescriptor> reachableCallee = new HashSet<MethodDescriptor>();
+
+ while (!toAnalyzeIsEmpty()) {
+ ClassDescriptor cd = toAnalyzeNext();
+
+ setupToAnalazeMethod(cd);
+ temp_toanalyzeMethodList.removeAll(visited);
+
+ while (!toAnalyzeMethodIsEmpty()) {
+ MethodDescriptor md = toAnalyzeMethodNext();
+ if ((!visited.contains(md))
+ && (ssjava.needTobeAnnotated(md) || reachableCallee.contains(md))) {
+
+ // creates a mapping from a method descriptor to virtual methods
+ Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ if (md.isStatic()) {
+ setPossibleCallees.add(md);
+ } else {
+ setPossibleCallees.addAll(ssjava.getCallGraph().getMethods(md));
+ }
+
+ Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getCalleeSet(md);
+ Set<MethodDescriptor> needToAnalyzeCalleeSet = new HashSet<MethodDescriptor>();
+
+ 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 void constructFlowGraph() {
+
+ System.out.println("");
+ toanalyze_methodDescList = computeMethodList();
+
+ LinkedList<MethodDescriptor> methodDescList =
+ (LinkedList<MethodDescriptor>) 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<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
+ int offset = 0;
+ if (!md.isStatic()) {
+ offset = 1;
+ mapParamDescToIdx.put(md.getThis(), 0);
+ }
+
+ for (int i = 0; i < md.numParameters(); i++) {
+ Descriptor paramDesc = (Descriptor) md.getParameter(i);
+ mapParamDescToIdx.put(paramDesc, new Integer(i + offset));
+ }
+
+ FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
+ mapMethodDescriptorToFlowGraph.put(md, fg);
+
+ analyzeMethodBody(md.getClassDesc(), md);
+ propagateFlowsFromCalleesWithNoCompositeLocation(md);
+ // assignCompositeLocation(md);
+
+ }
+ }
+ _debug_printGraph();
+
+ }
+
+ private Set<MethodInvokeNode> getMethodInvokeNodeSet(MethodDescriptor md) {
+ if (!mapMethodDescriptorToMethodInvokeNodeSet.containsKey(md)) {
+ mapMethodDescriptorToMethodInvokeNodeSet.put(md, new HashSet<MethodInvokeNode>());
+ }
+ return mapMethodDescriptorToMethodInvokeNodeSet.get(md);
+ }
+
+ private void constructSubGlobalFlowGraph(MethodDescriptor md) {
+
+ FlowGraph flowGraph = getFlowGraph(md);
+
+ Set<MethodInvokeNode> setMethodInvokeNode = getMethodInvokeNodeSet(md);
+
+ for (Iterator<MethodInvokeNode> 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<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ if (mdCallee.isStatic()) {
+ setPossibleCallees.add(mdCallee);
+ } else {
+ Set<MethodDescriptor> 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<FlowNode> 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) {
- NTuple<Descriptor> srcTuple = srcNode.getDescTuple();
+ List<NTuple<Descriptor>> prefixList = calculatePrefixList(flowGraph, flowNode);
+ Set<FlowNode> reachSet = flowGraph.getReachFlowNodeSetFrom(flowNode);
- for (Iterator<FlowEdge> outEdgeIter = currentVisitNode.getOutEdgeSet().iterator(); outEdgeIter
- .hasNext();) {
+ for (int i = 0; i < prefixList.size(); i++) {
+ NTuple<Descriptor> curPrefix = prefixList.get(i);
+ Set<NTuple<Descriptor>> reachableCommonPrefixSet = new HashSet<NTuple<Descriptor>>();
- FlowEdge outEdge = outEdgeIter.next();
- FlowNode newVisitNode = outEdge.getDst();
+ for (Iterator iterator2 = reachSet.iterator(); iterator2.hasNext();) {
+ FlowNode reachNode = (FlowNode) iterator2.next();
+ if (reachNode.getCurrentDescTuple().startsWith(curPrefix)) {
+ reachableCommonPrefixSet.add(reachNode.getCurrentDescTuple());
+ }
+ }
- NTuple<Descriptor> newVisitTuple = newVisitNode.getDescTuple();
+ 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;
+ }
- // if both the source node and the newly visit node are parameters,
- // need to keep this relation, then later add a new relation between
- // corresponding arguments in the caller's lattice.
- if (srcNode.isParameter() && newVisitNode.isParameter()) {
- System.out.println("src=" + srcNode + " newVisitNode=" + newVisitNode);
- propagateRelationToCaller(md, srcNode, newVisitNode);
+ }
}
}
}
- private void extractRelationFromFieldFlows(ClassDescriptor cd, FlowNode srcNode,
- FlowNode dstNode, int idx) {
-
- if (srcNode.getDescTuple().get(idx).equals(dstNode.getDescTuple().get(idx))) {
- // value flow between fields: we don't need to add a binary relation
- // for this case
- VarDescriptor varDesc = (VarDescriptor) srcNode.getDescTuple().get(idx);
- ClassDescriptor varClassDesc = varDesc.getType().getClassDesc();
- extractRelationFromFieldFlows(varClassDesc, srcNode, dstNode, idx + 1);
- } else {
+ private void propagateFlowsFromCalleesWithNoCompositeLocation(MethodDescriptor mdCaller) {
- Descriptor srcFieldDesc = srcNode.getDescTuple().get(idx);
- Descriptor dstFieldDesc = dstNode.getDescTuple().get(idx);
+ // the transformation for a call site propagates flows through parameters
+ // if the method is virtual, it also grab all relations from any possible
+ // callees
- // add a new binary relation of dstNode < srcNode
+ Set<MethodInvokeNode> setMethodInvokeNode =
+ mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
- SSJavaLattice<String> fieldLattice = getFieldLattice(cd);
- fieldLattice.addRelationHigherToLower(srcFieldDesc.getSymbol(), dstFieldDesc.getSymbol());
+ if (setMethodInvokeNode != null) {
- }
+ for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
+ MethodInvokeNode min = (MethodInvokeNode) iterator.next();
+ MethodDescriptor mdCallee = min.getMethod();
+ Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ if (mdCallee.isStatic()) {
+ setPossibleCallees.add(mdCallee);
+ } else {
+ Set<MethodDescriptor> 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);
+ }
- public SSJavaLattice<String> getFieldLattice(ClassDescriptor cd) {
- if (!cd2lattice.containsKey(cd)) {
- cd2lattice.put(cd, new SSJavaLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM));
+ }
}
- return cd2lattice.get(cd);
- }
-
- public void constructFlowGraph() {
- setupToAnalyze();
+ }
- while (!toAnalyzeIsEmpty()) {
- ClassDescriptor cd = toAnalyzeNext();
+ private void propagateFlowsFromCallees(MethodDescriptor mdCaller) {
- setupToAnalazeMethod(cd);
- while (!toAnalyzeMethodIsEmpty()) {
- MethodDescriptor md = toAnalyzeMethodNext();
- if (ssjava.needTobeAnnotated(md)) {
- if (state.SSJAVADEBUG) {
- System.out.println("SSJAVA: Constructing a flow graph: " + md);
- }
+ // 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
+ Set<MethodInvokeNode> setMethodInvokeNode =
+ mapMethodDescriptorToMethodInvokeNodeSet.get(mdCaller);
- Map<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
- int offset = md.isStatic() ? 0 : 1;
- for (int i = 0; i < md.numParameters(); i++) {
- Descriptor paramDesc = (Descriptor) md.getParameter(i);
- mapParamDescToIdx.put(paramDesc, new Integer(i + offset));
- }
+ if (setMethodInvokeNode != null) {
- FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
- mapMethodDescriptorToFlowGraph.put(md, fg);
+ for (Iterator iterator = setMethodInvokeNode.iterator(); iterator.hasNext();) {
+ MethodInvokeNode min = (MethodInvokeNode) iterator.next();
+ MethodDescriptor mdCallee = min.getMethod();
+ Set<MethodDescriptor> setPossibleCallees = new HashSet<MethodDescriptor>();
+ if (mdCallee.isStatic()) {
+ setPossibleCallees.add(mdCallee);
+ } else {
+ Set<MethodDescriptor> calleeSet = ssjava.getCallGraph().getMethods(mdCallee);
+ // removes method descriptors that are not invoked by the caller
+ calleeSet.retainAll(mapMethodToCalleeSet.get(mdCaller));
+ setPossibleCallees.addAll(calleeSet);
+ }
- analyzeMethodBody(cd, md);
+ 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) {
break;
case Kind.ReturnNode:
- analyzeReturnNode(md, nametable, (ReturnNode) bsn);
+ analyzeFlowReturnNode(md, nametable, (ReturnNode) bsn, implicitFlowTupleSet);
break;
case Kind.SubBlockNode:
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 (newImplicitTupleSet.size() > 1) {
+ // need to create an intermediate node for the GLB of conditional locations & implicit flows
+ NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+ for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
+ NTuple<Descriptor> 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);
+ }
}
analyzeFlowBlockNode(md, nametable, sbn.getBlockNode(), implicitFlowTupleSet);
}
- private void analyzeReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode bsn) {
- // TODO Auto-generated method stub
+ private void analyzeFlowReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn,
+ NodeTupleSet implicitFlowTupleSet) {
+
+ 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);
+
+ // 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<Descriptor> returnNodeTuple = (NTuple<Descriptor>) 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);
+
+ if (currentFlowTupleSet.size() > 1) {
+ FlowNode meetNode = fg.createIntermediateNode();
+ for (Iterator iterator = currentFlowTupleSet.iterator(); iterator.hasNext();) {
+ NTuple<Descriptor> currentFlowTuple = (NTuple<Descriptor>) iterator.next();
+ fg.addValueFlowEdge(currentFlowTuple, meetNode.getDescTuple());
+ }
+ fg.addReturnFlowNode(meetNode.getDescTuple());
+ } else if (currentFlowTupleSet.size() == 1) {
+ NTuple<Descriptor> tuple = currentFlowTupleSet.iterator().next();
+ fg.addReturnFlowNode(tuple);
+ }
+
+ }
}
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 (newImplicitTupleSet.size() > 1) {
+ // need to create an intermediate node for the GLB of conditional locations & implicit flows
+ NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+ for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter
+ .hasNext();) {
+ NTuple<Descriptor> tuple = idxIter.next();
+ addFlowGraphEdge(md, tuple, interTuple);
+ }
+ newImplicitTupleSet.clear();
+ newImplicitTupleSet.addTuple(interTuple);
+
+ }
+
+ // ///////////
+ // System.out.println("condTupleNode="+condTupleNode);
+ // NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+ //
+ // for (Iterator<NTuple<Descriptor>> idxIter = condTupleNode.iterator(); idxIter.hasNext();) {
+ // NTuple<Descriptor> tuple = idxIter.next();
+ // addFlowGraphEdge(md, tuple, interTuple);
+ // }
+
+ // for (Iterator<NTuple<Descriptor>> idxIter = implicitFlowTupleSet.iterator(); idxIter
+ // .hasNext();) {
+ // NTuple<Descriptor> 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
BlockNode bn = ln.getInitializer();
- analyzeFlowBlockNode(md, bn.getVarTable(), bn, implicitFlowTupleSet);
bn.getVarTable().setParent(nametable);
+ for (int i = 0; i < bn.size(); i++) {
+ BlockStatementNode bsn = bn.get(i);
+ analyzeBlockStatementNode(md, bn.getVarTable(), bsn, implicitFlowTupleSet);
+ }
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);
+ // ///////////
+ NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+
+ for (Iterator<NTuple<Descriptor>> idxIter = condTupleNode.iterator(); idxIter.hasNext();) {
+ NTuple<Descriptor> tuple = idxIter.next();
+ addFlowGraphEdge(md, tuple, interTuple);
+ }
+
+ for (Iterator<NTuple<Descriptor>> idxIter = implicitFlowTupleSet.iterator(); idxIter
+ .hasNext();) {
+ NTuple<Descriptor> tuple = idxIter.next();
+ addFlowGraphEdge(md, tuple, interTuple);
+ }
+
+ NodeTupleSet newImplicitSet = new NodeTupleSet();
+ newImplicitSet.addTuple(interTuple);
+ analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(), newImplicitSet);
+ analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(), newImplicitSet);
+ // ///////////
+
+ // condTupleNode.addTupleSet(implicitFlowTupleSet);
+ //
+ // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getUpdate(),
+ // condTupleNode);
+ // analyzeFlowBlockNode(md, bn.getVarTable(), ln.getBody(),
+ // condTupleNode);
}
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 (newImplicitTupleSet.size() > 1) {
+
+ // need to create an intermediate node for the GLB of conditional locations & implicit flows
+ NTuple<Descriptor> interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+ for (Iterator<NTuple<Descriptor>> idxIter = newImplicitTupleSet.iterator(); idxIter.hasNext();) {
+ NTuple<Descriptor> 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);
}
}
DeclarationNode dn, NodeTupleSet implicitFlowTupleSet) {
VarDescriptor vd = dn.getVarDescriptor();
+ mapDescToDefinitionLine.put(vd, dn.getNumLine());
NTuple<Descriptor> tupleLHS = new NTuple<Descriptor>();
tupleLHS.add(vd);
- getFlowGraph(md).createNewFlowNode(tupleLHS);
+ FlowNode fn = getFlowGraph(md).createNewFlowNode(tupleLHS);
+ fn.setDeclarationNode();
if (dn.getExpression() != null) {
- 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<NTuple<Descriptor>> iter = tupleSetRHS.iterator(); iter.hasNext();) {
- NTuple<Descriptor> from = iter.next();
- addFlowGraphEdge(md, from, tupleLHS);
+ // creates edges from RHS to LHS
+ NTuple<Descriptor> interTuple = null;
+ if (nodeSetRHS.size() > 1) {
+ interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+ }
+
+ for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
+ NTuple<Descriptor> fromTuple = iter.next();
+ addFlowGraphEdge(md, fromTuple, interTuple, tupleLHS);
+ }
+
+ // creates edges from implicitFlowTupleSet to LHS
+ for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
+ NTuple<Descriptor> implicitTuple = iter.next();
+ addFlowGraphEdge(md, implicitTuple, tupleLHS);
}
}
// note that expression node can create more than one flow node
// nodeSet contains of flow nodes
- // base is always assigned to null except name node case!
+ // base is always assigned to null except the case of a name node!
NTuple<Descriptor> flowTuple;
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:
flowTuple =
analyzeFlowFieldAccessNode(md, nametable, (FieldAccessNode) en, nodeSet, base,
- implicitFlowTupleSet);
- nodeSet.addTuple(flowTuple);
+ implicitFlowTupleSet, isLHS);
+ if (flowTuple != null) {
+ nodeSet.addTuple(flowTuple);
+ }
return flowTuple;
case Kind.NameNode:
NodeTupleSet nameNodeSet = new NodeTupleSet();
flowTuple =
analyzeFlowNameNode(md, nametable, (NameNode) en, nameNodeSet, base, implicitFlowTupleSet);
- nodeSet.addTuple(flowTuple);
+ if (flowTuple != null) {
+ nodeSet.addTuple(flowTuple);
+ }
return flowTuple;
case Kind.OpNode:
break;
case Kind.MethodInvokeNode:
- analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, implicitFlowTupleSet);
+ analyzeFlowMethodInvokeNode(md, nametable, (MethodInvokeNode) en, nodeSet,
+ implicitFlowTupleSet);
break;
case Kind.TertiaryNode:
break;
case Kind.CastNode:
- analyzeFlowCastNode(md, nametable, (CastNode) en, implicitFlowTupleSet);
+ analyzeFlowCastNode(md, nametable, (CastNode) en, nodeSet, base, implicitFlowTupleSet);
break;
-
// case Kind.InstanceOfNode:
// checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
// return null;
}
private void analyzeFlowCastNode(MethodDescriptor md, SymbolTable nametable, CastNode cn,
- NodeTupleSet implicitFlowTupleSet) {
+ NodeTupleSet nodeSet, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
- NodeTupleSet nodeTupleSet = new NodeTupleSet();
- analyzeFlowExpressionNode(md, nametable, cn.getExpression(), nodeTupleSet, false);
+ analyzeFlowExpressionNode(md, nametable, cn.getExpression(), nodeSet, base,
+ implicitFlowTupleSet, false);
}
private void analyzeFlowTertiaryNode(MethodDescriptor md, SymbolTable nametable, TertiaryNode tn,
NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
- System.out.println("### analyzeFlowTertiaryNode=" + tn.printNode(0));
-
NodeTupleSet tertiaryTupleNode = new NodeTupleSet();
analyzeFlowExpressionNode(md, nametable, tn.getCond(), tertiaryTupleNode, null,
implicitFlowTupleSet, false);
// add edges from tertiaryTupleNode to all nodes of conditional nodes
tertiaryTupleNode.addTupleSet(implicitFlowTupleSet);
- System.out.println("### TertiarayNode's condition=" + tertiaryTupleNode);
analyzeFlowExpressionNode(md, nametable, tn.getTrueExpr(), tertiaryTupleNode, null,
implicitFlowTupleSet, false);
set.add(min);
}
+ private void addParamNodeFlowingToReturnValue(MethodDescriptor md, FlowNode fn) {
+
+ if (!mapMethodDescToParamNodeFlowsToReturnValue.containsKey(md)) {
+ mapMethodDescToParamNodeFlowsToReturnValue.put(md, new HashSet<FlowNode>());
+ }
+ mapMethodDescToParamNodeFlowsToReturnValue.get(md).add(fn);
+ }
+
+ private Set<FlowNode> getParamNodeFlowingToReturnValue(MethodDescriptor md) {
+ return mapMethodDescToParamNodeFlowsToReturnValue.get(md);
+ }
+
private void analyzeFlowMethodInvokeNode(MethodDescriptor md, SymbolTable nametable,
- MethodInvokeNode min, NodeTupleSet implicitFlowTupleSet) {
+ MethodInvokeNode min, NodeTupleSet nodeSet, NodeTupleSet implicitFlowTupleSet) {
- addMapCallerMethodDescToMethodInvokeNodeSet(md, min);
+ if (nodeSet == null) {
+ nodeSet = new NodeTupleSet();
+ }
- MethodDescriptor calleeMD = min.getMethod();
+ MethodDescriptor calleeMethodDesc = min.getMethod();
NameDescriptor baseName = min.getBaseName();
boolean isSystemout = false;
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<FlowNode> calleeReturnSet = calleeFlowGraph.getReturnNodeSet();
+
+ System.out.println("#calleeReturnSet=" + calleeReturnSet);
- // CompositeLocation baseLocation = null;
if (min.getExpression() != null) {
NodeTupleSet baseNodeSet = new NodeTupleSet();
- System.out.println("Analyzing base of method=" + min.getExpression());
- analyzeFlowExpressionNode(calleeMD, nametable, min.getExpression(), baseNodeSet, null,
+ analyzeFlowExpressionNode(md, nametable, min.getExpression(), baseNodeSet, null,
implicitFlowTupleSet, false);
- } else {
+ assert (baseNodeSet.size() == 1);
+ mapMethodInvokeNodeToBaseTuple.put(min, baseNodeSet.iterator().next());
+
+ if (!min.getMethod().isStatic()) {
+ addArgIdxMap(min, 0, baseNodeSet);
+
+ for (Iterator iterator = calleeReturnSet.iterator(); iterator.hasNext();) {
+ FlowNode returnNode = (FlowNode) iterator.next();
+ NTuple<Descriptor> returnDescTuple = returnNode.getDescTuple();
+ if (returnDescTuple.startsWith(calleeMethodDesc.getThis())) {
+ // the location type of the return value is started with 'this'
+ // reference
+ for (Iterator<NTuple<Descriptor>> baseIter = baseNodeSet.iterator(); baseIter
+ .hasNext();) {
+ NTuple<Descriptor> baseTuple = baseIter.next();
+ NTuple<Descriptor> inFlowTuple = new NTuple<Descriptor>(baseTuple.getList());
+ inFlowTuple.addAll(returnDescTuple.subList(1, returnDescTuple.size()));
+ nodeSet.addTuple(inFlowTuple);
+ }
+ } else {
+ Set<FlowNode> inFlowSet = calleeFlowGraph.getIncomingFlowNodeSet(returnNode);
+ for (Iterator iterator2 = inFlowSet.iterator(); iterator2.hasNext();) {
+ FlowNode inFlowNode = (FlowNode) iterator2.next();
+ if (inFlowNode.getDescTuple().startsWith(calleeMethodDesc.getThis())) {
+ nodeSet.addTupleSet(baseNodeSet);
+ }
+ }
+ }
+ }
+ }
+
+ }
+
+ // 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.
+ addArgIdxMap(min, idx, argTupleSet);
+ FlowNode paramNode = calleeFlowGraph.getParamFlowNode(idx);
+ if (hasInFlowTo(calleeFlowGraph, paramNode, calleeReturnSet)
+ || calleeMethodDesc.getModifiers().isNative()) {
+ addParamNodeFlowingToReturnValue(calleeMethodDesc, paramNode);
+ nodeSet.addTupleSet(argTupleSet);
+ }
+ }
- // checkCalleeConstraints(md, nametable, min, baseLocation, constraint);
+ }
- // checkCallerArgumentLocationConstraints(md, nametable, min,
- // baseLocation, constraint);
+ // propagateFlowsFromCallee(min, md, min.getMethod());
- if (!min.getMethod().getReturnType().isVoid()) {
- // If method has a return value, compute the highest possible return
- // location in the caller's perspective
- // CompositeLocation ceilingLoc =
- // computeCeilingLocationForCaller(md, nametable, min, baseLocation,
- // constraint);
- // return ceilingLoc;
- }
}
- // return new CompositeLocation(Location.createTopLocation(md));
+ }
+ private boolean hasInFlowTo(FlowGraph fg, FlowNode inNode, Set<FlowNode> nodeSet) {
+ // return true if inNode has in-flows to nodeSet
+ Set<FlowNode> reachableSet = fg.getReachFlowNodeSetFrom(inNode);
+ for (Iterator iterator = reachableSet.iterator(); iterator.hasNext();) {
+ FlowNode fn = (FlowNode) iterator.next();
+ if (nodeSet.contains(fn)) {
+ return true;
+ }
+ }
+ return false;
}
- private NTuple<Descriptor> getArgTupleByArgIdx(MethodInvokeNode min, int idx) {
+ private NodeTupleSet getNodeTupleSetByArgIdx(MethodInvokeNode min, int idx) {
return mapMethodInvokeNodeToArgIdxMap.get(min).get(new Integer(idx));
}
- private void addArgIdxMap(MethodInvokeNode min, int idx, NTuple<Descriptor> argTuple) {
- Map<Integer, NTuple<Descriptor>> mapIdxToArgTuple = mapMethodInvokeNodeToArgIdxMap.get(min);
- if (mapIdxToArgTuple == null) {
- mapIdxToArgTuple = new HashMap<Integer, NTuple<Descriptor>>();
- mapMethodInvokeNodeToArgIdxMap.put(min, mapIdxToArgTuple);
+ private void addArgIdxMap(MethodInvokeNode min, int idx, NodeTupleSet tupleSet) {
+ Map<Integer, NodeTupleSet> mapIdxToTupleSet = mapMethodInvokeNodeToArgIdxMap.get(min);
+ if (mapIdxToTupleSet == null) {
+ mapIdxToTupleSet = new HashMap<Integer, NodeTupleSet>();
+ mapMethodInvokeNodeToArgIdxMap.put(min, mapIdxToTupleSet);
}
- mapIdxToArgTuple.put(new Integer(idx), argTuple);
+ mapIdxToTupleSet.put(new Integer(idx), tupleSet);
}
private void analyzeFlowMethodParameters(MethodDescriptor callermd, SymbolTable nametable,
- MethodInvokeNode min) {
+ MethodInvokeNode min, NodeTupleSet nodeSet) {
if (min.numArgs() > 0) {
- int offset = min.getMethod().isStatic() ? 0 : 1;
+ int offset;
+ if (min.getMethod().isStatic()) {
+ offset = 0;
+ } else {
+ offset = 1;
+ // NTuple<Descriptor> thisArgTuple = new NTuple<Descriptor>();
+ // thisArgTuple.add(callermd.getThis());
+ // NodeTupleSet argTupleSet = new NodeTupleSet();
+ // argTupleSet.addTuple(thisArgTuple);
+ // addArgIdxMap(min, 0, argTupleSet);
+ // nodeSet.addTuple(thisArgTuple);
+ }
for (int i = 0; i < min.numArgs(); i++) {
ExpressionNode en = min.getArg(i);
- NTuple<Descriptor> argTuple =
- analyzeFlowExpressionNode(callermd, nametable, en, new NodeTupleSet(), false);
-
- addArgIdxMap(min, i + offset, argTuple);
+ 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);
+ nodeSet.addTupleSet(argTupleSet);
}
}
}
private void analyzeLiteralNode(MethodDescriptor md, SymbolTable nametable, LiteralNode en) {
- // TODO Auto-generated method stub
}
ArrayAccessNode aan, NodeTupleSet nodeSet, boolean isLHS) {
NodeTupleSet expNodeTupleSet = new NodeTupleSet();
- analyzeFlowExpressionNode(md, nametable, aan.getExpression(), expNodeTupleSet, isLHS);
+ NTuple<Descriptor> 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<NTuple<Descriptor>> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) {
NTuple<Descriptor> idxTuple = idxIter.next();
for (Iterator<NTuple<Descriptor>> arrIter = expNodeTupleSet.iterator(); arrIter.hasNext();) {
nodeSet.addTupleSet(expNodeTupleSet);
nodeSet.addTupleSet(idxNodeTupleSet);
}
-
}
private void analyzeCreateObjectNode(MethodDescriptor md, SymbolTable nametable,
NodeTupleSet rightOpSet = new NodeTupleSet();
// left operand
- System.out.println("Analyzing left op=" + on.getLeft().printNode(0) + "::"
- + on.getLeft().getClass());
analyzeFlowExpressionNode(md, nametable, on.getLeft(), leftOpSet, null, implicitFlowTupleSet,
false);
- System.out.println("leftOpSet=" + leftOpSet);
if (on.getRight() != null) {
// right operand
analyzeFlowExpressionNode(md, nametable, on.getRight(), rightOpSet, null,
implicitFlowTupleSet, false);
- System.out.println("rightOpSet=" + rightOpSet);
}
Operation op = on.getOp();
default:
throw new Error(op.toString());
}
+
}
private NTuple<Descriptor> analyzeFlowNameNode(MethodDescriptor md, SymbolTable nametable,
NameNode nn, NodeTupleSet nodeSet, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
+ // System.out.println("analyzeFlowNameNode=" + nn.printNode(0));
+
if (base == null) {
base = new NTuple<Descriptor>();
}
NameDescriptor nd = nn.getName();
if (nd.getBase() != null) {
- analyzeFlowExpressionNode(md, nametable, nn.getExpression(), nodeSet, base,
- implicitFlowTupleSet, false);
+ base =
+ analyzeFlowExpressionNode(md, nametable, nn.getExpression(), nodeSet, base,
+ implicitFlowTupleSet, false);
+ if (base == null) {
+ // base node has the top location
+ return base;
+ }
} else {
String varname = nd.toString();
if (varname.equals("this")) {
FieldDescriptor fd = (FieldDescriptor) d;
if (fd.isStatic()) {
if (fd.isFinal()) {
- // if it is 'static final', the location has TOP since no one can
- // change its value
- // loc.addLocation(Location.createTopLocation(md));
- // return loc;
+ // if it is 'static final', no need to have flow node for the TOP
+ // location
+ return null;
} else {
- // if 'static', the location has pre-assigned global loc
- // MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
- // String globalLocId = localLattice.getGlobalLoc();
- // if (globalLocId == null) {
- // throw new
- // Error("Global location element is not defined in the method " +
- // md);
- // }
- // Location globalLoc = new Location(md, globalLocId);
- //
- // loc.addLocation(globalLoc);
+ // if 'static', assign the default GLOBAL LOCATION to the first
+ // element of the tuple
+ base.add(GLOBALDESC);
}
} else {
// the location of field access starts from this, followed by field
base.add(fd);
} else if (d == null) {
// access static field
+ base.add(GLOBALDESC);
+ base.add(nn.getField());
+ return base;
+
// FieldDescriptor fd = nn.getField();addFlowGraphEdge
//
// MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
}
}
-
getFlowGraph(md).createNewFlowNode(base);
return base;
private NTuple<Descriptor> analyzeFlowFieldAccessNode(MethodDescriptor md, SymbolTable nametable,
FieldAccessNode fan, NodeTupleSet nodeSet, NTuple<Descriptor> base,
- NodeTupleSet implicitFlowTupleSet) {
+ NodeTupleSet implicitFlowTupleSet, boolean isLHS) {
ExpressionNode left = fan.getExpression();
TypeDescriptor ltd = left.getType();
if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
// using a class name directly or access using this
if (fd.isStatic() && fd.isFinal()) {
- // loc.addLocation(Location.createTopLocation(md));
- // return loc;
+ return null;
}
}
- // if (left instanceof ArrayAccessNode) {
- // ArrayAccessNode aan = (ArrayAccessNode) left;
- // left = aan.getExpression();
- // }
- // fanNodeSet
+ NodeTupleSet idxNodeTupleSet = new NodeTupleSet();
+
+ if (left instanceof ArrayAccessNode) {
+
+ ArrayAccessNode aan = (ArrayAccessNode) left;
+ left = aan.getExpression();
+ analyzeFlowExpressionNode(md, nametable, aan.getIndex(), idxNodeTupleSet, base,
+ implicitFlowTupleSet, isLHS);
+
+ nodeSet.addTupleSet(idxNodeTupleSet);
+ }
base =
- analyzeFlowExpressionNode(md, nametable, left, nodeSet, base, implicitFlowTupleSet, false);
+ analyzeFlowExpressionNode(md, nametable, left, nodeSet, base, implicitFlowTupleSet, isLHS);
- if (!left.getType().isPrimitive()) {
+ if (base == null) {
+ // in this case, field is TOP location
+ return null;
+ } else {
+
+ NTuple<Descriptor> flowFieldTuple = new NTuple<Descriptor>(base.toList());
+
+ if (!left.getType().isPrimitive()) {
+
+ if (!fd.getSymbol().equals("length")) {
+ // array.length access, just have the location of the array
+ flowFieldTuple.add(fd);
+ nodeSet.removeTuple(base);
+ }
- if (fd.getSymbol().equals("length")) {
- // TODO
- // array.length access, return the location of the array
- // return loc;
}
+ getFlowGraph(md).createNewFlowNode(flowFieldTuple);
+
+ if (isLHS) {
+ for (Iterator<NTuple<Descriptor>> idxIter = idxNodeTupleSet.iterator(); idxIter.hasNext();) {
+ NTuple<Descriptor> idxTuple = idxIter.next();
+ getFlowGraph(md).addValueFlowEdge(idxTuple, flowFieldTuple);
+ }
+ }
+ return flowFieldTuple;
- base.add(fd);
}
- return base;
+ }
+
+ private void debug_printTreeNode(TreeNode tn) {
+
+ System.out.println("DEBUG: " + tn.printNode(0) + " line#=" + tn.getNumLine());
}
private void analyzeFlowAssignmentNode(MethodDescriptor md, SymbolTable nametable,
- AssignmentNode an, NTuple<Descriptor> base, NodeTupleSet implicitFlowTupleSet) {
-
- System.out.println("analyzeFlowAssignmentNode=" + an);
+ AssignmentNode an, NodeTupleSet nodeSet, NTuple<Descriptor> base,
+ NodeTupleSet implicitFlowTupleSet) {
NodeTupleSet nodeSetRHS = new NodeTupleSet();
NodeTupleSet nodeSetLHS = new NodeTupleSet();
.getBaseOp().getOp() != Operation.POSTDEC)) {
postinc = false;
}
-
// if LHS is array access node, need to capture value flows between an array
// and its index value
analyzeFlowExpressionNode(md, nametable, an.getDest(), nodeSetLHS, null, implicitFlowTupleSet,
true);
- System.out.println("ASSIGNMENT NODE nodeSetLHS=" + nodeSetLHS);
if (!postinc) {
// analyze value flows of rhs expression
analyzeFlowExpressionNode(md, nametable, an.getSrc(), nodeSetRHS, null, implicitFlowTupleSet,
false);
- System.out.println("ASSIGNMENT NODE nodeSetRHS=" + nodeSetRHS);
+
+ // System.out.println("-analyzeFlowAssignmentNode=" + an.printNode(0));
+ // System.out.println("-nodeSetLHS=" + nodeSetLHS);
+ // System.out.println("-nodeSetRHS=" + nodeSetRHS);
+ // System.out.println("-implicitFlowTupleSet=" + implicitFlowTupleSet);
+ // System.out.println("-");
+
+ if (an.getOperation().getOp() >= 2 && an.getOperation().getOp() <= 12) {
+ // if assignment contains OP+EQ operator, creates edges from LHS to LHS
+
+ for (Iterator<NTuple<Descriptor>> iter = nodeSetLHS.iterator(); iter.hasNext();) {
+ NTuple<Descriptor> fromTuple = iter.next();
+ for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
+ NTuple<Descriptor> toTuple = iter2.next();
+ addFlowGraphEdge(md, fromTuple, toTuple);
+ }
+ }
+ }
// creates edges from RHS to LHS
+ NTuple<Descriptor> interTuple = null;
+ if (nodeSetRHS.size() > 1) {
+ interTuple = getFlowGraph(md).createIntermediateNode().getDescTuple();
+ }
+
for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
NTuple<Descriptor> fromTuple = iter.next();
for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
NTuple<Descriptor> toTuple = iter2.next();
- addFlowGraphEdge(md, fromTuple, toTuple);
+ addFlowGraphEdge(md, fromTuple, interTuple, toTuple);
}
}
} else {
// postinc case
+
for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
NTuple<Descriptor> tuple = iter2.next();
addFlowGraphEdge(md, tuple, tuple);
}
+ // creates edges from implicitFlowTupleSet to LHS
+ for (Iterator<NTuple<Descriptor>> iter = implicitFlowTupleSet.iterator(); iter.hasNext();) {
+ NTuple<Descriptor> fromTuple = iter.next();
+ for (Iterator<NTuple<Descriptor>> iter2 = nodeSetLHS.iterator(); iter2.hasNext();) {
+ NTuple<Descriptor> toTuple = iter2.next();
+ addFlowGraphEdge(md, fromTuple, toTuple);
+ }
+ }
+
}
+ if (nodeSet != null) {
+ nodeSet.addTupleSet(nodeSetLHS);
+ }
}
public FlowGraph getFlowGraph(MethodDescriptor md) {
return mapMethodDescriptorToFlowGraph.get(md);
}
- public void addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from, NTuple<Descriptor> to) {
+ private boolean addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from,
+ NTuple<Descriptor> to) {
FlowGraph graph = getFlowGraph(md);
graph.addValueFlowEdge(from, to);
+ return true;
+ }
+
+ private void addFlowGraphEdge(MethodDescriptor md, NTuple<Descriptor> from,
+ NTuple<Descriptor> inter, NTuple<Descriptor> 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<String> locOrder, String nameSuffix) {
+ writeInferredLatticeDotFile(cd, null, simpleHierarchyGraph, locOrder, nameSuffix);
+ }
+
+ public void writeInferredLatticeDotFile(ClassDescriptor cd, MethodDescriptor md,
+ HierarchyGraph simpleHierarchyGraph, SSJavaLattice<String> 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<Pair<String, String>> pairSet = locOrder.getOrderingPairSet();
+
+ Set<String> addedLocSet = new HashSet<String>();
+
+ 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 <higher, lower>
+ Pair<String, String> pair = (Pair<String, String>) 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<HNode> 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<String> 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<HNode> mergeSet = graph.getMapHNodetoMergeSet().get(node);
+ prettyStr += ":" + convertMergeSetToString(graph, mergeSet);
+ }
+ bw.write(locName + " [label=\"" + prettyStr + "\"]" + ";\n");
}
public void _debug_printGraph() {
}
-class ParamIndexRelation {
- private Integer higherIdx;
- private Integer lowerIdx;
+class CyclicFlowException extends Exception {
+
+}
+
+class InterDescriptor extends Descriptor {
+
+ public InterDescriptor(String name) {
+ super(name);
+ }
+
}
projects / IRC.git / blobdiff