truffle: graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java annotate

annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java @ 19818:907128d02b31

Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface.

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Thu, 12 Mar 2015 18:03:05 -0700
parents	10a1fc5e3209
children	2e3cc2a27711

rev	line source
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1 /*
18985 867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	2 * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	4 *
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	5 * This code is free software; you can redistribute it and/or modify it
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	6 * under the terms of the GNU General Public License version 2 only, as
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	7 * published by the Free Software Foundation. Oracle designates this
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	8 * particular file as subject to the "Classpath" exception as provided
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	9 * by Oracle in the LICENSE file that accompanied this code.
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	10 *
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	11 * This code is distributed in the hope that it will be useful, but WITHOUT
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	14 * version 2 for more details (a copy is included in the LICENSE file that
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	15 * accompanied this code).
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	16 *
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	17 * You should have received a copy of the GNU General Public License version
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	18 * 2 along with this work; if not, write to the Free Software Foundation,
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	20 *
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	22 * or visit www.oracle.com if you need additional information or have any
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	23 * questions.
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	24 */
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	25 package com.oracle.truffle.api.instrument;
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	26
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	27 import com.oracle.truffle.api.*;
18130 b4e38f4ca414 Truffle: rename @SlowPath to @TruffleBoundary. Christian Humer <christian.humer@gmail.com> parents: 15779 diff changeset	28 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	29 import com.oracle.truffle.api.frame.*;
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	30 import com.oracle.truffle.api.instrument.InstrumentationNode.TruffleEvents;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	31 import com.oracle.truffle.api.instrument.impl.*;
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	32 import com.oracle.truffle.api.nodes.*;
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	33 import com.oracle.truffle.api.source.*;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	34
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	35 // TODO (mlvdv) migrate some of this to external documentation.
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	36 // TODO (mlvdv) move all this to a factory implemented in .impl (together with Probe),
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	37 // then break out some of the nested classes into package privates.
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	38 /**
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	39 * A dynamically added/removed binding between a {@link Probe}, which provides notification of
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	40 * <em>execution events</em> taking place at a {@link Node} in a Guest Language (GL) Truffle AST,
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	41 * and a <em>listener</em>, which consumes notifications on behalf of an external tool. There are at
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	42 * present two kinds of listeners that be used:
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	43 * <ol>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	44 * <li>{@link InstrumentListener} is the simplest and is intended for tools that require no access
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	45 * to the <em>internal execution state</em> of the Truffle execution, only that execution has passed
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	46 * through a particular location in the program. Information about that location is made available
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	47 * via the {@link Probe} argument in notification methods, including the {@linkplain SourceSection
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	48 * source location} of the node and any {@linkplain SyntaxTag tags} that have been applied to the
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	49 * node.</li>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	50 * <li>{@link ASTInstrumentListener} reports the same events and {@link Probe} argument, but
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	51 * additionally provides access to the execution state via the explicit {@link Node} and
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	52 * {@link Frame} at the current execution site.</li>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	53 * </ol>
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	54 * <p>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	55 * <h4>Summary: How to "instrument" an AST location:</h4>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	56 * <p>
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	57 * <ol>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	58 * <li>Create an implementation of a <em>listener</em> interface.</li>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	59 * <li>Create an Instrument via factory methods
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	60 * {@link Instrument#create(InstrumentListener, String)} or
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	61 * {@link Instrument#create(ASTInstrumentListener, String)}.</li>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	62 * <li>"Attach" the Instrument to a Probe via {@link Probe#attach(Instrument)}, at which point event
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	63 * notifications begin to arrive at the listener.</li>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	64 * <li>When no longer needed, "detach" the Instrument via {@link ASTInstrument#dispose()}, at which
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	65 * point event notifications to the listener cease, and the Instrument becomes unusable.</li>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	66 * </ol>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	67 * <p>
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	68 * <h4>Options for creating listeners:</h4>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	69 * <p>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	70 * <ol>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	71 * <li>Implement one of the <em>listener interfaces</em>: {@link InstrumentListener} or
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	72 * {@link ASTInstrumentListener} . Their event handling methods account for both the entry into an
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	73 * AST node (about to call) and three possible kinds of <em>execution return</em> from an AST node.</li>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	74 * <li>Extend one of the <em>helper implementations</em>: {@link DefaultInstrumentListener} or
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	75 * {@link DefaultASTInstrumentListener}. These provide no-op implementation of every listener
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	76 * method, so only the methods of interest need to be overridden.</li>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	77 * <li>Extend one of the <em>helper implementations</em>: {@link SimpleInstrumentListener} or
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	78 * {@link SimpleASTInstrumentListener}. These re-route all <em>execution returns</em> to a single
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	79 * method, ignoring return values, so only two methods (for "enter" and "return") will notify all
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	80 * events.</li>
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	81 * </ol>
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	82 * <p>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	83 * <h4>General guidelines for {@link ASTInstrumentListener} implementation:</h4>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	84 * <p>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	85 * Unlike the listener interface {@link InstrumentListener}, which isolates implementations
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	86 * completely from Truffle internals (and is thus <em>Truffle-safe</em>), implementations of
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	87 * {@link ASTInstrumentListener} can interact directly with (and potentially affect) Truffle
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	88 * execution in general and Truffle optimization in particular. For example, it is possible to
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	89 * implement a debugger with this interface.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	90 * </p>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	91 * <p>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	92 * As a consequence, implementations of {@link ASTInstrumentListener} effectively become part of the
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	93 * Truffle execution and must be coded according to general guidelines for Truffle implementations.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	94 * For example:
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	95 * <ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	96 * <li>Do not store {@link Frame} or {@link Node} references in fields.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	97 * <li>Prefer {@code final} fields and (where performance is important) short methods.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	98 * <li>If needed, pass along the {@link VirtualFrame} reference from an event notification as far as
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	99 * possible through code that is expected to be inlined, since this incurs no runtime overhead. When
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	100 * access to frame data is needed, substitute a more expensive {@linkplain Frame#materialize()
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	101 * materialized} representation of the frame.</li>
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	102 * <li>If a listener calls back to its tool during event handling, and if performance is an issue,
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	103 * then this should be through a final "callback" field in the instrument, and the called methods
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	104 * should be minimal.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	105 * <li>On the other hand, implementations should prevent Truffle from inlining beyond a reasonable
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	106 * point with the method annotation {@link TruffleBoundary}.</li>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	107 * <li>The implicit "outer" pointer in a non-static inner class is a useful (and
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	108 * Truffle-optimizable) way to implement callbacks to owner tools.</li>
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	109 * <li>Primitive-valued return events are boxed for event notification, but Truffle will eliminate
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	110 * the boxing if they are cast back to their primitive values quickly (in particular before crossing
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	111 * any {@link TruffleBoundary} annotations).
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	112 * </ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	113 * <p>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	114 * <h4>Allowing for AST cloning:</h4>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	115 * <p>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	116 * Truffle routinely <em>clones</em> ASTs, which has consequences for implementations of
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	117 * {@link ASTInstrumentListener} (but not for implementations of {@link InstrumentListener}, from
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	118 * which cloning is hidden).
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	119 * <ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	120 * <li>Even though a {@link Probe} is uniquely associated with a particular location in the
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	121 * executing Guest Language program, execution events at that location will in general be
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	122 * implemented by different {@link Node} instances, i.e. <em>clones</em> of the originally probed
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	123 * node.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	124 * <li>Because of <em>cloning</em> the {@link Node} supplied with notifications to a particular
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	125 * listener will vary, but because they all represent the same GL program location the events should
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	126 * be treated as equivalent for most purposes.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	127 * </ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	128 * <p>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	129 * <h4>Access to execution state via {@link ASTInstrumentListener}:</h4>
15779 8c34e2cc4add Truffle/Instrumentation: significant reorganization of the instrumentation framework's implementation and connection to the runtime ExecutionContext, with some new features, including a Tag-based "trap" mechanisms. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15605 diff changeset	130 * <p>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	131 * <ul>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	132 * <li>Notification arguments provide primary access to the GL program's execution states:
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	133 * <ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	134 * <li>{@link Node}: the concrete node (in one of the AST's clones) from which the event originated.
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	135 * </li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	136 * <li>{@link VirtualFrame}: the current execution frame.
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	137 * </ul>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	138 * <li>Truffle global information is available, for example the execution
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	139 * {@linkplain TruffleRuntime#iterateFrames(FrameInstanceVisitor) stack}.</li>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	140 * <li>Additional API access to execution state may be added in the future.</li>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	141 * </ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	142 * <p>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	143 * <h4>Activating and deactivating Instruments:</h4>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	144 * <p>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	145 * Instruments are <em>single-use</em>:
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	146 * <ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	147 * <li>An instrument becomes active only when <em>attached</em> to a Probe via
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	148 * {@link Probe#attach(Instrument)}, and it may only be attached to a single Probe. It is a runtime
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	149 * error to attempt attaching a previously attached instrument.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	150 * <li>Attaching an instrument modifies every existing clone of the AST to which it is being
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	151 * attached, which can trigger deoptimization.</li>
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	152 * <li>The method {@link Instrument#dispose()} makes an instrument inactive by removing it from the
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	153 * Probe to which it was attached and rendering it permanently inert.</li>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	154 * <li>Disposal removes the implementation of an instrument from all ASTs to which it was attached,
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	155 * which can trigger deoptimization.</li>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	156 * </ul>
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	157 * <p>
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	158 * <h4>Sharing listeners:</h4>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	159 * <p>
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	160 * Although an Instrument may only be attached to a single Probe, a listener can be shared among
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	161 * multiple Instruments. This can be useful for observing events that might happen at different
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	162 * locations in a single AST, for example all assignments to a particular variable. In this case a
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	163 * new Instrument would be created and attached at each assignment node, but all the Instruments
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	164 * would be created with the same listener.
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	165 * <p>
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	166 * <strong>Disclaimer:</strong> experimental; under development.
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	167 *
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	168 * @see Probe
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	169 * @see TruffleEvents
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	170 */
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	171 public abstract class Instrument {
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	172
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	173 /**
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	174 * Creates an instrument that will route execution events to a listener.
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	175 *
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	176 * @param listener a minimal listener for event generated by the instrument.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	177 * @param instrumentInfo optional description of the instrument's role, useful for debugging.
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	178 * @return a new instrument, ready for attachment at a probe
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	179 */
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	180 public static Instrument create(InstrumentListener listener, String instrumentInfo) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	181 return new BasicInstrument(listener, instrumentInfo);
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	182 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	183
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	184 /**
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	185 * Creates an instrument that will route execution events to a listener, along with access to
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	186 * internal execution state.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	187 *
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	188 * @param astListener a listener for event generated by the instrument that provides access to
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	189 * internal execution state
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	190 * @param instrumentInfo optional description of the instrument's role, useful for debugging.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	191 * @return a new instrument, ready for attachment at a probe
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	192 */
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	193 public static Instrument create(ASTInstrumentListener astListener, String instrumentInfo) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	194 return new ASTInstrument(astListener, instrumentInfo);
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	195 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	196
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	197 // TODO (mlvdv) experimental
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	198 /**
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	199 * For implementation testing.
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	200 */
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	201 public static Instrument create(TruffleOptListener listener) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	202 return new TruffleOptInstrument(listener, null);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	203 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	204
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	205 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	206 * Has this instrument been disposed? stays true once set.
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	207 */
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	208 private boolean isDisposed = false;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	209
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	210 protected Probe probe = null;
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	211
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	212 /**
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	213 * Optional documentation, mainly for debugging.
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	214 */
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	215 private final String instrumentInfo;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	216
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	217 private Instrument(String instrumentInfo) {
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	218 this.instrumentInfo = instrumentInfo;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	219 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	220
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	221 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	222 * Removes this instrument (and any clones) from the probe to which it attached and renders the
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	223 * instrument inert.
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	224 *
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	225 * @throws IllegalStateException if this instrument has already been disposed
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	226 */
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	227 public void dispose() throws IllegalStateException {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	228 if (isDisposed) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	229 throw new IllegalStateException("Attempt to dispose an already disposed Instrumennt");
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	230 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	231 if (probe != null) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	232 // It's attached
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	233 probe.disposeInstrument(this);
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	234 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	235 this.isDisposed = true;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	236 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	237
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	238 Probe getProbe() {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	239 return probe;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	240 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	241
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	242 void setAttachedTo(Probe probe) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	243 this.probe = probe;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	244 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	245
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	246 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	247 * Has this instrument been disposed and rendered unusable?
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	248 */
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	249 boolean isDisposed() {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	250 return isDisposed;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	251 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	252
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	253 abstract AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode);
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	254
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	255 /**
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	256 * An instrument that propagates events to an instance of {@link InstrumentListener}.
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	257 */
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	258 private static final class BasicInstrument extends Instrument {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	259
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	260 /**
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	261 * Tool-supplied listener for events.
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	262 */
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	263 private final InstrumentListener instrumentListener;
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	264
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	265 private BasicInstrument(InstrumentListener basicListener, String instrumentInfo) {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	266 super(instrumentInfo);
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	267 this.instrumentListener = basicListener;
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	268 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	269
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	270 @Override
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	271 AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	272 return new BasicInstrumentNode(nextNode);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	273 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	274
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	275 @Override
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	276 AbstractInstrumentNode removeFromChain(AbstractInstrumentNode instrumentNode) {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	277 boolean found = false;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	278 if (instrumentNode != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	279 if (instrumentNode.getInstrument() == this) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	280 // Found the match at the head of the chain
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	281 return instrumentNode.nextInstrument;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	282 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	283 // Match not at the head of the chain; remove it.
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	284 found = instrumentNode.removeFromChain(BasicInstrument.this);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	285 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	286 if (!found) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	287 throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	288 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	289 return instrumentNode;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	290 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	291
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	292 @NodeInfo(cost = NodeCost.NONE)
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	293 private final class BasicInstrumentNode extends AbstractInstrumentNode {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	294
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	295 private BasicInstrumentNode(AbstractInstrumentNode nextNode) {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	296 super(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	297 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	298
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	299 public void enter(Node node, VirtualFrame vFrame) {
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	300 BasicInstrument.this.instrumentListener.enter(BasicInstrument.this.probe);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	301 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	302 nextInstrument.enter(node, vFrame);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	303 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	304 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	305
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	306 public void returnVoid(Node node, VirtualFrame vFrame) {
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	307 BasicInstrument.this.instrumentListener.returnVoid(BasicInstrument.this.probe);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	308 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	309 nextInstrument.returnVoid(node, vFrame);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	310 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	311 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	312
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	313 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	314 BasicInstrument.this.instrumentListener.returnValue(BasicInstrument.this.probe, result);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	315 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	316 nextInstrument.returnValue(node, vFrame, result);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	317 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	318 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	319
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	320 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	321 BasicInstrument.this.instrumentListener.returnExceptional(BasicInstrument.this.probe, exception);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	322 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	323 nextInstrument.returnExceptional(node, vFrame, exception);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	324 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	325 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	326
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	327 public String instrumentationInfo() {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	328 final String info = getInstrumentInfo();
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	329 return info != null ? info : instrumentListener.getClass().getSimpleName();
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	330 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	331 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	332 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	333
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	334 /**
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	335 * Removes this instrument from an instrument chain.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	336 */
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	337 abstract AbstractInstrumentNode removeFromChain(AbstractInstrumentNode instrumentNode);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	338
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	339 /**
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	340 * An instrument that propagates events to an instance of {@link ASTInstrumentListener}.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	341 */
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	342 private static final class ASTInstrument extends Instrument {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	343
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	344 /**
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	345 * Tool-supplied listener for AST events.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	346 */
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	347 private final ASTInstrumentListener astListener;
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	348
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	349 private ASTInstrument(ASTInstrumentListener astListener, String instrumentInfo) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	350 super(instrumentInfo);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	351 this.astListener = astListener;
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	352 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	353
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	354 @Override
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	355 AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	356 return new ASTInstrumentNode(nextNode);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	357 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	358
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	359 @Override
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	360 AbstractInstrumentNode removeFromChain(AbstractInstrumentNode instrumentNode) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	361 boolean found = false;
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	362 if (instrumentNode != null) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	363 if (instrumentNode.getInstrument() == this) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	364 // Found the match at the head of the chain
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	365 return instrumentNode.nextInstrument;
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	366 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	367 // Match not at the head of the chain; remove it.
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	368 found = instrumentNode.removeFromChain(ASTInstrument.this);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	369 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	370 if (!found) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	371 throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	372 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	373 return instrumentNode;
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	374 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	375
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	376 @NodeInfo(cost = NodeCost.NONE)
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	377 private final class ASTInstrumentNode extends AbstractInstrumentNode {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	378
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	379 private ASTInstrumentNode(AbstractInstrumentNode nextNode) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	380 super(nextNode);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	381 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	382
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	383 public void enter(Node node, VirtualFrame vFrame) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	384 ASTInstrument.this.astListener.enter(ASTInstrument.this.probe, node, vFrame);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	385 if (nextInstrument != null) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	386 nextInstrument.enter(node, vFrame);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	387 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	388 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	389
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	390 public void returnVoid(Node node, VirtualFrame vFrame) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	391 ASTInstrument.this.astListener.returnVoid(ASTInstrument.this.probe, node, vFrame);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	392 if (nextInstrument != null) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	393 nextInstrument.returnVoid(node, vFrame);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	394 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	395 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	396
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	397 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	398 ASTInstrument.this.astListener.returnValue(ASTInstrument.this.probe, node, vFrame, result);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	399 if (nextInstrument != null) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	400 nextInstrument.returnValue(node, vFrame, result);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	401 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	402 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	403
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	404 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	405 ASTInstrument.this.astListener.returnExceptional(ASTInstrument.this.probe, node, vFrame, exception);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	406 if (nextInstrument != null) {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	407 nextInstrument.returnExceptional(node, vFrame, exception);
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	408 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	409 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	410
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	411 public String instrumentationInfo() {
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	412 final String info = getInstrumentInfo();
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	413 return info != null ? info : astListener.getClass().getSimpleName();
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	414 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	415 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	416
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	417 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	418
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	419 public interface TruffleOptListener {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	420 void notifyIsCompiled(boolean isCompiled);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	421 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	422
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	423 private static final class TruffleOptInstrument extends Instrument {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	424
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	425 private final TruffleOptListener toolOptListener;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	426
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	427 private TruffleOptInstrument(TruffleOptListener listener, String instrumentInfo) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	428 super(instrumentInfo);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	429 this.toolOptListener = listener;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	430 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	431
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	432 @Override
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	433 AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode) {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	434 return new TruffleOptInstrumentNode(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	435 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	436
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	437 @Override
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	438 AbstractInstrumentNode removeFromChain(AbstractInstrumentNode instrumentNode) {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	439 boolean found = false;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	440 if (instrumentNode != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	441 if (instrumentNode.getInstrument() == this) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	442 // Found the match at the head of the chain
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	443 return instrumentNode.nextInstrument;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	444 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	445 // Match not at the head of the chain; remove it.
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	446 found = instrumentNode.removeFromChain(TruffleOptInstrument.this);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	447 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	448 if (!found) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	449 throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	450 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	451 return instrumentNode;
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	452 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	453
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	454 @NodeInfo(cost = NodeCost.NONE)
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	455 private final class TruffleOptInstrumentNode extends AbstractInstrumentNode {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	456
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	457 private boolean isCompiled;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	458
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	459 private TruffleOptInstrumentNode(AbstractInstrumentNode nextNode) {
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	460 super(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	461 this.isCompiled = CompilerDirectives.inCompiledCode();
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	462 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	463
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	464 public void enter(Node node, VirtualFrame vFrame) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	465 if (this.isCompiled != CompilerDirectives.inCompiledCode()) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	466 this.isCompiled = CompilerDirectives.inCompiledCode();
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	467 TruffleOptInstrument.this.toolOptListener.notifyIsCompiled(this.isCompiled);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	468 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	469 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	470 nextInstrument.enter(node, vFrame);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	471 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	472 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	473
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	474 public void returnVoid(Node node, VirtualFrame vFrame) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	475 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	476 nextInstrument.returnVoid(node, vFrame);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	477 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	478 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	479
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	480 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	481 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	482 nextInstrument.returnValue(node, vFrame, result);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	483 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	484 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	485
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	486 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	487 if (nextInstrument != null) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	488 nextInstrument.returnExceptional(node, vFrame, exception);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	489 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	490 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	491
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	492 public String instrumentationInfo() {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	493 final String info = getInstrumentInfo();
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	494 return info != null ? info : toolOptListener.getClass().getSimpleName();
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	495 }
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	496 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	497
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	498 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	499
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	500 @NodeInfo(cost = NodeCost.NONE)
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	501 abstract class AbstractInstrumentNode extends Node implements TruffleEvents, InstrumentationNode {
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	502
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	503 @Child protected AbstractInstrumentNode nextInstrument;
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	504
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	505 protected AbstractInstrumentNode(AbstractInstrumentNode nextNode) {
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	506 this.nextInstrument = nextNode;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	507 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	508
18985 867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	509 @Override
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	510 public boolean isInstrumentable() {
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	511 return false;
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	512 }
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	513
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	514 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	515 * Gets the instrument that created this node.
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	516 */
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	517 private Instrument getInstrument() {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	518 return Instrument.this;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	519 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	520
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	521 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	522 * Removes the node from this chain that was added by a particular instrument, assuming that
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	523 * the head of the chain is not the one to be replaced. This is awkward, but is required
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	524 * because {@link Node#replace(Node)} won't take a {@code null} argument. This doesn't work
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	525 * for the tail of the list, which would be replacing itself with null. So the replacement
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	526 * must be directed the parent of the node being removed.
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	527 */
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	528 private boolean removeFromChain(Instrument instrument) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	529 assert getInstrument() != instrument;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	530 if (nextInstrument == null) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	531 return false;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	532 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	533 if (nextInstrument.getInstrument() == instrument) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	534 // Next is the one to remove
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	535 if (nextInstrument.nextInstrument == null) {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	536 // Next is at the tail; just forget
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	537 nextInstrument = null;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	538 } else {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	539 // Replace next with its successor
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	540 nextInstrument.replace(nextInstrument.nextInstrument);
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	541 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	542 return true;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	543 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	544 return nextInstrument.removeFromChain(instrument);
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	545 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	546
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	547 protected String getInstrumentInfo() {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	548 return Instrument.this.instrumentInfo;
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	549 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	550
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	551 }
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	552
0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	553 }

Mercurial > hg > truffle

annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java @ 19818:907128d02b31