Mercurial > hg > truffle
annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/ValueProfile.java @ 19507:1cde96b96673
Fixed code format issues.
author | Roland Schatz <roland.schatz@oracle.com> |
---|---|
date | Thu, 19 Feb 2015 16:15:56 +0100 |
parents | f57d86eb036f |
children | f7b3b0c5c3e5 |
rev | line source |
---|---|
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
1 /* |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved. |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
4 * |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
5 * This code is free software; you can redistribute it and/or modify it |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
6 * under the terms of the GNU General Public License version 2 only, as |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
7 * published by the Free Software Foundation. Oracle designates this |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
8 * particular file as subject to the "Classpath" exception as provided |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
9 * by Oracle in the LICENSE file that accompanied this code. |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
10 * |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
11 * This code is distributed in the hope that it will be useful, but WITHOUT |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
14 * version 2 for more details (a copy is included in the LICENSE file that |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
15 * accompanied this code). |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
16 * |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
17 * You should have received a copy of the GNU General Public License version |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
18 * 2 along with this work; if not, write to the Free Software Foundation, |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
20 * |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
22 * or visit www.oracle.com if you need additional information or have any |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
23 * questions. |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
24 */ |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
25 package com.oracle.truffle.api.utilities; |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
26 |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
27 /** |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
28 * Utility class to speculate on certain properties of values. |
19507
1cde96b96673
Fixed code format issues.
Roland Schatz <roland.schatz@oracle.com>
parents:
18845
diff
changeset
|
29 * |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
30 * Example usage: |
19507
1cde96b96673
Fixed code format issues.
Roland Schatz <roland.schatz@oracle.com>
parents:
18845
diff
changeset
|
31 * |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
32 * <pre> |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
33 * private final ValueProfile classProfile = ValueProfile.createClassProfile(); |
19507
1cde96b96673
Fixed code format issues.
Roland Schatz <roland.schatz@oracle.com>
parents:
18845
diff
changeset
|
34 * |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
35 * return classProfile.profile(value); |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
36 * </pre> |
19507
1cde96b96673
Fixed code format issues.
Roland Schatz <roland.schatz@oracle.com>
parents:
18845
diff
changeset
|
37 * |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
38 * All instances of {@code ValueProfile} (and subclasses) must be held in {@code final} fields for |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
39 * compiler optimizations to take effect. |
19507
1cde96b96673
Fixed code format issues.
Roland Schatz <roland.schatz@oracle.com>
parents:
18845
diff
changeset
|
40 * |
18164
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
41 * @see #createPrimitiveProfile() |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
42 * @see #createIdentityProfile() |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
43 * @see #createClassProfile() |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
44 */ |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
45 public abstract class ValueProfile { |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
46 |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
47 public abstract <T> T profile(T value); |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
48 |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
49 /** |
18168
e93507e232c9
Truffle: correct documentation of createPrimitiveProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
18164
diff
changeset
|
50 * Returns a {@link PrimitiveValueProfile} that speculates on the primitive equality or object |
e93507e232c9
Truffle: correct documentation of createPrimitiveProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
18164
diff
changeset
|
51 * identity of a value. |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
52 */ |
18164
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
53 public static PrimitiveValueProfile createPrimitiveProfile() { |
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
54 return new PrimitiveValueProfile(); |
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
55 } |
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
56 |
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
57 /** |
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
58 * Returns a {@link ValueProfile} that speculates on the exact class of a value. |
53afdc71b311
Truffle: added PrimitiveValueProfile.
Chris Seaton <chris.seaton@oracle.com>
parents:
17039
diff
changeset
|
59 */ |
17039
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
60 public static ValueProfile createClassProfile() { |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
61 return new ExactClassValueProfile(); |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
62 } |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
63 |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
64 /** |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
65 * Returns a {@link ValueProfile} that speculates on the object identity of a value. |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
66 */ |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
67 public static ValueProfile createIdentityProfile() { |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
68 return new IdentityValueProfile(); |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
69 } |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
70 |
1e542561783e
Truffle: new value profiles prototype.
Christian Humer <christian.humer@gmail.com>
parents:
diff
changeset
|
71 } |