Packages

t

org.opalj.ai

ReferenceValuesDomain

trait ReferenceValuesDomain extends ReferenceValuesFactory

Domain that defines all methods that perform computations related to RefernceValues.

Self Type
ReferenceValuesDomain
Source
ReferenceValuesDomain.scala
Linear Supertypes
ReferenceValuesFactory, ExceptionsFactory, ValuesDomain, AnyRef, Any
Known Subclasses
CorrelationalDomain, Domain, ConstantFieldValuesResolution, GeneralizedArrayHandling, RecordConstraints, ReifiedConstraints, ValuesCoordinatingDomain, BaseDomain, BaseDomainWithDefUse, DefaultReferenceValuesBinding, DefaultTypeLevelIntegerValues, DefaultTypeLevelReferenceValues, PrimitiveTACAIDomain, TypeCheckingDomain, TypeLevelDomain, TypeLevelIntegerValues, TypeLevelReferenceValues, ZeroDomain, ArrayValues, ClassValues, ConcreteArrayValues, DefaultArrayValuesBinding, DefaultClassValuesBinding, DefaultConcreteArrayValuesBinding, DefaultDomain, DefaultDomainWithCFG, DefaultDomainWithCFGAndDefUse, DefaultIntervalValuesDomain, DefaultLongSetValues, DefaultReferenceValuesBinding, DefaultReferenceValuesDomain, DefaultReferenceValuesDomainWithCFGAndDefUse, DefaultSetValuesDomain, DefaultSingletonValuesDomain, DefaultStringValuesBinding, MaxArrayLengthRefinement, ReferenceValues, StringBuilderValues, StringValues, ChildDefaultDomain, CoordinatingValuesDomain, DefaultDomain, DefaultPerformInvocationsDomain, DefaultPerformInvocationsDomainWithCFG, DefaultPerformInvocationsDomainWithCFGAndDefUse, SharedDefaultDomain, SharedValuesDomain, FieldValuesAnalysisDomain, MethodReturnValuesAnalysisDomain, L1DefaultDomainWithCFGAndDefUseAndSignatureRefinement, PrimitiveTACAIDomainWithSignatureRefinement
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReferenceValuesDomain
  2. ReferenceValuesFactory
  3. ExceptionsFactory
  4. ValuesDomain
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type ArrayLoadResult = Computation[DomainValue, ExceptionValues]

    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.

  2. type ArrayStoreResult = Computation[Nothing, ExceptionValues]

    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.

  3. abstract type DomainIllegalValue <: IllegalValue with DomainValue

    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
    ValuesDomain
  4. abstract type DomainReferenceValue >: Null <: ReferenceValue with DomainTypedValue[ReferenceType]
    Definition Classes
    ValuesDomain
  5. abstract type DomainReturnAddressValue <: ReturnAddressValue with DomainValue

    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
    ValuesDomain
  6. abstract type DomainReturnAddressValues <: ReturnAddressValues with DomainValue
    Definition Classes
    ValuesDomain
  7. abstract type DomainTypedValue[+T <: Type] >: Null <: DomainValue
    Definition Classes
    ValuesDomain
  8. abstract type DomainValue >: Null <: Value

    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
    ValuesDomain
  9. type ExceptionValue = DomainReferenceValue

    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
  10. type ExceptionValues = Iterable[ExceptionValue]

    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
  11. type Locals = collection.mutable.Locals[DomainValue]

    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
  12. type LocalsArray = Array[Locals]
    Definition Classes
    ValuesDomain
  13. type Operands = List[DomainValue]

    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
  14. type OperandsArray = Array[Operands]
    Definition Classes
    ValuesDomain
  15. class IllegalValue extends Value with IsIllegalValue

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

    Represents a value that has no well defined state/type. Such values are either the result of a join of two incompatible values or if the variable was identified as being dead. IllegalValue's are only found in registers (in the locals).

    Attributes
    protected
    Definition Classes
    ValuesDomain
    See also

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

  16. trait RETValue extends Value with IsReturnAddressValue
    Definition Classes
    ValuesDomain
  17. trait ReferenceValue extends TypedValue[ReferenceType] with IsReferenceValue
    Definition Classes
    ValuesDomain
  18. class ReturnAddressValue extends RETValue

    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 UnsupportedOperationException as these additional methods will never be called by the OPAL-AI.

  19. class ReturnAddressValues extends RETValue

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

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

    Definition Classes
    ValuesDomain
  20. trait TypedValue[+T <: Type] extends Value with KnownTypedValue
    Definition Classes
    ValuesDomain
  21. trait Value extends ValueInformation

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

