trait AbstractPurityAnalysis extends FPCFAnalysis
Base trait for analyses that analyze the purity of methods.
Provides types and methods needed for purity analyses.
- Alphabetic
- By Inheritance
- AbstractPurityAnalysis
- FPCFAnalysis
- ProjectBasedAnalysis
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait AnalysisState extends AnyRef
The state of the analysis.
The state of the analysis. Analyses are expected to extend this trait with the information they need.
lbPurity - The current minimum possible purity level for the method ubPurity - The current maximum purity level for the method method - The currently analyzed method context - The corresponding Context to report results for declClass - The declaring class of the currently analyzed method code - The code of the currently analyzed method
- abstract type StateType <: AnalysisState
- type V = DUVar[ValueInformation]
The type of the TAC domain.
Abstract Value Members
- abstract def checkMethodPurity(ep: EOptionP[Context, Purity], params: Seq[Expr[V]] = Seq.empty)(implicit state: StateType): Boolean
Examines the influence of the purity property of a method on the examined method's purity.
Examines the influence of the purity property of a method on the examined method's purity.
- Note
Adds dependendies when necessary.
- abstract def determinePurity(context: Context): ProperPropertyComputationResult
Determines the purity of the given method.
Determines the purity of the given method.
- context
A method call context
- abstract def handleCalleesUpdate(callees: EOptionP[DeclaredMethod, Callees])(implicit state: StateType): Unit
Handles what to do when the set of potential callees changes.
Handles what to do when the set of potential callees changes. Analyses must implement this method with the behavior they need, e.g. registering dependees.
- abstract def handleTACAI(ep: EOptionP[Method, properties.TACAI])(implicit state: StateType): Unit
Handles what to do if the TACAI is not yet final.
- abstract def handleUnknownFieldAssignability(ep: EOptionP[Field, FieldAssignability], objRef: Option[Expr[V]])(implicit state: StateType): Unit
Handles what to do when the mutability of a field is not yet known.
Handles what to do when the mutability of a field is not yet known. Analyses must implement this method with the behavior they need, e.g. registering dependees.
- abstract def handleUnknownTypeImmutability(ep: EOptionP[ObjectType, Property], expr: Expr[V])(implicit state: StateType): Unit
Handles what to do when the mutability of a type is not yet known.
Handles what to do when the mutability of a type is not yet known. Analyses must implement this method with the behavior they need, e.g. registering dependees.
- abstract def isLocal(expr: Expr[V], otherwise: Purity, excludedDefSites: IntTrieSet = EmptyIntTrieSet)(implicit state: StateType): Boolean
Examines whether the given expression denotes an object/array that is local to the current method, i.e.
Examines whether the given expression denotes an object/array that is local to the current method, i.e. the method has control over the object/array and actions on it might not influence purity.
- otherwise
The maxPurity will be reduced to at most this level if the expression is not local.
- abstract val project: SomeProject
- Definition Classes
- ProjectBasedAnalysis
- abstract val rater: DomainSpecificRater
- abstract def raterFqn: String
- Attributes
- protected[this]
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def atMost(newLevel: Purity)(implicit state: StateType): Unit
Reduces the minPurity and maxPurity of the current method to at most the given purity level.
- def baseMethodPurity(context: Context): ProperPropertyComputationResult
Retrieves and commits the methods purity as calculated for its declaring class type for the current DefinedMethod that represents the non-overwritten method in a subtype.
- final def ch: ClassHierarchy
- Definition Classes
- ProjectBasedAnalysis
- def checkFieldAssignability(ep: EOptionP[Field, FieldAssignability], objRef: Option[Expr[V]])(implicit state: StateType): Unit
Examines the influence that a given field mutability has on the method's purity.
- def checkPurityOfCallees(calleesEOptP: EOptionP[DeclaredMethod, Callees])(implicit state: StateType): Boolean
Examines the effect that the purity of all potential callees has on the purity of the method.
- def checkPurityOfExpr(expr: Expr[V])(implicit state: StateType): Boolean
Examines an expression for its influence on the method's purity.
Examines an expression for its influence on the method's purity. This method will return false for impure expressions, so evaluation can be terminated early.
- def checkPurityOfFieldRef(fieldRef: FieldRead[V])(implicit state: StateType): Unit
Examines whether a field read influences a method's purity.
Examines whether a field read influences a method's purity. Reading values from fields that are not (effectively) final may cause nondeterministic behavior, so the method can only be side-effect free.
- def checkPurityOfMethod(callee: Context, params: Seq[Expr[V]])(implicit state: StateType): Boolean
- def checkPurityOfReturn(returnValue: Expr[V])(implicit state: StateType): Unit
Examines the effect of returning a value on the method's purity.
Examines the effect of returning a value on the method's purity. Returning a reference to a mutable object or array may cause nondeterministic behavior as the object/array may be modified between invocations of the method, so the method can only be side-effect free. E.g., a given parameter which references a mutable object is returned (and not otherwise accessed).
- def checkPurityOfStmt(stmt: Stmt[V])(implicit state: StateType): Boolean
Examines a statement for its influence on the method's purity.
Examines a statement for its influence on the method's purity. This method will return false for impure statements, so evaluation can be terminated early.
- def checkTypeImmutability(ep: EOptionP[ObjectType, Property], returnValue: Expr[V])(implicit state: StateType): Boolean
Examines the effect that the mutability of a returned value's type has on the method's purity.
- implicit final def classHierarchy: ClassHierarchy
- Definition Classes
- ProjectBasedAnalysis
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- val configuredPurity: ConfiguredPurity
- implicit val declaredMethods: DeclaredMethods
- Attributes
- protected[this]
- def doDeterminePurity(e: Entity): ProperPropertyComputationResult
Called when the analysis is scheduled lazily.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def getCall(stmt: Stmt[V]): Call[V]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getTACAI(method: Method)(implicit state: StateType): Option[TACode[TACMethodParameter, V]]
Returns the TACode for a method if available, registering dependencies as necessary.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def isDomainSpecificCall(call: Call[V], receiver: Option[Expr[V]])(implicit state: StateType): Boolean
Examines whether a call constitutes a domain-specific action using the domain-specific rater.
Examines whether a call constitutes a domain-specific action using the domain-specific rater. If it is, the maxPurity will be reduced to at most the domain-specific purity returned by the domain-specific rater.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isSourceOfImmediateException(origin: ValueOrigin)(implicit state: StateType): Boolean
Checks whether the statement, which is the origin of an exception, directly created the exception or if the VM instantiated the exception.
Checks whether the statement, which is the origin of an exception, directly created the exception or if the VM instantiated the exception. Here, we are only concerned about the exceptions thrown by the instructions not about exceptions that are transitively thrown; e.g. if a method is called. TODO We need this method because currently, for exceptions that terminate the method, no definitions are recorded. Once this is done, use that information instead to determine whether it may be an immediate exception or not.
- implicit final def logContext: LogContext
- Definition Classes
- ProjectBasedAnalysis
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- implicit final def p: SomeProject
- Definition Classes
- ProjectBasedAnalysis
- implicit final val propertyStore: PropertyStore
- Definition Classes
- FPCFAnalysis
- final def ps: PropertyStore
- Definition Classes
- FPCFAnalysis
- def reducePurityLB(newLevel: Purity)(implicit state: StateType): Unit
Reduces the maxPurity of the current method to at most the given purity level.
- def resolveDomainSpecificRater(fqn: String): DomainSpecificRater
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit val typeIterator: TypeIterator
- Attributes
- protected[this]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated