Robust/src/Analysis/SSJava/FlowDownCheck.java

   1 package Analysis.SSJava;
   2
   3 import java.util.HashSet;
   4 import java.util.Hashtable;
   5 import java.util.Iterator;
   6 import java.util.Map;
   7 import java.util.Set;
   8 import java.util.StringTokenizer;
   9 import java.util.Vector;
  10
  11 import IR.AnnotationDescriptor;
  12 import IR.ClassDescriptor;
  13 import IR.Descriptor;
  14 import IR.FieldDescriptor;
  15 import IR.MethodDescriptor;
  16 import IR.NameDescriptor;
  17 import IR.Operation;
  18 import IR.State;
  19 import IR.SymbolTable;
  20 import IR.TypeDescriptor;
  21 import IR.VarDescriptor;
  22 import IR.Tree.ArrayAccessNode;
  23 import IR.Tree.AssignmentNode;
  24 import IR.Tree.BlockExpressionNode;
  25 import IR.Tree.BlockNode;
  26 import IR.Tree.BlockStatementNode;
  27 import IR.Tree.CastNode;
  28 import IR.Tree.CreateObjectNode;
  29 import IR.Tree.DeclarationNode;
  30 import IR.Tree.ExpressionNode;
  31 import IR.Tree.FieldAccessNode;
  32 import IR.Tree.IfStatementNode;
  33 import IR.Tree.Kind;
  34 import IR.Tree.LiteralNode;
  35 import IR.Tree.LoopNode;
  36 import IR.Tree.MethodInvokeNode;
  37 import IR.Tree.NameNode;
  38 import IR.Tree.OpNode;
  39 import IR.Tree.ReturnNode;
  40 import IR.Tree.SubBlockNode;
  41 import IR.Tree.TertiaryNode;
  42 import IR.Tree.TreeNode;
  43 import Util.Lattice;
  44
  45 public class FlowDownCheck {
  46
  47   static State state;
  48   HashSet toanalyze;
  49   Hashtable<Descriptor, Location> td2loc; // mapping from 'type descriptor'
  50                                           // to 'location'
  51   Hashtable<String, ClassDescriptor> id2cd; // mapping from 'locID' to 'class
  52                                             // descriptor'
  53
  54   public FlowDownCheck(State state) {
  55     this.state = state;
  56     this.toanalyze = new HashSet();
  57     this.td2loc = new Hashtable<Descriptor, Location>();
  58     init();
  59   }
  60
  61   public void init() {
  62     id2cd = new Hashtable<String, ClassDescriptor>();
  63     Hashtable cd2lattice = state.getCd2LocationOrder();
  64
  65     Set cdSet = cd2lattice.keySet();
  66     for (Iterator iterator = cdSet.iterator(); iterator.hasNext();) {
  67       ClassDescriptor cd = (ClassDescriptor) iterator.next();
  68       Lattice<String> lattice = (Lattice<String>) cd2lattice.get(cd);
  69
  70       Set<String> locIdSet = lattice.getKeySet();
  71       for (Iterator iterator2 = locIdSet.iterator(); iterator2.hasNext();) {
  72         String locID = (String) iterator2.next();
  73         id2cd.put(locID, cd);
  74       }
  75     }
  76
  77   }
  78
  79   public void flowDownCheck() {
  80     SymbolTable classtable = state.getClassSymbolTable();
  81
  82     // phase 1 : checking declaration node and creating mapping of 'type
  83     // desciptor' & 'location'
  84     toanalyze.addAll(classtable.getValueSet());
  85     toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
  86     while (!toanalyze.isEmpty()) {
  87       Object obj = toanalyze.iterator().next();
  88       ClassDescriptor cd = (ClassDescriptor) obj;
  89       toanalyze.remove(cd);
  90
  91       if (!cd.isInterface()) {
  92         checkDeclarationInClass(cd);
  93         for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
  94           MethodDescriptor md = (MethodDescriptor) method_it.next();
  95           try {
  96             checkDeclarationInMethodBody(cd, md);
  97           } catch (Error e) {
  98             System.out.println("Error in " + md);
  99             throw e;
 100           }
 101         }
 102       }
 103
 104     }
 105
 106     // post-processing for delta location
 107     // for a nested delta location, assigning a concrete reference to delta
 108     // operand
 109     Set<Descriptor> tdSet = td2loc.keySet();
 110     for (Iterator iterator = tdSet.iterator(); iterator.hasNext();) {
 111       Descriptor td = (Descriptor) iterator.next();
 112       Location loc = td2loc.get(td);
 113
 114       if (loc.getType() == Location.DELTA) {
 115         // if it contains delta reference pointing to another location element
 116         CompositeLocation compLoc = (CompositeLocation) loc;
 117
 118         Location locElement = compLoc.getTuple().at(0);
 119         assert (locElement instanceof DeltaLocation);
 120
 121         DeltaLocation delta = (DeltaLocation) locElement;
 122         Descriptor refType = delta.getRefLocationId();
 123         if (refType != null) {
 124           Location refLoc = td2loc.get(refType);
 125
 126           assert (refLoc instanceof CompositeLocation);
 127           CompositeLocation refCompLoc = (CompositeLocation) refLoc;
 128
 129           assert (refCompLoc.getTuple().at(0) instanceof DeltaLocation);
 130           DeltaLocation refDelta = (DeltaLocation) refCompLoc.getTuple().at(0);
 131
 132           delta.addDeltaOperand(refDelta);
 133           // compLoc.addLocation(refDelta);
 134         }
 135
 136       }
 137     }
 138
 139     // phase2 : checking assignments
 140     toanalyze.addAll(classtable.getValueSet());
 141     toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
 142     while (!toanalyze.isEmpty()) {
 143       Object obj = toanalyze.iterator().next();
 144       ClassDescriptor cd = (ClassDescriptor) obj;
 145       toanalyze.remove(cd);
 146
 147       checkClass(cd);
 148       for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
 149         MethodDescriptor md = (MethodDescriptor) method_it.next();
 150         try {
 151           checkMethodBody(cd, md);
 152         } catch (Error e) {
 153           System.out.println("Error in " + md);
 154           throw e;
 155         }
 156       }
 157     }
 158
 159   }
 160
 161   public Hashtable getMap() {
 162     return td2loc;
 163   }
 164
 165   private void checkDeclarationInMethodBody(ClassDescriptor cd, MethodDescriptor md) {
 166     BlockNode bn = state.getMethodBody(md);
 167     for (int i = 0; i < md.numParameters(); i++) {
 168       // process annotations on method parameters
 169       VarDescriptor vd = (VarDescriptor) md.getParameter(i);
 170       assignLocationOfVarDescriptor(vd, md, md.getParameterTable(), bn);
 171     }
 172     checkDeclarationInBlockNode(md, md.getParameterTable(), bn);
 173   }
 174
 175   private void checkDeclarationInBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn) {
 176     bn.getVarTable().setParent(nametable);
 177     for (int i = 0; i < bn.size(); i++) {
 178       BlockStatementNode bsn = bn.get(i);
 179       checkDeclarationInBlockStatementNode(md, bn.getVarTable(), bsn);
 180     }
 181   }
 182
 183   private void checkDeclarationInBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
 184       BlockStatementNode bsn) {
 185
 186     switch (bsn.kind()) {
 187     case Kind.SubBlockNode:
 188       checkDeclarationInSubBlockNode(md, nametable, (SubBlockNode) bsn);
 189       return;
 190
 191     case Kind.DeclarationNode:
 192       checkDeclarationNode(md, nametable, (DeclarationNode) bsn);
 193       break;
 194
 195     case Kind.LoopNode:
 196       checkDeclarationInLoopNode(md, nametable, (LoopNode) bsn);
 197       break;
 198     }
 199   }
 200
 201   private void checkDeclarationInLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln) {
 202
 203     if (ln.getType() == LoopNode.FORLOOP) {
 204       // check for loop case
 205       ClassDescriptor cd = md.getClassDesc();
 206       BlockNode bn = ln.getInitializer();
 207       for (int i = 0; i < bn.size(); i++) {
 208         BlockStatementNode bsn = bn.get(i);
 209         checkDeclarationInBlockStatementNode(md, nametable, bsn);
 210       }
 211     }
 212
 213     // check loop body
 214     checkDeclarationInBlockNode(md, nametable, ln.getBody());
 215   }
 216
 217   private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
 218     BlockNode bn = state.getMethodBody(md);
 219     checkLocationFromBlockNode(md, md.getParameterTable(), bn);
 220   }
 221
 222   private CompositeLocation checkLocationFromBlockNode(MethodDescriptor md, SymbolTable nametable,
 223       BlockNode bn) {
 224
 225     bn.getVarTable().setParent(nametable);
 226     // it will return the lowest location in the block node
 227     CompositeLocation lowestLoc = null;
 228     for (int i = 0; i < bn.size(); i++) {
 229       BlockStatementNode bsn = bn.get(i);
 230       CompositeLocation bLoc = checkLocationFromBlockStatementNode(md, bn.getVarTable(), bsn);
 231
 232       if (lowestLoc == null) {
 233         lowestLoc = bLoc;
 234       } else {
 235         if (CompositeLattice.isGreaterThan(lowestLoc, bLoc, md.getClassDesc())) {
 236           lowestLoc = bLoc;
 237         }
 238       }
 239     }
 240     return lowestLoc;
 241   }
 242
 243   private CompositeLocation checkLocationFromBlockStatementNode(MethodDescriptor md,
 244       SymbolTable nametable, BlockStatementNode bsn) {
 245
 246     CompositeLocation compLoc = null;
 247     switch (bsn.kind()) {
 248     case Kind.BlockExpressionNode:
 249       compLoc = checkLocationFromBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn);
 250       break;
 251
 252     case Kind.DeclarationNode:
 253       compLoc = checkLocationFromDeclarationNode(md, nametable, (DeclarationNode) bsn);
 254       break;
 255
 256     case Kind.IfStatementNode:
 257       compLoc = checkLocationFromIfStatementNode(md, nametable, (IfStatementNode) bsn);
 258       break;
 259
 260     case Kind.LoopNode:
 261       compLoc = checkLocationFromLoopNode(md, nametable, (LoopNode) bsn);
 262       break;
 263
 264     case Kind.ReturnNode:
 265       compLoc = checkLocationFromReturnNode(md, nametable, (ReturnNode) bsn);
 266       break;
 267
 268     case Kind.SubBlockNode:
 269       compLoc = checkLocationFromSubBlockNode(md, nametable, (SubBlockNode) bsn);
 270       break;
 271
 272     // case Kind.ContinueBreakNode:
 273     // checkLocationFromContinueBreakNode(md, nametable,(ContinueBreakNode)
 274     // bsn);
 275     // return null;
 276     }
 277     return compLoc;
 278   }
 279
 280   private CompositeLocation checkLocationFromReturnNode(MethodDescriptor md, SymbolTable nametable,
 281       ReturnNode rn) {
 282     ClassDescriptor cd = md.getClassDesc();
 283     CompositeLocation loc = new CompositeLocation(cd);
 284     // TODO: by default, return node has "bottom" location no matter what it is
 285     // going to return
 286     // but definitely I need to consider it more!!!
 287     loc.addLocation(Location.createBottomLocation(cd));
 288     /*
 289      * ExpressionNode returnExp = rn.getReturnExpression(); if
 290      * (rn.getReturnExpression() != null) { loc =
 291      * checkLocationFromExpressionNode(md, nametable, returnExp, loc); }
 292      */
 293     // System.out.println(rn.printNode(0) + "  has loc=" + loc);
 294     return loc;
 295   }
 296
 297   private CompositeLocation checkLocationFromLoopNode(MethodDescriptor md, SymbolTable nametable,
 298       LoopNode ln) {
 299
 300     ClassDescriptor cd = md.getClassDesc();
 301     if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
 302
 303       CompositeLocation condLoc =
 304           checkLocationFromExpressionNode(md, nametable, ln.getCondition(), new CompositeLocation(
 305               cd));
 306       addTypeLocation(ln.getCondition().getType(), (condLoc));
 307
 308       CompositeLocation bodyLoc = checkLocationFromBlockNode(md, nametable, ln.getBody());
 309
 310       if (!CompositeLattice.isGreaterThan(condLoc, bodyLoc, cd)) {
 311         // loop condition should be higher than loop body
 312         throw new Error(
 313             "The location of the while-condition statement is lower than the loop body at "
 314                 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
 315       }
 316
 317       return bodyLoc;
 318
 319     } else {
 320       // check for loop case
 321       BlockNode bn = ln.getInitializer();
 322       bn.getVarTable().setParent(nametable);
 323
 324       // calculate glb location of condition and update statements
 325       CompositeLocation condLoc =
 326           checkLocationFromExpressionNode(md, bn.getVarTable(), ln.getCondition(),
 327               new CompositeLocation(cd));
 328       addTypeLocation(ln.getCondition().getType(), condLoc);
 329
 330       CompositeLocation updateLoc =
 331           checkLocationFromBlockNode(md, bn.getVarTable(), ln.getUpdate());
 332
 333       Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 334       glbInputSet.add(condLoc);
 335       glbInputSet.add(updateLoc);
 336
 337       CompositeLocation glbLocOfForLoopCond = CompositeLattice.calculateGLB(cd, glbInputSet, cd);
 338
 339       // check location of 'forloop' body
 340       CompositeLocation blockLoc = checkLocationFromBlockNode(md, bn.getVarTable(), ln.getBody());
 341
 342       if (blockLoc == null) {
 343         // when there is no statement in the loop body
 344         return glbLocOfForLoopCond;
 345       }
 346
 347       if (!CompositeLattice.isGreaterThan(glbLocOfForLoopCond, blockLoc, cd)) {
 348         throw new Error(
 349             "The location of the for-condition statement is lower than the for-loop body at "
 350                 + cd.getSourceFileName() + ":" + ln.getCondition().getNumLine());
 351       }
 352       return blockLoc;
 353     }
 354
 355   }
 356
 357   private CompositeLocation checkLocationFromSubBlockNode(MethodDescriptor md,
 358       SymbolTable nametable, SubBlockNode sbn) {
 359     CompositeLocation compLoc = checkLocationFromBlockNode(md, nametable, sbn.getBlockNode());
 360     return compLoc;
 361   }
 362
 363   private CompositeLocation checkLocationFromIfStatementNode(MethodDescriptor md,
 364       SymbolTable nametable, IfStatementNode isn) {
 365
 366     ClassDescriptor localCD = md.getClassDesc();
 367     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 368
 369     CompositeLocation condLoc =
 370         checkLocationFromExpressionNode(md, nametable, isn.getCondition(), new CompositeLocation(
 371             localCD));
 372     addTypeLocation(isn.getCondition().getType(), condLoc);
 373     glbInputSet.add(condLoc);
 374
 375     CompositeLocation locTrueBlock = checkLocationFromBlockNode(md, nametable, isn.getTrueBlock());
 376     glbInputSet.add(locTrueBlock);
 377
 378     // here, the location of conditional block should be higher than the
 379     // location of true/false blocks
 380
 381     if (!CompositeLattice.isGreaterThan(condLoc, locTrueBlock, localCD)) {
 382       // error
 383       throw new Error(
 384           "The location of the if-condition statement is lower than the conditional block at "
 385               + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
 386     }
 387
 388     if (isn.getFalseBlock() != null) {
 389       CompositeLocation locFalseBlock =
 390           checkLocationFromBlockNode(md, nametable, isn.getFalseBlock());
 391       glbInputSet.add(locFalseBlock);
 392
 393       if (!CompositeLattice.isGreaterThan(condLoc, locFalseBlock, localCD)) {
 394         // error
 395         throw new Error(
 396             "The location of the if-condition statement is lower than the conditional block at "
 397                 + localCD.getSourceFileName() + ":" + isn.getCondition().getNumLine());
 398       }
 399
 400     }
 401
 402     // return GLB location of condition, true, and false block
 403     CompositeLocation glbLoc = CompositeLattice.calculateGLB(localCD, glbInputSet, localCD);
 404
 405     return glbLoc;
 406   }
 407
 408   private CompositeLocation checkLocationFromDeclarationNode(MethodDescriptor md,
 409       SymbolTable nametable, DeclarationNode dn) {
 410     VarDescriptor vd = dn.getVarDescriptor();
 411
 412     Location destLoc = td2loc.get(vd);
 413
 414     ClassDescriptor localCD = md.getClassDesc();
 415     if (dn.getExpression() != null) {
 416       CompositeLocation expressionLoc =
 417           checkLocationFromExpressionNode(md, nametable, dn.getExpression(), new CompositeLocation(
 418               localCD));
 419       addTypeLocation(dn.getExpression().getType(), expressionLoc);
 420
 421       if (expressionLoc != null) {
 422         // checking location order
 423         if (!CompositeLattice.isGreaterThan(expressionLoc, destLoc, localCD)) {
 424           throw new Error("The value flow from " + expressionLoc + " to " + destLoc
 425               + " does not respect location hierarchy on the assignment " + dn.printNode(0)
 426               + " at " + md.getClassDesc().getSourceFileName() + "::" + dn.getNumLine());
 427         }
 428       }
 429       return expressionLoc;
 430
 431     } else {
 432
 433       if (destLoc instanceof Location) {
 434         CompositeLocation comp = new CompositeLocation(localCD);
 435         comp.addLocation(destLoc);
 436         return comp;
 437       } else {
 438         return (CompositeLocation) destLoc;
 439       }
 440
 441     }
 442
 443   }
 444
 445   private void checkDeclarationInSubBlockNode(MethodDescriptor md, SymbolTable nametable,
 446       SubBlockNode sbn) {
 447     checkDeclarationInBlockNode(md, nametable.getParent(), sbn.getBlockNode());
 448   }
 449
 450   private CompositeLocation checkLocationFromBlockExpressionNode(MethodDescriptor md,
 451       SymbolTable nametable, BlockExpressionNode ben) {
 452     CompositeLocation compLoc =
 453         checkLocationFromExpressionNode(md, nametable, ben.getExpression(), null);
 454     addTypeLocation(ben.getExpression().getType(), compLoc);
 455     return compLoc;
 456   }
 457
 458   private CompositeLocation checkLocationFromExpressionNode(MethodDescriptor md,
 459       SymbolTable nametable, ExpressionNode en, CompositeLocation loc) {
 460
 461     CompositeLocation compLoc = null;
 462     switch (en.kind()) {
 463
 464     case Kind.AssignmentNode:
 465       compLoc = checkLocationFromAssignmentNode(md, nametable, (AssignmentNode) en, loc);
 466       break;
 467
 468     case Kind.FieldAccessNode:
 469       compLoc = checkLocationFromFieldAccessNode(md, nametable, (FieldAccessNode) en, loc);
 470       break;
 471
 472     case Kind.NameNode:
 473       compLoc = checkLocationFromNameNode(md, nametable, (NameNode) en, loc);
 474       break;
 475
 476     case Kind.OpNode:
 477       compLoc = checkLocationFromOpNode(md, nametable, (OpNode) en);
 478       break;
 479
 480     case Kind.CreateObjectNode:
 481       compLoc = checkLocationFromCreateObjectNode(md, nametable, (CreateObjectNode) en);
 482       break;
 483
 484     case Kind.ArrayAccessNode:
 485       compLoc = checkLocationFromArrayAccessNode(md, nametable, (ArrayAccessNode) en);
 486       break;
 487
 488     case Kind.LiteralNode:
 489       compLoc = checkLocationFromLiteralNode(md, nametable, (LiteralNode) en, loc);
 490       break;
 491
 492     case Kind.MethodInvokeNode:
 493       compLoc = checkLocationFromMethodInvokeNode(md, nametable, (MethodInvokeNode) en);
 494       break;
 495
 496     case Kind.TertiaryNode:
 497       compLoc = checkLocationFromTertiaryNode(md, nametable, (TertiaryNode) en);
 498       break;
 499
 500     case Kind.CastNode:
 501       compLoc = checkLocationFromCastNode(md, nametable, (CastNode) en);
 502       break;
 503
 504     // case Kind.InstanceOfNode:
 505     // checkInstanceOfNode(md, nametable, (InstanceOfNode) en, td);
 506     // return null;
 507
 508     // case Kind.ArrayInitializerNode:
 509     // checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en,
 510     // td);
 511     // return null;
 512
 513     // case Kind.ClassTypeNode:
 514     // checkClassTypeNode(md, nametable, (ClassTypeNode) en, td);
 515     // return null;
 516
 517     // case Kind.OffsetNode:
 518     // checkOffsetNode(md, nametable, (OffsetNode)en, td);
 519     // return null;
 520
 521     default:
 522       return null;
 523
 524     }
 525
 526     addTypeLocation(en.getType(), compLoc);
 527     return compLoc;
 528
 529   }
 530
 531   private CompositeLocation checkLocationFromCastNode(MethodDescriptor md, SymbolTable nametable,
 532       CastNode cn) {
 533
 534     ExpressionNode en = cn.getExpression();
 535     return checkLocationFromExpressionNode(md, nametable, en,
 536         new CompositeLocation(md.getClassDesc()));
 537
 538   }
 539
 540   private CompositeLocation checkLocationFromTertiaryNode(MethodDescriptor md,
 541       SymbolTable nametable, TertiaryNode tn) {
 542     ClassDescriptor cd = md.getClassDesc();
 543
 544     CompositeLocation condLoc =
 545         checkLocationFromExpressionNode(md, nametable, tn.getCond(), new CompositeLocation(cd));
 546     addTypeLocation(tn.getCond().getType(), condLoc);
 547     CompositeLocation trueLoc =
 548         checkLocationFromExpressionNode(md, nametable, tn.getTrueExpr(), new CompositeLocation(cd));
 549     addTypeLocation(tn.getTrueExpr().getType(), trueLoc);
 550     CompositeLocation falseLoc =
 551         checkLocationFromExpressionNode(md, nametable, tn.getFalseExpr(), new CompositeLocation(cd));
 552     addTypeLocation(tn.getFalseExpr().getType(), falseLoc);
 553
 554     // check if condLoc is higher than trueLoc & falseLoc
 555     if (!CompositeLattice.isGreaterThan(condLoc, trueLoc, cd)) {
 556       throw new Error(
 557           "The location of the condition expression is lower than the true expression at "
 558               + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
 559     }
 560
 561     if (!CompositeLattice.isGreaterThan(condLoc, falseLoc, cd)) {
 562       throw new Error(
 563           "The location of the condition expression is lower than the true expression at "
 564               + cd.getSourceFileName() + ":" + tn.getCond().getNumLine());
 565     }
 566
 567     // then, return glb of trueLoc & falseLoc
 568     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 569     glbInputSet.add(trueLoc);
 570     glbInputSet.add(falseLoc);
 571
 572     return CompositeLattice.calculateGLB(cd, glbInputSet, cd);
 573   }
 574
 575   private CompositeLocation checkLocationFromMethodInvokeNode(MethodDescriptor md,
 576       SymbolTable nametable, MethodInvokeNode min) {
 577
 578     ClassDescriptor cd = md.getClassDesc();
 579
 580     if (min.numArgs() > 1) {
 581
 582       // caller needs to guarantee that it passes arguments in regarding to
 583       // callee's hierarchy
 584
 585       for (int i = 0; i < min.numArgs(); i++) {
 586         ExpressionNode en = min.getArg(i);
 587         CompositeLocation callerArg1 =
 588             checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(cd));
 589
 590         ClassDescriptor calleecd = min.getMethod().getClassDesc();
 591         VarDescriptor calleevd = (VarDescriptor) min.getMethod().getParameter(i);
 592         Location calleeLoc1 = td2loc.get(calleevd);
 593
 594         if (!callerArg1.getLocation(cd).isTop()) {
 595           // here, check if ordering relations among caller's args respect
 596           // ordering relations in-between callee's args
 597           for (int currentIdx = 0; currentIdx < min.numArgs(); currentIdx++) {
 598             if (currentIdx != i) { // skip itself
 599               ExpressionNode argExp = min.getArg(currentIdx);
 600               CompositeLocation callerArg2 =
 601                   checkLocationFromExpressionNode(md, nametable, argExp, new CompositeLocation(cd));
 602
 603               VarDescriptor calleevd2 = (VarDescriptor) min.getMethod().getParameter(currentIdx);
 604               Location calleeLoc2 = td2loc.get(calleevd2);
 605               boolean callerResult = CompositeLattice.isGreaterThan(callerArg1, callerArg2, cd);
 606               boolean calleeResult =
 607                   CompositeLattice.isGreaterThan(calleeLoc1, calleeLoc2, calleecd);
 608
 609               if (calleeResult && !callerResult) {
 610                 // in callee, calleeLoc1 is higher than calleeLoc2
 611                 // then, caller should have same ordering relation in-bet
 612                 // callerLoc1 & callerLoc2
 613
 614                 throw new Error("Caller doesn't respect ordering relations among method arguments:"
 615                     + cd.getSourceFileName() + ":" + min.getNumLine());
 616               }
 617
 618             }
 619           }
 620         }
 621
 622       }
 623
 624     }
 625
 626     // all arguments should be higher than the location of return value
 627
 628     // first, calculate glb of arguments
 629     Set<CompositeLocation> argLocSet = new HashSet<CompositeLocation>();
 630     for (int i = 0; i < min.numArgs(); i++) {
 631       ExpressionNode en = min.getArg(i);
 632       CompositeLocation argLoc =
 633           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(cd));
 634       addTypeLocation(en.getType(), argLoc);
 635       argLocSet.add(argLoc);
 636     }
 637
 638     if (argLocSet.size() > 0) {
 639       CompositeLocation argGLBLoc = CompositeLattice.calculateGLB(cd, argLocSet, cd);
 640       return argGLBLoc;
 641     } else {
 642       // if there are no arguments,
 643       CompositeLocation returnLoc = new CompositeLocation(cd);
 644       returnLoc.addLocation(Location.createTopLocation(cd));
 645       return returnLoc;
 646     }
 647   }
 648
 649   private CompositeLocation checkLocationFromArrayAccessNode(MethodDescriptor md,
 650       SymbolTable nametable, ArrayAccessNode aan) {
 651
 652     // return glb location of array itself and index
 653
 654     ClassDescriptor cd = md.getClassDesc();
 655
 656     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 657
 658     CompositeLocation arrayLoc =
 659         checkLocationFromExpressionNode(md, nametable, aan.getExpression(), new CompositeLocation(
 660             cd));
 661     addTypeLocation(aan.getExpression().getType(), arrayLoc);
 662     glbInputSet.add(arrayLoc);
 663     CompositeLocation indexLoc =
 664         checkLocationFromExpressionNode(md, nametable, aan.getIndex(), new CompositeLocation(cd));
 665     glbInputSet.add(indexLoc);
 666     addTypeLocation(aan.getIndex().getType(), indexLoc);
 667
 668     CompositeLocation glbLoc = CompositeLattice.calculateGLB(cd, glbInputSet, cd);
 669     return glbLoc;
 670   }
 671
 672   private CompositeLocation checkLocationFromCreateObjectNode(MethodDescriptor md,
 673       SymbolTable nametable, CreateObjectNode con) {
 674
 675     ClassDescriptor cd = md.getClassDesc();
 676
 677     // check arguments
 678     Set<CompositeLocation> glbInputSet = new HashSet<CompositeLocation>();
 679     for (int i = 0; i < con.numArgs(); i++) {
 680       ExpressionNode en = con.getArg(i);
 681       CompositeLocation argLoc =
 682           checkLocationFromExpressionNode(md, nametable, en, new CompositeLocation(cd));
 683       glbInputSet.add(argLoc);
 684       addTypeLocation(en.getType(), argLoc);
 685     }
 686
 687     // check array initializers
 688     // if ((con.getArrayInitializer() != null)) {
 689     // checkLocationFromArrayInitializerNode(md, nametable,
 690     // con.getArrayInitializer());
 691     // }
 692
 693     if (glbInputSet.size() > 0) {
 694       return CompositeLattice.calculateGLB(cd, glbInputSet, cd);
 695     }
 696
 697     CompositeLocation compLoc = new CompositeLocation(cd);
 698     compLoc.addLocation(Location.createTopLocation(cd));
 699     return compLoc;
 700
 701   }
 702
 703   private CompositeLocation checkLocationFromOpNode(MethodDescriptor md, SymbolTable nametable,
 704       OpNode on) {
 705
 706     ClassDescriptor cd = md.getClassDesc();
 707     CompositeLocation leftLoc = new CompositeLocation(cd);
 708     leftLoc = checkLocationFromExpressionNode(md, nametable, on.getLeft(), leftLoc);
 709     addTypeLocation(on.getLeft().getType(), leftLoc);
 710
 711     CompositeLocation rightLoc = new CompositeLocation(cd);
 712     if (on.getRight() != null) {
 713       rightLoc = checkLocationFromExpressionNode(md, nametable, on.getRight(), rightLoc);
 714       addTypeLocation(on.getRight().getType(), rightLoc);
 715     }
 716
 717     // System.out.println("checking op node=" + on.printNode(0));
 718     // System.out.println("left loc=" + leftLoc + " from " +
 719     // on.getLeft().getClass());
 720     // System.out.println("right loc=" + rightLoc + " from " +
 721     // on.getLeft().getClass());
 722
 723     Operation op = on.getOp();
 724
 725     switch (op.getOp()) {
 726
 727     case Operation.UNARYPLUS:
 728     case Operation.UNARYMINUS:
 729     case Operation.LOGIC_NOT:
 730       // single operand
 731       return leftLoc;
 732
 733     case Operation.LOGIC_OR:
 734     case Operation.LOGIC_AND:
 735     case Operation.COMP:
 736     case Operation.BIT_OR:
 737     case Operation.BIT_XOR:
 738     case Operation.BIT_AND:
 739     case Operation.ISAVAILABLE:
 740     case Operation.EQUAL:
 741     case Operation.NOTEQUAL:
 742     case Operation.LT:
 743     case Operation.GT:
 744     case Operation.LTE:
 745     case Operation.GTE:
 746     case Operation.ADD:
 747     case Operation.SUB:
 748     case Operation.MULT:
 749     case Operation.DIV:
 750     case Operation.MOD:
 751     case Operation.LEFTSHIFT:
 752     case Operation.RIGHTSHIFT:
 753     case Operation.URIGHTSHIFT:
 754
 755       Set<CompositeLocation> inputSet = new HashSet<CompositeLocation>();
 756       inputSet.add(leftLoc);
 757       inputSet.add(rightLoc);
 758       CompositeLocation glbCompLoc = CompositeLattice.calculateGLB(cd, inputSet, cd);
 759       return glbCompLoc;
 760
 761     default:
 762       throw new Error(op.toString());
 763     }
 764
 765   }
 766
 767   private CompositeLocation checkLocationFromLiteralNode(MethodDescriptor md,
 768       SymbolTable nametable, LiteralNode en, CompositeLocation loc) {
 769
 770     // literal value has the top location so that value can be flowed into any
 771     // location
 772     Location literalLoc = Location.createTopLocation(md.getClassDesc());
 773     loc.addLocation(literalLoc);
 774     return loc;
 775
 776   }
 777
 778   private CompositeLocation checkLocationFromNameNode(MethodDescriptor md, SymbolTable nametable,
 779       NameNode nn, CompositeLocation loc) {
 780
 781     NameDescriptor nd = nn.getName();
 782     if (nd.getBase() != null) {
 783       loc = checkLocationFromExpressionNode(md, nametable, nn.getExpression(), loc);
 784       addTypeLocation(nn.getExpression().getType(), loc);
 785     } else {
 786
 787       String varname = nd.toString();
 788       if (varname.equals("this")) {
 789         // 'this' itself is top location in the local hierarchy
 790         loc.addLocation(Location.createTopLocation(md.getClassDesc()));
 791         return loc;
 792       }
 793       Descriptor d = (Descriptor) nametable.get(varname);
 794
 795       Location localLoc = null;
 796       if (d instanceof VarDescriptor) {
 797         VarDescriptor vd = (VarDescriptor) d;
 798         localLoc = td2loc.get(vd);
 799       } else if (d instanceof FieldDescriptor) {
 800         FieldDescriptor fd = (FieldDescriptor) d;
 801         localLoc = td2loc.get(fd);
 802       }
 803       assert (localLoc != null);
 804
 805       if (localLoc instanceof CompositeLocation) {
 806         loc = (CompositeLocation) localLoc;
 807       } else {
 808         loc.addLocation(localLoc);
 809       }
 810     }
 811
 812     return loc;
 813   }
 814
 815   private CompositeLocation checkLocationFromFieldAccessNode(MethodDescriptor md,
 816       SymbolTable nametable, FieldAccessNode fan, CompositeLocation loc) {
 817
 818     ExpressionNode left = fan.getExpression();
 819     loc = checkLocationFromExpressionNode(md, nametable, left, loc);
 820     addTypeLocation(left.getType(), loc);
 821
 822     if (!left.getType().isPrimitive()) {
 823       FieldDescriptor fd = fan.getField();
 824       Location fieldLoc = td2loc.get(fd);
 825
 826       // in the case of "this.field", need to get rid of 'this' location from
 827       // the composite location
 828       if (loc.getCd2Loc().containsKey(md.getClassDesc())) {
 829         loc.removieLocation(md.getClassDesc());
 830       }
 831       loc.addLocation(fieldLoc);
 832     }
 833
 834     return loc;
 835   }
 836
 837   private CompositeLocation checkLocationFromAssignmentNode(MethodDescriptor md,
 838       SymbolTable nametable, AssignmentNode an, CompositeLocation loc) {
 839     ClassDescriptor cd = md.getClassDesc();
 840
 841     boolean postinc = true;
 842     if (an.getOperation().getBaseOp() == null
 843         || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
 844             .getBaseOp().getOp() != Operation.POSTDEC))
 845       postinc = false;
 846
 847     CompositeLocation destLocation =
 848         checkLocationFromExpressionNode(md, nametable, an.getDest(), new CompositeLocation(cd));
 849
 850     CompositeLocation srcLocation = new CompositeLocation(cd);
 851     if (!postinc) {
 852       srcLocation = new CompositeLocation(cd);
 853       srcLocation = checkLocationFromExpressionNode(md, nametable, an.getSrc(), srcLocation);
 854       // System.out.println("an=" + an.printNode(0) + " an.getSrc()=" +
 855       // an.getSrc().getClass()
 856       // + " at " + cd.getSourceFileName() + "::" + an.getNumLine());
 857       if (!CompositeLattice.isGreaterThan(srcLocation, destLocation, cd)) {
 858         throw new Error("The value flow from " + srcLocation + " to " + destLocation
 859             + " does not respect location hierarchy on the assignment " + an.printNode(0) + "at "
 860             + cd.getSourceFileName() + "::" + an.getNumLine());
 861       }
 862     } else {
 863       destLocation =
 864           srcLocation = checkLocationFromExpressionNode(md, nametable, an.getDest(), srcLocation);
 865
 866       if (!((Set<String>) state.getCd2LocationPropertyMap().get(cd)).contains(destLocation
 867           .getLocation(cd).getLocIdentifier())) {
 868         throw new Error("Location " + destLocation + " is not allowed to have spinning values at "
 869             + cd.getSourceFileName() + ":" + an.getNumLine());
 870       }
 871
 872     }
 873     if (an.getSrc() != null) {
 874       addTypeLocation(an.getSrc().getType(), srcLocation);
 875     }
 876     addTypeLocation(an.getDest().getType(), destLocation);
 877
 878     return destLocation;
 879   }
 880
 881   private void assignLocationOfVarDescriptor(VarDescriptor vd, MethodDescriptor md,
 882       SymbolTable nametable, TreeNode n) {
 883
 884     ClassDescriptor cd = md.getClassDesc();
 885     Vector<AnnotationDescriptor> annotationVec = vd.getType().getAnnotationMarkers();
 886
 887     // currently enforce every variable to have corresponding location
 888     if (annotationVec.size() == 0) {
 889       throw new Error("Location is not assigned to variable " + vd.getSymbol() + " in the method "
 890           + md.getSymbol() + " of the class " + cd.getSymbol());
 891     }
 892
 893     if (annotationVec.size() > 1) {
 894       // variable can have at most one location
 895       throw new Error(vd.getSymbol() + " has more than one location.");
 896     }
 897
 898     AnnotationDescriptor ad = annotationVec.elementAt(0);
 899
 900     if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
 901
 902       if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
 903         String locationID = ad.getValue();
 904         // check if location is defined
 905         Lattice<String> lattice = (Lattice<String>) state.getCd2LocationOrder().get(cd);
 906         if (lattice == null || (!lattice.containsKey(locationID))) {
 907           throw new Error("Location " + locationID
 908               + " is not defined in the location hierarchy of class " + cd.getSymbol() + ".");
 909         }
 910         Location loc = new Location(cd, locationID);
 911         td2loc.put(vd, loc);
 912         addTypeLocation(vd.getType(), loc);
 913
 914       } else if (ad.getMarker().equals(SSJavaAnalysis.DELTA)) {
 915
 916         CompositeLocation compLoc = new CompositeLocation(cd);
 917
 918         if (ad.getValue().length() == 0) {
 919           throw new Error("Delta function of " + vd.getSymbol() + " does not have any locations: "
 920               + cd.getSymbol() + ".");
 921         }
 922
 923         String deltaStr = ad.getValue();
 924         if (deltaStr.startsWith("LOC(")) {
 925
 926           if (!deltaStr.endsWith(")")) {
 927             throw new Error("The declaration of the delta location is wrong at "
 928                 + cd.getSourceFileName() + ":" + n.getNumLine());
 929           }
 930           String locationOperand = deltaStr.substring(4, deltaStr.length() - 1);
 931
 932           nametable.get(locationOperand);
 933           Descriptor d = (Descriptor) nametable.get(locationOperand);
 934
 935           if (d instanceof VarDescriptor) {
 936             VarDescriptor varDescriptor = (VarDescriptor) d;
 937             DeltaLocation deltaLoc = new DeltaLocation(cd, varDescriptor);
 938             // td2loc.put(vd.getType(), compLoc);
 939             compLoc.addLocation(deltaLoc);
 940           } else if (d instanceof FieldDescriptor) {
 941             throw new Error("Applying delta operation to the field " + locationOperand
 942                 + " is not allowed at " + cd.getSourceFileName() + ":" + n.getNumLine());
 943           }
 944         } else {
 945           StringTokenizer token = new StringTokenizer(deltaStr, ",");
 946           DeltaLocation deltaLoc = new DeltaLocation(cd);
 947
 948           while (token.hasMoreTokens()) {
 949             String deltaOperand = token.nextToken();
 950             ClassDescriptor deltaCD = id2cd.get(deltaOperand);
 951             if (deltaCD == null) {
 952               // delta operand is not defined in the location hierarchy
 953               throw new Error("Delta operand '" + deltaOperand + "' of declaration node '" + vd
 954                   + "' is not defined by location hierarchies.");
 955             }
 956
 957             Location loc = new Location(deltaCD, deltaOperand);
 958             deltaLoc.addDeltaOperand(loc);
 959           }
 960           compLoc.addLocation(deltaLoc);
 961
 962         }
 963
 964         td2loc.put(vd, compLoc);
 965         addTypeLocation(vd.getType(), compLoc);
 966
 967       }
 968     }
 969
 970   }
 971
 972   private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn) {
 973     VarDescriptor vd = dn.getVarDescriptor();
 974     assignLocationOfVarDescriptor(vd, md, nametable, dn);
 975   }
 976
 977   private void checkClass(ClassDescriptor cd) {
 978     // Check to see that methods respects ss property
 979     for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
 980       MethodDescriptor md = (MethodDescriptor) method_it.next();
 981       checkMethodDeclaration(cd, md);
 982     }
 983   }
 984
 985   private void checkDeclarationInClass(ClassDescriptor cd) {
 986     // Check to see that fields are okay
 987     for (Iterator field_it = cd.getFields(); field_it.hasNext();) {
 988       FieldDescriptor fd = (FieldDescriptor) field_it.next();
 989       checkFieldDeclaration(cd, fd);
 990     }
 991   }
 992
 993   private void checkMethodDeclaration(ClassDescriptor cd, MethodDescriptor md) {
 994     // TODO
 995   }
 996
 997   private void checkFieldDeclaration(ClassDescriptor cd, FieldDescriptor fd) {
 998
 999     Vector<AnnotationDescriptor> annotationVec = fd.getType().getAnnotationMarkers();
1000
1001     // currently enforce every field to have corresponding location
1002     if (annotationVec.size() == 0) {
1003       throw new Error("Location is not assigned to the field " + fd.getSymbol() + " of the class "
1004           + cd.getSymbol());
1005     }
1006
1007     if (annotationVec.size() > 1) {
1008       // variable can have at most one location
1009       throw new Error("Field " + fd.getSymbol() + " of class " + cd
1010           + " has more than one location.");
1011     }
1012
1013     AnnotationDescriptor ad = annotationVec.elementAt(0);
1014
1015     if (ad.getType() == AnnotationDescriptor.SINGLE_ANNOTATION) {
1016
1017       if (ad.getMarker().equals(SSJavaAnalysis.LOC)) {
1018         String locationID = ad.getValue();
1019         // check if location is defined
1020         Lattice<String> lattice = (Lattice<String>) state.getCd2LocationOrder().get(cd);
1021         if (lattice == null || (!lattice.containsKey(locationID))) {
1022           throw new Error("Location " + locationID
1023               + " is not defined in the location hierarchy of class " + cd.getSymbol() + ".");
1024         }
1025         Location loc = new Location(cd, locationID);
1026         td2loc.put(fd, loc);
1027         addTypeLocation(fd.getType(), loc);
1028
1029       } else if (ad.getMarker().equals(SSJavaAnalysis.DELTA)) {
1030
1031         if (ad.getValue().length() == 0) {
1032           throw new Error("Delta function of " + fd.getSymbol() + " does not have any locations: "
1033               + cd.getSymbol() + ".");
1034         }
1035
1036         CompositeLocation compLoc = new CompositeLocation(cd);
1037         DeltaLocation deltaLoc = new DeltaLocation(cd);
1038
1039         StringTokenizer token = new StringTokenizer(ad.getValue(), ",");
1040         while (token.hasMoreTokens()) {
1041           String deltaOperand = token.nextToken();
1042           ClassDescriptor deltaCD = id2cd.get(deltaOperand);
1043           if (deltaCD == null) {
1044             // delta operand is not defined in the location hierarchy
1045             throw new Error("Delta operand '" + deltaOperand + "' of field node '" + fd
1046                 + "' is not defined by location hierarchies.");
1047           }
1048
1049           Location loc = new Location(deltaCD, deltaOperand);
1050           deltaLoc.addDeltaOperand(loc);
1051         }
1052         compLoc.addLocation(deltaLoc);
1053         td2loc.put(fd, compLoc);
1054         addTypeLocation(fd.getType(), compLoc);
1055
1056       }
1057     }
1058
1059
1060   }
1061
1062   private void addTypeLocation(TypeDescriptor type, Location loc) {
1063     if (type != null) {
1064       type.setExtension(loc);
1065     }
1066   }
1067
1068   static class CompositeLattice {
1069
1070     public static boolean isGreaterThan(Location loc1, Location loc2, ClassDescriptor priorityCD) {
1071
1072       // System.out.println("\nisGreaterThan=" + loc1 + " ? " + loc2);
1073       CompositeLocation compLoc1;
1074       CompositeLocation compLoc2;
1075
1076       if (loc1 instanceof CompositeLocation) {
1077         compLoc1 = (CompositeLocation) loc1;
1078       } else {
1079         // create a bogus composite location for a single location
1080         compLoc1 = new CompositeLocation(loc1.getClassDescriptor());
1081         compLoc1.addLocation(loc1);
1082       }
1083
1084       if (loc2 instanceof CompositeLocation) {
1085         compLoc2 = (CompositeLocation) loc2;
1086       } else {
1087         // create a bogus composite location for a single location
1088         compLoc2 = new CompositeLocation(loc2.getClassDescriptor());
1089         compLoc2.addLocation(loc2);
1090       }
1091
1092       // comparing two composite locations
1093       // System.out.println("compare base location=" + compLoc1 + " ? " +
1094       // compLoc2);
1095
1096       int baseCompareResult = compareBaseLocationSet(compLoc1, compLoc2, priorityCD);
1097       if (baseCompareResult == ComparisonResult.EQUAL) {
1098         if (compareDelta(compLoc1, compLoc2) == ComparisonResult.GREATER) {
1099           return true;
1100         } else {
1101           return false;
1102         }
1103       } else if (baseCompareResult == ComparisonResult.GREATER) {
1104         return true;
1105       } else {
1106         return false;
1107       }
1108
1109     }
1110
1111     private static int compareDelta(CompositeLocation compLoc1, CompositeLocation compLoc2) {
1112       if (compLoc1.getNumofDelta() < compLoc2.getNumofDelta()) {
1113         return ComparisonResult.GREATER;
1114       } else {
1115         return ComparisonResult.LESS;
1116       }
1117     }
1118
1119     private static int compareBaseLocationSet(CompositeLocation compLoc1,
1120         CompositeLocation compLoc2, ClassDescriptor priorityCD) {
1121
1122       // if compLoc1 is greater than compLoc2, return true
1123       // else return false;
1124
1125       Map<ClassDescriptor, Location> cd2loc1 = compLoc1.getCd2Loc();
1126       Map<ClassDescriptor, Location> cd2loc2 = compLoc2.getCd2Loc();
1127
1128       // compare first the priority loc elements
1129       Location priorityLoc1 = cd2loc1.get(priorityCD);
1130       Location priorityLoc2 = cd2loc2.get(priorityCD);
1131
1132       assert (priorityLoc1.getClassDescriptor().equals(priorityLoc2.getClassDescriptor()));
1133
1134       ClassDescriptor cd = priorityLoc1.getClassDescriptor();
1135       Lattice<String> locationOrder = (Lattice<String>) state.getCd2LocationOrder().get(cd);
1136
1137       if (priorityLoc1.getLocIdentifier().equals(priorityLoc2.getLocIdentifier())) {
1138         // have the same level of local hierarchy
1139
1140         Set<String> spinSet = (Set<String>) state.getCd2LocationPropertyMap().get(cd);
1141         if (spinSet != null && spinSet.contains(priorityLoc1.getLocIdentifier())) {
1142           // this location can be spinning
1143           return ComparisonResult.GREATER;
1144         }
1145
1146       } else if (locationOrder.isGreaterThan(priorityLoc1.getLocIdentifier(),
1147           priorityLoc2.getLocIdentifier())) {
1148         // if priority loc of compLoc1 is higher than compLoc2
1149         // then, compLoc 1 is higher than compLoc2
1150         return ComparisonResult.GREATER;
1151       } else {
1152         // if priority loc of compLoc1 is NOT higher than compLoc2
1153         // then, compLoc 1 is NOT higher than compLoc2
1154         return ComparisonResult.LESS;
1155       }
1156
1157       // compare base locations except priority by class descriptor
1158       Set<ClassDescriptor> keySet1 = cd2loc1.keySet();
1159       int numEqualLoc = 0;
1160
1161       for (Iterator iterator = keySet1.iterator(); iterator.hasNext();) {
1162         ClassDescriptor cd1 = (ClassDescriptor) iterator.next();
1163
1164         Location loc1 = cd2loc1.get(cd1);
1165         Location loc2 = cd2loc2.get(cd1);
1166
1167         if (priorityLoc1.equals(loc1)) {
1168           continue;
1169         }
1170
1171         if (loc2 == null) {
1172           // if comploc2 doesn't have corresponding location,
1173           // then we determines that comploc1 is lower than comploc 2
1174           return ComparisonResult.LESS;
1175         }
1176
1177         System.out.println("lattice comparison:" + loc1.getLocIdentifier() + " ? "
1178             + loc2.getLocIdentifier());
1179         locationOrder = (Lattice<String>) state.getCd2LocationOrder().get(cd1);
1180         if (loc1.getLocIdentifier().equals(loc2.getLocIdentifier())) {
1181           // have the same level of local hierarchy
1182           numEqualLoc++;
1183         } else if (!locationOrder.isGreaterThan(loc1.getLocIdentifier(), loc2.getLocIdentifier())) {
1184           // if one element of composite location 1 is not higher than composite
1185           // location 2
1186           // then, composite loc 1 is not higher than composite loc 2
1187
1188           System.out.println(compLoc1 + " < " + compLoc2);
1189           return ComparisonResult.LESS;
1190         }
1191
1192       }
1193
1194       if (numEqualLoc == (compLoc1.getBaseLocationSize() - 1)) {
1195         return ComparisonResult.EQUAL;
1196       }
1197
1198       System.out.println(compLoc1 + " > " + compLoc2);
1199       return ComparisonResult.GREATER;
1200     }
1201
1202     public static CompositeLocation calculateGLB(ClassDescriptor cd,
1203         Set<CompositeLocation> inputSet, ClassDescriptor priorityCD) {
1204
1205       CompositeLocation glbCompLoc = new CompositeLocation(cd);
1206       int maxDeltaFunction = 0;
1207
1208       // calculate GLB of priority element first
1209
1210       Hashtable<ClassDescriptor, Set<Location>> cd2locSet =
1211           new Hashtable<ClassDescriptor, Set<Location>>();
1212
1213       // creating mapping from class to set of locations
1214       for (Iterator iterator = inputSet.iterator(); iterator.hasNext();) {
1215         CompositeLocation compLoc = (CompositeLocation) iterator.next();
1216
1217         int numOfDelta = compLoc.getNumofDelta();
1218         if (numOfDelta > maxDeltaFunction) {
1219           maxDeltaFunction = numOfDelta;
1220         }
1221
1222         Set<Location> baseLocationSet = compLoc.getBaseLocationSet();
1223         for (Iterator iterator2 = baseLocationSet.iterator(); iterator2.hasNext();) {
1224           Location locElement = (Location) iterator2.next();
1225           ClassDescriptor locCD = locElement.getClassDescriptor();
1226
1227           Set<Location> locSet = cd2locSet.get(locCD);
1228           if (locSet == null) {
1229             locSet = new HashSet<Location>();
1230           }
1231           locSet.add(locElement);
1232
1233           cd2locSet.put(locCD, locSet);
1234
1235         }
1236       }
1237
1238       Set<Location> locSetofClass = cd2locSet.get(priorityCD);
1239       Set<String> locIdentifierSet = new HashSet<String>();
1240
1241       for (Iterator<Location> locIterator = locSetofClass.iterator(); locIterator.hasNext();) {
1242         Location locElement = locIterator.next();
1243         locIdentifierSet.add(locElement.getLocIdentifier());
1244       }
1245
1246       Lattice<String> locOrder = (Lattice<String>) state.getCd2LocationOrder().get(priorityCD);
1247       String glbLocIdentifer = locOrder.getGLB(locIdentifierSet);
1248
1249       Location priorityGLB = new Location(priorityCD, glbLocIdentifer);
1250
1251       Set<CompositeLocation> sameGLBLoc = new HashSet<CompositeLocation>();
1252
1253       for (Iterator<CompositeLocation> iterator = inputSet.iterator(); iterator.hasNext();) {
1254         CompositeLocation inputComploc = iterator.next();
1255         Location locElement = inputComploc.getLocation(priorityCD);
1256
1257         if (locElement.equals(priorityGLB)) {
1258           sameGLBLoc.add(inputComploc);
1259         }
1260       }
1261       glbCompLoc.addLocation(priorityGLB);
1262       if (sameGLBLoc.size() > 0) {
1263         // if more than one location shares the same priority GLB
1264         // need to calculate the rest of GLB loc
1265
1266         Set<Location> glbElementSet = new HashSet<Location>();
1267
1268         for (Iterator<ClassDescriptor> iterator = cd2locSet.keySet().iterator(); iterator.hasNext();) {
1269           ClassDescriptor localCD = iterator.next();
1270           if (!localCD.equals(priorityCD)) {
1271             Set<Location> localLocSet = cd2locSet.get(localCD);
1272             Set<String> LocalLocIdSet = new HashSet<String>();
1273
1274             for (Iterator<Location> locIterator = localLocSet.iterator(); locIterator.hasNext();) {
1275               Location locElement = locIterator.next();
1276               LocalLocIdSet.add(locElement.getLocIdentifier());
1277             }
1278
1279             Lattice<String> localOrder = (Lattice<String>) state.getCd2LocationOrder().get(localCD);
1280             Location localGLBLoc = new Location(localCD, localOrder.getGLB(LocalLocIdSet));
1281             glbCompLoc.addLocation(localGLBLoc);
1282           }
1283         }
1284       } else {
1285         // if priority glb loc is lower than all of input loc
1286         // assign top location to the rest of loc element
1287
1288         for (Iterator<ClassDescriptor> iterator = cd2locSet.keySet().iterator(); iterator.hasNext();) {
1289           ClassDescriptor localCD = iterator.next();
1290           if (!localCD.equals(priorityCD)) {
1291             Location localGLBLoc = Location.createTopLocation(localCD);
1292             glbCompLoc.addLocation(localGLBLoc);
1293           }
1294
1295         }
1296
1297       }
1298
1299       return glbCompLoc;
1300
1301     }
1302
1303   }
1304
1305   class ComparisonResult {
1306
1307     public static final int GREATER = 0;
1308     public static final int EQUAL = 1;
1309     public static final int LESS = 2;
1310     int result;
1311
1312   }
1313
1314 }