Packages

t

org.opalj.tac.fpcf.analyses.escape

AbstractEscapeAnalysis

trait AbstractEscapeAnalysis extends FPCFAnalysis

An abstract escape analysis for a org.opalj.tac.common.DefinitionSiteLike or a org.opalj.br.analyses.VirtualFormalParameter. The entity and all other information required by the analyses such as the defSite, uses or the code correspond to this entity are given as AbstractEscapeAnalysisContext.

It is assumed that the tac code has a flat hierarchy, i.e. it is real three address code.

The control-flow is intended to be: Client calls determineEscape. This method extracts the information for the given entity and calls doDetermineEscape.

Source
AbstractEscapeAnalysis.scala
Linear Supertypes
FPCFAnalysis, ProjectBasedAnalysis, AnyRef, Any
Known Subclasses
AbstractInterProceduralEscapeAnalysis, ConfigurationBasedConstructorEscapeAnalysis, ConstructorSensitiveEscapeAnalysis, DefaultEscapeAnalysis, ExceptionAwareEscapeAnalysis, InterProceduralEscapeAnalysis, SimpleEscapeAnalysis, SimpleFieldAwareEscapeAnalysis
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractEscapeAnalysis
  2. FPCFAnalysis
  3. ProjectBasedAnalysis
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type AnalysisContext <: AbstractEscapeAnalysisContext
  2. abstract type AnalysisState <: AbstractEscapeAnalysisState

