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