Packages

t

org.opalj.ai

ValuesDomain

trait ValuesDomain extends AnyRef

Defines the concept of a value in a Domain.

Self Type
ValuesDomain
Source
ValuesDomain.scala
See also

Domain For an explanation of the underlying concepts and ideas.

Linear Supertypes
AnyRef, Any
Known Subclasses
CoreDomainFunctionality, CorrelationalDomain, CorrelationalDomainSupport, Domain, DoubleValuesDomain, DoubleValuesFactory, ExceptionsFactory, FloatValuesDomain, FloatValuesFactory, IdentityBasedCorrelationChangeDetection, IntegerRangeValuesFactory, IntegerValuesDomain, IntegerValuesFactory, JoinStabilization, LongValuesDomain, LongValuesFactory, ReferenceValuesDomain, ReferenceValuesFactory, ConstantFieldValuesResolution, DefaultExceptionsFactory, DefaultSpecialDomainValuesBinding, GeneralizedArrayHandling, PerInstructionPostProcessing, PostEvaluationMemoryManagement, RecordCFG, RecordConstraints, RecordDefUse, RefineDefUseUsingOrigins, ReifiedConstraints, ValuesCoordinatingDomain, BaseDomain, BaseDomainWithDefUse, DefaultReferenceValuesBinding, DefaultTypeLevelDoubleValues, DefaultTypeLevelFloatValues, DefaultTypeLevelIntegerValues, DefaultTypeLevelLongValues, DefaultTypeLevelReferenceValues, PrimitiveTACAIDomain, TypeCheckingDomain, TypeLevelDomain, TypeLevelDoubleValues, TypeLevelFloatValues, TypeLevelIntegerValues, TypeLevelLongValues, TypeLevelLongValuesShiftOperators, TypeLevelReferenceValues, ZeroDomain, ArrayValues, ClassValues, ConcreteArrayValues, ConstraintsBetweenIntegerValues, DefaultArrayValuesBinding, DefaultClassValuesBinding, DefaultConcreteArrayValuesBinding, DefaultDomain, DefaultDomainWithCFG, DefaultDomainWithCFGAndDefUse, DefaultIntegerRangeValues, DefaultIntegerSetValues, DefaultIntegerValues, DefaultIntervalValuesDomain, DefaultLongSetValues, DefaultLongValues, DefaultReferenceValuesBinding, DefaultReferenceValuesDomain, DefaultReferenceValuesDomainWithCFGAndDefUse, DefaultSetValuesDomain, DefaultSingletonValuesDomain, DefaultStringValuesBinding, IntegerRangeValues, IntegerSetValues, IntegerValues, LongSetValues, LongSetValuesShiftOperators, LongValues, LongValuesShiftOperators, MaxArrayLengthRefinement, NullPropertyRefinement, ReferenceValues, StringBuilderValues, StringValues, ChildDefaultDomain, CoordinatingValuesDomain, DefaultDomain, DefaultPerformInvocationsDomain, DefaultPerformInvocationsDomainWithCFG, DefaultPerformInvocationsDomainWithCFGAndDefUse, SharedDefaultDomain, SharedValuesDomain, PropertyTracing, SimpleBooleanPropertyTracing, FieldValuesAnalysisDomain, MethodReturnValuesAnalysisDomain, L1DefaultDomainWithCFGAndDefUseAndSignatureRefinement, PrimitiveTACAIDomainWithSignatureRefinement
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValuesDomain
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type DomainIllegalValue <: IllegalValue with DomainValue

    Abstracts over the concrete type of IllegalValue.

    Abstracts over the concrete type of IllegalValue.

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

  2. abstract type DomainReferenceValue >: Null <: ReferenceValue with DomainTypedValue[ReferenceType]
  3. abstract type DomainReturnAddressValue <: ReturnAddressValue with DomainValue

    Abstracts over the concrete type of ReturnAddressValue.

    Abstracts over the concrete type of ReturnAddressValue. Needs to be fixed by some sub-trait/sub-class. In the simplest case (i.e., when neither the Value trait nor the ReturnAddressValue trait was refined) it is sufficient to write:

    type DomainReturnAddressValue = ReturnAddressValue
  4. abstract type DomainReturnAddressValues <: ReturnAddressValues with DomainValue
  5. abstract type DomainTypedValue[+T <: Type] >: Null <: DomainValue
  6. abstract type DomainValue >: Null <: Value

    Abstracts over the concrete type of Value.

    Abstracts over the concrete type of Value. Needs to be refined by traits that inherit from Domain and which extend Domain's Value trait.

  7. type ExceptionValue = DomainReferenceValue

    A simple type alias of the type DomainValue; used to facilitate comprehension.

  8. type ExceptionValues = Iterable[ExceptionValue]

    A type alias for Iterables of ExceptionValues; used to facilitate comprehension.

  9. 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
    See also

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

  10. type Locals = collection.mutable.Locals[DomainValue]

    An instruction's current register values/locals are represented using an array.

  11. type LocalsArray = Array[Locals]
  12. 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.

  13. type OperandsArray = Array[Operands]
  14. trait RETValue extends Value with IsReturnAddressValue
  15. trait ReferenceValue extends TypedValue[ReferenceType] with IsReferenceValue
  16. 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).

    Note

    Though the framework completely handles all aspects related to return address values, it is nevertheless necessary that this class inherits from Value as return addresses are stored on the stack/in the registers. However, if the Value trait should be refined, all additional methods may – from the point-of-view of OPAL-AI – just throw an UnsupportedOperationException as these additional methods will never be called by the OPAL-AI.

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

  18. trait TypedValue[+T <: Type] extends Value with KnownTypedValue
  19. trait Value extends ValueInformation

    Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.

    Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.

    Use Of Value/Dependencies On Value

    In general, subclasses and users of a Domain should not have/declare a direct dependency on Value. Instead they should use DomainValue as otherwise extensibility of a Domain may be hampered or even be impossible. The only exceptions are, of course, classes that directly inherit from this class.

    Refining Value

    If you directly extend/refine this trait (i.e., in a subclass of the Domain trait you write something like trait Value extends super.Value), make sure that you also extend all classes/traits that inherit from this type (this may require a deep mixin composition and that you refine the type DomainType accordingly). However, OPAL was designed such that extending this class should – in general – not be necessary. It may also be easier to encode the desired semantics – as far as possible – as part of the domain.

    Implementing Value

    Standard inheritance from this trait is always supported and is the primary mechanism to model an abstract domain's lattice w.r.t. some special type of value. In general, the implementation should try to avoid creating new instances of values unless strictly required to model the domain's semantics. This will greatly improve the overall performance as this framework heavily uses reference-based equality checks to speed up the evaluation.

    Note

    OPAL does not rely on any special equality semantics w.r.t. values and never directly or indirectly calls a Value's equals method. Hence, a domain can encode equality such that it best fits its need. However, some of the provided domains rely on the following semantics for equals: Two domain values have to be equal (==) iff they represent the same information. This includes additional information, such as, the value of the origin. E.g., a value (AnIntegerValue) that represents an arbitrary Integer value has to return true if the domain value with which it is compared also represents an arbitrary Integer value (AnIntegerValue). However, it may still be necessary to use multiple objects to represent an arbitrary integer value if, e.g., constraints should be attached to specific values. For example, after a comparison of an integer value with a predefined value (e.g., AnIntegerValue < 4) it is possible to constrain the respective value on the subsequent paths (< 4 on one path and >= 4 on the other path). To make that possible, it is however necessary to distinguish the AnIntegervalue from some other AnIntegerValue to avoid constraining unrelated values.

    public void foo(int a,int b) {
    if(a < 4) {
        z = a - 2 // here a is constrained (< 4), b and z are unconstrained
    }
    else {
        z = a + 2 // here a is constrained (>= 4), b and z are unconstrained
    }
}

    In general, equals is only defined for values belonging to the same domain. If values need to be compared across domains, they need to be adapted to a target domain first.

