1 package Analysis.SSJava;
3 import java.util.HashSet;
4 import java.util.Hashtable;
5 import java.util.Iterator;
8 import IR.ClassDescriptor;
9 import IR.MethodDescriptor;
12 import IR.SymbolTable;
14 import IR.Tree.ArrayAccessNode;
15 import IR.Tree.ArrayInitializerNode;
16 import IR.Tree.AssignmentNode;
17 import IR.Tree.BlockExpressionNode;
18 import IR.Tree.BlockNode;
19 import IR.Tree.BlockStatementNode;
20 import IR.Tree.CastNode;
21 import IR.Tree.CreateObjectNode;
22 import IR.Tree.DeclarationNode;
23 import IR.Tree.ExpressionNode;
24 import IR.Tree.FieldAccessNode;
25 import IR.Tree.IfStatementNode;
26 import IR.Tree.InstanceOfNode;
28 import IR.Tree.LoopNode;
29 import IR.Tree.MethodInvokeNode;
30 import IR.Tree.OpNode;
31 import IR.Tree.ReturnNode;
32 import IR.Tree.SubBlockNode;
33 import IR.Tree.SwitchBlockNode;
34 import IR.Tree.SwitchStatementNode;
35 import IR.Tree.TertiaryNode;
38 public class MethodAnnotationCheck {
41 SSJavaAnalysis ssjava;
44 Set<MethodDescriptor> annotatedMDSet;
45 Hashtable<MethodDescriptor, Set<MethodDescriptor>> caller2calleeSet;
47 public MethodAnnotationCheck(SSJavaAnalysis ssjava, State state, TypeUtil tu) {
51 caller2calleeSet = new Hashtable<MethodDescriptor, Set<MethodDescriptor>>();
52 annotatedMDSet = new HashSet<MethodDescriptor>();
55 public void methodAnnoatationCheck() {
56 SymbolTable classtable = state.getClassSymbolTable();
57 HashSet toanalyze = new HashSet();
58 toanalyze.addAll(classtable.getValueSet());
59 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
60 while (!toanalyze.isEmpty()) {
61 Object obj = toanalyze.iterator().next();
62 ClassDescriptor cd = (ClassDescriptor) obj;
65 if (!cd.isInterface()) {
66 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
67 MethodDescriptor md = (MethodDescriptor) method_it.next();
68 checkMethodBody(cd, md);
74 for (Iterator iterator = annotatedMDSet.iterator(); iterator.hasNext();) {
75 MethodDescriptor md = (MethodDescriptor) iterator.next();
76 ssjava.addAnnotationRequire(md);
79 Set<Pair> visited = new HashSet<Pair>();
80 Set<MethodDescriptor> tovisit = new HashSet<MethodDescriptor>();
81 tovisit.addAll(annotatedMDSet);
83 while (!tovisit.isEmpty()) {
84 MethodDescriptor callerMD = tovisit.iterator().next();
85 tovisit.remove(callerMD);
87 Set<MethodDescriptor> calleeSet = caller2calleeSet.get(callerMD);
88 if (calleeSet != null) {
89 for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
90 MethodDescriptor calleeMD = (MethodDescriptor) iterator.next();
91 Pair p = new Pair(callerMD, calleeMD);
92 if (!visited.contains(p)) {
95 tovisit.add(calleeMD);
97 Set<MethodDescriptor> possibleCalleeSet =
98 (Set<MethodDescriptor>) ssjava.getCallGraph().getMethods(calleeMD);
100 System.out.println("caller=" + callerMD + " callee=" + possibleCalleeSet);
102 for (Iterator iterator2 = possibleCalleeSet.iterator(); iterator2.hasNext();) {
103 MethodDescriptor possibleCallee = (MethodDescriptor) iterator2.next();
105 if (!possibleCallee.isAbstract()) {
106 ssjava.addAnnotationRequire(possibleCallee);
107 tovisit.add(possibleCallee);
119 public void methodAnnoataionInheritanceCheck() {
120 // check If a method is annotated, any method that overrides it should
123 Set<MethodDescriptor> tovisit = new HashSet<MethodDescriptor>();
124 tovisit.addAll(ssjava.getAnnotationRequireSet());
126 while (!tovisit.isEmpty()) {
127 MethodDescriptor md = tovisit.iterator().next();
130 ClassDescriptor cd = md.getClassDesc();
132 Set subClassSet = tu.getSubClasses(cd);
133 if (subClassSet != null) {
134 for (Iterator iterator2 = subClassSet.iterator(); iterator2.hasNext();) {
135 ClassDescriptor subCD = (ClassDescriptor) iterator2.next();
136 Set possiblematches = subCD.getMethodTable().getSet(md.getSymbol());
137 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
138 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
139 if (md.matches(matchmd)) {
140 if (matchmd.getClassDesc().equals(subCD)) {
141 ssjava.addAnnotationRequire(matchmd);
148 // need to check super classess if the current method is inherited from
149 // them, all of ancestor method should be annoated
150 ClassDescriptor currentCd = cd;
151 ClassDescriptor superCd = tu.getSuper(currentCd);
152 while (!superCd.getSymbol().equals("Object")) {
153 Set possiblematches = superCd.getMethodTable().getSet(md.getSymbol());
154 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
155 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
156 if (md.matches(matchmd)) {
157 ssjava.addAnnotationRequire(matchmd);
161 superCd = tu.getSuper(currentCd);
164 Set<ClassDescriptor> superIFSet = tu.getSuperIFs(cd);
165 for (Iterator iterator = superIFSet.iterator(); iterator.hasNext();) {
166 ClassDescriptor parentInterface = (ClassDescriptor) iterator.next();
167 Set possiblematches = parentInterface.getMethodTable().getSet(md.getSymbol());
168 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
169 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
170 if (md.matches(matchmd)) {
171 ssjava.addAnnotationRequire(matchmd);
180 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
181 BlockNode bn = state.getMethodBody(md);
182 checkBlockNode(md, md.getParameterTable(), bn, false);
185 private void checkBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn, boolean flag) {
186 bn.getVarTable().setParent(nametable);
187 String label = bn.getLabel();
188 boolean isSSJavaLoop = flag;
189 if (label != null && label.equals(ssjava.SSJAVA)) {
191 throw new Error("Only outermost loop can be the self-stabilizing loop.");
193 annotatedMDSet.add(md);
198 for (int i = 0; i < bn.size(); i++) {
199 BlockStatementNode bsn = bn.get(i);
200 checkBlockStatementNode(md, bn.getVarTable(), bsn, isSSJavaLoop);
205 private void checkBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
206 BlockStatementNode bsn, boolean flag) {
208 switch (bsn.kind()) {
209 case Kind.SubBlockNode:
210 checkSubBlockNode(md, nametable, (SubBlockNode) bsn, flag);
213 case Kind.BlockExpressionNode:
214 checkBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, flag);
217 case Kind.DeclarationNode:
218 checkDeclarationNode(md, nametable, (DeclarationNode) bsn, flag);
221 case Kind.IfStatementNode:
222 checkIfStatementNode(md, nametable, (IfStatementNode) bsn, flag);
226 checkLoopNode(md, nametable, (LoopNode) bsn, flag);
229 case Kind.ReturnNode:
230 checkReturnNode(md, nametable, (ReturnNode) bsn, flag);
233 case Kind.SwitchStatementNode:
234 checkSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, flag);
240 private void checkSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
241 SwitchStatementNode ssn, boolean flag) {
243 checkExpressionNode(md, nametable, ssn.getCondition(), flag);
245 BlockNode sbn = ssn.getSwitchBody();
246 for (int i = 0; i < sbn.size(); i++) {
247 checkBlockNode(md, nametable, ((SwitchBlockNode) sbn.get(i)).getSwitchBlockStatement(), flag);
252 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn,
254 if (dn.getExpression() != null) {
255 checkExpressionNode(md, nametable, dn.getExpression(), flag);
259 private void checkReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn,
261 if (rn.getReturnExpression() != null) {
262 if (md.getReturnType() != null) {
263 checkExpressionNode(md, nametable, rn.getReturnExpression(), flag);
268 private void checkLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln, boolean flag) {
269 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
270 checkExpressionNode(md, nametable, ln.getCondition(), flag);
271 checkBlockNode(md, nametable, ln.getBody(), flag);
274 /* Link in the initializer naming environment */
275 BlockNode bn = ln.getInitializer();
276 bn.getVarTable().setParent(nametable);
277 for (int i = 0; i < bn.size(); i++) {
278 BlockStatementNode bsn = bn.get(i);
279 checkBlockStatementNode(md, bn.getVarTable(), bsn, flag);
281 // check the condition
282 checkExpressionNode(md, bn.getVarTable(), ln.getCondition(), flag);
283 checkBlockNode(md, bn.getVarTable(), ln.getBody(), flag);
284 checkBlockNode(md, bn.getVarTable(), ln.getUpdate(), flag);
288 private void checkIfStatementNode(MethodDescriptor md, SymbolTable nametable,
289 IfStatementNode isn, boolean flag) {
290 checkExpressionNode(md, nametable, isn.getCondition(), flag);
291 checkBlockNode(md, nametable, isn.getTrueBlock(), flag);
292 if (isn.getFalseBlock() != null) {
293 checkBlockNode(md, nametable, isn.getFalseBlock(), flag);
297 private void checkSubBlockNode(MethodDescriptor md, SymbolTable nametable, SubBlockNode sbn,
299 checkBlockNode(md, nametable.getParent(), sbn.getBlockNode(), flag);
302 private void checkBlockExpressionNode(MethodDescriptor md, SymbolTable nametable,
303 BlockExpressionNode ben, boolean flag) {
304 checkExpressionNode(md, nametable, ben.getExpression(), flag);
307 private void checkExpressionNode(MethodDescriptor md, SymbolTable nametable, ExpressionNode en,
310 case Kind.AssignmentNode:
311 checkAssignmentNode(md, nametable, (AssignmentNode) en, flag);
315 checkCastNode(md, nametable, (CastNode) en, flag);
318 case Kind.CreateObjectNode:
319 checkCreateObjectNode(md, nametable, (CreateObjectNode) en, flag);
322 case Kind.FieldAccessNode:
323 checkFieldAccessNode(md, nametable, (FieldAccessNode) en, flag);
326 case Kind.ArrayAccessNode:
327 checkArrayAccessNode(md, nametable, (ArrayAccessNode) en, flag);
330 // case Kind.LiteralNode:
331 // checkLiteralNode(md, nametable, (LiteralNode) en, flag);
334 case Kind.MethodInvokeNode:
335 checkMethodInvokeNode(md, nametable, (MethodInvokeNode) en, flag);
338 // case Kind.NameNode:
339 // checkNameNode(md, nametable, (NameNode) en, flag);
343 checkOpNode(md, nametable, (OpNode) en, flag);
346 // case Kind.OffsetNode:
347 // checkOffsetNode(md, nametable, (OffsetNode) en, flag);
350 case Kind.TertiaryNode:
351 checkTertiaryNode(md, nametable, (TertiaryNode) en, flag);
354 case Kind.InstanceOfNode:
355 checkInstanceOfNode(md, nametable, (InstanceOfNode) en, flag);
358 case Kind.ArrayInitializerNode:
359 checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en, flag);
362 // case Kind.ClassTypeNode:
363 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, flag);
368 private void checkArrayInitializerNode(MethodDescriptor md, SymbolTable nametable,
369 ArrayInitializerNode ain, boolean flag) {
371 for (int i = 0; i < ain.numVarInitializers(); ++i) {
372 checkExpressionNode(md, nametable, ain.getVarInitializer(i), flag);
377 private void checkInstanceOfNode(MethodDescriptor md, SymbolTable nametable, InstanceOfNode tn,
379 checkExpressionNode(md, nametable, tn.getExpr(), flag);
382 private void checkTertiaryNode(MethodDescriptor md, SymbolTable nametable, TertiaryNode tn,
384 checkExpressionNode(md, nametable, tn.getCond(), flag);
385 checkExpressionNode(md, nametable, tn.getTrueExpr(), flag);
386 checkExpressionNode(md, nametable, tn.getFalseExpr(), flag);
389 private void checkOpNode(MethodDescriptor md, SymbolTable nametable, OpNode on, boolean flag) {
391 checkExpressionNode(md, nametable, on.getLeft(), flag);
392 if (on.getRight() != null) {
393 checkExpressionNode(md, nametable, on.getRight(), flag);
398 private void checkMethodInvokeNode(MethodDescriptor md, SymbolTable nametable,
399 MethodInvokeNode min, boolean flag) {
400 for (int i = 0; i < min.numArgs(); i++) {
401 ExpressionNode en = min.getArg(i);
402 checkExpressionNode(md, nametable, en, flag);
405 if (min.getExpression() != null) {
406 checkExpressionNode(md, nametable, min.getExpression(), flag);
410 annotatedMDSet.add(min.getMethod());
413 Set<MethodDescriptor> mdSet = caller2calleeSet.get(md);
415 mdSet = new HashSet<MethodDescriptor>();
416 caller2calleeSet.put(md, mdSet);
418 mdSet.add(min.getMethod());
422 private void checkArrayAccessNode(MethodDescriptor md, SymbolTable nametable,
423 ArrayAccessNode aan, boolean flag) {
425 ExpressionNode left = aan.getExpression();
426 checkExpressionNode(md, nametable, left, flag);
427 checkExpressionNode(md, nametable, aan.getIndex(), flag);
431 private void checkFieldAccessNode(MethodDescriptor md, SymbolTable nametable,
432 FieldAccessNode fan, boolean flag) {
433 ExpressionNode left = fan.getExpression();
434 checkExpressionNode(md, nametable, left, flag);
437 private void checkCreateObjectNode(MethodDescriptor md, SymbolTable nametable,
438 CreateObjectNode con, boolean flag) {
440 for (int i = 0; i < con.numArgs(); i++) {
441 ExpressionNode en = con.getArg(i);
442 checkExpressionNode(md, nametable, en, flag);
447 private void checkCastNode(MethodDescriptor md, SymbolTable nametable, CastNode cn, boolean flag) {
448 ExpressionNode en = cn.getExpression();
449 checkExpressionNode(md, nametable, en, flag);
452 private void checkAssignmentNode(MethodDescriptor md, SymbolTable nametable, AssignmentNode an,
454 boolean postinc = true;
456 if (an.getOperation().getBaseOp() == null
457 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
458 .getBaseOp().getOp() != Operation.POSTDEC))
462 checkExpressionNode(md, nametable, an.getSrc(), flag);
465 checkExpressionNode(md, nametable, an.getDest(), flag);