class DefaultDomainWithCFGAndDefUse[Source] extends DefaultDomainWithCFG[Source] with RefineDefUseUsingOrigins
Configuration of a domain that uses the most capable l1
domains and
which also records the abstract-interpretation time control flow graph and def/use
information.
- Source
- DefaultDomain.scala
- Alphabetic
- By Inheritance
- DefaultDomainWithCFGAndDefUse
- RefineDefUseUsingOrigins
- RecordDefUse
- DefaultDomainWithCFG
- RecordCFG
- DefaultDomain
- ConcretePrimitiveValuesConversions
- TypeLevelPrimitiveValuesConversions
- LongValuesShiftOperators
- DefaultLongValues
- LongValues
- ConcreteLongValues
- DefaultIntegerRangeValues
- IntegerRangeValues
- ConcreteIntegerValues
- IntegerRangeValuesFactory
- NullPropertyRefinement
- MaxArrayLengthRefinement
- DefaultArrayValuesBinding
- ArrayValues
- DefaultClassValuesBinding
- ClassValues
- DefaultStringValuesBinding
- StringValues
- PostEvaluationMemoryManagement
- DefaultJavaObjectToDomainValueConversion
- AsDomainValue
- DefaultReferenceValuesBinding
- DefaultExceptionsFactory
- ReferenceValues
- Origin
- DefaultTypeLevelReferenceValues
- TypeLevelReferenceValues
- AsJavaObject
- GeneralizedArrayHandling
- SpecialMethodsHandling
- TypeLevelDynamicLoads
- TypeLevelInvokeInstructions
- MethodCallsHandling
- TypeLevelFieldAccessInstructions
- DefaultTypeLevelDoubleValues
- TypeLevelDoubleValues
- DefaultTypeLevelFloatValues
- TypeLevelFloatValues
- DefaultTypeLevelHandlingOfMethodResults
- DefaultTypeLevelHandlingForReturnInstructions
- DefaultTypeLevelHandlingOfVoidReturns
- DefaultTypeLevelHandlingForThrownExceptions
- ReturnInstructionsDomain
- MonitorInstructionsTracker
- CustomInitialization
- IgnoreSynchronization
- ThrowAllPotentialExceptionsConfiguration
- DefaultSpecialDomainValuesBinding
- TheMethod
- TheCode
- TheProject
- LogContextProvider
- ThePropertyStore
- 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
- 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.
- class ANullValue extends (DefaultTypeLevelReferenceValues.this)#NullValueLike
- Attributes
- protected[this]
- Definition Classes
- DefaultTypeLevelReferenceValues
- trait AnArrayValue extends (DefaultTypeLevelReferenceValues.this)#ArrayValueLike with IsSArrayValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ArrayType]
- Attributes
- protected[this]
- Definition Classes
- DefaultTypeLevelReferenceValues
- trait AnObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValueLike
- Attributes
- protected
- Definition Classes
- DefaultTypeLevelReferenceValues
- trait MObjectValueLike extends (DefaultTypeLevelReferenceValues.this)#AnObjectValue with IsMObjectValue
- Attributes
- protected
- Definition Classes
- DefaultTypeLevelReferenceValues
- trait SObjectValueLike extends (DefaultTypeLevelReferenceValues.this)#AnObjectValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ObjectType] with IsSObjectValue
- Attributes
- protected
- Definition Classes
- DefaultTypeLevelReferenceValues
- trait DoubleValue extends (TypeLevelDoubleValues.this)#TypedValue[DoubleType] with IsDoubleValue
Abstracts over double values at the type level.
Abstracts over double values at the type level.
- Definition Classes
- TypeLevelDoubleValues
- trait FloatValue extends (TypeLevelFloatValues.this)#TypedValue[FloatType] with IsFloatValue
Abstracts over all values with computational type
float
.Abstracts over all values with computational type
float
.- Definition Classes
- TypeLevelFloatValues
- trait ArrayAbstraction extends AnyRef
- Definition Classes
- TypeLevelReferenceValues
- trait ArrayValueLike extends (TypeLevelReferenceValues.this)#ReferenceValueLike with IsSArrayValue
Represents an array value.
Represents an array value.
- Attributes
- protected[this]
- Definition Classes
- TypeLevelReferenceValues
- 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
- Definition Classes
- TypeLevelReferenceValues
- 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]
- Definition Classes
- TypeLevelReferenceValues
- 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.- Definition Classes
- TypeLevelReferenceValues
- 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]
- Definition Classes
- TypeLevelReferenceValues
- trait InitializedArrayValue extends (ArrayValues.this)#ArrayValue
Represents some (multi-dimensional) array where the (initialized) dimensions have the given size.
Represents some (multi-dimensional) array where the (initialized) dimensions have the given size.
- Definition Classes
- ArrayValues
- trait ClassValue extends (ClassValues.this)#SObjectValue with IsClassValue
All values (
Class<...> c
) that represent the same type (e.g.All values (
Class<...> c
) that represent the same type (e.g.java.lang.String
) are actually represented by the same class (object) value at runtime.- Attributes
- protected
- Definition Classes
- ClassValues
- case class DefaultClassValue(origin: ValueOrigin, value: Type, refId: (DefaultClassValuesBinding.this)#RefId) extends (DefaultClassValuesBinding.this)#ClassValue with Product with Serializable
- Attributes
- protected
- Definition Classes
- DefaultClassValuesBinding
- type AReferenceValue = TheReferenceValue
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues → TypeLevelReferenceValues
- 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
andArrayIndexOutOfBoundsException
.- 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
andArrayStoreException
.- Definition Classes
- ReferenceValuesDomain
- type DomainArrayValue = ArrayValue
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues → DefaultTypeLevelReferenceValues → TypeLevelReferenceValues
- type DomainClassValue = ClassValue
- Definition Classes
- DefaultClassValuesBinding → ClassValues
- final type DomainIllegalValue = IllegalValue
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
- DefaultSpecialDomainValuesBinding → ValuesDomain
- type DomainInitializedArrayValue = InitializedArrayValue
- Definition Classes
- DefaultArrayValuesBinding → ArrayValues
- type DomainMultipleReferenceValues = MultipleReferenceValues
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- type DomainNullValue = NullValue
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues → DefaultTypeLevelReferenceValues → TypeLevelReferenceValues
- type DomainObjectValue = ObjectValue
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues → DefaultTypeLevelReferenceValues → TypeLevelReferenceValues
- type DomainReferenceValue = TheReferenceValue
- Definition Classes
- DefaultReferenceValuesBinding → ValuesDomain
- final type DomainReturnAddressValue = ReturnAddressValue
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
- DefaultSpecialDomainValuesBinding → ValuesDomain
- final type DomainReturnAddressValues = ReturnAddressValues
- Definition Classes
- DefaultSpecialDomainValuesBinding → ValuesDomain
- type DomainSingleOriginReferenceValue = SingleOriginReferenceValue
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- type DomainStringValue = StringValue
- Definition Classes
- DefaultStringValuesBinding → StringValues
- final type DomainTypedValue[+T <: Type] = TypedValue[T]
- Definition Classes
- DefaultSpecialDomainValuesBinding → ValuesDomain
- final type DomainValue = 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
- DefaultSpecialDomainValuesBinding → 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
Iterable
s ofExceptionValue
s; used to facilitate comprehension.A type alias for
Iterable
s ofExceptionValue
s; 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
- type RefId = Int
Two domain values that have the same refid are guaranteed to refer to the same object at runtime (must-alias).
Two domain values that have the same refid are guaranteed to refer to the same object at runtime (must-alias).
The refid enables us to distinguish two values created/returned by the same instruction but at a different point in time (recall, both values have the same origin). Such values may or may not be different; i.e., those values may or may not refer to the same object on the heap/stack.
RefIds are required to determine changes in the memory layout. I.e., to determine if two values created by the same instruction are aliases or "just" maybe aliases. This information is particularly relevant if two values - stored in registers - are no longer guaranteed to be aliases!
- Definition Classes
- ReferenceValues
- type Refinements = IdentityHashMap[AReferenceValue, AReferenceValue]
A map that contains the refined values (the map's values) of some old values (the map's keys).
A map that contains the refined values (the map's values) of some old values (the map's keys).
- Definition Classes
- ReferenceValues
- class AnIntegerValue extends (DefaultIntegerRangeValues.this)#AnIntegerValueLike
Represents a specific but unknown Integer value.
Represents a specific but unknown Integer value.
- Definition Classes
- DefaultIntegerRangeValues
- Note
The functionality to propagate a constraint crucially depends on the fact that two integer values that are not guaranteed to represent the same runtime value are represented by two different instances of "AnIntegerValue"; otherwise, propagating the constraint that some value (after some kind of check) has to have a special value may affect unrelated values!
- class IntegerRange extends (DefaultIntegerRangeValues.this)#IntegerRangeLike
Represents a specific integer value in the range [
lowerBound
,upperBound
].Represents a specific integer value in the range [
lowerBound
,upperBound
].- Definition Classes
- DefaultIntegerRangeValues
- class ConcreteLongValue extends (DefaultLongValues.this)#TheLongValue
Represents a concrete long value.
Represents a concrete long value.
- Definition Classes
- DefaultLongValues
- case class DefaultMObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType], refId: (DefaultReferenceValuesBinding.this)#RefId) extends (DefaultReferenceValuesBinding.this)#MObjectValue with Product with Serializable
- Attributes
- protected
- Definition Classes
- DefaultReferenceValuesBinding
- case class DefaultSObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType, refId: (DefaultReferenceValuesBinding.this)#RefId) extends (DefaultReferenceValuesBinding.this)#SObjectValue with Product with Serializable
- Attributes
- protected
- Definition Classes
- DefaultReferenceValuesBinding
- case class DefaultStringValue(origin: ValueOrigin, value: String, refId: (DefaultStringValuesBinding.this)#RefId) extends (DefaultStringValuesBinding.this)#StringValue with Product with Serializable
- Attributes
- protected
- Definition Classes
- DefaultStringValuesBinding
- trait AnIntegerValueLike extends (IntegerRangeValues.this)#IntegerLikeValue
Represents an (unknown) integer value.
Represents an (unknown) integer value.
Models the top value of this domain's lattice.
- Definition Classes
- IntegerRangeValues
- sealed trait IntegerLikeValue extends (IntegerRangeValues.this)#TypedValue[CTIntType] with IsIntegerValue
Abstracts over all values with computational type
integer
.Abstracts over all values with computational type
integer
.- Definition Classes
- IntegerRangeValues
- abstract class IntegerRangeLike extends (IntegerRangeValues.this)#IntegerLikeValue
Represents a range of integer values.
Represents a range of integer values. The range's bounds are inclusive. Unless a range has only one value it is impossible to tell whether or not a value that is in the range will potentially occur at runtime.
- Definition Classes
- IntegerRangeValues
- trait ALongValue extends (LongValues.this)#LongValue
Represents an (unknown) long value.
Represents an (unknown) long value.
Models the top value of this domain's lattice.
- Definition Classes
- LongValues
- sealed trait LongValue extends (LongValues.this)#TypedValue[LongType] with IsLongValue
Abstracts over all values with computational type
long
.Abstracts over all values with computational type
long
.- Definition Classes
- LongValues
- trait TheLongValue extends (LongValues.this)#LongValue
Represents one concrete long value.
Represents one concrete long value.
- Definition Classes
- LongValues
- trait ArrayValue extends (ReferenceValues.this)#AnArrayValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue[ArrayType]
- Attributes
- protected
- Definition Classes
- ReferenceValues
- trait MObjectValue extends (ReferenceValues.this)#MObjectValueLike with (ReferenceValues.this)#ObjectValue
- Attributes
- protected
- Definition Classes
- ReferenceValues
- class MultipleReferenceValues extends IsMultipleReferenceValue with (ReferenceValues.this)#TheReferenceValue with MultipleOriginsValue
A
MultipleReferenceValues
tracks multiple reference values (of typeNullValue
,ArrayValue
,SObjectValue
andMObjectValue
) that have different origins.A
MultipleReferenceValues
tracks multiple reference values (of typeNullValue
,ArrayValue
,SObjectValue
andMObjectValue
) that have different origins. I.e., per value origin one domain value is used to abstract over the properties of that respective value.- Attributes
- protected
- Definition Classes
- ReferenceValues
- trait NonNullSingleOriginReferenceValue extends (ReferenceValues.this)#SingleOriginReferenceValue
- Definition Classes
- ReferenceValues
- trait NonNullSingleOriginSReferenceValue[T <: ReferenceType] extends (ReferenceValues.this)#NonNullSingleOriginReferenceValue
- Definition Classes
- ReferenceValues
- class NullValue extends (ReferenceValues.this)#ANullValue with (ReferenceValues.this)#SingleOriginReferenceValue
- Attributes
- protected
- Definition Classes
- ReferenceValues
- trait ObjectValue extends (ReferenceValues.this)#AnObjectValue with (ReferenceValues.this)#NonNullSingleOriginReferenceValue
- Definition Classes
- ReferenceValues
- trait SObjectValue extends (ReferenceValues.this)#SObjectValueLike with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue[ObjectType] with (ReferenceValues.this)#ObjectValue
- Attributes
- protected
- Definition Classes
- ReferenceValues
- trait SingleOriginReferenceValue extends (ReferenceValues.this)#TheReferenceValue with SingleOriginValue with UID
Represents all
DomainReferenceValue
s that represent a reference value where – in the current analysis context – the value has a single origin.Represents all
DomainReferenceValue
s that represent a reference value where – in the current analysis context – the value has a single origin.- Definition Classes
- ReferenceValues
- Note
To make it possible to store
SingleOriginReferenceValue
s in UIDSets - which in particular provide fastfilter
andtail
methods compared to the standard sets - the UID trait is implemented.
- trait TheReferenceValue extends (ReferenceValues.this)#ReferenceValueLike
Representation of some reference value; this includes
Object
,Array
andNull
values.Representation of some reference value; this includes
Object
,Array
andNull
values.This trait defines the additional methods needed for the refinement of the new properties.
- Definition Classes
- ReferenceValues
- trait StringValue extends (StringValues.this)#SObjectValue with IsStringValue
- Attributes
- protected
- Definition Classes
- StringValues
Value Members
- object ConcreteIntegerValue
- Definition Classes
- ConcreteIntegerValues
- object ConcreteLongValue
- Definition Classes
- ConcreteLongValues
- implicit object SingleOriginValueOrdering extends Ordering[SingleOriginValue]
- Definition Classes
- Origin
- case object ADoubleValue extends (DefaultTypeLevelDoubleValues.this)#DoubleValue with Product with Serializable
Represents an unknown double value.
Represents an unknown double value.
- Definition Classes
- DefaultTypeLevelDoubleValues
- case object AFloatValue extends (DefaultTypeLevelFloatValues.this)#FloatValue with Product with Serializable
- Definition Classes
- DefaultTypeLevelFloatValues
- object AnArrayValue
Enables matching of
DomainValue
s that are array values.Enables matching of
DomainValue
s that are array values.- Definition Classes
- DefaultTypeLevelReferenceValues
- object MObjectValueLike
- Definition Classes
- DefaultTypeLevelReferenceValues
- object SObjectValueLike
- Definition Classes
- DefaultTypeLevelReferenceValues
- object IsNull
- Definition Classes
- TypeLevelReferenceValues
- object IsPrecise
- Definition Classes
- TypeLevelReferenceValues
- object UpperTypeBound
- Definition Classes
- TypeLevelReferenceValues
- object ClassValue
- Definition Classes
- ClassValues
- 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 val AReferenceValueTag: ClassTag[AReferenceValue]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- def AnIntegerValue(): AnIntegerValue
Factory method to create a new instance of AnIntegerValue.
Factory method to create a new instance of AnIntegerValue.
- Definition Classes
- DefaultIntegerRangeValues
- final def ArithmeticException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- final def ArrayIndexOutOfBoundsException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- final def ArrayStoreException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- def ArrayValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ArrayType, t: RefId): DomainArrayValue
- Attributes
- protected[domain]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- def ArrayValue(pc: Int, arrayType: ArrayType): 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
- Definition Classes
- ReferenceValues → TypeLevelReferenceValues
- Note
Java's arrays are co-variant. I.e.,
Object[] a = new Serializable[100];
is valid.
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- final def ClassCastException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- final def ClassNotFoundException(origin: ValueOrigin): ExceptionValue
- Definition Classes
- DefaultExceptionsFactory → ExceptionsFactory
- def ClassValue(origin: ValueOrigin, value: Type, refId: RefId): DomainClassValue
- Definition Classes
- DefaultClassValuesBinding
- def ClassValue(origin: ValueOrigin, value: Type): DomainClassValue
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
- DefaultClassValuesBinding → ClassValues → ReferenceValues → TypeLevelReferenceValues → ReferenceValuesFactory
- 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., forIntegerValue
s the value is set to0
. In case of aReferenceType
the value is the ReferenceValuesFactory#NullValue.- Definition Classes
- TypedValuesFactory
- final val DomainArrayValueTag: ClassTag[DomainArrayValue]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- val DomainClassValueTag: ClassTag[DomainClassValue]
- Definition Classes
- DefaultClassValuesBinding → ClassValues
- final val DomainInitializedArrayValueTag: ClassTag[DomainInitializedArrayValue]
- Definition Classes
- DefaultArrayValuesBinding → ArrayValues
- final val DomainMultipleReferenceValuesTag: ClassTag[DomainMultipleReferenceValues]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- final val DomainNullValueTag: ClassTag[DomainNullValue]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- final val DomainObjectValueTag: ClassTag[DomainObjectValue]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- final 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
- DefaultReferenceValuesBinding → ValuesDomain
- final val DomainSingleOriginReferenceValueTag: ClassTag[DomainSingleOriginReferenceValue]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- final val DomainStringValueTag: ClassTag[DomainStringValue]
- Definition Classes
- DefaultStringValuesBinding → StringValues
- final 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 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
- DefaultSpecialDomainValuesBinding → ValuesDomain
- final def DoubleValue(valueOrigin: Int, value: Double): DoubleValue
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
- DefaultTypeLevelDoubleValues → DoubleValuesFactory
- final def DoubleValue(valueOrigin: Int): DoubleValue
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
- DefaultTypeLevelDoubleValues → DoubleValuesFactory
- def FloatValue(valueOrigin: Int, value: Float): FloatValue
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
- DefaultTypeLevelFloatValues → FloatValuesFactory
- def FloatValue(valueOrigin: Int): FloatValue
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
- DefaultTypeLevelFloatValues → FloatValuesFactory
- final def IllegalMonitorStateException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- def InitializedArrayValue(origin: ValueOrigin, arrayType: ArrayType, counts: Int, refId: RefId): DomainInitializedArrayValue
- Definition Classes
- DefaultArrayValuesBinding → ArrayValues
- final def InitializedArrayValue(origin: ValueOrigin, theType: ArrayType, length: Int): DomainArrayValue
- Definition Classes
- ArrayValues
- 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
- ReferenceValues → 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): 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
- ReferenceValues → TypeLevelReferenceValues → ReferenceValuesFactory
- 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 IntegerRange(lb: Int, ub: Int): IntegerRange
Creates a new IntegerRange value with the given bounds.
Creates a new IntegerRange value with the given bounds.
- Definition Classes
- DefaultIntegerRangeValues → IntegerRangeValues
- Annotations
- @inline()
- final def IntegerRange(origin: ValueOrigin, lowerBound: Int, upperBound: Int): DomainTypedValue[CTIntType]
Creates a new IntegerRange value with the given bounds.
Creates a new IntegerRange value with the given bounds.
- Definition Classes
- IntegerRangeValues → IntegerRangeValuesFactory
- def IntegerRange(value: Int): DomainTypedValue[CTIntType]
Creates a new IntegerRange value with the lower and upper bound set to the given value.
Creates a new IntegerRange value with the lower and upper bound set to the given value.
- Definition Classes
- IntegerRangeValues
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- def LongValue(origin: ValueOrigin, value: Long): ConcreteLongValue
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
- DefaultLongValues → LongValuesFactory
- def LongValue(origin: ValueOrigin): ALongValue.type
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
- DefaultLongValues → LongValuesFactory
- final val 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
- DefaultSpecialDomainValuesBinding → ValuesDomain
- def MethodCallResult(potentialExceptions: Iterable[ExceptionValue]): MethodCallResult
Factory method called to create a MethodCallResult.
Factory method called to create a MethodCallResult.
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- def MethodCallResult(returnValue: DomainValue, exceptions: Iterable[ExceptionValue]): MethodCallResult
Factory method called to create a MethodCallResult.
Factory method called to create a MethodCallResult.
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- 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
- def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue], origins: ValueOrigins, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: UIDSet[_ <: ReferenceType], refId: RefId): DomainMultipleReferenceValues
- Attributes
- protected[domain]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue]): DomainMultipleReferenceValues
- Attributes
- protected[domain]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- final def NegativeArraySizeException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- def NewArray(pc: Int, lengths: Operands, arrayType: ArrayType): DomainArrayValue
The lengths per dimension are found in the following order:
..., count1, [count2, ...] ->
The lengths per dimension are found in the following order:
..., count1, [count2, ...] ->
- Definition Classes
- ArrayValues → ReferenceValues → TypeLevelReferenceValues
- def NewArray(pc: Int, length: DomainValue, arrayType: ArrayType): 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)
- Definition Classes
- ArrayValues → ReferenceValues → TypeLevelReferenceValues
- def NewObject(origin: ValueOrigin, objectType: ObjectType): 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
- StringValues → ReferenceValues → 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): 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
- ReferenceValues → TypeLevelReferenceValues → ReferenceValuesFactory
- final def NullPointerException(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- def NullValue(origin: ValueOrigin): 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
- DefaultReferenceValuesBinding → TypeLevelReferenceValues → ReferenceValuesFactory
- def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType], refId: RefId): DomainObjectValue
- Attributes
- protected[domain]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType, refId: RefId): SObjectValue
- Attributes
- protected[domain]
- Definition Classes
- DefaultReferenceValuesBinding → ReferenceValues
- def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType): DomainObjectValue
- Attributes
- protected[domain]
- Definition Classes
- ReferenceValues
- def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType]): DomainObjectValue
- Attributes
- protected[domain]
- Definition Classes
- ReferenceValues
- def ObjectValue(pc: Int, upperTypeBound: UIDSet[ObjectType]): 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
- Definition Classes
- ReferenceValues → TypeLevelReferenceValues
- def ObjectValue(pc: Int, objectType: ObjectType): 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
- Definition Classes
- ReferenceValues → TypeLevelReferenceValues
- Initialized: Unknown
(I.e., it is not guaranteed that the constructor was called; unless
- final def RefIdUpdate[T](value: T): MetaInformationUpdate[T]
Creates an update object that characterizes a reference id update.
Creates an update object that characterizes a reference id update.
Basically, just a wrapper for a
MetaInformationUpdate
; the purpose is to better communicate the underlying purpose.- Definition Classes
- ReferenceValues
- Annotations
- @inline()
- final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, upperTypeBound: UIDSet[_ <: ReferenceType], refId: RefId): DomainSingleOriginReferenceValue
- Attributes
- protected[domain]
- Definition Classes
- ReferenceValues
- final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType): DomainSingleOriginReferenceValue
- Attributes
- protected[domain]
- Definition Classes
- ReferenceValues
- def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType, refId: RefId): DomainSingleOriginReferenceValue
- Attributes
- protected[domain]
- Definition Classes
- ReferenceValues
- final def ReferenceValue(pc: Int, upperTypeBound: ReferenceType): 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
- final def ReturnAddressValue(address: Int): ReturnAddressValue
Factory method to create an instance of a
ReturnAddressValue
.Factory method to create an instance of a
ReturnAddressValue
.- Definition Classes
- DefaultSpecialDomainValuesBinding → ValuesDomain
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- 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
- DefaultIntegerRangeValues → IntegerValuesFactory
- def StringValue(origin: ValueOrigin, value: String, refId: RefId): DomainStringValue
- Definition Classes
- DefaultStringValuesBinding → StringValues
- final def StringValue(origin: ValueOrigin, value: String): 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
- StringValues → ReferenceValues → 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.
- final val TheIllegalValue: DomainIllegalValue
The singleton instance of the
IllegalValue
.The singleton instance of the
IllegalValue
.- Definition Classes
- DefaultSpecialDomainValuesBinding → ValuesDomain
- final val TheReturnAddressValues: ReturnAddressValues
The singleton instance of
ReturnAddressValues
The singleton instance of
ReturnAddressValues
- Definition Classes
- DefaultSpecialDomainValuesBinding → ValuesDomain
- final def Throwable(origin: ValueOrigin): 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
- DefaultExceptionsFactory → ExceptionsFactory
- 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 isnull
, 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
- def UninitializedThis(objectType: ObjectType): 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
- ReferenceValues → TypeLevelReferenceValues → ReferenceValuesFactory
- Note
Instances of arrays are never uninitialized.
- 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
- final def ValueOrigins(vo: Int): ValueOrigins
- Definition Classes
- RecordDefUse
- Annotations
- @inline()
- def aaload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def aastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def abnormalExitPCs: IntTrieSet
Returns the PCs of all instructions whose execution may have led to an exception.
Returns the PCs of all instructions whose execution may have led to an exception. This can, e.g., be instance field read/field write statements or method invocations, but _in very rare cases_ also return instructions.
- Definition Classes
- RecordCFG
- 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.- returns
false
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- 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.- returns
false
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def abruptMethodExecution(pc: Int, exceptionValue: 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
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def abstractInterpretationEnded(aiResult: AIResult { val domain: DefaultDomainWithCFGAndDefUse.this.type }): Unit
Completes the computation of the definition/use information by using the recorded cfg.
Completes the computation of the definition/use information by using the recorded cfg.
- Definition Classes
- RecordDefUse → RecordCFG → 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 totargetPC
, 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 totargetPC
, 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
- NullPropertyRefinement → CoreDomainFunctionality
- Note
During the evaluation of the instruction it is possible that this method is called multiple times with different
targetPC
s. 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 thesuper
method (stackable traits
).
- final def allExecuted: BitSet
Computes the set of all executed instructions.
Computes the set of all executed instructions.
- Definition Classes
- RecordCFG
- def allExitPCs: IntTrieSet
Returns all PCs that may lead to the (ab)normal termination of the method.
Returns all PCs that may lead to the (ab)normal termination of the method. I.e., those instructions (in particular method call instructions, but potentially also array access instructions and (I]L)DIV|MOD instructions etc.) that may throw some unhandled exceptions will also be returned; even if the instruction may also have regular and also exception handlers!
- Definition Classes
- RecordCFG
- def allReachable(pcs: IntTrieSet): IntTrieSet
Computes the transitive hull of all instructions reachable from the given set of instructions.
Computes the transitive hull of all instructions reachable from the given set of instructions.
- Definition Classes
- RecordCFG
- def allReachable(pc: Int): IntTrieSet
Computes the transitive hull of all instructions reachable from the given instruction.
Computes the transitive hull of all instructions reachable from the given instruction.
- Definition Classes
- RecordCFG
- def allSuccessorsOf(pc: Int): PCs
Returns the set of all instructions executed after the instruction with the given
pc
.Returns the set of all instructions executed after the instruction with the given
pc
. If this set is empty, either the instruction belongs to dead code, the instruction is areturn
instruction or theinstruction
throws an exception that is never handled internally.- Definition Classes
- RecordCFG
- Note
The set is recalculated on demand.
- 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 givenpc
.The given
value
, which is a value with computational type reference, is returned by the return instruction with the givenpc
.- Definition Classes
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def arraylength(pc: Int, arrayref: DomainValue): Computation[DomainValue, 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
- MaxArrayLengthRefinement → 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: DomainValue, arrayref: DomainValue): 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: DomainValue, index: DomainValue, arrayref: DomainValue): 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: DomainValue): ArrayAbstraction
- Definition Classes
- TypeLevelReferenceValues
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asObjectValue(value: DomainValue): DomainObjectValue
- Definition Classes
- TypeLevelReferenceValues
- def asReferenceValue(value: DomainValue): 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.)
- Definition Classes
- TypeLevelReferenceValues
- def baload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def bastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def bbCFG: CFG[Instruction, Code]
- Definition Classes
- RecordCFG
- 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 caload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def castore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def cfgAsGraph(): DefaultMutableNode[List[Int]]
Creates a graph representation of the CFG.
Creates a graph representation of the CFG.
- Definition Classes
- RecordCFG
- Note
The returned graph is recomputed whenever this method is called.
,This implementation is for debugging purposes only. It is NOT performance optimized!
- final def classFile: ClassFile
- Definition Classes
- TheMethod
- Annotations
- @inline()
- implicit final def classHierarchy: ClassHierarchy
Returns the project's class hierarchy.
Returns the project's class hierarchy.
- Definition Classes
- TheProject
- Annotations
- @inline()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final val code: Code
Returns the code block that is currently analyzed.
- def createDefUseGraph(code: Code): Set[DefaultMutableNode[ValueOrigin]]
Creates a multi-graph that represents the method's def-use information.
Creates a multi-graph that represents the method's def-use information. I.e., in which way a certain value is used by other instructions and where the derived values are then used by further instructions. (Basically, we compute the data-dependence graph.)
- Definition Classes
- RecordDefUse
- def d2f(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelPrimitiveValuesConversions → PrimitiveValuesConversionsDomain
- def d2i(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelPrimitiveValuesConversions → PrimitiveValuesConversionsDomain
- def d2l(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelPrimitiveValuesConversions → PrimitiveValuesConversionsDomain
- def dadd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def daload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def dastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def dcmpg(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def dcmpl(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def ddiv(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def dmul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def dneg(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def doGetfield(pc: Int, objectref: DomainValue, fieldValue: DomainValue): Computation[DomainValue, ExceptionValue]
- Definition Classes
- TypeLevelFieldAccessInstructions
- def doGetstatic(pc: Int, fieldValue: DomainValue): Computation[DomainValue, Nothing]
- Definition Classes
- TypeLevelFieldAccessInstructions
- def doLoadDynamic(pc: Int, constantValue: DomainValue): Computation[DomainValue, Nothing]
- Definition Classes
- TypeLevelDynamicLoads
- def dominatorTree: DominatorTree
Returns the dominator tree; see org.opalj.graphs.DominatorTree$.apply[D<:org\.opalj\.graphs\.AbstractDominatorTree]* for details regarding the properties of the dominator tree.
Returns the dominator tree; see org.opalj.graphs.DominatorTree$.apply[D<:org\.opalj\.graphs\.AbstractDominatorTree]* for details regarding the properties of the dominator tree.
- Definition Classes
- RecordCFG
- Note
To get the list of all evaluated instructions and their dominators.
val result = AI(...,...,...) val evaluated = result.evaluatedInstructions
- def drem(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- 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 givenpc
.The given
value
, which is a value with computational type double, is returned by the return instruction with the givenpc
.- Definition Classes
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def dsub(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelDoubleValues → DoubleValuesDomain
- def dumpDefUseInfo(): Node
Creates an XHTML document that contains information about the def-/use information.
Creates an XHTML document that contains information about the def-/use information.
- Definition Classes
- RecordDefUse
- def dumpDefUseTable(): Node
Creates an XHTML table node which contains the def/use information.
Creates an XHTML table node which contains the def/use information.
- Definition Classes
- RecordDefUse
- def effectiveUTB(utb: UIDSet[_ <: ReferenceType]): UIDSet[_ <: ReferenceType]
Computes the effective upper-type bound which is the (single) final type in the utb if it contains one.
Computes the effective upper-type bound which is the (single) final type in the utb if it contains one. In this case the other types have to be in a super-/subtype relation and were added "just" as a result of explicit CHECKCAST instructions.
- Attributes
- protected
- Definition Classes
- ReferenceValues
- Note
This method is generally only useful when we have to handle incomplete type hierarchies.
- 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 exceptionHandlerSuccessorsOf(pc: Int): PCs
Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may raise an exception.
Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may raise an exception.
The returned set is always empty for instructions that cannot raise exceptions, such as the
StackManagementInstruction
s.- Definition Classes
- RecordCFG
- Note
The org.opalj.br.instructions.ATHROW has successors if and only if the thrown exception is directly handled inside this code block.
,The successor instructions are necessarily the handlers of catch blocks.
- def f2d(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelPrimitiveValuesConversions → PrimitiveValuesConversionsDomain
- def f2i(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelPrimitiveValuesConversions → PrimitiveValuesConversionsDomain
- def f2l(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelPrimitiveValuesConversions → PrimitiveValuesConversionsDomain
- def fadd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- def faload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def fastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def fcmpg(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- def fcmpl(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- def fdiv(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- 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 instructionsuccessorPC
. (Hence, this method is ONLY called forreturn
instructions if the return instruction throws anIllegalMonitorStateException
.) 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 withcurrentPC
. 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
andload
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 containssuccessorPC
,No
if the worklist does not containsuccessorPC
.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 schedulessuccessorPC
the the super call has to setisSuccessorScheduled
toYes
.- isExceptionalControlFlow
true
if and only if the evaluation of the instruction with the program countercurrentPC
threw an exception;false
otherwise. Hence, if this parameter istrue
the instruction withsuccessorPC
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 containssuccessorPC
and – if not – to prepend it. If the worklist already containssuccessorPC
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 theoperandsArray
of the subroutine that will execute the instruction withsuccessorPC
. The operandsArray may benull
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 thelocalsArray
of the subroutine that will execute the instruction withsuccessorPC
. The localsArray may benull
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 givenworklist
.
- Definition Classes
- RecordCFG → CoreDomainFunctionality
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def fmul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- def fneg(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- def foreachOrigin(value: DomainValue, f: (ValueOrigin) => Unit): Unit
Iterates over the origin(s) of the given value if the information is available.
Iterates over the origin(s) of the given value if the information is available.
- Definition Classes
- Origin
- final def foreachPredecessorOf(pc: Int)(f: (PC) => Unit): Unit
- Definition Classes
- RecordCFG
- def foreachSuccessorOf(pc: Int)(f: (PC) => Unit): Unit
- Definition Classes
- RecordCFG
- def frem(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- 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 givenpc
.The given
value
, which is a value with computational type float, is returned by the return instruction with the givenpc
.- Definition Classes
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def fsub(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- TypeLevelFloatValues → FloatValuesDomain
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getPotentialExceptions(pc: Int): List[ExceptionValue]
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- def getfield(pc: Int, objectref: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[DomainValue, ExceptionValue]
Returns the field's value and/or a new
NullPointerException
if the givenobjectref
represents the valuenull
.Returns the field's value and/or a new
NullPointerException
if the givenobjectref
represents the valuenull
.- returns
The field's value or a new
NullPointerException
.
- Definition Classes
- TypeLevelFieldAccessInstructions → 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
- ClassValues → FieldAccessesDomain
- def handleInstanceBasedInvoke(pc: Int, methodDescriptor: MethodDescriptor, targetMethods: Set[Method], receiverIsNull: Answer, operands: Operands): MethodCallResult
- methodDescriptor
The method descriptor as specified by the invoke instruction. In case of the invocation of a signature polymorphic method using org.opalj.br.instructions.INVOKEVIRTUAL the descriptor of the invoked method may differ from the descriptor used by the method. Nevertheless, the MethodCallResult has to satisfy the requirements of the caller. In particular regarding the return type.
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- def handleInstanceBasedInvoke(pc: Int, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- def handleInstanceBasedInvoke(pc: Int, methodDescriptor: MethodDescriptor, receiverIsNull: Answer): MethodCallResult
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- def handleInvoke(pc: Int, methodDescriptor: MethodDescriptor): MethodCallResult
- Attributes
- protected[this]
- Definition Classes
- MethodCallsHandling
- def handleReturn(pc: Int): Computation[Nothing, ExceptionValue]
Creates a computation object that encapsulates the result of a computation that may throw an
IllegalMonitorStateException
if a monitor is (potentially) used.Creates a computation object that encapsulates the result of a computation that may throw an
IllegalMonitorStateException
if a monitor is (potentially) used. The primary example are the(XXX)return
instructions.- pc
The program counter of a return instruction.
- Attributes
- protected[this]
- Definition Classes
- ReturnInstructionsDomain
- final def handlesException(exceptionHandler: ExceptionHandler): Boolean
Returns
true
if the exception handler may handle at least one exception thrown by an instruction in its try block.Returns
true
if the exception handler may handle at least one exception thrown by an instruction in its try block.- Definition Classes
- RecordCFG
- final def hasMultiplePredecessors(pc: Int): Boolean
Returns
true
if the instruction with the given pc has multiple direct predecessors (more than one).Returns
true
if the instruction with the given pc has multiple direct predecessors (more than one).- Definition Classes
- RecordCFG
- final def hasMultipleSuccessors(pc: Int): Boolean
- Definition Classes
- RecordCFG
- def hasNoSuccessor(pc: Int): Boolean
- Definition Classes
- RecordCFG
- def hasSuccessor(pc: Int, regularSuccessorsOnly: Boolean, p: (Int) => Boolean): Boolean
Tests if the instruction with the given
pc
has a successor instruction with apc'
that satisfies the given predicatep
.Tests if the instruction with the given
pc
has a successor instruction with apc'
that satisfies the given predicatep
.- Definition Classes
- RecordCFG
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def i2b(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def i2c(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def i2d(pc: Int, value: DomainValue): DomainValue
- def i2f(pc: Int, value: DomainValue): DomainValue
- def i2l(pc: Int, value: DomainValue): DomainValue
- def i2s(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def iadd(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def iaload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def iand(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def iastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def idiv(pc: Int, numerator: DomainValue, denominator: DomainValue): IntegerValueOrArithmeticException
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def iinc(pc: Int, value: DomainValue, increment: Int): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def imul(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def ineg(pc: Int, value: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def infiniteLoopHeaders: IntTrieSet
Returns the first instructions of the infinite loops of the current method.
Returns the first instructions of the infinite loops of the current method. An infinite loop is a set of instructions that does not have a connection to any instruction outside of the loop (closed strongly connected component). I.e., whatever path is taken, all remaining paths will eventually include the loop header instruction. The very vast majority of methods does not have infinite loops.
- Definition Classes
- RecordCFG
- def initProperties(code: Code, cfJoins: IntTrieSet, locals: Locals): Unit
Override this method to perform custom initialization steps.
Override this method to perform custom initialization steps.
Always use
abstract override
and call the super method; it is recommended to complete the initialization of this domain before calling the super method.- Definition Classes
- RecordDefUse → RecordCFG → CustomInitialization
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- 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
- IntegerRangeValues → IntegerValuesDomain
- 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
- IntegerRangeValues → 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
- IntegerRangeValues → 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, left: DomainValue, right: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
- Definition Classes
- IntegerRangeValues → 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, left: DomainValue, right: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
- Definition Classes
- IntegerRangeValues → 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
- IntegerRangeValues → 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 intIsLessThan(pc: Int, left: DomainValue, right: 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.
- Definition Classes
- IntegerRangeValues → 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 intIsLessThanOrEqualTo(pc: Int, left: DomainValue, right: 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.
- Definition Classes
- IntegerRangeValues → 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 intIsSomeValueInRange(pc: Int, value: DomainValue, lowerBound: Int, upperBound: Int): Answer
Returns
Yes
iff at least one possible extension of the givenvalue
is in the specified range; that is, if the intersection of the range of values captured by the givenvalue
and the specified range is non-empty.Returns
Yes
iff at least one possible extension of the givenvalue
is in the specified range; that is, if the intersection of the range of values captured by the givenvalue
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 beUnknown
. The answer isNo
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
- IntegerRangeValues → IntegerValuesDomain
- 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 givenvalue
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 givenvalue
and the specified range is non-empty. For example, if the givenvalue
has the integer value10
and the specified range is [0,Integer.MAX_VALUE] then the answer has to beNo
. But, if the givenvalue
represents the range [-5,Integer.MAX_VALUE] and the specified range is again [0,Integer.MAX_VALUE] then the answer has to beYes
.The answer is
Yes
iff the analysis determined that at runtimevalue
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 beUnknown
.- 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
- IntegerRangeValues → IntegerValuesDomain
- final def intValue[T](value: DomainValue)(f: (Int) => T)(orElse: => T): T
If the given value encapsulates a precise integer value then the function
ifThen
is called with the respective value otherwiseorElse
is called.If the given value encapsulates a precise integer value then the function
ifThen
is called with the respective value otherwiseorElse
is called.- Definition Classes
- IntegerRangeValues → ConcreteIntegerValues
- Annotations
- @inline()
- final def intValueOption(value: DomainValue): Option[Int]
Returns the current
Int
value represented by the domain value if it exists.Returns the current
Int
value represented by the domain value if it exists.- Definition Classes
- IntegerRangeValues → ConcreteIntegerValues
- Annotations
- @inline()
- Note
This method returns
None
if the DomainValue does not represent an Integer value or the precise value is not known. I.e., this method never fails.
- final def intValues[T](value1: DomainValue, value2: DomainValue)(f: (Int, Int) => T)(orElse: => T): T
- Attributes
- protected
- Definition Classes
- IntegerRangeValues
- Annotations
- @inline()
- def invokedynamic(pc: Int, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
- Definition Classes
- TypeLevelInvokeInstructions → MethodCallsDomain
- def invokeinterface(pc: Int, declaringClass: ObjectType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
- Definition Classes
- TypeLevelInvokeInstructions → MethodCallsDomain
- def invokespecial(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
- Definition Classes
- StringValues → MethodCallsDomain
- def invokestatic(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
- Definition Classes
- ClassValues → MethodCallsDomain
- def invokevirtual(pc: Int, declaringClass: ReferenceType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult
- Definition Classes
- TypeLevelInvokeInstructions → MethodCallsDomain
- def ior(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def irem(pc: Int, left: DomainValue, right: DomainValue): IntegerValueOrArithmeticException
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- 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 givenpc
.The given
value
, which is a value with computational type integer, is returned by the return instruction with the givenpc
.- Definition Classes
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- 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
- def isDirectRegularPredecessorOf(pc: Int, successorPC: Int): Boolean
- Definition Classes
- RecordCFG
- def isExitPC(pc: PC): Boolean
- Definition Classes
- RecordCFG
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isMonitorInstructionUsed: Boolean
- Definition Classes
- MonitorInstructionsTracker
- def isNull(values: Iterable[AReferenceValue]): Answer
Determines the common null-ness property of the given reference values.
Determines the common null-ness property of the given reference values.
- Attributes
- protected
- Definition Classes
- ReferenceValues
- def isPrecise(values: Iterable[AReferenceValue]): Boolean
Determines if the runtime object type referred to by the given
values
is always the same.Determines if the runtime object type referred to by the given
values
is always the same. I.e., it determines if all values are precise and have the sameupperTypeBound
.Null
values are ignored when determining the precision; i.e., if all values representNull
true
will be returned.- Attributes
- protected
- Definition Classes
- ReferenceValues
- def isRegularPredecessorOf(pc: Int, successorPC: Int): Boolean
Tests if the instruction with the given pc is a direct or indirect predecessor of the given successor instruction.
Tests if the instruction with the given pc is a direct or indirect predecessor of the given successor instruction.
If
pc
equalssuccessorPC
true
is returned.- Definition Classes
- RecordCFG
- Note
This method will traverse the entire graph if
successorPC
is not a regular predecessor ofpc
. Hence, consider using the(Post)DominatorTree
.
- 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: 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
.
- def ishl(pc: Int, value: DomainValue, shift: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def ishr(pc: Int, value: DomainValue, shift: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def isub(pc: Int, left: DomainValue, right: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def iushr(pc: Int, value: DomainValue, shift: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- def ixor(pc: Int, value1: DomainValue, value2: DomainValue): DomainValue
- Definition Classes
- IntegerRangeValues → IntegerValuesDomain
- 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 jumpBackTargetPCs: IntTrieSet
The set of instructions to which a jump back is performed.
The set of instructions to which a jump back is performed.
- Definition Classes
- RecordCFG
- def jumpToSubroutine(pc: Int, branchTargetPC: Int, returnTargetPC: Int): Unit
- pc
The pc of the jsr(w) instruction.
- Definition Classes
- RecordCFG → SubroutinesDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- final def justThrows(value: ExceptionValue): ThrowsException[ExceptionValues]
- Definition Classes
- ReferenceValuesFactory
- def justThrowsException(pc: Int): Boolean
Returns
true
if the execution of the given instruction – identified by its pc – always just throws an exception that is (potentially) handled by the method.Returns
true
if the execution of the given instruction – identified by its pc – always just throws an exception that is (potentially) handled by the method.- Definition Classes
- RecordCFG
- 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.
- returns
The result of calling
DoubleValue(pc)
.
- 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.
- returns
The result of calling
FloatValue(pc)
.
- 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.
- returns
The result of calling
IntegerValue(pc)
.
- 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
- LongValues → LongValuesDomain
- def laload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- 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
- LongValues → LongValuesDomain
- def lastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def lcmp(pc: Int, left: DomainValue, right: DomainValue): DomainValue
Comparison (==) of two long values.
Comparison (==) of two long values.
- pc
The pc of the comparison instruction.
- returns
A domain value that encapsulates an integer value with the value -1,0 or 1.
- Definition Classes
- LongValues → LongValuesDomain
- def ldiv(pc: Int, numerator: DomainValue, denominator: DomainValue): LongValueOrArithmeticException
Division of two long values.
Division of two long values.
- pc
The pc of the div (/) instruction.
- returns
The return value is the calculated value and/or (depending on the domain) an
ArithmeticException
ifvalue2
is0
.
- Definition Classes
- LongValues → LongValuesDomain
- 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
- LongValues → LongValuesDomain
- 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
- LongValues → LongValuesDomain
- 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
- ClassValues → DynamicLoadsDomain
- def localOrigin(pc: PC, registerIndex: Int): ValueOrigins
Returns the instruction(s) which define(s) the value found in the register variable with index
registerIndex
and the program counterpc
.Returns the instruction(s) which define(s) the value found in the register variable with index
registerIndex
and the program counterpc
.- Definition Classes
- RecordDefUse
- implicit final def logContext: LogContext
- Definition Classes
- TheProject → LogContextProvider
- final def longValue[T](value: DomainValue)(ifThen: (Long) => T)(orElse: => T): T
If the given value represents one specific long value then the function
ifThen
is called with the respective value otherwiseorElse
is called.If the given value represents one specific long value then the function
ifThen
is called with the respective value otherwiseorElse
is called.- Definition Classes
- LongValues → ConcreteLongValues
- Annotations
- @inline()
- final def longValueOption(value: DomainValue): Option[Long]
Returns the current
Long
value represented by the domain value if it exists.Returns the current
Long
value represented by the domain value if it exists.- Definition Classes
- LongValues → ConcreteLongValues
- Annotations
- @inline()
- Note
This method returns
None
if the DomainValue does not represent a Long value or the precise value is not known. I.e., this method never fails.
- final def longValues[T](value1: DomainValue, value2: DomainValue)(ifThen: (Long, Long) => T)(orElse: => T): T
- Attributes
- protected
- Definition Classes
- LongValues
- Annotations
- @inline()
- 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
- LongValues → LongValuesDomain
- def lrem(pc: Int, left: DomainValue, right: DomainValue): LongValueOrArithmeticException
Remainder of two long values.
Remainder of two long values.
- pc
The pc of the div (/) instruction.
- returns
The return value is the calculated value and/or (depending on the domain) an
ArithmeticException
ifvalue2
is0
.
- Definition Classes
- LongValues → LongValuesDomain
- 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 givenpc
.The given
value
, which is a value with computational type long, is returned by the return instruction with the givenpc
.- Definition Classes
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def lshl(pc: Int, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]
Shift left of a long value.
Shift left of a long value.
- pc
The pc of the "shift left" instruction.
- Definition Classes
- LongValuesShiftOperators → LongValuesDomain
- def lshr(pc: Int, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]
Shift right of a long value.
Shift right of a long value.
- pc
The pc of the "shift right" instruction.
- Definition Classes
- LongValuesShiftOperators → LongValuesDomain
- def lsub(pc: Int, left: DomainValue, right: DomainValue): DomainValue
Subtraction of two long values.
Subtraction of two long values.
- pc
The pc of the sub(-) instruction.
- Definition Classes
- LongValues → LongValuesDomain
- def lushr(pc: Int, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]
Unsigned shift right of a long value.
Unsigned shift right of a long value.
- pc
The pc of the "unsigned shift right" instruction.
- Definition Classes
- LongValuesShiftOperators → LongValuesDomain
- 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
- LongValues → LongValuesDomain
- def maxCardinalityOfIntegerRanges: Long
Determines the maximum number of values captured by an integer value range.
Determines the maximum number of values captured by an integer value range.
This setting is only used when true ranges are merged; in case of a join of two concrete values we will always create an IntegerRangeLike value. If the cardinality is exceeded, we will also first create ranges based on the boundaries determined by the defaul data types (byte,short,char).
This setting can be adapted at runtime.
- Definition Classes
- IntegerRangeValues
- def mergeDEComputations(pc: Int, c1: Computation[DomainValue, ExceptionValue], c2: Computation[DomainValue, ExceptionValue]): Computation[DomainValue, 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]
- Definition Classes
- TypeLevelReferenceValues
- def mergeDEsComputations(pc: Int, c1: Computation[DomainValue, ExceptionValues], c2: Computation[DomainValue, ExceptionValues]): Computation[DomainValue, 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]
- Definition Classes
- TypeLevelReferenceValues
- def mergeDomainValues(pc: Int, v1: DomainValue, v2: DomainValue): 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, ExceptionValues], c2: Computation[Nothing, ExceptionValues]): Computation[Nothing, 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]
- Definition Classes
- TypeLevelReferenceValues
- def mergeMultipleExceptionValues(pc: Int, v1s: ExceptionValues, v2s: ExceptionValues): 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.- Definition Classes
- TypeLevelReferenceValues
- val method: Method
Returns the method that is currently analyzed.
Returns the method that is currently analyzed.
- Definition Classes
- DefaultDomain → TheMethod
- def monitorenter(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
Handles a
monitorenter
instruction.Handles a
monitorenter
instruction.- Definition Classes
- MonitorInstructionsTracker → 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
- MonitorInstructionsTracker → MonitorInstructionsDomain
- Note
A monitor exit instruction may throw a
NullPointerException
or anIllegalMonitorStateException
.
- def multianewarray(pc: Int, counts: Operands, arrayType: ArrayType): Computation[DomainArrayValue, 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 newDefOpsForExceptionalControlFlow(currentPC: PC, currentInstruction: Instruction, successorPC: PC)(implicit operandsArray: OperandsArray): List[ValueOrigins]
- Attributes
- protected[this]
- Definition Classes
- RecordDefUse
- def newarray(pc: Int, count: DomainValue, componentType: FieldType): Computation[DomainValue, 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.
- def nextRefId(): RefId
Returns the next unused time stamp.
Returns the next unused time stamp.
- Definition Classes
- ReferenceValues
- def normalExitPCs: IntTrieSet
Returns the PCs of all return instructions which may have returned normally; which are practically always all return instructions unless the analysis _really_ finds an unbalanced return; which is very unlikely.
Returns the PCs of all return instructions which may have returned normally; which are practically always all return instructions unless the analysis _really_ finds an unbalanced return; which is very unlikely.
- Definition Classes
- RecordCFG
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def nullRefId: RefId
- Definition Classes
- ReferenceValues
- def operandOrigin(pc: PC, stackIndex: Int): ValueOrigins
Returns the instruction(s) which defined the value used by the instruction with the given
pc
and which is stored at the stack position with the given stackIndex.Returns the instruction(s) which defined the value used by the instruction with the given
pc
and which is stored at the stack position with the given stackIndex. The first/top value on the stack has index 0 and the second value - if it exists - has index two; independent of the computational category of the values.- Definition Classes
- RecordDefUse
- def origins(value: DomainValue): ValueOrigins
Returns the origin(s) of the given value if the information is available.
Returns the origin(s) of the given value if the information is available.
- Definition Classes
- Origin
- def originsIterator(value: DomainValue): ValueOriginsIterator
Returns the origin(s) of the given value if the information is available.
Returns the origin(s) of the given value if the information is available.
- returns
The source(s) of the given value if the information is available. Whether the information is available depends on the concrete domains. This trait only defines a general contract how to get access to a value's origin (I.e., the origin of the instruction which created the respective value.) By default this method returns an empty
Iterable
.
- Definition Classes
- Origin
- def originsOf(domainValue: DomainValue): Option[ValueOrigins]
Returns the origins of a domain value.
Returns the origins of a domain value. This method is intended to be overridden by domains that provide more precise def/use information than the default def/use analysis.
E.g., the l1.ReferenceValues domain tracks alias relations and can (when we inline calls) correctly identify those returned values that were passed to it.
- domainValue
The domain value for which the origin information is required. If no information is available,
defaultOrigins
should be returned.- returns
The origin information for the given
domainValue
.
- Attributes
- protected[this]
- Definition Classes
- RefineDefUseUsingOrigins → RecordDefUse
- val parametersOffset: Int
- Attributes
- protected[this]
- Definition Classes
- RecordDefUse
- def pdtBasedControlDependencies: DominanceFrontiers
Computes the control dependencies graph based on the post dominator tree.
Computes the control dependencies graph based on the post dominator tree.
Internally, a post dominator tree is used for methods without infinite loops; i.e., we compute non-termination insensitive control dependencies. Note that – dues to exceptions which may lead to abnormal returns
- Definition Classes
- RecordCFG
- def postDominatorTree: PostDominatorTree
Returns the org.opalj.graphs.PostDominatorTree (PDT).
Returns the org.opalj.graphs.PostDominatorTree (PDT).
- Definition Classes
- RecordCFG
- Note
The construction of
,PostDominatorTree
s for methods with multiple exit nodes and also – potentially - infinite loops has several limitations; in particular, if the results are used for computing control-dependence information.If the method/CFG contains infinite loops (see #infiniteLoopHeaders) then the instructions which jump back to the infinite loop headers (from within the loop) are also used as additional exit nodes.
- def predecessorsOf(pc: Int): PCs
Returns the program counter(s) of the instruction(s) that is(are) executed before the instruction with the given pc.
Returns the program counter(s) of the instruction(s) that is(are) executed before the instruction with the given pc.
If the instruction with the given
pc
was never executed an empty set is returned.- pc
A valid program counter.
- Definition Classes
- RecordCFG
- val project: Project[Source]
Returns the project that is currently analyzed.
Returns the project that is currently analyzed.
- Definition Classes
- DefaultDomain → TheProject
- def propagate(currentPC: Int, successorPC: Int, newDefOps: List[ValueOrigins], newDefLocals: collection.mutable.Locals[ValueOrigins])(implicit cfJoins: IntTrieSet, subroutinePCs: IntArraySet): Boolean
- Attributes
- protected[this]
- Definition Classes
- RecordDefUse
- def properties(pc: Int, propertyToString: (AnyRef) => String): Option[String]
Prints out the information by which values the current values are used.
Prints out the information by which values the current values are used.
Returns a string representation of the properties associated with the instruction with the respective program counter.
Associating properties with an instruction and maintaining those properties is, however, at the sole responsibility of the
Domain
.This method is predefined to facilitate the development of support tools and is not used by the abstract interpretation framework.
Domain
s that define (additional) properties should (abstract
)override
this method and should return a textual representation of the property.- Definition Classes
- RecordDefUse → ValuesDomain
- implicit final lazy val propertyStore: PropertyStore
- Definition Classes
- TheProject → ThePropertyStore
- def providesOriginInformationFor(ct: ComputationalType): Boolean
Implementers are expected to "override" this method and to call
super.providesOriginInformationFor
to make it possible to stack several domain implementations which provide origin information.Implementers are expected to "override" this method and to call
super.providesOriginInformationFor
to make it possible to stack several domain implementations which provide origin information.- Definition Classes
- ReferenceValues → Origin
- def putfield(pc: Int, objectref: DomainValue, value: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[Nothing, ExceptionValue]
Sets the field's value if the given
objectref
is notnull
(in the Domain).Sets the field's value if the given
objectref
is notnull
(in the Domain). In the latter case aNullPointerException
is thrown.- Definition Classes
- TypeLevelFieldAccessInstructions → FieldAccessesDomain
- def putstatic(pc: Int, value: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[Nothing, Nothing]
Sets the field's value.
Sets the field's value.
- Definition Classes
- TypeLevelFieldAccessInstructions → FieldAccessesDomain
- def refAreEqual(pc: Int, v1: DomainValue, v2: DomainValue): Answer
Returns
Yes
if bothDomainReferenceValues
definitively identify the same object at runtime.Returns
Yes
if bothDomainReferenceValues
definitively identify the same object at runtime.Using this domain, it is in general not possible to determine that two values are definitively not reference equal unless they are type incompatible.
- Definition Classes
- ReferenceValues → TypeLevelReferenceValues → ReferenceValuesDomain
- 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 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: 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)
Refines the "null"ness property (
isNull == No
) of the given value.Refines the "null"ness property (
isNull == No
) of the given value.Calls
refineIsNull
on the givenReferenceValue
and replaces every occurrence on the stack/in a register with the updated value.- value
A
ReferenceValue
that does not represent the valuenull
.
- Definition Classes
- ReferenceValues → ReferenceValuesDomain
- def refEstablishIsNull(pc: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
Updates the "null"ness property (
isNull == Yes
) of the given value.Updates the "null"ness property (
isNull == Yes
) of the given value.Calls
refineIsNull
on the givenReferenceValue
and replaces every occurrence on the stack/in a register with the updated value.- value
A
ReferenceValue
.
- Definition Classes
- ReferenceValues → ReferenceValuesDomain
- def refIsNonNull(pc: Int, value: 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: 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, 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
- ReferenceValues → TypeLevelReferenceValues → ReferenceValuesDomain
- def refTopOperandIsNull(pc: Int, operands: Operands, locals: Locals): (Operands, 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
- ReferenceValues → TypeLevelReferenceValues → ReferenceValuesDomain
- def refineIsNull(pc: Int, value: DomainValue, isNull: Answer, operands: Operands, locals: Locals): (Operands, Locals)
- Attributes
- protected[this]
- Definition Classes
- ReferenceValues
- def registerReadWrite(currentPC: PC, successorPC: PC, index: Int)(implicit cfJoins: IntTrieSet, subroutinePCs: IntArraySet, localsArray: LocalsArray): Boolean
- Attributes
- protected[this]
- Definition Classes
- RecordDefUse
- def regularSuccessorsOf(pc: Int): PCs
Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may succeed without raising an exception.
Returns the program counter(s) of the instruction(s) that is(are) executed next if the evaluation of this instruction may succeed without raising an exception.
The returned set is always empty for
return
instructions. It is also empty for instructions that always throw an exception (e.g., an integer value that is divided by zero will always result in a NullPointException.)- Definition Classes
- RecordCFG
- Note
The org.opalj.br.instructions.ATHROW instruction will never have a
regularSuccessor
. Thereturn
instructions will never have any successors.
- 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
- RecordCFG → ReturnInstructionsDomain
- Note
If another domain always overrides this method the invocation of this one has to be ensured; otherwise the recorded CFG will be incomplete.
- def safeExternalExceptionsUsedBy(pc: Int): ValueOrigins
Returns the instructions which use the (external) exception raised by the instruction with the given ValueOrigin.
Returns the instructions which use the (external) exception raised by the instruction with the given ValueOrigin.
- Definition Classes
- RecordDefUse
- def safeUsedBy(valueOrigin: ValueOrigin): ValueOrigins
Returns the instructions which use the value or the external exception identified by the given value origin.
Returns the instructions which use the value or the external exception identified by the given value origin. Basically, the same as
usedBy
except that an empty set of value origins is returned if the instruction with the given value origin is dead.- Definition Classes
- RecordDefUse
- def saload(pc: Int, index: DomainValue, arrayref: DomainValue): ArrayLoadResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- def sastore(pc: Int, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult
- Definition Classes
- GeneralizedArrayHandling → ReferenceValuesDomain
- 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 sideEffectOnlyOrExceptions(pc: Int, value: DomainValue): Computation[Nothing, ExceptionValue]
- Attributes
- protected[this]
- Definition Classes
- IgnoreSynchronization
- def simpleClassForNameCall(pc: Int, className: String): MethodCallResult
- Attributes
- protected[l1]
- Definition Classes
- ClassValues
- def stackOperation(currentPC: Int, currentInstruction: Instruction, successorPC: Int, isExceptionalControlFlow: Boolean, usedValues: Int, pushesValue: Boolean)(implicit cfJoins: IntTrieSet, subroutinePCs: IntArraySet, operandsArray: OperandsArray): Boolean
- Attributes
- protected[this]
- Definition Classes
- RecordDefUse
- def subroutineStartPCs: PCs
Returns the PCs of the first instructions of all subroutines; that is, the instructions a
JSR
instruction jumps to.Returns the PCs of the first instructions of all subroutines; that is, the instructions a
JSR
instruction jumps to.- Definition Classes
- RecordCFG
- final def successorsOf(pc: Int, regularSuccessorOnly: Boolean): PCs
- Definition Classes
- RecordCFG
- 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 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
- def thisProperty(pc: Int): Option[String]
- Attributes
- protected[this]
- Definition Classes
- RecordDefUse
- 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.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwArrayIndexOutOfBoundsException: Boolean
If
true
anArrayIndexOutOfBoundsException
is thrown if the index cannot be verified to be valid.If
true
anArrayIndexOutOfBoundsException
is thrown if the index cannot be verified to be valid.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwArrayStoreException: Boolean
If
true
anArrayStoreException
is thrown if it cannot be verified that the value can be stored in the array.If
true
anArrayStoreException
is thrown if it cannot be verified that the value can be stored in the array.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwClassCastException: Boolean
If
true
aClassCastException
is thrown byCHECKCAST
instructions if it cannot be verified that noClassCastException
will be thrown.If
true
aClassCastException
is thrown byCHECKCAST
instructions if it cannot be verified that noClassCastException
will be thrown.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- 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 specificProject
.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → 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.
- returns
ExceptionsRaisedByCalledMethods.Any
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwIllegalMonitorStateException: Boolean
If
true
thenmonitorexit
and the(XXX)return
instructions will throwIllegalMonitorStateException
s unless the analysis is able to determine that the exception is guaranteed not to be raised.If
true
thenmonitorexit
and the(XXX)return
instructions will throwIllegalMonitorStateException
s unless the analysis is able to determine that the exception is guaranteed not to be raised.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwNegativeArraySizeException: Boolean
If
true
aNegativeArraySizeException
is thrown if the index cannot be verified to be positive.If
true
aNegativeArraySizeException
is thrown if the index cannot be verified to be positive.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwNullPointerExceptionOnArrayAccess: Boolean
Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored.Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored. However, if the interpreter identifies a situation in which aNullPointerException
is guaranteed to be thrown, it will be thrown.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwNullPointerExceptionOnFieldAccess: Boolean
Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored.Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored. However, if the interpreter identifies a situation in which aNullPointerException
is guaranteed to be thrown, it will be thrown.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwNullPointerExceptionOnMethodCall: Boolean
Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored.Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored. However, if the interpreter identifies a situation in which aNullPointerException
is guaranteed to be thrown, it will be thrown. Example:def demo(o : Object) { o.toString // - If "true", a NullPointerException will ALSO be thrown; // the operation also succeeds. // - If "false" the operation will "just" succeed }
- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwNullPointerExceptionOnMonitorAccess: Boolean
Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored.Returns
true
if potentialNullPointerExceptions
should be thrown andfalse
if suchNullPointerExceptions
should be ignored. However, if the interpreter identifies a situation in which aNullPointerException
is guaranteed to be thrown, it will be thrown.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- def throwNullPointerExceptionOnThrow: Boolean
If
true
a VM levelNullPointerExceptions
is thrown if the exception that is to be thrown may be null.If
true
a VM levelNullPointerExceptions
is thrown if the exception that is to be thrown may be null.- returns
true
- Definition Classes
- ThrowAllPotentialExceptionsConfiguration → Configuration
- final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]
- Definition Classes
- ReferenceValuesFactory
- def throwsException(pc: Int): Boolean
Returns
true
if the execution of the given instruction – identified by its pc – ex-/implicitly throws an exception that is (potentially) handled by the method.Returns
true
if the execution of the given instruction – identified by its pc – ex-/implicitly throws an exception that is (potentially) handled by the method.- Definition Classes
- RecordCFG
- def toDomainValue(pc: Int, value: AnyRef): DomainReferenceValue
Converts the given Java object to a corresponding
DomainValue
by creating anDomainValue
that represents an initialized (array/object) value.Converts the given Java object to a corresponding
DomainValue
by creating anDomainValue
that represents an initialized (array/object) value.- pc
The program counter of the instruction that was responsible for creating the respective value. (This is in – in general – not the instruction where the transformation is performed.)
- value
The object.
- returns
A
DomainReferenceValue
.
- Definition Classes
- StringValues → DefaultJavaObjectToDomainValueConversion → AsDomainValue
- def toJavaObject(pc: Int, value: 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
- StringValues → ReferenceValues → 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
- TheMethod → AnyRef → Any
- def unused: ValueOrigins
Returns the union of the set of unused parameters and the set of all instructions which compute a value that is not used in the following.
Returns the union of the set of unused parameters and the set of all instructions which compute a value that is not used in the following.
- Definition Classes
- RecordDefUse
- def updateAfterEvaluation(oldValue: DomainValue, newValue: DomainValue): Unit
- Attributes
- protected
- Definition Classes
- PostEvaluationMemoryManagement
- def updateAfterException(oldValue: DomainValue, newValue: DomainValue): Unit
- Attributes
- protected
- Definition Classes
- PostEvaluationMemoryManagement
- def updateAfterExecution(oldValue: DomainValue, newValueAfterEvaluation: DomainValue, newValueAfterException: DomainValue): Unit
- Attributes
- protected
- Definition Classes
- PostEvaluationMemoryManagement
- def updateMemoryLayout(oldValue: DomainValue, newValue: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)
Replaces all occurrences of
oldValue
(using reference-quality) withnewValue
.Replaces all occurrences of
oldValue
(using reference-quality) withnewValue
. If no occurrences are found, the original operands and locals data structures are returned.- Definition Classes
- CoreDomainFunctionality
- def upperTypeBound(theValues: UIDSet[DomainSingleOriginReferenceValue]): UIDSet[_ <: ReferenceType]
Calculates the most specific common upper type bound of the upper type bounds of all values.
Calculates the most specific common upper type bound of the upper type bounds of all values.
NullValue
s are ignored unless all values are representingNull
.- Definition Classes
- ReferenceValues
- def usedBy(valueOrigin: ValueOrigin): ValueOrigins
Returns the instructions which use the value or the external exception identified by the given value origin.
Returns the instructions which use the value or the external exception identified by the given value origin. In c