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