Class

org.opalj.ai.domain.l0

PrimitiveTACAIDomain

Related Doc: package l0

Permalink

class PrimitiveTACAIDomain extends TypeLevelDomain with ThrowAllPotentialExceptionsConfiguration with IgnoreSynchronization with DefaultTypeLevelHandlingOfMethodResults with TheClassHierarchy with TheMethod with RecordDefUse

This is the most primitive domain that can be used to transform the bytecode to the three address representation which is build upon the result of an abstract interpretation.

Source
PrimitiveTACAIDomain.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PrimitiveTACAIDomain
  2. RecordDefUse
  3. RecordCFG
  4. TheMethod
  5. TheCode
  6. TheClassHierarchy
  7. DefaultTypeLevelHandlingOfMethodResults
  8. DefaultTypeLevelHandlingForReturnInstructions
  9. DefaultTypeLevelHandlingOfVoidReturns
  10. DefaultTypeLevelHandlingForThrownExceptions
  11. ReturnInstructionsDomain
  12. MonitorInstructionsTracker
  13. CustomInitialization
  14. IgnoreSynchronization
  15. ThrowAllPotentialExceptionsConfiguration
  16. TypeLevelDomain
  17. TypeLevelInvokeInstructions
  18. MethodCallsHandling
  19. TypeLevelFieldAccessInstructions
  20. DefaultTypeLevelDoubleValues
  21. TypeLevelDoubleValues
  22. DefaultTypeLevelFloatValues
  23. TypeLevelFloatValues
  24. TypeLevelPrimitiveValuesConversions
  25. TypeLevelLongValuesShiftOperators
  26. DefaultTypeLevelLongValues
  27. TypeLevelLongValues
  28. DefaultTypeLevelIntegerValues
  29. TypeLevelIntegerValues
  30. DefaultReferenceValuesBinding
  31. DefaultExceptionsFactory
  32. DefaultTypeLevelReferenceValues
  33. TypeLevelReferenceValues
  34. AsJavaObject
  35. GeneralizedArrayHandling
  36. DefaultDomainValueBinding
  37. Domain
  38. Configuration
  39. TypedValuesFactory
  40. PrimitiveValuesConversionsDomain
  41. ReturnInstructionsDomain
  42. MonitorInstructionsDomain
  43. MethodCallsDomain
  44. FieldAccessesDomain
  45. ReferenceValuesDomain
  46. ReferenceValuesFactory
  47. ExceptionsFactory
  48. DoubleValuesDomain
  49. DoubleValuesFactory
  50. FloatValuesDomain
  51. FloatValuesFactory
  52. LongValuesDomain
  53. LongValuesFactory
  54. IntegerValuesDomain
  55. IntegerValuesFactory
  56. CoreDomainFunctionality
  57. SubroutinesDomain
  58. ValuesDomain
  59. AnyRef
  60. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PrimitiveTACAIDomain(project: Project[_], method: Method)

    Permalink
  2. new PrimitiveTACAIDomain(classHierarchy: ClassHierarchy, method: Method)

    Permalink

