trait TypeLevelReferenceValues extends GeneralizedArrayHandling with AsJavaObject
Implements the foundations for performing computations related to reference values.
Extending/Implementing This Domain
The following implementation decisions need to be taken into account when inheriting from this trait:
- By default equality of
DomainValue
s that represent reference values is reference based. I.e., two instances ofDomainValue
s that represent reference values are never equal. However, subclasses may implement their own strategy. - Instances of
DomainValue
s are always immutable or are at least considered and treated as immutable. Every update of a value's properties creates a new value. This is a general design decision underlying OPAL and should not be changed. - A new instance of a
DomainValue
is always exclusively created by one of the factory methods. (The factory methods generally start with a capital letter and are correspondingly documented.) This greatly facilitates domain adaptability and selective customizations.
- Self Type
- TypeLevelReferenceValues with IntegerValuesDomain with Configuration
- Source
- TypeLevelReferenceValues.scala
- Alphabetic
- By Inheritance
- TypeLevelReferenceValues
- AsJavaObject
- GeneralizedArrayHandling
- ReferenceValuesDomain
- ReferenceValuesFactory
- ExceptionsFactory
- ValuesDomain
- AnyRef
- Any
- Hide All
- Show All
- 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 theValue
trait should be refined, all additional methods may – from the point-of-view of OPAL-AI – just throw anUnsupportedOperationException
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 onValue
. Instead they should useDomainValue
as otherwise extensibility of aDomain
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 liketrait 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 typeDomainType
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
'sequals
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 arbitraryInteger
value has to returntrue
if the domain value with which it is compared also represents an arbitraryInteger
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 theAnIntegervalue
from some otherAnIntegerValue
to avoid constraining unrelated values.public void foo(int a,int b) { if(a < 4) { z = a - 2 // here a is constrained (< 4), b and z are unconstrained } else { z = a + 2 // here a is constrained (>= 4), b and z are unconstrained } }
In general,
equals
is only defined for values belonging to the same domain. If values need to be compared across domains, they need to be adapted to a target domain first.
- abstract type AReferenceValue <: (TypeLevelReferenceValues.this)#DomainReferenceValue with (TypeLevelReferenceValues.this)#ReferenceValueLike
- trait ArrayAbstraction extends AnyRef
- type ArrayLoadResult = Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#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
andArrayIndexOutOfBoundsException
.- Definition Classes
- ReferenceValuesDomain
- type ArrayStoreResult = Computation[Nothing, (TypeLevelReferenceValues.this)#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
andArrayStoreException
.- Definition Classes
- ReferenceValuesDomain
- trait ArrayValueLike extends (TypeLevelReferenceValues.this)#ReferenceValueLike with IsSArrayValue
Represents an array value.
Represents an array value.
- Attributes
- protected[this]
- abstract type DomainArrayValue <: (TypeLevelReferenceValues.this)#ArrayValueLike with (TypeLevelReferenceValues.this)#AReferenceValue
- abstract type DomainIllegalValue <: (TypeLevelReferenceValues.this)#IllegalValue with (TypeLevelReferenceValues.this)#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 typeDomainValue
is refined.- Definition Classes
- ValuesDomain
- abstract type DomainNullValue <: (TypeLevelReferenceValues.this)#NullValueLike with (TypeLevelReferenceValues.this)#AReferenceValue
- abstract type DomainObjectValue <: (TypeLevelReferenceValues.this)#ObjectValueLike with (TypeLevelReferenceValues.this)#AReferenceValue
- abstract type DomainReferenceValue >: Null <: (TypeLevelReferenceValues.this)#ReferenceValue with (TypeLevelReferenceValues.this)#DomainTypedValue[ReferenceType]
- Definition Classes
- ValuesDomain
- abstract type DomainReturnAddressValue <: (TypeLevelReferenceValues.this)#ReturnAddressValue with (TypeLevelReferenceValues.this)#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 theValue
trait nor theReturnAddressValue
trait was refined) it is sufficient to write:type DomainReturnAddressValue = ReturnAddressValue
- Definition Classes
- ValuesDomain
- abstract type DomainReturnAddressValues <: (TypeLevelReferenceValues.this)#ReturnAddressValues with (TypeLevelReferenceValues.this)#DomainValue
- Definition Classes
- ValuesDomain
- abstract type DomainTypedValue[+T <: Type] >: Null <: (TypeLevelReferenceValues.this)#DomainValue
- Definition Classes
- ValuesDomain
- abstract type DomainValue >: Null <: (TypeLevelReferenceValues.this)#Value
Abstracts over the concrete type of
Value
.Abstracts over the concrete type of
Value
. Needs to be refined by traits that inherit fromDomain
and which extendDomain
'sValue
trait.- Definition Classes
- ValuesDomain
- type ExceptionValue = (TypeLevelReferenceValues.this)#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[(TypeLevelReferenceValues.this)#ExceptionValue]
A type alias for
Iterable
s ofExceptionValue
s; used to facilitate comprehension.A type alias for
Iterable
s ofExceptionValue
s; used to facilitate comprehension.- Definition Classes
- ValuesDomain
- type Locals = collection.mutable.Locals[(TypeLevelReferenceValues.this)#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[(TypeLevelReferenceValues.this)#Locals]
- Definition Classes
- ValuesDomain
- trait NullValueLike extends (TypeLevelReferenceValues.this)#ReferenceValueLike with IsNullValue
Represents the runtime value
null
.Represents the runtime value
null
. Null values are basically found in the following two cases:- The value
null
was pushed onto the stack usingaconst_null
. - A reference value that is not guaranteed to be non-null is tested against
null
usingifnull
orifnonnull
and we are now on the branch where the value has to benull
.
Depending on the precision of the domain
null
values may also be returned by method calls or field reads.- Attributes
- protected
- The value
- trait ObjectValueLike extends (TypeLevelReferenceValues.this)#ReferenceValueLike
Represents a class/interface value which may have a single class and/or multiple interfaces as its upper type bound.
Represents a class/interface value which may have a single class and/or multiple interfaces as its upper type bound.
- Attributes
- protected[this]
- type Operands = List[(TypeLevelReferenceValues.this)#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[(TypeLevelReferenceValues.this)#Operands]
- Definition Classes
- ValuesDomain
- trait ReferenceValueLike extends (TypeLevelReferenceValues.this)#ReferenceValue with (TypeLevelReferenceValues.this)#ArrayAbstraction
Abstracts over all values with computational type
reference
.Abstracts over all values with computational type
reference
. I.e., abstracts over class and array values and also thenull
value. - trait SReferenceValue[T <: ReferenceType] extends (TypeLevelReferenceValues.this)#ReferenceValueLike with IsSReferenceValue[T]
A reference value with a single (upper) type (bound).
A reference value with a single (upper) type (bound).
- Attributes
- protected[this]
Abstract Value Members
- abstract def ArithmeticException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
ArithmeticException
and that has the givenorigin
.Creates a non-null object that represent a
ArithmeticException
and that has the givenorigin
. If theArithmeticException
was created by the VM while evaluating an instruction with the program counterpc
you use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def ArrayIndexOutOfBoundsException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
ArrayIndexOutOfBoundsException
and that has the givenorigin
.Creates a non-null object that represent a
ArrayIndexOutOfBoundsException
and that has the givenorigin
. If theArrayIndexOutOfBoundsException
was created by the VM while evaluating an instruction with the program counterpc
you use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def ArrayStoreException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
ArrayStoreException
and that has the givenorigin
.Creates a non-null object that represent a
ArrayStoreException
and that has the givenorigin
. If theArrayStoreException
was created by the VM while evaluating an instruction with the program counterpc
you use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def ArrayValue(pc: Int, arrayType: ArrayType): (TypeLevelReferenceValues.this)#DomainArrayValue
Creates a new
DomainValue
that represents an array value with unknown values and where the specified type may also just be an upper type bound (unless the component type is a primitive type or an array of primitives.)Creates a new
DomainValue
that represents an array value with unknown values and where the specified type may also just be an upper type bound (unless the component type is a primitive type or an array of primitives.)Typical Usage
This factory method is (typically) used to create a domain value that represents an array if we know nothing specific about the array. E.g., if you want to analyze a method that takes an array as a parameter.
Summary
The properties of the value are:
- Type: Upper Bound (unless the elementType is a base type)
- Null: Unknown
- Size: Unknown
- Content: Unknown
- Note
Java's arrays are co-variant. I.e.,
Object[] a = new Serializable[100];
is valid.
- abstract def ClassCastException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
ClassCastException
and that has the givenorigin
.Creates a non-null object that represent a
ClassCastException
and that has the givenorigin
. If theClassCastException
was created by the VM while evaluating an instruction with the program counterpc
you use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def ClassNotFoundException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- abstract val DomainReferenceValueTag: ClassTag[(TypeLevelReferenceValues.this)#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[(TypeLevelReferenceValues.this)#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 abstractval
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 IllegalMonitorStateException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent an
IllegalMonitorStateException
and that has the givenorigin
.Creates a non-null object that represent an
IllegalMonitorStateException
and that has the givenorigin
. If theIllegalMonitorStateException
was created by the VM while evaluating an instruction with the program counterpc
you should use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def MetaInformationUpdateIllegalValue: MetaInformationUpdate[(TypeLevelReferenceValues.this)#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): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
NegativeArraySizeException
and that has the givenorigin
.Creates a non-null object that represent a
NegativeArraySizeException
and that has the givenorigin
. If theNegativeArraySizeException
was created by the VM while evaluating an instruction with the program counterpc
you use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def NullPointerException(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
NullPointerException
and that has the givenorigin
.Creates a non-null object that represent a
NullPointerException
and that has the givenorigin
. If theNullPointerException
was created by the VM while evaluating an instruction with the program counterpc
you should use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- abstract def NullValue(pc: Int): (TypeLevelReferenceValues.this)#DomainNullValue
Factory method to create a
DomainValue
that represents valuenull
and and that was created (explicitly or implicitly) by the instruction with the specified program counter.Factory method to create a
DomainValue
that represents valuenull
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- abstract def ObjectValue(pc: Int, upperTypeBound: UIDSet[ObjectType]): (TypeLevelReferenceValues.this)#DomainObjectValue
Factory method to create a
DomainValue
that represents either an class-/interface value that has the given types as an upper bound or the valuenull
.Factory method to create a
DomainValue
that represents either an class-/interface value that has the given types as an upper bound or the valuenull
. However, the information whether the value isnull
or not is not available. Furthermore, the type may also just be an upper bound and it is not known if the value is properly initialized.Summary
The properties of the domain value are:
- Initialized: Yes (An Object with multiple bounds can only exist due to a merge, in this case, the objects must have been initialized beforehand or the value is not used at all and actually represents a dead variable.)
- Type: Upper Bound
- Null: Unknown
- Content: Unknown
- abstract def ObjectValue(pc: Int, objectType: ObjectType): (TypeLevelReferenceValues.this)#DomainObjectValue
Factory method to create a
DomainValue
that represents either an class-/interface value that has the given type or the valuenull
.Factory method to create a
DomainValue
that represents either an class-/interface value that has the given type or the valuenull
. However, the information whether the value isnull
or not is not available. Furthermore, the type may also just be an upper bound and it is not known if the value is properly initialized.Summary
The properties of the domain value are:
- Initialized: Unknown
(I.e., it is not guaranteed that the constructor was called; unless
NewObject
was overridden and returns DomainValues that are distinguishable!) - Type: Upper Bound
- Null: Unknown
- Content: Unknown
- Initialized: Unknown
(I.e., it is not guaranteed that the constructor was called; unless
- abstract def ReturnAddressValue(address: Int): (TypeLevelReferenceValues.this)#DomainReturnAddressValue
Factory method to create an instance of a
ReturnAddressValue
.Factory method to create an instance of a
ReturnAddressValue
.- Definition Classes
- ValuesDomain
- abstract val TheIllegalValue: (TypeLevelReferenceValues.this)#DomainIllegalValue
The singleton instance of the
IllegalValue
.The singleton instance of the
IllegalValue
.- Definition Classes
- ValuesDomain
- abstract val TheReturnAddressValues: (TypeLevelReferenceValues.this)#DomainReturnAddressValues
The singleton instance of
ReturnAddressValues
The singleton instance of
ReturnAddressValues
- Definition Classes
- ValuesDomain
- abstract def Throwable(origin: ValueOrigin): (TypeLevelReferenceValues.this)#ExceptionValue
Creates a non-null object that represent a
Throwable
object and that has the givenorigin
.Creates a non-null object that represent a
Throwable
object and that has the givenorigin
. If theThrowable
was created by the VM while evaluating an instruction with the program counterpc
you should use the method ValueOriginForImmediateVMException to translate thatpc
to the appropriate ValueOrigin.- Definition Classes
- ExceptionsFactory
- 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
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
- def ClassValue(pc: Int, t: Type): (TypeLevelReferenceValues.this)#DomainObjectValue
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- def InitializedDomainValue(origin: ValueOrigin, vi: ValueInformation): (TypeLevelReferenceValues.this)#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
- TypeLevelReferenceValues → 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.
- def InitializedObjectValue(pc: Int, objectType: ObjectType): (TypeLevelReferenceValues.this)#DomainObjectValue
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
andClassCastException
). 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
- TypeLevelReferenceValues → ReferenceValuesFactory
- final def MethodExternalNullPointerException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- def MethodHandle(origin: ValueOrigin, handle: MethodHandle): (TypeLevelReferenceValues.this)#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): (TypeLevelReferenceValues.this)#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
- def NewArray(pc: Int, counts: (TypeLevelReferenceValues.this)#Operands, arrayType: ArrayType): (TypeLevelReferenceValues.this)#DomainArrayValue
Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.
Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.
Typical Usage
This factory method is (implicitly) used, e.g., by OPAL when a
multianewarray
instruction is found.Summary
The properties of the value are:
- Type: Precise
- Null: No
- Size: Depending on the values in
counts
- Content: Symbol("Empty")' (i.e., default values w.r.t. to the array's component type)
- def NewArray(pc: Int, count: (TypeLevelReferenceValues.this)#DomainValue, arrayType: ArrayType): (TypeLevelReferenceValues.this)#DomainArrayValue
Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.
Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.
Typical Usage
This factory method is (implicitly) used, e.g., by OPAL when a
newarray
instruction is found.Summary
The properties of the value are:
- Type: Precise
- Null: No
- Size: Count
- Content: Symbol("Empty")' (i.e., default values w.r.t. to the array's component type)
- def NewObject(pc: Int, objectType: ObjectType): (TypeLevelReferenceValues.this)#DomainObjectValue
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- Note
Instances of arrays are created by the
newarray
andmultianewarray
instructions and in both cases an exception may be thrown (e.g.,NegativeArraySizeException
).
- def NonNullObjectValue(pc: Int, objectType: ObjectType): (TypeLevelReferenceValues.this)#DomainObjectValue
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- final def ReferenceValue(pc: Int, upperTypeBound: ReferenceType): (TypeLevelReferenceValues.this)#AReferenceValue
Factory method to create a
DomainValue
that represents either a reference value that has the given type and is initialized or the valuenull
.Factory method to create a
DomainValue
that represents either a reference value that has the given type and is initialized or the valuenull
. However, the information whether the value isnull
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- def StringValue(pc: Int, value: String): (TypeLevelReferenceValues.this)#DomainObjectValue
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- Initialized: Yes and the String's value is the given value. The string
may be empty (""), but it is never
- final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]
The result of merging two values should never be reported as a
StructuralUpdate
if the computed value is anIllegalValue
.The result of merging two values should never be reported as a
StructuralUpdate
if the computed value is anIllegalValue
. 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 UninitializedThis(objectType: ObjectType): (TypeLevelReferenceValues.this)#DomainObjectValue
Creates a new
DomainValue
that represents thethis
value of a constructor before the super constructor is called.Creates a new
DomainValue
that represents thethis
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
- TypeLevelReferenceValues → ReferenceValuesFactory
- Note
Instances of arrays are never uninitialized.
- final def VMArithmeticException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMArrayIndexOutOfBoundsException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMArrayStoreException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMClassCastException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMClassNotFoundException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMIllegalMonitorStateException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMNegativeArraySizeException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMNullPointerException(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- final def VMThrowable(pc: Int): (TypeLevelReferenceValues.this)#ExceptionValue
- Definition Classes
- ExceptionsFactory
- def aaload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def aastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def arraylength(pc: Int, arrayref: (TypeLevelReferenceValues.this)#DomainValue): Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValue]
Returns the array's length or throws a
NullPointerException
if the given reference isnull
.Returns the array's length or throws a
NullPointerException
if the given reference isnull
.- Definition Classes
- TypeLevelReferenceValues → ReferenceValuesDomain
- Note
It is in general not necessary to override this method. If you need some special handling refine the trait
ArrayValue
.
- def arrayload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
Loads the value stored in the array at the given index or throws an exception (
NullPointerException
orIndexOutOfBoundsException
).Loads the value stored in the array at the given index or throws an exception (
NullPointerException
orIndexOutOfBoundsException
).- Definition Classes
- TypeLevelReferenceValues → GeneralizedArrayHandling
- Note
It is in general not necessary to override this method. If you need some special handling refine the
load
method defined by the traitArrayValue
.
- def arraystore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
Stores the given value in the array at the given index or throws an exception (
NullPointerException
,ArrayStoreException
orIndexOutOfBoundsException
).Stores the given value in the array at the given index or throws an exception (
NullPointerException
,ArrayStoreException
orIndexOutOfBoundsException
).- Definition Classes
- TypeLevelReferenceValues → GeneralizedArrayHandling
- Note
It is in general not necessary to override this method. If you need some special handling refine the
store
method defined by the traitArrayValue
.
- def asArrayAbstraction(value: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayAbstraction
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asObjectValue(value: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#DomainObjectValue
- def asReferenceValue(value: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#AReferenceValue
Returns the given value as a DomainReferenceValue.
Returns the given value as a DomainReferenceValue. Basically just performs a type cast and is intended to be used to communicate that the value has to be a reference value (if the underlying byte code is valid.)
- def baload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def bastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def caload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def castore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def daload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def dastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def faload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def fastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def iaload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def iastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- final def isASubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer
Tests if
subtype
is known to be subtype ofsupertype
.Tests if
subtype
is known to be subtype ofsupertype
. See org.opalj.br.ClassHierarchy'sisSubtypeOf
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 ofsupertype
.Tests if
subtype
is known to be subtype ofsupertype
. See org.opalj.br.ClassHierarchy'sisSubtypeOf
method for details.- Definition Classes
- ValuesDomain
- final def isValueASubtypeOf(value: (TypeLevelReferenceValues.this)#DomainValue, supertype: ReferenceType): Answer
Tries to determine – under the assumption that the given
value
is notnull
– if the runtime type of the given reference value could be a subtype of the specified reference typesupertype
.Tries to determine – under the assumption that the given
value
is notnull
– if the runtime type of the given reference value could be a subtype of the specified reference typesupertype
. I.e., if the type of the value is not precisely known, then all subtypes of thevalue
'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 givensupertype
the answer will beNo
.- Definition Classes
- TypeLevelReferenceValues → ReferenceValuesDomain
- Note
The returned value is only meaningful if
value
does not represent the runtime valuenull
.
- final def justThrows(value: (TypeLevelReferenceValues.this)#ExceptionValue): ThrowsException[(TypeLevelReferenceValues.this)#ExceptionValues]
- Definition Classes
- ReferenceValuesFactory
- def laload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def lastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def mergeDEComputations(pc: Int, c1: Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValue], c2: Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValue]): Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValue]
Merges two computations that both resulted in at most one
DomainValue
or at most oneExceptionValue
.Merges two computations that both resulted in at most one
DomainValue
or at most oneExceptionValue
.If values are merged the merged value will use the specified
pc
.- Attributes
- protected[this]
- def mergeDEsComputations(pc: Int, c1: Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValues], c2: Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValues]): Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValues]
Merges two computations that both return some
DomainValue
and someExceptionValues
.Merges two computations that both return some
DomainValue
and someExceptionValues
. If values are merged the merged value will use the specifiedpc
.- Attributes
- protected[this]
- def mergeDomainValues(pc: Int, v1: (TypeLevelReferenceValues.this)#DomainValue, v2: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#DomainValue
Merges the given domain value
v1
with the domain valuev2
and returns the merged value which isv1
ifv1
is an abstraction ofv2
,v2
ifv2
is an abstraction ofv1
or some other value if a new value is computed that abstracts over both values.Merges the given domain value
v1
with the domain valuev2
and returns the merged value which isv1
ifv1
is an abstraction ofv2
,v2
ifv2
is an abstraction ofv1
or some other value if a new value is computed that abstracts over both values.This operation is commutative.
- Definition Classes
- ValuesDomain
- def mergeEsComputations(pc: Int, c1: Computation[Nothing, (TypeLevelReferenceValues.this)#ExceptionValues], c2: Computation[Nothing, (TypeLevelReferenceValues.this)#ExceptionValues]): Computation[Nothing, (TypeLevelReferenceValues.this)#ExceptionValues]
Merges two computations that both resulted in at most one
ExceptionValue
each.Merges two computations that both resulted in at most one
ExceptionValue
each.If values are merged the merged value will use the specified
pc
.- Attributes
- protected[this]
- def mergeMultipleExceptionValues(pc: Int, v1s: (TypeLevelReferenceValues.this)#ExceptionValues, v2s: (TypeLevelReferenceValues.this)#ExceptionValues): (TypeLevelReferenceValues.this)#ExceptionValues
Merges those exceptions that have the same upper type bound.
Merges those exceptions that have the same upper type bound. This ensures that per upper type bound only one ValuesDomain.DomainValue (which may be a
MultipleReferenceValues
) is used. For those values that are merged, the givenpc
is used. - def multianewarray(pc: Int, counts: (TypeLevelReferenceValues.this)#Operands, arrayType: ArrayType): Computation[(TypeLevelReferenceValues.this)#DomainArrayValue, (TypeLevelReferenceValues.this)#ExceptionValue]
Creates a multi-dimensional array.
Creates a multi-dimensional array.
- Definition Classes
- TypeLevelReferenceValues → ReferenceValuesDomain
- Note
The componentType may be (again) an array type.
,It is generally not necessary to override this method as it handles all cases in a generic manner.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newarray(pc: Int, count: (TypeLevelReferenceValues.this)#DomainValue, componentType: FieldType): Computation[(TypeLevelReferenceValues.this)#DomainValue, (TypeLevelReferenceValues.this)#ExceptionValue]
Creates a new array.
Creates a new array.
- Definition Classes
- TypeLevelReferenceValues → ReferenceValuesDomain
- Note
It is generally not necessary to override this method as it handles all cases in a generic manner.
- 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.
Domain
s that define (additional) properties should (abstract
)override
this method and should return a textual representation of the property.- Definition Classes
- ValuesDomain
- def refAreEqual(pc: Int, value1: (TypeLevelReferenceValues.this)#DomainValue, value2: (TypeLevelReferenceValues.this)#DomainValue): Answer
Tests if both values refer to the same object instance.
Tests if both values refer to the same object instance.
Though this is in general intractable, there are some cases where a definitive answer is possible.
This implementation completely handles the case where at least one value definitively represents the
null
value. Additionally, if we have precise type information and the types are different,No
is returned. Otherwise,Unknown
is returned.- value1
A value of type
ReferenceValue
.- value2
A value of type
ReferenceValue
.
- Definition Classes
- TypeLevelReferenceValues → ReferenceValuesDomain
- Note
This method is intended to be overridden by subclasses and may be the first one that is called (by means of
super
) by the overriding method to handle checks related to null. E.g.super.areEqualReferences(value1,value2).ifUnknown { ... }
- def refAreNotEqual(pc: Int, value1: (TypeLevelReferenceValues.this)#DomainValue, value2: (TypeLevelReferenceValues.this)#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 returnsYes
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. OtherwiseUnknown
is returned.If both values are representing the
null
value the org.opalj.Answer isYes
.- value1
A value of computational type reference.
- value2
A value of computational type reference.
- Definition Classes
- ReferenceValuesDomain
- def refEstablishAreEqual(pc: Int, value1: (TypeLevelReferenceValues.this)#DomainValue, value2: (TypeLevelReferenceValues.this)#DomainValue, operands: (TypeLevelReferenceValues.this)#Operands, locals: (TypeLevelReferenceValues.this)#Locals): ((TypeLevelReferenceValues.this)#Operands, (TypeLevelReferenceValues.this)#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: (TypeLevelReferenceValues.this)#DomainValue, value2: (TypeLevelReferenceValues.this)#DomainValue, operands: (TypeLevelReferenceValues.this)#Operands, locals: (TypeLevelReferenceValues.this)#Locals): ((TypeLevelReferenceValues.this)#Operands, (TypeLevelReferenceValues.this)#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: (TypeLevelReferenceValues.this)#DomainValue, operands: (TypeLevelReferenceValues.this)#Operands, locals: (TypeLevelReferenceValues.this)#Locals): ((TypeLevelReferenceValues.this)#Operands, (TypeLevelReferenceValues.this)#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 withnull
OPAL can establish that the value has to benull
on one branch and that the value is notnull
on the other branch.- Definition Classes
- ReferenceValuesDomain
- def refEstablishIsNull(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, operands: (TypeLevelReferenceValues.this)#Operands, locals: (TypeLevelReferenceValues.this)#Locals): ((TypeLevelReferenceValues.this)#Operands, (TypeLevelReferenceValues.this)#Locals)
Called by the framework when the value is known to be
null
/has to benull
.Called by the framework when the value is known to be
null
/has to benull
. E.g., after a comparison withnull
(IFNULL/IFNONNULL) OPAL-AI knows that the value has to benull
on one branch and that the value is notnull
on the other branch.- Definition Classes
- ReferenceValuesDomain
- def refIsNonNull(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue): Answer
Returns
Yes
if given value is nevernull
,Unknown
if the values is maybenull
andNo
otherwise.Returns
Yes
if given value is nevernull
,Unknown
if the values is maybenull
andNo
otherwise.- value
A value of computational type reference.
- Definition Classes
- ReferenceValuesDomain
- final def refIsNull(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue): Answer
Determines the nullness-property of the given value.
Determines the nullness-property of the given value.
- value
A value of type
ReferenceValue
.
- Definition Classes
- TypeLevelReferenceValues → ReferenceValuesDomain
- def refSetUpperTypeBoundOfTopOperand(pc: Int, upperTypeBound: ReferenceType, operands: (TypeLevelReferenceValues.this)#Operands, locals: (TypeLevelReferenceValues.this)#Locals): ((TypeLevelReferenceValues.this)#Operands, (TypeLevelReferenceValues.this)#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
- TypeLevelReferenceValues → ReferenceValuesDomain
- def refTopOperandIsNull(pc: Int, operands: (TypeLevelReferenceValues.this)#Operands, locals: (TypeLevelReferenceValues.this)#Locals): ((TypeLevelReferenceValues.this)#Operands, (TypeLevelReferenceValues.this)#Locals)
Sets the
is null
property of the top-most stack value toYes
.Sets the
is null
property of the top-most stack value toYes
. This method is called by the framework when the top-most operand stack value has to be null, but a previousisNull
check returned Unknown. E.g., after a org.opalj.br.instructions.CHECKCAST that fails or if aInstanceOf
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
- TypeLevelReferenceValues → ReferenceValuesDomain
- def saload(pc: Int, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def sastore(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue, index: (TypeLevelReferenceValues.this)#DomainValue, arrayref: (TypeLevelReferenceValues.this)#DomainValue): (TypeLevelReferenceValues.this)#ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def summarize(pc: Int, values: Iterable[(TypeLevelReferenceValues.this)#DomainValue]): (TypeLevelReferenceValues.this)#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 seeValue.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
- final def throws(value: (TypeLevelReferenceValues.this)#ExceptionValue): ThrowsException[(TypeLevelReferenceValues.this)#ExceptionValue]
- Definition Classes
- ReferenceValuesFactory
- def toJavaObject(pc: Int, value: (TypeLevelReferenceValues.this)#DomainValue): Option[AnyRef]
Converts – if possible – a given
DomainValue
to a Java object that is appropriately initialized.Converts – if possible – a given
DomainValue
to a Java object that is appropriately initialized.Implementation
Every domain that supports the creation of a Java object's based on a domain value is expected to implement this method and to test if it can create a precise representation of the given value. If not, the implementation has to delegate the responsibility to the super method to creat an abstract representation.
abstract override def toJavaObject(value : DomainValue): Option[Object] = { if(value...) // create and return Java object else super.toJavaObject(value) }
- returns
Some(Object) is returned if it was possible to create a compatible corresponding Java object; otherwise
None
is returned. Default:None
unless thevalue
is null. In the latter caseSome(null)
is returned.
- Definition Classes
- TypeLevelReferenceValues → AsJavaObject
- Note
This operation is generally only possible if the domain value maintains enough state information to completely initialize the Java object.
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])
- object IsNull
- object IsPrecise
- object UpperTypeBound
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated