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 tac

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

    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 cg
    Definition Classes
    analyses
  • package escape
    Definition Classes
    analyses
  • package fieldassignability
    Definition Classes
    analyses
  • package pointsto
    Definition Classes
    analyses
  • package purity
    Definition Classes
    analyses
  • AbstractPurityAnalysis
  • AssertionExceptionRater
  • BaseDomainSpecificRater
  • DomainSpecificRater
  • EagerL1PurityAnalysis
  • EagerL2PurityAnalysis
  • ExceptionRater
  • L1PurityAnalysis
  • L1PurityAnalysisScheduler
  • L2PurityAnalysis
  • L2PurityAnalysisScheduler
  • LazyL1PurityAnalysis
  • LazyL2PurityAnalysis
  • LoggingRater
  • SystemOutErrRater
  • SystemOutLoggingAllExceptionRater
  • SystemOutLoggingAssertionExceptionRater

package purity

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. trait AbstractPurityAnalysis extends FPCFAnalysis

    Base trait for analyses that analyze the purity of methods.

    Base trait for analyses that analyze the purity of methods.

    Provides types and methods needed for purity analyses.

  2. trait AssertionExceptionRater extends DomainSpecificRater

    Mixin that treats some exception types typically used to assert program properties as domain-specific.

  3. class BaseDomainSpecificRater extends DomainSpecificRater

    Basic rater that does nothing.

  4. trait DomainSpecificRater extends AnyRef

    Rates, whether three address code statements perform actions that are domain-specific pure.

  5. trait ExceptionRater extends DomainSpecificRater

    Mixin that treats all exceptions as domain-specific.

  6. class L1PurityAnalysis extends AbstractPurityAnalysis

    An inter-procedural analysis to determine a method's purity.

    An inter-procedural analysis to determine a method's purity.

    Note

    This analysis is sound only up to the usual standards, i.e. it does not cope with VirtualMachineErrors and may be unsound in the presence of native code, reflection or sun.misc.Unsafe. Calls to native methods are generally handled soundly as they are considered org.opalj.br.fpcf.properties.ImpureByAnalysis. There are no soundness guarantees in the presence of load-time transformation. Soundness in general depends on the soundness of the analyses that compute properties used by this analysis, e.g. field mutability.

    ,

    This analysis is sound even if the three address code hierarchy is not flat, it will produce better results for a flat hierarchy, though. This is because it will not assess the types of expressions other than org.opalj.tac.Vars.

    ,

    This analysis derives all purity levels except for the Externally variants. A configurable DomainSpecificRater is used to identify calls, expressions and exceptions that are LBDPure instead of LBImpure or any SideEffectFree purity level. Compared to the L0PurityAnalysis, it deals with all methods, even if their reference type parameters are mutable. It can handle accesses of (effectively) final instance fields, array loads, array length and virtual/interface calls. Array stores and field writes as well as (useless) synchronization on locally created, non-escaping objects/arrays are also handled. Newly allocated objects/arrays returned from callees are not identified.

  7. trait L1PurityAnalysisScheduler extends FPCFAnalysisScheduler
  8. class L2PurityAnalysis extends AbstractPurityAnalysis

    An inter-procedural analysis to determine a method's purity.

    An inter-procedural analysis to determine a method's purity.

    Note

    This analysis is sound only up to the usual standards, i.e. it does not cope with VirtualMachineErrors, LinkageErrors and ReflectiveOperationExceptions and may be unsound in the presence of native code, reflection or sun.misc.Unsafe. Calls to native methods are handled soundly in general as they are considered org.opalj.br.fpcf.properties.ImpureByAnalysis, but native methods may break soundness of this analysis by invalidating assumptions such as which fields are effectively final.

    ,

    This analysis is sound even if the three address code hierarchy is not flat, it will produce better results for a flat hierarchy, though. This is because it will not assess the types of expressions other than org.opalj.tac.Vars.

    ,

    This analysis derives all purity level. A configurable org.opalj.tac.fpcf.analyses.purity.DomainSpecificRater is used to identify calls, expressions and exceptions that are LBDPure instead of LBImpure or any SideEffectFree purity level. Compared to L1PurityAnaylsis it identifies objects/arrays returned from pure callees that can be considered local. Synchronized methods are treated as ExternallyPure.

  9. trait L2PurityAnalysisScheduler extends FPCFAnalysisScheduler
  10. trait LoggingRater extends DomainSpecificRater

    Mixin that rates whether a call is part of using logging.

  11. trait SystemOutErrRater extends DomainSpecificRater

    Mixin that rates whether a call or GetStatic is part of using System.out or System.err

Value Members

  1. object EagerL1PurityAnalysis extends L1PurityAnalysisScheduler with FPCFEagerAnalysisScheduler
  2. object EagerL2PurityAnalysis extends L2PurityAnalysisScheduler with FPCFEagerAnalysisScheduler
  3. object L1PurityAnalysis
  4. object L2PurityAnalysis
  5. object LazyL1PurityAnalysis extends L1PurityAnalysisScheduler with FPCFLazyAnalysisScheduler
  6. object LazyL2PurityAnalysis extends L2PurityAnalysisScheduler with FPCFLazyAnalysisScheduler
  7. object SystemOutLoggingAllExceptionRater extends BaseDomainSpecificRater with SystemOutErrRater with LoggingRater with ExceptionRater

    Implementation of a rater that handles the use of System.out/System.err and logging as well as all exceptions

  8. object SystemOutLoggingAssertionExceptionRater extends BaseDomainSpecificRater with SystemOutErrRater with LoggingRater with AssertionExceptionRater

    Default implementation of a rater that handles the use of System.out/System.err and logging as well as some exception types typically used to assert program properties.

Ungrouped