Trait/Object

org.opalj.ai.jdkbug

TaintAnalysisDomain

Related Docs: object TaintAnalysisDomain | package jdkbug

Permalink

trait TaintAnalysisDomain[Source] extends CorrelationalDomain with DomainId with DefaultHandlingOfMethodResults with IgnoreSynchronization with TypeLevelLongValuesShiftOperators with TypeLevelPrimitiveValuesConversions with DefaultDomainValueBinding with TypeLevelInvokeInstructions with TypeLevelFieldAccessInstructions with DefaultTypeLevelLongValues with DefaultTypeLevelFloatValues with DefaultTypeLevelDoubleValues with DefaultTypeLevelIntegerValues with DefaultStringValuesBinding with ThrowAllPotentialExceptionsConfiguration with TypeLevelReferenceValues with TheProject with TheCode with OptionalReport

This is the analysis domain it provides all need functionality to find Class.forName bugs.

Self Type
TaintAnalysisDomain[Source]
Source
JDKBugs.scala
Linear Supertypes
OptionalReport, TheCode, TheProject, ThePropertyStore, LogContextProvider, TheClassHierarchy, ThrowAllPotentialExceptionsConfiguration, DefaultStringValuesBinding, StringValues, PostEvaluationMemoryManagement, DefaultJavaObjectToDomainValueConversion, AsDomainValue, DefaultReferenceValuesBinding, DefaultExceptionsFactory, ReferenceValues, Origin, DefaultTypeLevelReferenceValues, TypeLevelReferenceValues, AsJavaObject, GeneralizedArrayHandling, DefaultTypeLevelIntegerValues, TypeLevelIntegerValues, DefaultTypeLevelDoubleValues, TypeLevelDoubleValues, DefaultTypeLevelFloatValues, TypeLevelFloatValues, DefaultTypeLevelLongValues, TypeLevelLongValues, TypeLevelFieldAccessInstructions, TypeLevelInvokeInstructions, MethodCallsHandling, DefaultDomainValueBinding, TypeLevelPrimitiveValuesConversions, TypeLevelLongValuesShiftOperators, IgnoreSynchronization, DefaultHandlingOfMethodResults, DefaultHandlingForReturnInstructions, DefaultHandlingOfVoidReturns, DefaultHandlingForThrownExceptions, domain.ReturnInstructionsDomain, DomainId, CorrelationalDomain, CorrelationalDomainSupport, IdentityBasedCorrelationChangeDetection, JoinStabilization, Domain, Configuration, TypedValuesFactory, PrimitiveValuesConversionsDomain, ReturnInstructionsDomain, MonitorInstructionsDomain, MethodCallsDomain, FieldAccessesDomain, ReferenceValuesDomain, ReferenceValuesFactory, ExceptionsFactory, DoubleValuesDomain, DoubleValuesFactory, FloatValuesDomain, FloatValuesFactory, LongValuesDomain, LongValuesFactory, IntegerValuesDomain, IntegerValuesFactory, CoreDomainFunctionality, SubroutinesDomain, ValuesDomain, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TaintAnalysisDomain
  2. OptionalReport
  3. TheCode
  4. TheProject
  5. ThePropertyStore
  6. LogContextProvider
  7. TheClassHierarchy
  8. ThrowAllPotentialExceptionsConfiguration
  9. DefaultStringValuesBinding
  10. StringValues
  11. PostEvaluationMemoryManagement
  12. DefaultJavaObjectToDomainValueConversion
  13. AsDomainValue
  14. DefaultReferenceValuesBinding
  15. DefaultExceptionsFactory
  16. ReferenceValues
  17. Origin
  18. DefaultTypeLevelReferenceValues
  19. TypeLevelReferenceValues
  20. AsJavaObject
  21. GeneralizedArrayHandling
  22. DefaultTypeLevelIntegerValues
  23. TypeLevelIntegerValues
  24. DefaultTypeLevelDoubleValues
  25. TypeLevelDoubleValues
  26. DefaultTypeLevelFloatValues
  27. TypeLevelFloatValues
  28. DefaultTypeLevelLongValues
  29. TypeLevelLongValues
  30. TypeLevelFieldAccessInstructions
  31. TypeLevelInvokeInstructions
  32. MethodCallsHandling
  33. DefaultDomainValueBinding
  34. TypeLevelPrimitiveValuesConversions
  35. TypeLevelLongValuesShiftOperators
  36. IgnoreSynchronization
  37. DefaultHandlingOfMethodResults
  38. DefaultHandlingForReturnInstructions
  39. DefaultHandlingOfVoidReturns
  40. DefaultHandlingForThrownExceptions
  41. ReturnInstructionsDomain
  42. DomainId
  43. CorrelationalDomain
  44. CorrelationalDomainSupport
  45. IdentityBasedCorrelationChangeDetection
  46. JoinStabilization
  47. Domain
  48. Configuration
  49. TypedValuesFactory
  50. PrimitiveValuesConversionsDomain
  51. ReturnInstructionsDomain
  52. MonitorInstructionsDomain
  53. MethodCallsDomain
  54. FieldAccessesDomain
  55. ReferenceValuesDomain
  56. ReferenceValuesFactory
  57. ExceptionsFactory
  58. DoubleValuesDomain
  59. DoubleValuesFactory
  60. FloatValuesDomain
  61. FloatValuesFactory
  62. LongValuesDomain
  63. LongValuesFactory
  64. IntegerValuesDomain
  65. IntegerValuesFactory
  66. CoreDomainFunctionality
  67. SubroutinesDomain
  68. ValuesDomain
  69. AnyRef
  70. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AReferenceValue = ReferenceValue

    Permalink
  2. trait ArrayAbstraction extends AnyRef

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  3. type ArrayLoadResult = Computation[DomainValue, ExceptionValues]

    Permalink

    Computation that returns the value stored in an array at a given index or an exception.

    Computation that returns the value stored in an array at a given index or an exception. The exceptions that may be thrown are: NullPointerException and ArrayIndexOutOfBoundsException.

    Definition Classes
    ReferenceValuesDomain
  4. type ArrayStoreResult = Computation[Nothing, ExceptionValues]

    Permalink

    Computation that succeeds (updates the value stored in the array at the given index) or that throws an exception.

    Computation that succeeds (updates the value stored in the array at the given index) or that throws an exception. The exceptions that may be thrown are: NullPointerException, ArrayIndexOutOfBoundsException and ArrayStoreException.

    Definition Classes
    ReferenceValuesDomain
  5. class ArrayValue extends (ReferenceValues.this)#ArrayValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  6. trait BooleanValue extends (TypeLevelIntegerValues.this)#ComputationalTypeIntegerValue[BooleanType] with IsBooleanValue[(TypeLevelIntegerValues.this)#BooleanValue]

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  7. trait ByteValue extends (TypeLevelIntegerValues.this)#ComputationalTypeIntegerValue[ByteType] with IsByteValue[(TypeLevelIntegerValues.this)#ByteValue]

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  8. trait CharValue extends (TypeLevelIntegerValues.this)#ComputationalTypeIntegerValue[CharType] with IsCharValue[(TypeLevelIntegerValues.this)#CharValue]

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  9. trait ComputationalTypeIntegerValue[T <: CTIntType] extends (TypeLevelIntegerValues.this)#TypedValue[T]

    Permalink

    Abstracts over values with computational type integer.

    Abstracts over values with computational type integer.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelIntegerValues
  10. type DomainArrayValue = ArrayValue

    Permalink
  11. final type DomainIllegalValue = IllegalValue

    Permalink

    Abstracts over the concrete type of IllegalValue.

    Abstracts over the concrete type of IllegalValue.

    This type needs to be refined whenever the class IllegalValue is refined or the type DomainValue is refined.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  12. type DomainMultipleReferenceValues = MultipleReferenceValues

    Permalink
  13. type DomainNullValue = NullValue

    Permalink
  14. type DomainObjectValue = ObjectValue

    Permalink
  15. type DomainReferenceValue = ReferenceValue

    Permalink
  16. final type DomainReturnAddressValue = ReturnAddressValue

    Permalink

    Abstracts over the concrete type of ReturnAddressValue.

    Abstracts over the concrete type of ReturnAddressValue. Needs to be fixed by some sub-trait/sub-class. In the simplest case (i.e., when neither the Value trait nor the ReturnAddressValue trait was refined) it is sufficient to write:

    type DomainReturnAddressValue = ReturnAddressValue
    Definition Classes
    DefaultDomainValueBindingValuesDomain
  17. final type DomainReturnAddressValues = ReturnAddressValues

    Permalink
  18. type DomainSingleOriginReferenceValue = SingleOriginReferenceValue

    Permalink
  19. type DomainStringValue = StringValue

    Permalink
  20. final type DomainTypedValue[+T <: Type] = TypedValue[T]

    Permalink
  21. final type DomainValue = Value

    Permalink

    Abstracts over the concrete type of Value.

    Abstracts over the concrete type of Value. Needs to be refined by traits that inherit from Domain and which extend Domain's Value trait.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  22. trait DoubleValue extends (TypeLevelDoubleValues.this)#TypedValue[DoubleType] with IsDoubleValue[(TypeLevelDoubleValues.this)#DoubleValue]

    Permalink

    Abstracts over double values at the type level.

    Abstracts over double values at the type level.

    Definition Classes
    TypeLevelDoubleValues
  23. type ExceptionValue = DomainReferenceValue

    Permalink

    A simple type alias of the type DomainValue; used to facilitate comprehension.

    A simple type alias of the type DomainValue; used to facilitate comprehension.

    Definition Classes
    ValuesDomain
  24. type ExceptionValues = Iterable[ExceptionValue]

    Permalink

    A type alias for Iterables of ExceptionValues; used to facilitate comprehension.

    A type alias for Iterables of ExceptionValues; used to facilitate comprehension.

    Definition Classes
    ValuesDomain
  25. trait FloatValue extends (TypeLevelFloatValues.this)#TypedValue[FloatType] with IsFloatValue[(TypeLevelFloatValues.this)#FloatValue]

    Permalink

    Abstracts over all values with computational type float.

    Abstracts over all values with computational type float.

    Definition Classes
    TypeLevelFloatValues
  26. type Id = CallStackEntry

    Permalink

    The type which is used to identify the domain or the domain's context.

    The type which is used to identify the domain or the domain's context. E.g., if a new domain is created to analyze a called method it may be associated with the instruction caused its creation. It can, however, also just identify the method (by means of, e.g., the pair (classFile,method) that it is used for.

    Definition Classes
    TaintAnalysisDomainDomainId
  27. class IllegalValue extends Value

    Permalink

    Represents a value that has no well defined state/type.

    Represents a value that has no well defined state/type. Such values are the result of a join of two incompatible values and are generally only found in registers (in the locals) and then identify a value that is dead.

    Attributes
    protected
    Definition Classes
    ValuesDomain
    See also

    org.opalj.ai.Domain.Value for further details.

  28. trait IntegerValue extends (TypeLevelIntegerValues.this)#ComputationalTypeIntegerValue[IntegerType] with IsIntegerValue[(TypeLevelIntegerValues.this)#IntegerValue]

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  29. type IntegerValueOrArithmeticException = Computation[DomainValue, ExceptionValue]

    Permalink

    Computation that returns a numeric value or an ObjectType.ArithmeticException.

    Computation that returns a numeric value or an ObjectType.ArithmeticException.

    Definition Classes
    IntegerValuesDomain
  30. type Locals = collection.mutable.Locals[DomainValue]

    Permalink

    An instruction's current register values/locals are represented using an array.

    An instruction's current register values/locals are represented using an array.

    Definition Classes
    ValuesDomain
  31. type LocalsArray = Array[Locals]

    Permalink
    Definition Classes
    ValuesDomain
  32. trait LongValue extends (TypeLevelLongValues.this)#TypedValue[LongType] with IsLongValue[(TypeLevelLongValues.this)#LongValue]

    Permalink

    Common supertrait of all DomainValues that represent long values.

    Common supertrait of all DomainValues that represent long values.

    Definition Classes
    TypeLevelLongValues
  33. type LongValueOrArithmeticException = Computation[DomainValue, ExceptionValue]

    Permalink
    Definition Classes
    LongValuesDomain
  34. class MObjectValue extends (ReferenceValues.this)#MObjectValue with (ReferenceValues.this)#ObjectValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  35. type MethodCallResult = Computation[DomainValue, ExceptionValues]

    Permalink
    Definition Classes
    MethodCallsDomain
  36. trait MultipleOriginsValue extends (Origin.this)#ValueWithOriginInformation

    Permalink

    Should be mixed in by Value classes that capture information about all origins of a value.

    Should be mixed in by Value classes that capture information about all origins of a value.

    Definition Classes
    Origin
  37. class MultipleReferenceValues extends (ReferenceValues.this)#ReferenceValue with (ReferenceValues.this)#MultipleOriginsValue

    Permalink

    A MultipleReferenceValues tracks multiple reference values (of type NullValue, ArrayValue, SObjectValue and MObjectValue) that have different origins.

    A MultipleReferenceValues tracks multiple reference values (of type NullValue, ArrayValue, SObjectValue and MObjectValue) that have different origins. I.e., per value origin one domain value is used to abstract over the properties of that respective value.

    Attributes
    protected
    Definition Classes
    ReferenceValues
  38. trait NonNullSingleOriginReferenceValue extends (ReferenceValues.this)#SingleOriginReferenceValue

    Permalink
    Definition Classes
    ReferenceValues
  39. trait NonNullSingleOriginSReferenceValue extends (ReferenceValues.this)#NonNullSingleOriginReferenceValue

    Permalink
    Definition Classes
    ReferenceValues
  40. class NullValue extends (ReferenceValues.this)#NullValue with (ReferenceValues.this)#SingleOriginReferenceValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  41. trait ObjectValue extends (ReferenceValues.this)#ObjectValue with (ReferenceValues.this)#NonNullSingleOriginReferenceValue

    Permalink
    Definition Classes
    ReferenceValues
  42. type Operands = Chain[DomainValue]

    Permalink

    An instruction's operands are represented using a list where the first element of the list represents the top level operand stack value.

    An instruction's operands are represented using a list where the first element of the list represents the top level operand stack value.

    Definition Classes
    ValuesDomain
  43. type OperandsArray = Array[Operands]

    Permalink
    Definition Classes
    ValuesDomain
  44. trait RETValue extends Value

    Permalink
    Definition Classes
    ValuesDomain
  45. trait ReferenceValue extends (ReferenceValues.this)#ReferenceValue

    Permalink

    Representation of some reference value; this includes Object, Array and Null values.

    Representation of some reference value; this includes Object, Array and Null values.

    This trait defines the additional methods needed for the refinement of the new properties.

    Definition Classes
    ReferenceValues
  46. type Refinements = IdentityHashMap[AReferenceValue, AReferenceValue]

    Permalink

    A map that contains the refined values (the map's values) of some old values (the map's keys).

    A map that contains the refined values (the map's values) of some old values (the map's keys).

    Definition Classes
    ReferenceValues
  47. class ReturnAddressValue extends RETValue

    Permalink

    Stores a single return address (i.e., a program counter/index into the code array).

    Stores a single return address (i.e., a program counter/index into the code array).

    Definition Classes
    ValuesDomain
    Note

    Though the framework completely handles all aspects related to return address values, it is nevertheless necessary that this class inherits from Value as return addresses are stored on the stack/in the registers. However, if the Value trait should be refined, all additional methods may – from the point-of-view of OPAL-AI - just throw an OperationNotSupportedException as these additional methods will never be called by OPAL-AI.

  48. class ReturnAddressValues extends RETValue

    Permalink

    A collection of (not furhter stored) return address values.

    A collection of (not furhter stored) return address values. Primarily used when we join the executions of subroutines.

    Definition Classes
    ValuesDomain
  49. class SObjectValue extends (ReferenceValues.this)#SObjectValue with (ReferenceValues.this)#ObjectValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue

    Permalink

    Attributes
    protected
    Definition Classes
    ReferenceValues
  50. trait SReferenceValue[T <: ReferenceType] extends AnyRef

    Permalink

    A reference value with a single (upper) type (bound).

    A reference value with a single (upper) type (bound).

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  51. trait ShortValue extends (TypeLevelIntegerValues.this)#ComputationalTypeIntegerValue[ShortType] with IsShortValue[(TypeLevelIntegerValues.this)#ShortValue]

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  52. trait SingleOriginReferenceValue extends (ReferenceValues.this)#ReferenceValue with (ReferenceValues.this)#SingleOriginValue with UID

    Permalink

    Represents all DomainReferenceValues that represent a reference value where – in the current analysis context – the value has a single origin.

    Represents all DomainReferenceValues that represent a reference value where – in the current analysis context – the value has a single origin.

    Definition Classes
    ReferenceValues
    Note

    To make it possible to store SingleOriginReferenceValues in UIDSets - which in particular provide fast filter and tail methods compared to the standard sets - the UID trait is implemented.

  53. trait SingleOriginValue extends (Origin.this)#ValueWithOriginInformation

    Permalink

    Should be mixed in by Values that have a single origin.

    Should be mixed in by Values that have a single origin.

    Definition Classes
    Origin
  54. class StringValue extends (StringValues.this)#SObjectValue

    Permalink

    Attributes
    protected
    Definition Classes
    StringValues
  55. type Timestamp = Int

    Permalink

    The timestamp enables us to distinguish two values created/returned by the same instruction (two values with the same origin) but at a different point in time.

    The timestamp enables us to distinguish two values created/returned by the same instruction (two values with the same origin) but at a different point in time.

    Such values may or may not be different (i.e., those value may or may not refer to the same object on the heap/stack).

    However, two domain values that have the same timestamp are guaranteed to refer to the same object at runtime (must-alias).

    Timestamps are required to determine changes in the memory layout. I.e., to determine if two values created by the same instruction are aliases or "just" maybe aliases. This information is particularly relevant if two values - stored in registers - are no longer guaranteed to be aliases!

    Definition Classes
    ReferenceValues
  56. trait TypedValue[+T <: Type] extends Value with KnownType

    Permalink
    Definition Classes
    ValuesDomain
  57. trait Value extends AnyRef

    Permalink

    Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.

    Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.

    Use Of Value/Dependencies On Value

    In general, subclasses and users of a Domain should not have/declare a direct dependency on Value. Instead they should use DomainValue as otherwise extensibility of a Domain may be hampered or even be impossible. The only exceptions are, of course, classes that directly inherit from this class.

    Refining Value

    If you directly extend/refine this trait (i.e., in a subclass of the Domain trait you write something like trait Value extends super.Value), make sure that you also extend all classes/traits that inherit from this type (this may require a deep mixin composition and that you refine the type DomainType accordingly). However, OPAL was designed such that extending this class should – in general – not be necessary. It may also be easier to encode the desired semantics – as far as possible – as part of the domain.

    Implementing Value

    Standard inheritance from this trait is always supported and is the primary mechanism to model an abstract domain's lattice w.r.t. some special type of value. In general, the implementation should try to avoid creating new instances of values unless strictly required to model the domain's semantics. This will greatly improve the overall performance as this framework heavily uses reference-based equality checks to speed up the evaluation.

    Definition Classes
    ValuesDomain
    Note

    OPAL does not rely on any special equality semantics w.r.t. values and never directly or indirectly calls a Value's equals or eq method. Hence, a domain can encode equality such that it best fits its need. However, some of the provided domains rely on the following semantics for equals: Two domain values have to be equal (==) iff they represent the same information. This includes additional information, such as, the value of the origin. E.g., a value (AnIntegerValue) that represents an arbitrary Integer value has to return true if the domain value with which it is compared also represents an arbitrary Integer value (AnIntegerValue). However, it may still be necessary to use multiple objects to represent an arbitrary integer value if, e.g., constraints should be attached to specific values. For example, after a comparison of an integer value with a predefined value (e.g., AnIntegerValue < 4) it is possible to constrain the respective value on the subsequent paths (< 4 on one path and >= 4 on the other path). To make that possible, it is however necessary to distinguish the AnIntegervalue from some other AnIntegerValue to avoid constraining unrelated values.

    public void foo(int a,int b) {
        if(a < 4) {
            z = a - 2 // here a is constrained (< 4), b and z are unconstrained
        }
        else {
            z = a + 2 // here a is constrained (>= 4), b and z are unconstrained
        }
    }

    In general, equals is only defined for values belonging to the same domain. If values need to be compared across domains, they need to be adapted to a target domain first.

  58. trait ValueWithOriginInformation extends AnyRef

    Permalink
    Definition Classes
    Origin

