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 - 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 ifds
    Definition Classes
    opalj
  • AbstractIFDSFact
  • AbstractIFDSNullFact
  • Dependees
  • IFDSAnalysis
  • IFDSAnalysisScheduler
  • IFDSFact
  • IFDSProblem
  • IFDSProperty
  • IFDSPropertyMetaInformation
  • IFDSState
  • PathEdges
  • Statistics
c

org.opalj.ifds

IFDSProblem

abstract class IFDSProblem[Fact <: AbstractIFDSFact, C <: AnyRef, S, ICFG <: ICFG[S, C]] extends AnyRef

A framework for IFDS analyses.

Fact

The type of flow facts, which are tracked by the concrete analysis.

Source
IFDSProblem.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
JavaBackwardIFDSProblem, JavaForwardIFDSProblem, JavaIFDSProblem, AbstractJavaForwardTaintProblem, JavaBackwardTaintProblem
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IFDSProblem
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IFDSProblem(icfg: ICFG)

Type Members

  1. type OutsideAnalysisContextCallHandler = (S, Option[S], Fact, Seq[C], Getter) => Set[Fact] { def apply(call: S, successor: Option[S], in: Fact, unbCallChain: Seq[C], dependeesGetter: org.opalj.ifds.Dependees.Getter): Set[Fact] }
  2. type OutsideAnalysisContextUnbReturnHandler = (C, Fact, Seq[C], Getter) => Unit { def apply(callee: C, in: Fact, callChain: Seq[C], dependeesGetter: org.opalj.ifds.Dependees.Getter): Unit }

Abstract Value Members

  1. abstract def callFlow(start: S, in: Fact, call: S, callee: C): Set[Fact]

    Computes the data flow for a call to start edge.

    Computes the data flow for a call to start edge. The start node depends on the analysis direction (forward: entry of callee, backward: an exit/return statement).

    start

    The statement, which starts the analysis of the 'callee'.

    in

    The fact which holds before the execution of the call.

    call

    The statement, which called the callee.

    callee

    The called method, for which the data flow shall be computed.

    returns

    The facts, which hold after the execution of call under the assumption that the fact in held before call and call calls callee.

  2. abstract def callToReturnFlow(call: S, in: Fact, successor: Option[S], unbCallChain: Seq[C]): Set[Fact]

    Computes the data flow for a call to return edge.

    Computes the data flow for a call to return edge.

    call

    The statement, which invoked the call.

    in

    The facts, which hold before the call.

    unbCallChain

    The current call chain of unbalanced returns.

    returns

    The facts, which hold after the call independently of what happens in the callee under the assumption that in held before call.

  3. abstract def createFlowFactAtExit(callee: C, in: Fact, unbalancedCallChain: Seq[C]): Option[Fact]

    Called, when new FlowFacts are found at the analysis exit of a method.

    Called, when new FlowFacts are found at the analysis exit of a method. Creates a FlowFact in the callee context if necessary.

    callee

    The callee.

    in

    The newly found facts.

    unbalancedCallChain

    the current call chain.

    returns

    Some FlowFact, if necessary. Otherwise None.

  4. abstract def entryPoints: Seq[(C, IFDSFact[Fact, C, S])]

    The entry points of this analysis.

  5. abstract def needsPredecessor(statement: S): Boolean
  6. abstract def normalFlow(statement: S, in: Fact, predecessor: Option[S]): Set[Fact]

    Computes the data flow for a normal statement.

    Computes the data flow for a normal statement.

    statement

    The analyzed statement.

    in

    The fact which holds before the execution of the statement.

    predecessor

    The predecessor of the analyzed statement, for which the data flow shall be computed. Used for phi statements to distinguish the flow.

    returns

    The facts, which hold after the execution of statement under the assumption that the facts in in held before statement and successor will be executed next.

  7. abstract def nullFact: Fact

    The null fact of this analysis.

  8. abstract def outsideAnalysisContextCall(callee: C): Option[OutsideAnalysisContextCallHandler]

    Checks, if a callee is outside this analysis' context.

    Checks, if a callee is outside this analysis' context. By default, native methods are not inside the analysis context. For callees outside this analysis' context the returned handler is called to compute the summary edge for the call instead of analyzing the callee.

    callee

    The method called by call.

    returns

    The handler function. It receives the statement which invoked the call, the successor statement, which will be executed after the call and the set of input facts which hold before the call. It returns facts, which hold after the call, excluding the call to return flow.

  9. abstract def outsideAnalysisContextUnbReturn(callee: C): Option[OutsideAnalysisContextUnbReturnHandler]

    Checks if there are unbalanced returns outside this analysis' context.

    Checks if there are unbalanced returns outside this analysis' context. For unbalanced returns outside this analysis' context the returned handler is called to compute the return edge and trigger the callers' analyses.

    callee

    the method from which an unbalanced return is performed.

    returns

    the handler function. It receives the callee, the input fact, the existing call chain before this unbalanced return.

  10. abstract def returnFlow(exit: S, in: Fact, call: S, successor: Option[S], unbCallChain: Seq[C]): Set[Fact]

    Computes the data flow for an exit to return edge.

    Computes the data flow for an exit to return edge. The exit node depends on the analysis direction (forward: an exit/return statement, backward: entry of callee).

    exit

    The statement, which terminated the analysis of the callee.

    in

    The fact which holds before the execution of the exit.

    call

    The statement, which called the callee.

    successor

    The successor statement of the call, might be None if unbalanced return.

    unbCallChain

    The current call chain of unbalanced returns.

    returns

    The facts, which hold after the execution of exit in the caller's context under the assumption that in held before the execution of exit and that successor will be executed next.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def automaticallyPropagateNullFactInFlowFunctions: Boolean

    returns

    Whether the null Fact is automatically added to the result of every flow function where it is passed into

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def enableUnbalancedReturns: Boolean

    returns

    Whether the analysis should follow unbalanced return flows (return of a method for which no matching previous call was processed).

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. val icfg: ICFG
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. def shouldPerformUnbalancedReturn(source: (C, IFDSFact[Fact, C, S])): Boolean

    Whether at this exit of a function, an unbalanced return should be performed.

    Whether at this exit of a function, an unbalanced return should be performed. Only if enableUnbalancedReturns == true.

    source

    the source fact of the analysis of the current function.

    returns

    true if an unbalanced return should be performed.

  18. def subsumeFacts: Boolean

    returns

    Whether to try to subsume new facts under existing facts and save graph edges

  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. 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
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped