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 purity
    Definition Classes
    analyses
  • class L2PurityAnalysis extends AbstractPurityAnalysis

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

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

    Definition Classes
    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.

  • AnalysisState
  • State

class State extends AnalysisState

Holds the state of this analysis.

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

Instance Constructors

  1. new State(method: Method, context: Context, declClass: ObjectType, tac: TACode[TACMethodParameter, L2PurityAnalysis.V] = null, lbPurity: Purity = CompileTimePure, ubPurity: Purity = CompileTimePure)

    method

    The currently analyzed method

    context

    The corresponding Context we report results for

    declClass

    The declaring class of the currently analyzed method

    lbPurity

    The current minimum purity level for the method

    ubPurity

    The current maximum purity level for the method that will be assigned by checkPurityOfX methods to aggregrate the purity

Value Members

  1. def addClassImmutabilityDependee(t: ObjectType, eop: EOptionP[ObjectType, ClassImmutability], value: Expr[L2PurityAnalysis.V]): Unit
  2. def addFieldAssingabilityDependee(f: Field, eop: EOptionP[Field, FieldAssignability], owner: Option[Expr[L2PurityAnalysis.V]]): Unit
  3. def addFieldLocalityDependee(f: Field, eop: EOptionP[Field, FieldLocality], data: (Expr[L2PurityAnalysis.V], Purity)): Unit
  4. def addPurityDependee(context: Context, eop: EOptionP[Context, Purity], params: Seq[Expr[L2PurityAnalysis.V]]): Unit
  5. def addRVFDependee(context: Context, eop: EOptionP[Context, ReturnValueFreshness], data: (Option[Expr[L2PurityAnalysis.V]], Purity)): Unit
  6. def addTypeImmutabilityDependee(t: ObjectType, eop: EOptionP[ObjectType, TypeImmutability], value: Expr[L2PurityAnalysis.V]): Unit
  7. var callees: Option[Callees]
  8. var calleesDependee: Option[EOptionP[DeclaredMethod, Callees]]
  9. var classImmutabilityDependees: Map[ObjectType, (EOptionP[ObjectType, ClassImmutability], Set[Expr[L2PurityAnalysis.V]])]
  10. val context: Context
    Definition Classes
    State → AnalysisState
  11. val declClass: ObjectType
    Definition Classes
    State → AnalysisState
  12. def dependees: Set[SomeEOptionP]
  13. var fieldAssignabilityDependees: Map[Field, (EOptionP[Field, FieldAssignability], Set[Option[Expr[L2PurityAnalysis.V]]])]
  14. var fieldLocalityDependees: Map[Field, (EOptionP[Field, FieldLocality], Set[(Expr[L2PurityAnalysis.V], Purity)])]
  15. var lbPurity: Purity
    Definition Classes
    State → AnalysisState
  16. val method: Method
    Definition Classes
    State → AnalysisState
  17. var purityDependees: Map[Context, (EOptionP[Context, Purity], Set[Seq[Expr[L2PurityAnalysis.V]]])]
  18. def removeClassImmutabilityDependee(t: ObjectType): Unit
  19. def removeFieldAssignabilityDependee(f: Field): Unit
  20. def removeFieldLocalityDependee(f: Field): Unit
  21. def removePurityDependee(context: Context): Unit
  22. def removeRVFDependee(context: Context): Unit
  23. def removeTypeImmutabilityDependee(t: ObjectType): Unit
  24. var rvfCallSites: IntMap[(Option[Expr[L2PurityAnalysis.V]], Purity)]
  25. var rvfDependees: Map[Context, (EOptionP[Context, ReturnValueFreshness], Set[(Option[Expr[L2PurityAnalysis.V]], Purity)])]
  26. var staticDataUsage: Option[EOptionP[DeclaredMethod, StaticDataUsage]]
  27. var tac: TACode[TACMethodParameter, L2PurityAnalysis.V]
    Definition Classes
    State → AnalysisState
  28. var tacai: Option[EOptionP[Method, properties.TACAI]]
  29. var typeImmutabilityDependees: Map[ObjectType, (EOptionP[ObjectType, TypeImmutability], Set[Expr[L2PurityAnalysis.V]])]
  30. var ubPurity: Purity
    Definition Classes
    State → AnalysisState
  31. def updateCalleesDependee(eps: EOptionP[DeclaredMethod, Callees]): Unit
  32. def updateStaticDataUsage(eps: Option[EOptionP[DeclaredMethod, StaticDataUsage]]): Unit
  33. def updateTacai(eps: EOptionP[Method, properties.TACAI]): Unit