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 @ 20908:f166d264af9f

Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors.

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Mon, 13 Apr 2015 15:00:57 -0700
parents	ca13a009e38b
children	f96165ecb6f1

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.*;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	28 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	29 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	30 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	31 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	32
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	33 // TODO (mlvdv) these statics should not be global. Move them to some kind of context.
f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	34 // TODO (mlvdv) migrate factory into .impl (together with Probe)? break out nested classes?
f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	35
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	36 /**
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	37 * A <em>binding</em> between:
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	38 * <ol>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	39 * <li>A {@link Probe}: a source of <em>execution events</em> taking place at a program location in
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	40 * an executing Truffle AST, and</li>
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	41 * <li>A <em>listener</em>: a consumer of execution events on behalf of an external client.
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	42 * </ol>
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	43 * <p>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	44 * Client-oriented documentation for the use of Instruments is available online at <a
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	45 * HREF="https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events"
f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	46 * >https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events</a>
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	47 * <p>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	48 * The implementation of Instruments is complicated by the requirement that Truffle be able to clone
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	49 * ASTs at any time. In particular, any instrumentation-supporting Nodes that have been attached to
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	50 * an AST must be cloned along with the AST: AST clones are not permitted to share 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	51 * <p>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	52 * AST cloning is intended to be as <em>transparent</em> as possible to clients. This is encouraged
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	53 * by providing the {@link SimpleInstrumentListener} for clients that need know nothing more than
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	54 * the properties associated with a Probe: it's {@link SourceSection} and any associated instances
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	55 * of {@link SyntaxTag}.
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	56 * <p>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	57 * AST cloning is <em>not transparent</em> to clients that use the
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	58 * {@link StandardInstrumentListener}, since those event methods identify the concrete Node instance
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	59 * (and thus the AST instance) where the event takes place.
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	60 * <p>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	61 * <h4>Implementation Notes: the Life Cycle of an {@link Instrument} at a {@link Probe}</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	62 * <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	63 * <ul>
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	64 * <li>A new Instrument is created in permanent association with a client-provided
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	65 * <em>listener.</em></li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	66 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	67 * <li>Multiple Instruments may share a single listener.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	68 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	69 * <li>An Instrument does nothing until it is {@linkplain Probe#attach(Instrument) attached} to a
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	70 * Probe, at which time the Instrument begins routing execution events from the Probe's AST location
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	71 * to the Instrument's listener.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	72 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	73 * <li>Neither Instruments nor Probes are {@link Node}s.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	74 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	75 * <li>A Probe has a single source-based location in an AST, but manages a separate
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	76 * <em>instrumentation chain</em> of Nodes at the equivalent location in each clone of the AST.</li>
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	77 * <li>When a probed AST is cloned, the instrumentation chain associated with each Probe is cloned
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	78 * along with the rest of the AST.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	79 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	80 * <li>When a new Instrument (for example an instance of {@link SimpleInstrument} is attached to a
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	81 * Probe, the Instrument inserts a new instance of its private Node type,
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	82 * {@link SimpleInstrument.SimpleInstrumentNode}, into <em>each of the instrument chains</em>
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	83 * managed by the Probe, i.e. one node instance per existing clone of the AST.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	84 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	85 * <li>If an Instrument is attached to a Probe in an AST that subsequently gets cloned, then the
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	86 * Instrument's private Node type will be cloned along with the rest of the the AST.</li>
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	87 * <li>Each Instrument's private Node type is a dynamic inner class whose only state is in the
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	88 * shared (outer) Instrument instance; that state includes a reference to the Instrument's 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	89 * </li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	90 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	91 * <li>When an Instrument that has been attached to a Probe is {@linkplain #dispose() disposed}, the
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	92 * Instrument searches every instrument chain associated with the Probe and removes the instance of
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	93 * its private Node type.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	94 *
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	95 * <li>Attaching and disposing an Instrument at a Probe <em>deoptimizes</em> any compilations of the
ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	96 * AST.</li>
20908 f166d264af9f Truflfe/Instrumentaion: migrate client-oriented notes on Probes to a newly written documentation page at https://wiki.openjdk.java.net/display/Graal/Finding+Probes. Replace Probe's Javadoc with implementation notes oriented to implementors. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20897 diff changeset	97 *
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	98 * </ul>
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	99 *
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	100 * @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	101 * @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	102 */
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	103 public abstract class Instrument {
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	104
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	105 /**
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	106 * 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	107 *
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	108 * @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	109 * @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	110 * @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	111 */
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	112 public static Instrument create(SimpleInstrumentListener listener, String instrumentInfo) {
73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	113 return new SimpleInstrument(listener, instrumentInfo);
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	114 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	115
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	116 /**
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	117 * 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	118 * 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	119 *
20891 129a09815063 Truffle/Instrumentation: eclipseformat Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20890 diff changeset	120 * @param standardListener a listener for event generated by the instrument that provides access
129a09815063 Truffle/Instrumentation: eclipseformat Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20890 diff changeset	121 * to internal execution state
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	122 * @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	123 * @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	124 */
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	125 public static Instrument create(StandardInstrumentListener standardListener, String instrumentInfo) {
263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	126 return new StandardInstrument(standardListener, instrumentInfo);
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	127 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	128
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	129 /**
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	130 * Creates an instrument that, when executed the first time in any particular AST location,
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	131 * invites the tool to provide an AST fragment for attachment/adoption into the running AST.
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	132 *
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	133 * @param toolNodeListener a listener for the tool that can request an AST fragment
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	134 * @param instrumentInfo instrumentInfo optional description of the instrument's role, useful
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	135 * for debugging.
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	136 * @return a new instrument, ready for attachment at a probe.
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	137 */
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	138 public static Instrument create(ToolNodeInstrumentListener toolNodeListener, String instrumentInfo) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	139 return new ToolNodeInstrument(toolNodeListener, instrumentInfo);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	140 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	141
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	142 // 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	143 /**
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	144 * 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	145 */
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	146 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	147 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	148 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	149
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	150 /**
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 * 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	152 */
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	153 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	154
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	155 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	156
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	157 /**
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	158 * 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	159 */
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	160 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	161
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	162 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	163 this.instrumentInfo = instrumentInfo;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	164 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	165
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	166 /**
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	167 * Removes this instrument from the probe to which it attached and renders the instrument inert.
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	168 *
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	169 * @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	170 */
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	171 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	172 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	173 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	174 }
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 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	176 // 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	177 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	178 }
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 this.isDisposed = true;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	180 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	181
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	182 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	183 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	184 }
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	185
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	186 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	187 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	188 }
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	189
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	190 /**
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	191 * 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	192 */
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	193 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	194 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	195 }
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	196
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	197 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	198
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	199 /**
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	200 * An instrument that propagates events to an instance of {@link SimpleInstrumentListener}.
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	201 */
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	202 private static final class SimpleInstrument 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	203
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	204 /**
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	205 * 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	206 */
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	207 private final SimpleInstrumentListener simpleListener;
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	208
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	209 private SimpleInstrument(SimpleInstrumentListener simpleListener, 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	210 super(instrumentInfo);
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	211 this.simpleListener = simpleListener;
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
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	214 @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	215 AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode) {
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	216 return new SimpleInstrumentNode(nextNode);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	217 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	218
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	219 @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	220 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	221 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	222 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	223 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	224 // Found the match at the head of the chain
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	225 return instrumentNode.nextInstrumentNode;
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	226 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	227 // Match not at the head of the chain; remove it.
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	228 found = instrumentNode.removeFromChain(SimpleInstrument.this);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	229 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	230 if (!found) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	231 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	232 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	233 return instrumentNode;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	234 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	235
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	236 @NodeInfo(cost = NodeCost.NONE)
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	237 private final class SimpleInstrumentNode 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	238
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	239 private SimpleInstrumentNode(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	240 super(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	241 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	242
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	243 public void enter(Node node, VirtualFrame vFrame) {
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	244 SimpleInstrument.this.simpleListener.enter(SimpleInstrument.this.probe);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	245 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	246 nextInstrumentNode.enter(node, vFrame);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	247 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	248 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	249
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	250 public void returnVoid(Node node, VirtualFrame vFrame) {
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	251 SimpleInstrument.this.simpleListener.returnVoid(SimpleInstrument.this.probe);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	252 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	253 nextInstrumentNode.returnVoid(node, vFrame);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	254 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	255 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	256
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	257 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	258 SimpleInstrument.this.simpleListener.returnValue(SimpleInstrument.this.probe, result);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	259 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	260 nextInstrumentNode.returnValue(node, vFrame, result);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	261 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	262 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	263
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	264 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	265 SimpleInstrument.this.simpleListener.returnExceptional(SimpleInstrument.this.probe, exception);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	266 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	267 nextInstrumentNode.returnExceptional(node, vFrame, exception);
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
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	271 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	272 final String info = getInstrumentInfo();
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	273 return info != null ? info : simpleListener.getClass().getSimpleName();
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	274 }
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	275 }
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 }
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	277
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	278 /**
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	279 * 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	280 */
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	281 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	282
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	283 /**
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	284 * An instrument that propagates events to an instance of {@link StandardInstrumentListener}.
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	285 */
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	286 private static final class StandardInstrument extends Instrument {
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	287
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	288 /**
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	289 * 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	290 */
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	291 private final StandardInstrumentListener standardListener;
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	292
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	293 private StandardInstrument(StandardInstrumentListener standardListener, String 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	294 super(instrumentInfo);
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	295 this.standardListener = standardListener;
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	296 }
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	297
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	298 @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	299 AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode) {
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	300 return new StandardInstrumentNode(nextNode);
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	301 }
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	302
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	303 @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	304 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	305 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	306 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	307 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	308 // Found the match at the head of the chain
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	309 return instrumentNode.nextInstrumentNode;
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	310 }
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	311 // Match not at the head of the chain; remove it.
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	312 found = instrumentNode.removeFromChain(StandardInstrument.this);
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	313 }
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 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	315 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	316 }
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	317 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	318 }
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	319
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	320 @NodeInfo(cost = NodeCost.NONE)
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	321 private final class StandardInstrumentNode extends AbstractInstrumentNode {
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	322
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	323 private StandardInstrumentNode(AbstractInstrumentNode nextNode) {
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	324 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	325 }
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	326
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	327 public void enter(Node node, VirtualFrame vFrame) {
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	328 standardListener.enter(StandardInstrument.this.probe, node, vFrame);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	329 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	330 nextInstrumentNode.enter(node, 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	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 public void returnVoid(Node node, VirtualFrame vFrame) {
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	335 standardListener.returnVoid(StandardInstrument.this.probe, node, vFrame);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	336 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	337 nextInstrumentNode.returnVoid(node, 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	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
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 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	342 standardListener.returnValue(StandardInstrument.this.probe, node, vFrame, result);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	343 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	344 nextInstrumentNode.returnValue(node, vFrame, 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	345 }
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
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 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	349 standardListener.returnExceptional(StandardInstrument.this.probe, node, vFrame, exception);
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	350 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	351 nextInstrumentNode.returnExceptional(node, vFrame, 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	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
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 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	356 final String info = getInstrumentInfo();
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	357 return info != null ? info : standardListener.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	358 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	359 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	360 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	361
20897 ca13a009e38b Truffle/Instrumentation: Javadoc on Instrument now includes more thorough notes describing the implementation; client-oriented notes have been rewritten into a documentation page: https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20891 diff changeset	362 // TODO (mlvdv) EXPERIMENTAL- UNDER DEVELOPMENT
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	363 /**
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	364 * An instrument that propagates events to an instance of {@link StandardInstrumentListener}.
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	365 */
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	366 private static final class ToolNodeInstrument extends Instrument {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	367
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	368 /**
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	369 * Tool-supplied listener for AST events.
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	370 */
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	371 private final ToolNodeInstrumentListener toolNodeListener;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	372
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	373 private ToolNodeInstrument(ToolNodeInstrumentListener toolNodeListener, String instrumentInfo) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	374 super(instrumentInfo);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	375 this.toolNodeListener = toolNodeListener;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	376 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	377
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	378 @Override
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	379 AbstractInstrumentNode addToChain(AbstractInstrumentNode nextNode) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	380 return new ToolInstrumentNode(nextNode);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	381 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	382
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	383 @Override
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	384 AbstractInstrumentNode removeFromChain(AbstractInstrumentNode instrumentNode) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	385 boolean found = false;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	386 if (instrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	387 if (instrumentNode.getInstrument() == this) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	388 // Found the match at the head of the chain
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	389 return instrumentNode.nextInstrumentNode;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	390 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	391 // Match not at the head of the chain; remove it.
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	392 found = instrumentNode.removeFromChain(ToolNodeInstrument.this);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	393 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	394 if (!found) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	395 throw new IllegalStateException("Couldn't find instrument node to remove: " + this);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	396 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	397 return instrumentNode;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	398 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	399
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	400 @NodeInfo(cost = NodeCost.NONE)
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	401 private final class ToolInstrumentNode extends AbstractInstrumentNode {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	402
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	403 @Child ToolNode toolNode;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	404
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	405 private ToolInstrumentNode(AbstractInstrumentNode nextNode) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	406 super(nextNode);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	407 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	408
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	409 public void enter(Node node, VirtualFrame vFrame) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	410 if (toolNode == null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	411 final ToolNode newToolNode = ToolNodeInstrument.this.toolNodeListener.getToolNode(ToolNodeInstrument.this.probe);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	412 if (newToolNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	413 toolNode = newToolNode;
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	414 adoptChildren();
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	415 ToolNodeInstrument.this.probe.invalidateProbeUnchanged();
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	416 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	417 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	418 if (toolNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	419 toolNode.enter(node, vFrame);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	420 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	421 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	422 nextInstrumentNode.enter(node, vFrame);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	423 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	424 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	425
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	426 public void returnVoid(Node node, VirtualFrame vFrame) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	427 if (toolNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	428 toolNode.returnVoid(node, vFrame);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	429 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	430 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	431 nextInstrumentNode.returnVoid(node, vFrame);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	432 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	433 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	434
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	435 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	436 if (toolNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	437 toolNode.returnValue(node, vFrame, result);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	438 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	439 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	440 nextInstrumentNode.returnValue(node, vFrame, result);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	441 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	442 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	443
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	444 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	445 if (toolNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	446 toolNode.returnExceptional(node, vFrame, exception);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	447 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	448 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	449 nextInstrumentNode.returnExceptional(node, vFrame, exception);
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	450 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	451 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	452
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	453 public String instrumentationInfo() {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	454 final String info = getInstrumentInfo();
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	455 return info != null ? info : toolNodeListener.getClass().getSimpleName();
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	456 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	457 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	458 }
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	459
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	460 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	461 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	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 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	465
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	466 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	467
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	468 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	469 super(instrumentInfo);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	470 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	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 @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	474 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	475 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	476 }
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 @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	479 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	480 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	481 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	482 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	483 // Found the match at the head of the chain
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	484 return instrumentNode.nextInstrumentNode;
19645 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 // 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	487 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	488 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	489 if (!found) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	490 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	491 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	492 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	493 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	494
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	495 @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	496 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	497
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	498 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	499
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	500 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	501 super(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	502 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	503 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	504
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	505 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	506 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	507 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	508 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	509 }
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	510 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	511 nextInstrumentNode.enter(node, vFrame);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	512 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	513 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	514
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	515 public void returnVoid(Node node, VirtualFrame vFrame) {
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	516 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	517 nextInstrumentNode.returnVoid(node, vFrame);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	518 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	519 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	520
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	521 public void returnValue(Node node, VirtualFrame vFrame, Object result) {
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	522 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	523 nextInstrumentNode.returnValue(node, vFrame, result);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	524 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	525 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	526
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	527 public void returnExceptional(Node node, VirtualFrame vFrame, Exception exception) {
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	528 if (nextInstrumentNode != null) {
2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	529 nextInstrumentNode.returnExceptional(node, vFrame, exception);
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	530 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	531 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	532
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	533 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	534 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	535 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	536 }
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	537 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	538 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	539
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	540 @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	541 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	542
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	543 @Child protected AbstractInstrumentNode nextInstrumentNode;
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	544
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	545 protected AbstractInstrumentNode(AbstractInstrumentNode nextNode) {
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	546 this.nextInstrumentNode = 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	547 }
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	548
18985 867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	549 @Override
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	550 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	551 return false;
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	552 }
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	553
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	554 /**
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	555 * 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	556 */
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	557 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	558 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	559 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	560
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	561 /**
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	562 * 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	563 * 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	564 * 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	565 * 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	566 * 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	567 */
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	568 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	569 assert getInstrument() != instrument;
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	570 if (nextInstrumentNode == 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	571 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	572 }
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	573 if (nextInstrumentNode.getInstrument() == instrument) {
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	574 // Next is the one to remove
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	575 if (nextInstrumentNode.nextInstrumentNode == 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	576 // Next is at the tail; just forget
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	577 nextInstrumentNode = 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	578 } 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	579 // Replace next with its successor
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	580 nextInstrumentNode.replace(nextInstrumentNode.nextInstrumentNode);
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	581 }
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	582 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	583 }
20106 2e3cc2a27711 Truffle/Instrumentation: a new flavor of Instrument that lazily provides an AST fragment to be attached/adopted directly into a running AST, and to which execution event notifications will be routed. Important use cases so far include conditional breakpoints (with optimizeable conditions) and Ruby set_trace_func. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19818 diff changeset	584 return nextInstrumentNode.removeFromChain(instrument);
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	585 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	586
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	587 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	588 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	589 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	590 }
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	591 }

Mercurial > hg > truffle

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