Mercurial > hg > graal-compiler
comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ASTNodeProber.java @ 15279:0c6d8a08e31b
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 | 50d79ad439f1 |
comparison
equal
deleted
inserted
replaced
| 14862:0e713dba33bb | 15279:0c6d8a08e31b |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 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 * Implementation of a policy for <em>instrumenting</em> inserting a {@link Probe} at a Truffle AST | |
| 31 * node. | |
| 32 * <p> | |
| 33 * Note that this interface is guest language agnostic, but current extensions are | |
| 34 * language-specific. This will be revisited. | |
| 35 * <p> | |
| 36 * <strong>Disclaimer:</strong> experimental interface under development. Really! | |
| 37 */ | |
| 38 public interface ASTNodeProber { | |
| 39 | |
| 40 /** | |
| 41 * Optionally applies <em>instrumentation</em> at a Truffle AST node, depending on guest | |
| 42 * language characteristics and use-case policy. | |
| 43 * <ul> | |
| 44 * <li>if no instrumentation is to be applied, returns the AST node unmodified;</li> | |
| 45 * <li>if an AST node is to be instrumented, then returns a newly created {@link Wrapper} that | |
| 46 * <em>decorates</em> the AST node and notifies an associated {@link Probe} of all | |
| 47 * {@link ExecutionEvents} at the wrapped AST node.</li> | |
| 48 * <li>if the argument is itself a {@link Wrapper}, i.e. if the AST node at this site has | |
| 49 * already been wrapped, then the wrapper is returned (with the possible addition of a | |
| 50 * {@linkplain PhylumTag tag}).</li> | |
| 51 * </ul> | |
| 52 * | |
| 53 * @param astNode an AST node to which instrumentation might be applied | |
| 54 * @param tag an optional category directing how the node, if instrumented, should be perceived | |
| 55 * by tool users | |
| 56 * @param args additional arguments for instrumentation specific to a particular guest language | |
| 57 * @return if no instrumentation should be applied or if the node is a {@link Wrapper} then the | |
| 58 * unmodified node; otherwise a newly created {@link Wrapper} (whose child | |
| 59 * {@code astNode}) with an associated {@link Probe} . | |
| 60 */ | |
| 61 | |
| 62 Node probeAs(Node astNode, PhylumTag tag, Object... args); | |
| 63 } |