Robust/src/Analysis/SSJava/FlowDownCheck.java

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