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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-runtime Show documentation
Truffle runtime distribution.
There is a newer version: 24.1.0
/*
 * 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 com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.frame.Frame;
import com.oracle.truffle.api.nodes.RootNode;

import jdk.vm.ci.code.stack.InspectedFrame;

/**
 * Represents a Truffle {@link com.oracle.truffle.api.frame.FrameInstance} where OSR occurred.
 *
 * Contains a separate field for the {@link InspectedFrame} containing the most up-to-date Frame.
 */
final class OptimizedOSRFrameInstance extends OptimizedFrameInstance {
    private final InspectedFrame osrFrame;

    OptimizedOSRFrameInstance(InspectedFrame callTargetFrame, InspectedFrame callNodeFrame, InspectedFrame osrFrame) {
        super(callTargetFrame, callNodeFrame);
        this.osrFrame = osrFrame;
    }

    @TruffleBoundary
    @Override
    public Frame getFrame(FrameAccess access) {
        Frame materializedOSRFrame = getFrameFrom(osrFrame, access);
        if (getOSRRootNode() instanceof OptimizedOSRLoopNode.LoopOSRRootNode) {
            return (Frame) materializedOSRFrame.getArguments()[0];
        }
        return materializedOSRFrame;
    }

    private RootNode getOSRRootNode() {
        return ((OptimizedCallTarget) osrFrame.getLocal(OptimizedFrameInstance.CALL_TARGET_INDEX)).getRootNode();
    }

    @TruffleBoundary
    @Override
    public boolean isVirtualFrame() {
        return osrFrame.isVirtual(FRAME_INDEX);
    }

    @TruffleBoundary
    @Override
    public int getCompilationTier() {
        return ((CompilationState) osrFrame.getLocal(OPTIMIZATION_TIER_FRAME_INDEX)).getTier();
    }

    @TruffleBoundary
    @Override
    public boolean isCompilationRoot() {
        return ((CompilationState) osrFrame.getLocal(OPTIMIZATION_TIER_FRAME_INDEX)).isCompilationRoot();
    }
}