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.TypeExtension;
  27 import IR.VarDescriptor;
  28 import IR.Flat.FlatNode;
  29 import IR.Tree.ArrayAccessNode;
  30 import IR.Tree.AssignmentNode;
  31 import IR.Tree.BlockExpressionNode;
  32 import IR.Tree.BlockNode;
  33 import IR.Tree.BlockStatementNode;
  34 import IR.Tree.CastNode;
  35 import IR.Tree.CreateObjectNode;
  36 import IR.Tree.DeclarationNode;
  37 import IR.Tree.ExpressionNode;
  38 import IR.Tree.FieldAccessNode;
  39 import IR.Tree.IfStatementNode;
  40 import IR.Tree.Kind;
  41 import IR.Tree.LiteralNode;
  42 import IR.Tree.LoopNode;
  43 import IR.Tree.MethodInvokeNode;
  44 import IR.Tree.NameNode;
  45 import IR.Tree.OpNode;
  46 import IR.Tree.ReturnNode;
  47 import IR.Tree.SubBlockNode;
  48 import IR.Tree.SwitchBlockNode;
  49 import IR.Tree.SwitchStatementNode;
  50 import IR.Tree.SynchronizedNode;
  51 import IR.Tree.TertiaryNode;
  52 import IR.Tree.TreeNode;
  53 import Util.Pair;
  54
  55 public class FlowDownCheck {
  56
  57   State state;
  58   static SSJavaAnalysis ssjava;
  59
  60   Set<ClassDescriptor> toanalyze;
  61   List<ClassDescriptor> toanalyzeList;
  62
  63   Set<MethodDescriptor> toanalyzeMethod;
  64   List<MethodDescriptor> toanalyzeMethodList;
  65
  66   // mapping from 'descriptor' to 'composite location'
  67   Hashtable<Descriptor, CompositeLocation> d2loc;
  68
  69   Hashtable<MethodDescriptor, CompositeLocation> md2ReturnLoc;
  70   Hashtable<MethodDescriptor, ReturnLocGenerator> md2ReturnLocGen;
  71
  72   // mapping from 'locID' to 'class descriptor'
  73   Hashtable<String, ClassDescriptor> fieldLocName2cd;
  74
  75   boolean deterministic = true;
  76
  77   public FlowDownCheck(SSJavaAnalysis ssjava, State state) {
  78     this.ssjava = ssjava;
  79     this.state = state;
  80     if (deterministic) {
  81       this.toanalyzeList = new ArrayList<ClassDescriptor>();
  82     } else {
  83       this.toanalyze = new HashSet<ClassDescriptor>();
  84     }
  85     if (deterministic) {
  86       this.toanalyzeMethodList = new ArrayList<MethodDescriptor>();
  87     } else {
  88       this.toanalyzeMethod = new HashSet<MethodDescriptor>();
  89     }
  90     this.d2loc = new Hashtable<Descriptor, CompositeLocation>();
  91     this.fieldLocName2cd = new Hashtable<String, ClassDescriptor>();
  92     this.md2ReturnLoc = new Hashtable<MethodDescriptor, CompositeLocation>();
  93     this.md2ReturnLocGen = new Hashtable<MethodDescriptor, ReturnLocGenerator>();
  94   }
  95
  96   public void init() {
  97
  98     // construct mapping from the location name to the class descriptor
  99     // assume that the location name is unique through the whole program
 100
 101     Set<ClassDescriptor> cdSet = ssjava.getCd2lattice().keySet();
 102     for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
 103       ClassDescriptor cd = (ClassDescriptor) iterator.next();
 104       SSJavaLattice<String> lattice = ssjava.getCd2lattice().get(cd);
 105       Set<String> fieldLocNameSet = lattice.getKeySet();
 106
 107       for (Iterator iterator2 = fieldLocNameSet.iterator(); iterator2.hasNext();) {
 108         String fieldLocName = (String) iterator2.next();
 109         fieldLocName2cd.put(fieldLocName, cd);
 110       }
 111
 112     }
 113
 114   }
 115
 116   public boolean toAnalyzeIsEmpty() {
 117     if (deterministic) {
 118       return toanalyzeList.isEmpty();
 119     } else {
 120       return toanalyze.isEmpty();
 121     }
 122   }
 123
 124   public ClassDescriptor toAnalyzeNext() {
 125     if (deterministic) {
 126       return toanalyzeList.remove(0);
 127     } else {
 128       ClassDescriptor cd = toanalyze.iterator().next();
 129       toanalyze.remove(cd);
 130       return cd;
 131     }
 132   }
 133
 134   public void setupToAnalyze() {
 135     SymbolTable classtable = state.getClassSymbolTable();
 136     if (deterministic) {
 137       toanalyzeList.clear();
 138       toanalyzeList.addAll(classtable.getValueSet());
 139       Collections.sort(toanalyzeList, new Comparator<ClassDescriptor>() {
 140         public int compare(ClassDescriptor o1, ClassDescriptor o2) {
 141           return o1.getClassName().compareToIgnoreCase(o2.getClassName());
 142         }
 143       });
 144     } else {
 145       toanalyze.clear();
 146       toanalyze.addAll(classtable.getValueSet());
 147     }
 148   }
 149
 150   public void setupToAnalazeMethod(ClassDescriptor cd) {
 151
 152     SymbolTable methodtable = cd.getMethodTable();
 153     if (deterministic) {
 154       toanalyzeMethodList.clear();
 155       toanalyzeMethodList.addAll(methodtable.getValueSet());
 156       Collections.sort(toanalyzeMethodList, new Comparator<MethodDescriptor>() {
 157         public int compare(MethodDescriptor o1, MethodDescriptor o2) {
 158           return o1.getSymbol().compareToIgnoreCase(o2.getSymbol());
 159         }
 160       });
 161     } else {
 162       toanalyzeMethod.clear();
 163       toanalyzeMethod.addAll(methodtable.getValueSet());
 164     }
 165   }
 166
 167   public boolean toAnalyzeMethodIsEmpty() {
 168     if (deterministic) {
 169       return toanalyzeMethodList.isEmpty();
 170     } else {
 171       return toanalyzeMethod.isEmpty();
 172     }
 173   }
 174
 175   public MethodDescriptor toAnalyzeMethodNext() {
 176     if (deterministic) {
 177       return toanalyzeMethodList.remove(0);
 178     } else {
 179       MethodDescriptor md = toanalyzeMethod.iterator().next();
 180       toanalyzeMethod.remove(md);
 181       return md;
 182     }
 183   }
 184
 185   public void flowDownCheck() {
 186
 187     // phase 1 : checking declaration node and creating mapping of 'type
 188     // desciptor' & 'location'
 189     setupToAnalyze();
 190
 191     while (!toAnalyzeIsEmpty()) {
 192       ClassDescriptor cd = toAnalyzeNext();
 193
 194       if (ssjava.needToBeAnnoated(cd)) {
 195
 196         ClassDescriptor superDesc = cd.getSuperDesc();
 197
 198         if (superDesc != null && (!superDesc.getSymbol().equals("Object"))) {
 199           checkOrderingInheritance(superDesc, cd);
 200         }
 201
 202         checkDeclarationInClass(cd);
 203
 204         setupToAnalazeMethod(cd);
 205         while (!toAnalyzeMethodIsEmpty()) {
 206           MethodDescriptor md = toAnalyzeMethodNext();
 207           if (ssjava.needTobeAnnotated(md)) {
 208             checkDeclarationInMethodBody(cd, md);
 209           }
 210         }
 211
 212       }
 213
 214     }
 215
 216     // phase2 : checking assignments
 217     setupToAnalyze();
 218
 219     while (!toAnalyzeIsEmpty()) {
 220       ClassDescriptor cd = toAnalyzeNext();
 221
 222       setupToAnalazeMethod(cd);
 223       while (!toAnalyzeMethodIsEmpty()) {
 224         MethodDescriptor md = toAnalyzeMethodNext();
 225         if (ssjava.needTobeAnnotated(md)) {
 226           if (state.SSJAVADEBUG) {
 227             System.out.println("SSJAVA: Checking Flow-down Rules: " + md);
 228           }
 229           CompositeLocation calleePCLOC = ssjava.getPCLocation(md);
 230           checkMethodBody(cd, md, calleePCLOC);
 231         }
 232       }
 233     }
 234
 235   }
 236
 237   private void checkOrderingInheritance(ClassDescriptor superCd, ClassDescriptor cd) {
 238     // here, we're going to check that sub class keeps same relative orderings
 239     // in respect to super class
 240
 241     SSJavaLattice<String> superLattice = ssjava.getClassLattice(superCd);
 242     SSJavaLattice<String> subLattice = ssjava.getClassLattice(cd);
 243
 244     if (superLattice != null) {
 245       // if super class doesn't define lattice, then we don't need to check its
 246       // subclass
 247       if (subLattice == null) {
 248         throw new Error("If a parent class '" + superCd
 249             + "' has a ordering lattice, its subclass '" + cd + "' should have one.");
 250       }
 251
 252       Set<Pair<String, String>> superPairSet = superLattice.getOrderingPairSet();
 253       Set<Pair<String, String>> subPairSet = subLattice.getOrderingPairSet();
 254
 255       for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
 256         Pair<String, String> pair = (Pair<String, String>) iterator.next();
 257
 258         if (!subPairSet.contains(pair)) {
 259           throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
 260               + pair.getSecond() + " < " + pair.getFirst()
 261               + "' that is defined by its superclass '" + superCd + "'.");
 262         }
 263       }
 264     }
 265
 266     MethodLattice<String> superMethodDefaultLattice = ssjava.getMethodDefaultLattice(superCd);
 267     MethodLattice<String> subMethodDefaultLattice = ssjava.getMethodDefaultLattice(cd);
 268
 269     if (superMethodDefaultLattice != null) {
 270       if (subMethodDefaultLattice == null) {
 271         throw new Error("When a parent class '" + superCd
 272             + "' defines a default method lattice, its subclass '" + cd + "' should define one.");
 273       }
 274
 275       Set<Pair<String, String>> superPairSet = superMethodDefaultLattice.getOrderingPairSet();
 276       Set<Pair<String, String>> subPairSet = subMethodDefaultLattice.getOrderingPairSet();
 277
 278       for (Iterator iterator = superPairSet.iterator(); iterator.hasNext();) {
 279         Pair<String, String> pair = (Pair<String, String>) iterator.next();
 280
 281         if (!subPairSet.contains(pair)) {
 282           throw new Error("Subclass '" + cd + "' does not have the relative ordering '"
 283               + pair.getSecond() + " < " + pair.getFirst()
 284               + "' that is defined by its superclass '" + superCd
 285               + "' in the method default lattice.");
 286         }
 287       }
 288
 289     }
 290
 291   }
 292
 293   public Hashtable getMap() {
 294     return d2loc;
 295   }
 296
 297   private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
 298     BlockNode bn = state.getMethodBody(md);
 299
 300     // first, check annotations on method parameters
 301     List<CompositeLocation> paramList = new ArrayList<CompositeLocation>();
 302     for (int i = 0; i < md.numParameters(); i++) {
 303       // process annotations on method parameters
 304       VarDescriptor vd = (VarDescriptor) md.getParameter(i);
 305       assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), null);
 306       paramList.add(d2loc.get(vd));
 307     }
 308     Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
 309
 310     CompositeLocation returnLocComp = null;
 311
 312     boolean hasReturnLocDeclaration = false;
 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           hasReturnLocDeclaration = true;
 321         } else if (an.getMarker().equals(ssjava.THISLOC)) {
 322           String thisLoc = an.getValue();
 323           ssjava.getMethodLattice(md).setThisLoc(thisLoc);
 324         } else if (an.getMarker().equals(ssjava.GLOBALLOC)) {
 325           String globalLoc = an.getValue();
 326           ssjava.getMethodLattice(md).setGlobalLoc(globalLoc);
 327         } else if (an.getMarker().equals(ssjava.PCLOC)) {
 328           String pcLocDeclaration = an.getValue();
 329           ssjava.setPCLocation(md, parseLocationDeclaration(md, null, pcLocDeclaration));
 330         }
 331       }
 332     }
 333
 334     // second, check return location annotation
 335     if (!md.getReturnType().isVoid() && !ssjava.getMethodContainingSSJavaLoop().equals(md)) {
 336       if (!hasReturnLocDeclaration) {
 337         // if developer does not define method lattice
 338         // search return location in the method default lattice
 339         String rtrStr = ssjava.getMethodLattice(md).getReturnLoc();
 340         if (rtrStr != null) {
 341           returnLocComp = new CompositeLocation(new Location(md, rtrStr));
 342         }
 343       }
 344
 345       if (returnLocComp == null) {
 346         throw new Error("Return location is not specified for the method " + md + " at "
 347             + cd.getSourceFileName());
 348       }
 349
 350       md2ReturnLoc.put(md, returnLocComp);
 351
 352     }
 353
 354     if (!md.getReturnType().isVoid() && !ssjava.getMethodContainingSSJavaLoop().equals(md)) {
 355       MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
 356       String thisLocId = methodLattice.getThisLoc();
 357       if ((!md.isStatic())) {
 358
 359         if (thisLocId == null) {
 360           throw new Error("Method '" + md + "' does not have the definition of 'this' location at "
 361               + md.getClassDesc().getSourceFileName());
 362         }
 363
 364         CompositeLocation thisLoc = new CompositeLocation(new Location(md, thisLocId));
 365         paramList.add(0, thisLoc);
 366
 367       }
 368
 369       md2ReturnLocGen.put(md, new ReturnLocGenerator(md2ReturnLoc.get(md), md, paramList, md
 370           + " of " + cd.getSourceFileName()));
 371
 372     }
 373
 374     // fourth, check declarations inside of method
 375
 376     checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
 377
 378   }
 379
 380   private void checkDeclarationInBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn) {
 381     bn.getVarTable().setParent(nametable);
 382     for (int i = 0; i < bn.size(); i++) {
 383       BlockStatementNode bsn = bn.get(i);
 384       checkDeclarationInBlockStatementNode(md, bn.getVarTable(), bsn);
 385     }
 386   }
 387
 388   private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
 389       BlockStatementNode bsn) {
 390
 391     switch (bsn.kind()) {
 392     case Kind.SubBlockNode:
 393       checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
 394       return;
 395
 396     case Kind.DeclarationNode:
 397       checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
 398       break;
 399
 400     case Kind.LoopNode:
 401       checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
 402       break;
 403
 404     case Kind.IfStatementNode:
 405       checkDeclarationInIfStatementNode(md, nametable, (IfStatementNode) bsn);
 406       return;
 407
 408     case Kind.SwitchStatementNode:
 409       checkDeclarationInSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn);
 410       return;
 411
 412     case Kind.SynchronizedNode:
 413       checkDeclarationInSynchronizedNode(md, nametable, (SynchronizedNode) bsn);
 414       return;
 415
 416     }
 417   }
 418
 419   private void checkDeclarationInSynchronizedNode(MethodDescriptor md, SymbolTable nametable,
 420       SynchronizedNode sbn) {
 421     checkDeclarationInBlockNode(md, nametable, sbn.getBlockNode());
 422   }
 423
 424   private void checkDeclarationInSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
 425       SwitchStatementNode ssn) {
 426     BlockNode sbn = ssn.getSwitchBody();
 427     for (int i = 0; i < sbn.size(); i++) {
 428       SwitchBlockNode node = (SwitchBlockNode) sbn.get(i);
 429       checkDeclarationInBlockNode(md, nametable, node.getSwitchBlockStatement());
 430     }
 431   }
 432
 433   private void checkDeclarationInIfStatementNode(MethodDescriptor md, SymbolTable nametable,
 434       IfStatementNode isn) {
 435     checkDeclarationInBlockNode(md, nametable, isn.getTrueBlock());
 436     if (isn.getFalseBlock() != null)
 437       checkDeclarationInBlockNode(md, nametable, isn.getFalseBlock());
 438   }
 439
 440   private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
 441
 442     if (ln.getType() == LoopNode.FORLOOP) {
 443       // check for loop case
 444       ClassDescriptor cd = md.getClassDesc();
 445       BlockNode bn = ln.getInitializer();
 446       for (int i = 0; i < bn.size(); i++) {
 447         BlockStatementNode bsn = bn.get(i);
 448         checkDeclarationInBlockStatementNode(md, nametable, bsn);
 449       }
 450     }
 451
 452     // check loop body
 453     checkDeclarationInBlockNode(md, nametable, ln.getBody());
 454   }
 455
 456   private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md,
 457       CompositeLocation constraints) {
 458     BlockNode bn = state.getMethodBody(md);
 459     checkLocationFromBlockNode(md, md.getParameterTable(), bn, constraints);
 460   }
 461
 462   private String generateErrorMessage(ClassDescriptor cd, TreeNode tn) {
 463     if (tn != null) {
 464       return cd.getSourceFileName() + "::" + tn.getNumLine();
 465     } else {
 466       return cd.getSourceFileName();
 467     }
 468
 469   }
 470
 471   private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
 472       BlockNode bn, CompositeLocation constraint) {
 473
 474     bn.getVarTable().setParent(nametable);
 475     for (int i = 0; i < bn.size(); i++) {
 476       BlockStatementNode bsn = bn.get(i);
 477       checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn, constraint);
 478     }
 479     return new CompositeLocation();
 480
 481   }
 482
 483   private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
 484       SymbolTable nametable, BlockStatementNode bsn, CompositeLocation constraint) {
 485
 486     CompositeLocation compLoc = null;
 487     switch (bsn.kind()) {
 488     case Kind.BlockExpressionNode:
 489       compLoc =
 490           checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, constraint);
 491       break;
 492
 493     case Kind.DeclarationNode:
 494       compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn, constraint);
 495       break;
 496
 497     case Kind.IfStatementNode:
 498       compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn, constraint);
 499       break;
 500
 501     case Kind.LoopNode:
 502       compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn, constraint);
 503       break;
 504
 505     case Kind.ReturnNode:
 506       compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn, constraint);
 507       break;
 508
 509     case Kind.SubBlockNode:
 510       compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn, constraint);
 511       break;
 512
 513     case Kind.ContinueBreakNode:
 514       compLoc = new CompositeLocation();
 515       break;
 516
 517     case Kind.SwitchStatementNode:
 518       compLoc =
 519           checkLocationFromSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, constraint);
 520
 521     }
 522     return compLoc;
 523   }
 524
 525   private CompositeLocation checkLocationFromSwitchStatementNode(MethodDescriptor md,
 526       SymbolTable nametable, SwitchStatementNode ssn, CompositeLocation constraint) {
 527
 528     ClassDescriptor cd = md.getClassDesc();
 529     CompositeLocation condLoc =
 530         checkLocationFromExpressionNode(md, nametable, ssn.getCondition(), new CompositeLocation(),
 531             constraint, false);
 532     BlockNode sbn = ssn.getSwitchBody();
 533
 534     constraint = generateNewConstraint(constraint, condLoc);
 535
 536     for (int i = 0; i < sbn.size(); i++) {
 537       checkLocationFromSwitchBlockNode(md, nametable, (SwitchBlockNode) sbn.get(i), constraint);
 538     }
 539     return new CompositeLocation();
 540   }
 541
 542   private CompositeLocation checkLocationFromSwitchBlockNode(MethodDescriptor md,
 543       SymbolTable nametable, SwitchBlockNode sbn, CompositeLocation constraint) {
 544
 545     CompositeLocation blockLoc =
 546         checkLocationFromBlockNode(md, nametable, sbn.getSwitchBlockStatement(), constraint);
 547
 548     return blockLoc;
 549
 550   }
 551
 552   private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
 553       ReturnNode rn, CompositeLocation constraint) {
 554
 555     if (ssjava.getMethodContainingSSJavaLoop().equals(md)) {
 556       return new CompositeLocation();
 557     }
 558
 559     ExpressionNode returnExp = rn.getReturnExpression();
 560
 561     CompositeLocation declaredReturnLoc = md2ReturnLoc.get(md);
 562
 563     CompositeLocation returnValueLoc;
 564     if (returnExp != null) {
 565       returnValueLoc =
 566           checkLocationFromExpressionNode(md, nametable, returnExp, new CompositeLocation(),
 567               constraint, false);
 568
 569       // System.out.println("# RETURN VALUE LOC=" + returnValueLoc +
 570       // " with constraint=" + constraint);
 571
 572       // TODO: do we need to check here?
 573       // if this return statement is inside branch, return value has an implicit
 574       // flow from conditional location
 575       // if (constraint != null) {
 576       // Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
 577       // inputGLB.add(returnValueLoc);
 578       // inputGLB.add(constraint);
 579       // returnValueLoc =
 580       // CompositeLattice.calculateGLB(inputGLB,
 581       // generateErrorMessage(md.getClassDesc(), rn));
 582       // }
 583
 584       if (constraint != null) {
 585
 586         // Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
 587         // inputGLB.add(returnValueLoc);
 588         // inputGLB.add(constraint);
 589         // returnValueLoc =
 590         // CompositeLattice.calculateGLB(inputGLB,
 591         // generateErrorMessage(md.getClassDesc(), rn));
 592
 593         // if (!returnValueLoc.get(returnValueLoc.getSize() - 1).isTop()) {
 594         // if (!CompositeLattice.isGreaterThan(constraint, returnValueLoc,
 595         // generateErrorMessage(md.getClassDesc(), rn))) {
 596         // System.out.println("returnValueLoc.get(returnValueLoc.getSize() - 1).isTop()="
 597         // + returnValueLoc.get(returnValueLoc.getSize() - 1).isTop());
 598         // throw new Error("The value flow from " + constraint + " to " +
 599         // returnValueLoc
 600         // + " does not respect location hierarchy on the assignment " +
 601         // rn.printNode(0)
 602         // + " at " + md.getClassDesc().getSourceFileName() + "::" +
 603         // rn.getNumLine());
 604         // }
 605         // }
 606
 607         if (!CompositeLattice.isGreaterThan(constraint, declaredReturnLoc,
 608             generateErrorMessage(md.getClassDesc(), rn))) {
 609           throw new Error("The value flow from " + constraint + " to " + declaredReturnLoc
 610               + " does not respect location hierarchy on the assignment " + rn.printNode(0)
 611               + " at " + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
 612         }
 613
 614       }
 615
 616       // check if return value is equal or higher than RETRUNLOC of method
 617       // declaration annotation
 618
 619       int compareResult =
 620           CompositeLattice.compare(returnValueLoc, declaredReturnLoc, false,
 621               generateErrorMessage(md.getClassDesc(), rn));
 622
 623       if (compareResult == ComparisonResult.LESS || compareResult == ComparisonResult.INCOMPARABLE) {
 624         throw new Error(
 625             "Return value location is not equal or higher than the declaraed return location at "
 626                 + md.getClassDesc().getSourceFileName() + "::" + rn.getNumLine());
 627       }
 628     }
 629
 630     return new CompositeLocation();
 631   }
 632
 633   private boolean hasOnlyLiteralValue(ExpressionNode en) {
 634     if (en.kind() == Kind.LiteralNode) {
 635       return true;
 636     } else {
 637       return false;
 638     }
 639   }
 640
 641   private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
 642       LoopNode ln, CompositeLocation constraint) {
 643
 644     ClassDescriptor cd = md.getClassDesc();
 645     if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
 646
 647       CompositeLocation condLoc =
 648           checkLocationFromExpressionNode(md, nametable, ln.getCondition(),
 649               new CompositeLocation(), constraint, false);
 650       // addLocationType(ln.getCondition().getType(), (condLoc));
 651
 652       constraint = generateNewConstraint(constraint, condLoc);
 653       checkLocationFromBlockNode(md, nametable, ln.getBody(), constraint);
 654
 655       return new CompositeLocation();
 656
 657     } else {
 658       // check 'for loop' case
 659       BlockNode bn = ln.getInitializer();
 660       bn.getVarTable().setParent(nametable);
 661       // need to check initialization node
 662       // checkLocationFromBlockNode(md, bn.getVarTable(), bn, constraint);
 663       for (int i = 0; i < bn.size(); i++) {
 664         BlockStatementNode bsn = bn.get(i);
 665         checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn, constraint);
 666       }
 667
 668       // calculate glb location of condition and update statements
 669       CompositeLocation condLoc =
 670           checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
 671               new CompositeLocation(), constraint, false);
 672       // addLocationType(ln.getCondition().getType(), condLoc);
 673
 674       constraint = generateNewConstraint(constraint, condLoc);
 675
 676       checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate(), constraint);
 677       checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody(), constraint);
 678
 679       return new CompositeLocation();
 680
 681     }
 682
 683   }
 684
 685   private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
 686       SymbolTable nametable, SubBlockNode sbn, CompositeLocation constraint) {
 687     CompositeLocation compLoc =
 688         checkLocationFromBlockNode(md, nametable, sbn.getBlockNode(), constraint);
 689     return compLoc;
 690   }
 691
 692   private CompositeLocation generateNewConstraint(CompositeLocation currentCon,
 693       CompositeLocation newCon) {
 694
 695     if (currentCon == null) {
 696       return newCon;
 697     } else {
 698       // compute GLB of current constraint and new constraint
 699       Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
 700       inputSet.add(currentCon);
 701       inputSet.add(newCon);
 702       return CompositeLattice.calculateGLB(inputSet, "");
 703     }
 704
 705   }
 706
 707   private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
 708       SymbolTable nametable, IfStatementNode isn, CompositeLocation constraint) {
 709
 710     System.out.println("\n\ncheckLocationFromIfStatementNode=" + isn.printNode(0));
 711     CompositeLocation condLoc =
 712         checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation(),
 713             constraint, false);
 714
 715     System.out.println("-######old constraint=" + constraint);
 716     constraint = generateNewConstraint(constraint, condLoc);
 717     System.out.println("-######new constraint=" + constraint);
 718     checkLocationFromBlockNode(md, nametable, isn.getTrueBlock(), constraint);
 719
 720     if (isn.getFalseBlock() != null) {
 721       checkLocationFromBlockNode(md, nametable, isn.getFalseBlock(), constraint);
 722     }
 723
 724     return new CompositeLocation();
 725   }
 726
 727   private void checkOwnership(MethodDescriptor md, TreeNode tn, ExpressionNode srcExpNode) {
 728
 729     if (srcExpNode.kind() == Kind.NameNode || srcExpNode.kind() == Kind.FieldAccessNode) {
 730       if (srcExpNode.getType().isPtr() && !srcExpNode.getType().isNull()) {
 731         // first, check the linear type
 732         // RHS reference should be owned by the current method
 733         FieldDescriptor fd = getFieldDescriptorFromExpressionNode(srcExpNode);
 734         boolean isOwned;
 735         if (fd == null) {
 736           // local var case
 737           isOwned = ((SSJavaType) srcExpNode.getType().getExtension()).isOwned();
 738         } else {
 739           // field case
 740           isOwned = ssjava.isOwnedByMethod(md, fd);
 741         }
 742         if (!isOwned) {
 743           throw new Error(
 744               "It is not allowed to create the reference alias from the reference not owned by the method at "
 745                   + generateErrorMessage(md.getClassDesc(), tn));
 746         }
 747
 748       }
 749     }
 750
 751   }
 752
 753   private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
 754       SymbolTable nametable, DeclarationNode dn, CompositeLocation constraint) {
 755
 756     VarDescriptor vd = dn.getVarDescriptor();
 757
 758     CompositeLocation destLoc = d2loc.get(vd);
 759
 760     if (dn.getExpression() != null) {
 761
 762       checkOwnership(md, dn, dn.getExpression());
 763
 764       CompositeLocation expressionLoc =
 765           checkLocationFromExpressionNode(md, nametable, dn.getExpression(),
 766               new CompositeLocation(), constraint, false);
 767       // addTypeLocation(dn.getExpression().getType(), expressionLoc);
 768
 769       if (expressionLoc != null) {
 770
 771         // checking location order
 772         if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc,
 773             generateErrorMessage(md.getClassDesc(), dn))) {
 774           throw new Error("The value flow from " + expressionLoc + " to " + destLoc
 775               + " does not respect location hierarchy on the assignment " + dn.printNode(0)
 776               + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
 777         }
 778       }
 779       return expressionLoc;
 780
 781     } else {
 782
 783       return new CompositeLocation();
 784
 785     }
 786
 787   }
 788
 789   private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
 790       SubBlockNode sbn) {
 791     checkDeclarationInBlockNode(md, nametable, sbn.getBlockNode());
 792   }
 793
 794   private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
 795       SymbolTable nametable, BlockExpressionNode ben, CompositeLocation constraint) {
 796
 797     CompositeLocation compLoc =
 798         checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null, constraint, false);
 799     // addTypeLocation(ben.getExpression().getType(), compLoc);
 800     return compLoc;
 801   }
 802
 803   private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
 804       SymbolTable nametable, ExpressionNode en, CompositeLocation loc,
 805       CompositeLocation constraint, boolean isLHS) {
 806
 807     CompositeLocation compLoc = null;
 808     switch (en.kind()) {
 809
 810     case Kind.AssignmentNode:
 811       compLoc =
 812           checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc, constraint);
 813       break;
 814
 815     case Kind.FieldAccessNode:
 816       compLoc =
 817           checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc, constraint);
 818       break;
 819
 820     case Kind.NameNode:
 821       compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc, constraint);
 822       break;
 823
 824     case Kind.OpNode:
 825       compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en, constraint);
 826       break;
 827
 828     case Kind.CreateObjectNode:
 829       compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
 830       break;
 831
 832     case Kind.ArrayAccessNode:
 833       compLoc =
 834           checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en, constraint, isLHS);
 835       break;
 836
 837     case Kind.LiteralNode:
 838       compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
 839       break;
 840
 841     case Kind.MethodInvokeNode:
 842       compLoc =
 843           checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en, loc, constraint);
 844       break;
 845
 846     case Kind.TertiaryNode:
 847       compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en, constraint);
 848       break;
 849
 850     case Kind.CastNode:
 851       compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en, constraint);
 852       break;
 853
 854     // case Kind.InstanceOfNode:
 855     // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
 856     // return null;
 857
 858     // case Kind.ArrayInitializerNode:
 859     // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
 860     // td);
 861     // return null;
 862
 863     // case Kind.ClassTypeNode:
 864     // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
 865     // return null;
 866
 867     // case Kind.OffsetNode:
 868     // checkOffsetNode(md, nametable, (OffsetNode)en, td);
 869     // return null;
 870
 871     default:
 872       return null;
 873
 874     }
 875     // addTypeLocation(en.getType(), compLoc);
 876     return compLoc;
 877
 878   }
 879
 880   private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
 881       CastNode cn, CompositeLocation constraint) {
 882
 883     ExpressionNode en = cn.getExpression();
 884     return checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
 885         false);
 886
 887   }
 888
 889   private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
 890       SymbolTable nametable, TertiaryNode tn, CompositeLocation constraint) {
 891     ClassDescriptor cd = md.getClassDesc();
 892
 893     CompositeLocation condLoc =
 894         checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation(),
 895             constraint, false);
 896     // addLocationType(tn.getCond().getType(), condLoc);
 897     CompositeLocation trueLoc =
 898         checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation(),
 899             constraint, false);
 900     // addLocationType(tn.getTrueExpr().getType(), trueLoc);
 901     CompositeLocation falseLoc =
 902         checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation(),
 903             constraint, false);
 904     // addLocationType(tn.getFalseExpr().getType(), falseLoc);
 905
 906     // locations from true/false branches can be TOP when there are only literal
 907     // values
 908     // in this case, we don't need to check flow down rule!
 909
 910     // System.out.println("\n#tertiary cond=" + tn.getCond().printNode(0) +
 911     // " Loc=" + condLoc);
 912     // System.out.println("# true=" + tn.getTrueExpr().printNode(0) + " Loc=" +
 913     // trueLoc);
 914     // System.out.println("# false=" + tn.getFalseExpr().printNode(0) + " Loc="
 915     // + falseLoc);
 916
 917     // we don't need to check that condLoc is higher than trueLoc & falseLoc
 918     // if (!trueLoc.get(0).isTop()
 919     // && !CompositeLattice.isGreaterThan(condLoc, trueLoc, generateErrorMessage(cd, tn))) {
 920     // throw new Error(
 921     // "The location of the condition expression is lower than the true expression at "
 922     // + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
 923     // }
 924     //
 925     // if (!falseLoc.get(0).isTop()
 926     // && !CompositeLattice.isGreaterThan(condLoc, falseLoc,
 927     // generateErrorMessage(cd, tn.getCond()))) {
 928     // throw new Error(
 929     // "The location of the condition expression is lower than the false expression at "
 930     // + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
 931     // }
 932
 933     // then, return glb of trueLoc & falseLoc
 934     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 935     glbInputSet.add(condLoc);
 936     glbInputSet.add(trueLoc);
 937     glbInputSet.add(falseLoc);
 938
 939     if (glbInputSet.size() == 1) {
 940       return trueLoc;
 941     } else {
 942       return CompositeLattice.calculateGLB(glbInputSet, generateErrorMessage(cd, tn));
 943     }
 944
 945   }
 946
 947   private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
 948       SymbolTable nametable, MethodInvokeNode min, CompositeLocation loc,
 949       CompositeLocation constraint) {
 950
 951     ClassDescriptor cd = md.getClassDesc();
 952     MethodDescriptor calleeMethodDesc = min.getMethod();
 953
 954     NameDescriptor baseName = min.getBaseName();
 955     boolean isSystemout = false;
 956     if (baseName != null) {
 957       isSystemout = baseName.getSymbol().equals("System.out");
 958     }
 959
 960     if (!ssjava.isSSJavaUtil(calleeMethodDesc.getClassDesc())
 961         && !ssjava.isTrustMethod(calleeMethodDesc) && !calleeMethodDesc.getModifiers().isNative()
 962         && !isSystemout) {
 963
 964       CompositeLocation baseLocation = null;
 965       if (min.getExpression() != null) {
 966         baseLocation =
 967             checkLocationFromExpressionNode(md, nametable, min.getExpression(),
 968                 new CompositeLocation(), constraint, false);
 969       } else {
 970         if (min.getMethod().isStatic()) {
 971           String globalLocId = ssjava.getMethodLattice(md).getGlobalLoc();
 972           if (globalLocId == null) {
 973             throw new Error("Method lattice does not define global variable location at "
 974                 + generateErrorMessage(md.getClassDesc(), min));
 975           }
 976           baseLocation = new CompositeLocation(new Location(md, globalLocId));
 977         } else {
 978           String thisLocId = ssjava.getMethodLattice(md).getThisLoc();
 979           baseLocation = new CompositeLocation(new Location(md, thisLocId));
 980         }
 981       }
 982
 983       // System.out.println("\n#checkLocationFromMethodInvokeNode=" +
 984       // min.printNode(0)
 985       // + " baseLocation=" + baseLocation + " constraint=" + constraint);
 986
 987       // setup the location list of caller's arguments
 988       List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
 989
 990       // setup the location list of callee's parameters
 991       MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleeMethodDesc);
 992       List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
 993
 994       if (min.numArgs() > 0) {
 995         if (!calleeMethodDesc.isStatic()) {
 996           callerArgList.add(baseLocation);
 997         }
 998         for (int i = 0; i < min.numArgs(); i++) {
 999           ExpressionNode en = min.getArg(i);
1000           CompositeLocation callerArgLoc =
1001               checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(),
1002                   constraint, false);
1003           callerArgList.add(callerArgLoc);
1004         }
1005
1006         if (!calleeMethodDesc.isStatic()) {
1007           CompositeLocation calleeThisLoc =
1008               new CompositeLocation(new Location(calleeMethodDesc, calleeLattice.getThisLoc()));
1009           calleeParamList.add(calleeThisLoc);
1010         }
1011
1012         for (int i = 0; i < calleeMethodDesc.numParameters(); i++) {
1013           VarDescriptor calleevd = (VarDescriptor) calleeMethodDesc.getParameter(i);
1014           CompositeLocation calleeLoc = d2loc.get(calleevd);
1015           calleeParamList.add(calleeLoc);
1016         }
1017       }
1018
1019       if (constraint != null) {
1020         // check whether the PC location is lower than one of the
1021         // argument locations. If it is lower, the callee has to have @PCLOC
1022         // annotation that declares the program counter that is higher than
1023         // corresponding parameter
1024
1025         CompositeLocation calleePCLOC = ssjava.getPCLocation(calleeMethodDesc);
1026
1027         for (int idx = 0; idx < callerArgList.size(); idx++) {
1028           CompositeLocation argLocation = callerArgList.get(idx);
1029
1030           // if the PC location is lower than an argument location
1031           // then, need to check that the callee's the initial location for the PC is also lower
1032           // than the corresponding parameter location
1033
1034           if (!argLocation.get(0).isTop()
1035               && CompositeLattice.compare(argLocation, constraint, true,
1036                   generateErrorMessage(cd, min)) == ComparisonResult.GREATER) {
1037
1038             CompositeLocation paramLocation = calleeParamList.get(idx);
1039
1040             int paramCompareResult =
1041                 CompositeLattice.compare(paramLocation, calleePCLOC, true,
1042                     generateErrorMessage(cd, min));
1043             // CompositeLattice.compare(calleePCLOC, paramLocation, true,
1044             // generateErrorMessage(cd, min));
1045
1046             System.out.println("-CHECKPCLOC:");
1047             System.out.println("---ARG LOC="
1048                 + argLocation
1049                 + " callerPCLOC="
1050                 + constraint
1051                 + " result="
1052                 + CompositeLattice.compare(argLocation, constraint, true,
1053                     generateErrorMessage(cd, min)));
1054             System.out.println("---PARAM LOC=" + paramLocation + " calleePCLOC=" + calleePCLOC
1055                 + " paramCompareResult=" + paramCompareResult);
1056
1057             if (!(paramLocation.get(0).equals(calleePCLOC.get(0)) && calleePCLOC.getSize() > 1)
1058                 && paramCompareResult == ComparisonResult.LESS) {
1059               throw new Error(
1060                   "The argument(idx="
1061                       + idx
1062                       + ") location "
1063                       + argLocation
1064                       + "is higher than the caller program counter location "
1065                       + constraint
1066                       + ". Need to specify that the initial PC location of the callee, which is currently set to "
1067                       + calleePCLOC + ", is not higher than " + paramLocation + " in the method "
1068                       + calleeMethodDesc.getSymbol() + ":" + min.getNumLine());
1069             }
1070
1071           }
1072
1073         }
1074
1075       }
1076
1077       checkCalleeConstraints(md, nametable, min, baseLocation, constraint);
1078
1079       checkCallerArgumentLocationConstraints(md, nametable, min, baseLocation, constraint);
1080
1081       if (!min.getMethod().getReturnType().isVoid()) {
1082         // If method has a return value, compute the highest possible return
1083         // location in the caller's perspective
1084         CompositeLocation ceilingLoc =
1085             computeCeilingLocationForCaller(md, nametable, min, baseLocation, constraint);
1086
1087         if (ceilingLoc == null) {
1088           return new CompositeLocation(Location.createTopLocation(md));
1089         }
1090         return ceilingLoc;
1091       }
1092     }
1093
1094     return new CompositeLocation(Location.createTopLocation(md));
1095
1096   }
1097
1098   private CompositeLocation translateCallerLocToCalleeLoc(MethodDescriptor calleeMD,
1099       CompositeLocation calleeBaseLoc, CompositeLocation constraint) {
1100
1101     CompositeLocation calleeConstraint = new CompositeLocation();
1102
1103     // if (constraint.startsWith(calleeBaseLoc)) {
1104     // if the first part of constraint loc is matched with callee base loc
1105     Location thisLoc = new Location(calleeMD, ssjava.getMethodLattice(calleeMD).getThisLoc());
1106     calleeConstraint.addLocation(thisLoc);
1107     for (int i = calleeBaseLoc.getSize(); i < constraint.getSize(); i++) {
1108       calleeConstraint.addLocation(constraint.get(i));
1109     }
1110
1111     // }
1112
1113     return calleeConstraint;
1114   }
1115
1116   private void checkCallerArgumentLocationConstraints(MethodDescriptor md, SymbolTable nametable,
1117       MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
1118     // if parameter location consists of THIS and FIELD location,
1119     // caller should pass an argument that is comparable to the declared
1120     // parameter location
1121     // and is not lower than the declared parameter location in the field
1122     // lattice.
1123
1124     MethodDescriptor calleemd = min.getMethod();
1125
1126     if (calleemd.isStatic()) {
1127       return;
1128     }
1129
1130     List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
1131     List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
1132
1133     MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
1134     Location calleeThisLoc = new Location(calleemd, calleeLattice.getThisLoc());
1135
1136     for (int i = 0; i < min.numArgs(); i++) {
1137       ExpressionNode en = min.getArg(i);
1138       CompositeLocation callerArgLoc =
1139           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1140               false);
1141       callerArgList.add(callerArgLoc);
1142     }
1143
1144     // setup callee params set
1145     for (int i = 0; i < calleemd.numParameters(); i++) {
1146       VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
1147       CompositeLocation calleeLoc = d2loc.get(calleevd);
1148       calleeParamList.add(calleeLoc);
1149     }
1150
1151     String errorMsg = generateErrorMessage(md.getClassDesc(), min);
1152
1153     // System.out.println("checkCallerArgumentLocationConstraints=" +
1154     // min.printNode(0));
1155     // System.out.println("base location=" + callerBaseLoc + " constraint=" +
1156     // constraint);
1157
1158     System.out.println("calleeParamList=" + calleeParamList);
1159     int offset = 0;
1160     if (!md.isStatic()) {
1161       offset = 1;
1162     }
1163     for (int i = offset; i < calleeParamList.size(); i++) {
1164       CompositeLocation calleeParamLoc = calleeParamList.get(i);
1165       if (calleeParamLoc.get(0).equals(calleeThisLoc) && calleeParamLoc.getSize() > 1) {
1166
1167         // callee parameter location has field information
1168         CompositeLocation callerArgLoc = callerArgList.get(i);
1169
1170         CompositeLocation paramLocation =
1171             translateCalleeParamLocToCaller(md, calleeParamLoc, callerBaseLoc, errorMsg);
1172
1173         Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1174         if (constraint != null) {
1175           inputGLBSet.add(callerArgLoc);
1176           inputGLBSet.add(constraint);
1177           callerArgLoc =
1178               CompositeLattice.calculateGLB(inputGLBSet,
1179                   generateErrorMessage(md.getClassDesc(), min));
1180         }
1181
1182         Location argLastLoc = callerArgLoc.get(callerArgLoc.getSize() - 1);
1183         Location paramLastLoc = paramLocation.get(paramLocation.getSize() - 1);
1184
1185         if (argLastLoc.equals(paramLastLoc) && ssjava.isSharedLocation(argLastLoc)
1186             && ssjava.isSharedLocation(paramLastLoc)) {
1187           continue;
1188         }
1189
1190         System.out.println("---idx=" + i + "  callerArgLoc=" + callerArgLoc + "   paramLocation="
1191             + paramLocation);
1192         // if (!CompositeLattice.isGreaterThan(callerArgLoc, paramLocation, errorMsg)) {
1193         if (CompositeLattice.compare(callerArgLoc, paramLocation, true, errorMsg) == ComparisonResult.LESS) {
1194           throw new Error("Caller argument '" + min.getArg(i).printNode(0) + " : " + callerArgLoc
1195               + "' should be higher than corresponding callee's parameter : " + paramLocation
1196               + " at " + errorMsg);
1197         }
1198
1199       }
1200     }
1201
1202   }
1203
1204   private CompositeLocation translateCalleeParamLocToCaller(MethodDescriptor md,
1205       CompositeLocation calleeParamLoc, CompositeLocation callerBaseLocation, String errorMsg) {
1206
1207     CompositeLocation translate = new CompositeLocation();
1208
1209     for (int i = 0; i < callerBaseLocation.getSize(); i++) {
1210       translate.addLocation(callerBaseLocation.get(i));
1211     }
1212
1213     for (int i = 1; i < calleeParamLoc.getSize(); i++) {
1214       translate.addLocation(calleeParamLoc.get(i));
1215     }
1216
1217     // System.out.println("TRANSLATED=" + translate + " from calleeParamLoc=" +
1218     // calleeParamLoc);
1219
1220     return translate;
1221   }
1222
1223   private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
1224       SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation,
1225       CompositeLocation constraint) {
1226     List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
1227
1228     // by default, method has a THIS parameter
1229     if (!min.getMethod().isStatic()) {
1230       argList.add(baseLocation);
1231     }
1232
1233     for (int i = 0; i < min.numArgs(); i++) {
1234       ExpressionNode en = min.getArg(i);
1235       CompositeLocation callerArg =
1236           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1237               false);
1238       argList.add(callerArg);
1239     }
1240
1241     // System.out.println("\n## computeReturnLocation=" + min.getMethod() + " argList=" + argList);
1242     CompositeLocation ceilLoc = md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
1243     // System.out.println("## ReturnLocation=" + ceilLoc);
1244
1245     return ceilLoc;
1246
1247   }
1248
1249   private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
1250       MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
1251
1252     MethodDescriptor calleemd = min.getMethod();
1253
1254     MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
1255
1256     System.out.println("checkCalleeConstraints=" + calleemd + " calleeLattice.getThisLoc()="
1257         + calleeLattice.getThisLoc());
1258
1259     List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
1260     List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
1261
1262     if (min.numArgs() > 0) {
1263       // caller needs to guarantee that it passes arguments in regarding to
1264       // callee's hierarchy
1265
1266       // setup caller args set
1267       // first, add caller's base(this) location
1268       if (!calleemd.isStatic())
1269         callerArgList.add(callerBaseLoc);
1270       // second, add caller's arguments
1271       for (int i = 0; i < min.numArgs(); i++) {
1272         ExpressionNode en = min.getArg(i);
1273         CompositeLocation callerArgLoc =
1274             checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1275                 false);
1276         callerArgList.add(callerArgLoc);
1277       }
1278
1279       // setup callee params set
1280       // first, add callee's this location
1281       if (!calleemd.isStatic()) {
1282         CompositeLocation calleeThisLoc =
1283             new CompositeLocation(new Location(calleemd, calleeLattice.getThisLoc()));
1284         calleeParamList.add(calleeThisLoc);
1285       }
1286       // second, add callee's parameters
1287       for (int i = 0; i < calleemd.numParameters(); i++) {
1288         VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
1289         CompositeLocation calleeLoc = d2loc.get(calleevd);
1290         // System.out.println("calleevd=" + calleevd + " loc=" + calleeLoc);
1291         calleeParamList.add(calleeLoc);
1292       }
1293
1294       // here, check if ordering relations among caller's args respect
1295       // ordering relations in-between callee's args
1296       CHECK: for (int i = 0; i < calleeParamList.size(); i++) {
1297         CompositeLocation calleeLoc1 = calleeParamList.get(i);
1298         CompositeLocation callerLoc1 = callerArgList.get(i);
1299
1300         for (int j = 0; j < calleeParamList.size(); j++) {
1301           if (i != j) {
1302             CompositeLocation calleeLoc2 = calleeParamList.get(j);
1303             CompositeLocation callerLoc2 = callerArgList.get(j);
1304
1305             if (callerLoc1.get(callerLoc1.getSize() - 1).isTop()
1306                 || callerLoc2.get(callerLoc2.getSize() - 1).isTop()) {
1307               continue CHECK;
1308             }
1309
1310             // System.out.println("calleeLoc1=" + calleeLoc1);
1311             // System.out.println("calleeLoc2=" + calleeLoc2 +
1312             // "calleeParamList=" + calleeParamList);
1313
1314             int callerResult =
1315                 CompositeLattice.compare(callerLoc1, callerLoc2, true,
1316                     generateErrorMessage(md.getClassDesc(), min));
1317             // System.out.println("callerResult=" + callerResult);
1318             int calleeResult =
1319                 CompositeLattice.compare(calleeLoc1, calleeLoc2, true,
1320                     generateErrorMessage(md.getClassDesc(), min));
1321             // System.out.println("calleeResult=" + calleeResult);
1322
1323             if (callerResult == ComparisonResult.EQUAL) {
1324               if (ssjava.isSharedLocation(callerLoc1.get(callerLoc1.getSize() - 1))
1325                   && ssjava.isSharedLocation(callerLoc2.get(callerLoc2.getSize() - 1))) {
1326                 // if both of them are shared locations, promote them to
1327                 // "GREATER relation"
1328                 callerResult = ComparisonResult.GREATER;
1329               }
1330             }
1331
1332             if (calleeResult == ComparisonResult.GREATER
1333                 && callerResult != ComparisonResult.GREATER) {
1334               // If calleeLoc1 is higher than calleeLoc2
1335               // then, caller should have same ordering relation in-bet
1336               // callerLoc1 & callerLoc2
1337
1338               String paramName1, paramName2;
1339
1340               if (!calleemd.isStatic()) {
1341                 if (i == 0) {
1342                   paramName1 = "'THIS'";
1343                 } else {
1344                   paramName1 = "'parameter " + calleemd.getParamName(i - 1) + "'";
1345                 }
1346               } else {
1347                 paramName1 = "'parameter " + calleemd.getParamName(i) + "'";
1348               }
1349
1350               if (!calleemd.isStatic()) {
1351                 if (j == 0 && !calleemd.isStatic()) {
1352                   paramName2 = "'THIS'";
1353                 } else {
1354                   paramName2 = "'parameter " + calleemd.getParamName(j - 1) + "'";
1355                 }
1356               } else {
1357                 paramName2 = "'parameter " + calleemd.getParamName(j) + "'";
1358               }
1359
1360               throw new Error(
1361                   "Caller doesn't respect an ordering relation among method arguments: callee expects that "
1362                       + paramName1 + " should be higher than " + paramName2 + " in " + calleemd
1363                       + " at " + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
1364             }
1365           }
1366
1367         }
1368       }
1369
1370     }
1371
1372   }
1373
1374   private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
1375       SymbolTable nametable, ArrayAccessNode aan, CompositeLocation constraint, boolean isLHS) {
1376     System.out.println("aan=" + aan.printNode(0) + "  line#=" + aan.getNumLine());
1377     ClassDescriptor cd = md.getClassDesc();
1378     System.out.println("aan.getExpression()=" + aan.getExpression().getClass());
1379     CompositeLocation arrayLoc =
1380         checkLocationFromExpressionNode(md, nametable, aan.getExpression(),
1381             new CompositeLocation(), constraint, isLHS);
1382     System.out.println("HERE?");
1383     // addTypeLocation(aan.getExpression().getType(), arrayLoc);
1384     CompositeLocation indexLoc =
1385         checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(),
1386             constraint, isLHS);
1387     // addTypeLocation(aan.getIndex().getType(), indexLoc);
1388     System.out.println("HERE2?");
1389
1390     if (isLHS) {
1391       if (!CompositeLattice.isGreaterThan(indexLoc, arrayLoc, generateErrorMessage(cd, aan))) {
1392         throw new Error("Array index value is not higher than array location at "
1393             + generateErrorMessage(cd, aan));
1394       }
1395       return arrayLoc;
1396     } else {
1397       Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1398       inputGLB.add(arrayLoc);
1399       inputGLB.add(indexLoc);
1400       System.out.println("arrayLoc=" + arrayLoc + "   indexLoc=" + indexLoc);
1401       CompositeLocation comp =
1402           CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(cd, aan));
1403       System.out.println("---aan=" + aan.printNode(0) + "  compLoc=" + comp);
1404       return comp;
1405     }
1406
1407   }
1408
1409   private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
1410       SymbolTable nametable, CreateObjectNode con) {
1411
1412     ClassDescriptor cd = md.getClassDesc();
1413
1414     CompositeLocation compLoc = new CompositeLocation();
1415     compLoc.addLocation(Location.createTopLocation(md));
1416     return compLoc;
1417
1418   }
1419
1420   private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
1421       OpNode on, CompositeLocation constraint) {
1422
1423     ClassDescriptor cd = md.getClassDesc();
1424     CompositeLocation leftLoc = new CompositeLocation();
1425     leftLoc =
1426         checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc, constraint, false);
1427     // addTypeLocation(on.getLeft().getType(), leftLoc);
1428
1429     CompositeLocation rightLoc = new CompositeLocation();
1430     if (on.getRight() != null) {
1431       rightLoc =
1432           checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc, constraint, false);
1433       // addTypeLocation(on.getRight().getType(), rightLoc);
1434     }
1435
1436     // System.out.println("# left loc=" + leftLoc + " from " + on.getLeft().getClass());
1437     // if (on.getRight() != null) {
1438     // System.out.println("# right loc=" + rightLoc + " from " + on.getRight().getClass());
1439     // }
1440
1441     Operation op = on.getOp();
1442
1443     switch (op.getOp()) {
1444
1445     case Operation.UNARYPLUS:
1446     case Operation.UNARYMINUS:
1447     case Operation.LOGIC_NOT:
1448       // single operand
1449       return leftLoc;
1450
1451     case Operation.LOGIC_OR:
1452     case Operation.LOGIC_AND:
1453     case Operation.COMP:
1454     case Operation.BIT_OR:
1455     case Operation.BIT_XOR:
1456     case Operation.BIT_AND:
1457     case Operation.ISAVAILABLE:
1458     case Operation.EQUAL:
1459     case Operation.NOTEQUAL:
1460     case Operation.LT:
1461     case Operation.GT:
1462     case Operation.LTE:
1463     case Operation.GTE:
1464     case Operation.ADD:
1465     case Operation.SUB:
1466     case Operation.MULT:
1467     case Operation.DIV:
1468     case Operation.MOD:
1469     case Operation.LEFTSHIFT:
1470     case Operation.RIGHTSHIFT:
1471     case Operation.URIGHTSHIFT:
1472
1473       Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
1474       inputSet.add(leftLoc);
1475       inputSet.add(rightLoc);
1476       CompositeLocation glbCompLoc =
1477           CompositeLattice.calculateGLB(inputSet, generateErrorMessage(cd, on));
1478       return glbCompLoc;
1479
1480     default:
1481       throw new Error(op.toString());
1482     }
1483
1484   }
1485
1486   private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
1487       SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
1488
1489     // literal value has the top location so that value can be flowed into any
1490     // location
1491     Location literalLoc = Location.createTopLocation(md);
1492     loc.addLocation(literalLoc);
1493     return loc;
1494
1495   }
1496
1497   private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
1498       NameNode nn, CompositeLocation loc, CompositeLocation constraint) {
1499
1500     // System.out.println("checkLocationFromNameNode nn=" + nn.printNode(0));
1501     NameDescriptor nd = nn.getName();
1502     if (nd.getBase() != null) {
1503       loc =
1504           checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc, constraint, false);
1505     } else {
1506       String varname = nd.toString();
1507       if (varname.equals("this")) {
1508         // 'this' itself!
1509         MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
1510         String thisLocId = methodLattice.getThisLoc();
1511         if (thisLocId == null) {
1512           throw new Error("The location for 'this' is not defined at "
1513               + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
1514         }
1515         Location locElement = new Location(md, thisLocId);
1516         loc.addLocation(locElement);
1517         return loc;
1518
1519       }
1520
1521       Descriptor d = (Descriptor) nametable.get(varname);
1522
1523       // CompositeLocation localLoc = null;
1524       if (d instanceof VarDescriptor) {
1525         VarDescriptor vd = (VarDescriptor) d;
1526         // localLoc = d2loc.get(vd);
1527         // the type of var descriptor has a composite location!
1528         loc = ((SSJavaType) vd.getType().getExtension()).getCompLoc().clone();
1529       } else if (d instanceof FieldDescriptor) {
1530         // the type of field descriptor has a location!
1531         FieldDescriptor fd = (FieldDescriptor) d;
1532         // System.out.println("fd=" + fd);
1533         if (fd.isStatic()) {
1534           if (fd.isFinal()) {
1535             // if it is 'static final', the location has TOP since no one can
1536             // change its value
1537             loc.addLocation(Location.createTopLocation(md));
1538             return loc;
1539           } else {
1540
1541             // if 'static', the location has pre-assigned global loc
1542             MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1543             String globalLocId = localLattice.getGlobalLoc();
1544             if (globalLocId == null) {
1545               throw new Error("Global location element is not defined in the method " + md);
1546             }
1547             Location globalLoc = new Location(md, globalLocId);
1548             System.out.println("static=" + globalLoc);
1549             loc.addLocation(globalLoc);
1550           }
1551         } else {
1552           // the location of field access starts from this, followed by field
1553           // location
1554           MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1555           Location thisLoc = new Location(md, localLattice.getThisLoc());
1556           loc.addLocation(thisLoc);
1557         }
1558
1559         Location fieldLoc = (Location) fd.getType().getExtension();
1560         loc.addLocation(fieldLoc);
1561       } else if (d == null) {
1562         // access static field
1563         FieldDescriptor fd = nn.getField();
1564
1565         MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1566         String globalLocId = localLattice.getGlobalLoc();
1567         if (globalLocId == null) {
1568           throw new Error("Method lattice does not define global variable location at "
1569               + generateErrorMessage(md.getClassDesc(), nn));
1570         }
1571         loc.addLocation(new Location(md, globalLocId));
1572
1573         Location fieldLoc = (Location) fd.getType().getExtension();
1574         loc.addLocation(fieldLoc);
1575
1576         return loc;
1577
1578       }
1579     }
1580
1581     return loc;
1582   }
1583
1584   private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1585       SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc,
1586       CompositeLocation constraint) {
1587
1588     ExpressionNode left = fan.getExpression();
1589     TypeDescriptor ltd = left.getType();
1590
1591     FieldDescriptor fd = fan.getField();
1592
1593     String varName = null;
1594     if (left.kind() == Kind.NameNode) {
1595       NameDescriptor nd = ((NameNode) left).getName();
1596       varName = nd.toString();
1597     }
1598
1599     if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
1600       // using a class name directly or access using this
1601       if (fd.isStatic() && fd.isFinal()) {
1602         loc.addLocation(Location.createTopLocation(md));
1603         return loc;
1604       }
1605     }
1606
1607     Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1608     if (left instanceof ArrayAccessNode) {
1609       ArrayAccessNode aan = (ArrayAccessNode) left;
1610       CompositeLocation indexLoc =
1611           checkLocationFromExpressionNode(md, nametable, aan.getIndex(), loc, constraint, false);
1612       inputGLB.add(indexLoc);
1613     }
1614
1615     loc = checkLocationFromExpressionNode(md, nametable, left, loc, constraint, false);
1616
1617     if (!left.getType().isPrimitive()) {
1618
1619       if (!fd.getSymbol().equals("length")) {
1620         // array.length access, return the location of the array
1621         Location fieldLoc = getFieldLocation(fd);
1622         loc.addLocation(fieldLoc);
1623       }
1624
1625     }
1626
1627     inputGLB.add(loc);
1628     loc = CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(md.getClassDesc(), fan));
1629
1630     return loc;
1631   }
1632
1633   private Location getFieldLocation(FieldDescriptor fd) {
1634
1635     // System.out.println("### getFieldLocation=" + fd);
1636     // System.out.println("### fd.getType().getExtension()=" +
1637     // fd.getType().getExtension());
1638
1639     Location fieldLoc = (Location) fd.getType().getExtension();
1640
1641     // handle the case that method annotation checking skips checking field
1642     // declaration
1643     if (fieldLoc == null) {
1644       fieldLoc = checkFieldDeclaration(fd.getClassDescriptor(), fd);
1645     }
1646
1647     return fieldLoc;
1648
1649   }
1650
1651   private FieldDescriptor getFieldDescriptorFromExpressionNode(ExpressionNode en) {
1652
1653     if (en.kind() == Kind.NameNode) {
1654       NameNode nn = (NameNode) en;
1655       if (nn.getField() != null) {
1656         return nn.getField();
1657       }
1658
1659       if (nn.getName() != null && nn.getName().getBase() != null) {
1660         return getFieldDescriptorFromExpressionNode(nn.getExpression());
1661       }
1662
1663     } else if (en.kind() == Kind.FieldAccessNode) {
1664       FieldAccessNode fan = (FieldAccessNode) en;
1665       return fan.getField();
1666     }
1667
1668     return null;
1669   }
1670
1671   private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1672       SymbolTable nametable, AssignmentNode an, CompositeLocation loc, CompositeLocation constraint) {
1673
1674     System.out.println("\n\ncheckLocationFromAssignmentNode=" + an.printNode(0));
1675
1676     ClassDescriptor cd = md.getClassDesc();
1677
1678     Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1679
1680     boolean postinc = true;
1681     if (an.getOperation().getBaseOp() == null
1682         || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1683             .getBaseOp().getOp() != Operation.POSTDEC))
1684       postinc = false;
1685
1686     // if LHS is array access node, need to check if array index is higher
1687     // than array itself
1688     CompositeLocation destLocation =
1689         checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1690             constraint, true);
1691
1692     CompositeLocation rhsLocation;
1693     CompositeLocation srcLocation;
1694
1695     if (!postinc) {
1696
1697       checkOwnership(md, an, an.getSrc());
1698
1699       rhsLocation =
1700           checkLocationFromExpressionNode(md, nametable, an.getSrc(), new CompositeLocation(),
1701               constraint, false);
1702
1703       if (an.getOperation().getOp() >= 2 && an.getOperation().getOp() <= 12) {
1704         // if assignment contains OP+EQ operator, need to merge location types
1705         // of LHS & RHS into the RHS
1706         Set<CompositeLocation> srcGLBSet = new HashSet<CompositeLocation>();
1707         srcGLBSet.add(rhsLocation);
1708         srcGLBSet.add(destLocation);
1709         srcLocation = CompositeLattice.calculateGLB(srcGLBSet, generateErrorMessage(cd, an));
1710       } else {
1711         srcLocation = rhsLocation;
1712       }
1713
1714       if (constraint != null) {
1715
1716         if (!CompositeLattice.isGreaterThan(constraint, destLocation, generateErrorMessage(cd, an))) {
1717           throw new Error("The value flow from " + constraint + " to " + destLocation
1718               + " does not respect location hierarchy on the assignment " + an.printNode(0)
1719               + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1720         }
1721         // inputGLBSet.add(srcLocation);
1722         // inputGLBSet.add(constraint);
1723         // srcLocation = CompositeLattice.calculateGLB(inputGLBSet,
1724         // generateErrorMessage(cd, an));
1725       }
1726
1727       System.out.println("src=" + srcLocation + "  dest=" + destLocation + "  const=" + constraint);
1728
1729       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1730
1731         String context = "";
1732         if (constraint != null) {
1733           context = " and the current context constraint is " + constraint;
1734         }
1735
1736         throw new Error("The value flow from " + srcLocation + " to " + destLocation
1737             + " does not respect location hierarchy on the assignment " + an.printNode(0) + context
1738             + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1739       }
1740
1741       if (srcLocation.equals(destLocation)) {
1742         // keep it for definitely written analysis
1743         Set<FlatNode> flatNodeSet = ssjava.getBuildFlat().getFlatNodeSet(an);
1744         for (Iterator iterator = flatNodeSet.iterator(); iterator.hasNext();) {
1745           FlatNode fn = (FlatNode) iterator.next();
1746           ssjava.addSameHeightWriteFlatNode(fn);
1747         }
1748
1749       }
1750
1751     } else {
1752       destLocation =
1753           rhsLocation =
1754               checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1755                   constraint, false);
1756
1757       if (constraint != null) {
1758
1759         if (!CompositeLattice.isGreaterThan(constraint, destLocation, generateErrorMessage(cd, an))) {
1760           throw new Error("The value flow from " + constraint + " to " + destLocation
1761               + " does not respect location hierarchy on the assignment " + an.printNode(0)
1762               + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1763         }
1764         // inputGLBSet.add(rhsLocation);
1765         // inputGLBSet.add(constraint);
1766         // srcLocation = CompositeLattice.calculateGLB(inputGLBSet,
1767         // generateErrorMessage(cd, an));
1768         srcLocation = rhsLocation;
1769       } else {
1770         srcLocation = rhsLocation;
1771       }
1772
1773       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1774
1775         if (srcLocation.equals(destLocation)) {
1776           throw new Error("Location " + srcLocation
1777               + " is not allowed to have the value flow that moves within the same location at '"
1778               + an.printNode(0) + "' of " + cd.getSourceFileName() + "::" + an.getNumLine());
1779         } else {
1780           throw new Error("The value flow from " + srcLocation + " to " + destLocation
1781               + " does not respect location hierarchy on the assignment " + an.printNode(0)
1782               + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1783         }
1784
1785       }
1786
1787       if (srcLocation.equals(destLocation)) {
1788         // keep it for definitely written analysis
1789         Set<FlatNode> flatNodeSet = ssjava.getBuildFlat().getFlatNodeSet(an);
1790         for (Iterator iterator = flatNodeSet.iterator(); iterator.hasNext();) {
1791           FlatNode fn = (FlatNode) iterator.next();
1792           ssjava.addSameHeightWriteFlatNode(fn);
1793         }
1794       }
1795
1796     }
1797
1798     return destLocation;
1799   }
1800
1801   private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1802       SymbolTable nametable, TreeNode n) {
1803
1804     ClassDescriptor cd = md.getClassDesc();
1805     Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1806
1807     // currently enforce every variable to have corresponding location
1808     if (annotationVec.size() == 0) {
1809       throw new Error("Location is not assigned to variable '" + vd.getSymbol()
1810           + "' in the method '" + md + "' of the class " + cd.getSymbol() + " at "
1811           + generateErrorMessage(cd, n));
1812     }
1813
1814     int locDecCount = 0;
1815     for (int i = 0; i < annotationVec.size(); i++) {
1816       AnnotationDescriptor ad = annotationVec.elementAt(i);
1817
1818       if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1819
1820         if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1821           locDecCount++;
1822           if (locDecCount > 1) {// variable can have at most one location
1823             throw new Error(vd.getSymbol() + " has more than one location declaration.");
1824           }
1825           String locDec = ad.getValue(); // check if location is defined
1826
1827           if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1828             DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1829             d2loc.put(vd, deltaLoc);
1830             addLocationType(vd.getType(), deltaLoc);
1831           } else {
1832             CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1833
1834             Location lastElement = compLoc.get(compLoc.getSize() - 1);
1835             if (ssjava.isSharedLocation(lastElement)) {
1836               ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1837             }
1838
1839             d2loc.put(vd, compLoc);
1840             addLocationType(vd.getType(), compLoc);
1841           }
1842
1843         }
1844       }
1845     }
1846
1847   }
1848
1849   private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1850
1851     int deltaCount = 0;
1852     int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1853     while (dIdx >= 0) {
1854       deltaCount++;
1855       int beginIdx = dIdx + 6;
1856       locDec = locDec.substring(beginIdx, locDec.length() - 1);
1857       dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1858     }
1859
1860     CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1861     DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1862
1863     return deltaLoc;
1864   }
1865
1866   private Location parseFieldLocDeclaraton(String decl, String msg) throws Exception {
1867
1868     int idx = decl.indexOf(".");
1869
1870     String className = decl.substring(0, idx);
1871     String fieldName = decl.substring(idx + 1);
1872
1873     className.replaceAll(" ", "");
1874     fieldName.replaceAll(" ", "");
1875
1876     Descriptor d = state.getClassSymbolTable().get(className);
1877
1878     if (d == null) {
1879       // System.out.println("state.getClassSymbolTable()=" +
1880       // state.getClassSymbolTable());
1881       throw new Error("The class in the location declaration '" + decl + "' does not exist at "
1882           + msg);
1883     }
1884
1885     assert (d instanceof ClassDescriptor);
1886     SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1887     if (!lattice.containsKey(fieldName)) {
1888       throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1889           + className + "' at " + msg);
1890     }
1891
1892     return new Location(d, fieldName);
1893   }
1894
1895   private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1896
1897     CompositeLocation compLoc = new CompositeLocation();
1898
1899     StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1900     List<String> locIdList = new ArrayList<String>();
1901     while (tokenizer.hasMoreTokens()) {
1902       String locId = tokenizer.nextToken();
1903       locIdList.add(locId);
1904     }
1905
1906     // at least,one location element needs to be here!
1907     assert (locIdList.size() > 0);
1908
1909     // assume that loc with idx 0 comes from the local lattice
1910     // loc with idx 1 comes from the field lattice
1911
1912     String localLocId = locIdList.get(0);
1913     SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1914     Location localLoc = new Location(md, localLocId);
1915     if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1916       throw new Error("Location " + localLocId
1917           + " is not defined in the local variable lattice at "
1918           + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : md) + ".");
1919     }
1920     compLoc.addLocation(localLoc);
1921
1922     for (int i = 1; i < locIdList.size(); i++) {
1923       String locName = locIdList.get(i);
1924       try {
1925         Location fieldLoc =
1926             parseFieldLocDeclaraton(locName, generateErrorMessage(md.getClassDesc(), n));
1927         compLoc.addLocation(fieldLoc);
1928       } catch (Exception e) {
1929         throw new Error("The location declaration '" + locName + "' is wrong  at "
1930             + generateErrorMessage(md.getClassDesc(), n));
1931       }
1932     }
1933
1934     return compLoc;
1935
1936   }
1937
1938   private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1939     VarDescriptor vd = dn.getVarDescriptor();
1940     assignLocationOfVarDescriptor(vd, md, nametable, dn);
1941   }
1942
1943   private void checkDeclarationInClass(ClassDescriptor cd) {
1944     // Check to see that fields are okay
1945     for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1946       FieldDescriptor fd = (FieldDescriptor) field_it.next();
1947
1948       if (!(fd.isFinal() && fd.isStatic())) {
1949         checkFieldDeclaration(cd, fd);
1950       } else {
1951         // for static final, assign top location by default
1952         Location loc = Location.createTopLocation(cd);
1953         addLocationType(fd.getType(), loc);
1954       }
1955     }
1956   }
1957
1958   private Location checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1959
1960     Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1961
1962     // currently enforce every field to have corresponding location
1963     if (annotationVec.size() == 0) {
1964       throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1965           + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1966     }
1967
1968     if (annotationVec.size() > 1) {
1969       // variable can have at most one location
1970       throw new Error("Field " + fd.getSymbol() + " of class " + cd
1971           + " has more than one location.");
1972     }
1973
1974     AnnotationDescriptor ad = annotationVec.elementAt(0);
1975     Location loc = null;
1976
1977     if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1978       if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1979         String locationID = ad.getValue();
1980         // check if location is defined
1981         SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1982         if (lattice == null || (!lattice.containsKey(locationID))) {
1983           throw new Error("Location " + locationID
1984               + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1985               + cd.getSourceFileName() + ".");
1986         }
1987         loc = new Location(cd, locationID);
1988
1989         if (ssjava.isSharedLocation(loc)) {
1990           ssjava.mapSharedLocation2Descriptor(loc, fd);
1991         }
1992
1993         addLocationType(fd.getType(), loc);
1994
1995         if (ssjava.isSharedLocation(loc)) {
1996           ssjava.addSharedDesc(loc, fd);
1997         }
1998       }
1999     }
2000
2001     return loc;
2002   }
2003
2004   private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
2005     if (type != null) {
2006       TypeExtension te = type.getExtension();
2007       SSJavaType ssType;
2008       if (te != null) {
2009         ssType = (SSJavaType) te;
2010         ssType.setCompLoc(loc);
2011       } else {
2012         ssType = new SSJavaType(loc);
2013         type.setExtension(ssType);
2014       }
2015     }
2016   }
2017
2018   private void addLocationType(TypeDescriptor type, Location loc) {
2019     if (type != null) {
2020       type.setExtension(loc);
2021     }
2022   }
2023
2024   static class CompositeLattice {
2025
2026     public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
2027
2028       // System.out.println("\nisGreaterThan=" + loc1 + " " + loc2 + " msg=" +
2029       // msg);
2030       int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, false, msg);
2031       if (baseCompareResult == ComparisonResult.EQUAL) {
2032         if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
2033           return true;
2034         } else {
2035           return false;
2036         }
2037       } else if (baseCompareResult == ComparisonResult.GREATER) {
2038         return true;
2039       } else {
2040         return false;
2041       }
2042
2043     }
2044
2045     public static int compare(CompositeLocation loc1, CompositeLocation loc2, boolean ignore,
2046         String msg) {
2047
2048       // System.out.println("compare=" + loc1 + " " + loc2);
2049       int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, ignore, msg);
2050
2051       if (baseCompareResult == ComparisonResult.EQUAL) {
2052         return compareDelta(loc1, loc2);
2053       } else {
2054         return baseCompareResult;
2055       }
2056
2057     }
2058
2059     private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
2060
2061       int deltaCount1 = 0;
2062       int deltaCount2 = 0;
2063       if (dLoc1 instanceof DeltaLocation) {
2064         deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
2065       }
2066
2067       if (dLoc2 instanceof DeltaLocation) {
2068         deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
2069       }
2070       if (deltaCount1 < deltaCount2) {
2071         return ComparisonResult.GREATER;
2072       } else if (deltaCount1 == deltaCount2) {
2073         return ComparisonResult.EQUAL;
2074       } else {
2075         return ComparisonResult.LESS;
2076       }
2077
2078     }
2079
2080     private static int compareBaseLocationSet(CompositeLocation compLoc1,
2081         CompositeLocation compLoc2, boolean awareSharedLoc, boolean ignore, String msg) {
2082
2083       // if compLoc1 is greater than compLoc2, return true
2084       // else return false;
2085
2086       // compare one by one in according to the order of the tuple
2087       int numOfTie = 0;
2088       for (int i = 0; i < compLoc1.getSize(); i++) {
2089         Location loc1 = compLoc1.get(i);
2090         if (i >= compLoc2.getSize()) {
2091           if (ignore) {
2092             return ComparisonResult.INCOMPARABLE;
2093           } else {
2094             throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
2095                 + " because they are not comparable at " + msg);
2096           }
2097         }
2098         Location loc2 = compLoc2.get(i);
2099
2100         Descriptor descriptor = getCommonParentDescriptor(loc1, loc2, msg);
2101         SSJavaLattice<String> lattice = getLatticeByDescriptor(descriptor);
2102
2103         // check if the shared location is appeared only at the end of the
2104         // composite location
2105         if (lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
2106           if (i != (compLoc1.getSize() - 1)) {
2107             throw new Error("The shared location " + loc1.getLocIdentifier()
2108                 + " cannot be appeared in the middle of composite location at" + msg);
2109           }
2110         }
2111
2112         if (lattice.getSharedLocSet().contains(loc2.getLocIdentifier())) {
2113           if (i != (compLoc2.getSize() - 1)) {
2114             throw new Error("The shared location " + loc2.getLocIdentifier()
2115                 + " cannot be appeared in the middle of composite location at " + msg);
2116           }
2117         }
2118
2119         // if (!lattice1.equals(lattice2)) {
2120         // throw new Error("Failed to compare two locations of " + compLoc1 +
2121         // " and " + compLoc2
2122         // + " because they are not comparable at " + msg);
2123         // }
2124
2125         if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
2126           numOfTie++;
2127           // check if the current location is the spinning location
2128           // note that the spinning location only can be appeared in the last
2129           // part of the composite location
2130           if (awareSharedLoc && numOfTie == compLoc1.getSize()
2131               && lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
2132             return ComparisonResult.GREATER;
2133           }
2134           continue;
2135         } else if (lattice.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
2136           return ComparisonResult.GREATER;
2137         } else {
2138           if (lattice.isComparable(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
2139             return ComparisonResult.LESS;
2140           } else {
2141             return ComparisonResult.INCOMPARABLE;
2142           }
2143         }
2144
2145       }
2146
2147       if (numOfTie == compLoc1.getSize()) {
2148
2149         if (numOfTie != compLoc2.getSize()) {
2150
2151           if (ignore) {
2152             return ComparisonResult.INCOMPARABLE;
2153           } else {
2154             throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
2155                 + " because they are not comparable at " + msg);
2156           }
2157
2158         }
2159
2160         return ComparisonResult.EQUAL;
2161       }
2162
2163       return ComparisonResult.LESS;
2164
2165     }
2166
2167     public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet, String errMsg) {
2168
2169       System.out.println("Calculating GLB=" + inputSet);
2170       CompositeLocation glbCompLoc = new CompositeLocation();
2171
2172       // calculate GLB of the first(priority) element
2173       Set<String> priorityLocIdentifierSet = new HashSet<String>();
2174       Descriptor priorityDescriptor = null;
2175
2176       Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
2177           new Hashtable<String, Set<CompositeLocation>>();
2178       // mapping from the priority loc ID to its full representation by the
2179       // composite location
2180
2181       int maxTupleSize = 0;
2182       int minTupleSize = 0;
2183       CompositeLocation maxCompLoc = null;
2184
2185       Location prevPriorityLoc = null;
2186       for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
2187         CompositeLocation compLoc = (CompositeLocation) iterator.next();
2188         if (compLoc.getSize() > maxTupleSize) {
2189           maxTupleSize = compLoc.getSize();
2190           maxCompLoc = compLoc;
2191         }
2192         if (minTupleSize == 0 || compLoc.getSize() < minTupleSize) {
2193           minTupleSize = compLoc.getSize();
2194         }
2195         Location priorityLoc = compLoc.get(0);
2196         String priorityLocId = priorityLoc.getLocIdentifier();
2197         priorityLocIdentifierSet.add(priorityLocId);
2198
2199         if (locId2CompLocSet.containsKey(priorityLocId)) {
2200           locId2CompLocSet.get(priorityLocId).add(compLoc);
2201         } else {
2202           Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
2203           newSet.add(compLoc);
2204           locId2CompLocSet.put(priorityLocId, newSet);
2205         }
2206
2207         // check if priority location are coming from the same lattice
2208         if (priorityDescriptor == null) {
2209           priorityDescriptor = priorityLoc.getDescriptor();
2210         } else {
2211           priorityDescriptor = getCommonParentDescriptor(priorityLoc, prevPriorityLoc, errMsg);
2212         }
2213         prevPriorityLoc = priorityLoc;
2214         // else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
2215         // throw new Error("Failed to calculate GLB of " + inputSet
2216         // + " because they are from different lattices.");
2217         // }
2218       }
2219
2220       SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
2221       String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
2222       glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
2223       Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
2224
2225       if (compSet == null) {
2226         // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
2227         // mean that the result is already lower than <x1,y1> and <x2,y2>
2228         // assign TOP to the rest of the location elements
2229
2230         // in this case, do not take care about delta
2231         // CompositeLocation inputComp = inputSet.iterator().next();
2232         // for (int i = 1; i < maxTupleSize; i++) {
2233         for (int i = 1; i < minTupleSize; i++) {
2234           glbCompLoc.addLocation(Location.createTopLocation(maxCompLoc.get(i).getDescriptor()));
2235         }
2236       } else {
2237
2238         // here find out composite location that has a maximum length tuple
2239         // if we have three input set: [A], [A,B], [A,B,C]
2240         // maximum length tuple will be [A,B,C]
2241         int max = 0;
2242         CompositeLocation maxFromCompSet = null;
2243         for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2244           CompositeLocation c = (CompositeLocation) iterator.next();
2245           if (c.getSize() > max) {
2246             max = c.getSize();
2247             maxFromCompSet = c;
2248           }
2249         }
2250
2251         if (compSet.size() == 1) {
2252           // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
2253           CompositeLocation comp = compSet.iterator().next();
2254           for (int i = 1; i < comp.getSize(); i++) {
2255             glbCompLoc.addLocation(comp.get(i));
2256           }
2257
2258           // if input location corresponding to glb is a delta, need to apply
2259           // delta to glb result
2260           if (comp instanceof DeltaLocation) {
2261             glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2262           }
2263
2264         } else {
2265           // when GLB(x1,x2)==x1 and x2 : GLB case 1
2266           // if more than one location shares the same priority GLB
2267           // need to calculate the rest of GLB loc
2268
2269           // setup input set starting from the second tuple item
2270           Set<CompositeLocation> innerGLBInput = new HashSet<CompositeLocation>();
2271           for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2272             CompositeLocation compLoc = (CompositeLocation) iterator.next();
2273             CompositeLocation innerCompLoc = new CompositeLocation();
2274             for (int idx = 1; idx < compLoc.getSize(); idx++) {
2275               innerCompLoc.addLocation(compLoc.get(idx));
2276             }
2277             if (innerCompLoc.getSize() > 0) {
2278               innerGLBInput.add(innerCompLoc);
2279             }
2280           }
2281
2282           if (innerGLBInput.size() > 0) {
2283             // System.out.println("######innerGLBInput=" + innerGLBInput);
2284             CompositeLocation innerGLB = CompositeLattice.calculateGLB(innerGLBInput, errMsg);
2285             for (int idx = 0; idx < innerGLB.getSize(); idx++) {
2286               glbCompLoc.addLocation(innerGLB.get(idx));
2287             }
2288           }
2289
2290           // if input location corresponding to glb is a delta, need to apply
2291           // delta to glb result
2292
2293           for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2294             CompositeLocation compLoc = (CompositeLocation) iterator.next();
2295             if (compLoc instanceof DeltaLocation) {
2296               if (glbCompLoc.equals(compLoc)) {
2297                 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2298                 break;
2299               }
2300             }
2301           }
2302
2303         }
2304       }
2305
2306       System.out.println("GLB=" + glbCompLoc);
2307       return glbCompLoc;
2308
2309     }
2310
2311     static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
2312
2313       SSJavaLattice<String> lattice = null;
2314
2315       if (d instanceof ClassDescriptor) {
2316         lattice = ssjava.getCd2lattice().get(d);
2317       } else if (d instanceof MethodDescriptor) {
2318         if (ssjava.getMd2lattice().containsKey(d)) {
2319           lattice = ssjava.getMd2lattice().get(d);
2320         } else {
2321           // use default lattice for the method
2322           lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
2323         }
2324       }
2325
2326       return lattice;
2327     }
2328
2329     static Descriptor getCommonParentDescriptor(Location loc1, Location loc2, String msg) {
2330
2331       Descriptor d1 = loc1.getDescriptor();
2332       Descriptor d2 = loc2.getDescriptor();
2333
2334       Descriptor descriptor;
2335
2336       if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
2337
2338         if (d1.equals(d2)) {
2339           descriptor = d1;
2340         } else {
2341           // identifying which one is parent class
2342           Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
2343           Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
2344
2345           if (d1 == null && d2 == null) {
2346             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2347                 + " because they are not comparable at " + msg);
2348           } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
2349             descriptor = d1;
2350           } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
2351             descriptor = d2;
2352           } else {
2353             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2354                 + " because they are not comparable at " + msg);
2355           }
2356         }
2357
2358       } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
2359
2360         if (d1.equals(d2)) {
2361           descriptor = d1;
2362         } else {
2363
2364           // identifying which one is parent class
2365           MethodDescriptor md1 = (MethodDescriptor) d1;
2366           MethodDescriptor md2 = (MethodDescriptor) d2;
2367
2368           if (!md1.matches(md2)) {
2369             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2370                 + " because they are not comparable at " + msg);
2371           }
2372
2373           Set<Descriptor> d1SubClassesSet =
2374               ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
2375           Set<Descriptor> d2SubClassesSet =
2376               ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
2377
2378           if (d1 == null && d2 == null) {
2379             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2380                 + " because they are not comparable at " + msg);
2381           } else if (d1 != null && d1SubClassesSet.contains(d2)) {
2382             descriptor = d1;
2383           } else if (d2 != null && d2SubClassesSet.contains(d1)) {
2384             descriptor = d2;
2385           } else {
2386             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2387                 + " because they are not comparable at " + msg);
2388           }
2389         }
2390
2391       } else {
2392         throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2393             + " because they are not comparable at " + msg);
2394       }
2395
2396       return descriptor;
2397
2398     }
2399
2400   }
2401
2402   class ComparisonResult {
2403
2404     public static final int GREATER = 0;
2405     public static final int EQUAL = 1;
2406     public static final int LESS = 2;
2407     public static final int INCOMPARABLE = 3;
2408     int result;
2409
2410   }
2411
2412 }
2413
2414 class ReturnLocGenerator {
2415
2416   public static final int PARAMISHIGHER = 0;
2417   public static final int PARAMISSAME = 1;
2418   public static final int IGNORE = 2;
2419
2420   private Hashtable<Integer, Integer> paramIdx2paramType;
2421
2422   private CompositeLocation declaredReturnLoc = null;
2423
2424   public ReturnLocGenerator(CompositeLocation returnLoc, MethodDescriptor md,
2425       List<CompositeLocation> params, String msg) {
2426
2427     CompositeLocation thisLoc = params.get(0);
2428     if (returnLoc.get(0).equals(thisLoc.get(0)) && returnLoc.getSize() > 1) {
2429       // if the declared return location consists of THIS and field location,
2430       // return location for the caller's side has to have same field element
2431       this.declaredReturnLoc = returnLoc;
2432     } else {
2433       // creating mappings
2434       paramIdx2paramType = new Hashtable<Integer, Integer>();
2435       for (int i = 0; i < params.size(); i++) {
2436         CompositeLocation param = params.get(i);
2437         int compareResult = CompositeLattice.compare(param, returnLoc, true, msg);
2438
2439         int type;
2440         if (compareResult == ComparisonResult.GREATER) {
2441           type = 0;
2442         } else if (compareResult == ComparisonResult.EQUAL) {
2443           type = 1;
2444         } else {
2445           type = 2;
2446         }
2447         paramIdx2paramType.put(new Integer(i), new Integer(type));
2448       }
2449     }
2450
2451   }
2452
2453   public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
2454
2455     if (declaredReturnLoc != null) {
2456       // when developer specify that the return value is [THIS,field]
2457       // needs to translate to the caller's location
2458       CompositeLocation callerLoc = new CompositeLocation();
2459       CompositeLocation callerBaseLocation = args.get(0);
2460
2461       for (int i = 0; i < callerBaseLocation.getSize(); i++) {
2462         callerLoc.addLocation(callerBaseLocation.get(i));
2463       }
2464       for (int i = 1; i < declaredReturnLoc.getSize(); i++) {
2465         callerLoc.addLocation(declaredReturnLoc.get(i));
2466       }
2467       return callerLoc;
2468     } else {
2469       // compute the highest possible location in caller's side
2470       assert paramIdx2paramType.keySet().size() == args.size();
2471
2472       Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
2473       for (int i = 0; i < args.size(); i++) {
2474         int type = (paramIdx2paramType.get(new Integer(i))).intValue();
2475         CompositeLocation argLoc = args.get(i);
2476         if (type == PARAMISHIGHER || type == PARAMISSAME) {
2477           // return loc is equal to or lower than param
2478           inputGLB.add(argLoc);
2479         }
2480       }
2481
2482       // compute GLB of arguments subset that are same or higher than return
2483       // location
2484       if (inputGLB.isEmpty()) {
2485         if (args.size() == 0) {
2486           return null;
2487         }
2488         CompositeLocation rtr =
2489             new CompositeLocation(Location.createTopLocation(args.get(0).get(0).getDescriptor()));
2490         return rtr;
2491       } else {
2492         CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB, "");
2493         return glb;
2494       }
2495     }
2496
2497   }
2498 }