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 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 ide
    Definition Classes
    analyses
  • package ifds
    Definition Classes
    ide
  • package problem
    Definition Classes
    ifds
  • JavaIFDSProblem

abstract class JavaIFDSProblem[Fact <: IDEFact] extends IFDSProblem[Fact, JavaStatement, Method]

Specialized IFDS problem for Java programs based on an IDE problem.

Source
JavaIFDSProblem.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavaIFDSProblem
  2. IFDSProblem
  3. IDEProblem
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JavaIFDSProblem()

Abstract Value Members

  1. abstract def getCallFlowFunction(callSite: JavaStatement, callSiteFact: Fact, calleeEntry: JavaStatement, callee: Method)(implicit propertyStore: PropertyStore): FlowFunction[Fact]

    Generate a flow function for a call flow.

    Generate a flow function for a call flow.

    callSite

    where the call flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    calleeEntry

    where the callable starts (the statement which the callable is started with)

    callee

    the callable that is called

    Definition Classes
    IDEProblem
  2. abstract def getCallToReturnFlowFunction(callSite: JavaStatement, callSiteFact: Fact, callee: Method, returnSite: JavaStatement)(implicit propertyStore: PropertyStore): FlowFunction[Fact]

    Generate a flow function for a call-to-return flow.

    Generate a flow function for a call-to-return flow.

    callSite

    where the call-to-return flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    callee

    the callable this flow is about

    returnSite

    where the call-to-return flow ends (e.g. the next statement after the call)

    Definition Classes
    IDEProblem
  3. abstract def getNormalFlowFunction(source: JavaStatement, sourceFact: Fact, target: JavaStatement)(implicit propertyStore: PropertyStore): FlowFunction[Fact]

    Generate a flow function for a normal flow.

    Generate a flow function for a normal flow.

    source

    where the normal flow starts

    sourceFact

    the fact the flow starts with

    target

    where the normal flow ends

    Definition Classes
    IDEProblem
  4. abstract def getReturnFlowFunction(calleeExit: JavaStatement, calleeExitFact: Fact, callee: Method, returnSite: JavaStatement, callSite: JavaStatement, callSiteFact: Fact)(implicit propertyStore: PropertyStore): FlowFunction[Fact]

    Generate a flow function for a return flow.

    Generate a flow function for a return flow.

    calleeExit

    where the return flow starts (the statement the callable is exited with)

    calleeExitFact

    the fact the flow starts with

    callee

    the callable that is returned from

    returnSite

    where the return flow ends (e.g. the next statement after the call in the callers code)

    callSite

    corresponding to the return flow

    callSiteFact

    corresponding to the return flow

    Definition Classes
    IDEProblem
  5. abstract val nullFact: Fact

    The null fact to use.

    The null fact to use. Also used to bootstrap the analysis at the entry points.

    Definition Classes
    IDEProblem

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. implicit def edgeFunctionToFinalEdgeFunction(edgeFunction: EdgeFunction[IFDSValue]): EdgeFunctionResult[IFDSValue]
    Definition Classes
    IDEProblem
  7. val emptyFlowFunction: EmptyFlowFunction[Fact]

    Empty flow function that can be used when implementing problems

    Empty flow function that can be used when implementing problems

    Attributes
    protected
    Definition Classes
    IDEProblem
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def getAdditionalSeeds(stmt: JavaStatement, callee: Method)(implicit propertyStore: PropertyStore): Set[Fact]

    Add additional facts that the analysis should be seeded with.

    Add additional facts that the analysis should be seeded with. Traditionally, IDE starts with the null fact at the start statements of the callable. E.g. additional seeds can be used for adding facts about the parameters of the analyzed callable.

    stmt

    the start statement

    callee

    the analyzed callable

    Definition Classes
    IDEProblem
  11. def getAdditionalSeedsEdgeFunction(stmt: JavaStatement, fact: Fact, callee: Method)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate an edge function for a flow starting with an additional seeds.

    Generate an edge function for a flow starting with an additional seeds.

    stmt

    the start statement

    fact

    the start fact

    callee

    the analyzed callable

    Definition Classes
    IDEProblem
  12. final def getCallEdgeFunction(callSite: JavaStatement, callSiteFact: Fact, calleeEntry: JavaStatement, calleeEntryFact: Fact, callee: Method)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate an edge function for a call flow.

    Generate an edge function for a call flow.

    callSite

    where the call flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    calleeEntry

    where the callable starts (the statement which the callable is started with)

    calleeEntryFact

    the fact the flow ends with

    callee

    the callable that is called

    Definition Classes
    IFDSProblemIDEProblem
  13. final def getCallToReturnEdgeFunction(callSite: JavaStatement, callSiteFact: Fact, callee: Method, returnSite: JavaStatement, returnSiteFact: Fact)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate an edge function for a call-to-return flow.

    Generate an edge function for a call-to-return flow.

    callSite

    where the call-to-return flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    callee

    the callable this flow is about

    returnSite

    where the call-to-return flow ends (e.g. the next statement after the call)

    returnSiteFact

    the fact the flow ends with

    Definition Classes
    IFDSProblemIDEProblem
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def getNormalEdgeFunction(source: JavaStatement, sourceFact: Fact, target: JavaStatement, targetFact: Fact)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate an edge function for a normal flow.

    Generate an edge function for a normal flow.

    source

    where the normal flow starts

    sourceFact

    the fact the flow starts with

    target

    where the normal flow ends

    targetFact

    the fact the flow ends with

    Definition Classes
    IFDSProblemIDEProblem
  16. def getPrecomputedFlowFunction(callSite: JavaStatement, callSiteFact: Fact, returnSite: JavaStatement)(implicit propertyStore: PropertyStore): FlowFunction[Fact]

    Generate a flow function that yields the facts that are valid when going through the unknown callable and reaching the return site.

    Generate a flow function that yields the facts that are valid when going through the unknown callable and reaching the return site. Similar to a call-to-return flow (cfg. getCallToReturnFlowFunction) but capturing the effects that flow through the possible callables.

    callSite

    where the flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    returnSite

    where the flow ends (e.g. the next statement after the call)

    Definition Classes
    IDEProblem
    Note

    In this type of precomputed flow the callable is unknown. Thus, the call-to-return flow is not applied and needs to be integrated into this flow.

  17. def getPrecomputedFlowFunction(callSite: JavaStatement, callSiteFact: Fact, callee: Method, returnSite: JavaStatement)(implicit propertyStore: PropertyStore): FlowFunction[Fact]

    Generate a flow function that yields the facts that are valid when going through the callable and reaching the return site.

    Generate a flow function that yields the facts that are valid when going through the callable and reaching the return site. Similar to a call-to-return flow (cfg. getCallToReturnFlowFunction) but capturing the effects that flow through the callable.

    callSite

    where the flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    callee

    the callable this flow is about

    returnSite

    where the flow ends (e.g. the next statement after the call)

    Definition Classes
    IDEProblem
    Note

    In this type of precomputed flow the callable is known. Thus, the call-to-return flow can be applied normally and does not need to be integrated in this flow.

  18. final def getPrecomputedSummaryFunction(callSite: JavaStatement, callSiteFact: Fact, returnSite: JavaStatement, returnSiteFact: Fact)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate a summary function from a call-site node up to a return-site node (just what summary functions are in the foundation paper, but in one step and for all callables that are possible call targets).

    Generate a summary function from a call-site node up to a return-site node (just what summary functions are in the foundation paper, but in one step and for all callables that are possible call targets).

    callSite

    where the flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    returnSite

    where the flow ends (e.g. the next statement after the call)

    returnSiteFact

    the fact the flow ends with

    Definition Classes
    IFDSProblemIDEProblem
    Note

    In this type of precomputed flow the callable is unknown. Thus, the call-to-return flow is not applied and needs to be integrated into this flow.

  19. final def getPrecomputedSummaryFunction(callSite: JavaStatement, callSiteFact: Fact, callee: Method, returnSite: JavaStatement, returnSiteFact: Fact)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate a summary function from a call-site node up to a return-site node (just what summary functions are in the foundation paper, but in one step).

    Generate a summary function from a call-site node up to a return-site node (just what summary functions are in the foundation paper, but in one step).

    callSite

    where the flow starts (always a call statement)

    callSiteFact

    the fact the flow starts with

    callee

    the callable the flow is about

    returnSite

    where the flow ends (e.g. the next statement after the call)

    returnSiteFact

    the fact the flow ends with

    Definition Classes
    IFDSProblemIDEProblem
    Note

    In this type of precomputed flow the callable is known. Thus, the call-to-return flow can be applied normally and does not need to be integrated in this flow.

  20. final def getReturnEdgeFunction(calleeExit: JavaStatement, calleeExitFact: Fact, callee: Method, returnSite: JavaStatement, returnSiteFact: Fact, callSite: JavaStatement, callSiteFact: Fact)(implicit propertyStore: PropertyStore): EdgeFunctionResult[IFDSValue]

    Generate an edge function for a return flow.

    Generate an edge function for a return flow.

    calleeExit

    where the return flow starts (the statement the callable is exited with)

    calleeExitFact

    the fact the flow starts with

    callee

    the callable that is returned from

    returnSite

    where the return flow ends (e.g. the next statement after the call in the callers code)

    returnSiteFact

    the fact the flow ends with

    callSite

    corresponding to the return flow

    callSiteFact

    corresponding to the return flow

    Definition Classes
    IFDSProblemIDEProblem
  21. final def hasPrecomputedFlowAndSummaryFunction(callSite: JavaStatement, callSiteFact: Fact, callee: Method)(implicit propertyStore: PropertyStore): Boolean

    Whether precomputed flow and summary functions for a (callSite, callSiteFact, callee) combination exist (resp.

    Whether precomputed flow and summary functions for a (callSite, callSiteFact, callee) combination exist (resp. can be generated).

    callSite

    where the flow starts

    callSiteFact

    the fact the flow starts with

    callee

    the callable this flow is about

    Definition Classes
    IFDSProblemIDEProblem
  22. def hasPrecomputedFlowFunction(callSite: JavaStatement, callSiteFact: Fact, callee: Method)(implicit propertyStore: PropertyStore): Boolean

    Whether precomputed flow functions for a (callSite, callSiteFact, callee) combination exist (resp.

    Whether precomputed flow functions for a (callSite, callSiteFact, callee) combination exist (resp. can be generated).

    callSite

    where the flow starts

    callSiteFact

    the fact the flow starts with

    callee

    the callable this flow is about

    Definition Classes
    IFDSProblem
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final val lattice: MeetLattice[IFDSValue]

    The lattice that orders the used values

    The lattice that orders the used values

    Definition Classes
    IFDSProblemIDEProblem
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. 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 IFDSProblem[Fact, JavaStatement, Method]

Inherited from IDEProblem[Fact, IFDSValue, JavaStatement, Method]

Inherited from AnyRef

Inherited from Any

Ungrouped