ValuesCoordinatingDomain

trait ValuesCoordinatingDomain extends CorrelationalDomain with Configuration

Can be mixed in to create a Domain that is intended to be used to coordinate the exchange of values between different domains.

This domain does not prescribe the semantics of any values, but instead implements methods that perform computations.

This domain directly inherits from Domain and can, thus, directly be used to create a final domain.

Core Properties

Concrete base implementation of the following domains:
Thread safe.
Reusable.

Source: ValuesCoordinatingDomain.scala

Known Subclasses

CoordinatingValuesDomain

Ordering

Alphabetic
By Inheritance

Inherited

ValuesCoordinatingDomain
CorrelationalDomain
CorrelationalDomainSupport
IdentityBasedCorrelationChangeDetection
JoinStabilization
Domain
Configuration
TypedValuesFactory
PrimitiveValuesConversionsDomain
DynamicLoadsDomain
ReturnInstructionsDomain
MonitorInstructionsDomain
MethodCallsDomain
FieldAccessesDomain
ReferenceValuesDomain
ReferenceValuesFactory
ExceptionsFactory
DoubleValuesDomain
DoubleValuesFactory
FloatValuesDomain
FloatValuesFactory
LongValuesDomain
LongValuesFactory
IntegerValuesDomain
IntegerValuesFactory
CoreDomainFunctionality
SubroutinesDomain
ValuesDomain
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

