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 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 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.
      • ...
    • 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 l2
    Definition Classes
    domain
  • CalledMethodsStore
  • ChildDefaultDomain
  • ChildPerformInvocationsWithRecursionDetection
  • CoordinatingValuesDomain
  • DefaultDomain
  • DefaultPerformInvocationsDomain
  • DefaultPerformInvocationsDomainWithCFG
  • DefaultPerformInvocationsDomainWithCFGAndDefUse
  • PerformInvocations
  • PerformInvocationsWithRecursionDetection
  • SharedDefaultDomain
  • SharedValuesDomain
t

org.opalj.ai.domain.l2

PerformInvocations

trait PerformInvocations extends MethodCallsHandling

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PerformInvocations
  2. MethodCallsHandling
  3. MethodCallsDomain
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type CalledMethodDomain <: TargetDomain with MethodCallResults
  2. type MethodCallResult = Computation[(PerformInvocations.this)#DomainValue, (PerformInvocations.this)#ExceptionValues]
    Definition Classes
    MethodCallsDomain

Abstract Value Members

  1. abstract def calledMethodAI: AI[_ >: (PerformInvocations.this)#CalledMethodDomain]

    The abstract interpreter that will be used for the abstract interpretation.

  2. abstract def calledMethodDomain(method: Method): (PerformInvocations.this)#CalledMethodDomain

    The domain that will be used to perform the abstract interpretation of the called method.

    The domain that will be used to perform the abstract interpretation of the called method.

    In general, explicit support is required to identify recursive calls if the domain also follows method invocations.

    Attributes
    protected[this]
  3. abstract def invokedynamic(pc: Int, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult
    Definition Classes
    MethodCallsDomain
  4. abstract def shouldInvocationBePerformed(method: Method): Boolean

    Returns true if the given method should be invoked.

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. def MethodCallResult(potentialExceptions: Iterable[(PerformInvocations.this)#ExceptionValue]): (PerformInvocations.this)#MethodCallResult

    Factory method called to create a MethodCallResult.

    Factory method called to create a MethodCallResult.

    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  5. def MethodCallResult(returnValue: (PerformInvocations.this)#DomainValue, exceptions: Iterable[(PerformInvocations.this)#ExceptionValue]): (PerformInvocations.this)#MethodCallResult

    Factory method called to create a MethodCallResult.

    Factory method called to create a MethodCallResult.

    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def doInvoke(pc: Int, method: Method, operands: (PerformInvocations.this)#Operands, fallback: () => (PerformInvocations.this)#MethodCallResult): (PerformInvocations.this)#MethodCallResult

    Performs the invocation of the given method using the given operands.

    Performs the invocation of the given method using the given operands.

    Attributes
    protected[this]
  9. def doInvoke(method: Method, calledMethodDomain: (PerformInvocations.this)#CalledMethodDomain)(parameters: CalledMethodDomain.Locals): AIResult { val domain: calledMethodDomain.type }
    Attributes
    protected[this]
  10. def doInvokeNonVirtual(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, descriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands, fallback: () => (PerformInvocations.this)#MethodCallResult): (PerformInvocations.this)#MethodCallResult
    Attributes
    protected[this]
  11. def doInvokeVirtual(pc: Int, declaringClass: ReferenceType, isInterface: Boolean, name: String, descriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands, fallback: () => (PerformInvocations.this)#MethodCallResult): (PerformInvocations.this)#MethodCallResult

    The default implementation only supports the case where we can precisely resolve the target.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. def getPotentialExceptions(pc: Int): List[(PerformInvocations.this)#ExceptionValue]
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  16. def handleInstanceBasedInvoke(pc: Int, methodDescriptor: MethodDescriptor, targetMethods: Set[Method], receiverIsNull: Answer, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult

    methodDescriptor

    The method descriptor as specified by the invoke instruction. In case of the invocation of a signature polymorphic method using org.opalj.br.instructions.INVOKEVIRTUAL the descriptor of the invoked method may differ from the descriptor used by the method. Nevertheless, the MethodCallResult has to satisfy the requirements of the caller. In particular regarding the return type.

    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  17. def handleInstanceBasedInvoke(pc: Int, methodDescriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  18. def handleInstanceBasedInvoke(pc: Int, methodDescriptor: MethodDescriptor, receiverIsNull: Answer): (PerformInvocations.this)#MethodCallResult
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  19. def handleInvoke(pc: Int, methodDescriptor: MethodDescriptor): (PerformInvocations.this)#MethodCallResult
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def invokeinterface(pc: Int, declaringClass: ObjectType, name: String, descriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult
  22. def invokespecial(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, descriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult
  23. def invokestatic(pc: Int, declaringClass: ObjectType, isInterface: Boolean, name: String, descriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult

    For those invokestatic calls for which we have no concrete method (e.g., the respective class file was never loaded or the method is native) or if we have a recursive invocation, the super implementation is called.

    For those invokestatic calls for which we have no concrete method (e.g., the respective class file was never loaded or the method is native) or if we have a recursive invocation, the super implementation is called.

    Definition Classes
    PerformInvocationsMethodCallsDomain
  24. def invokevirtual(pc: Int, declaringClass: ReferenceType, name: String, descriptor: MethodDescriptor, operands: (PerformInvocations.this)#Operands): (PerformInvocations.this)#MethodCallResult
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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 testAndDoInvoke(pc: Int, method: Method, operands: (PerformInvocations.this)#Operands, fallback: () => (PerformInvocations.this)#MethodCallResult): (PerformInvocations.this)#MethodCallResult
    Attributes
    protected[this]
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def transformResult(callerPC: Int, calledMethod: Method, originalOperands: (PerformInvocations.this)#Operands, calledMethodDomain: (PerformInvocations.this)#CalledMethodDomain)(passedParameters: CalledMethodDomain.Locals, result: AIResult { val domain: calledMethodDomain.type }): (PerformInvocations.this)#MethodCallResult

    Converts the results (DomainValues) of the evaluation of the called method into the calling domain.

    Converts the results (DomainValues) of the evaluation of the called method into the calling domain.

    If the returned value is one of the parameters (determined using reference identity), then the parameter is mapped back to the original operand.

    Attributes
    protected[this]
  33. def useExceptionsThrownByCalledMethod: Boolean

    If true the exceptions thrown by the called method will be used during the evaluation of the calling method.

  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. 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

Inherited from MethodCallsHandling

Inherited from MethodCallsDomain

Inherited from AnyRef

Inherited from Any

Ungrouped