com.oracle.truffle.api.instrumentation

Class ProbeNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.instrumentation.ProbeNode

All Implemented Interfaces:

NodeInterface, Cloneable

public final class ProbeNode
extends Node

Represents an event sink for instrumentation events that is embedded in the AST using wrappers if needed. Instances of this class are provided by InstrumentableFactory.createWrapper(Node, ProbeNode) to notify the instrumentation API about execution events.

The recommended use of this node for implementing wrapper nodes looks as follows:

 @Override
 public Object execute(VirtualFrame frame) {
     try {
         probeNode.onEnter(frame);
         Object returnValue = delegate.execute(frame);
         probeNode.onReturnValue(frame, returnValue);
         return returnValue;
     } catch (Throwable t) {
         probeNode.onReturnExceptional(frame, t);
         throw t;
     }
 }
 

Since:

0.12

Nested Class Summary

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

Node.Child, Node.Children

Method Summary

Modifier and Type	Method and Description
NodeCost	getCost() Returns a rough estimate for the cost of this Node.
void	onEnter(VirtualFrame frame) Should get invoked before the node is invoked.
void	onReturnExceptional(VirtualFrame frame, Throwable exception) Should get invoked if the node did not complete successfully.
void	onReturnValue(VirtualFrame frame, Object result) Should get invoked after the node is invoked successfully.

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

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, 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

Method Detail

onEnter

public void onEnter(VirtualFrame frame)

Should get invoked before the node is invoked.

Parameters:

frame - the current frame of the execution.

Since:

0.12

onReturnValue

public void onReturnValue(VirtualFrame frame,
                          Object result)

Should get invoked after the node is invoked successfully.

Parameters:

result - the result value of the operation

frame - the current frame of the execution.

Since:

0.12

onReturnExceptional

public void onReturnExceptional(VirtualFrame frame,
                                Throwable exception)

Should get invoked if the node did not complete successfully.

Parameters:

exception - the exception that occurred during the execution

frame - the current frame of the execution.

Since:

0.12

getCost

public NodeCost getCost()

Description copied from class: Node

Returns a rough estimate for the cost of this Node. This estimate can be used by runtime systems or guest languages to implement heuristics based on Truffle ASTs. This method is intended to be overridden by subclasses. The default implementation returns the value of NodeInfo.cost() of the NodeInfo annotation declared at the subclass. If no NodeInfo annotation is declared the method returns NodeCost.MONOMORPHIC as a default value.

Overrides:

getCost in class Node

Since:

0.12