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.TertiaryNode;
45 import IR.Tree.TreeNode;
48 public class FlowDownCheck {
51 static SSJavaAnalysis ssjava;
55 // mapping from 'descriptor' to 'composite location'
56 Hashtable<Descriptor, CompositeLocation> d2loc;
58 Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
59 Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
61 // mapping from 'locID' to 'class descriptor'
62 Hashtable<String, ClassDescriptor> fieldLocName2cd;
64 public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
67 this.toanalyze = new HashSet();
68 this.d2loc = new Hashtable<Descriptor, CompositeLocation>();
69 this.fieldLocName2cd = new Hashtable<String, ClassDescriptor>();
70 this.md2ReturnLoc = new Hashtable<MethodDescriptor, CompositeLocation>();
71 this.md2ReturnLocGen = new Hashtable<MethodDescriptor, ReturnLocGenerator>();
76 // construct mapping from the location name to the class descriptor
77 // assume that the location name is unique through the whole program
79 Set<ClassDescriptor> cdSet = ssjava.getCd2lattice().keySet();
80 for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
81 ClassDescriptor cd = (ClassDescriptor) iterator.next();
82 SSJavaLattice<String> lattice = ssjava.getCd2lattice().get(cd);
83 Set<String> fieldLocNameSet = lattice.getKeySet();
85 for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
86 String fieldLocName = (String) iterator2.next();
87 fieldLocName2cd.put(fieldLocName, cd);
94 public void flowDownCheck() {
95 SymbolTable classtable = state.getClassSymbolTable();
97 // phase 1 : checking declaration node and creating mapping of 'type
98 // desciptor' & 'location'
99 toanalyze.addAll(classtable.getValueSet());
100 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
101 while (!toanalyze.isEmpty()) {
102 Object obj = toanalyze.iterator().next();
103 ClassDescriptor cd = (ClassDescriptor) obj;
104 toanalyze.remove(cd);
106 if (!cd.isInterface()) {
108 ClassDescriptor superDesc = cd.getSuperDesc();
109 if (superDesc != null && (!superDesc.isInterface())
110 && (!superDesc.getSymbol().equals("Object"))) {
111 checkOrderingInheritance(superDesc, cd);
114 checkDeclarationInClass(cd);
115 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
116 MethodDescriptor md = (MethodDescriptor) method_it.next();
117 if (ssjava.needTobeAnnotated(md)) {
118 checkDeclarationInMethodBody(cd, md);
125 // phase2 : checking assignments
126 toanalyze.addAll(classtable.getValueSet());
127 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
128 while (!toanalyze.isEmpty()) {
129 Object obj = toanalyze.iterator().next();
130 ClassDescriptor cd = (ClassDescriptor) obj;
131 toanalyze.remove(cd);
134 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
135 MethodDescriptor md = (MethodDescriptor) method_it.next();
136 if (ssjava.needTobeAnnotated(md)) {
137 checkMethodBody(cd, md);
144 private void checkOrderingInheritance(ClassDescriptor superCd, ClassDescriptor cd) {
145 // here, we're going to check that sub class keeps same relative orderings
146 // in respect to super class
148 SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
149 SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
151 if (superLattice != null && subLattice == null) {
152 throw new Error("If a parent class '" + superCd + "' has a ordering lattice, its subclass '"
153 + cd + "' should have one.");
156 Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
157 Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
159 for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
160 Pair<String, String> pair = (Pair<String, String>) iterator.next();
162 if (!subPairSet.contains(pair)) {
163 throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
164 + pair.getSecond() + " < " + pair.getFirst() + "' that is defined by its superclass '"
171 public Hashtable getMap() {
175 private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
176 BlockNode bn = state.getMethodBody(md);
178 // parsing returnloc annotation
179 if (ssjava.needTobeAnnotated(md)) {
181 Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
182 if (methodAnnotations != null) {
183 for (int i = 0; i < methodAnnotations.size(); i++) {
184 AnnotationDescriptor an = methodAnnotations.elementAt(i);
185 if (an.getMarker().equals(ssjava.RETURNLOC)) {
186 // developer explicitly defines method lattice
187 String returnLocDeclaration = an.getValue();
188 CompositeLocation returnLocComp =
189 parseLocationDeclaration(md, null, returnLocDeclaration);
190 md2ReturnLoc.put(md, returnLocComp);
194 if (!md.getReturnType().isVoid() && !md2ReturnLoc.containsKey(md)) {
195 throw new Error("Return location is not specified for the method " + md + " at "
196 + cd.getSourceFileName());
202 List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
204 boolean hasReturnValue = (!md.getReturnType().isVoid());
205 if (hasReturnValue) {
206 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
207 String thisLocId = methodLattice.getThisLoc();
208 CompositeLocation thisLoc = new CompositeLocation(new Location(md, thisLocId));
209 paramList.add(thisLoc);
212 for (int i = 0; i < md.numParameters(); i++) {
213 // process annotations on method parameters
214 VarDescriptor vd = (VarDescriptor) md.getParameter(i);
215 assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), bn);
216 if (hasReturnValue) {
217 paramList.add(d2loc.get(vd));
221 if (hasReturnValue) {
222 md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), paramList));
225 checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
228 private void checkDeclarationInBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn) {
229 bn.getVarTable().setParent(nametable);
230 for (int i = 0; i < bn.size(); i++) {
231 BlockStatementNode bsn = bn.get(i);
232 checkDeclarationInBlockStatementNode(md, bn.getVarTable(), bsn);
236 private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
237 BlockStatementNode bsn) {
239 switch (bsn.kind()) {
240 case Kind.SubBlockNode:
241 checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
244 case Kind.DeclarationNode:
245 checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
249 checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
254 private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
256 if (ln.getType() == LoopNode.FORLOOP) {
257 // check for loop case
258 ClassDescriptor cd = md.getClassDesc();
259 BlockNode bn = ln.getInitializer();
260 for (int i = 0; i < bn.size(); i++) {
261 BlockStatementNode bsn = bn.get(i);
262 checkDeclarationInBlockStatementNode(md, nametable, bsn);
267 checkDeclarationInBlockNode(md, nametable, ln.getBody());
270 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
271 BlockNode bn = state.getMethodBody(md);
272 checkLocationFromBlockNode(md, md.getParameterTable(), bn);
275 private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
278 bn.getVarTable().setParent(nametable);
279 // it will return the lowest location in the block node
280 CompositeLocation lowestLoc = null;
282 for (int i = 0; i < bn.size(); i++) {
283 BlockStatementNode bsn = bn.get(i);
284 CompositeLocation bLoc = checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn);
285 if (!bLoc.isEmpty()) {
286 if (lowestLoc == null) {
289 if (CompositeLattice.isGreaterThan(lowestLoc, bLoc)) {
297 if (lowestLoc == null) {
298 lowestLoc = new CompositeLocation(Location.createBottomLocation(md));
304 private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
305 SymbolTable nametable, BlockStatementNode bsn) {
307 CompositeLocation compLoc = null;
308 switch (bsn.kind()) {
309 case Kind.BlockExpressionNode:
310 compLoc = checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn);
313 case Kind.DeclarationNode:
314 compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn);
317 case Kind.IfStatementNode:
318 compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn);
322 compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn);
325 case Kind.ReturnNode:
326 compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn);
329 case Kind.SubBlockNode:
330 compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn);
333 case Kind.ContinueBreakNode:
334 compLoc = new CompositeLocation();
341 private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
344 ExpressionNode returnExp = rn.getReturnExpression();
346 CompositeLocation expLoc;
347 if (returnExp != null) {
348 expLoc = checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation());
349 // check if return value is equal or higher than RETRUNLOC of method
350 // declaration annotation
351 CompositeLocation returnLocAt = md2ReturnLoc.get(md);
353 if (CompositeLattice.isGreaterThan(returnLocAt, expLoc)) {
355 "Return value location is not equal or higher than the declaraed return location at "
356 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
360 return new CompositeLocation();
363 private boolean hasOnlyLiteralValue(ExpressionNode en) {
364 if (en.kind() == Kind.LiteralNode) {
371 private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
374 ClassDescriptor cd = md.getClassDesc();
375 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
377 CompositeLocation condLoc =
378 checkLocationFromExpressionNode(md, nametable, ln.getCondition(), new CompositeLocation());
379 addTypeLocation(ln.getCondition().getType(), (condLoc));
381 CompositeLocation bodyLoc = checkLocationFromBlockNode(md, nametable, ln.getBody());
383 if (!CompositeLattice.isGreaterThan(condLoc, bodyLoc)) {
384 // loop condition should be higher than loop body
386 "The location of the while-condition statement is lower than the loop body at "
387 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
393 // check for loop case
394 BlockNode bn = ln.getInitializer();
395 bn.getVarTable().setParent(nametable);
397 // calculate glb location of condition and update statements
398 CompositeLocation condLoc =
399 checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
400 new CompositeLocation());
401 addTypeLocation(ln.getCondition().getType(), condLoc);
403 CompositeLocation updateLoc =
404 checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate());
406 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
407 glbInputSet.add(condLoc);
408 glbInputSet.add(updateLoc);
410 CompositeLocation glbLocOfForLoopCond = CompositeLattice.calculateGLB(glbInputSet);
412 // check location of 'forloop' body
413 CompositeLocation blockLoc = checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody());
415 if (blockLoc == null) {
416 // when there is no statement in the loop body
417 return glbLocOfForLoopCond;
420 if (!CompositeLattice.isGreaterThan(glbLocOfForLoopCond, blockLoc)) {
422 "The location of the for-condition statement is lower than the for-loop body at "
423 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
430 private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
431 SymbolTable nametable, SubBlockNode sbn) {
432 CompositeLocation compLoc = checkLocationFromBlockNode(md, nametable, sbn.getBlockNode());
436 private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
437 SymbolTable nametable, IfStatementNode isn) {
439 ClassDescriptor localCD = md.getClassDesc();
440 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
442 CompositeLocation condLoc =
443 checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation());
445 addTypeLocation(isn.getCondition().getType(), condLoc);
446 glbInputSet.add(condLoc);
448 CompositeLocation locTrueBlock = checkLocationFromBlockNode(md, nametable, isn.getTrueBlock());
449 if (locTrueBlock != null) {
450 glbInputSet.add(locTrueBlock);
451 // here, the location of conditional block should be higher than the
452 // location of true/false blocks
453 if (locTrueBlock != null && !CompositeLattice.isGreaterThan(condLoc, locTrueBlock)) {
456 "The location of the if-condition statement is lower than the conditional block at "
457 + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
461 if (isn.getFalseBlock() != null) {
462 CompositeLocation locFalseBlock =
463 checkLocationFromBlockNode(md, nametable, isn.getFalseBlock());
465 if (locFalseBlock != null) {
466 glbInputSet.add(locFalseBlock);
468 if (!CompositeLattice.isGreaterThan(condLoc, locFalseBlock)) {
471 "The location of the if-condition statement is lower than the conditional block at "
472 + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
478 // return GLB location of condition, true, and false block
479 CompositeLocation glbLoc = CompositeLattice.calculateGLB(glbInputSet);
484 private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
485 SymbolTable nametable, DeclarationNode dn) {
487 VarDescriptor vd = dn.getVarDescriptor();
489 CompositeLocation destLoc = d2loc.get(vd);
491 if (dn.getExpression() != null) {
492 CompositeLocation expressionLoc =
493 checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
494 new CompositeLocation());
495 // addTypeLocation(dn.getExpression().getType(), expressionLoc);
497 if (expressionLoc != null) {
498 // checking location order
499 if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc)) {
500 throw new Error("The value flow from " + expressionLoc + " to " + destLoc
501 + " does not respect location hierarchy on the assignment " + dn.printNode(0)
502 + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
505 return expressionLoc;
509 return new CompositeLocation();
515 private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
517 checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
520 private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
521 SymbolTable nametable, BlockExpressionNode ben) {
522 CompositeLocation compLoc =
523 checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null);
524 // addTypeLocation(ben.getExpression().getType(), compLoc);
528 private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
529 SymbolTable nametable, ExpressionNode en, CompositeLocation loc) {
531 CompositeLocation compLoc = null;
534 case Kind.AssignmentNode:
535 compLoc = checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc);
538 case Kind.FieldAccessNode:
539 compLoc = checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc);
543 compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc);
547 compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en);
550 case Kind.CreateObjectNode:
551 compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
554 case Kind.ArrayAccessNode:
555 compLoc = checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en);
558 case Kind.LiteralNode:
559 compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
562 case Kind.MethodInvokeNode:
563 compLoc = checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc);
566 case Kind.TertiaryNode:
567 compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en);
571 compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en);
574 // case Kind.InstanceOfNode:
575 // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
578 // case Kind.ArrayInitializerNode:
579 // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
583 // case Kind.ClassTypeNode:
584 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
587 // case Kind.OffsetNode:
588 // checkOffsetNode(md, nametable, (OffsetNode)en, td);
595 // addTypeLocation(en.getType(), compLoc);
600 private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
603 ExpressionNode en = cn.getExpression();
604 return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
608 private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
609 SymbolTable nametable, TertiaryNode tn) {
610 ClassDescriptor cd = md.getClassDesc();
612 CompositeLocation condLoc =
613 checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation());
614 addTypeLocation(tn.getCond().getType(), condLoc);
615 CompositeLocation trueLoc =
616 checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation());
617 addTypeLocation(tn.getTrueExpr().getType(), trueLoc);
618 CompositeLocation falseLoc =
619 checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation());
620 addTypeLocation(tn.getFalseExpr().getType(), falseLoc);
622 // check if condLoc is higher than trueLoc & falseLoc
623 if (!CompositeLattice.isGreaterThan(condLoc, trueLoc)) {
625 "The location of the condition expression is lower than the true expression at "
626 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
629 if (!CompositeLattice.isGreaterThan(condLoc, falseLoc)) {
631 "The location of the condition expression is lower than the true expression at "
632 + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
635 // then, return glb of trueLoc & falseLoc
636 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
637 glbInputSet.add(trueLoc);
638 glbInputSet.add(falseLoc);
640 return CompositeLattice.calculateGLB(glbInputSet);
643 private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
644 SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc) {
646 checkCalleeConstraints(md, nametable, min);
648 CompositeLocation baseLocation = null;
649 if (min.getExpression() != null) {
651 checkLocationFromExpressionNode(md, nametable, min.getExpression(),
652 new CompositeLocation());
654 String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
655 baseLocation = new CompositeLocation(new Location(md, thisLocId));
658 if (!min.getMethod().getReturnType().isVoid()) {
659 // If method has a return value, compute the highest possible return
660 // location in the caller's perspective
661 CompositeLocation ceilingLoc =
662 computeCeilingLocationForCaller(md, nametable, min, baseLocation);
666 return new CompositeLocation();
670 private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
671 SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation) {
672 List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
674 // by default, method has a THIS parameter
675 argList.add(baseLocation);
677 for (int i = 0; i < min.numArgs(); i++) {
678 ExpressionNode en = min.getArg(i);
679 CompositeLocation callerArg =
680 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
681 argList.add(callerArg);
684 return md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
688 private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
689 MethodInvokeNode min) {
691 if (min.numArgs() > 1) {
692 // caller needs to guarantee that it passes arguments in regarding to
693 // callee's hierarchy
694 for (int i = 0; i < min.numArgs(); i++) {
695 ExpressionNode en = min.getArg(i);
696 CompositeLocation callerArg1 =
697 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
699 ClassDescriptor calleecd = min.getMethod().getClassDesc();
700 VarDescriptor calleevd = (VarDescriptor) min.getMethod().getParameter(i);
701 CompositeLocation calleeLoc1 = d2loc.get(calleevd);
703 if (!callerArg1.get(0).isTop()) {
704 // here, check if ordering relations among caller's args respect
705 // ordering relations in-between callee's args
706 for (int currentIdx = 0; currentIdx < min.numArgs(); currentIdx++) {
707 if (currentIdx != i) { // skip itself
708 ExpressionNode argExp = min.getArg(currentIdx);
710 CompositeLocation callerArg2 =
711 checkLocationFromExpressionNode(md, nametable, argExp, new CompositeLocation());
713 VarDescriptor calleevd2 = (VarDescriptor) min.getMethod().getParameter(currentIdx);
714 CompositeLocation calleeLoc2 = d2loc.get(calleevd2);
716 boolean callerResult = CompositeLattice.isGreaterThan(callerArg1, callerArg2);
717 boolean calleeResult = CompositeLattice.isGreaterThan(calleeLoc1, calleeLoc2);
719 if (calleeResult && !callerResult) {
720 // If calleeLoc1 is higher than calleeLoc2
721 // then, caller should have same ordering relation in-bet
722 // callerLoc1 & callerLoc2
724 throw new Error("Caller doesn't respect ordering relations among method arguments:"
725 + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
738 private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
739 SymbolTable nametable, ArrayAccessNode aan) {
741 // return glb location of array itself and index
743 ClassDescriptor cd = md.getClassDesc();
745 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
747 CompositeLocation arrayLoc =
748 checkLocationFromExpressionNode(md, nametable, aan.getExpression(), new CompositeLocation());
749 // addTypeLocation(aan.getExpression().getType(), arrayLoc);
750 glbInputSet.add(arrayLoc);
751 CompositeLocation indexLoc =
752 checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation());
753 glbInputSet.add(indexLoc);
754 // addTypeLocation(aan.getIndex().getType(), indexLoc);
756 CompositeLocation glbLoc = CompositeLattice.calculateGLB(glbInputSet);
760 private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
761 SymbolTable nametable, CreateObjectNode con) {
763 ClassDescriptor cd = md.getClassDesc();
766 Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
767 for (int i = 0; i < con.numArgs(); i++) {
768 ExpressionNode en = con.getArg(i);
769 CompositeLocation argLoc =
770 checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
771 glbInputSet.add(argLoc);
772 addTypeLocation(en.getType(), argLoc);
775 // check array initializers
776 // if ((con.getArrayInitializer() != null)) {
777 // checkLocationFromArrayInitializerNode(md, nametable,
778 // con.getArrayInitializer());
781 if (glbInputSet.size() > 0) {
782 return CompositeLattice.calculateGLB(glbInputSet);
785 CompositeLocation compLoc = new CompositeLocation();
786 compLoc.addLocation(Location.createTopLocation(md));
791 private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
794 ClassDescriptor cd = md.getClassDesc();
795 CompositeLocation leftLoc = new CompositeLocation();
796 leftLoc = checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc);
797 // addTypeLocation(on.getLeft().getType(), leftLoc);
799 CompositeLocation rightLoc = new CompositeLocation();
800 if (on.getRight() != null) {
801 rightLoc = checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc);
802 // addTypeLocation(on.getRight().getType(), rightLoc);
805 // System.out.println("checking op node=" + on.printNode(0));
806 // System.out.println("left loc=" + leftLoc + " from " +
807 // on.getLeft().getClass());
808 // System.out.println("right loc=" + rightLoc + " from " +
809 // on.getRight().getClass());
811 Operation op = on.getOp();
813 switch (op.getOp()) {
815 case Operation.UNARYPLUS:
816 case Operation.UNARYMINUS:
817 case Operation.LOGIC_NOT:
821 case Operation.LOGIC_OR:
822 case Operation.LOGIC_AND:
824 case Operation.BIT_OR:
825 case Operation.BIT_XOR:
826 case Operation.BIT_AND:
827 case Operation.ISAVAILABLE:
828 case Operation.EQUAL:
829 case Operation.NOTEQUAL:
839 case Operation.LEFTSHIFT:
840 case Operation.RIGHTSHIFT:
841 case Operation.URIGHTSHIFT:
843 Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
844 inputSet.add(leftLoc);
845 inputSet.add(rightLoc);
846 CompositeLocation glbCompLoc = CompositeLattice.calculateGLB(inputSet);
850 throw new Error(op.toString());
855 private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
856 SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
858 // literal value has the top location so that value can be flowed into any
860 Location literalLoc = Location.createTopLocation(md);
861 loc.addLocation(literalLoc);
866 private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
867 NameNode nn, CompositeLocation loc) {
869 NameDescriptor nd = nn.getName();
870 if (nd.getBase() != null) {
872 loc = checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc);
873 // addTypeLocation(nn.getExpression().getType(), loc);
875 String varname = nd.toString();
877 if (varname.equals("this")) {
879 MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
880 String thisLocId = methodLattice.getThisLoc();
881 if (thisLocId == null) {
882 throw new Error("The location for 'this' is not defined at "
883 + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
885 Location locElement = new Location(md, thisLocId);
886 loc.addLocation(locElement);
889 Descriptor d = (Descriptor) nametable.get(varname);
891 // CompositeLocation localLoc = null;
892 if (d instanceof VarDescriptor) {
893 VarDescriptor vd = (VarDescriptor) d;
894 // localLoc = d2loc.get(vd);
895 // the type of var descriptor has a composite location!
896 loc = ((CompositeLocation) vd.getType().getExtension()).clone();
897 } else if (d instanceof FieldDescriptor) {
898 // the type of field descriptor has a location!
899 FieldDescriptor fd = (FieldDescriptor) d;
903 // if it is 'static final', the location has TOP since no one can
905 loc.addLocation(Location.createTopLocation(md));
907 // if 'static', the location has pre-assigned global loc
908 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
909 String globalLocId = localLattice.getGlobalLoc();
910 if (globalLocId == null) {
911 throw new Error("Global location element is not defined in the method " + md);
913 Location globalLoc = new Location(md, globalLocId);
915 loc.addLocation(globalLoc);
918 // the location of field access starts from this, followed by field
920 MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
921 Location thisLoc = new Location(md, localLattice.getThisLoc());
922 loc.addLocation(thisLoc);
925 Location fieldLoc = (Location) fd.getType().getExtension();
926 loc.addLocation(fieldLoc);
932 private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
933 SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc) {
935 ExpressionNode left = fan.getExpression();
936 loc = checkLocationFromExpressionNode(md, nametable, left, loc);
937 // addTypeLocation(left.getType(), loc);
939 if (!left.getType().isPrimitive()) {
940 FieldDescriptor fd = fan.getField();
941 Location fieldLoc = (Location) fd.getType().getExtension();
942 loc.addLocation(fieldLoc);
948 private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
949 SymbolTable nametable, AssignmentNode an, CompositeLocation loc) {
951 ClassDescriptor cd = md.getClassDesc();
953 boolean postinc = true;
954 if (an.getOperation().getBaseOp() == null
955 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
956 .getBaseOp().getOp() != Operation.POSTDEC))
959 CompositeLocation destLocation =
960 checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation());
962 CompositeLocation srcLocation = new CompositeLocation();
965 if (hasOnlyLiteralValue(an.getSrc())) {
966 // if source is literal value, src location is TOP. so do not need to
970 srcLocation = new CompositeLocation();
971 srcLocation = checkLocationFromExpressionNode(md, nametable, an.getSrc(), srcLocation);
972 // System.out.println(" an= " + an.printNode(0) + " an.getSrc()=" +
973 // an.getSrc().getClass()
974 // + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
975 // System.out.println("srcLocation=" + srcLocation);
976 // System.out.println("dstLocation=" + destLocation);
977 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation)) {
978 throw new Error("The value flow from " + srcLocation + " to " + destLocation
979 + " does not respect location hierarchy on the assignment " + an.printNode(0) + " at "
980 + cd.getSourceFileName() + "::" + an.getNumLine());
984 srcLocation = checkLocationFromExpressionNode(md, nametable, an.getDest(), srcLocation);
986 if (!CompositeLattice.isGreaterThan(srcLocation, destLocation)) {
987 throw new Error("Location " + destLocation
988 + " is not allowed to have the value flow that moves within the same location at "
989 + cd.getSourceFileName() + "::" + an.getNumLine());
997 private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
998 SymbolTable nametable, TreeNode n) {
1000 ClassDescriptor cd = md.getClassDesc();
1001 Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1003 // currently enforce every variable to have corresponding location
1004 if (annotationVec.size() == 0) {
1005 throw new Error("Location is not assigned to variable " + vd.getSymbol() + " in the method "
1006 + md.getSymbol() + " of the class " + cd.getSymbol());
1009 if (annotationVec.size() > 1) { // variable can have at most one location
1010 throw new Error(vd.getSymbol() + " has more than one location.");
1013 AnnotationDescriptor ad = annotationVec.elementAt(0);
1015 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1017 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1018 String locDec = ad.getValue(); // check if location is defined
1020 if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1021 DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1022 d2loc.put(vd, deltaLoc);
1023 addTypeLocation(vd.getType(), deltaLoc);
1025 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1026 d2loc.put(vd, compLoc);
1027 addTypeLocation(vd.getType(), compLoc);
1035 private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1038 int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1041 int beginIdx = dIdx + 6;
1042 locDec = locDec.substring(beginIdx, locDec.length() - 1);
1043 dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1046 CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1047 DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1052 private Location parseFieldLocDeclaraton(String decl) {
1054 int idx = decl.indexOf(".");
1055 String className = decl.substring(0, idx);
1056 String fieldName = decl.substring(idx + 1);
1058 Descriptor d = state.getClassSymbolTable().get(className);
1060 assert (d instanceof ClassDescriptor);
1061 SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1062 if (!lattice.containsKey(fieldName)) {
1063 throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1064 + className + "'.");
1067 return new Location(d, fieldName);
1070 private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1072 CompositeLocation compLoc = new CompositeLocation();
1074 StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1075 List<String> locIdList = new ArrayList<String>();
1076 while (tokenizer.hasMoreTokens()) {
1077 String locId = tokenizer.nextToken();
1078 locIdList.add(locId);
1081 // at least,one location element needs to be here!
1082 assert (locIdList.size() > 0);
1084 // assume that loc with idx 0 comes from the local lattice
1085 // loc with idx 1 comes from the field lattice
1087 String localLocId = locIdList.get(0);
1088 SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1089 Location localLoc = new Location(md, localLocId);
1090 if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1091 throw new Error("Location " + localLocId
1092 + " is not defined in the local variable lattice at "
1093 + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : "") + ".");
1095 compLoc.addLocation(localLoc);
1097 for (int i = 1; i < locIdList.size(); i++) {
1098 String locName = locIdList.get(i);
1100 Location fieldLoc = parseFieldLocDeclaraton(locName);
1101 // ClassDescriptor cd = fieldLocName2cd.get(locName);
1102 // SSJavaLattice<String> fieldLattice =
1103 // CompositeLattice.getLatticeByDescriptor(cd);
1105 // if (fieldLattice == null || (!fieldLattice.containsKey(locName))) {
1106 // throw new Error("Location " + locName +
1107 // " is not defined in the field lattice at "
1108 // + cd.getSourceFileName() + ".");
1110 // Location fieldLoc = new Location(cd, locName);
1111 compLoc.addLocation(fieldLoc);
1118 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1119 VarDescriptor vd = dn.getVarDescriptor();
1120 assignLocationOfVarDescriptor(vd, md, nametable, dn);
1123 private void checkClass(ClassDescriptor cd) {
1124 // Check to see that methods respects ss property
1125 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
1126 MethodDescriptor md = (MethodDescriptor) method_it.next();
1127 checkMethodDeclaration(cd, md);
1131 private void checkDeclarationInClass(ClassDescriptor cd) {
1132 // Check to see that fields are okay
1133 for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1134 FieldDescriptor fd = (FieldDescriptor) field_it.next();
1135 checkFieldDeclaration(cd, fd);
1139 private void checkMethodDeclaration(ClassDescriptor cd, MethodDescriptor md) {
1143 private void checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1145 Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1147 // currently enforce every field to have corresponding location
1148 if (annotationVec.size() == 0) {
1149 throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1150 + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1153 if (annotationVec.size() > 1) {
1154 // variable can have at most one location
1155 throw new Error("Field " + fd.getSymbol() + " of class " + cd
1156 + " has more than one location.");
1159 AnnotationDescriptor ad = annotationVec.elementAt(0);
1161 if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1163 if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1164 String locationID = ad.getValue();
1165 // check if location is defined
1166 SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1167 if (lattice == null || (!lattice.containsKey(locationID))) {
1168 throw new Error("Location " + locationID
1169 + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1170 + cd.getSourceFileName() + ".");
1172 Location loc = new Location(cd, locationID);
1173 // d2loc.put(fd, loc);
1174 addTypeLocation(fd.getType(), loc);
1181 private void addTypeLocation(TypeDescriptor type, CompositeLocation loc) {
1183 type.setExtension(loc);
1187 private void addTypeLocation(TypeDescriptor type, Location loc) {
1189 type.setExtension(loc);
1193 static class CompositeLattice {
1195 public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2) {
1197 // System.out.println("isGreaterThan= " + loc1 + " " + loc2);
1199 int baseCompareResult = compareBaseLocationSet(loc1, loc2);
1200 if (baseCompareResult == ComparisonResult.EQUAL) {
1201 if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1206 } else if (baseCompareResult == ComparisonResult.GREATER) {
1214 public static int compare(CompositeLocation loc1, CompositeLocation loc2) {
1216 // System.out.println("compare=" + loc1 + " " + loc2);
1217 int baseCompareResult = compareBaseLocationSet(loc1, loc2);
1219 if (baseCompareResult == ComparisonResult.EQUAL) {
1220 return compareDelta(loc1, loc2);
1222 return baseCompareResult;
1227 private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1229 int deltaCount1 = 0;
1230 int deltaCount2 = 0;
1231 if (dLoc1 instanceof DeltaLocation) {
1232 deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1235 if (dLoc2 instanceof DeltaLocation) {
1236 deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1238 if (deltaCount1 < deltaCount2) {
1239 return ComparisonResult.GREATER;
1240 } else if (deltaCount1 == deltaCount2) {
1241 return ComparisonResult.EQUAL;
1243 return ComparisonResult.LESS;
1248 private static int compareBaseLocationSet(CompositeLocation compLoc1, CompositeLocation compLoc2) {
1250 // if compLoc1 is greater than compLoc2, return true
1251 // else return false;
1253 // compare one by one in according to the order of the tuple
1255 for (int i = 0; i < compLoc1.getSize(); i++) {
1256 Location loc1 = compLoc1.get(i);
1257 if (i >= compLoc2.getSize()) {
1258 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1259 + " because they are not comparable.");
1261 Location loc2 = compLoc2.get(i);
1263 if (!loc1.getDescriptor().equals(loc2.getDescriptor())) {
1264 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1265 + " because they are not comparable.");
1268 Descriptor d1 = loc1.getDescriptor();
1269 Descriptor d2 = loc2.getDescriptor();
1271 SSJavaLattice<String> lattice1 = getLatticeByDescriptor(d1);
1272 SSJavaLattice<String> lattice2 = getLatticeByDescriptor(d2);
1274 // check if the spin location is appeared only at the end of the
1275 // composite location
1276 if (lattice1.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1277 if (i != (compLoc1.getSize() - 1)) {
1278 throw new Error("The spin location " + loc1.getLocIdentifier()
1279 + " cannot be appeared in the middle of composite location.");
1283 if (lattice2.getSpinLocSet().contains(loc2.getLocIdentifier())) {
1284 if (i != (compLoc2.getSize() - 1)) {
1285 throw new Error("The spin location " + loc2.getLocIdentifier()
1286 + " cannot be appeared in the middle of composite location.");
1290 if (!lattice1.equals(lattice2)) {
1291 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1292 + " because they are not comparable.");
1295 if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1297 // check if the current location is the spinning location
1298 // note that the spinning location only can be appeared in the last
1299 // part of the composite location
1300 if (numOfTie == compLoc1.getSize()
1301 && lattice1.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1302 return ComparisonResult.GREATER;
1305 } else if (lattice1.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1306 return ComparisonResult.GREATER;
1308 return ComparisonResult.LESS;
1313 if (numOfTie == compLoc1.getSize()) {
1315 if (numOfTie != compLoc2.getSize()) {
1316 throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1317 + " because they are not comparable.");
1320 return ComparisonResult.EQUAL;
1323 return ComparisonResult.LESS;
1327 public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet) {
1329 // System.out.println("Calculating GLB=" + inputSet);
1330 CompositeLocation glbCompLoc = new CompositeLocation();
1332 // calculate GLB of the first(priority) element
1333 Set<String> priorityLocIdentifierSet = new HashSet<String>();
1334 Descriptor priorityDescriptor = null;
1336 Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1337 new Hashtable<String, Set<CompositeLocation>>();
1338 // mapping from the priority loc ID to its full representation by the
1339 // composite location
1341 int maxTupleSize = 0;
1342 CompositeLocation maxCompLoc = null;
1344 for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1345 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1346 if (compLoc.getSize() > maxTupleSize) {
1347 maxTupleSize = compLoc.getSize();
1348 maxCompLoc = compLoc;
1350 Location priorityLoc = compLoc.get(0);
1351 String priorityLocId = priorityLoc.getLocIdentifier();
1352 priorityLocIdentifierSet.add(priorityLocId);
1354 if (locId2CompLocSet.containsKey(priorityLocId)) {
1355 locId2CompLocSet.get(priorityLocId).add(compLoc);
1357 Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1358 newSet.add(compLoc);
1359 locId2CompLocSet.put(priorityLocId, newSet);
1362 // check if priority location are coming from the same lattice
1363 if (priorityDescriptor == null) {
1364 priorityDescriptor = priorityLoc.getDescriptor();
1365 } else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1366 throw new Error("Failed to calculate GLB of " + inputSet
1367 + " because they are from different lattices.");
1371 SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1372 String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1374 glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1375 Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1377 // here find out composite location that has a maximum length tuple
1378 // if we have three input set: [A], [A,B], [A,B,C]
1379 // maximum length tuple will be [A,B,C]
1381 CompositeLocation maxFromCompSet = null;
1382 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1383 CompositeLocation c = (CompositeLocation) iterator.next();
1384 if (c.getSize() > max) {
1390 if (compSet == null) {
1391 // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1392 // mean that the result is already lower than <x1,y1> and <x2,y2>
1393 // assign TOP to the rest of the location elements
1395 // in this case, do not take care about delta
1396 // CompositeLocation inputComp = inputSet.iterator().next();
1397 CompositeLocation inputComp = maxCompLoc;
1398 for (int i = 1; i < inputComp.getSize(); i++) {
1399 glbCompLoc.addLocation(Location.createTopLocation(inputComp.get(i).getDescriptor()));
1402 if (compSet.size() == 1) {
1404 // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
1405 CompositeLocation comp = compSet.iterator().next();
1406 for (int i = 1; i < comp.getSize(); i++) {
1407 glbCompLoc.addLocation(comp.get(i));
1410 // if input location corresponding to glb is a delta, need to apply
1411 // delta to glb result
1412 if (comp instanceof DeltaLocation) {
1413 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1417 // when GLB(x1,x2)==x1 and x2 : GLB case 1
1418 // if more than one location shares the same priority GLB
1419 // need to calculate the rest of GLB loc
1421 // int compositeLocSize = compSet.iterator().next().getSize();
1422 int compositeLocSize = maxFromCompSet.getSize();
1424 Set<String> glbInputSet = new HashSet<String>();
1425 Descriptor currentD = null;
1426 for (int i = 1; i < compositeLocSize; i++) {
1427 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1428 CompositeLocation compositeLocation = (CompositeLocation) iterator.next();
1429 if (compositeLocation.getSize() > i) {
1430 Location currentLoc = compositeLocation.get(i);
1431 currentD = currentLoc.getDescriptor();
1432 // making set of the current location sharing the same idx
1433 glbInputSet.add(currentLoc.getLocIdentifier());
1436 // calculate glb for the current lattice
1438 SSJavaLattice<String> currentLattice = getLatticeByDescriptor(currentD);
1439 String currentGLBLocId = currentLattice.getGLB(glbInputSet);
1440 glbCompLoc.addLocation(new Location(currentD, currentGLBLocId));
1443 // if input location corresponding to glb is a delta, need to apply
1444 // delta to glb result
1446 for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1447 CompositeLocation compLoc = (CompositeLocation) iterator.next();
1448 if (compLoc instanceof DeltaLocation) {
1449 if (glbCompLoc.equals(compLoc)) {
1450 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1463 static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
1465 SSJavaLattice<String> lattice = null;
1467 if (d instanceof ClassDescriptor) {
1468 lattice = ssjava.getCd2lattice().get(d);
1469 } else if (d instanceof MethodDescriptor) {
1470 if (ssjava.getMd2lattice().containsKey(d)) {
1471 lattice = ssjava.getMd2lattice().get(d);
1473 // use default lattice for the method
1474 lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
1483 class ComparisonResult {
1485 public static final int GREATER = 0;
1486 public static final int EQUAL = 1;
1487 public static final int LESS = 2;
1488 public static final int INCOMPARABLE = 3;
1495 class ReturnLocGenerator {
1497 public static final int PARAMISHIGHER = 0;
1498 public static final int PARAMISSAME = 1;
1499 public static final int IGNORE = 2;
1501 Hashtable<Integer, Integer> paramIdx2paramType;
1503 public ReturnLocGenerator(CompositeLocation returnLoc, List<CompositeLocation> params) {
1504 // creating mappings
1506 paramIdx2paramType = new Hashtable<Integer, Integer>();
1507 for (int i = 0; i < params.size(); i++) {
1508 CompositeLocation param = params.get(i);
1509 int compareResult = CompositeLattice.compare(param, returnLoc);
1512 if (compareResult == ComparisonResult.GREATER) {
1514 } else if (compareResult == ComparisonResult.EQUAL) {
1519 paramIdx2paramType.put(new Integer(i), new Integer(type));
1524 public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
1526 // compute the highest possible location in caller's side
1527 assert paramIdx2paramType.keySet().size() == args.size();
1529 Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1530 for (int i = 0; i < args.size(); i++) {
1531 int type = (paramIdx2paramType.get(new Integer(i))).intValue();
1532 CompositeLocation argLoc = args.get(i);
1533 if (type == PARAMISHIGHER) {
1534 // return loc is lower than param
1535 DeltaLocation delta = new DeltaLocation(argLoc, 1);
1536 inputGLB.add(delta);
1537 } else if (type == PARAMISSAME) {
1538 // return loc is equal or lower than param
1539 inputGLB.add(argLoc);
1543 // compute GLB of arguments subset that are same or higher than return
1545 CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB);