Class

org.opalj.ai.domain.l1

DefaultDomainWithCFGAndDefUse

Related Doc: package l1

Permalink

class DefaultDomainWithCFGAndDefUse[Source] extends DefaultDomainWithCFG[Source] with RecordDefUse

Configuration of a domain that uses the most capable l1 domains and which also records the abstract-interpretation time control flow graph and def/use information.

Source
DefaultDomain.scala
Linear Supertypes
RecordDefUse, DefaultDomainWithCFG[Source], RecordCFG, DefaultDomain[Source], ConcretePrimitiveValuesConversions, TypeLevelPrimitiveValuesConversions, LongValuesShiftOperators, DefaultLongValues, LongValues, ConcreteLongValues, DefaultIntegerRangeValues, IntegerRangeValues, ConcreteIntegerValues, IntegerRangeValuesFactory, NullPropertyRefinement, MaxArrayLengthRefinement, DefaultClassValuesBinding, ClassValues, DefaultStringValuesBinding, StringValues, PostEvaluationMemoryManagement, DefaultJavaObjectToDomainValueConversion, AsDomainValue, DefaultReferenceValuesBinding, DefaultExceptionsFactory, ReferenceValues, Origin, DefaultTypeLevelReferenceValues, TypeLevelReferenceValues, AsJavaObject, GeneralizedArrayHandling, SpecialMethodsHandling, TypeLevelInvokeInstructions, MethodCallsHandling, TypeLevelFieldAccessInstructions, DefaultTypeLevelDoubleValues, TypeLevelDoubleValues, DefaultTypeLevelFloatValues, TypeLevelFloatValues, DefaultTypeLevelHandlingOfMethodResults, DefaultTypeLevelHandlingForReturnInstructions, DefaultTypeLevelHandlingOfVoidReturns, DefaultTypeLevelHandlingForThrownExceptions, l0.ReturnInstructionsDomain, MonitorInstructionsTracker, CustomInitialization, IgnoreSynchronization, ThrowAllPotentialExceptionsConfiguration, DefaultDomainValueBinding, TheMethod, TheCode, TheProject, ThePropertyStore, LogContextProvider, TheClassHierarchy, CorrelationalDomain, CorrelationalDomainSupport, IdentityBasedCorrelationChangeDetection, JoinStabilization, Domain, Configuration, TypedValuesFactory, PrimitiveValuesConversionsDomain, ai.ReturnInstructionsDomain, MonitorInstructionsDomain, MethodCallsDomain, FieldAccessesDomain, ReferenceValuesDomain, ReferenceValuesFactory, ExceptionsFactory, DoubleValuesDomain, DoubleValuesFactory, FloatValuesDomain, FloatValuesFactory, LongValuesDomain, LongValuesFactory, IntegerValuesDomain, IntegerValuesFactory, CoreDomainFunctionality, SubroutinesDomain, ValuesDomain, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultDomainWithCFGAndDefUse
  2. RecordDefUse
  3. DefaultDomainWithCFG
  4. RecordCFG
  5. DefaultDomain
  6. ConcretePrimitiveValuesConversions
  7. TypeLevelPrimitiveValuesConversions
  8. LongValuesShiftOperators
  9. DefaultLongValues
  10. LongValues
  11. ConcreteLongValues
  12. DefaultIntegerRangeValues
  13. IntegerRangeValues
  14. ConcreteIntegerValues
  15. IntegerRangeValuesFactory
  16. NullPropertyRefinement
  17. MaxArrayLengthRefinement
  18. DefaultClassValuesBinding
  19. ClassValues
  20. DefaultStringValuesBinding
  21. StringValues
  22. PostEvaluationMemoryManagement
  23. DefaultJavaObjectToDomainValueConversion
  24. AsDomainValue
  25. DefaultReferenceValuesBinding
  26. DefaultExceptionsFactory
  27. ReferenceValues
  28. Origin
  29. DefaultTypeLevelReferenceValues
  30. TypeLevelReferenceValues
  31. AsJavaObject
  32. GeneralizedArrayHandling
  33. SpecialMethodsHandling
  34. TypeLevelInvokeInstructions
  35. MethodCallsHandling
  36. TypeLevelFieldAccessInstructions
  37. DefaultTypeLevelDoubleValues
  38. TypeLevelDoubleValues
  39. DefaultTypeLevelFloatValues
  40. TypeLevelFloatValues
  41. DefaultTypeLevelHandlingOfMethodResults
  42. DefaultTypeLevelHandlingForReturnInstructions
  43. DefaultTypeLevelHandlingOfVoidReturns
  44. DefaultTypeLevelHandlingForThrownExceptions
  45. ReturnInstructionsDomain
  46. MonitorInstructionsTracker
  47. CustomInitialization
  48. IgnoreSynchronization
  49. ThrowAllPotentialExceptionsConfiguration
  50. DefaultDomainValueBinding
  51. TheMethod
  52. TheCode
  53. TheProject
  54. ThePropertyStore
  55. LogContextProvider
  56. TheClassHierarchy
  57. CorrelationalDomain
  58. CorrelationalDomainSupport
  59. IdentityBasedCorrelationChangeDetection
  60. JoinStabilization
  61. Domain
  62. Configuration
  63. TypedValuesFactory
  64. PrimitiveValuesConversionsDomain
  65. ReturnInstructionsDomain
  66. MonitorInstructionsDomain
  67. MethodCallsDomain
  68. FieldAccessesDomain
  69. ReferenceValuesDomain
  70. ReferenceValuesFactory
  71. ExceptionsFactory
  72. DoubleValuesDomain
  73. DoubleValuesFactory
  74. FloatValuesDomain
  75. FloatValuesFactory
  76. LongValuesDomain
  77. LongValuesFactory
  78. IntegerValuesDomain
  79. IntegerValuesFactory
  80. CoreDomainFunctionality
  81. SubroutinesDomain
  82. ValuesDomain
  83. AnyRef
  84. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultDomainWithCFGAndDefUse(project: Project[Source], method: Method)

    Permalink

