org.pkl.thirdparty.truffle.api.profiles.InlinedConditionProfile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pkl-config-java-all Show documentation
Shaded fat Jar for pkl-config-java, a Java config library based on the Pkl config language.
There is a newer version: 0.27.1
/*
 * Copyright (c) 2022, 2022, 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 org.pkl.thirdparty.truffle.api.profiles;

import org.pkl.thirdparty.truffle.api.CompilerDirectives;
import org.pkl.thirdparty.truffle.api.dsl.InlineSupport.InlineTarget;
import org.pkl.thirdparty.truffle.api.dsl.InlineSupport.RequiredField;
import org.pkl.thirdparty.truffle.api.dsl.InlineSupport.StateField;
import org.pkl.thirdparty.truffle.api.nodes.Node;

/**
 * ConditionProfiles are useful to profile the outcome of conditions. A regular condition profile
 * keeps track of a binary state, for each branch whether a branch was hit or not and communicates
 * this to the compiler. If frequency information for each branch should be collected use
 * {@link InlinedCountingConditionProfile} instead.
 *
 * 
 *  Usage example: 
 *
 * 
 * abstract class AbsoluteNode extends Node {
 *
 *     abstract void execute(int value);
 *
 *     @Specialization
 *     int doDefault(int value,
 *                     @Cached InlinedConditionProfile p) {
 *         if (p.profile(this, value >= 0)) {
 *             return value;
 *         } else {
 *             return -value;
 *         }
 *     }
 * }
 * 
 *
 *
 * @since 23.0
 */
public final class InlinedConditionProfile extends InlinedProfile {

    private static final InlinedConditionProfile DISABLED;
    static {
        InlinedConditionProfile profile = new InlinedConditionProfile();
        DISABLED = profile;
    }

    private static final int REQUIRED_STATE_BITS = 2;

    private final StateField state;

    private InlinedConditionProfile() {
        this.state = null;
    }

    private InlinedConditionProfile(InlineTarget target) {
        this.state = target.getState(0, REQUIRED_STATE_BITS);
    }

    /** @since 23.0 */
    public boolean profile(Node node, boolean value) {
        if (state != null) {
            int s = this.state.get(node);
            if (value) {
                if ((s & 0b01) == 0) {
                    CompilerDirectives.transferToInterpreterAndInvalidate();
                    state.set(node, s | 0b01);
                }
                return true;
            } else {
                if ((s & 0b10) == 0) {
                    CompilerDirectives.transferToInterpreterAndInvalidate();
                    state.set(node, s | 0b10);
                }
                return false;
            }
        }
        return value;
    }

    /**
     * Returns true if the {@link #profile(Node, boolean)} method ever received a
     * true value, otherwise false. For profiles with profiling disabled
     * or {@link #getUncached() uncached} profiles this method always returns true.
     *
     * @since 23.0
     */
    public boolean wasTrue(Node node) {
        if (state == null) {
            return true;
        }
        return (state.get(node) & 0b01) == 0b01;
    }

    /**
     * Returns true if the {@link #profile(Node, boolean)} method ever received a
     * false value, otherwise false. For profiles with profiling disabled
     * or {@link #getUncached() uncached} profiles this method always returns true.
     *
     * @since 23.0
     */
    public boolean wasFalse(Node node) {
        if (state == null) {
            return true;
        }
        return (state.get(node) & 0b10) == 0b10;
    }

    /**
     * {@inheritDoc}
     *
     * @since 23.0
     */
    @Override
    public void disable(Node node) {
        if (state == null) {
            return;
        }
        state.set(node, 0b11);
    }

    /**
     * {@inheritDoc}
     *
     * @since 23.0
     */
    @Override
    public void reset(Node node) {
        if (state == null) {
            return;
        }
        state.set(node, 0b00);
    }

    boolean isGeneric(Node node) {
        if (state == null) {
            return true;
        }
        return wasTrue(node) && wasFalse(node);
    }

    boolean isUninitialized(Node node) {
        if (state == null) {
            return false;
        }
        return !wasTrue(node) && !wasFalse(node);
    }

    /**
     * {@inheritDoc}
     *
     * @since 23.0
     */
    @Override
    public String toString(Node node) {
        if (state == null) {
            return toStringDisabled();
        }
        return String.format("%s(wasTrue=%s, wasFalse=%s)@%x", getClass().getSimpleName(), wasTrue(node), wasFalse(node), hashCode());
    }

    /**
     * Returns an inlined version of the profile. This version is automatically used by Truffle DSL
     * node inlining.
     *
     * @since 23.0
     */
    public static InlinedConditionProfile inline(
                    @RequiredField(value = StateField.class, bits = REQUIRED_STATE_BITS) InlineTarget target) {
        if (Profile.isProfilingEnabled()) {
            return new InlinedConditionProfile(target);
        } else {
            return getUncached();
        }
    }

    /**
     * Returns the uncached version of the profile. The uncached version of a profile does not
     * perform any profiling.
     *
     * @since 23.0
     */
    public static InlinedConditionProfile getUncached() {
        return DISABLED;
    }

}