/*
 * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


package org.graalvm.compiler.nodes;

import org.graalvm.compiler.debug.GraalError;

import jdk.vm.ci.meta.DeoptimizationAction;
import jdk.vm.ci.meta.DeoptimizationReason;
import jdk.vm.ci.meta.SpeculationLog;
import jdk.vm.ci.meta.SpeculationLog.Speculation;

public interface StaticDeoptimizingNode extends ValueNodeInterface {

    DeoptimizationReason getReason();

    void setReason(DeoptimizationReason reason);

    DeoptimizationAction getAction();

    void setAction(DeoptimizationAction action);

    Speculation getSpeculation();

    
Describes how much information is gathered when deoptimization triggers. This enum is Comparable and orders its element from highest priority to lowest priority.
/** * Describes how much information is gathered when deoptimization triggers. * * This enum is {@link Comparable} and orders its element from highest priority to lowest * priority. */
enum GuardPriority { Speculation, Profile, None; public boolean isHigherPriorityThan(GuardPriority other) { return this.compareTo(other) < 0; } public boolean isLowerPriorityThan(GuardPriority other) { return this.compareTo(other) > 0; } public static GuardPriority highest() { return Speculation; } } default GuardPriority computePriority() { assert getSpeculation() != null; if (!getSpeculation().equals(SpeculationLog.NO_SPECULATION)) { return GuardNode.GuardPriority.Speculation; } switch (getAction()) { case InvalidateReprofile: case InvalidateRecompile: return GuardNode.GuardPriority.Profile; case RecompileIfTooManyDeopts: case InvalidateStopCompiling: case None: return GuardNode.GuardPriority.None; } throw GraalError.shouldNotReachHere(); } static DeoptimizationAction mergeActions(DeoptimizationAction a1, DeoptimizationAction a2) { if (a1 == a2) { return a1; } if (a1 == DeoptimizationAction.InvalidateRecompile && a2 == DeoptimizationAction.InvalidateReprofile || a1 == DeoptimizationAction.InvalidateReprofile && a2 == DeoptimizationAction.InvalidateRecompile) { return DeoptimizationAction.InvalidateReprofile; } return null; } }