graal-compiler: graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java comparison

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java @ 19652:10a1fc5e3209

Truffle/Instrumentation: new, experimental kind of Instrument

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Sat, 28 Feb 2015 15:52:13 -0800
parents	b5467bb34b24
children	907128d02b31

comparison

equal deleted inserted replaced

-:3ed1c541f420
+:10a1fc5e3209
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
 package com.oracle.truffle.api.instrument;
+import com.oracle.truffle.api.*;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
-import com.oracle.truffle.api.*;
 import com.oracle.truffle.api.frame.*;
 import com.oracle.truffle.api.instrument.impl.*;
 import com.oracle.truffle.api.nodes.*;
 // TODO (mlvdv) migrate some of this to external documentation.
+// TODO (mlvdv) move all this to a factory implemented in .impl (together with Probe),
+// then break out some of the nested classes into package privates.
 /**
 * A dynamically added/removed binding between a {@link Probe}, which provides notification of
 * {@linkplain TruffleEventListener execution events} taking place at a {@link Node} in a Guest
 * Language (GL) Truffle AST, and a {@linkplain TruffleEventListener listener}, which consumes
 * notifications on behalf of an external tool.
 * <li>Create an implementation of {@link TruffleEventListener} that responds to events on behalf of
 * a tool.</li>
 * <li>Create an Instrument via factory method {@link Instrument#create(TruffleEventListener)}.</li>
 * <li>"Attach" the Instrument to a Probe via {@link Probe#attach(Instrument)}, at which point event
 * notifications begin to arrive at the listener.</li>
-* <li>When no longer needed, "detach" the Instrument via {@link Instrument#dispose()}, at which
+* <li>When no longer needed, "detach" the Instrument via {@link TruffleEventInstrument#dispose()},
-* point event notifications to the listener cease, and the Instrument becomes unusable.</li>
+* at which point event notifications to the listener cease, and the Instrument becomes unusable.</li>
 * </ol>
 * <p>
 * <h4>Options for creating listeners:</h4>
 * <p>
 * <ol>
 * <li>An instrument becomes active only when <em>attached</em> to a Probe via
 * {@link Probe#attach(Instrument)}, and it may only be attached to a single Probe. It is a runtime
 * error to attempt attaching a previously attached instrument.</li>
 * <li>Attaching an instrument modifies every existing clone of the AST to which it is being
 * attached, which can trigger deoptimization.</li>
-* <li>The method {@link Instrument#dispose()} makes an instrument inactive by removing it from the
+* <li>The method {@link TruffleEventInstrument#dispose()} makes an instrument inactive by removing
-* Probe to which it was attached and rendering it permanently inert.</li>
+* it from the Probe to which it was attached and rendering it permanently inert.</li>
 * <li>Disposal removes the implementation of an instrument from all ASTs to which it was attached,
 * which can trigger deoptimization.</li>
 * </ul>
 * <p>
 * <h4>Sharing listeners:</h4>
 * <strong>Disclaimer:</strong> experimental; under development.
 *
 * @see Probe
 * @see TruffleEventListener
 */
