1 package Analysis.SSJava;
3 import java.util.ArrayList;
4 import java.util.HashSet;
5 import java.util.Hashtable;
6 import java.util.Iterator;
9 import java.util.StringTokenizer;
10 import java.util.Vector;
12 import Analysis.SSJava.FlowDownCheck.ComparisonResult;
13 import Analysis.SSJava.FlowDownCheck.CompositeLattice;
14 import IR.AnnotationDescriptor;
15 import IR.ClassDescriptor;
17 import IR.FieldDescriptor;
18 import IR.MethodDescriptor;
19 import IR.NameDescriptor;
22 import IR.SymbolTable;
23 import IR.TypeDescriptor;
24 import IR.VarDescriptor;
25 import IR.Tree.ArrayAccessNode;
26 import IR.Tree.AssignmentNode;
27 import IR.Tree.BlockExpressionNode;
28 import IR.Tree.BlockNode;
29 import IR.Tree.BlockStatementNode;
30 import IR.Tree.CastNode;
31 import IR.Tree.CreateObjectNode;
32 import IR.Tree.DeclarationNode;
33 import IR.Tree.ExpressionNode;
34 import IR.Tree.FieldAccessNode;
35 import IR.Tree.IfStatementNode;
37 import IR.Tree.LiteralNode;
38 import IR.Tree.LoopNode;
39 import IR.Tree.MethodInvokeNode;
40 import IR.Tree.NameNode;
41 import IR.Tree.OpNode;
42 import IR.Tree.ReturnNode;
43 import IR.Tree.SubBlockNode;
44 import IR.Tree.SwitchBlockNode;
45 import IR.Tree.SwitchStatementNode;
46 import IR.Tree.TertiaryNode;
47 import IR.Tree.TreeNode;
50 public class FlowDownCheck {
53 static SSJavaAnalysis ssjava;
57 // mapping from 'descriptor' to 'composite location'
58 Hashtable<Descriptor, CompositeLocation> d2loc;
60 Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
61 Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
63 // mapping from 'locID' to 'class descriptor'
64 Hashtable<String, ClassDescriptor> fieldLocName2cd;
66 public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
69 this.toanalyze = new HashSet();
70 this.d2loc = new Hashtable<Descriptor, CompositeLocation>();
71 this.fieldLocName2cd = new Hashtable<String, ClassDescriptor>();
72 this.md2ReturnLoc = new Hashtable<MethodDescriptor, CompositeLocation>();
73 this.md2ReturnLocGen = new Hashtable<MethodDescriptor, ReturnLocGenerator>();
78 // construct mapping from the location name to the class descriptor
79 // assume that the location name is unique through the whole program
81 Set<ClassDescriptor> cdSet = ssjava.getCd2lattice().keySet();
82 for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
83 ClassDescriptor cd = (ClassDescriptor) iterator.next();
84 SSJavaLattice<String> lattice = ssjava.getCd2lattice().get(cd);
85 Set<String> fieldLocNameSet = lattice.getKeySet();
87 for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
88 String fieldLocName = (String) iterator2.next();
89 fieldLocName2cd.put(fieldLocName, cd);
96 public void flowDownCheck() {
97 SymbolTable classtable = state.getClassSymbolTable();
99 // phase 1 : checking declaration node and creating mapping of 'type
100 // desciptor' & 'location'
101 toanalyze.addAll(classtable.getValueSet());
102 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
103 while (!toanalyze.isEmpty()) {
104 Object obj = toanalyze.iterator().next();
105 ClassDescriptor cd = (ClassDescriptor) obj;
106 toanalyze.remove(cd);
108 if (ssjava.needToBeAnnoated(cd) && (!cd.isInterface())) {
110 ClassDescriptor superDesc = cd.getSuperDesc();
111 if (superDesc != null && (!superDesc.isInterface())
112 && (!superDesc.getSymbol().equals("Object"))) {
113 checkOrderingInheritance(superDesc, cd);
116 checkDeclarationInClass(cd);
117 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
118 MethodDescriptor md = (MethodDescriptor) method_it.next();
119 if (ssjava.needTobeAnnotated(md)) {
120 checkDeclarationInMethodBody(cd, md);
127 // phase2 : checking assignments
128 toanalyze.addAll(classtable.getValueSet());
129 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
130 while (!toanalyze.isEmpty()) {
131 Object obj = toanalyze.iterator().next();
132 ClassDescriptor cd = (ClassDescriptor) obj;
133 toanalyze.remove(cd);
136 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
137 MethodDescriptor md = (MethodDescriptor) method_it.next();
138 if (ssjava.needTobeAnnotated(md)) {
139 checkMethodBody(cd, md);
146 private void checkOrderingInheritance(ClassDescriptor superCd, ClassDescriptor cd) {
147 // here, we're going to check that sub class keeps same relative orderings
148 // in respect to super class
150 SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
151 SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
153 if (superLattice != null) {
155 if (subLattice == null) {
156 throw new Error("If a parent class '" + superCd
157 + "' has a ordering lattice, its subclass '" + cd + "' should have one.");
160 Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
161 Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
163 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
164 Pair<String, String> pair = (Pair<String, String>) iterator.next();
166 if (!subPairSet.contains(pair)) {
167 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
168 + pair.getSecond() + " < " + pair.getFirst()
169 + "' that is defined by its superclass '" + superCd + "'.");
174 // if super class doesn't define lattice, then we don't need to check its
179 public Hashtable getMap() {
183 private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
184 BlockNode bn = state.getMethodBody(md);
186 // parsing returnloc annotation
187 if (ssjava.needTobeAnnotated(md)) {
189 Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
190 if (methodAnnotations != null) {
191 for (int i = 0; i < methodAnnotations.size(); i++) {
192 AnnotationDescriptor an = methodAnnotations.elementAt(i);
193 if (an.getMarker().equals(ssjava.RETURNLOC)) {
194 // developer explicitly defines method lattice
195 String returnLocDeclaration = an.getValue();
196 CompositeLocation returnLocComp =
197 parseLocationDeclaration(md, null, returnLocDeclaration);
198 md2ReturnLoc.put(md, returnLocComp);
202 if (!md.getReturnType().isVoid() && !md2ReturnLoc.containsKey(md)) {
203 throw new Error("Return location is not specified for the method " + md + " at "
204 + cd.getSourceFileName());
210 List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
212 boolean hasReturnValue = (!md.getReturnType().isVoid());
213 if (hasReturnValue) {
214 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
215 String thisLocId = methodLattice.getThisLoc();
216 if (thisLocId == null) {
217 throw new Error("Method '" + md + "' does not have the definition of 'this' location at "
218 + md.getClassDesc().getSourceFileName());
220 CompositeLocation thisLoc = new CompositeLocation(new Location(md, thisLocId));
221 paramList.add(thisLoc);
224 for (int i = 0; i < md.numParameters(); i++) {
225 // process annotations on method parameters
226 VarDescriptor vd = (VarDescriptor) md.getParameter(i);
227 assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), bn);
228 if (hasReturnValue) {
229 paramList.add(d2loc.get(vd));
233 if (hasReturnValue) {
234 md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), paramList,
235 generateErrorMessage(cd, null)));
238 checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
241 private void checkDeclarationInBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn) {
242 bn.getVarTable().setParent(nametable);
243 for (int i = 0; i < bn.size(); i++) {
244 BlockStatementNode bsn = bn.get(i);
245 checkDeclarationInBlockStatementNode(md, bn.getVarTable(), bsn);
249 private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
250 BlockStatementNode bsn) {
252 switch (bsn.kind()) {
253 case Kind.SubBlockNode:
254 checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
257 case Kind.DeclarationNode:
258 checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
262 checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
267 private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
269 if (ln.getType() == LoopNode.FORLOOP) {
270 // check for loop case
271 ClassDescriptor cd = md.getClassDesc();
272 BlockNode bn = ln.getInitializer();
273 for (int i = 0; i < bn.size(); i++) {
274 BlockStatementNode bsn = bn.get(i);
275 checkDeclarationInBlockStatementNode(md, nametable, bsn);
280 checkDeclarationInBlockNode(md, nametable, ln.getBody());
283 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
284 BlockNode bn = state.getMethodBody(md);
285 checkLocationFromBlockNode(md, md.getParameterTable(), bn);
288 private String generateErrorMessage(ClassDescriptor cd, TreeNode tn) {
290 return cd.getSourceFileName() + "::" + tn.getNumLine();
292 return cd.getSourceFileName();
297 private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
300 bn.getVarTable().setParent(nametable);
301 // it will return the lowest location in the block node
302 CompositeLocation lowestLoc = null;
304 for (int i = 0; i < bn.size(); i++) {
305 BlockStatementNode bsn = bn.get(i);
306 CompositeLocation bLoc = checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn);
307 if (!bLoc.isEmpty()) {
308 if (lowestLoc == null) {
311 if (CompositeLattice.isGreaterThan(lowestLoc, bLoc,
312 generateErrorMessage(md.getClassDesc(), bn))) {
320 if (lowestLoc == null) {
321 lowestLoc = new CompositeLocation(Location.createBottomLocation(md));
327 private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
328 SymbolTable nametable, BlockStatementNode bsn) {
330 CompositeLocation compLoc = null;
331 switch (bsn.kind()) {
332 case Kind.BlockExpressionNode:
333 compLoc = checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn);
336 case Kind.DeclarationNode:
337 compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn);
340 case Kind.IfStatementNode:
341 compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn);
345 compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn);
348 case Kind.ReturnNode:
349 compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn);
352 case Kind.SubBlockNode:
353 compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn);
356 case Kind.ContinueBreakNode:
357 compLoc = new CompositeLocation();
360 case Kind.SwitchStatementNode:
361 compLoc = checkLocationFromSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn);
367 private CompositeLocation checkLocationFromSwitchStatementNode(MethodDescriptor md,
368 SymbolTable nametable, SwitchStatementNode ssn) {
370 ClassDescriptor cd = md.getClassDesc();
371 CompositeLocation condLoc =
372 checkLocationFromExpressionNode(md, nametable, ssn.getCondition(), new CompositeLocation());
373 BlockNode sbn = ssn.getSwitchBody();
375 Set<CompositeLocation> blockLocSet = new HashSet<CompositeLocation>();
376 for (int i = 0; i < sbn.size(); i++) {
377 CompositeLocation blockLoc =
378 checkLocationFromSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i));
379 if (!CompositeLattice.isGreaterThan(condLoc, blockLoc,
380 generateErrorMessage(cd, ssn.getCondition()))) {
382 "The location of the switch-condition statement is lower than the conditional body at "
383 + cd.getSourceFileName() + ":" + ssn.getCondition().getNumLine());
386 blockLocSet.add(blockLoc);
388 return CompositeLattice.calculateGLB(blockLocSet);
391 private CompositeLocation checkLocationFromSwitchBlockNode(MethodDescriptor md,
392 SymbolTable nametable, SwitchBlockNode sbn) {
394 CompositeLocation blockLoc =
395 checkLocationFromBlockNode(md, nametable, sbn.getSwitchBlockStatement());
401 private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
404 ExpressionNode returnExp = rn.getReturnExpression();
406 CompositeLocation expLoc;
407 if (returnExp != null) {
408 expLoc = checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation());
409 // check if return value is equal or higher than RETRUNLOC of method
410 // declaration annotation
411 CompositeLocation returnLocAt = md2ReturnLoc.get(md);
413 if (CompositeLattice.isGreaterThan(returnLocAt, expLoc,
414 generateErrorMessage(md.getClassDesc(), rn))) {
416 "Return value location is not equal or higher than the declaraed return location at "
417 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
421 return new CompositeLocation();
424 private boolean hasOnlyLiteralValue(ExpressionNode en) {
425 if (en.kind() == Kind.LiteralNode) {
432 private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
435 ClassDescriptor cd = md.getClassDesc();
436 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
438 CompositeLocation condLoc =
439 checkLocationFromExpressionNode(md, nametable, ln.getCondition(), new CompositeLocation());
440 addLocationType(ln.getCondition().getType(), (condLoc));
442 CompositeLocation bodyLoc = checkLocationFromBlockNode(md, nametable, ln.getBody());
444 if (!CompositeLattice.isGreaterThan(condLoc, bodyLoc, generateErrorMessage(cd, ln))) {
445 // loop condition should be higher than loop body
447 "The location of the while-condition statement is lower than the loop body at "
448 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
454 // check for loop case
455 BlockNode bn = ln.getInitializer();
456 bn.getVarTable().setParent(nametable);
458 // calculate glb location of condition and update statements
459 CompositeLocation condLoc =
460 checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
461 new CompositeLocation());
462 addLocationType(ln.getCondition().getType(), condLoc);
464 CompositeLocation updateLoc =
465 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate());
467 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
468 glbInputSet.add(condLoc);
469 // glbInputSet.add(updateLoc);
471 CompositeLocation glbLocOfForLoopCond = CompositeLattice.calculateGLB(glbInputSet);
473 // check location of 'forloop' body
474 CompositeLocation blockLoc = checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody());
476 // compute glb of body including loop body and update statement
479 if (blockLoc == null) {
480 // when there is no statement in the loop body
482 if (updateLoc == null) {
483 // also there is no update statement in the loop body
484 return glbLocOfForLoopCond;
486 glbInputSet.add(updateLoc);
489 glbInputSet.add(blockLoc);
490 glbInputSet.add(updateLoc);
493 CompositeLocation loopBodyLoc = CompositeLattice.calculateGLB(glbInputSet);
495 if (!CompositeLattice.isGreaterThan(glbLocOfForLoopCond, loopBodyLoc,
496 generateErrorMessage(cd, ln))) {
498 "The location of the for-condition statement is lower than the for-loop body at "
499 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
506 private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
507 SymbolTable nametable, SubBlockNode sbn) {
508 CompositeLocation compLoc = checkLocationFromBlockNode(md, nametable, sbn.getBlockNode());
512 private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
513 SymbolTable nametable, IfStatementNode isn) {
515 ClassDescriptor localCD = md.getClassDesc();
516 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
518 CompositeLocation condLoc =
519 checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation());
521 addLocationType(isn.getCondition().getType(), condLoc);
522 glbInputSet.add(condLoc);
524 CompositeLocation locTrueBlock = checkLocationFromBlockNode(md, nametable, isn.getTrueBlock());
525 if (locTrueBlock != null) {
526 glbInputSet.add(locTrueBlock);
527 // here, the location of conditional block should be higher than the
528 // location of true/false blocks
529 if (locTrueBlock != null
530 && !CompositeLattice.isGreaterThan(condLoc, locTrueBlock,
531 generateErrorMessage(localCD, isn.getCondition()))) {
534 "The location of the if-condition statement is lower than the conditional block at "
535 + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
539 if (isn.getFalseBlock() != null) {
540 CompositeLocation locFalseBlock =
541 checkLocationFromBlockNode(md, nametable, isn.getFalseBlock());
543 if (locFalseBlock != null) {
544 glbInputSet.add(locFalseBlock);
546 if (!CompositeLattice.isGreaterThan(condLoc, locFalseBlock,
547 generateErrorMessage(localCD, isn.getCondition()))) {
550 "The location of the if-condition statement is lower than the conditional block at "
551 + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
557 // return GLB location of condition, true, and false block
558 CompositeLocation glbLoc = CompositeLattice.calculateGLB(glbInputSet);
563 private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
564 SymbolTable nametable, DeclarationNode dn) {
566 System.out.println("DeclarationNode=" + dn.printNode(0));
568 VarDescriptor vd = dn.getVarDescriptor();
570 CompositeLocation destLoc = d2loc.get(vd);
572 if (dn.getExpression() != null) {
573 CompositeLocation expressionLoc =
574 checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
575 new CompositeLocation());
576 // addTypeLocation(dn.getExpression().getType(), expressionLoc);
578 if (expressionLoc != null) {
579 // checking location order
580 if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc,
581 generateErrorMessage(md.getClassDesc(), dn))) {
582 throw new Error("The value flow from " + expressionLoc + " to " + destLoc
583 + " does not respect location hierarchy on the assignment " + dn.printNode(0)
584 + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
587 return expressionLoc;
591 return new CompositeLocation();
597 private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
599 checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
602 private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
603 SymbolTable nametable, BlockExpressionNode ben) {
604 CompositeLocation compLoc =
605 checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null);
606 // addTypeLocation(ben.getExpression().getType(), compLoc);
610 private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
611 SymbolTable nametable, ExpressionNode en, CompositeLocation loc) {
613 CompositeLocation compLoc = null;
616 case Kind.AssignmentNode:
617 compLoc = checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc);
620 case Kind.FieldAccessNode:
621 compLoc = checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc);
625 compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc);
629 compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en);
632 case Kind.CreateObjectNode:
633 compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
636 case Kind.ArrayAccessNode:
637 compLoc = checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en);
640 case Kind.LiteralNode:
641 compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
644 case Kind.MethodInvokeNode:
645 compLoc = checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc);
648 case Kind.TertiaryNode:
649 compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en);
653 compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en);
656 // case Kind.InstanceOfNode:
657 // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
660 // case Kind.ArrayInitializerNode:
661 // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
665 // case Kind.ClassTypeNode:
666 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
669 // case Kind.OffsetNode:
670 // checkOffsetNode(md, nametable, (OffsetNode)en, td);
677 // addTypeLocation(en.getType(), compLoc);
682 private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
685 ExpressionNode en = cn.getExpression();
686 return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
690 private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
691 SymbolTable nametable, TertiaryNode tn) {
692 ClassDescriptor cd = md.getClassDesc();
694 CompositeLocation condLoc =
695 checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation());
696 addLocationType(tn.getCond().getType(), condLoc);
697 CompositeLocation trueLoc =
698 checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation());
699 addLocationType(tn.getTrueExpr().getType(), trueLoc);
700 CompositeLocation falseLoc =
701 checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation());
702 addLocationType(tn.getFalseExpr().getType(), falseLoc);
704 // check if condLoc is higher than trueLoc & falseLoc
705 if (!CompositeLattice.isGreaterThan(condLoc, trueLoc, generateErrorMessage(cd, tn))) {
707 "The location of the condition expression is lower than the true expression at "
708 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
711 if (!CompositeLattice.isGreaterThan(condLoc, falseLoc, generateErrorMessage(cd, tn.getCond()))) {
713 "The location of the condition expression is lower than the true expression at "
714 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
717 // then, return glb of trueLoc & falseLoc
718 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
719 glbInputSet.add(trueLoc);
720 glbInputSet.add(falseLoc);
722 return CompositeLattice.calculateGLB(glbInputSet);
725 private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
726 SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc) {
728 checkCalleeConstraints(md, nametable, min);
730 CompositeLocation baseLocation = null;
731 if (min.getExpression() != null) {
733 checkLocationFromExpressionNode(md, nametable, min.getExpression(),
734 new CompositeLocation());
736 String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
737 baseLocation = new CompositeLocation(new Location(md, thisLocId));
740 if (!min.getMethod().getReturnType().isVoid()) {
741 // If method has a return value, compute the highest possible return
742 // location in the caller's perspective
743 CompositeLocation ceilingLoc =
744 computeCeilingLocationForCaller(md, nametable, min, baseLocation);
748 return new CompositeLocation();
752 private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
753 SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation) {
754 List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
756 // by default, method has a THIS parameter
757 argList.add(baseLocation);
759 for (int i = 0; i < min.numArgs(); i++) {
760 ExpressionNode en = min.getArg(i);
761 CompositeLocation callerArg =
762 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
763 argList.add(callerArg);
766 System.out.println("##");
767 System.out.println("min.getMethod()=" + min.getMethod());
768 System.out.println("md2ReturnLocGen.get(min.getMethod())="
769 + md2ReturnLocGen.get(min.getMethod()));
771 return md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
775 private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
776 MethodInvokeNode min) {
778 if (min.numArgs() > 1) {
779 // caller needs to guarantee that it passes arguments in regarding to
780 // callee's hierarchy
781 for (int i = 0; i < min.numArgs(); i++) {
782 ExpressionNode en = min.getArg(i);
783 CompositeLocation callerArg1 =
784 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
786 ClassDescriptor calleecd = min.getMethod().getClassDesc();
787 VarDescriptor calleevd = (VarDescriptor) min.getMethod().getParameter(i);
788 CompositeLocation calleeLoc1 = d2loc.get(calleevd);
790 if (!callerArg1.get(0).isTop()) {
791 // here, check if ordering relations among caller's args respect
792 // ordering relations in-between callee's args
793 for (int currentIdx = 0; currentIdx < min.numArgs(); currentIdx++) {
794 if (currentIdx != i) { // skip itself
795 ExpressionNode argExp = min.getArg(currentIdx);
797 CompositeLocation callerArg2 =
798 checkLocationFromExpressionNode(md, nametable, argExp, new CompositeLocation());
800 VarDescriptor calleevd2 = (VarDescriptor) min.getMethod().getParameter(currentIdx);
801 CompositeLocation calleeLoc2 = d2loc.get(calleevd2);
804 CompositeLattice.compare(callerArg1, callerArg2,
805 generateErrorMessage(md.getClassDesc(), min));
807 CompositeLattice.compare(calleeLoc1, calleeLoc2,
808 generateErrorMessage(md.getClassDesc(), min));
809 if (calleeResult == ComparisonResult.GREATER
810 && callerResult != ComparisonResult.GREATER) {
811 // If calleeLoc1 is higher than calleeLoc2
812 // then, caller should have same ordering relation in-bet
813 // callerLoc1 & callerLoc2
815 throw new Error("Caller doesn't respect ordering relations among method arguments:"
816 + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
829 private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
830 SymbolTable nametable, ArrayAccessNode aan) {
832 // return glb location of array itself and index
834 ClassDescriptor cd = md.getClassDesc();
836 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
838 CompositeLocation arrayLoc =
839 checkLocationFromExpressionNode(md, nametable, aan.getExpression(), new CompositeLocation());
840 // addTypeLocation(aan.getExpression().getType(), arrayLoc);
841 glbInputSet.add(arrayLoc);
842 CompositeLocation indexLoc =
843 checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation());
844 glbInputSet.add(indexLoc);
845 // addTypeLocation(aan.getIndex().getType(), indexLoc);
847 CompositeLocation glbLoc = CompositeLattice.calculateGLB(glbInputSet);
851 private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
852 SymbolTable nametable, CreateObjectNode con) {
854 ClassDescriptor cd = md.getClassDesc();
857 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
858 for (int i = 0; i < con.numArgs(); i++) {
859 ExpressionNode en = con.getArg(i);
860 CompositeLocation argLoc =
861 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
862 glbInputSet.add(argLoc);
863 addLocationType(en.getType(), argLoc);
866 // check array initializers
867 // if ((con.getArrayInitializer() != null)) {
868 // checkLocationFromArrayInitializerNode(md, nametable,
869 // con.getArrayInitializer());
872 if (glbInputSet.size() > 0) {
873 return CompositeLattice.calculateGLB(glbInputSet);
876 CompositeLocation compLoc = new CompositeLocation();
877 compLoc.addLocation(Location.createTopLocation(md));
882 private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
885 ClassDescriptor cd = md.getClassDesc();
886 CompositeLocation leftLoc = new CompositeLocation();
887 leftLoc = checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc);
888 // addTypeLocation(on.getLeft().getType(), leftLoc);
890 CompositeLocation rightLoc = new CompositeLocation();
891 if (on.getRight() != null) {
892 rightLoc = checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc);
893 // addTypeLocation(on.getRight().getType(), rightLoc);
896 // System.out.println("checking op node=" + on.printNode(0));
897 // System.out.println("left loc=" + leftLoc + " from " +
898 // on.getLeft().getClass());
899 // System.out.println("right loc=" + rightLoc + " from " +
900 // on.getRight().getClass());
902 Operation op = on.getOp();
904 switch (op.getOp()) {
906 case Operation.UNARYPLUS:
907 case Operation.UNARYMINUS:
908 case Operation.LOGIC_NOT:
912 case Operation.LOGIC_OR:
913 case Operation.LOGIC_AND:
915 case Operation.BIT_OR:
916 case Operation.BIT_XOR:
917 case Operation.BIT_AND:
918 case Operation.ISAVAILABLE:
919 case Operation.EQUAL:
920 case Operation.NOTEQUAL:
930 case Operation.LEFTSHIFT:
931 case Operation.RIGHTSHIFT:
932 case Operation.URIGHTSHIFT:
934 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
935 inputSet.add(leftLoc);
936 inputSet.add(rightLoc);
937 CompositeLocation glbCompLoc = CompositeLattice.calculateGLB(inputSet);
941 throw new Error(op.toString());
946 private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
947 SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
949 // literal value has the top location so that value can be flowed into any
951 Location literalLoc = Location.createTopLocation(md);
952 loc.addLocation(literalLoc);
957 private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
958 NameNode nn, CompositeLocation loc) {
960 NameDescriptor nd = nn.getName();
961 if (nd.getBase() != null) {
963 loc = checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc);
964 // addTypeLocation(nn.getExpression().getType(), loc);
966 String varname = nd.toString();
968 if (varname.equals("this")) {
970 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
971 String thisLocId = methodLattice.getThisLoc();
972 if (thisLocId == null) {
973 throw new Error("The location for 'this' is not defined at "
974 + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
976 Location locElement = new Location(md, thisLocId);
977 loc.addLocation(locElement);
980 Descriptor d = (Descriptor) nametable.get(varname);
982 // CompositeLocation localLoc = null;
983 if (d instanceof VarDescriptor) {
984 VarDescriptor vd = (VarDescriptor) d;
985 // localLoc = d2loc.get(vd);
986 // the type of var descriptor has a composite location!
987 loc = ((CompositeLocation) vd.getType().getExtension()).clone();
988 } else if (d instanceof FieldDescriptor) {
989 // the type of field descriptor has a location!
990 FieldDescriptor fd = (FieldDescriptor) d;
994 // if it is 'static final', the location has TOP since no one can
996 loc.addLocation(Location.createTopLocation(md));
998 // if 'static', the location has pre-assigned global loc
999 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1000 String globalLocId = localLattice.getGlobalLoc();
1001 if (globalLocId == null) {
1002 throw new Error("Global location element is not defined in the method " + md);
1004 Location globalLoc = new Location(md, globalLocId);
1006 loc.addLocation(globalLoc);
1009 // the location of field access starts from this, followed by field
1011 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1012 Location thisLoc = new Location(md, localLattice.getThisLoc());
1013 loc.addLocation(thisLoc);
1016 Location fieldLoc = (Location) fd.getType().getExtension();
1017 loc.addLocation(fieldLoc);
1023 private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1024 SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc) {
1026 ExpressionNode left = fan.getExpression();
1027 loc = checkLocationFromExpressionNode(md, nametable, left, loc);
1029 if (!left.getType().isPrimitive()) {
1030 FieldDescriptor fd = fan.getField();
1031 Location fieldLoc = (Location) fd.getType().getExtension();
1032 loc.addLocation(fieldLoc);
1038 private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1039 SymbolTable nametable, AssignmentNode an, CompositeLocation loc) {
1041 ClassDescriptor cd = md.getClassDesc();
1043 boolean postinc = true;
1044 if (an.getOperation().getBaseOp() == null
1045 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1046 .getBaseOp().getOp() != Operation.POSTDEC))
1049 CompositeLocation destLocation =
1050 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation());
1052 CompositeLocation srcLocation = new CompositeLocation();
1055 if (hasOnlyLiteralValue(an.getSrc())) {
1056 // if source is literal value, src location is TOP. so do not need to
1058 return destLocation;
1060 srcLocation = new CompositeLocation();
1061 System.out.println("checkLocationFromExpressionNode="+an.getSrc().printNode(0));
1062 srcLocation = checkLocationFromExpressionNode(md, nametable, an.getSrc(), srcLocation);
1063 // System.out.println(" an= " + an.printNode(0) + " an.getSrc()=" +
1064 // an.getSrc().getClass()
1065 // + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1066 // System.out.println("srcLocation=" + srcLocation);
1067 // System.out.println("dstLocation=" + destLocation);
1068 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1069 throw new Error("The value flow from " + srcLocation + " to " + destLocation
1070 + " does not respect location hierarchy on the assignment " + an.printNode(0) + " at "
1071 + cd.getSourceFileName() + "::" + an.getNumLine());
1075 srcLocation = checkLocationFromExpressionNode(md, nametable, an.getDest(), srcLocation);
1077 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1078 throw new Error("Location " + destLocation
1079 + " is not allowed to have the value flow that moves within the same location at "
1080 + cd.getSourceFileName() + "::" + an.getNumLine());
1085 return destLocation;
1088 private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1089 SymbolTable nametable, TreeNode n) {
1091 ClassDescriptor cd = md.getClassDesc();
1092 Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1094 if (!md.getModifiers().isAbstract()) {
1095 // currently enforce every variable to have corresponding location
1096 if (annotationVec.size() == 0) {
1097 throw new Error("Location is not assigned to variable " + vd.getSymbol()
1098 + " in the method " + md.getSymbol() + " of the class " + cd.getSymbol());
1101 if (annotationVec.size() > 1) { // variable can have at most one location
1102 throw new Error(vd.getSymbol() + " has more than one location.");
1105 AnnotationDescriptor ad = annotationVec.elementAt(0);
1107 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1109 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1110 String locDec = ad.getValue(); // check if location is defined
1112 if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1113 DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1114 d2loc.put(vd, deltaLoc);
1115 addLocationType(vd.getType(), deltaLoc);
1117 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1119 Location lastElement = compLoc.get(compLoc.getSize() - 1);
1120 if (ssjava.isSharedLocation(lastElement)) {
1121 ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1124 d2loc.put(vd, compLoc);
1125 addLocationType(vd.getType(), compLoc);
1134 private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1137 int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1140 int beginIdx = dIdx + 6;
1141 locDec = locDec.substring(beginIdx, locDec.length() - 1);
1142 dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1145 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1146 DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1151 private Location parseFieldLocDeclaraton(String decl) {
1153 int idx = decl.indexOf(".");
1154 String className = decl.substring(0, idx);
1155 String fieldName = decl.substring(idx + 1);
1157 Descriptor d = state.getClassSymbolTable().get(className);
1159 assert (d instanceof ClassDescriptor);
1160 SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1161 if (!lattice.containsKey(fieldName)) {
1162 throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1163 + className + "'.");
1166 return new Location(d, fieldName);
1169 private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1171 CompositeLocation compLoc = new CompositeLocation();
1173 StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1174 List<String> locIdList = new ArrayList<String>();
1175 while (tokenizer.hasMoreTokens()) {
1176 String locId = tokenizer.nextToken();
1177 locIdList.add(locId);
1180 // at least,one location element needs to be here!
1181 assert (locIdList.size() > 0);
1183 // assume that loc with idx 0 comes from the local lattice
1184 // loc with idx 1 comes from the field lattice
1186 String localLocId = locIdList.get(0);
1187 SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1188 Location localLoc = new Location(md, localLocId);
1189 if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1190 throw new Error("Location " + localLocId
1191 + " is not defined in the local variable lattice at "
1192 + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : "") + ".");
1194 compLoc.addLocation(localLoc);
1196 for (int i = 1; i < locIdList.size(); i++) {
1197 String locName = locIdList.get(i);
1199 Location fieldLoc = parseFieldLocDeclaraton(locName);
1200 // ClassDescriptor cd = fieldLocName2cd.get(locName);
1201 // SSJavaLattice<String> fieldLattice =
1202 // CompositeLattice.getLatticeByDescriptor(cd);
1204 // if (fieldLattice == null || (!fieldLattice.containsKey(locName))) {
1205 // throw new Error("Location " + locName +
1206 // " is not defined in the field lattice at "
1207 // + cd.getSourceFileName() + ".");
1209 // Location fieldLoc = new Location(cd, locName);
1210 compLoc.addLocation(fieldLoc);
1217 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1218 VarDescriptor vd = dn.getVarDescriptor();
1219 assignLocationOfVarDescriptor(vd, md, nametable, dn);
1222 private void checkClass(ClassDescriptor cd) {
1223 // Check to see that methods respects ss property
1224 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
1225 MethodDescriptor md = (MethodDescriptor) method_it.next();
1226 checkMethodDeclaration(cd, md);
1230 private void checkDeclarationInClass(ClassDescriptor cd) {
1231 // Check to see that fields are okay
1232 for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1233 FieldDescriptor fd = (FieldDescriptor) field_it.next();
1235 if (!(fd.isFinal() && fd.isStatic())) {
1236 checkFieldDeclaration(cd, fd);
1241 private void checkMethodDeclaration(ClassDescriptor cd, MethodDescriptor md) {
1245 private void checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1247 Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1249 // currently enforce every field to have corresponding location
1250 if (annotationVec.size() == 0) {
1251 throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1252 + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1255 if (annotationVec.size() > 1) {
1256 // variable can have at most one location
1257 throw new Error("Field " + fd.getSymbol() + " of class " + cd
1258 + " has more than one location.");
1261 AnnotationDescriptor ad = annotationVec.elementAt(0);
1263 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1265 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1266 String locationID = ad.getValue();
1267 // check if location is defined
1268 SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1269 if (lattice == null || (!lattice.containsKey(locationID))) {
1270 throw new Error("Location " + locationID
1271 + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1272 + cd.getSourceFileName() + ".");
1274 Location loc = new Location(cd, locationID);
1276 if (ssjava.isSharedLocation(loc)) {
1277 ssjava.mapSharedLocation2Descriptor(loc, fd);
1280 addLocationType(fd.getType(), loc);
1287 private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
1289 type.setExtension(loc);
1293 private void addLocationType(TypeDescriptor type, Location loc) {
1295 type.setExtension(loc);
1299 static class CompositeLattice {
1301 public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1303 int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, msg);
1304 if (baseCompareResult == ComparisonResult.EQUAL) {
1305 if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1310 } else if (baseCompareResult == ComparisonResult.GREATER) {
1318 public static int compare(CompositeLocation loc1, CompositeLocation loc2, String msg) {
1320 // System.out.println("compare=" + loc1 + " " + loc2);
1321 int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, msg);
1323 if (baseCompareResult == ComparisonResult.EQUAL) {
1324 return compareDelta(loc1, loc2);
1326 return baseCompareResult;
1331 private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1333 int deltaCount1 = 0;
1334 int deltaCount2 = 0;
1335 if (dLoc1 instanceof DeltaLocation) {
1336 deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1339 if (dLoc2 instanceof DeltaLocation) {
1340 deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1342 if (deltaCount1 < deltaCount2) {
1343 return ComparisonResult.GREATER;
1344 } else if (deltaCount1 == deltaCount2) {
1345 return ComparisonResult.EQUAL;
1347 return ComparisonResult.LESS;
1352 private static int compareBaseLocationSet(CompositeLocation compLoc1,
1353 CompositeLocation compLoc2, boolean awareSharedLoc, String msg) {
1355 // if compLoc1 is greater than compLoc2, return true
1356 // else return false;
1358 // compare one by one in according to the order of the tuple
1360 for (int i = 0; i < compLoc1.getSize(); i++) {
1361 Location loc1 = compLoc1.get(i);
1362 if (i >= compLoc2.getSize()) {
1363 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1364 + " because they are not comparable.");
1366 Location loc2 = compLoc2.get(i);
1368 if (!loc1.getDescriptor().equals(loc2.getDescriptor())) {
1369 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1370 + " because they are not comparable.");
1373 Descriptor d1 = loc1.getDescriptor();
1374 Descriptor d2 = loc2.getDescriptor();
1376 SSJavaLattice<String> lattice1 = getLatticeByDescriptor(d1);
1377 SSJavaLattice<String> lattice2 = getLatticeByDescriptor(d2);
1379 // check if the spin location is appeared only at the end of the
1380 // composite location
1381 if (lattice1.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1382 if (i != (compLoc1.getSize() - 1)) {
1383 throw new Error("The spin location " + loc1.getLocIdentifier()
1384 + " cannot be appeared in the middle of composite location at" + msg);
1388 if (lattice2.getSpinLocSet().contains(loc2.getLocIdentifier())) {
1389 if (i != (compLoc2.getSize() - 1)) {
1390 throw new Error("The spin location " + loc2.getLocIdentifier()
1391 + " cannot be appeared in the middle of composite location at " + msg);
1395 if (!lattice1.equals(lattice2)) {
1396 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1397 + " because they are not comparable at " + msg);
1400 if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1402 // check if the current location is the spinning location
1403 // note that the spinning location only can be appeared in the last
1404 // part of the composite location
1405 if (awareSharedLoc && numOfTie == compLoc1.getSize()
1406 && lattice1.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1407 return ComparisonResult.GREATER;
1410 } else if (lattice1.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1411 return ComparisonResult.GREATER;
1413 return ComparisonResult.LESS;
1418 if (numOfTie == compLoc1.getSize()) {
1420 if (numOfTie != compLoc2.getSize()) {
1421 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1422 + " because they are not comparable.");
1425 return ComparisonResult.EQUAL;
1428 return ComparisonResult.LESS;
1432 public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet) {
1434 // System.out.println("Calculating GLB=" + inputSet);
1435 CompositeLocation glbCompLoc = new CompositeLocation();
1437 // calculate GLB of the first(priority) element
1438 Set<String> priorityLocIdentifierSet = new HashSet<String>();
1439 Descriptor priorityDescriptor = null;
1441 Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1442 new Hashtable<String, Set<CompositeLocation>>();
1443 // mapping from the priority loc ID to its full representation by the
1444 // composite location
1446 int maxTupleSize = 0;
1447 CompositeLocation maxCompLoc = null;
1449 for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1450 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1451 if (compLoc.getSize() > maxTupleSize) {
1452 maxTupleSize = compLoc.getSize();
1453 maxCompLoc = compLoc;
1455 Location priorityLoc = compLoc.get(0);
1456 String priorityLocId = priorityLoc.getLocIdentifier();
1457 priorityLocIdentifierSet.add(priorityLocId);
1459 if (locId2CompLocSet.containsKey(priorityLocId)) {
1460 locId2CompLocSet.get(priorityLocId).add(compLoc);
1462 Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1463 newSet.add(compLoc);
1464 locId2CompLocSet.put(priorityLocId, newSet);
1467 // check if priority location are coming from the same lattice
1468 if (priorityDescriptor == null) {
1469 priorityDescriptor = priorityLoc.getDescriptor();
1470 } else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1471 throw new Error("Failed to calculate GLB of " + inputSet
1472 + " because they are from different lattices.");
1476 SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1477 String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1479 glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1480 Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1482 // here find out composite location that has a maximum length tuple
1483 // if we have three input set: [A], [A,B], [A,B,C]
1484 // maximum length tuple will be [A,B,C]
1486 CompositeLocation maxFromCompSet = null;
1487 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1488 CompositeLocation c = (CompositeLocation) iterator.next();
1489 if (c.getSize() > max) {
1495 if (compSet == null) {
1496 // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1497 // mean that the result is already lower than <x1,y1> and <x2,y2>
1498 // assign TOP to the rest of the location elements
1500 // in this case, do not take care about delta
1501 // CompositeLocation inputComp = inputSet.iterator().next();
1502 CompositeLocation inputComp = maxCompLoc;
1503 for (int i = 1; i < inputComp.getSize(); i++) {
1504 glbCompLoc.addLocation(Location.createTopLocation(inputComp.get(i).getDescriptor()));
1507 if (compSet.size() == 1) {
1509 // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
1510 CompositeLocation comp = compSet.iterator().next();
1511 for (int i = 1; i < comp.getSize(); i++) {
1512 glbCompLoc.addLocation(comp.get(i));
1515 // if input location corresponding to glb is a delta, need to apply
1516 // delta to glb result
1517 if (comp instanceof DeltaLocation) {
1518 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1522 // when GLB(x1,x2)==x1 and x2 : GLB case 1
1523 // if more than one location shares the same priority GLB
1524 // need to calculate the rest of GLB loc
1526 // int compositeLocSize = compSet.iterator().next().getSize();
1527 int compositeLocSize = maxFromCompSet.getSize();
1529 Set<String> glbInputSet = new HashSet<String>();
1530 Descriptor currentD = null;
1531 for (int i = 1; i < compositeLocSize; i++) {
1532 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1533 CompositeLocation compositeLocation = (CompositeLocation) iterator.next();
1534 if (compositeLocation.getSize() > i) {
1535 Location currentLoc = compositeLocation.get(i);
1536 currentD = currentLoc.getDescriptor();
1537 // making set of the current location sharing the same idx
1538 glbInputSet.add(currentLoc.getLocIdentifier());
1541 // calculate glb for the current lattice
1543 SSJavaLattice<String> currentLattice = getLatticeByDescriptor(currentD);
1544 String currentGLBLocId = currentLattice.getGLB(glbInputSet);
1545 glbCompLoc.addLocation(new Location(currentD, currentGLBLocId));
1548 // if input location corresponding to glb is a delta, need to apply
1549 // delta to glb result
1551 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1552 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1553 if (compLoc instanceof DeltaLocation) {
1554 if (glbCompLoc.equals(compLoc)) {
1555 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1568 static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
1570 SSJavaLattice<String> lattice = null;
1572 if (d instanceof ClassDescriptor) {
1573 lattice = ssjava.getCd2lattice().get(d);
1574 } else if (d instanceof MethodDescriptor) {
1575 if (ssjava.getMd2lattice().containsKey(d)) {
1576 lattice = ssjava.getMd2lattice().get(d);
1578 // use default lattice for the method
1579 lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
1588 class ComparisonResult {
1590 public static final int GREATER = 0;
1591 public static final int EQUAL = 1;
1592 public static final int LESS = 2;
1593 public static final int INCOMPARABLE = 3;
1600 class ReturnLocGenerator {
1602 public static final int PARAMISHIGHER = 0;
1603 public static final int PARAMISSAME = 1;
1604 public static final int IGNORE = 2;
1606 Hashtable<Integer, Integer> paramIdx2paramType;
1608 public ReturnLocGenerator(CompositeLocation returnLoc, List<CompositeLocation> params, String msg) {
1609 // creating mappings
1610 paramIdx2paramType = new Hashtable<Integer, Integer>();
1611 for (int i = 0; i < params.size(); i++) {
1612 CompositeLocation param = params.get(i);
1613 int compareResult = CompositeLattice.compare(param, returnLoc, msg);
1616 if (compareResult == ComparisonResult.GREATER) {
1618 } else if (compareResult == ComparisonResult.EQUAL) {
1623 paramIdx2paramType.put(new Integer(i), new Integer(type));
1628 public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
1630 // compute the highest possible location in caller's side
1631 assert paramIdx2paramType.keySet().size() == args.size();
1633 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1634 for (int i = 0; i < args.size(); i++) {
1635 int type = (paramIdx2paramType.get(new Integer(i))).intValue();
1636 CompositeLocation argLoc = args.get(i);
1637 if (type == PARAMISHIGHER) {
1638 // return loc is lower than param
1639 DeltaLocation delta = new DeltaLocation(argLoc, 1);
1640 inputGLB.add(delta);
1641 } else if (type == PARAMISSAME) {
1642 // return loc is equal or lower than param
1643 inputGLB.add(argLoc);
1647 // compute GLB of arguments subset that are same or higher than return
1649 CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB);