com.oracle.truffle.api.instrumentation

Interface InstrumentableFactory<T extends Node>

Type Parameters:

T - the type of delegate node this factory operates on

public interface InstrumentableFactory<T extends Node>

Factory for creating wrapper nodes. The instrumentation framework inserts a wrapper between an Instrumentable guest language node (called the delegate) and its parent for the purpose of interposing on execution events at the delegate and reporting those events to the instrumentation framework.

Wrapper implementations can be generated automatically: see the Instrumentable annotation.

Since:

0.12

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InstrumentableFactory.WrapperNode Nodes that the instrumentation framework inserts into guest language ASTs (between Instrumentable guest language nodes and their parents) for the purpose of interposing on execution events and reporting them via the instrumentation framework.

Method Summary

Modifier and Type	Method and Description
InstrumentableFactory.WrapperNode	createWrapper(T node, ProbeNode probe) Returns a new, never adopted, unshared wrapper node implementation for a particular Instrumentable node of the guest language AST called its delegate .

Method Detail

createWrapper

InstrumentableFactory.WrapperNode createWrapper(T node,
                                                ProbeNode probe)

Returns a new, never adopted, unshared wrapper node implementation for a particular Instrumentable node of the guest language AST called its delegate . The returned wrapper implementation must extend the same type that is annotated with Instrumentable.

A wrapper forwards the following events concerning the delegate to the given probe for propagation through the instrumentation framework, e.g. to event listeners bound to this guest language program location:

• onEnter(Frame): an execute method on the delegate is ready to be called;
• onReturnValue(Frame,Object): an execute method on the delegate has just returned a (possibly null) value;
• onReturnExceptional(Frame,Throwable): an execute method on the delegate has just thrown an exception.

Parameters:

node - the Instrumentable delegate to be adopted by the wrapper

probe - the probe node to be adopted and sent execution events by the wrapper

Returns:

a wrapper implementation

Since:

0.12