Mercurial > hg > truffle
view graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/CallNode.java @ 14569:5e04917e6616
Truffle: renamed NodeFilter to NodeCountFilter and changed it to have inclusive implementation semantics.
author | Christian Humer <christian.humer@gmail.com> |
---|---|
date | Mon, 17 Mar 2014 18:46:39 +0100 |
parents | 6681b9eb3f4c |
children | 6189c1983cd3 |
line wrap: on
line source
/* * Copyright (c) 2012, 2013, 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.nodes; import com.oracle.truffle.api.*; import com.oracle.truffle.api.frame.*; /** * Represents a call to a {@link CallTarget} in the Truffle AST. Addtionally to calling the * {@link CallTarget} this {@link Node} enables the runtime system to implement further * optimizations. Optimizations that can possibly applied to a {@link CallNode} are inlining and * splitting. Inlining inlines this call site into the call graph of the parent {@link CallTarget}. * Splitting duplicates the {@link CallTarget} using {@link RootNode#split()} to collect call site * sensitive profiling information. * * Please note: This class is not intended to be subclassed by guest language implementations. * * @see TruffleRuntime#createCallNode(CallTarget) * @see #inline() * @see #split() */ public abstract class CallNode extends Node { protected final CallTarget callTarget; protected CallNode(CallTarget callTarget) { this.callTarget = callTarget; } /** * Calls the inner {@link CallTarget} returned by {@link #getCurrentCallTarget()}. * * @param caller the caller frame * @param arguments the arguments that should be passed to the callee * @return the return result of the call */ public abstract Object call(PackedFrame caller, Arguments arguments); /** * Returns the originally supplied {@link CallTarget} when this call node was created. Please * note that the returned {@link CallTarget} is not necessarily the {@link CallTarget} that is * called. For that use {@link #getCurrentCallTarget()} instead. * * @return the {@link CallTarget} provided. */ public CallTarget getCallTarget() { return callTarget; } /** * Returns <code>true</code> if the underlying runtime system supports inlining for the * {@link CallTarget} in this {@link CallNode}. * * @return true if inlining is supported. */ public abstract boolean isInlinable(); /** * Returns <code>true</code> if the {@link CallTarget} in this {@link CallNode} is inlined. A * {@link CallNode} can either be inlined manually by invoking {@link #inline()} or by the * runtime system which may at any point decide to inline. * * @return true if this method was inlined else false. */ public abstract boolean isInlined(); /** * Enforces the runtime system to inline the {@link CallTarget} at this call site. If the * runtime system does not support inlining or it is already inlined this method has no effect. */ public abstract void inline(); /** * Returns <code>true</code> if this {@link CallNode} can be split. A {@link CallNode} can only * be split if the runtime system supports splitting and if the {@link RootNode} contained the * {@link CallTarget} returns <code>true</code> for {@link RootNode#isSplittable()}. * * @return <code>true</code> if the target can be split */ public abstract boolean isSplittable(); /** * Enforces the runtime system to split the {@link CallTarget}. If the {@link CallNode} is not * splittable this methods has no effect. */ public abstract boolean split(); /** * Returns <code>true</code> if the target of the {@link CallNode} was split. * * @return if the target was split */ public final boolean isSplit() { return getSplitCallTarget() != null; } /** * Returns the splitted {@link CallTarget} if this method is split. * * @return the split {@link CallTarget} */ public abstract CallTarget getSplitCallTarget(); /** * Returns the used call target when {@link #call(PackedFrame, Arguments)} is invoked. If the * {@link CallTarget} was split this method returns the {@link CallTarget} returned by * {@link #getSplitCallTarget()}. * * @return the used {@link CallTarget} when node is called */ public CallTarget getCurrentCallTarget() { CallTarget split = getSplitCallTarget(); if (split != null) { return split; } else { return getCallTarget(); } } /** * Returns the {@link RootNode} associated with {@link CallTarget} returned by * {@link #getCurrentCallTarget()}. If the stored {@link CallTarget} does not contain a * {@link RootNode} this method returns <code>null</code>. * * @see #getCurrentCallTarget() * @return the root node of the used call target */ public final RootNode getCurrentRootNode() { CallTarget target = getCurrentCallTarget(); if (target instanceof RootCallTarget) { return ((RootCallTarget) target).getRootNode(); } return null; } @Override protected void onReplace(Node newNode, String reason) { super.onReplace(newNode, reason); /* * Old call nodes are removed in the old target root node. */ CallNode oldCall = this; RootNode oldRoot = getCurrentRootNode(); if (oldRoot != null) { oldRoot.removeCachedCallNode(oldCall); } registerCallTarget((CallNode) newNode); } /** * Internal API for the runtime system. */ protected static final void registerCallTarget(CallNode newNode) { RootNode newRoot = newNode.getCurrentRootNode(); if (newRoot != null) { newRoot.addCachedCallNode(newNode); } } }