Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * fb-contrib - Auxiliary detectors for Java programs
   * Copyright (C) 2005-2014 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.Constants;
 import  org.apache.bcel.classfile.Code;
 import  org.apache.bcel.classfile.Method;
 import  org.apache.bcel.generic.Type;
 
 
looks for methods that use an array of length one to pass a variable to achieve call by pointer ala C++. It is better to define a proper return class type that holds all the relevant information retrieved from the called method.
 
 public class ArrayWrappedCallByReference extends BytecodeScanningDetector {
 	
 	static class WrapperInfo {
 		public int wrappedReg;
 		public boolean wasArg;
 		
 		public WrapperInfo(int reg) {
 			 = reg;
 			 = false;
 		}
 	}
 	
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;
 	private Map<IntegerWrapperInfowrappers;

    
constructs a AWCBR detector given the reporter to report bugs on

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

implement the visitor to create and clear the stack and wrappers

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

    
looks for methods that contain a NEWARRAY or ANEWARRAY opcodes

Parameters:
method the context object of the current method
Returns:
if the class uses synchronization
 
 	public boolean prescreen(Method method) {
 		BitSet bytecodeSet = getClassContext().getBytecodeSet(method);
 		return (bytecodeSet != null) && (bytecodeSet.get(Constants.NEWARRAY) || bytecodeSet.get(Constants.ANEWARRAY));
 	}

implements the visitor to reset the stack of opcodes

Parameters:
obj the context object for the currently parsed code block
	public void visitCode(Code obj) {
		if (prescreen(getMethod())) {
			super.visitCode(obj);
		}
	}

implements the visitor to wrapped array parameter calls

Parameters:
seen the currently visitor opcode
	public void sawOpcode(int seen) {
		Integer userValue = null;
		try {
	        .precomputation(this);
			switch (seen) {
				case NEWARRAY:
				case ANEWARRAY: {
					if (.getStackDepth() > 0) {
						Integer size = (Integer)itm.getConstant();
						if ((size != null) && (size.intValue() == 1)) {
							userValue = Integer.valueOf(-1);
						}
					}
				}
				break;
				case IASTORE:
				case LASTORE:
				case FASTORE:
				case DASTORE:
				case AASTORE:
				case BASTORE:
				case CASTORE:	
				case SASTORE: {
					if (.getStackDepth() >= 2) {
						int reg = itm.getRegisterNumber();
						if (reg != -1) {
							WrapperInfo wi = .get(Integer.valueOf(reg));
							if (wi != null) {
								wi.wrappedReg = elItm.getRegisterNumber();
							}
else {
							if (elItm.getRegisterNumber() != -1)
								userValue = Integer.valueOf(elItm.getRegisterNumber());
						}
					}
				}
				break;
				case ASTORE:
				case ASTORE_0:
				case ASTORE_1:
				case ASTORE_2:
				case ASTORE_3: {
					if (.getStackDepth() >= 1) {
						String sig = itm.getSignature();
						if ((sig.length() > 0) && (itm.getSignature().charAt(0) == '[')) {
							int reg = RegisterUtils.getAStoreReg(thisseen);
							Integer elReg = (Integer)itm.getUserValue();
							if (elReg != null)
								.put(Integer.valueOf(reg), new WrapperInfo(elReg.intValue()));
else {
							Integer elReg = (Integer)itm.getUserValue();
							if (elReg != null) {
								int reg = RegisterUtils.getAStoreReg(thisseen);
								if (elReg.intValue() == reg) {
									.reportBug(new BugInstance(this"AWCBR_ARRAY_WRAPPED_CALL_BY_REFERENCE", NORMAL_PRIORITY )
													.addClass(this)
													.addMethod(this)
													.addSourceLine(this));
								}
							}
						}
					}
				}
				break;
				case INVOKEVIRTUAL:
				case INVOKEINTERFACE:
				case INVOKESPECIAL:
				case INVOKESTATIC: {
					Type[] args = Type.getArgumentTypes(sig);
					if (.getStackDepth() >= args.length) {
						for (int i = 0; i < args.length; i++) {
							Type t = args[i];
							String argSig = t.getSignature();
							if ((argSig.length() > 0) && (argSig.charAt(0) == '[')) {
								OpcodeStack.Item itm = .getStackItem(args.length - i - 1);
								int arrayReg = itm.getRegisterNumber();
								WrapperInfo wi = .get(Integer.valueOf(arrayReg));
								if (wi != null)
									wi.wasArg = true;
							}
						}
					}
				}
				break;
				case IALOAD:
				case LALOAD:
				case FALOAD:
				case DALOAD:
				case AALOAD:
				case BALOAD:
				case CALOAD:
				case SALOAD: {
					if (.getStackDepth() >= 2) {
						int arReg = arItm.getRegisterNumber();
						WrapperInfo wi = .get(Integer.valueOf(arReg));
						if ((wi != null) && wi.wasArg) {
							userValue = Integer.valueOf(wi.wrappedReg);
						}
					}
				}
				break;
				case ALOAD:
				case ALOAD_0:
				case ALOAD_1:
				case ALOAD_2:
				case ALOAD_3: {
					int reg = RegisterUtils.getALoadReg(thisseen);
					WrapperInfo wi = .get(Integer.valueOf(reg));
					if (wi != null)
						userValue = Integer.valueOf(wi.wrappedReg);
				}
				break;
				case ISTORE:
				case ISTORE_0:
				case ISTORE_1:
				case ISTORE_2:
				case ISTORE_3:
				case LSTORE:
				case LSTORE_0:
				case LSTORE_1:
				case LSTORE_2:
				case LSTORE_3:	
				case DSTORE:
				case DSTORE_0:
				case DSTORE_1:
				case DSTORE_2:
				case DSTORE_3:
				case FSTORE:
				case FSTORE_0:
				case FSTORE_1:
				case FSTORE_2:
				case FSTORE_3: {
					if (.getStackDepth() >= 1) {
						Integer elReg = (Integer)itm.getUserValue();
						if (elReg != null) {
							int reg = RegisterUtils.getStoreReg(thisseen);
							if (elReg.intValue() == reg) {
								.reportBug(new BugInstance(this"AWCBR_ARRAY_WRAPPED_CALL_BY_REFERENCE", NORMAL_PRIORITY )
												.addClass(this)
												.addMethod(this)
												.addSourceLine(this));
							}
						}
					}
				}
				break;
			}
finally {
			TernaryPatcher.pre(seen);
			.sawOpcode(thisseen);
			TernaryPatcher.post(seen);
			if (userValue != null) {
				if (.getStackDepth() > 0) {
					itm.setUserValue(userValue);
				}
			}
		}
	}	
New to GrepCode? Check out our FAQ X