Abstract Value Members

  1. abstract def createContext(entity: (Context, Entity), defSitePC: ValueOrigin, targetMethod: Method): AnalysisContext
    Attributes
    protected[this]
  2. abstract def createState: AnalysisState
    Attributes
    protected[this]
  3. abstract def determineEscapeOfFP(fp: (Context, VirtualFormalParameter)): ProperPropertyComputationResult
    Attributes
    protected[this]
  4. abstract def handleArrayStore(arrayStore: ArrayStore[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    Same as handlePutField.

    Same as handlePutField.

    Attributes
    protected[this]
  5. abstract def handleInvokedynamicFunctionCall(call: InvokedynamicFunctionCall[V], hasAssignment: Boolean)(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  6. abstract def handleInvokedynamicMethodCall(call: InvokedynamicMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit
    Attributes
    protected[this]
  7. abstract def handleNonVirtualAndNonConstructorCall(call: NonVirtualMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit
    Attributes
    protected[this]
  8. abstract def handleNonVirtualFunctionCall(call: NonVirtualFunctionCall[V], hasAssignment: Boolean)(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  9. abstract def handleOtherKindsOfExpressions(expr: Expr[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    All basic analyses only care about function calls for org.opalj.tac.Assignment or org.opalj.tac.ExprStmt, but if a future analysis requires handling other expressions, it can override this method.

    All basic analyses only care about function calls for org.opalj.tac.Assignment or org.opalj.tac.ExprStmt, but if a future analysis requires handling other expressions, it can override this method.

    Attributes
    protected[this]
  10. abstract def handleParameterOfConstructor(call: NonVirtualMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit
    Attributes
    protected[this]
  11. abstract def handlePutField(putField: PutField[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    Putting an entity into a field can lead to an escape if the base of that field escapes or let its field escape.

    Putting an entity into a field can lead to an escape if the base of that field escapes or let its field escape.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  12. abstract def handleStaticFunctionCall(call: StaticFunctionCall[V], hasAssignment: Boolean)(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  13. abstract def handleStaticMethodCall(call: StaticMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  14. abstract def handleThisLocalOfConstructor(call: NonVirtualMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit
    Attributes
    protected[this]
  15. abstract def handleThrow(aThrow: Throw[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    Thrown exceptions that are not caught would lead to a org.opalj.br.fpcf.properties.EscapeViaAbnormalReturn.

    Thrown exceptions that are not caught would lead to a org.opalj.br.fpcf.properties.EscapeViaAbnormalReturn. This analysis does not check whether the exception is caught or not.

    Attributes
    protected[this]
    See also

    org.opalj.tac.fpcf.analyses.escape.ExceptionAwareEscapeAnalysis which overrides this very simple behavior.

  16. abstract def handleVirtualFunctionCall(call: VirtualFunctionCall[V], hasAssignment: Boolean)(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  17. abstract def handleVirtualMethodCall(call: VirtualMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  18. abstract val project: SomeProject
    Definition Classes
    ProjectBasedAnalysis

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 analyzeTAC()(implicit context: AnalysisContext, state: AnalysisState): ProperPropertyComputationResult

    Analyzes each TAC statement of the given method.

    Analyzes each TAC statement of the given method. This methods assumes that there is at least an intermediate result for the TAC present.

    Attributes
    protected[this]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def c(someEPS: SomeEPS)(implicit context: AnalysisContext, state: AnalysisState): ProperPropertyComputationResult

    A continuation function, that handles the updates of property values for entity other.

    A continuation function, that handles the updates of property values for entity other.

    Attributes
    protected[this]
  7. final def ch: ClassHierarchy
    Definition Classes
    ProjectBasedAnalysis
  8. implicit final def classHierarchy: ClassHierarchy
    Definition Classes
    ProjectBasedAnalysis
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. implicit val declaredMethods: DeclaredMethods
    Attributes
    protected[this]
  11. def determineEscape(e: Entity): ProperPropertyComputationResult

    Extracts information from the given entity and should call doDetermineEscape afterwards.

    Extracts information from the given entity and should call doDetermineEscape afterwards. For some entities a result might be returned immediately.

  12. def determineEscapeOfDS(dsl: (Context, DefinitionSiteLike)): ProperPropertyComputationResult
    Attributes
    protected[this]
  13. def doDetermineEscape(implicit context: AnalysisContext, state: AnalysisState): ProperPropertyComputationResult

    Retrieves the TAC and starts the analysis, if there is already a (intermediate) version of it.

    Retrieves the TAC and starts the analysis, if there is already a (intermediate) version of it. Otherwise, continue when a TAC is available.

    Attributes
    protected[this]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. def handleAssignment(assignment: Assignment[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    org.opalj.tac.Assignments can contain function calls, so they have to handle them.

    org.opalj.tac.Assignments can contain function calls, so they have to handle them.

    Attributes
    protected[this]
  18. def handleExprStmt(exprStmt: ExprStmt[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    org.opalj.tac.ExprStmt can contain function calls, so they have to handle them.

    org.opalj.tac.ExprStmt can contain function calls, so they have to handle them.

    Attributes
    protected[this]
  19. def handleExpression(expr: Expr[V], hasAssignment: Boolean)(implicit context: AnalysisContext, state: AnalysisState): Unit

    Currently, the only expressions that can lead to an escape are the different kinds of function calls.

    Currently, the only expressions that can lead to an escape are the different kinds of function calls. So this method delegates to them. In the case of another expression org.opalj.tac.fpcf.analyses.escape.AbstractEscapeAnalysis.handleOtherKindsOfExpressions will be called.

    Attributes
    protected[this]
  20. def handleNonVirtualMethodCall(call: NonVirtualMethodCall[V])(implicit context: AnalysisContext, state: AnalysisState): Unit

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    Passing an entity as argument to a call, will make the entity at most org.opalj.br.fpcf.properties.EscapeInCallee.

    This analysis only uses intra-procedural knowledge and does not take the behavior of the called method(s) into consideration.

    Attributes
    protected[this]
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. implicit final def logContext: LogContext
    Definition Classes
    ProjectBasedAnalysis
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. implicit final def p: SomeProject
    Definition Classes
    ProjectBasedAnalysis
  28. implicit final val propertyStore: PropertyStore
    Definition Classes
    FPCFAnalysis
  29. final def ps: PropertyStore
    Definition Classes
    FPCFAnalysis
  30. def returnResult(implicit context: AnalysisContext, state: AnalysisState): ProperPropertyComputationResult

    This method is called, after the entity has been analyzed.

    This method is called, after the entity has been analyzed. If there is no dependee left or the entity escapes globally, the result is returned directly. Otherwise, the maybe version of the current escape state is returned as org.opalj.fpcf.InterimResult.

    Attributes
    protected[this]
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. implicit val typeIterator: TypeIterator
    Attributes
    protected[this]
  34. lazy val virtualFormalParameters: VirtualFormalParameters
    Attributes
    protected[this]
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. 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 FPCFAnalysis

Inherited from ProjectBasedAnalysis

Inherited from AnyRef

Inherited from Any

Ungrouped