comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ASTInstrumentListener.java @ 19826:a5b09092003a

Truffle/Instrumentation (part 2): For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface.
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Thu, 12 Mar 2015 18:04:30 -0700
parents
children 37912559d662
comparison
equal deleted inserted replaced
19825:907128d02b31 19826:a5b09092003a
1 /*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package com.oracle.truffle.api.instrument;
26
27 import com.oracle.truffle.api.frame.*;
28 import com.oracle.truffle.api.nodes.*;
29
30 /**
31 * A listener of Truffle AST runtime execution events that can collect information, examine the
32 * execution state at a particular node, and possibly intervene on behalf of an external tool.
33 */
34 public interface ASTInstrumentListener {
35
36 /**
37 * Receive notification that an AST node's execute method is about to be called.
38 */
39 void enter(Probe probe, Node node, VirtualFrame vFrame);
40
41 /**
42 * Receive notification that an AST Node's {@code void}-valued execute method has just returned.
43 */
44 void returnVoid(Probe probe, Node node, VirtualFrame vFrame);
45
46 /**
47 * Receive notification that an AST Node's execute method has just returned a value (boxed if
48 * primitive).
49 */
50 void returnValue(Probe probe, Node node, VirtualFrame vFrame, Object result);
51
52 /**
53 * Receive notification that an AST Node's execute method has just thrown an exception.
54 */
55 void returnExceptional(Probe probe, Node node, VirtualFrame vFrame, Exception exception);
56
57 }