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
  • DomainRegistry
  • SimpleAIKey
  • XHTML
o

org.opalj.ai.common

DomainRegistry

object DomainRegistry

Registry for all domains that can be instantiated given a Project, and a Method with a body.

The registry was developed to support tools for enabling the automatic selection of a domain that satisfies a given set of requirements; it also support debugging purposes that let the user/developer choose between different domains. After choosing a domain, an abstract interpretation can be performed.

The compatible domains that are part of OPAL are already registered.

Thread Safety

The registry is thread safe.

Source
DomainRegistry.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DomainRegistry
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type ClassRegistry = Map[Class[_ <: Domain], DomainMetaInformation]
  2. case class DomainMetaInformation(lessPreciseDomains: Set[Class[_ <: Domain]], factory: (SomeProject, Method) => Domain) extends Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def allLessPreciseDomains(rootDomainClass: Class[_ <: Domain]): Set[Class[_ <: Domain]]

    The transitive hull of all less precise domains of the given domain.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final val configStrategySelectionKey: String("org.opalj.ai.common.DomainRegistry.defaultStrategy")
  8. def domainDescriptions(): Iterable[String]

    Returns an Iterable to make it possible to iterate over the descriptions of the domain.

    Returns an Iterable to make it possible to iterate over the descriptions of the domain. Useful to show the (end-users) some meaningful descriptions.

  9. def domainMetaInformation(domainClass: Class[_ <: Domain]): DomainMetaInformation
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def newDomain(domainClass: Class[_ <: Domain], project: SomeProject, method: Method): Domain

    Creates a new instance of the domain identified by the given domainClass.

    Creates a new instance of the domain identified by the given domainClass. To create the instance the registered factory method will be used.

    domainClass

    The class object of the domain.

    project

    The project.

    method

    A method with a body.

  17. def newDomain(domainDescription: String, project: SomeProject, method: Method): Domain

    Creates a new instance of the domain identified by the given domainDescription.

    Creates a new instance of the domain identified by the given domainDescription.

    domainDescription

    The description that identifies the domain.

    project

    The project.

    method

    A method with a body.

  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. def register(domainDescription: String, domainClass: Class[_ <: Domain], lessPreciseDomains: Set[Class[_ <: Domain]], factory: (SomeProject, Method) => Domain): Unit

    Register a new domain that can be used to perform an abstract interpretation of a specific method.

    Register a new domain that can be used to perform an abstract interpretation of a specific method.

    domainDescription

    A short description of the properties of the domain; in particular w.r.t. the kind of computations the domain does.

    domainClass

    The class of the domain.

    lessPreciseDomains

    The set of domains which are less precise/costly than this domain. This basically defines a partial order between the domains.

    factory

    The factory method that will be used to create instances of the domain.

  21. def registry: ClassRegistry

    Returns the current view of the registry.

  22. def selectBest(requirements: Iterable[Class[_ <: AnyRef]]): Set[Class[_ <: Domain]]

    Selects a domain that satisfies all requirements and which – according to the domains' partial order is the most precise one.

    Selects a domain that satisfies all requirements and which – according to the domains' partial order is the most precise one. If the most precise one is not unique multiple domains are returned; if no domain satisfies the requirements an empty sequence is returned.

    returns

    The best domain satisfying the stated requirements.

    Example:

    1. To get a domain use:

      selectBest(Seq(classOf[RecordDefUse],classOf[IntegerRangeValues] ))
  23. def selectCandidates(requirements: Iterable[Class[_ <: AnyRef]]): Set[Class[_ <: Domain]]
  24. def selectCheapest(requirements: Iterable[Class[_ <: AnyRef]]): Set[Class[_ <: Domain]]
  25. def selectConfigured(config: Config, requirements: Iterable[Class[_ <: AnyRef]]): Set[Class[_ <: Domain]]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped