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.TypeExtension;
27 import IR.VarDescriptor;
28 import IR.Tree.ArrayAccessNode;
29 import IR.Tree.AssignmentNode;
30 import IR.Tree.BlockExpressionNode;
31 import IR.Tree.BlockNode;
32 import IR.Tree.BlockStatementNode;
33 import IR.Tree.CastNode;
34 import IR.Tree.CreateObjectNode;
35 import IR.Tree.DeclarationNode;
36 import IR.Tree.ExpressionNode;
37 import IR.Tree.FieldAccessNode;
38 import IR.Tree.IfStatementNode;
40 import IR.Tree.LiteralNode;
41 import IR.Tree.LoopNode;
42 import IR.Tree.MethodInvokeNode;
43 import IR.Tree.NameNode;
44 import IR.Tree.OpNode;
45 import IR.Tree.ReturnNode;
46 import IR.Tree.SubBlockNode;
47 import IR.Tree.SwitchBlockNode;
48 import IR.Tree.SwitchStatementNode;
49 import IR.Tree.SynchronizedNode;
50 import IR.Tree.TertiaryNode;
51 import IR.Tree.TreeNode;
54 public class FlowDownCheck {
57 static SSJavaAnalysis ssjava;
59 Set<ClassDescriptor> toanalyze;
60 List<ClassDescriptor> toanalyzeList;
62 Set<MethodDescriptor> toanalyzeMethod;
63 List<MethodDescriptor> toanalyzeMethodList;
65 // mapping from 'descriptor' to 'composite location'
66 Hashtable<Descriptor, CompositeLocation> d2loc;
68 Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
69 Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
71 // mapping from 'locID' to 'class descriptor'
72 Hashtable<String, ClassDescriptor> fieldLocName2cd;
74 boolean deterministic = true;
76 public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
80 this.toanalyzeList = new ArrayList<ClassDescriptor>();
82 this.toanalyze = new HashSet<ClassDescriptor>();
85 this.toanalyzeMethodList = new ArrayList<MethodDescriptor>();
87 this.toanalyzeMethod = new HashSet<MethodDescriptor>();
89 this.d2loc = new Hashtable<Descriptor, CompositeLocation>();
90 this.fieldLocName2cd = new Hashtable<String, ClassDescriptor>();
91 this.md2ReturnLoc = new Hashtable<MethodDescriptor, CompositeLocation>();
92 this.md2ReturnLocGen = new Hashtable<MethodDescriptor, ReturnLocGenerator>();
97 // construct mapping from the location name to the class descriptor
98 // assume that the location name is unique through the whole program
100 Set<ClassDescriptor> cdSet = ssjava.getCd2lattice().keySet();
101 for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
102 ClassDescriptor cd = (ClassDescriptor) iterator.next();
103 SSJavaLattice<String> lattice = ssjava.getCd2lattice().get(cd);
104 Set<String> fieldLocNameSet = lattice.getKeySet();
106 for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
107 String fieldLocName = (String) iterator2.next();
108 fieldLocName2cd.put(fieldLocName, cd);
115 public boolean toAnalyzeIsEmpty() {
117 return toanalyzeList.isEmpty();
119 return toanalyze.isEmpty();
123 public ClassDescriptor toAnalyzeNext() {
125 return toanalyzeList.remove(0);
127 ClassDescriptor cd = toanalyze.iterator().next();
128 toanalyze.remove(cd);
133 public void setupToAnalyze() {
134 SymbolTable classtable = state.getClassSymbolTable();
136 toanalyzeList.clear();
137 toanalyzeList.addAll(classtable.getValueSet());
138 Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
139 public int compare(ClassDescriptor o1, ClassDescriptor o2) {
140 return o1.getClassName().compareToIgnoreCase(o2.getClassName());
145 toanalyze.addAll(classtable.getValueSet());
149 public void setupToAnalazeMethod(ClassDescriptor cd) {
151 SymbolTable methodtable = cd.getMethodTable();
153 toanalyzeMethodList.clear();
154 toanalyzeMethodList.addAll(methodtable.getValueSet());
155 Collections.sort(toanalyzeMethodList, new Comparator<MethodDescriptor>() {
156 public int compare(MethodDescriptor o1, MethodDescriptor o2) {
157 return o1.getSymbol().compareToIgnoreCase(o2.getSymbol());
161 toanalyzeMethod.clear();
162 toanalyzeMethod.addAll(methodtable.getValueSet());
166 public boolean toAnalyzeMethodIsEmpty() {
168 return toanalyzeMethodList.isEmpty();
170 return toanalyzeMethod.isEmpty();
174 public MethodDescriptor toAnalyzeMethodNext() {
176 return toanalyzeMethodList.remove(0);
178 MethodDescriptor md = toanalyzeMethod.iterator().next();
179 toanalyzeMethod.remove(md);
184 public void flowDownCheck() {
186 // phase 1 : checking declaration node and creating mapping of 'type
187 // desciptor' & 'location'
190 while (!toAnalyzeIsEmpty()) {
191 ClassDescriptor cd = toAnalyzeNext();
193 if (ssjava.needToBeAnnoated(cd)) {
195 ClassDescriptor superDesc = cd.getSuperDesc();
197 if (superDesc != null && (!superDesc.getSymbol().equals("Object"))) {
198 checkOrderingInheritance(superDesc, cd);
201 checkDeclarationInClass(cd);
203 setupToAnalazeMethod(cd);
204 while (!toAnalyzeMethodIsEmpty()) {
205 MethodDescriptor md = toAnalyzeMethodNext();
206 if (ssjava.needTobeAnnotated(md)) {
207 checkDeclarationInMethodBody(cd, md);
215 // phase2 : checking assignments
218 while (!toAnalyzeIsEmpty()) {
219 ClassDescriptor cd = toAnalyzeNext();
221 setupToAnalazeMethod(cd);
222 while (!toAnalyzeMethodIsEmpty()) {
223 MethodDescriptor md = toAnalyzeMethodNext();
224 if (ssjava.needTobeAnnotated(md)) {
225 if (state.SSJAVADEBUG) {
226 System.out.println("SSJAVA: Checking Flow-down Rules: " + md);
228 checkMethodBody(cd, md, null);
235 private void checkOrderingInheritance(ClassDescriptor superCd, ClassDescriptor cd) {
236 // here, we're going to check that sub class keeps same relative orderings
237 // in respect to super class
239 SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
240 SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
242 if (superLattice != null) {
243 // if super class doesn't define lattice, then we don't need to check its
245 if (subLattice == null) {
246 throw new Error("If a parent class '" + superCd
247 + "' has a ordering lattice, its subclass '" + cd + "' should have one.");
250 Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
251 Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
253 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
254 Pair<String, String> pair = (Pair<String, String>) iterator.next();
256 if (!subPairSet.contains(pair)) {
257 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
258 + pair.getSecond() + " < " + pair.getFirst()
259 + "' that is defined by its superclass '" + superCd + "'.");
264 MethodLattice<String> superMethodDefaultLattice = ssjava.getMethodDefaultLattice(superCd);
265 MethodLattice<String> subMethodDefaultLattice = ssjava.getMethodDefaultLattice(cd);
267 if (superMethodDefaultLattice != null) {
268 if (subMethodDefaultLattice == null) {
269 throw new Error("When a parent class '" + superCd
270 + "' defines a default method lattice, its subclass '" + cd + "' should define one.");
273 Set<Pair<String, String>> superPairSet = superMethodDefaultLattice.getOrderingPairSet();
274 Set<Pair<String, String>> subPairSet = subMethodDefaultLattice.getOrderingPairSet();
276 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
277 Pair<String, String> pair = (Pair<String, String>) iterator.next();
279 if (!subPairSet.contains(pair)) {
280 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
281 + pair.getSecond() + " < " + pair.getFirst()
282 + "' that is defined by its superclass '" + superCd
283 + "' in the method default lattice.");
291 public Hashtable getMap() {
295 private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
296 BlockNode bn = state.getMethodBody(md);
298 // first, check annotations on method parameters
299 List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
300 for (int i = 0; i < md.numParameters(); i++) {
301 // process annotations on method parameters
302 VarDescriptor vd = (VarDescriptor) md.getParameter(i);
303 assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), null);
304 paramList.add(d2loc.get(vd));
306 Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
308 // second, check return location annotation
309 if (!md.getReturnType().isVoid()) {
310 CompositeLocation returnLocComp = null;
312 boolean hasReturnLocDeclaration = false;
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);
320 hasReturnLocDeclaration = true;
325 if (!hasReturnLocDeclaration) {
326 // if developer does not define method lattice
327 // search return location in the method default lattice
328 String rtrStr = ssjava.getMethodLattice(md).getReturnLoc();
329 if (rtrStr != null) {
330 returnLocComp = new CompositeLocation(new Location(md, rtrStr));
334 if (returnLocComp == null) {
335 throw new Error("Return location is not specified for the method " + md + " at "
336 + cd.getSourceFileName());
339 md2ReturnLoc.put(md, returnLocComp);
341 // check this location
342 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
343 String thisLocId = methodLattice.getThisLoc();
344 if (thisLocId == null) {
345 throw new Error("Method '" + md + "' does not have the definition of 'this' location at "
346 + md.getClassDesc().getSourceFileName());
348 CompositeLocation thisLoc = new CompositeLocation(new Location(md, thisLocId));
349 paramList.add(0, thisLoc);
351 // System.out.println("### ReturnLocGenerator=" + md);
352 // System.out.println("### md2ReturnLoc.get(md)=" + md2ReturnLoc.get(md));
354 md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), md, paramList, md
355 + " of " + 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 CompositeLocation constraints) {
442 BlockNode bn = state.getMethodBody(md);
443 checkLocationFromBlockNode(md, md.getParameterTable(), bn, constraints);
446 private String generateErrorMessage(ClassDescriptor cd, TreeNode tn) {
448 return cd.getSourceFileName() + "::" + tn.getNumLine();
450 return cd.getSourceFileName();
455 private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
456 BlockNode bn, CompositeLocation constraint) {
458 bn.getVarTable().setParent(nametable);
459 for (int i = 0; i < bn.size(); i++) {
460 BlockStatementNode bsn = bn.get(i);
461 checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn, constraint);
463 return new CompositeLocation();
467 private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
468 SymbolTable nametable, BlockStatementNode bsn, CompositeLocation constraint) {
470 CompositeLocation compLoc = null;
471 switch (bsn.kind()) {
472 case Kind.BlockExpressionNode:
474 checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, constraint);
477 case Kind.DeclarationNode:
478 compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn, constraint);
481 case Kind.IfStatementNode:
482 compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn, constraint);
486 compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn, constraint);
489 case Kind.ReturnNode:
490 compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn, constraint);
493 case Kind.SubBlockNode:
494 compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn, constraint);
497 case Kind.ContinueBreakNode:
498 compLoc = new CompositeLocation();
501 case Kind.SwitchStatementNode:
503 checkLocationFromSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, constraint);
509 private CompositeLocation checkLocationFromSwitchStatementNode(MethodDescriptor md,
510 SymbolTable nametable, SwitchStatementNode ssn, CompositeLocation constraint) {
512 ClassDescriptor cd = md.getClassDesc();
513 CompositeLocation condLoc =
514 checkLocationFromExpressionNode(md, nametable, ssn.getCondition(), new CompositeLocation(),
516 BlockNode sbn = ssn.getSwitchBody();
518 constraint = generateNewConstraint(constraint, condLoc);
520 for (int i = 0; i < sbn.size(); i++) {
521 checkLocationFromSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), constraint);
523 return new CompositeLocation();
526 private CompositeLocation checkLocationFromSwitchBlockNode(MethodDescriptor md,
527 SymbolTable nametable, SwitchBlockNode sbn, CompositeLocation constraint) {
529 CompositeLocation blockLoc =
530 checkLocationFromBlockNode(md, nametable, sbn.getSwitchBlockStatement(), constraint);
536 private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
537 ReturnNode rn, CompositeLocation constraint) {
539 ExpressionNode returnExp = rn.getReturnExpression();
541 CompositeLocation returnValueLoc;
542 if (returnExp != null) {
544 checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation(),
547 // System.out.println("# RETURN VALUE LOC=" + returnValueLoc +
548 // " with constraint=" + constraint);
550 // TODO: do we need to check here?
551 // if this return statement is inside branch, return value has an implicit
552 // flow from conditional location
553 // if (constraint != null) {
554 // Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
555 // inputGLB.add(returnValueLoc);
556 // inputGLB.add(constraint);
558 // CompositeLattice.calculateGLB(inputGLB,
559 // generateErrorMessage(md.getClassDesc(), rn));
562 // check if return value is equal or higher than RETRUNLOC of method
563 // declaration annotation
564 CompositeLocation declaredReturnLoc = md2ReturnLoc.get(md);
567 CompositeLattice.compare(returnValueLoc, declaredReturnLoc, false,
568 generateErrorMessage(md.getClassDesc(), rn));
570 if (compareResult == ComparisonResult.LESS || compareResult == ComparisonResult.INCOMPARABLE) {
572 "Return value location is not equal or higher than the declaraed return location at "
573 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
577 return new CompositeLocation();
580 private boolean hasOnlyLiteralValue(ExpressionNode en) {
581 if (en.kind() == Kind.LiteralNode) {
588 private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
589 LoopNode ln, CompositeLocation constraint) {
591 ClassDescriptor cd = md.getClassDesc();
592 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
594 CompositeLocation condLoc =
595 checkLocationFromExpressionNode(md, nametable, ln.getCondition(),
596 new CompositeLocation(), constraint, false);
597 // addLocationType(ln.getCondition().getType(), (condLoc));
599 constraint = generateNewConstraint(constraint, condLoc);
600 checkLocationFromBlockNode(md, nametable, ln.getBody(), constraint);
602 return new CompositeLocation();
605 // check 'for loop' case
606 BlockNode bn = ln.getInitializer();
607 bn.getVarTable().setParent(nametable);
609 // calculate glb location of condition and update statements
610 CompositeLocation condLoc =
611 checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
612 new CompositeLocation(), constraint, false);
613 // addLocationType(ln.getCondition().getType(), condLoc);
615 constraint = generateNewConstraint(constraint, condLoc);
617 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate(), constraint);
618 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody(), constraint);
620 return new CompositeLocation();
626 private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
627 SymbolTable nametable, SubBlockNode sbn, CompositeLocation constraint) {
628 CompositeLocation compLoc =
629 checkLocationFromBlockNode(md, nametable, sbn.getBlockNode(), constraint);
633 private CompositeLocation generateNewConstraint(CompositeLocation currentCon,
634 CompositeLocation newCon) {
636 if (currentCon == null) {
639 // compute GLB of current constraint and new constraint
640 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
641 inputSet.add(currentCon);
642 inputSet.add(newCon);
643 return CompositeLattice.calculateGLB(inputSet, "");
648 private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
649 SymbolTable nametable, IfStatementNode isn, CompositeLocation constraint) {
651 CompositeLocation condLoc =
652 checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation(),
655 // addLocationType(isn.getCondition().getType(), condLoc);
657 constraint = generateNewConstraint(constraint, condLoc);
658 checkLocationFromBlockNode(md, nametable, isn.getTrueBlock(), constraint);
660 if (isn.getFalseBlock() != null) {
661 checkLocationFromBlockNode(md, nametable, isn.getFalseBlock(), constraint);
664 return new CompositeLocation();
667 private void checkOwnership(MethodDescriptor md, TreeNode tn, ExpressionNode srcExpNode) {
669 if (srcExpNode.kind() == Kind.NameNode || srcExpNode.kind() == Kind.FieldAccessNode) {
670 if (srcExpNode.getType().isPtr() && !srcExpNode.getType().isNull()) {
671 // first, check the linear type
672 // RHS reference should be owned by the current method
673 FieldDescriptor fd = getFieldDescriptorFromExpressionNode(srcExpNode);
677 isOwned = ((SSJavaType) srcExpNode.getType().getExtension()).isOwned();
680 isOwned = ssjava.isOwnedByMethod(md, fd);
684 "It is now allowed to create the reference alias from the reference not owned by the method at "
685 + generateErrorMessage(md.getClassDesc(), tn));
693 private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
694 SymbolTable nametable, DeclarationNode dn, CompositeLocation constraint) {
696 VarDescriptor vd = dn.getVarDescriptor();
698 CompositeLocation destLoc = d2loc.get(vd);
700 if (dn.getExpression() != null) {
702 checkOwnership(md, dn, dn.getExpression());
704 CompositeLocation expressionLoc =
705 checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
706 new CompositeLocation(), constraint, false);
707 // addTypeLocation(dn.getExpression().getType(), expressionLoc);
709 if (expressionLoc != null) {
711 // checking location order
712 if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc,
713 generateErrorMessage(md.getClassDesc(), dn))) {
714 throw new Error("The value flow from " + expressionLoc + " to " + destLoc
715 + " does not respect location hierarchy on the assignment " + dn.printNode(0)
716 + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
719 return expressionLoc;
723 return new CompositeLocation();
729 private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
731 checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
734 private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
735 SymbolTable nametable, BlockExpressionNode ben, CompositeLocation constraint) {
736 CompositeLocation compLoc =
737 checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null, constraint, false);
738 // addTypeLocation(ben.getExpression().getType(), compLoc);
742 private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
743 SymbolTable nametable, ExpressionNode en, CompositeLocation loc,
744 CompositeLocation constraint, boolean isLHS) {
746 CompositeLocation compLoc = null;
749 case Kind.AssignmentNode:
751 checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc, constraint);
754 case Kind.FieldAccessNode:
756 checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc, constraint);
760 compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc, constraint);
764 compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en, constraint);
767 case Kind.CreateObjectNode:
768 compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
771 case Kind.ArrayAccessNode:
773 checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en, constraint, isLHS);
776 case Kind.LiteralNode:
777 compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
780 case Kind.MethodInvokeNode:
782 checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc, constraint);
785 case Kind.TertiaryNode:
786 compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en, constraint);
790 compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en, constraint);
793 // case Kind.InstanceOfNode:
794 // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
797 // case Kind.ArrayInitializerNode:
798 // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
802 // case Kind.ClassTypeNode:
803 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
806 // case Kind.OffsetNode:
807 // checkOffsetNode(md, nametable, (OffsetNode)en, td);
814 // addTypeLocation(en.getType(), compLoc);
819 private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
820 CastNode cn, CompositeLocation constraint) {
822 ExpressionNode en = cn.getExpression();
823 return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
828 private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
829 SymbolTable nametable, TertiaryNode tn, CompositeLocation constraint) {
830 ClassDescriptor cd = md.getClassDesc();
832 CompositeLocation condLoc =
833 checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation(),
835 // addLocationType(tn.getCond().getType(), condLoc);
836 CompositeLocation trueLoc =
837 checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation(),
839 // addLocationType(tn.getTrueExpr().getType(), trueLoc);
840 CompositeLocation falseLoc =
841 checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation(),
843 // addLocationType(tn.getFalseExpr().getType(), falseLoc);
845 // locations from true/false branches can be TOP when there are only literal
847 // in this case, we don't need to check flow down rule!
849 // System.out.println("\n#tertiary cond=" + tn.getCond().printNode(0) +
850 // " Loc=" + condLoc);
851 // System.out.println("# true=" + tn.getTrueExpr().printNode(0) + " Loc=" +
853 // System.out.println("# false=" + tn.getFalseExpr().printNode(0) + " Loc="
856 // check if condLoc is higher than trueLoc & falseLoc
857 if (!trueLoc.get(0).isTop()
858 && !CompositeLattice.isGreaterThan(condLoc, trueLoc, generateErrorMessage(cd, tn))) {
860 "The location of the condition expression is lower than the true expression at "
861 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
864 if (!falseLoc.get(0).isTop()
865 && !CompositeLattice.isGreaterThan(condLoc, falseLoc,
866 generateErrorMessage(cd, tn.getCond()))) {
868 "The location of the condition expression is lower than the false expression at "
869 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
872 // then, return glb of trueLoc & falseLoc
873 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
874 glbInputSet.add(trueLoc);
875 glbInputSet.add(falseLoc);
877 if (glbInputSet.size() == 1) {
880 return CompositeLattice.calculateGLB(glbInputSet, generateErrorMessage(cd, tn));
885 private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
886 SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc,
887 CompositeLocation constraint) {
889 ClassDescriptor cd = md.getClassDesc();
890 MethodDescriptor calleeMD = min.getMethod();
892 NameDescriptor baseName = min.getBaseName();
893 boolean isSystemout = false;
894 if (baseName != null) {
895 isSystemout = baseName.getSymbol().equals("System.out");
898 if (!ssjava.isSSJavaUtil(calleeMD.getClassDesc()) && !ssjava.isTrustMethod(calleeMD)
899 && !calleeMD.getModifiers().isNative() && !isSystemout) {
901 CompositeLocation baseLocation = null;
902 if (min.getExpression() != null) {
904 checkLocationFromExpressionNode(md, nametable, min.getExpression(),
905 new CompositeLocation(), constraint, false);
907 if (min.getMethod().isStatic()) {
908 String globalLocId = ssjava.getMethodLattice(md).getGlobalLoc();
909 if (globalLocId == null) {
910 throw new Error("Method lattice does not define global variable location at "
911 + generateErrorMessage(md.getClassDesc(), min));
913 baseLocation = new CompositeLocation(new Location(md, globalLocId));
915 String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
916 baseLocation = new CompositeLocation(new Location(md, thisLocId));
920 // System.out.println("\n#checkLocationFromMethodInvokeNode=" +
922 // + " baseLocation=" + baseLocation + " constraint=" + constraint);
924 if (constraint != null) {
926 CompositeLattice.compare(constraint, baseLocation, true, generateErrorMessage(cd, min));
927 if (compareResult != ComparisonResult.GREATER) {
928 // if the current constraint is higher than method's THIS location
929 // no need to check constraints!
930 CompositeLocation calleeConstraint =
931 translateCallerLocToCalleeLoc(calleeMD, baseLocation, constraint);
932 // System.out.println("check method body for constraint:" + calleeMD +
933 // " calleeConstraint="
934 // + calleeConstraint);
935 checkMethodBody(calleeMD.getClassDesc(), calleeMD, calleeConstraint);
939 checkCalleeConstraints(md, nametable, min, baseLocation, constraint);
941 // checkCallerArgumentLocationConstraints(md, nametable, min,
942 // baseLocation, constraint);
944 if (!min.getMethod().getReturnType().isVoid()) {
945 // If method has a return value, compute the highest possible return
946 // location in the caller's perspective
947 CompositeLocation ceilingLoc =
948 computeCeilingLocationForCaller(md, nametable, min, baseLocation, constraint);
953 return new CompositeLocation(Location.createTopLocation(md));
957 private CompositeLocation translateCallerLocToCalleeLoc(MethodDescriptor calleeMD,
958 CompositeLocation calleeBaseLoc, CompositeLocation constraint) {
960 CompositeLocation calleeConstraint = new CompositeLocation();
962 // if (constraint.startsWith(calleeBaseLoc)) {
963 // if the first part of constraint loc is matched with callee base loc
964 Location thisLoc = new Location(calleeMD, ssjava.getMethodLattice(calleeMD).getThisLoc());
965 calleeConstraint.addLocation(thisLoc);
966 for (int i = calleeBaseLoc.getSize(); i < constraint.getSize(); i++) {
967 calleeConstraint.addLocation(constraint.get(i));
972 return calleeConstraint;
975 private void checkCallerArgumentLocationConstraints(MethodDescriptor md, SymbolTable nametable,
976 MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
977 // if parameter location consists of THIS and FIELD location,
978 // caller should pass an argument that is comparable to the declared
979 // parameter location
980 // and is not lower than the declared parameter location in the field
983 MethodDescriptor calleemd = min.getMethod();
985 List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
986 List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
988 MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
989 Location calleeThisLoc = new Location(calleemd, calleeLattice.getThisLoc());
991 for (int i = 0; i < min.numArgs(); i++) {
992 ExpressionNode en = min.getArg(i);
993 CompositeLocation callerArgLoc =
994 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
996 callerArgList.add(callerArgLoc);
999 // setup callee params set
1000 for (int i = 0; i < calleemd.numParameters(); i++) {
1001 VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
1002 CompositeLocation calleeLoc = d2loc.get(calleevd);
1003 calleeParamList.add(calleeLoc);
1006 String errorMsg = generateErrorMessage(md.getClassDesc(), min);
1008 // System.out.println("checkCallerArgumentLocationConstraints=" +
1009 // min.printNode(0));
1010 // System.out.println("base location=" + callerBaseLoc + " constraint=" +
1013 for (int i = 0; i < calleeParamList.size(); i++) {
1014 CompositeLocation calleeParamLoc = calleeParamList.get(i);
1015 if (calleeParamLoc.get(0).equals(calleeThisLoc) && calleeParamLoc.getSize() > 1) {
1017 // callee parameter location has field information
1018 CompositeLocation callerArgLoc = callerArgList.get(i);
1020 CompositeLocation paramLocation =
1021 translateCalleeParamLocToCaller(md, calleeParamLoc, callerBaseLoc, errorMsg);
1023 Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1024 if (constraint != null) {
1025 inputGLBSet.add(callerArgLoc);
1026 inputGLBSet.add(constraint);
1028 CompositeLattice.calculateGLB(inputGLBSet,
1029 generateErrorMessage(md.getClassDesc(), min));
1032 if (!CompositeLattice.isGreaterThan(callerArgLoc, paramLocation, errorMsg)) {
1033 throw new Error("Caller argument '" + min.getArg(i).printNode(0) + " : " + callerArgLoc
1034 + "' should be higher than corresponding callee's parameter : " + paramLocation
1035 + " at " + errorMsg);
1043 private CompositeLocation translateCalleeParamLocToCaller(MethodDescriptor md,
1044 CompositeLocation calleeParamLoc, CompositeLocation callerBaseLocation, String errorMsg) {
1046 CompositeLocation translate = new CompositeLocation();
1048 for (int i = 0; i < callerBaseLocation.getSize(); i++) {
1049 translate.addLocation(callerBaseLocation.get(i));
1052 for (int i = 1; i < calleeParamLoc.getSize(); i++) {
1053 translate.addLocation(calleeParamLoc.get(i));
1056 // System.out.println("TRANSLATED=" + translate + " from calleeParamLoc=" +
1062 private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
1063 SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation,
1064 CompositeLocation constraint) {
1065 List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
1067 // by default, method has a THIS parameter
1068 argList.add(baseLocation);
1070 for (int i = 0; i < min.numArgs(); i++) {
1071 ExpressionNode en = min.getArg(i);
1072 CompositeLocation callerArg =
1073 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1075 argList.add(callerArg);
1078 // System.out.println("\n## computeReturnLocation=" + min.getMethod() +
1079 // " argList=" + argList);
1080 CompositeLocation ceilLoc = md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
1081 // System.out.println("## ReturnLocation=" + ceilLoc);
1087 private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
1088 MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
1090 // System.out.println("checkCalleeConstraints=" + min.printNode(0));
1092 MethodDescriptor calleemd = min.getMethod();
1094 MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
1095 CompositeLocation calleeThisLoc =
1096 new CompositeLocation(new Location(calleemd, calleeLattice.getThisLoc()));
1098 List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
1099 List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
1101 if (min.numArgs() > 0) {
1102 // caller needs to guarantee that it passes arguments in regarding to
1103 // callee's hierarchy
1105 // setup caller args set
1106 // first, add caller's base(this) location
1107 callerArgList.add(callerBaseLoc);
1108 // second, add caller's arguments
1109 for (int i = 0; i < min.numArgs(); i++) {
1110 ExpressionNode en = min.getArg(i);
1111 CompositeLocation callerArgLoc =
1112 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1114 callerArgList.add(callerArgLoc);
1117 // setup callee params set
1118 // first, add callee's this location
1119 calleeParamList.add(calleeThisLoc);
1120 // second, add callee's parameters
1121 for (int i = 0; i < calleemd.numParameters(); i++) {
1122 VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
1123 CompositeLocation calleeLoc = d2loc.get(calleevd);
1124 // System.out.println("calleevd=" + calleevd + " loc=" + calleeLoc);
1125 calleeParamList.add(calleeLoc);
1128 // here, check if ordering relations among caller's args respect
1129 // ordering relations in-between callee's args
1130 CHECK: for (int i = 0; i < calleeParamList.size(); i++) {
1131 CompositeLocation calleeLoc1 = calleeParamList.get(i);
1132 CompositeLocation callerLoc1 = callerArgList.get(i);
1134 for (int j = 0; j < calleeParamList.size(); j++) {
1136 CompositeLocation calleeLoc2 = calleeParamList.get(j);
1137 CompositeLocation callerLoc2 = callerArgList.get(j);
1139 if (callerLoc1.get(callerLoc1.getSize() - 1).isTop()
1140 || callerLoc2.get(callerLoc2.getSize() - 1).isTop()) {
1144 // System.out.println("calleeLoc1=" + calleeLoc1);
1145 // System.out.println("calleeLoc2=" + calleeLoc2 +
1146 // "calleeParamList=" + calleeParamList);
1149 CompositeLattice.compare(callerLoc1, callerLoc2, true,
1150 generateErrorMessage(md.getClassDesc(), min));
1151 // System.out.println("callerResult=" + callerResult);
1153 CompositeLattice.compare(calleeLoc1, calleeLoc2, true,
1154 generateErrorMessage(md.getClassDesc(), min));
1155 // System.out.println("calleeResult=" + calleeResult);
1157 if (callerResult == ComparisonResult.EQUAL) {
1158 if (ssjava.isSharedLocation(callerLoc1.get(callerLoc1.getSize() - 1))
1159 && ssjava.isSharedLocation(callerLoc2.get(callerLoc2.getSize() - 1))) {
1160 // if both of them are shared locations, promote them to
1161 // "GREATER relation"
1162 callerResult = ComparisonResult.GREATER;
1166 if (calleeResult == ComparisonResult.GREATER
1167 && callerResult != ComparisonResult.GREATER) {
1168 // If calleeLoc1 is higher than calleeLoc2
1169 // then, caller should have same ordering relation in-bet
1170 // callerLoc1 & callerLoc2
1172 String paramName1, paramName2;
1175 paramName1 = "'THIS'";
1177 paramName1 = "'parameter " + calleemd.getParamName(i - 1) + "'";
1181 paramName2 = "'THIS'";
1183 paramName2 = "'parameter " + calleemd.getParamName(j - 1) + "'";
1187 "Caller doesn't respect an ordering relation among method arguments: callee expects that "
1188 + paramName1 + " should be higher than " + paramName2 + " in " + calleemd
1189 + " at " + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
1200 private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
1201 SymbolTable nametable, ArrayAccessNode aan, CompositeLocation constraint, boolean isLHS) {
1203 ClassDescriptor cd = md.getClassDesc();
1205 CompositeLocation arrayLoc =
1206 checkLocationFromExpressionNode(md, nametable, aan.getExpression(),
1207 new CompositeLocation(), constraint, isLHS);
1208 // addTypeLocation(aan.getExpression().getType(), arrayLoc);
1209 CompositeLocation indexLoc =
1210 checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(),
1212 // addTypeLocation(aan.getIndex().getType(), indexLoc);
1215 if (!CompositeLattice.isGreaterThan(indexLoc, arrayLoc, generateErrorMessage(cd, aan))) {
1216 throw new Error("Array index value is not higher than array location at "
1217 + generateErrorMessage(cd, aan));
1221 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1222 inputGLB.add(arrayLoc);
1223 inputGLB.add(indexLoc);
1224 return CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(cd, aan));
1229 private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
1230 SymbolTable nametable, CreateObjectNode con) {
1232 ClassDescriptor cd = md.getClassDesc();
1234 CompositeLocation compLoc = new CompositeLocation();
1235 compLoc.addLocation(Location.createTopLocation(md));
1240 private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
1241 OpNode on, CompositeLocation constraint) {
1243 ClassDescriptor cd = md.getClassDesc();
1244 CompositeLocation leftLoc = new CompositeLocation();
1246 checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc, constraint, false);
1247 // addTypeLocation(on.getLeft().getType(), leftLoc);
1249 CompositeLocation rightLoc = new CompositeLocation();
1250 if (on.getRight() != null) {
1252 checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc, constraint, false);
1253 // addTypeLocation(on.getRight().getType(), rightLoc);
1256 // System.out.println("\n# OP NODE=" + on.printNode(0));
1257 // System.out.println("# left loc=" + leftLoc + " from " +
1258 // on.getLeft().getClass());
1259 // if (on.getRight() != null) {
1260 // System.out.println("# right loc=" + rightLoc + " from " +
1261 // on.getRight().getClass());
1264 Operation op = on.getOp();
1266 switch (op.getOp()) {
1268 case Operation.UNARYPLUS:
1269 case Operation.UNARYMINUS:
1270 case Operation.LOGIC_NOT:
1274 case Operation.LOGIC_OR:
1275 case Operation.LOGIC_AND:
1276 case Operation.COMP:
1277 case Operation.BIT_OR:
1278 case Operation.BIT_XOR:
1279 case Operation.BIT_AND:
1280 case Operation.ISAVAILABLE:
1281 case Operation.EQUAL:
1282 case Operation.NOTEQUAL:
1289 case Operation.MULT:
1292 case Operation.LEFTSHIFT:
1293 case Operation.RIGHTSHIFT:
1294 case Operation.URIGHTSHIFT:
1296 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
1297 inputSet.add(leftLoc);
1298 inputSet.add(rightLoc);
1299 CompositeLocation glbCompLoc =
1300 CompositeLattice.calculateGLB(inputSet, generateErrorMessage(cd, on));
1301 // System.out.println("# glbCompLoc=" + glbCompLoc);
1305 throw new Error(op.toString());
1310 private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
1311 SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
1313 // literal value has the top location so that value can be flowed into any
1315 Location literalLoc = Location.createTopLocation(md);
1316 loc.addLocation(literalLoc);
1321 private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
1322 NameNode nn, CompositeLocation loc, CompositeLocation constraint) {
1324 NameDescriptor nd = nn.getName();
1325 if (nd.getBase() != null) {
1327 checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc, constraint, false);
1329 String varname = nd.toString();
1330 if (varname.equals("this")) {
1332 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
1333 String thisLocId = methodLattice.getThisLoc();
1334 if (thisLocId == null) {
1335 throw new Error("The location for 'this' is not defined at "
1336 + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
1338 Location locElement = new Location(md, thisLocId);
1339 loc.addLocation(locElement);
1344 Descriptor d = (Descriptor) nametable.get(varname);
1346 // CompositeLocation localLoc = null;
1347 if (d instanceof VarDescriptor) {
1348 VarDescriptor vd = (VarDescriptor) d;
1349 // localLoc = d2loc.get(vd);
1350 // the type of var descriptor has a composite location!
1351 loc = ((SSJavaType) vd.getType().getExtension()).getCompLoc().clone();
1352 } else if (d instanceof FieldDescriptor) {
1353 // the type of field descriptor has a location!
1354 FieldDescriptor fd = (FieldDescriptor) d;
1355 if (fd.isStatic()) {
1357 // if it is 'static final', the location has TOP since no one can
1359 loc.addLocation(Location.createTopLocation(md));
1362 // if 'static', the location has pre-assigned global loc
1363 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1364 String globalLocId = localLattice.getGlobalLoc();
1365 if (globalLocId == null) {
1366 throw new Error("Global location element is not defined in the method " + md);
1368 Location globalLoc = new Location(md, globalLocId);
1370 loc.addLocation(globalLoc);
1373 // the location of field access starts from this, followed by field
1375 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1376 Location thisLoc = new Location(md, localLattice.getThisLoc());
1377 loc.addLocation(thisLoc);
1380 Location fieldLoc = (Location) fd.getType().getExtension();
1381 loc.addLocation(fieldLoc);
1382 } else if (d == null) {
1383 // access static field
1384 ClassDescriptor cd = nn.getClassDesc();
1386 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1387 String globalLocId = localLattice.getGlobalLoc();
1388 if (globalLocId == null) {
1389 throw new Error("Method lattice does not define global variable location at "
1390 + generateErrorMessage(md.getClassDesc(), nn));
1392 loc.addLocation(new Location(md, globalLocId));
1400 private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1401 SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc,
1402 CompositeLocation constraint) {
1404 ExpressionNode left = fan.getExpression();
1405 TypeDescriptor ltd = left.getType();
1407 FieldDescriptor fd = fan.getField();
1409 String varName = null;
1410 if (left.kind() == Kind.NameNode) {
1411 NameDescriptor nd = ((NameNode) left).getName();
1412 varName = nd.toString();
1415 if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
1416 // using a class name directly or access using this
1417 if (fd.isStatic() && fd.isFinal()) {
1418 loc.addLocation(Location.createTopLocation(md));
1423 if (left instanceof ArrayAccessNode) {
1424 ArrayAccessNode aan = (ArrayAccessNode) left;
1425 left = aan.getExpression();
1428 loc = checkLocationFromExpressionNode(md, nametable, left, loc, constraint, false);
1429 // System.out.println("### checkLocationFromFieldAccessNode=" +
1430 // fan.printNode(0));
1431 // System.out.println("### left=" + left.printNode(0));
1433 if (left.getType().isArray()) {
1434 // array.length case: return the location of the array
1436 } else if (!left.getType().isPrimitive()) {
1437 Location fieldLoc = getFieldLocation(fd);
1438 loc.addLocation(fieldLoc);
1440 // System.out.println("### field loc=" + loc);
1444 private Location getFieldLocation(FieldDescriptor fd) {
1446 // System.out.println("### getFieldLocation=" + fd);
1447 // System.out.println("### fd.getType().getExtension()=" +
1448 // fd.getType().getExtension());
1450 Location fieldLoc = (Location) fd.getType().getExtension();
1452 // handle the case that method annotation checking skips checking field
1454 if (fieldLoc == null) {
1455 fieldLoc = checkFieldDeclaration(fd.getClassDescriptor(), fd);
1462 private FieldDescriptor getFieldDescriptorFromExpressionNode(ExpressionNode en) {
1464 if (en.kind() == Kind.NameNode) {
1465 NameNode nn = (NameNode) en;
1466 if (nn.getField() != null) {
1467 return nn.getField();
1470 if (nn.getName() != null && nn.getName().getBase() != null) {
1471 return getFieldDescriptorFromExpressionNode(nn.getExpression());
1474 } else if (en.kind() == Kind.FieldAccessNode) {
1475 FieldAccessNode fan = (FieldAccessNode) en;
1476 return fan.getField();
1482 private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1483 SymbolTable nametable, AssignmentNode an, CompositeLocation loc, CompositeLocation constraint) {
1485 // System.out.println("\n# ASSIGNMENTNODE=" + an.printNode(0));
1487 ClassDescriptor cd = md.getClassDesc();
1489 Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1491 boolean postinc = true;
1492 if (an.getOperation().getBaseOp() == null
1493 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1494 .getBaseOp().getOp() != Operation.POSTDEC))
1497 // if LHS is array access node, need to check if array index is higher
1498 // than array itself
1499 CompositeLocation destLocation =
1500 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1503 CompositeLocation rhsLocation;
1504 CompositeLocation srcLocation;
1508 checkOwnership(md, an, an.getSrc());
1511 checkLocationFromExpressionNode(md, nametable, an.getSrc(), new CompositeLocation(),
1514 srcLocation = rhsLocation;
1516 // if (!rhsLocation.get(rhsLocation.getSize() - 1).isTop()) {
1517 if (constraint != null) {
1518 inputGLBSet.add(rhsLocation);
1519 inputGLBSet.add(constraint);
1520 srcLocation = CompositeLattice.calculateGLB(inputGLBSet, generateErrorMessage(cd, an));
1524 // System.out.println("dstLocation=" + destLocation);
1525 // System.out.println("rhsLocation=" + rhsLocation);
1526 // System.out.println("srcLocation=" + srcLocation);
1527 // System.out.println("constraint=" + constraint);
1529 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1531 String context = "";
1532 if (constraint != null) {
1533 context = " and the current context constraint is " + constraint;
1536 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1537 + " does not respect location hierarchy on the assignment " + an.printNode(0) + context
1538 + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1544 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1547 if (constraint != null) {
1548 inputGLBSet.add(rhsLocation);
1549 inputGLBSet.add(constraint);
1550 srcLocation = CompositeLattice.calculateGLB(inputGLBSet, generateErrorMessage(cd, an));
1552 srcLocation = rhsLocation;
1555 // System.out.println("srcLocation=" + srcLocation);
1556 // System.out.println("rhsLocation=" + rhsLocation);
1557 // System.out.println("constraint=" + constraint);
1559 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1561 if (srcLocation.equals(destLocation)) {
1562 throw new Error("Location " + srcLocation
1563 + " is not allowed to have the value flow that moves within the same location at '"
1564 + an.printNode(0) + "' of " + cd.getSourceFileName() + "::" + an.getNumLine());
1566 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1567 + " does not respect location hierarchy on the assignment " + an.printNode(0)
1568 + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1575 return destLocation;
1578 private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1579 SymbolTable nametable, TreeNode n) {
1581 ClassDescriptor cd = md.getClassDesc();
1582 Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1584 // currently enforce every variable to have corresponding location
1585 if (annotationVec.size() == 0) {
1586 throw new Error("Location is not assigned to variable '" + vd.getSymbol()
1587 + "' in the method '" + md + "' of the class " + cd.getSymbol() + " at "
1588 + generateErrorMessage(cd, n));
1591 int locDecCount = 0;
1592 for (int i = 0; i < annotationVec.size(); i++) {
1593 AnnotationDescriptor ad = annotationVec.elementAt(i);
1595 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1597 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1599 if (locDecCount > 1) {// variable can have at most one location
1600 throw new Error(vd.getSymbol() + " has more than one location declaration.");
1602 String locDec = ad.getValue(); // check if location is defined
1604 if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1605 DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1606 d2loc.put(vd, deltaLoc);
1607 addLocationType(vd.getType(), deltaLoc);
1609 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1611 Location lastElement = compLoc.get(compLoc.getSize() - 1);
1612 if (ssjava.isSharedLocation(lastElement)) {
1613 ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1616 d2loc.put(vd, compLoc);
1617 addLocationType(vd.getType(), compLoc);
1626 private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1629 int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1632 int beginIdx = dIdx + 6;
1633 locDec = locDec.substring(beginIdx, locDec.length() - 1);
1634 dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1637 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1638 DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1643 private Location parseFieldLocDeclaraton(String decl, String msg) throws Exception {
1645 int idx = decl.indexOf(".");
1647 String className = decl.substring(0, idx);
1648 String fieldName = decl.substring(idx + 1);
1650 className.replaceAll(" ", "");
1651 fieldName.replaceAll(" ", "");
1653 Descriptor d = state.getClassSymbolTable().get(className);
1656 // System.out.println("state.getClassSymbolTable()=" +
1657 // state.getClassSymbolTable());
1658 throw new Error("The class in the location declaration '" + decl + "' does not exist at "
1662 assert (d instanceof ClassDescriptor);
1663 SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1664 if (!lattice.containsKey(fieldName)) {
1665 throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1666 + className + "' at " + msg);
1669 return new Location(d, fieldName);
1672 private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1674 CompositeLocation compLoc = new CompositeLocation();
1676 StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1677 List<String> locIdList = new ArrayList<String>();
1678 while (tokenizer.hasMoreTokens()) {
1679 String locId = tokenizer.nextToken();
1680 locIdList.add(locId);
1683 // at least,one location element needs to be here!
1684 assert (locIdList.size() > 0);
1686 // assume that loc with idx 0 comes from the local lattice
1687 // loc with idx 1 comes from the field lattice
1689 String localLocId = locIdList.get(0);
1690 SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1691 Location localLoc = new Location(md, localLocId);
1692 if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1693 throw new Error("Location " + localLocId
1694 + " is not defined in the local variable lattice at "
1695 + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : md) + ".");
1697 compLoc.addLocation(localLoc);
1699 for (int i = 1; i < locIdList.size(); i++) {
1700 String locName = locIdList.get(i);
1703 parseFieldLocDeclaraton(locName, generateErrorMessage(md.getClassDesc(), n));
1704 compLoc.addLocation(fieldLoc);
1705 } catch (Exception e) {
1706 throw new Error("The location declaration '" + locName + "' is wrong at "
1707 + generateErrorMessage(md.getClassDesc(), n));
1715 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1716 VarDescriptor vd = dn.getVarDescriptor();
1717 assignLocationOfVarDescriptor(vd, md, nametable, dn);
1720 private void checkDeclarationInClass(ClassDescriptor cd) {
1721 // Check to see that fields are okay
1722 for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1723 FieldDescriptor fd = (FieldDescriptor) field_it.next();
1725 if (!(fd.isFinal() && fd.isStatic())) {
1726 checkFieldDeclaration(cd, fd);
1728 // for static final, assign top location by default
1729 Location loc = Location.createTopLocation(cd);
1730 addLocationType(fd.getType(), loc);
1735 private Location checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1737 Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1739 // currently enforce every field to have corresponding location
1740 if (annotationVec.size() == 0) {
1741 throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1742 + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1745 if (annotationVec.size() > 1) {
1746 // variable can have at most one location
1747 throw new Error("Field " + fd.getSymbol() + " of class " + cd
1748 + " has more than one location.");
1751 AnnotationDescriptor ad = annotationVec.elementAt(0);
1752 Location loc = null;
1754 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1755 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1756 String locationID = ad.getValue();
1757 // check if location is defined
1758 SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1759 if (lattice == null || (!lattice.containsKey(locationID))) {
1760 throw new Error("Location " + locationID
1761 + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1762 + cd.getSourceFileName() + ".");
1764 loc = new Location(cd, locationID);
1766 if (ssjava.isSharedLocation(loc)) {
1767 ssjava.mapSharedLocation2Descriptor(loc, fd);
1770 addLocationType(fd.getType(), loc);
1778 private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
1780 TypeExtension te = type.getExtension();
1783 ssType = (SSJavaType) te;
1784 ssType.setCompLoc(loc);
1786 ssType = new SSJavaType(loc);
1787 type.setExtension(ssType);
1792 private void addLocationType(TypeDescriptor type, Location loc) {
1794 type.setExtension(loc);
1798 static class CompositeLattice {
1800 public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1802 // System.out.println("\nisGreaterThan=" + loc1 + " " + loc2 + " msg=" +
1804 int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, false, msg);
1805 if (baseCompareResult == ComparisonResult.EQUAL) {
1806 if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1811 } else if (baseCompareResult == ComparisonResult.GREATER) {
1819 public static int compare(CompositeLocation loc1, CompositeLocation loc2, boolean ignore,
1822 // System.out.println("compare=" + loc1 + " " + loc2);
1823 int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, ignore, msg);
1825 if (baseCompareResult == ComparisonResult.EQUAL) {
1826 return compareDelta(loc1, loc2);
1828 return baseCompareResult;
1833 private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1835 int deltaCount1 = 0;
1836 int deltaCount2 = 0;
1837 if (dLoc1 instanceof DeltaLocation) {
1838 deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1841 if (dLoc2 instanceof DeltaLocation) {
1842 deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1844 if (deltaCount1 < deltaCount2) {
1845 return ComparisonResult.GREATER;
1846 } else if (deltaCount1 == deltaCount2) {
1847 return ComparisonResult.EQUAL;
1849 return ComparisonResult.LESS;
1854 private static int compareBaseLocationSet(CompositeLocation compLoc1,
1855 CompositeLocation compLoc2, boolean awareSharedLoc, boolean ignore, String msg) {
1857 // if compLoc1 is greater than compLoc2, return true
1858 // else return false;
1860 // compare one by one in according to the order of the tuple
1862 for (int i = 0; i < compLoc1.getSize(); i++) {
1863 Location loc1 = compLoc1.get(i);
1864 if (i >= compLoc2.getSize()) {
1866 return ComparisonResult.INCOMPARABLE;
1868 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1869 + " because they are not comparable at " + msg);
1872 Location loc2 = compLoc2.get(i);
1874 Descriptor descriptor = getCommonParentDescriptor(loc1, loc2, msg);
1875 SSJavaLattice<String> lattice = getLatticeByDescriptor(descriptor);
1877 // check if the shared location is appeared only at the end of the
1878 // composite location
1879 if (lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
1880 if (i != (compLoc1.getSize() - 1)) {
1881 throw new Error("The shared location " + loc1.getLocIdentifier()
1882 + " cannot be appeared in the middle of composite location at" + msg);
1886 if (lattice.getSharedLocSet().contains(loc2.getLocIdentifier())) {
1887 if (i != (compLoc2.getSize() - 1)) {
1888 throw new Error("The shared location " + loc2.getLocIdentifier()
1889 + " cannot be appeared in the middle of composite location at " + msg);
1893 // if (!lattice1.equals(lattice2)) {
1894 // throw new Error("Failed to compare two locations of " + compLoc1 +
1895 // " and " + compLoc2
1896 // + " because they are not comparable at " + msg);
1899 if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1901 // check if the current location is the spinning location
1902 // note that the spinning location only can be appeared in the last
1903 // part of the composite location
1904 if (awareSharedLoc && numOfTie == compLoc1.getSize()
1905 && lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
1906 return ComparisonResult.GREATER;
1909 } else if (lattice.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1910 return ComparisonResult.GREATER;
1912 return ComparisonResult.LESS;
1917 if (numOfTie == compLoc1.getSize()) {
1919 if (numOfTie != compLoc2.getSize()) {
1922 return ComparisonResult.INCOMPARABLE;
1924 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1925 + " because they are not comparable at " + msg);
1930 return ComparisonResult.EQUAL;
1933 return ComparisonResult.LESS;
1937 public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet, String errMsg) {
1939 // System.out.println("Calculating GLB=" + inputSet);
1940 CompositeLocation glbCompLoc = new CompositeLocation();
1942 // calculate GLB of the first(priority) element
1943 Set<String> priorityLocIdentifierSet = new HashSet<String>();
1944 Descriptor priorityDescriptor = null;
1946 Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1947 new Hashtable<String, Set<CompositeLocation>>();
1948 // mapping from the priority loc ID to its full representation by the
1949 // composite location
1951 int maxTupleSize = 0;
1952 CompositeLocation maxCompLoc = null;
1954 Location prevPriorityLoc = null;
1955 for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1956 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1957 if (compLoc.getSize() > maxTupleSize) {
1958 maxTupleSize = compLoc.getSize();
1959 maxCompLoc = compLoc;
1961 Location priorityLoc = compLoc.get(0);
1962 String priorityLocId = priorityLoc.getLocIdentifier();
1963 priorityLocIdentifierSet.add(priorityLocId);
1965 if (locId2CompLocSet.containsKey(priorityLocId)) {
1966 locId2CompLocSet.get(priorityLocId).add(compLoc);
1968 Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1969 newSet.add(compLoc);
1970 locId2CompLocSet.put(priorityLocId, newSet);
1973 // check if priority location are coming from the same lattice
1974 if (priorityDescriptor == null) {
1975 priorityDescriptor = priorityLoc.getDescriptor();
1977 priorityDescriptor = getCommonParentDescriptor(priorityLoc, prevPriorityLoc, errMsg);
1979 prevPriorityLoc = priorityLoc;
1980 // else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1981 // throw new Error("Failed to calculate GLB of " + inputSet
1982 // + " because they are from different lattices.");
1986 SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1987 String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1989 glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1990 Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1992 if (compSet == null) {
1993 // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1994 // mean that the result is already lower than <x1,y1> and <x2,y2>
1995 // assign TOP to the rest of the location elements
1997 // in this case, do not take care about delta
1998 // CompositeLocation inputComp = inputSet.iterator().next();
1999 for (int i = 1; i < maxTupleSize; i++) {
2000 glbCompLoc.addLocation(Location.createTopLocation(maxCompLoc.get(i).getDescriptor()));
2004 // here find out composite location that has a maximum length tuple
2005 // if we have three input set: [A], [A,B], [A,B,C]
2006 // maximum length tuple will be [A,B,C]
2008 CompositeLocation maxFromCompSet = null;
2009 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2010 CompositeLocation c = (CompositeLocation) iterator.next();
2011 if (c.getSize() > max) {
2017 if (compSet.size() == 1) {
2018 // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
2019 CompositeLocation comp = compSet.iterator().next();
2020 for (int i = 1; i < comp.getSize(); i++) {
2021 glbCompLoc.addLocation(comp.get(i));
2024 // if input location corresponding to glb is a delta, need to apply
2025 // delta to glb result
2026 if (comp instanceof DeltaLocation) {
2027 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2031 // when GLB(x1,x2)==x1 and x2 : GLB case 1
2032 // if more than one location shares the same priority GLB
2033 // need to calculate the rest of GLB loc
2035 // setup input set starting from the second tuple item
2036 Set<CompositeLocation> innerGLBInput = new HashSet<CompositeLocation>();
2037 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2038 CompositeLocation compLoc = (CompositeLocation) iterator.next();
2039 CompositeLocation innerCompLoc = new CompositeLocation();
2040 for (int idx = 1; idx < compLoc.getSize(); idx++) {
2041 innerCompLoc.addLocation(compLoc.get(idx));
2043 if (innerCompLoc.getSize() > 0) {
2044 innerGLBInput.add(innerCompLoc);
2048 if (innerGLBInput.size() > 0) {
2049 CompositeLocation innerGLB = CompositeLattice.calculateGLB(innerGLBInput, errMsg);
2050 for (int idx = 0; idx < innerGLB.getSize(); idx++) {
2051 glbCompLoc.addLocation(innerGLB.get(idx));
2055 // if input location corresponding to glb is a delta, need to apply
2056 // delta to glb result
2058 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2059 CompositeLocation compLoc = (CompositeLocation) iterator.next();
2060 if (compLoc instanceof DeltaLocation) {
2061 if (glbCompLoc.equals(compLoc)) {
2062 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2071 // System.out.println("GLB=" + glbCompLoc);
2076 static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
2078 SSJavaLattice<String> lattice = null;
2080 if (d instanceof ClassDescriptor) {
2081 lattice = ssjava.getCd2lattice().get(d);
2082 } else if (d instanceof MethodDescriptor) {
2083 if (ssjava.getMd2lattice().containsKey(d)) {
2084 lattice = ssjava.getMd2lattice().get(d);
2086 // use default lattice for the method
2087 lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
2094 static Descriptor getCommonParentDescriptor(Location loc1, Location loc2, String msg) {
2096 Descriptor d1 = loc1.getDescriptor();
2097 Descriptor d2 = loc2.getDescriptor();
2099 Descriptor descriptor;
2101 if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
2103 if (d1.equals(d2)) {
2106 // identifying which one is parent class
2107 Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
2108 Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
2110 if (d1 == null && d2 == null) {
2111 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2112 + " because they are not comparable at " + msg);
2113 } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
2115 } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
2118 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2119 + " because they are not comparable at " + msg);
2123 } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
2125 if (d1.equals(d2)) {
2129 // identifying which one is parent class
2130 MethodDescriptor md1 = (MethodDescriptor) d1;
2131 MethodDescriptor md2 = (MethodDescriptor) d2;
2133 if (!md1.matches(md2)) {
2134 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2135 + " because they are not comparable at " + msg);
2138 Set<Descriptor> d1SubClassesSet =
2139 ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
2140 Set<Descriptor> d2SubClassesSet =
2141 ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
2143 if (d1 == null && d2 == null) {
2144 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2145 + " because they are not comparable at " + msg);
2146 } else if (d1 != null && d1SubClassesSet.contains(d2)) {
2148 } else if (d2 != null && d2SubClassesSet.contains(d1)) {
2151 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2152 + " because they are not comparable at " + msg);
2157 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2158 + " because they are not comparable at " + msg);
2167 class ComparisonResult {
2169 public static final int GREATER = 0;
2170 public static final int EQUAL = 1;
2171 public static final int LESS = 2;
2172 public static final int INCOMPARABLE = 3;
2179 class ReturnLocGenerator {
2181 public static final int PARAMISHIGHER = 0;
2182 public static final int PARAMISSAME = 1;
2183 public static final int IGNORE = 2;
2185 private Hashtable<Integer, Integer> paramIdx2paramType;
2187 private CompositeLocation declaredReturnLoc = null;
2189 public ReturnLocGenerator(CompositeLocation returnLoc, MethodDescriptor md,
2190 List<CompositeLocation> params, String msg) {
2192 CompositeLocation thisLoc = params.get(0);
2193 if (returnLoc.get(0).equals(thisLoc.get(0)) && returnLoc.getSize() > 1) {
2194 // if the declared return location consists of THIS and field location,
2195 // return location for the caller's side has to have same field element
2196 this.declaredReturnLoc = returnLoc;
2198 // creating mappings
2199 paramIdx2paramType = new Hashtable<Integer, Integer>();
2200 for (int i = 0; i < params.size(); i++) {
2201 CompositeLocation param = params.get(i);
2202 int compareResult = CompositeLattice.compare(param, returnLoc, true, msg);
2205 if (compareResult == ComparisonResult.GREATER) {
2207 } else if (compareResult == ComparisonResult.EQUAL) {
2212 paramIdx2paramType.put(new Integer(i), new Integer(type));
2218 public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
2220 if (declaredReturnLoc != null) {
2221 // when developer specify that the return value is [THIS,field]
2222 // needs to translate to the caller's location
2223 CompositeLocation callerLoc = new CompositeLocation();
2224 CompositeLocation callerBaseLocation = args.get(0);
2226 for (int i = 0; i < callerBaseLocation.getSize(); i++) {
2227 callerLoc.addLocation(callerBaseLocation.get(i));
2229 for (int i = 1; i < declaredReturnLoc.getSize(); i++) {
2230 callerLoc.addLocation(declaredReturnLoc.get(i));
2234 // compute the highest possible location in caller's side
2235 assert paramIdx2paramType.keySet().size() == args.size();
2237 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
2238 for (int i = 0; i < args.size(); i++) {
2239 int type = (paramIdx2paramType.get(new Integer(i))).intValue();
2240 CompositeLocation argLoc = args.get(i);
2241 if (type == PARAMISHIGHER || type == PARAMISSAME) {
2242 // return loc is equal to or lower than param
2243 inputGLB.add(argLoc);
2247 // compute GLB of arguments subset that are same or higher than return
2249 if (inputGLB.isEmpty()) {
2250 CompositeLocation rtr =
2251 new CompositeLocation(Location.createTopLocation(args.get(0).get(0).getDescriptor()));
2254 CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB, "");