The OPAL Framework5.0.0 < Back

Packages

package root
Definition Classes
root
package org
Definition Classes
root
package opalj
OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.
OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.
Its main components are:
- a library (Common) which provides generally useful data-structures and algorithms for static analyses.
- a framework for implementing lattice based static analyses (Static Analysis Infrastructure)
- a framework for parsing Java bytecode (Bytecode Infrastructure) that can be used to create arbitrary representations.
- a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler).
- a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
- a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
- a library to extract dependencies between code elements and to facilitate checking architecture definitions.
- a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler).
General Design Decisions
Thread Safety
Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)
No null Values
Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.
No Typecasts for Collections
For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety.
Assertions
OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.
Definition Classes
org
package ai
Implementation of an abstract interpretation (ai) framework – also referred to as OPAL.
Implementation of an abstract interpretation (ai) framework – also referred to as OPAL.
Please note that OPAL/the abstract interpreter just refers to the classes and traits defined in this package (ai). The classes and traits defined in the sub-packages (in particular in domain) are not considered to be part of the core of OPAL/the abstract interpreter.
Definition Classes
opalj
Note
This framework assumes that the analyzed bytecode is valid; i.e., the JVM's bytecode verifier would be able to verify the code. Furthermore, load-time errors (e.g., LinkageErrors) are – by default – completely ignored to facilitate the analysis of parts of a project. In general, if the presented bytecode is not valid, the result is undefined (i.e., OPAL may report meaningless results, crash or run indefinitely).
See also
org.opalj.ai.AI - Implements the abstract interpreter that processes a methods code and uses an analysis-specific domain to perform the abstract computations.
org.opalj.ai.Domain - The core interface between the abstract interpretation framework and the abstract domain that is responsible for performing the abstract computations.
package common
Definition Classes
ai
package domain
This package contains definitions of common domains that can be used for the implementation of analyses.
This package contains definitions of common domains that can be used for the implementation of analyses.
Types of Domains
In general, we distinguish two types of domains. First, domains that define a general interface (on top of the one defined by Domain), but do not directly provide an implementation. Hence, whenever you develop a new Domain you should consider implementing/using these domains to maximize reusability. Second, Domains that implement a specific interface (trait). In this case, we further distinguish between domains that provide a default implementation (per interface only one of these Domains can be used to create a final Domain) and those that can be stacked and basically refine the overall functionality.
Examples
- Domains That Define a General Interface
  - Origin defines two types which domains that provide information abou the origin of a value should consider to implement.
  - TheProject defines a standard mechanism how a domain can access the current project.
  - ...
- Domains That Provide a Default Implementation
  - Origin defines the functionality to return a value's origin if the value supports that.
  - org.opalj.ai.domain.TheProject default implementation of the class hierarchy related methods using the project's class hierarchy.
  - org.opalj.ai.domain.DefaultHandlingOfMethodResults basically implements a Domain's methods related to return instructions an uncaught exceptions.
  - ...
- Domains That Implement Stackable Functionality
  - org.opalj.ai.domain.RecordThrownExceptions records information about all uncaught exceptions by intercepting a Domain's respective methods. However, it does provide a default implementation. Hence, a typical pattern is:
```
class MyDomain extends Domain with ...
    with DefaultHandlingOfMethodResults with RecordThrownExceptions
```
Thread Safety
Unless explicitly documented, a domain is never thread-safe. The general programming model is to use one Domain object per code block/method and therefore, thread-safety is not required for Domains that are used for the evaluation of methods. However domains that are used to adapt/transfer values should be thread safe (see org.opalj.ai.domain.ValuesCoordinatingDomain for further details).
Definition Classes
ai
package fpcf
Definition Classes
ai
package project
Definition Classes
ai
package util
Common utility functionality.
Common utility functionality.
Definition Classes
ai
AI
AIAborted
AICompleted
AIException
AIResult
AIResultBuilder
AITracer
BaseAI
BoundedInterruptableAI
CTC1
CTC2
Computation
ComputationFailed
ComputationWithException
ComputationWithResult
ComputationWithResultAndException
ComputationWithSideEffectOnly
ComputationWithSideEffectOrException
ComputedValue
ComputedValueOrException
Configuration
CoreDomainFunctionality
CorrelationalDomain
CorrelationalDomainSupport
CountingAI
CustomInitialization
Domain
DomainException
DoubleValuesDomain
DoubleValuesFactory
DynamicLoadsDomain
ExceptionsFactory
ExceptionsRaisedByCalledMethods
FieldAccessesDomain
FloatValuesDomain
FloatValuesFactory
GlobalLogContextProvider
IdentityBasedCorrelationChangeDetection
InstructionCountBoundedAI
IntegerRangeValuesFactory
IntegerValuesDomain
IntegerValuesFactory
InterpretationFailedException
InterruptableAI
JoinStabilization
LogContextProvider
LongValuesDomain
LongValuesFactory
MetaInformationUpdate
MetaInformationUpdateType
MethodCallsDomain
MonitorInstructionsDomain
MultiTracer
NoUpdate
NoUpdateType
PrimitiveValuesConversionsDomain
ReferenceValuesDomain
ReferenceValuesFactory
ReturnInstructionsDomain
SomeUpdate
StructuralUpdate
StructuralUpdateType
SubroutinesDomain
TheAI
TheCodeStructure
TheMemoryLayout
ThrowsException
TimeBoundedAI
TypedValuesFactory
Update
UpdateType
ValuesDomain