-public final class Instrument {
+public abstract class Instrument {
 /**
 * Creates an instrument that will route execution events to a listener.
 *
 * @param listener a listener for event generated by the instrument
 * @param instrumentInfo optional description of the instrument's role
 * @return a new instrument, ready for attachment at a probe
 */
 public static Instrument create(TruffleEventListener listener, String instrumentInfo) {
-return new Instrument(listener, instrumentInfo);
+return new TruffleEventInstrument(listener, instrumentInfo);
 }
 /**
 * Creates an instrument that will route execution events to a listener.
 */
 public static Instrument create(TruffleEventListener listener) {
-return new Instrument(listener, null);
+return new TruffleEventInstrument(listener, null);
 }
-/**
+// TODO (mlvdv) experimental
-* Tool-supplied listener for events.
+/**
-*/
+* For implementation testing.
-private final TruffleEventListener toolEventListener;
+*/
+public static Instrument create(TruffleOptListener listener) {
+return new TruffleOptInstrument(listener, null);
+}
+/**
+* Has this instrument been disposed? stays true once set.
+*/
+private boolean isDisposed = false;
+private Probe probe = null;
 /**
 * Optional documentation, mainly for debugging.
 */
 private final String instrumentInfo;
-/**
+private Instrument(String instrumentInfo) {
-* Has this instrument been disposed? stays true once set.
-*/
-private boolean isDisposed = false;
-private Probe probe = null;
-private Instrument(TruffleEventListener listener, String instrumentInfo) {
-this.toolEventListener = listener;
 this.instrumentInfo = instrumentInfo;
 }
 /**
 * Removes this instrument (and any clones) from the probe to which it attached and renders the
 */
 boolean isDisposed() {
 return isDisposed;
 }
-InstrumentNode addToChain(InstrumentNode nextNode) {
+abstract InstrumentNode addToChain(InstrumentNode nextNode);
-return new InstrumentNode(nextNode);
-}
 /**
 * Removes this instrument from an instrument chain.
 */
-InstrumentNode removeFromChain(InstrumentNode instrumentNode) {
+abstract InstrumentNode removeFromChain(InstrumentNode instrumentNode);
-boolean found = false;
-if (instrumentNode != null) {
+private static final class TruffleEventInstrument extends Instrument {
-if (instrumentNode.getInstrument() == this) {
-// Found the match at the head of the chain
+/**
-return instrumentNode.nextInstrument;
+* Tool-supplied listener for events.
-}
+*/
-// Match not at the head of the chain; remove it.
+private final TruffleEventListener toolEventListener;
-found = instrumentNode.removeFromChain(Instrument.this);
-}
+private TruffleEventInstrument(TruffleEventListener listener, String instrumentInfo) {
-if (!found) {
+super(instrumentInfo);
-throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
+this.toolEventListener = listener;
 }
-return instrumentNode;
+@Override
+InstrumentNode addToChain(InstrumentNode nextNode) {
+return new TruffleEventInstrumentNode(nextNode);
+}
+@Override
+InstrumentNode removeFromChain(InstrumentNode instrumentNode) {
+boolean found = false;
+if (instrumentNode != null) {
+if (instrumentNode.getInstrument() == this) {
+// Found the match at the head of the chain
+return instrumentNode.nextInstrument;
+}
+// Match not at the head of the chain; remove it.
+found = instrumentNode.removeFromChain(TruffleEventInstrument.this);
+}
+if (!found) {
+throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
+}
+return instrumentNode;
+}
+@NodeInfo(cost = NodeCost.NONE)
+private final class TruffleEventInstrumentNode extends InstrumentNode {
+private TruffleEventInstrumentNode(InstrumentNode nextNode) {
+super(nextNode);
+}
+public void enter(Node node, VirtualFrame vFrame) {
+TruffleEventInstrument.this.toolEventListener.enter(node, vFrame);
+if (nextInstrument != null) {
+nextInstrument.enter(node, vFrame);
+}
+}
+public void returnVoid(Node node, VirtualFrame vFrame) {
+TruffleEventInstrument.this.toolEventListener.returnVoid(node, vFrame);
+if (nextInstrument != null) {
+nextInstrument.returnVoid(node, vFrame);
+}
+}
+public void returnValue(Node node, VirtualFrame vFrame, Object result) {
+TruffleEventInstrument.this.toolEventListener.returnValue(node, vFrame, result);
+if (nextInstrument != null) {
+nextInstrument.returnValue(node, vFrame, result);
+}
+}
+public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
+TruffleEventInstrument.this.toolEventListener.returnExceptional(node, vFrame, exception);
+if (nextInstrument != null) {
+nextInstrument.returnExceptional(node, vFrame, exception);
+}
+}
+public String instrumentationInfo() {
+final String info = getInstrumentInfo();
+return info != null ? info : toolEventListener.getClass().getSimpleName();
+}
+}
+}
+public interface TruffleOptListener {
+void notifyIsCompiled(boolean isCompiled);
+}
+private static final class TruffleOptInstrument extends Instrument {
+private final TruffleOptListener toolOptListener;
+private TruffleOptInstrument(TruffleOptListener listener, String instrumentInfo) {
+super(instrumentInfo);
+this.toolOptListener = listener;
+}
+@Override
+InstrumentNode addToChain(InstrumentNode nextNode) {
+return new TruffleOptInstrumentNode(nextNode);
+}
+@Override
+InstrumentNode removeFromChain(InstrumentNode instrumentNode) {
+boolean found = false;
+if (instrumentNode != null) {
+if (instrumentNode.getInstrument() == this) {
+// Found the match at the head of the chain
+return instrumentNode.nextInstrument;
+}
+// Match not at the head of the chain; remove it.
+found = instrumentNode.removeFromChain(TruffleOptInstrument.this);
+}
+if (!found) {
+throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
+}
+return instrumentNode;
+}
+@NodeInfo(cost = NodeCost.NONE)
+private final class TruffleOptInstrumentNode extends InstrumentNode {
+private boolean isCompiled;
+private TruffleOptInstrumentNode(InstrumentNode nextNode) {
+super(nextNode);
+this.isCompiled = CompilerDirectives.inCompiledCode();
+}
+public void enter(Node node, VirtualFrame vFrame) {
+if (this.isCompiled != CompilerDirectives.inCompiledCode()) {
+this.isCompiled = CompilerDirectives.inCompiledCode();
+TruffleOptInstrument.this.toolOptListener.notifyIsCompiled(this.isCompiled);
+}
+if (nextInstrument != null) {
+nextInstrument.enter(node, vFrame);
+}
+}
+public void returnVoid(Node node, VirtualFrame vFrame) {
+if (nextInstrument != null) {
+nextInstrument.returnVoid(node, vFrame);
+}
+}
+public void returnValue(Node node, VirtualFrame vFrame, Object result) {
+if (nextInstrument != null) {
+nextInstrument.returnValue(node, vFrame, result);
+}
+}
+public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
+if (nextInstrument != null) {
+nextInstrument.returnExceptional(node, vFrame, exception);
+}
+}
+public String instrumentationInfo() {
+final String info = getInstrumentInfo();
+return info != null ? info : toolOptListener.getClass().getSimpleName();
+}
+}
 }
 @NodeInfo(cost = NodeCost.NONE)
-final class InstrumentNode extends Node implements TruffleEventListener, InstrumentationNode {
+abstract class InstrumentNode extends Node implements TruffleEventListener, InstrumentationNode {
+@Child protected InstrumentNode nextInstrument;
-@Child private InstrumentNode nextInstrument;
+protected InstrumentNode(InstrumentNode nextNode) {
-private InstrumentNode(InstrumentNode nextNode) {
 this.nextInstrument = nextNode;
 }
 @Override
 public boolean isInstrumentable() {
 return true;
 }
 return nextInstrument.removeFromChain(instrument);
 }
-public void enter(Node node, VirtualFrame vFrame) {
+protected String getInstrumentInfo() {
-Instrument.this.toolEventListener.enter(node, vFrame);
+return Instrument.this.instrumentInfo;
-if (nextInstrument != null) {
+}
-nextInstrument.enter(node, vFrame);
-}
-}
-public void returnVoid(Node node, VirtualFrame vFrame) {
-Instrument.this.toolEventListener.returnVoid(node, vFrame);
-if (nextInstrument != null) {
-nextInstrument.returnVoid(node, vFrame);
-}
-}
-public void returnValue(Node node, VirtualFrame vFrame, Object result) {
-Instrument.this.toolEventListener.returnValue(node, vFrame, result);
-if (nextInstrument != null) {
-nextInstrument.returnValue(node, vFrame, result);
-}
-}
-public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
-Instrument.this.toolEventListener.returnExceptional(node, vFrame, exception);
-if (nextInstrument != null) {
-nextInstrument.returnExceptional(node, vFrame, exception);
-}
-}
-public String instrumentationInfo() {
-if (Instrument.this.instrumentInfo != null) {
-return Instrument.this.instrumentInfo;
-}
-return toolEventListener.getClass().getSimpleName();
-}
 }
 }

Mercurial > hg > graal-compiler

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java @ 19652:10a1fc5e3209