Type Members

  1. type AReferenceValue = ReferenceValue

    Permalink
  2. trait ArrayAbstraction extends AnyRef

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

    Permalink

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

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

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

    Permalink

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

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

    Definition Classes
    ReferenceValuesDomain
  5. class ArrayValue extends (DefaultTypeLevelReferenceValues.this)#ArrayValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ArrayType]

    Permalink

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

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

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

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

    Permalink

    Abstracts over values with computational type integer.

    Abstracts over values with computational type integer.

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

    Permalink
  11. final type DomainIllegalValue = IllegalValue

    Permalink

    Abstracts over the concrete type of IllegalValue.

    Abstracts over the concrete type of IllegalValue.

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

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  12. type DomainNullValue = NullValue

    Permalink
  13. type DomainObjectValue = ObjectValue

    Permalink
  14. type DomainReferenceValue = ReferenceValue

    Permalink
  15. 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
  16. final type DomainReturnAddressValues = ReturnAddressValues

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

    Permalink
  18. 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
  19. 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
  20. 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
  21. 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
  22. 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
  23. 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.

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

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  25. 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
  26. 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
  27. type LocalsArray = Array[Locals]

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

    Permalink

    Common supertrait of all DomainValues that represent long values.

    Common supertrait of all DomainValues that represent long values.

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

    Permalink
    Definition Classes
    LongValuesDomain
  30. class MObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue

    Permalink

    Attributes
    protected
    Definition Classes
    DefaultTypeLevelReferenceValues
  31. type MethodCallResult = Computation[DomainValue, ExceptionValues]

    Permalink
    Definition Classes
    MethodCallsDomain
  32. class NullValue extends (DefaultTypeLevelReferenceValues.this)#NullValue

    Permalink
    Attributes
    protected[this]
    Definition Classes
    DefaultTypeLevelReferenceValues
  33. trait ObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue

    Permalink
    Attributes
    protected
    Definition Classes
    DefaultTypeLevelReferenceValues
  34. 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
  35. type OperandsArray = Array[Operands]

    Permalink
    Definition Classes
    ValuesDomain
  36. trait RETValue extends Value

    Permalink
    Definition Classes
    ValuesDomain
  37. trait ReferenceValue extends (TypeLevelReferenceValues.this)#ReferenceValue with (TypeLevelReferenceValues.this)#ArrayAbstraction

    Permalink

    Abstracts over all values with computational type reference.

    Abstracts over all values with computational type reference. I.e., abstracts over class and array values and also the null value.

    Definition Classes
    TypeLevelReferenceValues
  38. 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.

  39. 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
  40. class SObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ObjectType]

    Permalink
    Attributes
    protected
    Definition Classes
    DefaultTypeLevelReferenceValues
  41. 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
  42. trait ShortValue extends (TypeLevelIntegerValues.this)#ComputationalTypeIntegerValue[ShortType] with IsShortValue[(TypeLevelIntegerValues.this)#ShortValue]

    Permalink
    Definition Classes
    TypeLevelIntegerValues
  43. trait TypedValue[+T <: Type] extends Value with KnownType

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

  45. type ValueOrigins = IntArraySet

    Permalink
    Definition Classes
    RecordDefUse

