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 fpcf

The fixpoint computations framework (fpcf) is a general framework to perform fixpoint computations of properties ordered by a lattice.

The fixpoint computations framework (fpcf) is a general framework to perform fixpoint computations of properties ordered by a lattice. The framework in particular supports the development of static analyses.

In this case, the fixpoint computations/static analyses are generally operating on the code and need to be executed until the computations have reached their (implicit) fixpoint. The fixpoint framework explicitly supports resolving cyclic dependencies/computations. A prime use case of the fixpoint framework are all those analyses that may interact with the results of other analyses.

For example, an analysis that analyzes all field write accesses to determine if we can refine a field's type (for the purpose of the analysis) can (reuse) the information about the return types of methods, which however may depend on the refined field types.

The framework is generic enough to facilitate the implementation of anytime algorithms.

Definition Classes: opalj
Note: This framework assumes that all data-structures (e.g., dependee lists and properties) that are passed to the framework are effectively immutable! (Effectively immutable means that a data structure is never updated after it was passed to the framework.)
,
The dependency relation is as follows: “A depends on B” === “A is the depender, B is the dependee”. === “B is depended on by A”
,
The very core of the framework is described in: Lattice Based Modularization of Static Analyses

package par

Definition Classes: fpcf

package seq

Definition Classes: fpcf

AnalysisScenario

ComputationSpecification

ComputationType

ContextNotAvailableException

EPK

EPS

EUBP

EUBPS

EagerComputation

ExplicitlyNamedProperty

FinalPropertyComputationResult

LBP

ProperPropertyComputationResult

PropertiesBoundType

Property

PropertyBounds

PropertyComputationResult

PropertyIsNotComputedByAnyAnalysis

PropertyIsNotDerivedByPreviouslyExecutedAnalysis

PropertyKey

PropertyKind

PropertyKindsConfiguration

PropertyMetaInformation

SimpleComputationSpecification

SinglePropertiesBoundType

SomeEPS

SomeFinalEP

SpecificationViolation

UBP

PropertyKindsConfiguration

case class PropertyKindsConfiguration(propertyKindsComputedInThisPhase: Set[PropertyKind], propertyKindsComputedInLaterPhase: Set[PropertyKind] = Set.empty, suppressInterimUpdates: Map[PropertyKind, Set[PropertyKind]] = Map.empty, collaborativelyComputedPropertyKindsFinalizationOrder: List[List[PropertyKind]] = List.empty) extends Product with Serializable

Encapsulates the configuration of an analysis phase.

propertyKindsComputedInThisPhase

The set of properties which will be computed in the phase. Required to determine which properties will never be computed and for which – therefore – fallbacks should be used.

propertyKindsComputedInLaterPhase

The set of properties computed in a later phase. Used for debugging purposes!

suppressInterimUpdates

Specifies for which properties updates no interim notifications shall be done. This ist generally only possible for those properties which are computed by analyses that do not take part in cyclic computations. For example,

ps.setupPhase(
  Set(ReachableNodes.Key, ReachableNodesCount.Key),
  Set.empty,
  Map(ReachableNodesCount.Key -> Set(ReachableNodes.Key))
)

will suppress notifications about interim updates from ReachableNodes to ReachableNodesCount

Source: PropertyKindsConfiguration.scala

Linear Supertypes

Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

PropertyKindsConfiguration
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new PropertyKindsConfiguration(propertyKindsComputedInThisPhase: Set[PropertyKind], propertyKindsComputedInLaterPhase: Set[PropertyKind] = Set.empty, suppressInterimUpdates: Map[PropertyKind, Set[PropertyKind]] = Map.empty, collaborativelyComputedPropertyKindsFinalizationOrder: List[List[PropertyKind]] = List.empty)
propertyKindsComputedInThisPhase
The set of properties which will be computed in the phase. Required to determine which properties will never be computed and for which – therefore – fallbacks should be used.
propertyKindsComputedInLaterPhase
The set of properties computed in a later phase. Used for debugging purposes!
suppressInterimUpdates
Specifies for which properties updates no interim notifications shall be done. This ist generally only possible for those properties which are computed by analyses that do not take part in cyclic computations. For example,
```
ps.setupPhase(
  Set(ReachableNodes.Key, ReachableNodesCount.Key),
  Set.empty,
  Map(ReachableNodesCount.Key -> Set(ReachableNodes.Key))
)
```
will suppress notifications about interim updates from ReachableNodes to ReachableNodesCount

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()
val collaborativelyComputedPropertyKindsFinalizationOrder: List[List[PropertyKind]]
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def getClass(): Class[_ <: AnyRef]
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()
def productElementNames: Iterator[String]
Definition Classes
Product
val propertyKindsComputedInLaterPhase: Set[PropertyKind]
val propertyKindsComputedInThisPhase: Set[PropertyKind]
val suppressInterimUpdates: Map[PropertyKind, Set[PropertyKind]]
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
PropertyKindsConfiguration → 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

PropertyKindsConfiguration

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

PropertyKindsConfiguration

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

PropertyKindsConfiguration