Class SharedVariableAtomicityDetector

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.SharedVariableAtomicityDetector

All Implemented Interfaces:

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

public class SharedVariableAtomicityDetector
extends OpcodeStackDetector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	SharedVariableAtomicityDetector.PendingBug	A candidate bug captured at the PUTFIELD/PUTSTATIC site, evaluated in report().

Nested classes/interfaces inherited from class OpcodeStackDetector

OpcodeStackDetector.WithCustomJumpInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final BugAccumulator	bugAccumulator
private CFG	currentCFG
private LockDataflow	currentLockDataFlow
private org.apache.bcel.classfile.Method	currentMethod
private boolean	hadOperation
private boolean	isFirstVisit
private static final Set<Short>	methodCallOpCodes
private final Map<XMethod, Set<XMethod>>	nonSyncedMethodCallsByCallingMethods
private static final Set<Short>	operationOpCodes
private final List<SharedVariableAtomicityDetector.PendingBug>	pendingBugs
private static final Set<Short>	pushOpCodes
private final Map<XMethod, Set<XField>>	readFieldsByMethods
private static final Set<Short>	readOpCodes
private final Set<XField>	relevantFields

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
SharedVariableAtomicityDetector(BugReporter reporter)

Method Summary

Modifier and Type	Method	Description
private void	addNonFinalFieldsOfClass(XField field, XMethod method, Map<XMethod, Set<XField>> map)
private void	addPendingBug(String bugType, XMethod method, XField field)
private void	checkAndReportBug(int seen, XMethod method)
private void	collectFieldReadsAndInnerMethodCalls(int seen, XMethod method)
private boolean	hasNonSyncedNonPrivateCallToMethod(XMethod method, Set<XMethod> visitedMethods)
private boolean	is64bitPrimitive(String className)
private static boolean	isEnclosingThisReference(XField field)
private boolean	isFieldOfMethodClassOrEnclosing(XField field, XMethod method)	True if field is declared on method's own class or on one of its enclosing classes.
private boolean	isPrimitiveOrItsBoxingType(String className)
private boolean	mapContainsFieldWithOtherMethod(XField field, XMethod method, Map<XMethod, Set<XField>> map)
void	report()	This method is called after all classes to be visited.
void	sawOpcode(int seen)	By default, this method will not be called when stack is TOP.
void	visit(org.apache.bcel.classfile.JavaClass javaClass)
void	visit(org.apache.bcel.classfile.Method method)
void	visitAfter(org.apache.bcel.classfile.JavaClass obj)
void	visitClassContext(ClassContext classContext)	Visit the ClassContext for a class which should be analyzed for instances of bug patterns.

Methods inherited from class OpcodeStackDetector

afterOpcode, beforeOpcode, getStack, isUsingCustomUserValue, visitCode

Methods inherited from class BytecodeScanningDetector

getClassContext, shouldVisitCode

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, 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, visitPermittedSubclasses, visitRecord, visitRecordComponent, visitStackMapType

Field Details

bugAccumulator

private final BugAccumulator bugAccumulator

currentMethod

private org.apache.bcel.classfile.Method currentMethod

currentCFG

private CFG currentCFG

currentLockDataFlow

private LockDataflow currentLockDataFlow

isFirstVisit

private boolean isFirstVisit

hadOperation

private boolean hadOperation

readFieldsByMethods

private final Map<XMethod, Set<XField>> readFieldsByMethods

relevantFields

private final Set<XField> relevantFields

nonSyncedMethodCallsByCallingMethods

private final Map<XMethod, Set<XMethod>> nonSyncedMethodCallsByCallingMethods

pendingBugs

private final List<SharedVariableAtomicityDetector.PendingBug> pendingBugs

readOpCodes

private static final Set<Short> readOpCodes

pushOpCodes

private static final Set<Short> pushOpCodes

operationOpCodes

private static final Set<Short> operationOpCodes

methodCallOpCodes

private static final Set<Short> methodCallOpCodes

Constructor Details

SharedVariableAtomicityDetector

public SharedVariableAtomicityDetector(BugReporter reporter)

Method Details

visitClassContext

public void visitClassContext(ClassContext classContext)

Description copied from interface: Detector

Visit the ClassContext for a class which should be analyzed for instances of bug patterns.

Specified by:

visitClassContext in interface Detector

Overrides:

visitClassContext in class BytecodeScanningDetector

Parameters:

classContext - the ClassContext

visit

public void visit(org.apache.bcel.classfile.JavaClass javaClass)

Overrides:

visit in class BetterVisitor

visit

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

Overrides:

visit in class BetterVisitor

visitAfter

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

Overrides:

visitAfter in class PreorderVisitor

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)

collectFieldReadsAndInnerMethodCalls

private void collectFieldReadsAndInnerMethodCalls(int seen,
 XMethod method)

addNonFinalFieldsOfClass

private void addNonFinalFieldsOfClass(XField field,
 XMethod method,
 Map<XMethod, Set<XField>> map)

hasNonSyncedNonPrivateCallToMethod

private boolean hasNonSyncedNonPrivateCallToMethod(XMethod method,
 Set<XMethod> visitedMethods)

mapContainsFieldWithOtherMethod

private boolean mapContainsFieldWithOtherMethod(XField field,
 XMethod method,
 Map<XMethod, Set<XField>> map)

checkAndReportBug

private void checkAndReportBug(int seen,
 XMethod method)

isPrimitiveOrItsBoxingType

private boolean isPrimitiveOrItsBoxingType(String className)

is64bitPrimitive

private boolean is64bitPrimitive(String className)

isFieldOfMethodClassOrEnclosing

private boolean isFieldOfMethodClassOrEnclosing(XField field,
 XMethod method)

True if field is declared on method's own class or on one of its enclosing classes. A non-static inner class can read and write fields of its enclosing instance via the synthetic this$0 reference, so the detector must follow that chain instead of only matching the inner class itself.

isEnclosingThisReference

private static boolean isEnclosingThisReference(XField field)

addPendingBug

private void addPendingBug(String bugType,
 XMethod method,
 XField field)

report

public void report()

Description copied from interface: Detector

This method is called after all classes to be visited. It should be used by any detectors which accumulate information over all visited classes to generate results.

Specified by:

report in interface Detector

Overrides:

report in class BytecodeScanningDetector