Abstract Value Members

  1. abstract def ArithmeticException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  2. abstract def ArrayIndexOutOfBoundsException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  3. abstract def ArrayStoreException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  4. abstract def ClassCastException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  5. abstract def ClassNotFoundException(origin: ValueOrigin): ExceptionValue
    Definition Classes
    ExceptionsFactory
  6. abstract def ClassValue(origin: ValueOrigin, t: Type): DomainReferenceValue

    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
    ReferenceValuesFactory
  7. abstract val DomainReferenceValueTag: ClassTag[DomainReferenceValue]

    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
    ValuesDomain
  8. implicit abstract val DomainValueTag: ClassTag[DomainValue]

    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
    ValuesDomain
  9. abstract def IllegalMonitorStateException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  10. abstract def InitializedDomainValue(origin: ValueOrigin, vi: ValueInformation): DomainValue

    Creates a domain value from the given value information that represents a properly domain value.

    Creates a domain value from the given value information that represents a properly domain value. A representation of a proper value is created even if the value information is provided for an uninitialized value.

    Definition Classes
    ValuesDomain
    Note

    This function is only defined for proper values, i.e., it is not defined for void values or illegal values.

    ,

    This method is intended to be overwritten by concrete domains which can represent more information.

  11. abstract def InitializedObjectValue(origin: ValueOrigin, objectType: ObjectType): DomainReferenceValue

    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 NullPointerException 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
    ReferenceValuesFactory
  12. abstract def MetaInformationUpdateIllegalValue: MetaInformationUpdate[DomainIllegalValue]

    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
    ValuesDomain
  13. abstract def NegativeArraySizeException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  14. abstract def NewObject(origin: ValueOrigin, objectType: ObjectType): DomainReferenceValue

    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 (super) 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
    ReferenceValuesFactory
    Note

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

  15. abstract def NonNullObjectValue(origin: ValueOrigin, objectType: ObjectType): DomainReferenceValue

    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
    ReferenceValuesFactory
  16. abstract def NullPointerException(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  17. abstract def NullValue(origin: ValueOrigin): DomainReferenceValue

    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
    ReferenceValuesFactory
  18. abstract def ReferenceValue(origin: ValueOrigin, referenceType: ReferenceType): DomainReferenceValue

    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
    ReferenceValuesFactory
  19. abstract def ReturnAddressValue(address: Int): DomainReturnAddressValue

    Factory method to create an instance of a ReturnAddressValue.

    Factory method to create an instance of a ReturnAddressValue.

    Definition Classes
    ValuesDomain
  20. abstract def StringValue(origin: ValueOrigin, value: String): DomainReferenceValue

    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
    ReferenceValuesFactory
  21. abstract val TheIllegalValue: DomainIllegalValue

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    ValuesDomain
  22. abstract val TheReturnAddressValues: DomainReturnAddressValues

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    ValuesDomain
  23. abstract def Throwable(origin: ValueOrigin): ExceptionValue

    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 ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    ExceptionsFactory
  24. abstract def UninitializedThis(objectType: ObjectType): DomainReferenceValue

    Creates a new DomainValue that represents the this value of a constructor before the super constructor is called.

    Creates a new DomainValue that represents the this value of a constructor before the super constructor is called. Hence, the value origin is necessarily always -1.

    OPAL calls this method when it creates the initial locals for constructors.

    Summary

    The properties of the domain value are:

    • Initialized: no (only the memory is allocated for the object)
    • Type: upper bound
    • Null: no (This value is not null.)
    Definition Classes
    ReferenceValuesFactory
    Note

    Instances of arrays are never uninitialized.

  25. abstract def aaload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  26. abstract def aastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  27. abstract def arraylength(pc: Int, arrayref: DomainValue): Computation[DomainValue, ExceptionValue]

    Returns the array's length or throws a NullPointerException.

  28. abstract def baload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  29. abstract def bastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  30. abstract def caload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  31. abstract def castore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  32. implicit abstract def classHierarchy: ClassHierarchy

    This project's class hierarchy.

    This project's class hierarchy.

    Usually, just a redirect to the Project's class hierarchy or the default class hierarchy.

    Definition Classes
    ValuesDomain
  33. abstract def daload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  34. abstract def dastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  35. abstract def faload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  36. abstract def fastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  37. abstract def iaload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  38. abstract def iastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  39. abstract def isValueASubtypeOf(value: DomainValue, supertype: ReferenceType): Answer

    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.

    Note

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

  40. abstract def laload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  41. abstract def lastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
  42. abstract def multianewarray(pc: Int, counts: Operands, arrayType: ArrayType): Computation[DomainValue, ExceptionValue]

    Creates a representation of a new multidimensional array.

    Creates a representation of a new multidimensional array. The return value is either a new array or a NegativeArraySizeException if count is negative.

  43. abstract def newarray(pc: Int, count: DomainValue, componentType: FieldType): Computation[DomainValue, ExceptionValue]

    The return value is either a new array or a NegativeArraySizeException if count is negative.

  44. abstract def refAreEqual(pc: Int, value1: DomainValue, value2: DomainValue): Answer

    Compares the given values for reference equality.

    Compares the given values for reference equality. Returns Yes if both values point to the same instance and returns No 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.

  45. abstract def refIsNull(pc: Int, value: DomainValue): Answer

    Determines whether the given value is null (Yes), maybe null (Unknown) or is not null (No).

    Determines whether the given value is null (Yes), maybe null (Unknown) or is not null (No).

    value

    A value of computational type reference.

  46. abstract def refSetUpperTypeBoundOfTopOperand(pc: Int, bound: ReferenceType, operands: Operands, locals: Locals): (Operands, Locals)

    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.

  47. abstract def refTopOperandIsNull(pc: Int, operands: Operands, locals: Locals): (Operands, Locals)

    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 or if a InstanceOf check has succeeded.

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

  48. abstract def saload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
  49. abstract def sastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def MethodExternalNullPointerException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  5. def MethodHandle(origin: ValueOrigin, handle: MethodHandle): DomainReferenceValue

    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
  6. def MethodType(origin: ValueOrigin, descriptor: MethodDescriptor): DomainReferenceValue

    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
  7. final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]

    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.

  8. final def VMArithmeticException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  9. final def VMArrayIndexOutOfBoundsException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  10. final def VMArrayStoreException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  11. final def VMClassCastException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  12. final def VMClassNotFoundException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  13. final def VMIllegalMonitorStateException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  14. final def VMNegativeArraySizeException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  15. final def VMNullPointerException(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  16. final def VMThrowable(pc: Int): ExceptionValue
    Definition Classes
    ExceptionsFactory
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  23. final def isASubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Tests if subtype is known to be subtype of supertype.

    Tests if subtype is known to be subtype of supertype. See org.opalj.br.ClassHierarchy's isSubtypeOf method for details.

    Definition Classes
    ValuesDomain
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Boolean

    Tests if subtype is known to be subtype of supertype.

    Tests if subtype is known to be subtype of supertype. See org.opalj.br.ClassHierarchy's isSubtypeOf method for details.

    Definition Classes
    ValuesDomain
  26. final def justThrows(value: ExceptionValue): ThrowsException[ExceptionValues]
    Definition Classes
    ReferenceValuesFactory
  27. def mergeDomainValues(pc: Int, v1: DomainValue, v2: DomainValue): DomainValue

    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
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. def properties(pc: PC, propertyToString: (AnyRef) => String = p => p.toString): Option[String]

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

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

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

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

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

    Definition Classes
    ValuesDomain
  32. def refAreNotEqual(pc: Int, value1: DomainValue, value2: DomainValue): Answer

    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.

  33. def refEstablishAreEqual(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

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

  34. def refEstablishAreNotEqual(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

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

  35. def refEstablishIsNonNull(pc: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Called by OPAL-AI when it establishes that the value is guaranteed not to be null.

    Called by OPAL-AI when it establishes that the value is guaranteed not to be null. E.g., after a comparison with null OPAL can establish that the value has to be null on one branch and that the value is not null on the other branch.

  36. def refEstablishIsNull(pc: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Called by the framework when the value is known to be null/has to be null.

    Called by the framework when the value is known to be null/has to be null. E.g., after a comparison with null (IFNULL/IFNONNULL) OPAL-AI knows that the value has to be null on one branch and that the value is not null on the other branch.

  37. def refIsNonNull(pc: Int, value: DomainValue): Answer

    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.

  38. def summarize(pc: Int, values: Iterable[DomainValue]): DomainValue

    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.

  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]
    Definition Classes
    ReferenceValuesFactory
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

Ungrouped