Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * fb-contrib - Auxiliary detectors for Java programs
   * Copyright (C) 2005-2013 Dave Brosius
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 package com.mebigfatguy.fbcontrib.detect;
 
 import java.util.Map;
 
 import  org.apache.bcel.classfile.Code;
 
 
 import  edu.umd.cs.findbugs.BugInstance;
 import  edu.umd.cs.findbugs.BugReporter;
 import  edu.umd.cs.findbugs.BytecodeScanningDetector;
 import  edu.umd.cs.findbugs.OpcodeStack;
 import  edu.umd.cs.findbugs.ba.ClassContext;
 import  edu.umd.cs.findbugs.ba.XField;

looks for code that checks to see if a field or local variable is not null, before entering a code block either an if, or while statement, and reassigns that field or variable. It seems that perhaps the guard should check if the field or variable is null.
 
 public class SuspiciousNullGuard extends BytecodeScanningDetector {
 
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;
 	private Map<IntegerNullGuardnullGuards;

constructs a SNG detector given the reporter to report bugs on

Parameters:
bugReporter the sync of bug reports
 
 	public SuspiciousNullGuard(BugReporter bugReporter) {
 		this. = bugReporter;
 	}

overrides the visitor to initialize and tear down the opcode stack

Parameters:
classContext the context object of the currently parsed class
 
 	public void visitClassContext(ClassContext classContext) {
 		try {
 			 = new OpcodeStack();
 			super.visitClassContext(classContext);
 		} finally {
 			 = null;
 		}
 	}

overrides the visitor to reset the stack

Parameters:
obj the context object of the currently parsed code block
 
 	public void visitCode(Code obj) {
 		.resetForMethodEntry(this);
 		super.visitCode(obj);
 	}

overrides the visitor to look for bad null guards

Parameters:
seen the opcode of the currently visited instruction
 
 	public void sawOpcode(int seen) {
 		try {
 			Integer pc = Integer.valueOf(getPC());
 
 			switch (seen) {
 				case IFNULL: {
 					if (.getStackDepth() > 0) {
 						OpcodeStack.Item item = .getStackItem(0);
 						int reg = item.getRegisterNumber();
						Integer target = Integer.valueOf(getBranchTarget());
						if (reg >= 0) {
							.put(targetnew NullGuard(regpc.intValue(), item.getSignature()));
else {
							XField xf = item.getXField();
							if (xf != null) {
								.put(targetnew NullGuard(xfpc.intValue(), item.getSignature()));
							}
						}
					}
				}
				break;
				case ASTORE:
				case ASTORE_0:
				case ASTORE_1:
				case ASTORE_2:
				case ASTORE_3: {
					if (.getStackDepth() > 0) {
						OpcodeStack.Item item = .getStackItem(0);
						if (!item.isNull()) {
							NullGuard guard = findNullGuardWithRegister(RegisterUtils.getAStoreReg(thisseen));
							if (guard != null) {
								.reportBug(new BugInstance(this"SNG_SUSPICIOUS_NULL_LOCAL_GUARD", NORMAL_PRIORITY)
															.addClass(this)
															.addMethod(this)
															.addSourceLine(this));
							}
						}
					}
				}
				break;
				case ALOAD:
				case ALOAD_0:
				case ALOAD_1:
				case ALOAD_2:
				case ALOAD_3: {
					NullGuard guard = findNullGuardWithRegister(RegisterUtils.getALoadReg(thisseen));
					if (guard != null) {
					}
				}
				break;
				case PUTFIELD: {
					if (.getStackDepth() > 1) {
						OpcodeStack.Item item = .getStackItem(0);
						if (!item.isNull()) {
							XField xf = getXFieldOperand();
							if (xf != null) {
								if (guard != null) {
									.reportBug(new BugInstance(this"SNG_SUSPICIOUS_NULL_FIELD_GUARD", NORMAL_PRIORITY)
																.addClass(this)
																.addMethod(this)
																.addSourceLine(this));
								}
							}
						}
					}
				}
				break;
				case GETFIELD: {
					if (.getStackDepth() > 0) {
						XField xf = getXFieldOperand();
						if (xf != null) {
							if (guard != null) {
							}
						}
					}
				}
				break;
				case IFEQ:
				case IFNE:
				case IFLT:
				case IFGE:
				case IFGT:
				case IFLE:
				case IF_ICMPEQ:
				case IF_ICMPNE:
				case IF_ICMPLT:
				case IF_ICMPGE:
				case IF_ICMPGT:
				case IF_ICMPLE:
				case IF_ACMPEQ:
				case IF_ACMPNE:
				case GOTO:
				case GOTO_W:
				case IFNONNULL:
				break;
			}
finally {
			.sawOpcode(thisseen);
		}
	}
	private NullGuard findNullGuardWithRegister(int reg) {
		for (NullGuard guard : .values()) {
			if (guard.getRegister() == reg) {
				return guard;
			}
		}
		return null;
	}
	private NullGuard findNullGuardWithField(XField field) {
		for (NullGuard guard : .values()) {
			if (field.equals(guard.getField())) {
				return guard;
			}
		}
		return null;
	}
	private void removeNullGuard(NullGuard guard) {
		while (it.hasNext()) {
			NullGuard potentialNG = it.next();
			if (potentialNG.equals(guard)) {
				it.remove();
				break;
			}
		}
	}
	static class NullGuard {
		XField field;
		public NullGuard(int regint startString guardSignature) {
			 = reg;
			 = null;
			 = start;
			 = guardSignature;
		}
		public NullGuard(XField xfint startString guardSignature) {
			 = -1;
			 = xf;
			 = start;
			 = guardSignature;
		}
		public int getRegister() {
			return ;
		}
		public XField getField() {
			return ;
		}
		public int getLocation() {
			return ;
		}
		public String getSignature() {
			return ;
		}
	}
New to GrepCode? Check out our FAQ X