1 package Analysis.SSJava;
3 import java.util.ArrayList;
4 import java.util.Collections;
5 import java.util.Comparator;
6 import java.util.HashSet;
7 import java.util.Hashtable;
8 import java.util.Iterator;
11 import java.util.StringTokenizer;
12 import java.util.Vector;
14 import Analysis.SSJava.FlowDownCheck.ComparisonResult;
15 import Analysis.SSJava.FlowDownCheck.CompositeLattice;
16 import IR.AnnotationDescriptor;
17 import IR.ClassDescriptor;
19 import IR.FieldDescriptor;
20 import IR.MethodDescriptor;
21 import IR.NameDescriptor;
24 import IR.SymbolTable;
25 import IR.TypeDescriptor;
26 import IR.VarDescriptor;
27 import IR.Tree.ArrayAccessNode;
28 import IR.Tree.AssignmentNode;
29 import IR.Tree.BlockExpressionNode;
30 import IR.Tree.BlockNode;
31 import IR.Tree.BlockStatementNode;
32 import IR.Tree.CastNode;
33 import IR.Tree.CreateObjectNode;
34 import IR.Tree.DeclarationNode;
35 import IR.Tree.ExpressionNode;
36 import IR.Tree.FieldAccessNode;
37 import IR.Tree.IfStatementNode;
39 import IR.Tree.LiteralNode;
40 import IR.Tree.LoopNode;
41 import IR.Tree.MethodInvokeNode;
42 import IR.Tree.NameNode;
43 import IR.Tree.OpNode;
44 import IR.Tree.ReturnNode;
45 import IR.Tree.SubBlockNode;
46 import IR.Tree.SwitchBlockNode;
47 import IR.Tree.SwitchStatementNode;
48 import IR.Tree.SynchronizedNode;
49 import IR.Tree.TertiaryNode;
50 import IR.Tree.TreeNode;
53 public class FlowDownCheck {
56 static SSJavaAnalysis ssjava;
58 Set<ClassDescriptor> toanalyze;
59 List<ClassDescriptor> toanalyzeList;
61 Set<MethodDescriptor> toanalyzeMethod;
62 List<MethodDescriptor> toanalyzeMethodList;
64 // mapping from 'descriptor' to 'composite location'
65 Hashtable<Descriptor, CompositeLocation> d2loc;
67 Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
68 Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
70 // mapping from 'locID' to 'class descriptor'
71 Hashtable<String, ClassDescriptor> fieldLocName2cd;
73 boolean deterministic = true;
75 public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
79 this.toanalyzeList = new ArrayList<ClassDescriptor>();
81 this.toanalyze = new HashSet<ClassDescriptor>();
84 this.toanalyzeMethodList = new ArrayList<MethodDescriptor>();
86 this.toanalyzeMethod = new HashSet<MethodDescriptor>();
88 this.d2loc = new Hashtable<Descriptor, CompositeLocation>();
89 this.fieldLocName2cd = new Hashtable<String, ClassDescriptor>();
90 this.md2ReturnLoc = new Hashtable<MethodDescriptor, CompositeLocation>();
91 this.md2ReturnLocGen = new Hashtable<MethodDescriptor, ReturnLocGenerator>();
96 // construct mapping from the location name to the class descriptor
97 // assume that the location name is unique through the whole program
99 Set<ClassDescriptor> cdSet = ssjava.getCd2lattice().keySet();
100 for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
101 ClassDescriptor cd = (ClassDescriptor) iterator.next();
102 SSJavaLattice<String> lattice = ssjava.getCd2lattice().get(cd);
103 Set<String> fieldLocNameSet = lattice.getKeySet();
105 for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
106 String fieldLocName = (String) iterator2.next();
107 fieldLocName2cd.put(fieldLocName, cd);
114 public boolean toAnalyzeIsEmpty() {
116 return toanalyzeList.isEmpty();
118 return toanalyze.isEmpty();
122 public ClassDescriptor toAnalyzeNext() {
124 return toanalyzeList.remove(0);
126 ClassDescriptor cd = toanalyze.iterator().next();
127 toanalyze.remove(cd);
132 public void setupToAnalyze() {
133 SymbolTable classtable = state.getClassSymbolTable();
135 toanalyzeList.clear();
136 toanalyzeList.addAll(classtable.getValueSet());
137 Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
138 public int compare(ClassDescriptor o1, ClassDescriptor o2) {
139 return o1.getClassName().compareTo(o2.getClassName());
144 toanalyze.addAll(classtable.getValueSet());
148 public void setupToAnalazeMethod(ClassDescriptor cd) {
150 SymbolTable methodtable = cd.getMethodTable();
152 toanalyzeMethodList.clear();
153 toanalyzeMethodList.addAll(methodtable.getValueSet());
154 Collections.sort(toanalyzeMethodList, new Comparator<MethodDescriptor>() {
155 public int compare(MethodDescriptor o1, MethodDescriptor o2) {
156 return o1.getSymbol().compareTo(o2.getSymbol());
160 toanalyzeMethod.clear();
161 toanalyzeMethod.addAll(methodtable.getValueSet());
165 public boolean toAnalyzeMethodIsEmpty() {
167 return toanalyzeMethodList.isEmpty();
169 return toanalyzeMethod.isEmpty();
173 public MethodDescriptor toAnalyzeMethodNext() {
175 return toanalyzeMethodList.remove(0);
177 MethodDescriptor md = toanalyzeMethod.iterator().next();
178 toanalyzeMethod.remove(md);
183 public void flowDownCheck() {
185 // phase 1 : checking declaration node and creating mapping of 'type
186 // desciptor' & 'location'
189 while (!toAnalyzeIsEmpty()) {
190 ClassDescriptor cd = toAnalyzeNext();
192 if (ssjava.needToBeAnnoated(cd)) {
194 ClassDescriptor superDesc = cd.getSuperDesc();
196 if (superDesc != null && (!superDesc.getSymbol().equals("Object"))) {
197 checkOrderingInheritance(superDesc, cd);
200 checkDeclarationInClass(cd);
202 setupToAnalazeMethod(cd);
203 while (!toAnalyzeMethodIsEmpty()) {
204 MethodDescriptor md = toAnalyzeMethodNext();
205 if (ssjava.needTobeAnnotated(md)) {
206 checkDeclarationInMethodBody(cd, md);
214 // phase2 : checking assignments
217 while (!toAnalyzeIsEmpty()) {
218 ClassDescriptor cd = toAnalyzeNext();
220 setupToAnalazeMethod(cd);
221 while (!toAnalyzeMethodIsEmpty()) {
222 MethodDescriptor md = toAnalyzeMethodNext();
223 if (ssjava.needTobeAnnotated(md)) {
224 System.out.println("SSJAVA: Checking assignments: " + md);
225 checkMethodBody(cd, md);
232 private void checkOrderingInheritance(ClassDescriptor superCd, ClassDescriptor cd) {
233 // here, we're going to check that sub class keeps same relative orderings
234 // in respect to super class
236 SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
237 SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
239 if (superLattice != null) {
240 // if super class doesn't define lattice, then we don't need to check its
242 if (subLattice == null) {
243 throw new Error("If a parent class '" + superCd
244 + "' has a ordering lattice, its subclass '" + cd + "' should have one.");
247 Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
248 Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
250 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
251 Pair<String, String> pair = (Pair<String, String>) iterator.next();
253 if (!subPairSet.contains(pair)) {
254 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
255 + pair.getSecond() + " < " + pair.getFirst()
256 + "' that is defined by its superclass '" + superCd + "'.");
261 MethodLattice<String> superMethodDefaultLattice = ssjava.getMethodDefaultLattice(superCd);
262 MethodLattice<String> subMethodDefaultLattice = ssjava.getMethodDefaultLattice(cd);
264 if (superMethodDefaultLattice != null) {
265 if (subMethodDefaultLattice == null) {
266 throw new Error("When a parent class '" + superCd
267 + "' defines a default method lattice, its subclass '" + cd + "' should define one.");
270 Set<Pair<String, String>> superPairSet = superMethodDefaultLattice.getOrderingPairSet();
271 Set<Pair<String, String>> subPairSet = subMethodDefaultLattice.getOrderingPairSet();
273 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
274 Pair<String, String> pair = (Pair<String, String>) iterator.next();
276 if (!subPairSet.contains(pair)) {
277 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
278 + pair.getSecond() + " < " + pair.getFirst()
279 + "' that is defined by its superclass '" + superCd
280 + "' in the method default lattice.");
288 public Hashtable getMap() {
292 private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
293 BlockNode bn = state.getMethodBody(md);
295 // first, check annotations on method parameters
296 List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
297 for (int i = 0; i < md.numParameters(); i++) {
298 // process annotations on method parameters
299 VarDescriptor vd = (VarDescriptor) md.getParameter(i);
300 assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), bn);
301 paramList.add(d2loc.get(vd));
303 Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
305 // second, check return location annotation
306 if (!md.getReturnType().isVoid()) {
307 CompositeLocation returnLocComp = null;
309 String rtrStr = ssjava.getMethodLattice(md).getReturnLoc();
310 if (rtrStr != null) {
311 returnLocComp = new CompositeLocation(new Location(md, rtrStr));
313 if (methodAnnotations != null) {
314 for (int i = 0; i < methodAnnotations.size(); i++) {
315 AnnotationDescriptor an = methodAnnotations.elementAt(i);
316 if (an.getMarker().equals(ssjava.RETURNLOC)) {
317 // this case, developer explicitly defines method lattice
318 String returnLocDeclaration = an.getValue();
319 returnLocComp = parseLocationDeclaration(md, null, returnLocDeclaration);
323 // if developer does not define method lattice
324 // search return location in the method default lattice
325 if (returnLocComp == null) {
326 MethodLattice<String> methodDefaultLattice = ssjava.getMethodDefaultLattice(cd);
327 if (methodDefaultLattice.getReturnLoc() != null) {
329 parseLocationDeclaration(md, null, methodDefaultLattice.getReturnLoc());
335 if (returnLocComp == null) {
336 throw new Error("Return location is not specified for the method " + md + " at "
337 + cd.getSourceFileName());
340 md2ReturnLoc.put(md, returnLocComp);
342 // check this location
343 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
344 String thisLocId = methodLattice.getThisLoc();
345 if (thisLocId == null) {
346 throw new Error("Method '" + md + "' does not have the definition of 'this' location at "
347 + md.getClassDesc().getSourceFileName());
349 CompositeLocation thisLoc = new CompositeLocation(new Location(md, thisLocId));
350 paramList.add(0, thisLoc);
352 System.out.println("### ReturnLocGenerator="+md);
353 System.out.println("### md2ReturnLoc.get(md)="+md2ReturnLoc.get(md));
354 md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), paramList, md + " of "
355 + cd.getSourceFileName()));
358 // fourth, check declarations inside of method
360 checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
364 private void checkDeclarationInBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn) {
365 bn.getVarTable().setParent(nametable);
366 for (int i = 0; i < bn.size(); i++) {
367 BlockStatementNode bsn = bn.get(i);
368 checkDeclarationInBlockStatementNode(md, bn.getVarTable(), bsn);
372 private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
373 BlockStatementNode bsn) {
375 switch (bsn.kind()) {
376 case Kind.SubBlockNode:
377 checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
380 case Kind.DeclarationNode:
381 checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
385 checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
388 case Kind.IfStatementNode:
389 checkDeclarationInIfStatementNode(md, nametable, (IfStatementNode) bsn);
392 case Kind.SwitchStatementNode:
393 checkDeclarationInSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn);
396 case Kind.SynchronizedNode:
397 checkDeclarationInSynchronizedNode(md, nametable, (SynchronizedNode) bsn);
403 private void checkDeclarationInSynchronizedNode(MethodDescriptor md, SymbolTable nametable,
404 SynchronizedNode sbn) {
405 checkDeclarationInBlockNode(md, nametable, sbn.getBlockNode());
408 private void checkDeclarationInSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
409 SwitchStatementNode ssn) {
410 BlockNode sbn = ssn.getSwitchBody();
411 for (int i = 0; i < sbn.size(); i++) {
412 SwitchBlockNode node = (SwitchBlockNode) sbn.get(i);
413 checkDeclarationInBlockNode(md, nametable, node.getSwitchBlockStatement());
417 private void checkDeclarationInIfStatementNode(MethodDescriptor md, SymbolTable nametable,
418 IfStatementNode isn) {
419 checkDeclarationInBlockNode(md, nametable, isn.getTrueBlock());
420 if (isn.getFalseBlock() != null)
421 checkDeclarationInBlockNode(md, nametable, isn.getFalseBlock());
424 private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
426 if (ln.getType() == LoopNode.FORLOOP) {
427 // check for loop case
428 ClassDescriptor cd = md.getClassDesc();
429 BlockNode bn = ln.getInitializer();
430 for (int i = 0; i < bn.size(); i++) {
431 BlockStatementNode bsn = bn.get(i);
432 checkDeclarationInBlockStatementNode(md, nametable, bsn);
437 checkDeclarationInBlockNode(md, nametable, ln.getBody());
440 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
441 BlockNode bn = state.getMethodBody(md);
442 checkLocationFromBlockNode(md, md.getParameterTable(), bn, null);
445 private String generateErrorMessage(ClassDescriptor cd, TreeNode tn) {
447 return cd.getSourceFileName() + "::" + tn.getNumLine();
449 return cd.getSourceFileName();
454 private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
455 BlockNode bn, CompositeLocation constraint) {
457 bn.getVarTable().setParent(nametable);
458 for (int i = 0; i < bn.size(); i++) {
459 BlockStatementNode bsn = bn.get(i);
460 checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn, constraint);
462 return new CompositeLocation();
466 private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
467 SymbolTable nametable, BlockStatementNode bsn, CompositeLocation constraint) {
469 CompositeLocation compLoc = null;
470 switch (bsn.kind()) {
471 case Kind.BlockExpressionNode:
473 checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, constraint);
476 case Kind.DeclarationNode:
477 compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn, constraint);
480 case Kind.IfStatementNode:
481 compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn, constraint);
485 compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn, constraint);
488 case Kind.ReturnNode:
489 compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn, constraint);
492 case Kind.SubBlockNode:
493 compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn, constraint);
496 case Kind.ContinueBreakNode:
497 compLoc = new CompositeLocation();
500 case Kind.SwitchStatementNode:
502 checkLocationFromSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, constraint);
508 private CompositeLocation checkLocationFromSwitchStatementNode(MethodDescriptor md,
509 SymbolTable nametable, SwitchStatementNode ssn, CompositeLocation constraint) {
511 ClassDescriptor cd = md.getClassDesc();
512 CompositeLocation condLoc =
513 checkLocationFromExpressionNode(md, nametable, ssn.getCondition(), new CompositeLocation(),
515 BlockNode sbn = ssn.getSwitchBody();
517 constraint = generateNewConstraint(constraint, condLoc);
519 for (int i = 0; i < sbn.size(); i++) {
520 checkLocationFromSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), constraint);
522 return new CompositeLocation();
525 private CompositeLocation checkLocationFromSwitchBlockNode(MethodDescriptor md,
526 SymbolTable nametable, SwitchBlockNode sbn, CompositeLocation constraint) {
528 CompositeLocation blockLoc =
529 checkLocationFromBlockNode(md, nametable, sbn.getSwitchBlockStatement(), constraint);
535 private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
536 ReturnNode rn, CompositeLocation constraint) {
538 ExpressionNode returnExp = rn.getReturnExpression();
540 CompositeLocation returnValueLoc;
541 if (returnExp != null) {
543 checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation(),
546 // if this return statement is inside branch, return value has an implicit
547 // flow from conditional location
548 if (constraint != null) {
549 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
550 inputGLB.add(returnValueLoc);
551 inputGLB.add(constraint);
553 CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(md.getClassDesc(), rn));
556 // check if return value is equal or higher than RETRUNLOC of method
557 // declaration annotation
558 CompositeLocation declaredReturnLoc = md2ReturnLoc.get(md);
561 CompositeLattice.compare(returnValueLoc, declaredReturnLoc,
562 generateErrorMessage(md.getClassDesc(), rn));
564 if (compareResult == ComparisonResult.LESS || compareResult == ComparisonResult.INCOMPARABLE) {
566 "Return value location is not equal or higher than the declaraed return location at "
567 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
571 return new CompositeLocation();
574 private boolean hasOnlyLiteralValue(ExpressionNode en) {
575 if (en.kind() == Kind.LiteralNode) {
582 private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
583 LoopNode ln, CompositeLocation constraint) {
585 ClassDescriptor cd = md.getClassDesc();
586 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
588 CompositeLocation condLoc =
589 checkLocationFromExpressionNode(md, nametable, ln.getCondition(),
590 new CompositeLocation(), constraint, false);
591 addLocationType(ln.getCondition().getType(), (condLoc));
593 constraint = generateNewConstraint(constraint, condLoc);
594 checkLocationFromBlockNode(md, nametable, ln.getBody(), constraint);
596 return new CompositeLocation();
599 // check 'for loop' case
600 BlockNode bn = ln.getInitializer();
601 bn.getVarTable().setParent(nametable);
603 // calculate glb location of condition and update statements
604 CompositeLocation condLoc =
605 checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
606 new CompositeLocation(), constraint, false);
607 addLocationType(ln.getCondition().getType(), condLoc);
609 constraint = generateNewConstraint(constraint, condLoc);
611 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate(), constraint);
612 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody(), constraint);
614 return new CompositeLocation();
620 private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
621 SymbolTable nametable, SubBlockNode sbn, CompositeLocation constraint) {
622 CompositeLocation compLoc =
623 checkLocationFromBlockNode(md, nametable, sbn.getBlockNode(), constraint);
627 private CompositeLocation generateNewConstraint(CompositeLocation currentCon,
628 CompositeLocation newCon) {
630 if (currentCon == null) {
633 // compute GLB of current constraint and new constraint
634 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
635 inputSet.add(currentCon);
636 inputSet.add(newCon);
637 return CompositeLattice.calculateGLB(inputSet, "");
642 private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
643 SymbolTable nametable, IfStatementNode isn, CompositeLocation constraint) {
645 CompositeLocation condLoc =
646 checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation(),
649 addLocationType(isn.getCondition().getType(), condLoc);
651 constraint = generateNewConstraint(constraint, condLoc);
652 checkLocationFromBlockNode(md, nametable, isn.getTrueBlock(), constraint);
654 if (isn.getFalseBlock() != null) {
655 checkLocationFromBlockNode(md, nametable, isn.getFalseBlock(), constraint);
658 return new CompositeLocation();
661 private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
662 SymbolTable nametable, DeclarationNode dn, CompositeLocation constraint) {
664 VarDescriptor vd = dn.getVarDescriptor();
666 CompositeLocation destLoc = d2loc.get(vd);
668 if (dn.getExpression() != null) {
669 CompositeLocation expressionLoc =
670 checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
671 new CompositeLocation(), constraint, false);
672 // addTypeLocation(dn.getExpression().getType(), expressionLoc);
674 if (expressionLoc != null) {
675 // checking location order
676 if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc,
677 generateErrorMessage(md.getClassDesc(), dn))) {
678 throw new Error("The value flow from " + expressionLoc + " to " + destLoc
679 + " does not respect location hierarchy on the assignment " + dn.printNode(0)
680 + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
683 return expressionLoc;
687 return new CompositeLocation();
693 private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
695 checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
698 private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
699 SymbolTable nametable, BlockExpressionNode ben, CompositeLocation constraint) {
700 CompositeLocation compLoc =
701 checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null, constraint, false);
702 // addTypeLocation(ben.getExpression().getType(), compLoc);
706 private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
707 SymbolTable nametable, ExpressionNode en, CompositeLocation loc,
708 CompositeLocation constraint, boolean isLHS) {
710 CompositeLocation compLoc = null;
713 case Kind.AssignmentNode:
715 checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc, constraint);
718 case Kind.FieldAccessNode:
720 checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc, constraint);
724 compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc, constraint);
728 compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en, constraint);
731 case Kind.CreateObjectNode:
732 compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
735 case Kind.ArrayAccessNode:
737 checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en, constraint, isLHS);
740 case Kind.LiteralNode:
741 compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
744 case Kind.MethodInvokeNode:
746 checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc, constraint);
749 case Kind.TertiaryNode:
750 compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en, constraint);
754 compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en, constraint);
757 // case Kind.InstanceOfNode:
758 // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
761 // case Kind.ArrayInitializerNode:
762 // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
766 // case Kind.ClassTypeNode:
767 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
770 // case Kind.OffsetNode:
771 // checkOffsetNode(md, nametable, (OffsetNode)en, td);
778 // addTypeLocation(en.getType(), compLoc);
783 private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
784 CastNode cn, CompositeLocation constraint) {
786 ExpressionNode en = cn.getExpression();
787 return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
792 private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
793 SymbolTable nametable, TertiaryNode tn, CompositeLocation constraint) {
794 ClassDescriptor cd = md.getClassDesc();
796 CompositeLocation condLoc =
797 checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation(),
799 addLocationType(tn.getCond().getType(), condLoc);
800 CompositeLocation trueLoc =
801 checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation(),
803 addLocationType(tn.getTrueExpr().getType(), trueLoc);
804 CompositeLocation falseLoc =
805 checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation(),
807 addLocationType(tn.getFalseExpr().getType(), falseLoc);
809 // locations from true/false branches can be TOP when there are only literal
811 // in this case, we don't need to check flow down rule!
813 // check if condLoc is higher than trueLoc & falseLoc
814 if (!trueLoc.get(0).isTop()
815 && !CompositeLattice.isGreaterThan(condLoc, trueLoc, generateErrorMessage(cd, tn))) {
817 "The location of the condition expression is lower than the true expression at "
818 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
821 if (!falseLoc.get(0).isTop()
822 && !CompositeLattice.isGreaterThan(condLoc, falseLoc,
823 generateErrorMessage(cd, tn.getCond()))) {
825 "The location of the condition expression is lower than the true expression at "
826 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
829 // then, return glb of trueLoc & falseLoc
830 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
831 glbInputSet.add(trueLoc);
832 glbInputSet.add(falseLoc);
834 return CompositeLattice.calculateGLB(glbInputSet, generateErrorMessage(cd, tn));
837 private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
838 SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc,
839 CompositeLocation constraint) {
841 CompositeLocation baseLocation = null;
842 if (min.getExpression() != null) {
844 checkLocationFromExpressionNode(md, nametable, min.getExpression(),
845 new CompositeLocation(), constraint, false);
847 String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
848 baseLocation = new CompositeLocation(new Location(md, thisLocId));
851 checkCalleeConstraints(md, nametable, min, baseLocation, constraint);
853 if (!min.getMethod().getReturnType().isVoid()) {
854 // If method has a return value, compute the highest possible return
855 // location in the caller's perspective
856 CompositeLocation ceilingLoc =
857 computeCeilingLocationForCaller(md, nametable, min, baseLocation, constraint);
861 return new CompositeLocation();
865 private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
866 SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation,
867 CompositeLocation constraint) {
868 List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
870 // by default, method has a THIS parameter
871 argList.add(baseLocation);
873 for (int i = 0; i < min.numArgs(); i++) {
874 ExpressionNode en = min.getArg(i);
875 CompositeLocation callerArg =
876 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
878 argList.add(callerArg);
881 System.out.println("\n## computeReturnLocation=" + min.getMethod() + " argList=" + argList);
882 CompositeLocation compLoc = md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
883 DeltaLocation delta = new DeltaLocation(compLoc, 1);
884 System.out.println("##computeReturnLocation=" + delta);
890 private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
891 MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
893 MethodDescriptor calleemd = min.getMethod();
895 MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
896 CompositeLocation calleeThisLoc =
897 new CompositeLocation(new Location(calleemd, calleeLattice.getThisLoc()));
899 List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
900 List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
902 if (min.numArgs() > 0) {
903 // caller needs to guarantee that it passes arguments in regarding to
904 // callee's hierarchy
906 // setup caller args set
907 // first, add caller's base(this) location
908 callerArgList.add(callerBaseLoc);
909 // second, add caller's arguments
910 for (int i = 0; i < min.numArgs(); i++) {
911 ExpressionNode en = min.getArg(i);
912 CompositeLocation callerArgLoc =
913 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
915 callerArgList.add(callerArgLoc);
918 // setup callee params set
919 // first, add callee's this location
920 calleeParamList.add(calleeThisLoc);
921 // second, add callee's parameters
922 for (int i = 0; i < calleemd.numParameters(); i++) {
923 VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
924 CompositeLocation calleeLoc = d2loc.get(calleevd);
925 calleeParamList.add(calleeLoc);
928 // here, check if ordering relations among caller's args respect
929 // ordering relations in-between callee's args
930 for (int i = 0; i < calleeParamList.size(); i++) {
931 CompositeLocation calleeLoc1 = calleeParamList.get(i);
932 CompositeLocation callerLoc1 = callerArgList.get(i);
934 for (int j = 0; j < calleeParamList.size(); j++) {
936 CompositeLocation calleeLoc2 = calleeParamList.get(j);
937 CompositeLocation callerLoc2 = callerArgList.get(j);
940 CompositeLattice.compare(callerLoc1, callerLoc2,
941 generateErrorMessage(md.getClassDesc(), min));
943 CompositeLattice.compare(calleeLoc1, calleeLoc2,
944 generateErrorMessage(md.getClassDesc(), min));
946 if (calleeResult == ComparisonResult.GREATER
947 && callerResult != ComparisonResult.GREATER) {
948 // If calleeLoc1 is higher than calleeLoc2
949 // then, caller should have same ordering relation in-bet
950 // callerLoc1 & callerLoc2
952 String paramName1, paramName2;
955 paramName1 = "'THIS'";
957 paramName1 = "'parameter " + calleemd.getParamName(i - 1) + "'";
961 paramName2 = "'THIS'";
963 paramName2 = "'parameter " + calleemd.getParamName(j - 1) + "'";
967 "Caller doesn't respect an ordering relation among method arguments: callee expects that "
968 + paramName1 + " should be higher than " + paramName2 + " in " + calleemd
969 + " at " + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
980 private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
981 SymbolTable nametable, ArrayAccessNode aan, CompositeLocation constraint, boolean isLHS) {
983 ClassDescriptor cd = md.getClassDesc();
985 CompositeLocation arrayLoc =
986 checkLocationFromExpressionNode(md, nametable, aan.getExpression(),
987 new CompositeLocation(), constraint, isLHS);
988 // addTypeLocation(aan.getExpression().getType(), arrayLoc);
989 CompositeLocation indexLoc =
990 checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(),
992 // addTypeLocation(aan.getIndex().getType(), indexLoc);
995 if (!CompositeLattice.isGreaterThan(indexLoc, arrayLoc, generateErrorMessage(cd, aan))) {
996 throw new Error("Array index value is not higher than array location at "
997 + generateErrorMessage(cd, aan));
1001 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1002 inputGLB.add(arrayLoc);
1003 inputGLB.add(indexLoc);
1004 return CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(cd, aan));
1009 private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
1010 SymbolTable nametable, CreateObjectNode con) {
1012 ClassDescriptor cd = md.getClassDesc();
1014 CompositeLocation compLoc = new CompositeLocation();
1015 compLoc.addLocation(Location.createTopLocation(md));
1020 private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
1021 OpNode on, CompositeLocation constraint) {
1023 ClassDescriptor cd = md.getClassDesc();
1024 CompositeLocation leftLoc = new CompositeLocation();
1026 checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc, constraint, false);
1027 // addTypeLocation(on.getLeft().getType(), leftLoc);
1029 CompositeLocation rightLoc = new CompositeLocation();
1030 if (on.getRight() != null) {
1032 checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc, constraint, false);
1033 // addTypeLocation(on.getRight().getType(), rightLoc);
1036 System.out.println("\n# OP NODE=" + on.printNode(0));
1037 System.out.println("# left loc=" + leftLoc + " from " + on.getLeft().getClass());
1038 if (on.getRight() != null) {
1039 System.out.println("# right loc=" + rightLoc + " from " + on.getRight().getClass());
1042 Operation op = on.getOp();
1044 switch (op.getOp()) {
1046 case Operation.UNARYPLUS:
1047 case Operation.UNARYMINUS:
1048 case Operation.LOGIC_NOT:
1052 case Operation.LOGIC_OR:
1053 case Operation.LOGIC_AND:
1054 case Operation.COMP:
1055 case Operation.BIT_OR:
1056 case Operation.BIT_XOR:
1057 case Operation.BIT_AND:
1058 case Operation.ISAVAILABLE:
1059 case Operation.EQUAL:
1060 case Operation.NOTEQUAL:
1067 case Operation.MULT:
1070 case Operation.LEFTSHIFT:
1071 case Operation.RIGHTSHIFT:
1072 case Operation.URIGHTSHIFT:
1074 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
1075 inputSet.add(leftLoc);
1076 inputSet.add(rightLoc);
1077 CompositeLocation glbCompLoc =
1078 CompositeLattice.calculateGLB(inputSet, generateErrorMessage(cd, on));
1079 System.out.println("# glbCompLoc=" + glbCompLoc);
1083 throw new Error(op.toString());
1088 private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
1089 SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
1091 // literal value has the top location so that value can be flowed into any
1093 Location literalLoc = Location.createTopLocation(md);
1094 loc.addLocation(literalLoc);
1099 private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
1100 NameNode nn, CompositeLocation loc, CompositeLocation constraint) {
1102 NameDescriptor nd = nn.getName();
1103 if (nd.getBase() != null) {
1105 checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc, constraint, false);
1107 String varname = nd.toString();
1108 if (varname.equals("this")) {
1110 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
1111 String thisLocId = methodLattice.getThisLoc();
1112 if (thisLocId == null) {
1113 throw new Error("The location for 'this' is not defined at "
1114 + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
1116 Location locElement = new Location(md, thisLocId);
1117 loc.addLocation(locElement);
1122 Descriptor d = (Descriptor) nametable.get(varname);
1124 // CompositeLocation localLoc = null;
1125 if (d instanceof VarDescriptor) {
1126 VarDescriptor vd = (VarDescriptor) d;
1127 // localLoc = d2loc.get(vd);
1128 // the type of var descriptor has a composite location!
1129 loc = ((CompositeLocation) vd.getType().getExtension()).clone();
1130 } else if (d instanceof FieldDescriptor) {
1131 // the type of field descriptor has a location!
1132 FieldDescriptor fd = (FieldDescriptor) d;
1133 if (fd.isStatic()) {
1135 // if it is 'static final', the location has TOP since no one can
1137 loc.addLocation(Location.createTopLocation(md));
1140 // if 'static', the location has pre-assigned global loc
1141 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1142 String globalLocId = localLattice.getGlobalLoc();
1143 if (globalLocId == null) {
1144 throw new Error("Global location element is not defined in the method " + md);
1146 Location globalLoc = new Location(md, globalLocId);
1148 loc.addLocation(globalLoc);
1151 // the location of field access starts from this, followed by field
1153 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1154 Location thisLoc = new Location(md, localLattice.getThisLoc());
1155 loc.addLocation(thisLoc);
1158 Location fieldLoc = (Location) fd.getType().getExtension();
1159 loc.addLocation(fieldLoc);
1160 } else if (d == null) {
1162 // check if the var is a static field of the class
1163 FieldDescriptor fd = nn.getField();
1164 ClassDescriptor cd = nn.getClassDesc();
1166 if (fd != null && cd != null) {
1168 if (fd.isStatic() && fd.isFinal()) {
1169 loc.addLocation(Location.createTopLocation(md));
1172 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1173 Location fieldLoc = new Location(md, localLattice.getThisLoc());
1174 loc.addLocation(fieldLoc);
1183 private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1184 SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc,
1185 CompositeLocation constraint) {
1187 ExpressionNode left = fan.getExpression();
1188 TypeDescriptor ltd = left.getType();
1190 FieldDescriptor fd = fan.getField();
1192 String varName = null;
1193 if (left.kind() == Kind.NameNode) {
1194 NameDescriptor nd = ((NameNode) left).getName();
1195 varName = nd.toString();
1198 if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
1199 // using a class name directly or access using this
1200 if (fd.isStatic() && fd.isFinal()) {
1201 loc.addLocation(Location.createTopLocation(md));
1206 loc = checkLocationFromExpressionNode(md, nametable, left, loc, constraint, false);
1207 if (!left.getType().isPrimitive()) {
1208 Location fieldLoc = getFieldLocation(fd);
1209 loc.addLocation(fieldLoc);
1215 private Location getFieldLocation(FieldDescriptor fd) {
1217 Location fieldLoc = (Location) fd.getType().getExtension();
1219 // handle the case that method annotation checking skips checking field
1221 if (fieldLoc == null) {
1222 fieldLoc = checkFieldDeclaration(fd.getClassDescriptor(), fd);
1229 private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1230 SymbolTable nametable, AssignmentNode an, CompositeLocation loc, CompositeLocation constraint) {
1232 System.out.println("\n# ASSIGNMENTNODE=" + an.printNode(0));
1234 ClassDescriptor cd = md.getClassDesc();
1236 Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1238 boolean postinc = true;
1239 if (an.getOperation().getBaseOp() == null
1240 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1241 .getBaseOp().getOp() != Operation.POSTDEC))
1244 // if LHS is array access node, need to check if array index is higher
1245 // than array itself
1246 CompositeLocation destLocation =
1247 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1250 CompositeLocation rhsLocation;
1251 CompositeLocation srcLocation;
1255 checkLocationFromExpressionNode(md, nametable, an.getSrc(), new CompositeLocation(),
1258 System.out.println("dstLocation=" + destLocation);
1259 System.out.println("rhsLocation=" + rhsLocation);
1260 System.out.println("constraint=" + constraint);
1262 if (constraint != null) {
1263 inputGLBSet.add(rhsLocation);
1264 inputGLBSet.add(constraint);
1265 srcLocation = CompositeLattice.calculateGLB(inputGLBSet, generateErrorMessage(cd, an));
1267 srcLocation = rhsLocation;
1270 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1271 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1272 + " does not respect location hierarchy on the assignment " + an.printNode(0) + " at "
1273 + cd.getSourceFileName() + "::" + an.getNumLine());
1279 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1282 if (constraint != null) {
1283 inputGLBSet.add(rhsLocation);
1284 inputGLBSet.add(constraint);
1285 srcLocation = CompositeLattice.calculateGLB(inputGLBSet, generateErrorMessage(cd, an));
1287 srcLocation = rhsLocation;
1290 System.out.println("srcLocation=" + srcLocation);
1291 System.out.println("rhsLocation=" + rhsLocation);
1292 System.out.println("constraint=" + constraint);
1294 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1295 throw new Error("Location " + destLocation
1296 + " is not allowed to have the value flow that moves within the same location at "
1297 + cd.getSourceFileName() + "::" + an.getNumLine());
1302 return destLocation;
1305 private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1306 SymbolTable nametable, TreeNode n) {
1308 ClassDescriptor cd = md.getClassDesc();
1309 Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1311 // currently enforce every variable to have corresponding location
1312 if (annotationVec.size() == 0) {
1313 throw new Error("Location is not assigned to variable " + vd.getSymbol() + " in the method "
1314 + md.getSymbol() + " of the class " + cd.getSymbol());
1317 if (annotationVec.size() > 1) { // variable can have at most one location
1318 throw new Error(vd.getSymbol() + " has more than one location.");
1321 AnnotationDescriptor ad = annotationVec.elementAt(0);
1323 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1325 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1326 String locDec = ad.getValue(); // check if location is defined
1328 if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1329 DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1330 d2loc.put(vd, deltaLoc);
1331 addLocationType(vd.getType(), deltaLoc);
1333 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1335 Location lastElement = compLoc.get(compLoc.getSize() - 1);
1336 if (ssjava.isSharedLocation(lastElement)) {
1337 ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1340 d2loc.put(vd, compLoc);
1341 addLocationType(vd.getType(), compLoc);
1349 private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1352 int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1355 int beginIdx = dIdx + 6;
1356 locDec = locDec.substring(beginIdx, locDec.length() - 1);
1357 dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1360 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1361 DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1366 private Location parseFieldLocDeclaraton(String decl, String msg) throws Exception {
1368 int idx = decl.indexOf(".");
1370 String className = decl.substring(0, idx);
1371 String fieldName = decl.substring(idx + 1);
1373 className.replaceAll(" ", "");
1374 fieldName.replaceAll(" ", "");
1376 Descriptor d = state.getClassSymbolTable().get(className);
1379 System.out.println("state.getClassSymbolTable()=" + state.getClassSymbolTable());
1380 throw new Error("The class in the location declaration '" + decl + "' does not exist at "
1384 assert (d instanceof ClassDescriptor);
1385 SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1386 if (!lattice.containsKey(fieldName)) {
1387 throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1388 + className + "' at " + msg);
1391 return new Location(d, fieldName);
1394 private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1396 CompositeLocation compLoc = new CompositeLocation();
1398 StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1399 List<String> locIdList = new ArrayList<String>();
1400 while (tokenizer.hasMoreTokens()) {
1401 String locId = tokenizer.nextToken();
1402 locIdList.add(locId);
1405 // at least,one location element needs to be here!
1406 assert (locIdList.size() > 0);
1408 // assume that loc with idx 0 comes from the local lattice
1409 // loc with idx 1 comes from the field lattice
1411 String localLocId = locIdList.get(0);
1412 SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1413 Location localLoc = new Location(md, localLocId);
1414 if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1415 System.out.println("locDec=" + locDec);
1416 throw new Error("Location " + localLocId
1417 + " is not defined in the local variable lattice at "
1418 + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : md) + ".");
1420 compLoc.addLocation(localLoc);
1422 for (int i = 1; i < locIdList.size(); i++) {
1423 String locName = locIdList.get(i);
1426 parseFieldLocDeclaraton(locName, generateErrorMessage(md.getClassDesc(), n));
1427 compLoc.addLocation(fieldLoc);
1428 } catch (Exception e) {
1429 throw new Error("The location declaration '" + locName + "' is wrong at "
1430 + generateErrorMessage(md.getClassDesc(), n));
1438 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1439 VarDescriptor vd = dn.getVarDescriptor();
1440 assignLocationOfVarDescriptor(vd, md, nametable, dn);
1443 private void checkDeclarationInClass(ClassDescriptor cd) {
1444 // Check to see that fields are okay
1445 for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1446 FieldDescriptor fd = (FieldDescriptor) field_it.next();
1448 if (!(fd.isFinal() && fd.isStatic())) {
1449 checkFieldDeclaration(cd, fd);
1451 // for static final, assign top location by default
1452 Location loc = Location.createTopLocation(cd);
1453 addLocationType(fd.getType(), loc);
1458 private Location checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1460 Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1462 // currently enforce every field to have corresponding location
1463 if (annotationVec.size() == 0) {
1464 throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1465 + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1468 if (annotationVec.size() > 1) {
1469 // variable can have at most one location
1470 throw new Error("Field " + fd.getSymbol() + " of class " + cd
1471 + " has more than one location.");
1474 AnnotationDescriptor ad = annotationVec.elementAt(0);
1475 Location loc = null;
1477 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1478 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1479 String locationID = ad.getValue();
1480 // check if location is defined
1481 SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1482 if (lattice == null || (!lattice.containsKey(locationID))) {
1483 throw new Error("Location " + locationID
1484 + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1485 + cd.getSourceFileName() + ".");
1487 loc = new Location(cd, locationID);
1489 if (ssjava.isSharedLocation(loc)) {
1490 ssjava.mapSharedLocation2Descriptor(loc, fd);
1493 addLocationType(fd.getType(), loc);
1501 private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
1503 type.setExtension(loc);
1507 private void addLocationType(TypeDescriptor type, Location loc) {
1509 type.setExtension(loc);
1513 static class CompositeLattice {
1515 public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1517 System.out.println("\nisGreaterThan=" + loc1 + " " + loc2 + " msg=" + msg);
1518 int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, msg);
1519 if (baseCompareResult == ComparisonResult.EQUAL) {
1520 if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1525 } else if (baseCompareResult == ComparisonResult.GREATER) {
1533 public static int compare(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1535 System.out.println("compare=" + loc1 + " " + loc2);
1536 int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, msg);
1538 if (baseCompareResult == ComparisonResult.EQUAL) {
1539 return compareDelta(loc1, loc2);
1541 return baseCompareResult;
1546 private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1548 int deltaCount1 = 0;
1549 int deltaCount2 = 0;
1550 if (dLoc1 instanceof DeltaLocation) {
1551 deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1554 if (dLoc2 instanceof DeltaLocation) {
1555 deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1557 if (deltaCount1 < deltaCount2) {
1558 return ComparisonResult.GREATER;
1559 } else if (deltaCount1 == deltaCount2) {
1560 return ComparisonResult.EQUAL;
1562 return ComparisonResult.LESS;
1567 private static int compareBaseLocationSet(CompositeLocation compLoc1,
1568 CompositeLocation compLoc2, boolean awareSharedLoc, String msg) {
1570 // if compLoc1 is greater than compLoc2, return true
1571 // else return false;
1573 // compare one by one in according to the order of the tuple
1575 for (int i = 0; i < compLoc1.getSize(); i++) {
1576 Location loc1 = compLoc1.get(i);
1577 if (i >= compLoc2.getSize()) {
1578 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1579 + " because they are not comparable at " + msg);
1581 Location loc2 = compLoc2.get(i);
1583 Descriptor d1 = loc1.getDescriptor();
1584 Descriptor d2 = loc2.getDescriptor();
1586 Descriptor descriptor;
1588 if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
1590 if (d1.equals(d2)) {
1593 // identifying which one is parent class
1594 Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
1595 Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
1597 if (d1 == null && d2 == null) {
1598 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1599 + " because they are not comparable at " + msg);
1600 } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
1602 } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
1605 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1606 + " because they are not comparable at " + msg);
1610 } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
1612 if (d1.equals(d2)) {
1616 // identifying which one is parent class
1617 MethodDescriptor md1 = (MethodDescriptor) d1;
1618 MethodDescriptor md2 = (MethodDescriptor) d2;
1620 if (!md1.matches(md2)) {
1621 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1622 + " because they are not comparable at " + msg);
1625 Set<Descriptor> d1SubClassesSet =
1626 ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
1627 Set<Descriptor> d2SubClassesSet =
1628 ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
1630 if (d1 == null && d2 == null) {
1631 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1632 + " because they are not comparable at " + msg);
1633 } else if (d1 != null && d1SubClassesSet.contains(d2)) {
1635 } else if (d2 != null && d2SubClassesSet.contains(d1)) {
1638 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1639 + " because they are not comparable at " + msg);
1644 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1645 + " because they are not comparable at " + msg);
1648 // SSJavaLattice<String> lattice1 = getLatticeByDescriptor(d1);
1649 // SSJavaLattice<String> lattice2 = getLatticeByDescriptor(d2);
1651 SSJavaLattice<String> lattice = getLatticeByDescriptor(descriptor);
1653 // check if the spin location is appeared only at the end of the
1654 // composite location
1655 if (lattice.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1656 if (i != (compLoc1.getSize() - 1)) {
1657 throw new Error("The shared location " + loc1.getLocIdentifier()
1658 + " cannot be appeared in the middle of composite location at" + msg);
1662 if (lattice.getSpinLocSet().contains(loc2.getLocIdentifier())) {
1663 if (i != (compLoc2.getSize() - 1)) {
1664 throw new Error("The spin location " + loc2.getLocIdentifier()
1665 + " cannot be appeared in the middle of composite location at " + msg);
1669 // if (!lattice1.equals(lattice2)) {
1670 // throw new Error("Failed to compare two locations of " + compLoc1 +
1671 // " and " + compLoc2
1672 // + " because they are not comparable at " + msg);
1675 if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1677 // check if the current location is the spinning location
1678 // note that the spinning location only can be appeared in the last
1679 // part of the composite location
1680 if (awareSharedLoc && numOfTie == compLoc1.getSize()
1681 && lattice.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1682 return ComparisonResult.GREATER;
1685 } else if (lattice.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1686 return ComparisonResult.GREATER;
1688 return ComparisonResult.LESS;
1693 if (numOfTie == compLoc1.getSize()) {
1695 if (numOfTie != compLoc2.getSize()) {
1696 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1697 + " because they are not comparable at " + msg);
1700 return ComparisonResult.EQUAL;
1703 return ComparisonResult.LESS;
1707 public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet, String errMsg) {
1709 System.out.println("Calculating GLB=" + inputSet);
1710 CompositeLocation glbCompLoc = new CompositeLocation();
1712 // calculate GLB of the first(priority) element
1713 Set<String> priorityLocIdentifierSet = new HashSet<String>();
1714 Descriptor priorityDescriptor = null;
1716 Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1717 new Hashtable<String, Set<CompositeLocation>>();
1718 // mapping from the priority loc ID to its full representation by the
1719 // composite location
1721 int maxTupleSize = 0;
1722 CompositeLocation maxCompLoc = null;
1724 Location prevPriorityLoc = null;
1725 for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1726 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1727 if (compLoc.getSize() > maxTupleSize) {
1728 maxTupleSize = compLoc.getSize();
1729 maxCompLoc = compLoc;
1731 Location priorityLoc = compLoc.get(0);
1732 String priorityLocId = priorityLoc.getLocIdentifier();
1733 priorityLocIdentifierSet.add(priorityLocId);
1735 if (locId2CompLocSet.containsKey(priorityLocId)) {
1736 locId2CompLocSet.get(priorityLocId).add(compLoc);
1738 Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1739 newSet.add(compLoc);
1740 locId2CompLocSet.put(priorityLocId, newSet);
1743 // check if priority location are coming from the same lattice
1744 if (priorityDescriptor == null) {
1745 priorityDescriptor = priorityLoc.getDescriptor();
1747 priorityDescriptor = getCommonParentDescriptor(priorityLoc, prevPriorityLoc, errMsg);
1749 prevPriorityLoc = priorityLoc;
1750 // else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1751 // throw new Error("Failed to calculate GLB of " + inputSet
1752 // + " because they are from different lattices.");
1756 SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1757 String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1759 glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1760 Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1762 if (compSet == null) {
1763 // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1764 // mean that the result is already lower than <x1,y1> and <x2,y2>
1765 // assign TOP to the rest of the location elements
1767 // in this case, do not take care about delta
1768 // CompositeLocation inputComp = inputSet.iterator().next();
1769 for (int i = 1; i < maxTupleSize; i++) {
1770 glbCompLoc.addLocation(Location.createTopLocation(maxCompLoc.get(i).getDescriptor()));
1774 // here find out composite location that has a maximum length tuple
1775 // if we have three input set: [A], [A,B], [A,B,C]
1776 // maximum length tuple will be [A,B,C]
1778 CompositeLocation maxFromCompSet = null;
1779 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1780 CompositeLocation c = (CompositeLocation) iterator.next();
1781 if (c.getSize() > max) {
1787 if (compSet.size() == 1) {
1788 // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
1789 CompositeLocation comp = compSet.iterator().next();
1790 for (int i = 1; i < comp.getSize(); i++) {
1791 glbCompLoc.addLocation(comp.get(i));
1794 // if input location corresponding to glb is a delta, need to apply
1795 // delta to glb result
1796 if (comp instanceof DeltaLocation) {
1797 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1801 // when GLB(x1,x2)==x1 and x2 : GLB case 1
1802 // if more than one location shares the same priority GLB
1803 // need to calculate the rest of GLB loc
1805 // setup input set starting from the second tuple item
1806 Set<CompositeLocation> innerGLBInput = new HashSet<CompositeLocation>();
1807 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1808 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1809 CompositeLocation innerCompLoc = new CompositeLocation();
1810 for (int idx = 1; idx < compLoc.getSize(); idx++) {
1811 innerCompLoc.addLocation(compLoc.get(idx));
1813 if (innerCompLoc.getSize() > 0) {
1814 innerGLBInput.add(innerCompLoc);
1818 if (innerGLBInput.size() > 0) {
1819 CompositeLocation innerGLB = CompositeLattice.calculateGLB(innerGLBInput, errMsg);
1820 for (int idx = 0; idx < innerGLB.getSize(); idx++) {
1821 glbCompLoc.addLocation(innerGLB.get(idx));
1825 // if input location corresponding to glb is a delta, need to apply
1826 // delta to glb result
1828 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1829 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1830 if (compLoc instanceof DeltaLocation) {
1831 if (glbCompLoc.equals(compLoc)) {
1832 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1841 System.out.println("GLB=" + glbCompLoc);
1846 static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
1848 SSJavaLattice<String> lattice = null;
1850 if (d instanceof ClassDescriptor) {
1851 lattice = ssjava.getCd2lattice().get(d);
1852 } else if (d instanceof MethodDescriptor) {
1853 if (ssjava.getMd2lattice().containsKey(d)) {
1854 lattice = ssjava.getMd2lattice().get(d);
1856 // use default lattice for the method
1857 lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
1864 static Descriptor getCommonParentDescriptor(Location loc1, Location loc2, String msg) {
1866 Descriptor d1 = loc1.getDescriptor();
1867 Descriptor d2 = loc2.getDescriptor();
1869 Descriptor descriptor;
1871 if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
1873 if (d1.equals(d2)) {
1876 // identifying which one is parent class
1877 Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
1878 Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
1880 if (d1 == null && d2 == null) {
1881 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
1882 + " because they are not comparable at " + msg);
1883 } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
1885 } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
1888 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
1889 + " because they are not comparable at " + msg);
1893 } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
1895 if (d1.equals(d2)) {
1899 // identifying which one is parent class
1900 MethodDescriptor md1 = (MethodDescriptor) d1;
1901 MethodDescriptor md2 = (MethodDescriptor) d2;
1903 if (!md1.matches(md2)) {
1904 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
1905 + " because they are not comparable at " + msg);
1908 Set<Descriptor> d1SubClassesSet =
1909 ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
1910 Set<Descriptor> d2SubClassesSet =
1911 ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
1913 if (d1 == null && d2 == null) {
1914 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
1915 + " because they are not comparable at " + msg);
1916 } else if (d1 != null && d1SubClassesSet.contains(d2)) {
1918 } else if (d2 != null && d2SubClassesSet.contains(d1)) {
1921 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
1922 + " because they are not comparable at " + msg);
1927 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
1928 + " because they are not comparable at " + msg);
1937 class ComparisonResult {
1939 public static final int GREATER = 0;
1940 public static final int EQUAL = 1;
1941 public static final int LESS = 2;
1942 public static final int INCOMPARABLE = 3;
1949 class ReturnLocGenerator {
1951 public static final int PARAMISHIGHER = 0;
1952 public static final int PARAMISSAME = 1;
1953 public static final int IGNORE = 2;
1955 Hashtable<Integer, Integer> paramIdx2paramType;
1957 public ReturnLocGenerator(CompositeLocation returnLoc, List<CompositeLocation> params, String msg) {
1958 // creating mappings
1959 paramIdx2paramType = new Hashtable<Integer, Integer>();
1960 for (int i = 0; i < params.size(); i++) {
1961 CompositeLocation param = params.get(i);
1962 int compareResult = CompositeLattice.compare(param, returnLoc, msg);
1965 if (compareResult == ComparisonResult.GREATER) {
1967 } else if (compareResult == ComparisonResult.EQUAL) {
1972 paramIdx2paramType.put(new Integer(i), new Integer(type));
1977 public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
1979 // compute the highest possible location in caller's side
1980 assert paramIdx2paramType.keySet().size() == args.size();
1982 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1983 for (int i = 0; i < args.size(); i++) {
1984 int type = (paramIdx2paramType.get(new Integer(i))).intValue();
1985 CompositeLocation argLoc = args.get(i);
1986 if (type == PARAMISHIGHER) {
1987 // return loc is lower than param
1988 DeltaLocation delta = new DeltaLocation(argLoc, 1);
1989 inputGLB.add(delta);
1990 } else if (type == PARAMISSAME) {
1991 // return loc is equal or lower than param
1992 inputGLB.add(argLoc);
1996 // compute GLB of arguments subset that are same or higher than return
1998 CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB, "");