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