com.oracle.truffle.runtime.AbstractOptimizedLoopNode Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.runtime;

import java.util.Objects;

import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
import com.oracle.truffle.api.nodes.LoopNode;
import com.oracle.truffle.api.nodes.RepeatingNode;

abstract class AbstractOptimizedLoopNode extends LoopNode {

    @Child protected RepeatingNode repeatingNode;

    @CompilationFinal private long trueCount; // long for long running loops.
    @CompilationFinal private int falseCount;

    protected AbstractOptimizedLoopNode(RepeatingNode repeatingNode) {
        this.repeatingNode = Objects.requireNonNull(repeatingNode);
    }

    @Override
    public final RepeatingNode getRepeatingNode() {
        return repeatingNode;
    }

    protected final void profileCounted(long iterations) {
        if (CompilerDirectives.inInterpreter()) {
            long trueCountLocal = trueCount + iterations;
            if (trueCountLocal >= 0) { // don't write overflow values
                trueCount = trueCountLocal;
                int falseCountLocal = falseCount;
                if (falseCountLocal < Integer.MAX_VALUE) {
                    falseCount = falseCountLocal + 1;
                }
            }
        }
    }

    protected final boolean inject(boolean condition) {
        if (CompilerDirectives.inCompiledCode()) {
            return CompilerDirectives.injectBranchProbability(calculateProbability(trueCount, falseCount), condition);
        } else {
            return condition;
        }
    }

    private static double calculateProbability(long trueCountLocal, int falseCountLocal) {
        if (falseCountLocal == 0 && trueCountLocal == 0) {
            // Avoid division by zero and assume default probability for AOT.
            return 0.5;
        } else {
            return (double) trueCountLocal / (double) (trueCountLocal + falseCountLocal);
        }
    }
}