Package com.mebigfatguy.fbcontrib.detect

Class SuspiciousUninitializedArray

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
com.mebigfatguy.fbcontrib.detect.SuspiciousUninitializedArray
All Implemented Interfaces:
edu.umd.cs.findbugs.Detector, edu.umd.cs.findbugs.Priorities, org.apache.bcel.classfile.Visitor
@CustomUserValue public class SuspiciousUninitializedArray extends edu.umd.cs.findbugs.BytecodeScanningDetector
looks for creation of arrays, that are not populated before being returned for a method. While it is possible that the method that called this method will do the work of populated the array, it seems odd that this would be the case.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    (package private) static final class 
    SuspiciousUninitializedArray.SUAUserValue
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private Map<Integer,Integer>
    arrayAliases
     
    private final edu.umd.cs.findbugs.BugReporter
    bugReporter
     
    private static final String
    INITIAL_VALUE
     
    private boolean
    isEnum
     
    private String
    returnArraySig
     
    private edu.umd.cs.findbugs.OpcodeStack
    stack
     
    private Map<Integer,SuspiciousUninitializedArray.SUAUserValue>
    storedUVs
     
    private static org.apache.bcel.classfile.JavaClass
    THREAD_LOCAL_CLASS
     
    private BitSet
    uninitializedRegs
     

    Fields inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

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

    Fields inherited from interface edu.umd.cs.findbugs.Priorities

    EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

  • Constructor Summary

    Constructors
    Constructor
    Description
    SuspiciousUninitializedArray(edu.umd.cs.findbugs.BugReporter bugReporter)
    constructs a SUA detector given the reporter to report bugs on

  • Method Summary

    Modifier and Type
    Method
    Description
    private void
    clearAliases(int reg)
     
    private void
    clearClosureAliases(int reg, BitSet alreadyCleared)
     
    private boolean
    isTOS0()
     
    void
    sawOpcode(int seen)
    overrides the visitor to annotate new array creation with a user value that denotes it as being uninitialized, and then if the array is populated to remove that user value.
    void
    visitClassContext(edu.umd.cs.findbugs.ba.ClassContext classContext)
    overrides the visitor to reset the stack
    void
    visitCode(org.apache.bcel.classfile.Code obj)
    overrides the visitor to check to see if the method returns an array, and if so resets the stack for this method.

    Methods inherited from class edu.umd.cs.findbugs.BytecodeScanningDetector

    getClassContext, report, shouldVisitCode

    Methods inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

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

    Methods inherited from class edu.umd.cs.findbugs.visitclass.AnnotationVisitor

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

    Methods inherited from class edu.umd.cs.findbugs.visitclass.PreorderVisitor

    amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, 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 edu.umd.cs.findbugs.visitclass.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, 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 java.lang.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

    • THREAD_LOCAL_CLASS

      private static org.apache.bcel.classfile.JavaClass THREAD_LOCAL_CLASS

    • INITIAL_VALUE

      private static final String INITIAL_VALUE
      See Also:

    • bugReporter

      private final edu.umd.cs.findbugs.BugReporter bugReporter

    • isEnum

      private boolean isEnum

    • stack

      private edu.umd.cs.findbugs.OpcodeStack stack

    • returnArraySig

      private String returnArraySig

    • uninitializedRegs

      private BitSet uninitializedRegs

    • arrayAliases

      private Map<Integer,Integer> arrayAliases

    • storedUVs

      private Map<Integer,SuspiciousUninitializedArray.SUAUserValue> storedUVs

  • Constructor Details

    • SuspiciousUninitializedArray

      public SuspiciousUninitializedArray(edu.umd.cs.findbugs.BugReporter bugReporter)
      constructs a SUA detector given the reporter to report bugs on
      Parameters:
      bugReporter - the sync of bug reports

  • Method Details

    • visitClassContext

      public void visitClassContext(edu.umd.cs.findbugs.ba.ClassContext classContext)
      overrides the visitor to reset the stack
      Specified by:
      visitClassContext in interface edu.umd.cs.findbugs.Detector
      Overrides:
      visitClassContext in class edu.umd.cs.findbugs.BytecodeScanningDetector
      Parameters:
      classContext - the context object of the currently parsed class

    • visitCode

      public void visitCode(org.apache.bcel.classfile.Code obj)
      overrides the visitor to check to see if the method returns an array, and if so resets the stack for this method.
      Specified by:
      visitCode in interface org.apache.bcel.classfile.Visitor
      Overrides:
      visitCode in class edu.umd.cs.findbugs.visitclass.PreorderVisitor
      Parameters:
      obj - the context object for the currently parsed code block

    • sawOpcode

      public void sawOpcode(int seen)
      overrides the visitor to annotate new array creation with a user value that denotes it as being uninitialized, and then if the array is populated to remove that user value. It then finds return values that have uninitialized arrays. byte arrays are not collected as creating a blank byte array is probably a reasonably normal occurrence.
      Overrides:
      sawOpcode in class edu.umd.cs.findbugs.visitclass.DismantleBytecode
      Parameters:
      seen - the context parameter of the currently parsed op code

    • clearAliases

      private void clearAliases(int reg)

    • clearClosureAliases

      private void clearClosureAliases(int reg, BitSet alreadyCleared)

    • isTOS0

      private boolean isTOS0()