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 @ 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

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Sun, 12 Apr 2015 22:37:16 -0700
parents	129a09815063
children	f166d264af9f

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
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	33 // TODO (mlvdv) move all this to a factory implemented in .impl (together with Probe),
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	34 // then break out some of the nested classes into package privates.
15279 0c6d8a08e31b Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	35 /**
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	36 * 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	37 * <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	38 * <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	39 * 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	40 * <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	41 * </ol>
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	42 * <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	43 * Client-oriented documentation for the use of Instruments is available online at <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	44 * HREF="https://wiki.openjdk.java.net/display/Graal/Listening+for+Execution+Events">Listening for
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	45 * 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	46 * <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	47 * 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	48 * 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	49 * 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	50 * <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	51 * 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	52 * 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	53 * 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	54 * 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	55 * <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	56 * 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	57 * {@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	58 * (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	59 * <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	60 * <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	61 * <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	62 * <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	63 * <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	64 * <em>listener.</em></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	65 * <li>Multiple Instruments may share a single listener.</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	66 * <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	67 * 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	68 * to the Instrument's listener.</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	69 * <li>Neither Instruments nor Probes are {@link Node}s.</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	70 * <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	71 * <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	72 * <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	73 * along with the rest 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	74 * <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	75 * 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	76 * {@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	77 * managed by the Probe, i.e. one node instance per existing 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	78 * <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	79 * 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	80 * <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	81 * 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	82 * </li>
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	83 * <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	84 * 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	85 * its private Node type.</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	86 * <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	87 * AST.</li>
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	88 * </ul>
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	89 *
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	90 * @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	91 * @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	92 */
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	93 public abstract class Instrument {
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	94
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	95 /**
19247 128586040207 Truffle/Instrumentation: TruffleEventReceiver renamed to TruffleEventListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18985 diff changeset	96 * 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	97 *
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	98 * @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	99 * @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	100 * @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	101 */
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	102 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	103 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	104 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	105
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	106 /**
19818 907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	107 * 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	108 * 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	109 *
20891 129a09815063 Truffle/Instrumentation: eclipseformat Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20890 diff changeset	110 * @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	111 * 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	112 * @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	113 * @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	114 */
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	115 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	116 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	117 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	118
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	119 /**
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	120 * 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	121 * 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	122 *
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	123 * @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	124 * @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	125 * 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	126 * @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	127 */
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	128 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	129 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	130 }
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
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	132 // 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	133 /**
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	134 * 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	135 */
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	136 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	137 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	138 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	139
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	140 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	141 * 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	142 */
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 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	144
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	145 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	146
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	147 /**
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	148 * 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	149 */
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	150 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	151
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	152 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	153 this.instrumentInfo = instrumentInfo;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	154 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	155
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 /**
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	157 * 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	158 *
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	159 * @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	160 */
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	161 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	162 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	163 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	164 }
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	165 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	166 // 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	167 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	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 this.isDisposed = true;
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	170 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	171
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	172 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	173 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	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
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 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	177 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	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
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	180 /**
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	181 * 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	182 */
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 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	184 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	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
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	187 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	188
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	189 /**
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	190 * 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	191 */
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	192 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	193
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	194 /**
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	195 * 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	196 */
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	197 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	198
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	199 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	200 super(instrumentInfo);
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	201 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	202 }
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 @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	205 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	206 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	207 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	208
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	209 @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	210 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	211 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	212 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	213 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	214 // 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	215 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	216 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	217 // 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	218 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	219 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	220 if (!found) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	221 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	222 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	223 return instrumentNode;
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	224 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	225
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	226 @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	227 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	228
20889 73b1844b5b14 Truffle/Instrumentation: rename InstrumentListener to SimpleInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20885 diff changeset	229 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	230 super(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	231 }
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 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	234 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	235 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	236 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	237 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	238 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	239
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	240 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	241 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	242 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	243 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	244 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	245 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	246
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	247 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	248 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	249 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	250 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	251 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	252 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	253
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	254 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	255 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	256 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	257 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	258 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	259 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	260
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	261 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	262 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	263 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	264 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	265 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	266 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	267
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	268 /**
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	269 * 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	270 */
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	271 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	272
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	273 /**
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	274 * 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	275 */
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	276 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	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 * 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	280 */
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	281 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	282
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	283 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	284 super(instrumentInfo);
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	285 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	286 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 @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	289 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	290 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	291 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	293 @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	294 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	295 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	296 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	297 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	298 // 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	299 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	300 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 // 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	302 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	303 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 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	305 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	306 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 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	308 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	309
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 @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	311 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	312
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	313 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	314 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	315 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 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	318 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	319 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	320 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	321 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	323
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 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	325 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	326 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	327 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	328 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	329 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	330
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	331 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	332 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	333 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	334 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	335 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	336 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	337
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for 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 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	339 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	340 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	341 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	342 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	343 }
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	344
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	345 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	346 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	347 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	348 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	349 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	350 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	351
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	352 // 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	353 /**
20890 263ab98b3bf0 Truffle/Instrumentation: rename ASTInstrumentListener to StandardInstrumentListener Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20889 diff changeset	354 * 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	355 */
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	356 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	357
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	358 /**
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	359 * 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	360 */
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	361 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	362
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 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	364 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	365 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	366 }
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 @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	369 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	370 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	371 }
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 @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	374 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	375 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	376 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	377 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	378 // 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	379 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	380 }
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 // 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	382 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	383 }
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 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	385 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	386 }
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 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	388 }
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
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 @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	391 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	392
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 @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	394
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 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	396 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	397 }
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 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	400 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	401 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	402 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	403 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	404 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	405 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	406 }
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 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	409 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	410 }
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 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	412 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	413 }
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 }
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
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 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	417 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	418 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	419 }
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 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	421 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	422 }
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 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	426 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	427 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	428 }
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 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	430 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	431 }
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 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	435 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	436 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	437 }
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 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	439 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	440 }
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 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	444 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	445 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	446 }
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 }
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
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	450 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	451 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	452 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	453
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	454 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	455
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	456 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	457
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	458 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	459 super(instrumentInfo);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	460 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	461 }
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 @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	464 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	465 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	466 }
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 @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	469 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	470 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	471 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	472 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	473 // 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	474 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	475 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	476 // 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	477 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	478 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	479 if (!found) {
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	480 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	481 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	482 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	483 }
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	484
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	485 @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	486 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	487
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	488 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	489
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	490 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	491 super(nextNode);
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	492 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	493 }
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 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	496 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	497 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	498 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	499 }
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	500 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	501 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	502 }
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 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	506 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	507 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	508 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	509 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	510
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	511 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	512 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	513 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	514 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	515 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	516
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	517 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	518 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	519 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	520 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	521 }
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	522
10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	523 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	524 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	525 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	526 }
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	527 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	528 }
be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	529
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	530 @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	531 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	532
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	533 @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	534
907128d02b31 Truffle/Instrumentation: For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19645 diff changeset	535 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	536 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	537 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	538
18985 867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	539 @Override
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	540 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	541 return false;
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	542 }
867058575979 Truffle: Improved support for "probing" AST nodes: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	543
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	544 /**
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18131 diff changeset	545 * 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	546 */
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 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	548 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	549 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	550
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	551 /**
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	552 * 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	553 * 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	554 * 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	555 * 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	556 * 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	557 */
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 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	559 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	560 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	561 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	562 }
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	563 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	564 // 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	565 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	566 // 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	567 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	568 } 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	569 // 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	570 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	571 }
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 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	573 }
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	574 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	575 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	576
19645 10a1fc5e3209 Truffle/Instrumentation: new, experimental kind of Instrument Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19518 diff changeset	577 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	578 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	579 }
15450 be0c151d912b Truffle/Instrumentation: API revisions Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 15279 diff changeset	580 }
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	581 }

Mercurial > hg > truffle

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