annotate truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/CountingConditionProfile.java @ 22548:6b76a24fffbd default tip

Use all variables: a, b, u,v and x, y
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Thu, 14 Jan 2016 14:20:57 +0100
parents a63bda98cfdb
children
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
22157
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
27 import com.oracle.truffle.api.CompilerDirectives;
21554
b1530a6cce8c renamed com.oracle.graal.[debug|options|hotspotvmconfig]* modules to com.oracle.jvmci.[debug|options|hotspotvmconfig]* modules (JBS:GRAAL-53)
Doug Simon <doug.simon@oracle.com>
parents: 16860
diff changeset
28 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
16828
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 /**
22501
a63bda98cfdb Extract profiles into separate package. Add isProfilingEnabled in TruffleRuntime to disable profiling in the default runtime; Add low overhead profiles for primitives; Add LoopConditionProfile; Profile footprint/threadsafety improvements; Make toString implementations more consistent; Greatly enhanced javadoc documentation for profiles; Deprecate old profiles
Christian Humer <christian.humer@oracle.com>
parents: 22389
diff changeset
31 * @deprecated use {@link com.oracle.truffle.api.profiles.ConditionProfile#createCountingProfile()}
a63bda98cfdb Extract profiles into separate package. Add isProfilingEnabled in TruffleRuntime to disable profiling in the default runtime; Add low overhead profiles for primitives; Add LoopConditionProfile; Profile footprint/threadsafety improvements; Make toString implementations more consistent; Greatly enhanced javadoc documentation for profiles; Deprecate old profiles
Christian Humer <christian.humer@oracle.com>
parents: 22389
diff changeset
32 * instead
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
33 */
22501
a63bda98cfdb Extract profiles into separate package. Add isProfilingEnabled in TruffleRuntime to disable profiling in the default runtime; Add low overhead profiles for primitives; Add LoopConditionProfile; Profile footprint/threadsafety improvements; Make toString implementations more consistent; Greatly enhanced javadoc documentation for profiles; Deprecate old profiles
Christian Humer <christian.humer@oracle.com>
parents: 22389
diff changeset
34 @Deprecated
a63bda98cfdb Extract profiles into separate package. Add isProfilingEnabled in TruffleRuntime to disable profiling in the default runtime; Add low overhead profiles for primitives; Add LoopConditionProfile; Profile footprint/threadsafety improvements; Make toString implementations more consistent; Greatly enhanced javadoc documentation for profiles; Deprecate old profiles
Christian Humer <christian.humer@oracle.com>
parents: 22389
diff changeset
35 @SuppressWarnings("deprecation")
16860
fa5e62620593 Truffle: made constructors of condition profiles package protected to delegate them later to TruffleRuntime.
Christian Humer <christian.humer@gmail.com>
parents: 16852
diff changeset
36 public final class CountingConditionProfile extends ConditionProfile {
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
37
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
38 @CompilationFinal private int trueCount;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
39 @CompilationFinal private int falseCount;
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
40
16860
fa5e62620593 Truffle: made constructors of condition profiles package protected to delegate them later to TruffleRuntime.
Christian Humer <christian.humer@gmail.com>
parents: 16852
diff changeset
41 CountingConditionProfile() {
fa5e62620593 Truffle: made constructors of condition profiles package protected to delegate them later to TruffleRuntime.
Christian Humer <christian.humer@gmail.com>
parents: 16852
diff changeset
42 /* package protected constructor */
fa5e62620593 Truffle: made constructors of condition profiles package protected to delegate them later to TruffleRuntime.
Christian Humer <christian.humer@gmail.com>
parents: 16852
diff changeset
43 }
fa5e62620593 Truffle: made constructors of condition profiles package protected to delegate them later to TruffleRuntime.
Christian Humer <christian.humer@gmail.com>
parents: 16852
diff changeset
44
16828
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
45 @Override
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
46 public boolean profile(boolean value) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
47 if (value) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
48 if (trueCount == 0) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
49 CompilerDirectives.transferToInterpreterAndInvalidate();
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 if (CompilerDirectives.inInterpreter()) {
22389
c1dfbaeef4af Profile counts should not overflow, otherwise injectBranchProbability triggers assertion
Stefan Marr <stefan.marr@jku.at>
parents: 22157
diff changeset
52 if (trueCount < Integer.MAX_VALUE) {
c1dfbaeef4af Profile counts should not overflow, otherwise injectBranchProbability triggers assertion
Stefan Marr <stefan.marr@jku.at>
parents: 22157
diff changeset
53 trueCount++;
c1dfbaeef4af Profile counts should not overflow, otherwise injectBranchProbability triggers assertion
Stefan Marr <stefan.marr@jku.at>
parents: 22157
diff changeset
54 }
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 } else {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
57 if (falseCount == 0) {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
58 CompilerDirectives.transferToInterpreterAndInvalidate();
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
59 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
60 if (CompilerDirectives.inInterpreter()) {
22389
c1dfbaeef4af Profile counts should not overflow, otherwise injectBranchProbability triggers assertion
Stefan Marr <stefan.marr@jku.at>
parents: 22157
diff changeset
61 if (falseCount < Integer.MAX_VALUE) {
c1dfbaeef4af Profile counts should not overflow, otherwise injectBranchProbability triggers assertion
Stefan Marr <stefan.marr@jku.at>
parents: 22157
diff changeset
62 falseCount++;
c1dfbaeef4af Profile counts should not overflow, otherwise injectBranchProbability triggers assertion
Stefan Marr <stefan.marr@jku.at>
parents: 22157
diff changeset
63 }
16828
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 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
66 return CompilerDirectives.injectBranchProbability((double) trueCount / (double) (trueCount + falseCount), value);
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
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
69 public int getTrueCount() {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
70 return trueCount;
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
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
73 public int getFalseCount() {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
74 return falseCount;
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
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
77 @Override
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
78 public String toString() {
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
79 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
80 }
2834af86f398 Truffle: new condition profile primitives.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
81 }