Mercurial > hg > truffle

annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/CountingConditionProfile.java @ 16852:3c114b3e08c3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle: renamed BooleanConditionProfile to BinaryConditionProfile and IntegerConditionProfile to CountingConditionProfile.
author Christian Humer <christian.humer@gmail.com>
date Mon, 18 Aug 2014 19:00:20 +0200
parents graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/IntegerConditionProfile.java@2834af86f398
children fa5e62620593
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
1 /*
16852
3c114b3e08c3 Truffle: renamed BooleanConditionProfile to BinaryConditionProfile and IntegerConditionProfile to CountingConditionProfile.
Christian Humer <christian.humer@gmail.com>
parents: 16828
diff changeset
2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
4 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
10 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
15 * accompanied this code).
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
16 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
20 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
23 * questions.
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
24 */
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
25 package com.oracle.truffle.api.utilities;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
26
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
27 import com.oracle.truffle.api.*;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
28 import com.oracle.truffle.api.CompilerDirectives.*;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
29
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
30 /**
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
31 * Utility class to speculate on conditions to be never true or to be never false. Additionally to
16852
3c114b3e08c3 Truffle: renamed BooleanConditionProfile to BinaryConditionProfile and IntegerConditionProfile to CountingConditionProfile.
Christian Humer <christian.humer@gmail.com>
parents: 16828
diff changeset
32 * {@link BinaryConditionProfile} this implementation of {@link ConditionProfile} also counts the
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
33 * number of times the condition was true and false. This information is reported to the underlying
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
34 * optimization system using {@link CompilerDirectives#injectBranchProbability(double, boolean)}.
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
35 * Condition profiles are intended to be used as part of if conditions.
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
36 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
37 * Example usage:
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
38 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
39 * <pre>
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
40 * private final ConditionProfile zero = new IntegerConditionProfile();
16852
3c114b3e08c3 Truffle: renamed BooleanConditionProfile to BinaryConditionProfile and IntegerConditionProfile to CountingConditionProfile.
Christian Humer <christian.humer@gmail.com>
parents: 16828
diff changeset
41 *
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
42 * int value = ...;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
43 * if (zero.profile(value == 0)) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
44 * return 0;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
45 * } else {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
46 * return value;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
47 * }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
48 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
49 * </pre>
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
50 *
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
51 * @see ConditionProfile
16852
3c114b3e08c3 Truffle: renamed BooleanConditionProfile to BinaryConditionProfile and IntegerConditionProfile to CountingConditionProfile.
Christian Humer <christian.humer@gmail.com>
parents: 16828
diff changeset
52 * @see CountingConditionProfile
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
53 */
16852
3c114b3e08c3 Truffle: renamed BooleanConditionProfile to BinaryConditionProfile and IntegerConditionProfile to CountingConditionProfile.
Christian Humer <christian.humer@gmail.com>
parents: 16828
diff changeset
54 public class CountingConditionProfile extends ConditionProfile {
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
55
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
56 @CompilationFinal private int trueCount;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
57 @CompilationFinal private int falseCount;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
58
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
59 @Override
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
60 public boolean profile(boolean value) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
61 if (value) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
62 if (trueCount == 0) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
63 CompilerDirectives.transferToInterpreterAndInvalidate();
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
64 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
65 if (CompilerDirectives.inInterpreter()) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
66 trueCount++;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
67 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
68 } else {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
69 if (falseCount == 0) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
70 CompilerDirectives.transferToInterpreterAndInvalidate();
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
71 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
72 if (CompilerDirectives.inInterpreter()) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
73 falseCount++;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
74 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
75 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
76 return CompilerDirectives.injectBranchProbability((double) trueCount / (double) (trueCount + falseCount), value);
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
77 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
78
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
79 public int getTrueCount() {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
80 return trueCount;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
81 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
82
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
83 public int getFalseCount() {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
84 return falseCount;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
85 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
86
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
87 @Override
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
88 public String toString() {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
89 return String.format("%s(trueCount=%s, falseCount=%s)@%x", getClass().getSimpleName(), trueCount, falseCount, hashCode());
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
90 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
91 }