Class FindImproperSynchronization

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

edu.umd.cs.findbugs.visitclass.DismantleBytecode

edu.umd.cs.findbugs.BytecodeScanningDetector

edu.umd.cs.findbugs.bcel.OpcodeStackDetector

edu.umd.cs.findbugs.detect.FindImproperSynchronization

All Implemented Interfaces:

Detector, Priorities, org.apache.bcel.classfile.Visitor

public class FindImproperSynchronization
extends OpcodeStackDetector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FindImproperSynchronization.BugInfo

Nested classes/interfaces inherited from class OpcodeStackDetector

OpcodeStackDetector.WithCustomJumpInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final MultiMap<XField,XField>	backingCollections
private final Set<XField>	badBackingCollections
private final BugReporter	bugReporter
private final MultiMap<XField,XMethod>	collectionAccessorsInHierarchy
private final MultiMap<XField,XMethod>	declaredCollectionAccessors
private final MultiMap<XField, FindImproperSynchronization.BugInfo>	declaredCollectionLockObjects
private final MultiMap<XField,XMethod>	declaredInheritedFieldAccessingMethods
private final MultiMap<XField,XMethod>	declaredLockAccessors
private final Map<XField,XMethod>	declaredLockObjects
private final Set<XMethod>	exposingMethods
private static final Set<String>	IMMUTABLE_RETURNERS
private final Set<XField>	inheritableBackingCollections
private final MultiMap<XField, FindImproperSynchronization.BugInfo>	inheritedCollectionLockObjects
private final Map<XField,XMethod>	inheritedLockObjects
private final MultiMap<XField,XMethod>	lockAccessorsInHierarchy
private final MultiMap<XField,XMethod>	lockUsingMethodsInHierarchy
private final MultiMap<XField,XMethod>	potentialInheritedBugContainingMethods
private final MultiMap<XField,XMethod>	potentialObjectBugContainingMethods
private final Set<XMethod>	synchronizedMethods
private static final Map<MethodDescriptor, Integer>	WRAPPER_IMPLEMENTATIONS

Fields inherited from class OpcodeStackDetector

stack

Fields inherited from class DismantleBytecode

codeBytes, lineNumberTable, M_BR, M_CP, M_INT, M_PAD, M_R, M_UINT