Abstract Value Members

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

    The class tag for the type DomainValue.

    The class tag for the type DomainValue.

    Required to generate instances of arrays in which values of type DomainValue can be stored in a type-safe manner.

    Initialization

    In the sub-trait or class that fixes the type of DomainValue it is necessary to implement this abstract val using:

    val DomainValueTag : ClassTag[DomainValue] = implicitly

    (As of Scala 2.10 it is necessary that you do not use implicit in the subclass - it will compile, but fail at runtime.)

  3. abstract def InitializedDomainValue(origin: ValueOrigin, vi: ValueInformation): DomainValue

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

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

    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.

  4. abstract def MetaInformationUpdateIllegalValue: MetaInformationUpdate[DomainIllegalValue]

    The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].

  5. abstract def ReturnAddressValue(address: Int): DomainReturnAddressValue

    Factory method to create an instance of a ReturnAddressValue.

  6. abstract val TheIllegalValue: DomainIllegalValue

    The singleton instance of the IllegalValue.

  7. abstract val TheReturnAddressValues: DomainReturnAddressValues

    The singleton instance of ReturnAddressValues

  8. implicit abstract def classHierarchy: ClassHierarchy

    This project's class hierarchy.

    This project's class hierarchy.

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]

    The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue.

    The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue. The JVM semantics guarantee that the value will not be used and, hence, continuing the interpretation is meaningless.

    Note

    This method is solely defined for documentation purposes and to catch implementation errors early on.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isASubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Tests if subtype is known to be subtype of supertype.

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

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Boolean

    Tests if subtype is known to be subtype of supertype.

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

  14. def mergeDomainValues(pc: Int, v1: DomainValue, v2: DomainValue): DomainValue

    Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.

    Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.

    This operation is commutative.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def properties(pc: PC, propertyToString: (AnyRef) => String = p => p.toString): Option[String]

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

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

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

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

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

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

    Creates a summary of the given domain values by summarizing and joining the given values.

    Creates a summary of the given domain values by summarizing and joining the given values. For the precise details regarding the calculation of a summary see Value.summarize(...).

    pc

    The program counter that will be used for the summary value if a new value is returned that abstracts over/summarizes the given values.

    values

    An Iterable over one or more values.

    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.

  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped