import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.List;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.Vector;
import Analysis.CallGraph.CallGraph;
+import Analysis.Loops.GlobalFieldType;
+import Analysis.Loops.LoopFinder;
import Analysis.Loops.LoopOptimize;
import Analysis.Loops.LoopTerminate;
import IR.AnnotationDescriptor;
import IR.ClassDescriptor;
import IR.Descriptor;
+import IR.FieldDescriptor;
import IR.MethodDescriptor;
import IR.State;
+import IR.SymbolTable;
import IR.TypeUtil;
import IR.Flat.BuildFlat;
import IR.Flat.FlatMethod;
+import IR.Flat.FlatNode;
import Util.Pair;
public class SSJavaAnalysis {
public static final String DELEGATETHIS = "DELEGATETHIS";
public static final String TRUST = "TRUST";
+ public static final String TOP = "_top_";
+ public static final String BOTTOM = "_bottom_";
+
State state;
TypeUtil tu;
FlowDownCheck flowDownChecker;
// the set of method descriptor required to check the linear type property
Set<MethodDescriptor> linearTypeCheckMethodSet;
+ // the set of method descriptors annotated as "TRUST"
+ Set<MethodDescriptor> trustWorthyMDSet;
+
+ // points to method containing SSJAVA Loop
+ private MethodDescriptor methodContainingSSJavaLoop;
+
+ private FlatNode ssjavaLoopEntrance;
+
+ // keep the field ownership from the linear type checking
+ Hashtable<MethodDescriptor, Set<FieldDescriptor>> mapMethodToOwnedFieldSet;
+
+ Set<FlatNode> sameHeightWriteFlatNodeSet;
+
CallGraph callgraph;
LinearTypeCheck checker;
+ // maps a descriptor to its known dependents: namely
+ // methods or tasks that call the descriptor's method
+ // AND are part of this analysis (reachable from main)
+ private Hashtable<Descriptor, Set<MethodDescriptor>> mapDescriptorToSetDependents;
+
+ private LinkedList<MethodDescriptor> sortedDescriptors;
+
public SSJavaAnalysis(State state, TypeUtil tu, BuildFlat bf, CallGraph callgraph) {
this.state = state;
this.tu = tu;
this.mapSharedLocation2DescriptorSet = new Hashtable<Location, Set<Descriptor>>();
this.linearTypeCheckMethodSet = new HashSet<MethodDescriptor>();
this.bf = bf;
+ this.trustWorthyMDSet = new HashSet<MethodDescriptor>();
+ this.mapMethodToOwnedFieldSet = new Hashtable<MethodDescriptor, Set<FieldDescriptor>>();
+ this.sameHeightWriteFlatNodeSet = new HashSet<FlatNode>();
+ this.mapDescriptorToSetDependents = new Hashtable<Descriptor, Set<MethodDescriptor>>();
+ this.sortedDescriptors = new LinkedList<MethodDescriptor>();
}
public void doCheck() {
doMethodAnnotationCheck();
computeLinearTypeCheckMethodSet();
doLinearTypeCheck();
+
+ init();
+
if (state.SSJAVADEBUG) {
- debugPrint();
+ debug_printAnnotationRequiredSet();
+ }
+ if (state.SSJAVAINFER) {
+ inference();
+ } else {
+ parseLocationAnnotation();
+ doFlowDownCheck();
+ doDefinitelyWrittenCheck();
+ doLoopCheck();
+ }
+ }
+
+ private void init() {
+ // perform topological sort over the set of methods accessed by the main
+ // event loop
+ Set<MethodDescriptor> methodDescriptorsToAnalyze = new HashSet<MethodDescriptor>();
+ methodDescriptorsToAnalyze.addAll(getAnnotationRequireSet());
+ sortedDescriptors = topologicalSort(methodDescriptorsToAnalyze);
+ }
+
+ public LinkedList<MethodDescriptor> getSortedDescriptors() {
+ return (LinkedList<MethodDescriptor>) sortedDescriptors.clone();
+ }
+
+ private void inference() {
+ LocationInference inferEngine = new LocationInference(this, state);
+ inferEngine.inference();
+ }
+
+ private void doLoopCheck() {
+ GlobalFieldType gft = new GlobalFieldType(callgraph, state, tu.getMain());
+ LoopOptimize lo = new LoopOptimize(gft, tu);
+
+ SymbolTable classtable = state.getClassSymbolTable();
+
+ List<ClassDescriptor> toanalyzeList = new ArrayList<ClassDescriptor>();
+ List<MethodDescriptor> toanalyzeMethodList = new ArrayList<MethodDescriptor>();
+
+ toanalyzeList.addAll(classtable.getValueSet());
+ Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
+ public int compare(ClassDescriptor o1, ClassDescriptor o2) {
+ return o1.getClassName().compareTo(o2.getClassName());
+ }
+ });
+
+ for (int i = 0; i < toanalyzeList.size(); i++) {
+ ClassDescriptor cd = toanalyzeList.get(i);
+
+ SymbolTable methodtable = cd.getMethodTable();
+ toanalyzeMethodList.clear();
+ toanalyzeMethodList.addAll(methodtable.getValueSet());
+ Collections.sort(toanalyzeMethodList, new Comparator<MethodDescriptor>() {
+ public int compare(MethodDescriptor o1, MethodDescriptor o2) {
+ return o1.getSymbol().compareTo(o2.getSymbol());
+ }
+ });
+
+ for (int mdIdx = 0; mdIdx < toanalyzeMethodList.size(); mdIdx++) {
+ MethodDescriptor md = toanalyzeMethodList.get(mdIdx);
+ if (needTobeAnnotated(md)) {
+ lo.analyze(state.getMethodFlat(md));
+ doLoopTerminationCheck(lo, state.getMethodFlat(md));
+ }
+ }
+
}
- parseLocationAnnotation();
- doFlowDownCheck();
- doDefinitelyWrittenCheck();
+
+ }
+
+ public void addTrustMethod(MethodDescriptor md) {
+ trustWorthyMDSet.add(md);
+ }
+
+ public boolean isTrustMethod(MethodDescriptor md) {
+ return trustWorthyMDSet.contains(md);
}
private void computeLinearTypeCheckMethodSet() {
Set<MethodDescriptor> trustedSet = new HashSet<MethodDescriptor>();
- Set<MethodDescriptor> trustAnnoatedSet = methodAnnotationChecker.getTrustWorthyMDSet();
-
- for (Iterator iterator = trustAnnoatedSet.iterator(); iterator.hasNext();) {
+ for (Iterator iterator = trustWorthyMDSet.iterator(); iterator.hasNext();) {
MethodDescriptor trustMethod = (MethodDescriptor) iterator.next();
Set<MethodDescriptor> calledFromTrustMethodSet = callgraph.getMethodCalls(trustMethod);
trustedSet.add(trustMethod);
for (Iterator iterator = trustedSet.iterator(); iterator.hasNext();) {
MethodDescriptor md = (MethodDescriptor) iterator.next();
Set<MethodDescriptor> callerSet = callgraph.getCallerSet(md);
- if (!trustedSet.containsAll(callerSet) && !trustAnnoatedSet.contains(md)) {
+ if (!trustedSet.containsAll(callerSet) && !trustWorthyMDSet.contains(md)) {
linearTypeCheckMethodSet.add(md);
}
}
checker.linearTypeCheck();
}
- public void debugPrint() {
+ public void debug_printAnnotationRequiredSet() {
System.out.println("SSJAVA: SSJava is checking the following methods:");
for (Iterator<MethodDescriptor> iterator = annotationRequireSet.iterator(); iterator.hasNext();) {
MethodDescriptor md = iterator.next();
- System.out.print(" " + md);
+ System.out.println(md);
}
System.out.println();
}
methodAnnotationChecker = new MethodAnnotationCheck(this, state, tu);
methodAnnotationChecker.methodAnnoatationCheck();
methodAnnotationChecker.methodAnnoataionInheritanceCheck();
+ state.setAnnotationRequireSet(annotationRequireSet);
}
public void doFlowDownCheck() {
String marker = an.getMarker();
if (marker.equals(LATTICE)) {
SSJavaLattice<String> locOrder =
- new SSJavaLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM);
+ new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
cd2lattice.put(cd, locOrder);
parseClassLatticeDefinition(cd, an.getValue(), locOrder);
if (state.SSJAVADEBUG) {
// generate lattice dot file
- writeLatticeDotFile(cd, locOrder);
+ writeLatticeDotFile(cd, null, locOrder);
}
} else if (marker.equals(METHODDEFAULT)) {
MethodLattice<String> locOrder =
- new MethodLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM);
+ new MethodLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
cd2methodDefault.put(cd, locOrder);
parseMethodDefaultLatticeDefinition(cd, an.getValue(), locOrder);
}
if (an.getMarker().equals(LATTICE)) {
// developer explicitly defines method lattice
MethodLattice<String> locOrder =
- new MethodLattice<String>(SSJavaLattice.TOP, SSJavaLattice.BOTTOM);
+ new MethodLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
md2lattice.put(md, locOrder);
parseMethodDefaultLatticeDefinition(cd, an.getValue(), locOrder);
} else if (an.getMarker().equals(TERMINATE)) {
}
}
- private void writeLatticeDotFile(ClassDescriptor cd, SSJavaLattice<String> locOrder) {
+ public <T> void writeLatticeDotFile(ClassDescriptor cd, MethodDescriptor md,
+ SSJavaLattice<T> locOrder) {
- String className = cd.getSymbol().replaceAll("[\\W_]", "");
+ String fileName = "lattice_";
+ if (md != null) {
+ fileName +=
+ cd.getSymbol().replaceAll("[\\W_]", "") + "_" + md.getSymbol().replaceAll("[\\W_]", "");
+ } else {
+ fileName += cd.getSymbol().replaceAll("[\\W_]", "");
+ }
- Set<Pair<String, String>> pairSet = locOrder.getOrderingPairSet();
+ Set<Pair<T, T>> pairSet = locOrder.getOrderingPairSet();
- try {
- BufferedWriter bw = new BufferedWriter(new FileWriter(className + ".dot"));
+ if (pairSet.size() > 0) {
+ try {
+ BufferedWriter bw = new BufferedWriter(new FileWriter(fileName + ".dot"));
- bw.write("digraph " + className + " {\n");
+ 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();
+ for (Iterator iterator = pairSet.iterator(); iterator.hasNext();) {
+ // pair is in the form of <higher, lower>
+ Pair<T, T> pair = (Pair<T, T>) iterator.next();
- String highLocId = pair.getFirst();
- if (locOrder.isSharedLoc(highLocId)) {
- highLocId = "\"" + highLocId + "*\"";
- }
- String lowLocId = pair.getSecond();
- if (locOrder.isSharedLoc(lowLocId)) {
- lowLocId = "\"" + lowLocId + "*\"";
+ T highLocId = pair.getFirst();
+ String highLocStr, lowLocStr;
+ if (locOrder.isSharedLoc(highLocId)) {
+ highLocStr = "\"" + highLocId + "*\"";
+ } else {
+ highLocStr = highLocId.toString();
+ }
+ T lowLocId = pair.getSecond();
+ if (locOrder.isSharedLoc(lowLocId)) {
+ lowLocStr = "\"" + lowLocId + "*\"";
+ } else {
+ lowLocStr = lowLocId.toString();
+ }
+ bw.write(highLocId + " -> " + lowLocId + ";\n");
}
- bw.write(highLocId + " -> " + lowLocId + ";\n");
+ bw.write("}\n");
+ bw.close();
+
+ } catch (IOException e) {
+ e.printStackTrace();
}
- bw.write("}\n");
- bw.close();
- } catch (IOException e) {
- e.printStackTrace();
}
}
// sanity checks
if (locOrder.getThisLoc() != null && !locOrder.containsKey(locOrder.getThisLoc())) {
throw new Error("Variable 'this' location '" + locOrder.getThisLoc()
- + "' is not defined in the default local variable lattice at " + cd.getSourceFileName());
+ + "' is not defined in the local variable lattice at " + cd.getSourceFileName());
}
if (locOrder.getGlobalLoc() != null && !locOrder.containsKey(locOrder.getGlobalLoc())) {
throw new Error("Variable global location '" + locOrder.getGlobalLoc()
- + "' is not defined in the default local variable lattice at " + cd.getSourceFileName());
+ + "' is not defined in the local variable lattice at " + cd.getSourceFileName());
}
}
if (md2lattice.containsKey(md)) {
return md2lattice.get(md);
} else {
- return cd2methodDefault.get(md.getClassDesc());
+
+ if (cd2methodDefault.containsKey(md.getClassDesc())) {
+ return cd2methodDefault.get(md.getClassDesc());
+ } else {
+ throw new Error("Method Lattice of " + md + " is not defined.");
+ }
+
}
}
ClassDescriptor cd = md.getClassDesc();
// if a method requires to be annotated, class containg that method also
// requires to be annotated
- annotationRequireClassSet.add(cd);
- annotationRequireSet.add(md);
+ if (!isSSJavaUtil(cd)) {
+ annotationRequireClassSet.add(cd);
+ annotationRequireSet.add(md);
+ }
}
public Set<MethodDescriptor> getAnnotationRequireSet() {
}
public void doLoopTerminationCheck(LoopOptimize lo, FlatMethod fm) {
- LoopTerminate lt = new LoopTerminate();
+ LoopTerminate lt = new LoopTerminate(this, state);
if (needTobeAnnotated(fm.getMethod())) {
lt.terminateAnalysis(fm, lo.getLoopInvariant(fm));
}
}
- public void doLoopTerminationCheck(LoopOptimize lo) {
- LoopTerminate lt = new LoopTerminate();
- for (Iterator iterator = annotationRequireSet.iterator(); iterator.hasNext();) {
- MethodDescriptor md = (MethodDescriptor) iterator.next();
- if (!skipLoopTerminate.containsKey(md)) {
- FlatMethod fm = state.getMethodFlat(md);
- lt.terminateAnalysis(fm, lo.getLoopInvariant(fm));
- }
- }
-
- }
-
public CallGraph getCallGraph() {
return callgraph;
}
return bf;
}
+ public MethodDescriptor getMethodContainingSSJavaLoop() {
+ return methodContainingSSJavaLoop;
+ }
+
+ public void setMethodContainingSSJavaLoop(MethodDescriptor methodContainingSSJavaLoop) {
+ this.methodContainingSSJavaLoop = methodContainingSSJavaLoop;
+ }
+
+ public boolean isSSJavaUtil(ClassDescriptor cd) {
+ if (cd.getSymbol().equals("SSJAVA")) {
+ return true;
+ }
+ return false;
+ }
+
+ public void setFieldOnwership(MethodDescriptor md, FieldDescriptor field) {
+
+ Set<FieldDescriptor> fieldSet = mapMethodToOwnedFieldSet.get(md);
+ if (fieldSet == null) {
+ fieldSet = new HashSet<FieldDescriptor>();
+ mapMethodToOwnedFieldSet.put(md, fieldSet);
+ }
+ fieldSet.add(field);
+ }
+
+ public boolean isOwnedByMethod(MethodDescriptor md, FieldDescriptor field) {
+ Set<FieldDescriptor> fieldSet = mapMethodToOwnedFieldSet.get(md);
+ if (fieldSet != null) {
+ return fieldSet.contains(field);
+ }
+ return false;
+ }
+
+ public FlatNode getSSJavaLoopEntrance() {
+ return ssjavaLoopEntrance;
+ }
+
+ public void setSSJavaLoopEntrance(FlatNode ssjavaLoopEntrance) {
+ this.ssjavaLoopEntrance = ssjavaLoopEntrance;
+ }
+
+ public void addSameHeightWriteFlatNode(FlatNode fn) {
+ this.sameHeightWriteFlatNodeSet.add(fn);
+ }
+
+ public boolean isSameHeightWrite(FlatNode fn) {
+ return this.sameHeightWriteFlatNodeSet.contains(fn);
+ }
+
+ public LinkedList<MethodDescriptor> topologicalSort(Set<MethodDescriptor> toSort) {
+
+ Set<MethodDescriptor> discovered = new HashSet<MethodDescriptor>();
+
+ LinkedList<MethodDescriptor> sorted = new LinkedList<MethodDescriptor>();
+
+ Iterator<MethodDescriptor> itr = toSort.iterator();
+ while (itr.hasNext()) {
+ MethodDescriptor d = itr.next();
+
+ if (!discovered.contains(d)) {
+ dfsVisit(d, toSort, sorted, discovered);
+ }
+ }
+
+ return sorted;
+ }
+
+ // While we're doing DFS on call graph, remember
+ // dependencies for efficient queuing of methods
+ // during interprocedural analysis:
+ //
+ // a dependent of a method decriptor d for this analysis is:
+ // 1) a method or task that invokes d
+ // 2) in the descriptorsToAnalyze set
+ private void dfsVisit(MethodDescriptor md, Set<MethodDescriptor> toSort,
+ LinkedList<MethodDescriptor> sorted, Set<MethodDescriptor> discovered) {
+
+ discovered.add(md);
+
+ Iterator itr2 = callgraph.getCalleeSet(md).iterator();
+ while (itr2.hasNext()) {
+ MethodDescriptor dCallee = (MethodDescriptor) itr2.next();
+ addDependent(dCallee, md);
+ }
+
+ Iterator itr = callgraph.getCallerSet(md).iterator();
+ while (itr.hasNext()) {
+ MethodDescriptor dCaller = (MethodDescriptor) itr.next();
+ // only consider callers in the original set to analyze
+ if (!toSort.contains(dCaller)) {
+ continue;
+ }
+ if (!discovered.contains(dCaller)) {
+ addDependent(md, // callee
+ dCaller // caller
+ );
+
+ dfsVisit(dCaller, toSort, sorted, discovered);
+ }
+ }
+
+ // for leaf-nodes last now!
+ sorted.addLast(md);
+ }
+
+ public void addDependent(MethodDescriptor callee, MethodDescriptor caller) {
+ Set<MethodDescriptor> deps = mapDescriptorToSetDependents.get(callee);
+ if (deps == null) {
+ deps = new HashSet<MethodDescriptor>();
+ }
+ deps.add(caller);
+ mapDescriptorToSetDependents.put(callee, deps);
+ }
+
+ public Set<MethodDescriptor> getDependents(MethodDescriptor callee) {
+ Set<MethodDescriptor> deps = mapDescriptorToSetDependents.get(callee);
+ if (deps == null) {
+ deps = new HashSet<MethodDescriptor>();
+ mapDescriptorToSetDependents.put(callee, deps);
+ }
+ return deps;
+ }
+
}