Mercurial > hg > truffle

annotate truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/Assumption.java @ 22157:dc83cc1f94f2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Using fully qualified imports
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 16 Sep 2015 11:33:22 +0200
parents 9c8c0937da41
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
1 /*
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
2 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
4 *
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
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: 9259
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: 9259
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: 9259
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
10 *
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
15 * accompanied this code).
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
16 *
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
20 *
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
23 * questions.
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
24 */
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
25 package com.oracle.truffle.api;
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
26
22157
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
27 import com.oracle.truffle.api.nodes.InvalidAssumptionException;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
28 import com.oracle.truffle.api.nodes.Node;
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
29
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
30 /**
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
31 * An assumption is a global boolean flag that starts with the value true (i.e., the assumption is
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
32 * valid) and can subsequently be invalidated (using {@link Assumption#invalidate()}). Once
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
33 * invalidated, an assumption can never get valid again. Assumptions can be created using the
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
34 * {@link TruffleRuntime#createAssumption()} or the {@link TruffleRuntime#createAssumption(String)}
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
35 * method. The Truffle compiler has special knowledge of this class in order to produce efficient
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
36 * machine code for checking an assumption in case the assumption object is a compile time constant.
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
37 * Therefore, assumptions should be stored in final fields in Truffle nodes.
16868
db090a8d3705 clarify documentation about assumption and profile storage in final fields
Michael Haupt <michael.haupt@oracle.com>
parents: 11279
diff changeset
38 *
db090a8d3705 clarify documentation about assumption and profile storage in final fields
Michael Haupt <michael.haupt@oracle.com>
parents: 11279
diff changeset
39 * All instances of classes implementing {@code Assumption} must be held in {@code final} fields for
db090a8d3705 clarify documentation about assumption and profile storage in final fields
Michael Haupt <michael.haupt@oracle.com>
parents: 11279
diff changeset
40 * compiler optimizations to take effect.
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
41 */
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
42 public interface Assumption {
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
43
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
44 /**
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
45 * Checks that this assumption is still valid. The method throws an exception, if this is no
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
46 * longer the case. This method is preferred over the {@link #isValid()} method when writing
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
47 * guest language interpreter code. The catch block should perform a node rewrite (see
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
48 * {@link Node#replace(Node)}) with a node that no longer relies on the assumption.
16868
db090a8d3705 clarify documentation about assumption and profile storage in final fields
Michael Haupt <michael.haupt@oracle.com>
parents: 11279
diff changeset
49 *
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
50 * @throws InvalidAssumptionException If the assumption is no longer valid.
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
51 */
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
52 void check() throws InvalidAssumptionException;
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
53
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
54 /**
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
55 * Checks whether the assumption is still valid.
16868
db090a8d3705 clarify documentation about assumption and profile storage in final fields
Michael Haupt <michael.haupt@oracle.com>
parents: 11279
diff changeset
56 *
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
57 * @return a boolean value indicating the validity of the assumption
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
58 */
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
59 boolean isValid();
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
60
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
61 /**
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
62 * Invalidates this assumption. Performs no operation, if the assumption is already invalid.
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
63 */
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
64 void invalidate();
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
65
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
66 /**
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
67 * A name for the assumption that is used for debug output.
16868
db090a8d3705 clarify documentation about assumption and profile storage in final fields
Michael Haupt <michael.haupt@oracle.com>
parents: 11279
diff changeset
68 *
9259
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
69 * @return the name of the assumption
324dcaedb1ed Added a method isValid to the Assumption class. Added javadoc to the Assumption class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 9258
diff changeset
70 */
9258
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
71 String getName();
07f8d136a05e Truffle API changes for the Frame API. Introduction of Assumptions class.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents:
diff changeset
72 }