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 // if this return statement is inside branch, return value has an implicit
548 // flow from conditional location
549 if (constraint != null) {
550 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
551 inputGLB.add(returnValueLoc);
552 inputGLB.add(constraint);
554 CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(md.getClassDesc(), rn));
557 // check if return value is equal or higher than RETRUNLOC of method
558 // declaration annotation
559 CompositeLocation declaredReturnLoc = md2ReturnLoc.get(md);
562 CompositeLattice.compare(returnValueLoc, declaredReturnLoc, false,
563 generateErrorMessage(md.getClassDesc(), rn));
565 if (compareResult == ComparisonResult.LESS || compareResult == ComparisonResult.INCOMPARABLE) {
567 "Return value location is not equal or higher than the declaraed return location at "
568 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
572 return new CompositeLocation();
575 private boolean hasOnlyLiteralValue(ExpressionNode en) {
576 if (en.kind() == Kind.LiteralNode) {
583 private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
584 LoopNode ln, CompositeLocation constraint) {
586 ClassDescriptor cd = md.getClassDesc();
587 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
589 CompositeLocation condLoc =
590 checkLocationFromExpressionNode(md, nametable, ln.getCondition(),
591 new CompositeLocation(), constraint, false);
592 // addLocationType(ln.getCondition().getType(), (condLoc));
594 constraint = generateNewConstraint(constraint, condLoc);
595 checkLocationFromBlockNode(md, nametable, ln.getBody(), constraint);
597 return new CompositeLocation();
600 // check 'for loop' case
601 BlockNode bn = ln.getInitializer();
602 bn.getVarTable().setParent(nametable);
604 // calculate glb location of condition and update statements
605 CompositeLocation condLoc =
606 checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
607 new CompositeLocation(), constraint, false);
608 // addLocationType(ln.getCondition().getType(), condLoc);
610 constraint = generateNewConstraint(constraint, condLoc);
612 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate(), constraint);
613 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody(), constraint);
615 return new CompositeLocation();
621 private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
622 SymbolTable nametable, SubBlockNode sbn, CompositeLocation constraint) {
623 CompositeLocation compLoc =
624 checkLocationFromBlockNode(md, nametable, sbn.getBlockNode(), constraint);
628 private CompositeLocation generateNewConstraint(CompositeLocation currentCon,
629 CompositeLocation newCon) {
631 if (currentCon == null) {
634 // compute GLB of current constraint and new constraint
635 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
636 inputSet.add(currentCon);
637 inputSet.add(newCon);
638 return CompositeLattice.calculateGLB(inputSet, "");
643 private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
644 SymbolTable nametable, IfStatementNode isn, CompositeLocation constraint) {
646 CompositeLocation condLoc =
647 checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation(),
650 // addLocationType(isn.getCondition().getType(), condLoc);
652 constraint = generateNewConstraint(constraint, condLoc);
653 checkLocationFromBlockNode(md, nametable, isn.getTrueBlock(), constraint);
655 if (isn.getFalseBlock() != null) {
656 checkLocationFromBlockNode(md, nametable, isn.getFalseBlock(), constraint);
659 return new CompositeLocation();
662 private void checkOwnership(MethodDescriptor md, TreeNode tn, ExpressionNode srcExpNode) {
664 if (srcExpNode.kind() == Kind.NameNode || srcExpNode.kind() == Kind.FieldAccessNode) {
665 if (srcExpNode.getType().isPtr() && !srcExpNode.getType().isNull()) {
666 // first, check the linear type
667 // RHS reference should be owned by the current method
668 FieldDescriptor fd = getFieldDescriptorFromExpressionNode(srcExpNode);
672 isOwned = ((SSJavaType) srcExpNode.getType().getExtension()).isOwned();
675 isOwned = ssjava.isOwnedByMethod(md, fd);
679 "It is now allowed to create the reference alias from the reference not owned by the method at "
680 + generateErrorMessage(md.getClassDesc(), tn));
688 private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
689 SymbolTable nametable, DeclarationNode dn, CompositeLocation constraint) {
691 VarDescriptor vd = dn.getVarDescriptor();
693 CompositeLocation destLoc = d2loc.get(vd);
695 if (dn.getExpression() != null) {
697 checkOwnership(md, dn, dn.getExpression());
699 CompositeLocation expressionLoc =
700 checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
701 new CompositeLocation(), constraint, false);
702 // addTypeLocation(dn.getExpression().getType(), expressionLoc);
704 if (expressionLoc != null) {
706 // checking location order
707 if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc,
708 generateErrorMessage(md.getClassDesc(), dn))) {
709 throw new Error("The value flow from " + expressionLoc + " to " + destLoc
710 + " does not respect location hierarchy on the assignment " + dn.printNode(0)
711 + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
714 return expressionLoc;
718 return new CompositeLocation();
724 private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
726 checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
729 private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
730 SymbolTable nametable, BlockExpressionNode ben, CompositeLocation constraint) {
731 CompositeLocation compLoc =
732 checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null, constraint, false);
733 // addTypeLocation(ben.getExpression().getType(), compLoc);
737 private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
738 SymbolTable nametable, ExpressionNode en, CompositeLocation loc,
739 CompositeLocation constraint, boolean isLHS) {
741 CompositeLocation compLoc = null;
744 case Kind.AssignmentNode:
746 checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc, constraint);
749 case Kind.FieldAccessNode:
751 checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc, constraint);
755 compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc, constraint);
759 compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en, constraint);
762 case Kind.CreateObjectNode:
763 compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
766 case Kind.ArrayAccessNode:
768 checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en, constraint, isLHS);
771 case Kind.LiteralNode:
772 compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
775 case Kind.MethodInvokeNode:
777 checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc, constraint);
780 case Kind.TertiaryNode:
781 compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en, constraint);
785 compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en, constraint);
788 // case Kind.InstanceOfNode:
789 // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
792 // case Kind.ArrayInitializerNode:
793 // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
797 // case Kind.ClassTypeNode:
798 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
801 // case Kind.OffsetNode:
802 // checkOffsetNode(md, nametable, (OffsetNode)en, td);
809 // addTypeLocation(en.getType(), compLoc);
814 private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
815 CastNode cn, CompositeLocation constraint) {
817 ExpressionNode en = cn.getExpression();
818 return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
823 private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
824 SymbolTable nametable, TertiaryNode tn, CompositeLocation constraint) {
825 ClassDescriptor cd = md.getClassDesc();
827 CompositeLocation condLoc =
828 checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation(),
830 // addLocationType(tn.getCond().getType(), condLoc);
831 CompositeLocation trueLoc =
832 checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation(),
834 // addLocationType(tn.getTrueExpr().getType(), trueLoc);
835 CompositeLocation falseLoc =
836 checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation(),
838 // addLocationType(tn.getFalseExpr().getType(), falseLoc);
840 // locations from true/false branches can be TOP when there are only literal
842 // in this case, we don't need to check flow down rule!
844 System.out.println("\n#tertiary cond=" + tn.getCond().printNode(0) + " Loc=" + condLoc);
845 System.out.println("# true=" + tn.getTrueExpr().printNode(0) + " Loc=" + trueLoc);
846 System.out.println("# false=" + tn.getFalseExpr().printNode(0) + " Loc=" + falseLoc);
848 // check if condLoc is higher than trueLoc & falseLoc
849 if (!trueLoc.get(0).isTop()
850 && !CompositeLattice.isGreaterThan(condLoc, trueLoc, generateErrorMessage(cd, tn))) {
852 "The location of the condition expression is lower than the true expression at "
853 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
856 if (!falseLoc.get(0).isTop()
857 && !CompositeLattice.isGreaterThan(condLoc, falseLoc,
858 generateErrorMessage(cd, tn.getCond()))) {
860 "The location of the condition expression is lower than the false expression at "
861 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
864 // then, return glb of trueLoc & falseLoc
865 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
866 glbInputSet.add(trueLoc);
867 glbInputSet.add(falseLoc);
869 if (glbInputSet.size() == 1) {
872 return CompositeLattice.calculateGLB(glbInputSet, generateErrorMessage(cd, tn));
877 private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
878 SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc,
879 CompositeLocation constraint) {
881 ClassDescriptor cd = md.getClassDesc();
882 MethodDescriptor calleeMD = min.getMethod();
884 NameDescriptor baseName = min.getBaseName();
885 boolean isSystemout = false;
886 if (baseName != null) {
887 isSystemout = baseName.getSymbol().equals("System.out");
890 if (!ssjava.isSSJavaUtil(calleeMD.getClassDesc()) && !ssjava.isTrustMethod(calleeMD)
891 && !calleeMD.getModifiers().isNative() && !isSystemout) {
893 CompositeLocation baseLocation = null;
894 if (min.getExpression() != null) {
896 checkLocationFromExpressionNode(md, nametable, min.getExpression(),
897 new CompositeLocation(), constraint, false);
899 System.out.println("min=" + min.getMethod());
900 if (min.getMethod().isStatic()) {
901 String globalLocId = ssjava.getMethodLattice(md).getGlobalLoc();
902 if (globalLocId == null) {
903 throw new Error("Method lattice does not define global variable location at "
904 + generateErrorMessage(md.getClassDesc(), min));
906 baseLocation = new CompositeLocation(new Location(md, globalLocId));
908 String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
909 baseLocation = new CompositeLocation(new Location(md, thisLocId));
914 System.out.println("\n#checkLocationFromMethodInvokeNode=" + min.printNode(0)
915 + " baseLocation=" + baseLocation + " constraint=" + constraint);
917 if (constraint != null) {
919 CompositeLattice.compare(constraint, baseLocation, true, generateErrorMessage(cd, min));
920 if (compareResult != ComparisonResult.GREATER) {
921 // if the current constraint is higher than method's THIS location
922 // no need to check constraints!
923 CompositeLocation calleeConstraint =
924 translateCallerLocToCalleeLoc(calleeMD, baseLocation, constraint);
925 // System.out.println("check method body for constraint:" + calleeMD +
926 // " calleeConstraint="
927 // + calleeConstraint);
928 checkMethodBody(calleeMD.getClassDesc(), calleeMD, calleeConstraint);
932 checkCalleeConstraints(md, nametable, min, baseLocation, constraint);
934 // checkCallerArgumentLocationConstraints(md, nametable, min,
935 // baseLocation, constraint);
937 if (!min.getMethod().getReturnType().isVoid()) {
938 // If method has a return value, compute the highest possible return
939 // location in the caller's perspective
940 CompositeLocation ceilingLoc =
941 computeCeilingLocationForCaller(md, nametable, min, baseLocation, constraint);
946 return new CompositeLocation(Location.createTopLocation(md));
950 private CompositeLocation translateCallerLocToCalleeLoc(MethodDescriptor calleeMD,
951 CompositeLocation calleeBaseLoc, CompositeLocation constraint) {
953 CompositeLocation calleeConstraint = new CompositeLocation();
955 // if (constraint.startsWith(calleeBaseLoc)) {
956 // if the first part of constraint loc is matched with callee base loc
957 Location thisLoc = new Location(calleeMD, ssjava.getMethodLattice(calleeMD).getThisLoc());
958 calleeConstraint.addLocation(thisLoc);
959 for (int i = calleeBaseLoc.getSize(); i < constraint.getSize(); i++) {
960 calleeConstraint.addLocation(constraint.get(i));
965 return calleeConstraint;
968 private void checkCallerArgumentLocationConstraints(MethodDescriptor md, SymbolTable nametable,
969 MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
970 // if parameter location consists of THIS and FIELD location,
971 // caller should pass an argument that is comparable to the declared
972 // parameter location
973 // and is not lower than the declared parameter location in the field
976 MethodDescriptor calleemd = min.getMethod();
978 List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
979 List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
981 MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
982 Location calleeThisLoc = new Location(calleemd, calleeLattice.getThisLoc());
984 for (int i = 0; i < min.numArgs(); i++) {
985 ExpressionNode en = min.getArg(i);
986 CompositeLocation callerArgLoc =
987 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
989 callerArgList.add(callerArgLoc);
992 // setup callee params set
993 for (int i = 0; i < calleemd.numParameters(); i++) {
994 VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
995 CompositeLocation calleeLoc = d2loc.get(calleevd);
996 calleeParamList.add(calleeLoc);
999 String errorMsg = generateErrorMessage(md.getClassDesc(), min);
1001 // System.out.println("checkCallerArgumentLocationConstraints=" +
1002 // min.printNode(0));
1003 // System.out.println("base location=" + callerBaseLoc + " constraint=" +
1006 for (int i = 0; i < calleeParamList.size(); i++) {
1007 CompositeLocation calleeParamLoc = calleeParamList.get(i);
1008 if (calleeParamLoc.get(0).equals(calleeThisLoc) && calleeParamLoc.getSize() > 1) {
1010 // callee parameter location has field information
1011 CompositeLocation callerArgLoc = callerArgList.get(i);
1013 CompositeLocation paramLocation =
1014 translateCalleeParamLocToCaller(md, calleeParamLoc, callerBaseLoc, errorMsg);
1016 Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1017 if (constraint != null) {
1018 inputGLBSet.add(callerArgLoc);
1019 inputGLBSet.add(constraint);
1021 CompositeLattice.calculateGLB(inputGLBSet,
1022 generateErrorMessage(md.getClassDesc(), min));
1025 if (!CompositeLattice.isGreaterThan(callerArgLoc, paramLocation, errorMsg)) {
1026 throw new Error("Caller argument '" + min.getArg(i).printNode(0) + " : " + callerArgLoc
1027 + "' should be higher than corresponding callee's parameter : " + paramLocation
1028 + " at " + errorMsg);
1036 private CompositeLocation translateCalleeParamLocToCaller(MethodDescriptor md,
1037 CompositeLocation calleeParamLoc, CompositeLocation callerBaseLocation, String errorMsg) {
1039 CompositeLocation translate = new CompositeLocation();
1041 for (int i = 0; i < callerBaseLocation.getSize(); i++) {
1042 translate.addLocation(callerBaseLocation.get(i));
1045 for (int i = 1; i < calleeParamLoc.getSize(); i++) {
1046 translate.addLocation(calleeParamLoc.get(i));
1049 // System.out.println("TRANSLATED=" + translate + " from calleeParamLoc=" +
1055 private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
1056 SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation,
1057 CompositeLocation constraint) {
1058 List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
1060 // by default, method has a THIS parameter
1061 argList.add(baseLocation);
1063 for (int i = 0; i < min.numArgs(); i++) {
1064 ExpressionNode en = min.getArg(i);
1065 CompositeLocation callerArg =
1066 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1068 argList.add(callerArg);
1071 // System.out.println("\n## computeReturnLocation=" + min.getMethod() +
1072 // " argList=" + argList);
1073 CompositeLocation ceilLoc = md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
1074 // System.out.println("## ReturnLocation=" + ceilLoc);
1080 private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
1081 MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
1083 // System.out.println("checkCalleeConstraints=" + min.printNode(0));
1085 MethodDescriptor calleemd = min.getMethod();
1087 MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
1088 CompositeLocation calleeThisLoc =
1089 new CompositeLocation(new Location(calleemd, calleeLattice.getThisLoc()));
1091 List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
1092 List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
1094 if (min.numArgs() > 0) {
1095 // caller needs to guarantee that it passes arguments in regarding to
1096 // callee's hierarchy
1098 // setup caller args set
1099 // first, add caller's base(this) location
1100 callerArgList.add(callerBaseLoc);
1101 // second, add caller's arguments
1102 for (int i = 0; i < min.numArgs(); i++) {
1103 ExpressionNode en = min.getArg(i);
1104 CompositeLocation callerArgLoc =
1105 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1107 callerArgList.add(callerArgLoc);
1110 // setup callee params set
1111 // first, add callee's this location
1112 calleeParamList.add(calleeThisLoc);
1113 // second, add callee's parameters
1114 for (int i = 0; i < calleemd.numParameters(); i++) {
1115 VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
1116 CompositeLocation calleeLoc = d2loc.get(calleevd);
1117 // System.out.println("calleevd=" + calleevd + " loc=" + calleeLoc);
1118 calleeParamList.add(calleeLoc);
1121 // here, check if ordering relations among caller's args respect
1122 // ordering relations in-between callee's args
1123 CHECK: for (int i = 0; i < calleeParamList.size(); i++) {
1124 CompositeLocation calleeLoc1 = calleeParamList.get(i);
1125 CompositeLocation callerLoc1 = callerArgList.get(i);
1127 for (int j = 0; j < calleeParamList.size(); j++) {
1129 CompositeLocation calleeLoc2 = calleeParamList.get(j);
1130 CompositeLocation callerLoc2 = callerArgList.get(j);
1132 if (callerLoc1.get(callerLoc1.getSize() - 1).isTop()
1133 || callerLoc2.get(callerLoc2.getSize() - 1).isTop()) {
1137 // System.out.println("calleeLoc1=" + calleeLoc1);
1138 // System.out.println("calleeLoc2=" + calleeLoc2 +
1139 // "calleeParamList=" + calleeParamList);
1142 CompositeLattice.compare(callerLoc1, callerLoc2, true,
1143 generateErrorMessage(md.getClassDesc(), min));
1144 System.out.println("callerResult=" + callerResult);
1146 CompositeLattice.compare(calleeLoc1, calleeLoc2, true,
1147 generateErrorMessage(md.getClassDesc(), min));
1148 System.out.println("calleeResult=" + calleeResult);
1150 if (callerResult == ComparisonResult.EQUAL) {
1151 if (ssjava.isSharedLocation(callerLoc1.get(callerLoc1.getSize() - 1))
1152 && ssjava.isSharedLocation(callerLoc2.get(callerLoc2.getSize() - 1))) {
1153 // if both of them are shared locations, promote them to
1154 // "GREATER relation"
1155 callerResult = ComparisonResult.GREATER;
1159 if (calleeResult == ComparisonResult.EQUAL) {
1160 if (ssjava.isSharedLocation(calleeLoc1.get(calleeLoc1.getSize() - 1))
1161 && ssjava.isSharedLocation(calleeLoc2.get(calleeLoc2.getSize() - 1))) {
1162 // if both of them are shared locations, promote them to
1163 // "GREATER relation"
1164 calleeResult = ComparisonResult.GREATER;
1168 if (calleeResult == ComparisonResult.GREATER
1169 && callerResult != ComparisonResult.GREATER) {
1170 // If calleeLoc1 is higher than calleeLoc2
1171 // then, caller should have same ordering relation in-bet
1172 // callerLoc1 & callerLoc2
1174 String paramName1, paramName2;
1177 paramName1 = "'THIS'";
1179 paramName1 = "'parameter " + calleemd.getParamName(i - 1) + "'";
1183 paramName2 = "'THIS'";
1185 paramName2 = "'parameter " + calleemd.getParamName(j - 1) + "'";
1189 "Caller doesn't respect an ordering relation among method arguments: callee expects that "
1190 + paramName1 + " should be higher than " + paramName2 + " in " + calleemd
1191 + " at " + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
1202 private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
1203 SymbolTable nametable, ArrayAccessNode aan, CompositeLocation constraint, boolean isLHS) {
1205 ClassDescriptor cd = md.getClassDesc();
1207 CompositeLocation arrayLoc =
1208 checkLocationFromExpressionNode(md, nametable, aan.getExpression(),
1209 new CompositeLocation(), constraint, isLHS);
1210 // addTypeLocation(aan.getExpression().getType(), arrayLoc);
1211 CompositeLocation indexLoc =
1212 checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(),
1214 // addTypeLocation(aan.getIndex().getType(), indexLoc);
1217 if (!CompositeLattice.isGreaterThan(indexLoc, arrayLoc, generateErrorMessage(cd, aan))) {
1218 throw new Error("Array index value is not higher than array location at "
1219 + generateErrorMessage(cd, aan));
1223 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1224 inputGLB.add(arrayLoc);
1225 inputGLB.add(indexLoc);
1226 return CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(cd, aan));
1231 private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
1232 SymbolTable nametable, CreateObjectNode con) {
1234 ClassDescriptor cd = md.getClassDesc();
1236 CompositeLocation compLoc = new CompositeLocation();
1237 compLoc.addLocation(Location.createTopLocation(md));
1242 private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
1243 OpNode on, CompositeLocation constraint) {
1245 ClassDescriptor cd = md.getClassDesc();
1246 CompositeLocation leftLoc = new CompositeLocation();
1248 checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc, constraint, false);
1249 // addTypeLocation(on.getLeft().getType(), leftLoc);
1251 CompositeLocation rightLoc = new CompositeLocation();
1252 if (on.getRight() != null) {
1254 checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc, constraint, false);
1255 // addTypeLocation(on.getRight().getType(), rightLoc);
1258 // System.out.println("\n# OP NODE=" + on.printNode(0));
1259 // System.out.println("# left loc=" + leftLoc + " from " +
1260 // on.getLeft().getClass());
1261 // if (on.getRight() != null) {
1262 // System.out.println("# right loc=" + rightLoc + " from " +
1263 // on.getRight().getClass());
1266 Operation op = on.getOp();
1268 switch (op.getOp()) {
1270 case Operation.UNARYPLUS:
1271 case Operation.UNARYMINUS:
1272 case Operation.LOGIC_NOT:
1276 case Operation.LOGIC_OR:
1277 case Operation.LOGIC_AND:
1278 case Operation.COMP:
1279 case Operation.BIT_OR:
1280 case Operation.BIT_XOR:
1281 case Operation.BIT_AND:
1282 case Operation.ISAVAILABLE:
1283 case Operation.EQUAL:
1284 case Operation.NOTEQUAL:
1291 case Operation.MULT:
1294 case Operation.LEFTSHIFT:
1295 case Operation.RIGHTSHIFT:
1296 case Operation.URIGHTSHIFT:
1298 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
1299 inputSet.add(leftLoc);
1300 inputSet.add(rightLoc);
1301 CompositeLocation glbCompLoc =
1302 CompositeLattice.calculateGLB(inputSet, generateErrorMessage(cd, on));
1303 // System.out.println("# glbCompLoc=" + glbCompLoc);
1307 throw new Error(op.toString());
1312 private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
1313 SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
1315 // literal value has the top location so that value can be flowed into any
1317 Location literalLoc = Location.createTopLocation(md);
1318 loc.addLocation(literalLoc);
1323 private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
1324 NameNode nn, CompositeLocation loc, CompositeLocation constraint) {
1326 NameDescriptor nd = nn.getName();
1327 if (nd.getBase() != null) {
1329 checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc, constraint, false);
1331 String varname = nd.toString();
1332 if (varname.equals("this")) {
1334 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
1335 String thisLocId = methodLattice.getThisLoc();
1336 if (thisLocId == null) {
1337 throw new Error("The location for 'this' is not defined at "
1338 + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
1340 Location locElement = new Location(md, thisLocId);
1341 loc.addLocation(locElement);
1346 Descriptor d = (Descriptor) nametable.get(varname);
1348 // CompositeLocation localLoc = null;
1349 if (d instanceof VarDescriptor) {
1350 VarDescriptor vd = (VarDescriptor) d;
1351 // localLoc = d2loc.get(vd);
1352 // the type of var descriptor has a composite location!
1353 loc = ((SSJavaType) vd.getType().getExtension()).getCompLoc().clone();
1354 } else if (d instanceof FieldDescriptor) {
1355 // the type of field descriptor has a location!
1356 FieldDescriptor fd = (FieldDescriptor) d;
1357 if (fd.isStatic()) {
1359 // if it is 'static final', the location has TOP since no one can
1361 loc.addLocation(Location.createTopLocation(md));
1364 // if 'static', the location has pre-assigned global loc
1365 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1366 String globalLocId = localLattice.getGlobalLoc();
1367 if (globalLocId == null) {
1368 throw new Error("Global location element is not defined in the method " + md);
1370 Location globalLoc = new Location(md, globalLocId);
1372 loc.addLocation(globalLoc);
1375 // the location of field access starts from this, followed by field
1377 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1378 Location thisLoc = new Location(md, localLattice.getThisLoc());
1379 loc.addLocation(thisLoc);
1382 Location fieldLoc = (Location) fd.getType().getExtension();
1383 loc.addLocation(fieldLoc);
1384 } else if (d == null) {
1385 // access static field
1386 ClassDescriptor cd = nn.getClassDesc();
1388 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1389 String globalLocId = localLattice.getGlobalLoc();
1390 if (globalLocId == null) {
1391 throw new Error("Method lattice does not define global variable location at "
1392 + generateErrorMessage(md.getClassDesc(), nn));
1394 loc.addLocation(new Location(md, globalLocId));
1402 private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1403 SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc,
1404 CompositeLocation constraint) {
1406 ExpressionNode left = fan.getExpression();
1407 TypeDescriptor ltd = left.getType();
1409 FieldDescriptor fd = fan.getField();
1411 String varName = null;
1412 if (left.kind() == Kind.NameNode) {
1413 NameDescriptor nd = ((NameNode) left).getName();
1414 varName = nd.toString();
1417 if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
1418 // using a class name directly or access using this
1419 if (fd.isStatic() && fd.isFinal()) {
1420 loc.addLocation(Location.createTopLocation(md));
1425 if (left instanceof ArrayAccessNode) {
1426 ArrayAccessNode aan = (ArrayAccessNode) left;
1427 left = aan.getExpression();
1430 loc = checkLocationFromExpressionNode(md, nametable, left, loc, constraint, false);
1431 // System.out.println("### checkLocationFromFieldAccessNode=" +
1432 // fan.printNode(0));
1433 // System.out.println("### left=" + left.printNode(0));
1435 if (left.getType().isArray()) {
1436 // array.length case: return the location of the array
1438 } else if (!left.getType().isPrimitive()) {
1439 Location fieldLoc = getFieldLocation(fd);
1440 loc.addLocation(fieldLoc);
1442 // System.out.println("### field loc=" + loc);
1446 private Location getFieldLocation(FieldDescriptor fd) {
1448 // System.out.println("### getFieldLocation=" + fd);
1449 // System.out.println("### fd.getType().getExtension()=" +
1450 // fd.getType().getExtension());
1452 Location fieldLoc = (Location) fd.getType().getExtension();
1454 // handle the case that method annotation checking skips checking field
1456 if (fieldLoc == null) {
1457 fieldLoc = checkFieldDeclaration(fd.getClassDescriptor(), fd);
1464 private FieldDescriptor getFieldDescriptorFromExpressionNode(ExpressionNode en) {
1466 if (en.kind() == Kind.NameNode) {
1467 NameNode nn = (NameNode) en;
1468 if (nn.getField() != null) {
1469 return nn.getField();
1472 if (nn.getName() != null && nn.getName().getBase() != null) {
1473 return getFieldDescriptorFromExpressionNode(nn.getExpression());
1476 } else if (en.kind() == Kind.FieldAccessNode) {
1477 FieldAccessNode fan = (FieldAccessNode) en;
1478 return fan.getField();
1484 private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1485 SymbolTable nametable, AssignmentNode an, CompositeLocation loc, CompositeLocation constraint) {
1487 // System.out.println("\n# ASSIGNMENTNODE=" + an.printNode(0));
1489 ClassDescriptor cd = md.getClassDesc();
1491 Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1493 boolean postinc = true;
1494 if (an.getOperation().getBaseOp() == null
1495 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1496 .getBaseOp().getOp() != Operation.POSTDEC))
1499 // if LHS is array access node, need to check if array index is higher
1500 // than array itself
1501 CompositeLocation destLocation =
1502 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1505 CompositeLocation rhsLocation;
1506 CompositeLocation srcLocation;
1510 checkOwnership(md, an, an.getSrc());
1513 checkLocationFromExpressionNode(md, nametable, an.getSrc(), new CompositeLocation(),
1516 srcLocation = rhsLocation;
1518 // if (!rhsLocation.get(rhsLocation.getSize() - 1).isTop()) {
1519 if (constraint != null) {
1520 inputGLBSet.add(rhsLocation);
1521 inputGLBSet.add(constraint);
1522 srcLocation = CompositeLattice.calculateGLB(inputGLBSet, generateErrorMessage(cd, an));
1526 // System.out.println("dstLocation=" + destLocation);
1527 // System.out.println("rhsLocation=" + rhsLocation);
1528 // System.out.println("srcLocation=" + srcLocation);
1529 // System.out.println("constraint=" + constraint);
1531 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1533 String context = "";
1534 if (constraint != null) {
1535 context = " and the current context constraint is " + constraint;
1538 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1539 + " does not respect location hierarchy on the assignment " + an.printNode(0) + context
1540 + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1546 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1549 if (constraint != null) {
1550 inputGLBSet.add(rhsLocation);
1551 inputGLBSet.add(constraint);
1552 srcLocation = CompositeLattice.calculateGLB(inputGLBSet, generateErrorMessage(cd, an));
1554 srcLocation = rhsLocation;
1557 // System.out.println("srcLocation=" + srcLocation);
1558 // System.out.println("rhsLocation=" + rhsLocation);
1559 // System.out.println("constraint=" + constraint);
1561 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1563 if (srcLocation.equals(destLocation)) {
1564 throw new Error("Location " + srcLocation
1565 + " is not allowed to have the value flow that moves within the same location at '"
1566 + an.printNode(0) + "' of " + cd.getSourceFileName() + "::" + an.getNumLine());
1568 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1569 + " does not respect location hierarchy on the assignment " + an.printNode(0)
1570 + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1577 return destLocation;
1580 private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1581 SymbolTable nametable, TreeNode n) {
1583 ClassDescriptor cd = md.getClassDesc();
1584 Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1586 // currently enforce every variable to have corresponding location
1587 if (annotationVec.size() == 0) {
1588 throw new Error("Location is not assigned to variable '" + vd.getSymbol()
1589 + "' in the method '" + md + "' of the class " + cd.getSymbol() + " at "
1590 + generateErrorMessage(cd, n));
1593 int locDecCount = 0;
1594 for (int i = 0; i < annotationVec.size(); i++) {
1595 AnnotationDescriptor ad = annotationVec.elementAt(i);
1597 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1599 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1601 if (locDecCount > 1) {// variable can have at most one location
1602 throw new Error(vd.getSymbol() + " has more than one location declaration.");
1604 String locDec = ad.getValue(); // check if location is defined
1606 if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1607 DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1608 d2loc.put(vd, deltaLoc);
1609 addLocationType(vd.getType(), deltaLoc);
1611 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1613 Location lastElement = compLoc.get(compLoc.getSize() - 1);
1614 if (ssjava.isSharedLocation(lastElement)) {
1615 ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1618 d2loc.put(vd, compLoc);
1619 addLocationType(vd.getType(), compLoc);
1628 private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1631 int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1634 int beginIdx = dIdx + 6;
1635 locDec = locDec.substring(beginIdx, locDec.length() - 1);
1636 dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1639 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1640 DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1645 private Location parseFieldLocDeclaraton(String decl, String msg) throws Exception {
1647 int idx = decl.indexOf(".");
1649 String className = decl.substring(0, idx);
1650 String fieldName = decl.substring(idx + 1);
1652 className.replaceAll(" ", "");
1653 fieldName.replaceAll(" ", "");
1655 Descriptor d = state.getClassSymbolTable().get(className);
1658 // System.out.println("state.getClassSymbolTable()=" +
1659 // state.getClassSymbolTable());
1660 throw new Error("The class in the location declaration '" + decl + "' does not exist at "
1664 assert (d instanceof ClassDescriptor);
1665 SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1666 if (!lattice.containsKey(fieldName)) {
1667 throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1668 + className + "' at " + msg);
1671 return new Location(d, fieldName);
1674 private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1676 CompositeLocation compLoc = new CompositeLocation();
1678 StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1679 List<String> locIdList = new ArrayList<String>();
1680 while (tokenizer.hasMoreTokens()) {
1681 String locId = tokenizer.nextToken();
1682 locIdList.add(locId);
1685 // at least,one location element needs to be here!
1686 assert (locIdList.size() > 0);
1688 // assume that loc with idx 0 comes from the local lattice
1689 // loc with idx 1 comes from the field lattice
1691 String localLocId = locIdList.get(0);
1692 SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1693 Location localLoc = new Location(md, localLocId);
1694 if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1695 throw new Error("Location " + localLocId
1696 + " is not defined in the local variable lattice at "
1697 + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : md) + ".");
1699 compLoc.addLocation(localLoc);
1701 for (int i = 1; i < locIdList.size(); i++) {
1702 String locName = locIdList.get(i);
1705 parseFieldLocDeclaraton(locName, generateErrorMessage(md.getClassDesc(), n));
1706 compLoc.addLocation(fieldLoc);
1707 } catch (Exception e) {
1708 throw new Error("The location declaration '" + locName + "' is wrong at "
1709 + generateErrorMessage(md.getClassDesc(), n));
1717 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1718 VarDescriptor vd = dn.getVarDescriptor();
1719 assignLocationOfVarDescriptor(vd, md, nametable, dn);
1722 private void checkDeclarationInClass(ClassDescriptor cd) {
1723 // Check to see that fields are okay
1724 for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1725 FieldDescriptor fd = (FieldDescriptor) field_it.next();
1727 if (!(fd.isFinal() && fd.isStatic())) {
1728 checkFieldDeclaration(cd, fd);
1730 // for static final, assign top location by default
1731 Location loc = Location.createTopLocation(cd);
1732 addLocationType(fd.getType(), loc);
1737 private Location checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1739 Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1741 // currently enforce every field to have corresponding location
1742 if (annotationVec.size() == 0) {
1743 throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1744 + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1747 if (annotationVec.size() > 1) {
1748 // variable can have at most one location
1749 throw new Error("Field " + fd.getSymbol() + " of class " + cd
1750 + " has more than one location.");
1753 AnnotationDescriptor ad = annotationVec.elementAt(0);
1754 Location loc = null;
1756 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1757 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1758 String locationID = ad.getValue();
1759 // check if location is defined
1760 SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1761 if (lattice == null || (!lattice.containsKey(locationID))) {
1762 throw new Error("Location " + locationID
1763 + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1764 + cd.getSourceFileName() + ".");
1766 loc = new Location(cd, locationID);
1768 if (ssjava.isSharedLocation(loc)) {
1769 ssjava.mapSharedLocation2Descriptor(loc, fd);
1772 addLocationType(fd.getType(), loc);
1780 private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
1782 TypeExtension te = type.getExtension();
1785 ssType = (SSJavaType) te;
1786 ssType.setCompLoc(loc);
1788 ssType = new SSJavaType(loc);
1789 type.setExtension(ssType);
1794 private void addLocationType(TypeDescriptor type, Location loc) {
1796 type.setExtension(loc);
1800 static class CompositeLattice {
1802 public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1804 // System.out.println("\nisGreaterThan=" + loc1 + " " + loc2 + " msg=" +
1806 int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, false, msg);
1807 if (baseCompareResult == ComparisonResult.EQUAL) {
1808 if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1813 } else if (baseCompareResult == ComparisonResult.GREATER) {
1821 public static int compare(CompositeLocation loc1, CompositeLocation loc2, boolean ignore,
1824 System.out.println("compare=" + loc1 + " " + loc2);
1825 int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, ignore, msg);
1827 if (baseCompareResult == ComparisonResult.EQUAL) {
1828 return compareDelta(loc1, loc2);
1830 return baseCompareResult;
1835 private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1837 int deltaCount1 = 0;
1838 int deltaCount2 = 0;
1839 if (dLoc1 instanceof DeltaLocation) {
1840 deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1843 if (dLoc2 instanceof DeltaLocation) {
1844 deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1846 if (deltaCount1 < deltaCount2) {
1847 return ComparisonResult.GREATER;
1848 } else if (deltaCount1 == deltaCount2) {
1849 return ComparisonResult.EQUAL;
1851 return ComparisonResult.LESS;
1856 private static int compareBaseLocationSet(CompositeLocation compLoc1,
1857 CompositeLocation compLoc2, boolean awareSharedLoc, boolean ignore, String msg) {
1859 // if compLoc1 is greater than compLoc2, return true
1860 // else return false;
1862 // compare one by one in according to the order of the tuple
1864 for (int i = 0; i < compLoc1.getSize(); i++) {
1865 Location loc1 = compLoc1.get(i);
1866 if (i >= compLoc2.getSize()) {
1868 return ComparisonResult.INCOMPARABLE;
1870 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1871 + " because they are not comparable at " + msg);
1874 Location loc2 = compLoc2.get(i);
1876 Descriptor descriptor = getCommonParentDescriptor(loc1, loc2, msg);
1877 SSJavaLattice<String> lattice = getLatticeByDescriptor(descriptor);
1879 // check if the shared location is appeared only at the end of the
1880 // composite location
1881 if (lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
1882 if (i != (compLoc1.getSize() - 1)) {
1883 throw new Error("The shared location " + loc1.getLocIdentifier()
1884 + " cannot be appeared in the middle of composite location at" + msg);
1888 if (lattice.getSharedLocSet().contains(loc2.getLocIdentifier())) {
1889 if (i != (compLoc2.getSize() - 1)) {
1890 throw new Error("The shared location " + loc2.getLocIdentifier()
1891 + " cannot be appeared in the middle of composite location at " + msg);
1895 // if (!lattice1.equals(lattice2)) {
1896 // throw new Error("Failed to compare two locations of " + compLoc1 +
1897 // " and " + compLoc2
1898 // + " because they are not comparable at " + msg);
1901 if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1903 // check if the current location is the spinning location
1904 // note that the spinning location only can be appeared in the last
1905 // part of the composite location
1906 if (awareSharedLoc && numOfTie == compLoc1.getSize()
1907 && lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
1908 return ComparisonResult.GREATER;
1911 } else if (lattice.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1912 return ComparisonResult.GREATER;
1914 return ComparisonResult.LESS;
1919 if (numOfTie == compLoc1.getSize()) {
1921 if (numOfTie != compLoc2.getSize()) {
1924 return ComparisonResult.INCOMPARABLE;
1926 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1927 + " because they are not comparable at " + msg);
1932 return ComparisonResult.EQUAL;
1935 return ComparisonResult.LESS;
1939 public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet, String errMsg) {
1941 // System.out.println("Calculating GLB=" + inputSet);
1942 CompositeLocation glbCompLoc = new CompositeLocation();
1944 // calculate GLB of the first(priority) element
1945 Set<String> priorityLocIdentifierSet = new HashSet<String>();
1946 Descriptor priorityDescriptor = null;
1948 Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1949 new Hashtable<String, Set<CompositeLocation>>();
1950 // mapping from the priority loc ID to its full representation by the
1951 // composite location
1953 int maxTupleSize = 0;
1954 CompositeLocation maxCompLoc = null;
1956 Location prevPriorityLoc = null;
1957 for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1958 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1959 if (compLoc.getSize() > maxTupleSize) {
1960 maxTupleSize = compLoc.getSize();
1961 maxCompLoc = compLoc;
1963 Location priorityLoc = compLoc.get(0);
1964 String priorityLocId = priorityLoc.getLocIdentifier();
1965 priorityLocIdentifierSet.add(priorityLocId);
1967 if (locId2CompLocSet.containsKey(priorityLocId)) {
1968 locId2CompLocSet.get(priorityLocId).add(compLoc);
1970 Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1971 newSet.add(compLoc);
1972 locId2CompLocSet.put(priorityLocId, newSet);
1975 // check if priority location are coming from the same lattice
1976 if (priorityDescriptor == null) {
1977 priorityDescriptor = priorityLoc.getDescriptor();
1979 priorityDescriptor = getCommonParentDescriptor(priorityLoc, prevPriorityLoc, errMsg);
1981 prevPriorityLoc = priorityLoc;
1982 // else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1983 // throw new Error("Failed to calculate GLB of " + inputSet
1984 // + " because they are from different lattices.");
1988 SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1989 String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1991 glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1992 Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1994 if (compSet == null) {
1995 // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1996 // mean that the result is already lower than <x1,y1> and <x2,y2>
1997 // assign TOP to the rest of the location elements
1999 // in this case, do not take care about delta
2000 // CompositeLocation inputComp = inputSet.iterator().next();
2001 for (int i = 1; i < maxTupleSize; i++) {
2002 glbCompLoc.addLocation(Location.createTopLocation(maxCompLoc.get(i).getDescriptor()));
2006 // here find out composite location that has a maximum length tuple
2007 // if we have three input set: [A], [A,B], [A,B,C]
2008 // maximum length tuple will be [A,B,C]
2010 CompositeLocation maxFromCompSet = null;
2011 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2012 CompositeLocation c = (CompositeLocation) iterator.next();
2013 if (c.getSize() > max) {
2019 if (compSet.size() == 1) {
2020 // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
2021 CompositeLocation comp = compSet.iterator().next();
2022 for (int i = 1; i < comp.getSize(); i++) {
2023 glbCompLoc.addLocation(comp.get(i));
2026 // if input location corresponding to glb is a delta, need to apply
2027 // delta to glb result
2028 if (comp instanceof DeltaLocation) {
2029 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2033 // when GLB(x1,x2)==x1 and x2 : GLB case 1
2034 // if more than one location shares the same priority GLB
2035 // need to calculate the rest of GLB loc
2037 // setup input set starting from the second tuple item
2038 Set<CompositeLocation> innerGLBInput = new HashSet<CompositeLocation>();
2039 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2040 CompositeLocation compLoc = (CompositeLocation) iterator.next();
2041 CompositeLocation innerCompLoc = new CompositeLocation();
2042 for (int idx = 1; idx < compLoc.getSize(); idx++) {
2043 innerCompLoc.addLocation(compLoc.get(idx));
2045 if (innerCompLoc.getSize() > 0) {
2046 innerGLBInput.add(innerCompLoc);
2050 if (innerGLBInput.size() > 0) {
2051 CompositeLocation innerGLB = CompositeLattice.calculateGLB(innerGLBInput, errMsg);
2052 for (int idx = 0; idx < innerGLB.getSize(); idx++) {
2053 glbCompLoc.addLocation(innerGLB.get(idx));
2057 // if input location corresponding to glb is a delta, need to apply
2058 // delta to glb result
2060 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2061 CompositeLocation compLoc = (CompositeLocation) iterator.next();
2062 if (compLoc instanceof DeltaLocation) {
2063 if (glbCompLoc.equals(compLoc)) {
2064 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2073 // System.out.println("GLB=" + glbCompLoc);
2078 static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
2080 SSJavaLattice<String> lattice = null;
2082 if (d instanceof ClassDescriptor) {
2083 lattice = ssjava.getCd2lattice().get(d);
2084 } else if (d instanceof MethodDescriptor) {
2085 if (ssjava.getMd2lattice().containsKey(d)) {
2086 lattice = ssjava.getMd2lattice().get(d);
2088 // use default lattice for the method
2089 lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
2096 static Descriptor getCommonParentDescriptor(Location loc1, Location loc2, String msg) {
2098 Descriptor d1 = loc1.getDescriptor();
2099 Descriptor d2 = loc2.getDescriptor();
2101 Descriptor descriptor;
2103 if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
2105 if (d1.equals(d2)) {
2108 // identifying which one is parent class
2109 Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
2110 Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
2112 if (d1 == null && d2 == null) {
2113 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2114 + " because they are not comparable at " + msg);
2115 } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
2117 } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
2120 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2121 + " because they are not comparable at " + msg);
2125 } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
2127 if (d1.equals(d2)) {
2131 // identifying which one is parent class
2132 MethodDescriptor md1 = (MethodDescriptor) d1;
2133 MethodDescriptor md2 = (MethodDescriptor) d2;
2135 if (!md1.matches(md2)) {
2136 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2137 + " because they are not comparable at " + msg);
2140 Set<Descriptor> d1SubClassesSet =
2141 ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
2142 Set<Descriptor> d2SubClassesSet =
2143 ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
2145 if (d1 == null && d2 == null) {
2146 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2147 + " because they are not comparable at " + msg);
2148 } else if (d1 != null && d1SubClassesSet.contains(d2)) {
2150 } else if (d2 != null && d2SubClassesSet.contains(d1)) {
2153 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2154 + " because they are not comparable at " + msg);
2159 throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2160 + " because they are not comparable at " + msg);
2169 class ComparisonResult {
2171 public static final int GREATER = 0;
2172 public static final int EQUAL = 1;
2173 public static final int LESS = 2;
2174 public static final int INCOMPARABLE = 3;
2181 class ReturnLocGenerator {
2183 public static final int PARAMISHIGHER = 0;
2184 public static final int PARAMISSAME = 1;
2185 public static final int IGNORE = 2;
2187 private Hashtable<Integer, Integer> paramIdx2paramType;
2189 private CompositeLocation declaredReturnLoc = null;
2191 public ReturnLocGenerator(CompositeLocation returnLoc, MethodDescriptor md,
2192 List<CompositeLocation> params, String msg) {
2194 CompositeLocation thisLoc = params.get(0);
2195 if (returnLoc.get(0).equals(thisLoc.get(0)) && returnLoc.getSize() > 1) {
2196 // if the declared return location consists of THIS and field location,
2197 // return location for the caller's side has to have same field element
2198 this.declaredReturnLoc = returnLoc;
2200 // creating mappings
2201 paramIdx2paramType = new Hashtable<Integer, Integer>();
2202 for (int i = 0; i < params.size(); i++) {
2203 CompositeLocation param = params.get(i);
2204 int compareResult = CompositeLattice.compare(param, returnLoc, true, msg);
2207 if (compareResult == ComparisonResult.GREATER) {
2209 } else if (compareResult == ComparisonResult.EQUAL) {
2214 paramIdx2paramType.put(new Integer(i), new Integer(type));
2220 public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
2222 if (declaredReturnLoc != null) {
2223 // when developer specify that the return value is [THIS,field]
2224 // needs to translate to the caller's location
2225 CompositeLocation callerLoc = new CompositeLocation();
2226 CompositeLocation callerBaseLocation = args.get(0);
2228 for (int i = 0; i < callerBaseLocation.getSize(); i++) {
2229 callerLoc.addLocation(callerBaseLocation.get(i));
2231 for (int i = 1; i < declaredReturnLoc.getSize(); i++) {
2232 callerLoc.addLocation(declaredReturnLoc.get(i));
2236 // compute the highest possible location in caller's side
2237 assert paramIdx2paramType.keySet().size() == args.size();
2239 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
2240 for (int i = 0; i < args.size(); i++) {
2241 int type = (paramIdx2paramType.get(new Integer(i))).intValue();
2242 CompositeLocation argLoc = args.get(i);
2243 if (type == PARAMISHIGHER || type == PARAMISSAME) {
2244 // return loc is equal to or lower than param
2245 inputGLB.add(argLoc);
2249 // compute GLB of arguments subset that are same or higher than return
2251 if (inputGLB.isEmpty()) {
2252 CompositeLocation rtr =
2253 new CompositeLocation(Location.createTopLocation(args.get(0).get(0).getDescriptor()));
2256 CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB, "");