1 package Analysis.SSJava;
3 import java.util.HashSet;
4 import java.util.Hashtable;
5 import java.util.Iterator;
7 import java.util.Vector;
9 import IR.AnnotationDescriptor;
10 import IR.ClassDescriptor;
11 import IR.MethodDescriptor;
14 import IR.SymbolTable;
16 import IR.Tree.ArrayAccessNode;
17 import IR.Tree.ArrayInitializerNode;
18 import IR.Tree.AssignmentNode;
19 import IR.Tree.BlockExpressionNode;
20 import IR.Tree.BlockNode;
21 import IR.Tree.BlockStatementNode;
22 import IR.Tree.CastNode;
23 import IR.Tree.CreateObjectNode;
24 import IR.Tree.DeclarationNode;
25 import IR.Tree.ExpressionNode;
26 import IR.Tree.FieldAccessNode;
27 import IR.Tree.IfStatementNode;
28 import IR.Tree.InstanceOfNode;
30 import IR.Tree.LoopNode;
31 import IR.Tree.MethodInvokeNode;
32 import IR.Tree.OpNode;
33 import IR.Tree.ReturnNode;
34 import IR.Tree.SubBlockNode;
35 import IR.Tree.SwitchBlockNode;
36 import IR.Tree.SwitchStatementNode;
37 import IR.Tree.TertiaryNode;
40 public class MethodAnnotationCheck {
43 SSJavaAnalysis ssjava;
46 Set<MethodDescriptor> annotatedMDSet;
47 Hashtable<MethodDescriptor, Set<MethodDescriptor>> caller2calleeSet;
49 public MethodAnnotationCheck(SSJavaAnalysis ssjava, State state, TypeUtil tu) {
53 caller2calleeSet = new Hashtable<MethodDescriptor, Set<MethodDescriptor>>();
54 annotatedMDSet = new HashSet<MethodDescriptor>();
57 public void methodAnnoatationCheck() {
58 SymbolTable classtable = state.getClassSymbolTable();
59 HashSet toanalyze = new HashSet();
60 toanalyze.addAll(classtable.getValueSet());
61 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
62 while (!toanalyze.isEmpty()) {
63 Object obj = toanalyze.iterator().next();
64 ClassDescriptor cd = (ClassDescriptor) obj;
67 if (!cd.isInterface()) {
68 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
69 MethodDescriptor md = (MethodDescriptor) method_it.next();
70 checkTrustworthyMethodAnnotation(md);
71 checkMethodBody(cd, md);
77 for (Iterator iterator = annotatedMDSet.iterator(); iterator.hasNext();) {
78 MethodDescriptor md = (MethodDescriptor) iterator.next();
79 ssjava.addAnnotationRequire(md);
82 Set<Pair> visited = new HashSet<Pair>();
83 Set<MethodDescriptor> tovisit = new HashSet<MethodDescriptor>();
84 tovisit.addAll(annotatedMDSet);
86 while (!tovisit.isEmpty()) {
87 MethodDescriptor callerMD = tovisit.iterator().next();
88 tovisit.remove(callerMD);
90 Set<MethodDescriptor> calleeSet = caller2calleeSet.get(callerMD);
91 if (calleeSet != null) {
92 for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
93 MethodDescriptor calleeMD = (MethodDescriptor) iterator.next();
94 Pair p = new Pair(callerMD, calleeMD);
95 if (!visited.contains(p)) {
98 if (!ssjava.isTrustMethod(calleeMD)) {
99 // if method is annotated as "TRUST", do not need to check for
100 // linear type & flow-down rule
101 tovisit.add(calleeMD);
103 Set<MethodDescriptor> possibleCalleeSet =
104 (Set<MethodDescriptor>) ssjava.getCallGraph().getMethods(calleeMD);
106 for (Iterator iterator2 = possibleCalleeSet.iterator(); iterator2.hasNext();) {
107 MethodDescriptor possibleCallee = (MethodDescriptor) iterator2.next();
109 if (!possibleCallee.isAbstract() && !possibleCallee.getModifiers().isNative()) {
110 ssjava.addAnnotationRequire(possibleCallee);
111 tovisit.add(possibleCallee);
123 private void checkTrustworthyMethodAnnotation(MethodDescriptor md) {
124 // method annotation parsing
125 Vector<AnnotationDescriptor> methodAnnotations = md.getModifiers().getAnnotations();
126 if (methodAnnotations != null) {
127 for (int i = 0; i < methodAnnotations.size(); i++) {
128 AnnotationDescriptor an = methodAnnotations.elementAt(i);
129 if (an.getMarker().equals(ssjava.TRUST)) {
130 ssjava.addTrustMethod(md);
136 public void methodAnnoataionInheritanceCheck() {
137 // check If a method is annotated, any method that overrides it should
140 Set<MethodDescriptor> tovisit = new HashSet<MethodDescriptor>();
141 tovisit.addAll(ssjava.getAnnotationRequireSet());
143 while (!tovisit.isEmpty()) {
144 MethodDescriptor md = tovisit.iterator().next();
147 ClassDescriptor cd = md.getClassDesc();
149 Set subClassSet = tu.getSubClasses(cd);
150 if (subClassSet != null) {
151 for (Iterator iterator2 = subClassSet.iterator(); iterator2.hasNext();) {
152 ClassDescriptor subCD = (ClassDescriptor) iterator2.next();
153 Set possiblematches = subCD.getMethodTable().getSet(md.getSymbol());
154 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
155 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
156 if (md.matches(matchmd)) {
157 if (matchmd.getClassDesc().equals(subCD)) {
158 ssjava.addAnnotationRequire(matchmd);
165 // need to check super classess if the current method is inherited from
166 // them, all of ancestor method should be annotated.
168 ClassDescriptor curClassDesc;
169 ClassDescriptor parentClassDesc = cd;
171 while (!parentClassDesc.getSymbol().equals("Object")) {
172 curClassDesc = parentClassDesc;
173 parentClassDesc = tu.getSuper(curClassDesc);
174 Set possiblematches = parentClassDesc.getMethodTable().getSet(md.getSymbol());
175 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
176 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
177 if (md.matches(matchmd)) {
178 ssjava.addAnnotationRequire(matchmd);
183 Set<ClassDescriptor> superIFSet = tu.getSuperIFs(cd);
184 for (Iterator iterator = superIFSet.iterator(); iterator.hasNext();) {
185 ClassDescriptor parentInterface = (ClassDescriptor) iterator.next();
186 Set possiblematches = parentInterface.getMethodTable().getSet(md.getSymbol());
187 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
188 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
189 if (md.matches(matchmd)) {
190 ssjava.addAnnotationRequire(matchmd);
199 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
200 BlockNode bn = state.getMethodBody(md);
201 checkBlockNode(md, md.getParameterTable(), bn, false);
204 private void checkBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn, boolean flag) {
205 bn.getVarTable().setParent(nametable);
207 for (int i = 0; i < bn.size(); i++) {
208 BlockStatementNode bsn = bn.get(i);
209 checkBlockStatementNode(md, bn.getVarTable(), bsn, flag);
214 private void checkBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
215 BlockStatementNode bsn, boolean flag) {
217 switch (bsn.kind()) {
218 case Kind.SubBlockNode:
219 checkSubBlockNode(md, nametable, (SubBlockNode) bsn, flag);
222 case Kind.BlockExpressionNode:
223 checkBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, flag);
226 case Kind.DeclarationNode:
227 checkDeclarationNode(md, nametable, (DeclarationNode) bsn, flag);
230 case Kind.IfStatementNode:
231 checkIfStatementNode(md, nametable, (IfStatementNode) bsn, flag);
235 checkLoopNode(md, nametable, (LoopNode) bsn, flag);
238 case Kind.ReturnNode:
239 checkReturnNode(md, nametable, (ReturnNode) bsn, flag);
242 case Kind.SwitchStatementNode:
243 checkSwitchStatementNode(md, nametable, (SwitchStatementNode) bsn, flag);
249 private void checkSwitchStatementNode(MethodDescriptor md, SymbolTable nametable,
250 SwitchStatementNode ssn, boolean flag) {
252 checkExpressionNode(md, nametable, ssn.getCondition(), flag);
254 BlockNode sbn = ssn.getSwitchBody();
255 for (int i = 0; i < sbn.size(); i++) {
256 checkBlockNode(md, nametable, ((SwitchBlockNode) sbn.get(i)).getSwitchBlockStatement(), flag);
261 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn,
263 if (dn.getExpression() != null) {
264 checkExpressionNode(md, nametable, dn.getExpression(), flag);
268 private void checkReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn,
270 if (rn.getReturnExpression() != null) {
271 if (md.getReturnType() != null) {
272 checkExpressionNode(md, nametable, rn.getReturnExpression(), flag);
277 private void checkLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln, boolean flag) {
279 String label = ln.getLabel();
280 boolean isSSJavaLoop = flag;
281 if (label != null && label.equals(ssjava.SSJAVA)) {
283 throw new Error("Only outermost loop can be the self-stabilizing loop.");
285 annotatedMDSet.add(md);
290 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
291 checkExpressionNode(md, nametable, ln.getCondition(), isSSJavaLoop);
292 checkBlockNode(md, nametable, ln.getBody(), isSSJavaLoop);
295 /* Link in the initializer naming environment */
296 BlockNode bn = ln.getInitializer();
297 bn.getVarTable().setParent(nametable);
298 for (int i = 0; i < bn.size(); i++) {
299 BlockStatementNode bsn = bn.get(i);
300 checkBlockStatementNode(md, bn.getVarTable(), bsn, isSSJavaLoop);
302 // check the condition
303 checkExpressionNode(md, bn.getVarTable(), ln.getCondition(), isSSJavaLoop);
304 checkBlockNode(md, bn.getVarTable(), ln.getBody(), isSSJavaLoop);
305 checkBlockNode(md, bn.getVarTable(), ln.getUpdate(), isSSJavaLoop);
309 private void checkIfStatementNode(MethodDescriptor md, SymbolTable nametable,
310 IfStatementNode isn, boolean flag) {
311 checkExpressionNode(md, nametable, isn.getCondition(), flag);
312 checkBlockNode(md, nametable, isn.getTrueBlock(), flag);
313 if (isn.getFalseBlock() != null) {
314 checkBlockNode(md, nametable, isn.getFalseBlock(), flag);
318 private void checkSubBlockNode(MethodDescriptor md, SymbolTable nametable, SubBlockNode sbn,
320 checkBlockNode(md, nametable.getParent(), sbn.getBlockNode(), flag);
323 private void checkBlockExpressionNode(MethodDescriptor md, SymbolTable nametable,
324 BlockExpressionNode ben, boolean flag) {
325 checkExpressionNode(md, nametable, ben.getExpression(), flag);
328 private void checkExpressionNode(MethodDescriptor md, SymbolTable nametable, ExpressionNode en,
331 case Kind.AssignmentNode:
332 checkAssignmentNode(md, nametable, (AssignmentNode) en, flag);
336 checkCastNode(md, nametable, (CastNode) en, flag);
339 case Kind.CreateObjectNode:
340 checkCreateObjectNode(md, nametable, (CreateObjectNode) en, flag);
343 case Kind.FieldAccessNode:
344 checkFieldAccessNode(md, nametable, (FieldAccessNode) en, flag);
347 case Kind.ArrayAccessNode:
348 checkArrayAccessNode(md, nametable, (ArrayAccessNode) en, flag);
351 // case Kind.LiteralNode:
352 // checkLiteralNode(md, nametable, (LiteralNode) en, flag);
355 case Kind.MethodInvokeNode:
356 checkMethodInvokeNode(md, nametable, (MethodInvokeNode) en, flag);
359 // case Kind.NameNode:
360 // checkNameNode(md, nametable, (NameNode) en, flag);
364 checkOpNode(md, nametable, (OpNode) en, flag);
367 // case Kind.OffsetNode:
368 // checkOffsetNode(md, nametable, (OffsetNode) en, flag);
371 case Kind.TertiaryNode:
372 checkTertiaryNode(md, nametable, (TertiaryNode) en, flag);
375 case Kind.InstanceOfNode:
376 checkInstanceOfNode(md, nametable, (InstanceOfNode) en, flag);
379 case Kind.ArrayInitializerNode:
380 checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en, flag);
383 // case Kind.ClassTypeNode:
384 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, flag);
389 private void checkArrayInitializerNode(MethodDescriptor md, SymbolTable nametable,
390 ArrayInitializerNode ain, boolean flag) {
392 for (int i = 0; i < ain.numVarInitializers(); ++i) {
393 checkExpressionNode(md, nametable, ain.getVarInitializer(i), flag);
398 private void checkInstanceOfNode(MethodDescriptor md, SymbolTable nametable, InstanceOfNode tn,
400 checkExpressionNode(md, nametable, tn.getExpr(), flag);
403 private void checkTertiaryNode(MethodDescriptor md, SymbolTable nametable, TertiaryNode tn,
405 checkExpressionNode(md, nametable, tn.getCond(), flag);
406 checkExpressionNode(md, nametable, tn.getTrueExpr(), flag);
407 checkExpressionNode(md, nametable, tn.getFalseExpr(), flag);
410 private void checkOpNode(MethodDescriptor md, SymbolTable nametable, OpNode on, boolean flag) {
412 checkExpressionNode(md, nametable, on.getLeft(), flag);
413 if (on.getRight() != null) {
414 checkExpressionNode(md, nametable, on.getRight(), flag);
419 private void checkMethodInvokeNode(MethodDescriptor md, SymbolTable nametable,
420 MethodInvokeNode min, boolean flag) {
421 for (int i = 0; i < min.numArgs(); i++) {
422 ExpressionNode en = min.getArg(i);
423 checkExpressionNode(md, nametable, en, flag);
426 if (min.getExpression() != null) {
427 checkExpressionNode(md, nametable, min.getExpression(), flag);
431 annotatedMDSet.add(min.getMethod());
434 Set<MethodDescriptor> mdSet = caller2calleeSet.get(md);
436 mdSet = new HashSet<MethodDescriptor>();
437 caller2calleeSet.put(md, mdSet);
439 mdSet.add(min.getMethod());
443 private void checkArrayAccessNode(MethodDescriptor md, SymbolTable nametable,
444 ArrayAccessNode aan, boolean flag) {
446 ExpressionNode left = aan.getExpression();
447 checkExpressionNode(md, nametable, left, flag);
448 checkExpressionNode(md, nametable, aan.getIndex(), flag);
452 private void checkFieldAccessNode(MethodDescriptor md, SymbolTable nametable,
453 FieldAccessNode fan, boolean flag) {
454 ExpressionNode left = fan.getExpression();
455 checkExpressionNode(md, nametable, left, flag);
458 private void checkCreateObjectNode(MethodDescriptor md, SymbolTable nametable,
459 CreateObjectNode con, boolean flag) {
461 for (int i = 0; i < con.numArgs(); i++) {
462 ExpressionNode en = con.getArg(i);
463 checkExpressionNode(md, nametable, en, flag);
468 private void checkCastNode(MethodDescriptor md, SymbolTable nametable, CastNode cn, boolean flag) {
469 ExpressionNode en = cn.getExpression();
470 checkExpressionNode(md, nametable, en, flag);
473 private void checkAssignmentNode(MethodDescriptor md, SymbolTable nametable, AssignmentNode an,
475 boolean postinc = true;
477 if (an.getOperation().getBaseOp() == null
478 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
479 .getBaseOp().getOp() != Operation.POSTDEC))
483 checkExpressionNode(md, nametable, an.getSrc(), flag);
486 checkExpressionNode(md, nametable, an.getDest(), flag);