Abstract Value Members

  1. abstract val callerNode: CallerNode

    Permalink

    Identifies the node in the analysis graph that represents the call of this domain's method.

    Identifies the node in the analysis graph that represents the call of this domain's method.

    Control Flow

    We only attach a child node (the contextNode) to the caller node if the analysis of this domain's method returns a relevant result. This is determined when the postAnalysis method is called.

    Attributes
    protected
  2. abstract val checkForFields: Boolean

    Permalink

    Predicates if the analysis is currently in the process of looking for the use of a previously tainted field.

    Predicates if the analysis is currently in the process of looking for the use of a previously tainted field. If this is true then this boolean prevents the analysis from analyzing "putfield" instructions that could lead the analysis to run into an endless loop

  3. abstract val contextNode: ContextNode

    Permalink

    Represents the node in the analysis graph that models the entry point to this method.

    Represents the node in the analysis graph that models the entry point to this method.

    Attributes
    protected
  4. abstract def id: Id

    Permalink

    Returns the value that identifies this domain (usually it is loosely connected to the analyzed method).

    Returns the value that identifies this domain (usually it is loosely connected to the analyzed method).

    This value may subsequently be used to identify/track object instances but – if so – this happens at the sole responsibility of the domain. OPAL-AI does not require any kind of tracking.

    Definition Classes
    DomainId
  5. abstract def isRecursiveCall(declaringClass: ReferenceType, name: String, descriptor: MethodDescriptor, parameters: DomainValues): Boolean

    Permalink

    Checks if the call to the specified method represents a (mutually) recursive call.

  6. implicit abstract def project: SomeProject

    Permalink

    Returns the project that is currently analyzed.

    Returns the project that is currently analyzed.

    Definition Classes
    TheProject

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object ABooleanValue extends (DefaultTypeLevelIntegerValues.this)#BooleanValue with Product with Serializable

    Permalink
  5. object AByteValue extends (DefaultTypeLevelIntegerValues.this)#ByteValue with Product with Serializable

    Permalink
  6. object ACharValue extends (DefaultTypeLevelIntegerValues.this)#CharValue with Product with Serializable

    Permalink
  7. object ADoubleValue extends (DefaultTypeLevelDoubleValues.this)#DoubleValue with Product with Serializable

    Permalink

    Represents an unknown double value.

    Represents an unknown double value.

    Definition Classes
    DefaultTypeLevelDoubleValues
  8. object AFloatValue extends (DefaultTypeLevelFloatValues.this)#FloatValue with Product with Serializable

    Permalink
    Definition Classes
    DefaultTypeLevelFloatValues
  9. object ALongValue extends (DefaultTypeLevelLongValues.this)#LongValue with Product with Serializable

    Permalink
    Definition Classes
    DefaultTypeLevelLongValues
  10. final val AReferenceValue: ClassTag[AReferenceValue]

    Permalink
  11. object AShortValue extends (DefaultTypeLevelIntegerValues.this)#ShortValue with Product with Serializable

    Permalink
  12. object AnIntegerValue extends (DefaultTypeLevelIntegerValues.this)#IntegerValue with Product with Serializable

    Permalink
  13. final def ArithmeticException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a ArithmeticException and that has the given origin.

    Creates a non-null object that represent a ArithmeticException and that has the given origin. If the ArithmeticException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  14. final def ArrayIndexOutOfBoundsException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a ArrayIndexOutOfBoundsException and that has the given origin.

    Creates a non-null object that represent a ArrayIndexOutOfBoundsException and that has the given origin. If the ArrayIndexOutOfBoundsException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  15. final def ArrayStoreException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a ArrayStoreException and that has the given origin.

    Creates a non-null object that represent a ArrayStoreException and that has the given origin. If the ArrayStoreException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  16. def ArrayValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ArrayType, t: Timestamp): DomainArrayValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  17. def ArrayValue(pc: PC, arrayType: ArrayType): DomainArrayValue

    Permalink

    Creates a new DomainValue that represents an array value with unknown values and where the specified type may also just be an upper type bound (unless the component type is a primitive type or an array of primitives.)

    Creates a new DomainValue that represents an array value with unknown values and where the specified type may also just be an upper type bound (unless the component type is a primitive type or an array of primitives.)

    Typical Usage

    This factory method is (typically) used to create a domain value that represents an array if we know nothing specific about the array. E.g., if you want to analyze a method that takes an array as a parameter.

    Summary

    The properties of the value are:

    • Type: Upper Bound (unless the elementType is a base type)
    • Null: Unknown
    • Size: Unknown
    • Content: Unknown
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValuesTypeLevelReferenceValues
    Note

    Java's arrays are co-variant. I.e., Object[] a = new Serializable[100]; is valid.

  18. object ArrayValue

    Permalink

    Enables matching of DomainValues that are array values.

    Enables matching of DomainValues that are array values.

    Definition Classes
    DefaultTypeLevelReferenceValues
  19. def BooleanValue(valueOrigin: ValueOrigin, value: Boolean): ABooleanValue.type

    Permalink

    Factory method to create a representation of a boolean value with the given initial value and origin.

    Factory method to create a representation of a boolean value with the given initial value and origin.

    The domain may ignore the information about the value and the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  20. def BooleanValue(valueOrigin: ValueOrigin): ABooleanValue.type

    Permalink

    Factory method to create a representation of a boolean value if we know the origin of the value.

    Factory method to create a representation of a boolean value if we know the origin of the value.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  21. def ByteValue(valueOrigin: ValueOrigin, value: Byte): AByteValue.type

    Permalink

    Factory method to create a DomainValue that represents the given byte value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given byte value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the value and the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  22. def ByteValue(valueOrigin: ValueOrigin): AByteValue.type

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  23. def CharValue(valueOrigin: ValueOrigin, value: Char): ACharValue.type

    Permalink

    Factory method to create a DomainValue that represents the given char value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given char value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  24. def CharValue(valueOrigin: ValueOrigin): ACharValue.type

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  25. final def ClassCastException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a ClassCastException and that has the given origin.

    Creates a non-null object that represent a ClassCastException and that has the given origin. If the ClassCastException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  26. final def ClassNotFoundException(origin: ValueOrigin): ExceptionValue

    Permalink
  27. def ClassValue(pc: PC, t: Type): DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents a runtime value of type "Class<T>" and that was created by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents a runtime value of type "Class<T>" and that was created by the instruction with the specified program counter.

    This function is called by OPAL when a class constant (LDC(_W) instruction) is put on the stack.

    The domain may ignore the information about the value and the origin (vo).

    Summary

    The properties of the domain value are:

    • Initialized: Yes and the type represented by the class is the given type.
    • Type: java.lang.Class<t:Type>
    • Null: No
    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  28. final def ConstantFieldValue(pc: PC, cv: ConstantFieldValue[_]): DomainValue

    Permalink

    Creates the domain value that represents the constant field value.

    Creates the domain value that represents the constant field value.

    Definition Classes
    Domain
  29. final def DefaultValue(origin: ValueOrigin, theType: FieldType): DomainValue

    Permalink

    Creates a DomainValue that represents a value with the given type and which is initialized using the JVM's default value for that type.

    Creates a DomainValue that represents a value with the given type and which is initialized using the JVM's default value for that type. E.g., for IntegerValues the value is set to 0. In case of a ReferenceType the value is the ReferenceValuesFactory#NullValue.

    Definition Classes
    TypedValuesFactory
  30. final val DomainArrayValue: ClassTag[DomainArrayValue]

    Permalink
  31. final val DomainMultipleReferenceValues: ClassTag[DomainMultipleReferenceValues]

    Permalink
  32. final val DomainNullValue: ClassTag[DomainNullValue]

    Permalink
  33. final val DomainObjectValue: ClassTag[DomainObjectValue]

    Permalink
  34. final val DomainReferenceValue: ClassTag[DomainReferenceValue]

    Permalink

    The class tag can be used to create type safe arrays or to extract the concrete type of the domain value.

    The class tag can be used to create type safe arrays or to extract the concrete type of the domain value.

    val DomainReferenceValue(v) = value // of type "DomainValue"
    // v is now of the type DomainReferenceValue
    Definition Classes
    DefaultReferenceValuesBindingValuesDomain
  35. final val DomainSingleOriginReferenceValue: ClassTag[DomainSingleOriginReferenceValue]

    Permalink
  36. implicit object DomainSingleOriginReferenceValueOrdering extends Ordering[(ReferenceValues.this)#DomainSingleOriginReferenceValue]

    Permalink

    Defines a total order on reference values with a single origin by subtracting both origins.

    Defines a total order on reference values with a single origin by subtracting both origins.

    Definition Classes
    ReferenceValues
  37. final val DomainStringValue: ClassTag[DomainStringValue]

    Permalink
  38. final val DomainValue: ClassTag[DomainValue]

    Permalink

    The class tag for the type DomainValue.

    The class tag for the type DomainValue.

    Required to generate instances of arrays in which values of type DomainValue can be stored in a type-safe manner.

    Initialization

    In the sub-trait or class that fixes the type of DomainValue it is necessary to implement this abstract val using:

    val DomainValueTag : ClassTag[DomainValue] = implicitly

    (As of Scala 2.10 it is necessary that you do not use implicit in the subclass - it will compile, but fail at runtime.)

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  39. final def DoubleValue(valueOrigin: ValueOrigin, value: Double): DoubleValue

    Permalink

    Factory method to create a DomainValue that represents the given double value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given double value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the value and the origin (vo).

    Definition Classes
    DefaultTypeLevelDoubleValuesDoubleValuesFactory
  40. final def DoubleValue(valueOrigin: ValueOrigin): DoubleValue

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter, but where we have no knowledge about the precise value.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter, but where we have no knowledge about the precise value.

    The domain may ignore the information about the origin (vo).

    Definition Classes
    DefaultTypeLevelDoubleValuesDoubleValuesFactory
  41. def FloatValue(valueOrigin: ValueOrigin, value: Float): FloatValue

    Permalink

    Factory method to create a DomainValue with the specified origin.

    Factory method to create a DomainValue with the specified origin. The origin is typically the program counter of the instruction that created this value/where the value was observed for the first time.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelFloatValuesFloatValuesFactory
  42. def FloatValue(valueOrigin: ValueOrigin): FloatValue

    Permalink

    Factory method to create a DomainValue with the specified origin.

    Factory method to create a DomainValue with the specified origin. The origin is typically the program counter of the instruction that created this value/where the value was observed for the first time.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelFloatValuesFloatValuesFactory
  43. final def IllegalMonitorStateException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent an IllegalMonitorStateException and that has the given origin.

    Creates a non-null object that represent an IllegalMonitorStateException and that has the given origin. If the IllegalMonitorStateException was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  44. def InitializedArrayValue(pc: PC, arrayType: ArrayType, counts: Chain[Int]): DomainArrayValue

    Permalink

    Factory method to create a DomainValue that represents an array that was successfully created and which has the given type.

    Factory method to create a DomainValue that represents an array that was successfully created and which has the given type.

    The domain may ignore the information about the origin (pc) and the precise size of each dimension.

    Summary

    The properties of the domain value are:

    • Type: Precise
    • Null: No
    • Content: Unknown
    counts

    The size of each dimension if available. counts may not be empty but may not contain information about all dimensions; the following condition always has to hold: counts.length <= arrayType.dimensions.

    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  45. def InitializedObjectValue(pc: PC, objectType: ObjectType): DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents an initialized reference value of the given type and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents an initialized reference value of the given type and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    General Remarks

    The given type usually identifies a class type (not an interface type) that is not abstract, but in some cases (e.g. consider java.awt.Toolkit()) it may be useful/meaningful to relax this requirement and to state that the class precisely represents the runtime type – even so the class is abstract. However, such decisions need to be made by the domain.

    This method is used by the OPAL framework to create reference values that are normally internally created by the JVM (in particular exceptions such as NullPointExeception and ClassCastException). However, it can generally be used to create initialized objects/arrays.

    Summary

    The properties of the domain value are:

    • Initialized: Yes
    • Type: precise (i.e., this type is not an upper bound, the type correctly models the runtime type.)
    • Null: No (This value is not null.)
    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  46. final def IntegerConstant0: DomainTypedValue[CTIntType]

    Permalink

    Factory method to create a representation of the integer constant value 0.

    Factory method to create a representation of the integer constant value 0.

    OPAL in particular uses this special value for performing subsequent computations against the fixed value 0 (e.g., for if_XX instructions).

    (The origin (ValueOrigin) that is used is the ConstantValueOrigin to signify that this value was not created by the program.)

    The domain may ignore the information about the value.

    Definition Classes
    IntegerValuesFactory
  47. def IntegerValue(valueOrigin: ValueOrigin, value: Int): AnIntegerValue.type

    Permalink

    Factory method to create a DomainValue that represents the given integer value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given integer value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the value and the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  48. def IntegerValue(valueOrigin: ValueOrigin): AnIntegerValue.type

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  49. object IsNull

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  50. object IsPrecise

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  51. def LongValue(valueOrigin: ValueOrigin, value: Long): LongValue

    Permalink

    Factory method to create a DomainValue that represents the given long value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given long value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the value and the origin (vo).

    Definition Classes
    DefaultTypeLevelLongValuesLongValuesFactory
  52. def LongValue(valueOrigin: ValueOrigin): LongValue

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the origin (vo).

    Definition Classes
    DefaultTypeLevelLongValuesLongValuesFactory
  53. object MObjectValue

    Permalink
  54. final val MetaInformationUpdateIllegalValue: MetaInformationUpdate[DomainIllegalValue]

    Permalink

    The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].

    The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  55. def MethodCallResult(potentialExceptions: Iterable[ExceptionValue]): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  56. def MethodCallResult(returnValue: DomainValue, exceptions: Iterable[ExceptionValue]): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  57. def MethodHandle(origin: ValueOrigin, handle: MethodHandle): DomainReferenceValue

    Permalink

    Called by the AI framework for each load constant method handle (org.opalj.br.instructions.LoadMethodHandle) instruction to get a representation of/a DomainValue that represents the handle.

    Called by the AI framework for each load constant method handle (org.opalj.br.instructions.LoadMethodHandle) instruction to get a representation of/a DomainValue that represents the handle.

    handle

    A valid method handle.

    returns

    An InitializedObjectValue(ObjectType.MethodHandle). Hence, this method needs to be overridden if resolution of MethodHandle based method calls should be performed.

    Definition Classes
    ReferenceValuesFactory
  58. def MethodType(origin: ValueOrigin, descriptor: MethodDescriptor): DomainReferenceValue

    Permalink

    Called by the framework for each load constant method type (org.opalj.br.instructions.LoadMethodType) instruction to get a domain-specific representation of the method descriptor as a MethodType.

    Called by the framework for each load constant method type (org.opalj.br.instructions.LoadMethodType) instruction to get a domain-specific representation of the method descriptor as a MethodType.

    descriptor

    A valid method descriptor.

    returns

    An InitializedObjectValue(ObjectType.MethodType). Hence, this method needs to be overridden if resolution of MethodType based method calls should be performed.

    Definition Classes
    ReferenceValuesFactory
  59. def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue], isNull: Answer, isPrecise: Boolean, theUpperTypeBound: UIDSet[_ <: ReferenceType], t: Timestamp): DomainMultipleReferenceValues

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  60. def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue]): DomainMultipleReferenceValues

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  61. object MultipleReferenceValues

    Permalink
    Definition Classes
    ReferenceValues
  62. final def NegativeArraySizeException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a NegativeArraySizeException and that has the given origin.

    Creates a non-null object that represent a NegativeArraySizeException and that has the given origin. If the NegativeArraySizeException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  63. def NewArray(pc: PC, counts: Operands, arrayType: ArrayType): DomainArrayValue

    Permalink

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Typical Usage

    This factory method is (implicitly) used, e.g., by OPAL when a multianewarray instruction is found.

    Summary

    The properties of the value are:

    • Type: Precise
    • Null: No
    • Size: Depending on the values in counts
    • Content: Empty (i.e., default values w.r.t. to the array's component type)
    Definition Classes
    ReferenceValuesTypeLevelReferenceValues
  64. def NewArray(pc: PC, count: DomainValue, arrayType: ArrayType): DomainArrayValue

    Permalink

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Typical Usage

    This factory method is (implicitly) used, e.g., by OPAL when a newarray instruction is found.

    Summary

    The properties of the value are:

    • Type: Precise
    • Null: No
    • Size: Count
    • Content: Empty (i.e., default values w.r.t. to the array's component type)
    Definition Classes
    ReferenceValuesTypeLevelReferenceValues
  65. def NewObject(origin: ValueOrigin, objectType: ObjectType): DomainObjectValue

    Permalink

    Creates a new DomainValue that represents a new, uninitialized instance of an object of the given type.

    Creates a new DomainValue that represents a new, uninitialized instance of an object of the given type. The object was created by the (NEW) instruction with the specified program counter.

    OPAL calls this method when it evaluates newobject instructions. If the bytecode is valid a call of one of the object's constructors will subsequently initialize the object.

    Summary

    The properties of the domain value are:

    • Initialized: no (only the memory is allocated for the object)
    • Type: precise (i.e., this type is not an upper bound, the type correctly models the runtime type.)
    • Null: No (This value is not null.)
    Definition Classes
    StringValuesReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
    Note

    Instances of arrays are created by the newarray and multianewarray instructions and in both cases an exception may be thrown (e.g., NegativeArraySizeException).

  66. def NonNullObjectValue(pc: PC, objectType: ObjectType): DomainObjectValue

    Permalink

    Represents a non-null reference value with the given type as an upper type bound.

    Represents a non-null reference value with the given type as an upper type bound.

    The domain may ignore the information about the value and the origin (vo).

    Summary

    The properties of the domain value are:

    • Initialized: Yes (the constructor was called)
    • Type: Upper Bound
    • Null: No (This value is not null.)
    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  67. final def NullPointerException(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a NullPointerException and that has the given origin.

    Creates a non-null object that represent a NullPointerException and that has the given origin. If the NullPointerException was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  68. def NullValue(origin: ValueOrigin): DomainNullValue

    Permalink

    Factory method to create a DomainValue that represents value null and and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents value null and and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the value and the origin (pc).

    Summary

    The properties of the domain value are:

    • Initialized: N/A
    • Type: Null
    • Null: Yes
    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValuesReferenceValuesFactory
  69. def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType], t: Timestamp): DomainObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  70. def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType, t: Timestamp): SObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  71. def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType): DomainObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  72. def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType]): DomainObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  73. def ObjectValue(pc: PC, upperTypeBound: UIDSet[ObjectType]): DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents either an class-/interface value that has the given types as an upper bound or the value null.

    Factory method to create a DomainValue that represents either an class-/interface value that has the given types as an upper bound or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound and it is not known if the value is properly initialized.

    Summary

    The properties of the domain value are:

    • Initialized: Unknown (i.e., it is not guaranteed that the constructor was called.)
    • Type: Upper Bound
    • Null: Unknown
    • Content: Unknown
    Definition Classes
    ReferenceValuesTypeLevelReferenceValues
  74. def ObjectValue(pc: PC, objectType: ObjectType): DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents either an class-/interface value that has the given type or the value null.

    Factory method to create a DomainValue that represents either an class-/interface value that has the given type or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound and it is not known if the value is properly initialized.

    Summary

    The properties of the domain value are:

    • Initialized: Unknown
    • Type: Upper Bound
    • Null: Unknown
    • Content: Unknown
    Definition Classes
    ReferenceValuesTypeLevelReferenceValues
  75. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, upperTypeBound: UIDSet[_ <: ReferenceType], t: Timestamp): DomainSingleOriginReferenceValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  76. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType): DomainSingleOriginReferenceValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  77. def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType, t: Timestamp): DomainSingleOriginReferenceValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  78. def ReferenceValue(pc: PC, upperTypeBound: ReferenceType): AReferenceValue

    Permalink

    Factory method to create a DomainValue that represents either a reference value that has the given type and is initialized or the value null.

    Factory method to create a DomainValue that represents either a reference value that has the given type and is initialized or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound.

    The domain may ignore the information about the value and the origin, but it has to remain possible for the domain to identify the component type of an array.

    Summary

    The properties of the domain value are:

    • Initialized: Yes (if non-null the constructor was called/the array was initialized)
    • Type: Upper Bound
    • Null: Unknown
    • Content: Unknown
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  79. final def ReturnAddressValue(address: Int): ReturnAddressValue

    Permalink

    Factory method to create an instance of a ReturnAddressValue.

    Factory method to create an instance of a ReturnAddressValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  80. object SObjectValue

    Permalink
  81. def ShortValue(valueOrigin: ValueOrigin, value: Short): AShortValue.type

    Permalink

    Factory method to create a DomainValue that represents the given short value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given short value and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  82. def ShortValue(valueOrigin: ValueOrigin): AShortValue.type

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  83. implicit object SingleOriginValueOrdering extends Ordering[(Origin.this)#SingleOriginValue]

    Permalink
    Definition Classes
    Origin
  84. def StringValue(origin: ValueOrigin, value: String, t: Timestamp): DomainStringValue

    Permalink
  85. final def StringValue(origin: ValueOrigin, value: String): DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents the given string value and that was created by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given string value and that was created by the instruction with the specified program counter.

    This function is called by OPAL-AI when a string constant (LDC(_W) instruction) is put on the stack.

    The domain may ignore the information about the value and the origin (vo).

    Summary

    The properties of the domain value are:

    • Initialized: Yes and the String's value is the given value. The string may be empty (""), but it is never null.
    • Type: java.lang.String
    • Null: No
    value

    A non-null string. (The string may be empty, though.)

    Definition Classes
    StringValuesReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  86. object StringValue

    Permalink
    Definition Classes
    StringValues
  87. final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]

    Permalink

    The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue.

    The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue. The JVM semantics guarantee that the value will not be used and, hence, continuing the interpretation is meaningless.

    Definition Classes
    ValuesDomain
    Note

    This method is solely defined for documentation purposes and to catch implementation errors early on.

  88. object T

    Permalink

    Extractor for timestamps.

    Extractor for timestamps.

    Definition Classes
    ReferenceValues
  89. final val TheIllegalValue: DomainIllegalValue

    Permalink

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  90. final val TheReturnAddressValues: ReturnAddressValues

    Permalink

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  91. final def Throwable(origin: ValueOrigin): ExceptionValue

    Permalink

    Creates a non-null object that represent a Throwable object and that has the given origin.

    Creates a non-null object that represent a Throwable object and that has the given origin. If the Throwable was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  92. final def TimestampUpdate[T](value: T): MetaInformationUpdate[T]

    Permalink

    Creates an update object that characterizes a timestamp update.

    Creates an update object that characterizes a timestamp update.

    Basically, just a wrapper for a MetaInformationUpdate; the purpose is to better communicate the underlying purpose.

    Definition Classes
    ReferenceValues
    Annotations
    @inline()
  93. def TypedValue(origin: ValueOrigin, valueType: Type): DomainValue

    Permalink

    Factory method to create domain values with a specific type.

    Factory method to create domain values with a specific type. I.e., values for which we have some type information but no precise value or source information. However, the value is guaranteed to be null or properly initialized.

    For example, if valueType is a reference type it may be possible that the actual value is null, but such knowledge is not available.

    The framework uses this method when a method is to be analyzed, but no parameter values are given and initial values need to be generated. This method is not used elsewhere by the framework.

    Definition Classes
    TypedValuesFactory
  94. object UpperTypeBound

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  95. final def VMArithmeticException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  96. final def VMArrayIndexOutOfBoundsException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  97. final def VMArrayStoreException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  98. final def VMClassCastException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  99. final def VMClassNotFoundException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  100. final def VMIllegalMonitorStateException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  101. final def VMNegativeArraySizeException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  102. final def VMNullPointerException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  103. final def VMThrowable(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  104. def aaload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  105. def aastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  106. def abruptMethodExecution(pc: PC, exception: ExceptionValue): Unit

    Permalink

    Called by the abstract interpreter when an exception is thrown that is not (guaranteed to be) handled within the same method.

    Called by the abstract interpreter when an exception is thrown that is not (guaranteed to be) handled within the same method.

    Definition Classes
    DefaultHandlingForThrownExceptionsReturnInstructionsDomain
    Note

    If the original exception value is null (/*E.g.*/throw null;), then the exception that is actually thrown is a new NullPointerException. This situation is, however, completely handled by OPAL and the exception value is hence never null.

  107. def abstractInterpretationEnded(aiResult: AIResult { val domain: TaintAnalysisDomain.this.type }): Unit

    Permalink

    Called by the abstract interpreter when the abstract interpretation of a method has ended.

    Called by the abstract interpreter when the abstract interpretation of a method has ended. The abstract interpretation of a method ends if either the fixpoint is reached or the interpretation was aborted.

    By default this method does nothing.

    Domains that override this method are expected to also call super.abstractInterpretationEnded(aiResult).

    Definition Classes
    CoreDomainFunctionality
  108. def afterBaseJoin(pc: PC): Unit

    Permalink

    This method is called after all values which differ have been joined, but before joinPostProcessing will be called.

    This method is called after all values which differ have been joined, but before joinPostProcessing will be called.

    Attributes
    protected[this]
    Definition Classes
    JoinStabilizationCoreDomainFunctionality
  109. def afterEvaluation(pc: PC, instruction: Instruction, oldOperands: Operands, oldLocals: Locals, targetPC: PC, isExceptionalControlFlow: Boolean, newOperands: Operands, newLocals: Locals): (Operands, Locals)

    Permalink

    This methods is called after the evaluation of the instruction with the given pc with respect to targetPC, but before the values are propagated (joined) and before it is checked whether the interpretation needs to be continued.

    This methods is called after the evaluation of the instruction with the given pc with respect to targetPC, but before the values are propagated (joined) and before it is checked whether the interpretation needs to be continued. I.e., if the operands (newOperands) or locals (newLocals) are further refined then the refined operands and locals are joined (if necessary).

    Definition Classes
    PostEvaluationMemoryManagementCoreDomainFunctionality
    Note

    During the evaluation of the instruction it is possible that this method is called multiple times with different targetPCs. The latter is not only true for control flow instructions, but also for those instructions that may raise an exception. This method can and is intended to be overridden to further refine the operand stack/the locals. However, the overriding method should always forward the (possibly refined) operands and locals to the super method (stackable traits).

  110. def areturn(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    The given value, which is a value with computational type reference, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type reference, is returned by the return instruction with the given pc.

    Definition Classes
    TaintAnalysisDomainDefaultHandlingForReturnInstructionsReturnInstructionsDomain
  111. def arraylength(pc: PC, arrayref: DomainValue): Computation[DomainValue, ExceptionValue]

    Permalink

    Returns the array's length or throws a NullPointerException if the given reference is null.

    Returns the array's length or throws a NullPointerException if the given reference is null.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    It is in general not necessary to override this method. If you need some special handling refine the trait ArrayValue.

  112. def arrayload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink

    Loads the value stored in the array at the given index or throws an exception (NullPointerException or IndexOutOfBoundsException).

    Loads the value stored in the array at the given index or throws an exception (NullPointerException or IndexOutOfBoundsException).

    Definition Classes
    TypeLevelReferenceValuesGeneralizedArrayHandling
    Note

    It is in general not necessary to override this method. If you need some special handling refine the load method defined by the trait ArrayValue.

  113. def arraystore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink

    Stores the given value in the array at the given index or throws an exception (NullPointerException, ArrayStoreException or IndexOutOfBoundsException).

    Stores the given value in the array at the given index or throws an exception (NullPointerException, ArrayStoreException or IndexOutOfBoundsException).

    Definition Classes
    TypeLevelReferenceValuesGeneralizedArrayHandling
    Note

    It is in general not necessary to override this method. If you need some special handling refine the store method defined by the trait ArrayValue.

  114. def asArrayAbstraction(value: DomainValue): ArrayAbstraction

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  115. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  116. def asObjectValue(value: DomainValue): DomainObjectValue

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  117. def asReferenceValue(value: DomainValue): AReferenceValue

    Permalink

    Returns the given value as a DomainReferenceValue.

    Returns the given value as a DomainReferenceValue. Basically just performs a type cast and is intended to be used to communicate that the value has to be a reference value (if the underlying byte code is valid.)

    Definition Classes
    TypeLevelReferenceValues
  118. def baload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  119. def bastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  120. def beforeBaseJoin(pc: PC): Unit

    Permalink

    This method is called immediately before a join operation with regard to the specified pc is performed.

    This method is called immediately before a join operation with regard to the specified pc is performed.

    Attributes
    protected[this]
    Definition Classes
    CoreDomainFunctionality
    Note

    This method is intended to be overwritten by clients to perform custom operations.

  121. var callToClassForNameFound: Boolean

    Permalink

    Stores if a call to Class.forName has occurred.

    Stores if a call to Class.forName has occurred. No report is created if this is not true

    Attributes
    protected
  122. def caload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  123. def castore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  124. def checkForSink(declaringClass: ObjectType, descriptor: MethodDescriptor, name: String): Boolean

    Permalink

    Check if the method call resembles a call to Class.forName.

    Check if the method call resembles a call to Class.forName. In this case the analysis has found a sink and this method returns true.

  125. implicit final def classHierarchy: ClassHierarchy

    Permalink

    Returns the project's class hierarchy.

    Returns the project's class hierarchy.

    Definition Classes
    TheProjectTheClassHierarchy
    Annotations
    @inline()
  126. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. def code: Code

    Permalink

    Returns the code block that is currently analyzed.

    Returns the code block that is currently analyzed.

    Definition Classes
    TaintAnalysisDomainTheCode
  128. def computeRelevantOperands(operands: Operands): Chain[(DomainValue, Int)]

    Permalink

    Compares the list of possibly tainted values with the operands and returns all parameters that could be tainted.

  129. def contextIdentifier: String

    Permalink
    Attributes
    protected
  130. def d2f(pc: PC, value: DomainValue): DomainValue

    Permalink
  131. def d2i(pc: PC, value: DomainValue): DomainValue

    Permalink
  132. def d2l(pc: PC, value: DomainValue): DomainValue

    Permalink
  133. def dadd(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  134. def daload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  135. def dastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  136. def dcmpg(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  137. def dcmpl(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  138. def ddiv(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  139. def declaringClass: ObjectType

    Permalink
    Attributes
    protected
  140. def descriptor: MethodDescriptor

    Permalink
    Attributes
    protected
  141. def dmul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  142. def dneg(pc: PC, value: DomainValue): DomainValue

    Permalink
  143. def doGetfield(pc: PC, objectref: DomainValue, fieldValue: DomainValue): Computation[DomainValue, ExceptionValue]

    Permalink
  144. def doGetstatic(pc: PC, fieldValue: DomainValue): Computation[DomainValue, Nothing]

    Permalink
  145. def drem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  146. def dreturn(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    The given value, which is a value with computational type double, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type double, is returned by the return instruction with the given pc.

    Definition Classes
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  147. def dsub(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  148. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  149. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  150. def evaluationCompleted(pc: PC, worklist: Chain[PC], evaluated: Chain[PC], operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): Unit

    Permalink

    Called by the framework after evaluating the instruction with the given pc.

    Called by the framework after evaluating the instruction with the given pc. I.e., the state of all potential successor instructions was updated and the flow method was called – potentially multiple times – accordingly.

    By default this method does nothing.

    Definition Classes
    CoreDomainFunctionality
  151. def f2d(pc: PC, value: DomainValue): DomainValue

    Permalink
  152. def f2i(pc: PC, value: DomainValue): DomainValue

    Permalink
  153. def f2l(pc: PC, value: DomainValue): DomainValue

    Permalink
  154. def fadd(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  155. def faload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  156. def fastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  157. def fcmpg(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  158. def fcmpl(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  159. def fdiv(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  160. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  161. def findAndInspectNewEntryPoint(classFile: ClassFile): Unit

    Permalink

    This method tries to find new entry points that use a tainted field.

    This method tries to find new entry points that use a tainted field. For each found entry point a new RootTaintAnalysisDomain is created. If the analyzed method found a bug (created a report) this report is printed.

  162. def flow(currentPC: PC, currentOperands: Operands, currentLocals: Locals, successorPC: PC, isSuccessorScheduled: Answer, isExceptionalControlFlow: Boolean, abruptSubroutineTerminationCount: Int, wasJoinPerformed: Boolean, worklist: Chain[PC], operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): Chain[PC]

    Permalink

    Called by the framework after performing a computation to inform the domain about the result.

    Called by the framework after performing a computation to inform the domain about the result. That is, after evaluating the effect of the instruction with currentPC on the current stack and register and (if necessary) joining the updated stack and registers with the stack and registers associated with the instruction successorPC. (Hence, this method is ONLY called for return instructions if the return instruction throws an IllegalMonitorStateException.) This function basically informs the domain about the instruction that may be evaluated next. The flow function is called for every possible successor of the instruction with currentPC. This includes all branch targets as well as those instructions that handle exceptions.

    In some cases it will even be the case that flow is called multiple times with the same pair of program counters: (currentPC, successorPC). This may happen, e.g., in case of a switch instruction where multiple values have the same body/target instruction and we do not have precise information about the switch value. E.g., as in the following snippet:

    switch (i) {  // pc: X => Y (for "1"), Y (for "2"), Y (for "3")
    case 1:
    case 2:
    case 3: System.out.println("Great.");            // pc: Y
    default: System.out.println("Not So Great.");    // pc: Z
    }

    The flow function is also called after instructions that are domain independent such as dup and load instructions which just manipulate the registers and stack in a generic way. This enables the domain to precisely follow the evaluation progress and in particular to perform control-flow dependent analyses.

    currentPC

    The program counter of the instruction that is currently evaluated by the abstract interpreter.

    currentOperands

    The current operands. I.e., the operand stack before the instruction is evaluated.

    currentLocals

    The current locals. I.e., the locals before the instruction is evaluated.

    successorPC

    The program counter of an instruction that is a potential successor of the instruction with currentPC. In general the AI framework adds the pc of the successor instruction to the beginning of the worklist unless it is a join instruction. In this case the pc is added to the end – in the context of the current (sub)routine. Hence, the AI framework first evaluates all paths leading to a join instruction before the join instruction will be evaluated.

    isSuccessorScheduled

    Yes if the successor instruction is or was scheduled. I.e., Yes is returned if the worklist contains successorPC, No if the worklist does not contain successorPC. Unknown is returned if the AI framework did not process the worklist and doesn't know anything about the scheduled successors. Note that this value is independent of the subroutine in which the value may be scheduled. If an implementation schedules successorPC the the super call has to set isSuccessorScheduled to Yes.

    isExceptionalControlFlow

    true if and only if the evaluation of the instruction with the program counter currentPC threw an exception; false otherwise. Hence, if this parameter is true the instruction with successorPC is the first instruction of the handler.

    abruptSubroutineTerminationCount

    > 0 if and only if we have an exceptional control flow that terminates one or more subroutines. In this case the successor instruction is scheduled (if at all) after all subroutines that will be terminated by the exception.

    wasJoinPerformed

    true if a join was performed. I.e., the successor instruction is an instruction (Code.cfJoins) that was already previously evaluated and where multiple paths potentially join.

    worklist

    The current list of instructions that will be evaluated next.

    If subroutines are not used (i.e., Java >= 5)

    If you want to force the evaluation of the instruction with the program counter successorPC it is sufficient to test whether the list already contains successorPC and – if not – to prepend it. If the worklist already contains successorPC then the domain is allowed to move the PC to the beginning of the worklist.

    If the code contains subroutines (JSR/RET)

    If the PC does not belong to the same (current) (sub)routine, it is not allowed to be moved to the beginning of the worklist. (Subroutines can only be found in code generated by old Java compilers; before Java 6. Subroutines are identified by jsr/ret instructions. A subroutine can be identified by going back in the worklist and by looking for specific "program counters" (e.g., SUBROUTINE_START, SUBROUTINE_END). These program counters mark the beginning of a subroutine. In other words, an instruction can be freely moved around unless a special program counter value is found. All special program counters use negative values. Additionally, neither the negative values nor the positive values between two negative values should be changed. Furthermore, no value (PC) should be put between negative values that capture subroutine information. If the domain updates the worklist, it is the responsibility of the domain to call the tracer and to inform it about the changes. Note that the worklist is not allowed to contain duplicates related to the evaluation of the current (sub-)routine.

    operandsArray

    The array that associates every instruction with its operand stack that is in effect. Note, that only those elements of the array contain values that are related to instructions that were evaluated in the past; the other elements are null. Furthermore, it identifies the operandsArray of the subroutine that will execute the instruction with successorPC. The operandsArray may be null for the current instruction (not the successor instruction) if the execution of the current instruction leads to the termination of the current subroutine. In this case the information about the operands and locals associated with all instructions belonging to the subroutine is reset.

    localsArray

    The array that associates every instruction with its current register values. Note, that only those elements of the array contain values that are related to instructions that were evaluated in the past. The other elements are null. Furthermore, it identifies the localsArray of the subroutine that will execute the instruction with successorPC. The localsArray may be null for the current instruction (not the successor instruction) if the execution of the current instruction leads to the termination of the current subroutine. In this case the information about the operands and locals associated with all instructions belonging to the subroutine is reset.

    returns

    The updated worklist. In most cases this is simply the given worklist. The default case is also to return the given worklist.

    Definition Classes
    CoreDomainFunctionality
    Note

    A method that overrides this method must always call the super method to ensure that every domain that uses this hook gets informed about a flow.

    ,

    The domain is allowed to modify the worklist, operandsArray and localsArray. However, the AI will not perform any checks. In case of updates of the operandsArray or localsArray it is necessary to first create a shallow copy before updating it. If this is not done, it may happen that the locals associated with other instructions are also updated.

  163. def fmul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  164. def fneg(pc: PC, value: DomainValue): DomainValue

    Permalink
  165. def foreachOrigin(value: DomainValue, f: (ValueOrigin) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Origin
  166. def frem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  167. def freturn(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    The given value, which is a value with computational type float, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type float, is returned by the return instruction with the given pc.

    Definition Classes
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  168. def fsub(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  169. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  170. def getPotentialExceptions(pc: PC): List[ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  171. def getfield(pc: br.PC, objectref: DomainValue, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[DomainValue, ExceptionValue]

    Permalink

    Returns the field's value and/or a new NullPointerException if the given objectref represents the value null.

    Returns the field's value and/or a new NullPointerException if the given objectref represents the value null.

    returns

    The field's value or a new NullPointerException.

    Definition Classes
    TaintAnalysisDomainTypeLevelFieldAccessInstructionsFieldAccessesDomain
  172. def getstatic(pc: br.PC, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[DomainValue, Nothing]

    Permalink

    Returns the field's value.

    Returns the field's value.

    Definition Classes
    TaintAnalysisDomainTypeLevelFieldAccessInstructionsFieldAccessesDomain
  173. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, targetMethods: Set[Method], receiverIsNull: Answer, operands: Operands): MethodCallResult

    Permalink

    methodDescriptor

    The method descriptor as specified by the invoke instruction. In case of the invocation of a signature polymorphic method using org.opalj.br.instructions.INVOKEVIRTUAL the descriptor of the invoked method may differ from the descriptor used by the method. Nevertheless, the MethodCallResult has to satisfy the requirements of the caller. In particular regarding the return type.

    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  174. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  175. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, receiverIsNull: Answer): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  176. def handleInvoke(pc: PC, targetMethod: Method, operands: Operands): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  177. def handleInvoke(pc: PC, methodDescriptor: MethodDescriptor): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  178. def handleReturn(pc: PC): Computation[Nothing, ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ReturnInstructionsDomain
  179. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  180. def i2b(pc: PC, value: DomainValue): DomainValue

    Permalink
  181. def i2c(pc: PC, value: DomainValue): DomainValue

    Permalink
  182. def i2d(pc: PC, value: DomainValue): DomainValue

    Permalink
  183. def i2f(pc: PC, value: DomainValue): DomainValue

    Permalink
  184. def i2l(pc: PC, value: DomainValue): DomainValue

    Permalink
  185. def i2s(pc: PC, value: DomainValue): DomainValue

    Permalink
  186. def iadd(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  187. def iaload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  188. def iand(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  189. def iastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  190. def idiv(pc: PC, left: DomainValue, right: DomainValue): IntegerValueOrArithmeticException

    Permalink
  191. def iinc(pc: PC, left: DomainValue, right: Int): DomainValue

    Permalink
  192. def imul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  193. def ineg(pc: PC, value: DomainValue): DomainValue

    Permalink
  194. def inspectMethod(pc: br.PC, method: Method, operands: Operands): Boolean

    Permalink

    This method allows for the complete analysis of a given method.

    This method allows for the complete analysis of a given method. It creates a new unique CalledTaintAnalysisDomain and evaluates the returned result of that analysis. It returns true if a relevant Value was returned.

  195. def intAreEqual(pc: PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Tests if the two given integer values are equal.

    Tests if the two given integer values are equal.

    value1

    A value with computational type integer.

    value2

    A value with computational type integer.

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  196. def intAreNotEqual(pc: PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Tests if the two given integer values are not equal.

    Tests if the two given integer values are not equal.

    value1

    A value with computational type integer.

    value2

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  197. def intEstablishAreEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 == value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  198. def intEstablishAreNotEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 != value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  199. def intEstablishIsLessThan(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 < value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  200. def intEstablishIsLessThanOrEqualTo(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 <= value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  201. def intEstablishValue(pc: PC, theValue: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Sets the given domain value to theValue.

    Sets the given domain value to theValue.

    This function is called by OPAL before it starts to explore the branch where this condition has to hold. (This function is, e.g., called whenever we explore the branches of a switch-case statement.) I.e., the constraint is established before a potential join operation.

    value

    An integer domain value that does also, but not exclusively represents theValue.

    Definition Classes
    IntegerValuesDomain
  202. def intIs0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is 0 or maybe 0.

    Tests if the given integer value is 0 or maybe 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  203. def intIsGreaterThan(pc: PC, largerValue: DomainValue, smallerValue: DomainValue): Answer

    Permalink

    Tests if the first integer value is larger than the second value.

    Tests if the first integer value is larger than the second value.

    largerValue

    A value with computational type integer.

    smallerValue

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  204. def intIsGreaterThan0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is > 0 or maybe > 0.

    Tests if the given integer value is > 0 or maybe > 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  205. def intIsGreaterThanOrEqualTo(pc: PC, largerOrEqualValue: DomainValue, smallerOrEqualValue: DomainValue): Answer

    Permalink

    Tests if the first integer value is larger than or equal to the second value.

    Tests if the first integer value is larger than or equal to the second value.

    largerOrEqualValue

    A value with computational type integer.

    smallerOrEqualValue

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  206. def intIsGreaterThanOrEqualTo0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given value is greater than or equal to 0 or maybe greater than or equal to 0.

    Tests if the given value is greater than or equal to 0 or maybe greater than or equal to 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  207. def intIsLessThan(pc: PC, left: DomainValue, right: DomainValue): Answer

    Permalink

    Tests if the first integer value is smaller than the second value.

    Tests if the first integer value is smaller than the second value.

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  208. def intIsLessThan0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is < 0 or maybe < 0.

    Tests if the given integer value is < 0 or maybe < 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  209. def intIsLessThanOrEqualTo(pc: PC, left: DomainValue, right: DomainValue): Answer

    Permalink

    Tests if the first integer value is less than or equal to the second value.

    Tests if the first integer value is less than or equal to the second value.

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  210. def intIsLessThanOrEqualTo0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is less than or equal to 0 or maybe less than or equal to 0.

    Tests if the given integer value is less than or equal to 0 or maybe less than or equal to 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  211. def intIsNot0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is not 0 or maybe not 0.

    Tests if the given integer value is not 0 or maybe not 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  212. def intIsSomeValueInRange(pc: PC, value: DomainValue, lowerBound: Int, upperBound: Int): Answer

    Permalink

    Returns Yes iff at least one possible extension of the given value is in the specified range; that is, if the intersection of the range of values captured by the given value and the specified range is non-empty.

    Returns Yes iff at least one possible extension of the given value is in the specified range; that is, if the intersection of the range of values captured by the given value and the specified range is non-empty.

    For example, if the given value captures all positive integer values and the specified range is [-1,1] then the answer has to be Yes. If we know nothing about the potential extension of the given value the answer will be Unknown. The answer is No iff both ranges are non-overlapping.

    value

    A value that has to be of computational type integer.

    lowerBound

    The range's lower bound (inclusive).

    upperBound

    The range's upper bound (inclusive).

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  213. def intIsSomeValueNotInRange(pc: PC, value: DomainValue, lowerBound: Int, upperBound: Int): Answer

    Permalink

    Returns Yes iff at least one (possible) extension of a given value is not in the specified range; that is, if the set difference of the range of values captured by the given value and the specified range is non-empty.

    Returns Yes iff at least one (possible) extension of a given value is not in the specified range; that is, if the set difference of the range of values captured by the given value and the specified range is non-empty. For example, if the given value has the integer value 10 and the specified range is [0,Integer.MAX_VALUE] then the answer has to be No. But, if the given value represents the range [-5,Integer.MAX_VALUE] and the specified range is again [0,Integer.MAX_VALUE] then the answer has to be Yes.

    The answer is Yes iff the analysis determined that at runtime value will have a value that is not in the specified range. If the analysis(domain) is not able to determine whether the value is or is not in the given range then the answer has to be Unknown.

    value

    A value that has to be of computational type integer.

    lowerBound

    The range's lower bound (inclusive).

    upperBound

    The range's upper bound (inclusive).

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  214. def invokedynamic(pc: PC, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  215. def invokeinterface(pc: Int, declaringClass: ObjectType, name: String, descriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  216. def invokespecial(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, descriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  217. def invokestatic(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, descriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  218. def invokevirtual(pc: Int, declaringClass: ReferenceType, name: String, descriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  219. def ior(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  220. def irem(pc: PC, left: DomainValue, right: DomainValue): IntegerValueOrArithmeticException

    Permalink
  221. def ireturn(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    The given value, which is a value with computational type integer, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type integer, is returned by the return instruction with the given pc.

    Definition Classes
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  222. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  223. def isIrrelevantInvoke(descriptor: MethodDescriptor, declaringClass: ReferenceType): Boolean

    Permalink

    checks if the invoke is irrelevant A relevant call needs to return a Class or an Object and its declaring Class must be an ObjectType

  224. def isNull(values: Iterable[AReferenceValue]): Answer

    Permalink

    Determines the common null-ness property of the given reference values.

    Determines the common null-ness property of the given reference values.

    Attributes
    protected
    Definition Classes
    ReferenceValues
  225. def isPrecise(values: Iterable[AReferenceValue]): Boolean

    Permalink

    Determines if the runtime object type referred to by the given values is always the same.

    Determines if the runtime object type referred to by the given values is always the same. I.e., it determines if all values are precise and have the same upperTypeBound. Null values are ignored when determining the precision.

    Attributes
    protected
    Definition Classes
    ReferenceValues
  226. final def isRecursiveCall(method: Method, parameters: DomainValues): Boolean

    Permalink
  227. def isRelevantValueReturned(): Boolean

    Permalink

    Note

    Calling this method only makes sense when the analysis of this domain's method has completed.

  228. def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Permalink

    Definition Classes
    TheClassHierarchy
    See also

    Delegates to org.opalj.br.ClassHierarchy's isSubtypeOf method.

    Domain.isSubtypeOf

  229. final def isValueSubtypeOf(value: DomainValue, supertype: ReferenceType): Answer

    Permalink

    Tries to determine – under the assumption that the given value is not null – if the runtime type of the given reference value could be a subtype of the specified reference type supertype.

    Tries to determine – under the assumption that the given value is not null – if the runtime type of the given reference value could be a subtype of the specified reference type supertype. I.e., if the type of the value is not precisely known, then all subtypes of the value's type are also taken into consideration when analyzing the subtype relation and only if we can guarantee that none is a subtype of the given supertype the answer will be No.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    The returned value is only meaningful if value does not represent the runtime value null.

  230. def ishl(pc: PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink
  231. def ishr(pc: PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink
  232. def isub(pc: PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink
  233. def iushr(pc: PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink
  234. def ixor(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  235. def join(pc: PC, thisOperands: Operands, thisLocals: Locals, otherOperands: Operands, otherLocals: Locals): Update[(Operands, Locals)]

    Permalink

    Joins the given operand stacks and local variables.

    Joins the given operand stacks and local variables.

    In general there should be no need to refine this method. Overriding this method should only be done for analysis purposes.

    Performance

    This method heavily relies on reference comparisons to speed up the overall process of performing an abstract interpretation of a method. Hence, a computation should – whenever possible – return (one of) the original object(s) if that value has the same abstract state as the result. Furthermore, if all original values capture the same abstract state as the result of the computation, the "left" value/the value that was already used in the past should be returned.

    returns

    The joined operand stack and registers. Returns NoUpdate if this memory layout already subsumes the other memory layout.

    Definition Classes
    CoreDomainFunctionality
    Note

    The operand stacks are guaranteed to contain compatible values w.r.t. the computational type (unless the bytecode is not valid or OPAL contains an error). I.e., if the result of joining two operand stack values is an IllegalValue we assume that the domain implementation is incorrect. However, the joining of two register values can result in an illegal value - which identifies the value as being dead.

    ,

    The size of the operands stacks that are to be joined and the number of registers/locals that are to be joined can be expected to be identical under the assumption that the bytecode is valid and the framework contains no bugs.

  236. def joinPostProcessing(updateType: UpdateType, pc: PC, oldOperands: Operands, oldLocals: Locals, newOperands: Operands, newLocals: Locals): Update[(Operands, Locals)]

    Permalink

    Enables the customization of the behavior of the base join method.

    Enables the customization of the behavior of the base join method.

    This method in particular enables, in case of a MetaInformationUpdate, to raise the update type to force the continuation of the abstract interpretation process.

    Methods should always override this method and should call the super method.

    updateType

    The current update type. The level can be raised. It is an error to lower the update level.

    oldOperands

    The old operands, before the join. Should not be changed.

    oldLocals

    The old locals, before the join. Should not be changed.

    newOperands

    The new operands; may be updated.

    newLocals

    The new locals; may be updated.

    Attributes
    protected[this]
    Definition Classes
    IdentityBasedCorrelationChangeDetectionCoreDomainFunctionality
  237. def joinValues(pc: PC, left: DomainValue, right: DomainValue): Update[DomainValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    JoinStabilizationCoreDomainFunctionality
  238. val joinedValues: Map[IdentityPair[AnyRef, AnyRef], Update[DomainValue]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    JoinStabilization
  239. def jumpToSubroutine(pc: PC, branchTarget: PC, returnTarget: PC): Unit

    Permalink

    pc

    The pc of the jsr(w) instruction.

    Definition Classes
    SubroutinesDomain
  240. final def justThrows(value: ExceptionValue): ThrowsException[ExceptionValues]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  241. def l2d(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to a double value.

    Conversion of the given long value to a double value.

    returns

    The result of calling DoubleValue(pc).

    Definition Classes
    TypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  242. def l2f(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to a float value.

    Conversion of the given long value to a float value.

    returns

    The result of calling FloatValue(pc).

    Definition Classes
    TypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  243. def l2i(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to an integer value.

    Conversion of the given long value to an integer value.

    returns

    The result of calling IntegerValue(pc).

    Definition Classes
    TypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  244. def ladd(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Add of two long values.

    Add of two long values.

    pc

    The pc of the add(+) instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  245. def laload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  246. def land(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Boolean and of two long values.

    Boolean and of two long values.

    pc

    The pc of the "&" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  247. def lastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  248. def lcmp(pc: PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink

    Comparison (==) of two long values.

    Comparison (==) of two long values.

    pc

    The pc of the comparison instruction.

    returns

    The result of calling IntegerValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  249. def ldiv(pc: PC, left: DomainValue, right: DomainValue): LongValueOrArithmeticException

    Permalink

    Division of two long values.

    Division of two long values.

    pc

    The pc of the div (/) instruction.

    returns

    Either ComputedValue(LongValue(pc)) if arithmetic exceptions should not be thrown if nothing is known about the precise value or – if the policy is to throw an ArithmeticException if in doubt – a ComputedValueOrException(LongValue(pc), ArithmeticException(pc))

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  250. def lmul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Multiplication of two long values.

    Multiplication of two long values.

    pc

    The pc of the mul (/) instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  251. def lneg(pc: PC, value: DomainValue): DomainValue

    Permalink

    Negation of a long value.

    Negation of a long value.

    pc

    The pc of the neg instruction.

    value

    A long value (guaranteed by the JVM's semantics).@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  252. implicit final def logContext: LogContext

    Permalink
    Definition Classes
    TheProjectLogContextProvider
  253. def lor(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Boolean or of two long values.

    Boolean or of two long values.

    pc

    The pc of the "boolean or" (|) instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  254. def lrem(pc: PC, left: DomainValue, right: DomainValue): LongValueOrArithmeticException

    Permalink

    Remainder of two long values.

    Remainder of two long values.

    pc

    The pc of the div (/) instruction.

    returns

    Either ComputedValue(LongValue(pc)) if arithmetic exceptions should not be thrown if nothing is known about the precise value or – if the policy is to throw an ArithmeticException if in doubt – a ComputedValueOrException(LongValue(pc), ArithmeticException(pc))

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  255. def lreturn(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    The given value, which is a value with computational type long, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type long, is returned by the return instruction with the given pc.

    Definition Classes
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  256. def lshl(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Shift left of a long value.

    Shift left of a long value.

    pc

    The pc of the "shift left" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A int value (guaranteed by the JVM's semantics) that determines the number of bits to shift.@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesShiftOperatorsLongValuesDomain
  257. def lshr(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Shift right of a long value.

    Shift right of a long value.

    pc

    The pc of the "shift right" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    An int value (guaranteed by the JVM's semantics) that determines the number of bits to shift.@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesShiftOperatorsLongValuesDomain
  258. def lsub(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Subtraction of two long values.

    Subtraction of two long values.

    pc

    The pc of the sub(-) instruction.

    value1

    A long value (guaranteed by the JVM's semantics.)

    value2

    A long value (guaranteed by the JVM's semantics.)@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  259. def lushr(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Unsigned shift right of a long value.

    Unsigned shift right of a long value.

    pc

    The pc of the "unsigned shift right" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A int value (guaranteed by the JVM's semantics) that determines the number of bits to shift.@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesShiftOperatorsLongValuesDomain
  260. def lxor(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    xor of two long values.

    xor of two long values.

    pc

    The pc of the "xor" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).@return The result of calling LongValue(pc).

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  261. def mergeDEComputations(pc: PC, c1: Computation[DomainValue, ExceptionValue], c2: Computation[DomainValue, ExceptionValue]): Computation[DomainValue, ExceptionValue]

    Permalink

    Merges two computations that both resulted in at most one DomainValue or at most one ExceptionValue.

    Merges two computations that both resulted in at most one DomainValue or at most one ExceptionValue.

    If values are merged the merged value will use the specified pc.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  262. def mergeDEsComputations(pc: PC, c1: Computation[DomainValue, ExceptionValues], c2: Computation[DomainValue, ExceptionValues]): Computation[DomainValue, ExceptionValues]

    Permalink

    Merges two computations that both return some DomainValue and some ExceptionValues.

    Merges two computations that both return some DomainValue and some ExceptionValues. If values are merged the merged value will use the specified pc.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  263. def mergeDomainValues(pc: PC, v1: DomainValue, v2: DomainValue): DomainValue

    Permalink

    Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.

    Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.

    This operation is commutative.

    Definition Classes
    ValuesDomain
  264. def mergeEsComputations(pc: PC, c1: Computation[Nothing, ExceptionValues], c2: Computation[Nothing, ExceptionValues]): Computation[Nothing, ExceptionValues]

    Permalink

    Merges two computations that both resulted in at most one ExceptionValue each.

    Merges two computations that both resulted in at most one ExceptionValue each.

    If values are merged the merged value will use the specified pc.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  265. def mergeMultipleExceptionValues(pc: PC, v1s: ExceptionValues, v2s: ExceptionValues): ExceptionValues

    Permalink

    Merges those exceptions that have the same upper type bound.

    Merges those exceptions that have the same upper type bound. This ensures that per upper type bound only one ValuesDomain.DomainValue (which may be a MultipleReferenceValues) is used. For those values that are merged, the given pc is used.

    Definition Classes
    TypeLevelReferenceValues
  266. def method: Method

    Permalink
  267. def monitorenter(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    Handles a monitorenter instruction.

    Handles a monitorenter instruction.

    Definition Classes
    IgnoreSynchronizationMonitorInstructionsDomain
    Note

    The default implementation checks if the given value is null and raises an exception if it is null or maybe null.

  268. def monitorexit(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValues]

    Permalink

    Handles a monitorexit instruction.

    Handles a monitorexit instruction.

    Definition Classes
    IgnoreSynchronizationMonitorInstructionsDomain
    Note

    The default implementation checks if the given value is null and raises an exception if it is null or maybe null.

  269. def multianewarray(pc: PC, counts: Operands, arrayType: ArrayType): Computation[DomainArrayValue, ExceptionValue]

    Permalink

    Creates a multi-dimensional array.

    Creates a multi-dimensional array.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    It is generally not necessary to override this method as it handles all cases in a generic manner.

    ,

    The componentType may be (again) an array type.

  270. def name: String

    Permalink
    Attributes
    protected
  271. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  272. def newarray(pc: PC, count: DomainValue, componentType: FieldType): Computation[DomainValue, ExceptionValue]

    Permalink

    Creates a new array.

    Creates a new array.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    It is generally not necessary to override this method as it handles all cases in a generic manner.

  273. def nextT(): Timestamp

    Permalink

    Returns the next unused time stamp.

    Returns the next unused time stamp.

    Definition Classes
    ReferenceValues
  274. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  275. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  276. final def nullT: Timestamp

    Permalink
    Definition Classes
    ReferenceValues
  277. def origin(value: DomainValue): Iterable[ValueOrigin]

    Permalink

    Returns the origin(s) of the given value if the information is available.

    Returns the origin(s) of the given value if the information is available.

    returns

    The source(s) of the given value if the information is available. Whether the information is available depends on the concrete domains. This trait only defines a general contract how to get access to a value's origin (I.e., the origin of the instruction which created the respective value.) By default this method returns an empty Iterable.

    Definition Classes
    Origin
  278. def postAnalysis(): Boolean

    Permalink

    When the analysis of this domain's method has completed a post analysis can be performed to construct the analysis graph.

    When the analysis of this domain's method has completed a post analysis can be performed to construct the analysis graph.

    Note

    This method must be called at most once otherwise the constructed analysis graph may contain duplicate information.

    ,

    Calling this method only makes sense when the analysis of this domain's method has completed.

  279. def properties(pc: PC, propertyToString: (AnyRef) ⇒ String = (v) ⇒ v.toString): Option[String]

    Permalink

    Returns a string representation of the properties associated with the instruction with the respective program counter.

    Returns a string representation of the properties associated with the instruction with the respective program counter.

    Associating properties with an instruction and maintaining those properties is, however, at the sole responsibility of the Domain.

    This method is predefined to facilitate the development of support tools and is not used by the abstract interpretation framework.

    Domains that define (additional) properties should (abstract) override this method and should return a textual representation of the property.

    Definition Classes
    ValuesDomain
  280. final lazy val propertyStore: PropertyStore

    Permalink
    Definition Classes
    TheProjectThePropertyStore
  281. def putfield(pc: br.PC, objectref: DomainValue, value: DomainValue, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[Nothing, ExceptionValue]

    Permalink

    Sets the field's value if the given objectref is not null(in the Domain).

    Sets the field's value if the given objectref is not null(in the Domain). In the latter case a NullPointerException is thrown.

    Definition Classes
    TaintAnalysisDomainTypeLevelFieldAccessInstructionsFieldAccessesDomain
  282. def putstatic(pc: br.PC, value: DomainValue, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[Nothing, Nothing]

    Permalink

    Sets the field's value.

    Sets the field's value.

    Definition Classes
    TaintAnalysisDomainTypeLevelFieldAccessInstructionsFieldAccessesDomain
  283. def refAreEqual(pc: PC, v1: DomainValue, v2: DomainValue): Answer

    Permalink

    Returns Yes if both DomainReferenceValues definitively identify the same object at runtime.

    Returns Yes if both DomainReferenceValues definitively identify the same object at runtime.

    Using this domain, it is in general not possible to determine that two values are definitively not reference equal unless they are type incompatible.

    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesDomain
  284. def refAreNotEqual(pc: PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Compares the given values for reference inequality.

    Compares the given values for reference inequality. Returns No if both values point to the same instance and returns Yes if both objects are known not to point to the same instance. The latter is, e.g., trivially the case when both values have a different concrete type. Otherwise Unknown is returned.

    If both values are representing the null value the org.opalj.Answer is Yes.

    value1

    A value of computational type reference.

    value2

    A value of computational type reference.

    Definition Classes
    ReferenceValuesDomain
  285. def refEstablishAreEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison succeeded.

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison succeeded.

    Definition Classes
    ReferenceValuesDomain
  286. def refEstablishAreNotEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison failed.

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison failed.

    Definition Classes
    ReferenceValuesDomain
  287. def refEstablishIsNonNull(pc: PC, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Refines the "null"ness property (isNull == No) of the given value.

    Refines the "null"ness property (isNull == No) of the given value.

    Calls refineIsNull on the given ReferenceValue and replaces every occurrence on the stack/in a register with the updated value.

    value

    A ReferenceValue that does not represent the value null.

    Definition Classes
    ReferenceValuesReferenceValuesDomain
  288. def refEstablishIsNull(pc: PC, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Updates the "null"ness property (isNull == Yes) of the given value.

    Updates the "null"ness property (isNull == Yes) of the given value.

    Calls refineIsNull on the given ReferenceValue and replaces every occurrence on the stack/in a register with the updated value.

    value

    A ReferenceValue.

    Definition Classes
    ReferenceValuesReferenceValuesDomain
  289. def refIsNonNull(pc: PC, value: DomainValue): Answer

    Permalink

    Returns Yes if given value is never null, Unknown if the values is maybe null and No otherwise.

    Returns Yes if given value is never null, Unknown if the values is maybe null and No otherwise.

    value

    A value of computational type reference.

    Definition Classes
    ReferenceValuesDomain
  290. final def refIsNull(pc: PC, value: DomainValue): Answer

    Permalink

    Determines the nullness-property of the given value.

    Determines the nullness-property of the given value.

    value

    A value of type ReferenceValue.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
  291. def refSetUpperTypeBoundOfTopOperand(pc: PC, bound: ReferenceType, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Called by the abstract interpreter when the type bound of the top most stack value needs to be refined.

    Called by the abstract interpreter when the type bound of the top most stack value needs to be refined. This method is only called by the abstract interpreter iff an immediately preceding subtype query (typeOf(value) <: bound) returned Unknown. This method must not be ignored – w.r.t. refining the top-most stack value; it is e.g., used by org.opalj.br.instructions.CHECKCAST instructions.

    A domain that is able to identify aliases can use this information to propagate the information to the other aliases.

    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesDomain
  292. def refTopOperandIsNull(pc: PC, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Sets the is null property of the top-most stack value to Yes.

    Sets the is null property of the top-most stack value to Yes. This method is called by the framework when the top-most operand stack value has to be null, but a previous isNull check returned Unknown. E.g., after a org.opalj.br.instructions.CHECKCAST that fails unless the value is "null".

    This method can be ignored; i.e., the return value can be (operands,locals). However, a domain that is able to identify aliases can use this information to propagate the information to the other aliases.

    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesDomain
  293. def refineIsNull(pc: PC, value: DomainValue, isNull: Answer, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ReferenceValues
  294. def registerSink(pc: br.PC, operands: Operands): Unit

    Permalink

    Creates a sinkNode into the call graph and add the PC to additionalRelevantParameters and relevantValuesOrigins

  295. var relevantValuesOrigins: List[(br.PC, CallerNode)]

    Permalink

    Stores the program counters of those invoke instructions that return either a class object or an object with the greatest lower bound java.lang.Object and which were originally passed a relevant value (in particular a relevant parameter).

    Stores the program counters of those invoke instructions that return either a class object or an object with the greatest lower bound java.lang.Object and which were originally passed a relevant value (in particular a relevant parameter).

    Attributes
    protected
  296. lazy val report: Option[String]

    Permalink

    Definition Classes
    TaintAnalysisDomainOptionalReport
    Note

    Calling this method only makes sense when the analysis of this domain's method has completed.

  297. def returnFromSubroutine(pc: PC, lvIndex: Int): Unit

    Permalink

    pc

    The pc of the ret instruction.

    Definition Classes
    SubroutinesDomain
  298. def returnVoid(pc: PC): Computation[Nothing, ExceptionValue]

    Permalink

    Called when a return instruction with the given pc is reached.

    Called when a return instruction with the given pc is reached. In other words, when the method returns normally.

    Definition Classes
    DefaultHandlingOfVoidReturnsReturnInstructionsDomain
  299. var returnedValues: List[(br.PC, DomainValue)]

    Permalink

    Stores the values that are returned by this method.

    Stores the values that are returned by this method. When the analysis of this method has completed the caller can then ask whether a a relevant value was returned.

    Attributes
    protected
  300. def saload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  301. def sastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  302. def schedule(successorPC: PC, abruptSubroutineTerminationCount: Int, worklist: Chain[PC]): Chain[PC]

    Permalink

    This function can be called when the instruction successorPC needs to be scheduled.

    This function can be called when the instruction successorPC needs to be scheduled. The function will test if the instruction is already scheduled and – if so – returns the given worklist. Otherwise the instruction is scheduled in the correct (subroutine-)context.

    Attributes
    protected[this]
    Definition Classes
    CoreDomainFunctionality
  303. def sideEffectOnlyOrExceptions(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    IgnoreSynchronization
  304. def summarize(pc: PC, values: Iterable[DomainValue]): DomainValue

    Permalink

    Creates a summary of the given domain values by summarizing and joining the given values.

    Creates a summary of the given domain values by summarizing and joining the given values. For the precise details regarding the calculation of a summary see Value.summarize(...).

    pc

    The program counter that will be used for the summary value if a new value is returned that abstracts over/summarizes the given values.

    values

    An Iterable over one or more values.

    Definition Classes
    ValuesDomain
    Note

    The current algorithm is generic and should satisfy most needs, but it is not very efficient. However, it should be easy to tailor it for a specific domain/domain values, if need be.

  305. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  306. var taintedFields: List[String]

    Permalink

    Stores a list of all global fields that contain a tainted value

  307. var taintedPCs: List[br.PC]

    Permalink

    Stores relevant PCs that occur during the analysis of a method.

    Stores relevant PCs that occur during the analysis of a method. For examples calls to getstatic or Class.forName

    Attributes
    protected
  308. def throwArithmeticExceptions: Boolean

    Permalink

    If true, all instructions that may raise an arithmetic exception (e.g., idiv, ldiv) should do so if it is impossible to statically determine that no exception will occur.

    If true, all instructions that may raise an arithmetic exception (e.g., idiv, ldiv) should do so if it is impossible to statically determine that no exception will occur. But, if we can statically determine that the operation will raise an exception then the exception will be thrown – independently of this setting. Furthermore, if we can statically determine that no exception will be raised, no exception will be thrown. Hence, this setting only affects computations with values with incomplete information.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  309. def throwArrayIndexOutOfBoundsException: Boolean

    Permalink

    If true an ArrayIndexOutOfBoundsException is thrown if the index cannot be verified to be valid.

    If true an ArrayIndexOutOfBoundsException is thrown if the index cannot be verified to be valid.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  310. def throwArrayStoreException: Boolean

    Permalink

    If true an ArrayStoreException is thrown if it cannot be verified that the value can be stored in the array.

    If true an ArrayStoreException is thrown if it cannot be verified that the value can be stored in the array.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  311. def throwClassCastException: Boolean

    Permalink

    If true a ClassCastException is thrown by CHECKCAST instructions if it cannot be verified that no ClassCastException will be thrown.

    If true a ClassCastException is thrown by CHECKCAST instructions if it cannot be verified that no ClassCastException will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  312. def throwClassNotFoundException: Boolean

    Permalink

    Throw a ClassNotFoundException if the a specific reference type is not known in the current context.

    Throw a ClassNotFoundException if the a specific reference type is not known in the current context. The context is typically a specific Project.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  313. def throwExceptionsOnMethodCall: ExceptionsRaisedByCalledMethod

    Permalink

    Determines the behavior how method calls are handled where the exceptions that the called method may throw are unknown.

    Determines the behavior how method calls are handled where the exceptions that the called method may throw are unknown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  314. def throwIllegalMonitorStateException: Boolean

    Permalink

    If true then monitorexit and the (XXX)return instructions will throw IllegalMonitorStateExceptions unless the analysis is able to determine that the exception is guaranteed to be raised.

    If true then monitorexit and the (XXX)return instructions will throw IllegalMonitorStateExceptions unless the analysis is able to determine that the exception is guaranteed to be raised.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  315. def throwNegativeArraySizeException: Boolean

    Permalink

    If true a NegativeArraySizeException is thrown if the index cannot be verified to be positive.

    If true a NegativeArraySizeException is thrown if the index cannot be verified to be positive.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  316. def throwNullPointerExceptionOnArrayAccess: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  317. def throwNullPointerExceptionOnFieldAccess: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  318. def throwNullPointerExceptionOnMethodCall: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown. Example:

    def demo(o : Object) {
         o.toString  // - If "true", a NullPointerException will ALSO be thrown;
                     //   the operation also succeeds.
                     // - If "false" the operation will "just" succeed
    }
    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  319. def throwNullPointerExceptionOnMonitorAccess: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  320. def throwNullPointerExceptionOnThrow: Boolean

    Permalink

    If true a NullPointerExceptions is thrown if the exception that is to be thrown is not not known to be null.

    If true a NullPointerExceptions is thrown if the exception that is to be thrown is not not known to be null.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  321. final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  322. def toDomainValue(pc: PC, value: AnyRef): DomainReferenceValue

    Permalink

    Converts the given Java object to a corresponding DomainValue.

    Converts the given Java object to a corresponding DomainValue. By creating an DomainValue that represents an initialized (array/object) value.

    pc

    The program counter of the instruction that was responsible for creating the respective value. (This is in – in general – not the instruction where the transformation is performed.)

    value

    The object.

    returns

    A DomainReferenceValue.

    Definition Classes
    StringValuesDefaultJavaObjectToDomainValueConversionAsDomainValue
  323. def toJavaObject(pc: PC, value: DomainValue): Option[AnyRef]

    Permalink

    Converts – if possible – a given DomainValue to a Java object that is appropriately initialized.

    Converts – if possible – a given DomainValue to a Java object that is appropriately initialized.

    Implementation

    Every domain that supports the creation of a Java object's based on a domain value is expected to implement this method and to test if it can create a precise representation of the given value. If not, the implementation has to delegate the responsibility to the super method to creat an abstract representation.

    abstract override def toJavaObject(value : DomainValue): Option[Object] = {
     if(value...)
         // create and return Java object
     else
         super.toJavaObject(value)
    }
    returns

    Some(Object) is returned if it was possible to create a compatible corresponding Java object; otherwise None is returned. Default: None unless the value is null. In the latter case Some(null) is returned.

    Definition Classes
    StringValuesReferenceValuesTypeLevelReferenceValuesAsJavaObject
    Note

    This operation is generally only possible if the domain value maintains enough state information to completely initialize the Java object.

  324. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  325. def typeOfValue(value: DomainValue): TypeInformation

    Permalink

    Returns the type(type bounds) of the given value.

    Returns the type(type bounds) of the given value.

    In general a single value can have multiple type bounds which depend on the control flow. However, all types that the value represents must belong to the same computational type category. I.e., it is possible that the value either has the type "NullPointerException or IllegalArgumentException", but it will never have – at the same time – the (Java) types int and long. Furthermore, it is possible that the returned type(s) is(are) only an upper bound of the real type unless the type is a primitive type.

    This default implementation always returns org.opalj.ai.UnknownType.

    Implementing typeOfValue

    This method is typically not implemented by a single Domain trait/object, but is instead implemented collaboratively by all domains that implement the semantics of certain values. To achieve that, other Domain traits that implement a concrete domain's semantics have to abstract override this method and only return the value's type if the domain knows anything about the type. If a method that overrides this method has no knowledge about the given value, it should delegate this call to its super method.

    Example

    trait FloatValues extends Domain[...] {
      ...
        abstract override def typeOfValue(value: DomainValue): TypesAnswer =
        value match {
          case r: FloatValue ⇒ IsFloatValue
          case _             ⇒ super.typeOfValue(value)
        }
    }
    Definition Classes
    ValuesDomain
  326. def updateAfterEvaluation(oldValue: DomainValue, newValue: DomainValue): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  327. def updateAfterException(oldValue: DomainValue, newValue: DomainValue): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  328. def updateAfterExecution(oldValue: DomainValue, newValueAfterEvaluation: DomainValue, newValueAfterException: DomainValue): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  329. def updateMemoryLayout(oldValue: DomainValue, newValue: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Replaces all occurrences of oldValue (using reference-quality) with newValue.

    Replaces all occurrences of oldValue (using reference-quality) with newValue. If no occurrences are found, the original operands and locals data structures are returned.

    Definition Classes
    CoreDomainFunctionality
  330. def upperTypeBound(theValues: UIDSet[DomainSingleOriginReferenceValue]): UIDSet[_ <: ReferenceType]

    Permalink

    Calculates the most specific common upper type bound of the upper type bounds of all values.

    Calculates the most specific common upper type bound of the upper type bounds of all values. NullValues are ignored.

    Definition Classes
    ReferenceValues
  331. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  332. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  333. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from OptionalReport

Inherited from TheCode

Inherited from TheProject

Inherited from ThePropertyStore

Inherited from LogContextProvider

Inherited from TheClassHierarchy

Inherited from StringValues

Inherited from AsDomainValue

Inherited from DefaultExceptionsFactory

Inherited from ReferenceValues

Inherited from Origin

Inherited from TypeLevelReferenceValues

Inherited from AsJavaObject

Inherited from GeneralizedArrayHandling

Inherited from TypeLevelIntegerValues

Inherited from TypeLevelDoubleValues

Inherited from TypeLevelFloatValues

Inherited from TypeLevelLongValues

Inherited from MethodCallsHandling

Inherited from DefaultDomainValueBinding

Inherited from IgnoreSynchronization

Inherited from DomainId

Inherited from CorrelationalDomain

Inherited from JoinStabilization

Inherited from Domain

Inherited from Configuration

Inherited from TypedValuesFactory

Inherited from ReturnInstructionsDomain

Inherited from MonitorInstructionsDomain

Inherited from MethodCallsDomain

Inherited from FieldAccessesDomain

Inherited from ReferenceValuesDomain

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from DoubleValuesDomain

Inherited from DoubleValuesFactory

Inherited from FloatValuesDomain

Inherited from FloatValuesFactory

Inherited from LongValuesDomain

Inherited from LongValuesFactory

Inherited from IntegerValuesDomain

Inherited from IntegerValuesFactory

Inherited from CoreDomainFunctionality

Inherited from SubroutinesDomain

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

Ungrouped