Value Members

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

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

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

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

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

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

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

    Permalink

    Represents an unknown double value.

    Represents an unknown double value.

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

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

    Permalink
    Definition Classes
    DefaultTypeLevelLongValues
  10. object AShortValue extends (DefaultTypeLevelIntegerValues.this)#ShortValue with Product with Serializable

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

    Permalink
  12. 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
  13. 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
  14. 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
  15. def ArrayValue(origin: ValueOrigin, 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
    DefaultReferenceValuesBindingTypeLevelReferenceValues
    Note

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

  16. object ArrayValue

    Permalink

    Enables matching of DomainValues that are array values.

    Enables matching of DomainValues that are array values.

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

    Permalink

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

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

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

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

    Permalink

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

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

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

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

    Permalink

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

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

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

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

    Permalink

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

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

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

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

    Permalink

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

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

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

    Permalink

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

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

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

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  23. 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
  24. final def ClassNotFoundException(origin: ValueOrigin): ExceptionValue

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

    Permalink

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

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

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

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

    Summary

    The properties of the domain value are:

    • Initialized: Yes and the type represented by the class is the given type.
    • Type: java.lang.Class<t:Type>
    • Null: No
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  26. 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
  27. 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
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. 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
  34. 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
  35. 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
    TypeLevelReferenceValuesReferenceValuesFactory
  36. 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
    TypeLevelReferenceValuesReferenceValuesFactory
  37. 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
  38. def IntegerValue(valueOrigin: ValueOrigin, value: Int): AnIntegerValue.type

    Permalink

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

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

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

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

    Permalink

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

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

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

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  40. object IsNull

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  41. object IsPrecise

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

    Permalink

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

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

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

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

    Permalink

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

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

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

    Definition Classes
    DefaultTypeLevelLongValuesLongValuesFactory
  44. object MObjectValue

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  48. 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
  49. 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
  50. 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
  51. 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
    TypeLevelReferenceValues
  52. 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
    TypeLevelReferenceValues
  53. def NewObject(pc: PC, 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
    TypeLevelReferenceValuesReferenceValuesFactory
    Note

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

  54. 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
    TypeLevelReferenceValuesReferenceValuesFactory
  55. 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
  56. 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

    This implementation always returns the singleton instance TheNullValue.

    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValuesReferenceValuesFactory
  57. def ObjectValue(origin: ValueOrigin, 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
    DefaultReferenceValuesBindingTypeLevelReferenceValues
  58. def ObjectValue(origin: ValueOrigin, 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
    DefaultReferenceValuesBindingTypeLevelReferenceValues
  59. 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
  60. 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
  61. object SObjectValue

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

    Permalink

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

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

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

    Permalink

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

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

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

    Definition Classes
    DefaultTypeLevelIntegerValuesIntegerValuesFactory
  64. def StringValue(pc: PC, 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
    TypeLevelReferenceValuesReferenceValuesFactory
  65. 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.

  66. final val TheIllegalValue: DomainIllegalValue

    Permalink

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  67. val TheNullValue: DomainNullValue

    Permalink
  68. final val TheReturnAddressValues: ReturnAddressValues

    Permalink

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  69. 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
  70. 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
  71. object UpperTypeBound

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

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

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

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

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

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

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

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

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

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

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

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

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

  85. def abstractInterpretationEnded(aiResult: AIResult { val domain: PrimitiveTACAIDomain.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
  86. 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
    CoreDomainFunctionality
  87. 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
    CoreDomainFunctionality
    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).

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

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

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

  92. def arraylength(pc: PC, arrayref: DomainValue): Computation[DomainValue, ExceptionValue]

    Permalink

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

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

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

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

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

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

  95. def asArrayAbstraction(value: DomainValue): ArrayAbstraction

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

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

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

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

    Permalink
  101. def bbCFG: CFG

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

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

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

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

  106. final def classFile: ClassFile

    Permalink
    Definition Classes
    TheMethod
    Annotations
    @inline()
  107. val classHierarchy: ClassHierarchy

    Permalink

    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
    PrimitiveTACAIDomainTheClassHierarchy
  108. def clone(): AnyRef

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

    Permalink

    Returns the code block that is currently analyzed.

    Returns the code block that is currently analyzed.

    Definition Classes
    TheMethodTheCode
  110. def controlDependencies: ControlDependencies

    Permalink
    Definition Classes
    RecordCFG
  111. 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
  112. def d2f(pc: PC, value: DomainValue): DomainValue

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  125. 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
  126. def drem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

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

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

    Permalink
  129. 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
  130. 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
  131. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  133. 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
  134. 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.

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

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

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

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

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

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

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

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

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

    Permalink
  144. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  145. 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.

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

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

    Permalink
  148. final def foreachPredecessorOf(pc: br.PC)(f: (br.PC) ⇒ Unit): Unit

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

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

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

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

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

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

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

    Permalink

    Returns the field's value.

    Returns the field's value.

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

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  162. 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
  163. 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
  164. 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
  165. final def hasMultipleSuccessors(pc: br.PC): Boolean

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

    Permalink
    Definition Classes
    RecordCFG
  167. 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
  168. def hashCode(): Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  183. 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
  184. def intAreEqual(pc: PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Tests if the two given integer values are equal.

    Tests if the two given integer values are equal.

    value1

    A value with computational type integer.

    value2

    A value with computational type integer.

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  185. 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
  186. def intEstablishAreEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

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

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

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

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

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

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

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

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

    Permalink

    Definition Classes
    IntegerValuesDomain
    Note

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

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

    Permalink

    Sets the given domain value to theValue.

    Sets the given domain value to theValue.

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

    value

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

    Definition Classes
    IntegerValuesDomain
  191. 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
  192. 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
  193. 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
  194. 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
  195. 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
  196. def intIsLessThan(pc: PC, left: DomainValue, right: DomainValue): Answer

    Permalink

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

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

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  197. 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
  198. def intIsLessThanOrEqualTo(pc: PC, left: DomainValue, right: DomainValue): Answer

    Permalink

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

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

    Definition Classes
    TypeLevelIntegerValuesIntegerValuesDomain
  199. 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
  200. 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
  201. def intIsSomeValueInRange(pc: PC, value: DomainValue, lowerBound: Int, upperBound: Int): Answer

    Permalink

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

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

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

    value

    A value that has to be of computational type integer.

    lowerBound

    The range's lower bound (inclusive).

    upperBound

    The range's upper bound (inclusive).

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

    Permalink

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

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

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

    value

    A value that has to be of computational type integer.

    lowerBound

    The range's lower bound (inclusive).

    upperBound

    The range's upper bound (inclusive).

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

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

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

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

    Permalink
  207. def invokevirtual(pc: PC, declaringClass: ReferenceType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  213. def isMonitorInstructionUsed: Boolean

    Permalink
    Definition Classes
    MonitorInstructionsTracker
  214. 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
  215. def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Permalink

    Definition Classes
    TheClassHierarchy
    See also

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

    Domain.isSubtypeOf

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

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

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

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

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

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

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

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

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

    Permalink

    pc

    The pc of the jsr(w) instruction.

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

    Permalink
    Definition Classes
    ReferenceValuesFactory
  227. 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
  228. def l2d(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to a double value.

    Conversion of the given long value to a double value.

    returns

    The result of calling DoubleValue(pc).

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

    Permalink

    Conversion of the given long value to a float value.

    Conversion of the given long value to a float value.

    returns

    The result of calling FloatValue(pc).

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

    Permalink

    Conversion of the given long value to an integer value.

    Conversion of the given long value to an integer value.

    returns

    The result of calling IntegerValue(pc).

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

    Permalink

    Add of two long values.

    Add of two long values.

    pc

    The pc of the add(+) instruction.

    value1

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

    value2

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

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

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

    Permalink

    Boolean and of two long values.

    Boolean and of two long values.

    pc

    The pc of the "&" instruction.

    value1

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

    value2

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

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

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

    Permalink

    Comparison (==) of two long values.

    Comparison (==) of two long values.

    pc

    The pc of the comparison instruction.

    returns

    The result of calling IntegerValue(pc).

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

    Permalink

    Division of two long values.

    Division of two long values.

    pc

    The pc of the div (/) instruction.

    returns

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

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

    Permalink

    Multiplication of two long values.

    Multiplication of two long values.

    pc

    The pc of the mul (/) instruction.

    value1

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

    value2

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

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

    Permalink

    Negation of a long value.

    Negation of a long value.

    pc

    The pc of the neg instruction.

    value

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

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  239. 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
  240. def lor(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Boolean or of two long values.

    Boolean or of two long values.

    pc

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

    value1

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

    value2

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

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

    Permalink

    Remainder of two long values.

    Remainder of two long values.

    pc

    The pc of the div (/) instruction.

    returns

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

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  242. 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.

  243. def lshl(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Shift left of a long value.

    Shift left of a long value.

    pc

    The pc of the "shift left" instruction.

    value1

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

    value2

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

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

    Permalink

    Shift right of a long value.

    Shift right of a long value.

    pc

    The pc of the "shift right" instruction.

    value1

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

    value2

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

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

    Permalink

    Subtraction of two long values.

    Subtraction of two long values.

    pc

    The pc of the sub(-) instruction.

    value1

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

    value2

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

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

    Permalink

    Unsigned shift right of a long value.

    Unsigned shift right of a long value.

    pc

    The pc of the "unsigned shift right" instruction.

    value1

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

    value2

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

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

    Permalink

    xor of two long values.

    xor of two long values.

    pc

    The pc of the "xor" instruction.

    value1

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

    value2

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

    Definition Classes
    TypeLevelLongValuesLongValuesDomain
  248. 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
  249. 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
  250. 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
  251. 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
  252. 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
  253. val method: Method

    Permalink

    Returns the method that is currently analyzed.

    Returns the method that is currently analyzed.

    Definition Classes
    PrimitiveTACAIDomainTheMethod
  254. 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.

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

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

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

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

  259. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  261. 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
  262. def postDominatorTree: DominatorTree

    Permalink
    Definition Classes
    RecordCFG
  263. def postDominatorTreeFactory: DominatorTreeFactory

    Permalink
    Definition Classes
    RecordCFG
  264. 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
  265. 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
  266. 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
  267. 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
  268. def refAreEqual(pc: PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Tests if both values refer to the same object instance.

    Tests if both values refer to the same object instance.

    Though this is in general intractable, there are some cases where a definitive answer is possible.

    This implementation completely handles the case where at least one value definitively represents the null value. Additionally, if we have precise type information and the types are different, No is returned. Otherwise, Unknown is returned.

    value1

    A value of type ReferenceValue.

    value2

    A value of type ReferenceValue.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    This method is intended to be overridden by subclasses and may be the first one that is called (by means of super) by the overriding method to handle checks related to null. E.g.

    super.areEqualReferences(value1,value2).ifUnknown {
        ...
    }
  269. 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
  270. 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
  271. 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
  272. def refEstablishIsNonNull(pc: PC, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    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.

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

    Permalink

    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.

    Definition Classes
    ReferenceValuesDomain
  274. 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
  275. 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
  276. def refSetUpperTypeBoundOfTopOperand(pc: PC, upperTypeBound: 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
    TypeLevelReferenceValuesReferenceValuesDomain
  277. 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
    TypeLevelReferenceValuesReferenceValuesDomain
  278. 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.

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

    Permalink

    pc

    The pc of the ret instruction.

    Definition Classes
    SubroutinesDomain
  280. 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.

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    IgnoreSynchronization
  285. final def successorsOf(pc: br.PC, regularSuccessorOnly: Boolean): PCs

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

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

    Permalink
    Definition Classes
    AnyRef
  288. 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
  289. 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
  290. 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
  291. 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
  292. 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
  293. 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
  294. 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
  295. 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
  296. 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
  297. 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
  298. 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
  299. 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
  300. 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
  301. final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  302. 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
  303. 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
    TypeLevelReferenceValuesAsJavaObject
    Note

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

  304. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  305. 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
  306. 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
  307. 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
  308. 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
  309. var usesMonitorInstruction: Boolean

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

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

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

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

    Permalink
    Definition Classes
    RecordCFG

Inherited from RecordDefUse

Inherited from RecordCFG

Inherited from TheMethod

Inherited from TheCode

Inherited from TheClassHierarchy

Inherited from ReturnInstructionsDomain

Inherited from CustomInitialization

Inherited from IgnoreSynchronization

Inherited from TypeLevelDomain

Inherited from MethodCallsHandling

Inherited from TypeLevelDoubleValues

Inherited from TypeLevelFloatValues

Inherited from TypeLevelLongValues

Inherited from TypeLevelIntegerValues

Inherited from DefaultExceptionsFactory

Inherited from TypeLevelReferenceValues

Inherited from AsJavaObject

Inherited from GeneralizedArrayHandling

Inherited from DefaultDomainValueBinding

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