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.TertiaryNode;
36 public class MethodAnnotationCheck {
39 SSJavaAnalysis ssjava;
42 Set<MethodDescriptor> annotatedMDSet;
43 Hashtable<MethodDescriptor, Set<MethodDescriptor>> caller2calleeSet;
45 public MethodAnnotationCheck(SSJavaAnalysis ssjava, State state, TypeUtil tu) {
49 caller2calleeSet = new Hashtable<MethodDescriptor, Set<MethodDescriptor>>();
50 annotatedMDSet = new HashSet<MethodDescriptor>();
53 public void methodAnnoatationCheck() {
54 SymbolTable classtable = state.getClassSymbolTable();
55 HashSet toanalyze = new HashSet();
56 toanalyze.addAll(classtable.getValueSet());
57 toanalyze.addAll(state.getTaskSymbolTable().getValueSet());
58 while (!toanalyze.isEmpty()) {
59 Object obj = toanalyze.iterator().next();
60 ClassDescriptor cd = (ClassDescriptor) obj;
63 if (!cd.isInterface()) {
64 for (Iterator method_it = cd.getMethods(); method_it.hasNext();) {
65 MethodDescriptor md = (MethodDescriptor) method_it.next();
66 checkMethodBody(cd, md);
72 for (Iterator iterator = annotatedMDSet.iterator(); iterator.hasNext();) {
73 MethodDescriptor md = (MethodDescriptor) iterator.next();
74 ssjava.putNeedAnnotation(md);
77 Set<Pair> visited = new HashSet<Pair>();
78 Set<MethodDescriptor> tovisit = new HashSet<MethodDescriptor>();
79 tovisit.addAll(annotatedMDSet);
81 while (!tovisit.isEmpty()) {
82 MethodDescriptor callerMD = tovisit.iterator().next();
83 tovisit.remove(callerMD);
84 Set<MethodDescriptor> calleeSet = caller2calleeSet.get(callerMD);
85 if (calleeSet != null) {
86 for (Iterator iterator = calleeSet.iterator(); iterator.hasNext();) {
87 MethodDescriptor calleeMD = (MethodDescriptor) iterator.next();
88 Pair p = new Pair(callerMD, calleeMD);
89 if (!visited.contains(p)) {
91 tovisit.add(calleeMD);
92 ssjava.putNeedAnnotation(calleeMD);
100 public void methodAnnoataionInheritanceCheck() {
101 // check If a method is annotated, any method that overrides it should
104 Set<MethodDescriptor> tovisit = new HashSet<MethodDescriptor>();
105 tovisit.addAll(ssjava.getMd2hasAnnotation().keySet());
107 while (!tovisit.isEmpty()) {
108 MethodDescriptor md = tovisit.iterator().next();
111 ClassDescriptor cd = md.getClassDesc();
113 Set subClassSet = tu.getSubClasses(cd);
114 if (subClassSet != null) {
115 for (Iterator iterator2 = subClassSet.iterator(); iterator2.hasNext();) {
116 ClassDescriptor subCD = (ClassDescriptor) iterator2.next();
117 Set possiblematches = subCD.getMethodTable().getSet(md.getSymbol());
118 for (Iterator methodit = possiblematches.iterator(); methodit.hasNext();) {
119 MethodDescriptor matchmd = (MethodDescriptor) methodit.next();
120 if (md.matches(matchmd)) {
121 if (matchmd.getClassDesc().equals(subCD)) {
122 ssjava.putNeedAnnotation(matchmd);
132 private void checkMethodBody(ClassDescriptor cd, MethodDescriptor md) {
133 BlockNode bn = state.getMethodBody(md);
134 checkBlockNode(md, md.getParameterTable(), bn, false);
137 private void checkBlockNode(MethodDescriptor md, SymbolTable nametable, BlockNode bn, boolean flag) {
138 bn.getVarTable().setParent(nametable);
139 String label = bn.getLabel();
140 boolean isSSJavaLoop = flag;
141 if (label != null && label.equals(ssjava.SSJAVA)) {
143 throw new Error("Only outermost loop can be the self-stabilizing loop.");
145 annotatedMDSet.add(md);
150 for (int i = 0; i < bn.size(); i++) {
151 BlockStatementNode bsn = bn.get(i);
152 checkBlockStatementNode(md, bn.getVarTable(), bsn, isSSJavaLoop);
157 private void checkBlockStatementNode(MethodDescriptor md, SymbolTable nametable,
158 BlockStatementNode bsn, boolean flag) {
160 switch (bsn.kind()) {
161 case Kind.SubBlockNode:
162 checkSubBlockNode(md, nametable, (SubBlockNode) bsn, flag);
165 case Kind.BlockExpressionNode:
166 checkBlockExpressionNode(md, nametable, (BlockExpressionNode) bsn, flag);
169 case Kind.DeclarationNode:
170 checkDeclarationNode(md, nametable, (DeclarationNode) bsn, flag);
173 case Kind.IfStatementNode:
174 checkIfStatementNode(md, nametable, (IfStatementNode) bsn, flag);
178 checkLoopNode(md, nametable, (LoopNode) bsn, flag);
181 case Kind.ReturnNode:
182 checkReturnNode(md, nametable, (ReturnNode) bsn, flag);
188 private void checkDeclarationNode(MethodDescriptor md, SymbolTable nametable, DeclarationNode dn,
190 if (dn.getExpression() != null) {
191 checkExpressionNode(md, nametable, dn.getExpression(), flag);
195 private void checkReturnNode(MethodDescriptor md, SymbolTable nametable, ReturnNode rn,
197 if (rn.getReturnExpression() != null) {
198 if (md.getReturnType() != null) {
199 checkExpressionNode(md, nametable, rn.getReturnExpression(), flag);
204 private void checkLoopNode(MethodDescriptor md, SymbolTable nametable, LoopNode ln, boolean flag) {
205 if (ln.getType() == LoopNode.WHILELOOP || ln.getType() == LoopNode.DOWHILELOOP) {
206 checkExpressionNode(md, nametable, ln.getCondition(), flag);
207 checkBlockNode(md, nametable, ln.getBody(), flag);
210 /* Link in the initializer naming environment */
211 BlockNode bn = ln.getInitializer();
212 bn.getVarTable().setParent(nametable);
213 for (int i = 0; i < bn.size(); i++) {
214 BlockStatementNode bsn = bn.get(i);
215 checkBlockStatementNode(md, bn.getVarTable(), bsn, flag);
217 // check the condition
218 checkExpressionNode(md, bn.getVarTable(), ln.getCondition(), flag);
219 checkBlockNode(md, bn.getVarTable(), ln.getBody(), flag);
220 checkBlockNode(md, bn.getVarTable(), ln.getUpdate(), flag);
224 private void checkIfStatementNode(MethodDescriptor md, SymbolTable nametable,
225 IfStatementNode isn, boolean flag) {
226 checkExpressionNode(md, nametable, isn.getCondition(), flag);
227 checkBlockNode(md, nametable, isn.getTrueBlock(), flag);
228 if (isn.getFalseBlock() != null) {
229 checkBlockNode(md, nametable, isn.getFalseBlock(), flag);
233 private void checkSubBlockNode(MethodDescriptor md, SymbolTable nametable, SubBlockNode sbn,
235 checkBlockNode(md, nametable.getParent(), sbn.getBlockNode(), flag);
238 private void checkBlockExpressionNode(MethodDescriptor md, SymbolTable nametable,
239 BlockExpressionNode ben, boolean flag) {
240 checkExpressionNode(md, nametable, ben.getExpression(), flag);
243 private void checkExpressionNode(MethodDescriptor md, SymbolTable nametable, ExpressionNode en,
246 case Kind.AssignmentNode:
247 checkAssignmentNode(md, nametable, (AssignmentNode) en, flag);
251 checkCastNode(md, nametable, (CastNode) en, flag);
254 case Kind.CreateObjectNode:
255 checkCreateObjectNode(md, nametable, (CreateObjectNode) en, flag);
258 case Kind.FieldAccessNode:
259 checkFieldAccessNode(md, nametable, (FieldAccessNode) en, flag);
262 case Kind.ArrayAccessNode:
263 checkArrayAccessNode(md, nametable, (ArrayAccessNode) en, flag);
266 // case Kind.LiteralNode:
267 // checkLiteralNode(md, nametable, (LiteralNode) en, flag);
270 case Kind.MethodInvokeNode:
271 checkMethodInvokeNode(md, nametable, (MethodInvokeNode) en, flag);
274 // case Kind.NameNode:
275 // checkNameNode(md, nametable, (NameNode) en, flag);
279 checkOpNode(md, nametable, (OpNode) en, flag);
282 // case Kind.OffsetNode:
283 // checkOffsetNode(md, nametable, (OffsetNode) en, flag);
286 case Kind.TertiaryNode:
287 checkTertiaryNode(md, nametable, (TertiaryNode) en, flag);
290 case Kind.InstanceOfNode:
291 checkInstanceOfNode(md, nametable, (InstanceOfNode) en, flag);
294 case Kind.ArrayInitializerNode:
295 checkArrayInitializerNode(md, nametable, (ArrayInitializerNode) en, flag);
298 // case Kind.ClassTypeNode:
299 // checkClassTypeNode(md, nametable, (ClassTypeNode) en, flag);
304 private void checkArrayInitializerNode(MethodDescriptor md, SymbolTable nametable,
305 ArrayInitializerNode ain, boolean flag) {
307 for (int i = 0; i < ain.numVarInitializers(); ++i) {
308 checkExpressionNode(md, nametable, ain.getVarInitializer(i), flag);
313 private void checkInstanceOfNode(MethodDescriptor md, SymbolTable nametable, InstanceOfNode tn,
315 checkExpressionNode(md, nametable, tn.getExpr(), flag);
318 private void checkTertiaryNode(MethodDescriptor md, SymbolTable nametable, TertiaryNode tn,
320 checkExpressionNode(md, nametable, tn.getCond(), flag);
321 checkExpressionNode(md, nametable, tn.getTrueExpr(), flag);
322 checkExpressionNode(md, nametable, tn.getFalseExpr(), flag);
325 private void checkOpNode(MethodDescriptor md, SymbolTable nametable, OpNode on, boolean flag) {
327 checkExpressionNode(md, nametable, on.getLeft(), flag);
328 if (on.getRight() != null) {
329 checkExpressionNode(md, nametable, on.getRight(), flag);
334 private void checkMethodInvokeNode(MethodDescriptor md, SymbolTable nametable,
335 MethodInvokeNode min, boolean flag) {
336 for (int i = 0; i < min.numArgs(); i++) {
337 ExpressionNode en = min.getArg(i);
338 checkExpressionNode(md, nametable, en, flag);
341 if (min.getExpression() != null) {
342 checkExpressionNode(md, nametable, min.getExpression(), flag);
346 annotatedMDSet.add(min.getMethod());
349 Set<MethodDescriptor> mdSet = caller2calleeSet.get(md);
351 mdSet = new HashSet<MethodDescriptor>();
352 caller2calleeSet.put(md, mdSet);
354 mdSet.add(min.getMethod());
358 private void checkArrayAccessNode(MethodDescriptor md, SymbolTable nametable,
359 ArrayAccessNode aan, boolean flag) {
361 ExpressionNode left = aan.getExpression();
362 checkExpressionNode(md, nametable, left, flag);
363 checkExpressionNode(md, nametable, aan.getIndex(), flag);
367 private void checkFieldAccessNode(MethodDescriptor md, SymbolTable nametable,
368 FieldAccessNode fan, boolean flag) {
369 ExpressionNode left = fan.getExpression();
370 checkExpressionNode(md, nametable, left, flag);
373 private void checkCreateObjectNode(MethodDescriptor md, SymbolTable nametable,
374 CreateObjectNode con, boolean flag) {
376 for (int i = 0; i < con.numArgs(); i++) {
377 ExpressionNode en = con.getArg(i);
378 checkExpressionNode(md, nametable, en, flag);
383 private void checkCastNode(MethodDescriptor md, SymbolTable nametable, CastNode cn, boolean flag) {
384 ExpressionNode en = cn.getExpression();
385 checkExpressionNode(md, nametable, en, flag);
388 private void checkAssignmentNode(MethodDescriptor md, SymbolTable nametable, AssignmentNode an,
390 boolean postinc = true;
392 if (an.getOperation().getBaseOp() == null
393 || (an.getOperation().getBaseOp().getOp() != Operation.POSTINC && an.getOperation()
394 .getBaseOp().getOp() != Operation.POSTDEC))
398 checkExpressionNode(md, nametable, an.getSrc(), flag);
401 checkExpressionNode(md, nametable, an.getDest(), flag);