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     for (int i = 0; i < calleeParamList.size(); i++) {
1159       CompositeLocation calleeParamLoc = calleeParamList.get(i);
1160       if (calleeParamLoc.get(0).equals(calleeThisLoc) && calleeParamLoc.getSize() > 1) {
1161
1162         // callee parameter location has field information
1163         CompositeLocation callerArgLoc = callerArgList.get(i);
1164
1165         CompositeLocation paramLocation =
1166             translateCalleeParamLocToCaller(md, calleeParamLoc, callerBaseLoc, errorMsg);
1167
1168         Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1169         if (constraint != null) {
1170           inputGLBSet.add(callerArgLoc);
1171           inputGLBSet.add(constraint);
1172           callerArgLoc =
1173               CompositeLattice.calculateGLB(inputGLBSet,
1174                   generateErrorMessage(md.getClassDesc(), min));
1175         }
1176
1177         Location argLastLoc = callerArgLoc.get(callerArgLoc.getSize() - 1);
1178         Location paramLastLoc = paramLocation.get(paramLocation.getSize() - 1);
1179
1180         if (argLastLoc.equals(paramLastLoc) && ssjava.isSharedLocation(argLastLoc)
1181             && ssjava.isSharedLocation(paramLastLoc)) {
1182           continue;
1183         }
1184
1185         // if (!CompositeLattice.isGreaterThan(callerArgLoc, paramLocation, errorMsg)) {
1186         if (CompositeLattice.compare(callerArgLoc, paramLocation, true, errorMsg) == ComparisonResult.LESS) {
1187           throw new Error("Caller argument '" + min.getArg(i).printNode(0) + " : " + callerArgLoc
1188               + "' should be higher than corresponding callee's parameter : " + paramLocation
1189               + " at " + errorMsg);
1190         }
1191
1192       }
1193     }
1194
1195   }
1196
1197   private CompositeLocation translateCalleeParamLocToCaller(MethodDescriptor md,
1198       CompositeLocation calleeParamLoc, CompositeLocation callerBaseLocation, String errorMsg) {
1199
1200     CompositeLocation translate = new CompositeLocation();
1201
1202     for (int i = 0; i < callerBaseLocation.getSize(); i++) {
1203       translate.addLocation(callerBaseLocation.get(i));
1204     }
1205
1206     for (int i = 1; i < calleeParamLoc.getSize(); i++) {
1207       translate.addLocation(calleeParamLoc.get(i));
1208     }
1209
1210     // System.out.println("TRANSLATED=" + translate + " from calleeParamLoc=" +
1211     // calleeParamLoc);
1212
1213     return translate;
1214   }
1215
1216   private CompositeLocation computeCeilingLocationForCaller(MethodDescriptor md,
1217       SymbolTable nametable, MethodInvokeNode min, CompositeLocation baseLocation,
1218       CompositeLocation constraint) {
1219     List<CompositeLocation> argList = new ArrayList<CompositeLocation>();
1220
1221     // by default, method has a THIS parameter
1222     if (!min.getMethod().isStatic()) {
1223       argList.add(baseLocation);
1224     }
1225
1226     for (int i = 0; i < min.numArgs(); i++) {
1227       ExpressionNode en = min.getArg(i);
1228       CompositeLocation callerArg =
1229           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1230               false);
1231       argList.add(callerArg);
1232     }
1233
1234     // System.out.println("\n## computeReturnLocation=" + min.getMethod() + " argList=" + argList);
1235     CompositeLocation ceilLoc = md2ReturnLocGen.get(min.getMethod()).computeReturnLocation(argList);
1236     // System.out.println("## ReturnLocation=" + ceilLoc);
1237
1238     return ceilLoc;
1239
1240   }
1241
1242   private void checkCalleeConstraints(MethodDescriptor md, SymbolTable nametable,
1243       MethodInvokeNode min, CompositeLocation callerBaseLoc, CompositeLocation constraint) {
1244
1245     MethodDescriptor calleemd = min.getMethod();
1246
1247     MethodLattice<String> calleeLattice = ssjava.getMethodLattice(calleemd);
1248
1249     System.out.println("checkCalleeConstraints=" + calleemd + " calleeLattice.getThisLoc()="
1250         + calleeLattice.getThisLoc());
1251
1252     List<CompositeLocation> callerArgList = new ArrayList<CompositeLocation>();
1253     List<CompositeLocation> calleeParamList = new ArrayList<CompositeLocation>();
1254
1255     if (min.numArgs() > 0) {
1256       // caller needs to guarantee that it passes arguments in regarding to
1257       // callee's hierarchy
1258
1259       // setup caller args set
1260       // first, add caller's base(this) location
1261       if (!calleemd.isStatic())
1262         callerArgList.add(callerBaseLoc);
1263       // second, add caller's arguments
1264       for (int i = 0; i < min.numArgs(); i++) {
1265         ExpressionNode en = min.getArg(i);
1266         CompositeLocation callerArgLoc =
1267             checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(), constraint,
1268                 false);
1269         callerArgList.add(callerArgLoc);
1270       }
1271
1272       // setup callee params set
1273       // first, add callee's this location
1274       if (!calleemd.isStatic()) {
1275         CompositeLocation calleeThisLoc =
1276             new CompositeLocation(new Location(calleemd, calleeLattice.getThisLoc()));
1277         calleeParamList.add(calleeThisLoc);
1278       }
1279       // second, add callee's parameters
1280       for (int i = 0; i < calleemd.numParameters(); i++) {
1281         VarDescriptor calleevd = (VarDescriptor) calleemd.getParameter(i);
1282         CompositeLocation calleeLoc = d2loc.get(calleevd);
1283         // System.out.println("calleevd=" + calleevd + " loc=" + calleeLoc);
1284         calleeParamList.add(calleeLoc);
1285       }
1286
1287       // here, check if ordering relations among caller's args respect
1288       // ordering relations in-between callee's args
1289       CHECK: for (int i = 0; i < calleeParamList.size(); i++) {
1290         CompositeLocation calleeLoc1 = calleeParamList.get(i);
1291         CompositeLocation callerLoc1 = callerArgList.get(i);
1292
1293         for (int j = 0; j < calleeParamList.size(); j++) {
1294           if (i != j) {
1295             CompositeLocation calleeLoc2 = calleeParamList.get(j);
1296             CompositeLocation callerLoc2 = callerArgList.get(j);
1297
1298             if (callerLoc1.get(callerLoc1.getSize() - 1).isTop()
1299                 || callerLoc2.get(callerLoc2.getSize() - 1).isTop()) {
1300               continue CHECK;
1301             }
1302
1303             // System.out.println("calleeLoc1=" + calleeLoc1);
1304             // System.out.println("calleeLoc2=" + calleeLoc2 +
1305             // "calleeParamList=" + calleeParamList);
1306
1307             int callerResult =
1308                 CompositeLattice.compare(callerLoc1, callerLoc2, true,
1309                     generateErrorMessage(md.getClassDesc(), min));
1310             // System.out.println("callerResult=" + callerResult);
1311             int calleeResult =
1312                 CompositeLattice.compare(calleeLoc1, calleeLoc2, true,
1313                     generateErrorMessage(md.getClassDesc(), min));
1314             // System.out.println("calleeResult=" + calleeResult);
1315
1316             if (callerResult == ComparisonResult.EQUAL) {
1317               if (ssjava.isSharedLocation(callerLoc1.get(callerLoc1.getSize() - 1))
1318                   && ssjava.isSharedLocation(callerLoc2.get(callerLoc2.getSize() - 1))) {
1319                 // if both of them are shared locations, promote them to
1320                 // "GREATER relation"
1321                 callerResult = ComparisonResult.GREATER;
1322               }
1323             }
1324
1325             if (calleeResult == ComparisonResult.GREATER
1326                 && callerResult != ComparisonResult.GREATER) {
1327               // If calleeLoc1 is higher than calleeLoc2
1328               // then, caller should have same ordering relation in-bet
1329               // callerLoc1 & callerLoc2
1330
1331               String paramName1, paramName2;
1332
1333               if (!calleemd.isStatic()) {
1334                 if (i == 0) {
1335                   paramName1 = "'THIS'";
1336                 } else {
1337                   paramName1 = "'parameter " + calleemd.getParamName(i - 1) + "'";
1338                 }
1339               } else {
1340                 paramName1 = "'parameter " + calleemd.getParamName(i) + "'";
1341               }
1342
1343               if (!calleemd.isStatic()) {
1344                 if (j == 0 && !calleemd.isStatic()) {
1345                   paramName2 = "'THIS'";
1346                 } else {
1347                   paramName2 = "'parameter " + calleemd.getParamName(j - 1) + "'";
1348                 }
1349               } else {
1350                 paramName2 = "'parameter " + calleemd.getParamName(j) + "'";
1351               }
1352
1353               throw new Error(
1354                   "Caller doesn't respect an ordering relation among method arguments: callee expects that "
1355                       + paramName1 + " should be higher than " + paramName2 + " in " + calleemd
1356                       + " at " + md.getClassDesc().getSourceFileName() + ":" + min.getNumLine());
1357             }
1358           }
1359
1360         }
1361       }
1362
1363     }
1364
1365   }
1366
1367   private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
1368       SymbolTable nametable, ArrayAccessNode aan, CompositeLocation constraint, boolean isLHS) {
1369     System.out.println("aan=" + aan.printNode(0) + "  line#=" + aan.getNumLine());
1370     ClassDescriptor cd = md.getClassDesc();
1371     System.out.println("aan.getExpression()=" + aan.getExpression().getClass());
1372     CompositeLocation arrayLoc =
1373         checkLocationFromExpressionNode(md, nametable, aan.getExpression(),
1374             new CompositeLocation(), constraint, isLHS);
1375     System.out.println("HERE?");
1376     // addTypeLocation(aan.getExpression().getType(), arrayLoc);
1377     CompositeLocation indexLoc =
1378         checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(),
1379             constraint, isLHS);
1380     // addTypeLocation(aan.getIndex().getType(), indexLoc);
1381     System.out.println("HERE2?");
1382
1383     if (isLHS) {
1384       if (!CompositeLattice.isGreaterThan(indexLoc, arrayLoc, generateErrorMessage(cd, aan))) {
1385         throw new Error("Array index value is not higher than array location at "
1386             + generateErrorMessage(cd, aan));
1387       }
1388       return arrayLoc;
1389     } else {
1390       Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1391       inputGLB.add(arrayLoc);
1392       inputGLB.add(indexLoc);
1393       System.out.println("arrayLoc=" + arrayLoc + "   indexLoc=" + indexLoc);
1394       CompositeLocation comp =
1395           CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(cd, aan));
1396       System.out.println("---aan=" + aan.printNode(0) + "  compLoc=" + comp);
1397       return comp;
1398     }
1399
1400   }
1401
1402   private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
1403       SymbolTable nametable, CreateObjectNode con) {
1404
1405     ClassDescriptor cd = md.getClassDesc();
1406
1407     CompositeLocation compLoc = new CompositeLocation();
1408     compLoc.addLocation(Location.createTopLocation(md));
1409     return compLoc;
1410
1411   }
1412
1413   private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
1414       OpNode on, CompositeLocation constraint) {
1415
1416     ClassDescriptor cd = md.getClassDesc();
1417     CompositeLocation leftLoc = new CompositeLocation();
1418     leftLoc =
1419         checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc, constraint, false);
1420     // addTypeLocation(on.getLeft().getType(), leftLoc);
1421
1422     CompositeLocation rightLoc = new CompositeLocation();
1423     if (on.getRight() != null) {
1424       rightLoc =
1425           checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc, constraint, false);
1426       // addTypeLocation(on.getRight().getType(), rightLoc);
1427     }
1428
1429     // System.out.println("# left loc=" + leftLoc + " from " + on.getLeft().getClass());
1430     // if (on.getRight() != null) {
1431     // System.out.println("# right loc=" + rightLoc + " from " + on.getRight().getClass());
1432     // }
1433
1434     Operation op = on.getOp();
1435
1436     switch (op.getOp()) {
1437
1438     case Operation.UNARYPLUS:
1439     case Operation.UNARYMINUS:
1440     case Operation.LOGIC_NOT:
1441       // single operand
1442       return leftLoc;
1443
1444     case Operation.LOGIC_OR:
1445     case Operation.LOGIC_AND:
1446     case Operation.COMP:
1447     case Operation.BIT_OR:
1448     case Operation.BIT_XOR:
1449     case Operation.BIT_AND:
1450     case Operation.ISAVAILABLE:
1451     case Operation.EQUAL:
1452     case Operation.NOTEQUAL:
1453     case Operation.LT:
1454     case Operation.GT:
1455     case Operation.LTE:
1456     case Operation.GTE:
1457     case Operation.ADD:
1458     case Operation.SUB:
1459     case Operation.MULT:
1460     case Operation.DIV:
1461     case Operation.MOD:
1462     case Operation.LEFTSHIFT:
1463     case Operation.RIGHTSHIFT:
1464     case Operation.URIGHTSHIFT:
1465
1466       Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
1467       inputSet.add(leftLoc);
1468       inputSet.add(rightLoc);
1469       CompositeLocation glbCompLoc =
1470           CompositeLattice.calculateGLB(inputSet, generateErrorMessage(cd, on));
1471       return glbCompLoc;
1472
1473     default:
1474       throw new Error(op.toString());
1475     }
1476
1477   }
1478
1479   private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
1480       SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
1481
1482     // literal value has the top location so that value can be flowed into any
1483     // location
1484     Location literalLoc = Location.createTopLocation(md);
1485     loc.addLocation(literalLoc);
1486     return loc;
1487
1488   }
1489
1490   private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
1491       NameNode nn, CompositeLocation loc, CompositeLocation constraint) {
1492
1493     // System.out.println("checkLocationFromNameNode nn=" + nn.printNode(0));
1494     NameDescriptor nd = nn.getName();
1495     if (nd.getBase() != null) {
1496       loc =
1497           checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc, constraint, false);
1498     } else {
1499       String varname = nd.toString();
1500       if (varname.equals("this")) {
1501         // 'this' itself!
1502         MethodLattice<String> methodLattice = ssjava.getMethodLattice(md);
1503         String thisLocId = methodLattice.getThisLoc();
1504         if (thisLocId == null) {
1505           throw new Error("The location for 'this' is not defined at "
1506               + md.getClassDesc().getSourceFileName() + "::" + nn.getNumLine());
1507         }
1508         Location locElement = new Location(md, thisLocId);
1509         loc.addLocation(locElement);
1510         return loc;
1511
1512       }
1513
1514       Descriptor d = (Descriptor) nametable.get(varname);
1515
1516       // CompositeLocation localLoc = null;
1517       if (d instanceof VarDescriptor) {
1518         VarDescriptor vd = (VarDescriptor) d;
1519         // localLoc = d2loc.get(vd);
1520         // the type of var descriptor has a composite location!
1521         loc = ((SSJavaType) vd.getType().getExtension()).getCompLoc().clone();
1522       } else if (d instanceof FieldDescriptor) {
1523         // the type of field descriptor has a location!
1524         FieldDescriptor fd = (FieldDescriptor) d;
1525         // System.out.println("fd=" + fd);
1526         if (fd.isStatic()) {
1527           if (fd.isFinal()) {
1528             // if it is 'static final', the location has TOP since no one can
1529             // change its value
1530             loc.addLocation(Location.createTopLocation(md));
1531             return loc;
1532           } else {
1533
1534             // if 'static', the location has pre-assigned global loc
1535             MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1536             String globalLocId = localLattice.getGlobalLoc();
1537             if (globalLocId == null) {
1538               throw new Error("Global location element is not defined in the method " + md);
1539             }
1540             Location globalLoc = new Location(md, globalLocId);
1541             System.out.println("static=" + globalLoc);
1542             loc.addLocation(globalLoc);
1543           }
1544         } else {
1545           // the location of field access starts from this, followed by field
1546           // location
1547           MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1548           Location thisLoc = new Location(md, localLattice.getThisLoc());
1549           loc.addLocation(thisLoc);
1550         }
1551
1552         Location fieldLoc = (Location) fd.getType().getExtension();
1553         loc.addLocation(fieldLoc);
1554       } else if (d == null) {
1555         // access static field
1556         FieldDescriptor fd = nn.getField();
1557
1558         MethodLattice<String> localLattice = ssjava.getMethodLattice(md);
1559         String globalLocId = localLattice.getGlobalLoc();
1560         if (globalLocId == null) {
1561           throw new Error("Method lattice does not define global variable location at "
1562               + generateErrorMessage(md.getClassDesc(), nn));
1563         }
1564         loc.addLocation(new Location(md, globalLocId));
1565
1566         Location fieldLoc = (Location) fd.getType().getExtension();
1567         loc.addLocation(fieldLoc);
1568
1569         return loc;
1570
1571       }
1572     }
1573
1574     return loc;
1575   }
1576
1577   private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
1578       SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc,
1579       CompositeLocation constraint) {
1580
1581     ExpressionNode left = fan.getExpression();
1582     TypeDescriptor ltd = left.getType();
1583
1584     FieldDescriptor fd = fan.getField();
1585
1586     String varName = null;
1587     if (left.kind() == Kind.NameNode) {
1588       NameDescriptor nd = ((NameNode) left).getName();
1589       varName = nd.toString();
1590     }
1591
1592     if (ltd.isClassNameRef() || (varName != null && varName.equals("this"))) {
1593       // using a class name directly or access using this
1594       if (fd.isStatic() && fd.isFinal()) {
1595         loc.addLocation(Location.createTopLocation(md));
1596         return loc;
1597       }
1598     }
1599
1600     Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
1601     if (left instanceof ArrayAccessNode) {
1602       ArrayAccessNode aan = (ArrayAccessNode) left;
1603       CompositeLocation indexLoc =
1604           checkLocationFromExpressionNode(md, nametable, aan.getIndex(), loc, constraint, false);
1605       inputGLB.add(indexLoc);
1606     }
1607
1608     loc = checkLocationFromExpressionNode(md, nametable, left, loc, constraint, false);
1609
1610     if (!left.getType().isPrimitive()) {
1611
1612       if (!fd.getSymbol().equals("length")) {
1613         // array.length access, return the location of the array
1614         Location fieldLoc = getFieldLocation(fd);
1615         loc.addLocation(fieldLoc);
1616       }
1617
1618     }
1619
1620     inputGLB.add(loc);
1621     loc = CompositeLattice.calculateGLB(inputGLB, generateErrorMessage(md.getClassDesc(), fan));
1622
1623     return loc;
1624   }
1625
1626   private Location getFieldLocation(FieldDescriptor fd) {
1627
1628     // System.out.println("### getFieldLocation=" + fd);
1629     // System.out.println("### fd.getType().getExtension()=" +
1630     // fd.getType().getExtension());
1631
1632     Location fieldLoc = (Location) fd.getType().getExtension();
1633
1634     // handle the case that method annotation checking skips checking field
1635     // declaration
1636     if (fieldLoc == null) {
1637       fieldLoc = checkFieldDeclaration(fd.getClassDescriptor(), fd);
1638     }
1639
1640     return fieldLoc;
1641
1642   }
1643
1644   private FieldDescriptor getFieldDescriptorFromExpressionNode(ExpressionNode en) {
1645
1646     if (en.kind() == Kind.NameNode) {
1647       NameNode nn = (NameNode) en;
1648       if (nn.getField() != null) {
1649         return nn.getField();
1650       }
1651
1652       if (nn.getName() != null && nn.getName().getBase() != null) {
1653         return getFieldDescriptorFromExpressionNode(nn.getExpression());
1654       }
1655
1656     } else if (en.kind() == Kind.FieldAccessNode) {
1657       FieldAccessNode fan = (FieldAccessNode) en;
1658       return fan.getField();
1659     }
1660
1661     return null;
1662   }
1663
1664   private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
1665       SymbolTable nametable, AssignmentNode an, CompositeLocation loc, CompositeLocation constraint) {
1666
1667     System.out.println("\n\ncheckLocationFromAssignmentNode=" + an.printNode(0));
1668
1669     ClassDescriptor cd = md.getClassDesc();
1670
1671     Set<CompositeLocation> inputGLBSet = new HashSet<CompositeLocation>();
1672
1673     boolean postinc = true;
1674     if (an.getOperation().getBaseOp() == null
1675         || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
1676             .getBaseOp().getOp() != Operation.POSTDEC))
1677       postinc = false;
1678
1679     // if LHS is array access node, need to check if array index is higher
1680     // than array itself
1681     CompositeLocation destLocation =
1682         checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1683             constraint, true);
1684
1685     CompositeLocation rhsLocation;
1686     CompositeLocation srcLocation;
1687
1688     if (!postinc) {
1689
1690       checkOwnership(md, an, an.getSrc());
1691
1692       rhsLocation =
1693           checkLocationFromExpressionNode(md, nametable, an.getSrc(), new CompositeLocation(),
1694               constraint, false);
1695
1696       if (an.getOperation().getOp() >= 2 && an.getOperation().getOp() <= 12) {
1697         // if assignment contains OP+EQ operator, need to merge location types
1698         // of LHS & RHS into the RHS
1699         Set<CompositeLocation> srcGLBSet = new HashSet<CompositeLocation>();
1700         srcGLBSet.add(rhsLocation);
1701         srcGLBSet.add(destLocation);
1702         srcLocation = CompositeLattice.calculateGLB(srcGLBSet, generateErrorMessage(cd, an));
1703       } else {
1704         srcLocation = rhsLocation;
1705       }
1706
1707       if (constraint != null) {
1708
1709         if (!CompositeLattice.isGreaterThan(constraint, destLocation, generateErrorMessage(cd, an))) {
1710           throw new Error("The value flow from " + constraint + " to " + destLocation
1711               + " does not respect location hierarchy on the assignment " + an.printNode(0)
1712               + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1713         }
1714         // inputGLBSet.add(srcLocation);
1715         // inputGLBSet.add(constraint);
1716         // srcLocation = CompositeLattice.calculateGLB(inputGLBSet,
1717         // generateErrorMessage(cd, an));
1718       }
1719
1720       System.out.println("src=" + srcLocation + "  dest=" + destLocation + "  const=" + constraint);
1721
1722       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1723
1724         String context = "";
1725         if (constraint != null) {
1726           context = " and the current context constraint is " + constraint;
1727         }
1728
1729         throw new Error("The value flow from " + srcLocation + " to " + destLocation
1730             + " does not respect location hierarchy on the assignment " + an.printNode(0) + context
1731             + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1732       }
1733
1734       if (srcLocation.equals(destLocation)) {
1735         // keep it for definitely written analysis
1736         Set<FlatNode> flatNodeSet = ssjava.getBuildFlat().getFlatNodeSet(an);
1737         for (Iterator iterator = flatNodeSet.iterator(); iterator.hasNext();) {
1738           FlatNode fn = (FlatNode) iterator.next();
1739           ssjava.addSameHeightWriteFlatNode(fn);
1740         }
1741
1742       }
1743
1744     } else {
1745       destLocation =
1746           rhsLocation =
1747               checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(),
1748                   constraint, false);
1749
1750       if (constraint != null) {
1751
1752         if (!CompositeLattice.isGreaterThan(constraint, destLocation, generateErrorMessage(cd, an))) {
1753           throw new Error("The value flow from " + constraint + " to " + destLocation
1754               + " does not respect location hierarchy on the assignment " + an.printNode(0)
1755               + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1756         }
1757         // inputGLBSet.add(rhsLocation);
1758         // inputGLBSet.add(constraint);
1759         // srcLocation = CompositeLattice.calculateGLB(inputGLBSet,
1760         // generateErrorMessage(cd, an));
1761         srcLocation = rhsLocation;
1762       } else {
1763         srcLocation = rhsLocation;
1764       }
1765
1766       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, generateErrorMessage(cd, an))) {
1767
1768         if (srcLocation.equals(destLocation)) {
1769           throw new Error("Location " + srcLocation
1770               + " is not allowed to have the value flow that moves within the same location at '"
1771               + an.printNode(0) + "' of " + cd.getSourceFileName() + "::" + an.getNumLine());
1772         } else {
1773           throw new Error("The value flow from " + srcLocation + " to " + destLocation
1774               + " does not respect location hierarchy on the assignment " + an.printNode(0)
1775               + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
1776         }
1777
1778       }
1779
1780       if (srcLocation.equals(destLocation)) {
1781         // keep it for definitely written analysis
1782         Set<FlatNode> flatNodeSet = ssjava.getBuildFlat().getFlatNodeSet(an);
1783         for (Iterator iterator = flatNodeSet.iterator(); iterator.hasNext();) {
1784           FlatNode fn = (FlatNode) iterator.next();
1785           ssjava.addSameHeightWriteFlatNode(fn);
1786         }
1787       }
1788
1789     }
1790
1791     return destLocation;
1792   }
1793
1794   private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
1795       SymbolTable nametable, TreeNode n) {
1796
1797     ClassDescriptor cd = md.getClassDesc();
1798     Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
1799
1800     // currently enforce every variable to have corresponding location
1801     if (annotationVec.size() == 0) {
1802       throw new Error("Location is not assigned to variable '" + vd.getSymbol()
1803           + "' in the method '" + md + "' of the class " + cd.getSymbol() + " at "
1804           + generateErrorMessage(cd, n));
1805     }
1806
1807     int locDecCount = 0;
1808     for (int i = 0; i < annotationVec.size(); i++) {
1809       AnnotationDescriptor ad = annotationVec.elementAt(i);
1810
1811       if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1812
1813         if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1814           locDecCount++;
1815           if (locDecCount > 1) {// variable can have at most one location
1816             throw new Error(vd.getSymbol() + " has more than one location declaration.");
1817           }
1818           String locDec = ad.getValue(); // check if location is defined
1819
1820           if (locDec.startsWith(SSJavaAnalysis.DELTA)) {
1821             DeltaLocation deltaLoc = parseDeltaDeclaration(md, n, locDec);
1822             d2loc.put(vd, deltaLoc);
1823             addLocationType(vd.getType(), deltaLoc);
1824           } else {
1825             CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1826
1827             Location lastElement = compLoc.get(compLoc.getSize() - 1);
1828             if (ssjava.isSharedLocation(lastElement)) {
1829               ssjava.mapSharedLocation2Descriptor(lastElement, vd);
1830             }
1831
1832             d2loc.put(vd, compLoc);
1833             addLocationType(vd.getType(), compLoc);
1834           }
1835
1836         }
1837       }
1838     }
1839
1840   }
1841
1842   private DeltaLocation parseDeltaDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1843
1844     int deltaCount = 0;
1845     int dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1846     while (dIdx >= 0) {
1847       deltaCount++;
1848       int beginIdx = dIdx + 6;
1849       locDec = locDec.substring(beginIdx, locDec.length() - 1);
1850       dIdx = locDec.indexOf(SSJavaAnalysis.DELTA);
1851     }
1852
1853     CompositeLocation compLoc = parseLocationDeclaration(md, n, locDec);
1854     DeltaLocation deltaLoc = new DeltaLocation(compLoc, deltaCount);
1855
1856     return deltaLoc;
1857   }
1858
1859   private Location parseFieldLocDeclaraton(String decl, String msg) throws Exception {
1860
1861     int idx = decl.indexOf(".");
1862
1863     String className = decl.substring(0, idx);
1864     String fieldName = decl.substring(idx + 1);
1865
1866     className.replaceAll(" ", "");
1867     fieldName.replaceAll(" ", "");
1868
1869     Descriptor d = state.getClassSymbolTable().get(className);
1870
1871     if (d == null) {
1872       // System.out.println("state.getClassSymbolTable()=" +
1873       // state.getClassSymbolTable());
1874       throw new Error("The class in the location declaration '" + decl + "' does not exist at "
1875           + msg);
1876     }
1877
1878     assert (d instanceof ClassDescriptor);
1879     SSJavaLattice<String> lattice = ssjava.getClassLattice((ClassDescriptor) d);
1880     if (!lattice.containsKey(fieldName)) {
1881       throw new Error("The location " + fieldName + " is not defined in the field lattice of '"
1882           + className + "' at " + msg);
1883     }
1884
1885     return new Location(d, fieldName);
1886   }
1887
1888   private CompositeLocation parseLocationDeclaration(MethodDescriptor md, TreeNode n, String locDec) {
1889
1890     CompositeLocation compLoc = new CompositeLocation();
1891
1892     StringTokenizer tokenizer = new StringTokenizer(locDec, ",");
1893     List<String> locIdList = new ArrayList<String>();
1894     while (tokenizer.hasMoreTokens()) {
1895       String locId = tokenizer.nextToken();
1896       locIdList.add(locId);
1897     }
1898
1899     // at least,one location element needs to be here!
1900     assert (locIdList.size() > 0);
1901
1902     // assume that loc with idx 0 comes from the local lattice
1903     // loc with idx 1 comes from the field lattice
1904
1905     String localLocId = locIdList.get(0);
1906     SSJavaLattice<String> localLattice = CompositeLattice.getLatticeByDescriptor(md);
1907     Location localLoc = new Location(md, localLocId);
1908     if (localLattice == null || (!localLattice.containsKey(localLocId))) {
1909       throw new Error("Location " + localLocId
1910           + " is not defined in the local variable lattice at "
1911           + md.getClassDesc().getSourceFileName() + "::" + (n != null ? n.getNumLine() : md) + ".");
1912     }
1913     compLoc.addLocation(localLoc);
1914
1915     for (int i = 1; i < locIdList.size(); i++) {
1916       String locName = locIdList.get(i);
1917       try {
1918         Location fieldLoc =
1919             parseFieldLocDeclaraton(locName, generateErrorMessage(md.getClassDesc(), n));
1920         compLoc.addLocation(fieldLoc);
1921       } catch (Exception e) {
1922         throw new Error("The location declaration '" + locName + "' is wrong  at "
1923             + generateErrorMessage(md.getClassDesc(), n));
1924       }
1925     }
1926
1927     return compLoc;
1928
1929   }
1930
1931   private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
1932     VarDescriptor vd = dn.getVarDescriptor();
1933     assignLocationOfVarDescriptor(vd, md, nametable, dn);
1934   }
1935
1936   private void checkDeclarationInClass(ClassDescriptor cd) {
1937     // Check to see that fields are okay
1938     for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
1939       FieldDescriptor fd = (FieldDescriptor) field_it.next();
1940
1941       if (!(fd.isFinal() && fd.isStatic())) {
1942         checkFieldDeclaration(cd, fd);
1943       } else {
1944         // for static final, assign top location by default
1945         Location loc = Location.createTopLocation(cd);
1946         addLocationType(fd.getType(), loc);
1947       }
1948     }
1949   }
1950
1951   private Location checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
1952
1953     Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1954
1955     // currently enforce every field to have corresponding location
1956     if (annotationVec.size() == 0) {
1957       throw new Error("Location is not assigned to the field '" + fd.getSymbol()
1958           + "' of the class " + cd.getSymbol() + " at " + cd.getSourceFileName());
1959     }
1960
1961     if (annotationVec.size() > 1) {
1962       // variable can have at most one location
1963       throw new Error("Field " + fd.getSymbol() + " of class " + cd
1964           + " has more than one location.");
1965     }
1966
1967     AnnotationDescriptor ad = annotationVec.elementAt(0);
1968     Location loc = null;
1969
1970     if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1971       if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1972         String locationID = ad.getValue();
1973         // check if location is defined
1974         SSJavaLattice<String> lattice = ssjava.getClassLattice(cd);
1975         if (lattice == null || (!lattice.containsKey(locationID))) {
1976           throw new Error("Location " + locationID
1977               + " is not defined in the field lattice of class " + cd.getSymbol() + " at"
1978               + cd.getSourceFileName() + ".");
1979         }
1980         loc = new Location(cd, locationID);
1981
1982         if (ssjava.isSharedLocation(loc)) {
1983           ssjava.mapSharedLocation2Descriptor(loc, fd);
1984         }
1985
1986         addLocationType(fd.getType(), loc);
1987
1988       }
1989     }
1990
1991     return loc;
1992   }
1993
1994   private void addLocationType(TypeDescriptor type, CompositeLocation loc) {
1995     if (type != null) {
1996       TypeExtension te = type.getExtension();
1997       SSJavaType ssType;
1998       if (te != null) {
1999         ssType = (SSJavaType) te;
2000         ssType.setCompLoc(loc);
2001       } else {
2002         ssType = new SSJavaType(loc);
2003         type.setExtension(ssType);
2004       }
2005     }
2006   }
2007
2008   private void addLocationType(TypeDescriptor type, Location loc) {
2009     if (type != null) {
2010       type.setExtension(loc);
2011     }
2012   }
2013
2014   static class CompositeLattice {
2015
2016     public static boolean isGreaterThan(CompositeLocation loc1, CompositeLocation loc2, String msg) {
2017
2018       // System.out.println("\nisGreaterThan=" + loc1 + " " + loc2 + " msg=" +
2019       // msg);
2020       int baseCompareResult = compareBaseLocationSet(loc1, loc2, true, false, msg);
2021       if (baseCompareResult == ComparisonResult.EQUAL) {
2022         if (compareDelta(loc1, loc2) == ComparisonResult.GREATER) {
2023           return true;
2024         } else {
2025           return false;
2026         }
2027       } else if (baseCompareResult == ComparisonResult.GREATER) {
2028         return true;
2029       } else {
2030         return false;
2031       }
2032
2033     }
2034
2035     public static int compare(CompositeLocation loc1, CompositeLocation loc2, boolean ignore,
2036         String msg) {
2037
2038       // System.out.println("compare=" + loc1 + " " + loc2);
2039       int baseCompareResult = compareBaseLocationSet(loc1, loc2, false, ignore, msg);
2040
2041       if (baseCompareResult == ComparisonResult.EQUAL) {
2042         return compareDelta(loc1, loc2);
2043       } else {
2044         return baseCompareResult;
2045       }
2046
2047     }
2048
2049     private static int compareDelta(CompositeLocation dLoc1, CompositeLocation dLoc2) {
2050
2051       int deltaCount1 = 0;
2052       int deltaCount2 = 0;
2053       if (dLoc1 instanceof DeltaLocation) {
2054         deltaCount1 = ((DeltaLocation) dLoc1).getNumDelta();
2055       }
2056
2057       if (dLoc2 instanceof DeltaLocation) {
2058         deltaCount2 = ((DeltaLocation) dLoc2).getNumDelta();
2059       }
2060       if (deltaCount1 < deltaCount2) {
2061         return ComparisonResult.GREATER;
2062       } else if (deltaCount1 == deltaCount2) {
2063         return ComparisonResult.EQUAL;
2064       } else {
2065         return ComparisonResult.LESS;
2066       }
2067
2068     }
2069
2070     private static int compareBaseLocationSet(CompositeLocation compLoc1,
2071         CompositeLocation compLoc2, boolean awareSharedLoc, boolean ignore, String msg) {
2072
2073       // if compLoc1 is greater than compLoc2, return true
2074       // else return false;
2075
2076       // compare one by one in according to the order of the tuple
2077       int numOfTie = 0;
2078       for (int i = 0; i < compLoc1.getSize(); i++) {
2079         Location loc1 = compLoc1.get(i);
2080         if (i >= compLoc2.getSize()) {
2081           if (ignore) {
2082             return ComparisonResult.INCOMPARABLE;
2083           } else {
2084             throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
2085                 + " because they are not comparable at " + msg);
2086           }
2087         }
2088         Location loc2 = compLoc2.get(i);
2089
2090         Descriptor descriptor = getCommonParentDescriptor(loc1, loc2, msg);
2091         SSJavaLattice<String> lattice = getLatticeByDescriptor(descriptor);
2092
2093         // check if the shared location is appeared only at the end of the
2094         // composite location
2095         if (lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
2096           if (i != (compLoc1.getSize() - 1)) {
2097             throw new Error("The shared location " + loc1.getLocIdentifier()
2098                 + " cannot be appeared in the middle of composite location at" + msg);
2099           }
2100         }
2101
2102         if (lattice.getSharedLocSet().contains(loc2.getLocIdentifier())) {
2103           if (i != (compLoc2.getSize() - 1)) {
2104             throw new Error("The shared location " + loc2.getLocIdentifier()
2105                 + " cannot be appeared in the middle of composite location at " + msg);
2106           }
2107         }
2108
2109         // if (!lattice1.equals(lattice2)) {
2110         // throw new Error("Failed to compare two locations of " + compLoc1 +
2111         // " and " + compLoc2
2112         // + " because they are not comparable at " + msg);
2113         // }
2114
2115         if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
2116           numOfTie++;
2117           // check if the current location is the spinning location
2118           // note that the spinning location only can be appeared in the last
2119           // part of the composite location
2120           if (awareSharedLoc && numOfTie == compLoc1.getSize()
2121               && lattice.getSharedLocSet().contains(loc1.getLocIdentifier())) {
2122             return ComparisonResult.GREATER;
2123           }
2124           continue;
2125         } else if (lattice.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
2126           return ComparisonResult.GREATER;
2127         } else {
2128           if (lattice.isComparable(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
2129             return ComparisonResult.LESS;
2130           } else {
2131             return ComparisonResult.INCOMPARABLE;
2132           }
2133         }
2134
2135       }
2136
2137       if (numOfTie == compLoc1.getSize()) {
2138
2139         if (numOfTie != compLoc2.getSize()) {
2140
2141           if (ignore) {
2142             return ComparisonResult.INCOMPARABLE;
2143           } else {
2144             throw new Error("Failed to compare two locations of " + compLoc1 + " and " + compLoc2
2145                 + " because they are not comparable at " + msg);
2146           }
2147
2148         }
2149
2150         return ComparisonResult.EQUAL;
2151       }
2152
2153       return ComparisonResult.LESS;
2154
2155     }
2156
2157     public static CompositeLocation calculateGLB(Set<CompositeLocation> inputSet, String errMsg) {
2158
2159       System.out.println("Calculating GLB=" + inputSet);
2160       CompositeLocation glbCompLoc = new CompositeLocation();
2161
2162       // calculate GLB of the first(priority) element
2163       Set<String> priorityLocIdentifierSet = new HashSet<String>();
2164       Descriptor priorityDescriptor = null;
2165
2166       Hashtable<String, Set<CompositeLocation>> locId2CompLocSet =
2167           new Hashtable<String, Set<CompositeLocation>>();
2168       // mapping from the priority loc ID to its full representation by the
2169       // composite location
2170
2171       int maxTupleSize = 0;
2172       int minTupleSize = 0;
2173       CompositeLocation maxCompLoc = null;
2174
2175       Location prevPriorityLoc = null;
2176       for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
2177         CompositeLocation compLoc = (CompositeLocation) iterator.next();
2178         if (compLoc.getSize() > maxTupleSize) {
2179           maxTupleSize = compLoc.getSize();
2180           maxCompLoc = compLoc;
2181         }
2182         if (minTupleSize == 0 || compLoc.getSize() < minTupleSize) {
2183           minTupleSize = compLoc.getSize();
2184         }
2185         Location priorityLoc = compLoc.get(0);
2186         String priorityLocId = priorityLoc.getLocIdentifier();
2187         priorityLocIdentifierSet.add(priorityLocId);
2188
2189         if (locId2CompLocSet.containsKey(priorityLocId)) {
2190           locId2CompLocSet.get(priorityLocId).add(compLoc);
2191         } else {
2192           Set<CompositeLocation> newSet = new HashSet<CompositeLocation>();
2193           newSet.add(compLoc);
2194           locId2CompLocSet.put(priorityLocId, newSet);
2195         }
2196
2197         // check if priority location are coming from the same lattice
2198         if (priorityDescriptor == null) {
2199           priorityDescriptor = priorityLoc.getDescriptor();
2200         } else {
2201           priorityDescriptor = getCommonParentDescriptor(priorityLoc, prevPriorityLoc, errMsg);
2202         }
2203         prevPriorityLoc = priorityLoc;
2204         // else if (!priorityDescriptor.equals(priorityLoc.getDescriptor())) {
2205         // throw new Error("Failed to calculate GLB of " + inputSet
2206         // + " because they are from different lattices.");
2207         // }
2208       }
2209
2210       SSJavaLattice<String> locOrder = getLatticeByDescriptor(priorityDescriptor);
2211       String glbOfPriorityLoc = locOrder.getGLB(priorityLocIdentifierSet);
2212       glbCompLoc.addLocation(new Location(priorityDescriptor, glbOfPriorityLoc));
2213       Set<CompositeLocation> compSet = locId2CompLocSet.get(glbOfPriorityLoc);
2214
2215       if (compSet == null) {
2216         // when GLB(x1,x2)!=x1 and !=x2 : GLB case 4
2217         // mean that the result is already lower than <x1,y1> and <x2,y2>
2218         // assign TOP to the rest of the location elements
2219
2220         // in this case, do not take care about delta
2221         // CompositeLocation inputComp = inputSet.iterator().next();
2222         // for (int i = 1; i < maxTupleSize; i++) {
2223         for (int i = 1; i < minTupleSize; i++) {
2224           glbCompLoc.addLocation(Location.createTopLocation(maxCompLoc.get(i).getDescriptor()));
2225         }
2226       } else {
2227
2228         // here find out composite location that has a maximum length tuple
2229         // if we have three input set: [A], [A,B], [A,B,C]
2230         // maximum length tuple will be [A,B,C]
2231         int max = 0;
2232         CompositeLocation maxFromCompSet = null;
2233         for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2234           CompositeLocation c = (CompositeLocation) iterator.next();
2235           if (c.getSize() > max) {
2236             max = c.getSize();
2237             maxFromCompSet = c;
2238           }
2239         }
2240
2241         if (compSet.size() == 1) {
2242           // if GLB(x1,x2)==x1 or x2 : GLB case 2,3
2243           CompositeLocation comp = compSet.iterator().next();
2244           for (int i = 1; i < comp.getSize(); i++) {
2245             glbCompLoc.addLocation(comp.get(i));
2246           }
2247
2248           // if input location corresponding to glb is a delta, need to apply
2249           // delta to glb result
2250           if (comp instanceof DeltaLocation) {
2251             glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2252           }
2253
2254         } else {
2255           // when GLB(x1,x2)==x1 and x2 : GLB case 1
2256           // if more than one location shares the same priority GLB
2257           // need to calculate the rest of GLB loc
2258
2259           // setup input set starting from the second tuple item
2260           Set<CompositeLocation> innerGLBInput = new HashSet<CompositeLocation>();
2261           for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2262             CompositeLocation compLoc = (CompositeLocation) iterator.next();
2263             CompositeLocation innerCompLoc = new CompositeLocation();
2264             for (int idx = 1; idx < compLoc.getSize(); idx++) {
2265               innerCompLoc.addLocation(compLoc.get(idx));
2266             }
2267             if (innerCompLoc.getSize() > 0) {
2268               innerGLBInput.add(innerCompLoc);
2269             }
2270           }
2271
2272           if (innerGLBInput.size() > 0) {
2273             // System.out.println("######innerGLBInput=" + innerGLBInput);
2274             CompositeLocation innerGLB = CompositeLattice.calculateGLB(innerGLBInput, errMsg);
2275             for (int idx = 0; idx < innerGLB.getSize(); idx++) {
2276               glbCompLoc.addLocation(innerGLB.get(idx));
2277             }
2278           }
2279
2280           // if input location corresponding to glb is a delta, need to apply
2281           // delta to glb result
2282
2283           for (Iterator iterator = compSet.iterator(); iterator.hasNext();) {
2284             CompositeLocation compLoc = (CompositeLocation) iterator.next();
2285             if (compLoc instanceof DeltaLocation) {
2286               if (glbCompLoc.equals(compLoc)) {
2287                 glbCompLoc = new DeltaLocation(glbCompLoc, 1);
2288                 break;
2289               }
2290             }
2291           }
2292
2293         }
2294       }
2295
2296       System.out.println("GLB=" + glbCompLoc);
2297       return glbCompLoc;
2298
2299     }
2300
2301     static SSJavaLattice<String> getLatticeByDescriptor(Descriptor d) {
2302
2303       SSJavaLattice<String> lattice = null;
2304
2305       if (d instanceof ClassDescriptor) {
2306         lattice = ssjava.getCd2lattice().get(d);
2307       } else if (d instanceof MethodDescriptor) {
2308         if (ssjava.getMd2lattice().containsKey(d)) {
2309           lattice = ssjava.getMd2lattice().get(d);
2310         } else {
2311           // use default lattice for the method
2312           lattice = ssjava.getCd2methodDefault().get(((MethodDescriptor) d).getClassDesc());
2313         }
2314       }
2315
2316       return lattice;
2317     }
2318
2319     static Descriptor getCommonParentDescriptor(Location loc1, Location loc2, String msg) {
2320
2321       Descriptor d1 = loc1.getDescriptor();
2322       Descriptor d2 = loc2.getDescriptor();
2323
2324       Descriptor descriptor;
2325
2326       if (d1 instanceof ClassDescriptor && d2 instanceof ClassDescriptor) {
2327
2328         if (d1.equals(d2)) {
2329           descriptor = d1;
2330         } else {
2331           // identifying which one is parent class
2332           Set<Descriptor> d1SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d1);
2333           Set<Descriptor> d2SubClassesSet = ssjava.tu.getSubClasses((ClassDescriptor) d2);
2334
2335           if (d1 == null && d2 == null) {
2336             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2337                 + " because they are not comparable at " + msg);
2338           } else if (d1SubClassesSet != null && d1SubClassesSet.contains(d2)) {
2339             descriptor = d1;
2340           } else if (d2SubClassesSet != null && d2SubClassesSet.contains(d1)) {
2341             descriptor = d2;
2342           } else {
2343             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2344                 + " because they are not comparable at " + msg);
2345           }
2346         }
2347
2348       } else if (d1 instanceof MethodDescriptor && d2 instanceof MethodDescriptor) {
2349
2350         if (d1.equals(d2)) {
2351           descriptor = d1;
2352         } else {
2353
2354           // identifying which one is parent class
2355           MethodDescriptor md1 = (MethodDescriptor) d1;
2356           MethodDescriptor md2 = (MethodDescriptor) d2;
2357
2358           if (!md1.matches(md2)) {
2359             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2360                 + " because they are not comparable at " + msg);
2361           }
2362
2363           Set<Descriptor> d1SubClassesSet =
2364               ssjava.tu.getSubClasses(((MethodDescriptor) d1).getClassDesc());
2365           Set<Descriptor> d2SubClassesSet =
2366               ssjava.tu.getSubClasses(((MethodDescriptor) d2).getClassDesc());
2367
2368           if (d1 == null && d2 == null) {
2369             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2370                 + " because they are not comparable at " + msg);
2371           } else if (d1 != null && d1SubClassesSet.contains(d2)) {
2372             descriptor = d1;
2373           } else if (d2 != null && d2SubClassesSet.contains(d1)) {
2374             descriptor = d2;
2375           } else {
2376             throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2377                 + " because they are not comparable at " + msg);
2378           }
2379         }
2380
2381       } else {
2382         throw new Error("Failed to compare two locations of " + loc1 + " and " + loc2
2383             + " because they are not comparable at " + msg);
2384       }
2385
2386       return descriptor;
2387
2388     }
2389
2390   }
2391
2392   class ComparisonResult {
2393
2394     public static final int GREATER = 0;
2395     public static final int EQUAL = 1;
2396     public static final int LESS = 2;
2397     public static final int INCOMPARABLE = 3;
2398     int result;
2399
2400   }
2401
2402 }
2403
2404 class ReturnLocGenerator {
2405
2406   public static final int PARAMISHIGHER = 0;
2407   public static final int PARAMISSAME = 1;
2408   public static final int IGNORE = 2;
2409
2410   private Hashtable<Integer, Integer> paramIdx2paramType;
2411
2412   private CompositeLocation declaredReturnLoc = null;
2413
2414   public ReturnLocGenerator(CompositeLocation returnLoc, MethodDescriptor md,
2415       List<CompositeLocation> params, String msg) {
2416
2417     CompositeLocation thisLoc = params.get(0);
2418     if (returnLoc.get(0).equals(thisLoc.get(0)) && returnLoc.getSize() > 1) {
2419       // if the declared return location consists of THIS and field location,
2420       // return location for the caller's side has to have same field element
2421       this.declaredReturnLoc = returnLoc;
2422     } else {
2423       // creating mappings
2424       paramIdx2paramType = new Hashtable<Integer, Integer>();
2425       for (int i = 0; i < params.size(); i++) {
2426         CompositeLocation param = params.get(i);
2427         int compareResult = CompositeLattice.compare(param, returnLoc, true, msg);
2428
2429         int type;
2430         if (compareResult == ComparisonResult.GREATER) {
2431           type = 0;
2432         } else if (compareResult == ComparisonResult.EQUAL) {
2433           type = 1;
2434         } else {
2435           type = 2;
2436         }
2437         paramIdx2paramType.put(new Integer(i), new Integer(type));
2438       }
2439     }
2440
2441   }
2442
2443   public CompositeLocation computeReturnLocation(List<CompositeLocation> args) {
2444
2445     if (declaredReturnLoc != null) {
2446       // when developer specify that the return value is [THIS,field]
2447       // needs to translate to the caller's location
2448       CompositeLocation callerLoc = new CompositeLocation();
2449       CompositeLocation callerBaseLocation = args.get(0);
2450
2451       for (int i = 0; i < callerBaseLocation.getSize(); i++) {
2452         callerLoc.addLocation(callerBaseLocation.get(i));
2453       }
2454       for (int i = 1; i < declaredReturnLoc.getSize(); i++) {
2455         callerLoc.addLocation(declaredReturnLoc.get(i));
2456       }
2457       return callerLoc;
2458     } else {
2459       // compute the highest possible location in caller's side
2460       assert paramIdx2paramType.keySet().size() == args.size();
2461
2462       Set<CompositeLocation> inputGLB = new HashSet<CompositeLocation>();
2463       for (int i = 0; i < args.size(); i++) {
2464         int type = (paramIdx2paramType.get(new Integer(i))).intValue();
2465         CompositeLocation argLoc = args.get(i);
2466         if (type == PARAMISHIGHER || type == PARAMISSAME) {
2467           // return loc is equal to or lower than param
2468           inputGLB.add(argLoc);
2469         }
2470       }
2471
2472       // compute GLB of arguments subset that are same or higher than return
2473       // location
2474       if (inputGLB.isEmpty()) {
2475         if (args.size() == 0) {
2476           return null;
2477         }
2478         CompositeLocation rtr =
2479             new CompositeLocation(Location.createTopLocation(args.get(0).get(0).getDescriptor()));
2480         return rtr;
2481       } else {
2482         CompositeLocation glb = CompositeLattice.calculateGLB(inputGLB, "");
2483         return glb;
2484       }
2485     }
2486
2487   }
2488 }