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