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. Furthermore, the concrete data-structure is always considered an implementation detail and may change at any time.

    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
  • package dataflow

    Supports the specification and solving of data-flow problems.

    Supports the specification and solving of data-flow problems.

    Goal

    To be able to express data-flow problems at a very high-level of abstraction. I.e., that some information flows or not-flows from a well-identified source to a well-identified sink.

    Usage Scenario

    • We want to avoid that information is stored in the database/processed by the backend without being sanitized.
    • We want to specify that certain information is not allowed to flow from one module to another module.

    Concept

    1. Select sources
      1. Sources are parameters passed to methods (e.g., doPost(session : Session) (This covers the main method as well as typical callback methods.)
      2. Values returned by methods (e.g., System.in.read) (here, we identify the call site)
    2. Select sinks
      1. A sink is either a field (in which the value is stored)
      2. a method (parameter) which is passed the value
    3. Filtering (Terminating) data-flows
      1. If a specific operation was performed, e.g.,
      2. If a comparison (e.g., against null, > 0 , ...)
      3. An instanceOf/a checkcast
      4. A mathematical operation (e.g. +.-,...)
      5. [OPTIMIZATION] If the value was passed to a specific method (e.g., check(x : X) - throws Exception if the check fails)
      6. [OPTIMIZATION] If the value was returned by a well-identified method (e.g., String sanitized = s.replace(...,...))

    4. Extending data-flows (Side Channels)

    • OPEN: What would be the general strategy if a value influences another value?
    • [SIDE CHANNELS?] What happens if the value is stored in a field of an object and that object is used?
    • [SIDE CHANNELS?] What happens if the value is used during the computation, but does not (directly) influence the output. (e.g., if(x == 0) 1; else 2;

    Furthermore, the framework will automatically handle taint propagation and aliasing. I.e., a tainted value that is stored in a field automatically marks the respective field as tainted.

    Definition Classes
    ai
  • package domain

    This package contains definitions of common domains that can be used for the implementation of analyses.

    This package contains definitions of common domains that can be used for the implementation of analyses.

    Types of Domains

    In general, we distinguish two types of domains. First, domains that define a general interface (on top of the one defined by Domain), but do not directly provide an implementation. Hence, whenever you develop a new Domain you should consider implementing/using these domains to maximize reusability. Second, Domains that implement a specific interface (trait). In this case, we further distinguish between domains that provide a default implementation (per interface only one of these Domains can be used to create a final Domain) and those that can be stacked and basically refine the overall functionality.

    Examples

    • Domains That Define a General Interface
      • Origin defines two types which domains that provide information abou the origin of a value should consider to implement.
      • TheProject defines a standard mechanism how a domain can access the current project.
      • TheClassHierarchy defines a standard mechanism how to get the project's class hierarchy.
      • ...
    • Domains That Provide a Default Implementation
    • Domains That Implement Stackable Functionality
      • org.opalj.ai.domain.RecordThrownExceptions records information about all uncaught exceptions by intercepting a Domain's respective methods. However, it does provide a default implementation. Hence, a typical pattern is:
    class MyDomain extends Domain with ...
        with DefaultHandlingOfMethodResults with RecordThrownExceptions

    Thread Safety

    Unless explicitly documented, a domain is never thread-safe. The general programming model is to use one Domain object per code block/method and therefore, thread-safety is not required for Domains that are used for the evaluation of methods. However domains that are used to adapt/transfer values should be thread safe (see org.opalj.ai.domain.ValuesCoordinatingDomain for further details).

    Definition Classes
    ai
  • package jdkbug

    Contains definitions that are used by the elements specified in JDKBugs

    Contains definitions that are used by the elements specified in JDKBugs

    Definition Classes
    ai
  • package project
    Definition Classes
    ai
  • package tutorial
    Definition Classes
    ai
  • package util

    Common utility functionality.

    Common utility functionality.

    Definition Classes
    ai
  • AI
  • AIAborted
  • AICompleted
  • AIException
  • AIResult
  • AIResultBuilder
  • AITracer
  • BaseAI
  • BoundedInterruptableAI
  • CTC1
  • CTC2
  • CipherGetInstanceStringUsage
  • Computation
  • ComputationFailed
  • ComputationWithException
  • ComputationWithResult
  • ComputationWithResultAndException
  • ComputationWithSideEffectOnly
  • ComputationWithSideEffectOrException
  • ComputedValue
  • ComputedValueOrException
  • Configuration
  • CoreDomainFunctionality
  • CorrelationalDomain
  • CorrelationalDomainSupport
  • CountingAI
  • CustomInitialization
  • Domain
  • DomainException
  • DoubleValuesDomain
  • DoubleValuesFactory
  • ExceptionUsage
  • ExceptionUsageAnalysisDomain
  • ExceptionsFactory
  • ExceptionsRaisedByCalledMethods
  • FieldAccessesDomain
  • FloatValuesDomain
  • FloatValuesFactory
  • GlobalLogContextProvider
  • IdentityBasedCorrelationChangeDetection
  • InfiniteRecursion
  • InfiniteRecursions
  • InfiniteRecursionsDomain
  • InstructionCountBoundedAI
  • IntegerRangeValuesFactory
  • IntegerValuesDomain
  • IntegerValuesFactory
  • InterpretationFailedException
  • InterruptableAI
  • JoinStabilization
  • LogContextProvider
  • LongValuesDomain
  • LongValuesFactory
  • MetaInformationUpdate
  • MetaInformationUpdateType
  • MethodCallInformation
  • MethodCallsDomain
  • MethodsThatAlwaysReturnAPassedParameter
  • MonitorInstructionsDomain
  • MultiTracer
  • NoUpdate
  • NoUpdateType
  • PrimitiveValuesConversionsDomain
  • ReferenceValuesDomain
  • ReferenceValuesFactory
  • ReturnInstructionsDomain
  • SomeUpdate
  • StructuralUpdate
  • StructuralUpdateType
  • SubroutinesDomain
  • TheAI
  • TheClassHierarchy
  • TheCodeStructure
  • TheMemoryLayout
  • ThrowsException
  • TimeBoundedAI
  • TypedValuesFactory
  • Update
  • UpdateType
  • UsageKind
  • UselessComputation
  • UselessComputations
  • UselessComputationsMinimal
  • ValuesDomain

sealed abstract class AICompleted extends AIResult

Encapsulates the final result of the successful abstract interpretation of a method.

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

Abstract Value Members

  1. abstract val cfJoins: IntTrieSet

    The instructions where two or more control flow paths join.

    The instructions where two or more control flow paths join.

    Definition Classes
    AIResult
    Note

    This information could be recomputed on-demand but is stored for performance reasons.

    See also

    org.opalj.br.Code.cfPCs, org.opalj.br.Code.cfJoins, org.opalj.br.Code.predecessorPCs

  2. abstract val code: Code

    The code for which the abstract interpretation was performed.

    The code for which the abstract interpretation was performed.

    Definition Classes
    AIResult
  3. abstract val domain: Domain

    The domain object that was used to perform the abstract interpretation.

    The domain object that was used to perform the abstract interpretation.

    Definition Classes
    AIResult
  4. abstract val evaluatedPCs: IntArrayStack

    The list of evaluated instructions ordered by the evaluation time; subroutines are identified using the SUBROUTINE marker ids.

    The list of evaluated instructions ordered by the evaluation time; subroutines are identified using the SUBROUTINE marker ids.

    Definition Classes
    AIResult
  5. abstract val liveVariables: LiveVariables

    The set of statically known live Variables.

    The set of statically known live Variables.

    Definition Classes
    AIResult
  6. abstract val localsArray: Domain.LocalsArray

    The values stored in the registers.

    The values stored in the registers.

    For those instructions that were never executed (potentially dead code if the abstract interpretation succeeded) the locals array will be empty (the value will be null).

    Definition Classes
    AIResult
  7. abstract val memoryLayoutBeforeSubroutineCall: Chain[(Int, Domain.OperandsArray, Domain.LocalsArray)]

    Contains the memory layout before the call to a subroutine.

    Contains the memory layout before the call to a subroutine. This list is empty if the abstract interpretation completed successfully.

    Definition Classes
    AIResult
  8. abstract val operandsArray: Domain.OperandsArray

    The array of the operand lists in effect before the execution of the instruction with the respective program counter.

    The array of the operand lists in effect before the execution of the instruction with the respective program counter.

    For those instructions that were never executed (potentially dead code if the abstract interpretation succeeded) the operands array will be empty (the value will be null).

    Definition Classes
    AIResult
  9. abstract def restartInterpretation(ai: AI[_ >: domain.type]): AIResult
  10. abstract val subroutinesLocalsArray: Domain.LocalsArray

    Contains the memory layout related to the method's subroutines (if any).

    Contains the memory layout related to the method's subroutines (if any).

    Definition Classes
    AIResult
    Note

    This value is null if the method does not have subroutines (Java 6 and newer class files never contain subroutines) or if no subroutine was analyzed so far.

  11. abstract val subroutinesOperandsArray: Domain.OperandsArray

    Contains the memory layout related to the method's subroutines (if any).

    Contains the memory layout related to the method's subroutines (if any).

    Definition Classes
    AIResult
    Note

    This value is null if the method does not have subroutines (Java 6 and newer class files never contain subroutines) or if no subroutine was analyzed so far.

  12. abstract val subroutinesWereEvaluated: Boolean

    True if and only if a subroutine (JSR) was actually evaluated.

    True if and only if a subroutine (JSR) was actually evaluated.

    Definition Classes
    AIResult

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. lazy val evaluatedInstructions: BitSet

    Returns the information whether an instruction with a specific PC was evaluated at least once.

    Returns the information whether an instruction with a specific PC was evaluated at least once.

    Definition Classes
    AIResult
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def stateToString: String

    Textual representation of the state encapsulated by this result.

    Textual representation of the state encapsulated by this result.

    Definition Classes
    AICompletedAIResult
  17. lazy val subroutinePCs: IntArraySet

    Returns all instructions that belong to a subroutine.

    Returns all instructions that belong to a subroutine.

    Definition Classes
    AIResult
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  23. def wasAborted: Boolean

    Returns true if the abstract interpretation was aborted.

    Returns true if the abstract interpretation was aborted.

    Definition Classes
    AICompletedAIResult
  24. final def wasEvaluated(pc: Int): Boolean

    Returns true if the instruction with the given pc was evaluated at least once.

    Returns true if the instruction with the given pc was evaluated at least once.

    This operation is much more efficient than performing an exists check on the list of evaluated instructions!

    Definition Classes
    AIResult
    Annotations
    @inline()
  25. val worklist: Chain[Int]

    The list of instructions that need to be interpreted next.

    The list of instructions that need to be interpreted next. This list is empty if the abstract interpretation succeed.

    Definition Classes
    AICompletedAIResult

Inherited from AIResult

Inherited from AnyRef

Inherited from Any

Ungrouped