Packages

Definition Classes: root

Definition Classes: root

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.

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 domain

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 l0

Definition Classes: domain

package l1

Commonly useful methods.

Definition Classes: domain

package l2

Definition Classes: domain

package tracing

Definition Classes: domain

AsDomainValue

AsJavaObject

ConcreteIntegerValues

ConcreteLongValues

ConstantFieldValuesResolution

CurrentCode

DefaultExceptionsFactory

DefaultHandlingForReturnInstructions

DefaultHandlingForThrownExceptions

DefaultHandlingOfMethodResults

DefaultHandlingOfVoidReturns

DefaultRecordMethodCallResults

DefaultSpecialDomainValuesBinding

DomainId

DomainValues

GeneralizedArrayHandling

IgnoreSynchronization

ImpossibleRefinement

MethodCallResults

MethodCallsHandling

MonitorInstructionsTracker

Origin

Origins

OriginsIterator

PerInstructionPostProcessing

PerformAI

PostEvaluationMemoryManagement

PredefinedClassHierarchy

RecordAllThrownExceptions

RecordCFG

RecordConstraints

RecordDefUse

RecordJoinedThrownExceptions

RecordLastReturnedValues

RecordMethodCallResults

RecordReturnFromMethodInstructions

RecordReturnedValue

RecordReturnedValueInfrastructure

RecordReturnedValues

RecordReturnedValuesInfrastructure

RecordThrownExceptions

RecordVoidReturns

RefineDefUseUsingOrigins

ReifiedConstraints

ReturnInstructionsDomain

SpecialMethodsHandling

ThrowAllPotentialExceptionsConfiguration

ThrowNoPotentialExceptionsConfiguration

ValuesCoordinatingDomain

org.opalj.ai.domain

AsJavaObject

trait AsJavaObject extends AnyRef

Mixed in by domains that support the conversation of a DomainValue into a respective Java object. This Java object can then be used to perform method invocations.

Limitation

Using AsJavaObject will only work reasonably iff the respective class is either in the classpath of the JVM or a class loader (initialized with the project's classpath) is used. The latter, however, does not work for classes on the bootclasspath (e.g., java.lang.String). In that case it is necessary to check that the code of the analyzed application is compatible with the one on the class path. To avoid accidental imprecision in the analysis you should use this features only for stable classes belonging to the core JDK (java.lang....)

Self Type: AsJavaObject with ReferenceValuesDomain
Source: AsJavaObject.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

BaseDomain, BaseDomainWithDefUse, DefaultReferenceValuesBinding, DefaultTypeLevelReferenceValues, PrimitiveTACAIDomain, TypeCheckingDomain, TypeLevelDomain, TypeLevelReferenceValues, ZeroDomain, ArrayValues, ClassValues, ConcreteArrayValues, DefaultArrayValuesBinding, DefaultClassValuesBinding, DefaultConcreteArrayValuesBinding, DefaultDomain, DefaultDomainWithCFG, DefaultDomainWithCFGAndDefUse, DefaultIntervalValuesDomain, DefaultReferenceValuesBinding, DefaultReferenceValuesDomain, DefaultReferenceValuesDomainWithCFGAndDefUse, DefaultSetValuesDomain, DefaultSingletonValuesDomain, DefaultStringValuesBinding, MaxArrayLengthRefinement, ReferenceValues, ReflectiveInvoker, StringBuilderValues, StringValues, ChildDefaultDomain, CoordinatingValuesDomain, DefaultDomain, DefaultPerformInvocationsDomain, DefaultPerformInvocationsDomainWithCFG, DefaultPerformInvocationsDomainWithCFGAndDefUse, SharedDefaultDomain, SharedValuesDomain, FieldValuesAnalysisDomain, MethodReturnValuesAnalysisDomain, L1DefaultDomainWithCFGAndDefUseAndSignatureRefinement, PrimitiveTACAIDomainWithSignatureRefinement

Ordering

Alphabetic
By Inheritance

Inherited

AsJavaObject
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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 toJavaObject(pc: Int, value: (AsJavaObject.this)#DomainValue): Option[AnyRef]
Converts – if possible – a given DomainValue to a Java object that is appropriately initialized.
Converts – if possible – a given DomainValue to a Java object that is appropriately initialized.
Implementation
Every domain that supports the creation of a Java object's based on a domain value is expected to implement this method and to test if it can create a precise representation of the given value. If not, the implementation has to delegate the responsibility to the super method to creat an abstract representation.
```
abstract override def toJavaObject(value : DomainValue): Option[Object] = {
 if(value...)
     // create and return Java object
 else
     super.toJavaObject(value)
}
```
returns
Some(Object) is returned if it was possible to create a compatible corresponding Java object; otherwise None is returned. Default: None unless the value is null. In the latter case Some(null) is returned.
Note
This operation is generally only possible if the domain value maintains enough state information to completely initialize the Java object.
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

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

AsJavaObject

trait AsJavaObject extends AnyRef

Limitation

Value Members

Implementation

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

AsJavaObject

trait AsJavaObject extends AnyRef

Limitation

Value Members

Implementation

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

AsJavaObject