Robust/src/Analysis/SSJava/FlowDownCheck.java

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