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 fpcf
    Definition Classes
    ai
  • package analyses
    Definition Classes
    fpcf
  • package domain
    Definition Classes
    fpcf
  • package properties
    Definition Classes
    fpcf
  • AIDomainFactoryKey
  • AnAIResult
  • BaseAIResult
  • BaseAIResultPropertyMetaInformation
  • FieldValue
  • FieldValueMetaInformation
  • MethodReturnValue
  • MethodReturnValuePropertyMetaInformation
  • NoAIResult
  • NoMethodReturnValue
  • ProjectSpecificAIExecutor
  • TheMethodReturnValue
  • TypeBasedFieldValueInformation
  • ValueBasedFieldValueInformation
p

org.opalj.ai.fpcf

properties

package properties

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. case class AnAIResult(theAIResult: AIResult) extends BaseAIResult with Product with Serializable
  2. sealed trait BaseAIResult extends Property with BaseAIResultPropertyMetaInformation

    Encapsulates the (intermediate) result of the abstract interpretation of a method.

    Encapsulates the (intermediate) result of the abstract interpretation of a method.

    As in case of the other properties, the upper bound represents the most precise result and the lower bound the sound over approximation. Initially, the upper bound is the special value NoAIResult and identifies the case where the method is not reached at all. The lower bound generally models the sound over-approximation of all paths that are potentially taken.

    The upper bound can only meaningfully be computed in combination with a call graph.

  3. sealed trait BaseAIResultPropertyMetaInformation extends PropertyMetaInformation
  4. sealed trait FieldValue extends Property with FieldValueMetaInformation

    Encapsulates the (intermediate) result of the computation of the properties of the values stored in a field.

    Encapsulates the (intermediate) result of the computation of the properties of the values stored in a field. The value generally abstracts over all values stored in a respective field.

  5. sealed trait FieldValueMetaInformation extends PropertyMetaInformation
  6. trait MethodReturnValue extends Property with MethodReturnValuePropertyMetaInformation
  7. sealed trait MethodReturnValuePropertyMetaInformation extends PropertyMetaInformation
  8. class ProjectSpecificAIExecutor extends (Method) => AIResult

    Encapsulates the information which domain will be used to perform the abstract interpretations for the specified project.

    Encapsulates the information which domain will be used to perform the abstract interpretations for the specified project. This typically initialized by the AIDomainFactoryKey$.

  9. case class TheMethodReturnValue(theReturnValue: ValueInformation) extends MethodReturnValue with Product with Serializable

    Stores the information about the value (always) returned by a specific method.

    Stores the information about the value (always) returned by a specific method. Overridden methods are generally not taken into account. For a method that always end with an exception returnValue will be None.

    In the worst case the information about the return value is just the declared type.

    theReturnValue

    The value returned by the method when the method does not throw an exception. If the method always throws an exception, then the returnValue is None.

  10. case class TypeBasedFieldValueInformation(fieldType: FieldType) extends FieldValue with Product with Serializable
  11. case class ValueBasedFieldValueInformation(theValue: ValueInformation) extends FieldValue with Product with Serializable

Value Members

  1. object AIDomainFactoryKey extends ProjectInformationKey[ProjectSpecificAIExecutor, Set[Class[_ <: AnyRef]]]

    Key to get the factory (actually this is a meta-factory) to create the domains that are used to perform abstract interpretations.

    Key to get the factory (actually this is a meta-factory) to create the domains that are used to perform abstract interpretations. The domain that is going to be used is determined by getting the set of (partial)domains that are required and then computing the cheapest domain; see org.opalj.ai.common.DomainRegistry for further information. Hence, the AIResult's domain is guaranteed to implement all required (partial) domains.

    This key's project specific initialization data are java.lang.Class objects which have to be implemented by the finally chosen domain.

  2. object BaseAIResult extends BaseAIResultPropertyMetaInformation

    Common constants used by all BaseAIResult properties associated with methods.

  3. object FieldValue extends FieldValueMetaInformation
  4. object MethodReturnValue extends MethodReturnValuePropertyMetaInformation
  5. case object NoAIResult extends BaseAIResult with Product with Serializable
  6. case object NoMethodReturnValue extends MethodReturnValue with Product with Serializable

Ungrouped