Fields inherited from interface Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
FindImproperSynchronization(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
private void	analyzeAssignments(org.apache.bcel.classfile.Method obj, ClassContext classContext)
private void	analyzeAssignments(org.apache.bcel.classfile.Method obj, ClassContext classContext, XField specificField)
private void	analyzeAssignmentsInHierarchy(XField collectionLockObject)
private void	analyzeWrappedField(org.apache.bcel.classfile.Method currentMethod, ClassContext classContext, Location location, org.apache.bcel.generic.InstructionHandle handle, XField assignedField, Integer stackOffsetForWrapperMethodParameter)	Analyze a wrapping method call and check if this the creation of a binding collection.
private String	buildMethodsMessage(Collection<XMethod> methods)
private void	checkLockUsageInHierarchy(XField field, XMethod exposingMethod)
private void	clearState()
private Set<XMethod>	findExposureInHierarchy(XField lockObject)
private Set<XMethod>	findLockUsageInHierarchy(XField field)
private static Integer	getStackOffset(MethodDescriptor methodDescriptor)
private boolean	isCollection(XField field)
private boolean	isCollection(org.apache.bcel.generic.Type type)
private static boolean	isImmutableReturner(String signature)
private boolean	isInherited(XField lockObject)	Check if the lock object is inherited from the current class.
private boolean	isInitializerMethod(String methodName)
private boolean	isMethodCall(org.apache.bcel.generic.Instruction instruction)
private boolean	isPackagePrivate(XField field)
private static boolean	isWrapperImplementation(MethodDescriptor methodDescriptor)
private void	reportAccessibleBackingCollectionBug(XField lock, MultiMap<XField, FindImproperSynchronization.BugInfo> possibleBugs, XField backingCollection, MultiMap<XField,XMethod> collectionAccessors)
private void	reportAccessibleObjectBug(XField lock, Collection<XMethod> definedLockAccessors, Map<XField,XMethod> synchronizedMethods)
private void	reportBadCollectionObjectBugs(XField lock, MultiMap<XField, FindImproperSynchronization.BugInfo> possibleBugs, XField backingCollection)
private void	reportExposingLockObjectBugs(XField lock, Collection<XMethod> lockUsingMethods, Collection<XMethod> exposingMethods)
private void	reportInheritedBackingCollectionBug(XField lock, MultiMap<XField, FindImproperSynchronization.BugInfo> possibleBugs, XField backingCollection)
private void	reportInheritedObjectBugs(XField lock, Collection<XMethod> synchronizedMethods)
private void	reportObjectBugs(XField lock, Collection<XMethod> synchronizedMethods)
void	sawOpcode(int seen)	By default, this method will not be called when stack is TOP.
void	visit(org.apache.bcel.classfile.Field obj)
void	visit(org.apache.bcel.classfile.Method obj)
void	visitAfter(org.apache.bcel.classfile.JavaClass obj)

Methods inherited from class OpcodeStackDetector

afterOpcode, beforeOpcode, getStack, isUsingCustomUserValue, visitCode

Methods inherited from class BytecodeScanningDetector

getClassContext, report, shouldVisitCode, visitClassContext

Methods inherited from class DismantleBytecode

areOppositeBranches, atCatchBlock, getBranchFallThrough, getBranchOffset, getBranchTarget, getClassConstantOperand, getClassDescriptorOperand, getCodeByte, getConstantRefOperand, getDefaultSwitchOffset, getDottedClassConstantOperand, getFieldDescriptorOperand, getIntConstant, getLongConstant, getMaxPC, getMethodDescriptorOperand, getNameConstantOperand, getNextCodeByte, getNextOpcode, getNextPC, getOpcode, getPC, getPrevOpcode, getRefFieldIsStatic, getRegisterOperand, getSigConstantOperand, getStringConstantOperand, getSwitchLabels, getSwitchOffsets, getXClassOperand, getXFieldOperand, getXMethodOperand, isBranch, isIf, isMethodCall, isRegisterLoad, isRegisterStore, isRegisterStore, isReturn, isShift, isSwitch, isWideOpcode, normalizeNullComparison, printOpCode, sawBranchTo, sawClass, sawDouble, sawField, sawFloat, sawIMethod, sawInt, sawLong, sawMethod, sawRegister, sawString, visit

Methods inherited from class AnnotationVisitor

getAnnotationParameterAsEnum, getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitAnnotation, visitParameterAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

Methods inherited from class PreorderVisitor

amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingCaughtExceptionTypes, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

Methods inherited from class BetterVisitor

clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitField, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitMethod, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.bcel.classfile.Visitor

visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitRecord, visitRecordComponent, visitStackMapType

Field Details

WRAPPER_IMPLEMENTATIONS

private static final Map<MethodDescriptor, Integer> WRAPPER_IMPLEMENTATIONS

IMMUTABLE_RETURNERS

private static final Set<String> IMMUTABLE_RETURNERS

bugReporter

private final BugReporter bugReporter

exposingMethods

private final Set<XMethod> exposingMethods

synchronizedMethods

private final Set<XMethod> synchronizedMethods

declaredLockObjects

private final Map<XField,XMethod> declaredLockObjects

inheritedLockObjects

private final Map<XField,XMethod> inheritedLockObjects

declaredLockAccessors

private final MultiMap<XField,XMethod> declaredLockAccessors

lockAccessorsInHierarchy

private final MultiMap<XField,XMethod> lockAccessorsInHierarchy

lockUsingMethodsInHierarchy

private final MultiMap<XField,XMethod> lockUsingMethodsInHierarchy

declaredInheritedFieldAccessingMethods

private final MultiMap<XField,XMethod> declaredInheritedFieldAccessingMethods

potentialObjectBugContainingMethods

private final MultiMap<XField,XMethod> potentialObjectBugContainingMethods

potentialInheritedBugContainingMethods

private final MultiMap<XField,XMethod> potentialInheritedBugContainingMethods

badBackingCollections

private final Set<XField> badBackingCollections

inheritableBackingCollections

private final Set<XField> inheritableBackingCollections

declaredCollectionLockObjects

private final MultiMap<XField, FindImproperSynchronization.BugInfo> declaredCollectionLockObjects

inheritedCollectionLockObjects

private final MultiMap<XField, FindImproperSynchronization.BugInfo> inheritedCollectionLockObjects

declaredCollectionAccessors

private final MultiMap<XField,XMethod> declaredCollectionAccessors

collectionAccessorsInHierarchy

private final MultiMap<XField,XMethod> collectionAccessorsInHierarchy

backingCollections

private final MultiMap<XField,XField> backingCollections

Constructor Details

FindImproperSynchronization

public FindImproperSynchronization(BugReporter bugReporter)

Method Details

isWrapperImplementation

private static boolean isWrapperImplementation(MethodDescriptor methodDescriptor)

getStackOffset

private static Integer getStackOffset(MethodDescriptor methodDescriptor)

isImmutableReturner

private static boolean isImmutableReturner(String signature)

visit

public void visit(org.apache.bcel.classfile.Method obj)

Overrides:

visit in class BetterVisitor

visit

public void visit(org.apache.bcel.classfile.Field obj)

Overrides:

visit in class BetterVisitor

sawOpcode

public void sawOpcode(int seen)

Description copied from class: OpcodeStackDetector

By default, this method will not be called when stack is TOP. To change this behavior, override #beforeOpcode(int) and change to return true even if stack is TOP.

see Using FindBugs for Research to learn lattice and what TOP means.

Specified by:

sawOpcode in class OpcodeStackDetector

See Also:

• OpcodeStackDetector.beforeOpcode(int)

visitAfter

public void visitAfter(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visitAfter in class PreorderVisitor

isCollection

private boolean isCollection(org.apache.bcel.generic.Type type)

isCollection

private boolean isCollection(XField field)

isMethodCall

private boolean isMethodCall(org.apache.bcel.generic.Instruction instruction)

isPackagePrivate

private boolean isPackagePrivate(XField field)

isInitializerMethod

private boolean isInitializerMethod(String methodName)

isInherited

private boolean isInherited(XField lockObject)

Check if the lock object is inherited from the current class. To ensure no false positives, we compare only the outer class name if the lock object is contained in an inner class. Only checking equality is enough, since the lock object is a field declared in a class. That means if the declaring class of the lock object is the same as the current class, the lock object is not inherited.

Parameters:

lockObject - the lock object to check for inheritance

Returns:

true if the lock object is inherited from the current class, false otherwise

analyzeWrappedField

private void analyzeWrappedField(org.apache.bcel.classfile.Method currentMethod,
 ClassContext classContext,
 Location location,
 org.apache.bcel.generic.InstructionHandle handle,
 XField assignedField,
 Integer stackOffsetForWrapperMethodParameter)

Analyze a wrapping method call and check if this the creation of a binding collection. There are specific methods that use their parameters to create a new collections, but they maintain a reference to the original collection. When a collection is wrapped by such a method and the result is assigned to a field, the wrapped collections becomes a backing collection.

Parameters:

currentMethod - the method in which the wrapping method call is located

classContext - the class context of the currently analyzed class, in which the wrapping method call is located

location - the location of the wrapping method call

handle - the instruction handle of the wrapping method call

assignedField - the field to which the result of the wrapping method call is assigned

stackOffsetForWrapperMethodParameter - the stack offset of the wrapped collection parameter of the wrapping method call

analyzeAssignments

private void analyzeAssignments(org.apache.bcel.classfile.Method obj,
 ClassContext classContext)
                         throws CFGBuilderException

Throws:

CFGBuilderException

analyzeAssignments

private void analyzeAssignments(org.apache.bcel.classfile.Method obj,
 ClassContext classContext,
 XField specificField)
                         throws CFGBuilderException

Throws:

CFGBuilderException

analyzeAssignmentsInHierarchy

private void analyzeAssignmentsInHierarchy(XField collectionLockObject)

checkLockUsageInHierarchy

private void checkLockUsageInHierarchy(XField field,
 XMethod exposingMethod)

findExposureInHierarchy

private Set<XMethod> findExposureInHierarchy(XField lockObject)
                                      throws ClassNotFoundException

Throws:

ClassNotFoundException

findLockUsageInHierarchy

private Set<XMethod> findLockUsageInHierarchy(XField field)
                                       throws ClassNotFoundException

Throws:

ClassNotFoundException

buildMethodsMessage

private String buildMethodsMessage(Collection<XMethod> methods)

reportExposingLockObjectBugs

private void reportExposingLockObjectBugs(XField lock,
 Collection<XMethod> lockUsingMethods,
 Collection<XMethod> exposingMethods)

reportAccessibleObjectBug

private void reportAccessibleObjectBug(XField lock,
 Collection<XMethod> definedLockAccessors,
 Map<XField,XMethod> synchronizedMethods)

reportInheritedObjectBugs

private void reportInheritedObjectBugs(XField lock,
 Collection<XMethod> synchronizedMethods)

reportObjectBugs

private void reportObjectBugs(XField lock,
 Collection<XMethod> synchronizedMethods)

reportAccessibleBackingCollectionBug

private void reportAccessibleBackingCollectionBug(XField lock,
 MultiMap<XField, FindImproperSynchronization.BugInfo> possibleBugs,
 XField backingCollection,
 MultiMap<XField,XMethod> collectionAccessors)

reportInheritedBackingCollectionBug

private void reportInheritedBackingCollectionBug(XField lock,
 MultiMap<XField, FindImproperSynchronization.BugInfo> possibleBugs,
 XField backingCollection)

reportBadCollectionObjectBugs

private void reportBadCollectionObjectBugs(XField lock,
 MultiMap<XField, FindImproperSynchronization.BugInfo> possibleBugs,
 XField backingCollection)

clearState

private void clearState()