Packages

t

org.opalj.ai

AITracer

trait AITracer extends AnyRef

Defines the interface between the abstract interpreter and a module for tracing and debugging the interpreter's progress. In general, a tracer is first registered with an abstract interpreter. After that, when a method is analyzed, the AI calls the tracer's methods at the respective points in time.

A tracer is registered with an abstract interpreter by creating a new subclass of AI and overriding the method AI.tracer.

Source
AITracer.scala
Note

All data structures passed to the tracer are the original data structures used by the abstract interpreter. Hence, if a value is mutated (e.g., for debugging purposes) it has to be guaranteed that the state remains meaningful. Hence, using the AITracer it is possible to develop a debugger for OPAL and to enable the user to perform certain mutations.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AITracer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def abruptMethodExecution(domain: Domain)(pc: PC, exception: Domain.ExceptionValue): Unit

    Called when the analyzed method throws an exception that is not caught within the method.

    Called when the analyzed method throws an exception that is not caught within the method. I.e., the interpreter evaluates an athrow instruction or some other instruction that throws an exception.

  2. abstract def abruptSubroutineTermination(domain: Domain)(details: String, sourcePC: PC, targetPC: PC, jumpToSubroutineId: Int, terminatedSubroutinesCount: Int, forceScheduling: Boolean, oldWorklist: Chain[PC], newWorklist: Chain[PC]): Unit

    Called when the evaluation of a subroutine terminated abruptly due to an unhandled exception.

    Called when the evaluation of a subroutine terminated abruptly due to an unhandled exception.

    jumpToSubroutineId

    The subroutine that will be continued. The id is the pc of the first instruction of the subroutine. It is 0 if it is the method as such.

    terminatedSubroutinesCount

    The number of subroutines that are terminated.

  3. abstract def continuingInterpretation(code: Code, domain: Domain)(initialWorkList: Chain[PC], alreadyEvaluated: Chain[PC], operandsArray: Domain.OperandsArray, localsArray: Domain.LocalsArray, memoryLayoutBeforeSubroutineCall: Chain[(PC, Domain.OperandsArray, Domain.LocalsArray)]): Unit

    Called immediately before the abstract interpretation of the specified code is performed.

    Called immediately before the abstract interpretation of the specified code is performed.

    If the tracer changes the operandsArray and/or localsArray, it is the responsibility of the tracer to ensure that the data structures are still valid afterwards.

  4. abstract def deadLocalVariable(domain: Domain)(pc: PC, lvIndex: Int): Unit

    Called by the interpret when a local variable with the given index (lvIndex) was set to a new value and, therefore, the reference stored in the local variable previously was useless/dead.

  5. abstract def domainMessage(domain: Domain, source: Class[_], typeID: String, pc: Option[PC], message: ⇒ String): Unit

    Called by the domain if something noteworthy was determined.

    Called by the domain if something noteworthy was determined.

    domain

    The domain.

    source

    The class (typically the (partial) domain) that generated the message.

    typeID

    A String that identifies the message. This value must not be null, but it can be the empty string.

    message

    The message; a non-null String that is formatted for the console.

  6. abstract def establishedConstraint(domain: Domain)(pc: PC, effectivePC: PC, operands: Domain.Operands, locals: Domain.Locals, newOperands: Domain.Operands, newLocals: Domain.Locals): Unit

    Called by the framework if a constraint is established.

    Called by the framework if a constraint is established. Constraints are generally established whenever a conditional jump is performed and the evaluation of the condition wasn't definitive. In this case a constraint will be established for each branch. In general the constraint will be applied before the join of the stack and locals with the successor instruction is done.

  7. abstract def flow(domain: Domain)(currentPC: PC, targetPC: PC, isExceptionalControlFlow: Boolean): Unit

    Called by the interpreter after an instruction (currentPC) was evaluated and before the instruction with the program counter targetPC may be evaluated.

    Called by the interpreter after an instruction (currentPC) was evaluated and before the instruction with the program counter targetPC may be evaluated.

    This method is only called if the instruction with the program counter targetPC will be evaluated in the future and was not yet scheduled. I.e., when the abstract interpreter determines that the evaluation of an instruction does not change the abstract state (associated with the successor instruction) and, therefore, will not schedule the successor instruction this method is not called.

    In case of if or switch instructions flow may be called multiple times (even with the same targetPC) before the method instructionEvaluation is called again.

    Note

    OPAL performs a depth-first exploration. However, subroutines are always first finished analyzing before an exception handler - that handles abrupt executions of the subroutine - is evaluated.

  8. abstract def initialLocals(domain: Domain)(locals: Domain.Locals): Unit

    The set of initial locals computed when the method is interpreted for the first time.

  9. abstract def instructionEvalution(domain: Domain)(pc: PC, instruction: Instruction, operands: Domain.Operands, locals: Domain.Locals): Unit

    Called before an instruction is evaluated.

    Called before an instruction is evaluated.

    This enables the tracer to precisely log the behavior of the abstract interpreter, but also enables the tracer to interrupt the evaluation to, e.g., enable stepping through a program.

    operands

    The operand stack before the execution of the instruction.

    locals

    The registers before the execution of the instruction.

  10. abstract def join(domain: Domain)(pc: PC, thisOperands: Domain.Operands, thisLocals: Domain.Locals, otherOperands: Domain.Operands, otherLocals: Domain.Locals, result: Update[(Domain.Operands, Domain.Locals)]): Unit

    Called by the abstract interpreter whenever two paths converge and the values on the operand stack and the registers are joined.

    Called by the abstract interpreter whenever two paths converge and the values on the operand stack and the registers are joined.

    thisOperands

    The operand stack as it was used the last time when the instruction with the given program counter was evaluated.

    thisLocals

    The registers as they were used the last time when the instruction with the given program counter was evaluated.

    otherOperands

    The current operand stack when we re-reach the instruction

    otherLocals

    The current registers.

    result

    The result of joining the operand stacks and register assignment.

  11. abstract def jumpToSubroutine(domain: Domain)(pc: PC, target: PC, nestingLevel: Int): Unit

    Called before a jump to a subroutine.

  12. abstract def noFlow(domain: Domain)(currentPC: PC, targetPC: PC): Unit

    Called by the interpreter if a successor instruction is NOT scheduled, because the abstract state didn't change.

  13. abstract def rescheduled(domain: Domain)(sourcePC: PC, targetPC: PC, isExceptionalControlFlow: Boolean, worklist: Chain[PC]): Unit

    Called if the instruction with the targetPC was already scheduled.

    Called if the instruction with the targetPC was already scheduled. I.e., the instruction was already scheduled for evaluation, but is now moved to the first position in the list of all instructions to be executed (related to the specific subroutine). A rescheduled event is also issued if the instruction was the the first in the list of instructions executed next. However, further instructions may be appended to the list before the next instructionEvaluation takes place.

    Note

    OPAL performs a depth-first exploration.

  14. abstract def result(result: AIResult): Unit

    Called when the abstract interpretation of a method has completed/was interrupted.

  15. abstract def ret(domain: Domain)(pc: PC, returnAddress: PC, oldWorklist: Chain[PC], newWorklist: Chain[PC]): Unit

    Called when a RET instruction is encountered.

    Called when a RET instruction is encountered. (That does not necessary imply that the evaluation of the subroutine as such has finished. It is possible that other paths still need to be pursued.)

  16. abstract def returnFromSubroutine(domain: Domain)(pc: PC, returnAddress: PC, subroutineInstructions: Chain[PC]): Unit

    Called when the evaluation of a subroutine (JSR/RET) as a whole is completed.

    Called when the evaluation of a subroutine (JSR/RET) as a whole is completed. I.e., all possible paths are analyzed and the fixpoint is reached.

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. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped