com.oracle.truffle.api.instrument.WrapperNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages that achieves high performance when combined with Graal.
There is a newer version: 1.0.0-rc7
Show newest version
/*
 * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.api.instrument;

import com.oracle.truffle.api.nodes.Node;

/**
 * A specialized {@link Node} instance that must be inserted into a Truffle AST in order to enable
 * {@linkplain Instrumenter instrumentation} at a particular Guest Language (GL) node.
 * 
 * The implementation must be GL-specific. A wrapper decorates a GL AST node (the wrapper's
 * child) by acting as a transparent proxy with respect to the GL's execution
 * semantics.
 * 

 * Instrumentation at the wrapped node is implemented by an instance of {@link EventHandlerNode}
 * attached as a second child of the {@link WrapperNode}.
 * 

 * A wrapper is obliged to notify its attached {@link EventHandlerNode} when execution events occur
 * at the wrapped AST node during program execution.
 * 

 * When a GL AST is cloned, the {@link WrapperNode}, its {@link EventHandlerNode} and any
 * {@linkplain ProbeInstrument instrumentation} are also cloned; they are in effect part of the GL
 * AST. An instance of {@link Probe} represents abstractly the instrumentation at a particular
 * location in a GL AST; it tracks all the copies of the Wrapper and attached instrumentation, and
 * acts as a single point of access for tools.
 * 

 * Implementation guidelines:
 * 

 * Each GL implementation must implement a WrapperNode implementation for each AST context in
 * which Instrumentation is to be supported.
 * The wrapper type should descend from the GL-specific node class.
 * Must have a field: {@code @Child private Node child;}
 * Must have a field: {@code @Child private EventHandlerNode eventHandlerNode;}
 * The wrapper must act as a proxy for its child, which means implementing every
 * possible execute- method that gets called on guest language AST node types by their
 * parents, and passing along each call to its child.
 * Method {@code Probe getProbe()} should be implemented as {@code eventHandlerNode.getProbe();}
 * 
Method {@code insertProbe(EventHandlerNode)} should be implemented as
 * {@code this.eventHandlerNode=insert(eventHandlerNode);}
 * Most importantly, Wrappers must be implemented so that Truffle optimization will reduce their
 * runtime overhead to zero when there are no attached {@link ProbeInstrument}s.
 * 
 * 
 *
 * @see ProbeInstrument
 * @since 0.8 or earlier
 */
@SuppressWarnings("deprecation")
@Deprecated
public interface WrapperNode extends InstrumentationNode {

    /**
     * Gets the node being "wrapped", i.e. the AST node for which {@linkplain EventHandlerNode
     * execution events} will be reported through the Instrumentation Framework.
     *
     * @since 0.8 or earlier
     */
    Node getChild();

    /**
     * Gets the {@link Probe} responsible for installing this wrapper.
     *
     * @since 0.8 or earlier
     */
    Probe getProbe();

    /**
     * Implementation support for completing a newly created wrapper node.
     *
     * @since 0.8 or earlier
     */
    void insertEventHandlerNode(EventHandlerNode eventHandlerNode);
}