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 - org.opalj.bi) that can be used to create arbitrary representations.
a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler - org.opalj.da).
a library to convert this representation to Java class files (Bytecode Creator - org.opalj.bc).
a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
a library to create a stackless, three-address code representation of Java bytecode that facilitates writing complex static analyses (Three Address Code - org.opalj.tac).
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 (Dependencies Extraction - org.opalj.de) and to facilitate checking architecture definitions (Architecture Validation - org.opalj.av).
a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler - org.opalj.ba).
a library for parsing Android packages (APK - org.opalj.apk).
libraries for writing static analyses using the interprocedural finite distributive subset (IFDS - org.opalj.ifds) and interprocedural distributive environment (IDE - org.opal.ide) algorithms.

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 tac

Common definitions related to the definition and processing of three address code.

Definition Classes: opalj

package fpcf

Definition Classes: tac

package analyses

Definition Classes: fpcf

package alias

Definition Classes: analyses

package pointsto

AbstractAliasAnalysis

AliasAnalysisContext

AliasAnalysisState

AliasSetLike

AllocationSiteAndTacBasedAliasAnalysis

AllocationSiteBasedAliasAnalysis

AllocationSiteBasedAliasAnalysisState

AllocationSiteBasedAliasSet

IntraProceduralAliasAnalysis

IntraProceduralAliasAnalysisScheduler

LazyIntraProceduralAliasAnalysisScheduler

SetBasedAliasAnalysis

SetBasedAliasAnalysisState

TacBasedAliasAnalysis

TacBasedAliasAnalysisState

TypeBasedAliasAnalysis

TypeBasedAliasAnalysisState

TypeBasedAliasSet

package cg

Definition Classes: analyses

package escape

Definition Classes: analyses

package fieldaccess

Definition Classes: analyses

package fieldassignability

Definition Classes: analyses

package ide

Definition Classes: analyses

package ifds

Definition Classes: analyses

package pointsto

Definition Classes: analyses

package purity

Definition Classes: analyses

package string

Definition Classes: analyses

package systemproperties

Definition Classes: analyses

org.opalj.tac.fpcf.analyses

alias

package alias

Source: package.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

alias
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Package Members

package pointsto

Type Members

trait AbstractAliasAnalysis extends FPCFAnalysis
A base trait for all alias analyses.
class AliasAnalysisContext extends AnyRef
Encapsulates the context of an alias analysis computation.
Encapsulates the context of an alias analysis computation.
It contains the entity for which the aliasing information is computed, the current project, and the property store used to query other properties.
It can be overridden to provide additional information to the computation.
trait AliasAnalysisState extends AnyRef
Encapsulates the current state of an alias analysis.
Encapsulates the current state of an alias analysis.
It handles the current dependees of the analysis.
It can be overridden to provide additional state information to the computation.
trait AliasSetLike[ElementType, T <: AliasSetLike[ElementType, T]] extends AnyRef
A base trait for alias sets that store the elements that an org.opalj.br.fpcf.properties.alias.AliasSourceElement can point to.
A base trait for alias sets that store the elements that an org.opalj.br.fpcf.properties.alias.AliasSourceElement can point to. It is possible to denote that the set can point to any arbitrary element if an analysis cannot limit the points-to set. This is handled by the pointsToAny and setPointsToAny() method.
ElementType
The type of the elements that can be stored in the set.
T
The concrete type of the alias set.
type AllocationSite = (Context, PC)
trait AllocationSiteAndTacBasedAliasAnalysis extends AllocationSiteBasedAliasAnalysis with TacBasedAliasAnalysis
trait AllocationSiteBasedAliasAnalysis extends SetBasedAliasAnalysis
class AllocationSiteBasedAliasAnalysisState extends SetBasedAliasAnalysisState[AllocationSite, AllocationSiteBasedAliasSet]
Encapsulates the current state of an alias analysis that uses an AllocationSiteBasedAliasSet to store the allocations sites to which each of the alias elements can point to.
class AllocationSiteBasedAliasSet extends AliasSetLike[AllocationSite, AllocationSiteBasedAliasSet]
Implementation of an AliasSetLike that is based on allocation sites, i.e., it stores elements of the type AllocationSite.
class IntraProceduralAliasAnalysis extends AllocationSiteAndTacBasedAliasAnalysis
sealed trait IntraProceduralAliasAnalysisScheduler extends FPCFAnalysisScheduler
trait SetBasedAliasAnalysis extends AbstractAliasAnalysis
trait SetBasedAliasAnalysisState[ElementType, AliasSet <: AliasSetLike[ElementType, AliasSet]] extends AliasAnalysisState
Encapsulates the current state of an alias analysis that uses an AliasSetLike to store the elements that an AliasSourceElement can point to.
Encapsulates the current state of an alias analysis that uses an AliasSetLike to store the elements that an AliasSourceElement can point to.
It additionally stores and handles an AliasSetLike for each AliasSourceElement and provides methods for interacting with it.
trait TacBasedAliasAnalysis extends AbstractAliasAnalysis
A base trait for all alias analyses based on the TACAI.
trait TacBasedAliasAnalysisState extends AliasAnalysisState
Encapsulates the state of a TAC-based alias analysis.
Encapsulates the state of a TAC-based alias analysis.
It additionally contains the TACAI for the first and second alias source element if they are method bound and provides a way to calculate and cache the dominator and postDominator tree of the methods.
trait TypeBasedAliasAnalysis extends SetBasedAliasAnalysis
class TypeBasedAliasAnalysisState extends SetBasedAliasAnalysisState[ReferenceType, TypeBasedAliasSet]
Encapsulates the current state of an alias analysis that uses an TypeBasedAliasSet to store the allocations sites to which each of the alias elements can point to.
class TypeBasedAliasSet extends AliasSetLike[ReferenceType, TypeBasedAliasSet]
Implementation of an AliasSetLike that is based on types, i.e., it stores elements of the type ReferenceType.
type V = DUVar[ValueInformation]

Value Members

object LazyIntraProceduralAliasAnalysisScheduler extends IntraProceduralAliasAnalysisScheduler with BasicFPCFLazyAnalysisScheduler
A scheduler for a lazy, intraprocedural alias analysis.

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

alias

package alias

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

alias

package alias

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

alias