org.opalj.ai

Configuration

trait Configuration extends AnyRef

Centralizes all configuration options related to how a domain should handle situations in which the information about a value is (often) not completely available and which could lead to some kind of exception.

Basically all domains that perform some kind of abstraction should mix in this trait and query the respective method to decide if a respective exception should be thrown if it is possible that an exception may be thrown.

Usage

If you need to adapt a setting just override the respective method in your domain.

In general, the org.opalj.ai.domain.ThrowAllPotentialExceptionsConfiguration should be used as a foundation as it generates all exceptions that may be thrown; however, configuring the behavior of method calls may be worth while.

Source: Configuration.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

CorrelationalDomain, Domain, ConstantFieldValuesResolution, ThrowAllPotentialExceptionsConfiguration, ThrowNoPotentialExceptionsConfiguration, ValuesCoordinatingDomain, BaseDomain, BaseDomainWithDefUse, DefaultTypeLevelIntegerValues, PrimitiveTACAIDomain, TypeCheckingDomain, TypeLevelDomain, TypeLevelIntegerValues, ZeroDomain, DefaultDomain, DefaultDomainWithCFG, DefaultDomainWithCFGAndDefUse, DefaultIntervalValuesDomain, DefaultLongSetValues, DefaultReferenceValuesDomain, DefaultReferenceValuesDomainWithCFGAndDefUse, DefaultSetValuesDomain, DefaultSingletonValuesDomain, ChildDefaultDomain, CoordinatingValuesDomain, DefaultDomain, DefaultPerformInvocationsDomain, DefaultPerformInvocationsDomainWithCFG, DefaultPerformInvocationsDomainWithCFGAndDefUse, SharedDefaultDomain, SharedValuesDomain, FieldValuesAnalysisDomain, MethodReturnValuesAnalysisDomain, L1DefaultDomainWithCFGAndDefUseAndSignatureRefinement, PrimitiveTACAIDomainWithSignatureRefinement

Ordering

Alphabetic
By Inheritance

Inherited

Configuration
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract 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.
Note
Directly used by the AI itself.
abstract 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.
Note
Directly used by the AI itself.
abstract 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.
abstract def throwArrayIndexOutOfBoundsException: Boolean
If true an ArrayIndexOutOfBoundsException is thrown if the index cannot be verified to be valid.
abstract def throwArrayStoreException: Boolean
If true an ArrayStoreException is thrown if it cannot be verified that the value can be stored in the array.
abstract def throwClassCastException: Boolean
If true a ClassCastException is thrown by CHECKCAST instructions if it cannot be verified that no ClassCastException will be thrown.
If true a ClassCastException is thrown by CHECKCAST instructions if it cannot be verified that no ClassCastException will be thrown.
Note
Directly used by the AI itself.
abstract def throwClassNotFoundException: Boolean
Throw a ClassNotFoundException if the a specific reference type is not known in the current context.
Throw a ClassNotFoundException if the a specific reference type is not known in the current context. The context is typically a specific Project.
abstract 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.
Note
Used by domains which handle method invokations.
abstract def throwIllegalMonitorStateException: Boolean
If true then monitorexit and the (XXX)return instructions will throw IllegalMonitorStateExceptions unless the analysis is able to determine that the exception is guaranteed not to be raised.
abstract def throwNegativeArraySizeException: Boolean
If true a NegativeArraySizeException is thrown if the index cannot be verified to be positive.
abstract def throwNullPointerExceptionOnArrayAccess: Boolean
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.
abstract def throwNullPointerExceptionOnFieldAccess: Boolean
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.
abstract def throwNullPointerExceptionOnMethodCall: Boolean
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown. Example:
```
def demo(o : Object) {
     o.toString  // - If "true", a NullPointerException will ALSO be thrown;
                 //   the operation also succeeds.
                 // - If "false" the operation will "just" succeed
}
```
Note
Used by domains which handle method invokations.
abstract def throwNullPointerExceptionOnMonitorAccess: Boolean
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.
Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.
abstract def throwNullPointerExceptionOnThrow: Boolean
If true a VM level NullPointerExceptions is thrown if the exception that is to be thrown may be null.
If true a VM level NullPointerExceptions is thrown if the exception that is to be thrown may be null.
Note
Directly used by the AI itself.

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

Types of Domains

Thread Safety

Configuration

trait Configuration extends AnyRef

Usage

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

Types of Domains

Thread Safety

Configuration

trait Configuration extends AnyRef

Usage

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

Configuration