Robust/src/Analysis/SSJava/FlowDownCheck.java

   1 package Analysis.SSJava;
   2
   3 import java.util.ArrayList;
   4 import java.util.HashSet;
   5 import java.util.Hashtable;
   6 import java.util.Iterator;
   7 import java.util.List;
   8 import java.util.Set;
   9 import java.util.StringTokenizer;
  10 import java.util.Vector;
  11
  12 import Analysis.SSJava.FlowDownCheck.ComparisonResult;
  13 import Analysis.SSJava.FlowDownCheck.CompositeLattice;
  14 import IR.AnnotationDescriptor;
  15 import IR.ClassDescriptor;
  16 import IR.Descriptor;
  17 import IR.FieldDescriptor;
  18 import IR.MethodDescriptor;
  19 import IR.NameDescriptor;
  20 import IR.Operation;
  21 import IR.State;
  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;
  36 import IR.Tree.Kind;
  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;
  46 import Util.Pair;
  47
  48 public class FlowDownCheck {
  49
  50   State state;
  51   static SSJavaAnalysis ssjava;
  52
  53   HashSet toanalyze;
  54
  55   // mapping from 'descriptor' to 'composite location'
  56   Hashtable<Descriptor, CompositeLocation> d2loc;
  57
  58   Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
  59   Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
  60
  61   // mapping from 'locID' to 'class descriptor'
  62   Hashtable<String, ClassDescriptor> fieldLocName2cd;
  63
  64   public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
  65     this.ssjava = ssjava;
  66     this.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>();
  72   }
  73
  74   public void init() {
  75
  76     // construct mapping from the location name to the class descriptor
  77     // assume that the location name is unique through the whole program
  78
  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();
  84
  85       for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
  86         String fieldLocName = (String) iterator2.next();
  87         fieldLocName2cd.put(fieldLocName, cd);
  88       }
  89
  90     }
  91
  92   }
  93
  94   public void flowDownCheck() {
  95     SymbolTable classtable = state.getClassSymbolTable();
  96
  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);
 105
 106       if (!cd.isInterface()) {
 107
 108         ClassDescriptor superDesc = cd.getSuperDesc();
 109         if (superDesc != null && (!superDesc.isInterface())
 110             && (!superDesc.getSymbol().equals("Object"))) {
 111           checkOrderingInheritance(superDesc, cd);
 112         }
 113
 114         checkDeclarationInClass(cd);
 115         for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
 116           MethodDescriptor md = (MethodDescriptor) method_it.next();
 117           if (ssjava.needAnnotation(md)) {
 118             checkDeclarationInMethodBody(cd, md);
 119           }
 120         }
 121       }
 122
 123     }
 124
 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);
 132
 133       checkClass(cd);
 134       for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
 135         MethodDescriptor md = (MethodDescriptor) method_it.next();
 136         if (ssjava.needAnnotation(md)) {
 137           checkMethodBody(cd, md);
 138         }
 139       }
 140     }
 141
 142   }
 143
 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
 147
 148     SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
 149     SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
 150
 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.");
 154     }
 155
 156     Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
 157     Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
 158
 159     for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
 160       Pair<String, String> pair = (Pair<String, String>) iterator.next();
 161
 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 '"
 165             + superCd + "'.");
 166       }
 167     }
 168
 169   }
 170
 171   public Hashtable getMap() {
 172     return d2loc;
 173   }
 174
 175   private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
 176     BlockNode bn = state.getMethodBody(md);
 177
 178     // parsing returnloc annotation
 179     if (ssjava.needAnnotation(md)) {
 180
 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);
 191           }
 192         }
 193
 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());
 197         }
 198
 199       }
 200     }
 201
 202     List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
 203
 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);
 210     }
 211
 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));
 218       }
 219     }
 220
 221     if (hasReturnValue) {
 222       md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), paramList));
 223     }
 224
 225     checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
 226   }
 227
 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);
 233     }
 234   }
 235
 236   private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
 237       BlockStatementNode bsn) {
 238
 239     switch (bsn.kind()) {
 240     case Kind.SubBlockNode:
 241       checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
 242       return;
 243
 244     case Kind.DeclarationNode:
 245       checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
 246       break;
 247
 248     case Kind.LoopNode:
 249       checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
 250       break;
 251     }
 252   }
 253
 254   private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
 255
 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);
 263       }
 264     }
 265
 266     // check loop body
 267     checkDeclarationInBlockNode(md, nametable, ln.getBody());
 268   }
 269
 270   private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
 271     BlockNode bn = state.getMethodBody(md);
 272     checkLocationFromBlockNode(md, md.getParameterTable(), bn);
 273   }
 274
 275   private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
 276       BlockNode bn) {
 277
 278     bn.getVarTable().setParent(nametable);
 279     // it will return the lowest location in the block node
 280     CompositeLocation lowestLoc = null;
 281
 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) {
 287           lowestLoc = bLoc;
 288         } else {
 289           if (CompositeLattice.isGreaterThan(lowestLoc, bLoc)) {
 290             lowestLoc = bLoc;
 291           }
 292         }
 293       }
 294
 295     }
 296
 297     if (lowestLoc == null) {
 298       lowestLoc = new CompositeLocation(Location.createBottomLocation(md));
 299     }
 300
 301     return lowestLoc;
 302   }
 303
 304   private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
 305       SymbolTable nametable, BlockStatementNode bsn) {
 306
 307     CompositeLocation compLoc = null;
 308     switch (bsn.kind()) {
 309     case Kind.BlockExpressionNode:
 310       compLoc = checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn);
 311       break;
 312
 313     case Kind.DeclarationNode:
 314       compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn);
 315       break;
 316
 317     case Kind.IfStatementNode:
 318       compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn);
 319       break;
 320
 321     case Kind.LoopNode:
 322       compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn);
 323       break;
 324
 325     case Kind.ReturnNode:
 326       compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn);
 327       break;
 328
 329     case Kind.SubBlockNode:
 330       compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn);
 331       break;
 332
 333     case Kind.ContinueBreakNode:
 334       compLoc = new CompositeLocation();
 335       break;
 336
 337     }
 338     return compLoc;
 339   }
 340
 341   private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
 342       ReturnNode rn) {
 343
 344     ExpressionNode returnExp = rn.getReturnExpression();
 345
 346     CompositeLocation expLoc =
 347         checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation());
 348
 349     // check if return value is equal or higher than RETRUNLOC of method
 350     // declaration annotation
 351     CompositeLocation returnLocAt = md2ReturnLoc.get(md);
 352
 353     if (CompositeLattice.isGreaterThan(returnLocAt, expLoc)) {
 354       throw new Error(
 355           "Return value location is not equal or higher than the declaraed return location at "
 356               + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
 357     }
 358
 359     return new CompositeLocation();
 360   }
 361
 362   private boolean hasOnlyLiteralValue(ExpressionNode en) {
 363     if (en.kind() == Kind.LiteralNode) {
 364       return true;
 365     } else {
 366       return false;
 367     }
 368   }
 369
 370   private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
 371       LoopNode ln) {
 372
 373     ClassDescriptor cd = md.getClassDesc();
 374     if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
 375
 376       CompositeLocation condLoc =
 377           checkLocationFromExpressionNode(md, nametable, ln.getCondition(), new CompositeLocation());
 378       addTypeLocation(ln.getCondition().getType(), (condLoc));
 379
 380       CompositeLocation bodyLoc = checkLocationFromBlockNode(md, nametable, ln.getBody());
 381
 382       if (!CompositeLattice.isGreaterThan(condLoc, bodyLoc)) {
 383         // loop condition should be higher than loop body
 384         throw new Error(
 385             "The location of the while-condition statement is lower than the loop body at "
 386                 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
 387       }
 388
 389       return bodyLoc;
 390
 391     } else {
 392       // check for loop case
 393       BlockNode bn = ln.getInitializer();
 394       bn.getVarTable().setParent(nametable);
 395
 396       // calculate glb location of condition and update statements
 397       CompositeLocation condLoc =
 398           checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
 399               new CompositeLocation());
 400       addTypeLocation(ln.getCondition().getType(), condLoc);
 401
 402       CompositeLocation updateLoc =
 403           checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate());
 404
 405       Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 406       glbInputSet.add(condLoc);
 407       glbInputSet.add(updateLoc);
 408
 409       CompositeLocation glbLocOfForLoopCond = CompositeLattice.calculateGLB(glbInputSet);
 410
 411       // check location of 'forloop' body
 412       CompositeLocation blockLoc = checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody());
 413
 414       if (blockLoc == null) {
 415         // when there is no statement in the loop body
 416         return glbLocOfForLoopCond;
 417       }
 418
 419       if (!CompositeLattice.isGreaterThan(glbLocOfForLoopCond, blockLoc)) {
 420         throw new Error(
 421             "The location of the for-condition statement is lower than the for-loop body at "
 422                 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
 423       }
 424       return blockLoc;
 425     }
 426
 427   }
 428
 429   private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
 430       SymbolTable nametable, SubBlockNode sbn) {
 431     CompositeLocation compLoc = checkLocationFromBlockNode(md, nametable, sbn.getBlockNode());
 432     return compLoc;
 433   }
 434
 435   private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
 436       SymbolTable nametable, IfStatementNode isn) {
 437
 438     ClassDescriptor localCD = md.getClassDesc();
 439     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 440
 441     CompositeLocation condLoc =
 442         checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation());
 443
 444     addTypeLocation(isn.getCondition().getType(), condLoc);
 445     glbInputSet.add(condLoc);
 446
 447     CompositeLocation locTrueBlock = checkLocationFromBlockNode(md, nametable, isn.getTrueBlock());
 448     if (locTrueBlock != null) {
 449       glbInputSet.add(locTrueBlock);
 450       // here, the location of conditional block should be higher than the
 451       // location of true/false blocks
 452       if (locTrueBlock != null && !CompositeLattice.isGreaterThan(condLoc, locTrueBlock)) {
 453         // error
 454         throw new Error(
 455             "The location of the if-condition statement is lower than the conditional block at "
 456                 + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
 457       }
 458     }
 459
 460     if (isn.getFalseBlock() != null) {
 461       CompositeLocation locFalseBlock =
 462           checkLocationFromBlockNode(md, nametable, isn.getFalseBlock());
 463
 464       if (locFalseBlock != null) {
 465         glbInputSet.add(locFalseBlock);
 466
 467         if (!CompositeLattice.isGreaterThan(condLoc, locFalseBlock)) {
 468           // error
 469           throw new Error(
 470               "The location of the if-condition statement is lower than the conditional block at "
 471                   + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
 472         }
 473       }
 474
 475     }
 476
 477     // return GLB location of condition, true, and false block
 478     CompositeLocation glbLoc = CompositeLattice.calculateGLB(glbInputSet);
 479
 480     return glbLoc;
 481   }
 482
 483   private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
 484       SymbolTable nametable, DeclarationNode dn) {
 485
 486     VarDescriptor vd = dn.getVarDescriptor();
 487
 488     CompositeLocation destLoc = d2loc.get(vd);
 489
 490     if (dn.getExpression() != null) {
 491       CompositeLocation expressionLoc =
 492           checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
 493               new CompositeLocation());
 494       // addTypeLocation(dn.getExpression().getType(), expressionLoc);
 495
 496       if (expressionLoc != null) {
 497         // checking location order
 498         if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc)) {
 499           throw new Error("The value flow from " + expressionLoc + " to " + destLoc
 500               + " does not respect location hierarchy on the assignment " + dn.printNode(0)
 501               + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
 502         }
 503       }
 504       return expressionLoc;
 505
 506     } else {
 507
 508       return new CompositeLocation();
 509
 510     }
 511
 512   }
 513
 514   private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
 515       SubBlockNode sbn) {
 516     checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
 517   }
 518
 519   private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
 520       SymbolTable nametable, BlockExpressionNode ben) {
 521     CompositeLocation compLoc =
 522         checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null);
 523     // addTypeLocation(ben.getExpression().getType(), compLoc);
 524     return compLoc;
 525   }
 526
 527   private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
 528       SymbolTable nametable, ExpressionNode en, CompositeLocation loc) {
 529
 530     CompositeLocation compLoc = null;
 531     switch (en.kind()) {
 532
 533     case Kind.AssignmentNode:
 534       compLoc = checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc);
 535       break;
 536
 537     case Kind.FieldAccessNode:
 538       compLoc = checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc);
 539       break;
 540
 541     case Kind.NameNode:
 542       compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc);
 543       break;
 544
 545     case Kind.OpNode:
 546       compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en);
 547       break;
 548
 549     case Kind.CreateObjectNode:
 550       compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
 551       break;
 552
 553     case Kind.ArrayAccessNode:
 554       compLoc = checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en);
 555       break;
 556
 557     case Kind.LiteralNode:
 558       compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
 559       break;
 560
 561     case Kind.MethodInvokeNode:
 562       compLoc = checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc);
 563       break;
 564
 565     case Kind.TertiaryNode:
 566       compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en);
 567       break;
 568
 569     case Kind.CastNode:
 570       compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en);
 571       break;
 572
 573     // case Kind.InstanceOfNode:
 574     // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
 575     // return null;
 576
 577     // case Kind.ArrayInitializerNode:
 578     // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
 579     // td);
 580     // return null;
 581
 582     // case Kind.ClassTypeNode:
 583     // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
 584     // return null;
 585
 586     // case Kind.OffsetNode:
 587     // checkOffsetNode(md, nametable, (OffsetNode)en, td);
 588     // return null;
 589
 590     default:
 591       return null;
 592
 593     }
 594     // addTypeLocation(en.getType(), compLoc);
 595     return compLoc;
 596
 597   }
 598
 599   private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
 600       CastNode cn) {
 601
 602     ExpressionNode en = cn.getExpression();
 603     return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
 604
 605   }
 606
 607   private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
 608       SymbolTable nametable, TertiaryNode tn) {
 609     ClassDescriptor cd = md.getClassDesc();
 610
 611     CompositeLocation condLoc =
 612         checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation());
 613     addTypeLocation(tn.getCond().getType(), condLoc);
 614     CompositeLocation trueLoc =
 615         checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation());
 616     addTypeLocation(tn.getTrueExpr().getType(), trueLoc);
 617     CompositeLocation falseLoc =
 618         checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation());
 619     addTypeLocation(tn.getFalseExpr().getType(), falseLoc);
 620
 621     // check if condLoc is higher than trueLoc & falseLoc
 622     if (!CompositeLattice.isGreaterThan(condLoc, trueLoc)) {
 623       throw new Error(
 624           "The location of the condition expression is lower than the true expression at "
 625               + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
 626     }
 627
 628     if (!CompositeLattice.isGreaterThan(condLoc, falseLoc)) {
 629       throw new Error(
 630           "The location of the condition expression is lower than the true expression at "
 631               + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
 632     }
 633
 634     // then, return glb of trueLoc & falseLoc
 635     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 636     glbInputSet.add(trueLoc);
 637     glbInputSet.add(falseLoc);
 638
 639     return CompositeLattice.calculateGLB(glbInputSet);
 640   }
 641
 642   private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
 643       SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc) {
 644
 645     checkCalleeConstraints(md, nametable, min);
 646
 647     CompositeLocation baseLocation = null;
 648     if (min.getExpression() != null) {
 649       baseLocation =
 650           checkLocationFromExpressionNode(md, nametable, min.getExpression(),
 651               new CompositeLocation());
 652     } else {
 653       String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
 654       baseLocation = new CompositeLocation(new Location(md, thisLocId));
 655     }
 656
 657     if (!min.getMethod().getReturnType().isVoid()) {
 658       // If method has a return value, compute the highest possible return
 659       // location in the caller's perspective
 660       CompositeLocation ceilingLoc =
 661           computeCeilingLocationForCaller(md, nametable, min, baseLocation);
 662       return ceilingLoc;
 663     }
 664
 665     return new CompositeLocation();
 666
 667   }
 668
 669   private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
 670       SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation) {
 671     List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
 672
 673     // by default, method has a THIS parameter
 674     argList.add(baseLocation);
 675
 676     for (int i = 0; i < min.numArgs(); i++) {
 677       ExpressionNode en = min.getArg(i);
 678       CompositeLocation callerArg =
 679           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
 680       argList.add(callerArg);
 681     }
 682
 683     return md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
 684
 685   }
 686
 687   private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
 688       MethodInvokeNode min) {
 689
 690     if (min.numArgs() > 1) {
 691       // caller needs to guarantee that it passes arguments in regarding to
 692       // callee's hierarchy
 693       for (int i = 0; i < min.numArgs(); i++) {
 694         ExpressionNode en = min.getArg(i);
 695         CompositeLocation callerArg1 =
 696             checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
 697
 698         ClassDescriptor calleecd = min.getMethod().getClassDesc();
 699         VarDescriptor calleevd = (VarDescriptor) min.getMethod().getParameter(i);
 700         CompositeLocation calleeLoc1 = d2loc.get(calleevd);
 701
 702         if (!callerArg1.get(0).isTop()) {
 703           // here, check if ordering relations among caller's args respect
 704           // ordering relations in-between callee's args
 705           for (int currentIdx = 0; currentIdx < min.numArgs(); currentIdx++) {
 706             if (currentIdx != i) { // skip itself
 707               ExpressionNode argExp = min.getArg(currentIdx);
 708
 709               CompositeLocation callerArg2 =
 710                   checkLocationFromExpressionNode(md, nametable, argExp, new CompositeLocation());
 711
 712               VarDescriptor calleevd2 = (VarDescriptor) min.getMethod().getParameter(currentIdx);
 713               CompositeLocation calleeLoc2 = d2loc.get(calleevd2);
 714
 715               boolean callerResult = CompositeLattice.isGreaterThan(callerArg1, callerArg2);
 716               boolean calleeResult = CompositeLattice.isGreaterThan(calleeLoc1, calleeLoc2);
 717
 718               if (calleeResult && !callerResult) {
 719                 // If calleeLoc1 is higher than calleeLoc2
 720                 // then, caller should have same ordering relation in-bet
 721                 // callerLoc1 & callerLoc2
 722
 723                 throw new Error("Caller doesn't respect ordering relations among method arguments:"
 724                     + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
 725               }
 726
 727             }
 728           }
 729         }
 730
 731       }
 732
 733     }
 734
 735   }
 736
 737   private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
 738       SymbolTable nametable, ArrayAccessNode aan) {
 739
 740     // return glb location of array itself and index
 741
 742     ClassDescriptor cd = md.getClassDesc();
 743
 744     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 745
 746     CompositeLocation arrayLoc =
 747         checkLocationFromExpressionNode(md, nametable, aan.getExpression(), new CompositeLocation());
 748     // addTypeLocation(aan.getExpression().getType(), arrayLoc);
 749     glbInputSet.add(arrayLoc);
 750     CompositeLocation indexLoc =
 751         checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation());
 752     glbInputSet.add(indexLoc);
 753     // addTypeLocation(aan.getIndex().getType(), indexLoc);
 754
 755     CompositeLocation glbLoc = CompositeLattice.calculateGLB(glbInputSet);
 756     return glbLoc;
 757   }
 758
 759   private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
 760       SymbolTable nametable, CreateObjectNode con) {
 761
 762     ClassDescriptor cd = md.getClassDesc();
 763
 764     // check arguments
 765     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 766     for (int i = 0; i < con.numArgs(); i++) {
 767       ExpressionNode en = con.getArg(i);
 768       CompositeLocation argLoc =
 769           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation());
 770       glbInputSet.add(argLoc);
 771       addTypeLocation(en.getType(), argLoc);
 772     }
 773
 774     // check array initializers
 775     // if ((con.getArrayInitializer() != null)) {
 776     // checkLocationFromArrayInitializerNode(md, nametable,
 777     // con.getArrayInitializer());
 778     // }
 779
 780     if (glbInputSet.size() > 0) {
 781       return CompositeLattice.calculateGLB(glbInputSet);
 782     }
 783
 784     CompositeLocation compLoc = new CompositeLocation();
 785     compLoc.addLocation(Location.createTopLocation(md));
 786     return compLoc;
 787
 788   }
 789
 790   private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
 791       OpNode on) {
 792
 793     ClassDescriptor cd = md.getClassDesc();
 794     CompositeLocation leftLoc = new CompositeLocation();
 795     leftLoc = checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc);
 796     // addTypeLocation(on.getLeft().getType(), leftLoc);
 797
 798     CompositeLocation rightLoc = new CompositeLocation();
 799     if (on.getRight() != null) {
 800       rightLoc = checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc);
 801       // addTypeLocation(on.getRight().getType(), rightLoc);
 802     }
 803
 804     // System.out.println("checking op node=" + on.printNode(0));
 805     // System.out.println("left loc=" + leftLoc + " from " +
 806     // on.getLeft().getClass());
 807     // System.out.println("right loc=" + rightLoc + " from " +
 808     // on.getRight().getClass());
 809
 810     Operation op = on.getOp();
 811
 812     switch (op.getOp()) {
 813
 814     case Operation.UNARYPLUS:
 815     case Operation.UNARYMINUS:
 816     case Operation.LOGIC_NOT:
 817       // single operand
 818       return leftLoc;
 819
 820     case Operation.LOGIC_OR:
 821     case Operation.LOGIC_AND:
 822     case Operation.COMP:
 823     case Operation.BIT_OR:
 824     case Operation.BIT_XOR:
 825     case Operation.BIT_AND:
 826     case Operation.ISAVAILABLE:
 827     case Operation.EQUAL:
 828     case Operation.NOTEQUAL:
 829     case Operation.LT:
 830     case Operation.GT:
 831     case Operation.LTE:
 832     case Operation.GTE:
 833     case Operation.ADD:
 834     case Operation.SUB:
 835     case Operation.MULT:
 836     case Operation.DIV:
 837     case Operation.MOD:
 838     case Operation.LEFTSHIFT:
 839     case Operation.RIGHTSHIFT:
 840     case Operation.URIGHTSHIFT:
 841
 842       Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
 843       inputSet.add(leftLoc);
 844       inputSet.add(rightLoc);
 845       CompositeLocation glbCompLoc = CompositeLattice.calculateGLB(inputSet);
 846       return glbCompLoc;
 847
 848     default:
 849       throw new Error(op.toString());
 850     }
 851
 852   }
 853
 854   private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
 855       SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
 856
 857     // literal value has the top location so that value can be flowed into any
 858     // location
 859     Location literalLoc = Location.createTopLocation(md);
 860     loc.addLocation(literalLoc);
 861     return loc;
 862
 863   }
 864
 865   private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
 866       NameNode nn, CompositeLocation loc) {
 867
 868     NameDescriptor nd = nn.getName();
 869     if (nd.getBase() != null) {
 870
 871       loc = checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc);
 872       // addTypeLocation(nn.getExpression().getType(), loc);
 873     } else {
 874       String varname = nd.toString();
 875
 876       if (varname.equals("this")) {
 877         // 'this' itself!
 878         MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
 879         String thisLocId = methodLattice.getThisLoc();
 880         if (thisLocId == null) {
 881           throw new Error("The location for 'this' is not defined at "
 882               + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
 883         }
 884         Location locElement = new Location(md, thisLocId);
 885         loc.addLocation(locElement);
 886         return loc;
 887       }
 888       Descriptor d = (Descriptor) nametable.get(varname);
 889
 890       // CompositeLocation localLoc = null;
 891       if (d instanceof VarDescriptor) {
 892         VarDescriptor vd = (VarDescriptor) d;
 893         // localLoc = d2loc.get(vd);
 894         // the type of var descriptor has a composite location!
 895         loc = ((CompositeLocation) vd.getType().getExtension()).clone();
 896       } else if (d instanceof FieldDescriptor) {
 897         // the type of field descriptor has a location!
 898         FieldDescriptor fd = (FieldDescriptor) d;
 899
 900         if (fd.isStatic()) {
 901           if (fd.isFinal()) {
 902             // if it is 'static final', the location has TOP since no one can
 903             // change its value
 904             loc.addLocation(Location.createTopLocation(md));
 905           } else {
 906             // if 'static', the location has pre-assigned global loc
 907             MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
 908             String globalLocId = localLattice.getGlobalLoc();
 909             if (globalLocId == null) {
 910               throw new Error("Global location element is not defined in the method " + md);
 911             }
 912             Location globalLoc = new Location(md, globalLocId);
 913
 914             loc.addLocation(globalLoc);
 915           }
 916         } else {
 917           // the location of field access starts from this, followed by field
 918           // location
 919           MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
 920           Location thisLoc = new Location(md, localLattice.getThisLoc());
 921           loc.addLocation(thisLoc);
 922         }
 923
 924         Location fieldLoc = (Location) fd.getType().getExtension();
 925         loc.addLocation(fieldLoc);
 926       }
 927     }
 928     return loc;
 929   }
 930
 931   private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
 932       SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc) {
 933
 934     ExpressionNode left = fan.getExpression();
 935     loc = checkLocationFromExpressionNode(md, nametable, left, loc);
 936     // addTypeLocation(left.getType(), loc);
 937
 938     if (!left.getType().isPrimitive()) {
 939       FieldDescriptor fd = fan.getField();
 940       Location fieldLoc = (Location) fd.getType().getExtension();
 941       loc.addLocation(fieldLoc);
 942     }
 943
 944     return loc;
 945   }
 946
 947   private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
 948       SymbolTable nametable, AssignmentNode an, CompositeLocation loc) {
 949
 950     ClassDescriptor cd = md.getClassDesc();
 951
 952     boolean postinc = true;
 953     if (an.getOperation().getBaseOp() == null
 954         || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
 955             .getBaseOp().getOp() != Operation.POSTDEC))
 956       postinc = false;
 957
 958     CompositeLocation destLocation =
 959         checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation());
 960
 961     CompositeLocation srcLocation = new CompositeLocation();
 962
 963     if (!postinc) {
 964       if (hasOnlyLiteralValue(an.getSrc())) {
 965         // if source is literal value, src location is TOP. so do not need to
 966         // compare!
 967         return destLocation;
 968       }
 969       srcLocation = new CompositeLocation();
 970       srcLocation = checkLocationFromExpressionNode(md, nametable, an.getSrc(), srcLocation);
 971       // System.out.println(" an= " + an.printNode(0) + " an.getSrc()=" +
 972       // an.getSrc().getClass()
 973       // + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
 974       // System.out.println("srcLocation=" + srcLocation);
 975       // System.out.println("dstLocation=" + destLocation);
 976       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation)) {
 977         throw new Error("The value flow from " + srcLocation + " to " + destLocation
 978             + " does not respect location hierarchy on the assignment " + an.printNode(0) + " at "
 979             + cd.getSourceFileName() + "::" + an.getNumLine());
 980       }
 981     } else {
 982       destLocation =
 983           srcLocation = checkLocationFromExpressionNode(md, nametable, an.getDest(), srcLocation);
 984
 985       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation)) {
 986         throw new Error("Location " + destLocation
 987             + " is not allowed to have the value flow that moves within the same location at "
 988             + cd.getSourceFileName() + "::" + an.getNumLine());
 989       }
 990
 991     }
 992
 993     return destLocation;
 994   }
 995
 996   private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
 997       SymbolTable nametable, TreeNode n) {
 998
 999     ClassDescriptor cd = md.getClassDesc();
1000     Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1001
1002     // currently enforce every variable to have corresponding location
1003     if (annotationVec.size() == 0) {
1004       throw new Error("Location is not assigned to variable " + vd.getSymbol() + " in the method "
1005           + md.getSymbol() + " of the class " + cd.getSymbol());
1006     }
1007
1008     if (annotationVec.size() > 1) { // variable can have at most one location
1009       throw new Error(vd.getSymbol() + " has more than one location.");
1010     }
1011
1012     AnnotationDescriptor ad = annotationVec.elementAt(0);
1013
1014     if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1015
1016       if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1017         String locDec = ad.getValue(); // check if location is defined
1018
1019         if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1020           DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1021           d2loc.put(vd, deltaLoc);
1022           addTypeLocation(vd.getType(), deltaLoc);
1023         } else {
1024           CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1025           d2loc.put(vd, compLoc);
1026           addTypeLocation(vd.getType(), compLoc);
1027         }
1028
1029       }
1030     }
1031
1032   }
1033
1034   private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1035
1036     int deltaCount = 0;
1037     int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1038     while (dIdx >= 0) {
1039       deltaCount++;
1040       int beginIdx = dIdx + 6;
1041       locDec = locDec.substring(beginIdx, locDec.length() - 1);
1042       dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1043     }
1044
1045     CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1046     DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1047
1048     return deltaLoc;
1049   }
1050
1051   private Location parseFieldLocDeclaraton(String decl) {
1052
1053     int idx = decl.indexOf(".");
1054     String className = decl.substring(0, idx);
1055     String fieldName = decl.substring(idx + 1);
1056
1057     Descriptor d = state.getClassSymbolTable().get(className);
1058
1059     assert (d instanceof ClassDescriptor);
1060     SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1061     if (!lattice.containsKey(fieldName)) {
1062       throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1063           + className + "'.");
1064     }
1065
1066     return new Location(d, fieldName);
1067   }
1068
1069   private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1070
1071     CompositeLocation compLoc = new CompositeLocation();
1072
1073     StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1074     List<String> locIdList = new ArrayList<String>();
1075     while (tokenizer.hasMoreTokens()) {
1076       String locId = tokenizer.nextToken();
1077       locIdList.add(locId);
1078     }
1079
1080     // at least,one location element needs to be here!
1081     assert (locIdList.size() > 0);
1082
1083     // assume that loc with idx 0 comes from the local lattice
1084     // loc with idx 1 comes from the field lattice
1085
1086     String localLocId = locIdList.get(0);
1087     SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1088     Location localLoc = new Location(md, localLocId);
1089     if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1090       throw new Error("Location " + localLocId
1091           + " is not defined in the local variable lattice at "
1092           + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : "") + ".");
1093     }
1094     compLoc.addLocation(localLoc);
1095
1096     for (int i = 1; i < locIdList.size(); i++) {
1097       String locName = locIdList.get(i);
1098
1099       Location fieldLoc = parseFieldLocDeclaraton(locName);
1100       // ClassDescriptor cd = fieldLocName2cd.get(locName);
1101       // SSJavaLattice<String> fieldLattice =
1102       // CompositeLattice.getLatticeByDescriptor(cd);
1103       //
1104       // if (fieldLattice == null || (!fieldLattice.containsKey(locName))) {
1105       // throw new Error("Location " + locName +
1106       // " is not defined in the field lattice at "
1107       // + cd.getSourceFileName() + ".");
1108       // }
1109       // Location fieldLoc = new Location(cd, locName);
1110       compLoc.addLocation(fieldLoc);
1111     }
1112
1113     return compLoc;
1114
1115   }
1116
1117   private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1118     VarDescriptor vd = dn.getVarDescriptor();
1119     assignLocationOfVarDescriptor(vd, md, nametable, dn);
1120   }
1121
1122   private void checkClass(ClassDescriptor cd) {
1123     // Check to see that methods respects ss property
1124     for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
1125       MethodDescriptor md = (MethodDescriptor) method_it.next();
1126       checkMethodDeclaration(cd, md);
1127     }
1128   }
1129
1130   private void checkDeclarationInClass(ClassDescriptor cd) {
1131     // Check to see that fields are okay
1132     for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1133       FieldDescriptor fd = (FieldDescriptor) field_it.next();
1134       checkFieldDeclaration(cd, fd);
1135     }
1136   }
1137
1138   private void checkMethodDeclaration(ClassDescriptor cd, MethodDescriptor md) {
1139     // TODO
1140   }
1141
1142   private void checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1143
1144     Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1145
1146     // currently enforce every field to have corresponding location
1147     if (annotationVec.size() == 0) {
1148       throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1149           + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1150     }
1151
1152     if (annotationVec.size() > 1) {
1153       // variable can have at most one location
1154       throw new Error("Field " + fd.getSymbol() + " of class " + cd
1155           + " has more than one location.");
1156     }
1157
1158     AnnotationDescriptor ad = annotationVec.elementAt(0);
1159
1160     if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1161
1162       if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1163         String locationID = ad.getValue();
1164         // check if location is defined
1165         SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1166         if (lattice == null || (!lattice.containsKey(locationID))) {
1167           throw new Error("Location " + locationID
1168               + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1169               + cd.getSourceFileName() + ".");
1170         }
1171         Location loc = new Location(cd, locationID);
1172         // d2loc.put(fd, loc);
1173         addTypeLocation(fd.getType(), loc);
1174
1175       }
1176     }
1177
1178   }
1179
1180   private void addTypeLocation(TypeDescriptor type, CompositeLocation loc) {
1181     if (type != null) {
1182       type.setExtension(loc);
1183     }
1184   }
1185
1186   private void addTypeLocation(TypeDescriptor type, Location loc) {
1187     if (type != null) {
1188       type.setExtension(loc);
1189     }
1190   }
1191
1192   static class CompositeLattice {
1193
1194     public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2) {
1195
1196       // System.out.println("isGreaterThan= " + loc1 + " " + loc2);
1197
1198       int baseCompareResult = compareBaseLocationSet(loc1, loc2);
1199       if (baseCompareResult == ComparisonResult.EQUAL) {
1200         if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
1201           return true;
1202         } else {
1203           return false;
1204         }
1205       } else if (baseCompareResult == ComparisonResult.GREATER) {
1206         return true;
1207       } else {
1208         return false;
1209       }
1210
1211     }
1212
1213     public static int compare(CompositeLocation loc1, CompositeLocation loc2) {
1214
1215       // System.out.println("compare=" + loc1 + " " + loc2);
1216       int baseCompareResult = compareBaseLocationSet(loc1, loc2);
1217
1218       if (baseCompareResult == ComparisonResult.EQUAL) {
1219         return compareDelta(loc1, loc2);
1220       } else {
1221         return baseCompareResult;
1222       }
1223
1224     }
1225
1226     private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
1227
1228       int deltaCount1 = 0;
1229       int deltaCount2 = 0;
1230       if (dLoc1 instanceof DeltaLocation) {
1231         deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
1232       }
1233
1234       if (dLoc2 instanceof DeltaLocation) {
1235         deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
1236       }
1237       if (deltaCount1 < deltaCount2) {
1238         return ComparisonResult.GREATER;
1239       } else if (deltaCount1 == deltaCount2) {
1240         return ComparisonResult.EQUAL;
1241       } else {
1242         return ComparisonResult.LESS;
1243       }
1244
1245     }
1246
1247     private static int compareBaseLocationSet(CompositeLocation compLoc1, CompositeLocation compLoc2) {
1248
1249       // if compLoc1 is greater than compLoc2, return true
1250       // else return false;
1251
1252       // compare one by one in according to the order of the tuple
1253       int numOfTie = 0;
1254       for (int i = 0; i < compLoc1.getSize(); i++) {
1255         Location loc1 = compLoc1.get(i);
1256         if (i >= compLoc2.getSize()) {
1257           throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1258               + " because they are not comparable.");
1259         }
1260         Location loc2 = compLoc2.get(i);
1261
1262         if (!loc1.getDescriptor().equals(loc2.getDescriptor())) {
1263           throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1264               + " because they are not comparable.");
1265         }
1266
1267         Descriptor d1 = loc1.getDescriptor();
1268         Descriptor d2 = loc2.getDescriptor();
1269
1270         SSJavaLattice<String> lattice1 = getLatticeByDescriptor(d1);
1271         SSJavaLattice<String> lattice2 = getLatticeByDescriptor(d2);
1272
1273         // check if the spin location is appeared only at the end of the
1274         // composite location
1275         if (lattice1.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1276           if (i != (compLoc1.getSize() - 1)) {
1277             throw new Error("The spin location " + loc1.getLocIdentifier()
1278                 + " cannot be appeared in the middle of composite location.");
1279           }
1280         }
1281
1282         if (lattice2.getSpinLocSet().contains(loc2.getLocIdentifier())) {
1283           if (i != (compLoc2.getSize() - 1)) {
1284             throw new Error("The spin location " + loc2.getLocIdentifier()
1285                 + " cannot be appeared in the middle of composite location.");
1286           }
1287         }
1288
1289         if (!lattice1.equals(lattice2)) {
1290           throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1291               + " because they are not comparable.");
1292         }
1293
1294         if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1295           numOfTie++;
1296           // check if the current location is the spinning location
1297           // note that the spinning location only can be appeared in the last
1298           // part of the composite location
1299           if (numOfTie == compLoc1.getSize()
1300               && lattice1.getSpinLocSet().contains(loc1.getLocIdentifier())) {
1301             return ComparisonResult.GREATER;
1302           }
1303           continue;
1304         } else if (lattice1.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1305           return ComparisonResult.GREATER;
1306         } else {
1307           return ComparisonResult.LESS;
1308         }
1309
1310       }
1311
1312       if (numOfTie == compLoc1.getSize()) {
1313
1314         if (numOfTie != compLoc2.getSize()) {
1315           throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
1316               + " because they are not comparable.");
1317         }
1318
1319         return ComparisonResult.EQUAL;
1320       }
1321
1322       return ComparisonResult.LESS;
1323
1324     }
1325
1326     public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet) {
1327
1328       // System.out.println("Calculating GLB=" + inputSet);
1329       CompositeLocation glbCompLoc = new CompositeLocation();
1330
1331       // calculate GLB of the first(priority) element
1332       Set<String> priorityLocIdentifierSet = new HashSet<String>();
1333       Descriptor priorityDescriptor = null;
1334
1335       Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
1336           new Hashtable<String, Set<CompositeLocation>>();
1337       // mapping from the priority loc ID to its full representation by the
1338       // composite location
1339
1340       int maxTupleSize = 0;
1341       CompositeLocation maxCompLoc = null;
1342
1343       for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1344         CompositeLocation compLoc = (CompositeLocation) iterator.next();
1345         if (compLoc.getSize() > maxTupleSize) {
1346           maxTupleSize = compLoc.getSize();
1347           maxCompLoc = compLoc;
1348         }
1349         Location priorityLoc = compLoc.get(0);
1350         String priorityLocId = priorityLoc.getLocIdentifier();
1351         priorityLocIdentifierSet.add(priorityLocId);
1352
1353         if (locId2CompLocSet.containsKey(priorityLocId)) {
1354           locId2CompLocSet.get(priorityLocId).add(compLoc);
1355         } else {
1356           Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
1357           newSet.add(compLoc);
1358           locId2CompLocSet.put(priorityLocId, newSet);
1359         }
1360
1361         // check if priority location are coming from the same lattice
1362         if (priorityDescriptor == null) {
1363           priorityDescriptor = priorityLoc.getDescriptor();
1364         } else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
1365           throw new Error("Failed to calculate GLB of " + inputSet
1366               + " because they are from different lattices.");
1367         }
1368       }
1369
1370       SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
1371       String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
1372
1373       glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
1374       Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
1375
1376       // here find out composite location that has a maximum length tuple
1377       // if we have three input set: [A], [A,B], [A,B,C]
1378       // maximum length tuple will be [A,B,C]
1379       int max = 0;
1380       CompositeLocation maxFromCompSet = null;
1381       for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1382         CompositeLocation c = (CompositeLocation) iterator.next();
1383         if (c.getSize() > max) {
1384           max = c.getSize();
1385           maxFromCompSet = c;
1386         }
1387       }
1388
1389       if (compSet == null) {
1390         // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
1391         // mean that the result is already lower than <x1,y1> and <x2,y2>
1392         // assign TOP to the rest of the location elements
1393
1394         // in this case, do not take care about delta
1395         // CompositeLocation inputComp = inputSet.iterator().next();
1396         CompositeLocation inputComp = maxCompLoc;
1397         for (int i = 1; i < inputComp.getSize(); i++) {
1398           glbCompLoc.addLocation(Location.createTopLocation(inputComp.get(i).getDescriptor()));
1399         }
1400       } else {
1401         if (compSet.size() == 1) {
1402
1403           // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
1404           CompositeLocation comp = compSet.iterator().next();
1405           for (int i = 1; i < comp.getSize(); i++) {
1406             glbCompLoc.addLocation(comp.get(i));
1407           }
1408
1409           // if input location corresponding to glb is a delta, need to apply
1410           // delta to glb result
1411           if (comp instanceof DeltaLocation) {
1412             glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1413           }
1414
1415         } else {
1416           // when GLB(x1,x2)==x1 and x2 : GLB case 1
1417           // if more than one location shares the same priority GLB
1418           // need to calculate the rest of GLB loc
1419
1420           // int compositeLocSize = compSet.iterator().next().getSize();
1421           int compositeLocSize = maxFromCompSet.getSize();
1422
1423           Set<String> glbInputSet = new HashSet<String>();
1424           Descriptor currentD = null;
1425           for (int i = 1; i < compositeLocSize; i++) {
1426             for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1427               CompositeLocation compositeLocation = (CompositeLocation) iterator.next();
1428               if (compositeLocation.getSize() > i) {
1429                 Location currentLoc = compositeLocation.get(i);
1430                 currentD = currentLoc.getDescriptor();
1431                 // making set of the current location sharing the same idx
1432                 glbInputSet.add(currentLoc.getLocIdentifier());
1433               }
1434             }
1435             // calculate glb for the current lattice
1436
1437             SSJavaLattice<String> currentLattice = getLatticeByDescriptor(currentD);
1438             String currentGLBLocId = currentLattice.getGLB(glbInputSet);
1439             glbCompLoc.addLocation(new Location(currentD, currentGLBLocId));
1440           }
1441
1442           // if input location corresponding to glb is a delta, need to apply
1443           // delta to glb result
1444
1445           for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
1446             CompositeLocation compLoc = (CompositeLocation) iterator.next();
1447             if (compLoc instanceof DeltaLocation) {
1448               if (glbCompLoc.equals(compLoc)) {
1449                 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
1450                 break;
1451               }
1452             }
1453           }
1454
1455         }
1456       }
1457
1458       return glbCompLoc;
1459
1460     }
1461
1462     static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
1463
1464       SSJavaLattice<String> lattice = null;
1465
1466       if (d instanceof ClassDescriptor) {
1467         lattice = ssjava.getCd2lattice().get(d);
1468       } else if (d instanceof MethodDescriptor) {
1469         if (ssjava.getMd2lattice().containsKey(d)) {
1470           lattice = ssjava.getMd2lattice().get(d);
1471         } else {
1472           // use default lattice for the method
1473           lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
1474         }
1475       }
1476
1477       return lattice;
1478     }
1479
1480   }
1481
1482   class ComparisonResult {
1483
1484     public static final int GREATER = 0;
1485     public static final int EQUAL = 1;
1486     public static final int LESS = 2;
1487     public static final int INCOMPARABLE = 3;
1488     int result;
1489
1490   }
1491
1492 }
1493
1494 class ReturnLocGenerator {
1495
1496   public static final int PARAMISHIGHER = 0;
1497   public static final int PARAMISSAME = 1;
1498   public static final int IGNORE = 2;
1499
1500   Hashtable<Integer, Integer> paramIdx2paramType;
1501
1502   public ReturnLocGenerator(CompositeLocation returnLoc, List<CompositeLocation> params) {
1503     // creating mappings
1504
1505     paramIdx2paramType = new Hashtable<Integer, Integer>();
1506     for (int i = 0; i < params.size(); i++) {
1507       CompositeLocation param = params.get(i);
1508       int compareResult = CompositeLattice.compare(param, returnLoc);
1509
1510       int type;
1511       if (compareResult == ComparisonResult.GREATER) {
1512         type = 0;
1513       } else if (compareResult == ComparisonResult.EQUAL) {
1514         type = 1;
1515       } else {
1516         type = 2;
1517       }
1518       paramIdx2paramType.put(new Integer(i), new Integer(type));
1519     }
1520
1521   }
1522
1523   public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
1524
1525     // compute the highest possible location in caller's side
1526     assert paramIdx2paramType.keySet().size() == args.size();
1527
1528     Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1529     for (int i = 0; i < args.size(); i++) {
1530       int type = (paramIdx2paramType.get(new Integer(i))).intValue();
1531       CompositeLocation argLoc = args.get(i);
1532       if (type == PARAMISHIGHER) {
1533         // return loc is lower than param
1534         DeltaLocation delta = new DeltaLocation(argLoc, 1);
1535         inputGLB.add(delta);
1536       } else if (type == PARAMISSAME) {
1537         // return loc is equal or lower than param
1538         inputGLB.add(argLoc);
1539       }
1540     }
1541
1542     // compute GLB of arguments subset that are same or higher than return
1543     // location
1544     CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB);
1545     return glb;
1546   }
1547 }