Interface ProbeNode.WrapperNode
- All Superinterfaces:
InstrumentationNode
- Enclosing class:
- ProbeNode
The implementation must be GL-specific. A wrapper decorates a GL AST node (the wrapper's child) by acting as a transparent proxy with respect to the GL's execution semantics.
Instrumentation at the wrapped node is implemented by an instance of ProbeNode
attached as a second child of the ProbeNode.WrapperNode
.
A wrapper is obliged to notify its attached ProbeNode
when execution events occur at
the wrapped AST node during program execution.
When a GL AST is cloned, the ProbeNode.WrapperNode
, its ProbeNode
and any
instrumentation are also cloned; they are in effect part of the GL
AST. An instance of Probe
represents abstractly the instrumentation at a particular
location in a GL AST; it tracks all the copies of the Wrapper and attached instrumentation,
and acts as a single point of access for tools.
This interface is not intended to be visible as part of the API for tools (instrumentation clients).
Implementation guidelines:
- Each GL implementation should include a WrapperNode implementation; usually only one is needed.
- The wrapper type should descend from the GL-specific node class.
- Must have a field:
@Child private <GL>Node child;
- Must have a field:
@Child private ProbeNode probeNode;
- The wrapper must act as a proxy for its child, which means implementing every possible execute- method that gets called on guest language AST node types by their parents, and passing along each call to its child.
- Method
Probe getProbe()
should be implemented asprobeNode.getProbe();
- Method
insertProbe(ProbeNode)
should be implemented asthis.probeNode=insert(newProbeNode);
- Most importantly, Wrappers must be implemented so that Truffle optimization will reduce
their runtime overhead to zero when there are no attached
Instrument
s.
Disclaimer: experimental interface under development.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetChild()
Gets the node being "wrapped", i.e.getProbe()
Gets theProbe
responsible for installing this wrapper; none if the wrapper installed via "lite-Probing".void
insertProbe
(ProbeNode probeNode) Implementation support for completing a newly created wrapper node.Methods inherited from interface com.oracle.truffle.api.instrument.InstrumentationNode
instrumentationInfo
-
Method Details
-
getChild
Node getChild()Gets the node being "wrapped", i.e. the AST node for which execution events will be reported through the Instrumentation Framework. -
getProbe
Probe getProbe()Gets theProbe
responsible for installing this wrapper; none if the wrapper installed via "lite-Probing". -
insertProbe
Implementation support for completing a newly created wrapper node.
-