Type Members

  1. trait ALongValue extends (LongValues.this)#LongValue

    Permalink

    Represents an (unknown) long value.

    Represents an (unknown) long value.

    Models the top value of this domain's lattice.

    Definition Classes
    LongValues
  2. type AReferenceValue = ReferenceValue

    Permalink
  3. class AnIntegerValue extends (DefaultIntegerRangeValues.this)#AnIntegerValue

    Permalink

    Represents a specific but unknown Integer value.

    Represents a specific but unknown Integer value.

    Definition Classes
    DefaultIntegerRangeValues
    Note

    The functionality to propagate a constraint crucially depends on the fact that two integer values that are not guaranteed to represent the same runtime value are represented by two different instances of "AnIntegerValue"; otherwise, propagating the constraint that some value (after some kind of check) has to have a special value may affect unrelated values!

  4. trait ArrayAbstraction extends AnyRef

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  5. 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
  6. 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
  7. class ArrayValue extends (ReferenceValues.this)#ArrayValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  8. class ClassValue extends (ClassValues.this)#SObjectValue

    Permalink

    All values (Class<...> c) that represent the same type (e.g.

    All values (Class<...> c) that represent the same type (e.g. java.lang.String) are actually represented by the same class (object) value at runtime.

    Attributes
    protected
    Definition Classes
    ClassValues
  9. type DomainArrayValue = ArrayValue

    Permalink
  10. type DomainClassValue = ClassValue

    Permalink
    Definition Classes
    DefaultClassValuesBindingClassValues
  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. 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.

  27. sealed trait IntegerLikeValue extends (IntegerRangeValues.this)#TypedValue[CTIntType] with IsIntegerValue[(IntegerRangeValues.this)#IntegerLikeValue]

    Permalink

    Abstracts over all values with computational type integer.

    Abstracts over all values with computational type integer.

    Definition Classes
    IntegerRangeValues
  28. class IntegerRange extends (DefaultIntegerRangeValues.this)#IntegerRange

    Permalink

    Represents a specific integer value in the range [lowerBound,upperBound].

    Represents a specific integer value in the range [lowerBound,upperBound].

    Definition Classes
    DefaultIntegerRangeValues
  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. sealed trait LongValue extends (LongValues.this)#TypedValue[LongType] with IsLongValue[(LongValues.this)#LongValue]

    Permalink

    Abstracts over all values with computational type long.

    Abstracts over all values with computational type long.

    Definition Classes
    LongValues
  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 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.

  52. 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
  53. class StringValue extends (StringValues.this)#SObjectValue

    Permalink

    Attributes
    protected
    Definition Classes
    StringValues
  54. class TheLongValue extends (DefaultLongValues.this)#TheLongValue

    Permalink

    Represents a concrete long value.

    Represents a concrete long value.

    Definition Classes
    DefaultLongValues
  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. type ValueOrigins = IntArraySet

    Permalink
    Definition Classes
    RecordDefUse
  59. trait ValueWithOriginInformation extends AnyRef

    Permalink
    Definition Classes
    Origin

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 ADoubleValue extends (DefaultTypeLevelDoubleValues.this)#DoubleValue with Product with Serializable

    Permalink

    Represents an unknown double value.

    Represents an unknown double value.

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

    Permalink
    Definition Classes
    DefaultTypeLevelFloatValues
  6. object ALongValue extends (DefaultLongValues.this)#ALongValue with Product with Serializable

    Permalink

    Represents an unspecific, unknown long value.

    Represents an unspecific, unknown long value.

    Definition Classes
    DefaultLongValues
  7. final val AReferenceValue: ClassTag[AReferenceValue]

    Permalink
  8. def AnIntegerValue(): AnIntegerValue

    Permalink

    Factory method to create a new instance of AnIntegerValue.

    Factory method to create a new instance of AnIntegerValue.

    Definition Classes
    DefaultIntegerRangeValues
  9. 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
  10. 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
  11. 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
  12. def ArrayValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ArrayType, t: Timestamp): DomainArrayValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  13. 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.

  14. object ArrayValue

    Permalink

    Enables matching of DomainValues that are array values.

    Enables matching of DomainValues that are array values.

    Definition Classes
    DefaultTypeLevelReferenceValues
  15. def BooleanValue(origin: ValueOrigin, value: Boolean): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  16. def BooleanValue(origin: ValueOrigin): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  17. def ByteValue(origin: ValueOrigin, value: Byte): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  18. def ByteValue(origin: ValueOrigin): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  19. def CharValue(origin: ValueOrigin, value: Char): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  20. def CharValue(origin: ValueOrigin): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  21. 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
  22. final def ClassNotFoundException(origin: ValueOrigin): ExceptionValue

    Permalink
  23. def ClassValue(origin: ValueOrigin, value: Type, t: Timestamp): DomainClassValue

    Permalink
    Definition Classes
    DefaultClassValuesBinding
  24. def ClassValue(origin: ValueOrigin, value: Type): DomainClassValue

    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
    DefaultClassValuesBindingClassValuesReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  25. object ClassValue

    Permalink
    Definition Classes
    ClassValues
  26. object ConcreteIntegerValue

    Permalink
    Definition Classes
    ConcreteIntegerValues
  27. object ConcreteLongValue

    Permalink
    Definition Classes
    ConcreteLongValues
  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. val DomainClassValue: ClassTag[DomainClassValue]

    Permalink
    Definition Classes
    DefaultClassValuesBindingClassValues
  32. final val DomainMultipleReferenceValues: ClassTag[DomainMultipleReferenceValues]

    Permalink
  33. final val DomainNullValue: ClassTag[DomainNullValue]

    Permalink
  34. final val DomainObjectValue: ClassTag[DomainObjectValue]

    Permalink
  35. 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
  36. final val DomainSingleOriginReferenceValue: ClassTag[DomainSingleOriginReferenceValue]

    Permalink
  37. 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
  38. final val DomainStringValue: ClassTag[DomainStringValue]

    Permalink
  39. 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
  40. 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
  41. 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
  42. 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
  43. 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
  44. 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
  45. 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
  46. 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
  47. 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
  48. final def IntegerRange(lb: Int, ub: Int): IntegerRange

    Permalink

    Creates a new IntegerRange value with the given bounds.

    Creates a new IntegerRange value with the given bounds.

    Definition Classes
    DefaultIntegerRangeValuesIntegerRangeValues
    Annotations
    @inline()
  49. final def IntegerRange(origin: ValueOrigin, lowerBound: Int, upperBound: Int): DomainTypedValue[CTIntType]

    Permalink

    Creates a new IntegerRange value with the given bounds.

    Creates a new IntegerRange value with the given bounds.

    Definition Classes
    IntegerRangeValuesIntegerRangeValuesFactory
  50. def IntegerRange(value: Int): DomainTypedValue[CTIntType]

    Permalink

    Creates a new IntegerRange value with the lower and upper bound set to the given value.

    Creates a new IntegerRange value with the lower and upper bound set to the given value.

    Definition Classes
    IntegerRangeValues
  51. object IntegerRange

    Permalink

    Extractor for IntegerRange values.

    Extractor for IntegerRange values.

    Definition Classes
    IntegerRangeValues
  52. def IntegerValue(origin: ValueOrigin, value: Int): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  53. def IntegerValue(origin: ValueOrigin): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  54. object IsNull

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  55. object IsPrecise

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  56. def LongValue(origin: ValueOrigin, value: Long): TheLongValue

    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
    DefaultLongValuesLongValuesFactory
  57. def LongValue(origin: ValueOrigin): ALongValue.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 (vo).

    Definition Classes
    DefaultLongValuesLongValuesFactory
  58. object MObjectValue

    Permalink
  59. 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
  60. def MethodCallResult(potentialExceptions: Iterable[ExceptionValue]): MethodCallResult

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  62. 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
  63. 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
  64. 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
  65. def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue]): DomainMultipleReferenceValues

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

    Permalink
    Definition Classes
    ReferenceValues
  67. 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
  68. 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
  69. 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
  70. 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).

  71. 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
  72. 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
  73. 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
  74. def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType], t: Timestamp): DomainObjectValue

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

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

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

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  78. 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
  79. 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
  80. 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
  81. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType): DomainSingleOriginReferenceValue

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

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  83. 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
  84. 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
  85. object SObjectValue

    Permalink
  86. def ShortValue(origin: ValueOrigin, value: Short): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  87. def ShortValue(origin: ValueOrigin): DomainTypedValue[CTIntType]

    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
    DefaultIntegerRangeValuesIntegerValuesFactory
  88. implicit object SingleOriginValueOrdering extends Ordering[(Origin.this)#SingleOriginValue]

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

    Permalink
  90. 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
  91. object StringValue

    Permalink
    Definition Classes
    StringValues
  92. 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.

  93. object T

    Permalink

    Extractor for timestamps.

    Extractor for timestamps.

    Definition Classes
    ReferenceValues
  94. final val TheIllegalValue: DomainIllegalValue

    Permalink

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  95. object TheLongValue

    Permalink
    Definition Classes
    LongValues
  96. final val TheReturnAddressValues: ReturnAddressValues

    Permalink

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  97. 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
  98. 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()
  99. 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
  100. object UpperTypeBound

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ExceptionsFactory
  110. final def ValueOrigins(vo: Int): IntArraySet

    Permalink
    Definition Classes
    RecordDefUse
    Annotations
    @inline()
  111. def aaload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

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

    Permalink
  113. def abruptMethodExecution(pc: br.PC, exceptionValue: 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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

  114. def abstractInterpretationEnded(aiResult: AIResult { val domain: DefaultDomainWithCFGAndDefUse.this.type }): Unit

    Permalink

    Completes the computation of the definition/use information by using the recorded cfg.

    Completes the computation of the definition/use information by using the recorded cfg.

    Definition Classes
    RecordDefUseRecordCFGCoreDomainFunctionality
  115. 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
  116. 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
    NullPropertyRefinementCoreDomainFunctionality
    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).

  117. def allExitPCs: BitSet

    Permalink

    Returns all PCs that may lead to the ab(normal) termination of the method.

    Returns all PCs that may lead to the ab(normal) termination of the method. I.e., those instructions (in particular method call instructions) that may throw some unhandled exceptions will also be returned; even if the instruction may also have regular and also exception handlers!

    Definition Classes
    RecordCFG
    Note

    This information is lazily computed.

  118. def allSubroutineStartPCs: PCs

    Permalink

    Returns the PCs of the first instruction of all subroutines.

    Returns the PCs of the first instruction of all subroutines.

    Definition Classes
    RecordCFG
  119. def allSuccessorsOf(pc: br.PC): PCs

    Permalink

    Returns the set of all instructions executed after the instruction with the given pc.

    Returns the set of all instructions executed after the instruction with the given pc. If this set is empty, either the instruction belongs to dead code, the instruction is a return instruction or the instruction throws an exception that is never handled internally.

    Definition Classes
    RecordCFG
    Note

    The set is recalculated on demand.

  120. def areturn(pc: br.PC, 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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

  121. 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
    MaxArrayLengthRefinementTypeLevelReferenceValuesReferenceValuesDomain
    Note

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

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

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

  124. def asArrayAbstraction(value: DomainValue): ArrayAbstraction

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

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

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  127. 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
  128. def baload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

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

    Permalink
  130. def bbCFG: CFG

    Permalink
    Definition Classes
    RecordCFG
  131. 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.

  132. def caload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

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

    Permalink
  134. def cfgAsGraph(): DefaultMutableNode[Chain[br.PC]]

    Permalink

    Creates a graph representation of the CFG.

    Creates a graph representation of the CFG.

    Definition Classes
    RecordCFG
    Note

    This implementation is for debugging purposes only. It is NOT performance optimized!

    ,

    The returned graph is recomputed whenever this method is called.

  135. final def classFile: ClassFile

    Permalink
    Definition Classes
    TheMethod
    Annotations
    @inline()
  136. implicit final def classHierarchy: ClassHierarchy

    Permalink

    Returns the project's class hierarchy.

    Returns the project's class hierarchy.

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final val code: Code

    Permalink

    Returns the code block that is currently analyzed.

    Returns the code block that is currently analyzed.

    Definition Classes
    TheMethodTheCode
  139. def controlDependencies: ControlDependencies

    Permalink
    Definition Classes
    RecordCFG
  140. def createDefUseGraph(code: Code): Set[DefaultMutableNode[ValueOrigin]]

    Permalink

    Creates a multi-graph that represents the method's def-use information.

    Creates a multi-graph that represents the method's def-use information. I.e., in which way a certain value is used by other instructions and where the derived values are then used by further instructions.

    Definition Classes
    RecordDefUse
  141. def d2f(pc: PC, value: DomainValue): DomainValue

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

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

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

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

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

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

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

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

    Permalink
  150. def dmul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

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

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

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

    Permalink
  154. def dominatorTree: DominatorTree

    Permalink

    Returns the dominator tree.

    Returns the dominator tree.

    Definition Classes
    RecordCFG
    Note

    To get the list of all evaluated instructions and their dominators.

    val result = AI(...,...,...)
    val evaluated = result.evaluatedInstructions
  155. def drem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  156. def dreturn(pc: br.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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

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

    Permalink
  158. def dumpDefUseInfo(): Node

    Permalink

    Creates an XHTML document that contains information about the def-/use information.

    Creates an XHTML document that contains information about the def-/use information.

    Definition Classes
    RecordDefUse
  159. def dumpDefUseTable(): Node

    Permalink

    Creates an XHTML table node which contains the def/use information.

    Creates an XHTML table node which contains the def/use information.

    Definition Classes
    RecordDefUse
  160. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  162. 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
  163. def exceptionHandlerSuccessorsOf(pc: br.PC): PCs

    Permalink

    Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may raise an exception.

    Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may raise an exception.

    The returned set is always empty for instructions that cannot raise exceptions, such as the StackManagementInstructions.

    Definition Classes
    RecordCFG
    Note

    The successor instructions are necessarily the handlers of catch blocks.

    ,

    The org.opalj.br.instructions.ATHROW has successors if and only if the thrown exception is directly handled inside this code block.

  164. def f2d(pc: PC, value: DomainValue): DomainValue

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

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

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

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

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

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

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

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

    Permalink
  173. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  174. def flow(currentPC: br.PC, currentOperands: Operands, currentLocals: Locals, successorPC: br.PC, isSuccessorSchedulued: Answer, isExceptionalControlFlow: Boolean, abruptSubroutineTerminationCount: Int, wasJoinPerformed: Boolean, worklist: Chain[br.PC], operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): Chain[br.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.

    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
    RecordCFGCoreDomainFunctionality
    Note

    This method is called by the abstract interpretation framework.

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

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

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

    Permalink
    Definition Classes
    Origin
  178. final def foreachPredecessorOf(pc: br.PC)(f: (br.PC) ⇒ Unit): Unit

    Permalink
    Definition Classes
    RecordCFG
  179. final def foreachSuccessorOf(pc: br.PC)(f: (br.PC) ⇒ Unit): Unit

    Permalink
    Definition Classes
    RecordCFG
  180. def frem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  181. def freturn(pc: br.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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

  182. def fsub(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  185. def getfield(pc: PC, objectref: DomainValue, declaringClass: ObjectType, fieldName: 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
    TypeLevelFieldAccessInstructionsFieldAccessesDomain
  186. def getstatic(pc: PC, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[DomainValue, Nothing]

    Permalink

    Returns the field's value.

    Returns the field's value.

    Definition Classes
    ClassValuesFieldAccessesDomain
  187. 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
  188. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

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

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

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

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

    Permalink

    Creates a computation object that encapsulates the result of a computation that may throw an IllegalMonitorStateException if a monitor is (potentially) used.

    Creates a computation object that encapsulates the result of a computation that may throw an IllegalMonitorStateException if a monitor is (potentially) used. The primary example are the (XXX)return instructions.

    pc

    The program counter of a return instruction.

    Attributes
    protected[this]
    Definition Classes
    ReturnInstructionsDomain
  193. final def handlesException(exceptionHandler: ExceptionHandler): Boolean

    Permalink

    Returns true if the exception handler may handle at least one exception thrown by an instruction in the try block.

    Returns true if the exception handler may handle at least one exception thrown by an instruction in the try block.

    Definition Classes
    RecordCFG
  194. final def hasMultiplePredecessors(pc: br.PC): Boolean

    Permalink

    Returns true if the instruction with the given pc has multiple direct predecessors (more than one).

    Returns true if the instruction with the given pc has multiple direct predecessors (more than one).

    Definition Classes
    RecordCFG
  195. final def hasMultipleSuccessors(pc: br.PC): Boolean

    Permalink
    Definition Classes
    RecordCFG
  196. def hasNoSuccessor(pc: br.PC): Boolean

    Permalink
    Definition Classes
    RecordCFG
  197. def hasSuccessor(pc: br.PC, regularSuccessorsOnly: Boolean, p: (br.PC) ⇒ Boolean): Boolean

    Permalink

    Tests if the instruction with the given pc has a successor instruction with a pc' that satisfies the given predicate p.

    Tests if the instruction with the given pc has a successor instruction with a pc' that satisfies the given predicate p.

    Definition Classes
    RecordCFG
  198. def hashCode(): Int

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

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

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

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

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

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

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

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

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

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

    Permalink
  209. def idiv(pc: PC, numerator: DomainValue, denominator: DomainValue): IntegerValueOrArithmeticException

    Permalink
  210. def iinc(pc: PC, value: DomainValue, increment: Int): DomainValue

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

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

    Permalink
  213. def initProperties(code: Code, cfJoins: BitSet, locals: Locals): Unit

    Permalink

    Override this method to perform custom initialization steps.

    Override this method to perform custom initialization steps.

    Always use abstract override and call the super method; it is recommended to complete the initialization of this domain before calling the super method.

    Definition Classes
    RecordDefUseRecordCFGCustomInitialization
  214. 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
    IntegerRangeValuesIntegerValuesDomain
  215. 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
  216. def intEstablishAreEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerRangeValuesIntegerValuesDomain
    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.

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

    Permalink

    Definition Classes
    IntegerRangeValuesIntegerValuesDomain
    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.

  218. def intEstablishIsLessThan(pc: PC, left: DomainValue, right: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerRangeValuesIntegerValuesDomain
    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.

  219. def intEstablishIsLessThanOrEqualTo(pc: PC, left: DomainValue, right: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerRangeValuesIntegerValuesDomain
    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.

  220. 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
    IntegerRangeValuesIntegerValuesDomain
  221. 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
  222. 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
  223. 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
  224. 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
  225. 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
  226. 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
    IntegerRangeValuesIntegerValuesDomain
  227. 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
  228. 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
    IntegerRangeValuesIntegerValuesDomain
  229. 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
  230. 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
  231. 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
    IntegerRangeValuesIntegerValuesDomain
  232. 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
    IntegerRangeValuesIntegerValuesDomain
  233. final def intValue[T](value: DomainValue)(f: (Int) ⇒ T)(orElse: ⇒ T): T

    Permalink

    If the given value encapsulates a precise integer value then the function ifThen is called with the respective value otherwise orElse is called.

    If the given value encapsulates a precise integer value then the function ifThen is called with the respective value otherwise orElse is called.

    Definition Classes
    IntegerRangeValuesConcreteIntegerValues
    Annotations
    @inline()
  234. final def intValueOption(value: DomainValue): Option[Int]

    Permalink

    Returns the current Int value represented by the domain value if it exists.

    Returns the current Int value represented by the domain value if it exists.

    Definition Classes
    IntegerRangeValuesConcreteIntegerValues
    Annotations
    @inline()
    Note

    This method returns None if the DomainValue does not represent an Integer value or the precise value is not known. I.e., this method never fails.

  235. final def intValues[T](value1: DomainValue, value2: DomainValue)(f: (Int, Int) ⇒ T)(orElse: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    IntegerRangeValues
    Annotations
    @inline()
  236. def invokedynamic(pc: PC, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  237. def invokeinterface(pc: PC, declaringClass: ObjectType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  238. def invokespecial(pc: PC, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
    Definition Classes
    StringValuesMethodCallsDomain
  239. def invokestatic(pc: PC, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
    Definition Classes
    ClassValuesMethodCallsDomain
  240. def invokevirtual(pc: PC, declaringClass: ReferenceType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

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

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

    Permalink
  243. def ireturn(pc: br.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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

  244. def isDirectRegularPredecessorOf(pc: br.PC, successorPC: br.PC): Boolean

    Permalink
    Definition Classes
    RecordCFG
  245. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  246. def isMonitorInstructionUsed: Boolean

    Permalink
    Definition Classes
    MonitorInstructionsTracker
  247. 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
  248. 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
  249. def isRegularPredecessorOf(pc: br.PC, successorPC: br.PC): Boolean

    Permalink

    Tests if the instruction with the given pc is a direct or indirect predecessor of the given successor instruction.

    Tests if the instruction with the given pc is a direct or indirect predecessor of the given successor instruction.

    If pc equals successorPC true is returned.

    Please note, that this method can be expensive basically traverses the entire graph if successorPC is NOT a regular predecessor of successorPC.

    Definition Classes
    RecordCFG
  250. def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Permalink

    Definition Classes
    TheClassHierarchy
    See also

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

    Domain.isSubtypeOf

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

  252. def ishl(pc: PC, value: DomainValue, shift: DomainValue): DomainValue

    Permalink
  253. def ishr(pc: PC, value: DomainValue, shift: DomainValue): DomainValue

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

    Permalink
  255. def iushr(pc: PC, value: DomainValue, shift: DomainValue): DomainValue

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

    Permalink
  257. 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.

  258. 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
  259. def joinValues(pc: PC, left: DomainValue, right: DomainValue): Update[DomainValue]

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

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

    Permalink

    pc

    The pc of the jsr(w) instruction.

    Definition Classes
    RecordCFGSubroutinesDomain
  262. final def justThrows(value: ExceptionValue): ThrowsException[ExceptionValues]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  263. def justThrowsException(pc: br.PC): Boolean

    Permalink

    Returns true if the execution of the given instruction – identified by its pc – always just throws an exception that is (potentially) handled by the method.

    Returns true if the execution of the given instruction – identified by its pc – always just throws an exception that is (potentially) handled by the method.

    Definition Classes
    RecordCFG
  264. 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
    ConcretePrimitiveValuesConversionsTypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  265. 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
    ConcretePrimitiveValuesConversionsTypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  266. 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
    ConcretePrimitiveValuesConversionsTypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  267. 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).

    Definition Classes
    LongValuesLongValuesDomain
  268. def laload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  269. 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).

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

    Permalink
  271. 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

    A domain value that encapsulates an integer value with the value -1,0 or 1.

    Definition Classes
    LongValuesLongValuesDomain
  272. def ldiv(pc: PC, numerator: DomainValue, denominator: DomainValue): LongValueOrArithmeticException

    Permalink

    Division of two long values.

    Division of two long values.

    pc

    The pc of the div (/) instruction.

    returns

    The return value is the calculated value and/or (depending on the domain) an ArithmeticException if value2 is 0.

    Definition Classes
    LongValuesLongValuesDomain
  273. 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).

    Definition Classes
    LongValuesLongValuesDomain
  274. 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).

    Definition Classes
    LongValuesLongValuesDomain
  275. def localOrigin(pc: PC, registerIndex: Int): ValueOrigins

    Permalink

    Returns the instruction(s) which define(s) the value found in the register variable with index registerIndex and the program counter pc.

    Returns the instruction(s) which define(s) the value found in the register variable with index registerIndex and the program counter pc.

    Definition Classes
    RecordDefUse
  276. implicit final def logContext: LogContext

    Permalink
    Definition Classes
    TheProjectLogContextProvider
  277. final def longValue[T](value: DomainValue)(ifThen: (Long) ⇒ T)(orElse: ⇒ T): T

    Permalink

    If the given value represents one specific long value then the function ifThen is called with the respective value otherwise orElse is called.

    If the given value represents one specific long value then the function ifThen is called with the respective value otherwise orElse is called.

    Definition Classes
    LongValuesConcreteLongValues
    Annotations
    @inline()
  278. final def longValueOption(value: DomainValue): Option[Long]

    Permalink

    Returns the current Long value represented by the domain value if it exists.

    Returns the current Long value represented by the domain value if it exists.

    Definition Classes
    LongValuesConcreteLongValues
    Annotations
    @inline()
    Note

    This method returns None if the DomainValue does not represent a Long value or the precise value is not known. I.e., this method never fails.

  279. final def longValues[T](value1: DomainValue, value2: DomainValue)(ifThen: (Long, Long) ⇒ T)(orElse: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    LongValues
    Annotations
    @inline()
  280. 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).

    Definition Classes
    LongValuesLongValuesDomain
  281. 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

    The return value is the calculated value and/or (depending on the domain) an ArithmeticException if value2 is 0.

    Definition Classes
    LongValuesLongValuesDomain
  282. def lreturn(pc: br.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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

  283. def lshl(pc: PC, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]

    Permalink

    Shift left of a long value.

    Shift left of a long value.

    pc

    The pc of the "shift left" instruction.

    Definition Classes
    LongValuesShiftOperatorsLongValuesDomain
  284. def lshr(pc: PC, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]

    Permalink

    Shift right of a long value.

    Shift right of a long value.

    pc

    The pc of the "shift right" instruction.

    Definition Classes
    LongValuesShiftOperatorsLongValuesDomain
  285. def lsub(pc: PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink

    Subtraction of two long values.

    Subtraction of two long values.

    pc

    The pc of the sub(-) instruction.

    Definition Classes
    LongValuesLongValuesDomain
  286. def lushr(pc: PC, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]

    Permalink

    Unsigned shift right of a long value.

    Unsigned shift right of a long value.

    pc

    The pc of the "unsigned shift right" instruction.

    Definition Classes
    LongValuesShiftOperatorsLongValuesDomain
  287. 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).

    Definition Classes
    LongValuesLongValuesDomain
  288. def maxCardinalityOfIntegerRanges: Long

    Permalink

    Determines the maximum number of values captured by an integer value range.

    Determines the maximum number of values captured by an integer value range.

    This setting is only used when true ranges are merged; in case of a join of two concrete values we will always create an IntegerRange value. If the cardinality is exceeded, we will also first create ranges based on the boundaries determined by the defaul data types (byte,short,char).

    This setting can be adapted at runtime.

    Definition Classes
    IntegerRangeValues
  289. 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
  290. 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
  291. 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
  292. 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
  293. 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
  294. val method: Method

    Permalink

    Returns the method that is currently analyzed.

    Returns the method that is currently analyzed.

    Definition Classes
    DefaultDomainTheMethod
  295. def monitorenter(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    Handles a monitorenter instruction.

    Handles a monitorenter instruction.

    Definition Classes
    MonitorInstructionsTrackerMonitorInstructionsDomain
    Note

    A monitor enter instruction may throw a NullPointerException.

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

    Permalink

    Handles a monitorexit instruction.

    Handles a monitorexit instruction.

    Definition Classes
    MonitorInstructionsTrackerMonitorInstructionsDomain
    Note

    A monitor exit instruction may throw a NullPointerException or an IllegalMonitorStateException.

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

  298. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  299. 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.

  300. def nextT(): Timestamp

    Permalink

    Returns the next unused time stamp.

    Returns the next unused time stamp.

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

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

    Permalink
    Definition Classes
    AnyRef
  303. final def nullT: Timestamp

    Permalink
    Definition Classes
    ReferenceValues
  304. def operandOrigin(pc: PC, stackIndex: Int): ValueOrigins

    Permalink

    Returns the instruction(s) which defined the value used by the instruction with the given pc and which is stored at the stack position with the given stackIndex.

    Returns the instruction(s) which defined the value used by the instruction with the given pc and which is stored at the stack position with the given stackIndex. The first/top value on the stack has index 0 and the second value - if it exists - has index two; independent of the computational category of the values.

    Definition Classes
    RecordDefUse
  305. 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
  306. def postDominatorTree: DominatorTree

    Permalink
    Definition Classes
    RecordCFG
  307. def postDominatorTreeFactory: DominatorTreeFactory

    Permalink
    Definition Classes
    RecordCFG
  308. def predecessorsOf(pc: br.PC): PCs

    Permalink

    Returns the program counter(s) of the instruction(s) that is(are) executed before the instruction with the given pc.

    Returns the program counter(s) of the instruction(s) that is(are) executed before the instruction with the given pc.

    If the instruction with the given pc was never executed an empty set is returned.

    pc

    A valid program counter.

    Definition Classes
    RecordCFG
  309. val project: Project[Source]

    Permalink

    Returns the project that is currently analyzed.

    Returns the project that is currently analyzed.

    Definition Classes
    DefaultDomainTheProject
  310. def properties(pc: Int, propertyToString: (AnyRef) ⇒ String): Option[String]

    Permalink

    Prints out the information by which values the current values are used.

    Prints out the information by which values the current values are used.

    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
    RecordDefUseValuesDomain
  311. final lazy val propertyStore: PropertyStore

    Permalink
    Definition Classes
    TheProjectThePropertyStore
  312. def putfield(pc: PC, objectref: DomainValue, value: DomainValue, declaringClass: ObjectType, fieldName: 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
    TypeLevelFieldAccessInstructionsFieldAccessesDomain
  313. def putstatic(pc: PC, value: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[Nothing, Nothing]

    Permalink

    Sets the field's value.

    Sets the field's value.

    Definition Classes
    TypeLevelFieldAccessInstructionsFieldAccessesDomain
  314. 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
  315. 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
  316. 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
  317. 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
  318. 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
  319. 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
  320. 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
  321. 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
  322. 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
  323. 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
  324. def refineIsNull(pc: PC, value: DomainValue, isNull: Answer, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ReferenceValues
  325. def regularSuccessorsOf(pc: br.PC): PCs

    Permalink

    Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may succeed without raising an exception.

    Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may succeed without raising an exception.

    The returned set is always empty for return instructions. It is also empty for instructions that always throw an exception (e.g., an integer value that is divided by zero will always result in a NullPointException.)

    Definition Classes
    RecordCFG
    Note

    The org.opalj.br.instructions.ATHROW instruction will never have a regularSuccessor. The return instructions will never have any successors.

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

    Permalink

    pc

    The pc of the ret instruction.

    Definition Classes
    SubroutinesDomain
  327. def returnVoid(pc: br.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
    RecordCFGReturnInstructionsDomain
    Note

    This method is only intended to be called by the AI framework.

  328. def saload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

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

    Permalink
  330. 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
  331. def sideEffectOnlyOrExceptions(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    IgnoreSynchronization
  332. def simpleClassForNameCall(pc: PC, className: String): MethodCallResult

    Permalink
    Attributes
    protected[org.opalj.ai.domain.l1]
    Definition Classes
    ClassValues
  333. final def successorsOf(pc: br.PC, regularSuccessorOnly: Boolean): PCs

    Permalink
    Definition Classes
    RecordCFG
  334. 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.

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

    Permalink
    Definition Classes
    AnyRef
  336. 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
  337. 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
  338. 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
  339. 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
  340. 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
  341. 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
  342. 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
  343. 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
  344. 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
  345. 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
  346. 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
  347. 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
  348. 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
  349. final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  350. def throwsException(pc: br.PC): Boolean

    Permalink

    Returns true if the execution of the given instruction – identified by its pc – ex-/implicitly throws an exception that is (potentially) handled by the method.

    Returns true if the execution of the given instruction – identified by its pc – ex-/implicitly throws an exception that is (potentially) handled by the method.

    Definition Classes
    RecordCFG
  351. 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
  352. 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.

  353. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  354. 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
  355. def unused(): ValueOrigins

    Permalink

    Returns the union of the set of unused parameters and the set of all instructions which compute a value that is not used in the following.

    Returns the union of the set of unused parameters and the set of all instructions which compute a value that is not used in the following.

    Definition Classes
    RecordDefUse
  356. def updateAfterEvaluation(oldValue: DomainValue, newValue: DomainValue): Unit

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  359. 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
  360. 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
  361. def usedBy(valueOrigin: ValueOrigin): ValueOrigins

    Permalink

    Returns the instructions which use the value with the given value origin.

    Returns the instructions which use the value with the given value origin.

    Definition Classes
    RecordDefUse
  362. var usesMonitorInstruction: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MonitorInstructionsTracker
  363. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  366. final def wasExecuted(pc: br.PC): Boolean

    Permalink
    Definition Classes
    RecordCFG

Inherited from RecordDefUse

Inherited from DefaultDomainWithCFG[Source]

Inherited from RecordCFG

Inherited from DefaultDomain[Source]

Inherited from LongValuesShiftOperators

Inherited from DefaultLongValues

Inherited from LongValues

Inherited from ConcreteLongValues

Inherited from DefaultIntegerRangeValues

Inherited from IntegerRangeValues

Inherited from ConcreteIntegerValues

Inherited from IntegerRangeValuesFactory

Inherited from NullPropertyRefinement

Inherited from MaxArrayLengthRefinement

Inherited from DefaultClassValuesBinding

Inherited from ClassValues

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 SpecialMethodsHandling

Inherited from MethodCallsHandling

Inherited from TypeLevelDoubleValues

Inherited from TypeLevelFloatValues

Inherited from CustomInitialization

Inherited from IgnoreSynchronization

Inherited from DefaultDomainValueBinding

Inherited from TheMethod

Inherited from TheCode

Inherited from TheProject

Inherited from ThePropertyStore

Inherited from LogContextProvider

Inherited from TheClassHierarchy

Inherited from CorrelationalDomain

Inherited from JoinStabilization

Inherited from Domain

Inherited from Configuration

Inherited from TypedValuesFactory

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