class IllegalValue extends Value with IsIllegalValue
Represents a value that has no well defined state/type.
Represents a value that has no well defined state/type. Such values are either the result of a join of two incompatible values or if the variable was identified as being dead. IllegalValue's are only found in registers (in the locals).
Attributes
protected
Definition Classes
ValuesDomain
See also
org.opalj.ai.Domain.Value for further details.
trait RETValue extends Value with IsReturnAddressValue
Definition Classes
ValuesDomain
trait ReferenceValue extends TypedValue[ReferenceType] with IsReferenceValue
Definition Classes
ValuesDomain
class ReturnAddressValue extends RETValue
Stores a single return address (i.e., a program counter/index into the code array).
Stores a single return address (i.e., a program counter/index into the code array).
Definition Classes
ValuesDomain
Note
Though the framework completely handles all aspects related to return address values, it is nevertheless necessary that this class inherits from Value as return addresses are stored on the stack/in the registers. However, if the Value trait should be refined, all additional methods may – from the point-of-view of OPAL-AI – just throw an UnsupportedOperationException as these additional methods will never be called by the OPAL-AI.
class ReturnAddressValues extends RETValue
A collection of (not further stored) return address values.
A collection of (not further stored) return address values. Primarily used when we join the executions of subroutines.
Definition Classes
ValuesDomain
trait TypedValue[+T <: Type] extends Value with KnownTypedValue
Definition Classes
ValuesDomain
trait Value extends ValueInformation
Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.
Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.
Use Of Value/Dependencies On Value
In general, subclasses and users of a Domain should not have/declare a direct dependency on Value. Instead they should use DomainValue as otherwise extensibility of a Domain may be hampered or even be impossible. The only exceptions are, of course, classes that directly inherit from this class.
Refining Value
If you directly extend/refine this trait (i.e., in a subclass of the Domain trait you write something like trait Value extends super.Value), make sure that you also extend all classes/traits that inherit from this type (this may require a deep mixin composition and that you refine the type DomainType accordingly). However, OPAL was designed such that extending this class should – in general – not be necessary. It may also be easier to encode the desired semantics – as far as possible – as part of the domain.
Implementing Value
Standard inheritance from this trait is always supported and is the primary mechanism to model an abstract domain's lattice w.r.t. some special type of value. In general, the implementation should try to avoid creating new instances of values unless strictly required to model the domain's semantics. This will greatly improve the overall performance as this framework heavily uses reference-based equality checks to speed up the evaluation.
Definition Classes
ValuesDomain
Note
OPAL does not rely on any special equality semantics w.r.t. values and never directly or indirectly calls a Value's equals method. Hence, a domain can encode equality such that it best fits its need. However, some of the provided domains rely on the following semantics for equals: Two domain values have to be equal (==) iff they represent the same information. This includes additional information, such as, the value of the origin. E.g., a value (AnIntegerValue) that represents an arbitrary Integer value has to return true if the domain value with which it is compared also represents an arbitrary Integer value (AnIntegerValue). However, it may still be necessary to use multiple objects to represent an arbitrary integer value if, e.g., constraints should be attached to specific values. For example, after a comparison of an integer value with a predefined value (e.g., AnIntegerValue < 4) it is possible to constrain the respective value on the subsequent paths (< 4 on one path and >= 4 on the other path). To make that possible, it is however necessary to distinguish the AnIntegervalue from some other AnIntegerValue to avoid constraining unrelated values.
public void foo(int a,int b) { if(a < 4) { z = a - 2 // here a is constrained (< 4), b and z are unconstrained } else { z = a + 2 // here a is constrained (>= 4), b and z are unconstrained } }
In general, equals is only defined for values belonging to the same domain. If values need to be compared across domains, they need to be adapted to a target domain first.
type ArrayLoadResult = Computation[DomainValue, ExceptionValues]
Computation that returns the value stored in an array at a given index or an exception.
Computation that returns the value stored in an array at a given index or an exception. The exceptions that may be thrown are: NullPointerException and ArrayIndexOutOfBoundsException.
Definition Classes
ReferenceValuesDomain
type ArrayStoreResult = Computation[Nothing, ExceptionValues]
Computation that succeeds (updates the value stored in the array at the given index) or that throws an exception.
Computation that succeeds (updates the value stored in the array at the given index) or that throws an exception. The exceptions that may be thrown are: NullPointerException, ArrayIndexOutOfBoundsException and ArrayStoreException.
Definition Classes
ReferenceValuesDomain
abstract type DomainIllegalValue <: IllegalValue with DomainValue
Abstracts over the concrete type of IllegalValue.
Abstracts over the concrete type of IllegalValue.
This type needs to be refined whenever the class IllegalValue is refined or the type DomainValue is refined.
Definition Classes
ValuesDomain
abstract type DomainReferenceValue >: Null <: ReferenceValue with DomainTypedValue[ReferenceType]
Definition Classes
ValuesDomain
abstract type DomainReturnAddressValue <: ReturnAddressValue with DomainValue
Abstracts over the concrete type of ReturnAddressValue.
Abstracts over the concrete type of ReturnAddressValue. Needs to be fixed by some sub-trait/sub-class. In the simplest case (i.e., when neither the Value trait nor the ReturnAddressValue trait was refined) it is sufficient to write:
```
type DomainReturnAddressValue = ReturnAddressValue
```
Definition Classes
ValuesDomain
abstract type DomainReturnAddressValues <: ReturnAddressValues with DomainValue
Definition Classes
ValuesDomain
abstract type DomainTypedValue[+T <: Type] >: Null <: DomainValue
Definition Classes
ValuesDomain
abstract type DomainValue >: Null <: Value
Abstracts over the concrete type of Value.
Abstracts over the concrete type of Value. Needs to be refined by traits that inherit from Domain and which extend Domain's Value trait.
Definition Classes
ValuesDomain
type ExceptionValue = DomainReferenceValue
A simple type alias of the type DomainValue; used to facilitate comprehension.
A simple type alias of the type DomainValue; used to facilitate comprehension.
Definition Classes
ValuesDomain
type ExceptionValues = Iterable[ExceptionValue]
A type alias for Iterables of ExceptionValues; used to facilitate comprehension.
A type alias for Iterables of ExceptionValues; used to facilitate comprehension.
Definition Classes
ValuesDomain
type IntegerValueOrArithmeticException = Computation[DomainValue, ExceptionValue]
Computation that returns a numeric value or an ObjectType.ArithmeticException.
Computation that returns a numeric value or an ObjectType.ArithmeticException.
Definition Classes
IntegerValuesDomain
type Locals = collection.mutable.Locals[DomainValue]
An instruction's current register values/locals are represented using an array.
An instruction's current register values/locals are represented using an array.
Definition Classes
ValuesDomain
type LocalsArray = Array[Locals]
Definition Classes
ValuesDomain
type LongValueOrArithmeticException = Computation[DomainValue, ExceptionValue]
Definition Classes
LongValuesDomain
type MethodCallResult = Computation[DomainValue, ExceptionValues]
Definition Classes
MethodCallsDomain
type Operands = List[DomainValue]
An instruction's operands are represented using a list where the first element of the list represents the top level operand stack value.
An instruction's operands are represented using a list where the first element of the list represents the top level operand stack value.
Definition Classes
ValuesDomain
type OperandsArray = Array[Operands]
Definition Classes
ValuesDomain

Abstract Value Members

abstract def ArithmeticException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a ArithmeticException and that has the given origin.
Creates a non-null object that represent a ArithmeticException and that has the given origin. If the ArithmeticException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def ArrayIndexOutOfBoundsException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a ArrayIndexOutOfBoundsException and that has the given origin.
Creates a non-null object that represent a ArrayIndexOutOfBoundsException and that has the given origin. If the ArrayIndexOutOfBoundsException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def ArrayStoreException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a ArrayStoreException and that has the given origin.
Creates a non-null object that represent a ArrayStoreException and that has the given origin. If the ArrayStoreException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def BooleanValue(origin: ValueOrigin, value: Boolean): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def BooleanValue(origin: ValueOrigin): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def ByteValue(origin: ValueOrigin, value: Byte): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def ByteValue(origin: ValueOrigin): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def CharValue(origin: ValueOrigin, value: Char): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def CharValue(origin: ValueOrigin): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def ClassCastException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a ClassCastException and that has the given origin.
Creates a non-null object that represent a ClassCastException and that has the given origin. If the ClassCastException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def ClassNotFoundException(origin: ValueOrigin): ExceptionValue
Definition Classes
ExceptionsFactory
abstract def ClassValue(origin: ValueOrigin, t: Type): DomainReferenceValue
Factory method to create a DomainValue that represents a runtime value of type "Class<T>" and that was created by the instruction with the specified program counter.
Factory method to create a DomainValue that represents a runtime value of type "Class<T>" and that was created by the instruction with the specified program counter.
This function is called by OPAL when a class constant (LDC(_W) instruction) is put on the stack.
The domain may ignore the information about the value and the origin (vo).
Summary
The properties of the domain value are:
- Initialized: Yes and the type represented by the class is the given type.
- Type: java.lang.Class<t:Type>
- Null: No
Definition Classes
ReferenceValuesFactory
abstract val DomainReferenceValueTag: ClassTag[DomainReferenceValue]
The class tag can be used to create type safe arrays or to extract the concrete type of the domain value.
The class tag can be used to create type safe arrays or to extract the concrete type of the domain value.
```
val DomainReferenceValue(v) = value // of type "DomainValue"
// v is now of the type DomainReferenceValue
```
Definition Classes
ValuesDomain
implicit abstract val DomainValueTag: ClassTag[DomainValue]
The class tag for the type DomainValue.
The class tag for the type DomainValue.
Required to generate instances of arrays in which values of type DomainValue can be stored in a type-safe manner.
Initialization
In the sub-trait or class that fixes the type of DomainValue it is necessary to implement this abstract val using:
```
val DomainValueTag : ClassTag[DomainValue] = implicitly
```
(As of Scala 2.10 it is necessary that you do not use implicit in the subclass - it will compile, but fail at runtime.)
Definition Classes
ValuesDomain
abstract def DoubleValue(origin: ValueOrigin, value: Double): DomainTypedValue[DoubleType]
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
DoubleValuesFactory
abstract def DoubleValue(origin: ValueOrigin): DomainTypedValue[DoubleType]
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
DoubleValuesFactory
abstract def FloatValue(valueOrigin: Int, value: Float): DomainTypedValue[FloatType]
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
FloatValuesFactory
abstract def FloatValue(valueOrigin: Int): DomainTypedValue[FloatType]
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
FloatValuesFactory
abstract def IllegalMonitorStateException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent an IllegalMonitorStateException and that has the given origin.
Creates a non-null object that represent an IllegalMonitorStateException and that has the given origin. If the IllegalMonitorStateException was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def InitializedObjectValue(origin: ValueOrigin, objectType: ObjectType): DomainReferenceValue
Factory method to create a DomainValue that represents an initialized reference value of the given type and that was created (explicitly or implicitly) by the instruction with the specified program counter.
Factory method to create a DomainValue that represents an initialized reference value of the given type and that was created (explicitly or implicitly) by the instruction with the specified program counter.
General Remarks
The given type usually identifies a class type (not an interface type) that is not abstract, but in some cases (e.g. consider java.awt.Toolkit()) it may be useful/meaningful to relax this requirement and to state that the class precisely represents the runtime type – even so the class is abstract. However, such decisions need to be made by the domain.
This method is used by the OPAL framework to create reference values that are normally internally created by the JVM (in particular exceptions such as NullPointerException and ClassCastException). However, it can generally be used to create initialized objects/arrays.
Summary
The properties of the domain value are:
- Initialized: Yes
- Type: precise (i.e., this type is not an upper bound, the type correctly models the runtime type.)
- Null: No (This value is not null.)
Definition Classes
ReferenceValuesFactory
abstract def IntegerValue(origin: ValueOrigin, value: Int): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def IntegerValue(origin: ValueOrigin): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def LongValue(origin: ValueOrigin, value: Long): DomainTypedValue[LongType]
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
LongValuesFactory
abstract def LongValue(origin: ValueOrigin): DomainTypedValue[LongType]
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
LongValuesFactory
abstract def MetaInformationUpdateIllegalValue: MetaInformationUpdate[DomainIllegalValue]
The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].
The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].
Definition Classes
ValuesDomain
abstract def NegativeArraySizeException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a NegativeArraySizeException and that has the given origin.
Creates a non-null object that represent a NegativeArraySizeException and that has the given origin. If the NegativeArraySizeException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def NewObject(origin: ValueOrigin, objectType: ObjectType): DomainReferenceValue
Creates a new DomainValue that represents a new, uninitialized instance of an object of the given type.
Creates a new DomainValue that represents a new, uninitialized instance of an object of the given type. The object was created by the (NEW) instruction with the specified program counter.
OPAL calls this method when it evaluates newobject instructions. If the bytecode is valid a call of one of the (super) object's constructors will subsequently initialize the object.
Summary
The properties of the domain value are:
- Initialized: no (only the memory is allocated for the object)
- Type: precise (i.e., this type is not an upper bound, the type correctly models the runtime type.)
- Null: no (This value is not null.)
Definition Classes
ReferenceValuesFactory
Note
Instances of arrays are created by the newarray and multianewarray instructions and in both cases an exception may be thrown (e.g., NegativeArraySizeException).
abstract def NonNullObjectValue(origin: ValueOrigin, objectType: ObjectType): DomainReferenceValue
Represents a non-null reference value with the given type as an upper type bound.
Represents a non-null reference value with the given type as an upper type bound.
The domain may ignore the information about the value and the origin (vo).
Summary
The properties of the domain value are:
- Initialized: Yes (the constructor was called)
- Type: Upper Bound
- Null: No (This value is not null.)
Definition Classes
ReferenceValuesFactory
abstract def NullPointerException(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a NullPointerException and that has the given origin.
Creates a non-null object that represent a NullPointerException and that has the given origin. If the NullPointerException was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def NullValue(origin: ValueOrigin): DomainReferenceValue
Factory method to create a DomainValue that represents value null and and that was created (explicitly or implicitly) by the instruction with the specified program counter.
Factory method to create a DomainValue that represents value null and and that was created (explicitly or implicitly) by the instruction with the specified program counter.
The domain may ignore the information about the value and the origin (pc).
Summary
The properties of the domain value are:
- Initialized: N/A
- Type: Null
- Null: Yes
Definition Classes
ReferenceValuesFactory
abstract def ReferenceValue(origin: ValueOrigin, referenceType: ReferenceType): DomainReferenceValue
Factory method to create a DomainValue that represents either a reference value that has the given type and is initialized or the value null.
Factory method to create a DomainValue that represents either a reference value that has the given type and is initialized or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound.
The domain may ignore the information about the value and the origin, but it has to remain possible for the domain to identify the component type of an array.
Summary
The properties of the domain value are:
- Initialized: Yes (if non-null the constructor was called/the array was initialized)
- Type: Upper Bound
- Null: Unknown
- Content: Unknown
Definition Classes
ReferenceValuesFactory
abstract def ReturnAddressValue(address: Int): DomainReturnAddressValue
Factory method to create an instance of a ReturnAddressValue.
Factory method to create an instance of a ReturnAddressValue.
Definition Classes
ValuesDomain
abstract def ShortValue(origin: ValueOrigin, value: Short): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def ShortValue(origin: ValueOrigin): DomainTypedValue[CTIntType]
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
IntegerValuesFactory
abstract def StringValue(origin: ValueOrigin, value: String): DomainReferenceValue
Factory method to create a DomainValue that represents the given string value and that was created by the instruction with the specified program counter.
Factory method to create a DomainValue that represents the given string value and that was created by the instruction with the specified program counter.
This function is called by OPAL-AI when a string constant (LDC(_W) instruction) is put on the stack.
The domain may ignore the information about the value and the origin (vo).
Summary
The properties of the domain value are:
- Initialized: Yes and the String's value is the given value. The string may be empty (""), but it is never null.
- Type: java.lang.String
- Null: No
value
A non-null string. (The string may be empty, though.)
Definition Classes
ReferenceValuesFactory
abstract val TheIllegalValue: DomainIllegalValue
The singleton instance of the IllegalValue.
The singleton instance of the IllegalValue.
Definition Classes
ValuesDomain
abstract val TheReturnAddressValues: DomainReturnAddressValues
The singleton instance of ReturnAddressValues
The singleton instance of ReturnAddressValues
Definition Classes
ValuesDomain
abstract def Throwable(origin: ValueOrigin): ExceptionValue
Creates a non-null object that represent a Throwable object and that has the given origin.
Creates a non-null object that represent a Throwable object and that has the given origin. If the Throwable was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForImmediateVMException to translate that pc to the appropriate ValueOrigin.
Definition Classes
ExceptionsFactory
abstract def UninitializedThis(objectType: ObjectType): DomainReferenceValue
Creates a new DomainValue that represents the this value of a constructor before the super constructor is called.
Creates a new DomainValue that represents the this value of a constructor before the super constructor is called. Hence, the value origin is necessarily always -1.
OPAL calls this method when it creates the initial locals for constructors.
Summary
The properties of the domain value are:
- Initialized: no (only the memory is allocated for the object)
- Type: upper bound
- Null: no (This value is not null.)
Definition Classes
ReferenceValuesFactory
Note
Instances of arrays are never uninitialized.
abstract def aaload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def aastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
abstract def arraylength(pc: Int, arrayref: DomainValue): Computation[DomainValue, ExceptionValue]
Returns the array's length or throws a NullPointerException.
Returns the array's length or throws a NullPointerException.
Definition Classes
ReferenceValuesDomain
abstract def baload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def bastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
abstract def caload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def castore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
implicit abstract def classHierarchy: ClassHierarchy
This project's class hierarchy.
This project's class hierarchy.
Usually, just a redirect to the Project's class hierarchy or the default class hierarchy.
Definition Classes
ValuesDomain
abstract def dadd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def daload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def dastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
abstract def dcmpg(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def dcmpl(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def ddiv(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def dmul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def dneg(pc: Int, value: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def drem(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def dsub(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
DoubleValuesDomain
abstract def fadd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def faload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def fastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
abstract def fcmpg(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def fcmpl(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def fdiv(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def fmul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def fneg(pc: Int, value: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def frem(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def fsub(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
FloatValuesDomain
abstract def i2b(pc: Int, value: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def i2c(pc: Int, value: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def i2s(pc: Int, value: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def iadd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def iaload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def iand(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def iastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
abstract def idiv(pc: Int, value1: DomainValue, value2: DomainValue): IntegerValueOrArithmeticException
Definition Classes
IntegerValuesDomain
abstract def iinc(pc: Int, value: DomainValue, increment: Int): DomainValue
Definition Classes
IntegerValuesDomain
abstract def imul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def ineg(pc: Int, value: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def intAreEqual(pc: Int, value1: DomainValue, value2: DomainValue): Answer
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
IntegerValuesDomain
abstract def intIsLessThan(pc: Int, smallerValue: DomainValue, largerValue: DomainValue): Answer
Tests if the first integer value is smaller than the second value.
Tests if the first integer value is smaller than the second value.
smallerValue
A value with computational type integer.
largerValue
A value with computational type integer.
Definition Classes
IntegerValuesDomain
abstract def intIsLessThanOrEqualTo(pc: Int, smallerOrEqualValue: DomainValue, equalOrLargerValue: DomainValue): Answer
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.
smallerOrEqualValue
A value with computational type integer.
equalOrLargerValue
A value with computational type integer.
Definition Classes
IntegerValuesDomain
abstract def intIsSomeValueInRange(pc: Int, value: DomainValue, lowerBound: Int, upperBound: Int): Answer
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
IntegerValuesDomain
abstract def intIsSomeValueNotInRange(pc: Int, value: DomainValue, lowerBound: Int, upperBound: Int): Answer
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
IntegerValuesDomain
abstract def ior(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def irem(pc: Int, value1: DomainValue, value2: DomainValue): IntegerValueOrArithmeticException
Definition Classes
IntegerValuesDomain
abstract def isValueASubtypeOf(value: DomainValue, supertype: ReferenceType): Answer
Tries to determine – under the assumption that the given value is not null – if the runtime type of the given reference value could be a subtype of the specified reference type supertype.
Tries to determine – under the assumption that the given value is not null – if the runtime type of the given reference value could be a subtype of the specified reference type supertype. I.e., if the type of the value is not precisely known, then all subtypes of the value's type are also taken into consideration when analyzing the subtype relation and only if we can guarantee that none is a subtype of the given supertype the answer will be No.
Definition Classes
ReferenceValuesDomain
Note
The returned value is only meaningful if value does not represent the runtime value null.
abstract def ishl(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def ishr(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def isub(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def iushr(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def ixor(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Definition Classes
IntegerValuesDomain
abstract def ladd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Add of two long values.
Add of two long values.
pc
The pc of the add(+) instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
Definition Classes
LongValuesDomain
abstract def laload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def land(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Boolean and of two long values.
Boolean and of two long values.
pc
The pc of the "&" instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
Definition Classes
LongValuesDomain
abstract def lastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain
abstract def lcmp(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Comparison (==) of two long values.
Comparison (==) of two long values.
pc
The pc of the comparison instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
returns
A domain value that encapsulates an integer value with the value -1,0 or 1.
Definition Classes
LongValuesDomain
abstract def ldiv(pc: Int, value1: DomainValue, value2: DomainValue): LongValueOrArithmeticException
Division of two long values.
Division of two long values.
pc
The pc of the div (/) instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
returns
The return value is the calculated value and/or (depending on the domain) an ArithmeticException if value2 is 0.
Definition Classes
LongValuesDomain
abstract def lmul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Multiplication of two long values.
Multiplication of two long values.
pc
The pc of the mul (/) instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
Definition Classes
LongValuesDomain
abstract def lneg(pc: Int, value: DomainValue): DomainValue
Negation of a long value.
Negation of a long value.
pc
The pc of the neg instruction.
value
A long value (guaranteed by the JVM's semantics).
Definition Classes
LongValuesDomain
abstract def loadDynamic(pc: Int, bootstrapMethod: BootstrapMethod, name: String, descriptor: FieldType): Computation[DomainValue, Nothing]
Returns the dynamic constant's value.
Returns the dynamic constant's value.
Definition Classes
DynamicLoadsDomain
abstract def lor(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
Boolean or of two long values.
Boolean or of two long values.
pc
The pc of the "boolean or" (|) instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
Definition Classes
LongValuesDomain
abstract def lrem(pc: Int, value1: DomainValue, value2: DomainValue): LongValueOrArithmeticException
Remainder of two long values.
Remainder of two long values.
pc
The pc of the div (/) instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
returns
The return value is the calculated value and/or (depending on the domain) an ArithmeticException if value2 is 0.
Definition Classes
LongValuesDomain
abstract def lsub(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
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.)
Definition Classes
LongValuesDomain
abstract def lxor(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
xor of two long values.
xor of two long values.
pc
The pc of the "xor" instruction.
value1
A long value (guaranteed by the JVM's semantics).
value2
A long value (guaranteed by the JVM's semantics).
Definition Classes
LongValuesDomain
abstract def multianewarray(pc: Int, counts: Operands, arrayType: ArrayType): Computation[DomainValue, ExceptionValue]
Creates a representation of a new multidimensional array.
Creates a representation of a new multidimensional array. The return value is either a new array or a NegativeArraySizeException if count is negative.
Definition Classes
ReferenceValuesDomain
abstract def newarray(pc: Int, count: DomainValue, componentType: FieldType): Computation[DomainValue, ExceptionValue]
The return value is either a new array or a NegativeArraySizeException if count is negative.
The return value is either a new array or a NegativeArraySizeException if count is negative.
Definition Classes
ReferenceValuesDomain
abstract def refAreEqual(pc: Int, value1: DomainValue, value2: DomainValue): Answer
Compares the given values for reference equality.
Compares the given values for reference equality. Returns Yes if both values point to the same instance and returns No if both objects are known not to point to the same instance. The latter is, e.g., trivially the case when both values have a different concrete type. Otherwise Unknown is returned.
If both values are representing the null value the org.opalj.Answer is Yes.
value1
A value of computational type reference.
value2
A value of computational type reference.
Definition Classes
ReferenceValuesDomain
abstract def refIsNull(pc: Int, value: DomainValue): Answer
Determines whether the given value is null (Yes), maybe null (Unknown) or is not null (No).
Determines whether the given value is null (Yes), maybe null (Unknown) or is not null (No).
value
A value of computational type reference.
Definition Classes
ReferenceValuesDomain
abstract def refSetUpperTypeBoundOfTopOperand(pc: Int, bound: ReferenceType, operands: Operands, locals: Locals): (Operands, Locals)
Called by the abstract interpreter when the type bound of the top most stack value needs to be refined.
Called by the abstract interpreter when the type bound of the top most stack value needs to be refined. This method is only called by the abstract interpreter iff an immediately preceding subtype query (typeOf(value) <: bound) returned Unknown. This method must not be ignored – w.r.t. refining the top-most stack value; it is e.g., used by org.opalj.br.instructions.CHECKCAST instructions.
A domain that is able to identify aliases can use this information to propagate the information to the other aliases.
Definition Classes
ReferenceValuesDomain
abstract def refTopOperandIsNull(pc: Int, operands: Operands, locals: Locals): (Operands, Locals)
Sets the is null property of the top-most stack value to Yes.
Sets the is null property of the top-most stack value to Yes. This method is called by the framework when the top-most operand stack value has to be null, but a previous isNull check returned Unknown. E.g., after a org.opalj.br.instructions.CHECKCAST that fails or if a InstanceOf check has succeeded.
This method can be ignored; i.e., the return value can be (operands,locals). However, a domain that tracks alias information can use this information to propagate the information to the other aliases.
Definition Classes
ReferenceValuesDomain
abstract def saload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
Definition Classes
ReferenceValuesDomain
abstract def sastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
Definition Classes
ReferenceValuesDomain

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ConstantFieldValue(pc: Int, cv: ConstantFieldValue[_]): DomainValue
Creates the domain value that represents the constant field value.
Creates the domain value that represents the constant field value.
Definition Classes
Domain
final def DefaultValue(origin: ValueOrigin, theType: FieldType): DomainValue
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
def InitializedDomainValue(origin: ValueOrigin, vi: ValueInformation): DomainValue
Creates a domain value from the given value information that represents a properly domain value.
Creates a domain value from the given value information that represents a properly domain value. A representation of a proper value is created even if the value information is provided for an uninitialized value.
Definition Classes
Domain → ValuesDomain
Note
This function is only defined for proper values, i.e., it is not defined for void values or illegal values.
,
This method is intended to be overwritten by concrete domains which can represent more information.
final def IntegerConstant0: DomainTypedValue[CTIntType]
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
final def MethodExternalNullPointerException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
def MethodHandle(origin: ValueOrigin, handle: MethodHandle): DomainReferenceValue
Called by the AI framework for each load constant method handle (org.opalj.br.instructions.LoadMethodHandle) instruction to get a representation of/a DomainValue that represents the handle.
Called by the AI framework for each load constant method handle (org.opalj.br.instructions.LoadMethodHandle) instruction to get a representation of/a DomainValue that represents the handle.
handle
A valid method handle.
returns
An InitializedObjectValue(ObjectType.MethodHandle). Hence, this method needs to be overridden if resolution of MethodHandle based method calls should be performed.
Definition Classes
ReferenceValuesFactory
def MethodType(origin: ValueOrigin, descriptor: MethodDescriptor): DomainReferenceValue
Called by the framework for each load constant method type (org.opalj.br.instructions.LoadMethodType) instruction to get a domain-specific representation of the method descriptor as a MethodType.
Called by the framework for each load constant method type (org.opalj.br.instructions.LoadMethodType) instruction to get a domain-specific representation of the method descriptor as a MethodType.
descriptor
A valid method descriptor.
returns
An InitializedObjectValue(ObjectType.MethodType). Hence, this method needs to be overridden if resolution of MethodType based method calls should be performed.
Definition Classes
ReferenceValuesFactory
final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]
The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue.
The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue. The JVM semantics guarantee that the value will not be used and, hence, continuing the interpretation is meaningless.
Definition Classes
ValuesDomain
Note
This method is solely defined for documentation purposes and to catch implementation errors early on.
def TypedValue(origin: ValueOrigin, valueType: Type): DomainValue
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
final def VMArithmeticException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMArrayIndexOutOfBoundsException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMArrayStoreException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMClassCastException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMClassNotFoundException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMIllegalMonitorStateException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMNegativeArraySizeException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMNullPointerException(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
final def VMThrowable(pc: Int): ExceptionValue
Definition Classes
ExceptionsFactory
def abortProcessingExceptionsOfCalledMethodsOnUnknownException: Boolean
If true the processing of the exception handlers related to an invoke statement will be aborted if the relation between the type of the thrown exception and the caught type is unknown.
If true the processing of the exception handlers related to an invoke statement will be aborted if the relation between the type of the thrown exception and the caught type is unknown.
Definition Classes
ValuesCoordinatingDomain → Configuration
Note
Directly used by the AI itself.
def abortProcessingThrownExceptionsOnUnknownException: Boolean
If true the processing of the exception handlers related to an athrow statement will be aborted if the relation between the type of the thrown exception and the caught type is unknown.
If true the processing of the exception handlers related to an athrow statement will be aborted if the relation between the type of the thrown exception and the caught type is unknown.
Definition Classes
ValuesCoordinatingDomain → Configuration
Note
Directly used by the AI itself.
def abruptMethodExecution(pc: Int, exception: ExceptionValue): Unit
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
Note
If the original exception value is null (/*E.g.*/throw null;), then the exception that is actually thrown is a new NullPointerException. This situation is, however, completely handled by OPAL and the exception value is hence never null.
def abstractInterpretationEnded(aiResult: AIResult { val domain: ValuesCoordinatingDomain.this.type }): Unit
Called by the abstract interpreter when the abstract interpretation of a method has ended.
Called by the abstract interpreter when the abstract interpretation of a method has ended. The abstract interpretation of a method ends if either the fixpoint is reached or the interpretation was aborted.
By default this method does nothing.
Domains that override this method are expected to also call super.abstractInterpretationEnded(aiResult).
Definition Classes
CoreDomainFunctionality
def afterBaseJoin(pc: Int): Unit
Classes overriding this method generally have to call it!
Classes overriding this method generally have to call it!
Attributes
protected[this]
Definition Classes
JoinStabilization → CoreDomainFunctionality
def afterEvaluation(pc: Int, instruction: Instruction, oldOperands: Operands, oldLocals: Locals, targetPC: Int, isExceptionalControlFlow: Boolean, forceJoin: Boolean, newOperands: Operands, newLocals: Locals): (Operands, Locals)
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).
def areturn(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
final def asInstanceOf[T0]: T0
Definition Classes
Any
def beforeBaseJoin(pc: Int): Unit
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.
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
def d2f(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def d2i(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def d2l(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def dreturn(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def evaluationCompleted(pc: Int, worklist: List[Int], evaluatedPCs: IntArrayStack, operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): Unit
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
def f2d(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def f2i(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def f2l(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def flow(currentPC: Int, currentOperands: Operands, currentLocals: Locals, successorPC: Int, isSuccessorScheduled: Answer, isExceptionalControlFlow: Boolean, abruptSubroutineTerminationCount: Int, wasJoinPerformed: Boolean, worklist: List[Int], operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): List[Int]
Called by the framework after performing a computation to inform the domain about the result.
Called by the framework after performing a computation to inform the domain about the result. That is, after evaluating the effect of the instruction with currentPC on the current stack and register and (if necessary) joining the updated stack and registers with the stack and registers associated with the instruction successorPC. (Hence, this method is ONLY called for return instructions if the return instruction throws an IllegalMonitorStateException.) This function basically informs the domain about the instruction that may be evaluated next. The flow function is called for every possible successor of the instruction with currentPC. This includes all branch targets as well as those instructions that handle exceptions.
In some cases it will even be the case that flow is called multiple times with the same pair of program counters: (currentPC, successorPC). This may happen, e.g., in case of a switch instruction where multiple values have the same body/target instruction and we do not have precise information about the switch value. E.g., as in the following snippet:
```
switch (i) {  // pc: X => Y (for "1"), Y (for "2"), Y (for "3")
case 1:
case 2:
case 3: System.out.println("Great.");            // pc: Y
default: System.out.println("Not So Great.");    // pc: Z
}
```
The flow function is also called after instructions that are domain independent such as dup and load instructions which just manipulate the registers and stack in a generic way. This enables the domain to precisely follow the evaluation progress and in particular to perform control-flow dependent analyses.
currentPC
The program counter of the instruction that is currently evaluated by the abstract interpreter.
currentOperands
The current operands. I.e., the operand stack before the instruction is evaluated.
currentLocals
The current locals. I.e., the locals before the instruction is evaluated.
successorPC
The program counter of an instruction that is a potential successor of the instruction with currentPC. In general the AI framework adds the pc of the successor instruction to the beginning of the worklist unless it is a join instruction. In this case the pc is added to the end – in the context of the current (sub)routine. Hence, the AI framework first evaluates all paths leading to a join instruction before the join instruction will be evaluated.
isSuccessorScheduled
Yes if the successor instruction is or was scheduled. I.e., Yes is returned if the worklist contains successorPC, No if the worklist does not contain successorPC. Unknown is returned if the AI framework did not process the worklist and doesn't know anything about the scheduled successors. Note that this value is independent of the subroutine in which the value may be scheduled. If an implementation schedules successorPC the the super call has to set isSuccessorScheduled to Yes.
isExceptionalControlFlow
true if and only if the evaluation of the instruction with the program counter currentPC threw an exception; false otherwise. Hence, if this parameter is true the instruction with successorPC is the first instruction of the handler.
abruptSubroutineTerminationCount
> 0 if and only if we have an exceptional control flow that terminates one or more subroutines. In this case the successor instruction is scheduled (if at all) after all subroutines that will be terminated by the exception.
wasJoinPerformed
true if a join was performed. I.e., the successor instruction is an instruction (Code.cfJoins) that was already previously evaluated and where multiple paths potentially join.
worklist
The current list of instructions that will be evaluated next.
If subroutines are not used (i.e., Java >= 5)
If you want to force the evaluation of the instruction with the program counter successorPC it is sufficient to test whether the list already contains successorPC and – if not – to prepend it. If the worklist already contains successorPC then the domain is allowed to move the PC to the beginning of the worklist.
If the code contains subroutines (JSR/RET)
If the PC does not belong to the same (current) (sub)routine, it is not allowed to be moved to the beginning of the worklist. (Subroutines can only be found in code generated by old Java compilers; before Java 6. Subroutines are identified by jsr/ret instructions. A subroutine can be identified by going back in the worklist and by looking for specific "program counters" (e.g., SUBROUTINE_START, SUBROUTINE_END). These program counters mark the beginning of a subroutine. In other words, an instruction can be freely moved around unless a special program counter value is found. All special program counters use negative values. Additionally, neither the negative values nor the positive values between two negative values should be changed. Furthermore, no value (PC) should be put between negative values that capture subroutine information. If the domain updates the worklist, it is the responsibility of the domain to call the tracer and to inform it about the changes. Note that the worklist is not allowed to contain duplicates related to the evaluation of the current (sub-)routine.
operandsArray
The array that associates every instruction with its operand stack that is in effect. Note, that only those elements of the array contain values that are related to instructions that were evaluated in the past; the other elements are null. Furthermore, it identifies the operandsArray of the subroutine that will execute the instruction with successorPC. The operandsArray may be null for the current instruction (not the successor instruction) if the execution of the current instruction leads to the termination of the current subroutine. In this case the information about the operands and locals associated with all instructions belonging to the subroutine is reset.
localsArray
The array that associates every instruction with its current register values. Note, that only those elements of the array contain values that are related to instructions that were evaluated in the past. The other elements are null. Furthermore, it identifies the localsArray of the subroutine that will execute the instruction with successorPC. The localsArray may be null for the current instruction (not the successor instruction) if the execution of the current instruction leads to the termination of the current subroutine. In this case the information about the operands and locals associated with all instructions belonging to the subroutine is reset.
returns
The updated worklist. In most cases this is simply the given worklist. The default case is also to return the given worklist.
Definition Classes
CoreDomainFunctionality
Note
The domain is allowed to modify the worklist, operandsArray and localsArray. However, the AI will not perform any checks. In case of updates of the operandsArray or localsArray it is necessary to first create a shallow copy before updating it. If this is not done, it may happen that the locals associated with other instructions are also updated.
,
A method that overrides this method must always call the super method to ensure that every domain that uses this hook gets informed about a flow.
def freturn(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def getfield(pc: Int, objectref: DomainValue, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[DomainValue, ExceptionValue]
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
ValuesCoordinatingDomain → FieldAccessesDomain
def getstatic(pc: Int, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[DomainValue, Nothing]
Returns the field's value.
Returns the field's value.
Definition Classes
ValuesCoordinatingDomain → FieldAccessesDomain
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def i2d(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def i2f(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def i2l(pc: Int, value: DomainValue): DomainValue
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def intAreNotEqual(pc: Int, value1: DomainValue, value2: DomainValue): Answer
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
def intEstablishAreEqual(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
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.
def intEstablishAreNotEqual(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
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.
def intEstablishIsLessThan(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
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.
def intEstablishIsLessThanOrEqualTo(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
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.
def intEstablishValue(pc: Int, theValue: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
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
def intIs0(pc: Int, value: DomainValue): Answer
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
def intIsGreaterThan(pc: Int, largerValue: DomainValue, smallerValue: DomainValue): Answer
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
def intIsGreaterThan0(pc: Int, value: DomainValue): Answer
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
def intIsGreaterThanOrEqualTo(pc: Int, largerOrEqualValue: DomainValue, smallerOrEqualValue: DomainValue): Answer
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
def intIsGreaterThanOrEqualTo0(pc: Int, value: DomainValue): Answer
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
def intIsLessThan0(pc: Int, value: DomainValue): Answer
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
def intIsLessThanOrEqualTo0(pc: Int, value: DomainValue): Answer
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
def intIsNot0(pc: Int, value: DomainValue): Answer
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
def invokedynamic(pc: Int, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: Operands): Computation[DomainValue, ExceptionValues]
Definition Classes
ValuesCoordinatingDomain → MethodCallsDomain
def invokeinterface(pc: Int, declaringClass: ObjectType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
Definition Classes
ValuesCoordinatingDomain → MethodCallsDomain
def invokespecial(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
Definition Classes
ValuesCoordinatingDomain → MethodCallsDomain
def invokestatic(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
Definition Classes
ValuesCoordinatingDomain → MethodCallsDomain
def invokevirtual(pc: Int, declaringClass: ReferenceType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
Definition Classes
ValuesCoordinatingDomain → MethodCallsDomain
def ireturn(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
final def isASubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer
Tests if subtype is known to be subtype of supertype.
Tests if subtype is known to be subtype of supertype. See org.opalj.br.ClassHierarchy's isSubtypeOf method for details.
Definition Classes
ValuesDomain
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Boolean
Tests if subtype is known to be subtype of supertype.
Tests if subtype is known to be subtype of supertype. See org.opalj.br.ClassHierarchy's isSubtypeOf method for details.
Definition Classes
ValuesDomain
def join(pc: Int, thisOperands: Operands, thisLocals: Locals, otherOperands: Operands, otherLocals: Locals): Update[(Operands, Locals)]
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 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.
,
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.
def joinPostProcessing(updateType: UpdateType, pc: Int, oldOperands: Operands, oldLocals: Locals, newOperands: Operands, newLocals: Locals): Update[(Operands, Locals)]
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
IdentityBasedCorrelationChangeDetection → CoreDomainFunctionality
def joinValues(pc: Int, left: DomainValue, right: DomainValue): Update[DomainValue]
Classes overriding this method generally have to call it!
Classes overriding this method generally have to call it!
Attributes
protected[this]
Definition Classes
JoinStabilization → CoreDomainFunctionality
val joinedValues: HashMap[IdentityPair[AnyRef, AnyRef], Update[DomainValue]]
Attributes
protected[this]
Definition Classes
JoinStabilization
def jumpToSubroutine(pc: Int, branchTarget: Int, returnTarget: Int): Unit
pc
The pc of the jsr(w) instruction.
Definition Classes
SubroutinesDomain
final def justThrows(value: ExceptionValue): ThrowsException[ExceptionValues]
Definition Classes
ReferenceValuesFactory
def l2d(pc: Int, value: DomainValue): DomainValue
Conversion of the given long value to a double value.
Conversion of the given long value to a double value.
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def l2f(pc: Int, value: DomainValue): DomainValue
Conversion of the given long value to a float value.
Conversion of the given long value to a float value.
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def l2i(pc: Int, value: DomainValue): DomainValue
Conversion of the given long value to an integer value.
Conversion of the given long value to an integer value.
Definition Classes
ValuesCoordinatingDomain → PrimitiveValuesConversionsDomain
def lreturn(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
def lshl(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
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.
Definition Classes
ValuesCoordinatingDomain → LongValuesDomain
def lshr(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
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.
Definition Classes
ValuesCoordinatingDomain → LongValuesDomain
def lushr(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
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.
Definition Classes
ValuesCoordinatingDomain → LongValuesDomain
def mergeDomainValues(pc: Int, v1: DomainValue, v2: DomainValue): DomainValue
Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.
Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.
This operation is commutative.
Definition Classes
ValuesDomain
def monitorenter(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
Handles a monitorenter instruction.
Handles a monitorenter instruction.
Definition Classes
ValuesCoordinatingDomain → MonitorInstructionsDomain
Note
A monitor enter instruction may throw a NullPointerException.
def monitorexit(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValues]
Handles a monitorexit instruction.
Handles a monitorexit instruction.
Definition Classes
ValuesCoordinatingDomain → MonitorInstructionsDomain
Note
A monitor exit instruction may throw a NullPointerException or an IllegalMonitorStateException.
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
def properties(pc: PC, propertyToString: (AnyRef) => String = p => p.toString): Option[String]
Returns a string representation of the properties associated with the instruction with the respective program counter.
Returns a string representation of the properties associated with the instruction with the respective program counter.
Associating properties with an instruction and maintaining those properties is, however, at the sole responsibility of the Domain.
This method is predefined to facilitate the development of support tools and is not used by the abstract interpretation framework.
Domains that define (additional) properties should (abstract) override this method and should return a textual representation of the property.
Definition Classes
ValuesDomain
def putfield(pc: Int, objectref: DomainValue, value: DomainValue, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → FieldAccessesDomain
def putstatic(pc: Int, value: DomainValue, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[Nothing, Nothing]
Sets the field's value.
Sets the field's value.
Definition Classes
ValuesCoordinatingDomain → FieldAccessesDomain
def refAreNotEqual(pc: Int, value1: DomainValue, value2: DomainValue): Answer
Compares the given values for reference inequality.
Compares the given values for reference inequality. Returns No if both values point to the same instance and returns Yes if both objects are known not to point to the same instance. The latter is, e.g., trivially the case when both values have a different concrete type. Otherwise Unknown is returned.
If both values are representing the null value the org.opalj.Answer is Yes.
value1
A value of computational type reference.
value2
A value of computational type reference.
Definition Classes
ReferenceValuesDomain
def refEstablishAreEqual(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison succeeded.
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
def refEstablishAreNotEqual(pc: Int, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison failed.
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
def refEstablishIsNonNull(pc: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
Called by OPAL-AI when it establishes that the value is guaranteed not to be null.
Called by OPAL-AI when it establishes that the value is guaranteed not to be null. E.g., after a comparison with null OPAL can establish that the value has to be null on one branch and that the value is not null on the other branch.
Definition Classes
ReferenceValuesDomain
def refEstablishIsNull(pc: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
Called by the framework when the value is known to be null/has to be null.
Called by the framework when the value is known to be null/has to be null. E.g., after a comparison with null (IFNULL/IFNONNULL) OPAL-AI knows that the value has to be null on one branch and that the value is not null on the other branch.
Definition Classes
ReferenceValuesDomain
def refIsNonNull(pc: Int, value: DomainValue): Answer
Returns Yes if given value is never null, Unknown if the values is maybe null and No otherwise.
Returns Yes if given value is never null, Unknown if the values is maybe null and No otherwise.
value
A value of computational type reference.
Definition Classes
ReferenceValuesDomain
def returnFromSubroutine(pc: Int, lvIndex: Int): Unit
pc
The pc of the ret instruction.
Definition Classes
SubroutinesDomain
def returnVoid(pc: Int): Computation[Nothing, ExceptionValue]
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
ValuesCoordinatingDomain → ReturnInstructionsDomain
def schedule(successorPC: Int, abruptSubroutineTerminationCount: Int, worklist: List[Int]): List[Int]
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
def summarize(pc: Int, values: Iterable[DomainValue]): DomainValue
Creates a summary of the given domain values by summarizing and joining the given values.
Creates a summary of the given domain values by summarizing and joining the given values. For the precise details regarding the calculation of a summary see Value.summarize(...).
pc
The program counter that will be used for the summary value if a new value is returned that abstracts over/summarizes the given values.
values
An Iterable over one or more values.
Definition Classes
ValuesDomain
Note
The current algorithm is generic and should satisfy most needs, but it is not very efficient. However, it should be easy to tailor it for a specific domain/domain values, if need be.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def throwArithmeticExceptions: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwArrayIndexOutOfBoundsException: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwArrayStoreException: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwClassCastException: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
Note
Directly used by the AI itself.
def throwClassNotFoundException: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwExceptionsOnMethodCall: ExceptionsRaisedByCalledMethod
Determines the behavior how method calls are handled when the exceptions that the called method may throw are unknown.
Determines the behavior how method calls are handled when the exceptions that the called method may throw are unknown.
Definition Classes
ValuesCoordinatingDomain → Configuration
Note
Used by domains which handle method invokations.
def throwIllegalMonitorStateException: Boolean
If true then monitorexit and the (XXX)return instructions will throw IllegalMonitorStateExceptions unless the analysis is able to determine that the exception is guaranteed not 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 not to be raised.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwNegativeArraySizeException: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwNullPointerExceptionOnArrayAccess: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwNullPointerExceptionOnFieldAccess: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwNullPointerExceptionOnMethodCall: Boolean
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
}
```
Definition Classes
ValuesCoordinatingDomain → Configuration
Note
Used by domains which handle method invokations.
def throwNullPointerExceptionOnMonitorAccess: Boolean
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.
Definition Classes
ValuesCoordinatingDomain → Configuration
def throwNullPointerExceptionOnThrow: Boolean
If true a VM level NullPointerExceptions is thrown if the exception that is to be thrown may be null.
If true a VM level NullPointerExceptions is thrown if the exception that is to be thrown may be null.
Definition Classes
ValuesCoordinatingDomain → Configuration
Note
Directly used by the AI itself.
final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]
Definition Classes
ReferenceValuesFactory
def toString(): String
Definition Classes
AnyRef → Any
def updateMemoryLayout(oldValue: DomainValue, newValue: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
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
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

Types of Domains

Thread Safety

ValuesCoordinatingDomain

trait ValuesCoordinatingDomain extends CorrelationalDomain with Configuration

Core Properties

Type Members

Use Of Value/Dependencies On Value

Refining Value

Implementing Value

Abstract Value Members

Summary

Initialization

General Remarks

Summary

Summary

Summary

Summary

Summary

Summary

Summary

Concrete Value Members

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

If the code contains subroutines (JSR/RET)

Performance

Deprecated Value Members

Inherited from CorrelationalDomain

Inherited from CorrelationalDomainSupport

Inherited from IdentityBasedCorrelationChangeDetection

Inherited from JoinStabilization

Inherited from Domain

Inherited from Configuration

Inherited from TypedValuesFactory

Inherited from PrimitiveValuesConversionsDomain

Inherited from DynamicLoadsDomain

Inherited from ai.ReturnInstructionsDomain

Inherited from MonitorInstructionsDomain

Inherited from MethodCallsDomain

Inherited from FieldAccessesDomain

Inherited from ReferenceValuesDomain

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from DoubleValuesDomain

Inherited from DoubleValuesFactory

Inherited from FloatValuesDomain

Inherited from FloatValuesFactory

Inherited from LongValuesDomain

Inherited from LongValuesFactory

Inherited from IntegerValuesDomain

Inherited from IntegerValuesFactory

Inherited from CoreDomainFunctionality

Inherited from SubroutinesDomain

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

ValuesCoordinatingDomain