Mercurial > hg > truffle
diff truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/TruffleRuntime.java @ 21951:9c8c0937da41
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/TruffleRuntime.java@656331a61829 |
children | dc83cc1f94f2 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/TruffleRuntime.java Wed Jun 17 10:58:08 2015 +0200 @@ -0,0 +1,168 @@ +/* + * Copyright (c) 2012, 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; + +import java.util.*; + +import com.oracle.truffle.api.frame.*; +import com.oracle.truffle.api.nodes.*; + +/** + * Interface representing a Truffle runtime object. The runtime is responsible for creating call + * targets and performing optimizations for them. + */ +public interface TruffleRuntime { + + /** + * Name describing this runtime implementation for debugging purposes. + * + * @return the name as a String + */ + String getName(); + + /** + * Creates a new call target for a given root node. + * + * @param rootNode the root node whose + * {@link RootNode#execute(com.oracle.truffle.api.frame.VirtualFrame)} method + * represents the entry point + * @return the new call target object + */ + RootCallTarget createCallTarget(RootNode rootNode); + + /** + * Creates a new runtime specific version of {@link DirectCallNode}. + * + * @param target the direct {@link CallTarget} to call + * @return the new call node + */ + DirectCallNode createDirectCallNode(CallTarget target); + + /** + * Experimental API. May change without notice. + */ + LoopNode createLoopNode(RepeatingNode body); + + /** + * Creates a new runtime specific version of {@link IndirectCallNode}. + * + * @return the new call node + */ + IndirectCallNode createIndirectCallNode(); + + /** + * Creates a new assumption object that can be checked and invalidated. + * + * @return the newly created assumption object + */ + Assumption createAssumption(); + + /** + * Creates a new assumption object with a given name that can be checked and invalidated. + * + * @param name the name for the new assumption + * @return the newly created assumption object + */ + Assumption createAssumption(String name); + + /** + * Creates a new virtual frame object that can be used to store values and is potentially + * optimizable by the runtime. + * + * @return the newly created virtual frame object + */ + VirtualFrame createVirtualFrame(Object[] arguments, FrameDescriptor frameDescriptor); + + /** + * Creates a new materialized frame object that can be used to store values. + * + * @return the newly created materialized frame object + */ + MaterializedFrame createMaterializedFrame(Object[] arguments); + + /** + * Creates a new materialized frame object with the given frame descriptor that can be used to + * store values. + * + * @param frameDescriptor the frame descriptor describing this frame's values + * @return the newly created materialized frame object + */ + MaterializedFrame createMaterializedFrame(Object[] arguments, FrameDescriptor frameDescriptor); + + /** + * Creates an object which allows you to test for support of and set options specific for this + * runtime. + * + * @return the newly created compiler options object + */ + CompilerOptions createCompilerOptions(); + + /** + * Accesses the current stack, i.e., the contents of the {@link Frame}s and the associated + * {@link CallTarget}s. Iteration starts at the caller frame, i.e., it does not include the + * current frame. + * + * Iteration continues as long as {@link FrameInstanceVisitor#visitFrame}, which is invoked for + * every {@link FrameInstance}, returns null. Any non-null result of the visitor indicates that + * frame iteration should stop. + * + * @param visitor the visitor that is called for every matching frame. + * @return the last result returned by the visitor (which is non-null to indicate that iteration + * should stop), or null if the whole stack was iterated. + */ + <T> T iterateFrames(FrameInstanceVisitor<T> visitor); + + /** + * Accesses the caller frame. This is a convenience method that returns the first frame that is + * passed to the visitor of {@link #iterateFrames}. + */ + FrameInstance getCallerFrame(); + + /** + * Accesses the current frame, i.e., the frame of the closest {@link CallTarget}. It is + * important to note that this {@link FrameInstance} supports only slow path access. + */ + FrameInstance getCurrentFrame(); + + /** + * Requests a capability from the runtime. + * + * @param capability the type of the interface representing the capability + * @return an implementation of the capability or {@code null} if the runtime does not offer it + */ + <T> T getCapability(Class<T> capability); + + /** + * Returns a list of all still referenced {@link RootCallTarget} instances that were created + * using {@link #createCallTarget(RootNode)}. + */ + Collection<RootCallTarget> getCallTargets(); + + /** + * Internal API method. Do not use. + */ + void notifyTransferToInterpreter(); + +}