1 package Analysis.SSJava;
3 import java.util.ArrayList;
4 import java.util.Collections;
5 import java.util.Comparator;
6 import java.util.HashSet;
7 import java.util.Hashtable;
8 import java.util.Iterator;
11 import java.util.StringTokenizer;
12 import java.util.Vector;
14 import Analysis.SSJava.FlowDownCheck.ComparisonResult;
15 import Analysis.SSJava.FlowDownCheck.CompositeLattice;
16 import IR.AnnotationDescriptor;
17 import IR.ClassDescriptor;
19 import IR.FieldDescriptor;
20 import IR.MethodDescriptor;
21 import IR.NameDescriptor;
24 import IR.SymbolTable;
25 import IR.TypeDescriptor;
26 import IR.VarDescriptor;
27 import IR.Tree.ArrayAccessNode;
28 import IR.Tree.AssignmentNode;
29 import IR.Tree.BlockExpressionNode;
30 import IR.Tree.BlockNode;
31 import IR.Tree.BlockStatementNode;
32 import IR.Tree.CastNode;
33 import IR.Tree.CreateObjectNode;
34 import IR.Tree.DeclarationNode;
35 import IR.Tree.ExpressionNode;
36 import IR.Tree.FieldAccessNode;
37 import IR.Tree.IfStatementNode;
39 import IR.Tree.LiteralNode;
40 import IR.Tree.LoopNode;
41 import IR.Tree.MethodInvokeNode;
42 import IR.Tree.NameNode;
43 import IR.Tree.OpNode;
44 import IR.Tree.ReturnNode;
45 import IR.Tree.SubBlockNode;
46 import IR.Tree.SwitchBlockNode;
47 import IR.Tree.SwitchStatementNode;
48 import IR.Tree.SynchronizedNode;
49 import IR.Tree.TertiaryNode;
50 import IR.Tree.TreeNode;
53 public class FlowDownCheck {
56 static SSJavaAnalysis ssjava;
58 Set<ClassDescriptor> toanalyze;
59 List<ClassDescriptor> toanalyzeList;
61 Set<MethodDescriptor> toanalyzeMethod;
62 List<MethodDescriptor> toanalyzeMethodList;
64 // mapping from 'descriptor' to 'composite location'
65 Hashtable<Descriptor, CompositeLocation> d2loc;
67 Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
68 Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
70 // mapping from 'locID' to 'class descriptor'
71 Hashtable<String, ClassDescriptor> fieldLocName2cd;
73 boolean deterministic = true;
75 public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
79 this.toanalyzeList = new ArrayList<ClassDescriptor>();
81 this.toanalyze = new HashSet<ClassDescriptor>();
84 this.toanalyzeMethodList = new ArrayList<MethodDescriptor>();
86 this.toanalyzeMethod = new HashSet<MethodDescriptor>();
88 this.d2loc = new Hashtable<Descriptor, CompositeLocation>();
89 this.fieldLocName2cd = new Hashtable<String, ClassDescriptor>();
90 this.md2ReturnLoc = new Hashtable<MethodDescriptor, CompositeLocation>();
91 this.md2ReturnLocGen = new Hashtable<MethodDescriptor, ReturnLocGenerator>();
96 // construct mapping from the location name to the class descriptor
97 // assume that the location name is unique through the whole program
99 Set<ClassDescriptor> cdSet = ssjava.getCd2lattice().keySet();
100 for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
101 ClassDescriptor cd = (ClassDescriptor) iterator.next();
102 SSJavaLattice<String> lattice = ssjava.getCd2lattice().get(cd);
103 Set<String> fieldLocNameSet = lattice.getKeySet();
105 for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
106 String fieldLocName = (String) iterator2.next();
107 fieldLocName2cd.put(fieldLocName, cd);
114 public boolean toAnalyzeIsEmpty() {
116 return toanalyzeList.isEmpty();
118 return toanalyze.isEmpty();
122 public ClassDescriptor toAnalyzeNext() {
124 return toanalyzeList.remove(0);
126 ClassDescriptor cd = toanalyze.iterator().next();
127 toanalyze.remove(cd);
132 public void setupToAnalyze() {
133 SymbolTable classtable = state.getClassSymbolTable();
135 toanalyzeList.clear();
136 toanalyzeList.addAll(classtable.getValueSet());
137 Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
138 public int compare(ClassDescriptor o1, ClassDescriptor o2) {
139 return o1.getClassName().compareTo(o2.getClassName());
144 toanalyze.addAll(classtable.getValueSet());
148 public void setupToAnalazeMethod(ClassDescriptor cd) {
150 SymbolTable methodtable = cd.getMethodTable();
152 toanalyzeMethodList.clear();
153 toanalyzeMethodList.addAll(methodtable.getValueSet());
154 Collections.sort(toanalyzeMethodList, new Comparator<MethodDescriptor>() {
155 public int compare(MethodDescriptor o1, MethodDescriptor o2) {
156 return o1.getSymbol().compareTo(o2.getSymbol());
160 toanalyzeMethod.clear();
161 toanalyzeMethod.addAll(methodtable.getValueSet());
165 public boolean toAnalyzeMethodIsEmpty() {
167 return toanalyzeMethodList.isEmpty();
169 return toanalyzeMethod.isEmpty();
173 public MethodDescriptor toAnalyzeMethodNext() {
175 return toanalyzeMethodList.remove(0);
177 MethodDescriptor md = toanalyzeMethod.iterator().next();
178 toanalyzeMethod.remove(md);
183 public void flowDownCheck() {
185 // phase 1 : checking declaration node and creating mapping of 'type
186 // desciptor' & 'location'
189 while (!toAnalyzeIsEmpty()) {
190 ClassDescriptor cd = toAnalyzeNext();
192 if (ssjava.needToBeAnnoated(cd)) {
194 ClassDescriptor superDesc = cd.getSuperDesc();
196 if (superDesc != null && (!superDesc.getSymbol().equals("Object"))) {
197 checkOrderingInheritance(superDesc, cd);
200 checkDeclarationInClass(cd);
202 setupToAnalazeMethod(cd);
203 while (!toAnalyzeMethodIsEmpty()) {
204 MethodDescriptor md = toAnalyzeMethodNext();
205 if (ssjava.needTobeAnnotated(md)) {
206 checkDeclarationInMethodBody(cd, md);
214 // phase2 : checking assignments
217 while (!toAnalyzeIsEmpty()) {
218 ClassDescriptor cd = toAnalyzeNext();
220 setupToAnalazeMethod(cd);
221 while (!toAnalyzeMethodIsEmpty()) {
222 MethodDescriptor md = toAnalyzeMethodNext();
223 if (ssjava.needTobeAnnotated(md)) {
224 System.out.println("SSJAVA: Checking assignments: " + md);
225 checkMethodBody(cd, md);
232 private void checkOrderingInheritance(ClassDescriptor superCd, ClassDescriptor cd) {
233 // here, we're going to check that sub class keeps same relative orderings
234 // in respect to super class
236 SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
237 SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
239 if (superLattice != null) {
240 // if super class doesn't define lattice, then we don't need to check its
242 if (subLattice == null) {
243 throw new Error("If a parent class '" + superCd
244 + "' has a ordering lattice, its subclass '" + cd + "' should have one.");
247 Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
248 Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
250 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
251 Pair<String, String> pair = (Pair<String, String>) iterator.next();
253 if (!subPairSet.contains(pair)) {
254 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
255 + pair.getSecond() + " < " + pair.getFirst()
256 + "' that is defined by its superclass '" + superCd + "'.");
261 MethodLattice<String> superMethodDefaultLattice = ssjava.getMethodDefaultLattice(superCd);
262 MethodLattice<String> subMethodDefaultLattice = ssjava.getMethodDefaultLattice(cd);
264 if (superMethodDefaultLattice != null) {
265 if (subMethodDefaultLattice == null) {
266 throw new Error("When a parent class '" + superCd
267 + "' defines a default method lattice, its subclass '" + cd + "' should define one.");
270 Set<Pair<String, String>> superPairSet = superMethodDefaultLattice.getOrderingPairSet();
271 Set<Pair<String, String>> subPairSet = subMethodDefaultLattice.getOrderingPairSet();
273 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
274 Pair<String, String> pair = (Pair<String, String>) iterator.next();
276 if (!subPairSet.contains(pair)) {
277 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
278 + pair.getSecond() + " < " + pair.getFirst()
279 + "' that is defined by its superclass '" + superCd
280 + "' in the method default lattice.");
288 public Hashtable getMap() {
292 private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
293 BlockNode bn = state.getMethodBody(md);
295 // first, check annotations on method parameters
296 List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
297 for (int i = 0; i < md.numParameters(); i++) {
298 // process annotations on method parameters
299 VarDescriptor vd = (VarDescriptor) md.getParameter(i);
300 assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), bn);
301 paramList.add(d2loc.get(vd));
304 // second, check return location annotation
305 if (!md.getReturnType().isVoid()) {
306 CompositeLocation returnLocComp = null;
307 Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
308 if (methodAnnotations != null) {
309 for (int i = 0; i < methodAnnotations.size(); i++) {
310 AnnotationDescriptor an = methodAnnotations.elementAt(i);
311 if (an.getMarker().equals(ssjava.RETURNLOC)) {
312 // developer explicitly defines method lattice
313 String returnLocDeclaration = an.getValue();
314 returnLocComp = parseLocationDeclaration(md, null, returnLocDeclaration);
315 md2ReturnLoc.put(md, returnLocComp);
319 if (returnLocComp == null) {
320 MethodLattice<String> methodDefaultLattice = ssjava.getMethodDefaultLattice(cd);
321 if (methodDefaultLattice.getReturnLoc() != null) {
322 returnLocComp = parseLocationDeclaration(md, null, methodDefaultLattice.getReturnLoc());
323 md2ReturnLoc.put(md, returnLocComp);
327 if (!md2ReturnLoc.containsKey(md)) {
328 throw new Error("Return location is not specified for the method " + md + " at "
329 + cd.getSourceFileName());
332 // check this location
333 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
334 String thisLocId = methodLattice.getThisLoc();
335 if (thisLocId == null) {
336 throw new Error("Method '" + md + "' does not have the definition of 'this' location at "
337 + md.getClassDesc().getSourceFileName());
339 CompositeLocation thisLoc = new CompositeLocation(new Location(md, thisLocId));
340 paramList.add(0, thisLoc);
342 md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), paramList,
343 generateErrorMessage(cd, null)));
346 // third, check declarations inside of method
348 checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
352 private void checkDeclarationInBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn) {
353 bn.getVarTable().setParent(nametable);
354 for (int i = 0; i < bn.size(); i++) {
355 BlockStatementNode bsn = bn.get(i);
356 checkDeclarationInBlockStatementNode(md, bn.getVarTable(), bsn);
360 private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
361 BlockStatementNode bsn) {
363 switch (bsn.kind()) {
364 case Kind.SubBlockNode:
365 checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
368 case Kind.DeclarationNode:
369 checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
373 checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
376 case Kind.IfStatementNode:
377 checkDeclarationInIfStatementNode(md, nametable, (IfStatementNode) bsn);
380 case Kind.SwitchStatementNode:
381 checkDeclarationInSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn);
384 case Kind.SynchronizedNode:
385 checkDeclarationInSynchronizedNode(md, nametable, (SynchronizedNode) bsn);
391 private void checkDeclarationInSynchronizedNode(MethodDescriptor md, SymbolTable nametable,
392 SynchronizedNode sbn) {
393 checkDeclarationInBlockNode(md, nametable, sbn.getBlockNode());
396 private void checkDeclarationInSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
397 SwitchStatementNode ssn) {
398 BlockNode sbn = ssn.getSwitchBody();
399 for (int i = 0; i < sbn.size(); i++) {
400 SwitchBlockNode node = (SwitchBlockNode) sbn.get(i);
401 checkDeclarationInBlockNode(md, nametable, node.getSwitchBlockStatement());
405 private void checkDeclarationInIfStatementNode(MethodDescriptor md, SymbolTable nametable,
406 IfStatementNode isn) {
407 checkDeclarationInBlockNode(md, nametable, isn.getTrueBlock());
408 if (isn.getFalseBlock() != null)
409 checkDeclarationInBlockNode(md, nametable, isn.getFalseBlock());
412 private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
414 if (ln.getType() == LoopNode.FORLOOP) {
415 // check for loop case
416 ClassDescriptor cd = md.getClassDesc();
417 BlockNode bn = ln.getInitializer();
418 for (int i = 0; i < bn.size(); i++) {
419 BlockStatementNode bsn = bn.get(i);
420 checkDeclarationInBlockStatementNode(md, nametable, bsn);
425 checkDeclarationInBlockNode(md, nametable, ln.getBody());
428 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
429 BlockNode bn = state.getMethodBody(md);
430 checkLocationFromBlockNode(md, md.getParameterTable(), bn, null);
433 private String generateErrorMessage(ClassDescriptor cd, TreeNode tn) {
435 return cd.getSourceFileName() + "::" + tn.getNumLine();
437 return cd.getSourceFileName();
442 private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
443 BlockNode bn, CompositeLocation constraint) {
445 bn.getVarTable().setParent(nametable);
446 for (int i = 0; i < bn.size(); i++) {
447 BlockStatementNode bsn = bn.get(i);
448 checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn, constraint);
450 return new CompositeLocation();
454 private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
455 SymbolTable nametable, BlockStatementNode bsn, CompositeLocation constraint) {
457 CompositeLocation compLoc = null;
458 switch (bsn.kind()) {
459 case Kind.BlockExpressionNode:
461 checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, constraint);
464 case Kind.DeclarationNode:
465 compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn, constraint);
468 case Kind.IfStatementNode:
469 compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn, constraint);
473 compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn, constraint);
476 case Kind.ReturnNode:
477 compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn, constraint);
480 case Kind.SubBlockNode:
481 compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn, constraint);
484 case Kind.ContinueBreakNode:
485 compLoc = new CompositeLocation();
488 case Kind.SwitchStatementNode:
490 checkLocationFromSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, constraint);
496 private CompositeLocation checkLocationFromSwitchStatementNode(MethodDescriptor md,
497 SymbolTable nametable, SwitchStatementNode ssn, CompositeLocation constraint) {
499 ClassDescriptor cd = md.getClassDesc();
500 CompositeLocation condLoc =
501 checkLocationFromExpressionNode(md, nametable, ssn.getCondition(), new CompositeLocation(),
503 BlockNode sbn = ssn.getSwitchBody();
505 constraint = generateNewConstraint(constraint, condLoc);
507 for (int i = 0; i < sbn.size(); i++) {
508 checkLocationFromSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), constraint);
510 return new CompositeLocation();
513 private CompositeLocation checkLocationFromSwitchBlockNode(MethodDescriptor md,
514 SymbolTable nametable, SwitchBlockNode sbn, CompositeLocation constraint) {
516 CompositeLocation blockLoc =
517 checkLocationFromBlockNode(md, nametable, sbn.getSwitchBlockStatement(), constraint);
523 private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
524 ReturnNode rn, CompositeLocation constraint) {
526 ExpressionNode returnExp = rn.getReturnExpression();
528 CompositeLocation returnValueLoc;
529 if (returnExp != null) {
531 checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation(),
534 // if this return statement is inside branch, return value has an implicit
535 // flow from conditional location
536 if (constraint != null) {
537 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
538 inputGLB.add(returnValueLoc);
539 inputGLB.add(constraint);
540 returnValueLoc = CompositeLattice.calculateGLB(inputGLB);
543 // check if return value is equal or higher than RETRUNLOC of method
544 // declaration annotation
545 CompositeLocation declaredReturnLoc = md2ReturnLoc.get(md);
548 CompositeLattice.compare(returnValueLoc, declaredReturnLoc,
549 generateErrorMessage(md.getClassDesc(), rn));
551 if (compareResult == ComparisonResult.LESS || compareResult == ComparisonResult.INCOMPARABLE) {
553 "Return value location is not equal or higher than the declaraed return location at "
554 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
558 return new CompositeLocation();
561 private boolean hasOnlyLiteralValue(ExpressionNode en) {
562 if (en.kind() == Kind.LiteralNode) {
569 private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
570 LoopNode ln, CompositeLocation constraint) {
572 ClassDescriptor cd = md.getClassDesc();
573 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
575 CompositeLocation condLoc =
576 checkLocationFromExpressionNode(md, nametable, ln.getCondition(),
577 new CompositeLocation(), constraint, false);
578 addLocationType(ln.getCondition().getType(), (condLoc));
580 constraint = generateNewConstraint(constraint, condLoc);
581 checkLocationFromBlockNode(md, nametable, ln.getBody(), constraint);
583 return new CompositeLocation();
586 // check 'for loop' case
587 BlockNode bn = ln.getInitializer();
588 bn.getVarTable().setParent(nametable);
590 // calculate glb location of condition and update statements
591 CompositeLocation condLoc =
592 checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
593 new CompositeLocation(), constraint, false);
594 addLocationType(ln.getCondition().getType(), condLoc);
596 constraint = generateNewConstraint(constraint, condLoc);
598 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate(), constraint);
599 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody(), constraint);
601 return new CompositeLocation();
607 private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
608 SymbolTable nametable, SubBlockNode sbn, CompositeLocation constraint) {
609 CompositeLocation compLoc =
610 checkLocationFromBlockNode(md, nametable, sbn.getBlockNode(), constraint);
614 private CompositeLocation generateNewConstraint(CompositeLocation currentCon,
615 CompositeLocation newCon) {
617 if (currentCon == null) {
620 // compute GLB of current constraint and new constraint
621 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
622 inputSet.add(currentCon);
623 inputSet.add(newCon);
624 return CompositeLattice.calculateGLB(inputSet);
629 private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
630 SymbolTable nametable, IfStatementNode isn, CompositeLocation constraint) {
632 CompositeLocation condLoc =
633 checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation(),
636 addLocationType(isn.getCondition().getType(), condLoc);
638 constraint = generateNewConstraint(constraint, condLoc);
639 checkLocationFromBlockNode(md, nametable, isn.getTrueBlock(), constraint);
641 if (isn.getFalseBlock() != null) {
642 checkLocationFromBlockNode(md, nametable, isn.getFalseBlock(), constraint);
645 return new CompositeLocation();
648 private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
649 SymbolTable nametable, DeclarationNode dn, CompositeLocation constraint) {
651 VarDescriptor vd = dn.getVarDescriptor();
653 CompositeLocation destLoc = d2loc.get(vd);
655 if (dn.getExpression() != null) {
656 CompositeLocation expressionLoc =
657 checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
658 new CompositeLocation(), constraint, false);
659 // addTypeLocation(dn.getExpression().getType(), expressionLoc);
661 if (expressionLoc != null) {
662 // checking location order
663 if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc,
664 generateErrorMessage(md.getClassDesc(), dn))) {
665 throw new Error("The value flow from " + expressionLoc + " to " + destLoc
666 + " does not respect location hierarchy on the assignment " + dn.printNode(0)
667 + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
670 return expressionLoc;
674 return new CompositeLocation();
680 private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
682 checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
685 private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
686 SymbolTable nametable, BlockExpressionNode ben, CompositeLocation constraint) {
687 CompositeLocation compLoc =
688 checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null, constraint, false);
689 // addTypeLocation(ben.getExpression().getType(), compLoc);
693 private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
694 SymbolTable nametable, ExpressionNode en, CompositeLocation loc,
695 CompositeLocation constraint, boolean isLHS) {
697 CompositeLocation compLoc = null;
700 case Kind.AssignmentNode:
702 checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc, constraint);
705 case Kind.FieldAccessNode:
707 checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc, constraint);
711 compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc, constraint);
715 compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en, constraint);
718 case Kind.CreateObjectNode:
719 compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
722 case Kind.ArrayAccessNode:
724 checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en, constraint, isLHS);
727 case Kind.LiteralNode:
728 compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
731 case Kind.MethodInvokeNode:
733 checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc, constraint);
736 case Kind.TertiaryNode:
737 compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en, constraint);
741 compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en, constraint);
744 // case Kind.InstanceOfNode:
745 // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
748 // case Kind.ArrayInitializerNode:
749 // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
753 // case Kind.ClassTypeNode:
754 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
757 // case Kind.OffsetNode:
758 // checkOffsetNode(md, nametable, (OffsetNode)en, td);
765 // addTypeLocation(en.getType(), compLoc);
770 private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
771 CastNode cn, CompositeLocation constraint) {
773 ExpressionNode en = cn.getExpression();
774 return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
779 private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
780 SymbolTable nametable, TertiaryNode tn, CompositeLocation constraint) {
781 ClassDescriptor cd = md.getClassDesc();
783 CompositeLocation condLoc =
784 checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation(),
786 addLocationType(tn.getCond().getType(), condLoc);
787 CompositeLocation trueLoc =
788 checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation(),
790 addLocationType(tn.getTrueExpr().getType(), trueLoc);
791 CompositeLocation falseLoc =
792 checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation(),
794 addLocationType(tn.getFalseExpr().getType(), falseLoc);
796 // locations from true/false branches can be TOP when there are only literal
798 // in this case, we don't need to check flow down rule!
800 // check if condLoc is higher than trueLoc & falseLoc
801 if (!trueLoc.get(0).isTop()
802 && !CompositeLattice.isGreaterThan(condLoc, trueLoc, generateErrorMessage(cd, tn))) {
804 "The location of the condition expression is lower than the true expression at "
805 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
808 if (!falseLoc.get(0).isTop()
809 && !CompositeLattice.isGreaterThan(condLoc, falseLoc,
810 generateErrorMessage(cd, tn.getCond()))) {
812 "The location of the condition expression is lower than the true expression at "
813 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
816 // then, return glb of trueLoc & falseLoc
817 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
818 glbInputSet.add(trueLoc);
819 glbInputSet.add(falseLoc);
821 return CompositeLattice.calculateGLB(glbInputSet);
824 private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
825 SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc,
826 CompositeLocation constraint) {
828 checkCalleeConstraints(md, nametable, min, constraint);
830 CompositeLocation baseLocation = null;
831 if (min.getExpression() != null) {
833 checkLocationFromExpressionNode(md, nametable, min.getExpression(),
834 new CompositeLocation(), constraint, false);
836 String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
837 baseLocation = new CompositeLocation(new Location(md, thisLocId));
840 if (!min.getMethod().getReturnType().isVoid()) {
841 // If method has a return value, compute the highest possible return
842 // location in the caller's perspective
843 CompositeLocation ceilingLoc =
844 computeCeilingLocationForCaller(md, nametable, min, baseLocation, constraint);
848 return new CompositeLocation();
852 private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
853 SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation,
854 CompositeLocation constraint) {
855 List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
857 // by default, method has a THIS parameter
858 argList.add(baseLocation);
860 for (int i = 0; i < min.numArgs(); i++) {
861 ExpressionNode en = min.getArg(i);
862 CompositeLocation callerArg =
863 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
865 argList.add(callerArg);
868 System.out.println("\n## computeReturnLocation=" + min.getMethod() + " argList=" + argList);
869 CompositeLocation compLoc = md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
870 DeltaLocation delta = new DeltaLocation(compLoc, 1);
871 System.out.println("##computeReturnLocation=" + delta);
877 private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
878 MethodInvokeNode min, CompositeLocation constraint) {
880 if (min.numArgs() > 1) {
881 // caller needs to guarantee that it passes arguments in regarding to
882 // callee's hierarchy
883 for (int i = 0; i < min.numArgs(); i++) {
884 ExpressionNode en = min.getArg(i);
885 CompositeLocation callerArg1 =
886 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
889 VarDescriptor calleevd = (VarDescriptor) min.getMethod().getParameter(i);
890 CompositeLocation calleeLoc1 = d2loc.get(calleevd);
892 if (!callerArg1.get(0).isTop()) {
893 // here, check if ordering relations among caller's args respect
894 // ordering relations in-between callee's args
895 for (int currentIdx = 0; currentIdx < min.numArgs(); currentIdx++) {
896 if (currentIdx != i) { // skip itself
897 ExpressionNode argExp = min.getArg(currentIdx);
899 CompositeLocation callerArg2 =
900 checkLocationFromExpressionNode(md, nametable, argExp, new CompositeLocation(),
903 VarDescriptor calleevd2 = (VarDescriptor) min.getMethod().getParameter(currentIdx);
904 CompositeLocation calleeLoc2 = d2loc.get(calleevd2);
907 CompositeLattice.compare(callerArg1, callerArg2,
908 generateErrorMessage(md.getClassDesc(), min));
910 CompositeLattice.compare(calleeLoc1, calleeLoc2,
911 generateErrorMessage(md.getClassDesc(), min));
913 if (calleeResult == ComparisonResult.GREATER
914 && callerResult != ComparisonResult.GREATER) {
915 // If calleeLoc1 is higher than calleeLoc2
916 // then, caller should have same ordering relation in-bet
917 // callerLoc1 & callerLoc2
919 throw new Error("Caller doesn't respect ordering relations among method arguments:"
920 + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
933 private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
934 SymbolTable nametable, ArrayAccessNode aan, CompositeLocation constraint, boolean isLHS) {
936 ClassDescriptor cd = md.getClassDesc();
938 CompositeLocation arrayLoc =
939 checkLocationFromExpressionNode(md, nametable, aan.getExpression(),
940 new CompositeLocation(), constraint, isLHS);
941 // addTypeLocation(aan.getExpression().getType(), arrayLoc);
942 CompositeLocation indexLoc =
943 checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(),
945 // addTypeLocation(aan.getIndex().getType(), indexLoc);
948 if (!CompositeLattice.isGreaterThan(indexLoc, arrayLoc, generateErrorMessage(cd, aan))) {
949 throw new Error("Array index value is not higher than array location at "
950 + generateErrorMessage(cd, aan));
954 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
955 inputGLB.add(arrayLoc);
956 inputGLB.add(indexLoc);
957 return CompositeLattice.calculateGLB(inputGLB);
962 private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
963 SymbolTable nametable, CreateObjectNode con) {
965 ClassDescriptor cd = md.getClassDesc();
967 CompositeLocation compLoc = new CompositeLocation();
968 compLoc.addLocation(Location.createTopLocation(md));
973 private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
974 OpNode on, CompositeLocation constraint) {
976 ClassDescriptor cd = md.getClassDesc();
977 CompositeLocation leftLoc = new CompositeLocation();
979 checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc, constraint, false);
980 // addTypeLocation(on.getLeft().getType(), leftLoc);
982 CompositeLocation rightLoc = new CompositeLocation();
983 if (on.getRight() != null) {
985 checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc, constraint, false);
986 // addTypeLocation(on.getRight().getType(), rightLoc);
989 System.out.println("\n# OP NODE=" + on.printNode(0));
990 System.out.println("# left loc=" + leftLoc + " from " + on.getLeft().getClass());
991 if (on.getRight() != null) {
992 System.out.println("# right loc=" + rightLoc + " from " + on.getRight().getClass());
995 Operation op = on.getOp();
997 switch (op.getOp()) {
999 case Operation.UNARYPLUS:
1000 case Operation.UNARYMINUS:
1001 case Operation.LOGIC_NOT:
1005 case Operation.LOGIC_OR:
1006 case Operation.LOGIC_AND:
1007 case Operation.COMP:
1008 case Operation.BIT_OR:
1009 case Operation.BIT_XOR:
1010 case Operation.BIT_AND:
1011 case Operation.ISAVAILABLE:
1012 case Operation.EQUAL:
1013 case Operation.NOTEQUAL:
1020 case Operation.MULT:
1023 case Operation.LEFTSHIFT:
1024 case Operation.RIGHTSHIFT:
1025 case Operation.URIGHTSHIFT:
1027 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
1028 inputSet.add(leftLoc);
1029 inputSet.add(rightLoc);
1030 CompositeLocation glbCompLoc = CompositeLattice.calculateGLB(inputSet);
1034 throw new Error(op.toString());
1039 private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
1040 SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
1042 // literal value has the top location so that value can be flowed into any
1044 Location literalLoc = Location.createTopLocation(md);
1045 loc.addLocation(literalLoc);
1050 private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
1051 NameNode nn, CompositeLocation loc, CompositeLocation constraint) {
1053 NameDescriptor nd = nn.getName();
1054 if (nd.getBase() != null) {
1056 checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc, constraint, false);
1058 String varname = nd.toString();
1059 if (varname.equals("this")) {
1061 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
1062 String thisLocId = methodLattice.getThisLoc();
1063 if (thisLocId == null) {
1064 throw new Error("The location for 'this' is not defined at "
1065 + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
1067 Location locElement = new Location(md, thisLocId);
1068 loc.addLocation(locElement);
1072 Descriptor d = (Descriptor) nametable.get(varname);
1074 // CompositeLocation localLoc = null;
1075 if (d instanceof VarDescriptor) {
1076 VarDescriptor vd = (VarDescriptor) d;
1077 // localLoc = d2loc.get(vd);
1078 // the type of var descriptor has a composite location!
1079 loc = ((CompositeLocation) vd.getType().getExtension()).clone();
1080 } else if (d instanceof FieldDescriptor) {
1081 // the type of field descriptor has a location!
1082 FieldDescriptor fd = (FieldDescriptor) d;
1083 if (fd.isStatic()) {
1085 // if it is 'static final', the location has TOP since no one can
1087 loc.addLocation(Location.createTopLocation(md));
1090 // if 'static', the location has pre-assigned global loc
1091 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1092 String globalLocId = localLattice.getGlobalLoc();
1093 if (globalLocId == null) {
1094 throw new Error("Global location element is not defined in the method " + md);
1096 Location globalLoc = new Location(md, globalLocId);
1098 loc.addLocation(globalLoc);
1101 // the location of field access starts from this, followed by field
1103 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1104 Location thisLoc = new Location(md, localLattice.getThisLoc());
1105 loc.addLocation(thisLoc);
1108 Location fieldLoc = (Location) fd.getType().getExtension();
1109 loc.addLocation(fieldLoc);
1110 } else if (d == null) {
1112 // check if the var is a static field of the class
1113 FieldDescriptor fd = nn.getField();
1114 ClassDescriptor cd = nn.getClassDesc();
1116 if (fd != null && cd != null) {
1118 if (fd.isStatic() && fd.isFinal()) {
1119 loc.addLocation(Location.createTopLocation(md));
1122 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1123 Location fieldLoc = new Location(md, localLattice.getThisLoc());
1124 loc.addLocation(fieldLoc);
1133 private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1134 SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc,
1135 CompositeLocation constraint) {
1137 ExpressionNode left = fan.getExpression();
1138 TypeDescriptor ltd = left.getType();
1140 FieldDescriptor fd = fan.getField();
1142 String varName = null;
1143 if (left.kind() == Kind.NameNode) {
1144 NameDescriptor nd = ((NameNode) left).getName();
1145 varName = nd.toString();
1148 if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
1149 // using a class name directly or access using this
1150 if (fd.isStatic() && fd.isFinal()) {
1151 loc.addLocation(Location.createTopLocation(md));
1156 loc = checkLocationFromExpressionNode(md, nametable, left, loc, constraint, false);
1157 if (!left.getType().isPrimitive()) {
1158 Location fieldLoc = getFieldLocation(fd);
1159 loc.addLocation(fieldLoc);
1165 private Location getFieldLocation(FieldDescriptor fd) {
1167 Location fieldLoc = (Location) fd.getType().getExtension();
1169 // handle the case that method annotation checking skips checking field
1171 if (fieldLoc == null) {
1172 fieldLoc = checkFieldDeclaration(fd.getClassDescriptor(), fd);
1179 private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1180 SymbolTable nametable, AssignmentNode an, CompositeLocation loc, CompositeLocation constraint) {
1182 System.out.println("\n# ASSIGNMENTNODE=" + an.printNode(0));
1184 ClassDescriptor cd = md.getClassDesc();
1186 Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1188 boolean postinc = true;
1189 if (an.getOperation().getBaseOp() == null
1190 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1191 .getBaseOp().getOp() != Operation.POSTDEC))
1194 // if LHS is array access node, need to check if array index is higher
1195 // than array itself
1196 CompositeLocation destLocation =
1197 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1200 CompositeLocation rhsLocation;
1201 CompositeLocation srcLocation;
1205 checkLocationFromExpressionNode(md, nametable, an.getSrc(), new CompositeLocation(),
1208 System.out.println("dstLocation=" + destLocation);
1209 System.out.println("rhsLocation=" + rhsLocation);
1210 System.out.println("constraint=" + constraint);
1212 if (constraint != null) {
1213 inputGLBSet.add(rhsLocation);
1214 inputGLBSet.add(constraint);
1215 srcLocation = CompositeLattice.calculateGLB(inputGLBSet);
1217 srcLocation = rhsLocation;
1220 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1221 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1222 + " does not respect location hierarchy on the assignment " + an.printNode(0) + " at "
1223 + cd.getSourceFileName() + "::" + an.getNumLine());
1229 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1232 if (constraint != null) {
1233 inputGLBSet.add(rhsLocation);
1234 inputGLBSet.add(constraint);
1235 srcLocation = CompositeLattice.calculateGLB(inputGLBSet);
1237 srcLocation = rhsLocation;
1240 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1241 throw new Error("Location " + destLocation
1242 + " is not allowed to have the value flow that moves within the same location at "
1243 + cd.getSourceFileName() + "::" + an.getNumLine());
1248 return destLocation;
1251 private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1252 SymbolTable nametable, TreeNode n) {
1254 ClassDescriptor cd = md.getClassDesc();
1255 Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1257 // currently enforce every variable to have corresponding location
1258 if (annotationVec.size() == 0) {
1259 throw new Error("Location is not assigned to variable " + vd.getSymbol() + " in the method "
1260 + md.getSymbol() + " of the class " + cd.getSymbol());
1263 if (annotationVec.size() > 1) { // variable can have at most one location
1264 throw new Error(vd.getSymbol() + " has more than one location.");
1267 AnnotationDescriptor ad = annotationVec.elementAt(0);
1269 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1271 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1272 String locDec = ad.getValue(); // check if location is defined
1274 if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1275 DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1276 d2loc.put(vd, deltaLoc);
1277 addLocationType(vd.getType(), deltaLoc);
1279 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1281 Location lastElement = compLoc.get(compLoc.getSize() - 1);
1282 if (ssjava.isSharedLocation(lastElement)) {
1283 ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1286 d2loc.put(vd, compLoc);
1287 addLocationType(vd.getType(), compLoc);
1295 private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1298 int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1301 int beginIdx = dIdx + 6;
1302 locDec = locDec.substring(beginIdx, locDec.length() - 1);
1303 dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1306 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1307 DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1312 private Location parseFieldLocDeclaraton(String decl, String msg) {
1314 int idx = decl.indexOf(".");
1315 String className = decl.substring(0, idx);
1316 String fieldName = decl.substring(idx + 1);
1318 className.replaceAll(" ", "");
1319 fieldName.replaceAll(" ", "");
1321 Descriptor d = state.getClassSymbolTable().get(className);
1324 throw new Error("The class in the location declaration '" + decl + "' does not exist at "
1328 assert (d instanceof ClassDescriptor);
1329 SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1330 if (!lattice.containsKey(fieldName)) {
1331 throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1332 + className + "' at " + msg);
1335 return new Location(d, fieldName);
1338 private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1340 CompositeLocation compLoc = new CompositeLocation();
1342 StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1343 List<String> locIdList = new ArrayList<String>();
1344 while (tokenizer.hasMoreTokens()) {
1345 String locId = tokenizer.nextToken();
1346 locIdList.add(locId);
1349 // at least,one location element needs to be here!
1350 assert (locIdList.size() > 0);
1352 // assume that loc with idx 0 comes from the local lattice
1353 // loc with idx 1 comes from the field lattice
1355 String localLocId = locIdList.get(0);
1356 SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1357 Location localLoc = new Location(md, localLocId);
1358 if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1359 throw new Error("Location " + localLocId
1360 + " is not defined in the local variable lattice at "
1361 + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : "") + ".");
1363 compLoc.addLocation(localLoc);
1365 for (int i = 1; i < locIdList.size(); i++) {
1366 String locName = locIdList.get(i);
1369 parseFieldLocDeclaraton(locName, generateErrorMessage(md.getClassDesc(), n));
1370 // ClassDescriptor cd = fieldLocName2cd.get(locName);
1371 // SSJavaLattice<String> fieldLattice =
1372 // CompositeLattice.getLatticeByDescriptor(cd);
1374 // if (fieldLattice == null || (!fieldLattice.containsKey(locName))) {
1375 // throw new Error("Location " + locName +
1376 // " is not defined in the field lattice at "
1377 // + cd.getSourceFileName() + ".");
1379 // Location fieldLoc = new Location(cd, locName);
1380 compLoc.addLocation(fieldLoc);
1387 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1388 VarDescriptor vd = dn.getVarDescriptor();
1389 assignLocationOfVarDescriptor(vd, md, nametable, dn);
1392 private void checkDeclarationInClass(ClassDescriptor cd) {
1393 // Check to see that fields are okay
1394 for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1395 FieldDescriptor fd = (FieldDescriptor) field_it.next();
1397 if (!(fd.isFinal() && fd.isStatic())) {
1398 checkFieldDeclaration(cd, fd);
1400 // for static final, assign top location by default
1401 Location loc = Location.createTopLocation(cd);
1402 addLocationType(fd.getType(), loc);
1407 private Location checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1409 Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1411 // currently enforce every field to have corresponding location
1412 if (annotationVec.size() == 0) {
1413 throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1414 + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1417 if (annotationVec.size() > 1) {
1418 // variable can have at most one location
1419 throw new Error("Field " + fd.getSymbol() + " of class " + cd
1420 + " has more than one location.");
1423 AnnotationDescriptor ad = annotationVec.elementAt(0);
1424 Location loc = null;
1426 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1427 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1428 String locationID = ad.getValue();
1429 // check if location is defined
1430 SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1431 if (lattice == null || (!lattice.containsKey(locationID))) {
1432 throw new Error("Location " + locationID
1433 + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1434 + cd.getSourceFileName() + ".");
1436 loc = new Location(cd, locationID);
1438 if (ssjava.isSharedLocation(loc)) {
1439 ssjava.mapSharedLocation2Descriptor(loc, fd);
1442 addLocationType(fd.getType(), loc);
1450 private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
1452 type.setExtension(loc);
1456 private void addLocationType(TypeDescriptor type, Location loc) {
1458 type.setExtension(loc);
1462 static class CompositeLattice {
1464 public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1466 System.out.println("isGreaterThan=" + loc1 + " " + loc2 + " msg=" + msg);
1467 int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, msg);
1468 if (baseCompareResult == ComparisonResult.EQUAL) {
1469 if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1474 } else if (baseCompareResult == ComparisonResult.GREATER) {
1482 public static int compare(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1484 System.out.println("compare=" + loc1 + " " + loc2);
1485 int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, msg);
1487 if (baseCompareResult == ComparisonResult.EQUAL) {
1488 return compareDelta(loc1, loc2);
1490 return baseCompareResult;
1495 private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1497 int deltaCount1 = 0;
1498 int deltaCount2 = 0;
1499 if (dLoc1 instanceof DeltaLocation) {
1500 deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1503 if (dLoc2 instanceof DeltaLocation) {
1504 deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1506 if (deltaCount1 < deltaCount2) {
1507 return ComparisonResult.GREATER;
1508 } else if (deltaCount1 == deltaCount2) {
1509 return ComparisonResult.EQUAL;
1511 return ComparisonResult.LESS;
1516 private static int compareBaseLocationSet(CompositeLocation compLoc1,
1517 CompositeLocation compLoc2, boolean awareSharedLoc, String msg) {
1519 // if compLoc1 is greater than compLoc2, return true
1520 // else return false;
1522 // compare one by one in according to the order of the tuple
1524 for (int i = 0; i < compLoc1.getSize(); i++) {
1525 Location loc1 = compLoc1.get(i);
1526 if (i >= compLoc2.getSize()) {
1527 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1528 + " because they are not comparable.");
1530 Location loc2 = compLoc2.get(i);
1532 Descriptor d1 = loc1.getDescriptor();
1533 Descriptor d2 = loc2.getDescriptor();
1535 Descriptor descriptor;
1537 if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
1539 if (d1.equals(d2)) {
1542 // identifying which one is parent class
1543 Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
1544 Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
1546 if (d1 == null && d2 == null) {
1547 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1548 + " because they are not comparable at " + msg);
1549 } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
1551 } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
1554 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1555 + " because they are not comparable at " + msg);
1559 } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
1561 if (d1.equals(d2)) {
1565 // identifying which one is parent class
1566 MethodDescriptor md1 = (MethodDescriptor) d1;
1567 MethodDescriptor md2 = (MethodDescriptor) d2;
1569 if (!md1.matches(md2)) {
1570 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1571 + " because they are not comparable at " + msg);
1574 Set<Descriptor> d1SubClassesSet =
1575 ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
1576 Set<Descriptor> d2SubClassesSet =
1577 ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
1579 if (d1 == null && d2 == null) {
1580 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1581 + " because they are not comparable at " + msg);
1582 } else if (d1 != null && d1SubClassesSet.contains(d2)) {
1584 } else if (d2 != null && d2SubClassesSet.contains(d1)) {
1587 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1588 + " because they are not comparable at " + msg);
1593 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1594 + " because they are not comparable at " + msg);
1597 // SSJavaLattice<String> lattice1 = getLatticeByDescriptor(d1);
1598 // SSJavaLattice<String> lattice2 = getLatticeByDescriptor(d2);
1600 SSJavaLattice<String> lattice = getLatticeByDescriptor(descriptor);
1602 // check if the spin location is appeared only at the end of the
1603 // composite location
1604 if (lattice.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1605 if (i != (compLoc1.getSize() - 1)) {
1606 throw new Error("The shared location " + loc1.getLocIdentifier()
1607 + " cannot be appeared in the middle of composite location at" + msg);
1611 if (lattice.getSpinLocSet().contains(loc2.getLocIdentifier())) {
1612 if (i != (compLoc2.getSize() - 1)) {
1613 throw new Error("The spin location " + loc2.getLocIdentifier()
1614 + " cannot be appeared in the middle of composite location at " + msg);
1618 // if (!lattice1.equals(lattice2)) {
1619 // throw new Error("Failed to compare two locations of " + compLoc1 +
1620 // " and " + compLoc2
1621 // + " because they are not comparable at " + msg);
1624 if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1626 // check if the current location is the spinning location
1627 // note that the spinning location only can be appeared in the last
1628 // part of the composite location
1629 if (awareSharedLoc && numOfTie == compLoc1.getSize()
1630 && lattice.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1631 return ComparisonResult.GREATER;
1634 } else if (lattice.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1635 return ComparisonResult.GREATER;
1637 return ComparisonResult.LESS;
1642 if (numOfTie == compLoc1.getSize()) {
1644 if (numOfTie != compLoc2.getSize()) {
1645 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1646 + " because they are not comparable at " + msg);
1649 return ComparisonResult.EQUAL;
1652 return ComparisonResult.LESS;
1656 public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet) {
1658 // System.out.println("Calculating GLB=" + inputSet);
1659 CompositeLocation glbCompLoc = new CompositeLocation();
1661 // calculate GLB of the first(priority) element
1662 Set<String> priorityLocIdentifierSet = new HashSet<String>();
1663 Descriptor priorityDescriptor = null;
1665 Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1666 new Hashtable<String, Set<CompositeLocation>>();
1667 // mapping from the priority loc ID to its full representation by the
1668 // composite location
1670 int maxTupleSize = 0;
1671 CompositeLocation maxCompLoc = null;
1673 for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1674 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1675 if (compLoc.getSize() > maxTupleSize) {
1676 maxTupleSize = compLoc.getSize();
1677 maxCompLoc = compLoc;
1679 Location priorityLoc = compLoc.get(0);
1680 String priorityLocId = priorityLoc.getLocIdentifier();
1681 priorityLocIdentifierSet.add(priorityLocId);
1683 if (locId2CompLocSet.containsKey(priorityLocId)) {
1684 locId2CompLocSet.get(priorityLocId).add(compLoc);
1686 Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1687 newSet.add(compLoc);
1688 locId2CompLocSet.put(priorityLocId, newSet);
1691 // check if priority location are coming from the same lattice
1692 if (priorityDescriptor == null) {
1693 priorityDescriptor = priorityLoc.getDescriptor();
1694 } else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1695 throw new Error("Failed to calculate GLB of " + inputSet
1696 + " because they are from different lattices.");
1700 SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1701 String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1703 glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1704 Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1706 if (compSet == null) {
1707 // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1708 // mean that the result is already lower than <x1,y1> and <x2,y2>
1709 // assign TOP to the rest of the location elements
1711 // in this case, do not take care about delta
1712 // CompositeLocation inputComp = inputSet.iterator().next();
1713 for (int i = 1; i < maxTupleSize; i++) {
1714 glbCompLoc.addLocation(Location.createTopLocation(maxCompLoc.get(i).getDescriptor()));
1718 // here find out composite location that has a maximum length tuple
1719 // if we have three input set: [A], [A,B], [A,B,C]
1720 // maximum length tuple will be [A,B,C]
1722 CompositeLocation maxFromCompSet = null;
1723 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1724 CompositeLocation c = (CompositeLocation) iterator.next();
1725 if (c.getSize() > max) {
1731 if (compSet.size() == 1) {
1733 // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
1734 CompositeLocation comp = compSet.iterator().next();
1735 for (int i = 1; i < comp.getSize(); i++) {
1736 glbCompLoc.addLocation(comp.get(i));
1739 // if input location corresponding to glb is a delta, need to apply
1740 // delta to glb result
1741 if (comp instanceof DeltaLocation) {
1742 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1746 // when GLB(x1,x2)==x1 and x2 : GLB case 1
1747 // if more than one location shares the same priority GLB
1748 // need to calculate the rest of GLB loc
1750 // int compositeLocSize = compSet.iterator().next().getSize();
1751 int compositeLocSize = maxFromCompSet.getSize();
1753 Set<String> glbInputSet = new HashSet<String>();
1754 Descriptor currentD = null;
1755 for (int i = 1; i < compositeLocSize; i++) {
1756 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1757 CompositeLocation compositeLocation = (CompositeLocation) iterator.next();
1758 if (compositeLocation.getSize() > i) {
1759 Location currentLoc = compositeLocation.get(i);
1760 currentD = currentLoc.getDescriptor();
1761 // making set of the current location sharing the same idx
1762 glbInputSet.add(currentLoc.getLocIdentifier());
1765 // calculate glb for the current lattice
1767 SSJavaLattice<String> currentLattice = getLatticeByDescriptor(currentD);
1768 String currentGLBLocId = currentLattice.getGLB(glbInputSet);
1769 glbCompLoc.addLocation(new Location(currentD, currentGLBLocId));
1772 // if input location corresponding to glb is a delta, need to apply
1773 // delta to glb result
1775 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1776 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1777 if (compLoc instanceof DeltaLocation) {
1778 if (glbCompLoc.equals(compLoc)) {
1779 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1792 static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
1794 SSJavaLattice<String> lattice = null;
1796 if (d instanceof ClassDescriptor) {
1797 lattice = ssjava.getCd2lattice().get(d);
1798 } else if (d instanceof MethodDescriptor) {
1799 if (ssjava.getMd2lattice().containsKey(d)) {
1800 lattice = ssjava.getMd2lattice().get(d);
1802 // use default lattice for the method
1803 lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
1812 class ComparisonResult {
1814 public static final int GREATER = 0;
1815 public static final int EQUAL = 1;
1816 public static final int LESS = 2;
1817 public static final int INCOMPARABLE = 3;
1824 class ReturnLocGenerator {
1826 public static final int PARAMISHIGHER = 0;
1827 public static final int PARAMISSAME = 1;
1828 public static final int IGNORE = 2;
1830 Hashtable<Integer, Integer> paramIdx2paramType;
1832 public ReturnLocGenerator(CompositeLocation returnLoc, List<CompositeLocation> params, String msg) {
1833 // creating mappings
1834 paramIdx2paramType = new Hashtable<Integer, Integer>();
1835 for (int i = 0; i < params.size(); i++) {
1836 CompositeLocation param = params.get(i);
1837 int compareResult = CompositeLattice.compare(param, returnLoc, msg);
1840 if (compareResult == ComparisonResult.GREATER) {
1842 } else if (compareResult == ComparisonResult.EQUAL) {
1847 paramIdx2paramType.put(new Integer(i), new Integer(type));
1852 public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
1854 // compute the highest possible location in caller's side
1855 assert paramIdx2paramType.keySet().size() == args.size();
1857 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1858 for (int i = 0; i < args.size(); i++) {
1859 int type = (paramIdx2paramType.get(new Integer(i))).intValue();
1860 CompositeLocation argLoc = args.get(i);
1861 if (type == PARAMISHIGHER) {
1862 // return loc is lower than param
1863 DeltaLocation delta = new DeltaLocation(argLoc, 1);
1864 inputGLB.add(delta);
1865 } else if (type == PARAMISSAME) {
1866 // return loc is equal or lower than param
1867 inputGLB.add(argLoc);
1871 // compute GLB of arguments subset that are same or higher than return
1873 CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB);