Mercurial > hg > truffle

comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/InstrumentationNode.java @ 21951:9c8c0937da41

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moving all sources into truffle subdirectory
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 17 Jun 2015 10:58:08 +0200
parents graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/InstrumentationNode.java@37912559d662
children dc83cc1f94f2
comparison
equal deleted inserted replaced
21950:2a5011c7e641 21951:9c8c0937da41
1 /*
2 * Copyright (c) 2014, 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 marker interface for Truffle {@linkplain Node nodes} that internally implement the
32 * <em>Instrumentation Framework</em>. Such nodes should not be part of any Guest Language execution
33 * semantics, and should in general not be visible to ordinary Instrumentation clients.
34 */
35 public interface InstrumentationNode {
36
37 /**
38 * A short description of the particular role played by the node, intended to support debugging.
39 */
40 String instrumentationInfo();
41
42 /**
43 * Events that propagate through the {@linkplain InstrumentationNode implementation nodes} of
44 * the Instrumentation Framework, not visible in this form to Instrumentation clients.
45 */
46 interface TruffleEvents {
47
48 /**
49 * An AST node's execute method is about to be called.
50 */
51 void enter(Node node, VirtualFrame vFrame);
52
53 /**
54 * An AST Node's {@code void}-valued execute method has just returned.
55 */
56 void returnVoid(Node node, VirtualFrame vFrame);
57
58 /**
59 * An AST Node's execute method has just returned a value (boxed if primitive).
60 */
61 void returnValue(Node node, VirtualFrame vFrame, Object result);
62
63 /**
64 * An AST Node's execute method has just thrown an exception.
65 */
66 void returnExceptional(Node node, VirtualFrame vFrame, Exception exception);
67 }
68 }