annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/InlinableCallSite.java @ 11809:c7769440afd8

improve NodeUtil.cloneNode.
author Andreas Woess <andreas.woess@jku.at>
date Wed, 25 Sep 2013 17:34:01 +0200
parents 75d9b7aedcfd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
1 /*
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
2 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
4 *
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
11279
494b818b527c Adding "Classpath" exception to the classes in the com.oracle.truffle.api and the com.oracle.truffle.api.dsl package.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 10794
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
494b818b527c Adding "Classpath" exception to the classes in the com.oracle.truffle.api and the com.oracle.truffle.api.dsl package.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 10794
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
494b818b527c Adding "Classpath" exception to the classes in the com.oracle.truffle.api and the com.oracle.truffle.api.dsl package.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 10794
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
10 *
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
15 * accompanied this code).
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
16 *
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
20 *
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
23 * questions.
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
24 */
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
25 package com.oracle.truffle.api.nodes;
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
26
10794
3fe325c3f31c Truffle: add InlinedCallSite interface and an InlinableCallSite method to query the inlined call target
Andreas Woess <andreas.woess@jku.at>
parents: 10484
diff changeset
27 import com.oracle.truffle.api.*;
3fe325c3f31c Truffle: add InlinedCallSite interface and an InlinableCallSite method to query the inlined call target
Andreas Woess <andreas.woess@jku.at>
parents: 10484
diff changeset
28
11343
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
29 /**
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
30 * Denotes a call node that can inline the tree of its associated call target.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
31 *
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
32 * @see InlinedCallSite
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
33 */
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
34 public interface InlinableCallSite {
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
35
11343
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
36 /**
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
37 * Returns the number of calls since the last reset of the call count.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
38 *
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
39 * @return the current call count.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
40 */
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
41 int getCallCount();
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
42
11343
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
43 /**
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
44 * Resets the call count to 0.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
45 */
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
46 void resetCallCount();
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
47
11343
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
48 /**
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
49 * Returns the tree that would be inlined by a call to {@link #inline(FrameFactory)}.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
50 *
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
51 * @return the node tree to be inlined.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
52 */
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
53 Node getInlineTree();
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
54
11343
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
55 /**
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
56 * Returns the call target associated with this call site.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
57 *
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
58 * @return the inlinable {@link CallTarget}.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
59 */
10794
3fe325c3f31c Truffle: add InlinedCallSite interface and an InlinableCallSite method to query the inlined call target
Andreas Woess <andreas.woess@jku.at>
parents: 10484
diff changeset
60 CallTarget getCallTarget();
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
61
11343
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
62 /**
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
63 * Instructs the call node to inline the associated call target.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
64 *
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
65 * @param factory Frame factory for creating new virtual frames for inlined calls.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
66 * @return {@code true} if call target was inlined; {@code false} otherwise.
75d9b7aedcfd Truffle: added some missing javadoc.
Andreas Woess <andreas.woess@jku.at>
parents: 11279
diff changeset
67 */
10794
3fe325c3f31c Truffle: add InlinedCallSite interface and an InlinableCallSite method to query the inlined call target
Andreas Woess <andreas.woess@jku.at>
parents: 10484
diff changeset
68 boolean inline(FrameFactory factory);
10484
0097fb11c16f Add basic version of Graal's Truffle runtime.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
69 }