annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/AssumedValue.java @ 13322:f28ea693056f

New assumption utilities.
author Chris Seaton <chris.seaton@oracle.com>
date Fri, 13 Dec 2013 15:53:30 +0000
parents
children 0e7894989f37
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13322
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
1 /*
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
4 *
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
10 *
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
15 * accompanied this code).
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
16 *
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
20 *
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
23 * questions.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
24 */
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
25 package com.oracle.truffle.api.utilities;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
26
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
27 import com.oracle.truffle.api.*;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
28 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
29 import com.oracle.truffle.api.nodes.*;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
30
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
31 /**
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
32 * A {@link CompilationFinal} value combined with an {@link Assumption} to notify when it changes.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
33 * Note that you should be careful that modifications to this value do not cause deoptimization
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
34 * loops. This could be by using a value that is monotonic.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
35 */
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
36 public class AssumedValue<T> {
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
37
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
38 @CompilationFinal private T value;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
39 private final CyclicAssumption assumption;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
40
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
41 public AssumedValue(String name, T initialValue) {
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
42 assumption = new CyclicAssumption(name);
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
43 value = initialValue;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
44 }
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
45
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
46 /**
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
47 * Get the current value, updating it if it has been {@link #set}. The compiler may be able to
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
48 * make this method return a constant value, but still accommodate mutation.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
49 */
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
50 public T get() {
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
51 try {
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
52 assumption.getAssumption().check();
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
53 } catch (InvalidAssumptionException e) {
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
54 // No need to rewrite anything - just pick up the new value
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
55 }
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
56
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
57 return value;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
58 }
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
59
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
60 /**
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
61 * Set a new value, which will be picked up the next time {@link #get} is called.
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
62 */
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
63 public void set(T newValue) {
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
64 value = newValue;
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
65 assumption.invalidate();
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
66 }
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
67
f28ea693056f New assumption utilities.
Chris Seaton <chris.seaton@oracle.com>
parents:
diff changeset
68 }