Mercurial > hg > graal-compiler

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Wrapper.java @ 15279:0c6d8a08e31b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 20 Apr 2014 20:37:27 -0700
parents
children bb9473723904
comparison
equal deleted inserted replaced
14862:0e713dba33bb 15279:0c6d8a08e31b
1 /*
2 * Copyright (c) 2013, 2014, 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.nodes.*;
28
29 /**
30 * A node that can be inserted into a Truffle AST in order to attach <em>instrumentation</em> at a
31 * particular node.
32 * <p>
33 * A wrapper <em>decorates</em> an AST node (its <em>child</em>) by acting as a transparent
34 * <em>proxy</em> for the child with respect to Truffle execution semantics.
35 * <p>
36 * A wrapper is also expected to notify its associated {@link Probe} when certain
37 * {@link ExecutionEvents} occur at the wrapper during program execution.
38 * <p>
39 * The wrapper's {@link Probe} is shared by every copy of the wrapper made when the AST is copied.
40 * <p>
41 * Wrappers methods must be amenable to Truffle/Graal inlining.
42 * <p>
43 * <strong>Disclaimer:</strong> experimental interface under development.
44 */
45 public interface Wrapper extends PhylumTagged {
46
47 /**
48 * Gets the AST node being instrumented, which should never be an instance of {@link Wrapper}.
49 */
50 Node getChild();
51
52 /**
53 * Gets the {@link Probe} to which events occurring at this wrapper's child are propagated.
54 */
55 Probe getProbe();
56
57 }