com.oracle.truffle.api.instrumentation

Class ExecutionEventNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.instrumentation.ExecutionEventNode

All Implemented Interfaces:

NodeInterface, Cloneable

public abstract class ExecutionEventNode
extends Node

An event node created by an ExecutionEventNodeFactory for a specific locations of a guest language program to listen to instrumentation events. In addition to listeners event nodes allow to store state for a particular program location.

Since:

0.12

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node

Node.Child, Node.Children

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExecutionEventNode()

Method Summary

Modifier and Type	Method and Description
protected void	onDispose(VirtualFrame frame) Invoked when an event node is removed from the AST.
protected void	onEnter(VirtualFrame frame) Invoked immediately before the instrumented node is executed.
protected void	onReturnExceptional(VirtualFrame frame, Throwable exception) Invoked immediately after an instrumented node did not successfully execute.
protected void	onReturnValue(VirtualFrame frame, Object result) Invoked immediately after an instrumented node is successfully executed.

Methods inherited from class com.oracle.truffle.api.nodes.Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isSafelyReplaceableBy, isTaggedWith, onReplace, replace, replace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionEventNode

protected ExecutionEventNode()

Since:

0.12

Method Detail

onEnter

protected void onEnter(VirtualFrame frame)

Invoked immediately before the instrumented node is executed. The order in which multiple event listeners are notified matches the order they are attached .

Parameters:

frame - the current frame used in the instrumented node

Since:

0.12

onReturnValue

protected void onReturnValue(VirtualFrame frame,
                             Object result)

Invoked immediately after an instrumented node is successfully executed. The order in which multiple event listeners are notified matches the order they are attached.

Parameters:

frame - the frame that was used for executing instrumented node

Since:

0.12

onReturnExceptional

protected void onReturnExceptional(VirtualFrame frame,
                                   Throwable exception)

Invoked immediately after an instrumented node did not successfully execute. The order in which multiple event listeners are notified matches the order they are attached.

Parameters:

frame - the frame that was used for executing instrumented node

Since:

0.12

onDispose

protected void onDispose(VirtualFrame frame)

Invoked when an event node is removed from the AST. This happens if the underlying binding, language/instrument or engine is disposed. Event nodes are removed lazily. This means that ExecutionEventNode.onDispose(VirtualFrame) is invoked the next time the particular part of the AST is executed. If the instrumented node is not invoked anymore after it was disposed then ExecutionEventNode.onDispose(VirtualFrame) might or might not be executed.

Parameters:

frame - the frame that was used for executing instrumented node

Since:

0.12