import java.io.IOException;
import java.util.ArrayList;
+import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Set;
import java.util.Stack;
-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.SubBlockNode;
import IR.Tree.SwitchStatementNode;
import IR.Tree.TertiaryNode;
+import IR.Tree.TreeNode;
public class LocationInference {
// 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 descriptor to a lattice mapping
- private Map<MethodDescriptor, Map<FieldDescriptor, String>> cd2LatticeMapping;
-
- // 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 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<MethodDescriptor, MethodLocationInfo> mapMethodDescToMethodLocationInfo;
+
+ private Map<ClassDescriptor, LocationInfo> mapClassToLocationInfo;
+
+ private Map<MethodDescriptor, Set<MethodDescriptor>> mapMethodToCalleeSet;
+
+ public static final String GLOBALLOC = "GLOBALLOC";
+
+ public static final String TOPLOC = "TOPLOC";
+
+ public static final Descriptor GLOBALDESC = new NameDescriptor(GLOBALLOC);
+
+ public static final Descriptor TOPDESC = new NameDescriptor(TOPLOC);
boolean debug = true;
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>();
}
public void setupToAnalyze() {
// 2) construct lattices
inferLattices();
+ simplifyLattices();
+
debug_writeLatticeDotFile();
+ // 3) check properties
+ checkLattices();
+
+ }
+
+ private void simplifyLattices() {
+
+ // generate lattice dot file
+ setupToAnalyze();
+
+ while (!toAnalyzeIsEmpty()) {
+ ClassDescriptor cd = toAnalyzeNext();
+
+ setupToAnalazeMethod(cd);
+
+ SSJavaLattice<String> classLattice = cd2lattice.get(cd);
+ if (classLattice != null) {
+ classLattice.removeRedundantEdges();
+ }
+
+ while (!toAnalyzeMethodIsEmpty()) {
+ MethodDescriptor md = toAnalyzeMethodNext();
+ if (ssjava.needTobeAnnotated(md)) {
+ SSJavaLattice<String> methodLattice = md2lattice.get(md);
+ if (methodLattice != null) {
+ methodLattice.removeRedundantEdges();
+ }
+ }
+ }
+ }
+
+ }
+
+ 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() {
SSJavaLattice<String> classLattice = cd2lattice.get(cd);
if (classLattice != null) {
- ssjava.writeLatticeDotFile(cd, classLattice);
+ ssjava.writeLatticeDotFile(cd, null, classLattice);
+ debug_printDescriptorToLocNameMapping(cd);
}
while (!toAnalyzeMethodIsEmpty()) {
if (ssjava.needTobeAnnotated(md)) {
SSJavaLattice<String> methodLattice = md2lattice.get(md);
if (methodLattice != null) {
- ssjava.writeLatticeDotFile(cd, methodLattice);
+ 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
- // perform method READ/OVERWRITE analysis
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
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);
+ new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
+ MethodLocationInfo methodInfo = new MethodLocationInfo(md);
+
+ System.out.println();
System.out.println("SSJAVA: Inferencing the lattice from " + md);
- analyzeMethodLattice(md, methodLattice);
+ 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);
- SSJavaLattice<String> prevMethodLattice = md2lattice.get(md);
+ if ((!methodLattice.equals(prevMethodLattice)) || (!methodInfo.equals(prevMethodInfo))) {
- if (!methodLattice.equals(prevMethodLattice)) {
- md2lattice.put(md, methodLattice);
+ setMethodLattice(md, methodLattice);
+ setMethodLocInfo(md, methodInfo);
// results for callee changed, so enqueue dependents caller for
// further analysis
}
}
+ }
+
+ 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 =
+ new CompositeLocation(new Location(md1, locInfo1.getReturnLocName()));
+ CompositeLocation rtrLoc2 =
+ new CompositeLocation(new Location(md2, locInfo2.getReturnLocName()));
+ 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 + ").");
+ }
+ }
+ }
+ }
}
return desc.getSymbol();
}
- private void addMappingDescriptorToLocationIdentifer(MethodDescriptor methodDesc,
- VarDescriptor varDesc, String identifier) {
- if (!md2LatticeMapping.containsKey(methodDesc)) {
- md2LatticeMapping.put(methodDesc, new HashMap<VarDescriptor, String>());
- }
-
+ private Descriptor getDescriptor(int idx, FlowNode node) {
+ Descriptor desc = node.getDescTuple().get(idx);
+ return desc;
}
- private void analyzeMethodLattice(MethodDescriptor md, SSJavaLattice<String> methodLattice) {
+ private void analyzeMethodLattice(MethodDescriptor md, SSJavaLattice<String> methodLattice,
+ MethodLocationInfo methodInfo) throws CyclicFlowException {
- // visit each node of method flow graph
+ // 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);
+
+ // 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();
- // first, take a look at directly connected nodes
Set<FlowEdge> outEdgeSet = srcNode.getOutEdgeSet();
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();
+
+ if (outEdge.getInitTuple().equals(srcNodeTuple)
+ && outEdge.getEndTuple().equals(dstNodeTuple)) {
+
+ if ((srcNodeTuple.size() > 1 && dstNodeTuple.size() > 1)
+ && srcNodeTuple.get(0).equals(dstNodeTuple.get(0))) {
- // second, take a look at all nodes that are reachable from the source
- // node
- recursiveVisitNodes(md, srcNode, dstNode);
+ // value flows between fields
+ VarDescriptor varDesc = (VarDescriptor) srcNodeTuple.get(0);
+ ClassDescriptor varClassDesc = varDesc.getType().getClassDesc();
+ extractRelationFromFieldFlows(varClassDesc, srcNode, dstNode, 1);
+ } else if (srcNodeTuple.size() == 1 || dstNodeTuple.size() == 1) {
+ // for the method lattice, we need to look at the first element of
+ // NTuple<Descriptor>
+ // in this case, take a look at connected nodes at the local level
+ addRelationToLattice(md, methodLattice, methodInfo, srcNode, dstNode);
+ } else {
+
+ if (!srcNode.getDescTuple().get(0).equals(dstNode.getDescTuple().get(0))) {
+ // in this case, take a look at connected nodes at the local level
+ addRelationToLattice(md, methodLattice, methodInfo, srcNode, dstNode);
+ } else {
+ Descriptor srcDesc = srcNode.getDescTuple().get(0);
+ Descriptor dstDesc = dstNode.getDescTuple().get(0);
+ recursivelyAddCompositeRelation(md, fg, methodInfo, srcNode, dstNode, srcDesc,
+ dstDesc);
+ // recursiveAddRelationToLattice(1, md, srcNode, dstNode);
+ }
+ }
+
+ }
+ }
+ }
+
+ // 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);
+ }
+
+ // calculate the initial program counter location
+ // PC location is higher than location types of all parameters
+ String pcLocSymbol = "PCLOC";
+ Map<Integer, CompositeLocation> mapParamToLoc = methodInfo.getMapParamIdxToInferLoc();
+ Set<Integer> keySet = mapParamToLoc.keySet();
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Integer paramIdx = (Integer) iterator.next();
+ CompositeLocation inferLoc = mapParamToLoc.get(paramIdx);
+ String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier();
+ if (!methodLattice.isGreaterThan(pcLocSymbol, paramLocLocalSymbol)) {
+ addRelationHigherToLower(methodLattice, methodInfo, pcLocSymbol, paramLocLocalSymbol);
}
+ }
+
+ // calculate a return location
+ // the return location type is lower than all parameters
+ if (!md.getReturnType().isVoid()) {
+ String returnLocSymbol = "RETURNLOC";
+
+ for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
+ Integer paramIdx = (Integer) iterator.next();
+ CompositeLocation inferLoc = mapParamToLoc.get(paramIdx);
+ String paramLocLocalSymbol = inferLoc.get(0).getLocIdentifier();
+ if (!methodLattice.isGreaterThan(paramLocLocalSymbol, returnLocSymbol)) {
+ addRelationHigherToLower(methodLattice, methodInfo, paramLocLocalSymbol, returnLocSymbol);
+ }
+ }
}
}
- 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
+ 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 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 =
+ calcualteInferredCompositeLocation(methodInfo, tuple1);
+ CompositeLocation inferLoc2 =
+ calcualteInferredCompositeLocation(methodInfo, tuple2);
+
+ addRelation(methodLattice, methodInfo, inferLoc1, inferLoc2);
+
+ }
+
+ }
+
+ }
+ }
+ }
+ }
+
+ }
+
+ private CompositeLocation calcualteInferredCompositeLocation(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());
+ 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();
+
+ String fieldLocSymbol =
+ getLocationInfo(enclosingDesc).getInferLocation(curDesc).get(0).getLocIdentifier();
+ Location inferLocElement = new Location(enclosingDesc, fieldLocSymbol);
+
+ inferLoc.addLocation(inferLocElement);
+
+ }
+
+ return inferLoc;
+ }
+
+ private void addRelation(SSJavaLattice<String> methodLattice, MethodLocationInfo methodInfo,
+ CompositeLocation srcInferLoc, CompositeLocation dstInferLoc) throws CyclicFlowException {
+
+ 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);
+ }
+ }
+
+ }
+
+ private 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);
+
+ }
- VarDescriptor varDesc = (VarDescriptor) srcNode.getDescTuple().get(0);
- ClassDescriptor varClassDesc = varDesc.getType().getClassDesc();
+ private LocationInfo getFieldLocationInfo(ClassDescriptor cd) {
- extractRelationFromFieldFlows(varClassDesc, srcNode, dstNode, 1);
- return;
+ 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);
+
+ calculateCompositeLocation(flowGraph, methodLattice, methodInfo, srcNode);
+
+ CompositeLocation srcInferLoc =
+ calcualteInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(srcNode));
+ CompositeLocation dstInferLoc =
+ calcualteInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(dstNode));
+
+ try {
+ addRelation(methodLattice, methodInfo, srcInferLoc, dstInferLoc);
+ } catch (CyclicFlowException e) {
+ // there is a cyclic value flow... try to calculate a composite location
+ // for the destination node
+ calculateCompositeLocation(flowGraph, methodLattice, methodInfo, dstNode);
+ dstInferLoc =
+ calcualteInferredCompositeLocation(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 srcSymbol = getSymbol(0, srcNode);
- String dstSymbol = getSymbol(0, dstNode);
+ String srcLocSymbol = srcInferLoc.get(idx).getLocIdentifier();
+ String dstLocSymbol = dstInferLoc.get(idx).getLocIdentifier();
- methodLattice.addRelationHigherToLower(srcSymbol, dstSymbol);
+ Descriptor parentDesc = srcInferLoc.get(idx).getDescriptor();
- if (srcNode.isParameter() && dstNode.isParameter()) {
- propagateRelationToCaller(md, srcNode, dstNode);
+ if (srcLocSymbol.equals(dstLocSymbol)) {
+ // check if it is the case of shared location
+ if (srcInferLoc.getSize() == (idx + 1) && dstInferLoc.getSize() == (idx + 1)) {
+ Location inferLocElement = srcInferLoc.get(idx);
+ getLattice(inferLocElement.getDescriptor())
+ .addSharedLoc(inferLocElement.getLocIdentifier());
+ } else if (srcInferLoc.getSize() > (idx + 1) && dstInferLoc.getSize() > (idx + 1)) {
+ recursivelyAddRelation(idx + 1, srcInferLoc, dstInferLoc);
+ }
+ } else {
+ addRelationHigherToLower(getLattice(parentDesc), getLocationInfo(parentDesc), srcLocSymbol,
+ dstLocSymbol);
}
}
- private SSJavaLattice<String> getMethodLattice(MethodDescriptor md) {
+ private void recursivelyAddCompositeRelation(MethodDescriptor md, FlowGraph flowGraph,
+ MethodLocationInfo methodInfo, FlowNode srcNode, FlowNode dstNode, Descriptor srcDesc,
+ Descriptor dstDesc) throws CyclicFlowException {
- if (!md2lattice.containsKey(md)) {
- md2lattice.put(md, new SSJavaLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM));
+ 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);
}
- return md2lattice.get(md);
+
+ 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 void propagateRelationToCaller(MethodDescriptor calleeMethodDesc, FlowNode srcNode,
- FlowNode newVisitNode) {
+ private boolean calculateCompositeLocation(FlowGraph flowGraph,
+ SSJavaLattice<String> methodLattice, MethodLocationInfo methodInfo, FlowNode flowNode)
+ throws CyclicFlowException {
- FlowGraph calleeFlowGraph = getFlowGraph(calleeMethodDesc);
+ Descriptor localVarDesc = flowNode.getDescTuple().get(0);
- int higherLocIdxCallee = calleeFlowGraph.getParamIdx(srcNode.getDescTuple());
- int lowerLocIdxCallee = calleeFlowGraph.getParamIdx(newVisitNode.getDescTuple());
+ Set<FlowNode> inNodeSet = flowGraph.getIncomingFlowNodeSet(flowNode);
+ Set<FlowNode> reachableNodeSet = flowGraph.getReachableFlowNodeSet(flowNode);
- System.out.println(" ssjava.getDependents(md)=" + ssjava.getDependents(calleeMethodDesc));
- Iterator<MethodDescriptor> depsItr = ssjava.getDependents(calleeMethodDesc).iterator();
- while (depsItr.hasNext()) {
- MethodDescriptor callerMethodDesc = depsItr.next();
+ Map<NTuple<Location>, Set<NTuple<Location>>> mapPrefixToIncomingLocTupleSet =
+ new HashMap<NTuple<Location>, Set<NTuple<Location>>>();
- SSJavaLattice<String> callerMethodLattice = md2lattice.get(callerMethodDesc);
+ Set<FlowNode> localInNodeSet = new HashSet<FlowNode>();
+ Set<FlowNode> localOutNodeSet = new HashSet<FlowNode>();
- 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
+ CompositeLocation flowNodeInferLoc =
+ calcualteInferredCompositeLocation(methodInfo, flowGraph.getLocationTuple(flowNode));
+
+ List<NTuple<Location>> prefixList = new ArrayList<NTuple<Location>>();
+
+ for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode inNode = (FlowNode) iterator.next();
+ NTuple<Location> inTuple = flowGraph.getLocationTuple(inNode);
+
+ if (inTuple.size() > 1) {
+ for (int i = 1; i < inTuple.size(); i++) {
+ NTuple<Location> prefix = inTuple.subList(0, i);
+ if (!prefixList.contains(prefix)) {
+ prefixList.add(prefix);
+ }
+ addPrefixMapping(mapPrefixToIncomingLocTupleSet, prefix, inTuple);
+ }
+ } else {
+ localInNodeSet.add(inNode);
+ }
+ }
+
+ 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;
+ }
+ }
+ });
+
+ for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
+ FlowNode reachableNode = (FlowNode) iterator2.next();
+ if (reachableNode.getDescTuple().size() == 1) {
+ localOutNodeSet.add(reachableNode);
+ }
+ }
+
+ // 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>>();
- System.out.println("higherLocIdxCallee=" + higherLocIdxCallee);
- System.out.println("lowerLocIdxCallee=" + lowerLocIdxCallee);
+ for (Iterator iterator2 = reachableNodeSet.iterator(); iterator2.hasNext();) {
+ FlowNode reachableNode = (FlowNode) iterator2.next();
+ NTuple<Location> reachLocTuple = flowGraph.getLocationTuple(reachableNode);
+ if (reachLocTuple.startsWith(curPrefix)) {
+ reachableCommonPrefixSet.add(reachLocTuple);
+ }
+ }
+
+ // check if the lattice has the relation in which higher prefix is
+ // actually lower than the current node
+ CompositeLocation prefixInferLoc = calcualteInferredCompositeLocation(methodInfo, curPrefix);
+ if (isGreaterThan(methodLattice, flowNodeInferLoc, prefixInferLoc)) {
+ reachableCommonPrefixSet.add(curPrefix);
+ }
+
+ if (!reachableCommonPrefixSet.isEmpty()) {
+ // found reachable nodes that start with the prefix curPrefix
+ // need to assign a composite location
+
+ // first, check if there are more than one the set of locations that has
+ // the same length of the longest reachable prefix, no way to assign
+ // a composite location to the input local var
+ prefixSanityCheck(prefixList, i, flowGraph, reachableNodeSet);
+
+ 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 =
+ // methodInfo.getInferLocation(flowNode);
+ CompositeLocation inferLocation = methodInfo.getInferLocation(localVarDesc);
+
+ String newlyInsertedLocName;
+ if (inferLocation.getSize() == 1) {
+ // need to replace the old local location with a new composite
+ // location
+
+ String oldMethodLocationSymbol = inferLocation.get(0).getLocIdentifier();
+
+ String newLocSymbol = "Loc" + (SSJavaLattice.seed++);
+ inferLocation = new CompositeLocation();
+ for (int locIdx = 0; locIdx < curPrefix.size(); locIdx++) {
+ inferLocation.addLocation(curPrefix.get(locIdx));
+ }
+ Location fieldLoc = new Location(desc, newLocSymbol);
+ inferLocation.addLocation(fieldLoc);
+
+ methodInfo.mapDescriptorToLocation(localVarDesc, inferLocation);
+ methodInfo.removeMaplocalVarToLocSet(localVarDesc);
+
+ String newMethodLocationSymbol = curPrefix.get(0).getLocIdentifier();
+
+ replaceOldLocWithNewLoc(methodLattice, oldMethodLocationSymbol, newMethodLocationSymbol);
+
+ } else {
+
+ String localLocName = methodInfo.getInferLocation(localVarDesc).get(0).getLocIdentifier();
+ return true;
- NTuple<Descriptor> higherArg = getArgTupleByArgIdx(methodInvokeNode, higherLocIdxCallee);
- NTuple<Descriptor> lowerArg = getArgTupleByArgIdx(methodInvokeNode, lowerLocIdxCallee);
+ }
- FlowNode callerHigherFlowNode = getFlowGraph(callerMethodDesc).getFlowNode(higherArg);
- FlowNode calleeHigherFlowNode = getFlowGraph(callerMethodDesc).getFlowNode(lowerArg);
+ newlyInsertedLocName = inferLocation.get(inferLocation.getSize() - 1).getLocIdentifier();
- addRelationToLattice(callerMethodDesc, getMethodLattice(callerMethodDesc),
- callerHigherFlowNode, calleeHigherFlowNode);
+ for (Iterator iterator = incomingCommonPrefixSet.iterator(); iterator.hasNext();) {
+ NTuple<Location> tuple = (NTuple<Location>) iterator.next();
+ Location loc = tuple.get(idx);
+ String higher = locInfo.getFieldInferLocation(loc.getLocDescriptor()).getLocIdentifier();
+ System.out.println("--");
+ System.out.println("add in-flow relation:");
+ addRelationHigherToLower(lattice, locInfo, higher, newlyInsertedLocName);
}
+ System.out.println("end of add-inflow relation");
+
+ for (Iterator iterator = localInNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode localNode = (FlowNode) iterator.next();
+
+ if (localNode.equals(flowNode)) {
+ continue;
+ }
+
+ Descriptor localInVarDesc = localNode.getDescTuple().get(0);
+ CompositeLocation inNodeInferLoc = methodInfo.getInferLocation(localInVarDesc);
+
+ if (isCompositeLocation(inNodeInferLoc)) {
+ // need to make sure that newLocSymbol is lower than the infernode
+ // location in the field lattice
+
+ if (inNodeInferLoc.getTuple().startsWith(curPrefix)
+ && inNodeInferLoc.getSize() == (curPrefix.size() + 1)) {
+ String higher = inNodeInferLoc.get(inNodeInferLoc.getSize() - 1).getLocIdentifier();
+ if (!higher.equals(newlyInsertedLocName)) {
+ System.out.println("add localInNodeSet relation:");
+ addRelationHigherToLower(lattice, locInfo, higher, newlyInsertedLocName);
+ }
+ } else {
+ throw new Error("Failed to generate a composite location.");
+ }
+
+ }
+
+ }
+
+ 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 = locInfo.getFieldInferLocation(loc.getLocDescriptor()).getLocIdentifier();
+ // lattice.addRelationHigherToLower(newlyInsertedLocName, lower);
+ System.out.println("add out-flow relation:");
+ addRelationHigherToLower(lattice, locInfo, newlyInsertedLocName, lower);
+ }
+ }
+ System.out.println("end of add out-flow relation");
+
+ for (Iterator iterator = localOutNodeSet.iterator(); iterator.hasNext();) {
+ FlowNode localOutNode = (FlowNode) iterator.next();
+
+ if (localOutNode.equals(flowNode)) {
+ continue;
+ }
+
+ Descriptor localOutDesc = localOutNode.getDescTuple().get(0);
+ CompositeLocation outNodeInferLoc = methodInfo.getInferLocation(localOutDesc);
+
+ if (isCompositeLocation(outNodeInferLoc)) {
+ // need to make sure that newLocSymbol is higher than the infernode
+ // location
+
+ if (outNodeInferLoc.getTuple().startsWith(curPrefix)
+ && outNodeInferLoc.getSize() == (curPrefix.size() + 1)) {
+
+ String lower = outNodeInferLoc.get(outNodeInferLoc.getSize() - 1).getLocIdentifier();
+ System.out.println("add outNodeInferLoc relation:");
+
+ addRelationHigherToLower(lattice, locInfo, newlyInsertedLocName, lower);
+
+ } else {
+ throw new Error("Failed to generate a composite location.");
+ }
+ }
+ }
+
+ return true;
}
}
+
+ return false;
+
}
- private void recursiveVisitNodes(MethodDescriptor md, FlowNode srcNode, FlowNode currentVisitNode) {
+ private boolean isCompositeLocation(CompositeLocation cl) {
+ return cl.getSize() > 1;
+ }
- NTuple<Descriptor> srcTuple = srcNode.getDescTuple();
+ private boolean containsNonPrimitiveElement(Set<Descriptor> descSet) {
+ for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
+ Descriptor desc = (Descriptor) iterator.next();
- for (Iterator<FlowEdge> outEdgeIter = currentVisitNode.getOutEdgeSet().iterator(); outEdgeIter
- .hasNext();) {
+ 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;
+ }
+ }
- FlowEdge outEdge = outEdgeIter.next();
- FlowNode newVisitNode = outEdge.getDst();
+ }
+ return false;
+ }
- NTuple<Descriptor> newVisitTuple = newVisitNode.getDescTuple();
+ private void addRelationHigherToLower(SSJavaLattice<String> lattice, LocationInfo locInfo,
+ String higher, String lower) throws CyclicFlowException {
- // 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);
+ // if (higher.equals(lower) && lattice.isSharedLoc(higher)) {
+ // return;
+ // }
+ Set<String> cycleElementSet = lattice.getPossibleCycleElements(higher, lower);
+ System.out.println("#Check cycle=" + lower + " < " + higher);
+ System.out.println("#cycleElementSet=" + cycleElementSet);
+
+ 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) {
+ // 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++);
+
+ lattice.mergeIntoSharedLocation(cycleElementSet, newSharedLoc);
+
+ for (Iterator iterator = cycleElementSet.iterator(); iterator.hasNext();) {
+ String oldLocSymbol = (String) iterator.next();
+ locInfo.mergeMapping(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 extractRelationFromFieldFlows(ClassDescriptor cd, FlowNode srcNode,
- FlowNode dstNode, int idx) {
+ FlowNode dstNode, int idx) throws CyclicFlowException {
- if (srcNode.getDescTuple().get(idx).equals(dstNode.getDescTuple().get(idx))) {
+ 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
- VarDescriptor varDesc = (VarDescriptor) srcNode.getDescTuple().get(idx);
- ClassDescriptor varClassDesc = varDesc.getType().getClassDesc();
- extractRelationFromFieldFlows(varClassDesc, srcNode, dstNode, idx + 1);
+
+ 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);
- fieldLattice.addRelationHigherToLower(srcFieldDesc.getSymbol(), dstFieldDesc.getSymbol());
+ 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>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM));
+ cd2lattice.put(cd, new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM));
}
return cd2lattice.get(cd);
}
setupToAnalyze();
+ Set<MethodDescriptor> visited = new HashSet<MethodDescriptor>();
+ Set<MethodDescriptor> reachableCallee = new HashSet<MethodDescriptor>();
+
while (!toAnalyzeIsEmpty()) {
ClassDescriptor cd = toAnalyzeNext();
setupToAnalazeMethod(cd);
+ toanalyzeMethodList.removeAll(visited);
+
while (!toAnalyzeMethodIsEmpty()) {
MethodDescriptor md = toAnalyzeMethodNext();
- if (ssjava.needTobeAnnotated(md)) {
+ if ((!visited.contains(md))
+ && (ssjava.needTobeAnnotated(md) || reachableCallee.contains(md))) {
if (state.SSJAVADEBUG) {
+ System.out.println();
System.out.println("SSJAVA: Constructing a flow graph: " + md);
}
- // creates a mapping from a parameter descriptor to its index
+ // 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)) {
+ toanalyzeMethodList.add(calleemd);
+ }
+ reachableCallee.add(calleemd);
+ needToAnalyzeCalleeSet.add(calleemd);
+ }
+ }
+ mapMethodToCalleeSet.put(md, needToAnalyzeCalleeSet);
+
+ // creates a mapping from a parameter descriptor to its index
Map<Descriptor, Integer> mapParamDescToIdx = new HashMap<Descriptor, Integer>();
int offset = md.isStatic() ? 0 : 1;
for (int i = 0; i < md.numParameters(); i++) {
FlowGraph fg = new FlowGraph(md, mapParamDescToIdx);
mapMethodDescriptorToFlowGraph.put(md, fg);
+ visited.add(md);
analyzeMethodBody(cd, md);
+
}
}
}
break;
case Kind.ReturnNode:
- analyzeReturnNode(md, nametable, (ReturnNode) bsn);
+ analyzeFlowReturnNode(md, nametable, (ReturnNode) bsn, implicitFlowTupleSet);
break;
case Kind.SubBlockNode:
private void analyzeSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
SwitchStatementNode bsn) {
// TODO Auto-generated method stub
-
}
private void analyzeFlowSubBlockNode(MethodDescriptor md, SymbolTable nametable,
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();
+ analyzeFlowExpressionNode(md, nametable, returnExp, nodeSet, false);
+
+ FlowGraph fg = getFlowGraph(md);
+
+ // annotate the elements of the node set as the return location
+ for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
+ NTuple<Descriptor> returnDescTuple = (NTuple<Descriptor>) iterator.next();
+ fg.setReturnFlowNode(returnDescTuple);
+ for (Iterator iterator2 = implicitFlowTupleSet.iterator(); iterator2.hasNext();) {
+ NTuple<Descriptor> implicitFlowDescTuple = (NTuple<Descriptor>) iterator2.next();
+ fg.addValueFlowEdge(implicitFlowDescTuple, returnDescTuple);
+ }
+ }
+ }
}
} 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,
// 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;
flowTuple =
analyzeFlowFieldAccessNode(md, nametable, (FieldAccessNode) en, nodeSet, base,
implicitFlowTupleSet);
- nodeSet.addTuple(flowTuple);
+ 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.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);
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 {
// checkCallerArgumentLocationConstraints(md, nametable, min,
// baseLocation, constraint);
- if (!min.getMethod().getReturnType().isVoid()) {
+ if (min.getMethod().getReturnType() != null && !min.getMethod().getReturnType().isVoid()) {
// If method has a return value, compute the highest possible return
// location in the caller's perspective
// CompositeLocation ceilingLoc =
}
- 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) {
+
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);
+ }
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);
}
}
}
private void analyzeLiteralNode(MethodDescriptor md, SymbolTable nametable, LiteralNode en) {
- // TODO Auto-generated method stub
}
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) {
+
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);
FieldAccessNode fan, NodeTupleSet nodeSet, NTuple<Descriptor> base,
NodeTupleSet implicitFlowTupleSet) {
+
ExpressionNode left = fan.getExpression();
TypeDescriptor ltd = left.getType();
FieldDescriptor fd = fan.getField();
}
}
- // if (left instanceof ArrayAccessNode) {
- // ArrayAccessNode aan = (ArrayAccessNode) left;
- // left = aan.getExpression();
- // }
+ if (left instanceof ArrayAccessNode) {
+ ArrayAccessNode aan = (ArrayAccessNode) left;
+ left = aan.getExpression();
+ }
// fanNodeSet
base =
analyzeFlowExpressionNode(md, nametable, left, nodeSet, base, implicitFlowTupleSet, false);
+ if (base == null) {
+ // in this case, field is TOP location
+ return null;
+ } else {
- if (!left.getType().isPrimitive()) {
+ if (!left.getType().isPrimitive()) {
+
+ if (fd.getSymbol().equals("length")) {
+ // array.length access, just have the location of the array
+ } else {
+ base.add(fd);
+ }
- if (fd.getSymbol().equals("length")) {
- // TODO
- // array.length access, return the location of the array
- // return loc;
}
- base.add(fd);
+ getFlowGraph(md).createNewFlowNode(base);
+ return base;
+
}
- 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);
-
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
for (Iterator<NTuple<Descriptor>> iter = nodeSetRHS.iterator(); iter.hasNext();) {
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) {
+ // TODO
+ // return true if it adds a new edge
FlowGraph graph = getFlowGraph(md);
graph.addValueFlowEdge(from, to);
+ return true;
}
public void _debug_printGraph() {
}
-class ParamIndexRelation {
- private Integer higherIdx;
- private Integer lowerIdx;
+class CyclicFlowException extends Exception {
+
}